[3.1.0] Maintenance scripts emit and honor proper exit codes
[htmlpurifier.git] / TODO
blob097a7cfb083d20f8a18daa2635c725af689b2205
2 TODO List
4 = KEY ====================
5     # Flagship
6     - Regular
7     ? Maybe I'll Do It
8 ==========================
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!
15 UPCOMING RELEASE
16 ----------------
18 IMPORTANT
19  - Release candidate, because of the major changes
21 DOCUMENTATION
22  - Document new ConfigSchema setup and format; dev-includes.txt is a base
23    but we need it in HTML
24  - Update French translation of README
25  - Document which scripts need to be called when a change is made
27 IMPORTANT FEATURES
28  - Get everything into configuration objects (filters, I'm looking at you)
29  - Factor out command line parser into its own class, and unit test it
30  - Verbose mode for webtester that includes transcript from command line
31  - Command line maintenance scripts must complain with exit(1) if there are
32    fatal errors
33  - Emit notices when aliases are used (allow muting these errors)
35 CONFIGDOC
36  - Properly integrate new ConfigSchema system into configdoc. DESCRIPTIONS
37    ARE CURRENTLY BROKEN AND NEED TO BE FIXED!!! (Configdoc
38    should directly read the configuration files, or at the very least should
39    not use static functions)
40  - Have configdoc use version and deprecated information (hide deprecated
41    info, for example)
42  - Implement source code sniffing for configdoc, so we can easily figure out
43    which files use what configuration (we'll rely on the $config convention)
45 NICE FEATURES
46  - Factor demo.php into a set of Printer classes, and then create a stub
47    file for users here (inside the actual HTML Purifier library)
48  - Support exporting configuration, so users can easily tweak settings
49    in the demo, and then copy-paste into their own setup
51 BUGS
52  - Style attribute height/width limiting for images
53  - Support for hard-coded paths/dirname(__FILE__) in include stub and autoload
54  - Easy way to blacklist elements and attributes
55  - Investigate iconv error emitting
56  - Investigate UTF-8 optimization <http://htmlpurifier.org/phorum/read.php?3,1496>
57  - Figure out what to do about target="" and name="", since they show up so often
58  - Update htmLawed comparison
60 FUTURE VERSIONS
61 ---------------
63 3.2 release [Error'ed]
64  # Error logging for filtering/cleanup procedures
65  - XSS-attempt detection
67 3.3 release [Do What I Mean, Not What I Say]
68  # Additional support for poorly written HTML
69     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
70     - Friendly strict handling of <address> (block -> <br>)
71  - Remove redundant tags, ex. <u><u>Underlined</u></u>. Implementation notes:
72     1. Analyzing which tags to remove duplicants
73     2. Ensure attributes are merged into the parent tag
74     3. Extend the tag exclusion system to specify whether or not the
75     contents should be dropped or not (currently, there's code that could do
76     something like this if it didn't drop the inner text too.)
77  - Remove <span> tags that don't do anything (no attributes)
78  - Remove empty inline tags<i></i>
79  - Append something to duplicate IDs so they're still usable (impl. note: the
80    dupe detector would also need to detect the suffix as well)
81  - Externalize inline CSS to promote clean HTML
83 3.4 release [It's All About Trust] (floating)
84  # Implement untrusted, dangerous elements/attributes
85     - Objects and Forms are especially wanted
86  # Implement IDREF support (harder than it seems, since you cannot have
87    IDREFs to non-existent IDs)
88  # Frameset XHTML 1.0 and HTML 4.01 doctypes
90 4.0 release [Beyond HTML]
91  # Legit token based CSS parsing (will require revamping almost every
92    AttrDef class). Probably will use CSSTidy class
93  # More control over allowed CSS properties (maybe modularize it in the
94    same fashion!)
95  # HTML 5 support
96  - Standardize token armor for all areas of processing
97  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
98    Also, enable disabling of directionality
99  - Table of Contents generation (XHTML Compiler might be reusable)
101 5.0 release [To XML and Beyond]
102  - Extended HTML capabilities based on namespacing and tag transforms (COMPLEX)
103     - Hooks for adding custom processors to custom namespaced tags and
104       attributes, offer default implementation
105     - Lots of documentation and samples
107 Ongoing
108  - More refactoring to take advantage of PHP5's facilities 
109  - Lots of profiling, make it faster!
110  - Plugins for major CMSes (COMPLEX)
111     - phpBB
112     - more! (look for ones that use WYSIWYGs)
113  - Complete basic smoketests
115 AutoFormat
116  - Smileys
117  - Syntax highlighting with <pre> and possibly <?php
118  - Look at http://drupal.org/project/Modules/category/63 for ideas
120 Unknown release (on a scratch-an-itch basis)
121  # CHMOD install script for PEAR installs
122  ? Have 'lang' attribute be checked against official lists, achieved by
123    encoding all characters that have string entity equivalents
124  - Abstract ChildDef_BlockQuote to work with all elements that only
125    allow blocks in them, required or optional
126  - Reorganize Unit Tests
127  - Advanced URI filtering schemes (see docs/proposal-new-directives.txt)
128  - Implement lenient <ruby> child validation
129  - Explain how to use HTML Purifier in non-PHP languages / create
130    a simple command line stub (or complicated?)
131  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
132  - Automatically add non-breaking spaces to empty table cells when
133    empty-cells:show is applied to have compatibility with Internet Explorer
134  - Distinguish between default settings and explicitly set settings, so
135    configurations can be merged
136  - Nested configuration namespaces
137  - Allow scoped="scoped" attribute in <style> tags; may be troublesome
138    because regular CSS has no way of uniquely identifying nodes, so we'd
139    have to generate IDs
140  - Time PHPT tests
142 Requested
144 Wontfix
145  - Non-lossy smart alternate character encoding transformations (unless
146    patch provided)
147  - Pretty-printing HTML: users can use Tidy on the output on entire page
148  - Native content compression, whitespace stripping (don't rely on Tidy, make
149    sure we don't remove from <pre> or related tags): use gzip if this is
150    really important