Fix [ 253 ] Attribute key without value not allowed in XML.
[docutils.git] / docutils / HISTORY.txt
blob933a2de16a97f6b2be845484d8ab62055f670ab3
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/directives/tables.py
25   - patch [ 120 ] tables accept option widths: list of relative widths, 'auto' 
26     or 'grid'.
28 * docutils/writers/odf_odt/__init__.py remove decode.encode of filename
29   stored in zip.
31 * docutils/writers/latex2e/__init__.py
33   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
34     admonitions and docinfo.
36 Release 0.12 (2014-07-06)
37 =========================
39 * docs/ref/rst/directives.txt
41   - Update "math" and "csv-table" descriptions.
43 * docutils/parsers/rst/directives/images.py
45   - Fix [ 258 ] figwidth="image" generates unitless width value.
46   
47 * docutils/parsers/rst/states.py
49   - Improve error report when a non-ASCII character is specified as
50     delimiter, quote or escape character under Python 2.
51     Fixes [ 249 ] and [ 250 ].
53 * docutils/writers/html4css1/__init__.py
55   - Don't add newline after inline math.
56     Thanks to Yury G. Kudryashov for the patch.
58 * docutils/writers/latex2e/__init__.py
60   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
61   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
63 * docutils/writers/odf_odt/__init__.py
65   - Apply patch by Jakub Wilk to fix bug [ 100 ].
67 * test/test_error_reporting.py
69   - Fix [ 223 ] by removing redundant tests we do not have control over.
71 * test/test_nodes.py
73   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
75 Release 0.11 (2013-07-22)
76 =========================
78 * General
80   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
81   - Support embedded aliases within hyperlink references.
82   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
83     language module) before global search.
85 * docutils/nodes.py
87   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
89 * docutils/parsers/rst/directives/__init__.py
91   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
93 * docutils/parsers/rst/directives/images.py
95   - Apply [ 3599485 ] node source/line information for sphinx translation.
97 * docutils/parsers/rst/directives/tables.py
99   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
101 * docutils/parsers/rst/states.py
103   - Fix [ 157 ] Line block parsing doesn't like system message.
104   - Always import our local copy of roman.py (report Larry Hastings).
106 * docutils/transforms/references.py
108   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
110 * docutils/utils/__init__.py
112   - Fix [ 3596884 ] exception importing ``docutils.io``.
114 * docutils/writers/html4css1/__init__.py
116   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
117   - New setting `stylesheet_dirs`: Comma-separated list of directories
118     where stylesheets are found. Used by `stylesheet_path` when expanding
119     relative path arguments.
120   - New default for math-output_: ``HTML math.css``.
121   - Avoid repeated class declarations in html4css1 writer
122     (modified version of patch [ 104 ]).
124 .. _math-output: docs/user/config.html#math-output
126 * docutils/writers/latex2e/__init__.py
128   - Drop the simple algorithm replacing straight double quotes with
129     English typographic ones.
130     Activate the SmartQuotes_ transform if you want this feature.
131   - Fix literal use of babel shorthands (straight quote, tilde, ...).
132   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
133   - New setting `stylesheet_dirs`.
135 .. _SmartQuotes: docs/user/config.html#smart-quotes
137 * docutils/writers/manpage.py
139   - Fix [3607063] handle lines starting with a period.
140   - Fix option separating comma was bold (thanks to Bill Morris).
142 Release 0.10 (2012-12-16)
143 =========================
145 * General
147   - Dropped support for Python 2.3.
148   - ``docutils/math``, ``docutils/error_reporting.py``, and
149     ``docutils/urischemes.py`` moved to the utils package.
150   - Fix [3541369] Relative __import__ also with Python 3.3.
151   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
152     and parsers for Python 2.7 up.
153   - Fix import of PIL.Image.
154   - Change default of "syntax highlight" option to "long",
155     basic syntax highlight styles for LaTeX and HTML.
157 * docutils/io.py
159   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
160     option is ignored and will be removed in a future release.
161   - Fix Py3k error writing to stdout with encoding differing from default.
162   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
164 * docutils/parsers/rst/directives/misc.py
166   - Fix [ 3546533 ] Unicode error with `date` directive.
168 * docutils/transforms/universal.py
170   - SmartQuotes transform for typographic quotes and dashes.
172 * docutils/utils/__init__.py
174   - normalize_language_tag() now returns `BCP 47`_ conformant tags
175     with subtags separated by ``-``.
177 * docutils/writers/html4css1/__init__.py
179   - Use ``<code>`` tag for inline "code",
180     do not drop nested inline nodes (syntax highlight tokens).
181   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
182   - No line break after opening inline math tag.
184 * docutils/writers/manpage.py
186   - Apply [ 3527401 ] addmonition's don't preserve indentation
187   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
189 , docutils/writers/xetex/__init__.py
191   - Apply [ 3555160 ] ensure order of "otherlanguages".
192   - Fix section numbering by LaTeX.
194 * docutils/writers/s5_html/__init__.py
196   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
198 * docutils/writers/s5_html/docutils_xml.py
200   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
202 * setup.py
204   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
206 * tools/test/test_buildhtml.py
208   - Fix [ 3521167 ] allow running in any directory.
209   - Fix [ 3521168 ] allow running with Python 3.
212 Release 0.9.1 (2012-06-17)
213 ==========================
215 * setup.py
217   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
218     installed in the PYTHONPATH. Converted tests are now
219     stored in ``test3/``, tools no longer need conversion.
221     If you installed one of Docutils versions 0.7 ... 0.9 with
222     ``setup.py install`` under Python 3, remove the spurious
223     ``test/`` and ``tools/`` directories in the site library root.
225 * test/
227   - Make tests independent from the location of the ``test/`` directory.
228   - Use converted sources (from the ``build/`` directory) for tests under
229     Python 3.
231 * tools/
233   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
235 * docutils/io.py
237   - Fix writing binary data to sys.stdout under Python 3 (allows
238     ``rst2odt.py`` to be used with output redirection).
240 * docutils/parsers/rst/directives/misc.py
242   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
243     ``locale == C`` and 8-bit char in path argument of `include` directive.
245 * test/alltests.py
247   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
248     file under Python 3.
250 Release 0.9 (2012-05-02)
251 ========================
253 * General:
255   - New reStructuredText "code" role and directive and "code" option
256     of the "include" directive with syntax highlighting by Pygments_.
257   - Fix parse_option_marker for option arguments containing ``=``.
258   - Fix [ 2993756 ]: import Python Imaging Library's Image module
259     via ``import PIL`` as starting with PIL 1.2,
260     "PIL lives in the PIL namespace only" (announcement__).
262 .. _Pygments: http://pygments.org/
263 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
265 * setup.py
267   - Fix [ 2971827 ] and [ 3442827 ]
268     extras/roman.py moved to docutils/utils/roman.py
270 * docutils/frontend.py
272   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
274 * docutils/io.py
276   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
277   - `mode` argument for FileOutput avoids code replication in
278     BinaryFileOutput.
279   - New exceptions InputError and OutputError for IO errors in
280     FileInput/FileOutput.
282 * docutils/core.py:
284   - No "hard" system exit on file IO errors: catch and report them in
285     `Publisher.reportException` instead. Allows handling by a calling
286     application if the configuration setting `traceback` is True.
288 * docutils/utils.py -> docutils/utils/__init__.py
290   - docutils.utils is now a package (providing a place for sub-modules)
292   .. note:: docutils/math, docutils/error_reporting.py, and
293      docutils/urischemes.py will move to the utils package in the next
294      release, too. See RELEASE-NOTES__
296      __ RELEASE-NOTES.html
298   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
299     errors recording non-ASCII filenames (fixes [ 3434355 ]).
301   - Fix relative_path() with source=None and `unicode` target.
303 * docutils/parsers/rst/states.py
305   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
306     characters and "international" quotes around inline markup.
307   - Use `field_marker` pattern to look for start of a
308     directive option block (fixes [ 3484857 ]).
310 * docutils/parsers/rst/tableparser.py
312   - Fix [ 2926161 ] for simple tables.
313     (Combining chars in grid tables still contribute to cell width.)
315 * docutils/writers/latex2e/__init__.py
317   - Support the `abbreviation` and `acronym` standard roles.
318   - Record only files required to generate the LaTeX source as dependencies.
319   - Fix handling of missing stylesheets.
320   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
321     when suppressing LaTeX section numbering.
322   - Use ``\DUtitle`` for unsupported section levels
323   - Apply [ 3512791 ] do not compare string literals with "is"
325 * docutils/writers/xetex/__init__.py
327   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
329 * docutils/writers/html4css1/__init__.py
331   - Change default for `math-output` setting to MathJax.
332   - Fix handling of missing stylesheets.
334 * docutils/writers/docutils_xml.py
336   - Use the visitor pattern with default_visit()/default_depart() methods
337     instead of minidom to facilitate special handling of selected nodes.
338   - Support raw XML (inserted as-is inside a <raw></raw> node).
340 * docutils/writers/manpage.py
342   - Do not emit comment line with trailing blank. Problematic for VCS.
344 Release 0.8.1 (2011-08-30)
345 ==========================
347 * General:
349   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
350     and [ 3395920 ] (correct copyright info for rst.el).
352 * test/
354   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
356 * docutils/writers/latex2e/__init__.py
358   - Clean up Babel language setting. Restores Sphinx compatibility.
360 Release 0.8 (2011-07-07)
361 ========================
363 * General:
365   - Handle language codes according to `BCP 47`_.
366   - If the specified language is not supported by Docutils,
367     warn and fall back to English.
368   - Math support: reStructuredText "math" role and directive,
369     ``math`` and ``math_block`` doctree elements.
370   - Decode command line arguments with the locale's preferred encoding
371     (to allow, e.g., ``--title=Dornröschen``).
372   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
373   - New sub-module `error_reporting`: handle encoding/decoding errors
374     when reporting exceptions.
375   - Some additions to the Docutils core are released under the 2-Clause BSD
376     license, see COPYING_ for details.
378   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
379   .. _COPYING: COPYING.html
381 * reStructuredText:
383   - Most directives now support a "name" option that attaches a
384     reference name.
386   - Directive content may start on the first line also when the directive
387     type accepts options.
389 * docs/dev/policies.txt:
391   - Recommend the 2-Clause BSD license
392     (http://www.spdx.org/licenses/BSD-2-Clause)
393     for code that is kept under the author's copyright.
395 * tools/buildhtml.py:
397   - Fix ``--local`` switch.
399 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
401 * docutils/writers/html4css1/__init__.py
403   - Set "lang" argument for objects with class argument
404     "language-<language tag>".
405   - New setting "math-output" with support for HTML, MathML, and LaTeX.
407 * docutils/writers/latex2e/__init__.py
409   - Fix [ 3043986 ] AttributeError using :local: with table of content.
410   - Place title data in the document preamble.
411   - Load `babel` package only if required.
412   - Update list of supported languages.
413   - New config setting "hyperref-options".
414     No hard-coded "unicode" hyperref option (clash with xetex).
415   - Set language for custom roles, paragraphs, block-quotes, and
416     line-quotes with class argument "language-<language tag>".
417   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
418   - Convert image URI to a local file path.
419   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
420     has more than one paragraph (Wolfgang Scherer).
421   - \leavevmode before longtable only when needed (prevents spurious vspace)
422   - do not advance table counter for tables without caption
424 * docutils/writers/xetex/__init__.py
426   - New writer generating LaTeX code for compiling with ``xelatex``.
428     A separate writer (inheriting from latex2e) instead of a ``--xetex``
429     option allows separate config options for XeTeX vs. LaTeX2e.
431 * docutils/writers/manpage.py
433   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
434   - Fix: vertical space cleaning for option group ``.``.
436 * tools/editors/emacs/rst.el:
438   - Fix [ 3001100 ] does not handle spaces in filenames
439     (thanks to Jakub Wilk)
441 * docutils/utils.py:
443   - strip whitespace from stylesheet arguments
444   - exclude combining chars from column_width()
445     (partial fix for [ 2926161 ])
447 * docutils/parsers/rst/directives/misc.py:
449   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
450     nested_parse
452 * docutils/io.py:
454   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
455     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
457 Release 0.7 (2010-07-07)
458 ========================
460 * General:
462   - Fix [ 2881769 ] setup configuration.
463   - Fix [ 2788716 ] reporting problems in included files.
465 * docutils/io.py
467   - FileInput opens files as text files with universal newline support
468     (mode "rU", configurable with the new optional argument "mode").
470 * docutils/nodes.py
472   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
474 * docutils/utils.py
476   - Fix [ 2923723 ] let decode_path() tolerate path == None
478 * docutils/writers/html4css1/__init__.py
480   - Support SVG and SWF images (thanks to Stefan Rank).
481   - Generate valid XHTML for centered images with targets.
482     Use CSS classes instead of "align" tags for image alignment.
484 * docutils/writers/latex2e/__init__.py
486   - Use `transforms.writer_aux.Admonitions` to "normalize" special
487     admonitions.
488   - Use the ``\url`` command for URLs (breaks long URLs instead of
489     writing into the margin).
490   - Preserve runs of spaces in `inline literals`__.
491   - Deprecate ``figure_footnotes`` setting.
492   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
493   - New ``latex_preamble`` setting.
494   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
495   - Fix hyperlink targets (labels) for images, figures, and tables.
496   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
497   - Apply [ 2961991 ] Call hyperref with unicode option.
498   - Drop the special `output_encoding`__ default ("latin-1").
499     The Docutils wide default (usually "UTF-8") is used instead.
500   - Render inline markup in document title and subtitle.
501   - Fix numbering depth with LaTeX section numbering.
502   - Update Unicode -> LaTeX translations.
503   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
505 __ docs/ref/restructuredtext.html#inline-literals
506 __ docs/user/config.html#docutils-footnotes
507 __ docs/user/config.html#output_encoding
509 * docutils/writers/manpage.py
511   - Fix: supported attribute (thanks to peter2108).
512   - Remove trailing blanks in code (keep in sync with mercurial version).
513   - Titles level 1, that is ``.SH``, always uppercase.
514   - Apply patch from mg: literal text should be bold in man-pages.
516 * docutils/nodes.py
518   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
519     turkish locale.
521 * setup.py:
523   - Python 3 support: copy test/ and tools/ to the build-dir
524     and convert Python sources with 2to3.
527 Release 0.6 (2009-10-11)
528 ========================
530 * General:
532   - Docutils is now compatible with Python versions from 2.3 up to 2.6
533     and convertible to 3.1 code.
535     + Node.__nonzero__ returns True instead of 1.
536     + use os.walk instead os.path.walk.
537     + minimize "types" module where possible.
538     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
539     + Text nodes now subclass unicode rather than UserString
540       (which is gone in python 3.0).
541     + 3.0 compatibility module docutils._compat
543     + Drop 2.2 compatibility workarounds.
544     + Drop extras/optparse.py and extras/textwrap.py
545       (stdlib modules since 2.3).
547   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
548   - Unix man page export: manpage writer moved from sandbox to Doctutils
549     core.
551   - Apply [ 1719345 ] Galician translation
552   - Apply [ 1905741 ] Polish translation
553   - Apply [ 1878977 ] make_id(): deaccent characters.
554   - Apply [ 2029251 ] return nonzero when tests fail.
555   - Fix [ 1692788 ] allow UTF-8 in style sheets.
556   - Fix [ 2781629 ] support non-ASCII chars in file names.
557   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
558   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
559   - Fix [ 2821266 ] --strict option works now like --halt=info.
560   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
561   - Fix [ 1627229 ] hyperlink references in substitutions.
563   - The "newlatex" writer is orphaned.
565 * reStructuredText:
567   - Documented Unicode characters allowed as inline markup openers,
568     closers, and delimiters.
569   - Allow units for all length specifications.
570   - Allow percent sign in "scale" argument of "figure" and "image" directives.
571   - Bugfix: The "figalign" argument of a figure now works as intended
572     (aligning the figure, not its contents).
573   - Align images with class "align-[right|center|left]"
574     (allows setting the alignment of an image in a figure).
576 * docutils/nodes.py:
578   - Added ``Element.__contains__`` method, for the in-operator.
580 * docutils/parsers/rst/states.py:
582   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
583   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
584     " " (non-breaking space), and "¡ ¿" openers.
586 * docutils/parsers/directives/misc.py:
588   - Added ``start-line`` and ``end-line`` options to "include"
589     directive to select a range of lines.
590   - Hard tabs in literal inclusions are replaced by spaces. This is
591     configurable via the new ``tab-width`` option of the "include" directive
592     (a negative tab-width prevents tab expansion).
594 * docutils/utils.py:
596   - Add ``get_stylesheet_list`` function.
597   - Apply [ 2834836 ] print info at halt
599 * docutils/transforms/universal.py:
601   - Raise default priority of StripClasses to exclude stripped classes from
602     the ToC.
604 * docutils/writers/html4css1/__init__.py:
606   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
607     separated list of stylesheets.
608   - Address [ 1938891 ] Inline literal text creates "pre" span only when
609     needed to prevent inter-word line wraps.
610   - Use `translate` method instead of repeated `replace` calls.
611   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
612     classes to allow CSS styling that does not interfere with other
613     table-using constructs (field lists, citations, ...).
615 * docutils/writers/newlatex2e/__init__.py:
617   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
619 * docutils/writers/latex2e/__init__.py (see also
620   `<docs/user/docutils-05-compat.sty.html>`__) :
622   - Add ``--embed-stylesheet`` option.
623   - Apply [ 1474017 ] image vertical alignment is reversed.
624   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
625   - Change: has_key for dictionaries (not Nodes) to in-operator.
626   - Merge adjacent citations into one latex cite command.
627   - Failsave implementation of custom roles. LaTeX compilation now ignores
628     unknown classes instead of aborting with an error.
629   - Support custom roles based on standard roles.
630   - LaTeX packages can be used as ``--stylesheet`` arguments without
631     restriction. (A style sheet is now referenced with the ``\usepackage``
632     command, if it ends with ``.sty`` or has no extension.)
633   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
634   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
635   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
636     2005-02-04 as a configurable length unit).
637   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
638     if font-encoding is set to ''. LaTeX defaults to OT1 then.
639   - Set sub- and superscript role argument in text mode not as math.
640     Use a custom role based on sub-/superscript if you want italic shape.
641   - Shorter preamble and less dependencies: Load packages and define macros
642     only if required in the document.
643   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
644   - New custom environments and commands with optional "classes" argument.
645   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
646   - Better conformance to Docutils specifications with ``--use-latex-toc``.
647     Support for LaTeX generated ToC also with unnumbered sections.
648   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
649     section numbering by LaTeX.
650   - Use default font in admonitions and sidebar.
651   - Align of image in a figure defaults to 'center'.
652   - Bugfix: Newlines around targets and references prevent run-together
653     paragraphs.
654   - Fix internal hyperlinks.
655   - Use class defaults for page margins ('typearea' now optional).
656   - Float placement made configurable, default changed to "here definitely".
657   - Typeset generic topic as "quote block with title".
658   - Use template (file and configuration option).
659   - In the default template, load cmap.sty (fix text extraction in PDF) and
660     fixltx2e.sty (LaTeX patches, \textsubscript).
661   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
662   - Use `translate` instead of repeated `replace` calls for text encoding.
663   - Hyperlinked footnotes and support for symbol footnotes and
664     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
665   - Complete pairs of binary options
666     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
667     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
668   - New defaults:
669     - font-encoding: "T1" (formerly implicitely set by 'ae').
670     - use-latex-toc: true (ToC with page numbers).
671     - use-latex-footnotes: true (no mixup with figures).
673 * docutils/writers/manpage.py
675   - Do not print version at document end, this is done by the viewer.
676   - Do not print date at document end, this is done by the viewer.
677   - Fix storage of docinfo fields for none standard fields.
679 * docutils/tools/rst2man.py
681 Release 0.5 (2008-06-25)
682 ========================
684 * docutils/languages/he.py: Added to project: Hebrew mappings by
685   Meir Kriheli.
687 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
688   mappings by Meir Kriheli.
690 * docutils/frontend.py:
692   - Configuration files are now assumed and required to be
693     UTF-8-encoded.
694   - Paths of applied configuration files are now recorded in the
695     runtime setting ``_config_files`` (accessible via
696     ``--dump-settings``).
697   - Added ``--strip-elements-with-class`` and ``--strip-class``
698     options (``strip_elements_with_classes`` and ``strip_classes``
699     settings).
701 * docutils/io.py:
703   - Added code to determine the input encoding from data: encoding
704     declarations or the presence of byte order marks (UTF-8 & UTF-16).
705   - Added support for IronPython 1.0.
707 * docutils/nodes.py:
709   - Added ``document.__getstate__`` method, for pickling.
711 * docutils/parsers/rst/states.py:
713   - Allow ``+`` and ``:`` in reference names.
714   - Unquoted targets beginning with an underscore (``.. __target:
715     URI``) are no longer accepted.
716   - Added support for multiple attributions in a physical block quote
717     (indented text block), dividing it into multiple logical block
718     quotes.
719   - Added support for unicode bullets in bullet lists: "•", "‣", and
720     "⁃".
721   - Added support for new object-oriented directive interface,
722     retaining compatibility to the old functional interface.
723   - Added support for throwing ``DirectiveError``'s from within
724     directive code.
726 * docutils/parsers/rst/__init__.py:
728   - Added ``Directive`` base class.
729   - Added ``DirectiveError`` base class.
730   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
731     definitions.
733 * docutils/parsers/directives/:
735   - Refactored all reStructuredText directives to use the new
736     object-oriented directive interface.  Errors are now (mostly)
737     thrown using the new ``DirectiveError`` class.
739 * docutils/parsers/directives/misc.py:
741   - Added ``start-after`` and ``end-before`` options to ``include``
742     directive; thanks to Stefan Rank.
744 * docutils/transforms/universal.py:
746   - Added ``StripClassesAndElements`` transform to remove from the
747     document tree all elements with classes in
748     ``settings.strip_elements_with_classes`` and all "classes"
749     attribute values in ``self.document.settings.strip_classes``.
751 * docutils/transforms/writer_aux.py:
753   - Added ``Admonitions`` transform to transform specific admonitions
754     (like ``note``, ``warning``, etc.) into generic admonitions with a
755     localized title.
757 * docutils/writers/html4css1/__init__.py:
759   - Moved template functionality from the PEP/HTML writer here.
760   - Expanded the fragments available in the ``parts`` attribute.
761   - Moved ``id`` attributes from titles to surrounding ``div``
762     elements.
763   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
764     universally supported now).
765   - ``template.txt`` is now opened in text mode instead of binary mode
766     (to ensure Windows compatibility).
767   - ``a`` elements now have an "internal" or "external" class,
768     depending on reference type.
770 * docutils/writers/html4css1/template.txt: Added to project.
772 * docutils/writers/pep_html/:
774   - Moved template functionality to the HTML writer.
776 * docutils/writers/s5_html/__init__.py:
778   - Added ``view_mode`` & ``hidden_controls`` settings
779     (``--view-mode`` & ``--hidden-controls/--visible-controls``
780     options).
782 * docutils/writers/latex2e/__init__.py:
784   - Add ``--literal-block-env``
785   - Fix: escaping ``%`` in href urls.
786   - Move usepackage hyperref after stylesheet inclusion.
787   - Fix: scrartcl does not have chapter but scrreprt.
788   - Add newline after ``\end{verbatim}``.
789   - Merge smaller differences from latex2e_adaptive_preamble.
790   - Add ``use-part-section``.
791   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
792   - Using leavemode option_list no longer needs to check if parent
793     is a definition list.
794   - Append ``\leavemode`` to definition list terms.
795   - No longer write visit\_/depart_definition_list_item comments to
796     output.
797   - Table column width with 3 decimal places.
798   - Add table stubs support (boldfont).
799   - Add assemble_parts to writer.
800   - Add simply support for nested tables.
801   - Fix verbatim in tables if use-verbatim-when-possible.
802   - Use section commands down to subparagraph.
803   - Put ensuremath around some latin1 chars.
804   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
805   - New option ``--use-bibtex=style,db1,db2``.
806   - New option ``--reference-label`` to allow usage of LaTeX ref for
807     labels in section references.
808   - Add a label after every section to support sectionnumbers as reference
809     labels.
810   - Fix: bug# 1605376 rst2latex: bad options group list
811   - Remove inactive code for use_optionlist_for_option_list.
812   - Remove latex comments from option_list output.
813   - Fix: bug# 1612270 double qoutes in italian literal.
814   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
815   - Add option --use-latex-abstract.
816   - Image width unit ``px`` is translated to ``pt``.
817   - Add image height support.
818   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
819     bug #1457388
820   - Fix: Do not escape underscores in citation reference labels if
821     use-latex-citations is set.
822   - Use centering instead of center for figure contents, to avoid vertical
823     space.
824   - Recognize table class: borderless, nolines, booktabs, standard.
825   - Fix: Renaming contents section does not work with latex writer; SF
826     bug #1487405.
827   - Applied patch for custom roles with classes from Edward Loper.
828   - Fixed bug that caused crashes with more than 256 lists.
830 * docutils/writers/pep_html/__init__.py:
832   - Changed to support new python.org website structure and
833     pep2pyramid.py.
835 * docs/howto/security.txt: "Deploying Docutils Securely", added to
836   project.
838 * tools/buildhtml.py:
840   -- Added ``ignore`` setting to exclude a list of shell patterns
841      (default: ``.svn:CVS``).
843 * tools/editors/emacs/rst.el:
845   - Changed license to "GPL".
846   - Added ``rst-straighten-decorations`` function.
847   - The ``compile`` module is now always loaded.
848   - Added ``rst-toggle-line-block`` function.
849   - Headings consisting only of non-ASCII characters are now
850     recognized by ``rst-toc`` and ``rst-adjust``.
851   - Added font-lock support for multi-line comments where the first
852     comment line is empty.
853   - Added ``(require 'font-lock)``.
855 * setup.py:
857   - Provide descriptive error message if distutils is missing.
860 Release 0.4 (2006-01-09)
861 ========================
863 * General:
865   - Updated the project policies for trunk/branch development &
866     version numbering.
868 * docutils/__init__.py:
870   - Added ``__version_details__`` attribute to describe code source
871     (repository/snapshot/release).
872   - Replaced ``default_transforms`` attribute of TransformSpec with
873     ``get_transforms()`` method.
875 * docutils/core.py:
877   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
878     functions, for document tree extraction and reprocessing.
880 * docutils/io.py:
882   - Added ``DocTreeInput`` class, for reprocessing existing documents.
883   - Added support for non-Unicode (e.g. binary) writer output.
885 * docutils/nodes.py:
887   - Re-introduced ``Targetable.indirect_reference_name``, for
888     MoinMoin/reST compatibility (removed in r3124/r3129).
889   - Added ``serial_escape`` function; escapes string values that are
890     elements of a list, for serialization.  Modified Docutils-XML
891     writing (``Element._dom_node``) and pseudo-XML writing
892     (``Element.starttag``) to use ``serial_escape``.
893   - Added ``Node.deepcopy()`` method.
894   - Removed the internal lists ``document.substitution_refs``,
895     ``document.anonymous_refs``, and ``document.anonymous_targets``.
896   - Added a "container" element.
897   - Fixed bug where values of list-valued attributes of elements
898     originating from custom interpreted text roles (i.e., with custom
899     classes) were being shared between element instances.  Reported by
900     Shmuel Zeigerman.
902 * docutils/statemachine.py:
904   - Added trailing whitespace stripping to ``string2lines()``.
905   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
906     Asian double-width character support.
908 * docutils/utils.py:
910   - Added ``east_asian_column_width()`` for double-width character
911     support.
913 * docutils/languages/ja.py: Added to project: Japanese mappings by
914   Hisashi Morita.
916 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
917   mappings by Panjunyong.
919 * docutils/parsers/null.py: Added to project; a do-nothing parser.
921 * docutils/parsers/rst/__init__.py:
923   - Added validator to tab_width setting, with test.  Closes SF bug
924     #1212515, report from Wu Wei.
926 * docutils/parsers/rst/states.py:
928   - Fixed bug with escaped colons indicating a literal block.
929   - Fixed bug with enumerated lists (SF#1254145).
930   - Backslash-escaped colons inside of field names are now allowed.
931   - Targets (implicit and explicit), anonymous hyperlink references
932     and auto-numbered footnote references inside of substitution
933     definitions are now disallowed.
934   - Fixed bug: list items with blank first lines.
935   - Fixed bug: block quote attributions with indented second lines.
936   - Added East Asian double-width character support (Python 2.4 only).
938 * docutils/parsers/rst/tableparser.py:
940   - Added East Asian double-width character support (Python 2.4 only).
942 * docutils/parsers/rst/directives/body.py:
944   - Added the "container" directive.
946 * docutils/parsers/rst/directives/misc.py:
948   - Added the "default-role", "title", and "date" directives.
949   - Added standard data file syntax to the "include" directive.
950   - Added support for "class" directive content.
952 * docutils/parsers/rst/directives/images.py:
954   - Added ``indirect_reference_name`` support for images with a target
955     option.
956   - Added support for image width and height units.
957   - Fixed bug with image "target" options.
959 * docutils/parsers/rst/directives/references.py:
961   - Added "class" attribute to "target-notes" directive, for
962     footnote_reference classes.
964 * docutils/parsers/rst/include/: Directory added to project; contains
965   standard data files for the "include" directive.  Initial contents:
966   character entity substitution definition sets, and a set of
967   definitions for S5/HTML presentations.
969 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
970   mappings by David Goodger.
972 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
973   Simplified Chinese mappings by Panjunyong.
975 * docutils/readers/__init__.py:
977   - Added universal.Decorations and universal.ExposeInternals
978     transforms as default transforms for all readers.
979   - Added ``ReReader`` base class for readers that reread an existing
980     document tree.
982 * docutils/readers/doctree.py: Added to project; a reader for existing
983   document trees.
985 * docutils/transforms/frontmatter.py:
987   - Fixed the DocInfo transform to handle SVN-style expansion of the
988     "Date" keyword.
989   - In ``DocInfo.extract_authors``, treat the contents of "authors"
990     fields uniformly.
992 * docutils/transforms/misc.py:
994   - Added misc.Transitions transform, extracted from
995     universal.FinalChecks.
997 * docutils/transforms/references.py:
999   - Added references.DanglingReferences transform, extracted from
1000     universal.FinalChecks.
1001   - Fixed bug with doubly-indirect substitutions.
1002   - Added footnote_reference classes attribute to "TargetNotes".
1003   - Fixed bug with circular substitution definitions that put Docutils
1004     into an infinite loop.
1006 * docutils/transforms/universal.py:
1008   - Added universal.ExposeInternals transform, extracted from
1009     universal.FinalChecks.
1010   - Removed universal.FinalChecks transform (logic has been moved to
1011     several new transforms).
1012   - Fixed bug with the "expose_internals" setting and Text nodes
1013     (exposed by the "rawsource" internal attribute).
1014   - Added the universal.StripComments transform, implementation of the
1015     "strip_comments" setting.
1017 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1018   transforms for writers.
1020   - Added ``Compound`` transform, which flattens compound paragraphs.
1022 * docutils/writers/: Several writer modules (html4css1.py) were
1023   converted into packages.  Support modules and data files have been
1024   moved into the packages.  The stylesheets for the HTML writers are
1025   now installed along with the code, the code knows where to find
1026   them, and the default is to use them (actually, to embed them).
1027   Some adjustments to configuration files may be necessary.  The
1028   easiest way to obtain the new default behavior is to remove all
1029   settings whose name includes "stylesheet".
1031 * docutils/writers/__init__.py:
1033   - Added universal.Messages and universal.FilterMessages transforms
1034     as default transforms for all writers.
1035   - Added ``UnfilteredWriter`` base class for writers that pass the
1036     document tree on unchanged.
1038 * docutils/writers/docutils_xml.py:
1040   - Made ``xmlcharrefreplace`` the default output encoding error
1041     handler.
1043 * docutils/writers/html4css1/:
1045   - Added support for image width and height units.
1046   - Made ``xmlcharrefreplace`` the default output encoding error
1047     handler.
1048   - Made ``--embed-stylesheet`` the default rather than
1049     ``--link-stylesheet``.
1050   - Moved "id" attribute from container (section etc.) to title's <a>
1051     tag, to be on the same tag as "name".
1052     (!!! To be reverted in Docutils 0.5.)
1053   - Added vertical space between fields of field lists.
1054   - Added ``--compact-field-lists`` option to remove vertical space in
1055     simple field lists.
1056   - Made cloaking of email addresses with ``--cloak-email-addresses``
1057     less obtrusive.
1058   - Fixed support for centered images.
1059   - Added support for class="compact" & class="open" lists.
1061 * docutils/writers/latex2e/:
1063   - Underscores in citekeys are no longer escaped.
1065 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1066   mapping of Unicode characters to LaTeX equivalents.
1068 * docutils/writers/s5_html/: Package added to project; writer for
1069   S5/HTML slide shows.
1071 * docs/dev/distributing.txt: Added to project; guide for distributors
1072   (package maintainers).
1074 * docs/dev/hacking.txt: Added to project; guide for developers.
1076 * docs/ref/doctree.txt:
1078   - Updated for plural attributes "classes", "ids", "names",
1079     "dupnames".
1080   - Added the "container" element.
1082 * docs/ref/docutils.dtd:
1084   - Updated for plural attributes "classes", "ids", "names",
1085     "dupnames".
1087 * docs/user/emacs.txt: Added to project; a document about Emacs
1088   support for reStructuredText and Docutils.
1090 * docs/user/links.txt: Added to project; lists of Docutils-related
1091   links.
1093 * docs/user/mailing-lists.txt: Added to project; information about
1094   Docutils-related mailing lists and how to access them.
1096 * docs/user/slide-shows.txt: Added to project; example of and docs for
1097   the S5/HTML writer (``rst2s5.py`` front end).
1099 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1100   Files", added to project.
1102 * test/coverage.sh: Added to project; test coverage script.
1104 * test/DocutilsTestSupport.py:
1106   - Added support for specifying runtime settings at the suite level.
1108 * test/test_functional.py:
1110   - Added the ``clear_output_directory`` function.
1111   - Added support for ``_test_more`` functions in functional test
1112     config files.
1114 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1116 * tools/rstpep2html.py: Renamed from pep.py.
1118 * tools/dev/create_unimap.py: Added to project; script to create the
1119   docutils/writers/unimap_latex.py mapping file.
1121 * tools/dev/profile_docutils.py: Added to project; profiler script.
1123 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1125 * tools/editors/emacs/restructuredtext.el,
1126   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1127   Removed from project; the functionality is now contained in rst.el.
1129 * tools/editors/emacs/rst.el: Added to project.  Added many features
1130   and fixed many bugs.  See docs/user/emacs.txt for details.
1132 * tools/stylesheets: Removed from project.  Stylesheets have been
1133   renamed and moved into writer packages.
1136 Release 0.3.9 (2005-05-26)
1137 ==========================
1139 * General:
1141   - Eliminated and replaced all uses of the old string attributes
1142     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1143     new list attributes ``ids``, ``names``, ``dupnames`` and
1144     ``classes`` throughout the whole source tree.
1146 * docutils/core.py:
1148   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1149     allowing for easier debugging.
1150   - In ``Publisher.publish()``, expanded the generic top-level
1151     exception catching.
1153 * docutils/examples.py:
1155   - Added ``internals`` function for exploration.
1157 * docutils/io.py:
1159   - Fixed ``Input.decode`` method to apply heuristics only if no
1160     encoding is explicitly given, and to provide better reporting of
1161     decoding errors.
1162   - The ``Input.decode`` method now removes byte order marks (BOMs)
1163     from input streams.
1165 * docutils/nodes.py:
1167   - ``image`` element class changed to subclass of Element, not
1168     TextElement (it's an empty element, and cannot contain text).
1169   - Added ``attr_defaults`` dictionary for default attribute values.
1170   - Added empty list as default value for the following attributes:
1171     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1172   - Added ``document.decoration`` attribute,
1173     ``document.get_decoration`` method, and ``decoration.get_header``
1174     & ``.get_footer`` methods.
1175   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1176     methods.
1178 * docutils/utils.py:
1180   - Removed ``docutils.utils.Reporter.categories``,
1181     ``docutils.utils.ConditionSet``, and all references to them, to
1182     simplify error reporting.
1184 * docutils/languages/nl.py: Added to project; Dutch mappings by
1185   Martijn Pieters.
1187 * docutils/parsers/rst/__init__.py:
1189   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1191 * docutils/parsers/rst/states.py:
1193   - Added check for escaped at-mark to prevent email address recognition.
1194   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1195     arguments>``.
1196   - Allowed whitespace in paths and URLs.
1197   - Added auto-enumerated list items.
1198   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1199     followed by text.
1200   - Added support for table stub columns.
1202 * docutils/parsers/rst/directives/__init__.py:
1204   - Allowed whitespace in paths (``path`` function).
1205   - Added ``uri`` directive option conversion function.
1207 * docutils/parsers/rst/directives/body.py:
1209   - Fixed illegal context bug with "topic" directive (allowed within
1210     sidebars; not within body elements).
1212 * docutils/parsers/rst/directives/images.py:
1214   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1215   - Added support for the ``file_insertion_enabled`` setting in the
1216     "figure" directive (disables "figwidth" option).
1217   - "image" directive: added checks for valid values of "align" option,
1218     depending on context.  "figure" directive: added specialized
1219     "align" option and attribute on "figure" element.
1220   - Made ":figwidth: image" option of "figure" directive work again.
1221   - Fixed bug with reference names containing uppercase letters
1222     (e.g. ``Name_``) in "target" option of "image" directive.
1224 * docutils/parsers/rst/directives/misc.py:
1226   - Fixed "include" and "raw" directives to catch text decoding
1227     errors.
1228   - Allowed whitespace in "include" & "raw" directive paths.
1229   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1230     settings in "include" & "raw" directives.
1232 * docutils/parsers/rst/directives/parts.py:
1234   - Added "header" & "footer" directives.
1235   - Fixed illegal context bug with "contents" directive (topics
1236     allowed within sidebars; not within body elements).
1238 * docutils/parsers/rst/directives/tables.py:
1240   - Added "list-table" directive.
1241   - Caught empty CSV table bug.
1242   - Added support for the ``file_insertion_enabled`` setting in the
1243     "csv-table" directive.
1244   - Added ``stub-columns`` option to "csv-table" and "list-table"
1245     directives.
1247 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1248   mappings by Martijn Pieters.
1250 * docutils/readers/standalone.py:
1252   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1253     options to activate or deactivate the SectSubTitle transform.
1255 * docutils/transforms/frontmatter.py:
1257   - Added SectSubTitle transform to promote titles of lone
1258     subsections to subtitles.
1260 * docutils/transforms/references.py:
1262   - Fixed mislocated internal targets bug, by propagating internal
1263     targets to the next node, making use of the newly added support
1264     for multiple names and IDs.
1265   - Fixed duplicate footnote label bug.
1266   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1267     transform.
1269 * docutils/writers/html4css1.py:
1271   - Fixed unencoded stylesheet reference bug (characters like "&" in
1272     stylesheet references).
1273   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1274     tags).
1275   - Added support for multiple IDs per node by creating empty ``span``
1276     tags.
1277   - Added the ``field_name_limit`` & ``option_limit`` settings &
1278     support.
1279   - Added support for table stub columns.
1280   - Added support for the ``align`` attribute on ``figure`` elements.
1281   - Added the ``cloak_email_addresses`` setting & support.
1282   - Added ``html_prolog``, ``html_head``, ``html_body``,
1283     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1284     ``docutils.core.publish_parts``.
1285   - Added support for section subtitles.
1287 * docutils/writers/latex2e.py:
1289   - Fixed tables starting with more than one multirow cell.
1290   - Improved --use-latex-docinfo so that organization/contact/address
1291     fields are lumped with the last author field and appear on the
1292     titlepage.
1293   - Made sure the titlepage is always shown with --use-latex-docinfo,
1294     even if the document has no title.
1295   - Made sure that latex doesn't fill in today's date if no date field
1296     was given.
1297   - Added support for section subtitles.
1299 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1300   (under development).
1302 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1304 * docs/api/publisher.txt:
1306   - Added "``publish_parts`` Details" section.
1308 * docutils/dev/repository.txt: Added to project; information about the
1309   Docutils Subversion repository.
1311 * docs/ref/docutils.dtd:
1313   - Added a ``stub`` attribute to the ``colspec`` element via the
1314     ``tbl.colspec.att`` parameter entity.
1315   - Allowed topic elements within sidebars
1316   - Added an ``align`` attribute to the ``figure`` element.
1318 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1319   writer.
1322 Release 0.3.7 (2004-12-24)
1323 ==========================
1325 * docutils/frontend.py:
1327   - Added options: --input-encoding-error-handler,
1328     --record-dependencies, --leave-footnote-reference-space,
1329     --strict-visitor.
1330   - Added command-line and config file support for "overrides" setting
1331     parameter.
1333 * docutils/io.py:
1335   - Added support for input encoding error handler.
1337 * docutils/nodes.py:
1339   - Added dispatch_visit and dispatch_departure methods to
1340     NodeVisitor; useful as a hook for Visitors.
1341   - Changed structure of ``line_block``; added ``line``.
1342   - Added ``compound`` node class.
1343   - Added a mechanism for Visitors to transitionally ignore new node
1344     classes.
1346 * docutils/utils.py:
1348   - Moved ``escape2null`` and ``unescape`` functions from
1349     docutils/parsers/rst/states.py.
1351 * docutils/parsers/rst/roles.py:
1353   - Added "raw" role.
1354   - Changed role function API: the "text" parameter now takes
1355     null-escaped interpreted text content.
1357 * docutils/parsers/rst/states.py:
1359   - Fixed bug where a "role" directive in a nested parse would crash
1360     the parser; the state machine's "language" attribute was not being
1361     copied over.
1362   - Added support for line block syntax.
1363   - Fixed directive parsing bug: argument-less directives didn't
1364     notice that arguments were present.
1365   - Removed error checking for transitions.
1366   - Added support for multiple classifiers in definition list items.
1367   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1368   - Changed role function API: the "text" parameter now takes
1369     null-escaped interpreted text content.
1370   - Empty sections and documents are allowed now.
1372 * docutils/parsers/rst/directives/__init__.py:
1374   - Added ``encoding`` directive option conversion function.
1375   - Allow multiple class names in class_option conversion function.
1377 * docutils/parsers/rst/directives/body.py:
1379   - Converted the line-block directive to use the new structure.
1380   - Extracted the old line-block functionality to the ``block``
1381     function (still used).
1382   - Added ``compound`` directive (thanks to Lea Wiemann).
1384 * docutils/parsers/rst/directives/misc.py:
1386   - Added "encoding" option to "include" and "raw" directives.
1387   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1388   - Allow multiple class names in the "class" directive.
1390 * docutils/parsers/rst/directives/parts.py:
1392   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1393     options.  Thanks to Lele Gaifax.
1395 * docutils/parsers/rst/directives/tables.py:
1397   - Added "encoding" directive to "csv-table" directive.
1398   - Added workaround for lack of Unicode support in csv.py, for
1399     non-ASCII CSV input.
1401 * docutils/transforms/misc.py:
1403   - Fixed bug when multiple "class" directives are applied to a single
1404     element.
1405   - Enabled multiple format names for "raw" directive.
1407 * docutils/transforms/references.py:
1409   - Added support for trimming whitespace from beside substitution
1410     references.
1412 * docutils/transforms/universal.py:
1414   - FinalChecks now checks for illegal transitions and moves
1415     transitions between sections.
1417 * docutils/writers/html4css1.py:
1419   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1420   - "stylesheet" and "stylesheet_path" settings are now mutually
1421     exclusive.
1422   - Added support for the new line_block/line structure.
1423   - --footnote-references now overrides
1424     --trim-footnote-reference-space, if applicable.
1425   - Added support for ``compound`` elements.
1426   - Enabled multiple format names for "raw" directive.
1427   - ``<p>`` tags of a paragraph which is the only visible child of the
1428     document node are no longer stripped.
1429   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1430     new method ``should_be_compact_paragraph()``.
1431   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1432     elements.
1433   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1434     the output if they have their ``class`` attribute set.
1435   - The whole document is now surrounded by a ``<div
1436     class="document">`` element.
1437   - Body-level images are now wrapped by their own ``<div>`` elements,
1438     with image classes copied to the wrapper, and for images which
1439     have the ``:align:`` option set, the surrounding ``<div>`` now
1440     receives a class attribute (like ``class="align-left"``).
1442 * docutils/writers/latex2e.py:
1444   - no newline after depart_term.
1445   - Added translations for some Unicode quotes.
1446   - Added option "font-encoding", made package AE the default.
1447   - "stylesheet" and "stylesheet_path" settings are now mutually
1448     exclusive.
1449   - --footnote-references now overrides
1450     --trim-footnote-reference-space, if applicable.
1451   - The footnote label style now matches the footnote reference style
1452     ("brackets" or "superscript").
1453   - Added support for ``compound`` elements.
1454   - Enabled multiple format names for "raw" directive.
1456 * docs/ref/docutils.dtd:
1458   - Changed structure of the ``line_block`` element; added ``line``.
1459   - Added ``compound`` element.
1460   - Added "ltrim" and "rtrim" attributes to
1461     ``substitution_definition`` element.
1462   - Enabled multiple format names for ``raw`` element.
1463   - Enabled multiple classifiers in ``definition_list_item`` elements.
1465 * docs/ref/rst/directives.txt
1467   - Marked "line-block" as deprecated.
1468   - "Class" directive now allows multiple class names.
1469   - Added "Rationale for Class Attribute Value Conversion".
1470   - Added warning about "raw" overuse/abuse.
1472 * docs/ref/rst/restructuredtext.txt:
1474   - Added syntax for line blocks.
1475   - Definition list items may have multiple classifiers.
1477 * docs/ref/rst/roles.txt:
1479   - Added "raw" role.
1481 * tools/stylesheets/default.css:
1483   - Added support for the new line_block structure.
1484   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1487 Release 0.3.5 (2004-07-29)
1488 ==========================
1490 General:
1492 * _`Documentation cleanup/reorganization`.
1494   - Created new subdirectories of docs/:
1496     * ``docs/user/``: introductory/tutorial material for end-users
1497     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1498     * ``docs/api/``: API reference material for client-developers
1499     * ``docs/ref/``: reference material for all groups
1500     * ``docs/howto/``: for component-developers and core-developers
1501     * ``docs/peps/``: Python Enhancement Proposals
1503   - Moved ``docs/*`` to ``docs/user/``.
1504   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1505     ``spec/`` to ``docs/dev``.
1506   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1507     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1508   - Moved ``alternatives.txt``, and ``problems.txt`` from
1509     ``spec/rst/`` to ``docs/dev/rst/``.
1510   - Moved ``reStructuredText.txt``, ``directives.txt``,
1511     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1512     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1513     ``roles.txt``, ``reStructuredText.txt`` to
1514     ``restructuredtext.txt``.
1515   - Moved ``spec/howto/`` to ``docs/howto``.
1517   In order to keep the CVS history of moved files, we supplied
1518   SourceForge with a `script for modifying the Docutils CVS
1519   repository`__.
1521   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1523   After running the cleanup script:
1525   - Added ``docs/index.txt``.
1526   - Added a ``.htaccess`` file to the ``web`` module, containing
1527     redirects for all old paths to new paths.  They'll preserve
1528     fragments (the "#name" part of a URL), and won't clutter up the
1529     file system, and will correct the URL in the user's browser.
1530   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1531     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1532     the "To Do" list itself in ``docs/dev/todo.txt``.
1533   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1534     section of ``docs/dev/todo.txt``.
1535   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1536   - Added "How To Report Bugs" to ``BUGS.txt``.
1537   - Went through all the sources and docs (including under web/) and
1538     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1539     (Still need to update links in the sandboxes.)
1541 Specific:
1543 * BUGS.txt: Added to project.
1545 * THANKS.txt: Added to project.
1547 * docutils/__init__.py:
1549   - 0.3.4: Post-release.
1551 * docutils/core.py:
1553   - Added special error handling & advice for UnicodeEncodeError.
1554   - Refactored Publisher.publish (simplified exception handling &
1555     extracted debug dumps).
1556   - Renamed "enable_exit" parameter of convenience functions to
1557     "enable_exit_status".
1558   - Enabled traceback (exception propagation) by default in
1559     programmatic convenience functions.
1560   - Now publish_file and publish_cmdline convenience functions return
1561     the encoded string results in addition to their regular I/O.
1562   - Extracted common code from publish_file, publish_string, and
1563     publish_parts, into new publish_programmatically.  Extracted
1564     settings code to ``Publisher.process_programmatic_settings``.
1565   - In Publisher.publish, disabled ``settings_overrides`` when
1566     ``settings`` is supplied; redundant.
1568 * docutils/frontend.py:
1570   - Added help text for "--output-encoding-error-handler" and
1571     "--error-encoding-error-handler".
1572   - Renamed "--exit" to "--exit-status".
1573   - Simplified default-setting code.
1575 * docutils/parsers/rst/__init__.py:
1577   - Added "--pep-base-url" and "--rfc-base-url" options.
1579 * docutils/parsers/rst/states.py:
1581   - Made URI recognition more aggressive and intelligent.
1583 * docutils/parsers/rst/directives/__init__.py:
1585   - Added several directive option conversion functions.
1587 * docutils/parsers/rst/directives/body.py:
1589   - Moved "table" directive to tables.py.
1591 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1592   added to project.
1594 * docutils/writers/latex2e.py:
1596   - Added "--table-style=(standard|booktabs|nolines)"
1597   - figures get "here" option (LaTeX per default puts them at bottom),
1598     and figure content is centered.
1599   - Rowspan support for tables.
1600   - Fix: admonition titles before first section.
1601   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1602   - Replave ``_`` in literal by an underlined blank, because it has the correct
1603     width.
1604   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1605   - A few unicode replacements, if output_encoding != utf
1606   - Add "--graphicx-option".
1607   - Indent literal-blocks.
1608   - Fix: omit ``\maketitle`` when there is no document title.
1610 * docs/index.txt: "Docutils Project Documentation Overview", added to
1611   project.
1613 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1614   Tool", added to project.
1616 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1618 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1620 * docs/dev/policies.txt: Added to project (extracted from
1621   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1623 * docs/dev/release.txt: Added to project (extracted from
1624   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1626 * docs/dev/testing.txt: Added to project.
1628 * docs/dev/website.txt: Added to project (extracted from
1629   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1631 * docs/ref/rst/directives.txt:
1633   - Added directives: "table", "csv-table".
1635 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1636   added to project.  1 page for syntax, and a 1 page reference for
1637   directives and roles.  Source text to be used as-is; not meant to be
1638   converted to HTML.
1640 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1641   with a change of title.
1643 * test/functional/, contents, and test/test_functional.py: Added to
1644   project.
1646 * tools/buildhtml.py: Fixed bug with config file handling.
1648 * tools/html.py: Removed from project (duplicate of rst2html.py).
1650 * tools/pep2html.py: Removed from project (duplicate of Python's
1651   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1652   Docutils-related PEPs in docs/peps/).
1654 * tools/rst2pseudoxml.py: Renamed from publish.py.
1656 * tools/rst2xml.py: Renamed from docutils-xml.py.
1658 * tools/test.txt: Removed from project; moved to
1659   docs/user/rst/demo.txt.
1661 * setup.py: Now also installs ``rst2latex.py``.
1664 Release 0.3.3 (2004-05-09)
1665 ==========================
1667 * docutils/__init__.py:
1669   - 0.3.1: Reorganized config file format (multiple sections); see
1670     docs/config.txt.
1671   - Added unknown_reference_resolvers attribute to TransformSpec.
1672   - 0.3.2: Interpreted text reorganization.
1673   - 0.3.3: Released.
1675 * docutils/core.py:
1677   - Catch system messages to stop tracebacks from parsing errors.
1678   - Catch exceptions during processing report & exit without
1679     tracebacks, except when "--traceback" used.
1680   - Reordered components for OptionParser; application comes last.
1681   - Added "config_section" parameter to several methods and functions,
1682     allowing front ends to easily specify their config file sections.
1683   - Added publish_parts convenience function to allow access to individual
1684     parts of a document.
1686 * docutils/examples.py: Added to project; practical examples of
1687   Docutils client code, to be used as-is or as models for variations.
1689 * docutils/frontend.py:
1691   - Added "--traceback" & "--no-traceback" options ("traceback"
1692     setting).
1693   - Implemented support for config file reorganization:
1694     ``standard_config_files`` moved from ``ConfigParser`` to
1695     ``OptionParser``; added
1696     ``OptionParser.get_config_file_settings()`` and
1697     ``.get_standard_config_settings()``; support for old "[options]"
1698     section (with deprecation warning) and mapping from old to new
1699     settings.
1700   - Reimplemented setting validation.
1701   - Enabled flexible boolean values: yes/no, true/false, on/off.
1702   - Added ``Values``, a subclass of ``optparse.Values``, with support
1703     for list setting attributes.
1704   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1705     thanks to Beni Cherniavsky.
1706   - Added "--no-section-numbering" option.
1708 * docutils/io.py:
1710   - Catch IOErrors when opening source & destination files, report &
1711     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1712     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1714 * docutils/nodes.py:
1716   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1717     method definitions (via ``exec``) to dynamic assignments (via
1718     ``setattr``); thanks to Roman Suzi.
1719   - Encapsulated visitor dynamic assignments in a function; thanks to
1720     Ian Bicking.
1721   - Added indirect_reference_name attribute to the Targetable
1722     class. This attribute holds the whitespace_normalized_name
1723     (contains mixed case) of a target.
1725 * docutils/statemachine.py:
1727   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1728   - Added ``StringList.get_2D_block``.
1730 * docutils/utils.py:
1732   - Added "level" attribute to SystemMessage exceptions.
1734 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1735   Jannie Hofmeyr.
1737 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1738   Blaha.
1740 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1741   Marcelo Huerta San Martin.
1743 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1744   mappings by Lalo Martins.
1746 * docutils/languages/ru.py: Added to project; Russian mappings by
1747   Roman Suzi.
1749 * docutils/parsers/rst/roles.py: Added to project.  Contains
1750   interpreted text role functions, a registry for interpreted text
1751   roles, and an API for adding to and retrieving from the registry.
1752   Contributed by Edward Loper.
1754 * docutils/parsers/rst/states.py:
1756   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1757   - Allowed true em-dash character and "---" as block quote
1758     attribution marker.
1759   - Added support for <angle-bracketed> complex option arguments
1760     (option lists).
1761   - Fixed handling of backslashes in substitution definitions.
1762   - Fixed off-by-1 error with extra whitespace after substitution
1763     definition directive.
1764   - Added inline markup parsing to field lists' field names.
1765   - Added support for quoted (and unindented) literal blocks.
1766     Driven in part by a bribe from Frank Siebenlist (thanks!).
1767   - Parser now handles escapes in URIs correctly.
1768   - Made embedded-URIs' reference text omittable.  Idea from Beni
1769     Cherniavsky.
1770   - Refactored explicit target processing code.
1771   - Added name attribute to references containing the reference name only
1772     through whitespace_normalize_name (no case changes).
1773   - parse_target no longer returns the refname after going through
1774     normalize_name. This is now handled in make_target.
1775   - Fixed bug relating to role-less interpreted text in non-English
1776     contexts.
1777   - Reorganized interpreted text processing; moved code into the new
1778     roles.py module.  Contributed by Edward Loper.
1779   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1780     ``parse_directive_block``.
1782 * docutils/parsers/rst/tableparser.py:
1784   - Reworked for ``StringList``, to support "include" directives in
1785     table cells.
1787 * docutils/parsers/rst/directives/__init__.py:
1789   - Renamed ``unchanged()`` directive option conversion function to
1790     ``unchanged_required``, and added a new ``unchanged``.
1791   - Catch unicode value too high error; fixes bug 781766.
1792   - Beefed up directive error reporting.
1794 * docutils/parsers/rst/directives/body.py:
1796   - Added basic "table" directive.
1798 * docutils/parsers/rst/directives/images.py:
1800   - Added "target" option to "image" directive.
1801   - Added name attribute to references containing the reference name only
1802     through whitespace_normalize_name (no case changes).
1804 * docutils/parsers/rst/directives/misc.py:
1806   - Isolated the import of the ``urllib2`` module; was causing
1807     problems on SourceForge (``libssl.so.2`` unavailable?).
1808   - Added the "role" directive for declaring custom interpreted text
1809     roles.
1811 * docutils/parsers/rst/directives/parts.py:
1813   - The "contents" directive does more work up-front, creating the
1814     "topic" and "title", and leaving the "pending" node for the
1815     transform.  Allows earlier reference resolution; fixes subtle bug.
1817 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1818   mappings by Jannie Hofmeyr.
1820 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1821   mappings by Marek Blaha.
1823 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1824   mappings by Marcelo Huerta San Martin.
1826 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1827   Portuguese mappings by Lalo Martins.
1829 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1830   mappings by Roman Suzi.
1832 * docutils/transforms/parts.py:
1834   - The "contents" directive does more work up-front, creating the
1835     "topic" and "title", and leaving the "pending" node for the
1836     transform.  Allows earlier reference resolution; fixes subtle bug.
1837   - Added support for disabling of section numbering.
1839 * docutils/transforms/references.py:
1841   - Verifying that external targets are truly targets and not indirect
1842     references. This is because we are now adding a "name" attribute to
1843     references in addition to targets. Note sure if this is correct!
1844   - Added code to hook into the unknown_reference_resolvers list for a
1845     transformer in resolve_indirect_target. This allows the
1846     unknown_reference_resolvers to keep around indirect targets which
1847     docutils doesn't know about.
1848   - Added specific error message for duplicate targets.
1850 * docutils/transforms/universal.py:
1852   - Added FilterMessages transform (removes system messages below the
1853     verbosity threshold).
1854   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1855     to FinalCheckVisitor for application-specific handling of
1856     unresolvable references.
1857   - Added specific error message for duplicate targets.
1859 * docutils/writers/__init__.py:
1861   - Added assemble_parts method to the Writer class to allow for
1862     access to a documents individual parts.
1863   - Documented & set default for ``Writer.output`` attribute.
1865 * docutils/writers/html4css1.py:
1867   - Fixed unicode handling of attribute values (bug 760673).
1868   - Prevent duplication of "class" attribute values (bug report from
1869     Kirill Lapshin).
1870   - Improved table grid/border handling (prompted by report from Bob
1871     Marshall).
1872   - Added support for table titles.
1873   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1874     to Darek Suchojad.
1875   - Added functionality to keep track of individual parts of a document
1876     and store them in a dictionary as the "parts" attribute of the writer.
1877     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1878   - Added proper support for the "scale" attribute of the "image"
1879     element.  Contributed by Brent Cook.
1880   - Added ``--initial-header-level`` option.
1881   - Fixed bug: the body_pre_docinfo segment depended on there being a
1882     docinfo; if no docinfo, the document title was incorporated into
1883     the body segment.  Adversely affected the publish_parts interface.
1885 * docutils/writers/latex2e.py:
1887   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1888     about a missing file.
1889   - Added options and support: ``--compound-enumerators``,
1890     ``--section-prefix-for-enumerators``, and
1891     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1892     934322).
1893   - Added option ``--use-verbatim-when-possible``, to avoid
1894     problematic characters (eg, '~' in italian) in literal blocks.
1895   - It's now possible to use four section levels in the `book` and
1896     `report` LaTeX classes.  The default `article` class still has
1897     three levels limit.
1899 * docs/config.txt: "Docutils Configuration Files", added to project.
1900   Moved config file entry descriptions from tools.txt.
1902 * docs/tools.txt:
1904   - Moved config file entry descriptions to config.txt.
1906 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1907   Development".
1909 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1910   Text Roles", added to project.
1912 * spec/rst/reStructuredText.txt:
1914   - Added description of support for <angle-bracketed> complex option
1915     arguments to option lists.
1916   - Added subsections for indented and quoted literal blocks.
1918 * test: Continually adding & updating tests.
1920   - Added test/test_settings.py & test/data/config_*.txt support
1921     files.
1922   - Added test/test_writers/test_htmlfragment.py.
1924 * test/DocutilsTestSupport.py:
1926   - Refactored LaTeX publisher test suite/case class names to make
1927     testing other writers easier.
1928   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1929     to test the processing of HTML fragments which use the new
1930     publish_parts convenience function.
1932 * tools/buildhtml.py:
1934   - Added support for the "--prune" option.
1935   - Removed dependency on pep2html.py; plaintext PEPs no longer
1936     supported.
1938 * tools/docutils.conf:
1940   - Updated for configuration file reorganization.
1942 * tools/rst2html.py:
1944   - copied from tools/html.py
1946 * setup.py:
1948   - added a 'scripts' section to configuration
1949   - added 'tools/rst2html.py' to the scripts section
1952 Release 0.3 (2003-06-24)
1953 ========================
1955 General:
1957 * Renamed "attribute" to "option" for directives/extensions.
1959 * Renamed transform method "transform" to "apply".
1961 * Renamed "options" to "settings" for runtime settings (as set by
1962   command-line options).  Sometimes "option" (singular) became
1963   "settings" (plural).  Some variations below:
1965   - document.options -> document.settings (stored in other objects as
1966     well)
1967   - option_spec -> settings_spec (not directives though)
1968   - OptionSpec -> SettingsSpec
1969   - cmdline_options -> settings_spec
1970   - relative_path_options -> relative_path_settings
1971   - option_default_overrides -> settings_default_overrides
1972   - Publisher.set_options -> Publisher.get_settings
1974 Specific:
1976 * COPYING.txt: Added "Public Domain Dedication".
1978 * FAQ.txt: Frequently asked questions, added to project.
1980 * setup.py:
1982   - Updated with PyPI Trove classifiers.
1983   - Conditional installation of third-party modules.
1985 * docutils/__init__.py:
1987   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1988   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1989   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1990   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1991     option and its effect on the PEP template & writer.
1992   - Bumped version to 0.2.4 due to changes to the PEP template &
1993     stylesheet.
1994   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1995   - Added ``TransformSpec`` class for new transform system.
1996   - Bumped version to 0.2.6 for API changes (renaming).
1997   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1998     convenience functions.
1999   - Added ``Component.component_type`` attribute.
2000   - Bumped version to 0.2.8 because of the internal parser switch from
2001     plain lists to the docutils.statemachine.StringList objects.
2002   - Bumped version to 0.2.9 because of the frontend.py API changes.
2003   - Bumped version to 0.2.10 due to changes to the project layout
2004     (third-party modules removed from the "docutils" package), and
2005     signature changes in ``io.Input``/``io.Output``.
2006   - Changed version to 0.3.0 for release.
2008 * docutils/core.py:
2010   - Made ``publish()`` a bit more convenient.
2011   - Generalized ``Publisher.set_io``.
2012   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2013     parameters; improved its docstring.
2014   - Added ``publish_file()`` and ``publish_string()``.
2015   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2016     out of ``.set_io``.
2017   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2018     "--dump-transforms" hidden options.
2019   - Added ``Publisher.apply_transforms()`` method.
2020   - Added ``Publisher.set_components()`` method; support for
2021     ``publish_*()`` conveninece functions.
2022   - Moved config file processing to docutils/frontend.py.
2023   - Added support for exit status ("exit_level" setting &
2024     ``enable_exit`` parameter for Publisher.publish() and convenience
2025     functions).
2027 * docutils/frontend.py:
2029   - Check for & exit on identical source & destination paths.
2030   - Fixed bug with absolute paths & "--config".
2031   - Set non-command-line defaults in ``OptionParser.__init__()``:
2032     ``_source`` & ``_destination``.
2033   - Distributed ``relative_path_settings`` to components; updated
2034     ``OptionParser.populate_from_components()`` to combine it all.
2035   - Require list of keys in ``make_paths_absolute`` (was implicit in
2036     global ``relative_path_settings``).
2037   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2038     "--dump-settings", and "--dump-transforms" hidden options.
2039   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2040     code, replaced with correct code.
2041   - Added validation functionality for config files.
2042   - Added "--error-encoding" option/setting, "_disable_config"
2043     internal setting.
2044   - Added encoding validation; updated "--input-encoding" and
2045     "--output-encoding"; added "--error-encoding-error-handler" and
2046     "--output-encoding-error-handler".
2047   - Moved config file processing from docutils/core.py.
2048   - Updated ``OptionParser.populate_from_components`` to handle new
2049     ``SettingsSpec.settings_defaults`` dict.
2050   - Added support for "-" => stdin/stdout.
2051   - Added "exit_level" setting ("--exit" option).
2053 * docutils/io.py:
2055   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2056   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2057   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2058   - ``FileOutput.write()`` now returns the encoded output string.
2059   - Try to get path/stream name automatically in ``FileInput`` &
2060     ``FileOutput``.
2061   - Added defaults for source & destination paths.
2062   - Allow for Unicode I/O with an explicit "unicode" encoding.
2063   - Added ``Output.encode()``.
2064   - Removed dependency on runtime settings; pass encoding directly.
2065   - Recognize Unicode strings in ``Input.decode()``.
2066   - Added support for output encoding error handlers.
2068 * docutils/nodes.py:
2070   - Added "Invisible" element category class.
2071   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2072     modification during a traversal.
2073   - Added element classes: ``line_block``, ``generated``, ``address``,
2074     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2075     ``superscript``, ``subscript``, ``inline``
2076   - Added support for lists of nodes to ``Element.insert()``.
2077   - Fixed parent linking in ``Element.replace()``.
2078   - Added new abstract superclass ``FixedTextElement``; adds
2079     "xml:space" attribute.
2080   - Added support for "line" attribute of ``system_message`` nodes.
2081   - Added support for the observer pattern from ``utils.Reporter``.
2082     Added ``parse_messages`` and ``transform_messages`` attributes to
2083     ``document``, removed ``messages``.  Added ``note_parse_message``
2084     and ``note_transform_message`` methods.
2085   - Added support for improved diagnostics:
2087     - Added "document", "source", and "line" internal attributes to
2088       ``Node``, set by ``Node.setup_child()``.
2089     - Converted variations on ``node.parent = self`` to
2090       ``self.setup_child(node)``.
2091     - Added ``document.current_source`` & ``.current_line``
2092       attributes, and ``.note_source`` observer method.
2093     - Changed "system_message" output to GNU-Tools format.
2095   - Added a "rawsource" attribute to the ``Text`` class, for text
2096     before backslash-escape resolution.
2097   - Support for new transform system.
2098   - Reworked ``pending`` element.
2099   - Fixed XML DOM bug (SF #660611).
2100   - Removed the ``interpeted`` element class and added
2101     ``title_reference``, ``abbreviation``, ``acronym``.
2102   - Made substitutions case-sensitive-but-forgiving; moved some code
2103     from the parser.
2104   - Fixed Unicode bug on element attributes (report: William Dode).
2106 * docutils/optik.py: Removed from project; replaced with
2107   extras/optparse.py and extras/textwrap.py.  These will be installed
2108   only if they're not already present in the Python installation.
2110 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2111   only if it's not already present in the Python installation.
2113 * docutils/statemachine.py:
2115   - Factored out ``State.add_initial_transitions()`` so it can be
2116     extended.
2117   - Converted whitespace-specific "blank" and "indent" transitions
2118     from special-case code to ordinary transitions: removed
2119     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2120     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2121     ``ws_initial_transitions`` attributes.
2122   - Removed ``State.match_transition()`` after merging it into
2123     ``.check_line()``.
2124   - Added ``StateCorrection`` exception.
2125   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2126     (moved ``TransitionCorrection`` support there too.)
2127   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2128     ``EOFError`` instead of ``IndexError``.
2129   - Added ``State.no_match`` method.
2130   - Added support for the Observer pattern, triggered by input line
2131     changes.
2132   - Added ``strip_top`` parameter to
2133     ``StateMachineWS.get_first_known_indented``.
2134   - Made ``context`` a parameter to ``StateMachine.run()``.
2135   - Added ``ViewList`` & ``StringList`` classes;
2136     ``extract_indented()`` becomes ``StringList.get_indented()``.
2137   - Added ``StateMachine.insert_input()``.
2138   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2139     thanks to) Fred Drake.
2141 * docutils/utils.py:
2143   - Added a ``source`` attribute to Reporter instances and
2144     ``system_message`` elements.
2145   - Added an observer pattern to ``utils.Reporter`` to keep track of
2146     system messages.
2147   - Fixed bugs in ``relative_path()``.
2148   - Added support for improved diagnostics.
2149   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2150   - Added support for encoding Reporter stderr output, and encoding
2151     error handlers.
2152   - Reporter keeps track of the highest level system message yet
2153     generated.
2155 * docutils/languages: Fixed bibliographic field language lookups.
2157 * docutils/languages/es.py: Added to project; Spanish mappings by
2158   Marcelo Huerta San Martin.
2160 * docutils/languages/fr.py: Added to project; French mappings by
2161   Stefane Fermigier.
2163 * docutils/languages/it.py: Added to project; Italian mappings by
2164   Nicola Larosa.
2166 * docutils/languages/sk.py: Added to project; Slovak mappings by
2167   Miroslav Vasko.
2169 * docutils/parser/__init__.py:
2171   - Added ``Parser.finish_parse()`` method.
2173 * docutils/parser/rst/__init__.py:
2175   - Added options: "--pep-references", "--rfc-references",
2176     "--tab-width", "--trim-footnote-reference-space".
2178 * docutils/parsers/rst/states.py:
2180   - Changed "title under/overline too short" system messages from INFO
2181     to WARNING, and fixed its insertion location.
2182   - Fixed enumerated list item parsing to allow paragraphs & section
2183     titles to begin with enumerators.
2184   - Converted system messages to use the new "line" attribute.
2185   - Fixed a substitution reference edge case.
2186   - Added support for "--pep-references" and "--rfc-references"
2187     options; reworked ``Inliner`` code to make customization easier.
2188   - Removed field argument parsing.
2189   - Added support for short section title over/underlines.
2190   - Fixed "simple reference name" regexp to ignore text like
2191     "object.__method__"; not an anonymous reference.
2192   - Added support for improved diagnostics.
2193   - Reworked directive API, based on Dethe Elza's contribution.  Added
2194     ``Body.parse_directive()``, ``.parse_directive_options()``,
2195     ``.parse_directive_arguments()`` methods.
2196   - Added ``ExtensionOptions`` class, to parse directive options
2197     without parsing field bodies.  Factored
2198     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2199     ``ExtensionOptions``.
2200   - Improved definition list term/classifier parsing.
2201   - Added warnings for unknown directives.
2202   - Renamed ``Stuff`` to ``Struct``.
2203   - Now flagged as errors: transitions at the beginning or end of
2204     sections, empty sections (except title), and empty documents.
2205   - Updated for ``statemachine.StringList``.
2206   - Enabled recognition of schemeless email addresses in targets.
2207   - Added support for embedded URIs in hyperlink references.
2208   - Added backslash-escapes to inline markup end-string suffix.
2209   - Added support for correct interpreted text processing.
2210   - Fixed nested title parsing (topic, sidebar directives).
2211   - Added special processing of backslash-escaped whitespace (idea
2212     from David Abrahams).
2213   - Made substitutions case-sensitive-but-forgiving; moved some code
2214     to ``docutils.nodes``.
2215   - Added support for block quote attributions.
2216   - Added a kludge to work-around a conflict between the bubble-up
2217     parser strategy and short titles (<= 3 char-long over- &
2218     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2219     titles" submitted by Jason Diamond.
2220   - Added explicit interpreted text roles for standard inline markup:
2221     "emphasis", "strong", "literal".
2222   - Implemented "superscript" and "subscript" interpreted text roles.
2223   - Added initial support for "abbreviation" and "acronym" roles;
2224     incomplete.
2225   - Added support for "--trim-footnote-reference-space" option.
2226   - Optional space before colons in directives & hyperlink targets.
2228 * docutils/parsers/rst/tableparser.py:
2230   - Fixed a bug that was producing unwanted empty rows in "simple"
2231     tables.
2232   - Detect bad column spans in "simple" tables.
2234 * docutils/parsers/rst/directives: Updated all directive functions to
2235   new API.
2237 * docutils/parsers/rst/directives/__init__.py:
2239   - Added ``flag()``, ``unchanged()``, ``path()``,
2240     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2241     directive option helper functions.
2242   - Added warnings for unknown directives.
2243   - Return ``None`` for missing directives.
2244   - Added ``register_directive()``, thanks to William Dode and Paul
2245     Moore.
2247 * docutils/parsers/rst/directives/admonitions.py:
2249   - Added "admonition" directive.
2251 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2252   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2253   "parsed-literal", "rubric", "epigraph", "highlights" and
2254   "pull-quote" directives.
2256 * docutils/parsers/rst/directives/images.py:
2258   - Added an "align" attribute to the "image" & "figure" directives
2259     (by Adam Chodorowski).
2260   - Added "class" option to "image", and "figclass" to "figure".
2262 * docutils/parsers/rst/directives/misc.py:
2264   - Added "include", "raw", and "replace" directives, courtesy of
2265     Dethe Elza.
2266   - Added "unicode" and "class" directives.
2268 * docutils/parsers/rst/directives/parts.py:
2270   - Added the "sectnum" directive; by Dmitry Jemerov.
2271   - Added "class" option to "contents" directive.
2273 * docutils/parsers/rst/directives/references.py: Added to project.
2274   Contains the "target-notes" directive.
2276 * docutils/parsers/rst/languages/__init__.py:
2278   - Return ``None`` from get_language() for missing language modules.
2280 * docutils/parsers/rst/languages/de.py: Added to project; German
2281   mappings by Engelbert Gruber.
2283 * docutils/parsers/rst/languages/en.py:
2285   - Added interpreted text roles mapping.
2287 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2288   mappings by Marcelo Huerta San Martin.
2290 * docutils/parsers/rst/languages/fr.py: Added to project; French
2291   mappings by William Dode.
2293 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2294   mappings by Nicola Larosa.
2296 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2297   mappings by Miroslav Vasko.
2299 * docutils/readers/__init__.py:
2301   - Added support for the observer pattern from ``utils.Reporter``, in
2302     ``Reader.parse`` and ``Reader.transform``.
2303   - Removed ``Reader.transform()`` method.
2304   - Added default parameter values to ``Reader.__init__()`` to make
2305     instantiation easier.
2306   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2308 * docutils/readers/pep.py:
2310   - Added the ``peps.TargetNotes`` transform to the Reader.
2311   - Removed PEP & RFC reference detection code; moved to
2312     parsers/rst/states.py as options (enabled here by default).
2313   - Added support for pre-acceptance PEPs (no PEP number yet).
2314   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2315     easy subclassing.
2317 * docutils/readers/python: Python Source Reader subpackage added to
2318   project, including preliminary versions of:
2320   - __init__.py
2321   - moduleparser.py: Parser for Python modules.
2323 * docutils/transforms/__init__.py:
2325   - Added ``Transformer`` class and completed transform reform.
2326   - Added unknown_reference_resolvers list for each transformer. This list holds
2327     the list of functions provided by each component of the transformer that
2328     help resolve references.
2330 * docutils/transforms/frontmatter.py:
2332   - Improved support for generic fields.
2333   - Fixed bibliographic field language lookups.
2335 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2336   transforms.
2338 * docutils/transforms/parts.py:
2340   - Moved the "id" attribute from TOC list items to the references
2341     (``Contents.build_contents()``).
2342   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2343   - Added "class" attribute support to ``Contents``.
2345 * docutils/transforms/peps.py:
2347   - Added ``mask_email()`` function, updating to pep2html.py's
2348     functionality.
2349   - Linked "Content-Type: text/x-rst" to PEP 12.
2350   - Added the ``TargetNotes`` PEP-specific transform.
2351   - Added ``TargetNotes.cleanup_callback``.
2352   - Added title check to ``Headers``.
2354 * docutils/transforms/references.py:
2356   - Added the ``TargetNotes`` generic transform.
2357   - Split ``Hyperlinks`` into multiple transforms.
2358   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2359   - Added check for circular indirect references.
2360   - Made substitutions case-sensitive-but-forgiving.
2362 * docutils/transforms/universal.py:
2364   - Added support for the "--expose-internal-attributes" option.
2365   - Removed ``Pending`` transform classes & data.
2367 * docutils/writers/__init__.py:
2369   - Removed ``Writer.transform()`` method.
2371 * docutils/writers/docutils-xml.py:
2373   - Added XML and doctype declarations.
2374   - Added "--no-doctype" and "--no-xml-declaration" options.
2376 * docutils/writers/html4css1.py:
2378   - "name" attributes only on these tags: a, applet, form, frame,
2379     iframe, img, map.
2380   - Added "name" attribute to <a> in section titles for Netscape 4
2381     support (bug report: Pearu Peterson).
2382   - Fixed targets (names) on footnote, citation, topic title,
2383     problematic, and system_message nodes (for Netscape 4).
2384   - Changed field names from "<td>" to "<th>".
2385   - Added "@" to "&#64;" encoding to thwart address harvesters.
2386   - Improved the vertical whitespace optimization; ignore "invisible"
2387     nodes (targets, comments, etc.).
2388   - Improved inline literals with ``<span class="pre">`` around chunks
2389     of text and ``&nbsp;`` for runs of spaces.
2390   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2391     ``self.docinfo`` segments.
2392   - Added support for "line_block", "address" elements.
2393   - Improved backlinks (footnotes & system_messages).
2394   - Improved system_message output.
2395   - Redefined "--stylesheet" as containing an invariant URL, used
2396     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2397     working directory.
2398   - Added "--footnote-references" option (superscript or brackets).
2399   - Added "--compact-lists" and "--no-compact-lists" options.
2400   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2401     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2402   - Improved field list rendering.
2403   - Added Docutils version to "generator" meta tag.
2404   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2405   - Improved layout of <pre> HTML source.
2406   - Fixed attribute typo on <colspec>.
2407   - Refined XML prologue.
2408   - Support for no stylesheet.
2409   - Removed "interpreted" element support.
2410   - Added support for "title_reference", "sidebar", "attribution",
2411     "rubric", and generic "admonition" elements.
2412   - Added "--attribution" option.
2413   - Added support for "inline", "subscript", "superscript" elements.
2414   - Added initial support for "abbreviation" and "acronym";
2415     incomplete.
2417 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2418   (from the sandbox).
2420   - Added french.
2421   - Double quotes in literal blocks (special treatment for de/ngerman).
2422   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2423   - Added  "--attribution" option.
2424   - Right align attributions.
2426 * docutils/writers/pep_html.py:
2428   - Parameterized output encoding in PEP template.
2429   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2430   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2431     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2432     working directory.
2433   - Added an override on the "--footnote-references" option.
2434   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2435   - Added Docutils version to "generator" meta tag.
2436   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2438 * docs/tools.txt:
2440   - Added a "silent" setting for ``buildhtml.py``.
2441   - Added a "Getting Help" section.
2442   - Rearranged the structure.
2443   - Kept up to date, with new settings, command-line options etc.
2444   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2445   - Converted settings table into a definition list.
2447 * docs/rst/quickstart.txt:
2449   - Added a table of contents.
2450   - Added feedback information.
2451   - Added mention of minimum section title underline lengths.
2452   - Removed the 4-character minimum for section title underlines.
2454 * docs/rst/quickref.html:
2456   - Added a "Getting Help" section.
2457   - Added a style to make section title backlinks more subtle.
2458   - Added mention of minimum section title underline lengths.
2459   - Removed the 4-character minimum for section title underlines.
2461 * extras: Directory added to project; contains third-party modules
2462   that Docutils depends on (optparse, textwrap, roman).  These are
2463   only installed if they're not already present.
2465 * licenses: Directory added to project; contains copies of license
2466   files for non-public-domain files.
2468 * spec/doctree.txt:
2470   - Changed the focus.  It's about DTD elements:  structural
2471     relationships, semantics, and external (public) attributes.  Not
2472     about the element class library.
2473   - Moved some implementation-specific stuff into ``docutils.nodes``
2474     docstrings.
2475   - Wrote descriptions of all common attributes and parameter
2476     entities.  Filled in introductory material.
2477   - Working through the element descriptions: 55 down, 37 to go.
2478   - Removed "Representation of Horizontal Rules" to
2479     spec/rst/alternatives.txt.
2481 * spec/docutils.dtd:
2483   - Added "generated" inline element.
2484   - Added "line_block" body element.
2485   - Added "auto" attribute to "title".
2486   - Changed content models of "literal_block" and "doctest_block" to
2487     ``%text.model``.
2488   - Added ``%number;`` attribute type parameter entity.
2489   - Changed ``%structural.elements;`` to ``%section.elements``.
2490   - Updated attribute types; made more specific.
2491   - Added "address" bibliographic element.
2492   - Added "line" attribute to ``system_message`` element.
2493   - Removed "field_argument" element; "field_name" may contain
2494     multiple words and whitespace.
2495   - Changed public identifier to docutils.sf.net.
2496   - Removed "interpreted" element; added "title_reference",
2497     "abbreviation", "acronym".
2498   - Removed "refuri" attribute from "footnote_reference" and
2499     "citation_reference".
2500   - Added "sidebar", "rubric", "attribution", "admonition",
2501     "superscript", "subscript", and "inline" elements.
2503 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2505 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2507 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2509 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2510   Dallas Mahrt.
2512 * spec/transforms.txt: Added to project.
2514 * spec/howto: Added subdirectory, for developer how-to docs.
2516 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2517   Elza, edited & extended by David Goodger.
2519 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2520   project.
2522 * spec/rst/alternatives.txt:
2524   - Added "Doctree Representation of Transitions" from
2525     spec/doctree.txt.
2526   - Updated "Inline External Targets" & closed the debate.
2527   - Added ideas for interpreted text syntax extensions.
2528   - Added "Nested Inline Markup" section.
2530 * spec/rst/directives.txt:
2532   - Added directives: "topic", "sectnum", "target-notes",
2533     "line-block", "parsed-literal", "include", "replace", "sidebar",
2534     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2535     "class".
2536   - Formalized descriptions of directive details.
2537   - Added an "align" attribute to the "image" & "figure" directives
2538     (by Adam Chodorowski).
2539   - Added "class" options to "topic", "sidebar", "line-block",
2540     "parsed-literal", "contents", and "image"; and "figclass" to
2541     "figure".
2543 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2544   interpreted text roles.
2546 * spec/rst/introduction.txt:
2548   - Added pointers to material for new users.
2550 * spec/rst/reStructuredText.txt:
2552   - Disambiguated comments (just add a newline after the "::").
2553   - Updated enumerated list description; added a discussion of the
2554     second-line validity checking.
2555   - Updated directive description.
2556   - Added a note redirecting newbies to the user docs.
2557   - Expanded description of inline markup start-strings in non-markup
2558     contexts.
2559   - Removed field arguments and made field lists a generic construct.
2560   - Removed the 4-character minimum for section title underlines.
2561   - Clarified term/classifier delimiter & inline markup ambiguity
2562     (definition lists).
2563   - Added "Embedded URIs".
2564   - Updated "Interpreted Text" section.
2565   - Added "Character-Level Inline Markup" section.
2567 * test: Continually adding & updating tests.
2569   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2570   - Moved test/test_pep/ to test/test_readers/test_pep/.
2571   - Added test/test_readers/test_python/.
2572   - Added test/test_writers/ (Engelbert Gruber).
2574 * tools:
2576   - Made the ``locale.setlocale()`` calls in front ends
2577     fault-tolerant.
2579 * tools/buildhtml.py:
2581   - Added "--silent" option.
2582   - Fixed bug with absolute paths & "--config".
2583   - Updated for new I/O classes.
2584   - Added some exception handling.
2585   - Separated publishers' setting defaults; prevents interference.
2586   - Updated for new ``publish_file()`` convenience function.
2588 * tools/pep-html-template:
2590   - Allow for "--embed-stylesheet".
2591   - Added Docutils version to "generator" meta tag.
2592   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2593   - Conform to XHTML spec.
2595 * tools/pep2html.py:
2597   - Made ``argv`` a parameter to ``main()``.
2598   - Added support for "Content-Type:" header & arbitrary PEP formats.
2599   - Linked "Content-Type: text/plain" to PEP 9.
2600   - Files skipped (due to an error) are not pushed onto the server.
2601   - Updated for new I/O classes.
2602   - Added ``check_requirements()`` & ``pep_type_error()``.
2603   - Added some exception handling.
2604   - Updated for new ``publish_string()`` convenience function.
2605   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2607 * tools/quicktest.py:
2609   - Added "-V"/"--version" option.
2611 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2613 * tools/unicode2rstsubs.py: Added to project.  Produces character
2614   entity files (reSructuredText substitutions) from the MathML master
2615   unicode.xml file.
2617 * tools/editors: Support code for editors, added to project.  Contains
2618   ``emacs/restructuredtext.el``.
2620 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2622   - Added style for chunks of inline literals.
2623   - Removed margin for first child of table cells.
2624   - Right-aligned field list names.
2625   - Support for auto-numbered section titles in TOCs.
2626   - Increased the size of inline literals (<tt>) in titles.
2627   - Restored the light gray background for inline literals.
2628   - Added support for "line_block" elements.
2629   - Added style for "address" elements.
2630   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2631   - Improved field list rendering.
2632   - Vertical whitespace improvements.
2633   - Removed "a.target" style.
2635 * tools/stylesheets/pep.css:
2637   - Fixed nested section margins.
2638   - Other changes parallel those of ``../default.css``.
2641 Release 0.2 (2002-07-31)
2642 ========================
2644 General:
2646 - The word "component" was being used ambiguously.  From now on,
2647   "component" will be used to mean "Docutils component", as in Reader,
2648   Writer, Parser, or Transform.  Portions of documents (Table of
2649   Contents, sections, etc.)  will be called "document parts".
2650 - Did a grand renaming: a lot of ``verylongnames`` became
2651   ``very_long_names``.
2652 - Cleaned up imports: no more relative package imports or
2653   comma-separated lists of top-level modules.
2654 - Added support for an option values object which carries default
2655   settings and overrides (from command-line options and library use).
2656 - Added internal Unicode support, and support for both input and
2657   output encodings.
2658 - Added support for the ``docutils.io.IO`` class & subclasses.
2660 Specific:
2662 * docutils/__init__.py:
2664   - Added ``ApplicationError`` and ``DataError``, for use throughout
2665     the package.
2666   - Added ``Component`` base class for Docutils components; implements
2667     the ``supports`` method.
2668   - Added ``__version__`` (thus, ``docutils.__version__``).
2670 * docutils/core.py:
2672   - Removed many keyword parameters to ``Publisher.__init__()`` and
2673     ``publish()``; bundled into an option values object.  Added
2674     "argv", "usage", "description", and "option_spec" parameters for
2675     command-line support.
2676   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2677     methods.
2678   - Reworked I/O model for ``docutils.io`` wrappers.
2679   - Updated ``Publisher.set_options()``; now returns option values
2680     object.
2681   - Added support for configuration files (/etc/docutils.conf,
2682     ./docutils.conf, ~/.docutils).
2683   - Added ``Publisher.setup_option_parser()``.
2684   - Added default usage message and description.
2686 * docutils/frontend.py: Added to project; support for front-end
2687   (command-line) scripts.  Option specifications may be augmented by
2688   components.  Requires Optik (http://optik.sf.net/) for option
2689   processing (installed locally as docutils/optik.py).
2691 * docutils/io.py: Added to project; uniform API for a variety of input
2692   output mechanisms.
2694 * docutils/nodes.py:
2696   - Added ``TreeCopyVisitor`` class.
2697   - Added a ``copy`` method to ``Node`` and subclasses.
2698   - Added a ``SkipDeparture`` exception for visitors.
2699   - Renamed ``TreePruningException`` from ``VisitorException``.
2700   - Added docstrings to ``TreePruningException``, subclasses, and
2701     ``Nodes.walk()``.
2702   - Improved docstrings.
2703   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2704   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2705     imports.
2706   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2707     ``PreDecorative`` mixin.
2708   - Reworked the name/id bookkeeping; to ``document``, removed
2709     ``explicit_targets`` and ``implicit_targets`` attributes, added
2710     ``nametypes`` attribute and ``set_name_id_map`` method.
2711   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2712     traversals.
2713   - Added ``document.has_name()`` method.
2714   - Fixed DOM generation for list-attributes.
2715   - Added category class ``Labeled`` (used by footnotes & citations).
2716   - Added ``Element.set_class()`` method (sets "class" attribute).
2718 * docutils/optik.py: Added to project.  Combined from the Optik
2719   package, with added option groups and other modifications.  The use
2720   of this module is probably only temporary.
2722 * docutils/statemachine.py:
2724   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2725   - Added underscores to improve many awkward names.
2726   - In ``string2lines()``, changed whitespace normalizing translation
2727     table to regexp; restores Python 2.0 compatibility with Unicode.
2729 * docutils/urischemes.py:
2731   - Filled in some descriptions.
2732   - Added "shttp" scheme.
2734 * docutils/utils.py:
2736   - Added ``clean_rcs_keywords`` function (moved from
2737     docutils/transforms/frontmatter.py
2738     ``DocInfo.filter_rcs_keywords``).
2739   - Added underscores to improve many awkward names.
2740   - Changed names of Reporter's thresholds:
2741     warning_level -> report_level; error_level -> halt_level.
2742   - Moved ``utils.id()`` to ``nodes.make_id()``.
2743   - Added ``relative_path(source, target)``.
2745 * docutils/languages/de.py: German mappings; added to project.  Thanks
2746   to Gunnar Schwant for the translations.
2748 * docutils/languages/en.py: Added "Dedication" bibliographic field
2749   mappings.
2751 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2752   Chodorowski.
2754 * docutils/parsers/rst/states.py:
2756   - Added underscores to improve many awkward names.
2757   - Added RFC-2822 header support.
2758   - Extracted the inline parsing code from ``RSTState`` to a separate
2759     class, ``Inliner``, which will allow easy subclassing.
2760   - Made local bindings for ``memo`` container & often-used contents
2761     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2762   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2763   - Added ``MarkupMismatch`` exception; for late corrections.
2764   - Added ``-/:`` characters to inline markup's start string prefix,
2765     ``/`` to end string suffix.
2766   - Fixed a footnote bug.
2767   - Fixed a bug with literal blocks.
2768   - Applied patch from Simon Budig: simplified regexps with symbolic
2769     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2770   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2771   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2772   - Allowed non-ASCII in "simple names" (directive names, field names,
2773     references, etc.).
2774   - Converted ``Inliner.patterns.initial`` to be dynamically built
2775     from parts with ``build_regexp()`` function.
2776   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2777   - Updated docstrings.
2778   - Changed "table" to "grid_table"; added "simple_table" support.
2780 * docutils/parsers/rst/tableparser.py:
2782   - Changed ``TableParser`` to ``GridTableParser``.
2783   - Added ``SimpleTableParser``.
2784   - Refactored naming.
2786 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2787   a fallback language for directive names.
2789 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2790   directive to use a ``pending`` element, used only by HTML writers.
2792 * docutils/parsers/rst/directives/parts.py: Renamed from
2793   components.py.
2795   - Added "backlinks" attribute to "contents" directive.
2797 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2798   project by Adam Chodorowski.
2800 * docutils/readers/__init__.py: Gave Readers more control over
2801   choosing and instantiating Parsers.
2803 * docutils/readers/pep.py: Added to project; for PEP processing.
2805 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2806   requires a ``component`` parameter.
2808 * docutils/transforms/components.py: Added to project; transforms
2809   related to Docutils components.
2811 * docutils/transforms/frontmatter.py:
2813   - In ``DocInfo.extract_authors``, check for a single "author" in an
2814     "authors" group, and convert it to a single "author" element.
2815   - Added support for "Dedication" and generic bibliographic fields.
2817 * docutils/transforms/peps.py: Added to project; PEP-specific.
2819 * docutils/transforms/parts.py: Renamed from old components.py.
2821   - Added filter for `Contents`, to use alt-text for inline images,
2822     and to remove inline markup that doesn't make sense in the ToC.
2823   - Added "name" attribute to TOC topic depending on its title.
2824   - Added support for optional TOC backlinks.
2826 * docutils/transforms/references.py: Fixed indirect target resolution
2827   in ``Hyperlinks`` transform.
2829 * docutils/transforms/universal.py:
2831   - Changed ``Messages`` transform to properly filter out system
2832     messages below the warning threshold.
2833   - Added ``Decorations`` transform (support for ``--generator``,
2834     ``--date``, ``--time``, ``--source-link`` options).
2836 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2837   Engelbert Gruber's PDF writer.
2839 * docutils/writers/html4css1.py:
2841   - Made XHTML-compatible (switched to lowercase element & attribute
2842     names; empty tag format).
2843   - Escape double-dashes in comment text.
2844   - Improved boilerplate & modularity of output.
2845   - Exposed modular output in Writer class.
2846   - Added a "generator" meta tag to <head>.
2847   - Added support for the ``--stylesheet`` option.
2848   - Added support for ``decoration``, ``header``, and ``footer``
2849     elements.
2850   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2851     translation table to regexp; restores Python 2.0 compatibility
2852     with Unicode.
2853   - Added the translator class as instance variable to the Writer, to
2854     make it easily subclassable.
2855   - Improved option list spacing (thanks to Richard Jones).
2856   - Modified field list output.
2857   - Added backlinks to footnotes & citations.
2858   - Added percentage widths to "<col>" tags (from colspec).
2859   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2860     "<span>" changed to "<var>".
2861   - Inline literals: "<code>" changed to "<tt>".
2862   - Many changes to optimize vertical space: compact simple lists etc.
2863   - Add a command-line options & directive attributes to control TOC
2864     and footnote/citation backlinks.
2865   - Added support for optional footnote/citation backlinks.
2866   - Added support for generic bibliographic fields.
2867   - Identify backrefs.
2868   - Relative URLs for stylesheet links.
2870 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2871   PEPs (subclass of ``html4css1.Writer``).
2873 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2875 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2876   of the Docutils internal doctree in XML.
2878 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2880 * spec/doctree.txt:
2882   - Changed the title to "The Docutils Document Tree".
2883   - Added "Hyperlink Bookkeeping" section.
2885 * spec/docutils.dtd:
2887   - Added ``decoration``, ``header``, and ``footer`` elements.
2888   - Brought ``interpreted`` element in line with the parser: changed
2889     attribute "type" to "role", added "position".
2890   - Added support for generic bibliographic fields.
2892 * spec/notes.txt: Continual updates.  Added "Project Policies".
2894 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2895   section.
2897 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2899 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2900   mailing list discussions.
2902 * spec/pep-0287.txt:
2904   - Renamed to "reStructuredText Docstring Format".
2905   - Minor edits.
2906   - Reworked Q&A as an enumerated list.
2907   - Converted to reStructuredText format.
2909 * spec/pysource.dtd:
2911   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2913 * spec/pysource.txt: Removed from project.  Moved much of its contents
2914   to pep-0258.txt.
2916 * spec/rst/alternatives.txt:
2918   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2919   - Added "Inline External Targets" section.
2921 * spec/rst/directives.txt:
2923   - Added "backlinks" attribute to "contents" directive.
2925 * spec/rst/problems.txt:
2927   - Updated the Enumerated List Markup discussion.
2928   - Added new alternative table markup syntaxes.
2930 * spec/rst/reStructuredText.txt:
2932   - Clarified field list usage.
2933   - Updated enumerated list description.
2934   - Clarified purpose of directives.
2935   - Added ``-/:`` characters to inline markup's start string prefix,
2936     ``/`` to end string suffix.
2937   - Updated "Authors" bibliographic field behavior.
2938   - Changed "inline hyperlink targets" to "inline internal targets".
2939   - Added "simple table" syntax to supplement the existing but
2940     newly-renamed "grid tables".
2941   - Added cautions for anonymous hyperlink use.
2942   - Added "Dedication" and generic bibliographic fields.
2944 * test: Made test modules standalone (subdirectories became packages).
2946 * test/DocutilsTestSupport.py:
2948   - Added support for PEP extensions to reStructuredText.
2949   - Added support for simple tables.
2950   - Refactored naming.
2952 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2954   - Now supports true packages containing test modules
2955     (``__init__.py`` files required); fixes duplicate module name bug.
2957 * test/test_pep/: Subpackage added to project; PEP testing.
2959 * test/test_rst/test_SimpleTableParser.py: Added to project.
2961 * tools:
2963   - Updated html.py and publish.py front-end tools to use the new
2964     command-line processing facilities of ``docutils.frontend``
2965     (exposed in ``docutils.core.Publisher``), reducing each to just a
2966     few lines of code.
2967   - Added ``locale.setlocale()`` calls to front-end tools.
2969 * tools/buildhtml.py: Added to project; batch-generates .html from all
2970   the .txt files in directories and subdirectories.
2972 * tools/default.css:
2974   - Added support for ``header`` and ``footer`` elements.
2975   - Added styles for "Dedication" topics (biblio fields).
2977 * tools/docutils.conf: A configuration file; added to project.
2979 * tools/docutils-xml.py: Added to project.
2981 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2983 * tools/pep-html-template: Added to project.
2985 * tools/pep2html.py: Added to project from Python (nondist/peps).
2986   Added support for Docutils (reStructuredText PEPs).
2988 * tools/quicktest.py:
2990   - Added the ``--attributes`` option, hacked a bit.
2991   - Added a second command-line argument (output file); cleaned up.
2993 * tools/stylesheets/: Subdirectory added to project.
2995 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2998 Release 0.1 (2002-04-20)
2999 ========================
3001 This is the first release of Docutils, merged from the now inactive
3002 reStructuredText__ and `Docstring Processing System`__ projects.  For
3003 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3004 `DPS HISTORY`__ files.
3006 __ http://structuredtext.sourceforge.net/
3007 __ http://docstring.sourceforge.net/
3008 __ http://structuredtext.sourceforge.net/HISTORY.html
3009 __ http://docstring.sourceforge.net/HISTORY.html
3011 General changes: renamed 'dps' package to 'docutils'; renamed
3012 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3013 the test suites (reStructuredText's test/test_states renamed to
3014 test/test_rst); and all modifications required to make it all work.
3016 * docutils/parsers/rst/states.py:
3018   - Improved diagnostic system messages for missing blank lines.
3019   - Fixed substitution_reference bug.
3023    Local Variables:
3024    mode: indented-text
3025    indent-tabs-mode: nil
3026    sentence-end-double-space: t
3027    fill-column: 70
3028    End: