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.
19 - Eliminated and replaced all uses of the old string attributes
20 ``id``, ``name``, ``dupname`` and ``class`` with references to the
21 new list attributes ``ids``, ``names``, ``dupnames`` and
22 ``classes`` throughout the whole source tree.
26 - Enabled ``--dump-*`` options when ``--traceback`` specified,
27 allowing for easier debugging.
31 - Fixed ``Input.decode`` method to apply heuristics only if no
32 encoding is explicitly given, and to provide better reporting of
34 - The ``Input.decode`` method now removes byte order marks (BOMs)
39 - ``image`` element class changed to subclass of Element, not
40 TextElement (it's an empty element, and cannot contain text).
41 - Added ``attr_defaults`` dictionary for default attribute values.
42 - Added empty list as default value for the following attributes:
43 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
45 * docutils/languages/nl.py: Added to project; Dutch mappings by
48 * docutils/parsers/rst/__init__.py:
50 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
52 * docutils/parsers/rst/states.py:
54 - Added check for escaped at-mark to prevent email address recognition.
55 - Fixed option lists to allow spaces inside ``<angle-bracketed option
57 - Allowed whitespace in paths and URLs.
58 - Added auto-enumerated list items.
59 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
62 * docutils/parsers/rst/directives/__init__.py:
64 - Allowed whitespace in paths (``path`` function).
65 - Added ``uri`` directive option conversion function.
67 * docutils/parsers/rst/directives/images.py:
69 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
70 - Added support for the ``file_insertion_enabled`` setting in the
71 "figure" directive (disables "figwidth" option).
73 * docutils/parsers/rst/directives/misc.py:
75 - Fixed "include" and "raw" directives to catch text decoding
77 - Allowed whitespace in "include" & "raw" directive paths.
78 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
79 settings in "include" & "raw" directives.
81 * docutils/parsers/rst/directives/tables.py:
83 - Added "list-table" directive.
84 - Caught empty CSV table bug.
85 - Added support for the ``file_insertion_enabled`` setting in the
86 "csv-table" directive.
88 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
89 mappings by Martijn Pieters.
91 * docutils/transforms/references.py:
93 - Fixed mislocated internal targets bug, by propagating internal
94 targets to the next node, making use of the newly added support
95 for multiple names and IDs.
96 - Fixed duplicate footnote label bug.
97 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
100 * docutils/writers/html4css1.py:
102 - Fixed unencoded stylesheet reference bug (characters like "&" in
103 stylesheet references).
104 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
106 - Added support for multiple IDs per node by creating empty ``span``
109 * docutils/writers/latex2e.py:
111 - Improved --use-latex-docinfo so that organization/contact/address
112 fields are lumped with the last author field and appear on the
114 - Made sure the titlepage is always shown with --use-latex-docinfo,
115 even if the document has no title.
116 - Made sure that latex doesn't fill in today's date if no date field
120 Release 0.3.7 (2004-12-24)
121 ==========================
123 * docutils/frontend.py:
125 - Added options: --input-encoding-error-handler,
126 --record-dependencies, --leave-footnote-reference-space,
128 - Added command-line and config file support for "overrides" setting
133 - Added support for input encoding error handler.
137 - Added dispatch_visit and dispatch_departure methods to
138 NodeVisitor; useful as a hook for Visitors.
139 - Changed structure of ``line_block``; added ``line``.
140 - Added ``compound`` node class.
141 - Added a mechanism for Visitors to transitionally ignore new node
146 - Moved ``escape2null`` and ``unescape`` functions from
147 docutils/parsers/rst/states.py.
149 * docutils/parsers/rst/roles.py:
152 - Changed role function API: the "text" parameter now takes
153 null-escaped interpreted text content.
155 * docutils/parsers/rst/states.py:
157 - Fixed bug where a "role" directive in a nested parse would crash
158 the parser; the state machine's "language" attribute was not being
160 - Added support for line block syntax.
161 - Fixed directive parsing bug: argument-less directives didn't
162 notice that arguments were present.
163 - Removed error checking for transitions.
164 - Added support for multiple classifiers in definition list items.
165 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
166 - Changed role function API: the "text" parameter now takes
167 null-escaped interpreted text content.
168 - Empty sections and documents are allowed now.
170 * docutils/parsers/rst/directives/__init__.py:
172 - Added ``encoding`` directive option conversion function.
173 - Allow multiple class names in class_option conversion function.
175 * docutils/parsers/rst/directives/body.py:
177 - Converted the line-block directive to use the new structure.
178 - Extracted the old line-block functionality to the ``block``
179 function (still used).
180 - Added ``compound`` directive (thanks to Felix Wiemann).
182 * docutils/parsers/rst/directives/misc.py:
184 - Added "encoding" option to "include" and "raw" directives.
185 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
186 - Allow multiple class names in the "class" directive.
188 * docutils/parsers/rst/directives/parts.py:
190 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
191 options. Thanks to Lele Gaifax.
193 * docutils/parsers/rst/directives/tables.py:
195 - Added "encoding" directive to "csv-table" directive.
196 - Added workaround for lack of Unicode support in csv.py, for
199 * docutils/transforms/misc.py:
201 - Fixed bug when multiple "class" directives are applied to a single
203 - Enabled multiple format names for "raw" directive.
205 * docutils/transforms/references.py:
207 - Added support for trimming whitespace from beside substitution
210 * docutils/transforms/universal.py:
212 - FinalChecks now checks for illegal transitions and moves
213 transitions between sections.
215 * docutils/writers/html4css1.py:
217 - HTMLTranslator.encode now converts U+00A0 to " ".
218 - "stylesheet" and "stylesheet_path" settings are now mutually
220 - Added support for the new line_block/line structure.
221 - --footnote-references now overrides
222 --trim-footnote-reference-space, if applicable.
223 - Added support for ``compound`` elements.
224 - Enabled multiple format names for "raw" directive.
225 - ``<p>`` tags of a paragraph which is the only visible child of the
226 document node are no longer stripped.
227 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
228 new method ``should_be_compact_paragraph()``.
229 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
231 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
232 the output if they have their ``class`` attribute set.
233 - The whole document is now surrounded by a ``<div
234 class="document">`` element.
235 - Body-level images are now wrapped by their own ``<div>`` elements,
236 with image classes copied to the wrapper, and for images which
237 have the ``:align:`` option set, the surrounding ``<div>`` now
238 receives a class attribute (like ``class="align-left"``).
240 * docutils/writers/latex2e.py:
242 - no newline after depart_term.
243 - Added translations for some Unicode quotes.
244 - Added option "font-encoding", made package AE the default.
245 - "stylesheet" and "stylesheet_path" settings are now mutually
247 - --footnote-references now overrides
248 --trim-footnote-reference-space, if applicable.
249 - The footnote label style now matches the footnote reference style
250 ("brackets" or "superscript").
251 - Added support for ``compound`` elements.
252 - Enabled multiple format names for "raw" directive.
254 * docs/ref/docutils.dtd:
256 - Changed structure of the ``line_block`` element; added ``line``.
257 - Added ``compound`` element.
258 - Added "ltrim" and "rtrim" attributes to
259 ``substitution_definition`` element.
260 - Enabled multiple format names for ``raw`` element.
261 - Enabled multiple classifiers in ``definition_list_item`` elements.
263 * docs/ref/rst/directives.txt
265 - Marked "line-block" as deprecated.
266 - "Class" directive now allows multiple class names.
267 - Added "Rationale for Class Attribute Value Conversion".
268 - Added warning about "raw" overuse/abuse.
270 * docs/ref/rst/restructuredtext.txt:
272 - Added syntax for line blocks.
273 - Definition list items may have multiple classifiers.
275 * docs/ref/rst/roles.txt:
279 * tools/stylesheets/default.css:
281 - Added support for the new line_block structure.
282 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
285 Release 0.3.5 (2004-07-29)
286 ==========================
290 * _`Documentation cleanup/reorganization`.
292 - Created new subdirectories of docs/:
294 * ``docs/user/``: introductory/tutorial material for end-users
295 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
296 * ``docs/api/``: API reference material for client-developers
297 * ``docs/ref/``: reference material for all groups
298 * ``docs/howto/``: for component-developers and core-developers
299 * ``docs/peps/``: Python Enhancement Proposals
301 - Moved ``docs/*`` to ``docs/user/``.
302 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
303 ``spec/`` to ``docs/dev``.
304 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
305 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
306 - Moved ``alternatives.txt``, and ``problems.txt`` from
307 ``spec/rst/`` to ``docs/dev/rst/``.
308 - Moved ``reStructuredText.txt``, ``directives.txt``,
309 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
310 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
311 ``roles.txt``, ``reStructuredText.txt`` to
312 ``restructuredtext.txt``.
313 - Moved ``spec/howto/`` to ``docs/howto``.
315 In order to keep the CVS history of moved files, we supplied
316 SourceForge with a `script for modifying the Docutils CVS
319 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
321 After running the cleanup script:
323 - Added ``docs/index.txt``.
324 - Added a ``.htaccess`` file to the ``web`` module, containing
325 redirects for all old paths to new paths. They'll preserve
326 fragments (the "#name" part of a URL), and won't clutter up the
327 file system, and will correct the URL in the user's browser.
328 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
329 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
330 the "To Do" list itself in ``docs/dev/todo.txt``.
331 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
332 section of ``docs/dev/todo.txt``.
333 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
334 - Added "How To Report Bugs" to ``BUGS.txt``.
335 - Went through all the sources and docs (including under web/) and
336 updated links. Mostly done by Felix Wiemann; thanks Felix!
337 (Still need to update links in the sandboxes.)
341 * BUGS.txt: Added to project.
343 * THANKS.txt: Added to project.
345 * docutils/__init__.py:
347 - 0.3.4: Post-release.
351 - Added special error handling & advice for UnicodeEncodeError.
352 - Refactored Publisher.publish (simplified exception handling &
353 extracted debug dumps).
354 - Renamed "enable_exit" parameter of convenience functions to
355 "enable_exit_status".
356 - Enabled traceback (exception propagation) by default in
357 programmatic convenience functions.
358 - Now publish_file and publish_cmdline convenience functions return
359 the encoded string results in addition to their regular I/O.
360 - Extracted common code from publish_file, publish_string, and
361 publish_parts, into new publish_programmatically. Extracted
362 settings code to ``Publisher.process_programmatic_settings``.
363 - In Publisher.publish, disabled ``settings_overrides`` when
364 ``settings`` is supplied; redundant.
366 * docutils/frontend.py:
368 - Added help text for "--output-encoding-error-handler" and
369 "--error-encoding-error-handler".
370 - Renamed "--exit" to "--exit-status".
371 - Simplified default-setting code.
373 * docutils/parsers/rst/__init__.py:
375 - Added "--pep-base-url" and "--rfc-base-url" options.
377 * docutils/parsers/rst/states.py:
379 - Made URI recognition more aggressive and intelligent.
381 * docutils/parsers/rst/directives/__init__.py:
383 - Added several directive option conversion functions.
385 * docutils/parsers/rst/directives/body.py:
387 - Moved "table" directive to tables.py.
389 * docutils/parsers/rst/directives/tables.py: Table-related directives,
392 * docutils/writers/latex2e.py:
394 - Added "--table-style=(standard|booktabs|nolines)"
395 - figures get "here" option (LaTeX per default puts them at bottom),
396 and figure content is centered.
397 - Rowspan support for tables.
398 - Fix: admonition titles before first section.
399 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
400 - Replave ``_`` in literal by an underlined blank, because it has the correct
402 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
403 - A few unicode replacements, if output_encoding != utf
404 - Add "--graphicx-option".
405 - Indent literal-blocks.
406 - Fix: omit ``\maketitle`` when there is no document title.
408 * docs/index.txt: "Docutils Project Documentation Overview", added to
411 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
412 Tool", added to project.
414 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
416 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
418 * docs/dev/policies.txt: Added to project (extracted from
419 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
421 * docs/dev/release.txt: Added to project (extracted from
422 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
424 * docs/dev/testing.txt: Added to project.
426 * docs/dev/website.txt: Added to project (extracted from
427 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
429 * docs/ref/rst/directives.txt:
431 - Added directives: "table", "csv-table".
433 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
434 added to project. 1 page for syntax, and a 1 page reference for
435 directives and roles. Source text to be used as-is; not meant to be
438 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
439 with a change of title.
441 * test/functional/, contents, and test/test_functional.py: Added to
444 * tools/buildhtml.py: Fixed bug with config file handling.
446 * tools/html.py: Removed from project (duplicate of rst2html.py).
448 * tools/pep2html.py: Removed from project (duplicate of Python's
449 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
450 Docutils-related PEPs in docs/peps/).
452 * tools/rst2pseudoxml.py: Renamed from publish.py.
454 * tools/rst2xml.py: Renamed from docutils-xml.py.
456 * tools/test.txt: Removed from project; moved to
457 docs/user/rst/demo.txt.
459 * setup.py: Now also installs ``rst2latex.py``.
462 Release 0.3.3 (2004-05-09)
463 ==========================
465 * docutils/__init__.py:
467 - 0.3.1: Reorganized config file format (multiple sections); see
469 - Added unknown_reference_resolvers attribute to TransformSpec.
470 - 0.3.2: Interpreted text reorganization.
475 - Catch system messages to stop tracebacks from parsing errors.
476 - Catch exceptions during processing report & exit without
477 tracebacks, except when "--traceback" used.
478 - Reordered components for OptionParser; application comes last.
479 - Added "config_section" parameter to several methods and functions,
480 allowing front ends to easily specify their config file sections.
481 - Added publish_parts convenience function to allow access to individual
484 * docutils/examples.py: Added to project; practical examples of
485 Docutils client code, to be used as-is or as models for variations.
487 * docutils/frontend.py:
489 - Added "--traceback" & "--no-traceback" options ("traceback"
491 - Implemented support for config file reorganization:
492 ``standard_config_files`` moved from ``ConfigParser`` to
493 ``OptionParser``; added
494 ``OptionParser.get_config_file_settings()`` and
495 ``.get_standard_config_settings()``; support for old "[options]"
496 section (with deprecation warning) and mapping from old to new
498 - Reimplemented setting validation.
499 - Enabled flexible boolean values: yes/no, true/false, on/off.
500 - Added ``Values``, a subclass of ``optparse.Values``, with support
501 for list setting attributes.
502 - Added support for new ``DOCUTILSCONFIG`` environment variable;
503 thanks to Beni Cherniavsky.
504 - Added "--no-section-numbering" option.
508 - Catch IOErrors when opening source & destination files, report &
509 exit without tracebacks. Added ``handle_io_errors`` parameter to
510 ``FileInput`` & ``FileOutput`` to enable caller error handling.
514 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
515 method definitions (via ``exec``) to dynamic assignments (via
516 ``setattr``); thanks to Roman Suzi.
517 - Encapsulated visitor dynamic assignments in a function; thanks to
519 - Added indirect_reference_name attribute to the Targetable
520 class. This attribute holds the whitespace_normalized_name
521 (contains mixed case) of a target.
523 * docutils/statemachine.py:
525 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
526 - Added ``StringList.get_2D_block``.
530 - Added "level" attribute to SystemMessage exceptions.
532 * docutils/languages/af.py: Added to project; Afrikaans mappings by
535 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
538 * docutils/languages/eo.py: Added to project; Esperanto mappings by
539 Marcelo Huerta San Martin.
541 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
542 mappings by Lalo Martins.
544 * docutils/languages/ru.py: Added to project; Russian mappings by
547 * docutils/parsers/rst/roles.py: Added to project. Contains
548 interpreted text role functions, a registry for interpreted text
549 roles, and an API for adding to and retrieving from the registry.
550 Contributed by Edward Loper.
552 * docutils/parsers/rst/states.py:
554 - Updated ``RSTState.nested_parse`` for "include" in table cells.
555 - Allowed true em-dash character and "---" as block quote
557 - Added support for <angle-bracketed> complex option arguments
559 - Fixed handling of backslashes in substitution definitions.
560 - Fixed off-by-1 error with extra whitespace after substitution
561 definition directive.
562 - Added inline markup parsing to field lists' field names.
563 - Added support for quoted (and unindented) literal blocks.
564 Driven in part by a bribe from Frank Siebenlist (thanks!).
565 - Parser now handles escapes in URIs correctly.
566 - Made embedded-URIs' reference text omittable. Idea from Beni
568 - Refactored explicit target processing code.
569 - Added name attribute to references containing the reference name only
570 through whitespace_normalize_name (no case changes).
571 - parse_target no longer returns the refname after going through
572 normalize_name. This is now handled in make_target.
573 - Fixed bug relating to role-less interpreted text in non-English
575 - Reorganized interpreted text processing; moved code into the new
576 roles.py module. Contributed by Edward Loper.
577 - Refactored ``Body.parse_directive`` into ``run_directive`` and
578 ``parse_directive_block``.
580 * docutils/parsers/rst/tableparser.py:
582 - Reworked for ``StringList``, to support "include" directives in
585 * docutils/parsers/rst/directives/__init__.py:
587 - Renamed ``unchanged()`` directive option conversion function to
588 ``unchanged_required``, and added a new ``unchanged``.
589 - Catch unicode value too high error; fixes bug 781766.
590 - Beefed up directive error reporting.
592 * docutils/parsers/rst/directives/body.py:
594 - Added basic "table" directive.
596 * docutils/parsers/rst/directives/images.py:
598 - Added "target" option to "image" directive.
599 - Added name attribute to references containing the reference name only
600 through whitespace_normalize_name (no case changes).
602 * docutils/parsers/rst/directives/misc.py:
604 - Isolated the import of the ``urllib2`` module; was causing
605 problems on SourceForge (``libssl.so.2`` unavailable?).
606 - Added the "role" directive for declaring custom interpreted text
609 * docutils/parsers/rst/directives/parts.py:
611 - The "contents" directive does more work up-front, creating the
612 "topic" and "title", and leaving the "pending" node for the
613 transform. Allows earlier reference resolution; fixes subtle bug.
615 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
616 mappings by Jannie Hofmeyr.
618 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
619 mappings by Marek Blaha.
621 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
622 mappings by Marcelo Huerta San Martin.
624 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
625 Portuguese mappings by Lalo Martins.
627 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
628 mappings by Roman Suzi.
630 * docutils/transforms/parts.py:
632 - The "contents" directive does more work up-front, creating the
633 "topic" and "title", and leaving the "pending" node for the
634 transform. Allows earlier reference resolution; fixes subtle bug.
635 - Added support for disabling of section numbering.
637 * docutils/transforms/references.py:
639 - Verifying that external targets are truly targets and not indirect
640 references. This is because we are now adding a "name" attribute to
641 references in addition to targets. Note sure if this is correct!
642 - Added code to hook into the unknown_reference_resolvers list for a
643 transformer in resolve_indirect_target. This allows the
644 unknown_reference_resolvers to keep around indirect targets which
645 docutils doesn't know about.
646 - Added specific error message for duplicate targets.
648 * docutils/transforms/universal.py:
650 - Added FilterMessages transform (removes system messages below the
651 verbosity threshold).
652 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
653 to FinalCheckVisitor for application-specific handling of
654 unresolvable references.
655 - Added specific error message for duplicate targets.
657 * docutils/writers/__init__.py:
659 - Added assemble_parts method to the Writer class to allow for
660 access to a documents individual parts.
661 - Documented & set default for ``Writer.output`` attribute.
663 * docutils/writers/html4css1.py:
665 - Fixed unicode handling of attribute values (bug 760673).
666 - Prevent duplication of "class" attribute values (bug report from
668 - Improved table grid/border handling (prompted by report from Bob
670 - Added support for table titles.
671 - Added "<title />" for untitled docs, for XHTML conformance; thanks
673 - Added functionality to keep track of individual parts of a document
674 and store them in a dictionary as the "parts" attribute of the writer.
675 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
676 - Added proper support for the "scale" attribute of the "image"
677 element. Contributed by Brent Cook.
678 - Added ``--initial-header-level`` option.
679 - Fixed bug: the body_pre_docinfo segment depended on there being a
680 docinfo; if no docinfo, the document title was incorporated into
681 the body segment. Adversely affected the publish_parts interface.
683 * docutils/writers/latex2e.py:
685 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
686 about a missing file.
687 - Added options and support: ``--compound-enumerators``,
688 ``--section-prefix-for-enumerators``, and
689 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
691 - Added option ``--use-verbatim-when-possible``, to avoid
692 problematic characters (eg, '~' in italian) in literal blocks.
693 - It's now possible to use four section levels in the `book` and
694 `report` LaTeX classes. The default `article` class still has
697 * docs/config.txt: "Docutils Configuration Files", added to project.
698 Moved config file entry descriptions from tools.txt.
702 - Moved config file entry descriptions to config.txt.
704 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
707 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
708 Text Roles", added to project.
710 * spec/rst/reStructuredText.txt:
712 - Added description of support for <angle-bracketed> complex option
713 arguments to option lists.
714 - Added subsections for indented and quoted literal blocks.
716 * test: Continually adding & updating tests.
718 - Added test/test_settings.py & test/data/config_*.txt support
720 - Added test/test_writers/test_htmlfragment.py.
722 * test/DocutilsTestSupport.py:
724 - Refactored LaTeX publisher test suite/case class names to make
725 testing other writers easier.
726 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
727 to test the processing of HTML fragments which use the new
728 publish_parts convenience function.
730 * tools/buildhtml.py:
732 - Added support for the "--prune" option.
733 - Removed dependency on pep2html.py; plaintext PEPs no longer
736 * tools/docutils.conf:
738 - Updated for configuration file reorganization.
742 - copied from tools/html.py
746 - added a 'scripts' section to configuration
747 - added 'tools/rst2html.py' to the scripts section
750 Release 0.3 (2003-06-24)
751 ========================
755 * Renamed "attribute" to "option" for directives/extensions.
757 * Renamed transform method "transform" to "apply".
759 * Renamed "options" to "settings" for runtime settings (as set by
760 command-line options). Sometimes "option" (singular) became
761 "settings" (plural). Some variations below:
763 - document.options -> document.settings (stored in other objects as
765 - option_spec -> settings_spec (not directives though)
766 - OptionSpec -> SettingsSpec
767 - cmdline_options -> settings_spec
768 - relative_path_options -> relative_path_settings
769 - option_default_overrides -> settings_default_overrides
770 - Publisher.set_options -> Publisher.get_settings
774 * COPYING.txt: Added "Public Domain Dedication".
776 * FAQ.txt: Frequently asked questions, added to project.
780 - Updated with PyPI Trove classifiers.
781 - Conditional installation of third-party modules.
783 * docutils/__init__.py:
785 - Bumped version to 0.2.1 to reflect changes to I/O classes.
786 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
787 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
788 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
789 option and its effect on the PEP template & writer.
790 - Bumped version to 0.2.4 due to changes to the PEP template &
792 - Bumped version to 0.2.5 to reflect changes to Reporter output.
793 - Added ``TransformSpec`` class for new transform system.
794 - Bumped version to 0.2.6 for API changes (renaming).
795 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
796 convenience functions.
797 - Added ``Component.component_type`` attribute.
798 - Bumped version to 0.2.8 because of the internal parser switch from
799 plain lists to the docutils.statemachine.StringList objects.
800 - Bumped version to 0.2.9 because of the frontend.py API changes.
801 - Bumped version to 0.2.10 due to changes to the project layout
802 (third-party modules removed from the "docutils" package), and
803 signature changes in ``io.Input``/``io.Output``.
804 - Changed version to 0.3.0 for release.
808 - Made ``publish()`` a bit more convenient.
809 - Generalized ``Publisher.set_io``.
810 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
811 parameters; improved its docstring.
812 - Added ``publish_file()`` and ``publish_string()``.
813 - Factored ``Publisher.set_source()`` and ``.set_destination()``
815 - Added support for "--dump-pseudo-xml", "--dump-settings", and
816 "--dump-transforms" hidden options.
817 - Added ``Publisher.apply_transforms()`` method.
818 - Added ``Publisher.set_components()`` method; support for
819 ``publish_*()`` conveninece functions.
820 - Moved config file processing to docutils/frontend.py.
821 - Added support for exit status ("exit_level" setting &
822 ``enable_exit`` parameter for Publisher.publish() and convenience
825 * docutils/frontend.py:
827 - Check for & exit on identical source & destination paths.
828 - Fixed bug with absolute paths & "--config".
829 - Set non-command-line defaults in ``OptionParser.__init__()``:
830 ``_source`` & ``_destination``.
831 - Distributed ``relative_path_settings`` to components; updated
832 ``OptionParser.populate_from_components()`` to combine it all.
833 - Require list of keys in ``make_paths_absolute`` (was implicit in
834 global ``relative_path_settings``).
835 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
836 "--dump-settings", and "--dump-transforms" hidden options.
837 - Removed nasty internals-fiddling ``ConfigParser.get_section``
838 code, replaced with correct code.
839 - Added validation functionality for config files.
840 - Added "--error-encoding" option/setting, "_disable_config"
842 - Added encoding validation; updated "--input-encoding" and
843 "--output-encoding"; added "--error-encoding-error-handler" and
844 "--output-encoding-error-handler".
845 - Moved config file processing from docutils/core.py.
846 - Updated ``OptionParser.populate_from_components`` to handle new
847 ``SettingsSpec.settings_defaults`` dict.
848 - Added support for "-" => stdin/stdout.
849 - Added "exit_level" setting ("--exit" option).
853 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
854 - Added automatic closing to ``FileInput`` and ``FileOutput``.
855 - Delayed opening of ``FileOutput`` file until ``write()`` called.
856 - ``FileOutput.write()`` now returns the encoded output string.
857 - Try to get path/stream name automatically in ``FileInput`` &
859 - Added defaults for source & destination paths.
860 - Allow for Unicode I/O with an explicit "unicode" encoding.
861 - Added ``Output.encode()``.
862 - Removed dependency on runtime settings; pass encoding directly.
863 - Recognize Unicode strings in ``Input.decode()``.
864 - Added support for output encoding error handlers.
868 - Added "Invisible" element category class.
869 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
870 modification during a traversal.
871 - Added element classes: ``line_block``, ``generated``, ``address``,
872 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
873 ``superscript``, ``subscript``, ``inline``
874 - Added support for lists of nodes to ``Element.insert()``.
875 - Fixed parent linking in ``Element.replace()``.
876 - Added new abstract superclass ``FixedTextElement``; adds
877 "xml:space" attribute.
878 - Added support for "line" attribute of ``system_message`` nodes.
879 - Added support for the observer pattern from ``utils.Reporter``.
880 Added ``parse_messages`` and ``transform_messages`` attributes to
881 ``document``, removed ``messages``. Added ``note_parse_message``
882 and ``note_transform_message`` methods.
883 - Added support for improved diagnostics:
885 - Added "document", "source", and "line" internal attributes to
886 ``Node``, set by ``Node.setup_child()``.
887 - Converted variations on ``node.parent = self`` to
888 ``self.setup_child(node)``.
889 - Added ``document.current_source`` & ``.current_line``
890 attributes, and ``.note_source`` observer method.
891 - Changed "system_message" output to GNU-Tools format.
893 - Added a "rawsource" attribute to the ``Text`` class, for text
894 before backslash-escape resolution.
895 - Support for new transform system.
896 - Reworked ``pending`` element.
897 - Fixed XML DOM bug (SF #660611).
898 - Removed the ``interpeted`` element class and added
899 ``title_reference``, ``abbreviation``, ``acronym``.
900 - Made substitutions case-sensitive-but-forgiving; moved some code
902 - Fixed Unicode bug on element attributes (report: William Dode).
904 * docutils/optik.py: Removed from project; replaced with
905 extras/optparse.py and extras/textwrap.py. These will be installed
906 only if they're not already present in the Python installation.
908 * docutils/roman.py: Moved to extras/roman.py; this will be installed
909 only if it's not already present in the Python installation.
911 * docutils/statemachine.py:
913 - Factored out ``State.add_initial_transitions()`` so it can be
915 - Converted whitespace-specific "blank" and "indent" transitions
916 from special-case code to ordinary transitions: removed
917 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
918 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
919 ``ws_initial_transitions`` attributes.
920 - Removed ``State.match_transition()`` after merging it into
922 - Added ``StateCorrection`` exception.
923 - Added support for ``StateCorrection`` in ``StateMachine.run()``
924 (moved ``TransitionCorrection`` support there too.)
925 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
926 ``EOFError`` instead of ``IndexError``.
927 - Added ``State.no_match`` method.
928 - Added support for the Observer pattern, triggered by input line
930 - Added ``strip_top`` parameter to
931 ``StateMachineWS.get_first_known_indented``.
932 - Made ``context`` a parameter to ``StateMachine.run()``.
933 - Added ``ViewList`` & ``StringList`` classes;
934 ``extract_indented()`` becomes ``StringList.get_indented()``.
935 - Added ``StateMachine.insert_input()``.
936 - Fixed ViewList slice handling for Python 2.3. Patch from (and
937 thanks to) Fred Drake.
941 - Added a ``source`` attribute to Reporter instances and
942 ``system_message`` elements.
943 - Added an observer pattern to ``utils.Reporter`` to keep track of
945 - Fixed bugs in ``relative_path()``.
946 - Added support for improved diagnostics.
947 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
948 - Added support for encoding Reporter stderr output, and encoding
950 - Reporter keeps track of the highest level system message yet
953 * docutils/languages: Fixed bibliographic field language lookups.
955 * docutils/languages/es.py: Added to project; Spanish mappings by
956 Marcelo Huerta San Martin.
958 * docutils/languages/fr.py: Added to project; French mappings by
961 * docutils/languages/it.py: Added to project; Italian mappings by
964 * docutils/languages/sk.py: Added to project; Slovak mappings by
967 * docutils/parser/__init__.py:
969 - Added ``Parser.finish_parse()`` method.
971 * docutils/parser/rst/__init__.py:
973 - Added options: "--pep-references", "--rfc-references",
974 "--tab-width", "--trim-footnote-reference-space".
976 * docutils/parsers/rst/states.py:
978 - Changed "title under/overline too short" system messages from INFO
979 to WARNING, and fixed its insertion location.
980 - Fixed enumerated list item parsing to allow paragraphs & section
981 titles to begin with enumerators.
982 - Converted system messages to use the new "line" attribute.
983 - Fixed a substitution reference edge case.
984 - Added support for "--pep-references" and "--rfc-references"
985 options; reworked ``Inliner`` code to make customization easier.
986 - Removed field argument parsing.
987 - Added support for short section title over/underlines.
988 - Fixed "simple reference name" regexp to ignore text like
989 "object.__method__"; not an anonymous reference.
990 - Added support for improved diagnostics.
991 - Reworked directive API, based on Dethe Elza's contribution. Added
992 ``Body.parse_directive()``, ``.parse_directive_options()``,
993 ``.parse_directive_arguments()`` methods.
994 - Added ``ExtensionOptions`` class, to parse directive options
995 without parsing field bodies. Factored
996 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
997 ``ExtensionOptions``.
998 - Improved definition list term/classifier parsing.
999 - Added warnings for unknown directives.
1000 - Renamed ``Stuff`` to ``Struct``.
1001 - Now flagged as errors: transitions at the beginning or end of
1002 sections, empty sections (except title), and empty documents.
1003 - Updated for ``statemachine.StringList``.
1004 - Enabled recognition of schemeless email addresses in targets.
1005 - Added support for embedded URIs in hyperlink references.
1006 - Added backslash-escapes to inline markup end-string suffix.
1007 - Added support for correct interpreted text processing.
1008 - Fixed nested title parsing (topic, sidebar directives).
1009 - Added special processing of backslash-escaped whitespace (idea
1010 from David Abrahams).
1011 - Made substitutions case-sensitive-but-forgiving; moved some code
1012 to ``docutils.nodes``.
1013 - Added support for block quote attributions.
1014 - Added a kludge to work-around a conflict between the bubble-up
1015 parser strategy and short titles (<= 3 char-long over- &
1016 underlines). Fixes SF bug #738803 "infinite loop with multiple
1017 titles" submitted by Jason Diamond.
1018 - Added explicit interpreted text roles for standard inline markup:
1019 "emphasis", "strong", "literal".
1020 - Implemented "superscript" and "subscript" interpreted text roles.
1021 - Added initial support for "abbreviation" and "acronym" roles;
1023 - Added support for "--trim-footnote-reference-space" option.
1024 - Optional space before colons in directives & hyperlink targets.
1026 * docutils/parsers/rst/tableparser.py:
1028 - Fixed a bug that was producing unwanted empty rows in "simple"
1030 - Detect bad column spans in "simple" tables.
1032 * docutils/parsers/rst/directives: Updated all directive functions to
1035 * docutils/parsers/rst/directives/__init__.py:
1037 - Added ``flag()``, ``unchanged()``, ``path()``,
1038 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1039 directive option helper functions.
1040 - Added warnings for unknown directives.
1041 - Return ``None`` for missing directives.
1042 - Added ``register_directive()``, thanks to William Dode and Paul
1045 * docutils/parsers/rst/directives/admonitions.py:
1047 - Added "admonition" directive.
1049 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1050 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1051 "parsed-literal", "rubric", "epigraph", "highlights" and
1052 "pull-quote" directives.
1054 * docutils/parsers/rst/directives/images.py:
1056 - Added an "align" attribute to the "image" & "figure" directives
1057 (by Adam Chodorowski).
1058 - Added "class" option to "image", and "figclass" to "figure".
1060 * docutils/parsers/rst/directives/misc.py:
1062 - Added "include", "raw", and "replace" directives, courtesy of
1064 - Added "unicode" and "class" directives.
1066 * docutils/parsers/rst/directives/parts.py:
1068 - Added the "sectnum" directive; by Dmitry Jemerov.
1069 - Added "class" option to "contents" directive.
1071 * docutils/parsers/rst/directives/references.py: Added to project.
1072 Contains the "target-notes" directive.
1074 * docutils/parsers/rst/languages/__init__.py:
1076 - Return ``None`` from get_language() for missing language modules.
1078 * docutils/parsers/rst/languages/de.py: Added to project; German
1079 mappings by Engelbert Gruber.
1081 * docutils/parsers/rst/languages/en.py:
1083 - Added interpreted text roles mapping.
1085 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1086 mappings by Marcelo Huerta San Martin.
1088 * docutils/parsers/rst/languages/fr.py: Added to project; French
1089 mappings by William Dode.
1091 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1092 mappings by Nicola Larosa.
1094 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1095 mappings by Miroslav Vasko.
1097 * docutils/readers/__init__.py:
1099 - Added support for the observer pattern from ``utils.Reporter``, in
1100 ``Reader.parse`` and ``Reader.transform``.
1101 - Removed ``Reader.transform()`` method.
1102 - Added default parameter values to ``Reader.__init__()`` to make
1103 instantiation easier.
1104 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1106 * docutils/readers/pep.py:
1108 - Added the ``peps.TargetNotes`` transform to the Reader.
1109 - Removed PEP & RFC reference detection code; moved to
1110 parsers/rst/states.py as options (enabled here by default).
1111 - Added support for pre-acceptance PEPs (no PEP number yet).
1112 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1115 * docutils/readers/python: Python Source Reader subpackage added to
1116 project, including preliminary versions of:
1119 - moduleparser.py: Parser for Python modules.
1121 * docutils/transforms/__init__.py:
1123 - Added ``Transformer`` class and completed transform reform.
1124 - Added unknown_reference_resolvers list for each transformer. This list holds
1125 the list of functions provided by each component of the transformer that
1126 help resolve references.
1128 * docutils/transforms/frontmatter.py:
1130 - Improved support for generic fields.
1131 - Fixed bibliographic field language lookups.
1133 * docutils/transforms/misc.py: Added to project. Miscellaneous
1136 * docutils/transforms/parts.py:
1138 - Moved the "id" attribute from TOC list items to the references
1139 (``Contents.build_contents()``).
1140 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1141 - Added "class" attribute support to ``Contents``.
1143 * docutils/transforms/peps.py:
1145 - Added ``mask_email()`` function, updating to pep2html.py's
1147 - Linked "Content-Type: text/x-rst" to PEP 12.
1148 - Added the ``TargetNotes`` PEP-specific transform.
1149 - Added ``TargetNotes.cleanup_callback``.
1150 - Added title check to ``Headers``.
1152 * docutils/transforms/references.py:
1154 - Added the ``TargetNotes`` generic transform.
1155 - Split ``Hyperlinks`` into multiple transforms.
1156 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1157 - Added check for circular indirect references.
1158 - Made substitutions case-sensitive-but-forgiving.
1160 * docutils/transforms/universal.py:
1162 - Added support for the "--expose-internal-attributes" option.
1163 - Removed ``Pending`` transform classes & data.
1165 * docutils/writers/__init__.py:
1167 - Removed ``Writer.transform()`` method.
1169 * docutils/writers/docutils-xml.py:
1171 - Added XML and doctype declarations.
1172 - Added "--no-doctype" and "--no-xml-declaration" options.
1174 * docutils/writers/html4css1.py:
1176 - "name" attributes only on these tags: a, applet, form, frame,
1178 - Added "name" attribute to <a> in section titles for Netscape 4
1179 support (bug report: Pearu Peterson).
1180 - Fixed targets (names) on footnote, citation, topic title,
1181 problematic, and system_message nodes (for Netscape 4).
1182 - Changed field names from "<td>" to "<th>".
1183 - Added "@" to "@" encoding to thwart address harvesters.
1184 - Improved the vertical whitespace optimization; ignore "invisible"
1185 nodes (targets, comments, etc.).
1186 - Improved inline literals with ``<span class="pre">`` around chunks
1187 of text and `` `` for runs of spaces.
1188 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1189 ``self.docinfo`` segments.
1190 - Added support for "line_block", "address" elements.
1191 - Improved backlinks (footnotes & system_messages).
1192 - Improved system_message output.
1193 - Redefined "--stylesheet" as containing an invariant URL, used
1194 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1196 - Added "--footnote-references" option (superscript or brackets).
1197 - Added "--compact-lists" and "--no-compact-lists" options.
1198 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1199 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1200 - Improved field list rendering.
1201 - Added Docutils version to "generator" meta tag.
1202 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1203 - Improved layout of <pre> HTML source.
1204 - Fixed attribute typo on <colspec>.
1205 - Refined XML prologue.
1206 - Support for no stylesheet.
1207 - Removed "interpreted" element support.
1208 - Added support for "title_reference", "sidebar", "attribution",
1209 "rubric", and generic "admonition" elements.
1210 - Added "--attribution" option.
1211 - Added support for "inline", "subscript", "superscript" elements.
1212 - Added initial support for "abbreviation" and "acronym";
1215 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1219 - Double quotes in literal blocks (special treatment for de/ngerman).
1220 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1221 - Added "--attribution" option.
1222 - Right align attributions.
1224 * docutils/writers/pep_html.py:
1226 - Parameterized output encoding in PEP template.
1227 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1228 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1229 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1231 - Added an override on the "--footnote-references" option.
1232 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1233 - Added Docutils version to "generator" meta tag.
1234 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1238 - Added a "silent" setting for ``buildhtml.py``.
1239 - Added a "Getting Help" section.
1240 - Rearranged the structure.
1241 - Kept up to date, with new settings, command-line options etc.
1242 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1243 - Converted settings table into a definition list.
1245 * docs/rst/quickstart.txt:
1247 - Added a table of contents.
1248 - Added feedback information.
1249 - Added mention of minimum section title underline lengths.
1250 - Removed the 4-character minimum for section title underlines.
1252 * docs/rst/quickref.html:
1254 - Added a "Getting Help" section.
1255 - Added a style to make section title backlinks more subtle.
1256 - Added mention of minimum section title underline lengths.
1257 - Removed the 4-character minimum for section title underlines.
1259 * extras: Directory added to project; contains third-party modules
1260 that Docutils depends on (optparse, textwrap, roman). These are
1261 only installed if they're not already present.
1263 * licenses: Directory added to project; contains copies of license
1264 files for non-public-domain files.
1268 - Changed the focus. It's about DTD elements: structural
1269 relationships, semantics, and external (public) attributes. Not
1270 about the element class library.
1271 - Moved some implementation-specific stuff into ``docutils.nodes``
1273 - Wrote descriptions of all common attributes and parameter
1274 entities. Filled in introductory material.
1275 - Working through the element descriptions: 55 down, 37 to go.
1276 - Removed "Representation of Horizontal Rules" to
1277 spec/rst/alternatives.txt.
1279 * spec/docutils.dtd:
1281 - Added "generated" inline element.
1282 - Added "line_block" body element.
1283 - Added "auto" attribute to "title".
1284 - Changed content models of "literal_block" and "doctest_block" to
1286 - Added ``%number;`` attribute type parameter entity.
1287 - Changed ``%structural.elements;`` to ``%section.elements``.
1288 - Updated attribute types; made more specific.
1289 - Added "address" bibliographic element.
1290 - Added "line" attribute to ``system_message`` element.
1291 - Removed "field_argument" element; "field_name" may contain
1292 multiple words and whitespace.
1293 - Changed public identifier to docutils.sf.net.
1294 - Removed "interpreted" element; added "title_reference",
1295 "abbreviation", "acronym".
1296 - Removed "refuri" attribute from "footnote_reference" and
1297 "citation_reference".
1298 - Added "sidebar", "rubric", "attribution", "admonition",
1299 "superscript", "subscript", and "inline" elements.
1301 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1303 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1305 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1307 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1310 * spec/transforms.txt: Added to project.
1312 * spec/howto: Added subdirectory, for developer how-to docs.
1314 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1315 Elza, edited & extended by David Goodger.
1317 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1320 * spec/rst/alternatives.txt:
1322 - Added "Doctree Representation of Transitions" from
1324 - Updated "Inline External Targets" & closed the debate.
1325 - Added ideas for interpreted text syntax extensions.
1326 - Added "Nested Inline Markup" section.
1328 * spec/rst/directives.txt:
1330 - Added directives: "topic", "sectnum", "target-notes",
1331 "line-block", "parsed-literal", "include", "replace", "sidebar",
1332 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1334 - Formalized descriptions of directive details.
1335 - Added an "align" attribute to the "image" & "figure" directives
1336 (by Adam Chodorowski).
1337 - Added "class" options to "topic", "sidebar", "line-block",
1338 "parsed-literal", "contents", and "image"; and "figclass" to
1341 * spec/rst/interpreted.txt: Added to project. Descriptions of
1342 interpreted text roles.
1344 * spec/rst/introduction.txt:
1346 - Added pointers to material for new users.
1348 * spec/rst/reStructuredText.txt:
1350 - Disambiguated comments (just add a newline after the "::").
1351 - Updated enumerated list description; added a discussion of the
1352 second-line validity checking.
1353 - Updated directive description.
1354 - Added a note redirecting newbies to the user docs.
1355 - Expanded description of inline markup start-strings in non-markup
1357 - Removed field arguments and made field lists a generic construct.
1358 - Removed the 4-character minimum for section title underlines.
1359 - Clarified term/classifier delimiter & inline markup ambiguity
1361 - Added "Embedded URIs".
1362 - Updated "Interpreted Text" section.
1363 - Added "Character-Level Inline Markup" section.
1365 * test: Continually adding & updating tests.
1367 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1368 - Moved test/test_pep/ to test/test_readers/test_pep/.
1369 - Added test/test_readers/test_python/.
1370 - Added test/test_writers/ (Engelbert Gruber).
1374 - Made the ``locale.setlocale()`` calls in front ends
1377 * tools/buildhtml.py:
1379 - Added "--silent" option.
1380 - Fixed bug with absolute paths & "--config".
1381 - Updated for new I/O classes.
1382 - Added some exception handling.
1383 - Separated publishers' setting defaults; prevents interference.
1384 - Updated for new ``publish_file()`` convenience function.
1386 * tools/pep-html-template:
1388 - Allow for "--embed-stylesheet".
1389 - Added Docutils version to "generator" meta tag.
1390 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1391 - Conform to XHTML spec.
1393 * tools/pep2html.py:
1395 - Made ``argv`` a parameter to ``main()``.
1396 - Added support for "Content-Type:" header & arbitrary PEP formats.
1397 - Linked "Content-Type: text/plain" to PEP 9.
1398 - Files skipped (due to an error) are not pushed onto the server.
1399 - Updated for new I/O classes.
1400 - Added ``check_requirements()`` & ``pep_type_error()``.
1401 - Added some exception handling.
1402 - Updated for new ``publish_string()`` convenience function.
1403 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1405 * tools/quicktest.py:
1407 - Added "-V"/"--version" option.
1409 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1411 * tools/unicode2rstsubs.py: Added to project. Produces character
1412 entity files (reSructuredText substitutions) from the MathML master
1415 * tools/editors: Support code for editors, added to project. Contains
1416 ``emacs/restructuredtext.el``.
1418 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1420 - Added style for chunks of inline literals.
1421 - Removed margin for first child of table cells.
1422 - Right-aligned field list names.
1423 - Support for auto-numbered section titles in TOCs.
1424 - Increased the size of inline literals (<tt>) in titles.
1425 - Restored the light gray background for inline literals.
1426 - Added support for "line_block" elements.
1427 - Added style for "address" elements.
1428 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1429 - Improved field list rendering.
1430 - Vertical whitespace improvements.
1431 - Removed "a.target" style.
1433 * tools/stylesheets/pep.css:
1435 - Fixed nested section margins.
1436 - Other changes parallel those of ``../default.css``.
1439 Release 0.2 (2002-07-31)
1440 ========================
1444 - The word "component" was being used ambiguously. From now on,
1445 "component" will be used to mean "Docutils component", as in Reader,
1446 Writer, Parser, or Transform. Portions of documents (Table of
1447 Contents, sections, etc.) will be called "document parts".
1448 - Did a grand renaming: a lot of ``verylongnames`` became
1449 ``very_long_names``.
1450 - Cleaned up imports: no more relative package imports or
1451 comma-separated lists of top-level modules.
1452 - Added support for an option values object which carries default
1453 settings and overrides (from command-line options and library use).
1454 - Added internal Unicode support, and support for both input and
1456 - Added support for the ``docutils.io.IO`` class & subclasses.
1460 * docutils/__init__.py:
1462 - Added ``ApplicationError`` and ``DataError``, for use throughout
1464 - Added ``Component`` base class for Docutils components; implements
1465 the ``supports`` method.
1466 - Added ``__version__`` (thus, ``docutils.__version__``).
1470 - Removed many keyword parameters to ``Publisher.__init__()`` and
1471 ``publish()``; bundled into an option values object. Added
1472 "argv", "usage", "description", and "option_spec" parameters for
1473 command-line support.
1474 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1476 - Reworked I/O model for ``docutils.io`` wrappers.
1477 - Updated ``Publisher.set_options()``; now returns option values
1479 - Added support for configuration files (/etc/docutils.conf,
1480 ./docutils.conf, ~/.docutils).
1481 - Added ``Publisher.setup_option_parser()``.
1482 - Added default usage message and description.
1484 * docutils/frontend.py: Added to project; support for front-end
1485 (command-line) scripts. Option specifications may be augmented by
1486 components. Requires Optik (http://optik.sf.net/) for option
1487 processing (installed locally as docutils/optik.py).
1489 * docutils/io.py: Added to project; uniform API for a variety of input
1492 * docutils/nodes.py:
1494 - Added ``TreeCopyVisitor`` class.
1495 - Added a ``copy`` method to ``Node`` and subclasses.
1496 - Added a ``SkipDeparture`` exception for visitors.
1497 - Renamed ``TreePruningException`` from ``VisitorException``.
1498 - Added docstrings to ``TreePruningException``, subclasses, and
1500 - Improved docstrings.
1501 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1502 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1504 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1505 ``PreDecorative`` mixin.
1506 - Reworked the name/id bookkeeping; to ``document``, removed
1507 ``explicit_targets`` and ``implicit_targets`` attributes, added
1508 ``nametypes`` attribute and ``set_name_id_map`` method.
1509 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1511 - Added ``document.has_name()`` method.
1512 - Fixed DOM generation for list-attributes.
1513 - Added category class ``Labeled`` (used by footnotes & citations).
1514 - Added ``Element.set_class()`` method (sets "class" attribute).
1516 * docutils/optik.py: Added to project. Combined from the Optik
1517 package, with added option groups and other modifications. The use
1518 of this module is probably only temporary.
1520 * docutils/statemachine.py:
1522 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1523 - Added underscores to improve many awkward names.
1524 - In ``string2lines()``, changed whitespace normalizing translation
1525 table to regexp; restores Python 2.0 compatibility with Unicode.
1527 * docutils/urischemes.py:
1529 - Filled in some descriptions.
1530 - Added "shttp" scheme.
1532 * docutils/utils.py:
1534 - Added ``clean_rcs_keywords`` function (moved from
1535 docutils/transforms/frontmatter.py
1536 ``DocInfo.filter_rcs_keywords``).
1537 - Added underscores to improve many awkward names.
1538 - Changed names of Reporter's thresholds:
1539 warning_level -> report_level; error_level -> halt_level.
1540 - Moved ``utils.id()`` to ``nodes.make_id()``.
1541 - Added ``relative_path(source, target)``.
1543 * docutils/languages/de.py: German mappings; added to project. Thanks
1544 to Gunnar Schwant for the translations.
1546 * docutils/languages/en.py: Added "Dedication" bibliographic field
1549 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1552 * docutils/parsers/rst/states.py:
1554 - Added underscores to improve many awkward names.
1555 - Added RFC-2822 header support.
1556 - Extracted the inline parsing code from ``RSTState`` to a separate
1557 class, ``Inliner``, which will allow easy subclassing.
1558 - Made local bindings for ``memo`` container & often-used contents
1559 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1560 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1561 - Added ``MarkupMismatch`` exception; for late corrections.
1562 - Added ``-/:`` characters to inline markup's start string prefix,
1563 ``/`` to end string suffix.
1564 - Fixed a footnote bug.
1565 - Fixed a bug with literal blocks.
1566 - Applied patch from Simon Budig: simplified regexps with symbolic
1567 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1568 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1569 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1570 - Allowed non-ASCII in "simple names" (directive names, field names,
1572 - Converted ``Inliner.patterns.initial`` to be dynamically built
1573 from parts with ``build_regexp()`` function.
1574 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1575 - Updated docstrings.
1576 - Changed "table" to "grid_table"; added "simple_table" support.
1578 * docutils/parsers/rst/tableparser.py:
1580 - Changed ``TableParser`` to ``GridTableParser``.
1581 - Added ``SimpleTableParser``.
1582 - Refactored naming.
1584 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1585 a fallback language for directive names.
1587 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1588 directive to use a ``pending`` element, used only by HTML writers.
1590 * docutils/parsers/rst/directives/parts.py: Renamed from
1593 - Added "backlinks" attribute to "contents" directive.
1595 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1596 project by Adam Chodorowski.
1598 * docutils/readers/__init__.py: Gave Readers more control over
1599 choosing and instantiating Parsers.
1601 * docutils/readers/pep.py: Added to project; for PEP processing.
1603 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1604 requires a ``component`` parameter.
1606 * docutils/transforms/components.py: Added to project; transforms
1607 related to Docutils components.
1609 * docutils/transforms/frontmatter.py:
1611 - In ``DocInfo.extract_authors``, check for a single "author" in an
1612 "authors" group, and convert it to a single "author" element.
1613 - Added support for "Dedication" and generic bibliographic fields.
1615 * docutils/transforms/peps.py: Added to project; PEP-specific.
1617 * docutils/transforms/parts.py: Renamed from old components.py.
1619 - Added filter for `Contents`, to use alt-text for inline images,
1620 and to remove inline markup that doesn't make sense in the ToC.
1621 - Added "name" attribute to TOC topic depending on its title.
1622 - Added support for optional TOC backlinks.
1624 * docutils/transforms/references.py: Fixed indirect target resolution
1625 in ``Hyperlinks`` transform.
1627 * docutils/transforms/universal.py:
1629 - Changed ``Messages`` transform to properly filter out system
1630 messages below the warning threshold.
1631 - Added ``Decorations`` transform (support for ``--generator``,
1632 ``--date``, ``--time``, ``--source-link`` options).
1634 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1635 Engelbert Gruber's PDF writer.
1637 * docutils/writers/html4css1.py:
1639 - Made XHTML-compatible (switched to lowercase element & attribute
1640 names; empty tag format).
1641 - Escape double-dashes in comment text.
1642 - Improved boilerplate & modularity of output.
1643 - Exposed modular output in Writer class.
1644 - Added a "generator" meta tag to <head>.
1645 - Added support for the ``--stylesheet`` option.
1646 - Added support for ``decoration``, ``header``, and ``footer``
1648 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1649 translation table to regexp; restores Python 2.0 compatibility
1651 - Added the translator class as instance variable to the Writer, to
1652 make it easily subclassable.
1653 - Improved option list spacing (thanks to Richard Jones).
1654 - Modified field list output.
1655 - Added backlinks to footnotes & citations.
1656 - Added percentage widths to "<col>" tags (from colspec).
1657 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1658 "<span>" changed to "<var>".
1659 - Inline literals: "<code>" changed to "<tt>".
1660 - Many changes to optimize vertical space: compact simple lists etc.
1661 - Add a command-line options & directive attributes to control TOC
1662 and footnote/citation backlinks.
1663 - Added support for optional footnote/citation backlinks.
1664 - Added support for generic bibliographic fields.
1665 - Identify backrefs.
1666 - Relative URLs for stylesheet links.
1668 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1669 PEPs (subclass of ``html4css1.Writer``).
1671 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1673 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1674 of the Docutils internal doctree in XML.
1676 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1680 - Changed the title to "The Docutils Document Tree".
1681 - Added "Hyperlink Bookkeeping" section.
1683 * spec/docutils.dtd:
1685 - Added ``decoration``, ``header``, and ``footer`` elements.
1686 - Brought ``interpreted`` element in line with the parser: changed
1687 attribute "type" to "role", added "position".
1688 - Added support for generic bibliographic fields.
1690 * spec/notes.txt: Continual updates. Added "Project Policies".
1692 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1695 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1697 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1698 mailing list discussions.
1700 * spec/pep-0287.txt:
1702 - Renamed to "reStructuredText Docstring Format".
1704 - Reworked Q&A as an enumerated list.
1705 - Converted to reStructuredText format.
1707 * spec/pysource.dtd:
1709 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1711 * spec/pysource.txt: Removed from project. Moved much of its contents
1714 * spec/rst/alternatives.txt:
1716 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1717 - Added "Inline External Targets" section.
1719 * spec/rst/directives.txt:
1721 - Added "backlinks" attribute to "contents" directive.
1723 * spec/rst/problems.txt:
1725 - Updated the Enumerated List Markup discussion.
1726 - Added new alternative table markup syntaxes.
1728 * spec/rst/reStructuredText.txt:
1730 - Clarified field list usage.
1731 - Updated enumerated list description.
1732 - Clarified purpose of directives.
1733 - Added ``-/:`` characters to inline markup's start string prefix,
1734 ``/`` to end string suffix.
1735 - Updated "Authors" bibliographic field behavior.
1736 - Changed "inline hyperlink targets" to "inline internal targets".
1737 - Added "simple table" syntax to supplement the existing but
1738 newly-renamed "grid tables".
1739 - Added cautions for anonymous hyperlink use.
1740 - Added "Dedication" and generic bibliographic fields.
1742 * test: Made test modules standalone (subdirectories became packages).
1744 * test/DocutilsTestSupport.py:
1746 - Added support for PEP extensions to reStructuredText.
1747 - Added support for simple tables.
1748 - Refactored naming.
1750 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1752 - Now supports true packages containing test modules
1753 (``__init__.py`` files required); fixes duplicate module name bug.
1755 * test/test_pep/: Subpackage added to project; PEP testing.
1757 * test/test_rst/test_SimpleTableParser.py: Added to project.
1761 - Updated html.py and publish.py front-end tools to use the new
1762 command-line processing facilities of ``docutils.frontend``
1763 (exposed in ``docutils.core.Publisher``), reducing each to just a
1765 - Added ``locale.setlocale()`` calls to front-end tools.
1767 * tools/buildhtml.py: Added to project; batch-generates .html from all
1768 the .txt files in directories and subdirectories.
1770 * tools/default.css:
1772 - Added support for ``header`` and ``footer`` elements.
1773 - Added styles for "Dedication" topics (biblio fields).
1775 * tools/docutils.conf: A configuration file; added to project.
1777 * tools/docutils-xml.py: Added to project.
1779 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1781 * tools/pep-html-template: Added to project.
1783 * tools/pep2html.py: Added to project from Python (nondist/peps).
1784 Added support for Docutils (reStructuredText PEPs).
1786 * tools/quicktest.py:
1788 - Added the ``--attributes`` option, hacked a bit.
1789 - Added a second command-line argument (output file); cleaned up.
1791 * tools/stylesheets/: Subdirectory added to project.
1793 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1796 Release 0.1 (2002-04-20)
1797 ========================
1799 This is the first release of Docutils, merged from the now inactive
1800 reStructuredText__ and `Docstring Processing System`__ projects. For
1801 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1802 `DPS HISTORY`__ files.
1804 __ http://structuredtext.sourceforge.net/
1805 __ http://docstring.sourceforge.net/
1806 __ http://structuredtext.sourceforge.net/HISTORY.html
1807 __ http://docstring.sourceforge.net/HISTORY.html
1809 General changes: renamed 'dps' package to 'docutils'; renamed
1810 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1811 the test suites (reStructuredText's test/test_states renamed to
1812 test/test_rst); and all modifications required to make it all work.
1814 * docutils/parsers/rst/states.py:
1816 - Improved diagnostic system messages for missing blank lines.
1817 - Fixed substitution_reference bug.
1823 indent-tabs-mode: nil
1824 sentence-end-double-space: t