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

Improved quickref and man.

Browse source
This commit is contained in:
Jim Derry 2015-10-31 14:45:30 +08:00
parent 30b67f7362
commit 7c7330343e
2 changed files with 222 additions and 430 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

638
documentation/quickref.xsl
View file

@ -1,7 +1,8 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!-- <!--
For generating the `quickref.html` web page from output of For generating the `quickref.html` web page from output of
`tidy -xml-config` `tidy -xml-config`, which is used on our websites and can
be generated by end users.
(c) 2005 (W3C) MIT, ERCIM, Keio University (c) 2005 (W3C) MIT, ERCIM, Keio University
See tidy.h for the copyright notice. See tidy.h for the copyright notice.
@ -15,7 +16,7 @@
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="xml" indent="yes" <xsl:output method="xml" indent="yes"
encoding="us-ascii" encoding="UTF-8"
omit-xml-declaration="yes" omit-xml-declaration="yes"
doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" /> doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" />
@ -23,25 +24,26 @@
<xsl:template match="/"> <xsl:template match="/">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml"> <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>HTML Tidy Configuration Options Quick Reference</title> <title>HTML Tidy <xsl:value-of select="config/@version" /> Options Quick Reference</title>
<xsl:call-template name="Stylesheet" /> <xsl:call-template name="Stylesheet" />
</head> </head>
<body> <body>
<h1 id="top">Quick Reference</h1> <h1 id="top">HTML Tidy <xsl:value-of select="config/@version" /> Options Quick Reference</h1>
<h2>HTML Tidy Configuration Options</h2> <h2 id="top">Option Groups</h2>
<ul class="option_groups">
<p>Version: <xsl:value-of select="config/@version" /></p> <li><a href="#MarkupHeader">HTML, XHTML, XML</a></li>
<li><a href="#DiagnosticsHeader">Diagnostics</a></li>
<p><a class="h3" href="#MarkupHeader">HTML, XHTML, XML</a><br /> <li><a href="#PrettyPrintHeader">Pretty Print</a></li>
<a class="h3" href="#DiagnosticsHeader">Diagnostics</a><br /> <li><a href="#EncodingHeader">Character Encoding</a></li>
<a class="h3" href="#PrettyPrintHeader">Pretty Print</a><br /> <li><a href="#MiscellaneousHeader">Miscellaneous</a></li>
<a class="h3" href="#EncodingHeader">Character Encoding</a><br /> </ul>
<a class="h3" href="#MiscellaneousHeader">Miscellaneous</a></p>
<h2 id="top">Option Index</h2>
<xsl:call-template name="link-section" /> <xsl:call-template name="link-section" />
<h2 id="top">Option Details</h2>
<xsl:call-template name="detail-section" /> <xsl:call-template name="detail-section" />
</body> </body>
@ -52,13 +54,7 @@
<!-- Named Templates: --> <!-- Named Templates: -->
<xsl:template name="link-section"> <xsl:template name="link-section">
<table summary="Tidy Options Quick Reference Header Section" border="0" <table summary="Options Quick Reference Index Section" class="index_table">
cellpadding="3" cellspacing="0">
<colgroup>
<col width="33%" />
<col width="33%" />
<col width="33%" />
</colgroup>
<xsl:call-template name="links"> <xsl:call-template name="links">
<xsl:with-param name="class">markup</xsl:with-param> <xsl:with-param name="class">markup</xsl:with-param>
<xsl:with-param name="header">HTML, XHTML, XML</xsl:with-param> <xsl:with-param name="header">HTML, XHTML, XML</xsl:with-param>
@ -89,8 +85,7 @@
<xsl:template name="detail-section"> <xsl:template name="detail-section">
<table summary="Tidy Options Quick Reference Detail Section" border="0" <table summary="Options Quick Reference Detail Section" class="detail_table">
cellpadding="3" cellspacing="0">
<xsl:call-template name="reference"> <xsl:call-template name="reference">
<xsl:with-param name="class">markup</xsl:with-param> <xsl:with-param name="class">markup</xsl:with-param>
<xsl:with-param name="header">HTML, XHTML, XML</xsl:with-param> <xsl:with-param name="header">HTML, XHTML, XML</xsl:with-param>
@ -124,31 +119,32 @@
<xsl:param name="class"/> <xsl:param name="class"/>
<xsl:param name="header"/> <xsl:param name="header"/>
<xsl:param name="headerID"/> <xsl:param name="headerID"/>
<tr valign="bottom"> <thead>
<td class="h3" colspan="2" id="{$headerID}"> <tr class="header_category">
<xsl:value-of select="$header"/> Options</td> <td colspan="3" id="{$headerID}">
<td valign="top"><a href="#top">Top</a></td> <xsl:value-of select="$header"/> Options
</tr>
<xsl:call-template name="ClassHeaders" />
<xsl:for-each select="/config/option[@class=$class]">
<xsl:sort select="name" order="ascending" />
<tr>
<td><a href="#{name}"><xsl:value-of select="name"/></a></td>
<td><xsl:apply-templates select="type"/></td>
<td><xsl:choose>
<xsl:when test="string-length(default) &gt; 0 ">
<xsl:apply-templates select="default" />
</xsl:when>
<xsl:otherwise>
<strong>-</strong>
</xsl:otherwise>
</xsl:choose>
</td> </td>
</tr> </tr>
</xsl:for-each> <xsl:call-template name="ClassHeaders" />
<tr valign="bottom"> </thead>
<td colspan="3">&#160;</td> <tbody>
</tr> <xsl:for-each select="/config/option[@class=$class]">
<xsl:sort select="name" order="ascending" />
<tr>
<td><a href="#{name}"><xsl:value-of select="name"/></a></td>
<td><xsl:apply-templates select="type"/></td>
<td><xsl:choose>
<xsl:when test="string-length(default) &gt; 0 ">
<xsl:apply-templates select="default" />
</xsl:when>
<xsl:otherwise>
<strong>-</strong>
</xsl:otherwise>
</xsl:choose>
</td>
</tr>
</xsl:for-each>
</tbody>
</xsl:template> </xsl:template>
@ -157,417 +153,213 @@
<xsl:param name="header"/> <xsl:param name="header"/>
<xsl:param name="headerID"/> <xsl:param name="headerID"/>
<tr> <thead>
<td>&#160;</td> <tr class="header_category">
</tr> <td colspan="2" id="{$headerID}">
<tr valign="bottom"> <xsl:value-of select="$header"/> Options Reference
<td valign="top" colspan="2" class="h2" id="{$headerID}"> </td>
<xsl:value-of select="$header"/> Options Reference </tr>
</td> </thead>
</tr>
<tr>
<td>&#160;</td>
</tr>
<xsl:for-each select="/config/option[@class=$class]"> <xsl:for-each select="/config/option[@class=$class]">
<xsl:sort select="name" order="ascending" /> <xsl:sort select="name" order="ascending" />
<tr> <thead>
<td class="tabletitle" valign="top" id="{name}"> <tr class="header_option_name">
<xsl:value-of select="name"/> <td colspan="2" id="{name}">
</td> <xsl:value-of select="name"/>
<td class="tabletitlelink" valign="top" align="right"> </td>
<a href="#top">Top</a></td> </tr>
</tr> </thead>
<tr> <tbody>
<td valign="top">Type: <strong><xsl:value-of <tr>
select="type"/></strong><br /> <td>Type:</td>
<td><xsl:value-of select="type"/></td>
<xsl:choose> </tr>
<xsl:when test="string-length(default) &gt; 0"> <tr>
Default: <strong><xsl:apply-templates select="default" /></strong> <td>Default:</td>
</xsl:when> <td>
<xsl:otherwise> <xsl:choose>
Default: <strong>-</strong> <xsl:when test="string-length(default) &gt; 0">
</xsl:otherwise> <xsl:apply-templates select="default" />
</xsl:choose> </xsl:when>
<xsl:otherwise>
<xsl:choose> -
<xsl:when test="string-length(example) &gt; 0"> </xsl:otherwise>
<br />Example: <strong><xsl:apply-templates </xsl:choose>
select="example"/></strong> </td>
</xsl:when> </tr>
<xsl:otherwise> <tr>
<br />Example: <strong>-</strong> <td>Example</td>
</xsl:otherwise> <td>
</xsl:choose> <xsl:choose>
</td> <xsl:when test="string-length(example) &gt; 0">
<td align="right" valign="top"> <xsl:apply-templates select="example"/>
<xsl:for-each select="seealso"> </xsl:when>
<a href="#{.}"><xsl:apply-templates select="." /></a> <xsl:otherwise>
<xsl:if test="position() != last()"> -
<br /> </xsl:otherwise>
</xsl:if> </xsl:choose>
</xsl:for-each> </td>
</td> </tr>
</tr> <tr>
<td>See also:</td>
<tr> <td>
<td colspan="2" class="qdescription"><xsl:apply-templates select="description"/></td> <xsl:for-each select="seealso">
</tr> <a href="#{.}"><xsl:apply-templates select="." /></a>
<xsl:if test="position() != last()">
<tr> <xsl:text>, </xsl:text>
<td>&#160;</td> </xsl:if>
</tr> </xsl:for-each>
</td>
</tr>
<tr>
<td></td>
<td class="qdescription"><xsl:apply-templates select="description"/></td>
</tr>
</tbody>
</xsl:for-each> </xsl:for-each>
</xsl:template> </xsl:template>
<xsl:template name="ClassHeaders"> <xsl:template name="ClassHeaders">
<tr> <tr class="header_column_labels" >
<td class="tabletitle">Option</td> <td>Option</td>
<td class="tabletitle">Type</td> <td>Type</td>
<td class="tabletitle">Default</td> <td>Default</td>
</tr> </tr>
</xsl:template> </xsl:template>
<xsl:template name="Stylesheet"> <xsl:template name="Stylesheet">
<style type="text/css"> <style type="text/css">
/* 1st Style ignored by Netscape */
td.dummy, font.dummy, .dummy, a:link.dummy, a:visited.dummy, a:active.dummy /**************************************
BASIC STYLES
**************************************/
body
{ {
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif; margin: 3em;
font-size: 16pt; padding: 0;
color: #336699; font-family: Helvetica, sans-serif;
text-decoration: none; font-size: 100%;
font-weight: normal color: black;
} background-color: cornsilk
body
{
margin-left: 10%;
margin-right: 10%;
font-family: sans-serif;
background-color: #FFFFFF
}
/* Blue TITLE */
td.title, font.title, .title, a:link.title, a:visited.title, a:active.title
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 16pt;
color: #336699;
text-decoration: none;
font-weight: normal
}
/* BODY TEXT */
td.text, font.text, .text, a:link.text, a:visited.text, a:active.text
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 9pt;
color: #000000;
text-decoration: none;
font-weight: normal
}
/* BOLD BODY TEXT */
td.textbold, font.textbold, .textbold, a:link.textbold, a:visited.textbold, a:active.textbold
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 9pt;
color: #000000;
text-decoration: none;
font-weight: bold
}
/* BOLD BODY TEXT LINK WITH UNDERLINE*/
td.textboldlink, font.textboldlink, .textboldlink, a:link.textboldlink, a:visited.textboldlink, a:active.textboldlink
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 9pt;
color: #000000;
font-weight: bold
}
/* SMALL BODY TEXT */
td.smtext, font.smtext, .smtext, a:link.smtext, a:visited.smtext, a:active.smtext
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 8pt;
color: #000000;
text-decoration: none;
font-weight: normal
}
/* SMALL BOLD BODY TEXT */
td.smtextbold, font.smtextbold, .smtextbold, a:link.smtextbold, a:visited.smtextbold, a:active.smtextbold
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 8pt;
color: #000000;
text-decoration: none;
font-weight: bold
}
/* TITLES
td.title, font.title, .title, a:link.title, a:visited.title, a:active.title
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
color: #CC3300;
text-decoration: none;
font-weight: bold
}
*/
/* SUBTITLES */
td.subtitle, font.subtitle, .subtitle, a:link.subtitle, a:visited.subtitle, a:active.subtitle
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 11pt;
color: #000000;
text-decoration: none;
font-weight: bold
}
/* LEGAL TEXT */
td.legal, font.legal, .legal, a:link.legal, a:visited.legal, a:active.legal
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 8pt;
color: #000000;
text-decoration: none;
font-weight: normal
}
td.legallink, font.legallink, .legallink, a:link.legallink, a:visited.legallink, a:active.legallink
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 8pt;
color: #CC3300;
font-weight: normal
}
/* RED TEXT */
td.textred, font.textred, .textred, a:link.textred, a:visited.textred, a:active.textred
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #CC3300;
text-decoration: none;
font-weight: normal
}
/* RED TEXT BOLD*/
td.textredbold, font.textredbold, .textredbold, a:link.textredbold, a:visited.textredbold, a:active.textredbold
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #CC3300;
text-decoration: none;
font-weight: bold
}
/* LINKS */
td.link, font.link, .link, a:link.link, a:visited.link, a:active.link
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #3366CC;
font-weight: normal
}
td.tabletitlelink, font.tabletitlelink, .tabletitlelink, a:link.tabletitlelink, a:visited.tabletitlelink, a:active.tabletitlelink
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
background-color: #e9e9d3;
color: #000000;
}
/* TABLE TITLES */
td.tabletitle, font.tabletitle, .tabletitle, a:link.tabletitle, a:visited.tabletitle, a:active.tabletitle
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #336699;
background-color: #e9e9d3;
/* text-decoration: none; */
font-weight: bold
}
/* TABLE CELL */
td.cell, tr.cell, font.cell, .cell, a:link.cell, a:visited.cell, a:active.cell
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
color: #000000;
font-weight: normal;
/* background-color: #e9e9d3 */
background-color: #f5f5f5
}
/* SHADED TABLE CELL */
td.shaded, tr.shaded, font.shaded, .shaded, a:link.shaded, a:visited.shaded, a:active.shaded
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
color: #000000;
font-weight: normal;
background-color: #f5f5f5
} }
/* BR IN TABLE DATA DESCRIPTION */ a
{
text-decoration: none;
}
a:hover
{
text-decoration: underline;
}
a,
a:visited
{
color: blue;
}
/**************************************
MAKE BR FORMAT LIKE P
**************************************/
td.qdescription br td.qdescription br
{ {
content: " "; content: " ";
display: block; display: block;
margin: 10px 0; margin: 10px 0;
} }
/* GLOSSARY TERM */ /**************************************
td.term, font.term, .term, a:link.term, a:visited.term, a:active.term OPTION GROUP INDEX
**************************************/
ul.option_groups
{ {
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif; list-style-type: square;
font-size: 10pt;
font-style: normal;
color: #000000;
text-decoration: none;
font-weight: normal
} }
/* ELEMENT TAGS */ ul.option_groups li
ul
{ {
font-family: Arial, Helvetica, sans-serif; line-height: 150%;
font-size: 10pt;
font-style: normal;
font-weight: normal
} }
li
/**************************************
TABLES
**************************************/
table
{ {
font-family: Arial, Helvetica, sans-serif; border-collapse: collapse;
font-size: 10pt;
font-style: normal;
font-weight: normal
} }
a:link.h1, a:visited.h1, .h1
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
color: #0066CC
}
a:active.h1
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
font-weight: bold;
color: #0066CC
}
h1
{
margin-left: -8%;
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 12pt;
color: #0066CC
}
.h2
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 11pt;
/* font-weight: bold; */
color: #000000
}
h2
{
margin-left: -4%;
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 11pt;
/* font-weight: bold; */
color: #000000
}
A:link.h3, A:visited.h3, .h3
{ font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #000000;
font-weight: bold
}
A:active.h3
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
color: #000000;
font-weight: bold
}
h3
{
margin-left: -4%;
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
font-weight: bold;
color: #000000
}
h4
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 9pt;
font-weight: bold;
color: #000000
}
.code, A:active.code, A:link.code, A:visited.code
{
font-family: "Courier New", Courier, monospace;
}
.abstract
{
font-style : italic;
}
p
{
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif;
font-size: 10pt;
font-style: normal
}
td td
{ {
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif; padding: 5px;
font-size: 10pt;
font-style: normal
} }
/* LINKS */
a:link, a:active /* CATEGORY ROWS */
{ tr.header_category
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif; {
font-size: 10pt; background-color: burlywood;
color: #3366CC; line-height: 3.0em;
font-weight: normal font-size: 1.2em;
} font-weight: bold;
}
tr.header_category td,
table.detail_table .section_thead tr td
{
padding-left: 1em;
}
/* INDEX HEADER ROW and DETAIL OPTION NAME */
tr.header_column_labels,
tr.header_option_name
{
background-color: antiquewhite;
}
a:visited tr.header_column_labels td
{ {
font-family: Arial, Helvetica, "Trebuchet MS", sans-serif; font-weight: bold;
font-size: 10pt; padding-left: 1.0em;
color: #333366; }
font-weight: normal
}
code {
/* use browser/user default for `font-family` */ tr.header_option_name td
font-weight: bold; {
color: brown; font-size: 1.1em;
background: transparent; font-weight: bold;
} padding-left: 1.0em;
line-height: 1.2em;
}
/* INDEX TABLE APPEARANCE */
table.index_table tbody tr
{
line-height: 2em;
border-bottom: 1px solid burlywood;
}
table.index_table tbody tr td:first-child
{
padding-left: 1em;
}
/* DETAILS TABLE DETAILS */
table.detail_table tbody td:first-child
{
text-align: right;
font-weight: bold;
min-width: 6.0em;
}
code
{
color: darkgreen;
font-size: 1.3em;
}
</style> </style>
</xsl:template> </xsl:template>

14
documentation/tidy1.xsl.in
View file

@ -258,7 +258,7 @@ For each option in one of the 5 categories/classes, provide its
.TP .TP
\fB<xsl:apply-templates select="name" />\fR \fB<xsl:apply-templates select="name" />\fR
Type: \fI<xsl:apply-templates select="type" />\fR Type: <xsl:apply-templates select="type" />
.br .br
<xsl:call-template name="provide-default" /> <xsl:call-template name="provide-default" />
.br .br
@ -298,11 +298,11 @@ doesn't exist, or it's empty, a single '-' is provided.
--> -->
<xsl:choose> <xsl:choose>
<xsl:when test="string-length(default) &gt; 0 "> <xsl:when test="string-length(default) &gt; 0 ">
<xsl:text />Default: \fI<xsl:apply-templates <xsl:text />Default: <xsl:apply-templates
select="default" />\fR<xsl:text /> select="default" /><xsl:text />
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:text />Default: \fI-\fR<xsl:text /> <xsl:text />Default: -<xsl:text />
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:template> </xsl:template>
@ -318,11 +318,11 @@ stylesheet-provided one. (Useful e.g. for `repeated-attributes`).
--> -->
<xsl:choose> <xsl:choose>
<xsl:when test="string-length(example) &gt; 0"> <xsl:when test="string-length(example) &gt; 0">
<xsl:text />Example: \fI<xsl:apply-templates <xsl:text />Example: <xsl:apply-templates
select="example" />\fR<xsl:text /> select="example" /><xsl:text />
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<xsl:text />Default: \fI-\fR<xsl:text /> <xsl:text />Default: -<xsl:text />
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:template> </xsl:template>