adding summaries to pages and minor tweaks

This commit is contained in:
Pedro 2015-03-06 01:21:05 +00:00
parent 5fde57fcd4
commit a358365d7b
5 changed files with 26 additions and 11 deletions

View file

@ -3,6 +3,8 @@
\page building_tidy Building Tidy \page building_tidy Building Tidy
How to compile and install Tidy from source code.
\section Prerequisites \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> - \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,10 +3,7 @@
\page history History \page history History
- This repository originally transferred from w3c.github.com/tidy-html5. Once upon a time....
- First moved to <a href="https://github.com/htacg/tidy-html5">Github</a> from <a href="http://tidy.sourceforge.net/">tidy.sourceforge.net</a>
<p><strong>HTML Tidy</strong> was created by the <a href="http://www.w3.org/">W3Cs</a> own <a href="http://www.w3.org/People/Raggett/">Dave Raggett</a> back in the <p><strong>HTML Tidy</strong> was created by the <a href="http://www.w3.org/">W3Cs</a> own <a href="http://www.w3.org/People/Raggett/">Dave Raggett</a> back in the
dawn of the Internet age. His original Internet page is still available and dawn of the Internet age. His original Internet page is still available and
@ -18,7 +15,7 @@ maintainers at <a href="http://tidy.sourceforge.net/">tidy.sourceforge.net</a> w
performed.</p> performed.</p>
<p>W3C members took a renewed interest in <strong>Tidy</strong> in 2011 and forked the <p>W3C members took a renewed interest in <strong>Tidy</strong> in 2011 and forked the
project to <a href="https://github.com/w3c/tidy-html5">github</a> (now redirects to new maintainers), where it featured project to <a href="https://github.com/w3c/tidy-html5">github</a> (now redirects to this project), where it featured
compatibility with HTML5 via a <a href="https://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html">key contribution</a> from one of the SourceForge compatibility with HTML5 via a <a href="https://lists.w3.org/Archives/Public/www-archive/2011Nov/0007.html">key contribution</a> from one of the SourceForge
key members.</p> key members.</p>
@ -32,4 +29,9 @@ being developed and prepped for a new, stable, and modern release.</p>
to harmonize <strong>HTML Tidy</strong> into a single, stable, solid release once again.</p> to harmonize <strong>HTML Tidy</strong> into a single, stable, solid release once again.</p>
- This repository originally transferred from w3c.github.com/tidy-html5.
- First moved to <a href="https://github.com/htacg/tidy-html5">Github</a> from <a href="http://tidy.sourceforge.net/">tidy.sourceforge.net</a>
*/ */

View file

@ -2,6 +2,9 @@
\page license License \page license License
License and Legal
<pre> <pre>
\htmlinclude LICENSE.md \htmlinclude LICENSE.md
</pre> </pre>

View file

@ -4,18 +4,22 @@
\page tidylib tidylib \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 its 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 its 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 \include example.1.c

View file

@ -3,6 +3,10 @@
\page todo Todo List \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" \xrefitem "Todo" "Todo List"