htmlpurifier/docs/index.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="description" content="Index to all HTML Purifier documentation." />
<link rel="stylesheet" type="text/css" href="./style.css" />

<title>Documentation - HTML Purifier</title>

</head>
<body>

<h1>Documentation</h1>

<p><strong><a href="http://htmlpurifier.org/">HTML Purifier</a></strong> has documentation for all types of people.
Here is an index of all of them.</p>

<h2>End-user</h2>
<p>End-user documentation that contains articles, tutorials and useful
information for casual developers using HTML Purifier.</p>

<dl>

<dt><a href="enduser-id.html">IDs</a></dt>
<dd>Explains various methods for allowing IDs in documents safely.</dd>

<dt><a href="enduser-youtube.html">Embedding YouTube videos</a></dt>
<dd>Explains how to safely allow the embedding of flash from trusted sites.</dd>

<dt><a href="enduser-slow.html">Speeding up HTML Purifier</a></dt>
<dd>Explains how to speed up HTML Purifier through caching or inbound filtering.</dd>

<dt><a href="enduser-utf8.html">UTF-8: The Secret of Character Encoding</a></dt>
<dd>Describes the rationale for using UTF-8, the ramifications otherwise, and how to make the switch.</dd>

<dt><a href="enduser-tidy.html">Tidy</a></dt>
<dd>Tutorial for tweaking HTML Purifier's Tidy-like behavior.</dd>

<dt><a href="enduser-customize.html">Customize</a></dt>
<dd>Tutorial for customizing HTML Purifier's tag and attribute sets.</dd>

<dt><a href="enduser-uri-filter.html">URI Filters</a></dt>
<dd>Tutorial for creating custom URI filters.</dd>

</dl>

<h2>Development</h2>
<p>Developer documentation detailing code issues, roadmaps and project
conventions.</p>

<dl>

<dt><a href="dev-progress.html">Implementation Progress</a></dt>
<dd>Tables detailing HTML element and CSS property implementation coverage.</dd>

<dt><a href="dev-naming.html">Naming Conventions</a></dt>
<dd>Defines class naming conventions.</dd>

<dt><a href="dev-optimization.html">Optimization</a></dt>
<dd>Discusses possible methods of optimizing HTML Purifier.</dd>

<dt><a href="dev-flush.html">Flushing the Purifier</a></dt>
<dd>Discusses when to flush HTML Purifier's various caches.</dd>

<dt><a href="dev-advanced-api.html">Advanced API</a></dt>
<dd>Specification for HTML Purifier's advanced API for defining
custom filtering behavior.</dd>

<dt><a href="dev-config-schema.html">Config Schema</a></dt>
<dd>Describes config schema framework in HTML Purifier.</dd>

</dl>

<h2>Proposals</h2>
<p>Proposed features, as well as the associated rambling to get a clear
objective in place before attempted implementation.</p>

<dl>
<dt><a href="proposal-colors.html">Colors</a></dt>
<dd>Proposal to allow for color constraints.</dd>
</dl>

<h2>Reference</h2>
<p>Miscellaneous essays, research pieces and other reference type material
that may not directly discuss HTML Purifier.</p>

<dl>
<dt><a href="ref-devnetwork.html">DevNetwork Credits</a></dt>
<dd>Credits and links to DevNetwork forum topics.</dd>
</dl>

<h2>Internal memos</h2>

<p>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.</p>

<table class="table">

<thead><tr>
    <th width="10%">Type</th>
    <th width="20%">Name</th>
    <th>Description</th>
</tr></thead>

<tbody>

<tr>
    <td>End-user</td>
    <td><a href="enduser-overview.txt">Overview</a></td>
    <td>High level overview of the general control flow (mostly obsolete).</td>
</tr>

<tr>
    <td>End-user</td>
    <td><a href="enduser-security.txt">Security</a></td>
    <td>Common security issues that may still arise (half-baked).</td>
</tr>

<tr>
    <td>Development</td>
    <td><a href="dev-code-quality.txt">Code Quality Issues</a></td>
    <td>Enumerates code quality issues and places that need to be refactored.</td>
</tr>

<tr>
    <td>Proposal</td>
    <td><a href="proposal-filter-levels.txt">Filter levels</a></td>
    <td>Outlines details of projected configurable level of filtering.</td>
</tr>

<tr>
    <td>Proposal</td>
    <td><a href="proposal-language.txt">Language</a></td>
    <td>Specification of I18N for error messages derived from MediaWiki (half-baked).</td>
</tr>

<tr>
    <td>Proposal</td>
    <td><a href="proposal-new-directives.txt">New directives</a></td>
    <td>Assorted configuration options that could be implemented.</td>
