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