Add link to substitution definitions for inline images.
[docutils.git] / HISTORY.txt
blobc114ec3d3cd67c9f1b2411736a6d4b314a6f8984
1 .. -*- coding: utf-8 -*-
3 ==================
4  Docutils History
5 ==================
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
9 :Date: $Date$
10 :Revision: $Revision$
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
14 .. contents::
16 Changes Since 0.9.1
17 ===================
19 * General
20   
21   - Dropped support for Python 2.3.
22   - ``docutils/math``, ``docutils/error_reporting.py``, and
23     ``docutils/urischemes.py`` moved to the utils package.
24   - Fix [3541369] Relative __import__ also with Python 3.3.
25   - Fix [3559988] and [3560841] __import__ local writer, reader, languages 
26     and parsers for Python 2.7 up.
27   - Fix import of PIL.Image.
28   - Change default of "syntax highlight" option to "long", 
29     basic syntax highlight styles for LaTeX and HTML.
31 * docutils/io.py
33   - FileInput/FileOutput: no system-exit on IOError.  The `handle_io_errors`
34     option is ignored and will be removed in a future release.
35   - Fix Py3k error writing to stdout with encoding differing from default.
37 * docutils/parsers/rst/directives/misc.py
39   - Fix [ 3546533 ] Unicode error with `date` directive.
41 * docutils/transforms/universal.py
43   - Add SmartQuotes transform for typographic quotes and dashes.
45 * docutils/writers/html4css1/__init__.py
47   - Use ``<code>`` tag for inline "code",
48     do not drop nested inline nodes (syntax highlight tokens).
49   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
50   - No line break after opening inline math tag.
52 * docutils/writers/manpage.py
54   - Apply [ 3527401 ] addmonition's don't preserve indentation
55   - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
57 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
59   - Apply [ 3555160 ] ensure order of "otherlanguages".
60   - Fix section numbering by LaTeX.
62 * docutils/writers/s5_html/__init__.py
64   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
66 * docutils/writers/s5_html/docutils_xml.py
68   - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
70 * setup.py
72   - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
74 * tools/test/test_buildhtml.py
76   - Fix [ 3521167 ] allow running in any directory.
77   - Fix [ 3521168 ] allow running with Python 3.
80 Release 0.9.1 (2012-06-17)
81 ==========================
83 * setup.py
85   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
86     installed in the PYTHONPATH. Converted tests are now
87     stored in ``test3/``, tools no longer need conversion.
89     If you installed one of Docutils versions 0.7 ... 0.9 with
90     ``setup.py install`` under Python 3, remove the spurious
91     ``test/`` and ``tools/`` directories in the site library root.
93 * test/
95   - Make tests independent from the location of the ``test/`` directory.
96   - Use converted sources (from the ``build/`` directory) for tests under
97     Python 3.
99 * tools/
101   - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
103 * docutils/io.py
105   - Fix writing binary data to sys.stdout under Python 3 (allows
106     ``rst2odt.py`` to be used with output redirection).
108 * docutils/parsers/rst/directives/misc.py
110   - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
111     ``locale == C`` and 8-bit char in path argument of `include` directive.
113 * test/alltests.py
115   - class `Tee`: catch UnicodeError when writing to "ascii" stream or
116     file under Python 3.
118 Release 0.9 (2012-05-02)
119 ========================
121 * General:
123   - New reStructuredText "code" role and directive and "code" option
124     of the "include" directive with syntax highlighting by Pygments_.
125   - Fix parse_option_marker for option arguments containing ``=``.
126   - Fix [ 2993756 ]: import Python Imaging Library's Image module
127     via ``import PIL`` as starting with PIL 1.2,
128     "PIL lives in the PIL namespace only" (announcement__).
130 .. _Pygments: http://pygments.org/
131 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
133 * setup.py
135   - Fix [ 2971827 ] and [ 3442827 ]
136     extras/roman.py moved to docutils/utils/roman.py
138 * docutils/frontend.py
140   - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
142 * docutils/io.py
144   - Fix [ 3395948 ] (Work around encoding problems in Py3k).
145   - `mode` argument for FileOutput avoids code replication in
146     BinaryFileOutput.
147   - New exceptions InputError and OutputError for IO errors in
148     FileInput/FileOutput.
150 * docutils/core.py:
152   - No "hard" system exit on file IO errors: catch and report them in
153     `Publisher.reportException` instead. Allows handling by a calling
154     application if the configuration setting `traceback` is True.
156 * docutils/utils.py -> docutils/utils/__init__.py
158   - docutils.utils is now a package (providing a place for sub-modules)
160   .. note:: docutils/math, docutils/error_reporting.py, and
161      docutils/urischemes.py will move to the utils package in the next
162      release, too. See RELEASE-NOTES__
164      __ RELEASE-NOTES.html
166   - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
167     errors recording non-ASCII filenames (fixes [ 3434355 ]).
169   - Fix relative_path() with source=None and `unicode` target.
171 * docutils/parsers/rst/states.py
173   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
174     characters and "international" quotes around inline markup.
175   - Use `field_marker` pattern to look for start of a
176     directive option block (fixes [ 3484857 ]).
178 * docutils/parsers/rst/tableparser.py
180   - Fix [ 2926161 ] for simple tables.
181     (Combining chars in grid tables still contribute to cell width.)
183 * docutils/writers/latex2e/__init__.py
185   - Support the `abbreviation` and `acronym` standard roles.
186   - Record only files required to generate the LaTeX source as dependencies.
187   - Fix handling of missing stylesheets.
188   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
189     when suppressing LaTeX section numbering.
190   - Use ``\DUtitle`` for unsupported section levels
191   - Apply [ 3512791 ] do not compare string literals with "is"
193 * docutils/writers/xetex/__init__.py
195   - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
197 * docutils/writers/html4css1/__init__.py
199   - Change default for `math-output` setting to MathJax.
200   - Fix handling of missing stylesheets.
202 * docutils/writers/docutils_xml.py
204   - Use the visitor pattern with default_visit()/default_depart() methods
205     instead of minidom to facilitate special handling of selected nodes.
206   - Support raw XML (inserted as-is inside a <raw></raw> node).
208 * docutils/writers/manpage.py
210   - Do not emit comment line with trailing blank. Problematic for VCS.
212 Release 0.8.1 (2011-08-30)
213 ==========================
215 * General:
217   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
218     and [ 3395920 ] (correct copyright info for rst.el).
220 * test/
222   -  Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
224 * docutils/writers/latex2e/__init__.py
226   - Clean up Babel language setting. Restores Sphinx compatibility.
228 Release 0.8 (2011-07-07)
229 ========================
231 * General:
233   - Handle language codes according to `BCP 47`_.
234   - If the specified language is not supported by Docutils,
235     warn and fall back to English.
236   - Math support: reStructuredText "math" role and directive,
237     ``math`` and ``math_block`` doctree elements.
238   - Decode command line arguments with the locale's preferred encoding
239     (to allow, e.g., ``--title=Dornröschen``).
240   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
241   - New sub-module `error_reporting`: handle encoding/decoding errors
242     when reporting exceptions.
243   - Some additions to the Docutils core are released under the 2-Clause BSD
244     license, see COPYING_ for details.
246   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
247   .. _COPYING: COPYING.html
249 * reStructuredText:
251   - Most directives now support a "name" option that attaches a
252     reference name.
254   - Directive content may start on the first line also when the directive
255     type accepts options.
257 * docs/dev/policies.txt:
259   - Recommend the 2-Clause BSD license
260     (http://www.spdx.org/licenses/BSD-2-Clause)
261     for code that is kept under the author's copyright.
263 * tools/buildhtml.py:
265   - Fix ``--local`` switch.
267 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
269 * docutils/writers/html4css1/__init__.py
271   - Set "lang" argument for objects with class argument
272     "language-<language tag>".
273   - New setting "math-output" with support for HTML, MathML, and LaTeX.
275 * docutils/writers/latex2e/__init__.py
277   - Fix [ 3043986 ] AttributeError using :local: with table of content.
278   - Place title data in the document preamble.
279   - Load `babel` package only if required.
280   - Update list of supported languages.
281   - New config setting "hyperref-options".
282     No hard-coded "unicode" hyperref option (clash with xetex).
283   - Set language for custom roles, paragraphs, block-quotes, and
284     line-quotes with class argument "language-<language tag>".
285   - Fix [ 3095603 ] wrong quotes output for russian and other languages.
286   - Convert image URI to a local file path.
287   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
288     has more than one paragraph (Wolfgang Scherer).
289   - \leavevmode before longtable only when needed (prevents spurious vspace)
290   - do not advance table counter for tables without caption
292 * docutils/writers/xetex/__init__.py
294   - New writer generating LaTeX code for compiling with ``xelatex``.
296     A separate writer (inheriting from latex2e) instead of a ``--xetex``
297     option allows separate config options for XeTeX vs. LaTeX2e.
299 * docutils/writers/manpage.py
301   - Fix: BUG#3219183 - vertical space in definition lists containing markup.
302   - Fix: vertical space cleaning for option group ``.``.
304 * tools/editors/emacs/rst.el:
306   - Fix [ 3001100 ] does not handle spaces in filenames
307     (thanks to Jakub Wilk)
309 * docutils/utils.py:
311   - strip whitespace from stylesheet arguments
312   - exclude combining chars from column_width()
313     (partial fix for [ 2926161 ])
315 * docutils/parsers/rst/directives/misc.py:
317   - Fix [ 1830389 ] Replace not breaking on getting system_messages from
318     nested_parse
320 * docutils/io.py:
322   - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
323     ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
325 Release 0.7 (2010-07-07)
326 ========================
328 * General:
330   - Fix [ 2881769 ] setup configuration.
331   - Fix [ 2788716 ] reporting problems in included files.
333 * docutils/io.py
335   - FileInput opens files as text files with universal newline support
336     (mode "rU", configurable with the new optional argument "mode").
338 * docutils/nodes.py
340   - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
342 * docutils/utils.py
344   - Fix [ 2923723 ] let decode_path() tolerate path == None
346 * docutils/writers/html4css1/__init__.py
348   - Support SVG and SWF images (thanks to Stefan Rank).
349   - Generate valid XHTML for centered images with targets.
350     Use CSS classes instead of "align" tags for image alignment.
352 * docutils/writers/latex2e/__init__.py
354   - Use `transforms.writer_aux.Admonitions` to "normalize" special
355     admonitions.
356   - Use the ``\url`` command for URLs (breaks long URLs instead of
357     writing into the margin).
358   - Preserve runs of spaces in `inline literals`__.
359   - Deprecate ``figure_footnotes`` setting.
360   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
361   - New ``latex_preamble`` setting.
362   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
363   - Fix hyperlink targets (labels) for images, figures, and tables.
364   - Apply [ 2961988 ] Load babel after inputenc and fontenc.
365   - Apply [ 2961991 ] Call hyperref with unicode option.
366   - Drop the special `output_encoding`__ default ("latin-1").
367     The Docutils wide default (usually "UTF-8") is used instead.
368   - Render inline markup in document title and subtitle.
369   - Fix numbering depth with LaTeX section numbering.
370   - Update Unicode -> LaTeX translations.
371   - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
373 __ docs/ref/restructuredtext.html#inline-literals
374 __ docs/user/config.html#docutils-footnotes
375 __ docs/user/config.html#output_encoding
377 * docutils/writers/manpage.py
379   - Fix: supported attribute (thanks to peter2108).
380   - Remove trailing blanks in code (keep in sync with mercurial version).
381   - Titles level 1, that is ``.SH``, always uppercase.
382   - Apply patch from mg: literal text should be bold in man-pages.
384 * docutils/nodes.py
386   - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
387     turkish locale.
389 * setup.py:
391   - Python 3 support: copy test/ and tools/ to the build-dir
392     and convert Python sources with 2to3.
395 Release 0.6 (2009-10-11)
396 ========================
398 * General:
400   - Docutils is now compatible with Python versions from 2.3 up to 2.6
401     and convertible to 3.1 code.
403     + Node.__nonzero__ returns True instead of 1.
404     + use os.walk instead os.path.walk.
405     + minimize "types" module where possible.
406     + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
407     + Text nodes now subclass unicode rather than UserString
408       (which is gone in python 3.0).
409     + 3.0 compatibility module docutils._compat
411     + Drop 2.2 compatibility workarounds.
412     + Drop extras/optparse.py and extras/textwrap.py
413       (stdlib modules since 2.3).
415   - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
416   - Unix man page export: manpage writer moved from sandbox to Doctutils
417     core.
419   - Apply [ 1719345 ] Galician translation
420   - Apply [ 1905741 ] Polish translation
421   - Apply [ 1878977 ] make_id(): deaccent characters.
422   - Apply [ 2029251 ] return nonzero when tests fail.
423   - Fix [ 1692788 ] allow UTF-8 in style sheets.
424   - Fix [ 2781629 ] support non-ASCII chars in file names.
425   - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
426   - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
427   - Fix [ 2821266 ] --strict option works now like --halt=info.
428   - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
429   - Fix [ 1627229 ] hyperlink references in substitutions.
431   - The "newlatex" writer is orphaned.
433 * reStructuredText:
435   - Documented Unicode characters allowed as inline markup openers,
436     closers, and delimiters.
437   - Allow units for all length specifications.
438   - Allow percent sign in "scale" argument of "figure" and "image" directives.
439   - Bugfix: The "figalign" argument of a figure now works as intended
440     (aligning the figure, not its contents).
441   - Align images with class "align-[right|center|left]"
442     (allows setting the alignment of an image in a figure).
444 * docutils/nodes.py:
446   - Added ``Element.__contains__`` method, for the in-operator.
448 * docutils/parsers/rst/states.py:
450   - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
451   - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
452     " " (non-breaking space), and "¡ ¿" openers.
454 * docutils/parsers/directives/misc.py:
456   - Added ``start-line`` and ``end-line`` options to "include"
457     directive to select a range of lines.
458   - Hard tabs in literal inclusions are replaced by spaces. This is
459     configurable via the new ``tab-width`` option of the "include" directive
460     (a negative tab-width prevents tab expansion).
462 * docutils/utils.py:
464   - Add ``get_stylesheet_list`` function.
465   - Apply [ 2834836 ] print info at halt
467 * docutils/transforms/universal.py:
469   - Raise default priority of StripClasses to exclude stripped classes from
470     the ToC.
472 * docutils/writers/html4css1/__init__.py:
474   - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
475     separated list of stylesheets.
476   - Address [ 1938891 ] Inline literal text creates "pre" span only when
477     needed to prevent inter-word line wraps.
478   - Use `translate` method instead of repeated `replace` calls.
479   - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
480     classes to allow CSS styling that does not interfere with other
481     table-using constructs (field lists, citations, ...).
483 * docutils/writers/newlatex2e/__init__.py:
485   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
487 * docutils/writers/latex2e/__init__.py (see also
488   `<docs/user/docutils-05-compat.sty.html>`__) :
490   - Add ``--embed-stylesheet`` option.
491   - Apply [ 1474017 ] image vertical alignment is reversed.
492   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
493   - Change: has_key for dictionaries (not Nodes) to in-operator.
494   - Merge adjacent citations into one latex cite command.
495   - Failsave implementation of custom roles. LaTeX compilation now ignores
496     unknown classes instead of aborting with an error.
497   - Support custom roles based on standard roles.
498   - LaTeX packages can be used as ``--stylesheet`` arguments without
499     restriction. (A style sheet is now referenced with the ``\usepackage``
500     command, if it ends with ``.sty`` or has no extension.)
501   - Add ``bp`` to lenghts without unit (prevents LaTex errors).
502   - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
503   - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
504     2005-02-04 as a configurable length unit).
505   - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
506     if font-encoding is set to ''. LaTeX defaults to OT1 then.
507   - Set sub- and superscript role argument in text mode not as math.
508     Use a custom role based on sub-/superscript if you want italic shape.
509   - Shorter preamble and less dependencies: Load packages and define macros
510     only if required in the document.
511   - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
512   - New custom environments and commands with optional "classes" argument.
513   - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
514   - Better conformance to Docutils specifications with ``--use-latex-toc``.
515     Support for LaTeX generated ToC also with unnumbered sections.
516   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
517     section numbering by LaTeX.
518   - Use default font in admonitions and sidebar.
519   - Align of image in a figure defaults to 'center'.
520   - Bugfix: Newlines around targets and references prevent run-together
521     paragraphs.
522   - Fix internal hyperlinks.
523   - Use class defaults for page margins ('typearea' now optional).
524   - Float placement made configurable, default changed to "here definitely".
525   - Typeset generic topic as "quote block with title".
526   - Use template (file and configuration option).
527   - In the default template, load cmap.sty (fix text extraction in PDF) and
528     fixltx2e.sty (LaTeX patches, \textsubscript).
529   - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
530   - Use `translate` instead of repeated `replace` calls for text encoding.
531   - Hyperlinked footnotes and support for symbol footnotes and
532     ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
533   - Complete pairs of binary options
534     (``--figure-footnotes, --figure-citations, --link-stylesheet``,
535     ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
536   - New defaults:
537     - font-encoding: "T1" (formerly implicitely set by 'ae').
538     - use-latex-toc: true (ToC with page numbers).
539     - use-latex-footnotes: true (no mixup with figures).
541 * docutils/writers/manpage.py
543   - Do not print version at document end, this is done by the viewer.
544   - Do not print date at document end, this is done by the viewer.
545   - Fix storage of docinfo fields for none standard fields.
547 * docutils/tools/rst2man.py
549 Release 0.5 (2008-06-25)
550 ========================
552 * docutils/languages/he.py: Added to project: Hebrew mappings by
553   Meir Kriheli.
555 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
556   mappings by Meir Kriheli.
558 * docutils/frontend.py:
560   - Configuration files are now assumed and required to be
561     UTF-8-encoded.
562   - Paths of applied configuration files are now recorded in the
563     runtime setting ``_config_files`` (accessible via
564     ``--dump-settings``).
565   - Added ``--strip-elements-with-class`` and ``--strip-class``
566     options (``strip_elements_with_classes`` and ``strip_classes``
567     settings).
569 * docutils/io.py:
571   - Added code to determine the input encoding from data: encoding
572     declarations or the presence of byte order marks (UTF-8 & UTF-16).
573   - Added support for IronPython 1.0.
575 * docutils/nodes.py:
577   - Added ``document.__getstate__`` method, for pickling.
579 * docutils/parsers/rst/states.py:
581   - Allow ``+`` and ``:`` in reference names.
582   - Unquoted targets beginning with an underscore (``.. __target:
583     URI``) are no longer accepted.
584   - Added support for multiple attributions in a physical block quote
585     (indented text block), dividing it into multiple logical block
586     quotes.
587   - Added support for unicode bullets in bullet lists: "•", "‣", and
588     "⁃".
589   - Added support for new object-oriented directive interface,
590     retaining compatibility to the old functional interface.
591   - Added support for throwing ``DirectiveError``'s from within
592     directive code.
594 * docutils/parsers/rst/__init__.py:
596   - Added ``Directive`` base class.
597   - Added ``DirectiveError`` base class.
598   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
599     definitions.
601 * docutils/parsers/directives/:
603   - Refactored all reStructuredText directives to use the new
604     object-oriented directive interface.  Errors are now (mostly)
605     thrown using the new ``DirectiveError`` class.
607 * docutils/parsers/directives/misc.py:
609   - Added ``start-after`` and ``end-before`` options to ``include``
610     directive; thanks to Stefan Rank.
612 * docutils/transforms/universal.py:
614   - Added ``StripClassesAndElements`` transform to remove from the
615     document tree all elements with classes in
616     ``settings.strip_elements_with_classes`` and all "classes"
617     attribute values in ``self.document.settings.strip_classes``.
619 * docutils/transforms/writer_aux.py:
621   - Added ``Admonitions`` transform to transform specific admonitions
622     (like ``note``, ``warning``, etc.) into generic admonitions with a
623     localized title.
625 * docutils/writers/html4css1/__init__.py:
627   - Moved template functionality from the PEP/HTML writer here.
628   - Expanded the fragments available in the ``parts`` attribute.
629   - Moved ``id`` attributes from titles to surrounding ``div``
630     elements.
631   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
632     universally supported now).
633   - ``template.txt`` is now opened in text mode instead of binary mode
634     (to ensure Windows compatibility).
635   - ``a`` elements now have an "internal" or "external" class,
636     depending on reference type.
638 * docutils/writers/html4css1/template.txt: Added to project.
640 * docutils/writers/pep_html/:
642   - Moved template functionality to the HTML writer.
644 * docutils/writers/s5_html/__init__.py:
646   - Added ``view_mode`` & ``hidden_controls`` settings
647     (``--view-mode`` & ``--hidden-controls/--visible-controls``
648     options).
650 * docutils/writers/latex2e/__init__.py:
652   - Add ``--literal-block-env``
653   - Fix: escaping ``%`` in href urls.
654   - Move usepackage hyperref after stylesheet inclusion.
655   - Fix: scrartcl does not have chapter but scrreprt.
656   - Add newline after ``\end{verbatim}``.
657   - Merge smaller differences from latex2e_adaptive_preamble.
658   - Add ``use-part-section``.
659   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
660   - Using leavemode option_list no longer needs to check if parent
661     is a definition list.
662   - Append ``\leavemode`` to definition list terms.
663   - No longer write visit\_/depart_definition_list_item comments to
664     output.
665   - Table column width with 3 decimal places.
666   - Add table stubs support (boldfont).
667   - Add assemble_parts to writer.
668   - Add simply support for nested tables.
669   - Fix verbatim in tables if use-verbatim-when-possible.
670   - Use section commands down to subparagraph.
671   - Put ensuremath around some latin1 chars.
672   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
673   - New option ``--use-bibtex=style,db1,db2``.
674   - New option ``--reference-label`` to allow usage of LaTeX ref for
675     labels in section references.
676   - Add a label after every section to support sectionnumbers as reference
677     labels.
678   - Fix: bug# 1605376 rst2latex: bad options group list
679   - Remove inactive code for use_optionlist_for_option_list.
680   - Remove latex comments from option_list output.
681   - Fix: bug# 1612270 double qoutes in italian literal.
682   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
683   - Add option --use-latex-abstract.
684   - Image width unit ``px`` is translated to ``pt``.
685   - Add image height support.
686   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
687     bug #1457388
688   - Fix: Do not escape underscores in citation reference labels if
689     use-latex-citations is set.
690   - Use centering instead of center for figure contents, to avoid vertical
691     space.
692   - Recognize table class: borderless, nolines, booktabs, standard.
693   - Fix: Renaming contents section does not work with latex writer; SF
694     bug #1487405.
695   - Applied patch for custom roles with classes from Edward Loper.
696   - Fixed bug that caused crashes with more than 256 lists.
698 * docutils/writers/pep_html/__init__.py:
700   - Changed to support new python.org website structure and
701     pep2pyramid.py.
703 * docs/howto/security.txt: "Deploying Docutils Securely", added to
704   project.
706 * tools/buildhtml.py:
708   -- Added ``ignore`` setting to exclude a list of shell patterns
709      (default: ``.svn:CVS``).
711 * tools/editors/emacs/rst.el:
713   - Changed license to "GPL".
714   - Added ``rst-straighten-decorations`` function.
715   - The ``compile`` module is now always loaded.
716   - Added ``rst-toggle-line-block`` function.
717   - Headings consisting only of non-ASCII characters are now
718     recognized by ``rst-toc`` and ``rst-adjust``.
719   - Added font-lock support for multi-line comments where the first
720     comment line is empty.
721   - Added ``(require 'font-lock)``.
723 * setup.py:
725   - Provide descriptive error message if distutils is missing.
728 Release 0.4 (2006-01-09)
729 ========================
731 * General:
733   - Updated the project policies for trunk/branch development &
734     version numbering.
736 * docutils/__init__.py:
738   - Added ``__version_details__`` attribute to describe code source
739     (repository/snapshot/release).
740   - Replaced ``default_transforms`` attribute of TransformSpec with
741     ``get_transforms()`` method.
743 * docutils/core.py:
745   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
746     functions, for document tree extraction and reprocessing.
748 * docutils/io.py:
750   - Added ``DocTreeInput`` class, for reprocessing existing documents.
751   - Added support for non-Unicode (e.g. binary) writer output.
753 * docutils/nodes.py:
755   - Re-introduced ``Targetable.indirect_reference_name``, for
756     MoinMoin/reST compatibility (removed in r3124/r3129).
757   - Added ``serial_escape`` function; escapes string values that are
758     elements of a list, for serialization.  Modified Docutils-XML
759     writing (``Element._dom_node``) and pseudo-XML writing
760     (``Element.starttag``) to use ``serial_escape``.
761   - Added ``Node.deepcopy()`` method.
762   - Removed the internal lists ``document.substitution_refs``,
763     ``document.anonymous_refs``, and ``document.anonymous_targets``.
764   - Added a "container" element.
765   - Fixed bug where values of list-valued attributes of elements
766     originating from custom interpreted text roles (i.e., with custom
767     classes) were being shared between element instances.  Reported by
768     Shmuel Zeigerman.
770 * docutils/statemachine.py:
772   - Added trailing whitespace stripping to ``string2lines()``.
773   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
774     Asian double-width character support.
776 * docutils/utils.py:
778   - Added ``east_asian_column_width()`` for double-width character
779     support.
781 * docutils/languages/ja.py: Added to project: Japanese mappings by
782   Hisashi Morita.
784 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
785   mappings by Panjunyong.
787 * docutils/parsers/null.py: Added to project; a do-nothing parser.
789 * docutils/parsers/rst/__init__.py:
791   - Added validator to tab_width setting, with test.  Closes SF bug
792     #1212515, report from Wu Wei.
794 * docutils/parsers/rst/states.py:
796   - Fixed bug with escaped colons indicating a literal block.
797   - Fixed bug with enumerated lists (SF#1254145).
798   - Backslash-escaped colons inside of field names are now allowed.
799   - Targets (implicit and explicit), anonymous hyperlink references
800     and auto-numbered footnote references inside of substitution
801     definitions are now disallowed.
802   - Fixed bug: list items with blank first lines.
803   - Fixed bug: block quote attributions with indented second lines.
804   - Added East Asian double-width character support (Python 2.4 only).
806 * docutils/parsers/rst/tableparser.py:
808   - Added East Asian double-width character support (Python 2.4 only).
810 * docutils/parsers/rst/directives/body.py:
812   - Added the "container" directive.
814 * docutils/parsers/rst/directives/misc.py:
816   - Added the "default-role", "title", and "date" directives.
817   - Added standard data file syntax to the "include" directive.
818   - Added support for "class" directive content.
820 * docutils/parsers/rst/directives/images.py:
822   - Added ``indirect_reference_name`` support for images with a target
823     option.
824   - Added support for image width and height units.
825   - Fixed bug with image "target" options.
827 * docutils/parsers/rst/directives/references.py:
829   - Added "class" attribute to "target-notes" directive, for
830     footnote_reference classes.
832 * docutils/parsers/rst/include/: Directory added to project; contains
833   standard data files for the "include" directive.  Initial contents:
834   character entity substitution definition sets, and a set of
835   definitions for S5/HTML presentations.
837 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
838   mappings by David Goodger.
840 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
841   Simplified Chinese mappings by Panjunyong.
843 * docutils/readers/__init__.py:
845   - Added universal.Decorations and universal.ExposeInternals
846     transforms as default transforms for all readers.
847   - Added ``ReReader`` base class for readers that reread an existing
848     document tree.
850 * docutils/readers/doctree.py: Added to project; a reader for existing
851   document trees.
853 * docutils/transforms/frontmatter.py:
855   - Fixed the DocInfo transform to handle SVN-style expansion of the
856     "Date" keyword.
857   - In ``DocInfo.extract_authors``, treat the contents of "authors"
858     fields uniformly.
860 * docutils/transforms/misc.py:
862   - Added misc.Transitions transform, extracted from
863     universal.FinalChecks.
865 * docutils/transforms/references.py:
867   - Added references.DanglingReferences transform, extracted from
868     universal.FinalChecks.
869   - Fixed bug with doubly-indirect substitutions.
870   - Added footnote_reference classes attribute to "TargetNotes".
871   - Fixed bug with circular substitution definitions that put Docutils
872     into an infinite loop.
874 * docutils/transforms/universal.py:
876   - Added universal.ExposeInternals transform, extracted from
877     universal.FinalChecks.
878   - Removed universal.FinalChecks transform (logic has been moved to
879     several new transforms).
880   - Fixed bug with the "expose_internals" setting and Text nodes
881     (exposed by the "rawsource" internal attribute).
882   - Added the universal.StripComments transform, implementation of the
883     "strip_comments" setting.
885 * docutils/transforms/writer_aux.py: Added to project; auxiliary
886   transforms for writers.
888   - Added ``Compound`` transform, which flattens compound paragraphs.
890 * docutils/writers/: Several writer modules (html4css1.py) were
891   converted into packages.  Support modules and data files have been
892   moved into the packages.  The stylesheets for the HTML writers are
893   now installed along with the code, the code knows where to find
894   them, and the default is to use them (actually, to embed them).
895   Some adjustments to configuration files may be necessary.  The
896   easiest way to obtain the new default behavior is to remove all
897   settings whose name includes "stylesheet".
899 * docutils/writers/__init__.py:
901   - Added universal.Messages and universal.FilterMessages transforms
902     as default transforms for all writers.
903   - Added ``UnfilteredWriter`` base class for writers that pass the
904     document tree on unchanged.
906 * docutils/writers/docutils_xml.py:
908   - Made ``xmlcharrefreplace`` the default output encoding error
909     handler.
911 * docutils/writers/html4css1/:
913   - Added support for image width and height units.
914   - Made ``xmlcharrefreplace`` the default output encoding error
915     handler.
916   - Made ``--embed-stylesheet`` the default rather than
917     ``--link-stylesheet``.
918   - Moved "id" attribute from container (section etc.) to title's <a>
919     tag, to be on the same tag as "name".
920     (!!! To be reverted in Docutils 0.5.)
921   - Added vertical space between fields of field lists.
922   - Added ``--compact-field-lists`` option to remove vertical space in
923     simple field lists.
924   - Made cloaking of email addresses with ``--cloak-email-addresses``
925     less obtrusive.
926   - Fixed support for centered images.
927   - Added support for class="compact" & class="open" lists.
929 * docutils/writers/latex2e/:
931   - Underscores in citekeys are no longer escaped.
933 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
934   mapping of Unicode characters to LaTeX equivalents.
936 * docutils/writers/s5_html/: Package added to project; writer for
937   S5/HTML slide shows.
939 * docs/dev/distributing.txt: Added to project; guide for distributors
940   (package maintainers).
942 * docs/dev/hacking.txt: Added to project; guide for developers.
944 * docs/ref/doctree.txt:
946   - Updated for plural attributes "classes", "ids", "names",
947     "dupnames".
948   - Added the "container" element.
950 * docs/ref/docutils.dtd:
952   - Updated for plural attributes "classes", "ids", "names",
953     "dupnames".
955 * docs/user/emacs.txt: Added to project; a document about Emacs
956   support for reStructuredText and Docutils.
958 * docs/user/links.txt: Added to project; lists of Docutils-related
959   links.
961 * docs/user/mailing-lists.txt: Added to project; information about
962   Docutils-related mailing lists and how to access them.
964 * docs/user/slide-shows.txt: Added to project; example of and docs for
965   the S5/HTML writer (``rst2s5.py`` front end).
967 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
968   Files", added to project.
970 * test/coverage.sh: Added to project; test coverage script.
972 * test/DocutilsTestSupport.py:
974   - Added support for specifying runtime settings at the suite level.
976 * test/test_functional.py:
978   - Added the ``clear_output_directory`` function.
979   - Added support for ``_test_more`` functions in functional test
980     config files.
982 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
984 * tools/rstpep2html.py: Renamed from pep.py.
986 * tools/dev/create_unimap.py: Added to project; script to create the
987   docutils/writers/unimap_latex.py mapping file.
989 * tools/dev/profile_docutils.py: Added to project; profiler script.
991 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
993 * tools/editors/emacs/restructuredtext.el,
994   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
995   Removed from project; the functionality is now contained in rst.el.
997 * tools/editors/emacs/rst.el: Added to project.  Added many features
998   and fixed many bugs.  See docs/user/emacs.txt for details.
1000 * tools/stylesheets: Removed from project.  Stylesheets have been
1001   renamed and moved into writer packages.
1004 Release 0.3.9 (2005-05-26)
1005 ==========================
1007 * General:
1009   - Eliminated and replaced all uses of the old string attributes
1010     ``id``, ``name``, ``dupname`` and ``class`` with references to the
1011     new list attributes ``ids``, ``names``, ``dupnames`` and
1012     ``classes`` throughout the whole source tree.
1014 * docutils/core.py:
1016   - Enabled ``--dump-*`` options when ``--traceback`` specified,
1017     allowing for easier debugging.
1018   - In ``Publisher.publish()``, expanded the generic top-level
1019     exception catching.
1021 * docutils/examples.py:
1023   - Added ``internals`` function for exploration.
1025 * docutils/io.py:
1027   - Fixed ``Input.decode`` method to apply heuristics only if no
1028     encoding is explicitly given, and to provide better reporting of
1029     decoding errors.
1030   - The ``Input.decode`` method now removes byte order marks (BOMs)
1031     from input streams.
1033 * docutils/nodes.py:
1035   - ``image`` element class changed to subclass of Element, not
1036     TextElement (it's an empty element, and cannot contain text).
1037   - Added ``attr_defaults`` dictionary for default attribute values.
1038   - Added empty list as default value for the following attributes:
1039     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1040   - Added ``document.decoration`` attribute,
1041     ``document.get_decoration`` method, and ``decoration.get_header``
1042     & ``.get_footer`` methods.
1043   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1044     methods.
1046 * docutils/utils.py:
1048   - Removed ``docutils.utils.Reporter.categories``,
1049     ``docutils.utils.ConditionSet``, and all references to them, to
1050     simplify error reporting.
1052 * docutils/languages/nl.py: Added to project; Dutch mappings by
1053   Martijn Pieters.
1055 * docutils/parsers/rst/__init__.py:
1057   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1059 * docutils/parsers/rst/states.py:
1061   - Added check for escaped at-mark to prevent email address recognition.
1062   - Fixed option lists to allow spaces inside ``<angle-bracketed option
1063     arguments>``.
1064   - Allowed whitespace in paths and URLs.
1065   - Added auto-enumerated list items.
1066   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1067     followed by text.
1068   - Added support for table stub columns.
1070 * docutils/parsers/rst/directives/__init__.py:
1072   - Allowed whitespace in paths (``path`` function).
1073   - Added ``uri`` directive option conversion function.
1075 * docutils/parsers/rst/directives/body.py:
1077   - Fixed illegal context bug with "topic" directive (allowed within
1078     sidebars; not within body elements).
1080 * docutils/parsers/rst/directives/images.py:
1082   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1083   - Added support for the ``file_insertion_enabled`` setting in the
1084     "figure" directive (disables "figwidth" option).
1085   - "image" directive: added checks for valid values of "align" option,
1086     depending on context.  "figure" directive: added specialized
1087     "align" option and attribute on "figure" element.
1088   - Made ":figwidth: image" option of "figure" directive work again.
1089   - Fixed bug with reference names containing uppercase letters
1090     (e.g. ``Name_``) in "target" option of "image" directive.
1092 * docutils/parsers/rst/directives/misc.py:
1094   - Fixed "include" and "raw" directives to catch text decoding
1095     errors.
1096   - Allowed whitespace in "include" & "raw" directive paths.
1097   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1098     settings in "include" & "raw" directives.
1100 * docutils/parsers/rst/directives/parts.py:
1102   - Added "header" & "footer" directives.
1103   - Fixed illegal context bug with "contents" directive (topics
1104     allowed within sidebars; not within body elements).
1106 * docutils/parsers/rst/directives/tables.py:
1108   - Added "list-table" directive.
1109   - Caught empty CSV table bug.
1110   - Added support for the ``file_insertion_enabled`` setting in the
1111     "csv-table" directive.
1112   - Added ``stub-columns`` option to "csv-table" and "list-table"
1113     directives.
1115 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1116   mappings by Martijn Pieters.
1118 * docutils/readers/standalone.py:
1120   - Added ``--section-subtitles`` and ``--no-section-subtitles``
1121     options to activate or deactivate the SectSubTitle transform.
1123 * docutils/transforms/frontmatter.py:
1125   - Added SectSubTitle transform to promote titles of lone
1126     subsections to subtitles.
1128 * docutils/transforms/references.py:
1130   - Fixed mislocated internal targets bug, by propagating internal
1131     targets to the next node, making use of the newly added support
1132     for multiple names and IDs.
1133   - Fixed duplicate footnote label bug.
1134   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1135     transform.
1137 * docutils/writers/html4css1.py:
1139   - Fixed unencoded stylesheet reference bug (characters like "&" in
1140     stylesheet references).
1141   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1142     tags).
1143   - Added support for multiple IDs per node by creating empty ``span``
1144     tags.
1145   - Added the ``field_name_limit`` & ``option_limit`` settings &
1146     support.
1147   - Added support for table stub columns.
1148   - Added support for the ``align`` attribute on ``figure`` elements.
1149   - Added the ``cloak_email_addresses`` setting & support.
1150   - Added ``html_prolog``, ``html_head``, ``html_body``,
1151     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1152     ``docutils.core.publish_parts``.
1153   - Added support for section subtitles.
1155 * docutils/writers/latex2e.py:
1157   - Fixed tables starting with more than one multirow cell.
1158   - Improved --use-latex-docinfo so that organization/contact/address
1159     fields are lumped with the last author field and appear on the
1160     titlepage.
1161   - Made sure the titlepage is always shown with --use-latex-docinfo,
1162     even if the document has no title.
1163   - Made sure that latex doesn't fill in today's date if no date field
1164     was given.
1165   - Added support for section subtitles.
1167 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1168   (under development).
1170 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1172 * docs/api/publisher.txt:
1174   - Added "``publish_parts`` Details" section.
1176 * docutils/dev/repository.txt: Added to project; information about the
1177   Docutils Subversion repository.
1179 * docs/ref/docutils.dtd:
1181   - Added a ``stub`` attribute to the ``colspec`` element via the
1182     ``tbl.colspec.att`` parameter entity.
1183   - Allowed topic elements within sidebars
1184   - Added an ``align`` attribute to the ``figure`` element.
1186 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1187   writer.
1190 Release 0.3.7 (2004-12-24)
1191 ==========================
1193 * docutils/frontend.py:
1195   - Added options: --input-encoding-error-handler,
1196     --record-dependencies, --leave-footnote-reference-space,
1197     --strict-visitor.
1198   - Added command-line and config file support for "overrides" setting
1199     parameter.
1201 * docutils/io.py:
1203   - Added support for input encoding error handler.
1205 * docutils/nodes.py:
1207   - Added dispatch_visit and dispatch_departure methods to
1208     NodeVisitor; useful as a hook for Visitors.
1209   - Changed structure of ``line_block``; added ``line``.
1210   - Added ``compound`` node class.
1211   - Added a mechanism for Visitors to transitionally ignore new node
1212     classes.
1214 * docutils/utils.py:
1216   - Moved ``escape2null`` and ``unescape`` functions from
1217     docutils/parsers/rst/states.py.
1219 * docutils/parsers/rst/roles.py:
1221   - Added "raw" role.
1222   - Changed role function API: the "text" parameter now takes
1223     null-escaped interpreted text content.
1225 * docutils/parsers/rst/states.py:
1227   - Fixed bug where a "role" directive in a nested parse would crash
1228     the parser; the state machine's "language" attribute was not being
1229     copied over.
1230   - Added support for line block syntax.
1231   - Fixed directive parsing bug: argument-less directives didn't
1232     notice that arguments were present.
1233   - Removed error checking for transitions.
1234   - Added support for multiple classifiers in definition list items.
1235   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1236   - Changed role function API: the "text" parameter now takes
1237     null-escaped interpreted text content.
1238   - Empty sections and documents are allowed now.
1240 * docutils/parsers/rst/directives/__init__.py:
1242   - Added ``encoding`` directive option conversion function.
1243   - Allow multiple class names in class_option conversion function.
1245 * docutils/parsers/rst/directives/body.py:
1247   - Converted the line-block directive to use the new structure.
1248   - Extracted the old line-block functionality to the ``block``
1249     function (still used).
1250   - Added ``compound`` directive (thanks to Lea Wiemann).
1252 * docutils/parsers/rst/directives/misc.py:
1254   - Added "encoding" option to "include" and "raw" directives.
1255   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1256   - Allow multiple class names in the "class" directive.
1258 * docutils/parsers/rst/directives/parts.py:
1260   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1261     options.  Thanks to Lele Gaifax.
1263 * docutils/parsers/rst/directives/tables.py:
1265   - Added "encoding" directive to "csv-table" directive.
1266   - Added workaround for lack of Unicode support in csv.py, for
1267     non-ASCII CSV input.
1269 * docutils/transforms/misc.py:
1271   - Fixed bug when multiple "class" directives are applied to a single
1272     element.
1273   - Enabled multiple format names for "raw" directive.
1275 * docutils/transforms/references.py:
1277   - Added support for trimming whitespace from beside substitution
1278     references.
1280 * docutils/transforms/universal.py:
1282   - FinalChecks now checks for illegal transitions and moves
1283     transitions between sections.
1285 * docutils/writers/html4css1.py:
1287   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
1288   - "stylesheet" and "stylesheet_path" settings are now mutually
1289     exclusive.
1290   - Added support for the new line_block/line structure.
1291   - --footnote-references now overrides
1292     --trim-footnote-reference-space, if applicable.
1293   - Added support for ``compound`` elements.
1294   - Enabled multiple format names for "raw" directive.
1295   - ``<p>`` tags of a paragraph which is the only visible child of the
1296     document node are no longer stripped.
1297   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1298     new method ``should_be_compact_paragraph()``.
1299   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1300     elements.
1301   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1302     the output if they have their ``class`` attribute set.
1303   - The whole document is now surrounded by a ``<div
1304     class="document">`` element.
1305   - Body-level images are now wrapped by their own ``<div>`` elements,
1306     with image classes copied to the wrapper, and for images which
1307     have the ``:align:`` option set, the surrounding ``<div>`` now
1308     receives a class attribute (like ``class="align-left"``).
1310 * docutils/writers/latex2e.py:
1312   - no newline after depart_term.
1313   - Added translations for some Unicode quotes.
1314   - Added option "font-encoding", made package AE the default.
1315   - "stylesheet" and "stylesheet_path" settings are now mutually
1316     exclusive.
1317   - --footnote-references now overrides
1318     --trim-footnote-reference-space, if applicable.
1319   - The footnote label style now matches the footnote reference style
1320     ("brackets" or "superscript").
1321   - Added support for ``compound`` elements.
1322   - Enabled multiple format names for "raw" directive.
1324 * docs/ref/docutils.dtd:
1326   - Changed structure of the ``line_block`` element; added ``line``.
1327   - Added ``compound`` element.
1328   - Added "ltrim" and "rtrim" attributes to
1329     ``substitution_definition`` element.
1330   - Enabled multiple format names for ``raw`` element.
1331   - Enabled multiple classifiers in ``definition_list_item`` elements.
1333 * docs/ref/rst/directives.txt
1335   - Marked "line-block" as deprecated.
1336   - "Class" directive now allows multiple class names.
1337   - Added "Rationale for Class Attribute Value Conversion".
1338   - Added warning about "raw" overuse/abuse.
1340 * docs/ref/rst/restructuredtext.txt:
1342   - Added syntax for line blocks.
1343   - Definition list items may have multiple classifiers.
1345 * docs/ref/rst/roles.txt:
1347   - Added "raw" role.
1349 * tools/stylesheets/default.css:
1351   - Added support for the new line_block structure.
1352   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1355 Release 0.3.5 (2004-07-29)
1356 ==========================
1358 General:
1360 * _`Documentation cleanup/reorganization`.
1362   - Created new subdirectories of docs/:
1364     * ``docs/user/``: introductory/tutorial material for end-users
1365     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1366     * ``docs/api/``: API reference material for client-developers
1367     * ``docs/ref/``: reference material for all groups
1368     * ``docs/howto/``: for component-developers and core-developers
1369     * ``docs/peps/``: Python Enhancement Proposals
1371   - Moved ``docs/*`` to ``docs/user/``.
1372   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1373     ``spec/`` to ``docs/dev``.
1374   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1375     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1376   - Moved ``alternatives.txt``, and ``problems.txt`` from
1377     ``spec/rst/`` to ``docs/dev/rst/``.
1378   - Moved ``reStructuredText.txt``, ``directives.txt``,
1379     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1380     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
1381     ``roles.txt``, ``reStructuredText.txt`` to
1382     ``restructuredtext.txt``.
1383   - Moved ``spec/howto/`` to ``docs/howto``.
1385   In order to keep the CVS history of moved files, we supplied
1386   SourceForge with a `script for modifying the Docutils CVS
1387   repository`__.
1389   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1391   After running the cleanup script:
1393   - Added ``docs/index.txt``.
1394   - Added a ``.htaccess`` file to the ``web`` module, containing
1395     redirects for all old paths to new paths.  They'll preserve
1396     fragments (the "#name" part of a URL), and won't clutter up the
1397     file system, and will correct the URL in the user's browser.
1398   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1399     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1400     the "To Do" list itself in ``docs/dev/todo.txt``.
1401   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1402     section of ``docs/dev/todo.txt``.
1403   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1404   - Added "How To Report Bugs" to ``BUGS.txt``.
1405   - Went through all the sources and docs (including under web/) and
1406     updated links.  Mostly done by Lea Wiemann; thanks Lea!
1407     (Still need to update links in the sandboxes.)
1409 Specific:
1411 * BUGS.txt: Added to project.
1413 * THANKS.txt: Added to project.
1415 * docutils/__init__.py:
1417   - 0.3.4: Post-release.
1419 * docutils/core.py:
1421   - Added special error handling & advice for UnicodeEncodeError.
1422   - Refactored Publisher.publish (simplified exception handling &
1423     extracted debug dumps).
1424   - Renamed "enable_exit" parameter of convenience functions to
1425     "enable_exit_status".
1426   - Enabled traceback (exception propagation) by default in
1427     programmatic convenience functions.
1428   - Now publish_file and publish_cmdline convenience functions return
1429     the encoded string results in addition to their regular I/O.
1430   - Extracted common code from publish_file, publish_string, and
1431     publish_parts, into new publish_programmatically.  Extracted
1432     settings code to ``Publisher.process_programmatic_settings``.
1433   - In Publisher.publish, disabled ``settings_overrides`` when
1434     ``settings`` is supplied; redundant.
1436 * docutils/frontend.py:
1438   - Added help text for "--output-encoding-error-handler" and
1439     "--error-encoding-error-handler".
1440   - Renamed "--exit" to "--exit-status".
1441   - Simplified default-setting code.
1443 * docutils/parsers/rst/__init__.py:
1445   - Added "--pep-base-url" and "--rfc-base-url" options.
1447 * docutils/parsers/rst/states.py:
1449   - Made URI recognition more aggressive and intelligent.
1451 * docutils/parsers/rst/directives/__init__.py:
1453   - Added several directive option conversion functions.
1455 * docutils/parsers/rst/directives/body.py:
1457   - Moved "table" directive to tables.py.
1459 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1460   added to project.
1462 * docutils/writers/latex2e.py:
1464   - Added "--table-style=(standard|booktabs|nolines)"
1465   - figures get "here" option (LaTeX per default puts them at bottom),
1466     and figure content is centered.
1467   - Rowspan support for tables.
1468   - Fix: admonition titles before first section.
1469   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1470   - Replave ``_`` in literal by an underlined blank, because it has the correct
1471     width.
1472   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1473   - A few unicode replacements, if output_encoding != utf
1474   - Add "--graphicx-option".
1475   - Indent literal-blocks.
1476   - Fix: omit ``\maketitle`` when there is no document title.
1478 * docs/index.txt: "Docutils Project Documentation Overview", added to
1479   project.
1481 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1482   Tool", added to project.
1484 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1486 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1488 * docs/dev/policies.txt: Added to project (extracted from
1489   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1491 * docs/dev/release.txt: Added to project (extracted from
1492   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1494 * docs/dev/testing.txt: Added to project.
1496 * docs/dev/website.txt: Added to project (extracted from
1497   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1499 * docs/ref/rst/directives.txt:
1501   - Added directives: "table", "csv-table".
1503 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1504   added to project.  1 page for syntax, and a 1 page reference for
1505   directives and roles.  Source text to be used as-is; not meant to be
1506   converted to HTML.
1508 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1509   with a change of title.
1511 * test/functional/, contents, and test/test_functional.py: Added to
1512   project.
1514 * tools/buildhtml.py: Fixed bug with config file handling.
1516 * tools/html.py: Removed from project (duplicate of rst2html.py).
1518 * tools/pep2html.py: Removed from project (duplicate of Python's
1519   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1520   Docutils-related PEPs in docs/peps/).
1522 * tools/rst2pseudoxml.py: Renamed from publish.py.
1524 * tools/rst2xml.py: Renamed from docutils-xml.py.
1526 * tools/test.txt: Removed from project; moved to
1527   docs/user/rst/demo.txt.
1529 * setup.py: Now also installs ``rst2latex.py``.
1532 Release 0.3.3 (2004-05-09)
1533 ==========================
1535 * docutils/__init__.py:
1537   - 0.3.1: Reorganized config file format (multiple sections); see
1538     docs/config.txt.
1539   - Added unknown_reference_resolvers attribute to TransformSpec.
1540   - 0.3.2: Interpreted text reorganization.
1541   - 0.3.3: Released.
1543 * docutils/core.py:
1545   - Catch system messages to stop tracebacks from parsing errors.
1546   - Catch exceptions during processing report & exit without
1547     tracebacks, except when "--traceback" used.
1548   - Reordered components for OptionParser; application comes last.
1549   - Added "config_section" parameter to several methods and functions,
1550     allowing front ends to easily specify their config file sections.
1551   - Added publish_parts convenience function to allow access to individual
1552     parts of a document.
1554 * docutils/examples.py: Added to project; practical examples of
1555   Docutils client code, to be used as-is or as models for variations.
1557 * docutils/frontend.py:
1559   - Added "--traceback" & "--no-traceback" options ("traceback"
1560     setting).
1561   - Implemented support for config file reorganization:
1562     ``standard_config_files`` moved from ``ConfigParser`` to
1563     ``OptionParser``; added
1564     ``OptionParser.get_config_file_settings()`` and
1565     ``.get_standard_config_settings()``; support for old "[options]"
1566     section (with deprecation warning) and mapping from old to new
1567     settings.
1568   - Reimplemented setting validation.
1569   - Enabled flexible boolean values: yes/no, true/false, on/off.
1570   - Added ``Values``, a subclass of ``optparse.Values``, with support
1571     for list setting attributes.
1572   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1573     thanks to Beni Cherniavsky.
1574   - Added "--no-section-numbering" option.
1576 * docutils/io.py:
1578   - Catch IOErrors when opening source & destination files, report &
1579     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1580     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1582 * docutils/nodes.py:
1584   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1585     method definitions (via ``exec``) to dynamic assignments (via
1586     ``setattr``); thanks to Roman Suzi.
1587   - Encapsulated visitor dynamic assignments in a function; thanks to
1588     Ian Bicking.
1589   - Added indirect_reference_name attribute to the Targetable
1590     class. This attribute holds the whitespace_normalized_name
1591     (contains mixed case) of a target.
1593 * docutils/statemachine.py:
1595   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1596   - Added ``StringList.get_2D_block``.
1598 * docutils/utils.py:
1600   - Added "level" attribute to SystemMessage exceptions.
1602 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1603   Jannie Hofmeyr.
1605 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1606   Blaha.
1608 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1609   Marcelo Huerta San Martin.
1611 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1612   mappings by Lalo Martins.
1614 * docutils/languages/ru.py: Added to project; Russian mappings by
1615   Roman Suzi.
1617 * docutils/parsers/rst/roles.py: Added to project.  Contains
1618   interpreted text role functions, a registry for interpreted text
1619   roles, and an API for adding to and retrieving from the registry.
1620   Contributed by Edward Loper.
1622 * docutils/parsers/rst/states.py:
1624   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1625   - Allowed true em-dash character and "---" as block quote
1626     attribution marker.
1627   - Added support for <angle-bracketed> complex option arguments
1628     (option lists).
1629   - Fixed handling of backslashes in substitution definitions.
1630   - Fixed off-by-1 error with extra whitespace after substitution
1631     definition directive.
1632   - Added inline markup parsing to field lists' field names.
1633   - Added support for quoted (and unindented) literal blocks.
1634     Driven in part by a bribe from Frank Siebenlist (thanks!).
1635   - Parser now handles escapes in URIs correctly.
1636   - Made embedded-URIs' reference text omittable.  Idea from Beni
1637     Cherniavsky.
1638   - Refactored explicit target processing code.
1639   - Added name attribute to references containing the reference name only
1640     through whitespace_normalize_name (no case changes).
1641   - parse_target no longer returns the refname after going through
1642     normalize_name. This is now handled in make_target.
1643   - Fixed bug relating to role-less interpreted text in non-English
1644     contexts.
1645   - Reorganized interpreted text processing; moved code into the new
1646     roles.py module.  Contributed by Edward Loper.
1647   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1648     ``parse_directive_block``.
1650 * docutils/parsers/rst/tableparser.py:
1652   - Reworked for ``StringList``, to support "include" directives in
1653     table cells.
1655 * docutils/parsers/rst/directives/__init__.py:
1657   - Renamed ``unchanged()`` directive option conversion function to
1658     ``unchanged_required``, and added a new ``unchanged``.
1659   - Catch unicode value too high error; fixes bug 781766.
1660   - Beefed up directive error reporting.
1662 * docutils/parsers/rst/directives/body.py:
1664   - Added basic "table" directive.
1666 * docutils/parsers/rst/directives/images.py:
1668   - Added "target" option to "image" directive.
1669   - Added name attribute to references containing the reference name only
1670     through whitespace_normalize_name (no case changes).
1672 * docutils/parsers/rst/directives/misc.py:
1674   - Isolated the import of the ``urllib2`` module; was causing
1675     problems on SourceForge (``libssl.so.2`` unavailable?).
1676   - Added the "role" directive for declaring custom interpreted text
1677     roles.
1679 * docutils/parsers/rst/directives/parts.py:
1681   - The "contents" directive does more work up-front, creating the
1682     "topic" and "title", and leaving the "pending" node for the
1683     transform.  Allows earlier reference resolution; fixes subtle bug.
1685 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1686   mappings by Jannie Hofmeyr.
1688 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1689   mappings by Marek Blaha.
1691 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1692   mappings by Marcelo Huerta San Martin.
1694 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1695   Portuguese mappings by Lalo Martins.
1697 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1698   mappings by Roman Suzi.
1700 * docutils/transforms/parts.py:
1702   - The "contents" directive does more work up-front, creating the
1703     "topic" and "title", and leaving the "pending" node for the
1704     transform.  Allows earlier reference resolution; fixes subtle bug.
1705   - Added support for disabling of section numbering.
1707 * docutils/transforms/references.py:
1709   - Verifying that external targets are truly targets and not indirect
1710     references. This is because we are now adding a "name" attribute to
1711     references in addition to targets. Note sure if this is correct!
1712   - Added code to hook into the unknown_reference_resolvers list for a
1713     transformer in resolve_indirect_target. This allows the
1714     unknown_reference_resolvers to keep around indirect targets which
1715     docutils doesn't know about.
1716   - Added specific error message for duplicate targets.
1718 * docutils/transforms/universal.py:
1720   - Added FilterMessages transform (removes system messages below the
1721     verbosity threshold).
1722   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1723     to FinalCheckVisitor for application-specific handling of
1724     unresolvable references.
1725   - Added specific error message for duplicate targets.
1727 * docutils/writers/__init__.py:
1729   - Added assemble_parts method to the Writer class to allow for
1730     access to a documents individual parts.
1731   - Documented & set default for ``Writer.output`` attribute.
1733 * docutils/writers/html4css1.py:
1735   - Fixed unicode handling of attribute values (bug 760673).
1736   - Prevent duplication of "class" attribute values (bug report from
1737     Kirill Lapshin).
1738   - Improved table grid/border handling (prompted by report from Bob
1739     Marshall).
1740   - Added support for table titles.
1741   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1742     to Darek Suchojad.
1743   - Added functionality to keep track of individual parts of a document
1744     and store them in a dictionary as the "parts" attribute of the writer.
1745     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1746   - Added proper support for the "scale" attribute of the "image"
1747     element.  Contributed by Brent Cook.
1748   - Added ``--initial-header-level`` option.
1749   - Fixed bug: the body_pre_docinfo segment depended on there being a
1750     docinfo; if no docinfo, the document title was incorporated into
1751     the body segment.  Adversely affected the publish_parts interface.
1753 * docutils/writers/latex2e.py:
1755   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1756     about a missing file.
1757   - Added options and support: ``--compound-enumerators``,
1758     ``--section-prefix-for-enumerators``, and
1759     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1760     934322).
1761   - Added option ``--use-verbatim-when-possible``, to avoid
1762     problematic characters (eg, '~' in italian) in literal blocks.
1763   - It's now possible to use four section levels in the `book` and
1764     `report` LaTeX classes.  The default `article` class still has
1765     three levels limit.
1767 * docs/config.txt: "Docutils Configuration Files", added to project.
1768   Moved config file entry descriptions from tools.txt.
1770 * docs/tools.txt:
1772   - Moved config file entry descriptions to config.txt.
1774 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1775   Development".
1777 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1778   Text Roles", added to project.
1780 * spec/rst/reStructuredText.txt:
1782   - Added description of support for <angle-bracketed> complex option
1783     arguments to option lists.
1784   - Added subsections for indented and quoted literal blocks.
1786 * test: Continually adding & updating tests.
1788   - Added test/test_settings.py & test/data/config_*.txt support
1789     files.
1790   - Added test/test_writers/test_htmlfragment.py.
1792 * test/DocutilsTestSupport.py:
1794   - Refactored LaTeX publisher test suite/case class names to make
1795     testing other writers easier.
1796   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1797     to test the processing of HTML fragments which use the new
1798     publish_parts convenience function.
1800 * tools/buildhtml.py:
1802   - Added support for the "--prune" option.
1803   - Removed dependency on pep2html.py; plaintext PEPs no longer
1804     supported.
1806 * tools/docutils.conf:
1808   - Updated for configuration file reorganization.
1810 * tools/rst2html.py:
1812   - copied from tools/html.py
1814 * setup.py:
1816   - added a 'scripts' section to configuration
1817   - added 'tools/rst2html.py' to the scripts section
1820 Release 0.3 (2003-06-24)
1821 ========================
1823 General:
1825 * Renamed "attribute" to "option" for directives/extensions.
1827 * Renamed transform method "transform" to "apply".
1829 * Renamed "options" to "settings" for runtime settings (as set by
1830   command-line options).  Sometimes "option" (singular) became
1831   "settings" (plural).  Some variations below:
1833   - document.options -> document.settings (stored in other objects as
1834     well)
1835   - option_spec -> settings_spec (not directives though)
1836   - OptionSpec -> SettingsSpec
1837   - cmdline_options -> settings_spec
1838   - relative_path_options -> relative_path_settings
1839   - option_default_overrides -> settings_default_overrides
1840   - Publisher.set_options -> Publisher.get_settings
1842 Specific:
1844 * COPYING.txt: Added "Public Domain Dedication".
1846 * FAQ.txt: Frequently asked questions, added to project.
1848 * setup.py:
1850   - Updated with PyPI Trove classifiers.
1851   - Conditional installation of third-party modules.
1853 * docutils/__init__.py:
1855   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1856   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1857   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1858   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1859     option and its effect on the PEP template & writer.
1860   - Bumped version to 0.2.4 due to changes to the PEP template &
1861     stylesheet.
1862   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1863   - Added ``TransformSpec`` class for new transform system.
1864   - Bumped version to 0.2.6 for API changes (renaming).
1865   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1866     convenience functions.
1867   - Added ``Component.component_type`` attribute.
1868   - Bumped version to 0.2.8 because of the internal parser switch from
1869     plain lists to the docutils.statemachine.StringList objects.
1870   - Bumped version to 0.2.9 because of the frontend.py API changes.
1871   - Bumped version to 0.2.10 due to changes to the project layout
1872     (third-party modules removed from the "docutils" package), and
1873     signature changes in ``io.Input``/``io.Output``.
1874   - Changed version to 0.3.0 for release.
1876 * docutils/core.py:
1878   - Made ``publish()`` a bit more convenient.
1879   - Generalized ``Publisher.set_io``.
1880   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1881     parameters; improved its docstring.
1882   - Added ``publish_file()`` and ``publish_string()``.
1883   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1884     out of ``.set_io``.
1885   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1886     "--dump-transforms" hidden options.
1887   - Added ``Publisher.apply_transforms()`` method.
1888   - Added ``Publisher.set_components()`` method; support for
1889     ``publish_*()`` conveninece functions.
1890   - Moved config file processing to docutils/frontend.py.
1891   - Added support for exit status ("exit_level" setting &
1892     ``enable_exit`` parameter for Publisher.publish() and convenience
1893     functions).
1895 * docutils/frontend.py:
1897   - Check for & exit on identical source & destination paths.
1898   - Fixed bug with absolute paths & "--config".
1899   - Set non-command-line defaults in ``OptionParser.__init__()``:
1900     ``_source`` & ``_destination``.
1901   - Distributed ``relative_path_settings`` to components; updated
1902     ``OptionParser.populate_from_components()`` to combine it all.
1903   - Require list of keys in ``make_paths_absolute`` (was implicit in
1904     global ``relative_path_settings``).
1905   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1906     "--dump-settings", and "--dump-transforms" hidden options.
1907   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1908     code, replaced with correct code.
1909   - Added validation functionality for config files.
1910   - Added "--error-encoding" option/setting, "_disable_config"
1911     internal setting.
1912   - Added encoding validation; updated "--input-encoding" and
1913     "--output-encoding"; added "--error-encoding-error-handler" and
1914     "--output-encoding-error-handler".
1915   - Moved config file processing from docutils/core.py.
1916   - Updated ``OptionParser.populate_from_components`` to handle new
1917     ``SettingsSpec.settings_defaults`` dict.
1918   - Added support for "-" => stdin/stdout.
1919   - Added "exit_level" setting ("--exit" option).
1921 * docutils/io.py:
1923   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1924   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1925   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1926   - ``FileOutput.write()`` now returns the encoded output string.
1927   - Try to get path/stream name automatically in ``FileInput`` &
1928     ``FileOutput``.
1929   - Added defaults for source & destination paths.
1930   - Allow for Unicode I/O with an explicit "unicode" encoding.
1931   - Added ``Output.encode()``.
1932   - Removed dependency on runtime settings; pass encoding directly.
1933   - Recognize Unicode strings in ``Input.decode()``.
1934   - Added support for output encoding error handlers.
1936 * docutils/nodes.py:
1938   - Added "Invisible" element category class.
1939   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1940     modification during a traversal.
1941   - Added element classes: ``line_block``, ``generated``, ``address``,
1942     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1943     ``superscript``, ``subscript``, ``inline``
1944   - Added support for lists of nodes to ``Element.insert()``.
1945   - Fixed parent linking in ``Element.replace()``.
1946   - Added new abstract superclass ``FixedTextElement``; adds
1947     "xml:space" attribute.
1948   - Added support for "line" attribute of ``system_message`` nodes.
1949   - Added support for the observer pattern from ``utils.Reporter``.
1950     Added ``parse_messages`` and ``transform_messages`` attributes to
1951     ``document``, removed ``messages``.  Added ``note_parse_message``
1952     and ``note_transform_message`` methods.
1953   - Added support for improved diagnostics:
1955     - Added "document", "source", and "line" internal attributes to
1956       ``Node``, set by ``Node.setup_child()``.
1957     - Converted variations on ``node.parent = self`` to
1958       ``self.setup_child(node)``.
1959     - Added ``document.current_source`` & ``.current_line``
1960       attributes, and ``.note_source`` observer method.
1961     - Changed "system_message" output to GNU-Tools format.
1963   - Added a "rawsource" attribute to the ``Text`` class, for text
1964     before backslash-escape resolution.
1965   - Support for new transform system.
1966   - Reworked ``pending`` element.
1967   - Fixed XML DOM bug (SF #660611).
1968   - Removed the ``interpeted`` element class and added
1969     ``title_reference``, ``abbreviation``, ``acronym``.
1970   - Made substitutions case-sensitive-but-forgiving; moved some code
1971     from the parser.
1972   - Fixed Unicode bug on element attributes (report: William Dode).
1974 * docutils/optik.py: Removed from project; replaced with
1975   extras/optparse.py and extras/textwrap.py.  These will be installed
1976   only if they're not already present in the Python installation.
1978 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1979   only if it's not already present in the Python installation.
1981 * docutils/statemachine.py:
1983   - Factored out ``State.add_initial_transitions()`` so it can be
1984     extended.
1985   - Converted whitespace-specific "blank" and "indent" transitions
1986     from special-case code to ordinary transitions: removed
1987     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1988     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1989     ``ws_initial_transitions`` attributes.
1990   - Removed ``State.match_transition()`` after merging it into
1991     ``.check_line()``.
1992   - Added ``StateCorrection`` exception.
1993   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1994     (moved ``TransitionCorrection`` support there too.)
1995   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1996     ``EOFError`` instead of ``IndexError``.
1997   - Added ``State.no_match`` method.
1998   - Added support for the Observer pattern, triggered by input line
1999     changes.
2000   - Added ``strip_top`` parameter to
2001     ``StateMachineWS.get_first_known_indented``.
2002   - Made ``context`` a parameter to ``StateMachine.run()``.
2003   - Added ``ViewList`` & ``StringList`` classes;
2004     ``extract_indented()`` becomes ``StringList.get_indented()``.
2005   - Added ``StateMachine.insert_input()``.
2006   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
2007     thanks to) Fred Drake.
2009 * docutils/utils.py:
2011   - Added a ``source`` attribute to Reporter instances and
2012     ``system_message`` elements.
2013   - Added an observer pattern to ``utils.Reporter`` to keep track of
2014     system messages.
2015   - Fixed bugs in ``relative_path()``.
2016   - Added support for improved diagnostics.
2017   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2018   - Added support for encoding Reporter stderr output, and encoding
2019     error handlers.
2020   - Reporter keeps track of the highest level system message yet
2021     generated.
2023 * docutils/languages: Fixed bibliographic field language lookups.
2025 * docutils/languages/es.py: Added to project; Spanish mappings by
2026   Marcelo Huerta San Martin.
2028 * docutils/languages/fr.py: Added to project; French mappings by
2029   Stefane Fermigier.
2031 * docutils/languages/it.py: Added to project; Italian mappings by
2032   Nicola Larosa.
2034 * docutils/languages/sk.py: Added to project; Slovak mappings by
2035   Miroslav Vasko.
2037 * docutils/parser/__init__.py:
2039   - Added ``Parser.finish_parse()`` method.
2041 * docutils/parser/rst/__init__.py:
2043   - Added options: "--pep-references", "--rfc-references",
2044     "--tab-width", "--trim-footnote-reference-space".
2046 * docutils/parsers/rst/states.py:
2048   - Changed "title under/overline too short" system messages from INFO
2049     to WARNING, and fixed its insertion location.
2050   - Fixed enumerated list item parsing to allow paragraphs & section
2051     titles to begin with enumerators.
2052   - Converted system messages to use the new "line" attribute.
2053   - Fixed a substitution reference edge case.
2054   - Added support for "--pep-references" and "--rfc-references"
2055     options; reworked ``Inliner`` code to make customization easier.
2056   - Removed field argument parsing.
2057   - Added support for short section title over/underlines.
2058   - Fixed "simple reference name" regexp to ignore text like
2059     "object.__method__"; not an anonymous reference.
2060   - Added support for improved diagnostics.
2061   - Reworked directive API, based on Dethe Elza's contribution.  Added
2062     ``Body.parse_directive()``, ``.parse_directive_options()``,
2063     ``.parse_directive_arguments()`` methods.
2064   - Added ``ExtensionOptions`` class, to parse directive options
2065     without parsing field bodies.  Factored
2066     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2067     ``ExtensionOptions``.
2068   - Improved definition list term/classifier parsing.
2069   - Added warnings for unknown directives.
2070   - Renamed ``Stuff`` to ``Struct``.
2071   - Now flagged as errors: transitions at the beginning or end of
2072     sections, empty sections (except title), and empty documents.
2073   - Updated for ``statemachine.StringList``.
2074   - Enabled recognition of schemeless email addresses in targets.
2075   - Added support for embedded URIs in hyperlink references.
2076   - Added backslash-escapes to inline markup end-string suffix.
2077   - Added support for correct interpreted text processing.
2078   - Fixed nested title parsing (topic, sidebar directives).
2079   - Added special processing of backslash-escaped whitespace (idea
2080     from David Abrahams).
2081   - Made substitutions case-sensitive-but-forgiving; moved some code
2082     to ``docutils.nodes``.
2083   - Added support for block quote attributions.
2084   - Added a kludge to work-around a conflict between the bubble-up
2085     parser strategy and short titles (<= 3 char-long over- &
2086     underlines).  Fixes SF bug #738803 "infinite loop with multiple
2087     titles" submitted by Jason Diamond.
2088   - Added explicit interpreted text roles for standard inline markup:
2089     "emphasis", "strong", "literal".
2090   - Implemented "superscript" and "subscript" interpreted text roles.
2091   - Added initial support for "abbreviation" and "acronym" roles;
2092     incomplete.
2093   - Added support for "--trim-footnote-reference-space" option.
2094   - Optional space before colons in directives & hyperlink targets.
2096 * docutils/parsers/rst/tableparser.py:
2098   - Fixed a bug that was producing unwanted empty rows in "simple"
2099     tables.
2100   - Detect bad column spans in "simple" tables.
2102 * docutils/parsers/rst/directives: Updated all directive functions to
2103   new API.
2105 * docutils/parsers/rst/directives/__init__.py:
2107   - Added ``flag()``, ``unchanged()``, ``path()``,
2108     ``nonnegative_int()``, ``choice()``, and ``class_option()``
2109     directive option helper functions.
2110   - Added warnings for unknown directives.
2111   - Return ``None`` for missing directives.
2112   - Added ``register_directive()``, thanks to William Dode and Paul
2113     Moore.
2115 * docutils/parsers/rst/directives/admonitions.py:
2117   - Added "admonition" directive.
2119 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
2120   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2121   "parsed-literal", "rubric", "epigraph", "highlights" and
2122   "pull-quote" directives.
2124 * docutils/parsers/rst/directives/images.py:
2126   - Added an "align" attribute to the "image" & "figure" directives
2127     (by Adam Chodorowski).
2128   - Added "class" option to "image", and "figclass" to "figure".
2130 * docutils/parsers/rst/directives/misc.py:
2132   - Added "include", "raw", and "replace" directives, courtesy of
2133     Dethe Elza.
2134   - Added "unicode" and "class" directives.
2136 * docutils/parsers/rst/directives/parts.py:
2138   - Added the "sectnum" directive; by Dmitry Jemerov.
2139   - Added "class" option to "contents" directive.
2141 * docutils/parsers/rst/directives/references.py: Added to project.
2142   Contains the "target-notes" directive.
2144 * docutils/parsers/rst/languages/__init__.py:
2146   - Return ``None`` from get_language() for missing language modules.
2148 * docutils/parsers/rst/languages/de.py: Added to project; German
2149   mappings by Engelbert Gruber.
2151 * docutils/parsers/rst/languages/en.py:
2153   - Added interpreted text roles mapping.
2155 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2156   mappings by Marcelo Huerta San Martin.
2158 * docutils/parsers/rst/languages/fr.py: Added to project; French
2159   mappings by William Dode.
2161 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2162   mappings by Nicola Larosa.
2164 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2165   mappings by Miroslav Vasko.
2167 * docutils/readers/__init__.py:
2169   - Added support for the observer pattern from ``utils.Reporter``, in
2170     ``Reader.parse`` and ``Reader.transform``.
2171   - Removed ``Reader.transform()`` method.
2172   - Added default parameter values to ``Reader.__init__()`` to make
2173     instantiation easier.
2174   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2176 * docutils/readers/pep.py:
2178   - Added the ``peps.TargetNotes`` transform to the Reader.
2179   - Removed PEP & RFC reference detection code; moved to
2180     parsers/rst/states.py as options (enabled here by default).
2181   - Added support for pre-acceptance PEPs (no PEP number yet).
2182   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2183     easy subclassing.
2185 * docutils/readers/python: Python Source Reader subpackage added to
2186   project, including preliminary versions of:
2188   - __init__.py
2189   - moduleparser.py: Parser for Python modules.
2191 * docutils/transforms/__init__.py:
2193   - Added ``Transformer`` class and completed transform reform.
2194   - Added unknown_reference_resolvers list for each transformer. This list holds
2195     the list of functions provided by each component of the transformer that
2196     help resolve references.
2198 * docutils/transforms/frontmatter.py:
2200   - Improved support for generic fields.
2201   - Fixed bibliographic field language lookups.
2203 * docutils/transforms/misc.py: Added to project.  Miscellaneous
2204   transforms.
2206 * docutils/transforms/parts.py:
2208   - Moved the "id" attribute from TOC list items to the references
2209     (``Contents.build_contents()``).
2210   - Added the ``SectNum`` transform; by Dmitry Jemerov.
2211   - Added "class" attribute support to ``Contents``.
2213 * docutils/transforms/peps.py:
2215   - Added ``mask_email()`` function, updating to pep2html.py's
2216     functionality.
2217   - Linked "Content-Type: text/x-rst" to PEP 12.
2218   - Added the ``TargetNotes`` PEP-specific transform.
2219   - Added ``TargetNotes.cleanup_callback``.
2220   - Added title check to ``Headers``.
2222 * docutils/transforms/references.py:
2224   - Added the ``TargetNotes`` generic transform.
2225   - Split ``Hyperlinks`` into multiple transforms.
2226   - Fixed bug with multiply-indirect references (report: Bruce Smith).
2227   - Added check for circular indirect references.
2228   - Made substitutions case-sensitive-but-forgiving.
2230 * docutils/transforms/universal.py:
2232   - Added support for the "--expose-internal-attributes" option.
2233   - Removed ``Pending`` transform classes & data.
2235 * docutils/writers/__init__.py:
2237   - Removed ``Writer.transform()`` method.
2239 * docutils/writers/docutils-xml.py:
2241   - Added XML and doctype declarations.
2242   - Added "--no-doctype" and "--no-xml-declaration" options.
2244 * docutils/writers/html4css1.py:
2246   - "name" attributes only on these tags: a, applet, form, frame,
2247     iframe, img, map.
2248   - Added "name" attribute to <a> in section titles for Netscape 4
2249     support (bug report: Pearu Peterson).
2250   - Fixed targets (names) on footnote, citation, topic title,
2251     problematic, and system_message nodes (for Netscape 4).
2252   - Changed field names from "<td>" to "<th>".
2253   - Added "@" to "&#64;" encoding to thwart address harvesters.
2254   - Improved the vertical whitespace optimization; ignore "invisible"
2255     nodes (targets, comments, etc.).
2256   - Improved inline literals with ``<span class="pre">`` around chunks
2257     of text and ``&nbsp;`` for runs of spaces.
2258   - Improved modularity of output; added ``self.body_pre_docinfo`` and
2259     ``self.docinfo`` segments.
2260   - Added support for "line_block", "address" elements.
2261   - Improved backlinks (footnotes & system_messages).
2262   - Improved system_message output.
2263   - Redefined "--stylesheet" as containing an invariant URL, used
2264     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
2265     working directory.
2266   - Added "--footnote-references" option (superscript or brackets).
2267   - Added "--compact-lists" and "--no-compact-lists" options.
2268   - Added "--embed-stylesheet" and "--link-stylesheet" options;
2269     factored out ``HTMLTranslator.get_stylesheet_reference()``.
2270   - Improved field list rendering.
2271   - Added Docutils version to "generator" meta tag.
2272   - Fixed a bug with images; they must be inline, so wrapped in <p>.
2273   - Improved layout of <pre> HTML source.
2274   - Fixed attribute typo on <colspec>.
2275   - Refined XML prologue.
2276   - Support for no stylesheet.
2277   - Removed "interpreted" element support.
2278   - Added support for "title_reference", "sidebar", "attribution",
2279     "rubric", and generic "admonition" elements.
2280   - Added "--attribution" option.
2281   - Added support for "inline", "subscript", "superscript" elements.
2282   - Added initial support for "abbreviation" and "acronym";
2283     incomplete.
2285 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2286   (from the sandbox).
2288   - Added french.
2289   - Double quotes in literal blocks (special treatment for de/ngerman).
2290   - Added '--hyperlink-color' option ('0' turns off coloring of links).
2291   - Added  "--attribution" option.
2292   - Right align attributions.
2294 * docutils/writers/pep_html.py:
2296   - Parameterized output encoding in PEP template.
2297   - Reworked substitutions from ``locals()`` into ``subs`` dict.
2298   - Redefined "--pep-stylesheet" as containing an invariant URL, used
2299     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
2300     working directory.
2301   - Added an override on the "--footnote-references" option.
2302   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2303   - Added Docutils version to "generator" meta tag.
2304   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2306 * docs/tools.txt:
2308   - Added a "silent" setting for ``buildhtml.py``.
2309   - Added a "Getting Help" section.
2310   - Rearranged the structure.
2311   - Kept up to date, with new settings, command-line options etc.
2312   - Added section for ``rst2latex.py`` (Engelbert Gruber).
2313   - Converted settings table into a definition list.
2315 * docs/rst/quickstart.txt:
2317   - Added a table of contents.
2318   - Added feedback information.
2319   - Added mention of minimum section title underline lengths.
2320   - Removed the 4-character minimum for section title underlines.
2322 * docs/rst/quickref.html:
2324   - Added a "Getting Help" section.
2325   - Added a style to make section title backlinks more subtle.
2326   - Added mention of minimum section title underline lengths.
2327   - Removed the 4-character minimum for section title underlines.
2329 * extras: Directory added to project; contains third-party modules
2330   that Docutils depends on (optparse, textwrap, roman).  These are
2331   only installed if they're not already present.
2333 * licenses: Directory added to project; contains copies of license
2334   files for non-public-domain files.
2336 * spec/doctree.txt:
2338   - Changed the focus.  It's about DTD elements:  structural
2339     relationships, semantics, and external (public) attributes.  Not
2340     about the element class library.
2341   - Moved some implementation-specific stuff into ``docutils.nodes``
2342     docstrings.
2343   - Wrote descriptions of all common attributes and parameter
2344     entities.  Filled in introductory material.
2345   - Working through the element descriptions: 55 down, 37 to go.
2346   - Removed "Representation of Horizontal Rules" to
2347     spec/rst/alternatives.txt.
2349 * spec/docutils.dtd:
2351   - Added "generated" inline element.
2352   - Added "line_block" body element.
2353   - Added "auto" attribute to "title".
2354   - Changed content models of "literal_block" and "doctest_block" to
2355     ``%text.model``.
2356   - Added ``%number;`` attribute type parameter entity.
2357   - Changed ``%structural.elements;`` to ``%section.elements``.
2358   - Updated attribute types; made more specific.
2359   - Added "address" bibliographic element.
2360   - Added "line" attribute to ``system_message`` element.
2361   - Removed "field_argument" element; "field_name" may contain
2362     multiple words and whitespace.
2363   - Changed public identifier to docutils.sf.net.
2364   - Removed "interpreted" element; added "title_reference",
2365     "abbreviation", "acronym".
2366   - Removed "refuri" attribute from "footnote_reference" and
2367     "citation_reference".
2368   - Added "sidebar", "rubric", "attribution", "admonition",
2369     "superscript", "subscript", and "inline" elements.
2371 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2373 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2375 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2377 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2378   Dallas Mahrt.
2380 * spec/transforms.txt: Added to project.
2382 * spec/howto: Added subdirectory, for developer how-to docs.
2384 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
2385   Elza, edited & extended by David Goodger.
2387 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
2388   project.
2390 * spec/rst/alternatives.txt:
2392   - Added "Doctree Representation of Transitions" from
2393     spec/doctree.txt.
2394   - Updated "Inline External Targets" & closed the debate.
2395   - Added ideas for interpreted text syntax extensions.
2396   - Added "Nested Inline Markup" section.
2398 * spec/rst/directives.txt:
2400   - Added directives: "topic", "sectnum", "target-notes",
2401     "line-block", "parsed-literal", "include", "replace", "sidebar",
2402     "admonition", "rubric", "epigraph", "highlights", "unicode" and
2403     "class".
2404   - Formalized descriptions of directive details.
2405   - Added an "align" attribute to the "image" & "figure" directives
2406     (by Adam Chodorowski).
2407   - Added "class" options to "topic", "sidebar", "line-block",
2408     "parsed-literal", "contents", and "image"; and "figclass" to
2409     "figure".
2411 * spec/rst/interpreted.txt: Added to project.  Descriptions of
2412   interpreted text roles.
2414 * spec/rst/introduction.txt:
2416   - Added pointers to material for new users.
2418 * spec/rst/reStructuredText.txt:
2420   - Disambiguated comments (just add a newline after the "::").
2421   - Updated enumerated list description; added a discussion of the
2422     second-line validity checking.
2423   - Updated directive description.
2424   - Added a note redirecting newbies to the user docs.
2425   - Expanded description of inline markup start-strings in non-markup
2426     contexts.
2427   - Removed field arguments and made field lists a generic construct.
2428   - Removed the 4-character minimum for section title underlines.
2429   - Clarified term/classifier delimiter & inline markup ambiguity
2430     (definition lists).
2431   - Added "Embedded URIs".
2432   - Updated "Interpreted Text" section.
2433   - Added "Character-Level Inline Markup" section.
2435 * test: Continually adding & updating tests.
2437   - Moved test/test_rst/ to test/test_parsers/test_rst/.
2438   - Moved test/test_pep/ to test/test_readers/test_pep/.
2439   - Added test/test_readers/test_python/.
2440   - Added test/test_writers/ (Engelbert Gruber).
2442 * tools:
2444   - Made the ``locale.setlocale()`` calls in front ends
2445     fault-tolerant.
2447 * tools/buildhtml.py:
2449   - Added "--silent" option.
2450   - Fixed bug with absolute paths & "--config".
2451   - Updated for new I/O classes.
2452   - Added some exception handling.
2453   - Separated publishers' setting defaults; prevents interference.
2454   - Updated for new ``publish_file()`` convenience function.
2456 * tools/pep-html-template:
2458   - Allow for "--embed-stylesheet".
2459   - Added Docutils version to "generator" meta tag.
2460   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2461   - Conform to XHTML spec.
2463 * tools/pep2html.py:
2465   - Made ``argv`` a parameter to ``main()``.
2466   - Added support for "Content-Type:" header & arbitrary PEP formats.
2467   - Linked "Content-Type: text/plain" to PEP 9.
2468   - Files skipped (due to an error) are not pushed onto the server.
2469   - Updated for new I/O classes.
2470   - Added ``check_requirements()`` & ``pep_type_error()``.
2471   - Added some exception handling.
2472   - Updated for new ``publish_string()`` convenience function.
2473   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2475 * tools/quicktest.py:
2477   - Added "-V"/"--version" option.
2479 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2481 * tools/unicode2rstsubs.py: Added to project.  Produces character
2482   entity files (reSructuredText substitutions) from the MathML master
2483   unicode.xml file.
2485 * tools/editors: Support code for editors, added to project.  Contains
2486   ``emacs/restructuredtext.el``.
2488 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2490   - Added style for chunks of inline literals.
2491   - Removed margin for first child of table cells.
2492   - Right-aligned field list names.
2493   - Support for auto-numbered section titles in TOCs.
2494   - Increased the size of inline literals (<tt>) in titles.
2495   - Restored the light gray background for inline literals.
2496   - Added support for "line_block" elements.
2497   - Added style for "address" elements.
2498   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2499   - Improved field list rendering.
2500   - Vertical whitespace improvements.
2501   - Removed "a.target" style.
2503 * tools/stylesheets/pep.css:
2505   - Fixed nested section margins.
2506   - Other changes parallel those of ``../default.css``.
2509 Release 0.2 (2002-07-31)
2510 ========================
2512 General:
2514 - The word "component" was being used ambiguously.  From now on,
2515   "component" will be used to mean "Docutils component", as in Reader,
2516   Writer, Parser, or Transform.  Portions of documents (Table of
2517   Contents, sections, etc.)  will be called "document parts".
2518 - Did a grand renaming: a lot of ``verylongnames`` became
2519   ``very_long_names``.
2520 - Cleaned up imports: no more relative package imports or
2521   comma-separated lists of top-level modules.
2522 - Added support for an option values object which carries default
2523   settings and overrides (from command-line options and library use).
2524 - Added internal Unicode support, and support for both input and
2525   output encodings.
2526 - Added support for the ``docutils.io.IO`` class & subclasses.
2528 Specific:
2530 * docutils/__init__.py:
2532   - Added ``ApplicationError`` and ``DataError``, for use throughout
2533     the package.
2534   - Added ``Component`` base class for Docutils components; implements
2535     the ``supports`` method.
2536   - Added ``__version__`` (thus, ``docutils.__version__``).
2538 * docutils/core.py:
2540   - Removed many keyword parameters to ``Publisher.__init__()`` and
2541     ``publish()``; bundled into an option values object.  Added
2542     "argv", "usage", "description", and "option_spec" parameters for
2543     command-line support.
2544   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2545     methods.
2546   - Reworked I/O model for ``docutils.io`` wrappers.
2547   - Updated ``Publisher.set_options()``; now returns option values
2548     object.
2549   - Added support for configuration files (/etc/docutils.conf,
2550     ./docutils.conf, ~/.docutils).
2551   - Added ``Publisher.setup_option_parser()``.
2552   - Added default usage message and description.
2554 * docutils/frontend.py: Added to project; support for front-end
2555   (command-line) scripts.  Option specifications may be augmented by
2556   components.  Requires Optik (http://optik.sf.net/) for option
2557   processing (installed locally as docutils/optik.py).
2559 * docutils/io.py: Added to project; uniform API for a variety of input
2560   output mechanisms.
2562 * docutils/nodes.py:
2564   - Added ``TreeCopyVisitor`` class.
2565   - Added a ``copy`` method to ``Node`` and subclasses.
2566   - Added a ``SkipDeparture`` exception for visitors.
2567   - Renamed ``TreePruningException`` from ``VisitorException``.
2568   - Added docstrings to ``TreePruningException``, subclasses, and
2569     ``Nodes.walk()``.
2570   - Improved docstrings.
2571   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2572   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2573     imports.
2574   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2575     ``PreDecorative`` mixin.
2576   - Reworked the name/id bookkeeping; to ``document``, removed
2577     ``explicit_targets`` and ``implicit_targets`` attributes, added
2578     ``nametypes`` attribute and ``set_name_id_map`` method.
2579   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2580     traversals.
2581   - Added ``document.has_name()`` method.
2582   - Fixed DOM generation for list-attributes.
2583   - Added category class ``Labeled`` (used by footnotes & citations).
2584   - Added ``Element.set_class()`` method (sets "class" attribute).
2586 * docutils/optik.py: Added to project.  Combined from the Optik
2587   package, with added option groups and other modifications.  The use
2588   of this module is probably only temporary.
2590 * docutils/statemachine.py:
2592   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2593   - Added underscores to improve many awkward names.
2594   - In ``string2lines()``, changed whitespace normalizing translation
2595     table to regexp; restores Python 2.0 compatibility with Unicode.
2597 * docutils/urischemes.py:
2599   - Filled in some descriptions.
2600   - Added "shttp" scheme.
2602 * docutils/utils.py:
2604   - Added ``clean_rcs_keywords`` function (moved from
2605     docutils/transforms/frontmatter.py
2606     ``DocInfo.filter_rcs_keywords``).
2607   - Added underscores to improve many awkward names.
2608   - Changed names of Reporter's thresholds:
2609     warning_level -> report_level; error_level -> halt_level.
2610   - Moved ``utils.id()`` to ``nodes.make_id()``.
2611   - Added ``relative_path(source, target)``.
2613 * docutils/languages/de.py: German mappings; added to project.  Thanks
2614   to Gunnar Schwant for the translations.
2616 * docutils/languages/en.py: Added "Dedication" bibliographic field
2617   mappings.
2619 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2620   Chodorowski.
2622 * docutils/parsers/rst/states.py:
2624   - Added underscores to improve many awkward names.
2625   - Added RFC-2822 header support.
2626   - Extracted the inline parsing code from ``RSTState`` to a separate
2627     class, ``Inliner``, which will allow easy subclassing.
2628   - Made local bindings for ``memo`` container & often-used contents
2629     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2630   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2631   - Added ``MarkupMismatch`` exception; for late corrections.
2632   - Added ``-/:`` characters to inline markup's start string prefix,
2633     ``/`` to end string suffix.
2634   - Fixed a footnote bug.
2635   - Fixed a bug with literal blocks.
2636   - Applied patch from Simon Budig: simplified regexps with symbolic
2637     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2638   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2639   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2640   - Allowed non-ASCII in "simple names" (directive names, field names,
2641     references, etc.).
2642   - Converted ``Inliner.patterns.initial`` to be dynamically built
2643     from parts with ``build_regexp()`` function.
2644   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2645   - Updated docstrings.
2646   - Changed "table" to "grid_table"; added "simple_table" support.
2648 * docutils/parsers/rst/tableparser.py:
2650   - Changed ``TableParser`` to ``GridTableParser``.
2651   - Added ``SimpleTableParser``.
2652   - Refactored naming.
2654 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2655   a fallback language for directive names.
2657 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2658   directive to use a ``pending`` element, used only by HTML writers.
2660 * docutils/parsers/rst/directives/parts.py: Renamed from
2661   components.py.
2663   - Added "backlinks" attribute to "contents" directive.
2665 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2666   project by Adam Chodorowski.
2668 * docutils/readers/__init__.py: Gave Readers more control over
2669   choosing and instantiating Parsers.
2671 * docutils/readers/pep.py: Added to project; for PEP processing.
2673 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2674   requires a ``component`` parameter.
2676 * docutils/transforms/components.py: Added to project; transforms
2677   related to Docutils components.
2679 * docutils/transforms/frontmatter.py:
2681   - In ``DocInfo.extract_authors``, check for a single "author" in an
2682     "authors" group, and convert it to a single "author" element.
2683   - Added support for "Dedication" and generic bibliographic fields.
2685 * docutils/transforms/peps.py: Added to project; PEP-specific.
2687 * docutils/transforms/parts.py: Renamed from old components.py.
2689   - Added filter for `Contents`, to use alt-text for inline images,
2690     and to remove inline markup that doesn't make sense in the ToC.
2691   - Added "name" attribute to TOC topic depending on its title.
2692   - Added support for optional TOC backlinks.
2694 * docutils/transforms/references.py: Fixed indirect target resolution
2695   in ``Hyperlinks`` transform.
2697 * docutils/transforms/universal.py:
2699   - Changed ``Messages`` transform to properly filter out system
2700     messages below the warning threshold.
2701   - Added ``Decorations`` transform (support for ``--generator``,
2702     ``--date``, ``--time``, ``--source-link`` options).
2704 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2705   Engelbert Gruber's PDF writer.
2707 * docutils/writers/html4css1.py:
2709   - Made XHTML-compatible (switched to lowercase element & attribute
2710     names; empty tag format).
2711   - Escape double-dashes in comment text.
2712   - Improved boilerplate & modularity of output.
2713   - Exposed modular output in Writer class.
2714   - Added a "generator" meta tag to <head>.
2715   - Added support for the ``--stylesheet`` option.
2716   - Added support for ``decoration``, ``header``, and ``footer``
2717     elements.
2718   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2719     translation table to regexp; restores Python 2.0 compatibility
2720     with Unicode.
2721   - Added the translator class as instance variable to the Writer, to
2722     make it easily subclassable.
2723   - Improved option list spacing (thanks to Richard Jones).
2724   - Modified field list output.
2725   - Added backlinks to footnotes & citations.
2726   - Added percentage widths to "<col>" tags (from colspec).
2727   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2728     "<span>" changed to "<var>".
2729   - Inline literals: "<code>" changed to "<tt>".
2730   - Many changes to optimize vertical space: compact simple lists etc.
2731   - Add a command-line options & directive attributes to control TOC
2732     and footnote/citation backlinks.
2733   - Added support for optional footnote/citation backlinks.
2734   - Added support for generic bibliographic fields.
2735   - Identify backrefs.
2736   - Relative URLs for stylesheet links.
2738 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2739   PEPs (subclass of ``html4css1.Writer``).
2741 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2743 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2744   of the Docutils internal doctree in XML.
2746 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2748 * spec/doctree.txt:
2750   - Changed the title to "The Docutils Document Tree".
2751   - Added "Hyperlink Bookkeeping" section.
2753 * spec/docutils.dtd:
2755   - Added ``decoration``, ``header``, and ``footer`` elements.
2756   - Brought ``interpreted`` element in line with the parser: changed
2757     attribute "type" to "role", added "position".
2758   - Added support for generic bibliographic fields.
2760 * spec/notes.txt: Continual updates.  Added "Project Policies".
2762 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2763   section.
2765 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2767 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2768   mailing list discussions.
2770 * spec/pep-0287.txt:
2772   - Renamed to "reStructuredText Docstring Format".
2773   - Minor edits.
2774   - Reworked Q&A as an enumerated list.
2775   - Converted to reStructuredText format.
2777 * spec/pysource.dtd:
2779   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2781 * spec/pysource.txt: Removed from project.  Moved much of its contents
2782   to pep-0258.txt.
2784 * spec/rst/alternatives.txt:
2786   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2787   - Added "Inline External Targets" section.
2789 * spec/rst/directives.txt:
2791   - Added "backlinks" attribute to "contents" directive.
2793 * spec/rst/problems.txt:
2795   - Updated the Enumerated List Markup discussion.
2796   - Added new alternative table markup syntaxes.
2798 * spec/rst/reStructuredText.txt:
2800   - Clarified field list usage.
2801   - Updated enumerated list description.
2802   - Clarified purpose of directives.
2803   - Added ``-/:`` characters to inline markup's start string prefix,
2804     ``/`` to end string suffix.
2805   - Updated "Authors" bibliographic field behavior.
2806   - Changed "inline hyperlink targets" to "inline internal targets".
2807   - Added "simple table" syntax to supplement the existing but
2808     newly-renamed "grid tables".
2809   - Added cautions for anonymous hyperlink use.
2810   - Added "Dedication" and generic bibliographic fields.
2812 * test: Made test modules standalone (subdirectories became packages).
2814 * test/DocutilsTestSupport.py:
2816   - Added support for PEP extensions to reStructuredText.
2817   - Added support for simple tables.
2818   - Refactored naming.
2820 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2822   - Now supports true packages containing test modules
2823     (``__init__.py`` files required); fixes duplicate module name bug.
2825 * test/test_pep/: Subpackage added to project; PEP testing.
2827 * test/test_rst/test_SimpleTableParser.py: Added to project.
2829 * tools:
2831   - Updated html.py and publish.py front-end tools to use the new
2832     command-line processing facilities of ``docutils.frontend``
2833     (exposed in ``docutils.core.Publisher``), reducing each to just a
2834     few lines of code.
2835   - Added ``locale.setlocale()`` calls to front-end tools.
2837 * tools/buildhtml.py: Added to project; batch-generates .html from all
2838   the .txt files in directories and subdirectories.
2840 * tools/default.css:
2842   - Added support for ``header`` and ``footer`` elements.
2843   - Added styles for "Dedication" topics (biblio fields).
2845 * tools/docutils.conf: A configuration file; added to project.
2847 * tools/docutils-xml.py: Added to project.
2849 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2851 * tools/pep-html-template: Added to project.
2853 * tools/pep2html.py: Added to project from Python (nondist/peps).
2854   Added support for Docutils (reStructuredText PEPs).
2856 * tools/quicktest.py:
2858   - Added the ``--attributes`` option, hacked a bit.
2859   - Added a second command-line argument (output file); cleaned up.
2861 * tools/stylesheets/: Subdirectory added to project.
2863 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2866 Release 0.1 (2002-04-20)
2867 ========================
2869 This is the first release of Docutils, merged from the now inactive
2870 reStructuredText__ and `Docstring Processing System`__ projects.  For
2871 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2872 `DPS HISTORY`__ files.
2874 __ http://structuredtext.sourceforge.net/
2875 __ http://docstring.sourceforge.net/
2876 __ http://structuredtext.sourceforge.net/HISTORY.html
2877 __ http://docstring.sourceforge.net/HISTORY.html
2879 General changes: renamed 'dps' package to 'docutils'; renamed
2880 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2881 the test suites (reStructuredText's test/test_states renamed to
2882 test/test_rst); and all modifications required to make it all work.
2884 * docutils/parsers/rst/states.py:
2886   - Improved diagnostic system messages for missing blank lines.
2887   - Fixed substitution_reference bug.
2891    Local Variables:
2892    mode: indented-text
2893    indent-tabs-mode: nil
2894    sentence-end-double-space: t
2895    fill-column: 70
2896    End: