TODO

   1
   2 TODO List
   3
   4 = KEY ====================
   5     # Flagship
   6     - Regular
   7     ? Maybe I'll Do It
   8 ==========================
   9
  10 If no interest is expressed for a feature that may required a considerable
  11 amount of effort to implement, it may get endlessly delayed. Do not be
  12 afraid to cast your vote for the next feature to be implemented!
  13
  14
  15 UPCOMING RELEASE
  16 ----------------
  17
  18 IMPORTANT
  19  - Release candidate, because of the major changes
  20  - Move utility classes for ConfigSchema into HTML Purifier itself: they're
  21    that important
  22  - Allow unit tests to be run w/o PHPT
  23
  24 DOCUMENTATION
  25  - Document new ConfigSchema setup and format; dev-includes.txt is a base
  26    but we need it in HTML
  27  - Update French translation of README
  28  - Document which scripts need to be called when a change is made
  29
  30 IMPORTANT FEATURES
  31  - Get everything into configuration objects (filters, I'm looking at you)
  32  - Factor generate-schema-cache.php into a class, so that the maintenance script
  33    is as small as possible
  34  - Factor out command line parser into its own class, and unit test it
  35  - Optimize ConfigSchema by only caching things necessary for runtime
  36
  37 CONFIGDOC
  38  - Properly integrate new ConfigSchema system into configdoc (Configdoc
  39    should directly read the configuration files, or at the very least should
  40    not use static functions)
  41  - Reduce code duplication between Serializer and Adapter/ReverseAdapter
  42    (we probably want to use ReverseAdapter for the long haul)
  43  - Have configdoc use version and deprecated information (hide deprecated
  44    info, for example)
  45  - Implement file sniffing for configdoc, so we can easily figure out
  46    which files use what configuration
  47
  48 IF IT AIN'T BROKE...
  49  - Rename merge-library.php script
  50  - Create "super" script which performs all regeneration actions
  51  - Remove all includes from unit tests, and remove blanks/ folder and generation
  52  - Simplify merge library script by removing recursion? (or other things)
  53  - Perhaps replace types with integer identifiers in ConfigSchema? (would be
  54    smaller, but not by much).
  55
  56 NICE FEATURES
  57  - Factor demo.php into a set of Printer classes, and then create a stub
  58    file for users here (inside the actual HTML Purifier library)
  59  - Support exporting configuration, so users can easily tweak settings
  60    in the demo, and then copy-paste into their own setup
  61
  62
  63 FUTURE VERSIONS
  64 ---------------
  65
  66 3.2 release [Error'ed]
  67  # Error logging for filtering/cleanup procedures
  68  - XSS-attempt detection
  69
  70 3.3 release [Do What I Mean, Not What I Say]
  71  # Additional support for poorly written HTML
  72     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
  73     - Friendly strict handling of <address> (block -> <br>)
  74  - Remove redundant tags, ex. <u><u>Underlined</u></u>. Implementation notes:
  75     1. Analyzing which tags to remove duplicants
  76     2. Ensure attributes are merged into the parent tag
  77     3. Extend the tag exclusion system to specify whether or not the
  78     contents should be dropped or not (currently, there's code that could do
  79     something like this if it didn't drop the inner text too.)
  80  - Remove <span> tags that don't do anything (no attributes)
  81  - Remove empty inline tags<i></i>
  82  - Append something to duplicate IDs so they're still usable (impl. note: the
  83    dupe detector would also need to detect the suffix as well)
  84  - Externalize inline CSS to promote clean HTML
  85
  86 3.4 release [It's All About Trust] (floating)
  87  # Implement untrusted, dangerous elements/attributes
  88  # Implement IDREF support (harder than it seems, since you cannot have
  89    IDREFs to non-existent IDs)
  90  # Frameset XHTML 1.0 and HTML 4.01 doctypes
  91
  92 4.0 release [Beyond HTML]
  93  # Legit token based CSS parsing (will require revamping almost every
  94    AttrDef class). Probably will use CSSTidy class
  95  # More control over allowed CSS properties (maybe modularize it in the
  96    same fashion!)
  97  # HTML 5 support
  98  - Standardize token armor for all areas of processing
  99  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
 100    Also, enable disabling of directionality
 101  - Table of Contents generation (XHTML Compiler might be reusable)
 102
 103 5.0 release [To XML and Beyond]
 104  - Extended HTML capabilities based on namespacing and tag transforms (COMPLEX)
 105     - Hooks for adding custom processors to custom namespaced tags and
 106       attributes, offer default implementation
 107     - Lots of documentation and samples
 108
 109 Ongoing
 110  - More refactoring to take advantage of PHP5's facilities
 111  - Lots of profiling, make it faster!
 112  - Plugins for major CMSes (COMPLEX)
 113     - phpBB
 114     - more! (look for ones that use WYSIWYGs)
 115  - Complete basic smoketests
 116
 117 AutoFormat
 118  - Smileys
 119  - Syntax highlighting with <pre> and possibly <?php
 120  - Look at http://drupal.org/project/Modules/category/63 for ideas
 121
 122 Unknown release (on a scratch-an-itch basis)
 123  # CHMOD install script for PEAR installs
 124  ? Have 'lang' attribute be checked against official lists, achieved by
 125    encoding all characters that have string entity equivalents
 126  - Abstract ChildDef_BlockQuote to work with all elements that only
 127    allow blocks in them, required or optional
 128  - Reorganize Unit Tests
 129  - Advanced URI filtering schemes (see docs/proposal-new-directives.txt)
 130  - Implement lenient <ruby> child validation
 131  - Explain how to use HTML Purifier in non-PHP languages / create
 132    a simple command line stub (or complicated?)
 133  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
 134  - Automatically add non-breaking spaces to empty table cells when
 135    empty-cells:show is applied to have compatibility with Internet Explorer
 136  - Distinguish between default settings and explicitly set settings, so
 137    configurations can be merged
 138  - Nested configuration namespaces
 139  - Allow scoped="scoped" attribute in <style> tags; may be troublesome
 140    because regular CSS has no way of uniquely identifying nodes, so we'd
 141    have to generate IDs
 142  - Time PHPT tests
 143
 144 Requested
 145
 146 Wontfix
 147  - Non-lossy smart alternate character encoding transformations (unless
 148    patch provided)
 149  - Pretty-printing HTML: users can use Tidy on the output on entire page
 150  - Native content compression, whitespace stripping (don't rely on Tidy, make
 151    sure we don't remove from <pre> or related tags): use gzip if this is
 152    really important