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

[1.1.1] Update documentation and TODO.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@436 48356398-32a2-884e-a903-53898d9a118a
This commit is contained in:
Edward Z. Yang 2006-09-17 21:59:40 +00:00
parent 7a6de55f76
commit b93892a3b6
5 changed files with 14 additions and 20 deletions

3
TODO
View File

@ -9,6 +9,7 @@ Ongoing
- Additional support for poorly written HTML - Additional support for poorly written HTML
- Implement all non-essential attribute transforms - Implement all non-essential attribute transforms
- Microsoft Word HTML cleaning (i.e. MsoNormal) - Microsoft Word HTML cleaning (i.e. MsoNormal)
- Error logging for filtering and cleanup procedures
1.3 release 1.3 release
- Formatters for plaintext - Formatters for plaintext
@ -41,6 +42,8 @@ Unknown release (on a scratch-an-itch basis)
- Pretty-printing HTML (adds dependency of Generator to HTMLDefinition) - Pretty-printing HTML (adds dependency of Generator to HTMLDefinition)
- Non-lossy dumb alternate character encoding transformations, achieved by - Non-lossy dumb alternate character encoding transformations, achieved by
numerically encoding all non-ASCII characters numerically encoding all non-ASCII characters
- Preservation of indentation in tables (tricky since the contents can be
shuffled around)
Wontfix Wontfix
- Non-lossy smart alternate character encoding transformations - Non-lossy smart alternate character encoding transformations

View File

@ -3,10 +3,10 @@
/** /**
* Internal data-structure used in attribute validation to accumulate state. * Internal data-structure used in attribute validation to accumulate state.
* *
* All it is is a data-structure that holds objects that accumulate state, like * This is a data-structure that holds objects that accumulate state, like
* HTMLPurifier_IDAccumulator. * HTMLPurifier_IDAccumulator. It's better than using globals!
* *
* @param Many functions that accept this object have it as a mandatory * @note Many functions that accept this object have it as a mandatory
* parameter, even when there is no use for it. Though this is * parameter, even when there is no use for it. Though this is
* for the same reasons as why HTMLPurifier_Config is a mandatory * for the same reasons as why HTMLPurifier_Config is a mandatory
* parameter, it is also because you cannot assign a default value * parameter, it is also because you cannot assign a default value

View File

@ -2,7 +2,6 @@
/** /**
* Configuration definition, defines directives and their defaults. * Configuration definition, defines directives and their defaults.
* @todo Build documentation generation capabilities.
* @todo The ability to define things multiple times is confusing and should * @todo The ability to define things multiple times is confusing and should
* be factored out to its own function named registerDependency() or * be factored out to its own function named registerDependency() or
* addNote(), where only the namespace.name and an extra descriptions * addNote(), where only the namespace.name and an extra descriptions
@ -39,7 +38,6 @@ class HTMLPurifier_ConfigSchema {
/** /**
* Lookup table of allowed types. * Lookup table of allowed types.
* @todo Add descriptions
*/ */
var $types = array( var $types = array(
'string' => 'String', 'string' => 'String',
@ -82,9 +80,6 @@ class HTMLPurifier_ConfigSchema {
/** /**
* Defines a directive for configuration * Defines a directive for configuration
* @warning Will fail of directive's namespace is defined * @warning Will fail of directive's namespace is defined
* @todo Collect information on description and allow redefinition
* so that multiple files can register a dependency on a
* configuration directive.
* @param $namespace Namespace the directive is in * @param $namespace Namespace the directive is in
* @param $name Key of directive * @param $name Key of directive
* @param $default Default value of directive * @param $default Default value of directive

View File

@ -88,7 +88,6 @@ class HTMLPurifier_EntityParser
* either index 1, 2 or 3 set with a hex value, dec value, * either index 1, 2 or 3 set with a hex value, dec value,
* or string (respectively). * or string (respectively).
* @returns Replacement string. * @returns Replacement string.
* @todo Implement string translations
*/ */
// +----------+----------+----------+----------+ // +----------+----------+----------+----------+

View File

@ -12,15 +12,12 @@ require_once 'HTMLPurifier/TokenFactory.php';
* documents, it performs twenty times faster than * documents, it performs twenty times faster than
* HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5. * HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5.
* *
* @notice * @note Any empty elements will have empty tokens associated with them, even if
* Any empty elements will have empty tokens associated with them, even if
* this is prohibited by the spec. This is cannot be fixed until the spec * this is prohibited by the spec. This is cannot be fixed until the spec
* comes into play. * comes into play.
* *
* @todo Determine DOM's entity parsing behavior, point to local entity files * @note PHP's DOM extension does not actually parse any entities, we use
* if necessary. * our own function to do that.
* @todo Make div access less fragile, and refrain from preprocessing when
* HTML tag and friends are already present.
*/ */
class HTMLPurifier_Lexer_DOMLex extends HTMLPurifier_Lexer class HTMLPurifier_Lexer_DOMLex extends HTMLPurifier_Lexer