6 :Contact: goodger@users.sourceforge.net
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 - Added indirect_reference_name attribute to the Targetable class. This
125 attribute holds the whitespace_normalized_name (contains mixed case) of a
128 * docutils/statemachine.py:
130 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
131 - Added ``StringList.get_2D_block``.
135 - Added "level" attribute to SystemMessage exceptions.
137 * docutils/languages/af.py: Added to project; Afrikaans mappings by
140 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
143 * docutils/languages/eo.py: Added to project; Esperanto mappings by
144 Marcelo Huerta San Martin.
146 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
147 mappings by Lalo Martins.
149 * docutils/languages/ru.py: Added to project; Russian mappings by
152 * docutils/parsers/rst/roles.py: Added to project. Contains
153 interpreted text role functions, a registry for interpreted text
154 roles, and an API for adding to and retrieving from the registry.
155 Contributed by Edward Loper.
157 * docutils/parsers/rst/states.py:
159 - Updated ``RSTState.nested_parse`` for "include" in table cells.
160 - Allowed true em-dash character and "---" as block quote
162 - Added support for <angle-bracketed> complex option arguments
164 - Fixed handling of backslashes in substitution definitions.
165 - Fixed off-by-1 error with extra whitespace after substitution
166 definition directive.
167 - Added inline markup parsing to field lists' field names.
168 - Added support for quoted (and unindented) literal blocks.
169 Driven in part by a bribe from Frank Siebenlist (thanks!).
170 - Parser now handles escapes in URIs correctly.
171 - Made embedded-URIs' reference text omittable. Idea from Beni
173 - Refactored explicit target processing code.
174 - Added name attribute to references containing the reference name only
175 through whitespace_normalize_name (no case changes).
176 - parse_target no longer returns the refname after going through
177 normalize_name. This is now handled in make_target.
178 - Fixed bug relating to role-less interpreted text in non-English
180 - Reorganized interpreted text processing; moved code into the new
181 roles.py module. Contributed by Edward Loper.
182 - Refactored ``Body.parse_directive`` into ``run_directive`` and
183 ``parse_directive_block``.
185 * docutils/parsers/rst/tableparser.py:
187 - Reworked for ``StringList``, to support "include" directives in
190 * docutils/parsers/rst/directives/__init__.py:
192 - Renamed ``unchanged()`` directive option conversion function to
193 ``unchanged_required``, and added a new ``unchanged``.
194 - Catch unicode value too high error; fixes bug 781766.
195 - Beefed up directive error reporting.
197 * docutils/parsers/rst/directives/body.py:
199 - Added basic "table" directive.
201 * docutils/parsers/rst/directives/images.py:
203 - Added "target" option to "image" directive.
204 - Added name attribute to references containing the reference name only
205 through whitespace_normalize_name (no case changes).
207 * docutils/parsers/rst/directives/misc.py:
209 - Isolated the import of the ``urllib2`` module; was causing
210 problems on SourceForge (``libssl.so.2`` unavailable?).
211 - Added the "role" directive for declaring custom interpreted text
214 * docutils/parsers/rst/directives/parts.py:
216 - The "contents" directive does more work up-front, creating the
217 "topic" and "title", and leaving the "pending" node for the
218 transform. Allows earlier reference resolution; fixes subtle bug.
220 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
221 mappings by Jannie Hofmeyr.
223 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
224 mappings by Marek Blaha.
226 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
227 mappings by Marcelo Huerta San Martin.
229 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
230 Portuguese mappings by Lalo Martins.
232 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
233 mappings by Roman Suzi.
235 * docutils/transforms/parts.py:
237 - The "contents" directive does more work up-front, creating the
238 "topic" and "title", and leaving the "pending" node for the
239 transform. Allows earlier reference resolution; fixes subtle bug.
240 - Added support for disabling of section numbering.
242 * docutils/transforms/references.py:
244 - Verifying that external targets are truly targets and not indirect
245 references. This is because we are now adding a "name" attribute to
246 references in addition to targets. Note sure if this is correct!
247 - Added code to hook into the unknown_reference_resolvers list for a
248 transformer in resolve_indirect_target. This allows the
249 unknown_reference_resolvers to keep around indirect targets which docutils
252 * docutils/transforms/universal.py:
254 - Added FilterMessages transform (removes system messages below the
255 verbosity threshold).
256 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
257 to FinalCheckVisitor for application-specific handling of
258 unresolvable references.
260 * docutils/writers/__init__.py:
262 - Added assemble_parts method to the Writer class to allow for
263 access to a documents individual parts.
265 * docutils/writers/html4css1.py:
267 - Fixed unicode handling of attribute values (bug 760673).
268 - Prevent duplication of "class" attribute values (bug report from
270 - Improved table grid/border handling (prompted by report from Bob
272 - Added support for table titles.
273 - Added "<title />" for untitled docs, for XHTML conformance; thanks
275 - Added functionality to keep track of individual parts of a document
276 and store them in a dictionary as the "parts" attribute of the writer.
277 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
278 - Added proper support for the "scale" attribute of the "image"
279 element. Contributed by Brent Cook.
280 - Added ``--initial-header-level`` option.
282 * docutils/writers/latex2e.py:
284 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
285 about a missing file.
286 - Added options and support: ``--compound-enumerators``,
287 ``--section-prefix-for-enumerators``, and
288 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
291 * docs/config.txt: "Docutils Configuration Files", added to project.
292 Moved config file entry descriptions from tools.txt.
296 - Moved config file entry descriptions to config.txt.
298 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
301 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
302 Text Roles", added to project.
304 * spec/rst/reStructuredText.txt:
306 - Added description of support for <angle-bracketed> complex option
307 arguments to option lists.
308 - Added subsections for indented and quoted literal blocks.
310 * test: Continually adding & updating tests.
312 - Added test/test_settings.py & test/data/config_*.txt support
314 - Added test/test_writers/test_htmlfragment.py.
316 * test/DocutilsTestSupport.py:
318 - Refactored LaTeX publisher test suite/case class names to make
319 testing other writers easier.
320 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
321 to test the processing of HTML fragments which use the new
322 publish_parts convenience function.
324 * tools/buildhtml.py:
326 - Added support for the "--prune" option.
328 * tools/docutils.conf:
330 - Updated for configuration file reorganization.
334 - copied from tools/html.py
338 - added a 'scripts' section to configuration
339 - added 'tools/rst2html.py' to the scripts section
342 Release 0.3 (2003-06-24)
343 ========================
347 * Renamed "attribute" to "option" for directives/extensions.
349 * Renamed transform method "transform" to "apply".
351 * Renamed "options" to "settings" for runtime settings (as set by
352 command-line options). Sometimes "option" (singular) became
353 "settings" (plural). Some variations below:
355 - document.options -> document.settings (stored in other objects as
357 - option_spec -> settings_spec (not directives though)
358 - OptionSpec -> SettingsSpec
359 - cmdline_options -> settings_spec
360 - relative_path_options -> relative_path_settings
361 - option_default_overrides -> settings_default_overrides
362 - Publisher.set_options -> Publisher.get_settings
366 * COPYING.txt: Added "Public Domain Dedication".
368 * FAQ.txt: Frequently asked questions, added to project.
372 - Updated with PyPI Trove classifiers.
373 - Conditional installation of third-party modules.
375 * docutils/__init__.py:
377 - Bumped version to 0.2.1 to reflect changes to I/O classes.
378 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
379 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
380 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
381 option and its effect on the PEP template & writer.
382 - Bumped version to 0.2.4 due to changes to the PEP template &
384 - Bumped version to 0.2.5 to reflect changes to Reporter output.
385 - Added ``TransformSpec`` class for new transform system.
386 - Bumped version to 0.2.6 for API changes (renaming).
387 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
388 convenience functions.
389 - Added ``Component.component_type`` attribute.
390 - Bumped version to 0.2.8 because of the internal parser switch from
391 plain lists to the docutils.statemachine.StringList objects.
392 - Bumped version to 0.2.9 because of the frontend.py API changes.
393 - Bumped version to 0.2.10 due to changes to the project layout
394 (third-party modules removed from the "docutils" package), and
395 signature changes in ``io.Input``/``io.Output``.
396 - Changed version to 0.3.0 for release.
400 - Made ``publish()`` a bit more convenient.
401 - Generalized ``Publisher.set_io``.
402 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
403 parameters; improved its docstring.
404 - Added ``publish_file()`` and ``publish_string()``.
405 - Factored ``Publisher.set_source()`` and ``.set_destination()``
407 - Added support for "--dump-pseudo-xml", "--dump-settings", and
408 "--dump-transforms" hidden options.
409 - Added ``Publisher.apply_transforms()`` method.
410 - Added ``Publisher.set_components()`` method; support for
411 ``publish_*()`` conveninece functions.
412 - Moved config file processing to docutils/frontend.py.
413 - Added support for exit status ("exit_level" setting &
414 ``enable_exit`` parameter for Publisher.publish() and convenience
417 * docutils/frontend.py:
419 - Check for & exit on identical source & destination paths.
420 - Fixed bug with absolute paths & "--config".
421 - Set non-command-line defaults in ``OptionParser.__init__()``:
422 ``_source`` & ``_destination``.
423 - Distributed ``relative_path_settings`` to components; updated
424 ``OptionParser.populate_from_components()`` to combine it all.
425 - Require list of keys in ``make_paths_absolute`` (was implicit in
426 global ``relative_path_settings``).
427 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
428 "--dump-settings", and "--dump-transforms" hidden options.
429 - Removed nasty internals-fiddling ``ConfigParser.get_section``
430 code, replaced with correct code.
431 - Added validation functionality for config files.
432 - Added "--error-encoding" option/setting, "_disable_config"
434 - Added encoding validation; updated "--input-encoding" and
435 "--output-encoding"; added "--error-encoding-error-handler" and
436 "--output-encoding-error-handler".
437 - Moved config file processing from docutils/core.py.
438 - Updated ``OptionParser.populate_from_components`` to handle new
439 ``SettingsSpec.settings_defaults`` dict.
440 - Added support for "-" => stdin/stdout.
441 - Added "exit_level" setting ("--exit" option).
445 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
446 - Added automatic closing to ``FileInput`` and ``FileOutput``.
447 - Delayed opening of ``FileOutput`` file until ``write()`` called.
448 - ``FileOutput.write()`` now returns the encoded output string.
449 - Try to get path/stream name automatically in ``FileInput`` &
451 - Added defaults for source & destination paths.
452 - Allow for Unicode I/O with an explicit "unicode" encoding.
453 - Added ``Output.encode()``.
454 - Removed dependency on runtime settings; pass encoding directly.
455 - Recognize Unicode strings in ``Input.decode()``.
456 - Added support for output encoding error handlers.
460 - Added "Invisible" element category class.
461 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
462 modification during a traversal.
463 - Added element classes: ``line_block``, ``generated``, ``address``,
464 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
465 ``superscript``, ``subscript``, ``inline``
466 - Added support for lists of nodes to ``Element.insert()``.
467 - Fixed parent linking in ``Element.replace()``.
468 - Added new abstract superclass ``FixedTextElement``; adds
469 "xml:space" attribute.
470 - Added support for "line" attribute of ``system_message`` nodes.
471 - Added support for the observer pattern from ``utils.Reporter``.
472 Added ``parse_messages`` and ``transform_messages`` attributes to
473 ``document``, removed ``messages``. Added ``note_parse_message``
474 and ``note_transform_message`` methods.
475 - Added support for improved diagnostics:
477 - Added "document", "source", and "line" internal attributes to
478 ``Node``, set by ``Node.setup_child()``.
479 - Converted variations on ``node.parent = self`` to
480 ``self.setup_child(node)``.
481 - Added ``document.current_source`` & ``.current_line``
482 attributes, and ``.note_source`` observer method.
483 - Changed "system_message" output to GNU-Tools format.
485 - Added a "rawsource" attribute to the ``Text`` class, for text
486 before backslash-escape resolution.
487 - Support for new transform system.
488 - Reworked ``pending`` element.
489 - Fixed XML DOM bug (SF #660611).
490 - Removed the ``interpeted`` element class and added
491 ``title_reference``, ``abbreviation``, ``acronym``.
492 - Made substitutions case-sensitive-but-forgiving; moved some code
494 - Fixed Unicode bug on element attributes (report: William Dode).
496 * docutils/optik.py: Removed from project; replaced with
497 extras/optparse.py and extras/textwrap.py. These will be installed
498 only if they're not already present in the Python installation.
500 * docutils/roman.py: Moved to extras/roman.py; this will be installed
501 only if it's not already present in the Python installation.
503 * docutils/statemachine.py:
505 - Factored out ``State.add_initial_transitions()`` so it can be
507 - Converted whitespace-specific "blank" and "indent" transitions
508 from special-case code to ordinary transitions: removed
509 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
510 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
511 ``ws_initial_transitions`` attributes.
512 - Removed ``State.match_transition()`` after merging it into
514 - Added ``StateCorrection`` exception.
515 - Added support for ``StateCorrection`` in ``StateMachine.run()``
516 (moved ``TransitionCorrection`` support there too.)
517 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
518 ``EOFError`` instead of ``IndexError``.
519 - Added ``State.no_match`` method.
520 - Added support for the Observer pattern, triggered by input line
522 - Added ``strip_top`` parameter to
523 ``StateMachineWS.get_first_known_indented``.
524 - Made ``context`` a parameter to ``StateMachine.run()``.
525 - Added ``ViewList`` & ``StringList`` classes;
526 ``extract_indented()`` becomes ``StringList.get_indented()``.
527 - Added ``StateMachine.insert_input()``.
528 - Fixed ViewList slice handling for Python 2.3. Patch from (and
529 thanks to) Fred Drake.
533 - Added a ``source`` attribute to Reporter instances and
534 ``system_message`` elements.
535 - Added an observer pattern to ``utils.Reporter`` to keep track of
537 - Fixed bugs in ``relative_path()``.
538 - Added support for improved diagnostics.
539 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
540 - Added support for encoding Reporter stderr output, and encoding
542 - Reporter keeps track of the highest level system message yet
545 * docutils/languages: Fixed bibliographic field language lookups.
547 * docutils/languages/es.py: Added to project; Spanish mappings by
548 Marcelo Huerta San Martin.
550 * docutils/languages/fr.py: Added to project; French mappings by
553 * docutils/languages/it.py: Added to project; Italian mappings by
556 * docutils/languages/sk.py: Added to project; Slovak mappings by
559 * docutils/parser/__init__.py:
561 - Added ``Parser.finish_parse()`` method.
563 * docutils/parser/rst/__init__.py:
565 - Added options: "--pep-references", "--rfc-references",
566 "--tab-width", "--trim-footnote-reference-space".
568 * docutils/parsers/rst/states.py:
570 - Changed "title under/overline too short" system messages from INFO
571 to WARNING, and fixed its insertion location.
572 - Fixed enumerated list item parsing to allow paragraphs & section
573 titles to begin with enumerators.
574 - Converted system messages to use the new "line" attribute.
575 - Fixed a substitution reference edge case.
576 - Added support for "--pep-references" and "--rfc-references"
577 options; reworked ``Inliner`` code to make customization easier.
578 - Removed field argument parsing.
579 - Added support for short section title over/underlines.
580 - Fixed "simple reference name" regexp to ignore text like
581 "object.__method__"; not an anonymous reference.
582 - Added support for improved diagnostics.
583 - Reworked directive API, based on Dethe Elza's contribution. Added
584 ``Body.parse_directive()``, ``.parse_directive_options()``,
585 ``.parse_directive_arguments()`` methods.
586 - Added ``ExtensionOptions`` class, to parse directive options
587 without parsing field bodies. Factored
588 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
589 ``ExtensionOptions``.
590 - Improved definition list term/classifier parsing.
591 - Added warnings for unknown directives.
592 - Renamed ``Stuff`` to ``Struct``.
593 - Now flagged as errors: transitions at the beginning or end of
594 sections, empty sections (except title), and empty documents.
595 - Updated for ``statemachine.StringList``.
596 - Enabled recognition of schemeless email addresses in targets.
597 - Added support for embedded URIs in hyperlink references.
598 - Added backslash-escapes to inline markup end-string suffix.
599 - Added support for correct interpreted text processing.
600 - Fixed nested title parsing (topic, sidebar directives).
601 - Added special processing of backslash-escaped whitespace (idea
602 from David Abrahams).
603 - Made substitutions case-sensitive-but-forgiving; moved some code
604 to ``docutils.nodes``.
605 - Added support for block quote attributions.
606 - Added a kludge to work-around a conflict between the bubble-up
607 parser strategy and short titles (<= 3 char-long over- &
608 underlines). Fixes SF bug #738803 "infinite loop with multiple
609 titles" submitted by Jason Diamond.
610 - Added explicit interpreted text roles for standard inline markup:
611 "emphasis", "strong", "literal".
612 - Implemented "superscript" and "subscript" interpreted text roles.
613 - Added initial support for "abbreviation" and "acronym" roles;
615 - Added support for "--trim-footnote-reference-space" option.
616 - Optional space before colons in directives & hyperlink targets.
618 * docutils/parsers/rst/tableparser.py:
620 - Fixed a bug that was producing unwanted empty rows in "simple"
622 - Detect bad column spans in "simple" tables.
624 * docutils/parsers/rst/directives: Updated all directive functions to
627 * docutils/parsers/rst/directives/__init__.py:
629 - Added ``flag()``, ``unchanged()``, ``path()``,
630 ``nonnegative_int()``, ``choice()``, and ``class_option()``
631 directive option helper functions.
632 - Added warnings for unknown directives.
633 - Return ``None`` for missing directives.
634 - Added ``register_directive()``, thanks to William Dode and Paul
637 * docutils/parsers/rst/directives/admonitions.py:
639 - Added "admonition" directive.
641 * docutils/parsers/rst/directives/body.py: Added to project. Contains
642 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
643 "parsed-literal", "rubric", "epigraph", "highlights" and
644 "pull-quote" directives.
646 * docutils/parsers/rst/directives/images.py:
648 - Added an "align" attribute to the "image" & "figure" directives
649 (by Adam Chodorowski).
650 - Added "class" option to "image", and "figclass" to "figure".
652 * docutils/parsers/rst/directives/misc.py:
654 - Added "include", "raw", and "replace" directives, courtesy of
656 - Added "unicode" and "class" directives.
658 * docutils/parsers/rst/directives/parts.py:
660 - Added the "sectnum" directive; by Dmitry Jemerov.
661 - Added "class" option to "contents" directive.
663 * docutils/parsers/rst/directives/references.py: Added to project.
664 Contains the "target-notes" directive.
666 * docutils/parsers/rst/languages/__init__.py:
668 - Return ``None`` from get_language() for missing language modules.
670 * docutils/parsers/rst/languages/de.py: Added to project; German
671 mappings by Engelbert Gruber.
673 * docutils/parsers/rst/languages/en.py:
675 - Added interpreted text roles mapping.
677 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
678 mappings by Marcelo Huerta San Martin.
680 * docutils/parsers/rst/languages/fr.py: Added to project; French
681 mappings by William Dode.
683 * docutils/parsers/rst/languages/it.py: Added to project; Italian
684 mappings by Nicola Larosa.
686 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
687 mappings by Miroslav Vasko.
689 * docutils/readers/__init__.py:
691 - Added support for the observer pattern from ``utils.Reporter``, in
692 ``Reader.parse`` and ``Reader.transform``.
693 - Removed ``Reader.transform()`` method.
694 - Added default parameter values to ``Reader.__init__()`` to make
695 instantiation easier.
696 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
698 * docutils/readers/pep.py:
700 - Added the ``peps.TargetNotes`` transform to the Reader.
701 - Removed PEP & RFC reference detection code; moved to
702 parsers/rst/states.py as options (enabled here by default).
703 - Added support for pre-acceptance PEPs (no PEP number yet).
704 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
707 * docutils/readers/python: Python Source Reader subpackage added to
708 project, including preliminary versions of:
711 - moduleparser.py: Parser for Python modules.
713 * docutils/transforms/__init__.py:
715 - Added ``Transformer`` class and completed transform reform.
716 - Added unknown_reference_resolvers list for each transformer. This list holds
717 the list of functions provided by each component of the transformer that
718 help resolve references.
720 * docutils/transforms/frontmatter.py:
722 - Improved support for generic fields.
723 - Fixed bibliographic field language lookups.
725 * docutils/transforms/misc.py: Added to project. Miscellaneous
728 * docutils/transforms/parts.py:
730 - Moved the "id" attribute from TOC list items to the references
731 (``Contents.build_contents()``).
732 - Added the ``SectNum`` transform; by Dmitry Jemerov.
733 - Added "class" attribute support to ``Contents``.
735 * docutils/transforms/peps.py:
737 - Added ``mask_email()`` function, updating to pep2html.py's
739 - Linked "Content-Type: text/x-rst" to PEP 12.
740 - Added the ``TargetNotes`` PEP-specific transform.
741 - Added ``TargetNotes.cleanup_callback``.
742 - Added title check to ``Headers``.
744 * docutils/transforms/references.py:
746 - Added the ``TargetNotes`` generic transform.
747 - Split ``Hyperlinks`` into multiple transforms.
748 - Fixed bug with multiply-indirect references (report: Bruce Smith).
749 - Added check for circular indirect references.
750 - Made substitutions case-sensitive-but-forgiving.
752 * docutils/transforms/universal.py:
754 - Added support for the "--expose-internal-attributes" option.
755 - Removed ``Pending`` transform classes & data.
757 * docutils/writers/__init__.py:
759 - Removed ``Writer.transform()`` method.
761 * docutils/writers/docutils-xml.py:
763 - Added XML and doctype declarations.
764 - Added "--no-doctype" and "--no-xml-declaration" options.
766 * docutils/writers/html4css1.py:
768 - "name" attributes only on these tags: a, applet, form, frame,
770 - Added "name" attribute to <a> in section titles for Netscape 4
771 support (bug report: Pearu Peterson).
772 - Fixed targets (names) on footnote, citation, topic title,
773 problematic, and system_message nodes (for Netscape 4).
774 - Changed field names from "<td>" to "<th>".
775 - Added "@" to "@" encoding to thwart address harvesters.
776 - Improved the vertical whitespace optimization; ignore "invisible"
777 nodes (targets, comments, etc.).
778 - Improved inline literals with ``<span class="pre">`` around chunks
779 of text and `` `` for runs of spaces.
780 - Improved modularity of output; added ``self.body_pre_docinfo`` and
781 ``self.docinfo`` segments.
782 - Added support for "line_block", "address" elements.
783 - Improved backlinks (footnotes & system_messages).
784 - Improved system_message output.
785 - Redefined "--stylesheet" as containing an invariant URL, used
786 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
788 - Added "--footnote-references" option (superscript or brackets).
789 - Added "--compact-lists" and "--no-compact-lists" options.
790 - Added "--embed-stylesheet" and "--link-stylesheet" options;
791 factored out ``HTMLTranslator.get_stylesheet_reference()``.
792 - Improved field list rendering.
793 - Added Docutils version to "generator" meta tag.
794 - Fixed a bug with images; they must be inline, so wrapped in <p>.
795 - Improved layout of <pre> HTML source.
796 - Fixed attribute typo on <colspec>.
797 - Refined XML prologue.
798 - Support for no stylesheet.
799 - Removed "interpreted" element support.
800 - Added support for "title_reference", "sidebar", "attribution",
801 "rubric", and generic "admonition" elements.
802 - Added "--attribution" option.
803 - Added support for "inline", "subscript", "superscript" elements.
804 - Added initial support for "abbreviation" and "acronym";
807 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
811 - Double quotes in literal blocks (special treatment for de/ngerman).
812 - Added '--hyperlink-color' option ('0' turns off coloring of links).
813 - Added "--attribution" option.
814 - Right align attributions.
816 * docutils/writers/pep_html.py:
818 - Parameterized output encoding in PEP template.
819 - Reworked substitutions from ``locals()`` into ``subs`` dict.
820 - Redefined "--pep-stylesheet" as containing an invariant URL, used
821 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
823 - Added an override on the "--footnote-references" option.
824 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
825 - Added Docutils version to "generator" meta tag.
826 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
830 - Added a "silent" setting for ``buildhtml.py``.
831 - Added a "Getting Help" section.
832 - Rearranged the structure.
833 - Kept up to date, with new settings, command-line options etc.
834 - Added section for ``rst2latex.py`` (Engelbert Gruber).
835 - Converted settings table into a definition list.
837 * docs/rst/quickstart.txt:
839 - Added a table of contents.
840 - Added feedback information.
841 - Added mention of minimum section title underline lengths.
842 - Removed the 4-character minimum for section title underlines.
844 * docs/rst/quickref.html:
846 - Added a "Getting Help" section.
847 - Added a style to make section title backlinks more subtle.
848 - Added mention of minimum section title underline lengths.
849 - Removed the 4-character minimum for section title underlines.
851 * extras: Directory added to project; contains third-party modules
852 that Docutils depends on (optparse, textwrap, roman). These are
853 only installed if they're not already present.
855 * licenses: Directory added to project; contains copies of license
856 files for non-public-domain files.
860 - Changed the focus. It's about DTD elements: structural
861 relationships, semantics, and external (public) attributes. Not
862 about the element class library.
863 - Moved some implementation-specific stuff into ``docutils.nodes``
865 - Wrote descriptions of all common attributes and parameter
866 entities. Filled in introductory material.
867 - Working through the element descriptions: 55 down, 37 to go.
868 - Removed "Representation of Horizontal Rules" to
869 spec/rst/alternatives.txt.
873 - Added "generated" inline element.
874 - Added "line_block" body element.
875 - Added "auto" attribute to "title".
876 - Changed content models of "literal_block" and "doctest_block" to
878 - Added ``%number;`` attribute type parameter entity.
879 - Changed ``%structural.elements;`` to ``%section.elements``.
880 - Updated attribute types; made more specific.
881 - Added "address" bibliographic element.
882 - Added "line" attribute to ``system_message`` element.
883 - Removed "field_argument" element; "field_name" may contain
884 multiple words and whitespace.
885 - Changed public identifier to docutils.sf.net.
886 - Removed "interpreted" element; added "title_reference",
887 "abbreviation", "acronym".
888 - Removed "refuri" attribute from "footnote_reference" and
889 "citation_reference".
890 - Added "sidebar", "rubric", "attribution", "admonition",
891 "superscript", "subscript", and "inline" elements.
893 * spec/pep-0256.txt: Converted to reStructuredText & updated.
895 * spec/pep-0257.txt: Converted to reStructuredText & updated.
897 * spec/pep-0258.txt: Converted to reStructuredText & updated.
899 * spec/semantics.txt: Updated with text from a Doc-SIG response to
902 * spec/transforms.txt: Added to project.
904 * spec/howto: Added subdirectory, for developer how-to docs.
906 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
907 Elza, edited & extended by David Goodger.
909 * spec/howto/i18n.txt: Docutils Internationalization. Added to
912 * spec/rst/alternatives.txt:
914 - Added "Doctree Representation of Transitions" from
916 - Updated "Inline External Targets" & closed the debate.
917 - Added ideas for interpreted text syntax extensions.
918 - Added "Nested Inline Markup" section.
920 * spec/rst/directives.txt:
922 - Added directives: "topic", "sectnum", "target-notes",
923 "line-block", "parsed-literal", "include", "replace", "sidebar",
924 "admonition", "rubric", "epigraph", "highlights", "unicode" and
926 - Formalized descriptions of directive details.
927 - Added an "align" attribute to the "image" & "figure" directives
928 (by Adam Chodorowski).
929 - Added "class" options to "topic", "sidebar", "line-block",
930 "parsed-literal", "contents", and "image"; and "figclass" to
933 * spec/rst/interpreted.txt: Added to project. Descriptions of
934 interpreted text roles.
936 * spec/rst/introduction.txt:
938 - Added pointers to material for new users.
940 * spec/rst/reStructuredText.txt:
942 - Disambiguated comments (just add a newline after the "::").
943 - Updated enumerated list description; added a discussion of the
944 second-line validity checking.
945 - Updated directive description.
946 - Added a note redirecting newbies to the user docs.
947 - Expanded description of inline markup start-strings in non-markup
949 - Removed field arguments and made field lists a generic construct.
950 - Removed the 4-character minimum for section title underlines.
951 - Clarified term/classifier delimiter & inline markup ambiguity
953 - Added "Embedded URIs".
954 - Updated "Interpreted Text" section.
955 - Added "Character-Level Inline Markup" section.
957 * test: Continually adding & updating tests.
959 - Moved test/test_rst/ to test/test_parsers/test_rst/.
960 - Moved test/test_pep/ to test/test_readers/test_pep/.
961 - Added test/test_readers/test_python/.
962 - Added test/test_writers/ (Engelbert Gruber).
966 - Made the ``locale.setlocale()`` calls in front ends
969 * tools/buildhtml.py:
971 - Added "--silent" option.
972 - Fixed bug with absolute paths & "--config".
973 - Updated for new I/O classes.
974 - Added some exception handling.
975 - Separated publishers' setting defaults; prevents interference.
976 - Updated for new ``publish_file()`` convenience function.
978 * tools/pep-html-template:
980 - Allow for "--embed-stylesheet".
981 - Added Docutils version to "generator" meta tag.
982 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
983 - Conform to XHTML spec.
987 - Made ``argv`` a parameter to ``main()``.
988 - Added support for "Content-Type:" header & arbitrary PEP formats.
989 - Linked "Content-Type: text/plain" to PEP 9.
990 - Files skipped (due to an error) are not pushed onto the server.
991 - Updated for new I/O classes.
992 - Added ``check_requirements()`` & ``pep_type_error()``.
993 - Added some exception handling.
994 - Updated for new ``publish_string()`` convenience function.
995 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
997 * tools/quicktest.py:
999 - Added "-V"/"--version" option.
1001 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1003 * tools/unicode2rstsubs.py: Added to project. Produces character
1004 entity files (reSructuredText substitutions) from the MathML master
1007 * tools/editors: Support code for editors, added to project. Contains
1008 ``emacs/restructuredtext.el``.
1010 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1012 - Added style for chunks of inline literals.
1013 - Removed margin for first child of table cells.
1014 - Right-aligned field list names.
1015 - Support for auto-numbered section titles in TOCs.
1016 - Increased the size of inline literals (<tt>) in titles.
1017 - Restored the light gray background for inline literals.
1018 - Added support for "line_block" elements.
1019 - Added style for "address" elements.
1020 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1021 - Improved field list rendering.
1022 - Vertical whitespace improvements.
1023 - Removed "a.target" style.
1025 * tools/stylesheets/pep.css:
1027 - Fixed nested section margins.
1028 - Other changes parallel those of ``../default.css``.
1031 Release 0.2 (2002-07-31)
1032 ========================
1036 - The word "component" was being used ambiguously. From now on,
1037 "component" will be used to mean "Docutils component", as in Reader,
1038 Writer, Parser, or Transform. Portions of documents (Table of
1039 Contents, sections, etc.) will be called "document parts".
1040 - Did a grand renaming: a lot of ``verylongnames`` became
1041 ``very_long_names``.
1042 - Cleaned up imports: no more relative package imports or
1043 comma-separated lists of top-level modules.
1044 - Added support for an option values object which carries default
1045 settings and overrides (from command-line options and library use).
1046 - Added internal Unicode support, and support for both input and
1048 - Added support for the ``docutils.io.IO`` class & subclasses.
1052 * docutils/__init__.py:
1054 - Added ``ApplicationError`` and ``DataError``, for use throughout
1056 - Added ``Component`` base class for Docutils components; implements
1057 the ``supports`` method.
1058 - Added ``__version__`` (thus, ``docutils.__version__``).
1062 - Removed many keyword parameters to ``Publisher.__init__()`` and
1063 ``publish()``; bundled into an option values object. Added
1064 "argv", "usage", "description", and "option_spec" parameters for
1065 command-line support.
1066 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1068 - Reworked I/O model for ``docutils.io`` wrappers.
1069 - Updated ``Publisher.set_options()``; now returns option values
1071 - Added support for configuration files (/etc/docutils.conf,
1072 ./docutils.conf, ~/.docutils).
1073 - Added ``Publisher.setup_option_parser()``.
1074 - Added default usage message and description.
1076 * docutils/frontend.py: Added to project; support for front-end
1077 (command-line) scripts. Option specifications may be augmented by
1078 components. Requires Optik (http://optik.sf.net/) for option
1079 processing (installed locally as docutils/optik.py).
1081 * docutils/io.py: Added to project; uniform API for a variety of input
1084 * docutils/nodes.py:
1086 - Added ``TreeCopyVisitor`` class.
1087 - Added a ``copy`` method to ``Node`` and subclasses.
1088 - Added a ``SkipDeparture`` exception for visitors.
1089 - Renamed ``TreePruningException`` from ``VisitorException``.
1090 - Added docstrings to ``TreePruningException``, subclasses, and
1092 - Improved docstrings.
1093 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1094 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1096 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1097 ``PreDecorative`` mixin.
1098 - Reworked the name/id bookkeeping; to ``document``, removed
1099 ``explicit_targets`` and ``implicit_targets`` attributes, added
1100 ``nametypes`` attribute and ``set_name_id_map`` method.
1101 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1103 - Added ``document.has_name()`` method.
1104 - Fixed DOM generation for list-attributes.
1105 - Added category class ``Labeled`` (used by footnotes & citations).
1106 - Added ``Element.set_class()`` method (sets "class" attribute).
1108 * docutils/optik.py: Added to project. Combined from the Optik
1109 package, with added option groups and other modifications. The use
1110 of this module is probably only temporary.
1112 * docutils/statemachine.py:
1114 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1115 - Added underscores to improve many awkward names.
1116 - In ``string2lines()``, changed whitespace normalizing translation
1117 table to regexp; restores Python 2.0 compatibility with Unicode.
1119 * docutils/urischemes.py:
1121 - Filled in some descriptions.
1122 - Added "shttp" scheme.
1124 * docutils/utils.py:
1126 - Added ``clean_rcs_keywords`` function (moved from
1127 docutils/transforms/frontmatter.py
1128 ``DocInfo.filter_rcs_keywords``).
1129 - Added underscores to improve many awkward names.
1130 - Changed names of Reporter's thresholds:
1131 warning_level -> report_level; error_level -> halt_level.
1132 - Moved ``utils.id()`` to ``nodes.make_id()``.
1133 - Added ``relative_path(source, target)``.
1135 * docutils/languages/de.py: German mappings; added to project. Thanks
1136 to Gunnar Schwant for the translations.
1138 * docutils/languages/en.py: Added "Dedication" bibliographic field
1141 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1144 * docutils/parsers/rst/states.py:
1146 - Added underscores to improve many awkward names.
1147 - Added RFC-2822 header support.
1148 - Extracted the inline parsing code from ``RSTState`` to a separate
1149 class, ``Inliner``, which will allow easy subclassing.
1150 - Made local bindings for ``memo`` container & often-used contents
1151 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1152 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1153 - Added ``MarkupMismatch`` exception; for late corrections.
1154 - Added ``-/:`` characters to inline markup's start string prefix,
1155 ``/`` to end string suffix.
1156 - Fixed a footnote bug.
1157 - Fixed a bug with literal blocks.
1158 - Applied patch from Simon Budig: simplified regexps with symbolic
1159 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1160 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1161 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1162 - Allowed non-ASCII in "simple names" (directive names, field names,
1164 - Converted ``Inliner.patterns.initial`` to be dynamically built
1165 from parts with ``build_regexp()`` function.
1166 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1167 - Updated docstrings.
1168 - Changed "table" to "grid_table"; added "simple_table" support.
1170 * docutils/parsers/rst/tableparser.py:
1172 - Changed ``TableParser`` to ``GridTableParser``.
1173 - Added ``SimpleTableParser``.
1174 - Refactored naming.
1176 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1177 a fallback language for directive names.
1179 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1180 directive to use a ``pending`` element, used only by HTML writers.
1182 * docutils/parsers/rst/directives/parts.py: Renamed from
1185 - Added "backlinks" attribute to "contents" directive.
1187 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1188 project by Adam Chodorowski.
1190 * docutils/readers/__init__.py: Gave Readers more control over
1191 choosing and instantiating Parsers.
1193 * docutils/readers/pep.py: Added to project; for PEP processing.
1195 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1196 requires a ``component`` parameter.
1198 * docutils/transforms/components.py: Added to project; transforms
1199 related to Docutils components.
1201 * docutils/transforms/frontmatter.py:
1203 - In ``DocInfo.extract_authors``, check for a single "author" in an
1204 "authors" group, and convert it to a single "author" element.
1205 - Added support for "Dedication" and generic bibliographic fields.
1207 * docutils/transforms/peps.py: Added to project; PEP-specific.
1209 * docutils/transforms/parts.py: Renamed from old components.py.
1211 - Added filter for `Contents`, to use alt-text for inline images,
1212 and to remove inline markup that doesn't make sense in the ToC.
1213 - Added "name" attribute to TOC topic depending on its title.
1214 - Added support for optional TOC backlinks.
1216 * docutils/transforms/references.py: Fixed indirect target resolution
1217 in ``Hyperlinks`` transform.
1219 * docutils/transforms/universal.py:
1221 - Changed ``Messages`` transform to properly filter out system
1222 messages below the warning threshold.
1223 - Added ``Decorations`` transform (support for ``--generator``,
1224 ``--date``, ``--time``, ``--source-link`` options).
1226 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1227 Engelbert Gruber's PDF writer.
1229 * docutils/writers/html4css1.py:
1231 - Made XHTML-compatible (switched to lowercase element & attribute
1232 names; empty tag format).
1233 - Escape double-dashes in comment text.
1234 - Improved boilerplate & modularity of output.
1235 - Exposed modular output in Writer class.
1236 - Added a "generator" meta tag to <head>.
1237 - Added support for the ``--stylesheet`` option.
1238 - Added support for ``decoration``, ``header``, and ``footer``
1240 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1241 translation table to regexp; restores Python 2.0 compatibility
1243 - Added the translator class as instance variable to the Writer, to
1244 make it easily subclassable.
1245 - Improved option list spacing (thanks to Richard Jones).
1246 - Modified field list output.
1247 - Added backlinks to footnotes & citations.
1248 - Added percentage widths to "<col>" tags (from colspec).
1249 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1250 "<span>" changed to "<var>".
1251 - Inline literals: "<code>" changed to "<tt>".
1252 - Many changes to optimize vertical space: compact simple lists etc.
1253 - Add a command-line options & directive attributes to control TOC
1254 and footnote/citation backlinks.
1255 - Added support for optional footnote/citation backlinks.
1256 - Added support for generic bibliographic fields.
1257 - Identify backrefs.
1258 - Relative URLs for stylesheet links.
1260 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1261 PEPs (subclass of ``html4css1.Writer``).
1263 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1265 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1266 of the Docutils internal doctree in XML.
1268 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1272 - Changed the title to "The Docutils Document Tree".
1273 - Added "Hyperlink Bookkeeping" section.
1275 * spec/docutils.dtd:
1277 - Added ``decoration``, ``header``, and ``footer`` elements.
1278 - Brought ``interpreted`` element in line with the parser: changed
1279 attribute "type" to "role", added "position".
1280 - Added support for generic bibliographic fields.
1282 * spec/notes.txt: Continual updates. Added "Project Policies".
1284 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1287 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1289 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1290 mailing list discussions.
1292 * spec/pep-0287.txt:
1294 - Renamed to "reStructuredText Docstring Format".
1296 - Reworked Q&A as an enumerated list.
1297 - Converted to reStructuredText format.
1299 * spec/pysource.dtd:
1301 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1303 * spec/pysource.txt: Removed from project. Moved much of its contents
1306 * spec/rst/alternatives.txt:
1308 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1309 - Added "Inline External Targets" section.
1311 * spec/rst/directives.txt:
1313 - Added "backlinks" attribute to "contents" directive.
1315 * spec/rst/problems.txt:
1317 - Updated the Enumerated List Markup discussion.
1318 - Added new alternative table markup syntaxes.
1320 * spec/rst/reStructuredText.txt:
1322 - Clarified field list usage.
1323 - Updated enumerated list description.
1324 - Clarified purpose of directives.
1325 - Added ``-/:`` characters to inline markup's start string prefix,
1326 ``/`` to end string suffix.
1327 - Updated "Authors" bibliographic field behavior.
1328 - Changed "inline hyperlink targets" to "inline internal targets".
1329 - Added "simple table" syntax to supplement the existing but
1330 newly-renamed "grid tables".
1331 - Added cautions for anonymous hyperlink use.
1332 - Added "Dedication" and generic bibliographic fields.
1334 * test: Made test modules standalone (subdirectories became packages).
1336 * test/DocutilsTestSupport.py:
1338 - Added support for PEP extensions to reStructuredText.
1339 - Added support for simple tables.
1340 - Refactored naming.
1342 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1344 - Now supports true packages containing test modules
1345 (``__init__.py`` files required); fixes duplicate module name bug.
1347 * test/test_pep/: Subpackage added to project; PEP testing.
1349 * test/test_rst/test_SimpleTableParser.py: Added to project.
1353 - Updated html.py and publish.py front-end tools to use the new
1354 command-line processing facilities of ``docutils.frontend``
1355 (exposed in ``docutils.core.Publisher``), reducing each to just a
1357 - Added ``locale.setlocale()`` calls to front-end tools.
1359 * tools/buildhtml.py: Added to project; batch-generates .html from all
1360 the .txt files in directories and subdirectories.
1362 * tools/default.css:
1364 - Added support for ``header`` and ``footer`` elements.
1365 - Added styles for "Dedication" topics (biblio fields).
1367 * tools/docutils.conf: A configuration file; added to project.
1369 * tools/docutils-xml.py: Added to project.
1371 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1373 * tools/pep-html-template: Added to project.
1375 * tools/pep2html.py: Added to project from Python (nondist/peps).
1376 Added support for Docutils (reStructuredText PEPs).
1378 * tools/quicktest.py:
1380 - Added the ``--attributes`` option, hacked a bit.
1381 - Added a second command-line argument (output file); cleaned up.
1383 * tools/stylesheets/: Subdirectory added to project.
1385 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1388 Release 0.1 (2002-04-20)
1389 ========================
1391 This is the first release of Docutils, merged from the now inactive
1392 reStructuredText__ and `Docstring Processing System`__ projects. For
1393 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1394 `DPS HISTORY`__ files.
1396 __ http://structuredtext.sourceforge.net/
1397 __ http://docstring.sourceforge.net/
1398 __ http://structuredtext.sourceforge.net/HISTORY.html
1399 __ http://docstring.sourceforge.net/HISTORY.html
1401 General changes: renamed 'dps' package to 'docutils'; renamed
1402 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1403 the test suites (reStructuredText's test/test_states renamed to
1404 test/test_rst); and all modifications required to make it all work.
1406 * docutils/parsers/rst/states.py:
1408 - Improved diagnostic system messages for missing blank lines.
1409 - Fixed substitution_reference bug.
1415 indent-tabs-mode: nil
1416 sentence-end-double-space: t