docs/index.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="description" content="Index to all HTML Purifier documentation." />
   7 <link rel="stylesheet" type="text/css" href="./style.css" />
   8
   9 <title>Documentation - HTML Purifier</title>
  10
  11 </head>
  12 <body>
  13
  14 <h1>Documentation</h1>
  15
  16 <p><strong><a href="http://htmlpurifier.org/">HTML Purifier</a></strong> has documentation for all types of people.
  17 Here is an index of all of them.</p>
  18
  19 <h2>End-user</h2>
  20 <p>End-user documentation that contains articles, tutorials and useful
  21 information for casual developers using HTML Purifier.</p>
  22
  23 <dl>
  24
  25 <dt><a href="enduser-id.html">IDs</a></dt>
  26 <dd>Explains various methods for allowing IDs in documents safely.</dd>
  27
  28 <dt><a href="enduser-youtube.html">Embedding YouTube videos</a></dt>
  29 <dd>Explains how to safely allow the embedding of flash from trusted sites.</dd>
  30
  31 <dt><a href="enduser-slow.html">Speeding up HTML Purifier</a></dt>
  32 <dd>Explains how to speed up HTML Purifier through caching or inbound filtering.</dd>
  33
  34 <dt><a href="enduser-utf8.html">UTF-8: The Secret of Character Encoding</a></dt>
  35 <dd>Describes the rationale for using UTF-8, the ramifications otherwise, and how to make the switch.</dd>
  36
  37 <dt><a href="enduser-tidy.html">Tidy</a></dt>
  38 <dd>Tutorial for tweaking HTML Purifier's Tidy-like behavior.</dd>
  39
  40 <dt><a href="enduser-customize.html">Customize</a></dt>
  41 <dd>Tutorial for customizing HTML Purifier's tag and attribute sets.</dd>
  42
  43 <dt><a href="enduser-uri-filter.html">URI Filters</a></dt>
  44 <dd>Tutorial for creating custom URI filters.</dd>
  45
  46 </dl>
  47
  48 <h2>Development</h2>
  49 <p>Developer documentation detailing code issues, roadmaps and project
  50 conventions.</p>
  51
  52 <dl>
  53
  54 <dt><a href="dev-progress.html">Implementation Progress</a></dt>
  55 <dd>Tables detailing HTML element and CSS property implementation coverage.</dd>
  56
  57 <dt><a href="dev-naming.html">Naming Conventions</a></dt>
  58 <dd>Defines class naming conventions.</dd>
  59
  60 <dt><a href="dev-optimization.html">Optimization</a></dt>
  61 <dd>Discusses possible methods of optimizing HTML Purifier.</dd>
  62
  63 <dt><a href="dev-flush.html">Flushing the Purifier</a></dt>
  64 <dd>Discusses when to flush HTML Purifier's various caches.</dd>
  65
  66 <dt><a href="dev-advanced-api.html">Advanced API</a></dt>
  67 <dd>Specification for HTML Purifier's advanced API for defining
  68 custom filtering behavior.</dd>
  69
  70 <dt><a href="dev-config-schema.html">Config Schema</a></dt>
  71 <dd>Describes config schema framework in HTML Purifier.</dd>
  72
  73 </dl>
  74
  75 <h2>Proposals</h2>
  76 <p>Proposed features, as well as the associated rambling to get a clear
  77 objective in place before attempted implementation.</p>
  78
  79 <dl>
  80 <dt><a href="proposal-colors.html">Colors</a></dt>
  81 <dd>Proposal to allow for color constraints.</dd>
  82 </dl>
  83
  84 <h2>Reference</h2>
  85 <p>Miscellaneous essays, research pieces and other reference type material
  86 that may not directly discuss HTML Purifier.</p>
  87
  88 <dl>
  89 <dt><a href="ref-devnetwork.html">DevNetwork Credits</a></dt>
  90 <dd>Credits and links to DevNetwork forum topics.</dd>
  91 </dl>
  92
  93 <h2>Internal memos</h2>
  94
  95 <p>Plaintext documents that are more for use by active developers of
  96 the code. They may be upgraded to HTML files or stay as TXT scratchpads.</p>
  97
  98 <table class="table">
  99
 100 <thead><tr>
 101     <th style="width:10%">Type</th>
 102     <th style="width:20%">Name</th>
 103     <th>Description</th>
 104 </tr></thead>
 105
 106 <tbody>
 107
 108 <tr>
 109     <td>End-user</td>
 110     <td><a href="enduser-overview.txt">Overview</a></td>
 111     <td>High level overview of the general control flow (mostly obsolete).</td>
 112 </tr>
 113
 114 <tr>
 115     <td>End-user</td>
 116     <td><a href="enduser-security.txt">Security</a></td>
 117     <td>Common security issues that may still arise (half-baked).</td>
 118 </tr>
 119
 120 <tr>
 121     <td>Development</td>
 122     <td><a href="dev-code-quality.txt">Code Quality Issues</a></td>
 123     <td>Enumerates code quality issues and places that need to be refactored.</td>
 124 </tr>
 125
 126 <tr>
 127     <td>Proposal</td>
 128     <td><a href="proposal-filter-levels.txt">Filter levels</a></td>
 129     <td>Outlines details of projected configurable level of filtering.</td>
 130 </tr>
 131
 132 <tr>
 133     <td>Proposal</td>
 134     <td><a href="proposal-language.txt">Language</a></td>
 135     <td>Specification of I18N for error messages derived from MediaWiki (half-baked).</td>
 136 </tr>
 137
 138 <tr>
 139     <td>Proposal</td>
 140     <td><a href="proposal-new-directives.txt">New directives</a></td>
 141     <td>Assorted configuration options that could be implemented.</td>
 142 </tr>
 143
 144 <tr>
 145     <td>Proposal</td>
 146     <td><a href="proposal-css-extraction.txt">CSS extraction</a></td>
 147     <td>Taking the inline CSS out of documents and into <code>style</code>.</td>
 148 </tr>
 149
 150 <tr>
 151     <td>Reference</td>
 152     <td><a href="ref-content-models.txt">Handling Content Model Changes</a></td>
 153     <td>Discusses how to tidy up content model changes using custom ChildDef classes.</td>
 154 </tr>
 155
 156 <tr>
 157     <td>Reference</td>
 158     <td><a href="ref-proprietary-tags.txt">Proprietary tags</a></td>
 159     <td>List of vendor-specific tags we may want to transform to W3C compliant markup.</td>
 160 </tr>
 161
 162 <tr>
 163     <td>Reference</td>
 164     <td><a href="ref-html-modularization.txt">Modularization of HTMLDefinition</a></td>
 165     <td>Provides a high-level overview of the concepts behind HTMLModules.</td>
 166 </tr>
 167
 168 <tr>
 169     <td>Reference</td>
 170     <td><a href="ref-whatwg.txt">WHATWG</a></td>
 171     <td>How WHATWG plays into what we need to do.</td>
 172 </tr>
 173
 174 </tbody>
 175
 176 </table>
 177
 178 </body>
 179 </html>
 180
 181 <!-- vim: et sw=4 sts=4 -->