0
0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2025-03-11 17:18:44 +00:00

Miscellaneous documentation updates.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1649 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
Edward Z. Yang 2008-04-04 22:15:14 +00:00
parent d467af6c4b
commit c216968087
7 changed files with 24 additions and 19 deletions

View File

@ -16,6 +16,11 @@
<div id="index">Return to the <a href="index.html">index</a>.</div> <div id="index">Return to the <a href="index.html">index</a>.</div>
<div id="home"><a href="http://htmlpurifier.org/">HTML Purifier</a> End-User Documentation</div> <div id="home"><a href="http://htmlpurifier.org/">HTML Purifier</a> End-User Documentation</div>
<p>
<strong>Warning:</strong> This document may be out-of-date. When in doubt,
consult the source code documentation.
</p>
<p>HTML Purifier currently natively supports only a subset of HTML's <p>HTML Purifier currently natively supports only a subset of HTML's
allowed elements, attributes, and behavior; specifically, this subset allowed elements, attributes, and behavior; specifically, this subset
is the set of elements that are safe for untrusted users to use. is the set of elements that are safe for untrusted users to use.

View File

@ -17,7 +17,6 @@ a lot of strtolower() calls, no legit casing
URI - multiple regular expressions; missing validation for parts (?) URI - multiple regular expressions; missing validation for parts (?)
CSS - parser doesn't accept advanced CSS (fringe) CSS - parser doesn't accept advanced CSS (fringe)
Number - constructor interface inconsistent with Integer Number - constructor interface inconsistent with Integer
ConfigSchema - redefinition is a mess
Strategy Strategy
FixNesting - cannot bubble nodes out of structures, duplicated checks FixNesting - cannot bubble nodes out of structures, duplicated checks
for special-case parent node for special-case parent node

View File

@ -23,7 +23,6 @@ that itch, put it here!</p>
<ul> <ul>
<li>Make Tokens Flyweights (may prove problematic, probably not worth it)</li> <li>Make Tokens Flyweights (may prove problematic, probably not worth it)</li>
<li>Rewrite regexps into PHP code</li> <li>Rewrite regexps into PHP code</li>
<li>Serialize the Definition object</li>
<li>Batch regexp validation (do as many per function call as possible)</li> <li>Batch regexp validation (do as many per function call as possible)</li>
<li>Parallelize strategies</li> <li>Parallelize strategies</li>
</ul> </ul>

View File

