From 6455593ab0c8c51b5cec19e9046a4b2a489078ce Mon Sep 17 00:00:00 2001 From: Pedro Date: Fri, 6 Mar 2015 06:38:57 +0000 Subject: [PATCH] tidy quickref and other nitpicking docs --- build/documentation/DoxygenLayout.xml | 2 +- build/documentation/README.md | 4 ++- build/documentation/pages/main_page.dox | 12 +++---- build/documentation/pages/page_building.dox | 1 + .../pages/page_featured_options.dox | 2 ++ build/documentation/pages/page_quickref.dox | 10 ++++++ build/documentation/pages/page_tidy.dox | 1 + .../documentation/pages/page_tidy_config.dox | 2 +- build/documentation/quickref.include.xsl | 16 ++++----- build/documentation/style.css | 36 +++++++++++++++---- 10 files changed, 60 insertions(+), 26 deletions(-) create mode 100644 build/documentation/pages/page_quickref.dox diff --git a/build/documentation/DoxygenLayout.xml b/build/documentation/DoxygenLayout.xml index 9deb824..6d8ed41 100644 --- a/build/documentation/DoxygenLayout.xml +++ b/build/documentation/DoxygenLayout.xml @@ -3,7 +3,7 @@ - + diff --git a/build/documentation/README.md b/build/documentation/README.md index 46ad387..faf0fa4 100644 --- a/build/documentation/README.md +++ b/build/documentation/README.md @@ -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` diff --git a/build/documentation/pages/main_page.dox b/build/documentation/pages/main_page.dox index 4fceef9..eda8488 100644 --- a/build/documentation/pages/main_page.dox +++ b/build/documentation/pages/main_page.dox @@ -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 - Modules - \ref building_tidy -- \ref history -- \ref license +-\ref docs_howto +- \subpage history +- \subpage license - \ref todo - -\page quickref Quick Reference - -\htmlinclude quickref_include.html - */ \ No newline at end of file diff --git a/build/documentation/pages/page_building.dox b/build/documentation/pages/page_building.dox index 60e3afd..a376757 100644 --- a/build/documentation/pages/page_building.dox +++ b/build/documentation/pages/page_building.dox @@ -5,6 +5,7 @@ How to compile and install Tidy from source code. + \section Prerequisites - \b git - git-scm.com/book/en/v2/Getting-Started-Installing-Git diff --git a/build/documentation/pages/page_featured_options.dox b/build/documentation/pages/page_featured_options.dox index 8e751a6..9a8e36f 100644 --- a/build/documentation/pages/page_featured_options.dox +++ b/build/documentation/pages/page_featured_options.dox @@ -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 diff --git a/build/documentation/pages/page_quickref.dox b/build/documentation/pages/page_quickref.dox new file mode 100644 index 0000000..94f6530 --- /dev/null +++ b/build/documentation/pages/page_quickref.dox @@ -0,0 +1,10 @@ +/*! + +\page quick_ref Quick Ref + +Quick reference generated from the tidy command + +\htmlinclude quickref_include.html + + +*/ \ No newline at end of file diff --git a/build/documentation/pages/page_tidy.dox b/build/documentation/pages/page_tidy.dox index 91a75e7..44cda77 100644 --- a/build/documentation/pages/page_tidy.dox +++ b/build/documentation/pages/page_tidy.dox @@ -1,5 +1,6 @@ /*! +Running the tidy command \page tidy_cmd tidy command diff --git a/build/documentation/pages/page_tidy_config.dox b/build/documentation/pages/page_tidy_config.dox index f09cc80..9f04d40 100644 --- a/build/documentation/pages/page_tidy_config.dox +++ b/build/documentation/pages/page_tidy_config.dox @@ -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 Quick Reference page. +You can find documentation for full set of configuration options on the \ref quickref page. \section example_config Example Configuration File diff --git a/build/documentation/quickref.include.xsl b/build/documentation/quickref.include.xsl index 01c32d7..32a47e9 100644 --- a/build/documentation/quickref.include.xsl +++ b/build/documentation/quickref.include.xsl @@ -21,8 +21,8 @@ - -

Option Groups

+ +

Option Groups

  • HTML, XHTML, XML
  • Diagnostics
    • @@ -115,7 +115,7 @@ Options - Top + Top @@ -146,10 +146,10 @@ -   +   - +

    @@ -158,11 +158,11 @@ - - + +

    - Top + Top diff --git a/build/documentation/style.css b/build/documentation/style.css index 0799f32..9e032c2 100644 --- a/build/documentation/style.css +++ b/build/documentation/style.css @@ -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; }