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.
17 * docutils/frontend.py:
19 - Added options: --input-encoding-error-handler,
20 --record-dependencies, --leave-footnote-reference-space,
22 - Added command-line and config file support for "overrides" setting
27 - Added support for input encoding error handler.
31 - Added dispatch_visit and dispatch_departure methods to
32 NodeVisitor; useful as a hook for Visitors.
33 - Changed structure of ``line_block``; added ``line``.
34 - Added ``compound`` node class.
35 - Added a mechanism for Visitors to transitionally ignore new node
38 * docutils/parsers/rst/states.py:
40 - Fixed bug where a "role" directive in a nested parse would crash
41 the parser; the state machine's "language" attribute was not being
43 - Added support for line block syntax.
44 - Fixed directive parsing bug: argument-less directives didn't
45 notice that arguments were present.
46 - Removed error checking for transitions.
48 * docutils/parsers/rst/directives/__init__.py:
50 - Added ``encoding`` directive option conversion function.
52 * docutils/parsers/rst/directives/body.py:
54 - Converted the line-block directive to use the new structure.
55 - Extracted the old line-block functionality to the ``block``
56 function (still used).
57 - Added ``compound`` directive (thanks to Felix Wiemann).
59 * docutils/parsers/rst/directives/misc.py:
61 - Added "encoding" option to "include" and "raw" directives.
63 * docutils/parsers/rst/directives/parts.py:
65 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
66 options. Thanks to Lele Gaifax.
68 * docutils/parsers/rst/directives/tables.py:
70 - Added "encoding" directive to "csv-table" directive.
71 - Added workaround for lack of Unicode support in csv.py, for
74 * docutils/transforms/misc.py:
76 - Fixed bug when multiple "class" directives are applied to a single
79 * docutils/transforms/universal.py:
81 - FinalChecks now checks for illegal transitions and moves
82 transitions between sections.
84 * docutils/writers/html4css1.py:
86 - HTMLTranslator.encode now converts U+00A0 to " ".
87 - "stylesheet" and "stylesheet_path" settings are now mutually
89 - Added support for the new line_block/line structure.
90 - --footnote-references now overrides
91 --trim-footnote-reference-space, if applicable.
92 - Added support for ``compound`` elements.
94 * docutils/writers/latex2e.py:
96 - no newline after depart_term.
97 - Added translations for some Unicode quotes.
98 - Added option "font-encoding", made package AE the default.
99 - "stylesheet" and "stylesheet_path" settings are now mutually
101 - --footnote-references now overrides
102 --trim-footnote-reference-space, if applicable.
103 - The footnote label style now matches the footnote reference style
104 ("brackets" or "superscript").
105 - Added support for ``compound`` elements.
107 * docs/ref/docutils.dtd:
109 - Changed structure of the ``line_block`` element; added ``line``.
110 - Added ``compound`` element.
112 * docs/ref/rst/directives.txt
114 - Marked "line-block" as deprecated.
116 * docs/ref/rst/restructuredtext.txt:
118 - Added syntax for line blocks.
120 * tools/stylesheets/default.css:
122 - Added support for the new line_block structure.
125 Release 0.3.5 (2004-07-29)
126 ==========================
130 * _`Documentation cleanup/reorganization`.
132 - Created new subdirectories of docs/:
134 * ``docs/user/``: introductory/tutorial material for end-users
135 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
136 * ``docs/api/``: API reference material for client-developers
137 * ``docs/ref/``: reference material for all groups
138 * ``docs/howto/``: for component-developers and core-developers
139 * ``docs/peps/``: Python Enhancement Proposals
141 - Moved ``docs/*`` to ``docs/user/``.
142 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
143 ``spec/`` to ``docs/dev``.
144 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
145 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
146 - Moved ``alternatives.txt``, and ``problems.txt`` from
147 ``spec/rst/`` to ``docs/dev/rst/``.
148 - Moved ``reStructuredText.txt``, ``directives.txt``,
149 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
150 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
151 ``roles.txt``, ``reStructuredText.txt`` to
152 ``restructuredtext.txt``.
153 - Moved ``spec/howto/`` to ``docs/howto``.
155 In order to keep the CVS history of moved files, we supplied
156 SourceForge with a `script for modifying the Docutils CVS
159 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
161 After running the cleanup script:
163 - Added ``docs/index.txt``.
164 - Added a ``.htaccess`` file to the ``web`` module, containing
165 redirects for all old paths to new paths. They'll preserve
166 fragments (the "#name" part of a URL), and won't clutter up the
167 file system, and will correct the URL in the user's browser.
168 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
169 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
170 the "To Do" list itself in ``docs/dev/todo.txt``.
171 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
172 section of ``docs/dev/todo.txt``.
173 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
174 - Added "How To Report Bugs" to ``BUGS.txt``.
175 - Went through all the sources and docs (including under web/) and
176 updated links. Mostly done by Felix Wiemann; thanks Felix!
177 (Still need to update links in the sandboxes.)
181 * BUGS.txt: Added to project.
183 * THANKS.txt: Added to project.
185 * docutils/__init__.py:
187 - 0.3.4: Post-release.
191 - Added special error handling & advice for UnicodeEncodeError.
192 - Refactored Publisher.publish (simplified exception handling &
193 extracted debug dumps).
194 - Renamed "enable_exit" parameter of convenience functions to
195 "enable_exit_status".
196 - Enabled traceback (exception propagation) by default in
197 programmatic convenience functions.
198 - Now publish_file and publish_cmdline convenience functions return
199 the encoded string results in addition to their regular I/O.
200 - Extracted common code from publish_file, publish_string, and
201 publish_parts, into new publish_programmatically. Extracted
202 settings code to ``Publisher.process_programmatic_settings``.
203 - In Publisher.publish, disabled ``settings_overrides`` when
204 ``settings`` is supplied; redundant.
206 * docutils/frontend.py:
208 - Added help text for "--output-encoding-error-handler" and
209 "--error-encoding-error-handler".
210 - Renamed "--exit" to "--exit-status".
211 - Simplified default-setting code.
213 * docutils/parsers/rst/__init__.py:
215 - Added "--pep-base-url" and "--rfc-base-url" options.
217 * docutils/parsers/rst/states.py:
219 - Made URI recognition more aggressive and intelligent.
221 * docutils/parsers/rst/directives/__init__.py:
223 - Added several directive option conversion functions.
225 * docutils/parsers/rst/directives/body.py:
227 - Moved "table" directive to tables.py.
229 * docutils/parsers/rst/directives/tables.py: Table-related directives,
232 * docutils/writers/latex2e.py:
234 - Added "--table-style=(standard|booktabs|nolines)"
235 - figures get "here" option (LaTeX per default puts them at bottom),
236 and figure content is centered.
237 - Rowspan support for tables.
238 - Fix: admonition titles before first section.
239 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
240 - Replave ``_`` in literal by an underlined blank, because it has the correct
242 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
243 - A few unicode replacements, if output_encoding != utf
244 - Add "--graphicx-option".
245 - Indent literal-blocks.
246 - Fix: omit ``\maketitle`` when there is no document title.
248 * docs/index.txt: "Docutils Project Documentation Overview", added to
251 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
252 Tool", added to project.
254 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
256 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
258 * docs/dev/policies.txt: Added to project (extracted from
259 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
261 * docs/dev/release.txt: Added to project (extracted from
262 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
264 * docs/dev/testing.txt: Added to project.
266 * docs/dev/website.txt: Added to project (extracted from
267 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
269 * docs/ref/rst/directives.txt:
271 - Added directives: "table", "csv-table".
273 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
274 added to project. 1 page for syntax, and a 1 page reference for
275 directives and roles. Source text to be used as-is; not meant to be
278 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
279 with a change of title.
281 * test/functional/, contents, and test/test_functional.py: Added to
284 * tools/buildhtml.py: Fixed bug with config file handling.
286 * tools/html.py: Removed from project (duplicate of rst2html.py).
288 * tools/pep2html.py: Removed from project (duplicate of Python's
289 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
290 Docutils-related PEPs in docs/peps/).
292 * tools/rst2pseudoxml.py: Renamed from publish.py.
294 * tools/rst2xml.py: Renamed from docutils-xml.py.
296 * tools/test.txt: Removed from project; moved to
297 docs/user/rst/demo.txt.
299 * setup.py: Now also installs ``rst2latex.py``.
302 Release 0.3.3 (2004-05-09)
303 ==========================
305 * docutils/__init__.py:
307 - 0.3.1: Reorganized config file format (multiple sections); see
309 - Added unknown_reference_resolvers attribute to TransformSpec.
310 - 0.3.2: Interpreted text reorganization.
315 - Catch system messages to stop tracebacks from parsing errors.
316 - Catch exceptions during processing report & exit without
317 tracebacks, except when "--traceback" used.
318 - Reordered components for OptionParser; application comes last.
319 - Added "config_section" parameter to several methods and functions,
320 allowing front ends to easily specify their config file sections.
321 - Added publish_parts convenience function to allow access to individual
324 * docutils/examples.py: Added to project; practical examples of
325 Docutils client code, to be used as-is or as models for variations.
327 * docutils/frontend.py:
329 - Added "--traceback" & "--no-traceback" options ("traceback"
331 - Implemented support for config file reorganization:
332 ``standard_config_files`` moved from ``ConfigParser`` to
333 ``OptionParser``; added
334 ``OptionParser.get_config_file_settings()`` and
335 ``.get_standard_config_settings()``; support for old "[options]"
336 section (with deprecation warning) and mapping from old to new
338 - Reimplemented setting validation.
339 - Enabled flexible boolean values: yes/no, true/false, on/off.
340 - Added ``Values``, a subclass of ``optparse.Values``, with support
341 for list setting attributes.
342 - Added support for new ``DOCUTILSCONFIG`` environment variable;
343 thanks to Beni Cherniavsky.
344 - Added "--no-section-numbering" option.
348 - Catch IOErrors when opening source & destination files, report &
349 exit without tracebacks. Added ``handle_io_errors`` parameter to
350 ``FileInput`` & ``FileOutput`` to enable caller error handling.
354 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
355 method definitions (via ``exec``) to dynamic assignments (via
356 ``setattr``); thanks to Roman Suzi.
357 - Encapsulated visitor dynamic assignments in a function; thanks to
359 - Added indirect_reference_name attribute to the Targetable
360 class. This attribute holds the whitespace_normalized_name
361 (contains mixed case) of a target.
363 * docutils/statemachine.py:
365 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
366 - Added ``StringList.get_2D_block``.
370 - Added "level" attribute to SystemMessage exceptions.
372 * docutils/languages/af.py: Added to project; Afrikaans mappings by
375 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
378 * docutils/languages/eo.py: Added to project; Esperanto mappings by
379 Marcelo Huerta San Martin.
381 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
382 mappings by Lalo Martins.
384 * docutils/languages/ru.py: Added to project; Russian mappings by
387 * docutils/parsers/rst/roles.py: Added to project. Contains
388 interpreted text role functions, a registry for interpreted text
389 roles, and an API for adding to and retrieving from the registry.
390 Contributed by Edward Loper.
392 * docutils/parsers/rst/states.py:
394 - Updated ``RSTState.nested_parse`` for "include" in table cells.
395 - Allowed true em-dash character and "---" as block quote
397 - Added support for <angle-bracketed> complex option arguments
399 - Fixed handling of backslashes in substitution definitions.
400 - Fixed off-by-1 error with extra whitespace after substitution
401 definition directive.
402 - Added inline markup parsing to field lists' field names.
403 - Added support for quoted (and unindented) literal blocks.
404 Driven in part by a bribe from Frank Siebenlist (thanks!).
405 - Parser now handles escapes in URIs correctly.
406 - Made embedded-URIs' reference text omittable. Idea from Beni
408 - Refactored explicit target processing code.
409 - Added name attribute to references containing the reference name only
410 through whitespace_normalize_name (no case changes).
411 - parse_target no longer returns the refname after going through
412 normalize_name. This is now handled in make_target.
413 - Fixed bug relating to role-less interpreted text in non-English
415 - Reorganized interpreted text processing; moved code into the new
416 roles.py module. Contributed by Edward Loper.
417 - Refactored ``Body.parse_directive`` into ``run_directive`` and
418 ``parse_directive_block``.
420 * docutils/parsers/rst/tableparser.py:
422 - Reworked for ``StringList``, to support "include" directives in
425 * docutils/parsers/rst/directives/__init__.py:
427 - Renamed ``unchanged()`` directive option conversion function to
428 ``unchanged_required``, and added a new ``unchanged``.
429 - Catch unicode value too high error; fixes bug 781766.
430 - Beefed up directive error reporting.
432 * docutils/parsers/rst/directives/body.py:
434 - Added basic "table" directive.
436 * docutils/parsers/rst/directives/images.py:
438 - Added "target" option to "image" directive.
439 - Added name attribute to references containing the reference name only
440 through whitespace_normalize_name (no case changes).
442 * docutils/parsers/rst/directives/misc.py:
444 - Isolated the import of the ``urllib2`` module; was causing
445 problems on SourceForge (``libssl.so.2`` unavailable?).
446 - Added the "role" directive for declaring custom interpreted text
449 * docutils/parsers/rst/directives/parts.py:
451 - The "contents" directive does more work up-front, creating the
452 "topic" and "title", and leaving the "pending" node for the
453 transform. Allows earlier reference resolution; fixes subtle bug.
455 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
456 mappings by Jannie Hofmeyr.
458 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
459 mappings by Marek Blaha.
461 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
462 mappings by Marcelo Huerta San Martin.
464 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
465 Portuguese mappings by Lalo Martins.
467 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
468 mappings by Roman Suzi.
470 * docutils/transforms/parts.py:
472 - The "contents" directive does more work up-front, creating the
473 "topic" and "title", and leaving the "pending" node for the
474 transform. Allows earlier reference resolution; fixes subtle bug.
475 - Added support for disabling of section numbering.
477 * docutils/transforms/references.py:
479 - Verifying that external targets are truly targets and not indirect
480 references. This is because we are now adding a "name" attribute to
481 references in addition to targets. Note sure if this is correct!
482 - Added code to hook into the unknown_reference_resolvers list for a
483 transformer in resolve_indirect_target. This allows the
484 unknown_reference_resolvers to keep around indirect targets which
485 docutils doesn't know about.
486 - Added specific error message for duplicate targets.
488 * docutils/transforms/universal.py:
490 - Added FilterMessages transform (removes system messages below the
491 verbosity threshold).
492 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
493 to FinalCheckVisitor for application-specific handling of
494 unresolvable references.
495 - Added specific error message for duplicate targets.
497 * docutils/writers/__init__.py:
499 - Added assemble_parts method to the Writer class to allow for
500 access to a documents individual parts.
501 - Documented & set default for ``Writer.output`` attribute.
503 * docutils/writers/html4css1.py:
505 - Fixed unicode handling of attribute values (bug 760673).
506 - Prevent duplication of "class" attribute values (bug report from
508 - Improved table grid/border handling (prompted by report from Bob
510 - Added support for table titles.
511 - Added "<title />" for untitled docs, for XHTML conformance; thanks
513 - Added functionality to keep track of individual parts of a document
514 and store them in a dictionary as the "parts" attribute of the writer.
515 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
516 - Added proper support for the "scale" attribute of the "image"
517 element. Contributed by Brent Cook.
518 - Added ``--initial-header-level`` option.
519 - Fixed bug: the body_pre_docinfo segment depended on there being a
520 docinfo; if no docinfo, the document title was incorporated into
521 the body segment. Adversely affected the publish_parts interface.
523 * docutils/writers/latex2e.py:
525 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
526 about a missing file.
527 - Added options and support: ``--compound-enumerators``,
528 ``--section-prefix-for-enumerators``, and
529 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
531 - Added option ``--use-verbatim-when-possible``, to avoid
532 problematic characters (eg, '~' in italian) in literal blocks.
533 - It's now possible to use four section levels in the `book` and
534 `report` LaTeX classes. The default `article` class still has
537 * docs/config.txt: "Docutils Configuration Files", added to project.
538 Moved config file entry descriptions from tools.txt.
542 - Moved config file entry descriptions to config.txt.
544 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
547 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
548 Text Roles", added to project.
550 * spec/rst/reStructuredText.txt:
552 - Added description of support for <angle-bracketed> complex option
553 arguments to option lists.
554 - Added subsections for indented and quoted literal blocks.
556 * test: Continually adding & updating tests.
558 - Added test/test_settings.py & test/data/config_*.txt support
560 - Added test/test_writers/test_htmlfragment.py.
562 * test/DocutilsTestSupport.py:
564 - Refactored LaTeX publisher test suite/case class names to make
565 testing other writers easier.
566 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
567 to test the processing of HTML fragments which use the new
568 publish_parts convenience function.
570 * tools/buildhtml.py:
572 - Added support for the "--prune" option.
573 - Removed dependency on pep2html.py; plaintext PEPs no longer
576 * tools/docutils.conf:
578 - Updated for configuration file reorganization.
582 - copied from tools/html.py
586 - added a 'scripts' section to configuration
587 - added 'tools/rst2html.py' to the scripts section
590 Release 0.3 (2003-06-24)
591 ========================
595 * Renamed "attribute" to "option" for directives/extensions.
597 * Renamed transform method "transform" to "apply".
599 * Renamed "options" to "settings" for runtime settings (as set by
600 command-line options). Sometimes "option" (singular) became
601 "settings" (plural). Some variations below:
603 - document.options -> document.settings (stored in other objects as
605 - option_spec -> settings_spec (not directives though)
606 - OptionSpec -> SettingsSpec
607 - cmdline_options -> settings_spec
608 - relative_path_options -> relative_path_settings
609 - option_default_overrides -> settings_default_overrides
610 - Publisher.set_options -> Publisher.get_settings
614 * COPYING.txt: Added "Public Domain Dedication".
616 * FAQ.txt: Frequently asked questions, added to project.
620 - Updated with PyPI Trove classifiers.
621 - Conditional installation of third-party modules.
623 * docutils/__init__.py:
625 - Bumped version to 0.2.1 to reflect changes to I/O classes.
626 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
627 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
628 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
629 option and its effect on the PEP template & writer.
630 - Bumped version to 0.2.4 due to changes to the PEP template &
632 - Bumped version to 0.2.5 to reflect changes to Reporter output.
633 - Added ``TransformSpec`` class for new transform system.
634 - Bumped version to 0.2.6 for API changes (renaming).
635 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
636 convenience functions.
637 - Added ``Component.component_type`` attribute.
638 - Bumped version to 0.2.8 because of the internal parser switch from
639 plain lists to the docutils.statemachine.StringList objects.
640 - Bumped version to 0.2.9 because of the frontend.py API changes.
641 - Bumped version to 0.2.10 due to changes to the project layout
642 (third-party modules removed from the "docutils" package), and
643 signature changes in ``io.Input``/``io.Output``.
644 - Changed version to 0.3.0 for release.
648 - Made ``publish()`` a bit more convenient.
649 - Generalized ``Publisher.set_io``.
650 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
651 parameters; improved its docstring.
652 - Added ``publish_file()`` and ``publish_string()``.
653 - Factored ``Publisher.set_source()`` and ``.set_destination()``
655 - Added support for "--dump-pseudo-xml", "--dump-settings", and
656 "--dump-transforms" hidden options.
657 - Added ``Publisher.apply_transforms()`` method.
658 - Added ``Publisher.set_components()`` method; support for
659 ``publish_*()`` conveninece functions.
660 - Moved config file processing to docutils/frontend.py.
661 - Added support for exit status ("exit_level" setting &
662 ``enable_exit`` parameter for Publisher.publish() and convenience
665 * docutils/frontend.py:
667 - Check for & exit on identical source & destination paths.
668 - Fixed bug with absolute paths & "--config".
669 - Set non-command-line defaults in ``OptionParser.__init__()``:
670 ``_source`` & ``_destination``.
671 - Distributed ``relative_path_settings`` to components; updated
672 ``OptionParser.populate_from_components()`` to combine it all.
673 - Require list of keys in ``make_paths_absolute`` (was implicit in
674 global ``relative_path_settings``).
675 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
676 "--dump-settings", and "--dump-transforms" hidden options.
677 - Removed nasty internals-fiddling ``ConfigParser.get_section``
678 code, replaced with correct code.
679 - Added validation functionality for config files.
680 - Added "--error-encoding" option/setting, "_disable_config"
682 - Added encoding validation; updated "--input-encoding" and
683 "--output-encoding"; added "--error-encoding-error-handler" and
684 "--output-encoding-error-handler".
685 - Moved config file processing from docutils/core.py.
686 - Updated ``OptionParser.populate_from_components`` to handle new
687 ``SettingsSpec.settings_defaults`` dict.
688 - Added support for "-" => stdin/stdout.
689 - Added "exit_level" setting ("--exit" option).
693 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
694 - Added automatic closing to ``FileInput`` and ``FileOutput``.
695 - Delayed opening of ``FileOutput`` file until ``write()`` called.
696 - ``FileOutput.write()`` now returns the encoded output string.
697 - Try to get path/stream name automatically in ``FileInput`` &
699 - Added defaults for source & destination paths.
700 - Allow for Unicode I/O with an explicit "unicode" encoding.
701 - Added ``Output.encode()``.
702 - Removed dependency on runtime settings; pass encoding directly.
703 - Recognize Unicode strings in ``Input.decode()``.
704 - Added support for output encoding error handlers.
708 - Added "Invisible" element category class.
709 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
710 modification during a traversal.
711 - Added element classes: ``line_block``, ``generated``, ``address``,
712 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
713 ``superscript``, ``subscript``, ``inline``
714 - Added support for lists of nodes to ``Element.insert()``.
715 - Fixed parent linking in ``Element.replace()``.
716 - Added new abstract superclass ``FixedTextElement``; adds
717 "xml:space" attribute.
718 - Added support for "line" attribute of ``system_message`` nodes.
719 - Added support for the observer pattern from ``utils.Reporter``.
720 Added ``parse_messages`` and ``transform_messages`` attributes to
721 ``document``, removed ``messages``. Added ``note_parse_message``
722 and ``note_transform_message`` methods.
723 - Added support for improved diagnostics:
725 - Added "document", "source", and "line" internal attributes to
726 ``Node``, set by ``Node.setup_child()``.
727 - Converted variations on ``node.parent = self`` to
728 ``self.setup_child(node)``.
729 - Added ``document.current_source`` & ``.current_line``
730 attributes, and ``.note_source`` observer method.
731 - Changed "system_message" output to GNU-Tools format.
733 - Added a "rawsource" attribute to the ``Text`` class, for text
734 before backslash-escape resolution.
735 - Support for new transform system.
736 - Reworked ``pending`` element.
737 - Fixed XML DOM bug (SF #660611).
738 - Removed the ``interpeted`` element class and added
739 ``title_reference``, ``abbreviation``, ``acronym``.
740 - Made substitutions case-sensitive-but-forgiving; moved some code
742 - Fixed Unicode bug on element attributes (report: William Dode).
744 * docutils/optik.py: Removed from project; replaced with
745 extras/optparse.py and extras/textwrap.py. These will be installed
746 only if they're not already present in the Python installation.
748 * docutils/roman.py: Moved to extras/roman.py; this will be installed
749 only if it's not already present in the Python installation.
751 * docutils/statemachine.py:
753 - Factored out ``State.add_initial_transitions()`` so it can be
755 - Converted whitespace-specific "blank" and "indent" transitions
756 from special-case code to ordinary transitions: removed
757 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
758 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
759 ``ws_initial_transitions`` attributes.
760 - Removed ``State.match_transition()`` after merging it into
762 - Added ``StateCorrection`` exception.
763 - Added support for ``StateCorrection`` in ``StateMachine.run()``
764 (moved ``TransitionCorrection`` support there too.)
765 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
766 ``EOFError`` instead of ``IndexError``.
767 - Added ``State.no_match`` method.
768 - Added support for the Observer pattern, triggered by input line
770 - Added ``strip_top`` parameter to
771 ``StateMachineWS.get_first_known_indented``.
772 - Made ``context`` a parameter to ``StateMachine.run()``.
773 - Added ``ViewList`` & ``StringList`` classes;
774 ``extract_indented()`` becomes ``StringList.get_indented()``.
775 - Added ``StateMachine.insert_input()``.
776 - Fixed ViewList slice handling for Python 2.3. Patch from (and
777 thanks to) Fred Drake.
781 - Added a ``source`` attribute to Reporter instances and
782 ``system_message`` elements.
783 - Added an observer pattern to ``utils.Reporter`` to keep track of
785 - Fixed bugs in ``relative_path()``.
786 - Added support for improved diagnostics.
787 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
788 - Added support for encoding Reporter stderr output, and encoding
790 - Reporter keeps track of the highest level system message yet
793 * docutils/languages: Fixed bibliographic field language lookups.
795 * docutils/languages/es.py: Added to project; Spanish mappings by
796 Marcelo Huerta San Martin.
798 * docutils/languages/fr.py: Added to project; French mappings by
801 * docutils/languages/it.py: Added to project; Italian mappings by
804 * docutils/languages/sk.py: Added to project; Slovak mappings by
807 * docutils/parser/__init__.py:
809 - Added ``Parser.finish_parse()`` method.
811 * docutils/parser/rst/__init__.py:
813 - Added options: "--pep-references", "--rfc-references",
814 "--tab-width", "--trim-footnote-reference-space".
816 * docutils/parsers/rst/states.py:
818 - Changed "title under/overline too short" system messages from INFO
819 to WARNING, and fixed its insertion location.
820 - Fixed enumerated list item parsing to allow paragraphs & section
821 titles to begin with enumerators.
822 - Converted system messages to use the new "line" attribute.
823 - Fixed a substitution reference edge case.
824 - Added support for "--pep-references" and "--rfc-references"
825 options; reworked ``Inliner`` code to make customization easier.
826 - Removed field argument parsing.
827 - Added support for short section title over/underlines.
828 - Fixed "simple reference name" regexp to ignore text like
829 "object.__method__"; not an anonymous reference.
830 - Added support for improved diagnostics.
831 - Reworked directive API, based on Dethe Elza's contribution. Added
832 ``Body.parse_directive()``, ``.parse_directive_options()``,
833 ``.parse_directive_arguments()`` methods.
834 - Added ``ExtensionOptions`` class, to parse directive options
835 without parsing field bodies. Factored
836 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
837 ``ExtensionOptions``.
838 - Improved definition list term/classifier parsing.
839 - Added warnings for unknown directives.
840 - Renamed ``Stuff`` to ``Struct``.
841 - Now flagged as errors: transitions at the beginning or end of
842 sections, empty sections (except title), and empty documents.
843 - Updated for ``statemachine.StringList``.
844 - Enabled recognition of schemeless email addresses in targets.
845 - Added support for embedded URIs in hyperlink references.
846 - Added backslash-escapes to inline markup end-string suffix.
847 - Added support for correct interpreted text processing.
848 - Fixed nested title parsing (topic, sidebar directives).
849 - Added special processing of backslash-escaped whitespace (idea
850 from David Abrahams).
851 - Made substitutions case-sensitive-but-forgiving; moved some code
852 to ``docutils.nodes``.
853 - Added support for block quote attributions.
854 - Added a kludge to work-around a conflict between the bubble-up
855 parser strategy and short titles (<= 3 char-long over- &
856 underlines). Fixes SF bug #738803 "infinite loop with multiple
857 titles" submitted by Jason Diamond.
858 - Added explicit interpreted text roles for standard inline markup:
859 "emphasis", "strong", "literal".
860 - Implemented "superscript" and "subscript" interpreted text roles.
861 - Added initial support for "abbreviation" and "acronym" roles;
863 - Added support for "--trim-footnote-reference-space" option.
864 - Optional space before colons in directives & hyperlink targets.
866 * docutils/parsers/rst/tableparser.py:
868 - Fixed a bug that was producing unwanted empty rows in "simple"
870 - Detect bad column spans in "simple" tables.
872 * docutils/parsers/rst/directives: Updated all directive functions to
875 * docutils/parsers/rst/directives/__init__.py:
877 - Added ``flag()``, ``unchanged()``, ``path()``,
878 ``nonnegative_int()``, ``choice()``, and ``class_option()``
879 directive option helper functions.
880 - Added warnings for unknown directives.
881 - Return ``None`` for missing directives.
882 - Added ``register_directive()``, thanks to William Dode and Paul
885 * docutils/parsers/rst/directives/admonitions.py:
887 - Added "admonition" directive.
889 * docutils/parsers/rst/directives/body.py: Added to project. Contains
890 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
891 "parsed-literal", "rubric", "epigraph", "highlights" and
892 "pull-quote" directives.
894 * docutils/parsers/rst/directives/images.py:
896 - Added an "align" attribute to the "image" & "figure" directives
897 (by Adam Chodorowski).
898 - Added "class" option to "image", and "figclass" to "figure".
900 * docutils/parsers/rst/directives/misc.py:
902 - Added "include", "raw", and "replace" directives, courtesy of
904 - Added "unicode" and "class" directives.
906 * docutils/parsers/rst/directives/parts.py:
908 - Added the "sectnum" directive; by Dmitry Jemerov.
909 - Added "class" option to "contents" directive.
911 * docutils/parsers/rst/directives/references.py: Added to project.
912 Contains the "target-notes" directive.
914 * docutils/parsers/rst/languages/__init__.py:
916 - Return ``None`` from get_language() for missing language modules.
918 * docutils/parsers/rst/languages/de.py: Added to project; German
919 mappings by Engelbert Gruber.
921 * docutils/parsers/rst/languages/en.py:
923 - Added interpreted text roles mapping.
925 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
926 mappings by Marcelo Huerta San Martin.
928 * docutils/parsers/rst/languages/fr.py: Added to project; French
929 mappings by William Dode.
931 * docutils/parsers/rst/languages/it.py: Added to project; Italian
932 mappings by Nicola Larosa.
934 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
935 mappings by Miroslav Vasko.
937 * docutils/readers/__init__.py:
939 - Added support for the observer pattern from ``utils.Reporter``, in
940 ``Reader.parse`` and ``Reader.transform``.
941 - Removed ``Reader.transform()`` method.
942 - Added default parameter values to ``Reader.__init__()`` to make
943 instantiation easier.
944 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
946 * docutils/readers/pep.py:
948 - Added the ``peps.TargetNotes`` transform to the Reader.
949 - Removed PEP & RFC reference detection code; moved to
950 parsers/rst/states.py as options (enabled here by default).
951 - Added support for pre-acceptance PEPs (no PEP number yet).
952 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
955 * docutils/readers/python: Python Source Reader subpackage added to
956 project, including preliminary versions of:
959 - moduleparser.py: Parser for Python modules.
961 * docutils/transforms/__init__.py:
963 - Added ``Transformer`` class and completed transform reform.
964 - Added unknown_reference_resolvers list for each transformer. This list holds
965 the list of functions provided by each component of the transformer that
966 help resolve references.
968 * docutils/transforms/frontmatter.py:
970 - Improved support for generic fields.
971 - Fixed bibliographic field language lookups.
973 * docutils/transforms/misc.py: Added to project. Miscellaneous
976 * docutils/transforms/parts.py:
978 - Moved the "id" attribute from TOC list items to the references
979 (``Contents.build_contents()``).
980 - Added the ``SectNum`` transform; by Dmitry Jemerov.
981 - Added "class" attribute support to ``Contents``.
983 * docutils/transforms/peps.py:
985 - Added ``mask_email()`` function, updating to pep2html.py's
987 - Linked "Content-Type: text/x-rst" to PEP 12.
988 - Added the ``TargetNotes`` PEP-specific transform.
989 - Added ``TargetNotes.cleanup_callback``.
990 - Added title check to ``Headers``.
992 * docutils/transforms/references.py:
994 - Added the ``TargetNotes`` generic transform.
995 - Split ``Hyperlinks`` into multiple transforms.
996 - Fixed bug with multiply-indirect references (report: Bruce Smith).
997 - Added check for circular indirect references.
998 - Made substitutions case-sensitive-but-forgiving.
1000 * docutils/transforms/universal.py:
1002 - Added support for the "--expose-internal-attributes" option.
1003 - Removed ``Pending`` transform classes & data.
1005 * docutils/writers/__init__.py:
1007 - Removed ``Writer.transform()`` method.
1009 * docutils/writers/docutils-xml.py:
1011 - Added XML and doctype declarations.
1012 - Added "--no-doctype" and "--no-xml-declaration" options.
1014 * docutils/writers/html4css1.py:
1016 - "name" attributes only on these tags: a, applet, form, frame,
1018 - Added "name" attribute to <a> in section titles for Netscape 4
1019 support (bug report: Pearu Peterson).
1020 - Fixed targets (names) on footnote, citation, topic title,
1021 problematic, and system_message nodes (for Netscape 4).
1022 - Changed field names from "<td>" to "<th>".
1023 - Added "@" to "@" encoding to thwart address harvesters.
1024 - Improved the vertical whitespace optimization; ignore "invisible"
1025 nodes (targets, comments, etc.).
1026 - Improved inline literals with ``<span class="pre">`` around chunks
1027 of text and `` `` for runs of spaces.
1028 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1029 ``self.docinfo`` segments.
1030 - Added support for "line_block", "address" elements.
1031 - Improved backlinks (footnotes & system_messages).
1032 - Improved system_message output.
1033 - Redefined "--stylesheet" as containing an invariant URL, used
1034 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1036 - Added "--footnote-references" option (superscript or brackets).
1037 - Added "--compact-lists" and "--no-compact-lists" options.
1038 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1039 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1040 - Improved field list rendering.
1041 - Added Docutils version to "generator" meta tag.
1042 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1043 - Improved layout of <pre> HTML source.
1044 - Fixed attribute typo on <colspec>.
1045 - Refined XML prologue.
1046 - Support for no stylesheet.
1047 - Removed "interpreted" element support.
1048 - Added support for "title_reference", "sidebar", "attribution",
1049 "rubric", and generic "admonition" elements.
1050 - Added "--attribution" option.
1051 - Added support for "inline", "subscript", "superscript" elements.
1052 - Added initial support for "abbreviation" and "acronym";
1055 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1059 - Double quotes in literal blocks (special treatment for de/ngerman).
1060 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1061 - Added "--attribution" option.
1062 - Right align attributions.
1064 * docutils/writers/pep_html.py:
1066 - Parameterized output encoding in PEP template.
1067 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1068 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1069 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1071 - Added an override on the "--footnote-references" option.
1072 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1073 - Added Docutils version to "generator" meta tag.
1074 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1078 - Added a "silent" setting for ``buildhtml.py``.
1079 - Added a "Getting Help" section.
1080 - Rearranged the structure.
1081 - Kept up to date, with new settings, command-line options etc.
1082 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1083 - Converted settings table into a definition list.
1085 * docs/rst/quickstart.txt:
1087 - Added a table of contents.
1088 - Added feedback information.
1089 - Added mention of minimum section title underline lengths.
1090 - Removed the 4-character minimum for section title underlines.
1092 * docs/rst/quickref.html:
1094 - Added a "Getting Help" section.
1095 - Added a style to make section title backlinks more subtle.
1096 - Added mention of minimum section title underline lengths.
1097 - Removed the 4-character minimum for section title underlines.
1099 * extras: Directory added to project; contains third-party modules
1100 that Docutils depends on (optparse, textwrap, roman). These are
1101 only installed if they're not already present.
1103 * licenses: Directory added to project; contains copies of license
1104 files for non-public-domain files.
1108 - Changed the focus. It's about DTD elements: structural
1109 relationships, semantics, and external (public) attributes. Not
1110 about the element class library.
1111 - Moved some implementation-specific stuff into ``docutils.nodes``
1113 - Wrote descriptions of all common attributes and parameter
1114 entities. Filled in introductory material.
1115 - Working through the element descriptions: 55 down, 37 to go.
1116 - Removed "Representation of Horizontal Rules" to
1117 spec/rst/alternatives.txt.
1119 * spec/docutils.dtd:
1121 - Added "generated" inline element.
1122 - Added "line_block" body element.
1123 - Added "auto" attribute to "title".
1124 - Changed content models of "literal_block" and "doctest_block" to
1126 - Added ``%number;`` attribute type parameter entity.
1127 - Changed ``%structural.elements;`` to ``%section.elements``.
1128 - Updated attribute types; made more specific.
1129 - Added "address" bibliographic element.
1130 - Added "line" attribute to ``system_message`` element.
1131 - Removed "field_argument" element; "field_name" may contain
1132 multiple words and whitespace.
1133 - Changed public identifier to docutils.sf.net.
1134 - Removed "interpreted" element; added "title_reference",
1135 "abbreviation", "acronym".
1136 - Removed "refuri" attribute from "footnote_reference" and
1137 "citation_reference".
1138 - Added "sidebar", "rubric", "attribution", "admonition",
1139 "superscript", "subscript", and "inline" elements.
1141 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1143 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1145 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1147 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1150 * spec/transforms.txt: Added to project.
1152 * spec/howto: Added subdirectory, for developer how-to docs.
1154 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1155 Elza, edited & extended by David Goodger.
1157 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1160 * spec/rst/alternatives.txt:
1162 - Added "Doctree Representation of Transitions" from
1164 - Updated "Inline External Targets" & closed the debate.
1165 - Added ideas for interpreted text syntax extensions.
1166 - Added "Nested Inline Markup" section.
1168 * spec/rst/directives.txt:
1170 - Added directives: "topic", "sectnum", "target-notes",
1171 "line-block", "parsed-literal", "include", "replace", "sidebar",
1172 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1174 - Formalized descriptions of directive details.
1175 - Added an "align" attribute to the "image" & "figure" directives
1176 (by Adam Chodorowski).
1177 - Added "class" options to "topic", "sidebar", "line-block",
1178 "parsed-literal", "contents", and "image"; and "figclass" to
1181 * spec/rst/interpreted.txt: Added to project. Descriptions of
1182 interpreted text roles.
1184 * spec/rst/introduction.txt:
1186 - Added pointers to material for new users.
1188 * spec/rst/reStructuredText.txt:
1190 - Disambiguated comments (just add a newline after the "::").
1191 - Updated enumerated list description; added a discussion of the
1192 second-line validity checking.
1193 - Updated directive description.
1194 - Added a note redirecting newbies to the user docs.
1195 - Expanded description of inline markup start-strings in non-markup
1197 - Removed field arguments and made field lists a generic construct.
1198 - Removed the 4-character minimum for section title underlines.
1199 - Clarified term/classifier delimiter & inline markup ambiguity
1201 - Added "Embedded URIs".
1202 - Updated "Interpreted Text" section.
1203 - Added "Character-Level Inline Markup" section.
1205 * test: Continually adding & updating tests.
1207 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1208 - Moved test/test_pep/ to test/test_readers/test_pep/.
1209 - Added test/test_readers/test_python/.
1210 - Added test/test_writers/ (Engelbert Gruber).
1214 - Made the ``locale.setlocale()`` calls in front ends
1217 * tools/buildhtml.py:
1219 - Added "--silent" option.
1220 - Fixed bug with absolute paths & "--config".
1221 - Updated for new I/O classes.
1222 - Added some exception handling.
1223 - Separated publishers' setting defaults; prevents interference.
1224 - Updated for new ``publish_file()`` convenience function.
1226 * tools/pep-html-template:
1228 - Allow for "--embed-stylesheet".
1229 - Added Docutils version to "generator" meta tag.
1230 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1231 - Conform to XHTML spec.
1233 * tools/pep2html.py:
1235 - Made ``argv`` a parameter to ``main()``.
1236 - Added support for "Content-Type:" header & arbitrary PEP formats.
1237 - Linked "Content-Type: text/plain" to PEP 9.
1238 - Files skipped (due to an error) are not pushed onto the server.
1239 - Updated for new I/O classes.
1240 - Added ``check_requirements()`` & ``pep_type_error()``.
1241 - Added some exception handling.
1242 - Updated for new ``publish_string()`` convenience function.
1243 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1245 * tools/quicktest.py:
1247 - Added "-V"/"--version" option.
1249 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1251 * tools/unicode2rstsubs.py: Added to project. Produces character
1252 entity files (reSructuredText substitutions) from the MathML master
1255 * tools/editors: Support code for editors, added to project. Contains
1256 ``emacs/restructuredtext.el``.
1258 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1260 - Added style for chunks of inline literals.
1261 - Removed margin for first child of table cells.
1262 - Right-aligned field list names.
1263 - Support for auto-numbered section titles in TOCs.
1264 - Increased the size of inline literals (<tt>) in titles.
1265 - Restored the light gray background for inline literals.
1266 - Added support for "line_block" elements.
1267 - Added style for "address" elements.
1268 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1269 - Improved field list rendering.
1270 - Vertical whitespace improvements.
1271 - Removed "a.target" style.
1273 * tools/stylesheets/pep.css:
1275 - Fixed nested section margins.
1276 - Other changes parallel those of ``../default.css``.
1279 Release 0.2 (2002-07-31)
1280 ========================
1284 - The word "component" was being used ambiguously. From now on,
1285 "component" will be used to mean "Docutils component", as in Reader,
1286 Writer, Parser, or Transform. Portions of documents (Table of
1287 Contents, sections, etc.) will be called "document parts".
1288 - Did a grand renaming: a lot of ``verylongnames`` became
1289 ``very_long_names``.
1290 - Cleaned up imports: no more relative package imports or
1291 comma-separated lists of top-level modules.
1292 - Added support for an option values object which carries default
1293 settings and overrides (from command-line options and library use).
1294 - Added internal Unicode support, and support for both input and
1296 - Added support for the ``docutils.io.IO`` class & subclasses.
1300 * docutils/__init__.py:
1302 - Added ``ApplicationError`` and ``DataError``, for use throughout
1304 - Added ``Component`` base class for Docutils components; implements
1305 the ``supports`` method.
1306 - Added ``__version__`` (thus, ``docutils.__version__``).
1310 - Removed many keyword parameters to ``Publisher.__init__()`` and
1311 ``publish()``; bundled into an option values object. Added
1312 "argv", "usage", "description", and "option_spec" parameters for
1313 command-line support.
1314 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1316 - Reworked I/O model for ``docutils.io`` wrappers.
1317 - Updated ``Publisher.set_options()``; now returns option values
1319 - Added support for configuration files (/etc/docutils.conf,
1320 ./docutils.conf, ~/.docutils).
1321 - Added ``Publisher.setup_option_parser()``.
1322 - Added default usage message and description.
1324 * docutils/frontend.py: Added to project; support for front-end
1325 (command-line) scripts. Option specifications may be augmented by
1326 components. Requires Optik (http://optik.sf.net/) for option
1327 processing (installed locally as docutils/optik.py).
1329 * docutils/io.py: Added to project; uniform API for a variety of input
1332 * docutils/nodes.py:
1334 - Added ``TreeCopyVisitor`` class.
1335 - Added a ``copy`` method to ``Node`` and subclasses.
1336 - Added a ``SkipDeparture`` exception for visitors.
1337 - Renamed ``TreePruningException`` from ``VisitorException``.
1338 - Added docstrings to ``TreePruningException``, subclasses, and
1340 - Improved docstrings.
1341 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1342 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1344 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1345 ``PreDecorative`` mixin.
1346 - Reworked the name/id bookkeeping; to ``document``, removed
1347 ``explicit_targets`` and ``implicit_targets`` attributes, added
1348 ``nametypes`` attribute and ``set_name_id_map`` method.
1349 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1351 - Added ``document.has_name()`` method.
1352 - Fixed DOM generation for list-attributes.
1353 - Added category class ``Labeled`` (used by footnotes & citations).
1354 - Added ``Element.set_class()`` method (sets "class" attribute).
1356 * docutils/optik.py: Added to project. Combined from the Optik
1357 package, with added option groups and other modifications. The use
1358 of this module is probably only temporary.
1360 * docutils/statemachine.py:
1362 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1363 - Added underscores to improve many awkward names.
1364 - In ``string2lines()``, changed whitespace normalizing translation
1365 table to regexp; restores Python 2.0 compatibility with Unicode.
1367 * docutils/urischemes.py:
1369 - Filled in some descriptions.
1370 - Added "shttp" scheme.
1372 * docutils/utils.py:
1374 - Added ``clean_rcs_keywords`` function (moved from
1375 docutils/transforms/frontmatter.py
1376 ``DocInfo.filter_rcs_keywords``).
1377 - Added underscores to improve many awkward names.
1378 - Changed names of Reporter's thresholds:
1379 warning_level -> report_level; error_level -> halt_level.
1380 - Moved ``utils.id()`` to ``nodes.make_id()``.
1381 - Added ``relative_path(source, target)``.
1383 * docutils/languages/de.py: German mappings; added to project. Thanks
1384 to Gunnar Schwant for the translations.
1386 * docutils/languages/en.py: Added "Dedication" bibliographic field
1389 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1392 * docutils/parsers/rst/states.py:
1394 - Added underscores to improve many awkward names.
1395 - Added RFC-2822 header support.
1396 - Extracted the inline parsing code from ``RSTState`` to a separate
1397 class, ``Inliner``, which will allow easy subclassing.
1398 - Made local bindings for ``memo`` container & often-used contents
1399 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1400 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1401 - Added ``MarkupMismatch`` exception; for late corrections.
1402 - Added ``-/:`` characters to inline markup's start string prefix,
1403 ``/`` to end string suffix.
1404 - Fixed a footnote bug.
1405 - Fixed a bug with literal blocks.
1406 - Applied patch from Simon Budig: simplified regexps with symbolic
1407 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1408 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1409 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1410 - Allowed non-ASCII in "simple names" (directive names, field names,
1412 - Converted ``Inliner.patterns.initial`` to be dynamically built
1413 from parts with ``build_regexp()`` function.
1414 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1415 - Updated docstrings.
1416 - Changed "table" to "grid_table"; added "simple_table" support.
1418 * docutils/parsers/rst/tableparser.py:
1420 - Changed ``TableParser`` to ``GridTableParser``.
1421 - Added ``SimpleTableParser``.
1422 - Refactored naming.
1424 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1425 a fallback language for directive names.
1427 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1428 directive to use a ``pending`` element, used only by HTML writers.
1430 * docutils/parsers/rst/directives/parts.py: Renamed from
1433 - Added "backlinks" attribute to "contents" directive.
1435 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1436 project by Adam Chodorowski.
1438 * docutils/readers/__init__.py: Gave Readers more control over
1439 choosing and instantiating Parsers.
1441 * docutils/readers/pep.py: Added to project; for PEP processing.
1443 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1444 requires a ``component`` parameter.
1446 * docutils/transforms/components.py: Added to project; transforms
1447 related to Docutils components.
1449 * docutils/transforms/frontmatter.py:
1451 - In ``DocInfo.extract_authors``, check for a single "author" in an
1452 "authors" group, and convert it to a single "author" element.
1453 - Added support for "Dedication" and generic bibliographic fields.
1455 * docutils/transforms/peps.py: Added to project; PEP-specific.
1457 * docutils/transforms/parts.py: Renamed from old components.py.
1459 - Added filter for `Contents`, to use alt-text for inline images,
1460 and to remove inline markup that doesn't make sense in the ToC.
1461 - Added "name" attribute to TOC topic depending on its title.
1462 - Added support for optional TOC backlinks.
1464 * docutils/transforms/references.py: Fixed indirect target resolution
1465 in ``Hyperlinks`` transform.
1467 * docutils/transforms/universal.py:
1469 - Changed ``Messages`` transform to properly filter out system
1470 messages below the warning threshold.
1471 - Added ``Decorations`` transform (support for ``--generator``,
1472 ``--date``, ``--time``, ``--source-link`` options).
1474 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1475 Engelbert Gruber's PDF writer.
1477 * docutils/writers/html4css1.py:
1479 - Made XHTML-compatible (switched to lowercase element & attribute
1480 names; empty tag format).
1481 - Escape double-dashes in comment text.
1482 - Improved boilerplate & modularity of output.
1483 - Exposed modular output in Writer class.
1484 - Added a "generator" meta tag to <head>.
1485 - Added support for the ``--stylesheet`` option.
1486 - Added support for ``decoration``, ``header``, and ``footer``
1488 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1489 translation table to regexp; restores Python 2.0 compatibility
1491 - Added the translator class as instance variable to the Writer, to
1492 make it easily subclassable.
1493 - Improved option list spacing (thanks to Richard Jones).
1494 - Modified field list output.
1495 - Added backlinks to footnotes & citations.
1496 - Added percentage widths to "<col>" tags (from colspec).
1497 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1498 "<span>" changed to "<var>".
1499 - Inline literals: "<code>" changed to "<tt>".
1500 - Many changes to optimize vertical space: compact simple lists etc.
1501 - Add a command-line options & directive attributes to control TOC
1502 and footnote/citation backlinks.
1503 - Added support for optional footnote/citation backlinks.
1504 - Added support for generic bibliographic fields.
1505 - Identify backrefs.
1506 - Relative URLs for stylesheet links.
1508 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1509 PEPs (subclass of ``html4css1.Writer``).
1511 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1513 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1514 of the Docutils internal doctree in XML.
1516 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1520 - Changed the title to "The Docutils Document Tree".
1521 - Added "Hyperlink Bookkeeping" section.
1523 * spec/docutils.dtd:
1525 - Added ``decoration``, ``header``, and ``footer`` elements.
1526 - Brought ``interpreted`` element in line with the parser: changed
1527 attribute "type" to "role", added "position".
1528 - Added support for generic bibliographic fields.
1530 * spec/notes.txt: Continual updates. Added "Project Policies".
1532 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1535 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1537 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1538 mailing list discussions.
1540 * spec/pep-0287.txt:
1542 - Renamed to "reStructuredText Docstring Format".
1544 - Reworked Q&A as an enumerated list.
1545 - Converted to reStructuredText format.
1547 * spec/pysource.dtd:
1549 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1551 * spec/pysource.txt: Removed from project. Moved much of its contents
1554 * spec/rst/alternatives.txt:
1556 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1557 - Added "Inline External Targets" section.
1559 * spec/rst/directives.txt:
1561 - Added "backlinks" attribute to "contents" directive.
1563 * spec/rst/problems.txt:
1565 - Updated the Enumerated List Markup discussion.
1566 - Added new alternative table markup syntaxes.
1568 * spec/rst/reStructuredText.txt:
1570 - Clarified field list usage.
1571 - Updated enumerated list description.
1572 - Clarified purpose of directives.
1573 - Added ``-/:`` characters to inline markup's start string prefix,
1574 ``/`` to end string suffix.
1575 - Updated "Authors" bibliographic field behavior.
1576 - Changed "inline hyperlink targets" to "inline internal targets".
1577 - Added "simple table" syntax to supplement the existing but
1578 newly-renamed "grid tables".
1579 - Added cautions for anonymous hyperlink use.
1580 - Added "Dedication" and generic bibliographic fields.
1582 * test: Made test modules standalone (subdirectories became packages).
1584 * test/DocutilsTestSupport.py:
1586 - Added support for PEP extensions to reStructuredText.
1587 - Added support for simple tables.
1588 - Refactored naming.
1590 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1592 - Now supports true packages containing test modules
1593 (``__init__.py`` files required); fixes duplicate module name bug.
1595 * test/test_pep/: Subpackage added to project; PEP testing.
1597 * test/test_rst/test_SimpleTableParser.py: Added to project.
1601 - Updated html.py and publish.py front-end tools to use the new
1602 command-line processing facilities of ``docutils.frontend``
1603 (exposed in ``docutils.core.Publisher``), reducing each to just a
1605 - Added ``locale.setlocale()`` calls to front-end tools.
1607 * tools/buildhtml.py: Added to project; batch-generates .html from all
1608 the .txt files in directories and subdirectories.
1610 * tools/default.css:
1612 - Added support for ``header`` and ``footer`` elements.
1613 - Added styles for "Dedication" topics (biblio fields).
1615 * tools/docutils.conf: A configuration file; added to project.
1617 * tools/docutils-xml.py: Added to project.
1619 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1621 * tools/pep-html-template: Added to project.
1623 * tools/pep2html.py: Added to project from Python (nondist/peps).
1624 Added support for Docutils (reStructuredText PEPs).
1626 * tools/quicktest.py:
1628 - Added the ``--attributes`` option, hacked a bit.
1629 - Added a second command-line argument (output file); cleaned up.
1631 * tools/stylesheets/: Subdirectory added to project.
1633 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1636 Release 0.1 (2002-04-20)
1637 ========================
1639 This is the first release of Docutils, merged from the now inactive
1640 reStructuredText__ and `Docstring Processing System`__ projects. For
1641 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1642 `DPS HISTORY`__ files.
1644 __ http://structuredtext.sourceforge.net/
1645 __ http://docstring.sourceforge.net/
1646 __ http://structuredtext.sourceforge.net/HISTORY.html
1647 __ http://docstring.sourceforge.net/HISTORY.html
1649 General changes: renamed 'dps' package to 'docutils'; renamed
1650 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1651 the test suites (reStructuredText's test/test_states renamed to
1652 test/test_rst); and all modifications required to make it all work.
1654 * docutils/parsers/rst/states.py:
1656 - Improved diagnostic system messages for missing blank lines.
1657 - Fixed substitution_reference bug.
1663 indent-tabs-mode: nil
1664 sentence-end-double-space: t