@ -34,6 +34,11 @@ thead th {text-align:left;padding:0.1em;background-color:#EEE;}
<div id="index">Return to the <a href="index.html">index</a>.</div> <div id="index">Return to the <a href="index.html">index</a>.</div>
<div id="home"><a href="http://htmlpurifier.org/">HTML Purifier</a> End-User Documentation</div> <div id="home"><a href="http://htmlpurifier.org/">HTML Purifier</a> End-User Documentation</div>
<p>
<strong>Warning:</strong> This table is kept for historical purposes and
is not being actively updated.
</p>
<h2>Key</h2> <h2>Key</h2>
<table cellspacing="0"><tbody> <table cellspacing="0"><tbody>
@ -148,7 +153,7 @@ thead th {text-align:left;padding:0.1em;background-color:#EEE;}
Depends on background-image</td></tr> Depends on background-image</td></tr>
<tr class="css1 impl-yes"><td>background-position</td><td>Depends on background-image</td></tr> <tr class="css1 impl-yes"><td>background-position</td><td>Depends on background-image</td></tr>
<tr class="danger impl-no"><td>cursor</td><td>Dangerous but fluffy</td></tr> <tr class="danger impl-no"><td>cursor</td><td>Dangerous but fluffy</td></tr>
<tr class="danger css1"><td>display</td><td>ENUM(...), Dangerous but interesting; <tr class="danger impl-yes"><td>display</td><td>ENUM(...), Dangerous but interesting;
will not implement list-item, run-in (Opera only) or table (no IE); will not implement list-item, run-in (Opera only) or table (no IE);
inline-block has incomplete IE6 support and requires -moz-inline-box inline-block has incomplete IE6 support and requires -moz-inline-box
for Mozilla. Unknown target milestone.</td></tr> for Mozilla. Unknown target milestone.</td></tr>
@ -167,7 +172,7 @@ thead th {text-align:left;padding:0.1em;background-color:#EEE;}
Mostly supported. Unknown target milestone.</td></tr> Mostly supported. Unknown target milestone.</td></tr>
<tr><td>page-break-inside</td><td>ENUM(avoid, auto), Opera only. Unknown target milestone.</td></tr> <tr><td>page-break-inside</td><td>ENUM(avoid, auto), Opera only. Unknown target milestone.</td></tr>
<tr class="impl-no"><td>quotes</td><td>May be dropped from CSS2, fairly useless for inline context</td></tr> <tr class="impl-no"><td>quotes</td><td>May be dropped from CSS2, fairly useless for inline context</td></tr>
<tr class="impl-no"><td>visibility</td><td>ENUM(visible, hidden, collapse), <tr class="danger impl-yes"><td>visibility</td><td>ENUM(visible, hidden, collapse),
Dangerous</td></tr> Dangerous</td></tr>
<tr class="css1 feature impl-partial"><td>white-space</td><td>ENUM(normal, pre, nowrap, pre-wrap, <tr class="css1 feature impl-partial"><td>white-space</td><td>ENUM(normal, pre, nowrap, pre-wrap,
pre-line), Spotty implementation: pre-line), Spotty implementation:

View File

@ -33,9 +33,9 @@
<pre>class HTMLPurifier_URIFilter_<strong>NameOfFilter</strong> extends HTMLPurifier_URIFilter <pre>class HTMLPurifier_URIFilter_<strong>NameOfFilter</strong> extends HTMLPurifier_URIFilter
{ {
var $name = '<strong>NameOfFilter</strong>'; public $name = '<strong>NameOfFilter</strong>';
function prepare($config) {} public function prepare($config) {}
function filter(&$uri, $config, &$context) {} public function filter(&$uri, $config, &$context) {}
}</pre> }</pre>
<p> <p>
@ -56,12 +56,12 @@
<pre>class HTMLPurifier_URI <pre>class HTMLPurifier_URI
{ {
var $scheme, $userinfo, $host, $port, $path, $query, $fragment; public $scheme, $userinfo, $host, $port, $path, $query, $fragment;
function HTMLPurifier_URI($scheme, $userinfo, $host, $port, $path, $query, $fragment); public function HTMLPurifier_URI($scheme, $userinfo, $host, $port, $path, $query, $fragment);
function toString(); public function toString();
function copy(); public function copy();
function getSchemeObj($config, &$context); public function getSchemeObj($config, &$context);
function validate($config, &$context); public function validate($config, &$context);
}</pre> }</pre>
<p> <p>
@ -138,8 +138,8 @@
<pre>class HTMLPurifier_URIFilter_ConvertIDNToPunycode extends HTMLPurifier_URIFilter <pre>class HTMLPurifier_URIFilter_ConvertIDNToPunycode extends HTMLPurifier_URIFilter
{ {
var $name = 'ConvertIDNToPunycode'; public $name = 'ConvertIDNToPunycode';
function filter(&$uri, $config, &$context) { public function filter(&$uri, $config, &$context) {
if (is_null($uri->host)) return true; if (is_null($uri->host)) return true;
if ($uri->host == utf8_decode($uri->host)) { if ($uri->host == utf8_decode($uri->host)) {
// is ASCII, abort // is ASCII, abort

View File

@ -116,7 +116,7 @@ the code. They may be upgraded to HTML files or stay as TXT scratchpads.</p>
<tr> <tr>
<td>Development</td> <td>Development</td>
<td><a href="enduser-code-quality.txt">Code Quality Issues</a></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> <td>Enumerates code quality issues and places that need to be refactored.</td>
</tr> </tr>

View File

@ -1,9 +1,6 @@
The Modularization of HTMLDefinition in HTML Purifier The Modularization of HTMLDefinition in HTML Purifier
Todo for XHTML 1.1 support <http://www.w3.org/TR/xhtml11/changes.html>
1. Support Ruby <http://www.w3.org/TR/2001/REC-ruby-20010531/>
HTML Purifier uses the modularization of XHTML HTML Purifier uses the modularization of XHTML
<http://www.w3.org/TR/xhtml-modularization/> to organize the internals <http://www.w3.org/TR/xhtml-modularization/> to organize the internals
of HTMLDefinition into a more manageable and extensible fashion. Rather of HTMLDefinition into a more manageable and extensible fashion. Rather