mirrors/htmlpurifier
0
0
Fork 0
mirror of https://github.com/ezyang/htmlpurifier.git synced 2024-12-23 00:41:52 +00:00
Code Releases Activity

Add notes on "mode" to advanced API.

Browse Source 
git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@801 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
Edward Z. Yang 2007-03-12 03:53:09 +00:00
parent 918081b372
commit 72f1984229
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/dev-advanced-api.html
View File

@ -27,7 +27,8 @@ filtersets: therefore, users must be able to define their own sets of
<dd><ul> <dd><ul>
<li>Doctype</li> <li>Doctype</li>
<li>Filtersets: Rich / Plain / Full ...</li> <li>Filtersets: Rich / Plain / Full ...</li>
<li>Collections: Safe / Unsafe / Leniency(?) / Corrections(?) [advanced]</li> <li>Mode: Lenient / Correctional</li>
<li>Collections (?): Safe / Unsafe</li>
<li>Modules / Tags / Attributes</li> <li>Modules / Tags / Attributes</li>
</ul></dd> </ul></dd>
<dt>Customize</dt> <dt>Customize</dt>
@ -88,6 +89,31 @@ other users to use.</p>
<pre>$config->set('HTML', 'Filterset', 'Rich');</pre> <pre>$config->set('HTML', 'Filterset', 'Rich');</pre>
<h3>Selecting Mode</h3>
<p>Within filtersets, there are various <strong>modes</strong> of operation.
These indicate variant behaviors that, while not strictly changing the
allowed set of elements and attributes, will definitely affect the output.
Currently, we have two modes, which may be used together:</p>
<dl>
<dt>Lenient</dt>
<dd>Deprecated elements and attributes will be transformed into
standards-compliant alternatives when explicitly disallowed. For
example, in the XHTML 1.0 Strict doctype, a <code>center</code>
tag would be turned into a <code>div</code> with the CSS property
<code>text-align:center;</code>, but in XHTML 1.0 Transitional
the tag would be preserved. This mode is on by default.</dd>
<dt>Correctional</dt>
<dd>Deprecated elements and attributes will be transformed into
standards-compliant alternatives whenever possible. Referring
back to the previous example, the <code>center</code> tag would
be transformed in both cases. However, tags without a
reasonable standards-compliant alternative will be preserved
in their form. This mode is on by default. It may have
various levels of operation.</dd>
</dl>
<h3>Selecting Modules / Tags / Attributes</h3> <h3>Selecting Modules / Tags / Attributes</h3>
<p>If this cookie cutter approach doesn't appeal to a user, they may <p>If this cookie cutter approach doesn't appeal to a user, they may