From 2d0f9717474a7106e21ce267008267ab35eafb0c Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 30 Oct 2015 10:19:47 +0800 Subject: [PATCH 01/23] Update documentation to address #288. --- src/localize.c | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/src/localize.c b/src/localize.c index 447ef71..d0d7951 100755 --- a/src/localize.c +++ b/src/localize.c @@ -410,16 +410,17 @@ static const TidyOptionDoc option_docs[] = }, {TidyMakeClean, "This option specifies if Tidy " - "should strip out surplus presentational tags and attributes replacing " - "them by style rules and structural markup as appropriate. It works well " - "on the HTML saved by Microsoft Office products. " - , TidyMakeCleanTagsLinks + "should perform cleaning of some legacy presentational tags (currently " + "<i>, <b>, <center> when enclosed within appropriate " + "inline tags, and <font>). If set then legacy tags will be replaced " + "with CSS <style> tags and structural markup as appropriate. " + , }, {TidyGDocClean, "This option specifies if Tidy " "should enable specific behavior for cleaning up HTML exported from " "Google Docs. " - , TidyMakeCleanTagsLinks + , }, {TidyDoctype, "This option specifies the DOCTYPE declaration generated by Tidy.
" @@ -452,9 +453,14 @@ static const TidyOptionDoc option_docs[] = "This option specifies if Tidy should discard empty paragraphs. " }, {TidyDropFontTags, - "This option specifies if Tidy should discard <FONT> and " - "<CENTER> tags without creating the corresponding style rules. This " - "option can be set independently of the clean option. " + "Deprecated; DO NOT USE. This option is destructive to <font> tags, " + "and it will be removed from future versions of Tidy. Use the clean option " + "instead. If you do set this option despite the warning it will perform " + "as clean except styles will be inline instead of put into a CSS class. " + "<font> tags will be dropped completely and their styles will not be " + "preserved. If both clean and this option are enabled, <font> tags " + "will still be dropped completely, and other styles will be preserved in a " + "CSS class instead of inline. See clean for more information. " , TidyDropFontTagsLinks }, {TidyDropPropAttrs, From a3138cb142501983a7eebdd2f71d02b34d254a9b Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 30 Oct 2015 12:23:20 +0800 Subject: [PATCH 02/23] URL cleanup. --- src/localize.c | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/src/localize.c b/src/localize.c index d0d7951..fa27b32 100755 --- a/src/localize.c +++ b/src/localize.c @@ -22,10 +22,11 @@ /* used to point to Web Accessibility Guidelines */ #define ACCESS_URL "http://www.w3.org/WAI/GL" -/* points to the Adaptive Technology Resource Centre at the +/* points to Tidy's accessibility page, previous available +** at the Adaptive Technology Resource Centre at the ** University of Toronto */ -#define ATRC_ACCESS_URL "http://www.aprompt.ca/Tidy/accessibilitychecks.html" +#define ATRC_ACCESS_URL "http://www.html-tidy.org/accessibility/" #include "version.h" @@ -365,10 +366,6 @@ static const TidyOptionId TidyNumEntitiesLinks[] = { TidyDoctype, TidyPreserveEntities, TidyUnknownOption }; static const TidyOptionId TidyDropFontTagsLinks[] = { TidyMakeClean, TidyUnknownOption }; -static const TidyOptionId TidyMakeCleanTagsLinks[] = - { TidyDropFontTags, TidyUnknownOption }; -static const TidyOptionId TidyGDocCleanLinks[] = - { TidyMakeClean, TidyUnknownOption }; /* Documentation of options */ static const TidyOptionDoc option_docs[] = @@ -689,9 +686,8 @@ static const TidyOptionDoc option_docs[] = "This option specifies what level of accessibility checking, if any, " "that Tidy should do. Level 0 is equivalent to Tidy Classic's " "accessibility checking. " - "For more information on Tidy's accessibility checking, visit the " - "Adaptive Technology Resource Centre at the University of Toronto. " + "For more information on Tidy's accessibility checking, visit " + " Tidy's Accessibility Page. " }, {TidyShowErrors, "This option specifies the number Tidy uses to determine if further errors " @@ -1734,7 +1730,7 @@ void TY_(ErrorSummary)( TidyDocImpl* doc ) tidy_out(doc, "UTF-8 as a transformation of Unicode characters. ISO/IEC 10646\n"); tidy_out(doc, "does not allow mapping of unpaired surrogates, nor U+FFFE and U+FFFF\n"); tidy_out(doc, "(but it does allow other noncharacters). For more information please refer to\n"); - tidy_out(doc, "http://www.unicode.org/unicode and http://www.cl.cam.ac.uk/~mgk25/unicode.html\n\n"); + tidy_out(doc, "http://www.unicode.org/ and http://www.cl.cam.ac.uk/~mgk25/unicode.html\n\n"); } #if SUPPORT_UTF16_ENCODINGS @@ -1744,7 +1740,7 @@ void TY_(ErrorSummary)( TidyDocImpl* doc ) tidy_out(doc, "Character codes for UTF-16 must be in the range: U+0000 to U+10FFFF.\n"); tidy_out(doc, "The definition of UTF-16 in Annex C of ISO/IEC 10646-1:2000 does not allow the\n"); tidy_out(doc, "mapping of unpaired surrogates. For more information please refer to\n"); - tidy_out(doc, "http://www.unicode.org/unicode and http://www.cl.cam.ac.uk/~mgk25/unicode.html\n\n"); + tidy_out(doc, "http://www.unicode.org/ and http://www.cl.cam.ac.uk/~mgk25/unicode.html\n\n"); } #endif @@ -1832,9 +1828,6 @@ void TY_(ErrorSummary)( TidyDocImpl* doc ) if ( cfg(doc, TidyAccessibilityCheckLevel) > 0 ) tidy_out(doc, " and %s", ATRC_ACCESS_URL ); tidy_out(doc, ".\n" ); - tidy_out(doc, ". You may also want to try\n" ); - tidy_out(doc, "\"http://www.cast.org/bobby/\" which is a free Web-based\n"); - tidy_out(doc, "service for checking URLs for accessibility.\n\n"); } if (doc->badLayout) From 09b0698c562bd159870d5c7edc8949394b13aa3b Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 30 Oct 2015 12:58:11 +0800 Subject: [PATCH 03/23] Typo. --- src/localize.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/localize.c b/src/localize.c index fa27b32..6d3eee5 100755 --- a/src/localize.c +++ b/src/localize.c @@ -22,7 +22,7 @@ /* used to point to Web Accessibility Guidelines */ #define ACCESS_URL "http://www.w3.org/WAI/GL" -/* points to Tidy's accessibility page, previous available +/* points to Tidy's accessibility page, previously available ** at the Adaptive Technology Resource Centre at the ** University of Toronto */ From 709ac8cb4ceafaa784a942b8996e75819b847510 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 30 Oct 2015 18:17:40 +0800 Subject: [PATCH 04/23] Support HTML in descriptions. --- documentation/quickref.include.xsl | 2 +- documentation/quickref.xsl | 2 +- src/localize.c | 8 ++++++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/documentation/quickref.include.xsl b/documentation/quickref.include.xsl index 32a47e9..da3012f 100644 --- a/documentation/quickref.include.xsl +++ b/documentation/quickref.include.xsl @@ -208,7 +208,7 @@ - + diff --git a/documentation/quickref.xsl b/documentation/quickref.xsl index d016d88..6c41e71 100644 --- a/documentation/quickref.xsl +++ b/documentation/quickref.xsl @@ -212,7 +212,7 @@ - + diff --git a/src/localize.c b/src/localize.c index 6d3eee5..90e6cdd 100755 --- a/src/localize.c +++ b/src/localize.c @@ -367,7 +367,11 @@ static const TidyOptionId TidyNumEntitiesLinks[] = static const TidyOptionId TidyDropFontTagsLinks[] = { TidyMakeClean, TidyUnknownOption }; -/* Documentation of options */ +/* Documentation of options +** As of 2015-October these descriptions are used uniquely by +** printXMLDescription from which quickref.html and the Unix +** man pages are generated. +*/ static const TidyOptionDoc option_docs[] = { {TidyXmlDecl, @@ -450,7 +454,7 @@ static const TidyOptionDoc option_docs[] = "This option specifies if Tidy should discard empty paragraphs. " }, {TidyDropFontTags, - "Deprecated; DO NOT USE. This option is destructive to <font> tags, " + "Deprecated; DO NOT USE. This option is destructive to <font> tags, " "and it will be removed from future versions of Tidy. Use the clean option " "instead. If you do set this option despite the warning it will perform " "as clean except styles will be inline instead of put into a CSS class. " From 8c5fae8c0903d00a519538472d9413149feab956 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Fri, 30 Oct 2015 23:58:43 +0800 Subject: [PATCH 05/23] - documentation/quickref.xsl - Includes

support - Matches the description class name in quickref.include.xsl - Styles
to enforce vertical spacing (in the reference table only). - documentation/style.css - Styles
to enforce vertical spacing (in the reference table only). - documentation/tidy1.xsl.in - Includes

support. - Better manages line breaks with .sp1 instead of .br. - src/localize.c - Legibility to the troublesome `drop-font-tags` description. --- documentation/quickref.xsl | 12 ++++++++++-- documentation/style.css | 8 +++++++- documentation/tidy1.xsl.in | 19 ++++++++++++++++++- src/localize.c | 24 +++++++++++++++--------- 4 files changed, 50 insertions(+), 13 deletions(-) diff --git a/documentation/quickref.xsl b/documentation/quickref.xsl index 6c41e71..09e2413 100644 --- a/documentation/quickref.xsl +++ b/documentation/quickref.xsl @@ -212,7 +212,7 @@ - + @@ -415,6 +415,14 @@ font-weight: normal; background-color: #f5f5f5 } + + /* BR IN TABLE DATA DESCRIPTION */ + td.qdescription br + { + content: " "; + display: block; + margin: 10px 0; + } /* GLOSSARY TERM */ td.term, font.term, .term, a:link.term, a:visited.term, a:active.term @@ -565,7 +573,7 @@ - + diff --git a/documentation/style.css b/documentation/style.css index e8b9868..6eb740f 100644 --- a/documentation/style.css +++ b/documentation/style.css @@ -301,4 +301,10 @@ h4.qoptiontitle { line-height: 140%; border-left: 1px solid #bbbbbb; border-bottom: 1px solid #bbbbbb; -} \ No newline at end of file +} + +td.qdescription br { + content: " "; + display: block; + margin: 10px 0; +} diff --git a/documentation/tidy1.xsl.in b/documentation/tidy1.xsl.in index ad213b4..e10efc7 100644 --- a/documentation/tidy1.xsl.in +++ b/documentation/tidy1.xsl.in @@ -403,9 +403,26 @@ The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-h \fI\fR + + +.sp 1 + + + + + + +.sp 1 + + + +.sp 1 + + + -.br +.sp 1 diff --git a/src/localize.c b/src/localize.c index 90e6cdd..7297dd3 100755 --- a/src/localize.c +++ b/src/localize.c @@ -370,7 +370,10 @@ static const TidyOptionId TidyDropFontTagsLinks[] = /* Documentation of options ** As of 2015-October these descriptions are used uniquely by ** printXMLDescription from which quickref.html and the Unix -** man pages are generated. +** man pages are generated, and the xslt for building all +** documentation now supports the following tags in descriptions: +** , , ,
,

+** Note that the xslt processor requires
to be self closing! */ static const TidyOptionDoc option_docs[] = { @@ -454,14 +457,17 @@ static const TidyOptionDoc option_docs[] = "This option specifies if Tidy should discard empty paragraphs. " }, {TidyDropFontTags, - "Deprecated; DO NOT USE. This option is destructive to <font> tags, " - "and it will be removed from future versions of Tidy. Use the clean option " - "instead. If you do set this option despite the warning it will perform " - "as clean except styles will be inline instead of put into a CSS class. " - "<font> tags will be dropped completely and their styles will not be " - "preserved. If both clean and this option are enabled, <font> tags " - "will still be dropped completely, and other styles will be preserved in a " - "CSS class instead of inline. See clean for more information. " + "Deprecated; do not use. This option is destructive to " + "<font> tags, and it will be removed from future versions of Tidy. " + "Use the clean option instead. " + "
If you do set this option despite the warning it will perform " + "as clean except styles will be inline instead of put into " + "a CSS class. <font> tags will be dropped completely and their styles " + "will not be preserved. " + "
If both clean and this option are enabled, " + "<font> tags will still be dropped completely, and other styles will " + "be preserved in a CSS class instead of inline. " + "
See clean for more information. " , TidyDropFontTagsLinks }, {TidyDropPropAttrs, From 8b95ca5d4f56492c3e22ddc5a4e0314e9ed35f13 Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Sat, 31 Oct 2015 09:21:55 +0800 Subject: [PATCH 06/23] - Consolidated README documents into root-level subdir. - Removed redundant documentation directory from build. --- CODESTYLE.md => README/CODESTYLE.md | 0 CONTRIBUTING.md => README/CONTRIBUTING.md | 0 LICENSE.md => README/LICENSE.md | 0 LICENSE.txt => README/LICENSE.txt | 0 README.html => README/README.html | 0 README.md => README/README.md | 0 VERSION.md => README/VERSION.md | 0 verhist.log => README/verhist.log | 0 build/documentation/.gitignore | 12 - build/documentation/DoxygenLayout.xml | 198 -- build/documentation/README.md | 105 - build/documentation/doxygen.cfg | 1919 ----------------- build/documentation/examples/example.1.c | 49 - .../documentation/examples/example_config.txt | 22 - build/documentation/pages/main_page.dox | 52 - build/documentation/pages/page_building.dox | 98 - .../pages/page_featured_options.dox | 146 -- build/documentation/pages/page_history.dox | 54 - build/documentation/pages/page_license.dox | 14 - build/documentation/pages/page_quickref.dox | 12 - build/documentation/pages/page_tidy.dox | 18 - .../documentation/pages/page_tidy_config.dox | 46 - .../pages/page_tidy_quickstart.dox | 71 - .../pages/page_tidy_scripting.dox | 31 - build/documentation/pages/page_tidylib.dox | 53 - build/documentation/pages/page_todo.dox | 14 - build/documentation/quickref.include.xsl | 244 --- build/documentation/quickref.xsl | 574 ----- build/documentation/style.css | 304 --- build/documentation/tidy1.xsl | 448 ---- .../build_docs.sh | 4 +- 31 files changed, 2 insertions(+), 4486 deletions(-) rename CODESTYLE.md => README/CODESTYLE.md (100%) rename CONTRIBUTING.md => README/CONTRIBUTING.md (100%) rename LICENSE.md => README/LICENSE.md (100%) rename LICENSE.txt => README/LICENSE.txt (100%) rename README.html => README/README.html (100%) rename README.md => README/README.md (100%) rename VERSION.md => README/VERSION.md (100%) rename verhist.log => README/verhist.log (100%) delete mode 100644 build/documentation/.gitignore delete mode 100644 build/documentation/DoxygenLayout.xml delete mode 100644 build/documentation/README.md delete mode 100644 build/documentation/doxygen.cfg delete mode 100644 build/documentation/examples/example.1.c delete mode 100644 build/documentation/examples/example_config.txt delete mode 100644 build/documentation/pages/main_page.dox delete mode 100644 build/documentation/pages/page_building.dox delete mode 100644 build/documentation/pages/page_featured_options.dox delete mode 100644 build/documentation/pages/page_history.dox delete mode 100644 build/documentation/pages/page_license.dox delete mode 100644 build/documentation/pages/page_quickref.dox delete mode 100644 build/documentation/pages/page_tidy.dox delete mode 100644 build/documentation/pages/page_tidy_config.dox delete mode 100644 build/documentation/pages/page_tidy_quickstart.dox delete mode 100644 build/documentation/pages/page_tidy_scripting.dox delete mode 100644 build/documentation/pages/page_tidylib.dox delete mode 100644 build/documentation/pages/page_todo.dox delete mode 100644 build/documentation/quickref.include.xsl delete mode 100644 build/documentation/quickref.xsl delete mode 100644 build/documentation/style.css delete mode 100644 build/documentation/tidy1.xsl rename {build/documentation => documentation}/build_docs.sh (96%) diff --git a/CODESTYLE.md b/README/CODESTYLE.md similarity index 100% rename from CODESTYLE.md rename to README/CODESTYLE.md diff --git a/CONTRIBUTING.md b/README/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to README/CONTRIBUTING.md diff --git a/LICENSE.md b/README/LICENSE.md similarity index 100% rename from LICENSE.md rename to README/LICENSE.md diff --git a/LICENSE.txt b/README/LICENSE.txt similarity index 100% rename from LICENSE.txt rename to README/LICENSE.txt diff --git a/README.html b/README/README.html similarity index 100% rename from README.html rename to README/README.html diff --git a/README.md b/README/README.md similarity index 100% rename from README.md rename to README/README.md diff --git a/VERSION.md b/README/VERSION.md similarity index 100% rename from VERSION.md rename to README/VERSION.md diff --git a/verhist.log b/README/verhist.log similarity index 100% rename from verhist.log rename to README/verhist.log diff --git a/build/documentation/.gitignore b/build/documentation/.gitignore deleted file mode 100644 index cc2afff..0000000 --- a/build/documentation/.gitignore +++ /dev/null @@ -1,12 +0,0 @@ - -# file created during build_docs -# = tidy5 -h > tidy5.cmd.txt -examples/tidy5.*.txt - -# The license file needs to copies to examples for \include -examples/LICENSE.md - -# file generates from xsl -examples/quickref_include.html - - diff --git a/build/documentation/DoxygenLayout.xml b/build/documentation/DoxygenLayout.xml deleted file mode 100644 index 1580088..0000000 --- a/build/documentation/DoxygenLayout.xml +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/build/documentation/README.md b/build/documentation/README.md deleted file mode 100644 index faf0fa4..0000000 --- a/build/documentation/README.md +++ /dev/null @@ -1,105 +0,0 @@ -Documentation HOWTO {#docs_howto} -======================== -Instructions for generating documentation - -\note For linking to these docs, the doxygen tag file is `tidy.tags` - -**HTML Tidy** provides several types of documentation to suit different purposes. This -document describes how to generate the following: - -- `tidylib_api/` (directory) - - - This collection of documents describes the **TidyLib** API and is generated from the - comments and code in the **Tidy** source code. - -- `quickref.html` - - - This document provides a nice, readable HTML document describing all of the options and - settings that you can use with **Tidy** and internally in **TidyLib**. - -- `tidy.1` - - - This document is a Mac/Linux/Unix standard `man` page. - - -## The easy way - -In this directory you can find the shell script `build_docs.sh`, and that will build all -of the documentation into the `temp/` directory (i.e., `{tidy}/build/documentation/temp`). - -Please note these prerequisites: - -- It's a Mac/Linux/Unix shell script. -- Doxygen is required to generate the API documentation. -- xsltproc is required to generate the man page and the `quickref.html` file. - -If you prefer to understand how to do this manually (for example, for integration into -other scripts, build systems, or IDEs), read on. - - -## Manually - - -### `tidylib_api/` (directory) - -If you want to build the API documentation you must have [doxygen][1] installed. -You can clone the [repository from github][2] if it is not currently installed. - -Building as simple as: - -~~~ -cd {tidy}/build/documentation/ -doxygen doxygen.cfg -~~~ - -This will result in a document set in `{tidy}/build/documentation/temp/tidylib_api`, -where you can find the main `index.html` file. - - -### `quickref.html` - -Note that these instructions require the standard `xsltproc` utility to build the file, -but any XSLT processor of your choice should work, too. - -- `tidy -xml-config > "tidy-config.xml"` - - - This uses your up-to-date version of **Tidy** to generate an XML file containing all - of **Tidy**’s built-in settings and their descriptions. This file is only temporary, - as it will be transformed in the next step. - -- `xsltproc "quickref.xsl" "tidy-config.xml" > "quickref.html"` - - - This examples uses the `xsltproc` command to transform `tidy-config.xml` using the - rules in the `quickref.xsl` stylesheet, and output it to `quickref.html`. - - - -### `tidy.1` - -Note that these instructions require the standard `xsltproc` utility to build the file, -but any XSLT processor of your choice should work, too. - -- `tidy -xml-config > "tidy-config.xml"` - - - This uses your up-to-date version of **Tidy** to generate an XML file containing all - of **Tidy**’s built-in settings and their descriptions. This file is only temporary, - as it will be transformed in the third step. - -- `tidy -xml-help > "tidy-help.xml"` - - - This uses your up-to-date version of **Tidy** to generate an XML file containing all - of **Tidy**’s built-in help information. This file is only temporary, - as it will be transformed in the next step. - -- `xsltproc "tidy1.xsl" "tidy-help.xml" > "tidy.1"` - - - This examples uses the `xsltproc` command to transform `tidy-help.xml` using the - rules in the `tidy1.xsl` stylesheet, and output it to `tidy.1`. - - \note Note that `tidy1.xls` includes the file `tidy-config.xml` as part of the stylesheet, - and so although it does not appear in the command invocation, it is indeed required. - - - - [1]: http://www.stack.nl/~dimitri/doxygen/ - [2]: https://github.com/doxygen/doxygen diff --git a/build/documentation/doxygen.cfg b/build/documentation/doxygen.cfg deleted file mode 100644 index c7b57e4..0000000 --- a/build/documentation/doxygen.cfg +++ /dev/null @@ -1,1919 +0,0 @@ -# Doxyfile 1.8.9.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. - -PROJECT_NAME = "HTML Tidy" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = version.txt - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "The HTACG Tidy HTML Project" - -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = temp - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow -# non-ASCII characters to appear in the names of generated files. -# If set to NO, non-ASCII characters will be escaped, for example -# _xE3_x81_x84 will be used for Unicode U+3044. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = NO - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = YES - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = YES - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = NO - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = YES - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = YES - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = YES - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable documentation. -# See http://daringfireball.net/projects/markdown/ for details. The output of -# markdown processing is further processed by doxygen, so you can mix doxygen, -# HTML, and XML commands with Markdown formatting. Disable only in case of backward -# compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When enabled doxygen tries to link words that correspond to documented classes, -# or namespaces to their corresponding documentation. Such a link can be prevented -# in individual cases by putting a % sign in front of the word or globally by -# setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). - -INLINE_GROUPED_CLASSES = YES - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). - -INLINE_SIMPLE_STRUCTS = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can -# be an expensive process and often the same symbol appears multiple times in -# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too -# small doxygen will become slower. If the cache is too large, memory is wasted. -# The cache size is given by this formula: $2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}$. -# The valid range is 0..9, the default is 0, corresponding to a cache size of -# $2^{16} = 65536$ symbols. At the end of a run doxygen will report the cache -# usage and suggest the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or -# internal scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = YES - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = YES - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = YES - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = YES - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = YES - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. - -LAYOUT_FILE = DoxygenLayout.xml - -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = NO - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = "../../include" "./" "./pages" - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = NO - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# Note that relative paths are relative to directory from which doxygen is run. - -EXCLUDE = ../include/platform.h - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = "./examples/" - - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page (index.html). -# This can be useful if you have a project on for instance GitHub and want to -# reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = NO - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink -# in the source code will show a tooltip with additional information -# such as prototype, brief description and links to the definition and -# documentation. Since this will make the HTML file larger and loading -# of large files a bit slower, you can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use -# the clang parser for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ -# code for which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen -# was compiled with the --with-libclang option. -# The default value is: NO. - -# CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -# CLANG_OPTIONS = - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = NO - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = "tidylib_api" - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is adviced to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. - -HTML_EXTRA_STYLESHEET = ./style.css - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 50 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. - -HTML_COLORSTYLE_GAMMA = 100 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number -# of entries 1 will produce a full collapsed tree by default. 0 is a special -# value representing an infinite number of entries and will result in a full -# expanded tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. - -ENUM_VALUES_PER_LINE = 1 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. - -FORMULA_TRANSPARENT = YES - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used -# for the MathJax output. See the MathJax site for more details. -# Possible values are: HTML-CSS (which is slower, but has the best compatibility), -# NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. -# See the MathJax site for more details. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP -# script for searching. Instead the search results are written to an XML file -# which needs to be processed by an external indexer. Doxygen will invoke an -# external search engine pointed to by the SEARCHENGINE_URL option to obtain -# the search results. -# Doxygen ships with an example indexer (doxyindexer) and search engine (doxysearch.cgi) -# which are based on the open source search engine library Xapian. -# See the section External Indexing and Searching for details. -# The default value is: NO. -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH = NO - -# The SEARCHENGINE_URL should point to a search engine hosted by a web server -# which will return the search results when EXTERNAL_SEARCH is enabled. -# Doxygen ships with an example indexer (doxyindexer) and search engine -# (doxysearch.cgi) which are based on the open source search engine library -# Xapian. See the section External Indexing and Searching for details. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHENGINE_URL = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed -# search data is written to a file for indexing by an external tool. With the -# SEARCHDATA_FILE tag the name of this file can be specified. -# The default file is: searchdata.xml. -# This tag requires that the tag SEARCHENGINE is set to YES. - -SEARCHDATA_FILE = - -# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the -# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is -# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple -# projects and redirect the results back to the right project. -#This tag requires that the tag SEARCHENGINE is set to YES. - -EXTERNAL_SEARCH_ID = - -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen -# projects other than the one defined by this configuration file, but that are all -# added to the same external search index. Each project needs to have a unique id -# set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of to a relative -# location where the documentation can be found. -# The format is: -# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... -# This tag requires that the tag SEARCHENGINE is set to YES. - -EXTRA_SEARCH_MAPPINGS = - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for -# the generated latex document. The footer should contain everything after -# the last chapter. If it is left blank doxygen will generate a -# standard footer. Notice: only use this tag if you know what you are doing! - -LATEX_FOOTER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = NO - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = NO - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -# The LATEX_BIB_STYLE tag can be used to specify the style to use for the -# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See -# http://en.wikipedia.org/wiki/BibTeX for more info. - -LATEX_BIB_STYLE = plain - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .1 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -# XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -# XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = YES - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# pointed to by INCLUDE_PATH will be searched when a #include is found. - -SEARCH_INCLUDES = NO - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = "../../src" - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = TIDY_EXPORT= - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition that -# overrules the definition found in the source code. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all references to function-like macros -# that are alone on a line, have an all uppercase name, and do not end with a -# semicolon, because these will confuse the parser if not removed. - -SKIP_FUNCTION_MACROS = NO - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed -# in the related pages index. If set to NO, only the current project's pages -# will be listed. -# The default value is: YES. - -EXTERNAL_PAGES = - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to -# install and use dot, since it yields more powerful graphs. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. -# The DIA_PATH tag allows you to specify the directory where the dia binary -# resides. If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. - -DOT_NUM_THREADS = 0 - -# By default doxygen will use the Helvetica font for all dot files that -# doxygen generates. When you want a differently looking font you can specify -# the font name using DOT_FONTNAME. You need to make sure dot is able to find -# the font, which can be done by putting it in a standard location or by setting -# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the -# directory containing the font. - -DOT_FONTNAME = Helvetica - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the Helvetica font. -# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to -# set the path where dot can find it. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = NO - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = NO - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will generate a graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are svg, png, jpg, or gif. -# If left blank png will be used. If you choose svg you need to set -# HTML_FILE_EXTENSION to xhtml in order to make the SVG files -# visible in IE 9+ (other browsers do not have this requirement). - -DOT_IMAGE_FORMAT = png - -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. -# Note that this requires a modern browser other than Internet Explorer. -# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you -# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files -# visible. Older versions of IE do not have SVG support. - -INTERACTIVE_SVG = NO - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the -# \mscfile command). - -MSCFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES diff --git a/build/documentation/examples/example.1.c b/build/documentation/examples/example.1.c deleted file mode 100644 index 96c790f..0000000 --- a/build/documentation/examples/example.1.c +++ /dev/null @@ -1,49 +0,0 @@ - - -#include -#include -#include -#include - -int main(int argc, char **argv ) -{ - const char* input = "Hello

World!"; - TidyBuffer output = {0}; - TidyBuffer errbuf = {0}; - int rc = -1; - Bool ok; - - // Initialize "document" - TidyDoc tdoc = tidyCreate(); - printf( "Tidying:\t%s\n", input ); - - // Convert to XHTML - ok = tidyOptSetBool( tdoc, TidyXhtmlOut, yes ); - if ( ok ) - rc = tidySetErrorBuffer( tdoc, &errbuf ); // Capture diagnostics - if ( rc >= 0 ) - rc = tidyParseString( tdoc, input ); // Parse the input - if ( rc >= 0 ) - rc = tidyCleanAndRepair( tdoc ); // Tidy it up! - if ( rc >= 0 ) - rc = tidyRunDiagnostics( tdoc ); // Kvetch - if ( rc > 1 ) // If error, force output. - rc = ( tidyOptSetBool(tdoc, TidyForceOutput, yes) ? rc : -1 ); - if ( rc >= 0 ) - rc = tidySaveBuffer( tdoc, &output ); // Pretty Print - - if ( rc >= 0 ) - { - if ( rc > 0 ) - printf( "\nDiagnostics:\n\n%s", errbuf.bp ); - printf( "\nAnd here is the result:\n\n%s", output.bp ); - } - else - printf( "A severe error (%d) occurred.\n", rc ); - - tidyBufFree( &output ); - tidyBufFree( &errbuf ); - tidyRelease( tdoc ); - return rc; -} - diff --git a/build/documentation/examples/example_config.txt b/build/documentation/examples/example_config.txt deleted file mode 100644 index 5a0164b..0000000 --- a/build/documentation/examples/example_config.txt +++ /dev/null @@ -1,22 +0,0 @@ -// sample config file for HTML tidy -indent: auto -indent-spaces: 2 -wrap: 72 -markup: yes -output-xml: no -input-xml: no -show-warnings: yes -numeric-entities: yes -quote-marks: yes -quote-nbsp: yes -quote-ampersand: no -break-before-br: no -uppercase-tags: no -uppercase-attributes: no -char-encoding: latin1 -new-inline-tags: cfif, cfelse, math, mroot, - mrow, mi, mn, mo, msqrt, mfrac, msubsup, munderover, - munder, mover, mmultiscripts, msup, msub, mtext, - mprescripts, mtable, mtr, mtd, mth -new-blocklevel-tags: cfoutput, cfquery -new-empty-tags: cfelse \ No newline at end of file diff --git a/build/documentation/pages/main_page.dox b/build/documentation/pages/main_page.dox deleted file mode 100644 index c8a6532..0000000 --- a/build/documentation/pages/main_page.dox +++ /dev/null @@ -1,52 +0,0 @@ -/*! - -\mainpage Tidy home - -\note The repository github.com/htacg/tidy-html5 and this documentation should be considered canonical for HTML Tidy as of 2015-January-15. See \ref history - - -\b Tidy corrects and cleans up HTML content by fixing markup errors such as mismatched, misnested and missing tags, missing end "/" tags, missing quotations et all, eg: - - -\code{.html} -

heading

-

sub
heading

-References -\endcode -is converted to -\code{.html} -
-

heading

-

sub

-
-

heading

-References -\endcode - - -

This project has two parts:

- -- \ref tidylib - - a C static or dynamic library that developers can integrate into their applications - in order to bring all of Tidy’s power to your favorite tools. - -- \ref tidy_cmd - - a console application built on \ref tidylib for Mac OS X, Linux, Windows, UNIX, and more. - -\section content Contents -- \ref quick_ref -- \ref tidy_cmd - - \ref tidy_quickstart - - \ref tidy_config - - \ref featured_options - - \ref tidy_scripting -- \ref tidylib - - Modules -- \ref building_tidy --\ref docs_howto -- \subpage history -- \subpage license -- \ref todo - - -*/ \ No newline at end of file diff --git a/build/documentation/pages/page_building.dox b/build/documentation/pages/page_building.dox deleted file mode 100644 index 15b22b9..0000000 --- a/build/documentation/pages/page_building.dox +++ /dev/null @@ -1,98 +0,0 @@ -/*! - - -\page building_tidy Building Tidy - -How to compile and install Tidy from source code. - -\tableofcontents - -\section Prerequisites - - - \b git - git-scm.com/book/en/v2/Getting-Started-Installing-Git - - \b cmake - cmake.org/download/ - - Appropriate build tools for the platform - -CMake comes in two forms - command line and gui. Some installations only install one or the other, but sometimes both. The build -commands below are only for the command line use. - -Also the actual build tools vary for each platform. But that is one of the great features of cmake, it can generate -variuous 'native' build files. Running cmake without any parameters will list the generators -available on that platform. For sure one of the common ones is "Unix Makefiles", which needs autotools -make installed, but many other generators are supported. - -In windows cmake offers various versions of MSVC. Again below only the command line use of MSVC is shown, but the -tidy solution (*.sln) file can be loaded into the MSVC IDE, and the building done in there. - -\section get_source Get the source code - -Tidy’s sourcecode can be found at github.com/htacg/tidy-html5. There are sometimes -several branches, but in general `master` is the most recently updated version. - -\note Note that as “cutting edge,” it may have bugs or other -unstable behavior. If you prefer a stable, officially released version, be sure to have a look -at Releases on the github page. - -In general you can use the Download ZIP button on the github page to download the most recent version of a branch. If you prefer -Git then you can clone the repository to a working machine with: - - -\code{.sh} -git clone git@github.com:htacg/tidy-html5.git -\endcode - -\section compile Compile - -

Enter the `build/cmake` directory

-\code{.sh} -# *nix -cd {your-tidy-html5-directory}/build/cmake - -# windows -cd {your-tidy-html5-directory}\build\cmake -\endcode - -

Configure the build

-\code{.sh} -# *nix -cmake ../../ [-DCMAKE_INSTALL_PREFIX=/path/for/install] - -# windows -cmake ..\..\ -\endcode -By default cmake sets the install path to `/usr/local` in unix. - -If you wanted the binary in say `/usr/bin` instead, then use `-DCMAKE_INSTALL_PREFIX=/usr` - -On windows the default install is to `C:\Program Files\tidy5`, or `C:/Program Files (x86)/tidy5`, which is not very useful. After -the build the `tidy[n].exe` is in the `Release\` directory, and can be copied to any directory in your `PATH` environment variable, for global use. - -If you need the tidy library built as a 'shared' (DLL) library, then in add the command `-DBUILD_SHARED_LIB:BOOL=ON`. -This option is `OFF` by default, so the static library is built and linked with the command line tool for convenience. - - -

Compile

-\code{.sh} -# *nix -make - -# windows -cmake --build . --config Release -\endcode - - -\section compileOnstall Install -Install the applicatio and library with - -\code{.sh} -# *nix -[sudo] make install - -# windows -cmake --build . --config Release --target INSTALL -\endcode - - - - -*/ \ No newline at end of file diff --git a/build/documentation/pages/page_featured_options.dox b/build/documentation/pages/page_featured_options.dox deleted file mode 100644 index 564adf9..0000000 --- a/build/documentation/pages/page_featured_options.dox +++ /dev/null @@ -1,146 +0,0 @@ -/*! - - -\page featured_options Featured Options - -Overview of popular features and problems - -\tableofcontents - -\section indenting Indenting output for readability - -Indenting the source markup of an HTML document makes the markup easier to read. Tidy can indent the -markup for an HTML document while recognizing elements whose contents should not be indented. In the -example below, Tidy indents the output while preserving the formatting of the `
` element:
-
-Input:
-\code{.html}
-
- 
- Test document
- 
- 
- 
This example shows how Tidy can indent output while preserving
- formatting of particular elements.

-
- 
This is
- genuine
-       preformatted
-    text
- 

- 
- 
- \endcode 
- 
- Output:
-\code{.html}
-
-    
-        Test document
-    
-
-    
-        
This example shows how Tidy can indent output while preserving
-        formatting of particular elements.

-
-This is
-genuine
-       preformatted
-   text
-

-    
-
-\endcode 
-
-Tidy’s indenting behavior is not perfect and can sometimes cause your output to be rendered by browsers in a different way than the input. You can 
-avoid unexpected indenting-related rendering problems by setting `indent:no` or `indent:auto` in a config file.
-
-\note 
-    Preserving original indenting not possible


-    Tidy is not capable of preserving the original indenting of the markup from the input it receives. That’s because Tidy starts by 
-    building a clean parse tree from the input, and that parse tree doesn’t contain any information about the original indenting. Tidy then 
-    pretty-prints the parse tree using the current config settings. Trying to preserve the original 
-    indenting from the input would interact badly with the repair operations needed to build a clean parse tree, and would considerably complicate the code.
-
-    
-\section encodings Encodings and character references
-
-Tidy defaults to assuming you want output to be encoded in `UTF-8`. But Tidy offers you a choice of other 
-character encodings: `US ASCII`, `ISO Latin-1`, and the `ISO 2022` family of 7 bit encodings.
-
-Tidy doesn’t yet recognize the use of the HTML `` element for specifying the character encoding.
-
-The full set of HTML character references are defined. Cleaned-up output uses named character references for characters when appropriate. Otherwise, 
-characters outside the normal range are output as numeric character references.
-
-\section accessibility Accessibility
-
-Tidy offers advice on potential accessibility problems for people using non-graphical browsers.
-
-\section cleaning_presentational Cleaning up presentational markup
-
-Some tools generate HTML with presentational elements such as ``, ``, and `
`. Tidy’s -clean option will replace those elements with `
-
-
-
-
-
-    
-        
-    
-
-
-
diff --git a/build/documentation/quickref.xsl b/build/documentation/quickref.xsl
deleted file mode 100644
index d016d88..0000000
--- a/build/documentation/quickref.xsl
+++ /dev/null
@@ -1,574 +0,0 @@
-
-
-
-
-
-
-
-
-  
-  
-    HTML Tidy Configuration Options Quick Reference
-	
-  
-
-  
-    
Quick Reference

-
-    
HTML Tidy Configuration Options

-
-    
Version: 

-
-    
HTML, XHTML, XML

-     Diagnostics

-     Pretty Print

-     Character Encoding

-     Miscellaneous

-
-    
-
-    
-
-  
-  
-
-
-
-
-
-
-  
-    -      -      -      -    
-    
-      markup
-      HTML, XHTML, XML
-      MarkupHeader
-    
-    
-      diagnostics
-      Diagnostics
-      DiagnosticsHeader
-    
-    
-      print
-      Pretty Print
-      PrettyPrintHeader
-    
-    
-      encoding
-      Character Encoding
-      EncodingHeader
-    
-    
-      misc
-      Miscellaneous
-      MiscellaneousHeader
-    
-  






-
-
-
-
-  
-    
-      markup
-      HTML, XHTML, XML
-      MarkupReference
-    
-    
-      diagnostics
-      Diagnostics
-      DiagnosticsReference
-    
-    
-      print
-      Pretty Print
-      PrettyPrintReference
-    
-    
-      encoding
-      Character Encoding
-      EncodingReference
-    
-    
-      misc
-      Miscellaneous
-      MiscellaneousReference
-    
-  

-
-
-
-
-  
-  
-  
-  
-    
-       Options
-    Top
-  
-  
-  
-    
-    
-      
-      
-      
-            
-              
-            
-            
-              -
-            
-        
-      
-    
-  
-  
-     
-  
-
-
-
-
-  
-  
-  
-
-  
-     
-  
-  
-    
-        Options Reference
-    
-  
-  
-     
-  
-
-  
-    
-    
-      
-        
-      
-      
-      Top
-    
-    
-      Type: 

-
-        
-          
-            Default: 
-          
-          
-            Default: -
-          
-        
-
-        
-          
-            
Example: 
-          
-          
-            
Example: -
-          
-        
-      
-      
-        
-          
-          
-            

-          
-        
-      
-    
-
-    
-      
-    
-
-    
-       
-    
-  
-
-
-
-      
-        Option
-        Type
-        Default
-      
-
-
-
-	
-
-
-
-
-
-    
-        
-    
-
-
-
diff --git a/build/documentation/style.css b/build/documentation/style.css
deleted file mode 100644
index e8b9868..0000000
--- a/build/documentation/style.css
+++ /dev/null
@@ -1,304 +0,0 @@
-
-body {
-    background-color: #efefef;
-}
-
-#titlearea {
-    background-image: url(http://www.html-tidy.org/assets/images/green-abstract-background.jpg);
-    background-size: cover;
-}
-
-#projectname {
-    font-family: sans-serif;
-    font-size: 22pt; 
-    margin: 0 0 0 0;
-    margin-left: 150px;
-    padding: 2px 0px;
-    color: white;
-}
-
-#projectnumber {
-    font-size: 12pt; 
-}
-
-#projectbrief {
-    font-family: sans-serif;
-    font-size: 10pt; 
-    color: #dddddd;
-    margin-left: 150px;
-}
-
-
-.contents h1 {
-    font-size: 15pt;
-    font-family: monospace;
-    color: #4D4D74;
-    font-weight: bold;
-    border-left: none;
-    border-top: none;
-    border-bottom: 2px solid #cccccc;
-    margin: 30px 0px 10px 0px;
-    padding: 5px 0 5px 10px;
-}
-.contents h2 {
-    font-size: 12pt;
-    font-family: monospace;
-    color: #4D4D74;
-    font-weight: bold;
-    border-top: none;
-    border-bottom: 1px solid #dddddd;
-    margin: 20px 20% 20px 0px;
-    padding: 2px 0 2px 10px;
-}
-
-
-
-.contents p {
-    line-height: 130%;
-    font-size: 11pt;
-    font-family: sans-serif;
-    margin: 10px 20% 15px 10px;
-    padding: 0px;
-}
-
-.contents ul{
-    list-style-type: disc;
-    font-size: 11pt;
-    margin: 5px 20% 5px 40px;
-    padding: 0px;
-    line-height: 140%;
-}
-.contents ul ul{
-    list-style-type: circle;
-    margin-left: 30px;
-}
-.contents li{
-    padding: 2px 0 2px 0;
-    margin: 0;
-    ssbackground-color: pink;
-}
-
-.contents .textblock{
-    font-size: 10pt;
-    margin: 10px 50px 10px 50px;
-    line-height: 140%;
-}
-.contents .textblock code{
-    font-family: monospace;
-    font-size: 9pt;
-}
-.contents .todo{
-    font-size: 11pt;
-    margin: 10px 10% 20px 30px;
-}
-.contents .bug{
-    font-size: 11pt;
-    margin: 10px 10% 20px 30px;
-}
-
-dl
-{
-        padding: 0 0 0 10px;
-}
-
-/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
-dl.section
-{
-    margin-left: 0px;
-    padding-left: 0px;
-}
-
-dl.note
-{
-        margin: 5px 10% 5px 30px;
-        padding: 10px;
-        border-left: 4px solid;
-        border-color: #D0C000;
-        background-color: #FFFAC5;
-        border-radius: 10px;
-}
-
-ul dl.note{
-    margin-right: 0;
-}
-
-dl.warning, dl.attention
-{
-        margin: 5px 10% 5px 30px;
-        padding: 10px;
-        border-left: 4px solid;
-        border-color: #FF909F;
-        background-color: #FFE1E5;
-        border-radius: 10px;
-}
-
-dl.pre, dl.post, dl.invariant
-{
-        margin-left:-7px;
-        padding-left: 3px;
-        border-left:4px solid;
-        border-color: #00D000;
-}
-
-dl.deprecated
-{
-        margin: 5px 10% 5px 30px;
-        padding: 10px;
-        border-left:4px solid #B10BBF;
-        background-color: #FBC9FF;
-        border-radius: 10px;
-}
-
-dl.todo
-{
-        margin: 5px 10% 5px 30px;
-        padding: 10px;
-        border-left:4px solid #00C0E0;
-        background-color:  #DCFAFF ;
-        border-radius: 10px;
-}
-dl.bug
-{
-        margin: 5px 10% 5px 30px;
-        padding: 10px;
-        border-left:4px solid red;
-        background-color:  #FFC3B9 ;
-        border-radius: 10px;
-}
-dl.test
-{
-        margin-left:-7px;
-        padding-left: 3px;
-        border-left:4px solid;
-        border-color: #3030E0;
-}
-
-dl.bug
-{
-        margin-left:-7px;
-        padding-left: 3px;
-        border-left:4px solid;
-        border-color: #C08050;
-}
-
-
-
-dl.section dd {
-    margin-bottom: 6px;
-}
-
-
-
-table.directory tr {
-    border-bottom: 1px solid #cccccc !important;
-}
-
-table.directory  tr:hover {
-    background-color: #F6FF88 !important;
-}
-
-
-table.directory  td  {
-    padding: 5px;
-    font-family: sans-serif;
-}
-
-/*****************************************************/
-/* Quickref */
-table.quickref {
-    font-size: 9pt;
-    font-family: monospace;
-}
-table.quickref tr:hover{
-    background-color: #F6FF88;
-}
-table.quickref td.qrow {
-    border-bottom: 1px solid #cccccc !important;
-}
-table td.h2 {
-    padding: 0;
-    margin: 0;
-}
-.qh2 {
-    background-color: #333333;
-    color: #eeeeee !important;
-    padding: 10px;
-    border-radius: 5px;
-    border: none;
-    margin: 0;
-    padding: 8px;
-    font-size: 15pt;
-    width: 100%;
-    
-}
-table td.h3 {
-    background-color: #333333;
-    color: #eeeeee;
-    padding: 8px;
-    border-top-left-radius: 8px;
-}
-table td.h3top {
-    background-color: #333333;
-    padding: 8px;
-    border-top-right-radius: 8px;
-    text-align: right;
-    font-size: 8pt;
-}
-table td.h3top a{
-       color: #dddddd !important;
-}
-.h3topssssa {
-    color: #333333;
-}
-
-
-table td.tabletitle {
-    background-color: #cccccc;
-    font-size: 8pt;
-}
-
-td.tabletitlelink {
-    font-size: 8pt;
-}
-td.qoptiontitletd {
- padding: 0;
- margin: 0;
-}
-h4.qoptiontitle {
-    background-color: #bbbbbb;
-    font-size: 11pt;
-    font-weight: bold;
-    font-family: monospace;
-    padding: 5px 5px 5px 10px;
-    margin: 0;
-    border-top-left-radius: 5px;
-    border-top-right-radius: 5px;
-}
-
-
-.qlabel {
-    text-align: right;
-    font-size: 9pt;
-    width: 80px;
-    border-bottom: 1px solid #bbbbbb;
-
-    background-color: #dddddd;
-    font-family: sans-serif;
-}
-.qvalu {
-    font-size: 9pt;
-    font-weight: bold;
-    border-bottom: 1px solid #bbbbbb;
-    font-family: monospace;
-    border-left: 1px solid #bbbbbb;
-}
-
-.qdescription {
-    font-size: 11pt;
-    color: #333333;
-    margin: 0;
-    padding: 5px;
-    line-height: 140%;
-    border-left: 1px solid #bbbbbb;
-    border-bottom: 1px solid #bbbbbb;
-}
\ No newline at end of file
diff --git a/build/documentation/tidy1.xsl b/build/documentation/tidy1.xsl
deleted file mode 100644
index db2e647..0000000
--- a/build/documentation/tidy1.xsl
+++ /dev/null
@@ -1,448 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-   
-   
-   
-   
-
-
-
-
-
-
-
-  .\" tidy man page for the HTML Tidy
-.TH TIDY 1 "" "HTML Tidy" ""
-
-
-
-
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.SH NAME
-\fBtidy\fR - check, correct, and pretty-print HTML(5) files
-.SH SYNOPSIS
-\fBtidy\fR [option ...] [file ...] [option ...] [file ...]
-.SH DESCRIPTION
-Tidy reads HTML, XHTML, and XML files and writes cleaned-up markup.  For HTML variants, it detects, reports, and corrects many common coding errors and strives to produce visually equivalent markup that is both conformant to the HTML specifications and that works in most browsers.
-.LP
-A common use of Tidy is to convert plain HTML to XHTML.  For generic XML files, Tidy is limited to correcting basic well-formedness errors and pretty printing.
-.LP
-If no input file is specified, Tidy reads the standard input.  If no output file is specified, Tidy writes the tidied markup to the standard output.  If no error file is specified, Tidy writes messages to the standard error.
-For command line options that expect a numerical argument, a default is assumed if no meaningful value can be found. 
-.SH OPTIONS
-
-.SH USAGE
-.LP
-Use \fB--\fR\fIoptionX valueX\fR for the detailed configuration option "optionX" with argument "valueX".  See also below under \fBDetailed Configuration Options\fR as to how to conveniently group all such options in a single config file.
-.LP
-Input/Output default to stdin/stdout respectively. Single letter options apart from \fB-f\fR and \fB-o\fR may be combined as in:
-.LP
-.in 1i
-\fBtidy -f errs.txt -imu foo.html\fR
-.SH ENVIRONMENT
-.TP
-.B HTML_TIDY
-Name of the default configuration file.  This should be an absolute path, since you will probably invoke \fBtidy\fR from different directories.  The value of HTML_TIDY will be parsed after the compiled-in default (defined with -DTIDY_CONFIG_FILE), but before any of the files specified using \fB-config\fR.
-.SH "EXIT STATUS"
-.IP 0
-All input files were processed successfully.
-.IP 1
-There were warnings.
-.IP 2
-There were errors.
-
-
-
-
-.SH ______________________________
-.SH "  "
-.SH "DETAILED CONFIGURATION OPTIONS"
-This section describes the Detailed (i.e., "expanded") Options, which may be specified by preceding each option with \fB--\fR at the command line, followed by its desired value, OR by placing the options and values in a configuration file, and telling tidy to read that file with the \fB-config\fR standard option.
-.SH SYNOPSIS
-\fBtidy --\fR\fIoption1 \fRvalue1 \fB--\fIoption2 \fRvalue2 [standard options ...]
-.br
-\fBtidy -config \fIconfig-file \fR[standard options ...]
-.SH WARNING
-The options detailed here do not include the "standard" command-line options (i.e., those preceded by a single '\fB-\fR') described above in the first section of this man page.
-.SH DESCRIPTION
-A list of options for configuring the behavior of Tidy, which can be passed either on the command line, or specified in a configuration file.
-.LP
-A Tidy configuration file is simply a text file, where each option
-is listed on a separate line in the form
-.LP
-.in 1i
-\fBoption1\fR: \fIvalue1\fR
-.br
-\fBoption2\fR: \fIvalue2\fR
-.br
-etc.
-.LP
-The permissible values for a given option depend on the option's \fBType\fR.  There are five types: \fIBoolean\fR, \fIAutoBool\fR, \fIDocType\fR, \fIEnum\fR, and \fIString\fR. Boolean types allow any of \fIyes/no, y/n, true/false, t/f, 1/0\fR.  AutoBools allow \fIauto\fR in addition to the values allowed by Booleans.  Integer types take non-negative integers.  String types generally have no defaults, and you should provide them in non-quoted form (unless you wish the output to contain the literal quotes).
-.LP
-Enum, Encoding, and DocType "types" have a fixed repertoire of items; consult the \fIExample\fR[s] provided below for the option[s] in question.
-.LP
-You only need to provide options and values for those whose defaults you wish to override, although you may wish to include some already-defaulted options and values for the sake of documentation and explicitness.
-.LP
-Here is a sample config file, with at least one example of each of the five Types:
-.LP
-\fI
-    // sample Tidy configuration options
-    output-xhtml: yes
-    add-xml-decl: no
-    doctype: strict
-    char-encoding: ascii
-    indent: auto
-    wrap: 76
-    repeated-attributes: keep-last
-    error-file: errs.txt
-\fR
-.LP
-Below is a summary and brief description of each of the options. They are listed alphabetically within each category.  There are five categories: \fIHTML, XHTML, XML\fR options, \fIDiagnostics\fR options, \fIPretty Print\fR options, \fICharacter Encoding\fR options, and \fIMiscellaneous\fR options.
-.LP
-.SH OPTIONS
-
-
-
-
-
-.SS File manipulation
-  
-     file-manip
-  
-.SS Processing directives
-  
-     process-directives
-  
-.SS Character encodings
-  
-     char-encoding
-  
-.SS Miscellaneous
-  
-     misc
-  
-
-
-
-
-
-  
-    
-
-.TP
-
-       
-       
-
-       
-       
-
-       
-    
-
-
-
-
-
-  
-    \fB\fR
-    
-      , 
-    
-  
-
-
-
-
-
-  
-   
-     (\fI
-     
-     \fR)
-   
-  
-
-
-
-
-
-.SS HTML, XHTML, XML options:
-  
-     markup
-  
-.SS Diagnostics options:
-  
-     diagnostics
-  
-.SS Pretty Print options:
-  
-     print
-  
-.SS Character Encoding options:
-  
-     encoding
-  
-.SS Miscellaneous options:
-  
-     misc
-  
-
-
-
-
-
-
-
-  
-    
-       
-.TP
-\fB\fR
-
-Type:    \fI\fR
-.br
-
-.br
-
-
-
-
-
-
-    
-
-
-
-
-
-  
-     
-
-
-.rj 1
-\fBSee also\fR: 
-    
-      \fI\fR
-      
-        , 
-      
-    
-  
-
-
-
-
-
-
-  
-    
-      Default: \fI\fR
-    
-    
-      Default: \fI-\fR
-    
-  
-
-
-
-
-
-
-  
-    
-      Example: \fI\fR
-    
-    
-      Default: \fI-\fR
-    
-  
-
-
-
-
-
-
-  
-    
-      
-    
-    
-      
-    
-  
-
-
-
-
-
-.SH SEE ALSO
-For more information about HTML Tidy:
-.RS 4
-.LP
-http://www.html-tidy.org/
-.RE
-.LP
-For more information on HTML:
-.RS 4
-.LP
-\fBHTML: Edition for Web Authors\fR (the latest HTML specification)
-.br
-http://dev.w3.org/html5/spec-author-view
-.LP
-\fBHTML: The Markup Language\fR (an HTML language reference)
-.br
-http://dev.w3.org/html5/markup/
-.RE
-.LP
-For bug reports and comments:
-.RS 4
-.LP
-https://github.com/htacg/tidy-html5/issues/
-.RE
-.LP
-Or send questions and comments to \fBpublic-htacg@w3.org\fR.
-.LP
-Validate your HTML documents using the \fBW3C Nu Markup Validator\fR:
-.RS 4
-.LP
-http://validator.w3.org/nu/
-.RE
-.SH AUTHOR
-\fBTidy\fR was written by \fBDave Raggett\fR <dsr@w3.org>, and subsequently maintained by a team at http://tidy.sourceforge.net/,
-and now maintained by \fBHTACG\fR (http://www.htacg.org).
-.LP
-The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-html5/ under the MIT Licence.
-
-
-
-
-
-
-
-   
-
-
-
-   
-    at \fI\fR
-
-
-
-   \fI\fR
-
-
-
-   
-.br
-
-
-
-
-   \fB\fR
-
-
-
-
-
-
-   
-   
-
-
-
-   
-   
-
-
-
-   
-   
-
-
-
-   
-
-
-
diff --git a/build/documentation/build_docs.sh b/documentation/build_docs.sh
similarity index 96%
rename from build/documentation/build_docs.sh
rename to documentation/build_docs.sh
index e70b0a3..b937d6a 100755
--- a/build/documentation/build_docs.sh
+++ b/documentation/build_docs.sh
@@ -7,9 +7,9 @@
 # documentation. Relative path is okay. You shouldn't have to change this
 # too often if your compiler always puts tidy in the same place.
 
-TIDY_PATH="../cmake/tidy"         # Current directory.
+TIDY_PATH="../build/cmake/tidy"         # Build directory.
 
-TIDY_VERSION=`cat ../../version.txt`
+TIDY_VERSION=`cat ../version.txt`       # Project root directory.
 
 
 cat << HEREDOC

From 4ac07978dfeb48a7829e55da5e1d6d85ac6692ff Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 10:58:28 +0800
Subject: [PATCH 07/23] Fix CMakeLists references to old paths.

---
 CMakeLists.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 46f0841..b3e0ba2 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -277,7 +277,7 @@ if (UNIX)
                     COMMAND xsltproc ARGS quickref.include.xsl ${TIDYCONFIG} > ${EXP_DIR}/quickref_include.html # delete later
                     COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME} -h > ${EXP_DIR}/tidy5.help.txt # delete later
                     COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME} -help-config > ${EXP_DIR}/tidy5.config.txt   # delete later
-                    COMMAND cp ARGS ../LICENSE.md ${EXP_DIR}  # delete later
+                    COMMAND cp ARGS ../README/LICENSE.md ${EXP_DIR}  # delete later
                     )
                 #=========================================
                 # Run Doxygen.
@@ -344,11 +344,11 @@ set(CPACK_PACKAGE_VERSION ${LIBTIDY_VERSION})
 set(CPACK_PACKAGE_VERSION_MAJOR "${TIDY_MAJOR_VERSION}")
 set(CPACK_PACKAGE_VERSION_MINOR "${TIDY_MINOR_VERSION}")
 set(CPACK_PACKAGE_VERSION_PATCH "${TIDY_POINT_VERSION}")
-set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.html")
+set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
 
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.html")
-set(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_CURRENT_SOURCE_DIR}/README.html")
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/README/LICENSE.txt")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
+set(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
 
 ## debian config
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER ${CPACK_PACKAGE_CONTACT})

From 354c31e5dd233b01dc32db66974b58ac27eeb39c Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 10:58:51 +0800
Subject: [PATCH 08/23] Formatting.

---
 documentation/README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/documentation/README.md b/documentation/README.md
index 8628790..efbd7d3 100644
--- a/documentation/README.md
+++ b/documentation/README.md
@@ -1,6 +1,7 @@
 Documentation
 =============
 
-This directory does _not_ contain documentation for HTML Tidy. It consists of files used for generating documentation for HTML Tidy.
+This directory does _not_ contain documentation for HTML Tidy. It consists of
+files used for generating documentation for HTML Tidy.
 
 Please consult the main README file for more information.

From e6ceaa8589238c6404670012a7defb49911464b9 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 10:59:35 +0800
Subject: [PATCH 09/23] Additional documentation for the dependent file.

---
 documentation/tidy1.xsl.in | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/documentation/tidy1.xsl.in b/documentation/tidy1.xsl.in
index e10efc7..3875646 100644
--- a/documentation/tidy1.xsl.in
+++ b/documentation/tidy1.xsl.in
@@ -21,7 +21,9 @@
     command line to the XSLT processor, currently "tidy-help.xml".
     For the detailed config options section however, the template
     match is to the file "tidy-config.xml".  This is captured in
-    the $CONFIG variable, declared here:
+    the $CONFIG variable, declared here. CMAKE configure will
+    substitute TIDYCONFIG during the build. Shell scripts will
+    have to do the same.
 -->
 
 

From 9e033cab225474dc55d5ab5f8d97450d5314d273 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 11:00:27 +0800
Subject: [PATCH 10/23] Non cmake build system works again.

---
 documentation/build_docs.sh | 44 ++++++++++++++++---------------------
 1 file changed, 19 insertions(+), 25 deletions(-)

diff --git a/documentation/build_docs.sh b/documentation/build_docs.sh
index b937d6a..fdae38a 100755
--- a/documentation/build_docs.sh
+++ b/documentation/build_docs.sh
@@ -7,9 +7,9 @@
 # documentation. Relative path is okay. You shouldn't have to change this
 # too often if your compiler always puts tidy in the same place.
 
-TIDY_PATH="../build/cmake/tidy"         # Build directory.
+TIDY_PATH="../build/cmake/tidy"          # Build directory.
 
-TIDY_VERSION=`cat ../version.txt`       # Project root directory.
+TIDY_VERSION=`head -n 1 ../version.txt`  # In project root directory.
 
 
 cat << HEREDOC
@@ -31,8 +31,8 @@ HEREDOC
 
 
 # Output and flags' declarations.
-DOXY_CFG="doxygen.cfg"
-OUTP_DIR="temp"
+DOXY_CFG="./doxygen.cfg"
+OUTP_DIR="./temp"
 BUILD_XSLT=1
 BUILD_API=1
 
@@ -66,20 +66,21 @@ hash xsltproc 2>/dev/null || { echo "- xsltproc not found. You require an XSLT p
 if [ "$BUILD_XSLT" -eq 1 ]; then
 	# Use the designated tidy to get its config and help.
 	# These temporary files will be cleaned up later.
-	$TIDY_PATH -xml-config > "tidy-config.xml"
-	$TIDY_PATH -xml-help > "tidy-help.xml"
+	$TIDY_PATH -xml-config > "$OUTP_DIR/tidy-config.xml"
+	$TIDY_PATH -xml-help > "$OUTP_DIR/tidy-help.xml"
 
-	# 'quickref.html'
-	xsltproc "quickref.xsl" "tidy-config.xml" > "$OUTP_DIR/quickref.html"
-	xsltproc "quickref.include.xsl" "tidy-config.xml" > ./examples/quickref_include.html
+	# 'quickref.html' and 'quickref_include.html' for the Doxygen build.
+	xsltproc "./quickref.xsl" "$OUTP_DIR/tidy-config.xml" > "$OUTP_DIR/quickref.html"
+	xsltproc "./quickref.include.xsl" "$OUTP_DIR/tidy-config.xml" > ./examples/quickref_include.html
 
-	# 'tidy.1'
-	xsltproc "tidy1.xsl" "tidy-help.xml" > "$OUTP_DIR/tidy.1"
+	# 'tidy.1'; create a valid tidy1.xsl first by subbing CMAKE's variable.
+	sed "s|@TIDYCONFIG@|./tidy-config.xml|g" < ./tidy1.xsl.in > "$OUTP_DIR/tidy1.xsl"
+	xsltproc "$OUTP_DIR/tidy1.xsl" "$OUTP_DIR/tidy-help.xml" > "$OUTP_DIR/tidy.1"
 
-	# Cleanup - Note: to avoid issues with the tidy1.xsl finding the tidy-config.xml
-	# document, they are created and read from the source directory instead of temp.
-	rm "tidy-config.xml"
-	rm "tidy-help.xml"
+	# Cleanup
+	rm "$OUTP_DIR/tidy-config.xml"
+	rm "$OUTP_DIR/tidy-help.xml"
+	rm "$OUTP_DIR/tidy1.xsl"
 	
 	echo "'quickref.html' and 'tidy.1' have been built.\n"
 else
@@ -114,11 +115,11 @@ if [ "$BUILD_API" -eq 1 ]; then
   
   
   ## copy license file to examples for includsing
-  cp ../../LICENSE.md ./examples/
+  cp ../README/LICENSE.md ./examples/
   
   ## this lot 
-  # - echos and catches outputs the doxygen config
-  # - overwrites some vars but appending some to config an end
+  # - echoes and catches output of the doxygen config
+  # - overwrites some vars but appending some to config at end
   # - which are then passed to doxygen as stdin (instead of the path to a config.file)
   ( cat "$DOXY_CFG"; \
     echo "PROJECT_NUMBER=$TIDY_VERSION"; \
@@ -131,13 +132,6 @@ if [ "$BUILD_API" -eq 1 ]; then
     rm "./examples/tidy5.config.txt"
     rm "./examples/LICENSE.md"
     
-    ## create zip file of docs
-    cd $OUTP_DIR;
-    #zip  -r "tidy-docs-$TIDY_VERSION.zip" ./tidylib_api
-    
-    
-    
-    
   echo "\nTidyLib API documentation has been built."
 else
   echo "* $OUTP_DIR/tidylib_api/ was skipped because not all dependencies were satisfied."

From d712cec4c5846c6a16785043d5181da78040d6d1 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 11:02:20 +0800
Subject: [PATCH 11/23] This file shouldn't be tracked.

---
 documentation/quickref.html | 2821 -----------------------------------
 1 file changed, 2821 deletions(-)
 delete mode 100644 documentation/quickref.html

diff --git a/documentation/quickref.html b/documentation/quickref.html
deleted file mode 100644
index a8ded4f..0000000
--- a/documentation/quickref.html
+++ /dev/null
@@ -1,2821 +0,0 @@
-
-
-  
-    
-    HTML Tidy Configuration Options Quick Reference
-    
-  
-  
-    
Quick Reference

-    
HTML Tidy Configuration Options

-    
Version: 4.9.30

-    

-      HTML, XHTML, XML
-      

-      Diagnostics
-      

-      Pretty Print
-      

-      Character Encoding
-      

-      Miscellaneous
-    

-    
-      -        -        -        -      
-      
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-        
-        
-      
-      
-        
-      
-    





HTML, XHTML, XML Options
-          Top
-        
OptionTypeDefault

-          add-xml-decl
-        Booleanno

-          add-xml-space
-        Booleanno

-          alt-text
-        String
-          -
-        

-          anchor-as-name
-        Booleanyes

-          assume-xml-procins
-        Booleanno

-          bare
-        Booleanno

-          clean
-        Booleanno

-          coerce-endtags
-        Booleanyes

-          css-prefix
-        String
-          -
-        

-          decorate-inferred-ul
-        Booleanno

-          doctype
-        DocTypeauto

-          drop-empty-elements
-        Booleanyes

-          drop-empty-paras
-        Booleanyes

-          drop-font-tags
-        Booleanno

-          drop-proprietary-attributes
-        Booleanno

-          enclose-block-text
-        Booleanno

-          enclose-text
-        Booleanno

-          escape-cdata
-        Booleanno

-          fix-backslash
-        Booleanyes

-          fix-bad-comments
-        Booleanyes

-          fix-uri
-        Booleanyes

-          gdoc
-        Booleanno

-          hide-comments
-        Booleanno

-          hide-endtags
-        Booleanno

-          indent-cdata
-        Booleanno

-          input-xml
-        Booleanno

-          join-classes
-        Booleanno

-          join-styles
-        Booleanyes

-          literal-attributes
-        Booleanno

-          logical-emphasis
-        Booleanno

-          lower-literals
-        Booleanyes

-          merge-divs
-        AutoBoolauto

-          merge-emphasis
-        Booleanyes

-          merge-spans
-        AutoBoolauto

-          ncr
-        Booleanyes

-          new-blocklevel-tags
-        Tag names
-          -
-        

-          new-empty-tags
-        Tag names
-          -
-        

-          new-inline-tags
-        Tag names
-          -
-        

-          new-pre-tags
-        Tag names
-          -
-        

-          numeric-entities
-        Booleanno

-          omit-optional-tags
-        Booleanno

-          output-html
-        Booleanno

-          output-xhtml
-        Booleanno

-          output-xml
-        Booleanno

-          preserve-entities
-        Booleanno

-          quote-ampersand
-        Booleanyes

-          quote-marks
-        Booleanno

-          quote-nbsp
-        Booleanyes

-          repeated-attributes
-        enumkeep-last

-          replace-color
-        Booleanno

-          show-body-only
-        AutoBoolno

-          uppercase-attributes
-        Booleanno

-          uppercase-tags
-        Booleanno

-          word-2000
-        Booleanno
 
Diagnostics Options
-          Top
-        
OptionTypeDefault

-          accessibility-check
-        enum0 (Tidy Classic)

-          show-errors
-        Integer6

-          show-info
-        Booleanyes

-          show-warnings
-        Booleanyes
 
Pretty Print Options
-          Top
-        
OptionTypeDefault

-          break-before-br
-        Booleanno

-          indent
-        AutoBoolno

-          indent-attributes
-        Booleanno

-          indent-spaces
-        Integer2

-          indent-with-tabs
-        Booleanno

-          markup
-        Booleanyes

-          punctuation-wrap
-        Booleanno

-          sort-attributes
-        enumnone

-          split
-        Booleanno

-          tab-size
-        Integer8

-          vertical-space
-        Booleanno

-          wrap
-        Integer68

-          wrap-asp
-        Booleanyes

-          wrap-attributes
-        Booleanno

-          wrap-jste
-        Booleanyes

-          wrap-php
-        Booleanyes

-          wrap-script-literals
-        Booleanno

-          wrap-sections
-        Booleanyes
 
Character Encoding Options
-          Top
-        
OptionTypeDefault

-          ascii-chars
-        Booleanno

-          char-encoding
-        Encodingutf8

-          input-encoding
-        Encodingutf8

-          language
-        String
-          -
-        

-          newline
-        enum
-          Platform dependent
-        

-          output-bom
-        AutoBoolauto

-          output-encoding
-        Encodingutf8
 
Miscellaneous Options
-          Top
-        
OptionTypeDefault

-          error-file
-        String
-          -
-        

-          force-output
-        Booleanno

-          gnu-emacs
-        Booleanno

-          gnu-emacs-file
-        String
-          -
-        

-          keep-time
-        Booleanno

-          output-file
-        String
-          -
-        

-          quiet
-        Booleanno

-          slide-style
-        String
-          -
-        

-          tidy-mark
-        Booleanyes

-          write-back
-        Booleanno
 

-    
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-      
-        
-        
-      
-      
-        
-        
-      
-      
-        
-      
-      
-        
-      
-    
 
HTML, XHTML, XML Options Reference
-    
 
add-xml-decl
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          char-encoding
-          

-          output-encoding
-        
This option specifies if Tidy should add the XML declaration when outputting XML or XHTML. Note that if the input already includes an <?xml ... ?> declaration then this option will be ignored. If the encoding for the output is different from "ascii", one of the utf encodings or "raw", the declaration is always added as required by the XML standard. 
 
add-xml-space
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should add xml:space="preserve" to elements such as <PRE>, <STYLE> and <SCRIPT> when generating XML. This is needed if the whitespace in such elements is to be parsed appropriately without having access to the DTD. 
 
alt-text
-          Top
-        
Type: String

-            Default: -
Example: -
This option specifies the default "alt=" text Tidy uses for <IMG> attributes. This feature is dangerous as it suppresses further accessibility warnings. You are responsible for making your documents accessible to people who can not see the images! 
 
anchor-as-name
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option controls the deletion or addition of the name attribute in elements where it can serve as anchor. If set to "yes", a name attribute, if not already existing, is added along an existing id attribute if the DTD allows it. If set to "no", any existing name attribute is removed if an id attribute exists or has been added. 
 
assume-xml-procins
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should change the parsing of processing instructions to require ?> as the terminator rather than >. This option is automatically set if the input is in XML. 
 
bare
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should strip Microsoft specific HTML from Word 2000 documents, and output spaces rather than non-breaking spaces where they exist in the input. 
 
clean
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          drop-font-tags
-        
This option specifies if Tidy should strip out surplus presentational tags and attributes replacing them by style rules and structural markup as appropriate. It works well on the HTML saved by Microsoft Office products. 
 
coerce-endtags
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should coerce a start tag into an end tag in cases where it looks like an end tag was probably intended; for example, given <span>foo <b>bar<b> baz</span>, Tidy will output <span>foo <b>bar</b> baz</span>. 
 
css-prefix
-          Top
-        
Type: String

-            Default: -
Example: -
This option specifies the prefix that Tidy uses for styles rules. By default, "c" will be used. 
 
decorate-inferred-ul
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should decorate inferred UL elements with some CSS markup to avoid indentation to the right. 
 
doctype
-          Top
-        
Type: DocType

-            Default: auto
Example: html5, omit, auto, strict, transitional, user
This option specifies the DOCTYPE declaration generated by Tidy.
If set to "omit" the output won't contain a DOCTYPE declaration.
If set to "html5" the DOCTYPE is set to "<!DOCTYPE html>".
If set to "auto" (the default) Tidy will use an educated guess based upon the contents of the document.
If set to "strict", Tidy will set the DOCTYPE to the HTML4 or XHTML1 strict DTD.
If set to "loose", the DOCTYPE is set to the HTML4 or XHTML1 loose (transitional) DTD. 
Alternatively, you can supply a string for the formal public identifier (FPI).

For example: 
doctype: "-//ACME//DTD HTML 3.14159//EN"

If you specify the FPI for an XHTML document, Tidy will set the system identifier to an empty string. For an HTML document, Tidy adds a system identifier only if one was already present in order to preserve the processing mode of some browsers. Tidy leaves the DOCTYPE for generic XML documents unchanged. --doctype omit implies --numeric-entities yes. This option does not offer a validation of the document conformance. 
 
drop-empty-elements
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should discard empty elements. 
 
drop-empty-paras
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should discard empty paragraphs. 
 
drop-font-tags
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          clean
-        
This option specifies if Tidy should discard <FONT> and <CENTER> tags without creating the corresponding style rules. This option can be set independently of the clean option. 
 
drop-proprietary-attributes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should strip out proprietary attributes, such as MS data binding attributes. 
 
enclose-block-text
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should insert a <P> element to enclose any text it finds in any element that allows mixed content for HTML transitional but not HTML strict. 
 
enclose-text
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should enclose any text it finds in the body element within a <P> element. This is useful when you want to take existing HTML and use it with a style sheet. 
 
escape-cdata
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should convert <![CDATA[]]> sections to normal text. 
 
fix-backslash
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should replace backslash characters "\" in URLs by forward slashes "/". 
 
fix-bad-comments
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should replace unexpected hyphens with "=" characters when it comes across adjacent hyphens. The default is yes. This option is provided for users of Cold Fusion which uses the comment syntax: <!--- ---> 
 
fix-uri
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should check attribute values that carry URIs for illegal characters and if such are found, escape them as HTML 4 recommends. 
 
gdoc
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          drop-font-tags
-        
This option specifies if Tidy should enable specific behavior for cleaning up HTML exported from Google Docs. 
 
hide-comments
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should print out comments. 
 
hide-endtags
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option is an alias for omit-optional-tags. 
 
indent-cdata
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should indent <![CDATA[]]> sections. 
 
input-xml
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should use the XML parser rather than the error correcting HTML parser. 
 
join-classes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          join-styles
-          

-          repeated-attributes
-        
This option specifies if Tidy should combine class names to generate a single new class name, if multiple class assignments are detected on an element. 
 
join-styles
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0		
-          join-classes
-          

-          repeated-attributes
-        
This option specifies if Tidy should combine styles to generate a single new style, if multiple style values are detected on an element. 
 
literal-attributes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies how Tidy deals with whitespace characters within attribute values. If the value is "no" (the default), Tidy "munges" or "normalizes" attribute values by replacing any newline or tab character with a single space character, and further by replacing any sequences of multiple whitespace characters with a single space. To force tidy to preserve the original, literal values of all attributes, and ensure that whitespace characters within attribute values are passed through unchanged, set this option to "yes". 
 
logical-emphasis
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should replace any occurrence of <I> by <EM> and any occurrence of <B> by <STRONG>. In both cases, the attributes are preserved unchanged. This option can be set independently of the clean and drop-font-tags options. 
 
lower-literals
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should convert the value of an attribute that takes a list of predefined values to lower case. This is required for XHTML documents. 
 
merge-divs
-          Top
-        
Type: AutoBool

-            Default: auto
Example: auto, y/n, yes/no, t/f, true/false, 1/0		
-          clean
-          

-          merge-spans
-        
Can be used to modify behavior of -c (--clean yes) option. This option specifies if Tidy should merge nested <div> such as "<div><div>...</div></div>". If set to "auto", the attributes of the inner <div> are moved to the outer one. As well, nested <div> with ID attributes are not merged. If set to "yes", the attributes of the inner <div> are discarded with the exception of "class" and "style". 
 
merge-emphasis
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should merge nested <b> and <i> elements; for example, for the case <b class="rtop-2">foo <b class="r2-2">bar</b> baz</b>, Tidy will output  <b class="rtop-2">foo bar baz</b>. 
 
merge-spans
-          Top
-        
Type: AutoBool

-            Default: auto
Example: auto, y/n, yes/no, t/f, true/false, 1/0		
-          clean
-          

-          merge-divs
-        
Can be used to modify behavior of -c (--clean yes) option. This option specifies if Tidy should merge nested <span> such as "<span><span>...</span></span>". The algorithm is identical to the one used by --merge-divs. 
 
ncr
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should allow numeric character references. 
 
new-blocklevel-tags
-          Top
-        
Type: Tag names

-            Default: -
Example: tagX, tagY, ...		
-          new-empty-tags
-          

-          new-inline-tags
-          

-          new-pre-tags
-        
This option specifies new block-level tags. This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Note you can't change the content model for elements such as <TABLE>, <UL>, <OL> and <DL>. This option is ignored in XML mode. 
 
new-empty-tags
-          Top
-        
Type: Tag names

-            Default: -
Example: tagX, tagY, ...		
-          new-blocklevel-tags
-          

-          new-inline-tags
-          

-          new-pre-tags
-        
This option specifies new empty inline tags. This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Remember to also declare empty tags as either inline or blocklevel. This option is ignored in XML mode. 
 
new-inline-tags
-          Top
-        
Type: Tag names

-            Default: -
Example: tagX, tagY, ...		
-          new-blocklevel-tags
-          

-          new-empty-tags
-          

-          new-pre-tags
-        
This option specifies new non-empty inline tags. This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. This option is ignored in XML mode. 
 
new-pre-tags
-          Top
-        
Type: Tag names

-            Default: -
Example: tagX, tagY, ...		
-          new-blocklevel-tags
-          

-          new-empty-tags
-          

-          new-inline-tags
-        
This option specifies new tags that are to be processed in exactly the same way as HTML's <PRE> element. This option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Note you can not as yet add new CDATA elements (similar to <SCRIPT>). This option is ignored in XML mode. 
 
numeric-entities
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          doctype
-          

-          preserve-entities
-        
This option specifies if Tidy should output entities other than the built-in HTML entities (&amp;, &lt;, &gt; and &quot;) in the numeric rather than the named entity form. Only entities compatible with the DOCTYPE declaration generated are used. Entities that can be represented in the output encoding are translated correspondingly. 
 
omit-optional-tags
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should omit optional start tags and end tags when generating output. Setting this option causes all tags for the html, head, and body elements to be omitted from output, as well as such end tags as </p>, </li>, </dt>, </dd>, </option>, </tr>, </td>, and </th>. This option is ignored for XML output. 
 
output-html
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should generate pretty printed output, writing it as HTML. 
 
output-xhtml
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should generate pretty printed output, writing it as extensible HTML. This option causes Tidy to set the DOCTYPE and default namespace as appropriate to XHTML. If a DOCTYPE or namespace is given they will checked for consistency with the content of the document. In the case of an inconsistency, the corrected values will appear in the output. For XHTML, entities can be written as named or numeric entities according to the setting of the "numeric-entities" option. The original case of tags and attributes will be preserved, regardless of other options. 
 
output-xml
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should pretty print output, writing it as well-formed XML. Any entities not defined in XML 1.0 will be written as numeric entities to allow them to be parsed by a XML parser. The original case of tags and attributes will be preserved, regardless of other options. 
 
preserve-entities
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should preserve the well-formed entities as found in the input. 
 
quote-ampersand
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output unadorned & characters as &amp;. 
 
quote-marks
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output " characters as &quot; as is preferred by some editing environments. The apostrophe character ' is written out as &#39; since many web browsers don't yet support &apos;. 
 
quote-nbsp
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output non-breaking space characters as entities, rather than as the Unicode character value 160 (decimal). 
 
repeated-attributes
-          Top
-        
Type: enum

-            Default: keep-last
Example: keep-first, keep-last		
-          join-classes
-          

-          join-styles
-        
This option specifies if Tidy should keep the first or last attribute, if an attribute is repeated, e.g. has two align attributes. 
 
replace-color
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should replace numeric values in color attributes by HTML/XHTML color names where defined, e.g. replace "#ffffff" with "white". 
 
show-body-only
-          Top
-        
Type: AutoBool

-            Default: no
Example: auto, y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should print only the contents of the body tag as an HTML fragment. If set to "auto", this is performed only if the body tag has been inferred. Useful for incorporating existing whole pages as a portion of another page. This option has no effect if XML output is requested. 
 
uppercase-attributes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output attribute names in upper case. The default is no, which results in lower case attribute names, except for XML input, where the original case is preserved. 
 
uppercase-tags
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output tag names in upper case. The default is no, which results in lower case tag names, except for XML input, where the original case is preserved. 
 
word-2000
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should go to great pains to strip out all the surplus stuff Microsoft Word 2000 inserts when you save Word documents as "Web pages". Doesn't handle embedded images or VML. You should consider using Word's "Save As: Web Page, Filtered". 
 
 
Diagnostics Options Reference
-    
 
accessibility-check
-          Top
-        
Type: enum

-            Default: 0 (Tidy Classic)
Example: 0 (Tidy Classic), 1 (Priority 1 Checks), 2 (Priority 2 Checks), 3 (Priority 3 Checks)
This option specifies what level of accessibility checking, if any, that Tidy should do. Level 0 is equivalent to Tidy Classic's accessibility checking. For more information on Tidy's accessibility checking, visit the Adaptive Technology Resource Centre at the University of Toronto. 
 
show-errors
-          Top
-        
Type: Integer

-            Default: 6
Example: 0, 1, 2, ...
This option specifies the number Tidy uses to determine if further errors should be shown. If set to 0, then no errors are shown. 
 
show-info
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should display info-level messages. 
 
show-warnings
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should suppress warnings. This can be useful when a few errors are hidden in a flurry of warnings. 
 
 
Pretty Print Options Reference
-    
 
break-before-br
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output a line break before each <BR> element. 
 
indent
-          Top
-        
Type: AutoBool

-            Default: no
Example: auto, y/n, yes/no, t/f, true/false, 1/0		
-          indent-spaces
-        
This option specifies if Tidy should indent block-level tags. If set to "auto", this option causes Tidy to decide whether or not to indent the content of tags such as TITLE, H1-H6, LI, TD, TD, or P depending on whether or not the content includes a block-level element. You are advised to avoid setting indent to yes as this can expose layout bugs in some browsers. 
 
indent-attributes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should begin each attribute on a new line. 
 
indent-spaces
-          Top
-        
Type: Integer

-            Default: 2
Example: 0, 1, 2, ...		
-          indent
-        
This option specifies the number of spaces Tidy uses to indent content, when indentation is enabled. 
 
indent-with-tabs
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
Set this option "on" to indent using tabs instead of the default spaces. The option TidyIndentSpaces controls the number of tabs output per level of indent, which is reset to 1, when this option is set on. And of course, indent must be enabled for this to have any effect. Note TidyTabSize controls converting input tabs to spaces. Set to zero to retain input tabs. 
 
markup
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should generate a pretty printed version of the markup. Note that Tidy won't generate a pretty printed version if it finds significant errors (see force-output). 
 
punctuation-wrap
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should line wrap after some Unicode or Chinese punctuation characters. 
 
sort-attributes
-          Top
-        
Type: enum

-            Default: none
Example: none, alpha
This option specifies that tidy should sort attributes within an element using the specified sort algorithm. If set to "alpha", the algorithm is an ascending alphabetic sort. 
 
split
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
Currently not used. Tidy Classic only. 
 
tab-size
-          Top
-        
Type: Integer

-            Default: 8
Example: 0, 1, 2, ...
This option specifies the number of columns that Tidy uses between successive tab stops. It is used to map tabs to spaces when reading the input. 
 
vertical-space
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should add some empty lines for readability. 
 
wrap
-          Top
-        
Type: Integer

-            Default: 68
Example: 0 (no wrapping), 1, 2, ...
This option specifies the right margin Tidy uses for line wrapping. Tidy tries to wrap lines so that they do not exceed this length. Set wrap to zero if you want to disable line wrapping. 
 
wrap-asp
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should line wrap text contained within ASP pseudo elements, which look like: <% ... %>. 
 
wrap-attributes
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          wrap-script-literals
-          

-          literal-attributes
-        
This option specifies if Tidy should line-wrap attribute values, for easier editing. Line wrapping means that if the value of an attribute causes a line to exceed the width specified by the "wrap" option, tidy will add one or more line breaks to the value, causing it to wrapped into multiple lines. Note that this option can be set independently of wrap-script-literals. Also note that by default, Tidy "munges" or "normalizes" attribute values by replacing any newline or tab character with a single space character, and further by replacing any sequences of multiple whitespace characters with a single space. To force Tidy to preserve the original, literal values of all attributes, and ensure that whitespace characters within attribute values are passed through unchanged, set the literal-attributes option to "yes". 
 
wrap-jste
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should line wrap text contained within JSTE pseudo elements, which look like: <# ... #>. 
 
wrap-php
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should line wrap text contained within PHP pseudo elements, which look like: <?php ... ?>. 
 
wrap-script-literals
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          wrap-attributes
-        
This option specifies if Tidy should line wrap string literals that appear in script attributes. Tidy wraps long script string literals by inserting a backslash character before the line break. 
 
wrap-sections
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should line wrap text contained within <![ ... ]> section tags. 
 
 
Character Encoding Options Reference
-    
 
ascii-chars
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0		
-          clean
-        
Can be used to modify behavior of -c (--clean yes) option.  If set to "yes" when using -c, &emdash;, &rdquo;, and other named character entities are downgraded to their closest ascii equivalents. 
 
char-encoding
-          Top
-        
Type: Encoding

-            Default: utf8
Example: raw, ascii, latin0, latin1, utf8, iso2022, mac, win1252, ibm858, utf16le, utf16be, utf16, big5, shiftjis		
-          input-encoding
-          

-          output-encoding
-        
This option specifies the character encoding Tidy uses for both the input and output. For ascii, Tidy will accept Latin-1 (ISO-8859-1) character values, but will use entities for all characters whose value > 127. For raw, Tidy will output values above 127 without translating them into entities. For latin1, characters above 255 will be written as entities. For utf8, Tidy assumes that both input and output is encoded as UTF-8. You can use iso2022 for files encoded using the ISO-2022 family of encodings e.g. ISO-2022-JP. For mac and win1252, Tidy will accept vendor specific character values, but will use entities for all characters whose value > 127. For unsupported encodings, use an external utility to convert to and from UTF-8. 
 
input-encoding
-          Top
-        
Type: Encoding

-            Default: utf8
Example: raw, ascii, latin0, latin1, utf8, iso2022, mac, win1252, ibm858, utf16le, utf16be, utf16, big5, shiftjis		
-          char-encoding
-        
This option specifies the character encoding Tidy uses for the input. See char-encoding for more info. 
 
language
-          Top
-        
Type: String

-            Default: -
Example: -
Currently not used, but this option specifies the language Tidy uses (for instance "en"). 
 
newline
-          Top
-        
Type: enum

-            Default: Platform dependent
Example: LF, CRLF, CR
The default is appropriate to the current platform: CRLF on PC-DOS, MS-Windows and OS/2, CR on Classic Mac OS, and LF everywhere else (Unix and Linux). 
 
output-bom
-          Top
-        
Type: AutoBool

-            Default: auto
Example: auto, y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should write a Unicode Byte Order Mark character (BOM; also known as Zero Width No-Break Space; has value of U+FEFF) to the beginning of the output; only for UTF-8 and UTF-16 output encodings. If set to "auto", this option causes Tidy to write a BOM to the output only if a BOM was present at the beginning of the input. A BOM is always written for XML/XHTML output using UTF-16 output encodings. 
 
output-encoding
-          Top
-        
Type: Encoding

-            Default: utf8
Example: raw, ascii, latin0, latin1, utf8, iso2022, mac, win1252, ibm858, utf16le, utf16be, utf16, big5, shiftjis		
-          char-encoding
-        
This option specifies the character encoding Tidy uses for the output. See char-encoding for more info. May only be different from input-encoding for Latin encodings (ascii, latin0, latin1, mac, win1252, ibm858). 
 
 
Miscellaneous Options Reference
-    
 
error-file
-          Top
-        
Type: String

-            Default: -
Example: -		
-          output-file
-        
This option specifies the error file Tidy uses for errors and warnings. Normally errors and warnings are output to "stderr". 
 
force-output
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should produce output even if errors are encountered. Use this option with care - if Tidy reports an error, this means Tidy was not able to, or is not sure how to, fix the error, so the resulting output may not reflect your intention. 
 
gnu-emacs
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should change the format for reporting errors and warnings to a format that is more easily parsed by GNU Emacs. 
 
gnu-emacs-file
-          Top
-        
Type: String

-            Default: -
Example: -
Used internally. 
 
keep-time
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should keep the original modification time of files that Tidy modifies in place. The default is no. Setting the option to yes allows you to tidy files without causing these files to be uploaded to a web server when using a tool such as SiteCopy. Note this feature is not supported on some platforms. 
 
output-file
-          Top
-        
Type: String

-            Default: -
Example: -		
-          error-file
-        
This option specifies the output file Tidy uses for markup. Normally markup is written to "stdout". 
 
quiet
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should output the summary of the numbers of errors and warnings, or the welcome or informational messages. 
 
slide-style
-          Top
-        
Type: String

-            Default: -
Example: -
Currently not used.  Tidy Classic only. 
 
tidy-mark
-          Top
-        
Type: Boolean

-            Default: yes
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should add a meta element to the document head to indicate that the document has been tidied. Tidy won't add a meta element if one is already present. 
 
write-back
-          Top
-        
Type: Boolean

-            Default: no
Example: y/n, yes/no, t/f, true/false, 1/0
This option specifies if Tidy should write back the tidied markup to the same file it read from. You are advised to keep copies of important files before tidying them, as on rare occasions the result may not be what you expect. 
 

-  
-

From 30b67f73624bc526614c1a15672c75b09b7fa607 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 14:44:13 +0800
Subject: [PATCH 12/23] Made labels consisten with quickref.

---
 documentation/pages/page_quickref.dox | 6 +++---
 documentation/quickref.include.xsl    | 9 +++++----
 2 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/documentation/pages/page_quickref.dox b/documentation/pages/page_quickref.dox
index 8ccf47b..fc280df 100644
--- a/documentation/pages/page_quickref.dox
+++ b/documentation/pages/page_quickref.dox
@@ -1,12 +1,12 @@
 /*!
 
-\page quick_ref Quick Ref
+\page quick_ref Quick Reference
 
-Quick reference generated from the tidy command
+HTML Tidy Configuration Options
 
 
 
 \htmlinclude quickref_include.html
 
 
-*/
\ No newline at end of file
+*/
diff --git a/documentation/quickref.include.xsl b/documentation/quickref.include.xsl
index da3012f..524d723 100644
--- a/documentation/quickref.include.xsl
+++ b/documentation/quickref.include.xsl
@@ -1,7 +1,8 @@
 
 
 
 
-  From 7c7330343e09fe7cde326859fb730e14b0a6cc64 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 14:45:30 +0800
Subject: [PATCH 13/23] Improved quickref and man.

---
 documentation/quickref.xsl | 638 +++++++++++++------------------------
 documentation/tidy1.xsl.in |  14 +-
 2 files changed, 222 insertions(+), 430 deletions(-)

diff --git a/documentation/quickref.xsl b/documentation/quickref.xsl
index 09e2413..260902b 100644
--- a/documentation/quickref.xsl
+++ b/documentation/quickref.xsl
@@ -1,7 +1,8 @@
 
 
 
 
-  

     
       



-    -      -      -      -    
+  






       markup
       HTML, XHTML, XML
@@ -89,8 +85,7 @@
 
 
 
-  

     

+  

       markup
       HTML, XHTML, XML
@@ -124,31 +119,32 @@
   
   
   
-  
-    
-    
-  
-  
-  
-    
-    
-      
-      
-      
+    
+      
-  
-  
-    
-  
+    
+  
+  
+    
+      
+      
+        
+        
+        
+      
+    
+  
 
 
@@ -157,417 +153,213 @@
   
   
 
-  
-    
-  
-  
-    
-  
-  
-    
-  
+  
+    
+      
+    
+  
     
-    
-      
-      
-    
-    
-      
-      
-    
-
-    
-      
-    
-
-    
-      
-    
+    
+      
+        
+      
+    
+    
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+      
+        
+        
+      
+    
-      
-        
-        
-        
+      
+        
+        
+        
 	
 
 
diff --git a/documentation/tidy1.xsl.in b/documentation/tidy1.xsl.in
index 3875646..e19faa2 100644
--- a/documentation/tidy1.xsl.in
+++ b/documentation/tidy1.xsl.in
@@ -258,7 +258,7 @@ For each option in one of the 5 categories/classes, provide its
 .TP
 \fB\fR
 
-Type:    \fI\fR
+Type:    
 .br
 
 .br
@@ -298,11 +298,11 @@ doesn't exist, or it's empty, a single '-' is provided.
 -->
   
     
-      Default: \fI\fR
+      Default: 
     
     
-      Default: \fI-\fR
+      Default: -
     
   
 
@@ -318,11 +318,11 @@ stylesheet-provided one. (Useful e.g. for `repeated-attributes`).
 -->
   
     
-      Example: \fI\fR
+      Example: 
     
     
-      Default: \fI-\fR
+      Default: -
     
   
 

From cf3c0293c085012fc2ab5972c8609cba42d99d96 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 14:45:51 +0800
Subject: [PATCH 14/23] Additional tests with our troublesome option.

---
 src/localize.c | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/src/localize.c b/src/localize.c
index 7297dd3..2decdd6 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -458,16 +458,19 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyDropFontTags,
    "Deprecated; do not use. This option is destructive to "
-   "<font> tags, and it will be removed from future versions of Tidy. "
-   "Use the clean option instead. "
-   "
If you do set this option despite the warning it will perform "
+   "<font> tags, and it will be removed from future "
+   "versions of Tidy. Use the clean option instead. "
+   "
"
+   "If you do set this option despite the warning it will perform "
    "as clean except styles will be inline instead of put into "
-   "a CSS class. <font> tags will be dropped completely and their styles "
-   "will not be preserved. "
-   "
If both clean and this option are enabled, "
-   "<font> tags will still be dropped completely, and other styles will "
-   "be preserved in a CSS class instead of inline. "
-   "
See clean for more information. "
+   "a CSS class. <font> tags will be dropped completely "
+   "and their styles will not be preserved. "
+   "
"
+   "If both clean and this option are enabled, "
+   "<font> tags will still be dropped completely, and "
+   "other styles will be preserved in a CSS class instead of inline. "
+   "
"
+   "See clean for more information. "
    , TidyDropFontTagsLinks
   },
   {TidyDropPropAttrs,

From e0f42bcaba2cdf82dc36f7b835fbf2a9ce6c3e73 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 17:33:43 +0800
Subject: [PATCH 15/23] Prototype (undocument) -help-option argument added to
 console app.

---
 console/tidy.c | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/console/tidy.c b/console/tidy.c
index 430df55..9d3fc1e 100644
--- a/console/tidy.c
+++ b/console/tidy.c
@@ -878,6 +878,26 @@ static void optionhelp( TidyDoc tdoc )
     ForEachSortedOption( tdoc, printOption );
 }
 
+static void optiondescribe( TidyDoc tdoc, char *tag )
+{
+    printf( "\nNote this help function is UNDOCUMENTED, and still needs work.\n" );
+
+    printf( "\n`%s`\n\n", tag );
+
+    TidyOptionId topt = tidyOptGetIdForName( tag );
+    
+    char *result = NULL;
+    if (topt < N_TIDY_OPTIONS)
+    {
+        result = (char*)tidyOptGetDoc( tdoc, tidyGetOption( tdoc, topt ) );
+    } else
+    {
+        result = "Unknown option.";
+    }
+    
+    printf( "%s\n\n", result );
+}
+
 static
 void printOptionValues( TidyDoc ARG_UNUSED(tdoc), TidyOption topt,
                         OptionDesc *d )
@@ -1096,6 +1116,19 @@ int main( int argc, char** argv )
                 tidyRelease( tdoc );
                 return 0; /* success */
             }
+            else if ( strcasecmp(arg, "help-option") == 0 )
+            {
+                if ( argc >= 3)
+                {
+                    optiondescribe( tdoc, argv[2] );
+                }
+                else
+                {
+                    printf( "%s", "Tidy option name must be specified.\n");
+                }
+                tidyRelease( tdoc );
+                return 0; /* success */
+            }
             else if ( strcasecmp(arg, "xml-config") == 0 )
             {
                 XMLoptionhelp( tdoc );

From 565d2ec2323f383d54e778d3a26309d0c8d618ba Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 18:30:02 +0800
Subject: [PATCH 16/23] Documentation beautification underway.

---
 src/localize.c | 90 +++++++++++++++++++++++++++++---------------------
 1 file changed, 53 insertions(+), 37 deletions(-)

diff --git a/src/localize.c b/src/localize.c
index 2decdd6..5469c50 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -379,29 +379,37 @@ static const TidyOptionDoc option_docs[] =
 {
   {TidyXmlDecl,
    "This option specifies if Tidy should add the XML declaration when "
-   "outputting XML or XHTML. Note that if the input already includes an "
-   "<?xml ... ?> declaration then this option will be ignored. "
-   "If the encoding for the output is different from \"ascii\", one of the "
-   "utf encodings or \"raw\", the declaration is always added as required by "
-   "the XML standard. "
+   "outputting XML or XHTML. "
+   "
"
+   "Note that if the input already includes an <?xml ... ?> "
+   "declaration then this option will be ignored. "
+   "
"
+   "If the encoding for the output is different from ascii, one "
+   "of the utf encodings or raw, the declaration is always added "
+   "as required by the XML standard. "
    , TidyXmlDeclLinks
   },
   {TidyXmlSpace,
-   "This option specifies if Tidy should add xml:space=\"preserve\" to "
-   "elements such as <PRE>, <STYLE> and <SCRIPT> when "
-   "generating XML. This is needed if the whitespace in such elements is to "
+   "This option specifies if Tidy should add "
+   "xml:space=\"preserve\" to elements such as "
+   "<PRE>, <STYLE> and "
+   "<SCRIPT> when generating XML. "
+   "
"
+   "This is needed if the whitespace in such elements is to "
    "be parsed appropriately without having access to the DTD. "
   },
   {TidyAltText,
-   "This option specifies the default \"alt=\" text Tidy uses for "
-   "<IMG> attributes. This feature is dangerous as it suppresses "
-   "further accessibility warnings. You are responsible for making your "
-   "documents accessible to people who can not see the images! "
+   "This option specifies the default alt= text Tidy uses for "
+   "<IMG> attributes. "
+   "
"
+   "Use with care, as this feature suppresses further accessibility warnings. "
   },
   {TidyXmlPIs,
    "This option specifies if Tidy should change the parsing of processing "
-   "instructions to require ?> as the terminator rather than >. This "
-   "option is automatically set if the input is in XML. "
+   "instructions to require ?> as the terminator rather than "
+   ">. "
+   "
"
+   "This option is automatically set if the input is in XML. "
   },
   {TidyMakeBare,
    "This option specifies if Tidy should strip Microsoft specific HTML "
@@ -409,39 +417,47 @@ static const TidyOptionDoc option_docs[] =
    "spaces where they exist in the input. "
   },
   {TidyCSSPrefix,
-   "This option specifies the prefix that Tidy uses for styles rules. By "
-   "default, \"c\" will be used. "
+   "This option specifies the prefix that Tidy uses for styles rules. "
+   "
"
+   "By default, c will be used. "
   },
   {TidyMakeClean,
-   "This option specifies if Tidy "
-   "should perform cleaning of some legacy presentational tags (currently "
-   "<i>, <b>, <center> when enclosed within appropriate "
-   "inline tags, and <font>). If set then legacy tags will be replaced "
-   "with CSS <style> tags and structural markup as appropriate. " 
+   "This option specifies if Tidy should perform cleaning of some legacy "
+   "presentational tags (currently <i>, "
+   "<b>, <center> when enclosed within "
+   "appropriate inline tags, and <font>). If set to "
+   "YES then legacy tags will be replaced with CSS "
+   "<style> tags and structural markup as appropriate. " 
    ,
   },
   {TidyGDocClean,
-   "This option specifies if Tidy "
-   "should enable specific behavior for cleaning up HTML exported from "
-   "Google Docs. "
+   "This option specifies if Tidy should enable specific behavior for "
+   "cleaning up HTML exported from Google Docs. "
    ,
   },
   {TidyDoctype,
-   "This option specifies the DOCTYPE declaration generated by Tidy.
"
-   "If set to \"omit\" the output won't contain a DOCTYPE declaration.
"
-   "If set to \"html5\" the DOCTYPE is set to \"<!DOCTYPE html>\".
"
-   "If set to \"auto\" (the default) Tidy will use an educated guess based "
-   "upon the contents of the document.
"
-   "If set to \"strict\", Tidy will set the DOCTYPE to the HTML4 or XHTML1 "
-   "strict DTD.
"
-   "If set to \"loose\", the DOCTYPE is set to the HTML4 or XHTML1 loose "
-   "(transitional) DTD. 
"
+   "This option specifies the DOCTYPE declaration generated by Tidy. "
+   "
"
+   "If set to omit the output won't contain a DOCTYPE declaration. "
+   "
"
+   "If set to html5 the DOCTYPE is set to <!DOCTYPE html>."
+   "
"
+   "If set to auto (the default) Tidy will use an educated guess "
+   "based upon the contents of the document."
+   "
"
+   "If set to strict, Tidy will set the DOCTYPE to the HTML4 or "
+   "XHTML1 strict DTD."
+   "
"
+   "If set to loose, the DOCTYPE is set to the HTML4 or XHTML1 "
+   "loose (transitional) DTD."
+   "
"
    "Alternatively, you can supply a string for the formal public identifier "
-   "(FPI).
"
-   "
"
-   "For example: 
"
-   "doctype: \"-//ACME//DTD HTML 3.14159//EN\"
"
+   "(FPI)."
    "
"
+   "For example: "
+   "
"
+   "doctype: \"-//ACME//DTD HTML 3.14159//EN\""
+   "
"
    "If you specify the FPI for an XHTML document, Tidy will set the "
    "system identifier to an empty string. For an HTML document, Tidy adds a "
    "system identifier only if one was already present in order to preserve "

From 2613f02dc5866308fffd4ca7be43d848fad27d24 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sat, 31 Oct 2015 22:03:33 +0800
Subject: [PATCH 17/23] More documentation beautification.

---
 src/localize.c | 171 +++++++++++++++++++++++++++++++------------------
 1 file changed, 109 insertions(+), 62 deletions(-)

diff --git a/src/localize.c b/src/localize.c
index 5469c50..0f8783c 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -426,7 +426,7 @@ static const TidyOptionDoc option_docs[] =
    "presentational tags (currently <i>, "
    "<b>, <center> when enclosed within "
    "appropriate inline tags, and <font>). If set to "
-   "YES then legacy tags will be replaced with CSS "
+   "yes then legacy tags will be replaced with CSS "
    "<style> tags and structural markup as appropriate. " 
    ,
   },
@@ -453,7 +453,7 @@ static const TidyOptionDoc option_docs[] =
    "
"
    "Alternatively, you can supply a string for the formal public identifier "
    "(FPI)."
-   "
"
+   "
"
    "For example: "
    "
"
    "doctype: \"-//ACME//DTD HTML 3.14159//EN\""
@@ -491,31 +491,36 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyDropPropAttrs,
    "This option specifies if Tidy should strip out proprietary attributes, "
-   "such as MS data binding attributes. "
+   "such as Microsoft data binding attributes. "
   },
   {TidyEncloseBlockText,
-   "This option specifies if Tidy should insert a <P> element to "
-   "enclose any text it finds in any element that allows mixed content for "
-   "HTML transitional but not HTML strict. "
+   "This option specifies if Tidy should insert a <P> "
+   "element to enclose any text it finds in any element that allows mixed "
+   "content for HTML transitional but not HTML strict. "
   },
   {TidyEncloseBodyText,
    "This option specifies if Tidy should enclose any text it finds in the "
-   "body element within a <P> element. This is useful when you want to "
-   "take existing HTML and use it with a style sheet. "
+   "body element within a <P> element."
+   "
"
+   "This is useful when you want to take existing HTML and use it with a "
+   "style sheet. "
   },
   {TidyEscapeCdata,
-   "This option specifies if Tidy should convert <![CDATA[]]> "
-   "sections to normal text. "
+   "This option specifies if Tidy should convert "
+   "<![CDATA[]]> sections to normal text. "
   },
   {TidyFixComments,
    "This option specifies if Tidy should replace unexpected hyphens with "
-   "\"=\" characters when it comes across adjacent hyphens. The default is "
-   "yes. This option is provided for users of Cold Fusion which uses the "
-   "comment syntax: <!--- ---> "
+   "= characters when it comes across adjacent hyphens. "
+   "
"
+   "The default is yes. "
+   "
"
+   "This option is provided for users of Cold Fusion which uses the "
+   "comment syntax: <!--- --->. "
   },
   {TidyFixUri,
    "This option specifies if Tidy should check attribute values that carry "
-   "URIs for illegal characters and if such are found, escape them as HTML 4 "
+   "URIs for illegal characters and if such are found, escape them as HTML4 "
    "recommends. "
   },
   {TidyHideComments,
@@ -524,22 +529,34 @@ static const TidyOptionDoc option_docs[] =
   {TidyCoerceEndTags,
    "This option specifies if Tidy should coerce a start tag into an end tag "
    "in cases where it looks like an end tag was probably intended; "
-   "for example, given <span>foo <b>bar<b> baz</span>, "
-   "Tidy will output <span>foo <b>bar</b> baz</span>. "
+   "for example, given "
+   "
"
+   "<span>foo <b>bar<b> baz</span> "
+   "
"
+   "Tidy will output "
+   "
"
+   "<span>foo <b>bar</b> baz</span> "
   },
   {TidyOmitOptionalTags,
    "This option specifies if Tidy should omit optional start tags and end tags "
-   "when generating output. Setting this option causes all tags for the "
-   "html, head, and body elements to be omitted from output, as well as such "
-   "end tags as </p>, </li>, </dt>, </dd>, "
-   "</option>, </tr>, </td>, and </th>. "
+   "when generating output. "
+   "
"
+   "Setting this option causes all tags for the <html>, "
+   "<head>, and <body> elements to be "
+   "omitted from output, as well as such end tags as </p>, "
+   "</li>, </dt>, "
+   "</dd>, </option>, "
+   "</tr>, </td>, and "
+   "</th>. "
+   "
"
    "This option is ignored for XML output. "
   },
   {TidyHideEndTags,
    "This option is an alias for omit-optional-tags. "
   },
   {TidyIndentCdata,
-   "This option specifies if Tidy should indent <![CDATA[]]> sections. "
+   "This option specifies if Tidy should indent "
+   "<![CDATA[]]> sections. "
   },
   {TidyXmlTags,
    "This option specifies if Tidy should use the XML parser rather than the "
@@ -547,47 +564,62 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyJoinClasses,
    "This option specifies if Tidy should combine class names to generate "
-   "a single new class name, if multiple class assignments are detected on "
+   "a single new class name if multiple class assignments are detected on "
    "an element. "
    , TidyJoinClassesLinks
   },
   {TidyJoinStyles,
    "This option specifies if Tidy should combine styles to generate a single "
-   "new style, if multiple style values are detected on an element. "
+   "new style if multiple style values are detected on an element. "
    , TidyJoinStylesLinks
   },
   {TidyLogicalEmphasis,
-   "This option specifies if Tidy should replace any occurrence of <I> "
-   "by <EM> and any occurrence of <B> by <STRONG>. In both "
-   "cases, the attributes are preserved unchanged. This option can be set "
-   "independently of the clean and drop-font-tags options. "
+   "This option specifies if Tidy should replace any occurrence of "
+   "<i> with <em> and any occurrence of "
+   "<b> with <strong>. Any attributes "
+   "are preserved unchanged. "
+   "
"
+   "This option can be set independently of the clean option. "
   },
   {TidyLowerLiterals,
    "This option specifies if Tidy should convert the value of an attribute "
-   "that takes a list of predefined values to lower case. This is required "
-   "for XHTML documents. "
+   "that takes a list of predefined values to lower case. "
+   "
"
+   "This is required for XHTML documents. "
   },
   {TidyMergeEmphasis,
-   "This option specifies if Tidy should merge nested <b> and <i> "
-   "elements; for example, for the case "
-   "<b class=\"rtop-2\">foo <b class=\"r2-2\">bar</b> baz</b>, "
-   "Tidy will output  <b class=\"rtop-2\">foo bar baz</b>. "
+   "This option specifies if Tidy should merge nested <b> "
+   "and <i> elements; for example, for the case "
+   "
"
+   "<b class=\"rtop-2\">foo <b class=\"r2-2\">bar</b> baz</b>, "
+   "
"
+   "Tidy will output <b class=\"rtop-2\">foo bar baz</b>. "
   },
   {TidyMergeDivs,
-   "Can be used to modify behavior of -c (--clean yes) option. "
-   "This option specifies if Tidy should merge nested <div> such as "
-   "\"<div><div>...</div></div>\". If set to "
-   "\"auto\", the attributes of the inner <div> are moved to the "
-   "outer one. As well, nested <div> with ID attributes are not "
-   "merged. If set to \"yes\", the attributes of the inner <div> "
-   "are discarded with the exception of \"class\" and \"style\". "
+   "This option can be used to modify the behavior of clean when "
+   "set to yes."
+   "
"
+   "This option specifies if Tidy should merge nested <div> "
+   "such as <div><div>...</div></div>. "
+   "
"
+   "If set to auto the attributes of the inner "
+   "<div> are moved to the outer one. Nested "
+   "<div> with id attributes are not "
+   "merged. "
+   "
"
+   "If set to yes the attributes of the inner "
+   "<div> are discarded with the exception of "
+   "class and style. "
    ,TidyMergeDivsLinks
   },
   {TidyMergeSpans,
-   "Can be used to modify behavior of -c (--clean yes) option. "
-   "This option specifies if Tidy should merge nested <span> such as "
-   "\"<span><span>...</span></span>\". The algorithm "
-   "is identical to the one used by --merge-divs. "
+   "This option can be used to modify the behavior of clean when "
+   "set to yes."
+   "
"
+   "This option specifies if Tidy should merge nested <span> "
+   "such as <span><span>...</span></span>. "
+   "
"
+   "The algorithm is identical to the one used by merge-divs. "
    ,TidyMergeSpansLinks
   },
 #if SUPPORT_ASIAN_ENCODINGS
@@ -597,35 +629,50 @@ static const TidyOptionDoc option_docs[] =
 #endif
   {TidyBlockTags,
    "This option specifies new block-level tags. This option takes a space or "
-   "comma separated list of tag names. Unless you declare new tags, Tidy will "
-   "refuse to generate a tidied file if the input includes previously unknown "
-   "tags. Note you can't change the content model for elements such as "
-   "<TABLE>, <UL>, <OL> and <DL>. This option is "
-   "ignored in XML mode. "
+   "comma separated list of tag names. "
+   "
"
+   "Unless you declare new tags, Tidy will refuse to generate a tidied file if "
+   "the input includes previously unknown tags. "
+   "
"
+   "Note you can't change the content model for elements such as "
+   "<table>, <ul>, "
+   "<ol> and <dl>. "
+   "
"
+   "This option is ignored in XML mode. "
    ,TidyBlockTagsLinks
   },
   {TidyEmptyTags,
    "This option specifies new empty inline tags. This option takes a space "
-   "or comma separated list of tag names. Unless you declare new tags, Tidy "
-   "will refuse to generate a tidied file if the input includes previously "
-   "unknown tags. Remember to also declare empty tags as either inline or "
-   "blocklevel. This option is ignored in XML mode. "
+   "or comma separated list of tag names. "
+   "
"
+   "Unless you declare new tags, Tidy will refuse to generate a tidied file if "
+   "the input includes previously unknown tags. "
+   "
"
+   "Remember to also declare empty tags as either inline or blocklevel. "
+   "
"
+   "This option is ignored in XML mode. "
    ,TidyEmptyTagsLinks
   },
   {TidyInlineTags,
    "This option specifies new non-empty inline tags. This option takes a "
-   "space or comma separated list of tag names. Unless you declare new tags, "
-   "Tidy will refuse to generate a tidied file if the input includes "
-   "previously unknown tags. This option is ignored in XML mode. "
+   "space or comma separated list of tag names. "
+   "
"
+   "Unless you declare new tags, Tidy will refuse to generate a tidied file if "
+   "the input includes previously unknown tags. "
+   "
"
+   "This option is ignored in XML mode. "
    ,TidyInlineTagsLinks
   },
   { TidyPreTags,
-    "This option specifies "
-    "new tags that are to be processed in exactly the same way as HTML's "
-    "<PRE> element. This option takes a space or comma separated list "
-    "of tag names. Unless you declare new tags, Tidy will refuse to generate "
-    "a tidied file if the input includes previously unknown tags. Note you "
-    "can not as yet add new CDATA elements (similar to <SCRIPT>). "
+    "This option specifies new tags that are to be processed in exactly the "
+    "same way as HTML's <pre> element. This option takes a "
+    "space or comma separated list of tag names. "
+    "
"
+    "Unless you declare new tags, Tidy will refuse to generate a tidied file if "
+    "the input includes previously unknown tags. "
+    "
"
+    "Note you can not as yet add new CDATA elements. "
+    "
"
     "This option is ignored in XML mode. "
     ,TidyPreTagsLinks
   },

From 807fed4ff6b25f908ad77cc75b9844f10dca4827 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Sun, 1 Nov 2015 19:05:03 +0800
Subject: [PATCH 18/23] Documentation improvements.

---
 src/localize.c | 73 +++++++++++++++++++++++++++++++-------------------
 1 file changed, 45 insertions(+), 28 deletions(-)

diff --git a/src/localize.c b/src/localize.c
index 0f8783c..cdd8e05 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -678,10 +678,14 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyNumEntities,
    "This option specifies if Tidy should output entities other than the "
-   "built-in HTML entities (&amp;, &lt;, &gt; and &quot;) in "
-   "the numeric rather than the named entity form. Only entities compatible "
-   "with the DOCTYPE declaration generated are used. Entities that can be "
-   "represented in the output encoding are translated correspondingly. "
+   "built-in HTML entities (&amp;, &lt;, "
+   "&gt;, and &quot;) in the numeric rather "
+   "than the named entity form. "
+   "
"
+   "Only entities compatible with the DOCTYPE declaration generated are used. "
+   "
"
+   "Entities that can be represented in the output encoding are translated "
+   "correspondingly. "
     ,TidyNumEntitiesLinks
   },
   {TidyHtmlOut,
@@ -691,30 +695,38 @@ static const TidyOptionDoc option_docs[] =
   {TidyXhtmlOut,
    "This option specifies if Tidy should generate pretty printed output, "
    "writing it as extensible HTML. "
+   "
"
    "This option causes Tidy to set the DOCTYPE and default namespace as "
-   "appropriate to XHTML. If a DOCTYPE or namespace is given they will "
-   "checked for consistency with the content of the document. In the case of "
-   "an inconsistency, the corrected values will appear in the output. For "
-   "XHTML, entities can be written as named or numeric entities according to "
-   "the setting of the \"numeric-entities\" option. The original case of tags "
-   "and attributes will be preserved, regardless of other options. "
+   "appropriate to XHTML, and will use the corrected value in output "
+   "regardless of other sources. "
+   "
"
+   "For XHTML, entities can be written as named or numeric entities according "
+   "to the setting of numeric-entities. "
+   "
"
+   "The original case of tags and attributes will be preserved, regardless of "
+   "other options. "
   },
   {TidyXmlOut,
    "This option specifies if Tidy should pretty print output, writing it as "
-   "well-formed XML. Any entities not defined in XML 1.0 will be written as "
-   "numeric entities to allow them to be parsed by a XML parser. The original "
-   "case of tags and attributes will be preserved, regardless of other "
-   "options. "
+   "well-formed XML. "
+   "
"
+   "Any entities not defined in XML 1.0 will be written as numeric entities to "
+   "allow them to be parsed by an XML parser. "
+   "
"
+   "The original case of tags and attributes will be preserved, regardless of "
+   "other options. "
   },
   {TidyQuoteAmpersand,
-   "This option specifies if Tidy should output unadorned & characters as "
-   "&amp;. "
+   "This option specifies if Tidy should output unadorned & "
+   "characters as &amp;. "
   },
   {TidyQuoteMarks,
-   "This option specifies if Tidy should output " characters as "
-   "&quot; as is preferred by some editing environments. The apostrophe "
-   "character ' is written out as &#39; since many web browsers don't yet "
-   "support &apos;. "
+   "This option specifies if Tidy should output " characters "
+   "as &quot; as is preferred by some editing environments. "
+   "
"
+   "The apostrophe character ' is written out as "
+   "&#39; since many web browsers don't yet support "
+   "&apos;. "
   },
   {TidyQuoteNbsp,
    "This option specifies if Tidy should output non-breaking space characters "
@@ -722,24 +734,29 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyDuplicateAttrs,
    "This option specifies if Tidy should keep the first or last attribute, if "
-   "an attribute is repeated, e.g. has two align attributes. "
+   "an attribute is repeated, e.g. has two align attributes. "
    , TidyDuplicateAttrsLinks
   },
   {TidySortAttributes,
    "This option specifies that tidy should sort attributes within an element "
-   "using the specified sort algorithm. If set to \"alpha\", the algorithm is "
-   "an ascending alphabetic sort. "
+   "using the specified sort algorithm. If set to alpha, the "
+   "algorithm is an ascending alphabetic sort. "
   },
   {TidyReplaceColor,
    "This option specifies if Tidy should replace numeric values in color "
-   "attributes by HTML/XHTML color names where defined, e.g. replace "
-   "\"#ffffff\" with \"white\". "
+   "attributes with HTML/XHTML color names where defined, e.g. replace "
+   "#ffffff with white. "
   },
   {TidyBodyOnly,
    "This option specifies if Tidy should print only the contents of the "
-   "body tag as an HTML fragment. If set to \"auto\", this is performed only "
-   "if the body tag has been inferred. Useful for incorporating "
-   "existing whole pages as a portion of another page. "
+   "body tag as an HTML fragment. "
+   "
"
+   "If set to auto, this is performed only if the body tag has "
+   "been inferred. "
+   "
"
+   "Useful for incorporating existing whole pages as a portion of another "
+   "page. "
+   "
"
    "This option has no effect if XML output is requested. "
   },
   {TidyUpperCaseAttrs,

From af97d6a8cdb62707c2f53216fc67e3d4e181b7bc Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Mon, 2 Nov 2015 11:31:58 +0800
Subject: [PATCH 19/23] better spacing in man.

---
 documentation/tidy1.xsl.in | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/documentation/tidy1.xsl.in b/documentation/tidy1.xsl.in
index e19faa2..9506feb 100644
--- a/documentation/tidy1.xsl.in
+++ b/documentation/tidy1.xsl.in
@@ -253,6 +253,8 @@ For each option in one of the 5 categories/classes, provide its
     6. description
 -->
   
+.rs
+.sp 1
     
        
 .TP

From d0ac990636f22ef86e8ce0a076504a9e21583ee4 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Mon, 2 Nov 2015 12:06:37 +0800
Subject: [PATCH 20/23] More description beautification.

---
 src/localize.c | 102 ++++++++++++++++++++++++++++++-------------------
 1 file changed, 63 insertions(+), 39 deletions(-)

diff --git a/src/localize.c b/src/localize.c
index cdd8e05..f210c87 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -761,30 +761,37 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyUpperCaseAttrs,
    "This option specifies if Tidy should output attribute names in upper "
-   "case. The default is no, which results in lower case attribute names, "
-   "except for XML input, where the original case is preserved. "
+   "case. "
+   "
"
+   "The default is no, which results in lower case attribute "
+   "names, except for XML input, where the original case is preserved. "
   },
   {TidyUpperCaseTags,
    "This option specifies if Tidy should output tag names in upper case. "
-   "The default is no, which results in lower case tag names, except for XML "
-   "input, where the original case is preserved. "
+   "
"
+   "The default is no which results in lower case tag names, "
+   "except for XML input where the original case is preserved. "
   },
   {TidyWord2000,
    "This option specifies if Tidy should go to great pains to strip out all "
    "the surplus stuff Microsoft Word 2000 inserts when you save Word "
-   "documents as \"Web pages\". Doesn't handle embedded images or VML. "
+   "documents as \"Web pages\". It doesn't handle embedded images or VML. "
+   "
"
    "You should consider using Word's \"Save As: Web Page, Filtered\". "
   },
   {TidyAccessibilityCheckLevel,
    "This option specifies what level of accessibility checking, if any, "
-   "that Tidy should do. Level 0 is equivalent to Tidy Classic's "
-   "accessibility checking. "
+   "that Tidy should perform. "
+   "
"
+   "Level 0 (Tidy Classic) is equivalent to Tidy Classic's accessibility "
+   "checking. "
+   "
"
    "For more information on Tidy's accessibility checking, visit "
    " Tidy's Accessibility Page. "
   },
   {TidyShowErrors,
    "This option specifies the number Tidy uses to determine if further errors "
-   "should be shown. If set to 0, then no errors are shown. "
+   "should be shown. If set to 0, then no errors are shown. "
   },
   {TidyShowInfo,
    "This option specifies if Tidy should display info-level messages. "
@@ -795,14 +802,18 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyBreakBeforeBR,
    "This option specifies if Tidy should output a line break before each "
-   "<BR> element. "
+   "<br> element. "
   },
   {TidyIndentContent,
-   "This option specifies if Tidy should indent block-level tags. If set to "
-   "\"auto\", this option causes Tidy to decide whether or not to indent the "
-   "content of tags such as TITLE, H1-H6, LI, TD, TD, or P depending on "
-   "whether or not the content includes a block-level element. You are "
-   "advised to avoid setting indent to yes as this can expose layout bugs in "
+   "This option specifies if Tidy should indent block-level tags. "
+   "
"
+   "If set to auto Tidy will decide whether or not to indent the "
+   "content of tags such as <title>, "
+   "<h1>-<h6>, <li>, "
+   "<td>, or <p> "
+   "based on the content including a block-level element. "
+   "
"
+   "Setting indent to yes can expose layout bugs in "
    "some browsers. "
    ,TidyIndentContentLinks
   },
@@ -816,18 +827,20 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyLiteralAttribs,
    "This option specifies how Tidy deals with whitespace characters within "
-   "attribute values. If the value is \"no\" (the default), Tidy \"munges\" "
-   "or \"normalizes\" attribute values by replacing any newline or tab "
-   "character with a single space character, and further by replacing "
-   "any sequences of multiple whitespace characters with a single space. "
-   "To force tidy to preserve the original, literal values of all attributes, "
-   "and ensure that whitespace characters within attribute values are passed "
-   "through unchanged, set this option to \"yes\". "
+   "attribute values. "
+   "
"
+   "If the value is no Tidy normalizes attribute values by "
+   "replacing any newline or tab with a single space, and further by replacing "
+   "any contiguous whitespace with a single space. "
+   "
"
+   "To force Tidy to preserve the original, literal values of all attributes "
+   "and ensure that whitespace within attribute values is passed "
+   "through unchanged, set this option to yes. "
   },
   {TidyShowMarkup,
    "This option specifies if Tidy should generate a pretty printed version "
    "of the markup. Note that Tidy won't generate a pretty printed version if "
-   "it finds significant errors (see force-output). "
+   "it finds significant errors (see force-output). "
   },
 #if SUPPORT_ASIAN_ENCODINGS
   {TidyPunctWrap,
@@ -836,40 +849,51 @@ static const TidyOptionDoc option_docs[] =
   },
 #endif
   {TidyBurstSlides,
-   "Currently not used. Tidy Classic only. "
+   "This option has no function and is deprecated. "
   },
   {TidyTabSize,
    "This option specifies the number of columns that Tidy uses between "
    "successive tab stops. It is used to map tabs to spaces when reading the "
    "input. "
+   "
"
+   "Tidy never outputs tabs."
   },
   {TidyVertSpace,   /* Issue #228 - changed to tri-state */
    "This option specifies if Tidy should add some extra empty lines for "
-   "readability. Default is 'no'. If set to 'auto', will eliminate nearly "
-   "all newline chars."
+   "readability. "
+   "
"
+   "The default is no. "
+   "
"
+   "If set to auto' Tidy will eliminate nearly all newline "
+   "characters."
   },
   {TidyWrapLen,
-   "This option specifies the right margin Tidy uses for line wrapping. Tidy "
-   "tries to wrap lines so that they do not exceed this length. Set wrap to "
-   "zero if you want to disable line wrapping. "
+   "This option specifies the right margin Tidy uses for line wrapping. "
+   "
"
+   "Tidy tries to wrap lines so that they do not exceed this length. "
+   "
"
+   "Set wrap to 0(zero) if you want to disable line "
+   "wrapping. "
   },
   {TidyWrapAsp,
    "This option specifies if Tidy should line wrap text contained within ASP "
-   "pseudo elements, which look like: <% ... %>. "
+   "pseudo elements, which look like: <% ... %>. "
   },
   {TidyWrapAttVals,
-   "This option specifies if Tidy should line-wrap attribute values, for "
-   "easier editing. Line wrapping means that if the value of an attribute "
-   "causes a line to exceed the width specified by the \"wrap\" option, "
-   "tidy will add one or more line breaks to the value, causing it to "
-   "wrapped into multiple lines. Note that this option can be set "
-   "independently of wrap-script-literals. Also note that by default, Tidy "
-   "\"munges\" or \"normalizes\" attribute values by replacing any newline "
-   "or tab character with a single space character, and further by replacing "
-   "any sequences of multiple whitespace characters with a single space. "
+   "This option specifies if Tidy should line-wrap attribute values, meaning "
+   "that if the value of an attribute causes a line to exceed the width "
+   "specified by wrap, Tidy will add one or more line breaks to "
+   "the value, causing it to be wrapped into multiple lines. "
+   "
"
+   "Note that this option can be set independently of "
+   "wrap-script-literals. "
+   "By default Tidy replaces any newline or tab with a single space and "
+   "replaces any sequences of whitespace with a single space. "
+   "
"
    "To force Tidy to preserve the original, literal values of all attributes, "
    "and ensure that whitespace characters within attribute values are passed "
-   "through unchanged, set the literal-attributes option to \"yes\". "
+   "through unchanged, set literal-attributes to "
+   "yes. "
    ,TidyWrapAttValsLinks
   },
   {TidyWrapJste,

From dec6356a6f5b0055115598ae1fe3568f1a92e1a8 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Mon, 2 Nov 2015 15:31:47 +0800
Subject: [PATCH 21/23] Deleted multiple equal id attributes.

---
 documentation/quickref.xsl |   6 +-
 src/localize.c             | 217 +++++++++++++++++++++++--------------
 2 files changed, 138 insertions(+), 85 deletions(-)

diff --git a/documentation/quickref.xsl b/documentation/quickref.xsl
index 260902b..73e308a 100644
--- a/documentation/quickref.xsl
+++ b/documentation/quickref.xsl
@@ -31,7 +31,7 @@
   
     
HTML Tidy  Options Quick Reference

 
-    
Option Groups

+    
Option Groups

     
 
-    
Option Index

+    
Option Index

     
 
-    
Option Details

+    
Option Details

     
 
   
diff --git a/src/localize.c b/src/localize.c
index f210c87..812205c 100755
--- a/src/localize.c
+++ b/src/localize.c
@@ -392,15 +392,15 @@ static const TidyOptionDoc option_docs[] =
   {TidyXmlSpace,
    "This option specifies if Tidy should add "
    "xml:space=\"preserve\" to elements such as "
-   "<PRE>, <STYLE> and "
-   "<SCRIPT> when generating XML. "
+   "<pre>, <style> and "
+   "<script> when generating XML. "
    "
"
    "This is needed if the whitespace in such elements is to "
    "be parsed appropriately without having access to the DTD. "
   },
   {TidyAltText,
    "This option specifies the default alt= text Tidy uses for "
-   "<IMG> attributes. "
+   "<img> attributes. "
    "
"
    "Use with care, as this feature suppresses further accessibility warnings. "
   },
@@ -438,9 +438,12 @@ static const TidyOptionDoc option_docs[] =
   {TidyDoctype,
    "This option specifies the DOCTYPE declaration generated by Tidy. "
    "
"
-   "If set to omit the output won't contain a DOCTYPE declaration. "
+   "If set to omit the output won't contain a DOCTYPE "
+   "declaration. Note this this also implies numeric-entities is "
+   "set to yes"
    "
"
-   "If set to html5 the DOCTYPE is set to <!DOCTYPE html>."
+   "If set to html5 the DOCTYPE is set to "
+   "<!DOCTYPE html>."
    "
"
    "If set to auto (the default) Tidy will use an educated guess "
    "based upon the contents of the document."
@@ -462,9 +465,9 @@ static const TidyOptionDoc option_docs[] =
    "system identifier to an empty string. For an HTML document, Tidy adds a "
    "system identifier only if one was already present in order to preserve "
    "the processing mode of some browsers. Tidy leaves the DOCTYPE for "
-   "generic XML documents unchanged. --doctype omit implies "
-   "--numeric-entities yes. This option does not offer a "
-   "validation of the document conformance. "
+   "generic XML documents unchanged. "
+   "
"
+   "This option does not offer a validation of document conformance. "
   },
   {TidyDropEmptyElems,
    "This option specifies if Tidy should discard empty elements. "
@@ -494,13 +497,13 @@ static const TidyOptionDoc option_docs[] =
    "such as Microsoft data binding attributes. "
   },
   {TidyEncloseBlockText,
-   "This option specifies if Tidy should insert a <P> "
+   "This option specifies if Tidy should insert a <p> "
    "element to enclose any text it finds in any element that allows mixed "
    "content for HTML transitional but not HTML strict. "
   },
   {TidyEncloseBodyText,
    "This option specifies if Tidy should enclose any text it finds in the "
-   "body element within a <P> element."
+   "body element within a <p> element."
    "
"
    "This is useful when you want to take existing HTML and use it with a "
    "style sheet. "
@@ -552,7 +555,7 @@ static const TidyOptionDoc option_docs[] =
    "This option is ignored for XML output. "
   },
   {TidyHideEndTags,
-   "This option is an alias for omit-optional-tags. "
+   "This option is an alias for omit-optional-tags. "
   },
   {TidyIndentCdata,
    "This option specifies if Tidy should indent "
@@ -564,12 +567,12 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyJoinClasses,
    "This option specifies if Tidy should combine class names to generate "
-   "a single new class name if multiple class assignments are detected on "
+   "a single, new class name if multiple class assignments are detected on "
    "an element. "
    , TidyJoinClassesLinks
   },
   {TidyJoinStyles,
-   "This option specifies if Tidy should combine styles to generate a single "
+   "This option specifies if Tidy should combine styles to generate a single, "
    "new style if multiple style values are detected on an element. "
    , TidyJoinStylesLinks
   },
@@ -671,7 +674,7 @@ static const TidyOptionDoc option_docs[] =
     "Unless you declare new tags, Tidy will refuse to generate a tidied file if "
     "the input includes previously unknown tags. "
     "
"
-    "Note you can not as yet add new CDATA elements. "
+    "Note you cannot as yet add new CDATA elements. "
     "
"
     "This option is ignored in XML mode. "
     ,TidyPreTagsLinks
@@ -738,7 +741,7 @@ static const TidyOptionDoc option_docs[] =
    , TidyDuplicateAttrsLinks
   },
   {TidySortAttributes,
-   "This option specifies that tidy should sort attributes within an element "
+   "This option specifies that Tidy should sort attributes within an element "
    "using the specified sort algorithm. If set to alpha, the "
    "algorithm is an ascending alphabetic sort. "
   },
@@ -815,14 +818,22 @@ static const TidyOptionDoc option_docs[] =
    "
"
    "Setting indent to yes can expose layout bugs in "
    "some browsers. "
+   "
"
+   "Use the option indent-spaces to control the number of spaces "
+   "or tabs output per level of indent, and indent-with-tabs to "
+   "specify whether spaces or tabs are used. "
+ 
    ,TidyIndentContentLinks
   },
   {TidyIndentAttributes,
    "This option specifies if Tidy should begin each attribute on a new line. "
   },
   {TidyIndentSpaces,
-   "This option specifies the number of spaces Tidy uses to indent content, "
-   "when indentation is enabled. "
+   "This option specifies the number of spaces or tabs that Tidy uses to "
+   "indent content when indent is enabled. "
+   "
"
+   "Note that the default value for this option is dependent upon the value of "
+   "indent-with-tabs (see also). "
    ,TidyIndentSpacesLinks
   },
   {TidyLiteralAttribs,
@@ -855,8 +866,6 @@ static const TidyOptionDoc option_docs[] =
    "This option specifies the number of columns that Tidy uses between "
    "successive tab stops. It is used to map tabs to spaces when reading the "
    "input. "
-   "
"
-   "Tidy never outputs tabs."
   },
   {TidyVertSpace,   /* Issue #228 - changed to tri-state */
    "This option specifies if Tidy should add some extra empty lines for "
@@ -864,7 +873,7 @@ static const TidyOptionDoc option_docs[] =
    "
"
    "The default is no. "
    "
"
-   "If set to auto' Tidy will eliminate nearly all newline "
+   "If set to auto Tidy will eliminate nearly all newline "
    "characters."
   },
   {TidyWrapLen,
@@ -898,89 +907,116 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyWrapJste,
    "This option specifies if Tidy should line wrap text contained within "
-   "JSTE pseudo elements, which look like: <# ... #>. "
+   "JSTE pseudo elements, which look like: <# ... #>. "
   },
   {TidyWrapPhp,
    "This option specifies if Tidy should line wrap text contained within PHP "
-   "pseudo elements, which look like: <?php ... ?>. "
+   "pseudo elements, which look like: <?php ... ?>. "
   },
   {TidyWrapScriptlets,
    "This option specifies if Tidy should line wrap string literals that "
-   "appear in script attributes. Tidy wraps long script string literals by "
-   "inserting a backslash character before the line break. "
+   "appear in script attributes. "
+   "
"
+   "Tidy wraps long script string literals by inserting a backslash character "
+   "before the line break. "
    ,TidyWrapScriptletsLinks
   },
   {TidyWrapSection,
    "This option specifies if Tidy should line wrap text contained within "
-   "<![ ... ]> section tags. "
+   "<![ ... ]> section tags. "
   },
   {TidyAsciiChars,
-   "Can be used to modify behavior of -c (--clean yes) option.  If set "
-   "to \"yes\" when using -c, &emdash;, &rdquo;, and other named "
-   "character entities are downgraded to their closest ascii equivalents. "
+   "Can be used to modify behavior of the clean option when set "
+   "to yes. "
+   "
"
+   "If set to yes when clean, "
+   "&emdash;, &rdquo;, and other named "
+   "character entities are downgraded to their closest ASCII equivalents. "
    ,TidyAsciiCharsLinks
   },
   {TidyCharEncoding,
    "This option specifies the character encoding Tidy uses for both the input "
-   "and output. For ascii, Tidy will accept Latin-1 (ISO-8859-1) character "
-   "values, but will use entities for all characters whose value > 127. "
-   "For raw, Tidy will output values above 127 without translating them into "
-   "entities. For latin1, characters above 255 will be written as entities. "
-   "For utf8, Tidy assumes that both input and output is encoded as UTF-8. "
-   "You can use iso2022 for files encoded using the ISO-2022 family of "
-   "encodings e.g. ISO-2022-JP. For mac and win1252, Tidy will accept vendor "
+   "and output. "
+   "
"
+   "For ascii Tidy will accept Latin-1 (ISO-8859-1) character "
+   "values, but will use entities for all characters whose value >127. "
+   "
"
+   "For raw, Tidy will output values above 127 without "
+   "translating them into entities. "
+   "
"
+   "For latin1, characters above 255 will be written as entities. "
+   "
"
+   "For utf8, Tidy assumes that both input and output are encoded "
+   "as UTF-8. "
+   "
"
+   "You can use iso2022 for files encoded using the ISO-2022 "
+   "family of encodings e.g. ISO-2022-JP. "
+   "
"
+   "For mac and win1252, Tidy will accept vendor "
    "specific character values, but will use entities for all characters whose "
-   "value > 127. "
+   "value >127. "
+   "
"
    "For unsupported encodings, use an external utility to convert to and from "
    "UTF-8. "
    ,TidyCharEncodingLinks
   },
   {TidyInCharEncoding,
    "This option specifies the character encoding Tidy uses for the input. See "
-   "char-encoding for more info. "
+   "char-encoding for more info. "
    ,TidyInCharEncodingLinks
   },
 #if SUPPORT_ASIAN_ENCODINGS
   {TidyLanguage,
-   "Currently not used, but this option specifies the language Tidy uses "
-   "(for instance \"en\"). "
+   "Currently not used, but this option specifies the language Tidy would use "
+   "if it were properly localized. For example: en. "
   },
 #endif
 #if SUPPORT_UTF16_ENCODINGS
   {TidyOutputBOM,
    "This option specifies if Tidy should write a Unicode Byte Order Mark "
    "character (BOM; also known as Zero Width No-Break Space; has value of "
-   "U+FEFF) to the beginning of the output; only for UTF-8 and UTF-16 output "
-   "encodings. If set to \"auto\", this option causes Tidy to write a BOM to "
-   "the output only if a BOM was present at the beginning of the input. A BOM "
-   "is always written for XML/XHTML output using UTF-16 output encodings. "
+   "U+FEFF) to the beginning of the output, and only applies to UTF-8 and "
+   "UTF-16 output encodings. "
+   "
"
+   "If set to auto this option causes Tidy to write a BOM to "
+   "the output only if a BOM was present at the beginning of the input. "
+   "
"
+   "A BOM is always written for XML/XHTML output using UTF-16 output "
+   "encodings. "
   },
 #endif
   {TidyOutCharEncoding,
    "This option specifies the character encoding Tidy uses for the output. "
-   "See char-encoding for more info. May only be different from "
-   "input-encoding for Latin encodings (ascii, latin0, latin1, mac, win1252, "
-   "ibm858). "
+   "
"
+   "Note that this may only be different from input-encoding for "
+   "Latin encodings (ascii, latin0, "
+   "latin1, mac, win1252, "
+   "ibm858)."
+   "
"
+   "See char-encoding for more information"
    ,TidyOutCharEncodingLinks
   },
   {TidyNewline,
-   "The default is appropriate to the current platform: CRLF on PC-DOS, "
-   "MS-Windows and OS/2, CR on Classic Mac OS, and LF everywhere else "
-   "(Unix and Linux). "
+   "The default is appropriate to the current platform. "
+   "
"
+   "Genrally CRLF on PC-DOS, Windows and OS/2; CR on Classic Mac OS; and LF "
+   "everywhere else (Linux, Mac OS X, and Unix). "
   },
   {TidyErrFile,
    "This option specifies the error file Tidy uses for errors and warnings. "
-   "Normally errors and warnings are output to \"stderr\". "
+   "Normally errors and warnings are output to stderr. "
    ,TidyErrFileLinks
   },
   {TidyFixBackslash,
    "This option specifies if Tidy should replace backslash characters "
-   "\"\\\" in URLs by forward slashes \"/\". "
+   "\\ in URLs with forward slashes /. "
   },
   {TidyForceOutput,
    "This option specifies if Tidy should produce output even if errors are "
-   "encountered. Use this option with care - if Tidy reports an error, this "
-   "means Tidy was not able to, or is not sure how to, fix the error, so the "
+   "encountered. "
+   "
"
+   "Use this option with care; if Tidy reports an error, this "
+   "means Tidy was not able to (or is not sure how to) fix the error, so the "
    "resulting output may not reflect your intention. "
   },
   {TidyEmacs,
@@ -992,14 +1028,18 @@ static const TidyOptionDoc option_docs[] =
   },
   {TidyKeepFileTimes,
    "This option specifies if Tidy should keep the original modification time "
-   "of files that Tidy modifies in place. The default is no. Setting the "
-   "option to yes allows you to tidy files without causing these files to be "
-   "uploaded to a web server when using a tool such as SiteCopy. Note this "
-   "feature is not supported on some platforms. "
+   "of files that Tidy modifies in place. "
+   "
"
+   "Setting the option to yes allows you to tidy files without "
+   "changing the file modification date, which may be useful with certain "
+   "tools that use the modification date for things such as automatic server "
+   "deployment."
+   "
"
+   "Note this feature is not supported on some platforms. "
   },
   {TidyOutFile,
    "This option specifies the output file Tidy uses for markup. Normally "
-   "markup is written to \"stdout\". "
+   "markup is written to stdout. "
    ,TidyOutFileLinks
   },
   {TidyQuiet,
@@ -1007,46 +1047,59 @@ static const TidyOptionDoc option_docs[] =
    "of errors and warnings, or the welcome or informational messages. "
   },
   {TidySlideStyle,
-   "Currently not used.  Tidy Classic only. "
+   "This option has no function and is deprecated. "
   },
   {TidyMark,
-   "This option specifies if Tidy should add a meta element to the document "
-   "head to indicate that the document has been tidied. Tidy won't add a meta "
-   "element if one is already present. "
+   "This option specifies if Tidy should add a meta element to "
+   "the document head to indicate that the document has been tidied. "
+   "
"
+   "Tidy won't add a meta element if one is already present. "
   },
   {TidyWriteBack,
    "This option specifies if Tidy should write back the tidied markup to the "
-   "same file it read from. You are advised to keep copies of important files "
-   "before tidying them, as on rare occasions the result may not be what you "
-   "expect. "
+   "same file it read from. "
+   "
"
+   "You are advised to keep copies of important files before tidying them, as "
+   "on rare occasions the result may not be what you expect. "
   },
   {TidyDecorateInferredUL,
-   "This option specifies if Tidy should decorate inferred UL elements with "
-   "some CSS markup to avoid indentation to the right. "
+   "This option specifies if Tidy should decorate inferred "
+   "<ul> elements with some CSS markup to avoid indentation "
+   "to the right. "
   },
   {TidyPreserveEntities,
-   "This option specifies if Tidy should preserve the well-formed entities "
+   "This option specifies if Tidy should preserve well-formed entities "
    "as found in the input. "
   },
   {TidyAnchorAsName,
-   "This option controls the deletion or addition of the name attribute "
-   "in elements where it can serve as anchor. "
-   "If set to \"yes\", a name attribute, if not already existing, "
-   "is added along an existing id attribute if the DTD allows it. "
-   "If set to \"no\", any existing name attribute is removed "
-   "if an id attribute exists or has been added. "
+   "This option controls the deletion or addition of the name "
+   "attribute in elements where it can serve as anchor. "
+   "
"
+   "If set to yes a name attribute, if not already "
+   "existing, is added along an existing id attribute if the DTD "
+   "allows it. "
+   "
"
+   "If set to no any existing name attribute is removed if an"
+   "id attribute exists or has been added. "
   },
    {TidyPPrintTabs,
-   "Set this option \"on\" to indent using tabs instead of the default "
-   "spaces. The option TidyIndentSpaces controls the number of tabs output "
-   "per level of indent, which is reset to 1, when this option is set on. "
-   "And of course, indent must be enabled for this to have any effect. "
-   "Note TidyTabSize controls converting input tabs to spaces. Set to zero "
-   "to retain input tabs. "
+   "This option specifies if Tidy should indent with tabs instead of spaces, "
+   "assuming indent is yes. "
+   "
"
+   "Set it to yes to indent using tabs instead of the default "
+   "spaces. "
+   "
"
+   "Use the option indent-spaces to control the number of tabs "
+   "output per level of indent. Note that when indent-with-tabs "
+   "is enabled the default value of indent-spaces is reset to "
+   "1. "
+   "
"
+   "Note tab-size controls converting input tabs to spaces. Set "
+   "it to zero to retain input tabs. "
   },
   {TidySkipQuotes,
-   "This option specifies that Tidy should skip quotes, and comments "
-   "when parsing script data. "
+   "This option specifies that Tidy should skip nested tags when parsing "
+   "script and style data. "
   },
   {N_TIDY_OPTIONS,
    NULL

From 5447e6642bf3026c64dda1e687387804f2caebd4 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Mon, 2 Nov 2015 15:32:11 +0800
Subject: [PATCH 22/23] We should Tidy our quickref document.

---
 documentation/build_docs.sh |  3 ++
 documentation/tidy.cfg      | 82 +++++++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+)
 create mode 100644 documentation/tidy.cfg

diff --git a/documentation/build_docs.sh b/documentation/build_docs.sh
index fdae38a..d5405a1 100755
--- a/documentation/build_docs.sh
+++ b/documentation/build_docs.sh
@@ -73,6 +73,9 @@ if [ "$BUILD_XSLT" -eq 1 ]; then
 	xsltproc "./quickref.xsl" "$OUTP_DIR/tidy-config.xml" > "$OUTP_DIR/quickref.html"
 	xsltproc "./quickref.include.xsl" "$OUTP_DIR/tidy-config.xml" > ./examples/quickref_include.html
 
+	# Well, duh, we should tidy quickref.html
+	$TIDY_PATH -config "./tidy.cfg" -modify "$OUTP_DIR/quickref.html"
+
 	# 'tidy.1'; create a valid tidy1.xsl first by subbing CMAKE's variable.
 	sed "s|@TIDYCONFIG@|./tidy-config.xml|g" < ./tidy1.xsl.in > "$OUTP_DIR/tidy1.xsl"
 	xsltproc "$OUTP_DIR/tidy1.xsl" "$OUTP_DIR/tidy-help.xml" > "$OUTP_DIR/tidy.1"
diff --git a/documentation/tidy.cfg b/documentation/tidy.cfg
new file mode 100644
index 0000000..a4c4e91
--- /dev/null
+++ b/documentation/tidy.cfg
@@ -0,0 +1,82 @@
+# Tidy Options generated and exported by Balthisar Tidy for Mac OS X.
+# Please visit http://www.balthisar.com for more information about Balthisar Tidy.
+# - Double-check encoding values; Balthisar Tidy set them all to "utf8".
+# - If "accessibility-check" has a string after the number, it’s okay; it will work fine.
+# To use this configuration file with the native command line version of Tidy, use Tidy like this:
+# tidy -config tidy.cfg some_file.html
+#
+accessibility-check: 0 (Tidy Classic)
+add-xml-decl: no
+add-xml-space: no
+alt-text: 
+anchor-as-name: yes
+ascii-chars: no
+assume-xml-procins: no
+bare: no
+break-before-br: no
+clean: yes
+coerce-endtags: yes
+css-prefix: 
+decorate-inferred-ul: no
+doctype: html5
+drop-empty-elements: yes
+drop-empty-paras: yes
+drop-proprietary-attributes: no
+enclose-block-text: no
+enclose-text: no
+escape-cdata: no
+fix-backslash: yes
+fix-bad-comments: yes
+fix-uri: yes
+force-output: no
+gdoc: no
+hide-comments: no
+indent: yes
+indent-attributes: no
+indent-cdata: no
+indent-spaces: 4
+input-encoding: utf8
+input-xml: no
+join-classes: no
+join-styles: no
+literal-attributes: no
+logical-emphasis: no
+lower-literals: yes
+markup: yes
+merge-divs: auto
+merge-emphasis: yes
+merge-spans: auto
+ncr: yes
+new-blocklevel-tags: 
+new-empty-tags: 
+new-inline-tags: 
+new-pre-tags: 
+newline: LF
+numeric-entities: no
+omit-optional-tags: no
+output-encoding: utf8
+output-html: no
+output-xhtml: no
+output-xml: no
+preserve-entities: yes
+punctuation-wrap: no
+quote-ampersand: yes
+quote-marks: no
+quote-nbsp: yes
+repeated-attributes: keep-last
+replace-color: yes
+show-body-only: no
+sort-attributes: none
+tab-size: 8
+tidy-mark: yes
+uppercase-attributes: no
+uppercase-tags: no
+vertical-space: no
+word-2000: no
+wrap: 0
+wrap-asp: yes
+wrap-attributes: no
+wrap-jste: yes
+wrap-php: yes
+wrap-script-literals: no
+wrap-sections: yes

