Comments on underscore.
[docutils.git] / HISTORY.txt
blob9d9af0da9cd829ead846ff3e16a532214da9a06c
1 ==================
2  Docutils History
3 ==================
5 :Author: David Goodger
6 :Contact: goodger@users.sourceforge.net
7 :Date: $Date$
8 :Web site: http://docutils.sourceforge.net/
9 :Copyright: This document has been placed in the public domain.
11 .. contents::
13 Acknowledgements
14 ================
16 I would like to acknowledge the people who have made a direct impact
17 on the Docutils project, knowingly or not, in terms of encouragement,
18 suggestions, criticism, bug reports, code contributions, tasty treats,
19 and related projects:
21     Aahz, David Abrahams, David Ascher, Heiko Baumann, Eric Bellot,
22     Ian Bicking, Marek Blaha, Martin Blais, Stephen Boulet, Fred
23     Bremmer, Simon Budig, Bill Bumgarner, Brett Cannon, Greg Chapman,
24     Nicolas Chauveau, Beni Cherniavsky, Adam Chodorowski, Brent Cook,
25     Laura Creighton, Artur de Sousa Rocha, Jason Diamond, William
26     Dode, Fred Drake, Reggie Dugard, Dethe Elza, Marcus Ertl, Benja
27     Fallenstein, fantasai, Stefane Fermigier, Jim Fulton, Peter Funk,
28     Lele Gaifax, Dinu C. Gherman, Matt Gilbert, Jorge Gonzalez,
29     Engelbert Gruber, Jacob Hallen, Simon Hefti, Doug Hellmann,
30     Juergen Hermann, Jannie Hofmeyr, Steve Holden, Michael Hudson,
31     Marcelo Huerta San Martin, Ludger Humbert, Jeremy Hylton, Tony
32     Ibbs, Alan Jaffray, Dmitry Jemerov, Richard Jones, Andreas Jung,
33     Garth Kidd, Axel Kollmorgen, Jeff Kowalczyk, Dave Kuhlman, Lloyd
34     Kvam, Kirill Lapshin, Nicola Larosa, Daniel Larsson, Marc-Andre
35     Lemburg, Julien Letessier, Wolfgang Lipp, Edward Loper, Dallas
36     Mahrt, Ken Manheimer, Bob Marshall, Mark McEahern, Vincent
37     McIntyre, John F Meinel Jr, Vasko Miroslav, Skip Montanaro, Paul
38     Moore, Nigel W. Moriarty, Mark Nodine, Patrick K. O'Brien, Michel
39     Pelletier, Sam Penrose, Tim Peters, Pearu Peterson, Mark Pilgrim,
40     Brett g Porter, David Priest, Jens Quade, Andy Robinson, Tavis
41     Rudd, Tracy Ruggles, Oliver Rutherfurd, Kenichi Sato, Ueli
42     Schlaepfer, Gunnar Schwant, Bill Sconce, Frank Siebenlist, Bruce
43     Smith, Darek Suchojad, Roman Suzi, tav, Kent Tenney, Bob Tolbert,
44     Paul Tremblay, Laurence Tratt, Adrian van den Dries, Guido van
45     Rossum, Paul Viren, Martin von Loewis, Greg Ward, Barry Warsaw,
46     Edward Welbourne, Ka-Ping Yee, Moshe Zadka
48 Thank you!
50 (I'm still waiting for contributions of computer equipment and cold
51 hard cash :-).)  Hopefully I haven't forgotten anyone or misspelled
52 any names; apologies (and please let me know!) if I have.
55 Future Plans
56 ============
58 * Include substitution files for character entities, produced by the
59   tools/unicode2rstsubs.py.  As static data, these files could go
60   inside the docutils package somewhere.
62 * Rename front-end tools (perhaps to "rst2*" pattern) and have
63   setup.py install them.
65 * A Python Source Reader component (Python auto-documentation) will be
66   added as soon as there's enough time, effort, and will.  If you'd
67   like to help, let me know!
70 Changes Since 0.3
71 =================
73 * docutils/__init__.py:
75   - 0.3.1: Reorganized config file format (multiple sections); see
76     docs/config.txt.
77   - Added unknown_reference_resolvers attribute to TransformSpec.
78   - 0.3.2: Interpreted text reorganization.
80 * docutils/core.py:
82   - Catch system messages to stop tracebacks from parsing errors.
83   - Catch exceptions during processing report & exit without
84     tracebacks, except when "--traceback" used.
85   - Reordered components for OptionParser; application comes last.
86   - Added "config_section" parameter to several methods and functions,
87     allowing front ends to easily specify their config file sections.
88   - Added publish_parts convenience function to allow access to individual
89     parts of a document
91 * docutils/frontend.py:
93   - Added "--traceback" & "--no-traceback" options ("traceback"
94     setting).
95   - Implemented support for config file reorganization:
96     ``standard_config_files`` moved from ``ConfigParser`` to
97     ``OptionParser``; added
98     ``OptionParser.get_config_file_settings()`` and
99     ``.get_standard_config_settings()``; support for old "[options]"
100     section (with deprecation warning) and mapping from old to new
101     settings.
102   - Reimplemented setting validation.
103   - Enabled flexible boolean values: yes/no, true/false, on/off.
104   - Added ``Values``, a subclass of ``optparse.Values``, with support
105     for list setting attributes.
106   - Added support for new ``DOCUTILSCONFIG`` environment variable;
107     thanks to Beni Cherniavsky.
108   - Added "--no-section-numbering" option.
110 * docutils/io.py:
112   - Catch IOErrors when opening source & destination files, report &
113     exit without tracebacks.  Added ``handle_io_errors`` parameter to
114     ``FileInput`` & ``FileOutput`` to enable caller error handling.
116 * docutils/nodes.py:
118   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
119     method definitions (via ``exec``) to dynamic assignments (via
120     ``setattr``); thanks to Roman Suzi.
121   - Added indirect_reference_name attribute to the Targetable class. This
122     attribute holds the whitespace_normalized_name (contains mixed case) of a
123     target.
125 * docutils/statemachine.py:
127   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
128   - Added ``StringList.get_2D_block``.
130 * docutils/utils.py:
132   - Added "level" attribute to SystemMessage exceptions.
134 * docutils/languages/af.py: Added to project; Afrikaans mappings by
135   Jannie Hofmeyr.
137 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
138   Blaha.
140 * docutils/languages/eo.py: Added to project; Esperanto mappings by
141   Marcelo Huerta San Martin.
143 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
144   mappings by Lalo Martins.
146 * docutils/languages/ru.py: Added to project; Russian mappings by
147   Roman Suzi.
149 * docutils/parsers/rst/roles.py: Added to project.  Contains
150   interpreted text role functions, a registry for interpreted text
151   roles, and an API for adding to and retrieving from the registry.
152   Contributed by Edward Loper.
154 * docutils/parsers/rst/states.py:
156   - Updated ``RSTState.nested_parse`` for "include" in table cells.
157   - Allowed true em-dash character and "---" as block quote
158     attribution marker.
159   - Added support for <angle-bracketed> complex option arguments
160     (option lists).
161   - Fixed handling of backslashes in substitution definitions.
162   - Fixed off-by-1 error with extra whitespace after substitution
163     definition directive.
164   - Added inline markup parsing to field lists' field names.
165   - Added support for quoted (and unindented) literal blocks.
166     Driven in part by a bribe from Frank Siebenlist (thanks!).
167   - Parser now handles escapes in URIs correctly.
168   - Made embedded-URIs' reference text omittable.  Idea from Beni
169     Cherniavsky.
170   - Refactored explicit target processing code.
171   - Added name attribute to references containing the reference name only
172     through whitespace_normalize_name (no case changes).
173   - parse_target no longer returns the refname after going through
174     normalize_name. This is now handled in make_target.
175   - Fixed bug relating to role-less interpreted text in non-English
176     contexts.
177   - Reorganized interpreted text processing; moved code into the new
178     roles.py module.  Contributed by Edward Loper.
179   - Refactored ``Body.parse_directive`` into ``run_directive`` and
180     ``parse_directive_block``.
182 * docutils/parsers/rst/tableparser.py:
184   - Reworked for ``StringList``, to support "include" directives in
185     table cells.
187 * docutils/parsers/rst/directives/__init__.py:
189   - Renamed ``unchanged()`` directive option conversion function to
190     ``unchanged_required``, and added a new ``unchanged``.
191   - Catch unicode value too high error; fixes bug 781766.
192   - Beefed up directive error reporting.
194 * docutils/parsers/rst/directives/body.py:
196   - Added basic "table" directive.
198 * docutils/parsers/rst/directives/images.py:
200   - Added "target" option to "image" directive.
201   - Added name attribute to references containing the reference name only
202     through whitespace_normalize_name (no case changes).
204 * docutils/parsers/rst/directives/misc.py:
206   - Isolated the import of the ``urllib2`` module; was causing
207     problems on SourceForge (``libssl.so.2`` unavailable?).
208   - Added the "role" directive for declaring custom interpreted text
209     roles.
211 * docutils/parsers/rst/directives/parts.py:
213   - The "contents" directive does more work up-front, creating the
214     "topic" and "title", and leaving the "pending" node for the
215     transform.  Allows earlier reference resolution; fixes subtle bug.
217 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
218   mappings by Jannie Hofmeyr.
220 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
221   mappings by Marek Blaha.
223 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
224   mappings by Marcelo Huerta San Martin.
226 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
227   Portuguese mappings by Lalo Martins.
229 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
230   mappings by Roman Suzi.
232 * docutils/transforms/parts.py:
234   - The "contents" directive does more work up-front, creating the
235     "topic" and "title", and leaving the "pending" node for the
236     transform.  Allows earlier reference resolution; fixes subtle bug.
237   - Added support for disabling of section numbering.
238     
239 * docutils/transforms/references.py:
241   - Verifying that external targets are truly targets and not indirect 
242     references. This is because we are now adding a "name" attribute to 
243     references in addition to targets. Note sure if this is correct!
244   - Added code to hook into the unknown_reference_resolvers list for a
245     transformer in resolve_indirect_target. This allows the
246     unknown_reference_resolvers to keep around indirect targets which docutils 
247     doesn't know about.
249 * docutils/transforms/universal.py:
251   - Added FilterMessages transform (removes system messages below the
252     verbosity threshold).
253   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
254     to FinalCheckVisitor for application-specific handling of 
255     unresolvable references.
256   
257 * docutils/writers/__init__.py:
259   - Added assemble_parts method to the Writer class to allow for
260     access to a documents individual parts.
262 * docutils/writers/html4css1.py:
264   - Fixed unicode handling of attribute values (bug 760673).
265   - Prevent duplication of "class" attribute values (bug report from
266     Kirill Lapshin).
267   - Improved table grid/border handling (prompted by report from Bob
268     Marshall).
269   - Added support for table titles.
270   - Added "<title />" for untitled docs, for XHTML conformance; thanks
271     to Darek Suchojad.
272   - Added functionality to keep track of individual parts of a document
273     and store them in a dictionary as the "parts" attribute of the writer.
274     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
275   - Added proper support for the "scale" attribute of the "image"
276     element.  Contributed by Brent Cook.
278 * docutils/writers/latex2e.py:
280   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
281     about a missing file.
282   - Added options and support: ``--compound-enumerators``,
283     ``--section-prefix-for-enumerators``, and
284     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
285     934322).
287 * docs/config.txt: "Docutils Configuration Files", added to project.
288   Moved config file entry descriptions from tools.txt.
290 * docs/tools.txt:
292   - Moved config file entry descriptions to config.txt.
294 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
295   Development".
297 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
298   Text Roles", added to project.
300 * spec/rst/reStructuredText.txt:
302   - Added description of support for <angle-bracketed> complex option
303     arguments to option lists.
304   - Added subsections for indented and quoted literal blocks.
306 * test: Continually adding & updating tests.
308   - Added test/test_settings.py & test/data/config_*.txt support
309     files.
310   - Added test/test_writers/test_htmlfragment.py.
312 * test/DocutilsTestSupport.py:
314   - Refactored LaTeX publisher test suite/case class names to make
315     testing other writers easier.
316   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
317     to test the processing of HTML fragments which use the new
318     publish_parts convenience function.
320 * tools/buildhtml.py:
322   - Added support for the "--prune" option.
324 * tools/docutils.conf:
326   - Updated for configuration file reorganization.
328 * tools/rst2html.py:
330   - copied from tools/html.py
332 * setup.py:
334   - added a 'scripts' section to configuration
335   - added 'tools/rst2html.py' to the scripts section
338 Release 0.3 (2003-06-24)
339 ========================
341 General:
343 * Renamed "attribute" to "option" for directives/extensions.
345 * Renamed transform method "transform" to "apply".
347 * Renamed "options" to "settings" for runtime settings (as set by
348   command-line options).  Sometimes "option" (singular) became
349   "settings" (plural).  Some variations below:
351   - document.options -> document.settings (stored in other objects as
352     well)
353   - option_spec -> settings_spec (not directives though)
354   - OptionSpec -> SettingsSpec
355   - cmdline_options -> settings_spec
356   - relative_path_options -> relative_path_settings
357   - option_default_overrides -> settings_default_overrides
358   - Publisher.set_options -> Publisher.get_settings
360 Specific:
362 * COPYING.txt: Added "Public Domain Dedication".
364 * FAQ.txt: Frequently asked questions, added to project.
366 * setup.py:
368   - Updated with PyPI Trove classifiers.
369   - Conditional installation of third-party modules.
371 * docutils/__init__.py:
373   - Bumped version to 0.2.1 to reflect changes to I/O classes.
374   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
375   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
376   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
377     option and its effect on the PEP template & writer.
378   - Bumped version to 0.2.4 due to changes to the PEP template &
379     stylesheet.
380   - Bumped version to 0.2.5 to reflect changes to Reporter output.
381   - Added ``TransformSpec`` class for new transform system.
382   - Bumped version to 0.2.6 for API changes (renaming).
383   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
384     convenience functions.
385   - Added ``Component.component_type`` attribute.
386   - Bumped version to 0.2.8 because of the internal parser switch from
387     plain lists to the docutils.statemachine.StringList objects.
388   - Bumped version to 0.2.9 because of the frontend.py API changes.
389   - Bumped version to 0.2.10 due to changes to the project layout
390     (third-party modules removed from the "docutils" package), and
391     signature changes in ``io.Input``/``io.Output``.
392   - Changed version to 0.3.0 for release.
394 * docutils/core.py:
396   - Made ``publish()`` a bit more convenient.
397   - Generalized ``Publisher.set_io``.
398   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
399     parameters; improved its docstring.
400   - Added ``publish_file()`` and ``publish_string()``.
401   - Factored ``Publisher.set_source()`` and ``.set_destination()``
402     out of ``.set_io``.
403   - Added support for "--dump-pseudo-xml", "--dump-settings", and
404     "--dump-transforms" hidden options.
405   - Added ``Publisher.apply_transforms()`` method.
406   - Added ``Publisher.set_components()`` method; support for
407     ``publish_*()`` conveninece functions.
408   - Moved config file processing to docutils/frontend.py.
409   - Added support for exit status ("exit_level" setting &
410     ``enable_exit`` parameter for Publisher.publish() and convenience
411     functions).
413 * docutils/frontend.py:
415   - Check for & exit on identical source & destination paths.
416   - Fixed bug with absolute paths & "--config".
417   - Set non-command-line defaults in ``OptionParser.__init__()``:
418     ``_source`` & ``_destination``.
419   - Distributed ``relative_path_settings`` to components; updated
420     ``OptionParser.populate_from_components()`` to combine it all.
421   - Require list of keys in ``make_paths_absolute`` (was implicit in
422     global ``relative_path_settings``).
423   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
424     "--dump-settings", and "--dump-transforms" hidden options.
425   - Removed nasty internals-fiddling ``ConfigParser.get_section``
426     code, replaced with correct code.
427   - Added validation functionality for config files.
428   - Added "--error-encoding" option/setting, "_disable_config"
429     internal setting.
430   - Added encoding validation; updated "--input-encoding" and
431     "--output-encoding"; added "--error-encoding-error-handler" and
432     "--output-encoding-error-handler".
433   - Moved config file processing from docutils/core.py.
434   - Updated ``OptionParser.populate_from_components`` to handle new
435     ``SettingsSpec.settings_defaults`` dict.
436   - Added support for "-" => stdin/stdout.
437   - Added "exit_level" setting ("--exit" option).
439 * docutils/io.py:
441   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
442   - Added automatic closing to ``FileInput`` and ``FileOutput``.
443   - Delayed opening of ``FileOutput`` file until ``write()`` called.
444   - ``FileOutput.write()`` now returns the encoded output string.
445   - Try to get path/stream name automatically in ``FileInput`` &
446     ``FileOutput``.
447   - Added defaults for source & destination paths.
448   - Allow for Unicode I/O with an explicit "unicode" encoding.
449   - Added ``Output.encode()``.
450   - Removed dependency on runtime settings; pass encoding directly.
451   - Recognize Unicode strings in ``Input.decode()``.
452   - Added support for output encoding error handlers.
454 * docutils/nodes.py:
456   - Added "Invisible" element category class.
457   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
458     modification during a traversal.
459   - Added element classes: ``line_block``, ``generated``, ``address``,
460     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
461     ``superscript``, ``subscript``, ``inline``
462   - Added support for lists of nodes to ``Element.insert()``.
463   - Fixed parent linking in ``Element.replace()``.
464   - Added new abstract superclass ``FixedTextElement``; adds
465     "xml:space" attribute.
466   - Added support for "line" attribute of ``system_message`` nodes.
467   - Added support for the observer pattern from ``utils.Reporter``.
468     Added ``parse_messages`` and ``transform_messages`` attributes to
469     ``document``, removed ``messages``.  Added ``note_parse_message``
470     and ``note_transform_message`` methods.
471   - Added support for improved diagnostics:
473     - Added "document", "source", and "line" internal attributes to
474       ``Node``, set by ``Node.setup_child()``.
475     - Converted variations on ``node.parent = self`` to
476       ``self.setup_child(node)``.
477     - Added ``document.current_source`` & ``.current_line``
478       attributes, and ``.note_source`` observer method.
479     - Changed "system_message" output to GNU-Tools format.
481   - Added a "rawsource" attribute to the ``Text`` class, for text
482     before backslash-escape resolution.
483   - Support for new transform system.
484   - Reworked ``pending`` element.
485   - Fixed XML DOM bug (SF #660611).
486   - Removed the ``interpeted`` element class and added
487     ``title_reference``, ``abbreviation``, ``acronym``.
488   - Made substitutions case-sensitive-but-forgiving; moved some code
489     from the parser.
490   - Fixed Unicode bug on element attributes (report: William Dode).
492 * docutils/optik.py: Removed from project; replaced with
493   extras/optparse.py and extras/textwrap.py.  These will be installed
494   only if they're not already present in the Python installation.
496 * docutils/roman.py: Moved to extras/roman.py; this will be installed
497   only if it's not already present in the Python installation.
499 * docutils/statemachine.py:
501   - Factored out ``State.add_initial_transitions()`` so it can be
502     extended.
503   - Converted whitespace-specific "blank" and "indent" transitions
504     from special-case code to ordinary transitions: removed
505     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
506     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
507     ``ws_initial_transitions`` attributes.
508   - Removed ``State.match_transition()`` after merging it into
509     ``.check_line()``.
510   - Added ``StateCorrection`` exception.
511   - Added support for ``StateCorrection`` in ``StateMachine.run()``
512     (moved ``TransitionCorrection`` support there too.)
513   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
514     ``EOFError`` instead of ``IndexError``.
515   - Added ``State.no_match`` method.
516   - Added support for the Observer pattern, triggered by input line
517     changes.
518   - Added ``strip_top`` parameter to
519     ``StateMachineWS.get_first_known_indented``.
520   - Made ``context`` a parameter to ``StateMachine.run()``.
521   - Added ``ViewList`` & ``StringList`` classes;
522     ``extract_indented()`` becomes ``StringList.get_indented()``.
523   - Added ``StateMachine.insert_input()``.
524   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
525     thanks to) Fred Drake.
527 * docutils/utils.py:
529   - Added a ``source`` attribute to Reporter instances and
530     ``system_message`` elements.
531   - Added an observer pattern to ``utils.Reporter`` to keep track of
532     system messages.
533   - Fixed bugs in ``relative_path()``.
534   - Added support for improved diagnostics.
535   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
536   - Added support for encoding Reporter stderr output, and encoding
537     error handlers.
538   - Reporter keeps track of the highest level system message yet
539     generated.
541 * docutils/languages: Fixed bibliographic field language lookups.
543 * docutils/languages/es.py: Added to project; Spanish mappings by
544   Marcelo Huerta San Martin.
546 * docutils/languages/fr.py: Added to project; French mappings by
547   Stefane Fermigier.
549 * docutils/languages/it.py: Added to project; Italian mappings by
550   Nicola Larosa.
552 * docutils/languages/sk.py: Added to project; Slovak mappings by
553   Miroslav Vasko.
555 * docutils/parser/__init__.py:
557   - Added ``Parser.finish_parse()`` method.
559 * docutils/parser/rst/__init__.py:
561   - Added options: "--pep-references", "--rfc-references",
562     "--tab-width", "--trim-footnote-reference-space".
564 * docutils/parsers/rst/states.py:
566   - Changed "title under/overline too short" system messages from INFO
567     to WARNING, and fixed its insertion location.
568   - Fixed enumerated list item parsing to allow paragraphs & section
569     titles to begin with enumerators.
570   - Converted system messages to use the new "line" attribute.
571   - Fixed a substitution reference edge case.
572   - Added support for "--pep-references" and "--rfc-references"
573     options; reworked ``Inliner`` code to make customization easier.
574   - Removed field argument parsing.
575   - Added support for short section title over/underlines.
576   - Fixed "simple reference name" regexp to ignore text like
577     "object.__method__"; not an anonymous reference.
578   - Added support for improved diagnostics.
579   - Reworked directive API, based on Dethe Elza's contribution.  Added
580     ``Body.parse_directive()``, ``.parse_directive_options()``,
581     ``.parse_directive_arguments()`` methods.
582   - Added ``ExtensionOptions`` class, to parse directive options
583     without parsing field bodies.  Factored
584     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
585     ``ExtensionOptions``.
586   - Improved definition list term/classifier parsing.
587   - Added warnings for unknown directives.
588   - Renamed ``Stuff`` to ``Struct``.
589   - Now flagged as errors: transitions at the beginning or end of
590     sections, empty sections (except title), and empty documents.
591   - Updated for ``statemachine.StringList``.
592   - Enabled recognition of schemeless email addresses in targets.
593   - Added support for embedded URIs in hyperlink references.
594   - Added backslash-escapes to inline markup end-string suffix.
595   - Added support for correct interpreted text processing.
596   - Fixed nested title parsing (topic, sidebar directives).
597   - Added special processing of backslash-escaped whitespace (idea
598     from David Abrahams).
599   - Made substitutions case-sensitive-but-forgiving; moved some code
600     to ``docutils.nodes``.
601   - Added support for block quote attributions.
602   - Added a kludge to work-around a conflict between the bubble-up
603     parser strategy and short titles (<= 3 char-long over- &
604     underlines).  Fixes SF bug #738803 "infinite loop with multiple
605     titles" submitted by Jason Diamond.
606   - Added explicit interpreted text roles for standard inline markup:
607     "emphasis", "strong", "literal".
608   - Implemented "superscript" and "subscript" interpreted text roles.
609   - Added initial support for "abbreviation" and "acronym" roles;
610     incomplete.
611   - Added support for "--trim-footnote-reference-space" option.
612   - Optional space before colons in directives & hyperlink targets.
614 * docutils/parsers/rst/tableparser.py:
616   - Fixed a bug that was producing unwanted empty rows in "simple"
617     tables.
618   - Detect bad column spans in "simple" tables.
620 * docutils/parsers/rst/directives: Updated all directive functions to
621   new API.
623 * docutils/parsers/rst/directives/__init__.py:
625   - Added ``flag()``, ``unchanged()``, ``path()``,
626     ``nonnegative_int()``, ``choice()``, and ``class_option()``
627     directive option helper functions.
628   - Added warnings for unknown directives.
629   - Return ``None`` for missing directives.
630   - Added ``register_directive()``, thanks to William Dode and Paul
631     Moore.
633 * docutils/parsers/rst/directives/admonitions.py:
635   - Added "admonition" directive.
637 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
638   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
639   "parsed-literal", "rubric", "epigraph", "highlights" and
640   "pull-quote" directives.
642 * docutils/parsers/rst/directives/images.py:
644   - Added an "align" attribute to the "image" & "figure" directives
645     (by Adam Chodorowski).
646   - Added "class" option to "image", and "figclass" to "figure".
648 * docutils/parsers/rst/directives/misc.py:
650   - Added "include", "raw", and "replace" directives, courtesy of
651     Dethe Elza.
652   - Added "unicode" and "class" directives.
654 * docutils/parsers/rst/directives/parts.py:
656   - Added the "sectnum" directive; by Dmitry Jemerov.
657   - Added "class" option to "contents" directive.
659 * docutils/parsers/rst/directives/references.py: Added to project.
660   Contains the "target-notes" directive.
662 * docutils/parsers/rst/languages/__init__.py:
664   - Return ``None`` from get_language() for missing language modules.
666 * docutils/parsers/rst/languages/de.py: Added to project; German
667   mappings by Engelbert Gruber.
669 * docutils/parsers/rst/languages/en.py:
671   - Added interpreted text roles mapping.
673 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
674   mappings by Marcelo Huerta San Martin.
676 * docutils/parsers/rst/languages/fr.py: Added to project; French
677   mappings by William Dode.
679 * docutils/parsers/rst/languages/it.py: Added to project; Italian
680   mappings by Nicola Larosa.
682 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
683   mappings by Miroslav Vasko.
685 * docutils/readers/__init__.py:
687   - Added support for the observer pattern from ``utils.Reporter``, in
688     ``Reader.parse`` and ``Reader.transform``.
689   - Removed ``Reader.transform()`` method.
690   - Added default parameter values to ``Reader.__init__()`` to make
691     instantiation easier.
692   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
694 * docutils/readers/pep.py:
696   - Added the ``peps.TargetNotes`` transform to the Reader.
697   - Removed PEP & RFC reference detection code; moved to
698     parsers/rst/states.py as options (enabled here by default).
699   - Added support for pre-acceptance PEPs (no PEP number yet).
700   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
701     easy subclassing.
703 * docutils/readers/python: Python Source Reader subpackage added to
704   project, including preliminary versions of:
706   - __init__.py
707   - moduleparser.py: Parser for Python modules.
709 * docutils/transforms/__init__.py:
711   - Added ``Transformer`` class and completed transform reform.
712   - Added unknown_reference_resolvers list for each transformer. This list holds
713     the list of functions provided by each component of the transformer that
714     help resolve references.
716 * docutils/transforms/frontmatter.py:
718   - Improved support for generic fields.
719   - Fixed bibliographic field language lookups.
721 * docutils/transforms/misc.py: Added to project.  Miscellaneous
722   transforms.
724 * docutils/transforms/parts.py:
726   - Moved the "id" attribute from TOC list items to the references
727     (``Contents.build_contents()``).
728   - Added the ``SectNum`` transform; by Dmitry Jemerov.
729   - Added "class" attribute support to ``Contents``.
731 * docutils/transforms/peps.py:
733   - Added ``mask_email()`` function, updating to pep2html.py's
734     functionality.
735   - Linked "Content-Type: text/x-rst" to PEP 12.
736   - Added the ``TargetNotes`` PEP-specific transform.
737   - Added ``TargetNotes.cleanup_callback``.
738   - Added title check to ``Headers``.
740 * docutils/transforms/references.py:
742   - Added the ``TargetNotes`` generic transform.
743   - Split ``Hyperlinks`` into multiple transforms.
744   - Fixed bug with multiply-indirect references (report: Bruce Smith).
745   - Added check for circular indirect references.
746   - Made substitutions case-sensitive-but-forgiving.
748 * docutils/transforms/universal.py:
750   - Added support for the "--expose-internal-attributes" option.
751   - Removed ``Pending`` transform classes & data.
753 * docutils/writers/__init__.py:
755   - Removed ``Writer.transform()`` method.
757 * docutils/writers/docutils-xml.py:
759   - Added XML and doctype declarations.
760   - Added "--no-doctype" and "--no-xml-declaration" options.
762 * docutils/writers/html4css1.py:
764   - "name" attributes only on these tags: a, applet, form, frame,
765     iframe, img, map.
766   - Added "name" attribute to <a> in section titles for Netscape 4
767     support (bug report: Pearu Peterson).
768   - Fixed targets (names) on footnote, citation, topic title,
769     problematic, and system_message nodes (for Netscape 4).
770   - Changed field names from "<td>" to "<th>".
771   - Added "@" to "&#64;" encoding to thwart address harvesters.
772   - Improved the vertical whitespace optimization; ignore "invisible"
773     nodes (targets, comments, etc.).
774   - Improved inline literals with ``<span class="pre">`` around chunks
775     of text and ``&nbsp;`` for runs of spaces.
776   - Improved modularity of output; added ``self.body_pre_docinfo`` and
777     ``self.docinfo`` segments.
778   - Added support for "line_block", "address" elements.
779   - Improved backlinks (footnotes & system_messages).
780   - Improved system_message output.
781   - Redefined "--stylesheet" as containing an invariant URL, used
782     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
783     working directory.
784   - Added "--footnote-references" option (superscript or brackets).
785   - Added "--compact-lists" and "--no-compact-lists" options.
786   - Added "--embed-stylesheet" and "--link-stylesheet" options;
787     factored out ``HTMLTranslator.get_stylesheet_reference()``.
788   - Improved field list rendering.
789   - Added Docutils version to "generator" meta tag.
790   - Fixed a bug with images; they must be inline, so wrapped in <p>.
791   - Improved layout of <pre> HTML source.
792   - Fixed attribute typo on <colspec>.
793   - Refined XML prologue.
794   - Support for no stylesheet.
795   - Removed "interpreted" element support.
796   - Added support for "title_reference", "sidebar", "attribution",
797     "rubric", and generic "admonition" elements.
798   - Added "--attribution" option.
799   - Added support for "inline", "subscript", "superscript" elements.
800   - Added initial support for "abbreviation" and "acronym";
801     incomplete.
803 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
804   (from the sandbox).
806   - Added french.
807   - Double quotes in literal blocks (special treatment for de/ngerman).
808   - Added '--hyperlink-color' option ('0' turns off coloring of links).
809   - Added  "--attribution" option.
810   - Right align attributions.
812 * docutils/writers/pep_html.py:
814   - Parameterized output encoding in PEP template.
815   - Reworked substitutions from ``locals()`` into ``subs`` dict.
816   - Redefined "--pep-stylesheet" as containing an invariant URL, used
817     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
818     working directory.
819   - Added an override on the "--footnote-references" option.
820   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
821   - Added Docutils version to "generator" meta tag.
822   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
824 * docs/tools.txt:
826   - Added a "silent" setting for ``buildhtml.py``.
827   - Added a "Getting Help" section.
828   - Rearranged the structure.
829   - Kept up to date, with new settings, command-line options etc.
830   - Added section for ``rst2latex.py`` (Engelbert Gruber).
831   - Converted settings table into a definition list.
833 * docs/rst/quickstart.txt:
835   - Added a table of contents.
836   - Added feedback information.
837   - Added mention of minimum section title underline lengths.
838   - Removed the 4-character minimum for section title underlines.
840 * docs/rst/quickref.html:
842   - Added a "Getting Help" section.
843   - Added a style to make section title backlinks more subtle.
844   - Added mention of minimum section title underline lengths.
845   - Removed the 4-character minimum for section title underlines.
847 * extras: Directory added to project; contains third-party modules
848   that Docutils depends on (optparse, textwrap, roman).  These are
849   only installed if they're not already present.
851 * licenses: Directory added to project; contains copies of license
852   files for non-public-domain files.
854 * spec/doctree.txt:
856   - Changed the focus.  It's about DTD elements:  structural
857     relationships, semantics, and external (public) attributes.  Not
858     about the element class library.
859   - Moved some implementation-specific stuff into ``docutils.nodes``
860     docstrings.
861   - Wrote descriptions of all common attributes and parameter
862     entities.  Filled in introductory material.
863   - Working through the element descriptions: 55 down, 37 to go.
864   - Removed "Representation of Horizontal Rules" to
865     spec/rst/alternatives.txt.
867 * spec/docutils.dtd:
869   - Added "generated" inline element.
870   - Added "line_block" body element.
871   - Added "auto" attribute to "title".
872   - Changed content models of "literal_block" and "doctest_block" to
873     ``%text.model``.
874   - Added ``%number;`` attribute type parameter entity.
875   - Changed ``%structural.elements;`` to ``%section.elements``.
876   - Updated attribute types; made more specific.
877   - Added "address" bibliographic element.
878   - Added "line" attribute to ``system_message`` element.
879   - Removed "field_argument" element; "field_name" may contain
880     multiple words and whitespace.
881   - Changed public identifier to docutils.sf.net.
882   - Removed "interpreted" element; added "title_reference",
883     "abbreviation", "acronym".
884   - Removed "refuri" attribute from "footnote_reference" and
885     "citation_reference".
886   - Added "sidebar", "rubric", "attribution", "admonition",
887     "superscript", "subscript", and "inline" elements.
889 * spec/pep-0256.txt: Converted to reStructuredText & updated.
891 * spec/pep-0257.txt: Converted to reStructuredText & updated.
893 * spec/pep-0258.txt: Converted to reStructuredText & updated.
895 * spec/semantics.txt: Updated with text from a Doc-SIG response to
896   Dallas Mahrt.
898 * spec/transforms.txt: Added to project.
900 * spec/howto: Added subdirectory, for developer how-to docs.
902 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
903   Elza, edited & extended by David Goodger.
905 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
906   project.
908 * spec/rst/alternatives.txt:
910   - Added "Doctree Representation of Transitions" from
911     spec/doctree.txt.
912   - Updated "Inline External Targets" & closed the debate.
913   - Added ideas for interpreted text syntax extensions.
914   - Added "Nested Inline Markup" section.
916 * spec/rst/directives.txt:
918   - Added directives: "topic", "sectnum", "target-notes",
919     "line-block", "parsed-literal", "include", "replace", "sidebar",
920     "admonition", "rubric", "epigraph", "highlights", "unicode" and
921     "class".
922   - Formalized descriptions of directive details.
923   - Added an "align" attribute to the "image" & "figure" directives
924     (by Adam Chodorowski).
925   - Added "class" options to "topic", "sidebar", "line-block",
926     "parsed-literal", "contents", and "image"; and "figclass" to
927     "figure".
929 * spec/rst/interpreted.txt: Added to project.  Descriptions of
930   interpreted text roles.
932 * spec/rst/introduction.txt:
934   - Added pointers to material for new users.
936 * spec/rst/reStructuredText.txt:
938   - Disambiguated comments (just add a newline after the "::").
939   - Updated enumerated list description; added a discussion of the
940     second-line validity checking.
941   - Updated directive description.
942   - Added a note redirecting newbies to the user docs.
943   - Expanded description of inline markup start-strings in non-markup
944     contexts.
945   - Removed field arguments and made field lists a generic construct.
946   - Removed the 4-character minimum for section title underlines.
947   - Clarified term/classifier delimiter & inline markup ambiguity
948     (definition lists).
949   - Added "Embedded URIs".
950   - Updated "Interpreted Text" section.
951   - Added "Character-Level Inline Markup" section.
953 * test: Continually adding & updating tests.
955   - Moved test/test_rst/ to test/test_parsers/test_rst/.
956   - Moved test/test_pep/ to test/test_readers/test_pep/.
957   - Added test/test_readers/test_python/.
958   - Added test/test_writers/ (Engelbert Gruber).
960 * tools:
962   - Made the ``locale.setlocale()`` calls in front ends
963     fault-tolerant.
965 * tools/buildhtml.py:
967   - Added "--silent" option.
968   - Fixed bug with absolute paths & "--config".
969   - Updated for new I/O classes.
970   - Added some exception handling.
971   - Separated publishers' setting defaults; prevents interference.
972   - Updated for new ``publish_file()`` convenience function.
974 * tools/pep-html-template:
976   - Allow for "--embed-stylesheet".
977   - Added Docutils version to "generator" meta tag.
978   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
979   - Conform to XHTML spec.
981 * tools/pep2html.py:
983   - Made ``argv`` a parameter to ``main()``.
984   - Added support for "Content-Type:" header & arbitrary PEP formats.
985   - Linked "Content-Type: text/plain" to PEP 9.
986   - Files skipped (due to an error) are not pushed onto the server.
987   - Updated for new I/O classes.
988   - Added ``check_requirements()`` & ``pep_type_error()``.
989   - Added some exception handling.
990   - Updated for new ``publish_string()`` convenience function.
991   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
993 * tools/quicktest.py:
995   - Added "-V"/"--version" option.
997 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
999 * tools/unicode2rstsubs.py: Added to project.  Produces character
1000   entity files (reSructuredText substitutions) from the MathML master
1001   unicode.xml file.
1003 * tools/editors: Support code for editors, added to project.  Contains
1004   ``emacs/restructuredtext.el``.
1006 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1008   - Added style for chunks of inline literals.
1009   - Removed margin for first child of table cells.
1010   - Right-aligned field list names.
1011   - Support for auto-numbered section titles in TOCs.
1012   - Increased the size of inline literals (<tt>) in titles.
1013   - Restored the light gray background for inline literals.
1014   - Added support for "line_block" elements.
1015   - Added style for "address" elements.
1016   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1017   - Improved field list rendering.
1018   - Vertical whitespace improvements.
1019   - Removed "a.target" style.
1021 * tools/stylesheets/pep.css:
1023   - Fixed nested section margins.
1024   - Other changes parallel those of ``../default.css``.
1027 Release 0.2 (2002-07-31)
1028 ========================
1030 General:
1032 - The word "component" was being used ambiguously.  From now on,
1033   "component" will be used to mean "Docutils component", as in Reader,
1034   Writer, Parser, or Transform.  Portions of documents (Table of
1035   Contents, sections, etc.)  will be called "document parts".
1036 - Did a grand renaming: a lot of ``verylongnames`` became
1037   ``very_long_names``.
1038 - Cleaned up imports: no more relative package imports or
1039   comma-separated lists of top-level modules.
1040 - Added support for an option values object which carries default
1041   settings and overrides (from command-line options and library use).
1042 - Added internal Unicode support, and support for both input and
1043   output encodings.
1044 - Added support for the ``docutils.io.IO`` class & subclasses.
1046 Specific:
1048 * docutils/__init__.py:
1050   - Added ``ApplicationError`` and ``DataError``, for use throughout
1051     the package.
1052   - Added ``Component`` base class for Docutils components; implements
1053     the ``supports`` method.
1054   - Added ``__version__`` (thus, ``docutils.__version__``).
1056 * docutils/core.py:
1058   - Removed many keyword parameters to ``Publisher.__init__()`` and
1059     ``publish()``; bundled into an option values object.  Added
1060     "argv", "usage", "description", and "option_spec" parameters for
1061     command-line support.
1062   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1063     methods.
1064   - Reworked I/O model for ``docutils.io`` wrappers.
1065   - Updated ``Publisher.set_options()``; now returns option values
1066     object.
1067   - Added support for configuration files (/etc/docutils.conf,
1068     ./docutils.conf, ~/.docutils).
1069   - Added ``Publisher.setup_option_parser()``.
1070   - Added default usage message and description.
1072 * docutils/frontend.py: Added to project; support for front-end
1073   (command-line) scripts.  Option specifications may be augmented by
1074   components.  Requires Optik (http://optik.sf.net/) for option
1075   processing (installed locally as docutils/optik.py).
1077 * docutils/io.py: Added to project; uniform API for a variety of input
1078   output mechanisms.
1080 * docutils/nodes.py:
1082   - Added ``TreeCopyVisitor`` class.
1083   - Added a ``copy`` method to ``Node`` and subclasses.
1084   - Added a ``SkipDeparture`` exception for visitors.
1085   - Renamed ``TreePruningException`` from ``VisitorException``.
1086   - Added docstrings to ``TreePruningException``, subclasses, and
1087     ``Nodes.walk()``.
1088   - Improved docstrings.
1089   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1090   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1091     imports.
1092   - Added ``decoration``, ``header``, and ``footer`` node classes, and
1093     ``PreDecorative`` mixin.
1094   - Reworked the name/id bookkeeping; to ``document``, removed
1095     ``explicit_targets`` and ``implicit_targets`` attributes, added
1096     ``nametypes`` attribute and ``set_name_id_map`` method.
1097   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1098     traversals.
1099   - Added ``document.has_name()`` method.
1100   - Fixed DOM generation for list-attributes.
1101   - Added category class ``Labeled`` (used by footnotes & citations).
1102   - Added ``Element.set_class()`` method (sets "class" attribute).
1104 * docutils/optik.py: Added to project.  Combined from the Optik
1105   package, with added option groups and other modifications.  The use
1106   of this module is probably only temporary.
1108 * docutils/statemachine.py:
1110   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1111   - Added underscores to improve many awkward names.
1112   - In ``string2lines()``, changed whitespace normalizing translation
1113     table to regexp; restores Python 2.0 compatibility with Unicode.
1115 * docutils/urischemes.py:
1117   - Filled in some descriptions.
1118   - Added "shttp" scheme.
1120 * docutils/utils.py:
1122   - Added ``clean_rcs_keywords`` function (moved from
1123     docutils/transforms/frontmatter.py
1124     ``DocInfo.filter_rcs_keywords``).
1125   - Added underscores to improve many awkward names.
1126   - Changed names of Reporter's thresholds:
1127     warning_level -> report_level; error_level -> halt_level.
1128   - Moved ``utils.id()`` to ``nodes.make_id()``.
1129   - Added ``relative_path(source, target)``.
1131 * docutils/languages/de.py: German mappings; added to project.  Thanks
1132   to Gunnar Schwant for the translations.
1134 * docutils/languages/en.py: Added "Dedication" bibliographic field
1135   mappings.
1137 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1138   Chodorowski.
1140 * docutils/parsers/rst/states.py:
1142   - Added underscores to improve many awkward names.
1143   - Added RFC-2822 header support.
1144   - Extracted the inline parsing code from ``RSTState`` to a separate
1145     class, ``Inliner``, which will allow easy subclassing.
1146   - Made local bindings for ``memo`` container & often-used contents
1147     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
1148   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1149   - Added ``MarkupMismatch`` exception; for late corrections.
1150   - Added ``-/:`` characters to inline markup's start string prefix,
1151     ``/`` to end string suffix.
1152   - Fixed a footnote bug.
1153   - Fixed a bug with literal blocks.
1154   - Applied patch from Simon Budig: simplified regexps with symbolic
1155     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1156   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1157   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1158   - Allowed non-ASCII in "simple names" (directive names, field names,
1159     references, etc.).
1160   - Converted ``Inliner.patterns.initial`` to be dynamically built
1161     from parts with ``build_regexp()`` function.
1162   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1163   - Updated docstrings.
1164   - Changed "table" to "grid_table"; added "simple_table" support.
1166 * docutils/parsers/rst/tableparser.py:
1168   - Changed ``TableParser`` to ``GridTableParser``.
1169   - Added ``SimpleTableParser``.
1170   - Refactored naming.
1172 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1173   a fallback language for directive names.
1175 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1176   directive to use a ``pending`` element, used only by HTML writers.
1178 * docutils/parsers/rst/directives/parts.py: Renamed from
1179   components.py.
1181   - Added "backlinks" attribute to "contents" directive.
1183 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1184   project by Adam Chodorowski.
1186 * docutils/readers/__init__.py: Gave Readers more control over
1187   choosing and instantiating Parsers.
1189 * docutils/readers/pep.py: Added to project; for PEP processing.
1191 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1192   requires a ``component`` parameter.
1194 * docutils/transforms/components.py: Added to project; transforms
1195   related to Docutils components.
1197 * docutils/transforms/frontmatter.py:
1199   - In ``DocInfo.extract_authors``, check for a single "author" in an
1200     "authors" group, and convert it to a single "author" element.
1201   - Added support for "Dedication" and generic bibliographic fields.
1203 * docutils/transforms/peps.py: Added to project; PEP-specific.
1205 * docutils/transforms/parts.py: Renamed from old components.py.
1207   - Added filter for `Contents`, to use alt-text for inline images,
1208     and to remove inline markup that doesn't make sense in the ToC.
1209   - Added "name" attribute to TOC topic depending on its title.
1210   - Added support for optional TOC backlinks.
1212 * docutils/transforms/references.py: Fixed indirect target resolution
1213   in ``Hyperlinks`` transform.
1215 * docutils/transforms/universal.py:
1217   - Changed ``Messages`` transform to properly filter out system
1218     messages below the warning threshold.
1219   - Added ``Decorations`` transform (support for ``--generator``,
1220     ``--date``, ``--time``, ``--source-link`` options).
1222 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1223   Engelbert Gruber's PDF writer.
1225 * docutils/writers/html4css1.py:
1227   - Made XHTML-compatible (switched to lowercase element & attribute
1228     names; empty tag format).
1229   - Escape double-dashes in comment text.
1230   - Improved boilerplate & modularity of output.
1231   - Exposed modular output in Writer class.
1232   - Added a "generator" meta tag to <head>.
1233   - Added support for the ``--stylesheet`` option.
1234   - Added support for ``decoration``, ``header``, and ``footer``
1235     elements.
1236   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1237     translation table to regexp; restores Python 2.0 compatibility
1238     with Unicode.
1239   - Added the translator class as instance variable to the Writer, to
1240     make it easily subclassable.
1241   - Improved option list spacing (thanks to Richard Jones).
1242   - Modified field list output.
1243   - Added backlinks to footnotes & citations.
1244   - Added percentage widths to "<col>" tags (from colspec).
1245   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1246     "<span>" changed to "<var>".
1247   - Inline literals: "<code>" changed to "<tt>".
1248   - Many changes to optimize vertical space: compact simple lists etc.
1249   - Add a command-line options & directive attributes to control TOC
1250     and footnote/citation backlinks.
1251   - Added support for optional footnote/citation backlinks.
1252   - Added support for generic bibliographic fields.
1253   - Identify backrefs.
1254   - Relative URLs for stylesheet links.
1256 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1257   PEPs (subclass of ``html4css1.Writer``).
1259 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1261 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1262   of the Docutils internal doctree in XML.
1264 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1266 * spec/doctree.txt:
1268   - Changed the title to "The Docutils Document Tree".
1269   - Added "Hyperlink Bookkeeping" section.
1271 * spec/docutils.dtd:
1273   - Added ``decoration``, ``header``, and ``footer`` elements.
1274   - Brought ``interpreted`` element in line with the parser: changed
1275     attribute "type" to "role", added "position".
1276   - Added support for generic bibliographic fields.
1278 * spec/notes.txt: Continual updates.  Added "Project Policies".
1280 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
1281   section.
1283 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1285 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
1286   mailing list discussions.
1288 * spec/pep-0287.txt:
1290   - Renamed to "reStructuredText Docstring Format".
1291   - Minor edits.
1292   - Reworked Q&A as an enumerated list.
1293   - Converted to reStructuredText format.
1295 * spec/pysource.dtd:
1297   - Reworked structural elements, incorporating ideas from Tony Ibbs.
1299 * spec/pysource.txt: Removed from project.  Moved much of its contents
1300   to pep-0258.txt.
1302 * spec/rst/alternatives.txt:
1304   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1305   - Added "Inline External Targets" section.
1307 * spec/rst/directives.txt:
1309   - Added "backlinks" attribute to "contents" directive.
1311 * spec/rst/problems.txt:
1313   - Updated the Enumerated List Markup discussion.
1314   - Added new alternative table markup syntaxes.
1316 * spec/rst/reStructuredText.txt:
1318   - Clarified field list usage.
1319   - Updated enumerated list description.
1320   - Clarified purpose of directives.
1321   - Added ``-/:`` characters to inline markup's start string prefix,
1322     ``/`` to end string suffix.
1323   - Updated "Authors" bibliographic field behavior.
1324   - Changed "inline hyperlink targets" to "inline internal targets".
1325   - Added "simple table" syntax to supplement the existing but
1326     newly-renamed "grid tables".
1327   - Added cautions for anonymous hyperlink use.
1328   - Added "Dedication" and generic bibliographic fields.
1330 * test: Made test modules standalone (subdirectories became packages).
1332 * test/DocutilsTestSupport.py:
1334   - Added support for PEP extensions to reStructuredText.
1335   - Added support for simple tables.
1336   - Refactored naming.
1338 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1340   - Now supports true packages containing test modules
1341     (``__init__.py`` files required); fixes duplicate module name bug.
1343 * test/test_pep/: Subpackage added to project; PEP testing.
1345 * test/test_rst/test_SimpleTableParser.py: Added to project.
1347 * tools:
1349   - Updated html.py and publish.py front-end tools to use the new
1350     command-line processing facilities of ``docutils.frontend``
1351     (exposed in ``docutils.core.Publisher``), reducing each to just a
1352     few lines of code.
1353   - Added ``locale.setlocale()`` calls to front-end tools.
1355 * tools/buildhtml.py: Added to project; batch-generates .html from all
1356   the .txt files in directories and subdirectories.
1358 * tools/default.css:
1360   - Added support for ``header`` and ``footer`` elements.
1361   - Added styles for "Dedication" topics (biblio fields).
1363 * tools/docutils.conf: A configuration file; added to project.
1365 * tools/docutils-xml.py: Added to project.
1367 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1369 * tools/pep-html-template: Added to project.
1371 * tools/pep2html.py: Added to project from Python (nondist/peps).
1372   Added support for Docutils (reStructuredText PEPs).
1374 * tools/quicktest.py:
1376   - Added the ``--attributes`` option, hacked a bit.
1377   - Added a second command-line argument (output file); cleaned up.
1379 * tools/stylesheets/: Subdirectory added to project.
1381 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1384 Release 0.1 (2002-04-20)
1385 ========================
1387 This is the first release of Docutils, merged from the now inactive
1388 reStructuredText__ and `Docstring Processing System`__ projects.  For
1389 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1390 `DPS HISTORY`__ files.
1392 __ http://structuredtext.sourceforge.net/
1393 __ http://docstring.sourceforge.net/
1394 __ http://structuredtext.sourceforge.net/HISTORY.html
1395 __ http://docstring.sourceforge.net/HISTORY.html
1397 General changes: renamed 'dps' package to 'docutils'; renamed
1398 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1399 the test suites (reStructuredText's test/test_states renamed to
1400 test/test_rst); and all modifications required to make it all work.
1402 * docutils/parsers/rst/states.py:
1404   - Improved diagnostic system messages for missing blank lines.
1405   - Fixed substitution_reference bug.
1409    Local Variables:
1410    mode: indented-text
1411    indent-tabs-mode: nil
1412    sentence-end-double-space: t
1413    fill-column: 70
1414    End: