5 :Author: David Goodger; open to all Docutils developers
6 :Contact: goodger@python.org
9 :Web site: http://docutils.sourceforge.net/
10 :Copyright: This document has been placed in the public domain.
20 - Added code to determine the input encoding from data: encoding
21 declarations or the presence of byte order marks (UTF-8 & UTF-16).
25 - Added ``document.__getstate__`` method, for pickling.
27 * docutils/parsers/rst/states.py:
29 - Unquoted targets beginning with an underscore (``.. __target:
30 URI``) are no longer accepted.
31 - Added support for multiple attributions in a physical block quote
32 (indented text block), dividing it into multiple logical block
35 * docutils/writers/html4css1/__init__.py:
37 - Moved template functionality from the PEP/HTML writer here.
38 - Expanded the fragments available in the ``parts`` attribute.
40 * docutils/writers/html4css1/template.txt: Added to project.
42 * docutils/writers/pep_html/:
44 - Moved template functionality to the HTML writer.
46 * docutils/writers/s5_html/__init__.py:
48 - Added ``view_mode`` & ``hidden_controls`` settings
49 (``--view-mode`` & ``--hidden-controls/--visible-controls``
52 * docutils/writers/latex2e/__init__.py:
54 - Fix: Renaming contents section does not work with latex writer.
55 sourceforge bug 1487405
56 - Apply patch for custom roles with classes from Edward Loper.
58 Release 0.4 (2006-01-09)
59 ========================
63 - Updated the project policies for trunk/branch development &
66 * docutils/__init__.py:
68 - Added ``__version_details__`` attribute to describe code source
69 (repository/snapshot/release).
70 - Replaced ``default_transforms`` attribute of TransformSpec with
71 ``get_transforms()`` method.
75 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
76 functions, for document tree extraction and reprocessing.
80 - Added ``DocTreeInput`` class, for reprocessing existing documents.
81 - Added support for non-Unicode (e.g. binary) writer output.
85 - Re-introduced ``Targetable.indirect_reference_name``, for
86 MoinMoin/reST compatibility (removed in r3124/r3129).
87 - Added ``serial_escape`` function; escapes string values that are
88 elements of a list, for serialization. Modified Docutils-XML
89 writing (``Element._dom_node``) and pseudo-XML writing
90 (``Element.starttag``) to use ``serial_escape``.
91 - Added ``Node.deepcopy()`` method.
92 - Removed the internal lists ``document.substitution_refs``,
93 ``document.anonymous_refs``, and ``document.anonymous_targets``.
94 - Added a "container" element.
95 - Fixed bug where values of list-valued attributes of elements
96 originating from custom interpreted text roles (i.e., with custom
97 classes) were being shared between element instances. Reported by
100 * docutils/statemachine.py:
102 - Added trailing whitespace stripping to ``string2lines()``.
103 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
104 Asian double-width character support.
108 - Added ``east_asian_column_width()`` for double-width character
111 * docutils/languages/ja.py: Added to project: Japanese mappings by
114 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
115 mappings by Panjunyong.
117 * docutils/parsers/null.py: Added to project; a do-nothing parser.
119 * docutils/parsers/rst/__init__.py:
121 - Added validator to tab_width setting, with test. Closes SF bug
122 #1212515, report from Wu Wei.
124 * docutils/parsers/rst/states.py:
126 - Fixed bug with escaped colons indicating a literal block.
127 - Fixed bug with enumerated lists (SF#1254145).
128 - Backslash-escaped colons inside of field names are now allowed.
129 - Targets (implicit and explicit), anonymous hyperlink references
130 and auto-numbered footnote references inside of substitution
131 definitions are now disallowed.
132 - Fixed bug: list items with blank first lines.
133 - Fixed bug: block quote attributions with indented second lines.
134 - Added East Asian double-width character support (Python 2.4 only).
136 * docutils/parsers/rst/tableparser.py:
138 - Added East Asian double-width character support (Python 2.4 only).
140 * docutils/parsers/rst/directives/body.py:
142 - Added the "container" directive.
144 * docutils/parsers/rst/directives/misc.py:
146 - Added the "default-role", "title", and "date" directives.
147 - Added standard data file syntax to the "include" directive.
148 - Added support for "class" directive content.
150 * docutils/parsers/rst/directives/images.py:
152 - Added ``indirect_reference_name`` support for images with a target
154 - Added support for image width and height units.
155 - Fixed bug with image "target" options.
157 * docutils/parsers/rst/directives/references.py:
159 - Added "class" attribute to "target-notes" directive, for
160 footnote_reference classes.
162 * docutils/parsers/rst/include/: Directory added to project; contains
163 standard data files for the "include" directive. Initial contents:
164 character entity substitution definition sets, and a set of
165 definitions for S5/HTML presentations.
167 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
168 mappings by David Goodger.
170 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
171 Simplified Chinese mappings by Panjunyong.
173 * docutils/readers/__init__.py:
175 - Added universal.Decorations and universal.ExposeInternals
176 transforms as default transforms for all readers.
177 - Added ``ReReader`` base class for readers that reread an existing
180 * docutils/readers/doctree.py: Added to project; a reader for existing
183 * docutils/transforms/frontmatter.py:
185 - Fixed the DocInfo transform to handle SVN-style expansion of the
187 - In ``DocInfo.extract_authors``, treat the contents of "authors"
190 * docutils/transforms/misc.py:
192 - Added misc.Transitions transform, extracted from
193 universal.FinalChecks.
195 * docutils/transforms/references.py:
197 - Added references.DanglingReferences transform, extracted from
198 universal.FinalChecks.
199 - Fixed bug with doubly-indirect substitutions.
200 - Added footnote_reference classes attribute to "TargetNotes".
201 - Fixed bug with circular substitution definitions that put Docutils
202 into an infinite loop.
204 * docutils/transforms/universal.py:
206 - Added universal.ExposeInternals transform, extracted from
207 universal.FinalChecks.
208 - Removed universal.FinalChecks transform (logic has been moved to
209 several new transforms).
210 - Fixed bug with the "expose_internals" setting and Text nodes
211 (exposed by the "rawsource" internal attribute).
212 - Added the universal.StripComments transform, implementation of the
213 "strip_comments" setting.
215 * docutils/transforms/writer_aux.py: Added to project; auxiliary
216 transforms for writers.
218 - Added ``Compound`` transform, which flattens compound paragraphs.
220 * docutils/writers/: Several writer modules (html4css1.py) were
221 converted into packages. Support modules and data files have been
222 moved into the packages. The stylesheets for the HTML writers are
223 now installed along with the code, the code knows where to find
224 them, and the default is to use them (actually, to embed them).
225 Some adjustments to configuration files may be necessary. The
226 easiest way to obtain the new default behavior is to remove all
227 settings whose name includes "stylesheet".
229 * docutils/writers/__init__.py:
231 - Added universal.Messages and universal.FilterMessages transforms
232 as default transforms for all writers.
233 - Added ``UnfilteredWriter`` base class for writers that pass the
234 document tree on unchanged.
236 * docutils/writers/docutils_xml.py:
238 - Made ``xmlcharrefreplace`` the default output encoding error
241 * docutils/writers/html4css1/:
243 - Added support for image width and height units.
244 - Made ``xmlcharrefreplace`` the default output encoding error
246 - Made ``--embed-stylesheet`` the default rather than
247 ``--link-stylesheet``.
248 - Moved "id" attribute from container (section etc.) to title's <a>
249 tag, to be on the same tag as "name".
250 (!!! To be reverted in Docutils 0.5.)
251 - Added vertical space between fields of field lists.
252 - Added ``--compact-field-lists`` option to remove vertical space in
254 - Made cloaking of email addresses with ``--cloak-email-addresses``
256 - Fixed support for centered images.
257 - Added support for class="compact" & class="open" lists.
259 * docutils/writers/latex2e/:
261 - Underscores in citekeys are no longer escaped.
263 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
264 mapping of Unicode characters to LaTeX equivalents.
266 * docutils/writers/s5_html/: Package added to project; writer for
269 * docs/dev/distributing.txt: Added to project; guide for distributors
270 (package maintainers).
272 * docs/dev/hacking.txt: Added to project; guide for developers.
274 * docs/ref/doctree.txt:
276 - Updated for plural attributes "classes", "ids", "names",
278 - Added the "container" element.
280 * docs/ref/docutils.dtd:
282 - Updated for plural attributes "classes", "ids", "names",
285 * docs/user/emacs.txt: Added to project; a document about Emacs
286 support for reStructuredText and Docutils.
288 * docs/user/links.txt: Added to project; lists of Docutils-related
291 * docs/user/mailing-lists.txt: Added to project; information about
292 Docutils-related mailing lists and how to access them.
294 * docs/user/slide-shows.txt: Added to project; example of and docs for
295 the S5/HTML writer (``rst2s5.py`` front end).
297 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
298 Files", added to project.
300 * test/coverage.sh: Added to project; test coverage script.
302 * test/DocutilsTestSupport.py:
304 - Added support for specifying runtime settings at the suite level.
306 * test/test_functional.py:
308 - Added the ``clear_output_directory`` function.
309 - Added support for ``_test_more`` functions in functional test
312 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
314 * tools/rstpep2html.py: Renamed from pep.py.
316 * tools/dev/create_unimap.py: Added to project; script to create the
317 docutils/writers/unimap_latex.py mapping file.
319 * tools/dev/profile_docutils.py: Added to project; profiler script.
321 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
323 * tools/editors/emacs/restructuredtext.el,
324 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
325 Removed from project; the functionality is now contained in rst.el.
327 * tools/editors/emacs/rst.el: Added to project. Added many features
328 and fixed many bugs. See docs/user/emacs.txt for details.
330 * tools/stylesheets: Removed from project. Stylesheets have been
331 renamed and moved into writer packages.
334 Release 0.3.9 (2005-05-26)
335 ==========================
339 - Eliminated and replaced all uses of the old string attributes
340 ``id``, ``name``, ``dupname`` and ``class`` with references to the
341 new list attributes ``ids``, ``names``, ``dupnames`` and
342 ``classes`` throughout the whole source tree.
346 - Enabled ``--dump-*`` options when ``--traceback`` specified,
347 allowing for easier debugging.
348 - In ``Publisher.publish()``, expanded the generic top-level
351 * docutils/examples.py:
353 - Added ``internals`` function for exploration.
357 - Fixed ``Input.decode`` method to apply heuristics only if no
358 encoding is explicitly given, and to provide better reporting of
360 - The ``Input.decode`` method now removes byte order marks (BOMs)
365 - ``image`` element class changed to subclass of Element, not
366 TextElement (it's an empty element, and cannot contain text).
367 - Added ``attr_defaults`` dictionary for default attribute values.
368 - Added empty list as default value for the following attributes:
369 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
370 - Added ``document.decoration`` attribute,
371 ``document.get_decoration`` method, and ``decoration.get_header``
372 & ``.get_footer`` methods.
373 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
378 - Removed ``docutils.utils.Reporter.categories``,
379 ``docutils.utils.ConditionSet``, and all references to them, to
380 simplify error reporting.
382 * docutils/languages/nl.py: Added to project; Dutch mappings by
385 * docutils/parsers/rst/__init__.py:
387 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
389 * docutils/parsers/rst/states.py:
391 - Added check for escaped at-mark to prevent email address recognition.
392 - Fixed option lists to allow spaces inside ``<angle-bracketed option
394 - Allowed whitespace in paths and URLs.
395 - Added auto-enumerated list items.
396 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
398 - Added support for table stub columns.
400 * docutils/parsers/rst/directives/__init__.py:
402 - Allowed whitespace in paths (``path`` function).
403 - Added ``uri`` directive option conversion function.
405 * docutils/parsers/rst/directives/body.py:
407 - Fixed illegal context bug with "topic" directive (allowed within
408 sidebars; not within body elements).
410 * docutils/parsers/rst/directives/images.py:
412 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
413 - Added support for the ``file_insertion_enabled`` setting in the
414 "figure" directive (disables "figwidth" option).
415 - "image" directive: added checks for valid values of "align" option,
416 depending on context. "figure" directive: added specialized
417 "align" option and attribute on "figure" element.
418 - Made ":figwidth: image" option of "figure" directive work again.
419 - Fixed bug with reference names containing uppercase letters
420 (e.g. ``Name_``) in "target" option of "image" directive.
422 * docutils/parsers/rst/directives/misc.py:
424 - Fixed "include" and "raw" directives to catch text decoding
426 - Allowed whitespace in "include" & "raw" directive paths.
427 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
428 settings in "include" & "raw" directives.
430 * docutils/parsers/rst/directives/parts.py:
432 - Added "header" & "footer" directives.
433 - Fixed illegal context bug with "contents" directive (topics
434 allowed within sidebars; not within body elements).
436 * docutils/parsers/rst/directives/tables.py:
438 - Added "list-table" directive.
439 - Caught empty CSV table bug.
440 - Added support for the ``file_insertion_enabled`` setting in the
441 "csv-table" directive.
442 - Added ``stub-columns`` option to "csv-table" and "list-table"
445 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
446 mappings by Martijn Pieters.
448 * docutils/readers/standalone.py:
450 - Added ``--section-subtitles`` and ``--no-section-subtitles``
451 options to activate or deactivate the SectSubTitle transform.
453 * docutils/transforms/frontmatter.py:
455 - Added SectSubTitle transform to promote titles of lone
456 subsections to subtitles.
458 * docutils/transforms/references.py:
460 - Fixed mislocated internal targets bug, by propagating internal
461 targets to the next node, making use of the newly added support
462 for multiple names and IDs.
463 - Fixed duplicate footnote label bug.
464 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
467 * docutils/writers/html4css1.py:
469 - Fixed unencoded stylesheet reference bug (characters like "&" in
470 stylesheet references).
471 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
473 - Added support for multiple IDs per node by creating empty ``span``
475 - Added the ``field_name_limit`` & ``option_limit`` settings &
477 - Added support for table stub columns.
478 - Added support for the ``align`` attribute on ``figure`` elements.
479 - Added the ``cloak_email_addresses`` setting & support.
480 - Added ``html_prolog``, ``html_head``, ``html_body``,
481 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
482 ``docutils.core.publish_parts``.
483 - Added support for section subtitles.
485 * docutils/writers/latex2e.py:
487 - Fixed tables starting with more than one multirow cell.
488 - Improved --use-latex-docinfo so that organization/contact/address
489 fields are lumped with the last author field and appear on the
491 - Made sure the titlepage is always shown with --use-latex-docinfo,
492 even if the document has no title.
493 - Made sure that latex doesn't fill in today's date if no date field
495 - Added support for section subtitles.
497 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
500 * docutils/writers/null.py: Added to project; a do-nothing Writer.
502 * docs/api/publisher.txt:
504 - Added "``publish_parts`` Details" section.
506 * docutils/dev/repository.txt: Added to project; information about the
507 Docutils Subversion repository.
509 * docs/ref/docutils.dtd:
511 - Added a ``stub`` attribute to the ``colspec`` element via the
512 ``tbl.colspec.att`` parameter entity.
513 - Allowed topic elements within sidebars
514 - Added an ``align`` attribute to the ``figure`` element.
516 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
520 Release 0.3.7 (2004-12-24)
521 ==========================
523 * docutils/frontend.py:
525 - Added options: --input-encoding-error-handler,
526 --record-dependencies, --leave-footnote-reference-space,
528 - Added command-line and config file support for "overrides" setting
533 - Added support for input encoding error handler.
537 - Added dispatch_visit and dispatch_departure methods to
538 NodeVisitor; useful as a hook for Visitors.
539 - Changed structure of ``line_block``; added ``line``.
540 - Added ``compound`` node class.
541 - Added a mechanism for Visitors to transitionally ignore new node
546 - Moved ``escape2null`` and ``unescape`` functions from
547 docutils/parsers/rst/states.py.
549 * docutils/parsers/rst/roles.py:
552 - Changed role function API: the "text" parameter now takes
553 null-escaped interpreted text content.
555 * docutils/parsers/rst/states.py:
557 - Fixed bug where a "role" directive in a nested parse would crash
558 the parser; the state machine's "language" attribute was not being
560 - Added support for line block syntax.
561 - Fixed directive parsing bug: argument-less directives didn't
562 notice that arguments were present.
563 - Removed error checking for transitions.
564 - Added support for multiple classifiers in definition list items.
565 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
566 - Changed role function API: the "text" parameter now takes
567 null-escaped interpreted text content.
568 - Empty sections and documents are allowed now.
570 * docutils/parsers/rst/directives/__init__.py:
572 - Added ``encoding`` directive option conversion function.
573 - Allow multiple class names in class_option conversion function.
575 * docutils/parsers/rst/directives/body.py:
577 - Converted the line-block directive to use the new structure.
578 - Extracted the old line-block functionality to the ``block``
579 function (still used).
580 - Added ``compound`` directive (thanks to Felix Wiemann).
582 * docutils/parsers/rst/directives/misc.py:
584 - Added "encoding" option to "include" and "raw" directives.
585 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
586 - Allow multiple class names in the "class" directive.
588 * docutils/parsers/rst/directives/parts.py:
590 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
591 options. Thanks to Lele Gaifax.
593 * docutils/parsers/rst/directives/tables.py:
595 - Added "encoding" directive to "csv-table" directive.
596 - Added workaround for lack of Unicode support in csv.py, for
599 * docutils/transforms/misc.py:
601 - Fixed bug when multiple "class" directives are applied to a single
603 - Enabled multiple format names for "raw" directive.
605 * docutils/transforms/references.py:
607 - Added support for trimming whitespace from beside substitution
610 * docutils/transforms/universal.py:
612 - FinalChecks now checks for illegal transitions and moves
613 transitions between sections.
615 * docutils/writers/html4css1.py:
617 - HTMLTranslator.encode now converts U+00A0 to " ".
618 - "stylesheet" and "stylesheet_path" settings are now mutually
620 - Added support for the new line_block/line structure.
621 - --footnote-references now overrides
622 --trim-footnote-reference-space, if applicable.
623 - Added support for ``compound`` elements.
624 - Enabled multiple format names for "raw" directive.
625 - ``<p>`` tags of a paragraph which is the only visible child of the
626 document node are no longer stripped.
627 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
628 new method ``should_be_compact_paragraph()``.
629 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
631 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
632 the output if they have their ``class`` attribute set.
633 - The whole document is now surrounded by a ``<div
634 class="document">`` element.
635 - Body-level images are now wrapped by their own ``<div>`` elements,
636 with image classes copied to the wrapper, and for images which
637 have the ``:align:`` option set, the surrounding ``<div>`` now
638 receives a class attribute (like ``class="align-left"``).
640 * docutils/writers/latex2e.py:
642 - no newline after depart_term.
643 - Added translations for some Unicode quotes.
644 - Added option "font-encoding", made package AE the default.
645 - "stylesheet" and "stylesheet_path" settings are now mutually
647 - --footnote-references now overrides
648 --trim-footnote-reference-space, if applicable.
649 - The footnote label style now matches the footnote reference style
650 ("brackets" or "superscript").
651 - Added support for ``compound`` elements.
652 - Enabled multiple format names for "raw" directive.
654 * docs/ref/docutils.dtd:
656 - Changed structure of the ``line_block`` element; added ``line``.
657 - Added ``compound`` element.
658 - Added "ltrim" and "rtrim" attributes to
659 ``substitution_definition`` element.
660 - Enabled multiple format names for ``raw`` element.
661 - Enabled multiple classifiers in ``definition_list_item`` elements.
663 * docs/ref/rst/directives.txt
665 - Marked "line-block" as deprecated.
666 - "Class" directive now allows multiple class names.
667 - Added "Rationale for Class Attribute Value Conversion".
668 - Added warning about "raw" overuse/abuse.
670 * docs/ref/rst/restructuredtext.txt:
672 - Added syntax for line blocks.
673 - Definition list items may have multiple classifiers.
675 * docs/ref/rst/roles.txt:
679 * tools/stylesheets/default.css:
681 - Added support for the new line_block structure.
682 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
685 Release 0.3.5 (2004-07-29)
686 ==========================
690 * _`Documentation cleanup/reorganization`.
692 - Created new subdirectories of docs/:
694 * ``docs/user/``: introductory/tutorial material for end-users
695 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
696 * ``docs/api/``: API reference material for client-developers
697 * ``docs/ref/``: reference material for all groups
698 * ``docs/howto/``: for component-developers and core-developers
699 * ``docs/peps/``: Python Enhancement Proposals
701 - Moved ``docs/*`` to ``docs/user/``.
702 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
703 ``spec/`` to ``docs/dev``.
704 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
705 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
706 - Moved ``alternatives.txt``, and ``problems.txt`` from
707 ``spec/rst/`` to ``docs/dev/rst/``.
708 - Moved ``reStructuredText.txt``, ``directives.txt``,
709 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
710 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
711 ``roles.txt``, ``reStructuredText.txt`` to
712 ``restructuredtext.txt``.
713 - Moved ``spec/howto/`` to ``docs/howto``.
715 In order to keep the CVS history of moved files, we supplied
716 SourceForge with a `script for modifying the Docutils CVS
719 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
721 After running the cleanup script:
723 - Added ``docs/index.txt``.
724 - Added a ``.htaccess`` file to the ``web`` module, containing
725 redirects for all old paths to new paths. They'll preserve
726 fragments (the "#name" part of a URL), and won't clutter up the
727 file system, and will correct the URL in the user's browser.
728 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
729 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
730 the "To Do" list itself in ``docs/dev/todo.txt``.
731 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
732 section of ``docs/dev/todo.txt``.
733 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
734 - Added "How To Report Bugs" to ``BUGS.txt``.
735 - Went through all the sources and docs (including under web/) and
736 updated links. Mostly done by Felix Wiemann; thanks Felix!
737 (Still need to update links in the sandboxes.)
741 * BUGS.txt: Added to project.
743 * THANKS.txt: Added to project.
745 * docutils/__init__.py:
747 - 0.3.4: Post-release.
751 - Added special error handling & advice for UnicodeEncodeError.
752 - Refactored Publisher.publish (simplified exception handling &
753 extracted debug dumps).
754 - Renamed "enable_exit" parameter of convenience functions to
755 "enable_exit_status".
756 - Enabled traceback (exception propagation) by default in
757 programmatic convenience functions.
758 - Now publish_file and publish_cmdline convenience functions return
759 the encoded string results in addition to their regular I/O.
760 - Extracted common code from publish_file, publish_string, and
761 publish_parts, into new publish_programmatically. Extracted
762 settings code to ``Publisher.process_programmatic_settings``.
763 - In Publisher.publish, disabled ``settings_overrides`` when
764 ``settings`` is supplied; redundant.
766 * docutils/frontend.py:
768 - Added help text for "--output-encoding-error-handler" and
769 "--error-encoding-error-handler".
770 - Renamed "--exit" to "--exit-status".
771 - Simplified default-setting code.
773 * docutils/parsers/rst/__init__.py:
775 - Added "--pep-base-url" and "--rfc-base-url" options.
777 * docutils/parsers/rst/states.py:
779 - Made URI recognition more aggressive and intelligent.
781 * docutils/parsers/rst/directives/__init__.py:
783 - Added several directive option conversion functions.
785 * docutils/parsers/rst/directives/body.py:
787 - Moved "table" directive to tables.py.
789 * docutils/parsers/rst/directives/tables.py: Table-related directives,
792 * docutils/writers/latex2e.py:
794 - Added "--table-style=(standard|booktabs|nolines)"
795 - figures get "here" option (LaTeX per default puts them at bottom),
796 and figure content is centered.
797 - Rowspan support for tables.
798 - Fix: admonition titles before first section.
799 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
800 - Replave ``_`` in literal by an underlined blank, because it has the correct
802 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
803 - A few unicode replacements, if output_encoding != utf
804 - Add "--graphicx-option".
805 - Indent literal-blocks.
806 - Fix: omit ``\maketitle`` when there is no document title.
808 * docs/index.txt: "Docutils Project Documentation Overview", added to
811 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
812 Tool", added to project.
814 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
816 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
818 * docs/dev/policies.txt: Added to project (extracted from
819 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
821 * docs/dev/release.txt: Added to project (extracted from
822 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
824 * docs/dev/testing.txt: Added to project.
826 * docs/dev/website.txt: Added to project (extracted from
827 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
829 * docs/ref/rst/directives.txt:
831 - Added directives: "table", "csv-table".
833 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
834 added to project. 1 page for syntax, and a 1 page reference for
835 directives and roles. Source text to be used as-is; not meant to be
838 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
839 with a change of title.
841 * test/functional/, contents, and test/test_functional.py: Added to
844 * tools/buildhtml.py: Fixed bug with config file handling.
846 * tools/html.py: Removed from project (duplicate of rst2html.py).
848 * tools/pep2html.py: Removed from project (duplicate of Python's
849 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
850 Docutils-related PEPs in docs/peps/).
852 * tools/rst2pseudoxml.py: Renamed from publish.py.
854 * tools/rst2xml.py: Renamed from docutils-xml.py.
856 * tools/test.txt: Removed from project; moved to
857 docs/user/rst/demo.txt.
859 * setup.py: Now also installs ``rst2latex.py``.
862 Release 0.3.3 (2004-05-09)
863 ==========================
865 * docutils/__init__.py:
867 - 0.3.1: Reorganized config file format (multiple sections); see
869 - Added unknown_reference_resolvers attribute to TransformSpec.
870 - 0.3.2: Interpreted text reorganization.
875 - Catch system messages to stop tracebacks from parsing errors.
876 - Catch exceptions during processing report & exit without
877 tracebacks, except when "--traceback" used.
878 - Reordered components for OptionParser; application comes last.
879 - Added "config_section" parameter to several methods and functions,
880 allowing front ends to easily specify their config file sections.
881 - Added publish_parts convenience function to allow access to individual
884 * docutils/examples.py: Added to project; practical examples of
885 Docutils client code, to be used as-is or as models for variations.
887 * docutils/frontend.py:
889 - Added "--traceback" & "--no-traceback" options ("traceback"
891 - Implemented support for config file reorganization:
892 ``standard_config_files`` moved from ``ConfigParser`` to
893 ``OptionParser``; added
894 ``OptionParser.get_config_file_settings()`` and
895 ``.get_standard_config_settings()``; support for old "[options]"
896 section (with deprecation warning) and mapping from old to new
898 - Reimplemented setting validation.
899 - Enabled flexible boolean values: yes/no, true/false, on/off.
900 - Added ``Values``, a subclass of ``optparse.Values``, with support
901 for list setting attributes.
902 - Added support for new ``DOCUTILSCONFIG`` environment variable;
903 thanks to Beni Cherniavsky.
904 - Added "--no-section-numbering" option.
908 - Catch IOErrors when opening source & destination files, report &
909 exit without tracebacks. Added ``handle_io_errors`` parameter to
910 ``FileInput`` & ``FileOutput`` to enable caller error handling.
914 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
915 method definitions (via ``exec``) to dynamic assignments (via
916 ``setattr``); thanks to Roman Suzi.
917 - Encapsulated visitor dynamic assignments in a function; thanks to
919 - Added indirect_reference_name attribute to the Targetable
920 class. This attribute holds the whitespace_normalized_name
921 (contains mixed case) of a target.
923 * docutils/statemachine.py:
925 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
926 - Added ``StringList.get_2D_block``.
930 - Added "level" attribute to SystemMessage exceptions.
932 * docutils/languages/af.py: Added to project; Afrikaans mappings by
935 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
938 * docutils/languages/eo.py: Added to project; Esperanto mappings by
939 Marcelo Huerta San Martin.
941 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
942 mappings by Lalo Martins.
944 * docutils/languages/ru.py: Added to project; Russian mappings by
947 * docutils/parsers/rst/roles.py: Added to project. Contains
948 interpreted text role functions, a registry for interpreted text
949 roles, and an API for adding to and retrieving from the registry.
950 Contributed by Edward Loper.
952 * docutils/parsers/rst/states.py:
954 - Updated ``RSTState.nested_parse`` for "include" in table cells.
955 - Allowed true em-dash character and "---" as block quote
957 - Added support for <angle-bracketed> complex option arguments
959 - Fixed handling of backslashes in substitution definitions.
960 - Fixed off-by-1 error with extra whitespace after substitution
961 definition directive.
962 - Added inline markup parsing to field lists' field names.
963 - Added support for quoted (and unindented) literal blocks.
964 Driven in part by a bribe from Frank Siebenlist (thanks!).
965 - Parser now handles escapes in URIs correctly.
966 - Made embedded-URIs' reference text omittable. Idea from Beni
968 - Refactored explicit target processing code.
969 - Added name attribute to references containing the reference name only
970 through whitespace_normalize_name (no case changes).
971 - parse_target no longer returns the refname after going through
972 normalize_name. This is now handled in make_target.
973 - Fixed bug relating to role-less interpreted text in non-English
975 - Reorganized interpreted text processing; moved code into the new
976 roles.py module. Contributed by Edward Loper.
977 - Refactored ``Body.parse_directive`` into ``run_directive`` and
978 ``parse_directive_block``.
980 * docutils/parsers/rst/tableparser.py:
982 - Reworked for ``StringList``, to support "include" directives in
985 * docutils/parsers/rst/directives/__init__.py:
987 - Renamed ``unchanged()`` directive option conversion function to
988 ``unchanged_required``, and added a new ``unchanged``.
989 - Catch unicode value too high error; fixes bug 781766.
990 - Beefed up directive error reporting.
992 * docutils/parsers/rst/directives/body.py:
994 - Added basic "table" directive.
996 * docutils/parsers/rst/directives/images.py:
998 - Added "target" option to "image" directive.
999 - Added name attribute to references containing the reference name only
1000 through whitespace_normalize_name (no case changes).
1002 * docutils/parsers/rst/directives/misc.py:
1004 - Isolated the import of the ``urllib2`` module; was causing
1005 problems on SourceForge (``libssl.so.2`` unavailable?).
1006 - Added the "role" directive for declaring custom interpreted text
1009 * docutils/parsers/rst/directives/parts.py:
1011 - The "contents" directive does more work up-front, creating the
1012 "topic" and "title", and leaving the "pending" node for the
1013 transform. Allows earlier reference resolution; fixes subtle bug.
1015 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1016 mappings by Jannie Hofmeyr.
1018 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1019 mappings by Marek Blaha.
1021 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1022 mappings by Marcelo Huerta San Martin.
1024 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1025 Portuguese mappings by Lalo Martins.
1027 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1028 mappings by Roman Suzi.
1030 * docutils/transforms/parts.py:
1032 - The "contents" directive does more work up-front, creating the
1033 "topic" and "title", and leaving the "pending" node for the
1034 transform. Allows earlier reference resolution; fixes subtle bug.
1035 - Added support for disabling of section numbering.
1037 * docutils/transforms/references.py:
1039 - Verifying that external targets are truly targets and not indirect
1040 references. This is because we are now adding a "name" attribute to
1041 references in addition to targets. Note sure if this is correct!
1042 - Added code to hook into the unknown_reference_resolvers list for a
1043 transformer in resolve_indirect_target. This allows the
1044 unknown_reference_resolvers to keep around indirect targets which
1045 docutils doesn't know about.
1046 - Added specific error message for duplicate targets.
1048 * docutils/transforms/universal.py:
1050 - Added FilterMessages transform (removes system messages below the
1051 verbosity threshold).
1052 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1053 to FinalCheckVisitor for application-specific handling of
1054 unresolvable references.
1055 - Added specific error message for duplicate targets.
1057 * docutils/writers/__init__.py:
1059 - Added assemble_parts method to the Writer class to allow for
1060 access to a documents individual parts.
1061 - Documented & set default for ``Writer.output`` attribute.
1063 * docutils/writers/html4css1.py:
1065 - Fixed unicode handling of attribute values (bug 760673).
1066 - Prevent duplication of "class" attribute values (bug report from
1068 - Improved table grid/border handling (prompted by report from Bob
1070 - Added support for table titles.
1071 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1073 - Added functionality to keep track of individual parts of a document
1074 and store them in a dictionary as the "parts" attribute of the writer.
1075 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1076 - Added proper support for the "scale" attribute of the "image"
1077 element. Contributed by Brent Cook.
1078 - Added ``--initial-header-level`` option.
1079 - Fixed bug: the body_pre_docinfo segment depended on there being a
1080 docinfo; if no docinfo, the document title was incorporated into
1081 the body segment. Adversely affected the publish_parts interface.
1083 * docutils/writers/latex2e.py:
1085 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1086 about a missing file.
1087 - Added options and support: ``--compound-enumerators``,
1088 ``--section-prefix-for-enumerators``, and
1089 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1091 - Added option ``--use-verbatim-when-possible``, to avoid
1092 problematic characters (eg, '~' in italian) in literal blocks.
1093 - It's now possible to use four section levels in the `book` and
1094 `report` LaTeX classes. The default `article` class still has
1097 * docs/config.txt: "Docutils Configuration Files", added to project.
1098 Moved config file entry descriptions from tools.txt.
1102 - Moved config file entry descriptions to config.txt.
1104 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1107 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1108 Text Roles", added to project.
1110 * spec/rst/reStructuredText.txt:
1112 - Added description of support for <angle-bracketed> complex option
1113 arguments to option lists.
1114 - Added subsections for indented and quoted literal blocks.
1116 * test: Continually adding & updating tests.
1118 - Added test/test_settings.py & test/data/config_*.txt support
1120 - Added test/test_writers/test_htmlfragment.py.
1122 * test/DocutilsTestSupport.py:
1124 - Refactored LaTeX publisher test suite/case class names to make
1125 testing other writers easier.
1126 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1127 to test the processing of HTML fragments which use the new
1128 publish_parts convenience function.
1130 * tools/buildhtml.py:
1132 - Added support for the "--prune" option.
1133 - Removed dependency on pep2html.py; plaintext PEPs no longer
1136 * tools/docutils.conf:
1138 - Updated for configuration file reorganization.
1140 * tools/rst2html.py:
1142 - copied from tools/html.py
1146 - added a 'scripts' section to configuration
1147 - added 'tools/rst2html.py' to the scripts section
1150 Release 0.3 (2003-06-24)
1151 ========================
1155 * Renamed "attribute" to "option" for directives/extensions.
1157 * Renamed transform method "transform" to "apply".
1159 * Renamed "options" to "settings" for runtime settings (as set by
1160 command-line options). Sometimes "option" (singular) became
1161 "settings" (plural). Some variations below:
1163 - document.options -> document.settings (stored in other objects as
1165 - option_spec -> settings_spec (not directives though)
1166 - OptionSpec -> SettingsSpec
1167 - cmdline_options -> settings_spec
1168 - relative_path_options -> relative_path_settings
1169 - option_default_overrides -> settings_default_overrides
1170 - Publisher.set_options -> Publisher.get_settings
1174 * COPYING.txt: Added "Public Domain Dedication".
1176 * FAQ.txt: Frequently asked questions, added to project.
1180 - Updated with PyPI Trove classifiers.
1181 - Conditional installation of third-party modules.
1183 * docutils/__init__.py:
1185 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1186 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1187 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1188 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1189 option and its effect on the PEP template & writer.
1190 - Bumped version to 0.2.4 due to changes to the PEP template &
1192 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1193 - Added ``TransformSpec`` class for new transform system.
1194 - Bumped version to 0.2.6 for API changes (renaming).
1195 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1196 convenience functions.
1197 - Added ``Component.component_type`` attribute.
1198 - Bumped version to 0.2.8 because of the internal parser switch from
1199 plain lists to the docutils.statemachine.StringList objects.
1200 - Bumped version to 0.2.9 because of the frontend.py API changes.
1201 - Bumped version to 0.2.10 due to changes to the project layout
1202 (third-party modules removed from the "docutils" package), and
1203 signature changes in ``io.Input``/``io.Output``.
1204 - Changed version to 0.3.0 for release.
1208 - Made ``publish()`` a bit more convenient.
1209 - Generalized ``Publisher.set_io``.
1210 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1211 parameters; improved its docstring.
1212 - Added ``publish_file()`` and ``publish_string()``.
1213 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1215 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1216 "--dump-transforms" hidden options.
1217 - Added ``Publisher.apply_transforms()`` method.
1218 - Added ``Publisher.set_components()`` method; support for
1219 ``publish_*()`` conveninece functions.
1220 - Moved config file processing to docutils/frontend.py.
1221 - Added support for exit status ("exit_level" setting &
1222 ``enable_exit`` parameter for Publisher.publish() and convenience
1225 * docutils/frontend.py:
1227 - Check for & exit on identical source & destination paths.
1228 - Fixed bug with absolute paths & "--config".
1229 - Set non-command-line defaults in ``OptionParser.__init__()``:
1230 ``_source`` & ``_destination``.
1231 - Distributed ``relative_path_settings`` to components; updated
1232 ``OptionParser.populate_from_components()`` to combine it all.
1233 - Require list of keys in ``make_paths_absolute`` (was implicit in
1234 global ``relative_path_settings``).
1235 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1236 "--dump-settings", and "--dump-transforms" hidden options.
1237 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1238 code, replaced with correct code.
1239 - Added validation functionality for config files.
1240 - Added "--error-encoding" option/setting, "_disable_config"
1242 - Added encoding validation; updated "--input-encoding" and
1243 "--output-encoding"; added "--error-encoding-error-handler" and
1244 "--output-encoding-error-handler".
1245 - Moved config file processing from docutils/core.py.
1246 - Updated ``OptionParser.populate_from_components`` to handle new
1247 ``SettingsSpec.settings_defaults`` dict.
1248 - Added support for "-" => stdin/stdout.
1249 - Added "exit_level" setting ("--exit" option).
1253 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1254 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1255 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1256 - ``FileOutput.write()`` now returns the encoded output string.
1257 - Try to get path/stream name automatically in ``FileInput`` &
1259 - Added defaults for source & destination paths.
1260 - Allow for Unicode I/O with an explicit "unicode" encoding.
1261 - Added ``Output.encode()``.
1262 - Removed dependency on runtime settings; pass encoding directly.
1263 - Recognize Unicode strings in ``Input.decode()``.
1264 - Added support for output encoding error handlers.
1266 * docutils/nodes.py:
1268 - Added "Invisible" element category class.
1269 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1270 modification during a traversal.
1271 - Added element classes: ``line_block``, ``generated``, ``address``,
1272 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1273 ``superscript``, ``subscript``, ``inline``
1274 - Added support for lists of nodes to ``Element.insert()``.
1275 - Fixed parent linking in ``Element.replace()``.
1276 - Added new abstract superclass ``FixedTextElement``; adds
1277 "xml:space" attribute.
1278 - Added support for "line" attribute of ``system_message`` nodes.
1279 - Added support for the observer pattern from ``utils.Reporter``.
1280 Added ``parse_messages`` and ``transform_messages`` attributes to
1281 ``document``, removed ``messages``. Added ``note_parse_message``
1282 and ``note_transform_message`` methods.
1283 - Added support for improved diagnostics:
1285 - Added "document", "source", and "line" internal attributes to
1286 ``Node``, set by ``Node.setup_child()``.
1287 - Converted variations on ``node.parent = self`` to
1288 ``self.setup_child(node)``.
1289 - Added ``document.current_source`` & ``.current_line``
1290 attributes, and ``.note_source`` observer method.
1291 - Changed "system_message" output to GNU-Tools format.
1293 - Added a "rawsource" attribute to the ``Text`` class, for text
1294 before backslash-escape resolution.
1295 - Support for new transform system.
1296 - Reworked ``pending`` element.
1297 - Fixed XML DOM bug (SF #660611).
1298 - Removed the ``interpeted`` element class and added
1299 ``title_reference``, ``abbreviation``, ``acronym``.
1300 - Made substitutions case-sensitive-but-forgiving; moved some code
1302 - Fixed Unicode bug on element attributes (report: William Dode).
1304 * docutils/optik.py: Removed from project; replaced with
1305 extras/optparse.py and extras/textwrap.py. These will be installed
1306 only if they're not already present in the Python installation.
1308 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1309 only if it's not already present in the Python installation.
1311 * docutils/statemachine.py:
1313 - Factored out ``State.add_initial_transitions()`` so it can be
1315 - Converted whitespace-specific "blank" and "indent" transitions
1316 from special-case code to ordinary transitions: removed
1317 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1318 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1319 ``ws_initial_transitions`` attributes.
1320 - Removed ``State.match_transition()`` after merging it into
1322 - Added ``StateCorrection`` exception.
1323 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1324 (moved ``TransitionCorrection`` support there too.)
1325 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1326 ``EOFError`` instead of ``IndexError``.
1327 - Added ``State.no_match`` method.
1328 - Added support for the Observer pattern, triggered by input line
1330 - Added ``strip_top`` parameter to
1331 ``StateMachineWS.get_first_known_indented``.
1332 - Made ``context`` a parameter to ``StateMachine.run()``.
1333 - Added ``ViewList`` & ``StringList`` classes;
1334 ``extract_indented()`` becomes ``StringList.get_indented()``.
1335 - Added ``StateMachine.insert_input()``.
1336 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1337 thanks to) Fred Drake.
1339 * docutils/utils.py:
1341 - Added a ``source`` attribute to Reporter instances and
1342 ``system_message`` elements.
1343 - Added an observer pattern to ``utils.Reporter`` to keep track of
1345 - Fixed bugs in ``relative_path()``.
1346 - Added support for improved diagnostics.
1347 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1348 - Added support for encoding Reporter stderr output, and encoding
1350 - Reporter keeps track of the highest level system message yet
1353 * docutils/languages: Fixed bibliographic field language lookups.
1355 * docutils/languages/es.py: Added to project; Spanish mappings by
1356 Marcelo Huerta San Martin.
1358 * docutils/languages/fr.py: Added to project; French mappings by
1361 * docutils/languages/it.py: Added to project; Italian mappings by
1364 * docutils/languages/sk.py: Added to project; Slovak mappings by
1367 * docutils/parser/__init__.py:
1369 - Added ``Parser.finish_parse()`` method.
1371 * docutils/parser/rst/__init__.py:
1373 - Added options: "--pep-references", "--rfc-references",
1374 "--tab-width", "--trim-footnote-reference-space".
1376 * docutils/parsers/rst/states.py:
1378 - Changed "title under/overline too short" system messages from INFO
1379 to WARNING, and fixed its insertion location.
1380 - Fixed enumerated list item parsing to allow paragraphs & section
1381 titles to begin with enumerators.
1382 - Converted system messages to use the new "line" attribute.
1383 - Fixed a substitution reference edge case.
1384 - Added support for "--pep-references" and "--rfc-references"
1385 options; reworked ``Inliner`` code to make customization easier.
1386 - Removed field argument parsing.
1387 - Added support for short section title over/underlines.
1388 - Fixed "simple reference name" regexp to ignore text like
1389 "object.__method__"; not an anonymous reference.
1390 - Added support for improved diagnostics.
1391 - Reworked directive API, based on Dethe Elza's contribution. Added
1392 ``Body.parse_directive()``, ``.parse_directive_options()``,
1393 ``.parse_directive_arguments()`` methods.
1394 - Added ``ExtensionOptions`` class, to parse directive options
1395 without parsing field bodies. Factored
1396 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1397 ``ExtensionOptions``.
1398 - Improved definition list term/classifier parsing.
1399 - Added warnings for unknown directives.
1400 - Renamed ``Stuff`` to ``Struct``.
1401 - Now flagged as errors: transitions at the beginning or end of
1402 sections, empty sections (except title), and empty documents.
1403 - Updated for ``statemachine.StringList``.
1404 - Enabled recognition of schemeless email addresses in targets.
1405 - Added support for embedded URIs in hyperlink references.
1406 - Added backslash-escapes to inline markup end-string suffix.
1407 - Added support for correct interpreted text processing.
1408 - Fixed nested title parsing (topic, sidebar directives).
1409 - Added special processing of backslash-escaped whitespace (idea
1410 from David Abrahams).
1411 - Made substitutions case-sensitive-but-forgiving; moved some code
1412 to ``docutils.nodes``.
1413 - Added support for block quote attributions.
1414 - Added a kludge to work-around a conflict between the bubble-up
1415 parser strategy and short titles (<= 3 char-long over- &
1416 underlines). Fixes SF bug #738803 "infinite loop with multiple
1417 titles" submitted by Jason Diamond.
1418 - Added explicit interpreted text roles for standard inline markup:
1419 "emphasis", "strong", "literal".
1420 - Implemented "superscript" and "subscript" interpreted text roles.
1421 - Added initial support for "abbreviation" and "acronym" roles;
1423 - Added support for "--trim-footnote-reference-space" option.
1424 - Optional space before colons in directives & hyperlink targets.
1426 * docutils/parsers/rst/tableparser.py:
1428 - Fixed a bug that was producing unwanted empty rows in "simple"
1430 - Detect bad column spans in "simple" tables.
1432 * docutils/parsers/rst/directives: Updated all directive functions to
1435 * docutils/parsers/rst/directives/__init__.py:
1437 - Added ``flag()``, ``unchanged()``, ``path()``,
1438 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1439 directive option helper functions.
1440 - Added warnings for unknown directives.
1441 - Return ``None`` for missing directives.
1442 - Added ``register_directive()``, thanks to William Dode and Paul
1445 * docutils/parsers/rst/directives/admonitions.py:
1447 - Added "admonition" directive.
1449 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1450 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1451 "parsed-literal", "rubric", "epigraph", "highlights" and
1452 "pull-quote" directives.
1454 * docutils/parsers/rst/directives/images.py:
1456 - Added an "align" attribute to the "image" & "figure" directives
1457 (by Adam Chodorowski).
1458 - Added "class" option to "image", and "figclass" to "figure".
1460 * docutils/parsers/rst/directives/misc.py:
1462 - Added "include", "raw", and "replace" directives, courtesy of
1464 - Added "unicode" and "class" directives.
1466 * docutils/parsers/rst/directives/parts.py:
1468 - Added the "sectnum" directive; by Dmitry Jemerov.
1469 - Added "class" option to "contents" directive.
1471 * docutils/parsers/rst/directives/references.py: Added to project.
1472 Contains the "target-notes" directive.
1474 * docutils/parsers/rst/languages/__init__.py:
1476 - Return ``None`` from get_language() for missing language modules.
1478 * docutils/parsers/rst/languages/de.py: Added to project; German
1479 mappings by Engelbert Gruber.
1481 * docutils/parsers/rst/languages/en.py:
1483 - Added interpreted text roles mapping.
1485 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1486 mappings by Marcelo Huerta San Martin.
1488 * docutils/parsers/rst/languages/fr.py: Added to project; French
1489 mappings by William Dode.
1491 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1492 mappings by Nicola Larosa.
1494 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1495 mappings by Miroslav Vasko.
1497 * docutils/readers/__init__.py:
1499 - Added support for the observer pattern from ``utils.Reporter``, in
1500 ``Reader.parse`` and ``Reader.transform``.
1501 - Removed ``Reader.transform()`` method.
1502 - Added default parameter values to ``Reader.__init__()`` to make
1503 instantiation easier.
1504 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1506 * docutils/readers/pep.py:
1508 - Added the ``peps.TargetNotes`` transform to the Reader.
1509 - Removed PEP & RFC reference detection code; moved to
1510 parsers/rst/states.py as options (enabled here by default).
1511 - Added support for pre-acceptance PEPs (no PEP number yet).
1512 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1515 * docutils/readers/python: Python Source Reader subpackage added to
1516 project, including preliminary versions of:
1519 - moduleparser.py: Parser for Python modules.
1521 * docutils/transforms/__init__.py:
1523 - Added ``Transformer`` class and completed transform reform.
1524 - Added unknown_reference_resolvers list for each transformer. This list holds
1525 the list of functions provided by each component of the transformer that
1526 help resolve references.
1528 * docutils/transforms/frontmatter.py:
1530 - Improved support for generic fields.
1531 - Fixed bibliographic field language lookups.
1533 * docutils/transforms/misc.py: Added to project. Miscellaneous
1536 * docutils/transforms/parts.py:
1538 - Moved the "id" attribute from TOC list items to the references
1539 (``Contents.build_contents()``).
1540 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1541 - Added "class" attribute support to ``Contents``.
1543 * docutils/transforms/peps.py:
1545 - Added ``mask_email()`` function, updating to pep2html.py's
1547 - Linked "Content-Type: text/x-rst" to PEP 12.
1548 - Added the ``TargetNotes`` PEP-specific transform.
1549 - Added ``TargetNotes.cleanup_callback``.
1550 - Added title check to ``Headers``.
1552 * docutils/transforms/references.py:
1554 - Added the ``TargetNotes`` generic transform.
1555 - Split ``Hyperlinks`` into multiple transforms.
1556 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1557 - Added check for circular indirect references.
1558 - Made substitutions case-sensitive-but-forgiving.
1560 * docutils/transforms/universal.py:
1562 - Added support for the "--expose-internal-attributes" option.
1563 - Removed ``Pending`` transform classes & data.
1565 * docutils/writers/__init__.py:
1567 - Removed ``Writer.transform()`` method.
1569 * docutils/writers/docutils-xml.py:
1571 - Added XML and doctype declarations.
1572 - Added "--no-doctype" and "--no-xml-declaration" options.
1574 * docutils/writers/html4css1.py:
1576 - "name" attributes only on these tags: a, applet, form, frame,
1578 - Added "name" attribute to <a> in section titles for Netscape 4
1579 support (bug report: Pearu Peterson).
1580 - Fixed targets (names) on footnote, citation, topic title,
1581 problematic, and system_message nodes (for Netscape 4).
1582 - Changed field names from "<td>" to "<th>".
1583 - Added "@" to "@" encoding to thwart address harvesters.
1584 - Improved the vertical whitespace optimization; ignore "invisible"
1585 nodes (targets, comments, etc.).
1586 - Improved inline literals with ``<span class="pre">`` around chunks
1587 of text and `` `` for runs of spaces.
1588 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1589 ``self.docinfo`` segments.
1590 - Added support for "line_block", "address" elements.
1591 - Improved backlinks (footnotes & system_messages).
1592 - Improved system_message output.
1593 - Redefined "--stylesheet" as containing an invariant URL, used
1594 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1596 - Added "--footnote-references" option (superscript or brackets).
1597 - Added "--compact-lists" and "--no-compact-lists" options.
1598 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1599 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1600 - Improved field list rendering.
1601 - Added Docutils version to "generator" meta tag.
1602 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1603 - Improved layout of <pre> HTML source.
1604 - Fixed attribute typo on <colspec>.
1605 - Refined XML prologue.
1606 - Support for no stylesheet.
1607 - Removed "interpreted" element support.
1608 - Added support for "title_reference", "sidebar", "attribution",
1609 "rubric", and generic "admonition" elements.
1610 - Added "--attribution" option.
1611 - Added support for "inline", "subscript", "superscript" elements.
1612 - Added initial support for "abbreviation" and "acronym";
1615 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1619 - Double quotes in literal blocks (special treatment for de/ngerman).
1620 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1621 - Added "--attribution" option.
1622 - Right align attributions.
1624 * docutils/writers/pep_html.py:
1626 - Parameterized output encoding in PEP template.
1627 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1628 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1629 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1631 - Added an override on the "--footnote-references" option.
1632 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1633 - Added Docutils version to "generator" meta tag.
1634 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1638 - Added a "silent" setting for ``buildhtml.py``.
1639 - Added a "Getting Help" section.
1640 - Rearranged the structure.
1641 - Kept up to date, with new settings, command-line options etc.
1642 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1643 - Converted settings table into a definition list.
1645 * docs/rst/quickstart.txt:
1647 - Added a table of contents.
1648 - Added feedback information.
1649 - Added mention of minimum section title underline lengths.
1650 - Removed the 4-character minimum for section title underlines.
1652 * docs/rst/quickref.html:
1654 - Added a "Getting Help" section.
1655 - Added a style to make section title backlinks more subtle.
1656 - Added mention of minimum section title underline lengths.
1657 - Removed the 4-character minimum for section title underlines.
1659 * extras: Directory added to project; contains third-party modules
1660 that Docutils depends on (optparse, textwrap, roman). These are
1661 only installed if they're not already present.
1663 * licenses: Directory added to project; contains copies of license
1664 files for non-public-domain files.
1668 - Changed the focus. It's about DTD elements: structural
1669 relationships, semantics, and external (public) attributes. Not
1670 about the element class library.
1671 - Moved some implementation-specific stuff into ``docutils.nodes``
1673 - Wrote descriptions of all common attributes and parameter
1674 entities. Filled in introductory material.
1675 - Working through the element descriptions: 55 down, 37 to go.
1676 - Removed "Representation of Horizontal Rules" to
1677 spec/rst/alternatives.txt.
1679 * spec/docutils.dtd:
1681 - Added "generated" inline element.
1682 - Added "line_block" body element.
1683 - Added "auto" attribute to "title".
1684 - Changed content models of "literal_block" and "doctest_block" to
1686 - Added ``%number;`` attribute type parameter entity.
1687 - Changed ``%structural.elements;`` to ``%section.elements``.
1688 - Updated attribute types; made more specific.
1689 - Added "address" bibliographic element.
1690 - Added "line" attribute to ``system_message`` element.
1691 - Removed "field_argument" element; "field_name" may contain
1692 multiple words and whitespace.
1693 - Changed public identifier to docutils.sf.net.
1694 - Removed "interpreted" element; added "title_reference",
1695 "abbreviation", "acronym".
1696 - Removed "refuri" attribute from "footnote_reference" and
1697 "citation_reference".
1698 - Added "sidebar", "rubric", "attribution", "admonition",
1699 "superscript", "subscript", and "inline" elements.
1701 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1703 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1705 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1707 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1710 * spec/transforms.txt: Added to project.
1712 * spec/howto: Added subdirectory, for developer how-to docs.
1714 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1715 Elza, edited & extended by David Goodger.
1717 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1720 * spec/rst/alternatives.txt:
1722 - Added "Doctree Representation of Transitions" from
1724 - Updated "Inline External Targets" & closed the debate.
1725 - Added ideas for interpreted text syntax extensions.
1726 - Added "Nested Inline Markup" section.
1728 * spec/rst/directives.txt:
1730 - Added directives: "topic", "sectnum", "target-notes",
1731 "line-block", "parsed-literal", "include", "replace", "sidebar",
1732 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1734 - Formalized descriptions of directive details.
1735 - Added an "align" attribute to the "image" & "figure" directives
1736 (by Adam Chodorowski).
1737 - Added "class" options to "topic", "sidebar", "line-block",
1738 "parsed-literal", "contents", and "image"; and "figclass" to
1741 * spec/rst/interpreted.txt: Added to project. Descriptions of
1742 interpreted text roles.
1744 * spec/rst/introduction.txt:
1746 - Added pointers to material for new users.
1748 * spec/rst/reStructuredText.txt:
1750 - Disambiguated comments (just add a newline after the "::").
1751 - Updated enumerated list description; added a discussion of the
1752 second-line validity checking.
1753 - Updated directive description.
1754 - Added a note redirecting newbies to the user docs.
1755 - Expanded description of inline markup start-strings in non-markup
1757 - Removed field arguments and made field lists a generic construct.
1758 - Removed the 4-character minimum for section title underlines.
1759 - Clarified term/classifier delimiter & inline markup ambiguity
1761 - Added "Embedded URIs".
1762 - Updated "Interpreted Text" section.
1763 - Added "Character-Level Inline Markup" section.
1765 * test: Continually adding & updating tests.
1767 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1768 - Moved test/test_pep/ to test/test_readers/test_pep/.
1769 - Added test/test_readers/test_python/.
1770 - Added test/test_writers/ (Engelbert Gruber).
1774 - Made the ``locale.setlocale()`` calls in front ends
1777 * tools/buildhtml.py:
1779 - Added "--silent" option.
1780 - Fixed bug with absolute paths & "--config".
1781 - Updated for new I/O classes.
1782 - Added some exception handling.
1783 - Separated publishers' setting defaults; prevents interference.
1784 - Updated for new ``publish_file()`` convenience function.
1786 * tools/pep-html-template:
1788 - Allow for "--embed-stylesheet".
1789 - Added Docutils version to "generator" meta tag.
1790 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1791 - Conform to XHTML spec.
1793 * tools/pep2html.py:
1795 - Made ``argv`` a parameter to ``main()``.
1796 - Added support for "Content-Type:" header & arbitrary PEP formats.
1797 - Linked "Content-Type: text/plain" to PEP 9.
1798 - Files skipped (due to an error) are not pushed onto the server.
1799 - Updated for new I/O classes.
1800 - Added ``check_requirements()`` & ``pep_type_error()``.
1801 - Added some exception handling.
1802 - Updated for new ``publish_string()`` convenience function.
1803 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1805 * tools/quicktest.py:
1807 - Added "-V"/"--version" option.
1809 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1811 * tools/unicode2rstsubs.py: Added to project. Produces character
1812 entity files (reSructuredText substitutions) from the MathML master
1815 * tools/editors: Support code for editors, added to project. Contains
1816 ``emacs/restructuredtext.el``.
1818 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1820 - Added style for chunks of inline literals.
1821 - Removed margin for first child of table cells.
1822 - Right-aligned field list names.
1823 - Support for auto-numbered section titles in TOCs.
1824 - Increased the size of inline literals (<tt>) in titles.
1825 - Restored the light gray background for inline literals.
1826 - Added support for "line_block" elements.
1827 - Added style for "address" elements.
1828 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1829 - Improved field list rendering.
1830 - Vertical whitespace improvements.
1831 - Removed "a.target" style.
1833 * tools/stylesheets/pep.css:
1835 - Fixed nested section margins.
1836 - Other changes parallel those of ``../default.css``.
1839 Release 0.2 (2002-07-31)
1840 ========================
1844 - The word "component" was being used ambiguously. From now on,
1845 "component" will be used to mean "Docutils component", as in Reader,
1846 Writer, Parser, or Transform. Portions of documents (Table of
1847 Contents, sections, etc.) will be called "document parts".
1848 - Did a grand renaming: a lot of ``verylongnames`` became
1849 ``very_long_names``.
1850 - Cleaned up imports: no more relative package imports or
1851 comma-separated lists of top-level modules.
1852 - Added support for an option values object which carries default
1853 settings and overrides (from command-line options and library use).
1854 - Added internal Unicode support, and support for both input and
1856 - Added support for the ``docutils.io.IO`` class & subclasses.
1860 * docutils/__init__.py:
1862 - Added ``ApplicationError`` and ``DataError``, for use throughout
1864 - Added ``Component`` base class for Docutils components; implements
1865 the ``supports`` method.
1866 - Added ``__version__`` (thus, ``docutils.__version__``).
1870 - Removed many keyword parameters to ``Publisher.__init__()`` and
1871 ``publish()``; bundled into an option values object. Added
1872 "argv", "usage", "description", and "option_spec" parameters for
1873 command-line support.
1874 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1876 - Reworked I/O model for ``docutils.io`` wrappers.
1877 - Updated ``Publisher.set_options()``; now returns option values
1879 - Added support for configuration files (/etc/docutils.conf,
1880 ./docutils.conf, ~/.docutils).
1881 - Added ``Publisher.setup_option_parser()``.
1882 - Added default usage message and description.
1884 * docutils/frontend.py: Added to project; support for front-end
1885 (command-line) scripts. Option specifications may be augmented by
1886 components. Requires Optik (http://optik.sf.net/) for option
1887 processing (installed locally as docutils/optik.py).
1889 * docutils/io.py: Added to project; uniform API for a variety of input
1892 * docutils/nodes.py:
1894 - Added ``TreeCopyVisitor`` class.
1895 - Added a ``copy`` method to ``Node`` and subclasses.
1896 - Added a ``SkipDeparture`` exception for visitors.
1897 - Renamed ``TreePruningException`` from ``VisitorException``.
1898 - Added docstrings to ``TreePruningException``, subclasses, and
1900 - Improved docstrings.
1901 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1902 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1904 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1905 ``PreDecorative`` mixin.
1906 - Reworked the name/id bookkeeping; to ``document``, removed
1907 ``explicit_targets`` and ``implicit_targets`` attributes, added
1908 ``nametypes`` attribute and ``set_name_id_map`` method.
1909 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1911 - Added ``document.has_name()`` method.
1912 - Fixed DOM generation for list-attributes.
1913 - Added category class ``Labeled`` (used by footnotes & citations).
1914 - Added ``Element.set_class()`` method (sets "class" attribute).
1916 * docutils/optik.py: Added to project. Combined from the Optik
1917 package, with added option groups and other modifications. The use
1918 of this module is probably only temporary.
1920 * docutils/statemachine.py:
1922 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1923 - Added underscores to improve many awkward names.
1924 - In ``string2lines()``, changed whitespace normalizing translation
1925 table to regexp; restores Python 2.0 compatibility with Unicode.
1927 * docutils/urischemes.py:
1929 - Filled in some descriptions.
1930 - Added "shttp" scheme.
1932 * docutils/utils.py:
1934 - Added ``clean_rcs_keywords`` function (moved from
1935 docutils/transforms/frontmatter.py
1936 ``DocInfo.filter_rcs_keywords``).
1937 - Added underscores to improve many awkward names.
1938 - Changed names of Reporter's thresholds:
1939 warning_level -> report_level; error_level -> halt_level.
1940 - Moved ``utils.id()`` to ``nodes.make_id()``.
1941 - Added ``relative_path(source, target)``.
1943 * docutils/languages/de.py: German mappings; added to project. Thanks
1944 to Gunnar Schwant for the translations.
1946 * docutils/languages/en.py: Added "Dedication" bibliographic field
1949 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1952 * docutils/parsers/rst/states.py:
1954 - Added underscores to improve many awkward names.
1955 - Added RFC-2822 header support.
1956 - Extracted the inline parsing code from ``RSTState`` to a separate
1957 class, ``Inliner``, which will allow easy subclassing.
1958 - Made local bindings for ``memo`` container & often-used contents
1959 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1960 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1961 - Added ``MarkupMismatch`` exception; for late corrections.
1962 - Added ``-/:`` characters to inline markup's start string prefix,
1963 ``/`` to end string suffix.
1964 - Fixed a footnote bug.
1965 - Fixed a bug with literal blocks.
1966 - Applied patch from Simon Budig: simplified regexps with symbolic
1967 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1968 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1969 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1970 - Allowed non-ASCII in "simple names" (directive names, field names,
1972 - Converted ``Inliner.patterns.initial`` to be dynamically built
1973 from parts with ``build_regexp()`` function.
1974 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1975 - Updated docstrings.
1976 - Changed "table" to "grid_table"; added "simple_table" support.
1978 * docutils/parsers/rst/tableparser.py:
1980 - Changed ``TableParser`` to ``GridTableParser``.
1981 - Added ``SimpleTableParser``.
1982 - Refactored naming.
1984 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1985 a fallback language for directive names.
1987 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1988 directive to use a ``pending`` element, used only by HTML writers.
1990 * docutils/parsers/rst/directives/parts.py: Renamed from
1993 - Added "backlinks" attribute to "contents" directive.
1995 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1996 project by Adam Chodorowski.
1998 * docutils/readers/__init__.py: Gave Readers more control over
1999 choosing and instantiating Parsers.
2001 * docutils/readers/pep.py: Added to project; for PEP processing.
2003 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2004 requires a ``component`` parameter.
2006 * docutils/transforms/components.py: Added to project; transforms
2007 related to Docutils components.
2009 * docutils/transforms/frontmatter.py:
2011 - In ``DocInfo.extract_authors``, check for a single "author" in an
2012 "authors" group, and convert it to a single "author" element.
2013 - Added support for "Dedication" and generic bibliographic fields.
2015 * docutils/transforms/peps.py: Added to project; PEP-specific.
2017 * docutils/transforms/parts.py: Renamed from old components.py.
2019 - Added filter for `Contents`, to use alt-text for inline images,
2020 and to remove inline markup that doesn't make sense in the ToC.
2021 - Added "name" attribute to TOC topic depending on its title.
2022 - Added support for optional TOC backlinks.
2024 * docutils/transforms/references.py: Fixed indirect target resolution
2025 in ``Hyperlinks`` transform.
2027 * docutils/transforms/universal.py:
2029 - Changed ``Messages`` transform to properly filter out system
2030 messages below the warning threshold.
2031 - Added ``Decorations`` transform (support for ``--generator``,
2032 ``--date``, ``--time``, ``--source-link`` options).
2034 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2035 Engelbert Gruber's PDF writer.
2037 * docutils/writers/html4css1.py:
2039 - Made XHTML-compatible (switched to lowercase element & attribute
2040 names; empty tag format).
2041 - Escape double-dashes in comment text.
2042 - Improved boilerplate & modularity of output.
2043 - Exposed modular output in Writer class.
2044 - Added a "generator" meta tag to <head>.
2045 - Added support for the ``--stylesheet`` option.
2046 - Added support for ``decoration``, ``header``, and ``footer``
2048 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2049 translation table to regexp; restores Python 2.0 compatibility
2051 - Added the translator class as instance variable to the Writer, to
2052 make it easily subclassable.
2053 - Improved option list spacing (thanks to Richard Jones).
2054 - Modified field list output.
2055 - Added backlinks to footnotes & citations.
2056 - Added percentage widths to "<col>" tags (from colspec).
2057 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2058 "<span>" changed to "<var>".
2059 - Inline literals: "<code>" changed to "<tt>".
2060 - Many changes to optimize vertical space: compact simple lists etc.
2061 - Add a command-line options & directive attributes to control TOC
2062 and footnote/citation backlinks.
2063 - Added support for optional footnote/citation backlinks.
2064 - Added support for generic bibliographic fields.
2065 - Identify backrefs.
2066 - Relative URLs for stylesheet links.
2068 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2069 PEPs (subclass of ``html4css1.Writer``).
2071 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2073 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2074 of the Docutils internal doctree in XML.
2076 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2080 - Changed the title to "The Docutils Document Tree".
2081 - Added "Hyperlink Bookkeeping" section.
2083 * spec/docutils.dtd:
2085 - Added ``decoration``, ``header``, and ``footer`` elements.
2086 - Brought ``interpreted`` element in line with the parser: changed
2087 attribute "type" to "role", added "position".
2088 - Added support for generic bibliographic fields.
2090 * spec/notes.txt: Continual updates. Added "Project Policies".
2092 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2095 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2097 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2098 mailing list discussions.
2100 * spec/pep-0287.txt:
2102 - Renamed to "reStructuredText Docstring Format".
2104 - Reworked Q&A as an enumerated list.
2105 - Converted to reStructuredText format.
2107 * spec/pysource.dtd:
2109 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2111 * spec/pysource.txt: Removed from project. Moved much of its contents
2114 * spec/rst/alternatives.txt:
2116 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2117 - Added "Inline External Targets" section.
2119 * spec/rst/directives.txt:
2121 - Added "backlinks" attribute to "contents" directive.
2123 * spec/rst/problems.txt:
2125 - Updated the Enumerated List Markup discussion.
2126 - Added new alternative table markup syntaxes.
2128 * spec/rst/reStructuredText.txt:
2130 - Clarified field list usage.
2131 - Updated enumerated list description.
2132 - Clarified purpose of directives.
2133 - Added ``-/:`` characters to inline markup's start string prefix,
2134 ``/`` to end string suffix.
2135 - Updated "Authors" bibliographic field behavior.
2136 - Changed "inline hyperlink targets" to "inline internal targets".
2137 - Added "simple table" syntax to supplement the existing but
2138 newly-renamed "grid tables".
2139 - Added cautions for anonymous hyperlink use.
2140 - Added "Dedication" and generic bibliographic fields.
2142 * test: Made test modules standalone (subdirectories became packages).
2144 * test/DocutilsTestSupport.py:
2146 - Added support for PEP extensions to reStructuredText.
2147 - Added support for simple tables.
2148 - Refactored naming.
2150 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2152 - Now supports true packages containing test modules
2153 (``__init__.py`` files required); fixes duplicate module name bug.
2155 * test/test_pep/: Subpackage added to project; PEP testing.
2157 * test/test_rst/test_SimpleTableParser.py: Added to project.
2161 - Updated html.py and publish.py front-end tools to use the new
2162 command-line processing facilities of ``docutils.frontend``
2163 (exposed in ``docutils.core.Publisher``), reducing each to just a
2165 - Added ``locale.setlocale()`` calls to front-end tools.
2167 * tools/buildhtml.py: Added to project; batch-generates .html from all
2168 the .txt files in directories and subdirectories.
2170 * tools/default.css:
2172 - Added support for ``header`` and ``footer`` elements.
2173 - Added styles for "Dedication" topics (biblio fields).
2175 * tools/docutils.conf: A configuration file; added to project.
2177 * tools/docutils-xml.py: Added to project.
2179 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2181 * tools/pep-html-template: Added to project.
2183 * tools/pep2html.py: Added to project from Python (nondist/peps).
2184 Added support for Docutils (reStructuredText PEPs).
2186 * tools/quicktest.py:
2188 - Added the ``--attributes`` option, hacked a bit.
2189 - Added a second command-line argument (output file); cleaned up.
2191 * tools/stylesheets/: Subdirectory added to project.
2193 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2196 Release 0.1 (2002-04-20)
2197 ========================
2199 This is the first release of Docutils, merged from the now inactive
2200 reStructuredText__ and `Docstring Processing System`__ projects. For
2201 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2202 `DPS HISTORY`__ files.
2204 __ http://structuredtext.sourceforge.net/
2205 __ http://docstring.sourceforge.net/
2206 __ http://structuredtext.sourceforge.net/HISTORY.html
2207 __ http://docstring.sourceforge.net/HISTORY.html
2209 General changes: renamed 'dps' package to 'docutils'; renamed
2210 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2211 the test suites (reStructuredText's test/test_states renamed to
2212 test/test_rst); and all modifications required to make it all work.
2214 * docutils/parsers/rst/states.py:
2216 - Improved diagnostic system messages for missing blank lines.
2217 - Fixed substitution_reference bug.
2223 indent-tabs-mode: nil
2224 sentence-end-double-space: t