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 - Prepare for python 3.0: minimize "types" module where possible.
23 - Apply [ 1878977 ] make_id(): deaccent characters.
24 - Backwards-compatible changes to remove python2.6 -3 deprecation warnings
25 - Text nodes now subclass unicode rather than UserString
26 (which is gone in python 3.0)
27 - Apply [ 1719345 ] Galician translation
28 - Apply [ 1905741 ] polish-translation
32 - Added ``Element.__contains__`` method, for the in-operator.
34 * docutils/parsers/rst/states.py:
36 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
37 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
38 " " (non-breaking space), and "¡ ¿" openers.
40 * docutils/writers/newlatex2e/__init__.py:
42 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
44 * docutils/writers/latex2e/__init__.py:
46 - Add option ``--embed-stylesheet``.
47 - Apply [ 1474017 ] image vertical alignment is reversed.
48 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
49 - Fix: for spanish ``~n`` is ``n`` with tilde above, change to ``~{}n``.
50 - Change: has_key for dictionaries (not Nodes) to in-operator.
51 - Merge adjacent citations into one latex cite command.
53 * docs/ref/rst/restructuredtext.txt:
55 - Documented Unicode characters allowed as inline markup openers,
56 closers, and delimiters.
59 Release 0.5 (2008-06-25)
60 ========================
62 * docutils/languages/he.py: Added to project: Hebrew mappings by
65 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
66 mappings by Meir Kriheli.
68 * docutils/frontend.py:
70 - Configuration files are now assumed and required to be
72 - Paths of applied configuration files are now recorded in the
73 runtime setting ``_config_files`` (accessible via
75 - Added ``--strip-elements-with-class`` and ``--strip-class``
76 options (``strip_elements_with_classes`` and ``strip_classes``
81 - Added code to determine the input encoding from data: encoding
82 declarations or the presence of byte order marks (UTF-8 & UTF-16).
83 - Added support for IronPython 1.0.
87 - Added ``document.__getstate__`` method, for pickling.
89 * docutils/parsers/rst/states.py:
91 - Allow ``+`` and ``:`` in reference names.
92 - Unquoted targets beginning with an underscore (``.. __target:
93 URI``) are no longer accepted.
94 - Added support for multiple attributions in a physical block quote
95 (indented text block), dividing it into multiple logical block
97 - Added support for unicode bullets in bullet lists: "•", "‣", and
99 - Added support for new object-oriented directive interface,
100 retaining compatibility to the old functional interface.
101 - Added support for throwing ``DirectiveError``'s from within
104 * docutils/parsers/rst/__init__.py:
106 - Added ``Directive`` base class.
107 - Added ``DirectiveError`` base class.
108 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
111 * docutils/parsers/directives/:
113 - Refactored all reStructuredText directives to use the new
114 object-oriented directive interface. Errors are now (mostly)
115 thrown using the new ``DirectiveError`` class.
117 * docutils/parsers/directives/misc.py:
119 - Added ``start-after`` and ``end-before`` options to ``include``
120 directive; thanks to Stefan Rank.
122 * docutils/transforms/universal.py:
124 - Added ``StripClassesAndElements`` transform to remove from the
125 document tree all elements with classes in
126 ``settings.strip_elements_with_classes`` and all "classes"
127 attribute values in ``self.document.settings.strip_classes``.
129 * docutils/transforms/writer_aux.py:
131 - Added ``Admonitions`` transform to transform specific admonitions
132 (like ``note``, ``warning``, etc.) into generic admonitions with a
135 * docutils/writers/html4css1/__init__.py:
137 - Moved template functionality from the PEP/HTML writer here.
138 - Expanded the fragments available in the ``parts`` attribute.
139 - Moved ``id`` attributes from titles to surrounding ``div``
141 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
142 universally supported now).
143 - ``template.txt`` is now opened in text mode instead of binary mode
144 (to ensure Windows compatibility).
145 - ``a`` elements now have an "internal" or "external" class,
146 depending on reference type.
148 * docutils/writers/html4css1/template.txt: Added to project.
150 * docutils/writers/pep_html/:
152 - Moved template functionality to the HTML writer.
154 * docutils/writers/s5_html/__init__.py:
156 - Added ``view_mode`` & ``hidden_controls`` settings
157 (``--view-mode`` & ``--hidden-controls/--visible-controls``
160 * docutils/writers/latex2e/__init__.py:
162 - Add ``--literal-block-env``
163 - Fix: escaping ``%`` in href urls.
164 - Move usepackage hyperref after stylesheet inclusion.
165 - Fix: scrartcl does not have chapter but scrreprt.
166 - Add newline after ``\end{verbatim}``.
167 - Merge smaller differences from latex2e_adaptive_preamble.
168 - Add ``use-part-section``.
169 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
170 - Using leavemode option_list no longer needs to check if parent
171 is a definition list.
172 - Append ``\leavemode`` to definition list terms.
173 - No longer write visit\_/depart_definition_list_item comments to
175 - Table column width with 3 decimal places.
176 - Add table stubs support (boldfont).
177 - Add assemble_parts to writer.
178 - Add simply support for nested tables.
179 - Fix verbatim in tables if use-verbatim-when-possible.
180 - Use section commands down to subparagraph.
181 - Put ensuremath around some latin1 chars.
182 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
183 - New option ``--use-bibtex=style,db1,db2``.
184 - New option ``--reference-label`` to allow usage of LaTeX ref for
185 labels in section references.
186 - Add a label after every section to support sectionnumbers as reference
188 - Fix: bug# 1605376 rst2latex: bad options group list
189 - Remove inactive code for use_optionlist_for_option_list.
190 - Remove latex comments from option_list output.
191 - Fix: bug# 1612270 double qoutes in italian literal.
192 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
193 - Add option --use-latex-abstract.
194 - Image width unit ``px`` is translated to ``pt``.
195 - Add image height support.
196 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
198 - Fix: Do not escape underscores in citation reference labels if
199 use-latex-citations is set.
200 - Use centering instead of center for figure contents, to avoid vertical
202 - Recognize table class: borderless, nolines, booktabs, standard.
203 - Fix: Renaming contents section does not work with latex writer; SF
205 - Applied patch for custom roles with classes from Edward Loper.
206 - Fixed bug that caused crashes with more than 256 lists.
208 * docutils/writers/pep_html/__init__.py:
210 - Changed to support new python.org website structure and
213 * docs/howto/security.txt: "Deploying Docutils Securely", added to
216 * tools/buildhtml.py:
218 -- Added ``ignore`` setting to exclude a list of shell patterns
219 (default: ``.svn:CVS``).
221 * tools/editors/emacs/rst.el:
223 - Changed license to "GPL".
224 - Added ``rst-straighten-decorations`` function.
225 - The ``compile`` module is now always loaded.
226 - Added ``rst-toggle-line-block`` function.
227 - Headings consisting only of non-ASCII characters are now
228 recognized by ``rst-toc`` and ``rst-adjust``.
229 - Added font-lock support for multi-line comments where the first
230 comment line is empty.
231 - Added ``(require 'font-lock)``.
235 - Provide descriptive error message if distutils is missing.
238 Release 0.4 (2006-01-09)
239 ========================
243 - Updated the project policies for trunk/branch development &
246 * docutils/__init__.py:
248 - Added ``__version_details__`` attribute to describe code source
249 (repository/snapshot/release).
250 - Replaced ``default_transforms`` attribute of TransformSpec with
251 ``get_transforms()`` method.
255 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
256 functions, for document tree extraction and reprocessing.
260 - Added ``DocTreeInput`` class, for reprocessing existing documents.
261 - Added support for non-Unicode (e.g. binary) writer output.
265 - Re-introduced ``Targetable.indirect_reference_name``, for
266 MoinMoin/reST compatibility (removed in r3124/r3129).
267 - Added ``serial_escape`` function; escapes string values that are
268 elements of a list, for serialization. Modified Docutils-XML
269 writing (``Element._dom_node``) and pseudo-XML writing
270 (``Element.starttag``) to use ``serial_escape``.
271 - Added ``Node.deepcopy()`` method.
272 - Removed the internal lists ``document.substitution_refs``,
273 ``document.anonymous_refs``, and ``document.anonymous_targets``.
274 - Added a "container" element.
275 - Fixed bug where values of list-valued attributes of elements
276 originating from custom interpreted text roles (i.e., with custom
277 classes) were being shared between element instances. Reported by
280 * docutils/statemachine.py:
282 - Added trailing whitespace stripping to ``string2lines()``.
283 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
284 Asian double-width character support.
288 - Added ``east_asian_column_width()`` for double-width character
291 * docutils/languages/ja.py: Added to project: Japanese mappings by
294 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
295 mappings by Panjunyong.
297 * docutils/parsers/null.py: Added to project; a do-nothing parser.
299 * docutils/parsers/rst/__init__.py:
301 - Added validator to tab_width setting, with test. Closes SF bug
302 #1212515, report from Wu Wei.
304 * docutils/parsers/rst/states.py:
306 - Fixed bug with escaped colons indicating a literal block.
307 - Fixed bug with enumerated lists (SF#1254145).
308 - Backslash-escaped colons inside of field names are now allowed.
309 - Targets (implicit and explicit), anonymous hyperlink references
310 and auto-numbered footnote references inside of substitution
311 definitions are now disallowed.
312 - Fixed bug: list items with blank first lines.
313 - Fixed bug: block quote attributions with indented second lines.
314 - Added East Asian double-width character support (Python 2.4 only).
316 * docutils/parsers/rst/tableparser.py:
318 - Added East Asian double-width character support (Python 2.4 only).
320 * docutils/parsers/rst/directives/body.py:
322 - Added the "container" directive.
324 * docutils/parsers/rst/directives/misc.py:
326 - Added the "default-role", "title", and "date" directives.
327 - Added standard data file syntax to the "include" directive.
328 - Added support for "class" directive content.
330 * docutils/parsers/rst/directives/images.py:
332 - Added ``indirect_reference_name`` support for images with a target
334 - Added support for image width and height units.
335 - Fixed bug with image "target" options.
337 * docutils/parsers/rst/directives/references.py:
339 - Added "class" attribute to "target-notes" directive, for
340 footnote_reference classes.
342 * docutils/parsers/rst/include/: Directory added to project; contains
343 standard data files for the "include" directive. Initial contents:
344 character entity substitution definition sets, and a set of
345 definitions for S5/HTML presentations.
347 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
348 mappings by David Goodger.
350 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
351 Simplified Chinese mappings by Panjunyong.
353 * docutils/readers/__init__.py:
355 - Added universal.Decorations and universal.ExposeInternals
356 transforms as default transforms for all readers.
357 - Added ``ReReader`` base class for readers that reread an existing
360 * docutils/readers/doctree.py: Added to project; a reader for existing
363 * docutils/transforms/frontmatter.py:
365 - Fixed the DocInfo transform to handle SVN-style expansion of the
367 - In ``DocInfo.extract_authors``, treat the contents of "authors"
370 * docutils/transforms/misc.py:
372 - Added misc.Transitions transform, extracted from
373 universal.FinalChecks.
375 * docutils/transforms/references.py:
377 - Added references.DanglingReferences transform, extracted from
378 universal.FinalChecks.
379 - Fixed bug with doubly-indirect substitutions.
380 - Added footnote_reference classes attribute to "TargetNotes".
381 - Fixed bug with circular substitution definitions that put Docutils
382 into an infinite loop.
384 * docutils/transforms/universal.py:
386 - Added universal.ExposeInternals transform, extracted from
387 universal.FinalChecks.
388 - Removed universal.FinalChecks transform (logic has been moved to
389 several new transforms).
390 - Fixed bug with the "expose_internals" setting and Text nodes
391 (exposed by the "rawsource" internal attribute).
392 - Added the universal.StripComments transform, implementation of the
393 "strip_comments" setting.
395 * docutils/transforms/writer_aux.py: Added to project; auxiliary
396 transforms for writers.
398 - Added ``Compound`` transform, which flattens compound paragraphs.
400 * docutils/writers/: Several writer modules (html4css1.py) were
401 converted into packages. Support modules and data files have been
402 moved into the packages. The stylesheets for the HTML writers are
403 now installed along with the code, the code knows where to find
404 them, and the default is to use them (actually, to embed them).
405 Some adjustments to configuration files may be necessary. The
406 easiest way to obtain the new default behavior is to remove all
407 settings whose name includes "stylesheet".
409 * docutils/writers/__init__.py:
411 - Added universal.Messages and universal.FilterMessages transforms
412 as default transforms for all writers.
413 - Added ``UnfilteredWriter`` base class for writers that pass the
414 document tree on unchanged.
416 * docutils/writers/docutils_xml.py:
418 - Made ``xmlcharrefreplace`` the default output encoding error
421 * docutils/writers/html4css1/:
423 - Added support for image width and height units.
424 - Made ``xmlcharrefreplace`` the default output encoding error
426 - Made ``--embed-stylesheet`` the default rather than
427 ``--link-stylesheet``.
428 - Moved "id" attribute from container (section etc.) to title's <a>
429 tag, to be on the same tag as "name".
430 (!!! To be reverted in Docutils 0.5.)
431 - Added vertical space between fields of field lists.
432 - Added ``--compact-field-lists`` option to remove vertical space in
434 - Made cloaking of email addresses with ``--cloak-email-addresses``
436 - Fixed support for centered images.
437 - Added support for class="compact" & class="open" lists.
439 * docutils/writers/latex2e/:
441 - Underscores in citekeys are no longer escaped.
443 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
444 mapping of Unicode characters to LaTeX equivalents.
446 * docutils/writers/s5_html/: Package added to project; writer for
449 * docs/dev/distributing.txt: Added to project; guide for distributors
450 (package maintainers).
452 * docs/dev/hacking.txt: Added to project; guide for developers.
454 * docs/ref/doctree.txt:
456 - Updated for plural attributes "classes", "ids", "names",
458 - Added the "container" element.
460 * docs/ref/docutils.dtd:
462 - Updated for plural attributes "classes", "ids", "names",
465 * docs/user/emacs.txt: Added to project; a document about Emacs
466 support for reStructuredText and Docutils.
468 * docs/user/links.txt: Added to project; lists of Docutils-related
471 * docs/user/mailing-lists.txt: Added to project; information about
472 Docutils-related mailing lists and how to access them.
474 * docs/user/slide-shows.txt: Added to project; example of and docs for
475 the S5/HTML writer (``rst2s5.py`` front end).
477 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
478 Files", added to project.
480 * test/coverage.sh: Added to project; test coverage script.
482 * test/DocutilsTestSupport.py:
484 - Added support for specifying runtime settings at the suite level.
486 * test/test_functional.py:
488 - Added the ``clear_output_directory`` function.
489 - Added support for ``_test_more`` functions in functional test
492 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
494 * tools/rstpep2html.py: Renamed from pep.py.
496 * tools/dev/create_unimap.py: Added to project; script to create the
497 docutils/writers/unimap_latex.py mapping file.
499 * tools/dev/profile_docutils.py: Added to project; profiler script.
501 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
503 * tools/editors/emacs/restructuredtext.el,
504 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
505 Removed from project; the functionality is now contained in rst.el.
507 * tools/editors/emacs/rst.el: Added to project. Added many features
508 and fixed many bugs. See docs/user/emacs.txt for details.
510 * tools/stylesheets: Removed from project. Stylesheets have been
511 renamed and moved into writer packages.
514 Release 0.3.9 (2005-05-26)
515 ==========================
519 - Eliminated and replaced all uses of the old string attributes
520 ``id``, ``name``, ``dupname`` and ``class`` with references to the
521 new list attributes ``ids``, ``names``, ``dupnames`` and
522 ``classes`` throughout the whole source tree.
526 - Enabled ``--dump-*`` options when ``--traceback`` specified,
527 allowing for easier debugging.
528 - In ``Publisher.publish()``, expanded the generic top-level
531 * docutils/examples.py:
533 - Added ``internals`` function for exploration.
537 - Fixed ``Input.decode`` method to apply heuristics only if no
538 encoding is explicitly given, and to provide better reporting of
540 - The ``Input.decode`` method now removes byte order marks (BOMs)
545 - ``image`` element class changed to subclass of Element, not
546 TextElement (it's an empty element, and cannot contain text).
547 - Added ``attr_defaults`` dictionary for default attribute values.
548 - Added empty list as default value for the following attributes:
549 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
550 - Added ``document.decoration`` attribute,
551 ``document.get_decoration`` method, and ``decoration.get_header``
552 & ``.get_footer`` methods.
553 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
558 - Removed ``docutils.utils.Reporter.categories``,
559 ``docutils.utils.ConditionSet``, and all references to them, to
560 simplify error reporting.
562 * docutils/languages/nl.py: Added to project; Dutch mappings by
565 * docutils/parsers/rst/__init__.py:
567 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
569 * docutils/parsers/rst/states.py:
571 - Added check for escaped at-mark to prevent email address recognition.
572 - Fixed option lists to allow spaces inside ``<angle-bracketed option
574 - Allowed whitespace in paths and URLs.
575 - Added auto-enumerated list items.
576 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
578 - Added support for table stub columns.
580 * docutils/parsers/rst/directives/__init__.py:
582 - Allowed whitespace in paths (``path`` function).
583 - Added ``uri`` directive option conversion function.
585 * docutils/parsers/rst/directives/body.py:
587 - Fixed illegal context bug with "topic" directive (allowed within
588 sidebars; not within body elements).
590 * docutils/parsers/rst/directives/images.py:
592 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
593 - Added support for the ``file_insertion_enabled`` setting in the
594 "figure" directive (disables "figwidth" option).
595 - "image" directive: added checks for valid values of "align" option,
596 depending on context. "figure" directive: added specialized
597 "align" option and attribute on "figure" element.
598 - Made ":figwidth: image" option of "figure" directive work again.
599 - Fixed bug with reference names containing uppercase letters
600 (e.g. ``Name_``) in "target" option of "image" directive.
602 * docutils/parsers/rst/directives/misc.py:
604 - Fixed "include" and "raw" directives to catch text decoding
606 - Allowed whitespace in "include" & "raw" directive paths.
607 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
608 settings in "include" & "raw" directives.
610 * docutils/parsers/rst/directives/parts.py:
612 - Added "header" & "footer" directives.
613 - Fixed illegal context bug with "contents" directive (topics
614 allowed within sidebars; not within body elements).
616 * docutils/parsers/rst/directives/tables.py:
618 - Added "list-table" directive.
619 - Caught empty CSV table bug.
620 - Added support for the ``file_insertion_enabled`` setting in the
621 "csv-table" directive.
622 - Added ``stub-columns`` option to "csv-table" and "list-table"
625 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
626 mappings by Martijn Pieters.
628 * docutils/readers/standalone.py:
630 - Added ``--section-subtitles`` and ``--no-section-subtitles``
631 options to activate or deactivate the SectSubTitle transform.
633 * docutils/transforms/frontmatter.py:
635 - Added SectSubTitle transform to promote titles of lone
636 subsections to subtitles.
638 * docutils/transforms/references.py:
640 - Fixed mislocated internal targets bug, by propagating internal
641 targets to the next node, making use of the newly added support
642 for multiple names and IDs.
643 - Fixed duplicate footnote label bug.
644 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
647 * docutils/writers/html4css1.py:
649 - Fixed unencoded stylesheet reference bug (characters like "&" in
650 stylesheet references).
651 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
653 - Added support for multiple IDs per node by creating empty ``span``
655 - Added the ``field_name_limit`` & ``option_limit`` settings &
657 - Added support for table stub columns.
658 - Added support for the ``align`` attribute on ``figure`` elements.
659 - Added the ``cloak_email_addresses`` setting & support.
660 - Added ``html_prolog``, ``html_head``, ``html_body``,
661 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
662 ``docutils.core.publish_parts``.
663 - Added support for section subtitles.
665 * docutils/writers/latex2e.py:
667 - Fixed tables starting with more than one multirow cell.
668 - Improved --use-latex-docinfo so that organization/contact/address
669 fields are lumped with the last author field and appear on the
671 - Made sure the titlepage is always shown with --use-latex-docinfo,
672 even if the document has no title.
673 - Made sure that latex doesn't fill in today's date if no date field
675 - Added support for section subtitles.
677 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
680 * docutils/writers/null.py: Added to project; a do-nothing Writer.
682 * docs/api/publisher.txt:
684 - Added "``publish_parts`` Details" section.
686 * docutils/dev/repository.txt: Added to project; information about the
687 Docutils Subversion repository.
689 * docs/ref/docutils.dtd:
691 - Added a ``stub`` attribute to the ``colspec`` element via the
692 ``tbl.colspec.att`` parameter entity.
693 - Allowed topic elements within sidebars
694 - Added an ``align`` attribute to the ``figure`` element.
696 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
700 Release 0.3.7 (2004-12-24)
701 ==========================
703 * docutils/frontend.py:
705 - Added options: --input-encoding-error-handler,
706 --record-dependencies, --leave-footnote-reference-space,
708 - Added command-line and config file support for "overrides" setting
713 - Added support for input encoding error handler.
717 - Added dispatch_visit and dispatch_departure methods to
718 NodeVisitor; useful as a hook for Visitors.
719 - Changed structure of ``line_block``; added ``line``.
720 - Added ``compound`` node class.
721 - Added a mechanism for Visitors to transitionally ignore new node
726 - Moved ``escape2null`` and ``unescape`` functions from
727 docutils/parsers/rst/states.py.
729 * docutils/parsers/rst/roles.py:
732 - Changed role function API: the "text" parameter now takes
733 null-escaped interpreted text content.
735 * docutils/parsers/rst/states.py:
737 - Fixed bug where a "role" directive in a nested parse would crash
738 the parser; the state machine's "language" attribute was not being
740 - Added support for line block syntax.
741 - Fixed directive parsing bug: argument-less directives didn't
742 notice that arguments were present.
743 - Removed error checking for transitions.
744 - Added support for multiple classifiers in definition list items.
745 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
746 - Changed role function API: the "text" parameter now takes
747 null-escaped interpreted text content.
748 - Empty sections and documents are allowed now.
750 * docutils/parsers/rst/directives/__init__.py:
752 - Added ``encoding`` directive option conversion function.
753 - Allow multiple class names in class_option conversion function.
755 * docutils/parsers/rst/directives/body.py:
757 - Converted the line-block directive to use the new structure.
758 - Extracted the old line-block functionality to the ``block``
759 function (still used).
760 - Added ``compound`` directive (thanks to Lea Wiemann).
762 * docutils/parsers/rst/directives/misc.py:
764 - Added "encoding" option to "include" and "raw" directives.
765 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
766 - Allow multiple class names in the "class" directive.
768 * docutils/parsers/rst/directives/parts.py:
770 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
771 options. Thanks to Lele Gaifax.
773 * docutils/parsers/rst/directives/tables.py:
775 - Added "encoding" directive to "csv-table" directive.
776 - Added workaround for lack of Unicode support in csv.py, for
779 * docutils/transforms/misc.py:
781 - Fixed bug when multiple "class" directives are applied to a single
783 - Enabled multiple format names for "raw" directive.
785 * docutils/transforms/references.py:
787 - Added support for trimming whitespace from beside substitution
790 * docutils/transforms/universal.py:
792 - FinalChecks now checks for illegal transitions and moves
793 transitions between sections.
795 * docutils/writers/html4css1.py:
797 - HTMLTranslator.encode now converts U+00A0 to " ".
798 - "stylesheet" and "stylesheet_path" settings are now mutually
800 - Added support for the new line_block/line structure.
801 - --footnote-references now overrides
802 --trim-footnote-reference-space, if applicable.
803 - Added support for ``compound`` elements.
804 - Enabled multiple format names for "raw" directive.
805 - ``<p>`` tags of a paragraph which is the only visible child of the
806 document node are no longer stripped.
807 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
808 new method ``should_be_compact_paragraph()``.
809 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
811 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
812 the output if they have their ``class`` attribute set.
813 - The whole document is now surrounded by a ``<div
814 class="document">`` element.
815 - Body-level images are now wrapped by their own ``<div>`` elements,
816 with image classes copied to the wrapper, and for images which
817 have the ``:align:`` option set, the surrounding ``<div>`` now
818 receives a class attribute (like ``class="align-left"``).
820 * docutils/writers/latex2e.py:
822 - no newline after depart_term.
823 - Added translations for some Unicode quotes.
824 - Added option "font-encoding", made package AE the default.
825 - "stylesheet" and "stylesheet_path" settings are now mutually
827 - --footnote-references now overrides
828 --trim-footnote-reference-space, if applicable.
829 - The footnote label style now matches the footnote reference style
830 ("brackets" or "superscript").
831 - Added support for ``compound`` elements.
832 - Enabled multiple format names for "raw" directive.
834 * docs/ref/docutils.dtd:
836 - Changed structure of the ``line_block`` element; added ``line``.
837 - Added ``compound`` element.
838 - Added "ltrim" and "rtrim" attributes to
839 ``substitution_definition`` element.
840 - Enabled multiple format names for ``raw`` element.
841 - Enabled multiple classifiers in ``definition_list_item`` elements.
843 * docs/ref/rst/directives.txt
845 - Marked "line-block" as deprecated.
846 - "Class" directive now allows multiple class names.
847 - Added "Rationale for Class Attribute Value Conversion".
848 - Added warning about "raw" overuse/abuse.
850 * docs/ref/rst/restructuredtext.txt:
852 - Added syntax for line blocks.
853 - Definition list items may have multiple classifiers.
855 * docs/ref/rst/roles.txt:
859 * tools/stylesheets/default.css:
861 - Added support for the new line_block structure.
862 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
865 Release 0.3.5 (2004-07-29)
866 ==========================
870 * _`Documentation cleanup/reorganization`.
872 - Created new subdirectories of docs/:
874 * ``docs/user/``: introductory/tutorial material for end-users
875 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
876 * ``docs/api/``: API reference material for client-developers
877 * ``docs/ref/``: reference material for all groups
878 * ``docs/howto/``: for component-developers and core-developers
879 * ``docs/peps/``: Python Enhancement Proposals
881 - Moved ``docs/*`` to ``docs/user/``.
882 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
883 ``spec/`` to ``docs/dev``.
884 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
885 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
886 - Moved ``alternatives.txt``, and ``problems.txt`` from
887 ``spec/rst/`` to ``docs/dev/rst/``.
888 - Moved ``reStructuredText.txt``, ``directives.txt``,
889 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
890 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
891 ``roles.txt``, ``reStructuredText.txt`` to
892 ``restructuredtext.txt``.
893 - Moved ``spec/howto/`` to ``docs/howto``.
895 In order to keep the CVS history of moved files, we supplied
896 SourceForge with a `script for modifying the Docutils CVS
899 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
901 After running the cleanup script:
903 - Added ``docs/index.txt``.
904 - Added a ``.htaccess`` file to the ``web`` module, containing
905 redirects for all old paths to new paths. They'll preserve
906 fragments (the "#name" part of a URL), and won't clutter up the
907 file system, and will correct the URL in the user's browser.
908 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
909 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
910 the "To Do" list itself in ``docs/dev/todo.txt``.
911 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
912 section of ``docs/dev/todo.txt``.
913 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
914 - Added "How To Report Bugs" to ``BUGS.txt``.
915 - Went through all the sources and docs (including under web/) and
916 updated links. Mostly done by Lea Wiemann; thanks Lea!
917 (Still need to update links in the sandboxes.)
921 * BUGS.txt: Added to project.
923 * THANKS.txt: Added to project.
925 * docutils/__init__.py:
927 - 0.3.4: Post-release.
931 - Added special error handling & advice for UnicodeEncodeError.
932 - Refactored Publisher.publish (simplified exception handling &
933 extracted debug dumps).
934 - Renamed "enable_exit" parameter of convenience functions to
935 "enable_exit_status".
936 - Enabled traceback (exception propagation) by default in
937 programmatic convenience functions.
938 - Now publish_file and publish_cmdline convenience functions return
939 the encoded string results in addition to their regular I/O.
940 - Extracted common code from publish_file, publish_string, and
941 publish_parts, into new publish_programmatically. Extracted
942 settings code to ``Publisher.process_programmatic_settings``.
943 - In Publisher.publish, disabled ``settings_overrides`` when
944 ``settings`` is supplied; redundant.
946 * docutils/frontend.py:
948 - Added help text for "--output-encoding-error-handler" and
949 "--error-encoding-error-handler".
950 - Renamed "--exit" to "--exit-status".
951 - Simplified default-setting code.
953 * docutils/parsers/rst/__init__.py:
955 - Added "--pep-base-url" and "--rfc-base-url" options.
957 * docutils/parsers/rst/states.py:
959 - Made URI recognition more aggressive and intelligent.
961 * docutils/parsers/rst/directives/__init__.py:
963 - Added several directive option conversion functions.
965 * docutils/parsers/rst/directives/body.py:
967 - Moved "table" directive to tables.py.
969 * docutils/parsers/rst/directives/tables.py: Table-related directives,
972 * docutils/writers/latex2e.py:
974 - Added "--table-style=(standard|booktabs|nolines)"
975 - figures get "here" option (LaTeX per default puts them at bottom),
976 and figure content is centered.
977 - Rowspan support for tables.
978 - Fix: admonition titles before first section.
979 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
980 - Replave ``_`` in literal by an underlined blank, because it has the correct
982 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
983 - A few unicode replacements, if output_encoding != utf
984 - Add "--graphicx-option".
985 - Indent literal-blocks.
986 - Fix: omit ``\maketitle`` when there is no document title.
988 * docs/index.txt: "Docutils Project Documentation Overview", added to
991 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
992 Tool", added to project.
994 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
996 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
998 * docs/dev/policies.txt: Added to project (extracted from
999 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1001 * docs/dev/release.txt: Added to project (extracted from
1002 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1004 * docs/dev/testing.txt: Added to project.
1006 * docs/dev/website.txt: Added to project (extracted from
1007 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1009 * docs/ref/rst/directives.txt:
1011 - Added directives: "table", "csv-table".
1013 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1014 added to project. 1 page for syntax, and a 1 page reference for
1015 directives and roles. Source text to be used as-is; not meant to be
1018 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1019 with a change of title.
1021 * test/functional/, contents, and test/test_functional.py: Added to
1024 * tools/buildhtml.py: Fixed bug with config file handling.
1026 * tools/html.py: Removed from project (duplicate of rst2html.py).
1028 * tools/pep2html.py: Removed from project (duplicate of Python's
1029 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1030 Docutils-related PEPs in docs/peps/).
1032 * tools/rst2pseudoxml.py: Renamed from publish.py.
1034 * tools/rst2xml.py: Renamed from docutils-xml.py.
1036 * tools/test.txt: Removed from project; moved to
1037 docs/user/rst/demo.txt.
1039 * setup.py: Now also installs ``rst2latex.py``.
1042 Release 0.3.3 (2004-05-09)
1043 ==========================
1045 * docutils/__init__.py:
1047 - 0.3.1: Reorganized config file format (multiple sections); see
1049 - Added unknown_reference_resolvers attribute to TransformSpec.
1050 - 0.3.2: Interpreted text reorganization.
1055 - Catch system messages to stop tracebacks from parsing errors.
1056 - Catch exceptions during processing report & exit without
1057 tracebacks, except when "--traceback" used.
1058 - Reordered components for OptionParser; application comes last.
1059 - Added "config_section" parameter to several methods and functions,
1060 allowing front ends to easily specify their config file sections.
1061 - Added publish_parts convenience function to allow access to individual
1062 parts of a document.
1064 * docutils/examples.py: Added to project; practical examples of
1065 Docutils client code, to be used as-is or as models for variations.
1067 * docutils/frontend.py:
1069 - Added "--traceback" & "--no-traceback" options ("traceback"
1071 - Implemented support for config file reorganization:
1072 ``standard_config_files`` moved from ``ConfigParser`` to
1073 ``OptionParser``; added
1074 ``OptionParser.get_config_file_settings()`` and
1075 ``.get_standard_config_settings()``; support for old "[options]"
1076 section (with deprecation warning) and mapping from old to new
1078 - Reimplemented setting validation.
1079 - Enabled flexible boolean values: yes/no, true/false, on/off.
1080 - Added ``Values``, a subclass of ``optparse.Values``, with support
1081 for list setting attributes.
1082 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1083 thanks to Beni Cherniavsky.
1084 - Added "--no-section-numbering" option.
1088 - Catch IOErrors when opening source & destination files, report &
1089 exit without tracebacks. Added ``handle_io_errors`` parameter to
1090 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1092 * docutils/nodes.py:
1094 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1095 method definitions (via ``exec``) to dynamic assignments (via
1096 ``setattr``); thanks to Roman Suzi.
1097 - Encapsulated visitor dynamic assignments in a function; thanks to
1099 - Added indirect_reference_name attribute to the Targetable
1100 class. This attribute holds the whitespace_normalized_name
1101 (contains mixed case) of a target.
1103 * docutils/statemachine.py:
1105 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1106 - Added ``StringList.get_2D_block``.
1108 * docutils/utils.py:
1110 - Added "level" attribute to SystemMessage exceptions.
1112 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1115 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1118 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1119 Marcelo Huerta San Martin.
1121 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1122 mappings by Lalo Martins.
1124 * docutils/languages/ru.py: Added to project; Russian mappings by
1127 * docutils/parsers/rst/roles.py: Added to project. Contains
1128 interpreted text role functions, a registry for interpreted text
1129 roles, and an API for adding to and retrieving from the registry.
1130 Contributed by Edward Loper.
1132 * docutils/parsers/rst/states.py:
1134 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1135 - Allowed true em-dash character and "---" as block quote
1137 - Added support for <angle-bracketed> complex option arguments
1139 - Fixed handling of backslashes in substitution definitions.
1140 - Fixed off-by-1 error with extra whitespace after substitution
1141 definition directive.
1142 - Added inline markup parsing to field lists' field names.
1143 - Added support for quoted (and unindented) literal blocks.
1144 Driven in part by a bribe from Frank Siebenlist (thanks!).
1145 - Parser now handles escapes in URIs correctly.
1146 - Made embedded-URIs' reference text omittable. Idea from Beni
1148 - Refactored explicit target processing code.
1149 - Added name attribute to references containing the reference name only
1150 through whitespace_normalize_name (no case changes).
1151 - parse_target no longer returns the refname after going through
1152 normalize_name. This is now handled in make_target.
1153 - Fixed bug relating to role-less interpreted text in non-English
1155 - Reorganized interpreted text processing; moved code into the new
1156 roles.py module. Contributed by Edward Loper.
1157 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1158 ``parse_directive_block``.
1160 * docutils/parsers/rst/tableparser.py:
1162 - Reworked for ``StringList``, to support "include" directives in
1165 * docutils/parsers/rst/directives/__init__.py:
1167 - Renamed ``unchanged()`` directive option conversion function to
1168 ``unchanged_required``, and added a new ``unchanged``.
1169 - Catch unicode value too high error; fixes bug 781766.
1170 - Beefed up directive error reporting.
1172 * docutils/parsers/rst/directives/body.py:
1174 - Added basic "table" directive.
1176 * docutils/parsers/rst/directives/images.py:
1178 - Added "target" option to "image" directive.
1179 - Added name attribute to references containing the reference name only
1180 through whitespace_normalize_name (no case changes).
1182 * docutils/parsers/rst/directives/misc.py:
1184 - Isolated the import of the ``urllib2`` module; was causing
1185 problems on SourceForge (``libssl.so.2`` unavailable?).
1186 - Added the "role" directive for declaring custom interpreted text
1189 * docutils/parsers/rst/directives/parts.py:
1191 - The "contents" directive does more work up-front, creating the
1192 "topic" and "title", and leaving the "pending" node for the
1193 transform. Allows earlier reference resolution; fixes subtle bug.
1195 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1196 mappings by Jannie Hofmeyr.
1198 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1199 mappings by Marek Blaha.
1201 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1202 mappings by Marcelo Huerta San Martin.
1204 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1205 Portuguese mappings by Lalo Martins.
1207 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1208 mappings by Roman Suzi.
1210 * docutils/transforms/parts.py:
1212 - The "contents" directive does more work up-front, creating the
1213 "topic" and "title", and leaving the "pending" node for the
1214 transform. Allows earlier reference resolution; fixes subtle bug.
1215 - Added support for disabling of section numbering.
1217 * docutils/transforms/references.py:
1219 - Verifying that external targets are truly targets and not indirect
1220 references. This is because we are now adding a "name" attribute to
1221 references in addition to targets. Note sure if this is correct!
1222 - Added code to hook into the unknown_reference_resolvers list for a
1223 transformer in resolve_indirect_target. This allows the
1224 unknown_reference_resolvers to keep around indirect targets which
1225 docutils doesn't know about.
1226 - Added specific error message for duplicate targets.
1228 * docutils/transforms/universal.py:
1230 - Added FilterMessages transform (removes system messages below the
1231 verbosity threshold).
1232 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1233 to FinalCheckVisitor for application-specific handling of
1234 unresolvable references.
1235 - Added specific error message for duplicate targets.
1237 * docutils/writers/__init__.py:
1239 - Added assemble_parts method to the Writer class to allow for
1240 access to a documents individual parts.
1241 - Documented & set default for ``Writer.output`` attribute.
1243 * docutils/writers/html4css1.py:
1245 - Fixed unicode handling of attribute values (bug 760673).
1246 - Prevent duplication of "class" attribute values (bug report from
1248 - Improved table grid/border handling (prompted by report from Bob
1250 - Added support for table titles.
1251 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1253 - Added functionality to keep track of individual parts of a document
1254 and store them in a dictionary as the "parts" attribute of the writer.
1255 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1256 - Added proper support for the "scale" attribute of the "image"
1257 element. Contributed by Brent Cook.
1258 - Added ``--initial-header-level`` option.
1259 - Fixed bug: the body_pre_docinfo segment depended on there being a
1260 docinfo; if no docinfo, the document title was incorporated into
1261 the body segment. Adversely affected the publish_parts interface.
1263 * docutils/writers/latex2e.py:
1265 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1266 about a missing file.
1267 - Added options and support: ``--compound-enumerators``,
1268 ``--section-prefix-for-enumerators``, and
1269 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1271 - Added option ``--use-verbatim-when-possible``, to avoid
1272 problematic characters (eg, '~' in italian) in literal blocks.
1273 - It's now possible to use four section levels in the `book` and
1274 `report` LaTeX classes. The default `article` class still has
1277 * docs/config.txt: "Docutils Configuration Files", added to project.
1278 Moved config file entry descriptions from tools.txt.
1282 - Moved config file entry descriptions to config.txt.
1284 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1287 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1288 Text Roles", added to project.
1290 * spec/rst/reStructuredText.txt:
1292 - Added description of support for <angle-bracketed> complex option
1293 arguments to option lists.
1294 - Added subsections for indented and quoted literal blocks.
1296 * test: Continually adding & updating tests.
1298 - Added test/test_settings.py & test/data/config_*.txt support
1300 - Added test/test_writers/test_htmlfragment.py.
1302 * test/DocutilsTestSupport.py:
1304 - Refactored LaTeX publisher test suite/case class names to make
1305 testing other writers easier.
1306 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1307 to test the processing of HTML fragments which use the new
1308 publish_parts convenience function.
1310 * tools/buildhtml.py:
1312 - Added support for the "--prune" option.
1313 - Removed dependency on pep2html.py; plaintext PEPs no longer
1316 * tools/docutils.conf:
1318 - Updated for configuration file reorganization.
1320 * tools/rst2html.py:
1322 - copied from tools/html.py
1326 - added a 'scripts' section to configuration
1327 - added 'tools/rst2html.py' to the scripts section
1330 Release 0.3 (2003-06-24)
1331 ========================
1335 * Renamed "attribute" to "option" for directives/extensions.
1337 * Renamed transform method "transform" to "apply".
1339 * Renamed "options" to "settings" for runtime settings (as set by
1340 command-line options). Sometimes "option" (singular) became
1341 "settings" (plural). Some variations below:
1343 - document.options -> document.settings (stored in other objects as
1345 - option_spec -> settings_spec (not directives though)
1346 - OptionSpec -> SettingsSpec
1347 - cmdline_options -> settings_spec
1348 - relative_path_options -> relative_path_settings
1349 - option_default_overrides -> settings_default_overrides
1350 - Publisher.set_options -> Publisher.get_settings
1354 * COPYING.txt: Added "Public Domain Dedication".
1356 * FAQ.txt: Frequently asked questions, added to project.
1360 - Updated with PyPI Trove classifiers.
1361 - Conditional installation of third-party modules.
1363 * docutils/__init__.py:
1365 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1366 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1367 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1368 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1369 option and its effect on the PEP template & writer.
1370 - Bumped version to 0.2.4 due to changes to the PEP template &
1372 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1373 - Added ``TransformSpec`` class for new transform system.
1374 - Bumped version to 0.2.6 for API changes (renaming).
1375 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1376 convenience functions.
1377 - Added ``Component.component_type`` attribute.
1378 - Bumped version to 0.2.8 because of the internal parser switch from
1379 plain lists to the docutils.statemachine.StringList objects.
1380 - Bumped version to 0.2.9 because of the frontend.py API changes.
1381 - Bumped version to 0.2.10 due to changes to the project layout
1382 (third-party modules removed from the "docutils" package), and
1383 signature changes in ``io.Input``/``io.Output``.
1384 - Changed version to 0.3.0 for release.
1388 - Made ``publish()`` a bit more convenient.
1389 - Generalized ``Publisher.set_io``.
1390 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1391 parameters; improved its docstring.
1392 - Added ``publish_file()`` and ``publish_string()``.
1393 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1395 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1396 "--dump-transforms" hidden options.
1397 - Added ``Publisher.apply_transforms()`` method.
1398 - Added ``Publisher.set_components()`` method; support for
1399 ``publish_*()`` conveninece functions.
1400 - Moved config file processing to docutils/frontend.py.
1401 - Added support for exit status ("exit_level" setting &
1402 ``enable_exit`` parameter for Publisher.publish() and convenience
1405 * docutils/frontend.py:
1407 - Check for & exit on identical source & destination paths.
1408 - Fixed bug with absolute paths & "--config".
1409 - Set non-command-line defaults in ``OptionParser.__init__()``:
1410 ``_source`` & ``_destination``.
1411 - Distributed ``relative_path_settings`` to components; updated
1412 ``OptionParser.populate_from_components()`` to combine it all.
1413 - Require list of keys in ``make_paths_absolute`` (was implicit in
1414 global ``relative_path_settings``).
1415 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1416 "--dump-settings", and "--dump-transforms" hidden options.
1417 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1418 code, replaced with correct code.
1419 - Added validation functionality for config files.
1420 - Added "--error-encoding" option/setting, "_disable_config"
1422 - Added encoding validation; updated "--input-encoding" and
1423 "--output-encoding"; added "--error-encoding-error-handler" and
1424 "--output-encoding-error-handler".
1425 - Moved config file processing from docutils/core.py.
1426 - Updated ``OptionParser.populate_from_components`` to handle new
1427 ``SettingsSpec.settings_defaults`` dict.
1428 - Added support for "-" => stdin/stdout.
1429 - Added "exit_level" setting ("--exit" option).
1433 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1434 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1435 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1436 - ``FileOutput.write()`` now returns the encoded output string.
1437 - Try to get path/stream name automatically in ``FileInput`` &
1439 - Added defaults for source & destination paths.
1440 - Allow for Unicode I/O with an explicit "unicode" encoding.
1441 - Added ``Output.encode()``.
1442 - Removed dependency on runtime settings; pass encoding directly.
1443 - Recognize Unicode strings in ``Input.decode()``.
1444 - Added support for output encoding error handlers.
1446 * docutils/nodes.py:
1448 - Added "Invisible" element category class.
1449 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1450 modification during a traversal.
1451 - Added element classes: ``line_block``, ``generated``, ``address``,
1452 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1453 ``superscript``, ``subscript``, ``inline``
1454 - Added support for lists of nodes to ``Element.insert()``.
1455 - Fixed parent linking in ``Element.replace()``.
1456 - Added new abstract superclass ``FixedTextElement``; adds
1457 "xml:space" attribute.
1458 - Added support for "line" attribute of ``system_message`` nodes.
1459 - Added support for the observer pattern from ``utils.Reporter``.
1460 Added ``parse_messages`` and ``transform_messages`` attributes to
1461 ``document``, removed ``messages``. Added ``note_parse_message``
1462 and ``note_transform_message`` methods.
1463 - Added support for improved diagnostics:
1465 - Added "document", "source", and "line" internal attributes to
1466 ``Node``, set by ``Node.setup_child()``.
1467 - Converted variations on ``node.parent = self`` to
1468 ``self.setup_child(node)``.
1469 - Added ``document.current_source`` & ``.current_line``
1470 attributes, and ``.note_source`` observer method.
1471 - Changed "system_message" output to GNU-Tools format.
1473 - Added a "rawsource" attribute to the ``Text`` class, for text
1474 before backslash-escape resolution.
1475 - Support for new transform system.
1476 - Reworked ``pending`` element.
1477 - Fixed XML DOM bug (SF #660611).
1478 - Removed the ``interpeted`` element class and added
1479 ``title_reference``, ``abbreviation``, ``acronym``.
1480 - Made substitutions case-sensitive-but-forgiving; moved some code
1482 - Fixed Unicode bug on element attributes (report: William Dode).
1484 * docutils/optik.py: Removed from project; replaced with
1485 extras/optparse.py and extras/textwrap.py. These will be installed
1486 only if they're not already present in the Python installation.
1488 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1489 only if it's not already present in the Python installation.
1491 * docutils/statemachine.py:
1493 - Factored out ``State.add_initial_transitions()`` so it can be
1495 - Converted whitespace-specific "blank" and "indent" transitions
1496 from special-case code to ordinary transitions: removed
1497 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1498 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1499 ``ws_initial_transitions`` attributes.
1500 - Removed ``State.match_transition()`` after merging it into
1502 - Added ``StateCorrection`` exception.
1503 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1504 (moved ``TransitionCorrection`` support there too.)
1505 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1506 ``EOFError`` instead of ``IndexError``.
1507 - Added ``State.no_match`` method.
1508 - Added support for the Observer pattern, triggered by input line
1510 - Added ``strip_top`` parameter to
1511 ``StateMachineWS.get_first_known_indented``.
1512 - Made ``context`` a parameter to ``StateMachine.run()``.
1513 - Added ``ViewList`` & ``StringList`` classes;
1514 ``extract_indented()`` becomes ``StringList.get_indented()``.
1515 - Added ``StateMachine.insert_input()``.
1516 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1517 thanks to) Fred Drake.
1519 * docutils/utils.py:
1521 - Added a ``source`` attribute to Reporter instances and
1522 ``system_message`` elements.
1523 - Added an observer pattern to ``utils.Reporter`` to keep track of
1525 - Fixed bugs in ``relative_path()``.
1526 - Added support for improved diagnostics.
1527 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1528 - Added support for encoding Reporter stderr output, and encoding
1530 - Reporter keeps track of the highest level system message yet
1533 * docutils/languages: Fixed bibliographic field language lookups.
1535 * docutils/languages/es.py: Added to project; Spanish mappings by
1536 Marcelo Huerta San Martin.
1538 * docutils/languages/fr.py: Added to project; French mappings by
1541 * docutils/languages/it.py: Added to project; Italian mappings by
1544 * docutils/languages/sk.py: Added to project; Slovak mappings by
1547 * docutils/parser/__init__.py:
1549 - Added ``Parser.finish_parse()`` method.
1551 * docutils/parser/rst/__init__.py:
1553 - Added options: "--pep-references", "--rfc-references",
1554 "--tab-width", "--trim-footnote-reference-space".
1556 * docutils/parsers/rst/states.py:
1558 - Changed "title under/overline too short" system messages from INFO
1559 to WARNING, and fixed its insertion location.
1560 - Fixed enumerated list item parsing to allow paragraphs & section
1561 titles to begin with enumerators.
1562 - Converted system messages to use the new "line" attribute.
1563 - Fixed a substitution reference edge case.
1564 - Added support for "--pep-references" and "--rfc-references"
1565 options; reworked ``Inliner`` code to make customization easier.
1566 - Removed field argument parsing.
1567 - Added support for short section title over/underlines.
1568 - Fixed "simple reference name" regexp to ignore text like
1569 "object.__method__"; not an anonymous reference.
1570 - Added support for improved diagnostics.
1571 - Reworked directive API, based on Dethe Elza's contribution. Added
1572 ``Body.parse_directive()``, ``.parse_directive_options()``,
1573 ``.parse_directive_arguments()`` methods.
1574 - Added ``ExtensionOptions`` class, to parse directive options
1575 without parsing field bodies. Factored
1576 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1577 ``ExtensionOptions``.
1578 - Improved definition list term/classifier parsing.
1579 - Added warnings for unknown directives.
1580 - Renamed ``Stuff`` to ``Struct``.
1581 - Now flagged as errors: transitions at the beginning or end of
1582 sections, empty sections (except title), and empty documents.
1583 - Updated for ``statemachine.StringList``.
1584 - Enabled recognition of schemeless email addresses in targets.
1585 - Added support for embedded URIs in hyperlink references.
1586 - Added backslash-escapes to inline markup end-string suffix.
1587 - Added support for correct interpreted text processing.
1588 - Fixed nested title parsing (topic, sidebar directives).
1589 - Added special processing of backslash-escaped whitespace (idea
1590 from David Abrahams).
1591 - Made substitutions case-sensitive-but-forgiving; moved some code
1592 to ``docutils.nodes``.
1593 - Added support for block quote attributions.
1594 - Added a kludge to work-around a conflict between the bubble-up
1595 parser strategy and short titles (<= 3 char-long over- &
1596 underlines). Fixes SF bug #738803 "infinite loop with multiple
1597 titles" submitted by Jason Diamond.
1598 - Added explicit interpreted text roles for standard inline markup:
1599 "emphasis", "strong", "literal".
1600 - Implemented "superscript" and "subscript" interpreted text roles.
1601 - Added initial support for "abbreviation" and "acronym" roles;
1603 - Added support for "--trim-footnote-reference-space" option.
1604 - Optional space before colons in directives & hyperlink targets.
1606 * docutils/parsers/rst/tableparser.py:
1608 - Fixed a bug that was producing unwanted empty rows in "simple"
1610 - Detect bad column spans in "simple" tables.
1612 * docutils/parsers/rst/directives: Updated all directive functions to
1615 * docutils/parsers/rst/directives/__init__.py:
1617 - Added ``flag()``, ``unchanged()``, ``path()``,
1618 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1619 directive option helper functions.
1620 - Added warnings for unknown directives.
1621 - Return ``None`` for missing directives.
1622 - Added ``register_directive()``, thanks to William Dode and Paul
1625 * docutils/parsers/rst/directives/admonitions.py:
1627 - Added "admonition" directive.
1629 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1630 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1631 "parsed-literal", "rubric", "epigraph", "highlights" and
1632 "pull-quote" directives.
1634 * docutils/parsers/rst/directives/images.py:
1636 - Added an "align" attribute to the "image" & "figure" directives
1637 (by Adam Chodorowski).
1638 - Added "class" option to "image", and "figclass" to "figure".
1640 * docutils/parsers/rst/directives/misc.py:
1642 - Added "include", "raw", and "replace" directives, courtesy of
1644 - Added "unicode" and "class" directives.
1646 * docutils/parsers/rst/directives/parts.py:
1648 - Added the "sectnum" directive; by Dmitry Jemerov.
1649 - Added "class" option to "contents" directive.
1651 * docutils/parsers/rst/directives/references.py: Added to project.
1652 Contains the "target-notes" directive.
1654 * docutils/parsers/rst/languages/__init__.py:
1656 - Return ``None`` from get_language() for missing language modules.
1658 * docutils/parsers/rst/languages/de.py: Added to project; German
1659 mappings by Engelbert Gruber.
1661 * docutils/parsers/rst/languages/en.py:
1663 - Added interpreted text roles mapping.
1665 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1666 mappings by Marcelo Huerta San Martin.
1668 * docutils/parsers/rst/languages/fr.py: Added to project; French
1669 mappings by William Dode.
1671 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1672 mappings by Nicola Larosa.
1674 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1675 mappings by Miroslav Vasko.
1677 * docutils/readers/__init__.py:
1679 - Added support for the observer pattern from ``utils.Reporter``, in
1680 ``Reader.parse`` and ``Reader.transform``.
1681 - Removed ``Reader.transform()`` method.
1682 - Added default parameter values to ``Reader.__init__()`` to make
1683 instantiation easier.
1684 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1686 * docutils/readers/pep.py:
1688 - Added the ``peps.TargetNotes`` transform to the Reader.
1689 - Removed PEP & RFC reference detection code; moved to
1690 parsers/rst/states.py as options (enabled here by default).
1691 - Added support for pre-acceptance PEPs (no PEP number yet).
1692 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1695 * docutils/readers/python: Python Source Reader subpackage added to
1696 project, including preliminary versions of:
1699 - moduleparser.py: Parser for Python modules.
1701 * docutils/transforms/__init__.py:
1703 - Added ``Transformer`` class and completed transform reform.
1704 - Added unknown_reference_resolvers list for each transformer. This list holds
1705 the list of functions provided by each component of the transformer that
1706 help resolve references.
1708 * docutils/transforms/frontmatter.py:
1710 - Improved support for generic fields.
1711 - Fixed bibliographic field language lookups.
1713 * docutils/transforms/misc.py: Added to project. Miscellaneous
1716 * docutils/transforms/parts.py:
1718 - Moved the "id" attribute from TOC list items to the references
1719 (``Contents.build_contents()``).
1720 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1721 - Added "class" attribute support to ``Contents``.
1723 * docutils/transforms/peps.py:
1725 - Added ``mask_email()`` function, updating to pep2html.py's
1727 - Linked "Content-Type: text/x-rst" to PEP 12.
1728 - Added the ``TargetNotes`` PEP-specific transform.
1729 - Added ``TargetNotes.cleanup_callback``.
1730 - Added title check to ``Headers``.
1732 * docutils/transforms/references.py:
1734 - Added the ``TargetNotes`` generic transform.
1735 - Split ``Hyperlinks`` into multiple transforms.
1736 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1737 - Added check for circular indirect references.
1738 - Made substitutions case-sensitive-but-forgiving.
1740 * docutils/transforms/universal.py:
1742 - Added support for the "--expose-internal-attributes" option.
1743 - Removed ``Pending`` transform classes & data.
1745 * docutils/writers/__init__.py:
1747 - Removed ``Writer.transform()`` method.
1749 * docutils/writers/docutils-xml.py:
1751 - Added XML and doctype declarations.
1752 - Added "--no-doctype" and "--no-xml-declaration" options.
1754 * docutils/writers/html4css1.py:
1756 - "name" attributes only on these tags: a, applet, form, frame,
1758 - Added "name" attribute to <a> in section titles for Netscape 4
1759 support (bug report: Pearu Peterson).
1760 - Fixed targets (names) on footnote, citation, topic title,
1761 problematic, and system_message nodes (for Netscape 4).
1762 - Changed field names from "<td>" to "<th>".
1763 - Added "@" to "@" encoding to thwart address harvesters.
1764 - Improved the vertical whitespace optimization; ignore "invisible"
1765 nodes (targets, comments, etc.).
1766 - Improved inline literals with ``<span class="pre">`` around chunks
1767 of text and `` `` for runs of spaces.
1768 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1769 ``self.docinfo`` segments.
1770 - Added support for "line_block", "address" elements.
1771 - Improved backlinks (footnotes & system_messages).
1772 - Improved system_message output.
1773 - Redefined "--stylesheet" as containing an invariant URL, used
1774 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1776 - Added "--footnote-references" option (superscript or brackets).
1777 - Added "--compact-lists" and "--no-compact-lists" options.
1778 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1779 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1780 - Improved field list rendering.
1781 - Added Docutils version to "generator" meta tag.
1782 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1783 - Improved layout of <pre> HTML source.
1784 - Fixed attribute typo on <colspec>.
1785 - Refined XML prologue.
1786 - Support for no stylesheet.
1787 - Removed "interpreted" element support.
1788 - Added support for "title_reference", "sidebar", "attribution",
1789 "rubric", and generic "admonition" elements.
1790 - Added "--attribution" option.
1791 - Added support for "inline", "subscript", "superscript" elements.
1792 - Added initial support for "abbreviation" and "acronym";
1795 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1799 - Double quotes in literal blocks (special treatment for de/ngerman).
1800 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1801 - Added "--attribution" option.
1802 - Right align attributions.
1804 * docutils/writers/pep_html.py:
1806 - Parameterized output encoding in PEP template.
1807 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1808 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1809 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1811 - Added an override on the "--footnote-references" option.
1812 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1813 - Added Docutils version to "generator" meta tag.
1814 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1818 - Added a "silent" setting for ``buildhtml.py``.
1819 - Added a "Getting Help" section.
1820 - Rearranged the structure.
1821 - Kept up to date, with new settings, command-line options etc.
1822 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1823 - Converted settings table into a definition list.
1825 * docs/rst/quickstart.txt:
1827 - Added a table of contents.
1828 - Added feedback information.
1829 - Added mention of minimum section title underline lengths.
1830 - Removed the 4-character minimum for section title underlines.
1832 * docs/rst/quickref.html:
1834 - Added a "Getting Help" section.
1835 - Added a style to make section title backlinks more subtle.
1836 - Added mention of minimum section title underline lengths.
1837 - Removed the 4-character minimum for section title underlines.
1839 * extras: Directory added to project; contains third-party modules
1840 that Docutils depends on (optparse, textwrap, roman). These are
1841 only installed if they're not already present.
1843 * licenses: Directory added to project; contains copies of license
1844 files for non-public-domain files.
1848 - Changed the focus. It's about DTD elements: structural
1849 relationships, semantics, and external (public) attributes. Not
1850 about the element class library.
1851 - Moved some implementation-specific stuff into ``docutils.nodes``
1853 - Wrote descriptions of all common attributes and parameter
1854 entities. Filled in introductory material.
1855 - Working through the element descriptions: 55 down, 37 to go.
1856 - Removed "Representation of Horizontal Rules" to
1857 spec/rst/alternatives.txt.
1859 * spec/docutils.dtd:
1861 - Added "generated" inline element.
1862 - Added "line_block" body element.
1863 - Added "auto" attribute to "title".
1864 - Changed content models of "literal_block" and "doctest_block" to
1866 - Added ``%number;`` attribute type parameter entity.
1867 - Changed ``%structural.elements;`` to ``%section.elements``.
1868 - Updated attribute types; made more specific.
1869 - Added "address" bibliographic element.
1870 - Added "line" attribute to ``system_message`` element.
1871 - Removed "field_argument" element; "field_name" may contain
1872 multiple words and whitespace.
1873 - Changed public identifier to docutils.sf.net.
1874 - Removed "interpreted" element; added "title_reference",
1875 "abbreviation", "acronym".
1876 - Removed "refuri" attribute from "footnote_reference" and
1877 "citation_reference".
1878 - Added "sidebar", "rubric", "attribution", "admonition",
1879 "superscript", "subscript", and "inline" elements.
1881 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1883 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1885 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1887 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1890 * spec/transforms.txt: Added to project.
1892 * spec/howto: Added subdirectory, for developer how-to docs.
1894 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1895 Elza, edited & extended by David Goodger.
1897 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1900 * spec/rst/alternatives.txt:
1902 - Added "Doctree Representation of Transitions" from
1904 - Updated "Inline External Targets" & closed the debate.
1905 - Added ideas for interpreted text syntax extensions.
1906 - Added "Nested Inline Markup" section.
1908 * spec/rst/directives.txt:
1910 - Added directives: "topic", "sectnum", "target-notes",
1911 "line-block", "parsed-literal", "include", "replace", "sidebar",
1912 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1914 - Formalized descriptions of directive details.
1915 - Added an "align" attribute to the "image" & "figure" directives
1916 (by Adam Chodorowski).
1917 - Added "class" options to "topic", "sidebar", "line-block",
1918 "parsed-literal", "contents", and "image"; and "figclass" to
1921 * spec/rst/interpreted.txt: Added to project. Descriptions of
1922 interpreted text roles.
1924 * spec/rst/introduction.txt:
1926 - Added pointers to material for new users.
1928 * spec/rst/reStructuredText.txt:
1930 - Disambiguated comments (just add a newline after the "::").
1931 - Updated enumerated list description; added a discussion of the
1932 second-line validity checking.
1933 - Updated directive description.
1934 - Added a note redirecting newbies to the user docs.
1935 - Expanded description of inline markup start-strings in non-markup
1937 - Removed field arguments and made field lists a generic construct.
1938 - Removed the 4-character minimum for section title underlines.
1939 - Clarified term/classifier delimiter & inline markup ambiguity
1941 - Added "Embedded URIs".
1942 - Updated "Interpreted Text" section.
1943 - Added "Character-Level Inline Markup" section.
1945 * test: Continually adding & updating tests.
1947 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1948 - Moved test/test_pep/ to test/test_readers/test_pep/.
1949 - Added test/test_readers/test_python/.
1950 - Added test/test_writers/ (Engelbert Gruber).
1954 - Made the ``locale.setlocale()`` calls in front ends
1957 * tools/buildhtml.py:
1959 - Added "--silent" option.
1960 - Fixed bug with absolute paths & "--config".
1961 - Updated for new I/O classes.
1962 - Added some exception handling.
1963 - Separated publishers' setting defaults; prevents interference.
1964 - Updated for new ``publish_file()`` convenience function.
1966 * tools/pep-html-template:
1968 - Allow for "--embed-stylesheet".
1969 - Added Docutils version to "generator" meta tag.
1970 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1971 - Conform to XHTML spec.
1973 * tools/pep2html.py:
1975 - Made ``argv`` a parameter to ``main()``.
1976 - Added support for "Content-Type:" header & arbitrary PEP formats.
1977 - Linked "Content-Type: text/plain" to PEP 9.
1978 - Files skipped (due to an error) are not pushed onto the server.
1979 - Updated for new I/O classes.
1980 - Added ``check_requirements()`` & ``pep_type_error()``.
1981 - Added some exception handling.
1982 - Updated for new ``publish_string()`` convenience function.
1983 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1985 * tools/quicktest.py:
1987 - Added "-V"/"--version" option.
1989 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1991 * tools/unicode2rstsubs.py: Added to project. Produces character
1992 entity files (reSructuredText substitutions) from the MathML master
1995 * tools/editors: Support code for editors, added to project. Contains
1996 ``emacs/restructuredtext.el``.
1998 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2000 - Added style for chunks of inline literals.
2001 - Removed margin for first child of table cells.
2002 - Right-aligned field list names.
2003 - Support for auto-numbered section titles in TOCs.
2004 - Increased the size of inline literals (<tt>) in titles.
2005 - Restored the light gray background for inline literals.
2006 - Added support for "line_block" elements.
2007 - Added style for "address" elements.
2008 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2009 - Improved field list rendering.
2010 - Vertical whitespace improvements.
2011 - Removed "a.target" style.
2013 * tools/stylesheets/pep.css:
2015 - Fixed nested section margins.
2016 - Other changes parallel those of ``../default.css``.
2019 Release 0.2 (2002-07-31)
2020 ========================
2024 - The word "component" was being used ambiguously. From now on,
2025 "component" will be used to mean "Docutils component", as in Reader,
2026 Writer, Parser, or Transform. Portions of documents (Table of
2027 Contents, sections, etc.) will be called "document parts".
2028 - Did a grand renaming: a lot of ``verylongnames`` became
2029 ``very_long_names``.
2030 - Cleaned up imports: no more relative package imports or
2031 comma-separated lists of top-level modules.
2032 - Added support for an option values object which carries default
2033 settings and overrides (from command-line options and library use).
2034 - Added internal Unicode support, and support for both input and
2036 - Added support for the ``docutils.io.IO`` class & subclasses.
2040 * docutils/__init__.py:
2042 - Added ``ApplicationError`` and ``DataError``, for use throughout
2044 - Added ``Component`` base class for Docutils components; implements
2045 the ``supports`` method.
2046 - Added ``__version__`` (thus, ``docutils.__version__``).
2050 - Removed many keyword parameters to ``Publisher.__init__()`` and
2051 ``publish()``; bundled into an option values object. Added
2052 "argv", "usage", "description", and "option_spec" parameters for
2053 command-line support.
2054 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2056 - Reworked I/O model for ``docutils.io`` wrappers.
2057 - Updated ``Publisher.set_options()``; now returns option values
2059 - Added support for configuration files (/etc/docutils.conf,
2060 ./docutils.conf, ~/.docutils).
2061 - Added ``Publisher.setup_option_parser()``.
2062 - Added default usage message and description.
2064 * docutils/frontend.py: Added to project; support for front-end
2065 (command-line) scripts. Option specifications may be augmented by
2066 components. Requires Optik (http://optik.sf.net/) for option
2067 processing (installed locally as docutils/optik.py).
2069 * docutils/io.py: Added to project; uniform API for a variety of input
2072 * docutils/nodes.py:
2074 - Added ``TreeCopyVisitor`` class.
2075 - Added a ``copy`` method to ``Node`` and subclasses.
2076 - Added a ``SkipDeparture`` exception for visitors.
2077 - Renamed ``TreePruningException`` from ``VisitorException``.
2078 - Added docstrings to ``TreePruningException``, subclasses, and
2080 - Improved docstrings.
2081 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2082 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2084 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2085 ``PreDecorative`` mixin.
2086 - Reworked the name/id bookkeeping; to ``document``, removed
2087 ``explicit_targets`` and ``implicit_targets`` attributes, added
2088 ``nametypes`` attribute and ``set_name_id_map`` method.
2089 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2091 - Added ``document.has_name()`` method.
2092 - Fixed DOM generation for list-attributes.
2093 - Added category class ``Labeled`` (used by footnotes & citations).
2094 - Added ``Element.set_class()`` method (sets "class" attribute).
2096 * docutils/optik.py: Added to project. Combined from the Optik
2097 package, with added option groups and other modifications. The use
2098 of this module is probably only temporary.
2100 * docutils/statemachine.py:
2102 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2103 - Added underscores to improve many awkward names.
2104 - In ``string2lines()``, changed whitespace normalizing translation
2105 table to regexp; restores Python 2.0 compatibility with Unicode.
2107 * docutils/urischemes.py:
2109 - Filled in some descriptions.
2110 - Added "shttp" scheme.
2112 * docutils/utils.py:
2114 - Added ``clean_rcs_keywords`` function (moved from
2115 docutils/transforms/frontmatter.py
2116 ``DocInfo.filter_rcs_keywords``).
2117 - Added underscores to improve many awkward names.
2118 - Changed names of Reporter's thresholds:
2119 warning_level -> report_level; error_level -> halt_level.
2120 - Moved ``utils.id()`` to ``nodes.make_id()``.
2121 - Added ``relative_path(source, target)``.
2123 * docutils/languages/de.py: German mappings; added to project. Thanks
2124 to Gunnar Schwant for the translations.
2126 * docutils/languages/en.py: Added "Dedication" bibliographic field
2129 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2132 * docutils/parsers/rst/states.py:
2134 - Added underscores to improve many awkward names.
2135 - Added RFC-2822 header support.
2136 - Extracted the inline parsing code from ``RSTState`` to a separate
2137 class, ``Inliner``, which will allow easy subclassing.
2138 - Made local bindings for ``memo`` container & often-used contents
2139 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2140 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2141 - Added ``MarkupMismatch`` exception; for late corrections.
2142 - Added ``-/:`` characters to inline markup's start string prefix,
2143 ``/`` to end string suffix.
2144 - Fixed a footnote bug.
2145 - Fixed a bug with literal blocks.
2146 - Applied patch from Simon Budig: simplified regexps with symbolic
2147 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2148 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2149 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2150 - Allowed non-ASCII in "simple names" (directive names, field names,
2152 - Converted ``Inliner.patterns.initial`` to be dynamically built
2153 from parts with ``build_regexp()`` function.
2154 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2155 - Updated docstrings.
2156 - Changed "table" to "grid_table"; added "simple_table" support.
2158 * docutils/parsers/rst/tableparser.py:
2160 - Changed ``TableParser`` to ``GridTableParser``.
2161 - Added ``SimpleTableParser``.
2162 - Refactored naming.
2164 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2165 a fallback language for directive names.
2167 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2168 directive to use a ``pending`` element, used only by HTML writers.
2170 * docutils/parsers/rst/directives/parts.py: Renamed from
2173 - Added "backlinks" attribute to "contents" directive.
2175 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2176 project by Adam Chodorowski.
2178 * docutils/readers/__init__.py: Gave Readers more control over
2179 choosing and instantiating Parsers.
2181 * docutils/readers/pep.py: Added to project; for PEP processing.
2183 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2184 requires a ``component`` parameter.
2186 * docutils/transforms/components.py: Added to project; transforms
2187 related to Docutils components.
2189 * docutils/transforms/frontmatter.py:
2191 - In ``DocInfo.extract_authors``, check for a single "author" in an
2192 "authors" group, and convert it to a single "author" element.
2193 - Added support for "Dedication" and generic bibliographic fields.
2195 * docutils/transforms/peps.py: Added to project; PEP-specific.
2197 * docutils/transforms/parts.py: Renamed from old components.py.
2199 - Added filter for `Contents`, to use alt-text for inline images,
2200 and to remove inline markup that doesn't make sense in the ToC.
2201 - Added "name" attribute to TOC topic depending on its title.
2202 - Added support for optional TOC backlinks.
2204 * docutils/transforms/references.py: Fixed indirect target resolution
2205 in ``Hyperlinks`` transform.
2207 * docutils/transforms/universal.py:
2209 - Changed ``Messages`` transform to properly filter out system
2210 messages below the warning threshold.
2211 - Added ``Decorations`` transform (support for ``--generator``,
2212 ``--date``, ``--time``, ``--source-link`` options).
2214 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2215 Engelbert Gruber's PDF writer.
2217 * docutils/writers/html4css1.py:
2219 - Made XHTML-compatible (switched to lowercase element & attribute
2220 names; empty tag format).
2221 - Escape double-dashes in comment text.
2222 - Improved boilerplate & modularity of output.
2223 - Exposed modular output in Writer class.
2224 - Added a "generator" meta tag to <head>.
2225 - Added support for the ``--stylesheet`` option.
2226 - Added support for ``decoration``, ``header``, and ``footer``
2228 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2229 translation table to regexp; restores Python 2.0 compatibility
2231 - Added the translator class as instance variable to the Writer, to
2232 make it easily subclassable.
2233 - Improved option list spacing (thanks to Richard Jones).
2234 - Modified field list output.
2235 - Added backlinks to footnotes & citations.
2236 - Added percentage widths to "<col>" tags (from colspec).
2237 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2238 "<span>" changed to "<var>".
2239 - Inline literals: "<code>" changed to "<tt>".
2240 - Many changes to optimize vertical space: compact simple lists etc.
2241 - Add a command-line options & directive attributes to control TOC
2242 and footnote/citation backlinks.
2243 - Added support for optional footnote/citation backlinks.
2244 - Added support for generic bibliographic fields.
2245 - Identify backrefs.
2246 - Relative URLs for stylesheet links.
2248 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2249 PEPs (subclass of ``html4css1.Writer``).
2251 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2253 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2254 of the Docutils internal doctree in XML.
2256 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2260 - Changed the title to "The Docutils Document Tree".
2261 - Added "Hyperlink Bookkeeping" section.
2263 * spec/docutils.dtd:
2265 - Added ``decoration``, ``header``, and ``footer`` elements.
2266 - Brought ``interpreted`` element in line with the parser: changed
2267 attribute "type" to "role", added "position".
2268 - Added support for generic bibliographic fields.
2270 * spec/notes.txt: Continual updates. Added "Project Policies".
2272 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2275 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2277 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2278 mailing list discussions.
2280 * spec/pep-0287.txt:
2282 - Renamed to "reStructuredText Docstring Format".
2284 - Reworked Q&A as an enumerated list.
2285 - Converted to reStructuredText format.
2287 * spec/pysource.dtd:
2289 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2291 * spec/pysource.txt: Removed from project. Moved much of its contents
2294 * spec/rst/alternatives.txt:
2296 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2297 - Added "Inline External Targets" section.
2299 * spec/rst/directives.txt:
2301 - Added "backlinks" attribute to "contents" directive.
2303 * spec/rst/problems.txt:
2305 - Updated the Enumerated List Markup discussion.
2306 - Added new alternative table markup syntaxes.
2308 * spec/rst/reStructuredText.txt:
2310 - Clarified field list usage.
2311 - Updated enumerated list description.
2312 - Clarified purpose of directives.
2313 - Added ``-/:`` characters to inline markup's start string prefix,
2314 ``/`` to end string suffix.
2315 - Updated "Authors" bibliographic field behavior.
2316 - Changed "inline hyperlink targets" to "inline internal targets".
2317 - Added "simple table" syntax to supplement the existing but
2318 newly-renamed "grid tables".
2319 - Added cautions for anonymous hyperlink use.
2320 - Added "Dedication" and generic bibliographic fields.
2322 * test: Made test modules standalone (subdirectories became packages).
2324 * test/DocutilsTestSupport.py:
2326 - Added support for PEP extensions to reStructuredText.
2327 - Added support for simple tables.
2328 - Refactored naming.
2330 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2332 - Now supports true packages containing test modules
2333 (``__init__.py`` files required); fixes duplicate module name bug.
2335 * test/test_pep/: Subpackage added to project; PEP testing.
2337 * test/test_rst/test_SimpleTableParser.py: Added to project.
2341 - Updated html.py and publish.py front-end tools to use the new
2342 command-line processing facilities of ``docutils.frontend``
2343 (exposed in ``docutils.core.Publisher``), reducing each to just a
2345 - Added ``locale.setlocale()`` calls to front-end tools.
2347 * tools/buildhtml.py: Added to project; batch-generates .html from all
2348 the .txt files in directories and subdirectories.
2350 * tools/default.css:
2352 - Added support for ``header`` and ``footer`` elements.
2353 - Added styles for "Dedication" topics (biblio fields).
2355 * tools/docutils.conf: A configuration file; added to project.
2357 * tools/docutils-xml.py: Added to project.
2359 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2361 * tools/pep-html-template: Added to project.
2363 * tools/pep2html.py: Added to project from Python (nondist/peps).
2364 Added support for Docutils (reStructuredText PEPs).
2366 * tools/quicktest.py:
2368 - Added the ``--attributes`` option, hacked a bit.
2369 - Added a second command-line argument (output file); cleaned up.
2371 * tools/stylesheets/: Subdirectory added to project.
2373 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2376 Release 0.1 (2002-04-20)
2377 ========================
2379 This is the first release of Docutils, merged from the now inactive
2380 reStructuredText__ and `Docstring Processing System`__ projects. For
2381 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2382 `DPS HISTORY`__ files.
2384 __ http://structuredtext.sourceforge.net/
2385 __ http://docstring.sourceforge.net/
2386 __ http://structuredtext.sourceforge.net/HISTORY.html
2387 __ http://docstring.sourceforge.net/HISTORY.html
2389 General changes: renamed 'dps' package to 'docutils'; renamed
2390 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2391 the test suites (reStructuredText's test/test_states renamed to
2392 test/test_rst); and all modifications required to make it all work.
2394 * docutils/parsers/rst/states.py:
2396 - Improved diagnostic system messages for missing blank lines.
2397 - Fixed substitution_reference bug.
2403 indent-tabs-mode: nil
2404 sentence-end-double-space: t