New setting validators, code cleanup.
[docutils.git] / HISTORY.txt
blobe9a40e66eb0b590643ed3df97876d37cf530c3ff
1 .. -*- coding: utf-8 -*-
3 ==================
4  Docutils History
5 ==================
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
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.9.1
17 ===================
19 * General
20   
21   - Dropped support for Python 2.3.
22   - ``docutils/math``, ``docutils/error_reporting.py``, and
23     ``docutils/urischemes.py`` moved to the utils package.
24   - Fix [3541369] Relative __import__ also with Python 3.3.
25   - Fix [3559988] and [3560841] __import__ local writer, reader, languages 
26     and parsers for Python 2.7 up.
27   - Fix import of PIL.Image.
28   - Change default of "syntax highlight" option to "long", 
29     basic syntax highlight styles for LaTeX and HTML.
31 * docutils/io.py
33   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
34     option is ignored and will be removed in a future release.
35   - Fix Py3k error writing to stdout with encoding differing from default.
37 * docutils/parsers/rst/directives/misc.py
39   - Fix [ 3546533 ] Unicode error with `date` directive.
41 * docutils/writers/html4css1/__init__.py
43   - Use ``<code>`` tag for inline "code",
44     do not drop nested inline nodes (syntax highlight tokens).
46 * docutils/tools/test/test_buildhtml.py
48   - Fix [ 3521167 ] allow running in any directory.
49   - Fix [ 3521168 ] allow running with Python 3.
51 * docutils/writers/manpage.py
53   - Apply [ 3527401 ] addmonition's don't preserve indentation
54   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
56 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
58   - Apply [ 3555160 ] ensure order of "otherlanguages".
59   - Fix section numbering by LaTeX.
61 * docutils/writers/s5_html/__init__.py
63   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
65 * docutils/writers/s5_html/docutils_xml.py
67   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
70 Release 0.9.1 (2012-06-17)
71 ==========================
73 * docutils/setup.py
75   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
76     installed in the PYTHONPATH. Converted tests are now
77     stored in ``test3/``, tools no longer need conversion.
79     If you installed one of Docutils versions 0.7 ... 0.9 with
80     ``setup.py install`` under Python 3, remove the spurious
81     ``test/`` and ``tools/`` directories in the site library root.
83 * docutils/test/
85   - Make tests independent from the location of the ``test/`` directory.
86   - Use converted sources (from the ``build/`` directory) for tests under
87     Python 3.
89 * docutils/tools/
91   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
93 * docutils/io.py
95   - Fix writing binary data to sys.stdout under Python 3 (allows
96     ``rst2odt.py`` to be used with output redirection).
98 * docutils/parsers/rst/directives/misc.py
100   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
101     ``locale == C`` and 8-bit char in path argument of `include` directive.
103 * docutils/test/alltests.py
105   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
106     file under Python 3.
108 Release 0.9 (2012-05-02)
109 ========================
111 * General:
113   - New reStructuredText "code" role and directive and "code" option
114     of the "include" directive with syntax highlighting by Pygments_.
115   - Fix parse_option_marker for option arguments containing ``=``.
116   - Fix [ 2993756 ]: import Python Imaging Library's Image module
117     via ``import PIL`` as starting with PIL 1.2,
118     "PIL lives in the PIL namespace only" (announcement__).
120 .. _Pygments: http://pygments.org/
121 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
123 * setup.py
125   - Fix [ 2971827 ] and [ 3442827 ]
126     extras/roman.py moved to docutils/utils/roman.py
128 * docutils/frontend.py
130   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
132 * docutils/io.py
134   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
135   - `mode` argument for FileOutput avoids code replication in
136     BinaryFileOutput.
137   - New exceptions InputError and OutputError for IO errors in
138     FileInput/FileOutput.
140 * docutils/core.py:
142   - No "hard" system exit on file IO errors: catch and report them in
143     `Publisher.reportException` instead. Allows handling by a calling
144     application if the configuration setting `traceback` is True.
146 * docutils/utils.py -> docutils/utils/__init__.py
148   - docutils.utils is now a package (providing a place for sub-modules)
150   .. note:: docutils/math, docutils/error_reporting.py, and
151      docutils/urischemes.py will move to the utils package in the next
152      release, too. See RELEASE-NOTES__
154      __ RELEASE-NOTES.html
156   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
157     errors recording non-ASCII filenames (fixes [ 3434355 ]).
159   - Fix relative_path() with source=None and `unicode` target.
161 * docutils/parsers/rst/states.py
163   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
164     characters and "international" quotes around inline markup.
165   - Use `field_marker` pattern to look for start of a
166     directive option block (fixes [ 3484857 ]).
168 * docutils/parsers/rst/tableparser.py
170   - Fix [ 2926161 ] for simple tables.
171     (Combining chars in grid tables still contribute to cell width.)
173 * docutils/writers/latex2e/__init__.py
175   - Support the `abbreviation` and `acronym` standard roles.
176   - Record only files required to generate the LaTeX source as dependencies.
177   - Fix handling of missing stylesheets.
178   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
179     when suppressing LaTeX section numbering.
180   - Use ``\DUtitle`` for unsupported section levels
181   - Apply [ 3512791 ] do not compare string literals with "is"
183 * docutils/writers/xetex/__init__.py
185   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
187 * docutils/writers/html4css1/__init__.py
189   - Change default for `math-output` setting to MathJax.
190   - Fix handling of missing stylesheets.
192 * docutils/writers/docutils_xml.py
194   - Use the visitor pattern with default_visit()/default_depart() methods
195     instead of minidom to facilitate special handling of selected nodes.
196   - Support raw XML (inserted as-is inside a <raw></raw> node).
198 * docutils/writers/manpage.py
200   - Do not emit comment line with trailing blank. Problematic for VCS.
202 Release 0.8.1 (2011-08-30)
203 ==========================
205 * General:
207   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
208     and [ 3395920 ] (correct copyright info for rst.el).
210 * docutils/test/
212   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
214 * docutils/writers/latex2e/__init__.py
216   - Clean up Babel language setting. Restores Sphinx compatibility.
218 Release 0.8 (2011-07-07)
219 ========================
221 * General:
223   - Handle language codes according to `BCP 47`_.
224   - If the specified language is not supported by Docutils,
225     warn and fall back to English.
226   - Math support: reStructuredText "math" role and directive,
227     ``math`` and ``math_block`` doctree elements.
228   - Decode command line arguments with the locale's preferred encoding
229     (to allow, e.g., ``--title=Dornröschen``).
230   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
231   - New sub-module `error_reporting`: handle encoding/decoding errors
232     when reporting exceptions.
233   - Some additions to the Docutils core are released under the 2-Clause BSD
234     license, see COPYING_ for details.
236   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
237   .. _COPYING: COPYING.html
239 * reStructuredText:
241   - Most directives now support a "name" option that attaches a
242     reference name.
244   - Directive content may start on the first line also when the directive
245     type accepts options.
247 * docs/dev/policies.txt:
249   - Recommend the 2-Clause BSD license
250     (http://www.spdx.org/licenses/BSD-2-Clause)
251     for code that is kept under the author's copyright.
253 * tools/buildhtml.py:
255   - Fix ``--local`` switch.
257 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
259 * docutils/writers/html4css1/__init__.py
261   - Set "lang" argument for objects with class argument
262     "language-<language tag>".
263   - New setting "math-output" with support for HTML, MathML, and LaTeX.
265 * docutils/writers/latex2e/__init__.py
267   - Fix [ 3043986 ] AttributeError using :local: with table of content.
268   - Place title data in the document preamble.
269   - Load `babel` package only if required.
270   - Update list of supported languages.
271   - New config setting "hyperref-options".
272     No hard-coded "unicode" hyperref option (clash with xetex).
273   - Set language for custom roles, paragraphs, block-quotes, and
274     line-quotes with class argument "language-<language tag>".
275   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
276   - Convert image URI to a local file path.
277   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
278     has more than one paragraph (Wolfgang Scherer).
279   - \leavevmode before longtable only when needed (prevents spurious vspace)
280   - do not advance table counter for tables without caption
282 * docutils/writers/xetex/__init__.py
284   - New writer generating LaTeX code for compiling with ``xelatex``.
286     A separate writer (inheriting from latex2e) instead of a ``--xetex``
287     option allows separate config options for XeTeX vs. LaTeX2e.
289 * docutils/writers/manpage.py
291   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
292   - Fix: vertical space cleaning for option group ``.``.
294 * tools/editors/emacs/rst.el:
296   - Fix [ 3001100 ] does not handle spaces in filenames
297     (thanks to Jakub Wilk)
299 * docutils/utils.py:
301   - strip whitespace from stylesheet arguments
302   - exclude combining chars from column_width()
303     (partial fix for [ 2926161 ])
305 * docutils/parsers/rst/directives/misc.py:
307   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
308     nested_parse
310 * docutils/io.py:
312   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
313     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
315 Release 0.7 (2010-07-07)
316 ========================
318 * General:
320   - Fix [ 2881769 ] setup configuration.
321   - Fix [ 2788716 ] reporting problems in included files.
323 * docutils/io.py
325   - FileInput opens files as text files with universal newline support
326     (mode "rU", configurable with the new optional argument "mode").
328 * docutils/nodes.py
330   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
332 * docutils/utils.py
334   - Fix [ 2923723 ] let decode_path() tolerate path == None
336 * docutils/writers/html4css1/__init__.py
338   - Support SVG and SWF images (thanks to Stefan Rank).
339   - Generate valid XHTML for centered images with targets.
340     Use CSS classes instead of "align" tags for image alignment.
342 * docutils/writers/latex2e/__init__.py
344   - Use `transforms.writer_aux.Admonitions` to "normalize" special
345     admonitions.
346   - Use the ``\url`` command for URLs (breaks long URLs instead of
347     writing into the margin).
348   - Preserve runs of spaces in `inline literals`__.
349   - Deprecate ``figure_footnotes`` setting.
350   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
351   - New ``latex_preamble`` setting.
352   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
353   - Fix hyperlink targets (labels) for images, figures, and tables.
354   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
355   - Apply [ 2961991 ] Call hyperref with unicode option.
356   - Drop the special `output_encoding`__ default ("latin-1").
357     The Docutils wide default (usually "UTF-8") is used instead.
358   - Render inline markup in document title and subtitle.
359   - Fix numbering depth with LaTeX section numbering.
360   - Update Unicode -> LaTeX translations.
361   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
363 __ docs/ref/restructuredtext.html#inline-literals
364 __ docs/user/config.html#docutils-footnotes
365 __ docs/user/config.html#output_encoding
367 * docutils/writers/manpage.py
369   - Fix: supported attribute (thanks to peter2108).
370   - Remove trailing blanks in code (keep in sync with mercurial version).
371   - Titles level 1, that is ``.SH``, always uppercase.
372   - Apply patch from mg: literal text should be bold in man-pages.
374 * docutils/nodes.py
376   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
377     turkish locale.
379 * setup.py:
381   - Python 3 support: copy test/ and tools/ to the build-dir
382     and convert Python sources with 2to3.
385 Release 0.6 (2009-10-11)
386 ========================
388 * General:
390   - Docutils is now compatible with Python versions from 2.3 up to 2.6
391     and convertible to 3.1 code.
393     + Node.__nonzero__ returns True instead of 1.
394     + use os.walk instead os.path.walk.
395     + minimize "types" module where possible.
396     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
397     + Text nodes now subclass unicode rather than UserString
398       (which is gone in python 3.0).
399     + 3.0 compatibility module docutils._compat
401     + Drop 2.2 compatibility workarounds.
402     + Drop extras/optparse.py and extras/textwrap.py
403       (stdlib modules since 2.3).
405   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
406   - Unix man page export: manpage writer moved from sandbox to Doctutils
407     core.
409   - Apply [ 1719345 ] Galician translation
410   - Apply [ 1905741 ] Polish translation
411   - Apply [ 1878977 ] make_id(): deaccent characters.
412   - Apply [ 2029251 ] return nonzero when tests fail.
413   - Fix [ 1692788 ] allow UTF-8 in style sheets.
414   - Fix [ 2781629 ] support non-ASCII chars in file names.
415   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
416   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
417   - Fix [ 2821266 ] --strict option works now like --halt=info.
418   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
419   - Fix [ 1627229 ] hyperlink references in substitutions.
421   - The "newlatex" writer is orphaned.
423 * reStructuredText:
425   - Documented Unicode characters allowed as inline markup openers,
426     closers, and delimiters.
427   - Allow units for all length specifications.
428   - Allow percent sign in "scale" argument of "figure" and "image" directives.
429   - Bugfix: The "figalign" argument of a figure now works as intended
430     (aligning the figure, not its contents).
431   - Align images with class "align-[right|center|left]"
432     (allows setting the alignment of an image in a figure).
434 * docutils/nodes.py:
436   - Added ``Element.__contains__`` method, for the in-operator.
438 * docutils/parsers/rst/states.py:
440   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
441   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
442     " " (non-breaking space), and "¡ ¿" openers.
444 * docutils/parsers/directives/misc.py:
446   - Added ``start-line`` and ``end-line`` options to "include"
447     directive to select a range of lines.
448   - Hard tabs in literal inclusions are replaced by spaces. This is
449     configurable via the new ``tab-width`` option of the "include" directive
450     (a negative tab-width prevents tab expansion).
452 * docutils/utils.py:
454   - Add ``get_stylesheet_list`` function.
455   - Apply [ 2834836 ] print info at halt
457 * docutils/transforms/universal.py:
459   - Raise default priority of StripClasses to exclude stripped classes from
460     the ToC.
462 * docutils/writers/html4css1/__init__.py:
464   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
465     separated list of stylesheets.
466   - Address [ 1938891 ] Inline literal text creates "pre" span only when
467     needed to prevent inter-word line wraps.
468   - Use `translate` method instead of repeated `replace` calls.
469   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
470     classes to allow CSS styling that does not interfere with other
471     table-using constructs (field lists, citations, ...).
473 * docutils/writers/newlatex2e/__init__.py:
475   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
477 * docutils/writers/latex2e/__init__.py (see also
478   `<docs/user/docutils-05-compat.sty.html>`__) :
480   - Add ``--embed-stylesheet`` option.
481   - Apply [ 1474017 ] image vertical alignment is reversed.
482   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
483   - Change: has_key for dictionaries (not Nodes) to in-operator.
484   - Merge adjacent citations into one latex cite command.
485   - Failsave implementation of custom roles. LaTeX compilation now ignores
486     unknown classes instead of aborting with an error.
487   - Support custom roles based on standard roles.
488   - LaTeX packages can be used as ``--stylesheet`` arguments without
489     restriction. (A style sheet is now referenced with the ``\usepackage``
490     command, if it ends with ``.sty`` or has no extension.)
491   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
492   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
493   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
494     2005-02-04 as a configurable length unit).
495   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
496     if font-encoding is set to ''. LaTeX defaults to OT1 then.
497   - Set sub- and superscript role argument in text mode not as math.
498     Use a custom role based on sub-/superscript if you want italic shape.
499   - Shorter preamble and less dependencies: Load packages and define macros
500     only if required in the document.
501   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
502   - New custom environments and commands with optional "classes" argument.
503   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
504   - Better conformance to Docutils specifications with ``--use-latex-toc``.
505     Support for LaTeX generated ToC also with unnumbered sections.
506   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
507     section numbering by LaTeX.
508   - Use default font in admonitions and sidebar.
509   - Align of image in a figure defaults to 'center'.
510   - Bugfix: Newlines around targets and references prevent run-together
511     paragraphs.
512   - Fix internal hyperlinks.
513   - Use class defaults for page margins ('typearea' now optional).
514   - Float placement made configurable, default changed to "here definitely".
515   - Typeset generic topic as "quote block with title".
516   - Use template (file and configuration option).
517   - In the default template, load cmap.sty (fix text extraction in PDF) and
518     fixltx2e.sty (LaTeX patches, \textsubscript).
519   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
520   - Use `translate` instead of repeated `replace` calls for text encoding.
521   - Hyperlinked footnotes and support for symbol footnotes and
522     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
523   - Complete pairs of binary options
524     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
525     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
526   - New defaults:
527     - font-encoding: "T1" (formerly implicitely set by 'ae').
528     - use-latex-toc: true (ToC with page numbers).
529     - use-latex-footnotes: true (no mixup with figures).
531 * docutils/writers/manpage.py
533   - Do not print version at document end, this is done by the viewer.
534   - Do not print date at document end, this is done by the viewer.
535   - Fix storage of docinfo fields for none standard fields.
537 * docutils/tools/rst2man.py
539 Release 0.5 (2008-06-25)
540 ========================
542 * docutils/languages/he.py: Added to project: Hebrew mappings by
543   Meir Kriheli.
545 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
546   mappings by Meir Kriheli.
548 * docutils/frontend.py:
550   - Configuration files are now assumed and required to be
551     UTF-8-encoded.
552   - Paths of applied configuration files are now recorded in the
553     runtime setting ``_config_files`` (accessible via
554     ``--dump-settings``).
555   - Added ``--strip-elements-with-class`` and ``--strip-class``
556     options (``strip_elements_with_classes`` and ``strip_classes``
557     settings).
559 * docutils/io.py:
561   - Added code to determine the input encoding from data: encoding
562     declarations or the presence of byte order marks (UTF-8 & UTF-16).
563   - Added support for IronPython 1.0.
565 * docutils/nodes.py:
567   - Added ``document.__getstate__`` method, for pickling.
569 * docutils/parsers/rst/states.py:
571   - Allow ``+`` and ``:`` in reference names.
572   - Unquoted targets beginning with an underscore (``.. __target:
573     URI``) are no longer accepted.
574   - Added support for multiple attributions in a physical block quote
575     (indented text block), dividing it into multiple logical block
576     quotes.
577   - Added support for unicode bullets in bullet lists: "•", "‣", and
578     "⁃".
579   - Added support for new object-oriented directive interface,
580     retaining compatibility to the old functional interface.
581   - Added support for throwing ``DirectiveError``'s from within
582     directive code.
584 * docutils/parsers/rst/__init__.py:
586   - Added ``Directive`` base class.
587   - Added ``DirectiveError`` base class.
588   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
589     definitions.
591 * docutils/parsers/directives/:
593   - Refactored all reStructuredText directives to use the new
594     object-oriented directive interface.  Errors are now (mostly)
595     thrown using the new ``DirectiveError`` class.
597 * docutils/parsers/directives/misc.py:
599   - Added ``start-after`` and ``end-before`` options to ``include``
600     directive; thanks to Stefan Rank.
602 * docutils/transforms/universal.py:
604   - Added ``StripClassesAndElements`` transform to remove from the
605     document tree all elements with classes in
606     ``settings.strip_elements_with_classes`` and all "classes"
607     attribute values in ``self.document.settings.strip_classes``.
609 * docutils/transforms/writer_aux.py:
611   - Added ``Admonitions`` transform to transform specific admonitions
612     (like ``note``, ``warning``, etc.) into generic admonitions with a
613     localized title.
615 * docutils/writers/html4css1/__init__.py:
617   - Moved template functionality from the PEP/HTML writer here.
618   - Expanded the fragments available in the ``parts`` attribute.
619   - Moved ``id`` attributes from titles to surrounding ``div``
620     elements.
621   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
622     universally supported now).
623   - ``template.txt`` is now opened in text mode instead of binary mode
624     (to ensure Windows compatibility).
625   - ``a`` elements now have an "internal" or "external" class,
626     depending on reference type.
628 * docutils/writers/html4css1/template.txt: Added to project.
630 * docutils/writers/pep_html/:
632   - Moved template functionality to the HTML writer.
634 * docutils/writers/s5_html/__init__.py:
636   - Added ``view_mode`` & ``hidden_controls`` settings
637     (``--view-mode`` & ``--hidden-controls/--visible-controls``
638     options).
640 * docutils/writers/latex2e/__init__.py:
642   - Add ``--literal-block-env``
643   - Fix: escaping ``%`` in href urls.
644   - Move usepackage hyperref after stylesheet inclusion.
645   - Fix: scrartcl does not have chapter but scrreprt.
646   - Add newline after ``\end{verbatim}``.
647   - Merge smaller differences from latex2e_adaptive_preamble.
648   - Add ``use-part-section``.
649   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
650   - Using leavemode option_list no longer needs to check if parent
651     is a definition list.
652   - Append ``\leavemode`` to definition list terms.
653   - No longer write visit\_/depart_definition_list_item comments to
654     output.
655   - Table column width with 3 decimal places.
656   - Add table stubs support (boldfont).
657   - Add assemble_parts to writer.
658   - Add simply support for nested tables.
659   - Fix verbatim in tables if use-verbatim-when-possible.
660   - Use section commands down to subparagraph.
661   - Put ensuremath around some latin1 chars.
662   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
663   - New option ``--use-bibtex=style,db1,db2``.
664   - New option ``--reference-label`` to allow usage of LaTeX ref for
665     labels in section references.
666   - Add a label after every section to support sectionnumbers as reference
667     labels.
668   - Fix: bug# 1605376 rst2latex: bad options group list
669   - Remove inactive code for use_optionlist_for_option_list.
670   - Remove latex comments from option_list output.
671   - Fix: bug# 1612270 double qoutes in italian literal.
672   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
673   - Add option --use-latex-abstract.
674   - Image width unit ``px`` is translated to ``pt``.
675   - Add image height support.
676   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
677     bug #1457388
678   - Fix: Do not escape underscores in citation reference labels if
679     use-latex-citations is set.
680   - Use centering instead of center for figure contents, to avoid vertical
681     space.
682   - Recognize table class: borderless, nolines, booktabs, standard.
683   - Fix: Renaming contents section does not work with latex writer; SF
684     bug #1487405.
685   - Applied patch for custom roles with classes from Edward Loper.
686   - Fixed bug that caused crashes with more than 256 lists.
688 * docutils/writers/pep_html/__init__.py:
690   - Changed to support new python.org website structure and
691     pep2pyramid.py.
693 * docs/howto/security.txt: "Deploying Docutils Securely", added to
694   project.
696 * tools/buildhtml.py:
698   -- Added ``ignore`` setting to exclude a list of shell patterns
699      (default: ``.svn:CVS``).
701 * tools/editors/emacs/rst.el:
703   - Changed license to "GPL".
704   - Added ``rst-straighten-decorations`` function.
705   - The ``compile`` module is now always loaded.
706   - Added ``rst-toggle-line-block`` function.
707   - Headings consisting only of non-ASCII characters are now
708     recognized by ``rst-toc`` and ``rst-adjust``.
709   - Added font-lock support for multi-line comments where the first
710     comment line is empty.
711   - Added ``(require 'font-lock)``.
713 * setup.py:
715   - Provide descriptive error message if distutils is missing.
718 Release 0.4 (2006-01-09)
719 ========================
721 * General:
723   - Updated the project policies for trunk/branch development &
724     version numbering.
726 * docutils/__init__.py:
728   - Added ``__version_details__`` attribute to describe code source
729     (repository/snapshot/release).
730   - Replaced ``default_transforms`` attribute of TransformSpec with
731     ``get_transforms()`` method.
733 * docutils/core.py:
735   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
736     functions, for document tree extraction and reprocessing.
738 * docutils/io.py:
740   - Added ``DocTreeInput`` class, for reprocessing existing documents.
741   - Added support for non-Unicode (e.g. binary) writer output.
743 * docutils/nodes.py:
745   - Re-introduced ``Targetable.indirect_reference_name``, for
746     MoinMoin/reST compatibility (removed in r3124/r3129).
747   - Added ``serial_escape`` function; escapes string values that are
748     elements of a list, for serialization.  Modified Docutils-XML
749     writing (``Element._dom_node``) and pseudo-XML writing
750     (``Element.starttag``) to use ``serial_escape``.
751   - Added ``Node.deepcopy()`` method.
752   - Removed the internal lists ``document.substitution_refs``,
753     ``document.anonymous_refs``, and ``document.anonymous_targets``.
754   - Added a "container" element.
755   - Fixed bug where values of list-valued attributes of elements
756     originating from custom interpreted text roles (i.e., with custom
757     classes) were being shared between element instances.  Reported by
758     Shmuel Zeigerman.
760 * docutils/statemachine.py:
762   - Added trailing whitespace stripping to ``string2lines()``.
763   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
764     Asian double-width character support.
766 * docutils/utils.py:
768   - Added ``east_asian_column_width()`` for double-width character
769     support.
771 * docutils/languages/ja.py: Added to project: Japanese mappings by
772   Hisashi Morita.
774 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
775   mappings by Panjunyong.
777 * docutils/parsers/null.py: Added to project; a do-nothing parser.
779 * docutils/parsers/rst/__init__.py:
781   - Added validator to tab_width setting, with test.  Closes SF bug
782     #1212515, report from Wu Wei.
784 * docutils/parsers/rst/states.py:
786   - Fixed bug with escaped colons indicating a literal block.
787   - Fixed bug with enumerated lists (SF#1254145).
788   - Backslash-escaped colons inside of field names are now allowed.
789   - Targets (implicit and explicit), anonymous hyperlink references
790     and auto-numbered footnote references inside of substitution
791     definitions are now disallowed.
792   - Fixed bug: list items with blank first lines.
793   - Fixed bug: block quote attributions with indented second lines.
794   - Added East Asian double-width character support (Python 2.4 only).
796 * docutils/parsers/rst/tableparser.py:
798   - Added East Asian double-width character support (Python 2.4 only).
800 * docutils/parsers/rst/directives/body.py:
802   - Added the "container" directive.
804 * docutils/parsers/rst/directives/misc.py:
806   - Added the "default-role", "title", and "date" directives.
807   - Added standard data file syntax to the "include" directive.
808   - Added support for "class" directive content.
810 * docutils/parsers/rst/directives/images.py:
812   - Added ``indirect_reference_name`` support for images with a target
813     option.
814   - Added support for image width and height units.
815   - Fixed bug with image "target" options.
817 * docutils/parsers/rst/directives/references.py:
819   - Added "class" attribute to "target-notes" directive, for
820     footnote_reference classes.
822 * docutils/parsers/rst/include/: Directory added to project; contains
823   standard data files for the "include" directive.  Initial contents:
824   character entity substitution definition sets, and a set of
825   definitions for S5/HTML presentations.
827 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
828   mappings by David Goodger.
830 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
831   Simplified Chinese mappings by Panjunyong.
833 * docutils/readers/__init__.py:
835   - Added universal.Decorations and universal.ExposeInternals
836     transforms as default transforms for all readers.
837   - Added ``ReReader`` base class for readers that reread an existing
838     document tree.
840 * docutils/readers/doctree.py: Added to project; a reader for existing
841   document trees.
843 * docutils/transforms/frontmatter.py:
845   - Fixed the DocInfo transform to handle SVN-style expansion of the
846     "Date" keyword.
847   - In ``DocInfo.extract_authors``, treat the contents of "authors"
848     fields uniformly.
850 * docutils/transforms/misc.py:
852   - Added misc.Transitions transform, extracted from
853     universal.FinalChecks.
855 * docutils/transforms/references.py:
857   - Added references.DanglingReferences transform, extracted from
858     universal.FinalChecks.
859   - Fixed bug with doubly-indirect substitutions.
860   - Added footnote_reference classes attribute to "TargetNotes".
861   - Fixed bug with circular substitution definitions that put Docutils
862     into an infinite loop.
864 * docutils/transforms/universal.py:
866   - Added universal.ExposeInternals transform, extracted from
867     universal.FinalChecks.
868   - Removed universal.FinalChecks transform (logic has been moved to
869     several new transforms).
870   - Fixed bug with the "expose_internals" setting and Text nodes
871     (exposed by the "rawsource" internal attribute).
872   - Added the universal.StripComments transform, implementation of the
873     "strip_comments" setting.
875 * docutils/transforms/writer_aux.py: Added to project; auxiliary
876   transforms for writers.
878   - Added ``Compound`` transform, which flattens compound paragraphs.
880 * docutils/writers/: Several writer modules (html4css1.py) were
881   converted into packages.  Support modules and data files have been
882   moved into the packages.  The stylesheets for the HTML writers are
883   now installed along with the code, the code knows where to find
884   them, and the default is to use them (actually, to embed them).
885   Some adjustments to configuration files may be necessary.  The
886   easiest way to obtain the new default behavior is to remove all
887   settings whose name includes "stylesheet".
889 * docutils/writers/__init__.py:
891   - Added universal.Messages and universal.FilterMessages transforms
892     as default transforms for all writers.
893   - Added ``UnfilteredWriter`` base class for writers that pass the
894     document tree on unchanged.
896 * docutils/writers/docutils_xml.py:
898   - Made ``xmlcharrefreplace`` the default output encoding error
899     handler.
901 * docutils/writers/html4css1/:
903   - Added support for image width and height units.
904   - Made ``xmlcharrefreplace`` the default output encoding error
905     handler.
906   - Made ``--embed-stylesheet`` the default rather than
907     ``--link-stylesheet``.
908   - Moved "id" attribute from container (section etc.) to title's <a>
909     tag, to be on the same tag as "name".
910     (!!! To be reverted in Docutils 0.5.)
911   - Added vertical space between fields of field lists.
912   - Added ``--compact-field-lists`` option to remove vertical space in
913     simple field lists.
914   - Made cloaking of email addresses with ``--cloak-email-addresses``
915     less obtrusive.
916   - Fixed support for centered images.
917   - Added support for class="compact" & class="open" lists.
919 * docutils/writers/latex2e/:
921   - Underscores in citekeys are no longer escaped.
923 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
924   mapping of Unicode characters to LaTeX equivalents.
926 * docutils/writers/s5_html/: Package added to project; writer for
927   S5/HTML slide shows.
929 * docs/dev/distributing.txt: Added to project; guide for distributors
930   (package maintainers).
932 * docs/dev/hacking.txt: Added to project; guide for developers.
934 * docs/ref/doctree.txt:
936   - Updated for plural attributes "classes", "ids", "names",
937     "dupnames".
938   - Added the "container" element.
940 * docs/ref/docutils.dtd:
942   - Updated for plural attributes "classes", "ids", "names",
943     "dupnames".
945 * docs/user/emacs.txt: Added to project; a document about Emacs
946   support for reStructuredText and Docutils.
948 * docs/user/links.txt: Added to project; lists of Docutils-related
949   links.
951 * docs/user/mailing-lists.txt: Added to project; information about
952   Docutils-related mailing lists and how to access them.
954 * docs/user/slide-shows.txt: Added to project; example of and docs for
955   the S5/HTML writer (``rst2s5.py`` front end).
957 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
958   Files", added to project.
960 * test/coverage.sh: Added to project; test coverage script.
962 * test/DocutilsTestSupport.py:
964   - Added support for specifying runtime settings at the suite level.
966 * test/test_functional.py:
968   - Added the ``clear_output_directory`` function.
969   - Added support for ``_test_more`` functions in functional test
970     config files.
972 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
974 * tools/rstpep2html.py: Renamed from pep.py.
976 * tools/dev/create_unimap.py: Added to project; script to create the
977   docutils/writers/unimap_latex.py mapping file.
979 * tools/dev/profile_docutils.py: Added to project; profiler script.
981 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
983 * tools/editors/emacs/restructuredtext.el,
984   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
985   Removed from project; the functionality is now contained in rst.el.
987 * tools/editors/emacs/rst.el: Added to project.  Added many features
988   and fixed many bugs.  See docs/user/emacs.txt for details.
990 * tools/stylesheets: Removed from project.  Stylesheets have been
991   renamed and moved into writer packages.
994 Release 0.3.9 (2005-05-26)
995 ==========================
997 * General:
999   - Eliminated and replaced all uses of the old string attributes
1000     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1001     new list attributes ``ids``, ``names``, ``dupnames`` and
1002     ``classes`` throughout the whole source tree.
1004 * docutils/core.py:
1006   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1007     allowing for easier debugging.
1008   - In ``Publisher.publish()``, expanded the generic top-level
1009     exception catching.
1011 * docutils/examples.py:
1013   - Added ``internals`` function for exploration.
1015 * docutils/io.py:
1017   - Fixed ``Input.decode`` method to apply heuristics only if no
1018     encoding is explicitly given, and to provide better reporting of
1019     decoding errors.
1020   - The ``Input.decode`` method now removes byte order marks (BOMs)
1021     from input streams.
1023 * docutils/nodes.py:
1025   - ``image`` element class changed to subclass of Element, not
1026     TextElement (it's an empty element, and cannot contain text).
1027   - Added ``attr_defaults`` dictionary for default attribute values.
1028   - Added empty list as default value for the following attributes:
1029     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1030   - Added ``document.decoration`` attribute,
1031     ``document.get_decoration`` method, and ``decoration.get_header``
1032     & ``.get_footer`` methods.
1033   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1034     methods.
1036 * docutils/utils.py:
1038   - Removed ``docutils.utils.Reporter.categories``,
1039     ``docutils.utils.ConditionSet``, and all references to them, to
1040     simplify error reporting.
1042 * docutils/languages/nl.py: Added to project; Dutch mappings by
1043   Martijn Pieters.
1045 * docutils/parsers/rst/__init__.py:
1047   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1049 * docutils/parsers/rst/states.py:
1051   - Added check for escaped at-mark to prevent email address recognition.
1052   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1053     arguments>``.
1054   - Allowed whitespace in paths and URLs.
1055   - Added auto-enumerated list items.
1056   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1057     followed by text.
1058   - Added support for table stub columns.
1060 * docutils/parsers/rst/directives/__init__.py:
1062   - Allowed whitespace in paths (``path`` function).
1063   - Added ``uri`` directive option conversion function.
1065 * docutils/parsers/rst/directives/body.py:
1067   - Fixed illegal context bug with "topic" directive (allowed within
1068     sidebars; not within body elements).
1070 * docutils/parsers/rst/directives/images.py:
1072   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1073   - Added support for the ``file_insertion_enabled`` setting in the
1074     "figure" directive (disables "figwidth" option).
1075   - "image" directive: added checks for valid values of "align" option,
1076     depending on context.  "figure" directive: added specialized
1077     "align" option and attribute on "figure" element.
1078   - Made ":figwidth: image" option of "figure" directive work again.
1079   - Fixed bug with reference names containing uppercase letters
1080     (e.g. ``Name_``) in "target" option of "image" directive.
1082 * docutils/parsers/rst/directives/misc.py:
1084   - Fixed "include" and "raw" directives to catch text decoding
1085     errors.
1086   - Allowed whitespace in "include" & "raw" directive paths.
1087   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1088     settings in "include" & "raw" directives.
1090 * docutils/parsers/rst/directives/parts.py:
1092   - Added "header" & "footer" directives.
1093   - Fixed illegal context bug with "contents" directive (topics
1094     allowed within sidebars; not within body elements).
1096 * docutils/parsers/rst/directives/tables.py:
1098   - Added "list-table" directive.
1099   - Caught empty CSV table bug.
1100   - Added support for the ``file_insertion_enabled`` setting in the
1101     "csv-table" directive.
1102   - Added ``stub-columns`` option to "csv-table" and "list-table"
1103     directives.
1105 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1106   mappings by Martijn Pieters.
1108 * docutils/readers/standalone.py:
1110   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1111     options to activate or deactivate the SectSubTitle transform.
1113 * docutils/transforms/frontmatter.py:
1115   - Added SectSubTitle transform to promote titles of lone
1116     subsections to subtitles.
1118 * docutils/transforms/references.py:
1120   - Fixed mislocated internal targets bug, by propagating internal
1121     targets to the next node, making use of the newly added support
1122     for multiple names and IDs.
1123   - Fixed duplicate footnote label bug.
1124   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1125     transform.
1127 * docutils/writers/html4css1.py:
1129   - Fixed unencoded stylesheet reference bug (characters like "&" in
1130     stylesheet references).
1131   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1132     tags).
1133   - Added support for multiple IDs per node by creating empty ``span``
1134     tags.
1135   - Added the ``field_name_limit`` & ``option_limit`` settings &
1136     support.
1137   - Added support for table stub columns.
1138   - Added support for the ``align`` attribute on ``figure`` elements.
1139   - Added the ``cloak_email_addresses`` setting & support.
1140   - Added ``html_prolog``, ``html_head``, ``html_body``,
1141     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1142     ``docutils.core.publish_parts``.
1143   - Added support for section subtitles.
1145 * docutils/writers/latex2e.py:
1147   - Fixed tables starting with more than one multirow cell.
1148   - Improved --use-latex-docinfo so that organization/contact/address
1149     fields are lumped with the last author field and appear on the
1150     titlepage.
1151   - Made sure the titlepage is always shown with --use-latex-docinfo,
1152     even if the document has no title.
1153   - Made sure that latex doesn't fill in today's date if no date field
1154     was given.
1155   - Added support for section subtitles.
1157 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1158   (under development).
1160 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1162 * docs/api/publisher.txt:
1164   - Added "``publish_parts`` Details" section.
1166 * docutils/dev/repository.txt: Added to project; information about the
1167   Docutils Subversion repository.
1169 * docs/ref/docutils.dtd:
1171   - Added a ``stub`` attribute to the ``colspec`` element via the
1172     ``tbl.colspec.att`` parameter entity.
1173   - Allowed topic elements within sidebars
1174   - Added an ``align`` attribute to the ``figure`` element.
1176 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1177   writer.
1180 Release 0.3.7 (2004-12-24)
1181 ==========================
1183 * docutils/frontend.py:
1185   - Added options: --input-encoding-error-handler,
1186     --record-dependencies, --leave-footnote-reference-space,
1187     --strict-visitor.
1188   - Added command-line and config file support for "overrides" setting
1189     parameter.
1191 * docutils/io.py:
1193   - Added support for input encoding error handler.
1195 * docutils/nodes.py:
1197   - Added dispatch_visit and dispatch_departure methods to
1198     NodeVisitor; useful as a hook for Visitors.
1199   - Changed structure of ``line_block``; added ``line``.
1200   - Added ``compound`` node class.
1201   - Added a mechanism for Visitors to transitionally ignore new node
1202     classes.
1204 * docutils/utils.py:
1206   - Moved ``escape2null`` and ``unescape`` functions from
1207     docutils/parsers/rst/states.py.
1209 * docutils/parsers/rst/roles.py:
1211   - Added "raw" role.
1212   - Changed role function API: the "text" parameter now takes
1213     null-escaped interpreted text content.
1215 * docutils/parsers/rst/states.py:
1217   - Fixed bug where a "role" directive in a nested parse would crash
1218     the parser; the state machine's "language" attribute was not being
1219     copied over.
1220   - Added support for line block syntax.
1221   - Fixed directive parsing bug: argument-less directives didn't
1222     notice that arguments were present.
1223   - Removed error checking for transitions.
1224   - Added support for multiple classifiers in definition list items.
1225   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1226   - Changed role function API: the "text" parameter now takes
1227     null-escaped interpreted text content.
1228   - Empty sections and documents are allowed now.
1230 * docutils/parsers/rst/directives/__init__.py:
1232   - Added ``encoding`` directive option conversion function.
1233   - Allow multiple class names in class_option conversion function.
1235 * docutils/parsers/rst/directives/body.py:
1237   - Converted the line-block directive to use the new structure.
1238   - Extracted the old line-block functionality to the ``block``
1239     function (still used).
1240   - Added ``compound`` directive (thanks to Lea Wiemann).
1242 * docutils/parsers/rst/directives/misc.py:
1244   - Added "encoding" option to "include" and "raw" directives.
1245   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1246   - Allow multiple class names in the "class" directive.
1248 * docutils/parsers/rst/directives/parts.py:
1250   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1251     options.  Thanks to Lele Gaifax.
1253 * docutils/parsers/rst/directives/tables.py:
1255   - Added "encoding" directive to "csv-table" directive.
1256   - Added workaround for lack of Unicode support in csv.py, for
1257     non-ASCII CSV input.
1259 * docutils/transforms/misc.py:
1261   - Fixed bug when multiple "class" directives are applied to a single
1262     element.
1263   - Enabled multiple format names for "raw" directive.
1265 * docutils/transforms/references.py:
1267   - Added support for trimming whitespace from beside substitution
1268     references.
1270 * docutils/transforms/universal.py:
1272   - FinalChecks now checks for illegal transitions and moves
1273     transitions between sections.
1275 * docutils/writers/html4css1.py:
1277   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1278   - "stylesheet" and "stylesheet_path" settings are now mutually
1279     exclusive.
1280   - Added support for the new line_block/line structure.
1281   - --footnote-references now overrides
1282     --trim-footnote-reference-space, if applicable.
1283   - Added support for ``compound`` elements.
1284   - Enabled multiple format names for "raw" directive.
1285   - ``<p>`` tags of a paragraph which is the only visible child of the
1286     document node are no longer stripped.
1287   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1288     new method ``should_be_compact_paragraph()``.
1289   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1290     elements.
1291   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1292     the output if they have their ``class`` attribute set.
1293   - The whole document is now surrounded by a ``<div
1294     class="document">`` element.
1295   - Body-level images are now wrapped by their own ``<div>`` elements,
1296     with image classes copied to the wrapper, and for images which
1297     have the ``:align:`` option set, the surrounding ``<div>`` now
1298     receives a class attribute (like ``class="align-left"``).
1300 * docutils/writers/latex2e.py:
1302   - no newline after depart_term.
1303   - Added translations for some Unicode quotes.
1304   - Added option "font-encoding", made package AE the default.
1305   - "stylesheet" and "stylesheet_path" settings are now mutually
1306     exclusive.
1307   - --footnote-references now overrides
1308     --trim-footnote-reference-space, if applicable.
1309   - The footnote label style now matches the footnote reference style
1310     ("brackets" or "superscript").
1311   - Added support for ``compound`` elements.
1312   - Enabled multiple format names for "raw" directive.
1314 * docs/ref/docutils.dtd:
1316   - Changed structure of the ``line_block`` element; added ``line``.
1317   - Added ``compound`` element.
1318   - Added "ltrim" and "rtrim" attributes to
1319     ``substitution_definition`` element.
1320   - Enabled multiple format names for ``raw`` element.
1321   - Enabled multiple classifiers in ``definition_list_item`` elements.
1323 * docs/ref/rst/directives.txt
1325   - Marked "line-block" as deprecated.
1326   - "Class" directive now allows multiple class names.
1327   - Added "Rationale for Class Attribute Value Conversion".
1328   - Added warning about "raw" overuse/abuse.
1330 * docs/ref/rst/restructuredtext.txt:
1332   - Added syntax for line blocks.
1333   - Definition list items may have multiple classifiers.
1335 * docs/ref/rst/roles.txt:
1337   - Added "raw" role.
1339 * tools/stylesheets/default.css:
1341   - Added support for the new line_block structure.
1342   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1345 Release 0.3.5 (2004-07-29)
1346 ==========================
1348 General:
1350 * _`Documentation cleanup/reorganization`.
1352   - Created new subdirectories of docs/:
1354     * ``docs/user/``: introductory/tutorial material for end-users
1355     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1356     * ``docs/api/``: API reference material for client-developers
1357     * ``docs/ref/``: reference material for all groups
1358     * ``docs/howto/``: for component-developers and core-developers
1359     * ``docs/peps/``: Python Enhancement Proposals
1361   - Moved ``docs/*`` to ``docs/user/``.
1362   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1363     ``spec/`` to ``docs/dev``.
1364   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1365     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1366   - Moved ``alternatives.txt``, and ``problems.txt`` from
1367     ``spec/rst/`` to ``docs/dev/rst/``.
1368   - Moved ``reStructuredText.txt``, ``directives.txt``,
1369     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1370     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1371     ``roles.txt``, ``reStructuredText.txt`` to
1372     ``restructuredtext.txt``.
1373   - Moved ``spec/howto/`` to ``docs/howto``.
1375   In order to keep the CVS history of moved files, we supplied
1376   SourceForge with a `script for modifying the Docutils CVS
1377   repository`__.
1379   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1381   After running the cleanup script:
1383   - Added ``docs/index.txt``.
1384   - Added a ``.htaccess`` file to the ``web`` module, containing
1385     redirects for all old paths to new paths.  They'll preserve
1386     fragments (the "#name" part of a URL), and won't clutter up the
1387     file system, and will correct the URL in the user's browser.
1388   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1389     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1390     the "To Do" list itself in ``docs/dev/todo.txt``.
1391   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1392     section of ``docs/dev/todo.txt``.
1393   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1394   - Added "How To Report Bugs" to ``BUGS.txt``.
1395   - Went through all the sources and docs (including under web/) and
1396     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1397     (Still need to update links in the sandboxes.)
1399 Specific:
1401 * BUGS.txt: Added to project.
1403 * THANKS.txt: Added to project.
1405 * docutils/__init__.py:
1407   - 0.3.4: Post-release.
1409 * docutils/core.py:
1411   - Added special error handling & advice for UnicodeEncodeError.
1412   - Refactored Publisher.publish (simplified exception handling &
1413     extracted debug dumps).
1414   - Renamed "enable_exit" parameter of convenience functions to
1415     "enable_exit_status".
1416   - Enabled traceback (exception propagation) by default in
1417     programmatic convenience functions.
1418   - Now publish_file and publish_cmdline convenience functions return
1419     the encoded string results in addition to their regular I/O.
1420   - Extracted common code from publish_file, publish_string, and
1421     publish_parts, into new publish_programmatically.  Extracted
1422     settings code to ``Publisher.process_programmatic_settings``.
1423   - In Publisher.publish, disabled ``settings_overrides`` when
1424     ``settings`` is supplied; redundant.
1426 * docutils/frontend.py:
1428   - Added help text for "--output-encoding-error-handler" and
1429     "--error-encoding-error-handler".
1430   - Renamed "--exit" to "--exit-status".
1431   - Simplified default-setting code.
1433 * docutils/parsers/rst/__init__.py:
1435   - Added "--pep-base-url" and "--rfc-base-url" options.
1437 * docutils/parsers/rst/states.py:
1439   - Made URI recognition more aggressive and intelligent.
1441 * docutils/parsers/rst/directives/__init__.py:
1443   - Added several directive option conversion functions.
1445 * docutils/parsers/rst/directives/body.py:
1447   - Moved "table" directive to tables.py.
1449 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1450   added to project.
1452 * docutils/writers/latex2e.py:
1454   - Added "--table-style=(standard|booktabs|nolines)"
1455   - figures get "here" option (LaTeX per default puts them at bottom),
1456     and figure content is centered.
1457   - Rowspan support for tables.
1458   - Fix: admonition titles before first section.
1459   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1460   - Replave ``_`` in literal by an underlined blank, because it has the correct
1461     width.
1462   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1463   - A few unicode replacements, if output_encoding != utf
1464   - Add "--graphicx-option".
1465   - Indent literal-blocks.
1466   - Fix: omit ``\maketitle`` when there is no document title.
1468 * docs/index.txt: "Docutils Project Documentation Overview", added to
1469   project.
1471 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1472   Tool", added to project.
1474 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1476 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1478 * docs/dev/policies.txt: Added to project (extracted from
1479   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1481 * docs/dev/release.txt: Added to project (extracted from
1482   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1484 * docs/dev/testing.txt: Added to project.
1486 * docs/dev/website.txt: Added to project (extracted from
1487   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1489 * docs/ref/rst/directives.txt:
1491   - Added directives: "table", "csv-table".
1493 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1494   added to project.  1 page for syntax, and a 1 page reference for
1495   directives and roles.  Source text to be used as-is; not meant to be
1496   converted to HTML.
1498 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1499   with a change of title.
1501 * test/functional/, contents, and test/test_functional.py: Added to
1502   project.
1504 * tools/buildhtml.py: Fixed bug with config file handling.
1506 * tools/html.py: Removed from project (duplicate of rst2html.py).
1508 * tools/pep2html.py: Removed from project (duplicate of Python's
1509   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1510   Docutils-related PEPs in docs/peps/).
1512 * tools/rst2pseudoxml.py: Renamed from publish.py.
1514 * tools/rst2xml.py: Renamed from docutils-xml.py.
1516 * tools/test.txt: Removed from project; moved to
1517   docs/user/rst/demo.txt.
1519 * setup.py: Now also installs ``rst2latex.py``.
1522 Release 0.3.3 (2004-05-09)
1523 ==========================
1525 * docutils/__init__.py:
1527   - 0.3.1: Reorganized config file format (multiple sections); see
1528     docs/config.txt.
1529   - Added unknown_reference_resolvers attribute to TransformSpec.
1530   - 0.3.2: Interpreted text reorganization.
1531   - 0.3.3: Released.
1533 * docutils/core.py:
1535   - Catch system messages to stop tracebacks from parsing errors.
1536   - Catch exceptions during processing report & exit without
1537     tracebacks, except when "--traceback" used.
1538   - Reordered components for OptionParser; application comes last.
1539   - Added "config_section" parameter to several methods and functions,
1540     allowing front ends to easily specify their config file sections.
1541   - Added publish_parts convenience function to allow access to individual
1542     parts of a document.
1544 * docutils/examples.py: Added to project; practical examples of
1545   Docutils client code, to be used as-is or as models for variations.
1547 * docutils/frontend.py:
1549   - Added "--traceback" & "--no-traceback" options ("traceback"
1550     setting).
1551   - Implemented support for config file reorganization:
1552     ``standard_config_files`` moved from ``ConfigParser`` to
1553     ``OptionParser``; added
1554     ``OptionParser.get_config_file_settings()`` and
1555     ``.get_standard_config_settings()``; support for old "[options]"
1556     section (with deprecation warning) and mapping from old to new
1557     settings.
1558   - Reimplemented setting validation.
1559   - Enabled flexible boolean values: yes/no, true/false, on/off.
1560   - Added ``Values``, a subclass of ``optparse.Values``, with support
1561     for list setting attributes.
1562   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1563     thanks to Beni Cherniavsky.
1564   - Added "--no-section-numbering" option.
1566 * docutils/io.py:
1568   - Catch IOErrors when opening source & destination files, report &
1569     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1570     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1572 * docutils/nodes.py:
1574   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1575     method definitions (via ``exec``) to dynamic assignments (via
1576     ``setattr``); thanks to Roman Suzi.
1577   - Encapsulated visitor dynamic assignments in a function; thanks to
1578     Ian Bicking.
1579   - Added indirect_reference_name attribute to the Targetable
1580     class. This attribute holds the whitespace_normalized_name
1581     (contains mixed case) of a target.
1583 * docutils/statemachine.py:
1585   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1586   - Added ``StringList.get_2D_block``.
1588 * docutils/utils.py:
1590   - Added "level" attribute to SystemMessage exceptions.
1592 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1593   Jannie Hofmeyr.
1595 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1596   Blaha.
1598 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1599   Marcelo Huerta San Martin.
1601 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1602   mappings by Lalo Martins.
1604 * docutils/languages/ru.py: Added to project; Russian mappings by
1605   Roman Suzi.
1607 * docutils/parsers/rst/roles.py: Added to project.  Contains
1608   interpreted text role functions, a registry for interpreted text
1609   roles, and an API for adding to and retrieving from the registry.
1610   Contributed by Edward Loper.
1612 * docutils/parsers/rst/states.py:
1614   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1615   - Allowed true em-dash character and "---" as block quote
1616     attribution marker.
1617   - Added support for <angle-bracketed> complex option arguments
1618     (option lists).
1619   - Fixed handling of backslashes in substitution definitions.
1620   - Fixed off-by-1 error with extra whitespace after substitution
1621     definition directive.
1622   - Added inline markup parsing to field lists' field names.
1623   - Added support for quoted (and unindented) literal blocks.
1624     Driven in part by a bribe from Frank Siebenlist (thanks!).
1625   - Parser now handles escapes in URIs correctly.
1626   - Made embedded-URIs' reference text omittable.  Idea from Beni
1627     Cherniavsky.
1628   - Refactored explicit target processing code.
1629   - Added name attribute to references containing the reference name only
1630     through whitespace_normalize_name (no case changes).
1631   - parse_target no longer returns the refname after going through
1632     normalize_name. This is now handled in make_target.
1633   - Fixed bug relating to role-less interpreted text in non-English
1634     contexts.
1635   - Reorganized interpreted text processing; moved code into the new
1636     roles.py module.  Contributed by Edward Loper.
1637   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1638     ``parse_directive_block``.
1640 * docutils/parsers/rst/tableparser.py:
1642   - Reworked for ``StringList``, to support "include" directives in
1643     table cells.
1645 * docutils/parsers/rst/directives/__init__.py:
1647   - Renamed ``unchanged()`` directive option conversion function to
1648     ``unchanged_required``, and added a new ``unchanged``.
1649   - Catch unicode value too high error; fixes bug 781766.
1650   - Beefed up directive error reporting.
1652 * docutils/parsers/rst/directives/body.py:
1654   - Added basic "table" directive.
1656 * docutils/parsers/rst/directives/images.py:
1658   - Added "target" option to "image" directive.
1659   - Added name attribute to references containing the reference name only
1660     through whitespace_normalize_name (no case changes).
1662 * docutils/parsers/rst/directives/misc.py:
1664   - Isolated the import of the ``urllib2`` module; was causing
1665     problems on SourceForge (``libssl.so.2`` unavailable?).
1666   - Added the "role" directive for declaring custom interpreted text
1667     roles.
1669 * docutils/parsers/rst/directives/parts.py:
1671   - The "contents" directive does more work up-front, creating the
1672     "topic" and "title", and leaving the "pending" node for the
1673     transform.  Allows earlier reference resolution; fixes subtle bug.
1675 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1676   mappings by Jannie Hofmeyr.
1678 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1679   mappings by Marek Blaha.
1681 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1682   mappings by Marcelo Huerta San Martin.
1684 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1685   Portuguese mappings by Lalo Martins.
1687 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1688   mappings by Roman Suzi.
1690 * docutils/transforms/parts.py:
1692   - The "contents" directive does more work up-front, creating the
1693     "topic" and "title", and leaving the "pending" node for the
1694     transform.  Allows earlier reference resolution; fixes subtle bug.
1695   - Added support for disabling of section numbering.
1697 * docutils/transforms/references.py:
1699   - Verifying that external targets are truly targets and not indirect
1700     references. This is because we are now adding a "name" attribute to
1701     references in addition to targets. Note sure if this is correct!
1702   - Added code to hook into the unknown_reference_resolvers list for a
1703     transformer in resolve_indirect_target. This allows the
1704     unknown_reference_resolvers to keep around indirect targets which
1705     docutils doesn't know about.
1706   - Added specific error message for duplicate targets.
1708 * docutils/transforms/universal.py:
1710   - Added FilterMessages transform (removes system messages below the
1711     verbosity threshold).
1712   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1713     to FinalCheckVisitor for application-specific handling of
1714     unresolvable references.
1715   - Added specific error message for duplicate targets.
1717 * docutils/writers/__init__.py:
1719   - Added assemble_parts method to the Writer class to allow for
1720     access to a documents individual parts.
1721   - Documented & set default for ``Writer.output`` attribute.
1723 * docutils/writers/html4css1.py:
1725   - Fixed unicode handling of attribute values (bug 760673).
1726   - Prevent duplication of "class" attribute values (bug report from
1727     Kirill Lapshin).
1728   - Improved table grid/border handling (prompted by report from Bob
1729     Marshall).
1730   - Added support for table titles.
1731   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1732     to Darek Suchojad.
1733   - Added functionality to keep track of individual parts of a document
1734     and store them in a dictionary as the "parts" attribute of the writer.
1735     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1736   - Added proper support for the "scale" attribute of the "image"
1737     element.  Contributed by Brent Cook.
1738   - Added ``--initial-header-level`` option.
1739   - Fixed bug: the body_pre_docinfo segment depended on there being a
1740     docinfo; if no docinfo, the document title was incorporated into
1741     the body segment.  Adversely affected the publish_parts interface.
1743 * docutils/writers/latex2e.py:
1745   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1746     about a missing file.
1747   - Added options and support: ``--compound-enumerators``,
1748     ``--section-prefix-for-enumerators``, and
1749     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1750     934322).
1751   - Added option ``--use-verbatim-when-possible``, to avoid
1752     problematic characters (eg, '~' in italian) in literal blocks.
1753   - It's now possible to use four section levels in the `book` and
1754     `report` LaTeX classes.  The default `article` class still has
1755     three levels limit.
1757 * docs/config.txt: "Docutils Configuration Files", added to project.
1758   Moved config file entry descriptions from tools.txt.
1760 * docs/tools.txt:
1762   - Moved config file entry descriptions to config.txt.
1764 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1765   Development".
1767 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1768   Text Roles", added to project.
1770 * spec/rst/reStructuredText.txt:
1772   - Added description of support for <angle-bracketed> complex option
1773     arguments to option lists.
1774   - Added subsections for indented and quoted literal blocks.
1776 * test: Continually adding & updating tests.
1778   - Added test/test_settings.py & test/data/config_*.txt support
1779     files.
1780   - Added test/test_writers/test_htmlfragment.py.
1782 * test/DocutilsTestSupport.py:
1784   - Refactored LaTeX publisher test suite/case class names to make
1785     testing other writers easier.
1786   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1787     to test the processing of HTML fragments which use the new
1788     publish_parts convenience function.
1790 * tools/buildhtml.py:
1792   - Added support for the "--prune" option.
1793   - Removed dependency on pep2html.py; plaintext PEPs no longer
1794     supported.
1796 * tools/docutils.conf:
1798   - Updated for configuration file reorganization.
1800 * tools/rst2html.py:
1802   - copied from tools/html.py
1804 * setup.py:
1806   - added a 'scripts' section to configuration
1807   - added 'tools/rst2html.py' to the scripts section
1810 Release 0.3 (2003-06-24)
1811 ========================
1813 General:
1815 * Renamed "attribute" to "option" for directives/extensions.
1817 * Renamed transform method "transform" to "apply".
1819 * Renamed "options" to "settings" for runtime settings (as set by
1820   command-line options).  Sometimes "option" (singular) became
1821   "settings" (plural).  Some variations below:
1823   - document.options -> document.settings (stored in other objects as
1824     well)
1825   - option_spec -> settings_spec (not directives though)
1826   - OptionSpec -> SettingsSpec
1827   - cmdline_options -> settings_spec
1828   - relative_path_options -> relative_path_settings
1829   - option_default_overrides -> settings_default_overrides
1830   - Publisher.set_options -> Publisher.get_settings
1832 Specific:
1834 * COPYING.txt: Added "Public Domain Dedication".
1836 * FAQ.txt: Frequently asked questions, added to project.
1838 * setup.py:
1840   - Updated with PyPI Trove classifiers.
1841   - Conditional installation of third-party modules.
1843 * docutils/__init__.py:
1845   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1846   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1847   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1848   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1849     option and its effect on the PEP template & writer.
1850   - Bumped version to 0.2.4 due to changes to the PEP template &
1851     stylesheet.
1852   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1853   - Added ``TransformSpec`` class for new transform system.
1854   - Bumped version to 0.2.6 for API changes (renaming).
1855   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1856     convenience functions.
1857   - Added ``Component.component_type`` attribute.
1858   - Bumped version to 0.2.8 because of the internal parser switch from
1859     plain lists to the docutils.statemachine.StringList objects.
1860   - Bumped version to 0.2.9 because of the frontend.py API changes.
1861   - Bumped version to 0.2.10 due to changes to the project layout
1862     (third-party modules removed from the "docutils" package), and
1863     signature changes in ``io.Input``/``io.Output``.
1864   - Changed version to 0.3.0 for release.
1866 * docutils/core.py:
1868   - Made ``publish()`` a bit more convenient.
1869   - Generalized ``Publisher.set_io``.
1870   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1871     parameters; improved its docstring.
1872   - Added ``publish_file()`` and ``publish_string()``.
1873   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1874     out of ``.set_io``.
1875   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1876     "--dump-transforms" hidden options.
1877   - Added ``Publisher.apply_transforms()`` method.
1878   - Added ``Publisher.set_components()`` method; support for
1879     ``publish_*()`` conveninece functions.
1880   - Moved config file processing to docutils/frontend.py.
1881   - Added support for exit status ("exit_level" setting &
1882     ``enable_exit`` parameter for Publisher.publish() and convenience
1883     functions).
1885 * docutils/frontend.py:
1887   - Check for & exit on identical source & destination paths.
1888   - Fixed bug with absolute paths & "--config".
1889   - Set non-command-line defaults in ``OptionParser.__init__()``:
1890     ``_source`` & ``_destination``.
1891   - Distributed ``relative_path_settings`` to components; updated
1892     ``OptionParser.populate_from_components()`` to combine it all.
1893   - Require list of keys in ``make_paths_absolute`` (was implicit in
1894     global ``relative_path_settings``).
1895   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1896     "--dump-settings", and "--dump-transforms" hidden options.
1897   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1898     code, replaced with correct code.
1899   - Added validation functionality for config files.
1900   - Added "--error-encoding" option/setting, "_disable_config"
1901     internal setting.
1902   - Added encoding validation; updated "--input-encoding" and
1903     "--output-encoding"; added "--error-encoding-error-handler" and
1904     "--output-encoding-error-handler".
1905   - Moved config file processing from docutils/core.py.
1906   - Updated ``OptionParser.populate_from_components`` to handle new
1907     ``SettingsSpec.settings_defaults`` dict.
1908   - Added support for "-" => stdin/stdout.
1909   - Added "exit_level" setting ("--exit" option).
1911 * docutils/io.py:
1913   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1914   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1915   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1916   - ``FileOutput.write()`` now returns the encoded output string.
1917   - Try to get path/stream name automatically in ``FileInput`` &
1918     ``FileOutput``.
1919   - Added defaults for source & destination paths.
1920   - Allow for Unicode I/O with an explicit "unicode" encoding.
1921   - Added ``Output.encode()``.
1922   - Removed dependency on runtime settings; pass encoding directly.
1923   - Recognize Unicode strings in ``Input.decode()``.
1924   - Added support for output encoding error handlers.
1926 * docutils/nodes.py:
1928   - Added "Invisible" element category class.
1929   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1930     modification during a traversal.
1931   - Added element classes: ``line_block``, ``generated``, ``address``,
1932     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1933     ``superscript``, ``subscript``, ``inline``
1934   - Added support for lists of nodes to ``Element.insert()``.
1935   - Fixed parent linking in ``Element.replace()``.
1936   - Added new abstract superclass ``FixedTextElement``; adds
1937     "xml:space" attribute.
1938   - Added support for "line" attribute of ``system_message`` nodes.
1939   - Added support for the observer pattern from ``utils.Reporter``.
1940     Added ``parse_messages`` and ``transform_messages`` attributes to
1941     ``document``, removed ``messages``.  Added ``note_parse_message``
1942     and ``note_transform_message`` methods.
1943   - Added support for improved diagnostics:
1945     - Added "document", "source", and "line" internal attributes to
1946       ``Node``, set by ``Node.setup_child()``.
1947     - Converted variations on ``node.parent = self`` to
1948       ``self.setup_child(node)``.
1949     - Added ``document.current_source`` & ``.current_line``
1950       attributes, and ``.note_source`` observer method.
1951     - Changed "system_message" output to GNU-Tools format.
1953   - Added a "rawsource" attribute to the ``Text`` class, for text
1954     before backslash-escape resolution.
1955   - Support for new transform system.
1956   - Reworked ``pending`` element.
1957   - Fixed XML DOM bug (SF #660611).
1958   - Removed the ``interpeted`` element class and added
1959     ``title_reference``, ``abbreviation``, ``acronym``.
1960   - Made substitutions case-sensitive-but-forgiving; moved some code
1961     from the parser.
1962   - Fixed Unicode bug on element attributes (report: William Dode).
1964 * docutils/optik.py: Removed from project; replaced with
1965   extras/optparse.py and extras/textwrap.py.  These will be installed
1966   only if they're not already present in the Python installation.
1968 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1969   only if it's not already present in the Python installation.
1971 * docutils/statemachine.py:
1973   - Factored out ``State.add_initial_transitions()`` so it can be
1974     extended.
1975   - Converted whitespace-specific "blank" and "indent" transitions
1976     from special-case code to ordinary transitions: removed
1977     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1978     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1979     ``ws_initial_transitions`` attributes.
1980   - Removed ``State.match_transition()`` after merging it into
1981     ``.check_line()``.
1982   - Added ``StateCorrection`` exception.
1983   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1984     (moved ``TransitionCorrection`` support there too.)
1985   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1986     ``EOFError`` instead of ``IndexError``.
1987   - Added ``State.no_match`` method.
1988   - Added support for the Observer pattern, triggered by input line
1989     changes.
1990   - Added ``strip_top`` parameter to
1991     ``StateMachineWS.get_first_known_indented``.
1992   - Made ``context`` a parameter to ``StateMachine.run()``.
1993   - Added ``ViewList`` & ``StringList`` classes;
1994     ``extract_indented()`` becomes ``StringList.get_indented()``.
1995   - Added ``StateMachine.insert_input()``.
1996   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1997     thanks to) Fred Drake.
1999 * docutils/utils.py:
2001   - Added a ``source`` attribute to Reporter instances and
2002     ``system_message`` elements.
2003   - Added an observer pattern to ``utils.Reporter`` to keep track of
2004     system messages.
2005   - Fixed bugs in ``relative_path()``.
2006   - Added support for improved diagnostics.
2007   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2008   - Added support for encoding Reporter stderr output, and encoding
2009     error handlers.
2010   - Reporter keeps track of the highest level system message yet
2011     generated.
2013 * docutils/languages: Fixed bibliographic field language lookups.
2015 * docutils/languages/es.py: Added to project; Spanish mappings by
2016   Marcelo Huerta San Martin.
2018 * docutils/languages/fr.py: Added to project; French mappings by
2019   Stefane Fermigier.
2021 * docutils/languages/it.py: Added to project; Italian mappings by
2022   Nicola Larosa.
2024 * docutils/languages/sk.py: Added to project; Slovak mappings by
2025   Miroslav Vasko.
2027 * docutils/parser/__init__.py:
2029   - Added ``Parser.finish_parse()`` method.
2031 * docutils/parser/rst/__init__.py:
2033   - Added options: "--pep-references", "--rfc-references",
2034     "--tab-width", "--trim-footnote-reference-space".
2036 * docutils/parsers/rst/states.py:
2038   - Changed "title under/overline too short" system messages from INFO
2039     to WARNING, and fixed its insertion location.
2040   - Fixed enumerated list item parsing to allow paragraphs & section
2041     titles to begin with enumerators.
2042   - Converted system messages to use the new "line" attribute.
2043   - Fixed a substitution reference edge case.
2044   - Added support for "--pep-references" and "--rfc-references"
2045     options; reworked ``Inliner`` code to make customization easier.
2046   - Removed field argument parsing.
2047   - Added support for short section title over/underlines.
2048   - Fixed "simple reference name" regexp to ignore text like
2049     "object.__method__"; not an anonymous reference.
2050   - Added support for improved diagnostics.
2051   - Reworked directive API, based on Dethe Elza's contribution.  Added
2052     ``Body.parse_directive()``, ``.parse_directive_options()``,
2053     ``.parse_directive_arguments()`` methods.
2054   - Added ``ExtensionOptions`` class, to parse directive options
2055     without parsing field bodies.  Factored
2056     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2057     ``ExtensionOptions``.
2058   - Improved definition list term/classifier parsing.
2059   - Added warnings for unknown directives.
2060   - Renamed ``Stuff`` to ``Struct``.
2061   - Now flagged as errors: transitions at the beginning or end of
2062     sections, empty sections (except title), and empty documents.
2063   - Updated for ``statemachine.StringList``.
2064   - Enabled recognition of schemeless email addresses in targets.
2065   - Added support for embedded URIs in hyperlink references.
2066   - Added backslash-escapes to inline markup end-string suffix.
2067   - Added support for correct interpreted text processing.
2068   - Fixed nested title parsing (topic, sidebar directives).
2069   - Added special processing of backslash-escaped whitespace (idea
2070     from David Abrahams).
2071   - Made substitutions case-sensitive-but-forgiving; moved some code
2072     to ``docutils.nodes``.
2073   - Added support for block quote attributions.
2074   - Added a kludge to work-around a conflict between the bubble-up
2075     parser strategy and short titles (<= 3 char-long over- &
2076     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2077     titles" submitted by Jason Diamond.
2078   - Added explicit interpreted text roles for standard inline markup:
2079     "emphasis", "strong", "literal".
2080   - Implemented "superscript" and "subscript" interpreted text roles.
2081   - Added initial support for "abbreviation" and "acronym" roles;
2082     incomplete.
2083   - Added support for "--trim-footnote-reference-space" option.
2084   - Optional space before colons in directives & hyperlink targets.
2086 * docutils/parsers/rst/tableparser.py:
2088   - Fixed a bug that was producing unwanted empty rows in "simple"
2089     tables.
2090   - Detect bad column spans in "simple" tables.
2092 * docutils/parsers/rst/directives: Updated all directive functions to
2093   new API.
2095 * docutils/parsers/rst/directives/__init__.py:
2097   - Added ``flag()``, ``unchanged()``, ``path()``,
2098     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2099     directive option helper functions.
2100   - Added warnings for unknown directives.
2101   - Return ``None`` for missing directives.
2102   - Added ``register_directive()``, thanks to William Dode and Paul
2103     Moore.
2105 * docutils/parsers/rst/directives/admonitions.py:
2107   - Added "admonition" directive.
2109 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2110   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2111   "parsed-literal", "rubric", "epigraph", "highlights" and
2112   "pull-quote" directives.
2114 * docutils/parsers/rst/directives/images.py:
2116   - Added an "align" attribute to the "image" & "figure" directives
2117     (by Adam Chodorowski).
2118   - Added "class" option to "image", and "figclass" to "figure".
2120 * docutils/parsers/rst/directives/misc.py:
2122   - Added "include", "raw", and "replace" directives, courtesy of
2123     Dethe Elza.
2124   - Added "unicode" and "class" directives.
2126 * docutils/parsers/rst/directives/parts.py:
2128   - Added the "sectnum" directive; by Dmitry Jemerov.
2129   - Added "class" option to "contents" directive.
2131 * docutils/parsers/rst/directives/references.py: Added to project.
2132   Contains the "target-notes" directive.
2134 * docutils/parsers/rst/languages/__init__.py:
2136   - Return ``None`` from get_language() for missing language modules.
2138 * docutils/parsers/rst/languages/de.py: Added to project; German
2139   mappings by Engelbert Gruber.
2141 * docutils/parsers/rst/languages/en.py:
2143   - Added interpreted text roles mapping.
2145 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2146   mappings by Marcelo Huerta San Martin.
2148 * docutils/parsers/rst/languages/fr.py: Added to project; French
2149   mappings by William Dode.
2151 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2152   mappings by Nicola Larosa.
2154 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2155   mappings by Miroslav Vasko.
2157 * docutils/readers/__init__.py:
2159   - Added support for the observer pattern from ``utils.Reporter``, in
2160     ``Reader.parse`` and ``Reader.transform``.
2161   - Removed ``Reader.transform()`` method.
2162   - Added default parameter values to ``Reader.__init__()`` to make
2163     instantiation easier.
2164   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2166 * docutils/readers/pep.py:
2168   - Added the ``peps.TargetNotes`` transform to the Reader.
2169   - Removed PEP & RFC reference detection code; moved to
2170     parsers/rst/states.py as options (enabled here by default).
2171   - Added support for pre-acceptance PEPs (no PEP number yet).
2172   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2173     easy subclassing.
2175 * docutils/readers/python: Python Source Reader subpackage added to
2176   project, including preliminary versions of:
2178   - __init__.py
2179   - moduleparser.py: Parser for Python modules.
2181 * docutils/transforms/__init__.py:
2183   - Added ``Transformer`` class and completed transform reform.
2184   - Added unknown_reference_resolvers list for each transformer. This list holds
2185     the list of functions provided by each component of the transformer that
2186     help resolve references.
2188 * docutils/transforms/frontmatter.py:
2190   - Improved support for generic fields.
2191   - Fixed bibliographic field language lookups.
2193 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2194   transforms.
2196 * docutils/transforms/parts.py:
2198   - Moved the "id" attribute from TOC list items to the references
2199     (``Contents.build_contents()``).
2200   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2201   - Added "class" attribute support to ``Contents``.
2203 * docutils/transforms/peps.py:
2205   - Added ``mask_email()`` function, updating to pep2html.py's
2206     functionality.
2207   - Linked "Content-Type: text/x-rst" to PEP 12.
2208   - Added the ``TargetNotes`` PEP-specific transform.
2209   - Added ``TargetNotes.cleanup_callback``.
2210   - Added title check to ``Headers``.
2212 * docutils/transforms/references.py:
2214   - Added the ``TargetNotes`` generic transform.
2215   - Split ``Hyperlinks`` into multiple transforms.
2216   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2217   - Added check for circular indirect references.
2218   - Made substitutions case-sensitive-but-forgiving.
2220 * docutils/transforms/universal.py:
2222   - Added support for the "--expose-internal-attributes" option.
2223   - Removed ``Pending`` transform classes & data.
2225 * docutils/writers/__init__.py:
2227   - Removed ``Writer.transform()`` method.
2229 * docutils/writers/docutils-xml.py:
2231   - Added XML and doctype declarations.
2232   - Added "--no-doctype" and "--no-xml-declaration" options.
2234 * docutils/writers/html4css1.py:
2236   - "name" attributes only on these tags: a, applet, form, frame,
2237     iframe, img, map.
2238   - Added "name" attribute to <a> in section titles for Netscape 4
2239     support (bug report: Pearu Peterson).
2240   - Fixed targets (names) on footnote, citation, topic title,
2241     problematic, and system_message nodes (for Netscape 4).
2242   - Changed field names from "<td>" to "<th>".
2243   - Added "@" to "&#64;" encoding to thwart address harvesters.
2244   - Improved the vertical whitespace optimization; ignore "invisible"
2245     nodes (targets, comments, etc.).
2246   - Improved inline literals with ``<span class="pre">`` around chunks
2247     of text and ``&nbsp;`` for runs of spaces.
2248   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2249     ``self.docinfo`` segments.
2250   - Added support for "line_block", "address" elements.
2251   - Improved backlinks (footnotes & system_messages).
2252   - Improved system_message output.
2253   - Redefined "--stylesheet" as containing an invariant URL, used
2254     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2255     working directory.
2256   - Added "--footnote-references" option (superscript or brackets).
2257   - Added "--compact-lists" and "--no-compact-lists" options.
2258   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2259     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2260   - Improved field list rendering.
2261   - Added Docutils version to "generator" meta tag.
2262   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2263   - Improved layout of <pre> HTML source.
2264   - Fixed attribute typo on <colspec>.
2265   - Refined XML prologue.
2266   - Support for no stylesheet.
2267   - Removed "interpreted" element support.
2268   - Added support for "title_reference", "sidebar", "attribution",
2269     "rubric", and generic "admonition" elements.
2270   - Added "--attribution" option.
2271   - Added support for "inline", "subscript", "superscript" elements.
2272   - Added initial support for "abbreviation" and "acronym";
2273     incomplete.
2275 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2276   (from the sandbox).
2278   - Added french.
2279   - Double quotes in literal blocks (special treatment for de/ngerman).
2280   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2281   - Added  "--attribution" option.
2282   - Right align attributions.
2284 * docutils/writers/pep_html.py:
2286   - Parameterized output encoding in PEP template.
2287   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2288   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2289     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2290     working directory.
2291   - Added an override on the "--footnote-references" option.
2292   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2293   - Added Docutils version to "generator" meta tag.
2294   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2296 * docs/tools.txt:
2298   - Added a "silent" setting for ``buildhtml.py``.
2299   - Added a "Getting Help" section.
2300   - Rearranged the structure.
2301   - Kept up to date, with new settings, command-line options etc.
2302   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2303   - Converted settings table into a definition list.
2305 * docs/rst/quickstart.txt:
2307   - Added a table of contents.
2308   - Added feedback information.
2309   - Added mention of minimum section title underline lengths.
2310   - Removed the 4-character minimum for section title underlines.
2312 * docs/rst/quickref.html:
2314   - Added a "Getting Help" section.
2315   - Added a style to make section title backlinks more subtle.
2316   - Added mention of minimum section title underline lengths.
2317   - Removed the 4-character minimum for section title underlines.
2319 * extras: Directory added to project; contains third-party modules
2320   that Docutils depends on (optparse, textwrap, roman).  These are
2321   only installed if they're not already present.
2323 * licenses: Directory added to project; contains copies of license
2324   files for non-public-domain files.
2326 * spec/doctree.txt:
2328   - Changed the focus.  It's about DTD elements:  structural
2329     relationships, semantics, and external (public) attributes.  Not
2330     about the element class library.
2331   - Moved some implementation-specific stuff into ``docutils.nodes``
2332     docstrings.
2333   - Wrote descriptions of all common attributes and parameter
2334     entities.  Filled in introductory material.
2335   - Working through the element descriptions: 55 down, 37 to go.
2336   - Removed "Representation of Horizontal Rules" to
2337     spec/rst/alternatives.txt.
2339 * spec/docutils.dtd:
2341   - Added "generated" inline element.
2342   - Added "line_block" body element.
2343   - Added "auto" attribute to "title".
2344   - Changed content models of "literal_block" and "doctest_block" to
2345     ``%text.model``.
2346   - Added ``%number;`` attribute type parameter entity.
2347   - Changed ``%structural.elements;`` to ``%section.elements``.
2348   - Updated attribute types; made more specific.
2349   - Added "address" bibliographic element.
2350   - Added "line" attribute to ``system_message`` element.
2351   - Removed "field_argument" element; "field_name" may contain
2352     multiple words and whitespace.
2353   - Changed public identifier to docutils.sf.net.
2354   - Removed "interpreted" element; added "title_reference",
2355     "abbreviation", "acronym".
2356   - Removed "refuri" attribute from "footnote_reference" and
2357     "citation_reference".
2358   - Added "sidebar", "rubric", "attribution", "admonition",
2359     "superscript", "subscript", and "inline" elements.
2361 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2363 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2365 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2367 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2368   Dallas Mahrt.
2370 * spec/transforms.txt: Added to project.
2372 * spec/howto: Added subdirectory, for developer how-to docs.
2374 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2375   Elza, edited & extended by David Goodger.
2377 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2378   project.
2380 * spec/rst/alternatives.txt:
2382   - Added "Doctree Representation of Transitions" from
2383     spec/doctree.txt.
2384   - Updated "Inline External Targets" & closed the debate.
2385   - Added ideas for interpreted text syntax extensions.
2386   - Added "Nested Inline Markup" section.
2388 * spec/rst/directives.txt:
2390   - Added directives: "topic", "sectnum", "target-notes",
2391     "line-block", "parsed-literal", "include", "replace", "sidebar",
2392     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2393     "class".
2394   - Formalized descriptions of directive details.
2395   - Added an "align" attribute to the "image" & "figure" directives
2396     (by Adam Chodorowski).
2397   - Added "class" options to "topic", "sidebar", "line-block",
2398     "parsed-literal", "contents", and "image"; and "figclass" to
2399     "figure".
2401 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2402   interpreted text roles.
2404 * spec/rst/introduction.txt:
2406   - Added pointers to material for new users.
2408 * spec/rst/reStructuredText.txt:
2410   - Disambiguated comments (just add a newline after the "::").
2411   - Updated enumerated list description; added a discussion of the
2412     second-line validity checking.
2413   - Updated directive description.
2414   - Added a note redirecting newbies to the user docs.
2415   - Expanded description of inline markup start-strings in non-markup
2416     contexts.
2417   - Removed field arguments and made field lists a generic construct.
2418   - Removed the 4-character minimum for section title underlines.
2419   - Clarified term/classifier delimiter & inline markup ambiguity
2420     (definition lists).
2421   - Added "Embedded URIs".
2422   - Updated "Interpreted Text" section.
2423   - Added "Character-Level Inline Markup" section.
2425 * test: Continually adding & updating tests.
2427   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2428   - Moved test/test_pep/ to test/test_readers/test_pep/.
2429   - Added test/test_readers/test_python/.
2430   - Added test/test_writers/ (Engelbert Gruber).
2432 * tools:
2434   - Made the ``locale.setlocale()`` calls in front ends
2435     fault-tolerant.
2437 * tools/buildhtml.py:
2439   - Added "--silent" option.
2440   - Fixed bug with absolute paths & "--config".
2441   - Updated for new I/O classes.
2442   - Added some exception handling.
2443   - Separated publishers' setting defaults; prevents interference.
2444   - Updated for new ``publish_file()`` convenience function.
2446 * tools/pep-html-template:
2448   - Allow for "--embed-stylesheet".
2449   - Added Docutils version to "generator" meta tag.
2450   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2451   - Conform to XHTML spec.
2453 * tools/pep2html.py:
2455   - Made ``argv`` a parameter to ``main()``.
2456   - Added support for "Content-Type:" header & arbitrary PEP formats.
2457   - Linked "Content-Type: text/plain" to PEP 9.
2458   - Files skipped (due to an error) are not pushed onto the server.
2459   - Updated for new I/O classes.
2460   - Added ``check_requirements()`` & ``pep_type_error()``.
2461   - Added some exception handling.
2462   - Updated for new ``publish_string()`` convenience function.
2463   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2465 * tools/quicktest.py:
2467   - Added "-V"/"--version" option.
2469 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2471 * tools/unicode2rstsubs.py: Added to project.  Produces character
2472   entity files (reSructuredText substitutions) from the MathML master
2473   unicode.xml file.
2475 * tools/editors: Support code for editors, added to project.  Contains
2476   ``emacs/restructuredtext.el``.
2478 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2480   - Added style for chunks of inline literals.
2481   - Removed margin for first child of table cells.
2482   - Right-aligned field list names.
2483   - Support for auto-numbered section titles in TOCs.
2484   - Increased the size of inline literals (<tt>) in titles.
2485   - Restored the light gray background for inline literals.
2486   - Added support for "line_block" elements.
2487   - Added style for "address" elements.
2488   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2489   - Improved field list rendering.
2490   - Vertical whitespace improvements.
2491   - Removed "a.target" style.
2493 * tools/stylesheets/pep.css:
2495   - Fixed nested section margins.
2496   - Other changes parallel those of ``../default.css``.
2499 Release 0.2 (2002-07-31)
2500 ========================
2502 General:
2504 - The word "component" was being used ambiguously.  From now on,
2505   "component" will be used to mean "Docutils component", as in Reader,
2506   Writer, Parser, or Transform.  Portions of documents (Table of
2507   Contents, sections, etc.)  will be called "document parts".
2508 - Did a grand renaming: a lot of ``verylongnames`` became
2509   ``very_long_names``.
2510 - Cleaned up imports: no more relative package imports or
2511   comma-separated lists of top-level modules.
2512 - Added support for an option values object which carries default
2513   settings and overrides (from command-line options and library use).
2514 - Added internal Unicode support, and support for both input and
2515   output encodings.
2516 - Added support for the ``docutils.io.IO`` class & subclasses.
2518 Specific:
2520 * docutils/__init__.py:
2522   - Added ``ApplicationError`` and ``DataError``, for use throughout
2523     the package.
2524   - Added ``Component`` base class for Docutils components; implements
2525     the ``supports`` method.
2526   - Added ``__version__`` (thus, ``docutils.__version__``).
2528 * docutils/core.py:
2530   - Removed many keyword parameters to ``Publisher.__init__()`` and
2531     ``publish()``; bundled into an option values object.  Added
2532     "argv", "usage", "description", and "option_spec" parameters for
2533     command-line support.
2534   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2535     methods.
2536   - Reworked I/O model for ``docutils.io`` wrappers.
2537   - Updated ``Publisher.set_options()``; now returns option values
2538     object.
2539   - Added support for configuration files (/etc/docutils.conf,
2540     ./docutils.conf, ~/.docutils).
2541   - Added ``Publisher.setup_option_parser()``.
2542   - Added default usage message and description.
2544 * docutils/frontend.py: Added to project; support for front-end
2545   (command-line) scripts.  Option specifications may be augmented by
2546   components.  Requires Optik (http://optik.sf.net/) for option
2547   processing (installed locally as docutils/optik.py).
2549 * docutils/io.py: Added to project; uniform API for a variety of input
2550   output mechanisms.
2552 * docutils/nodes.py:
2554   - Added ``TreeCopyVisitor`` class.
2555   - Added a ``copy`` method to ``Node`` and subclasses.
2556   - Added a ``SkipDeparture`` exception for visitors.
2557   - Renamed ``TreePruningException`` from ``VisitorException``.
2558   - Added docstrings to ``TreePruningException``, subclasses, and
2559     ``Nodes.walk()``.
2560   - Improved docstrings.
2561   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2562   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2563     imports.
2564   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2565     ``PreDecorative`` mixin.
2566   - Reworked the name/id bookkeeping; to ``document``, removed
2567     ``explicit_targets`` and ``implicit_targets`` attributes, added
2568     ``nametypes`` attribute and ``set_name_id_map`` method.
2569   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2570     traversals.
2571   - Added ``document.has_name()`` method.
2572   - Fixed DOM generation for list-attributes.
2573   - Added category class ``Labeled`` (used by footnotes & citations).
2574   - Added ``Element.set_class()`` method (sets "class" attribute).
2576 * docutils/optik.py: Added to project.  Combined from the Optik
2577   package, with added option groups and other modifications.  The use
2578   of this module is probably only temporary.
2580 * docutils/statemachine.py:
2582   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2583   - Added underscores to improve many awkward names.
2584   - In ``string2lines()``, changed whitespace normalizing translation
2585     table to regexp; restores Python 2.0 compatibility with Unicode.
2587 * docutils/urischemes.py:
2589   - Filled in some descriptions.
2590   - Added "shttp" scheme.
2592 * docutils/utils.py:
2594   - Added ``clean_rcs_keywords`` function (moved from
2595     docutils/transforms/frontmatter.py
2596     ``DocInfo.filter_rcs_keywords``).
2597   - Added underscores to improve many awkward names.
2598   - Changed names of Reporter's thresholds:
2599     warning_level -> report_level; error_level -> halt_level.
2600   - Moved ``utils.id()`` to ``nodes.make_id()``.
2601   - Added ``relative_path(source, target)``.
2603 * docutils/languages/de.py: German mappings; added to project.  Thanks
2604   to Gunnar Schwant for the translations.
2606 * docutils/languages/en.py: Added "Dedication" bibliographic field
2607   mappings.
2609 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2610   Chodorowski.
2612 * docutils/parsers/rst/states.py:
2614   - Added underscores to improve many awkward names.
2615   - Added RFC-2822 header support.
2616   - Extracted the inline parsing code from ``RSTState`` to a separate
2617     class, ``Inliner``, which will allow easy subclassing.
2618   - Made local bindings for ``memo`` container & often-used contents
2619     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2620   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2621   - Added ``MarkupMismatch`` exception; for late corrections.
2622   - Added ``-/:`` characters to inline markup's start string prefix,
2623     ``/`` to end string suffix.
2624   - Fixed a footnote bug.
2625   - Fixed a bug with literal blocks.
2626   - Applied patch from Simon Budig: simplified regexps with symbolic
2627     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2628   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2629   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2630   - Allowed non-ASCII in "simple names" (directive names, field names,
2631     references, etc.).
2632   - Converted ``Inliner.patterns.initial`` to be dynamically built
2633     from parts with ``build_regexp()`` function.
2634   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2635   - Updated docstrings.
2636   - Changed "table" to "grid_table"; added "simple_table" support.
2638 * docutils/parsers/rst/tableparser.py:
2640   - Changed ``TableParser`` to ``GridTableParser``.
2641   - Added ``SimpleTableParser``.
2642   - Refactored naming.
2644 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2645   a fallback language for directive names.
2647 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2648   directive to use a ``pending`` element, used only by HTML writers.
2650 * docutils/parsers/rst/directives/parts.py: Renamed from
2651   components.py.
2653   - Added "backlinks" attribute to "contents" directive.
2655 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2656   project by Adam Chodorowski.
2658 * docutils/readers/__init__.py: Gave Readers more control over
2659   choosing and instantiating Parsers.
2661 * docutils/readers/pep.py: Added to project; for PEP processing.
2663 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2664   requires a ``component`` parameter.
2666 * docutils/transforms/components.py: Added to project; transforms
2667   related to Docutils components.
2669 * docutils/transforms/frontmatter.py:
2671   - In ``DocInfo.extract_authors``, check for a single "author" in an
2672     "authors" group, and convert it to a single "author" element.
2673   - Added support for "Dedication" and generic bibliographic fields.
2675 * docutils/transforms/peps.py: Added to project; PEP-specific.
2677 * docutils/transforms/parts.py: Renamed from old components.py.
2679   - Added filter for `Contents`, to use alt-text for inline images,
2680     and to remove inline markup that doesn't make sense in the ToC.
2681   - Added "name" attribute to TOC topic depending on its title.
2682   - Added support for optional TOC backlinks.
2684 * docutils/transforms/references.py: Fixed indirect target resolution
2685   in ``Hyperlinks`` transform.
2687 * docutils/transforms/universal.py:
2689   - Changed ``Messages`` transform to properly filter out system
2690     messages below the warning threshold.
2691   - Added ``Decorations`` transform (support for ``--generator``,
2692     ``--date``, ``--time``, ``--source-link`` options).
2694 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2695   Engelbert Gruber's PDF writer.
2697 * docutils/writers/html4css1.py:
2699   - Made XHTML-compatible (switched to lowercase element & attribute
2700     names; empty tag format).
2701   - Escape double-dashes in comment text.
2702   - Improved boilerplate & modularity of output.
2703   - Exposed modular output in Writer class.
2704   - Added a "generator" meta tag to <head>.
2705   - Added support for the ``--stylesheet`` option.
2706   - Added support for ``decoration``, ``header``, and ``footer``
2707     elements.
2708   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2709     translation table to regexp; restores Python 2.0 compatibility
2710     with Unicode.
2711   - Added the translator class as instance variable to the Writer, to
2712     make it easily subclassable.
2713   - Improved option list spacing (thanks to Richard Jones).
2714   - Modified field list output.
2715   - Added backlinks to footnotes & citations.
2716   - Added percentage widths to "<col>" tags (from colspec).
2717   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2718     "<span>" changed to "<var>".
2719   - Inline literals: "<code>" changed to "<tt>".
2720   - Many changes to optimize vertical space: compact simple lists etc.
2721   - Add a command-line options & directive attributes to control TOC
2722     and footnote/citation backlinks.
2723   - Added support for optional footnote/citation backlinks.
2724   - Added support for generic bibliographic fields.
2725   - Identify backrefs.
2726   - Relative URLs for stylesheet links.
2728 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2729   PEPs (subclass of ``html4css1.Writer``).
2731 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2733 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2734   of the Docutils internal doctree in XML.
2736 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2738 * spec/doctree.txt:
2740   - Changed the title to "The Docutils Document Tree".
2741   - Added "Hyperlink Bookkeeping" section.
2743 * spec/docutils.dtd:
2745   - Added ``decoration``, ``header``, and ``footer`` elements.
2746   - Brought ``interpreted`` element in line with the parser: changed
2747     attribute "type" to "role", added "position".
2748   - Added support for generic bibliographic fields.
2750 * spec/notes.txt: Continual updates.  Added "Project Policies".
2752 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2753   section.
2755 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2757 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2758   mailing list discussions.
2760 * spec/pep-0287.txt:
2762   - Renamed to "reStructuredText Docstring Format".
2763   - Minor edits.
2764   - Reworked Q&A as an enumerated list.
2765   - Converted to reStructuredText format.
2767 * spec/pysource.dtd:
2769   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2771 * spec/pysource.txt: Removed from project.  Moved much of its contents
2772   to pep-0258.txt.
2774 * spec/rst/alternatives.txt:
2776   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2777   - Added "Inline External Targets" section.
2779 * spec/rst/directives.txt:
2781   - Added "backlinks" attribute to "contents" directive.
2783 * spec/rst/problems.txt:
2785   - Updated the Enumerated List Markup discussion.
2786   - Added new alternative table markup syntaxes.
2788 * spec/rst/reStructuredText.txt:
2790   - Clarified field list usage.
2791   - Updated enumerated list description.
2792   - Clarified purpose of directives.
2793   - Added ``-/:`` characters to inline markup's start string prefix,
2794     ``/`` to end string suffix.
2795   - Updated "Authors" bibliographic field behavior.
2796   - Changed "inline hyperlink targets" to "inline internal targets".
2797   - Added "simple table" syntax to supplement the existing but
2798     newly-renamed "grid tables".
2799   - Added cautions for anonymous hyperlink use.
2800   - Added "Dedication" and generic bibliographic fields.
2802 * test: Made test modules standalone (subdirectories became packages).
2804 * test/DocutilsTestSupport.py:
2806   - Added support for PEP extensions to reStructuredText.
2807   - Added support for simple tables.
2808   - Refactored naming.
2810 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2812   - Now supports true packages containing test modules
2813     (``__init__.py`` files required); fixes duplicate module name bug.
2815 * test/test_pep/: Subpackage added to project; PEP testing.
2817 * test/test_rst/test_SimpleTableParser.py: Added to project.
2819 * tools:
2821   - Updated html.py and publish.py front-end tools to use the new
2822     command-line processing facilities of ``docutils.frontend``
2823     (exposed in ``docutils.core.Publisher``), reducing each to just a
2824     few lines of code.
2825   - Added ``locale.setlocale()`` calls to front-end tools.
2827 * tools/buildhtml.py: Added to project; batch-generates .html from all
2828   the .txt files in directories and subdirectories.
2830 * tools/default.css:
2832   - Added support for ``header`` and ``footer`` elements.
2833   - Added styles for "Dedication" topics (biblio fields).
2835 * tools/docutils.conf: A configuration file; added to project.
2837 * tools/docutils-xml.py: Added to project.
2839 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2841 * tools/pep-html-template: Added to project.
2843 * tools/pep2html.py: Added to project from Python (nondist/peps).
2844   Added support for Docutils (reStructuredText PEPs).
2846 * tools/quicktest.py:
2848   - Added the ``--attributes`` option, hacked a bit.
2849   - Added a second command-line argument (output file); cleaned up.
2851 * tools/stylesheets/: Subdirectory added to project.
2853 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2856 Release 0.1 (2002-04-20)
2857 ========================
2859 This is the first release of Docutils, merged from the now inactive
2860 reStructuredText__ and `Docstring Processing System`__ projects.  For
2861 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2862 `DPS HISTORY`__ files.
2864 __ http://structuredtext.sourceforge.net/
2865 __ http://docstring.sourceforge.net/
2866 __ http://structuredtext.sourceforge.net/HISTORY.html
2867 __ http://docstring.sourceforge.net/HISTORY.html
2869 General changes: renamed 'dps' package to 'docutils'; renamed
2870 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2871 the test suites (reStructuredText's test/test_states renamed to
2872 test/test_rst); and all modifications required to make it all work.
2874 * docutils/parsers/rst/states.py:
2876   - Improved diagnostic system messages for missing blank lines.
2877   - Fixed substitution_reference bug.
2881    Local Variables:
2882    mode: indented-text
2883    indent-tabs-mode: nil
2884    sentence-end-double-space: t
2885    fill-column: 70
2886    End: