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.
29 * docutils/examples.py:
31 - Added ``internals`` function for exploration.
35 - Fixed ``Input.decode`` method to apply heuristics only if no
36 encoding is explicitly given, and to provide better reporting of
38 - The ``Input.decode`` method now removes byte order marks (BOMs)
43 - ``image`` element class changed to subclass of Element, not
44 TextElement (it's an empty element, and cannot contain text).
45 - Added ``attr_defaults`` dictionary for default attribute values.
46 - Added empty list as default value for the following attributes:
47 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
48 - Added ``document.decoration`` attribute,
49 ``document.get_decoration`` method, and ``decoration.get_header``
50 & ``.get_footer`` methods.
54 - Removed ``docutils.utils.Reporter.categories``,
55 ``docutils.utils.ConditionSet``, and all references to them, to
56 simplify error reporting.
58 * docutils/languages/nl.py: Added to project; Dutch mappings by
61 * docutils/parsers/rst/__init__.py:
63 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
65 * docutils/parsers/rst/states.py:
67 - Added check for escaped at-mark to prevent email address recognition.
68 - Fixed option lists to allow spaces inside ``<angle-bracketed option
70 - Allowed whitespace in paths and URLs.
71 - Added auto-enumerated list items.
72 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
74 - Added support for table stub columns.
76 * docutils/parsers/rst/directives/__init__.py:
78 - Allowed whitespace in paths (``path`` function).
79 - Added ``uri`` directive option conversion function.
81 * docutils/parsers/rst/directives/body.py:
83 - Fixed illegal context bug with "topic" directive (allowed within
84 sidebars; not within body elements).
86 * docutils/parsers/rst/directives/images.py:
88 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
89 - Added support for the ``file_insertion_enabled`` setting in the
90 "figure" directive (disables "figwidth" option).
91 - "image" directive: added checks for valid values of "align" option,
92 depending on context. "figure" directive: added specialized
93 "align" option and attribute on "figure" element.
95 * docutils/parsers/rst/directives/misc.py:
97 - Fixed "include" and "raw" directives to catch text decoding
99 - Allowed whitespace in "include" & "raw" directive paths.
100 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
101 settings in "include" & "raw" directives.
103 * docutils/parsers/rst/directives/parts.py:
105 - Added "header" & "footer" directives.
106 - Fixed illegal context bug with "contents" directive (topics
107 allowed within sidebars; not within body elements).
109 * docutils/parsers/rst/directives/tables.py:
111 - Added "list-table" directive.
112 - Caught empty CSV table bug.
113 - Added support for the ``file_insertion_enabled`` setting in the
114 "csv-table" directive.
115 - Added ``stub-columns`` option to "csv-table" and "list-table"
118 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
119 mappings by Martijn Pieters.
121 * docutils/transforms/references.py:
123 - Fixed mislocated internal targets bug, by propagating internal
124 targets to the next node, making use of the newly added support
125 for multiple names and IDs.
126 - Fixed duplicate footnote label bug.
127 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
130 * docutils/writers/html4css1.py:
132 - Fixed unencoded stylesheet reference bug (characters like "&" in
133 stylesheet references).
134 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
136 - Added support for multiple IDs per node by creating empty ``span``
138 - Added the ``field_name_limit`` & ``option_limit`` settings &
140 - Added support for table stub columns.
141 - Added support for the ``align`` attribute on ``figure`` elements.
142 - Added the ``cloak_email_addresses`` setting & support.
143 - Added ``html_prolog``, ``html_head``, ``html_body``,
144 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
145 ``docutils.core.publish_parts``.
147 * docutils/writers/latex2e.py:
149 - Improved --use-latex-docinfo so that organization/contact/address
150 fields are lumped with the last author field and appear on the
152 - Made sure the titlepage is always shown with --use-latex-docinfo,
153 even if the document has no title.
154 - Made sure that latex doesn't fill in today's date if no date field
157 * docutils/writers/null.py: Added to project; a do-nothing Writer.
159 * docs/api/publisher.txt:
161 - Added "``publish_parts`` Details" section.
163 * docs/ref/docutils.dtd:
165 - Added a ``stub`` attribute to the ``colspec`` element via the
166 ``tbl.colspec.att`` parameter entity.
167 - Allowed topic elements within sidebars
168 - Added an ``align`` attribute to the ``figure`` element.
171 Release 0.3.7 (2004-12-24)
172 ==========================
174 * docutils/frontend.py:
176 - Added options: --input-encoding-error-handler,
177 --record-dependencies, --leave-footnote-reference-space,
179 - Added command-line and config file support for "overrides" setting
184 - Added support for input encoding error handler.
188 - Added dispatch_visit and dispatch_departure methods to
189 NodeVisitor; useful as a hook for Visitors.
190 - Changed structure of ``line_block``; added ``line``.
191 - Added ``compound`` node class.
192 - Added a mechanism for Visitors to transitionally ignore new node
197 - Moved ``escape2null`` and ``unescape`` functions from
198 docutils/parsers/rst/states.py.
200 * docutils/parsers/rst/roles.py:
203 - Changed role function API: the "text" parameter now takes
204 null-escaped interpreted text content.
206 * docutils/parsers/rst/states.py:
208 - Fixed bug where a "role" directive in a nested parse would crash
209 the parser; the state machine's "language" attribute was not being
211 - Added support for line block syntax.
212 - Fixed directive parsing bug: argument-less directives didn't
213 notice that arguments were present.
214 - Removed error checking for transitions.
215 - Added support for multiple classifiers in definition list items.
216 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
217 - Changed role function API: the "text" parameter now takes
218 null-escaped interpreted text content.
219 - Empty sections and documents are allowed now.
221 * docutils/parsers/rst/directives/__init__.py:
223 - Added ``encoding`` directive option conversion function.
224 - Allow multiple class names in class_option conversion function.
226 * docutils/parsers/rst/directives/body.py:
228 - Converted the line-block directive to use the new structure.
229 - Extracted the old line-block functionality to the ``block``
230 function (still used).
231 - Added ``compound`` directive (thanks to Felix Wiemann).
233 * docutils/parsers/rst/directives/misc.py:
235 - Added "encoding" option to "include" and "raw" directives.
236 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
237 - Allow multiple class names in the "class" directive.
239 * docutils/parsers/rst/directives/parts.py:
241 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
242 options. Thanks to Lele Gaifax.
244 * docutils/parsers/rst/directives/tables.py:
246 - Added "encoding" directive to "csv-table" directive.
247 - Added workaround for lack of Unicode support in csv.py, for
250 * docutils/transforms/misc.py:
252 - Fixed bug when multiple "class" directives are applied to a single
254 - Enabled multiple format names for "raw" directive.
256 * docutils/transforms/references.py:
258 - Added support for trimming whitespace from beside substitution
261 * docutils/transforms/universal.py:
263 - FinalChecks now checks for illegal transitions and moves
264 transitions between sections.
266 * docutils/writers/html4css1.py:
268 - HTMLTranslator.encode now converts U+00A0 to " ".
269 - "stylesheet" and "stylesheet_path" settings are now mutually
271 - Added support for the new line_block/line structure.
272 - --footnote-references now overrides
273 --trim-footnote-reference-space, if applicable.
274 - Added support for ``compound`` elements.
275 - Enabled multiple format names for "raw" directive.
276 - ``<p>`` tags of a paragraph which is the only visible child of the
277 document node are no longer stripped.
278 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
279 new method ``should_be_compact_paragraph()``.
280 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
282 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
283 the output if they have their ``class`` attribute set.
284 - The whole document is now surrounded by a ``<div
285 class="document">`` element.
286 - Body-level images are now wrapped by their own ``<div>`` elements,
287 with image classes copied to the wrapper, and for images which
288 have the ``:align:`` option set, the surrounding ``<div>`` now
289 receives a class attribute (like ``class="align-left"``).
291 * docutils/writers/latex2e.py:
293 - no newline after depart_term.
294 - Added translations for some Unicode quotes.
295 - Added option "font-encoding", made package AE the default.
296 - "stylesheet" and "stylesheet_path" settings are now mutually
298 - --footnote-references now overrides
299 --trim-footnote-reference-space, if applicable.
300 - The footnote label style now matches the footnote reference style
301 ("brackets" or "superscript").
302 - Added support for ``compound`` elements.
303 - Enabled multiple format names for "raw" directive.
305 * docs/ref/docutils.dtd:
307 - Changed structure of the ``line_block`` element; added ``line``.
308 - Added ``compound`` element.
309 - Added "ltrim" and "rtrim" attributes to
310 ``substitution_definition`` element.
311 - Enabled multiple format names for ``raw`` element.
312 - Enabled multiple classifiers in ``definition_list_item`` elements.
314 * docs/ref/rst/directives.txt
316 - Marked "line-block" as deprecated.
317 - "Class" directive now allows multiple class names.
318 - Added "Rationale for Class Attribute Value Conversion".
319 - Added warning about "raw" overuse/abuse.
321 * docs/ref/rst/restructuredtext.txt:
323 - Added syntax for line blocks.
324 - Definition list items may have multiple classifiers.
326 * docs/ref/rst/roles.txt:
330 * tools/stylesheets/default.css:
332 - Added support for the new line_block structure.
333 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
336 Release 0.3.5 (2004-07-29)
337 ==========================
341 * _`Documentation cleanup/reorganization`.
343 - Created new subdirectories of docs/:
345 * ``docs/user/``: introductory/tutorial material for end-users
346 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
347 * ``docs/api/``: API reference material for client-developers
348 * ``docs/ref/``: reference material for all groups
349 * ``docs/howto/``: for component-developers and core-developers
350 * ``docs/peps/``: Python Enhancement Proposals
352 - Moved ``docs/*`` to ``docs/user/``.
353 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
354 ``spec/`` to ``docs/dev``.
355 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
356 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
357 - Moved ``alternatives.txt``, and ``problems.txt`` from
358 ``spec/rst/`` to ``docs/dev/rst/``.
359 - Moved ``reStructuredText.txt``, ``directives.txt``,
360 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
361 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
362 ``roles.txt``, ``reStructuredText.txt`` to
363 ``restructuredtext.txt``.
364 - Moved ``spec/howto/`` to ``docs/howto``.
366 In order to keep the CVS history of moved files, we supplied
367 SourceForge with a `script for modifying the Docutils CVS
370 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
372 After running the cleanup script:
374 - Added ``docs/index.txt``.
375 - Added a ``.htaccess`` file to the ``web`` module, containing
376 redirects for all old paths to new paths. They'll preserve
377 fragments (the "#name" part of a URL), and won't clutter up the
378 file system, and will correct the URL in the user's browser.
379 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
380 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
381 the "To Do" list itself in ``docs/dev/todo.txt``.
382 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
383 section of ``docs/dev/todo.txt``.
384 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
385 - Added "How To Report Bugs" to ``BUGS.txt``.
386 - Went through all the sources and docs (including under web/) and
387 updated links. Mostly done by Felix Wiemann; thanks Felix!
388 (Still need to update links in the sandboxes.)
392 * BUGS.txt: Added to project.
394 * THANKS.txt: Added to project.
396 * docutils/__init__.py:
398 - 0.3.4: Post-release.
402 - Added special error handling & advice for UnicodeEncodeError.
403 - Refactored Publisher.publish (simplified exception handling &
404 extracted debug dumps).
405 - Renamed "enable_exit" parameter of convenience functions to
406 "enable_exit_status".
407 - Enabled traceback (exception propagation) by default in
408 programmatic convenience functions.
409 - Now publish_file and publish_cmdline convenience functions return
410 the encoded string results in addition to their regular I/O.
411 - Extracted common code from publish_file, publish_string, and
412 publish_parts, into new publish_programmatically. Extracted
413 settings code to ``Publisher.process_programmatic_settings``.
414 - In Publisher.publish, disabled ``settings_overrides`` when
415 ``settings`` is supplied; redundant.
417 * docutils/frontend.py:
419 - Added help text for "--output-encoding-error-handler" and
420 "--error-encoding-error-handler".
421 - Renamed "--exit" to "--exit-status".
422 - Simplified default-setting code.
424 * docutils/parsers/rst/__init__.py:
426 - Added "--pep-base-url" and "--rfc-base-url" options.
428 * docutils/parsers/rst/states.py:
430 - Made URI recognition more aggressive and intelligent.
432 * docutils/parsers/rst/directives/__init__.py:
434 - Added several directive option conversion functions.
436 * docutils/parsers/rst/directives/body.py:
438 - Moved "table" directive to tables.py.
440 * docutils/parsers/rst/directives/tables.py: Table-related directives,
443 * docutils/writers/latex2e.py:
445 - Added "--table-style=(standard|booktabs|nolines)"
446 - figures get "here" option (LaTeX per default puts them at bottom),
447 and figure content is centered.
448 - Rowspan support for tables.
449 - Fix: admonition titles before first section.
450 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
451 - Replave ``_`` in literal by an underlined blank, because it has the correct
453 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
454 - A few unicode replacements, if output_encoding != utf
455 - Add "--graphicx-option".
456 - Indent literal-blocks.
457 - Fix: omit ``\maketitle`` when there is no document title.
459 * docs/index.txt: "Docutils Project Documentation Overview", added to
462 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
463 Tool", added to project.
465 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
467 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
469 * docs/dev/policies.txt: Added to project (extracted from
470 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
472 * docs/dev/release.txt: Added to project (extracted from
473 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
475 * docs/dev/testing.txt: Added to project.
477 * docs/dev/website.txt: Added to project (extracted from
478 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
480 * docs/ref/rst/directives.txt:
482 - Added directives: "table", "csv-table".
484 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
485 added to project. 1 page for syntax, and a 1 page reference for
486 directives and roles. Source text to be used as-is; not meant to be
489 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
490 with a change of title.
492 * test/functional/, contents, and test/test_functional.py: Added to
495 * tools/buildhtml.py: Fixed bug with config file handling.
497 * tools/html.py: Removed from project (duplicate of rst2html.py).
499 * tools/pep2html.py: Removed from project (duplicate of Python's
500 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
501 Docutils-related PEPs in docs/peps/).
503 * tools/rst2pseudoxml.py: Renamed from publish.py.
505 * tools/rst2xml.py: Renamed from docutils-xml.py.
507 * tools/test.txt: Removed from project; moved to
508 docs/user/rst/demo.txt.
510 * setup.py: Now also installs ``rst2latex.py``.
513 Release 0.3.3 (2004-05-09)
514 ==========================
516 * docutils/__init__.py:
518 - 0.3.1: Reorganized config file format (multiple sections); see
520 - Added unknown_reference_resolvers attribute to TransformSpec.
521 - 0.3.2: Interpreted text reorganization.
526 - Catch system messages to stop tracebacks from parsing errors.
527 - Catch exceptions during processing report & exit without
528 tracebacks, except when "--traceback" used.
529 - Reordered components for OptionParser; application comes last.
530 - Added "config_section" parameter to several methods and functions,
531 allowing front ends to easily specify their config file sections.
532 - Added publish_parts convenience function to allow access to individual
535 * docutils/examples.py: Added to project; practical examples of
536 Docutils client code, to be used as-is or as models for variations.
538 * docutils/frontend.py:
540 - Added "--traceback" & "--no-traceback" options ("traceback"
542 - Implemented support for config file reorganization:
543 ``standard_config_files`` moved from ``ConfigParser`` to
544 ``OptionParser``; added
545 ``OptionParser.get_config_file_settings()`` and
546 ``.get_standard_config_settings()``; support for old "[options]"
547 section (with deprecation warning) and mapping from old to new
549 - Reimplemented setting validation.
550 - Enabled flexible boolean values: yes/no, true/false, on/off.
551 - Added ``Values``, a subclass of ``optparse.Values``, with support
552 for list setting attributes.
553 - Added support for new ``DOCUTILSCONFIG`` environment variable;
554 thanks to Beni Cherniavsky.
555 - Added "--no-section-numbering" option.
559 - Catch IOErrors when opening source & destination files, report &
560 exit without tracebacks. Added ``handle_io_errors`` parameter to
561 ``FileInput`` & ``FileOutput`` to enable caller error handling.
565 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
566 method definitions (via ``exec``) to dynamic assignments (via
567 ``setattr``); thanks to Roman Suzi.
568 - Encapsulated visitor dynamic assignments in a function; thanks to
570 - Added indirect_reference_name attribute to the Targetable
571 class. This attribute holds the whitespace_normalized_name
572 (contains mixed case) of a target.
574 * docutils/statemachine.py:
576 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
577 - Added ``StringList.get_2D_block``.
581 - Added "level" attribute to SystemMessage exceptions.
583 * docutils/languages/af.py: Added to project; Afrikaans mappings by
586 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
589 * docutils/languages/eo.py: Added to project; Esperanto mappings by
590 Marcelo Huerta San Martin.
592 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
593 mappings by Lalo Martins.
595 * docutils/languages/ru.py: Added to project; Russian mappings by
598 * docutils/parsers/rst/roles.py: Added to project. Contains
599 interpreted text role functions, a registry for interpreted text
600 roles, and an API for adding to and retrieving from the registry.
601 Contributed by Edward Loper.
603 * docutils/parsers/rst/states.py:
605 - Updated ``RSTState.nested_parse`` for "include" in table cells.
606 - Allowed true em-dash character and "---" as block quote
608 - Added support for <angle-bracketed> complex option arguments
610 - Fixed handling of backslashes in substitution definitions.
611 - Fixed off-by-1 error with extra whitespace after substitution
612 definition directive.
613 - Added inline markup parsing to field lists' field names.
614 - Added support for quoted (and unindented) literal blocks.
615 Driven in part by a bribe from Frank Siebenlist (thanks!).
616 - Parser now handles escapes in URIs correctly.
617 - Made embedded-URIs' reference text omittable. Idea from Beni
619 - Refactored explicit target processing code.
620 - Added name attribute to references containing the reference name only
621 through whitespace_normalize_name (no case changes).
622 - parse_target no longer returns the refname after going through
623 normalize_name. This is now handled in make_target.
624 - Fixed bug relating to role-less interpreted text in non-English
626 - Reorganized interpreted text processing; moved code into the new
627 roles.py module. Contributed by Edward Loper.
628 - Refactored ``Body.parse_directive`` into ``run_directive`` and
629 ``parse_directive_block``.
631 * docutils/parsers/rst/tableparser.py:
633 - Reworked for ``StringList``, to support "include" directives in
636 * docutils/parsers/rst/directives/__init__.py:
638 - Renamed ``unchanged()`` directive option conversion function to
639 ``unchanged_required``, and added a new ``unchanged``.
640 - Catch unicode value too high error; fixes bug 781766.
641 - Beefed up directive error reporting.
643 * docutils/parsers/rst/directives/body.py:
645 - Added basic "table" directive.
647 * docutils/parsers/rst/directives/images.py:
649 - Added "target" option to "image" directive.
650 - Added name attribute to references containing the reference name only
651 through whitespace_normalize_name (no case changes).
653 * docutils/parsers/rst/directives/misc.py:
655 - Isolated the import of the ``urllib2`` module; was causing
656 problems on SourceForge (``libssl.so.2`` unavailable?).
657 - Added the "role" directive for declaring custom interpreted text
660 * docutils/parsers/rst/directives/parts.py:
662 - The "contents" directive does more work up-front, creating the
663 "topic" and "title", and leaving the "pending" node for the
664 transform. Allows earlier reference resolution; fixes subtle bug.
666 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
667 mappings by Jannie Hofmeyr.
669 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
670 mappings by Marek Blaha.
672 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
673 mappings by Marcelo Huerta San Martin.
675 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
676 Portuguese mappings by Lalo Martins.
678 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
679 mappings by Roman Suzi.
681 * docutils/transforms/parts.py:
683 - The "contents" directive does more work up-front, creating the
684 "topic" and "title", and leaving the "pending" node for the
685 transform. Allows earlier reference resolution; fixes subtle bug.
686 - Added support for disabling of section numbering.
688 * docutils/transforms/references.py:
690 - Verifying that external targets are truly targets and not indirect
691 references. This is because we are now adding a "name" attribute to
692 references in addition to targets. Note sure if this is correct!
693 - Added code to hook into the unknown_reference_resolvers list for a
694 transformer in resolve_indirect_target. This allows the
695 unknown_reference_resolvers to keep around indirect targets which
696 docutils doesn't know about.
697 - Added specific error message for duplicate targets.
699 * docutils/transforms/universal.py:
701 - Added FilterMessages transform (removes system messages below the
702 verbosity threshold).
703 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
704 to FinalCheckVisitor for application-specific handling of
705 unresolvable references.
706 - Added specific error message for duplicate targets.
708 * docutils/writers/__init__.py:
710 - Added assemble_parts method to the Writer class to allow for
711 access to a documents individual parts.
712 - Documented & set default for ``Writer.output`` attribute.
714 * docutils/writers/html4css1.py:
716 - Fixed unicode handling of attribute values (bug 760673).
717 - Prevent duplication of "class" attribute values (bug report from
719 - Improved table grid/border handling (prompted by report from Bob
721 - Added support for table titles.
722 - Added "<title />" for untitled docs, for XHTML conformance; thanks
724 - Added functionality to keep track of individual parts of a document
725 and store them in a dictionary as the "parts" attribute of the writer.
726 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
727 - Added proper support for the "scale" attribute of the "image"
728 element. Contributed by Brent Cook.
729 - Added ``--initial-header-level`` option.
730 - Fixed bug: the body_pre_docinfo segment depended on there being a
731 docinfo; if no docinfo, the document title was incorporated into
732 the body segment. Adversely affected the publish_parts interface.
734 * docutils/writers/latex2e.py:
736 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
737 about a missing file.
738 - Added options and support: ``--compound-enumerators``,
739 ``--section-prefix-for-enumerators``, and
740 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
742 - Added option ``--use-verbatim-when-possible``, to avoid
743 problematic characters (eg, '~' in italian) in literal blocks.
744 - It's now possible to use four section levels in the `book` and
745 `report` LaTeX classes. The default `article` class still has
748 * docs/config.txt: "Docutils Configuration Files", added to project.
749 Moved config file entry descriptions from tools.txt.
753 - Moved config file entry descriptions to config.txt.
755 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
758 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
759 Text Roles", added to project.
761 * spec/rst/reStructuredText.txt:
763 - Added description of support for <angle-bracketed> complex option
764 arguments to option lists.
765 - Added subsections for indented and quoted literal blocks.
767 * test: Continually adding & updating tests.
769 - Added test/test_settings.py & test/data/config_*.txt support
771 - Added test/test_writers/test_htmlfragment.py.
773 * test/DocutilsTestSupport.py:
775 - Refactored LaTeX publisher test suite/case class names to make
776 testing other writers easier.
777 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
778 to test the processing of HTML fragments which use the new
779 publish_parts convenience function.
781 * tools/buildhtml.py:
783 - Added support for the "--prune" option.
784 - Removed dependency on pep2html.py; plaintext PEPs no longer
787 * tools/docutils.conf:
789 - Updated for configuration file reorganization.
793 - copied from tools/html.py
797 - added a 'scripts' section to configuration
798 - added 'tools/rst2html.py' to the scripts section
801 Release 0.3 (2003-06-24)
802 ========================
806 * Renamed "attribute" to "option" for directives/extensions.
808 * Renamed transform method "transform" to "apply".
810 * Renamed "options" to "settings" for runtime settings (as set by
811 command-line options). Sometimes "option" (singular) became
812 "settings" (plural). Some variations below:
814 - document.options -> document.settings (stored in other objects as
816 - option_spec -> settings_spec (not directives though)
817 - OptionSpec -> SettingsSpec
818 - cmdline_options -> settings_spec
819 - relative_path_options -> relative_path_settings
820 - option_default_overrides -> settings_default_overrides
821 - Publisher.set_options -> Publisher.get_settings
825 * COPYING.txt: Added "Public Domain Dedication".
827 * FAQ.txt: Frequently asked questions, added to project.
831 - Updated with PyPI Trove classifiers.
832 - Conditional installation of third-party modules.
834 * docutils/__init__.py:
836 - Bumped version to 0.2.1 to reflect changes to I/O classes.
837 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
838 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
839 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
840 option and its effect on the PEP template & writer.
841 - Bumped version to 0.2.4 due to changes to the PEP template &
843 - Bumped version to 0.2.5 to reflect changes to Reporter output.
844 - Added ``TransformSpec`` class for new transform system.
845 - Bumped version to 0.2.6 for API changes (renaming).
846 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
847 convenience functions.
848 - Added ``Component.component_type`` attribute.
849 - Bumped version to 0.2.8 because of the internal parser switch from
850 plain lists to the docutils.statemachine.StringList objects.
851 - Bumped version to 0.2.9 because of the frontend.py API changes.
852 - Bumped version to 0.2.10 due to changes to the project layout
853 (third-party modules removed from the "docutils" package), and
854 signature changes in ``io.Input``/``io.Output``.
855 - Changed version to 0.3.0 for release.
859 - Made ``publish()`` a bit more convenient.
860 - Generalized ``Publisher.set_io``.
861 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
862 parameters; improved its docstring.
863 - Added ``publish_file()`` and ``publish_string()``.
864 - Factored ``Publisher.set_source()`` and ``.set_destination()``
866 - Added support for "--dump-pseudo-xml", "--dump-settings", and
867 "--dump-transforms" hidden options.
868 - Added ``Publisher.apply_transforms()`` method.
869 - Added ``Publisher.set_components()`` method; support for
870 ``publish_*()`` conveninece functions.
871 - Moved config file processing to docutils/frontend.py.
872 - Added support for exit status ("exit_level" setting &
873 ``enable_exit`` parameter for Publisher.publish() and convenience
876 * docutils/frontend.py:
878 - Check for & exit on identical source & destination paths.
879 - Fixed bug with absolute paths & "--config".
880 - Set non-command-line defaults in ``OptionParser.__init__()``:
881 ``_source`` & ``_destination``.
882 - Distributed ``relative_path_settings`` to components; updated
883 ``OptionParser.populate_from_components()`` to combine it all.
884 - Require list of keys in ``make_paths_absolute`` (was implicit in
885 global ``relative_path_settings``).
886 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
887 "--dump-settings", and "--dump-transforms" hidden options.
888 - Removed nasty internals-fiddling ``ConfigParser.get_section``
889 code, replaced with correct code.
890 - Added validation functionality for config files.
891 - Added "--error-encoding" option/setting, "_disable_config"
893 - Added encoding validation; updated "--input-encoding" and
894 "--output-encoding"; added "--error-encoding-error-handler" and
895 "--output-encoding-error-handler".
896 - Moved config file processing from docutils/core.py.
897 - Updated ``OptionParser.populate_from_components`` to handle new
898 ``SettingsSpec.settings_defaults`` dict.
899 - Added support for "-" => stdin/stdout.
900 - Added "exit_level" setting ("--exit" option).
904 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
905 - Added automatic closing to ``FileInput`` and ``FileOutput``.
906 - Delayed opening of ``FileOutput`` file until ``write()`` called.
907 - ``FileOutput.write()`` now returns the encoded output string.
908 - Try to get path/stream name automatically in ``FileInput`` &
910 - Added defaults for source & destination paths.
911 - Allow for Unicode I/O with an explicit "unicode" encoding.
912 - Added ``Output.encode()``.
913 - Removed dependency on runtime settings; pass encoding directly.
914 - Recognize Unicode strings in ``Input.decode()``.
915 - Added support for output encoding error handlers.
919 - Added "Invisible" element category class.
920 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
921 modification during a traversal.
922 - Added element classes: ``line_block``, ``generated``, ``address``,
923 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
924 ``superscript``, ``subscript``, ``inline``
925 - Added support for lists of nodes to ``Element.insert()``.
926 - Fixed parent linking in ``Element.replace()``.
927 - Added new abstract superclass ``FixedTextElement``; adds
928 "xml:space" attribute.
929 - Added support for "line" attribute of ``system_message`` nodes.
930 - Added support for the observer pattern from ``utils.Reporter``.
931 Added ``parse_messages`` and ``transform_messages`` attributes to
932 ``document``, removed ``messages``. Added ``note_parse_message``
933 and ``note_transform_message`` methods.
934 - Added support for improved diagnostics:
936 - Added "document", "source", and "line" internal attributes to
937 ``Node``, set by ``Node.setup_child()``.
938 - Converted variations on ``node.parent = self`` to
939 ``self.setup_child(node)``.
940 - Added ``document.current_source`` & ``.current_line``
941 attributes, and ``.note_source`` observer method.
942 - Changed "system_message" output to GNU-Tools format.
944 - Added a "rawsource" attribute to the ``Text`` class, for text
945 before backslash-escape resolution.
946 - Support for new transform system.
947 - Reworked ``pending`` element.
948 - Fixed XML DOM bug (SF #660611).
949 - Removed the ``interpeted`` element class and added
950 ``title_reference``, ``abbreviation``, ``acronym``.
951 - Made substitutions case-sensitive-but-forgiving; moved some code
953 - Fixed Unicode bug on element attributes (report: William Dode).
955 * docutils/optik.py: Removed from project; replaced with
956 extras/optparse.py and extras/textwrap.py. These will be installed
957 only if they're not already present in the Python installation.
959 * docutils/roman.py: Moved to extras/roman.py; this will be installed
960 only if it's not already present in the Python installation.
962 * docutils/statemachine.py:
964 - Factored out ``State.add_initial_transitions()`` so it can be
966 - Converted whitespace-specific "blank" and "indent" transitions
967 from special-case code to ordinary transitions: removed
968 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
969 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
970 ``ws_initial_transitions`` attributes.
971 - Removed ``State.match_transition()`` after merging it into
973 - Added ``StateCorrection`` exception.
974 - Added support for ``StateCorrection`` in ``StateMachine.run()``
975 (moved ``TransitionCorrection`` support there too.)
976 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
977 ``EOFError`` instead of ``IndexError``.
978 - Added ``State.no_match`` method.
979 - Added support for the Observer pattern, triggered by input line
981 - Added ``strip_top`` parameter to
982 ``StateMachineWS.get_first_known_indented``.
983 - Made ``context`` a parameter to ``StateMachine.run()``.
984 - Added ``ViewList`` & ``StringList`` classes;
985 ``extract_indented()`` becomes ``StringList.get_indented()``.
986 - Added ``StateMachine.insert_input()``.
987 - Fixed ViewList slice handling for Python 2.3. Patch from (and
988 thanks to) Fred Drake.
992 - Added a ``source`` attribute to Reporter instances and
993 ``system_message`` elements.
994 - Added an observer pattern to ``utils.Reporter`` to keep track of
996 - Fixed bugs in ``relative_path()``.
997 - Added support for improved diagnostics.
998 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
999 - Added support for encoding Reporter stderr output, and encoding
1001 - Reporter keeps track of the highest level system message yet
1004 * docutils/languages: Fixed bibliographic field language lookups.
1006 * docutils/languages/es.py: Added to project; Spanish mappings by
1007 Marcelo Huerta San Martin.
1009 * docutils/languages/fr.py: Added to project; French mappings by
1012 * docutils/languages/it.py: Added to project; Italian mappings by
1015 * docutils/languages/sk.py: Added to project; Slovak mappings by
1018 * docutils/parser/__init__.py:
1020 - Added ``Parser.finish_parse()`` method.
1022 * docutils/parser/rst/__init__.py:
1024 - Added options: "--pep-references", "--rfc-references",
1025 "--tab-width", "--trim-footnote-reference-space".
1027 * docutils/parsers/rst/states.py:
1029 - Changed "title under/overline too short" system messages from INFO
1030 to WARNING, and fixed its insertion location.
1031 - Fixed enumerated list item parsing to allow paragraphs & section
1032 titles to begin with enumerators.
1033 - Converted system messages to use the new "line" attribute.
1034 - Fixed a substitution reference edge case.
1035 - Added support for "--pep-references" and "--rfc-references"
1036 options; reworked ``Inliner`` code to make customization easier.
1037 - Removed field argument parsing.
1038 - Added support for short section title over/underlines.
1039 - Fixed "simple reference name" regexp to ignore text like
1040 "object.__method__"; not an anonymous reference.
1041 - Added support for improved diagnostics.
1042 - Reworked directive API, based on Dethe Elza's contribution. Added
1043 ``Body.parse_directive()``, ``.parse_directive_options()``,
1044 ``.parse_directive_arguments()`` methods.
1045 - Added ``ExtensionOptions`` class, to parse directive options
1046 without parsing field bodies. Factored
1047 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1048 ``ExtensionOptions``.
1049 - Improved definition list term/classifier parsing.
1050 - Added warnings for unknown directives.
1051 - Renamed ``Stuff`` to ``Struct``.
1052 - Now flagged as errors: transitions at the beginning or end of
1053 sections, empty sections (except title), and empty documents.
1054 - Updated for ``statemachine.StringList``.
1055 - Enabled recognition of schemeless email addresses in targets.
1056 - Added support for embedded URIs in hyperlink references.
1057 - Added backslash-escapes to inline markup end-string suffix.
1058 - Added support for correct interpreted text processing.
1059 - Fixed nested title parsing (topic, sidebar directives).
1060 - Added special processing of backslash-escaped whitespace (idea
1061 from David Abrahams).
1062 - Made substitutions case-sensitive-but-forgiving; moved some code
1063 to ``docutils.nodes``.
1064 - Added support for block quote attributions.
1065 - Added a kludge to work-around a conflict between the bubble-up
1066 parser strategy and short titles (<= 3 char-long over- &
1067 underlines). Fixes SF bug #738803 "infinite loop with multiple
1068 titles" submitted by Jason Diamond.
1069 - Added explicit interpreted text roles for standard inline markup:
1070 "emphasis", "strong", "literal".
1071 - Implemented "superscript" and "subscript" interpreted text roles.
1072 - Added initial support for "abbreviation" and "acronym" roles;
1074 - Added support for "--trim-footnote-reference-space" option.
1075 - Optional space before colons in directives & hyperlink targets.
1077 * docutils/parsers/rst/tableparser.py:
1079 - Fixed a bug that was producing unwanted empty rows in "simple"
1081 - Detect bad column spans in "simple" tables.
1083 * docutils/parsers/rst/directives: Updated all directive functions to
1086 * docutils/parsers/rst/directives/__init__.py:
1088 - Added ``flag()``, ``unchanged()``, ``path()``,
1089 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1090 directive option helper functions.
1091 - Added warnings for unknown directives.
1092 - Return ``None`` for missing directives.
1093 - Added ``register_directive()``, thanks to William Dode and Paul
1096 * docutils/parsers/rst/directives/admonitions.py:
1098 - Added "admonition" directive.
1100 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1101 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1102 "parsed-literal", "rubric", "epigraph", "highlights" and
1103 "pull-quote" directives.
1105 * docutils/parsers/rst/directives/images.py:
1107 - Added an "align" attribute to the "image" & "figure" directives
1108 (by Adam Chodorowski).
1109 - Added "class" option to "image", and "figclass" to "figure".
1111 * docutils/parsers/rst/directives/misc.py:
1113 - Added "include", "raw", and "replace" directives, courtesy of
1115 - Added "unicode" and "class" directives.
1117 * docutils/parsers/rst/directives/parts.py:
1119 - Added the "sectnum" directive; by Dmitry Jemerov.
1120 - Added "class" option to "contents" directive.
1122 * docutils/parsers/rst/directives/references.py: Added to project.
1123 Contains the "target-notes" directive.
1125 * docutils/parsers/rst/languages/__init__.py:
1127 - Return ``None`` from get_language() for missing language modules.
1129 * docutils/parsers/rst/languages/de.py: Added to project; German
1130 mappings by Engelbert Gruber.
1132 * docutils/parsers/rst/languages/en.py:
1134 - Added interpreted text roles mapping.
1136 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1137 mappings by Marcelo Huerta San Martin.
1139 * docutils/parsers/rst/languages/fr.py: Added to project; French
1140 mappings by William Dode.
1142 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1143 mappings by Nicola Larosa.
1145 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1146 mappings by Miroslav Vasko.
1148 * docutils/readers/__init__.py:
1150 - Added support for the observer pattern from ``utils.Reporter``, in
1151 ``Reader.parse`` and ``Reader.transform``.
1152 - Removed ``Reader.transform()`` method.
1153 - Added default parameter values to ``Reader.__init__()`` to make
1154 instantiation easier.
1155 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1157 * docutils/readers/pep.py:
1159 - Added the ``peps.TargetNotes`` transform to the Reader.
1160 - Removed PEP & RFC reference detection code; moved to
1161 parsers/rst/states.py as options (enabled here by default).
1162 - Added support for pre-acceptance PEPs (no PEP number yet).
1163 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1166 * docutils/readers/python: Python Source Reader subpackage added to
1167 project, including preliminary versions of:
1170 - moduleparser.py: Parser for Python modules.
1172 * docutils/transforms/__init__.py:
1174 - Added ``Transformer`` class and completed transform reform.
1175 - Added unknown_reference_resolvers list for each transformer. This list holds
1176 the list of functions provided by each component of the transformer that
1177 help resolve references.
1179 * docutils/transforms/frontmatter.py:
1181 - Improved support for generic fields.
1182 - Fixed bibliographic field language lookups.
1184 * docutils/transforms/misc.py: Added to project. Miscellaneous
1187 * docutils/transforms/parts.py:
1189 - Moved the "id" attribute from TOC list items to the references
1190 (``Contents.build_contents()``).
1191 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1192 - Added "class" attribute support to ``Contents``.
1194 * docutils/transforms/peps.py:
1196 - Added ``mask_email()`` function, updating to pep2html.py's
1198 - Linked "Content-Type: text/x-rst" to PEP 12.
1199 - Added the ``TargetNotes`` PEP-specific transform.
1200 - Added ``TargetNotes.cleanup_callback``.
1201 - Added title check to ``Headers``.
1203 * docutils/transforms/references.py:
1205 - Added the ``TargetNotes`` generic transform.
1206 - Split ``Hyperlinks`` into multiple transforms.
1207 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1208 - Added check for circular indirect references.
1209 - Made substitutions case-sensitive-but-forgiving.
1211 * docutils/transforms/universal.py:
1213 - Added support for the "--expose-internal-attributes" option.
1214 - Removed ``Pending`` transform classes & data.
1216 * docutils/writers/__init__.py:
1218 - Removed ``Writer.transform()`` method.
1220 * docutils/writers/docutils-xml.py:
1222 - Added XML and doctype declarations.
1223 - Added "--no-doctype" and "--no-xml-declaration" options.
1225 * docutils/writers/html4css1.py:
1227 - "name" attributes only on these tags: a, applet, form, frame,
1229 - Added "name" attribute to <a> in section titles for Netscape 4
1230 support (bug report: Pearu Peterson).
1231 - Fixed targets (names) on footnote, citation, topic title,
1232 problematic, and system_message nodes (for Netscape 4).
1233 - Changed field names from "<td>" to "<th>".
1234 - Added "@" to "@" encoding to thwart address harvesters.
1235 - Improved the vertical whitespace optimization; ignore "invisible"
1236 nodes (targets, comments, etc.).
1237 - Improved inline literals with ``<span class="pre">`` around chunks
1238 of text and `` `` for runs of spaces.
1239 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1240 ``self.docinfo`` segments.
1241 - Added support for "line_block", "address" elements.
1242 - Improved backlinks (footnotes & system_messages).
1243 - Improved system_message output.
1244 - Redefined "--stylesheet" as containing an invariant URL, used
1245 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1247 - Added "--footnote-references" option (superscript or brackets).
1248 - Added "--compact-lists" and "--no-compact-lists" options.
1249 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1250 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1251 - Improved field list rendering.
1252 - Added Docutils version to "generator" meta tag.
1253 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1254 - Improved layout of <pre> HTML source.
1255 - Fixed attribute typo on <colspec>.
1256 - Refined XML prologue.
1257 - Support for no stylesheet.
1258 - Removed "interpreted" element support.
1259 - Added support for "title_reference", "sidebar", "attribution",
1260 "rubric", and generic "admonition" elements.
1261 - Added "--attribution" option.
1262 - Added support for "inline", "subscript", "superscript" elements.
1263 - Added initial support for "abbreviation" and "acronym";
1266 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1270 - Double quotes in literal blocks (special treatment for de/ngerman).
1271 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1272 - Added "--attribution" option.
1273 - Right align attributions.
1275 * docutils/writers/pep_html.py:
1277 - Parameterized output encoding in PEP template.
1278 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1279 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1280 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1282 - Added an override on the "--footnote-references" option.
1283 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1284 - Added Docutils version to "generator" meta tag.
1285 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1289 - Added a "silent" setting for ``buildhtml.py``.
1290 - Added a "Getting Help" section.
1291 - Rearranged the structure.
1292 - Kept up to date, with new settings, command-line options etc.
1293 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1294 - Converted settings table into a definition list.
1296 * docs/rst/quickstart.txt:
1298 - Added a table of contents.
1299 - Added feedback information.
1300 - Added mention of minimum section title underline lengths.
1301 - Removed the 4-character minimum for section title underlines.
1303 * docs/rst/quickref.html:
1305 - Added a "Getting Help" section.
1306 - Added a style to make section title backlinks more subtle.
1307 - Added mention of minimum section title underline lengths.
1308 - Removed the 4-character minimum for section title underlines.
1310 * extras: Directory added to project; contains third-party modules
1311 that Docutils depends on (optparse, textwrap, roman). These are
1312 only installed if they're not already present.
1314 * licenses: Directory added to project; contains copies of license
1315 files for non-public-domain files.
1319 - Changed the focus. It's about DTD elements: structural
1320 relationships, semantics, and external (public) attributes. Not
1321 about the element class library.
1322 - Moved some implementation-specific stuff into ``docutils.nodes``
1324 - Wrote descriptions of all common attributes and parameter
1325 entities. Filled in introductory material.
1326 - Working through the element descriptions: 55 down, 37 to go.
1327 - Removed "Representation of Horizontal Rules" to
1328 spec/rst/alternatives.txt.
1330 * spec/docutils.dtd:
1332 - Added "generated" inline element.
1333 - Added "line_block" body element.
1334 - Added "auto" attribute to "title".
1335 - Changed content models of "literal_block" and "doctest_block" to
1337 - Added ``%number;`` attribute type parameter entity.
1338 - Changed ``%structural.elements;`` to ``%section.elements``.
1339 - Updated attribute types; made more specific.
1340 - Added "address" bibliographic element.
1341 - Added "line" attribute to ``system_message`` element.
1342 - Removed "field_argument" element; "field_name" may contain
1343 multiple words and whitespace.
1344 - Changed public identifier to docutils.sf.net.
1345 - Removed "interpreted" element; added "title_reference",
1346 "abbreviation", "acronym".
1347 - Removed "refuri" attribute from "footnote_reference" and
1348 "citation_reference".
1349 - Added "sidebar", "rubric", "attribution", "admonition",
1350 "superscript", "subscript", and "inline" elements.
1352 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1354 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1356 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1358 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1361 * spec/transforms.txt: Added to project.
1363 * spec/howto: Added subdirectory, for developer how-to docs.
1365 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1366 Elza, edited & extended by David Goodger.
1368 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1371 * spec/rst/alternatives.txt:
1373 - Added "Doctree Representation of Transitions" from
1375 - Updated "Inline External Targets" & closed the debate.
1376 - Added ideas for interpreted text syntax extensions.
1377 - Added "Nested Inline Markup" section.
1379 * spec/rst/directives.txt:
1381 - Added directives: "topic", "sectnum", "target-notes",
1382 "line-block", "parsed-literal", "include", "replace", "sidebar",
1383 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1385 - Formalized descriptions of directive details.
1386 - Added an "align" attribute to the "image" & "figure" directives
1387 (by Adam Chodorowski).
1388 - Added "class" options to "topic", "sidebar", "line-block",
1389 "parsed-literal", "contents", and "image"; and "figclass" to
1392 * spec/rst/interpreted.txt: Added to project. Descriptions of
1393 interpreted text roles.
1395 * spec/rst/introduction.txt:
1397 - Added pointers to material for new users.
1399 * spec/rst/reStructuredText.txt:
1401 - Disambiguated comments (just add a newline after the "::").
1402 - Updated enumerated list description; added a discussion of the
1403 second-line validity checking.
1404 - Updated directive description.
1405 - Added a note redirecting newbies to the user docs.
1406 - Expanded description of inline markup start-strings in non-markup
1408 - Removed field arguments and made field lists a generic construct.
1409 - Removed the 4-character minimum for section title underlines.
1410 - Clarified term/classifier delimiter & inline markup ambiguity
1412 - Added "Embedded URIs".
1413 - Updated "Interpreted Text" section.
1414 - Added "Character-Level Inline Markup" section.
1416 * test: Continually adding & updating tests.
1418 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1419 - Moved test/test_pep/ to test/test_readers/test_pep/.
1420 - Added test/test_readers/test_python/.
1421 - Added test/test_writers/ (Engelbert Gruber).
1425 - Made the ``locale.setlocale()`` calls in front ends
1428 * tools/buildhtml.py:
1430 - Added "--silent" option.
1431 - Fixed bug with absolute paths & "--config".
1432 - Updated for new I/O classes.
1433 - Added some exception handling.
1434 - Separated publishers' setting defaults; prevents interference.
1435 - Updated for new ``publish_file()`` convenience function.
1437 * tools/pep-html-template:
1439 - Allow for "--embed-stylesheet".
1440 - Added Docutils version to "generator" meta tag.
1441 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1442 - Conform to XHTML spec.
1444 * tools/pep2html.py:
1446 - Made ``argv`` a parameter to ``main()``.
1447 - Added support for "Content-Type:" header & arbitrary PEP formats.
1448 - Linked "Content-Type: text/plain" to PEP 9.
1449 - Files skipped (due to an error) are not pushed onto the server.
1450 - Updated for new I/O classes.
1451 - Added ``check_requirements()`` & ``pep_type_error()``.
1452 - Added some exception handling.
1453 - Updated for new ``publish_string()`` convenience function.
1454 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1456 * tools/quicktest.py:
1458 - Added "-V"/"--version" option.
1460 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1462 * tools/unicode2rstsubs.py: Added to project. Produces character
1463 entity files (reSructuredText substitutions) from the MathML master
1466 * tools/editors: Support code for editors, added to project. Contains
1467 ``emacs/restructuredtext.el``.
1469 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1471 - Added style for chunks of inline literals.
1472 - Removed margin for first child of table cells.
1473 - Right-aligned field list names.
1474 - Support for auto-numbered section titles in TOCs.
1475 - Increased the size of inline literals (<tt>) in titles.
1476 - Restored the light gray background for inline literals.
1477 - Added support for "line_block" elements.
1478 - Added style for "address" elements.
1479 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1480 - Improved field list rendering.
1481 - Vertical whitespace improvements.
1482 - Removed "a.target" style.
1484 * tools/stylesheets/pep.css:
1486 - Fixed nested section margins.
1487 - Other changes parallel those of ``../default.css``.
1490 Release 0.2 (2002-07-31)
1491 ========================
1495 - The word "component" was being used ambiguously. From now on,
1496 "component" will be used to mean "Docutils component", as in Reader,
1497 Writer, Parser, or Transform. Portions of documents (Table of
1498 Contents, sections, etc.) will be called "document parts".
1499 - Did a grand renaming: a lot of ``verylongnames`` became
1500 ``very_long_names``.
1501 - Cleaned up imports: no more relative package imports or
1502 comma-separated lists of top-level modules.
1503 - Added support for an option values object which carries default
1504 settings and overrides (from command-line options and library use).
1505 - Added internal Unicode support, and support for both input and
1507 - Added support for the ``docutils.io.IO`` class & subclasses.
1511 * docutils/__init__.py:
1513 - Added ``ApplicationError`` and ``DataError``, for use throughout
1515 - Added ``Component`` base class for Docutils components; implements
1516 the ``supports`` method.
1517 - Added ``__version__`` (thus, ``docutils.__version__``).
1521 - Removed many keyword parameters to ``Publisher.__init__()`` and
1522 ``publish()``; bundled into an option values object. Added
1523 "argv", "usage", "description", and "option_spec" parameters for
1524 command-line support.
1525 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1527 - Reworked I/O model for ``docutils.io`` wrappers.
1528 - Updated ``Publisher.set_options()``; now returns option values
1530 - Added support for configuration files (/etc/docutils.conf,
1531 ./docutils.conf, ~/.docutils).
1532 - Added ``Publisher.setup_option_parser()``.
1533 - Added default usage message and description.
1535 * docutils/frontend.py: Added to project; support for front-end
1536 (command-line) scripts. Option specifications may be augmented by
1537 components. Requires Optik (http://optik.sf.net/) for option
1538 processing (installed locally as docutils/optik.py).
1540 * docutils/io.py: Added to project; uniform API for a variety of input
1543 * docutils/nodes.py:
1545 - Added ``TreeCopyVisitor`` class.
1546 - Added a ``copy`` method to ``Node`` and subclasses.
1547 - Added a ``SkipDeparture`` exception for visitors.
1548 - Renamed ``TreePruningException`` from ``VisitorException``.
1549 - Added docstrings to ``TreePruningException``, subclasses, and
1551 - Improved docstrings.
1552 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1553 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1555 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1556 ``PreDecorative`` mixin.
1557 - Reworked the name/id bookkeeping; to ``document``, removed
1558 ``explicit_targets`` and ``implicit_targets`` attributes, added
1559 ``nametypes`` attribute and ``set_name_id_map`` method.
1560 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1562 - Added ``document.has_name()`` method.
1563 - Fixed DOM generation for list-attributes.
1564 - Added category class ``Labeled`` (used by footnotes & citations).
1565 - Added ``Element.set_class()`` method (sets "class" attribute).
1567 * docutils/optik.py: Added to project. Combined from the Optik
1568 package, with added option groups and other modifications. The use
1569 of this module is probably only temporary.
1571 * docutils/statemachine.py:
1573 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1574 - Added underscores to improve many awkward names.
1575 - In ``string2lines()``, changed whitespace normalizing translation
1576 table to regexp; restores Python 2.0 compatibility with Unicode.
1578 * docutils/urischemes.py:
1580 - Filled in some descriptions.
1581 - Added "shttp" scheme.
1583 * docutils/utils.py:
1585 - Added ``clean_rcs_keywords`` function (moved from
1586 docutils/transforms/frontmatter.py
1587 ``DocInfo.filter_rcs_keywords``).
1588 - Added underscores to improve many awkward names.
1589 - Changed names of Reporter's thresholds:
1590 warning_level -> report_level; error_level -> halt_level.
1591 - Moved ``utils.id()`` to ``nodes.make_id()``.
1592 - Added ``relative_path(source, target)``.
1594 * docutils/languages/de.py: German mappings; added to project. Thanks
1595 to Gunnar Schwant for the translations.
1597 * docutils/languages/en.py: Added "Dedication" bibliographic field
1600 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1603 * docutils/parsers/rst/states.py:
1605 - Added underscores to improve many awkward names.
1606 - Added RFC-2822 header support.
1607 - Extracted the inline parsing code from ``RSTState`` to a separate
1608 class, ``Inliner``, which will allow easy subclassing.
1609 - Made local bindings for ``memo`` container & often-used contents
1610 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1611 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1612 - Added ``MarkupMismatch`` exception; for late corrections.
1613 - Added ``-/:`` characters to inline markup's start string prefix,
1614 ``/`` to end string suffix.
1615 - Fixed a footnote bug.
1616 - Fixed a bug with literal blocks.
1617 - Applied patch from Simon Budig: simplified regexps with symbolic
1618 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1619 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1620 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1621 - Allowed non-ASCII in "simple names" (directive names, field names,
1623 - Converted ``Inliner.patterns.initial`` to be dynamically built
1624 from parts with ``build_regexp()`` function.
1625 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1626 - Updated docstrings.
1627 - Changed "table" to "grid_table"; added "simple_table" support.
1629 * docutils/parsers/rst/tableparser.py:
1631 - Changed ``TableParser`` to ``GridTableParser``.
1632 - Added ``SimpleTableParser``.
1633 - Refactored naming.
1635 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1636 a fallback language for directive names.
1638 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1639 directive to use a ``pending`` element, used only by HTML writers.
1641 * docutils/parsers/rst/directives/parts.py: Renamed from
1644 - Added "backlinks" attribute to "contents" directive.
1646 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1647 project by Adam Chodorowski.
1649 * docutils/readers/__init__.py: Gave Readers more control over
1650 choosing and instantiating Parsers.
1652 * docutils/readers/pep.py: Added to project; for PEP processing.
1654 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1655 requires a ``component`` parameter.
1657 * docutils/transforms/components.py: Added to project; transforms
1658 related to Docutils components.
1660 * docutils/transforms/frontmatter.py:
1662 - In ``DocInfo.extract_authors``, check for a single "author" in an
1663 "authors" group, and convert it to a single "author" element.
1664 - Added support for "Dedication" and generic bibliographic fields.
1666 * docutils/transforms/peps.py: Added to project; PEP-specific.
1668 * docutils/transforms/parts.py: Renamed from old components.py.
1670 - Added filter for `Contents`, to use alt-text for inline images,
1671 and to remove inline markup that doesn't make sense in the ToC.
1672 - Added "name" attribute to TOC topic depending on its title.
1673 - Added support for optional TOC backlinks.
1675 * docutils/transforms/references.py: Fixed indirect target resolution
1676 in ``Hyperlinks`` transform.
1678 * docutils/transforms/universal.py:
1680 - Changed ``Messages`` transform to properly filter out system
1681 messages below the warning threshold.
1682 - Added ``Decorations`` transform (support for ``--generator``,
1683 ``--date``, ``--time``, ``--source-link`` options).
1685 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1686 Engelbert Gruber's PDF writer.
1688 * docutils/writers/html4css1.py:
1690 - Made XHTML-compatible (switched to lowercase element & attribute
1691 names; empty tag format).
1692 - Escape double-dashes in comment text.
1693 - Improved boilerplate & modularity of output.
1694 - Exposed modular output in Writer class.
1695 - Added a "generator" meta tag to <head>.
1696 - Added support for the ``--stylesheet`` option.
1697 - Added support for ``decoration``, ``header``, and ``footer``
1699 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1700 translation table to regexp; restores Python 2.0 compatibility
1702 - Added the translator class as instance variable to the Writer, to
1703 make it easily subclassable.
1704 - Improved option list spacing (thanks to Richard Jones).
1705 - Modified field list output.
1706 - Added backlinks to footnotes & citations.
1707 - Added percentage widths to "<col>" tags (from colspec).
1708 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1709 "<span>" changed to "<var>".
1710 - Inline literals: "<code>" changed to "<tt>".
1711 - Many changes to optimize vertical space: compact simple lists etc.
1712 - Add a command-line options & directive attributes to control TOC
1713 and footnote/citation backlinks.
1714 - Added support for optional footnote/citation backlinks.
1715 - Added support for generic bibliographic fields.
1716 - Identify backrefs.
1717 - Relative URLs for stylesheet links.
1719 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1720 PEPs (subclass of ``html4css1.Writer``).
1722 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1724 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1725 of the Docutils internal doctree in XML.
1727 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1731 - Changed the title to "The Docutils Document Tree".
1732 - Added "Hyperlink Bookkeeping" section.
1734 * spec/docutils.dtd:
1736 - Added ``decoration``, ``header``, and ``footer`` elements.
1737 - Brought ``interpreted`` element in line with the parser: changed
1738 attribute "type" to "role", added "position".
1739 - Added support for generic bibliographic fields.
1741 * spec/notes.txt: Continual updates. Added "Project Policies".
1743 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1746 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1748 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1749 mailing list discussions.
1751 * spec/pep-0287.txt:
1753 - Renamed to "reStructuredText Docstring Format".
1755 - Reworked Q&A as an enumerated list.
1756 - Converted to reStructuredText format.
1758 * spec/pysource.dtd:
1760 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1762 * spec/pysource.txt: Removed from project. Moved much of its contents
1765 * spec/rst/alternatives.txt:
1767 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1768 - Added "Inline External Targets" section.
1770 * spec/rst/directives.txt:
1772 - Added "backlinks" attribute to "contents" directive.
1774 * spec/rst/problems.txt:
1776 - Updated the Enumerated List Markup discussion.
1777 - Added new alternative table markup syntaxes.
1779 * spec/rst/reStructuredText.txt:
1781 - Clarified field list usage.
1782 - Updated enumerated list description.
1783 - Clarified purpose of directives.
1784 - Added ``-/:`` characters to inline markup's start string prefix,
1785 ``/`` to end string suffix.
1786 - Updated "Authors" bibliographic field behavior.
1787 - Changed "inline hyperlink targets" to "inline internal targets".
1788 - Added "simple table" syntax to supplement the existing but
1789 newly-renamed "grid tables".
1790 - Added cautions for anonymous hyperlink use.
1791 - Added "Dedication" and generic bibliographic fields.
1793 * test: Made test modules standalone (subdirectories became packages).
1795 * test/DocutilsTestSupport.py:
1797 - Added support for PEP extensions to reStructuredText.
1798 - Added support for simple tables.
1799 - Refactored naming.
1801 * test/package_unittest.py: Renamed from UnitTestFolder.py.
1803 - Now supports true packages containing test modules
1804 (``__init__.py`` files required); fixes duplicate module name bug.
1806 * test/test_pep/: Subpackage added to project; PEP testing.
1808 * test/test_rst/test_SimpleTableParser.py: Added to project.
1812 - Updated html.py and publish.py front-end tools to use the new
1813 command-line processing facilities of ``docutils.frontend``
1814 (exposed in ``docutils.core.Publisher``), reducing each to just a
1816 - Added ``locale.setlocale()`` calls to front-end tools.
1818 * tools/buildhtml.py: Added to project; batch-generates .html from all
1819 the .txt files in directories and subdirectories.
1821 * tools/default.css:
1823 - Added support for ``header`` and ``footer`` elements.
1824 - Added styles for "Dedication" topics (biblio fields).
1826 * tools/docutils.conf: A configuration file; added to project.
1828 * tools/docutils-xml.py: Added to project.
1830 * tools/pep.py: Added to project; PEP to HTML front-end tool.
1832 * tools/pep-html-template: Added to project.
1834 * tools/pep2html.py: Added to project from Python (nondist/peps).
1835 Added support for Docutils (reStructuredText PEPs).
1837 * tools/quicktest.py:
1839 - Added the ``--attributes`` option, hacked a bit.
1840 - Added a second command-line argument (output file); cleaned up.
1842 * tools/stylesheets/: Subdirectory added to project.
1844 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
1847 Release 0.1 (2002-04-20)
1848 ========================
1850 This is the first release of Docutils, merged from the now inactive
1851 reStructuredText__ and `Docstring Processing System`__ projects. For
1852 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
1853 `DPS HISTORY`__ files.
1855 __ http://structuredtext.sourceforge.net/
1856 __ http://docstring.sourceforge.net/
1857 __ http://structuredtext.sourceforge.net/HISTORY.html
1858 __ http://docstring.sourceforge.net/HISTORY.html
1860 General changes: renamed 'dps' package to 'docutils'; renamed
1861 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
1862 the test suites (reStructuredText's test/test_states renamed to
1863 test/test_rst); and all modifications required to make it all work.
1865 * docutils/parsers/rst/states.py:
1867 - Improved diagnostic system messages for missing blank lines.
1868 - Fixed substitution_reference bug.
1874 indent-tabs-mode: nil
1875 sentence-end-double-space: t