Wrap SVG images in <img> tags not <object>.
[docutils.git] / docutils / HISTORY.txt
blob22656682763d37cdcc3b96118b9508b7e1b4ca7b
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/rst/__init__.py
25   - Fix [ 233 ] Change the base URL for the :rfc: role.
27 * docutils/parsers/rst/directives/tables.py
29   - patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
30     or 'grid'.
32 * docutils/utils/math/math2html.py
34   - add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
36 * docutils/writers/html4css1/__init__.py
38   - Add "docutils" to class values for "container" object to address [ 267 ].
39   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
40     ``default_stylesheet_path`` and ``default_template_path``.
42 * docutils/writers/xhtml11/
44   - New HTML writer generating `XHTML1.1`_ styled with CSS2.
45     Moved to the docutils core from sandbox/html4strict.
47   - Wrap SVG images in <img> tags not <object>.
48     Addresses bug [ 247 ], but rendering problems remain
49     (see test/functional/expected/standalone_rst_xhtml11.xhtml),
50     so we might need a config setting.
52   .. _XHTML1.1: http://www.w3.org/TR/xhtml11/
54 * docutils/writers/latex2e/__init__.py
56   - use absolute path for ``default_template_path``.
58 * docutils/writers/odf_odt/__init__.py
60   - remove decode.encode of filename stored in zip.
62 * docutils/writers/latex2e/__init__.py
64   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
65     admonitions and docinfo.
67 Release 0.12 (2014-07-06)
68 =========================
70 * docs/ref/rst/directives.txt
72   - Update "math" and "csv-table" descriptions.
74 * docutils/parsers/rst/directives/images.py
76   - Fix [ 258 ] figwidth="image" generates unitless width value.
78 * docutils/parsers/rst/states.py
80   - Improve error report when a non-ASCII character is specified as
81     delimiter, quote or escape character under Python 2.
82     Fixes [ 249 ] and [ 250 ].
84 * docutils/writers/html4css1/__init__.py
86   - Don't add newline after inline math.
87     Thanks to Yury G. Kudryashov for the patch.
89 * docutils/writers/latex2e/__init__.py
91   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
92   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
94 * docutils/writers/odf_odt/__init__.py
96   - Apply patch by Jakub Wilk to fix bug [ 100 ].
98 * test/test_error_reporting.py
100   - Fix [ 223 ] by removing redundant tests we do not have control over.
102 * test/test_nodes.py
104   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
106 Release 0.11 (2013-07-22)
107 =========================
109 * General
111   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
112   - Support embedded aliases within hyperlink references.
113   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
114     language module) before global search.
116 * docutils/nodes.py
118   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
120 * docutils/parsers/rst/directives/__init__.py
122   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
124 * docutils/parsers/rst/directives/images.py
126   - Apply [ 3599485 ] node source/line information for sphinx translation.
128 * docutils/parsers/rst/directives/tables.py
130   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
132 * docutils/parsers/rst/states.py
134   - Fix [ 157 ] Line block parsing doesn't like system message.
135   - Always import our local copy of roman.py (report Larry Hastings).
137 * docutils/transforms/references.py
139   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
141 * docutils/utils/__init__.py
143   - Fix [ 3596884 ] exception importing ``docutils.io``.
145 * docutils/writers/html4css1/__init__.py
147   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
148   - New setting `stylesheet_dirs`: Comma-separated list of directories
149     where stylesheets are found. Used by `stylesheet_path` when expanding
150     relative path arguments.
151   - New default for math-output_: ``HTML math.css``.
152   - Avoid repeated class declarations in html4css1 writer
153     (modified version of patch [ 104 ]).
155 .. _math-output: docs/user/config.html#math-output
157 * docutils/writers/latex2e/__init__.py
159   - Drop the simple algorithm replacing straight double quotes with
160     English typographic ones.
161     Activate the SmartQuotes_ transform if you want this feature.
162   - Fix literal use of babel shorthands (straight quote, tilde, ...).
163   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
164   - New setting `stylesheet_dirs`.
166 .. _SmartQuotes: docs/user/config.html#smart-quotes
168 * docutils/writers/manpage.py
170   - Fix [3607063] handle lines starting with a period.
171   - Fix option separating comma was bold (thanks to Bill Morris).
173 Release 0.10 (2012-12-16)
174 =========================
176 * General
178   - Dropped support for Python 2.3.
179   - ``docutils/math``, ``docutils/error_reporting.py``, and
180     ``docutils/urischemes.py`` moved to the utils package.
181   - Fix [3541369] Relative __import__ also with Python 3.3.
182   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
183     and parsers for Python 2.7 up.
184   - Fix import of PIL.Image.
185   - Change default of "syntax highlight" option to "long",
186     basic syntax highlight styles for LaTeX and HTML.
188 * docutils/io.py
190   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
191     option is ignored and will be removed in a future release.
192   - Fix Py3k error writing to stdout with encoding differing from default.
193   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
195 * docutils/parsers/rst/directives/misc.py
197   - Fix [ 3546533 ] Unicode error with `date` directive.
199 * docutils/transforms/universal.py
201   - SmartQuotes transform for typographic quotes and dashes.
203 * docutils/utils/__init__.py
205   - normalize_language_tag() now returns `BCP 47`_ conformant tags
206     with subtags separated by ``-``.
208 * docutils/writers/html4css1/__init__.py
210   - Use ``<code>`` tag for inline "code",
211     do not drop nested inline nodes (syntax highlight tokens).
212   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
213   - No line break after opening inline math tag.
215 * docutils/writers/manpage.py
217   - Apply [ 3527401 ] addmonition's don't preserve indentation
218   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
220 , docutils/writers/xetex/__init__.py
222   - Apply [ 3555160 ] ensure order of "otherlanguages".
223   - Fix section numbering by LaTeX.
225 * docutils/writers/s5_html/__init__.py
227   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
229 * docutils/writers/s5_html/docutils_xml.py
231   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
233 * setup.py
235   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
237 * tools/test/test_buildhtml.py
239   - Fix [ 3521167 ] allow running in any directory.
240   - Fix [ 3521168 ] allow running with Python 3.
243 Release 0.9.1 (2012-06-17)
244 ==========================
246 * setup.py
248   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
249     installed in the PYTHONPATH. Converted tests are now
250     stored in ``test3/``, tools no longer need conversion.
252     If you installed one of Docutils versions 0.7 ... 0.9 with
253     ``setup.py install`` under Python 3, remove the spurious
254     ``test/`` and ``tools/`` directories in the site library root.
256 * test/
258   - Make tests independent from the location of the ``test/`` directory.
259   - Use converted sources (from the ``build/`` directory) for tests under
260     Python 3.
262 * tools/
264   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
266 * docutils/io.py
268   - Fix writing binary data to sys.stdout under Python 3 (allows
269     ``rst2odt.py`` to be used with output redirection).
271 * docutils/parsers/rst/directives/misc.py
273   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
274     ``locale == C`` and 8-bit char in path argument of `include` directive.
276 * test/alltests.py
278   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
279     file under Python 3.
281 Release 0.9 (2012-05-02)
282 ========================
284 * General:
286   - New reStructuredText "code" role and directive and "code" option
287     of the "include" directive with syntax highlighting by Pygments_.
288   - Fix parse_option_marker for option arguments containing ``=``.
289   - Fix [ 2993756 ]: import Python Imaging Library's Image module
290     via ``import PIL`` as starting with PIL 1.2,
291     "PIL lives in the PIL namespace only" (announcement__).
293 .. _Pygments: http://pygments.org/
294 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
296 * setup.py
298   - Fix [ 2971827 ] and [ 3442827 ]
299     extras/roman.py moved to docutils/utils/roman.py
301 * docutils/frontend.py
303   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
305 * docutils/io.py
307   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
308   - `mode` argument for FileOutput avoids code replication in
309     BinaryFileOutput.
310   - New exceptions InputError and OutputError for IO errors in
311     FileInput/FileOutput.
313 * docutils/core.py:
315   - No "hard" system exit on file IO errors: catch and report them in
316     `Publisher.reportException` instead. Allows handling by a calling
317     application if the configuration setting `traceback` is True.
319 * docutils/utils.py -> docutils/utils/__init__.py
321   - docutils.utils is now a package (providing a place for sub-modules)
323   .. note:: docutils/math, docutils/error_reporting.py, and
324      docutils/urischemes.py will move to the utils package in the next
325      release, too. See RELEASE-NOTES__
327      __ RELEASE-NOTES.html
329   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
330     errors recording non-ASCII filenames (fixes [ 3434355 ]).
332   - Fix relative_path() with source=None and `unicode` target.
334 * docutils/parsers/rst/states.py
336   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
337     characters and "international" quotes around inline markup.
338   - Use `field_marker` pattern to look for start of a
339     directive option block (fixes [ 3484857 ]).
341 * docutils/parsers/rst/tableparser.py
343   - Fix [ 2926161 ] for simple tables.
344     (Combining chars in grid tables still contribute to cell width.)
346 * docutils/writers/latex2e/__init__.py
348   - Support the `abbreviation` and `acronym` standard roles.
349   - Record only files required to generate the LaTeX source as dependencies.
350   - Fix handling of missing stylesheets.
351   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
352     when suppressing LaTeX section numbering.
353   - Use ``\DUtitle`` for unsupported section levels
354   - Apply [ 3512791 ] do not compare string literals with "is"
356 * docutils/writers/xetex/__init__.py
358   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
360 * docutils/writers/html4css1/__init__.py
362   - Change default for `math-output` setting to MathJax.
363   - Fix handling of missing stylesheets.
365 * docutils/writers/docutils_xml.py
367   - Use the visitor pattern with default_visit()/default_depart() methods
368     instead of minidom to facilitate special handling of selected nodes.
369   - Support raw XML (inserted as-is inside a <raw></raw> node).
371 * docutils/writers/manpage.py
373   - Do not emit comment line with trailing blank. Problematic for VCS.
375 Release 0.8.1 (2011-08-30)
376 ==========================
378 * General:
380   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
381     and [ 3395920 ] (correct copyright info for rst.el).
383 * test/
385   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
387 * docutils/writers/latex2e/__init__.py
389   - Clean up Babel language setting. Restores Sphinx compatibility.
391 Release 0.8 (2011-07-07)
392 ========================
394 * General:
396   - Handle language codes according to `BCP 47`_.
397   - If the specified language is not supported by Docutils,
398     warn and fall back to English.
399   - Math support: reStructuredText "math" role and directive,
400     ``math`` and ``math_block`` doctree elements.
401   - Decode command line arguments with the locale's preferred encoding
402     (to allow, e.g., ``--title=Dornröschen``).
403   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
404   - New sub-module `error_reporting`: handle encoding/decoding errors
405     when reporting exceptions.
406   - Some additions to the Docutils core are released under the 2-Clause BSD
407     license, see COPYING_ for details.
409   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
410   .. _COPYING: COPYING.html
412 * reStructuredText:
414   - Most directives now support a "name" option that attaches a
415     reference name.
417   - Directive content may start on the first line also when the directive
418     type accepts options.
420 * docs/dev/policies.txt:
422   - Recommend the 2-Clause BSD license
423     (http://www.spdx.org/licenses/BSD-2-Clause)
424     for code that is kept under the author's copyright.
426 * tools/buildhtml.py:
428   - Fix ``--local`` switch.
430 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
432 * docutils/writers/html4css1/__init__.py
434   - Set "lang" argument for objects with class argument
435     "language-<language tag>".
436   - New setting "math-output" with support for HTML, MathML, and LaTeX.
438 * docutils/writers/latex2e/__init__.py
440   - Fix [ 3043986 ] AttributeError using :local: with table of content.
441   - Place title data in the document preamble.
442   - Load `babel` package only if required.
443   - Update list of supported languages.
444   - New config setting "hyperref-options".
445     No hard-coded "unicode" hyperref option (clash with xetex).
446   - Set language for custom roles, paragraphs, block-quotes, and
447     line-quotes with class argument "language-<language tag>".
448   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
449   - Convert image URI to a local file path.
450   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
451     has more than one paragraph (Wolfgang Scherer).
452   - \leavevmode before longtable only when needed (prevents spurious vspace)
453   - do not advance table counter for tables without caption
455 * docutils/writers/xetex/__init__.py
457   - New writer generating LaTeX code for compiling with ``xelatex``.
459     A separate writer (inheriting from latex2e) instead of a ``--xetex``
460     option allows separate config options for XeTeX vs. LaTeX2e.
462 * docutils/writers/manpage.py
464   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
465   - Fix: vertical space cleaning for option group ``.``.
467 * tools/editors/emacs/rst.el:
469   - Fix [ 3001100 ] does not handle spaces in filenames
470     (thanks to Jakub Wilk)
472 * docutils/utils.py:
474   - strip whitespace from stylesheet arguments
475   - exclude combining chars from column_width()
476     (partial fix for [ 2926161 ])
478 * docutils/parsers/rst/directives/misc.py:
480   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
481     nested_parse
483 * docutils/io.py:
485   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
486     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
488 Release 0.7 (2010-07-07)
489 ========================
491 * General:
493   - Fix [ 2881769 ] setup configuration.
494   - Fix [ 2788716 ] reporting problems in included files.
496 * docutils/io.py
498   - FileInput opens files as text files with universal newline support
499     (mode "rU", configurable with the new optional argument "mode").
501 * docutils/nodes.py
503   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
505 * docutils/utils.py
507   - Fix [ 2923723 ] let decode_path() tolerate path == None
509 * docutils/writers/html4css1/__init__.py
511   - Support SVG and SWF images (thanks to Stefan Rank).
512   - Generate valid XHTML for centered images with targets.
513     Use CSS classes instead of "align" tags for image alignment.
515 * docutils/writers/latex2e/__init__.py
517   - Use `transforms.writer_aux.Admonitions` to "normalize" special
518     admonitions.
519   - Use the ``\url`` command for URLs (breaks long URLs instead of
520     writing into the margin).
521   - Preserve runs of spaces in `inline literals`__.
522   - Deprecate ``figure_footnotes`` setting.
523   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
524   - New ``latex_preamble`` setting.
525   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
526   - Fix hyperlink targets (labels) for images, figures, and tables.
527   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
528   - Apply [ 2961991 ] Call hyperref with unicode option.
529   - Drop the special `output_encoding`__ default ("latin-1").
530     The Docutils wide default (usually "UTF-8") is used instead.
531   - Render inline markup in document title and subtitle.
532   - Fix numbering depth with LaTeX section numbering.
533   - Update Unicode -> LaTeX translations.
534   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
536 __ docs/ref/restructuredtext.html#inline-literals
537 __ docs/user/config.html#docutils-footnotes
538 __ docs/user/config.html#output_encoding
540 * docutils/writers/manpage.py
542   - Fix: supported attribute (thanks to peter2108).
543   - Remove trailing blanks in code (keep in sync with mercurial version).
544   - Titles level 1, that is ``.SH``, always uppercase.
545   - Apply patch from mg: literal text should be bold in man-pages.
547 * docutils/nodes.py
549   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
550     turkish locale.
552 * setup.py:
554   - Python 3 support: copy test/ and tools/ to the build-dir
555     and convert Python sources with 2to3.
558 Release 0.6 (2009-10-11)
559 ========================
561 * General:
563   - Docutils is now compatible with Python versions from 2.3 up to 2.6
564     and convertible to 3.1 code.
566     + Node.__nonzero__ returns True instead of 1.
567     + use os.walk instead os.path.walk.
568     + minimize "types" module where possible.
569     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
570     + Text nodes now subclass unicode rather than UserString
571       (which is gone in python 3.0).
572     + 3.0 compatibility module docutils._compat
574     + Drop 2.2 compatibility workarounds.
575     + Drop extras/optparse.py and extras/textwrap.py
576       (stdlib modules since 2.3).
578   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
579   - Unix man page export: manpage writer moved from sandbox to Doctutils
580     core.
582   - Apply [ 1719345 ] Galician translation
583   - Apply [ 1905741 ] Polish translation
584   - Apply [ 1878977 ] make_id(): deaccent characters.
585   - Apply [ 2029251 ] return nonzero when tests fail.
586   - Fix [ 1692788 ] allow UTF-8 in style sheets.
587   - Fix [ 2781629 ] support non-ASCII chars in file names.
588   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
589   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
590   - Fix [ 2821266 ] --strict option works now like --halt=info.
591   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
592   - Fix [ 1627229 ] hyperlink references in substitutions.
594   - The "newlatex" writer is orphaned.
596 * reStructuredText:
598   - Documented Unicode characters allowed as inline markup openers,
599     closers, and delimiters.
600   - Allow units for all length specifications.
601   - Allow percent sign in "scale" argument of "figure" and "image" directives.
602   - Bugfix: The "figalign" argument of a figure now works as intended
603     (aligning the figure, not its contents).
604   - Align images with class "align-[right|center|left]"
605     (allows setting the alignment of an image in a figure).
607 * docutils/nodes.py:
609   - Added ``Element.__contains__`` method, for the in-operator.
611 * docutils/parsers/rst/states.py:
613   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
614   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
615     " " (non-breaking space), and "¡ ¿" openers.
617 * docutils/parsers/directives/misc.py:
619   - Added ``start-line`` and ``end-line`` options to "include"
620     directive to select a range of lines.
621   - Hard tabs in literal inclusions are replaced by spaces. This is
622     configurable via the new ``tab-width`` option of the "include" directive
623     (a negative tab-width prevents tab expansion).
625 * docutils/utils.py:
627   - Add ``get_stylesheet_list`` function.
628   - Apply [ 2834836 ] print info at halt
630 * docutils/transforms/universal.py:
632   - Raise default priority of StripClasses to exclude stripped classes from
633     the ToC.
635 * docutils/writers/html4css1/__init__.py:
637   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
638     separated list of stylesheets.
639   - Address [ 1938891 ] Inline literal text creates "pre" span only when
640     needed to prevent inter-word line wraps.
641   - Use `translate` method instead of repeated `replace` calls.
642   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
643     classes to allow CSS styling that does not interfere with other
644     table-using constructs (field lists, citations, ...).
646 * docutils/writers/newlatex2e/__init__.py:
648   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
650 * docutils/writers/latex2e/__init__.py (see also
651   `<docs/user/docutils-05-compat.sty.html>`__) :
653   - Add ``--embed-stylesheet`` option.
654   - Apply [ 1474017 ] image vertical alignment is reversed.
655   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
656   - Change: has_key for dictionaries (not Nodes) to in-operator.
657   - Merge adjacent citations into one latex cite command.
658   - Failsave implementation of custom roles. LaTeX compilation now ignores
659     unknown classes instead of aborting with an error.
660   - Support custom roles based on standard roles.
661   - LaTeX packages can be used as ``--stylesheet`` arguments without
662     restriction. (A style sheet is now referenced with the ``\usepackage``
663     command, if it ends with ``.sty`` or has no extension.)
664   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
665   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
666   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
667     2005-02-04 as a configurable length unit).
668   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
669     if font-encoding is set to ''. LaTeX defaults to OT1 then.
670   - Set sub- and superscript role argument in text mode not as math.
671     Use a custom role based on sub-/superscript if you want italic shape.
672   - Shorter preamble and less dependencies: Load packages and define macros
673     only if required in the document.
674   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
675   - New custom environments and commands with optional "classes" argument.
676   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
677   - Better conformance to Docutils specifications with ``--use-latex-toc``.
678     Support for LaTeX generated ToC also with unnumbered sections.
679   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
680     section numbering by LaTeX.
681   - Use default font in admonitions and sidebar.
682   - Align of image in a figure defaults to 'center'.
683   - Bugfix: Newlines around targets and references prevent run-together
684     paragraphs.
685   - Fix internal hyperlinks.
686   - Use class defaults for page margins ('typearea' now optional).
687   - Float placement made configurable, default changed to "here definitely".
688   - Typeset generic topic as "quote block with title".
689   - Use template (file and configuration option).
690   - In the default template, load cmap.sty (fix text extraction in PDF) and
691     fixltx2e.sty (LaTeX patches, \textsubscript).
692   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
693   - Use `translate` instead of repeated `replace` calls for text encoding.
694   - Hyperlinked footnotes and support for symbol footnotes and
695     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
696   - Complete pairs of binary options
697     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
698     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
699   - New defaults:
700     - font-encoding: "T1" (formerly implicitely set by 'ae').
701     - use-latex-toc: true (ToC with page numbers).
702     - use-latex-footnotes: true (no mixup with figures).
704 * docutils/writers/manpage.py
706   - Do not print version at document end, this is done by the viewer.
707   - Do not print date at document end, this is done by the viewer.
708   - Fix storage of docinfo fields for none standard fields.
710 * docutils/tools/rst2man.py
712 Release 0.5 (2008-06-25)
713 ========================
715 * docutils/languages/he.py: Added to project: Hebrew mappings by
716   Meir Kriheli.
718 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
719   mappings by Meir Kriheli.
721 * docutils/frontend.py:
723   - Configuration files are now assumed and required to be
724     UTF-8-encoded.
725   - Paths of applied configuration files are now recorded in the
726     runtime setting ``_config_files`` (accessible via
727     ``--dump-settings``).
728   - Added ``--strip-elements-with-class`` and ``--strip-class``
729     options (``strip_elements_with_classes`` and ``strip_classes``
730     settings).
732 * docutils/io.py:
734   - Added code to determine the input encoding from data: encoding
735     declarations or the presence of byte order marks (UTF-8 & UTF-16).
736   - Added support for IronPython 1.0.
738 * docutils/nodes.py:
740   - Added ``document.__getstate__`` method, for pickling.
742 * docutils/parsers/rst/states.py:
744   - Allow ``+`` and ``:`` in reference names.
745   - Unquoted targets beginning with an underscore (``.. __target:
746     URI``) are no longer accepted.
747   - Added support for multiple attributions in a physical block quote
748     (indented text block), dividing it into multiple logical block
749     quotes.
750   - Added support for unicode bullets in bullet lists: "•", "‣", and
751     "⁃".
752   - Added support for new object-oriented directive interface,
753     retaining compatibility to the old functional interface.
754   - Added support for throwing ``DirectiveError``'s from within
755     directive code.
757 * docutils/parsers/rst/__init__.py:
759   - Added ``Directive`` base class.
760   - Added ``DirectiveError`` base class.
761   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
762     definitions.
764 * docutils/parsers/directives/:
766   - Refactored all reStructuredText directives to use the new
767     object-oriented directive interface.  Errors are now (mostly)
768     thrown using the new ``DirectiveError`` class.
770 * docutils/parsers/directives/misc.py:
772   - Added ``start-after`` and ``end-before`` options to ``include``
773     directive; thanks to Stefan Rank.
775 * docutils/transforms/universal.py:
777   - Added ``StripClassesAndElements`` transform to remove from the
778     document tree all elements with classes in
779     ``settings.strip_elements_with_classes`` and all "classes"
780     attribute values in ``self.document.settings.strip_classes``.
782 * docutils/transforms/writer_aux.py:
784   - Added ``Admonitions`` transform to transform specific admonitions
785     (like ``note``, ``warning``, etc.) into generic admonitions with a
786     localized title.
788 * docutils/writers/html4css1/__init__.py:
790   - Moved template functionality from the PEP/HTML writer here.
791   - Expanded the fragments available in the ``parts`` attribute.
792   - Moved ``id`` attributes from titles to surrounding ``div``
793     elements.
794   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
795     universally supported now).
796   - ``template.txt`` is now opened in text mode instead of binary mode
797     (to ensure Windows compatibility).
798   - ``a`` elements now have an "internal" or "external" class,
799     depending on reference type.
801 * docutils/writers/html4css1/template.txt: Added to project.
803 * docutils/writers/pep_html/:
805   - Moved template functionality to the HTML writer.
807 * docutils/writers/s5_html/__init__.py:
809   - Added ``view_mode`` & ``hidden_controls`` settings
810     (``--view-mode`` & ``--hidden-controls/--visible-controls``
811     options).
813 * docutils/writers/latex2e/__init__.py:
815   - Add ``--literal-block-env``
816   - Fix: escaping ``%`` in href urls.
817   - Move usepackage hyperref after stylesheet inclusion.
818   - Fix: scrartcl does not have chapter but scrreprt.
819   - Add newline after ``\end{verbatim}``.
820   - Merge smaller differences from latex2e_adaptive_preamble.
821   - Add ``use-part-section``.
822   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
823   - Using leavemode option_list no longer needs to check if parent
824     is a definition list.
825   - Append ``\leavemode`` to definition list terms.
826   - No longer write visit\_/depart_definition_list_item comments to
827     output.
828   - Table column width with 3 decimal places.
829   - Add table stubs support (boldfont).
830   - Add assemble_parts to writer.
831   - Add simply support for nested tables.
832   - Fix verbatim in tables if use-verbatim-when-possible.
833   - Use section commands down to subparagraph.
834   - Put ensuremath around some latin1 chars.
835   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
836   - New option ``--use-bibtex=style,db1,db2``.
837   - New option ``--reference-label`` to allow usage of LaTeX ref for
838     labels in section references.
839   - Add a label after every section to support sectionnumbers as reference
840     labels.
841   - Fix: bug# 1605376 rst2latex: bad options group list
842   - Remove inactive code for use_optionlist_for_option_list.
843   - Remove latex comments from option_list output.
844   - Fix: bug# 1612270 double qoutes in italian literal.
845   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
846   - Add option --use-latex-abstract.
847   - Image width unit ``px`` is translated to ``pt``.
848   - Add image height support.
849   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
850     bug #1457388
851   - Fix: Do not escape underscores in citation reference labels if
852     use-latex-citations is set.
853   - Use centering instead of center for figure contents, to avoid vertical
854     space.
855   - Recognize table class: borderless, nolines, booktabs, standard.
856   - Fix: Renaming contents section does not work with latex writer; SF
857     bug #1487405.
858   - Applied patch for custom roles with classes from Edward Loper.
859   - Fixed bug that caused crashes with more than 256 lists.
861 * docutils/writers/pep_html/__init__.py:
863   - Changed to support new python.org website structure and
864     pep2pyramid.py.
866 * docs/howto/security.txt: "Deploying Docutils Securely", added to
867   project.
869 * tools/buildhtml.py:
871   -- Added ``ignore`` setting to exclude a list of shell patterns
872      (default: ``.svn:CVS``).
874 * tools/editors/emacs/rst.el:
876   - Changed license to "GPL".
877   - Added ``rst-straighten-decorations`` function.
878   - The ``compile`` module is now always loaded.
879   - Added ``rst-toggle-line-block`` function.
880   - Headings consisting only of non-ASCII characters are now
881     recognized by ``rst-toc`` and ``rst-adjust``.
882   - Added font-lock support for multi-line comments where the first
883     comment line is empty.
884   - Added ``(require 'font-lock)``.
886 * setup.py:
888   - Provide descriptive error message if distutils is missing.
891 Release 0.4 (2006-01-09)
892 ========================
894 * General:
896   - Updated the project policies for trunk/branch development &
897     version numbering.
899 * docutils/__init__.py:
901   - Added ``__version_details__`` attribute to describe code source
902     (repository/snapshot/release).
903   - Replaced ``default_transforms`` attribute of TransformSpec with
904     ``get_transforms()`` method.
906 * docutils/core.py:
908   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
909     functions, for document tree extraction and reprocessing.
911 * docutils/io.py:
913   - Added ``DocTreeInput`` class, for reprocessing existing documents.
914   - Added support for non-Unicode (e.g. binary) writer output.
916 * docutils/nodes.py:
918   - Re-introduced ``Targetable.indirect_reference_name``, for
919     MoinMoin/reST compatibility (removed in r3124/r3129).
920   - Added ``serial_escape`` function; escapes string values that are
921     elements of a list, for serialization.  Modified Docutils-XML
922     writing (``Element._dom_node``) and pseudo-XML writing
923     (``Element.starttag``) to use ``serial_escape``.
924   - Added ``Node.deepcopy()`` method.
925   - Removed the internal lists ``document.substitution_refs``,
926     ``document.anonymous_refs``, and ``document.anonymous_targets``.
927   - Added a "container" element.
928   - Fixed bug where values of list-valued attributes of elements
929     originating from custom interpreted text roles (i.e., with custom
930     classes) were being shared between element instances.  Reported by
931     Shmuel Zeigerman.
933 * docutils/statemachine.py:
935   - Added trailing whitespace stripping to ``string2lines()``.
936   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
937     Asian double-width character support.
939 * docutils/utils.py:
941   - Added ``east_asian_column_width()`` for double-width character
942     support.
944 * docutils/languages/ja.py: Added to project: Japanese mappings by
945   Hisashi Morita.
947 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
948   mappings by Panjunyong.
950 * docutils/parsers/null.py: Added to project; a do-nothing parser.
952 * docutils/parsers/rst/__init__.py:
954   - Added validator to tab_width setting, with test.  Closes SF bug
955     #1212515, report from Wu Wei.
957 * docutils/parsers/rst/states.py:
959   - Fixed bug with escaped colons indicating a literal block.
960   - Fixed bug with enumerated lists (SF#1254145).
961   - Backslash-escaped colons inside of field names are now allowed.
962   - Targets (implicit and explicit), anonymous hyperlink references
963     and auto-numbered footnote references inside of substitution
964     definitions are now disallowed.
965   - Fixed bug: list items with blank first lines.
966   - Fixed bug: block quote attributions with indented second lines.
967   - Added East Asian double-width character support (Python 2.4 only).
969 * docutils/parsers/rst/tableparser.py:
971   - Added East Asian double-width character support (Python 2.4 only).
973 * docutils/parsers/rst/directives/body.py:
975   - Added the "container" directive.
977 * docutils/parsers/rst/directives/misc.py:
979   - Added the "default-role", "title", and "date" directives.
980   - Added standard data file syntax to the "include" directive.
981   - Added support for "class" directive content.
983 * docutils/parsers/rst/directives/images.py:
985   - Added ``indirect_reference_name`` support for images with a target
986     option.
987   - Added support for image width and height units.
988   - Fixed bug with image "target" options.
990 * docutils/parsers/rst/directives/references.py:
992   - Added "class" attribute to "target-notes" directive, for
993     footnote_reference classes.
995 * docutils/parsers/rst/include/: Directory added to project; contains
996   standard data files for the "include" directive.  Initial contents:
997   character entity substitution definition sets, and a set of
998   definitions for S5/HTML presentations.
1000 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1001   mappings by David Goodger.
1003 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1004   Simplified Chinese mappings by Panjunyong.
1006 * docutils/readers/__init__.py:
1008   - Added universal.Decorations and universal.ExposeInternals
1009     transforms as default transforms for all readers.
1010   - Added ``ReReader`` base class for readers that reread an existing
1011     document tree.
1013 * docutils/readers/doctree.py: Added to project; a reader for existing
1014   document trees.
1016 * docutils/transforms/frontmatter.py:
1018   - Fixed the DocInfo transform to handle SVN-style expansion of the
1019     "Date" keyword.
1020   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1021     fields uniformly.
1023 * docutils/transforms/misc.py:
1025   - Added misc.Transitions transform, extracted from
1026     universal.FinalChecks.
1028 * docutils/transforms/references.py:
1030   - Added references.DanglingReferences transform, extracted from
1031     universal.FinalChecks.
1032   - Fixed bug with doubly-indirect substitutions.
1033   - Added footnote_reference classes attribute to "TargetNotes".
1034   - Fixed bug with circular substitution definitions that put Docutils
1035     into an infinite loop.
1037 * docutils/transforms/universal.py:
1039   - Added universal.ExposeInternals transform, extracted from
1040     universal.FinalChecks.
1041   - Removed universal.FinalChecks transform (logic has been moved to
1042     several new transforms).
1043   - Fixed bug with the "expose_internals" setting and Text nodes
1044     (exposed by the "rawsource" internal attribute).
1045   - Added the universal.StripComments transform, implementation of the
1046     "strip_comments" setting.
1048 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1049   transforms for writers.
1051   - Added ``Compound`` transform, which flattens compound paragraphs.
1053 * docutils/writers/: Several writer modules (html4css1.py) were
1054   converted into packages.  Support modules and data files have been
1055   moved into the packages.  The stylesheets for the HTML writers are
1056   now installed along with the code, the code knows where to find
1057   them, and the default is to use them (actually, to embed them).
1058   Some adjustments to configuration files may be necessary.  The
1059   easiest way to obtain the new default behavior is to remove all
1060   settings whose name includes "stylesheet".
1062 * docutils/writers/__init__.py:
1064   - Added universal.Messages and universal.FilterMessages transforms
1065     as default transforms for all writers.
1066   - Added ``UnfilteredWriter`` base class for writers that pass the
1067     document tree on unchanged.
1069 * docutils/writers/docutils_xml.py:
1071   - Made ``xmlcharrefreplace`` the default output encoding error
1072     handler.
1074 * docutils/writers/html4css1/:
1076   - Added support for image width and height units.
1077   - Made ``xmlcharrefreplace`` the default output encoding error
1078     handler.
1079   - Made ``--embed-stylesheet`` the default rather than
1080     ``--link-stylesheet``.
1081   - Moved "id" attribute from container (section etc.) to title's <a>
1082     tag, to be on the same tag as "name".
1083     (!!! To be reverted in Docutils 0.5.)
1084   - Added vertical space between fields of field lists.
1085   - Added ``--compact-field-lists`` option to remove vertical space in
1086     simple field lists.
1087   - Made cloaking of email addresses with ``--cloak-email-addresses``
1088     less obtrusive.
1089   - Fixed support for centered images.
1090   - Added support for class="compact" & class="open" lists.
1092 * docutils/writers/latex2e/:
1094   - Underscores in citekeys are no longer escaped.
1096 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1097   mapping of Unicode characters to LaTeX equivalents.
1099 * docutils/writers/s5_html/: Package added to project; writer for
1100   S5/HTML slide shows.
1102 * docs/dev/distributing.txt: Added to project; guide for distributors
1103   (package maintainers).
1105 * docs/dev/hacking.txt: Added to project; guide for developers.
1107 * docs/ref/doctree.txt:
1109   - Updated for plural attributes "classes", "ids", "names",
1110     "dupnames".
1111   - Added the "container" element.
1113 * docs/ref/docutils.dtd:
1115   - Updated for plural attributes "classes", "ids", "names",
1116     "dupnames".
1118 * docs/user/emacs.txt: Added to project; a document about Emacs
1119   support for reStructuredText and Docutils.
1121 * docs/user/links.txt: Added to project; lists of Docutils-related
1122   links.
1124 * docs/user/mailing-lists.txt: Added to project; information about
1125   Docutils-related mailing lists and how to access them.
1127 * docs/user/slide-shows.txt: Added to project; example of and docs for
1128   the S5/HTML writer (``rst2s5.py`` front end).
1130 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1131   Files", added to project.
1133 * test/coverage.sh: Added to project; test coverage script.
1135 * test/DocutilsTestSupport.py:
1137   - Added support for specifying runtime settings at the suite level.
1139 * test/test_functional.py:
1141   - Added the ``clear_output_directory`` function.
1142   - Added support for ``_test_more`` functions in functional test
1143     config files.
1145 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1147 * tools/rstpep2html.py: Renamed from pep.py.
1149 * tools/dev/create_unimap.py: Added to project; script to create the
1150   docutils/writers/unimap_latex.py mapping file.
1152 * tools/dev/profile_docutils.py: Added to project; profiler script.
1154 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1156 * tools/editors/emacs/restructuredtext.el,
1157   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1158   Removed from project; the functionality is now contained in rst.el.
1160 * tools/editors/emacs/rst.el: Added to project.  Added many features
1161   and fixed many bugs.  See docs/user/emacs.txt for details.
1163 * tools/stylesheets: Removed from project.  Stylesheets have been
1164   renamed and moved into writer packages.
1167 Release 0.3.9 (2005-05-26)
1168 ==========================
1170 * General:
1172   - Eliminated and replaced all uses of the old string attributes
1173     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1174     new list attributes ``ids``, ``names``, ``dupnames`` and
1175     ``classes`` throughout the whole source tree.
1177 * docutils/core.py:
1179   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1180     allowing for easier debugging.
1181   - In ``Publisher.publish()``, expanded the generic top-level
1182     exception catching.
1184 * docutils/examples.py:
1186   - Added ``internals`` function for exploration.
1188 * docutils/io.py:
1190   - Fixed ``Input.decode`` method to apply heuristics only if no
1191     encoding is explicitly given, and to provide better reporting of
1192     decoding errors.
1193   - The ``Input.decode`` method now removes byte order marks (BOMs)
1194     from input streams.
1196 * docutils/nodes.py:
1198   - ``image`` element class changed to subclass of Element, not
1199     TextElement (it's an empty element, and cannot contain text).
1200   - Added ``attr_defaults`` dictionary for default attribute values.
1201   - Added empty list as default value for the following attributes:
1202     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1203   - Added ``document.decoration`` attribute,
1204     ``document.get_decoration`` method, and ``decoration.get_header``
1205     & ``.get_footer`` methods.
1206   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1207     methods.
1209 * docutils/utils.py:
1211   - Removed ``docutils.utils.Reporter.categories``,
1212     ``docutils.utils.ConditionSet``, and all references to them, to
1213     simplify error reporting.
1215 * docutils/languages/nl.py: Added to project; Dutch mappings by
1216   Martijn Pieters.
1218 * docutils/parsers/rst/__init__.py:
1220   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1222 * docutils/parsers/rst/states.py:
1224   - Added check for escaped at-mark to prevent email address recognition.
1225   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1226     arguments>``.
1227   - Allowed whitespace in paths and URLs.
1228   - Added auto-enumerated list items.
1229   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1230     followed by text.
1231   - Added support for table stub columns.
1233 * docutils/parsers/rst/directives/__init__.py:
1235   - Allowed whitespace in paths (``path`` function).
1236   - Added ``uri`` directive option conversion function.
1238 * docutils/parsers/rst/directives/body.py:
1240   - Fixed illegal context bug with "topic" directive (allowed within
1241     sidebars; not within body elements).
1243 * docutils/parsers/rst/directives/images.py:
1245   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1246   - Added support for the ``file_insertion_enabled`` setting in the
1247     "figure" directive (disables "figwidth" option).
1248   - "image" directive: added checks for valid values of "align" option,
1249     depending on context.  "figure" directive: added specialized
1250     "align" option and attribute on "figure" element.
1251   - Made ":figwidth: image" option of "figure" directive work again.
1252   - Fixed bug with reference names containing uppercase letters
1253     (e.g. ``Name_``) in "target" option of "image" directive.
1255 * docutils/parsers/rst/directives/misc.py:
1257   - Fixed "include" and "raw" directives to catch text decoding
1258     errors.
1259   - Allowed whitespace in "include" & "raw" directive paths.
1260   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1261     settings in "include" & "raw" directives.
1263 * docutils/parsers/rst/directives/parts.py:
1265   - Added "header" & "footer" directives.
1266   - Fixed illegal context bug with "contents" directive (topics
1267     allowed within sidebars; not within body elements).
1269 * docutils/parsers/rst/directives/tables.py:
1271   - Added "list-table" directive.
1272   - Caught empty CSV table bug.
1273   - Added support for the ``file_insertion_enabled`` setting in the
1274     "csv-table" directive.
1275   - Added ``stub-columns`` option to "csv-table" and "list-table"
1276     directives.
1278 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1279   mappings by Martijn Pieters.
1281 * docutils/readers/standalone.py:
1283   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1284     options to activate or deactivate the SectSubTitle transform.
1286 * docutils/transforms/frontmatter.py:
1288   - Added SectSubTitle transform to promote titles of lone
1289     subsections to subtitles.
1291 * docutils/transforms/references.py:
1293   - Fixed mislocated internal targets bug, by propagating internal
1294     targets to the next node, making use of the newly added support
1295     for multiple names and IDs.
1296   - Fixed duplicate footnote label bug.
1297   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1298     transform.
1300 * docutils/writers/html4css1.py:
1302   - Fixed unencoded stylesheet reference bug (characters like "&" in
1303     stylesheet references).
1304   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1305     tags).
1306   - Added support for multiple IDs per node by creating empty ``span``
1307     tags.
1308   - Added the ``field_name_limit`` & ``option_limit`` settings &
1309     support.
1310   - Added support for table stub columns.
1311   - Added support for the ``align`` attribute on ``figure`` elements.
1312   - Added the ``cloak_email_addresses`` setting & support.
1313   - Added ``html_prolog``, ``html_head``, ``html_body``,
1314     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1315     ``docutils.core.publish_parts``.
1316   - Added support for section subtitles.
1318 * docutils/writers/latex2e.py:
1320   - Fixed tables starting with more than one multirow cell.
1321   - Improved --use-latex-docinfo so that organization/contact/address
1322     fields are lumped with the last author field and appear on the
1323     titlepage.
1324   - Made sure the titlepage is always shown with --use-latex-docinfo,
1325     even if the document has no title.
1326   - Made sure that latex doesn't fill in today's date if no date field
1327     was given.
1328   - Added support for section subtitles.
1330 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1331   (under development).
1333 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1335 * docs/api/publisher.txt:
1337   - Added "``publish_parts`` Details" section.
1339 * docutils/dev/repository.txt: Added to project; information about the
1340   Docutils Subversion repository.
1342 * docs/ref/docutils.dtd:
1344   - Added a ``stub`` attribute to the ``colspec`` element via the
1345     ``tbl.colspec.att`` parameter entity.
1346   - Allowed topic elements within sidebars
1347   - Added an ``align`` attribute to the ``figure`` element.
1349 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1350   writer.
1353 Release 0.3.7 (2004-12-24)
1354 ==========================
1356 * docutils/frontend.py:
1358   - Added options: --input-encoding-error-handler,
1359     --record-dependencies, --leave-footnote-reference-space,
1360     --strict-visitor.
1361   - Added command-line and config file support for "overrides" setting
1362     parameter.
1364 * docutils/io.py:
1366   - Added support for input encoding error handler.
1368 * docutils/nodes.py:
1370   - Added dispatch_visit and dispatch_departure methods to
1371     NodeVisitor; useful as a hook for Visitors.
1372   - Changed structure of ``line_block``; added ``line``.
1373   - Added ``compound`` node class.
1374   - Added a mechanism for Visitors to transitionally ignore new node
1375     classes.
1377 * docutils/utils.py:
1379   - Moved ``escape2null`` and ``unescape`` functions from
1380     docutils/parsers/rst/states.py.
1382 * docutils/parsers/rst/roles.py:
1384   - Added "raw" role.
1385   - Changed role function API: the "text" parameter now takes
1386     null-escaped interpreted text content.
1388 * docutils/parsers/rst/states.py:
1390   - Fixed bug where a "role" directive in a nested parse would crash
1391     the parser; the state machine's "language" attribute was not being
1392     copied over.
1393   - Added support for line block syntax.
1394   - Fixed directive parsing bug: argument-less directives didn't
1395     notice that arguments were present.
1396   - Removed error checking for transitions.
1397   - Added support for multiple classifiers in definition list items.
1398   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1399   - Changed role function API: the "text" parameter now takes
1400     null-escaped interpreted text content.
1401   - Empty sections and documents are allowed now.
1403 * docutils/parsers/rst/directives/__init__.py:
1405   - Added ``encoding`` directive option conversion function.
1406   - Allow multiple class names in class_option conversion function.
1408 * docutils/parsers/rst/directives/body.py:
1410   - Converted the line-block directive to use the new structure.
1411   - Extracted the old line-block functionality to the ``block``
1412     function (still used).
1413   - Added ``compound`` directive (thanks to Lea Wiemann).
1415 * docutils/parsers/rst/directives/misc.py:
1417   - Added "encoding" option to "include" and "raw" directives.
1418   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1419   - Allow multiple class names in the "class" directive.
1421 * docutils/parsers/rst/directives/parts.py:
1423   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1424     options.  Thanks to Lele Gaifax.
1426 * docutils/parsers/rst/directives/tables.py:
1428   - Added "encoding" directive to "csv-table" directive.
1429   - Added workaround for lack of Unicode support in csv.py, for
1430     non-ASCII CSV input.
1432 * docutils/transforms/misc.py:
1434   - Fixed bug when multiple "class" directives are applied to a single
1435     element.
1436   - Enabled multiple format names for "raw" directive.
1438 * docutils/transforms/references.py:
1440   - Added support for trimming whitespace from beside substitution
1441     references.
1443 * docutils/transforms/universal.py:
1445   - FinalChecks now checks for illegal transitions and moves
1446     transitions between sections.
1448 * docutils/writers/html4css1.py:
1450   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1451   - "stylesheet" and "stylesheet_path" settings are now mutually
1452     exclusive.
1453   - Added support for the new line_block/line structure.
1454   - --footnote-references now overrides
1455     --trim-footnote-reference-space, if applicable.
1456   - Added support for ``compound`` elements.
1457   - Enabled multiple format names for "raw" directive.
1458   - ``<p>`` tags of a paragraph which is the only visible child of the
1459     document node are no longer stripped.
1460   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1461     new method ``should_be_compact_paragraph()``.
1462   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1463     elements.
1464   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1465     the output if they have their ``class`` attribute set.
1466   - The whole document is now surrounded by a ``<div
1467     class="document">`` element.
1468   - Body-level images are now wrapped by their own ``<div>`` elements,
1469     with image classes copied to the wrapper, and for images which
1470     have the ``:align:`` option set, the surrounding ``<div>`` now
1471     receives a class attribute (like ``class="align-left"``).
1473 * docutils/writers/latex2e.py:
1475   - no newline after depart_term.
1476   - Added translations for some Unicode quotes.
1477   - Added option "font-encoding", made package AE the default.
1478   - "stylesheet" and "stylesheet_path" settings are now mutually
1479     exclusive.
1480   - --footnote-references now overrides
1481     --trim-footnote-reference-space, if applicable.
1482   - The footnote label style now matches the footnote reference style
1483     ("brackets" or "superscript").
1484   - Added support for ``compound`` elements.
1485   - Enabled multiple format names for "raw" directive.
1487 * docs/ref/docutils.dtd:
1489   - Changed structure of the ``line_block`` element; added ``line``.
1490   - Added ``compound`` element.
1491   - Added "ltrim" and "rtrim" attributes to
1492     ``substitution_definition`` element.
1493   - Enabled multiple format names for ``raw`` element.
1494   - Enabled multiple classifiers in ``definition_list_item`` elements.
1496 * docs/ref/rst/directives.txt
1498   - Marked "line-block" as deprecated.
1499   - "Class" directive now allows multiple class names.
1500   - Added "Rationale for Class Attribute Value Conversion".
1501   - Added warning about "raw" overuse/abuse.
1503 * docs/ref/rst/restructuredtext.txt:
1505   - Added syntax for line blocks.
1506   - Definition list items may have multiple classifiers.
1508 * docs/ref/rst/roles.txt:
1510   - Added "raw" role.
1512 * tools/stylesheets/default.css:
1514   - Added support for the new line_block structure.
1515   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1518 Release 0.3.5 (2004-07-29)
1519 ==========================
1521 General:
1523 * _`Documentation cleanup/reorganization`.
1525   - Created new subdirectories of docs/:
1527     * ``docs/user/``: introductory/tutorial material for end-users
1528     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1529     * ``docs/api/``: API reference material for client-developers
1530     * ``docs/ref/``: reference material for all groups
1531     * ``docs/howto/``: for component-developers and core-developers
1532     * ``docs/peps/``: Python Enhancement Proposals
1534   - Moved ``docs/*`` to ``docs/user/``.
1535   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1536     ``spec/`` to ``docs/dev``.
1537   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1538     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1539   - Moved ``alternatives.txt``, and ``problems.txt`` from
1540     ``spec/rst/`` to ``docs/dev/rst/``.
1541   - Moved ``reStructuredText.txt``, ``directives.txt``,
1542     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1543     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1544     ``roles.txt``, ``reStructuredText.txt`` to
1545     ``restructuredtext.txt``.
1546   - Moved ``spec/howto/`` to ``docs/howto``.
1548   In order to keep the CVS history of moved files, we supplied
1549   SourceForge with a `script for modifying the Docutils CVS
1550   repository`__.
1552   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1554   After running the cleanup script:
1556   - Added ``docs/index.txt``.
1557   - Added a ``.htaccess`` file to the ``web`` module, containing
1558     redirects for all old paths to new paths.  They'll preserve
1559     fragments (the "#name" part of a URL), and won't clutter up the
1560     file system, and will correct the URL in the user's browser.
1561   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1562     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1563     the "To Do" list itself in ``docs/dev/todo.txt``.
1564   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1565     section of ``docs/dev/todo.txt``.
1566   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1567   - Added "How To Report Bugs" to ``BUGS.txt``.
1568   - Went through all the sources and docs (including under web/) and
1569     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1570     (Still need to update links in the sandboxes.)
1572 Specific:
1574 * BUGS.txt: Added to project.
1576 * THANKS.txt: Added to project.
1578 * docutils/__init__.py:
1580   - 0.3.4: Post-release.
1582 * docutils/core.py:
1584   - Added special error handling & advice for UnicodeEncodeError.
1585   - Refactored Publisher.publish (simplified exception handling &
1586     extracted debug dumps).
1587   - Renamed "enable_exit" parameter of convenience functions to
1588     "enable_exit_status".
1589   - Enabled traceback (exception propagation) by default in
1590     programmatic convenience functions.
1591   - Now publish_file and publish_cmdline convenience functions return
1592     the encoded string results in addition to their regular I/O.
1593   - Extracted common code from publish_file, publish_string, and
1594     publish_parts, into new publish_programmatically.  Extracted
1595     settings code to ``Publisher.process_programmatic_settings``.
1596   - In Publisher.publish, disabled ``settings_overrides`` when
1597     ``settings`` is supplied; redundant.
1599 * docutils/frontend.py:
1601   - Added help text for "--output-encoding-error-handler" and
1602     "--error-encoding-error-handler".
1603   - Renamed "--exit" to "--exit-status".
1604   - Simplified default-setting code.
1606 * docutils/parsers/rst/__init__.py:
1608   - Added "--pep-base-url" and "--rfc-base-url" options.
1610 * docutils/parsers/rst/states.py:
1612   - Made URI recognition more aggressive and intelligent.
1614 * docutils/parsers/rst/directives/__init__.py:
1616   - Added several directive option conversion functions.
1618 * docutils/parsers/rst/directives/body.py:
1620   - Moved "table" directive to tables.py.
1622 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1623   added to project.
1625 * docutils/writers/latex2e.py:
1627   - Added "--table-style=(standard|booktabs|nolines)"
1628   - figures get "here" option (LaTeX per default puts them at bottom),
1629     and figure content is centered.
1630   - Rowspan support for tables.
1631   - Fix: admonition titles before first section.
1632   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1633   - Replave ``_`` in literal by an underlined blank, because it has the correct
1634     width.
1635   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1636   - A few unicode replacements, if output_encoding != utf
1637   - Add "--graphicx-option".
1638   - Indent literal-blocks.
1639   - Fix: omit ``\maketitle`` when there is no document title.
1641 * docs/index.txt: "Docutils Project Documentation Overview", added to
1642   project.
1644 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1645   Tool", added to project.
1647 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1649 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1651 * docs/dev/policies.txt: Added to project (extracted from
1652   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1654 * docs/dev/release.txt: Added to project (extracted from
1655   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1657 * docs/dev/testing.txt: Added to project.
1659 * docs/dev/website.txt: Added to project (extracted from
1660   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1662 * docs/ref/rst/directives.txt:
1664   - Added directives: "table", "csv-table".
1666 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1667   added to project.  1 page for syntax, and a 1 page reference for
1668   directives and roles.  Source text to be used as-is; not meant to be
1669   converted to HTML.
1671 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1672   with a change of title.
1674 * test/functional/, contents, and test/test_functional.py: Added to
1675   project.
1677 * tools/buildhtml.py: Fixed bug with config file handling.
1679 * tools/html.py: Removed from project (duplicate of rst2html.py).
1681 * tools/pep2html.py: Removed from project (duplicate of Python's
1682   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1683   Docutils-related PEPs in docs/peps/).
1685 * tools/rst2pseudoxml.py: Renamed from publish.py.
1687 * tools/rst2xml.py: Renamed from docutils-xml.py.
1689 * tools/test.txt: Removed from project; moved to
1690   docs/user/rst/demo.txt.
1692 * setup.py: Now also installs ``rst2latex.py``.
1695 Release 0.3.3 (2004-05-09)
1696 ==========================
1698 * docutils/__init__.py:
1700   - 0.3.1: Reorganized config file format (multiple sections); see
1701     docs/config.txt.
1702   - Added unknown_reference_resolvers attribute to TransformSpec.
1703   - 0.3.2: Interpreted text reorganization.
1704   - 0.3.3: Released.
1706 * docutils/core.py:
1708   - Catch system messages to stop tracebacks from parsing errors.
1709   - Catch exceptions during processing report & exit without
1710     tracebacks, except when "--traceback" used.
1711   - Reordered components for OptionParser; application comes last.
1712   - Added "config_section" parameter to several methods and functions,
1713     allowing front ends to easily specify their config file sections.
1714   - Added publish_parts convenience function to allow access to individual
1715     parts of a document.
1717 * docutils/examples.py: Added to project; practical examples of
1718   Docutils client code, to be used as-is or as models for variations.
1720 * docutils/frontend.py:
1722   - Added "--traceback" & "--no-traceback" options ("traceback"
1723     setting).
1724   - Implemented support for config file reorganization:
1725     ``standard_config_files`` moved from ``ConfigParser`` to
1726     ``OptionParser``; added
1727     ``OptionParser.get_config_file_settings()`` and
1728     ``.get_standard_config_settings()``; support for old "[options]"
1729     section (with deprecation warning) and mapping from old to new
1730     settings.
1731   - Reimplemented setting validation.
1732   - Enabled flexible boolean values: yes/no, true/false, on/off.
1733   - Added ``Values``, a subclass of ``optparse.Values``, with support
1734     for list setting attributes.
1735   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1736     thanks to Beni Cherniavsky.
1737   - Added "--no-section-numbering" option.
1739 * docutils/io.py:
1741   - Catch IOErrors when opening source & destination files, report &
1742     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1743     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1745 * docutils/nodes.py:
1747   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1748     method definitions (via ``exec``) to dynamic assignments (via
1749     ``setattr``); thanks to Roman Suzi.
1750   - Encapsulated visitor dynamic assignments in a function; thanks to
1751     Ian Bicking.
1752   - Added indirect_reference_name attribute to the Targetable
1753     class. This attribute holds the whitespace_normalized_name
1754     (contains mixed case) of a target.
1756 * docutils/statemachine.py:
1758   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1759   - Added ``StringList.get_2D_block``.
1761 * docutils/utils.py:
1763   - Added "level" attribute to SystemMessage exceptions.
1765 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1766   Jannie Hofmeyr.
1768 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1769   Blaha.
1771 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1772   Marcelo Huerta San Martin.
1774 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1775   mappings by Lalo Martins.
1777 * docutils/languages/ru.py: Added to project; Russian mappings by
1778   Roman Suzi.
1780 * docutils/parsers/rst/roles.py: Added to project.  Contains
1781   interpreted text role functions, a registry for interpreted text
1782   roles, and an API for adding to and retrieving from the registry.
1783   Contributed by Edward Loper.
1785 * docutils/parsers/rst/states.py:
1787   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1788   - Allowed true em-dash character and "---" as block quote
1789     attribution marker.
1790   - Added support for <angle-bracketed> complex option arguments
1791     (option lists).
1792   - Fixed handling of backslashes in substitution definitions.
1793   - Fixed off-by-1 error with extra whitespace after substitution
1794     definition directive.
1795   - Added inline markup parsing to field lists' field names.
1796   - Added support for quoted (and unindented) literal blocks.
1797     Driven in part by a bribe from Frank Siebenlist (thanks!).
1798   - Parser now handles escapes in URIs correctly.
1799   - Made embedded-URIs' reference text omittable.  Idea from Beni
1800     Cherniavsky.
1801   - Refactored explicit target processing code.
1802   - Added name attribute to references containing the reference name only
1803     through whitespace_normalize_name (no case changes).
1804   - parse_target no longer returns the refname after going through
1805     normalize_name. This is now handled in make_target.
1806   - Fixed bug relating to role-less interpreted text in non-English
1807     contexts.
1808   - Reorganized interpreted text processing; moved code into the new
1809     roles.py module.  Contributed by Edward Loper.
1810   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1811     ``parse_directive_block``.
1813 * docutils/parsers/rst/tableparser.py:
1815   - Reworked for ``StringList``, to support "include" directives in
1816     table cells.
1818 * docutils/parsers/rst/directives/__init__.py:
1820   - Renamed ``unchanged()`` directive option conversion function to
1821     ``unchanged_required``, and added a new ``unchanged``.
1822   - Catch unicode value too high error; fixes bug 781766.
1823   - Beefed up directive error reporting.
1825 * docutils/parsers/rst/directives/body.py:
1827   - Added basic "table" directive.
1829 * docutils/parsers/rst/directives/images.py:
1831   - Added "target" option to "image" directive.
1832   - Added name attribute to references containing the reference name only
1833     through whitespace_normalize_name (no case changes).
1835 * docutils/parsers/rst/directives/misc.py:
1837   - Isolated the import of the ``urllib2`` module; was causing
1838     problems on SourceForge (``libssl.so.2`` unavailable?).
1839   - Added the "role" directive for declaring custom interpreted text
1840     roles.
1842 * docutils/parsers/rst/directives/parts.py:
1844   - The "contents" directive does more work up-front, creating the
1845     "topic" and "title", and leaving the "pending" node for the
1846     transform.  Allows earlier reference resolution; fixes subtle bug.
1848 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1849   mappings by Jannie Hofmeyr.
1851 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1852   mappings by Marek Blaha.
1854 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1855   mappings by Marcelo Huerta San Martin.
1857 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1858   Portuguese mappings by Lalo Martins.
1860 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1861   mappings by Roman Suzi.
1863 * docutils/transforms/parts.py:
1865   - The "contents" directive does more work up-front, creating the
1866     "topic" and "title", and leaving the "pending" node for the
1867     transform.  Allows earlier reference resolution; fixes subtle bug.
1868   - Added support for disabling of section numbering.
1870 * docutils/transforms/references.py:
1872   - Verifying that external targets are truly targets and not indirect
1873     references. This is because we are now adding a "name" attribute to
1874     references in addition to targets. Note sure if this is correct!
1875   - Added code to hook into the unknown_reference_resolvers list for a
1876     transformer in resolve_indirect_target. This allows the
1877     unknown_reference_resolvers to keep around indirect targets which
1878     docutils doesn't know about.
1879   - Added specific error message for duplicate targets.
1881 * docutils/transforms/universal.py:
1883   - Added FilterMessages transform (removes system messages below the
1884     verbosity threshold).
1885   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1886     to FinalCheckVisitor for application-specific handling of
1887     unresolvable references.
1888   - Added specific error message for duplicate targets.
1890 * docutils/writers/__init__.py:
1892   - Added assemble_parts method to the Writer class to allow for
1893     access to a documents individual parts.
1894   - Documented & set default for ``Writer.output`` attribute.
1896 * docutils/writers/html4css1.py:
1898   - Fixed unicode handling of attribute values (bug 760673).
1899   - Prevent duplication of "class" attribute values (bug report from
1900     Kirill Lapshin).
1901   - Improved table grid/border handling (prompted by report from Bob
1902     Marshall).
1903   - Added support for table titles.
1904   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1905     to Darek Suchojad.
1906   - Added functionality to keep track of individual parts of a document
1907     and store them in a dictionary as the "parts" attribute of the writer.
1908     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1909   - Added proper support for the "scale" attribute of the "image"
1910     element.  Contributed by Brent Cook.
1911   - Added ``--initial-header-level`` option.
1912   - Fixed bug: the body_pre_docinfo segment depended on there being a
1913     docinfo; if no docinfo, the document title was incorporated into
1914     the body segment.  Adversely affected the publish_parts interface.
1916 * docutils/writers/latex2e.py:
1918   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1919     about a missing file.
1920   - Added options and support: ``--compound-enumerators``,
1921     ``--section-prefix-for-enumerators``, and
1922     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1923     934322).
1924   - Added option ``--use-verbatim-when-possible``, to avoid
1925     problematic characters (eg, '~' in italian) in literal blocks.
1926   - It's now possible to use four section levels in the `book` and
1927     `report` LaTeX classes.  The default `article` class still has
1928     three levels limit.
1930 * docs/config.txt: "Docutils Configuration Files", added to project.
1931   Moved config file entry descriptions from tools.txt.
1933 * docs/tools.txt:
1935   - Moved config file entry descriptions to config.txt.
1937 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1938   Development".
1940 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1941   Text Roles", added to project.
1943 * spec/rst/reStructuredText.txt:
1945   - Added description of support for <angle-bracketed> complex option
1946     arguments to option lists.
1947   - Added subsections for indented and quoted literal blocks.
1949 * test: Continually adding & updating tests.
1951   - Added test/test_settings.py & test/data/config_*.txt support
1952     files.
1953   - Added test/test_writers/test_htmlfragment.py.
1955 * test/DocutilsTestSupport.py:
1957   - Refactored LaTeX publisher test suite/case class names to make
1958     testing other writers easier.
1959   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1960     to test the processing of HTML fragments which use the new
1961     publish_parts convenience function.
1963 * tools/buildhtml.py:
1965   - Added support for the "--prune" option.
1966   - Removed dependency on pep2html.py; plaintext PEPs no longer
1967     supported.
1969 * tools/docutils.conf:
1971   - Updated for configuration file reorganization.
1973 * tools/rst2html.py:
1975   - copied from tools/html.py
1977 * setup.py:
1979   - added a 'scripts' section to configuration
1980   - added 'tools/rst2html.py' to the scripts section
1983 Release 0.3 (2003-06-24)
1984 ========================
1986 General:
1988 * Renamed "attribute" to "option" for directives/extensions.
1990 * Renamed transform method "transform" to "apply".
1992 * Renamed "options" to "settings" for runtime settings (as set by
1993   command-line options).  Sometimes "option" (singular) became
1994   "settings" (plural).  Some variations below:
1996   - document.options -> document.settings (stored in other objects as
1997     well)
1998   - option_spec -> settings_spec (not directives though)
1999   - OptionSpec -> SettingsSpec
2000   - cmdline_options -> settings_spec
2001   - relative_path_options -> relative_path_settings
2002   - option_default_overrides -> settings_default_overrides
2003   - Publisher.set_options -> Publisher.get_settings
2005 Specific:
2007 * COPYING.txt: Added "Public Domain Dedication".
2009 * FAQ.txt: Frequently asked questions, added to project.
2011 * setup.py:
2013   - Updated with PyPI Trove classifiers.
2014   - Conditional installation of third-party modules.
2016 * docutils/__init__.py:
2018   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2019   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2020   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2021   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2022     option and its effect on the PEP template & writer.
2023   - Bumped version to 0.2.4 due to changes to the PEP template &
2024     stylesheet.
2025   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2026   - Added ``TransformSpec`` class for new transform system.
2027   - Bumped version to 0.2.6 for API changes (renaming).
2028   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2029     convenience functions.
2030   - Added ``Component.component_type`` attribute.
2031   - Bumped version to 0.2.8 because of the internal parser switch from
2032     plain lists to the docutils.statemachine.StringList objects.
2033   - Bumped version to 0.2.9 because of the frontend.py API changes.
2034   - Bumped version to 0.2.10 due to changes to the project layout
2035     (third-party modules removed from the "docutils" package), and
2036     signature changes in ``io.Input``/``io.Output``.
2037   - Changed version to 0.3.0 for release.
2039 * docutils/core.py:
2041   - Made ``publish()`` a bit more convenient.
2042   - Generalized ``Publisher.set_io``.
2043   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2044     parameters; improved its docstring.
2045   - Added ``publish_file()`` and ``publish_string()``.
2046   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2047     out of ``.set_io``.
2048   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2049     "--dump-transforms" hidden options.
2050   - Added ``Publisher.apply_transforms()`` method.
2051   - Added ``Publisher.set_components()`` method; support for
2052     ``publish_*()`` conveninece functions.
2053   - Moved config file processing to docutils/frontend.py.
2054   - Added support for exit status ("exit_level" setting &
2055     ``enable_exit`` parameter for Publisher.publish() and convenience
2056     functions).
2058 * docutils/frontend.py:
2060   - Check for & exit on identical source & destination paths.
2061   - Fixed bug with absolute paths & "--config".
2062   - Set non-command-line defaults in ``OptionParser.__init__()``:
2063     ``_source`` & ``_destination``.
2064   - Distributed ``relative_path_settings`` to components; updated
2065     ``OptionParser.populate_from_components()`` to combine it all.
2066   - Require list of keys in ``make_paths_absolute`` (was implicit in
2067     global ``relative_path_settings``).
2068   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2069     "--dump-settings", and "--dump-transforms" hidden options.
2070   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2071     code, replaced with correct code.
2072   - Added validation functionality for config files.
2073   - Added "--error-encoding" option/setting, "_disable_config"
2074     internal setting.
2075   - Added encoding validation; updated "--input-encoding" and
2076     "--output-encoding"; added "--error-encoding-error-handler" and
2077     "--output-encoding-error-handler".
2078   - Moved config file processing from docutils/core.py.
2079   - Updated ``OptionParser.populate_from_components`` to handle new
2080     ``SettingsSpec.settings_defaults`` dict.
2081   - Added support for "-" => stdin/stdout.
2082   - Added "exit_level" setting ("--exit" option).
2084 * docutils/io.py:
2086   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2087   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2088   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2089   - ``FileOutput.write()`` now returns the encoded output string.
2090   - Try to get path/stream name automatically in ``FileInput`` &
2091     ``FileOutput``.
2092   - Added defaults for source & destination paths.
2093   - Allow for Unicode I/O with an explicit "unicode" encoding.
2094   - Added ``Output.encode()``.
2095   - Removed dependency on runtime settings; pass encoding directly.
2096   - Recognize Unicode strings in ``Input.decode()``.
2097   - Added support for output encoding error handlers.
2099 * docutils/nodes.py:
2101   - Added "Invisible" element category class.
2102   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2103     modification during a traversal.
2104   - Added element classes: ``line_block``, ``generated``, ``address``,
2105     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2106     ``superscript``, ``subscript``, ``inline``
2107   - Added support for lists of nodes to ``Element.insert()``.
2108   - Fixed parent linking in ``Element.replace()``.
2109   - Added new abstract superclass ``FixedTextElement``; adds
2110     "xml:space" attribute.
2111   - Added support for "line" attribute of ``system_message`` nodes.
2112   - Added support for the observer pattern from ``utils.Reporter``.
2113     Added ``parse_messages`` and ``transform_messages`` attributes to
2114     ``document``, removed ``messages``.  Added ``note_parse_message``
2115     and ``note_transform_message`` methods.
2116   - Added support for improved diagnostics:
2118     - Added "document", "source", and "line" internal attributes to
2119       ``Node``, set by ``Node.setup_child()``.
2120     - Converted variations on ``node.parent = self`` to
2121       ``self.setup_child(node)``.
2122     - Added ``document.current_source`` & ``.current_line``
2123       attributes, and ``.note_source`` observer method.
2124     - Changed "system_message" output to GNU-Tools format.
2126   - Added a "rawsource" attribute to the ``Text`` class, for text
2127     before backslash-escape resolution.
2128   - Support for new transform system.
2129   - Reworked ``pending`` element.
2130   - Fixed XML DOM bug (SF #660611).
2131   - Removed the ``interpeted`` element class and added
2132     ``title_reference``, ``abbreviation``, ``acronym``.
2133   - Made substitutions case-sensitive-but-forgiving; moved some code
2134     from the parser.
2135   - Fixed Unicode bug on element attributes (report: William Dode).
2137 * docutils/optik.py: Removed from project; replaced with
2138   extras/optparse.py and extras/textwrap.py.  These will be installed
2139   only if they're not already present in the Python installation.
2141 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2142   only if it's not already present in the Python installation.
2144 * docutils/statemachine.py:
2146   - Factored out ``State.add_initial_transitions()`` so it can be
2147     extended.
2148   - Converted whitespace-specific "blank" and "indent" transitions
2149     from special-case code to ordinary transitions: removed
2150     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2151     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2152     ``ws_initial_transitions`` attributes.
2153   - Removed ``State.match_transition()`` after merging it into
2154     ``.check_line()``.
2155   - Added ``StateCorrection`` exception.
2156   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2157     (moved ``TransitionCorrection`` support there too.)
2158   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2159     ``EOFError`` instead of ``IndexError``.
2160   - Added ``State.no_match`` method.
2161   - Added support for the Observer pattern, triggered by input line
2162     changes.
2163   - Added ``strip_top`` parameter to
2164     ``StateMachineWS.get_first_known_indented``.
2165   - Made ``context`` a parameter to ``StateMachine.run()``.
2166   - Added ``ViewList`` & ``StringList`` classes;
2167     ``extract_indented()`` becomes ``StringList.get_indented()``.
2168   - Added ``StateMachine.insert_input()``.
2169   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2170     thanks to) Fred Drake.
2172 * docutils/utils.py:
2174   - Added a ``source`` attribute to Reporter instances and
2175     ``system_message`` elements.
2176   - Added an observer pattern to ``utils.Reporter`` to keep track of
2177     system messages.
2178   - Fixed bugs in ``relative_path()``.
2179   - Added support for improved diagnostics.
2180   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2181   - Added support for encoding Reporter stderr output, and encoding
2182     error handlers.
2183   - Reporter keeps track of the highest level system message yet
2184     generated.
2186 * docutils/languages: Fixed bibliographic field language lookups.
2188 * docutils/languages/es.py: Added to project; Spanish mappings by
2189   Marcelo Huerta San Martin.
2191 * docutils/languages/fr.py: Added to project; French mappings by
2192   Stefane Fermigier.
2194 * docutils/languages/it.py: Added to project; Italian mappings by
2195   Nicola Larosa.
2197 * docutils/languages/sk.py: Added to project; Slovak mappings by
2198   Miroslav Vasko.
2200 * docutils/parser/__init__.py:
2202   - Added ``Parser.finish_parse()`` method.
2204 * docutils/parser/rst/__init__.py:
2206   - Added options: "--pep-references", "--rfc-references",
2207     "--tab-width", "--trim-footnote-reference-space".
2209 * docutils/parsers/rst/states.py:
2211   - Changed "title under/overline too short" system messages from INFO
2212     to WARNING, and fixed its insertion location.
2213   - Fixed enumerated list item parsing to allow paragraphs & section
2214     titles to begin with enumerators.
2215   - Converted system messages to use the new "line" attribute.
2216   - Fixed a substitution reference edge case.
2217   - Added support for "--pep-references" and "--rfc-references"
2218     options; reworked ``Inliner`` code to make customization easier.
2219   - Removed field argument parsing.
2220   - Added support for short section title over/underlines.
2221   - Fixed "simple reference name" regexp to ignore text like
2222     "object.__method__"; not an anonymous reference.
2223   - Added support for improved diagnostics.
2224   - Reworked directive API, based on Dethe Elza's contribution.  Added
2225     ``Body.parse_directive()``, ``.parse_directive_options()``,
2226     ``.parse_directive_arguments()`` methods.
2227   - Added ``ExtensionOptions`` class, to parse directive options
2228     without parsing field bodies.  Factored
2229     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2230     ``ExtensionOptions``.
2231   - Improved definition list term/classifier parsing.
2232   - Added warnings for unknown directives.
2233   - Renamed ``Stuff`` to ``Struct``.
2234   - Now flagged as errors: transitions at the beginning or end of
2235     sections, empty sections (except title), and empty documents.
2236   - Updated for ``statemachine.StringList``.
2237   - Enabled recognition of schemeless email addresses in targets.
2238   - Added support for embedded URIs in hyperlink references.
2239   - Added backslash-escapes to inline markup end-string suffix.
2240   - Added support for correct interpreted text processing.
2241   - Fixed nested title parsing (topic, sidebar directives).
2242   - Added special processing of backslash-escaped whitespace (idea
2243     from David Abrahams).
2244   - Made substitutions case-sensitive-but-forgiving; moved some code
2245     to ``docutils.nodes``.
2246   - Added support for block quote attributions.
2247   - Added a kludge to work-around a conflict between the bubble-up
2248     parser strategy and short titles (<= 3 char-long over- &
2249     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2250     titles" submitted by Jason Diamond.
2251   - Added explicit interpreted text roles for standard inline markup:
2252     "emphasis", "strong", "literal".
2253   - Implemented "superscript" and "subscript" interpreted text roles.
2254   - Added initial support for "abbreviation" and "acronym" roles;
2255     incomplete.
2256   - Added support for "--trim-footnote-reference-space" option.
2257   - Optional space before colons in directives & hyperlink targets.
2259 * docutils/parsers/rst/tableparser.py:
2261   - Fixed a bug that was producing unwanted empty rows in "simple"
2262     tables.
2263   - Detect bad column spans in "simple" tables.
2265 * docutils/parsers/rst/directives: Updated all directive functions to
2266   new API.
2268 * docutils/parsers/rst/directives/__init__.py:
2270   - Added ``flag()``, ``unchanged()``, ``path()``,
2271     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2272     directive option helper functions.
2273   - Added warnings for unknown directives.
2274   - Return ``None`` for missing directives.
2275   - Added ``register_directive()``, thanks to William Dode and Paul
2276     Moore.
2278 * docutils/parsers/rst/directives/admonitions.py:
2280   - Added "admonition" directive.
2282 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2283   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2284   "parsed-literal", "rubric", "epigraph", "highlights" and
2285   "pull-quote" directives.
2287 * docutils/parsers/rst/directives/images.py:
2289   - Added an "align" attribute to the "image" & "figure" directives
2290     (by Adam Chodorowski).
2291   - Added "class" option to "image", and "figclass" to "figure".
2293 * docutils/parsers/rst/directives/misc.py:
2295   - Added "include", "raw", and "replace" directives, courtesy of
2296     Dethe Elza.
2297   - Added "unicode" and "class" directives.
2299 * docutils/parsers/rst/directives/parts.py:
2301   - Added the "sectnum" directive; by Dmitry Jemerov.
2302   - Added "class" option to "contents" directive.
2304 * docutils/parsers/rst/directives/references.py: Added to project.
2305   Contains the "target-notes" directive.
2307 * docutils/parsers/rst/languages/__init__.py:
2309   - Return ``None`` from get_language() for missing language modules.
2311 * docutils/parsers/rst/languages/de.py: Added to project; German
2312   mappings by Engelbert Gruber.
2314 * docutils/parsers/rst/languages/en.py:
2316   - Added interpreted text roles mapping.
2318 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2319   mappings by Marcelo Huerta San Martin.
2321 * docutils/parsers/rst/languages/fr.py: Added to project; French
2322   mappings by William Dode.
2324 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2325   mappings by Nicola Larosa.
2327 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2328   mappings by Miroslav Vasko.
2330 * docutils/readers/__init__.py:
2332   - Added support for the observer pattern from ``utils.Reporter``, in
2333     ``Reader.parse`` and ``Reader.transform``.
2334   - Removed ``Reader.transform()`` method.
2335   - Added default parameter values to ``Reader.__init__()`` to make
2336     instantiation easier.
2337   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2339 * docutils/readers/pep.py:
2341   - Added the ``peps.TargetNotes`` transform to the Reader.
2342   - Removed PEP & RFC reference detection code; moved to
2343     parsers/rst/states.py as options (enabled here by default).
2344   - Added support for pre-acceptance PEPs (no PEP number yet).
2345   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2346     easy subclassing.
2348 * docutils/readers/python: Python Source Reader subpackage added to
2349   project, including preliminary versions of:
2351   - __init__.py
2352   - moduleparser.py: Parser for Python modules.
2354 * docutils/transforms/__init__.py:
2356   - Added ``Transformer`` class and completed transform reform.
2357   - Added unknown_reference_resolvers list for each transformer. This list holds
2358     the list of functions provided by each component of the transformer that
2359     help resolve references.
2361 * docutils/transforms/frontmatter.py:
2363   - Improved support for generic fields.
2364   - Fixed bibliographic field language lookups.
2366 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2367   transforms.
2369 * docutils/transforms/parts.py:
2371   - Moved the "id" attribute from TOC list items to the references
2372     (``Contents.build_contents()``).
2373   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2374   - Added "class" attribute support to ``Contents``.
2376 * docutils/transforms/peps.py:
2378   - Added ``mask_email()`` function, updating to pep2html.py's
2379     functionality.
2380   - Linked "Content-Type: text/x-rst" to PEP 12.
2381   - Added the ``TargetNotes`` PEP-specific transform.
2382   - Added ``TargetNotes.cleanup_callback``.
2383   - Added title check to ``Headers``.
2385 * docutils/transforms/references.py:
2387   - Added the ``TargetNotes`` generic transform.
2388   - Split ``Hyperlinks`` into multiple transforms.
2389   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2390   - Added check for circular indirect references.
2391   - Made substitutions case-sensitive-but-forgiving.
2393 * docutils/transforms/universal.py:
2395   - Added support for the "--expose-internal-attributes" option.
2396   - Removed ``Pending`` transform classes & data.
2398 * docutils/writers/__init__.py:
2400   - Removed ``Writer.transform()`` method.
2402 * docutils/writers/docutils-xml.py:
2404   - Added XML and doctype declarations.
2405   - Added "--no-doctype" and "--no-xml-declaration" options.
2407 * docutils/writers/html4css1.py:
2409   - "name" attributes only on these tags: a, applet, form, frame,
2410     iframe, img, map.
2411   - Added "name" attribute to <a> in section titles for Netscape 4
2412     support (bug report: Pearu Peterson).
2413   - Fixed targets (names) on footnote, citation, topic title,
2414     problematic, and system_message nodes (for Netscape 4).
2415   - Changed field names from "<td>" to "<th>".
2416   - Added "@" to "&#64;" encoding to thwart address harvesters.
2417   - Improved the vertical whitespace optimization; ignore "invisible"
2418     nodes (targets, comments, etc.).
2419   - Improved inline literals with ``<span class="pre">`` around chunks
2420     of text and ``&nbsp;`` for runs of spaces.
2421   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2422     ``self.docinfo`` segments.
2423   - Added support for "line_block", "address" elements.
2424   - Improved backlinks (footnotes & system_messages).
2425   - Improved system_message output.
2426   - Redefined "--stylesheet" as containing an invariant URL, used
2427     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2428     working directory.
2429   - Added "--footnote-references" option (superscript or brackets).
2430   - Added "--compact-lists" and "--no-compact-lists" options.
2431   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2432     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2433   - Improved field list rendering.
2434   - Added Docutils version to "generator" meta tag.
2435   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2436   - Improved layout of <pre> HTML source.
2437   - Fixed attribute typo on <colspec>.
2438   - Refined XML prologue.
2439   - Support for no stylesheet.
2440   - Removed "interpreted" element support.
2441   - Added support for "title_reference", "sidebar", "attribution",
2442     "rubric", and generic "admonition" elements.
2443   - Added "--attribution" option.
2444   - Added support for "inline", "subscript", "superscript" elements.
2445   - Added initial support for "abbreviation" and "acronym";
2446     incomplete.
2448 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2449   (from the sandbox).
2451   - Added french.
2452   - Double quotes in literal blocks (special treatment for de/ngerman).
2453   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2454   - Added  "--attribution" option.
2455   - Right align attributions.
2457 * docutils/writers/pep_html.py:
2459   - Parameterized output encoding in PEP template.
2460   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2461   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2462     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2463     working directory.
2464   - Added an override on the "--footnote-references" option.
2465   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2466   - Added Docutils version to "generator" meta tag.
2467   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2469 * docs/tools.txt:
2471   - Added a "silent" setting for ``buildhtml.py``.
2472   - Added a "Getting Help" section.
2473   - Rearranged the structure.
2474   - Kept up to date, with new settings, command-line options etc.
2475   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2476   - Converted settings table into a definition list.
2478 * docs/rst/quickstart.txt:
2480   - Added a table of contents.
2481   - Added feedback information.
2482   - Added mention of minimum section title underline lengths.
2483   - Removed the 4-character minimum for section title underlines.
2485 * docs/rst/quickref.html:
2487   - Added a "Getting Help" section.
2488   - Added a style to make section title backlinks more subtle.
2489   - Added mention of minimum section title underline lengths.
2490   - Removed the 4-character minimum for section title underlines.
2492 * extras: Directory added to project; contains third-party modules
2493   that Docutils depends on (optparse, textwrap, roman).  These are
2494   only installed if they're not already present.
2496 * licenses: Directory added to project; contains copies of license
2497   files for non-public-domain files.
2499 * spec/doctree.txt:
2501   - Changed the focus.  It's about DTD elements:  structural
2502     relationships, semantics, and external (public) attributes.  Not
2503     about the element class library.
2504   - Moved some implementation-specific stuff into ``docutils.nodes``
2505     docstrings.
2506   - Wrote descriptions of all common attributes and parameter
2507     entities.  Filled in introductory material.
2508   - Working through the element descriptions: 55 down, 37 to go.
2509   - Removed "Representation of Horizontal Rules" to
2510     spec/rst/alternatives.txt.
2512 * spec/docutils.dtd:
2514   - Added "generated" inline element.
2515   - Added "line_block" body element.
2516   - Added "auto" attribute to "title".
2517   - Changed content models of "literal_block" and "doctest_block" to
2518     ``%text.model``.
2519   - Added ``%number;`` attribute type parameter entity.
2520   - Changed ``%structural.elements;`` to ``%section.elements``.
2521   - Updated attribute types; made more specific.
2522   - Added "address" bibliographic element.
2523   - Added "line" attribute to ``system_message`` element.
2524   - Removed "field_argument" element; "field_name" may contain
2525     multiple words and whitespace.
2526   - Changed public identifier to docutils.sf.net.
2527   - Removed "interpreted" element; added "title_reference",
2528     "abbreviation", "acronym".
2529   - Removed "refuri" attribute from "footnote_reference" and
2530     "citation_reference".
2531   - Added "sidebar", "rubric", "attribution", "admonition",
2532     "superscript", "subscript", and "inline" elements.
2534 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2536 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2538 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2540 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2541   Dallas Mahrt.
2543 * spec/transforms.txt: Added to project.
2545 * spec/howto: Added subdirectory, for developer how-to docs.
2547 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2548   Elza, edited & extended by David Goodger.
2550 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2551   project.
2553 * spec/rst/alternatives.txt:
2555   - Added "Doctree Representation of Transitions" from
2556     spec/doctree.txt.
2557   - Updated "Inline External Targets" & closed the debate.
2558   - Added ideas for interpreted text syntax extensions.
2559   - Added "Nested Inline Markup" section.
2561 * spec/rst/directives.txt:
2563   - Added directives: "topic", "sectnum", "target-notes",
2564     "line-block", "parsed-literal", "include", "replace", "sidebar",
2565     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2566     "class".
2567   - Formalized descriptions of directive details.
2568   - Added an "align" attribute to the "image" & "figure" directives
2569     (by Adam Chodorowski).
2570   - Added "class" options to "topic", "sidebar", "line-block",
2571     "parsed-literal", "contents", and "image"; and "figclass" to
2572     "figure".
2574 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2575   interpreted text roles.
2577 * spec/rst/introduction.txt:
2579   - Added pointers to material for new users.
2581 * spec/rst/reStructuredText.txt:
2583   - Disambiguated comments (just add a newline after the "::").
2584   - Updated enumerated list description; added a discussion of the
2585     second-line validity checking.
2586   - Updated directive description.
2587   - Added a note redirecting newbies to the user docs.
2588   - Expanded description of inline markup start-strings in non-markup
2589     contexts.
2590   - Removed field arguments and made field lists a generic construct.
2591   - Removed the 4-character minimum for section title underlines.
2592   - Clarified term/classifier delimiter & inline markup ambiguity
2593     (definition lists).
2594   - Added "Embedded URIs".
2595   - Updated "Interpreted Text" section.
2596   - Added "Character-Level Inline Markup" section.
2598 * test: Continually adding & updating tests.
2600   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2601   - Moved test/test_pep/ to test/test_readers/test_pep/.
2602   - Added test/test_readers/test_python/.
2603   - Added test/test_writers/ (Engelbert Gruber).
2605 * tools:
2607   - Made the ``locale.setlocale()`` calls in front ends
2608     fault-tolerant.
2610 * tools/buildhtml.py:
2612   - Added "--silent" option.
2613   - Fixed bug with absolute paths & "--config".
2614   - Updated for new I/O classes.
2615   - Added some exception handling.
2616   - Separated publishers' setting defaults; prevents interference.
2617   - Updated for new ``publish_file()`` convenience function.
2619 * tools/pep-html-template:
2621   - Allow for "--embed-stylesheet".
2622   - Added Docutils version to "generator" meta tag.
2623   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2624   - Conform to XHTML spec.
2626 * tools/pep2html.py:
2628   - Made ``argv`` a parameter to ``main()``.
2629   - Added support for "Content-Type:" header & arbitrary PEP formats.
2630   - Linked "Content-Type: text/plain" to PEP 9.
2631   - Files skipped (due to an error) are not pushed onto the server.
2632   - Updated for new I/O classes.
2633   - Added ``check_requirements()`` & ``pep_type_error()``.
2634   - Added some exception handling.
2635   - Updated for new ``publish_string()`` convenience function.
2636   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2638 * tools/quicktest.py:
2640   - Added "-V"/"--version" option.
2642 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2644 * tools/unicode2rstsubs.py: Added to project.  Produces character
2645   entity files (reSructuredText substitutions) from the MathML master
2646   unicode.xml file.
2648 * tools/editors: Support code for editors, added to project.  Contains
2649   ``emacs/restructuredtext.el``.
2651 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2653   - Added style for chunks of inline literals.
2654   - Removed margin for first child of table cells.
2655   - Right-aligned field list names.
2656   - Support for auto-numbered section titles in TOCs.
2657   - Increased the size of inline literals (<tt>) in titles.
2658   - Restored the light gray background for inline literals.
2659   - Added support for "line_block" elements.
2660   - Added style for "address" elements.
2661   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2662   - Improved field list rendering.
2663   - Vertical whitespace improvements.
2664   - Removed "a.target" style.
2666 * tools/stylesheets/pep.css:
2668   - Fixed nested section margins.
2669   - Other changes parallel those of ``../default.css``.
2672 Release 0.2 (2002-07-31)
2673 ========================
2675 General:
2677 - The word "component" was being used ambiguously.  From now on,
2678   "component" will be used to mean "Docutils component", as in Reader,
2679   Writer, Parser, or Transform.  Portions of documents (Table of
2680   Contents, sections, etc.)  will be called "document parts".
2681 - Did a grand renaming: a lot of ``verylongnames`` became
2682   ``very_long_names``.
2683 - Cleaned up imports: no more relative package imports or
2684   comma-separated lists of top-level modules.
2685 - Added support for an option values object which carries default
2686   settings and overrides (from command-line options and library use).
2687 - Added internal Unicode support, and support for both input and
2688   output encodings.
2689 - Added support for the ``docutils.io.IO`` class & subclasses.
2691 Specific:
2693 * docutils/__init__.py:
2695   - Added ``ApplicationError`` and ``DataError``, for use throughout
2696     the package.
2697   - Added ``Component`` base class for Docutils components; implements
2698     the ``supports`` method.
2699   - Added ``__version__`` (thus, ``docutils.__version__``).
2701 * docutils/core.py:
2703   - Removed many keyword parameters to ``Publisher.__init__()`` and
2704     ``publish()``; bundled into an option values object.  Added
2705     "argv", "usage", "description", and "option_spec" parameters for
2706     command-line support.
2707   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2708     methods.
2709   - Reworked I/O model for ``docutils.io`` wrappers.
2710   - Updated ``Publisher.set_options()``; now returns option values
2711     object.
2712   - Added support for configuration files (/etc/docutils.conf,
2713     ./docutils.conf, ~/.docutils).
2714   - Added ``Publisher.setup_option_parser()``.
2715   - Added default usage message and description.
2717 * docutils/frontend.py: Added to project; support for front-end
2718   (command-line) scripts.  Option specifications may be augmented by
2719   components.  Requires Optik (http://optik.sf.net/) for option
2720   processing (installed locally as docutils/optik.py).
2722 * docutils/io.py: Added to project; uniform API for a variety of input
2723   output mechanisms.
2725 * docutils/nodes.py:
2727   - Added ``TreeCopyVisitor`` class.
2728   - Added a ``copy`` method to ``Node`` and subclasses.
2729   - Added a ``SkipDeparture`` exception for visitors.
2730   - Renamed ``TreePruningException`` from ``VisitorException``.
2731   - Added docstrings to ``TreePruningException``, subclasses, and
2732     ``Nodes.walk()``.
2733   - Improved docstrings.
2734   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2735   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2736     imports.
2737   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2738     ``PreDecorative`` mixin.
2739   - Reworked the name/id bookkeeping; to ``document``, removed
2740     ``explicit_targets`` and ``implicit_targets`` attributes, added
2741     ``nametypes`` attribute and ``set_name_id_map`` method.
2742   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2743     traversals.
2744   - Added ``document.has_name()`` method.
2745   - Fixed DOM generation for list-attributes.
2746   - Added category class ``Labeled`` (used by footnotes & citations).
2747   - Added ``Element.set_class()`` method (sets "class" attribute).
2749 * docutils/optik.py: Added to project.  Combined from the Optik
2750   package, with added option groups and other modifications.  The use
2751   of this module is probably only temporary.
2753 * docutils/statemachine.py:
2755   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2756   - Added underscores to improve many awkward names.
2757   - In ``string2lines()``, changed whitespace normalizing translation
2758     table to regexp; restores Python 2.0 compatibility with Unicode.
2760 * docutils/urischemes.py:
2762   - Filled in some descriptions.
2763   - Added "shttp" scheme.
2765 * docutils/utils.py:
2767   - Added ``clean_rcs_keywords`` function (moved from
2768     docutils/transforms/frontmatter.py
2769     ``DocInfo.filter_rcs_keywords``).
2770   - Added underscores to improve many awkward names.
2771   - Changed names of Reporter's thresholds:
2772     warning_level -> report_level; error_level -> halt_level.
2773   - Moved ``utils.id()`` to ``nodes.make_id()``.
2774   - Added ``relative_path(source, target)``.
2776 * docutils/languages/de.py: German mappings; added to project.  Thanks
2777   to Gunnar Schwant for the translations.
2779 * docutils/languages/en.py: Added "Dedication" bibliographic field
2780   mappings.
2782 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2783   Chodorowski.
2785 * docutils/parsers/rst/states.py:
2787   - Added underscores to improve many awkward names.
2788   - Added RFC-2822 header support.
2789   - Extracted the inline parsing code from ``RSTState`` to a separate
2790     class, ``Inliner``, which will allow easy subclassing.
2791   - Made local bindings for ``memo`` container & often-used contents
2792     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2793   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2794   - Added ``MarkupMismatch`` exception; for late corrections.
2795   - Added ``-/:`` characters to inline markup's start string prefix,
2796     ``/`` to end string suffix.
2797   - Fixed a footnote bug.
2798   - Fixed a bug with literal blocks.
2799   - Applied patch from Simon Budig: simplified regexps with symbolic
2800     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2801   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2802   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2803   - Allowed non-ASCII in "simple names" (directive names, field names,
2804     references, etc.).
2805   - Converted ``Inliner.patterns.initial`` to be dynamically built
2806     from parts with ``build_regexp()`` function.
2807   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2808   - Updated docstrings.
2809   - Changed "table" to "grid_table"; added "simple_table" support.
2811 * docutils/parsers/rst/tableparser.py:
2813   - Changed ``TableParser`` to ``GridTableParser``.
2814   - Added ``SimpleTableParser``.
2815   - Refactored naming.
2817 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2818   a fallback language for directive names.
2820 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2821   directive to use a ``pending`` element, used only by HTML writers.
2823 * docutils/parsers/rst/directives/parts.py: Renamed from
2824   components.py.
2826   - Added "backlinks" attribute to "contents" directive.
2828 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2829   project by Adam Chodorowski.
2831 * docutils/readers/__init__.py: Gave Readers more control over
2832   choosing and instantiating Parsers.
2834 * docutils/readers/pep.py: Added to project; for PEP processing.
2836 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2837   requires a ``component`` parameter.
2839 * docutils/transforms/components.py: Added to project; transforms
2840   related to Docutils components.
2842 * docutils/transforms/frontmatter.py:
2844   - In ``DocInfo.extract_authors``, check for a single "author" in an
2845     "authors" group, and convert it to a single "author" element.
2846   - Added support for "Dedication" and generic bibliographic fields.
2848 * docutils/transforms/peps.py: Added to project; PEP-specific.
2850 * docutils/transforms/parts.py: Renamed from old components.py.
2852   - Added filter for `Contents`, to use alt-text for inline images,
2853     and to remove inline markup that doesn't make sense in the ToC.
2854   - Added "name" attribute to TOC topic depending on its title.
2855   - Added support for optional TOC backlinks.
2857 * docutils/transforms/references.py: Fixed indirect target resolution
2858   in ``Hyperlinks`` transform.
2860 * docutils/transforms/universal.py:
2862   - Changed ``Messages`` transform to properly filter out system
2863     messages below the warning threshold.
2864   - Added ``Decorations`` transform (support for ``--generator``,
2865     ``--date``, ``--time``, ``--source-link`` options).
2867 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2868   Engelbert Gruber's PDF writer.
2870 * docutils/writers/html4css1.py:
2872   - Made XHTML-compatible (switched to lowercase element & attribute
2873     names; empty tag format).
2874   - Escape double-dashes in comment text.
2875   - Improved boilerplate & modularity of output.
2876   - Exposed modular output in Writer class.
2877   - Added a "generator" meta tag to <head>.
2878   - Added support for the ``--stylesheet`` option.
2879   - Added support for ``decoration``, ``header``, and ``footer``
2880     elements.
2881   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2882     translation table to regexp; restores Python 2.0 compatibility
2883     with Unicode.
2884   - Added the translator class as instance variable to the Writer, to
2885     make it easily subclassable.
2886   - Improved option list spacing (thanks to Richard Jones).
2887   - Modified field list output.
2888   - Added backlinks to footnotes & citations.
2889   - Added percentage widths to "<col>" tags (from colspec).
2890   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2891     "<span>" changed to "<var>".
2892   - Inline literals: "<code>" changed to "<tt>".
2893   - Many changes to optimize vertical space: compact simple lists etc.
2894   - Add a command-line options & directive attributes to control TOC
2895     and footnote/citation backlinks.
2896   - Added support for optional footnote/citation backlinks.
2897   - Added support for generic bibliographic fields.
2898   - Identify backrefs.
2899   - Relative URLs for stylesheet links.
2901 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2902   PEPs (subclass of ``html4css1.Writer``).
2904 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2906 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2907   of the Docutils internal doctree in XML.
2909 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2911 * spec/doctree.txt:
2913   - Changed the title to "The Docutils Document Tree".
2914   - Added "Hyperlink Bookkeeping" section.
2916 * spec/docutils.dtd:
2918   - Added ``decoration``, ``header``, and ``footer`` elements.
2919   - Brought ``interpreted`` element in line with the parser: changed
2920     attribute "type" to "role", added "position".
2921   - Added support for generic bibliographic fields.
2923 * spec/notes.txt: Continual updates.  Added "Project Policies".
2925 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2926   section.
2928 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2930 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2931   mailing list discussions.
2933 * spec/pep-0287.txt:
2935   - Renamed to "reStructuredText Docstring Format".
2936   - Minor edits.
2937   - Reworked Q&A as an enumerated list.
2938   - Converted to reStructuredText format.
2940 * spec/pysource.dtd:
2942   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2944 * spec/pysource.txt: Removed from project.  Moved much of its contents
2945   to pep-0258.txt.
2947 * spec/rst/alternatives.txt:
2949   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2950   - Added "Inline External Targets" section.
2952 * spec/rst/directives.txt:
2954   - Added "backlinks" attribute to "contents" directive.
2956 * spec/rst/problems.txt:
2958   - Updated the Enumerated List Markup discussion.
2959   - Added new alternative table markup syntaxes.
2961 * spec/rst/reStructuredText.txt:
2963   - Clarified field list usage.
2964   - Updated enumerated list description.
2965   - Clarified purpose of directives.
2966   - Added ``-/:`` characters to inline markup's start string prefix,
2967     ``/`` to end string suffix.
2968   - Updated "Authors" bibliographic field behavior.
2969   - Changed "inline hyperlink targets" to "inline internal targets".
2970   - Added "simple table" syntax to supplement the existing but
2971     newly-renamed "grid tables".
2972   - Added cautions for anonymous hyperlink use.
2973   - Added "Dedication" and generic bibliographic fields.
2975 * test: Made test modules standalone (subdirectories became packages).
2977 * test/DocutilsTestSupport.py:
2979   - Added support for PEP extensions to reStructuredText.
2980   - Added support for simple tables.
2981   - Refactored naming.
2983 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2985   - Now supports true packages containing test modules
2986     (``__init__.py`` files required); fixes duplicate module name bug.
2988 * test/test_pep/: Subpackage added to project; PEP testing.
2990 * test/test_rst/test_SimpleTableParser.py: Added to project.
2992 * tools:
2994   - Updated html.py and publish.py front-end tools to use the new
2995     command-line processing facilities of ``docutils.frontend``
2996     (exposed in ``docutils.core.Publisher``), reducing each to just a
2997     few lines of code.
2998   - Added ``locale.setlocale()`` calls to front-end tools.
3000 * tools/buildhtml.py: Added to project; batch-generates .html from all
3001   the .txt files in directories and subdirectories.
3003 * tools/default.css:
3005   - Added support for ``header`` and ``footer`` elements.
3006   - Added styles for "Dedication" topics (biblio fields).
3008 * tools/docutils.conf: A configuration file; added to project.
3010 * tools/docutils-xml.py: Added to project.
3012 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3014 * tools/pep-html-template: Added to project.
3016 * tools/pep2html.py: Added to project from Python (nondist/peps).
3017   Added support for Docutils (reStructuredText PEPs).
3019 * tools/quicktest.py:
3021   - Added the ``--attributes`` option, hacked a bit.
3022   - Added a second command-line argument (output file); cleaned up.
3024 * tools/stylesheets/: Subdirectory added to project.
3026 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3029 Release 0.1 (2002-04-20)
3030 ========================
3032 This is the first release of Docutils, merged from the now inactive
3033 reStructuredText__ and `Docstring Processing System`__ projects.  For
3034 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3035 `DPS HISTORY`__ files.
3037 __ http://structuredtext.sourceforge.net/
3038 __ http://docstring.sourceforge.net/
3039 __ http://structuredtext.sourceforge.net/HISTORY.html
3040 __ http://docstring.sourceforge.net/HISTORY.html
3042 General changes: renamed 'dps' package to 'docutils'; renamed
3043 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3044 the test suites (reStructuredText's test/test_states renamed to
3045 test/test_rst); and all modifications required to make it all work.
3047 * docutils/parsers/rst/states.py:
3049   - Improved diagnostic system messages for missing blank lines.
3050   - Fixed substitution_reference bug.
3054    Local Variables:
3055    mode: indented-text
3056    indent-tabs-mode: nil
3057    sentence-end-double-space: t
3058    fill-column: 70
3059    End: