Documentation

HTML Purifier has documentation for all types of people. Here is an index of all of them.

End-user

End-user documentation that contains articles, tutorials and useful information for casual developers using HTML Purifier.

IDs
Explains various methods for allowing IDs in documents safely in HTML Purifier.

Development

Developer documentation detailing code issues, roadmaps and project conventions.

Code Quality Issues
Discusses code quality issues and places that need to be refactored.
Implementation Progress
Tables detailing HTML element and CSS property implementation coverage.
Naming Conventions
Defines class naming conventions.
Optimization
Discusses possible methods of optimizing HTML Purifier.

Proposals

Proposed features, as well as the associated rambling to get a clear objective in place before attempted implementation.

Colors
Proposal to allow for color constraints.

Reference

Miscellaneous essays, research pieces and other reference type material that may not directly discuss HTML Purifier.

DevNetwork Credits
Credits and links to DevNetwork forum topics.

Internal memos

Plaintext documents that are more for use by active developers of the code. They may be upgraded to HTML files or stay as TXT scratchpads.

Type Name Description
End-user Overview High level overview of the general control flow (mostly obsolete).
End-user Security Common security issues that may still arise (half-baked).
Proposal Filter levels Outlines details of projected configurable level of filtering.
Proposal Language Specification of I18N for error messages derived from MediaWiki (half-baked).
Proposal New directives Assorted configuration options that could be implemented.
Reference Loose vs.Strict Differences between HTML Strict and Transitional versions.
Reference Proprietary tags List of vendor-specific tags we may want to transform to W3C compliant markup.
Reference Strictness Short essay on how loose definition isn't really loose.
Reference XHTML 1.1 What we'd have to do to support XHTML 1.1.
Reference WHATWG How WHATWG plays into what we need to do.
$Id$