tidy quickref and other nitpicking docs

This commit is contained in:
Pedro 2015-03-06 06:38:57 +00:00
parent 3d9085c6f1
commit 6455593ab0
10 changed files with 60 additions and 26 deletions

View file

@ -3,7 +3,7 @@
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="Tidy Home"/>
<tab type="user" url="quickref.html" title="Quick Ref"/>
<tab type="user" url="@ref quick_ref" title="Quick Ref"/>
<tab type="pages" visible="yes" title="Pages" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">

View file

@ -1,4 +1,6 @@
# Documentation HOWTO
Documentation HOWTO {#docs_howto}
========================
Instructions for generating documentation
\note For linking to these docs, the doxygen tag file is `tidy.tags`

View file

@ -34,7 +34,7 @@ is converted to
- 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
@ -43,14 +43,10 @@ is converted to
- \ref tidylib
- <a href="modules.html">Modules</a>
- \ref building_tidy
- \ref history
- \ref license
-\ref docs_howto
- \subpage history
- \subpage license
- \ref todo
\page quickref Quick Reference
\htmlinclude quickref_include.html
*/

View file

@ -5,6 +5,7 @@
How to compile and install Tidy from source code.
\section Prerequisites
- \b git - <a href="http://git-scm.com/book/en/v2/Getting-Started-Installing-Git">git-scm.com/book/en/v2/Getting-Started-Installing-Git</a>

View file

@ -3,6 +3,8 @@
\page featured_options Featured Options
Overview of common tasks
\section indenting Indenting output for readability
Indenting the source markup of an HTML document makes the markup easier to read. Tidy can indent the

View file

@ -0,0 +1,10 @@
/*!
\page quick_ref Quick Ref
Quick reference generated from the tidy command
\htmlinclude quickref_include.html
*/

View file

@ -1,5 +1,6 @@
/*!
Running the tidy command
\page tidy_cmd tidy command

View file

@ -28,7 +28,7 @@ immediately (no intervening space) with the string “--”; for example:
tidy --break-before-br true --show-warnings false
\endcode
You can find documentation for full set of configuration options on the <a href="quickref.html">Quick Reference</a> page.
You can find documentation for full set of configuration options on the \ref quickref page.
\section example_config Example Configuration File

View file

@ -21,8 +21,8 @@
<xsl:template match="/">
<a name="top"></a>
<h1 id="top">Option Groups</h1>
<a name="qtop"></a>
<h2 id="top">Option Groups</h2>
<ul>
<li><a class="h3" href="#MarkupHeader">HTML, XHTML, XML</a></li>
<li><a class="h3" href="#DiagnosticsHeader">Diagnostics</a></li>
@ -115,7 +115,7 @@
<tr valign="bottom">
<td class="h3" colspan="2" id="{$headerID}">
<xsl:value-of select="$header"/> Options</td>
<td valign="top" class="h3top"><a href="#top" class="h3topa">Top</a></td>
<td valign="top" class="h3top"><a href="#qtop" class="h3topa">Top</a></td>
</tr>
<xsl:call-template name="ClassHeaders" />
<xsl:for-each select="/config/option[@class=$class]">
@ -146,10 +146,10 @@
<xsl:param name="headerID"/>
<tr>
<td>&#160;</td>
<td colspan="3">&#160;</td>
</tr>
<tr valign="bottom">
<td valign="top" colspan="2" class="h2" id="{$headerID}">
<td valign="top" colspan="3" class="h2" id="{$headerID}">
<h2 class="qh2"><xsl:value-of select="$header"/></h2>
</td>
</tr>
@ -158,11 +158,11 @@
<xsl:for-each select="/config/option[@class=$class]">
<xsl:sort select="name" order="ascending" />
<tr>
<td class="qoptiontitle" valign="top" id="{name}" colspan="2">
<xsl:value-of select="name"/>
<td valign="top" id="{name}" colspan="2" class="qoptiontitletd">
<h4 class="qoptiontitle"><xsl:value-of select="name"/></h4>
</td>
<td class="tabletitlelink" valign="top" align="right">
<a href="#top">Top</a>
<a href="#qtop">Top</a>
</td>
</tr>
<tr>

View file

@ -190,22 +190,29 @@ dl.section dd {
/* Quickref */
table.quickref {
font-size: 10pt;
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: 4px;
border-radius: 5px;
border: none;
margin: 0;
padding: 8px;
font-size: 15pt;
width: 100%;
}
table td.h3 {
@ -219,8 +226,12 @@ table td.h3top {
padding: 8px;
border-top-right-radius: 8px;
text-align: right;
font-size: 8pt;
}
.h3topa {
table td.h3top a{
color: #dddddd !important;
}
.h3topssssa {
color: #333333;
}
@ -229,12 +240,23 @@ table td.tabletitle {
background-color: #cccccc;
font-size: 8pt;
}
table td.qoptiontitle {
background-color: #cccccc;
font-size: 10pt;
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-left: 5px;
padding: 5px 5px 5px 10px;
margin: 0;
border-top-left-radius: 5px;
border-top-right-radius: 5px;
}