1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
22 - Backwards-compatible changes to remove python2.6 -3 deprecation warnings
23 - Text nodes now subclass unicode rather than UserString
24 (which is gone in python 3.0)
25 - Apply [ 1719345 ] Galician translation
26 - Apply [ 1905741 ] polish-translation
30 - Added ``Element.__contains__`` method, for the in-operator.
32 * docutils/parsers/rst/states.py:
34 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup
36 * docutils/writers/newlatex2e/__init__.py:
38 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
40 * docutils/writers/latex2e/__init__.py:
42 - Apply [ 1474017 ] image vertical alignment is reversed.
43 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
44 - Fix: for spanish ``~n`` is ``n`` with tilde above, change to ``~{}n``.
45 - Change: has_key for dictionaries (not Nodes) to in-operator.
46 - Merge adjacent citations into one latex cite command.
48 Release 0.5 (2008-06-25)
49 ========================
51 * docutils/languages/he.py: Added to project: Hebrew mappings by
54 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
55 mappings by Meir Kriheli.
57 * docutils/frontend.py:
59 - Configuration files are now assumed and required to be
61 - Paths of applied configuration files are now recorded in the
62 runtime setting ``_config_files`` (accessible via
64 - Added ``--strip-elements-with-class`` and ``--strip-class``
65 options (``strip_elements_with_classes`` and ``strip_classes``
70 - Added code to determine the input encoding from data: encoding
71 declarations or the presence of byte order marks (UTF-8 & UTF-16).
72 - Added support for IronPython 1.0.
76 - Added ``document.__getstate__`` method, for pickling.
78 * docutils/parsers/rst/states.py:
80 - Allow ``+`` and ``:`` in reference names.
81 - Unquoted targets beginning with an underscore (``.. __target:
82 URI``) are no longer accepted.
83 - Added support for multiple attributions in a physical block quote
84 (indented text block), dividing it into multiple logical block
86 - Added support for unicode bullets in bullet lists: "•", "‣", and
88 - Added support for new object-oriented directive interface,
89 retaining compatibility to the old functional interface.
90 - Added support for throwing ``DirectiveError``'s from within
93 * docutils/parsers/rst/__init__.py:
95 - Added ``Directive`` base class.
96 - Added ``DirectiveError`` base class.
97 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
100 * docutils/parsers/directives/:
102 - Refactored all reStructuredText directives to use the new
103 object-oriented directive interface. Errors are now (mostly)
104 thrown using the new ``DirectiveError`` class.
106 * docutils/parsers/directives/misc.py:
108 - Added ``start-after`` and ``end-before`` options to ``include``
109 directive; thanks to Stefan Rank.
111 * docutils/transforms/universal.py:
113 - Added ``StripClassesAndElements`` transform to remove from the
114 document tree all elements with classes in
115 ``settings.strip_elements_with_classes`` and all "classes"
116 attribute values in ``self.document.settings.strip_classes``.
118 * docutils/transforms/writer_aux.py:
120 - Added ``Admonitions`` transform to transform specific admonitions
121 (like ``note``, ``warning``, etc.) into generic admonitions with a
124 * docutils/writers/html4css1/__init__.py:
126 - Moved template functionality from the PEP/HTML writer here.
127 - Expanded the fragments available in the ``parts`` attribute.
128 - Moved ``id`` attributes from titles to surrounding ``div``
130 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
131 universally supported now).
132 - ``template.txt`` is now opened in text mode instead of binary mode
133 (to ensure Windows compatibility).
134 - ``a`` elements now have an "internal" or "external" class,
135 depending on reference type.
137 * docutils/writers/html4css1/template.txt: Added to project.
139 * docutils/writers/pep_html/:
141 - Moved template functionality to the HTML writer.
143 * docutils/writers/s5_html/__init__.py:
145 - Added ``view_mode`` & ``hidden_controls`` settings
146 (``--view-mode`` & ``--hidden-controls/--visible-controls``
149 * docutils/writers/latex2e/__init__.py:
151 - Add ``--literal-block-env``
152 - Fix: escaping ``%`` in href urls.
153 - Move usepackage hyperref after stylesheet inclusion.
154 - Fix: scrartcl does not have chapter but scrreprt.
155 - Add newline after ``\end{verbatim}``.
156 - Merge smaller differences from latex2e_adaptive_preamble.
157 - Add ``use-part-section``.
158 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
159 - Using leavemode option_list no longer needs to check if parent
160 is a definition list.
161 - Append ``\leavemode`` to definition list terms.
162 - No longer write visit\_/depart_definition_list_item comments to
164 - Table column width with 3 decimal places.
165 - Add table stubs support (boldfont).
166 - Add assemble_parts to writer.
167 - Add simply support for nested tables.
168 - Fix verbatim in tables if use-verbatim-when-possible.
169 - Use section commands down to subparagraph.
170 - Put ensuremath around some latin1 chars.
171 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
172 - New option ``--use-bibtex=style,db1,db2``.
173 - New option ``--reference-label`` to allow usage of LaTeX ref for
174 labels in section references.
175 - Add a label after every section to support sectionnumbers as reference
177 - Fix: bug# 1605376 rst2latex: bad options group list
178 - Remove inactive code for use_optionlist_for_option_list.
179 - Remove latex comments from option_list output.
180 - Fix: bug# 1612270 double qoutes in italian literal.
181 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
182 - Add option --use-latex-abstract.
183 - Image width unit ``px`` is translated to ``pt``.
184 - Add image height support.
185 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
187 - Fix: Do not escape underscores in citation reference labels if
188 use-latex-citations is set.
189 - Use centering instead of center for figure contents, to avoid vertical
191 - Recognize table class: borderless, nolines, booktabs, standard.
192 - Fix: Renaming contents section does not work with latex writer; SF
194 - Applied patch for custom roles with classes from Edward Loper.
195 - Fixed bug that caused crashes with more than 256 lists.
197 * docutils/writers/pep_html/__init__.py:
199 - Changed to support new python.org website structure and
202 * docs/howto/security.txt: "Deploying Docutils Securely", added to
205 * tools/buildhtml.py:
207 -- Added ``ignore`` setting to exclude a list of shell patterns
208 (default: ``.svn:CVS``).
210 * tools/editors/emacs/rst.el:
212 - Changed license to "GPL".
213 - Added ``rst-straighten-decorations`` function.
214 - The ``compile`` module is now always loaded.
215 - Added ``rst-toggle-line-block`` function.
216 - Headings consisting only of non-ASCII characters are now
217 recognized by ``rst-toc`` and ``rst-adjust``.
218 - Added font-lock support for multi-line comments where the first
219 comment line is empty.
220 - Added ``(require 'font-lock)``.
224 - Provide descriptive error message if distutils is missing.
227 Release 0.4 (2006-01-09)
228 ========================
232 - Updated the project policies for trunk/branch development &
235 * docutils/__init__.py:
237 - Added ``__version_details__`` attribute to describe code source
238 (repository/snapshot/release).
239 - Replaced ``default_transforms`` attribute of TransformSpec with
240 ``get_transforms()`` method.
244 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
245 functions, for document tree extraction and reprocessing.
249 - Added ``DocTreeInput`` class, for reprocessing existing documents.
250 - Added support for non-Unicode (e.g. binary) writer output.
254 - Re-introduced ``Targetable.indirect_reference_name``, for
255 MoinMoin/reST compatibility (removed in r3124/r3129).
256 - Added ``serial_escape`` function; escapes string values that are
257 elements of a list, for serialization. Modified Docutils-XML
258 writing (``Element._dom_node``) and pseudo-XML writing
259 (``Element.starttag``) to use ``serial_escape``.
260 - Added ``Node.deepcopy()`` method.
261 - Removed the internal lists ``document.substitution_refs``,
262 ``document.anonymous_refs``, and ``document.anonymous_targets``.
263 - Added a "container" element.
264 - Fixed bug where values of list-valued attributes of elements
265 originating from custom interpreted text roles (i.e., with custom
266 classes) were being shared between element instances. Reported by
269 * docutils/statemachine.py:
271 - Added trailing whitespace stripping to ``string2lines()``.
272 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
273 Asian double-width character support.
277 - Added ``east_asian_column_width()`` for double-width character
280 * docutils/languages/ja.py: Added to project: Japanese mappings by
283 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
284 mappings by Panjunyong.
286 * docutils/parsers/null.py: Added to project; a do-nothing parser.
288 * docutils/parsers/rst/__init__.py:
290 - Added validator to tab_width setting, with test. Closes SF bug
291 #1212515, report from Wu Wei.
293 * docutils/parsers/rst/states.py:
295 - Fixed bug with escaped colons indicating a literal block.
296 - Fixed bug with enumerated lists (SF#1254145).
297 - Backslash-escaped colons inside of field names are now allowed.
298 - Targets (implicit and explicit), anonymous hyperlink references
299 and auto-numbered footnote references inside of substitution
300 definitions are now disallowed.
301 - Fixed bug: list items with blank first lines.
302 - Fixed bug: block quote attributions with indented second lines.
303 - Added East Asian double-width character support (Python 2.4 only).
305 * docutils/parsers/rst/tableparser.py:
307 - Added East Asian double-width character support (Python 2.4 only).
309 * docutils/parsers/rst/directives/body.py:
311 - Added the "container" directive.
313 * docutils/parsers/rst/directives/misc.py:
315 - Added the "default-role", "title", and "date" directives.
316 - Added standard data file syntax to the "include" directive.
317 - Added support for "class" directive content.
319 * docutils/parsers/rst/directives/images.py:
321 - Added ``indirect_reference_name`` support for images with a target
323 - Added support for image width and height units.
324 - Fixed bug with image "target" options.
326 * docutils/parsers/rst/directives/references.py:
328 - Added "class" attribute to "target-notes" directive, for
329 footnote_reference classes.
331 * docutils/parsers/rst/include/: Directory added to project; contains
332 standard data files for the "include" directive. Initial contents:
333 character entity substitution definition sets, and a set of
334 definitions for S5/HTML presentations.
336 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
337 mappings by David Goodger.
339 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
340 Simplified Chinese mappings by Panjunyong.
342 * docutils/readers/__init__.py:
344 - Added universal.Decorations and universal.ExposeInternals
345 transforms as default transforms for all readers.
346 - Added ``ReReader`` base class for readers that reread an existing
349 * docutils/readers/doctree.py: Added to project; a reader for existing
352 * docutils/transforms/frontmatter.py:
354 - Fixed the DocInfo transform to handle SVN-style expansion of the
356 - In ``DocInfo.extract_authors``, treat the contents of "authors"
359 * docutils/transforms/misc.py:
361 - Added misc.Transitions transform, extracted from
362 universal.FinalChecks.
364 * docutils/transforms/references.py:
366 - Added references.DanglingReferences transform, extracted from
367 universal.FinalChecks.
368 - Fixed bug with doubly-indirect substitutions.
369 - Added footnote_reference classes attribute to "TargetNotes".
370 - Fixed bug with circular substitution definitions that put Docutils
371 into an infinite loop.
373 * docutils/transforms/universal.py:
375 - Added universal.ExposeInternals transform, extracted from
376 universal.FinalChecks.
377 - Removed universal.FinalChecks transform (logic has been moved to
378 several new transforms).
379 - Fixed bug with the "expose_internals" setting and Text nodes
380 (exposed by the "rawsource" internal attribute).
381 - Added the universal.StripComments transform, implementation of the
382 "strip_comments" setting.
384 * docutils/transforms/writer_aux.py: Added to project; auxiliary
385 transforms for writers.
387 - Added ``Compound`` transform, which flattens compound paragraphs.
389 * docutils/writers/: Several writer modules (html4css1.py) were
390 converted into packages. Support modules and data files have been
391 moved into the packages. The stylesheets for the HTML writers are
392 now installed along with the code, the code knows where to find
393 them, and the default is to use them (actually, to embed them).
394 Some adjustments to configuration files may be necessary. The
395 easiest way to obtain the new default behavior is to remove all
396 settings whose name includes "stylesheet".
398 * docutils/writers/__init__.py:
400 - Added universal.Messages and universal.FilterMessages transforms
401 as default transforms for all writers.
402 - Added ``UnfilteredWriter`` base class for writers that pass the
403 document tree on unchanged.
405 * docutils/writers/docutils_xml.py:
407 - Made ``xmlcharrefreplace`` the default output encoding error
410 * docutils/writers/html4css1/:
412 - Added support for image width and height units.
413 - Made ``xmlcharrefreplace`` the default output encoding error
415 - Made ``--embed-stylesheet`` the default rather than
416 ``--link-stylesheet``.
417 - Moved "id" attribute from container (section etc.) to title's <a>
418 tag, to be on the same tag as "name".
419 (!!! To be reverted in Docutils 0.5.)
420 - Added vertical space between fields of field lists.
421 - Added ``--compact-field-lists`` option to remove vertical space in
423 - Made cloaking of email addresses with ``--cloak-email-addresses``
425 - Fixed support for centered images.
426 - Added support for class="compact" & class="open" lists.
428 * docutils/writers/latex2e/:
430 - Underscores in citekeys are no longer escaped.
432 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
433 mapping of Unicode characters to LaTeX equivalents.
435 * docutils/writers/s5_html/: Package added to project; writer for
438 * docs/dev/distributing.txt: Added to project; guide for distributors
439 (package maintainers).
441 * docs/dev/hacking.txt: Added to project; guide for developers.
443 * docs/ref/doctree.txt:
445 - Updated for plural attributes "classes", "ids", "names",
447 - Added the "container" element.
449 * docs/ref/docutils.dtd:
451 - Updated for plural attributes "classes", "ids", "names",
454 * docs/user/emacs.txt: Added to project; a document about Emacs
455 support for reStructuredText and Docutils.
457 * docs/user/links.txt: Added to project; lists of Docutils-related
460 * docs/user/mailing-lists.txt: Added to project; information about
461 Docutils-related mailing lists and how to access them.
463 * docs/user/slide-shows.txt: Added to project; example of and docs for
464 the S5/HTML writer (``rst2s5.py`` front end).
466 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
467 Files", added to project.
469 * test/coverage.sh: Added to project; test coverage script.
471 * test/DocutilsTestSupport.py:
473 - Added support for specifying runtime settings at the suite level.
475 * test/test_functional.py:
477 - Added the ``clear_output_directory`` function.
478 - Added support for ``_test_more`` functions in functional test
481 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
483 * tools/rstpep2html.py: Renamed from pep.py.
485 * tools/dev/create_unimap.py: Added to project; script to create the
486 docutils/writers/unimap_latex.py mapping file.
488 * tools/dev/profile_docutils.py: Added to project; profiler script.
490 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
492 * tools/editors/emacs/restructuredtext.el,
493 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
494 Removed from project; the functionality is now contained in rst.el.
496 * tools/editors/emacs/rst.el: Added to project. Added many features
497 and fixed many bugs. See docs/user/emacs.txt for details.
499 * tools/stylesheets: Removed from project. Stylesheets have been
500 renamed and moved into writer packages.
503 Release 0.3.9 (2005-05-26)
504 ==========================
508 - Eliminated and replaced all uses of the old string attributes
509 ``id``, ``name``, ``dupname`` and ``class`` with references to the
510 new list attributes ``ids``, ``names``, ``dupnames`` and
511 ``classes`` throughout the whole source tree.
515 - Enabled ``--dump-*`` options when ``--traceback`` specified,
516 allowing for easier debugging.
517 - In ``Publisher.publish()``, expanded the generic top-level
520 * docutils/examples.py:
522 - Added ``internals`` function for exploration.
526 - Fixed ``Input.decode`` method to apply heuristics only if no
527 encoding is explicitly given, and to provide better reporting of
529 - The ``Input.decode`` method now removes byte order marks (BOMs)
534 - ``image`` element class changed to subclass of Element, not
535 TextElement (it's an empty element, and cannot contain text).
536 - Added ``attr_defaults`` dictionary for default attribute values.
537 - Added empty list as default value for the following attributes:
538 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
539 - Added ``document.decoration`` attribute,
540 ``document.get_decoration`` method, and ``decoration.get_header``
541 & ``.get_footer`` methods.
542 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
547 - Removed ``docutils.utils.Reporter.categories``,
548 ``docutils.utils.ConditionSet``, and all references to them, to
549 simplify error reporting.
551 * docutils/languages/nl.py: Added to project; Dutch mappings by
554 * docutils/parsers/rst/__init__.py:
556 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
558 * docutils/parsers/rst/states.py:
560 - Added check for escaped at-mark to prevent email address recognition.
561 - Fixed option lists to allow spaces inside ``<angle-bracketed option
563 - Allowed whitespace in paths and URLs.
564 - Added auto-enumerated list items.
565 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
567 - Added support for table stub columns.
569 * docutils/parsers/rst/directives/__init__.py:
571 - Allowed whitespace in paths (``path`` function).
572 - Added ``uri`` directive option conversion function.
574 * docutils/parsers/rst/directives/body.py:
576 - Fixed illegal context bug with "topic" directive (allowed within
577 sidebars; not within body elements).
579 * docutils/parsers/rst/directives/images.py:
581 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
582 - Added support for the ``file_insertion_enabled`` setting in the
583 "figure" directive (disables "figwidth" option).
584 - "image" directive: added checks for valid values of "align" option,
585 depending on context. "figure" directive: added specialized
586 "align" option and attribute on "figure" element.
587 - Made ":figwidth: image" option of "figure" directive work again.
588 - Fixed bug with reference names containing uppercase letters
589 (e.g. ``Name_``) in "target" option of "image" directive.
591 * docutils/parsers/rst/directives/misc.py:
593 - Fixed "include" and "raw" directives to catch text decoding
595 - Allowed whitespace in "include" & "raw" directive paths.
596 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
597 settings in "include" & "raw" directives.
599 * docutils/parsers/rst/directives/parts.py:
601 - Added "header" & "footer" directives.
602 - Fixed illegal context bug with "contents" directive (topics
603 allowed within sidebars; not within body elements).
605 * docutils/parsers/rst/directives/tables.py:
607 - Added "list-table" directive.
608 - Caught empty CSV table bug.
609 - Added support for the ``file_insertion_enabled`` setting in the
610 "csv-table" directive.
611 - Added ``stub-columns`` option to "csv-table" and "list-table"
614 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
615 mappings by Martijn Pieters.
617 * docutils/readers/standalone.py:
619 - Added ``--section-subtitles`` and ``--no-section-subtitles``
620 options to activate or deactivate the SectSubTitle transform.
622 * docutils/transforms/frontmatter.py:
624 - Added SectSubTitle transform to promote titles of lone
625 subsections to subtitles.
627 * docutils/transforms/references.py:
629 - Fixed mislocated internal targets bug, by propagating internal
630 targets to the next node, making use of the newly added support
631 for multiple names and IDs.
632 - Fixed duplicate footnote label bug.
633 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
636 * docutils/writers/html4css1.py:
638 - Fixed unencoded stylesheet reference bug (characters like "&" in
639 stylesheet references).
640 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
642 - Added support for multiple IDs per node by creating empty ``span``
644 - Added the ``field_name_limit`` & ``option_limit`` settings &
646 - Added support for table stub columns.
647 - Added support for the ``align`` attribute on ``figure`` elements.
648 - Added the ``cloak_email_addresses`` setting & support.
649 - Added ``html_prolog``, ``html_head``, ``html_body``,
650 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
651 ``docutils.core.publish_parts``.
652 - Added support for section subtitles.
654 * docutils/writers/latex2e.py:
656 - Fixed tables starting with more than one multirow cell.
657 - Improved --use-latex-docinfo so that organization/contact/address
658 fields are lumped with the last author field and appear on the
660 - Made sure the titlepage is always shown with --use-latex-docinfo,
661 even if the document has no title.
662 - Made sure that latex doesn't fill in today's date if no date field
664 - Added support for section subtitles.
666 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
669 * docutils/writers/null.py: Added to project; a do-nothing Writer.
671 * docs/api/publisher.txt:
673 - Added "``publish_parts`` Details" section.
675 * docutils/dev/repository.txt: Added to project; information about the
676 Docutils Subversion repository.
678 * docs/ref/docutils.dtd:
680 - Added a ``stub`` attribute to the ``colspec`` element via the
681 ``tbl.colspec.att`` parameter entity.
682 - Allowed topic elements within sidebars
683 - Added an ``align`` attribute to the ``figure`` element.
685 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
689 Release 0.3.7 (2004-12-24)
690 ==========================
692 * docutils/frontend.py:
694 - Added options: --input-encoding-error-handler,
695 --record-dependencies, --leave-footnote-reference-space,
697 - Added command-line and config file support for "overrides" setting
702 - Added support for input encoding error handler.
706 - Added dispatch_visit and dispatch_departure methods to
707 NodeVisitor; useful as a hook for Visitors.
708 - Changed structure of ``line_block``; added ``line``.
709 - Added ``compound`` node class.
710 - Added a mechanism for Visitors to transitionally ignore new node
715 - Moved ``escape2null`` and ``unescape`` functions from
716 docutils/parsers/rst/states.py.
718 * docutils/parsers/rst/roles.py:
721 - Changed role function API: the "text" parameter now takes
722 null-escaped interpreted text content.
724 * docutils/parsers/rst/states.py:
726 - Fixed bug where a "role" directive in a nested parse would crash
727 the parser; the state machine's "language" attribute was not being
729 - Added support for line block syntax.
730 - Fixed directive parsing bug: argument-less directives didn't
731 notice that arguments were present.
732 - Removed error checking for transitions.
733 - Added support for multiple classifiers in definition list items.
734 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
735 - Changed role function API: the "text" parameter now takes
736 null-escaped interpreted text content.
737 - Empty sections and documents are allowed now.
739 * docutils/parsers/rst/directives/__init__.py:
741 - Added ``encoding`` directive option conversion function.
742 - Allow multiple class names in class_option conversion function.
744 * docutils/parsers/rst/directives/body.py:
746 - Converted the line-block directive to use the new structure.
747 - Extracted the old line-block functionality to the ``block``
748 function (still used).
749 - Added ``compound`` directive (thanks to Lea Wiemann).
751 * docutils/parsers/rst/directives/misc.py:
753 - Added "encoding" option to "include" and "raw" directives.
754 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
755 - Allow multiple class names in the "class" directive.
757 * docutils/parsers/rst/directives/parts.py:
759 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
760 options. Thanks to Lele Gaifax.
762 * docutils/parsers/rst/directives/tables.py:
764 - Added "encoding" directive to "csv-table" directive.
765 - Added workaround for lack of Unicode support in csv.py, for
768 * docutils/transforms/misc.py:
770 - Fixed bug when multiple "class" directives are applied to a single
772 - Enabled multiple format names for "raw" directive.
774 * docutils/transforms/references.py:
776 - Added support for trimming whitespace from beside substitution
779 * docutils/transforms/universal.py:
781 - FinalChecks now checks for illegal transitions and moves
782 transitions between sections.
784 * docutils/writers/html4css1.py:
786 - HTMLTranslator.encode now converts U+00A0 to " ".
787 - "stylesheet" and "stylesheet_path" settings are now mutually
789 - Added support for the new line_block/line structure.
790 - --footnote-references now overrides
791 --trim-footnote-reference-space, if applicable.
792 - Added support for ``compound`` elements.
793 - Enabled multiple format names for "raw" directive.
794 - ``<p>`` tags of a paragraph which is the only visible child of the
795 document node are no longer stripped.
796 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
797 new method ``should_be_compact_paragraph()``.
798 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
800 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
801 the output if they have their ``class`` attribute set.
802 - The whole document is now surrounded by a ``<div
803 class="document">`` element.
804 - Body-level images are now wrapped by their own ``<div>`` elements,
805 with image classes copied to the wrapper, and for images which
806 have the ``:align:`` option set, the surrounding ``<div>`` now
807 receives a class attribute (like ``class="align-left"``).
809 * docutils/writers/latex2e.py:
811 - no newline after depart_term.
812 - Added translations for some Unicode quotes.
813 - Added option "font-encoding", made package AE the default.
814 - "stylesheet" and "stylesheet_path" settings are now mutually
816 - --footnote-references now overrides
817 --trim-footnote-reference-space, if applicable.
818 - The footnote label style now matches the footnote reference style
819 ("brackets" or "superscript").
820 - Added support for ``compound`` elements.
821 - Enabled multiple format names for "raw" directive.
823 * docs/ref/docutils.dtd:
825 - Changed structure of the ``line_block`` element; added ``line``.
826 - Added ``compound`` element.
827 - Added "ltrim" and "rtrim" attributes to
828 ``substitution_definition`` element.
829 - Enabled multiple format names for ``raw`` element.
830 - Enabled multiple classifiers in ``definition_list_item`` elements.
832 * docs/ref/rst/directives.txt
834 - Marked "line-block" as deprecated.
835 - "Class" directive now allows multiple class names.
836 - Added "Rationale for Class Attribute Value Conversion".
837 - Added warning about "raw" overuse/abuse.
839 * docs/ref/rst/restructuredtext.txt:
841 - Added syntax for line blocks.
842 - Definition list items may have multiple classifiers.
844 * docs/ref/rst/roles.txt:
848 * tools/stylesheets/default.css:
850 - Added support for the new line_block structure.
851 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
854 Release 0.3.5 (2004-07-29)
855 ==========================
859 * _`Documentation cleanup/reorganization`.
861 - Created new subdirectories of docs/:
863 * ``docs/user/``: introductory/tutorial material for end-users
864 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
865 * ``docs/api/``: API reference material for client-developers
866 * ``docs/ref/``: reference material for all groups
867 * ``docs/howto/``: for component-developers and core-developers
868 * ``docs/peps/``: Python Enhancement Proposals
870 - Moved ``docs/*`` to ``docs/user/``.
871 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
872 ``spec/`` to ``docs/dev``.
873 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
874 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
875 - Moved ``alternatives.txt``, and ``problems.txt`` from
876 ``spec/rst/`` to ``docs/dev/rst/``.
877 - Moved ``reStructuredText.txt``, ``directives.txt``,
878 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
879 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
880 ``roles.txt``, ``reStructuredText.txt`` to
881 ``restructuredtext.txt``.
882 - Moved ``spec/howto/`` to ``docs/howto``.
884 In order to keep the CVS history of moved files, we supplied
885 SourceForge with a `script for modifying the Docutils CVS
888 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
890 After running the cleanup script:
892 - Added ``docs/index.txt``.
893 - Added a ``.htaccess`` file to the ``web`` module, containing
894 redirects for all old paths to new paths. They'll preserve
895 fragments (the "#name" part of a URL), and won't clutter up the
896 file system, and will correct the URL in the user's browser.
897 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
898 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
899 the "To Do" list itself in ``docs/dev/todo.txt``.
900 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
901 section of ``docs/dev/todo.txt``.
902 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
903 - Added "How To Report Bugs" to ``BUGS.txt``.
904 - Went through all the sources and docs (including under web/) and
905 updated links. Mostly done by Lea Wiemann; thanks Lea!
906 (Still need to update links in the sandboxes.)
910 * BUGS.txt: Added to project.
912 * THANKS.txt: Added to project.
914 * docutils/__init__.py:
916 - 0.3.4: Post-release.
920 - Added special error handling & advice for UnicodeEncodeError.
921 - Refactored Publisher.publish (simplified exception handling &
922 extracted debug dumps).
923 - Renamed "enable_exit" parameter of convenience functions to
924 "enable_exit_status".
925 - Enabled traceback (exception propagation) by default in
926 programmatic convenience functions.
927 - Now publish_file and publish_cmdline convenience functions return
928 the encoded string results in addition to their regular I/O.
929 - Extracted common code from publish_file, publish_string, and
930 publish_parts, into new publish_programmatically. Extracted
931 settings code to ``Publisher.process_programmatic_settings``.
932 - In Publisher.publish, disabled ``settings_overrides`` when
933 ``settings`` is supplied; redundant.
935 * docutils/frontend.py:
937 - Added help text for "--output-encoding-error-handler" and
938 "--error-encoding-error-handler".
939 - Renamed "--exit" to "--exit-status".
940 - Simplified default-setting code.
942 * docutils/parsers/rst/__init__.py:
944 - Added "--pep-base-url" and "--rfc-base-url" options.
946 * docutils/parsers/rst/states.py:
948 - Made URI recognition more aggressive and intelligent.
950 * docutils/parsers/rst/directives/__init__.py:
952 - Added several directive option conversion functions.
954 * docutils/parsers/rst/directives/body.py:
956 - Moved "table" directive to tables.py.
958 * docutils/parsers/rst/directives/tables.py: Table-related directives,
961 * docutils/writers/latex2e.py:
963 - Added "--table-style=(standard|booktabs|nolines)"
964 - figures get "here" option (LaTeX per default puts them at bottom),
965 and figure content is centered.
966 - Rowspan support for tables.
967 - Fix: admonition titles before first section.
968 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
969 - Replave ``_`` in literal by an underlined blank, because it has the correct
971 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
972 - A few unicode replacements, if output_encoding != utf
973 - Add "--graphicx-option".
974 - Indent literal-blocks.
975 - Fix: omit ``\maketitle`` when there is no document title.
977 * docs/index.txt: "Docutils Project Documentation Overview", added to
980 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
981 Tool", added to project.
983 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
985 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
987 * docs/dev/policies.txt: Added to project (extracted from
988 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
990 * docs/dev/release.txt: Added to project (extracted from
991 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
993 * docs/dev/testing.txt: Added to project.
995 * docs/dev/website.txt: Added to project (extracted from
996 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
998 * docs/ref/rst/directives.txt:
1000 - Added directives: "table", "csv-table".
1002 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1003 added to project. 1 page for syntax, and a 1 page reference for
1004 directives and roles. Source text to be used as-is; not meant to be
1007 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1008 with a change of title.
1010 * test/functional/, contents, and test/test_functional.py: Added to
1013 * tools/buildhtml.py: Fixed bug with config file handling.
1015 * tools/html.py: Removed from project (duplicate of rst2html.py).
1017 * tools/pep2html.py: Removed from project (duplicate of Python's
1018 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1019 Docutils-related PEPs in docs/peps/).
1021 * tools/rst2pseudoxml.py: Renamed from publish.py.
1023 * tools/rst2xml.py: Renamed from docutils-xml.py.
1025 * tools/test.txt: Removed from project; moved to
1026 docs/user/rst/demo.txt.
1028 * setup.py: Now also installs ``rst2latex.py``.
1031 Release 0.3.3 (2004-05-09)
1032 ==========================
1034 * docutils/__init__.py:
1036 - 0.3.1: Reorganized config file format (multiple sections); see
1038 - Added unknown_reference_resolvers attribute to TransformSpec.
1039 - 0.3.2: Interpreted text reorganization.
1044 - Catch system messages to stop tracebacks from parsing errors.
1045 - Catch exceptions during processing report & exit without
1046 tracebacks, except when "--traceback" used.
1047 - Reordered components for OptionParser; application comes last.
1048 - Added "config_section" parameter to several methods and functions,
1049 allowing front ends to easily specify their config file sections.
1050 - Added publish_parts convenience function to allow access to individual
1051 parts of a document.
1053 * docutils/examples.py: Added to project; practical examples of
1054 Docutils client code, to be used as-is or as models for variations.
1056 * docutils/frontend.py:
1058 - Added "--traceback" & "--no-traceback" options ("traceback"
1060 - Implemented support for config file reorganization:
1061 ``standard_config_files`` moved from ``ConfigParser`` to
1062 ``OptionParser``; added
1063 ``OptionParser.get_config_file_settings()`` and
1064 ``.get_standard_config_settings()``; support for old "[options]"
1065 section (with deprecation warning) and mapping from old to new
1067 - Reimplemented setting validation.
1068 - Enabled flexible boolean values: yes/no, true/false, on/off.
1069 - Added ``Values``, a subclass of ``optparse.Values``, with support
1070 for list setting attributes.
1071 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1072 thanks to Beni Cherniavsky.
1073 - Added "--no-section-numbering" option.
1077 - Catch IOErrors when opening source & destination files, report &
1078 exit without tracebacks. Added ``handle_io_errors`` parameter to
1079 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1081 * docutils/nodes.py:
1083 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1084 method definitions (via ``exec``) to dynamic assignments (via
1085 ``setattr``); thanks to Roman Suzi.
1086 - Encapsulated visitor dynamic assignments in a function; thanks to
1088 - Added indirect_reference_name attribute to the Targetable
1089 class. This attribute holds the whitespace_normalized_name
1090 (contains mixed case) of a target.
1092 * docutils/statemachine.py:
1094 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1095 - Added ``StringList.get_2D_block``.
1097 * docutils/utils.py:
1099 - Added "level" attribute to SystemMessage exceptions.
1101 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1104 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1107 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1108 Marcelo Huerta San Martin.
1110 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1111 mappings by Lalo Martins.
1113 * docutils/languages/ru.py: Added to project; Russian mappings by
1116 * docutils/parsers/rst/roles.py: Added to project. Contains
1117 interpreted text role functions, a registry for interpreted text
1118 roles, and an API for adding to and retrieving from the registry.
1119 Contributed by Edward Loper.
1121 * docutils/parsers/rst/states.py:
1123 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1124 - Allowed true em-dash character and "---" as block quote
1126 - Added support for <angle-bracketed> complex option arguments
1128 - Fixed handling of backslashes in substitution definitions.
1129 - Fixed off-by-1 error with extra whitespace after substitution
1130 definition directive.
1131 - Added inline markup parsing to field lists' field names.
1132 - Added support for quoted (and unindented) literal blocks.
1133 Driven in part by a bribe from Frank Siebenlist (thanks!).
1134 - Parser now handles escapes in URIs correctly.
1135 - Made embedded-URIs' reference text omittable. Idea from Beni
1137 - Refactored explicit target processing code.
1138 - Added name attribute to references containing the reference name only
1139 through whitespace_normalize_name (no case changes).
1140 - parse_target no longer returns the refname after going through
1141 normalize_name. This is now handled in make_target.
1142 - Fixed bug relating to role-less interpreted text in non-English
1144 - Reorganized interpreted text processing; moved code into the new
1145 roles.py module. Contributed by Edward Loper.
1146 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1147 ``parse_directive_block``.
1149 * docutils/parsers/rst/tableparser.py:
1151 - Reworked for ``StringList``, to support "include" directives in
1154 * docutils/parsers/rst/directives/__init__.py:
1156 - Renamed ``unchanged()`` directive option conversion function to
1157 ``unchanged_required``, and added a new ``unchanged``.
1158 - Catch unicode value too high error; fixes bug 781766.
1159 - Beefed up directive error reporting.
1161 * docutils/parsers/rst/directives/body.py:
1163 - Added basic "table" directive.
1165 * docutils/parsers/rst/directives/images.py:
1167 - Added "target" option to "image" directive.
1168 - Added name attribute to references containing the reference name only
1169 through whitespace_normalize_name (no case changes).
1171 * docutils/parsers/rst/directives/misc.py:
1173 - Isolated the import of the ``urllib2`` module; was causing
1174 problems on SourceForge (``libssl.so.2`` unavailable?).
1175 - Added the "role" directive for declaring custom interpreted text
1178 * docutils/parsers/rst/directives/parts.py:
1180 - The "contents" directive does more work up-front, creating the
1181 "topic" and "title", and leaving the "pending" node for the
1182 transform. Allows earlier reference resolution; fixes subtle bug.
1184 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1185 mappings by Jannie Hofmeyr.
1187 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1188 mappings by Marek Blaha.
1190 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1191 mappings by Marcelo Huerta San Martin.
1193 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1194 Portuguese mappings by Lalo Martins.
1196 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1197 mappings by Roman Suzi.
1199 * docutils/transforms/parts.py:
1201 - The "contents" directive does more work up-front, creating the
1202 "topic" and "title", and leaving the "pending" node for the
1203 transform. Allows earlier reference resolution; fixes subtle bug.
1204 - Added support for disabling of section numbering.
1206 * docutils/transforms/references.py:
1208 - Verifying that external targets are truly targets and not indirect
1209 references. This is because we are now adding a "name" attribute to
1210 references in addition to targets. Note sure if this is correct!
1211 - Added code to hook into the unknown_reference_resolvers list for a
1212 transformer in resolve_indirect_target. This allows the
1213 unknown_reference_resolvers to keep around indirect targets which
1214 docutils doesn't know about.
1215 - Added specific error message for duplicate targets.
1217 * docutils/transforms/universal.py:
1219 - Added FilterMessages transform (removes system messages below the
1220 verbosity threshold).
1221 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1222 to FinalCheckVisitor for application-specific handling of
1223 unresolvable references.
1224 - Added specific error message for duplicate targets.
1226 * docutils/writers/__init__.py:
1228 - Added assemble_parts method to the Writer class to allow for
1229 access to a documents individual parts.
1230 - Documented & set default for ``Writer.output`` attribute.
1232 * docutils/writers/html4css1.py:
1234 - Fixed unicode handling of attribute values (bug 760673).
1235 - Prevent duplication of "class" attribute values (bug report from
1237 - Improved table grid/border handling (prompted by report from Bob
1239 - Added support for table titles.
1240 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1242 - Added functionality to keep track of individual parts of a document
1243 and store them in a dictionary as the "parts" attribute of the writer.
1244 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1245 - Added proper support for the "scale" attribute of the "image"
1246 element. Contributed by Brent Cook.
1247 - Added ``--initial-header-level`` option.
1248 - Fixed bug: the body_pre_docinfo segment depended on there being a
1249 docinfo; if no docinfo, the document title was incorporated into
1250 the body segment. Adversely affected the publish_parts interface.
1252 * docutils/writers/latex2e.py:
1254 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1255 about a missing file.
1256 - Added options and support: ``--compound-enumerators``,
1257 ``--section-prefix-for-enumerators``, and
1258 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1260 - Added option ``--use-verbatim-when-possible``, to avoid
1261 problematic characters (eg, '~' in italian) in literal blocks.
1262 - It's now possible to use four section levels in the `book` and
1263 `report` LaTeX classes. The default `article` class still has
1266 * docs/config.txt: "Docutils Configuration Files", added to project.
1267 Moved config file entry descriptions from tools.txt.
1271 - Moved config file entry descriptions to config.txt.
1273 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1276 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1277 Text Roles", added to project.
1279 * spec/rst/reStructuredText.txt:
1281 - Added description of support for <angle-bracketed> complex option
1282 arguments to option lists.
1283 - Added subsections for indented and quoted literal blocks.
1285 * test: Continually adding & updating tests.
1287 - Added test/test_settings.py & test/data/config_*.txt support
1289 - Added test/test_writers/test_htmlfragment.py.
1291 * test/DocutilsTestSupport.py:
1293 - Refactored LaTeX publisher test suite/case class names to make
1294 testing other writers easier.
1295 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1296 to test the processing of HTML fragments which use the new
1297 publish_parts convenience function.
1299 * tools/buildhtml.py:
1301 - Added support for the "--prune" option.
1302 - Removed dependency on pep2html.py; plaintext PEPs no longer
1305 * tools/docutils.conf:
1307 - Updated for configuration file reorganization.
1309 * tools/rst2html.py:
1311 - copied from tools/html.py
1315 - added a 'scripts' section to configuration
1316 - added 'tools/rst2html.py' to the scripts section
1319 Release 0.3 (2003-06-24)
1320 ========================
1324 * Renamed "attribute" to "option" for directives/extensions.
1326 * Renamed transform method "transform" to "apply".
1328 * Renamed "options" to "settings" for runtime settings (as set by
1329 command-line options). Sometimes "option" (singular) became
1330 "settings" (plural). Some variations below:
1332 - document.options -> document.settings (stored in other objects as
1334 - option_spec -> settings_spec (not directives though)
1335 - OptionSpec -> SettingsSpec
1336 - cmdline_options -> settings_spec
1337 - relative_path_options -> relative_path_settings
1338 - option_default_overrides -> settings_default_overrides
1339 - Publisher.set_options -> Publisher.get_settings
1343 * COPYING.txt: Added "Public Domain Dedication".
1345 * FAQ.txt: Frequently asked questions, added to project.
1349 - Updated with PyPI Trove classifiers.
1350 - Conditional installation of third-party modules.
1352 * docutils/__init__.py:
1354 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1355 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1356 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1357 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1358 option and its effect on the PEP template & writer.
1359 - Bumped version to 0.2.4 due to changes to the PEP template &
1361 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1362 - Added ``TransformSpec`` class for new transform system.
1363 - Bumped version to 0.2.6 for API changes (renaming).
1364 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1365 convenience functions.
1366 - Added ``Component.component_type`` attribute.
1367 - Bumped version to 0.2.8 because of the internal parser switch from
1368 plain lists to the docutils.statemachine.StringList objects.
1369 - Bumped version to 0.2.9 because of the frontend.py API changes.
1370 - Bumped version to 0.2.10 due to changes to the project layout
1371 (third-party modules removed from the "docutils" package), and
1372 signature changes in ``io.Input``/``io.Output``.
1373 - Changed version to 0.3.0 for release.
1377 - Made ``publish()`` a bit more convenient.
1378 - Generalized ``Publisher.set_io``.
1379 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1380 parameters; improved its docstring.
1381 - Added ``publish_file()`` and ``publish_string()``.
1382 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1384 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1385 "--dump-transforms" hidden options.
1386 - Added ``Publisher.apply_transforms()`` method.
1387 - Added ``Publisher.set_components()`` method; support for
1388 ``publish_*()`` conveninece functions.
1389 - Moved config file processing to docutils/frontend.py.
1390 - Added support for exit status ("exit_level" setting &
1391 ``enable_exit`` parameter for Publisher.publish() and convenience
1394 * docutils/frontend.py:
1396 - Check for & exit on identical source & destination paths.
1397 - Fixed bug with absolute paths & "--config".
1398 - Set non-command-line defaults in ``OptionParser.__init__()``:
1399 ``_source`` & ``_destination``.
1400 - Distributed ``relative_path_settings`` to components; updated
1401 ``OptionParser.populate_from_components()`` to combine it all.
1402 - Require list of keys in ``make_paths_absolute`` (was implicit in
1403 global ``relative_path_settings``).
1404 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1405 "--dump-settings", and "--dump-transforms" hidden options.
1406 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1407 code, replaced with correct code.
1408 - Added validation functionality for config files.
1409 - Added "--error-encoding" option/setting, "_disable_config"
1411 - Added encoding validation; updated "--input-encoding" and
1412 "--output-encoding"; added "--error-encoding-error-handler" and
1413 "--output-encoding-error-handler".
1414 - Moved config file processing from docutils/core.py.
1415 - Updated ``OptionParser.populate_from_components`` to handle new
1416 ``SettingsSpec.settings_defaults`` dict.
1417 - Added support for "-" => stdin/stdout.
1418 - Added "exit_level" setting ("--exit" option).
1422 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1423 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1424 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1425 - ``FileOutput.write()`` now returns the encoded output string.
1426 - Try to get path/stream name automatically in ``FileInput`` &
1428 - Added defaults for source & destination paths.
1429 - Allow for Unicode I/O with an explicit "unicode" encoding.
1430 - Added ``Output.encode()``.
1431 - Removed dependency on runtime settings; pass encoding directly.
1432 - Recognize Unicode strings in ``Input.decode()``.
1433 - Added support for output encoding error handlers.
1435 * docutils/nodes.py:
1437 - Added "Invisible" element category class.
1438 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1439 modification during a traversal.
1440 - Added element classes: ``line_block``, ``generated``, ``address``,
1441 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1442 ``superscript``, ``subscript``, ``inline``
1443 - Added support for lists of nodes to ``Element.insert()``.
1444 - Fixed parent linking in ``Element.replace()``.
1445 - Added new abstract superclass ``FixedTextElement``; adds
1446 "xml:space" attribute.
1447 - Added support for "line" attribute of ``system_message`` nodes.
1448 - Added support for the observer pattern from ``utils.Reporter``.
1449 Added ``parse_messages`` and ``transform_messages`` attributes to
1450 ``document``, removed ``messages``. Added ``note_parse_message``
1451 and ``note_transform_message`` methods.
1452 - Added support for improved diagnostics:
1454 - Added "document", "source", and "line" internal attributes to
1455 ``Node``, set by ``Node.setup_child()``.
1456 - Converted variations on ``node.parent = self`` to
1457 ``self.setup_child(node)``.
1458 - Added ``document.current_source`` & ``.current_line``
1459 attributes, and ``.note_source`` observer method.
1460 - Changed "system_message" output to GNU-Tools format.
1462 - Added a "rawsource" attribute to the ``Text`` class, for text
1463 before backslash-escape resolution.
1464 - Support for new transform system.
1465 - Reworked ``pending`` element.
1466 - Fixed XML DOM bug (SF #660611).
1467 - Removed the ``interpeted`` element class and added
1468 ``title_reference``, ``abbreviation``, ``acronym``.
1469 - Made substitutions case-sensitive-but-forgiving; moved some code
1471 - Fixed Unicode bug on element attributes (report: William Dode).
1473 * docutils/optik.py: Removed from project; replaced with
1474 extras/optparse.py and extras/textwrap.py. These will be installed
1475 only if they're not already present in the Python installation.
1477 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1478 only if it's not already present in the Python installation.
1480 * docutils/statemachine.py:
1482 - Factored out ``State.add_initial_transitions()`` so it can be
1484 - Converted whitespace-specific "blank" and "indent" transitions
1485 from special-case code to ordinary transitions: removed
1486 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1487 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1488 ``ws_initial_transitions`` attributes.
1489 - Removed ``State.match_transition()`` after merging it into
1491 - Added ``StateCorrection`` exception.
1492 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1493 (moved ``TransitionCorrection`` support there too.)
1494 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1495 ``EOFError`` instead of ``IndexError``.
1496 - Added ``State.no_match`` method.
1497 - Added support for the Observer pattern, triggered by input line
1499 - Added ``strip_top`` parameter to
1500 ``StateMachineWS.get_first_known_indented``.
1501 - Made ``context`` a parameter to ``StateMachine.run()``.
1502 - Added ``ViewList`` & ``StringList`` classes;
1503 ``extract_indented()`` becomes ``StringList.get_indented()``.
1504 - Added ``StateMachine.insert_input()``.
1505 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1506 thanks to) Fred Drake.
1508 * docutils/utils.py:
1510 - Added a ``source`` attribute to Reporter instances and
1511 ``system_message`` elements.
1512 - Added an observer pattern to ``utils.Reporter`` to keep track of
1514 - Fixed bugs in ``relative_path()``.
1515 - Added support for improved diagnostics.
1516 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1517 - Added support for encoding Reporter stderr output, and encoding
1519 - Reporter keeps track of the highest level system message yet
1522 * docutils/languages: Fixed bibliographic field language lookups.
1524 * docutils/languages/es.py: Added to project; Spanish mappings by
1525 Marcelo Huerta San Martin.
1527 * docutils/languages/fr.py: Added to project; French mappings by
1530 * docutils/languages/it.py: Added to project; Italian mappings by
1533 * docutils/languages/sk.py: Added to project; Slovak mappings by
1536 * docutils/parser/__init__.py:
1538 - Added ``Parser.finish_parse()`` method.
1540 * docutils/parser/rst/__init__.py:
1542 - Added options: "--pep-references", "--rfc-references",
1543 "--tab-width", "--trim-footnote-reference-space".
1545 * docutils/parsers/rst/states.py:
1547 - Changed "title under/overline too short" system messages from INFO
1548 to WARNING, and fixed its insertion location.
1549 - Fixed enumerated list item parsing to allow paragraphs & section
1550 titles to begin with enumerators.
1551 - Converted system messages to use the new "line" attribute.
1552 - Fixed a substitution reference edge case.
1553 - Added support for "--pep-references" and "--rfc-references"
1554 options; reworked ``Inliner`` code to make customization easier.
1555 - Removed field argument parsing.
1556 - Added support for short section title over/underlines.
1557 - Fixed "simple reference name" regexp to ignore text like
1558 "object.__method__"; not an anonymous reference.
1559 - Added support for improved diagnostics.
1560 - Reworked directive API, based on Dethe Elza's contribution. Added
1561 ``Body.parse_directive()``, ``.parse_directive_options()``,
1562 ``.parse_directive_arguments()`` methods.
1563 - Added ``ExtensionOptions`` class, to parse directive options
1564 without parsing field bodies. Factored
1565 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1566 ``ExtensionOptions``.
1567 - Improved definition list term/classifier parsing.
1568 - Added warnings for unknown directives.
1569 - Renamed ``Stuff`` to ``Struct``.
1570 - Now flagged as errors: transitions at the beginning or end of
1571 sections, empty sections (except title), and empty documents.
1572 - Updated for ``statemachine.StringList``.
1573 - Enabled recognition of schemeless email addresses in targets.
1574 - Added support for embedded URIs in hyperlink references.
1575 - Added backslash-escapes to inline markup end-string suffix.
1576 - Added support for correct interpreted text processing.
1577 - Fixed nested title parsing (topic, sidebar directives).
1578 - Added special processing of backslash-escaped whitespace (idea
1579 from David Abrahams).
1580 - Made substitutions case-sensitive-but-forgiving; moved some code
1581 to ``docutils.nodes``.
1582 - Added support for block quote attributions.
1583 - Added a kludge to work-around a conflict between the bubble-up
1584 parser strategy and short titles (<= 3 char-long over- &
1585 underlines). Fixes SF bug #738803 "infinite loop with multiple
1586 titles" submitted by Jason Diamond.
1587 - Added explicit interpreted text roles for standard inline markup:
1588 "emphasis", "strong", "literal".
1589 - Implemented "superscript" and "subscript" interpreted text roles.
1590 - Added initial support for "abbreviation" and "acronym" roles;
1592 - Added support for "--trim-footnote-reference-space" option.
1593 - Optional space before colons in directives & hyperlink targets.
1595 * docutils/parsers/rst/tableparser.py:
1597 - Fixed a bug that was producing unwanted empty rows in "simple"
1599 - Detect bad column spans in "simple" tables.
1601 * docutils/parsers/rst/directives: Updated all directive functions to
1604 * docutils/parsers/rst/directives/__init__.py:
1606 - Added ``flag()``, ``unchanged()``, ``path()``,
1607 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1608 directive option helper functions.
1609 - Added warnings for unknown directives.
1610 - Return ``None`` for missing directives.
1611 - Added ``register_directive()``, thanks to William Dode and Paul
1614 * docutils/parsers/rst/directives/admonitions.py:
1616 - Added "admonition" directive.
1618 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1619 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1620 "parsed-literal", "rubric", "epigraph", "highlights" and
1621 "pull-quote" directives.
1623 * docutils/parsers/rst/directives/images.py:
1625 - Added an "align" attribute to the "image" & "figure" directives
1626 (by Adam Chodorowski).
1627 - Added "class" option to "image", and "figclass" to "figure".
1629 * docutils/parsers/rst/directives/misc.py:
1631 - Added "include", "raw", and "replace" directives, courtesy of
1633 - Added "unicode" and "class" directives.
1635 * docutils/parsers/rst/directives/parts.py:
1637 - Added the "sectnum" directive; by Dmitry Jemerov.
1638 - Added "class" option to "contents" directive.
1640 * docutils/parsers/rst/directives/references.py: Added to project.
1641 Contains the "target-notes" directive.
1643 * docutils/parsers/rst/languages/__init__.py:
1645 - Return ``None`` from get_language() for missing language modules.
1647 * docutils/parsers/rst/languages/de.py: Added to project; German
1648 mappings by Engelbert Gruber.
1650 * docutils/parsers/rst/languages/en.py:
1652 - Added interpreted text roles mapping.
1654 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1655 mappings by Marcelo Huerta San Martin.
1657 * docutils/parsers/rst/languages/fr.py: Added to project; French
1658 mappings by William Dode.
1660 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1661 mappings by Nicola Larosa.
1663 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1664 mappings by Miroslav Vasko.
1666 * docutils/readers/__init__.py:
1668 - Added support for the observer pattern from ``utils.Reporter``, in
1669 ``Reader.parse`` and ``Reader.transform``.
1670 - Removed ``Reader.transform()`` method.
1671 - Added default parameter values to ``Reader.__init__()`` to make
1672 instantiation easier.
1673 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1675 * docutils/readers/pep.py:
1677 - Added the ``peps.TargetNotes`` transform to the Reader.
1678 - Removed PEP & RFC reference detection code; moved to
1679 parsers/rst/states.py as options (enabled here by default).
1680 - Added support for pre-acceptance PEPs (no PEP number yet).
1681 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1684 * docutils/readers/python: Python Source Reader subpackage added to
1685 project, including preliminary versions of:
1688 - moduleparser.py: Parser for Python modules.
1690 * docutils/transforms/__init__.py:
1692 - Added ``Transformer`` class and completed transform reform.
1693 - Added unknown_reference_resolvers list for each transformer. This list holds
1694 the list of functions provided by each component of the transformer that
1695 help resolve references.
1697 * docutils/transforms/frontmatter.py:
1699 - Improved support for generic fields.
1700 - Fixed bibliographic field language lookups.
1702 * docutils/transforms/misc.py: Added to project. Miscellaneous
1705 * docutils/transforms/parts.py:
1707 - Moved the "id" attribute from TOC list items to the references
1708 (``Contents.build_contents()``).
1709 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1710 - Added "class" attribute support to ``Contents``.
1712 * docutils/transforms/peps.py:
1714 - Added ``mask_email()`` function, updating to pep2html.py's
1716 - Linked "Content-Type: text/x-rst" to PEP 12.
1717 - Added the ``TargetNotes`` PEP-specific transform.
1718 - Added ``TargetNotes.cleanup_callback``.
1719 - Added title check to ``Headers``.
1721 * docutils/transforms/references.py:
1723 - Added the ``TargetNotes`` generic transform.
1724 - Split ``Hyperlinks`` into multiple transforms.
1725 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1726 - Added check for circular indirect references.
1727 - Made substitutions case-sensitive-but-forgiving.
1729 * docutils/transforms/universal.py:
1731 - Added support for the "--expose-internal-attributes" option.
1732 - Removed ``Pending`` transform classes & data.
1734 * docutils/writers/__init__.py:
1736 - Removed ``Writer.transform()`` method.
1738 * docutils/writers/docutils-xml.py:
1740 - Added XML and doctype declarations.
1741 - Added "--no-doctype" and "--no-xml-declaration" options.
1743 * docutils/writers/html4css1.py:
1745 - "name" attributes only on these tags: a, applet, form, frame,
1747 - Added "name" attribute to <a> in section titles for Netscape 4
1748 support (bug report: Pearu Peterson).
1749 - Fixed targets (names) on footnote, citation, topic title,
1750 problematic, and system_message nodes (for Netscape 4).
1751 - Changed field names from "<td>" to "<th>".
1752 - Added "@" to "@" encoding to thwart address harvesters.
1753 - Improved the vertical whitespace optimization; ignore "invisible"
1754 nodes (targets, comments, etc.).
1755 - Improved inline literals with ``<span class="pre">`` around chunks
1756 of text and `` `` for runs of spaces.
1757 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1758 ``self.docinfo`` segments.
1759 - Added support for "line_block", "address" elements.
1760 - Improved backlinks (footnotes & system_messages).
1761 - Improved system_message output.
1762 - Redefined "--stylesheet" as containing an invariant URL, used
1763 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1765 - Added "--footnote-references" option (superscript or brackets).
1766 - Added "--compact-lists" and "--no-compact-lists" options.
1767 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1768 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1769 - Improved field list rendering.
1770 - Added Docutils version to "generator" meta tag.
1771 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1772 - Improved layout of <pre> HTML source.
1773 - Fixed attribute typo on <colspec>.
1774 - Refined XML prologue.
1775 - Support for no stylesheet.
1776 - Removed "interpreted" element support.
1777 - Added support for "title_reference", "sidebar", "attribution",
1778 "rubric", and generic "admonition" elements.
1779 - Added "--attribution" option.
1780 - Added support for "inline", "subscript", "superscript" elements.
1781 - Added initial support for "abbreviation" and "acronym";
1784 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1788 - Double quotes in literal blocks (special treatment for de/ngerman).
1789 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1790 - Added "--attribution" option.
1791 - Right align attributions.
1793 * docutils/writers/pep_html.py:
1795 - Parameterized output encoding in PEP template.
1796 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1797 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1798 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1800 - Added an override on the "--footnote-references" option.
1801 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1802 - Added Docutils version to "generator" meta tag.
1803 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1807 - Added a "silent" setting for ``buildhtml.py``.
1808 - Added a "Getting Help" section.
1809 - Rearranged the structure.
1810 - Kept up to date, with new settings, command-line options etc.
1811 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1812 - Converted settings table into a definition list.
1814 * docs/rst/quickstart.txt:
1816 - Added a table of contents.
1817 - Added feedback information.
1818 - Added mention of minimum section title underline lengths.
1819 - Removed the 4-character minimum for section title underlines.
1821 * docs/rst/quickref.html:
1823 - Added a "Getting Help" section.
1824 - Added a style to make section title backlinks more subtle.
1825 - Added mention of minimum section title underline lengths.
1826 - Removed the 4-character minimum for section title underlines.
1828 * extras: Directory added to project; contains third-party modules
1829 that Docutils depends on (optparse, textwrap, roman). These are
1830 only installed if they're not already present.
1832 * licenses: Directory added to project; contains copies of license
1833 files for non-public-domain files.
1837 - Changed the focus. It's about DTD elements: structural
1838 relationships, semantics, and external (public) attributes. Not
1839 about the element class library.
1840 - Moved some implementation-specific stuff into ``docutils.nodes``
1842 - Wrote descriptions of all common attributes and parameter
1843 entities. Filled in introductory material.
1844 - Working through the element descriptions: 55 down, 37 to go.
1845 - Removed "Representation of Horizontal Rules" to
1846 spec/rst/alternatives.txt.
1848 * spec/docutils.dtd:
1850 - Added "generated" inline element.
1851 - Added "line_block" body element.
1852 - Added "auto" attribute to "title".
1853 - Changed content models of "literal_block" and "doctest_block" to
1855 - Added ``%number;`` attribute type parameter entity.
1856 - Changed ``%structural.elements;`` to ``%section.elements``.
1857 - Updated attribute types; made more specific.
1858 - Added "address" bibliographic element.
1859 - Added "line" attribute to ``system_message`` element.
1860 - Removed "field_argument" element; "field_name" may contain
1861 multiple words and whitespace.
1862 - Changed public identifier to docutils.sf.net.
1863 - Removed "interpreted" element; added "title_reference",
1864 "abbreviation", "acronym".
1865 - Removed "refuri" attribute from "footnote_reference" and
1866 "citation_reference".
1867 - Added "sidebar", "rubric", "attribution", "admonition",
1868 "superscript", "subscript", and "inline" elements.
1870 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1872 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1874 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1876 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1879 * spec/transforms.txt: Added to project.
1881 * spec/howto: Added subdirectory, for developer how-to docs.
1883 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1884 Elza, edited & extended by David Goodger.
1886 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1889 * spec/rst/alternatives.txt:
1891 - Added "Doctree Representation of Transitions" from
1893 - Updated "Inline External Targets" & closed the debate.
1894 - Added ideas for interpreted text syntax extensions.
1895 - Added "Nested Inline Markup" section.
1897 * spec/rst/directives.txt:
1899 - Added directives: "topic", "sectnum", "target-notes",
1900 "line-block", "parsed-literal", "include", "replace", "sidebar",
1901 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1903 - Formalized descriptions of directive details.
1904 - Added an "align" attribute to the "image" & "figure" directives
1905 (by Adam Chodorowski).
1906 - Added "class" options to "topic", "sidebar", "line-block",
1907 "parsed-literal", "contents", and "image"; and "figclass" to
1910 * spec/rst/interpreted.txt: Added to project. Descriptions of
1911 interpreted text roles.
1913 * spec/rst/introduction.txt:
1915 - Added pointers to material for new users.
1917 * spec/rst/reStructuredText.txt:
1919 - Disambiguated comments (just add a newline after the "::").
1920 - Updated enumerated list description; added a discussion of the
1921 second-line validity checking.
1922 - Updated directive description.
1923 - Added a note redirecting newbies to the user docs.
1924 - Expanded description of inline markup start-strings in non-markup
1926 - Removed field arguments and made field lists a generic construct.
1927 - Removed the 4-character minimum for section title underlines.
1928 - Clarified term/classifier delimiter & inline markup ambiguity
1930 - Added "Embedded URIs".
1931 - Updated "Interpreted Text" section.
1932 - Added "Character-Level Inline Markup" section.
1934 * test: Continually adding & updating tests.
1936 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1937 - Moved test/test_pep/ to test/test_readers/test_pep/.
1938 - Added test/test_readers/test_python/.
1939 - Added test/test_writers/ (Engelbert Gruber).
1943 - Made the ``locale.setlocale()`` calls in front ends
1946 * tools/buildhtml.py:
1948 - Added "--silent" option.
1949 - Fixed bug with absolute paths & "--config".
1950 - Updated for new I/O classes.
1951 - Added some exception handling.
1952 - Separated publishers' setting defaults; prevents interference.
1953 - Updated for new ``publish_file()`` convenience function.
1955 * tools/pep-html-template:
1957 - Allow for "--embed-stylesheet".
1958 - Added Docutils version to "generator" meta tag.
1959 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1960 - Conform to XHTML spec.
1962 * tools/pep2html.py:
1964 - Made ``argv`` a parameter to ``main()``.
1965 - Added support for "Content-Type:" header & arbitrary PEP formats.
1966 - Linked "Content-Type: text/plain" to PEP 9.
1967 - Files skipped (due to an error) are not pushed onto the server.
1968 - Updated for new I/O classes.
1969 - Added ``check_requirements()`` & ``pep_type_error()``.
1970 - Added some exception handling.
1971 - Updated for new ``publish_string()`` convenience function.
1972 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1974 * tools/quicktest.py:
1976 - Added "-V"/"--version" option.
1978 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1980 * tools/unicode2rstsubs.py: Added to project. Produces character
1981 entity files (reSructuredText substitutions) from the MathML master
1984 * tools/editors: Support code for editors, added to project. Contains
1985 ``emacs/restructuredtext.el``.
1987 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1989 - Added style for chunks of inline literals.
1990 - Removed margin for first child of table cells.
1991 - Right-aligned field list names.
1992 - Support for auto-numbered section titles in TOCs.
1993 - Increased the size of inline literals (<tt>) in titles.
1994 - Restored the light gray background for inline literals.
1995 - Added support for "line_block" elements.
1996 - Added style for "address" elements.
1997 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1998 - Improved field list rendering.
1999 - Vertical whitespace improvements.
2000 - Removed "a.target" style.
2002 * tools/stylesheets/pep.css:
2004 - Fixed nested section margins.
2005 - Other changes parallel those of ``../default.css``.
2008 Release 0.2 (2002-07-31)
2009 ========================
2013 - The word "component" was being used ambiguously. From now on,
2014 "component" will be used to mean "Docutils component", as in Reader,
2015 Writer, Parser, or Transform. Portions of documents (Table of
2016 Contents, sections, etc.) will be called "document parts".
2017 - Did a grand renaming: a lot of ``verylongnames`` became
2018 ``very_long_names``.
2019 - Cleaned up imports: no more relative package imports or
2020 comma-separated lists of top-level modules.
2021 - Added support for an option values object which carries default
2022 settings and overrides (from command-line options and library use).
2023 - Added internal Unicode support, and support for both input and
2025 - Added support for the ``docutils.io.IO`` class & subclasses.
2029 * docutils/__init__.py:
2031 - Added ``ApplicationError`` and ``DataError``, for use throughout
2033 - Added ``Component`` base class for Docutils components; implements
2034 the ``supports`` method.
2035 - Added ``__version__`` (thus, ``docutils.__version__``).
2039 - Removed many keyword parameters to ``Publisher.__init__()`` and
2040 ``publish()``; bundled into an option values object. Added
2041 "argv", "usage", "description", and "option_spec" parameters for
2042 command-line support.
2043 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2045 - Reworked I/O model for ``docutils.io`` wrappers.
2046 - Updated ``Publisher.set_options()``; now returns option values
2048 - Added support for configuration files (/etc/docutils.conf,
2049 ./docutils.conf, ~/.docutils).
2050 - Added ``Publisher.setup_option_parser()``.
2051 - Added default usage message and description.
2053 * docutils/frontend.py: Added to project; support for front-end
2054 (command-line) scripts. Option specifications may be augmented by
2055 components. Requires Optik (http://optik.sf.net/) for option
2056 processing (installed locally as docutils/optik.py).
2058 * docutils/io.py: Added to project; uniform API for a variety of input
2061 * docutils/nodes.py:
2063 - Added ``TreeCopyVisitor`` class.
2064 - Added a ``copy`` method to ``Node`` and subclasses.
2065 - Added a ``SkipDeparture`` exception for visitors.
2066 - Renamed ``TreePruningException`` from ``VisitorException``.
2067 - Added docstrings to ``TreePruningException``, subclasses, and
2069 - Improved docstrings.
2070 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2071 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2073 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2074 ``PreDecorative`` mixin.
2075 - Reworked the name/id bookkeeping; to ``document``, removed
2076 ``explicit_targets`` and ``implicit_targets`` attributes, added
2077 ``nametypes`` attribute and ``set_name_id_map`` method.
2078 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2080 - Added ``document.has_name()`` method.
2081 - Fixed DOM generation for list-attributes.
2082 - Added category class ``Labeled`` (used by footnotes & citations).
2083 - Added ``Element.set_class()`` method (sets "class" attribute).
2085 * docutils/optik.py: Added to project. Combined from the Optik
2086 package, with added option groups and other modifications. The use
2087 of this module is probably only temporary.
2089 * docutils/statemachine.py:
2091 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2092 - Added underscores to improve many awkward names.
2093 - In ``string2lines()``, changed whitespace normalizing translation
2094 table to regexp; restores Python 2.0 compatibility with Unicode.
2096 * docutils/urischemes.py:
2098 - Filled in some descriptions.
2099 - Added "shttp" scheme.
2101 * docutils/utils.py:
2103 - Added ``clean_rcs_keywords`` function (moved from
2104 docutils/transforms/frontmatter.py
2105 ``DocInfo.filter_rcs_keywords``).
2106 - Added underscores to improve many awkward names.
2107 - Changed names of Reporter's thresholds:
2108 warning_level -> report_level; error_level -> halt_level.
2109 - Moved ``utils.id()`` to ``nodes.make_id()``.
2110 - Added ``relative_path(source, target)``.
2112 * docutils/languages/de.py: German mappings; added to project. Thanks
2113 to Gunnar Schwant for the translations.
2115 * docutils/languages/en.py: Added "Dedication" bibliographic field
2118 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2121 * docutils/parsers/rst/states.py:
2123 - Added underscores to improve many awkward names.
2124 - Added RFC-2822 header support.
2125 - Extracted the inline parsing code from ``RSTState`` to a separate
2126 class, ``Inliner``, which will allow easy subclassing.
2127 - Made local bindings for ``memo`` container & often-used contents
2128 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2129 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2130 - Added ``MarkupMismatch`` exception; for late corrections.
2131 - Added ``-/:`` characters to inline markup's start string prefix,
2132 ``/`` to end string suffix.
2133 - Fixed a footnote bug.
2134 - Fixed a bug with literal blocks.
2135 - Applied patch from Simon Budig: simplified regexps with symbolic
2136 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2137 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2138 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2139 - Allowed non-ASCII in "simple names" (directive names, field names,
2141 - Converted ``Inliner.patterns.initial`` to be dynamically built
2142 from parts with ``build_regexp()`` function.
2143 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2144 - Updated docstrings.
2145 - Changed "table" to "grid_table"; added "simple_table" support.
2147 * docutils/parsers/rst/tableparser.py:
2149 - Changed ``TableParser`` to ``GridTableParser``.
2150 - Added ``SimpleTableParser``.
2151 - Refactored naming.
2153 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2154 a fallback language for directive names.
2156 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2157 directive to use a ``pending`` element, used only by HTML writers.
2159 * docutils/parsers/rst/directives/parts.py: Renamed from
2162 - Added "backlinks" attribute to "contents" directive.
2164 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2165 project by Adam Chodorowski.
2167 * docutils/readers/__init__.py: Gave Readers more control over
2168 choosing and instantiating Parsers.
2170 * docutils/readers/pep.py: Added to project; for PEP processing.
2172 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2173 requires a ``component`` parameter.
2175 * docutils/transforms/components.py: Added to project; transforms
2176 related to Docutils components.
2178 * docutils/transforms/frontmatter.py:
2180 - In ``DocInfo.extract_authors``, check for a single "author" in an
2181 "authors" group, and convert it to a single "author" element.
2182 - Added support for "Dedication" and generic bibliographic fields.
2184 * docutils/transforms/peps.py: Added to project; PEP-specific.
2186 * docutils/transforms/parts.py: Renamed from old components.py.
2188 - Added filter for `Contents`, to use alt-text for inline images,
2189 and to remove inline markup that doesn't make sense in the ToC.
2190 - Added "name" attribute to TOC topic depending on its title.
2191 - Added support for optional TOC backlinks.
2193 * docutils/transforms/references.py: Fixed indirect target resolution
2194 in ``Hyperlinks`` transform.
2196 * docutils/transforms/universal.py:
2198 - Changed ``Messages`` transform to properly filter out system
2199 messages below the warning threshold.
2200 - Added ``Decorations`` transform (support for ``--generator``,
2201 ``--date``, ``--time``, ``--source-link`` options).
2203 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2204 Engelbert Gruber's PDF writer.
2206 * docutils/writers/html4css1.py:
2208 - Made XHTML-compatible (switched to lowercase element & attribute
2209 names; empty tag format).
2210 - Escape double-dashes in comment text.
2211 - Improved boilerplate & modularity of output.
2212 - Exposed modular output in Writer class.
2213 - Added a "generator" meta tag to <head>.
2214 - Added support for the ``--stylesheet`` option.
2215 - Added support for ``decoration``, ``header``, and ``footer``
2217 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2218 translation table to regexp; restores Python 2.0 compatibility
2220 - Added the translator class as instance variable to the Writer, to
2221 make it easily subclassable.
2222 - Improved option list spacing (thanks to Richard Jones).
2223 - Modified field list output.
2224 - Added backlinks to footnotes & citations.
2225 - Added percentage widths to "<col>" tags (from colspec).
2226 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2227 "<span>" changed to "<var>".
2228 - Inline literals: "<code>" changed to "<tt>".
2229 - Many changes to optimize vertical space: compact simple lists etc.
2230 - Add a command-line options & directive attributes to control TOC
2231 and footnote/citation backlinks.
2232 - Added support for optional footnote/citation backlinks.
2233 - Added support for generic bibliographic fields.
2234 - Identify backrefs.
2235 - Relative URLs for stylesheet links.
2237 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2238 PEPs (subclass of ``html4css1.Writer``).
2240 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2242 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2243 of the Docutils internal doctree in XML.
2245 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2249 - Changed the title to "The Docutils Document Tree".
2250 - Added "Hyperlink Bookkeeping" section.
2252 * spec/docutils.dtd:
2254 - Added ``decoration``, ``header``, and ``footer`` elements.
2255 - Brought ``interpreted`` element in line with the parser: changed
2256 attribute "type" to "role", added "position".
2257 - Added support for generic bibliographic fields.
2259 * spec/notes.txt: Continual updates. Added "Project Policies".
2261 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2264 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2266 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2267 mailing list discussions.
2269 * spec/pep-0287.txt:
2271 - Renamed to "reStructuredText Docstring Format".
2273 - Reworked Q&A as an enumerated list.
2274 - Converted to reStructuredText format.
2276 * spec/pysource.dtd:
2278 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2280 * spec/pysource.txt: Removed from project. Moved much of its contents
2283 * spec/rst/alternatives.txt:
2285 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2286 - Added "Inline External Targets" section.
2288 * spec/rst/directives.txt:
2290 - Added "backlinks" attribute to "contents" directive.
2292 * spec/rst/problems.txt:
2294 - Updated the Enumerated List Markup discussion.
2295 - Added new alternative table markup syntaxes.
2297 * spec/rst/reStructuredText.txt:
2299 - Clarified field list usage.
2300 - Updated enumerated list description.
2301 - Clarified purpose of directives.
2302 - Added ``-/:`` characters to inline markup's start string prefix,
2303 ``/`` to end string suffix.
2304 - Updated "Authors" bibliographic field behavior.
2305 - Changed "inline hyperlink targets" to "inline internal targets".
2306 - Added "simple table" syntax to supplement the existing but
2307 newly-renamed "grid tables".
2308 - Added cautions for anonymous hyperlink use.
2309 - Added "Dedication" and generic bibliographic fields.
2311 * test: Made test modules standalone (subdirectories became packages).
2313 * test/DocutilsTestSupport.py:
2315 - Added support for PEP extensions to reStructuredText.
2316 - Added support for simple tables.
2317 - Refactored naming.
2319 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2321 - Now supports true packages containing test modules
2322 (``__init__.py`` files required); fixes duplicate module name bug.
2324 * test/test_pep/: Subpackage added to project; PEP testing.
2326 * test/test_rst/test_SimpleTableParser.py: Added to project.
2330 - Updated html.py and publish.py front-end tools to use the new
2331 command-line processing facilities of ``docutils.frontend``
2332 (exposed in ``docutils.core.Publisher``), reducing each to just a
2334 - Added ``locale.setlocale()`` calls to front-end tools.
2336 * tools/buildhtml.py: Added to project; batch-generates .html from all
2337 the .txt files in directories and subdirectories.
2339 * tools/default.css:
2341 - Added support for ``header`` and ``footer`` elements.
2342 - Added styles for "Dedication" topics (biblio fields).
2344 * tools/docutils.conf: A configuration file; added to project.
2346 * tools/docutils-xml.py: Added to project.
2348 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2350 * tools/pep-html-template: Added to project.
2352 * tools/pep2html.py: Added to project from Python (nondist/peps).
2353 Added support for Docutils (reStructuredText PEPs).
2355 * tools/quicktest.py:
2357 - Added the ``--attributes`` option, hacked a bit.
2358 - Added a second command-line argument (output file); cleaned up.
2360 * tools/stylesheets/: Subdirectory added to project.
2362 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2365 Release 0.1 (2002-04-20)
2366 ========================
2368 This is the first release of Docutils, merged from the now inactive
2369 reStructuredText__ and `Docstring Processing System`__ projects. For
2370 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2371 `DPS HISTORY`__ files.
2373 __ http://structuredtext.sourceforge.net/
2374 __ http://docstring.sourceforge.net/
2375 __ http://structuredtext.sourceforge.net/HISTORY.html
2376 __ http://docstring.sourceforge.net/HISTORY.html
2378 General changes: renamed 'dps' package to 'docutils'; renamed
2379 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2380 the test suites (reStructuredText's test/test_states renamed to
2381 test/test_rst); and all modifications required to make it all work.
2383 * docutils/parsers/rst/states.py:
2385 - Improved diagnostic system messages for missing blank lines.
2386 - Fixed substitution_reference bug.
2392 indent-tabs-mode: nil
2393 sentence-end-double-space: t