From a358365d7b1850d17054a3aa1c46fc888c108e2f Mon Sep 17 00:00:00 2001 From: Pedro Date: Fri, 6 Mar 2015 01:21:05 +0000 Subject: [PATCH] adding summaries to pages and minor tweaks --- build/documentation/pages/page_building.dox | 2 ++ build/documentation/pages/page_history.dox | 12 +++++++----- build/documentation/pages/page_license.dox | 3 +++ build/documentation/pages/page_tidylib.dox | 16 ++++++++++------ build/documentation/pages/page_todo.dox | 4 ++++ 5 files changed, 26 insertions(+), 11 deletions(-) diff --git a/build/documentation/pages/page_building.dox b/build/documentation/pages/page_building.dox index d2202c5..60e3afd 100644 --- a/build/documentation/pages/page_building.dox +++ b/build/documentation/pages/page_building.dox @@ -3,6 +3,8 @@ \page building_tidy Building Tidy +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_history.dox b/build/documentation/pages/page_history.dox index 22ee95c..75346ac 100644 --- a/build/documentation/pages/page_history.dox +++ b/build/documentation/pages/page_history.dox @@ -3,10 +3,7 @@ \page history History -- This repository originally transferred from w3c.github.com/tidy-html5. - -- First moved to Github from tidy.sourceforge.net - +Once upon a time....

HTML Tidy was created by the W3C’s own Dave Raggett back in the dawn of the Internet age. His original Internet page is still available and @@ -18,7 +15,7 @@ maintainers at tidy.sourceforge.net w performed.

W3C members took a renewed interest in Tidy in 2011 and forked the -project to github (now redirects to new maintainers), where it featured +project to github (now redirects to this project), where it featured compatibility with HTML5 via a key contribution from one of the SourceForge key members.

@@ -32,4 +29,9 @@ being developed and prepped for a new, stable, and modern release.

to harmonize HTML Tidy into a single, stable, solid release once again.

+ +- This repository originally transferred from w3c.github.com/tidy-html5. +- First moved to Github from tidy.sourceforge.net + + */ \ No newline at end of file diff --git a/build/documentation/pages/page_license.dox b/build/documentation/pages/page_license.dox index b719223..e8e0ac4 100644 --- a/build/documentation/pages/page_license.dox +++ b/build/documentation/pages/page_license.dox @@ -2,6 +2,9 @@ \page license License + +License and Legal + 
 \htmlinclude LICENSE.md
diff --git a/build/documentation/pages/page_tidylib.dox b/build/documentation/pages/page_tidylib.dox index abb5ce6..3e7d726 100644 --- a/build/documentation/pages/page_tidylib.dox +++ b/build/documentation/pages/page_tidylib.dox @@ -4,18 +4,22 @@ \page tidylib tidylib -- \b TidyLib - is 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. +About the tidylib C library and code -- \b TidyLib - is designed to use opaque types in the public interface. This allows the application to just pass an integer around and the need to transform data types in different languages is minimized. As a results it’s straight-forward to write very thin library wrappers for C++, Pascal, and COM/ATL. +\section about_tidylib TidyLib features -- \b TidyLib - eats its own dogfood. HTML Tidy links directly to TidyLib. +- 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. -- \b TidyLib - is Thread Safe and Re-entrant. Because there are many uses for HTML Tidy - from content validation, content scraping, conversion to XHTML - it was important to make TidyLib run reasonably well within server applications as well as client side. +- designed to use opaque types in the public interface. This allows the application to just pass an integer around and the need to transform data types in different languages is minimized. As a results it’s straight-forward to write very thin library wrappers for C++, Pascal, and COM/ATL. -- \b TidyLib - 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. +- eats its own dogfood. HTML Tidy links directly to TidyLib. + +- is Thread Safe and Re-entrant. Because there are many uses for HTML Tidy - from content validation, content scraping, conversion to XHTML - it was important to make TidyLib run reasonably well within server applications as well as client side. + +- 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 example_hello Example +\section example_hello tidylib example \include example.1.c diff --git a/build/documentation/pages/page_todo.dox b/build/documentation/pages/page_todo.dox index de5fad5..7b935d9 100644 --- a/build/documentation/pages/page_todo.dox +++ b/build/documentation/pages/page_todo.dox @@ -3,6 +3,10 @@ \page todo Todo List +The todo list. + +\note If this page is empty, then there are no todo items flagged in source. + \xrefitem "Todo" "Todo List"