5 :Authors: David Goodger, and all Docutils developers
6 :Contact: goodger@python.org
8 :Web site: http://docutils.sourceforge.net/
9 :Copyright: This document has been placed in the public domain.
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,
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
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.
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!
73 * docutils/__init__.py:
75 - 0.3.1: Reorganized config file format (multiple sections); see
77 - Added unknown_reference_resolvers attribute to TransformSpec.
78 - 0.3.2: Interpreted text reorganization.
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
91 * docutils/examples.py: Added to project; practical examples of
92 Docutils client code, to be used as-is or as models for variations.
94 * docutils/frontend.py:
96 - Added "--traceback" & "--no-traceback" options ("traceback"
98 - Implemented support for config file reorganization:
99 ``standard_config_files`` moved from ``ConfigParser`` to
100 ``OptionParser``; added
101 ``OptionParser.get_config_file_settings()`` and
102 ``.get_standard_config_settings()``; support for old "[options]"
103 section (with deprecation warning) and mapping from old to new
105 - Reimplemented setting validation.
106 - Enabled flexible boolean values: yes/no, true/false, on/off.
107 - Added ``Values``, a subclass of ``optparse.Values``, with support
108 for list setting attributes.
109 - Added support for new ``DOCUTILSCONFIG`` environment variable;
110 thanks to Beni Cherniavsky.
111 - Added "--no-section-numbering" option.
115 - Catch IOErrors when opening source & destination files, report &
116 exit without tracebacks. Added ``handle_io_errors`` parameter to
117 ``FileInput`` & ``FileOutput`` to enable caller error handling.
121 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
122 method definitions (via ``exec``) to dynamic assignments (via
123 ``setattr``); thanks to Roman Suzi.
124 - Encapsulated visitor dynamic assignments in a function; thanks to
126 - Added indirect_reference_name attribute to the Targetable
127 class. This attribute holds the whitespace_normalized_name
128 (contains mixed case) of a target.
130 * docutils/statemachine.py:
132 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
133 - Added ``StringList.get_2D_block``.
137 - Added "level" attribute to SystemMessage exceptions.
139 * docutils/languages/af.py: Added to project; Afrikaans mappings by
142 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
145 * docutils/languages/eo.py: Added to project; Esperanto mappings by
146 Marcelo Huerta San Martin.
148 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
149 mappings by Lalo Martins.
151 * docutils/languages/ru.py: Added to project; Russian mappings by
154 * docutils/parsers/rst/roles.py: Added to project. Contains
155 interpreted text role functions, a registry for interpreted text
156 roles, and an API for adding to and retrieving from the registry.
157 Contributed by Edward Loper.
159 * docutils/parsers/rst/states.py:
161 - Updated ``RSTState.nested_parse`` for "include" in table cells.
162 - Allowed true em-dash character and "---" as block quote
164 - Added support for <angle-bracketed> complex option arguments
166 - Fixed handling of backslashes in substitution definitions.
167 - Fixed off-by-1 error with extra whitespace after substitution
168 definition directive.
169 - Added inline markup parsing to field lists' field names.
170 - Added support for quoted (and unindented) literal blocks.
171 Driven in part by a bribe from Frank Siebenlist (thanks!).
172 - Parser now handles escapes in URIs correctly.
173 - Made embedded-URIs' reference text omittable. Idea from Beni
175 - Refactored explicit target processing code.
176 - Added name attribute to references containing the reference name only
177 through whitespace_normalize_name (no case changes).
178 - parse_target no longer returns the refname after going through
179 normalize_name. This is now handled in make_target.
180 - Fixed bug relating to role-less interpreted text in non-English
182 - Reorganized interpreted text processing; moved code into the new
183 roles.py module. Contributed by Edward Loper.
184 - Refactored ``Body.parse_directive`` into ``run_directive`` and
185 ``parse_directive_block``.
187 * docutils/parsers/rst/tableparser.py:
189 - Reworked for ``StringList``, to support "include" directives in
192 * docutils/parsers/rst/directives/__init__.py:
194 - Renamed ``unchanged()`` directive option conversion function to
195 ``unchanged_required``, and added a new ``unchanged``.
196 - Catch unicode value too high error; fixes bug 781766.
197 - Beefed up directive error reporting.
199 * docutils/parsers/rst/directives/body.py:
201 - Added basic "table" directive.
203 * docutils/parsers/rst/directives/images.py:
205 - Added "target" option to "image" directive.
206 - Added name attribute to references containing the reference name only
207 through whitespace_normalize_name (no case changes).
209 * docutils/parsers/rst/directives/misc.py:
211 - Isolated the import of the ``urllib2`` module; was causing
212 problems on SourceForge (``libssl.so.2`` unavailable?).
213 - Added the "role" directive for declaring custom interpreted text
216 * docutils/parsers/rst/directives/parts.py:
218 - The "contents" directive does more work up-front, creating the
219 "topic" and "title", and leaving the "pending" node for the
220 transform. Allows earlier reference resolution; fixes subtle bug.
222 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
223 mappings by Jannie Hofmeyr.
225 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
226 mappings by Marek Blaha.
228 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
229 mappings by Marcelo Huerta San Martin.
231 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
232 Portuguese mappings by Lalo Martins.
234 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
235 mappings by Roman Suzi.
237 * docutils/transforms/parts.py:
239 - The "contents" directive does more work up-front, creating the
240 "topic" and "title", and leaving the "pending" node for the
241 transform. Allows earlier reference resolution; fixes subtle bug.
242 - Added support for disabling of section numbering.
244 * docutils/transforms/references.py:
246 - Verifying that external targets are truly targets and not indirect
247 references. This is because we are now adding a "name" attribute to
248 references in addition to targets. Note sure if this is correct!
249 - Added code to hook into the unknown_reference_resolvers list for a
250 transformer in resolve_indirect_target. This allows the
251 unknown_reference_resolvers to keep around indirect targets which
252 docutils doesn't know about.
253 - Added specific error message for duplicate targets.
255 * docutils/transforms/universal.py:
257 - Added FilterMessages transform (removes system messages below the
258 verbosity threshold).
259 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
260 to FinalCheckVisitor for application-specific handling of
261 unresolvable references.
262 - Added specific error message for duplicate targets.
264 * docutils/writers/__init__.py:
266 - Added assemble_parts method to the Writer class to allow for
267 access to a documents individual parts.
268 - Documented & set default for ``Writer.output`` attribute.
270 * docutils/writers/html4css1.py:
272 - Fixed unicode handling of attribute values (bug 760673).
273 - Prevent duplication of "class" attribute values (bug report from
275 - Improved table grid/border handling (prompted by report from Bob
277 - Added support for table titles.
278 - Added "<title />" for untitled docs, for XHTML conformance; thanks
280 - Added functionality to keep track of individual parts of a document
281 and store them in a dictionary as the "parts" attribute of the writer.
282 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
283 - Added proper support for the "scale" attribute of the "image"
284 element. Contributed by Brent Cook.
285 - Added ``--initial-header-level`` option.
286 - Fixed bug: the body_pre_docinfo segment depended on there being a
287 docinfo; if no docinfo, the document title was incorporated into
288 the body segment. Adversely affected the publish_parts interface.
290 * docutils/writers/latex2e.py:
292 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
293 about a missing file.
294 - Added options and support: ``--compound-enumerators``,
295 ``--section-prefix-for-enumerators``, and
296 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
298 - Added option ``--use-verbatim-when-possible``, to avoid
299 problematic characters (eg, '~' in italian) in literal blocks.
300 - It's now possible to use four section levels in the `book` and
301 `report` LaTeX classes. The default `article` class still has
304 * docs/config.txt: "Docutils Configuration Files", added to project.
305 Moved config file entry descriptions from tools.txt.
309 - Moved config file entry descriptions to config.txt.
311 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
314 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
315 Text Roles", added to project.
317 * spec/rst/reStructuredText.txt:
319 - Added description of support for <angle-bracketed> complex option
320 arguments to option lists.
321 - Added subsections for indented and quoted literal blocks.
323 * test: Continually adding & updating tests.
325 - Added test/test_settings.py & test/data/config_*.txt support
327 - Added test/test_writers/test_htmlfragment.py.
329 * test/DocutilsTestSupport.py:
331 - Refactored LaTeX publisher test suite/case class names to make
332 testing other writers easier.
333 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
334 to test the processing of HTML fragments which use the new
335 publish_parts convenience function.
337 * tools/buildhtml.py:
339 - Added support for the "--prune" option.
341 * tools/docutils.conf:
343 - Updated for configuration file reorganization.
347 - copied from tools/html.py
351 - added a 'scripts' section to configuration
352 - added 'tools/rst2html.py' to the scripts section
355 Release 0.3 (2003-06-24)
356 ========================
360 * Renamed "attribute" to "option" for directives/extensions.
362 * Renamed transform method "transform" to "apply".
364 * Renamed "options" to "settings" for runtime settings (as set by
365 command-line options). Sometimes "option" (singular) became
366 "settings" (plural). Some variations below:
368 - document.options -> document.settings (stored in other objects as
370 - option_spec -> settings_spec (not directives though)
371 - OptionSpec -> SettingsSpec
372 - cmdline_options -> settings_spec
373 - relative_path_options -> relative_path_settings
374 - option_default_overrides -> settings_default_overrides
375 - Publisher.set_options -> Publisher.get_settings
379 * COPYING.txt: Added "Public Domain Dedication".
381 * FAQ.txt: Frequently asked questions, added to project.
385 - Updated with PyPI Trove classifiers.
386 - Conditional installation of third-party modules.
388 * docutils/__init__.py:
390 - Bumped version to 0.2.1 to reflect changes to I/O classes.
391 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
392 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
393 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
394 option and its effect on the PEP template & writer.
395 - Bumped version to 0.2.4 due to changes to the PEP template &
397 - Bumped version to 0.2.5 to reflect changes to Reporter output.
398 - Added ``TransformSpec`` class for new transform system.
399 - Bumped version to 0.2.6 for API changes (renaming).
400 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
401 convenience functions.
402 - Added ``Component.component_type`` attribute.
403 - Bumped version to 0.2.8 because of the internal parser switch from
404 plain lists to the docutils.statemachine.StringList objects.
405 - Bumped version to 0.2.9 because of the frontend.py API changes.
406 - Bumped version to 0.2.10 due to changes to the project layout
407 (third-party modules removed from the "docutils" package), and
408 signature changes in ``io.Input``/``io.Output``.
409 - Changed version to 0.3.0 for release.
413 - Made ``publish()`` a bit more convenient.
414 - Generalized ``Publisher.set_io``.
415 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
416 parameters; improved its docstring.
417 - Added ``publish_file()`` and ``publish_string()``.
418 - Factored ``Publisher.set_source()`` and ``.set_destination()``
420 - Added support for "--dump-pseudo-xml", "--dump-settings", and
421 "--dump-transforms" hidden options.
422 - Added ``Publisher.apply_transforms()`` method.
423 - Added ``Publisher.set_components()`` method; support for
424 ``publish_*()`` conveninece functions.
425 - Moved config file processing to docutils/frontend.py.
426 - Added support for exit status ("exit_level" setting &
427 ``enable_exit`` parameter for Publisher.publish() and convenience
430 * docutils/frontend.py:
432 - Check for & exit on identical source & destination paths.
433 - Fixed bug with absolute paths & "--config".
434 - Set non-command-line defaults in ``OptionParser.__init__()``:
435 ``_source`` & ``_destination``.
436 - Distributed ``relative_path_settings`` to components; updated
437 ``OptionParser.populate_from_components()`` to combine it all.
438 - Require list of keys in ``make_paths_absolute`` (was implicit in
439 global ``relative_path_settings``).
440 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
441 "--dump-settings", and "--dump-transforms" hidden options.
442 - Removed nasty internals-fiddling ``ConfigParser.get_section``
443 code, replaced with correct code.
444 - Added validation functionality for config files.
445 - Added "--error-encoding" option/setting, "_disable_config"
447 - Added encoding validation; updated "--input-encoding" and
448 "--output-encoding"; added "--error-encoding-error-handler" and
449 "--output-encoding-error-handler".
450 - Moved config file processing from docutils/core.py.
451 - Updated ``OptionParser.populate_from_components`` to handle new
452 ``SettingsSpec.settings_defaults`` dict.
453 - Added support for "-" => stdin/stdout.
454 - Added "exit_level" setting ("--exit" option).
458 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
459 - Added automatic closing to ``FileInput`` and ``FileOutput``.
460 - Delayed opening of ``FileOutput`` file until ``write()`` called.
461 - ``FileOutput.write()`` now returns the encoded output string.
462 - Try to get path/stream name automatically in ``FileInput`` &
464 - Added defaults for source & destination paths.
465 - Allow for Unicode I/O with an explicit "unicode" encoding.
466 - Added ``Output.encode()``.
467 - Removed dependency on runtime settings; pass encoding directly.
468 - Recognize Unicode strings in ``Input.decode()``.
469 - Added support for output encoding error handlers.
473 - Added "Invisible" element category class.
474 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
475 modification during a traversal.
476 - Added element classes: ``line_block``, ``generated``, ``address``,
477 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
478 ``superscript``, ``subscript``, ``inline``
479 - Added support for lists of nodes to ``Element.insert()``.
480 - Fixed parent linking in ``Element.replace()``.
481 - Added new abstract superclass ``FixedTextElement``; adds
482 "xml:space" attribute.
483 - Added support for "line" attribute of ``system_message`` nodes.
484 - Added support for the observer pattern from ``utils.Reporter``.
485 Added ``parse_messages`` and ``transform_messages`` attributes to
486 ``document``, removed ``messages``. Added ``note_parse_message``
487 and ``note_transform_message`` methods.
488 - Added support for improved diagnostics:
490 - Added "document", "source", and "line" internal attributes to
491 ``Node``, set by ``Node.setup_child()``.
492 - Converted variations on ``node.parent = self`` to
493 ``self.setup_child(node)``.
494 - Added ``document.current_source`` & ``.current_line``
495 attributes, and ``.note_source`` observer method.
496 - Changed "system_message" output to GNU-Tools format.
498 - Added a "rawsource" attribute to the ``Text`` class, for text
499 before backslash-escape resolution.
500 - Support for new transform system.
501 - Reworked ``pending`` element.
502 - Fixed XML DOM bug (SF #660611).
503 - Removed the ``interpeted`` element class and added
504 ``title_reference``, ``abbreviation``, ``acronym``.
505 - Made substitutions case-sensitive-but-forgiving; moved some code
507 - Fixed Unicode bug on element attributes (report: William Dode).
509 * docutils/optik.py: Removed from project; replaced with
510 extras/optparse.py and extras/textwrap.py. These will be installed
511 only if they're not already present in the Python installation.
513 * docutils/roman.py: Moved to extras/roman.py; this will be installed
514 only if it's not already present in the Python installation.
516 * docutils/statemachine.py:
518 - Factored out ``State.add_initial_transitions()`` so it can be
520 - Converted whitespace-specific "blank" and "indent" transitions
521 from special-case code to ordinary transitions: removed
522 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
523 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
524 ``ws_initial_transitions`` attributes.
525 - Removed ``State.match_transition()`` after merging it into
527 - Added ``StateCorrection`` exception.
528 - Added support for ``StateCorrection`` in ``StateMachine.run()``
529 (moved ``TransitionCorrection`` support there too.)
530 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
531 ``EOFError`` instead of ``IndexError``.
532 - Added ``State.no_match`` method.
533 - Added support for the Observer pattern, triggered by input line
535 - Added ``strip_top`` parameter to
536 ``StateMachineWS.get_first_known_indented``.
537 - Made ``context`` a parameter to ``StateMachine.run()``.
538 - Added ``ViewList`` & ``StringList`` classes;
539 ``extract_indented()`` becomes ``StringList.get_indented()``.
540 - Added ``StateMachine.insert_input()``.
541 - Fixed ViewList slice handling for Python 2.3. Patch from (and
542 thanks to) Fred Drake.
546 - Added a ``source`` attribute to Reporter instances and
547 ``system_message`` elements.
548 - Added an observer pattern to ``utils.Reporter`` to keep track of
550 - Fixed bugs in ``relative_path()``.
551 - Added support for improved diagnostics.
552 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
553 - Added support for encoding Reporter stderr output, and encoding
555 - Reporter keeps track of the highest level system message yet
558 * docutils/languages: Fixed bibliographic field language lookups.
560 * docutils/languages/es.py: Added to project; Spanish mappings by
561 Marcelo Huerta San Martin.
563 * docutils/languages/fr.py: Added to project; French mappings by
566 * docutils/languages/it.py: Added to project; Italian mappings by
569 * docutils/languages/sk.py: Added to project; Slovak mappings by
572 * docutils/parser/__init__.py:
574 - Added ``Parser.finish_parse()`` method.
576 * docutils/parser/rst/__init__.py:
578 - Added options: "--pep-references", "--rfc-references",
579 "--tab-width", "--trim-footnote-reference-space".
581 * docutils/parsers/rst/states.py:
583 - Changed "title under/overline too short" system messages from INFO
584 to WARNING, and fixed its insertion location.
585 - Fixed enumerated list item parsing to allow paragraphs & section
586 titles to begin with enumerators.
587 - Converted system messages to use the new "line" attribute.
588 - Fixed a substitution reference edge case.
589 - Added support for "--pep-references" and "--rfc-references"
590 options; reworked ``Inliner`` code to make customization easier.
591 - Removed field argument parsing.
592 - Added support for short section title over/underlines.
593 - Fixed "simple reference name" regexp to ignore text like
594 "object.__method__"; not an anonymous reference.
595 - Added support for improved diagnostics.
596 - Reworked directive API, based on Dethe Elza's contribution. Added
597 ``Body.parse_directive()``, ``.parse_directive_options()``,
598 ``.parse_directive_arguments()`` methods.
599 - Added ``ExtensionOptions`` class, to parse directive options
600 without parsing field bodies. Factored
601 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
602 ``ExtensionOptions``.
603 - Improved definition list term/classifier parsing.
604 - Added warnings for unknown directives.
605 - Renamed ``Stuff`` to ``Struct``.
606 - Now flagged as errors: transitions at the beginning or end of
607 sections, empty sections (except title), and empty documents.
608 - Updated for ``statemachine.StringList``.
609 - Enabled recognition of schemeless email addresses in targets.
610 - Added support for embedded URIs in hyperlink references.
611 - Added backslash-escapes to inline markup end-string suffix.
612 - Added support for correct interpreted text processing.
613 - Fixed nested title parsing (topic, sidebar directives).
614 - Added special processing of backslash-escaped whitespace (idea
615 from David Abrahams).
616 - Made substitutions case-sensitive-but-forgiving; moved some code
617 to ``docutils.nodes``.
618 - Added support for block quote attributions.
619 - Added a kludge to work-around a conflict between the bubble-up
620 parser strategy and short titles (<= 3 char-long over- &
621 underlines). Fixes SF bug #738803 "infinite loop with multiple
622 titles" submitted by Jason Diamond.
623 - Added explicit interpreted text roles for standard inline markup:
624 "emphasis", "strong", "literal".
625 - Implemented "superscript" and "subscript" interpreted text roles.
626 - Added initial support for "abbreviation" and "acronym" roles;
628 - Added support for "--trim-footnote-reference-space" option.
629 - Optional space before colons in directives & hyperlink targets.
631 * docutils/parsers/rst/tableparser.py:
633 - Fixed a bug that was producing unwanted empty rows in "simple"
635 - Detect bad column spans in "simple" tables.
637 * docutils/parsers/rst/directives: Updated all directive functions to
640 * docutils/parsers/rst/directives/__init__.py:
642 - Added ``flag()``, ``unchanged()``, ``path()``,
643 ``nonnegative_int()``, ``choice()``, and ``class_option()``
644 directive option helper functions.
645 - Added warnings for unknown directives.
646 - Return ``None`` for missing directives.
647 - Added ``register_directive()``, thanks to William Dode and Paul
650 * docutils/parsers/rst/directives/admonitions.py:
652 - Added "admonition" directive.
654 * docutils/parsers/rst/directives/body.py: Added to project. Contains
655 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
656 "parsed-literal", "rubric", "epigraph", "highlights" and
657 "pull-quote" directives.
659 * docutils/parsers/rst/directives/images.py:
661 - Added an "align" attribute to the "image" & "figure" directives
662 (by Adam Chodorowski).
663 - Added "class" option to "image", and "figclass" to "figure".
665 * docutils/parsers/rst/directives/misc.py:
667 - Added "include", "raw", and "replace" directives, courtesy of
669 - Added "unicode" and "class" directives.
671 * docutils/parsers/rst/directives/parts.py:
673 - Added the "sectnum" directive; by Dmitry Jemerov.
674 - Added "class" option to "contents" directive.
676 * docutils/parsers/rst/directives/references.py: Added to project.
677 Contains the "target-notes" directive.
679 * docutils/parsers/rst/languages/__init__.py:
681 - Return ``None`` from get_language() for missing language modules.
683 * docutils/parsers/rst/languages/de.py: Added to project; German
684 mappings by Engelbert Gruber.
686 * docutils/parsers/rst/languages/en.py:
688 - Added interpreted text roles mapping.
690 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
691 mappings by Marcelo Huerta San Martin.
693 * docutils/parsers/rst/languages/fr.py: Added to project; French
694 mappings by William Dode.
696 * docutils/parsers/rst/languages/it.py: Added to project; Italian
697 mappings by Nicola Larosa.
699 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
700 mappings by Miroslav Vasko.
702 * docutils/readers/__init__.py:
704 - Added support for the observer pattern from ``utils.Reporter``, in
705 ``Reader.parse`` and ``Reader.transform``.
706 - Removed ``Reader.transform()`` method.
707 - Added default parameter values to ``Reader.__init__()`` to make
708 instantiation easier.
709 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
711 * docutils/readers/pep.py:
713 - Added the ``peps.TargetNotes`` transform to the Reader.
714 - Removed PEP & RFC reference detection code; moved to
715 parsers/rst/states.py as options (enabled here by default).
716 - Added support for pre-acceptance PEPs (no PEP number yet).
717 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
720 * docutils/readers/python: Python Source Reader subpackage added to
721 project, including preliminary versions of:
724 - moduleparser.py: Parser for Python modules.
726 * docutils/transforms/__init__.py:
728 - Added ``Transformer`` class and completed transform reform.
729 - Added unknown_reference_resolvers list for each transformer. This list holds
730 the list of functions provided by each component of the transformer that
731 help resolve references.
733 * docutils/transforms/frontmatter.py:
735 - Improved support for generic fields.
736 - Fixed bibliographic field language lookups.
738 * docutils/transforms/misc.py: Added to project. Miscellaneous
741 * docutils/transforms/parts.py:
743 - Moved the "id" attribute from TOC list items to the references
744 (``Contents.build_contents()``).
745 - Added the ``SectNum`` transform; by Dmitry Jemerov.
746 - Added "class" attribute support to ``Contents``.
748 * docutils/transforms/peps.py:
750 - Added ``mask_email()`` function, updating to pep2html.py's
752 - Linked "Content-Type: text/x-rst" to PEP 12.
753 - Added the ``TargetNotes`` PEP-specific transform.
754 - Added ``TargetNotes.cleanup_callback``.
755 - Added title check to ``Headers``.
757 * docutils/transforms/references.py:
759 - Added the ``TargetNotes`` generic transform.
760 - Split ``Hyperlinks`` into multiple transforms.
761 - Fixed bug with multiply-indirect references (report: Bruce Smith).
762 - Added check for circular indirect references.
763 - Made substitutions case-sensitive-but-forgiving.
765 * docutils/transforms/universal.py:
767 - Added support for the "--expose-internal-attributes" option.
768 - Removed ``Pending`` transform classes & data.
770 * docutils/writers/__init__.py:
772 - Removed ``Writer.transform()`` method.
774 * docutils/writers/docutils-xml.py:
776 - Added XML and doctype declarations.
777 - Added "--no-doctype" and "--no-xml-declaration" options.
779 * docutils/writers/html4css1.py:
781 - "name" attributes only on these tags: a, applet, form, frame,
783 - Added "name" attribute to <a> in section titles for Netscape 4
784 support (bug report: Pearu Peterson).
785 - Fixed targets (names) on footnote, citation, topic title,
786 problematic, and system_message nodes (for Netscape 4).
787 - Changed field names from "<td>" to "<th>".
788 - Added "@" to "@" encoding to thwart address harvesters.
789 - Improved the vertical whitespace optimization; ignore "invisible"
790 nodes (targets, comments, etc.).
791 - Improved inline literals with ``<span class="pre">`` around chunks
792 of text and `` `` for runs of spaces.
793 - Improved modularity of output; added ``self.body_pre_docinfo`` and
794 ``self.docinfo`` segments.
795 - Added support for "line_block", "address" elements.
796 - Improved backlinks (footnotes & system_messages).
797 - Improved system_message output.
798 - Redefined "--stylesheet" as containing an invariant URL, used
799 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
801 - Added "--footnote-references" option (superscript or brackets).
802 - Added "--compact-lists" and "--no-compact-lists" options.
803 - Added "--embed-stylesheet" and "--link-stylesheet" options;
804 factored out ``HTMLTranslator.get_stylesheet_reference()``.
805 - Improved field list rendering.
806 - Added Docutils version to "generator" meta tag.
807 - Fixed a bug with images; they must be inline, so wrapped in <p>.
808 - Improved layout of <pre> HTML source.
809 - Fixed attribute typo on <colspec>.
810 - Refined XML prologue.
811 - Support for no stylesheet.
812 - Removed "interpreted" element support.
813 - Added support for "title_reference", "sidebar", "attribution",
814 "rubric", and generic "admonition" elements.
815 - Added "--attribution" option.
816 - Added support for "inline", "subscript", "superscript" elements.
817 - Added initial support for "abbreviation" and "acronym";
820 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
824 - Double quotes in literal blocks (special treatment for de/ngerman).
825 - Added '--hyperlink-color' option ('0' turns off coloring of links).
826 - Added "--attribution" option.
827 - Right align attributions.
829 * docutils/writers/pep_html.py:
831 - Parameterized output encoding in PEP template.
832 - Reworked substitutions from ``locals()`` into ``subs`` dict.
833 - Redefined "--pep-stylesheet" as containing an invariant URL, used
834 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
836 - Added an override on the "--footnote-references" option.
837 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
838 - Added Docutils version to "generator" meta tag.
839 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
843 - Added a "silent" setting for ``buildhtml.py``.
844 - Added a "Getting Help" section.
845 - Rearranged the structure.
846 - Kept up to date, with new settings, command-line options etc.
847 - Added section for ``rst2latex.py`` (Engelbert Gruber).
848 - Converted settings table into a definition list.
850 * docs/rst/quickstart.txt:
852 - Added a table of contents.
853 - Added feedback information.
854 - Added mention of minimum section title underline lengths.
855 - Removed the 4-character minimum for section title underlines.
857 * docs/rst/quickref.html:
859 - Added a "Getting Help" section.
860 - Added a style to make section title backlinks more subtle.
861 - Added mention of minimum section title underline lengths.
862 - Removed the 4-character minimum for section title underlines.
864 * extras: Directory added to project; contains third-party modules
865 that Docutils depends on (optparse, textwrap, roman). These are
866 only installed if they're not already present.
868 * licenses: Directory added to project; contains copies of license
869 files for non-public-domain files.
873 - Changed the focus. It's about DTD elements: structural
874 relationships, semantics, and external (public) attributes. Not
875 about the element class library.
876 - Moved some implementation-specific stuff into ``docutils.nodes``
878 - Wrote descriptions of all common attributes and parameter
879 entities. Filled in introductory material.
880 - Working through the element descriptions: 55 down, 37 to go.
881 - Removed "Representation of Horizontal Rules" to
882 spec/rst/alternatives.txt.
886 - Added "generated" inline element.
887 - Added "line_block" body element.
888 - Added "auto" attribute to "title".
889 - Changed content models of "literal_block" and "doctest_block" to
891 - Added ``%number;`` attribute type parameter entity.
892 - Changed ``%structural.elements;`` to ``%section.elements``.
893 - Updated attribute types; made more specific.
894 - Added "address" bibliographic element.
895 - Added "line" attribute to ``system_message`` element.
896 - Removed "field_argument" element; "field_name" may contain
897 multiple words and whitespace.
898 - Changed public identifier to docutils.sf.net.
899 - Removed "interpreted" element; added "title_reference",
900 "abbreviation", "acronym".
901 - Removed "refuri" attribute from "footnote_reference" and
902 "citation_reference".
903 - Added "sidebar", "rubric", "attribution", "admonition",
904 "superscript", "subscript", and "inline" elements.
906 * spec/pep-0256.txt: Converted to reStructuredText & updated.
908 * spec/pep-0257.txt: Converted to reStructuredText & updated.
910 * spec/pep-0258.txt: Converted to reStructuredText & updated.
912 * spec/semantics.txt: Updated with text from a Doc-SIG response to
915 * spec/transforms.txt: Added to project.
917 * spec/howto: Added subdirectory, for developer how-to docs.
919 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
920 Elza, edited & extended by David Goodger.
922 * spec/howto/i18n.txt: Docutils Internationalization. Added to
925 * spec/rst/alternatives.txt:
927 - Added "Doctree Representation of Transitions" from
929 - Updated "Inline External Targets" & closed the debate.
930 - Added ideas for interpreted text syntax extensions.
931 - Added "Nested Inline Markup" section.
933 * spec/rst/directives.txt:
935 - Added directives: "topic", "sectnum", "target-notes",
936 "line-block", "parsed-literal", "include", "replace", "sidebar",
937 "admonition", "rubric", "epigraph", "highlights", "unicode" and
939 - Formalized descriptions of directive details.
940 - Added an "align" attribute to the "image" & "figure" directives
941 (by Adam Chodorowski).
942 - Added "class" options to "topic", "sidebar", "line-block",
943 "parsed-literal", "contents", and "image"; and "figclass" to
946 * spec/rst/interpreted.txt: Added to project. Descriptions of
947 interpreted text roles.
949 * spec/rst/introduction.txt:
951 - Added pointers to material for new users.
953 * spec/rst/reStructuredText.txt:
955 - Disambiguated comments (just add a newline after the "::").
956 - Updated enumerated list description; added a discussion of the
957 second-line validity checking.
958 - Updated directive description.
959 - Added a note redirecting newbies to the user docs.
960 - Expanded description of inline markup start-strings in non-markup
962 - Removed field arguments and made field lists a generic construct.
963 - Removed the 4-character minimum for section title underlines.
964 - Clarified term/classifier delimiter & inline markup ambiguity
966 - Added "Embedded URIs".
967 - Updated "Interpreted Text" section.
968 - Added "Character-Level Inline Markup" section.
970 * test: Continually adding & updating tests.
972 - Moved test/test_rst/ to test/test_parsers/test_rst/.
973 - Moved test/test_pep/ to test/test_readers/test_pep/.
974 - Added test/test_readers/test_python/.
975 - Added test/test_writers/ (Engelbert Gruber).
979 - Made the ``locale.setlocale()`` calls in front ends
982 * tools/buildhtml.py:
984 - Added "--silent" option.
985 - Fixed bug with absolute paths & "--config".
986 - Updated for new I/O classes.
987 - Added some exception handling.
988 - Separated publishers' setting defaults; prevents interference.
989 - Updated for new ``publish_file()`` convenience function.
991 * tools/pep-html-template:
993 - Allow for "--embed-stylesheet".
994 - Added Docutils version to "generator" meta tag.
995 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
996 - Conform to XHTML spec.
1000 - Made ``argv`` a parameter to ``main()``.
1001 - Added support for "Content-Type:" header & arbitrary PEP formats.
1002 - Linked "Content-Type: text/plain" to PEP 9.
1003 - Files skipped (due to an error) are not pushed onto the server.
1004 - Updated for new I/O classes.
1005 - Added ``check_requirements()`` & ``pep_type_error()``.
1006 - Added some exception handling.
1007 - Updated for new ``publish_string()`` convenience function.
1008 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1010 * tools/quicktest.py:
1012 - Added "-V"/"--version" option.
1014 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1016 * tools/unicode2rstsubs.py: Added to project. Produces character
1017 entity files (reSructuredText substitutions) from the MathML master
1020 * tools/editors: Support code for editors, added to project. Contains
1021 ``emacs/restructuredtext.el``.
1023 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1025 - Added style for chunks of inline literals.
1026 - Removed margin for first child of table cells.
1027 - Right-aligned field list names.
1028 - Support for auto-numbered section titles in TOCs.
1029 - Increased the size of inline literals (<tt>) in titles.
1030 - Restored the light gray background for inline literals.
1031 - Added support for "line_block" elements.
1032 - Added style for "address" elements.
1033 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1034 - Improved field list rendering.
1035 - Vertical whitespace improvements.
1036 - Removed "a.target" style.
1038 * tools/stylesheets/pep.css:
1040 - Fixed nested section margins.
1041 - Other changes parallel those of ``../default.css``.
1044 Release 0.2 (2002-07-31)
1045 ========================
1049 - The word "component" was being used ambiguously. From now on,
1050 "component" will be used to mean "Docutils component", as in Reader,
1051 Writer, Parser, or Transform. Portions of documents (Table of
1052 Contents, sections, etc.) will be called "document parts".
1053 - Did a grand renaming: a lot of ``verylongnames`` became
1054 ``very_long_names``.
1055 - Cleaned up imports: no more relative package imports or
1056 comma-separated lists of top-level modules.
1057 - Added support for an option values object which carries default
1058 settings and overrides (from command-line options and library use).
1059 - Added internal Unicode support, and support for both input and
1061 - Added support for the ``docutils.io.IO`` class & subclasses.
1065 * docutils/__init__.py:
1067 - Added ``ApplicationError`` and ``DataError``, for use throughout
1069 - Added ``Component`` base class for Docutils components; implements
1070 the ``supports`` method.
1071 - Added ``__version__`` (thus, ``docutils.__version__``).
1075 - Removed many keyword parameters to ``Publisher.__init__()`` and
1076 ``publish()``; bundled into an option values object. Added
1077 "argv", "usage", "description", and "option_spec" parameters for
1078 command-line support.
1079 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1081 - Reworked I/O model for ``docutils.io`` wrappers.
1082 - Updated ``Publisher.set_options()``; now returns option values
1084 - Added support for configuration files (/etc/docutils.conf,
1085 ./docutils.conf, ~/.docutils).
1086 - Added ``Publisher.setup_option_parser()``.
1087 - Added default usage message and description.
1089 * docutils/frontend.py: Added to project; support for front-end
1090 (command-line) scripts. Option specifications may be augmented by
1091 components. Requires Optik (http://optik.sf.net/) for option
1092 processing (installed locally as docutils/optik.py).
1094 * docutils/io.py: Added to project; uniform API for a variety of input
1097 * docutils/nodes.py:
1099 - Added ``TreeCopyVisitor`` class.
1100 - Added a ``copy`` method to ``Node`` and subclasses.
1101 - Added a ``SkipDeparture`` exception for visitors.
1102 - Renamed ``TreePruningException`` from ``VisitorException``.
1103 - Added docstrings to ``TreePruningException``, subclasses, and
1105 - Improved docstrings.
1106 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1107 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1109 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1110 ``PreDecorative`` mixin.
1111 - Reworked the name/id bookkeeping; to ``document``, removed
1112 ``explicit_targets`` and ``implicit_targets`` attributes, added
1113 ``nametypes`` attribute and ``set_name_id_map`` method.
1114 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1116 - Added ``document.has_name()`` method.
1117 - Fixed DOM generation for list-attributes.
1118 - Added category class ``Labeled`` (used by footnotes & citations).
1119 - Added ``Element.set_class()`` method (sets "class" attribute).
1121 * docutils/optik.py: Added to project. Combined from the Optik
1122 package, with added option groups and other modifications. The use
1123 of this module is probably only temporary.
1125 * docutils/statemachine.py:
1127 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1128 - Added underscores to improve many awkward names.
1129 - In ``string2lines()``, changed whitespace normalizing translation
1130 table to regexp; restores Python 2.0 compatibility with Unicode.
1132 * docutils/urischemes.py:
1134 - Filled in some descriptions.
1135 - Added "shttp" scheme.
1137 * docutils/utils.py:
1139 - Added ``clean_rcs_keywords`` function (moved from
1140 docutils/transforms/frontmatter.py
1141 ``DocInfo.filter_rcs_keywords``).
1142 - Added underscores to improve many awkward names.
1143 - Changed names of Reporter's thresholds:
1144 warning_level -> report_level; error_level -> halt_level.
1145 - Moved ``utils.id()`` to ``nodes.make_id()``.
1146 - Added ``relative_path(source, target)``.
1148 * docutils/languages/de.py: German mappings; added to project. Thanks
1149 to Gunnar Schwant for the translations.
1151 * docutils/languages/en.py: Added "Dedication" bibliographic field
1154 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1157 * docutils/parsers/rst/states.py:
1159 - Added underscores to improve many awkward names.
1160 - Added RFC-2822 header support.
1161 - Extracted the inline parsing code from ``RSTState`` to a separate
1162 class, ``Inliner``, which will allow easy subclassing.
1163 - Made local bindings for ``memo`` container & often-used contents
1164 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1165 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1166 - Added ``MarkupMismatch`` exception; for late corrections.
1167 - Added ``-/:`` characters to inline markup's start string prefix,
1168 ``/`` to end string suffix.
1169 - Fixed a footnote bug.
1170 - Fixed a bug with literal blocks.
1171 - Applied patch from Simon Budig: simplified regexps with symbolic
1172 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1173 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1174 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1175 - Allowed non-ASCII in "simple names" (directive names, field names,
1177 - Converted ``Inliner.patterns.initial`` to be dynamically built
1178 from parts with ``build_regexp()`` function.
1179 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1180 - Updated docstrings.
1181 - Changed "table" to "grid_table"; added "simple_table" support.
1183 * docutils/parsers/rst/tableparser.py:
1185 - Changed ``TableParser`` to ``GridTableParser``.
1186 - Added ``SimpleTableParser``.
1187 - Refactored naming.
1189 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1190 a fallback language for directive names.
1192 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1193 directive to use a ``pending`` element, used only by HTML writers.
1195 * docutils/parsers/rst/directives/parts.py: Renamed from
1198 - Added "backlinks" attribute to "contents" directive.
1200 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1201 project by Adam Chodorowski.
1203 * docutils/readers/__init__.py: Gave Readers more control over
1204 choosing and instantiating Parsers.
1206 * docutils/readers/pep.py: Added to project; for PEP processing.
1208 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1209 requires a ``component`` parameter.
1211 * docutils/transforms/components.py: Added to project; transforms
1212 related to Docutils components.
1214 * docutils/transforms/frontmatter.py:
1216 - In ``DocInfo.extract_authors``, check for a single "author" in an
1217 "authors" group, and convert it to a single "author" element.
1218 - Added support for "Dedication" and generic bibliographic fields.
1220 * docutils/transforms/peps.py: Added to project; PEP-specific.
1222 * docutils/transforms/parts.py: Renamed from old components.py.
1224 - Added filter for `Contents`, to use alt-text for inline images,
1225 and to remove inline markup that doesn't make sense in the ToC.
1226 - Added "name" attribute to TOC topic depending on its title.
1227 - Added support for optional TOC backlinks.
1229 * docutils/transforms/references.py: Fixed indirect target resolution
1230 in ``Hyperlinks`` transform.
1232 * docutils/transforms/universal.py:
1234 - Changed ``Messages`` transform to properly filter out system
1235 messages below the warning threshold.
1236 - Added ``Decorations`` transform (support for ``--generator``,
1237 ``--date``, ``--time``, ``--source-link`` options).
1239 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1240 Engelbert Gruber's PDF writer.
1242 * docutils/writers/html4css1.py:
1244 - Made XHTML-compatible (switched to lowercase element & attribute
1245 names; empty tag format).
1246 - Escape double-dashes in comment text.
1247 - Improved boilerplate & modularity of output.
1248 - Exposed modular output in Writer class.
1249 - Added a "generator" meta tag to <head>.
1250 - Added support for the ``--stylesheet`` option.
1251 - Added support for ``decoration``, ``header``, and ``footer``
1253 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1254 translation table to regexp; restores Python 2.0 compatibility
1256 - Added the translator class as instance variable to the Writer, to
1257 make it easily subclassable.
1258 - Improved option list spacing (thanks to Richard Jones).
1259 - Modified field list output.
1260 - Added backlinks to footnotes & citations.
1261 - Added percentage widths to "<col>" tags (from colspec).
1262 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1263 "<span>" changed to "<var>".
1264 - Inline literals: "<code>" changed to "<tt>".
1265 - Many changes to optimize vertical space: compact simple lists etc.
1266 - Add a command-line options & directive attributes to control TOC
1267 and footnote/citation backlinks.
1268 - Added support for optional footnote/citation backlinks.
1269 - Added support for generic bibliographic fields.
1270 - Identify backrefs.
1271 - Relative URLs for stylesheet links.
1273 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1274 PEPs (subclass of ``html4css1.Writer``).
1276 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1278 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1279 of the Docutils internal doctree in XML.
1281 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1285 - Changed the title to "The Docutils Document Tree".
1286 - Added "Hyperlink Bookkeeping" section.
1288 * spec/docutils.dtd:
1290 - Added ``decoration``, ``header``, and ``footer`` elements.
1291 - Brought ``interpreted`` element in line with the parser: changed
1292 attribute "type" to "role", added "position".
1293 - Added support for generic bibliographic fields.
1295 * spec/notes.txt: Continual updates. Added "Project Policies".
1297 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1300 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1302 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1303 mailing list discussions.
1305 * spec/pep-0287.txt:
1307 - Renamed to "reStructuredText Docstring Format".
1309 - Reworked Q&A as an enumerated list.
1310 - Converted to reStructuredText format.
1312 * spec/pysource.dtd:
1314 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1316 * spec/pysource.txt: Removed from project. Moved much of its contents
1319 * spec/rst/alternatives.txt:
1321 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1322 - Added "Inline External Targets" section.
1324 * spec/rst/directives.txt:
1326 - Added "backlinks" attribute to "contents" directive.
1328 * spec/rst/problems.txt:
1330 - Updated the Enumerated List Markup discussion.
1331 - Added new alternative table markup syntaxes.
1333 * spec/rst/reStructuredText.txt:
1335 - Clarified field list usage.
1336 - Updated enumerated list description.
1337 - Clarified purpose of directives.
1338 - Added ``-/:`` characters to inline markup's start string prefix,
1339 ``/`` to end string suffix.
1340 - Updated "Authors" bibliographic field behavior.
1341 - Changed "inline hyperlink targets" to "inline internal targets".
1342 - Added "simple table" syntax to supplement the existing but
1343 newly-renamed "grid tables".
1344 - Added cautions for anonymous hyperlink use.
1345 - Added "Dedication" and generic bibliographic fields.
1347 * test: Made test modules standalone (subdirectories became packages).
1349 * test/DocutilsTestSupport.py:
1351 - Added support for PEP extensions to reStructuredText.
1352 - Added support for simple tables.
1353 - Refactored naming.
1355 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1357 - Now supports true packages containing test modules
1358 (``__init__.py`` files required); fixes duplicate module name bug.
1360 * test/test_pep/: Subpackage added to project; PEP testing.
1362 * test/test_rst/test_SimpleTableParser.py: Added to project.
1366 - Updated html.py and publish.py front-end tools to use the new
1367 command-line processing facilities of ``docutils.frontend``
1368 (exposed in ``docutils.core.Publisher``), reducing each to just a
1370 - Added ``locale.setlocale()`` calls to front-end tools.
1372 * tools/buildhtml.py: Added to project; batch-generates .html from all
1373 the .txt files in directories and subdirectories.
1375 * tools/default.css:
1377 - Added support for ``header`` and ``footer`` elements.
1378 - Added styles for "Dedication" topics (biblio fields).
1380 * tools/docutils.conf: A configuration file; added to project.
1382 * tools/docutils-xml.py: Added to project.
1384 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1386 * tools/pep-html-template: Added to project.
1388 * tools/pep2html.py: Added to project from Python (nondist/peps).
1389 Added support for Docutils (reStructuredText PEPs).
1391 * tools/quicktest.py:
1393 - Added the ``--attributes`` option, hacked a bit.
1394 - Added a second command-line argument (output file); cleaned up.
1396 * tools/stylesheets/: Subdirectory added to project.
1398 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1401 Release 0.1 (2002-04-20)
1402 ========================
1404 This is the first release of Docutils, merged from the now inactive
1405 reStructuredText__ and `Docstring Processing System`__ projects. For
1406 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1407 `DPS HISTORY`__ files.
1409 __ http://structuredtext.sourceforge.net/
1410 __ http://docstring.sourceforge.net/
1411 __ http://structuredtext.sourceforge.net/HISTORY.html
1412 __ http://docstring.sourceforge.net/HISTORY.html
1414 General changes: renamed 'dps' package to 'docutils'; renamed
1415 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1416 the test suites (reStructuredText's test/test_states renamed to
1417 test/test_rst); and all modifications required to make it all work.
1419 * docutils/parsers/rst/states.py:
1421 - Improved diagnostic system messages for missing blank lines.
1422 - Fixed substitution_reference bug.
1428 indent-tabs-mode: nil
1429 sentence-end-double-space: t