Small documentation updates and fixes.
[docutils.git] / docutils / HISTORY.txt
blob5e9ea5b6ab0bad2caf20d7c04e69e486989f402d
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: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
14 .. contents::
17 Changes Since 0.16
18 ==================
20 Version 0.17b1
22 * General
24   - Installing with ``setup.py`` now requires ``setuptools``.
25     Alternatively, install with `pip`_ (or "manually").
26   - Use importlib.import_module() to programmatically import modules.
27   - Fix bug #385: Import of language modules.
29   .. _pip: https://pypi.org/project/pip/
31 * docutils/MANIFEST.in
33   - Exclude test outputs.
35 * docutils/__init__.py
37   - VersionInfo: ValueError for invalid values, fix comparison to tuples.
39 * docutils/languages/  
40   docutils/parsers/rst/languages/
42   - Apply patch # 177 Arabic mappings by Shahin.
43   - Apply patch for bug #399 Fixes in Korean translation.
45 * docutils/nodes.py
47   - Apply patch #165 "Fix error when copying `system_message` node"
48     by Takeshi KOMIYA.
49   - Apply version of patch #167 "Let document.set_id() register all
50     existing IDs" (thanks to Takeshi KOMIYA).
51   - Fix bug #410: Use a "property" function to recursively fetch
52     `Node.document` value from parent node.
54 * docutils/parsers/recommonmark_wrapper.py
56   - New, experimental wrapper to integrate the
57     `recommonmark`__ Markdown parser for use with Docutils.
59     __ https://pypi.org/project/recommonmark/
61 * docutils/parsers/rst/directives/body.py
63   - Make the sidebar's "title" argument optional (feature request #69).
65 * docutils/parsers/rst/directives/html.py
67   - Make "meta" elements available for "latex" and "odt".
69 * docutils/parsers/rst/directives/misc.py
71   - Prevent infinite inclusion loops.
73 * docutils/parsers/rst/roles.py
75   - Apply patch #174 Lowercase new role names on registration
77 * docutils/utils/smartquotes.py
79   - Fix bug #383: Smart quotes around opening and separator characters.
81 * docutils/transforms/components.py
83   - Allow a comma-separated list of formats for the Filter transform.
85 * docutils/writers/html*
87   - Implement feature request #40 `Option to embed images as data URI`.
89 * docutils/writers/html5_polyglot/__init__.py
91   - Use the new semantic tags <main>, <section>, <header>,
92     <footer>, <aside>, <figure>, and <figcaption>.
93     See ``minimal.css`` and ``plain.css`` for styling rule examples.
95     Change the `initial_header_level` setting default to "2", as browsers
96     use the `same style for <h1> and <h2> when nested in a <section\>`__.
98     __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
100   - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
101     <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
102     is found in `inline` and `literal` elements.
103     Use <ins> and <del> if a matching class value
104     is found in `inline`, `literal`, or `container` elements.
106 * docutils/writers/html5_polyglot/responsive.css
108   - New optional stylesheet that adapts to different screen sizes.
110 * docutils/writers/html5_polyglot/minimal.css
112   - Move non-essential styling to ``plain.css``.
113     Support "captionbelow" class value for tables.
114     Small fixes and tweaks.
116 * docutils/writers/html5_polyglot/plain.css
118   - Support numbered figures.
119   - Fix bug #398: properly close link tag to "schema.dcterms".
121 * docutils/writers/html5_polyglot/responsive.css
123   - New optional stylesheet for better readability on different
124     screens.
126 * docutils/writers/html5_polyglot/minimal.css
128   - Move non-essential styling from  to ``plain.css``.
129     Support "captionbelow" class value for tables.
130     Small fixes and tweaks.
132 * docutils/writers/html5_polyglot/plain.css
134   - Support numbered figures.
136 * docutils/writers/latex2e/__init__.py:
138   - Use LaTeX environments for admonitions and "class wrappers" for styling
139     admonitions and titles if the new configuration setting
140     `legacy_class_functions`_ is False.
142     .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
144   - Remove backwards compatibility code for the deprecated
145     `styling command`__ prefix ``\docutilsrole``.
147     __ docs/user/latex.html#custom-interpreted-text-roles
149   - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
150   
151   - Support the `memoir` LaTeX document class.
152     Fixes bugs #390, #391, and #392.
154   - The special value "auto" for the `graphicx_option`_ setting
155     is no longer supported (it never worked for xetex/luatex).
157     .. _graphicx_option: docs/user/config.html#graphicx-option
159   - Most helper commands and element definitions are now defined in the
160     LaTeX package `docutils.sty`_ and only inserted in the document
161     preamble if the `stylesheet`__ setting does not list "docutils".
163     .. _docutils.sty: https://ctan.org/pkg/docutils
164     __ docs/user/config.html#stylesheet-latex-writers
166   - Apply patch #173 "Make \*TeX writers convert nonstandard table
167     classes to DUclass environments" by John Thorvald Wodder II.
169   - Fix bug #408 "Incorrect assert in latex writer
170     for multiple citation references".
172   - Apply patch #175 "Fix alignment of nested tables",
173     additional fixes to table alignment.
175   - Do not write Docutils-generated ToC, when ``use_latex_toc``
176     is True. (This did happen when publishing from a doctree.)
177     
178   - Set PDF document properties from "meta" directive content.
179   
180   - Apply version of patch #176 "LaTeX writer: Append \leavevmode to
181     non-docinfo field names" by John Thorvald Wodder II.
183 * docutils/writers/manpage.py
185   - Fix #394 fix missing new line after rubric.
186   - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
187   - Fix #126 manpage title with spaces.
188   - Fix #380 commandline option problem in sphinx.
190 * docutils/writers/odf_odt/__init__.py:
192   - Fix/improve metadata handling:
193     fix "keyword" splitting, 
194     allow generic fields (stored as "Custom Properties").
196 * docutils/writers/pseudoxml.py:
198   - New option `detailled`__.
200     __ docs/user/config.html#detailled
202 * test/DocutilsTestSupport.py
204   - Run python3 test like python2 against source not the build/-directory
206 * tools/docutils_cli.py
208   - New generic command line front end that allows the free selection of
209     reader, parser, and writer components.
212 Release 0.16 (2020-01-16)
213 =========================
215 * General
217   - Dropped support for Python 2.6, 3.3 and 3.4
218   - Docutils now supports Python 2.7 and Python 3.5+ natively
219     (without conversion by ``2to3``).
220   - Keep `backslash escapes`__ in the document tree. Backslash characters in
221     text are be represented by NULL characters in the ``text`` attribute of
222     Doctree nodes and removed in the writing stage by the node's
223     ``astext()`` method.
225   __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
227 * docutils/io.py
229   - Remove the `handle_io_errors` option from io.FileInput/Output.
231 * docutils/nodes.py
233   - Speed up Node.next_node().
234   - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
235   - Warn about Node.traverse() returning an iterator instead of a list
236     in future.
238   .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
240 * docutils/statemachine.py
242   - Patch [ 158 ]: Speed up patterns by saving compiled versions (eric89gxl)
244 * docutils/transforms/universal.py
246   - Fix [ 332 ]: Standard backslash escape for smartquotes.
247   - Fix [ 342 ]: No escape in roles descending from `inline literal`.
249 * docutils/utils/__init__.py
251   - unescape() definition moved to `nodes` to avoid circular import
252     dependency. Fixes [ 366 ].
254 * docutils/writers/latex2e/__init__.py:
256   - Fix topic subtitle.
257   - Make "rubric" bold-italic and left aligned.
258   - Fix [ 339 ] don't use "alltt" or literal-block-environment
259     in admonitions and footnotes.
260   - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
261   - Add "latex writers" to the `config_section_dependencies`.
262   - Ignore classes for `rubric` elements
263     (class wrapper interferes with LaTeX formatting).
265 * docutils/writers/manpage.py
267   - Apply fix for [ 287 ] comma after option is bold.
268   - Apply fix for [ 289 ], line starting with ``.`` in a text.
270 * docutils/writers/odf_odt/__init__.py:
272   - Fix: ElementTree.getchildren deprecated warning
274 * docutils/writers/xetex/__init__.py:
276   - Add "latex writers" to the `config_section_dependencies`.
278 * test/alltests.py
280   - Fix: 377 ResourceWarning: unclosed file python3.8
281     Close alltests.out with atexit.
283 * test/functional/*
285   - Fix: 377 ResourceWarning: unclosed file python3.8
286     Read defaults file with context.
288   - Set "auto_id_prefix" to "%" (expands to tag-names).
289     Results in descriptive links in HTML and more localized changes when
290     editions to the input add or remove auto-ids.
292 * test/test_io.py:
294   - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
296 * test/test_writers/test_odt.py:
298   - Fix [ 359 ]: Test suite failes on Python 3.8. odt xml sorting.
299     Use ElementTree instead of minidom.
301 * tools/buildhtml.py
303   - New option `html-writer`_.
305   .. _html-writer: docs/user/config.html#html-writer
308 Release 0.15.1 (2019-07-24)
309 ===========================
311 source: branches/rel-0.15
313 Bugs #366 fix release for python2 only.
316 Release 0.15 (2019-07-20)
317 =========================
319 * General
321   - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
322   - Infrastructure automation.
324 * docs/ref/rst/restructuredtext.txt:
326   - Document rST syntax change: Tokens like ``:this:example:`` are now valid
327     field list names (instead of ordinary text).
329 * docutils/io.py
331   - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
332     deprecated (thanks to hugovk).
334 *  docutils/languages/ko.py
335    docutils/parsers/rst/languages/ko.py:
337   - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
339 * docutils/nodes.py
341   - Fix [ 251 ] system_message.copy() TypeError.
342   - Element.copy() also copies `document`, `line`, and `source` attributes.
344 * docutils/parsers/rst/__init__.py:
346   - Apply [ 152 ] reset `default role` at end of document.
348 * docutils/parsers/rst/states.py:
350   - Allow embedded colons in field list field names.
352 * docutils/parsers/rst/directives/html.py:
354   - Fix bug #281: Remove escaping backslashes in meta directive content.
356 * docutils/parsers/rst/directives/misc.py:
358   - Don't convert tabs to spaces, if `tab_width` is negative in
359     `include` directive with `code` option.
361 * docutils/parsers/rst/directives/tables.py:
363   - Apply patch #121: Add "width" option for the table directives.
365 * docutils/transforms/frontmatter.py:
367   - Add field name as class argument to generic docinfo fields unconditionally.
369 * docutils/transforms/references.py:
371   - Fix bug #331: fixed the "trim" options of the "unicode" directive.
373 * docutils/utils/__init__.py:
375   - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
377 * docutils/utils/smartquotes.py:
379   - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
381 * docutils/writers/html5_polyglot/
383   - automatically add HTML5-compatible meta tags for docinfo items
384     "authors", "date", and "copyright".
386 * docutils/writers/_html_base.py
388   - Fix bug #358: Non-breaking space removed from fixed-width literal.
390 * docutils/writers/latex2e/__init__.py:
392   - Fix bug #323: spurious ``\phantomsection`` and whitespace in
393     ``parts['title']``.
394   - Fix bug #324: Invalid LaTeX for table with empty multicolumn cell.
395   - Fixes to literal block handling.
398 Release 0.14 (2017-08-03)
399 =========================
401 * docs/ref/docutils.dtd:
403   - Enable validation of Docutils XML documents against the DTD:
405     Use attribute type NMTOKEN instead of REFID for the `refid` attribute
406     and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
407     however, the `ids` attribute cannot use the ID type because `XML only
408     allows one ID per Element Type`__ and doesn't support a multiple-ID
409     "IDS" attribute type.
411   __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
413 * docs/ref/rst/restructuredtext.txt:
415   - Added documentation for escaped whitespace in URI contexts.
416   - Clarify use of Unicode character categories.
418 * docutils/parsers/rst/states.py:
420   - Added functionality: escaped whitespace in URI contexts.
421   - Consistent handling of all whitespace characters in inline markup
422     recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
424 * docutils/parsers/rst/directives/images.py:
426   - Added support for escaped whitespace in URI contexts.
428 * docutils/parsers/rst/directives/tables.py:
430   - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
431     that led to problems in an application with a custom table directive).
433 * docutils/transforms/frontmatter.py:
435   - Fix [ 320 ] Russian docinfo fields not recognized.
437 * docutils/transforms/references.py:
439   - Don't add a second ID to problematic references.
441 * docutils/transforms/universal.py:
443   Fix SmartQuotes: warn only once if language is unsupported,
444   keep "rawsource" when "educating" quotes.
446 * docutils/utils/__init__.py:
448   - Added ``split_escaped_whitespace`` function, support for escaped
449     whitespace in URI contexts.
451 * docutils/utils/error_reporting.py:
453   - Fix [ 321 ] Import block might cause name error.
455 * docutils/utils/smartquotes.py:
457   - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
458   - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
459   - Fix [ 313 ] Differentiate apostrophe from closing single quote
460     (if possible).
461   - Fix [ 317 ] Extra space inserted with French smartquotes.
462   - Add command line interface for stand-alone use (requires 2.7).
464 * docutils/writers/_html_base.py:
466   - Provide default title in metadata (required by HTML5).
467   - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
468   - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
469     reasons, we don't use a third party public installation as default but
470     warn if math-output_ is set to MathJax without specifying a URL.
472 * docutils/writers/html4css1/__init__.py:
474   - Apply [ 125 ] HTML writer: respect automatic table column sizing.
476 * docutils/writers/latex2e/__init__.py:
478   - Handle class arguments for block-level elements by wrapping them
479     in a "DUclass" environment. This replaces the special handling for
480     "epigraph" and "topic" elements.
482 * docutils/writers/manpage.py:
484   - Apply [ 141 ] Handling inline in manpage writer.
486 * docutils/writers/odf_odt/__init__.py:
488   - Command setting ``language`` now sets the default language
489     of the generated ODF document.
490   - The use of image directive options :width: (%), :scale:, etc now
491     set the width/height/size of images in the generated ODF
492     documents.
493   - The heading/title of admonitions now reflects the language
494     specified by the ``language`` setting.
495   - Fixed [ 306 ] only first of multiple "image" directives with the same URL
496     shown in output.
497   - Fixed [ 282 ] python3: AttributeError.
499 * tools/rst2html4.py: New front-end.
501 * tools/dev/generate_punctuation_chars.py: New skript
502   to test and update utils.punctuation_chars.
505 Release 0.13.1 (2016-12-09)
506 ===========================
508 * docutils/languages/fa.py
509   docutils/parsers/rst/languages/fa.py
510   docutils/languages/la.py
511   docutils/parsers/rst/languages/la.py:
513   - Apply [ 133 ] Persian mappings by Shahin Azad.
514   - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
516 * docutils/nodes.py
518   - Fix [ 253 ] Attribute key without value not allowed in XML.
520 * docutils/parsers/
522   - Apply [ 103 ] Recognize inline markups without word boundaries.
523   - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
525 * docutils/parsers/rst/__init__.py
527   - Fix [ 233 ] Change the base URL for the :rfc: role.
529 * docutils/parsers/rst/directives/tables.py
531   - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
532     or 'grid'.
534   - Implement feature request [ 48 ]
535     Add :align: option to the table directives.
536     Thanks to Takeshi KOMIYA for the patch.
538 * docutils/parsers/rst/roles.py
540   - Fix [ 295 ] Class argument for custom role inheriting from math.
542 * docutils/parsers/rst/tableparser.py
544   - Really fix [ 159 ] Spurious table column alignment errors.
546 * docutils/transforms/frontmatter.py
548   - Add name of generic bibliographic fields as a "classes" attribute value
549     (after conversion to a valid identifier form).
551 * docutils/utils/error_reporting.py
553   - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
555 * docutils/utils/math/math2html.py
557   - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
558   - New upstream version (additional macros, piecewise integrals and sums).
560 * docutils/writers/_html_base.py
562   - New auxiliary module for definitions common to all HTML writers.
564 * docutils/writers/html5_polyglot/
566   - New HTML writer generating clean, polyglot_ markup conforming to
567     `HTML 5`_.
569     The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
570     and recommended layout rules.
572 * docutils/writers/html4css1/__init__.py
574   - Add "docutils" to class values for "container" object to address [ 267 ].
575   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
576     ``default_stylesheet_path`` and ``default_template_path``.
577   - Fix [ 266 ] creating labels/class values in description list items.
578   - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
579   - Fix footnotes with content that does not start with a paragraph.
580   - Use https in default MathJax URL (report Alan G Isaac).
581   - Outsourcing of common code to _html_base.py.
583 * docutils/writers/latex2e/__init__.py
585   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
586     admonitions and docinfo.
588   - Use absolute path for ``default_template_path``.
590   - Removed deprecated options ``--use-latex-footnotes`` and
591     ``--figure-footnotes``.
593   - Cleaner LaTeX code for enumerations and literal blocks.
595   - Use "hyperref" package together with "bookmark" (improved hyperlinking
596     by the same author).
598   - Fix [ 286 ] Empty column title cause invalid latex file.
600   - Fix [ 224 ] Fix rowspan support for tables.
602   - Let LaTeX determine the column widths in tables with "colwidths-auto".
603     Not suited for multi-paragraph cells!
605 * docutils/writers/odf_odt/__init__.py
607   - remove decode.encode of filename stored in zip.
609 * docutils/writers/xetex/__init__.py
611   - LuaLaTex compatibility: do not load "xunicode".
613 * tools/
615   - New front-end ``rst2html5.py``.
617 * tox.ini
619   - Test py26, py27, py33 and py34.
621     To use, install the ``tox`` package via pip or easy_install and use
622     tox from the project root directory.
624 .. _polyglot: http://www.w3.org/TR/html-polyglot/
625 .. _HTML 5: http://www.w3.org/TR/html5/
626 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
629 Release 0.12 (2014-07-06)
630 =========================
632 * docs/ref/rst/directives.txt
634   - Update "math" and "csv-table" descriptions.
636 * docutils/parsers/rst/directives/images.py
638   - Fix [ 258 ] figwidth="image" generates unitless width value.
640 * docutils/parsers/rst/states.py
642   - Improve error report when a non-ASCII character is specified as
643     delimiter, quote or escape character under Python 2.
644     Fixes [ 249 ] and [ 250 ].
646 * docutils/writers/html4css1/__init__.py
648   - Don't add newline after inline math.
649     Thanks to Yury G. Kudryashov for the patch.
651 * docutils/writers/latex2e/__init__.py
653   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
654   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
656 * docutils/writers/odf_odt/__init__.py
658   - Apply patch by Jakub Wilk to fix bug [ 100 ].
660 * test/test_error_reporting.py
662   - Fix [ 223 ] by removing redundant tests we do not have control over.
664 * test/test_nodes.py
666   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
668 Release 0.11 (2013-07-22)
669 =========================
671 * General
673   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
674   - Support embedded aliases within hyperlink references.
675   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
676     language module) before global search.
678 * docutils/nodes.py
680   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
682 * docutils/parsers/rst/directives/__init__.py
684   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
686 * docutils/parsers/rst/directives/images.py
688   - Apply [ 3599485 ] node source/line information for sphinx translation.
690 * docutils/parsers/rst/directives/tables.py
692   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
694 * docutils/parsers/rst/states.py
696   - Fix [ 157 ] Line block parsing doesn't like system message.
697   - Always import our local copy of roman.py (report Larry Hastings).
699 * docutils/transforms/references.py
701   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
703 * docutils/utils/__init__.py
705   - Fix [ 3596884 ] exception importing ``docutils.io``.
707 * docutils/writers/html4css1/__init__.py
709   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
710   - New setting `stylesheet_dirs`: Comma-separated list of directories
711     where stylesheets are found. Used by `stylesheet_path` when expanding
712     relative path arguments.
713   - New default for math-output_: ``HTML math.css``.
714   - Avoid repeated class declarations in html4css1 writer
715     (modified version of patch [ 104 ]).
717 .. _math-output: docs/user/config.html#math-output
719 * docutils/writers/latex2e/__init__.py
721   - Drop the simple algorithm replacing straight double quotes with
722     English typographic ones.
723     Activate the SmartQuotes_ transform if you want this feature.
724   - Fix literal use of babel shorthands (straight quote, tilde, ...).
725   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
726   - New setting `stylesheet_dirs`.
728 .. _SmartQuotes: docs/user/config.html#smart-quotes
730 * docutils/writers/manpage.py
732   - Fix [3607063] handle lines starting with a period.
733   - Fix option separating comma was bold (thanks to Bill Morris).
735 Release 0.10 (2012-12-16)
736 =========================
738 * General
740   - Dropped support for Python 2.3.
741   - ``docutils/math``, ``docutils/error_reporting.py``, and
742     ``docutils/urischemes.py`` moved to the utils package.
743   - Fix [3541369] Relative __import__ also with Python 3.3.
744   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
745     and parsers for Python 2.7 up.
746   - Fix import of PIL.Image.
747   - Change default of "syntax highlight" option to "long",
748     basic syntax highlight styles for LaTeX and HTML.
750 * docutils/io.py
752   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
753     option is ignored and will be removed in a future release.
754   - Fix Py3k error writing to stdout with encoding differing from default.
755   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
757 * docutils/parsers/rst/directives/misc.py
759   - Fix [ 3546533 ] Unicode error with `date` directive.
761 * docutils/transforms/universal.py
763   - SmartQuotes transform for typographic quotes and dashes.
765 * docutils/utils/__init__.py
767   - normalize_language_tag() now returns `BCP 47`_ conformant tags
768     with subtags separated by ``-``.
770 * docutils/writers/html4css1/__init__.py
772   - Use ``<code>`` tag for inline "code",
773     do not drop nested inline nodes (syntax highlight tokens).
774   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
775   - No line break after opening inline math tag.
777 * docutils/writers/manpage.py
779   - Apply [ 3527401 ] addmonition's don't preserve indentation
780   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
782 * docutils/writers/xetex/__init__.py
784   - Apply [ 3555160 ] ensure order of "otherlanguages".
785   - Fix section numbering by LaTeX.
787 * docutils/writers/s5_html/__init__.py
789   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
791 * docutils/writers/s5_html/docutils_xml.py
793   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
794   - Fix/improve output with ``--indent`` option.
796 * setup.py
798   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
800 * tools/test/test_buildhtml.py
802   - Fix [ 3521167 ] allow running in any directory.
803   - Fix [ 3521168 ] allow running with Python 3.
806 Release 0.9.1 (2012-06-17)
807 ==========================
809 * setup.py
811   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
812     installed in the PYTHONPATH. Converted tests are now
813     stored in ``test3/``, tools no longer need conversion.
815     If you installed one of Docutils versions 0.7 ... 0.9 with
816     ``setup.py install`` under Python 3, remove the spurious
817     ``test/`` and ``tools/`` directories in the site library root.
819 * test/
821   - Make tests independent from the location of the ``test/`` directory.
822   - Use converted sources (from the ``build/`` directory) for tests under
823     Python 3.
825 * tools/
827   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
829 * docutils/io.py
831   - Fix writing binary data to sys.stdout under Python 3 (allows
832     ``rst2odt.py`` to be used with output redirection).
834 * docutils/parsers/rst/directives/misc.py
836   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
837     ``locale == C`` and 8-bit char in path argument of `include` directive.
839 * test/alltests.py
841   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
842     file under Python 3.
844 Release 0.9 (2012-05-02)
845 ========================
847 * General:
849   - New reStructuredText "code" role and directive and "code" option
850     of the "include" directive with syntax highlighting by Pygments_.
851   - Fix parse_option_marker for option arguments containing ``=``.
852   - Fix [ 2993756 ]: import Python Imaging Library's Image module
853     via ``import PIL`` as starting with PIL 1.2,
854     "PIL lives in the PIL namespace only" (announcement__).
856 .. _Pygments: http://pygments.org/
857 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
859 * setup.py
861   - Fix [ 2971827 ] and [ 3442827 ]
862     extras/roman.py moved to docutils/utils/roman.py
864 * docutils/frontend.py
866   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
868 * docutils/io.py
870   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
871   - `mode` argument for FileOutput avoids code replication in
872     BinaryFileOutput.
873   - New exceptions InputError and OutputError for IO errors in
874     FileInput/FileOutput.
876 * docutils/core.py:
878   - No "hard" system exit on file IO errors: catch and report them in
879     `Publisher.reportException` instead. Allows handling by a calling
880     application if the configuration setting `traceback` is True.
882 * docutils/utils.py -> docutils/utils/__init__.py
884   - docutils.utils is now a package (providing a place for sub-modules)
886   .. note:: docutils/math, docutils/error_reporting.py, and
887      docutils/urischemes.py will move to the utils package in the next
888      release, too. See RELEASE-NOTES__
890      __ RELEASE-NOTES.html
892   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
893     errors recording non-ASCII filenames (fixes [ 3434355 ]).
895   - Fix relative_path() with source=None and `unicode` target.
897 * docutils/parsers/rst/states.py
899   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
900     characters and "international" quotes around inline markup.
901   - Use `field_marker` pattern to look for start of a
902     directive option block (fixes [ 3484857 ]).
904 * docutils/parsers/rst/tableparser.py
906   - Fix [ 2926161 ] for simple tables.
907     (Combining chars in grid tables still contribute to cell width.)
909 * docutils/writers/latex2e/__init__.py
911   - Support the `abbreviation` and `acronym` standard roles.
912   - Record only files required to generate the LaTeX source as dependencies.
913   - Fix handling of missing stylesheets.
914   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
915     when suppressing LaTeX section numbering.
916   - Use ``\DUtitle`` for unsupported section levels
917   - Apply [ 3512791 ] do not compare string literals with "is"
919 * docutils/writers/xetex/__init__.py
921   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
923 * docutils/writers/html4css1/__init__.py
925   - Change default for `math-output` setting to MathJax.
926   - Fix handling of missing stylesheets.
928 * docutils/writers/docutils_xml.py
930   - Use the visitor pattern with default_visit()/default_depart() methods
931     instead of minidom to facilitate special handling of selected nodes.
932   - Support raw XML (inserted as-is inside a <raw></raw> node).
934 * docutils/writers/manpage.py
936   - Do not emit comment line with trailing blank. Problematic for VCS.
938 Release 0.8.1 (2011-08-30)
939 ==========================
941 * General:
943   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
944     and [ 3395920 ] (correct copyright info for rst.el).
946 * test/
948   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
950 * docutils/writers/latex2e/__init__.py
952   - Clean up Babel language setting. Restores Sphinx compatibility.
954 Release 0.8 (2011-07-07)
955 ========================
957 * General:
959   - Handle language codes according to `BCP 47`_.
960   - If the specified language is not supported by Docutils,
961     warn and fall back to English.
962   - Math support: reStructuredText "math" role and directive,
963     ``math`` and ``math_block`` doctree elements.
964   - Decode command line arguments with the locale's preferred encoding
965     (to allow, e.g., ``--title=Dornröschen``).
966   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
967   - New sub-module `error_reporting`: handle encoding/decoding errors
968     when reporting exceptions.
969   - Some additions to the Docutils core are released under the 2-Clause BSD
970     license, see COPYING_ for details.
972   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
973   .. _COPYING: COPYING.html
975 * reStructuredText:
977   - Most directives now support a "name" option that attaches a
978     reference name.
980   - Directive content may start on the first line also when the directive
981     type accepts options.
983 * docs/dev/policies.txt:
985   - Recommend the 2-Clause BSD license
986     (http://opensource.org/licenses/BSD-2-Clause)
987     for code that is kept under the author's copyright.
989 * tools/buildhtml.py:
991   - Fix ``--local`` switch.
993 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
995 * docutils/writers/html4css1/__init__.py
997   - Set "lang" argument for objects with class argument
998     "language-<language tag>".
999   - New setting "math-output" with support for HTML, MathML, and LaTeX.
1001 * docutils/writers/latex2e/__init__.py
1003   - Fix [ 3043986 ] AttributeError using :local: with table of content.
1004   - Place title data in the document preamble.
1005   - Load `babel` package only if required.
1006   - Update list of supported languages.
1007   - New config setting "hyperref-options".
1008     No hard-coded "unicode" hyperref option (clash with xetex).
1009   - Set language for custom roles, paragraphs, block-quotes, and
1010     line-quotes with class argument "language-<language tag>".
1011   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
1012   - Convert image URI to a local file path.
1013   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1014     has more than one paragraph (Wolfgang Scherer).
1015   - \leavevmode before longtable only when needed (prevents spurious vspace)
1016   - do not advance table counter for tables without caption
1018 * docutils/writers/xetex/__init__.py
1020   - New writer generating LaTeX code for compiling with ``xelatex``.
1022     A separate writer (inheriting from latex2e) instead of a ``--xetex``
1023     option allows separate config options for XeTeX vs. LaTeX2e.
1025 * docutils/writers/manpage.py
1027   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1028   - Fix: vertical space cleaning for option group ``.``.
1030 * tools/editors/emacs/rst.el:
1032   - Fix [ 3001100 ] does not handle spaces in filenames
1033     (thanks to Jakub Wilk)
1035 * docutils/utils.py:
1037   - strip whitespace from stylesheet arguments
1038   - exclude combining chars from column_width()
1039     (partial fix for [ 2926161 ])
1041 * docutils/parsers/rst/directives/misc.py:
1043   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1044     nested_parse
1046 * docutils/io.py:
1048   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
1049     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1051 Release 0.7 (2010-07-07)
1052 ========================
1054 * General:
1056   - Fix [ 2881769 ] setup configuration.
1057   - Fix [ 2788716 ] reporting problems in included files.
1059 * docutils/io.py
1061   - FileInput opens files as text files with universal newline support
1062     (mode "rU", configurable with the new optional argument "mode").
1064 * docutils/nodes.py
1066   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1068 * docutils/utils.py
1070   - Fix [ 2923723 ] let decode_path() tolerate path == None
1072 * docutils/writers/html4css1/__init__.py
1074   - Support SVG and SWF images (thanks to Stefan Rank).
1075   - Generate valid XHTML for centered images with targets.
1076     Use CSS classes instead of "align" tags for image alignment.
1078 * docutils/writers/latex2e/__init__.py
1080   - Use `transforms.writer_aux.Admonitions` to "normalize" special
1081     admonitions.
1082   - Use the ``\url`` command for URLs (breaks long URLs instead of
1083     writing into the margin).
1084   - Preserve runs of spaces in `inline literals`__.
1085   - Deprecate ``figure_footnotes`` setting.
1086   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
1087   - New ``latex_preamble`` setting.
1088   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1089   - Fix hyperlink targets (labels) for images, figures, and tables.
1090   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1091   - Apply [ 2961991 ] Call hyperref with unicode option.
1092   - Drop the special `output_encoding`__ default ("latin-1").
1093     The Docutils wide default (usually "UTF-8") is used instead.
1094   - Render inline markup in document title and subtitle.
1095   - Fix numbering depth with LaTeX section numbering.
1096   - Update Unicode -> LaTeX translations.
1097   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1099 __ docs/ref/restructuredtext.html#inline-literals
1100 __ docs/user/config.html#docutils-footnotes
1101 __ docs/user/config.html#output_encoding
1103 * docutils/writers/manpage.py
1105   - Fix: supported attribute (thanks to peter2108).
1106   - Remove trailing blanks in code (keep in sync with mercurial version).
1107   - Titles level 1, that is ``.SH``, always uppercase.
1108   - Apply patch from mg: literal text should be bold in man-pages.
1110 * docutils/nodes.py
1112   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1113     turkish locale.
1115 * setup.py:
1117   - Python 3 support: copy test/ and tools/ to the build-dir
1118     and convert Python sources with 2to3.
1121 Release 0.6 (2009-10-11)
1122 ========================
1124 * General:
1126   - Docutils is now compatible with Python versions from 2.3 up to 2.6
1127     and convertible to 3.1 code.
1129     + Node.__nonzero__ returns True instead of 1.
1130     + use os.walk instead os.path.walk.
1131     + minimize "types" module where possible.
1132     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1133     + Text nodes now subclass unicode rather than UserString
1134       (which is gone in python 3.0).
1135     + 3.0 compatibility module docutils._compat
1137     + Drop 2.2 compatibility workarounds.
1138     + Drop extras/optparse.py and extras/textwrap.py
1139       (stdlib modules since 2.3).
1141   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
1142   - Unix man page export: manpage writer moved from sandbox to Doctutils
1143     core.
1145   - Apply [ 1719345 ] Galician translation
1146   - Apply [ 1905741 ] Polish translation
1147   - Apply [ 1878977 ] make_id(): deaccent characters.
1148   - Apply [ 2029251 ] return nonzero when tests fail.
1149   - Fix [ 1692788 ] allow UTF-8 in style sheets.
1150   - Fix [ 2781629 ] support non-ASCII chars in file names.
1151   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1152   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
1153   - Fix [ 2821266 ] --strict option works now like --halt=info.
1154   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
1155   - Fix [ 1627229 ] hyperlink references in substitutions.
1157   - The "newlatex" writer is orphaned.
1159 * reStructuredText:
1161   - Documented Unicode characters allowed as inline markup openers,
1162     closers, and delimiters.
1163   - Allow units for all length specifications.
1164   - Allow percent sign in "scale" argument of "figure" and "image" directives.
1165   - Bugfix: The "figalign" argument of a figure now works as intended
1166     (aligning the figure, not its contents).
1167   - Align images with class "align-[right|center|left]"
1168     (allows setting the alignment of an image in a figure).
1170 * docutils/nodes.py:
1172   - Added ``Element.__contains__`` method, for the in-operator.
1174 * docutils/parsers/rst/states.py:
1176   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1177   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1178     " " (non-breaking space), and "¡ ¿" openers.
1180 * docutils/parsers/directives/misc.py:
1182   - Added ``start-line`` and ``end-line`` options to "include"
1183     directive to select a range of lines.
1184   - Hard tabs in literal inclusions are replaced by spaces. This is
1185     configurable via the new ``tab-width`` option of the "include" directive
1186     (a negative tab-width prevents tab expansion).
1188 * docutils/utils.py:
1190   - Add ``get_stylesheet_list`` function.
1191   - Apply [ 2834836 ] print info at halt
1193 * docutils/transforms/universal.py:
1195   - Raise default priority of StripClasses to exclude stripped classes from
1196     the ToC.
1198 * docutils/writers/html4css1/__init__.py:
1200   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
1201     separated list of stylesheets.
1202   - Address [ 1938891 ] Inline literal text creates "pre" span only when
1203     needed to prevent inter-word line wraps.
1204   - Use `translate` method instead of repeated `replace` calls.
1205   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
1206     classes to allow CSS styling that does not interfere with other
1207     table-using constructs (field lists, citations, ...).
1209 * docutils/writers/newlatex2e/__init__.py:
1211   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1213 * docutils/writers/latex2e/__init__.py:
1215   - Add ``--embed-stylesheet`` option.
1216   - Apply [ 1474017 ] image vertical alignment is reversed.
1217   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1218   - Change: has_key for dictionaries (not Nodes) to in-operator.
1219   - Merge adjacent citations into one latex cite command.
1220   - Failsave implementation of custom roles. LaTeX compilation now ignores
1221     unknown classes instead of aborting with an error.
1222   - Support custom roles based on standard roles.
1223   - LaTeX packages can be used as ``--stylesheet`` arguments without
1224     restriction. (A style sheet is now referenced with the ``\usepackage``
1225     command, if it ends with ``.sty`` or has no extension.)
1226   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
1227   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1228   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1229     2005-02-04 as a configurable length unit).
1230   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1231     if font-encoding is set to ''. LaTeX defaults to OT1 then.
1232   - Set sub- and superscript role argument in text mode not as math.
1233     Use a custom role based on sub-/superscript if you want italic shape.
1234   - Shorter preamble and less dependencies: Load packages and define macros
1235     only if required in the document.
1236   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1237   - New custom environments and commands with optional "classes" argument.
1238   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1239   - Better conformance to Docutils specifications with ``--use-latex-toc``.
1240     Support for LaTeX generated ToC also with unnumbered sections.
1241   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1242     section numbering by LaTeX.
1243   - Use default font in admonitions and sidebar.
1244   - Align of image in a figure defaults to 'center'.
1245   - Bugfix: Newlines around targets and references prevent run-together
1246     paragraphs.
1247   - Fix internal hyperlinks.
1248   - Use class defaults for page margins ('typearea' now optional).
1249   - Float placement made configurable, default changed to "here definitely".
1250   - Typeset generic topic as "quote block with title".
1251   - Use template (file and configuration option).
1252   - In the default template, load cmap.sty (fix text extraction in PDF) and
1253     fixltx2e.sty (LaTeX patches, \textsubscript).
1254   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1255   - Use `translate` instead of repeated `replace` calls for text encoding.
1256   - Hyperlinked footnotes and support for symbol footnotes and
1257     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
1258   - Complete pairs of binary options
1259     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
1260     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
1261   - New defaults:
1262     - font-encoding: "T1" (formerly implicitely set by 'ae').
1263     - use-latex-toc: true (ToC with page numbers).
1264     - use-latex-footnotes: true (no mixup with figures).
1266 * docutils/writers/manpage.py
1268   - Do not print version at document end, this is done by the viewer.
1269   - Do not print date at document end, this is done by the viewer.
1270   - Fix storage of docinfo fields for none standard fields.
1272 * docutils/tools/rst2man.py
1274 Release 0.5 (2008-06-25)
1275 ========================
1277 * docutils/languages/he.py: Added to project: Hebrew mappings by
1278   Meir Kriheli.
1280 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
1281   mappings by Meir Kriheli.
1283 * docutils/frontend.py:
1285   - Configuration files are now assumed and required to be
1286     UTF-8-encoded.
1287   - Paths of applied configuration files are now recorded in the
1288     runtime setting ``_config_files`` (accessible via
1289     ``--dump-settings``).
1290   - Added ``--strip-elements-with-class`` and ``--strip-class``
1291     options (``strip_elements_with_classes`` and ``strip_classes``
1292     settings).
1294 * docutils/io.py:
1296   - Added code to determine the input encoding from data: encoding
1297     declarations or the presence of byte order marks (UTF-8 & UTF-16).
1298   - Added support for IronPython 1.0.
1300 * docutils/nodes.py:
1302   - Added ``document.__getstate__`` method, for pickling.
1304 * docutils/parsers/rst/states.py:
1306   - Allow ``+`` and ``:`` in reference names.
1307   - Unquoted targets beginning with an underscore (``.. __target:
1308     URI``) are no longer accepted.
1309   - Added support for multiple attributions in a physical block quote
1310     (indented text block), dividing it into multiple logical block
1311     quotes.
1312   - Added support for unicode bullets in bullet lists: "•", "‣", and
1313     "⁃".
1314   - Added support for new object-oriented directive interface,
1315     retaining compatibility to the old functional interface.
1316   - Added support for throwing ``DirectiveError``'s from within
1317     directive code.
1319 * docutils/parsers/rst/__init__.py:
1321   - Added ``Directive`` base class.
1322   - Added ``DirectiveError`` base class.
1323   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
1324     definitions.
1326 * docutils/parsers/directives/:
1328   - Refactored all reStructuredText directives to use the new
1329     object-oriented directive interface.  Errors are now (mostly)
1330     thrown using the new ``DirectiveError`` class.
1332 * docutils/parsers/directives/misc.py:
1334   - Added ``start-after`` and ``end-before`` options to ``include``
1335     directive; thanks to Stefan Rank.
1337 * docutils/transforms/universal.py:
1339   - Added ``StripClassesAndElements`` transform to remove from the
1340     document tree all elements with classes in
1341     ``settings.strip_elements_with_classes`` and all "classes"
1342     attribute values in ``self.document.settings.strip_classes``.
1344 * docutils/transforms/writer_aux.py:
1346   - Added ``Admonitions`` transform to transform specific admonitions
1347     (like ``note``, ``warning``, etc.) into generic admonitions with a
1348     localized title.
1350 * docutils/writers/html4css1/__init__.py:
1352   - Moved template functionality from the PEP/HTML writer here.
1353   - Expanded the fragments available in the ``parts`` attribute.
1354   - Moved ``id`` attributes from titles to surrounding ``div``
1355     elements.
1356   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
1357     universally supported now).
1358   - ``template.txt`` is now opened in text mode instead of binary mode
1359     (to ensure Windows compatibility).
1360   - ``a`` elements now have an "internal" or "external" class,
1361     depending on reference type.
1363 * docutils/writers/html4css1/template.txt: Added to project.
1365 * docutils/writers/pep_html/:
1367   - Moved template functionality to the HTML writer.
1369 * docutils/writers/s5_html/__init__.py:
1371   - Added ``view_mode`` & ``hidden_controls`` settings
1372     (``--view-mode`` & ``--hidden-controls/--visible-controls``
1373     options).
1375 * docutils/writers/latex2e/__init__.py:
1377   - Add ``--literal-block-env``
1378   - Fix: escaping ``%`` in href urls.
1379   - Move usepackage hyperref after stylesheet inclusion.
1380   - Fix: scrartcl does not have chapter but scrreprt.
1381   - Add newline after ``\end{verbatim}``.
1382   - Merge smaller differences from latex2e_adaptive_preamble.
1383   - Add ``use-part-section``.
1384   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
1385   - Using leavemode option_list no longer needs to check if parent
1386     is a definition list.
1387   - Append ``\leavemode`` to definition list terms.
1388   - No longer write visit\_/depart_definition_list_item comments to
1389     output.
1390   - Table column width with 3 decimal places.
1391   - Add table stubs support (boldfont).
1392   - Add assemble_parts to writer.
1393   - Add simply support for nested tables.
1394   - Fix verbatim in tables if use-verbatim-when-possible.
1395   - Use section commands down to subparagraph.
1396   - Put ensuremath around some latin1 chars.
1397   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
1398   - New option ``--use-bibtex=style,db1,db2``.
1399   - New option ``--reference-label`` to allow usage of LaTeX ref for
1400     labels in section references.
1401   - Add a label after every section to support sectionnumbers as reference
1402     labels.
1403   - Fix: bug# 1605376 rst2latex: bad options group list
1404   - Remove inactive code for use_optionlist_for_option_list.
1405   - Remove latex comments from option_list output.
1406   - Fix: bug# 1612270 double qoutes in italian literal.
1407   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
1408   - Add option --use-latex-abstract.
1409   - Image width unit ``px`` is translated to ``pt``.
1410   - Add image height support.
1411   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
1412     bug #1457388
1413   - Fix: Do not escape underscores in citation reference labels if
1414     use-latex-citations is set.
1415   - Use centering instead of center for figure contents, to avoid vertical
1416     space.
1417   - Recognize table class: borderless, nolines, booktabs, standard.
1418   - Fix: Renaming contents section does not work with latex writer; SF
1419     bug #1487405.
1420   - Applied patch for custom roles with classes from Edward Loper.
1421   - Fixed bug that caused crashes with more than 256 lists.
1423 * docutils/writers/pep_html/__init__.py:
1425   - Changed to support new python.org website structure and
1426     pep2pyramid.py.
1428 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1429   project.
1431 * tools/buildhtml.py:
1433   -- Added ``ignore`` setting to exclude a list of shell patterns
1434      (default: ``.svn:CVS``).
1436 * tools/editors/emacs/rst.el:
1438   - Changed license to "GPL".
1439   - Added ``rst-straighten-decorations`` function.
1440   - The ``compile`` module is now always loaded.
1441   - Added ``rst-toggle-line-block`` function.
1442   - Headings consisting only of non-ASCII characters are now
1443     recognized by ``rst-toc`` and ``rst-adjust``.
1444   - Added font-lock support for multi-line comments where the first
1445     comment line is empty.
1446   - Added ``(require 'font-lock)``.
1448 * setup.py:
1450   - Provide descriptive error message if distutils is missing.
1453 Release 0.4 (2006-01-09)
1454 ========================
1456 * General:
1458   - Updated the project policies for trunk/branch development &
1459     version numbering.
1461 * docutils/__init__.py:
1463   - Added ``__version_details__`` attribute to describe code source
1464     (repository/snapshot/release).
1465   - Replaced ``default_transforms`` attribute of TransformSpec with
1466     ``get_transforms()`` method.
1468 * docutils/core.py:
1470   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1471     functions, for document tree extraction and reprocessing.
1473 * docutils/io.py:
1475   - Added ``DocTreeInput`` class, for reprocessing existing documents.
1476   - Added support for non-Unicode (e.g. binary) writer output.
1478 * docutils/nodes.py:
1480   - Re-introduced ``Targetable.indirect_reference_name``, for
1481     MoinMoin/reST compatibility (removed in r3124/r3129).
1482   - Added ``serial_escape`` function; escapes string values that are
1483     elements of a list, for serialization.  Modified Docutils-XML
1484     writing (``Element._dom_node``) and pseudo-XML writing
1485     (``Element.starttag``) to use ``serial_escape``.
1486   - Added ``Node.deepcopy()`` method.
1487   - Removed the internal lists ``document.substitution_refs``,
1488     ``document.anonymous_refs``, and ``document.anonymous_targets``.
1489   - Added a "container" element.
1490   - Fixed bug where values of list-valued attributes of elements
1491     originating from custom interpreted text roles (i.e., with custom
1492     classes) were being shared between element instances.  Reported by
1493     Shmuel Zeigerman.
1495 * docutils/statemachine.py:
1497   - Added trailing whitespace stripping to ``string2lines()``.
1498   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1499     Asian double-width character support.
1501 * docutils/utils.py:
1503   - Added ``east_asian_column_width()`` for double-width character
1504     support.
1506 * docutils/languages/ja.py: Added to project: Japanese mappings by
1507   Hisashi Morita.
1509 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1510   mappings by Panjunyong.
1512 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1514 * docutils/parsers/rst/__init__.py:
1516   - Added validator to tab_width setting, with test.  Closes SF bug
1517     #1212515, report from Wu Wei.
1519 * docutils/parsers/rst/states.py:
1521   - Fixed bug with escaped colons indicating a literal block.
1522   - Fixed bug with enumerated lists (SF#1254145).
1523   - Backslash-escaped colons inside of field names are now allowed.
1524   - Targets (implicit and explicit), anonymous hyperlink references
1525     and auto-numbered footnote references inside of substitution
1526     definitions are now disallowed.
1527   - Fixed bug: list items with blank first lines.
1528   - Fixed bug: block quote attributions with indented second lines.
1529   - Added East Asian double-width character support (Python 2.4 only).
1531 * docutils/parsers/rst/tableparser.py:
1533   - Added East Asian double-width character support (Python 2.4 only).
1535 * docutils/parsers/rst/directives/body.py:
1537   - Added the "container" directive.
1539 * docutils/parsers/rst/directives/misc.py:
1541   - Added the "default-role", "title", and "date" directives.
1542   - Added standard data file syntax to the "include" directive.
1543   - Added support for "class" directive content.
1545 * docutils/parsers/rst/directives/images.py:
1547   - Added ``indirect_reference_name`` support for images with a target
1548     option.
1549   - Added support for image width and height units.
1550   - Fixed bug with image "target" options.
1552 * docutils/parsers/rst/directives/references.py:
1554   - Added "class" attribute to "target-notes" directive, for
1555     footnote_reference classes.
1557 * docutils/parsers/rst/include/: Directory added to project; contains
1558   standard data files for the "include" directive.  Initial contents:
1559   character entity substitution definition sets, and a set of
1560   definitions for S5/HTML presentations.
1562 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1563   mappings by David Goodger.
1565 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1566   Simplified Chinese mappings by Panjunyong.
1568 * docutils/readers/__init__.py:
1570   - Added universal.Decorations and universal.ExposeInternals
1571     transforms as default transforms for all readers.
1572   - Added ``ReReader`` base class for readers that reread an existing
1573     document tree.
1575 * docutils/readers/doctree.py: Added to project; a reader for existing
1576   document trees.
1578 * docutils/transforms/frontmatter.py:
1580   - Fixed the DocInfo transform to handle SVN-style expansion of the
1581     "Date" keyword.
1582   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1583     fields uniformly.
1585 * docutils/transforms/misc.py:
1587   - Added misc.Transitions transform, extracted from
1588     universal.FinalChecks.
1590 * docutils/transforms/references.py:
1592   - Added references.DanglingReferences transform, extracted from
1593     universal.FinalChecks.
1594   - Fixed bug with doubly-indirect substitutions.
1595   - Added footnote_reference classes attribute to "TargetNotes".
1596   - Fixed bug with circular substitution definitions that put Docutils
1597     into an infinite loop.
1599 * docutils/transforms/universal.py:
1601   - Added universal.ExposeInternals transform, extracted from
1602     universal.FinalChecks.
1603   - Removed universal.FinalChecks transform (logic has been moved to
1604     several new transforms).
1605   - Fixed bug with the "expose_internals" setting and Text nodes
1606     (exposed by the "rawsource" internal attribute).
1607   - Added the universal.StripComments transform, implementation of the
1608     "strip_comments" setting.
1610 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1611   transforms for writers.
1613   - Added ``Compound`` transform, which flattens compound paragraphs.
1615 * docutils/writers/: Several writer modules (html4css1.py) were
1616   converted into packages.  Support modules and data files have been
1617   moved into the packages.  The stylesheets for the HTML writers are
1618   now installed along with the code, the code knows where to find
1619   them, and the default is to use them (actually, to embed them).
1620   Some adjustments to configuration files may be necessary.  The
1621   easiest way to obtain the new default behavior is to remove all
1622   settings whose name includes "stylesheet".
1624 * docutils/writers/__init__.py:
1626   - Added universal.Messages and universal.FilterMessages transforms
1627     as default transforms for all writers.
1628   - Added ``UnfilteredWriter`` base class for writers that pass the
1629     document tree on unchanged.
1631 * docutils/writers/docutils_xml.py:
1633   - Made ``xmlcharrefreplace`` the default output encoding error
1634     handler.
1636 * docutils/writers/html4css1/:
1638   - Added support for image width and height units.
1639   - Made ``xmlcharrefreplace`` the default output encoding error
1640     handler.
1641   - Made ``--embed-stylesheet`` the default rather than
1642     ``--link-stylesheet``.
1643   - Moved "id" attribute from container (section etc.) to title's <a>
1644     tag, to be on the same tag as "name".
1645     (!!! To be reverted in Docutils 0.5.)
1646   - Added vertical space between fields of field lists.
1647   - Added ``--compact-field-lists`` option to remove vertical space in
1648     simple field lists.
1649   - Made cloaking of email addresses with ``--cloak-email-addresses``
1650     less obtrusive.
1651   - Fixed support for centered images.
1652   - Added support for class="compact" & class="open" lists.
1654 * docutils/writers/latex2e/:
1656   - Underscores in citekeys are no longer escaped.
1658 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1659   mapping of Unicode characters to LaTeX equivalents.
1661 * docutils/writers/s5_html/: Package added to project; writer for
1662   S5/HTML slide shows.
1664 * docs/dev/distributing.txt: Added to project; guide for distributors
1665   (package maintainers).
1667 * docs/dev/hacking.txt: Added to project; guide for developers.
1669 * docs/ref/doctree.txt:
1671   - Updated for plural attributes "classes", "ids", "names",
1672     "dupnames".
1673   - Added the "container" element.
1675 * docs/ref/docutils.dtd:
1677   - Updated for plural attributes "classes", "ids", "names",
1678     "dupnames".
1680 * docs/user/emacs.txt: Added to project; a document about Emacs
1681   support for reStructuredText and Docutils.
1683 * docs/user/links.txt: Added to project; lists of Docutils-related
1684   links.
1686 * docs/user/mailing-lists.txt: Added to project; information about
1687   Docutils-related mailing lists and how to access them.
1689 * docs/user/slide-shows.txt: Added to project; example of and docs for
1690   the S5/HTML writer (``rst2s5.py`` front end).
1692 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1693   Files", added to project.
1695 * test/coverage.sh: Added to project; test coverage script.
1697 * test/DocutilsTestSupport.py:
1699   - Added support for specifying runtime settings at the suite level.
1701 * test/test_functional.py:
1703   - Added the ``clear_output_directory`` function.
1704   - Added support for ``_test_more`` functions in functional test
1705     config files.
1707 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1709 * tools/rstpep2html.py: Renamed from pep.py.
1711 * tools/dev/create_unimap.py: Added to project; script to create the
1712   docutils/writers/unimap_latex.py mapping file.
1714 * tools/dev/profile_docutils.py: Added to project; profiler script.
1716 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1718 * tools/editors/emacs/restructuredtext.el,
1719   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1720   Removed from project; the functionality is now contained in rst.el.
1722 * tools/editors/emacs/rst.el: Added to project.  Added many features
1723   and fixed many bugs.  See docs/user/emacs.txt for details.
1725 * tools/stylesheets: Removed from project.  Stylesheets have been
1726   renamed and moved into writer packages.
1729 Release 0.3.9 (2005-05-26)
1730 ==========================
1732 * General:
1734   - Eliminated and replaced all uses of the old string attributes
1735     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1736     new list attributes ``ids``, ``names``, ``dupnames`` and
1737     ``classes`` throughout the whole source tree.
1739 * docutils/core.py:
1741   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1742     allowing for easier debugging.
1743   - In ``Publisher.publish()``, expanded the generic top-level
1744     exception catching.
1746 * docutils/examples.py:
1748   - Added ``internals`` function for exploration.
1750 * docutils/io.py:
1752   - Fixed ``Input.decode`` method to apply heuristics only if no
1753     encoding is explicitly given, and to provide better reporting of
1754     decoding errors.
1755   - The ``Input.decode`` method now removes byte order marks (BOMs)
1756     from input streams.
1758 * docutils/nodes.py:
1760   - ``image`` element class changed to subclass of Element, not
1761     TextElement (it's an empty element, and cannot contain text).
1762   - Added ``attr_defaults`` dictionary for default attribute values.
1763   - Added empty list as default value for the following attributes:
1764     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1765   - Added ``document.decoration`` attribute,
1766     ``document.get_decoration`` method, and ``decoration.get_header``
1767     & ``.get_footer`` methods.
1768   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1769     methods.
1771 * docutils/utils.py:
1773   - Removed ``docutils.utils.Reporter.categories``,
1774     ``docutils.utils.ConditionSet``, and all references to them, to
1775     simplify error reporting.
1777 * docutils/languages/nl.py: Added to project; Dutch mappings by
1778   Martijn Pieters.
1780 * docutils/parsers/rst/__init__.py:
1782   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1784 * docutils/parsers/rst/states.py:
1786   - Added check for escaped at-mark to prevent email address recognition.
1787   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1788     arguments>``.
1789   - Allowed whitespace in paths and URLs.
1790   - Added auto-enumerated list items.
1791   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1792     followed by text.
1793   - Added support for table stub columns.
1795 * docutils/parsers/rst/directives/__init__.py:
1797   - Allowed whitespace in paths (``path`` function).
1798   - Added ``uri`` directive option conversion function.
1800 * docutils/parsers/rst/directives/body.py:
1802   - Fixed illegal context bug with "topic" directive (allowed within
1803     sidebars; not within body elements).
1805 * docutils/parsers/rst/directives/images.py:
1807   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1808   - Added support for the ``file_insertion_enabled`` setting in the
1809     "figure" directive (disables "figwidth" option).
1810   - "image" directive: added checks for valid values of "align" option,
1811     depending on context.  "figure" directive: added specialized
1812     "align" option and attribute on "figure" element.
1813   - Made ":figwidth: image" option of "figure" directive work again.
1814   - Fixed bug with reference names containing uppercase letters
1815     (e.g. ``Name_``) in "target" option of "image" directive.
1817 * docutils/parsers/rst/directives/misc.py:
1819   - Fixed "include" and "raw" directives to catch text decoding
1820     errors.
1821   - Allowed whitespace in "include" & "raw" directive paths.
1822   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1823     settings in "include" & "raw" directives.
1825 * docutils/parsers/rst/directives/parts.py:
1827   - Added "header" & "footer" directives.
1828   - Fixed illegal context bug with "contents" directive (topics
1829     allowed within sidebars; not within body elements).
1831 * docutils/parsers/rst/directives/tables.py:
1833   - Added "list-table" directive.
1834   - Caught empty CSV table bug.
1835   - Added support for the ``file_insertion_enabled`` setting in the
1836     "csv-table" directive.
1837   - Added ``stub-columns`` option to "csv-table" and "list-table"
1838     directives.
1840 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1841   mappings by Martijn Pieters.
1843 * docutils/readers/standalone.py:
1845   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1846     options to activate or deactivate the SectSubTitle transform.
1848 * docutils/transforms/frontmatter.py:
1850   - Added SectSubTitle transform to promote titles of lone
1851     subsections to subtitles.
1853 * docutils/transforms/references.py:
1855   - Fixed mislocated internal targets bug, by propagating internal
1856     targets to the next node, making use of the newly added support
1857     for multiple names and IDs.
1858   - Fixed duplicate footnote label bug.
1859   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1860     transform.
1862 * docutils/writers/html4css1.py:
1864   - Fixed unencoded stylesheet reference bug (characters like "&" in
1865     stylesheet references).
1866   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1867     tags).
1868   - Added support for multiple IDs per node by creating empty ``span``
1869     tags.
1870   - Added the ``field_name_limit`` & ``option_limit`` settings &
1871     support.
1872   - Added support for table stub columns.
1873   - Added support for the ``align`` attribute on ``figure`` elements.
1874   - Added the ``cloak_email_addresses`` setting & support.
1875   - Added ``html_prolog``, ``html_head``, ``html_body``,
1876     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1877     ``docutils.core.publish_parts``.
1878   - Added support for section subtitles.
1880 * docutils/writers/latex2e.py:
1882   - Fixed tables starting with more than one multirow cell.
1883   - Improved --use-latex-docinfo so that organization/contact/address
1884     fields are lumped with the last author field and appear on the
1885     titlepage.
1886   - Made sure the titlepage is always shown with --use-latex-docinfo,
1887     even if the document has no title.
1888   - Made sure that latex doesn't fill in today's date if no date field
1889     was given.
1890   - Added support for section subtitles.
1892 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1893   (under development).
1895 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1897 * docs/api/publisher.txt:
1899   - Added "``publish_parts`` Details" section.
1901 * docutils/dev/repository.txt: Added to project; information about the
1902   Docutils Subversion repository.
1904 * docs/ref/docutils.dtd:
1906   - Added a ``stub`` attribute to the ``colspec`` element via the
1907     ``tbl.colspec.att`` parameter entity.
1908   - Allowed topic elements within sidebars
1909   - Added an ``align`` attribute to the ``figure`` element.
1911 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1912   writer.
1915 Release 0.3.7 (2004-12-24)
1916 ==========================
1918 * docutils/frontend.py:
1920   - Added options: --input-encoding-error-handler,
1921     --record-dependencies, --leave-footnote-reference-space,
1922     --strict-visitor.
1923   - Added command-line and config file support for "overrides" setting
1924     parameter.
1926 * docutils/io.py:
1928   - Added support for input encoding error handler.
1930 * docutils/nodes.py:
1932   - Added dispatch_visit and dispatch_departure methods to
1933     NodeVisitor; useful as a hook for Visitors.
1934   - Changed structure of ``line_block``; added ``line``.
1935   - Added ``compound`` node class.
1936   - Added a mechanism for Visitors to transitionally ignore new node
1937     classes.
1939 * docutils/utils.py:
1941   - Moved ``escape2null`` and ``unescape`` functions from
1942     docutils/parsers/rst/states.py.
1944 * docutils/parsers/rst/roles.py:
1946   - Added "raw" role.
1947   - Changed role function API: the "text" parameter now takes
1948     null-escaped interpreted text content.
1950 * docutils/parsers/rst/states.py:
1952   - Fixed bug where a "role" directive in a nested parse would crash
1953     the parser; the state machine's "language" attribute was not being
1954     copied over.
1955   - Added support for line block syntax.
1956   - Fixed directive parsing bug: argument-less directives didn't
1957     notice that arguments were present.
1958   - Removed error checking for transitions.
1959   - Added support for multiple classifiers in definition list items.
1960   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1961   - Changed role function API: the "text" parameter now takes
1962     null-escaped interpreted text content.
1963   - Empty sections and documents are allowed now.
1965 * docutils/parsers/rst/directives/__init__.py:
1967   - Added ``encoding`` directive option conversion function.
1968   - Allow multiple class names in class_option conversion function.
1970 * docutils/parsers/rst/directives/body.py:
1972   - Converted the line-block directive to use the new structure.
1973   - Extracted the old line-block functionality to the ``block``
1974     function (still used).
1975   - Added ``compound`` directive (thanks to Lea Wiemann).
1977 * docutils/parsers/rst/directives/misc.py:
1979   - Added "encoding" option to "include" and "raw" directives.
1980   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1981   - Allow multiple class names in the "class" directive.
1983 * docutils/parsers/rst/directives/parts.py:
1985   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1986     options.  Thanks to Lele Gaifax.
1988 * docutils/parsers/rst/directives/tables.py:
1990   - Added "encoding" directive to "csv-table" directive.
1991   - Added workaround for lack of Unicode support in csv.py, for
1992     non-ASCII CSV input.
1994 * docutils/transforms/misc.py:
1996   - Fixed bug when multiple "class" directives are applied to a single
1997     element.
1998   - Enabled multiple format names for "raw" directive.
2000 * docutils/transforms/references.py:
2002   - Added support for trimming whitespace from beside substitution
2003     references.
2005 * docutils/transforms/universal.py:
2007   - FinalChecks now checks for illegal transitions and moves
2008     transitions between sections.
2010 * docutils/writers/html4css1.py:
2012   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
2013   - "stylesheet" and "stylesheet_path" settings are now mutually
2014     exclusive.
2015   - Added support for the new line_block/line structure.
2016   - --footnote-references now overrides
2017     --trim-footnote-reference-space, if applicable.
2018   - Added support for ``compound`` elements.
2019   - Enabled multiple format names for "raw" directive.
2020   - ``<p>`` tags of a paragraph which is the only visible child of the
2021     document node are no longer stripped.
2022   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2023     new method ``should_be_compact_paragraph()``.
2024   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2025     elements.
2026   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2027     the output if they have their ``class`` attribute set.
2028   - The whole document is now surrounded by a ``<div
2029     class="document">`` element.
2030   - Body-level images are now wrapped by their own ``<div>`` elements,
2031     with image classes copied to the wrapper, and for images which
2032     have the ``:align:`` option set, the surrounding ``<div>`` now
2033     receives a class attribute (like ``class="align-left"``).
2035 * docutils/writers/latex2e.py:
2037   - no newline after depart_term.
2038   - Added translations for some Unicode quotes.
2039   - Added option "font-encoding", made package AE the default.
2040   - "stylesheet" and "stylesheet_path" settings are now mutually
2041     exclusive.
2042   - --footnote-references now overrides
2043     --trim-footnote-reference-space, if applicable.
2044   - The footnote label style now matches the footnote reference style
2045     ("brackets" or "superscript").
2046   - Added support for ``compound`` elements.
2047   - Enabled multiple format names for "raw" directive.
2049 * docs/ref/docutils.dtd:
2051   - Changed structure of the ``line_block`` element; added ``line``.
2052   - Added ``compound`` element.
2053   - Added "ltrim" and "rtrim" attributes to
2054     ``substitution_definition`` element.
2055   - Enabled multiple format names for ``raw`` element.
2056   - Enabled multiple classifiers in ``definition_list_item`` elements.
2058 * docs/ref/rst/directives.txt
2060   - Marked "line-block" as deprecated.
2061   - "Class" directive now allows multiple class names.
2062   - Added "Rationale for Class Attribute Value Conversion".
2063   - Added warning about "raw" overuse/abuse.
2065 * docs/ref/rst/restructuredtext.txt:
2067   - Added syntax for line blocks.
2068   - Definition list items may have multiple classifiers.
2070 * docs/ref/rst/roles.txt:
2072   - Added "raw" role.
2074 * tools/stylesheets/default.css:
2076   - Added support for the new line_block structure.
2077   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2080 Release 0.3.5 (2004-07-29)
2081 ==========================
2083 General:
2085 * _`Documentation cleanup/reorganization`.
2087   - Created new subdirectories of docs/:
2089     * ``docs/user/``: introductory/tutorial material for end-users
2090     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2091     * ``docs/api/``: API reference material for client-developers
2092     * ``docs/ref/``: reference material for all groups
2093     * ``docs/howto/``: for component-developers and core-developers
2094     * ``docs/peps/``: Python Enhancement Proposals
2096   - Moved ``docs/*`` to ``docs/user/``.
2097   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2098     ``spec/`` to ``docs/dev``.
2099   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2100     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2101   - Moved ``alternatives.txt``, and ``problems.txt`` from
2102     ``spec/rst/`` to ``docs/dev/rst/``.
2103   - Moved ``reStructuredText.txt``, ``directives.txt``,
2104     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2105     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
2106     ``roles.txt``, ``reStructuredText.txt`` to
2107     ``restructuredtext.txt``.
2108   - Moved ``spec/howto/`` to ``docs/howto``.
2110   In order to keep the CVS history of moved files, we supplied
2111   SourceForge with a `script for modifying the Docutils CVS
2112   repository`__.
2114   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
2116   After running the cleanup script:
2118   - Added ``docs/index.txt``.
2119   - Added a ``.htaccess`` file to the ``web`` module, containing
2120     redirects for all old paths to new paths.  They'll preserve
2121     fragments (the "#name" part of a URL), and won't clutter up the
2122     file system, and will correct the URL in the user's browser.
2123   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2124     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2125     the "To Do" list itself in ``docs/dev/todo.txt``.
2126   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2127     section of ``docs/dev/todo.txt``.
2128   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2129   - Added "How To Report Bugs" to ``BUGS.txt``.
2130   - Went through all the sources and docs (including under web/) and
2131     updated links.  Mostly done by Lea Wiemann; thanks Lea!
2132     (Still need to update links in the sandboxes.)
2134 Specific:
2136 * BUGS.txt: Added to project.
2138 * THANKS.txt: Added to project.
2140 * docutils/__init__.py:
2142   - 0.3.4: Post-release.
2144 * docutils/core.py:
2146   - Added special error handling & advice for UnicodeEncodeError.
2147   - Refactored Publisher.publish (simplified exception handling &
2148     extracted debug dumps).
2149   - Renamed "enable_exit" parameter of convenience functions to
2150     "enable_exit_status".
2151   - Enabled traceback (exception propagation) by default in
2152     programmatic convenience functions.
2153   - Now publish_file and publish_cmdline convenience functions return
2154     the encoded string results in addition to their regular I/O.
2155   - Extracted common code from publish_file, publish_string, and
2156     publish_parts, into new publish_programmatically.  Extracted
2157     settings code to ``Publisher.process_programmatic_settings``.
2158   - In Publisher.publish, disabled ``settings_overrides`` when
2159     ``settings`` is supplied; redundant.
2161 * docutils/frontend.py:
2163   - Added help text for "--output-encoding-error-handler" and
2164     "--error-encoding-error-handler".
2165   - Renamed "--exit" to "--exit-status".
2166   - Simplified default-setting code.
2168 * docutils/parsers/rst/__init__.py:
2170   - Added "--pep-base-url" and "--rfc-base-url" options.
2172 * docutils/parsers/rst/states.py:
2174   - Made URI recognition more aggressive and intelligent.
2176 * docutils/parsers/rst/directives/__init__.py:
2178   - Added several directive option conversion functions.
2180 * docutils/parsers/rst/directives/body.py:
2182   - Moved "table" directive to tables.py.
2184 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2185   added to project.
2187 * docutils/writers/latex2e.py:
2189   - Added "--table-style=(standard|booktabs|nolines)"
2190   - figures get "here" option (LaTeX per default puts them at bottom),
2191     and figure content is centered.
2192   - Rowspan support for tables.
2193   - Fix: admonition titles before first section.
2194   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2195   - Replave ``_`` in literal by an underlined blank, because it has the correct
2196     width.
2197   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2198   - A few unicode replacements, if output_encoding != utf
2199   - Add "--graphicx-option".
2200   - Indent literal-blocks.
2201   - Fix: omit ``\maketitle`` when there is no document title.
2203 * docs/index.txt: "Docutils Project Documentation Overview", added to
2204   project.
2206 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2207   Tool", added to project.
2209 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2211 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2213 * docs/dev/policies.txt: Added to project (extracted from
2214   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2216 * docs/dev/release.txt: Added to project (extracted from
2217   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2219 * docs/dev/testing.txt: Added to project.
2221 * docs/dev/website.txt: Added to project (extracted from
2222   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2224 * docs/ref/rst/directives.txt:
2226   - Added directives: "table", "csv-table".
2228 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2229   added to project.  1 page for syntax, and a 1 page reference for
2230   directives and roles.  Source text to be used as-is; not meant to be
2231   converted to HTML.
2233 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2234   with a change of title.
2236 * test/functional/, contents, and test/test_functional.py: Added to
2237   project.
2239 * tools/buildhtml.py: Fixed bug with config file handling.
2241 * tools/html.py: Removed from project (duplicate of rst2html.py).
2243 * tools/pep2html.py: Removed from project (duplicate of Python's
2244   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2245   Docutils-related PEPs in docs/peps/).
2247 * tools/rst2pseudoxml.py: Renamed from publish.py.
2249 * tools/rst2xml.py: Renamed from docutils-xml.py.
2251 * tools/test.txt: Removed from project; moved to
2252   docs/user/rst/demo.txt.
2254 * setup.py: Now also installs ``rst2latex.py``.
2257 Release 0.3.3 (2004-05-09)
2258 ==========================
2260 * docutils/__init__.py:
2262   - 0.3.1: Reorganized config file format (multiple sections); see
2263     docs/config.txt.
2264   - Added unknown_reference_resolvers attribute to TransformSpec.
2265   - 0.3.2: Interpreted text reorganization.
2266   - 0.3.3: Released.
2268 * docutils/core.py:
2270   - Catch system messages to stop tracebacks from parsing errors.
2271   - Catch exceptions during processing report & exit without
2272     tracebacks, except when "--traceback" used.
2273   - Reordered components for OptionParser; application comes last.
2274   - Added "config_section" parameter to several methods and functions,
2275     allowing front ends to easily specify their config file sections.
2276   - Added publish_parts convenience function to allow access to individual
2277     parts of a document.
2279 * docutils/examples.py: Added to project; practical examples of
2280   Docutils client code, to be used as-is or as models for variations.
2282 * docutils/frontend.py:
2284   - Added "--traceback" & "--no-traceback" options ("traceback"
2285     setting).
2286   - Implemented support for config file reorganization:
2287     ``standard_config_files`` moved from ``ConfigParser`` to
2288     ``OptionParser``; added
2289     ``OptionParser.get_config_file_settings()`` and
2290     ``.get_standard_config_settings()``; support for old "[options]"
2291     section (with deprecation warning) and mapping from old to new
2292     settings.
2293   - Reimplemented setting validation.
2294   - Enabled flexible boolean values: yes/no, true/false, on/off.
2295   - Added ``Values``, a subclass of ``optparse.Values``, with support
2296     for list setting attributes.
2297   - Added support for new ``DOCUTILSCONFIG`` environment variable;
2298     thanks to Beni Cherniavsky.
2299   - Added "--no-section-numbering" option.
2301 * docutils/io.py:
2303   - Catch IOErrors when opening source & destination files, report &
2304     exit without tracebacks.  Added ``handle_io_errors`` parameter to
2305     ``FileInput`` & ``FileOutput`` to enable caller error handling.
2307 * docutils/nodes.py:
2309   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
2310     method definitions (via ``exec``) to dynamic assignments (via
2311     ``setattr``); thanks to Roman Suzi.
2312   - Encapsulated visitor dynamic assignments in a function; thanks to
2313     Ian Bicking.
2314   - Added indirect_reference_name attribute to the Targetable
2315     class. This attribute holds the whitespace_normalized_name
2316     (contains mixed case) of a target.
2318 * docutils/statemachine.py:
2320   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
2321   - Added ``StringList.get_2D_block``.
2323 * docutils/utils.py:
2325   - Added "level" attribute to SystemMessage exceptions.
2327 * docutils/languages/af.py: Added to project; Afrikaans mappings by
2328   Jannie Hofmeyr.
2330 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
2331   Blaha.
2333 * docutils/languages/eo.py: Added to project; Esperanto mappings by
2334   Marcelo Huerta San Martin.
2336 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
2337   mappings by Lalo Martins.
2339 * docutils/languages/ru.py: Added to project; Russian mappings by
2340   Roman Suzi.
2342 * docutils/parsers/rst/roles.py: Added to project.  Contains
2343   interpreted text role functions, a registry for interpreted text
2344   roles, and an API for adding to and retrieving from the registry.
2345   Contributed by Edward Loper.
2347 * docutils/parsers/rst/states.py:
2349   - Updated ``RSTState.nested_parse`` for "include" in table cells.
2350   - Allowed true em-dash character and "---" as block quote
2351     attribution marker.
2352   - Added support for <angle-bracketed> complex option arguments
2353     (option lists).
2354   - Fixed handling of backslashes in substitution definitions.
2355   - Fixed off-by-1 error with extra whitespace after substitution
2356     definition directive.
2357   - Added inline markup parsing to field lists' field names.
2358   - Added support for quoted (and unindented) literal blocks.
2359     Driven in part by a bribe from Frank Siebenlist (thanks!).
2360   - Parser now handles escapes in URIs correctly.
2361   - Made embedded-URIs' reference text omittable.  Idea from Beni
2362     Cherniavsky.
2363   - Refactored explicit target processing code.
2364   - Added name attribute to references containing the reference name only
2365     through whitespace_normalize_name (no case changes).
2366   - parse_target no longer returns the refname after going through
2367     normalize_name. This is now handled in make_target.
2368   - Fixed bug relating to role-less interpreted text in non-English
2369     contexts.
2370   - Reorganized interpreted text processing; moved code into the new
2371     roles.py module.  Contributed by Edward Loper.
2372   - Refactored ``Body.parse_directive`` into ``run_directive`` and
2373     ``parse_directive_block``.
2375 * docutils/parsers/rst/tableparser.py:
2377   - Reworked for ``StringList``, to support "include" directives in
2378     table cells.
2380 * docutils/parsers/rst/directives/__init__.py:
2382   - Renamed ``unchanged()`` directive option conversion function to
2383     ``unchanged_required``, and added a new ``unchanged``.
2384   - Catch unicode value too high error; fixes bug 781766.
2385   - Beefed up directive error reporting.
2387 * docutils/parsers/rst/directives/body.py:
2389   - Added basic "table" directive.
2391 * docutils/parsers/rst/directives/images.py:
2393   - Added "target" option to "image" directive.
2394   - Added name attribute to references containing the reference name only
2395     through whitespace_normalize_name (no case changes).
2397 * docutils/parsers/rst/directives/misc.py:
2399   - Isolated the import of the ``urllib2`` module; was causing
2400     problems on SourceForge (``libssl.so.2`` unavailable?).
2401   - Added the "role" directive for declaring custom interpreted text
2402     roles.
2404 * docutils/parsers/rst/directives/parts.py:
2406   - The "contents" directive does more work up-front, creating the
2407     "topic" and "title", and leaving the "pending" node for the
2408     transform.  Allows earlier reference resolution; fixes subtle bug.
2410 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
2411   mappings by Jannie Hofmeyr.
2413 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
2414   mappings by Marek Blaha.
2416 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
2417   mappings by Marcelo Huerta San Martin.
2419 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2420   Portuguese mappings by Lalo Martins.
2422 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2423   mappings by Roman Suzi.
2425 * docutils/transforms/parts.py:
2427   - The "contents" directive does more work up-front, creating the
2428     "topic" and "title", and leaving the "pending" node for the
2429     transform.  Allows earlier reference resolution; fixes subtle bug.
2430   - Added support for disabling of section numbering.
2432 * docutils/transforms/references.py:
2434   - Verifying that external targets are truly targets and not indirect
2435     references. This is because we are now adding a "name" attribute to
2436     references in addition to targets. Note sure if this is correct!
2437   - Added code to hook into the unknown_reference_resolvers list for a
2438     transformer in resolve_indirect_target. This allows the
2439     unknown_reference_resolvers to keep around indirect targets which
2440     docutils doesn't know about.
2441   - Added specific error message for duplicate targets.
2443 * docutils/transforms/universal.py:
2445   - Added FilterMessages transform (removes system messages below the
2446     verbosity threshold).
2447   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2448     to FinalCheckVisitor for application-specific handling of
2449     unresolvable references.
2450   - Added specific error message for duplicate targets.
2452 * docutils/writers/__init__.py:
2454   - Added assemble_parts method to the Writer class to allow for
2455     access to a documents individual parts.
2456   - Documented & set default for ``Writer.output`` attribute.
2458 * docutils/writers/html4css1.py:
2460   - Fixed unicode handling of attribute values (bug 760673).
2461   - Prevent duplication of "class" attribute values (bug report from
2462     Kirill Lapshin).
2463   - Improved table grid/border handling (prompted by report from Bob
2464     Marshall).
2465   - Added support for table titles.
2466   - Added "<title />" for untitled docs, for XHTML conformance; thanks
2467     to Darek Suchojad.
2468   - Added functionality to keep track of individual parts of a document
2469     and store them in a dictionary as the "parts" attribute of the writer.
2470     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2471   - Added proper support for the "scale" attribute of the "image"
2472     element.  Contributed by Brent Cook.
2473   - Added ``--initial-header-level`` option.
2474   - Fixed bug: the body_pre_docinfo segment depended on there being a
2475     docinfo; if no docinfo, the document title was incorporated into
2476     the body segment.  Adversely affected the publish_parts interface.
2478 * docutils/writers/latex2e.py:
2480   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2481     about a missing file.
2482   - Added options and support: ``--compound-enumerators``,
2483     ``--section-prefix-for-enumerators``, and
2484     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
2485     934322).
2486   - Added option ``--use-verbatim-when-possible``, to avoid
2487     problematic characters (eg, '~' in italian) in literal blocks.
2488   - It's now possible to use four section levels in the `book` and
2489     `report` LaTeX classes.  The default `article` class still has
2490     three levels limit.
2492 * docs/config.txt: "Docutils Configuration Files", added to project.
2493   Moved config file entry descriptions from tools.txt.
2495 * docs/tools.txt:
2497   - Moved config file entry descriptions to config.txt.
2499 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
2500   Development".
2502 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2503   Text Roles", added to project.
2505 * spec/rst/reStructuredText.txt:
2507   - Added description of support for <angle-bracketed> complex option
2508     arguments to option lists.
2509   - Added subsections for indented and quoted literal blocks.
2511 * test: Continually adding & updating tests.
2513   - Added test/test_settings.py & test/data/config_*.txt support
2514     files.
2515   - Added test/test_writers/test_htmlfragment.py.
2517 * test/DocutilsTestSupport.py:
2519   - Refactored LaTeX publisher test suite/case class names to make
2520     testing other writers easier.
2521   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2522     to test the processing of HTML fragments which use the new
2523     publish_parts convenience function.
2525 * tools/buildhtml.py:
2527   - Added support for the "--prune" option.
2528   - Removed dependency on pep2html.py; plaintext PEPs no longer
2529     supported.
2531 * tools/docutils.conf:
2533   - Updated for configuration file reorganization.
2535 * tools/rst2html.py:
2537   - copied from tools/html.py
2539 * setup.py:
2541   - added a 'scripts' section to configuration
2542   - added 'tools/rst2html.py' to the scripts section
2545 Release 0.3 (2003-06-24)
2546 ========================
2548 General:
2550 * Renamed "attribute" to "option" for directives/extensions.
2552 * Renamed transform method "transform" to "apply".
2554 * Renamed "options" to "settings" for runtime settings (as set by
2555   command-line options).  Sometimes "option" (singular) became
2556   "settings" (plural).  Some variations below:
2558   - document.options -> document.settings (stored in other objects as
2559     well)
2560   - option_spec -> settings_spec (not directives though)
2561   - OptionSpec -> SettingsSpec
2562   - cmdline_options -> settings_spec
2563   - relative_path_options -> relative_path_settings
2564   - option_default_overrides -> settings_default_overrides
2565   - Publisher.set_options -> Publisher.get_settings
2567 Specific:
2569 * COPYING.txt: Added "Public Domain Dedication".
2571 * FAQ.txt: Frequently asked questions, added to project.
2573 * setup.py:
2575   - Updated with PyPI Trove classifiers.
2576   - Conditional installation of third-party modules.
2578 * docutils/__init__.py:
2580   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2581   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2582   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2583   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2584     option and its effect on the PEP template & writer.
2585   - Bumped version to 0.2.4 due to changes to the PEP template &
2586     stylesheet.
2587   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2588   - Added ``TransformSpec`` class for new transform system.
2589   - Bumped version to 0.2.6 for API changes (renaming).
2590   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2591     convenience functions.
2592   - Added ``Component.component_type`` attribute.
2593   - Bumped version to 0.2.8 because of the internal parser switch from
2594     plain lists to the docutils.statemachine.StringList objects.
2595   - Bumped version to 0.2.9 because of the frontend.py API changes.
2596   - Bumped version to 0.2.10 due to changes to the project layout
2597     (third-party modules removed from the "docutils" package), and
2598     signature changes in ``io.Input``/``io.Output``.
2599   - Changed version to 0.3.0 for release.
2601 * docutils/core.py:
2603   - Made ``publish()`` a bit more convenient.
2604   - Generalized ``Publisher.set_io``.
2605   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2606     parameters; improved its docstring.
2607   - Added ``publish_file()`` and ``publish_string()``.
2608   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2609     out of ``.set_io``.
2610   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2611     "--dump-transforms" hidden options.
2612   - Added ``Publisher.apply_transforms()`` method.
2613   - Added ``Publisher.set_components()`` method; support for
2614     ``publish_*()`` conveninece functions.
2615   - Moved config file processing to docutils/frontend.py.
2616   - Added support for exit status ("exit_level" setting &
2617     ``enable_exit`` parameter for Publisher.publish() and convenience
2618     functions).
2620 * docutils/frontend.py:
2622   - Check for & exit on identical source & destination paths.
2623   - Fixed bug with absolute paths & "--config".
2624   - Set non-command-line defaults in ``OptionParser.__init__()``:
2625     ``_source`` & ``_destination``.
2626   - Distributed ``relative_path_settings`` to components; updated
2627     ``OptionParser.populate_from_components()`` to combine it all.
2628   - Require list of keys in ``make_paths_absolute`` (was implicit in
2629     global ``relative_path_settings``).
2630   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2631     "--dump-settings", and "--dump-transforms" hidden options.
2632   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2633     code, replaced with correct code.
2634   - Added validation functionality for config files.
2635   - Added "--error-encoding" option/setting, "_disable_config"
2636     internal setting.
2637   - Added encoding validation; updated "--input-encoding" and
2638     "--output-encoding"; added "--error-encoding-error-handler" and
2639     "--output-encoding-error-handler".
2640   - Moved config file processing from docutils/core.py.
2641   - Updated ``OptionParser.populate_from_components`` to handle new
2642     ``SettingsSpec.settings_defaults`` dict.
2643   - Added support for "-" => stdin/stdout.
2644   - Added "exit_level" setting ("--exit" option).
2646 * docutils/io.py:
2648   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2649   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2650   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2651   - ``FileOutput.write()`` now returns the encoded output string.
2652   - Try to get path/stream name automatically in ``FileInput`` &
2653     ``FileOutput``.
2654   - Added defaults for source & destination paths.
2655   - Allow for Unicode I/O with an explicit "unicode" encoding.
2656   - Added ``Output.encode()``.
2657   - Removed dependency on runtime settings; pass encoding directly.
2658   - Recognize Unicode strings in ``Input.decode()``.
2659   - Added support for output encoding error handlers.
2661 * docutils/nodes.py:
2663   - Added "Invisible" element category class.
2664   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2665     modification during a traversal.
2666   - Added element classes: ``line_block``, ``generated``, ``address``,
2667     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2668     ``superscript``, ``subscript``, ``inline``
2669   - Added support for lists of nodes to ``Element.insert()``.
2670   - Fixed parent linking in ``Element.replace()``.
2671   - Added new abstract superclass ``FixedTextElement``; adds
2672     "xml:space" attribute.
2673   - Added support for "line" attribute of ``system_message`` nodes.
2674   - Added support for the observer pattern from ``utils.Reporter``.
2675     Added ``parse_messages`` and ``transform_messages`` attributes to
2676     ``document``, removed ``messages``.  Added ``note_parse_message``
2677     and ``note_transform_message`` methods.
2678   - Added support for improved diagnostics:
2680     - Added "document", "source", and "line" internal attributes to
2681       ``Node``, set by ``Node.setup_child()``.
2682     - Converted variations on ``node.parent = self`` to
2683       ``self.setup_child(node)``.
2684     - Added ``document.current_source`` & ``.current_line``
2685       attributes, and ``.note_source`` observer method.
2686     - Changed "system_message" output to GNU-Tools format.
2688   - Added a "rawsource" attribute to the ``Text`` class, for text
2689     before backslash-escape resolution.
2690   - Support for new transform system.
2691   - Reworked ``pending`` element.
2692   - Fixed XML DOM bug (SF #660611).
2693   - Removed the ``interpeted`` element class and added
2694     ``title_reference``, ``abbreviation``, ``acronym``.
2695   - Made substitutions case-sensitive-but-forgiving; moved some code
2696     from the parser.
2697   - Fixed Unicode bug on element attributes (report: William Dode).
2699 * docutils/optik.py: Removed from project; replaced with
2700   extras/optparse.py and extras/textwrap.py.  These will be installed
2701   only if they're not already present in the Python installation.
2703 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2704   only if it's not already present in the Python installation.
2706 * docutils/statemachine.py:
2708   - Factored out ``State.add_initial_transitions()`` so it can be
2709     extended.
2710   - Converted whitespace-specific "blank" and "indent" transitions
2711     from special-case code to ordinary transitions: removed
2712     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2713     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2714     ``ws_initial_transitions`` attributes.
2715   - Removed ``State.match_transition()`` after merging it into
2716     ``.check_line()``.
2717   - Added ``StateCorrection`` exception.
2718   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2719     (moved ``TransitionCorrection`` support there too.)
2720   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2721     ``EOFError`` instead of ``IndexError``.
2722   - Added ``State.no_match`` method.
2723   - Added support for the Observer pattern, triggered by input line
2724     changes.
2725   - Added ``strip_top`` parameter to
2726     ``StateMachineWS.get_first_known_indented``.
2727   - Made ``context`` a parameter to ``StateMachine.run()``.
2728   - Added ``ViewList`` & ``StringList`` classes;
2729     ``extract_indented()`` becomes ``StringList.get_indented()``.
2730   - Added ``StateMachine.insert_input()``.
2731   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2732     thanks to) Fred Drake.
2734 * docutils/utils.py:
2736   - Added a ``source`` attribute to Reporter instances and
2737     ``system_message`` elements.
2738   - Added an observer pattern to ``utils.Reporter`` to keep track of
2739     system messages.
2740   - Fixed bugs in ``relative_path()``.
2741   - Added support for improved diagnostics.
2742   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2743   - Added support for encoding Reporter stderr output, and encoding
2744     error handlers.
2745   - Reporter keeps track of the highest level system message yet
2746     generated.
2748 * docutils/languages: Fixed bibliographic field language lookups.
2750 * docutils/languages/es.py: Added to project; Spanish mappings by
2751   Marcelo Huerta San Martin.
2753 * docutils/languages/fr.py: Added to project; French mappings by
2754   Stefane Fermigier.
2756 * docutils/languages/it.py: Added to project; Italian mappings by
2757   Nicola Larosa.
2759 * docutils/languages/sk.py: Added to project; Slovak mappings by
2760   Miroslav Vasko.
2762 * docutils/parser/__init__.py:
2764   - Added ``Parser.finish_parse()`` method.
2766 * docutils/parser/rst/__init__.py:
2768   - Added options: "--pep-references", "--rfc-references",
2769     "--tab-width", "--trim-footnote-reference-space".
2771 * docutils/parsers/rst/states.py:
2773   - Changed "title under/overline too short" system messages from INFO
2774     to WARNING, and fixed its insertion location.
2775   - Fixed enumerated list item parsing to allow paragraphs & section
2776     titles to begin with enumerators.
2777   - Converted system messages to use the new "line" attribute.
2778   - Fixed a substitution reference edge case.
2779   - Added support for "--pep-references" and "--rfc-references"
2780     options; reworked ``Inliner`` code to make customization easier.
2781   - Removed field argument parsing.
2782   - Added support for short section title over/underlines.
2783   - Fixed "simple reference name" regexp to ignore text like
2784     "object.__method__"; not an anonymous reference.
2785   - Added support for improved diagnostics.
2786   - Reworked directive API, based on Dethe Elza's contribution.  Added
2787     ``Body.parse_directive()``, ``.parse_directive_options()``,
2788     ``.parse_directive_arguments()`` methods.
2789   - Added ``ExtensionOptions`` class, to parse directive options
2790     without parsing field bodies.  Factored
2791     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2792     ``ExtensionOptions``.
2793   - Improved definition list term/classifier parsing.
2794   - Added warnings for unknown directives.
2795   - Renamed ``Stuff`` to ``Struct``.
2796   - Now flagged as errors: transitions at the beginning or end of
2797     sections, empty sections (except title), and empty documents.
2798   - Updated for ``statemachine.StringList``.
2799   - Enabled recognition of schemeless email addresses in targets.
2800   - Added support for embedded URIs in hyperlink references.
2801   - Added backslash-escapes to inline markup end-string suffix.
2802   - Added support for correct interpreted text processing.
2803   - Fixed nested title parsing (topic, sidebar directives).
2804   - Added special processing of backslash-escaped whitespace (idea
2805     from David Abrahams).
2806   - Made substitutions case-sensitive-but-forgiving; moved some code
2807     to ``docutils.nodes``.
2808   - Added support for block quote attributions.
2809   - Added a kludge to work-around a conflict between the bubble-up
2810     parser strategy and short titles (<= 3 char-long over- &
2811     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2812     titles" submitted by Jason Diamond.
2813   - Added explicit interpreted text roles for standard inline markup:
2814     "emphasis", "strong", "literal".
2815   - Implemented "superscript" and "subscript" interpreted text roles.
2816   - Added initial support for "abbreviation" and "acronym" roles;
2817     incomplete.
2818   - Added support for "--trim-footnote-reference-space" option.
2819   - Optional space before colons in directives & hyperlink targets.
2821 * docutils/parsers/rst/tableparser.py:
2823   - Fixed a bug that was producing unwanted empty rows in "simple"
2824     tables.
2825   - Detect bad column spans in "simple" tables.
2827 * docutils/parsers/rst/directives: Updated all directive functions to
2828   new API.
2830 * docutils/parsers/rst/directives/__init__.py:
2832   - Added ``flag()``, ``unchanged()``, ``path()``,
2833     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2834     directive option helper functions.
2835   - Added warnings for unknown directives.
2836   - Return ``None`` for missing directives.
2837   - Added ``register_directive()``, thanks to William Dode and Paul
2838     Moore.
2840 * docutils/parsers/rst/directives/admonitions.py:
2842   - Added "admonition" directive.
2844 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2845   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2846   "parsed-literal", "rubric", "epigraph", "highlights" and
2847   "pull-quote" directives.
2849 * docutils/parsers/rst/directives/images.py:
2851   - Added an "align" attribute to the "image" & "figure" directives
2852     (by Adam Chodorowski).
2853   - Added "class" option to "image", and "figclass" to "figure".
2855 * docutils/parsers/rst/directives/misc.py:
2857   - Added "include", "raw", and "replace" directives, courtesy of
2858     Dethe Elza.
2859   - Added "unicode" and "class" directives.
2861 * docutils/parsers/rst/directives/parts.py:
2863   - Added the "sectnum" directive; by Dmitry Jemerov.
2864   - Added "class" option to "contents" directive.
2866 * docutils/parsers/rst/directives/references.py: Added to project.
2867   Contains the "target-notes" directive.
2869 * docutils/parsers/rst/languages/__init__.py:
2871   - Return ``None`` from get_language() for missing language modules.
2873 * docutils/parsers/rst/languages/de.py: Added to project; German
2874   mappings by Engelbert Gruber.
2876 * docutils/parsers/rst/languages/en.py:
2878   - Added interpreted text roles mapping.
2880 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2881   mappings by Marcelo Huerta San Martin.
2883 * docutils/parsers/rst/languages/fr.py: Added to project; French
2884   mappings by William Dode.
2886 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2887   mappings by Nicola Larosa.
2889 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2890   mappings by Miroslav Vasko.
2892 * docutils/readers/__init__.py:
2894   - Added support for the observer pattern from ``utils.Reporter``, in
2895     ``Reader.parse`` and ``Reader.transform``.
2896   - Removed ``Reader.transform()`` method.
2897   - Added default parameter values to ``Reader.__init__()`` to make
2898     instantiation easier.
2899   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2901 * docutils/readers/pep.py:
2903   - Added the ``peps.TargetNotes`` transform to the Reader.
2904   - Removed PEP & RFC reference detection code; moved to
2905     parsers/rst/states.py as options (enabled here by default).
2906   - Added support for pre-acceptance PEPs (no PEP number yet).
2907   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2908     easy subclassing.
2910 * docutils/readers/python: Python Source Reader subpackage added to
2911   project, including preliminary versions of:
2913   - __init__.py
2914   - moduleparser.py: Parser for Python modules.
2916 * docutils/transforms/__init__.py:
2918   - Added ``Transformer`` class and completed transform reform.
2919   - Added unknown_reference_resolvers list for each transformer. This list holds
2920     the list of functions provided by each component of the transformer that
2921     help resolve references.
2923 * docutils/transforms/frontmatter.py:
2925   - Improved support for generic fields.
2926   - Fixed bibliographic field language lookups.
2928 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2929   transforms.
2931 * docutils/transforms/parts.py:
2933   - Moved the "id" attribute from TOC list items to the references
2934     (``Contents.build_contents()``).
2935   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2936   - Added "class" attribute support to ``Contents``.
2938 * docutils/transforms/peps.py:
2940   - Added ``mask_email()`` function, updating to pep2html.py's
2941     functionality.
2942   - Linked "Content-Type: text/x-rst" to PEP 12.
2943   - Added the ``TargetNotes`` PEP-specific transform.
2944   - Added ``TargetNotes.cleanup_callback``.
2945   - Added title check to ``Headers``.
2947 * docutils/transforms/references.py:
2949   - Added the ``TargetNotes`` generic transform.
2950   - Split ``Hyperlinks`` into multiple transforms.
2951   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2952   - Added check for circular indirect references.
2953   - Made substitutions case-sensitive-but-forgiving.
2955 * docutils/transforms/universal.py:
2957   - Added support for the "--expose-internal-attributes" option.
2958   - Removed ``Pending`` transform classes & data.
2960 * docutils/writers/__init__.py:
2962   - Removed ``Writer.transform()`` method.
2964 * docutils/writers/docutils-xml.py:
2966   - Added XML and doctype declarations.
2967   - Added "--no-doctype" and "--no-xml-declaration" options.
2969 * docutils/writers/html4css1.py:
2971   - "name" attributes only on these tags: a, applet, form, frame,
2972     iframe, img, map.
2973   - Added "name" attribute to <a> in section titles for Netscape 4
2974     support (bug report: Pearu Peterson).
2975   - Fixed targets (names) on footnote, citation, topic title,
2976     problematic, and system_message nodes (for Netscape 4).
2977   - Changed field names from "<td>" to "<th>".
2978   - Added "@" to "&#64;" encoding to thwart address harvesters.
2979   - Improved the vertical whitespace optimization; ignore "invisible"
2980     nodes (targets, comments, etc.).
2981   - Improved inline literals with ``<span class="pre">`` around chunks
2982     of text and ``&nbsp;`` for runs of spaces.
2983   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2984     ``self.docinfo`` segments.
2985   - Added support for "line_block", "address" elements.
2986   - Improved backlinks (footnotes & system_messages).
2987   - Improved system_message output.
2988   - Redefined "--stylesheet" as containing an invariant URL, used
2989     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2990     working directory.
2991   - Added "--footnote-references" option (superscript or brackets).
2992   - Added "--compact-lists" and "--no-compact-lists" options.
2993   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2994     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2995   - Improved field list rendering.
2996   - Added Docutils version to "generator" meta tag.
2997   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2998   - Improved layout of <pre> HTML source.
2999   - Fixed attribute typo on <colspec>.
3000   - Refined XML prologue.
3001   - Support for no stylesheet.
3002   - Removed "interpreted" element support.
3003   - Added support for "title_reference", "sidebar", "attribution",
3004     "rubric", and generic "admonition" elements.
3005   - Added "--attribution" option.
3006   - Added support for "inline", "subscript", "superscript" elements.
3007   - Added initial support for "abbreviation" and "acronym";
3008     incomplete.
3010 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3011   (from the sandbox).
3013   - Added french.
3014   - Double quotes in literal blocks (special treatment for de/ngerman).
3015   - Added '--hyperlink-color' option ('0' turns off coloring of links).
3016   - Added  "--attribution" option.
3017   - Right align attributions.
3019 * docutils/writers/pep_html.py:
3021   - Parameterized output encoding in PEP template.
3022   - Reworked substitutions from ``locals()`` into ``subs`` dict.
3023   - Redefined "--pep-stylesheet" as containing an invariant URL, used
3024     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
3025     working directory.
3026   - Added an override on the "--footnote-references" option.
3027   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3028   - Added Docutils version to "generator" meta tag.
3029   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3031 * docs/tools.txt:
3033   - Added a "silent" setting for ``buildhtml.py``.
3034   - Added a "Getting Help" section.
3035   - Rearranged the structure.
3036   - Kept up to date, with new settings, command-line options etc.
3037   - Added section for ``rst2latex.py`` (Engelbert Gruber).
3038   - Converted settings table into a definition list.
3040 * docs/rst/quickstart.txt:
3042   - Added a table of contents.
3043   - Added feedback information.
3044   - Added mention of minimum section title underline lengths.
3045   - Removed the 4-character minimum for section title underlines.
3047 * docs/rst/quickref.html:
3049   - Added a "Getting Help" section.
3050   - Added a style to make section title backlinks more subtle.
3051   - Added mention of minimum section title underline lengths.
3052   - Removed the 4-character minimum for section title underlines.
3054 * extras: Directory added to project; contains third-party modules
3055   that Docutils depends on (optparse, textwrap, roman).  These are
3056   only installed if they're not already present.
3058 * licenses: Directory added to project; contains copies of license
3059   files for non-public-domain files.
3061 * spec/doctree.txt:
3063   - Changed the focus.  It's about DTD elements:  structural
3064     relationships, semantics, and external (public) attributes.  Not
3065     about the element class library.
3066   - Moved some implementation-specific stuff into ``docutils.nodes``
3067     docstrings.
3068   - Wrote descriptions of all common attributes and parameter
3069     entities.  Filled in introductory material.
3070   - Working through the element descriptions: 55 down, 37 to go.
3071   - Removed "Representation of Horizontal Rules" to
3072     spec/rst/alternatives.txt.
3074 * spec/docutils.dtd:
3076   - Added "generated" inline element.
3077   - Added "line_block" body element.
3078   - Added "auto" attribute to "title".
3079   - Changed content models of "literal_block" and "doctest_block" to
3080     ``%text.model``.
3081   - Added ``%number;`` attribute type parameter entity.
3082   - Changed ``%structural.elements;`` to ``%section.elements``.
3083   - Updated attribute types; made more specific.
3084   - Added "address" bibliographic element.
3085   - Added "line" attribute to ``system_message`` element.
3086   - Removed "field_argument" element; "field_name" may contain
3087     multiple words and whitespace.
3088   - Changed public identifier to docutils.sf.net.
3089   - Removed "interpreted" element; added "title_reference",
3090     "abbreviation", "acronym".
3091   - Removed "refuri" attribute from "footnote_reference" and
3092     "citation_reference".
3093   - Added "sidebar", "rubric", "attribution", "admonition",
3094     "superscript", "subscript", and "inline" elements.
3096 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3098 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3100 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3102 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3103   Dallas Mahrt.
3105 * spec/transforms.txt: Added to project.
3107 * spec/howto: Added subdirectory, for developer how-to docs.
3109 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
3110   Elza, edited & extended by David Goodger.
3112 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
3113   project.
3115 * spec/rst/alternatives.txt:
3117   - Added "Doctree Representation of Transitions" from
3118     spec/doctree.txt.
3119   - Updated "Inline External Targets" & closed the debate.
3120   - Added ideas for interpreted text syntax extensions.
3121   - Added "Nested Inline Markup" section.
3123 * spec/rst/directives.txt:
3125   - Added directives: "topic", "sectnum", "target-notes",
3126     "line-block", "parsed-literal", "include", "replace", "sidebar",
3127     "admonition", "rubric", "epigraph", "highlights", "unicode" and
3128     "class".
3129   - Formalized descriptions of directive details.
3130   - Added an "align" attribute to the "image" & "figure" directives
3131     (by Adam Chodorowski).
3132   - Added "class" options to "topic", "sidebar", "line-block",
3133     "parsed-literal", "contents", and "image"; and "figclass" to
3134     "figure".
3136 * spec/rst/interpreted.txt: Added to project.  Descriptions of
3137   interpreted text roles.
3139 * spec/rst/introduction.txt:
3141   - Added pointers to material for new users.
3143 * spec/rst/reStructuredText.txt:
3145   - Disambiguated comments (just add a newline after the "::").
3146   - Updated enumerated list description; added a discussion of the
3147     second-line validity checking.
3148   - Updated directive description.
3149   - Added a note redirecting newbies to the user docs.
3150   - Expanded description of inline markup start-strings in non-markup
3151     contexts.
3152   - Removed field arguments and made field lists a generic construct.
3153   - Removed the 4-character minimum for section title underlines.
3154   - Clarified term/classifier delimiter & inline markup ambiguity
3155     (definition lists).
3156   - Added "Embedded URIs".
3157   - Updated "Interpreted Text" section.
3158   - Added "Character-Level Inline Markup" section.
3160 * test: Continually adding & updating tests.
3162   - Moved test/test_rst/ to test/test_parsers/test_rst/.
3163   - Moved test/test_pep/ to test/test_readers/test_pep/.
3164   - Added test/test_readers/test_python/.
3165   - Added test/test_writers/ (Engelbert Gruber).
3167 * tools:
3169   - Made the ``locale.setlocale()`` calls in front ends
3170     fault-tolerant.
3172 * tools/buildhtml.py:
3174   - Added "--silent" option.
3175   - Fixed bug with absolute paths & "--config".
3176   - Updated for new I/O classes.
3177   - Added some exception handling.
3178   - Separated publishers' setting defaults; prevents interference.
3179   - Updated for new ``publish_file()`` convenience function.
3181 * tools/pep-html-template:
3183   - Allow for "--embed-stylesheet".
3184   - Added Docutils version to "generator" meta tag.
3185   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3186   - Conform to XHTML spec.
3188 * tools/pep2html.py:
3190   - Made ``argv`` a parameter to ``main()``.
3191   - Added support for "Content-Type:" header & arbitrary PEP formats.
3192   - Linked "Content-Type: text/plain" to PEP 9.
3193   - Files skipped (due to an error) are not pushed onto the server.
3194   - Updated for new I/O classes.
3195   - Added ``check_requirements()`` & ``pep_type_error()``.
3196   - Added some exception handling.
3197   - Updated for new ``publish_string()`` convenience function.
3198   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3200 * tools/quicktest.py:
3202   - Added "-V"/"--version" option.
3204 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3206 * tools/unicode2rstsubs.py: Added to project.  Produces character
3207   entity files (reSructuredText substitutions) from the MathML master
3208   unicode.xml file.
3210 * tools/editors: Support code for editors, added to project.  Contains
3211   ``emacs/restructuredtext.el``.
3213 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3215   - Added style for chunks of inline literals.
3216   - Removed margin for first child of table cells.
3217   - Right-aligned field list names.
3218   - Support for auto-numbered section titles in TOCs.
3219   - Increased the size of inline literals (<tt>) in titles.
3220   - Restored the light gray background for inline literals.
3221   - Added support for "line_block" elements.
3222   - Added style for "address" elements.
3223   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3224   - Improved field list rendering.
3225   - Vertical whitespace improvements.
3226   - Removed "a.target" style.
3228 * tools/stylesheets/pep.css:
3230   - Fixed nested section margins.
3231   - Other changes parallel those of ``../default.css``.
3234 Release 0.2 (2002-07-31)
3235 ========================
3237 General:
3239 - The word "component" was being used ambiguously.  From now on,
3240   "component" will be used to mean "Docutils component", as in Reader,
3241   Writer, Parser, or Transform.  Portions of documents (Table of
3242   Contents, sections, etc.)  will be called "document parts".
3243 - Did a grand renaming: a lot of ``verylongnames`` became
3244   ``very_long_names``.
3245 - Cleaned up imports: no more relative package imports or
3246   comma-separated lists of top-level modules.
3247 - Added support for an option values object which carries default
3248   settings and overrides (from command-line options and library use).
3249 - Added internal Unicode support, and support for both input and
3250   output encodings.
3251 - Added support for the ``docutils.io.IO`` class & subclasses.
3253 Specific:
3255 * docutils/__init__.py:
3257   - Added ``ApplicationError`` and ``DataError``, for use throughout
3258     the package.
3259   - Added ``Component`` base class for Docutils components; implements
3260     the ``supports`` method.
3261   - Added ``__version__`` (thus, ``docutils.__version__``).
3263 * docutils/core.py:
3265   - Removed many keyword parameters to ``Publisher.__init__()`` and
3266     ``publish()``; bundled into an option values object.  Added
3267     "argv", "usage", "description", and "option_spec" parameters for
3268     command-line support.
3269   - Added ``Publisher.process_command_line()`` and ``.set_options()``
3270     methods.
3271   - Reworked I/O model for ``docutils.io`` wrappers.
3272   - Updated ``Publisher.set_options()``; now returns option values
3273     object.
3274   - Added support for configuration files (/etc/docutils.conf,
3275     ./docutils.conf, ~/.docutils).
3276   - Added ``Publisher.setup_option_parser()``.
3277   - Added default usage message and description.
3279 * docutils/frontend.py: Added to project; support for front-end
3280   (command-line) scripts.  Option specifications may be augmented by
3281   components.  Requires Optik (http://optik.sf.net/) for option
3282   processing (installed locally as docutils/optik.py).
3284 * docutils/io.py: Added to project; uniform API for a variety of input
3285   output mechanisms.
3287 * docutils/nodes.py:
3289   - Added ``TreeCopyVisitor`` class.
3290   - Added a ``copy`` method to ``Node`` and subclasses.
3291   - Added a ``SkipDeparture`` exception for visitors.
3292   - Renamed ``TreePruningException`` from ``VisitorException``.
3293   - Added docstrings to ``TreePruningException``, subclasses, and
3294     ``Nodes.walk()``.
3295   - Improved docstrings.
3296   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
3297   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
3298     imports.
3299   - Added ``decoration``, ``header``, and ``footer`` node classes, and
3300     ``PreDecorative`` mixin.
3301   - Reworked the name/id bookkeeping; to ``document``, removed
3302     ``explicit_targets`` and ``implicit_targets`` attributes, added
3303     ``nametypes`` attribute and ``set_name_id_map`` method.
3304   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
3305     traversals.
3306   - Added ``document.has_name()`` method.
3307   - Fixed DOM generation for list-attributes.
3308   - Added category class ``Labeled`` (used by footnotes & citations).
3309   - Added ``Element.set_class()`` method (sets "class" attribute).
3311 * docutils/optik.py: Added to project.  Combined from the Optik
3312   package, with added option groups and other modifications.  The use
3313   of this module is probably only temporary.
3315 * docutils/statemachine.py:
3317   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
3318   - Added underscores to improve many awkward names.
3319   - In ``string2lines()``, changed whitespace normalizing translation
3320     table to regexp; restores Python 2.0 compatibility with Unicode.
3322 * docutils/urischemes.py:
3324   - Filled in some descriptions.
3325   - Added "shttp" scheme.
3327 * docutils/utils.py:
3329   - Added ``clean_rcs_keywords`` function (moved from
3330     docutils/transforms/frontmatter.py
3331     ``DocInfo.filter_rcs_keywords``).
3332   - Added underscores to improve many awkward names.
3333   - Changed names of Reporter's thresholds:
3334     warning_level -> report_level; error_level -> halt_level.
3335   - Moved ``utils.id()`` to ``nodes.make_id()``.
3336   - Added ``relative_path(source, target)``.
3338 * docutils/languages/de.py: German mappings; added to project.  Thanks
3339   to Gunnar Schwant for the translations.
3341 * docutils/languages/en.py: Added "Dedication" bibliographic field
3342   mappings.
3344 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
3345   Chodorowski.
3347 * docutils/parsers/rst/states.py:
3349   - Added underscores to improve many awkward names.
3350   - Added RFC-2822 header support.
3351   - Extracted the inline parsing code from ``RSTState`` to a separate
3352     class, ``Inliner``, which will allow easy subclassing.
3353   - Made local bindings for ``memo`` container & often-used contents
3354     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
3355   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
3356   - Added ``MarkupMismatch`` exception; for late corrections.
3357   - Added ``-/:`` characters to inline markup's start string prefix,
3358     ``/`` to end string suffix.
3359   - Fixed a footnote bug.
3360   - Fixed a bug with literal blocks.
3361   - Applied patch from Simon Budig: simplified regexps with symbolic
3362     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
3363   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
3364   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
3365   - Allowed non-ASCII in "simple names" (directive names, field names,
3366     references, etc.).
3367   - Converted ``Inliner.patterns.initial`` to be dynamically built
3368     from parts with ``build_regexp()`` function.
3369   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
3370   - Updated docstrings.
3371   - Changed "table" to "grid_table"; added "simple_table" support.
3373 * docutils/parsers/rst/tableparser.py:
3375   - Changed ``TableParser`` to ``GridTableParser``.
3376   - Added ``SimpleTableParser``.
3377   - Refactored naming.
3379 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
3380   a fallback language for directive names.
3382 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
3383   directive to use a ``pending`` element, used only by HTML writers.
3385 * docutils/parsers/rst/directives/parts.py: Renamed from
3386   components.py.
3388   - Added "backlinks" attribute to "contents" directive.
3390 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
3391   project by Adam Chodorowski.
3393 * docutils/readers/__init__.py: Gave Readers more control over
3394   choosing and instantiating Parsers.
3396 * docutils/readers/pep.py: Added to project; for PEP processing.
3398 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
3399   requires a ``component`` parameter.
3401 * docutils/transforms/components.py: Added to project; transforms
3402   related to Docutils components.
3404 * docutils/transforms/frontmatter.py:
3406   - In ``DocInfo.extract_authors``, check for a single "author" in an
3407     "authors" group, and convert it to a single "author" element.
3408   - Added support for "Dedication" and generic bibliographic fields.
3410 * docutils/transforms/peps.py: Added to project; PEP-specific.
3412 * docutils/transforms/parts.py: Renamed from old components.py.
3414   - Added filter for `Contents`, to use alt-text for inline images,
3415     and to remove inline markup that doesn't make sense in the ToC.
3416   - Added "name" attribute to TOC topic depending on its title.
3417   - Added support for optional TOC backlinks.
3419 * docutils/transforms/references.py: Fixed indirect target resolution
3420   in ``Hyperlinks`` transform.
3422 * docutils/transforms/universal.py:
3424   - Changed ``Messages`` transform to properly filter out system
3425     messages below the warning threshold.
3426   - Added ``Decorations`` transform (support for ``--generator``,
3427     ``--date``, ``--time``, ``--source-link`` options).
3429 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3430   Engelbert Gruber's PDF writer.
3432 * docutils/writers/html4css1.py:
3434   - Made XHTML-compatible (switched to lowercase element & attribute
3435     names; empty tag format).
3436   - Escape double-dashes in comment text.
3437   - Improved boilerplate & modularity of output.
3438   - Exposed modular output in Writer class.
3439   - Added a "generator" meta tag to <head>.
3440   - Added support for the ``--stylesheet`` option.
3441   - Added support for ``decoration``, ``header``, and ``footer``
3442     elements.
3443   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3444     translation table to regexp; restores Python 2.0 compatibility
3445     with Unicode.
3446   - Added the translator class as instance variable to the Writer, to
3447     make it easily subclassable.
3448   - Improved option list spacing (thanks to Richard Jones).
3449   - Modified field list output.
3450   - Added backlinks to footnotes & citations.
3451   - Added percentage widths to "<col>" tags (from colspec).
3452   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3453     "<span>" changed to "<var>".
3454   - Inline literals: "<code>" changed to "<tt>".
3455   - Many changes to optimize vertical space: compact simple lists etc.
3456   - Add a command-line options & directive attributes to control TOC
3457     and footnote/citation backlinks.
3458   - Added support for optional footnote/citation backlinks.
3459   - Added support for generic bibliographic fields.
3460   - Identify backrefs.
3461   - Relative URLs for stylesheet links.
3463 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3464   PEPs (subclass of ``html4css1.Writer``).
3466 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3468 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3469   of the Docutils internal doctree in XML.
3471 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3473 * spec/doctree.txt:
3475   - Changed the title to "The Docutils Document Tree".
3476   - Added "Hyperlink Bookkeeping" section.
3478 * spec/docutils.dtd:
3480   - Added ``decoration``, ``header``, and ``footer`` elements.
3481   - Brought ``interpreted`` element in line with the parser: changed
3482     attribute "type" to "role", added "position".
3483   - Added support for generic bibliographic fields.
3485 * spec/notes.txt: Continual updates.  Added "Project Policies".
3487 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
3488   section.
3490 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3492 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
3493   mailing list discussions.
3495 * spec/pep-0287.txt:
3497   - Renamed to "reStructuredText Docstring Format".
3498   - Minor edits.
3499   - Reworked Q&A as an enumerated list.
3500   - Converted to reStructuredText format.
3502 * spec/pysource.dtd:
3504   - Reworked structural elements, incorporating ideas from Tony Ibbs.
3506 * spec/pysource.txt: Removed from project.  Moved much of its contents
3507   to pep-0258.txt.
3509 * spec/rst/alternatives.txt:
3511   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3512   - Added "Inline External Targets" section.
3514 * spec/rst/directives.txt:
3516   - Added "backlinks" attribute to "contents" directive.
3518 * spec/rst/problems.txt:
3520   - Updated the Enumerated List Markup discussion.
3521   - Added new alternative table markup syntaxes.
3523 * spec/rst/reStructuredText.txt:
3525   - Clarified field list usage.
3526   - Updated enumerated list description.
3527   - Clarified purpose of directives.
3528   - Added ``-/:`` characters to inline markup's start string prefix,
3529     ``/`` to end string suffix.
3530   - Updated "Authors" bibliographic field behavior.
3531   - Changed "inline hyperlink targets" to "inline internal targets".
3532   - Added "simple table" syntax to supplement the existing but
3533     newly-renamed "grid tables".
3534   - Added cautions for anonymous hyperlink use.
3535   - Added "Dedication" and generic bibliographic fields.
3537 * test: Made test modules standalone (subdirectories became packages).
3539 * test/DocutilsTestSupport.py:
3541   - Added support for PEP extensions to reStructuredText.
3542   - Added support for simple tables.
3543   - Refactored naming.
3545 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3547   - Now supports true packages containing test modules
3548     (``__init__.py`` files required); fixes duplicate module name bug.
3550 * test/test_pep/: Subpackage added to project; PEP testing.
3552 * test/test_rst/test_SimpleTableParser.py: Added to project.
3554 * tools:
3556   - Updated html.py and publish.py front-end tools to use the new
3557     command-line processing facilities of ``docutils.frontend``
3558     (exposed in ``docutils.core.Publisher``), reducing each to just a
3559     few lines of code.
3560   - Added ``locale.setlocale()`` calls to front-end tools.
3562 * tools/buildhtml.py: Added to project; batch-generates .html from all
3563   the .txt files in directories and subdirectories.
3565 * tools/default.css:
3567   - Added support for ``header`` and ``footer`` elements.
3568   - Added styles for "Dedication" topics (biblio fields).
3570 * tools/docutils.conf: A configuration file; added to project.
3572 * tools/docutils-xml.py: Added to project.
3574 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3576 * tools/pep-html-template: Added to project.
3578 * tools/pep2html.py: Added to project from Python (nondist/peps).
3579   Added support for Docutils (reStructuredText PEPs).
3581 * tools/quicktest.py:
3583   - Added the ``--attributes`` option, hacked a bit.
3584   - Added a second command-line argument (output file); cleaned up.
3586 * tools/stylesheets/: Subdirectory added to project.
3588 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3591 Release 0.1 (2002-04-20)
3592 ========================
3594 This is the first release of Docutils, merged from the now inactive
3595 reStructuredText__ and `Docstring Processing System`__ projects.  For
3596 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3597 `DPS HISTORY`__ files.
3599 __ http://structuredtext.sourceforge.net/
3600 __ http://docstring.sourceforge.net/
3601 __ http://structuredtext.sourceforge.net/HISTORY.html
3602 __ http://docstring.sourceforge.net/HISTORY.html
3604 General changes: renamed 'dps' package to 'docutils'; renamed
3605 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3606 the test suites (reStructuredText's test/test_states renamed to
3607 test/test_rst); and all modifications required to make it all work.
3609 * docutils/parsers/rst/states.py:
3611   - Improved diagnostic system messages for missing blank lines.
3612   - Fixed substitution_reference bug.
3616    Local Variables:
3617    mode: indented-text
3618    indent-tabs-mode: nil
3619    sentence-end-double-space: t
3620    fill-column: 70
3621    End: