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/documentation/examples/example_config.txt b/documentation/examples/example_config.txt deleted file mode 100644 index 5a0164b..0000000 --- a/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/documentation/pages/main_page.dox b/documentation/pages/main_page.dox deleted file mode 100644 index ee774b3..0000000 --- a/documentation/pages/main_page.dox +++ /dev/null @@ -1,51 +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} -
` 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/documentation/quickref.xsl b/documentation/quickref.xsl
deleted file mode 100644
index 73e308a..0000000
--- a/documentation/quickref.xsl
+++ /dev/null
@@ -1,374 +0,0 @@
-
-
-
-
-
-
-
-
- HTML Tidy <xsl:value-of select="config/@version" /> Options Quick Reference
- HTML Tidy
-
- Option Groups
-
-
- Option Index
- Option Details
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Type:
-
-
- Default:
-
-
-
-
-
- -
-
-
-
-
-
- Example
-
-
-
-
-
- -
-
-
-
-
-
- See also:
-
-
-
- ,
-
-
-
-
-
-
-
-
-
-
-
-
- Option
- Type
- Default
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/documentation/style.css b/documentation/style.css
deleted file mode 100644
index 6eb740f..0000000
--- a/documentation/style.css
+++ /dev/null
@@ -1,310 +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;
-}
-
-td.qdescription br {
- content: " ";
- display: block;
- margin: 10px 0;
-}
diff --git a/documentation/tidy.cfg b/documentation/tidy.cfg
deleted file mode 100644
index a4c4e91..0000000
--- a/documentation/tidy.cfg
+++ /dev/null
@@ -1,82 +0,0 @@
-# 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
diff --git a/documentation/.gitignore b/man/.gitignore
similarity index 100%
rename from documentation/.gitignore
rename to man/.gitignore
diff --git a/man/README.md b/man/README.md
new file mode 100644
index 0000000..4639991
--- /dev/null
+++ b/man/README.md
@@ -0,0 +1,8 @@
+man
+===
+
+This directory consists of file required for generating Tidy's documentation:
+
+- `tidy.1`, which is Tidy's `man` page on Unix-like systems.
+
+Please consult the main project README file for more information.
diff --git a/documentation/tidy1.xsl.in b/man/tidy1.xsl.in
similarity index 100%
rename from documentation/tidy1.xsl.in
rename to man/tidy1.xsl.in