Remove inscrutable TODO, optionalize another.
[htmlpurifier.git] / TODO
blobb79e47da2dc0b5e3a632f39877b4bc10f167f43d
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 require 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!
14 Things to do as soon as possible:
16  - Think about allowing explicit order of operations hooks for transforms
17  - Fix "<.<" bug (trailing < is removed if not EOD)
18  - Build in better internal state dumps and debugging tools for remote
19    debugging
20  - Allowed/Allowed* have strange interactions when both set
21  ? Transform lone embeds into object tags
22  - Deprecated config options that emit warnings when you set them (with'
23    a way of muting the warning if you really want to)
24  - Make HTML.Trusted work with Output.FlashCompat
25  - HTML.Trusted and HTML.SafeObject have funny interaction; general
26    problem is what to do when a module "supersedes" another
27    (see also tables and basic tables.)  This is a little dicier
28    because HTML.SafeObject has some extra functionality that
29    trusted might find useful.  See http://htmlpurifier.org/phorum/read.php?3,5762,6100
31 FUTURE VERSIONS
32 ---------------
34 4.5 release [OMG CONFIG PONIES]
35  ! Fix Printer. It's from the old days when we didn't have decent XML classes
36  ! Factor demo.php into a set of Printer classes, and then create a stub
37    file for users here (inside the actual HTML Purifier library)
38  - Fix error handling with form construction
39  - Do encoding validation in Printers, or at least, where user data comes in
40  - Config: Add examples to everything (make built-in which also automatically
41    gives output)
42  - Add "register" field to config schemas to eliminate dependence on
43    naming conventions (try to remember why we ultimately decided on tihs)
45 5.0 release [HTML 5]
46  # Swap out code to use html5lib tokenizer and tree-builder
47  ! Allow turning off of FixNesting and required attribute insertion
49 5.1 release [It's All About Trust] (floating)
50  # Implement untrusted, dangerous elements/attributes
51  # Implement IDREF support (harder than it seems, since you cannot have
52    IDREFs to non-existent IDs)
53      - Implement <area> (client and server side image maps are blocking
54        on IDREF support)
55  # Frameset XHTML 1.0 and HTML 4.01 doctypes
56  - Figure out how to simultaneously set %CSS.Trusted and %HTML.Trusted (?)
58 5.2 release [Error'ed]
59  # Error logging for filtering/cleanup procedures
60  # Additional support for poorly written HTML
61     - Microsoft Word HTML cleaning (i.e. MsoNormal, but research essential!)
62     - Friendly strict handling of <address> (block -> <br>)
63  - XSS-attempt detection--certain errors are flagged XSS-like
64  - Append something to duplicate IDs so they're still usable (impl. note: the
65    dupe detector would also need to detect the suffix as well)
67 6.0 release [Beyond HTML]
68  # Legit token based CSS parsing (will require revamping almost every
69    AttrDef class). Probably will use CSSTidy
70  # More control over allowed CSS properties using a modularization
71  # IRI support (this includes IDN)
72  - Standardize token armor for all areas of processing
74 7.0 release [To XML and Beyond]
75  - Extended HTML capabilities based on namespacing and tag transforms (COMPLEX)
76     - Hooks for adding custom processors to custom namespaced tags and
77       attributes, offer default implementation
78     - Lots of documentation and samples
80 Ongoing
81  - More refactoring to take advantage of PHP5's facilities
82  - Refactor unit tests into lots of test methods
83  - Plugins for major CMSes (COMPLEX)
84     - phpBB
85     - Also, a FAQ for extension writers with HTML Purifier
87 AutoFormat
88  - Smileys
89  - Syntax highlighting (with GeSHi) with <pre> and possibly <?php
90  - Look at http://drupal.org/project/Modules/category/63 for ideas
92 Neat feature related
93  ! Support exporting configuration, so users can easily tweak settings
94    in the demo, and then copy-paste into their own setup
95  - Advanced URI filtering schemes (see docs/proposal-new-directives.txt)
96  - Allow scoped="scoped" attribute in <style> tags; may be troublesome
97    because regular CSS has no way of uniquely identifying nodes, so we'd
98    have to generate IDs
99  - Explain how to use HTML Purifier in non-PHP languages / create
100    a simple command line stub (or complicated?)
101  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
102  - Automatically add non-breaking spaces to empty table cells when
103    empty-cells:show is applied to have compatibility with Internet Explorer
104  - Table of Contents generation (XHTML Compiler might be reusable). May also
105    be out-of-band information.
106  - Full set of color keywords. Also, a way to add onto them without
107    finalizing the configuration object.
108  - Write a var_export and memcached DefinitionCache - Denis
109  - Built-in support for target="_blank" on all external links
110  - Convert RTL/LTR override characters to <bdo> tags, or vice versa on demand.
111    Also, enable disabling of directionality
112  ? Externalize inline CSS to promote clean HTML, proposed by Sander Tekelenburg
113  ? Remove redundant tags, ex. <u><u>Underlined</u></u>. Implementation notes:
114     1. Analyzing which tags to remove duplicants
115     2. Ensure attributes are merged into the parent tag
116     3. Extend the tag exclusion system to specify whether or not the
117     contents should be dropped or not (currently, there's code that could do
118     something like this if it didn't drop the inner text too.)
119  ? Make AutoParagraph also support paragraph-izing double <br> tags, and not
120    just double newlines.  This is kind of tough to do in the current framework,
121    though, and might be reasonably approximated by search replacing double <br>s
122    with newlines before running it through HTML Purifier.
124 Maintenance related (slightly boring)
125  # CHMOD install script for PEAR installs
126  ! Factor out command line parser into its own class, and unit test it
127  - Reduce size of internal data-structures (esp. HTMLDefinition)
128  - Allow merging configurations.  Thus,
129         a -> b -> default
130         c -> d -> default
131    becomes
132         a -> b -> c -> d -> default
133    Maybe allow more fine-grained tuning of this behavior. Alternatively,
134    encourage people to use short plist depths before building them up.
135  - Time PHPT tests
137 ChildDef related (very boring)
138  - Abstract ChildDef_BlockQuote to work with all elements that only
139    allow blocks in them, required or optional
140  - Implement lenient <ruby> child validation
142 Wontfix
143  - Non-lossy smart alternate character encoding transformations (unless
144    patch provided)
145  - Pretty-printing HTML: users can use Tidy on the output on entire page
146  - Native content compression, whitespace stripping: use gzip if this is
147    really important
149     vim: et sw=4 sts=4