HTML Tidy Library Project

A quorum of developers have pitched in on a SourceForge project to maintain and further develop Dave Raggett's excellent HTML Tidy program. We have two primary goals. First, to provide a home where all the patches and fixes that folks contribute can be collected and incorporated into the program. Second, a library form of Tidy has been created to make it easier to incorporate Tidy into other software.

Table of Contents

News

The latest version of tidy is exclusively available through CVS (current version number).

18 June 2008

The configuration option anchor-as-name has been added.

13 August 2007

The configuration option merge-spans has been added.

14 June 2007

The configuration option sort-attributes has been added. Additionally, the option show-body-only has been extended to accept auto.

26 February 2007

The executables built by the sourceforge compile farm are not provided anymore. Likewise for the annotated source code by LXR. A reference to Dirk Paehl's Windows build has been added.

11 February 2007

The configuration option preserve-entities has been added.

23 January 2007

With the current version of tidy, tidylib users using tidyBuffer need to recompile their code. From tidy dated "23 January 2007", source compatibility should work although explicitly calling tidyBufInit is recommended (see tidy/include/tidy.h for an example).

30 December 2006

A Windows ".def" file is now provided in the distribution (issue 1459819). All internal symbols are now mangled (issue 1533253). These should simplify the use of tidylib.

29 December 2006

From tidy dated "29 December 2006", new APIs are available to use user-defined allocators (issue 1160008). The interface of tidyFileExists has changed.

12 October 2006

From tidy dated "12 October 2006", tidy uses memory mapped i/o by default (issue 1551769).

14 February 2006

From tidy dated "14 February 2006", ports on Windows 64 should work out-of-the-box.

20 January 2006

The automated build is currently broken. The latest source can be obtained using CVS.

11 November, 2005

From tidy dated "11 November 2005", hash lookup is used by default (issue 1331849). This can be disabled at build time. Please report any bug. Along with issue 1345637 being fixed, tidy should handle large documents faster.

October, 2005

Terry Teague who co-maintained tidy since 2001 died. Terry was instrumental in keeping tidy going and will be missed.

21 July, 2005

The man page is now available online (formatted using groff -Thtml -mandoc).

14 June, 2005

The quick reference card and the man page are now automatically generated as part of the build process using the TidyLib APIs. Use 'make doc' to generate them.

21 November, 2004

The source code is now searchable and cross-referenced using LXR.

18 September, 2004

Also added Checked by Tidy icon (courtesy of Marc Gueury).

1 August, 2004

Automatic updates of the source, documentation, and SourceForge compile farm machine builds to this web site are temporarily disabled, due to SourceForge removing support for the 'cron' jobs that automate this process.

Please bear with us during this period - manual updates may be made on an ad-hoc basis, source is always available through CVS.

5 July, 2004

Updated the list of available SourceForge compile farm machine builds.

26 June, 2004

Updated some links to third-party products.

Documentation

Dave Raggett's Overview

Quick Reference

Man Page

Introduction to TidyLib

TidyLib API Docs

Also, try the -help-config command line option to get a brief listing of Tidy configuration options. Try -show-config to get a listing of all options in effect.

Frequently Asked Questions

The source code of the documentation can be found in the htmldoc directory in the distribution available through CVS.

The original 04 Aug 00 Tidy documentation.

Support

For information on getting support for HTML Tidy, please see the FAQ item on How To Get Support.

Executable binaries

If you are a beginner using Windows you may want this installer (provided as a service by Cory Nelson) that includes Dave Raggett's overview and a quick reference to all of Tidy's options.

If you don't find a pre-built executable version of Tidy to download for your machine/OS in the tables below, look at the links on the right side of this page for versions of Tidy provided by various people.

Documentation and source code are not included. You may download documentation and source code separately.

To better safeguard the TidyLib source code and pre-built binaries against hacker attacks, MD5 hash sums are automatically generated for the source code archive and all pre-built binary archives, and displayed on this web page. You can use the appropriate command on your platform (e.g. "md5sum archive.tgz") to verify that files you have downloaded from this site have not been tampered with.

Other Builds

These are manually built by various people on an ad hoc basis, and are generally unsupported.

Platform Last Updated Author
Windows 95/98/ME/2000/XP exe

Current

Dirk Paehl

Windows 95/98/ME/2000/XP exe/lib/dll

April 2006

Cory Nelson

OS/2

13 December, 2002

Christian Hennecke

MkLinux

5 July, 2004

Terry Teague

Mac OS (Classic)
Mac OS X
Windows 95/98/ME/2000/XP

License

HTML Tidy, including both TidyLib and the command line utility, uses a MIT-like license. This license allows you to do almost anything with the code, except to represent your changes as coming from the W3C. For details, read the license.

Source code

The TidyLib source code is the main trunk in CVS.

As well as the standard GNU make Makefile provided, there are additional tools available to build TidyLib, including GNU autoconf and Microsoft Visual C; these are available in the "build" directory.

Feel free to browse the CVS repository.

The source code distribution is not generated anymore. To better safeguard the TidyLib source code and pre-built binaries against hacker attacks, MD5 hash sums are automatically generated for the source code archive and all pre-built binary archives, and displayed on this web page. You can use the appropriate command on your platform (e.g. "md5sum archive.tgz") to verify that files you have downloaded from this site have not been tampered with.

Download older versions of the source code.

Test cases

The test suite can be found in the test directory in the distribution available through CVS.

Release Process

If you are not comfortable working with the latest versions of Tidy, you can stay with the last official release of Tidy, by Dave Raggett on 04 Aug 00. However, there have been many changes and bugs fixed in Tidy since that release, and you are encouraged to use the latest versions. If you need the original 04 Aug 00 executable for Win32, you can download that here.

For more information on the HTML Tidy release process, please see the FAQ item on Tidy versions.

Valid XHTML 1.0! Checked by Tidy!