Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
[docutils.git] / HISTORY.txt
blob83f18da8f939405e43401436ac2b0e0e0f35f499
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.
26 * docutils/io.py
28   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
29     option is ignored and will be removed in a future release.
31 * docutils/parsers/rst/directives/misc.py
33   - Fix [ 3546533 ] Unicode error with `date` directive.
35 * docutils/writers/manpage.py
37   - Apply [ 3527401 ] addmonition's don't preserve indentation
38   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
40 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
42   - Apply [ 3555160 ] ensure order of "otherlanguages".
44 * docutils/writers/s5_html/__init__.py
46   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
48 * docutils/writers/s5_html/docutils_xml.py
50   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
53 Release 0.9.1 (2012-06-17)
54 ==========================
56 * docutils/setup.py
58   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
59     installed in the PYTHONPATH. Converted tests are now
60     stored in ``test3/``, tools no longer need conversion.
62     If you installed one of Docutils versions 0.7 ... 0.9 with
63     ``setup.py install`` under Python 3, remove the spurious
64     ``test/`` and ``tools/`` directories in the site library root.
66 * docutils/test/
68   - Make tests independent from the location of the ``test/`` directory.
69   - Use converted sources (from the ``build/`` directory) for tests under
70     Python 3.
72 * docutils/tools/
74   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
76 * docutils/io.py
78   - Fix writing binary data to sys.stdout under Python 3 (allows
79     ``rst2odt.py`` to be used with output redirection).
81 * docutils/parsers/rst/directives/misc.py
83   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
84     ``locale == C`` and 8-bit char in path argument of `include` directive.
86 * docutils/test/alltests.py
88   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
89     file under Python 3.
91 Release 0.9 (2012-05-02)
92 ========================
94 * General:
96   - New reStructuredText "code" role and directive and "code" option
97     of the "include" directive with syntax highlighting by Pygments_.
98   - Fix parse_option_marker for option arguments containing ``=``.
99   - Fix [ 2993756 ]: import Python Imaging Library's Image module
100     via ``import PIL`` as starting with PIL 1.2,
101     "PIL lives in the PIL namespace only" (announcement__).
103 .. _Pygments: http://pygments.org/
104 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
106 * setup.py
108   - Fix [ 2971827 ] and [ 3442827 ]
109     extras/roman.py moved to docutils/utils/roman.py
111 * docutils/frontend.py
113   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
115 * docutils/io.py
117   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
118   - `mode` argument for FileOutput avoids code replication in
119     BinaryFileOutput.
120   - New exceptions InputError and OutputError for IO errors in
121     FileInput/FileOutput.
123 * docutils/core.py:
125   - No "hard" system exit on file IO errors: catch and report them in
126     `Publisher.reportException` instead. Allows handling by a calling
127     application if the configuration setting `traceback` is True.
129 * docutils/utils.py -> docutils/utils/__init__.py
131   - docutils.utils is now a package (providing a place for sub-modules)
133   .. note:: docutils/math, docutils/error_reporting.py, and
134      docutils/urischemes.py will move to the utils package in the next
135      release, too. See RELEASE-NOTES__
137      __ RELEASE-NOTES.html
139   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
140     errors recording non-ASCII filenames (fixes [ 3434355 ]).
142   - Fix relative_path() with source=None and `unicode` target.
144 * docutils/parsers/rst/states.py
146   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
147     characters and "international" quotes around inline markup.
148   - Use `field_marker` pattern to look for start of a
149     directive option block (fixes [ 3484857 ]).
151 * docutils/parsers/rst/tableparser.py
153   - Fix [ 2926161 ] for simple tables.
154     (Combining chars in grid tables still contribute to cell width.)
156 * docutils/writers/latex2e/__init__.py
158   - Support the `abbreviation` and `acronym` standard roles.
159   - Record only files required to generate the LaTeX source as dependencies.
160   - Fix handling of missing stylesheets.
161   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
162     when suppressing LaTeX section numbering.
163   - Use ``\DUtitle`` for unsupported section levels
164   - Apply [ 3512791 ] do not compare string literals with "is"
166 * docutils/writers/xetex/__init__.py
168   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
170 * docutils/writers/html4css1/__init__.py
172   - Change default for `math-output` setting to MathJax.
173   - Fix handling of missing stylesheets.
175 * docutils/writers/docutils_xml.py
177   - Use the visitor pattern with default_visit()/default_depart() methods
178     instead of minidom to facilitate special handling of selected nodes.
179   - Support raw XML (inserted as-is inside a <raw></raw> node).
181 * docutils/writers/manpage.py
183   - Do not emit comment line with trailing blank. Problematic for VCS.
185 Release 0.8.1 (2011-08-30)
186 ==========================
188 * General:
190   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
191     and [ 3395920 ] (correct copyright info for rst.el).
193 * docutils/test/
195   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
197 * docutils/writers/latex2e/__init__.py
199   - Clean up Babel language setting. Restores Sphinx compatibility.
201 Release 0.8 (2011-07-07)
202 ========================
204 * General:
206   - Handle language codes according to `BCP 47`_.
207   - If the specified language is not supported by Docutils,
208     warn and fall back to English.
209   - Math support: reStructuredText "math" role and directive,
210     ``math`` and ``math_block`` doctree elements.
211   - Decode command line arguments with the locale's preferred encoding
212     (to allow, e.g., ``--title=Dornröschen``).
213   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
214   - New sub-module `error_reporting`: handle encoding/decoding errors
215     when reporting exceptions.
216   - Some additions to the Docutils core are released under the 2-Clause BSD
217     license, see COPYING_ for details.
219   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
220   .. _COPYING: COPYING.html
222 * reStructuredText:
224   - Most directives now support a "name" option that attaches a
225     reference name.
227   - Directive content may start on the first line also when the directive
228     type accepts options.
230 * docs/dev/policies.txt:
232   - Recommend the 2-Clause BSD license
233     (http://www.spdx.org/licenses/BSD-2-Clause)
234     for code that is kept under the author's copyright.
236 * tools/buildhtml.py:
238   - Fix ``--local`` switch.
240 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
242 * docutils/writers/html4css1/__init__.py
244   - Set "lang" argument for objects with class argument
245     "language-<language tag>".
246   - New setting "math-output" with support for HTML, MathML, and LaTeX.
248 * docutils/writers/latex2e/__init__.py
250   - Fix [ 3043986 ] AttributeError using :local: with table of content.
251   - Place title data in the document preamble.
252   - Load `babel` package only if required.
253   - Update list of supported languages.
254   - New config setting "hyperref-options".
255     No hard-coded "unicode" hyperref option (clash with xetex).
256   - Set language for custom roles, paragraphs, block-quotes, and
257     line-quotes with class argument "language-<language tag>".
258   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
259   - Convert image URI to a local file path.
260   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
261     has more than one paragraph (Wolfgang Scherer).
262   - \leavevmode before longtable only when needed (prevents spurious vspace)
263   - do not advance table counter for tables without caption
265 * docutils/writers/xetex/__init__.py
267   - New writer generating LaTeX code for compiling with ``xelatex``.
269     A separate writer (inheriting from latex2e) instead of a ``--xetex``
270     option allows separate config options for XeTeX vs. LaTeX2e.
272 * docutils/writers/manpage.py
274   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
275   - Fix: vertical space cleaning for option group ``.``.
277 * tools/editors/emacs/rst.el:
279   - Fix [ 3001100 ] does not handle spaces in filenames
280     (thanks to Jakub Wilk)
282 * docutils/utils.py:
284   - strip whitespace from stylesheet arguments
285   - exclude combining chars from column_width()
286     (partial fix for [ 2926161 ])
288 * docutils/parsers/rst/directives/misc.py:
290   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
291     nested_parse
293 * docutils/io.py:
295   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
296     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
298 Release 0.7 (2010-07-07)
299 ========================
301 * General:
303   - Fix [ 2881769 ] setup configuration.
304   - Fix [ 2788716 ] reporting problems in included files.
306 * docutils/io.py
308   - FileInput opens files as text files with universal newline support
309     (mode "rU", configurable with the new optional argument "mode").
311 * docutils/nodes.py
313   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
315 * docutils/utils.py
317   - Fix [ 2923723 ] let decode_path() tolerate path == None
319 * docutils/writers/html4css1/__init__.py
321   - Support SVG and SWF images (thanks to Stefan Rank).
322   - Generate valid XHTML for centered images with targets.
323     Use CSS classes instead of "align" tags for image alignment.
325 * docutils/writers/latex2e/__init__.py
327   - Use `transforms.writer_aux.Admonitions` to "normalize" special
328     admonitions.
329   - Use the ``\url`` command for URLs (breaks long URLs instead of
330     writing into the margin).
331   - Preserve runs of spaces in `inline literals`__.
332   - Deprecate ``figure_footnotes`` setting.
333   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
334   - New ``latex_preamble`` setting.
335   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
336   - Fix hyperlink targets (labels) for images, figures, and tables.
337   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
338   - Apply [ 2961991 ] Call hyperref with unicode option.
339   - Drop the special `output_encoding`__ default ("latin-1").
340     The Docutils wide default (usually "UTF-8") is used instead.
341   - Render inline markup in document title and subtitle.
342   - Fix numbering depth with LaTeX section numbering.
343   - Update Unicode -> LaTeX translations.
344   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
346 __ docs/ref/restructuredtext.html#inline-literals
347 __ docs/user/config.html#docutils-footnotes
348 __ docs/user/config.html#output_encoding
350 * docutils/writers/manpage.py
352   - Fix: supported attribute (thanks to peter2108).
353   - Remove trailing blanks in code (keep in sync with mercurial version).
354   - Titles level 1, that is ``.SH``, always uppercase.
355   - Apply patch from mg: literal text should be bold in man-pages.
357 * docutils/nodes.py
359   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
360     turkish locale.
362 * setup.py:
364   - Python 3 support: copy test/ and tools/ to the build-dir
365     and convert Python sources with 2to3.
368 Release 0.6 (2009-10-11)
369 ========================
371 * General:
373   - Docutils is now compatible with Python versions from 2.3 up to 2.6
374     and convertible to 3.1 code.
376     + Node.__nonzero__ returns True instead of 1.
377     + use os.walk instead os.path.walk.
378     + minimize "types" module where possible.
379     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
380     + Text nodes now subclass unicode rather than UserString
381       (which is gone in python 3.0).
382     + 3.0 compatibility module docutils._compat
384     + Drop 2.2 compatibility workarounds.
385     + Drop extras/optparse.py and extras/textwrap.py
386       (stdlib modules since 2.3).
388   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
389   - Unix man page export: manpage writer moved from sandbox to Doctutils
390     core.
392   - Apply [ 1719345 ] Galician translation
393   - Apply [ 1905741 ] Polish translation
394   - Apply [ 1878977 ] make_id(): deaccent characters.
395   - Apply [ 2029251 ] return nonzero when tests fail.
396   - Fix [ 1692788 ] allow UTF-8 in style sheets.
397   - Fix [ 2781629 ] support non-ASCII chars in file names.
398   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
399   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
400   - Fix [ 2821266 ] --strict option works now like --halt=info.
401   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
402   - Fix [ 1627229 ] hyperlink references in substitutions.
404   - The "newlatex" writer is orphaned.
406 * reStructuredText:
408   - Documented Unicode characters allowed as inline markup openers,
409     closers, and delimiters.
410   - Allow units for all length specifications.
411   - Allow percent sign in "scale" argument of "figure" and "image" directives.
412   - Bugfix: The "figalign" argument of a figure now works as intended
413     (aligning the figure, not its contents).
414   - Align images with class "align-[right|center|left]"
415     (allows setting the alignment of an image in a figure).
417 * docutils/nodes.py:
419   - Added ``Element.__contains__`` method, for the in-operator.
421 * docutils/parsers/rst/states.py:
423   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
424   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
425     " " (non-breaking space), and "¡ ¿" openers.
427 * docutils/parsers/directives/misc.py:
429   - Added ``start-line`` and ``end-line`` options to "include"
430     directive to select a range of lines.
431   - Hard tabs in literal inclusions are replaced by spaces. This is
432     configurable via the new ``tab-width`` option of the "include" directive
433     (a negative tab-width prevents tab expansion).
435 * docutils/utils.py:
437   - Add ``get_stylesheet_list`` function.
438   - Apply [ 2834836 ] print info at halt
440 * docutils/transforms/universal.py:
442   - Raise default priority of StripClasses to exclude stripped classes from
443     the ToC.
445 * docutils/writers/html4css1/__init__.py:
447   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
448     separated list of stylesheets.
449   - Address [ 1938891 ] Inline literal text creates "pre" span only when
450     needed to prevent inter-word line wraps.
451   - Use `translate` method instead of repeated `replace` calls.
452   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
453     classes to allow CSS styling that does not interfere with other
454     table-using constructs (field lists, citations, ...).
456 * docutils/writers/newlatex2e/__init__.py:
458   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
460 * docutils/writers/latex2e/__init__.py (see also
461   `<docs/user/docutils-05-compat.sty.html>`__) :
463   - Add ``--embed-stylesheet`` option.
464   - Apply [ 1474017 ] image vertical alignment is reversed.
465   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
466   - Change: has_key for dictionaries (not Nodes) to in-operator.
467   - Merge adjacent citations into one latex cite command.
468   - Failsave implementation of custom roles. LaTeX compilation now ignores
469     unknown classes instead of aborting with an error.
470   - Support custom roles based on standard roles.
471   - LaTeX packages can be used as ``--stylesheet`` arguments without
472     restriction. (A style sheet is now referenced with the ``\usepackage``
473     command, if it ends with ``.sty`` or has no extension.)
474   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
475   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
476   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
477     2005-02-04 as a configurable length unit).
478   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
479     if font-encoding is set to ''. LaTeX defaults to OT1 then.
480   - Set sub- and superscript role argument in text mode not as math.
481     Use a custom role based on sub-/superscript if you want italic shape.
482   - Shorter preamble and less dependencies: Load packages and define macros
483     only if required in the document.
484   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
485   - New custom environments and commands with optional "classes" argument.
486   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
487   - Better conformance to Docutils specifications with ``--use-latex-toc``.
488     Support for LaTeX generated ToC also with unnumbered sections.
489   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
490     section numbering by LaTeX.
491   - Use default font in admonitions and sidebar.
492   - Align of image in a figure defaults to 'center'.
493   - Bugfix: Newlines around targets and references prevent run-together
494     paragraphs.
495   - Fix internal hyperlinks.
496   - Use class defaults for page margins ('typearea' now optional).
497   - Float placement made configurable, default changed to "here definitely".
498   - Typeset generic topic as "quote block with title".
499   - Use template (file and configuration option).
500   - In the default template, load cmap.sty (fix text extraction in PDF) and
501     fixltx2e.sty (LaTeX patches, \textsubscript).
502   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
503   - Use `translate` instead of repeated `replace` calls for text encoding.
504   - Hyperlinked footnotes and support for symbol footnotes and
505     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
506   - Complete pairs of binary options
507     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
508     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
509   - New defaults:
510     - font-encoding: "T1" (formerly implicitely set by 'ae').
511     - use-latex-toc: true (ToC with page numbers).
512     - use-latex-footnotes: true (no mixup with figures).
514 * docutils/writers/manpage.py
516   - Do not print version at document end, this is done by the viewer.
517   - Do not print date at document end, this is done by the viewer.
518   - Fix storage of docinfo fields for none standard fields.
520 * docutils/tools/rst2man.py
522 Release 0.5 (2008-06-25)
523 ========================
525 * docutils/languages/he.py: Added to project: Hebrew mappings by
526   Meir Kriheli.
528 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
529   mappings by Meir Kriheli.
531 * docutils/frontend.py:
533   - Configuration files are now assumed and required to be
534     UTF-8-encoded.
535   - Paths of applied configuration files are now recorded in the
536     runtime setting ``_config_files`` (accessible via
537     ``--dump-settings``).
538   - Added ``--strip-elements-with-class`` and ``--strip-class``
539     options (``strip_elements_with_classes`` and ``strip_classes``
540     settings).
542 * docutils/io.py:
544   - Added code to determine the input encoding from data: encoding
545     declarations or the presence of byte order marks (UTF-8 & UTF-16).
546   - Added support for IronPython 1.0.
548 * docutils/nodes.py:
550   - Added ``document.__getstate__`` method, for pickling.
552 * docutils/parsers/rst/states.py:
554   - Allow ``+`` and ``:`` in reference names.
555   - Unquoted targets beginning with an underscore (``.. __target:
556     URI``) are no longer accepted.
557   - Added support for multiple attributions in a physical block quote
558     (indented text block), dividing it into multiple logical block
559     quotes.
560   - Added support for unicode bullets in bullet lists: "•", "‣", and
561     "⁃".
562   - Added support for new object-oriented directive interface,
563     retaining compatibility to the old functional interface.
564   - Added support for throwing ``DirectiveError``'s from within
565     directive code.
567 * docutils/parsers/rst/__init__.py:
569   - Added ``Directive`` base class.
570   - Added ``DirectiveError`` base class.
571   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
572     definitions.
574 * docutils/parsers/directives/:
576   - Refactored all reStructuredText directives to use the new
577     object-oriented directive interface.  Errors are now (mostly)
578     thrown using the new ``DirectiveError`` class.
580 * docutils/parsers/directives/misc.py:
582   - Added ``start-after`` and ``end-before`` options to ``include``
583     directive; thanks to Stefan Rank.
585 * docutils/transforms/universal.py:
587   - Added ``StripClassesAndElements`` transform to remove from the
588     document tree all elements with classes in
589     ``settings.strip_elements_with_classes`` and all "classes"
590     attribute values in ``self.document.settings.strip_classes``.
592 * docutils/transforms/writer_aux.py:
594   - Added ``Admonitions`` transform to transform specific admonitions
595     (like ``note``, ``warning``, etc.) into generic admonitions with a
596     localized title.
598 * docutils/writers/html4css1/__init__.py:
600   - Moved template functionality from the PEP/HTML writer here.
601   - Expanded the fragments available in the ``parts`` attribute.
602   - Moved ``id`` attributes from titles to surrounding ``div``
603     elements.
604   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
605     universally supported now).
606   - ``template.txt`` is now opened in text mode instead of binary mode
607     (to ensure Windows compatibility).
608   - ``a`` elements now have an "internal" or "external" class,
609     depending on reference type.
611 * docutils/writers/html4css1/template.txt: Added to project.
613 * docutils/writers/pep_html/:
615   - Moved template functionality to the HTML writer.
617 * docutils/writers/s5_html/__init__.py:
619   - Added ``view_mode`` & ``hidden_controls`` settings
620     (``--view-mode`` & ``--hidden-controls/--visible-controls``
621     options).
623 * docutils/writers/latex2e/__init__.py:
625   - Add ``--literal-block-env``
626   - Fix: escaping ``%`` in href urls.
627   - Move usepackage hyperref after stylesheet inclusion.
628   - Fix: scrartcl does not have chapter but scrreprt.
629   - Add newline after ``\end{verbatim}``.
630   - Merge smaller differences from latex2e_adaptive_preamble.
631   - Add ``use-part-section``.
632   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
633   - Using leavemode option_list no longer needs to check if parent
634     is a definition list.
635   - Append ``\leavemode`` to definition list terms.
636   - No longer write visit\_/depart_definition_list_item comments to
637     output.
638   - Table column width with 3 decimal places.
639   - Add table stubs support (boldfont).
640   - Add assemble_parts to writer.
641   - Add simply support for nested tables.
642   - Fix verbatim in tables if use-verbatim-when-possible.
643   - Use section commands down to subparagraph.
644   - Put ensuremath around some latin1 chars.
645   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
646   - New option ``--use-bibtex=style,db1,db2``.
647   - New option ``--reference-label`` to allow usage of LaTeX ref for
648     labels in section references.
649   - Add a label after every section to support sectionnumbers as reference
650     labels.
651   - Fix: bug# 1605376 rst2latex: bad options group list
652   - Remove inactive code for use_optionlist_for_option_list.
653   - Remove latex comments from option_list output.
654   - Fix: bug# 1612270 double qoutes in italian literal.
655   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
656   - Add option --use-latex-abstract.
657   - Image width unit ``px`` is translated to ``pt``.
658   - Add image height support.
659   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
660     bug #1457388
661   - Fix: Do not escape underscores in citation reference labels if
662     use-latex-citations is set.
663   - Use centering instead of center for figure contents, to avoid vertical
664     space.
665   - Recognize table class: borderless, nolines, booktabs, standard.
666   - Fix: Renaming contents section does not work with latex writer; SF
667     bug #1487405.
668   - Applied patch for custom roles with classes from Edward Loper.
669   - Fixed bug that caused crashes with more than 256 lists.
671 * docutils/writers/pep_html/__init__.py:
673   - Changed to support new python.org website structure and
674     pep2pyramid.py.
676 * docs/howto/security.txt: "Deploying Docutils Securely", added to
677   project.
679 * tools/buildhtml.py:
681   -- Added ``ignore`` setting to exclude a list of shell patterns
682      (default: ``.svn:CVS``).
684 * tools/editors/emacs/rst.el:
686   - Changed license to "GPL".
687   - Added ``rst-straighten-decorations`` function.
688   - The ``compile`` module is now always loaded.
689   - Added ``rst-toggle-line-block`` function.
690   - Headings consisting only of non-ASCII characters are now
691     recognized by ``rst-toc`` and ``rst-adjust``.
692   - Added font-lock support for multi-line comments where the first
693     comment line is empty.
694   - Added ``(require 'font-lock)``.
696 * setup.py:
698   - Provide descriptive error message if distutils is missing.
701 Release 0.4 (2006-01-09)
702 ========================
704 * General:
706   - Updated the project policies for trunk/branch development &
707     version numbering.
709 * docutils/__init__.py:
711   - Added ``__version_details__`` attribute to describe code source
712     (repository/snapshot/release).
713   - Replaced ``default_transforms`` attribute of TransformSpec with
714     ``get_transforms()`` method.
716 * docutils/core.py:
718   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
719     functions, for document tree extraction and reprocessing.
721 * docutils/io.py:
723   - Added ``DocTreeInput`` class, for reprocessing existing documents.
724   - Added support for non-Unicode (e.g. binary) writer output.
726 * docutils/nodes.py:
728   - Re-introduced ``Targetable.indirect_reference_name``, for
729     MoinMoin/reST compatibility (removed in r3124/r3129).
730   - Added ``serial_escape`` function; escapes string values that are
731     elements of a list, for serialization.  Modified Docutils-XML
732     writing (``Element._dom_node``) and pseudo-XML writing
733     (``Element.starttag``) to use ``serial_escape``.
734   - Added ``Node.deepcopy()`` method.
735   - Removed the internal lists ``document.substitution_refs``,
736     ``document.anonymous_refs``, and ``document.anonymous_targets``.
737   - Added a "container" element.
738   - Fixed bug where values of list-valued attributes of elements
739     originating from custom interpreted text roles (i.e., with custom
740     classes) were being shared between element instances.  Reported by
741     Shmuel Zeigerman.
743 * docutils/statemachine.py:
745   - Added trailing whitespace stripping to ``string2lines()``.
746   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
747     Asian double-width character support.
749 * docutils/utils.py:
751   - Added ``east_asian_column_width()`` for double-width character
752     support.
754 * docutils/languages/ja.py: Added to project: Japanese mappings by
755   Hisashi Morita.
757 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
758   mappings by Panjunyong.
760 * docutils/parsers/null.py: Added to project; a do-nothing parser.
762 * docutils/parsers/rst/__init__.py:
764   - Added validator to tab_width setting, with test.  Closes SF bug
765     #1212515, report from Wu Wei.
767 * docutils/parsers/rst/states.py:
769   - Fixed bug with escaped colons indicating a literal block.
770   - Fixed bug with enumerated lists (SF#1254145).
771   - Backslash-escaped colons inside of field names are now allowed.
772   - Targets (implicit and explicit), anonymous hyperlink references
773     and auto-numbered footnote references inside of substitution
774     definitions are now disallowed.
775   - Fixed bug: list items with blank first lines.
776   - Fixed bug: block quote attributions with indented second lines.
777   - Added East Asian double-width character support (Python 2.4 only).
779 * docutils/parsers/rst/tableparser.py:
781   - Added East Asian double-width character support (Python 2.4 only).
783 * docutils/parsers/rst/directives/body.py:
785   - Added the "container" directive.
787 * docutils/parsers/rst/directives/misc.py:
789   - Added the "default-role", "title", and "date" directives.
790   - Added standard data file syntax to the "include" directive.
791   - Added support for "class" directive content.
793 * docutils/parsers/rst/directives/images.py:
795   - Added ``indirect_reference_name`` support for images with a target
796     option.
797   - Added support for image width and height units.
798   - Fixed bug with image "target" options.
800 * docutils/parsers/rst/directives/references.py:
802   - Added "class" attribute to "target-notes" directive, for
803     footnote_reference classes.
805 * docutils/parsers/rst/include/: Directory added to project; contains
806   standard data files for the "include" directive.  Initial contents:
807   character entity substitution definition sets, and a set of
808   definitions for S5/HTML presentations.
810 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
811   mappings by David Goodger.
813 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
814   Simplified Chinese mappings by Panjunyong.
816 * docutils/readers/__init__.py:
818   - Added universal.Decorations and universal.ExposeInternals
819     transforms as default transforms for all readers.
820   - Added ``ReReader`` base class for readers that reread an existing
821     document tree.
823 * docutils/readers/doctree.py: Added to project; a reader for existing
824   document trees.
826 * docutils/transforms/frontmatter.py:
828   - Fixed the DocInfo transform to handle SVN-style expansion of the
829     "Date" keyword.
830   - In ``DocInfo.extract_authors``, treat the contents of "authors"
831     fields uniformly.
833 * docutils/transforms/misc.py:
835   - Added misc.Transitions transform, extracted from
836     universal.FinalChecks.
838 * docutils/transforms/references.py:
840   - Added references.DanglingReferences transform, extracted from
841     universal.FinalChecks.
842   - Fixed bug with doubly-indirect substitutions.
843   - Added footnote_reference classes attribute to "TargetNotes".
844   - Fixed bug with circular substitution definitions that put Docutils
845     into an infinite loop.
847 * docutils/transforms/universal.py:
849   - Added universal.ExposeInternals transform, extracted from
850     universal.FinalChecks.
851   - Removed universal.FinalChecks transform (logic has been moved to
852     several new transforms).
853   - Fixed bug with the "expose_internals" setting and Text nodes
854     (exposed by the "rawsource" internal attribute).
855   - Added the universal.StripComments transform, implementation of the
856     "strip_comments" setting.
858 * docutils/transforms/writer_aux.py: Added to project; auxiliary
859   transforms for writers.
861   - Added ``Compound`` transform, which flattens compound paragraphs.
863 * docutils/writers/: Several writer modules (html4css1.py) were
864   converted into packages.  Support modules and data files have been
865   moved into the packages.  The stylesheets for the HTML writers are
866   now installed along with the code, the code knows where to find
867   them, and the default is to use them (actually, to embed them).
868   Some adjustments to configuration files may be necessary.  The
869   easiest way to obtain the new default behavior is to remove all
870   settings whose name includes "stylesheet".
872 * docutils/writers/__init__.py:
874   - Added universal.Messages and universal.FilterMessages transforms
875     as default transforms for all writers.
876   - Added ``UnfilteredWriter`` base class for writers that pass the
877     document tree on unchanged.
879 * docutils/writers/docutils_xml.py:
881   - Made ``xmlcharrefreplace`` the default output encoding error
882     handler.
884 * docutils/writers/html4css1/:
886   - Added support for image width and height units.
887   - Made ``xmlcharrefreplace`` the default output encoding error
888     handler.
889   - Made ``--embed-stylesheet`` the default rather than
890     ``--link-stylesheet``.
891   - Moved "id" attribute from container (section etc.) to title's <a>
892     tag, to be on the same tag as "name".
893     (!!! To be reverted in Docutils 0.5.)
894   - Added vertical space between fields of field lists.
895   - Added ``--compact-field-lists`` option to remove vertical space in
896     simple field lists.
897   - Made cloaking of email addresses with ``--cloak-email-addresses``
898     less obtrusive.
899   - Fixed support for centered images.
900   - Added support for class="compact" & class="open" lists.
902 * docutils/writers/latex2e/:
904   - Underscores in citekeys are no longer escaped.
906 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
907   mapping of Unicode characters to LaTeX equivalents.
909 * docutils/writers/s5_html/: Package added to project; writer for
910   S5/HTML slide shows.
912 * docs/dev/distributing.txt: Added to project; guide for distributors
913   (package maintainers).
915 * docs/dev/hacking.txt: Added to project; guide for developers.
917 * docs/ref/doctree.txt:
919   - Updated for plural attributes "classes", "ids", "names",
920     "dupnames".
921   - Added the "container" element.
923 * docs/ref/docutils.dtd:
925   - Updated for plural attributes "classes", "ids", "names",
926     "dupnames".
928 * docs/user/emacs.txt: Added to project; a document about Emacs
929   support for reStructuredText and Docutils.
931 * docs/user/links.txt: Added to project; lists of Docutils-related
932   links.
934 * docs/user/mailing-lists.txt: Added to project; information about
935   Docutils-related mailing lists and how to access them.
937 * docs/user/slide-shows.txt: Added to project; example of and docs for
938   the S5/HTML writer (``rst2s5.py`` front end).
940 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
941   Files", added to project.
943 * test/coverage.sh: Added to project; test coverage script.
945 * test/DocutilsTestSupport.py:
947   - Added support for specifying runtime settings at the suite level.
949 * test/test_functional.py:
951   - Added the ``clear_output_directory`` function.
952   - Added support for ``_test_more`` functions in functional test
953     config files.
955 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
957 * tools/rstpep2html.py: Renamed from pep.py.
959 * tools/dev/create_unimap.py: Added to project; script to create the
960   docutils/writers/unimap_latex.py mapping file.
962 * tools/dev/profile_docutils.py: Added to project; profiler script.
964 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
966 * tools/editors/emacs/restructuredtext.el,
967   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
968   Removed from project; the functionality is now contained in rst.el.
970 * tools/editors/emacs/rst.el: Added to project.  Added many features
971   and fixed many bugs.  See docs/user/emacs.txt for details.
973 * tools/stylesheets: Removed from project.  Stylesheets have been
974   renamed and moved into writer packages.
977 Release 0.3.9 (2005-05-26)
978 ==========================
980 * General:
982   - Eliminated and replaced all uses of the old string attributes
983     ``id``, ``name``, ``dupname`` and ``class`` with references to the
984     new list attributes ``ids``, ``names``, ``dupnames`` and
985     ``classes`` throughout the whole source tree.
987 * docutils/core.py:
989   - Enabled ``--dump-*`` options when ``--traceback`` specified,
990     allowing for easier debugging.
991   - In ``Publisher.publish()``, expanded the generic top-level
992     exception catching.
994 * docutils/examples.py:
996   - Added ``internals`` function for exploration.
998 * docutils/io.py:
1000   - Fixed ``Input.decode`` method to apply heuristics only if no
1001     encoding is explicitly given, and to provide better reporting of
1002     decoding errors.
1003   - The ``Input.decode`` method now removes byte order marks (BOMs)
1004     from input streams.
1006 * docutils/nodes.py:
1008   - ``image`` element class changed to subclass of Element, not
1009     TextElement (it's an empty element, and cannot contain text).
1010   - Added ``attr_defaults`` dictionary for default attribute values.
1011   - Added empty list as default value for the following attributes:
1012     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1013   - Added ``document.decoration`` attribute,
1014     ``document.get_decoration`` method, and ``decoration.get_header``
1015     & ``.get_footer`` methods.
1016   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1017     methods.
1019 * docutils/utils.py:
1021   - Removed ``docutils.utils.Reporter.categories``,
1022     ``docutils.utils.ConditionSet``, and all references to them, to
1023     simplify error reporting.
1025 * docutils/languages/nl.py: Added to project; Dutch mappings by
1026   Martijn Pieters.
1028 * docutils/parsers/rst/__init__.py:
1030   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1032 * docutils/parsers/rst/states.py:
1034   - Added check for escaped at-mark to prevent email address recognition.
1035   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1036     arguments>``.
1037   - Allowed whitespace in paths and URLs.
1038   - Added auto-enumerated list items.
1039   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1040     followed by text.
1041   - Added support for table stub columns.
1043 * docutils/parsers/rst/directives/__init__.py:
1045   - Allowed whitespace in paths (``path`` function).
1046   - Added ``uri`` directive option conversion function.
1048 * docutils/parsers/rst/directives/body.py:
1050   - Fixed illegal context bug with "topic" directive (allowed within
1051     sidebars; not within body elements).
1053 * docutils/parsers/rst/directives/images.py:
1055   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1056   - Added support for the ``file_insertion_enabled`` setting in the
1057     "figure" directive (disables "figwidth" option).
1058   - "image" directive: added checks for valid values of "align" option,
1059     depending on context.  "figure" directive: added specialized
1060     "align" option and attribute on "figure" element.
1061   - Made ":figwidth: image" option of "figure" directive work again.
1062   - Fixed bug with reference names containing uppercase letters
1063     (e.g. ``Name_``) in "target" option of "image" directive.
1065 * docutils/parsers/rst/directives/misc.py:
1067   - Fixed "include" and "raw" directives to catch text decoding
1068     errors.
1069   - Allowed whitespace in "include" & "raw" directive paths.
1070   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1071     settings in "include" & "raw" directives.
1073 * docutils/parsers/rst/directives/parts.py:
1075   - Added "header" & "footer" directives.
1076   - Fixed illegal context bug with "contents" directive (topics
1077     allowed within sidebars; not within body elements).
1079 * docutils/parsers/rst/directives/tables.py:
1081   - Added "list-table" directive.
1082   - Caught empty CSV table bug.
1083   - Added support for the ``file_insertion_enabled`` setting in the
1084     "csv-table" directive.
1085   - Added ``stub-columns`` option to "csv-table" and "list-table"
1086     directives.
1088 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1089   mappings by Martijn Pieters.
1091 * docutils/readers/standalone.py:
1093   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1094     options to activate or deactivate the SectSubTitle transform.
1096 * docutils/transforms/frontmatter.py:
1098   - Added SectSubTitle transform to promote titles of lone
1099     subsections to subtitles.
1101 * docutils/transforms/references.py:
1103   - Fixed mislocated internal targets bug, by propagating internal
1104     targets to the next node, making use of the newly added support
1105     for multiple names and IDs.
1106   - Fixed duplicate footnote label bug.
1107   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1108     transform.
1110 * docutils/writers/html4css1.py:
1112   - Fixed unencoded stylesheet reference bug (characters like "&" in
1113     stylesheet references).
1114   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1115     tags).
1116   - Added support for multiple IDs per node by creating empty ``span``
1117     tags.
1118   - Added the ``field_name_limit`` & ``option_limit`` settings &
1119     support.
1120   - Added support for table stub columns.
1121   - Added support for the ``align`` attribute on ``figure`` elements.
1122   - Added the ``cloak_email_addresses`` setting & support.
1123   - Added ``html_prolog``, ``html_head``, ``html_body``,
1124     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1125     ``docutils.core.publish_parts``.
1126   - Added support for section subtitles.
1128 * docutils/writers/latex2e.py:
1130   - Fixed tables starting with more than one multirow cell.
1131   - Improved --use-latex-docinfo so that organization/contact/address
1132     fields are lumped with the last author field and appear on the
1133     titlepage.
1134   - Made sure the titlepage is always shown with --use-latex-docinfo,
1135     even if the document has no title.
1136   - Made sure that latex doesn't fill in today's date if no date field
1137     was given.
1138   - Added support for section subtitles.
1140 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1141   (under development).
1143 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1145 * docs/api/publisher.txt:
1147   - Added "``publish_parts`` Details" section.
1149 * docutils/dev/repository.txt: Added to project; information about the
1150   Docutils Subversion repository.
1152 * docs/ref/docutils.dtd:
1154   - Added a ``stub`` attribute to the ``colspec`` element via the
1155     ``tbl.colspec.att`` parameter entity.
1156   - Allowed topic elements within sidebars
1157   - Added an ``align`` attribute to the ``figure`` element.
1159 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1160   writer.
1163 Release 0.3.7 (2004-12-24)
1164 ==========================
1166 * docutils/frontend.py:
1168   - Added options: --input-encoding-error-handler,
1169     --record-dependencies, --leave-footnote-reference-space,
1170     --strict-visitor.
1171   - Added command-line and config file support for "overrides" setting
1172     parameter.
1174 * docutils/io.py:
1176   - Added support for input encoding error handler.
1178 * docutils/nodes.py:
1180   - Added dispatch_visit and dispatch_departure methods to
1181     NodeVisitor; useful as a hook for Visitors.
1182   - Changed structure of ``line_block``; added ``line``.
1183   - Added ``compound`` node class.
1184   - Added a mechanism for Visitors to transitionally ignore new node
1185     classes.
1187 * docutils/utils.py:
1189   - Moved ``escape2null`` and ``unescape`` functions from
1190     docutils/parsers/rst/states.py.
1192 * docutils/parsers/rst/roles.py:
1194   - Added "raw" role.
1195   - Changed role function API: the "text" parameter now takes
1196     null-escaped interpreted text content.
1198 * docutils/parsers/rst/states.py:
1200   - Fixed bug where a "role" directive in a nested parse would crash
1201     the parser; the state machine's "language" attribute was not being
1202     copied over.
1203   - Added support for line block syntax.
1204   - Fixed directive parsing bug: argument-less directives didn't
1205     notice that arguments were present.
1206   - Removed error checking for transitions.
1207   - Added support for multiple classifiers in definition list items.
1208   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1209   - Changed role function API: the "text" parameter now takes
1210     null-escaped interpreted text content.
1211   - Empty sections and documents are allowed now.
1213 * docutils/parsers/rst/directives/__init__.py:
1215   - Added ``encoding`` directive option conversion function.
1216   - Allow multiple class names in class_option conversion function.
1218 * docutils/parsers/rst/directives/body.py:
1220   - Converted the line-block directive to use the new structure.
1221   - Extracted the old line-block functionality to the ``block``
1222     function (still used).
1223   - Added ``compound`` directive (thanks to Lea Wiemann).
1225 * docutils/parsers/rst/directives/misc.py:
1227   - Added "encoding" option to "include" and "raw" directives.
1228   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1229   - Allow multiple class names in the "class" directive.
1231 * docutils/parsers/rst/directives/parts.py:
1233   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1234     options.  Thanks to Lele Gaifax.
1236 * docutils/parsers/rst/directives/tables.py:
1238   - Added "encoding" directive to "csv-table" directive.
1239   - Added workaround for lack of Unicode support in csv.py, for
1240     non-ASCII CSV input.
1242 * docutils/transforms/misc.py:
1244   - Fixed bug when multiple "class" directives are applied to a single
1245     element.
1246   - Enabled multiple format names for "raw" directive.
1248 * docutils/transforms/references.py:
1250   - Added support for trimming whitespace from beside substitution
1251     references.
1253 * docutils/transforms/universal.py:
1255   - FinalChecks now checks for illegal transitions and moves
1256     transitions between sections.
1258 * docutils/writers/html4css1.py:
1260   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1261   - "stylesheet" and "stylesheet_path" settings are now mutually
1262     exclusive.
1263   - Added support for the new line_block/line structure.
1264   - --footnote-references now overrides
1265     --trim-footnote-reference-space, if applicable.
1266   - Added support for ``compound`` elements.
1267   - Enabled multiple format names for "raw" directive.
1268   - ``<p>`` tags of a paragraph which is the only visible child of the
1269     document node are no longer stripped.
1270   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1271     new method ``should_be_compact_paragraph()``.
1272   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1273     elements.
1274   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1275     the output if they have their ``class`` attribute set.
1276   - The whole document is now surrounded by a ``<div
1277     class="document">`` element.
1278   - Body-level images are now wrapped by their own ``<div>`` elements,
1279     with image classes copied to the wrapper, and for images which
1280     have the ``:align:`` option set, the surrounding ``<div>`` now
1281     receives a class attribute (like ``class="align-left"``).
1283 * docutils/writers/latex2e.py:
1285   - no newline after depart_term.
1286   - Added translations for some Unicode quotes.
1287   - Added option "font-encoding", made package AE the default.
1288   - "stylesheet" and "stylesheet_path" settings are now mutually
1289     exclusive.
1290   - --footnote-references now overrides
1291     --trim-footnote-reference-space, if applicable.
1292   - The footnote label style now matches the footnote reference style
1293     ("brackets" or "superscript").
1294   - Added support for ``compound`` elements.
1295   - Enabled multiple format names for "raw" directive.
1297 * docs/ref/docutils.dtd:
1299   - Changed structure of the ``line_block`` element; added ``line``.
1300   - Added ``compound`` element.
1301   - Added "ltrim" and "rtrim" attributes to
1302     ``substitution_definition`` element.
1303   - Enabled multiple format names for ``raw`` element.
1304   - Enabled multiple classifiers in ``definition_list_item`` elements.
1306 * docs/ref/rst/directives.txt
1308   - Marked "line-block" as deprecated.
1309   - "Class" directive now allows multiple class names.
1310   - Added "Rationale for Class Attribute Value Conversion".
1311   - Added warning about "raw" overuse/abuse.
1313 * docs/ref/rst/restructuredtext.txt:
1315   - Added syntax for line blocks.
1316   - Definition list items may have multiple classifiers.
1318 * docs/ref/rst/roles.txt:
1320   - Added "raw" role.
1322 * tools/stylesheets/default.css:
1324   - Added support for the new line_block structure.
1325   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1328 Release 0.3.5 (2004-07-29)
1329 ==========================
1331 General:
1333 * _`Documentation cleanup/reorganization`.
1335   - Created new subdirectories of docs/:
1337     * ``docs/user/``: introductory/tutorial material for end-users
1338     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1339     * ``docs/api/``: API reference material for client-developers
1340     * ``docs/ref/``: reference material for all groups
1341     * ``docs/howto/``: for component-developers and core-developers
1342     * ``docs/peps/``: Python Enhancement Proposals
1344   - Moved ``docs/*`` to ``docs/user/``.
1345   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1346     ``spec/`` to ``docs/dev``.
1347   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1348     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1349   - Moved ``alternatives.txt``, and ``problems.txt`` from
1350     ``spec/rst/`` to ``docs/dev/rst/``.
1351   - Moved ``reStructuredText.txt``, ``directives.txt``,
1352     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1353     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1354     ``roles.txt``, ``reStructuredText.txt`` to
1355     ``restructuredtext.txt``.
1356   - Moved ``spec/howto/`` to ``docs/howto``.
1358   In order to keep the CVS history of moved files, we supplied
1359   SourceForge with a `script for modifying the Docutils CVS
1360   repository`__.
1362   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1364   After running the cleanup script:
1366   - Added ``docs/index.txt``.
1367   - Added a ``.htaccess`` file to the ``web`` module, containing
1368     redirects for all old paths to new paths.  They'll preserve
1369     fragments (the "#name" part of a URL), and won't clutter up the
1370     file system, and will correct the URL in the user's browser.
1371   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1372     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1373     the "To Do" list itself in ``docs/dev/todo.txt``.
1374   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1375     section of ``docs/dev/todo.txt``.
1376   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1377   - Added "How To Report Bugs" to ``BUGS.txt``.
1378   - Went through all the sources and docs (including under web/) and
1379     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1380     (Still need to update links in the sandboxes.)
1382 Specific:
1384 * BUGS.txt: Added to project.
1386 * THANKS.txt: Added to project.
1388 * docutils/__init__.py:
1390   - 0.3.4: Post-release.
1392 * docutils/core.py:
1394   - Added special error handling & advice for UnicodeEncodeError.
1395   - Refactored Publisher.publish (simplified exception handling &
1396     extracted debug dumps).
1397   - Renamed "enable_exit" parameter of convenience functions to
1398     "enable_exit_status".
1399   - Enabled traceback (exception propagation) by default in
1400     programmatic convenience functions.
1401   - Now publish_file and publish_cmdline convenience functions return
1402     the encoded string results in addition to their regular I/O.
1403   - Extracted common code from publish_file, publish_string, and
1404     publish_parts, into new publish_programmatically.  Extracted
1405     settings code to ``Publisher.process_programmatic_settings``.
1406   - In Publisher.publish, disabled ``settings_overrides`` when
1407     ``settings`` is supplied; redundant.
1409 * docutils/frontend.py:
1411   - Added help text for "--output-encoding-error-handler" and
1412     "--error-encoding-error-handler".
1413   - Renamed "--exit" to "--exit-status".
1414   - Simplified default-setting code.
1416 * docutils/parsers/rst/__init__.py:
1418   - Added "--pep-base-url" and "--rfc-base-url" options.
1420 * docutils/parsers/rst/states.py:
1422   - Made URI recognition more aggressive and intelligent.
1424 * docutils/parsers/rst/directives/__init__.py:
1426   - Added several directive option conversion functions.
1428 * docutils/parsers/rst/directives/body.py:
1430   - Moved "table" directive to tables.py.
1432 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1433   added to project.
1435 * docutils/writers/latex2e.py:
1437   - Added "--table-style=(standard|booktabs|nolines)"
1438   - figures get "here" option (LaTeX per default puts them at bottom),
1439     and figure content is centered.
1440   - Rowspan support for tables.
1441   - Fix: admonition titles before first section.
1442   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1443   - Replave ``_`` in literal by an underlined blank, because it has the correct
1444     width.
1445   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1446   - A few unicode replacements, if output_encoding != utf
1447   - Add "--graphicx-option".
1448   - Indent literal-blocks.
1449   - Fix: omit ``\maketitle`` when there is no document title.
1451 * docs/index.txt: "Docutils Project Documentation Overview", added to
1452   project.
1454 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1455   Tool", added to project.
1457 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1459 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1461 * docs/dev/policies.txt: Added to project (extracted from
1462   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1464 * docs/dev/release.txt: Added to project (extracted from
1465   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1467 * docs/dev/testing.txt: Added to project.
1469 * docs/dev/website.txt: Added to project (extracted from
1470   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1472 * docs/ref/rst/directives.txt:
1474   - Added directives: "table", "csv-table".
1476 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1477   added to project.  1 page for syntax, and a 1 page reference for
1478   directives and roles.  Source text to be used as-is; not meant to be
1479   converted to HTML.
1481 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1482   with a change of title.
1484 * test/functional/, contents, and test/test_functional.py: Added to
1485   project.
1487 * tools/buildhtml.py: Fixed bug with config file handling.
1489 * tools/html.py: Removed from project (duplicate of rst2html.py).
1491 * tools/pep2html.py: Removed from project (duplicate of Python's
1492   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1493   Docutils-related PEPs in docs/peps/).
1495 * tools/rst2pseudoxml.py: Renamed from publish.py.
1497 * tools/rst2xml.py: Renamed from docutils-xml.py.
1499 * tools/test.txt: Removed from project; moved to
1500   docs/user/rst/demo.txt.
1502 * setup.py: Now also installs ``rst2latex.py``.
1505 Release 0.3.3 (2004-05-09)
1506 ==========================
1508 * docutils/__init__.py:
1510   - 0.3.1: Reorganized config file format (multiple sections); see
1511     docs/config.txt.
1512   - Added unknown_reference_resolvers attribute to TransformSpec.
1513   - 0.3.2: Interpreted text reorganization.
1514   - 0.3.3: Released.
1516 * docutils/core.py:
1518   - Catch system messages to stop tracebacks from parsing errors.
1519   - Catch exceptions during processing report & exit without
1520     tracebacks, except when "--traceback" used.
1521   - Reordered components for OptionParser; application comes last.
1522   - Added "config_section" parameter to several methods and functions,
1523     allowing front ends to easily specify their config file sections.
1524   - Added publish_parts convenience function to allow access to individual
1525     parts of a document.
1527 * docutils/examples.py: Added to project; practical examples of
1528   Docutils client code, to be used as-is or as models for variations.
1530 * docutils/frontend.py:
1532   - Added "--traceback" & "--no-traceback" options ("traceback"
1533     setting).
1534   - Implemented support for config file reorganization:
1535     ``standard_config_files`` moved from ``ConfigParser`` to
1536     ``OptionParser``; added
1537     ``OptionParser.get_config_file_settings()`` and
1538     ``.get_standard_config_settings()``; support for old "[options]"
1539     section (with deprecation warning) and mapping from old to new
1540     settings.
1541   - Reimplemented setting validation.
1542   - Enabled flexible boolean values: yes/no, true/false, on/off.
1543   - Added ``Values``, a subclass of ``optparse.Values``, with support
1544     for list setting attributes.
1545   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1546     thanks to Beni Cherniavsky.
1547   - Added "--no-section-numbering" option.
1549 * docutils/io.py:
1551   - Catch IOErrors when opening source & destination files, report &
1552     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1553     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1555 * docutils/nodes.py:
1557   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1558     method definitions (via ``exec``) to dynamic assignments (via
1559     ``setattr``); thanks to Roman Suzi.
1560   - Encapsulated visitor dynamic assignments in a function; thanks to
1561     Ian Bicking.
1562   - Added indirect_reference_name attribute to the Targetable
1563     class. This attribute holds the whitespace_normalized_name
1564     (contains mixed case) of a target.
1566 * docutils/statemachine.py:
1568   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1569   - Added ``StringList.get_2D_block``.
1571 * docutils/utils.py:
1573   - Added "level" attribute to SystemMessage exceptions.
1575 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1576   Jannie Hofmeyr.
1578 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1579   Blaha.
1581 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1582   Marcelo Huerta San Martin.
1584 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1585   mappings by Lalo Martins.
1587 * docutils/languages/ru.py: Added to project; Russian mappings by
1588   Roman Suzi.
1590 * docutils/parsers/rst/roles.py: Added to project.  Contains
1591   interpreted text role functions, a registry for interpreted text
1592   roles, and an API for adding to and retrieving from the registry.
1593   Contributed by Edward Loper.
1595 * docutils/parsers/rst/states.py:
1597   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1598   - Allowed true em-dash character and "---" as block quote
1599     attribution marker.
1600   - Added support for <angle-bracketed> complex option arguments
1601     (option lists).
1602   - Fixed handling of backslashes in substitution definitions.
1603   - Fixed off-by-1 error with extra whitespace after substitution
1604     definition directive.
1605   - Added inline markup parsing to field lists' field names.
1606   - Added support for quoted (and unindented) literal blocks.
1607     Driven in part by a bribe from Frank Siebenlist (thanks!).
1608   - Parser now handles escapes in URIs correctly.
1609   - Made embedded-URIs' reference text omittable.  Idea from Beni
1610     Cherniavsky.
1611   - Refactored explicit target processing code.
1612   - Added name attribute to references containing the reference name only
1613     through whitespace_normalize_name (no case changes).
1614   - parse_target no longer returns the refname after going through
1615     normalize_name. This is now handled in make_target.
1616   - Fixed bug relating to role-less interpreted text in non-English
1617     contexts.
1618   - Reorganized interpreted text processing; moved code into the new
1619     roles.py module.  Contributed by Edward Loper.
1620   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1621     ``parse_directive_block``.
1623 * docutils/parsers/rst/tableparser.py:
1625   - Reworked for ``StringList``, to support "include" directives in
1626     table cells.
1628 * docutils/parsers/rst/directives/__init__.py:
1630   - Renamed ``unchanged()`` directive option conversion function to
1631     ``unchanged_required``, and added a new ``unchanged``.
1632   - Catch unicode value too high error; fixes bug 781766.
1633   - Beefed up directive error reporting.
1635 * docutils/parsers/rst/directives/body.py:
1637   - Added basic "table" directive.
1639 * docutils/parsers/rst/directives/images.py:
1641   - Added "target" option to "image" directive.
1642   - Added name attribute to references containing the reference name only
1643     through whitespace_normalize_name (no case changes).
1645 * docutils/parsers/rst/directives/misc.py:
1647   - Isolated the import of the ``urllib2`` module; was causing
1648     problems on SourceForge (``libssl.so.2`` unavailable?).
1649   - Added the "role" directive for declaring custom interpreted text
1650     roles.
1652 * docutils/parsers/rst/directives/parts.py:
1654   - The "contents" directive does more work up-front, creating the
1655     "topic" and "title", and leaving the "pending" node for the
1656     transform.  Allows earlier reference resolution; fixes subtle bug.
1658 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1659   mappings by Jannie Hofmeyr.
1661 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1662   mappings by Marek Blaha.
1664 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1665   mappings by Marcelo Huerta San Martin.
1667 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1668   Portuguese mappings by Lalo Martins.
1670 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1671   mappings by Roman Suzi.
1673 * docutils/transforms/parts.py:
1675   - The "contents" directive does more work up-front, creating the
1676     "topic" and "title", and leaving the "pending" node for the
1677     transform.  Allows earlier reference resolution; fixes subtle bug.
1678   - Added support for disabling of section numbering.
1680 * docutils/transforms/references.py:
1682   - Verifying that external targets are truly targets and not indirect
1683     references. This is because we are now adding a "name" attribute to
1684     references in addition to targets. Note sure if this is correct!
1685   - Added code to hook into the unknown_reference_resolvers list for a
1686     transformer in resolve_indirect_target. This allows the
1687     unknown_reference_resolvers to keep around indirect targets which
1688     docutils doesn't know about.
1689   - Added specific error message for duplicate targets.
1691 * docutils/transforms/universal.py:
1693   - Added FilterMessages transform (removes system messages below the
1694     verbosity threshold).
1695   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1696     to FinalCheckVisitor for application-specific handling of
1697     unresolvable references.
1698   - Added specific error message for duplicate targets.
1700 * docutils/writers/__init__.py:
1702   - Added assemble_parts method to the Writer class to allow for
1703     access to a documents individual parts.
1704   - Documented & set default for ``Writer.output`` attribute.
1706 * docutils/writers/html4css1.py:
1708   - Fixed unicode handling of attribute values (bug 760673).
1709   - Prevent duplication of "class" attribute values (bug report from
1710     Kirill Lapshin).
1711   - Improved table grid/border handling (prompted by report from Bob
1712     Marshall).
1713   - Added support for table titles.
1714   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1715     to Darek Suchojad.
1716   - Added functionality to keep track of individual parts of a document
1717     and store them in a dictionary as the "parts" attribute of the writer.
1718     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1719   - Added proper support for the "scale" attribute of the "image"
1720     element.  Contributed by Brent Cook.
1721   - Added ``--initial-header-level`` option.
1722   - Fixed bug: the body_pre_docinfo segment depended on there being a
1723     docinfo; if no docinfo, the document title was incorporated into
1724     the body segment.  Adversely affected the publish_parts interface.
1726 * docutils/writers/latex2e.py:
1728   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1729     about a missing file.
1730   - Added options and support: ``--compound-enumerators``,
1731     ``--section-prefix-for-enumerators``, and
1732     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1733     934322).
1734   - Added option ``--use-verbatim-when-possible``, to avoid
1735     problematic characters (eg, '~' in italian) in literal blocks.
1736   - It's now possible to use four section levels in the `book` and
1737     `report` LaTeX classes.  The default `article` class still has
1738     three levels limit.
1740 * docs/config.txt: "Docutils Configuration Files", added to project.
1741   Moved config file entry descriptions from tools.txt.
1743 * docs/tools.txt:
1745   - Moved config file entry descriptions to config.txt.
1747 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1748   Development".
1750 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1751   Text Roles", added to project.
1753 * spec/rst/reStructuredText.txt:
1755   - Added description of support for <angle-bracketed> complex option
1756     arguments to option lists.
1757   - Added subsections for indented and quoted literal blocks.
1759 * test: Continually adding & updating tests.
1761   - Added test/test_settings.py & test/data/config_*.txt support
1762     files.
1763   - Added test/test_writers/test_htmlfragment.py.
1765 * test/DocutilsTestSupport.py:
1767   - Refactored LaTeX publisher test suite/case class names to make
1768     testing other writers easier.
1769   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1770     to test the processing of HTML fragments which use the new
1771     publish_parts convenience function.
1773 * tools/buildhtml.py:
1775   - Added support for the "--prune" option.
1776   - Removed dependency on pep2html.py; plaintext PEPs no longer
1777     supported.
1779 * tools/docutils.conf:
1781   - Updated for configuration file reorganization.
1783 * tools/rst2html.py:
1785   - copied from tools/html.py
1787 * setup.py:
1789   - added a 'scripts' section to configuration
1790   - added 'tools/rst2html.py' to the scripts section
1793 Release 0.3 (2003-06-24)
1794 ========================
1796 General:
1798 * Renamed "attribute" to "option" for directives/extensions.
1800 * Renamed transform method "transform" to "apply".
1802 * Renamed "options" to "settings" for runtime settings (as set by
1803   command-line options).  Sometimes "option" (singular) became
1804   "settings" (plural).  Some variations below:
1806   - document.options -> document.settings (stored in other objects as
1807     well)
1808   - option_spec -> settings_spec (not directives though)
1809   - OptionSpec -> SettingsSpec
1810   - cmdline_options -> settings_spec
1811   - relative_path_options -> relative_path_settings
1812   - option_default_overrides -> settings_default_overrides
1813   - Publisher.set_options -> Publisher.get_settings
1815 Specific:
1817 * COPYING.txt: Added "Public Domain Dedication".
1819 * FAQ.txt: Frequently asked questions, added to project.
1821 * setup.py:
1823   - Updated with PyPI Trove classifiers.
1824   - Conditional installation of third-party modules.
1826 * docutils/__init__.py:
1828   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1829   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1830   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1831   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1832     option and its effect on the PEP template & writer.
1833   - Bumped version to 0.2.4 due to changes to the PEP template &
1834     stylesheet.
1835   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1836   - Added ``TransformSpec`` class for new transform system.
1837   - Bumped version to 0.2.6 for API changes (renaming).
1838   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1839     convenience functions.
1840   - Added ``Component.component_type`` attribute.
1841   - Bumped version to 0.2.8 because of the internal parser switch from
1842     plain lists to the docutils.statemachine.StringList objects.
1843   - Bumped version to 0.2.9 because of the frontend.py API changes.
1844   - Bumped version to 0.2.10 due to changes to the project layout
1845     (third-party modules removed from the "docutils" package), and
1846     signature changes in ``io.Input``/``io.Output``.
1847   - Changed version to 0.3.0 for release.
1849 * docutils/core.py:
1851   - Made ``publish()`` a bit more convenient.
1852   - Generalized ``Publisher.set_io``.
1853   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1854     parameters; improved its docstring.
1855   - Added ``publish_file()`` and ``publish_string()``.
1856   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1857     out of ``.set_io``.
1858   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1859     "--dump-transforms" hidden options.
1860   - Added ``Publisher.apply_transforms()`` method.
1861   - Added ``Publisher.set_components()`` method; support for
1862     ``publish_*()`` conveninece functions.
1863   - Moved config file processing to docutils/frontend.py.
1864   - Added support for exit status ("exit_level" setting &
1865     ``enable_exit`` parameter for Publisher.publish() and convenience
1866     functions).
1868 * docutils/frontend.py:
1870   - Check for & exit on identical source & destination paths.
1871   - Fixed bug with absolute paths & "--config".
1872   - Set non-command-line defaults in ``OptionParser.__init__()``:
1873     ``_source`` & ``_destination``.
1874   - Distributed ``relative_path_settings`` to components; updated
1875     ``OptionParser.populate_from_components()`` to combine it all.
1876   - Require list of keys in ``make_paths_absolute`` (was implicit in
1877     global ``relative_path_settings``).
1878   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1879     "--dump-settings", and "--dump-transforms" hidden options.
1880   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1881     code, replaced with correct code.
1882   - Added validation functionality for config files.
1883   - Added "--error-encoding" option/setting, "_disable_config"
1884     internal setting.
1885   - Added encoding validation; updated "--input-encoding" and
1886     "--output-encoding"; added "--error-encoding-error-handler" and
1887     "--output-encoding-error-handler".
1888   - Moved config file processing from docutils/core.py.
1889   - Updated ``OptionParser.populate_from_components`` to handle new
1890     ``SettingsSpec.settings_defaults`` dict.
1891   - Added support for "-" => stdin/stdout.
1892   - Added "exit_level" setting ("--exit" option).
1894 * docutils/io.py:
1896   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1897   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1898   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1899   - ``FileOutput.write()`` now returns the encoded output string.
1900   - Try to get path/stream name automatically in ``FileInput`` &
1901     ``FileOutput``.
1902   - Added defaults for source & destination paths.
1903   - Allow for Unicode I/O with an explicit "unicode" encoding.
1904   - Added ``Output.encode()``.
1905   - Removed dependency on runtime settings; pass encoding directly.
1906   - Recognize Unicode strings in ``Input.decode()``.
1907   - Added support for output encoding error handlers.
1909 * docutils/nodes.py:
1911   - Added "Invisible" element category class.
1912   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1913     modification during a traversal.
1914   - Added element classes: ``line_block``, ``generated``, ``address``,
1915     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1916     ``superscript``, ``subscript``, ``inline``
1917   - Added support for lists of nodes to ``Element.insert()``.
1918   - Fixed parent linking in ``Element.replace()``.
1919   - Added new abstract superclass ``FixedTextElement``; adds
1920     "xml:space" attribute.
1921   - Added support for "line" attribute of ``system_message`` nodes.
1922   - Added support for the observer pattern from ``utils.Reporter``.
1923     Added ``parse_messages`` and ``transform_messages`` attributes to
1924     ``document``, removed ``messages``.  Added ``note_parse_message``
1925     and ``note_transform_message`` methods.
1926   - Added support for improved diagnostics:
1928     - Added "document", "source", and "line" internal attributes to
1929       ``Node``, set by ``Node.setup_child()``.
1930     - Converted variations on ``node.parent = self`` to
1931       ``self.setup_child(node)``.
1932     - Added ``document.current_source`` & ``.current_line``
1933       attributes, and ``.note_source`` observer method.
1934     - Changed "system_message" output to GNU-Tools format.
1936   - Added a "rawsource" attribute to the ``Text`` class, for text
1937     before backslash-escape resolution.
1938   - Support for new transform system.
1939   - Reworked ``pending`` element.
1940   - Fixed XML DOM bug (SF #660611).
1941   - Removed the ``interpeted`` element class and added
1942     ``title_reference``, ``abbreviation``, ``acronym``.
1943   - Made substitutions case-sensitive-but-forgiving; moved some code
1944     from the parser.
1945   - Fixed Unicode bug on element attributes (report: William Dode).
1947 * docutils/optik.py: Removed from project; replaced with
1948   extras/optparse.py and extras/textwrap.py.  These will be installed
1949   only if they're not already present in the Python installation.
1951 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1952   only if it's not already present in the Python installation.
1954 * docutils/statemachine.py:
1956   - Factored out ``State.add_initial_transitions()`` so it can be
1957     extended.
1958   - Converted whitespace-specific "blank" and "indent" transitions
1959     from special-case code to ordinary transitions: removed
1960     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1961     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1962     ``ws_initial_transitions`` attributes.
1963   - Removed ``State.match_transition()`` after merging it into
1964     ``.check_line()``.
1965   - Added ``StateCorrection`` exception.
1966   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1967     (moved ``TransitionCorrection`` support there too.)
1968   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1969     ``EOFError`` instead of ``IndexError``.
1970   - Added ``State.no_match`` method.
1971   - Added support for the Observer pattern, triggered by input line
1972     changes.
1973   - Added ``strip_top`` parameter to
1974     ``StateMachineWS.get_first_known_indented``.
1975   - Made ``context`` a parameter to ``StateMachine.run()``.
1976   - Added ``ViewList`` & ``StringList`` classes;
1977     ``extract_indented()`` becomes ``StringList.get_indented()``.
1978   - Added ``StateMachine.insert_input()``.
1979   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1980     thanks to) Fred Drake.
1982 * docutils/utils.py:
1984   - Added a ``source`` attribute to Reporter instances and
1985     ``system_message`` elements.
1986   - Added an observer pattern to ``utils.Reporter`` to keep track of
1987     system messages.
1988   - Fixed bugs in ``relative_path()``.
1989   - Added support for improved diagnostics.
1990   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1991   - Added support for encoding Reporter stderr output, and encoding
1992     error handlers.
1993   - Reporter keeps track of the highest level system message yet
1994     generated.
1996 * docutils/languages: Fixed bibliographic field language lookups.
1998 * docutils/languages/es.py: Added to project; Spanish mappings by
1999   Marcelo Huerta San Martin.
2001 * docutils/languages/fr.py: Added to project; French mappings by
2002   Stefane Fermigier.
2004 * docutils/languages/it.py: Added to project; Italian mappings by
2005   Nicola Larosa.
2007 * docutils/languages/sk.py: Added to project; Slovak mappings by
2008   Miroslav Vasko.
2010 * docutils/parser/__init__.py:
2012   - Added ``Parser.finish_parse()`` method.
2014 * docutils/parser/rst/__init__.py:
2016   - Added options: "--pep-references", "--rfc-references",
2017     "--tab-width", "--trim-footnote-reference-space".
2019 * docutils/parsers/rst/states.py:
2021   - Changed "title under/overline too short" system messages from INFO
2022     to WARNING, and fixed its insertion location.
2023   - Fixed enumerated list item parsing to allow paragraphs & section
2024     titles to begin with enumerators.
2025   - Converted system messages to use the new "line" attribute.
2026   - Fixed a substitution reference edge case.
2027   - Added support for "--pep-references" and "--rfc-references"
2028     options; reworked ``Inliner`` code to make customization easier.
2029   - Removed field argument parsing.
2030   - Added support for short section title over/underlines.
2031   - Fixed "simple reference name" regexp to ignore text like
2032     "object.__method__"; not an anonymous reference.
2033   - Added support for improved diagnostics.
2034   - Reworked directive API, based on Dethe Elza's contribution.  Added
2035     ``Body.parse_directive()``, ``.parse_directive_options()``,
2036     ``.parse_directive_arguments()`` methods.
2037   - Added ``ExtensionOptions`` class, to parse directive options
2038     without parsing field bodies.  Factored
2039     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2040     ``ExtensionOptions``.
2041   - Improved definition list term/classifier parsing.
2042   - Added warnings for unknown directives.
2043   - Renamed ``Stuff`` to ``Struct``.
2044   - Now flagged as errors: transitions at the beginning or end of
2045     sections, empty sections (except title), and empty documents.
2046   - Updated for ``statemachine.StringList``.
2047   - Enabled recognition of schemeless email addresses in targets.
2048   - Added support for embedded URIs in hyperlink references.
2049   - Added backslash-escapes to inline markup end-string suffix.
2050   - Added support for correct interpreted text processing.
2051   - Fixed nested title parsing (topic, sidebar directives).
2052   - Added special processing of backslash-escaped whitespace (idea
2053     from David Abrahams).
2054   - Made substitutions case-sensitive-but-forgiving; moved some code
2055     to ``docutils.nodes``.
2056   - Added support for block quote attributions.
2057   - Added a kludge to work-around a conflict between the bubble-up
2058     parser strategy and short titles (<= 3 char-long over- &
2059     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2060     titles" submitted by Jason Diamond.
2061   - Added explicit interpreted text roles for standard inline markup:
2062     "emphasis", "strong", "literal".
2063   - Implemented "superscript" and "subscript" interpreted text roles.
2064   - Added initial support for "abbreviation" and "acronym" roles;
2065     incomplete.
2066   - Added support for "--trim-footnote-reference-space" option.
2067   - Optional space before colons in directives & hyperlink targets.
2069 * docutils/parsers/rst/tableparser.py:
2071   - Fixed a bug that was producing unwanted empty rows in "simple"
2072     tables.
2073   - Detect bad column spans in "simple" tables.
2075 * docutils/parsers/rst/directives: Updated all directive functions to
2076   new API.
2078 * docutils/parsers/rst/directives/__init__.py:
2080   - Added ``flag()``, ``unchanged()``, ``path()``,
2081     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2082     directive option helper functions.
2083   - Added warnings for unknown directives.
2084   - Return ``None`` for missing directives.
2085   - Added ``register_directive()``, thanks to William Dode and Paul
2086     Moore.
2088 * docutils/parsers/rst/directives/admonitions.py:
2090   - Added "admonition" directive.
2092 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2093   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2094   "parsed-literal", "rubric", "epigraph", "highlights" and
2095   "pull-quote" directives.
2097 * docutils/parsers/rst/directives/images.py:
2099   - Added an "align" attribute to the "image" & "figure" directives
2100     (by Adam Chodorowski).
2101   - Added "class" option to "image", and "figclass" to "figure".
2103 * docutils/parsers/rst/directives/misc.py:
2105   - Added "include", "raw", and "replace" directives, courtesy of
2106     Dethe Elza.
2107   - Added "unicode" and "class" directives.
2109 * docutils/parsers/rst/directives/parts.py:
2111   - Added the "sectnum" directive; by Dmitry Jemerov.
2112   - Added "class" option to "contents" directive.
2114 * docutils/parsers/rst/directives/references.py: Added to project.
2115   Contains the "target-notes" directive.
2117 * docutils/parsers/rst/languages/__init__.py:
2119   - Return ``None`` from get_language() for missing language modules.
2121 * docutils/parsers/rst/languages/de.py: Added to project; German
2122   mappings by Engelbert Gruber.
2124 * docutils/parsers/rst/languages/en.py:
2126   - Added interpreted text roles mapping.
2128 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2129   mappings by Marcelo Huerta San Martin.
2131 * docutils/parsers/rst/languages/fr.py: Added to project; French
2132   mappings by William Dode.
2134 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2135   mappings by Nicola Larosa.
2137 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2138   mappings by Miroslav Vasko.
2140 * docutils/readers/__init__.py:
2142   - Added support for the observer pattern from ``utils.Reporter``, in
2143     ``Reader.parse`` and ``Reader.transform``.
2144   - Removed ``Reader.transform()`` method.
2145   - Added default parameter values to ``Reader.__init__()`` to make
2146     instantiation easier.
2147   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2149 * docutils/readers/pep.py:
2151   - Added the ``peps.TargetNotes`` transform to the Reader.
2152   - Removed PEP & RFC reference detection code; moved to
2153     parsers/rst/states.py as options (enabled here by default).
2154   - Added support for pre-acceptance PEPs (no PEP number yet).
2155   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2156     easy subclassing.
2158 * docutils/readers/python: Python Source Reader subpackage added to
2159   project, including preliminary versions of:
2161   - __init__.py
2162   - moduleparser.py: Parser for Python modules.
2164 * docutils/transforms/__init__.py:
2166   - Added ``Transformer`` class and completed transform reform.
2167   - Added unknown_reference_resolvers list for each transformer. This list holds
2168     the list of functions provided by each component of the transformer that
2169     help resolve references.
2171 * docutils/transforms/frontmatter.py:
2173   - Improved support for generic fields.
2174   - Fixed bibliographic field language lookups.
2176 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2177   transforms.
2179 * docutils/transforms/parts.py:
2181   - Moved the "id" attribute from TOC list items to the references
2182     (``Contents.build_contents()``).
2183   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2184   - Added "class" attribute support to ``Contents``.
2186 * docutils/transforms/peps.py:
2188   - Added ``mask_email()`` function, updating to pep2html.py's
2189     functionality.
2190   - Linked "Content-Type: text/x-rst" to PEP 12.
2191   - Added the ``TargetNotes`` PEP-specific transform.
2192   - Added ``TargetNotes.cleanup_callback``.
2193   - Added title check to ``Headers``.
2195 * docutils/transforms/references.py:
2197   - Added the ``TargetNotes`` generic transform.
2198   - Split ``Hyperlinks`` into multiple transforms.
2199   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2200   - Added check for circular indirect references.
2201   - Made substitutions case-sensitive-but-forgiving.
2203 * docutils/transforms/universal.py:
2205   - Added support for the "--expose-internal-attributes" option.
2206   - Removed ``Pending`` transform classes & data.
2208 * docutils/writers/__init__.py:
2210   - Removed ``Writer.transform()`` method.
2212 * docutils/writers/docutils-xml.py:
2214   - Added XML and doctype declarations.
2215   - Added "--no-doctype" and "--no-xml-declaration" options.
2217 * docutils/writers/html4css1.py:
2219   - "name" attributes only on these tags: a, applet, form, frame,
2220     iframe, img, map.
2221   - Added "name" attribute to <a> in section titles for Netscape 4
2222     support (bug report: Pearu Peterson).
2223   - Fixed targets (names) on footnote, citation, topic title,
2224     problematic, and system_message nodes (for Netscape 4).
2225   - Changed field names from "<td>" to "<th>".
2226   - Added "@" to "&#64;" encoding to thwart address harvesters.
2227   - Improved the vertical whitespace optimization; ignore "invisible"
2228     nodes (targets, comments, etc.).
2229   - Improved inline literals with ``<span class="pre">`` around chunks
2230     of text and ``&nbsp;`` for runs of spaces.
2231   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2232     ``self.docinfo`` segments.
2233   - Added support for "line_block", "address" elements.
2234   - Improved backlinks (footnotes & system_messages).
2235   - Improved system_message output.
2236   - Redefined "--stylesheet" as containing an invariant URL, used
2237     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2238     working directory.
2239   - Added "--footnote-references" option (superscript or brackets).
2240   - Added "--compact-lists" and "--no-compact-lists" options.
2241   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2242     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2243   - Improved field list rendering.
2244   - Added Docutils version to "generator" meta tag.
2245   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2246   - Improved layout of <pre> HTML source.
2247   - Fixed attribute typo on <colspec>.
2248   - Refined XML prologue.
2249   - Support for no stylesheet.
2250   - Removed "interpreted" element support.
2251   - Added support for "title_reference", "sidebar", "attribution",
2252     "rubric", and generic "admonition" elements.
2253   - Added "--attribution" option.
2254   - Added support for "inline", "subscript", "superscript" elements.
2255   - Added initial support for "abbreviation" and "acronym";
2256     incomplete.
2258 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2259   (from the sandbox).
2261   - Added french.
2262   - Double quotes in literal blocks (special treatment for de/ngerman).
2263   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2264   - Added  "--attribution" option.
2265   - Right align attributions.
2267 * docutils/writers/pep_html.py:
2269   - Parameterized output encoding in PEP template.
2270   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2271   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2272     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2273     working directory.
2274   - Added an override on the "--footnote-references" option.
2275   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2276   - Added Docutils version to "generator" meta tag.
2277   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2279 * docs/tools.txt:
2281   - Added a "silent" setting for ``buildhtml.py``.
2282   - Added a "Getting Help" section.
2283   - Rearranged the structure.
2284   - Kept up to date, with new settings, command-line options etc.
2285   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2286   - Converted settings table into a definition list.
2288 * docs/rst/quickstart.txt:
2290   - Added a table of contents.
2291   - Added feedback information.
2292   - Added mention of minimum section title underline lengths.
2293   - Removed the 4-character minimum for section title underlines.
2295 * docs/rst/quickref.html:
2297   - Added a "Getting Help" section.
2298   - Added a style to make section title backlinks more subtle.
2299   - Added mention of minimum section title underline lengths.
2300   - Removed the 4-character minimum for section title underlines.
2302 * extras: Directory added to project; contains third-party modules
2303   that Docutils depends on (optparse, textwrap, roman).  These are
2304   only installed if they're not already present.
2306 * licenses: Directory added to project; contains copies of license
2307   files for non-public-domain files.
2309 * spec/doctree.txt:
2311   - Changed the focus.  It's about DTD elements:  structural
2312     relationships, semantics, and external (public) attributes.  Not
2313     about the element class library.
2314   - Moved some implementation-specific stuff into ``docutils.nodes``
2315     docstrings.
2316   - Wrote descriptions of all common attributes and parameter
2317     entities.  Filled in introductory material.
2318   - Working through the element descriptions: 55 down, 37 to go.
2319   - Removed "Representation of Horizontal Rules" to
2320     spec/rst/alternatives.txt.
2322 * spec/docutils.dtd:
2324   - Added "generated" inline element.
2325   - Added "line_block" body element.
2326   - Added "auto" attribute to "title".
2327   - Changed content models of "literal_block" and "doctest_block" to
2328     ``%text.model``.
2329   - Added ``%number;`` attribute type parameter entity.
2330   - Changed ``%structural.elements;`` to ``%section.elements``.
2331   - Updated attribute types; made more specific.
2332   - Added "address" bibliographic element.
2333   - Added "line" attribute to ``system_message`` element.
2334   - Removed "field_argument" element; "field_name" may contain
2335     multiple words and whitespace.
2336   - Changed public identifier to docutils.sf.net.
2337   - Removed "interpreted" element; added "title_reference",
2338     "abbreviation", "acronym".
2339   - Removed "refuri" attribute from "footnote_reference" and
2340     "citation_reference".
2341   - Added "sidebar", "rubric", "attribution", "admonition",
2342     "superscript", "subscript", and "inline" elements.
2344 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2346 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2348 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2350 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2351   Dallas Mahrt.
2353 * spec/transforms.txt: Added to project.
2355 * spec/howto: Added subdirectory, for developer how-to docs.
2357 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2358   Elza, edited & extended by David Goodger.
2360 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2361   project.
2363 * spec/rst/alternatives.txt:
2365   - Added "Doctree Representation of Transitions" from
2366     spec/doctree.txt.
2367   - Updated "Inline External Targets" & closed the debate.
2368   - Added ideas for interpreted text syntax extensions.
2369   - Added "Nested Inline Markup" section.
2371 * spec/rst/directives.txt:
2373   - Added directives: "topic", "sectnum", "target-notes",
2374     "line-block", "parsed-literal", "include", "replace", "sidebar",
2375     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2376     "class".
2377   - Formalized descriptions of directive details.
2378   - Added an "align" attribute to the "image" & "figure" directives
2379     (by Adam Chodorowski).
2380   - Added "class" options to "topic", "sidebar", "line-block",
2381     "parsed-literal", "contents", and "image"; and "figclass" to
2382     "figure".
2384 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2385   interpreted text roles.
2387 * spec/rst/introduction.txt:
2389   - Added pointers to material for new users.
2391 * spec/rst/reStructuredText.txt:
2393   - Disambiguated comments (just add a newline after the "::").
2394   - Updated enumerated list description; added a discussion of the
2395     second-line validity checking.
2396   - Updated directive description.
2397   - Added a note redirecting newbies to the user docs.
2398   - Expanded description of inline markup start-strings in non-markup
2399     contexts.
2400   - Removed field arguments and made field lists a generic construct.
2401   - Removed the 4-character minimum for section title underlines.
2402   - Clarified term/classifier delimiter & inline markup ambiguity
2403     (definition lists).
2404   - Added "Embedded URIs".
2405   - Updated "Interpreted Text" section.
2406   - Added "Character-Level Inline Markup" section.
2408 * test: Continually adding & updating tests.
2410   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2411   - Moved test/test_pep/ to test/test_readers/test_pep/.
2412   - Added test/test_readers/test_python/.
2413   - Added test/test_writers/ (Engelbert Gruber).
2415 * tools:
2417   - Made the ``locale.setlocale()`` calls in front ends
2418     fault-tolerant.
2420 * tools/buildhtml.py:
2422   - Added "--silent" option.
2423   - Fixed bug with absolute paths & "--config".
2424   - Updated for new I/O classes.
2425   - Added some exception handling.
2426   - Separated publishers' setting defaults; prevents interference.
2427   - Updated for new ``publish_file()`` convenience function.
2429 * tools/pep-html-template:
2431   - Allow for "--embed-stylesheet".
2432   - Added Docutils version to "generator" meta tag.
2433   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2434   - Conform to XHTML spec.
2436 * tools/pep2html.py:
2438   - Made ``argv`` a parameter to ``main()``.
2439   - Added support for "Content-Type:" header & arbitrary PEP formats.
2440   - Linked "Content-Type: text/plain" to PEP 9.
2441   - Files skipped (due to an error) are not pushed onto the server.
2442   - Updated for new I/O classes.
2443   - Added ``check_requirements()`` & ``pep_type_error()``.
2444   - Added some exception handling.
2445   - Updated for new ``publish_string()`` convenience function.
2446   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2448 * tools/quicktest.py:
2450   - Added "-V"/"--version" option.
2452 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2454 * tools/unicode2rstsubs.py: Added to project.  Produces character
2455   entity files (reSructuredText substitutions) from the MathML master
2456   unicode.xml file.
2458 * tools/editors: Support code for editors, added to project.  Contains
2459   ``emacs/restructuredtext.el``.
2461 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2463   - Added style for chunks of inline literals.
2464   - Removed margin for first child of table cells.
2465   - Right-aligned field list names.
2466   - Support for auto-numbered section titles in TOCs.
2467   - Increased the size of inline literals (<tt>) in titles.
2468   - Restored the light gray background for inline literals.
2469   - Added support for "line_block" elements.
2470   - Added style for "address" elements.
2471   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2472   - Improved field list rendering.
2473   - Vertical whitespace improvements.
2474   - Removed "a.target" style.
2476 * tools/stylesheets/pep.css:
2478   - Fixed nested section margins.
2479   - Other changes parallel those of ``../default.css``.
2482 Release 0.2 (2002-07-31)
2483 ========================
2485 General:
2487 - The word "component" was being used ambiguously.  From now on,
2488   "component" will be used to mean "Docutils component", as in Reader,
2489   Writer, Parser, or Transform.  Portions of documents (Table of
2490   Contents, sections, etc.)  will be called "document parts".
2491 - Did a grand renaming: a lot of ``verylongnames`` became
2492   ``very_long_names``.
2493 - Cleaned up imports: no more relative package imports or
2494   comma-separated lists of top-level modules.
2495 - Added support for an option values object which carries default
2496   settings and overrides (from command-line options and library use).
2497 - Added internal Unicode support, and support for both input and
2498   output encodings.
2499 - Added support for the ``docutils.io.IO`` class & subclasses.
2501 Specific:
2503 * docutils/__init__.py:
2505   - Added ``ApplicationError`` and ``DataError``, for use throughout
2506     the package.
2507   - Added ``Component`` base class for Docutils components; implements
2508     the ``supports`` method.
2509   - Added ``__version__`` (thus, ``docutils.__version__``).
2511 * docutils/core.py:
2513   - Removed many keyword parameters to ``Publisher.__init__()`` and
2514     ``publish()``; bundled into an option values object.  Added
2515     "argv", "usage", "description", and "option_spec" parameters for
2516     command-line support.
2517   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2518     methods.
2519   - Reworked I/O model for ``docutils.io`` wrappers.
2520   - Updated ``Publisher.set_options()``; now returns option values
2521     object.
2522   - Added support for configuration files (/etc/docutils.conf,
2523     ./docutils.conf, ~/.docutils).
2524   - Added ``Publisher.setup_option_parser()``.
2525   - Added default usage message and description.
2527 * docutils/frontend.py: Added to project; support for front-end
2528   (command-line) scripts.  Option specifications may be augmented by
2529   components.  Requires Optik (http://optik.sf.net/) for option
2530   processing (installed locally as docutils/optik.py).
2532 * docutils/io.py: Added to project; uniform API for a variety of input
2533   output mechanisms.
2535 * docutils/nodes.py:
2537   - Added ``TreeCopyVisitor`` class.
2538   - Added a ``copy`` method to ``Node`` and subclasses.
2539   - Added a ``SkipDeparture`` exception for visitors.
2540   - Renamed ``TreePruningException`` from ``VisitorException``.
2541   - Added docstrings to ``TreePruningException``, subclasses, and
2542     ``Nodes.walk()``.
2543   - Improved docstrings.
2544   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2545   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2546     imports.
2547   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2548     ``PreDecorative`` mixin.
2549   - Reworked the name/id bookkeeping; to ``document``, removed
2550     ``explicit_targets`` and ``implicit_targets`` attributes, added
2551     ``nametypes`` attribute and ``set_name_id_map`` method.
2552   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2553     traversals.
2554   - Added ``document.has_name()`` method.
2555   - Fixed DOM generation for list-attributes.
2556   - Added category class ``Labeled`` (used by footnotes & citations).
2557   - Added ``Element.set_class()`` method (sets "class" attribute).
2559 * docutils/optik.py: Added to project.  Combined from the Optik
2560   package, with added option groups and other modifications.  The use
2561   of this module is probably only temporary.
2563 * docutils/statemachine.py:
2565   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2566   - Added underscores to improve many awkward names.
2567   - In ``string2lines()``, changed whitespace normalizing translation
2568     table to regexp; restores Python 2.0 compatibility with Unicode.
2570 * docutils/urischemes.py:
2572   - Filled in some descriptions.
2573   - Added "shttp" scheme.
2575 * docutils/utils.py:
2577   - Added ``clean_rcs_keywords`` function (moved from
2578     docutils/transforms/frontmatter.py
2579     ``DocInfo.filter_rcs_keywords``).
2580   - Added underscores to improve many awkward names.
2581   - Changed names of Reporter's thresholds:
2582     warning_level -> report_level; error_level -> halt_level.
2583   - Moved ``utils.id()`` to ``nodes.make_id()``.
2584   - Added ``relative_path(source, target)``.
2586 * docutils/languages/de.py: German mappings; added to project.  Thanks
2587   to Gunnar Schwant for the translations.
2589 * docutils/languages/en.py: Added "Dedication" bibliographic field
2590   mappings.
2592 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2593   Chodorowski.
2595 * docutils/parsers/rst/states.py:
2597   - Added underscores to improve many awkward names.
2598   - Added RFC-2822 header support.
2599   - Extracted the inline parsing code from ``RSTState`` to a separate
2600     class, ``Inliner``, which will allow easy subclassing.
2601   - Made local bindings for ``memo`` container & often-used contents
2602     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2603   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2604   - Added ``MarkupMismatch`` exception; for late corrections.
2605   - Added ``-/:`` characters to inline markup's start string prefix,
2606     ``/`` to end string suffix.
2607   - Fixed a footnote bug.
2608   - Fixed a bug with literal blocks.
2609   - Applied patch from Simon Budig: simplified regexps with symbolic
2610     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2611   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2612   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2613   - Allowed non-ASCII in "simple names" (directive names, field names,
2614     references, etc.).
2615   - Converted ``Inliner.patterns.initial`` to be dynamically built
2616     from parts with ``build_regexp()`` function.
2617   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2618   - Updated docstrings.
2619   - Changed "table" to "grid_table"; added "simple_table" support.
2621 * docutils/parsers/rst/tableparser.py:
2623   - Changed ``TableParser`` to ``GridTableParser``.
2624   - Added ``SimpleTableParser``.
2625   - Refactored naming.
2627 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2628   a fallback language for directive names.
2630 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2631   directive to use a ``pending`` element, used only by HTML writers.
2633 * docutils/parsers/rst/directives/parts.py: Renamed from
2634   components.py.
2636   - Added "backlinks" attribute to "contents" directive.
2638 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2639   project by Adam Chodorowski.
2641 * docutils/readers/__init__.py: Gave Readers more control over
2642   choosing and instantiating Parsers.
2644 * docutils/readers/pep.py: Added to project; for PEP processing.
2646 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2647   requires a ``component`` parameter.
2649 * docutils/transforms/components.py: Added to project; transforms
2650   related to Docutils components.
2652 * docutils/transforms/frontmatter.py:
2654   - In ``DocInfo.extract_authors``, check for a single "author" in an
2655     "authors" group, and convert it to a single "author" element.
2656   - Added support for "Dedication" and generic bibliographic fields.
2658 * docutils/transforms/peps.py: Added to project; PEP-specific.
2660 * docutils/transforms/parts.py: Renamed from old components.py.
2662   - Added filter for `Contents`, to use alt-text for inline images,
2663     and to remove inline markup that doesn't make sense in the ToC.
2664   - Added "name" attribute to TOC topic depending on its title.
2665   - Added support for optional TOC backlinks.
2667 * docutils/transforms/references.py: Fixed indirect target resolution
2668   in ``Hyperlinks`` transform.
2670 * docutils/transforms/universal.py:
2672   - Changed ``Messages`` transform to properly filter out system
2673     messages below the warning threshold.
2674   - Added ``Decorations`` transform (support for ``--generator``,
2675     ``--date``, ``--time``, ``--source-link`` options).
2677 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2678   Engelbert Gruber's PDF writer.
2680 * docutils/writers/html4css1.py:
2682   - Made XHTML-compatible (switched to lowercase element & attribute
2683     names; empty tag format).
2684   - Escape double-dashes in comment text.
2685   - Improved boilerplate & modularity of output.
2686   - Exposed modular output in Writer class.
2687   - Added a "generator" meta tag to <head>.
2688   - Added support for the ``--stylesheet`` option.
2689   - Added support for ``decoration``, ``header``, and ``footer``
2690     elements.
2691   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2692     translation table to regexp; restores Python 2.0 compatibility
2693     with Unicode.
2694   - Added the translator class as instance variable to the Writer, to
2695     make it easily subclassable.
2696   - Improved option list spacing (thanks to Richard Jones).
2697   - Modified field list output.
2698   - Added backlinks to footnotes & citations.
2699   - Added percentage widths to "<col>" tags (from colspec).
2700   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2701     "<span>" changed to "<var>".
2702   - Inline literals: "<code>" changed to "<tt>".
2703   - Many changes to optimize vertical space: compact simple lists etc.
2704   - Add a command-line options & directive attributes to control TOC
2705     and footnote/citation backlinks.
2706   - Added support for optional footnote/citation backlinks.
2707   - Added support for generic bibliographic fields.
2708   - Identify backrefs.
2709   - Relative URLs for stylesheet links.
2711 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2712   PEPs (subclass of ``html4css1.Writer``).
2714 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2716 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2717   of the Docutils internal doctree in XML.
2719 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2721 * spec/doctree.txt:
2723   - Changed the title to "The Docutils Document Tree".
2724   - Added "Hyperlink Bookkeeping" section.
2726 * spec/docutils.dtd:
2728   - Added ``decoration``, ``header``, and ``footer`` elements.
2729   - Brought ``interpreted`` element in line with the parser: changed
2730     attribute "type" to "role", added "position".
2731   - Added support for generic bibliographic fields.
2733 * spec/notes.txt: Continual updates.  Added "Project Policies".
2735 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2736   section.
2738 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2740 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2741   mailing list discussions.
2743 * spec/pep-0287.txt:
2745   - Renamed to "reStructuredText Docstring Format".
2746   - Minor edits.
2747   - Reworked Q&A as an enumerated list.
2748   - Converted to reStructuredText format.
2750 * spec/pysource.dtd:
2752   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2754 * spec/pysource.txt: Removed from project.  Moved much of its contents
2755   to pep-0258.txt.
2757 * spec/rst/alternatives.txt:
2759   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2760   - Added "Inline External Targets" section.
2762 * spec/rst/directives.txt:
2764   - Added "backlinks" attribute to "contents" directive.
2766 * spec/rst/problems.txt:
2768   - Updated the Enumerated List Markup discussion.
2769   - Added new alternative table markup syntaxes.
2771 * spec/rst/reStructuredText.txt:
2773   - Clarified field list usage.
2774   - Updated enumerated list description.
2775   - Clarified purpose of directives.
2776   - Added ``-/:`` characters to inline markup's start string prefix,
2777     ``/`` to end string suffix.
2778   - Updated "Authors" bibliographic field behavior.
2779   - Changed "inline hyperlink targets" to "inline internal targets".
2780   - Added "simple table" syntax to supplement the existing but
2781     newly-renamed "grid tables".
2782   - Added cautions for anonymous hyperlink use.
2783   - Added "Dedication" and generic bibliographic fields.
2785 * test: Made test modules standalone (subdirectories became packages).
2787 * test/DocutilsTestSupport.py:
2789   - Added support for PEP extensions to reStructuredText.
2790   - Added support for simple tables.
2791   - Refactored naming.
2793 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2795   - Now supports true packages containing test modules
2796     (``__init__.py`` files required); fixes duplicate module name bug.
2798 * test/test_pep/: Subpackage added to project; PEP testing.
2800 * test/test_rst/test_SimpleTableParser.py: Added to project.
2802 * tools:
2804   - Updated html.py and publish.py front-end tools to use the new
2805     command-line processing facilities of ``docutils.frontend``
2806     (exposed in ``docutils.core.Publisher``), reducing each to just a
2807     few lines of code.
2808   - Added ``locale.setlocale()`` calls to front-end tools.
2810 * tools/buildhtml.py: Added to project; batch-generates .html from all
2811   the .txt files in directories and subdirectories.
2813 * tools/default.css:
2815   - Added support for ``header`` and ``footer`` elements.
2816   - Added styles for "Dedication" topics (biblio fields).
2818 * tools/docutils.conf: A configuration file; added to project.
2820 * tools/docutils-xml.py: Added to project.
2822 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2824 * tools/pep-html-template: Added to project.
2826 * tools/pep2html.py: Added to project from Python (nondist/peps).
2827   Added support for Docutils (reStructuredText PEPs).
2829 * tools/quicktest.py:
2831   - Added the ``--attributes`` option, hacked a bit.
2832   - Added a second command-line argument (output file); cleaned up.
2834 * tools/stylesheets/: Subdirectory added to project.
2836 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2839 Release 0.1 (2002-04-20)
2840 ========================
2842 This is the first release of Docutils, merged from the now inactive
2843 reStructuredText__ and `Docstring Processing System`__ projects.  For
2844 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2845 `DPS HISTORY`__ files.
2847 __ http://structuredtext.sourceforge.net/
2848 __ http://docstring.sourceforge.net/
2849 __ http://structuredtext.sourceforge.net/HISTORY.html
2850 __ http://docstring.sourceforge.net/HISTORY.html
2852 General changes: renamed 'dps' package to 'docutils'; renamed
2853 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2854 the test suites (reStructuredText's test/test_states renamed to
2855 test/test_rst); and all modifications required to make it all work.
2857 * docutils/parsers/rst/states.py:
2859   - Improved diagnostic system messages for missing blank lines.
2860   - Fixed substitution_reference bug.
2864    Local Variables:
2865    mode: indented-text
2866    indent-tabs-mode: nil
2867    sentence-end-double-space: t
2868    fill-column: 70
2869    End: