XeTeX writer: Scale monotype font to match others.
[docutils.git] / HISTORY.txt
blob31df77cfd7848c78ee205202b4d0958192d2eb9f
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.10
17 ==================
19 * docutils/utils/__init__.py
21   - Fix [ 3596884 ] exception importing ``docutils.io``.
23 * docutils/writers/latex2e/__init__.py
25   - Drop the simple algorithm replacing straight double quotes with
26     English typographic ones. Use the SmartQuotes transform
27     (``--smart-quotes=True``) instead.
30 Release 0.10 (2012-12-16)
31 =========================
33 * General
35   - Dropped support for Python 2.3.
36   - ``docutils/math``, ``docutils/error_reporting.py``, and
37     ``docutils/urischemes.py`` moved to the utils package.
38   - Fix [3541369] Relative __import__ also with Python 3.3.
39   - Fix [3559988] and [3560841] __import__ local writer, reader, languages
40     and parsers for Python 2.7 up.
41   - Fix import of PIL.Image.
42   - Change default of "syntax highlight" option to "long",
43     basic syntax highlight styles for LaTeX and HTML.
45 * docutils/io.py
47   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
48     option is ignored and will be removed in a future release.
49   - Fix Py3k error writing to stdout with encoding differing from default.
50   - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
52 * docutils/parsers/rst/directives/misc.py
54   - Fix [ 3546533 ] Unicode error with `date` directive.
56 * docutils/transforms/universal.py
58   - SmartQuotes transform for typographic quotes and dashes.
60 * docutils/utils/__init__.py
62   - normalize_language_tag() now returns `BCP 47`_ conformant tags
63     with subtags separated by ``-``.
65 * docutils/writers/html4css1/__init__.py
67   - Use ``<code>`` tag for inline "code",
68     do not drop nested inline nodes (syntax highlight tokens).
69   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
70   - No line break after opening inline math tag.
72 * docutils/writers/manpage.py
74   - Apply [ 3527401 ] addmonition's don't preserve indentation
75   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
77 , docutils/writers/xetex/__init__.py
79   - Apply [ 3555160 ] ensure order of "otherlanguages".
80   - Fix section numbering by LaTeX.
82 * docutils/writers/s5_html/__init__.py
84   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
86 * docutils/writers/s5_html/docutils_xml.py
88   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
90 * setup.py
92   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
94 * tools/test/test_buildhtml.py
96   - Fix [ 3521167 ] allow running in any directory.
97   - Fix [ 3521168 ] allow running with Python 3.
100 Release 0.9.1 (2012-06-17)
101 ==========================
103 * setup.py
105   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
106     installed in the PYTHONPATH. Converted tests are now
107     stored in ``test3/``, tools no longer need conversion.
109     If you installed one of Docutils versions 0.7 ... 0.9 with
110     ``setup.py install`` under Python 3, remove the spurious
111     ``test/`` and ``tools/`` directories in the site library root.
113 * test/
115   - Make tests independent from the location of the ``test/`` directory.
116   - Use converted sources (from the ``build/`` directory) for tests under
117     Python 3.
119 * tools/
121   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
123 * docutils/io.py
125   - Fix writing binary data to sys.stdout under Python 3 (allows
126     ``rst2odt.py`` to be used with output redirection).
128 * docutils/parsers/rst/directives/misc.py
130   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
131     ``locale == C`` and 8-bit char in path argument of `include` directive.
133 * test/alltests.py
135   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
136     file under Python 3.
138 Release 0.9 (2012-05-02)
139 ========================
141 * General:
143   - New reStructuredText "code" role and directive and "code" option
144     of the "include" directive with syntax highlighting by Pygments_.
145   - Fix parse_option_marker for option arguments containing ``=``.
146   - Fix [ 2993756 ]: import Python Imaging Library's Image module
147     via ``import PIL`` as starting with PIL 1.2,
148     "PIL lives in the PIL namespace only" (announcement__).
150 .. _Pygments: http://pygments.org/
151 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
153 * setup.py
155   - Fix [ 2971827 ] and [ 3442827 ]
156     extras/roman.py moved to docutils/utils/roman.py
158 * docutils/frontend.py
160   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
162 * docutils/io.py
164   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
165   - `mode` argument for FileOutput avoids code replication in
166     BinaryFileOutput.
167   - New exceptions InputError and OutputError for IO errors in
168     FileInput/FileOutput.
170 * docutils/core.py:
172   - No "hard" system exit on file IO errors: catch and report them in
173     `Publisher.reportException` instead. Allows handling by a calling
174     application if the configuration setting `traceback` is True.
176 * docutils/utils.py -> docutils/utils/__init__.py
178   - docutils.utils is now a package (providing a place for sub-modules)
180   .. note:: docutils/math, docutils/error_reporting.py, and
181      docutils/urischemes.py will move to the utils package in the next
182      release, too. See RELEASE-NOTES__
184      __ RELEASE-NOTES.html
186   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
187     errors recording non-ASCII filenames (fixes [ 3434355 ]).
189   - Fix relative_path() with source=None and `unicode` target.
191 * docutils/parsers/rst/states.py
193   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
194     characters and "international" quotes around inline markup.
195   - Use `field_marker` pattern to look for start of a
196     directive option block (fixes [ 3484857 ]).
198 * docutils/parsers/rst/tableparser.py
200   - Fix [ 2926161 ] for simple tables.
201     (Combining chars in grid tables still contribute to cell width.)
203 * docutils/writers/latex2e/__init__.py
205   - Support the `abbreviation` and `acronym` standard roles.
206   - Record only files required to generate the LaTeX source as dependencies.
207   - Fix handling of missing stylesheets.
208   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
209     when suppressing LaTeX section numbering.
210   - Use ``\DUtitle`` for unsupported section levels
211   - Apply [ 3512791 ] do not compare string literals with "is"
213 * docutils/writers/xetex/__init__.py
215   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
217 * docutils/writers/html4css1/__init__.py
219   - Change default for `math-output` setting to MathJax.
220   - Fix handling of missing stylesheets.
222 * docutils/writers/docutils_xml.py
224   - Use the visitor pattern with default_visit()/default_depart() methods
225     instead of minidom to facilitate special handling of selected nodes.
226   - Support raw XML (inserted as-is inside a <raw></raw> node).
228 * docutils/writers/manpage.py
230   - Do not emit comment line with trailing blank. Problematic for VCS.
232 Release 0.8.1 (2011-08-30)
233 ==========================
235 * General:
237   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
238     and [ 3395920 ] (correct copyright info for rst.el).
240 * test/
242   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
244 * docutils/writers/latex2e/__init__.py
246   - Clean up Babel language setting. Restores Sphinx compatibility.
248 Release 0.8 (2011-07-07)
249 ========================
251 * General:
253   - Handle language codes according to `BCP 47`_.
254   - If the specified language is not supported by Docutils,
255     warn and fall back to English.
256   - Math support: reStructuredText "math" role and directive,
257     ``math`` and ``math_block`` doctree elements.
258   - Decode command line arguments with the locale's preferred encoding
259     (to allow, e.g., ``--title=Dornröschen``).
260   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
261   - New sub-module `error_reporting`: handle encoding/decoding errors
262     when reporting exceptions.
263   - Some additions to the Docutils core are released under the 2-Clause BSD
264     license, see COPYING_ for details.
266   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
267   .. _COPYING: COPYING.html
269 * reStructuredText:
271   - Most directives now support a "name" option that attaches a
272     reference name.
274   - Directive content may start on the first line also when the directive
275     type accepts options.
277 * docs/dev/policies.txt:
279   - Recommend the 2-Clause BSD license
280     (http://www.spdx.org/licenses/BSD-2-Clause)
281     for code that is kept under the author's copyright.
283 * tools/buildhtml.py:
285   - Fix ``--local`` switch.
287 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
289 * docutils/writers/html4css1/__init__.py
291   - Set "lang" argument for objects with class argument
292     "language-<language tag>".
293   - New setting "math-output" with support for HTML, MathML, and LaTeX.
295 * docutils/writers/latex2e/__init__.py
297   - Fix [ 3043986 ] AttributeError using :local: with table of content.
298   - Place title data in the document preamble.
299   - Load `babel` package only if required.
300   - Update list of supported languages.
301   - New config setting "hyperref-options".
302     No hard-coded "unicode" hyperref option (clash with xetex).
303   - Set language for custom roles, paragraphs, block-quotes, and
304     line-quotes with class argument "language-<language tag>".
305   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
306   - Convert image URI to a local file path.
307   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
308     has more than one paragraph (Wolfgang Scherer).
309   - \leavevmode before longtable only when needed (prevents spurious vspace)
310   - do not advance table counter for tables without caption
312 * docutils/writers/xetex/__init__.py
314   - New writer generating LaTeX code for compiling with ``xelatex``.
316     A separate writer (inheriting from latex2e) instead of a ``--xetex``
317     option allows separate config options for XeTeX vs. LaTeX2e.
319 * docutils/writers/manpage.py
321   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
322   - Fix: vertical space cleaning for option group ``.``.
324 * tools/editors/emacs/rst.el:
326   - Fix [ 3001100 ] does not handle spaces in filenames
327     (thanks to Jakub Wilk)
329 * docutils/utils.py:
331   - strip whitespace from stylesheet arguments
332   - exclude combining chars from column_width()
333     (partial fix for [ 2926161 ])
335 * docutils/parsers/rst/directives/misc.py:
337   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
338     nested_parse
340 * docutils/io.py:
342   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
343     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
345 Release 0.7 (2010-07-07)
346 ========================
348 * General:
350   - Fix [ 2881769 ] setup configuration.
351   - Fix [ 2788716 ] reporting problems in included files.
353 * docutils/io.py
355   - FileInput opens files as text files with universal newline support
356     (mode "rU", configurable with the new optional argument "mode").
358 * docutils/nodes.py
360   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
362 * docutils/utils.py
364   - Fix [ 2923723 ] let decode_path() tolerate path == None
366 * docutils/writers/html4css1/__init__.py
368   - Support SVG and SWF images (thanks to Stefan Rank).
369   - Generate valid XHTML for centered images with targets.
370     Use CSS classes instead of "align" tags for image alignment.
372 * docutils/writers/latex2e/__init__.py
374   - Use `transforms.writer_aux.Admonitions` to "normalize" special
375     admonitions.
376   - Use the ``\url`` command for URLs (breaks long URLs instead of
377     writing into the margin).
378   - Preserve runs of spaces in `inline literals`__.
379   - Deprecate ``figure_footnotes`` setting.
380   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
381   - New ``latex_preamble`` setting.
382   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
383   - Fix hyperlink targets (labels) for images, figures, and tables.
384   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
385   - Apply [ 2961991 ] Call hyperref with unicode option.
386   - Drop the special `output_encoding`__ default ("latin-1").
387     The Docutils wide default (usually "UTF-8") is used instead.
388   - Render inline markup in document title and subtitle.
389   - Fix numbering depth with LaTeX section numbering.
390   - Update Unicode -> LaTeX translations.
391   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
393 __ docs/ref/restructuredtext.html#inline-literals
394 __ docs/user/config.html#docutils-footnotes
395 __ docs/user/config.html#output_encoding
397 * docutils/writers/manpage.py
399   - Fix: supported attribute (thanks to peter2108).
400   - Remove trailing blanks in code (keep in sync with mercurial version).
401   - Titles level 1, that is ``.SH``, always uppercase.
402   - Apply patch from mg: literal text should be bold in man-pages.
404 * docutils/nodes.py
406   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
407     turkish locale.
409 * setup.py:
411   - Python 3 support: copy test/ and tools/ to the build-dir
412     and convert Python sources with 2to3.
415 Release 0.6 (2009-10-11)
416 ========================
418 * General:
420   - Docutils is now compatible with Python versions from 2.3 up to 2.6
421     and convertible to 3.1 code.
423     + Node.__nonzero__ returns True instead of 1.
424     + use os.walk instead os.path.walk.
425     + minimize "types" module where possible.
426     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
427     + Text nodes now subclass unicode rather than UserString
428       (which is gone in python 3.0).
429     + 3.0 compatibility module docutils._compat
431     + Drop 2.2 compatibility workarounds.
432     + Drop extras/optparse.py and extras/textwrap.py
433       (stdlib modules since 2.3).
435   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
436   - Unix man page export: manpage writer moved from sandbox to Doctutils
437     core.
439   - Apply [ 1719345 ] Galician translation
440   - Apply [ 1905741 ] Polish translation
441   - Apply [ 1878977 ] make_id(): deaccent characters.
442   - Apply [ 2029251 ] return nonzero when tests fail.
443   - Fix [ 1692788 ] allow UTF-8 in style sheets.
444   - Fix [ 2781629 ] support non-ASCII chars in file names.
445   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
446   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
447   - Fix [ 2821266 ] --strict option works now like --halt=info.
448   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
449   - Fix [ 1627229 ] hyperlink references in substitutions.
451   - The "newlatex" writer is orphaned.
453 * reStructuredText:
455   - Documented Unicode characters allowed as inline markup openers,
456     closers, and delimiters.
457   - Allow units for all length specifications.
458   - Allow percent sign in "scale" argument of "figure" and "image" directives.
459   - Bugfix: The "figalign" argument of a figure now works as intended
460     (aligning the figure, not its contents).
461   - Align images with class "align-[right|center|left]"
462     (allows setting the alignment of an image in a figure).
464 * docutils/nodes.py:
466   - Added ``Element.__contains__`` method, for the in-operator.
468 * docutils/parsers/rst/states.py:
470   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
471   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
472     " " (non-breaking space), and "¡ ¿" openers.
474 * docutils/parsers/directives/misc.py:
476   - Added ``start-line`` and ``end-line`` options to "include"
477     directive to select a range of lines.
478   - Hard tabs in literal inclusions are replaced by spaces. This is
479     configurable via the new ``tab-width`` option of the "include" directive
480     (a negative tab-width prevents tab expansion).
482 * docutils/utils.py:
484   - Add ``get_stylesheet_list`` function.
485   - Apply [ 2834836 ] print info at halt
487 * docutils/transforms/universal.py:
489   - Raise default priority of StripClasses to exclude stripped classes from
490     the ToC.
492 * docutils/writers/html4css1/__init__.py:
494   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
495     separated list of stylesheets.
496   - Address [ 1938891 ] Inline literal text creates "pre" span only when
497     needed to prevent inter-word line wraps.
498   - Use `translate` method instead of repeated `replace` calls.
499   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
500     classes to allow CSS styling that does not interfere with other
501     table-using constructs (field lists, citations, ...).
503 * docutils/writers/newlatex2e/__init__.py:
505   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
507 * docutils/writers/latex2e/__init__.py (see also
508   `<docs/user/docutils-05-compat.sty.html>`__) :
510   - Add ``--embed-stylesheet`` option.
511   - Apply [ 1474017 ] image vertical alignment is reversed.
512   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
513   - Change: has_key for dictionaries (not Nodes) to in-operator.
514   - Merge adjacent citations into one latex cite command.
515   - Failsave implementation of custom roles. LaTeX compilation now ignores
516     unknown classes instead of aborting with an error.
517   - Support custom roles based on standard roles.
518   - LaTeX packages can be used as ``--stylesheet`` arguments without
519     restriction. (A style sheet is now referenced with the ``\usepackage``
520     command, if it ends with ``.sty`` or has no extension.)
521   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
522   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
523   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
524     2005-02-04 as a configurable length unit).
525   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
526     if font-encoding is set to ''. LaTeX defaults to OT1 then.
527   - Set sub- and superscript role argument in text mode not as math.
528     Use a custom role based on sub-/superscript if you want italic shape.
529   - Shorter preamble and less dependencies: Load packages and define macros
530     only if required in the document.
531   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
532   - New custom environments and commands with optional "classes" argument.
533   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
534   - Better conformance to Docutils specifications with ``--use-latex-toc``.
535     Support for LaTeX generated ToC also with unnumbered sections.
536   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
537     section numbering by LaTeX.
538   - Use default font in admonitions and sidebar.
539   - Align of image in a figure defaults to 'center'.
540   - Bugfix: Newlines around targets and references prevent run-together
541     paragraphs.
542   - Fix internal hyperlinks.
543   - Use class defaults for page margins ('typearea' now optional).
544   - Float placement made configurable, default changed to "here definitely".
545   - Typeset generic topic as "quote block with title".
546   - Use template (file and configuration option).
547   - In the default template, load cmap.sty (fix text extraction in PDF) and
548     fixltx2e.sty (LaTeX patches, \textsubscript).
549   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
550   - Use `translate` instead of repeated `replace` calls for text encoding.
551   - Hyperlinked footnotes and support for symbol footnotes and
552     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
553   - Complete pairs of binary options
554     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
555     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
556   - New defaults:
557     - font-encoding: "T1" (formerly implicitely set by 'ae').
558     - use-latex-toc: true (ToC with page numbers).
559     - use-latex-footnotes: true (no mixup with figures).
561 * docutils/writers/manpage.py
563   - Do not print version at document end, this is done by the viewer.
564   - Do not print date at document end, this is done by the viewer.
565   - Fix storage of docinfo fields for none standard fields.
567 * docutils/tools/rst2man.py
569 Release 0.5 (2008-06-25)
570 ========================
572 * docutils/languages/he.py: Added to project: Hebrew mappings by
573   Meir Kriheli.
575 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
576   mappings by Meir Kriheli.
578 * docutils/frontend.py:
580   - Configuration files are now assumed and required to be
581     UTF-8-encoded.
582   - Paths of applied configuration files are now recorded in the
583     runtime setting ``_config_files`` (accessible via
584     ``--dump-settings``).
585   - Added ``--strip-elements-with-class`` and ``--strip-class``
586     options (``strip_elements_with_classes`` and ``strip_classes``
587     settings).
589 * docutils/io.py:
591   - Added code to determine the input encoding from data: encoding
592     declarations or the presence of byte order marks (UTF-8 & UTF-16).
593   - Added support for IronPython 1.0.
595 * docutils/nodes.py:
597   - Added ``document.__getstate__`` method, for pickling.
599 * docutils/parsers/rst/states.py:
601   - Allow ``+`` and ``:`` in reference names.
602   - Unquoted targets beginning with an underscore (``.. __target:
603     URI``) are no longer accepted.
604   - Added support for multiple attributions in a physical block quote
605     (indented text block), dividing it into multiple logical block
606     quotes.
607   - Added support for unicode bullets in bullet lists: "•", "‣", and
608     "⁃".
609   - Added support for new object-oriented directive interface,
610     retaining compatibility to the old functional interface.
611   - Added support for throwing ``DirectiveError``'s from within
612     directive code.
614 * docutils/parsers/rst/__init__.py:
616   - Added ``Directive`` base class.
617   - Added ``DirectiveError`` base class.
618   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
619     definitions.
621 * docutils/parsers/directives/:
623   - Refactored all reStructuredText directives to use the new
624     object-oriented directive interface.  Errors are now (mostly)
625     thrown using the new ``DirectiveError`` class.
627 * docutils/parsers/directives/misc.py:
629   - Added ``start-after`` and ``end-before`` options to ``include``
630     directive; thanks to Stefan Rank.
632 * docutils/transforms/universal.py:
634   - Added ``StripClassesAndElements`` transform to remove from the
635     document tree all elements with classes in
636     ``settings.strip_elements_with_classes`` and all "classes"
637     attribute values in ``self.document.settings.strip_classes``.
639 * docutils/transforms/writer_aux.py:
641   - Added ``Admonitions`` transform to transform specific admonitions
642     (like ``note``, ``warning``, etc.) into generic admonitions with a
643     localized title.
645 * docutils/writers/html4css1/__init__.py:
647   - Moved template functionality from the PEP/HTML writer here.
648   - Expanded the fragments available in the ``parts`` attribute.
649   - Moved ``id`` attributes from titles to surrounding ``div``
650     elements.
651   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
652     universally supported now).
653   - ``template.txt`` is now opened in text mode instead of binary mode
654     (to ensure Windows compatibility).
655   - ``a`` elements now have an "internal" or "external" class,
656     depending on reference type.
658 * docutils/writers/html4css1/template.txt: Added to project.
660 * docutils/writers/pep_html/:
662   - Moved template functionality to the HTML writer.
664 * docutils/writers/s5_html/__init__.py:
666   - Added ``view_mode`` & ``hidden_controls`` settings
667     (``--view-mode`` & ``--hidden-controls/--visible-controls``
668     options).
670 * docutils/writers/latex2e/__init__.py:
672   - Add ``--literal-block-env``
673   - Fix: escaping ``%`` in href urls.
674   - Move usepackage hyperref after stylesheet inclusion.
675   - Fix: scrartcl does not have chapter but scrreprt.
676   - Add newline after ``\end{verbatim}``.
677   - Merge smaller differences from latex2e_adaptive_preamble.
678   - Add ``use-part-section``.
679   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
680   - Using leavemode option_list no longer needs to check if parent
681     is a definition list.
682   - Append ``\leavemode`` to definition list terms.
683   - No longer write visit\_/depart_definition_list_item comments to
684     output.
685   - Table column width with 3 decimal places.
686   - Add table stubs support (boldfont).
687   - Add assemble_parts to writer.
688   - Add simply support for nested tables.
689   - Fix verbatim in tables if use-verbatim-when-possible.
690   - Use section commands down to subparagraph.
691   - Put ensuremath around some latin1 chars.
692   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
693   - New option ``--use-bibtex=style,db1,db2``.
694   - New option ``--reference-label`` to allow usage of LaTeX ref for
695     labels in section references.
696   - Add a label after every section to support sectionnumbers as reference
697     labels.
698   - Fix: bug# 1605376 rst2latex: bad options group list
699   - Remove inactive code for use_optionlist_for_option_list.
700   - Remove latex comments from option_list output.
701   - Fix: bug# 1612270 double qoutes in italian literal.
702   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
703   - Add option --use-latex-abstract.
704   - Image width unit ``px`` is translated to ``pt``.
705   - Add image height support.
706   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
707     bug #1457388
708   - Fix: Do not escape underscores in citation reference labels if
709     use-latex-citations is set.
710   - Use centering instead of center for figure contents, to avoid vertical
711     space.
712   - Recognize table class: borderless, nolines, booktabs, standard.
713   - Fix: Renaming contents section does not work with latex writer; SF
714     bug #1487405.
715   - Applied patch for custom roles with classes from Edward Loper.
716   - Fixed bug that caused crashes with more than 256 lists.
718 * docutils/writers/pep_html/__init__.py:
720   - Changed to support new python.org website structure and
721     pep2pyramid.py.
723 * docs/howto/security.txt: "Deploying Docutils Securely", added to
724   project.
726 * tools/buildhtml.py:
728   -- Added ``ignore`` setting to exclude a list of shell patterns
729      (default: ``.svn:CVS``).
731 * tools/editors/emacs/rst.el:
733   - Changed license to "GPL".
734   - Added ``rst-straighten-decorations`` function.
735   - The ``compile`` module is now always loaded.
736   - Added ``rst-toggle-line-block`` function.
737   - Headings consisting only of non-ASCII characters are now
738     recognized by ``rst-toc`` and ``rst-adjust``.
739   - Added font-lock support for multi-line comments where the first
740     comment line is empty.
741   - Added ``(require 'font-lock)``.
743 * setup.py:
745   - Provide descriptive error message if distutils is missing.
748 Release 0.4 (2006-01-09)
749 ========================
751 * General:
753   - Updated the project policies for trunk/branch development &
754     version numbering.
756 * docutils/__init__.py:
758   - Added ``__version_details__`` attribute to describe code source
759     (repository/snapshot/release).
760   - Replaced ``default_transforms`` attribute of TransformSpec with
761     ``get_transforms()`` method.
763 * docutils/core.py:
765   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
766     functions, for document tree extraction and reprocessing.
768 * docutils/io.py:
770   - Added ``DocTreeInput`` class, for reprocessing existing documents.
771   - Added support for non-Unicode (e.g. binary) writer output.
773 * docutils/nodes.py:
775   - Re-introduced ``Targetable.indirect_reference_name``, for
776     MoinMoin/reST compatibility (removed in r3124/r3129).
777   - Added ``serial_escape`` function; escapes string values that are
778     elements of a list, for serialization.  Modified Docutils-XML
779     writing (``Element._dom_node``) and pseudo-XML writing
780     (``Element.starttag``) to use ``serial_escape``.
781   - Added ``Node.deepcopy()`` method.
782   - Removed the internal lists ``document.substitution_refs``,
783     ``document.anonymous_refs``, and ``document.anonymous_targets``.
784   - Added a "container" element.
785   - Fixed bug where values of list-valued attributes of elements
786     originating from custom interpreted text roles (i.e., with custom
787     classes) were being shared between element instances.  Reported by
788     Shmuel Zeigerman.
790 * docutils/statemachine.py:
792   - Added trailing whitespace stripping to ``string2lines()``.
793   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
794     Asian double-width character support.
796 * docutils/utils.py:
798   - Added ``east_asian_column_width()`` for double-width character
799     support.
801 * docutils/languages/ja.py: Added to project: Japanese mappings by
802   Hisashi Morita.
804 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
805   mappings by Panjunyong.
807 * docutils/parsers/null.py: Added to project; a do-nothing parser.
809 * docutils/parsers/rst/__init__.py:
811   - Added validator to tab_width setting, with test.  Closes SF bug
812     #1212515, report from Wu Wei.
814 * docutils/parsers/rst/states.py:
816   - Fixed bug with escaped colons indicating a literal block.
817   - Fixed bug with enumerated lists (SF#1254145).
818   - Backslash-escaped colons inside of field names are now allowed.
819   - Targets (implicit and explicit), anonymous hyperlink references
820     and auto-numbered footnote references inside of substitution
821     definitions are now disallowed.
822   - Fixed bug: list items with blank first lines.
823   - Fixed bug: block quote attributions with indented second lines.
824   - Added East Asian double-width character support (Python 2.4 only).
826 * docutils/parsers/rst/tableparser.py:
828   - Added East Asian double-width character support (Python 2.4 only).
830 * docutils/parsers/rst/directives/body.py:
832   - Added the "container" directive.
834 * docutils/parsers/rst/directives/misc.py:
836   - Added the "default-role", "title", and "date" directives.
837   - Added standard data file syntax to the "include" directive.
838   - Added support for "class" directive content.
840 * docutils/parsers/rst/directives/images.py:
842   - Added ``indirect_reference_name`` support for images with a target
843     option.
844   - Added support for image width and height units.
845   - Fixed bug with image "target" options.
847 * docutils/parsers/rst/directives/references.py:
849   - Added "class" attribute to "target-notes" directive, for
850     footnote_reference classes.
852 * docutils/parsers/rst/include/: Directory added to project; contains
853   standard data files for the "include" directive.  Initial contents:
854   character entity substitution definition sets, and a set of
855   definitions for S5/HTML presentations.
857 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
858   mappings by David Goodger.
860 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
861   Simplified Chinese mappings by Panjunyong.
863 * docutils/readers/__init__.py:
865   - Added universal.Decorations and universal.ExposeInternals
866     transforms as default transforms for all readers.
867   - Added ``ReReader`` base class for readers that reread an existing
868     document tree.
870 * docutils/readers/doctree.py: Added to project; a reader for existing
871   document trees.
873 * docutils/transforms/frontmatter.py:
875   - Fixed the DocInfo transform to handle SVN-style expansion of the
876     "Date" keyword.
877   - In ``DocInfo.extract_authors``, treat the contents of "authors"
878     fields uniformly.
880 * docutils/transforms/misc.py:
882   - Added misc.Transitions transform, extracted from
883     universal.FinalChecks.
885 * docutils/transforms/references.py:
887   - Added references.DanglingReferences transform, extracted from
888     universal.FinalChecks.
889   - Fixed bug with doubly-indirect substitutions.
890   - Added footnote_reference classes attribute to "TargetNotes".
891   - Fixed bug with circular substitution definitions that put Docutils
892     into an infinite loop.
894 * docutils/transforms/universal.py:
896   - Added universal.ExposeInternals transform, extracted from
897     universal.FinalChecks.
898   - Removed universal.FinalChecks transform (logic has been moved to
899     several new transforms).
900   - Fixed bug with the "expose_internals" setting and Text nodes
901     (exposed by the "rawsource" internal attribute).
902   - Added the universal.StripComments transform, implementation of the
903     "strip_comments" setting.
905 * docutils/transforms/writer_aux.py: Added to project; auxiliary
906   transforms for writers.
908   - Added ``Compound`` transform, which flattens compound paragraphs.
910 * docutils/writers/: Several writer modules (html4css1.py) were
911   converted into packages.  Support modules and data files have been
912   moved into the packages.  The stylesheets for the HTML writers are
913   now installed along with the code, the code knows where to find
914   them, and the default is to use them (actually, to embed them).
915   Some adjustments to configuration files may be necessary.  The
916   easiest way to obtain the new default behavior is to remove all
917   settings whose name includes "stylesheet".
919 * docutils/writers/__init__.py:
921   - Added universal.Messages and universal.FilterMessages transforms
922     as default transforms for all writers.
923   - Added ``UnfilteredWriter`` base class for writers that pass the
924     document tree on unchanged.
926 * docutils/writers/docutils_xml.py:
928   - Made ``xmlcharrefreplace`` the default output encoding error
929     handler.
931 * docutils/writers/html4css1/:
933   - Added support for image width and height units.
934   - Made ``xmlcharrefreplace`` the default output encoding error
935     handler.
936   - Made ``--embed-stylesheet`` the default rather than
937     ``--link-stylesheet``.
938   - Moved "id" attribute from container (section etc.) to title's <a>
939     tag, to be on the same tag as "name".
940     (!!! To be reverted in Docutils 0.5.)
941   - Added vertical space between fields of field lists.
942   - Added ``--compact-field-lists`` option to remove vertical space in
943     simple field lists.
944   - Made cloaking of email addresses with ``--cloak-email-addresses``
945     less obtrusive.
946   - Fixed support for centered images.
947   - Added support for class="compact" & class="open" lists.
949 * docutils/writers/latex2e/:
951   - Underscores in citekeys are no longer escaped.
953 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
954   mapping of Unicode characters to LaTeX equivalents.
956 * docutils/writers/s5_html/: Package added to project; writer for
957   S5/HTML slide shows.
959 * docs/dev/distributing.txt: Added to project; guide for distributors
960   (package maintainers).
962 * docs/dev/hacking.txt: Added to project; guide for developers.
964 * docs/ref/doctree.txt:
966   - Updated for plural attributes "classes", "ids", "names",
967     "dupnames".
968   - Added the "container" element.
970 * docs/ref/docutils.dtd:
972   - Updated for plural attributes "classes", "ids", "names",
973     "dupnames".
975 * docs/user/emacs.txt: Added to project; a document about Emacs
976   support for reStructuredText and Docutils.
978 * docs/user/links.txt: Added to project; lists of Docutils-related
979   links.
981 * docs/user/mailing-lists.txt: Added to project; information about
982   Docutils-related mailing lists and how to access them.
984 * docs/user/slide-shows.txt: Added to project; example of and docs for
985   the S5/HTML writer (``rst2s5.py`` front end).
987 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
988   Files", added to project.
990 * test/coverage.sh: Added to project; test coverage script.
992 * test/DocutilsTestSupport.py:
994   - Added support for specifying runtime settings at the suite level.
996 * test/test_functional.py:
998   - Added the ``clear_output_directory`` function.
999   - Added support for ``_test_more`` functions in functional test
1000     config files.
1002 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1004 * tools/rstpep2html.py: Renamed from pep.py.
1006 * tools/dev/create_unimap.py: Added to project; script to create the
1007   docutils/writers/unimap_latex.py mapping file.
1009 * tools/dev/profile_docutils.py: Added to project; profiler script.
1011 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1013 * tools/editors/emacs/restructuredtext.el,
1014   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1015   Removed from project; the functionality is now contained in rst.el.
1017 * tools/editors/emacs/rst.el: Added to project.  Added many features
1018   and fixed many bugs.  See docs/user/emacs.txt for details.
1020 * tools/stylesheets: Removed from project.  Stylesheets have been
1021   renamed and moved into writer packages.
1024 Release 0.3.9 (2005-05-26)
1025 ==========================
1027 * General:
1029   - Eliminated and replaced all uses of the old string attributes
1030     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1031     new list attributes ``ids``, ``names``, ``dupnames`` and
1032     ``classes`` throughout the whole source tree.
1034 * docutils/core.py:
1036   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1037     allowing for easier debugging.
1038   - In ``Publisher.publish()``, expanded the generic top-level
1039     exception catching.
1041 * docutils/examples.py:
1043   - Added ``internals`` function for exploration.
1045 * docutils/io.py:
1047   - Fixed ``Input.decode`` method to apply heuristics only if no
1048     encoding is explicitly given, and to provide better reporting of
1049     decoding errors.
1050   - The ``Input.decode`` method now removes byte order marks (BOMs)
1051     from input streams.
1053 * docutils/nodes.py:
1055   - ``image`` element class changed to subclass of Element, not
1056     TextElement (it's an empty element, and cannot contain text).
1057   - Added ``attr_defaults`` dictionary for default attribute values.
1058   - Added empty list as default value for the following attributes:
1059     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1060   - Added ``document.decoration`` attribute,
1061     ``document.get_decoration`` method, and ``decoration.get_header``
1062     & ``.get_footer`` methods.
1063   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1064     methods.
1066 * docutils/utils.py:
1068   - Removed ``docutils.utils.Reporter.categories``,
1069     ``docutils.utils.ConditionSet``, and all references to them, to
1070     simplify error reporting.
1072 * docutils/languages/nl.py: Added to project; Dutch mappings by
1073   Martijn Pieters.
1075 * docutils/parsers/rst/__init__.py:
1077   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1079 * docutils/parsers/rst/states.py:
1081   - Added check for escaped at-mark to prevent email address recognition.
1082   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1083     arguments>``.
1084   - Allowed whitespace in paths and URLs.
1085   - Added auto-enumerated list items.
1086   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1087     followed by text.
1088   - Added support for table stub columns.
1090 * docutils/parsers/rst/directives/__init__.py:
1092   - Allowed whitespace in paths (``path`` function).
1093   - Added ``uri`` directive option conversion function.
1095 * docutils/parsers/rst/directives/body.py:
1097   - Fixed illegal context bug with "topic" directive (allowed within
1098     sidebars; not within body elements).
1100 * docutils/parsers/rst/directives/images.py:
1102   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1103   - Added support for the ``file_insertion_enabled`` setting in the
1104     "figure" directive (disables "figwidth" option).
1105   - "image" directive: added checks for valid values of "align" option,
1106     depending on context.  "figure" directive: added specialized
1107     "align" option and attribute on "figure" element.
1108   - Made ":figwidth: image" option of "figure" directive work again.
1109   - Fixed bug with reference names containing uppercase letters
1110     (e.g. ``Name_``) in "target" option of "image" directive.
1112 * docutils/parsers/rst/directives/misc.py:
1114   - Fixed "include" and "raw" directives to catch text decoding
1115     errors.
1116   - Allowed whitespace in "include" & "raw" directive paths.
1117   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1118     settings in "include" & "raw" directives.
1120 * docutils/parsers/rst/directives/parts.py:
1122   - Added "header" & "footer" directives.
1123   - Fixed illegal context bug with "contents" directive (topics
1124     allowed within sidebars; not within body elements).
1126 * docutils/parsers/rst/directives/tables.py:
1128   - Added "list-table" directive.
1129   - Caught empty CSV table bug.
1130   - Added support for the ``file_insertion_enabled`` setting in the
1131     "csv-table" directive.
1132   - Added ``stub-columns`` option to "csv-table" and "list-table"
1133     directives.
1135 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1136   mappings by Martijn Pieters.
1138 * docutils/readers/standalone.py:
1140   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1141     options to activate or deactivate the SectSubTitle transform.
1143 * docutils/transforms/frontmatter.py:
1145   - Added SectSubTitle transform to promote titles of lone
1146     subsections to subtitles.
1148 * docutils/transforms/references.py:
1150   - Fixed mislocated internal targets bug, by propagating internal
1151     targets to the next node, making use of the newly added support
1152     for multiple names and IDs.
1153   - Fixed duplicate footnote label bug.
1154   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1155     transform.
1157 * docutils/writers/html4css1.py:
1159   - Fixed unencoded stylesheet reference bug (characters like "&" in
1160     stylesheet references).
1161   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1162     tags).
1163   - Added support for multiple IDs per node by creating empty ``span``
1164     tags.
1165   - Added the ``field_name_limit`` & ``option_limit`` settings &
1166     support.
1167   - Added support for table stub columns.
1168   - Added support for the ``align`` attribute on ``figure`` elements.
1169   - Added the ``cloak_email_addresses`` setting & support.
1170   - Added ``html_prolog``, ``html_head``, ``html_body``,
1171     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1172     ``docutils.core.publish_parts``.
1173   - Added support for section subtitles.
1175 * docutils/writers/latex2e.py:
1177   - Fixed tables starting with more than one multirow cell.
1178   - Improved --use-latex-docinfo so that organization/contact/address
1179     fields are lumped with the last author field and appear on the
1180     titlepage.
1181   - Made sure the titlepage is always shown with --use-latex-docinfo,
1182     even if the document has no title.
1183   - Made sure that latex doesn't fill in today's date if no date field
1184     was given.
1185   - Added support for section subtitles.
1187 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1188   (under development).
1190 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1192 * docs/api/publisher.txt:
1194   - Added "``publish_parts`` Details" section.
1196 * docutils/dev/repository.txt: Added to project; information about the
1197   Docutils Subversion repository.
1199 * docs/ref/docutils.dtd:
1201   - Added a ``stub`` attribute to the ``colspec`` element via the
1202     ``tbl.colspec.att`` parameter entity.
1203   - Allowed topic elements within sidebars
1204   - Added an ``align`` attribute to the ``figure`` element.
1206 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1207   writer.
1210 Release 0.3.7 (2004-12-24)
1211 ==========================
1213 * docutils/frontend.py:
1215   - Added options: --input-encoding-error-handler,
1216     --record-dependencies, --leave-footnote-reference-space,
1217     --strict-visitor.
1218   - Added command-line and config file support for "overrides" setting
1219     parameter.
1221 * docutils/io.py:
1223   - Added support for input encoding error handler.
1225 * docutils/nodes.py:
1227   - Added dispatch_visit and dispatch_departure methods to
1228     NodeVisitor; useful as a hook for Visitors.
1229   - Changed structure of ``line_block``; added ``line``.
1230   - Added ``compound`` node class.
1231   - Added a mechanism for Visitors to transitionally ignore new node
1232     classes.
1234 * docutils/utils.py:
1236   - Moved ``escape2null`` and ``unescape`` functions from
1237     docutils/parsers/rst/states.py.
1239 * docutils/parsers/rst/roles.py:
1241   - Added "raw" role.
1242   - Changed role function API: the "text" parameter now takes
1243     null-escaped interpreted text content.
1245 * docutils/parsers/rst/states.py:
1247   - Fixed bug where a "role" directive in a nested parse would crash
1248     the parser; the state machine's "language" attribute was not being
1249     copied over.
1250   - Added support for line block syntax.
1251   - Fixed directive parsing bug: argument-less directives didn't
1252     notice that arguments were present.
1253   - Removed error checking for transitions.
1254   - Added support for multiple classifiers in definition list items.
1255   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1256   - Changed role function API: the "text" parameter now takes
1257     null-escaped interpreted text content.
1258   - Empty sections and documents are allowed now.
1260 * docutils/parsers/rst/directives/__init__.py:
1262   - Added ``encoding`` directive option conversion function.
1263   - Allow multiple class names in class_option conversion function.
1265 * docutils/parsers/rst/directives/body.py:
1267   - Converted the line-block directive to use the new structure.
1268   - Extracted the old line-block functionality to the ``block``
1269     function (still used).
1270   - Added ``compound`` directive (thanks to Lea Wiemann).
1272 * docutils/parsers/rst/directives/misc.py:
1274   - Added "encoding" option to "include" and "raw" directives.
1275   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1276   - Allow multiple class names in the "class" directive.
1278 * docutils/parsers/rst/directives/parts.py:
1280   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1281     options.  Thanks to Lele Gaifax.
1283 * docutils/parsers/rst/directives/tables.py:
1285   - Added "encoding" directive to "csv-table" directive.
1286   - Added workaround for lack of Unicode support in csv.py, for
1287     non-ASCII CSV input.
1289 * docutils/transforms/misc.py:
1291   - Fixed bug when multiple "class" directives are applied to a single
1292     element.
1293   - Enabled multiple format names for "raw" directive.
1295 * docutils/transforms/references.py:
1297   - Added support for trimming whitespace from beside substitution
1298     references.
1300 * docutils/transforms/universal.py:
1302   - FinalChecks now checks for illegal transitions and moves
1303     transitions between sections.
1305 * docutils/writers/html4css1.py:
1307   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1308   - "stylesheet" and "stylesheet_path" settings are now mutually
1309     exclusive.
1310   - Added support for the new line_block/line structure.
1311   - --footnote-references now overrides
1312     --trim-footnote-reference-space, if applicable.
1313   - Added support for ``compound`` elements.
1314   - Enabled multiple format names for "raw" directive.
1315   - ``<p>`` tags of a paragraph which is the only visible child of the
1316     document node are no longer stripped.
1317   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1318     new method ``should_be_compact_paragraph()``.
1319   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1320     elements.
1321   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1322     the output if they have their ``class`` attribute set.
1323   - The whole document is now surrounded by a ``<div
1324     class="document">`` element.
1325   - Body-level images are now wrapped by their own ``<div>`` elements,
1326     with image classes copied to the wrapper, and for images which
1327     have the ``:align:`` option set, the surrounding ``<div>`` now
1328     receives a class attribute (like ``class="align-left"``).
1330 * docutils/writers/latex2e.py:
1332   - no newline after depart_term.
1333   - Added translations for some Unicode quotes.
1334   - Added option "font-encoding", made package AE the default.
1335   - "stylesheet" and "stylesheet_path" settings are now mutually
1336     exclusive.
1337   - --footnote-references now overrides
1338     --trim-footnote-reference-space, if applicable.
1339   - The footnote label style now matches the footnote reference style
1340     ("brackets" or "superscript").
1341   - Added support for ``compound`` elements.
1342   - Enabled multiple format names for "raw" directive.
1344 * docs/ref/docutils.dtd:
1346   - Changed structure of the ``line_block`` element; added ``line``.
1347   - Added ``compound`` element.
1348   - Added "ltrim" and "rtrim" attributes to
1349     ``substitution_definition`` element.
1350   - Enabled multiple format names for ``raw`` element.
1351   - Enabled multiple classifiers in ``definition_list_item`` elements.
1353 * docs/ref/rst/directives.txt
1355   - Marked "line-block" as deprecated.
1356   - "Class" directive now allows multiple class names.
1357   - Added "Rationale for Class Attribute Value Conversion".
1358   - Added warning about "raw" overuse/abuse.
1360 * docs/ref/rst/restructuredtext.txt:
1362   - Added syntax for line blocks.
1363   - Definition list items may have multiple classifiers.
1365 * docs/ref/rst/roles.txt:
1367   - Added "raw" role.
1369 * tools/stylesheets/default.css:
1371   - Added support for the new line_block structure.
1372   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1375 Release 0.3.5 (2004-07-29)
1376 ==========================
1378 General:
1380 * _`Documentation cleanup/reorganization`.
1382   - Created new subdirectories of docs/:
1384     * ``docs/user/``: introductory/tutorial material for end-users
1385     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1386     * ``docs/api/``: API reference material for client-developers
1387     * ``docs/ref/``: reference material for all groups
1388     * ``docs/howto/``: for component-developers and core-developers
1389     * ``docs/peps/``: Python Enhancement Proposals
1391   - Moved ``docs/*`` to ``docs/user/``.
1392   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1393     ``spec/`` to ``docs/dev``.
1394   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1395     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1396   - Moved ``alternatives.txt``, and ``problems.txt`` from
1397     ``spec/rst/`` to ``docs/dev/rst/``.
1398   - Moved ``reStructuredText.txt``, ``directives.txt``,
1399     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1400     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1401     ``roles.txt``, ``reStructuredText.txt`` to
1402     ``restructuredtext.txt``.
1403   - Moved ``spec/howto/`` to ``docs/howto``.
1405   In order to keep the CVS history of moved files, we supplied
1406   SourceForge with a `script for modifying the Docutils CVS
1407   repository`__.
1409   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1411   After running the cleanup script:
1413   - Added ``docs/index.txt``.
1414   - Added a ``.htaccess`` file to the ``web`` module, containing
1415     redirects for all old paths to new paths.  They'll preserve
1416     fragments (the "#name" part of a URL), and won't clutter up the
1417     file system, and will correct the URL in the user's browser.
1418   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1419     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1420     the "To Do" list itself in ``docs/dev/todo.txt``.
1421   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1422     section of ``docs/dev/todo.txt``.
1423   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1424   - Added "How To Report Bugs" to ``BUGS.txt``.
1425   - Went through all the sources and docs (including under web/) and
1426     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1427     (Still need to update links in the sandboxes.)
1429 Specific:
1431 * BUGS.txt: Added to project.
1433 * THANKS.txt: Added to project.
1435 * docutils/__init__.py:
1437   - 0.3.4: Post-release.
1439 * docutils/core.py:
1441   - Added special error handling & advice for UnicodeEncodeError.
1442   - Refactored Publisher.publish (simplified exception handling &
1443     extracted debug dumps).
1444   - Renamed "enable_exit" parameter of convenience functions to
1445     "enable_exit_status".
1446   - Enabled traceback (exception propagation) by default in
1447     programmatic convenience functions.
1448   - Now publish_file and publish_cmdline convenience functions return
1449     the encoded string results in addition to their regular I/O.
1450   - Extracted common code from publish_file, publish_string, and
1451     publish_parts, into new publish_programmatically.  Extracted
1452     settings code to ``Publisher.process_programmatic_settings``.
1453   - In Publisher.publish, disabled ``settings_overrides`` when
1454     ``settings`` is supplied; redundant.
1456 * docutils/frontend.py:
1458   - Added help text for "--output-encoding-error-handler" and
1459     "--error-encoding-error-handler".
1460   - Renamed "--exit" to "--exit-status".
1461   - Simplified default-setting code.
1463 * docutils/parsers/rst/__init__.py:
1465   - Added "--pep-base-url" and "--rfc-base-url" options.
1467 * docutils/parsers/rst/states.py:
1469   - Made URI recognition more aggressive and intelligent.
1471 * docutils/parsers/rst/directives/__init__.py:
1473   - Added several directive option conversion functions.
1475 * docutils/parsers/rst/directives/body.py:
1477   - Moved "table" directive to tables.py.
1479 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1480   added to project.
1482 * docutils/writers/latex2e.py:
1484   - Added "--table-style=(standard|booktabs|nolines)"
1485   - figures get "here" option (LaTeX per default puts them at bottom),
1486     and figure content is centered.
1487   - Rowspan support for tables.
1488   - Fix: admonition titles before first section.
1489   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1490   - Replave ``_`` in literal by an underlined blank, because it has the correct
1491     width.
1492   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1493   - A few unicode replacements, if output_encoding != utf
1494   - Add "--graphicx-option".
1495   - Indent literal-blocks.
1496   - Fix: omit ``\maketitle`` when there is no document title.
1498 * docs/index.txt: "Docutils Project Documentation Overview", added to
1499   project.
1501 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1502   Tool", added to project.
1504 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1506 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1508 * docs/dev/policies.txt: Added to project (extracted from
1509   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1511 * docs/dev/release.txt: Added to project (extracted from
1512   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1514 * docs/dev/testing.txt: Added to project.
1516 * docs/dev/website.txt: Added to project (extracted from
1517   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1519 * docs/ref/rst/directives.txt:
1521   - Added directives: "table", "csv-table".
1523 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1524   added to project.  1 page for syntax, and a 1 page reference for
1525   directives and roles.  Source text to be used as-is; not meant to be
1526   converted to HTML.
1528 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1529   with a change of title.
1531 * test/functional/, contents, and test/test_functional.py: Added to
1532   project.
1534 * tools/buildhtml.py: Fixed bug with config file handling.
1536 * tools/html.py: Removed from project (duplicate of rst2html.py).
1538 * tools/pep2html.py: Removed from project (duplicate of Python's
1539   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1540   Docutils-related PEPs in docs/peps/).
1542 * tools/rst2pseudoxml.py: Renamed from publish.py.
1544 * tools/rst2xml.py: Renamed from docutils-xml.py.
1546 * tools/test.txt: Removed from project; moved to
1547   docs/user/rst/demo.txt.
1549 * setup.py: Now also installs ``rst2latex.py``.
1552 Release 0.3.3 (2004-05-09)
1553 ==========================
1555 * docutils/__init__.py:
1557   - 0.3.1: Reorganized config file format (multiple sections); see
1558     docs/config.txt.
1559   - Added unknown_reference_resolvers attribute to TransformSpec.
1560   - 0.3.2: Interpreted text reorganization.
1561   - 0.3.3: Released.
1563 * docutils/core.py:
1565   - Catch system messages to stop tracebacks from parsing errors.
1566   - Catch exceptions during processing report & exit without
1567     tracebacks, except when "--traceback" used.
1568   - Reordered components for OptionParser; application comes last.
1569   - Added "config_section" parameter to several methods and functions,
1570     allowing front ends to easily specify their config file sections.
1571   - Added publish_parts convenience function to allow access to individual
1572     parts of a document.
1574 * docutils/examples.py: Added to project; practical examples of
1575   Docutils client code, to be used as-is or as models for variations.
1577 * docutils/frontend.py:
1579   - Added "--traceback" & "--no-traceback" options ("traceback"
1580     setting).
1581   - Implemented support for config file reorganization:
1582     ``standard_config_files`` moved from ``ConfigParser`` to
1583     ``OptionParser``; added
1584     ``OptionParser.get_config_file_settings()`` and
1585     ``.get_standard_config_settings()``; support for old "[options]"
1586     section (with deprecation warning) and mapping from old to new
1587     settings.
1588   - Reimplemented setting validation.
1589   - Enabled flexible boolean values: yes/no, true/false, on/off.
1590   - Added ``Values``, a subclass of ``optparse.Values``, with support
1591     for list setting attributes.
1592   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1593     thanks to Beni Cherniavsky.
1594   - Added "--no-section-numbering" option.
1596 * docutils/io.py:
1598   - Catch IOErrors when opening source & destination files, report &
1599     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1600     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1602 * docutils/nodes.py:
1604   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1605     method definitions (via ``exec``) to dynamic assignments (via
1606     ``setattr``); thanks to Roman Suzi.
1607   - Encapsulated visitor dynamic assignments in a function; thanks to
1608     Ian Bicking.
1609   - Added indirect_reference_name attribute to the Targetable
1610     class. This attribute holds the whitespace_normalized_name
1611     (contains mixed case) of a target.
1613 * docutils/statemachine.py:
1615   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1616   - Added ``StringList.get_2D_block``.
1618 * docutils/utils.py:
1620   - Added "level" attribute to SystemMessage exceptions.
1622 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1623   Jannie Hofmeyr.
1625 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1626   Blaha.
1628 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1629   Marcelo Huerta San Martin.
1631 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1632   mappings by Lalo Martins.
1634 * docutils/languages/ru.py: Added to project; Russian mappings by
1635   Roman Suzi.
1637 * docutils/parsers/rst/roles.py: Added to project.  Contains
1638   interpreted text role functions, a registry for interpreted text
1639   roles, and an API for adding to and retrieving from the registry.
1640   Contributed by Edward Loper.
1642 * docutils/parsers/rst/states.py:
1644   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1645   - Allowed true em-dash character and "---" as block quote
1646     attribution marker.
1647   - Added support for <angle-bracketed> complex option arguments
1648     (option lists).
1649   - Fixed handling of backslashes in substitution definitions.
1650   - Fixed off-by-1 error with extra whitespace after substitution
1651     definition directive.
1652   - Added inline markup parsing to field lists' field names.
1653   - Added support for quoted (and unindented) literal blocks.
1654     Driven in part by a bribe from Frank Siebenlist (thanks!).
1655   - Parser now handles escapes in URIs correctly.
1656   - Made embedded-URIs' reference text omittable.  Idea from Beni
1657     Cherniavsky.
1658   - Refactored explicit target processing code.
1659   - Added name attribute to references containing the reference name only
1660     through whitespace_normalize_name (no case changes).
1661   - parse_target no longer returns the refname after going through
1662     normalize_name. This is now handled in make_target.
1663   - Fixed bug relating to role-less interpreted text in non-English
1664     contexts.
1665   - Reorganized interpreted text processing; moved code into the new
1666     roles.py module.  Contributed by Edward Loper.
1667   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1668     ``parse_directive_block``.
1670 * docutils/parsers/rst/tableparser.py:
1672   - Reworked for ``StringList``, to support "include" directives in
1673     table cells.
1675 * docutils/parsers/rst/directives/__init__.py:
1677   - Renamed ``unchanged()`` directive option conversion function to
1678     ``unchanged_required``, and added a new ``unchanged``.
1679   - Catch unicode value too high error; fixes bug 781766.
1680   - Beefed up directive error reporting.
1682 * docutils/parsers/rst/directives/body.py:
1684   - Added basic "table" directive.
1686 * docutils/parsers/rst/directives/images.py:
1688   - Added "target" option to "image" directive.
1689   - Added name attribute to references containing the reference name only
1690     through whitespace_normalize_name (no case changes).
1692 * docutils/parsers/rst/directives/misc.py:
1694   - Isolated the import of the ``urllib2`` module; was causing
1695     problems on SourceForge (``libssl.so.2`` unavailable?).
1696   - Added the "role" directive for declaring custom interpreted text
1697     roles.
1699 * docutils/parsers/rst/directives/parts.py:
1701   - The "contents" directive does more work up-front, creating the
1702     "topic" and "title", and leaving the "pending" node for the
1703     transform.  Allows earlier reference resolution; fixes subtle bug.
1705 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1706   mappings by Jannie Hofmeyr.
1708 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1709   mappings by Marek Blaha.
1711 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1712   mappings by Marcelo Huerta San Martin.
1714 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1715   Portuguese mappings by Lalo Martins.
1717 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1718   mappings by Roman Suzi.
1720 * docutils/transforms/parts.py:
1722   - The "contents" directive does more work up-front, creating the
1723     "topic" and "title", and leaving the "pending" node for the
1724     transform.  Allows earlier reference resolution; fixes subtle bug.
1725   - Added support for disabling of section numbering.
1727 * docutils/transforms/references.py:
1729   - Verifying that external targets are truly targets and not indirect
1730     references. This is because we are now adding a "name" attribute to
1731     references in addition to targets. Note sure if this is correct!
1732   - Added code to hook into the unknown_reference_resolvers list for a
1733     transformer in resolve_indirect_target. This allows the
1734     unknown_reference_resolvers to keep around indirect targets which
1735     docutils doesn't know about.
1736   - Added specific error message for duplicate targets.
1738 * docutils/transforms/universal.py:
1740   - Added FilterMessages transform (removes system messages below the
1741     verbosity threshold).
1742   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1743     to FinalCheckVisitor for application-specific handling of
1744     unresolvable references.
1745   - Added specific error message for duplicate targets.
1747 * docutils/writers/__init__.py:
1749   - Added assemble_parts method to the Writer class to allow for
1750     access to a documents individual parts.
1751   - Documented & set default for ``Writer.output`` attribute.
1753 * docutils/writers/html4css1.py:
1755   - Fixed unicode handling of attribute values (bug 760673).
1756   - Prevent duplication of "class" attribute values (bug report from
1757     Kirill Lapshin).
1758   - Improved table grid/border handling (prompted by report from Bob
1759     Marshall).
1760   - Added support for table titles.
1761   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1762     to Darek Suchojad.
1763   - Added functionality to keep track of individual parts of a document
1764     and store them in a dictionary as the "parts" attribute of the writer.
1765     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1766   - Added proper support for the "scale" attribute of the "image"
1767     element.  Contributed by Brent Cook.
1768   - Added ``--initial-header-level`` option.
1769   - Fixed bug: the body_pre_docinfo segment depended on there being a
1770     docinfo; if no docinfo, the document title was incorporated into
1771     the body segment.  Adversely affected the publish_parts interface.
1773 * docutils/writers/latex2e.py:
1775   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1776     about a missing file.
1777   - Added options and support: ``--compound-enumerators``,
1778     ``--section-prefix-for-enumerators``, and
1779     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1780     934322).
1781   - Added option ``--use-verbatim-when-possible``, to avoid
1782     problematic characters (eg, '~' in italian) in literal blocks.
1783   - It's now possible to use four section levels in the `book` and
1784     `report` LaTeX classes.  The default `article` class still has
1785     three levels limit.
1787 * docs/config.txt: "Docutils Configuration Files", added to project.
1788   Moved config file entry descriptions from tools.txt.
1790 * docs/tools.txt:
1792   - Moved config file entry descriptions to config.txt.
1794 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1795   Development".
1797 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1798   Text Roles", added to project.
1800 * spec/rst/reStructuredText.txt:
1802   - Added description of support for <angle-bracketed> complex option
1803     arguments to option lists.
1804   - Added subsections for indented and quoted literal blocks.
1806 * test: Continually adding & updating tests.
1808   - Added test/test_settings.py & test/data/config_*.txt support
1809     files.
1810   - Added test/test_writers/test_htmlfragment.py.
1812 * test/DocutilsTestSupport.py:
1814   - Refactored LaTeX publisher test suite/case class names to make
1815     testing other writers easier.
1816   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1817     to test the processing of HTML fragments which use the new
1818     publish_parts convenience function.
1820 * tools/buildhtml.py:
1822   - Added support for the "--prune" option.
1823   - Removed dependency on pep2html.py; plaintext PEPs no longer
1824     supported.
1826 * tools/docutils.conf:
1828   - Updated for configuration file reorganization.
1830 * tools/rst2html.py:
1832   - copied from tools/html.py
1834 * setup.py:
1836   - added a 'scripts' section to configuration
1837   - added 'tools/rst2html.py' to the scripts section
1840 Release 0.3 (2003-06-24)
1841 ========================
1843 General:
1845 * Renamed "attribute" to "option" for directives/extensions.
1847 * Renamed transform method "transform" to "apply".
1849 * Renamed "options" to "settings" for runtime settings (as set by
1850   command-line options).  Sometimes "option" (singular) became
1851   "settings" (plural).  Some variations below:
1853   - document.options -> document.settings (stored in other objects as
1854     well)
1855   - option_spec -> settings_spec (not directives though)
1856   - OptionSpec -> SettingsSpec
1857   - cmdline_options -> settings_spec
1858   - relative_path_options -> relative_path_settings
1859   - option_default_overrides -> settings_default_overrides
1860   - Publisher.set_options -> Publisher.get_settings
1862 Specific:
1864 * COPYING.txt: Added "Public Domain Dedication".
1866 * FAQ.txt: Frequently asked questions, added to project.
1868 * setup.py:
1870   - Updated with PyPI Trove classifiers.
1871   - Conditional installation of third-party modules.
1873 * docutils/__init__.py:
1875   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1876   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1877   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1878   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1879     option and its effect on the PEP template & writer.
1880   - Bumped version to 0.2.4 due to changes to the PEP template &
1881     stylesheet.
1882   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1883   - Added ``TransformSpec`` class for new transform system.
1884   - Bumped version to 0.2.6 for API changes (renaming).
1885   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1886     convenience functions.
1887   - Added ``Component.component_type`` attribute.
1888   - Bumped version to 0.2.8 because of the internal parser switch from
1889     plain lists to the docutils.statemachine.StringList objects.
1890   - Bumped version to 0.2.9 because of the frontend.py API changes.
1891   - Bumped version to 0.2.10 due to changes to the project layout
1892     (third-party modules removed from the "docutils" package), and
1893     signature changes in ``io.Input``/``io.Output``.
1894   - Changed version to 0.3.0 for release.
1896 * docutils/core.py:
1898   - Made ``publish()`` a bit more convenient.
1899   - Generalized ``Publisher.set_io``.
1900   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1901     parameters; improved its docstring.
1902   - Added ``publish_file()`` and ``publish_string()``.
1903   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1904     out of ``.set_io``.
1905   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1906     "--dump-transforms" hidden options.
1907   - Added ``Publisher.apply_transforms()`` method.
1908   - Added ``Publisher.set_components()`` method; support for
1909     ``publish_*()`` conveninece functions.
1910   - Moved config file processing to docutils/frontend.py.
1911   - Added support for exit status ("exit_level" setting &
1912     ``enable_exit`` parameter for Publisher.publish() and convenience
1913     functions).
1915 * docutils/frontend.py:
1917   - Check for & exit on identical source & destination paths.
1918   - Fixed bug with absolute paths & "--config".
1919   - Set non-command-line defaults in ``OptionParser.__init__()``:
1920     ``_source`` & ``_destination``.
1921   - Distributed ``relative_path_settings`` to components; updated
1922     ``OptionParser.populate_from_components()`` to combine it all.
1923   - Require list of keys in ``make_paths_absolute`` (was implicit in
1924     global ``relative_path_settings``).
1925   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1926     "--dump-settings", and "--dump-transforms" hidden options.
1927   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1928     code, replaced with correct code.
1929   - Added validation functionality for config files.
1930   - Added "--error-encoding" option/setting, "_disable_config"
1931     internal setting.
1932   - Added encoding validation; updated "--input-encoding" and
1933     "--output-encoding"; added "--error-encoding-error-handler" and
1934     "--output-encoding-error-handler".
1935   - Moved config file processing from docutils/core.py.
1936   - Updated ``OptionParser.populate_from_components`` to handle new
1937     ``SettingsSpec.settings_defaults`` dict.
1938   - Added support for "-" => stdin/stdout.
1939   - Added "exit_level" setting ("--exit" option).
1941 * docutils/io.py:
1943   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1944   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1945   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1946   - ``FileOutput.write()`` now returns the encoded output string.
1947   - Try to get path/stream name automatically in ``FileInput`` &
1948     ``FileOutput``.
1949   - Added defaults for source & destination paths.
1950   - Allow for Unicode I/O with an explicit "unicode" encoding.
1951   - Added ``Output.encode()``.
1952   - Removed dependency on runtime settings; pass encoding directly.
1953   - Recognize Unicode strings in ``Input.decode()``.
1954   - Added support for output encoding error handlers.
1956 * docutils/nodes.py:
1958   - Added "Invisible" element category class.
1959   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1960     modification during a traversal.
1961   - Added element classes: ``line_block``, ``generated``, ``address``,
1962     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1963     ``superscript``, ``subscript``, ``inline``
1964   - Added support for lists of nodes to ``Element.insert()``.
1965   - Fixed parent linking in ``Element.replace()``.
1966   - Added new abstract superclass ``FixedTextElement``; adds
1967     "xml:space" attribute.
1968   - Added support for "line" attribute of ``system_message`` nodes.
1969   - Added support for the observer pattern from ``utils.Reporter``.
1970     Added ``parse_messages`` and ``transform_messages`` attributes to
1971     ``document``, removed ``messages``.  Added ``note_parse_message``
1972     and ``note_transform_message`` methods.
1973   - Added support for improved diagnostics:
1975     - Added "document", "source", and "line" internal attributes to
1976       ``Node``, set by ``Node.setup_child()``.
1977     - Converted variations on ``node.parent = self`` to
1978       ``self.setup_child(node)``.
1979     - Added ``document.current_source`` & ``.current_line``
1980       attributes, and ``.note_source`` observer method.
1981     - Changed "system_message" output to GNU-Tools format.
1983   - Added a "rawsource" attribute to the ``Text`` class, for text
1984     before backslash-escape resolution.
1985   - Support for new transform system.
1986   - Reworked ``pending`` element.
1987   - Fixed XML DOM bug (SF #660611).
1988   - Removed the ``interpeted`` element class and added
1989     ``title_reference``, ``abbreviation``, ``acronym``.
1990   - Made substitutions case-sensitive-but-forgiving; moved some code
1991     from the parser.
1992   - Fixed Unicode bug on element attributes (report: William Dode).
1994 * docutils/optik.py: Removed from project; replaced with
1995   extras/optparse.py and extras/textwrap.py.  These will be installed
1996   only if they're not already present in the Python installation.
1998 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1999   only if it's not already present in the Python installation.
2001 * docutils/statemachine.py:
2003   - Factored out ``State.add_initial_transitions()`` so it can be
2004     extended.
2005   - Converted whitespace-specific "blank" and "indent" transitions
2006     from special-case code to ordinary transitions: removed
2007     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2008     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2009     ``ws_initial_transitions`` attributes.
2010   - Removed ``State.match_transition()`` after merging it into
2011     ``.check_line()``.
2012   - Added ``StateCorrection`` exception.
2013   - Added support for ``StateCorrection`` in ``StateMachine.run()``
2014     (moved ``TransitionCorrection`` support there too.)
2015   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2016     ``EOFError`` instead of ``IndexError``.
2017   - Added ``State.no_match`` method.
2018   - Added support for the Observer pattern, triggered by input line
2019     changes.
2020   - Added ``strip_top`` parameter to
2021     ``StateMachineWS.get_first_known_indented``.
2022   - Made ``context`` a parameter to ``StateMachine.run()``.
2023   - Added ``ViewList`` & ``StringList`` classes;
2024     ``extract_indented()`` becomes ``StringList.get_indented()``.
2025   - Added ``StateMachine.insert_input()``.
2026   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2027     thanks to) Fred Drake.
2029 * docutils/utils.py:
2031   - Added a ``source`` attribute to Reporter instances and
2032     ``system_message`` elements.
2033   - Added an observer pattern to ``utils.Reporter`` to keep track of
2034     system messages.
2035   - Fixed bugs in ``relative_path()``.
2036   - Added support for improved diagnostics.
2037   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2038   - Added support for encoding Reporter stderr output, and encoding
2039     error handlers.
2040   - Reporter keeps track of the highest level system message yet
2041     generated.
2043 * docutils/languages: Fixed bibliographic field language lookups.
2045 * docutils/languages/es.py: Added to project; Spanish mappings by
2046   Marcelo Huerta San Martin.
2048 * docutils/languages/fr.py: Added to project; French mappings by
2049   Stefane Fermigier.
2051 * docutils/languages/it.py: Added to project; Italian mappings by
2052   Nicola Larosa.
2054 * docutils/languages/sk.py: Added to project; Slovak mappings by
2055   Miroslav Vasko.
2057 * docutils/parser/__init__.py:
2059   - Added ``Parser.finish_parse()`` method.
2061 * docutils/parser/rst/__init__.py:
2063   - Added options: "--pep-references", "--rfc-references",
2064     "--tab-width", "--trim-footnote-reference-space".
2066 * docutils/parsers/rst/states.py:
2068   - Changed "title under/overline too short" system messages from INFO
2069     to WARNING, and fixed its insertion location.
2070   - Fixed enumerated list item parsing to allow paragraphs & section
2071     titles to begin with enumerators.
2072   - Converted system messages to use the new "line" attribute.
2073   - Fixed a substitution reference edge case.
2074   - Added support for "--pep-references" and "--rfc-references"
2075     options; reworked ``Inliner`` code to make customization easier.
2076   - Removed field argument parsing.
2077   - Added support for short section title over/underlines.
2078   - Fixed "simple reference name" regexp to ignore text like
2079     "object.__method__"; not an anonymous reference.
2080   - Added support for improved diagnostics.
2081   - Reworked directive API, based on Dethe Elza's contribution.  Added
2082     ``Body.parse_directive()``, ``.parse_directive_options()``,
2083     ``.parse_directive_arguments()`` methods.
2084   - Added ``ExtensionOptions`` class, to parse directive options
2085     without parsing field bodies.  Factored
2086     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2087     ``ExtensionOptions``.
2088   - Improved definition list term/classifier parsing.
2089   - Added warnings for unknown directives.
2090   - Renamed ``Stuff`` to ``Struct``.
2091   - Now flagged as errors: transitions at the beginning or end of
2092     sections, empty sections (except title), and empty documents.
2093   - Updated for ``statemachine.StringList``.
2094   - Enabled recognition of schemeless email addresses in targets.
2095   - Added support for embedded URIs in hyperlink references.
2096   - Added backslash-escapes to inline markup end-string suffix.
2097   - Added support for correct interpreted text processing.
2098   - Fixed nested title parsing (topic, sidebar directives).
2099   - Added special processing of backslash-escaped whitespace (idea
2100     from David Abrahams).
2101   - Made substitutions case-sensitive-but-forgiving; moved some code
2102     to ``docutils.nodes``.
2103   - Added support for block quote attributions.
2104   - Added a kludge to work-around a conflict between the bubble-up
2105     parser strategy and short titles (<= 3 char-long over- &
2106     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2107     titles" submitted by Jason Diamond.
2108   - Added explicit interpreted text roles for standard inline markup:
2109     "emphasis", "strong", "literal".
2110   - Implemented "superscript" and "subscript" interpreted text roles.
2111   - Added initial support for "abbreviation" and "acronym" roles;
2112     incomplete.
2113   - Added support for "--trim-footnote-reference-space" option.
2114   - Optional space before colons in directives & hyperlink targets.
2116 * docutils/parsers/rst/tableparser.py:
2118   - Fixed a bug that was producing unwanted empty rows in "simple"
2119     tables.
2120   - Detect bad column spans in "simple" tables.
2122 * docutils/parsers/rst/directives: Updated all directive functions to
2123   new API.
2125 * docutils/parsers/rst/directives/__init__.py:
2127   - Added ``flag()``, ``unchanged()``, ``path()``,
2128     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2129     directive option helper functions.
2130   - Added warnings for unknown directives.
2131   - Return ``None`` for missing directives.
2132   - Added ``register_directive()``, thanks to William Dode and Paul
2133     Moore.
2135 * docutils/parsers/rst/directives/admonitions.py:
2137   - Added "admonition" directive.
2139 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2140   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2141   "parsed-literal", "rubric", "epigraph", "highlights" and
2142   "pull-quote" directives.
2144 * docutils/parsers/rst/directives/images.py:
2146   - Added an "align" attribute to the "image" & "figure" directives
2147     (by Adam Chodorowski).
2148   - Added "class" option to "image", and "figclass" to "figure".
2150 * docutils/parsers/rst/directives/misc.py:
2152   - Added "include", "raw", and "replace" directives, courtesy of
2153     Dethe Elza.
2154   - Added "unicode" and "class" directives.
2156 * docutils/parsers/rst/directives/parts.py:
2158   - Added the "sectnum" directive; by Dmitry Jemerov.
2159   - Added "class" option to "contents" directive.
2161 * docutils/parsers/rst/directives/references.py: Added to project.
2162   Contains the "target-notes" directive.
2164 * docutils/parsers/rst/languages/__init__.py:
2166   - Return ``None`` from get_language() for missing language modules.
2168 * docutils/parsers/rst/languages/de.py: Added to project; German
2169   mappings by Engelbert Gruber.
2171 * docutils/parsers/rst/languages/en.py:
2173   - Added interpreted text roles mapping.
2175 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2176   mappings by Marcelo Huerta San Martin.
2178 * docutils/parsers/rst/languages/fr.py: Added to project; French
2179   mappings by William Dode.
2181 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2182   mappings by Nicola Larosa.
2184 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2185   mappings by Miroslav Vasko.
2187 * docutils/readers/__init__.py:
2189   - Added support for the observer pattern from ``utils.Reporter``, in
2190     ``Reader.parse`` and ``Reader.transform``.
2191   - Removed ``Reader.transform()`` method.
2192   - Added default parameter values to ``Reader.__init__()`` to make
2193     instantiation easier.
2194   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2196 * docutils/readers/pep.py:
2198   - Added the ``peps.TargetNotes`` transform to the Reader.
2199   - Removed PEP & RFC reference detection code; moved to
2200     parsers/rst/states.py as options (enabled here by default).
2201   - Added support for pre-acceptance PEPs (no PEP number yet).
2202   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2203     easy subclassing.
2205 * docutils/readers/python: Python Source Reader subpackage added to
2206   project, including preliminary versions of:
2208   - __init__.py
2209   - moduleparser.py: Parser for Python modules.
2211 * docutils/transforms/__init__.py:
2213   - Added ``Transformer`` class and completed transform reform.
2214   - Added unknown_reference_resolvers list for each transformer. This list holds
2215     the list of functions provided by each component of the transformer that
2216     help resolve references.
2218 * docutils/transforms/frontmatter.py:
2220   - Improved support for generic fields.
2221   - Fixed bibliographic field language lookups.
2223 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2224   transforms.
2226 * docutils/transforms/parts.py:
2228   - Moved the "id" attribute from TOC list items to the references
2229     (``Contents.build_contents()``).
2230   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2231   - Added "class" attribute support to ``Contents``.
2233 * docutils/transforms/peps.py:
2235   - Added ``mask_email()`` function, updating to pep2html.py's
2236     functionality.
2237   - Linked "Content-Type: text/x-rst" to PEP 12.
2238   - Added the ``TargetNotes`` PEP-specific transform.
2239   - Added ``TargetNotes.cleanup_callback``.
2240   - Added title check to ``Headers``.
2242 * docutils/transforms/references.py:
2244   - Added the ``TargetNotes`` generic transform.
2245   - Split ``Hyperlinks`` into multiple transforms.
2246   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2247   - Added check for circular indirect references.
2248   - Made substitutions case-sensitive-but-forgiving.
2250 * docutils/transforms/universal.py:
2252   - Added support for the "--expose-internal-attributes" option.
2253   - Removed ``Pending`` transform classes & data.
2255 * docutils/writers/__init__.py:
2257   - Removed ``Writer.transform()`` method.
2259 * docutils/writers/docutils-xml.py:
2261   - Added XML and doctype declarations.
2262   - Added "--no-doctype" and "--no-xml-declaration" options.
2264 * docutils/writers/html4css1.py:
2266   - "name" attributes only on these tags: a, applet, form, frame,
2267     iframe, img, map.
2268   - Added "name" attribute to <a> in section titles for Netscape 4
2269     support (bug report: Pearu Peterson).
2270   - Fixed targets (names) on footnote, citation, topic title,
2271     problematic, and system_message nodes (for Netscape 4).
2272   - Changed field names from "<td>" to "<th>".
2273   - Added "@" to "&#64;" encoding to thwart address harvesters.
2274   - Improved the vertical whitespace optimization; ignore "invisible"
2275     nodes (targets, comments, etc.).
2276   - Improved inline literals with ``<span class="pre">`` around chunks
2277     of text and ``&nbsp;`` for runs of spaces.
2278   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2279     ``self.docinfo`` segments.
2280   - Added support for "line_block", "address" elements.
2281   - Improved backlinks (footnotes & system_messages).
2282   - Improved system_message output.
2283   - Redefined "--stylesheet" as containing an invariant URL, used
2284     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2285     working directory.
2286   - Added "--footnote-references" option (superscript or brackets).
2287   - Added "--compact-lists" and "--no-compact-lists" options.
2288   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2289     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2290   - Improved field list rendering.
2291   - Added Docutils version to "generator" meta tag.
2292   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2293   - Improved layout of <pre> HTML source.
2294   - Fixed attribute typo on <colspec>.
2295   - Refined XML prologue.
2296   - Support for no stylesheet.
2297   - Removed "interpreted" element support.
2298   - Added support for "title_reference", "sidebar", "attribution",
2299     "rubric", and generic "admonition" elements.
2300   - Added "--attribution" option.
2301   - Added support for "inline", "subscript", "superscript" elements.
2302   - Added initial support for "abbreviation" and "acronym";
2303     incomplete.
2305 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2306   (from the sandbox).
2308   - Added french.
2309   - Double quotes in literal blocks (special treatment for de/ngerman).
2310   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2311   - Added  "--attribution" option.
2312   - Right align attributions.
2314 * docutils/writers/pep_html.py:
2316   - Parameterized output encoding in PEP template.
2317   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2318   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2319     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2320     working directory.
2321   - Added an override on the "--footnote-references" option.
2322   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2323   - Added Docutils version to "generator" meta tag.
2324   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2326 * docs/tools.txt:
2328   - Added a "silent" setting for ``buildhtml.py``.
2329   - Added a "Getting Help" section.
2330   - Rearranged the structure.
2331   - Kept up to date, with new settings, command-line options etc.
2332   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2333   - Converted settings table into a definition list.
2335 * docs/rst/quickstart.txt:
2337   - Added a table of contents.
2338   - Added feedback information.
2339   - Added mention of minimum section title underline lengths.
2340   - Removed the 4-character minimum for section title underlines.
2342 * docs/rst/quickref.html:
2344   - Added a "Getting Help" section.
2345   - Added a style to make section title backlinks more subtle.
2346   - Added mention of minimum section title underline lengths.
2347   - Removed the 4-character minimum for section title underlines.
2349 * extras: Directory added to project; contains third-party modules
2350   that Docutils depends on (optparse, textwrap, roman).  These are
2351   only installed if they're not already present.
2353 * licenses: Directory added to project; contains copies of license
2354   files for non-public-domain files.
2356 * spec/doctree.txt:
2358   - Changed the focus.  It's about DTD elements:  structural
2359     relationships, semantics, and external (public) attributes.  Not
2360     about the element class library.
2361   - Moved some implementation-specific stuff into ``docutils.nodes``
2362     docstrings.
2363   - Wrote descriptions of all common attributes and parameter
2364     entities.  Filled in introductory material.
2365   - Working through the element descriptions: 55 down, 37 to go.
2366   - Removed "Representation of Horizontal Rules" to
2367     spec/rst/alternatives.txt.
2369 * spec/docutils.dtd:
2371   - Added "generated" inline element.
2372   - Added "line_block" body element.
2373   - Added "auto" attribute to "title".
2374   - Changed content models of "literal_block" and "doctest_block" to
2375     ``%text.model``.
2376   - Added ``%number;`` attribute type parameter entity.
2377   - Changed ``%structural.elements;`` to ``%section.elements``.
2378   - Updated attribute types; made more specific.
2379   - Added "address" bibliographic element.
2380   - Added "line" attribute to ``system_message`` element.
2381   - Removed "field_argument" element; "field_name" may contain
2382     multiple words and whitespace.
2383   - Changed public identifier to docutils.sf.net.
2384   - Removed "interpreted" element; added "title_reference",
2385     "abbreviation", "acronym".
2386   - Removed "refuri" attribute from "footnote_reference" and
2387     "citation_reference".
2388   - Added "sidebar", "rubric", "attribution", "admonition",
2389     "superscript", "subscript", and "inline" elements.
2391 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2393 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2395 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2397 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2398   Dallas Mahrt.
2400 * spec/transforms.txt: Added to project.
2402 * spec/howto: Added subdirectory, for developer how-to docs.
2404 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2405   Elza, edited & extended by David Goodger.
2407 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2408   project.
2410 * spec/rst/alternatives.txt:
2412   - Added "Doctree Representation of Transitions" from
2413     spec/doctree.txt.
2414   - Updated "Inline External Targets" & closed the debate.
2415   - Added ideas for interpreted text syntax extensions.
2416   - Added "Nested Inline Markup" section.
2418 * spec/rst/directives.txt:
2420   - Added directives: "topic", "sectnum", "target-notes",
2421     "line-block", "parsed-literal", "include", "replace", "sidebar",
2422     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2423     "class".
2424   - Formalized descriptions of directive details.
2425   - Added an "align" attribute to the "image" & "figure" directives
2426     (by Adam Chodorowski).
2427   - Added "class" options to "topic", "sidebar", "line-block",
2428     "parsed-literal", "contents", and "image"; and "figclass" to
2429     "figure".
2431 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2432   interpreted text roles.
2434 * spec/rst/introduction.txt:
2436   - Added pointers to material for new users.
2438 * spec/rst/reStructuredText.txt:
2440   - Disambiguated comments (just add a newline after the "::").
2441   - Updated enumerated list description; added a discussion of the
2442     second-line validity checking.
2443   - Updated directive description.
2444   - Added a note redirecting newbies to the user docs.
2445   - Expanded description of inline markup start-strings in non-markup
2446     contexts.
2447   - Removed field arguments and made field lists a generic construct.
2448   - Removed the 4-character minimum for section title underlines.
2449   - Clarified term/classifier delimiter & inline markup ambiguity
2450     (definition lists).
2451   - Added "Embedded URIs".
2452   - Updated "Interpreted Text" section.
2453   - Added "Character-Level Inline Markup" section.
2455 * test: Continually adding & updating tests.
2457   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2458   - Moved test/test_pep/ to test/test_readers/test_pep/.
2459   - Added test/test_readers/test_python/.
2460   - Added test/test_writers/ (Engelbert Gruber).
2462 * tools:
2464   - Made the ``locale.setlocale()`` calls in front ends
2465     fault-tolerant.
2467 * tools/buildhtml.py:
2469   - Added "--silent" option.
2470   - Fixed bug with absolute paths & "--config".
2471   - Updated for new I/O classes.
2472   - Added some exception handling.
2473   - Separated publishers' setting defaults; prevents interference.
2474   - Updated for new ``publish_file()`` convenience function.
2476 * tools/pep-html-template:
2478   - Allow for "--embed-stylesheet".
2479   - Added Docutils version to "generator" meta tag.
2480   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2481   - Conform to XHTML spec.
2483 * tools/pep2html.py:
2485   - Made ``argv`` a parameter to ``main()``.
2486   - Added support for "Content-Type:" header & arbitrary PEP formats.
2487   - Linked "Content-Type: text/plain" to PEP 9.
2488   - Files skipped (due to an error) are not pushed onto the server.
2489   - Updated for new I/O classes.
2490   - Added ``check_requirements()`` & ``pep_type_error()``.
2491   - Added some exception handling.
2492   - Updated for new ``publish_string()`` convenience function.
2493   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2495 * tools/quicktest.py:
2497   - Added "-V"/"--version" option.
2499 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2501 * tools/unicode2rstsubs.py: Added to project.  Produces character
2502   entity files (reSructuredText substitutions) from the MathML master
2503   unicode.xml file.
2505 * tools/editors: Support code for editors, added to project.  Contains
2506   ``emacs/restructuredtext.el``.
2508 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2510   - Added style for chunks of inline literals.
2511   - Removed margin for first child of table cells.
2512   - Right-aligned field list names.
2513   - Support for auto-numbered section titles in TOCs.
2514   - Increased the size of inline literals (<tt>) in titles.
2515   - Restored the light gray background for inline literals.
2516   - Added support for "line_block" elements.
2517   - Added style for "address" elements.
2518   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2519   - Improved field list rendering.
2520   - Vertical whitespace improvements.
2521   - Removed "a.target" style.
2523 * tools/stylesheets/pep.css:
2525   - Fixed nested section margins.
2526   - Other changes parallel those of ``../default.css``.
2529 Release 0.2 (2002-07-31)
2530 ========================
2532 General:
2534 - The word "component" was being used ambiguously.  From now on,
2535   "component" will be used to mean "Docutils component", as in Reader,
2536   Writer, Parser, or Transform.  Portions of documents (Table of
2537   Contents, sections, etc.)  will be called "document parts".
2538 - Did a grand renaming: a lot of ``verylongnames`` became
2539   ``very_long_names``.
2540 - Cleaned up imports: no more relative package imports or
2541   comma-separated lists of top-level modules.
2542 - Added support for an option values object which carries default
2543   settings and overrides (from command-line options and library use).
2544 - Added internal Unicode support, and support for both input and
2545   output encodings.
2546 - Added support for the ``docutils.io.IO`` class & subclasses.
2548 Specific:
2550 * docutils/__init__.py:
2552   - Added ``ApplicationError`` and ``DataError``, for use throughout
2553     the package.
2554   - Added ``Component`` base class for Docutils components; implements
2555     the ``supports`` method.
2556   - Added ``__version__`` (thus, ``docutils.__version__``).
2558 * docutils/core.py:
2560   - Removed many keyword parameters to ``Publisher.__init__()`` and
2561     ``publish()``; bundled into an option values object.  Added
2562     "argv", "usage", "description", and "option_spec" parameters for
2563     command-line support.
2564   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2565     methods.
2566   - Reworked I/O model for ``docutils.io`` wrappers.
2567   - Updated ``Publisher.set_options()``; now returns option values
2568     object.
2569   - Added support for configuration files (/etc/docutils.conf,
2570     ./docutils.conf, ~/.docutils).
2571   - Added ``Publisher.setup_option_parser()``.
2572   - Added default usage message and description.
2574 * docutils/frontend.py: Added to project; support for front-end
2575   (command-line) scripts.  Option specifications may be augmented by
2576   components.  Requires Optik (http://optik.sf.net/) for option
2577   processing (installed locally as docutils/optik.py).
2579 * docutils/io.py: Added to project; uniform API for a variety of input
2580   output mechanisms.
2582 * docutils/nodes.py:
2584   - Added ``TreeCopyVisitor`` class.
2585   - Added a ``copy`` method to ``Node`` and subclasses.
2586   - Added a ``SkipDeparture`` exception for visitors.
2587   - Renamed ``TreePruningException`` from ``VisitorException``.
2588   - Added docstrings to ``TreePruningException``, subclasses, and
2589     ``Nodes.walk()``.
2590   - Improved docstrings.
2591   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2592   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2593     imports.
2594   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2595     ``PreDecorative`` mixin.
2596   - Reworked the name/id bookkeeping; to ``document``, removed
2597     ``explicit_targets`` and ``implicit_targets`` attributes, added
2598     ``nametypes`` attribute and ``set_name_id_map`` method.
2599   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2600     traversals.
2601   - Added ``document.has_name()`` method.
2602   - Fixed DOM generation for list-attributes.
2603   - Added category class ``Labeled`` (used by footnotes & citations).
2604   - Added ``Element.set_class()`` method (sets "class" attribute).
2606 * docutils/optik.py: Added to project.  Combined from the Optik
2607   package, with added option groups and other modifications.  The use
2608   of this module is probably only temporary.
2610 * docutils/statemachine.py:
2612   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2613   - Added underscores to improve many awkward names.
2614   - In ``string2lines()``, changed whitespace normalizing translation
2615     table to regexp; restores Python 2.0 compatibility with Unicode.
2617 * docutils/urischemes.py:
2619   - Filled in some descriptions.
2620   - Added "shttp" scheme.
2622 * docutils/utils.py:
2624   - Added ``clean_rcs_keywords`` function (moved from
2625     docutils/transforms/frontmatter.py
2626     ``DocInfo.filter_rcs_keywords``).
2627   - Added underscores to improve many awkward names.
2628   - Changed names of Reporter's thresholds:
2629     warning_level -> report_level; error_level -> halt_level.
2630   - Moved ``utils.id()`` to ``nodes.make_id()``.
2631   - Added ``relative_path(source, target)``.
2633 * docutils/languages/de.py: German mappings; added to project.  Thanks
2634   to Gunnar Schwant for the translations.
2636 * docutils/languages/en.py: Added "Dedication" bibliographic field
2637   mappings.
2639 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2640   Chodorowski.
2642 * docutils/parsers/rst/states.py:
2644   - Added underscores to improve many awkward names.
2645   - Added RFC-2822 header support.
2646   - Extracted the inline parsing code from ``RSTState`` to a separate
2647     class, ``Inliner``, which will allow easy subclassing.
2648   - Made local bindings for ``memo`` container & often-used contents
2649     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2650   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2651   - Added ``MarkupMismatch`` exception; for late corrections.
2652   - Added ``-/:`` characters to inline markup's start string prefix,
2653     ``/`` to end string suffix.
2654   - Fixed a footnote bug.
2655   - Fixed a bug with literal blocks.
2656   - Applied patch from Simon Budig: simplified regexps with symbolic
2657     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2658   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2659   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2660   - Allowed non-ASCII in "simple names" (directive names, field names,
2661     references, etc.).
2662   - Converted ``Inliner.patterns.initial`` to be dynamically built
2663     from parts with ``build_regexp()`` function.
2664   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2665   - Updated docstrings.
2666   - Changed "table" to "grid_table"; added "simple_table" support.
2668 * docutils/parsers/rst/tableparser.py:
2670   - Changed ``TableParser`` to ``GridTableParser``.
2671   - Added ``SimpleTableParser``.
2672   - Refactored naming.
2674 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2675   a fallback language for directive names.
2677 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2678   directive to use a ``pending`` element, used only by HTML writers.
2680 * docutils/parsers/rst/directives/parts.py: Renamed from
2681   components.py.
2683   - Added "backlinks" attribute to "contents" directive.
2685 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2686   project by Adam Chodorowski.
2688 * docutils/readers/__init__.py: Gave Readers more control over
2689   choosing and instantiating Parsers.
2691 * docutils/readers/pep.py: Added to project; for PEP processing.
2693 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2694   requires a ``component`` parameter.
2696 * docutils/transforms/components.py: Added to project; transforms
2697   related to Docutils components.
2699 * docutils/transforms/frontmatter.py:
2701   - In ``DocInfo.extract_authors``, check for a single "author" in an
2702     "authors" group, and convert it to a single "author" element.
2703   - Added support for "Dedication" and generic bibliographic fields.
2705 * docutils/transforms/peps.py: Added to project; PEP-specific.
2707 * docutils/transforms/parts.py: Renamed from old components.py.
2709   - Added filter for `Contents`, to use alt-text for inline images,
2710     and to remove inline markup that doesn't make sense in the ToC.
2711   - Added "name" attribute to TOC topic depending on its title.
2712   - Added support for optional TOC backlinks.
2714 * docutils/transforms/references.py: Fixed indirect target resolution
2715   in ``Hyperlinks`` transform.
2717 * docutils/transforms/universal.py:
2719   - Changed ``Messages`` transform to properly filter out system
2720     messages below the warning threshold.
2721   - Added ``Decorations`` transform (support for ``--generator``,
2722     ``--date``, ``--time``, ``--source-link`` options).
2724 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2725   Engelbert Gruber's PDF writer.
2727 * docutils/writers/html4css1.py:
2729   - Made XHTML-compatible (switched to lowercase element & attribute
2730     names; empty tag format).
2731   - Escape double-dashes in comment text.
2732   - Improved boilerplate & modularity of output.
2733   - Exposed modular output in Writer class.
2734   - Added a "generator" meta tag to <head>.
2735   - Added support for the ``--stylesheet`` option.
2736   - Added support for ``decoration``, ``header``, and ``footer``
2737     elements.
2738   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2739     translation table to regexp; restores Python 2.0 compatibility
2740     with Unicode.
2741   - Added the translator class as instance variable to the Writer, to
2742     make it easily subclassable.
2743   - Improved option list spacing (thanks to Richard Jones).
2744   - Modified field list output.
2745   - Added backlinks to footnotes & citations.
2746   - Added percentage widths to "<col>" tags (from colspec).
2747   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2748     "<span>" changed to "<var>".
2749   - Inline literals: "<code>" changed to "<tt>".
2750   - Many changes to optimize vertical space: compact simple lists etc.
2751   - Add a command-line options & directive attributes to control TOC
2752     and footnote/citation backlinks.
2753   - Added support for optional footnote/citation backlinks.
2754   - Added support for generic bibliographic fields.
2755   - Identify backrefs.
2756   - Relative URLs for stylesheet links.
2758 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2759   PEPs (subclass of ``html4css1.Writer``).
2761 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2763 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2764   of the Docutils internal doctree in XML.
2766 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2768 * spec/doctree.txt:
2770   - Changed the title to "The Docutils Document Tree".
2771   - Added "Hyperlink Bookkeeping" section.
2773 * spec/docutils.dtd:
2775   - Added ``decoration``, ``header``, and ``footer`` elements.
2776   - Brought ``interpreted`` element in line with the parser: changed
2777     attribute "type" to "role", added "position".
2778   - Added support for generic bibliographic fields.
2780 * spec/notes.txt: Continual updates.  Added "Project Policies".
2782 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2783   section.
2785 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2787 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2788   mailing list discussions.
2790 * spec/pep-0287.txt:
2792   - Renamed to "reStructuredText Docstring Format".
2793   - Minor edits.
2794   - Reworked Q&A as an enumerated list.
2795   - Converted to reStructuredText format.
2797 * spec/pysource.dtd:
2799   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2801 * spec/pysource.txt: Removed from project.  Moved much of its contents
2802   to pep-0258.txt.
2804 * spec/rst/alternatives.txt:
2806   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2807   - Added "Inline External Targets" section.
2809 * spec/rst/directives.txt:
2811   - Added "backlinks" attribute to "contents" directive.
2813 * spec/rst/problems.txt:
2815   - Updated the Enumerated List Markup discussion.
2816   - Added new alternative table markup syntaxes.
2818 * spec/rst/reStructuredText.txt:
2820   - Clarified field list usage.
2821   - Updated enumerated list description.
2822   - Clarified purpose of directives.
2823   - Added ``-/:`` characters to inline markup's start string prefix,
2824     ``/`` to end string suffix.
2825   - Updated "Authors" bibliographic field behavior.
2826   - Changed "inline hyperlink targets" to "inline internal targets".
2827   - Added "simple table" syntax to supplement the existing but
2828     newly-renamed "grid tables".
2829   - Added cautions for anonymous hyperlink use.
2830   - Added "Dedication" and generic bibliographic fields.
2832 * test: Made test modules standalone (subdirectories became packages).
2834 * test/DocutilsTestSupport.py:
2836   - Added support for PEP extensions to reStructuredText.
2837   - Added support for simple tables.
2838   - Refactored naming.
2840 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2842   - Now supports true packages containing test modules
2843     (``__init__.py`` files required); fixes duplicate module name bug.
2845 * test/test_pep/: Subpackage added to project; PEP testing.
2847 * test/test_rst/test_SimpleTableParser.py: Added to project.
2849 * tools:
2851   - Updated html.py and publish.py front-end tools to use the new
2852     command-line processing facilities of ``docutils.frontend``
2853     (exposed in ``docutils.core.Publisher``), reducing each to just a
2854     few lines of code.
2855   - Added ``locale.setlocale()`` calls to front-end tools.
2857 * tools/buildhtml.py: Added to project; batch-generates .html from all
2858   the .txt files in directories and subdirectories.
2860 * tools/default.css:
2862   - Added support for ``header`` and ``footer`` elements.
2863   - Added styles for "Dedication" topics (biblio fields).
2865 * tools/docutils.conf: A configuration file; added to project.
2867 * tools/docutils-xml.py: Added to project.
2869 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2871 * tools/pep-html-template: Added to project.
2873 * tools/pep2html.py: Added to project from Python (nondist/peps).
2874   Added support for Docutils (reStructuredText PEPs).
2876 * tools/quicktest.py:
2878   - Added the ``--attributes`` option, hacked a bit.
2879   - Added a second command-line argument (output file); cleaned up.
2881 * tools/stylesheets/: Subdirectory added to project.
2883 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2886 Release 0.1 (2002-04-20)
2887 ========================
2889 This is the first release of Docutils, merged from the now inactive
2890 reStructuredText__ and `Docstring Processing System`__ projects.  For
2891 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2892 `DPS HISTORY`__ files.
2894 __ http://structuredtext.sourceforge.net/
2895 __ http://docstring.sourceforge.net/
2896 __ http://structuredtext.sourceforge.net/HISTORY.html
2897 __ http://docstring.sourceforge.net/HISTORY.html
2899 General changes: renamed 'dps' package to 'docutils'; renamed
2900 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2901 the test suites (reStructuredText's test/test_states renamed to
2902 test/test_rst); and all modifications required to make it all work.
2904 * docutils/parsers/rst/states.py:
2906   - Improved diagnostic system messages for missing blank lines.
2907   - Fixed substitution_reference bug.
2911    Local Variables:
2912    mode: indented-text
2913    indent-tabs-mode: nil
2914    sentence-end-double-space: t
2915    fill-column: 70
2916    End: