Fix [ 295 ] Class argument for custom role inheriting from math.
[docutils.git] / HISTORY.txt
blob7020013057569b8547ca0a112da187b8726d66a7
1 .. -*- coding: utf-8 -*-
3 ==================
4  Docutils History
5 ==================
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
9 :Date: $Date$
10 :Revision: $Revision$
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
14 .. contents::
16 Changes Since 0.12
17 ==================
19 * docutils/nodes.py
21   - Fix [ 253 ] Attribute key without value not allowed in XML.
23 * docutils/parsers/rst/__init__.py
25   - Fix [ 233 ] Change the base URL for the :rfc: role.
27 * docutils/parsers/rst/directives/tables.py
29   - Patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
30     or 'grid'.
32 * docutils/parsers/rst/roles.py
34   - Fix [ 295 ] Class argument for custom role inheriting from math.
36 * docutils/parsers/rst/tableparser.py
38   - Really fix [ 159 ] Spurious table column alignment errors.
40 * docutils/transforms/frontmatter.py
42   - Add name of generic bibliographic fields as a "classes" attribute value
43     (after conversion to a valid identifier form).
45 * docutils/utils/error_reporting.py
47   - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
49 * docutils/utils/math/math2html.py
51   - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
52   - New upstream version (additional macros, piecewise integrals and sums).
54 * docutils/writers/html_plain/
56   - New HTML writer generating clean, polyglot_ markup conforming to
57     `HTML 5`_ and compatible with `XHTML 1.0`_ Transitional.
59     The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
60     and recommended layout rules.
62 * docutils/writers/html4css1/__init__.py
64   - Add "docutils" to class values for "container" object to address [ 267 ].
65   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
66     ``default_stylesheet_path`` and ``default_template_path``.
67   - Fix [ 266 ] creating labels/class values in description list items.
68   - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
69   - Fix footnotes with content that does not start with a paragraph.
71 * docutils/writers/latex2e/__init__.py
73   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
74     admonitions and docinfo.
76   - Use absolute path for ``default_template_path``.
78   - Removed deprecated options ``--use-latex-footnotes`` and
79     ``--figure-footnotes``.
81   - Cleaner LaTeX code for enumerations and literal blocks.
83   - Use "hyperref" package together with "bookmark" (improved hyperlinking
84     by the same author).
86   - Fix [ 286 ] Empty column title cause invalid latex file.
88 * docutils/writers/odf_odt/__init__.py
90   - remove decode.encode of filename stored in zip.
92 * docutils/writers/xetex/__init__.py
94   - LuaLaTex compatibility: do not load "xunicode".
96 * tools/
98   - New front-end ``rst2html5.py``.
100 * tox.ini
102   - Test py26, py27, py33 and py34.
104     To use, install the ``tox`` package via pip or easy_install and use
105     tox from the project root directory.
107 .. _polyglot: http://www.w3.org/TR/html-polyglot/
108 .. _HTML 5: http://www.w3.org/TR/html5/
109 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
112 Release 0.12 (2014-07-06)
113 =========================
115 * docs/ref/rst/directives.txt
117   - Update "math" and "csv-table" descriptions.
119 * docutils/parsers/rst/directives/images.py
121   - Fix [ 258 ] figwidth="image" generates unitless width value.
123 * docutils/parsers/rst/states.py
125   - Improve error report when a non-ASCII character is specified as
126     delimiter, quote or escape character under Python 2.
127     Fixes [ 249 ] and [ 250 ].
129 * docutils/writers/html4css1/__init__.py
131   - Don't add newline after inline math.
132     Thanks to Yury G. Kudryashov for the patch.
134 * docutils/writers/latex2e/__init__.py
136   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
137   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
139 * docutils/writers/odf_odt/__init__.py
141   - Apply patch by Jakub Wilk to fix bug [ 100 ].
143 * test/test_error_reporting.py
145   - Fix [ 223 ] by removing redundant tests we do not have control over.
147 * test/test_nodes.py
149   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
151 Release 0.11 (2013-07-22)
152 =========================
154 * General
156   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
157   - Support embedded aliases within hyperlink references.
158   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
159     language module) before global search.
161 * docutils/nodes.py
163   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
165 * docutils/parsers/rst/directives/__init__.py
167   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
169 * docutils/parsers/rst/directives/images.py
171   - Apply [ 3599485 ] node source/line information for sphinx translation.
173 * docutils/parsers/rst/directives/tables.py
175   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
177 * docutils/parsers/rst/states.py
179   - Fix [ 157 ] Line block parsing doesn't like system message.
180   - Always import our local copy of roman.py (report Larry Hastings).
182 * docutils/transforms/references.py
184   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
186 * docutils/utils/__init__.py
188   - Fix [ 3596884 ] exception importing ``docutils.io``.
190 * docutils/writers/html4css1/__init__.py
192   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
193   - New setting `stylesheet_dirs`: Comma-separated list of directories
194     where stylesheets are found. Used by `stylesheet_path` when expanding
195     relative path arguments.
196   - New default for math-output_: ``HTML math.css``.
197   - Avoid repeated class declarations in html4css1 writer
198     (modified version of patch [ 104 ]).
200 .. _math-output: docs/user/config.html#math-output
202 * docutils/writers/latex2e/__init__.py
204   - Drop the simple algorithm replacing straight double quotes with
205     English typographic ones.
206     Activate the SmartQuotes_ transform if you want this feature.
207   - Fix literal use of babel shorthands (straight quote, tilde, ...).
208   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
209   - New setting `stylesheet_dirs`.
211 .. _SmartQuotes: docs/user/config.html#smart-quotes
213 * docutils/writers/manpage.py
215   - Fix [3607063] handle lines starting with a period.
216   - Fix option separating comma was bold (thanks to Bill Morris).
218 Release 0.10 (2012-12-16)
219 =========================
221 * General
223   - Dropped support for Python 2.3.
224   - ``docutils/math``, ``docutils/error_reporting.py``, and
225     ``docutils/urischemes.py`` moved to the utils package.
226   - Fix [3541369] Relative __import__ also with Python 3.3.
227   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
228     and parsers for Python 2.7 up.
229   - Fix import of PIL.Image.
230   - Change default of "syntax highlight" option to "long",
231     basic syntax highlight styles for LaTeX and HTML.
233 * docutils/io.py
235   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
236     option is ignored and will be removed in a future release.
237   - Fix Py3k error writing to stdout with encoding differing from default.
238   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
240 * docutils/parsers/rst/directives/misc.py
242   - Fix [ 3546533 ] Unicode error with `date` directive.
244 * docutils/transforms/universal.py
246   - SmartQuotes transform for typographic quotes and dashes.
248 * docutils/utils/__init__.py
250   - normalize_language_tag() now returns `BCP 47`_ conformant tags
251     with subtags separated by ``-``.
253 * docutils/writers/html4css1/__init__.py
255   - Use ``<code>`` tag for inline "code",
256     do not drop nested inline nodes (syntax highlight tokens).
257   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
258   - No line break after opening inline math tag.
260 * docutils/writers/manpage.py
262   - Apply [ 3527401 ] addmonition's don't preserve indentation
263   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
265 * docutils/writers/xetex/__init__.py
267   - Apply [ 3555160 ] ensure order of "otherlanguages".
268   - Fix section numbering by LaTeX.
270 * docutils/writers/s5_html/__init__.py
272   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
274 * docutils/writers/s5_html/docutils_xml.py
276   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
278 * setup.py
280   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
282 * tools/test/test_buildhtml.py
284   - Fix [ 3521167 ] allow running in any directory.
285   - Fix [ 3521168 ] allow running with Python 3.
288 Release 0.9.1 (2012-06-17)
289 ==========================
291 * setup.py
293   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
294     installed in the PYTHONPATH. Converted tests are now
295     stored in ``test3/``, tools no longer need conversion.
297     If you installed one of Docutils versions 0.7 ... 0.9 with
298     ``setup.py install`` under Python 3, remove the spurious
299     ``test/`` and ``tools/`` directories in the site library root.
301 * test/
303   - Make tests independent from the location of the ``test/`` directory.
304   - Use converted sources (from the ``build/`` directory) for tests under
305     Python 3.
307 * tools/
309   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
311 * docutils/io.py
313   - Fix writing binary data to sys.stdout under Python 3 (allows
314     ``rst2odt.py`` to be used with output redirection).
316 * docutils/parsers/rst/directives/misc.py
318   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
319     ``locale == C`` and 8-bit char in path argument of `include` directive.
321 * test/alltests.py
323   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
324     file under Python 3.
326 Release 0.9 (2012-05-02)
327 ========================
329 * General:
331   - New reStructuredText "code" role and directive and "code" option
332     of the "include" directive with syntax highlighting by Pygments_.
333   - Fix parse_option_marker for option arguments containing ``=``.
334   - Fix [ 2993756 ]: import Python Imaging Library's Image module
335     via ``import PIL`` as starting with PIL 1.2,
336     "PIL lives in the PIL namespace only" (announcement__).
338 .. _Pygments: http://pygments.org/
339 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
341 * setup.py
343   - Fix [ 2971827 ] and [ 3442827 ]
344     extras/roman.py moved to docutils/utils/roman.py
346 * docutils/frontend.py
348   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
350 * docutils/io.py
352   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
353   - `mode` argument for FileOutput avoids code replication in
354     BinaryFileOutput.
355   - New exceptions InputError and OutputError for IO errors in
356     FileInput/FileOutput.
358 * docutils/core.py:
360   - No "hard" system exit on file IO errors: catch and report them in
361     `Publisher.reportException` instead. Allows handling by a calling
362     application if the configuration setting `traceback` is True.
364 * docutils/utils.py -> docutils/utils/__init__.py
366   - docutils.utils is now a package (providing a place for sub-modules)
368   .. note:: docutils/math, docutils/error_reporting.py, and
369      docutils/urischemes.py will move to the utils package in the next
370      release, too. See RELEASE-NOTES__
372      __ RELEASE-NOTES.html
374   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
375     errors recording non-ASCII filenames (fixes [ 3434355 ]).
377   - Fix relative_path() with source=None and `unicode` target.
379 * docutils/parsers/rst/states.py
381   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
382     characters and "international" quotes around inline markup.
383   - Use `field_marker` pattern to look for start of a
384     directive option block (fixes [ 3484857 ]).
386 * docutils/parsers/rst/tableparser.py
388   - Fix [ 2926161 ] for simple tables.
389     (Combining chars in grid tables still contribute to cell width.)
391 * docutils/writers/latex2e/__init__.py
393   - Support the `abbreviation` and `acronym` standard roles.
394   - Record only files required to generate the LaTeX source as dependencies.
395   - Fix handling of missing stylesheets.
396   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
397     when suppressing LaTeX section numbering.
398   - Use ``\DUtitle`` for unsupported section levels
399   - Apply [ 3512791 ] do not compare string literals with "is"
401 * docutils/writers/xetex/__init__.py
403   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
405 * docutils/writers/html4css1/__init__.py
407   - Change default for `math-output` setting to MathJax.
408   - Fix handling of missing stylesheets.
410 * docutils/writers/docutils_xml.py
412   - Use the visitor pattern with default_visit()/default_depart() methods
413     instead of minidom to facilitate special handling of selected nodes.
414   - Support raw XML (inserted as-is inside a <raw></raw> node).
416 * docutils/writers/manpage.py
418   - Do not emit comment line with trailing blank. Problematic for VCS.
420 Release 0.8.1 (2011-08-30)
421 ==========================
423 * General:
425   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
426     and [ 3395920 ] (correct copyright info for rst.el).
428 * test/
430   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
432 * docutils/writers/latex2e/__init__.py
434   - Clean up Babel language setting. Restores Sphinx compatibility.
436 Release 0.8 (2011-07-07)
437 ========================
439 * General:
441   - Handle language codes according to `BCP 47`_.
442   - If the specified language is not supported by Docutils,
443     warn and fall back to English.
444   - Math support: reStructuredText "math" role and directive,
445     ``math`` and ``math_block`` doctree elements.
446   - Decode command line arguments with the locale's preferred encoding
447     (to allow, e.g., ``--title=Dornröschen``).
448   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
449   - New sub-module `error_reporting`: handle encoding/decoding errors
450     when reporting exceptions.
451   - Some additions to the Docutils core are released under the 2-Clause BSD
452     license, see COPYING_ for details.
454   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
455   .. _COPYING: COPYING.html
457 * reStructuredText:
459   - Most directives now support a "name" option that attaches a
460     reference name.
462   - Directive content may start on the first line also when the directive
463     type accepts options.
465 * docs/dev/policies.txt:
467   - Recommend the 2-Clause BSD license
468     (http://www.spdx.org/licenses/BSD-2-Clause)
469     for code that is kept under the author's copyright.
471 * tools/buildhtml.py:
473   - Fix ``--local`` switch.
475 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
477 * docutils/writers/html4css1/__init__.py
479   - Set "lang" argument for objects with class argument
480     "language-<language tag>".
481   - New setting "math-output" with support for HTML, MathML, and LaTeX.
483 * docutils/writers/latex2e/__init__.py
485   - Fix [ 3043986 ] AttributeError using :local: with table of content.
486   - Place title data in the document preamble.
487   - Load `babel` package only if required.
488   - Update list of supported languages.
489   - New config setting "hyperref-options".
490     No hard-coded "unicode" hyperref option (clash with xetex).
491   - Set language for custom roles, paragraphs, block-quotes, and
492     line-quotes with class argument "language-<language tag>".
493   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
494   - Convert image URI to a local file path.
495   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
496     has more than one paragraph (Wolfgang Scherer).
497   - \leavevmode before longtable only when needed (prevents spurious vspace)
498   - do not advance table counter for tables without caption
500 * docutils/writers/xetex/__init__.py
502   - New writer generating LaTeX code for compiling with ``xelatex``.
504     A separate writer (inheriting from latex2e) instead of a ``--xetex``
505     option allows separate config options for XeTeX vs. LaTeX2e.
507 * docutils/writers/manpage.py
509   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
510   - Fix: vertical space cleaning for option group ``.``.
512 * tools/editors/emacs/rst.el:
514   - Fix [ 3001100 ] does not handle spaces in filenames
515     (thanks to Jakub Wilk)
517 * docutils/utils.py:
519   - strip whitespace from stylesheet arguments
520   - exclude combining chars from column_width()
521     (partial fix for [ 2926161 ])
523 * docutils/parsers/rst/directives/misc.py:
525   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
526     nested_parse
528 * docutils/io.py:
530   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
531     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
533 Release 0.7 (2010-07-07)
534 ========================
536 * General:
538   - Fix [ 2881769 ] setup configuration.
539   - Fix [ 2788716 ] reporting problems in included files.
541 * docutils/io.py
543   - FileInput opens files as text files with universal newline support
544     (mode "rU", configurable with the new optional argument "mode").
546 * docutils/nodes.py
548   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
550 * docutils/utils.py
552   - Fix [ 2923723 ] let decode_path() tolerate path == None
554 * docutils/writers/html4css1/__init__.py
556   - Support SVG and SWF images (thanks to Stefan Rank).
557   - Generate valid XHTML for centered images with targets.
558     Use CSS classes instead of "align" tags for image alignment.
560 * docutils/writers/latex2e/__init__.py
562   - Use `transforms.writer_aux.Admonitions` to "normalize" special
563     admonitions.
564   - Use the ``\url`` command for URLs (breaks long URLs instead of
565     writing into the margin).
566   - Preserve runs of spaces in `inline literals`__.
567   - Deprecate ``figure_footnotes`` setting.
568   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
569   - New ``latex_preamble`` setting.
570   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
571   - Fix hyperlink targets (labels) for images, figures, and tables.
572   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
573   - Apply [ 2961991 ] Call hyperref with unicode option.
574   - Drop the special `output_encoding`__ default ("latin-1").
575     The Docutils wide default (usually "UTF-8") is used instead.
576   - Render inline markup in document title and subtitle.
577   - Fix numbering depth with LaTeX section numbering.
578   - Update Unicode -> LaTeX translations.
579   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
581 __ docs/ref/restructuredtext.html#inline-literals
582 __ docs/user/config.html#docutils-footnotes
583 __ docs/user/config.html#output_encoding
585 * docutils/writers/manpage.py
587   - Fix: supported attribute (thanks to peter2108).
588   - Remove trailing blanks in code (keep in sync with mercurial version).
589   - Titles level 1, that is ``.SH``, always uppercase.
590   - Apply patch from mg: literal text should be bold in man-pages.
592 * docutils/nodes.py
594   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
595     turkish locale.
597 * setup.py:
599   - Python 3 support: copy test/ and tools/ to the build-dir
600     and convert Python sources with 2to3.
603 Release 0.6 (2009-10-11)
604 ========================
606 * General:
608   - Docutils is now compatible with Python versions from 2.3 up to 2.6
609     and convertible to 3.1 code.
611     + Node.__nonzero__ returns True instead of 1.
612     + use os.walk instead os.path.walk.
613     + minimize "types" module where possible.
614     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
615     + Text nodes now subclass unicode rather than UserString
616       (which is gone in python 3.0).
617     + 3.0 compatibility module docutils._compat
619     + Drop 2.2 compatibility workarounds.
620     + Drop extras/optparse.py and extras/textwrap.py
621       (stdlib modules since 2.3).
623   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
624   - Unix man page export: manpage writer moved from sandbox to Doctutils
625     core.
627   - Apply [ 1719345 ] Galician translation
628   - Apply [ 1905741 ] Polish translation
629   - Apply [ 1878977 ] make_id(): deaccent characters.
630   - Apply [ 2029251 ] return nonzero when tests fail.
631   - Fix [ 1692788 ] allow UTF-8 in style sheets.
632   - Fix [ 2781629 ] support non-ASCII chars in file names.
633   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
634   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
635   - Fix [ 2821266 ] --strict option works now like --halt=info.
636   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
637   - Fix [ 1627229 ] hyperlink references in substitutions.
639   - The "newlatex" writer is orphaned.
641 * reStructuredText:
643   - Documented Unicode characters allowed as inline markup openers,
644     closers, and delimiters.
645   - Allow units for all length specifications.
646   - Allow percent sign in "scale" argument of "figure" and "image" directives.
647   - Bugfix: The "figalign" argument of a figure now works as intended
648     (aligning the figure, not its contents).
649   - Align images with class "align-[right|center|left]"
650     (allows setting the alignment of an image in a figure).
652 * docutils/nodes.py:
654   - Added ``Element.__contains__`` method, for the in-operator.
656 * docutils/parsers/rst/states.py:
658   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
659   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
660     " " (non-breaking space), and "¡ ¿" openers.
662 * docutils/parsers/directives/misc.py:
664   - Added ``start-line`` and ``end-line`` options to "include"
665     directive to select a range of lines.
666   - Hard tabs in literal inclusions are replaced by spaces. This is
667     configurable via the new ``tab-width`` option of the "include" directive
668     (a negative tab-width prevents tab expansion).
670 * docutils/utils.py:
672   - Add ``get_stylesheet_list`` function.
673   - Apply [ 2834836 ] print info at halt
675 * docutils/transforms/universal.py:
677   - Raise default priority of StripClasses to exclude stripped classes from
678     the ToC.
680 * docutils/writers/html4css1/__init__.py:
682   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
683     separated list of stylesheets.
684   - Address [ 1938891 ] Inline literal text creates "pre" span only when
685     needed to prevent inter-word line wraps.
686   - Use `translate` method instead of repeated `replace` calls.
687   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
688     classes to allow CSS styling that does not interfere with other
689     table-using constructs (field lists, citations, ...).
691 * docutils/writers/newlatex2e/__init__.py:
693   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
695 * docutils/writers/latex2e/__init__.py (see also
696   `<docs/user/docutils-05-compat.sty.html>`__) :
698   - Add ``--embed-stylesheet`` option.
699   - Apply [ 1474017 ] image vertical alignment is reversed.
700   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
701   - Change: has_key for dictionaries (not Nodes) to in-operator.
702   - Merge adjacent citations into one latex cite command.
703   - Failsave implementation of custom roles. LaTeX compilation now ignores
704     unknown classes instead of aborting with an error.
705   - Support custom roles based on standard roles.
706   - LaTeX packages can be used as ``--stylesheet`` arguments without
707     restriction. (A style sheet is now referenced with the ``\usepackage``
708     command, if it ends with ``.sty`` or has no extension.)
709   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
710   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
711   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
712     2005-02-04 as a configurable length unit).
713   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
714     if font-encoding is set to ''. LaTeX defaults to OT1 then.
715   - Set sub- and superscript role argument in text mode not as math.
716     Use a custom role based on sub-/superscript if you want italic shape.
717   - Shorter preamble and less dependencies: Load packages and define macros
718     only if required in the document.
719   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
720   - New custom environments and commands with optional "classes" argument.
721   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
722   - Better conformance to Docutils specifications with ``--use-latex-toc``.
723     Support for LaTeX generated ToC also with unnumbered sections.
724   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
725     section numbering by LaTeX.
726   - Use default font in admonitions and sidebar.
727   - Align of image in a figure defaults to 'center'.
728   - Bugfix: Newlines around targets and references prevent run-together
729     paragraphs.
730   - Fix internal hyperlinks.
731   - Use class defaults for page margins ('typearea' now optional).
732   - Float placement made configurable, default changed to "here definitely".
733   - Typeset generic topic as "quote block with title".
734   - Use template (file and configuration option).
735   - In the default template, load cmap.sty (fix text extraction in PDF) and
736     fixltx2e.sty (LaTeX patches, \textsubscript).
737   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
738   - Use `translate` instead of repeated `replace` calls for text encoding.
739   - Hyperlinked footnotes and support for symbol footnotes and
740     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
741   - Complete pairs of binary options
742     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
743     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
744   - New defaults:
745     - font-encoding: "T1" (formerly implicitely set by 'ae').
746     - use-latex-toc: true (ToC with page numbers).
747     - use-latex-footnotes: true (no mixup with figures).
749 * docutils/writers/manpage.py
751   - Do not print version at document end, this is done by the viewer.
752   - Do not print date at document end, this is done by the viewer.
753   - Fix storage of docinfo fields for none standard fields.
755 * docutils/tools/rst2man.py
757 Release 0.5 (2008-06-25)
758 ========================
760 * docutils/languages/he.py: Added to project: Hebrew mappings by
761   Meir Kriheli.
763 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
764   mappings by Meir Kriheli.
766 * docutils/frontend.py:
768   - Configuration files are now assumed and required to be
769     UTF-8-encoded.
770   - Paths of applied configuration files are now recorded in the
771     runtime setting ``_config_files`` (accessible via
772     ``--dump-settings``).
773   - Added ``--strip-elements-with-class`` and ``--strip-class``
774     options (``strip_elements_with_classes`` and ``strip_classes``
775     settings).
777 * docutils/io.py:
779   - Added code to determine the input encoding from data: encoding
780     declarations or the presence of byte order marks (UTF-8 & UTF-16).
781   - Added support for IronPython 1.0.
783 * docutils/nodes.py:
785   - Added ``document.__getstate__`` method, for pickling.
787 * docutils/parsers/rst/states.py:
789   - Allow ``+`` and ``:`` in reference names.
790   - Unquoted targets beginning with an underscore (``.. __target:
791     URI``) are no longer accepted.
792   - Added support for multiple attributions in a physical block quote
793     (indented text block), dividing it into multiple logical block
794     quotes.
795   - Added support for unicode bullets in bullet lists: "•", "‣", and
796     "⁃".
797   - Added support for new object-oriented directive interface,
798     retaining compatibility to the old functional interface.
799   - Added support for throwing ``DirectiveError``'s from within
800     directive code.
802 * docutils/parsers/rst/__init__.py:
804   - Added ``Directive`` base class.
805   - Added ``DirectiveError`` base class.
806   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
807     definitions.
809 * docutils/parsers/directives/:
811   - Refactored all reStructuredText directives to use the new
812     object-oriented directive interface.  Errors are now (mostly)
813     thrown using the new ``DirectiveError`` class.
815 * docutils/parsers/directives/misc.py:
817   - Added ``start-after`` and ``end-before`` options to ``include``
818     directive; thanks to Stefan Rank.
820 * docutils/transforms/universal.py:
822   - Added ``StripClassesAndElements`` transform to remove from the
823     document tree all elements with classes in
824     ``settings.strip_elements_with_classes`` and all "classes"
825     attribute values in ``self.document.settings.strip_classes``.
827 * docutils/transforms/writer_aux.py:
829   - Added ``Admonitions`` transform to transform specific admonitions
830     (like ``note``, ``warning``, etc.) into generic admonitions with a
831     localized title.
833 * docutils/writers/html4css1/__init__.py:
835   - Moved template functionality from the PEP/HTML writer here.
836   - Expanded the fragments available in the ``parts`` attribute.
837   - Moved ``id`` attributes from titles to surrounding ``div``
838     elements.
839   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
840     universally supported now).
841   - ``template.txt`` is now opened in text mode instead of binary mode
842     (to ensure Windows compatibility).
843   - ``a`` elements now have an "internal" or "external" class,
844     depending on reference type.
846 * docutils/writers/html4css1/template.txt: Added to project.
848 * docutils/writers/pep_html/:
850   - Moved template functionality to the HTML writer.
852 * docutils/writers/s5_html/__init__.py:
854   - Added ``view_mode`` & ``hidden_controls`` settings
855     (``--view-mode`` & ``--hidden-controls/--visible-controls``
856     options).
858 * docutils/writers/latex2e/__init__.py:
860   - Add ``--literal-block-env``
861   - Fix: escaping ``%`` in href urls.
862   - Move usepackage hyperref after stylesheet inclusion.
863   - Fix: scrartcl does not have chapter but scrreprt.
864   - Add newline after ``\end{verbatim}``.
865   - Merge smaller differences from latex2e_adaptive_preamble.
866   - Add ``use-part-section``.
867   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
868   - Using leavemode option_list no longer needs to check if parent
869     is a definition list.
870   - Append ``\leavemode`` to definition list terms.
871   - No longer write visit\_/depart_definition_list_item comments to
872     output.
873   - Table column width with 3 decimal places.
874   - Add table stubs support (boldfont).
875   - Add assemble_parts to writer.
876   - Add simply support for nested tables.
877   - Fix verbatim in tables if use-verbatim-when-possible.
878   - Use section commands down to subparagraph.
879   - Put ensuremath around some latin1 chars.
880   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
881   - New option ``--use-bibtex=style,db1,db2``.
882   - New option ``--reference-label`` to allow usage of LaTeX ref for
883     labels in section references.
884   - Add a label after every section to support sectionnumbers as reference
885     labels.
886   - Fix: bug# 1605376 rst2latex: bad options group list
887   - Remove inactive code for use_optionlist_for_option_list.
888   - Remove latex comments from option_list output.
889   - Fix: bug# 1612270 double qoutes in italian literal.
890   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
891   - Add option --use-latex-abstract.
892   - Image width unit ``px`` is translated to ``pt``.
893   - Add image height support.
894   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
895     bug #1457388
896   - Fix: Do not escape underscores in citation reference labels if
897     use-latex-citations is set.
898   - Use centering instead of center for figure contents, to avoid vertical
899     space.
900   - Recognize table class: borderless, nolines, booktabs, standard.
901   - Fix: Renaming contents section does not work with latex writer; SF
902     bug #1487405.
903   - Applied patch for custom roles with classes from Edward Loper.
904   - Fixed bug that caused crashes with more than 256 lists.
906 * docutils/writers/pep_html/__init__.py:
908   - Changed to support new python.org website structure and
909     pep2pyramid.py.
911 * docs/howto/security.txt: "Deploying Docutils Securely", added to
912   project.
914 * tools/buildhtml.py:
916   -- Added ``ignore`` setting to exclude a list of shell patterns
917      (default: ``.svn:CVS``).
919 * tools/editors/emacs/rst.el:
921   - Changed license to "GPL".
922   - Added ``rst-straighten-decorations`` function.
923   - The ``compile`` module is now always loaded.
924   - Added ``rst-toggle-line-block`` function.
925   - Headings consisting only of non-ASCII characters are now
926     recognized by ``rst-toc`` and ``rst-adjust``.
927   - Added font-lock support for multi-line comments where the first
928     comment line is empty.
929   - Added ``(require 'font-lock)``.
931 * setup.py:
933   - Provide descriptive error message if distutils is missing.
936 Release 0.4 (2006-01-09)
937 ========================
939 * General:
941   - Updated the project policies for trunk/branch development &
942     version numbering.
944 * docutils/__init__.py:
946   - Added ``__version_details__`` attribute to describe code source
947     (repository/snapshot/release).
948   - Replaced ``default_transforms`` attribute of TransformSpec with
949     ``get_transforms()`` method.
951 * docutils/core.py:
953   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
954     functions, for document tree extraction and reprocessing.
956 * docutils/io.py:
958   - Added ``DocTreeInput`` class, for reprocessing existing documents.
959   - Added support for non-Unicode (e.g. binary) writer output.
961 * docutils/nodes.py:
963   - Re-introduced ``Targetable.indirect_reference_name``, for
964     MoinMoin/reST compatibility (removed in r3124/r3129).
965   - Added ``serial_escape`` function; escapes string values that are
966     elements of a list, for serialization.  Modified Docutils-XML
967     writing (``Element._dom_node``) and pseudo-XML writing
968     (``Element.starttag``) to use ``serial_escape``.
969   - Added ``Node.deepcopy()`` method.
970   - Removed the internal lists ``document.substitution_refs``,
971     ``document.anonymous_refs``, and ``document.anonymous_targets``.
972   - Added a "container" element.
973   - Fixed bug where values of list-valued attributes of elements
974     originating from custom interpreted text roles (i.e., with custom
975     classes) were being shared between element instances.  Reported by
976     Shmuel Zeigerman.
978 * docutils/statemachine.py:
980   - Added trailing whitespace stripping to ``string2lines()``.
981   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
982     Asian double-width character support.
984 * docutils/utils.py:
986   - Added ``east_asian_column_width()`` for double-width character
987     support.
989 * docutils/languages/ja.py: Added to project: Japanese mappings by
990   Hisashi Morita.
992 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
993   mappings by Panjunyong.
995 * docutils/parsers/null.py: Added to project; a do-nothing parser.
997 * docutils/parsers/rst/__init__.py:
999   - Added validator to tab_width setting, with test.  Closes SF bug
1000     #1212515, report from Wu Wei.
1002 * docutils/parsers/rst/states.py:
1004   - Fixed bug with escaped colons indicating a literal block.
1005   - Fixed bug with enumerated lists (SF#1254145).
1006   - Backslash-escaped colons inside of field names are now allowed.
1007   - Targets (implicit and explicit), anonymous hyperlink references
1008     and auto-numbered footnote references inside of substitution
1009     definitions are now disallowed.
1010   - Fixed bug: list items with blank first lines.
1011   - Fixed bug: block quote attributions with indented second lines.
1012   - Added East Asian double-width character support (Python 2.4 only).
1014 * docutils/parsers/rst/tableparser.py:
1016   - Added East Asian double-width character support (Python 2.4 only).
1018 * docutils/parsers/rst/directives/body.py:
1020   - Added the "container" directive.
1022 * docutils/parsers/rst/directives/misc.py:
1024   - Added the "default-role", "title", and "date" directives.
1025   - Added standard data file syntax to the "include" directive.
1026   - Added support for "class" directive content.
1028 * docutils/parsers/rst/directives/images.py:
1030   - Added ``indirect_reference_name`` support for images with a target
1031     option.
1032   - Added support for image width and height units.
1033   - Fixed bug with image "target" options.
1035 * docutils/parsers/rst/directives/references.py:
1037   - Added "class" attribute to "target-notes" directive, for
1038     footnote_reference classes.
1040 * docutils/parsers/rst/include/: Directory added to project; contains
1041   standard data files for the "include" directive.  Initial contents:
1042   character entity substitution definition sets, and a set of
1043   definitions for S5/HTML presentations.
1045 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1046   mappings by David Goodger.
1048 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1049   Simplified Chinese mappings by Panjunyong.
1051 * docutils/readers/__init__.py:
1053   - Added universal.Decorations and universal.ExposeInternals
1054     transforms as default transforms for all readers.
1055   - Added ``ReReader`` base class for readers that reread an existing
1056     document tree.
1058 * docutils/readers/doctree.py: Added to project; a reader for existing
1059   document trees.
1061 * docutils/transforms/frontmatter.py:
1063   - Fixed the DocInfo transform to handle SVN-style expansion of the
1064     "Date" keyword.
1065   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1066     fields uniformly.
1068 * docutils/transforms/misc.py:
1070   - Added misc.Transitions transform, extracted from
1071     universal.FinalChecks.
1073 * docutils/transforms/references.py:
1075   - Added references.DanglingReferences transform, extracted from
1076     universal.FinalChecks.
1077   - Fixed bug with doubly-indirect substitutions.
1078   - Added footnote_reference classes attribute to "TargetNotes".
1079   - Fixed bug with circular substitution definitions that put Docutils
1080     into an infinite loop.
1082 * docutils/transforms/universal.py:
1084   - Added universal.ExposeInternals transform, extracted from
1085     universal.FinalChecks.
1086   - Removed universal.FinalChecks transform (logic has been moved to
1087     several new transforms).
1088   - Fixed bug with the "expose_internals" setting and Text nodes
1089     (exposed by the "rawsource" internal attribute).
1090   - Added the universal.StripComments transform, implementation of the
1091     "strip_comments" setting.
1093 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1094   transforms for writers.
1096   - Added ``Compound`` transform, which flattens compound paragraphs.
1098 * docutils/writers/: Several writer modules (html4css1.py) were
1099   converted into packages.  Support modules and data files have been
1100   moved into the packages.  The stylesheets for the HTML writers are
1101   now installed along with the code, the code knows where to find
1102   them, and the default is to use them (actually, to embed them).
1103   Some adjustments to configuration files may be necessary.  The
1104   easiest way to obtain the new default behavior is to remove all
1105   settings whose name includes "stylesheet".
1107 * docutils/writers/__init__.py:
1109   - Added universal.Messages and universal.FilterMessages transforms
1110     as default transforms for all writers.
1111   - Added ``UnfilteredWriter`` base class for writers that pass the
1112     document tree on unchanged.
1114 * docutils/writers/docutils_xml.py:
1116   - Made ``xmlcharrefreplace`` the default output encoding error
1117     handler.
1119 * docutils/writers/html4css1/:
1121   - Added support for image width and height units.
1122   - Made ``xmlcharrefreplace`` the default output encoding error
1123     handler.
1124   - Made ``--embed-stylesheet`` the default rather than
1125     ``--link-stylesheet``.
1126   - Moved "id" attribute from container (section etc.) to title's <a>
1127     tag, to be on the same tag as "name".
1128     (!!! To be reverted in Docutils 0.5.)
1129   - Added vertical space between fields of field lists.
1130   - Added ``--compact-field-lists`` option to remove vertical space in
1131     simple field lists.
1132   - Made cloaking of email addresses with ``--cloak-email-addresses``
1133     less obtrusive.
1134   - Fixed support for centered images.
1135   - Added support for class="compact" & class="open" lists.
1137 * docutils/writers/latex2e/:
1139   - Underscores in citekeys are no longer escaped.
1141 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1142   mapping of Unicode characters to LaTeX equivalents.
1144 * docutils/writers/s5_html/: Package added to project; writer for
1145   S5/HTML slide shows.
1147 * docs/dev/distributing.txt: Added to project; guide for distributors
1148   (package maintainers).
1150 * docs/dev/hacking.txt: Added to project; guide for developers.
1152 * docs/ref/doctree.txt:
1154   - Updated for plural attributes "classes", "ids", "names",
1155     "dupnames".
1156   - Added the "container" element.
1158 * docs/ref/docutils.dtd:
1160   - Updated for plural attributes "classes", "ids", "names",
1161     "dupnames".
1163 * docs/user/emacs.txt: Added to project; a document about Emacs
1164   support for reStructuredText and Docutils.
1166 * docs/user/links.txt: Added to project; lists of Docutils-related
1167   links.
1169 * docs/user/mailing-lists.txt: Added to project; information about
1170   Docutils-related mailing lists and how to access them.
1172 * docs/user/slide-shows.txt: Added to project; example of and docs for
1173   the S5/HTML writer (``rst2s5.py`` front end).
1175 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1176   Files", added to project.
1178 * test/coverage.sh: Added to project; test coverage script.
1180 * test/DocutilsTestSupport.py:
1182   - Added support for specifying runtime settings at the suite level.
1184 * test/test_functional.py:
1186   - Added the ``clear_output_directory`` function.
1187   - Added support for ``_test_more`` functions in functional test
1188     config files.
1190 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1192 * tools/rstpep2html.py: Renamed from pep.py.
1194 * tools/dev/create_unimap.py: Added to project; script to create the
1195   docutils/writers/unimap_latex.py mapping file.
1197 * tools/dev/profile_docutils.py: Added to project; profiler script.
1199 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1201 * tools/editors/emacs/restructuredtext.el,
1202   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1203   Removed from project; the functionality is now contained in rst.el.
1205 * tools/editors/emacs/rst.el: Added to project.  Added many features
1206   and fixed many bugs.  See docs/user/emacs.txt for details.
1208 * tools/stylesheets: Removed from project.  Stylesheets have been
1209   renamed and moved into writer packages.
1212 Release 0.3.9 (2005-05-26)
1213 ==========================
1215 * General:
1217   - Eliminated and replaced all uses of the old string attributes
1218     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1219     new list attributes ``ids``, ``names``, ``dupnames`` and
1220     ``classes`` throughout the whole source tree.
1222 * docutils/core.py:
1224   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1225     allowing for easier debugging.
1226   - In ``Publisher.publish()``, expanded the generic top-level
1227     exception catching.
1229 * docutils/examples.py:
1231   - Added ``internals`` function for exploration.
1233 * docutils/io.py:
1235   - Fixed ``Input.decode`` method to apply heuristics only if no
1236     encoding is explicitly given, and to provide better reporting of
1237     decoding errors.
1238   - The ``Input.decode`` method now removes byte order marks (BOMs)
1239     from input streams.
1241 * docutils/nodes.py:
1243   - ``image`` element class changed to subclass of Element, not
1244     TextElement (it's an empty element, and cannot contain text).
1245   - Added ``attr_defaults`` dictionary for default attribute values.
1246   - Added empty list as default value for the following attributes:
1247     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1248   - Added ``document.decoration`` attribute,
1249     ``document.get_decoration`` method, and ``decoration.get_header``
1250     & ``.get_footer`` methods.
1251   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1252     methods.
1254 * docutils/utils.py:
1256   - Removed ``docutils.utils.Reporter.categories``,
1257     ``docutils.utils.ConditionSet``, and all references to them, to
1258     simplify error reporting.
1260 * docutils/languages/nl.py: Added to project; Dutch mappings by
1261   Martijn Pieters.
1263 * docutils/parsers/rst/__init__.py:
1265   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1267 * docutils/parsers/rst/states.py:
1269   - Added check for escaped at-mark to prevent email address recognition.
1270   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1271     arguments>``.
1272   - Allowed whitespace in paths and URLs.
1273   - Added auto-enumerated list items.
1274   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1275     followed by text.
1276   - Added support for table stub columns.
1278 * docutils/parsers/rst/directives/__init__.py:
1280   - Allowed whitespace in paths (``path`` function).
1281   - Added ``uri`` directive option conversion function.
1283 * docutils/parsers/rst/directives/body.py:
1285   - Fixed illegal context bug with "topic" directive (allowed within
1286     sidebars; not within body elements).
1288 * docutils/parsers/rst/directives/images.py:
1290   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1291   - Added support for the ``file_insertion_enabled`` setting in the
1292     "figure" directive (disables "figwidth" option).
1293   - "image" directive: added checks for valid values of "align" option,
1294     depending on context.  "figure" directive: added specialized
1295     "align" option and attribute on "figure" element.
1296   - Made ":figwidth: image" option of "figure" directive work again.
1297   - Fixed bug with reference names containing uppercase letters
1298     (e.g. ``Name_``) in "target" option of "image" directive.
1300 * docutils/parsers/rst/directives/misc.py:
1302   - Fixed "include" and "raw" directives to catch text decoding
1303     errors.
1304   - Allowed whitespace in "include" & "raw" directive paths.
1305   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1306     settings in "include" & "raw" directives.
1308 * docutils/parsers/rst/directives/parts.py:
1310   - Added "header" & "footer" directives.
1311   - Fixed illegal context bug with "contents" directive (topics
1312     allowed within sidebars; not within body elements).
1314 * docutils/parsers/rst/directives/tables.py:
1316   - Added "list-table" directive.
1317   - Caught empty CSV table bug.
1318   - Added support for the ``file_insertion_enabled`` setting in the
1319     "csv-table" directive.
1320   - Added ``stub-columns`` option to "csv-table" and "list-table"
1321     directives.
1323 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1324   mappings by Martijn Pieters.
1326 * docutils/readers/standalone.py:
1328   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1329     options to activate or deactivate the SectSubTitle transform.
1331 * docutils/transforms/frontmatter.py:
1333   - Added SectSubTitle transform to promote titles of lone
1334     subsections to subtitles.
1336 * docutils/transforms/references.py:
1338   - Fixed mislocated internal targets bug, by propagating internal
1339     targets to the next node, making use of the newly added support
1340     for multiple names and IDs.
1341   - Fixed duplicate footnote label bug.
1342   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1343     transform.
1345 * docutils/writers/html4css1.py:
1347   - Fixed unencoded stylesheet reference bug (characters like "&" in
1348     stylesheet references).
1349   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1350     tags).
1351   - Added support for multiple IDs per node by creating empty ``span``
1352     tags.
1353   - Added the ``field_name_limit`` & ``option_limit`` settings &
1354     support.
1355   - Added support for table stub columns.
1356   - Added support for the ``align`` attribute on ``figure`` elements.
1357   - Added the ``cloak_email_addresses`` setting & support.
1358   - Added ``html_prolog``, ``html_head``, ``html_body``,
1359     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1360     ``docutils.core.publish_parts``.
1361   - Added support for section subtitles.
1363 * docutils/writers/latex2e.py:
1365   - Fixed tables starting with more than one multirow cell.
1366   - Improved --use-latex-docinfo so that organization/contact/address
1367     fields are lumped with the last author field and appear on the
1368     titlepage.
1369   - Made sure the titlepage is always shown with --use-latex-docinfo,
1370     even if the document has no title.
1371   - Made sure that latex doesn't fill in today's date if no date field
1372     was given.
1373   - Added support for section subtitles.
1375 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1376   (under development).
1378 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1380 * docs/api/publisher.txt:
1382   - Added "``publish_parts`` Details" section.
1384 * docutils/dev/repository.txt: Added to project; information about the
1385   Docutils Subversion repository.
1387 * docs/ref/docutils.dtd:
1389   - Added a ``stub`` attribute to the ``colspec`` element via the
1390     ``tbl.colspec.att`` parameter entity.
1391   - Allowed topic elements within sidebars
1392   - Added an ``align`` attribute to the ``figure`` element.
1394 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1395   writer.
1398 Release 0.3.7 (2004-12-24)
1399 ==========================
1401 * docutils/frontend.py:
1403   - Added options: --input-encoding-error-handler,
1404     --record-dependencies, --leave-footnote-reference-space,
1405     --strict-visitor.
1406   - Added command-line and config file support for "overrides" setting
1407     parameter.
1409 * docutils/io.py:
1411   - Added support for input encoding error handler.
1413 * docutils/nodes.py:
1415   - Added dispatch_visit and dispatch_departure methods to
1416     NodeVisitor; useful as a hook for Visitors.
1417   - Changed structure of ``line_block``; added ``line``.
1418   - Added ``compound`` node class.
1419   - Added a mechanism for Visitors to transitionally ignore new node
1420     classes.
1422 * docutils/utils.py:
1424   - Moved ``escape2null`` and ``unescape`` functions from
1425     docutils/parsers/rst/states.py.
1427 * docutils/parsers/rst/roles.py:
1429   - Added "raw" role.
1430   - Changed role function API: the "text" parameter now takes
1431     null-escaped interpreted text content.
1433 * docutils/parsers/rst/states.py:
1435   - Fixed bug where a "role" directive in a nested parse would crash
1436     the parser; the state machine's "language" attribute was not being
1437     copied over.
1438   - Added support for line block syntax.
1439   - Fixed directive parsing bug: argument-less directives didn't
1440     notice that arguments were present.
1441   - Removed error checking for transitions.
1442   - Added support for multiple classifiers in definition list items.
1443   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1444   - Changed role function API: the "text" parameter now takes
1445     null-escaped interpreted text content.
1446   - Empty sections and documents are allowed now.
1448 * docutils/parsers/rst/directives/__init__.py:
1450   - Added ``encoding`` directive option conversion function.
1451   - Allow multiple class names in class_option conversion function.
1453 * docutils/parsers/rst/directives/body.py:
1455   - Converted the line-block directive to use the new structure.
1456   - Extracted the old line-block functionality to the ``block``
1457     function (still used).
1458   - Added ``compound`` directive (thanks to Lea Wiemann).
1460 * docutils/parsers/rst/directives/misc.py:
1462   - Added "encoding" option to "include" and "raw" directives.
1463   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1464   - Allow multiple class names in the "class" directive.
1466 * docutils/parsers/rst/directives/parts.py:
1468   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1469     options.  Thanks to Lele Gaifax.
1471 * docutils/parsers/rst/directives/tables.py:
1473   - Added "encoding" directive to "csv-table" directive.
1474   - Added workaround for lack of Unicode support in csv.py, for
1475     non-ASCII CSV input.
1477 * docutils/transforms/misc.py:
1479   - Fixed bug when multiple "class" directives are applied to a single
1480     element.
1481   - Enabled multiple format names for "raw" directive.
1483 * docutils/transforms/references.py:
1485   - Added support for trimming whitespace from beside substitution
1486     references.
1488 * docutils/transforms/universal.py:
1490   - FinalChecks now checks for illegal transitions and moves
1491     transitions between sections.
1493 * docutils/writers/html4css1.py:
1495   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1496   - "stylesheet" and "stylesheet_path" settings are now mutually
1497     exclusive.
1498   - Added support for the new line_block/line structure.
1499   - --footnote-references now overrides
1500     --trim-footnote-reference-space, if applicable.
1501   - Added support for ``compound`` elements.
1502   - Enabled multiple format names for "raw" directive.
1503   - ``<p>`` tags of a paragraph which is the only visible child of the
1504     document node are no longer stripped.
1505   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1506     new method ``should_be_compact_paragraph()``.
1507   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1508     elements.
1509   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1510     the output if they have their ``class`` attribute set.
1511   - The whole document is now surrounded by a ``<div
1512     class="document">`` element.
1513   - Body-level images are now wrapped by their own ``<div>`` elements,
1514     with image classes copied to the wrapper, and for images which
1515     have the ``:align:`` option set, the surrounding ``<div>`` now
1516     receives a class attribute (like ``class="align-left"``).
1518 * docutils/writers/latex2e.py:
1520   - no newline after depart_term.
1521   - Added translations for some Unicode quotes.
1522   - Added option "font-encoding", made package AE the default.
1523   - "stylesheet" and "stylesheet_path" settings are now mutually
1524     exclusive.
1525   - --footnote-references now overrides
1526     --trim-footnote-reference-space, if applicable.
1527   - The footnote label style now matches the footnote reference style
1528     ("brackets" or "superscript").
1529   - Added support for ``compound`` elements.
1530   - Enabled multiple format names for "raw" directive.
1532 * docs/ref/docutils.dtd:
1534   - Changed structure of the ``line_block`` element; added ``line``.
1535   - Added ``compound`` element.
1536   - Added "ltrim" and "rtrim" attributes to
1537     ``substitution_definition`` element.
1538   - Enabled multiple format names for ``raw`` element.
1539   - Enabled multiple classifiers in ``definition_list_item`` elements.
1541 * docs/ref/rst/directives.txt
1543   - Marked "line-block" as deprecated.
1544   - "Class" directive now allows multiple class names.
1545   - Added "Rationale for Class Attribute Value Conversion".
1546   - Added warning about "raw" overuse/abuse.
1548 * docs/ref/rst/restructuredtext.txt:
1550   - Added syntax for line blocks.
1551   - Definition list items may have multiple classifiers.
1553 * docs/ref/rst/roles.txt:
1555   - Added "raw" role.
1557 * tools/stylesheets/default.css:
1559   - Added support for the new line_block structure.
1560   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1563 Release 0.3.5 (2004-07-29)
1564 ==========================
1566 General:
1568 * _`Documentation cleanup/reorganization`.
1570   - Created new subdirectories of docs/:
1572     * ``docs/user/``: introductory/tutorial material for end-users
1573     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1574     * ``docs/api/``: API reference material for client-developers
1575     * ``docs/ref/``: reference material for all groups
1576     * ``docs/howto/``: for component-developers and core-developers
1577     * ``docs/peps/``: Python Enhancement Proposals
1579   - Moved ``docs/*`` to ``docs/user/``.
1580   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1581     ``spec/`` to ``docs/dev``.
1582   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1583     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1584   - Moved ``alternatives.txt``, and ``problems.txt`` from
1585     ``spec/rst/`` to ``docs/dev/rst/``.
1586   - Moved ``reStructuredText.txt``, ``directives.txt``,
1587     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1588     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1589     ``roles.txt``, ``reStructuredText.txt`` to
1590     ``restructuredtext.txt``.
1591   - Moved ``spec/howto/`` to ``docs/howto``.
1593   In order to keep the CVS history of moved files, we supplied
1594   SourceForge with a `script for modifying the Docutils CVS
1595   repository`__.
1597   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1599   After running the cleanup script:
1601   - Added ``docs/index.txt``.
1602   - Added a ``.htaccess`` file to the ``web`` module, containing
1603     redirects for all old paths to new paths.  They'll preserve
1604     fragments (the "#name" part of a URL), and won't clutter up the
1605     file system, and will correct the URL in the user's browser.
1606   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1607     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1608     the "To Do" list itself in ``docs/dev/todo.txt``.
1609   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1610     section of ``docs/dev/todo.txt``.
1611   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1612   - Added "How To Report Bugs" to ``BUGS.txt``.
1613   - Went through all the sources and docs (including under web/) and
1614     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1615     (Still need to update links in the sandboxes.)
1617 Specific:
1619 * BUGS.txt: Added to project.
1621 * THANKS.txt: Added to project.
1623 * docutils/__init__.py:
1625   - 0.3.4: Post-release.
1627 * docutils/core.py:
1629   - Added special error handling & advice for UnicodeEncodeError.
1630   - Refactored Publisher.publish (simplified exception handling &
1631     extracted debug dumps).
1632   - Renamed "enable_exit" parameter of convenience functions to
1633     "enable_exit_status".
1634   - Enabled traceback (exception propagation) by default in
1635     programmatic convenience functions.
1636   - Now publish_file and publish_cmdline convenience functions return
1637     the encoded string results in addition to their regular I/O.
1638   - Extracted common code from publish_file, publish_string, and
1639     publish_parts, into new publish_programmatically.  Extracted
1640     settings code to ``Publisher.process_programmatic_settings``.
1641   - In Publisher.publish, disabled ``settings_overrides`` when
1642     ``settings`` is supplied; redundant.
1644 * docutils/frontend.py:
1646   - Added help text for "--output-encoding-error-handler" and
1647     "--error-encoding-error-handler".
1648   - Renamed "--exit" to "--exit-status".
1649   - Simplified default-setting code.
1651 * docutils/parsers/rst/__init__.py:
1653   - Added "--pep-base-url" and "--rfc-base-url" options.
1655 * docutils/parsers/rst/states.py:
1657   - Made URI recognition more aggressive and intelligent.
1659 * docutils/parsers/rst/directives/__init__.py:
1661   - Added several directive option conversion functions.
1663 * docutils/parsers/rst/directives/body.py:
1665   - Moved "table" directive to tables.py.
1667 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1668   added to project.
1670 * docutils/writers/latex2e.py:
1672   - Added "--table-style=(standard|booktabs|nolines)"
1673   - figures get "here" option (LaTeX per default puts them at bottom),
1674     and figure content is centered.
1675   - Rowspan support for tables.
1676   - Fix: admonition titles before first section.
1677   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1678   - Replave ``_`` in literal by an underlined blank, because it has the correct
1679     width.
1680   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1681   - A few unicode replacements, if output_encoding != utf
1682   - Add "--graphicx-option".
1683   - Indent literal-blocks.
1684   - Fix: omit ``\maketitle`` when there is no document title.
1686 * docs/index.txt: "Docutils Project Documentation Overview", added to
1687   project.
1689 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1690   Tool", added to project.
1692 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1694 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1696 * docs/dev/policies.txt: Added to project (extracted from
1697   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1699 * docs/dev/release.txt: Added to project (extracted from
1700   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1702 * docs/dev/testing.txt: Added to project.
1704 * docs/dev/website.txt: Added to project (extracted from
1705   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1707 * docs/ref/rst/directives.txt:
1709   - Added directives: "table", "csv-table".
1711 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1712   added to project.  1 page for syntax, and a 1 page reference for
1713   directives and roles.  Source text to be used as-is; not meant to be
1714   converted to HTML.
1716 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1717   with a change of title.
1719 * test/functional/, contents, and test/test_functional.py: Added to
1720   project.
1722 * tools/buildhtml.py: Fixed bug with config file handling.
1724 * tools/html.py: Removed from project (duplicate of rst2html.py).
1726 * tools/pep2html.py: Removed from project (duplicate of Python's
1727   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1728   Docutils-related PEPs in docs/peps/).
1730 * tools/rst2pseudoxml.py: Renamed from publish.py.
1732 * tools/rst2xml.py: Renamed from docutils-xml.py.
1734 * tools/test.txt: Removed from project; moved to
1735   docs/user/rst/demo.txt.
1737 * setup.py: Now also installs ``rst2latex.py``.
1740 Release 0.3.3 (2004-05-09)
1741 ==========================
1743 * docutils/__init__.py:
1745   - 0.3.1: Reorganized config file format (multiple sections); see
1746     docs/config.txt.
1747   - Added unknown_reference_resolvers attribute to TransformSpec.
1748   - 0.3.2: Interpreted text reorganization.
1749   - 0.3.3: Released.
1751 * docutils/core.py:
1753   - Catch system messages to stop tracebacks from parsing errors.
1754   - Catch exceptions during processing report & exit without
1755     tracebacks, except when "--traceback" used.
1756   - Reordered components for OptionParser; application comes last.
1757   - Added "config_section" parameter to several methods and functions,
1758     allowing front ends to easily specify their config file sections.
1759   - Added publish_parts convenience function to allow access to individual
1760     parts of a document.
1762 * docutils/examples.py: Added to project; practical examples of
1763   Docutils client code, to be used as-is or as models for variations.
1765 * docutils/frontend.py:
1767   - Added "--traceback" & "--no-traceback" options ("traceback"
1768     setting).
1769   - Implemented support for config file reorganization:
1770     ``standard_config_files`` moved from ``ConfigParser`` to
1771     ``OptionParser``; added
1772     ``OptionParser.get_config_file_settings()`` and
1773     ``.get_standard_config_settings()``; support for old "[options]"
1774     section (with deprecation warning) and mapping from old to new
1775     settings.
1776   - Reimplemented setting validation.
1777   - Enabled flexible boolean values: yes/no, true/false, on/off.
1778   - Added ``Values``, a subclass of ``optparse.Values``, with support
1779     for list setting attributes.
1780   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1781     thanks to Beni Cherniavsky.
1782   - Added "--no-section-numbering" option.
1784 * docutils/io.py:
1786   - Catch IOErrors when opening source & destination files, report &
1787     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1788     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1790 * docutils/nodes.py:
1792   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1793     method definitions (via ``exec``) to dynamic assignments (via
1794     ``setattr``); thanks to Roman Suzi.
1795   - Encapsulated visitor dynamic assignments in a function; thanks to
1796     Ian Bicking.
1797   - Added indirect_reference_name attribute to the Targetable
1798     class. This attribute holds the whitespace_normalized_name
1799     (contains mixed case) of a target.
1801 * docutils/statemachine.py:
1803   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1804   - Added ``StringList.get_2D_block``.
1806 * docutils/utils.py:
1808   - Added "level" attribute to SystemMessage exceptions.
1810 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1811   Jannie Hofmeyr.
1813 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1814   Blaha.
1816 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1817   Marcelo Huerta San Martin.
1819 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1820   mappings by Lalo Martins.
1822 * docutils/languages/ru.py: Added to project; Russian mappings by
1823   Roman Suzi.
1825 * docutils/parsers/rst/roles.py: Added to project.  Contains
1826   interpreted text role functions, a registry for interpreted text
1827   roles, and an API for adding to and retrieving from the registry.
1828   Contributed by Edward Loper.
1830 * docutils/parsers/rst/states.py:
1832   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1833   - Allowed true em-dash character and "---" as block quote
1834     attribution marker.
1835   - Added support for <angle-bracketed> complex option arguments
1836     (option lists).
1837   - Fixed handling of backslashes in substitution definitions.
1838   - Fixed off-by-1 error with extra whitespace after substitution
1839     definition directive.
1840   - Added inline markup parsing to field lists' field names.
1841   - Added support for quoted (and unindented) literal blocks.
1842     Driven in part by a bribe from Frank Siebenlist (thanks!).
1843   - Parser now handles escapes in URIs correctly.
1844   - Made embedded-URIs' reference text omittable.  Idea from Beni
1845     Cherniavsky.
1846   - Refactored explicit target processing code.
1847   - Added name attribute to references containing the reference name only
1848     through whitespace_normalize_name (no case changes).
1849   - parse_target no longer returns the refname after going through
1850     normalize_name. This is now handled in make_target.
1851   - Fixed bug relating to role-less interpreted text in non-English
1852     contexts.
1853   - Reorganized interpreted text processing; moved code into the new
1854     roles.py module.  Contributed by Edward Loper.
1855   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1856     ``parse_directive_block``.
1858 * docutils/parsers/rst/tableparser.py:
1860   - Reworked for ``StringList``, to support "include" directives in
1861     table cells.
1863 * docutils/parsers/rst/directives/__init__.py:
1865   - Renamed ``unchanged()`` directive option conversion function to
1866     ``unchanged_required``, and added a new ``unchanged``.
1867   - Catch unicode value too high error; fixes bug 781766.
1868   - Beefed up directive error reporting.
1870 * docutils/parsers/rst/directives/body.py:
1872   - Added basic "table" directive.
1874 * docutils/parsers/rst/directives/images.py:
1876   - Added "target" option to "image" directive.
1877   - Added name attribute to references containing the reference name only
1878     through whitespace_normalize_name (no case changes).
1880 * docutils/parsers/rst/directives/misc.py:
1882   - Isolated the import of the ``urllib2`` module; was causing
1883     problems on SourceForge (``libssl.so.2`` unavailable?).
1884   - Added the "role" directive for declaring custom interpreted text
1885     roles.
1887 * docutils/parsers/rst/directives/parts.py:
1889   - The "contents" directive does more work up-front, creating the
1890     "topic" and "title", and leaving the "pending" node for the
1891     transform.  Allows earlier reference resolution; fixes subtle bug.
1893 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1894   mappings by Jannie Hofmeyr.
1896 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1897   mappings by Marek Blaha.
1899 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1900   mappings by Marcelo Huerta San Martin.
1902 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1903   Portuguese mappings by Lalo Martins.
1905 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1906   mappings by Roman Suzi.
1908 * docutils/transforms/parts.py:
1910   - The "contents" directive does more work up-front, creating the
1911     "topic" and "title", and leaving the "pending" node for the
1912     transform.  Allows earlier reference resolution; fixes subtle bug.
1913   - Added support for disabling of section numbering.
1915 * docutils/transforms/references.py:
1917   - Verifying that external targets are truly targets and not indirect
1918     references. This is because we are now adding a "name" attribute to
1919     references in addition to targets. Note sure if this is correct!
1920   - Added code to hook into the unknown_reference_resolvers list for a
1921     transformer in resolve_indirect_target. This allows the
1922     unknown_reference_resolvers to keep around indirect targets which
1923     docutils doesn't know about.
1924   - Added specific error message for duplicate targets.
1926 * docutils/transforms/universal.py:
1928   - Added FilterMessages transform (removes system messages below the
1929     verbosity threshold).
1930   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1931     to FinalCheckVisitor for application-specific handling of
1932     unresolvable references.
1933   - Added specific error message for duplicate targets.
1935 * docutils/writers/__init__.py:
1937   - Added assemble_parts method to the Writer class to allow for
1938     access to a documents individual parts.
1939   - Documented & set default for ``Writer.output`` attribute.
1941 * docutils/writers/html4css1.py:
1943   - Fixed unicode handling of attribute values (bug 760673).
1944   - Prevent duplication of "class" attribute values (bug report from
1945     Kirill Lapshin).
1946   - Improved table grid/border handling (prompted by report from Bob
1947     Marshall).
1948   - Added support for table titles.
1949   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1950     to Darek Suchojad.
1951   - Added functionality to keep track of individual parts of a document
1952     and store them in a dictionary as the "parts" attribute of the writer.
1953     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1954   - Added proper support for the "scale" attribute of the "image"
1955     element.  Contributed by Brent Cook.
1956   - Added ``--initial-header-level`` option.
1957   - Fixed bug: the body_pre_docinfo segment depended on there being a
1958     docinfo; if no docinfo, the document title was incorporated into
1959     the body segment.  Adversely affected the publish_parts interface.
1961 * docutils/writers/latex2e.py:
1963   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1964     about a missing file.
1965   - Added options and support: ``--compound-enumerators``,
1966     ``--section-prefix-for-enumerators``, and
1967     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1968     934322).
1969   - Added option ``--use-verbatim-when-possible``, to avoid
1970     problematic characters (eg, '~' in italian) in literal blocks.
1971   - It's now possible to use four section levels in the `book` and
1972     `report` LaTeX classes.  The default `article` class still has
1973     three levels limit.
1975 * docs/config.txt: "Docutils Configuration Files", added to project.
1976   Moved config file entry descriptions from tools.txt.
1978 * docs/tools.txt:
1980   - Moved config file entry descriptions to config.txt.
1982 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1983   Development".
1985 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1986   Text Roles", added to project.
1988 * spec/rst/reStructuredText.txt:
1990   - Added description of support for <angle-bracketed> complex option
1991     arguments to option lists.
1992   - Added subsections for indented and quoted literal blocks.
1994 * test: Continually adding & updating tests.
1996   - Added test/test_settings.py & test/data/config_*.txt support
1997     files.
1998   - Added test/test_writers/test_htmlfragment.py.
2000 * test/DocutilsTestSupport.py:
2002   - Refactored LaTeX publisher test suite/case class names to make
2003     testing other writers easier.
2004   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2005     to test the processing of HTML fragments which use the new
2006     publish_parts convenience function.
2008 * tools/buildhtml.py:
2010   - Added support for the "--prune" option.
2011   - Removed dependency on pep2html.py; plaintext PEPs no longer
2012     supported.
2014 * tools/docutils.conf:
2016   - Updated for configuration file reorganization.
2018 * tools/rst2html.py:
2020   - copied from tools/html.py
2022 * setup.py:
2024   - added a 'scripts' section to configuration
2025   - added 'tools/rst2html.py' to the scripts section
2028 Release 0.3 (2003-06-24)
2029 ========================
2031 General:
2033 * Renamed "attribute" to "option" for directives/extensions.
2035 * Renamed transform method "transform" to "apply".
2037 * Renamed "options" to "settings" for runtime settings (as set by
2038   command-line options).  Sometimes "option" (singular) became
2039   "settings" (plural).  Some variations below:
2041   - document.options -> document.settings (stored in other objects as
2042     well)
2043   - option_spec -> settings_spec (not directives though)
2044   - OptionSpec -> SettingsSpec
2045   - cmdline_options -> settings_spec
2046   - relative_path_options -> relative_path_settings
2047   - option_default_overrides -> settings_default_overrides
2048   - Publisher.set_options -> Publisher.get_settings
2050 Specific:
2052 * COPYING.txt: Added "Public Domain Dedication".
2054 * FAQ.txt: Frequently asked questions, added to project.
2056 * setup.py:
2058   - Updated with PyPI Trove classifiers.
2059   - Conditional installation of third-party modules.
2061 * docutils/__init__.py:
2063   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2064   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2065   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2066   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2067     option and its effect on the PEP template & writer.
2068   - Bumped version to 0.2.4 due to changes to the PEP template &
2069     stylesheet.
2070   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2071   - Added ``TransformSpec`` class for new transform system.
2072   - Bumped version to 0.2.6 for API changes (renaming).
2073   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2074     convenience functions.
2075   - Added ``Component.component_type`` attribute.
2076   - Bumped version to 0.2.8 because of the internal parser switch from
2077     plain lists to the docutils.statemachine.StringList objects.
2078   - Bumped version to 0.2.9 because of the frontend.py API changes.
2079   - Bumped version to 0.2.10 due to changes to the project layout
2080     (third-party modules removed from the "docutils" package), and
2081     signature changes in ``io.Input``/``io.Output``.
2082   - Changed version to 0.3.0 for release.
2084 * docutils/core.py:
2086   - Made ``publish()`` a bit more convenient.
2087   - Generalized ``Publisher.set_io``.
2088   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2089     parameters; improved its docstring.
2090   - Added ``publish_file()`` and ``publish_string()``.
2091   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2092     out of ``.set_io``.
2093   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2094     "--dump-transforms" hidden options.
2095   - Added ``Publisher.apply_transforms()`` method.
2096   - Added ``Publisher.set_components()`` method; support for
2097     ``publish_*()`` conveninece functions.
2098   - Moved config file processing to docutils/frontend.py.
2099   - Added support for exit status ("exit_level" setting &
2100     ``enable_exit`` parameter for Publisher.publish() and convenience
2101     functions).
2103 * docutils/frontend.py:
2105   - Check for & exit on identical source & destination paths.
2106   - Fixed bug with absolute paths & "--config".
2107   - Set non-command-line defaults in ``OptionParser.__init__()``:
2108     ``_source`` & ``_destination``.
2109   - Distributed ``relative_path_settings`` to components; updated
2110     ``OptionParser.populate_from_components()`` to combine it all.
2111   - Require list of keys in ``make_paths_absolute`` (was implicit in
2112     global ``relative_path_settings``).
2113   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2114     "--dump-settings", and "--dump-transforms" hidden options.
2115   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2116     code, replaced with correct code.
2117   - Added validation functionality for config files.
2118   - Added "--error-encoding" option/setting, "_disable_config"
2119     internal setting.
2120   - Added encoding validation; updated "--input-encoding" and
2121     "--output-encoding"; added "--error-encoding-error-handler" and
2122     "--output-encoding-error-handler".
2123   - Moved config file processing from docutils/core.py.
2124   - Updated ``OptionParser.populate_from_components`` to handle new
2125     ``SettingsSpec.settings_defaults`` dict.
2126   - Added support for "-" => stdin/stdout.
2127   - Added "exit_level" setting ("--exit" option).
2129 * docutils/io.py:
2131   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2132   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2133   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2134   - ``FileOutput.write()`` now returns the encoded output string.
2135   - Try to get path/stream name automatically in ``FileInput`` &
2136     ``FileOutput``.
2137   - Added defaults for source & destination paths.
2138   - Allow for Unicode I/O with an explicit "unicode" encoding.
2139   - Added ``Output.encode()``.
2140   - Removed dependency on runtime settings; pass encoding directly.
2141   - Recognize Unicode strings in ``Input.decode()``.
2142   - Added support for output encoding error handlers.
2144 * docutils/nodes.py:
2146   - Added "Invisible" element category class.
2147   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2148     modification during a traversal.
2149   - Added element classes: ``line_block``, ``generated``, ``address``,
2150     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2151     ``superscript``, ``subscript``, ``inline``
2152   - Added support for lists of nodes to ``Element.insert()``.
2153   - Fixed parent linking in ``Element.replace()``.
2154   - Added new abstract superclass ``FixedTextElement``; adds
2155     "xml:space" attribute.
2156   - Added support for "line" attribute of ``system_message`` nodes.
2157   - Added support for the observer pattern from ``utils.Reporter``.
2158     Added ``parse_messages`` and ``transform_messages`` attributes to
2159     ``document``, removed ``messages``.  Added ``note_parse_message``
2160     and ``note_transform_message`` methods.
2161   - Added support for improved diagnostics:
2163     - Added "document", "source", and "line" internal attributes to
2164       ``Node``, set by ``Node.setup_child()``.
2165     - Converted variations on ``node.parent = self`` to
2166       ``self.setup_child(node)``.
2167     - Added ``document.current_source`` & ``.current_line``
2168       attributes, and ``.note_source`` observer method.
2169     - Changed "system_message" output to GNU-Tools format.
2171   - Added a "rawsource" attribute to the ``Text`` class, for text
2172     before backslash-escape resolution.
2173   - Support for new transform system.
2174   - Reworked ``pending`` element.
2175   - Fixed XML DOM bug (SF #660611).
2176   - Removed the ``interpeted`` element class and added
2177     ``title_reference``, ``abbreviation``, ``acronym``.
2178   - Made substitutions case-sensitive-but-forgiving; moved some code
2179     from the parser.
2180   - Fixed Unicode bug on element attributes (report: William Dode).
2182 * docutils/optik.py: Removed from project; replaced with
2183   extras/optparse.py and extras/textwrap.py.  These will be installed
2184   only if they're not already present in the Python installation.
2186 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2187   only if it's not already present in the Python installation.
2189 * docutils/statemachine.py:
2191   - Factored out ``State.add_initial_transitions()`` so it can be
2192     extended.
2193   - Converted whitespace-specific "blank" and "indent" transitions
2194     from special-case code to ordinary transitions: removed
2195     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2196     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2197     ``ws_initial_transitions`` attributes.
2198   - Removed ``State.match_transition()`` after merging it into
2199     ``.check_line()``.
2200   - Added ``StateCorrection`` exception.
2201   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2202     (moved ``TransitionCorrection`` support there too.)
2203   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2204     ``EOFError`` instead of ``IndexError``.
2205   - Added ``State.no_match`` method.
2206   - Added support for the Observer pattern, triggered by input line
2207     changes.
2208   - Added ``strip_top`` parameter to
2209     ``StateMachineWS.get_first_known_indented``.
2210   - Made ``context`` a parameter to ``StateMachine.run()``.
2211   - Added ``ViewList`` & ``StringList`` classes;
2212     ``extract_indented()`` becomes ``StringList.get_indented()``.
2213   - Added ``StateMachine.insert_input()``.
2214   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2215     thanks to) Fred Drake.
2217 * docutils/utils.py:
2219   - Added a ``source`` attribute to Reporter instances and
2220     ``system_message`` elements.
2221   - Added an observer pattern to ``utils.Reporter`` to keep track of
2222     system messages.
2223   - Fixed bugs in ``relative_path()``.
2224   - Added support for improved diagnostics.
2225   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2226   - Added support for encoding Reporter stderr output, and encoding
2227     error handlers.
2228   - Reporter keeps track of the highest level system message yet
2229     generated.
2231 * docutils/languages: Fixed bibliographic field language lookups.
2233 * docutils/languages/es.py: Added to project; Spanish mappings by
2234   Marcelo Huerta San Martin.
2236 * docutils/languages/fr.py: Added to project; French mappings by
2237   Stefane Fermigier.
2239 * docutils/languages/it.py: Added to project; Italian mappings by
2240   Nicola Larosa.
2242 * docutils/languages/sk.py: Added to project; Slovak mappings by
2243   Miroslav Vasko.
2245 * docutils/parser/__init__.py:
2247   - Added ``Parser.finish_parse()`` method.
2249 * docutils/parser/rst/__init__.py:
2251   - Added options: "--pep-references", "--rfc-references",
2252     "--tab-width", "--trim-footnote-reference-space".
2254 * docutils/parsers/rst/states.py:
2256   - Changed "title under/overline too short" system messages from INFO
2257     to WARNING, and fixed its insertion location.
2258   - Fixed enumerated list item parsing to allow paragraphs & section
2259     titles to begin with enumerators.
2260   - Converted system messages to use the new "line" attribute.
2261   - Fixed a substitution reference edge case.
2262   - Added support for "--pep-references" and "--rfc-references"
2263     options; reworked ``Inliner`` code to make customization easier.
2264   - Removed field argument parsing.
2265   - Added support for short section title over/underlines.
2266   - Fixed "simple reference name" regexp to ignore text like
2267     "object.__method__"; not an anonymous reference.
2268   - Added support for improved diagnostics.
2269   - Reworked directive API, based on Dethe Elza's contribution.  Added
2270     ``Body.parse_directive()``, ``.parse_directive_options()``,
2271     ``.parse_directive_arguments()`` methods.
2272   - Added ``ExtensionOptions`` class, to parse directive options
2273     without parsing field bodies.  Factored
2274     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2275     ``ExtensionOptions``.
2276   - Improved definition list term/classifier parsing.
2277   - Added warnings for unknown directives.
2278   - Renamed ``Stuff`` to ``Struct``.
2279   - Now flagged as errors: transitions at the beginning or end of
2280     sections, empty sections (except title), and empty documents.
2281   - Updated for ``statemachine.StringList``.
2282   - Enabled recognition of schemeless email addresses in targets.
2283   - Added support for embedded URIs in hyperlink references.
2284   - Added backslash-escapes to inline markup end-string suffix.
2285   - Added support for correct interpreted text processing.
2286   - Fixed nested title parsing (topic, sidebar directives).
2287   - Added special processing of backslash-escaped whitespace (idea
2288     from David Abrahams).
2289   - Made substitutions case-sensitive-but-forgiving; moved some code
2290     to ``docutils.nodes``.
2291   - Added support for block quote attributions.
2292   - Added a kludge to work-around a conflict between the bubble-up
2293     parser strategy and short titles (<= 3 char-long over- &
2294     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2295     titles" submitted by Jason Diamond.
2296   - Added explicit interpreted text roles for standard inline markup:
2297     "emphasis", "strong", "literal".
2298   - Implemented "superscript" and "subscript" interpreted text roles.
2299   - Added initial support for "abbreviation" and "acronym" roles;
2300     incomplete.
2301   - Added support for "--trim-footnote-reference-space" option.
2302   - Optional space before colons in directives & hyperlink targets.
2304 * docutils/parsers/rst/tableparser.py:
2306   - Fixed a bug that was producing unwanted empty rows in "simple"
2307     tables.
2308   - Detect bad column spans in "simple" tables.
2310 * docutils/parsers/rst/directives: Updated all directive functions to
2311   new API.
2313 * docutils/parsers/rst/directives/__init__.py:
2315   - Added ``flag()``, ``unchanged()``, ``path()``,
2316     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2317     directive option helper functions.
2318   - Added warnings for unknown directives.
2319   - Return ``None`` for missing directives.
2320   - Added ``register_directive()``, thanks to William Dode and Paul
2321     Moore.
2323 * docutils/parsers/rst/directives/admonitions.py:
2325   - Added "admonition" directive.
2327 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2328   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2329   "parsed-literal", "rubric", "epigraph", "highlights" and
2330   "pull-quote" directives.
2332 * docutils/parsers/rst/directives/images.py:
2334   - Added an "align" attribute to the "image" & "figure" directives
2335     (by Adam Chodorowski).
2336   - Added "class" option to "image", and "figclass" to "figure".
2338 * docutils/parsers/rst/directives/misc.py:
2340   - Added "include", "raw", and "replace" directives, courtesy of
2341     Dethe Elza.
2342   - Added "unicode" and "class" directives.
2344 * docutils/parsers/rst/directives/parts.py:
2346   - Added the "sectnum" directive; by Dmitry Jemerov.
2347   - Added "class" option to "contents" directive.
2349 * docutils/parsers/rst/directives/references.py: Added to project.
2350   Contains the "target-notes" directive.
2352 * docutils/parsers/rst/languages/__init__.py:
2354   - Return ``None`` from get_language() for missing language modules.
2356 * docutils/parsers/rst/languages/de.py: Added to project; German
2357   mappings by Engelbert Gruber.
2359 * docutils/parsers/rst/languages/en.py:
2361   - Added interpreted text roles mapping.
2363 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2364   mappings by Marcelo Huerta San Martin.
2366 * docutils/parsers/rst/languages/fr.py: Added to project; French
2367   mappings by William Dode.
2369 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2370   mappings by Nicola Larosa.
2372 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2373   mappings by Miroslav Vasko.
2375 * docutils/readers/__init__.py:
2377   - Added support for the observer pattern from ``utils.Reporter``, in
2378     ``Reader.parse`` and ``Reader.transform``.
2379   - Removed ``Reader.transform()`` method.
2380   - Added default parameter values to ``Reader.__init__()`` to make
2381     instantiation easier.
2382   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2384 * docutils/readers/pep.py:
2386   - Added the ``peps.TargetNotes`` transform to the Reader.
2387   - Removed PEP & RFC reference detection code; moved to
2388     parsers/rst/states.py as options (enabled here by default).
2389   - Added support for pre-acceptance PEPs (no PEP number yet).
2390   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2391     easy subclassing.
2393 * docutils/readers/python: Python Source Reader subpackage added to
2394   project, including preliminary versions of:
2396   - __init__.py
2397   - moduleparser.py: Parser for Python modules.
2399 * docutils/transforms/__init__.py:
2401   - Added ``Transformer`` class and completed transform reform.
2402   - Added unknown_reference_resolvers list for each transformer. This list holds
2403     the list of functions provided by each component of the transformer that
2404     help resolve references.
2406 * docutils/transforms/frontmatter.py:
2408   - Improved support for generic fields.
2409   - Fixed bibliographic field language lookups.
2411 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2412   transforms.
2414 * docutils/transforms/parts.py:
2416   - Moved the "id" attribute from TOC list items to the references
2417     (``Contents.build_contents()``).
2418   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2419   - Added "class" attribute support to ``Contents``.
2421 * docutils/transforms/peps.py:
2423   - Added ``mask_email()`` function, updating to pep2html.py's
2424     functionality.
2425   - Linked "Content-Type: text/x-rst" to PEP 12.
2426   - Added the ``TargetNotes`` PEP-specific transform.
2427   - Added ``TargetNotes.cleanup_callback``.
2428   - Added title check to ``Headers``.
2430 * docutils/transforms/references.py:
2432   - Added the ``TargetNotes`` generic transform.
2433   - Split ``Hyperlinks`` into multiple transforms.
2434   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2435   - Added check for circular indirect references.
2436   - Made substitutions case-sensitive-but-forgiving.
2438 * docutils/transforms/universal.py:
2440   - Added support for the "--expose-internal-attributes" option.
2441   - Removed ``Pending`` transform classes & data.
2443 * docutils/writers/__init__.py:
2445   - Removed ``Writer.transform()`` method.
2447 * docutils/writers/docutils-xml.py:
2449   - Added XML and doctype declarations.
2450   - Added "--no-doctype" and "--no-xml-declaration" options.
2452 * docutils/writers/html4css1.py:
2454   - "name" attributes only on these tags: a, applet, form, frame,
2455     iframe, img, map.
2456   - Added "name" attribute to <a> in section titles for Netscape 4
2457     support (bug report: Pearu Peterson).
2458   - Fixed targets (names) on footnote, citation, topic title,
2459     problematic, and system_message nodes (for Netscape 4).
2460   - Changed field names from "<td>" to "<th>".
2461   - Added "@" to "&#64;" encoding to thwart address harvesters.
2462   - Improved the vertical whitespace optimization; ignore "invisible"
2463     nodes (targets, comments, etc.).
2464   - Improved inline literals with ``<span class="pre">`` around chunks
2465     of text and ``&nbsp;`` for runs of spaces.
2466   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2467     ``self.docinfo`` segments.
2468   - Added support for "line_block", "address" elements.
2469   - Improved backlinks (footnotes & system_messages).
2470   - Improved system_message output.
2471   - Redefined "--stylesheet" as containing an invariant URL, used
2472     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2473     working directory.
2474   - Added "--footnote-references" option (superscript or brackets).
2475   - Added "--compact-lists" and "--no-compact-lists" options.
2476   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2477     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2478   - Improved field list rendering.
2479   - Added Docutils version to "generator" meta tag.
2480   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2481   - Improved layout of <pre> HTML source.
2482   - Fixed attribute typo on <colspec>.
2483   - Refined XML prologue.
2484   - Support for no stylesheet.
2485   - Removed "interpreted" element support.
2486   - Added support for "title_reference", "sidebar", "attribution",
2487     "rubric", and generic "admonition" elements.
2488   - Added "--attribution" option.
2489   - Added support for "inline", "subscript", "superscript" elements.
2490   - Added initial support for "abbreviation" and "acronym";
2491     incomplete.
2493 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2494   (from the sandbox).
2496   - Added french.
2497   - Double quotes in literal blocks (special treatment for de/ngerman).
2498   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2499   - Added  "--attribution" option.
2500   - Right align attributions.
2502 * docutils/writers/pep_html.py:
2504   - Parameterized output encoding in PEP template.
2505   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2506   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2507     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2508     working directory.
2509   - Added an override on the "--footnote-references" option.
2510   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2511   - Added Docutils version to "generator" meta tag.
2512   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2514 * docs/tools.txt:
2516   - Added a "silent" setting for ``buildhtml.py``.
2517   - Added a "Getting Help" section.
2518   - Rearranged the structure.
2519   - Kept up to date, with new settings, command-line options etc.
2520   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2521   - Converted settings table into a definition list.
2523 * docs/rst/quickstart.txt:
2525   - Added a table of contents.
2526   - Added feedback information.
2527   - Added mention of minimum section title underline lengths.
2528   - Removed the 4-character minimum for section title underlines.
2530 * docs/rst/quickref.html:
2532   - Added a "Getting Help" section.
2533   - Added a style to make section title backlinks more subtle.
2534   - Added mention of minimum section title underline lengths.
2535   - Removed the 4-character minimum for section title underlines.
2537 * extras: Directory added to project; contains third-party modules
2538   that Docutils depends on (optparse, textwrap, roman).  These are
2539   only installed if they're not already present.
2541 * licenses: Directory added to project; contains copies of license
2542   files for non-public-domain files.
2544 * spec/doctree.txt:
2546   - Changed the focus.  It's about DTD elements:  structural
2547     relationships, semantics, and external (public) attributes.  Not
2548     about the element class library.
2549   - Moved some implementation-specific stuff into ``docutils.nodes``
2550     docstrings.
2551   - Wrote descriptions of all common attributes and parameter
2552     entities.  Filled in introductory material.
2553   - Working through the element descriptions: 55 down, 37 to go.
2554   - Removed "Representation of Horizontal Rules" to
2555     spec/rst/alternatives.txt.
2557 * spec/docutils.dtd:
2559   - Added "generated" inline element.
2560   - Added "line_block" body element.
2561   - Added "auto" attribute to "title".
2562   - Changed content models of "literal_block" and "doctest_block" to
2563     ``%text.model``.
2564   - Added ``%number;`` attribute type parameter entity.
2565   - Changed ``%structural.elements;`` to ``%section.elements``.
2566   - Updated attribute types; made more specific.
2567   - Added "address" bibliographic element.
2568   - Added "line" attribute to ``system_message`` element.
2569   - Removed "field_argument" element; "field_name" may contain
2570     multiple words and whitespace.
2571   - Changed public identifier to docutils.sf.net.
2572   - Removed "interpreted" element; added "title_reference",
2573     "abbreviation", "acronym".
2574   - Removed "refuri" attribute from "footnote_reference" and
2575     "citation_reference".
2576   - Added "sidebar", "rubric", "attribution", "admonition",
2577     "superscript", "subscript", and "inline" elements.
2579 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2581 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2583 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2585 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2586   Dallas Mahrt.
2588 * spec/transforms.txt: Added to project.
2590 * spec/howto: Added subdirectory, for developer how-to docs.
2592 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2593   Elza, edited & extended by David Goodger.
2595 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2596   project.
2598 * spec/rst/alternatives.txt:
2600   - Added "Doctree Representation of Transitions" from
2601     spec/doctree.txt.
2602   - Updated "Inline External Targets" & closed the debate.
2603   - Added ideas for interpreted text syntax extensions.
2604   - Added "Nested Inline Markup" section.
2606 * spec/rst/directives.txt:
2608   - Added directives: "topic", "sectnum", "target-notes",
2609     "line-block", "parsed-literal", "include", "replace", "sidebar",
2610     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2611     "class".
2612   - Formalized descriptions of directive details.
2613   - Added an "align" attribute to the "image" & "figure" directives
2614     (by Adam Chodorowski).
2615   - Added "class" options to "topic", "sidebar", "line-block",
2616     "parsed-literal", "contents", and "image"; and "figclass" to
2617     "figure".
2619 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2620   interpreted text roles.
2622 * spec/rst/introduction.txt:
2624   - Added pointers to material for new users.
2626 * spec/rst/reStructuredText.txt:
2628   - Disambiguated comments (just add a newline after the "::").
2629   - Updated enumerated list description; added a discussion of the
2630     second-line validity checking.
2631   - Updated directive description.
2632   - Added a note redirecting newbies to the user docs.
2633   - Expanded description of inline markup start-strings in non-markup
2634     contexts.
2635   - Removed field arguments and made field lists a generic construct.
2636   - Removed the 4-character minimum for section title underlines.
2637   - Clarified term/classifier delimiter & inline markup ambiguity
2638     (definition lists).
2639   - Added "Embedded URIs".
2640   - Updated "Interpreted Text" section.
2641   - Added "Character-Level Inline Markup" section.
2643 * test: Continually adding & updating tests.
2645   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2646   - Moved test/test_pep/ to test/test_readers/test_pep/.
2647   - Added test/test_readers/test_python/.
2648   - Added test/test_writers/ (Engelbert Gruber).
2650 * tools:
2652   - Made the ``locale.setlocale()`` calls in front ends
2653     fault-tolerant.
2655 * tools/buildhtml.py:
2657   - Added "--silent" option.
2658   - Fixed bug with absolute paths & "--config".
2659   - Updated for new I/O classes.
2660   - Added some exception handling.
2661   - Separated publishers' setting defaults; prevents interference.
2662   - Updated for new ``publish_file()`` convenience function.
2664 * tools/pep-html-template:
2666   - Allow for "--embed-stylesheet".
2667   - Added Docutils version to "generator" meta tag.
2668   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2669   - Conform to XHTML spec.
2671 * tools/pep2html.py:
2673   - Made ``argv`` a parameter to ``main()``.
2674   - Added support for "Content-Type:" header & arbitrary PEP formats.
2675   - Linked "Content-Type: text/plain" to PEP 9.
2676   - Files skipped (due to an error) are not pushed onto the server.
2677   - Updated for new I/O classes.
2678   - Added ``check_requirements()`` & ``pep_type_error()``.
2679   - Added some exception handling.
2680   - Updated for new ``publish_string()`` convenience function.
2681   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2683 * tools/quicktest.py:
2685   - Added "-V"/"--version" option.
2687 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2689 * tools/unicode2rstsubs.py: Added to project.  Produces character
2690   entity files (reSructuredText substitutions) from the MathML master
2691   unicode.xml file.
2693 * tools/editors: Support code for editors, added to project.  Contains
2694   ``emacs/restructuredtext.el``.
2696 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2698   - Added style for chunks of inline literals.
2699   - Removed margin for first child of table cells.
2700   - Right-aligned field list names.
2701   - Support for auto-numbered section titles in TOCs.
2702   - Increased the size of inline literals (<tt>) in titles.
2703   - Restored the light gray background for inline literals.
2704   - Added support for "line_block" elements.
2705   - Added style for "address" elements.
2706   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2707   - Improved field list rendering.
2708   - Vertical whitespace improvements.
2709   - Removed "a.target" style.
2711 * tools/stylesheets/pep.css:
2713   - Fixed nested section margins.
2714   - Other changes parallel those of ``../default.css``.
2717 Release 0.2 (2002-07-31)
2718 ========================
2720 General:
2722 - The word "component" was being used ambiguously.  From now on,
2723   "component" will be used to mean "Docutils component", as in Reader,
2724   Writer, Parser, or Transform.  Portions of documents (Table of
2725   Contents, sections, etc.)  will be called "document parts".
2726 - Did a grand renaming: a lot of ``verylongnames`` became
2727   ``very_long_names``.
2728 - Cleaned up imports: no more relative package imports or
2729   comma-separated lists of top-level modules.
2730 - Added support for an option values object which carries default
2731   settings and overrides (from command-line options and library use).
2732 - Added internal Unicode support, and support for both input and
2733   output encodings.
2734 - Added support for the ``docutils.io.IO`` class & subclasses.
2736 Specific:
2738 * docutils/__init__.py:
2740   - Added ``ApplicationError`` and ``DataError``, for use throughout
2741     the package.
2742   - Added ``Component`` base class for Docutils components; implements
2743     the ``supports`` method.
2744   - Added ``__version__`` (thus, ``docutils.__version__``).
2746 * docutils/core.py:
2748   - Removed many keyword parameters to ``Publisher.__init__()`` and
2749     ``publish()``; bundled into an option values object.  Added
2750     "argv", "usage", "description", and "option_spec" parameters for
2751     command-line support.
2752   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2753     methods.
2754   - Reworked I/O model for ``docutils.io`` wrappers.
2755   - Updated ``Publisher.set_options()``; now returns option values
2756     object.
2757   - Added support for configuration files (/etc/docutils.conf,
2758     ./docutils.conf, ~/.docutils).
2759   - Added ``Publisher.setup_option_parser()``.
2760   - Added default usage message and description.
2762 * docutils/frontend.py: Added to project; support for front-end
2763   (command-line) scripts.  Option specifications may be augmented by
2764   components.  Requires Optik (http://optik.sf.net/) for option
2765   processing (installed locally as docutils/optik.py).
2767 * docutils/io.py: Added to project; uniform API for a variety of input
2768   output mechanisms.
2770 * docutils/nodes.py:
2772   - Added ``TreeCopyVisitor`` class.
2773   - Added a ``copy`` method to ``Node`` and subclasses.
2774   - Added a ``SkipDeparture`` exception for visitors.
2775   - Renamed ``TreePruningException`` from ``VisitorException``.
2776   - Added docstrings to ``TreePruningException``, subclasses, and
2777     ``Nodes.walk()``.
2778   - Improved docstrings.
2779   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2780   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2781     imports.
2782   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2783     ``PreDecorative`` mixin.
2784   - Reworked the name/id bookkeeping; to ``document``, removed
2785     ``explicit_targets`` and ``implicit_targets`` attributes, added
2786     ``nametypes`` attribute and ``set_name_id_map`` method.
2787   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2788     traversals.
2789   - Added ``document.has_name()`` method.
2790   - Fixed DOM generation for list-attributes.
2791   - Added category class ``Labeled`` (used by footnotes & citations).
2792   - Added ``Element.set_class()`` method (sets "class" attribute).
2794 * docutils/optik.py: Added to project.  Combined from the Optik
2795   package, with added option groups and other modifications.  The use
2796   of this module is probably only temporary.
2798 * docutils/statemachine.py:
2800   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2801   - Added underscores to improve many awkward names.
2802   - In ``string2lines()``, changed whitespace normalizing translation
2803     table to regexp; restores Python 2.0 compatibility with Unicode.
2805 * docutils/urischemes.py:
2807   - Filled in some descriptions.
2808   - Added "shttp" scheme.
2810 * docutils/utils.py:
2812   - Added ``clean_rcs_keywords`` function (moved from
2813     docutils/transforms/frontmatter.py
2814     ``DocInfo.filter_rcs_keywords``).
2815   - Added underscores to improve many awkward names.
2816   - Changed names of Reporter's thresholds:
2817     warning_level -> report_level; error_level -> halt_level.
2818   - Moved ``utils.id()`` to ``nodes.make_id()``.
2819   - Added ``relative_path(source, target)``.
2821 * docutils/languages/de.py: German mappings; added to project.  Thanks
2822   to Gunnar Schwant for the translations.
2824 * docutils/languages/en.py: Added "Dedication" bibliographic field
2825   mappings.
2827 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2828   Chodorowski.
2830 * docutils/parsers/rst/states.py:
2832   - Added underscores to improve many awkward names.
2833   - Added RFC-2822 header support.
2834   - Extracted the inline parsing code from ``RSTState`` to a separate
2835     class, ``Inliner``, which will allow easy subclassing.
2836   - Made local bindings for ``memo`` container & often-used contents
2837     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2838   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2839   - Added ``MarkupMismatch`` exception; for late corrections.
2840   - Added ``-/:`` characters to inline markup's start string prefix,
2841     ``/`` to end string suffix.
2842   - Fixed a footnote bug.
2843   - Fixed a bug with literal blocks.
2844   - Applied patch from Simon Budig: simplified regexps with symbolic
2845     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2846   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2847   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2848   - Allowed non-ASCII in "simple names" (directive names, field names,
2849     references, etc.).
2850   - Converted ``Inliner.patterns.initial`` to be dynamically built
2851     from parts with ``build_regexp()`` function.
2852   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2853   - Updated docstrings.
2854   - Changed "table" to "grid_table"; added "simple_table" support.
2856 * docutils/parsers/rst/tableparser.py:
2858   - Changed ``TableParser`` to ``GridTableParser``.
2859   - Added ``SimpleTableParser``.
2860   - Refactored naming.
2862 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2863   a fallback language for directive names.
2865 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2866   directive to use a ``pending`` element, used only by HTML writers.
2868 * docutils/parsers/rst/directives/parts.py: Renamed from
2869   components.py.
2871   - Added "backlinks" attribute to "contents" directive.
2873 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2874   project by Adam Chodorowski.
2876 * docutils/readers/__init__.py: Gave Readers more control over
2877   choosing and instantiating Parsers.
2879 * docutils/readers/pep.py: Added to project; for PEP processing.
2881 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2882   requires a ``component`` parameter.
2884 * docutils/transforms/components.py: Added to project; transforms
2885   related to Docutils components.
2887 * docutils/transforms/frontmatter.py:
2889   - In ``DocInfo.extract_authors``, check for a single "author" in an
2890     "authors" group, and convert it to a single "author" element.
2891   - Added support for "Dedication" and generic bibliographic fields.
2893 * docutils/transforms/peps.py: Added to project; PEP-specific.
2895 * docutils/transforms/parts.py: Renamed from old components.py.
2897   - Added filter for `Contents`, to use alt-text for inline images,
2898     and to remove inline markup that doesn't make sense in the ToC.
2899   - Added "name" attribute to TOC topic depending on its title.
2900   - Added support for optional TOC backlinks.
2902 * docutils/transforms/references.py: Fixed indirect target resolution
2903   in ``Hyperlinks`` transform.
2905 * docutils/transforms/universal.py:
2907   - Changed ``Messages`` transform to properly filter out system
2908     messages below the warning threshold.
2909   - Added ``Decorations`` transform (support for ``--generator``,
2910     ``--date``, ``--time``, ``--source-link`` options).
2912 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2913   Engelbert Gruber's PDF writer.
2915 * docutils/writers/html4css1.py:
2917   - Made XHTML-compatible (switched to lowercase element & attribute
2918     names; empty tag format).
2919   - Escape double-dashes in comment text.
2920   - Improved boilerplate & modularity of output.
2921   - Exposed modular output in Writer class.
2922   - Added a "generator" meta tag to <head>.
2923   - Added support for the ``--stylesheet`` option.
2924   - Added support for ``decoration``, ``header``, and ``footer``
2925     elements.
2926   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2927     translation table to regexp; restores Python 2.0 compatibility
2928     with Unicode.
2929   - Added the translator class as instance variable to the Writer, to
2930     make it easily subclassable.
2931   - Improved option list spacing (thanks to Richard Jones).
2932   - Modified field list output.
2933   - Added backlinks to footnotes & citations.
2934   - Added percentage widths to "<col>" tags (from colspec).
2935   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2936     "<span>" changed to "<var>".
2937   - Inline literals: "<code>" changed to "<tt>".
2938   - Many changes to optimize vertical space: compact simple lists etc.
2939   - Add a command-line options & directive attributes to control TOC
2940     and footnote/citation backlinks.
2941   - Added support for optional footnote/citation backlinks.
2942   - Added support for generic bibliographic fields.
2943   - Identify backrefs.
2944   - Relative URLs for stylesheet links.
2946 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2947   PEPs (subclass of ``html4css1.Writer``).
2949 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2951 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2952   of the Docutils internal doctree in XML.
2954 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2956 * spec/doctree.txt:
2958   - Changed the title to "The Docutils Document Tree".
2959   - Added "Hyperlink Bookkeeping" section.
2961 * spec/docutils.dtd:
2963   - Added ``decoration``, ``header``, and ``footer`` elements.
2964   - Brought ``interpreted`` element in line with the parser: changed
2965     attribute "type" to "role", added "position".
2966   - Added support for generic bibliographic fields.
2968 * spec/notes.txt: Continual updates.  Added "Project Policies".
2970 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2971   section.
2973 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2975 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2976   mailing list discussions.
2978 * spec/pep-0287.txt:
2980   - Renamed to "reStructuredText Docstring Format".
2981   - Minor edits.
2982   - Reworked Q&A as an enumerated list.
2983   - Converted to reStructuredText format.
2985 * spec/pysource.dtd:
2987   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2989 * spec/pysource.txt: Removed from project.  Moved much of its contents
2990   to pep-0258.txt.
2992 * spec/rst/alternatives.txt:
2994   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2995   - Added "Inline External Targets" section.
2997 * spec/rst/directives.txt:
2999   - Added "backlinks" attribute to "contents" directive.
3001 * spec/rst/problems.txt:
3003   - Updated the Enumerated List Markup discussion.
3004   - Added new alternative table markup syntaxes.
3006 * spec/rst/reStructuredText.txt:
3008   - Clarified field list usage.
3009   - Updated enumerated list description.
3010   - Clarified purpose of directives.
3011   - Added ``-/:`` characters to inline markup's start string prefix,
3012     ``/`` to end string suffix.
3013   - Updated "Authors" bibliographic field behavior.
3014   - Changed "inline hyperlink targets" to "inline internal targets".
3015   - Added "simple table" syntax to supplement the existing but
3016     newly-renamed "grid tables".
3017   - Added cautions for anonymous hyperlink use.
3018   - Added "Dedication" and generic bibliographic fields.
3020 * test: Made test modules standalone (subdirectories became packages).
3022 * test/DocutilsTestSupport.py:
3024   - Added support for PEP extensions to reStructuredText.
3025   - Added support for simple tables.
3026   - Refactored naming.
3028 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3030   - Now supports true packages containing test modules
3031     (``__init__.py`` files required); fixes duplicate module name bug.
3033 * test/test_pep/: Subpackage added to project; PEP testing.
3035 * test/test_rst/test_SimpleTableParser.py: Added to project.
3037 * tools:
3039   - Updated html.py and publish.py front-end tools to use the new
3040     command-line processing facilities of ``docutils.frontend``
3041     (exposed in ``docutils.core.Publisher``), reducing each to just a
3042     few lines of code.
3043   - Added ``locale.setlocale()`` calls to front-end tools.
3045 * tools/buildhtml.py: Added to project; batch-generates .html from all
3046   the .txt files in directories and subdirectories.
3048 * tools/default.css:
3050   - Added support for ``header`` and ``footer`` elements.
3051   - Added styles for "Dedication" topics (biblio fields).
3053 * tools/docutils.conf: A configuration file; added to project.
3055 * tools/docutils-xml.py: Added to project.
3057 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3059 * tools/pep-html-template: Added to project.
3061 * tools/pep2html.py: Added to project from Python (nondist/peps).
3062   Added support for Docutils (reStructuredText PEPs).
3064 * tools/quicktest.py:
3066   - Added the ``--attributes`` option, hacked a bit.
3067   - Added a second command-line argument (output file); cleaned up.
3069 * tools/stylesheets/: Subdirectory added to project.
3071 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3074 Release 0.1 (2002-04-20)
3075 ========================
3077 This is the first release of Docutils, merged from the now inactive
3078 reStructuredText__ and `Docstring Processing System`__ projects.  For
3079 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3080 `DPS HISTORY`__ files.
3082 __ http://structuredtext.sourceforge.net/
3083 __ http://docstring.sourceforge.net/
3084 __ http://structuredtext.sourceforge.net/HISTORY.html
3085 __ http://docstring.sourceforge.net/HISTORY.html
3087 General changes: renamed 'dps' package to 'docutils'; renamed
3088 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3089 the test suites (reStructuredText's test/test_states renamed to
3090 test/test_rst); and all modifications required to make it all work.
3092 * docutils/parsers/rst/states.py:
3094   - Improved diagnostic system messages for missing blank lines.
3095   - Fixed substitution_reference bug.
3099    Local Variables:
3100    mode: indented-text
3101    indent-tabs-mode: nil
3102    sentence-end-double-space: t
3103    fill-column: 70
3104    End: