New CSS 2.1 style-sheet for xhtml11 writer.
[docutils.git] / HISTORY.txt
blob44f25ee830c5b7710ba3bb23a02bf4afd1f4648e
1 .. -*- coding: utf-8 -*-
3 ==================
4  Docutils History
5 ==================
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
9 :Date: $Date$
10 :Revision: $Revision$
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
14 .. contents::
16 Changes Since 0.12
17 ==================
19 * docutils/nodes.py
21   - Fix [ 253 ] Attribute key without value not allowed in XML.
23 * docutils/parsers/rst/__init__.py
25   - Fix [ 233 ] Change the base URL for the :rfc: role.
27 * docutils/parsers/rst/directives/tables.py
29   - Patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
30     or 'grid'.
32 * docutils/utils/math/math2html.py
34   - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
35   - New upstream version (additional macros, piecewise integrals and sums).
36   
37 * docutils/writers/html4css1/__init__.py
39   - Add "docutils" to class values for "container" object to address [ 267 ].
40   - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
41     ``default_stylesheet_path`` and ``default_template_path``.
42   - Fix [ 266 ] creating labels/class values in description list items.
44 * docutils/writers/xhtml11/
46   - New HTML writer generating `XHTML1.1`_ styled with CSS2.1
47     Moved to the docutils core from sandbox/html4strict.
49   .. _XHTML1.1: http://www.w3.org/TR/xhtml11/
51 * docutils/writers/latex2e/__init__.py
53   - use absolute path for ``default_template_path``.
55 * docutils/writers/odf_odt/__init__.py
57   - remove decode.encode of filename stored in zip.
59 * docutils/writers/latex2e/__init__.py
61   - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
62     admonitions and docinfo.
64 Release 0.12 (2014-07-06)
65 =========================
67 * docs/ref/rst/directives.txt
69   - Update "math" and "csv-table" descriptions.
71 * docutils/parsers/rst/directives/images.py
73   - Fix [ 258 ] figwidth="image" generates unitless width value.
75 * docutils/parsers/rst/states.py
77   - Improve error report when a non-ASCII character is specified as
78     delimiter, quote or escape character under Python 2.
79     Fixes [ 249 ] and [ 250 ].
81 * docutils/writers/html4css1/__init__.py
83   - Don't add newline after inline math.
84     Thanks to Yury G. Kudryashov for the patch.
86 * docutils/writers/latex2e/__init__.py
88   - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
89   - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
91 * docutils/writers/odf_odt/__init__.py
93   - Apply patch by Jakub Wilk to fix bug [ 100 ].
95 * test/test_error_reporting.py
97   - Fix [ 223 ] by removing redundant tests we do not have control over.
99 * test/test_nodes.py
101   - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
103 Release 0.11 (2013-07-22)
104 =========================
106 * General
108   - Apply [ 2714873 ] Fix for the overwritting of document attributes.
109   - Support embedded aliases within hyperlink references.
110   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
111     language module) before global search.
113 * docutils/nodes.py
115   - Fix [ 3601607 ] node.__repr__() must return `str` instance.
117 * docutils/parsers/rst/directives/__init__.py
119   - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
121 * docutils/parsers/rst/directives/images.py
123   - Apply [ 3599485 ] node source/line information for sphinx translation.
125 * docutils/parsers/rst/directives/tables.py
127   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
129 * docutils/parsers/rst/states.py
131   - Fix [ 157 ] Line block parsing doesn't like system message.
132   - Always import our local copy of roman.py (report Larry Hastings).
134 * docutils/transforms/references.py
136   - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
138 * docutils/utils/__init__.py
140   - Fix [ 3596884 ] exception importing ``docutils.io``.
142 * docutils/writers/html4css1/__init__.py
144   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
145   - New setting `stylesheet_dirs`: Comma-separated list of directories
146     where stylesheets are found. Used by `stylesheet_path` when expanding
147     relative path arguments.
148   - New default for math-output_: ``HTML math.css``.
149   - Avoid repeated class declarations in html4css1 writer
150     (modified version of patch [ 104 ]).
152 .. _math-output: docs/user/config.html#math-output
154 * docutils/writers/latex2e/__init__.py
156   - Drop the simple algorithm replacing straight double quotes with
157     English typographic ones.
158     Activate the SmartQuotes_ transform if you want this feature.
159   - Fix literal use of babel shorthands (straight quote, tilde, ...).
160   - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
161   - New setting `stylesheet_dirs`.
163 .. _SmartQuotes: docs/user/config.html#smart-quotes
165 * docutils/writers/manpage.py
167   - Fix [3607063] handle lines starting with a period.
168   - Fix option separating comma was bold (thanks to Bill Morris).
170 Release 0.10 (2012-12-16)
171 =========================
173 * General
175   - Dropped support for Python 2.3.
176   - ``docutils/math``, ``docutils/error_reporting.py``, and
177     ``docutils/urischemes.py`` moved to the utils package.
178   - Fix [3541369] Relative __import__ also with Python 3.3.
179   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
180     and parsers for Python 2.7 up.
181   - Fix import of PIL.Image.
182   - Change default of "syntax highlight" option to "long",
183     basic syntax highlight styles for LaTeX and HTML.
185 * docutils/io.py
187   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
188     option is ignored and will be removed in a future release.
189   - Fix Py3k error writing to stdout with encoding differing from default.
190   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
192 * docutils/parsers/rst/directives/misc.py
194   - Fix [ 3546533 ] Unicode error with `date` directive.
196 * docutils/transforms/universal.py
198   - SmartQuotes transform for typographic quotes and dashes.
200 * docutils/utils/__init__.py
202   - normalize_language_tag() now returns `BCP 47`_ conformant tags
203     with subtags separated by ``-``.
205 * docutils/writers/html4css1/__init__.py
207   - Use ``<code>`` tag for inline "code",
208     do not drop nested inline nodes (syntax highlight tokens).
209   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
210   - No line break after opening inline math tag.
212 * docutils/writers/manpage.py
214   - Apply [ 3527401 ] addmonition's don't preserve indentation
215   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
217 , docutils/writers/xetex/__init__.py
219   - Apply [ 3555160 ] ensure order of "otherlanguages".
220   - Fix section numbering by LaTeX.
222 * docutils/writers/s5_html/__init__.py
224   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
226 * docutils/writers/s5_html/docutils_xml.py
228   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
230 * setup.py
232   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
234 * tools/test/test_buildhtml.py
236   - Fix [ 3521167 ] allow running in any directory.
237   - Fix [ 3521168 ] allow running with Python 3.
240 Release 0.9.1 (2012-06-17)
241 ==========================
243 * setup.py
245   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
246     installed in the PYTHONPATH. Converted tests are now
247     stored in ``test3/``, tools no longer need conversion.
249     If you installed one of Docutils versions 0.7 ... 0.9 with
250     ``setup.py install`` under Python 3, remove the spurious
251     ``test/`` and ``tools/`` directories in the site library root.
253 * test/
255   - Make tests independent from the location of the ``test/`` directory.
256   - Use converted sources (from the ``build/`` directory) for tests under
257     Python 3.
259 * tools/
261   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
263 * docutils/io.py
265   - Fix writing binary data to sys.stdout under Python 3 (allows
266     ``rst2odt.py`` to be used with output redirection).
268 * docutils/parsers/rst/directives/misc.py
270   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
271     ``locale == C`` and 8-bit char in path argument of `include` directive.
273 * test/alltests.py
275   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
276     file under Python 3.
278 Release 0.9 (2012-05-02)
279 ========================
281 * General:
283   - New reStructuredText "code" role and directive and "code" option
284     of the "include" directive with syntax highlighting by Pygments_.
285   - Fix parse_option_marker for option arguments containing ``=``.
286   - Fix [ 2993756 ]: import Python Imaging Library's Image module
287     via ``import PIL`` as starting with PIL 1.2,
288     "PIL lives in the PIL namespace only" (announcement__).
290 .. _Pygments: http://pygments.org/
291 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
293 * setup.py
295   - Fix [ 2971827 ] and [ 3442827 ]
296     extras/roman.py moved to docutils/utils/roman.py
298 * docutils/frontend.py
300   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
302 * docutils/io.py
304   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
305   - `mode` argument for FileOutput avoids code replication in
306     BinaryFileOutput.
307   - New exceptions InputError and OutputError for IO errors in
308     FileInput/FileOutput.
310 * docutils/core.py:
312   - No "hard" system exit on file IO errors: catch and report them in
313     `Publisher.reportException` instead. Allows handling by a calling
314     application if the configuration setting `traceback` is True.
316 * docutils/utils.py -> docutils/utils/__init__.py
318   - docutils.utils is now a package (providing a place for sub-modules)
320   .. note:: docutils/math, docutils/error_reporting.py, and
321      docutils/urischemes.py will move to the utils package in the next
322      release, too. See RELEASE-NOTES__
324      __ RELEASE-NOTES.html
326   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
327     errors recording non-ASCII filenames (fixes [ 3434355 ]).
329   - Fix relative_path() with source=None and `unicode` target.
331 * docutils/parsers/rst/states.py
333   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
334     characters and "international" quotes around inline markup.
335   - Use `field_marker` pattern to look for start of a
336     directive option block (fixes [ 3484857 ]).
338 * docutils/parsers/rst/tableparser.py
340   - Fix [ 2926161 ] for simple tables.
341     (Combining chars in grid tables still contribute to cell width.)
343 * docutils/writers/latex2e/__init__.py
345   - Support the `abbreviation` and `acronym` standard roles.
346   - Record only files required to generate the LaTeX source as dependencies.
347   - Fix handling of missing stylesheets.
348   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
349     when suppressing LaTeX section numbering.
350   - Use ``\DUtitle`` for unsupported section levels
351   - Apply [ 3512791 ] do not compare string literals with "is"
353 * docutils/writers/xetex/__init__.py
355   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
357 * docutils/writers/html4css1/__init__.py
359   - Change default for `math-output` setting to MathJax.
360   - Fix handling of missing stylesheets.
362 * docutils/writers/docutils_xml.py
364   - Use the visitor pattern with default_visit()/default_depart() methods
365     instead of minidom to facilitate special handling of selected nodes.
366   - Support raw XML (inserted as-is inside a <raw></raw> node).
368 * docutils/writers/manpage.py
370   - Do not emit comment line with trailing blank. Problematic for VCS.
372 Release 0.8.1 (2011-08-30)
373 ==========================
375 * General:
377   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
378     and [ 3395920 ] (correct copyright info for rst.el).
380 * test/
382   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
384 * docutils/writers/latex2e/__init__.py
386   - Clean up Babel language setting. Restores Sphinx compatibility.
388 Release 0.8 (2011-07-07)
389 ========================
391 * General:
393   - Handle language codes according to `BCP 47`_.
394   - If the specified language is not supported by Docutils,
395     warn and fall back to English.
396   - Math support: reStructuredText "math" role and directive,
397     ``math`` and ``math_block`` doctree elements.
398   - Decode command line arguments with the locale's preferred encoding
399     (to allow, e.g., ``--title=Dornröschen``).
400   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
401   - New sub-module `error_reporting`: handle encoding/decoding errors
402     when reporting exceptions.
403   - Some additions to the Docutils core are released under the 2-Clause BSD
404     license, see COPYING_ for details.
406   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
407   .. _COPYING: COPYING.html
409 * reStructuredText:
411   - Most directives now support a "name" option that attaches a
412     reference name.
414   - Directive content may start on the first line also when the directive
415     type accepts options.
417 * docs/dev/policies.txt:
419   - Recommend the 2-Clause BSD license
420     (http://www.spdx.org/licenses/BSD-2-Clause)
421     for code that is kept under the author's copyright.
423 * tools/buildhtml.py:
425   - Fix ``--local`` switch.
427 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
429 * docutils/writers/html4css1/__init__.py
431   - Set "lang" argument for objects with class argument
432     "language-<language tag>".
433   - New setting "math-output" with support for HTML, MathML, and LaTeX.
435 * docutils/writers/latex2e/__init__.py
437   - Fix [ 3043986 ] AttributeError using :local: with table of content.
438   - Place title data in the document preamble.
439   - Load `babel` package only if required.
440   - Update list of supported languages.
441   - New config setting "hyperref-options".
442     No hard-coded "unicode" hyperref option (clash with xetex).
443   - Set language for custom roles, paragraphs, block-quotes, and
444     line-quotes with class argument "language-<language tag>".
445   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
446   - Convert image URI to a local file path.
447   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
448     has more than one paragraph (Wolfgang Scherer).
449   - \leavevmode before longtable only when needed (prevents spurious vspace)
450   - do not advance table counter for tables without caption
452 * docutils/writers/xetex/__init__.py
454   - New writer generating LaTeX code for compiling with ``xelatex``.
456     A separate writer (inheriting from latex2e) instead of a ``--xetex``
457     option allows separate config options for XeTeX vs. LaTeX2e.
459 * docutils/writers/manpage.py
461   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
462   - Fix: vertical space cleaning for option group ``.``.
464 * tools/editors/emacs/rst.el:
466   - Fix [ 3001100 ] does not handle spaces in filenames
467     (thanks to Jakub Wilk)
469 * docutils/utils.py:
471   - strip whitespace from stylesheet arguments
472   - exclude combining chars from column_width()
473     (partial fix for [ 2926161 ])
475 * docutils/parsers/rst/directives/misc.py:
477   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
478     nested_parse
480 * docutils/io.py:
482   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
483     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
485 Release 0.7 (2010-07-07)
486 ========================
488 * General:
490   - Fix [ 2881769 ] setup configuration.
491   - Fix [ 2788716 ] reporting problems in included files.
493 * docutils/io.py
495   - FileInput opens files as text files with universal newline support
496     (mode "rU", configurable with the new optional argument "mode").
498 * docutils/nodes.py
500   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
502 * docutils/utils.py
504   - Fix [ 2923723 ] let decode_path() tolerate path == None
506 * docutils/writers/html4css1/__init__.py
508   - Support SVG and SWF images (thanks to Stefan Rank).
509   - Generate valid XHTML for centered images with targets.
510     Use CSS classes instead of "align" tags for image alignment.
512 * docutils/writers/latex2e/__init__.py
514   - Use `transforms.writer_aux.Admonitions` to "normalize" special
515     admonitions.
516   - Use the ``\url`` command for URLs (breaks long URLs instead of
517     writing into the margin).
518   - Preserve runs of spaces in `inline literals`__.
519   - Deprecate ``figure_footnotes`` setting.
520   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
521   - New ``latex_preamble`` setting.
522   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
523   - Fix hyperlink targets (labels) for images, figures, and tables.
524   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
525   - Apply [ 2961991 ] Call hyperref with unicode option.
526   - Drop the special `output_encoding`__ default ("latin-1").
527     The Docutils wide default (usually "UTF-8") is used instead.
528   - Render inline markup in document title and subtitle.
529   - Fix numbering depth with LaTeX section numbering.
530   - Update Unicode -> LaTeX translations.
531   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
533 __ docs/ref/restructuredtext.html#inline-literals
534 __ docs/user/config.html#docutils-footnotes
535 __ docs/user/config.html#output_encoding
537 * docutils/writers/manpage.py
539   - Fix: supported attribute (thanks to peter2108).
540   - Remove trailing blanks in code (keep in sync with mercurial version).
541   - Titles level 1, that is ``.SH``, always uppercase.
542   - Apply patch from mg: literal text should be bold in man-pages.
544 * docutils/nodes.py
546   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
547     turkish locale.
549 * setup.py:
551   - Python 3 support: copy test/ and tools/ to the build-dir
552     and convert Python sources with 2to3.
555 Release 0.6 (2009-10-11)
556 ========================
558 * General:
560   - Docutils is now compatible with Python versions from 2.3 up to 2.6
561     and convertible to 3.1 code.
563     + Node.__nonzero__ returns True instead of 1.
564     + use os.walk instead os.path.walk.
565     + minimize "types" module where possible.
566     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
567     + Text nodes now subclass unicode rather than UserString
568       (which is gone in python 3.0).
569     + 3.0 compatibility module docutils._compat
571     + Drop 2.2 compatibility workarounds.
572     + Drop extras/optparse.py and extras/textwrap.py
573       (stdlib modules since 2.3).
575   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
576   - Unix man page export: manpage writer moved from sandbox to Doctutils
577     core.
579   - Apply [ 1719345 ] Galician translation
580   - Apply [ 1905741 ] Polish translation
581   - Apply [ 1878977 ] make_id(): deaccent characters.
582   - Apply [ 2029251 ] return nonzero when tests fail.
583   - Fix [ 1692788 ] allow UTF-8 in style sheets.
584   - Fix [ 2781629 ] support non-ASCII chars in file names.
585   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
586   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
587   - Fix [ 2821266 ] --strict option works now like --halt=info.
588   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
589   - Fix [ 1627229 ] hyperlink references in substitutions.
591   - The "newlatex" writer is orphaned.
593 * reStructuredText:
595   - Documented Unicode characters allowed as inline markup openers,
596     closers, and delimiters.
597   - Allow units for all length specifications.
598   - Allow percent sign in "scale" argument of "figure" and "image" directives.
599   - Bugfix: The "figalign" argument of a figure now works as intended
600     (aligning the figure, not its contents).
601   - Align images with class "align-[right|center|left]"
602     (allows setting the alignment of an image in a figure).
604 * docutils/nodes.py:
606   - Added ``Element.__contains__`` method, for the in-operator.
608 * docutils/parsers/rst/states.py:
610   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
611   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
612     " " (non-breaking space), and "¡ ¿" openers.
614 * docutils/parsers/directives/misc.py:
616   - Added ``start-line`` and ``end-line`` options to "include"
617     directive to select a range of lines.
618   - Hard tabs in literal inclusions are replaced by spaces. This is
619     configurable via the new ``tab-width`` option of the "include" directive
620     (a negative tab-width prevents tab expansion).
622 * docutils/utils.py:
624   - Add ``get_stylesheet_list`` function.
625   - Apply [ 2834836 ] print info at halt
627 * docutils/transforms/universal.py:
629   - Raise default priority of StripClasses to exclude stripped classes from
630     the ToC.
632 * docutils/writers/html4css1/__init__.py:
634   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
635     separated list of stylesheets.
636   - Address [ 1938891 ] Inline literal text creates "pre" span only when
637     needed to prevent inter-word line wraps.
638   - Use `translate` method instead of repeated `replace` calls.
639   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
640     classes to allow CSS styling that does not interfere with other
641     table-using constructs (field lists, citations, ...).
643 * docutils/writers/newlatex2e/__init__.py:
645   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
647 * docutils/writers/latex2e/__init__.py (see also
648   `<docs/user/docutils-05-compat.sty.html>`__) :
650   - Add ``--embed-stylesheet`` option.
651   - Apply [ 1474017 ] image vertical alignment is reversed.
652   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
653   - Change: has_key for dictionaries (not Nodes) to in-operator.
654   - Merge adjacent citations into one latex cite command.
655   - Failsave implementation of custom roles. LaTeX compilation now ignores
656     unknown classes instead of aborting with an error.
657   - Support custom roles based on standard roles.
658   - LaTeX packages can be used as ``--stylesheet`` arguments without
659     restriction. (A style sheet is now referenced with the ``\usepackage``
660     command, if it ends with ``.sty`` or has no extension.)
661   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
662   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
663   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
664     2005-02-04 as a configurable length unit).
665   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
666     if font-encoding is set to ''. LaTeX defaults to OT1 then.
667   - Set sub- and superscript role argument in text mode not as math.
668     Use a custom role based on sub-/superscript if you want italic shape.
669   - Shorter preamble and less dependencies: Load packages and define macros
670     only if required in the document.
671   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
672   - New custom environments and commands with optional "classes" argument.
673   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
674   - Better conformance to Docutils specifications with ``--use-latex-toc``.
675     Support for LaTeX generated ToC also with unnumbered sections.
676   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
677     section numbering by LaTeX.
678   - Use default font in admonitions and sidebar.
679   - Align of image in a figure defaults to 'center'.
680   - Bugfix: Newlines around targets and references prevent run-together
681     paragraphs.
682   - Fix internal hyperlinks.
683   - Use class defaults for page margins ('typearea' now optional).
684   - Float placement made configurable, default changed to "here definitely".
685   - Typeset generic topic as "quote block with title".
686   - Use template (file and configuration option).
687   - In the default template, load cmap.sty (fix text extraction in PDF) and
688     fixltx2e.sty (LaTeX patches, \textsubscript).
689   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
690   - Use `translate` instead of repeated `replace` calls for text encoding.
691   - Hyperlinked footnotes and support for symbol footnotes and
692     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
693   - Complete pairs of binary options
694     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
695     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
696   - New defaults:
697     - font-encoding: "T1" (formerly implicitely set by 'ae').
698     - use-latex-toc: true (ToC with page numbers).
699     - use-latex-footnotes: true (no mixup with figures).
701 * docutils/writers/manpage.py
703   - Do not print version at document end, this is done by the viewer.
704   - Do not print date at document end, this is done by the viewer.
705   - Fix storage of docinfo fields for none standard fields.
707 * docutils/tools/rst2man.py
709 Release 0.5 (2008-06-25)
710 ========================
712 * docutils/languages/he.py: Added to project: Hebrew mappings by
713   Meir Kriheli.
715 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
716   mappings by Meir Kriheli.
718 * docutils/frontend.py:
720   - Configuration files are now assumed and required to be
721     UTF-8-encoded.
722   - Paths of applied configuration files are now recorded in the
723     runtime setting ``_config_files`` (accessible via
724     ``--dump-settings``).
725   - Added ``--strip-elements-with-class`` and ``--strip-class``
726     options (``strip_elements_with_classes`` and ``strip_classes``
727     settings).
729 * docutils/io.py:
731   - Added code to determine the input encoding from data: encoding
732     declarations or the presence of byte order marks (UTF-8 & UTF-16).
733   - Added support for IronPython 1.0.
735 * docutils/nodes.py:
737   - Added ``document.__getstate__`` method, for pickling.
739 * docutils/parsers/rst/states.py:
741   - Allow ``+`` and ``:`` in reference names.
742   - Unquoted targets beginning with an underscore (``.. __target:
743     URI``) are no longer accepted.
744   - Added support for multiple attributions in a physical block quote
745     (indented text block), dividing it into multiple logical block
746     quotes.
747   - Added support for unicode bullets in bullet lists: "•", "‣", and
748     "⁃".
749   - Added support for new object-oriented directive interface,
750     retaining compatibility to the old functional interface.
751   - Added support for throwing ``DirectiveError``'s from within
752     directive code.
754 * docutils/parsers/rst/__init__.py:
756   - Added ``Directive`` base class.
757   - Added ``DirectiveError`` base class.
758   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
759     definitions.
761 * docutils/parsers/directives/:
763   - Refactored all reStructuredText directives to use the new
764     object-oriented directive interface.  Errors are now (mostly)
765     thrown using the new ``DirectiveError`` class.
767 * docutils/parsers/directives/misc.py:
769   - Added ``start-after`` and ``end-before`` options to ``include``
770     directive; thanks to Stefan Rank.
772 * docutils/transforms/universal.py:
774   - Added ``StripClassesAndElements`` transform to remove from the
775     document tree all elements with classes in
776     ``settings.strip_elements_with_classes`` and all "classes"
777     attribute values in ``self.document.settings.strip_classes``.
779 * docutils/transforms/writer_aux.py:
781   - Added ``Admonitions`` transform to transform specific admonitions
782     (like ``note``, ``warning``, etc.) into generic admonitions with a
783     localized title.
785 * docutils/writers/html4css1/__init__.py:
787   - Moved template functionality from the PEP/HTML writer here.
788   - Expanded the fragments available in the ``parts`` attribute.
789   - Moved ``id`` attributes from titles to surrounding ``div``
790     elements.
791   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
792     universally supported now).
793   - ``template.txt`` is now opened in text mode instead of binary mode
794     (to ensure Windows compatibility).
795   - ``a`` elements now have an "internal" or "external" class,
796     depending on reference type.
798 * docutils/writers/html4css1/template.txt: Added to project.
800 * docutils/writers/pep_html/:
802   - Moved template functionality to the HTML writer.
804 * docutils/writers/s5_html/__init__.py:
806   - Added ``view_mode`` & ``hidden_controls`` settings
807     (``--view-mode`` & ``--hidden-controls/--visible-controls``
808     options).
810 * docutils/writers/latex2e/__init__.py:
812   - Add ``--literal-block-env``
813   - Fix: escaping ``%`` in href urls.
814   - Move usepackage hyperref after stylesheet inclusion.
815   - Fix: scrartcl does not have chapter but scrreprt.
816   - Add newline after ``\end{verbatim}``.
817   - Merge smaller differences from latex2e_adaptive_preamble.
818   - Add ``use-part-section``.
819   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
820   - Using leavemode option_list no longer needs to check if parent
821     is a definition list.
822   - Append ``\leavemode`` to definition list terms.
823   - No longer write visit\_/depart_definition_list_item comments to
824     output.
825   - Table column width with 3 decimal places.
826   - Add table stubs support (boldfont).
827   - Add assemble_parts to writer.
828   - Add simply support for nested tables.
829   - Fix verbatim in tables if use-verbatim-when-possible.
830   - Use section commands down to subparagraph.
831   - Put ensuremath around some latin1 chars.
832   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
833   - New option ``--use-bibtex=style,db1,db2``.
834   - New option ``--reference-label`` to allow usage of LaTeX ref for
835     labels in section references.
836   - Add a label after every section to support sectionnumbers as reference
837     labels.
838   - Fix: bug# 1605376 rst2latex: bad options group list
839   - Remove inactive code for use_optionlist_for_option_list.
840   - Remove latex comments from option_list output.
841   - Fix: bug# 1612270 double qoutes in italian literal.
842   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
843   - Add option --use-latex-abstract.
844   - Image width unit ``px`` is translated to ``pt``.
845   - Add image height support.
846   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
847     bug #1457388
848   - Fix: Do not escape underscores in citation reference labels if
849     use-latex-citations is set.
850   - Use centering instead of center for figure contents, to avoid vertical
851     space.
852   - Recognize table class: borderless, nolines, booktabs, standard.
853   - Fix: Renaming contents section does not work with latex writer; SF
854     bug #1487405.
855   - Applied patch for custom roles with classes from Edward Loper.
856   - Fixed bug that caused crashes with more than 256 lists.
858 * docutils/writers/pep_html/__init__.py:
860   - Changed to support new python.org website structure and
861     pep2pyramid.py.
863 * docs/howto/security.txt: "Deploying Docutils Securely", added to
864   project.
866 * tools/buildhtml.py:
868   -- Added ``ignore`` setting to exclude a list of shell patterns
869      (default: ``.svn:CVS``).
871 * tools/editors/emacs/rst.el:
873   - Changed license to "GPL".
874   - Added ``rst-straighten-decorations`` function.
875   - The ``compile`` module is now always loaded.
876   - Added ``rst-toggle-line-block`` function.
877   - Headings consisting only of non-ASCII characters are now
878     recognized by ``rst-toc`` and ``rst-adjust``.
879   - Added font-lock support for multi-line comments where the first
880     comment line is empty.
881   - Added ``(require 'font-lock)``.
883 * setup.py:
885   - Provide descriptive error message if distutils is missing.
888 Release 0.4 (2006-01-09)
889 ========================
891 * General:
893   - Updated the project policies for trunk/branch development &
894     version numbering.
896 * docutils/__init__.py:
898   - Added ``__version_details__`` attribute to describe code source
899     (repository/snapshot/release).
900   - Replaced ``default_transforms`` attribute of TransformSpec with
901     ``get_transforms()`` method.
903 * docutils/core.py:
905   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
906     functions, for document tree extraction and reprocessing.
908 * docutils/io.py:
910   - Added ``DocTreeInput`` class, for reprocessing existing documents.
911   - Added support for non-Unicode (e.g. binary) writer output.
913 * docutils/nodes.py:
915   - Re-introduced ``Targetable.indirect_reference_name``, for
916     MoinMoin/reST compatibility (removed in r3124/r3129).
917   - Added ``serial_escape`` function; escapes string values that are
918     elements of a list, for serialization.  Modified Docutils-XML
919     writing (``Element._dom_node``) and pseudo-XML writing
920     (``Element.starttag``) to use ``serial_escape``.
921   - Added ``Node.deepcopy()`` method.
922   - Removed the internal lists ``document.substitution_refs``,
923     ``document.anonymous_refs``, and ``document.anonymous_targets``.
924   - Added a "container" element.
925   - Fixed bug where values of list-valued attributes of elements
926     originating from custom interpreted text roles (i.e., with custom
927     classes) were being shared between element instances.  Reported by
928     Shmuel Zeigerman.
930 * docutils/statemachine.py:
932   - Added trailing whitespace stripping to ``string2lines()``.
933   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
934     Asian double-width character support.
936 * docutils/utils.py:
938   - Added ``east_asian_column_width()`` for double-width character
939     support.
941 * docutils/languages/ja.py: Added to project: Japanese mappings by
942   Hisashi Morita.
944 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
945   mappings by Panjunyong.
947 * docutils/parsers/null.py: Added to project; a do-nothing parser.
949 * docutils/parsers/rst/__init__.py:
951   - Added validator to tab_width setting, with test.  Closes SF bug
952     #1212515, report from Wu Wei.
954 * docutils/parsers/rst/states.py:
956   - Fixed bug with escaped colons indicating a literal block.
957   - Fixed bug with enumerated lists (SF#1254145).
958   - Backslash-escaped colons inside of field names are now allowed.
959   - Targets (implicit and explicit), anonymous hyperlink references
960     and auto-numbered footnote references inside of substitution
961     definitions are now disallowed.
962   - Fixed bug: list items with blank first lines.
963   - Fixed bug: block quote attributions with indented second lines.
964   - Added East Asian double-width character support (Python 2.4 only).
966 * docutils/parsers/rst/tableparser.py:
968   - Added East Asian double-width character support (Python 2.4 only).
970 * docutils/parsers/rst/directives/body.py:
972   - Added the "container" directive.
974 * docutils/parsers/rst/directives/misc.py:
976   - Added the "default-role", "title", and "date" directives.
977   - Added standard data file syntax to the "include" directive.
978   - Added support for "class" directive content.
980 * docutils/parsers/rst/directives/images.py:
982   - Added ``indirect_reference_name`` support for images with a target
983     option.
984   - Added support for image width and height units.
985   - Fixed bug with image "target" options.
987 * docutils/parsers/rst/directives/references.py:
989   - Added "class" attribute to "target-notes" directive, for
990     footnote_reference classes.
992 * docutils/parsers/rst/include/: Directory added to project; contains
993   standard data files for the "include" directive.  Initial contents:
994   character entity substitution definition sets, and a set of
995   definitions for S5/HTML presentations.
997 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
998   mappings by David Goodger.
1000 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1001   Simplified Chinese mappings by Panjunyong.
1003 * docutils/readers/__init__.py:
1005   - Added universal.Decorations and universal.ExposeInternals
1006     transforms as default transforms for all readers.
1007   - Added ``ReReader`` base class for readers that reread an existing
1008     document tree.
1010 * docutils/readers/doctree.py: Added to project; a reader for existing
1011   document trees.
1013 * docutils/transforms/frontmatter.py:
1015   - Fixed the DocInfo transform to handle SVN-style expansion of the
1016     "Date" keyword.
1017   - In ``DocInfo.extract_authors``, treat the contents of "authors"
1018     fields uniformly.
1020 * docutils/transforms/misc.py:
1022   - Added misc.Transitions transform, extracted from
1023     universal.FinalChecks.
1025 * docutils/transforms/references.py:
1027   - Added references.DanglingReferences transform, extracted from
1028     universal.FinalChecks.
1029   - Fixed bug with doubly-indirect substitutions.
1030   - Added footnote_reference classes attribute to "TargetNotes".
1031   - Fixed bug with circular substitution definitions that put Docutils
1032     into an infinite loop.
1034 * docutils/transforms/universal.py:
1036   - Added universal.ExposeInternals transform, extracted from
1037     universal.FinalChecks.
1038   - Removed universal.FinalChecks transform (logic has been moved to
1039     several new transforms).
1040   - Fixed bug with the "expose_internals" setting and Text nodes
1041     (exposed by the "rawsource" internal attribute).
1042   - Added the universal.StripComments transform, implementation of the
1043     "strip_comments" setting.
1045 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1046   transforms for writers.
1048   - Added ``Compound`` transform, which flattens compound paragraphs.
1050 * docutils/writers/: Several writer modules (html4css1.py) were
1051   converted into packages.  Support modules and data files have been
1052   moved into the packages.  The stylesheets for the HTML writers are
1053   now installed along with the code, the code knows where to find
1054   them, and the default is to use them (actually, to embed them).
1055   Some adjustments to configuration files may be necessary.  The
1056   easiest way to obtain the new default behavior is to remove all
1057   settings whose name includes "stylesheet".
1059 * docutils/writers/__init__.py:
1061   - Added universal.Messages and universal.FilterMessages transforms
1062     as default transforms for all writers.
1063   - Added ``UnfilteredWriter`` base class for writers that pass the
1064     document tree on unchanged.
1066 * docutils/writers/docutils_xml.py:
1068   - Made ``xmlcharrefreplace`` the default output encoding error
1069     handler.
1071 * docutils/writers/html4css1/:
1073   - Added support for image width and height units.
1074   - Made ``xmlcharrefreplace`` the default output encoding error
1075     handler.
1076   - Made ``--embed-stylesheet`` the default rather than
1077     ``--link-stylesheet``.
1078   - Moved "id" attribute from container (section etc.) to title's <a>
1079     tag, to be on the same tag as "name".
1080     (!!! To be reverted in Docutils 0.5.)
1081   - Added vertical space between fields of field lists.
1082   - Added ``--compact-field-lists`` option to remove vertical space in
1083     simple field lists.
1084   - Made cloaking of email addresses with ``--cloak-email-addresses``
1085     less obtrusive.
1086   - Fixed support for centered images.
1087   - Added support for class="compact" & class="open" lists.
1089 * docutils/writers/latex2e/:
1091   - Underscores in citekeys are no longer escaped.
1093 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1094   mapping of Unicode characters to LaTeX equivalents.
1096 * docutils/writers/s5_html/: Package added to project; writer for
1097   S5/HTML slide shows.
1099 * docs/dev/distributing.txt: Added to project; guide for distributors
1100   (package maintainers).
1102 * docs/dev/hacking.txt: Added to project; guide for developers.
1104 * docs/ref/doctree.txt:
1106   - Updated for plural attributes "classes", "ids", "names",
1107     "dupnames".
1108   - Added the "container" element.
1110 * docs/ref/docutils.dtd:
1112   - Updated for plural attributes "classes", "ids", "names",
1113     "dupnames".
1115 * docs/user/emacs.txt: Added to project; a document about Emacs
1116   support for reStructuredText and Docutils.
1118 * docs/user/links.txt: Added to project; lists of Docutils-related
1119   links.
1121 * docs/user/mailing-lists.txt: Added to project; information about
1122   Docutils-related mailing lists and how to access them.
1124 * docs/user/slide-shows.txt: Added to project; example of and docs for
1125   the S5/HTML writer (``rst2s5.py`` front end).
1127 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1128   Files", added to project.
1130 * test/coverage.sh: Added to project; test coverage script.
1132 * test/DocutilsTestSupport.py:
1134   - Added support for specifying runtime settings at the suite level.
1136 * test/test_functional.py:
1138   - Added the ``clear_output_directory`` function.
1139   - Added support for ``_test_more`` functions in functional test
1140     config files.
1142 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1144 * tools/rstpep2html.py: Renamed from pep.py.
1146 * tools/dev/create_unimap.py: Added to project; script to create the
1147   docutils/writers/unimap_latex.py mapping file.
1149 * tools/dev/profile_docutils.py: Added to project; profiler script.
1151 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1153 * tools/editors/emacs/restructuredtext.el,
1154   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1155   Removed from project; the functionality is now contained in rst.el.
1157 * tools/editors/emacs/rst.el: Added to project.  Added many features
1158   and fixed many bugs.  See docs/user/emacs.txt for details.
1160 * tools/stylesheets: Removed from project.  Stylesheets have been
1161   renamed and moved into writer packages.
1164 Release 0.3.9 (2005-05-26)
1165 ==========================
1167 * General:
1169   - Eliminated and replaced all uses of the old string attributes
1170     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1171     new list attributes ``ids``, ``names``, ``dupnames`` and
1172     ``classes`` throughout the whole source tree.
1174 * docutils/core.py:
1176   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1177     allowing for easier debugging.
1178   - In ``Publisher.publish()``, expanded the generic top-level
1179     exception catching.
1181 * docutils/examples.py:
1183   - Added ``internals`` function for exploration.
1185 * docutils/io.py:
1187   - Fixed ``Input.decode`` method to apply heuristics only if no
1188     encoding is explicitly given, and to provide better reporting of
1189     decoding errors.
1190   - The ``Input.decode`` method now removes byte order marks (BOMs)
1191     from input streams.
1193 * docutils/nodes.py:
1195   - ``image`` element class changed to subclass of Element, not
1196     TextElement (it's an empty element, and cannot contain text).
1197   - Added ``attr_defaults`` dictionary for default attribute values.
1198   - Added empty list as default value for the following attributes:
1199     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1200   - Added ``document.decoration`` attribute,
1201     ``document.get_decoration`` method, and ``decoration.get_header``
1202     & ``.get_footer`` methods.
1203   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1204     methods.
1206 * docutils/utils.py:
1208   - Removed ``docutils.utils.Reporter.categories``,
1209     ``docutils.utils.ConditionSet``, and all references to them, to
1210     simplify error reporting.
1212 * docutils/languages/nl.py: Added to project; Dutch mappings by
1213   Martijn Pieters.
1215 * docutils/parsers/rst/__init__.py:
1217   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1219 * docutils/parsers/rst/states.py:
1221   - Added check for escaped at-mark to prevent email address recognition.
1222   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1223     arguments>``.
1224   - Allowed whitespace in paths and URLs.
1225   - Added auto-enumerated list items.
1226   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1227     followed by text.
1228   - Added support for table stub columns.
1230 * docutils/parsers/rst/directives/__init__.py:
1232   - Allowed whitespace in paths (``path`` function).
1233   - Added ``uri`` directive option conversion function.
1235 * docutils/parsers/rst/directives/body.py:
1237   - Fixed illegal context bug with "topic" directive (allowed within
1238     sidebars; not within body elements).
1240 * docutils/parsers/rst/directives/images.py:
1242   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1243   - Added support for the ``file_insertion_enabled`` setting in the
1244     "figure" directive (disables "figwidth" option).
1245   - "image" directive: added checks for valid values of "align" option,
1246     depending on context.  "figure" directive: added specialized
1247     "align" option and attribute on "figure" element.
1248   - Made ":figwidth: image" option of "figure" directive work again.
1249   - Fixed bug with reference names containing uppercase letters
1250     (e.g. ``Name_``) in "target" option of "image" directive.
1252 * docutils/parsers/rst/directives/misc.py:
1254   - Fixed "include" and "raw" directives to catch text decoding
1255     errors.
1256   - Allowed whitespace in "include" & "raw" directive paths.
1257   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1258     settings in "include" & "raw" directives.
1260 * docutils/parsers/rst/directives/parts.py:
1262   - Added "header" & "footer" directives.
1263   - Fixed illegal context bug with "contents" directive (topics
1264     allowed within sidebars; not within body elements).
1266 * docutils/parsers/rst/directives/tables.py:
1268   - Added "list-table" directive.
1269   - Caught empty CSV table bug.
1270   - Added support for the ``file_insertion_enabled`` setting in the
1271     "csv-table" directive.
1272   - Added ``stub-columns`` option to "csv-table" and "list-table"
1273     directives.
1275 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1276   mappings by Martijn Pieters.
1278 * docutils/readers/standalone.py:
1280   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1281     options to activate or deactivate the SectSubTitle transform.
1283 * docutils/transforms/frontmatter.py:
1285   - Added SectSubTitle transform to promote titles of lone
1286     subsections to subtitles.
1288 * docutils/transforms/references.py:
1290   - Fixed mislocated internal targets bug, by propagating internal
1291     targets to the next node, making use of the newly added support
1292     for multiple names and IDs.
1293   - Fixed duplicate footnote label bug.
1294   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1295     transform.
1297 * docutils/writers/html4css1.py:
1299   - Fixed unencoded stylesheet reference bug (characters like "&" in
1300     stylesheet references).
1301   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1302     tags).
1303   - Added support for multiple IDs per node by creating empty ``span``
1304     tags.
1305   - Added the ``field_name_limit`` & ``option_limit`` settings &
1306     support.
1307   - Added support for table stub columns.
1308   - Added support for the ``align`` attribute on ``figure`` elements.
1309   - Added the ``cloak_email_addresses`` setting & support.
1310   - Added ``html_prolog``, ``html_head``, ``html_body``,
1311     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1312     ``docutils.core.publish_parts``.
1313   - Added support for section subtitles.
1315 * docutils/writers/latex2e.py:
1317   - Fixed tables starting with more than one multirow cell.
1318   - Improved --use-latex-docinfo so that organization/contact/address
1319     fields are lumped with the last author field and appear on the
1320     titlepage.
1321   - Made sure the titlepage is always shown with --use-latex-docinfo,
1322     even if the document has no title.
1323   - Made sure that latex doesn't fill in today's date if no date field
1324     was given.
1325   - Added support for section subtitles.
1327 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1328   (under development).
1330 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1332 * docs/api/publisher.txt:
1334   - Added "``publish_parts`` Details" section.
1336 * docutils/dev/repository.txt: Added to project; information about the
1337   Docutils Subversion repository.
1339 * docs/ref/docutils.dtd:
1341   - Added a ``stub`` attribute to the ``colspec`` element via the
1342     ``tbl.colspec.att`` parameter entity.
1343   - Allowed topic elements within sidebars
1344   - Added an ``align`` attribute to the ``figure`` element.
1346 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1347   writer.
1350 Release 0.3.7 (2004-12-24)
1351 ==========================
1353 * docutils/frontend.py:
1355   - Added options: --input-encoding-error-handler,
1356     --record-dependencies, --leave-footnote-reference-space,
1357     --strict-visitor.
1358   - Added command-line and config file support for "overrides" setting
1359     parameter.
1361 * docutils/io.py:
1363   - Added support for input encoding error handler.
1365 * docutils/nodes.py:
1367   - Added dispatch_visit and dispatch_departure methods to
1368     NodeVisitor; useful as a hook for Visitors.
1369   - Changed structure of ``line_block``; added ``line``.
1370   - Added ``compound`` node class.
1371   - Added a mechanism for Visitors to transitionally ignore new node
1372     classes.
1374 * docutils/utils.py:
1376   - Moved ``escape2null`` and ``unescape`` functions from
1377     docutils/parsers/rst/states.py.
1379 * docutils/parsers/rst/roles.py:
1381   - Added "raw" role.
1382   - Changed role function API: the "text" parameter now takes
1383     null-escaped interpreted text content.
1385 * docutils/parsers/rst/states.py:
1387   - Fixed bug where a "role" directive in a nested parse would crash
1388     the parser; the state machine's "language" attribute was not being
1389     copied over.
1390   - Added support for line block syntax.
1391   - Fixed directive parsing bug: argument-less directives didn't
1392     notice that arguments were present.
1393   - Removed error checking for transitions.
1394   - Added support for multiple classifiers in definition list items.
1395   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1396   - Changed role function API: the "text" parameter now takes
1397     null-escaped interpreted text content.
1398   - Empty sections and documents are allowed now.
1400 * docutils/parsers/rst/directives/__init__.py:
1402   - Added ``encoding`` directive option conversion function.
1403   - Allow multiple class names in class_option conversion function.
1405 * docutils/parsers/rst/directives/body.py:
1407   - Converted the line-block directive to use the new structure.
1408   - Extracted the old line-block functionality to the ``block``
1409     function (still used).
1410   - Added ``compound`` directive (thanks to Lea Wiemann).
1412 * docutils/parsers/rst/directives/misc.py:
1414   - Added "encoding" option to "include" and "raw" directives.
1415   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1416   - Allow multiple class names in the "class" directive.
1418 * docutils/parsers/rst/directives/parts.py:
1420   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1421     options.  Thanks to Lele Gaifax.
1423 * docutils/parsers/rst/directives/tables.py:
1425   - Added "encoding" directive to "csv-table" directive.
1426   - Added workaround for lack of Unicode support in csv.py, for
1427     non-ASCII CSV input.
1429 * docutils/transforms/misc.py:
1431   - Fixed bug when multiple "class" directives are applied to a single
1432     element.
1433   - Enabled multiple format names for "raw" directive.
1435 * docutils/transforms/references.py:
1437   - Added support for trimming whitespace from beside substitution
1438     references.
1440 * docutils/transforms/universal.py:
1442   - FinalChecks now checks for illegal transitions and moves
1443     transitions between sections.
1445 * docutils/writers/html4css1.py:
1447   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1448   - "stylesheet" and "stylesheet_path" settings are now mutually
1449     exclusive.
1450   - Added support for the new line_block/line structure.
1451   - --footnote-references now overrides
1452     --trim-footnote-reference-space, if applicable.
1453   - Added support for ``compound`` elements.
1454   - Enabled multiple format names for "raw" directive.
1455   - ``<p>`` tags of a paragraph which is the only visible child of the
1456     document node are no longer stripped.
1457   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1458     new method ``should_be_compact_paragraph()``.
1459   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1460     elements.
1461   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1462     the output if they have their ``class`` attribute set.
1463   - The whole document is now surrounded by a ``<div
1464     class="document">`` element.
1465   - Body-level images are now wrapped by their own ``<div>`` elements,
1466     with image classes copied to the wrapper, and for images which
1467     have the ``:align:`` option set, the surrounding ``<div>`` now
1468     receives a class attribute (like ``class="align-left"``).
1470 * docutils/writers/latex2e.py:
1472   - no newline after depart_term.
1473   - Added translations for some Unicode quotes.
1474   - Added option "font-encoding", made package AE the default.
1475   - "stylesheet" and "stylesheet_path" settings are now mutually
1476     exclusive.
1477   - --footnote-references now overrides
1478     --trim-footnote-reference-space, if applicable.
1479   - The footnote label style now matches the footnote reference style
1480     ("brackets" or "superscript").
1481   - Added support for ``compound`` elements.
1482   - Enabled multiple format names for "raw" directive.
1484 * docs/ref/docutils.dtd:
1486   - Changed structure of the ``line_block`` element; added ``line``.
1487   - Added ``compound`` element.
1488   - Added "ltrim" and "rtrim" attributes to
1489     ``substitution_definition`` element.
1490   - Enabled multiple format names for ``raw`` element.
1491   - Enabled multiple classifiers in ``definition_list_item`` elements.
1493 * docs/ref/rst/directives.txt
1495   - Marked "line-block" as deprecated.
1496   - "Class" directive now allows multiple class names.
1497   - Added "Rationale for Class Attribute Value Conversion".
1498   - Added warning about "raw" overuse/abuse.
1500 * docs/ref/rst/restructuredtext.txt:
1502   - Added syntax for line blocks.
1503   - Definition list items may have multiple classifiers.
1505 * docs/ref/rst/roles.txt:
1507   - Added "raw" role.
1509 * tools/stylesheets/default.css:
1511   - Added support for the new line_block structure.
1512   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1515 Release 0.3.5 (2004-07-29)
1516 ==========================
1518 General:
1520 * _`Documentation cleanup/reorganization`.
1522   - Created new subdirectories of docs/:
1524     * ``docs/user/``: introductory/tutorial material for end-users
1525     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1526     * ``docs/api/``: API reference material for client-developers
1527     * ``docs/ref/``: reference material for all groups
1528     * ``docs/howto/``: for component-developers and core-developers
1529     * ``docs/peps/``: Python Enhancement Proposals
1531   - Moved ``docs/*`` to ``docs/user/``.
1532   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1533     ``spec/`` to ``docs/dev``.
1534   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1535     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1536   - Moved ``alternatives.txt``, and ``problems.txt`` from
1537     ``spec/rst/`` to ``docs/dev/rst/``.
1538   - Moved ``reStructuredText.txt``, ``directives.txt``,
1539     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1540     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1541     ``roles.txt``, ``reStructuredText.txt`` to
1542     ``restructuredtext.txt``.
1543   - Moved ``spec/howto/`` to ``docs/howto``.
1545   In order to keep the CVS history of moved files, we supplied
1546   SourceForge with a `script for modifying the Docutils CVS
1547   repository`__.
1549   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1551   After running the cleanup script:
1553   - Added ``docs/index.txt``.
1554   - Added a ``.htaccess`` file to the ``web`` module, containing
1555     redirects for all old paths to new paths.  They'll preserve
1556     fragments (the "#name" part of a URL), and won't clutter up the
1557     file system, and will correct the URL in the user's browser.
1558   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1559     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1560     the "To Do" list itself in ``docs/dev/todo.txt``.
1561   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1562     section of ``docs/dev/todo.txt``.
1563   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1564   - Added "How To Report Bugs" to ``BUGS.txt``.
1565   - Went through all the sources and docs (including under web/) and
1566     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1567     (Still need to update links in the sandboxes.)
1569 Specific:
1571 * BUGS.txt: Added to project.
1573 * THANKS.txt: Added to project.
1575 * docutils/__init__.py:
1577   - 0.3.4: Post-release.
1579 * docutils/core.py:
1581   - Added special error handling & advice for UnicodeEncodeError.
1582   - Refactored Publisher.publish (simplified exception handling &
1583     extracted debug dumps).
1584   - Renamed "enable_exit" parameter of convenience functions to
1585     "enable_exit_status".
1586   - Enabled traceback (exception propagation) by default in
1587     programmatic convenience functions.
1588   - Now publish_file and publish_cmdline convenience functions return
1589     the encoded string results in addition to their regular I/O.
1590   - Extracted common code from publish_file, publish_string, and
1591     publish_parts, into new publish_programmatically.  Extracted
1592     settings code to ``Publisher.process_programmatic_settings``.
1593   - In Publisher.publish, disabled ``settings_overrides`` when
1594     ``settings`` is supplied; redundant.
1596 * docutils/frontend.py:
1598   - Added help text for "--output-encoding-error-handler" and
1599     "--error-encoding-error-handler".
1600   - Renamed "--exit" to "--exit-status".
1601   - Simplified default-setting code.
1603 * docutils/parsers/rst/__init__.py:
1605   - Added "--pep-base-url" and "--rfc-base-url" options.
1607 * docutils/parsers/rst/states.py:
1609   - Made URI recognition more aggressive and intelligent.
1611 * docutils/parsers/rst/directives/__init__.py:
1613   - Added several directive option conversion functions.
1615 * docutils/parsers/rst/directives/body.py:
1617   - Moved "table" directive to tables.py.
1619 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1620   added to project.
1622 * docutils/writers/latex2e.py:
1624   - Added "--table-style=(standard|booktabs|nolines)"
1625   - figures get "here" option (LaTeX per default puts them at bottom),
1626     and figure content is centered.
1627   - Rowspan support for tables.
1628   - Fix: admonition titles before first section.
1629   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1630   - Replave ``_`` in literal by an underlined blank, because it has the correct
1631     width.
1632   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1633   - A few unicode replacements, if output_encoding != utf
1634   - Add "--graphicx-option".
1635   - Indent literal-blocks.
1636   - Fix: omit ``\maketitle`` when there is no document title.
1638 * docs/index.txt: "Docutils Project Documentation Overview", added to
1639   project.
1641 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1642   Tool", added to project.
1644 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1646 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1648 * docs/dev/policies.txt: Added to project (extracted from
1649   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1651 * docs/dev/release.txt: Added to project (extracted from
1652   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1654 * docs/dev/testing.txt: Added to project.
1656 * docs/dev/website.txt: Added to project (extracted from
1657   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1659 * docs/ref/rst/directives.txt:
1661   - Added directives: "table", "csv-table".
1663 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1664   added to project.  1 page for syntax, and a 1 page reference for
1665   directives and roles.  Source text to be used as-is; not meant to be
1666   converted to HTML.
1668 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1669   with a change of title.
1671 * test/functional/, contents, and test/test_functional.py: Added to
1672   project.
1674 * tools/buildhtml.py: Fixed bug with config file handling.
1676 * tools/html.py: Removed from project (duplicate of rst2html.py).
1678 * tools/pep2html.py: Removed from project (duplicate of Python's
1679   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1680   Docutils-related PEPs in docs/peps/).
1682 * tools/rst2pseudoxml.py: Renamed from publish.py.
1684 * tools/rst2xml.py: Renamed from docutils-xml.py.
1686 * tools/test.txt: Removed from project; moved to
1687   docs/user/rst/demo.txt.
1689 * setup.py: Now also installs ``rst2latex.py``.
1692 Release 0.3.3 (2004-05-09)
1693 ==========================
1695 * docutils/__init__.py:
1697   - 0.3.1: Reorganized config file format (multiple sections); see
1698     docs/config.txt.
1699   - Added unknown_reference_resolvers attribute to TransformSpec.
1700   - 0.3.2: Interpreted text reorganization.
1701   - 0.3.3: Released.
1703 * docutils/core.py:
1705   - Catch system messages to stop tracebacks from parsing errors.
1706   - Catch exceptions during processing report & exit without
1707     tracebacks, except when "--traceback" used.
1708   - Reordered components for OptionParser; application comes last.
1709   - Added "config_section" parameter to several methods and functions,
1710     allowing front ends to easily specify their config file sections.
1711   - Added publish_parts convenience function to allow access to individual
1712     parts of a document.
1714 * docutils/examples.py: Added to project; practical examples of
1715   Docutils client code, to be used as-is or as models for variations.
1717 * docutils/frontend.py:
1719   - Added "--traceback" & "--no-traceback" options ("traceback"
1720     setting).
1721   - Implemented support for config file reorganization:
1722     ``standard_config_files`` moved from ``ConfigParser`` to
1723     ``OptionParser``; added
1724     ``OptionParser.get_config_file_settings()`` and
1725     ``.get_standard_config_settings()``; support for old "[options]"
1726     section (with deprecation warning) and mapping from old to new
1727     settings.
1728   - Reimplemented setting validation.
1729   - Enabled flexible boolean values: yes/no, true/false, on/off.
1730   - Added ``Values``, a subclass of ``optparse.Values``, with support
1731     for list setting attributes.
1732   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1733     thanks to Beni Cherniavsky.
1734   - Added "--no-section-numbering" option.
1736 * docutils/io.py:
1738   - Catch IOErrors when opening source & destination files, report &
1739     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1740     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1742 * docutils/nodes.py:
1744   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1745     method definitions (via ``exec``) to dynamic assignments (via
1746     ``setattr``); thanks to Roman Suzi.
1747   - Encapsulated visitor dynamic assignments in a function; thanks to
1748     Ian Bicking.
1749   - Added indirect_reference_name attribute to the Targetable
1750     class. This attribute holds the whitespace_normalized_name
1751     (contains mixed case) of a target.
1753 * docutils/statemachine.py:
1755   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1756   - Added ``StringList.get_2D_block``.
1758 * docutils/utils.py:
1760   - Added "level" attribute to SystemMessage exceptions.
1762 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1763   Jannie Hofmeyr.
1765 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1766   Blaha.
1768 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1769   Marcelo Huerta San Martin.
1771 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1772   mappings by Lalo Martins.
1774 * docutils/languages/ru.py: Added to project; Russian mappings by
1775   Roman Suzi.
1777 * docutils/parsers/rst/roles.py: Added to project.  Contains
1778   interpreted text role functions, a registry for interpreted text
1779   roles, and an API for adding to and retrieving from the registry.
1780   Contributed by Edward Loper.
1782 * docutils/parsers/rst/states.py:
1784   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1785   - Allowed true em-dash character and "---" as block quote
1786     attribution marker.
1787   - Added support for <angle-bracketed> complex option arguments
1788     (option lists).
1789   - Fixed handling of backslashes in substitution definitions.
1790   - Fixed off-by-1 error with extra whitespace after substitution
1791     definition directive.
1792   - Added inline markup parsing to field lists' field names.
1793   - Added support for quoted (and unindented) literal blocks.
1794     Driven in part by a bribe from Frank Siebenlist (thanks!).
1795   - Parser now handles escapes in URIs correctly.
1796   - Made embedded-URIs' reference text omittable.  Idea from Beni
1797     Cherniavsky.
1798   - Refactored explicit target processing code.
1799   - Added name attribute to references containing the reference name only
1800     through whitespace_normalize_name (no case changes).
1801   - parse_target no longer returns the refname after going through
1802     normalize_name. This is now handled in make_target.
1803   - Fixed bug relating to role-less interpreted text in non-English
1804     contexts.
1805   - Reorganized interpreted text processing; moved code into the new
1806     roles.py module.  Contributed by Edward Loper.
1807   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1808     ``parse_directive_block``.
1810 * docutils/parsers/rst/tableparser.py:
1812   - Reworked for ``StringList``, to support "include" directives in
1813     table cells.
1815 * docutils/parsers/rst/directives/__init__.py:
1817   - Renamed ``unchanged()`` directive option conversion function to
1818     ``unchanged_required``, and added a new ``unchanged``.
1819   - Catch unicode value too high error; fixes bug 781766.
1820   - Beefed up directive error reporting.
1822 * docutils/parsers/rst/directives/body.py:
1824   - Added basic "table" directive.
1826 * docutils/parsers/rst/directives/images.py:
1828   - Added "target" option to "image" directive.
1829   - Added name attribute to references containing the reference name only
1830     through whitespace_normalize_name (no case changes).
1832 * docutils/parsers/rst/directives/misc.py:
1834   - Isolated the import of the ``urllib2`` module; was causing
1835     problems on SourceForge (``libssl.so.2`` unavailable?).
1836   - Added the "role" directive for declaring custom interpreted text
1837     roles.
1839 * docutils/parsers/rst/directives/parts.py:
1841   - The "contents" directive does more work up-front, creating the
1842     "topic" and "title", and leaving the "pending" node for the
1843     transform.  Allows earlier reference resolution; fixes subtle bug.
1845 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1846   mappings by Jannie Hofmeyr.
1848 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1849   mappings by Marek Blaha.
1851 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1852   mappings by Marcelo Huerta San Martin.
1854 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1855   Portuguese mappings by Lalo Martins.
1857 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1858   mappings by Roman Suzi.
1860 * docutils/transforms/parts.py:
1862   - The "contents" directive does more work up-front, creating the
1863     "topic" and "title", and leaving the "pending" node for the
1864     transform.  Allows earlier reference resolution; fixes subtle bug.
1865   - Added support for disabling of section numbering.
1867 * docutils/transforms/references.py:
1869   - Verifying that external targets are truly targets and not indirect
1870     references. This is because we are now adding a "name" attribute to
1871     references in addition to targets. Note sure if this is correct!
1872   - Added code to hook into the unknown_reference_resolvers list for a
1873     transformer in resolve_indirect_target. This allows the
1874     unknown_reference_resolvers to keep around indirect targets which
1875     docutils doesn't know about.
1876   - Added specific error message for duplicate targets.
1878 * docutils/transforms/universal.py:
1880   - Added FilterMessages transform (removes system messages below the
1881     verbosity threshold).
1882   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1883     to FinalCheckVisitor for application-specific handling of
1884     unresolvable references.
1885   - Added specific error message for duplicate targets.
1887 * docutils/writers/__init__.py:
1889   - Added assemble_parts method to the Writer class to allow for
1890     access to a documents individual parts.
1891   - Documented & set default for ``Writer.output`` attribute.
1893 * docutils/writers/html4css1.py:
1895   - Fixed unicode handling of attribute values (bug 760673).
1896   - Prevent duplication of "class" attribute values (bug report from
1897     Kirill Lapshin).
1898   - Improved table grid/border handling (prompted by report from Bob
1899     Marshall).
1900   - Added support for table titles.
1901   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1902     to Darek Suchojad.
1903   - Added functionality to keep track of individual parts of a document
1904     and store them in a dictionary as the "parts" attribute of the writer.
1905     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1906   - Added proper support for the "scale" attribute of the "image"
1907     element.  Contributed by Brent Cook.
1908   - Added ``--initial-header-level`` option.
1909   - Fixed bug: the body_pre_docinfo segment depended on there being a
1910     docinfo; if no docinfo, the document title was incorporated into
1911     the body segment.  Adversely affected the publish_parts interface.
1913 * docutils/writers/latex2e.py:
1915   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1916     about a missing file.
1917   - Added options and support: ``--compound-enumerators``,
1918     ``--section-prefix-for-enumerators``, and
1919     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1920     934322).
1921   - Added option ``--use-verbatim-when-possible``, to avoid
1922     problematic characters (eg, '~' in italian) in literal blocks.
1923   - It's now possible to use four section levels in the `book` and
1924     `report` LaTeX classes.  The default `article` class still has
1925     three levels limit.
1927 * docs/config.txt: "Docutils Configuration Files", added to project.
1928   Moved config file entry descriptions from tools.txt.
1930 * docs/tools.txt:
1932   - Moved config file entry descriptions to config.txt.
1934 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1935   Development".
1937 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1938   Text Roles", added to project.
1940 * spec/rst/reStructuredText.txt:
1942   - Added description of support for <angle-bracketed> complex option
1943     arguments to option lists.
1944   - Added subsections for indented and quoted literal blocks.
1946 * test: Continually adding & updating tests.
1948   - Added test/test_settings.py & test/data/config_*.txt support
1949     files.
1950   - Added test/test_writers/test_htmlfragment.py.
1952 * test/DocutilsTestSupport.py:
1954   - Refactored LaTeX publisher test suite/case class names to make
1955     testing other writers easier.
1956   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1957     to test the processing of HTML fragments which use the new
1958     publish_parts convenience function.
1960 * tools/buildhtml.py:
1962   - Added support for the "--prune" option.
1963   - Removed dependency on pep2html.py; plaintext PEPs no longer
1964     supported.
1966 * tools/docutils.conf:
1968   - Updated for configuration file reorganization.
1970 * tools/rst2html.py:
1972   - copied from tools/html.py
1974 * setup.py:
1976   - added a 'scripts' section to configuration
1977   - added 'tools/rst2html.py' to the scripts section
1980 Release 0.3 (2003-06-24)
1981 ========================
1983 General:
1985 * Renamed "attribute" to "option" for directives/extensions.
1987 * Renamed transform method "transform" to "apply".
1989 * Renamed "options" to "settings" for runtime settings (as set by
1990   command-line options).  Sometimes "option" (singular) became
1991   "settings" (plural).  Some variations below:
1993   - document.options -> document.settings (stored in other objects as
1994     well)
1995   - option_spec -> settings_spec (not directives though)
1996   - OptionSpec -> SettingsSpec
1997   - cmdline_options -> settings_spec
1998   - relative_path_options -> relative_path_settings
1999   - option_default_overrides -> settings_default_overrides
2000   - Publisher.set_options -> Publisher.get_settings
2002 Specific:
2004 * COPYING.txt: Added "Public Domain Dedication".
2006 * FAQ.txt: Frequently asked questions, added to project.
2008 * setup.py:
2010   - Updated with PyPI Trove classifiers.
2011   - Conditional installation of third-party modules.
2013 * docutils/__init__.py:
2015   - Bumped version to 0.2.1 to reflect changes to I/O classes.
2016   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2017   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2018   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2019     option and its effect on the PEP template & writer.
2020   - Bumped version to 0.2.4 due to changes to the PEP template &
2021     stylesheet.
2022   - Bumped version to 0.2.5 to reflect changes to Reporter output.
2023   - Added ``TransformSpec`` class for new transform system.
2024   - Bumped version to 0.2.6 for API changes (renaming).
2025   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2026     convenience functions.
2027   - Added ``Component.component_type`` attribute.
2028   - Bumped version to 0.2.8 because of the internal parser switch from
2029     plain lists to the docutils.statemachine.StringList objects.
2030   - Bumped version to 0.2.9 because of the frontend.py API changes.
2031   - Bumped version to 0.2.10 due to changes to the project layout
2032     (third-party modules removed from the "docutils" package), and
2033     signature changes in ``io.Input``/``io.Output``.
2034   - Changed version to 0.3.0 for release.
2036 * docutils/core.py:
2038   - Made ``publish()`` a bit more convenient.
2039   - Generalized ``Publisher.set_io``.
2040   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2041     parameters; improved its docstring.
2042   - Added ``publish_file()`` and ``publish_string()``.
2043   - Factored ``Publisher.set_source()`` and ``.set_destination()``
2044     out of ``.set_io``.
2045   - Added support for "--dump-pseudo-xml", "--dump-settings", and
2046     "--dump-transforms" hidden options.
2047   - Added ``Publisher.apply_transforms()`` method.
2048   - Added ``Publisher.set_components()`` method; support for
2049     ``publish_*()`` conveninece functions.
2050   - Moved config file processing to docutils/frontend.py.
2051   - Added support for exit status ("exit_level" setting &
2052     ``enable_exit`` parameter for Publisher.publish() and convenience
2053     functions).
2055 * docutils/frontend.py:
2057   - Check for & exit on identical source & destination paths.
2058   - Fixed bug with absolute paths & "--config".
2059   - Set non-command-line defaults in ``OptionParser.__init__()``:
2060     ``_source`` & ``_destination``.
2061   - Distributed ``relative_path_settings`` to components; updated
2062     ``OptionParser.populate_from_components()`` to combine it all.
2063   - Require list of keys in ``make_paths_absolute`` (was implicit in
2064     global ``relative_path_settings``).
2065   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2066     "--dump-settings", and "--dump-transforms" hidden options.
2067   - Removed nasty internals-fiddling ``ConfigParser.get_section``
2068     code, replaced with correct code.
2069   - Added validation functionality for config files.
2070   - Added "--error-encoding" option/setting, "_disable_config"
2071     internal setting.
2072   - Added encoding validation; updated "--input-encoding" and
2073     "--output-encoding"; added "--error-encoding-error-handler" and
2074     "--output-encoding-error-handler".
2075   - Moved config file processing from docutils/core.py.
2076   - Updated ``OptionParser.populate_from_components`` to handle new
2077     ``SettingsSpec.settings_defaults`` dict.
2078   - Added support for "-" => stdin/stdout.
2079   - Added "exit_level" setting ("--exit" option).
2081 * docutils/io.py:
2083   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2084   - Added automatic closing to ``FileInput`` and ``FileOutput``.
2085   - Delayed opening of ``FileOutput`` file until ``write()`` called.
2086   - ``FileOutput.write()`` now returns the encoded output string.
2087   - Try to get path/stream name automatically in ``FileInput`` &
2088     ``FileOutput``.
2089   - Added defaults for source & destination paths.
2090   - Allow for Unicode I/O with an explicit "unicode" encoding.
2091   - Added ``Output.encode()``.
2092   - Removed dependency on runtime settings; pass encoding directly.
2093   - Recognize Unicode strings in ``Input.decode()``.
2094   - Added support for output encoding error handlers.
2096 * docutils/nodes.py:
2098   - Added "Invisible" element category class.
2099   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2100     modification during a traversal.
2101   - Added element classes: ``line_block``, ``generated``, ``address``,
2102     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2103     ``superscript``, ``subscript``, ``inline``
2104   - Added support for lists of nodes to ``Element.insert()``.
2105   - Fixed parent linking in ``Element.replace()``.
2106   - Added new abstract superclass ``FixedTextElement``; adds
2107     "xml:space" attribute.
2108   - Added support for "line" attribute of ``system_message`` nodes.
2109   - Added support for the observer pattern from ``utils.Reporter``.
2110     Added ``parse_messages`` and ``transform_messages`` attributes to
2111     ``document``, removed ``messages``.  Added ``note_parse_message``
2112     and ``note_transform_message`` methods.
2113   - Added support for improved diagnostics:
2115     - Added "document", "source", and "line" internal attributes to
2116       ``Node``, set by ``Node.setup_child()``.
2117     - Converted variations on ``node.parent = self`` to
2118       ``self.setup_child(node)``.
2119     - Added ``document.current_source`` & ``.current_line``
2120       attributes, and ``.note_source`` observer method.
2121     - Changed "system_message" output to GNU-Tools format.
2123   - Added a "rawsource" attribute to the ``Text`` class, for text
2124     before backslash-escape resolution.
2125   - Support for new transform system.
2126   - Reworked ``pending`` element.
2127   - Fixed XML DOM bug (SF #660611).
2128   - Removed the ``interpeted`` element class and added
2129     ``title_reference``, ``abbreviation``, ``acronym``.
2130   - Made substitutions case-sensitive-but-forgiving; moved some code
2131     from the parser.
2132   - Fixed Unicode bug on element attributes (report: William Dode).
2134 * docutils/optik.py: Removed from project; replaced with
2135   extras/optparse.py and extras/textwrap.py.  These will be installed
2136   only if they're not already present in the Python installation.
2138 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2139   only if it's not already present in the Python installation.
2141 * docutils/statemachine.py:
2143   - Factored out ``State.add_initial_transitions()`` so it can be
2144     extended.
2145   - Converted whitespace-specific "blank" and "indent" transitions
2146     from special-case code to ordinary transitions: removed
2147     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2148     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2149     ``ws_initial_transitions`` attributes.
2150   - Removed ``State.match_transition()`` after merging it into
2151     ``.check_line()``.
2152   - Added ``StateCorrection`` exception.
2153   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2154     (moved ``TransitionCorrection`` support there too.)
2155   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2156     ``EOFError`` instead of ``IndexError``.
2157   - Added ``State.no_match`` method.
2158   - Added support for the Observer pattern, triggered by input line
2159     changes.
2160   - Added ``strip_top`` parameter to
2161     ``StateMachineWS.get_first_known_indented``.
2162   - Made ``context`` a parameter to ``StateMachine.run()``.
2163   - Added ``ViewList`` & ``StringList`` classes;
2164     ``extract_indented()`` becomes ``StringList.get_indented()``.
2165   - Added ``StateMachine.insert_input()``.
2166   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2167     thanks to) Fred Drake.
2169 * docutils/utils.py:
2171   - Added a ``source`` attribute to Reporter instances and
2172     ``system_message`` elements.
2173   - Added an observer pattern to ``utils.Reporter`` to keep track of
2174     system messages.
2175   - Fixed bugs in ``relative_path()``.
2176   - Added support for improved diagnostics.
2177   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2178   - Added support for encoding Reporter stderr output, and encoding
2179     error handlers.
2180   - Reporter keeps track of the highest level system message yet
2181     generated.
2183 * docutils/languages: Fixed bibliographic field language lookups.
2185 * docutils/languages/es.py: Added to project; Spanish mappings by
2186   Marcelo Huerta San Martin.
2188 * docutils/languages/fr.py: Added to project; French mappings by
2189   Stefane Fermigier.
2191 * docutils/languages/it.py: Added to project; Italian mappings by
2192   Nicola Larosa.
2194 * docutils/languages/sk.py: Added to project; Slovak mappings by
2195   Miroslav Vasko.
2197 * docutils/parser/__init__.py:
2199   - Added ``Parser.finish_parse()`` method.
2201 * docutils/parser/rst/__init__.py:
2203   - Added options: "--pep-references", "--rfc-references",
2204     "--tab-width", "--trim-footnote-reference-space".
2206 * docutils/parsers/rst/states.py:
2208   - Changed "title under/overline too short" system messages from INFO
2209     to WARNING, and fixed its insertion location.
2210   - Fixed enumerated list item parsing to allow paragraphs & section
2211     titles to begin with enumerators.
2212   - Converted system messages to use the new "line" attribute.
2213   - Fixed a substitution reference edge case.
2214   - Added support for "--pep-references" and "--rfc-references"
2215     options; reworked ``Inliner`` code to make customization easier.
2216   - Removed field argument parsing.
2217   - Added support for short section title over/underlines.
2218   - Fixed "simple reference name" regexp to ignore text like
2219     "object.__method__"; not an anonymous reference.
2220   - Added support for improved diagnostics.
2221   - Reworked directive API, based on Dethe Elza's contribution.  Added
2222     ``Body.parse_directive()``, ``.parse_directive_options()``,
2223     ``.parse_directive_arguments()`` methods.
2224   - Added ``ExtensionOptions`` class, to parse directive options
2225     without parsing field bodies.  Factored
2226     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2227     ``ExtensionOptions``.
2228   - Improved definition list term/classifier parsing.
2229   - Added warnings for unknown directives.
2230   - Renamed ``Stuff`` to ``Struct``.
2231   - Now flagged as errors: transitions at the beginning or end of
2232     sections, empty sections (except title), and empty documents.
2233   - Updated for ``statemachine.StringList``.
2234   - Enabled recognition of schemeless email addresses in targets.
2235   - Added support for embedded URIs in hyperlink references.
2236   - Added backslash-escapes to inline markup end-string suffix.
2237   - Added support for correct interpreted text processing.
2238   - Fixed nested title parsing (topic, sidebar directives).
2239   - Added special processing of backslash-escaped whitespace (idea
2240     from David Abrahams).
2241   - Made substitutions case-sensitive-but-forgiving; moved some code
2242     to ``docutils.nodes``.
2243   - Added support for block quote attributions.
2244   - Added a kludge to work-around a conflict between the bubble-up
2245     parser strategy and short titles (<= 3 char-long over- &
2246     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2247     titles" submitted by Jason Diamond.
2248   - Added explicit interpreted text roles for standard inline markup:
2249     "emphasis", "strong", "literal".
2250   - Implemented "superscript" and "subscript" interpreted text roles.
2251   - Added initial support for "abbreviation" and "acronym" roles;
2252     incomplete.
2253   - Added support for "--trim-footnote-reference-space" option.
2254   - Optional space before colons in directives & hyperlink targets.
2256 * docutils/parsers/rst/tableparser.py:
2258   - Fixed a bug that was producing unwanted empty rows in "simple"
2259     tables.
2260   - Detect bad column spans in "simple" tables.
2262 * docutils/parsers/rst/directives: Updated all directive functions to
2263   new API.
2265 * docutils/parsers/rst/directives/__init__.py:
2267   - Added ``flag()``, ``unchanged()``, ``path()``,
2268     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2269     directive option helper functions.
2270   - Added warnings for unknown directives.
2271   - Return ``None`` for missing directives.
2272   - Added ``register_directive()``, thanks to William Dode and Paul
2273     Moore.
2275 * docutils/parsers/rst/directives/admonitions.py:
2277   - Added "admonition" directive.
2279 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2280   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2281   "parsed-literal", "rubric", "epigraph", "highlights" and
2282   "pull-quote" directives.
2284 * docutils/parsers/rst/directives/images.py:
2286   - Added an "align" attribute to the "image" & "figure" directives
2287     (by Adam Chodorowski).
2288   - Added "class" option to "image", and "figclass" to "figure".
2290 * docutils/parsers/rst/directives/misc.py:
2292   - Added "include", "raw", and "replace" directives, courtesy of
2293     Dethe Elza.
2294   - Added "unicode" and "class" directives.
2296 * docutils/parsers/rst/directives/parts.py:
2298   - Added the "sectnum" directive; by Dmitry Jemerov.
2299   - Added "class" option to "contents" directive.
2301 * docutils/parsers/rst/directives/references.py: Added to project.
2302   Contains the "target-notes" directive.
2304 * docutils/parsers/rst/languages/__init__.py:
2306   - Return ``None`` from get_language() for missing language modules.
2308 * docutils/parsers/rst/languages/de.py: Added to project; German
2309   mappings by Engelbert Gruber.
2311 * docutils/parsers/rst/languages/en.py:
2313   - Added interpreted text roles mapping.
2315 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2316   mappings by Marcelo Huerta San Martin.
2318 * docutils/parsers/rst/languages/fr.py: Added to project; French
2319   mappings by William Dode.
2321 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2322   mappings by Nicola Larosa.
2324 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2325   mappings by Miroslav Vasko.
2327 * docutils/readers/__init__.py:
2329   - Added support for the observer pattern from ``utils.Reporter``, in
2330     ``Reader.parse`` and ``Reader.transform``.
2331   - Removed ``Reader.transform()`` method.
2332   - Added default parameter values to ``Reader.__init__()`` to make
2333     instantiation easier.
2334   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2336 * docutils/readers/pep.py:
2338   - Added the ``peps.TargetNotes`` transform to the Reader.
2339   - Removed PEP & RFC reference detection code; moved to
2340     parsers/rst/states.py as options (enabled here by default).
2341   - Added support for pre-acceptance PEPs (no PEP number yet).
2342   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2343     easy subclassing.
2345 * docutils/readers/python: Python Source Reader subpackage added to
2346   project, including preliminary versions of:
2348   - __init__.py
2349   - moduleparser.py: Parser for Python modules.
2351 * docutils/transforms/__init__.py:
2353   - Added ``Transformer`` class and completed transform reform.
2354   - Added unknown_reference_resolvers list for each transformer. This list holds
2355     the list of functions provided by each component of the transformer that
2356     help resolve references.
2358 * docutils/transforms/frontmatter.py:
2360   - Improved support for generic fields.
2361   - Fixed bibliographic field language lookups.
2363 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2364   transforms.
2366 * docutils/transforms/parts.py:
2368   - Moved the "id" attribute from TOC list items to the references
2369     (``Contents.build_contents()``).
2370   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2371   - Added "class" attribute support to ``Contents``.
2373 * docutils/transforms/peps.py:
2375   - Added ``mask_email()`` function, updating to pep2html.py's
2376     functionality.
2377   - Linked "Content-Type: text/x-rst" to PEP 12.
2378   - Added the ``TargetNotes`` PEP-specific transform.
2379   - Added ``TargetNotes.cleanup_callback``.
2380   - Added title check to ``Headers``.
2382 * docutils/transforms/references.py:
2384   - Added the ``TargetNotes`` generic transform.
2385   - Split ``Hyperlinks`` into multiple transforms.
2386   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2387   - Added check for circular indirect references.
2388   - Made substitutions case-sensitive-but-forgiving.
2390 * docutils/transforms/universal.py:
2392   - Added support for the "--expose-internal-attributes" option.
2393   - Removed ``Pending`` transform classes & data.
2395 * docutils/writers/__init__.py:
2397   - Removed ``Writer.transform()`` method.
2399 * docutils/writers/docutils-xml.py:
2401   - Added XML and doctype declarations.
2402   - Added "--no-doctype" and "--no-xml-declaration" options.
2404 * docutils/writers/html4css1.py:
2406   - "name" attributes only on these tags: a, applet, form, frame,
2407     iframe, img, map.
2408   - Added "name" attribute to <a> in section titles for Netscape 4
2409     support (bug report: Pearu Peterson).
2410   - Fixed targets (names) on footnote, citation, topic title,
2411     problematic, and system_message nodes (for Netscape 4).
2412   - Changed field names from "<td>" to "<th>".
2413   - Added "@" to "&#64;" encoding to thwart address harvesters.
2414   - Improved the vertical whitespace optimization; ignore "invisible"
2415     nodes (targets, comments, etc.).
2416   - Improved inline literals with ``<span class="pre">`` around chunks
2417     of text and ``&nbsp;`` for runs of spaces.
2418   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2419     ``self.docinfo`` segments.
2420   - Added support for "line_block", "address" elements.
2421   - Improved backlinks (footnotes & system_messages).
2422   - Improved system_message output.
2423   - Redefined "--stylesheet" as containing an invariant URL, used
2424     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2425     working directory.
2426   - Added "--footnote-references" option (superscript or brackets).
2427   - Added "--compact-lists" and "--no-compact-lists" options.
2428   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2429     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2430   - Improved field list rendering.
2431   - Added Docutils version to "generator" meta tag.
2432   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2433   - Improved layout of <pre> HTML source.
2434   - Fixed attribute typo on <colspec>.
2435   - Refined XML prologue.
2436   - Support for no stylesheet.
2437   - Removed "interpreted" element support.
2438   - Added support for "title_reference", "sidebar", "attribution",
2439     "rubric", and generic "admonition" elements.
2440   - Added "--attribution" option.
2441   - Added support for "inline", "subscript", "superscript" elements.
2442   - Added initial support for "abbreviation" and "acronym";
2443     incomplete.
2445 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2446   (from the sandbox).
2448   - Added french.
2449   - Double quotes in literal blocks (special treatment for de/ngerman).
2450   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2451   - Added  "--attribution" option.
2452   - Right align attributions.
2454 * docutils/writers/pep_html.py:
2456   - Parameterized output encoding in PEP template.
2457   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2458   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2459     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2460     working directory.
2461   - Added an override on the "--footnote-references" option.
2462   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2463   - Added Docutils version to "generator" meta tag.
2464   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2466 * docs/tools.txt:
2468   - Added a "silent" setting for ``buildhtml.py``.
2469   - Added a "Getting Help" section.
2470   - Rearranged the structure.
2471   - Kept up to date, with new settings, command-line options etc.
2472   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2473   - Converted settings table into a definition list.
2475 * docs/rst/quickstart.txt:
2477   - Added a table of contents.
2478   - Added feedback information.
2479   - Added mention of minimum section title underline lengths.
2480   - Removed the 4-character minimum for section title underlines.
2482 * docs/rst/quickref.html:
2484   - Added a "Getting Help" section.
2485   - Added a style to make section title backlinks more subtle.
2486   - Added mention of minimum section title underline lengths.
2487   - Removed the 4-character minimum for section title underlines.
2489 * extras: Directory added to project; contains third-party modules
2490   that Docutils depends on (optparse, textwrap, roman).  These are
2491   only installed if they're not already present.
2493 * licenses: Directory added to project; contains copies of license
2494   files for non-public-domain files.
2496 * spec/doctree.txt:
2498   - Changed the focus.  It's about DTD elements:  structural
2499     relationships, semantics, and external (public) attributes.  Not
2500     about the element class library.
2501   - Moved some implementation-specific stuff into ``docutils.nodes``
2502     docstrings.
2503   - Wrote descriptions of all common attributes and parameter
2504     entities.  Filled in introductory material.
2505   - Working through the element descriptions: 55 down, 37 to go.
2506   - Removed "Representation of Horizontal Rules" to
2507     spec/rst/alternatives.txt.
2509 * spec/docutils.dtd:
2511   - Added "generated" inline element.
2512   - Added "line_block" body element.
2513   - Added "auto" attribute to "title".
2514   - Changed content models of "literal_block" and "doctest_block" to
2515     ``%text.model``.
2516   - Added ``%number;`` attribute type parameter entity.
2517   - Changed ``%structural.elements;`` to ``%section.elements``.
2518   - Updated attribute types; made more specific.
2519   - Added "address" bibliographic element.
2520   - Added "line" attribute to ``system_message`` element.
2521   - Removed "field_argument" element; "field_name" may contain
2522     multiple words and whitespace.
2523   - Changed public identifier to docutils.sf.net.
2524   - Removed "interpreted" element; added "title_reference",
2525     "abbreviation", "acronym".
2526   - Removed "refuri" attribute from "footnote_reference" and
2527     "citation_reference".
2528   - Added "sidebar", "rubric", "attribution", "admonition",
2529     "superscript", "subscript", and "inline" elements.
2531 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2533 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2535 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2537 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2538   Dallas Mahrt.
2540 * spec/transforms.txt: Added to project.
2542 * spec/howto: Added subdirectory, for developer how-to docs.
2544 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2545   Elza, edited & extended by David Goodger.
2547 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2548   project.
2550 * spec/rst/alternatives.txt:
2552   - Added "Doctree Representation of Transitions" from
2553     spec/doctree.txt.
2554   - Updated "Inline External Targets" & closed the debate.
2555   - Added ideas for interpreted text syntax extensions.
2556   - Added "Nested Inline Markup" section.
2558 * spec/rst/directives.txt:
2560   - Added directives: "topic", "sectnum", "target-notes",
2561     "line-block", "parsed-literal", "include", "replace", "sidebar",
2562     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2563     "class".
2564   - Formalized descriptions of directive details.
2565   - Added an "align" attribute to the "image" & "figure" directives
2566     (by Adam Chodorowski).
2567   - Added "class" options to "topic", "sidebar", "line-block",
2568     "parsed-literal", "contents", and "image"; and "figclass" to
2569     "figure".
2571 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2572   interpreted text roles.
2574 * spec/rst/introduction.txt:
2576   - Added pointers to material for new users.
2578 * spec/rst/reStructuredText.txt:
2580   - Disambiguated comments (just add a newline after the "::").
2581   - Updated enumerated list description; added a discussion of the
2582     second-line validity checking.
2583   - Updated directive description.
2584   - Added a note redirecting newbies to the user docs.
2585   - Expanded description of inline markup start-strings in non-markup
2586     contexts.
2587   - Removed field arguments and made field lists a generic construct.
2588   - Removed the 4-character minimum for section title underlines.
2589   - Clarified term/classifier delimiter & inline markup ambiguity
2590     (definition lists).
2591   - Added "Embedded URIs".
2592   - Updated "Interpreted Text" section.
2593   - Added "Character-Level Inline Markup" section.
2595 * test: Continually adding & updating tests.
2597   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2598   - Moved test/test_pep/ to test/test_readers/test_pep/.
2599   - Added test/test_readers/test_python/.
2600   - Added test/test_writers/ (Engelbert Gruber).
2602 * tools:
2604   - Made the ``locale.setlocale()`` calls in front ends
2605     fault-tolerant.
2607 * tools/buildhtml.py:
2609   - Added "--silent" option.
2610   - Fixed bug with absolute paths & "--config".
2611   - Updated for new I/O classes.
2612   - Added some exception handling.
2613   - Separated publishers' setting defaults; prevents interference.
2614   - Updated for new ``publish_file()`` convenience function.
2616 * tools/pep-html-template:
2618   - Allow for "--embed-stylesheet".
2619   - Added Docutils version to "generator" meta tag.
2620   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2621   - Conform to XHTML spec.
2623 * tools/pep2html.py:
2625   - Made ``argv`` a parameter to ``main()``.
2626   - Added support for "Content-Type:" header & arbitrary PEP formats.
2627   - Linked "Content-Type: text/plain" to PEP 9.
2628   - Files skipped (due to an error) are not pushed onto the server.
2629   - Updated for new I/O classes.
2630   - Added ``check_requirements()`` & ``pep_type_error()``.
2631   - Added some exception handling.
2632   - Updated for new ``publish_string()`` convenience function.
2633   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2635 * tools/quicktest.py:
2637   - Added "-V"/"--version" option.
2639 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2641 * tools/unicode2rstsubs.py: Added to project.  Produces character
2642   entity files (reSructuredText substitutions) from the MathML master
2643   unicode.xml file.
2645 * tools/editors: Support code for editors, added to project.  Contains
2646   ``emacs/restructuredtext.el``.
2648 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2650   - Added style for chunks of inline literals.
2651   - Removed margin for first child of table cells.
2652   - Right-aligned field list names.
2653   - Support for auto-numbered section titles in TOCs.
2654   - Increased the size of inline literals (<tt>) in titles.
2655   - Restored the light gray background for inline literals.
2656   - Added support for "line_block" elements.
2657   - Added style for "address" elements.
2658   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2659   - Improved field list rendering.
2660   - Vertical whitespace improvements.
2661   - Removed "a.target" style.
2663 * tools/stylesheets/pep.css:
2665   - Fixed nested section margins.
2666   - Other changes parallel those of ``../default.css``.
2669 Release 0.2 (2002-07-31)
2670 ========================
2672 General:
2674 - The word "component" was being used ambiguously.  From now on,
2675   "component" will be used to mean "Docutils component", as in Reader,
2676   Writer, Parser, or Transform.  Portions of documents (Table of
2677   Contents, sections, etc.)  will be called "document parts".
2678 - Did a grand renaming: a lot of ``verylongnames`` became
2679   ``very_long_names``.
2680 - Cleaned up imports: no more relative package imports or
2681   comma-separated lists of top-level modules.
2682 - Added support for an option values object which carries default
2683   settings and overrides (from command-line options and library use).
2684 - Added internal Unicode support, and support for both input and
2685   output encodings.
2686 - Added support for the ``docutils.io.IO`` class & subclasses.
2688 Specific:
2690 * docutils/__init__.py:
2692   - Added ``ApplicationError`` and ``DataError``, for use throughout
2693     the package.
2694   - Added ``Component`` base class for Docutils components; implements
2695     the ``supports`` method.
2696   - Added ``__version__`` (thus, ``docutils.__version__``).
2698 * docutils/core.py:
2700   - Removed many keyword parameters to ``Publisher.__init__()`` and
2701     ``publish()``; bundled into an option values object.  Added
2702     "argv", "usage", "description", and "option_spec" parameters for
2703     command-line support.
2704   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2705     methods.
2706   - Reworked I/O model for ``docutils.io`` wrappers.
2707   - Updated ``Publisher.set_options()``; now returns option values
2708     object.
2709   - Added support for configuration files (/etc/docutils.conf,
2710     ./docutils.conf, ~/.docutils).
2711   - Added ``Publisher.setup_option_parser()``.
2712   - Added default usage message and description.
2714 * docutils/frontend.py: Added to project; support for front-end
2715   (command-line) scripts.  Option specifications may be augmented by
2716   components.  Requires Optik (http://optik.sf.net/) for option
2717   processing (installed locally as docutils/optik.py).
2719 * docutils/io.py: Added to project; uniform API for a variety of input
2720   output mechanisms.
2722 * docutils/nodes.py:
2724   - Added ``TreeCopyVisitor`` class.
2725   - Added a ``copy`` method to ``Node`` and subclasses.
2726   - Added a ``SkipDeparture`` exception for visitors.
2727   - Renamed ``TreePruningException`` from ``VisitorException``.
2728   - Added docstrings to ``TreePruningException``, subclasses, and
2729     ``Nodes.walk()``.
2730   - Improved docstrings.
2731   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2732   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2733     imports.
2734   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2735     ``PreDecorative`` mixin.
2736   - Reworked the name/id bookkeeping; to ``document``, removed
2737     ``explicit_targets`` and ``implicit_targets`` attributes, added
2738     ``nametypes`` attribute and ``set_name_id_map`` method.
2739   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2740     traversals.
2741   - Added ``document.has_name()`` method.
2742   - Fixed DOM generation for list-attributes.
2743   - Added category class ``Labeled`` (used by footnotes & citations).
2744   - Added ``Element.set_class()`` method (sets "class" attribute).
2746 * docutils/optik.py: Added to project.  Combined from the Optik
2747   package, with added option groups and other modifications.  The use
2748   of this module is probably only temporary.
2750 * docutils/statemachine.py:
2752   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2753   - Added underscores to improve many awkward names.
2754   - In ``string2lines()``, changed whitespace normalizing translation
2755     table to regexp; restores Python 2.0 compatibility with Unicode.
2757 * docutils/urischemes.py:
2759   - Filled in some descriptions.
2760   - Added "shttp" scheme.
2762 * docutils/utils.py:
2764   - Added ``clean_rcs_keywords`` function (moved from
2765     docutils/transforms/frontmatter.py
2766     ``DocInfo.filter_rcs_keywords``).
2767   - Added underscores to improve many awkward names.
2768   - Changed names of Reporter's thresholds:
2769     warning_level -> report_level; error_level -> halt_level.
2770   - Moved ``utils.id()`` to ``nodes.make_id()``.
2771   - Added ``relative_path(source, target)``.
2773 * docutils/languages/de.py: German mappings; added to project.  Thanks
2774   to Gunnar Schwant for the translations.
2776 * docutils/languages/en.py: Added "Dedication" bibliographic field
2777   mappings.
2779 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2780   Chodorowski.
2782 * docutils/parsers/rst/states.py:
2784   - Added underscores to improve many awkward names.
2785   - Added RFC-2822 header support.
2786   - Extracted the inline parsing code from ``RSTState`` to a separate
2787     class, ``Inliner``, which will allow easy subclassing.
2788   - Made local bindings for ``memo`` container & often-used contents
2789     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2790   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2791   - Added ``MarkupMismatch`` exception; for late corrections.
2792   - Added ``-/:`` characters to inline markup's start string prefix,
2793     ``/`` to end string suffix.
2794   - Fixed a footnote bug.
2795   - Fixed a bug with literal blocks.
2796   - Applied patch from Simon Budig: simplified regexps with symbolic
2797     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2798   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2799   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2800   - Allowed non-ASCII in "simple names" (directive names, field names,
2801     references, etc.).
2802   - Converted ``Inliner.patterns.initial`` to be dynamically built
2803     from parts with ``build_regexp()`` function.
2804   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2805   - Updated docstrings.
2806   - Changed "table" to "grid_table"; added "simple_table" support.
2808 * docutils/parsers/rst/tableparser.py:
2810   - Changed ``TableParser`` to ``GridTableParser``.
2811   - Added ``SimpleTableParser``.
2812   - Refactored naming.
2814 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2815   a fallback language for directive names.
2817 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2818   directive to use a ``pending`` element, used only by HTML writers.
2820 * docutils/parsers/rst/directives/parts.py: Renamed from
2821   components.py.
2823   - Added "backlinks" attribute to "contents" directive.
2825 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2826   project by Adam Chodorowski.
2828 * docutils/readers/__init__.py: Gave Readers more control over
2829   choosing and instantiating Parsers.
2831 * docutils/readers/pep.py: Added to project; for PEP processing.
2833 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2834   requires a ``component`` parameter.
2836 * docutils/transforms/components.py: Added to project; transforms
2837   related to Docutils components.
2839 * docutils/transforms/frontmatter.py:
2841   - In ``DocInfo.extract_authors``, check for a single "author" in an
2842     "authors" group, and convert it to a single "author" element.
2843   - Added support for "Dedication" and generic bibliographic fields.
2845 * docutils/transforms/peps.py: Added to project; PEP-specific.
2847 * docutils/transforms/parts.py: Renamed from old components.py.
2849   - Added filter for `Contents`, to use alt-text for inline images,
2850     and to remove inline markup that doesn't make sense in the ToC.
2851   - Added "name" attribute to TOC topic depending on its title.
2852   - Added support for optional TOC backlinks.
2854 * docutils/transforms/references.py: Fixed indirect target resolution
2855   in ``Hyperlinks`` transform.
2857 * docutils/transforms/universal.py:
2859   - Changed ``Messages`` transform to properly filter out system
2860     messages below the warning threshold.
2861   - Added ``Decorations`` transform (support for ``--generator``,
2862     ``--date``, ``--time``, ``--source-link`` options).
2864 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2865   Engelbert Gruber's PDF writer.
2867 * docutils/writers/html4css1.py:
2869   - Made XHTML-compatible (switched to lowercase element & attribute
2870     names; empty tag format).
2871   - Escape double-dashes in comment text.
2872   - Improved boilerplate & modularity of output.
2873   - Exposed modular output in Writer class.
2874   - Added a "generator" meta tag to <head>.
2875   - Added support for the ``--stylesheet`` option.
2876   - Added support for ``decoration``, ``header``, and ``footer``
2877     elements.
2878   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2879     translation table to regexp; restores Python 2.0 compatibility
2880     with Unicode.
2881   - Added the translator class as instance variable to the Writer, to
2882     make it easily subclassable.
2883   - Improved option list spacing (thanks to Richard Jones).
2884   - Modified field list output.
2885   - Added backlinks to footnotes & citations.
2886   - Added percentage widths to "<col>" tags (from colspec).
2887   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2888     "<span>" changed to "<var>".
2889   - Inline literals: "<code>" changed to "<tt>".
2890   - Many changes to optimize vertical space: compact simple lists etc.
2891   - Add a command-line options & directive attributes to control TOC
2892     and footnote/citation backlinks.
2893   - Added support for optional footnote/citation backlinks.
2894   - Added support for generic bibliographic fields.
2895   - Identify backrefs.
2896   - Relative URLs for stylesheet links.
2898 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2899   PEPs (subclass of ``html4css1.Writer``).
2901 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2903 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2904   of the Docutils internal doctree in XML.
2906 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2908 * spec/doctree.txt:
2910   - Changed the title to "The Docutils Document Tree".
2911   - Added "Hyperlink Bookkeeping" section.
2913 * spec/docutils.dtd:
2915   - Added ``decoration``, ``header``, and ``footer`` elements.
2916   - Brought ``interpreted`` element in line with the parser: changed
2917     attribute "type" to "role", added "position".
2918   - Added support for generic bibliographic fields.
2920 * spec/notes.txt: Continual updates.  Added "Project Policies".
2922 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2923   section.
2925 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2927 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2928   mailing list discussions.
2930 * spec/pep-0287.txt:
2932   - Renamed to "reStructuredText Docstring Format".
2933   - Minor edits.
2934   - Reworked Q&A as an enumerated list.
2935   - Converted to reStructuredText format.
2937 * spec/pysource.dtd:
2939   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2941 * spec/pysource.txt: Removed from project.  Moved much of its contents
2942   to pep-0258.txt.
2944 * spec/rst/alternatives.txt:
2946   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2947   - Added "Inline External Targets" section.
2949 * spec/rst/directives.txt:
2951   - Added "backlinks" attribute to "contents" directive.
2953 * spec/rst/problems.txt:
2955   - Updated the Enumerated List Markup discussion.
2956   - Added new alternative table markup syntaxes.
2958 * spec/rst/reStructuredText.txt:
2960   - Clarified field list usage.
2961   - Updated enumerated list description.
2962   - Clarified purpose of directives.
2963   - Added ``-/:`` characters to inline markup's start string prefix,
2964     ``/`` to end string suffix.
2965   - Updated "Authors" bibliographic field behavior.
2966   - Changed "inline hyperlink targets" to "inline internal targets".
2967   - Added "simple table" syntax to supplement the existing but
2968     newly-renamed "grid tables".
2969   - Added cautions for anonymous hyperlink use.
2970   - Added "Dedication" and generic bibliographic fields.
2972 * test: Made test modules standalone (subdirectories became packages).
2974 * test/DocutilsTestSupport.py:
2976   - Added support for PEP extensions to reStructuredText.
2977   - Added support for simple tables.
2978   - Refactored naming.
2980 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2982   - Now supports true packages containing test modules
2983     (``__init__.py`` files required); fixes duplicate module name bug.
2985 * test/test_pep/: Subpackage added to project; PEP testing.
2987 * test/test_rst/test_SimpleTableParser.py: Added to project.
2989 * tools:
2991   - Updated html.py and publish.py front-end tools to use the new
2992     command-line processing facilities of ``docutils.frontend``
2993     (exposed in ``docutils.core.Publisher``), reducing each to just a
2994     few lines of code.
2995   - Added ``locale.setlocale()`` calls to front-end tools.
2997 * tools/buildhtml.py: Added to project; batch-generates .html from all
2998   the .txt files in directories and subdirectories.
3000 * tools/default.css:
3002   - Added support for ``header`` and ``footer`` elements.
3003   - Added styles for "Dedication" topics (biblio fields).
3005 * tools/docutils.conf: A configuration file; added to project.
3007 * tools/docutils-xml.py: Added to project.
3009 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3011 * tools/pep-html-template: Added to project.
3013 * tools/pep2html.py: Added to project from Python (nondist/peps).
3014   Added support for Docutils (reStructuredText PEPs).
3016 * tools/quicktest.py:
3018   - Added the ``--attributes`` option, hacked a bit.
3019   - Added a second command-line argument (output file); cleaned up.
3021 * tools/stylesheets/: Subdirectory added to project.
3023 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3026 Release 0.1 (2002-04-20)
3027 ========================
3029 This is the first release of Docutils, merged from the now inactive
3030 reStructuredText__ and `Docstring Processing System`__ projects.  For
3031 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3032 `DPS HISTORY`__ files.
3034 __ http://structuredtext.sourceforge.net/
3035 __ http://docstring.sourceforge.net/
3036 __ http://structuredtext.sourceforge.net/HISTORY.html
3037 __ http://docstring.sourceforge.net/HISTORY.html
3039 General changes: renamed 'dps' package to 'docutils'; renamed
3040 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3041 the test suites (reStructuredText's test/test_states renamed to
3042 test/test_rst); and all modifications required to make it all work.
3044 * docutils/parsers/rst/states.py:
3046   - Improved diagnostic system messages for missing blank lines.
3047   - Fixed substitution_reference bug.
3051    Local Variables:
3052    mode: indented-text
3053    indent-tabs-mode: nil
3054    sentence-end-double-space: t
3055    fill-column: 70
3056    End: