.. | ||
api | ||
doxygen.cfg | ||
quickref.css | ||
quickref.sh | ||
quickref.xsl | ||
README.md | ||
tidy1.sh | ||
tidy1.xsl |
DOCUMENTATION HOW-TO
HTML Tidy provides several types of documentation to suit different purposes. This document describes how to generate the following:
htmldoc/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.
htmldoc/api/ (directory)
If you want to build the API documentation locally you must have doxygen installed. You can clone the repository from github if it is not currently installed.
Building as simple as:
cd {your-tidy-html5-source}/htmldoc/doxygen doxygen.cfg
This will result in a document set in {your-tidy-html5-source}/htmldoc/doxygen/api/
,
where you can find the main index.html
file.
quickref.html
For convenience you can use the quickref.sh
shell script on Unix-like systems to
build the quickref.html
file. Note that it depends on the standard xsltproc
utility
to build the file.
If you are using a non-Unix operating system or have a different XSLT processor then the following section describes how the file can be built easily.
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
For convenience you can use the tidy1.sh
shell script on Unix-like systems to
build the tidy.1
file. Note that it depends on the standard xsltproc
utility
to build the file.
If you are using a non-Unix operating system or have a different XSLT processor then the following section describes how the file can be built easily.
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 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.