</tr>

<tr>
    <td>Proposal</td>
    <td><a href="proposal-css-extraction.txt">CSS extraction</a></td>
    <td>Taking the inline CSS out of documents and into <code>style</code>.</td>
</tr>

<tr>
    <td>Reference</td>
    <td><a href="ref-content-models.txt">Handling Content Model Changes</a></td>
    <td>Discusses how to tidy up content model changes using custom ChildDef classes.</td>
</tr>

<tr>
    <td>Reference</td>
    <td><a href="ref-proprietary-tags.txt">Proprietary tags</a></td>
    <td>List of vendor-specific tags we may want to transform to W3C compliant markup.</td>
</tr>

<tr>
    <td>Reference</td>
    <td><a href="ref-html-modularization.txt">Modularization of HTMLDefinition</a></td>
    <td>Provides a high-level overview of the concepts behind HTMLModules.</td>
</tr>

<tr>
    <td>Reference</td>
    <td><a href="ref-whatwg.txt">WHATWG</a></td>
    <td>How WHATWG plays into what we need to do.</td>
</tr>

</tbody>

</table>

</body>
</html>
[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`<?xml version="1.0" encoding="UTF-8"?>`
			`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"`
			`"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">`
			`<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>`
			`<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />`
[1.2.0] Converted enduser-id.txt to HTML. Fixed summary in index. Added extra style .subsubtitle git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@539 48356398-32a2-884e-a903-53898d9a118a 2006-11-20 02:47:00 +00:00			`<meta name="description" content="Index to all HTML Purifier documentation." />`
[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`<link rel="stylesheet" type="text/css" href="./style.css" />`

			`<title>Documentation - HTML Purifier</title>`

			`</head>`
			`<body>`

			`<h1>Documentation</h1>`

Update URLs from hp.jpsband.org to htmlpurifier.org git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@992 48356398-32a2-884e-a903-53898d9a118a 2007-04-22 22:22:48 +00:00			`<p><strong><a href="http://htmlpurifier.org/">HTML Purifier</a></strong> has documentation for all types of people.`
[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`Here is an index of all of them.</p>`

			`<h2>End-user</h2>`
			`<p>End-user documentation that contains articles, tutorials and useful`
			`information for casual developers using HTML Purifier.</p>`

[1.2.0] Converted enduser-id.txt to HTML. Fixed summary in index. Added extra style .subsubtitle git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@539 48356398-32a2-884e-a903-53898d9a118a 2006-11-20 02:47:00 +00:00			`<dl>`

			`<dt><a href="enduser-id.html">IDs</a></dt>`
Update index with YouTube link. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@613 48356398-32a2-884e-a903-53898d9a118a 2006-12-20 03:03:03 +00:00			`<dd>Explains various methods for allowing IDs in documents safely.</dd>`

			`<dt><a href="enduser-youtube.html">Embedding YouTube videos</a></dt>`
			`<dd>Explains how to safely allow the embedding of flash from trusted sites.</dd>`
[1.2.0] Converted enduser-id.txt to HTML. Fixed summary in index. Added extra style .subsubtitle git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@539 48356398-32a2-884e-a903-53898d9a118a 2006-11-20 02:47:00 +00:00
[1.3.3] - Move SLOW to docs/enduser-slow.html and add code examples - Update README and WYSIWYG - Add warning to HTMLPurifier.func.php about naming similarities git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@635 48356398-32a2-884e-a903-53898d9a118a 2007-01-11 22:28:44 +00:00			`<dt><a href="enduser-slow.html">Speeding up HTML Purifier</a></dt>`
			`<dd>Explains how to speed up HTML Purifier through caching or inbound filtering.</dd>`

Update UTF-8 title. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@735 48356398-32a2-884e-a903-53898d9a118a 2007-02-13 03:09:34 +00:00			`<dt><a href="enduser-utf8.html">UTF-8: The Secret of Character Encoding</a></dt>`
[1.4.0] - Added %Core.EscapeNonASCIICharacters to workaround %Core.Encoding misbehavior - Add "All Tests" to test runner title and reorder subfile names - Specific file is now called with ?f= - Link to UTF-8 docs, even though they're not done - 1000th unit test passed! W00t! (that's a third as many as SimpleTest has for itself.) git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@658 48356398-32a2-884e-a903-53898d9a118a 2007-01-19 03:54:55 +00:00			`<dd>Describes the rationale for using UTF-8, the ramifications otherwise, and how to make the switch.</dd>`

[1.7.0] Add documentation for the Tidy functionality - Make specifying the child property for ElementDef unnecessary when overloading content_model or content_model_type - Add necessary includes to Tidy module files - Move div@align fix to Tidy_Proprietary - Future proof attrTransform.php by setting doctype to strict git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1071 48356398-32a2-884e-a903-53898d9a118a 2007-05-20 02:12:01 +00:00			`<dt><a href="enduser-tidy.html">Tidy</a></dt>`
			`<dd>Tutorial for tweaking HTML Purifier's Tidy-like behavior.</dd>`

[1.7.0] Change ->Revision member variable to a legit configuration directive. Start writing tutorial for customization. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1171 48356398-32a2-884e-a903-53898d9a118a 2007-06-20 02:43:43 +00:00			`<dt><a href="enduser-customize.html">Customize</a></dt>`
			`<dd>Tutorial for customizing HTML Purifier's tag and attribute sets.</dd>`

[2.1.0] Add tutorial for creating URI Filters - Update NEWS git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1348 48356398-32a2-884e-a903-53898d9a118a 2007-08-02 23:34:30 +00:00			`<dt><a href="enduser-uri-filter.html">URI Filters</a></dt>`
			`<dd>Tutorial for creating custom URI filters.</dd>`

[1.2.0] Converted enduser-id.txt to HTML. Fixed summary in index. Added extra style .subsubtitle git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@539 48356398-32a2-884e-a903-53898d9a118a 2006-11-20 02:47:00 +00:00			`</dl>`

[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`<h2>Development</h2>`
			`<p>Developer documentation detailing code issues, roadmaps and project`
			`conventions.</p>`

			`<dl>`
[1.2.0] - Converted dev-naming and dev-optimization to HTML - Fixed up failed validation in a few of the other HTML files git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@538 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:56:50 +00:00
[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`<dt><a href="dev-progress.html">Implementation Progress</a></dt>`
			`<dd>Tables detailing HTML element and CSS property implementation coverage.</dd>`
[1.2.0] - Converted dev-naming and dev-optimization to HTML - Fixed up failed validation in a few of the other HTML files git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@538 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:56:50 +00:00
			`<dt><a href="dev-naming.html">Naming Conventions</a></dt>`
			`<dd>Defines class naming conventions.</dd>`

			`<dt><a href="dev-optimization.html">Optimization</a></dt>`
			`<dd>Discusses possible methods of optimizing HTML Purifier.</dd>`

[3.1.0] Improve maintenance script documentation git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1644 48356398-32a2-884e-a903-53898d9a118a 2008-04-03 22:39:50 +00:00			`<dt><a href="dev-flush.html">Flushing the Purifier</a></dt>`
			`<dd>Discusses when to flush HTML Purifier's various caches.</dd>`

Update advanced API docs, link to it from index. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@808 48356398-32a2-884e-a903-53898d9a118a 2007-03-14 04:56:44 +00:00			`<dt><a href="dev-advanced-api.html">Advanced API</a></dt>`
[3.1.0] Document Config Schema, also, fix bug with null defaults git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1651 48356398-32a2-884e-a903-53898d9a118a 2008-04-05 18:37:08 +00:00			`<dd>Specification for HTML Purifier's advanced API for defining`
Update advanced API docs, link to it from index. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@808 48356398-32a2-884e-a903-53898d9a118a 2007-03-14 04:56:44 +00:00			`custom filtering behavior.</dd>`

[3.1.0] Document Config Schema, also, fix bug with null defaults git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1651 48356398-32a2-884e-a903-53898d9a118a 2008-04-05 18:37:08 +00:00			`<dt><a href="dev-config-schema.html">Config Schema</a></dt>`
			`<dd>Describes config schema framework in HTML Purifier.</dd>`

[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`</dl>`

			`<h2>Proposals</h2>`
			`<p>Proposed features, as well as the associated rambling to get a clear`
			`objective in place before attempted implementation.</p>`

			`<dl>`
			`<dt><a href="proposal-colors.html">Colors</a></dt>`
			`<dd>Proposal to allow for color constraints.</dd>`
			`</dl>`

			`<h2>Reference</h2>`
			`<p>Miscellaneous essays, research pieces and other reference type material`
			`that may not directly discuss HTML Purifier.</p>`

			`<dl>`
			`<dt><a href="ref-devnetwork.html">DevNetwork Credits</a></dt>`
			`<dd>Credits and links to DevNetwork forum topics.</dd>`
			`</dl>`

- Add more documentation about proprietary tags - Link to all text memos git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@559 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 00:45:43 +00:00			`<h2>Internal memos</h2>`

			`<p>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.</p>`

			`<table class="table">`

			`<thead><tr>`
			`<th width="10%">Type</th>`
			`<th width="20%">Name</th>`
			`<th>Description</th>`
			`</tr></thead>`

			`<tbody>`

			`<tr>`
			`<td>End-user</td>`
			`<td><a href="enduser-overview.txt">Overview</a></td>`
			`<td>High level overview of the general control flow (mostly obsolete).</td>`
			`</tr>`

			`<tr>`
			`<td>End-user</td>`
			`<td><a href="enduser-security.txt">Security</a></td>`
			`<td>Common security issues that may still arise (half-baked).</td>`
			`</tr>`

Downgrade code-quality back to a txt scratchpad, add more items for AttrDef git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1010 48356398-32a2-884e-a903-53898d9a118a 2007-05-03 03:15:29 +00:00			`<tr>`
			`<td>Development</td>`
Miscellaneous documentation updates. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1649 48356398-32a2-884e-a903-53898d9a118a 2008-04-04 22:15:14 +00:00			`<td><a href="dev-code-quality.txt">Code Quality Issues</a></td>`
Downgrade code-quality back to a txt scratchpad, add more items for AttrDef git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1010 48356398-32a2-884e-a903-53898d9a118a 2007-05-03 03:15:29 +00:00			`<td>Enumerates code quality issues and places that need to be refactored.</td>`
			`</tr>`

- Add more documentation about proprietary tags - Link to all text memos git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@559 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 00:45:43 +00:00			`<tr>`
			`<td>Proposal</td>`
			`<td><a href="proposal-filter-levels.txt">Filter levels</a></td>`
			`<td>Outlines details of projected configurable level of filtering.</td>`
			`</tr>`

			`<tr>`
			`<td>Proposal</td>`
			`<td><a href="proposal-language.txt">Language</a></td>`
			`<td>Specification of I18N for error messages derived from MediaWiki (half-baked).</td>`
			`</tr>`

			`<tr>`
			`<td>Proposal</td>`
			`<td><a href="proposal-new-directives.txt">New directives</a></td>`
			`<td>Assorted configuration options that could be implemented.</td>`
			`</tr>`

Update index. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1595 48356398-32a2-884e-a903-53898d9a118a 2008-03-04 02:02:02 +00:00			`<tr>`
			`<td>Proposal</td>`
			`<td><a href="proposal-css-extraction.txt">CSS extraction</a></td>`
			`<td>Taking the inline CSS out of documents and into <code>style</code>.</td>`
			`</tr>`

- Add more documentation about proprietary tags - Link to all text memos git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@559 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 00:45:43 +00:00			`<tr>`
			`<td>Reference</td>`
Repair links to renamed documentation; fix typo in ref-html-modularization.txt git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1127 48356398-32a2-884e-a903-53898d9a118a 2007-06-08 01:52:42 +00:00			`<td><a href="ref-content-models.txt">Handling Content Model Changes</a></td>`
			`<td>Discusses how to tidy up content model changes using custom ChildDef classes.</td>`
- Add more documentation about proprietary tags - Link to all text memos git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@559 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 00:45:43 +00:00			`</tr>`

			`<tr>`
			`<td>Reference</td>`
			`<td><a href="ref-proprietary-tags.txt">Proprietary tags</a></td>`
			`<td>List of vendor-specific tags we may want to transform to W3C compliant markup.</td>`
			`</tr>`

[1.3.0] Add some forward thinking documents. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@572 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 22:33:07 +00:00			`<tr>`
			`<td>Reference</td>`
Repair links to renamed documentation; fix typo in ref-html-modularization.txt git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1127 48356398-32a2-884e-a903-53898d9a118a 2007-06-08 01:52:42 +00:00			`<td><a href="ref-html-modularization.txt">Modularization of HTMLDefinition</a></td>`
			`<td>Provides a high-level overview of the concepts behind HTMLModules.</td>`
[1.3.0] Add some forward thinking documents. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@572 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 22:33:07 +00:00			`</tr>`

			`<tr>`
			`<td>Reference</td>`
			`<td><a href="ref-whatwg.txt">WHATWG</a></td>`
			`<td>How WHATWG plays into what we need to do.</td>`
			`</tr>`

- Add more documentation about proprietary tags - Link to all text memos git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@559 48356398-32a2-884e-a903-53898d9a118a 2006-11-23 00:45:43 +00:00			`</tbody>`

			`</table>`

[1.2.0] Update documentation infrastructure. - Add filings and link to index - Update descriptions - Add an index git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@535 48356398-32a2-884e-a903-53898d9a118a 2006-11-19 04:31:48 +00:00			`</body>`
Remove trailing ?> in PHP library files, add trailing newlines to all other files. git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1253 48356398-32a2-884e-a903-53898d9a118a 2007-06-27 13:58:32 +00:00			`</html>`