Add tableofcontents and generally nitpick things

build/documentation/DoxygenLayout.xml

@@ -3,7 +3,6 @@
   <!-- Navigation index tabs for HTML output -->
   <navindex>
     <tab type="mainpage" visible="yes" title="Tidy Home"/>
-    <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="">

build/documentation/pages/page_building.dox

@@ -5,6 +5,7 @@
 
 How to compile and install Tidy from source code.
 
+\tableofcontents
   
 \section Prerequisites
 
@@ -79,7 +80,10 @@ make
 cmake --build . --config Release
 \endcode
 
-<h4>Install</h4>
+
+\section compileOnstall Install
+Install the applicatio and library with
+
 \code{.sh}
 # *nix
 [sudo] make install

build/documentation/pages/page_featured_options.dox

@@ -3,7 +3,9 @@
 
 \page featured_options Featured Options
 
-Overview of common tasks
+Overview of popular features and problems
+
+\tableofcontents
 
 \section indenting Indenting output for readability
 

build/documentation/pages/page_quickref.dox

@@ -4,6 +4,8 @@
 
 Quick reference generated from the tidy command
 
+
+
 \htmlinclude quickref_include.html
 
 

build/documentation/pages/page_tidy_config.dox

@@ -2,6 +2,10 @@
 
 \page tidy_config Configuration
 
+Configuration settings and files
+
+\tableofcontents
+
 To get a list of all configuration settings, see \ref config_options below or use:
 \code{.sh}
 tidy -help-config

build/documentation/pages/page_tidy_quickstart.dox

@@ -2,6 +2,8 @@
 
 \page tidy_quickstart tidy command quickstart
 
+\tableofcontents
+
 This is the syntax for invoking Tidy from the command line:
 \code{.sh}
 tidy [[options] filename]

build/documentation/pages/page_tidylib.dox

@@ -6,6 +6,8 @@
 
 About the tidylib C library and code
 
+\tableofcontents
+
 \section about_tidylib TidyLib  features
 
 - easy to integrate. Because of the near universal adoption of C linkage, a C interface may be called from a great number of programming languages.
@@ -18,6 +20,29 @@ About the tidylib C library and code
 
 -  uses adaptable I/O. As part of the larger integration strategy it was decided to fully abstract all I/O. This means a (relatively) clean separation between character encoding processing and shovelling bytes back and forth. Internally, the library reads from sources and writes to sinks. This abstraction is used for both markup and configuration “files”. Concrete implementations are provided for file and memory I/O, and new sources and sinks may be provided via the public interface.
 
+\section return_code Return codes
+
+It’s important to understand that API functions that return an integer almost universally adhere to the following convention:
+
+- \b 0 == \b Success
+    - Good to go.
+- \b 1 == \b Warnings, but no errors
+   - Check the error buffer or track error messages for details.
+- \b 2 == \b Errors (and maybe warnings)
+  - By default, Tidy will not produce output. You can force output with the TidyForceOutput option. As with warnings, check error buffer or track error messages for details.
+- <b>< 0</b> == <b>Severe error</b>
+  - Usually value equals `-errno`. See errno.h.
+
+Also, by default, warning and error messages are sent to stderr. You can redirect diagnostic 
+output using either tidySetErrorFile() or tidySetErrorBuffer(). See  tidy.h for details.
+
+
+\section app_notes Application Notes
+
+Of course, there are functions to parse and save both markup and configuration files. For the adventurous, it is possible to create new input sources and output sinks. For example, a URL source could pull the markup from a given URL.
+
+It is also worth remembering that an application may instantiate any number of document and buffer objects. They are fairly cheap to initialize and destroy (just memory allocation and zeroing, really), so they may be created and destroyed locally, as needed. There is no problem keeping them around a while for keeping state. For example, a server app might keep a global document as a master configuration. As documents are parsed, they can copy their configuration data from the master instance. See tidyOptCopyConfig(). If the master copy is initialized at startup, no synchronization is necessary.
+
 
 \section example_hello tidylib example