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.
20 * docutils/languages/he.py: Added to project: Hebrew mappings by
23 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
24 mappings by Meir Kriheli.
26 * docutils/frontend.py:
28 - Configuration files are now assumed and required to be
30 - Paths of applied configuration files are now recorded in the
31 runtime setting ``_config_files`` (accessible via
33 - Added ``--strip-elements-with-class`` and ``--strip-class``
34 options (``strip_elements_with_classes`` and ``strip_classes``
39 - Added code to determine the input encoding from data: encoding
40 declarations or the presence of byte order marks (UTF-8 & UTF-16).
41 - Added support for IronPython 1.0.
45 - Added ``document.__getstate__`` method, for pickling.
47 * docutils/parsers/rst/states.py:
49 - Allow ``+`` and ``:`` in reference names.
50 - Unquoted targets beginning with an underscore (``.. __target:
51 URI``) are no longer accepted.
52 - Added support for multiple attributions in a physical block quote
53 (indented text block), dividing it into multiple logical block
55 - Added support for unicode bullets in bullet lists: "•", "‣", and
57 - Added support for new object-oriented directive interface,
58 retaining compatibility to the old functional interface.
59 - Added support for throwing ``DirectiveError``'s from within
62 * docutils/parsers/rst/__init__.py:
64 - Added ``Directive`` base class.
65 - Added ``DirectiveError`` base class.
66 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
69 * docutils/parsers/directives/:
71 - Refactored all reStructuredText directives to use the new
72 object-oriented directive interface. Errors are now (mostly)
73 thrown using the new ``DirectiveError`` class.
75 * docutils/parsers/directives/misc.py:
77 - Added ``start-after`` and ``end-before`` options to ``include``
78 directive; thanks to Stefan Rank.
80 * docutils/transforms/universal.py:
82 - Added ``StripClassesAndElements`` transform to remove from the
83 document tree all elements with classes in
84 ``settings.strip_elements_with_classes`` and all "classes"
85 attribute values in ``self.document.settings.strip_classes``.
87 * docutils/transforms/writer_aux.py:
89 - Added ``Admonitions`` transform to transform specific admonitions
90 (like ``note``, ``warning``, etc.) into generic admonitions with a
93 * docutils/writers/html4css1/__init__.py:
95 - Moved template functionality from the PEP/HTML writer here.
96 - Expanded the fragments available in the ``parts`` attribute.
97 - Moved ``id`` attributes from titles to surrounding ``div``
99 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
100 universally supported now).
101 - ``template.txt`` is now opened in text mode instead of binary mode
102 (to ensure Windows compatibility).
103 - ``a`` elements now have an "internal" or "external" class,
104 depending on reference type.
106 * docutils/writers/html4css1/template.txt: Added to project.
108 * docutils/writers/pep_html/:
110 - Moved template functionality to the HTML writer.
112 * docutils/writers/s5_html/__init__.py:
114 - Added ``view_mode`` & ``hidden_controls`` settings
115 (``--view-mode`` & ``--hidden-controls/--visible-controls``
118 * docutils/writers/latex2e/__init__.py:
120 - Fix: escaping ``%`` in href urls.
121 - Move usepackage hyperref after stylesheet inclusion.
122 - Fix: scrartcl does not have chapter but scrreprt.
123 - Add newline after ``\end{verbatim}``.
124 - Merge smaller differences from latex2e_adaptive_preamble.
125 - Add ``use-part-section``.
126 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
127 - Using leavemode optoin_list no longer needs to check if parent
128 is a definition list.
129 - Append ``\leavemode`` to definition list terms.
130 - No longer write visit\_/depart_definition_list_item comments to
132 - Table column width with 3 decimal places.
133 - Add table stubs support (boldfont).
134 - Add assemble_parts to writer.
135 - Add simply support for nested tables.
136 - Fix verbatim in tables if use-verbatim-when-possible.
137 - Use section commands down to subparagraph.
138 - Put ensuremath around some latin1 chars.
139 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
140 - New option ``--use-bibtex=style,db1,db2``.
141 - New option ``--reference-label`` to allow usage of LaTeX ref for
142 labels in section references.
143 - Add a label after every section to support sectionnumbers as reference
145 - Fix: bug# 1605376 rst2latex: bad options group list
146 - Remove inactive code for use_optionlist_for_option_list.
147 - Remove latex comments from option_list output.
148 - Fix: bug# 1612270 double qoutes in italian literal.
149 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
150 - Add option --use-latex-abstract.
151 - Image width unit ``px`` is translated to ``pt``.
152 - Add image height support.
153 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
155 - Fix: Do not escape underscores in citation reference labels if
156 use-latex-citations is set.
157 - Use centering instead of center for figure contents, to avoid vertical
159 - Recognize table class: borderless, nolines, booktabs, standard.
160 - Fix: Renaming contents section does not work with latex writer; SF
162 - Applied patch for custom roles with classes from Edward Loper.
163 - Fixed bug that caused crashes with more than 256 lists.
165 * docutils/writers/pep_html/__init__.py:
167 - Changed to support new python.org website structure and
170 * docs/howto/security.txt: "Deploying Docutils Securely", added to
173 * tools/buildhtml.py:
175 -- Added ``ignore`` setting to exclude a list of shell patterns
176 (default: ``.svn:CVS``).
178 * tools/editors/emacs/rst.el:
180 - Changed license to "GPL".
181 - Added ``rst-straighten-decorations`` function.
182 - The ``compile`` module is now always loaded.
183 - Added ``rst-toggle-line-block`` function.
184 - Headings consisting only of non-ASCII characters are now
185 recognized by ``rst-toc`` and ``rst-adjust``.
186 - Added font-lock support for multi-line comments where the first
187 comment line is empty.
188 - Added ``(require 'font-lock)``.
192 - Provide descriptive error message if distutils is missing.
195 Release 0.4 (2006-01-09)
196 ========================
200 - Updated the project policies for trunk/branch development &
203 * docutils/__init__.py:
205 - Added ``__version_details__`` attribute to describe code source
206 (repository/snapshot/release).
207 - Replaced ``default_transforms`` attribute of TransformSpec with
208 ``get_transforms()`` method.
212 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
213 functions, for document tree extraction and reprocessing.
217 - Added ``DocTreeInput`` class, for reprocessing existing documents.
218 - Added support for non-Unicode (e.g. binary) writer output.
222 - Re-introduced ``Targetable.indirect_reference_name``, for
223 MoinMoin/reST compatibility (removed in r3124/r3129).
224 - Added ``serial_escape`` function; escapes string values that are
225 elements of a list, for serialization. Modified Docutils-XML
226 writing (``Element._dom_node``) and pseudo-XML writing
227 (``Element.starttag``) to use ``serial_escape``.
228 - Added ``Node.deepcopy()`` method.
229 - Removed the internal lists ``document.substitution_refs``,
230 ``document.anonymous_refs``, and ``document.anonymous_targets``.
231 - Added a "container" element.
232 - Fixed bug where values of list-valued attributes of elements
233 originating from custom interpreted text roles (i.e., with custom
234 classes) were being shared between element instances. Reported by
237 * docutils/statemachine.py:
239 - Added trailing whitespace stripping to ``string2lines()``.
240 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
241 Asian double-width character support.
245 - Added ``east_asian_column_width()`` for double-width character
248 * docutils/languages/ja.py: Added to project: Japanese mappings by
251 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
252 mappings by Panjunyong.
254 * docutils/parsers/null.py: Added to project; a do-nothing parser.
256 * docutils/parsers/rst/__init__.py:
258 - Added validator to tab_width setting, with test. Closes SF bug
259 #1212515, report from Wu Wei.
261 * docutils/parsers/rst/states.py:
263 - Fixed bug with escaped colons indicating a literal block.
264 - Fixed bug with enumerated lists (SF#1254145).
265 - Backslash-escaped colons inside of field names are now allowed.
266 - Targets (implicit and explicit), anonymous hyperlink references
267 and auto-numbered footnote references inside of substitution
268 definitions are now disallowed.
269 - Fixed bug: list items with blank first lines.
270 - Fixed bug: block quote attributions with indented second lines.
271 - Added East Asian double-width character support (Python 2.4 only).
273 * docutils/parsers/rst/tableparser.py:
275 - Added East Asian double-width character support (Python 2.4 only).
277 * docutils/parsers/rst/directives/body.py:
279 - Added the "container" directive.
281 * docutils/parsers/rst/directives/misc.py:
283 - Added the "default-role", "title", and "date" directives.
284 - Added standard data file syntax to the "include" directive.
285 - Added support for "class" directive content.
287 * docutils/parsers/rst/directives/images.py:
289 - Added ``indirect_reference_name`` support for images with a target
291 - Added support for image width and height units.
292 - Fixed bug with image "target" options.
294 * docutils/parsers/rst/directives/references.py:
296 - Added "class" attribute to "target-notes" directive, for
297 footnote_reference classes.
299 * docutils/parsers/rst/include/: Directory added to project; contains
300 standard data files for the "include" directive. Initial contents:
301 character entity substitution definition sets, and a set of
302 definitions for S5/HTML presentations.
304 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
305 mappings by David Goodger.
307 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
308 Simplified Chinese mappings by Panjunyong.
310 * docutils/readers/__init__.py:
312 - Added universal.Decorations and universal.ExposeInternals
313 transforms as default transforms for all readers.
314 - Added ``ReReader`` base class for readers that reread an existing
317 * docutils/readers/doctree.py: Added to project; a reader for existing
320 * docutils/transforms/frontmatter.py:
322 - Fixed the DocInfo transform to handle SVN-style expansion of the
324 - In ``DocInfo.extract_authors``, treat the contents of "authors"
327 * docutils/transforms/misc.py:
329 - Added misc.Transitions transform, extracted from
330 universal.FinalChecks.
332 * docutils/transforms/references.py:
334 - Added references.DanglingReferences transform, extracted from
335 universal.FinalChecks.
336 - Fixed bug with doubly-indirect substitutions.
337 - Added footnote_reference classes attribute to "TargetNotes".
338 - Fixed bug with circular substitution definitions that put Docutils
339 into an infinite loop.
341 * docutils/transforms/universal.py:
343 - Added universal.ExposeInternals transform, extracted from
344 universal.FinalChecks.
345 - Removed universal.FinalChecks transform (logic has been moved to
346 several new transforms).
347 - Fixed bug with the "expose_internals" setting and Text nodes
348 (exposed by the "rawsource" internal attribute).
349 - Added the universal.StripComments transform, implementation of the
350 "strip_comments" setting.
352 * docutils/transforms/writer_aux.py: Added to project; auxiliary
353 transforms for writers.
355 - Added ``Compound`` transform, which flattens compound paragraphs.
357 * docutils/writers/: Several writer modules (html4css1.py) were
358 converted into packages. Support modules and data files have been
359 moved into the packages. The stylesheets for the HTML writers are
360 now installed along with the code, the code knows where to find
361 them, and the default is to use them (actually, to embed them).
362 Some adjustments to configuration files may be necessary. The
363 easiest way to obtain the new default behavior is to remove all
364 settings whose name includes "stylesheet".
366 * docutils/writers/__init__.py:
368 - Added universal.Messages and universal.FilterMessages transforms
369 as default transforms for all writers.
370 - Added ``UnfilteredWriter`` base class for writers that pass the
371 document tree on unchanged.
373 * docutils/writers/docutils_xml.py:
375 - Made ``xmlcharrefreplace`` the default output encoding error
378 * docutils/writers/html4css1/:
380 - Added support for image width and height units.
381 - Made ``xmlcharrefreplace`` the default output encoding error
383 - Made ``--embed-stylesheet`` the default rather than
384 ``--link-stylesheet``.
385 - Moved "id" attribute from container (section etc.) to title's <a>
386 tag, to be on the same tag as "name".
387 (!!! To be reverted in Docutils 0.5.)
388 - Added vertical space between fields of field lists.
389 - Added ``--compact-field-lists`` option to remove vertical space in
391 - Made cloaking of email addresses with ``--cloak-email-addresses``
393 - Fixed support for centered images.
394 - Added support for class="compact" & class="open" lists.
396 * docutils/writers/latex2e/:
398 - Underscores in citekeys are no longer escaped.
400 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
401 mapping of Unicode characters to LaTeX equivalents.
403 * docutils/writers/s5_html/: Package added to project; writer for
406 * docs/dev/distributing.txt: Added to project; guide for distributors
407 (package maintainers).
409 * docs/dev/hacking.txt: Added to project; guide for developers.
411 * docs/ref/doctree.txt:
413 - Updated for plural attributes "classes", "ids", "names",
415 - Added the "container" element.
417 * docs/ref/docutils.dtd:
419 - Updated for plural attributes "classes", "ids", "names",
422 * docs/user/emacs.txt: Added to project; a document about Emacs
423 support for reStructuredText and Docutils.
425 * docs/user/links.txt: Added to project; lists of Docutils-related
428 * docs/user/mailing-lists.txt: Added to project; information about
429 Docutils-related mailing lists and how to access them.
431 * docs/user/slide-shows.txt: Added to project; example of and docs for
432 the S5/HTML writer (``rst2s5.py`` front end).
434 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
435 Files", added to project.
437 * test/coverage.sh: Added to project; test coverage script.
439 * test/DocutilsTestSupport.py:
441 - Added support for specifying runtime settings at the suite level.
443 * test/test_functional.py:
445 - Added the ``clear_output_directory`` function.
446 - Added support for ``_test_more`` functions in functional test
449 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
451 * tools/rstpep2html.py: Renamed from pep.py.
453 * tools/dev/create_unimap.py: Added to project; script to create the
454 docutils/writers/unimap_latex.py mapping file.
456 * tools/dev/profile_docutils.py: Added to project; profiler script.
458 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
460 * tools/editors/emacs/restructuredtext.el,
461 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
462 Removed from project; the functionality is now contained in rst.el.
464 * tools/editors/emacs/rst.el: Added to project. Added many features
465 and fixed many bugs. See docs/user/emacs.txt for details.
467 * tools/stylesheets: Removed from project. Stylesheets have been
468 renamed and moved into writer packages.
471 Release 0.3.9 (2005-05-26)
472 ==========================
476 - Eliminated and replaced all uses of the old string attributes
477 ``id``, ``name``, ``dupname`` and ``class`` with references to the
478 new list attributes ``ids``, ``names``, ``dupnames`` and
479 ``classes`` throughout the whole source tree.
483 - Enabled ``--dump-*`` options when ``--traceback`` specified,
484 allowing for easier debugging.
485 - In ``Publisher.publish()``, expanded the generic top-level
488 * docutils/examples.py:
490 - Added ``internals`` function for exploration.
494 - Fixed ``Input.decode`` method to apply heuristics only if no
495 encoding is explicitly given, and to provide better reporting of
497 - The ``Input.decode`` method now removes byte order marks (BOMs)
502 - ``image`` element class changed to subclass of Element, not
503 TextElement (it's an empty element, and cannot contain text).
504 - Added ``attr_defaults`` dictionary for default attribute values.
505 - Added empty list as default value for the following attributes:
506 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
507 - Added ``document.decoration`` attribute,
508 ``document.get_decoration`` method, and ``decoration.get_header``
509 & ``.get_footer`` methods.
510 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
515 - Removed ``docutils.utils.Reporter.categories``,
516 ``docutils.utils.ConditionSet``, and all references to them, to
517 simplify error reporting.
519 * docutils/languages/nl.py: Added to project; Dutch mappings by
522 * docutils/parsers/rst/__init__.py:
524 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
526 * docutils/parsers/rst/states.py:
528 - Added check for escaped at-mark to prevent email address recognition.
529 - Fixed option lists to allow spaces inside ``<angle-bracketed option
531 - Allowed whitespace in paths and URLs.
532 - Added auto-enumerated list items.
533 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
535 - Added support for table stub columns.
537 * docutils/parsers/rst/directives/__init__.py:
539 - Allowed whitespace in paths (``path`` function).
540 - Added ``uri`` directive option conversion function.
542 * docutils/parsers/rst/directives/body.py:
544 - Fixed illegal context bug with "topic" directive (allowed within
545 sidebars; not within body elements).
547 * docutils/parsers/rst/directives/images.py:
549 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
550 - Added support for the ``file_insertion_enabled`` setting in the
551 "figure" directive (disables "figwidth" option).
552 - "image" directive: added checks for valid values of "align" option,
553 depending on context. "figure" directive: added specialized
554 "align" option and attribute on "figure" element.
555 - Made ":figwidth: image" option of "figure" directive work again.
556 - Fixed bug with reference names containing uppercase letters
557 (e.g. ``Name_``) in "target" option of "image" directive.
559 * docutils/parsers/rst/directives/misc.py:
561 - Fixed "include" and "raw" directives to catch text decoding
563 - Allowed whitespace in "include" & "raw" directive paths.
564 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
565 settings in "include" & "raw" directives.
567 * docutils/parsers/rst/directives/parts.py:
569 - Added "header" & "footer" directives.
570 - Fixed illegal context bug with "contents" directive (topics
571 allowed within sidebars; not within body elements).
573 * docutils/parsers/rst/directives/tables.py:
575 - Added "list-table" directive.
576 - Caught empty CSV table bug.
577 - Added support for the ``file_insertion_enabled`` setting in the
578 "csv-table" directive.
579 - Added ``stub-columns`` option to "csv-table" and "list-table"
582 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
583 mappings by Martijn Pieters.
585 * docutils/readers/standalone.py:
587 - Added ``--section-subtitles`` and ``--no-section-subtitles``
588 options to activate or deactivate the SectSubTitle transform.
590 * docutils/transforms/frontmatter.py:
592 - Added SectSubTitle transform to promote titles of lone
593 subsections to subtitles.
595 * docutils/transforms/references.py:
597 - Fixed mislocated internal targets bug, by propagating internal
598 targets to the next node, making use of the newly added support
599 for multiple names and IDs.
600 - Fixed duplicate footnote label bug.
601 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
604 * docutils/writers/html4css1.py:
606 - Fixed unencoded stylesheet reference bug (characters like "&" in
607 stylesheet references).
608 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
610 - Added support for multiple IDs per node by creating empty ``span``
612 - Added the ``field_name_limit`` & ``option_limit`` settings &
614 - Added support for table stub columns.
615 - Added support for the ``align`` attribute on ``figure`` elements.
616 - Added the ``cloak_email_addresses`` setting & support.
617 - Added ``html_prolog``, ``html_head``, ``html_body``,
618 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
619 ``docutils.core.publish_parts``.
620 - Added support for section subtitles.
622 * docutils/writers/latex2e.py:
624 - Fixed tables starting with more than one multirow cell.
625 - Improved --use-latex-docinfo so that organization/contact/address
626 fields are lumped with the last author field and appear on the
628 - Made sure the titlepage is always shown with --use-latex-docinfo,
629 even if the document has no title.
630 - Made sure that latex doesn't fill in today's date if no date field
632 - Added support for section subtitles.
634 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
637 * docutils/writers/null.py: Added to project; a do-nothing Writer.
639 * docs/api/publisher.txt:
641 - Added "``publish_parts`` Details" section.
643 * docutils/dev/repository.txt: Added to project; information about the
644 Docutils Subversion repository.
646 * docs/ref/docutils.dtd:
648 - Added a ``stub`` attribute to the ``colspec`` element via the
649 ``tbl.colspec.att`` parameter entity.
650 - Allowed topic elements within sidebars
651 - Added an ``align`` attribute to the ``figure`` element.
653 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
657 Release 0.3.7 (2004-12-24)
658 ==========================
660 * docutils/frontend.py:
662 - Added options: --input-encoding-error-handler,
663 --record-dependencies, --leave-footnote-reference-space,
665 - Added command-line and config file support for "overrides" setting
670 - Added support for input encoding error handler.
674 - Added dispatch_visit and dispatch_departure methods to
675 NodeVisitor; useful as a hook for Visitors.
676 - Changed structure of ``line_block``; added ``line``.
677 - Added ``compound`` node class.
678 - Added a mechanism for Visitors to transitionally ignore new node
683 - Moved ``escape2null`` and ``unescape`` functions from
684 docutils/parsers/rst/states.py.
686 * docutils/parsers/rst/roles.py:
689 - Changed role function API: the "text" parameter now takes
690 null-escaped interpreted text content.
692 * docutils/parsers/rst/states.py:
694 - Fixed bug where a "role" directive in a nested parse would crash
695 the parser; the state machine's "language" attribute was not being
697 - Added support for line block syntax.
698 - Fixed directive parsing bug: argument-less directives didn't
699 notice that arguments were present.
700 - Removed error checking for transitions.
701 - Added support for multiple classifiers in definition list items.
702 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
703 - Changed role function API: the "text" parameter now takes
704 null-escaped interpreted text content.
705 - Empty sections and documents are allowed now.
707 * docutils/parsers/rst/directives/__init__.py:
709 - Added ``encoding`` directive option conversion function.
710 - Allow multiple class names in class_option conversion function.
712 * docutils/parsers/rst/directives/body.py:
714 - Converted the line-block directive to use the new structure.
715 - Extracted the old line-block functionality to the ``block``
716 function (still used).
717 - Added ``compound`` directive (thanks to Lea Wiemann).
719 * docutils/parsers/rst/directives/misc.py:
721 - Added "encoding" option to "include" and "raw" directives.
722 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
723 - Allow multiple class names in the "class" directive.
725 * docutils/parsers/rst/directives/parts.py:
727 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
728 options. Thanks to Lele Gaifax.
730 * docutils/parsers/rst/directives/tables.py:
732 - Added "encoding" directive to "csv-table" directive.
733 - Added workaround for lack of Unicode support in csv.py, for
736 * docutils/transforms/misc.py:
738 - Fixed bug when multiple "class" directives are applied to a single
740 - Enabled multiple format names for "raw" directive.
742 * docutils/transforms/references.py:
744 - Added support for trimming whitespace from beside substitution
747 * docutils/transforms/universal.py:
749 - FinalChecks now checks for illegal transitions and moves
750 transitions between sections.
752 * docutils/writers/html4css1.py:
754 - HTMLTranslator.encode now converts U+00A0 to " ".
755 - "stylesheet" and "stylesheet_path" settings are now mutually
757 - Added support for the new line_block/line structure.
758 - --footnote-references now overrides
759 --trim-footnote-reference-space, if applicable.
760 - Added support for ``compound`` elements.
761 - Enabled multiple format names for "raw" directive.
762 - ``<p>`` tags of a paragraph which is the only visible child of the
763 document node are no longer stripped.
764 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
765 new method ``should_be_compact_paragraph()``.
766 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
768 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
769 the output if they have their ``class`` attribute set.
770 - The whole document is now surrounded by a ``<div
771 class="document">`` element.
772 - Body-level images are now wrapped by their own ``<div>`` elements,
773 with image classes copied to the wrapper, and for images which
774 have the ``:align:`` option set, the surrounding ``<div>`` now
775 receives a class attribute (like ``class="align-left"``).
777 * docutils/writers/latex2e.py:
779 - no newline after depart_term.
780 - Added translations for some Unicode quotes.
781 - Added option "font-encoding", made package AE the default.
782 - "stylesheet" and "stylesheet_path" settings are now mutually
784 - --footnote-references now overrides
785 --trim-footnote-reference-space, if applicable.
786 - The footnote label style now matches the footnote reference style
787 ("brackets" or "superscript").
788 - Added support for ``compound`` elements.
789 - Enabled multiple format names for "raw" directive.
791 * docs/ref/docutils.dtd:
793 - Changed structure of the ``line_block`` element; added ``line``.
794 - Added ``compound`` element.
795 - Added "ltrim" and "rtrim" attributes to
796 ``substitution_definition`` element.
797 - Enabled multiple format names for ``raw`` element.
798 - Enabled multiple classifiers in ``definition_list_item`` elements.
800 * docs/ref/rst/directives.txt
802 - Marked "line-block" as deprecated.
803 - "Class" directive now allows multiple class names.
804 - Added "Rationale for Class Attribute Value Conversion".
805 - Added warning about "raw" overuse/abuse.
807 * docs/ref/rst/restructuredtext.txt:
809 - Added syntax for line blocks.
810 - Definition list items may have multiple classifiers.
812 * docs/ref/rst/roles.txt:
816 * tools/stylesheets/default.css:
818 - Added support for the new line_block structure.
819 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
822 Release 0.3.5 (2004-07-29)
823 ==========================
827 * _`Documentation cleanup/reorganization`.
829 - Created new subdirectories of docs/:
831 * ``docs/user/``: introductory/tutorial material for end-users
832 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
833 * ``docs/api/``: API reference material for client-developers
834 * ``docs/ref/``: reference material for all groups
835 * ``docs/howto/``: for component-developers and core-developers
836 * ``docs/peps/``: Python Enhancement Proposals
838 - Moved ``docs/*`` to ``docs/user/``.
839 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
840 ``spec/`` to ``docs/dev``.
841 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
842 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
843 - Moved ``alternatives.txt``, and ``problems.txt`` from
844 ``spec/rst/`` to ``docs/dev/rst/``.
845 - Moved ``reStructuredText.txt``, ``directives.txt``,
846 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
847 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
848 ``roles.txt``, ``reStructuredText.txt`` to
849 ``restructuredtext.txt``.
850 - Moved ``spec/howto/`` to ``docs/howto``.
852 In order to keep the CVS history of moved files, we supplied
853 SourceForge with a `script for modifying the Docutils CVS
856 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
858 After running the cleanup script:
860 - Added ``docs/index.txt``.
861 - Added a ``.htaccess`` file to the ``web`` module, containing
862 redirects for all old paths to new paths. They'll preserve
863 fragments (the "#name" part of a URL), and won't clutter up the
864 file system, and will correct the URL in the user's browser.
865 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
866 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
867 the "To Do" list itself in ``docs/dev/todo.txt``.
868 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
869 section of ``docs/dev/todo.txt``.
870 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
871 - Added "How To Report Bugs" to ``BUGS.txt``.
872 - Went through all the sources and docs (including under web/) and
873 updated links. Mostly done by Lea Wiemann; thanks Lea!
874 (Still need to update links in the sandboxes.)
878 * BUGS.txt: Added to project.
880 * THANKS.txt: Added to project.
882 * docutils/__init__.py:
884 - 0.3.4: Post-release.
888 - Added special error handling & advice for UnicodeEncodeError.
889 - Refactored Publisher.publish (simplified exception handling &
890 extracted debug dumps).
891 - Renamed "enable_exit" parameter of convenience functions to
892 "enable_exit_status".
893 - Enabled traceback (exception propagation) by default in
894 programmatic convenience functions.
895 - Now publish_file and publish_cmdline convenience functions return
896 the encoded string results in addition to their regular I/O.
897 - Extracted common code from publish_file, publish_string, and
898 publish_parts, into new publish_programmatically. Extracted
899 settings code to ``Publisher.process_programmatic_settings``.
900 - In Publisher.publish, disabled ``settings_overrides`` when
901 ``settings`` is supplied; redundant.
903 * docutils/frontend.py:
905 - Added help text for "--output-encoding-error-handler" and
906 "--error-encoding-error-handler".
907 - Renamed "--exit" to "--exit-status".
908 - Simplified default-setting code.
910 * docutils/parsers/rst/__init__.py:
912 - Added "--pep-base-url" and "--rfc-base-url" options.
914 * docutils/parsers/rst/states.py:
916 - Made URI recognition more aggressive and intelligent.
918 * docutils/parsers/rst/directives/__init__.py:
920 - Added several directive option conversion functions.
922 * docutils/parsers/rst/directives/body.py:
924 - Moved "table" directive to tables.py.
926 * docutils/parsers/rst/directives/tables.py: Table-related directives,
929 * docutils/writers/latex2e.py:
931 - Added "--table-style=(standard|booktabs|nolines)"
932 - figures get "here" option (LaTeX per default puts them at bottom),
933 and figure content is centered.
934 - Rowspan support for tables.
935 - Fix: admonition titles before first section.
936 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
937 - Replave ``_`` in literal by an underlined blank, because it has the correct
939 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
940 - A few unicode replacements, if output_encoding != utf
941 - Add "--graphicx-option".
942 - Indent literal-blocks.
943 - Fix: omit ``\maketitle`` when there is no document title.
945 * docs/index.txt: "Docutils Project Documentation Overview", added to
948 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
949 Tool", added to project.
951 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
953 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
955 * docs/dev/policies.txt: Added to project (extracted from
956 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
958 * docs/dev/release.txt: Added to project (extracted from
959 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
961 * docs/dev/testing.txt: Added to project.
963 * docs/dev/website.txt: Added to project (extracted from
964 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
966 * docs/ref/rst/directives.txt:
968 - Added directives: "table", "csv-table".
970 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
971 added to project. 1 page for syntax, and a 1 page reference for
972 directives and roles. Source text to be used as-is; not meant to be
975 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
976 with a change of title.
978 * test/functional/, contents, and test/test_functional.py: Added to
981 * tools/buildhtml.py: Fixed bug with config file handling.
983 * tools/html.py: Removed from project (duplicate of rst2html.py).
985 * tools/pep2html.py: Removed from project (duplicate of Python's
986 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
987 Docutils-related PEPs in docs/peps/).
989 * tools/rst2pseudoxml.py: Renamed from publish.py.
991 * tools/rst2xml.py: Renamed from docutils-xml.py.
993 * tools/test.txt: Removed from project; moved to
994 docs/user/rst/demo.txt.
996 * setup.py: Now also installs ``rst2latex.py``.
999 Release 0.3.3 (2004-05-09)
1000 ==========================
1002 * docutils/__init__.py:
1004 - 0.3.1: Reorganized config file format (multiple sections); see
1006 - Added unknown_reference_resolvers attribute to TransformSpec.
1007 - 0.3.2: Interpreted text reorganization.
1012 - Catch system messages to stop tracebacks from parsing errors.
1013 - Catch exceptions during processing report & exit without
1014 tracebacks, except when "--traceback" used.
1015 - Reordered components for OptionParser; application comes last.
1016 - Added "config_section" parameter to several methods and functions,
1017 allowing front ends to easily specify their config file sections.
1018 - Added publish_parts convenience function to allow access to individual
1019 parts of a document.
1021 * docutils/examples.py: Added to project; practical examples of
1022 Docutils client code, to be used as-is or as models for variations.
1024 * docutils/frontend.py:
1026 - Added "--traceback" & "--no-traceback" options ("traceback"
1028 - Implemented support for config file reorganization:
1029 ``standard_config_files`` moved from ``ConfigParser`` to
1030 ``OptionParser``; added
1031 ``OptionParser.get_config_file_settings()`` and
1032 ``.get_standard_config_settings()``; support for old "[options]"
1033 section (with deprecation warning) and mapping from old to new
1035 - Reimplemented setting validation.
1036 - Enabled flexible boolean values: yes/no, true/false, on/off.
1037 - Added ``Values``, a subclass of ``optparse.Values``, with support
1038 for list setting attributes.
1039 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1040 thanks to Beni Cherniavsky.
1041 - Added "--no-section-numbering" option.
1045 - Catch IOErrors when opening source & destination files, report &
1046 exit without tracebacks. Added ``handle_io_errors`` parameter to
1047 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1049 * docutils/nodes.py:
1051 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1052 method definitions (via ``exec``) to dynamic assignments (via
1053 ``setattr``); thanks to Roman Suzi.
1054 - Encapsulated visitor dynamic assignments in a function; thanks to
1056 - Added indirect_reference_name attribute to the Targetable
1057 class. This attribute holds the whitespace_normalized_name
1058 (contains mixed case) of a target.
1060 * docutils/statemachine.py:
1062 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1063 - Added ``StringList.get_2D_block``.
1065 * docutils/utils.py:
1067 - Added "level" attribute to SystemMessage exceptions.
1069 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1072 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1075 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1076 Marcelo Huerta San Martin.
1078 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1079 mappings by Lalo Martins.
1081 * docutils/languages/ru.py: Added to project; Russian mappings by
1084 * docutils/parsers/rst/roles.py: Added to project. Contains
1085 interpreted text role functions, a registry for interpreted text
1086 roles, and an API for adding to and retrieving from the registry.
1087 Contributed by Edward Loper.
1089 * docutils/parsers/rst/states.py:
1091 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1092 - Allowed true em-dash character and "---" as block quote
1094 - Added support for <angle-bracketed> complex option arguments
1096 - Fixed handling of backslashes in substitution definitions.
1097 - Fixed off-by-1 error with extra whitespace after substitution
1098 definition directive.
1099 - Added inline markup parsing to field lists' field names.
1100 - Added support for quoted (and unindented) literal blocks.
1101 Driven in part by a bribe from Frank Siebenlist (thanks!).
1102 - Parser now handles escapes in URIs correctly.
1103 - Made embedded-URIs' reference text omittable. Idea from Beni
1105 - Refactored explicit target processing code.
1106 - Added name attribute to references containing the reference name only
1107 through whitespace_normalize_name (no case changes).
1108 - parse_target no longer returns the refname after going through
1109 normalize_name. This is now handled in make_target.
1110 - Fixed bug relating to role-less interpreted text in non-English
1112 - Reorganized interpreted text processing; moved code into the new
1113 roles.py module. Contributed by Edward Loper.
1114 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1115 ``parse_directive_block``.
1117 * docutils/parsers/rst/tableparser.py:
1119 - Reworked for ``StringList``, to support "include" directives in
1122 * docutils/parsers/rst/directives/__init__.py:
1124 - Renamed ``unchanged()`` directive option conversion function to
1125 ``unchanged_required``, and added a new ``unchanged``.
1126 - Catch unicode value too high error; fixes bug 781766.
1127 - Beefed up directive error reporting.
1129 * docutils/parsers/rst/directives/body.py:
1131 - Added basic "table" directive.
1133 * docutils/parsers/rst/directives/images.py:
1135 - Added "target" option to "image" directive.
1136 - Added name attribute to references containing the reference name only
1137 through whitespace_normalize_name (no case changes).
1139 * docutils/parsers/rst/directives/misc.py:
1141 - Isolated the import of the ``urllib2`` module; was causing
1142 problems on SourceForge (``libssl.so.2`` unavailable?).
1143 - Added the "role" directive for declaring custom interpreted text
1146 * docutils/parsers/rst/directives/parts.py:
1148 - The "contents" directive does more work up-front, creating the
1149 "topic" and "title", and leaving the "pending" node for the
1150 transform. Allows earlier reference resolution; fixes subtle bug.
1152 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1153 mappings by Jannie Hofmeyr.
1155 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1156 mappings by Marek Blaha.
1158 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1159 mappings by Marcelo Huerta San Martin.
1161 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1162 Portuguese mappings by Lalo Martins.
1164 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1165 mappings by Roman Suzi.
1167 * docutils/transforms/parts.py:
1169 - The "contents" directive does more work up-front, creating the
1170 "topic" and "title", and leaving the "pending" node for the
1171 transform. Allows earlier reference resolution; fixes subtle bug.
1172 - Added support for disabling of section numbering.
1174 * docutils/transforms/references.py:
1176 - Verifying that external targets are truly targets and not indirect
1177 references. This is because we are now adding a "name" attribute to
1178 references in addition to targets. Note sure if this is correct!
1179 - Added code to hook into the unknown_reference_resolvers list for a
1180 transformer in resolve_indirect_target. This allows the
1181 unknown_reference_resolvers to keep around indirect targets which
1182 docutils doesn't know about.
1183 - Added specific error message for duplicate targets.
1185 * docutils/transforms/universal.py:
1187 - Added FilterMessages transform (removes system messages below the
1188 verbosity threshold).
1189 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1190 to FinalCheckVisitor for application-specific handling of
1191 unresolvable references.
1192 - Added specific error message for duplicate targets.
1194 * docutils/writers/__init__.py:
1196 - Added assemble_parts method to the Writer class to allow for
1197 access to a documents individual parts.
1198 - Documented & set default for ``Writer.output`` attribute.
1200 * docutils/writers/html4css1.py:
1202 - Fixed unicode handling of attribute values (bug 760673).
1203 - Prevent duplication of "class" attribute values (bug report from
1205 - Improved table grid/border handling (prompted by report from Bob
1207 - Added support for table titles.
1208 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1210 - Added functionality to keep track of individual parts of a document
1211 and store them in a dictionary as the "parts" attribute of the writer.
1212 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1213 - Added proper support for the "scale" attribute of the "image"
1214 element. Contributed by Brent Cook.
1215 - Added ``--initial-header-level`` option.
1216 - Fixed bug: the body_pre_docinfo segment depended on there being a
1217 docinfo; if no docinfo, the document title was incorporated into
1218 the body segment. Adversely affected the publish_parts interface.
1220 * docutils/writers/latex2e.py:
1222 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1223 about a missing file.
1224 - Added options and support: ``--compound-enumerators``,
1225 ``--section-prefix-for-enumerators``, and
1226 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1228 - Added option ``--use-verbatim-when-possible``, to avoid
1229 problematic characters (eg, '~' in italian) in literal blocks.
1230 - It's now possible to use four section levels in the `book` and
1231 `report` LaTeX classes. The default `article` class still has
1234 * docs/config.txt: "Docutils Configuration Files", added to project.
1235 Moved config file entry descriptions from tools.txt.
1239 - Moved config file entry descriptions to config.txt.
1241 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1244 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1245 Text Roles", added to project.
1247 * spec/rst/reStructuredText.txt:
1249 - Added description of support for <angle-bracketed> complex option
1250 arguments to option lists.
1251 - Added subsections for indented and quoted literal blocks.
1253 * test: Continually adding & updating tests.
1255 - Added test/test_settings.py & test/data/config_*.txt support
1257 - Added test/test_writers/test_htmlfragment.py.
1259 * test/DocutilsTestSupport.py:
1261 - Refactored LaTeX publisher test suite/case class names to make
1262 testing other writers easier.
1263 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1264 to test the processing of HTML fragments which use the new
1265 publish_parts convenience function.
1267 * tools/buildhtml.py:
1269 - Added support for the "--prune" option.
1270 - Removed dependency on pep2html.py; plaintext PEPs no longer
1273 * tools/docutils.conf:
1275 - Updated for configuration file reorganization.
1277 * tools/rst2html.py:
1279 - copied from tools/html.py
1283 - added a 'scripts' section to configuration
1284 - added 'tools/rst2html.py' to the scripts section
1287 Release 0.3 (2003-06-24)
1288 ========================
1292 * Renamed "attribute" to "option" for directives/extensions.
1294 * Renamed transform method "transform" to "apply".
1296 * Renamed "options" to "settings" for runtime settings (as set by
1297 command-line options). Sometimes "option" (singular) became
1298 "settings" (plural). Some variations below:
1300 - document.options -> document.settings (stored in other objects as
1302 - option_spec -> settings_spec (not directives though)
1303 - OptionSpec -> SettingsSpec
1304 - cmdline_options -> settings_spec
1305 - relative_path_options -> relative_path_settings
1306 - option_default_overrides -> settings_default_overrides
1307 - Publisher.set_options -> Publisher.get_settings
1311 * COPYING.txt: Added "Public Domain Dedication".
1313 * FAQ.txt: Frequently asked questions, added to project.
1317 - Updated with PyPI Trove classifiers.
1318 - Conditional installation of third-party modules.
1320 * docutils/__init__.py:
1322 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1323 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1324 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1325 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1326 option and its effect on the PEP template & writer.
1327 - Bumped version to 0.2.4 due to changes to the PEP template &
1329 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1330 - Added ``TransformSpec`` class for new transform system.
1331 - Bumped version to 0.2.6 for API changes (renaming).
1332 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1333 convenience functions.
1334 - Added ``Component.component_type`` attribute.
1335 - Bumped version to 0.2.8 because of the internal parser switch from
1336 plain lists to the docutils.statemachine.StringList objects.
1337 - Bumped version to 0.2.9 because of the frontend.py API changes.
1338 - Bumped version to 0.2.10 due to changes to the project layout
1339 (third-party modules removed from the "docutils" package), and
1340 signature changes in ``io.Input``/``io.Output``.
1341 - Changed version to 0.3.0 for release.
1345 - Made ``publish()`` a bit more convenient.
1346 - Generalized ``Publisher.set_io``.
1347 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1348 parameters; improved its docstring.
1349 - Added ``publish_file()`` and ``publish_string()``.
1350 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1352 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1353 "--dump-transforms" hidden options.
1354 - Added ``Publisher.apply_transforms()`` method.
1355 - Added ``Publisher.set_components()`` method; support for
1356 ``publish_*()`` conveninece functions.
1357 - Moved config file processing to docutils/frontend.py.
1358 - Added support for exit status ("exit_level" setting &
1359 ``enable_exit`` parameter for Publisher.publish() and convenience
1362 * docutils/frontend.py:
1364 - Check for & exit on identical source & destination paths.
1365 - Fixed bug with absolute paths & "--config".
1366 - Set non-command-line defaults in ``OptionParser.__init__()``:
1367 ``_source`` & ``_destination``.
1368 - Distributed ``relative_path_settings`` to components; updated
1369 ``OptionParser.populate_from_components()`` to combine it all.
1370 - Require list of keys in ``make_paths_absolute`` (was implicit in
1371 global ``relative_path_settings``).
1372 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1373 "--dump-settings", and "--dump-transforms" hidden options.
1374 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1375 code, replaced with correct code.
1376 - Added validation functionality for config files.
1377 - Added "--error-encoding" option/setting, "_disable_config"
1379 - Added encoding validation; updated "--input-encoding" and
1380 "--output-encoding"; added "--error-encoding-error-handler" and
1381 "--output-encoding-error-handler".
1382 - Moved config file processing from docutils/core.py.
1383 - Updated ``OptionParser.populate_from_components`` to handle new
1384 ``SettingsSpec.settings_defaults`` dict.
1385 - Added support for "-" => stdin/stdout.
1386 - Added "exit_level" setting ("--exit" option).
1390 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1391 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1392 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1393 - ``FileOutput.write()`` now returns the encoded output string.
1394 - Try to get path/stream name automatically in ``FileInput`` &
1396 - Added defaults for source & destination paths.
1397 - Allow for Unicode I/O with an explicit "unicode" encoding.
1398 - Added ``Output.encode()``.
1399 - Removed dependency on runtime settings; pass encoding directly.
1400 - Recognize Unicode strings in ``Input.decode()``.
1401 - Added support for output encoding error handlers.
1403 * docutils/nodes.py:
1405 - Added "Invisible" element category class.
1406 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1407 modification during a traversal.
1408 - Added element classes: ``line_block``, ``generated``, ``address``,
1409 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1410 ``superscript``, ``subscript``, ``inline``
1411 - Added support for lists of nodes to ``Element.insert()``.
1412 - Fixed parent linking in ``Element.replace()``.
1413 - Added new abstract superclass ``FixedTextElement``; adds
1414 "xml:space" attribute.
1415 - Added support for "line" attribute of ``system_message`` nodes.
1416 - Added support for the observer pattern from ``utils.Reporter``.
1417 Added ``parse_messages`` and ``transform_messages`` attributes to
1418 ``document``, removed ``messages``. Added ``note_parse_message``
1419 and ``note_transform_message`` methods.
1420 - Added support for improved diagnostics:
1422 - Added "document", "source", and "line" internal attributes to
1423 ``Node``, set by ``Node.setup_child()``.
1424 - Converted variations on ``node.parent = self`` to
1425 ``self.setup_child(node)``.
1426 - Added ``document.current_source`` & ``.current_line``
1427 attributes, and ``.note_source`` observer method.
1428 - Changed "system_message" output to GNU-Tools format.
1430 - Added a "rawsource" attribute to the ``Text`` class, for text
1431 before backslash-escape resolution.
1432 - Support for new transform system.
1433 - Reworked ``pending`` element.
1434 - Fixed XML DOM bug (SF #660611).
1435 - Removed the ``interpeted`` element class and added
1436 ``title_reference``, ``abbreviation``, ``acronym``.
1437 - Made substitutions case-sensitive-but-forgiving; moved some code
1439 - Fixed Unicode bug on element attributes (report: William Dode).
1441 * docutils/optik.py: Removed from project; replaced with
1442 extras/optparse.py and extras/textwrap.py. These will be installed
1443 only if they're not already present in the Python installation.
1445 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1446 only if it's not already present in the Python installation.
1448 * docutils/statemachine.py:
1450 - Factored out ``State.add_initial_transitions()`` so it can be
1452 - Converted whitespace-specific "blank" and "indent" transitions
1453 from special-case code to ordinary transitions: removed
1454 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1455 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1456 ``ws_initial_transitions`` attributes.
1457 - Removed ``State.match_transition()`` after merging it into
1459 - Added ``StateCorrection`` exception.
1460 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1461 (moved ``TransitionCorrection`` support there too.)
1462 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1463 ``EOFError`` instead of ``IndexError``.
1464 - Added ``State.no_match`` method.
1465 - Added support for the Observer pattern, triggered by input line
1467 - Added ``strip_top`` parameter to
1468 ``StateMachineWS.get_first_known_indented``.
1469 - Made ``context`` a parameter to ``StateMachine.run()``.
1470 - Added ``ViewList`` & ``StringList`` classes;
1471 ``extract_indented()`` becomes ``StringList.get_indented()``.
1472 - Added ``StateMachine.insert_input()``.
1473 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1474 thanks to) Fred Drake.
1476 * docutils/utils.py:
1478 - Added a ``source`` attribute to Reporter instances and
1479 ``system_message`` elements.
1480 - Added an observer pattern to ``utils.Reporter`` to keep track of
1482 - Fixed bugs in ``relative_path()``.
1483 - Added support for improved diagnostics.
1484 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1485 - Added support for encoding Reporter stderr output, and encoding
1487 - Reporter keeps track of the highest level system message yet
1490 * docutils/languages: Fixed bibliographic field language lookups.
1492 * docutils/languages/es.py: Added to project; Spanish mappings by
1493 Marcelo Huerta San Martin.
1495 * docutils/languages/fr.py: Added to project; French mappings by
1498 * docutils/languages/it.py: Added to project; Italian mappings by
1501 * docutils/languages/sk.py: Added to project; Slovak mappings by
1504 * docutils/parser/__init__.py:
1506 - Added ``Parser.finish_parse()`` method.
1508 * docutils/parser/rst/__init__.py:
1510 - Added options: "--pep-references", "--rfc-references",
1511 "--tab-width", "--trim-footnote-reference-space".
1513 * docutils/parsers/rst/states.py:
1515 - Changed "title under/overline too short" system messages from INFO
1516 to WARNING, and fixed its insertion location.
1517 - Fixed enumerated list item parsing to allow paragraphs & section
1518 titles to begin with enumerators.
1519 - Converted system messages to use the new "line" attribute.
1520 - Fixed a substitution reference edge case.
1521 - Added support for "--pep-references" and "--rfc-references"
1522 options; reworked ``Inliner`` code to make customization easier.
1523 - Removed field argument parsing.
1524 - Added support for short section title over/underlines.
1525 - Fixed "simple reference name" regexp to ignore text like
1526 "object.__method__"; not an anonymous reference.
1527 - Added support for improved diagnostics.
1528 - Reworked directive API, based on Dethe Elza's contribution. Added
1529 ``Body.parse_directive()``, ``.parse_directive_options()``,
1530 ``.parse_directive_arguments()`` methods.
1531 - Added ``ExtensionOptions`` class, to parse directive options
1532 without parsing field bodies. Factored
1533 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1534 ``ExtensionOptions``.
1535 - Improved definition list term/classifier parsing.
1536 - Added warnings for unknown directives.
1537 - Renamed ``Stuff`` to ``Struct``.
1538 - Now flagged as errors: transitions at the beginning or end of
1539 sections, empty sections (except title), and empty documents.
1540 - Updated for ``statemachine.StringList``.
1541 - Enabled recognition of schemeless email addresses in targets.
1542 - Added support for embedded URIs in hyperlink references.
1543 - Added backslash-escapes to inline markup end-string suffix.
1544 - Added support for correct interpreted text processing.
1545 - Fixed nested title parsing (topic, sidebar directives).
1546 - Added special processing of backslash-escaped whitespace (idea
1547 from David Abrahams).
1548 - Made substitutions case-sensitive-but-forgiving; moved some code
1549 to ``docutils.nodes``.
1550 - Added support for block quote attributions.
1551 - Added a kludge to work-around a conflict between the bubble-up
1552 parser strategy and short titles (<= 3 char-long over- &
1553 underlines). Fixes SF bug #738803 "infinite loop with multiple
1554 titles" submitted by Jason Diamond.
1555 - Added explicit interpreted text roles for standard inline markup:
1556 "emphasis", "strong", "literal".
1557 - Implemented "superscript" and "subscript" interpreted text roles.
1558 - Added initial support for "abbreviation" and "acronym" roles;
1560 - Added support for "--trim-footnote-reference-space" option.
1561 - Optional space before colons in directives & hyperlink targets.
1563 * docutils/parsers/rst/tableparser.py:
1565 - Fixed a bug that was producing unwanted empty rows in "simple"
1567 - Detect bad column spans in "simple" tables.
1569 * docutils/parsers/rst/directives: Updated all directive functions to
1572 * docutils/parsers/rst/directives/__init__.py:
1574 - Added ``flag()``, ``unchanged()``, ``path()``,
1575 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1576 directive option helper functions.
1577 - Added warnings for unknown directives.
1578 - Return ``None`` for missing directives.
1579 - Added ``register_directive()``, thanks to William Dode and Paul
1582 * docutils/parsers/rst/directives/admonitions.py:
1584 - Added "admonition" directive.
1586 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1587 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1588 "parsed-literal", "rubric", "epigraph", "highlights" and
1589 "pull-quote" directives.
1591 * docutils/parsers/rst/directives/images.py:
1593 - Added an "align" attribute to the "image" & "figure" directives
1594 (by Adam Chodorowski).
1595 - Added "class" option to "image", and "figclass" to "figure".
1597 * docutils/parsers/rst/directives/misc.py:
1599 - Added "include", "raw", and "replace" directives, courtesy of
1601 - Added "unicode" and "class" directives.
1603 * docutils/parsers/rst/directives/parts.py:
1605 - Added the "sectnum" directive; by Dmitry Jemerov.
1606 - Added "class" option to "contents" directive.
1608 * docutils/parsers/rst/directives/references.py: Added to project.
1609 Contains the "target-notes" directive.
1611 * docutils/parsers/rst/languages/__init__.py:
1613 - Return ``None`` from get_language() for missing language modules.
1615 * docutils/parsers/rst/languages/de.py: Added to project; German
1616 mappings by Engelbert Gruber.
1618 * docutils/parsers/rst/languages/en.py:
1620 - Added interpreted text roles mapping.
1622 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1623 mappings by Marcelo Huerta San Martin.
1625 * docutils/parsers/rst/languages/fr.py: Added to project; French
1626 mappings by William Dode.
1628 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1629 mappings by Nicola Larosa.
1631 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1632 mappings by Miroslav Vasko.
1634 * docutils/readers/__init__.py:
1636 - Added support for the observer pattern from ``utils.Reporter``, in
1637 ``Reader.parse`` and ``Reader.transform``.
1638 - Removed ``Reader.transform()`` method.
1639 - Added default parameter values to ``Reader.__init__()`` to make
1640 instantiation easier.
1641 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1643 * docutils/readers/pep.py:
1645 - Added the ``peps.TargetNotes`` transform to the Reader.
1646 - Removed PEP & RFC reference detection code; moved to
1647 parsers/rst/states.py as options (enabled here by default).
1648 - Added support for pre-acceptance PEPs (no PEP number yet).
1649 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1652 * docutils/readers/python: Python Source Reader subpackage added to
1653 project, including preliminary versions of:
1656 - moduleparser.py: Parser for Python modules.
1658 * docutils/transforms/__init__.py:
1660 - Added ``Transformer`` class and completed transform reform.
1661 - Added unknown_reference_resolvers list for each transformer. This list holds
1662 the list of functions provided by each component of the transformer that
1663 help resolve references.
1665 * docutils/transforms/frontmatter.py:
1667 - Improved support for generic fields.
1668 - Fixed bibliographic field language lookups.
1670 * docutils/transforms/misc.py: Added to project. Miscellaneous
1673 * docutils/transforms/parts.py:
1675 - Moved the "id" attribute from TOC list items to the references
1676 (``Contents.build_contents()``).
1677 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1678 - Added "class" attribute support to ``Contents``.
1680 * docutils/transforms/peps.py:
1682 - Added ``mask_email()`` function, updating to pep2html.py's
1684 - Linked "Content-Type: text/x-rst" to PEP 12.
1685 - Added the ``TargetNotes`` PEP-specific transform.
1686 - Added ``TargetNotes.cleanup_callback``.
1687 - Added title check to ``Headers``.
1689 * docutils/transforms/references.py:
1691 - Added the ``TargetNotes`` generic transform.
1692 - Split ``Hyperlinks`` into multiple transforms.
1693 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1694 - Added check for circular indirect references.
1695 - Made substitutions case-sensitive-but-forgiving.
1697 * docutils/transforms/universal.py:
1699 - Added support for the "--expose-internal-attributes" option.
1700 - Removed ``Pending`` transform classes & data.
1702 * docutils/writers/__init__.py:
1704 - Removed ``Writer.transform()`` method.
1706 * docutils/writers/docutils-xml.py:
1708 - Added XML and doctype declarations.
1709 - Added "--no-doctype" and "--no-xml-declaration" options.
1711 * docutils/writers/html4css1.py:
1713 - "name" attributes only on these tags: a, applet, form, frame,
1715 - Added "name" attribute to <a> in section titles for Netscape 4
1716 support (bug report: Pearu Peterson).
1717 - Fixed targets (names) on footnote, citation, topic title,
1718 problematic, and system_message nodes (for Netscape 4).
1719 - Changed field names from "<td>" to "<th>".
1720 - Added "@" to "@" encoding to thwart address harvesters.
1721 - Improved the vertical whitespace optimization; ignore "invisible"
1722 nodes (targets, comments, etc.).
1723 - Improved inline literals with ``<span class="pre">`` around chunks
1724 of text and `` `` for runs of spaces.
1725 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1726 ``self.docinfo`` segments.
1727 - Added support for "line_block", "address" elements.
1728 - Improved backlinks (footnotes & system_messages).
1729 - Improved system_message output.
1730 - Redefined "--stylesheet" as containing an invariant URL, used
1731 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1733 - Added "--footnote-references" option (superscript or brackets).
1734 - Added "--compact-lists" and "--no-compact-lists" options.
1735 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1736 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1737 - Improved field list rendering.
1738 - Added Docutils version to "generator" meta tag.
1739 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1740 - Improved layout of <pre> HTML source.
1741 - Fixed attribute typo on <colspec>.
1742 - Refined XML prologue.
1743 - Support for no stylesheet.
1744 - Removed "interpreted" element support.
1745 - Added support for "title_reference", "sidebar", "attribution",
1746 "rubric", and generic "admonition" elements.
1747 - Added "--attribution" option.
1748 - Added support for "inline", "subscript", "superscript" elements.
1749 - Added initial support for "abbreviation" and "acronym";
1752 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1756 - Double quotes in literal blocks (special treatment for de/ngerman).
1757 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1758 - Added "--attribution" option.
1759 - Right align attributions.
1761 * docutils/writers/pep_html.py:
1763 - Parameterized output encoding in PEP template.
1764 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1765 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1766 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1768 - Added an override on the "--footnote-references" option.
1769 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1770 - Added Docutils version to "generator" meta tag.
1771 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1775 - Added a "silent" setting for ``buildhtml.py``.
1776 - Added a "Getting Help" section.
1777 - Rearranged the structure.
1778 - Kept up to date, with new settings, command-line options etc.
1779 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1780 - Converted settings table into a definition list.
1782 * docs/rst/quickstart.txt:
1784 - Added a table of contents.
1785 - Added feedback information.
1786 - Added mention of minimum section title underline lengths.
1787 - Removed the 4-character minimum for section title underlines.
1789 * docs/rst/quickref.html:
1791 - Added a "Getting Help" section.
1792 - Added a style to make section title backlinks more subtle.
1793 - Added mention of minimum section title underline lengths.
1794 - Removed the 4-character minimum for section title underlines.
1796 * extras: Directory added to project; contains third-party modules
1797 that Docutils depends on (optparse, textwrap, roman). These are
1798 only installed if they're not already present.
1800 * licenses: Directory added to project; contains copies of license
1801 files for non-public-domain files.
1805 - Changed the focus. It's about DTD elements: structural
1806 relationships, semantics, and external (public) attributes. Not
1807 about the element class library.
1808 - Moved some implementation-specific stuff into ``docutils.nodes``
1810 - Wrote descriptions of all common attributes and parameter
1811 entities. Filled in introductory material.
1812 - Working through the element descriptions: 55 down, 37 to go.
1813 - Removed "Representation of Horizontal Rules" to
1814 spec/rst/alternatives.txt.
1816 * spec/docutils.dtd:
1818 - Added "generated" inline element.
1819 - Added "line_block" body element.
1820 - Added "auto" attribute to "title".
1821 - Changed content models of "literal_block" and "doctest_block" to
1823 - Added ``%number;`` attribute type parameter entity.
1824 - Changed ``%structural.elements;`` to ``%section.elements``.
1825 - Updated attribute types; made more specific.
1826 - Added "address" bibliographic element.
1827 - Added "line" attribute to ``system_message`` element.
1828 - Removed "field_argument" element; "field_name" may contain
1829 multiple words and whitespace.
1830 - Changed public identifier to docutils.sf.net.
1831 - Removed "interpreted" element; added "title_reference",
1832 "abbreviation", "acronym".
1833 - Removed "refuri" attribute from "footnote_reference" and
1834 "citation_reference".
1835 - Added "sidebar", "rubric", "attribution", "admonition",
1836 "superscript", "subscript", and "inline" elements.
1838 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1840 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1842 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1844 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1847 * spec/transforms.txt: Added to project.
1849 * spec/howto: Added subdirectory, for developer how-to docs.
1851 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1852 Elza, edited & extended by David Goodger.
1854 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1857 * spec/rst/alternatives.txt:
1859 - Added "Doctree Representation of Transitions" from
1861 - Updated "Inline External Targets" & closed the debate.
1862 - Added ideas for interpreted text syntax extensions.
1863 - Added "Nested Inline Markup" section.
1865 * spec/rst/directives.txt:
1867 - Added directives: "topic", "sectnum", "target-notes",
1868 "line-block", "parsed-literal", "include", "replace", "sidebar",
1869 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1871 - Formalized descriptions of directive details.
1872 - Added an "align" attribute to the "image" & "figure" directives
1873 (by Adam Chodorowski).
1874 - Added "class" options to "topic", "sidebar", "line-block",
1875 "parsed-literal", "contents", and "image"; and "figclass" to
1878 * spec/rst/interpreted.txt: Added to project. Descriptions of
1879 interpreted text roles.
1881 * spec/rst/introduction.txt:
1883 - Added pointers to material for new users.
1885 * spec/rst/reStructuredText.txt:
1887 - Disambiguated comments (just add a newline after the "::").
1888 - Updated enumerated list description; added a discussion of the
1889 second-line validity checking.
1890 - Updated directive description.
1891 - Added a note redirecting newbies to the user docs.
1892 - Expanded description of inline markup start-strings in non-markup
1894 - Removed field arguments and made field lists a generic construct.
1895 - Removed the 4-character minimum for section title underlines.
1896 - Clarified term/classifier delimiter & inline markup ambiguity
1898 - Added "Embedded URIs".
1899 - Updated "Interpreted Text" section.
1900 - Added "Character-Level Inline Markup" section.
1902 * test: Continually adding & updating tests.
1904 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1905 - Moved test/test_pep/ to test/test_readers/test_pep/.
1906 - Added test/test_readers/test_python/.
1907 - Added test/test_writers/ (Engelbert Gruber).
1911 - Made the ``locale.setlocale()`` calls in front ends
1914 * tools/buildhtml.py:
1916 - Added "--silent" option.
1917 - Fixed bug with absolute paths & "--config".
1918 - Updated for new I/O classes.
1919 - Added some exception handling.
1920 - Separated publishers' setting defaults; prevents interference.
1921 - Updated for new ``publish_file()`` convenience function.
1923 * tools/pep-html-template:
1925 - Allow for "--embed-stylesheet".
1926 - Added Docutils version to "generator" meta tag.
1927 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1928 - Conform to XHTML spec.
1930 * tools/pep2html.py:
1932 - Made ``argv`` a parameter to ``main()``.
1933 - Added support for "Content-Type:" header & arbitrary PEP formats.
1934 - Linked "Content-Type: text/plain" to PEP 9.
1935 - Files skipped (due to an error) are not pushed onto the server.
1936 - Updated for new I/O classes.
1937 - Added ``check_requirements()`` & ``pep_type_error()``.
1938 - Added some exception handling.
1939 - Updated for new ``publish_string()`` convenience function.
1940 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1942 * tools/quicktest.py:
1944 - Added "-V"/"--version" option.
1946 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1948 * tools/unicode2rstsubs.py: Added to project. Produces character
1949 entity files (reSructuredText substitutions) from the MathML master
1952 * tools/editors: Support code for editors, added to project. Contains
1953 ``emacs/restructuredtext.el``.
1955 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1957 - Added style for chunks of inline literals.
1958 - Removed margin for first child of table cells.
1959 - Right-aligned field list names.
1960 - Support for auto-numbered section titles in TOCs.
1961 - Increased the size of inline literals (<tt>) in titles.
1962 - Restored the light gray background for inline literals.
1963 - Added support for "line_block" elements.
1964 - Added style for "address" elements.
1965 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1966 - Improved field list rendering.
1967 - Vertical whitespace improvements.
1968 - Removed "a.target" style.
1970 * tools/stylesheets/pep.css:
1972 - Fixed nested section margins.
1973 - Other changes parallel those of ``../default.css``.
1976 Release 0.2 (2002-07-31)
1977 ========================
1981 - The word "component" was being used ambiguously. From now on,
1982 "component" will be used to mean "Docutils component", as in Reader,
1983 Writer, Parser, or Transform. Portions of documents (Table of
1984 Contents, sections, etc.) will be called "document parts".
1985 - Did a grand renaming: a lot of ``verylongnames`` became
1986 ``very_long_names``.
1987 - Cleaned up imports: no more relative package imports or
1988 comma-separated lists of top-level modules.
1989 - Added support for an option values object which carries default
1990 settings and overrides (from command-line options and library use).
1991 - Added internal Unicode support, and support for both input and
1993 - Added support for the ``docutils.io.IO`` class & subclasses.
1997 * docutils/__init__.py:
1999 - Added ``ApplicationError`` and ``DataError``, for use throughout
2001 - Added ``Component`` base class for Docutils components; implements
2002 the ``supports`` method.
2003 - Added ``__version__`` (thus, ``docutils.__version__``).
2007 - Removed many keyword parameters to ``Publisher.__init__()`` and
2008 ``publish()``; bundled into an option values object. Added
2009 "argv", "usage", "description", and "option_spec" parameters for
2010 command-line support.
2011 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2013 - Reworked I/O model for ``docutils.io`` wrappers.
2014 - Updated ``Publisher.set_options()``; now returns option values
2016 - Added support for configuration files (/etc/docutils.conf,
2017 ./docutils.conf, ~/.docutils).
2018 - Added ``Publisher.setup_option_parser()``.
2019 - Added default usage message and description.
2021 * docutils/frontend.py: Added to project; support for front-end
2022 (command-line) scripts. Option specifications may be augmented by
2023 components. Requires Optik (http://optik.sf.net/) for option
2024 processing (installed locally as docutils/optik.py).
2026 * docutils/io.py: Added to project; uniform API for a variety of input
2029 * docutils/nodes.py:
2031 - Added ``TreeCopyVisitor`` class.
2032 - Added a ``copy`` method to ``Node`` and subclasses.
2033 - Added a ``SkipDeparture`` exception for visitors.
2034 - Renamed ``TreePruningException`` from ``VisitorException``.
2035 - Added docstrings to ``TreePruningException``, subclasses, and
2037 - Improved docstrings.
2038 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2039 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2041 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2042 ``PreDecorative`` mixin.
2043 - Reworked the name/id bookkeeping; to ``document``, removed
2044 ``explicit_targets`` and ``implicit_targets`` attributes, added
2045 ``nametypes`` attribute and ``set_name_id_map`` method.
2046 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2048 - Added ``document.has_name()`` method.
2049 - Fixed DOM generation for list-attributes.
2050 - Added category class ``Labeled`` (used by footnotes & citations).
2051 - Added ``Element.set_class()`` method (sets "class" attribute).
2053 * docutils/optik.py: Added to project. Combined from the Optik
2054 package, with added option groups and other modifications. The use
2055 of this module is probably only temporary.
2057 * docutils/statemachine.py:
2059 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2060 - Added underscores to improve many awkward names.
2061 - In ``string2lines()``, changed whitespace normalizing translation
2062 table to regexp; restores Python 2.0 compatibility with Unicode.
2064 * docutils/urischemes.py:
2066 - Filled in some descriptions.
2067 - Added "shttp" scheme.
2069 * docutils/utils.py:
2071 - Added ``clean_rcs_keywords`` function (moved from
2072 docutils/transforms/frontmatter.py
2073 ``DocInfo.filter_rcs_keywords``).
2074 - Added underscores to improve many awkward names.
2075 - Changed names of Reporter's thresholds:
2076 warning_level -> report_level; error_level -> halt_level.
2077 - Moved ``utils.id()`` to ``nodes.make_id()``.
2078 - Added ``relative_path(source, target)``.
2080 * docutils/languages/de.py: German mappings; added to project. Thanks
2081 to Gunnar Schwant for the translations.
2083 * docutils/languages/en.py: Added "Dedication" bibliographic field
2086 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2089 * docutils/parsers/rst/states.py:
2091 - Added underscores to improve many awkward names.
2092 - Added RFC-2822 header support.
2093 - Extracted the inline parsing code from ``RSTState`` to a separate
2094 class, ``Inliner``, which will allow easy subclassing.
2095 - Made local bindings for ``memo`` container & often-used contents
2096 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2097 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2098 - Added ``MarkupMismatch`` exception; for late corrections.
2099 - Added ``-/:`` characters to inline markup's start string prefix,
2100 ``/`` to end string suffix.
2101 - Fixed a footnote bug.
2102 - Fixed a bug with literal blocks.
2103 - Applied patch from Simon Budig: simplified regexps with symbolic
2104 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2105 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2106 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2107 - Allowed non-ASCII in "simple names" (directive names, field names,
2109 - Converted ``Inliner.patterns.initial`` to be dynamically built
2110 from parts with ``build_regexp()`` function.
2111 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2112 - Updated docstrings.
2113 - Changed "table" to "grid_table"; added "simple_table" support.
2115 * docutils/parsers/rst/tableparser.py:
2117 - Changed ``TableParser`` to ``GridTableParser``.
2118 - Added ``SimpleTableParser``.
2119 - Refactored naming.
2121 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2122 a fallback language for directive names.
2124 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2125 directive to use a ``pending`` element, used only by HTML writers.
2127 * docutils/parsers/rst/directives/parts.py: Renamed from
2130 - Added "backlinks" attribute to "contents" directive.
2132 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2133 project by Adam Chodorowski.
2135 * docutils/readers/__init__.py: Gave Readers more control over
2136 choosing and instantiating Parsers.
2138 * docutils/readers/pep.py: Added to project; for PEP processing.
2140 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2141 requires a ``component`` parameter.
2143 * docutils/transforms/components.py: Added to project; transforms
2144 related to Docutils components.
2146 * docutils/transforms/frontmatter.py:
2148 - In ``DocInfo.extract_authors``, check for a single "author" in an
2149 "authors" group, and convert it to a single "author" element.
2150 - Added support for "Dedication" and generic bibliographic fields.
2152 * docutils/transforms/peps.py: Added to project; PEP-specific.
2154 * docutils/transforms/parts.py: Renamed from old components.py.
2156 - Added filter for `Contents`, to use alt-text for inline images,
2157 and to remove inline markup that doesn't make sense in the ToC.
2158 - Added "name" attribute to TOC topic depending on its title.
2159 - Added support for optional TOC backlinks.
2161 * docutils/transforms/references.py: Fixed indirect target resolution
2162 in ``Hyperlinks`` transform.
2164 * docutils/transforms/universal.py:
2166 - Changed ``Messages`` transform to properly filter out system
2167 messages below the warning threshold.
2168 - Added ``Decorations`` transform (support for ``--generator``,
2169 ``--date``, ``--time``, ``--source-link`` options).
2171 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2172 Engelbert Gruber's PDF writer.
2174 * docutils/writers/html4css1.py:
2176 - Made XHTML-compatible (switched to lowercase element & attribute
2177 names; empty tag format).
2178 - Escape double-dashes in comment text.
2179 - Improved boilerplate & modularity of output.
2180 - Exposed modular output in Writer class.
2181 - Added a "generator" meta tag to <head>.
2182 - Added support for the ``--stylesheet`` option.
2183 - Added support for ``decoration``, ``header``, and ``footer``
2185 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2186 translation table to regexp; restores Python 2.0 compatibility
2188 - Added the translator class as instance variable to the Writer, to
2189 make it easily subclassable.
2190 - Improved option list spacing (thanks to Richard Jones).
2191 - Modified field list output.
2192 - Added backlinks to footnotes & citations.
2193 - Added percentage widths to "<col>" tags (from colspec).
2194 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2195 "<span>" changed to "<var>".
2196 - Inline literals: "<code>" changed to "<tt>".
2197 - Many changes to optimize vertical space: compact simple lists etc.
2198 - Add a command-line options & directive attributes to control TOC
2199 and footnote/citation backlinks.
2200 - Added support for optional footnote/citation backlinks.
2201 - Added support for generic bibliographic fields.
2202 - Identify backrefs.
2203 - Relative URLs for stylesheet links.
2205 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2206 PEPs (subclass of ``html4css1.Writer``).
2208 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2210 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2211 of the Docutils internal doctree in XML.
2213 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2217 - Changed the title to "The Docutils Document Tree".
2218 - Added "Hyperlink Bookkeeping" section.
2220 * spec/docutils.dtd:
2222 - Added ``decoration``, ``header``, and ``footer`` elements.
2223 - Brought ``interpreted`` element in line with the parser: changed
2224 attribute "type" to "role", added "position".
2225 - Added support for generic bibliographic fields.
2227 * spec/notes.txt: Continual updates. Added "Project Policies".
2229 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2232 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2234 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2235 mailing list discussions.
2237 * spec/pep-0287.txt:
2239 - Renamed to "reStructuredText Docstring Format".
2241 - Reworked Q&A as an enumerated list.
2242 - Converted to reStructuredText format.
2244 * spec/pysource.dtd:
2246 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2248 * spec/pysource.txt: Removed from project. Moved much of its contents
2251 * spec/rst/alternatives.txt:
2253 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2254 - Added "Inline External Targets" section.
2256 * spec/rst/directives.txt:
2258 - Added "backlinks" attribute to "contents" directive.
2260 * spec/rst/problems.txt:
2262 - Updated the Enumerated List Markup discussion.
2263 - Added new alternative table markup syntaxes.
2265 * spec/rst/reStructuredText.txt:
2267 - Clarified field list usage.
2268 - Updated enumerated list description.
2269 - Clarified purpose of directives.
2270 - Added ``-/:`` characters to inline markup's start string prefix,
2271 ``/`` to end string suffix.
2272 - Updated "Authors" bibliographic field behavior.
2273 - Changed "inline hyperlink targets" to "inline internal targets".
2274 - Added "simple table" syntax to supplement the existing but
2275 newly-renamed "grid tables".
2276 - Added cautions for anonymous hyperlink use.
2277 - Added "Dedication" and generic bibliographic fields.
2279 * test: Made test modules standalone (subdirectories became packages).
2281 * test/DocutilsTestSupport.py:
2283 - Added support for PEP extensions to reStructuredText.
2284 - Added support for simple tables.
2285 - Refactored naming.
2287 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2289 - Now supports true packages containing test modules
2290 (``__init__.py`` files required); fixes duplicate module name bug.
2292 * test/test_pep/: Subpackage added to project; PEP testing.
2294 * test/test_rst/test_SimpleTableParser.py: Added to project.
2298 - Updated html.py and publish.py front-end tools to use the new
2299 command-line processing facilities of ``docutils.frontend``
2300 (exposed in ``docutils.core.Publisher``), reducing each to just a
2302 - Added ``locale.setlocale()`` calls to front-end tools.
2304 * tools/buildhtml.py: Added to project; batch-generates .html from all
2305 the .txt files in directories and subdirectories.
2307 * tools/default.css:
2309 - Added support for ``header`` and ``footer`` elements.
2310 - Added styles for "Dedication" topics (biblio fields).
2312 * tools/docutils.conf: A configuration file; added to project.
2314 * tools/docutils-xml.py: Added to project.
2316 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2318 * tools/pep-html-template: Added to project.
2320 * tools/pep2html.py: Added to project from Python (nondist/peps).
2321 Added support for Docutils (reStructuredText PEPs).
2323 * tools/quicktest.py:
2325 - Added the ``--attributes`` option, hacked a bit.
2326 - Added a second command-line argument (output file); cleaned up.
2328 * tools/stylesheets/: Subdirectory added to project.
2330 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2333 Release 0.1 (2002-04-20)
2334 ========================
2336 This is the first release of Docutils, merged from the now inactive
2337 reStructuredText__ and `Docstring Processing System`__ projects. For
2338 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2339 `DPS HISTORY`__ files.
2341 __ http://structuredtext.sourceforge.net/
2342 __ http://docstring.sourceforge.net/
2343 __ http://structuredtext.sourceforge.net/HISTORY.html
2344 __ http://docstring.sourceforge.net/HISTORY.html
2346 General changes: renamed 'dps' package to 'docutils'; renamed
2347 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2348 the test suites (reStructuredText's test/test_states renamed to
2349 test/test_rst); and all modifications required to make it all work.
2351 * docutils/parsers/rst/states.py:
2353 - Improved diagnostic system messages for missing blank lines.
2354 - Fixed substitution_reference bug.
2360 indent-tabs-mode: nil
2361 sentence-end-double-space: t