5 :Author: David Goodger; open to 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.
18 * _`Documentation cleanup/reorganization`.
20 - Created new subdirectories of docs/:
22 * ``docs/user/``: introductory/tutorial material for end-users
23 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
24 * ``docs/ref/``: reference material for all groups
25 * ``docs/howto/``: for component-developers and core-developers
26 * ``docs/peps/``: Python Enhancement Proposals
28 - Moved ``docs/*`` to ``docs/user/``.
29 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
30 ``spec/`` to ``docs/dev``.
31 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
32 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
33 - Moved ``alternatives.txt``, and ``problems.txt`` from
34 ``spec/rst/`` to ``docs/dev/rst/``.
35 - Moved ``reStructuredText.txt``, ``directives.txt``,
36 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
37 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
38 ``roles.txt``, ``reStructuredText.txt`` to
39 ``restructuredtext.txt``.
40 - Moved ``spec/howto/`` to ``docs/howto``.
42 In order to keep the CVS history of moved files, we supplied
43 SourceForge with a `script for modifying the Docutils CVS
46 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
48 After running the cleanup script:
50 - Added ``docs/index.txt``.
51 - Added a ``.htaccess`` file to the ``web`` module, containing
52 redirects for all old paths to new paths. They'll preserve
53 fragments (the "#name" part of a URL), and won't clutter up the
54 file system, and will correct the URL in the user's browser.
55 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
56 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
57 the "To Do" list itself in ``docs/dev/todo.txt``.
58 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
59 section of ``docs/dev/todo.txt``.
60 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
61 - Added "How To Report Bugs" to ``BUGS.txt``.
62 - Went through all the sources and docs (including under web/) and
63 updated links. Mostly done by Felix Wiemann; thanks Felix!
64 (Still need to update links in the sandboxes.)
68 * BUGS.txt: Added to project.
70 * THANKS.txt: Added to project.
72 * docutils/__init__.py:
74 - 0.3.4: Post-release.
78 - Added special error handling & advice for UnicodeEncodeError.
79 - Refactored Publisher.publish (simplified exception handling &
80 extracted debug dumps).
81 - Renamed "enable_exit" parameter of convenience functions to
83 - Enabled traceback (exception propagation) by default in
84 programmatic convenience functions.
86 * docutils/frontend.py:
88 - Added help text for "--output-encoding-error-handler" and
89 "--error-encoding-error-handler".
90 - Renamed "--exit" to "--exit-status".
92 * docutils/writers/latex2e.py:
94 - Added "--table-style=(standard|booktabs|nolines)"
95 - figures get "here" option (LaTeX per default puts them at bottom),
96 and figure content is centered.
97 - Rowspan support for tables.
98 - Fix: admonition titles before first section.
100 * docs/index.txt: "Docutils Project Documentation Overview", added to
103 * docs/dev/policies.txt: Added to project (extracted from
104 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
106 * docs/dev/release.txt: Added to project (extracted from
107 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
109 * docs/dev/website.txt: Added to project (extracted from
110 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
112 * docs/ref/rst/directives.txt:
114 - Added directive: "table".
116 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
117 added to project. 1 page for syntax, and a 1 page reference for
118 directives and roles. Source text to be used as-is; not meant to be
122 Release 0.3.3 (2004-05-09)
123 ==========================
125 * docutils/__init__.py:
127 - 0.3.1: Reorganized config file format (multiple sections); see
129 - Added unknown_reference_resolvers attribute to TransformSpec.
130 - 0.3.2: Interpreted text reorganization.
135 - Catch system messages to stop tracebacks from parsing errors.
136 - Catch exceptions during processing report & exit without
137 tracebacks, except when "--traceback" used.
138 - Reordered components for OptionParser; application comes last.
139 - Added "config_section" parameter to several methods and functions,
140 allowing front ends to easily specify their config file sections.
141 - Added publish_parts convenience function to allow access to individual
144 * docutils/examples.py: Added to project; practical examples of
145 Docutils client code, to be used as-is or as models for variations.
147 * docutils/frontend.py:
149 - Added "--traceback" & "--no-traceback" options ("traceback"
151 - Implemented support for config file reorganization:
152 ``standard_config_files`` moved from ``ConfigParser`` to
153 ``OptionParser``; added
154 ``OptionParser.get_config_file_settings()`` and
155 ``.get_standard_config_settings()``; support for old "[options]"
156 section (with deprecation warning) and mapping from old to new
158 - Reimplemented setting validation.
159 - Enabled flexible boolean values: yes/no, true/false, on/off.
160 - Added ``Values``, a subclass of ``optparse.Values``, with support
161 for list setting attributes.
162 - Added support for new ``DOCUTILSCONFIG`` environment variable;
163 thanks to Beni Cherniavsky.
164 - Added "--no-section-numbering" option.
168 - Catch IOErrors when opening source & destination files, report &
169 exit without tracebacks. Added ``handle_io_errors`` parameter to
170 ``FileInput`` & ``FileOutput`` to enable caller error handling.
174 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
175 method definitions (via ``exec``) to dynamic assignments (via
176 ``setattr``); thanks to Roman Suzi.
177 - Encapsulated visitor dynamic assignments in a function; thanks to
179 - Added indirect_reference_name attribute to the Targetable
180 class. This attribute holds the whitespace_normalized_name
181 (contains mixed case) of a target.
183 * docutils/statemachine.py:
185 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
186 - Added ``StringList.get_2D_block``.
190 - Added "level" attribute to SystemMessage exceptions.
192 * docutils/languages/af.py: Added to project; Afrikaans mappings by
195 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
198 * docutils/languages/eo.py: Added to project; Esperanto mappings by
199 Marcelo Huerta San Martin.
201 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
202 mappings by Lalo Martins.
204 * docutils/languages/ru.py: Added to project; Russian mappings by
207 * docutils/parsers/rst/roles.py: Added to project. Contains
208 interpreted text role functions, a registry for interpreted text
209 roles, and an API for adding to and retrieving from the registry.
210 Contributed by Edward Loper.
212 * docutils/parsers/rst/states.py:
214 - Updated ``RSTState.nested_parse`` for "include" in table cells.
215 - Allowed true em-dash character and "---" as block quote
217 - Added support for <angle-bracketed> complex option arguments
219 - Fixed handling of backslashes in substitution definitions.
220 - Fixed off-by-1 error with extra whitespace after substitution
221 definition directive.
222 - Added inline markup parsing to field lists' field names.
223 - Added support for quoted (and unindented) literal blocks.
224 Driven in part by a bribe from Frank Siebenlist (thanks!).
225 - Parser now handles escapes in URIs correctly.
226 - Made embedded-URIs' reference text omittable. Idea from Beni
228 - Refactored explicit target processing code.
229 - Added name attribute to references containing the reference name only
230 through whitespace_normalize_name (no case changes).
231 - parse_target no longer returns the refname after going through
232 normalize_name. This is now handled in make_target.
233 - Fixed bug relating to role-less interpreted text in non-English
235 - Reorganized interpreted text processing; moved code into the new
236 roles.py module. Contributed by Edward Loper.
237 - Refactored ``Body.parse_directive`` into ``run_directive`` and
238 ``parse_directive_block``.
240 * docutils/parsers/rst/tableparser.py:
242 - Reworked for ``StringList``, to support "include" directives in
245 * docutils/parsers/rst/directives/__init__.py:
247 - Renamed ``unchanged()`` directive option conversion function to
248 ``unchanged_required``, and added a new ``unchanged``.
249 - Catch unicode value too high error; fixes bug 781766.
250 - Beefed up directive error reporting.
252 * docutils/parsers/rst/directives/body.py:
254 - Added basic "table" directive.
256 * docutils/parsers/rst/directives/images.py:
258 - Added "target" option to "image" directive.
259 - Added name attribute to references containing the reference name only
260 through whitespace_normalize_name (no case changes).
262 * docutils/parsers/rst/directives/misc.py:
264 - Isolated the import of the ``urllib2`` module; was causing
265 problems on SourceForge (``libssl.so.2`` unavailable?).
266 - Added the "role" directive for declaring custom interpreted text
269 * docutils/parsers/rst/directives/parts.py:
271 - The "contents" directive does more work up-front, creating the
272 "topic" and "title", and leaving the "pending" node for the
273 transform. Allows earlier reference resolution; fixes subtle bug.
275 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
276 mappings by Jannie Hofmeyr.
278 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
279 mappings by Marek Blaha.
281 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
282 mappings by Marcelo Huerta San Martin.
284 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
285 Portuguese mappings by Lalo Martins.
287 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
288 mappings by Roman Suzi.
290 * docutils/transforms/parts.py:
292 - The "contents" directive does more work up-front, creating the
293 "topic" and "title", and leaving the "pending" node for the
294 transform. Allows earlier reference resolution; fixes subtle bug.
295 - Added support for disabling of section numbering.
297 * docutils/transforms/references.py:
299 - Verifying that external targets are truly targets and not indirect
300 references. This is because we are now adding a "name" attribute to
301 references in addition to targets. Note sure if this is correct!
302 - Added code to hook into the unknown_reference_resolvers list for a
303 transformer in resolve_indirect_target. This allows the
304 unknown_reference_resolvers to keep around indirect targets which
305 docutils doesn't know about.
306 - Added specific error message for duplicate targets.
308 * docutils/transforms/universal.py:
310 - Added FilterMessages transform (removes system messages below the
311 verbosity threshold).
312 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
313 to FinalCheckVisitor for application-specific handling of
314 unresolvable references.
315 - Added specific error message for duplicate targets.
317 * docutils/writers/__init__.py:
319 - Added assemble_parts method to the Writer class to allow for
320 access to a documents individual parts.
321 - Documented & set default for ``Writer.output`` attribute.
323 * docutils/writers/html4css1.py:
325 - Fixed unicode handling of attribute values (bug 760673).
326 - Prevent duplication of "class" attribute values (bug report from
328 - Improved table grid/border handling (prompted by report from Bob
330 - Added support for table titles.
331 - Added "<title />" for untitled docs, for XHTML conformance; thanks
333 - Added functionality to keep track of individual parts of a document
334 and store them in a dictionary as the "parts" attribute of the writer.
335 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
336 - Added proper support for the "scale" attribute of the "image"
337 element. Contributed by Brent Cook.
338 - Added ``--initial-header-level`` option.
339 - Fixed bug: the body_pre_docinfo segment depended on there being a
340 docinfo; if no docinfo, the document title was incorporated into
341 the body segment. Adversely affected the publish_parts interface.
343 * docutils/writers/latex2e.py:
345 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
346 about a missing file.
347 - Added options and support: ``--compound-enumerators``,
348 ``--section-prefix-for-enumerators``, and
349 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
351 - Added option ``--use-verbatim-when-possible``, to avoid
352 problematic characters (eg, '~' in italian) in literal blocks.
353 - It's now possible to use four section levels in the `book` and
354 `report` LaTeX classes. The default `article` class still has
357 * docs/config.txt: "Docutils Configuration Files", added to project.
358 Moved config file entry descriptions from tools.txt.
362 - Moved config file entry descriptions to config.txt.
364 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
367 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
368 Text Roles", added to project.
370 * spec/rst/reStructuredText.txt:
372 - Added description of support for <angle-bracketed> complex option
373 arguments to option lists.
374 - Added subsections for indented and quoted literal blocks.
376 * test: Continually adding & updating tests.
378 - Added test/test_settings.py & test/data/config_*.txt support
380 - Added test/test_writers/test_htmlfragment.py.
382 * test/DocutilsTestSupport.py:
384 - Refactored LaTeX publisher test suite/case class names to make
385 testing other writers easier.
386 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
387 to test the processing of HTML fragments which use the new
388 publish_parts convenience function.
390 * tools/buildhtml.py:
392 - Added support for the "--prune" option.
393 - Removed dependency on pep2html.py; plaintext PEPs no longer
396 * tools/docutils.conf:
398 - Updated for configuration file reorganization.
402 - copied from tools/html.py
406 - added a 'scripts' section to configuration
407 - added 'tools/rst2html.py' to the scripts section
410 Release 0.3 (2003-06-24)
411 ========================
415 * Renamed "attribute" to "option" for directives/extensions.
417 * Renamed transform method "transform" to "apply".
419 * Renamed "options" to "settings" for runtime settings (as set by
420 command-line options). Sometimes "option" (singular) became
421 "settings" (plural). Some variations below:
423 - document.options -> document.settings (stored in other objects as
425 - option_spec -> settings_spec (not directives though)
426 - OptionSpec -> SettingsSpec
427 - cmdline_options -> settings_spec
428 - relative_path_options -> relative_path_settings
429 - option_default_overrides -> settings_default_overrides
430 - Publisher.set_options -> Publisher.get_settings
434 * COPYING.txt: Added "Public Domain Dedication".
436 * FAQ.txt: Frequently asked questions, added to project.
440 - Updated with PyPI Trove classifiers.
441 - Conditional installation of third-party modules.
443 * docutils/__init__.py:
445 - Bumped version to 0.2.1 to reflect changes to I/O classes.
446 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
447 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
448 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
449 option and its effect on the PEP template & writer.
450 - Bumped version to 0.2.4 due to changes to the PEP template &
452 - Bumped version to 0.2.5 to reflect changes to Reporter output.
453 - Added ``TransformSpec`` class for new transform system.
454 - Bumped version to 0.2.6 for API changes (renaming).
455 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
456 convenience functions.
457 - Added ``Component.component_type`` attribute.
458 - Bumped version to 0.2.8 because of the internal parser switch from
459 plain lists to the docutils.statemachine.StringList objects.
460 - Bumped version to 0.2.9 because of the frontend.py API changes.
461 - Bumped version to 0.2.10 due to changes to the project layout
462 (third-party modules removed from the "docutils" package), and
463 signature changes in ``io.Input``/``io.Output``.
464 - Changed version to 0.3.0 for release.
468 - Made ``publish()`` a bit more convenient.
469 - Generalized ``Publisher.set_io``.
470 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
471 parameters; improved its docstring.
472 - Added ``publish_file()`` and ``publish_string()``.
473 - Factored ``Publisher.set_source()`` and ``.set_destination()``
475 - Added support for "--dump-pseudo-xml", "--dump-settings", and
476 "--dump-transforms" hidden options.
477 - Added ``Publisher.apply_transforms()`` method.
478 - Added ``Publisher.set_components()`` method; support for
479 ``publish_*()`` conveninece functions.
480 - Moved config file processing to docutils/frontend.py.
481 - Added support for exit status ("exit_level" setting &
482 ``enable_exit`` parameter for Publisher.publish() and convenience
485 * docutils/frontend.py:
487 - Check for & exit on identical source & destination paths.
488 - Fixed bug with absolute paths & "--config".
489 - Set non-command-line defaults in ``OptionParser.__init__()``:
490 ``_source`` & ``_destination``.
491 - Distributed ``relative_path_settings`` to components; updated
492 ``OptionParser.populate_from_components()`` to combine it all.
493 - Require list of keys in ``make_paths_absolute`` (was implicit in
494 global ``relative_path_settings``).
495 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
496 "--dump-settings", and "--dump-transforms" hidden options.
497 - Removed nasty internals-fiddling ``ConfigParser.get_section``
498 code, replaced with correct code.
499 - Added validation functionality for config files.
500 - Added "--error-encoding" option/setting, "_disable_config"
502 - Added encoding validation; updated "--input-encoding" and
503 "--output-encoding"; added "--error-encoding-error-handler" and
504 "--output-encoding-error-handler".
505 - Moved config file processing from docutils/core.py.
506 - Updated ``OptionParser.populate_from_components`` to handle new
507 ``SettingsSpec.settings_defaults`` dict.
508 - Added support for "-" => stdin/stdout.
509 - Added "exit_level" setting ("--exit" option).
513 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
514 - Added automatic closing to ``FileInput`` and ``FileOutput``.
515 - Delayed opening of ``FileOutput`` file until ``write()`` called.
516 - ``FileOutput.write()`` now returns the encoded output string.
517 - Try to get path/stream name automatically in ``FileInput`` &
519 - Added defaults for source & destination paths.
520 - Allow for Unicode I/O with an explicit "unicode" encoding.
521 - Added ``Output.encode()``.
522 - Removed dependency on runtime settings; pass encoding directly.
523 - Recognize Unicode strings in ``Input.decode()``.
524 - Added support for output encoding error handlers.
528 - Added "Invisible" element category class.
529 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
530 modification during a traversal.
531 - Added element classes: ``line_block``, ``generated``, ``address``,
532 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
533 ``superscript``, ``subscript``, ``inline``
534 - Added support for lists of nodes to ``Element.insert()``.
535 - Fixed parent linking in ``Element.replace()``.
536 - Added new abstract superclass ``FixedTextElement``; adds
537 "xml:space" attribute.
538 - Added support for "line" attribute of ``system_message`` nodes.
539 - Added support for the observer pattern from ``utils.Reporter``.
540 Added ``parse_messages`` and ``transform_messages`` attributes to
541 ``document``, removed ``messages``. Added ``note_parse_message``
542 and ``note_transform_message`` methods.
543 - Added support for improved diagnostics:
545 - Added "document", "source", and "line" internal attributes to
546 ``Node``, set by ``Node.setup_child()``.
547 - Converted variations on ``node.parent = self`` to
548 ``self.setup_child(node)``.
549 - Added ``document.current_source`` & ``.current_line``
550 attributes, and ``.note_source`` observer method.
551 - Changed "system_message" output to GNU-Tools format.
553 - Added a "rawsource" attribute to the ``Text`` class, for text
554 before backslash-escape resolution.
555 - Support for new transform system.
556 - Reworked ``pending`` element.
557 - Fixed XML DOM bug (SF #660611).
558 - Removed the ``interpeted`` element class and added
559 ``title_reference``, ``abbreviation``, ``acronym``.
560 - Made substitutions case-sensitive-but-forgiving; moved some code
562 - Fixed Unicode bug on element attributes (report: William Dode).
564 * docutils/optik.py: Removed from project; replaced with
565 extras/optparse.py and extras/textwrap.py. These will be installed
566 only if they're not already present in the Python installation.
568 * docutils/roman.py: Moved to extras/roman.py; this will be installed
569 only if it's not already present in the Python installation.
571 * docutils/statemachine.py:
573 - Factored out ``State.add_initial_transitions()`` so it can be
575 - Converted whitespace-specific "blank" and "indent" transitions
576 from special-case code to ordinary transitions: removed
577 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
578 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
579 ``ws_initial_transitions`` attributes.
580 - Removed ``State.match_transition()`` after merging it into
582 - Added ``StateCorrection`` exception.
583 - Added support for ``StateCorrection`` in ``StateMachine.run()``
584 (moved ``TransitionCorrection`` support there too.)
585 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
586 ``EOFError`` instead of ``IndexError``.
587 - Added ``State.no_match`` method.
588 - Added support for the Observer pattern, triggered by input line
590 - Added ``strip_top`` parameter to
591 ``StateMachineWS.get_first_known_indented``.
592 - Made ``context`` a parameter to ``StateMachine.run()``.
593 - Added ``ViewList`` & ``StringList`` classes;
594 ``extract_indented()`` becomes ``StringList.get_indented()``.
595 - Added ``StateMachine.insert_input()``.
596 - Fixed ViewList slice handling for Python 2.3. Patch from (and
597 thanks to) Fred Drake.
601 - Added a ``source`` attribute to Reporter instances and
602 ``system_message`` elements.
603 - Added an observer pattern to ``utils.Reporter`` to keep track of
605 - Fixed bugs in ``relative_path()``.
606 - Added support for improved diagnostics.
607 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
608 - Added support for encoding Reporter stderr output, and encoding
610 - Reporter keeps track of the highest level system message yet
613 * docutils/languages: Fixed bibliographic field language lookups.
615 * docutils/languages/es.py: Added to project; Spanish mappings by
616 Marcelo Huerta San Martin.
618 * docutils/languages/fr.py: Added to project; French mappings by
621 * docutils/languages/it.py: Added to project; Italian mappings by
624 * docutils/languages/sk.py: Added to project; Slovak mappings by
627 * docutils/parser/__init__.py:
629 - Added ``Parser.finish_parse()`` method.
631 * docutils/parser/rst/__init__.py:
633 - Added options: "--pep-references", "--rfc-references",
634 "--tab-width", "--trim-footnote-reference-space".
636 * docutils/parsers/rst/states.py:
638 - Changed "title under/overline too short" system messages from INFO
639 to WARNING, and fixed its insertion location.
640 - Fixed enumerated list item parsing to allow paragraphs & section
641 titles to begin with enumerators.
642 - Converted system messages to use the new "line" attribute.
643 - Fixed a substitution reference edge case.
644 - Added support for "--pep-references" and "--rfc-references"
645 options; reworked ``Inliner`` code to make customization easier.
646 - Removed field argument parsing.
647 - Added support for short section title over/underlines.
648 - Fixed "simple reference name" regexp to ignore text like
649 "object.__method__"; not an anonymous reference.
650 - Added support for improved diagnostics.
651 - Reworked directive API, based on Dethe Elza's contribution. Added
652 ``Body.parse_directive()``, ``.parse_directive_options()``,
653 ``.parse_directive_arguments()`` methods.
654 - Added ``ExtensionOptions`` class, to parse directive options
655 without parsing field bodies. Factored
656 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
657 ``ExtensionOptions``.
658 - Improved definition list term/classifier parsing.
659 - Added warnings for unknown directives.
660 - Renamed ``Stuff`` to ``Struct``.
661 - Now flagged as errors: transitions at the beginning or end of
662 sections, empty sections (except title), and empty documents.
663 - Updated for ``statemachine.StringList``.
664 - Enabled recognition of schemeless email addresses in targets.
665 - Added support for embedded URIs in hyperlink references.
666 - Added backslash-escapes to inline markup end-string suffix.
667 - Added support for correct interpreted text processing.
668 - Fixed nested title parsing (topic, sidebar directives).
669 - Added special processing of backslash-escaped whitespace (idea
670 from David Abrahams).
671 - Made substitutions case-sensitive-but-forgiving; moved some code
672 to ``docutils.nodes``.
673 - Added support for block quote attributions.
674 - Added a kludge to work-around a conflict between the bubble-up
675 parser strategy and short titles (<= 3 char-long over- &
676 underlines). Fixes SF bug #738803 "infinite loop with multiple
677 titles" submitted by Jason Diamond.
678 - Added explicit interpreted text roles for standard inline markup:
679 "emphasis", "strong", "literal".
680 - Implemented "superscript" and "subscript" interpreted text roles.
681 - Added initial support for "abbreviation" and "acronym" roles;
683 - Added support for "--trim-footnote-reference-space" option.
684 - Optional space before colons in directives & hyperlink targets.
686 * docutils/parsers/rst/tableparser.py:
688 - Fixed a bug that was producing unwanted empty rows in "simple"
690 - Detect bad column spans in "simple" tables.
692 * docutils/parsers/rst/directives: Updated all directive functions to
695 * docutils/parsers/rst/directives/__init__.py:
697 - Added ``flag()``, ``unchanged()``, ``path()``,
698 ``nonnegative_int()``, ``choice()``, and ``class_option()``
699 directive option helper functions.
700 - Added warnings for unknown directives.
701 - Return ``None`` for missing directives.
702 - Added ``register_directive()``, thanks to William Dode and Paul
705 * docutils/parsers/rst/directives/admonitions.py:
707 - Added "admonition" directive.
709 * docutils/parsers/rst/directives/body.py: Added to project. Contains
710 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
711 "parsed-literal", "rubric", "epigraph", "highlights" and
712 "pull-quote" directives.
714 * docutils/parsers/rst/directives/images.py:
716 - Added an "align" attribute to the "image" & "figure" directives
717 (by Adam Chodorowski).
718 - Added "class" option to "image", and "figclass" to "figure".
720 * docutils/parsers/rst/directives/misc.py:
722 - Added "include", "raw", and "replace" directives, courtesy of
724 - Added "unicode" and "class" directives.
726 * docutils/parsers/rst/directives/parts.py:
728 - Added the "sectnum" directive; by Dmitry Jemerov.
729 - Added "class" option to "contents" directive.
731 * docutils/parsers/rst/directives/references.py: Added to project.
732 Contains the "target-notes" directive.
734 * docutils/parsers/rst/languages/__init__.py:
736 - Return ``None`` from get_language() for missing language modules.
738 * docutils/parsers/rst/languages/de.py: Added to project; German
739 mappings by Engelbert Gruber.
741 * docutils/parsers/rst/languages/en.py:
743 - Added interpreted text roles mapping.
745 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
746 mappings by Marcelo Huerta San Martin.
748 * docutils/parsers/rst/languages/fr.py: Added to project; French
749 mappings by William Dode.
751 * docutils/parsers/rst/languages/it.py: Added to project; Italian
752 mappings by Nicola Larosa.
754 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
755 mappings by Miroslav Vasko.
757 * docutils/readers/__init__.py:
759 - Added support for the observer pattern from ``utils.Reporter``, in
760 ``Reader.parse`` and ``Reader.transform``.
761 - Removed ``Reader.transform()`` method.
762 - Added default parameter values to ``Reader.__init__()`` to make
763 instantiation easier.
764 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
766 * docutils/readers/pep.py:
768 - Added the ``peps.TargetNotes`` transform to the Reader.
769 - Removed PEP & RFC reference detection code; moved to
770 parsers/rst/states.py as options (enabled here by default).
771 - Added support for pre-acceptance PEPs (no PEP number yet).
772 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
775 * docutils/readers/python: Python Source Reader subpackage added to
776 project, including preliminary versions of:
779 - moduleparser.py: Parser for Python modules.
781 * docutils/transforms/__init__.py:
783 - Added ``Transformer`` class and completed transform reform.
784 - Added unknown_reference_resolvers list for each transformer. This list holds
785 the list of functions provided by each component of the transformer that
786 help resolve references.
788 * docutils/transforms/frontmatter.py:
790 - Improved support for generic fields.
791 - Fixed bibliographic field language lookups.
793 * docutils/transforms/misc.py: Added to project. Miscellaneous
796 * docutils/transforms/parts.py:
798 - Moved the "id" attribute from TOC list items to the references
799 (``Contents.build_contents()``).
800 - Added the ``SectNum`` transform; by Dmitry Jemerov.
801 - Added "class" attribute support to ``Contents``.
803 * docutils/transforms/peps.py:
805 - Added ``mask_email()`` function, updating to pep2html.py's
807 - Linked "Content-Type: text/x-rst" to PEP 12.
808 - Added the ``TargetNotes`` PEP-specific transform.
809 - Added ``TargetNotes.cleanup_callback``.
810 - Added title check to ``Headers``.
812 * docutils/transforms/references.py:
814 - Added the ``TargetNotes`` generic transform.
815 - Split ``Hyperlinks`` into multiple transforms.
816 - Fixed bug with multiply-indirect references (report: Bruce Smith).
817 - Added check for circular indirect references.
818 - Made substitutions case-sensitive-but-forgiving.
820 * docutils/transforms/universal.py:
822 - Added support for the "--expose-internal-attributes" option.
823 - Removed ``Pending`` transform classes & data.
825 * docutils/writers/__init__.py:
827 - Removed ``Writer.transform()`` method.
829 * docutils/writers/docutils-xml.py:
831 - Added XML and doctype declarations.
832 - Added "--no-doctype" and "--no-xml-declaration" options.
834 * docutils/writers/html4css1.py:
836 - "name" attributes only on these tags: a, applet, form, frame,
838 - Added "name" attribute to <a> in section titles for Netscape 4
839 support (bug report: Pearu Peterson).
840 - Fixed targets (names) on footnote, citation, topic title,
841 problematic, and system_message nodes (for Netscape 4).
842 - Changed field names from "<td>" to "<th>".
843 - Added "@" to "@" encoding to thwart address harvesters.
844 - Improved the vertical whitespace optimization; ignore "invisible"
845 nodes (targets, comments, etc.).
846 - Improved inline literals with ``<span class="pre">`` around chunks
847 of text and `` `` for runs of spaces.
848 - Improved modularity of output; added ``self.body_pre_docinfo`` and
849 ``self.docinfo`` segments.
850 - Added support for "line_block", "address" elements.
851 - Improved backlinks (footnotes & system_messages).
852 - Improved system_message output.
853 - Redefined "--stylesheet" as containing an invariant URL, used
854 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
856 - Added "--footnote-references" option (superscript or brackets).
857 - Added "--compact-lists" and "--no-compact-lists" options.
858 - Added "--embed-stylesheet" and "--link-stylesheet" options;
859 factored out ``HTMLTranslator.get_stylesheet_reference()``.
860 - Improved field list rendering.
861 - Added Docutils version to "generator" meta tag.
862 - Fixed a bug with images; they must be inline, so wrapped in <p>.
863 - Improved layout of <pre> HTML source.
864 - Fixed attribute typo on <colspec>.
865 - Refined XML prologue.
866 - Support for no stylesheet.
867 - Removed "interpreted" element support.
868 - Added support for "title_reference", "sidebar", "attribution",
869 "rubric", and generic "admonition" elements.
870 - Added "--attribution" option.
871 - Added support for "inline", "subscript", "superscript" elements.
872 - Added initial support for "abbreviation" and "acronym";
875 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
879 - Double quotes in literal blocks (special treatment for de/ngerman).
880 - Added '--hyperlink-color' option ('0' turns off coloring of links).
881 - Added "--attribution" option.
882 - Right align attributions.
884 * docutils/writers/pep_html.py:
886 - Parameterized output encoding in PEP template.
887 - Reworked substitutions from ``locals()`` into ``subs`` dict.
888 - Redefined "--pep-stylesheet" as containing an invariant URL, used
889 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
891 - Added an override on the "--footnote-references" option.
892 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
893 - Added Docutils version to "generator" meta tag.
894 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
898 - Added a "silent" setting for ``buildhtml.py``.
899 - Added a "Getting Help" section.
900 - Rearranged the structure.
901 - Kept up to date, with new settings, command-line options etc.
902 - Added section for ``rst2latex.py`` (Engelbert Gruber).
903 - Converted settings table into a definition list.
905 * docs/rst/quickstart.txt:
907 - Added a table of contents.
908 - Added feedback information.
909 - Added mention of minimum section title underline lengths.
910 - Removed the 4-character minimum for section title underlines.
912 * docs/rst/quickref.html:
914 - Added a "Getting Help" section.
915 - Added a style to make section title backlinks more subtle.
916 - Added mention of minimum section title underline lengths.
917 - Removed the 4-character minimum for section title underlines.
919 * extras: Directory added to project; contains third-party modules
920 that Docutils depends on (optparse, textwrap, roman). These are
921 only installed if they're not already present.
923 * licenses: Directory added to project; contains copies of license
924 files for non-public-domain files.
928 - Changed the focus. It's about DTD elements: structural
929 relationships, semantics, and external (public) attributes. Not
930 about the element class library.
931 - Moved some implementation-specific stuff into ``docutils.nodes``
933 - Wrote descriptions of all common attributes and parameter
934 entities. Filled in introductory material.
935 - Working through the element descriptions: 55 down, 37 to go.
936 - Removed "Representation of Horizontal Rules" to
937 spec/rst/alternatives.txt.
941 - Added "generated" inline element.
942 - Added "line_block" body element.
943 - Added "auto" attribute to "title".
944 - Changed content models of "literal_block" and "doctest_block" to
946 - Added ``%number;`` attribute type parameter entity.
947 - Changed ``%structural.elements;`` to ``%section.elements``.
948 - Updated attribute types; made more specific.
949 - Added "address" bibliographic element.
950 - Added "line" attribute to ``system_message`` element.
951 - Removed "field_argument" element; "field_name" may contain
952 multiple words and whitespace.
953 - Changed public identifier to docutils.sf.net.
954 - Removed "interpreted" element; added "title_reference",
955 "abbreviation", "acronym".
956 - Removed "refuri" attribute from "footnote_reference" and
957 "citation_reference".
958 - Added "sidebar", "rubric", "attribution", "admonition",
959 "superscript", "subscript", and "inline" elements.
961 * spec/pep-0256.txt: Converted to reStructuredText & updated.
963 * spec/pep-0257.txt: Converted to reStructuredText & updated.
965 * spec/pep-0258.txt: Converted to reStructuredText & updated.
967 * spec/semantics.txt: Updated with text from a Doc-SIG response to
970 * spec/transforms.txt: Added to project.
972 * spec/howto: Added subdirectory, for developer how-to docs.
974 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
975 Elza, edited & extended by David Goodger.
977 * spec/howto/i18n.txt: Docutils Internationalization. Added to
980 * spec/rst/alternatives.txt:
982 - Added "Doctree Representation of Transitions" from
984 - Updated "Inline External Targets" & closed the debate.
985 - Added ideas for interpreted text syntax extensions.
986 - Added "Nested Inline Markup" section.
988 * spec/rst/directives.txt:
990 - Added directives: "topic", "sectnum", "target-notes",
991 "line-block", "parsed-literal", "include", "replace", "sidebar",
992 "admonition", "rubric", "epigraph", "highlights", "unicode" and
994 - Formalized descriptions of directive details.
995 - Added an "align" attribute to the "image" & "figure" directives
996 (by Adam Chodorowski).
997 - Added "class" options to "topic", "sidebar", "line-block",
998 "parsed-literal", "contents", and "image"; and "figclass" to
1001 * spec/rst/interpreted.txt: Added to project. Descriptions of
1002 interpreted text roles.
1004 * spec/rst/introduction.txt:
1006 - Added pointers to material for new users.
1008 * spec/rst/reStructuredText.txt:
1010 - Disambiguated comments (just add a newline after the "::").
1011 - Updated enumerated list description; added a discussion of the
1012 second-line validity checking.
1013 - Updated directive description.
1014 - Added a note redirecting newbies to the user docs.
1015 - Expanded description of inline markup start-strings in non-markup
1017 - Removed field arguments and made field lists a generic construct.
1018 - Removed the 4-character minimum for section title underlines.
1019 - Clarified term/classifier delimiter & inline markup ambiguity
1021 - Added "Embedded URIs".
1022 - Updated "Interpreted Text" section.
1023 - Added "Character-Level Inline Markup" section.
1025 * test: Continually adding & updating tests.
1027 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1028 - Moved test/test_pep/ to test/test_readers/test_pep/.
1029 - Added test/test_readers/test_python/.
1030 - Added test/test_writers/ (Engelbert Gruber).
1034 - Made the ``locale.setlocale()`` calls in front ends
1037 * tools/buildhtml.py:
1039 - Added "--silent" option.
1040 - Fixed bug with absolute paths & "--config".
1041 - Updated for new I/O classes.
1042 - Added some exception handling.
1043 - Separated publishers' setting defaults; prevents interference.
1044 - Updated for new ``publish_file()`` convenience function.
1046 * tools/pep-html-template:
1048 - Allow for "--embed-stylesheet".
1049 - Added Docutils version to "generator" meta tag.
1050 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1051 - Conform to XHTML spec.
1053 * tools/pep2html.py:
1055 - Made ``argv`` a parameter to ``main()``.
1056 - Added support for "Content-Type:" header & arbitrary PEP formats.
1057 - Linked "Content-Type: text/plain" to PEP 9.
1058 - Files skipped (due to an error) are not pushed onto the server.
1059 - Updated for new I/O classes.
1060 - Added ``check_requirements()`` & ``pep_type_error()``.
1061 - Added some exception handling.
1062 - Updated for new ``publish_string()`` convenience function.
1063 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1065 * tools/quicktest.py:
1067 - Added "-V"/"--version" option.
1069 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1071 * tools/unicode2rstsubs.py: Added to project. Produces character
1072 entity files (reSructuredText substitutions) from the MathML master
1075 * tools/editors: Support code for editors, added to project. Contains
1076 ``emacs/restructuredtext.el``.
1078 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1080 - Added style for chunks of inline literals.
1081 - Removed margin for first child of table cells.
1082 - Right-aligned field list names.
1083 - Support for auto-numbered section titles in TOCs.
1084 - Increased the size of inline literals (<tt>) in titles.
1085 - Restored the light gray background for inline literals.
1086 - Added support for "line_block" elements.
1087 - Added style for "address" elements.
1088 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1089 - Improved field list rendering.
1090 - Vertical whitespace improvements.
1091 - Removed "a.target" style.
1093 * tools/stylesheets/pep.css:
1095 - Fixed nested section margins.
1096 - Other changes parallel those of ``../default.css``.
1099 Release 0.2 (2002-07-31)
1100 ========================
1104 - The word "component" was being used ambiguously. From now on,
1105 "component" will be used to mean "Docutils component", as in Reader,
1106 Writer, Parser, or Transform. Portions of documents (Table of
1107 Contents, sections, etc.) will be called "document parts".
1108 - Did a grand renaming: a lot of ``verylongnames`` became
1109 ``very_long_names``.
1110 - Cleaned up imports: no more relative package imports or
1111 comma-separated lists of top-level modules.
1112 - Added support for an option values object which carries default
1113 settings and overrides (from command-line options and library use).
1114 - Added internal Unicode support, and support for both input and
1116 - Added support for the ``docutils.io.IO`` class & subclasses.
1120 * docutils/__init__.py:
1122 - Added ``ApplicationError`` and ``DataError``, for use throughout
1124 - Added ``Component`` base class for Docutils components; implements
1125 the ``supports`` method.
1126 - Added ``__version__`` (thus, ``docutils.__version__``).
1130 - Removed many keyword parameters to ``Publisher.__init__()`` and
1131 ``publish()``; bundled into an option values object. Added
1132 "argv", "usage", "description", and "option_spec" parameters for
1133 command-line support.
1134 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1136 - Reworked I/O model for ``docutils.io`` wrappers.
1137 - Updated ``Publisher.set_options()``; now returns option values
1139 - Added support for configuration files (/etc/docutils.conf,
1140 ./docutils.conf, ~/.docutils).
1141 - Added ``Publisher.setup_option_parser()``.
1142 - Added default usage message and description.
1144 * docutils/frontend.py: Added to project; support for front-end
1145 (command-line) scripts. Option specifications may be augmented by
1146 components. Requires Optik (http://optik.sf.net/) for option
1147 processing (installed locally as docutils/optik.py).
1149 * docutils/io.py: Added to project; uniform API for a variety of input
1152 * docutils/nodes.py:
1154 - Added ``TreeCopyVisitor`` class.
1155 - Added a ``copy`` method to ``Node`` and subclasses.
1156 - Added a ``SkipDeparture`` exception for visitors.
1157 - Renamed ``TreePruningException`` from ``VisitorException``.
1158 - Added docstrings to ``TreePruningException``, subclasses, and
1160 - Improved docstrings.
1161 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1162 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1164 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1165 ``PreDecorative`` mixin.
1166 - Reworked the name/id bookkeeping; to ``document``, removed
1167 ``explicit_targets`` and ``implicit_targets`` attributes, added
1168 ``nametypes`` attribute and ``set_name_id_map`` method.
1169 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1171 - Added ``document.has_name()`` method.
1172 - Fixed DOM generation for list-attributes.
1173 - Added category class ``Labeled`` (used by footnotes & citations).
1174 - Added ``Element.set_class()`` method (sets "class" attribute).
1176 * docutils/optik.py: Added to project. Combined from the Optik
1177 package, with added option groups and other modifications. The use
1178 of this module is probably only temporary.
1180 * docutils/statemachine.py:
1182 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1183 - Added underscores to improve many awkward names.
1184 - In ``string2lines()``, changed whitespace normalizing translation
1185 table to regexp; restores Python 2.0 compatibility with Unicode.
1187 * docutils/urischemes.py:
1189 - Filled in some descriptions.
1190 - Added "shttp" scheme.
1192 * docutils/utils.py:
1194 - Added ``clean_rcs_keywords`` function (moved from
1195 docutils/transforms/frontmatter.py
1196 ``DocInfo.filter_rcs_keywords``).
1197 - Added underscores to improve many awkward names.
1198 - Changed names of Reporter's thresholds:
1199 warning_level -> report_level; error_level -> halt_level.
1200 - Moved ``utils.id()`` to ``nodes.make_id()``.
1201 - Added ``relative_path(source, target)``.
1203 * docutils/languages/de.py: German mappings; added to project. Thanks
1204 to Gunnar Schwant for the translations.
1206 * docutils/languages/en.py: Added "Dedication" bibliographic field
1209 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1212 * docutils/parsers/rst/states.py:
1214 - Added underscores to improve many awkward names.
1215 - Added RFC-2822 header support.
1216 - Extracted the inline parsing code from ``RSTState`` to a separate
1217 class, ``Inliner``, which will allow easy subclassing.
1218 - Made local bindings for ``memo`` container & often-used contents
1219 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1220 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1221 - Added ``MarkupMismatch`` exception; for late corrections.
1222 - Added ``-/:`` characters to inline markup's start string prefix,
1223 ``/`` to end string suffix.
1224 - Fixed a footnote bug.
1225 - Fixed a bug with literal blocks.
1226 - Applied patch from Simon Budig: simplified regexps with symbolic
1227 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1228 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1229 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1230 - Allowed non-ASCII in "simple names" (directive names, field names,
1232 - Converted ``Inliner.patterns.initial`` to be dynamically built
1233 from parts with ``build_regexp()`` function.
1234 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1235 - Updated docstrings.
1236 - Changed "table" to "grid_table"; added "simple_table" support.
1238 * docutils/parsers/rst/tableparser.py:
1240 - Changed ``TableParser`` to ``GridTableParser``.
1241 - Added ``SimpleTableParser``.
1242 - Refactored naming.
1244 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1245 a fallback language for directive names.
1247 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1248 directive to use a ``pending`` element, used only by HTML writers.
1250 * docutils/parsers/rst/directives/parts.py: Renamed from
1253 - Added "backlinks" attribute to "contents" directive.
1255 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1256 project by Adam Chodorowski.
1258 * docutils/readers/__init__.py: Gave Readers more control over
1259 choosing and instantiating Parsers.
1261 * docutils/readers/pep.py: Added to project; for PEP processing.
1263 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1264 requires a ``component`` parameter.
1266 * docutils/transforms/components.py: Added to project; transforms
1267 related to Docutils components.
1269 * docutils/transforms/frontmatter.py:
1271 - In ``DocInfo.extract_authors``, check for a single "author" in an
1272 "authors" group, and convert it to a single "author" element.
1273 - Added support for "Dedication" and generic bibliographic fields.
1275 * docutils/transforms/peps.py: Added to project; PEP-specific.
1277 * docutils/transforms/parts.py: Renamed from old components.py.
1279 - Added filter for `Contents`, to use alt-text for inline images,
1280 and to remove inline markup that doesn't make sense in the ToC.
1281 - Added "name" attribute to TOC topic depending on its title.
1282 - Added support for optional TOC backlinks.
1284 * docutils/transforms/references.py: Fixed indirect target resolution
1285 in ``Hyperlinks`` transform.
1287 * docutils/transforms/universal.py:
1289 - Changed ``Messages`` transform to properly filter out system
1290 messages below the warning threshold.
1291 - Added ``Decorations`` transform (support for ``--generator``,
1292 ``--date``, ``--time``, ``--source-link`` options).
1294 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1295 Engelbert Gruber's PDF writer.
1297 * docutils/writers/html4css1.py:
1299 - Made XHTML-compatible (switched to lowercase element & attribute
1300 names; empty tag format).
1301 - Escape double-dashes in comment text.
1302 - Improved boilerplate & modularity of output.
1303 - Exposed modular output in Writer class.
1304 - Added a "generator" meta tag to <head>.
1305 - Added support for the ``--stylesheet`` option.
1306 - Added support for ``decoration``, ``header``, and ``footer``
1308 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1309 translation table to regexp; restores Python 2.0 compatibility
1311 - Added the translator class as instance variable to the Writer, to
1312 make it easily subclassable.
1313 - Improved option list spacing (thanks to Richard Jones).
1314 - Modified field list output.
1315 - Added backlinks to footnotes & citations.
1316 - Added percentage widths to "<col>" tags (from colspec).
1317 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1318 "<span>" changed to "<var>".
1319 - Inline literals: "<code>" changed to "<tt>".
1320 - Many changes to optimize vertical space: compact simple lists etc.
1321 - Add a command-line options & directive attributes to control TOC
1322 and footnote/citation backlinks.
1323 - Added support for optional footnote/citation backlinks.
1324 - Added support for generic bibliographic fields.
1325 - Identify backrefs.
1326 - Relative URLs for stylesheet links.
1328 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1329 PEPs (subclass of ``html4css1.Writer``).
1331 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1333 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1334 of the Docutils internal doctree in XML.
1336 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1340 - Changed the title to "The Docutils Document Tree".
1341 - Added "Hyperlink Bookkeeping" section.
1343 * spec/docutils.dtd:
1345 - Added ``decoration``, ``header``, and ``footer`` elements.
1346 - Brought ``interpreted`` element in line with the parser: changed
1347 attribute "type" to "role", added "position".
1348 - Added support for generic bibliographic fields.
1350 * spec/notes.txt: Continual updates. Added "Project Policies".
1352 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1355 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1357 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1358 mailing list discussions.
1360 * spec/pep-0287.txt:
1362 - Renamed to "reStructuredText Docstring Format".
1364 - Reworked Q&A as an enumerated list.
1365 - Converted to reStructuredText format.
1367 * spec/pysource.dtd:
1369 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1371 * spec/pysource.txt: Removed from project. Moved much of its contents
1374 * spec/rst/alternatives.txt:
1376 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1377 - Added "Inline External Targets" section.
1379 * spec/rst/directives.txt:
1381 - Added "backlinks" attribute to "contents" directive.
1383 * spec/rst/problems.txt:
1385 - Updated the Enumerated List Markup discussion.
1386 - Added new alternative table markup syntaxes.
1388 * spec/rst/reStructuredText.txt:
1390 - Clarified field list usage.
1391 - Updated enumerated list description.
1392 - Clarified purpose of directives.
1393 - Added ``-/:`` characters to inline markup's start string prefix,
1394 ``/`` to end string suffix.
1395 - Updated "Authors" bibliographic field behavior.
1396 - Changed "inline hyperlink targets" to "inline internal targets".
1397 - Added "simple table" syntax to supplement the existing but
1398 newly-renamed "grid tables".
1399 - Added cautions for anonymous hyperlink use.
1400 - Added "Dedication" and generic bibliographic fields.
1402 * test: Made test modules standalone (subdirectories became packages).
1404 * test/DocutilsTestSupport.py:
1406 - Added support for PEP extensions to reStructuredText.
1407 - Added support for simple tables.
1408 - Refactored naming.
1410 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1412 - Now supports true packages containing test modules
1413 (``__init__.py`` files required); fixes duplicate module name bug.
1415 * test/test_pep/: Subpackage added to project; PEP testing.
1417 * test/test_rst/test_SimpleTableParser.py: Added to project.
1421 - Updated html.py and publish.py front-end tools to use the new
1422 command-line processing facilities of ``docutils.frontend``
1423 (exposed in ``docutils.core.Publisher``), reducing each to just a
1425 - Added ``locale.setlocale()`` calls to front-end tools.
1427 * tools/buildhtml.py: Added to project; batch-generates .html from all
1428 the .txt files in directories and subdirectories.
1430 * tools/default.css:
1432 - Added support for ``header`` and ``footer`` elements.
1433 - Added styles for "Dedication" topics (biblio fields).
1435 * tools/docutils.conf: A configuration file; added to project.
1437 * tools/docutils-xml.py: Added to project.
1439 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1441 * tools/pep-html-template: Added to project.
1443 * tools/pep2html.py: Added to project from Python (nondist/peps).
1444 Added support for Docutils (reStructuredText PEPs).
1446 * tools/quicktest.py:
1448 - Added the ``--attributes`` option, hacked a bit.
1449 - Added a second command-line argument (output file); cleaned up.
1451 * tools/stylesheets/: Subdirectory added to project.
1453 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1456 Release 0.1 (2002-04-20)
1457 ========================
1459 This is the first release of Docutils, merged from the now inactive
1460 reStructuredText__ and `Docstring Processing System`__ projects. For
1461 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1462 `DPS HISTORY`__ files.
1464 __ http://structuredtext.sourceforge.net/
1465 __ http://docstring.sourceforge.net/
1466 __ http://structuredtext.sourceforge.net/HISTORY.html
1467 __ http://docstring.sourceforge.net/HISTORY.html
1469 General changes: renamed 'dps' package to 'docutils'; renamed
1470 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1471 the test suites (reStructuredText's test/test_states renamed to
1472 test/test_rst); and all modifications required to make it all work.
1474 * docutils/parsers/rst/states.py:
1476 - Improved diagnostic system messages for missing blank lines.
1477 - Fixed substitution_reference bug.
1483 indent-tabs-mode: nil
1484 sentence-end-double-space: t