From 684621c6f7a351ea13d1e7f2e8b80d113e380fc3 Mon Sep 17 00:00:00 2001
From: Jim Derry 
Date: Mon, 2 Nov 2015 15:53:55 +0800
Subject: [PATCH 23/23] Root level README.

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..32c9a22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# HTML Tidy with HTML5 support
+
+All READMEs and related materials have been relocated into README/.
+
+For build instructions please see README/README.md.


     

-       OptionsTop

-            
-              
-            
-            
-              -
-            
-        
+  

+         Options
       
     
 

+              
+                
+              
+              
+                -
+              
+          
+        

 
 

-        Options Reference
-    
 

+         Options Reference
+      

 
   

-        
-      
-      Top
Type: 

-
-        
-          
-            Default: 
-          
-          
-            Default: -
-          
-        
-
-        
-          
-            
Example: 
-          
-          
-            
Example: -
-          
-        
-      		
-        
-          
-          
-            

-          
-        
-      
 

+          
+        
Type:
Default:
+          
+            
+              
+            
+            
+              -
+            
+                  
+        
Example
+          
+            
+              
+            
+            
+              -
+            
+          
+        
See also:
+          
+            
+            
+              , 
+            
+          
+        

   
 
 
 
OptionTypeDefault
OptionTypeDefault