emelie/tidy-html5
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge documentation of "command-line" and "configuration" options (Issue #469) (#473)

Browse source 
* Track tidy.1 before merging duplicate sections

I am adding the file to the git repository to track and review
the changes to this generated file. I will then update the XSLT
transformation which produces this file to remove duplicate sections.
As a first step, I will stop outputting duplicate sections; I will
then merge them into existing sections. I will commit the changes
to the generated file at each step.

Related issue: #469

* Also track changes in text rendering of the man page tidy.1

The rendering to text was done with following command:

  /usr/bin/groff -Tascii -mandoc -c tidy.1

This format should make the review of differences more readable.

Related issue: #469

* Remove duplicate sections: temporarily discard detailed options

Related issue: #469

* Generalize command line given in SYNOPSIS

The new SYNOPSIS expresses the fact that multiple files can
be provided as argument, and that options and files can be mixed
(options apply only to the files specified after, not the ones before).

It does not explain that there are actually two types of options; this
shall be detailed afterwards: simple options (aka standard options) start
with single dash while configuration options start with a double dash.
Only the latter can be defined in configuration files, using their name
without the double dash.

I have also reformatted the terms 'options' and 'file' to be underlined,
to follow conventions that I observed in other man pages (ls, grep, wget...)

Related issue: #469

* Regroup sentences related to options at the start of OPTIONS section

This is an intermediate step before adapting the text to its new
location. I will probably start the section with a paragraph to
introduce the two different kinds of options. Then describe the
"standard" options in more details. Then list the standard options.
Then describe the configuration options in more details. Then list
the configuration options, using a format similar to the one used
for standard options.

Related issue: #469

* Describe "standard" and "expanded" options part of OPTIONS section

The section now starts with a description of both types of options,
and explains that the first part of the section concerns with the
"standard" options while the second part of the section concerns with
the "expanded" options.

More details are provided about "standard" options, which are then
listed individually.

More details are then provided about "expanded" options and their
usage on the command line and in configuration files. The configuration
options are not listed yet. In order to avoid repeating a lot of
information with every separate configuration option, I will first
describe common values and formats; I will then describe each option
more succinctly, like "standard" options.

Related issue: #469

* Remove redundant USAGE section

The fact that the input file defaults to standard input
and the output file to standard output is already indicated
in the DESCRIPTION section. This was the only information
left in this section at this point.

Related issue: #469

* Delete separation line

The line used to separate "standard" usage from "extended" usage.
Both forms are now integrated in the common description of OPTIONS.

Related issue: #469

* Delete DETAILED CONFIGURATION OPTIONS section

The detailed configuration options are now described together
with standard options in a common OPTIONS section.

Related issue: #469

* Delete duplicate SYNOPSIS section

A single generalized SYNOPSIS now encompasses both kinds of options.

Related issue: #469

* Delete WARNING section, no longer relevant

The WARNING referred to a separate section for the description
of "standard" options. They are now described in the same OPTIONS
section as "extended" options.

Related issue: #469

* Copy details of configuration options and file format to OPTIONS

Just before listing all the configuration options, this is the
expected place to describe the "extended" options in more details.
The description was already worded as an introduction to the list
of configuration options. I will update this description after having
compacted entries which describe individual configuration options.

Related issue: #469

* Delete duplicate DESCRIPTION section

This section has been merged into the generalized OPTIONS section.

Related issue: #469

* List configuration options at the end of the OPTIONS section

This list is very long, with lots of duplicate information
repeated for entries of the same type. The description of
configuration options should be compacted to match as closely
as possible the description of "standard" options.

Related issue: #469

* Delete duplicate OPTIONS section

I contained the list of configuration options, which is now included
at the end of the generalized OPTIONS section.

Related issue: #469

* Delete config-section template

The template was now empty. Its contents have been merged
into the cmdline-section template.

Related issue: #469

* Remove redundant sentence

The sentence listed the five categories of configuration options.
This kind of made sense when the options were listed in the following
section. Now that they are listed just below, it has become redundant.

Related issue: #469

* Remove colon ':' at the end of configuration options categories

The categories of "standard" options do not end with a colon;
no title does actually.

Related issue: #469

* Remove extra lines before the list of configuration options

Related issue: #469

* Add double space after period '.  ' where missing

For consistency with usage, sentences within paragraphs shall be
separated by a double space rather than a single space. This was
done in most places in the document, with only a few places missing.

Related issue: #469

* Delete irrelevant comment

The comment refers to cmdline section at the start of the processing
of configuration options. The cmdline options are opposed to
config options in the context of this transformation. They are
provided through two separate XML input files.

Related issue: #469

* Delete extra blank line before sample configuration file

Related issue: #469

* Remove multiple empty lines after heading of each options category

Related issue: #469

* Remove duplicate empty line before 'See also:' lines

Related issue: #469

* Clarify the terms used for both kinds of options

I removed references to "standard" (or regular) command-line options
and "extended" (or detailed) options. I used the terms featured in
the description of the options which output XML files describing
each kind of options:

  -xml-help
        list the command line options in XML format

  -xml-config
        list all configuration options in XML format

The term for single-dash options is now (purely) command-line options
while double-dash options are referred to as configuration options.

Related issue: #469

* Update copyright year to 2016

* Clarify configuration options equivalent to command-line options

I added a paragraph to explain the equivalence of a command-line
option with a configuration option and value, and to explicit the
format used to describe this equivalence in the description of
command-line parameters.

I moved the parentheses, which were on the last line, at the end
of the description, to the first line at the end of the list of
names for the command-line option.

Related issue: #469

* Use underlines (I) instead of bold (B) for option names in config example

This is for consistency with the format used for the option names in
the equivalent command-line example above, and in the other example
of configuration file.

Related issue: #469

* Update copyright year to 2017

* Add double dash before the name of configuration options

This is a first step for the harmonization of the descriptions
of command-line and configuration options.

Related issue: #469

* Reformat logically to separate formatting (bold) from text (option name)

Related issue: #469

* Move Type after name of configuration option

This puts it in the position expected on the command line.

Related issue: #469

* Move default value after config option name and Type

I tried different formats for the default value:

  --clean Boolean:no
  --clean Boolean[no]

and more formats after I realized that the 'default' value is
not applied when the value is omitted, but when the option is
not used at all:

  --clean Boolean (initially: no)
  --clean Boolean (unset: no)

I selected the less confusing format:

  --clean Boolean (no if unset)

which is self-explanatory.

Related issue: #469

* Clarify that a configuration option cannot be used without a value

For example, using --clean without a value is not equivalent to
using -clean option:

  curl -s https://www.google.com | tidy --clean 2>&1 1>/dev/null | head -n 1

results in:

  Config: missing or malformed argument for option: clean

Related issue: #469

* Add double dash before option names in 'See also' sections

This is consistent with the format used at the top of the
description of configuration options.

Related issue: #469

* Fix order of items in comment describing documentation of config options

The 'seealso' comes last actually, after the description.

* Break long lines to keep source code readable in a terminal (80 characters)

This makes no change on the text generated by

  /usr/bin/groff -Tascii -mandoc -c tidy.1 > tidy.1.txt

* Only output an empty line when Example section is present

Otherwise, the description starts with an empty line when
no Example section is present.

Related issue: #469

* Simplify matching of example elements with contents

Using a template match instead of a named template,
I will then add rules with higher priority to ignore
examples for certain types of values, which are very
redundant (identical for all options of the same type).

Related issue: #469

* Do not print redundant examples

Examples for Boolean and AutoBool are redundant because they are
described in the main text and identical for all options of that type.

Examples for Tag names are redundant because they are redundant
with the name of the Type, and identical for all options of that type.

Examples for Integer are redundant because they are identical for
all options of that type but one, where the value 0 is followed with
a comment, but even in this case the examples are redundant because
the comment for the value 0 is also included in the description.

Related issue: #469

* Rename 'Examples' section to 'Supported values' to clarify

I also updated the description related to 'Examples' section
in the introduction paragraphs to the configuration options.

Related issue: #469

* Use italics consistently for the names of option types

Related issue: #469

* Use capitalization with no extra style consistently for Type

Previously, a mix of

  * Type set in bold font
  * Type set in regular font
  * "types" (quoted)
  * types (unquoted)

was found. I replaced all instances by Type in regular font.

Related issue: #469

* Consistently use bold format for option values

Both parameter names and values are now in bold,
while keys and values for configuration files are in italics.

Related issue: #469

* Use the same format as other subsections for 'See also'

The subsection is now flush left, in regular font, like
the 'Supported values' subsection.

The previous format was less adequate when the list wrapped
to the next line (--new-inline-tags): wrapping started on
the very first column, breaking the alignment of the rest of
the description.

Related issue: #469

* Consistently indent with 2 spaces, use a single line between templates

Parts of the file were indented with 2 spaces, others with 3 spaces.
Parts of the templates were separated with two empty lines, others
with a single one.

* Remove temporary files used for step by step comparisons of man page

Related issue: #469
This commit is contained in:
Eric Bréchemier 2017-01-08 18:19:36 +01:00 committed by Geoff McLane
parent fd0ccb2bbf
commit 7593d7b58f
1 changed files with 219 additions and 203 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

294
man/tidy1.xsl.in
View file

@ -3,11 +3,10 @@
For generating the `tidy.1` man page from the For generating the `tidy.1` man page from the
output of `tidy -xml-help` and `tidy -xml-config` output of `tidy -xml-help` and `tidy -xml-config`
(c) 2005-2007 (W3C) MIT, ERCIM, Keio University (c) 2005-2017 (W3C) MIT, ERCIM, Keio University
See tidy.h for the copyright notice. See tidy.h for the copyright notice.
Written by Jelks Cabaniss and Arnaud Desitter Written by Jelks Cabaniss and Arnaud Desitter
--> -->
<xsl:stylesheet version="1.0" <xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
@ -28,26 +27,20 @@
<xsl:variable name="CONFIG" select="document('@TIDYCONFIG@')"/> <xsl:variable name="CONFIG" select="document('@TIDYCONFIG@')"/>
<!-- Main Template: --> <!-- Main Template: -->
<xsl:template match="/"> <xsl:template match="/">
<xsl:call-template name="header-section" /> <xsl:call-template name="header-section" />
<xsl:call-template name="cmdline-section" /> <xsl:call-template name="cmdline-section" />
<xsl:call-template name="config-section" />
<xsl:call-template name="manpage-see-also-section" /> <xsl:call-template name="manpage-see-also-section" />
</xsl:template> </xsl:template>
<!-- Named Templates: --> <!-- Named Templates: -->
<xsl:template name="header-section"> <xsl:template name="header-section">
<xsl:text/>.\" tidy man page for the HTML Tidy <xsl:text/>.\" tidy man page for the HTML Tidy
.TH TIDY 1 "<xsl:value-of select="cmdline/@version" />" "HTML Tidy" "<xsl:value-of select="cmdline/@version" />" .TH TIDY 1 "<xsl:value-of select="cmdline/@version" />" "HTML Tidy" "<xsl:value-of select="cmdline/@version" />"
</xsl:template> </xsl:template>
<xsl:template name="cmdline-section"> <xsl:template name="cmdline-section">
.\" disable hyphenation .\" disable hyphenation
.nh .nh
@ -56,72 +49,96 @@
.SH NAME .SH NAME
\fBtidy\fR - check, correct, and pretty-print HTML(5) files \fBtidy\fR - check, correct, and pretty-print HTML(5) files
.SH SYNOPSIS .SH SYNOPSIS
\fBtidy\fR [option ...] [file ...] [option ...] [file ...] \fBtidy\fR [\fIoptions\fR] [\fIfile\fR ...] [\fIoptions\fR] [\fIfile\fR ...] ...
.SH DESCRIPTION .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. 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 .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. 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 .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. If no input file is specified, Tidy reads the standard input.
For command line options that expect a numerical argument, a default is assumed if no meaningful value can be found. 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.
.SH OPTIONS .SH OPTIONS
Tidy supports two different kinds of options.
Purely \fIcommand-line\fR options, starting with a single dash '\fB-\fR',
can only be used on the command-line, not in configuration files.
They are listed in the first part of this section.
\fIConfiguration\fR options, on the other hand, can either be passed
on the command line, starting with two dashes \fB--\fR,
or specified in a configuration file,
using the option name without the starting dashes.
They are listed in the second part of this section.
.LP
For \fIcommand-line\fR options that expect a numerical argument,
a default is assumed if no meaningful value can be found.
On the other hand, \fIconfiguration\fR options cannot be used
without a value; a \fIconfiguration\fR option without a value
is simply discarded and reported as an error.
.LP
Using a \fIcommand-line\fR option is sometimes equivalent to setting
the value of a \fIconfiguration\fR option. The equivalent option
and value are shown in parentheses in the list below, as they would
appear in a configuration file. For example,
\fB-quiet, -q\fR (\fIquiet: yes\fR) means that using the
\fIcommand-line\fR option \fB-quiet\fR or \fB-q\fR
is equivalent to setting the \fIconfiguration\fR option
\fIquiet\fR to \fIyes\fR.
.LP
Single-letter \fIcommand-line\fR options without an associated value
can be combined; for example '\fB-i\fR', '\fB-m\fR' and '\fB-u\fR'
may be combined as '\fB-imu\fR'.<xsl:text/>
<xsl:call-template name="show-cmdline-options" /> <xsl:call-template name="show-cmdline-options" />
.SH USAGE
.LP .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. \fIConfiguration\fR options can be specified
.LP by preceding each option with \fB--\fR at the command line,
Input/Output default to stdin/stdout respectively. Single letter options apart from \fB-f\fR and \fB-o\fR may be combined as in: 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 option:
.LP .LP
.in 1i .in 1i
\fBtidy -f errs.txt -imu foo.html\fR \fBtidy --\fR\fIoption1 \fRvalue1 \fB--\fIoption2 \fRvalue2 ...
.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.
</xsl:template>
<xsl:template name="config-section">
.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 .br
\fBtidy -config \fIconfig-file \fR[standard options ...] \fBtidy -config \fIconfig-file \fR ...
.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 .LP
\fIConfiguration\fR options can be conveniently grouped
in a single config file.
A Tidy configuration file is simply a text file, where each option A Tidy configuration file is simply a text file, where each option
is listed on a separate line in the form is listed on a separate line in the form
.LP .LP
.in 1i .in 1i
\fBoption1\fR: \fIvalue1\fR \fIoption1\fR: \fIvalue1\fR
.br .br
\fBoption2\fR: \fIvalue2\fR \fIoption2\fR: \fIvalue2\fR
.br .br
etc. etc.
.LP .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). The permissible values for a given option depend on the option's Type.
There are five Types: \fIBoolean\fR, \fIAutoBool\fR, \fIDocType\fR,
\fIEnum\fR, and \fIString\fR.
\fIBoolean\fR Types allow any of \fByes/no, y/n, true/false, t/f, 1/0\fR.
\fIAutoBool\fRs allow \fBauto\fR in addition to the values allowed
by \fIBooleans\fR.
\fIInteger\fR Types take non-negative integers.
\fIString\fR 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 .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. \fIEnum\fR, \fIEncoding\fR, and \fIDocType\fR Types have a fixed repertoire
of items, which are listed in the \fISupported values\fR sections below.
.LP .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. 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 .LP
Here is a sample config file, with at least one example of each of the five Types: Here is a sample config file, with at least one example of each of
the five Types:
.LP .LP
\fI \fI// sample Tidy configuration options
// sample Tidy configuration options
output-xhtml: yes output-xhtml: yes
add-xml-decl: no add-xml-decl: no
doctype: strict doctype: strict
@ -132,13 +149,26 @@ Here is a sample config file, with at least one example of each of the five Type
error-file: errs.txt error-file: errs.txt
\fR \fR
.LP .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. Below is a summary and brief description of each of the options.
.LP They are listed alphabetically within each category.<xsl:text/>
.SH OPTIONS
<xsl:call-template name="show-config-options" /> <xsl:call-template name="show-config-options" />
.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.
</xsl:template> </xsl:template>
<xsl:template name="show-cmdline-options"> <xsl:template name="show-cmdline-options">
.SS File manipulation .SS File manipulation
<xsl:call-template name="cmdline-detail"> <xsl:call-template name="cmdline-detail">
@ -162,10 +192,9 @@ Below is a summary and brief description of each of the options. They are listed
</xsl:call-template> </xsl:call-template>
</xsl:template> </xsl:template>
<xsl:template name="cmdline-detail"> <xsl:template name="cmdline-detail">
<!-- <!--
For each option in one of the categories/classes, provide its For each option in one of the categories/classes, provide its
1. names 1. names
2. description 2. description
3. equivalent configuration option 3. equivalent configuration option
@ -176,18 +205,15 @@ For each option in one of the categories/classes, provide its
.TP .TP
</xsl:text> </xsl:text>
<xsl:call-template name="process-names" /> <xsl:call-template name="process-names" />
<xsl:call-template name="process-eqconfig" />
<xsl:text> <xsl:text>
</xsl:text> </xsl:text>
<xsl:apply-templates select="description" /> <xsl:apply-templates select="description" />
<xsl:text>
</xsl:text>
<xsl:call-template name="process-eqconfig" />
</xsl:for-each> </xsl:for-each>
</xsl:template> </xsl:template>
<xsl:template name="process-names">
<!-- Used only in the cmdline section --> <!-- Used only in the cmdline section -->
<xsl:template name="process-names">
<xsl:for-each select="name"> <xsl:for-each select="name">
<xsl:text />\fB<xsl:value-of select="." />\fR<xsl:text /> <xsl:text />\fB<xsl:value-of select="." />\fR<xsl:text />
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
@ -196,44 +222,40 @@ For each option in one of the categories/classes, provide its
</xsl:for-each> </xsl:for-each>
</xsl:template> </xsl:template>
<xsl:template name="process-eqconfig">
<!-- Used only in the cmdline section --> <!-- Used only in the cmdline section -->
<xsl:template name="process-eqconfig">
<xsl:if test="string-length(eqconfig) &gt; 0"> <xsl:if test="string-length(eqconfig) &gt; 0">
<xsl:for-each select="eqconfig"> <xsl:for-each select="eqconfig">
<xsl:text>(\fI</xsl:text> <xsl:text> (\fI</xsl:text>
<xsl:value-of select="." /> <xsl:value-of select="." />
<xsl:text>\fR)</xsl:text> <xsl:text>\fR)</xsl:text>
</xsl:for-each> </xsl:for-each>
</xsl:if> </xsl:if>
</xsl:template> </xsl:template>
<xsl:template name="show-config-options"> <xsl:template name="show-config-options">
<!-- Used only in the cmdline section --> .SS HTML, XHTML, XML options<xsl:text/>
.SS HTML, XHTML, XML options:
<xsl:call-template name="config-detail"> <xsl:call-template name="config-detail">
<xsl:with-param name="category">markup</xsl:with-param> <xsl:with-param name="category">markup</xsl:with-param>
</xsl:call-template> </xsl:call-template>
.SS Diagnostics options: .SS Diagnostics options
<xsl:call-template name="config-detail"> <xsl:call-template name="config-detail">
<xsl:with-param name="category">diagnostics</xsl:with-param> <xsl:with-param name="category">diagnostics</xsl:with-param>
</xsl:call-template> </xsl:call-template>
.SS Pretty Print options: .SS Pretty Print options
<xsl:call-template name="config-detail"> <xsl:call-template name="config-detail">
<xsl:with-param name="category">print</xsl:with-param> <xsl:with-param name="category">print</xsl:with-param>
</xsl:call-template> </xsl:call-template>
.SS Character Encoding options: .SS Character Encoding options
<xsl:call-template name="config-detail"> <xsl:call-template name="config-detail">
<xsl:with-param name="category">encoding</xsl:with-param> <xsl:with-param name="category">encoding</xsl:with-param>
</xsl:call-template> </xsl:call-template>
.SS Miscellaneous options: .SS Miscellaneous options
<xsl:call-template name="config-detail"> <xsl:call-template name="config-detail">
<xsl:with-param name="category">misc</xsl:with-param> <xsl:with-param name="category">misc</xsl:with-param>
</xsl:call-template> </xsl:call-template>
</xsl:template> </xsl:template>
<!-- <!--
Note that any templates called implicitly or explicitly Note that any templates called implicitly or explicitly
from the "config-detail" template below will match on from the "config-detail" template below will match on
@ -248,46 +270,42 @@ For each option in one of the categories/classes, provide its
<xsl:template name="config-detail"> <xsl:template name="config-detail">
<!-- <!--
For each option in one of the 5 categories/classes, provide its For each option in one of the 5 categories/classes, provide its
1. name 1. name
2. type 2. Type
3. default (if any) 3. default (if any)
4. example (if any) 4. example (if any)
5. seealso (if any) 5. description
6. description 6. seealso (if any)
--> -->
<xsl:param name="category" /> <xsl:param name="category" />
.rs .rs<xsl:text/>
.sp 1
<xsl:for-each select='$CONFIG/config/option[@class=$category]'> <xsl:for-each select='$CONFIG/config/option[@class=$category]'>
<xsl:sort select="name" order="ascending" /> <xsl:sort select="name" order="ascending" />
.TP .TP
\fB<xsl:apply-templates select="name" />\fR <xsl:text>\fB</xsl:text>
<xsl:text>--</xsl:text><xsl:apply-templates select="name" />
Type: <xsl:apply-templates select="type" /> <xsl:text>\fR</xsl:text>
<xsl:text> </xsl:text>
<xsl:text>\fI</xsl:text>
<xsl:apply-templates select="type" />
<xsl:text>\fR</xsl:text>
<xsl:apply-templates select="default" />
.br .br
<xsl:call-template name="provide-default" /> <xsl:apply-templates select="example" />
.br
<xsl:call-template name="provide-example" />
<xsl:text>
</xsl:text>
<xsl:apply-templates select="description" /> <xsl:apply-templates select="description" />
<xsl:call-template name="seealso" /> <xsl:call-template name="seealso" />
</xsl:for-each> </xsl:for-each>
</xsl:template> </xsl:template>
<!-- Used only in the config options section: --> <!-- Used only in the config options section: -->
<xsl:template name="seealso"> <xsl:template name="seealso">
<xsl:if test="seealso"> <xsl:if test="seealso">
<xsl:text> <xsl:text>
</xsl:text> </xsl:text>
.rj 1 See also: <xsl:text />
\fBSee also\fR: <xsl:text />
<xsl:for-each select="seealso"> <xsl:for-each select="seealso">
<xsl:text />\fI<xsl:value-of select="." />\fR<xsl:text /> <xsl:text />\fB--<xsl:value-of select="." />\fR<xsl:text />
<xsl:if test="position() != last()"> <xsl:if test="position() != last()">
<xsl:text>, </xsl:text> <xsl:text>, </xsl:text>
</xsl:if> </xsl:if>
@ -295,51 +313,43 @@ Type: <xsl:apply-templates select="type" />
</xsl:if> </xsl:if>
</xsl:template> </xsl:template>
<!-- Used only in the config options section: --> <!-- Used only in the config options section: -->
<xsl:template name="provide-default"> <xsl:template match="default[.!='']">
<!-- <xsl:text> (</xsl:text>
Picks up the default from the XML. If the `default` element <xsl:text>\fB</xsl:text>
doesn't exist, or it's empty, a single '-' is provided. <xsl:value-of select="." />
--> <xsl:text>\fR</xsl:text>
<xsl:choose> <xsl:text> if unset)</xsl:text>
<xsl:when test="string-length(default) &gt; 0 ">
<xsl:text />Default: <xsl:apply-templates
select="default" /><xsl:text />
</xsl:when>
<xsl:otherwise>
<xsl:text />Default: -<xsl:text />
</xsl:otherwise>
</xsl:choose>
</xsl:template> </xsl:template>
<!--
Do not print redundant examples
(identical for all values of the same Type)
-->
<xsl:template match="
option[
type = 'Boolean'
or type = 'AutoBool'
or type = 'Integer'
or type = 'Tag names'
]/example" priority="2"
/>
<!-- Used only in the config options section: --> <!-- Used only in the config options section: -->
<xsl:template name="provide-example"> <xsl:template match="example[.!='']">
<!-- <xsl:text>Supported values: </xsl:text>
By default, doesn't output examples for String types (mirroring the <xsl:text>\fB</xsl:text>
quickref page). But for *any* options in the XML instance that <xsl:value-of select="." />
have an `example` child, that example will be used in lieu of a <xsl:text>\fR</xsl:text>
stylesheet-provided one. (Useful e.g. for `repeated-attributes`). <xsl:text>&#xA;&#xA;</xsl:text>
-->
<xsl:choose>
<xsl:when test="string-length(example) &gt; 0">
<xsl:text />Example: <xsl:apply-templates
select="example" /><xsl:text />
</xsl:when>
<xsl:otherwise>
<xsl:text />Default: -<xsl:text />
</xsl:otherwise>
</xsl:choose>
</xsl:template> </xsl:template>
<!-- Called from the templates below matching `code`, `em`, `strong`: --> <!-- Called from the templates below matching `code`, `em`, `strong`: -->
<xsl:template name="escape-backslash"> <xsl:template name="escape-backslash">
<!-- <!--
Since backslashes are "special" to the *roff processors used Since backslashes are "special" to the *roff processors used
to generate man pages, we need to escape backslash characters to generate man pages, we need to escape backslash characters
appearing in content with another backslash. appearing in content with another backslash.
--> -->
<xsl:choose> <xsl:choose>
<xsl:when test="contains(.,'\')"> <xsl:when test="contains(.,'\')">
@ -352,7 +362,6 @@ appearing in content with another backslash.
</xsl:choose> </xsl:choose>
</xsl:template> </xsl:template>
<!-- Appears at the bottom of the man page: --> <!-- Appears at the bottom of the man page: -->
<xsl:template name="manpage-see-also-section"> <xsl:template name="manpage-see-also-section">
.SH SEE ALSO .SH SEE ALSO
@ -388,16 +397,16 @@ Validate your HTML documents using the \fBW3C Nu Markup Validator\fR:
http://validator.w3.org/nu/ http://validator.w3.org/nu/
.RE .RE
.SH AUTHOR .SH AUTHOR
\fBTidy\fR was written by \fBDave Raggett\fR &lt;dsr@w3.org&gt;, and subsequently maintained by a team at http://tidy.sourceforge.net/, \fBTidy\fR was written by \fBDave Raggett\fR &lt;dsr@w3.org&gt;,
and subsequently maintained by a team at http://tidy.sourceforge.net/,
and now maintained by \fBHTACG\fR (http://www.htacg.org). and now maintained by \fBHTACG\fR (http://www.htacg.org).
.LP .LP
The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-html5/ under the MIT Licence. The sources for \fBHTML Tidy\fR are available at
https://github.com/htacg/tidy-html5/ under the MIT Licence.
</xsl:template> </xsl:template>
<!-- Regular Templates: --> <!-- Regular Templates: -->
<xsl:template match="description"> <xsl:template match="description">
<xsl:apply-templates /> <xsl:apply-templates />
</xsl:template> </xsl:template>
@ -407,8 +416,16 @@ The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-h
<xsl:text /> at \fI<xsl:value-of select="@href" />\fR<xsl:text /> <xsl:text /> at \fI<xsl:value-of select="@href" />\fR<xsl:text />
</xsl:template> </xsl:template>
<xsl:template match="code | em | var"> <xsl:template match="code | em">
<xsl:text />\fI<xsl:call-template name="escape-backslash" />\fR<xsl:text /> <xsl:text>\fI</xsl:text>
<xsl:call-template name="escape-backslash" />
<xsl:text>\fR</xsl:text>
</xsl:template>
<xsl:template match="var">
<xsl:text>\fB</xsl:text>
<xsl:call-template name="escape-backslash" />
<xsl:text>\fR</xsl:text>
</xsl:template> </xsl:template>
<xsl:template match="p[1]"> <xsl:template match="p[1]">
@ -438,13 +455,12 @@ The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-h
<xsl:text />\fB<xsl:call-template name="escape-backslash" />\fR<xsl:text /> <xsl:text />\fB<xsl:call-template name="escape-backslash" />\fR<xsl:text />
</xsl:template> </xsl:template>
<!-- <!--
The following templates The following templates
a) normalize whitespace, primarily necessary for `description` a) normalize whitespace, primarily necessary for `description`
b) do so without stripping possible whitespace surrounding `code` b) do so without stripping possible whitespace surrounding `code`
d) strip leading and trailing whitespace in 'description` and `code` d) strip leading and trailing whitespace in 'description` and `code`
(courtesy of Ken Holman on the XSL-list): (courtesy of Ken Holman on the XSL-list):
--> -->
<xsl:template match="text()[preceding-sibling::node() and <xsl:template match="text()[preceding-sibling::node() and