Provide fallbacks for parser config settings.
[docutils.git] / docutils / HISTORY.txt
blobd949170c4e0ffee3d87cdba4ce197cd7d1bbf5da
1 .. -*- coding: utf-8 -*-
3 ==================
4  Docutils History
5 ==================
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
9 :Date: $Date$
10 :Revision: $Revision$
11 :Web site: https://docutils.sourceforge.io/
12 :Copyright: This document has been placed in the public domain.
14 .. contents::
16 Changes Since 0.17
17 ==================
19 * manpage writer
21   - Apply patch #160: move macro defs above ``.TH``
22     (thanks Willie and sorry for the delay).
24 * docutils/parsers/*.py, docutils/transforms/*.py
26   - Provide fallbacks for parser config settings
27     to facilitate programmatic use.
29 Release 0.17 (2021-04-03)
30 =========================
32 * General
34   - Installing with ``setup.py`` now requires ``setuptools``.
35     Alternatively, install with `pip`_ (or "manually").
36   - Use importlib.import_module() to programmatically import modules.
37   - Fix bug #385: Import of language modules.
39   .. _pip: https://pypi.org/project/pip/
41 * docutils/MANIFEST.in
43   - Exclude test outputs.
45 * docutils/__init__.py
47   - VersionInfo: ValueError for invalid values, fix comparison to tuples.
49 * docutils/languages/
50   docutils/parsers/rst/languages/
52   - Apply patch # 177 Arabic mappings by Shahin.
53   - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
55 * docutils/nodes.py
57   - Apply patch #165 "Fix error when copying `system_message` node"
58     by Takeshi KOMIYA.
59   - Apply version of patch #167 "Let document.set_id() register all
60     existing IDs" (thanks to Takeshi KOMIYA).
61   - Fix bug #410: Use a "property" function to recursively fetch
62     `Node.document` value from parent node.
64 * docutils/parsers/recommonmark_wrapper.py
66   - New, experimental wrapper to integrate the
67     `recommonmark`__ Markdown parser for use with Docutils.
69     __ https://pypi.org/project/recommonmark/
71 * docutils/parsers/rst/directives/body.py
73   - Make the sidebar's "title" argument optional (feature request #69).
75 * docutils/parsers/rst/directives/html.py
77   - Make "meta" elements available for "latex" and "odt".
79 * docutils/parsers/rst/directives/misc.py
81   - Prevent infinite inclusion loops.
83 * docutils/parsers/rst/roles.py
85   - Apply patch #174 `Lowercase new role names on registration`
86     by John Thorvald Wodder II.
88 * docutils/utils/smartquotes.py
90   - Fix bug #383: Smart quotes around opening and separator characters.
92 * docutils/transforms/components.py
94   - Allow a comma-separated list of formats for the Filter transform.
96 * docutils/writers/html*
98   - Implement feature request #40 `Option to embed images as data URI`.
100 * docutils/writers/html5_polyglot/__init__.py
102   - Use the new semantic tags <main>, <section>, <header>,
103     <footer>, <aside>, <figure>, and <figcaption>.
104     See ``minimal.css`` and ``plain.css`` for styling rule examples.
106     Change the `initial_header_level` setting default to "2", as browsers
107     use the `same style for <h1> and <h2> when nested in a <section\>`__.
109     __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
111   - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
112     <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
113     is found in `inline` and `literal` elements.
114     Use <ins> and <del> if a matching class value
115     is found in `inline`, `literal`, or `container` elements.
116     Use <small> for generated code line numbers.
118   - Fix bug #398: properly close link tag to "schema.dcterms".
120   - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
122     __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
123     
124   - Use <video> for images with video MIME types supported by HTML5.
126 * docutils/writers/html5_polyglot/minimal.css
128   - Move non-essential styling to ``plain.css``.
129     Small fixes and tweaks.
130     
131   - Support "captionbelow" class value for tables.
132   
133   - Display code line numbers as pseudo-elements which are skipped
134     when copying text from code blocks. Solves feature request #32.
136 * docutils/writers/html5_polyglot/plain.css
138   - Support numbered figures.
140 * docutils/writers/html5_polyglot/responsive.css
142   - New optional style that adapts to different screen sizes.
144 * docutils/writers/latex2e/__init__.py:
146   - Use LaTeX environments for admonitions and "class wrappers" for styling
147     admonitions and titles if the new configuration setting
148     `legacy_class_functions`_ is False.
150     .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
152   - Remove backwards compatibility code for the deprecated
153     `styling command`__ prefix ``\docutilsrole``.
155     __ docs/user/latex.html#custom-interpreted-text-roles
157   - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
159   - Support the `memoir` LaTeX document class.
160     Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
162   - The special value "auto" for the `graphicx_option`_ setting
163     is no longer supported (it never worked for xetex/luatex).
165     .. _graphicx_option: docs/user/config.html#graphicx-option
167   - Most helper commands and element definitions are now defined in the
168     LaTeX package `docutils.sty`_ and only inserted in the document
169     preamble if the `stylesheet`__ setting does not list "docutils".
171     .. _docutils.sty: https://ctan.org/pkg/docutils
172     __ docs/user/config.html#stylesheet-latex-writers
174   - Apply patch #173 "Make \*TeX writers convert nonstandard table
175     classes to DUclass environments" by John Thorvald Wodder II.
177   - Fix bug #408 "Incorrect assert in latex writer
178     for multiple citation references".
180   - Apply patch #175 "Fix alignment of nested tables"
181     by John Thorvald Wodder II. Additional fixes to table alignment.
183   - Do not write Docutils-generated ToC, when ``use_latex_toc``
184     is True. (This did happen when publishing from a doctree.)
186   - Set PDF document properties from "meta" directive content.
188   - Apply version of patch #176 "LaTeX writer: Append \leavevmode to
189     non-docinfo field names" by John Thorvald Wodder II.
191 * docutils/writers/manpage.py
193   - Fix #394 fix missing new line after rubric.
194   - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
195   - Fix #126 manpage title with spaces.
196   - Fix #380 commandline option problem in sphinx.
198 * docutils/writers/odf_odt/__init__.py:
200   - Fix/improve metadata handling:
201     fix "keyword" splitting,
202     allow generic fields (stored as "Custom Properties").
204 * docutils/writers/pseudoxml.py:
206   - New option `detailled`__.
208     __ docs/user/config.html#detailled
210 * test/DocutilsTestSupport.py
212   - Run python3 test like python2 against source not the build/-directory
214 * tools/docutils-cli.py
216   - New generic command line front end that allows the free selection of
217     reader, parser, and writer components.
220 Release 0.16 (2020-01-16)
221 =========================
223 * General
225   - Dropped support for Python 2.6, 3.3 and 3.4
226   - Docutils now supports Python 2.7 and Python 3.5+ natively
227     (without conversion by ``2to3``).
228   - Keep `backslash escapes`__ in the document tree. Backslash characters in
229     text are be represented by NULL characters in the ``text`` attribute of
230     Doctree nodes and removed in the writing stage by the node's
231     ``astext()`` method.
233   __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
235 * docutils/io.py
237   - Remove the `handle_io_errors` option from io.FileInput/Output.
239 * docutils/nodes.py
241   - Speed up Node.next_node().
242   - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
243   - Warn about Node.traverse() returning an iterator instead of a list
244     in future.
246   .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
248 * docutils/statemachine.py
250   - Patch [ 158 ]: Speed up patterns by saving compiled versions (eric89gxl)
252 * docutils/transforms/universal.py
254   - Fix [ 332 ]: Standard backslash escape for smartquotes.
255   - Fix [ 342 ]: No escape in roles descending from `inline literal`.
257 * docutils/utils/__init__.py
259   - unescape() definition moved to `nodes` to avoid circular import
260     dependency. Fixes [ 366 ].
262 * docutils/writers/latex2e/__init__.py:
264   - Fix topic subtitle.
265   - Make "rubric" bold-italic and left aligned.
266   - Fix [ 339 ] don't use "alltt" or literal-block-environment
267     in admonitions and footnotes.
268   - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
269   - Add "latex writers" to the `config_section_dependencies`.
270   - Ignore classes for `rubric` elements
271     (class wrapper interferes with LaTeX formatting).
273 * docutils/writers/manpage.py
275   - Apply fix for [ 287 ] comma after option is bold.
276   - Apply fix for [ 289 ], line starting with ``.`` in a text.
278 * docutils/writers/odf_odt/__init__.py:
280   - Fix: ElementTree.getchildren deprecated warning
282 * docutils/writers/xetex/__init__.py:
284   - Add "latex writers" to the `config_section_dependencies`.
286 * test/alltests.py
288   - Fix: 377 ResourceWarning: unclosed file python3.8
289     Close alltests.out with atexit.
291 * test/functional/*
293   - Fix: 377 ResourceWarning: unclosed file python3.8
294     Read defaults file with context.
296   - Set "auto_id_prefix" to "%" (expands to tag-names).
297     Results in descriptive links in HTML and more localized changes when
298     editions to the input add or remove auto-ids.
300 * test/test_io.py:
302   - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
304 * test/test_writers/test_odt.py:
306   - Fix [ 359 ]: Test suite failes on Python 3.8. odt xml sorting.
307     Use ElementTree instead of minidom.
309 * tools/buildhtml.py
311   - New option `html-writer`_.
313   .. _html-writer: docs/user/config.html#html-writer
316 Release 0.15.1 (2019-07-24)
317 ===========================
319 source: branches/rel-0.15
321 Bugs #366 fix release for python2 only.
324 Release 0.15 (2019-07-20)
325 =========================
327 * General
329   - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
330   - Infrastructure automation.
332 * docs/ref/rst/restructuredtext.txt:
334   - Document rST syntax change: Tokens like ``:this:example:`` are now valid
335     field list names (instead of ordinary text).
337 * docutils/io.py
339   - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
340     deprecated (thanks to hugovk).
342 *  docutils/languages/ko.py
343    docutils/parsers/rst/languages/ko.py:
345   - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
347 * docutils/nodes.py
349   - Fix [ 251 ] system_message.copy() TypeError.
350   - Element.copy() also copies `document`, `line`, and `source` attributes.
352 * docutils/parsers/rst/__init__.py:
354   - Apply [ 152 ] reset `default role` at end of document.
356 * docutils/parsers/rst/states.py:
358   - Allow embedded colons in field list field names.
360 * docutils/parsers/rst/directives/html.py:
362   - Fix bug #281: Remove escaping backslashes in meta directive content.
364 * docutils/parsers/rst/directives/misc.py:
366   - Don't convert tabs to spaces, if `tab_width` is negative in
367     `include` directive with `code` option.
369 * docutils/parsers/rst/directives/tables.py:
371   - Apply patch #121: Add "width" option for the table directives.
373 * docutils/transforms/frontmatter.py:
375   - Add field name as class argument to generic docinfo fields unconditionally.
377 * docutils/transforms/references.py:
379   - Fix bug #331: fixed the "trim" options of the "unicode" directive.
381 * docutils/utils/__init__.py:
383   - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
385 * docutils/utils/smartquotes.py:
387   - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
389 * docutils/writers/html5_polyglot/
391   - automatically add HTML5-compatible meta tags for docinfo items
392     "authors", "date", and "copyright".
394 * docutils/writers/_html_base.py
396   - Fix bug #358: Non-breaking space removed from fixed-width literal.
398 * docutils/writers/latex2e/__init__.py:
400   - Fix bug #323: spurious ``\phantomsection`` and whitespace in
401     ``parts['title']``.
402   - Fix bug #324: Invalid LaTeX for table with empty multicolumn cell.
403   - Fixes to literal block handling.
406 Release 0.14 (2017-08-03)
407 =========================
409 * docs/ref/docutils.dtd:
411   - Enable validation of Docutils XML documents against the DTD:
413     Use attribute type NMTOKEN instead of REFID for the `refid` attribute
414     and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
415     however, the `ids` attribute cannot use the ID type because `XML only
416     allows one ID per Element Type`__ and doesn't support a multiple-ID
417     "IDS" attribute type.
419   __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
421 * docs/ref/rst/restructuredtext.txt:
423   - Added documentation for escaped whitespace in URI contexts.
424   - Clarify use of Unicode character categories.
426 * docutils/parsers/rst/states.py:
428   - Added functionality: escaped whitespace in URI contexts.
429   - Consistent handling of all whitespace characters in inline markup
430     recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
432 * docutils/parsers/rst/directives/images.py:
434   - Added support for escaped whitespace in URI contexts.
436 * docutils/parsers/rst/directives/tables.py:
438   - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
439     that led to problems in an application with a custom table directive).
441 * docutils/transforms/frontmatter.py:
443   - Fix [ 320 ] Russian docinfo fields not recognized.
445 * docutils/transforms/references.py:
447   - Don't add a second ID to problematic references.
449 * docutils/transforms/universal.py:
451   Fix SmartQuotes: warn only once if language is unsupported,
452   keep "rawsource" when "educating" quotes.
454 * docutils/utils/__init__.py:
456   - Added ``split_escaped_whitespace`` function, support for escaped
457     whitespace in URI contexts.
459 * docutils/utils/error_reporting.py:
461   - Fix [ 321 ] Import block might cause name error.
463 * docutils/utils/smartquotes.py:
465   - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
466   - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
467   - Fix [ 313 ] Differentiate apostrophe from closing single quote
468     (if possible).
469   - Fix [ 317 ] Extra space inserted with French smartquotes.
470   - Add command line interface for stand-alone use (requires 2.7).
472 * docutils/writers/_html_base.py:
474   - Provide default title in metadata (required by HTML5).
475   - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
476   - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
477     reasons, we don't use a third party public installation as default but
478     warn if math-output_ is set to MathJax without specifying a URL.
480 * docutils/writers/html4css1/__init__.py:
482   - Apply [ 125 ] HTML writer: respect automatic table column sizing.
484 * docutils/writers/latex2e/__init__.py:
486   - Handle class arguments for block-level elements by wrapping them
487     in a "DUclass" environment. This replaces the special handling for
488     "epigraph" and "topic" elements.
490 * docutils/writers/manpage.py:
492   - Apply [ 141 ] Handling inline in manpage writer.
494 * docutils/writers/odf_odt/__init__.py:
496   - Command setting ``language`` now sets the default language
497     of the generated ODF document.
498   - The use of image directive options :width: (%), :scale:, etc now
499     set the width/height/size of images in the generated ODF
500     documents.
501   - The heading/title of admonitions now reflects the language
502     specified by the ``language`` setting.
503   - Fixed [ 306 ] only first of multiple "image" directives with the same URL
504     shown in output.
505   - Fixed [ 282 ] python3: AttributeError.
507 * tools/rst2html4.py: New front-end.
509 * tools/dev/generate_punctuation_chars.py: New skript
510   to test and update utils.punctuation_chars.
513 Release 0.13.1 (2016-12-09)
514 ===========================
516 * docutils/languages/fa.py
517   docutils/parsers/rst/languages/fa.py
518   docutils/languages/la.py
519   docutils/parsers/rst/languages/la.py:
521   - Apply [ 133 ] Persian mappings by Shahin Azad.
522   - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
524 * docutils/nodes.py
526   - Fix [ 253 ] Attribute key without value not allowed in XML.
528 * docutils/parsers/
530   - Apply [ 103 ] Recognize inline markups without word boundaries.
531   - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
533 * docutils/parsers/rst/__init__.py
535   - Fix [ 233 ] Change the base URL for the :rfc: role.
537 * docutils/parsers/rst/directives/tables.py
539   - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
540     or 'grid'.
542   - Implement feature request [ 48 ]
543     Add :align: option to the table directives.
544     Thanks to Takeshi KOMIYA for the patch.
546 * docutils/parsers/rst/roles.py
548   - Fix [ 295 ] Class argument for custom role inheriting from math.
550 * docutils/parsers/rst/tableparser.py
552   - Really fix [ 159 ] Spurious table column alignment errors.
554 * docutils/transforms/frontmatter.py
556   - Add name of generic bibliographic fields as a "classes" attribute value
557     (after conversion to a valid identifier form).
559 * docutils/utils/error_reporting.py
561   - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
563 * docutils/utils/math/math2html.py
565   - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
566   - New upstream version (additional macros, piecewise integrals and sums).
568 * docutils/writers/_html_base.py
570   - New auxiliary module for definitions common to all HTML writers.
572 * docutils/writers/html5_polyglot/
574   - New HTML writer generating clean, polyglot_ markup conforming to
575     `HTML 5`_.
577     The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
578     and recommended layout rules.
580 * docutils/writers/html4css1/__init__.py
582   - Add "docutils" to class values for "container" object to address [ 267 ].
583   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
584     ``default_stylesheet_path`` and ``default_template_path``.
585   - Fix [ 266 ] creating labels/class values in description list items.
586   - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
587   - Fix footnotes with content that does not start with a paragraph.
588   - Use https in default MathJax URL (report Alan G Isaac).
589   - Outsourcing of common code to _html_base.py.
591 * docutils/writers/latex2e/__init__.py
593   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
594     admonitions and docinfo.
596   - Use absolute path for ``default_template_path``.
598   - Removed deprecated options ``--use-latex-footnotes`` and
599     ``--figure-footnotes``.
601   - Cleaner LaTeX code for enumerations and literal blocks.
603   - Use "hyperref" package together with "bookmark" (improved hyperlinking
604     by the same author).
606   - Fix [ 286 ] Empty column title cause invalid latex file.
608   - Fix [ 224 ] Fix rowspan support for tables.
610   - Let LaTeX determine the column widths in tables with "colwidths-auto".
611     Not suited for multi-paragraph cells!
613 * docutils/writers/odf_odt/__init__.py
615   - remove decode.encode of filename stored in zip.
617 * docutils/writers/xetex/__init__.py
619   - LuaLaTex compatibility: do not load "xunicode".
621 * tools/
623   - New front-end ``rst2html5.py``.
625 * tox.ini
627   - Test py26, py27, py33 and py34.
629     To use, install the ``tox`` package via pip or easy_install and use
630     tox from the project root directory.
632 .. _polyglot: http://www.w3.org/TR/html-polyglot/
633 .. _HTML 5: http://www.w3.org/TR/html5/
634 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
637 Release 0.12 (2014-07-06)
638 =========================
640 * docs/ref/rst/directives.txt
642   - Update "math" and "csv-table" descriptions.
644 * docutils/parsers/rst/directives/images.py
646   - Fix [ 258 ] figwidth="image" generates unitless width value.
648 * docutils/parsers/rst/states.py
650   - Improve error report when a non-ASCII character is specified as
651     delimiter, quote or escape character under Python 2.
652     Fixes [ 249 ] and [ 250 ].
654 * docutils/writers/html4css1/__init__.py
656   - Don't add newline after inline math.
657     Thanks to Yury G. Kudryashov for the patch.
659 * docutils/writers/latex2e/__init__.py
661   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
662   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
664 * docutils/writers/odf_odt/__init__.py
666   - Apply patch by Jakub Wilk to fix bug [ 100 ].
668 * test/test_error_reporting.py
670   - Fix [ 223 ] by removing redundant tests we do not have control over.
672 * test/test_nodes.py
674   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
676 Release 0.11 (2013-07-22)
677 =========================
679 * General
681   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
682   - Support embedded aliases within hyperlink references.
683   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
684     language module) before global search.
686 * docutils/nodes.py
688   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
690 * docutils/parsers/rst/directives/__init__.py
692   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
694 * docutils/parsers/rst/directives/images.py
696   - Apply [ 3599485 ] node source/line information for sphinx translation.
698 * docutils/parsers/rst/directives/tables.py
700   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
702 * docutils/parsers/rst/states.py
704   - Fix [ 157 ] Line block parsing doesn't like system message.
705   - Always import our local copy of roman.py (report Larry Hastings).
707 * docutils/transforms/references.py
709   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
711 * docutils/utils/__init__.py
713   - Fix [ 3596884 ] exception importing ``docutils.io``.
715 * docutils/writers/html4css1/__init__.py
717   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
718   - New setting `stylesheet_dirs`: Comma-separated list of directories
719     where stylesheets are found. Used by `stylesheet_path` when expanding
720     relative path arguments.
721   - New default for math-output_: ``HTML math.css``.
722   - Avoid repeated class declarations in html4css1 writer
723     (modified version of patch [ 104 ]).
725 .. _math-output: docs/user/config.html#math-output
727 * docutils/writers/latex2e/__init__.py
729   - Drop the simple algorithm replacing straight double quotes with
730     English typographic ones.
731     Activate the SmartQuotes_ transform if you want this feature.
732   - Fix literal use of babel shorthands (straight quote, tilde, ...).
733   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
734   - New setting `stylesheet_dirs`.
736 .. _SmartQuotes: docs/user/config.html#smart-quotes
738 * docutils/writers/manpage.py
740   - Fix [3607063] handle lines starting with a period.
741   - Fix option separating comma was bold (thanks to Bill Morris).
743 Release 0.10 (2012-12-16)
744 =========================
746 * General
748   - Dropped support for Python 2.3.
749   - ``docutils/math``, ``docutils/error_reporting.py``, and
750     ``docutils/urischemes.py`` moved to the utils package.
751   - Fix [3541369] Relative __import__ also with Python 3.3.
752   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
753     and parsers for Python 2.7 up.
754   - Fix import of PIL.Image.
755   - Change default of "syntax highlight" option to "long",
756     basic syntax highlight styles for LaTeX and HTML.
758 * docutils/io.py
760   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
761     option is ignored and will be removed in a future release.
762   - Fix Py3k error writing to stdout with encoding differing from default.
763   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
765 * docutils/parsers/rst/directives/misc.py
767   - Fix [ 3546533 ] Unicode error with `date` directive.
769 * docutils/transforms/universal.py
771   - SmartQuotes transform for typographic quotes and dashes.
773 * docutils/utils/__init__.py
775   - normalize_language_tag() now returns `BCP 47`_ conformant tags
776     with subtags separated by ``-``.
778 * docutils/writers/html4css1/__init__.py
780   - Use ``<code>`` tag for inline "code",
781     do not drop nested inline nodes (syntax highlight tokens).
782   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
783   - No line break after opening inline math tag.
785 * docutils/writers/manpage.py
787   - Apply [ 3527401 ] addmonition's don't preserve indentation
788   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
790 * docutils/writers/xetex/__init__.py
792   - Apply [ 3555160 ] ensure order of "otherlanguages".
793   - Fix section numbering by LaTeX.
795 * docutils/writers/s5_html/__init__.py
797   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
799 * docutils/writers/s5_html/docutils_xml.py
801   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
802   - Fix/improve output with ``--indent`` option.
804 * setup.py
806   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
808 * tools/test/test_buildhtml.py
810   - Fix [ 3521167 ] allow running in any directory.
811   - Fix [ 3521168 ] allow running with Python 3.
814 Release 0.9.1 (2012-06-17)
815 ==========================
817 * setup.py
819   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
820     installed in the PYTHONPATH. Converted tests are now
821     stored in ``test3/``, tools no longer need conversion.
823     If you installed one of Docutils versions 0.7 ... 0.9 with
824     ``setup.py install`` under Python 3, remove the spurious
825     ``test/`` and ``tools/`` directories in the site library root.
827 * test/
829   - Make tests independent from the location of the ``test/`` directory.
830   - Use converted sources (from the ``build/`` directory) for tests under
831     Python 3.
833 * tools/
835   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
837 * docutils/io.py
839   - Fix writing binary data to sys.stdout under Python 3 (allows
840     ``rst2odt.py`` to be used with output redirection).
842 * docutils/parsers/rst/directives/misc.py
844   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
845     ``locale == C`` and 8-bit char in path argument of `include` directive.
847 * test/alltests.py
849   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
850     file under Python 3.
852 Release 0.9 (2012-05-02)
853 ========================
855 * General:
857   - New reStructuredText "code" role and directive and "code" option
858     of the "include" directive with syntax highlighting by Pygments_.
859   - Fix parse_option_marker for option arguments containing ``=``.
860   - Fix [ 2993756 ]: import Python Imaging Library's Image module
861     via ``import PIL`` as starting with PIL 1.2,
862     "PIL lives in the PIL namespace only" (announcement__).
864 .. _Pygments: http://pygments.org/
865 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
867 * setup.py
869   - Fix [ 2971827 ] and [ 3442827 ]
870     extras/roman.py moved to docutils/utils/roman.py
872 * docutils/frontend.py
874   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
876 * docutils/io.py
878   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
879   - `mode` argument for FileOutput avoids code replication in
880     BinaryFileOutput.
881   - New exceptions InputError and OutputError for IO errors in
882     FileInput/FileOutput.
884 * docutils/core.py:
886   - No "hard" system exit on file IO errors: catch and report them in
887     `Publisher.reportException` instead. Allows handling by a calling
888     application if the configuration setting `traceback` is True.
890 * docutils/utils.py -> docutils/utils/__init__.py
892   - docutils.utils is now a package (providing a place for sub-modules)
894   .. note:: docutils/math, docutils/error_reporting.py, and
895      docutils/urischemes.py will move to the utils package in the next
896      release, too. See RELEASE-NOTES__
898      __ RELEASE-NOTES.html
900   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
901     errors recording non-ASCII filenames (fixes [ 3434355 ]).
903   - Fix relative_path() with source=None and `unicode` target.
905 * docutils/parsers/rst/states.py
907   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
908     characters and "international" quotes around inline markup.
909   - Use `field_marker` pattern to look for start of a
910     directive option block (fixes [ 3484857 ]).
912 * docutils/parsers/rst/tableparser.py
914   - Fix [ 2926161 ] for simple tables.
915     (Combining chars in grid tables still contribute to cell width.)
917 * docutils/writers/latex2e/__init__.py
919   - Support the `abbreviation` and `acronym` standard roles.
920   - Record only files required to generate the LaTeX source as dependencies.
921   - Fix handling of missing stylesheets.
922   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
923     when suppressing LaTeX section numbering.
924   - Use ``\DUtitle`` for unsupported section levels
925   - Apply [ 3512791 ] do not compare string literals with "is"
927 * docutils/writers/xetex/__init__.py
929   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
931 * docutils/writers/html4css1/__init__.py
933   - Change default for `math-output` setting to MathJax.
934   - Fix handling of missing stylesheets.
936 * docutils/writers/docutils_xml.py
938   - Use the visitor pattern with default_visit()/default_depart() methods
939     instead of minidom to facilitate special handling of selected nodes.
940   - Support raw XML (inserted as-is inside a <raw></raw> node).
942 * docutils/writers/manpage.py
944   - Do not emit comment line with trailing blank. Problematic for VCS.
946 Release 0.8.1 (2011-08-30)
947 ==========================
949 * General:
951   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
952     and [ 3395920 ] (correct copyright info for rst.el).
954 * test/
956   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
958 * docutils/writers/latex2e/__init__.py
960   - Clean up Babel language setting. Restores Sphinx compatibility.
962 Release 0.8 (2011-07-07)
963 ========================
965 * General:
967   - Handle language codes according to `BCP 47`_.
968   - If the specified language is not supported by Docutils,
969     warn and fall back to English.
970   - Math support: reStructuredText "math" role and directive,
971     ``math`` and ``math_block`` doctree elements.
972   - Decode command line arguments with the locale's preferred encoding
973     (to allow, e.g., ``--title=Dornröschen``).
974   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
975   - New sub-module `error_reporting`: handle encoding/decoding errors
976     when reporting exceptions.
977   - Some additions to the Docutils core are released under the 2-Clause BSD
978     license, see COPYING_ for details.
980   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
981   .. _COPYING: COPYING.html
983 * reStructuredText:
985   - Most directives now support a "name" option that attaches a
986     reference name.
988   - Directive content may start on the first line also when the directive
989     type accepts options.
991 * docs/dev/policies.txt:
993   - Recommend the 2-Clause BSD license
994     (http://opensource.org/licenses/BSD-2-Clause)
995     for code that is kept under the author's copyright.
997 * tools/buildhtml.py:
999   - Fix ``--local`` switch.
1001 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1003 * docutils/writers/html4css1/__init__.py
1005   - Set "lang" argument for objects with class argument
1006     "language-<language tag>".
1007   - New setting "math-output" with support for HTML, MathML, and LaTeX.
1009 * docutils/writers/latex2e/__init__.py
1011   - Fix [ 3043986 ] AttributeError using :local: with table of content.
1012   - Place title data in the document preamble.
1013   - Load `babel` package only if required.
1014   - Update list of supported languages.
1015   - New config setting "hyperref-options".
1016     No hard-coded "unicode" hyperref option (clash with xetex).
1017   - Set language for custom roles, paragraphs, block-quotes, and
1018     line-quotes with class argument "language-<language tag>".
1019   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
1020   - Convert image URI to a local file path.
1021   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1022     has more than one paragraph (Wolfgang Scherer).
1023   - \leavevmode before longtable only when needed (prevents spurious vspace)
1024   - do not advance table counter for tables without caption
1026 * docutils/writers/xetex/__init__.py
1028   - New writer generating LaTeX code for compiling with ``xelatex``.
1030     A separate writer (inheriting from latex2e) instead of a ``--xetex``
1031     option allows separate config options for XeTeX vs. LaTeX2e.
1033 * docutils/writers/manpage.py
1035   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1036   - Fix: vertical space cleaning for option group ``.``.
1038 * tools/editors/emacs/rst.el:
1040   - Fix [ 3001100 ] does not handle spaces in filenames
1041     (thanks to Jakub Wilk)
1043 * docutils/utils.py:
1045   - strip whitespace from stylesheet arguments
1046   - exclude combining chars from column_width()
1047     (partial fix for [ 2926161 ])
1049 * docutils/parsers/rst/directives/misc.py:
1051   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1052     nested_parse
1054 * docutils/io.py:
1056   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
1057     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1059 Release 0.7 (2010-07-07)
1060 ========================
1062 * General:
1064   - Fix [ 2881769 ] setup configuration.
1065   - Fix [ 2788716 ] reporting problems in included files.
1067 * docutils/io.py
1069   - FileInput opens files as text files with universal newline support
1070     (mode "rU", configurable with the new optional argument "mode").
1072 * docutils/nodes.py
1074   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1076 * docutils/utils.py
1078   - Fix [ 2923723 ] let decode_path() tolerate path == None
1080 * docutils/writers/html4css1/__init__.py
1082   - Support SVG and SWF images (thanks to Stefan Rank).
1083   - Generate valid XHTML for centered images with targets.
1084     Use CSS classes instead of "align" tags for image alignment.
1086 * docutils/writers/latex2e/__init__.py
1088   - Use `transforms.writer_aux.Admonitions` to "normalize" special
1089     admonitions.
1090   - Use the ``\url`` command for URLs (breaks long URLs instead of
1091     writing into the margin).
1092   - Preserve runs of spaces in `inline literals`__.
1093   - Deprecate ``figure_footnotes`` setting.
1094   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
1095   - New ``latex_preamble`` setting.
1096   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1097   - Fix hyperlink targets (labels) for images, figures, and tables.
1098   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1099   - Apply [ 2961991 ] Call hyperref with unicode option.
1100   - Drop the special `output_encoding`__ default ("latin-1").
1101     The Docutils wide default (usually "UTF-8") is used instead.
1102   - Render inline markup in document title and subtitle.
1103   - Fix numbering depth with LaTeX section numbering.
1104   - Update Unicode -> LaTeX translations.
1105   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1107 __ docs/ref/restructuredtext.html#inline-literals
1108 __ docs/user/config.html#docutils-footnotes
1109 __ docs/user/config.html#output_encoding
1111 * docutils/writers/manpage.py
1113   - Fix: supported attribute (thanks to peter2108).
1114   - Remove trailing blanks in code (keep in sync with mercurial version).
1115   - Titles level 1, that is ``.SH``, always uppercase.
1116   - Apply patch from mg: literal text should be bold in man-pages.
1118 * docutils/nodes.py
1120   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1121     turkish locale.
1123 * setup.py:
1125   - Python 3 support: copy test/ and tools/ to the build-dir
1126     and convert Python sources with 2to3.
1129 Release 0.6 (2009-10-11)
1130 ========================
1132 * General:
1134   - Docutils is now compatible with Python versions from 2.3 up to 2.6
1135     and convertible to 3.1 code.
1137     + Node.__nonzero__ returns True instead of 1.
1138     + use os.walk instead os.path.walk.
1139     + minimize "types" module where possible.
1140     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1141     + Text nodes now subclass unicode rather than UserString
1142       (which is gone in python 3.0).
1143     + 3.0 compatibility module docutils._compat
1145     + Drop 2.2 compatibility workarounds.
1146     + Drop extras/optparse.py and extras/textwrap.py
1147       (stdlib modules since 2.3).
1149   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
1150   - Unix man page export: manpage writer moved from sandbox to Doctutils
1151     core.
1153   - Apply [ 1719345 ] Galician translation
1154   - Apply [ 1905741 ] Polish translation
1155   - Apply [ 1878977 ] make_id(): deaccent characters.
1156   - Apply [ 2029251 ] return nonzero when tests fail.
1157   - Fix [ 1692788 ] allow UTF-8 in style sheets.
1158   - Fix [ 2781629 ] support non-ASCII chars in file names.
1159   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1160   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
1161   - Fix [ 2821266 ] --strict option works now like --halt=info.
1162   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
1163   - Fix [ 1627229 ] hyperlink references in substitutions.
1165   - The "newlatex" writer is orphaned.
1167 * reStructuredText:
1169   - Documented Unicode characters allowed as inline markup openers,
1170     closers, and delimiters.
1171   - Allow units for all length specifications.
1172   - Allow percent sign in "scale" argument of "figure" and "image" directives.
1173   - Bugfix: The "figalign" argument of a figure now works as intended
1174     (aligning the figure, not its contents).
1175   - Align images with class "align-[right|center|left]"
1176     (allows setting the alignment of an image in a figure).
1178 * docutils/nodes.py:
1180   - Added ``Element.__contains__`` method, for the in-operator.
1182 * docutils/parsers/rst/states.py:
1184   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1185   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1186     " " (non-breaking space), and "¡ ¿" openers.
1188 * docutils/parsers/directives/misc.py:
1190   - Added ``start-line`` and ``end-line`` options to "include"
1191     directive to select a range of lines.
1192   - Hard tabs in literal inclusions are replaced by spaces. This is
1193     configurable via the new ``tab-width`` option of the "include" directive
1194     (a negative tab-width prevents tab expansion).
1196 * docutils/utils.py:
1198   - Add ``get_stylesheet_list`` function.
1199   - Apply [ 2834836 ] print info at halt
1201 * docutils/transforms/universal.py:
1203   - Raise default priority of StripClasses to exclude stripped classes from
1204     the ToC.
1206 * docutils/writers/html4css1/__init__.py:
1208   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
1209     separated list of stylesheets.
1210   - Address [ 1938891 ] Inline literal text creates "pre" span only when
1211     needed to prevent inter-word line wraps.
1212   - Use `translate` method instead of repeated `replace` calls.
1213   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
1214     classes to allow CSS styling that does not interfere with other
1215     table-using constructs (field lists, citations, ...).
1217 * docutils/writers/newlatex2e/__init__.py:
1219   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1221 * docutils/writers/latex2e/__init__.py:
1223   - Add ``--embed-stylesheet`` option.
1224   - Apply [ 1474017 ] image vertical alignment is reversed.
1225   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1226   - Change: has_key for dictionaries (not Nodes) to in-operator.
1227   - Merge adjacent citations into one latex cite command.
1228   - Failsave implementation of custom roles. LaTeX compilation now ignores
1229     unknown classes instead of aborting with an error.
1230   - Support custom roles based on standard roles.
1231   - LaTeX packages can be used as ``--stylesheet`` arguments without
1232     restriction. (A style sheet is now referenced with the ``\usepackage``
1233     command, if it ends with ``.sty`` or has no extension.)
1234   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
1235   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1236   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1237     2005-02-04 as a configurable length unit).
1238   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1239     if font-encoding is set to ''. LaTeX defaults to OT1 then.
1240   - Set sub- and superscript role argument in text mode not as math.
1241     Use a custom role based on sub-/superscript if you want italic shape.
1242   - Shorter preamble and less dependencies: Load packages and define macros
1243     only if required in the document.
1244   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1245   - New custom environments and commands with optional "classes" argument.
1246   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1247   - Better conformance to Docutils specifications with ``--use-latex-toc``.
1248     Support for LaTeX generated ToC also with unnumbered sections.
1249   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1250     section numbering by LaTeX.
1251   - Use default font in admonitions and sidebar.
1252   - Align of image in a figure defaults to 'center'.
1253   - Bugfix: Newlines around targets and references prevent run-together
1254     paragraphs.
1255   - Fix internal hyperlinks.
1256   - Use class defaults for page margins ('typearea' now optional).
1257   - Float placement made configurable, default changed to "here definitely".
1258   - Typeset generic topic as "quote block with title".
1259   - Use template (file and configuration option).
1260   - In the default template, load cmap.sty (fix text extraction in PDF) and
1261     fixltx2e.sty (LaTeX patches, \textsubscript).
1262   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1263   - Use `translate` instead of repeated `replace` calls for text encoding.
1264   - Hyperlinked footnotes and support for symbol footnotes and
1265     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
1266   - Complete pairs of binary options
1267     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
1268     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
1269   - New defaults:
1270     - font-encoding: "T1" (formerly implicitely set by 'ae').
1271     - use-latex-toc: true (ToC with page numbers).
1272     - use-latex-footnotes: true (no mixup with figures).
1274 * docutils/writers/manpage.py
1276   - Do not print version at document end, this is done by the viewer.
1277   - Do not print date at document end, this is done by the viewer.
1278   - Fix storage of docinfo fields for none standard fields.
1280 * docutils/tools/rst2man.py
1282 Release 0.5 (2008-06-25)
1283 ========================
1285 * docutils/languages/he.py: Added to project: Hebrew mappings by
1286   Meir Kriheli.
1288 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
1289   mappings by Meir Kriheli.
1291 * docutils/frontend.py:
1293   - Configuration files are now assumed and required to be
1294     UTF-8-encoded.
1295   - Paths of applied configuration files are now recorded in the
1296     runtime setting ``_config_files`` (accessible via
1297     ``--dump-settings``).
1298   - Added ``--strip-elements-with-class`` and ``--strip-class``
1299     options (``strip_elements_with_classes`` and ``strip_classes``
1300     settings).
1302 * docutils/io.py:
1304   - Added code to determine the input encoding from data: encoding
1305     declarations or the presence of byte order marks (UTF-8 & UTF-16).
1306   - Added support for IronPython 1.0.
1308 * docutils/nodes.py:
1310   - Added ``document.__getstate__`` method, for pickling.
1312 * docutils/parsers/rst/states.py:
1314   - Allow ``+`` and ``:`` in reference names.
1315   - Unquoted targets beginning with an underscore (``.. __target:
1316     URI``) are no longer accepted.
1317   - Added support for multiple attributions in a physical block quote
1318     (indented text block), dividing it into multiple logical block
1319     quotes.
1320   - Added support for unicode bullets in bullet lists: "•", "‣", and
1321     "⁃".
1322   - Added support for new object-oriented directive interface,
1323     retaining compatibility to the old functional interface.
1324   - Added support for throwing ``DirectiveError``'s from within
1325     directive code.
1327 * docutils/parsers/rst/__init__.py:
1329   - Added ``Directive`` base class.
1330   - Added ``DirectiveError`` base class.
1331   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
1332     definitions.
1334 * docutils/parsers/directives/:
1336   - Refactored all reStructuredText directives to use the new
1337     object-oriented directive interface.  Errors are now (mostly)
1338     thrown using the new ``DirectiveError`` class.
1340 * docutils/parsers/directives/misc.py:
1342   - Added ``start-after`` and ``end-before`` options to ``include``
1343     directive; thanks to Stefan Rank.
1345 * docutils/transforms/universal.py:
1347   - Added ``StripClassesAndElements`` transform to remove from the
1348     document tree all elements with classes in
1349     ``settings.strip_elements_with_classes`` and all "classes"
1350     attribute values in ``self.document.settings.strip_classes``.
1352 * docutils/transforms/writer_aux.py:
1354   - Added ``Admonitions`` transform to transform specific admonitions
1355     (like ``note``, ``warning``, etc.) into generic admonitions with a
1356     localized title.
1358 * docutils/writers/html4css1/__init__.py:
1360   - Moved template functionality from the PEP/HTML writer here.
1361   - Expanded the fragments available in the ``parts`` attribute.
1362   - Moved ``id`` attributes from titles to surrounding ``div``
1363     elements.
1364   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
1365     universally supported now).
1366   - ``template.txt`` is now opened in text mode instead of binary mode
1367     (to ensure Windows compatibility).
1368   - ``a`` elements now have an "internal" or "external" class,
1369     depending on reference type.
1371 * docutils/writers/html4css1/template.txt: Added to project.
1373 * docutils/writers/pep_html/:
1375   - Moved template functionality to the HTML writer.
1377 * docutils/writers/s5_html/__init__.py:
1379   - Added ``view_mode`` & ``hidden_controls`` settings
1380     (``--view-mode`` & ``--hidden-controls/--visible-controls``
1381     options).
1383 * docutils/writers/latex2e/__init__.py:
1385   - Add ``--literal-block-env``
1386   - Fix: escaping ``%`` in href urls.
1387   - Move usepackage hyperref after stylesheet inclusion.
1388   - Fix: scrartcl does not have chapter but scrreprt.
1389   - Add newline after ``\end{verbatim}``.
1390   - Merge smaller differences from latex2e_adaptive_preamble.
1391   - Add ``use-part-section``.
1392   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
1393   - Using leavemode option_list no longer needs to check if parent
1394     is a definition list.
1395   - Append ``\leavemode`` to definition list terms.
1396   - No longer write visit\_/depart_definition_list_item comments to
1397     output.
1398   - Table column width with 3 decimal places.
1399   - Add table stubs support (boldfont).
1400   - Add assemble_parts to writer.
1401   - Add simply support for nested tables.
1402   - Fix verbatim in tables if use-verbatim-when-possible.
1403   - Use section commands down to subparagraph.
1404   - Put ensuremath around some latin1 chars.
1405   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
1406   - New option ``--use-bibtex=style,db1,db2``.
1407   - New option ``--reference-label`` to allow usage of LaTeX ref for
1408     labels in section references.
1409   - Add a label after every section to support sectionnumbers as reference
1410     labels.
1411   - Fix: bug# 1605376 rst2latex: bad options group list
1412   - Remove inactive code for use_optionlist_for_option_list.
1413   - Remove latex comments from option_list output.
1414   - Fix: bug# 1612270 double qoutes in italian literal.
1415   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
1416   - Add option --use-latex-abstract.
1417   - Image width unit ``px`` is translated to ``pt``.
1418   - Add image height support.
1419   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
1420     bug #1457388
1421   - Fix: Do not escape underscores in citation reference labels if
1422     use-latex-citations is set.
1423   - Use centering instead of center for figure contents, to avoid vertical
1424     space.
1425   - Recognize table class: borderless, nolines, booktabs, standard.
1426   - Fix: Renaming contents section does not work with latex writer; SF
1427     bug #1487405.
1428   - Applied patch for custom roles with classes from Edward Loper.
1429   - Fixed bug that caused crashes with more than 256 lists.
1431 * docutils/writers/pep_html/__init__.py:
1433   - Changed to support new python.org website structure and
1434     pep2pyramid.py.
1436 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1437   project.
1439 * tools/buildhtml.py:
1441   -- Added ``ignore`` setting to exclude a list of shell patterns
1442      (default: ``.svn:CVS``).
1444 * tools/editors/emacs/rst.el:
1446   - Changed license to "GPL".
1447   - Added ``rst-straighten-decorations`` function.
1448   - The ``compile`` module is now always loaded.
1449   - Added ``rst-toggle-line-block`` function.
1450   - Headings consisting only of non-ASCII characters are now
1451     recognized by ``rst-toc`` and ``rst-adjust``.
1452   - Added font-lock support for multi-line comments where the first
1453     comment line is empty.
1454   - Added ``(require 'font-lock)``.
1456 * setup.py:
1458   - Provide descriptive error message if distutils is missing.
1461 Release 0.4 (2006-01-09)
1462 ========================
1464 * General:
1466   - Updated the project policies for trunk/branch development &
1467     version numbering.
1469 * docutils/__init__.py:
1471   - Added ``__version_details__`` attribute to describe code source
1472     (repository/snapshot/release).
1473   - Replaced ``default_transforms`` attribute of TransformSpec with
1474     ``get_transforms()`` method.
1476 * docutils/core.py:
1478   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1479     functions, for document tree extraction and reprocessing.
1481 * docutils/io.py:
1483   - Added ``DocTreeInput`` class, for reprocessing existing documents.
1484   - Added support for non-Unicode (e.g. binary) writer output.
1486 * docutils/nodes.py:
1488   - Re-introduced ``Targetable.indirect_reference_name``, for
1489     MoinMoin/reST compatibility (removed in r3124/r3129).
1490   - Added ``serial_escape`` function; escapes string values that are
1491     elements of a list, for serialization.  Modified Docutils-XML
1492     writing (``Element._dom_node``) and pseudo-XML writing
1493     (``Element.starttag``) to use ``serial_escape``.
1494   - Added ``Node.deepcopy()`` method.
1495   - Removed the internal lists ``document.substitution_refs``,
1496     ``document.anonymous_refs``, and ``document.anonymous_targets``.
1497   - Added a "container" element.
1498   - Fixed bug where values of list-valued attributes of elements
1499     originating from custom interpreted text roles (i.e., with custom
1500     classes) were being shared between element instances.  Reported by
1501     Shmuel Zeigerman.
1503 * docutils/statemachine.py:
1505   - Added trailing whitespace stripping to ``string2lines()``.
1506   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1507     Asian double-width character support.
1509 * docutils/utils.py:
1511   - Added ``east_asian_column_width()`` for double-width character
1512     support.
1514 * docutils/languages/ja.py: Added to project: Japanese mappings by
1515   Hisashi Morita.
1517 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1518   mappings by Panjunyong.
1520 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1522 * docutils/parsers/rst/__init__.py:
1524   - Added validator to tab_width setting, with test.  Closes SF bug
1525     #1212515, report from Wu Wei.
1527 * docutils/parsers/rst/states.py:
1529   - Fixed bug with escaped colons indicating a literal block.
1530   - Fixed bug with enumerated lists (SF#1254145).
1531   - Backslash-escaped colons inside of field names are now allowed.
1532   - Targets (implicit and explicit), anonymous hyperlink references
1533     and auto-numbered footnote references inside of substitution
1534     definitions are now disallowed.
1535   - Fixed bug: list items with blank first lines.
1536   - Fixed bug: block quote attributions with indented second lines.
1537   - Added East Asian double-width character support (Python 2.4 only).
1539 * docutils/parsers/rst/tableparser.py:
1541   - Added East Asian double-width character support (Python 2.4 only).
1543 * docutils/parsers/rst/directives/body.py:
1545   - Added the "container" directive.
1547 * docutils/parsers/rst/directives/misc.py:
1549   - Added the "default-role", "title", and "date" directives.
1550   - Added standard data file syntax to the "include" directive.
1551   - Added support for "class" directive content.
1553 * docutils/parsers/rst/directives/images.py:
1555   - Added ``indirect_reference_name`` support for images with a target
1556     option.
1557   - Added support for image width and height units.
1558   - Fixed bug with image "target" options.
1560 * docutils/parsers/rst/directives/references.py:
1562   - Added "class" attribute to "target-notes" directive, for
1563     footnote_reference classes.
1565 * docutils/parsers/rst/include/: Directory added to project; contains
1566   standard data files for the "include" directive.  Initial contents:
1567   character entity substitution definition sets, and a set of
1568   definitions for S5/HTML presentations.
1570 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1571   mappings by David Goodger.
1573 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1574   Simplified Chinese mappings by Panjunyong.
1576 * docutils/readers/__init__.py:
1578   - Added universal.Decorations and universal.ExposeInternals
1579     transforms as default transforms for all readers.
1580   - Added ``ReReader`` base class for readers that reread an existing
1581     document tree.
1583 * docutils/readers/doctree.py: Added to project; a reader for existing
1584   document trees.
1586 * docutils/transforms/frontmatter.py:
1588   - Fixed the DocInfo transform to handle SVN-style expansion of the
1589     "Date" keyword.
1590   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1591     fields uniformly.
1593 * docutils/transforms/misc.py:
1595   - Added misc.Transitions transform, extracted from
1596     universal.FinalChecks.
1598 * docutils/transforms/references.py:
1600   - Added references.DanglingReferences transform, extracted from
1601     universal.FinalChecks.
1602   - Fixed bug with doubly-indirect substitutions.
1603   - Added footnote_reference classes attribute to "TargetNotes".
1604   - Fixed bug with circular substitution definitions that put Docutils
1605     into an infinite loop.
1607 * docutils/transforms/universal.py:
1609   - Added universal.ExposeInternals transform, extracted from
1610     universal.FinalChecks.
1611   - Removed universal.FinalChecks transform (logic has been moved to
1612     several new transforms).
1613   - Fixed bug with the "expose_internals" setting and Text nodes
1614     (exposed by the "rawsource" internal attribute).
1615   - Added the universal.StripComments transform, implementation of the
1616     "strip_comments" setting.
1618 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1619   transforms for writers.
1621   - Added ``Compound`` transform, which flattens compound paragraphs.
1623 * docutils/writers/: Several writer modules (html4css1.py) were
1624   converted into packages.  Support modules and data files have been
1625   moved into the packages.  The stylesheets for the HTML writers are
1626   now installed along with the code, the code knows where to find
1627   them, and the default is to use them (actually, to embed them).
1628   Some adjustments to configuration files may be necessary.  The
1629   easiest way to obtain the new default behavior is to remove all
1630   settings whose name includes "stylesheet".
1632 * docutils/writers/__init__.py:
1634   - Added universal.Messages and universal.FilterMessages transforms
1635     as default transforms for all writers.
1636   - Added ``UnfilteredWriter`` base class for writers that pass the
1637     document tree on unchanged.
1639 * docutils/writers/docutils_xml.py:
1641   - Made ``xmlcharrefreplace`` the default output encoding error
1642     handler.
1644 * docutils/writers/html4css1/:
1646   - Added support for image width and height units.
1647   - Made ``xmlcharrefreplace`` the default output encoding error
1648     handler.
1649   - Made ``--embed-stylesheet`` the default rather than
1650     ``--link-stylesheet``.
1651   - Moved "id" attribute from container (section etc.) to title's <a>
1652     tag, to be on the same tag as "name".
1653     (!!! To be reverted in Docutils 0.5.)
1654   - Added vertical space between fields of field lists.
1655   - Added ``--compact-field-lists`` option to remove vertical space in
1656     simple field lists.
1657   - Made cloaking of email addresses with ``--cloak-email-addresses``
1658     less obtrusive.
1659   - Fixed support for centered images.
1660   - Added support for class="compact" & class="open" lists.
1662 * docutils/writers/latex2e/:
1664   - Underscores in citekeys are no longer escaped.
1666 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1667   mapping of Unicode characters to LaTeX equivalents.
1669 * docutils/writers/s5_html/: Package added to project; writer for
1670   S5/HTML slide shows.
1672 * docs/dev/distributing.txt: Added to project; guide for distributors
1673   (package maintainers).
1675 * docs/dev/hacking.txt: Added to project; guide for developers.
1677 * docs/ref/doctree.txt:
1679   - Updated for plural attributes "classes", "ids", "names",
1680     "dupnames".
1681   - Added the "container" element.
1683 * docs/ref/docutils.dtd:
1685   - Updated for plural attributes "classes", "ids", "names",
1686     "dupnames".
1688 * docs/user/emacs.txt: Added to project; a document about Emacs
1689   support for reStructuredText and Docutils.
1691 * docs/user/links.txt: Added to project; lists of Docutils-related
1692   links.
1694 * docs/user/mailing-lists.txt: Added to project; information about
1695   Docutils-related mailing lists and how to access them.
1697 * docs/user/slide-shows.txt: Added to project; example of and docs for
1698   the S5/HTML writer (``rst2s5.py`` front end).
1700 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1701   Files", added to project.
1703 * test/coverage.sh: Added to project; test coverage script.
1705 * test/DocutilsTestSupport.py:
1707   - Added support for specifying runtime settings at the suite level.
1709 * test/test_functional.py:
1711   - Added the ``clear_output_directory`` function.
1712   - Added support for ``_test_more`` functions in functional test
1713     config files.
1715 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1717 * tools/rstpep2html.py: Renamed from pep.py.
1719 * tools/dev/create_unimap.py: Added to project; script to create the
1720   docutils/writers/unimap_latex.py mapping file.
1722 * tools/dev/profile_docutils.py: Added to project; profiler script.
1724 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1726 * tools/editors/emacs/restructuredtext.el,
1727   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1728   Removed from project; the functionality is now contained in rst.el.
1730 * tools/editors/emacs/rst.el: Added to project.  Added many features
1731   and fixed many bugs.  See docs/user/emacs.txt for details.
1733 * tools/stylesheets: Removed from project.  Stylesheets have been
1734   renamed and moved into writer packages.
1737 Release 0.3.9 (2005-05-26)
1738 ==========================
1740 * General:
1742   - Eliminated and replaced all uses of the old string attributes
1743     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1744     new list attributes ``ids``, ``names``, ``dupnames`` and
1745     ``classes`` throughout the whole source tree.
1747 * docutils/core.py:
1749   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1750     allowing for easier debugging.
1751   - In ``Publisher.publish()``, expanded the generic top-level
1752     exception catching.
1754 * docutils/examples.py:
1756   - Added ``internals`` function for exploration.
1758 * docutils/io.py:
1760   - Fixed ``Input.decode`` method to apply heuristics only if no
1761     encoding is explicitly given, and to provide better reporting of
1762     decoding errors.
1763   - The ``Input.decode`` method now removes byte order marks (BOMs)
1764     from input streams.
1766 * docutils/nodes.py:
1768   - ``image`` element class changed to subclass of Element, not
1769     TextElement (it's an empty element, and cannot contain text).
1770   - Added ``attr_defaults`` dictionary for default attribute values.
1771   - Added empty list as default value for the following attributes:
1772     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1773   - Added ``document.decoration`` attribute,
1774     ``document.get_decoration`` method, and ``decoration.get_header``
1775     & ``.get_footer`` methods.
1776   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1777     methods.
1779 * docutils/utils.py:
1781   - Removed ``docutils.utils.Reporter.categories``,
1782     ``docutils.utils.ConditionSet``, and all references to them, to
1783     simplify error reporting.
1785 * docutils/languages/nl.py: Added to project; Dutch mappings by
1786   Martijn Pieters.
1788 * docutils/parsers/rst/__init__.py:
1790   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1792 * docutils/parsers/rst/states.py:
1794   - Added check for escaped at-mark to prevent email address recognition.
1795   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1796     arguments>``.
1797   - Allowed whitespace in paths and URLs.
1798   - Added auto-enumerated list items.
1799   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1800     followed by text.
1801   - Added support for table stub columns.
1803 * docutils/parsers/rst/directives/__init__.py:
1805   - Allowed whitespace in paths (``path`` function).
1806   - Added ``uri`` directive option conversion function.
1808 * docutils/parsers/rst/directives/body.py:
1810   - Fixed illegal context bug with "topic" directive (allowed within
1811     sidebars; not within body elements).
1813 * docutils/parsers/rst/directives/images.py:
1815   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1816   - Added support for the ``file_insertion_enabled`` setting in the
1817     "figure" directive (disables "figwidth" option).
1818   - "image" directive: added checks for valid values of "align" option,
1819     depending on context.  "figure" directive: added specialized
1820     "align" option and attribute on "figure" element.
1821   - Made ":figwidth: image" option of "figure" directive work again.
1822   - Fixed bug with reference names containing uppercase letters
1823     (e.g. ``Name_``) in "target" option of "image" directive.
1825 * docutils/parsers/rst/directives/misc.py:
1827   - Fixed "include" and "raw" directives to catch text decoding
1828     errors.
1829   - Allowed whitespace in "include" & "raw" directive paths.
1830   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1831     settings in "include" & "raw" directives.
1833 * docutils/parsers/rst/directives/parts.py:
1835   - Added "header" & "footer" directives.
1836   - Fixed illegal context bug with "contents" directive (topics
1837     allowed within sidebars; not within body elements).
1839 * docutils/parsers/rst/directives/tables.py:
1841   - Added "list-table" directive.
1842   - Caught empty CSV table bug.
1843   - Added support for the ``file_insertion_enabled`` setting in the
1844     "csv-table" directive.
1845   - Added ``stub-columns`` option to "csv-table" and "list-table"
1846     directives.
1848 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1849   mappings by Martijn Pieters.
1851 * docutils/readers/standalone.py:
1853   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1854     options to activate or deactivate the SectSubTitle transform.
1856 * docutils/transforms/frontmatter.py:
1858   - Added SectSubTitle transform to promote titles of lone
1859     subsections to subtitles.
1861 * docutils/transforms/references.py:
1863   - Fixed mislocated internal targets bug, by propagating internal
1864     targets to the next node, making use of the newly added support
1865     for multiple names and IDs.
1866   - Fixed duplicate footnote label bug.
1867   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1868     transform.
1870 * docutils/writers/html4css1.py:
1872   - Fixed unencoded stylesheet reference bug (characters like "&" in
1873     stylesheet references).
1874   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1875     tags).
1876   - Added support for multiple IDs per node by creating empty ``span``
1877     tags.
1878   - Added the ``field_name_limit`` & ``option_limit`` settings &
1879     support.
1880   - Added support for table stub columns.
1881   - Added support for the ``align`` attribute on ``figure`` elements.
1882   - Added the ``cloak_email_addresses`` setting & support.
1883   - Added ``html_prolog``, ``html_head``, ``html_body``,
1884     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1885     ``docutils.core.publish_parts``.
1886   - Added support for section subtitles.
1888 * docutils/writers/latex2e.py:
1890   - Fixed tables starting with more than one multirow cell.
1891   - Improved --use-latex-docinfo so that organization/contact/address
1892     fields are lumped with the last author field and appear on the
1893     titlepage.
1894   - Made sure the titlepage is always shown with --use-latex-docinfo,
1895     even if the document has no title.
1896   - Made sure that latex doesn't fill in today's date if no date field
1897     was given.
1898   - Added support for section subtitles.
1900 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1901   (under development).
1903 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1905 * docs/api/publisher.txt:
1907   - Added "``publish_parts`` Details" section.
1909 * docutils/dev/repository.txt: Added to project; information about the
1910   Docutils Subversion repository.
1912 * docs/ref/docutils.dtd:
1914   - Added a ``stub`` attribute to the ``colspec`` element via the
1915     ``tbl.colspec.att`` parameter entity.
1916   - Allowed topic elements within sidebars
1917   - Added an ``align`` attribute to the ``figure`` element.
1919 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1920   writer.
1923 Release 0.3.7 (2004-12-24)
1924 ==========================
1926 * docutils/frontend.py:
1928   - Added options: --input-encoding-error-handler,
1929     --record-dependencies, --leave-footnote-reference-space,
1930     --strict-visitor.
1931   - Added command-line and config file support for "overrides" setting
1932     parameter.
1934 * docutils/io.py:
1936   - Added support for input encoding error handler.
1938 * docutils/nodes.py:
1940   - Added dispatch_visit and dispatch_departure methods to
1941     NodeVisitor; useful as a hook for Visitors.
1942   - Changed structure of ``line_block``; added ``line``.
1943   - Added ``compound`` node class.
1944   - Added a mechanism for Visitors to transitionally ignore new node
1945     classes.
1947 * docutils/utils.py:
1949   - Moved ``escape2null`` and ``unescape`` functions from
1950     docutils/parsers/rst/states.py.
1952 * docutils/parsers/rst/roles.py:
1954   - Added "raw" role.
1955   - Changed role function API: the "text" parameter now takes
1956     null-escaped interpreted text content.
1958 * docutils/parsers/rst/states.py:
1960   - Fixed bug where a "role" directive in a nested parse would crash
1961     the parser; the state machine's "language" attribute was not being
1962     copied over.
1963   - Added support for line block syntax.
1964   - Fixed directive parsing bug: argument-less directives didn't
1965     notice that arguments were present.
1966   - Removed error checking for transitions.
1967   - Added support for multiple classifiers in definition list items.
1968   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1969   - Changed role function API: the "text" parameter now takes
1970     null-escaped interpreted text content.
1971   - Empty sections and documents are allowed now.
1973 * docutils/parsers/rst/directives/__init__.py:
1975   - Added ``encoding`` directive option conversion function.
1976   - Allow multiple class names in class_option conversion function.
1978 * docutils/parsers/rst/directives/body.py:
1980   - Converted the line-block directive to use the new structure.
1981   - Extracted the old line-block functionality to the ``block``
1982     function (still used).
1983   - Added ``compound`` directive (thanks to Lea Wiemann).
1985 * docutils/parsers/rst/directives/misc.py:
1987   - Added "encoding" option to "include" and "raw" directives.
1988   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1989   - Allow multiple class names in the "class" directive.
1991 * docutils/parsers/rst/directives/parts.py:
1993   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1994     options.  Thanks to Lele Gaifax.
1996 * docutils/parsers/rst/directives/tables.py:
1998   - Added "encoding" directive to "csv-table" directive.
1999   - Added workaround for lack of Unicode support in csv.py, for
2000     non-ASCII CSV input.
2002 * docutils/transforms/misc.py:
2004   - Fixed bug when multiple "class" directives are applied to a single
2005     element.
2006   - Enabled multiple format names for "raw" directive.
2008 * docutils/transforms/references.py:
2010   - Added support for trimming whitespace from beside substitution
2011     references.
2013 * docutils/transforms/universal.py:
2015   - FinalChecks now checks for illegal transitions and moves
2016     transitions between sections.
2018 * docutils/writers/html4css1.py:
2020   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
2021   - "stylesheet" and "stylesheet_path" settings are now mutually
2022     exclusive.
2023   - Added support for the new line_block/line structure.
2024   - --footnote-references now overrides
2025     --trim-footnote-reference-space, if applicable.
2026   - Added support for ``compound`` elements.
2027   - Enabled multiple format names for "raw" directive.
2028   - ``<p>`` tags of a paragraph which is the only visible child of the
2029     document node are no longer stripped.
2030   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2031     new method ``should_be_compact_paragraph()``.
2032   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2033     elements.
2034   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2035     the output if they have their ``class`` attribute set.
2036   - The whole document is now surrounded by a ``<div
2037     class="document">`` element.
2038   - Body-level images are now wrapped by their own ``<div>`` elements,
2039     with image classes copied to the wrapper, and for images which
2040     have the ``:align:`` option set, the surrounding ``<div>`` now
2041     receives a class attribute (like ``class="align-left"``).
2043 * docutils/writers/latex2e.py:
2045   - no newline after depart_term.
2046   - Added translations for some Unicode quotes.
2047   - Added option "font-encoding", made package AE the default.
2048   - "stylesheet" and "stylesheet_path" settings are now mutually
2049     exclusive.
2050   - --footnote-references now overrides
2051     --trim-footnote-reference-space, if applicable.
2052   - The footnote label style now matches the footnote reference style
2053     ("brackets" or "superscript").
2054   - Added support for ``compound`` elements.
2055   - Enabled multiple format names for "raw" directive.
2057 * docs/ref/docutils.dtd:
2059   - Changed structure of the ``line_block`` element; added ``line``.
2060   - Added ``compound`` element.
2061   - Added "ltrim" and "rtrim" attributes to
2062     ``substitution_definition`` element.
2063   - Enabled multiple format names for ``raw`` element.
2064   - Enabled multiple classifiers in ``definition_list_item`` elements.
2066 * docs/ref/rst/directives.txt
2068   - Marked "line-block" as deprecated.
2069   - "Class" directive now allows multiple class names.
2070   - Added "Rationale for Class Attribute Value Conversion".
2071   - Added warning about "raw" overuse/abuse.
2073 * docs/ref/rst/restructuredtext.txt:
2075   - Added syntax for line blocks.
2076   - Definition list items may have multiple classifiers.
2078 * docs/ref/rst/roles.txt:
2080   - Added "raw" role.
2082 * tools/stylesheets/default.css:
2084   - Added support for the new line_block structure.
2085   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2088 Release 0.3.5 (2004-07-29)
2089 ==========================
2091 General:
2093 * _`Documentation cleanup/reorganization`.
2095   - Created new subdirectories of docs/:
2097     * ``docs/user/``: introductory/tutorial material for end-users
2098     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2099     * ``docs/api/``: API reference material for client-developers
2100     * ``docs/ref/``: reference material for all groups
2101     * ``docs/howto/``: for component-developers and core-developers
2102     * ``docs/peps/``: Python Enhancement Proposals
2104   - Moved ``docs/*`` to ``docs/user/``.
2105   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2106     ``spec/`` to ``docs/dev``.
2107   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2108     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2109   - Moved ``alternatives.txt``, and ``problems.txt`` from
2110     ``spec/rst/`` to ``docs/dev/rst/``.
2111   - Moved ``reStructuredText.txt``, ``directives.txt``,
2112     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2113     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
2114     ``roles.txt``, ``reStructuredText.txt`` to
2115     ``restructuredtext.txt``.
2116   - Moved ``spec/howto/`` to ``docs/howto``.
2118   In order to keep the CVS history of moved files, we supplied
2119   SourceForge with a `script for modifying the Docutils CVS
2120   repository`__.
2122   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
2124   After running the cleanup script:
2126   - Added ``docs/index.txt``.
2127   - Added a ``.htaccess`` file to the ``web`` module, containing
2128     redirects for all old paths to new paths.  They'll preserve
2129     fragments (the "#name" part of a URL), and won't clutter up the
2130     file system, and will correct the URL in the user's browser.
2131   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2132     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2133     the "To Do" list itself in ``docs/dev/todo.txt``.
2134   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2135     section of ``docs/dev/todo.txt``.
2136   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2137   - Added "How To Report Bugs" to ``BUGS.txt``.
2138   - Went through all the sources and docs (including under web/) and
2139     updated links.  Mostly done by Lea Wiemann; thanks Lea!
2140     (Still need to update links in the sandboxes.)
2142 Specific:
2144 * BUGS.txt: Added to project.
2146 * THANKS.txt: Added to project.
2148 * docutils/__init__.py:
2150   - 0.3.4: Post-release.
2152 * docutils/core.py:
2154   - Added special error handling & advice for UnicodeEncodeError.
2155   - Refactored Publisher.publish (simplified exception handling &
2156     extracted debug dumps).
2157   - Renamed "enable_exit" parameter of convenience functions to
2158     "enable_exit_status".
2159   - Enabled traceback (exception propagation) by default in
2160     programmatic convenience functions.
2161   - Now publish_file and publish_cmdline convenience functions return
2162     the encoded string results in addition to their regular I/O.
2163   - Extracted common code from publish_file, publish_string, and
2164     publish_parts, into new publish_programmatically.  Extracted
2165     settings code to ``Publisher.process_programmatic_settings``.
2166   - In Publisher.publish, disabled ``settings_overrides`` when
2167     ``settings`` is supplied; redundant.
2169 * docutils/frontend.py:
2171   - Added help text for "--output-encoding-error-handler" and
2172     "--error-encoding-error-handler".
2173   - Renamed "--exit" to "--exit-status".
2174   - Simplified default-setting code.
2176 * docutils/parsers/rst/__init__.py:
2178   - Added "--pep-base-url" and "--rfc-base-url" options.
2180 * docutils/parsers/rst/states.py:
2182   - Made URI recognition more aggressive and intelligent.
2184 * docutils/parsers/rst/directives/__init__.py:
2186   - Added several directive option conversion functions.
2188 * docutils/parsers/rst/directives/body.py:
2190   - Moved "table" directive to tables.py.
2192 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2193   added to project.
2195 * docutils/writers/latex2e.py:
2197   - Added "--table-style=(standard|booktabs|nolines)"
2198   - figures get "here" option (LaTeX per default puts them at bottom),
2199     and figure content is centered.
2200   - Rowspan support for tables.
2201   - Fix: admonition titles before first section.
2202   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2203   - Replave ``_`` in literal by an underlined blank, because it has the correct
2204     width.
2205   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2206   - A few unicode replacements, if output_encoding != utf
2207   - Add "--graphicx-option".
2208   - Indent literal-blocks.
2209   - Fix: omit ``\maketitle`` when there is no document title.
2211 * docs/index.txt: "Docutils Project Documentation Overview", added to
2212   project.
2214 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2215   Tool", added to project.
2217 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2219 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2221 * docs/dev/policies.txt: Added to project (extracted from
2222   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2224 * docs/dev/release.txt: Added to project (extracted from
2225   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2227 * docs/dev/testing.txt: Added to project.
2229 * docs/dev/website.txt: Added to project (extracted from
2230   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2232 * docs/ref/rst/directives.txt:
2234   - Added directives: "table", "csv-table".
2236 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2237   added to project.  1 page for syntax, and a 1 page reference for
2238   directives and roles.  Source text to be used as-is; not meant to be
2239   converted to HTML.
2241 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2242   with a change of title.
2244 * test/functional/, contents, and test/test_functional.py: Added to
2245   project.
2247 * tools/buildhtml.py: Fixed bug with config file handling.
2249 * tools/html.py: Removed from project (duplicate of rst2html.py).
2251 * tools/pep2html.py: Removed from project (duplicate of Python's
2252   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2253   Docutils-related PEPs in docs/peps/).
2255 * tools/rst2pseudoxml.py: Renamed from publish.py.
2257 * tools/rst2xml.py: Renamed from docutils-xml.py.
2259 * tools/test.txt: Removed from project; moved to
2260   docs/user/rst/demo.txt.
2262 * setup.py: Now also installs ``rst2latex.py``.
2265 Release 0.3.3 (2004-05-09)
2266 ==========================
2268 * docutils/__init__.py:
2270   - 0.3.1: Reorganized config file format (multiple sections); see
2271     docs/config.txt.
2272   - Added unknown_reference_resolvers attribute to TransformSpec.
2273   - 0.3.2: Interpreted text reorganization.
2274   - 0.3.3: Released.
2276 * docutils/core.py:
2278   - Catch system messages to stop tracebacks from parsing errors.
2279   - Catch exceptions during processing report & exit without
2280     tracebacks, except when "--traceback" used.
2281   - Reordered components for OptionParser; application comes last.
2282   - Added "config_section" parameter to several methods and functions,
2283     allowing front ends to easily specify their config file sections.
2284   - Added publish_parts convenience function to allow access to individual
2285     parts of a document.
2287 * docutils/examples.py: Added to project; practical examples of
2288   Docutils client code, to be used as-is or as models for variations.
2290 * docutils/frontend.py:
2292   - Added "--traceback" & "--no-traceback" options ("traceback"
2293     setting).
2294   - Implemented support for config file reorganization:
2295     ``standard_config_files`` moved from ``ConfigParser`` to
2296     ``OptionParser``; added
2297     ``OptionParser.get_config_file_settings()`` and
2298     ``.get_standard_config_settings()``; support for old "[options]"
2299     section (with deprecation warning) and mapping from old to new
2300     settings.
2301   - Reimplemented setting validation.
2302   - Enabled flexible boolean values: yes/no, true/false, on/off.
2303   - Added ``Values``, a subclass of ``optparse.Values``, with support
2304     for list setting attributes.
2305   - Added support for new ``DOCUTILSCONFIG`` environment variable;
2306     thanks to Beni Cherniavsky.
2307   - Added "--no-section-numbering" option.
2309 * docutils/io.py:
2311   - Catch IOErrors when opening source & destination files, report &
2312     exit without tracebacks.  Added ``handle_io_errors`` parameter to
2313     ``FileInput`` & ``FileOutput`` to enable caller error handling.
2315 * docutils/nodes.py:
2317   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
2318     method definitions (via ``exec``) to dynamic assignments (via
2319     ``setattr``); thanks to Roman Suzi.
2320   - Encapsulated visitor dynamic assignments in a function; thanks to
2321     Ian Bicking.
2322   - Added indirect_reference_name attribute to the Targetable
2323     class. This attribute holds the whitespace_normalized_name
2324     (contains mixed case) of a target.
2326 * docutils/statemachine.py:
2328   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
2329   - Added ``StringList.get_2D_block``.
2331 * docutils/utils.py:
2333   - Added "level" attribute to SystemMessage exceptions.
2335 * docutils/languages/af.py: Added to project; Afrikaans mappings by
2336   Jannie Hofmeyr.
2338 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
2339   Blaha.
2341 * docutils/languages/eo.py: Added to project; Esperanto mappings by
2342   Marcelo Huerta San Martin.
2344 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
2345   mappings by Lalo Martins.
2347 * docutils/languages/ru.py: Added to project; Russian mappings by
2348   Roman Suzi.
2350 * docutils/parsers/rst/roles.py: Added to project.  Contains
2351   interpreted text role functions, a registry for interpreted text
2352   roles, and an API for adding to and retrieving from the registry.
2353   Contributed by Edward Loper.
2355 * docutils/parsers/rst/states.py:
2357   - Updated ``RSTState.nested_parse`` for "include" in table cells.
2358   - Allowed true em-dash character and "---" as block quote
2359     attribution marker.
2360   - Added support for <angle-bracketed> complex option arguments
2361     (option lists).
2362   - Fixed handling of backslashes in substitution definitions.
2363   - Fixed off-by-1 error with extra whitespace after substitution
2364     definition directive.
2365   - Added inline markup parsing to field lists' field names.
2366   - Added support for quoted (and unindented) literal blocks.
2367     Driven in part by a bribe from Frank Siebenlist (thanks!).
2368   - Parser now handles escapes in URIs correctly.
2369   - Made embedded-URIs' reference text omittable.  Idea from Beni
2370     Cherniavsky.
2371   - Refactored explicit target processing code.
2372   - Added name attribute to references containing the reference name only
2373     through whitespace_normalize_name (no case changes).
2374   - parse_target no longer returns the refname after going through
2375     normalize_name. This is now handled in make_target.
2376   - Fixed bug relating to role-less interpreted text in non-English
2377     contexts.
2378   - Reorganized interpreted text processing; moved code into the new
2379     roles.py module.  Contributed by Edward Loper.
2380   - Refactored ``Body.parse_directive`` into ``run_directive`` and
2381     ``parse_directive_block``.
2383 * docutils/parsers/rst/tableparser.py:
2385   - Reworked for ``StringList``, to support "include" directives in
2386     table cells.
2388 * docutils/parsers/rst/directives/__init__.py:
2390   - Renamed ``unchanged()`` directive option conversion function to
2391     ``unchanged_required``, and added a new ``unchanged``.
2392   - Catch unicode value too high error; fixes bug 781766.
2393   - Beefed up directive error reporting.
2395 * docutils/parsers/rst/directives/body.py:
2397   - Added basic "table" directive.
2399 * docutils/parsers/rst/directives/images.py:
2401   - Added "target" option to "image" directive.
2402   - Added name attribute to references containing the reference name only
2403     through whitespace_normalize_name (no case changes).
2405 * docutils/parsers/rst/directives/misc.py:
2407   - Isolated the import of the ``urllib2`` module; was causing
2408     problems on SourceForge (``libssl.so.2`` unavailable?).
2409   - Added the "role" directive for declaring custom interpreted text
2410     roles.
2412 * docutils/parsers/rst/directives/parts.py:
2414   - The "contents" directive does more work up-front, creating the
2415     "topic" and "title", and leaving the "pending" node for the
2416     transform.  Allows earlier reference resolution; fixes subtle bug.
2418 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
2419   mappings by Jannie Hofmeyr.
2421 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
2422   mappings by Marek Blaha.
2424 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
2425   mappings by Marcelo Huerta San Martin.
2427 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2428   Portuguese mappings by Lalo Martins.
2430 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2431   mappings by Roman Suzi.
2433 * docutils/transforms/parts.py:
2435   - The "contents" directive does more work up-front, creating the
2436     "topic" and "title", and leaving the "pending" node for the
2437     transform.  Allows earlier reference resolution; fixes subtle bug.
2438   - Added support for disabling of section numbering.
2440 * docutils/transforms/references.py:
2442   - Verifying that external targets are truly targets and not indirect
2443     references. This is because we are now adding a "name" attribute to
2444     references in addition to targets. Note sure if this is correct!
2445   - Added code to hook into the unknown_reference_resolvers list for a
2446     transformer in resolve_indirect_target. This allows the
2447     unknown_reference_resolvers to keep around indirect targets which
2448     docutils doesn't know about.
2449   - Added specific error message for duplicate targets.
2451 * docutils/transforms/universal.py:
2453   - Added FilterMessages transform (removes system messages below the
2454     verbosity threshold).
2455   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2456     to FinalCheckVisitor for application-specific handling of
2457     unresolvable references.
2458   - Added specific error message for duplicate targets.
2460 * docutils/writers/__init__.py:
2462   - Added assemble_parts method to the Writer class to allow for
2463     access to a documents individual parts.
2464   - Documented & set default for ``Writer.output`` attribute.
2466 * docutils/writers/html4css1.py:
2468   - Fixed unicode handling of attribute values (bug 760673).
2469   - Prevent duplication of "class" attribute values (bug report from
2470     Kirill Lapshin).
2471   - Improved table grid/border handling (prompted by report from Bob
2472     Marshall).
2473   - Added support for table titles.
2474   - Added "<title />" for untitled docs, for XHTML conformance; thanks
2475     to Darek Suchojad.
2476   - Added functionality to keep track of individual parts of a document
2477     and store them in a dictionary as the "parts" attribute of the writer.
2478     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2479   - Added proper support for the "scale" attribute of the "image"
2480     element.  Contributed by Brent Cook.
2481   - Added ``--initial-header-level`` option.
2482   - Fixed bug: the body_pre_docinfo segment depended on there being a
2483     docinfo; if no docinfo, the document title was incorporated into
2484     the body segment.  Adversely affected the publish_parts interface.
2486 * docutils/writers/latex2e.py:
2488   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2489     about a missing file.
2490   - Added options and support: ``--compound-enumerators``,
2491     ``--section-prefix-for-enumerators``, and
2492     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
2493     934322).
2494   - Added option ``--use-verbatim-when-possible``, to avoid
2495     problematic characters (eg, '~' in italian) in literal blocks.
2496   - It's now possible to use four section levels in the `book` and
2497     `report` LaTeX classes.  The default `article` class still has
2498     three levels limit.
2500 * docs/config.txt: "Docutils Configuration Files", added to project.
2501   Moved config file entry descriptions from tools.txt.
2503 * docs/tools.txt:
2505   - Moved config file entry descriptions to config.txt.
2507 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
2508   Development".
2510 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2511   Text Roles", added to project.
2513 * spec/rst/reStructuredText.txt:
2515   - Added description of support for <angle-bracketed> complex option
2516     arguments to option lists.
2517   - Added subsections for indented and quoted literal blocks.
2519 * test: Continually adding & updating tests.
2521   - Added test/test_settings.py & test/data/config_*.txt support
2522     files.
2523   - Added test/test_writers/test_htmlfragment.py.
2525 * test/DocutilsTestSupport.py:
2527   - Refactored LaTeX publisher test suite/case class names to make
2528     testing other writers easier.
2529   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2530     to test the processing of HTML fragments which use the new
2531     publish_parts convenience function.
2533 * tools/buildhtml.py:
2535   - Added support for the "--prune" option.
2536   - Removed dependency on pep2html.py; plaintext PEPs no longer
2537     supported.
2539 * tools/docutils.conf:
2541   - Updated for configuration file reorganization.
2543 * tools/rst2html.py:
2545   - copied from tools/html.py
2547 * setup.py:
2549   - added a 'scripts' section to configuration
2550   - added 'tools/rst2html.py' to the scripts section
2553 Release 0.3 (2003-06-24)
2554 ========================
2556 General:
2558 * Renamed "attribute" to "option" for directives/extensions.
2560 * Renamed transform method "transform" to "apply".
2562 * Renamed "options" to "settings" for runtime settings (as set by
2563   command-line options).  Sometimes "option" (singular) became
2564   "settings" (plural).  Some variations below:
2566   - document.options -> document.settings (stored in other objects as
2567     well)
2568   - option_spec -> settings_spec (not directives though)
2569   - OptionSpec -> SettingsSpec
2570   - cmdline_options -> settings_spec
2571   - relative_path_options -> relative_path_settings
2572   - option_default_overrides -> settings_default_overrides
2573   - Publisher.set_options -> Publisher.get_settings
2575 Specific:
2577 * COPYING.txt: Added "Public Domain Dedication".
2579 * FAQ.txt: Frequently asked questions, added to project.
2581 * setup.py:
2583   - Updated with PyPI Trove classifiers.
2584   - Conditional installation of third-party modules.
2586 * docutils/__init__.py:
2588   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2589   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2590   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2591   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2592     option and its effect on the PEP template & writer.
2593   - Bumped version to 0.2.4 due to changes to the PEP template &
2594     stylesheet.
2595   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2596   - Added ``TransformSpec`` class for new transform system.
2597   - Bumped version to 0.2.6 for API changes (renaming).
2598   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2599     convenience functions.
2600   - Added ``Component.component_type`` attribute.
2601   - Bumped version to 0.2.8 because of the internal parser switch from
2602     plain lists to the docutils.statemachine.StringList objects.
2603   - Bumped version to 0.2.9 because of the frontend.py API changes.
2604   - Bumped version to 0.2.10 due to changes to the project layout
2605     (third-party modules removed from the "docutils" package), and
2606     signature changes in ``io.Input``/``io.Output``.
2607   - Changed version to 0.3.0 for release.
2609 * docutils/core.py:
2611   - Made ``publish()`` a bit more convenient.
2612   - Generalized ``Publisher.set_io``.
2613   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2614     parameters; improved its docstring.
2615   - Added ``publish_file()`` and ``publish_string()``.
2616   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2617     out of ``.set_io``.
2618   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2619     "--dump-transforms" hidden options.
2620   - Added ``Publisher.apply_transforms()`` method.
2621   - Added ``Publisher.set_components()`` method; support for
2622     ``publish_*()`` conveninece functions.
2623   - Moved config file processing to docutils/frontend.py.
2624   - Added support for exit status ("exit_level" setting &
2625     ``enable_exit`` parameter for Publisher.publish() and convenience
2626     functions).
2628 * docutils/frontend.py:
2630   - Check for & exit on identical source & destination paths.
2631   - Fixed bug with absolute paths & "--config".
2632   - Set non-command-line defaults in ``OptionParser.__init__()``:
2633     ``_source`` & ``_destination``.
2634   - Distributed ``relative_path_settings`` to components; updated
2635     ``OptionParser.populate_from_components()`` to combine it all.
2636   - Require list of keys in ``make_paths_absolute`` (was implicit in
2637     global ``relative_path_settings``).
2638   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2639     "--dump-settings", and "--dump-transforms" hidden options.
2640   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2641     code, replaced with correct code.
2642   - Added validation functionality for config files.
2643   - Added "--error-encoding" option/setting, "_disable_config"
2644     internal setting.
2645   - Added encoding validation; updated "--input-encoding" and
2646     "--output-encoding"; added "--error-encoding-error-handler" and
2647     "--output-encoding-error-handler".
2648   - Moved config file processing from docutils/core.py.
2649   - Updated ``OptionParser.populate_from_components`` to handle new
2650     ``SettingsSpec.settings_defaults`` dict.
2651   - Added support for "-" => stdin/stdout.
2652   - Added "exit_level" setting ("--exit" option).
2654 * docutils/io.py:
2656   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2657   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2658   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2659   - ``FileOutput.write()`` now returns the encoded output string.
2660   - Try to get path/stream name automatically in ``FileInput`` &
2661     ``FileOutput``.
2662   - Added defaults for source & destination paths.
2663   - Allow for Unicode I/O with an explicit "unicode" encoding.
2664   - Added ``Output.encode()``.
2665   - Removed dependency on runtime settings; pass encoding directly.
2666   - Recognize Unicode strings in ``Input.decode()``.
2667   - Added support for output encoding error handlers.
2669 * docutils/nodes.py:
2671   - Added "Invisible" element category class.
2672   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2673     modification during a traversal.
2674   - Added element classes: ``line_block``, ``generated``, ``address``,
2675     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2676     ``superscript``, ``subscript``, ``inline``
2677   - Added support for lists of nodes to ``Element.insert()``.
2678   - Fixed parent linking in ``Element.replace()``.
2679   - Added new abstract superclass ``FixedTextElement``; adds
2680     "xml:space" attribute.
2681   - Added support for "line" attribute of ``system_message`` nodes.
2682   - Added support for the observer pattern from ``utils.Reporter``.
2683     Added ``parse_messages`` and ``transform_messages`` attributes to
2684     ``document``, removed ``messages``.  Added ``note_parse_message``
2685     and ``note_transform_message`` methods.
2686   - Added support for improved diagnostics:
2688     - Added "document", "source", and "line" internal attributes to
2689       ``Node``, set by ``Node.setup_child()``.
2690     - Converted variations on ``node.parent = self`` to
2691       ``self.setup_child(node)``.
2692     - Added ``document.current_source`` & ``.current_line``
2693       attributes, and ``.note_source`` observer method.
2694     - Changed "system_message" output to GNU-Tools format.
2696   - Added a "rawsource" attribute to the ``Text`` class, for text
2697     before backslash-escape resolution.
2698   - Support for new transform system.
2699   - Reworked ``pending`` element.
2700   - Fixed XML DOM bug (SF #660611).
2701   - Removed the ``interpeted`` element class and added
2702     ``title_reference``, ``abbreviation``, ``acronym``.
2703   - Made substitutions case-sensitive-but-forgiving; moved some code
2704     from the parser.
2705   - Fixed Unicode bug on element attributes (report: William Dode).
2707 * docutils/optik.py: Removed from project; replaced with
2708   extras/optparse.py and extras/textwrap.py.  These will be installed
2709   only if they're not already present in the Python installation.
2711 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2712   only if it's not already present in the Python installation.
2714 * docutils/statemachine.py:
2716   - Factored out ``State.add_initial_transitions()`` so it can be
2717     extended.
2718   - Converted whitespace-specific "blank" and "indent" transitions
2719     from special-case code to ordinary transitions: removed
2720     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2721     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2722     ``ws_initial_transitions`` attributes.
2723   - Removed ``State.match_transition()`` after merging it into
2724     ``.check_line()``.
2725   - Added ``StateCorrection`` exception.
2726   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2727     (moved ``TransitionCorrection`` support there too.)
2728   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2729     ``EOFError`` instead of ``IndexError``.
2730   - Added ``State.no_match`` method.
2731   - Added support for the Observer pattern, triggered by input line
2732     changes.
2733   - Added ``strip_top`` parameter to
2734     ``StateMachineWS.get_first_known_indented``.
2735   - Made ``context`` a parameter to ``StateMachine.run()``.
2736   - Added ``ViewList`` & ``StringList`` classes;
2737     ``extract_indented()`` becomes ``StringList.get_indented()``.
2738   - Added ``StateMachine.insert_input()``.
2739   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2740     thanks to) Fred Drake.
2742 * docutils/utils.py:
2744   - Added a ``source`` attribute to Reporter instances and
2745     ``system_message`` elements.
2746   - Added an observer pattern to ``utils.Reporter`` to keep track of
2747     system messages.
2748   - Fixed bugs in ``relative_path()``.
2749   - Added support for improved diagnostics.
2750   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2751   - Added support for encoding Reporter stderr output, and encoding
2752     error handlers.
2753   - Reporter keeps track of the highest level system message yet
2754     generated.
2756 * docutils/languages: Fixed bibliographic field language lookups.
2758 * docutils/languages/es.py: Added to project; Spanish mappings by
2759   Marcelo Huerta San Martin.
2761 * docutils/languages/fr.py: Added to project; French mappings by
2762   Stefane Fermigier.
2764 * docutils/languages/it.py: Added to project; Italian mappings by
2765   Nicola Larosa.
2767 * docutils/languages/sk.py: Added to project; Slovak mappings by
2768   Miroslav Vasko.
2770 * docutils/parser/__init__.py:
2772   - Added ``Parser.finish_parse()`` method.
2774 * docutils/parser/rst/__init__.py:
2776   - Added options: "--pep-references", "--rfc-references",
2777     "--tab-width", "--trim-footnote-reference-space".
2779 * docutils/parsers/rst/states.py:
2781   - Changed "title under/overline too short" system messages from INFO
2782     to WARNING, and fixed its insertion location.
2783   - Fixed enumerated list item parsing to allow paragraphs & section
2784     titles to begin with enumerators.
2785   - Converted system messages to use the new "line" attribute.
2786   - Fixed a substitution reference edge case.
2787   - Added support for "--pep-references" and "--rfc-references"
2788     options; reworked ``Inliner`` code to make customization easier.
2789   - Removed field argument parsing.
2790   - Added support for short section title over/underlines.
2791   - Fixed "simple reference name" regexp to ignore text like
2792     "object.__method__"; not an anonymous reference.
2793   - Added support for improved diagnostics.
2794   - Reworked directive API, based on Dethe Elza's contribution.  Added
2795     ``Body.parse_directive()``, ``.parse_directive_options()``,
2796     ``.parse_directive_arguments()`` methods.
2797   - Added ``ExtensionOptions`` class, to parse directive options
2798     without parsing field bodies.  Factored
2799     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2800     ``ExtensionOptions``.
2801   - Improved definition list term/classifier parsing.
2802   - Added warnings for unknown directives.
2803   - Renamed ``Stuff`` to ``Struct``.
2804   - Now flagged as errors: transitions at the beginning or end of
2805     sections, empty sections (except title), and empty documents.
2806   - Updated for ``statemachine.StringList``.
2807   - Enabled recognition of schemeless email addresses in targets.
2808   - Added support for embedded URIs in hyperlink references.
2809   - Added backslash-escapes to inline markup end-string suffix.
2810   - Added support for correct interpreted text processing.
2811   - Fixed nested title parsing (topic, sidebar directives).
2812   - Added special processing of backslash-escaped whitespace (idea
2813     from David Abrahams).
2814   - Made substitutions case-sensitive-but-forgiving; moved some code
2815     to ``docutils.nodes``.
2816   - Added support for block quote attributions.
2817   - Added a kludge to work-around a conflict between the bubble-up
2818     parser strategy and short titles (<= 3 char-long over- &
2819     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2820     titles" submitted by Jason Diamond.
2821   - Added explicit interpreted text roles for standard inline markup:
2822     "emphasis", "strong", "literal".
2823   - Implemented "superscript" and "subscript" interpreted text roles.
2824   - Added initial support for "abbreviation" and "acronym" roles;
2825     incomplete.
2826   - Added support for "--trim-footnote-reference-space" option.
2827   - Optional space before colons in directives & hyperlink targets.
2829 * docutils/parsers/rst/tableparser.py:
2831   - Fixed a bug that was producing unwanted empty rows in "simple"
2832     tables.
2833   - Detect bad column spans in "simple" tables.
2835 * docutils/parsers/rst/directives: Updated all directive functions to
2836   new API.
2838 * docutils/parsers/rst/directives/__init__.py:
2840   - Added ``flag()``, ``unchanged()``, ``path()``,
2841     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2842     directive option helper functions.
2843   - Added warnings for unknown directives.
2844   - Return ``None`` for missing directives.
2845   - Added ``register_directive()``, thanks to William Dode and Paul
2846     Moore.
2848 * docutils/parsers/rst/directives/admonitions.py:
2850   - Added "admonition" directive.
2852 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2853   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2854   "parsed-literal", "rubric", "epigraph", "highlights" and
2855   "pull-quote" directives.
2857 * docutils/parsers/rst/directives/images.py:
2859   - Added an "align" attribute to the "image" & "figure" directives
2860     (by Adam Chodorowski).
2861   - Added "class" option to "image", and "figclass" to "figure".
2863 * docutils/parsers/rst/directives/misc.py:
2865   - Added "include", "raw", and "replace" directives, courtesy of
2866     Dethe Elza.
2867   - Added "unicode" and "class" directives.
2869 * docutils/parsers/rst/directives/parts.py:
2871   - Added the "sectnum" directive; by Dmitry Jemerov.
2872   - Added "class" option to "contents" directive.
2874 * docutils/parsers/rst/directives/references.py: Added to project.
2875   Contains the "target-notes" directive.
2877 * docutils/parsers/rst/languages/__init__.py:
2879   - Return ``None`` from get_language() for missing language modules.
2881 * docutils/parsers/rst/languages/de.py: Added to project; German
2882   mappings by Engelbert Gruber.
2884 * docutils/parsers/rst/languages/en.py:
2886   - Added interpreted text roles mapping.
2888 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2889   mappings by Marcelo Huerta San Martin.
2891 * docutils/parsers/rst/languages/fr.py: Added to project; French
2892   mappings by William Dode.
2894 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2895   mappings by Nicola Larosa.
2897 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2898   mappings by Miroslav Vasko.
2900 * docutils/readers/__init__.py:
2902   - Added support for the observer pattern from ``utils.Reporter``, in
2903     ``Reader.parse`` and ``Reader.transform``.
2904   - Removed ``Reader.transform()`` method.
2905   - Added default parameter values to ``Reader.__init__()`` to make
2906     instantiation easier.
2907   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2909 * docutils/readers/pep.py:
2911   - Added the ``peps.TargetNotes`` transform to the Reader.
2912   - Removed PEP & RFC reference detection code; moved to
2913     parsers/rst/states.py as options (enabled here by default).
2914   - Added support for pre-acceptance PEPs (no PEP number yet).
2915   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2916     easy subclassing.
2918 * docutils/readers/python: Python Source Reader subpackage added to
2919   project, including preliminary versions of:
2921   - __init__.py
2922   - moduleparser.py: Parser for Python modules.
2924 * docutils/transforms/__init__.py:
2926   - Added ``Transformer`` class and completed transform reform.
2927   - Added unknown_reference_resolvers list for each transformer. This list holds
2928     the list of functions provided by each component of the transformer that
2929     help resolve references.
2931 * docutils/transforms/frontmatter.py:
2933   - Improved support for generic fields.
2934   - Fixed bibliographic field language lookups.
2936 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2937   transforms.
2939 * docutils/transforms/parts.py:
2941   - Moved the "id" attribute from TOC list items to the references
2942     (``Contents.build_contents()``).
2943   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2944   - Added "class" attribute support to ``Contents``.
2946 * docutils/transforms/peps.py:
2948   - Added ``mask_email()`` function, updating to pep2html.py's
2949     functionality.
2950   - Linked "Content-Type: text/x-rst" to PEP 12.
2951   - Added the ``TargetNotes`` PEP-specific transform.
2952   - Added ``TargetNotes.cleanup_callback``.
2953   - Added title check to ``Headers``.
2955 * docutils/transforms/references.py:
2957   - Added the ``TargetNotes`` generic transform.
2958   - Split ``Hyperlinks`` into multiple transforms.
2959   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2960   - Added check for circular indirect references.
2961   - Made substitutions case-sensitive-but-forgiving.
2963 * docutils/transforms/universal.py:
2965   - Added support for the "--expose-internal-attributes" option.
2966   - Removed ``Pending`` transform classes & data.
2968 * docutils/writers/__init__.py:
2970   - Removed ``Writer.transform()`` method.
2972 * docutils/writers/docutils-xml.py:
2974   - Added XML and doctype declarations.
2975   - Added "--no-doctype" and "--no-xml-declaration" options.
2977 * docutils/writers/html4css1.py:
2979   - "name" attributes only on these tags: a, applet, form, frame,
2980     iframe, img, map.
2981   - Added "name" attribute to <a> in section titles for Netscape 4
2982     support (bug report: Pearu Peterson).
2983   - Fixed targets (names) on footnote, citation, topic title,
2984     problematic, and system_message nodes (for Netscape 4).
2985   - Changed field names from "<td>" to "<th>".
2986   - Added "@" to "&#64;" encoding to thwart address harvesters.
2987   - Improved the vertical whitespace optimization; ignore "invisible"
2988     nodes (targets, comments, etc.).
2989   - Improved inline literals with ``<span class="pre">`` around chunks
2990     of text and ``&nbsp;`` for runs of spaces.
2991   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2992     ``self.docinfo`` segments.
2993   - Added support for "line_block", "address" elements.
2994   - Improved backlinks (footnotes & system_messages).
2995   - Improved system_message output.
2996   - Redefined "--stylesheet" as containing an invariant URL, used
2997     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2998     working directory.
2999   - Added "--footnote-references" option (superscript or brackets).
3000   - Added "--compact-lists" and "--no-compact-lists" options.
3001   - Added "--embed-stylesheet" and "--link-stylesheet" options;
3002     factored out ``HTMLTranslator.get_stylesheet_reference()``.
3003   - Improved field list rendering.
3004   - Added Docutils version to "generator" meta tag.
3005   - Fixed a bug with images; they must be inline, so wrapped in <p>.
3006   - Improved layout of <pre> HTML source.
3007   - Fixed attribute typo on <colspec>.
3008   - Refined XML prologue.
3009   - Support for no stylesheet.
3010   - Removed "interpreted" element support.
3011   - Added support for "title_reference", "sidebar", "attribution",
3012     "rubric", and generic "admonition" elements.
3013   - Added "--attribution" option.
3014   - Added support for "inline", "subscript", "superscript" elements.
3015   - Added initial support for "abbreviation" and "acronym";
3016     incomplete.
3018 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3019   (from the sandbox).
3021   - Added french.
3022   - Double quotes in literal blocks (special treatment for de/ngerman).
3023   - Added '--hyperlink-color' option ('0' turns off coloring of links).
3024   - Added  "--attribution" option.
3025   - Right align attributions.
3027 * docutils/writers/pep_html.py:
3029   - Parameterized output encoding in PEP template.
3030   - Reworked substitutions from ``locals()`` into ``subs`` dict.
3031   - Redefined "--pep-stylesheet" as containing an invariant URL, used
3032     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
3033     working directory.
3034   - Added an override on the "--footnote-references" option.
3035   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3036   - Added Docutils version to "generator" meta tag.
3037   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3039 * docs/tools.txt:
3041   - Added a "silent" setting for ``buildhtml.py``.
3042   - Added a "Getting Help" section.
3043   - Rearranged the structure.
3044   - Kept up to date, with new settings, command-line options etc.
3045   - Added section for ``rst2latex.py`` (Engelbert Gruber).
3046   - Converted settings table into a definition list.
3048 * docs/rst/quickstart.txt:
3050   - Added a table of contents.
3051   - Added feedback information.
3052   - Added mention of minimum section title underline lengths.
3053   - Removed the 4-character minimum for section title underlines.
3055 * docs/rst/quickref.html:
3057   - Added a "Getting Help" section.
3058   - Added a style to make section title backlinks more subtle.
3059   - Added mention of minimum section title underline lengths.
3060   - Removed the 4-character minimum for section title underlines.
3062 * extras: Directory added to project; contains third-party modules
3063   that Docutils depends on (optparse, textwrap, roman).  These are
3064   only installed if they're not already present.
3066 * licenses: Directory added to project; contains copies of license
3067   files for non-public-domain files.
3069 * spec/doctree.txt:
3071   - Changed the focus.  It's about DTD elements:  structural
3072     relationships, semantics, and external (public) attributes.  Not
3073     about the element class library.
3074   - Moved some implementation-specific stuff into ``docutils.nodes``
3075     docstrings.
3076   - Wrote descriptions of all common attributes and parameter
3077     entities.  Filled in introductory material.
3078   - Working through the element descriptions: 55 down, 37 to go.
3079   - Removed "Representation of Horizontal Rules" to
3080     spec/rst/alternatives.txt.
3082 * spec/docutils.dtd:
3084   - Added "generated" inline element.
3085   - Added "line_block" body element.
3086   - Added "auto" attribute to "title".
3087   - Changed content models of "literal_block" and "doctest_block" to
3088     ``%text.model``.
3089   - Added ``%number;`` attribute type parameter entity.
3090   - Changed ``%structural.elements;`` to ``%section.elements``.
3091   - Updated attribute types; made more specific.
3092   - Added "address" bibliographic element.
3093   - Added "line" attribute to ``system_message`` element.
3094   - Removed "field_argument" element; "field_name" may contain
3095     multiple words and whitespace.
3096   - Changed public identifier to docutils.sf.net.
3097   - Removed "interpreted" element; added "title_reference",
3098     "abbreviation", "acronym".
3099   - Removed "refuri" attribute from "footnote_reference" and
3100     "citation_reference".
3101   - Added "sidebar", "rubric", "attribution", "admonition",
3102     "superscript", "subscript", and "inline" elements.
3104 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3106 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3108 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3110 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3111   Dallas Mahrt.
3113 * spec/transforms.txt: Added to project.
3115 * spec/howto: Added subdirectory, for developer how-to docs.
3117 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
3118   Elza, edited & extended by David Goodger.
3120 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
3121   project.
3123 * spec/rst/alternatives.txt:
3125   - Added "Doctree Representation of Transitions" from
3126     spec/doctree.txt.
3127   - Updated "Inline External Targets" & closed the debate.
3128   - Added ideas for interpreted text syntax extensions.
3129   - Added "Nested Inline Markup" section.
3131 * spec/rst/directives.txt:
3133   - Added directives: "topic", "sectnum", "target-notes",
3134     "line-block", "parsed-literal", "include", "replace", "sidebar",
3135     "admonition", "rubric", "epigraph", "highlights", "unicode" and
3136     "class".
3137   - Formalized descriptions of directive details.
3138   - Added an "align" attribute to the "image" & "figure" directives
3139     (by Adam Chodorowski).
3140   - Added "class" options to "topic", "sidebar", "line-block",
3141     "parsed-literal", "contents", and "image"; and "figclass" to
3142     "figure".
3144 * spec/rst/interpreted.txt: Added to project.  Descriptions of
3145   interpreted text roles.
3147 * spec/rst/introduction.txt:
3149   - Added pointers to material for new users.
3151 * spec/rst/reStructuredText.txt:
3153   - Disambiguated comments (just add a newline after the "::").
3154   - Updated enumerated list description; added a discussion of the
3155     second-line validity checking.
3156   - Updated directive description.
3157   - Added a note redirecting newbies to the user docs.
3158   - Expanded description of inline markup start-strings in non-markup
3159     contexts.
3160   - Removed field arguments and made field lists a generic construct.
3161   - Removed the 4-character minimum for section title underlines.
3162   - Clarified term/classifier delimiter & inline markup ambiguity
3163     (definition lists).
3164   - Added "Embedded URIs".
3165   - Updated "Interpreted Text" section.
3166   - Added "Character-Level Inline Markup" section.
3168 * test: Continually adding & updating tests.
3170   - Moved test/test_rst/ to test/test_parsers/test_rst/.
3171   - Moved test/test_pep/ to test/test_readers/test_pep/.
3172   - Added test/test_readers/test_python/.
3173   - Added test/test_writers/ (Engelbert Gruber).
3175 * tools:
3177   - Made the ``locale.setlocale()`` calls in front ends
3178     fault-tolerant.
3180 * tools/buildhtml.py:
3182   - Added "--silent" option.
3183   - Fixed bug with absolute paths & "--config".
3184   - Updated for new I/O classes.
3185   - Added some exception handling.
3186   - Separated publishers' setting defaults; prevents interference.
3187   - Updated for new ``publish_file()`` convenience function.
3189 * tools/pep-html-template:
3191   - Allow for "--embed-stylesheet".
3192   - Added Docutils version to "generator" meta tag.
3193   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3194   - Conform to XHTML spec.
3196 * tools/pep2html.py:
3198   - Made ``argv`` a parameter to ``main()``.
3199   - Added support for "Content-Type:" header & arbitrary PEP formats.
3200   - Linked "Content-Type: text/plain" to PEP 9.
3201   - Files skipped (due to an error) are not pushed onto the server.
3202   - Updated for new I/O classes.
3203   - Added ``check_requirements()`` & ``pep_type_error()``.
3204   - Added some exception handling.
3205   - Updated for new ``publish_string()`` convenience function.
3206   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3208 * tools/quicktest.py:
3210   - Added "-V"/"--version" option.
3212 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3214 * tools/unicode2rstsubs.py: Added to project.  Produces character
3215   entity files (reSructuredText substitutions) from the MathML master
3216   unicode.xml file.
3218 * tools/editors: Support code for editors, added to project.  Contains
3219   ``emacs/restructuredtext.el``.
3221 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3223   - Added style for chunks of inline literals.
3224   - Removed margin for first child of table cells.
3225   - Right-aligned field list names.
3226   - Support for auto-numbered section titles in TOCs.
3227   - Increased the size of inline literals (<tt>) in titles.
3228   - Restored the light gray background for inline literals.
3229   - Added support for "line_block" elements.
3230   - Added style for "address" elements.
3231   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3232   - Improved field list rendering.
3233   - Vertical whitespace improvements.
3234   - Removed "a.target" style.
3236 * tools/stylesheets/pep.css:
3238   - Fixed nested section margins.
3239   - Other changes parallel those of ``../default.css``.
3242 Release 0.2 (2002-07-31)
3243 ========================
3245 General:
3247 - The word "component" was being used ambiguously.  From now on,
3248   "component" will be used to mean "Docutils component", as in Reader,
3249   Writer, Parser, or Transform.  Portions of documents (Table of
3250   Contents, sections, etc.)  will be called "document parts".
3251 - Did a grand renaming: a lot of ``verylongnames`` became
3252   ``very_long_names``.
3253 - Cleaned up imports: no more relative package imports or
3254   comma-separated lists of top-level modules.
3255 - Added support for an option values object which carries default
3256   settings and overrides (from command-line options and library use).
3257 - Added internal Unicode support, and support for both input and
3258   output encodings.
3259 - Added support for the ``docutils.io.IO`` class & subclasses.
3261 Specific:
3263 * docutils/__init__.py:
3265   - Added ``ApplicationError`` and ``DataError``, for use throughout
3266     the package.
3267   - Added ``Component`` base class for Docutils components; implements
3268     the ``supports`` method.
3269   - Added ``__version__`` (thus, ``docutils.__version__``).
3271 * docutils/core.py:
3273   - Removed many keyword parameters to ``Publisher.__init__()`` and
3274     ``publish()``; bundled into an option values object.  Added
3275     "argv", "usage", "description", and "option_spec" parameters for
3276     command-line support.
3277   - Added ``Publisher.process_command_line()`` and ``.set_options()``
3278     methods.
3279   - Reworked I/O model for ``docutils.io`` wrappers.
3280   - Updated ``Publisher.set_options()``; now returns option values
3281     object.
3282   - Added support for configuration files (/etc/docutils.conf,
3283     ./docutils.conf, ~/.docutils).
3284   - Added ``Publisher.setup_option_parser()``.
3285   - Added default usage message and description.
3287 * docutils/frontend.py: Added to project; support for front-end
3288   (command-line) scripts.  Option specifications may be augmented by
3289   components.  Requires Optik (http://optik.sf.net/) for option
3290   processing (installed locally as docutils/optik.py).
3292 * docutils/io.py: Added to project; uniform API for a variety of input
3293   output mechanisms.
3295 * docutils/nodes.py:
3297   - Added ``TreeCopyVisitor`` class.
3298   - Added a ``copy`` method to ``Node`` and subclasses.
3299   - Added a ``SkipDeparture`` exception for visitors.
3300   - Renamed ``TreePruningException`` from ``VisitorException``.
3301   - Added docstrings to ``TreePruningException``, subclasses, and
3302     ``Nodes.walk()``.
3303   - Improved docstrings.
3304   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
3305   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
3306     imports.
3307   - Added ``decoration``, ``header``, and ``footer`` node classes, and
3308     ``PreDecorative`` mixin.
3309   - Reworked the name/id bookkeeping; to ``document``, removed
3310     ``explicit_targets`` and ``implicit_targets`` attributes, added
3311     ``nametypes`` attribute and ``set_name_id_map`` method.
3312   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
3313     traversals.
3314   - Added ``document.has_name()`` method.
3315   - Fixed DOM generation for list-attributes.
3316   - Added category class ``Labeled`` (used by footnotes & citations).
3317   - Added ``Element.set_class()`` method (sets "class" attribute).
3319 * docutils/optik.py: Added to project.  Combined from the Optik
3320   package, with added option groups and other modifications.  The use
3321   of this module is probably only temporary.
3323 * docutils/statemachine.py:
3325   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
3326   - Added underscores to improve many awkward names.
3327   - In ``string2lines()``, changed whitespace normalizing translation
3328     table to regexp; restores Python 2.0 compatibility with Unicode.
3330 * docutils/urischemes.py:
3332   - Filled in some descriptions.
3333   - Added "shttp" scheme.
3335 * docutils/utils.py:
3337   - Added ``clean_rcs_keywords`` function (moved from
3338     docutils/transforms/frontmatter.py
3339     ``DocInfo.filter_rcs_keywords``).
3340   - Added underscores to improve many awkward names.
3341   - Changed names of Reporter's thresholds:
3342     warning_level -> report_level; error_level -> halt_level.
3343   - Moved ``utils.id()`` to ``nodes.make_id()``.
3344   - Added ``relative_path(source, target)``.
3346 * docutils/languages/de.py: German mappings; added to project.  Thanks
3347   to Gunnar Schwant for the translations.
3349 * docutils/languages/en.py: Added "Dedication" bibliographic field
3350   mappings.
3352 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
3353   Chodorowski.
3355 * docutils/parsers/rst/states.py:
3357   - Added underscores to improve many awkward names.
3358   - Added RFC-2822 header support.
3359   - Extracted the inline parsing code from ``RSTState`` to a separate
3360     class, ``Inliner``, which will allow easy subclassing.
3361   - Made local bindings for ``memo`` container & often-used contents
3362     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
3363   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
3364   - Added ``MarkupMismatch`` exception; for late corrections.
3365   - Added ``-/:`` characters to inline markup's start string prefix,
3366     ``/`` to end string suffix.
3367   - Fixed a footnote bug.
3368   - Fixed a bug with literal blocks.
3369   - Applied patch from Simon Budig: simplified regexps with symbolic
3370     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
3371   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
3372   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
3373   - Allowed non-ASCII in "simple names" (directive names, field names,
3374     references, etc.).
3375   - Converted ``Inliner.patterns.initial`` to be dynamically built
3376     from parts with ``build_regexp()`` function.
3377   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
3378   - Updated docstrings.
3379   - Changed "table" to "grid_table"; added "simple_table" support.
3381 * docutils/parsers/rst/tableparser.py:
3383   - Changed ``TableParser`` to ``GridTableParser``.
3384   - Added ``SimpleTableParser``.
3385   - Refactored naming.
3387 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
3388   a fallback language for directive names.
3390 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
3391   directive to use a ``pending`` element, used only by HTML writers.
3393 * docutils/parsers/rst/directives/parts.py: Renamed from
3394   components.py.
3396   - Added "backlinks" attribute to "contents" directive.
3398 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
3399   project by Adam Chodorowski.
3401 * docutils/readers/__init__.py: Gave Readers more control over
3402   choosing and instantiating Parsers.
3404 * docutils/readers/pep.py: Added to project; for PEP processing.
3406 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
3407   requires a ``component`` parameter.
3409 * docutils/transforms/components.py: Added to project; transforms
3410   related to Docutils components.
3412 * docutils/transforms/frontmatter.py:
3414   - In ``DocInfo.extract_authors``, check for a single "author" in an
3415     "authors" group, and convert it to a single "author" element.
3416   - Added support for "Dedication" and generic bibliographic fields.
3418 * docutils/transforms/peps.py: Added to project; PEP-specific.
3420 * docutils/transforms/parts.py: Renamed from old components.py.
3422   - Added filter for `Contents`, to use alt-text for inline images,
3423     and to remove inline markup that doesn't make sense in the ToC.
3424   - Added "name" attribute to TOC topic depending on its title.
3425   - Added support for optional TOC backlinks.
3427 * docutils/transforms/references.py: Fixed indirect target resolution
3428   in ``Hyperlinks`` transform.
3430 * docutils/transforms/universal.py:
3432   - Changed ``Messages`` transform to properly filter out system
3433     messages below the warning threshold.
3434   - Added ``Decorations`` transform (support for ``--generator``,
3435     ``--date``, ``--time``, ``--source-link`` options).
3437 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3438   Engelbert Gruber's PDF writer.
3440 * docutils/writers/html4css1.py:
3442   - Made XHTML-compatible (switched to lowercase element & attribute
3443     names; empty tag format).
3444   - Escape double-dashes in comment text.
3445   - Improved boilerplate & modularity of output.
3446   - Exposed modular output in Writer class.
3447   - Added a "generator" meta tag to <head>.
3448   - Added support for the ``--stylesheet`` option.
3449   - Added support for ``decoration``, ``header``, and ``footer``
3450     elements.
3451   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3452     translation table to regexp; restores Python 2.0 compatibility
3453     with Unicode.
3454   - Added the translator class as instance variable to the Writer, to
3455     make it easily subclassable.
3456   - Improved option list spacing (thanks to Richard Jones).
3457   - Modified field list output.
3458   - Added backlinks to footnotes & citations.
3459   - Added percentage widths to "<col>" tags (from colspec).
3460   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3461     "<span>" changed to "<var>".
3462   - Inline literals: "<code>" changed to "<tt>".
3463   - Many changes to optimize vertical space: compact simple lists etc.
3464   - Add a command-line options & directive attributes to control TOC
3465     and footnote/citation backlinks.
3466   - Added support for optional footnote/citation backlinks.
3467   - Added support for generic bibliographic fields.
3468   - Identify backrefs.
3469   - Relative URLs for stylesheet links.
3471 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3472   PEPs (subclass of ``html4css1.Writer``).
3474 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3476 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3477   of the Docutils internal doctree in XML.
3479 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3481 * spec/doctree.txt:
3483   - Changed the title to "The Docutils Document Tree".
3484   - Added "Hyperlink Bookkeeping" section.
3486 * spec/docutils.dtd:
3488   - Added ``decoration``, ``header``, and ``footer`` elements.
3489   - Brought ``interpreted`` element in line with the parser: changed
3490     attribute "type" to "role", added "position".
3491   - Added support for generic bibliographic fields.
3493 * spec/notes.txt: Continual updates.  Added "Project Policies".
3495 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
3496   section.
3498 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3500 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
3501   mailing list discussions.
3503 * spec/pep-0287.txt:
3505   - Renamed to "reStructuredText Docstring Format".
3506   - Minor edits.
3507   - Reworked Q&A as an enumerated list.
3508   - Converted to reStructuredText format.
3510 * spec/pysource.dtd:
3512   - Reworked structural elements, incorporating ideas from Tony Ibbs.
3514 * spec/pysource.txt: Removed from project.  Moved much of its contents
3515   to pep-0258.txt.
3517 * spec/rst/alternatives.txt:
3519   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3520   - Added "Inline External Targets" section.
3522 * spec/rst/directives.txt:
3524   - Added "backlinks" attribute to "contents" directive.
3526 * spec/rst/problems.txt:
3528   - Updated the Enumerated List Markup discussion.
3529   - Added new alternative table markup syntaxes.
3531 * spec/rst/reStructuredText.txt:
3533   - Clarified field list usage.
3534   - Updated enumerated list description.
3535   - Clarified purpose of directives.
3536   - Added ``-/:`` characters to inline markup's start string prefix,
3537     ``/`` to end string suffix.
3538   - Updated "Authors" bibliographic field behavior.
3539   - Changed "inline hyperlink targets" to "inline internal targets".
3540   - Added "simple table" syntax to supplement the existing but
3541     newly-renamed "grid tables".
3542   - Added cautions for anonymous hyperlink use.
3543   - Added "Dedication" and generic bibliographic fields.
3545 * test: Made test modules standalone (subdirectories became packages).
3547 * test/DocutilsTestSupport.py:
3549   - Added support for PEP extensions to reStructuredText.
3550   - Added support for simple tables.
3551   - Refactored naming.
3553 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3555   - Now supports true packages containing test modules
3556     (``__init__.py`` files required); fixes duplicate module name bug.
3558 * test/test_pep/: Subpackage added to project; PEP testing.
3560 * test/test_rst/test_SimpleTableParser.py: Added to project.
3562 * tools:
3564   - Updated html.py and publish.py front-end tools to use the new
3565     command-line processing facilities of ``docutils.frontend``
3566     (exposed in ``docutils.core.Publisher``), reducing each to just a
3567     few lines of code.
3568   - Added ``locale.setlocale()`` calls to front-end tools.
3570 * tools/buildhtml.py: Added to project; batch-generates .html from all
3571   the .txt files in directories and subdirectories.
3573 * tools/default.css:
3575   - Added support for ``header`` and ``footer`` elements.
3576   - Added styles for "Dedication" topics (biblio fields).
3578 * tools/docutils.conf: A configuration file; added to project.
3580 * tools/docutils-xml.py: Added to project.
3582 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3584 * tools/pep-html-template: Added to project.
3586 * tools/pep2html.py: Added to project from Python (nondist/peps).
3587   Added support for Docutils (reStructuredText PEPs).
3589 * tools/quicktest.py:
3591   - Added the ``--attributes`` option, hacked a bit.
3592   - Added a second command-line argument (output file); cleaned up.
3594 * tools/stylesheets/: Subdirectory added to project.
3596 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3599 Release 0.1 (2002-04-20)
3600 ========================
3602 This is the first release of Docutils, merged from the now inactive
3603 reStructuredText__ and `Docstring Processing System`__ projects.  For
3604 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3605 `DPS HISTORY`__ files.
3607 __ http://structuredtext.sourceforge.net/
3608 __ http://docstring.sourceforge.net/
3609 __ http://structuredtext.sourceforge.net/HISTORY.html
3610 __ http://docstring.sourceforge.net/HISTORY.html
3612 General changes: renamed 'dps' package to 'docutils'; renamed
3613 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3614 the test suites (reStructuredText's test/test_states renamed to
3615 test/test_rst); and all modifications required to make it all work.
3617 * docutils/parsers/rst/states.py:
3619   - Improved diagnostic system messages for missing blank lines.
3620   - Fixed substitution_reference bug.
3624    Local Variables:
3625    mode: indented-text
3626    indent-tabs-mode: nil
3627    sentence-end-double-space: t
3628    fill-column: 70
3629    End: