README
1 mod_tidy - a TidyLib based DSO module for the Apache HTTP Server Version 2
2
3
4What is it?
5-----------
6
7mod_tidy is a TidyLib based DSO module for the Apache HTTP Server Version 2
8to parse, clean-up and pretty-print the webservers' (X)HTML output.
9
10How does it work?
11-----------------
12
13mod_tidy works as a filter that hooks up to the (X)HTML output of an Apache 2 webserver.
14It passes the webservers' (X)HTML output to TidyLib (http://tidy.sourceforge.net/)
15which parses and optional cleans-up and pretty-prints that output. If TidyLib detects an error,
16the client receives a HTML page with a list of all found errors and warnings
17that prevent the input of being a valid (X)HTML document. If TidyLib doesn't complain,
18the client will get and display the (X)HTML data as without mod_tidy.
19
20Due to the fact that mod_tidy may affect little response delays of the webserver,
21its use should be reduced to a developer framework only. mod_tidy is not recommended
22to be used in a production environment, where response delays of the webserver are undesirable.
23
24Who makes it?
25-------------
26
27mod_tidy is initially written by Sebastian Tusk, who has retired from that project.
28The previous official project page has been accessible through the web for years,
29until it has been silently closed in April 2005. With kindly permission of the initial project owner,
30Sierk Bornemann has created a new home on Sourceforge.net to give mod_tidy a new chance.
31
32Regarding the core of mod_tidy, the TidyLib (http://tidy.sourceforge.net/), on which mod_tidy heavily relies,
33most work is done by the Tidy library team.
34
35The Latest Version
36------------------
37
38The latest version of mod_tidy can be found on the
39project page under http://mod-tidy.sourceforge.net/.
40
41Documentation
42-------------
43
44No further documentation is available as of the date of this release.
45
46Installation and Configuration
47------------------------------
48
49Please see the file called INSTALL.
50
51Licensing
52---------
53
54mod_tidy is licensed under an Apache Licence, Version 2.
55For details, please see the file called LICENSE.
56
57Contacts
58--------
59
60 o If you want to be informed about new code releases, bug fixes,
61 security fixes, general news and information about the mod_tidy module
62 visit the mod_tidy project page on http://mod-tidy.sourceforge.net/.
63
64Acknowledgments
65----------------
66
67 I wish to acknowledge the following copyrighted works that
68 make up portions of the mod_tidy module:
69
70 Portions of this software were developed at the World Wide Web Consortium (http://w3.org/)
71 (Massachusetts Institute of Technology, European Research
72 Consortium for Informatics and Mathematics, Keio University).
73 The original software is available from http://tidy.sourceforge.net/.
74