Implement feature request [ 48 ]
[docutils.git] / HISTORY.txt
blobc10f3f1c1475856d1a76179598905363dae1c095
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::
16 Changes Since 0.12
17 ==================
19 * docutils/nodes.py
21   - Fix [ 253 ] Attribute key without value not allowed in XML.
23 * docutils/parsers/
25   - Apply [ 103 ] Recognize inline markups without word boundaries.
26   - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
28 * docutils/parsers/rst/__init__.py
30   - Fix [ 233 ] Change the base URL for the :rfc: role.
32 * docutils/parsers/rst/directives/tables.py
34   - Patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
35     or 'grid'.
37   - Implement feature request [ 48 ]
38     Add :align: option to the table directives.
39     Thanks to Takeshi KOMIYA for the patch.
41 * docutils/parsers/rst/roles.py
43   - Fix [ 295 ] Class argument for custom role inheriting from math.
45 * docutils/parsers/rst/tableparser.py
47   - Really fix [ 159 ] Spurious table column alignment errors.
49 * docutils/transforms/frontmatter.py
51   - Add name of generic bibliographic fields as a "classes" attribute value
52     (after conversion to a valid identifier form).
54 * docutils/utils/error_reporting.py
56   - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
58 * docutils/utils/math/math2html.py
60   - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
61   - New upstream version (additional macros, piecewise integrals and sums).
63 * docutils/writers/html_plain/
65   - New HTML writer generating clean, polyglot_ markup conforming to
66     `HTML 5`_.
68     The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
69     and recommended layout rules.
71 * docutils/writers/html4css1/__init__.py
73   - Add "docutils" to class values for "container" object to address [ 267 ].
74   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
75     ``default_stylesheet_path`` and ``default_template_path``.
76   - Fix [ 266 ] creating labels/class values in description list items.
77   - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
78   - Fix footnotes with content that does not start with a paragraph.
79   - Use https in default MathJax URL (report Alan G Isaac).
81 * docutils/writers/latex2e/__init__.py
83   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
84     admonitions and docinfo.
86   - Use absolute path for ``default_template_path``.
88   - Removed deprecated options ``--use-latex-footnotes`` and
89     ``--figure-footnotes``.
91   - Cleaner LaTeX code for enumerations and literal blocks.
93   - Use "hyperref" package together with "bookmark" (improved hyperlinking
94     by the same author).
96   - Fix [ 286 ] Empty column title cause invalid latex file.
98   - Fix [ 224 ] Fix rowspan support for tables.
100 * docutils/writers/odf_odt/__init__.py
102   - remove decode.encode of filename stored in zip.
104 * docutils/writers/xetex/__init__.py
106   - LuaLaTex compatibility: do not load "xunicode".
108 * tools/
110   - New front-end ``rst2html5.py``.
112 * tox.ini
114   - Test py26, py27, py33 and py34.
116     To use, install the ``tox`` package via pip or easy_install and use
117     tox from the project root directory.
119 .. _polyglot: http://www.w3.org/TR/html-polyglot/
120 .. _HTML 5: http://www.w3.org/TR/html5/
121 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
124 Release 0.12 (2014-07-06)
125 =========================
127 * docs/ref/rst/directives.txt
129   - Update "math" and "csv-table" descriptions.
131 * docutils/parsers/rst/directives/images.py
133   - Fix [ 258 ] figwidth="image" generates unitless width value.
135 * docutils/parsers/rst/states.py
137   - Improve error report when a non-ASCII character is specified as
138     delimiter, quote or escape character under Python 2.
139     Fixes [ 249 ] and [ 250 ].
141 * docutils/writers/html4css1/__init__.py
143   - Don't add newline after inline math.
144     Thanks to Yury G. Kudryashov for the patch.
146 * docutils/writers/latex2e/__init__.py
148   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
149   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
151 * docutils/writers/odf_odt/__init__.py
153   - Apply patch by Jakub Wilk to fix bug [ 100 ].
155 * test/test_error_reporting.py
157   - Fix [ 223 ] by removing redundant tests we do not have control over.
159 * test/test_nodes.py
161   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
163 Release 0.11 (2013-07-22)
164 =========================
166 * General
168   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
169   - Support embedded aliases within hyperlink references.
170   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
171     language module) before global search.
173 * docutils/nodes.py
175   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
177 * docutils/parsers/rst/directives/__init__.py
179   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
181 * docutils/parsers/rst/directives/images.py
183   - Apply [ 3599485 ] node source/line information for sphinx translation.
185 * docutils/parsers/rst/directives/tables.py
187   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
189 * docutils/parsers/rst/states.py
191   - Fix [ 157 ] Line block parsing doesn't like system message.
192   - Always import our local copy of roman.py (report Larry Hastings).
194 * docutils/transforms/references.py
196   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
198 * docutils/utils/__init__.py
200   - Fix [ 3596884 ] exception importing ``docutils.io``.
202 * docutils/writers/html4css1/__init__.py
204   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
205   - New setting `stylesheet_dirs`: Comma-separated list of directories
206     where stylesheets are found. Used by `stylesheet_path` when expanding
207     relative path arguments.
208   - New default for math-output_: ``HTML math.css``.
209   - Avoid repeated class declarations in html4css1 writer
210     (modified version of patch [ 104 ]).
212 .. _math-output: docs/user/config.html#math-output
214 * docutils/writers/latex2e/__init__.py
216   - Drop the simple algorithm replacing straight double quotes with
217     English typographic ones.
218     Activate the SmartQuotes_ transform if you want this feature.
219   - Fix literal use of babel shorthands (straight quote, tilde, ...).
220   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
221   - New setting `stylesheet_dirs`.
223 .. _SmartQuotes: docs/user/config.html#smart-quotes
225 * docutils/writers/manpage.py
227   - Fix [3607063] handle lines starting with a period.
228   - Fix option separating comma was bold (thanks to Bill Morris).
230 Release 0.10 (2012-12-16)
231 =========================
233 * General
235   - Dropped support for Python 2.3.
236   - ``docutils/math``, ``docutils/error_reporting.py``, and
237     ``docutils/urischemes.py`` moved to the utils package.
238   - Fix [3541369] Relative __import__ also with Python 3.3.
239   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
240     and parsers for Python 2.7 up.
241   - Fix import of PIL.Image.
242   - Change default of "syntax highlight" option to "long",
243     basic syntax highlight styles for LaTeX and HTML.
245 * docutils/io.py
247   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
248     option is ignored and will be removed in a future release.
249   - Fix Py3k error writing to stdout with encoding differing from default.
250   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
252 * docutils/parsers/rst/directives/misc.py
254   - Fix [ 3546533 ] Unicode error with `date` directive.
256 * docutils/transforms/universal.py
258   - SmartQuotes transform for typographic quotes and dashes.
260 * docutils/utils/__init__.py
262   - normalize_language_tag() now returns `BCP 47`_ conformant tags
263     with subtags separated by ``-``.
265 * docutils/writers/html4css1/__init__.py
267   - Use ``<code>`` tag for inline "code",
268     do not drop nested inline nodes (syntax highlight tokens).
269   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
270   - No line break after opening inline math tag.
272 * docutils/writers/manpage.py
274   - Apply [ 3527401 ] addmonition's don't preserve indentation
275   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
277 * docutils/writers/xetex/__init__.py
279   - Apply [ 3555160 ] ensure order of "otherlanguages".
280   - Fix section numbering by LaTeX.
282 * docutils/writers/s5_html/__init__.py
284   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
286 * docutils/writers/s5_html/docutils_xml.py
288   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
290 * setup.py
292   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
294 * tools/test/test_buildhtml.py
296   - Fix [ 3521167 ] allow running in any directory.
297   - Fix [ 3521168 ] allow running with Python 3.
300 Release 0.9.1 (2012-06-17)
301 ==========================
303 * setup.py
305   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
306     installed in the PYTHONPATH. Converted tests are now
307     stored in ``test3/``, tools no longer need conversion.
309     If you installed one of Docutils versions 0.7 ... 0.9 with
310     ``setup.py install`` under Python 3, remove the spurious
311     ``test/`` and ``tools/`` directories in the site library root.
313 * test/
315   - Make tests independent from the location of the ``test/`` directory.
316   - Use converted sources (from the ``build/`` directory) for tests under
317     Python 3.
319 * tools/
321   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
323 * docutils/io.py
325   - Fix writing binary data to sys.stdout under Python 3 (allows
326     ``rst2odt.py`` to be used with output redirection).
328 * docutils/parsers/rst/directives/misc.py
330   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
331     ``locale == C`` and 8-bit char in path argument of `include` directive.
333 * test/alltests.py
335   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
336     file under Python 3.
338 Release 0.9 (2012-05-02)
339 ========================
341 * General:
343   - New reStructuredText "code" role and directive and "code" option
344     of the "include" directive with syntax highlighting by Pygments_.
345   - Fix parse_option_marker for option arguments containing ``=``.
346   - Fix [ 2993756 ]: import Python Imaging Library's Image module
347     via ``import PIL`` as starting with PIL 1.2,
348     "PIL lives in the PIL namespace only" (announcement__).
350 .. _Pygments: http://pygments.org/
351 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
353 * setup.py
355   - Fix [ 2971827 ] and [ 3442827 ]
356     extras/roman.py moved to docutils/utils/roman.py
358 * docutils/frontend.py
360   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
362 * docutils/io.py
364   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
365   - `mode` argument for FileOutput avoids code replication in
366     BinaryFileOutput.
367   - New exceptions InputError and OutputError for IO errors in
368     FileInput/FileOutput.
370 * docutils/core.py:
372   - No "hard" system exit on file IO errors: catch and report them in
373     `Publisher.reportException` instead. Allows handling by a calling
374     application if the configuration setting `traceback` is True.
376 * docutils/utils.py -> docutils/utils/__init__.py
378   - docutils.utils is now a package (providing a place for sub-modules)
380   .. note:: docutils/math, docutils/error_reporting.py, and
381      docutils/urischemes.py will move to the utils package in the next
382      release, too. See RELEASE-NOTES__
384      __ RELEASE-NOTES.html
386   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
387     errors recording non-ASCII filenames (fixes [ 3434355 ]).
389   - Fix relative_path() with source=None and `unicode` target.
391 * docutils/parsers/rst/states.py
393   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
394     characters and "international" quotes around inline markup.
395   - Use `field_marker` pattern to look for start of a
396     directive option block (fixes [ 3484857 ]).
398 * docutils/parsers/rst/tableparser.py
400   - Fix [ 2926161 ] for simple tables.
401     (Combining chars in grid tables still contribute to cell width.)
403 * docutils/writers/latex2e/__init__.py
405   - Support the `abbreviation` and `acronym` standard roles.
406   - Record only files required to generate the LaTeX source as dependencies.
407   - Fix handling of missing stylesheets.
408   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
409     when suppressing LaTeX section numbering.
410   - Use ``\DUtitle`` for unsupported section levels
411   - Apply [ 3512791 ] do not compare string literals with "is"
413 * docutils/writers/xetex/__init__.py
415   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
417 * docutils/writers/html4css1/__init__.py
419   - Change default for `math-output` setting to MathJax.
420   - Fix handling of missing stylesheets.
422 * docutils/writers/docutils_xml.py
424   - Use the visitor pattern with default_visit()/default_depart() methods
425     instead of minidom to facilitate special handling of selected nodes.
426   - Support raw XML (inserted as-is inside a <raw></raw> node).
428 * docutils/writers/manpage.py
430   - Do not emit comment line with trailing blank. Problematic for VCS.
432 Release 0.8.1 (2011-08-30)
433 ==========================
435 * General:
437   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
438     and [ 3395920 ] (correct copyright info for rst.el).
440 * test/
442   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
444 * docutils/writers/latex2e/__init__.py
446   - Clean up Babel language setting. Restores Sphinx compatibility.
448 Release 0.8 (2011-07-07)
449 ========================
451 * General:
453   - Handle language codes according to `BCP 47`_.
454   - If the specified language is not supported by Docutils,
455     warn and fall back to English.
456   - Math support: reStructuredText "math" role and directive,
457     ``math`` and ``math_block`` doctree elements.
458   - Decode command line arguments with the locale's preferred encoding
459     (to allow, e.g., ``--title=Dornröschen``).
460   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
461   - New sub-module `error_reporting`: handle encoding/decoding errors
462     when reporting exceptions.
463   - Some additions to the Docutils core are released under the 2-Clause BSD
464     license, see COPYING_ for details.
466   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
467   .. _COPYING: COPYING.html
469 * reStructuredText:
471   - Most directives now support a "name" option that attaches a
472     reference name.
474   - Directive content may start on the first line also when the directive
475     type accepts options.
477 * docs/dev/policies.txt:
479   - Recommend the 2-Clause BSD license
480     (http://www.spdx.org/licenses/BSD-2-Clause)
481     for code that is kept under the author's copyright.
483 * tools/buildhtml.py:
485   - Fix ``--local`` switch.
487 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
489 * docutils/writers/html4css1/__init__.py
491   - Set "lang" argument for objects with class argument
492     "language-<language tag>".
493   - New setting "math-output" with support for HTML, MathML, and LaTeX.
495 * docutils/writers/latex2e/__init__.py
497   - Fix [ 3043986 ] AttributeError using :local: with table of content.
498   - Place title data in the document preamble.
499   - Load `babel` package only if required.
500   - Update list of supported languages.
501   - New config setting "hyperref-options".
502     No hard-coded "unicode" hyperref option (clash with xetex).
503   - Set language for custom roles, paragraphs, block-quotes, and
504     line-quotes with class argument "language-<language tag>".
505   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
506   - Convert image URI to a local file path.
507   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
508     has more than one paragraph (Wolfgang Scherer).
509   - \leavevmode before longtable only when needed (prevents spurious vspace)
510   - do not advance table counter for tables without caption
512 * docutils/writers/xetex/__init__.py
514   - New writer generating LaTeX code for compiling with ``xelatex``.
516     A separate writer (inheriting from latex2e) instead of a ``--xetex``
517     option allows separate config options for XeTeX vs. LaTeX2e.
519 * docutils/writers/manpage.py
521   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
522   - Fix: vertical space cleaning for option group ``.``.
524 * tools/editors/emacs/rst.el:
526   - Fix [ 3001100 ] does not handle spaces in filenames
527     (thanks to Jakub Wilk)
529 * docutils/utils.py:
531   - strip whitespace from stylesheet arguments
532   - exclude combining chars from column_width()
533     (partial fix for [ 2926161 ])
535 * docutils/parsers/rst/directives/misc.py:
537   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
538     nested_parse
540 * docutils/io.py:
542   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
543     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
545 Release 0.7 (2010-07-07)
546 ========================
548 * General:
550   - Fix [ 2881769 ] setup configuration.
551   - Fix [ 2788716 ] reporting problems in included files.
553 * docutils/io.py
555   - FileInput opens files as text files with universal newline support
556     (mode "rU", configurable with the new optional argument "mode").
558 * docutils/nodes.py
560   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
562 * docutils/utils.py
564   - Fix [ 2923723 ] let decode_path() tolerate path == None
566 * docutils/writers/html4css1/__init__.py
568   - Support SVG and SWF images (thanks to Stefan Rank).
569   - Generate valid XHTML for centered images with targets.
570     Use CSS classes instead of "align" tags for image alignment.
572 * docutils/writers/latex2e/__init__.py
574   - Use `transforms.writer_aux.Admonitions` to "normalize" special
575     admonitions.
576   - Use the ``\url`` command for URLs (breaks long URLs instead of
577     writing into the margin).
578   - Preserve runs of spaces in `inline literals`__.
579   - Deprecate ``figure_footnotes`` setting.
580   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
581   - New ``latex_preamble`` setting.
582   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
583   - Fix hyperlink targets (labels) for images, figures, and tables.
584   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
585   - Apply [ 2961991 ] Call hyperref with unicode option.
586   - Drop the special `output_encoding`__ default ("latin-1").
587     The Docutils wide default (usually "UTF-8") is used instead.
588   - Render inline markup in document title and subtitle.
589   - Fix numbering depth with LaTeX section numbering.
590   - Update Unicode -> LaTeX translations.
591   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
593 __ docs/ref/restructuredtext.html#inline-literals
594 __ docs/user/config.html#docutils-footnotes
595 __ docs/user/config.html#output_encoding
597 * docutils/writers/manpage.py
599   - Fix: supported attribute (thanks to peter2108).
600   - Remove trailing blanks in code (keep in sync with mercurial version).
601   - Titles level 1, that is ``.SH``, always uppercase.
602   - Apply patch from mg: literal text should be bold in man-pages.
604 * docutils/nodes.py
606   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
607     turkish locale.
609 * setup.py:
611   - Python 3 support: copy test/ and tools/ to the build-dir
612     and convert Python sources with 2to3.
615 Release 0.6 (2009-10-11)
616 ========================
618 * General:
620   - Docutils is now compatible with Python versions from 2.3 up to 2.6
621     and convertible to 3.1 code.
623     + Node.__nonzero__ returns True instead of 1.
624     + use os.walk instead os.path.walk.
625     + minimize "types" module where possible.
626     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
627     + Text nodes now subclass unicode rather than UserString
628       (which is gone in python 3.0).
629     + 3.0 compatibility module docutils._compat
631     + Drop 2.2 compatibility workarounds.
632     + Drop extras/optparse.py and extras/textwrap.py
633       (stdlib modules since 2.3).
635   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
636   - Unix man page export: manpage writer moved from sandbox to Doctutils
637     core.
639   - Apply [ 1719345 ] Galician translation
640   - Apply [ 1905741 ] Polish translation
641   - Apply [ 1878977 ] make_id(): deaccent characters.
642   - Apply [ 2029251 ] return nonzero when tests fail.
643   - Fix [ 1692788 ] allow UTF-8 in style sheets.
644   - Fix [ 2781629 ] support non-ASCII chars in file names.
645   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
646   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
647   - Fix [ 2821266 ] --strict option works now like --halt=info.
648   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
649   - Fix [ 1627229 ] hyperlink references in substitutions.
651   - The "newlatex" writer is orphaned.
653 * reStructuredText:
655   - Documented Unicode characters allowed as inline markup openers,
656     closers, and delimiters.
657   - Allow units for all length specifications.
658   - Allow percent sign in "scale" argument of "figure" and "image" directives.
659   - Bugfix: The "figalign" argument of a figure now works as intended
660     (aligning the figure, not its contents).
661   - Align images with class "align-[right|center|left]"
662     (allows setting the alignment of an image in a figure).
664 * docutils/nodes.py:
666   - Added ``Element.__contains__`` method, for the in-operator.
668 * docutils/parsers/rst/states.py:
670   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
671   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
672     " " (non-breaking space), and "¡ ¿" openers.
674 * docutils/parsers/directives/misc.py:
676   - Added ``start-line`` and ``end-line`` options to "include"
677     directive to select a range of lines.
678   - Hard tabs in literal inclusions are replaced by spaces. This is
679     configurable via the new ``tab-width`` option of the "include" directive
680     (a negative tab-width prevents tab expansion).
682 * docutils/utils.py:
684   - Add ``get_stylesheet_list`` function.
685   - Apply [ 2834836 ] print info at halt
687 * docutils/transforms/universal.py:
689   - Raise default priority of StripClasses to exclude stripped classes from
690     the ToC.
692 * docutils/writers/html4css1/__init__.py:
694   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
695     separated list of stylesheets.
696   - Address [ 1938891 ] Inline literal text creates "pre" span only when
697     needed to prevent inter-word line wraps.
698   - Use `translate` method instead of repeated `replace` calls.
699   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
700     classes to allow CSS styling that does not interfere with other
701     table-using constructs (field lists, citations, ...).
703 * docutils/writers/newlatex2e/__init__.py:
705   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
707 * docutils/writers/latex2e/__init__.py (see also
708   `<docs/user/docutils-05-compat.sty.html>`__) :
710   - Add ``--embed-stylesheet`` option.
711   - Apply [ 1474017 ] image vertical alignment is reversed.
712   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
713   - Change: has_key for dictionaries (not Nodes) to in-operator.
714   - Merge adjacent citations into one latex cite command.
715   - Failsave implementation of custom roles. LaTeX compilation now ignores
716     unknown classes instead of aborting with an error.
717   - Support custom roles based on standard roles.
718   - LaTeX packages can be used as ``--stylesheet`` arguments without
719     restriction. (A style sheet is now referenced with the ``\usepackage``
720     command, if it ends with ``.sty`` or has no extension.)
721   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
722   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
723   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
724     2005-02-04 as a configurable length unit).
725   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
726     if font-encoding is set to ''. LaTeX defaults to OT1 then.
727   - Set sub- and superscript role argument in text mode not as math.
728     Use a custom role based on sub-/superscript if you want italic shape.
729   - Shorter preamble and less dependencies: Load packages and define macros
730     only if required in the document.
731   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
732   - New custom environments and commands with optional "classes" argument.
733   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
734   - Better conformance to Docutils specifications with ``--use-latex-toc``.
735     Support for LaTeX generated ToC also with unnumbered sections.
736   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
737     section numbering by LaTeX.
738   - Use default font in admonitions and sidebar.
739   - Align of image in a figure defaults to 'center'.
740   - Bugfix: Newlines around targets and references prevent run-together
741     paragraphs.
742   - Fix internal hyperlinks.
743   - Use class defaults for page margins ('typearea' now optional).
744   - Float placement made configurable, default changed to "here definitely".
745   - Typeset generic topic as "quote block with title".
746   - Use template (file and configuration option).
747   - In the default template, load cmap.sty (fix text extraction in PDF) and
748     fixltx2e.sty (LaTeX patches, \textsubscript).
749   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
750   - Use `translate` instead of repeated `replace` calls for text encoding.
751   - Hyperlinked footnotes and support for symbol footnotes and
752     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
753   - Complete pairs of binary options
754     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
755     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
756   - New defaults:
757     - font-encoding: "T1" (formerly implicitely set by 'ae').
758     - use-latex-toc: true (ToC with page numbers).
759     - use-latex-footnotes: true (no mixup with figures).
761 * docutils/writers/manpage.py
763   - Do not print version at document end, this is done by the viewer.
764   - Do not print date at document end, this is done by the viewer.
765   - Fix storage of docinfo fields for none standard fields.
767 * docutils/tools/rst2man.py
769 Release 0.5 (2008-06-25)
770 ========================
772 * docutils/languages/he.py: Added to project: Hebrew mappings by
773   Meir Kriheli.
775 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
776   mappings by Meir Kriheli.
778 * docutils/frontend.py:
780   - Configuration files are now assumed and required to be
781     UTF-8-encoded.
782   - Paths of applied configuration files are now recorded in the
783     runtime setting ``_config_files`` (accessible via
784     ``--dump-settings``).
785   - Added ``--strip-elements-with-class`` and ``--strip-class``
786     options (``strip_elements_with_classes`` and ``strip_classes``
787     settings).
789 * docutils/io.py:
791   - Added code to determine the input encoding from data: encoding
792     declarations or the presence of byte order marks (UTF-8 & UTF-16).
793   - Added support for IronPython 1.0.
795 * docutils/nodes.py:
797   - Added ``document.__getstate__`` method, for pickling.
799 * docutils/parsers/rst/states.py:
801   - Allow ``+`` and ``:`` in reference names.
802   - Unquoted targets beginning with an underscore (``.. __target:
803     URI``) are no longer accepted.
804   - Added support for multiple attributions in a physical block quote
805     (indented text block), dividing it into multiple logical block
806     quotes.
807   - Added support for unicode bullets in bullet lists: "•", "‣", and
808     "⁃".
809   - Added support for new object-oriented directive interface,
810     retaining compatibility to the old functional interface.
811   - Added support for throwing ``DirectiveError``'s from within
812     directive code.
814 * docutils/parsers/rst/__init__.py:
816   - Added ``Directive`` base class.
817   - Added ``DirectiveError`` base class.
818   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
819     definitions.
821 * docutils/parsers/directives/:
823   - Refactored all reStructuredText directives to use the new
824     object-oriented directive interface.  Errors are now (mostly)
825     thrown using the new ``DirectiveError`` class.
827 * docutils/parsers/directives/misc.py:
829   - Added ``start-after`` and ``end-before`` options to ``include``
830     directive; thanks to Stefan Rank.
832 * docutils/transforms/universal.py:
834   - Added ``StripClassesAndElements`` transform to remove from the
835     document tree all elements with classes in
836     ``settings.strip_elements_with_classes`` and all "classes"
837     attribute values in ``self.document.settings.strip_classes``.
839 * docutils/transforms/writer_aux.py:
841   - Added ``Admonitions`` transform to transform specific admonitions
842     (like ``note``, ``warning``, etc.) into generic admonitions with a
843     localized title.
845 * docutils/writers/html4css1/__init__.py:
847   - Moved template functionality from the PEP/HTML writer here.
848   - Expanded the fragments available in the ``parts`` attribute.
849   - Moved ``id`` attributes from titles to surrounding ``div``
850     elements.
851   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
852     universally supported now).
853   - ``template.txt`` is now opened in text mode instead of binary mode
854     (to ensure Windows compatibility).
855   - ``a`` elements now have an "internal" or "external" class,
856     depending on reference type.
858 * docutils/writers/html4css1/template.txt: Added to project.
860 * docutils/writers/pep_html/:
862   - Moved template functionality to the HTML writer.
864 * docutils/writers/s5_html/__init__.py:
866   - Added ``view_mode`` & ``hidden_controls`` settings
867     (``--view-mode`` & ``--hidden-controls/--visible-controls``
868     options).
870 * docutils/writers/latex2e/__init__.py:
872   - Add ``--literal-block-env``
873   - Fix: escaping ``%`` in href urls.
874   - Move usepackage hyperref after stylesheet inclusion.
875   - Fix: scrartcl does not have chapter but scrreprt.
876   - Add newline after ``\end{verbatim}``.
877   - Merge smaller differences from latex2e_adaptive_preamble.
878   - Add ``use-part-section``.
879   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
880   - Using leavemode option_list no longer needs to check if parent
881     is a definition list.
882   - Append ``\leavemode`` to definition list terms.
883   - No longer write visit\_/depart_definition_list_item comments to
884     output.
885   - Table column width with 3 decimal places.
886   - Add table stubs support (boldfont).
887   - Add assemble_parts to writer.
888   - Add simply support for nested tables.
889   - Fix verbatim in tables if use-verbatim-when-possible.
890   - Use section commands down to subparagraph.
891   - Put ensuremath around some latin1 chars.
892   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
893   - New option ``--use-bibtex=style,db1,db2``.
894   - New option ``--reference-label`` to allow usage of LaTeX ref for
895     labels in section references.
896   - Add a label after every section to support sectionnumbers as reference
897     labels.
898   - Fix: bug# 1605376 rst2latex: bad options group list
899   - Remove inactive code for use_optionlist_for_option_list.
900   - Remove latex comments from option_list output.
901   - Fix: bug# 1612270 double qoutes in italian literal.
902   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
903   - Add option --use-latex-abstract.
904   - Image width unit ``px`` is translated to ``pt``.
905   - Add image height support.
906   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
907     bug #1457388
908   - Fix: Do not escape underscores in citation reference labels if
909     use-latex-citations is set.
910   - Use centering instead of center for figure contents, to avoid vertical
911     space.
912   - Recognize table class: borderless, nolines, booktabs, standard.
913   - Fix: Renaming contents section does not work with latex writer; SF
914     bug #1487405.
915   - Applied patch for custom roles with classes from Edward Loper.
916   - Fixed bug that caused crashes with more than 256 lists.
918 * docutils/writers/pep_html/__init__.py:
920   - Changed to support new python.org website structure and
921     pep2pyramid.py.
923 * docs/howto/security.txt: "Deploying Docutils Securely", added to
924   project.
926 * tools/buildhtml.py:
928   -- Added ``ignore`` setting to exclude a list of shell patterns
929      (default: ``.svn:CVS``).
931 * tools/editors/emacs/rst.el:
933   - Changed license to "GPL".
934   - Added ``rst-straighten-decorations`` function.
935   - The ``compile`` module is now always loaded.
936   - Added ``rst-toggle-line-block`` function.
937   - Headings consisting only of non-ASCII characters are now
938     recognized by ``rst-toc`` and ``rst-adjust``.
939   - Added font-lock support for multi-line comments where the first
940     comment line is empty.
941   - Added ``(require 'font-lock)``.
943 * setup.py:
945   - Provide descriptive error message if distutils is missing.
948 Release 0.4 (2006-01-09)
949 ========================
951 * General:
953   - Updated the project policies for trunk/branch development &
954     version numbering.
956 * docutils/__init__.py:
958   - Added ``__version_details__`` attribute to describe code source
959     (repository/snapshot/release).
960   - Replaced ``default_transforms`` attribute of TransformSpec with
961     ``get_transforms()`` method.
963 * docutils/core.py:
965   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
966     functions, for document tree extraction and reprocessing.
968 * docutils/io.py:
970   - Added ``DocTreeInput`` class, for reprocessing existing documents.
971   - Added support for non-Unicode (e.g. binary) writer output.
973 * docutils/nodes.py:
975   - Re-introduced ``Targetable.indirect_reference_name``, for
976     MoinMoin/reST compatibility (removed in r3124/r3129).
977   - Added ``serial_escape`` function; escapes string values that are
978     elements of a list, for serialization.  Modified Docutils-XML
979     writing (``Element._dom_node``) and pseudo-XML writing
980     (``Element.starttag``) to use ``serial_escape``.
981   - Added ``Node.deepcopy()`` method.
982   - Removed the internal lists ``document.substitution_refs``,
983     ``document.anonymous_refs``, and ``document.anonymous_targets``.
984   - Added a "container" element.
985   - Fixed bug where values of list-valued attributes of elements
986     originating from custom interpreted text roles (i.e., with custom
987     classes) were being shared between element instances.  Reported by
988     Shmuel Zeigerman.
990 * docutils/statemachine.py:
992   - Added trailing whitespace stripping to ``string2lines()``.
993   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
994     Asian double-width character support.
996 * docutils/utils.py:
998   - Added ``east_asian_column_width()`` for double-width character
999     support.
1001 * docutils/languages/ja.py: Added to project: Japanese mappings by
1002   Hisashi Morita.
1004 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1005   mappings by Panjunyong.
1007 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1009 * docutils/parsers/rst/__init__.py:
1011   - Added validator to tab_width setting, with test.  Closes SF bug
1012     #1212515, report from Wu Wei.
1014 * docutils/parsers/rst/states.py:
1016   - Fixed bug with escaped colons indicating a literal block.
1017   - Fixed bug with enumerated lists (SF#1254145).
1018   - Backslash-escaped colons inside of field names are now allowed.
1019   - Targets (implicit and explicit), anonymous hyperlink references
1020     and auto-numbered footnote references inside of substitution
1021     definitions are now disallowed.
1022   - Fixed bug: list items with blank first lines.
1023   - Fixed bug: block quote attributions with indented second lines.
1024   - Added East Asian double-width character support (Python 2.4 only).
1026 * docutils/parsers/rst/tableparser.py:
1028   - Added East Asian double-width character support (Python 2.4 only).
1030 * docutils/parsers/rst/directives/body.py:
1032   - Added the "container" directive.
1034 * docutils/parsers/rst/directives/misc.py:
1036   - Added the "default-role", "title", and "date" directives.
1037   - Added standard data file syntax to the "include" directive.
1038   - Added support for "class" directive content.
1040 * docutils/parsers/rst/directives/images.py:
1042   - Added ``indirect_reference_name`` support for images with a target
1043     option.
1044   - Added support for image width and height units.
1045   - Fixed bug with image "target" options.
1047 * docutils/parsers/rst/directives/references.py:
1049   - Added "class" attribute to "target-notes" directive, for
1050     footnote_reference classes.
1052 * docutils/parsers/rst/include/: Directory added to project; contains
1053   standard data files for the "include" directive.  Initial contents:
1054   character entity substitution definition sets, and a set of
1055   definitions for S5/HTML presentations.
1057 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1058   mappings by David Goodger.
1060 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1061   Simplified Chinese mappings by Panjunyong.
1063 * docutils/readers/__init__.py:
1065   - Added universal.Decorations and universal.ExposeInternals
1066     transforms as default transforms for all readers.
1067   - Added ``ReReader`` base class for readers that reread an existing
1068     document tree.
1070 * docutils/readers/doctree.py: Added to project; a reader for existing
1071   document trees.
1073 * docutils/transforms/frontmatter.py:
1075   - Fixed the DocInfo transform to handle SVN-style expansion of the
1076     "Date" keyword.
1077   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1078     fields uniformly.
1080 * docutils/transforms/misc.py:
1082   - Added misc.Transitions transform, extracted from
1083     universal.FinalChecks.
1085 * docutils/transforms/references.py:
1087   - Added references.DanglingReferences transform, extracted from
1088     universal.FinalChecks.
1089   - Fixed bug with doubly-indirect substitutions.
1090   - Added footnote_reference classes attribute to "TargetNotes".
1091   - Fixed bug with circular substitution definitions that put Docutils
1092     into an infinite loop.
1094 * docutils/transforms/universal.py:
1096   - Added universal.ExposeInternals transform, extracted from
1097     universal.FinalChecks.
1098   - Removed universal.FinalChecks transform (logic has been moved to
1099     several new transforms).
1100   - Fixed bug with the "expose_internals" setting and Text nodes
1101     (exposed by the "rawsource" internal attribute).
1102   - Added the universal.StripComments transform, implementation of the
1103     "strip_comments" setting.
1105 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1106   transforms for writers.
1108   - Added ``Compound`` transform, which flattens compound paragraphs.
1110 * docutils/writers/: Several writer modules (html4css1.py) were
1111   converted into packages.  Support modules and data files have been
1112   moved into the packages.  The stylesheets for the HTML writers are
1113   now installed along with the code, the code knows where to find
1114   them, and the default is to use them (actually, to embed them).
1115   Some adjustments to configuration files may be necessary.  The
1116   easiest way to obtain the new default behavior is to remove all
1117   settings whose name includes "stylesheet".
1119 * docutils/writers/__init__.py:
1121   - Added universal.Messages and universal.FilterMessages transforms
1122     as default transforms for all writers.
1123   - Added ``UnfilteredWriter`` base class for writers that pass the
1124     document tree on unchanged.
1126 * docutils/writers/docutils_xml.py:
1128   - Made ``xmlcharrefreplace`` the default output encoding error
1129     handler.
1131 * docutils/writers/html4css1/:
1133   - Added support for image width and height units.
1134   - Made ``xmlcharrefreplace`` the default output encoding error
1135     handler.
1136   - Made ``--embed-stylesheet`` the default rather than
1137     ``--link-stylesheet``.
1138   - Moved "id" attribute from container (section etc.) to title's <a>
1139     tag, to be on the same tag as "name".
1140     (!!! To be reverted in Docutils 0.5.)
1141   - Added vertical space between fields of field lists.
1142   - Added ``--compact-field-lists`` option to remove vertical space in
1143     simple field lists.
1144   - Made cloaking of email addresses with ``--cloak-email-addresses``
1145     less obtrusive.
1146   - Fixed support for centered images.
1147   - Added support for class="compact" & class="open" lists.
1149 * docutils/writers/latex2e/:
1151   - Underscores in citekeys are no longer escaped.
1153 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1154   mapping of Unicode characters to LaTeX equivalents.
1156 * docutils/writers/s5_html/: Package added to project; writer for
1157   S5/HTML slide shows.
1159 * docs/dev/distributing.txt: Added to project; guide for distributors
1160   (package maintainers).
1162 * docs/dev/hacking.txt: Added to project; guide for developers.
1164 * docs/ref/doctree.txt:
1166   - Updated for plural attributes "classes", "ids", "names",
1167     "dupnames".
1168   - Added the "container" element.
1170 * docs/ref/docutils.dtd:
1172   - Updated for plural attributes "classes", "ids", "names",
1173     "dupnames".
1175 * docs/user/emacs.txt: Added to project; a document about Emacs
1176   support for reStructuredText and Docutils.
1178 * docs/user/links.txt: Added to project; lists of Docutils-related
1179   links.
1181 * docs/user/mailing-lists.txt: Added to project; information about
1182   Docutils-related mailing lists and how to access them.
1184 * docs/user/slide-shows.txt: Added to project; example of and docs for
1185   the S5/HTML writer (``rst2s5.py`` front end).
1187 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1188   Files", added to project.
1190 * test/coverage.sh: Added to project; test coverage script.
1192 * test/DocutilsTestSupport.py:
1194   - Added support for specifying runtime settings at the suite level.
1196 * test/test_functional.py:
1198   - Added the ``clear_output_directory`` function.
1199   - Added support for ``_test_more`` functions in functional test
1200     config files.
1202 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1204 * tools/rstpep2html.py: Renamed from pep.py.
1206 * tools/dev/create_unimap.py: Added to project; script to create the
1207   docutils/writers/unimap_latex.py mapping file.
1209 * tools/dev/profile_docutils.py: Added to project; profiler script.
1211 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1213 * tools/editors/emacs/restructuredtext.el,
1214   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1215   Removed from project; the functionality is now contained in rst.el.
1217 * tools/editors/emacs/rst.el: Added to project.  Added many features
1218   and fixed many bugs.  See docs/user/emacs.txt for details.
1220 * tools/stylesheets: Removed from project.  Stylesheets have been
1221   renamed and moved into writer packages.
1224 Release 0.3.9 (2005-05-26)
1225 ==========================
1227 * General:
1229   - Eliminated and replaced all uses of the old string attributes
1230     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1231     new list attributes ``ids``, ``names``, ``dupnames`` and
1232     ``classes`` throughout the whole source tree.
1234 * docutils/core.py:
1236   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1237     allowing for easier debugging.
1238   - In ``Publisher.publish()``, expanded the generic top-level
1239     exception catching.
1241 * docutils/examples.py:
1243   - Added ``internals`` function for exploration.
1245 * docutils/io.py:
1247   - Fixed ``Input.decode`` method to apply heuristics only if no
1248     encoding is explicitly given, and to provide better reporting of
1249     decoding errors.
1250   - The ``Input.decode`` method now removes byte order marks (BOMs)
1251     from input streams.
1253 * docutils/nodes.py:
1255   - ``image`` element class changed to subclass of Element, not
1256     TextElement (it's an empty element, and cannot contain text).
1257   - Added ``attr_defaults`` dictionary for default attribute values.
1258   - Added empty list as default value for the following attributes:
1259     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1260   - Added ``document.decoration`` attribute,
1261     ``document.get_decoration`` method, and ``decoration.get_header``
1262     & ``.get_footer`` methods.
1263   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1264     methods.
1266 * docutils/utils.py:
1268   - Removed ``docutils.utils.Reporter.categories``,
1269     ``docutils.utils.ConditionSet``, and all references to them, to
1270     simplify error reporting.
1272 * docutils/languages/nl.py: Added to project; Dutch mappings by
1273   Martijn Pieters.
1275 * docutils/parsers/rst/__init__.py:
1277   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1279 * docutils/parsers/rst/states.py:
1281   - Added check for escaped at-mark to prevent email address recognition.
1282   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1283     arguments>``.
1284   - Allowed whitespace in paths and URLs.
1285   - Added auto-enumerated list items.
1286   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1287     followed by text.
1288   - Added support for table stub columns.
1290 * docutils/parsers/rst/directives/__init__.py:
1292   - Allowed whitespace in paths (``path`` function).
1293   - Added ``uri`` directive option conversion function.
1295 * docutils/parsers/rst/directives/body.py:
1297   - Fixed illegal context bug with "topic" directive (allowed within
1298     sidebars; not within body elements).
1300 * docutils/parsers/rst/directives/images.py:
1302   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1303   - Added support for the ``file_insertion_enabled`` setting in the
1304     "figure" directive (disables "figwidth" option).
1305   - "image" directive: added checks for valid values of "align" option,
1306     depending on context.  "figure" directive: added specialized
1307     "align" option and attribute on "figure" element.
1308   - Made ":figwidth: image" option of "figure" directive work again.
1309   - Fixed bug with reference names containing uppercase letters
1310     (e.g. ``Name_``) in "target" option of "image" directive.
1312 * docutils/parsers/rst/directives/misc.py:
1314   - Fixed "include" and "raw" directives to catch text decoding
1315     errors.
1316   - Allowed whitespace in "include" & "raw" directive paths.
1317   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1318     settings in "include" & "raw" directives.
1320 * docutils/parsers/rst/directives/parts.py:
1322   - Added "header" & "footer" directives.
1323   - Fixed illegal context bug with "contents" directive (topics
1324     allowed within sidebars; not within body elements).
1326 * docutils/parsers/rst/directives/tables.py:
1328   - Added "list-table" directive.
1329   - Caught empty CSV table bug.
1330   - Added support for the ``file_insertion_enabled`` setting in the
1331     "csv-table" directive.
1332   - Added ``stub-columns`` option to "csv-table" and "list-table"
1333     directives.
1335 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1336   mappings by Martijn Pieters.
1338 * docutils/readers/standalone.py:
1340   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1341     options to activate or deactivate the SectSubTitle transform.
1343 * docutils/transforms/frontmatter.py:
1345   - Added SectSubTitle transform to promote titles of lone
1346     subsections to subtitles.
1348 * docutils/transforms/references.py:
1350   - Fixed mislocated internal targets bug, by propagating internal
1351     targets to the next node, making use of the newly added support
1352     for multiple names and IDs.
1353   - Fixed duplicate footnote label bug.
1354   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1355     transform.
1357 * docutils/writers/html4css1.py:
1359   - Fixed unencoded stylesheet reference bug (characters like "&" in
1360     stylesheet references).
1361   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1362     tags).
1363   - Added support for multiple IDs per node by creating empty ``span``
1364     tags.
1365   - Added the ``field_name_limit`` & ``option_limit`` settings &
1366     support.
1367   - Added support for table stub columns.
1368   - Added support for the ``align`` attribute on ``figure`` elements.
1369   - Added the ``cloak_email_addresses`` setting & support.
1370   - Added ``html_prolog``, ``html_head``, ``html_body``,
1371     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1372     ``docutils.core.publish_parts``.
1373   - Added support for section subtitles.
1375 * docutils/writers/latex2e.py:
1377   - Fixed tables starting with more than one multirow cell.
1378   - Improved --use-latex-docinfo so that organization/contact/address
1379     fields are lumped with the last author field and appear on the
1380     titlepage.
1381   - Made sure the titlepage is always shown with --use-latex-docinfo,
1382     even if the document has no title.
1383   - Made sure that latex doesn't fill in today's date if no date field
1384     was given.
1385   - Added support for section subtitles.
1387 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1388   (under development).
1390 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1392 * docs/api/publisher.txt:
1394   - Added "``publish_parts`` Details" section.
1396 * docutils/dev/repository.txt: Added to project; information about the
1397   Docutils Subversion repository.
1399 * docs/ref/docutils.dtd:
1401   - Added a ``stub`` attribute to the ``colspec`` element via the
1402     ``tbl.colspec.att`` parameter entity.
1403   - Allowed topic elements within sidebars
1404   - Added an ``align`` attribute to the ``figure`` element.
1406 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1407   writer.
1410 Release 0.3.7 (2004-12-24)
1411 ==========================
1413 * docutils/frontend.py:
1415   - Added options: --input-encoding-error-handler,
1416     --record-dependencies, --leave-footnote-reference-space,
1417     --strict-visitor.
1418   - Added command-line and config file support for "overrides" setting
1419     parameter.
1421 * docutils/io.py:
1423   - Added support for input encoding error handler.
1425 * docutils/nodes.py:
1427   - Added dispatch_visit and dispatch_departure methods to
1428     NodeVisitor; useful as a hook for Visitors.
1429   - Changed structure of ``line_block``; added ``line``.
1430   - Added ``compound`` node class.
1431   - Added a mechanism for Visitors to transitionally ignore new node
1432     classes.
1434 * docutils/utils.py:
1436   - Moved ``escape2null`` and ``unescape`` functions from
1437     docutils/parsers/rst/states.py.
1439 * docutils/parsers/rst/roles.py:
1441   - Added "raw" role.
1442   - Changed role function API: the "text" parameter now takes
1443     null-escaped interpreted text content.
1445 * docutils/parsers/rst/states.py:
1447   - Fixed bug where a "role" directive in a nested parse would crash
1448     the parser; the state machine's "language" attribute was not being
1449     copied over.
1450   - Added support for line block syntax.
1451   - Fixed directive parsing bug: argument-less directives didn't
1452     notice that arguments were present.
1453   - Removed error checking for transitions.
1454   - Added support for multiple classifiers in definition list items.
1455   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1456   - Changed role function API: the "text" parameter now takes
1457     null-escaped interpreted text content.
1458   - Empty sections and documents are allowed now.
1460 * docutils/parsers/rst/directives/__init__.py:
1462   - Added ``encoding`` directive option conversion function.
1463   - Allow multiple class names in class_option conversion function.
1465 * docutils/parsers/rst/directives/body.py:
1467   - Converted the line-block directive to use the new structure.
1468   - Extracted the old line-block functionality to the ``block``
1469     function (still used).
1470   - Added ``compound`` directive (thanks to Lea Wiemann).
1472 * docutils/parsers/rst/directives/misc.py:
1474   - Added "encoding" option to "include" and "raw" directives.
1475   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1476   - Allow multiple class names in the "class" directive.
1478 * docutils/parsers/rst/directives/parts.py:
1480   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1481     options.  Thanks to Lele Gaifax.
1483 * docutils/parsers/rst/directives/tables.py:
1485   - Added "encoding" directive to "csv-table" directive.
1486   - Added workaround for lack of Unicode support in csv.py, for
1487     non-ASCII CSV input.
1489 * docutils/transforms/misc.py:
1491   - Fixed bug when multiple "class" directives are applied to a single
1492     element.
1493   - Enabled multiple format names for "raw" directive.
1495 * docutils/transforms/references.py:
1497   - Added support for trimming whitespace from beside substitution
1498     references.
1500 * docutils/transforms/universal.py:
1502   - FinalChecks now checks for illegal transitions and moves
1503     transitions between sections.
1505 * docutils/writers/html4css1.py:
1507   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1508   - "stylesheet" and "stylesheet_path" settings are now mutually
1509     exclusive.
1510   - Added support for the new line_block/line structure.
1511   - --footnote-references now overrides
1512     --trim-footnote-reference-space, if applicable.
1513   - Added support for ``compound`` elements.
1514   - Enabled multiple format names for "raw" directive.
1515   - ``<p>`` tags of a paragraph which is the only visible child of the
1516     document node are no longer stripped.
1517   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1518     new method ``should_be_compact_paragraph()``.
1519   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1520     elements.
1521   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1522     the output if they have their ``class`` attribute set.
1523   - The whole document is now surrounded by a ``<div
1524     class="document">`` element.
1525   - Body-level images are now wrapped by their own ``<div>`` elements,
1526     with image classes copied to the wrapper, and for images which
1527     have the ``:align:`` option set, the surrounding ``<div>`` now
1528     receives a class attribute (like ``class="align-left"``).
1530 * docutils/writers/latex2e.py:
1532   - no newline after depart_term.
1533   - Added translations for some Unicode quotes.
1534   - Added option "font-encoding", made package AE the default.
1535   - "stylesheet" and "stylesheet_path" settings are now mutually
1536     exclusive.
1537   - --footnote-references now overrides
1538     --trim-footnote-reference-space, if applicable.
1539   - The footnote label style now matches the footnote reference style
1540     ("brackets" or "superscript").
1541   - Added support for ``compound`` elements.
1542   - Enabled multiple format names for "raw" directive.
1544 * docs/ref/docutils.dtd:
1546   - Changed structure of the ``line_block`` element; added ``line``.
1547   - Added ``compound`` element.
1548   - Added "ltrim" and "rtrim" attributes to
1549     ``substitution_definition`` element.
1550   - Enabled multiple format names for ``raw`` element.
1551   - Enabled multiple classifiers in ``definition_list_item`` elements.
1553 * docs/ref/rst/directives.txt
1555   - Marked "line-block" as deprecated.
1556   - "Class" directive now allows multiple class names.
1557   - Added "Rationale for Class Attribute Value Conversion".
1558   - Added warning about "raw" overuse/abuse.
1560 * docs/ref/rst/restructuredtext.txt:
1562   - Added syntax for line blocks.
1563   - Definition list items may have multiple classifiers.
1565 * docs/ref/rst/roles.txt:
1567   - Added "raw" role.
1569 * tools/stylesheets/default.css:
1571   - Added support for the new line_block structure.
1572   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1575 Release 0.3.5 (2004-07-29)
1576 ==========================
1578 General:
1580 * _`Documentation cleanup/reorganization`.
1582   - Created new subdirectories of docs/:
1584     * ``docs/user/``: introductory/tutorial material for end-users
1585     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1586     * ``docs/api/``: API reference material for client-developers
1587     * ``docs/ref/``: reference material for all groups
1588     * ``docs/howto/``: for component-developers and core-developers
1589     * ``docs/peps/``: Python Enhancement Proposals
1591   - Moved ``docs/*`` to ``docs/user/``.
1592   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1593     ``spec/`` to ``docs/dev``.
1594   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1595     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1596   - Moved ``alternatives.txt``, and ``problems.txt`` from
1597     ``spec/rst/`` to ``docs/dev/rst/``.
1598   - Moved ``reStructuredText.txt``, ``directives.txt``,
1599     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1600     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1601     ``roles.txt``, ``reStructuredText.txt`` to
1602     ``restructuredtext.txt``.
1603   - Moved ``spec/howto/`` to ``docs/howto``.
1605   In order to keep the CVS history of moved files, we supplied
1606   SourceForge with a `script for modifying the Docutils CVS
1607   repository`__.
1609   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1611   After running the cleanup script:
1613   - Added ``docs/index.txt``.
1614   - Added a ``.htaccess`` file to the ``web`` module, containing
1615     redirects for all old paths to new paths.  They'll preserve
1616     fragments (the "#name" part of a URL), and won't clutter up the
1617     file system, and will correct the URL in the user's browser.
1618   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1619     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1620     the "To Do" list itself in ``docs/dev/todo.txt``.
1621   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1622     section of ``docs/dev/todo.txt``.
1623   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1624   - Added "How To Report Bugs" to ``BUGS.txt``.
1625   - Went through all the sources and docs (including under web/) and
1626     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1627     (Still need to update links in the sandboxes.)
1629 Specific:
1631 * BUGS.txt: Added to project.
1633 * THANKS.txt: Added to project.
1635 * docutils/__init__.py:
1637   - 0.3.4: Post-release.
1639 * docutils/core.py:
1641   - Added special error handling & advice for UnicodeEncodeError.
1642   - Refactored Publisher.publish (simplified exception handling &
1643     extracted debug dumps).
1644   - Renamed "enable_exit" parameter of convenience functions to
1645     "enable_exit_status".
1646   - Enabled traceback (exception propagation) by default in
1647     programmatic convenience functions.
1648   - Now publish_file and publish_cmdline convenience functions return
1649     the encoded string results in addition to their regular I/O.
1650   - Extracted common code from publish_file, publish_string, and
1651     publish_parts, into new publish_programmatically.  Extracted
1652     settings code to ``Publisher.process_programmatic_settings``.
1653   - In Publisher.publish, disabled ``settings_overrides`` when
1654     ``settings`` is supplied; redundant.
1656 * docutils/frontend.py:
1658   - Added help text for "--output-encoding-error-handler" and
1659     "--error-encoding-error-handler".
1660   - Renamed "--exit" to "--exit-status".
1661   - Simplified default-setting code.
1663 * docutils/parsers/rst/__init__.py:
1665   - Added "--pep-base-url" and "--rfc-base-url" options.
1667 * docutils/parsers/rst/states.py:
1669   - Made URI recognition more aggressive and intelligent.
1671 * docutils/parsers/rst/directives/__init__.py:
1673   - Added several directive option conversion functions.
1675 * docutils/parsers/rst/directives/body.py:
1677   - Moved "table" directive to tables.py.
1679 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1680   added to project.
1682 * docutils/writers/latex2e.py:
1684   - Added "--table-style=(standard|booktabs|nolines)"
1685   - figures get "here" option (LaTeX per default puts them at bottom),
1686     and figure content is centered.
1687   - Rowspan support for tables.
1688   - Fix: admonition titles before first section.
1689   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1690   - Replave ``_`` in literal by an underlined blank, because it has the correct
1691     width.
1692   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1693   - A few unicode replacements, if output_encoding != utf
1694   - Add "--graphicx-option".
1695   - Indent literal-blocks.
1696   - Fix: omit ``\maketitle`` when there is no document title.
1698 * docs/index.txt: "Docutils Project Documentation Overview", added to
1699   project.
1701 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1702   Tool", added to project.
1704 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1706 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1708 * docs/dev/policies.txt: Added to project (extracted from
1709   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1711 * docs/dev/release.txt: Added to project (extracted from
1712   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1714 * docs/dev/testing.txt: Added to project.
1716 * docs/dev/website.txt: Added to project (extracted from
1717   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1719 * docs/ref/rst/directives.txt:
1721   - Added directives: "table", "csv-table".
1723 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1724   added to project.  1 page for syntax, and a 1 page reference for
1725   directives and roles.  Source text to be used as-is; not meant to be
1726   converted to HTML.
1728 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1729   with a change of title.
1731 * test/functional/, contents, and test/test_functional.py: Added to
1732   project.
1734 * tools/buildhtml.py: Fixed bug with config file handling.
1736 * tools/html.py: Removed from project (duplicate of rst2html.py).
1738 * tools/pep2html.py: Removed from project (duplicate of Python's
1739   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1740   Docutils-related PEPs in docs/peps/).
1742 * tools/rst2pseudoxml.py: Renamed from publish.py.
1744 * tools/rst2xml.py: Renamed from docutils-xml.py.
1746 * tools/test.txt: Removed from project; moved to
1747   docs/user/rst/demo.txt.
1749 * setup.py: Now also installs ``rst2latex.py``.
1752 Release 0.3.3 (2004-05-09)
1753 ==========================
1755 * docutils/__init__.py:
1757   - 0.3.1: Reorganized config file format (multiple sections); see
1758     docs/config.txt.
1759   - Added unknown_reference_resolvers attribute to TransformSpec.
1760   - 0.3.2: Interpreted text reorganization.
1761   - 0.3.3: Released.
1763 * docutils/core.py:
1765   - Catch system messages to stop tracebacks from parsing errors.
1766   - Catch exceptions during processing report & exit without
1767     tracebacks, except when "--traceback" used.
1768   - Reordered components for OptionParser; application comes last.
1769   - Added "config_section" parameter to several methods and functions,
1770     allowing front ends to easily specify their config file sections.
1771   - Added publish_parts convenience function to allow access to individual
1772     parts of a document.
1774 * docutils/examples.py: Added to project; practical examples of
1775   Docutils client code, to be used as-is or as models for variations.
1777 * docutils/frontend.py:
1779   - Added "--traceback" & "--no-traceback" options ("traceback"
1780     setting).
1781   - Implemented support for config file reorganization:
1782     ``standard_config_files`` moved from ``ConfigParser`` to
1783     ``OptionParser``; added
1784     ``OptionParser.get_config_file_settings()`` and
1785     ``.get_standard_config_settings()``; support for old "[options]"
1786     section (with deprecation warning) and mapping from old to new
1787     settings.
1788   - Reimplemented setting validation.
1789   - Enabled flexible boolean values: yes/no, true/false, on/off.
1790   - Added ``Values``, a subclass of ``optparse.Values``, with support
1791     for list setting attributes.
1792   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1793     thanks to Beni Cherniavsky.
1794   - Added "--no-section-numbering" option.
1796 * docutils/io.py:
1798   - Catch IOErrors when opening source & destination files, report &
1799     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1800     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1802 * docutils/nodes.py:
1804   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1805     method definitions (via ``exec``) to dynamic assignments (via
1806     ``setattr``); thanks to Roman Suzi.
1807   - Encapsulated visitor dynamic assignments in a function; thanks to
1808     Ian Bicking.
1809   - Added indirect_reference_name attribute to the Targetable
1810     class. This attribute holds the whitespace_normalized_name
1811     (contains mixed case) of a target.
1813 * docutils/statemachine.py:
1815   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1816   - Added ``StringList.get_2D_block``.
1818 * docutils/utils.py:
1820   - Added "level" attribute to SystemMessage exceptions.
1822 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1823   Jannie Hofmeyr.
1825 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1826   Blaha.
1828 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1829   Marcelo Huerta San Martin.
1831 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1832   mappings by Lalo Martins.
1834 * docutils/languages/ru.py: Added to project; Russian mappings by
1835   Roman Suzi.
1837 * docutils/parsers/rst/roles.py: Added to project.  Contains
1838   interpreted text role functions, a registry for interpreted text
1839   roles, and an API for adding to and retrieving from the registry.
1840   Contributed by Edward Loper.
1842 * docutils/parsers/rst/states.py:
1844   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1845   - Allowed true em-dash character and "---" as block quote
1846     attribution marker.
1847   - Added support for <angle-bracketed> complex option arguments
1848     (option lists).
1849   - Fixed handling of backslashes in substitution definitions.
1850   - Fixed off-by-1 error with extra whitespace after substitution
1851     definition directive.
1852   - Added inline markup parsing to field lists' field names.
1853   - Added support for quoted (and unindented) literal blocks.
1854     Driven in part by a bribe from Frank Siebenlist (thanks!).
1855   - Parser now handles escapes in URIs correctly.
1856   - Made embedded-URIs' reference text omittable.  Idea from Beni
1857     Cherniavsky.
1858   - Refactored explicit target processing code.
1859   - Added name attribute to references containing the reference name only
1860     through whitespace_normalize_name (no case changes).
1861   - parse_target no longer returns the refname after going through
1862     normalize_name. This is now handled in make_target.
1863   - Fixed bug relating to role-less interpreted text in non-English
1864     contexts.
1865   - Reorganized interpreted text processing; moved code into the new
1866     roles.py module.  Contributed by Edward Loper.
1867   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1868     ``parse_directive_block``.
1870 * docutils/parsers/rst/tableparser.py:
1872   - Reworked for ``StringList``, to support "include" directives in
1873     table cells.
1875 * docutils/parsers/rst/directives/__init__.py:
1877   - Renamed ``unchanged()`` directive option conversion function to
1878     ``unchanged_required``, and added a new ``unchanged``.
1879   - Catch unicode value too high error; fixes bug 781766.
1880   - Beefed up directive error reporting.
1882 * docutils/parsers/rst/directives/body.py:
1884   - Added basic "table" directive.
1886 * docutils/parsers/rst/directives/images.py:
1888   - Added "target" option to "image" directive.
1889   - Added name attribute to references containing the reference name only
1890     through whitespace_normalize_name (no case changes).
1892 * docutils/parsers/rst/directives/misc.py:
1894   - Isolated the import of the ``urllib2`` module; was causing
1895     problems on SourceForge (``libssl.so.2`` unavailable?).
1896   - Added the "role" directive for declaring custom interpreted text
1897     roles.
1899 * docutils/parsers/rst/directives/parts.py:
1901   - The "contents" directive does more work up-front, creating the
1902     "topic" and "title", and leaving the "pending" node for the
1903     transform.  Allows earlier reference resolution; fixes subtle bug.
1905 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1906   mappings by Jannie Hofmeyr.
1908 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1909   mappings by Marek Blaha.
1911 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1912   mappings by Marcelo Huerta San Martin.
1914 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1915   Portuguese mappings by Lalo Martins.
1917 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1918   mappings by Roman Suzi.
1920 * docutils/transforms/parts.py:
1922   - The "contents" directive does more work up-front, creating the
1923     "topic" and "title", and leaving the "pending" node for the
1924     transform.  Allows earlier reference resolution; fixes subtle bug.
1925   - Added support for disabling of section numbering.
1927 * docutils/transforms/references.py:
1929   - Verifying that external targets are truly targets and not indirect
1930     references. This is because we are now adding a "name" attribute to
1931     references in addition to targets. Note sure if this is correct!
1932   - Added code to hook into the unknown_reference_resolvers list for a
1933     transformer in resolve_indirect_target. This allows the
1934     unknown_reference_resolvers to keep around indirect targets which
1935     docutils doesn't know about.
1936   - Added specific error message for duplicate targets.
1938 * docutils/transforms/universal.py:
1940   - Added FilterMessages transform (removes system messages below the
1941     verbosity threshold).
1942   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1943     to FinalCheckVisitor for application-specific handling of
1944     unresolvable references.
1945   - Added specific error message for duplicate targets.
1947 * docutils/writers/__init__.py:
1949   - Added assemble_parts method to the Writer class to allow for
1950     access to a documents individual parts.
1951   - Documented & set default for ``Writer.output`` attribute.
1953 * docutils/writers/html4css1.py:
1955   - Fixed unicode handling of attribute values (bug 760673).
1956   - Prevent duplication of "class" attribute values (bug report from
1957     Kirill Lapshin).
1958   - Improved table grid/border handling (prompted by report from Bob
1959     Marshall).
1960   - Added support for table titles.
1961   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1962     to Darek Suchojad.
1963   - Added functionality to keep track of individual parts of a document
1964     and store them in a dictionary as the "parts" attribute of the writer.
1965     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1966   - Added proper support for the "scale" attribute of the "image"
1967     element.  Contributed by Brent Cook.
1968   - Added ``--initial-header-level`` option.
1969   - Fixed bug: the body_pre_docinfo segment depended on there being a
1970     docinfo; if no docinfo, the document title was incorporated into
1971     the body segment.  Adversely affected the publish_parts interface.
1973 * docutils/writers/latex2e.py:
1975   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1976     about a missing file.
1977   - Added options and support: ``--compound-enumerators``,
1978     ``--section-prefix-for-enumerators``, and
1979     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1980     934322).
1981   - Added option ``--use-verbatim-when-possible``, to avoid
1982     problematic characters (eg, '~' in italian) in literal blocks.
1983   - It's now possible to use four section levels in the `book` and
1984     `report` LaTeX classes.  The default `article` class still has
1985     three levels limit.
1987 * docs/config.txt: "Docutils Configuration Files", added to project.
1988   Moved config file entry descriptions from tools.txt.
1990 * docs/tools.txt:
1992   - Moved config file entry descriptions to config.txt.
1994 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1995   Development".
1997 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1998   Text Roles", added to project.
2000 * spec/rst/reStructuredText.txt:
2002   - Added description of support for <angle-bracketed> complex option
2003     arguments to option lists.
2004   - Added subsections for indented and quoted literal blocks.
2006 * test: Continually adding & updating tests.
2008   - Added test/test_settings.py & test/data/config_*.txt support
2009     files.
2010   - Added test/test_writers/test_htmlfragment.py.
2012 * test/DocutilsTestSupport.py:
2014   - Refactored LaTeX publisher test suite/case class names to make
2015     testing other writers easier.
2016   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2017     to test the processing of HTML fragments which use the new
2018     publish_parts convenience function.
2020 * tools/buildhtml.py:
2022   - Added support for the "--prune" option.
2023   - Removed dependency on pep2html.py; plaintext PEPs no longer
2024     supported.
2026 * tools/docutils.conf:
2028   - Updated for configuration file reorganization.
2030 * tools/rst2html.py:
2032   - copied from tools/html.py
2034 * setup.py:
2036   - added a 'scripts' section to configuration
2037   - added 'tools/rst2html.py' to the scripts section
2040 Release 0.3 (2003-06-24)
2041 ========================
2043 General:
2045 * Renamed "attribute" to "option" for directives/extensions.
2047 * Renamed transform method "transform" to "apply".
2049 * Renamed "options" to "settings" for runtime settings (as set by
2050   command-line options).  Sometimes "option" (singular) became
2051   "settings" (plural).  Some variations below:
2053   - document.options -> document.settings (stored in other objects as
2054     well)
2055   - option_spec -> settings_spec (not directives though)
2056   - OptionSpec -> SettingsSpec
2057   - cmdline_options -> settings_spec
2058   - relative_path_options -> relative_path_settings
2059   - option_default_overrides -> settings_default_overrides
2060   - Publisher.set_options -> Publisher.get_settings
2062 Specific:
2064 * COPYING.txt: Added "Public Domain Dedication".
2066 * FAQ.txt: Frequently asked questions, added to project.
2068 * setup.py:
2070   - Updated with PyPI Trove classifiers.
2071   - Conditional installation of third-party modules.
2073 * docutils/__init__.py:
2075   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2076   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2077   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2078   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2079     option and its effect on the PEP template & writer.
2080   - Bumped version to 0.2.4 due to changes to the PEP template &
2081     stylesheet.
2082   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2083   - Added ``TransformSpec`` class for new transform system.
2084   - Bumped version to 0.2.6 for API changes (renaming).
2085   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2086     convenience functions.
2087   - Added ``Component.component_type`` attribute.
2088   - Bumped version to 0.2.8 because of the internal parser switch from
2089     plain lists to the docutils.statemachine.StringList objects.
2090   - Bumped version to 0.2.9 because of the frontend.py API changes.
2091   - Bumped version to 0.2.10 due to changes to the project layout
2092     (third-party modules removed from the "docutils" package), and
2093     signature changes in ``io.Input``/``io.Output``.
2094   - Changed version to 0.3.0 for release.
2096 * docutils/core.py:
2098   - Made ``publish()`` a bit more convenient.
2099   - Generalized ``Publisher.set_io``.
2100   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2101     parameters; improved its docstring.
2102   - Added ``publish_file()`` and ``publish_string()``.
2103   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2104     out of ``.set_io``.
2105   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2106     "--dump-transforms" hidden options.
2107   - Added ``Publisher.apply_transforms()`` method.
2108   - Added ``Publisher.set_components()`` method; support for
2109     ``publish_*()`` conveninece functions.
2110   - Moved config file processing to docutils/frontend.py.
2111   - Added support for exit status ("exit_level" setting &
2112     ``enable_exit`` parameter for Publisher.publish() and convenience
2113     functions).
2115 * docutils/frontend.py:
2117   - Check for & exit on identical source & destination paths.
2118   - Fixed bug with absolute paths & "--config".
2119   - Set non-command-line defaults in ``OptionParser.__init__()``:
2120     ``_source`` & ``_destination``.
2121   - Distributed ``relative_path_settings`` to components; updated
2122     ``OptionParser.populate_from_components()`` to combine it all.
2123   - Require list of keys in ``make_paths_absolute`` (was implicit in
2124     global ``relative_path_settings``).
2125   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2126     "--dump-settings", and "--dump-transforms" hidden options.
2127   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2128     code, replaced with correct code.
2129   - Added validation functionality for config files.
2130   - Added "--error-encoding" option/setting, "_disable_config"
2131     internal setting.
2132   - Added encoding validation; updated "--input-encoding" and
2133     "--output-encoding"; added "--error-encoding-error-handler" and
2134     "--output-encoding-error-handler".
2135   - Moved config file processing from docutils/core.py.
2136   - Updated ``OptionParser.populate_from_components`` to handle new
2137     ``SettingsSpec.settings_defaults`` dict.
2138   - Added support for "-" => stdin/stdout.
2139   - Added "exit_level" setting ("--exit" option).
2141 * docutils/io.py:
2143   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2144   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2145   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2146   - ``FileOutput.write()`` now returns the encoded output string.
2147   - Try to get path/stream name automatically in ``FileInput`` &
2148     ``FileOutput``.
2149   - Added defaults for source & destination paths.
2150   - Allow for Unicode I/O with an explicit "unicode" encoding.
2151   - Added ``Output.encode()``.
2152   - Removed dependency on runtime settings; pass encoding directly.
2153   - Recognize Unicode strings in ``Input.decode()``.
2154   - Added support for output encoding error handlers.
2156 * docutils/nodes.py:
2158   - Added "Invisible" element category class.
2159   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2160     modification during a traversal.
2161   - Added element classes: ``line_block``, ``generated``, ``address``,
2162     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2163     ``superscript``, ``subscript``, ``inline``
2164   - Added support for lists of nodes to ``Element.insert()``.
2165   - Fixed parent linking in ``Element.replace()``.
2166   - Added new abstract superclass ``FixedTextElement``; adds
2167     "xml:space" attribute.
2168   - Added support for "line" attribute of ``system_message`` nodes.
2169   - Added support for the observer pattern from ``utils.Reporter``.
2170     Added ``parse_messages`` and ``transform_messages`` attributes to
2171     ``document``, removed ``messages``.  Added ``note_parse_message``
2172     and ``note_transform_message`` methods.
2173   - Added support for improved diagnostics:
2175     - Added "document", "source", and "line" internal attributes to
2176       ``Node``, set by ``Node.setup_child()``.
2177     - Converted variations on ``node.parent = self`` to
2178       ``self.setup_child(node)``.
2179     - Added ``document.current_source`` & ``.current_line``
2180       attributes, and ``.note_source`` observer method.
2181     - Changed "system_message" output to GNU-Tools format.
2183   - Added a "rawsource" attribute to the ``Text`` class, for text
2184     before backslash-escape resolution.
2185   - Support for new transform system.
2186   - Reworked ``pending`` element.
2187   - Fixed XML DOM bug (SF #660611).
2188   - Removed the ``interpeted`` element class and added
2189     ``title_reference``, ``abbreviation``, ``acronym``.
2190   - Made substitutions case-sensitive-but-forgiving; moved some code
2191     from the parser.
2192   - Fixed Unicode bug on element attributes (report: William Dode).
2194 * docutils/optik.py: Removed from project; replaced with
2195   extras/optparse.py and extras/textwrap.py.  These will be installed
2196   only if they're not already present in the Python installation.
2198 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2199   only if it's not already present in the Python installation.
2201 * docutils/statemachine.py:
2203   - Factored out ``State.add_initial_transitions()`` so it can be
2204     extended.
2205   - Converted whitespace-specific "blank" and "indent" transitions
2206     from special-case code to ordinary transitions: removed
2207     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2208     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2209     ``ws_initial_transitions`` attributes.
2210   - Removed ``State.match_transition()`` after merging it into
2211     ``.check_line()``.
2212   - Added ``StateCorrection`` exception.
2213   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2214     (moved ``TransitionCorrection`` support there too.)
2215   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2216     ``EOFError`` instead of ``IndexError``.
2217   - Added ``State.no_match`` method.
2218   - Added support for the Observer pattern, triggered by input line
2219     changes.
2220   - Added ``strip_top`` parameter to
2221     ``StateMachineWS.get_first_known_indented``.
2222   - Made ``context`` a parameter to ``StateMachine.run()``.
2223   - Added ``ViewList`` & ``StringList`` classes;
2224     ``extract_indented()`` becomes ``StringList.get_indented()``.
2225   - Added ``StateMachine.insert_input()``.
2226   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2227     thanks to) Fred Drake.
2229 * docutils/utils.py:
2231   - Added a ``source`` attribute to Reporter instances and
2232     ``system_message`` elements.
2233   - Added an observer pattern to ``utils.Reporter`` to keep track of
2234     system messages.
2235   - Fixed bugs in ``relative_path()``.
2236   - Added support for improved diagnostics.
2237   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2238   - Added support for encoding Reporter stderr output, and encoding
2239     error handlers.
2240   - Reporter keeps track of the highest level system message yet
2241     generated.
2243 * docutils/languages: Fixed bibliographic field language lookups.
2245 * docutils/languages/es.py: Added to project; Spanish mappings by
2246   Marcelo Huerta San Martin.
2248 * docutils/languages/fr.py: Added to project; French mappings by
2249   Stefane Fermigier.
2251 * docutils/languages/it.py: Added to project; Italian mappings by
2252   Nicola Larosa.
2254 * docutils/languages/sk.py: Added to project; Slovak mappings by
2255   Miroslav Vasko.
2257 * docutils/parser/__init__.py:
2259   - Added ``Parser.finish_parse()`` method.
2261 * docutils/parser/rst/__init__.py:
2263   - Added options: "--pep-references", "--rfc-references",
2264     "--tab-width", "--trim-footnote-reference-space".
2266 * docutils/parsers/rst/states.py:
2268   - Changed "title under/overline too short" system messages from INFO
2269     to WARNING, and fixed its insertion location.
2270   - Fixed enumerated list item parsing to allow paragraphs & section
2271     titles to begin with enumerators.
2272   - Converted system messages to use the new "line" attribute.
2273   - Fixed a substitution reference edge case.
2274   - Added support for "--pep-references" and "--rfc-references"
2275     options; reworked ``Inliner`` code to make customization easier.
2276   - Removed field argument parsing.
2277   - Added support for short section title over/underlines.
2278   - Fixed "simple reference name" regexp to ignore text like
2279     "object.__method__"; not an anonymous reference.
2280   - Added support for improved diagnostics.
2281   - Reworked directive API, based on Dethe Elza's contribution.  Added
2282     ``Body.parse_directive()``, ``.parse_directive_options()``,
2283     ``.parse_directive_arguments()`` methods.
2284   - Added ``ExtensionOptions`` class, to parse directive options
2285     without parsing field bodies.  Factored
2286     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2287     ``ExtensionOptions``.
2288   - Improved definition list term/classifier parsing.
2289   - Added warnings for unknown directives.
2290   - Renamed ``Stuff`` to ``Struct``.
2291   - Now flagged as errors: transitions at the beginning or end of
2292     sections, empty sections (except title), and empty documents.
2293   - Updated for ``statemachine.StringList``.
2294   - Enabled recognition of schemeless email addresses in targets.
2295   - Added support for embedded URIs in hyperlink references.
2296   - Added backslash-escapes to inline markup end-string suffix.
2297   - Added support for correct interpreted text processing.
2298   - Fixed nested title parsing (topic, sidebar directives).
2299   - Added special processing of backslash-escaped whitespace (idea
2300     from David Abrahams).
2301   - Made substitutions case-sensitive-but-forgiving; moved some code
2302     to ``docutils.nodes``.
2303   - Added support for block quote attributions.
2304   - Added a kludge to work-around a conflict between the bubble-up
2305     parser strategy and short titles (<= 3 char-long over- &
2306     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2307     titles" submitted by Jason Diamond.
2308   - Added explicit interpreted text roles for standard inline markup:
2309     "emphasis", "strong", "literal".
2310   - Implemented "superscript" and "subscript" interpreted text roles.
2311   - Added initial support for "abbreviation" and "acronym" roles;
2312     incomplete.
2313   - Added support for "--trim-footnote-reference-space" option.
2314   - Optional space before colons in directives & hyperlink targets.
2316 * docutils/parsers/rst/tableparser.py:
2318   - Fixed a bug that was producing unwanted empty rows in "simple"
2319     tables.
2320   - Detect bad column spans in "simple" tables.
2322 * docutils/parsers/rst/directives: Updated all directive functions to
2323   new API.
2325 * docutils/parsers/rst/directives/__init__.py:
2327   - Added ``flag()``, ``unchanged()``, ``path()``,
2328     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2329     directive option helper functions.
2330   - Added warnings for unknown directives.
2331   - Return ``None`` for missing directives.
2332   - Added ``register_directive()``, thanks to William Dode and Paul
2333     Moore.
2335 * docutils/parsers/rst/directives/admonitions.py:
2337   - Added "admonition" directive.
2339 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2340   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2341   "parsed-literal", "rubric", "epigraph", "highlights" and
2342   "pull-quote" directives.
2344 * docutils/parsers/rst/directives/images.py:
2346   - Added an "align" attribute to the "image" & "figure" directives
2347     (by Adam Chodorowski).
2348   - Added "class" option to "image", and "figclass" to "figure".
2350 * docutils/parsers/rst/directives/misc.py:
2352   - Added "include", "raw", and "replace" directives, courtesy of
2353     Dethe Elza.
2354   - Added "unicode" and "class" directives.
2356 * docutils/parsers/rst/directives/parts.py:
2358   - Added the "sectnum" directive; by Dmitry Jemerov.
2359   - Added "class" option to "contents" directive.
2361 * docutils/parsers/rst/directives/references.py: Added to project.
2362   Contains the "target-notes" directive.
2364 * docutils/parsers/rst/languages/__init__.py:
2366   - Return ``None`` from get_language() for missing language modules.
2368 * docutils/parsers/rst/languages/de.py: Added to project; German
2369   mappings by Engelbert Gruber.
2371 * docutils/parsers/rst/languages/en.py:
2373   - Added interpreted text roles mapping.
2375 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2376   mappings by Marcelo Huerta San Martin.
2378 * docutils/parsers/rst/languages/fr.py: Added to project; French
2379   mappings by William Dode.
2381 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2382   mappings by Nicola Larosa.
2384 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2385   mappings by Miroslav Vasko.
2387 * docutils/readers/__init__.py:
2389   - Added support for the observer pattern from ``utils.Reporter``, in
2390     ``Reader.parse`` and ``Reader.transform``.
2391   - Removed ``Reader.transform()`` method.
2392   - Added default parameter values to ``Reader.__init__()`` to make
2393     instantiation easier.
2394   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2396 * docutils/readers/pep.py:
2398   - Added the ``peps.TargetNotes`` transform to the Reader.
2399   - Removed PEP & RFC reference detection code; moved to
2400     parsers/rst/states.py as options (enabled here by default).
2401   - Added support for pre-acceptance PEPs (no PEP number yet).
2402   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2403     easy subclassing.
2405 * docutils/readers/python: Python Source Reader subpackage added to
2406   project, including preliminary versions of:
2408   - __init__.py
2409   - moduleparser.py: Parser for Python modules.
2411 * docutils/transforms/__init__.py:
2413   - Added ``Transformer`` class and completed transform reform.
2414   - Added unknown_reference_resolvers list for each transformer. This list holds
2415     the list of functions provided by each component of the transformer that
2416     help resolve references.
2418 * docutils/transforms/frontmatter.py:
2420   - Improved support for generic fields.
2421   - Fixed bibliographic field language lookups.
2423 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2424   transforms.
2426 * docutils/transforms/parts.py:
2428   - Moved the "id" attribute from TOC list items to the references
2429     (``Contents.build_contents()``).
2430   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2431   - Added "class" attribute support to ``Contents``.
2433 * docutils/transforms/peps.py:
2435   - Added ``mask_email()`` function, updating to pep2html.py's
2436     functionality.
2437   - Linked "Content-Type: text/x-rst" to PEP 12.
2438   - Added the ``TargetNotes`` PEP-specific transform.
2439   - Added ``TargetNotes.cleanup_callback``.
2440   - Added title check to ``Headers``.
2442 * docutils/transforms/references.py:
2444   - Added the ``TargetNotes`` generic transform.
2445   - Split ``Hyperlinks`` into multiple transforms.
2446   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2447   - Added check for circular indirect references.
2448   - Made substitutions case-sensitive-but-forgiving.
2450 * docutils/transforms/universal.py:
2452   - Added support for the "--expose-internal-attributes" option.
2453   - Removed ``Pending`` transform classes & data.
2455 * docutils/writers/__init__.py:
2457   - Removed ``Writer.transform()`` method.
2459 * docutils/writers/docutils-xml.py:
2461   - Added XML and doctype declarations.
2462   - Added "--no-doctype" and "--no-xml-declaration" options.
2464 * docutils/writers/html4css1.py:
2466   - "name" attributes only on these tags: a, applet, form, frame,
2467     iframe, img, map.
2468   - Added "name" attribute to <a> in section titles for Netscape 4
2469     support (bug report: Pearu Peterson).
2470   - Fixed targets (names) on footnote, citation, topic title,
2471     problematic, and system_message nodes (for Netscape 4).
2472   - Changed field names from "<td>" to "<th>".
2473   - Added "@" to "&#64;" encoding to thwart address harvesters.
2474   - Improved the vertical whitespace optimization; ignore "invisible"
2475     nodes (targets, comments, etc.).
2476   - Improved inline literals with ``<span class="pre">`` around chunks
2477     of text and ``&nbsp;`` for runs of spaces.
2478   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2479     ``self.docinfo`` segments.
2480   - Added support for "line_block", "address" elements.
2481   - Improved backlinks (footnotes & system_messages).
2482   - Improved system_message output.
2483   - Redefined "--stylesheet" as containing an invariant URL, used
2484     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2485     working directory.
2486   - Added "--footnote-references" option (superscript or brackets).
2487   - Added "--compact-lists" and "--no-compact-lists" options.
2488   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2489     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2490   - Improved field list rendering.
2491   - Added Docutils version to "generator" meta tag.
2492   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2493   - Improved layout of <pre> HTML source.
2494   - Fixed attribute typo on <colspec>.
2495   - Refined XML prologue.
2496   - Support for no stylesheet.
2497   - Removed "interpreted" element support.
2498   - Added support for "title_reference", "sidebar", "attribution",
2499     "rubric", and generic "admonition" elements.
2500   - Added "--attribution" option.
2501   - Added support for "inline", "subscript", "superscript" elements.
2502   - Added initial support for "abbreviation" and "acronym";
2503     incomplete.
2505 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2506   (from the sandbox).
2508   - Added french.
2509   - Double quotes in literal blocks (special treatment for de/ngerman).
2510   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2511   - Added  "--attribution" option.
2512   - Right align attributions.
2514 * docutils/writers/pep_html.py:
2516   - Parameterized output encoding in PEP template.
2517   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2518   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2519     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2520     working directory.
2521   - Added an override on the "--footnote-references" option.
2522   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2523   - Added Docutils version to "generator" meta tag.
2524   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2526 * docs/tools.txt:
2528   - Added a "silent" setting for ``buildhtml.py``.
2529   - Added a "Getting Help" section.
2530   - Rearranged the structure.
2531   - Kept up to date, with new settings, command-line options etc.
2532   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2533   - Converted settings table into a definition list.
2535 * docs/rst/quickstart.txt:
2537   - Added a table of contents.
2538   - Added feedback information.
2539   - Added mention of minimum section title underline lengths.
2540   - Removed the 4-character minimum for section title underlines.
2542 * docs/rst/quickref.html:
2544   - Added a "Getting Help" section.
2545   - Added a style to make section title backlinks more subtle.
2546   - Added mention of minimum section title underline lengths.
2547   - Removed the 4-character minimum for section title underlines.
2549 * extras: Directory added to project; contains third-party modules
2550   that Docutils depends on (optparse, textwrap, roman).  These are
2551   only installed if they're not already present.
2553 * licenses: Directory added to project; contains copies of license
2554   files for non-public-domain files.
2556 * spec/doctree.txt:
2558   - Changed the focus.  It's about DTD elements:  structural
2559     relationships, semantics, and external (public) attributes.  Not
2560     about the element class library.
2561   - Moved some implementation-specific stuff into ``docutils.nodes``
2562     docstrings.
2563   - Wrote descriptions of all common attributes and parameter
2564     entities.  Filled in introductory material.
2565   - Working through the element descriptions: 55 down, 37 to go.
2566   - Removed "Representation of Horizontal Rules" to
2567     spec/rst/alternatives.txt.
2569 * spec/docutils.dtd:
2571   - Added "generated" inline element.
2572   - Added "line_block" body element.
2573   - Added "auto" attribute to "title".
2574   - Changed content models of "literal_block" and "doctest_block" to
2575     ``%text.model``.
2576   - Added ``%number;`` attribute type parameter entity.
2577   - Changed ``%structural.elements;`` to ``%section.elements``.
2578   - Updated attribute types; made more specific.
2579   - Added "address" bibliographic element.
2580   - Added "line" attribute to ``system_message`` element.
2581   - Removed "field_argument" element; "field_name" may contain
2582     multiple words and whitespace.
2583   - Changed public identifier to docutils.sf.net.
2584   - Removed "interpreted" element; added "title_reference",
2585     "abbreviation", "acronym".
2586   - Removed "refuri" attribute from "footnote_reference" and
2587     "citation_reference".
2588   - Added "sidebar", "rubric", "attribution", "admonition",
2589     "superscript", "subscript", and "inline" elements.
2591 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2593 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2595 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2597 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2598   Dallas Mahrt.
2600 * spec/transforms.txt: Added to project.
2602 * spec/howto: Added subdirectory, for developer how-to docs.
2604 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2605   Elza, edited & extended by David Goodger.
2607 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2608   project.
2610 * spec/rst/alternatives.txt:
2612   - Added "Doctree Representation of Transitions" from
2613     spec/doctree.txt.
2614   - Updated "Inline External Targets" & closed the debate.
2615   - Added ideas for interpreted text syntax extensions.
2616   - Added "Nested Inline Markup" section.
2618 * spec/rst/directives.txt:
2620   - Added directives: "topic", "sectnum", "target-notes",
2621     "line-block", "parsed-literal", "include", "replace", "sidebar",
2622     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2623     "class".
2624   - Formalized descriptions of directive details.
2625   - Added an "align" attribute to the "image" & "figure" directives
2626     (by Adam Chodorowski).
2627   - Added "class" options to "topic", "sidebar", "line-block",
2628     "parsed-literal", "contents", and "image"; and "figclass" to
2629     "figure".
2631 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2632   interpreted text roles.
2634 * spec/rst/introduction.txt:
2636   - Added pointers to material for new users.
2638 * spec/rst/reStructuredText.txt:
2640   - Disambiguated comments (just add a newline after the "::").
2641   - Updated enumerated list description; added a discussion of the
2642     second-line validity checking.
2643   - Updated directive description.
2644   - Added a note redirecting newbies to the user docs.
2645   - Expanded description of inline markup start-strings in non-markup
2646     contexts.
2647   - Removed field arguments and made field lists a generic construct.
2648   - Removed the 4-character minimum for section title underlines.
2649   - Clarified term/classifier delimiter & inline markup ambiguity
2650     (definition lists).
2651   - Added "Embedded URIs".
2652   - Updated "Interpreted Text" section.
2653   - Added "Character-Level Inline Markup" section.
2655 * test: Continually adding & updating tests.
2657   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2658   - Moved test/test_pep/ to test/test_readers/test_pep/.
2659   - Added test/test_readers/test_python/.
2660   - Added test/test_writers/ (Engelbert Gruber).
2662 * tools:
2664   - Made the ``locale.setlocale()`` calls in front ends
2665     fault-tolerant.
2667 * tools/buildhtml.py:
2669   - Added "--silent" option.
2670   - Fixed bug with absolute paths & "--config".
2671   - Updated for new I/O classes.
2672   - Added some exception handling.
2673   - Separated publishers' setting defaults; prevents interference.
2674   - Updated for new ``publish_file()`` convenience function.
2676 * tools/pep-html-template:
2678   - Allow for "--embed-stylesheet".
2679   - Added Docutils version to "generator" meta tag.
2680   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2681   - Conform to XHTML spec.
2683 * tools/pep2html.py:
2685   - Made ``argv`` a parameter to ``main()``.
2686   - Added support for "Content-Type:" header & arbitrary PEP formats.
2687   - Linked "Content-Type: text/plain" to PEP 9.
2688   - Files skipped (due to an error) are not pushed onto the server.
2689   - Updated for new I/O classes.
2690   - Added ``check_requirements()`` & ``pep_type_error()``.
2691   - Added some exception handling.
2692   - Updated for new ``publish_string()`` convenience function.
2693   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2695 * tools/quicktest.py:
2697   - Added "-V"/"--version" option.
2699 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2701 * tools/unicode2rstsubs.py: Added to project.  Produces character
2702   entity files (reSructuredText substitutions) from the MathML master
2703   unicode.xml file.
2705 * tools/editors: Support code for editors, added to project.  Contains
2706   ``emacs/restructuredtext.el``.
2708 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2710   - Added style for chunks of inline literals.
2711   - Removed margin for first child of table cells.
2712   - Right-aligned field list names.
2713   - Support for auto-numbered section titles in TOCs.
2714   - Increased the size of inline literals (<tt>) in titles.
2715   - Restored the light gray background for inline literals.
2716   - Added support for "line_block" elements.
2717   - Added style for "address" elements.
2718   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2719   - Improved field list rendering.
2720   - Vertical whitespace improvements.
2721   - Removed "a.target" style.
2723 * tools/stylesheets/pep.css:
2725   - Fixed nested section margins.
2726   - Other changes parallel those of ``../default.css``.
2729 Release 0.2 (2002-07-31)
2730 ========================
2732 General:
2734 - The word "component" was being used ambiguously.  From now on,
2735   "component" will be used to mean "Docutils component", as in Reader,
2736   Writer, Parser, or Transform.  Portions of documents (Table of
2737   Contents, sections, etc.)  will be called "document parts".
2738 - Did a grand renaming: a lot of ``verylongnames`` became
2739   ``very_long_names``.
2740 - Cleaned up imports: no more relative package imports or
2741   comma-separated lists of top-level modules.
2742 - Added support for an option values object which carries default
2743   settings and overrides (from command-line options and library use).
2744 - Added internal Unicode support, and support for both input and
2745   output encodings.
2746 - Added support for the ``docutils.io.IO`` class & subclasses.
2748 Specific:
2750 * docutils/__init__.py:
2752   - Added ``ApplicationError`` and ``DataError``, for use throughout
2753     the package.
2754   - Added ``Component`` base class for Docutils components; implements
2755     the ``supports`` method.
2756   - Added ``__version__`` (thus, ``docutils.__version__``).
2758 * docutils/core.py:
2760   - Removed many keyword parameters to ``Publisher.__init__()`` and
2761     ``publish()``; bundled into an option values object.  Added
2762     "argv", "usage", "description", and "option_spec" parameters for
2763     command-line support.
2764   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2765     methods.
2766   - Reworked I/O model for ``docutils.io`` wrappers.
2767   - Updated ``Publisher.set_options()``; now returns option values
2768     object.
2769   - Added support for configuration files (/etc/docutils.conf,
2770     ./docutils.conf, ~/.docutils).
2771   - Added ``Publisher.setup_option_parser()``.
2772   - Added default usage message and description.
2774 * docutils/frontend.py: Added to project; support for front-end
2775   (command-line) scripts.  Option specifications may be augmented by
2776   components.  Requires Optik (http://optik.sf.net/) for option
2777   processing (installed locally as docutils/optik.py).
2779 * docutils/io.py: Added to project; uniform API for a variety of input
2780   output mechanisms.
2782 * docutils/nodes.py:
2784   - Added ``TreeCopyVisitor`` class.
2785   - Added a ``copy`` method to ``Node`` and subclasses.
2786   - Added a ``SkipDeparture`` exception for visitors.
2787   - Renamed ``TreePruningException`` from ``VisitorException``.
2788   - Added docstrings to ``TreePruningException``, subclasses, and
2789     ``Nodes.walk()``.
2790   - Improved docstrings.
2791   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2792   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2793     imports.
2794   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2795     ``PreDecorative`` mixin.
2796   - Reworked the name/id bookkeeping; to ``document``, removed
2797     ``explicit_targets`` and ``implicit_targets`` attributes, added
2798     ``nametypes`` attribute and ``set_name_id_map`` method.
2799   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2800     traversals.
2801   - Added ``document.has_name()`` method.
2802   - Fixed DOM generation for list-attributes.
2803   - Added category class ``Labeled`` (used by footnotes & citations).
2804   - Added ``Element.set_class()`` method (sets "class" attribute).
2806 * docutils/optik.py: Added to project.  Combined from the Optik
2807   package, with added option groups and other modifications.  The use
2808   of this module is probably only temporary.
2810 * docutils/statemachine.py:
2812   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2813   - Added underscores to improve many awkward names.
2814   - In ``string2lines()``, changed whitespace normalizing translation
2815     table to regexp; restores Python 2.0 compatibility with Unicode.
2817 * docutils/urischemes.py:
2819   - Filled in some descriptions.
2820   - Added "shttp" scheme.
2822 * docutils/utils.py:
2824   - Added ``clean_rcs_keywords`` function (moved from
2825     docutils/transforms/frontmatter.py
2826     ``DocInfo.filter_rcs_keywords``).
2827   - Added underscores to improve many awkward names.
2828   - Changed names of Reporter's thresholds:
2829     warning_level -> report_level; error_level -> halt_level.
2830   - Moved ``utils.id()`` to ``nodes.make_id()``.
2831   - Added ``relative_path(source, target)``.
2833 * docutils/languages/de.py: German mappings; added to project.  Thanks
2834   to Gunnar Schwant for the translations.
2836 * docutils/languages/en.py: Added "Dedication" bibliographic field
2837   mappings.
2839 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2840   Chodorowski.
2842 * docutils/parsers/rst/states.py:
2844   - Added underscores to improve many awkward names.
2845   - Added RFC-2822 header support.
2846   - Extracted the inline parsing code from ``RSTState`` to a separate
2847     class, ``Inliner``, which will allow easy subclassing.
2848   - Made local bindings for ``memo`` container & often-used contents
2849     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2850   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2851   - Added ``MarkupMismatch`` exception; for late corrections.
2852   - Added ``-/:`` characters to inline markup's start string prefix,
2853     ``/`` to end string suffix.
2854   - Fixed a footnote bug.
2855   - Fixed a bug with literal blocks.
2856   - Applied patch from Simon Budig: simplified regexps with symbolic
2857     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2858   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2859   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2860   - Allowed non-ASCII in "simple names" (directive names, field names,
2861     references, etc.).
2862   - Converted ``Inliner.patterns.initial`` to be dynamically built
2863     from parts with ``build_regexp()`` function.
2864   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2865   - Updated docstrings.
2866   - Changed "table" to "grid_table"; added "simple_table" support.
2868 * docutils/parsers/rst/tableparser.py:
2870   - Changed ``TableParser`` to ``GridTableParser``.
2871   - Added ``SimpleTableParser``.
2872   - Refactored naming.
2874 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2875   a fallback language for directive names.
2877 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2878   directive to use a ``pending`` element, used only by HTML writers.
2880 * docutils/parsers/rst/directives/parts.py: Renamed from
2881   components.py.
2883   - Added "backlinks" attribute to "contents" directive.
2885 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2886   project by Adam Chodorowski.
2888 * docutils/readers/__init__.py: Gave Readers more control over
2889   choosing and instantiating Parsers.
2891 * docutils/readers/pep.py: Added to project; for PEP processing.
2893 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2894   requires a ``component`` parameter.
2896 * docutils/transforms/components.py: Added to project; transforms
2897   related to Docutils components.
2899 * docutils/transforms/frontmatter.py:
2901   - In ``DocInfo.extract_authors``, check for a single "author" in an
2902     "authors" group, and convert it to a single "author" element.
2903   - Added support for "Dedication" and generic bibliographic fields.
2905 * docutils/transforms/peps.py: Added to project; PEP-specific.
2907 * docutils/transforms/parts.py: Renamed from old components.py.
2909   - Added filter for `Contents`, to use alt-text for inline images,
2910     and to remove inline markup that doesn't make sense in the ToC.
2911   - Added "name" attribute to TOC topic depending on its title.
2912   - Added support for optional TOC backlinks.
2914 * docutils/transforms/references.py: Fixed indirect target resolution
2915   in ``Hyperlinks`` transform.
2917 * docutils/transforms/universal.py:
2919   - Changed ``Messages`` transform to properly filter out system
2920     messages below the warning threshold.
2921   - Added ``Decorations`` transform (support for ``--generator``,
2922     ``--date``, ``--time``, ``--source-link`` options).
2924 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2925   Engelbert Gruber's PDF writer.
2927 * docutils/writers/html4css1.py:
2929   - Made XHTML-compatible (switched to lowercase element & attribute
2930     names; empty tag format).
2931   - Escape double-dashes in comment text.
2932   - Improved boilerplate & modularity of output.
2933   - Exposed modular output in Writer class.
2934   - Added a "generator" meta tag to <head>.
2935   - Added support for the ``--stylesheet`` option.
2936   - Added support for ``decoration``, ``header``, and ``footer``
2937     elements.
2938   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2939     translation table to regexp; restores Python 2.0 compatibility
2940     with Unicode.
2941   - Added the translator class as instance variable to the Writer, to
2942     make it easily subclassable.
2943   - Improved option list spacing (thanks to Richard Jones).
2944   - Modified field list output.
2945   - Added backlinks to footnotes & citations.
2946   - Added percentage widths to "<col>" tags (from colspec).
2947   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2948     "<span>" changed to "<var>".
2949   - Inline literals: "<code>" changed to "<tt>".
2950   - Many changes to optimize vertical space: compact simple lists etc.
2951   - Add a command-line options & directive attributes to control TOC
2952     and footnote/citation backlinks.
2953   - Added support for optional footnote/citation backlinks.
2954   - Added support for generic bibliographic fields.
2955   - Identify backrefs.
2956   - Relative URLs for stylesheet links.
2958 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2959   PEPs (subclass of ``html4css1.Writer``).
2961 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2963 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2964   of the Docutils internal doctree in XML.
2966 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2968 * spec/doctree.txt:
2970   - Changed the title to "The Docutils Document Tree".
2971   - Added "Hyperlink Bookkeeping" section.
2973 * spec/docutils.dtd:
2975   - Added ``decoration``, ``header``, and ``footer`` elements.
2976   - Brought ``interpreted`` element in line with the parser: changed
2977     attribute "type" to "role", added "position".
2978   - Added support for generic bibliographic fields.
2980 * spec/notes.txt: Continual updates.  Added "Project Policies".
2982 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2983   section.
2985 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2987 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2988   mailing list discussions.
2990 * spec/pep-0287.txt:
2992   - Renamed to "reStructuredText Docstring Format".
2993   - Minor edits.
2994   - Reworked Q&A as an enumerated list.
2995   - Converted to reStructuredText format.
2997 * spec/pysource.dtd:
2999   - Reworked structural elements, incorporating ideas from Tony Ibbs.
3001 * spec/pysource.txt: Removed from project.  Moved much of its contents
3002   to pep-0258.txt.
3004 * spec/rst/alternatives.txt:
3006   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3007   - Added "Inline External Targets" section.
3009 * spec/rst/directives.txt:
3011   - Added "backlinks" attribute to "contents" directive.
3013 * spec/rst/problems.txt:
3015   - Updated the Enumerated List Markup discussion.
3016   - Added new alternative table markup syntaxes.
3018 * spec/rst/reStructuredText.txt:
3020   - Clarified field list usage.
3021   - Updated enumerated list description.
3022   - Clarified purpose of directives.
3023   - Added ``-/:`` characters to inline markup's start string prefix,
3024     ``/`` to end string suffix.
3025   - Updated "Authors" bibliographic field behavior.
3026   - Changed "inline hyperlink targets" to "inline internal targets".
3027   - Added "simple table" syntax to supplement the existing but
3028     newly-renamed "grid tables".
3029   - Added cautions for anonymous hyperlink use.
3030   - Added "Dedication" and generic bibliographic fields.
3032 * test: Made test modules standalone (subdirectories became packages).
3034 * test/DocutilsTestSupport.py:
3036   - Added support for PEP extensions to reStructuredText.
3037   - Added support for simple tables.
3038   - Refactored naming.
3040 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3042   - Now supports true packages containing test modules
3043     (``__init__.py`` files required); fixes duplicate module name bug.
3045 * test/test_pep/: Subpackage added to project; PEP testing.
3047 * test/test_rst/test_SimpleTableParser.py: Added to project.
3049 * tools:
3051   - Updated html.py and publish.py front-end tools to use the new
3052     command-line processing facilities of ``docutils.frontend``
3053     (exposed in ``docutils.core.Publisher``), reducing each to just a
3054     few lines of code.
3055   - Added ``locale.setlocale()`` calls to front-end tools.
3057 * tools/buildhtml.py: Added to project; batch-generates .html from all
3058   the .txt files in directories and subdirectories.
3060 * tools/default.css:
3062   - Added support for ``header`` and ``footer`` elements.
3063   - Added styles for "Dedication" topics (biblio fields).
3065 * tools/docutils.conf: A configuration file; added to project.
3067 * tools/docutils-xml.py: Added to project.
3069 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3071 * tools/pep-html-template: Added to project.
3073 * tools/pep2html.py: Added to project from Python (nondist/peps).
3074   Added support for Docutils (reStructuredText PEPs).
3076 * tools/quicktest.py:
3078   - Added the ``--attributes`` option, hacked a bit.
3079   - Added a second command-line argument (output file); cleaned up.
3081 * tools/stylesheets/: Subdirectory added to project.
3083 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3086 Release 0.1 (2002-04-20)
3087 ========================
3089 This is the first release of Docutils, merged from the now inactive
3090 reStructuredText__ and `Docstring Processing System`__ projects.  For
3091 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3092 `DPS HISTORY`__ files.
3094 __ http://structuredtext.sourceforge.net/
3095 __ http://docstring.sourceforge.net/
3096 __ http://structuredtext.sourceforge.net/HISTORY.html
3097 __ http://docstring.sourceforge.net/HISTORY.html
3099 General changes: renamed 'dps' package to 'docutils'; renamed
3100 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3101 the test suites (reStructuredText's test/test_states renamed to
3102 test/test_rst); and all modifications required to make it all work.
3104 * docutils/parsers/rst/states.py:
3106   - Improved diagnostic system messages for missing blank lines.
3107   - Fixed substitution_reference bug.
3111    Local Variables:
3112    mode: indented-text
3113    indent-tabs-mode: nil
3114    sentence-end-double-space: t
3115    fill-column: 70
3116    End: