*** mod_tidy README ***

What is mod_tidy?

mod_tidy validates the HTML output of your apache2 webserver. So you don't 
need a separate application to check your HTML.

How does it works?

mod_tidy is a module for the apache2 webserver. It works as a filter that 
hooks up to HTML output. mod_tidy feeds the HTML output to TidyLib 
(http://tidy.sourceforge.net/) which validates the HTML output. If TidyLib
finds an error the client receives a HTML page with a list of all found 
errors. If TidyLib doesn't complain you will get your HTML data as without
mod_tidy.

Who makes it?

mod_tidy is written by Sebastian Tusk. But most work is done by the Tidy 
library team. You will find the TidyLib project site here.
http://tidy.sourceforge.net/

Installation

Prerequisites

* Apache 2.0.47 - http://www.apache.org/
You will need the webserver and the source headers. Other versions 
may work but have not been tested.

Building and Installation

You need to know where the apxs tool is. apxs is part of the apache2 
webserver and needed to compile mod_tidy.

$ tar xfz mod_tidy-0.3.tar.gz
$ cd mod_tidy-0.3
$ ./configure --with-apxs=/path/to/apxs 
$ make
$ su root
# make install

That compiles mod_tidy and installs the module into the httpd module directory.

Configuration

Now you need to configure the webserver.

Add the following directives to your httpd.conf file. The path to 
mod_tidy.so depends on your apache installation.

LoadModule	tidy_module	/usr/local/httpd/modules/mod_tidy.so
AddOutputFilterByType	TIDY	text/html application/xhtml+xml

So the webserver loads mod_tidy and uses mod_tidy to filter HTML and XHTML 
output.

To set TidyLib options you use the TidyOption directive. Here an example that
sets the character encoding to UTF-8.

TidyOption char-encoding utf8

For other TidyLib options refer to the TidyLib documentation.
http://tidy.sourceforge.net/


Changes since 0.2
- fix undefined 'null' error
- tidylib is now distributed with mod_tidy
- build process rewritten
