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 </dl>
  38
  39 <h2>Development</h2>
  40 <p>Developer documentation detailing code issues, roadmaps and project
  41 conventions.</p>
  42
  43 <dl>
  44
  45 <dt><a href="dev-progress.html">Implementation Progress</a></dt>
  46 <dd>Tables detailing HTML element and CSS property implementation coverage.</dd>
  47
  48 <dt><a href="dev-naming.html">Naming Conventions</a></dt>
  49 <dd>Defines class naming conventions.</dd>
  50
  51 <dt><a href="dev-optimization.html">Optimization</a></dt>
  52 <dd>Discusses possible methods of optimizing HTML Purifier.</dd>
  53
  54 <dt><a href="dev-advanced-api.html">Advanced API</a></dt>
  55 <dd>Functional specification for HTML Purifier's advanced API for defining
  56 custom filtering behavior.</dd>
  57
  58 </dl>
  59
  60 <h2>Proposals</h2>
  61 <p>Proposed features, as well as the associated rambling to get a clear
  62 objective in place before attempted implementation.</p>
  63
  64 <dl>
  65 <dt><a href="proposal-colors.html">Colors</a></dt>
  66 <dd>Proposal to allow for color constraints.</dd>
  67 </dl>
  68
  69 <h2>Reference</h2>
  70 <p>Miscellaneous essays, research pieces and other reference type material
  71 that may not directly discuss HTML Purifier.</p>
  72
  73 <dl>
  74 <dt><a href="ref-devnetwork.html">DevNetwork Credits</a></dt>
  75 <dd>Credits and links to DevNetwork forum topics.</dd>
  76 </dl>
  77
  78 <h2>Internal memos</h2>
  79
  80 <p>Plaintext documents that are more for use by active developers of
  81 the code. They may be upgraded to HTML files or stay as TXT scratchpads.</p>
  82
  83 <table class="table">
  84
  85 <thead><tr>
  86     <th width="10%">Type</th>
  87     <th width="20%">Name</th>
  88     <th>Description</th>
  89 </tr></thead>
  90
  91 <tbody>
  92
  93 <tr>
  94     <td>End-user</td>
  95     <td><a href="enduser-overview.txt">Overview</a></td>
  96     <td>High level overview of the general control flow (mostly obsolete).</td>
  97 </tr>
  98
  99 <tr>
 100     <td>End-user</td>
 101     <td><a href="enduser-security.txt">Security</a></td>
 102     <td>Common security issues that may still arise (half-baked).</td>
 103 </tr>
 104
 105 <tr>
 106     <td>Development</td>
 107     <td><a href="enduser-code-quality.txt">Code Quality Issues</a></td>
 108     <td>Enumerates code quality issues and places that need to be refactored.</td>
 109 </tr>
 110
 111 <tr>
 112     <td>Proposal</td>
 113     <td><a href="proposal-filter-levels.txt">Filter levels</a></td>
 114     <td>Outlines details of projected configurable level of filtering.</td>
 115 </tr>
 116
 117 <tr>
 118     <td>Proposal</td>
 119     <td><a href="proposal-language.txt">Language</a></td>
 120     <td>Specification of I18N for error messages derived from MediaWiki (half-baked).</td>
 121 </tr>
 122
 123 <tr>
 124     <td>Proposal</td>
 125     <td><a href="proposal-new-directives.txt">New directives</a></td>
 126     <td>Assorted configuration options that could be implemented.</td>
 127 </tr>
 128
 129 <tr>
 130     <td>Reference</td>
 131     <td><a href="ref-loose-vs-strict.txt">Loose vs.Strict</a></td>
 132     <td>Differences between HTML Strict and Transitional versions.</td>
 133 </tr>
 134
 135 <tr>
 136     <td>Reference</td>
 137     <td><a href="ref-proprietary-tags.txt">Proprietary tags</a></td>
 138     <td>List of vendor-specific tags we may want to transform to W3C compliant markup.</td>
 139 </tr>
 140
 141 <tr>
 142     <td>Reference</td>
 143     <td><a href="ref-strictness.txt">Strictness</a></td>
 144     <td>Short essay on how loose definition isn't really loose.</td>
 145 </tr>
 146
 147 <tr>
 148     <td>Reference</td>
 149     <td><a href="ref-xhtml-1.1.txt">XHTML 1.1</a></td>
 150     <td>What we'd have to do to support XHTML 1.1.</td>
 151 </tr>
 152
 153 <tr>
 154     <td>Reference</td>
 155     <td><a href="ref-whatwg.txt">WHATWG</a></td>
 156     <td>How WHATWG plays into what we need to do.</td>
 157 </tr>
 158
 159 </tbody>
 160
 161 </table>
 162
 163 <div id="version">$Id$</div>
 164 </body>
 165 </html>