Fix: galician translation
[docutils.git] / HISTORY.txt
blob79d266764cfb415de4c1f78f2f6497c380c54353
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::
17 Changes Since 0.5
18 =================
20 * General:
22   - Backwards-compatible changes to remove python2.6 -3 deprecation warnings
23   - Text nodes now subclass unicode rather than UserString
24     (which is gone in python 3.0)
25   - [ 1719345 ] Galician translation 
27 * docutils/nodes.py:
29   - Added ``Element.__contains__`` method, for the in-operator.
31 * docutils/writers/newlatex2e/__init__.py:
33   - Apply [ 1612821 ] Double quotes in literal text in Italian/German
35 * docutils/writers/latex2e/__init__.py:
37   - Apply [ 1474017 ] image vertical alignment is reversed.
38   - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
39   - Fix: for spanish ``~n`` is ``n`` with tilde above, change to ``~{}n``.
40   - Change: has_key for dictionaries (not Nodes) to in-operator.
41   - Merge adjacent citations into one latex cite command.
43 Release 0.5 (2008-06-25)
44 ========================
46 * docutils/languages/he.py: Added to project: Hebrew mappings by
47   Meir Kriheli.
49 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew 
50   mappings by Meir Kriheli.
52 * docutils/frontend.py:
54   - Configuration files are now assumed and required to be
55     UTF-8-encoded.
56   - Paths of applied configuration files are now recorded in the
57     runtime setting ``_config_files`` (accessible via
58     ``--dump-settings``).
59   - Added ``--strip-elements-with-class`` and ``--strip-class``
60     options (``strip_elements_with_classes`` and ``strip_classes``
61     settings).
63 * docutils/io.py:
65   - Added code to determine the input encoding from data: encoding
66     declarations or the presence of byte order marks (UTF-8 & UTF-16).
67   - Added support for IronPython 1.0.
69 * docutils/nodes.py:
71   - Added ``document.__getstate__`` method, for pickling.
73 * docutils/parsers/rst/states.py:
75   - Allow ``+`` and ``:`` in reference names.
76   - Unquoted targets beginning with an underscore (``.. __target:
77     URI``) are no longer accepted.
78   - Added support for multiple attributions in a physical block quote
79     (indented text block), dividing it into multiple logical block
80     quotes.
81   - Added support for unicode bullets in bullet lists: "•", "‣", and
82     "⁃".
83   - Added support for new object-oriented directive interface,
84     retaining compatibility to the old functional interface.
85   - Added support for throwing ``DirectiveError``'s from within
86     directive code.
88 * docutils/parsers/rst/__init__.py:
90   - Added ``Directive`` base class.
91   - Added ``DirectiveError`` base class.
92   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
93     definitions.
95 * docutils/parsers/directives/:
97   - Refactored all reStructuredText directives to use the new
98     object-oriented directive interface.  Errors are now (mostly)
99     thrown using the new ``DirectiveError`` class.
101 * docutils/parsers/directives/misc.py:
103   - Added ``start-after`` and ``end-before`` options to ``include``
104     directive; thanks to Stefan Rank.
106 * docutils/transforms/universal.py:
108   - Added ``StripClassesAndElements`` transform to remove from the
109     document tree all elements with classes in
110     ``settings.strip_elements_with_classes`` and all "classes"
111     attribute values in ``self.document.settings.strip_classes``.
113 * docutils/transforms/writer_aux.py:
115   - Added ``Admonitions`` transform to transform specific admonitions
116     (like ``note``, ``warning``, etc.) into generic admonitions with a
117     localized title.
119 * docutils/writers/html4css1/__init__.py:
121   - Moved template functionality from the PEP/HTML writer here.
122   - Expanded the fragments available in the ``parts`` attribute.
123   - Moved ``id`` attributes from titles to surrounding ``div``
124     elements.
125   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
126     universally supported now).
127   - ``template.txt`` is now opened in text mode instead of binary mode
128     (to ensure Windows compatibility).
129   - ``a`` elements now have an "internal" or "external" class,
130     depending on reference type.
132 * docutils/writers/html4css1/template.txt: Added to project.
134 * docutils/writers/pep_html/:
136   - Moved template functionality to the HTML writer.
138 * docutils/writers/s5_html/__init__.py:
140   - Added ``view_mode`` & ``hidden_controls`` settings
141     (``--view-mode`` & ``--hidden-controls/--visible-controls``
142     options).
144 * docutils/writers/latex2e/__init__.py:
146   - Add ``--literal-block-env``
147   - Fix: escaping ``%`` in href urls.
148   - Move usepackage hyperref after stylesheet inclusion.
149   - Fix: scrartcl does not have chapter but scrreprt.
150   - Add newline after ``\end{verbatim}``.
151   - Merge smaller differences from latex2e_adaptive_preamble.
152   - Add ``use-part-section``.
153   - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
154   - Using leavemode option_list no longer needs to check if parent
155     is a definition list.
156   - Append ``\leavemode`` to definition list terms.
157   - No longer write visit\_/depart_definition_list_item comments to
158     output.
159   - Table column width with 3 decimal places.
160   - Add table stubs support (boldfont).
161   - Add assemble_parts to writer.
162   - Add simply support for nested tables.
163   - Fix verbatim in tables if use-verbatim-when-possible.
164   - Use section commands down to subparagraph.
165   - Put ensuremath around some latin1 chars.
166   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
167   - New option ``--use-bibtex=style,db1,db2``.
168   - New option ``--reference-label`` to allow usage of LaTeX ref for 
169     labels in section references.
170   - Add a label after every section to support sectionnumbers as reference
171     labels.
172   - Fix: bug# 1605376 rst2latex: bad options group list
173   - Remove inactive code for use_optionlist_for_option_list.
174   - Remove latex comments from option_list output.
175   - Fix: bug# 1612270 double qoutes in italian literal.
176   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target. 
177   - Add option --use-latex-abstract.
178   - Image width unit ``px`` is translated to ``pt``.
179   - Add image height support.
180   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
181     bug #1457388
182   - Fix: Do not escape underscores in citation reference labels if
183     use-latex-citations is set.
184   - Use centering instead of center for figure contents, to avoid vertical
185     space.
186   - Recognize table class: borderless, nolines, booktabs, standard.
187   - Fix: Renaming contents section does not work with latex writer; SF
188     bug #1487405.
189   - Applied patch for custom roles with classes from Edward Loper.
190   - Fixed bug that caused crashes with more than 256 lists.
192 * docutils/writers/pep_html/__init__.py:
194   - Changed to support new python.org website structure and
195     pep2pyramid.py.
197 * docs/howto/security.txt: "Deploying Docutils Securely", added to
198   project.
200 * tools/buildhtml.py:
202   -- Added ``ignore`` setting to exclude a list of shell patterns
203      (default: ``.svn:CVS``).
205 * tools/editors/emacs/rst.el:
207   - Changed license to "GPL".
208   - Added ``rst-straighten-decorations`` function.
209   - The ``compile`` module is now always loaded.
210   - Added ``rst-toggle-line-block`` function.
211   - Headings consisting only of non-ASCII characters are now
212     recognized by ``rst-toc`` and ``rst-adjust``.
213   - Added font-lock support for multi-line comments where the first
214     comment line is empty.
215   - Added ``(require 'font-lock)``.
217 * setup.py:
219   - Provide descriptive error message if distutils is missing.
222 Release 0.4 (2006-01-09)
223 ========================
225 * General:
227   - Updated the project policies for trunk/branch development &
228     version numbering.
230 * docutils/__init__.py:
232   - Added ``__version_details__`` attribute to describe code source
233     (repository/snapshot/release).
234   - Replaced ``default_transforms`` attribute of TransformSpec with
235     ``get_transforms()`` method.
237 * docutils/core.py:
239   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
240     functions, for document tree extraction and reprocessing.
242 * docutils/io.py:
244   - Added ``DocTreeInput`` class, for reprocessing existing documents.
245   - Added support for non-Unicode (e.g. binary) writer output.
247 * docutils/nodes.py:
249   - Re-introduced ``Targetable.indirect_reference_name``, for
250     MoinMoin/reST compatibility (removed in r3124/r3129).
251   - Added ``serial_escape`` function; escapes string values that are
252     elements of a list, for serialization.  Modified Docutils-XML
253     writing (``Element._dom_node``) and pseudo-XML writing
254     (``Element.starttag``) to use ``serial_escape``.
255   - Added ``Node.deepcopy()`` method.
256   - Removed the internal lists ``document.substitution_refs``,
257     ``document.anonymous_refs``, and ``document.anonymous_targets``.
258   - Added a "container" element.
259   - Fixed bug where values of list-valued attributes of elements
260     originating from custom interpreted text roles (i.e., with custom
261     classes) were being shared between element instances.  Reported by
262     Shmuel Zeigerman.
264 * docutils/statemachine.py:
266   - Added trailing whitespace stripping to ``string2lines()``.
267   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
268     Asian double-width character support.
270 * docutils/utils.py:
272   - Added ``east_asian_column_width()`` for double-width character
273     support.
275 * docutils/languages/ja.py: Added to project: Japanese mappings by
276   Hisashi Morita.
278 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
279   mappings by Panjunyong.
281 * docutils/parsers/null.py: Added to project; a do-nothing parser.
283 * docutils/parsers/rst/__init__.py:
285   - Added validator to tab_width setting, with test.  Closes SF bug
286     #1212515, report from Wu Wei.
288 * docutils/parsers/rst/states.py:
290   - Fixed bug with escaped colons indicating a literal block.
291   - Fixed bug with enumerated lists (SF#1254145).
292   - Backslash-escaped colons inside of field names are now allowed.
293   - Targets (implicit and explicit), anonymous hyperlink references
294     and auto-numbered footnote references inside of substitution
295     definitions are now disallowed.
296   - Fixed bug: list items with blank first lines.
297   - Fixed bug: block quote attributions with indented second lines.
298   - Added East Asian double-width character support (Python 2.4 only).
300 * docutils/parsers/rst/tableparser.py:
302   - Added East Asian double-width character support (Python 2.4 only).
304 * docutils/parsers/rst/directives/body.py:
306   - Added the "container" directive.
308 * docutils/parsers/rst/directives/misc.py:
310   - Added the "default-role", "title", and "date" directives.
311   - Added standard data file syntax to the "include" directive.
312   - Added support for "class" directive content.
314 * docutils/parsers/rst/directives/images.py:
316   - Added ``indirect_reference_name`` support for images with a target
317     option.
318   - Added support for image width and height units.
319   - Fixed bug with image "target" options.
321 * docutils/parsers/rst/directives/references.py:
323   - Added "class" attribute to "target-notes" directive, for
324     footnote_reference classes.
326 * docutils/parsers/rst/include/: Directory added to project; contains
327   standard data files for the "include" directive.  Initial contents:
328   character entity substitution definition sets, and a set of
329   definitions for S5/HTML presentations.
331 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
332   mappings by David Goodger.
333   
334 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
335   Simplified Chinese mappings by Panjunyong.
337 * docutils/readers/__init__.py:
339   - Added universal.Decorations and universal.ExposeInternals
340     transforms as default transforms for all readers.
341   - Added ``ReReader`` base class for readers that reread an existing
342     document tree.
344 * docutils/readers/doctree.py: Added to project; a reader for existing
345   document trees.
347 * docutils/transforms/frontmatter.py:
349   - Fixed the DocInfo transform to handle SVN-style expansion of the
350     "Date" keyword.
351   - In ``DocInfo.extract_authors``, treat the contents of "authors"
352     fields uniformly.
354 * docutils/transforms/misc.py:
356   - Added misc.Transitions transform, extracted from
357     universal.FinalChecks.
359 * docutils/transforms/references.py:
361   - Added references.DanglingReferences transform, extracted from
362     universal.FinalChecks.
363   - Fixed bug with doubly-indirect substitutions.
364   - Added footnote_reference classes attribute to "TargetNotes".
365   - Fixed bug with circular substitution definitions that put Docutils
366     into an infinite loop.
368 * docutils/transforms/universal.py:
370   - Added universal.ExposeInternals transform, extracted from
371     universal.FinalChecks.
372   - Removed universal.FinalChecks transform (logic has been moved to
373     several new transforms).
374   - Fixed bug with the "expose_internals" setting and Text nodes
375     (exposed by the "rawsource" internal attribute).
376   - Added the universal.StripComments transform, implementation of the
377     "strip_comments" setting.
379 * docutils/transforms/writer_aux.py: Added to project; auxiliary
380   transforms for writers.
382   - Added ``Compound`` transform, which flattens compound paragraphs.
384 * docutils/writers/: Several writer modules (html4css1.py) were
385   converted into packages.  Support modules and data files have been
386   moved into the packages.  The stylesheets for the HTML writers are
387   now installed along with the code, the code knows where to find
388   them, and the default is to use them (actually, to embed them).
389   Some adjustments to configuration files may be necessary.  The
390   easiest way to obtain the new default behavior is to remove all
391   settings whose name includes "stylesheet".
393 * docutils/writers/__init__.py:
395   - Added universal.Messages and universal.FilterMessages transforms
396     as default transforms for all writers.
397   - Added ``UnfilteredWriter`` base class for writers that pass the
398     document tree on unchanged.
400 * docutils/writers/docutils_xml.py:
402   - Made ``xmlcharrefreplace`` the default output encoding error
403     handler.
405 * docutils/writers/html4css1/: 
407   - Added support for image width and height units.
408   - Made ``xmlcharrefreplace`` the default output encoding error
409     handler.
410   - Made ``--embed-stylesheet`` the default rather than
411     ``--link-stylesheet``.
412   - Moved "id" attribute from container (section etc.) to title's <a>
413     tag, to be on the same tag as "name".
414     (!!! To be reverted in Docutils 0.5.)
415   - Added vertical space between fields of field lists.
416   - Added ``--compact-field-lists`` option to remove vertical space in
417     simple field lists.
418   - Made cloaking of email addresses with ``--cloak-email-addresses``
419     less obtrusive.
420   - Fixed support for centered images.
421   - Added support for class="compact" & class="open" lists.
423 * docutils/writers/latex2e/:
425   - Underscores in citekeys are no longer escaped.
427 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
428   mapping of Unicode characters to LaTeX equivalents.
430 * docutils/writers/s5_html/: Package added to project; writer for
431   S5/HTML slide shows.
433 * docs/dev/distributing.txt: Added to project; guide for distributors
434   (package maintainers).
436 * docs/dev/hacking.txt: Added to project; guide for developers.
438 * docs/ref/doctree.txt:
440   - Updated for plural attributes "classes", "ids", "names",
441     "dupnames".
442   - Added the "container" element.
444 * docs/ref/docutils.dtd:
446   - Updated for plural attributes "classes", "ids", "names",
447     "dupnames".
449 * docs/user/emacs.txt: Added to project; a document about Emacs
450   support for reStructuredText and Docutils.
452 * docs/user/links.txt: Added to project; lists of Docutils-related
453   links.
455 * docs/user/mailing-lists.txt: Added to project; information about
456   Docutils-related mailing lists and how to access them.
458 * docs/user/slide-shows.txt: Added to project; example of and docs for
459   the S5/HTML writer (``rst2s5.py`` front end).
461 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
462   Files", added to project.
464 * test/coverage.sh: Added to project; test coverage script.
466 * test/DocutilsTestSupport.py:
468   - Added support for specifying runtime settings at the suite level.
470 * test/test_functional.py:
472   - Added the ``clear_output_directory`` function.
473   - Added support for ``_test_more`` functions in functional test
474     config files.
476 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
478 * tools/rstpep2html.py: Renamed from pep.py.
480 * tools/dev/create_unimap.py: Added to project; script to create the
481   docutils/writers/unimap_latex.py mapping file.
483 * tools/dev/profile_docutils.py: Added to project; profiler script.
485 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
487 * tools/editors/emacs/restructuredtext.el,
488   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
489   Removed from project; the functionality is now contained in rst.el.
491 * tools/editors/emacs/rst.el: Added to project.  Added many features
492   and fixed many bugs.  See docs/user/emacs.txt for details.
494 * tools/stylesheets: Removed from project.  Stylesheets have been
495   renamed and moved into writer packages.
498 Release 0.3.9 (2005-05-26)
499 ==========================
501 * General:
503   - Eliminated and replaced all uses of the old string attributes
504     ``id``, ``name``, ``dupname`` and ``class`` with references to the
505     new list attributes ``ids``, ``names``, ``dupnames`` and
506     ``classes`` throughout the whole source tree.
508 * docutils/core.py:
510   - Enabled ``--dump-*`` options when ``--traceback`` specified,
511     allowing for easier debugging.
512   - In ``Publisher.publish()``, expanded the generic top-level
513     exception catching.
515 * docutils/examples.py:
517   - Added ``internals`` function for exploration.
519 * docutils/io.py:
521   - Fixed ``Input.decode`` method to apply heuristics only if no
522     encoding is explicitly given, and to provide better reporting of
523     decoding errors.
524   - The ``Input.decode`` method now removes byte order marks (BOMs)
525     from input streams.
527 * docutils/nodes.py:
529   - ``image`` element class changed to subclass of Element, not
530     TextElement (it's an empty element, and cannot contain text).
531   - Added ``attr_defaults`` dictionary for default attribute values.
532   - Added empty list as default value for the following attributes:
533     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
534   - Added ``document.decoration`` attribute,
535     ``document.get_decoration`` method, and ``decoration.get_header``
536     & ``.get_footer`` methods.
537   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
538     methods.
540 * docutils/utils.py:
542   - Removed ``docutils.utils.Reporter.categories``,
543     ``docutils.utils.ConditionSet``, and all references to them, to
544     simplify error reporting.
546 * docutils/languages/nl.py: Added to project; Dutch mappings by
547   Martijn Pieters.
549 * docutils/parsers/rst/__init__.py:
551   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
553 * docutils/parsers/rst/states.py:
555   - Added check for escaped at-mark to prevent email address recognition.
556   - Fixed option lists to allow spaces inside ``<angle-bracketed option
557     arguments>``.
558   - Allowed whitespace in paths and URLs.
559   - Added auto-enumerated list items.
560   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
561     followed by text.
562   - Added support for table stub columns.
564 * docutils/parsers/rst/directives/__init__.py:
566   - Allowed whitespace in paths (``path`` function).
567   - Added ``uri`` directive option conversion function.
569 * docutils/parsers/rst/directives/body.py:
571   - Fixed illegal context bug with "topic" directive (allowed within
572     sidebars; not within body elements).
574 * docutils/parsers/rst/directives/images.py:
576   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
577   - Added support for the ``file_insertion_enabled`` setting in the
578     "figure" directive (disables "figwidth" option).
579   - "image" directive: added checks for valid values of "align" option,
580     depending on context.  "figure" directive: added specialized
581     "align" option and attribute on "figure" element.
582   - Made ":figwidth: image" option of "figure" directive work again.
583   - Fixed bug with reference names containing uppercase letters
584     (e.g. ``Name_``) in "target" option of "image" directive.
586 * docutils/parsers/rst/directives/misc.py:
588   - Fixed "include" and "raw" directives to catch text decoding
589     errors.
590   - Allowed whitespace in "include" & "raw" directive paths.
591   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
592     settings in "include" & "raw" directives.
594 * docutils/parsers/rst/directives/parts.py:
596   - Added "header" & "footer" directives.
597   - Fixed illegal context bug with "contents" directive (topics
598     allowed within sidebars; not within body elements).
600 * docutils/parsers/rst/directives/tables.py:
602   - Added "list-table" directive.
603   - Caught empty CSV table bug.
604   - Added support for the ``file_insertion_enabled`` setting in the
605     "csv-table" directive.
606   - Added ``stub-columns`` option to "csv-table" and "list-table"
607     directives.
609 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
610   mappings by Martijn Pieters.
612 * docutils/readers/standalone.py:
614   - Added ``--section-subtitles`` and ``--no-section-subtitles``
615     options to activate or deactivate the SectSubTitle transform.
617 * docutils/transforms/frontmatter.py:
619   - Added SectSubTitle transform to promote titles of lone
620     subsections to subtitles.
622 * docutils/transforms/references.py:
624   - Fixed mislocated internal targets bug, by propagating internal
625     targets to the next node, making use of the newly added support
626     for multiple names and IDs.
627   - Fixed duplicate footnote label bug.
628   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
629     transform.
631 * docutils/writers/html4css1.py:
633   - Fixed unencoded stylesheet reference bug (characters like "&" in
634     stylesheet references).
635   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
636     tags).
637   - Added support for multiple IDs per node by creating empty ``span``
638     tags.
639   - Added the ``field_name_limit`` & ``option_limit`` settings &
640     support.
641   - Added support for table stub columns.
642   - Added support for the ``align`` attribute on ``figure`` elements.
643   - Added the ``cloak_email_addresses`` setting & support.
644   - Added ``html_prolog``, ``html_head``, ``html_body``,
645     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
646     ``docutils.core.publish_parts``.
647   - Added support for section subtitles.
649 * docutils/writers/latex2e.py:
651   - Fixed tables starting with more than one multirow cell.
652   - Improved --use-latex-docinfo so that organization/contact/address
653     fields are lumped with the last author field and appear on the
654     titlepage.
655   - Made sure the titlepage is always shown with --use-latex-docinfo,
656     even if the document has no title.
657   - Made sure that latex doesn't fill in today's date if no date field
658     was given.
659   - Added support for section subtitles.
661 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
662   (under development).
664 * docutils/writers/null.py: Added to project; a do-nothing Writer.
666 * docs/api/publisher.txt:
668   - Added "``publish_parts`` Details" section.
670 * docutils/dev/repository.txt: Added to project; information about the
671   Docutils Subversion repository.
673 * docs/ref/docutils.dtd:
675   - Added a ``stub`` attribute to the ``colspec`` element via the
676     ``tbl.colspec.att`` parameter entity.
677   - Allowed topic elements within sidebars
678   - Added an ``align`` attribute to the ``figure`` element.
680 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
681   writer.
684 Release 0.3.7 (2004-12-24)
685 ==========================
687 * docutils/frontend.py:
689   - Added options: --input-encoding-error-handler,
690     --record-dependencies, --leave-footnote-reference-space,
691     --strict-visitor.
692   - Added command-line and config file support for "overrides" setting
693     parameter.
695 * docutils/io.py:
697   - Added support for input encoding error handler.
699 * docutils/nodes.py:
701   - Added dispatch_visit and dispatch_departure methods to
702     NodeVisitor; useful as a hook for Visitors.
703   - Changed structure of ``line_block``; added ``line``.
704   - Added ``compound`` node class.
705   - Added a mechanism for Visitors to transitionally ignore new node
706     classes.
708 * docutils/utils.py:
710   - Moved ``escape2null`` and ``unescape`` functions from
711     docutils/parsers/rst/states.py.
713 * docutils/parsers/rst/roles.py:
715   - Added "raw" role.
716   - Changed role function API: the "text" parameter now takes
717     null-escaped interpreted text content.
719 * docutils/parsers/rst/states.py:
721   - Fixed bug where a "role" directive in a nested parse would crash
722     the parser; the state machine's "language" attribute was not being
723     copied over.
724   - Added support for line block syntax.
725   - Fixed directive parsing bug: argument-less directives didn't
726     notice that arguments were present.
727   - Removed error checking for transitions.
728   - Added support for multiple classifiers in definition list items.
729   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
730   - Changed role function API: the "text" parameter now takes
731     null-escaped interpreted text content.
732   - Empty sections and documents are allowed now.
734 * docutils/parsers/rst/directives/__init__.py:
736   - Added ``encoding`` directive option conversion function.
737   - Allow multiple class names in class_option conversion function.
739 * docutils/parsers/rst/directives/body.py:
741   - Converted the line-block directive to use the new structure.
742   - Extracted the old line-block functionality to the ``block``
743     function (still used).
744   - Added ``compound`` directive (thanks to Lea Wiemann).
746 * docutils/parsers/rst/directives/misc.py:
748   - Added "encoding" option to "include" and "raw" directives.
749   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
750   - Allow multiple class names in the "class" directive.
752 * docutils/parsers/rst/directives/parts.py:
754   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
755     options.  Thanks to Lele Gaifax.
757 * docutils/parsers/rst/directives/tables.py:
759   - Added "encoding" directive to "csv-table" directive.
760   - Added workaround for lack of Unicode support in csv.py, for
761     non-ASCII CSV input.
763 * docutils/transforms/misc.py:
765   - Fixed bug when multiple "class" directives are applied to a single
766     element.
767   - Enabled multiple format names for "raw" directive.
769 * docutils/transforms/references.py:
771   - Added support for trimming whitespace from beside substitution
772     references.
774 * docutils/transforms/universal.py:
776   - FinalChecks now checks for illegal transitions and moves
777     transitions between sections.
779 * docutils/writers/html4css1.py:
781   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
782   - "stylesheet" and "stylesheet_path" settings are now mutually
783     exclusive.
784   - Added support for the new line_block/line structure.
785   - --footnote-references now overrides
786     --trim-footnote-reference-space, if applicable.
787   - Added support for ``compound`` elements.
788   - Enabled multiple format names for "raw" directive.
789   - ``<p>`` tags of a paragraph which is the only visible child of the
790     document node are no longer stripped.
791   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
792     new method ``should_be_compact_paragraph()``.
793   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
794     elements.
795   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
796     the output if they have their ``class`` attribute set.
797   - The whole document is now surrounded by a ``<div
798     class="document">`` element.
799   - Body-level images are now wrapped by their own ``<div>`` elements,
800     with image classes copied to the wrapper, and for images which
801     have the ``:align:`` option set, the surrounding ``<div>`` now
802     receives a class attribute (like ``class="align-left"``).
804 * docutils/writers/latex2e.py:
806   - no newline after depart_term.
807   - Added translations for some Unicode quotes.
808   - Added option "font-encoding", made package AE the default.
809   - "stylesheet" and "stylesheet_path" settings are now mutually
810     exclusive.
811   - --footnote-references now overrides
812     --trim-footnote-reference-space, if applicable.
813   - The footnote label style now matches the footnote reference style
814     ("brackets" or "superscript").
815   - Added support for ``compound`` elements.
816   - Enabled multiple format names for "raw" directive.
818 * docs/ref/docutils.dtd:
820   - Changed structure of the ``line_block`` element; added ``line``.
821   - Added ``compound`` element.
822   - Added "ltrim" and "rtrim" attributes to
823     ``substitution_definition`` element.
824   - Enabled multiple format names for ``raw`` element.
825   - Enabled multiple classifiers in ``definition_list_item`` elements.
827 * docs/ref/rst/directives.txt
829   - Marked "line-block" as deprecated.
830   - "Class" directive now allows multiple class names.
831   - Added "Rationale for Class Attribute Value Conversion".
832   - Added warning about "raw" overuse/abuse.
834 * docs/ref/rst/restructuredtext.txt:
836   - Added syntax for line blocks.
837   - Definition list items may have multiple classifiers.
839 * docs/ref/rst/roles.txt:
841   - Added "raw" role.
843 * tools/stylesheets/default.css:
845   - Added support for the new line_block structure.
846   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
849 Release 0.3.5 (2004-07-29)
850 ==========================
852 General:
854 * _`Documentation cleanup/reorganization`.
856   - Created new subdirectories of docs/:
858     * ``docs/user/``: introductory/tutorial material for end-users
859     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
860     * ``docs/api/``: API reference material for client-developers
861     * ``docs/ref/``: reference material for all groups
862     * ``docs/howto/``: for component-developers and core-developers
863     * ``docs/peps/``: Python Enhancement Proposals
865   - Moved ``docs/*`` to ``docs/user/``.
866   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
867     ``spec/`` to ``docs/dev``.
868   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
869     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
870   - Moved ``alternatives.txt``, and ``problems.txt`` from
871     ``spec/rst/`` to ``docs/dev/rst/``.
872   - Moved ``reStructuredText.txt``, ``directives.txt``,
873     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
874     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
875     ``roles.txt``, ``reStructuredText.txt`` to
876     ``restructuredtext.txt``.
877   - Moved ``spec/howto/`` to ``docs/howto``.
879   In order to keep the CVS history of moved files, we supplied
880   SourceForge with a `script for modifying the Docutils CVS
881   repository`__.
883   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
885   After running the cleanup script:
887   - Added ``docs/index.txt``.
888   - Added a ``.htaccess`` file to the ``web`` module, containing
889     redirects for all old paths to new paths.  They'll preserve
890     fragments (the "#name" part of a URL), and won't clutter up the
891     file system, and will correct the URL in the user's browser.
892   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
893     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
894     the "To Do" list itself in ``docs/dev/todo.txt``.
895   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
896     section of ``docs/dev/todo.txt``.
897   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
898   - Added "How To Report Bugs" to ``BUGS.txt``.
899   - Went through all the sources and docs (including under web/) and
900     updated links.  Mostly done by Lea Wiemann; thanks Lea!
901     (Still need to update links in the sandboxes.)
903 Specific:
905 * BUGS.txt: Added to project.
907 * THANKS.txt: Added to project.
909 * docutils/__init__.py:
911   - 0.3.4: Post-release.
913 * docutils/core.py:
915   - Added special error handling & advice for UnicodeEncodeError.
916   - Refactored Publisher.publish (simplified exception handling &
917     extracted debug dumps).
918   - Renamed "enable_exit" parameter of convenience functions to
919     "enable_exit_status".
920   - Enabled traceback (exception propagation) by default in
921     programmatic convenience functions.
922   - Now publish_file and publish_cmdline convenience functions return
923     the encoded string results in addition to their regular I/O.
924   - Extracted common code from publish_file, publish_string, and
925     publish_parts, into new publish_programmatically.  Extracted
926     settings code to ``Publisher.process_programmatic_settings``.
927   - In Publisher.publish, disabled ``settings_overrides`` when
928     ``settings`` is supplied; redundant.
930 * docutils/frontend.py:
932   - Added help text for "--output-encoding-error-handler" and
933     "--error-encoding-error-handler".
934   - Renamed "--exit" to "--exit-status".
935   - Simplified default-setting code.
937 * docutils/parsers/rst/__init__.py:
939   - Added "--pep-base-url" and "--rfc-base-url" options.
941 * docutils/parsers/rst/states.py:
943   - Made URI recognition more aggressive and intelligent.
945 * docutils/parsers/rst/directives/__init__.py:
947   - Added several directive option conversion functions.
949 * docutils/parsers/rst/directives/body.py:
951   - Moved "table" directive to tables.py.
953 * docutils/parsers/rst/directives/tables.py: Table-related directives,
954   added to project.
956 * docutils/writers/latex2e.py:
958   - Added "--table-style=(standard|booktabs|nolines)"
959   - figures get "here" option (LaTeX per default puts them at bottom),
960     and figure content is centered.
961   - Rowspan support for tables.
962   - Fix: admonition titles before first section.
963   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
964   - Replave ``_`` in literal by an underlined blank, because it has the correct
965     width.
966   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
967   - A few unicode replacements, if output_encoding != utf
968   - Add "--graphicx-option".
969   - Indent literal-blocks.
970   - Fix: omit ``\maketitle`` when there is no document title.
972 * docs/index.txt: "Docutils Project Documentation Overview", added to
973   project.
975 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
976   Tool", added to project.
978 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
980 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
982 * docs/dev/policies.txt: Added to project (extracted from
983   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
985 * docs/dev/release.txt: Added to project (extracted from
986   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
988 * docs/dev/testing.txt: Added to project.
990 * docs/dev/website.txt: Added to project (extracted from
991   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
993 * docs/ref/rst/directives.txt:
995   - Added directives: "table", "csv-table".
997 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
998   added to project.  1 page for syntax, and a 1 page reference for
999   directives and roles.  Source text to be used as-is; not meant to be
1000   converted to HTML.
1002 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1003   with a change of title.
1005 * test/functional/, contents, and test/test_functional.py: Added to
1006   project.
1008 * tools/buildhtml.py: Fixed bug with config file handling.
1010 * tools/html.py: Removed from project (duplicate of rst2html.py).
1012 * tools/pep2html.py: Removed from project (duplicate of Python's
1013   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1014   Docutils-related PEPs in docs/peps/).
1016 * tools/rst2pseudoxml.py: Renamed from publish.py.
1018 * tools/rst2xml.py: Renamed from docutils-xml.py.
1020 * tools/test.txt: Removed from project; moved to
1021   docs/user/rst/demo.txt.
1023 * setup.py: Now also installs ``rst2latex.py``.
1026 Release 0.3.3 (2004-05-09)
1027 ==========================
1029 * docutils/__init__.py:
1031   - 0.3.1: Reorganized config file format (multiple sections); see
1032     docs/config.txt.
1033   - Added unknown_reference_resolvers attribute to TransformSpec.
1034   - 0.3.2: Interpreted text reorganization.
1035   - 0.3.3: Released.
1037 * docutils/core.py:
1039   - Catch system messages to stop tracebacks from parsing errors.
1040   - Catch exceptions during processing report & exit without
1041     tracebacks, except when "--traceback" used.
1042   - Reordered components for OptionParser; application comes last.
1043   - Added "config_section" parameter to several methods and functions,
1044     allowing front ends to easily specify their config file sections.
1045   - Added publish_parts convenience function to allow access to individual
1046     parts of a document.
1048 * docutils/examples.py: Added to project; practical examples of
1049   Docutils client code, to be used as-is or as models for variations.
1051 * docutils/frontend.py:
1053   - Added "--traceback" & "--no-traceback" options ("traceback"
1054     setting).
1055   - Implemented support for config file reorganization:
1056     ``standard_config_files`` moved from ``ConfigParser`` to
1057     ``OptionParser``; added
1058     ``OptionParser.get_config_file_settings()`` and
1059     ``.get_standard_config_settings()``; support for old "[options]"
1060     section (with deprecation warning) and mapping from old to new
1061     settings.
1062   - Reimplemented setting validation.
1063   - Enabled flexible boolean values: yes/no, true/false, on/off.
1064   - Added ``Values``, a subclass of ``optparse.Values``, with support
1065     for list setting attributes.
1066   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1067     thanks to Beni Cherniavsky.
1068   - Added "--no-section-numbering" option.
1070 * docutils/io.py:
1072   - Catch IOErrors when opening source & destination files, report &
1073     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1074     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1076 * docutils/nodes.py:
1078   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1079     method definitions (via ``exec``) to dynamic assignments (via
1080     ``setattr``); thanks to Roman Suzi.
1081   - Encapsulated visitor dynamic assignments in a function; thanks to
1082     Ian Bicking.
1083   - Added indirect_reference_name attribute to the Targetable
1084     class. This attribute holds the whitespace_normalized_name
1085     (contains mixed case) of a target.
1087 * docutils/statemachine.py:
1089   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1090   - Added ``StringList.get_2D_block``.
1092 * docutils/utils.py:
1094   - Added "level" attribute to SystemMessage exceptions.
1096 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1097   Jannie Hofmeyr.
1099 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1100   Blaha.
1102 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1103   Marcelo Huerta San Martin.
1105 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1106   mappings by Lalo Martins.
1108 * docutils/languages/ru.py: Added to project; Russian mappings by
1109   Roman Suzi.
1111 * docutils/parsers/rst/roles.py: Added to project.  Contains
1112   interpreted text role functions, a registry for interpreted text
1113   roles, and an API for adding to and retrieving from the registry.
1114   Contributed by Edward Loper.
1116 * docutils/parsers/rst/states.py:
1118   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1119   - Allowed true em-dash character and "---" as block quote
1120     attribution marker.
1121   - Added support for <angle-bracketed> complex option arguments
1122     (option lists).
1123   - Fixed handling of backslashes in substitution definitions.
1124   - Fixed off-by-1 error with extra whitespace after substitution
1125     definition directive.
1126   - Added inline markup parsing to field lists' field names.
1127   - Added support for quoted (and unindented) literal blocks.
1128     Driven in part by a bribe from Frank Siebenlist (thanks!).
1129   - Parser now handles escapes in URIs correctly.
1130   - Made embedded-URIs' reference text omittable.  Idea from Beni
1131     Cherniavsky.
1132   - Refactored explicit target processing code.
1133   - Added name attribute to references containing the reference name only
1134     through whitespace_normalize_name (no case changes).
1135   - parse_target no longer returns the refname after going through
1136     normalize_name. This is now handled in make_target.
1137   - Fixed bug relating to role-less interpreted text in non-English
1138     contexts.
1139   - Reorganized interpreted text processing; moved code into the new
1140     roles.py module.  Contributed by Edward Loper.
1141   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1142     ``parse_directive_block``.
1144 * docutils/parsers/rst/tableparser.py:
1146   - Reworked for ``StringList``, to support "include" directives in
1147     table cells.
1149 * docutils/parsers/rst/directives/__init__.py:
1151   - Renamed ``unchanged()`` directive option conversion function to
1152     ``unchanged_required``, and added a new ``unchanged``.
1153   - Catch unicode value too high error; fixes bug 781766.
1154   - Beefed up directive error reporting.
1156 * docutils/parsers/rst/directives/body.py:
1158   - Added basic "table" directive.
1160 * docutils/parsers/rst/directives/images.py:
1162   - Added "target" option to "image" directive.
1163   - Added name attribute to references containing the reference name only
1164     through whitespace_normalize_name (no case changes).
1166 * docutils/parsers/rst/directives/misc.py:
1168   - Isolated the import of the ``urllib2`` module; was causing
1169     problems on SourceForge (``libssl.so.2`` unavailable?).
1170   - Added the "role" directive for declaring custom interpreted text
1171     roles.
1173 * docutils/parsers/rst/directives/parts.py:
1175   - The "contents" directive does more work up-front, creating the
1176     "topic" and "title", and leaving the "pending" node for the
1177     transform.  Allows earlier reference resolution; fixes subtle bug.
1179 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1180   mappings by Jannie Hofmeyr.
1182 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1183   mappings by Marek Blaha.
1185 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1186   mappings by Marcelo Huerta San Martin.
1188 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1189   Portuguese mappings by Lalo Martins.
1191 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1192   mappings by Roman Suzi.
1194 * docutils/transforms/parts.py:
1196   - The "contents" directive does more work up-front, creating the
1197     "topic" and "title", and leaving the "pending" node for the
1198     transform.  Allows earlier reference resolution; fixes subtle bug.
1199   - Added support for disabling of section numbering.
1201 * docutils/transforms/references.py:
1203   - Verifying that external targets are truly targets and not indirect
1204     references. This is because we are now adding a "name" attribute to
1205     references in addition to targets. Note sure if this is correct!
1206   - Added code to hook into the unknown_reference_resolvers list for a
1207     transformer in resolve_indirect_target. This allows the
1208     unknown_reference_resolvers to keep around indirect targets which
1209     docutils doesn't know about.
1210   - Added specific error message for duplicate targets.
1212 * docutils/transforms/universal.py:
1214   - Added FilterMessages transform (removes system messages below the
1215     verbosity threshold).
1216   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1217     to FinalCheckVisitor for application-specific handling of
1218     unresolvable references.
1219   - Added specific error message for duplicate targets.
1221 * docutils/writers/__init__.py:
1223   - Added assemble_parts method to the Writer class to allow for
1224     access to a documents individual parts.
1225   - Documented & set default for ``Writer.output`` attribute.
1227 * docutils/writers/html4css1.py:
1229   - Fixed unicode handling of attribute values (bug 760673).
1230   - Prevent duplication of "class" attribute values (bug report from
1231     Kirill Lapshin).
1232   - Improved table grid/border handling (prompted by report from Bob
1233     Marshall).
1234   - Added support for table titles.
1235   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1236     to Darek Suchojad.
1237   - Added functionality to keep track of individual parts of a document
1238     and store them in a dictionary as the "parts" attribute of the writer.
1239     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1240   - Added proper support for the "scale" attribute of the "image"
1241     element.  Contributed by Brent Cook.
1242   - Added ``--initial-header-level`` option.
1243   - Fixed bug: the body_pre_docinfo segment depended on there being a
1244     docinfo; if no docinfo, the document title was incorporated into
1245     the body segment.  Adversely affected the publish_parts interface.
1247 * docutils/writers/latex2e.py:
1249   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1250     about a missing file.
1251   - Added options and support: ``--compound-enumerators``,
1252     ``--section-prefix-for-enumerators``, and
1253     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1254     934322).
1255   - Added option ``--use-verbatim-when-possible``, to avoid
1256     problematic characters (eg, '~' in italian) in literal blocks.
1257   - It's now possible to use four section levels in the `book` and
1258     `report` LaTeX classes.  The default `article` class still has
1259     three levels limit.
1261 * docs/config.txt: "Docutils Configuration Files", added to project.
1262   Moved config file entry descriptions from tools.txt.
1264 * docs/tools.txt:
1266   - Moved config file entry descriptions to config.txt.
1268 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1269   Development".
1271 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1272   Text Roles", added to project.
1274 * spec/rst/reStructuredText.txt:
1276   - Added description of support for <angle-bracketed> complex option
1277     arguments to option lists.
1278   - Added subsections for indented and quoted literal blocks.
1280 * test: Continually adding & updating tests.
1282   - Added test/test_settings.py & test/data/config_*.txt support
1283     files.
1284   - Added test/test_writers/test_htmlfragment.py.
1286 * test/DocutilsTestSupport.py:
1288   - Refactored LaTeX publisher test suite/case class names to make
1289     testing other writers easier.
1290   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1291     to test the processing of HTML fragments which use the new
1292     publish_parts convenience function.
1294 * tools/buildhtml.py:
1296   - Added support for the "--prune" option.
1297   - Removed dependency on pep2html.py; plaintext PEPs no longer
1298     supported.
1300 * tools/docutils.conf:
1302   - Updated for configuration file reorganization.
1304 * tools/rst2html.py:
1306   - copied from tools/html.py
1308 * setup.py:
1310   - added a 'scripts' section to configuration
1311   - added 'tools/rst2html.py' to the scripts section
1314 Release 0.3 (2003-06-24)
1315 ========================
1317 General:
1319 * Renamed "attribute" to "option" for directives/extensions.
1321 * Renamed transform method "transform" to "apply".
1323 * Renamed "options" to "settings" for runtime settings (as set by
1324   command-line options).  Sometimes "option" (singular) became
1325   "settings" (plural).  Some variations below:
1327   - document.options -> document.settings (stored in other objects as
1328     well)
1329   - option_spec -> settings_spec (not directives though)
1330   - OptionSpec -> SettingsSpec
1331   - cmdline_options -> settings_spec
1332   - relative_path_options -> relative_path_settings
1333   - option_default_overrides -> settings_default_overrides
1334   - Publisher.set_options -> Publisher.get_settings
1336 Specific:
1338 * COPYING.txt: Added "Public Domain Dedication".
1340 * FAQ.txt: Frequently asked questions, added to project.
1342 * setup.py:
1344   - Updated with PyPI Trove classifiers.
1345   - Conditional installation of third-party modules.
1347 * docutils/__init__.py:
1349   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1350   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1351   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1352   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1353     option and its effect on the PEP template & writer.
1354   - Bumped version to 0.2.4 due to changes to the PEP template &
1355     stylesheet.
1356   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1357   - Added ``TransformSpec`` class for new transform system.
1358   - Bumped version to 0.2.6 for API changes (renaming).
1359   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1360     convenience functions.
1361   - Added ``Component.component_type`` attribute.
1362   - Bumped version to 0.2.8 because of the internal parser switch from
1363     plain lists to the docutils.statemachine.StringList objects.
1364   - Bumped version to 0.2.9 because of the frontend.py API changes.
1365   - Bumped version to 0.2.10 due to changes to the project layout
1366     (third-party modules removed from the "docutils" package), and
1367     signature changes in ``io.Input``/``io.Output``.
1368   - Changed version to 0.3.0 for release.
1370 * docutils/core.py:
1372   - Made ``publish()`` a bit more convenient.
1373   - Generalized ``Publisher.set_io``.
1374   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1375     parameters; improved its docstring.
1376   - Added ``publish_file()`` and ``publish_string()``.
1377   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1378     out of ``.set_io``.
1379   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1380     "--dump-transforms" hidden options.
1381   - Added ``Publisher.apply_transforms()`` method.
1382   - Added ``Publisher.set_components()`` method; support for
1383     ``publish_*()`` conveninece functions.
1384   - Moved config file processing to docutils/frontend.py.
1385   - Added support for exit status ("exit_level" setting &
1386     ``enable_exit`` parameter for Publisher.publish() and convenience
1387     functions).
1389 * docutils/frontend.py:
1391   - Check for & exit on identical source & destination paths.
1392   - Fixed bug with absolute paths & "--config".
1393   - Set non-command-line defaults in ``OptionParser.__init__()``:
1394     ``_source`` & ``_destination``.
1395   - Distributed ``relative_path_settings`` to components; updated
1396     ``OptionParser.populate_from_components()`` to combine it all.
1397   - Require list of keys in ``make_paths_absolute`` (was implicit in
1398     global ``relative_path_settings``).
1399   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1400     "--dump-settings", and "--dump-transforms" hidden options.
1401   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1402     code, replaced with correct code.
1403   - Added validation functionality for config files.
1404   - Added "--error-encoding" option/setting, "_disable_config"
1405     internal setting.
1406   - Added encoding validation; updated "--input-encoding" and
1407     "--output-encoding"; added "--error-encoding-error-handler" and
1408     "--output-encoding-error-handler".
1409   - Moved config file processing from docutils/core.py.
1410   - Updated ``OptionParser.populate_from_components`` to handle new
1411     ``SettingsSpec.settings_defaults`` dict.
1412   - Added support for "-" => stdin/stdout.
1413   - Added "exit_level" setting ("--exit" option).
1415 * docutils/io.py:
1417   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1418   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1419   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1420   - ``FileOutput.write()`` now returns the encoded output string.
1421   - Try to get path/stream name automatically in ``FileInput`` &
1422     ``FileOutput``.
1423   - Added defaults for source & destination paths.
1424   - Allow for Unicode I/O with an explicit "unicode" encoding.
1425   - Added ``Output.encode()``.
1426   - Removed dependency on runtime settings; pass encoding directly.
1427   - Recognize Unicode strings in ``Input.decode()``.
1428   - Added support for output encoding error handlers.
1430 * docutils/nodes.py:
1432   - Added "Invisible" element category class.
1433   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1434     modification during a traversal.
1435   - Added element classes: ``line_block``, ``generated``, ``address``,
1436     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1437     ``superscript``, ``subscript``, ``inline``
1438   - Added support for lists of nodes to ``Element.insert()``.
1439   - Fixed parent linking in ``Element.replace()``.
1440   - Added new abstract superclass ``FixedTextElement``; adds
1441     "xml:space" attribute.
1442   - Added support for "line" attribute of ``system_message`` nodes.
1443   - Added support for the observer pattern from ``utils.Reporter``.
1444     Added ``parse_messages`` and ``transform_messages`` attributes to
1445     ``document``, removed ``messages``.  Added ``note_parse_message``
1446     and ``note_transform_message`` methods.
1447   - Added support for improved diagnostics:
1449     - Added "document", "source", and "line" internal attributes to
1450       ``Node``, set by ``Node.setup_child()``.
1451     - Converted variations on ``node.parent = self`` to
1452       ``self.setup_child(node)``.
1453     - Added ``document.current_source`` & ``.current_line``
1454       attributes, and ``.note_source`` observer method.
1455     - Changed "system_message" output to GNU-Tools format.
1457   - Added a "rawsource" attribute to the ``Text`` class, for text
1458     before backslash-escape resolution.
1459   - Support for new transform system.
1460   - Reworked ``pending`` element.
1461   - Fixed XML DOM bug (SF #660611).
1462   - Removed the ``interpeted`` element class and added
1463     ``title_reference``, ``abbreviation``, ``acronym``.
1464   - Made substitutions case-sensitive-but-forgiving; moved some code
1465     from the parser.
1466   - Fixed Unicode bug on element attributes (report: William Dode).
1468 * docutils/optik.py: Removed from project; replaced with
1469   extras/optparse.py and extras/textwrap.py.  These will be installed
1470   only if they're not already present in the Python installation.
1472 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1473   only if it's not already present in the Python installation.
1475 * docutils/statemachine.py:
1477   - Factored out ``State.add_initial_transitions()`` so it can be
1478     extended.
1479   - Converted whitespace-specific "blank" and "indent" transitions
1480     from special-case code to ordinary transitions: removed
1481     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1482     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1483     ``ws_initial_transitions`` attributes.
1484   - Removed ``State.match_transition()`` after merging it into
1485     ``.check_line()``.
1486   - Added ``StateCorrection`` exception.
1487   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1488     (moved ``TransitionCorrection`` support there too.)
1489   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1490     ``EOFError`` instead of ``IndexError``.
1491   - Added ``State.no_match`` method.
1492   - Added support for the Observer pattern, triggered by input line
1493     changes.
1494   - Added ``strip_top`` parameter to
1495     ``StateMachineWS.get_first_known_indented``.
1496   - Made ``context`` a parameter to ``StateMachine.run()``.
1497   - Added ``ViewList`` & ``StringList`` classes;
1498     ``extract_indented()`` becomes ``StringList.get_indented()``.
1499   - Added ``StateMachine.insert_input()``.
1500   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1501     thanks to) Fred Drake.
1503 * docutils/utils.py:
1505   - Added a ``source`` attribute to Reporter instances and
1506     ``system_message`` elements.
1507   - Added an observer pattern to ``utils.Reporter`` to keep track of
1508     system messages.
1509   - Fixed bugs in ``relative_path()``.
1510   - Added support for improved diagnostics.
1511   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1512   - Added support for encoding Reporter stderr output, and encoding
1513     error handlers.
1514   - Reporter keeps track of the highest level system message yet
1515     generated.
1517 * docutils/languages: Fixed bibliographic field language lookups.
1519 * docutils/languages/es.py: Added to project; Spanish mappings by
1520   Marcelo Huerta San Martin.
1522 * docutils/languages/fr.py: Added to project; French mappings by
1523   Stefane Fermigier.
1525 * docutils/languages/it.py: Added to project; Italian mappings by
1526   Nicola Larosa.
1528 * docutils/languages/sk.py: Added to project; Slovak mappings by
1529   Miroslav Vasko.
1531 * docutils/parser/__init__.py:
1533   - Added ``Parser.finish_parse()`` method.
1535 * docutils/parser/rst/__init__.py:
1537   - Added options: "--pep-references", "--rfc-references",
1538     "--tab-width", "--trim-footnote-reference-space".
1540 * docutils/parsers/rst/states.py:
1542   - Changed "title under/overline too short" system messages from INFO
1543     to WARNING, and fixed its insertion location.
1544   - Fixed enumerated list item parsing to allow paragraphs & section
1545     titles to begin with enumerators.
1546   - Converted system messages to use the new "line" attribute.
1547   - Fixed a substitution reference edge case.
1548   - Added support for "--pep-references" and "--rfc-references"
1549     options; reworked ``Inliner`` code to make customization easier.
1550   - Removed field argument parsing.
1551   - Added support for short section title over/underlines.
1552   - Fixed "simple reference name" regexp to ignore text like
1553     "object.__method__"; not an anonymous reference.
1554   - Added support for improved diagnostics.
1555   - Reworked directive API, based on Dethe Elza's contribution.  Added
1556     ``Body.parse_directive()``, ``.parse_directive_options()``,
1557     ``.parse_directive_arguments()`` methods.
1558   - Added ``ExtensionOptions`` class, to parse directive options
1559     without parsing field bodies.  Factored
1560     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1561     ``ExtensionOptions``.
1562   - Improved definition list term/classifier parsing.
1563   - Added warnings for unknown directives.
1564   - Renamed ``Stuff`` to ``Struct``.
1565   - Now flagged as errors: transitions at the beginning or end of
1566     sections, empty sections (except title), and empty documents.
1567   - Updated for ``statemachine.StringList``.
1568   - Enabled recognition of schemeless email addresses in targets.
1569   - Added support for embedded URIs in hyperlink references.
1570   - Added backslash-escapes to inline markup end-string suffix.
1571   - Added support for correct interpreted text processing.
1572   - Fixed nested title parsing (topic, sidebar directives).
1573   - Added special processing of backslash-escaped whitespace (idea
1574     from David Abrahams).
1575   - Made substitutions case-sensitive-but-forgiving; moved some code
1576     to ``docutils.nodes``.
1577   - Added support for block quote attributions.
1578   - Added a kludge to work-around a conflict between the bubble-up
1579     parser strategy and short titles (<= 3 char-long over- &
1580     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1581     titles" submitted by Jason Diamond.
1582   - Added explicit interpreted text roles for standard inline markup:
1583     "emphasis", "strong", "literal".
1584   - Implemented "superscript" and "subscript" interpreted text roles.
1585   - Added initial support for "abbreviation" and "acronym" roles;
1586     incomplete.
1587   - Added support for "--trim-footnote-reference-space" option.
1588   - Optional space before colons in directives & hyperlink targets.
1590 * docutils/parsers/rst/tableparser.py:
1592   - Fixed a bug that was producing unwanted empty rows in "simple"
1593     tables.
1594   - Detect bad column spans in "simple" tables.
1596 * docutils/parsers/rst/directives: Updated all directive functions to
1597   new API.
1599 * docutils/parsers/rst/directives/__init__.py:
1601   - Added ``flag()``, ``unchanged()``, ``path()``,
1602     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1603     directive option helper functions.
1604   - Added warnings for unknown directives.
1605   - Return ``None`` for missing directives.
1606   - Added ``register_directive()``, thanks to William Dode and Paul
1607     Moore.
1609 * docutils/parsers/rst/directives/admonitions.py:
1611   - Added "admonition" directive.
1613 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1614   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1615   "parsed-literal", "rubric", "epigraph", "highlights" and
1616   "pull-quote" directives.
1618 * docutils/parsers/rst/directives/images.py:
1620   - Added an "align" attribute to the "image" & "figure" directives
1621     (by Adam Chodorowski).
1622   - Added "class" option to "image", and "figclass" to "figure".
1624 * docutils/parsers/rst/directives/misc.py:
1626   - Added "include", "raw", and "replace" directives, courtesy of
1627     Dethe Elza.
1628   - Added "unicode" and "class" directives.
1630 * docutils/parsers/rst/directives/parts.py:
1632   - Added the "sectnum" directive; by Dmitry Jemerov.
1633   - Added "class" option to "contents" directive.
1635 * docutils/parsers/rst/directives/references.py: Added to project.
1636   Contains the "target-notes" directive.
1638 * docutils/parsers/rst/languages/__init__.py:
1640   - Return ``None`` from get_language() for missing language modules.
1642 * docutils/parsers/rst/languages/de.py: Added to project; German
1643   mappings by Engelbert Gruber.
1645 * docutils/parsers/rst/languages/en.py:
1647   - Added interpreted text roles mapping.
1649 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1650   mappings by Marcelo Huerta San Martin.
1652 * docutils/parsers/rst/languages/fr.py: Added to project; French
1653   mappings by William Dode.
1655 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1656   mappings by Nicola Larosa.
1658 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1659   mappings by Miroslav Vasko.
1661 * docutils/readers/__init__.py:
1663   - Added support for the observer pattern from ``utils.Reporter``, in
1664     ``Reader.parse`` and ``Reader.transform``.
1665   - Removed ``Reader.transform()`` method.
1666   - Added default parameter values to ``Reader.__init__()`` to make
1667     instantiation easier.
1668   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1670 * docutils/readers/pep.py:
1672   - Added the ``peps.TargetNotes`` transform to the Reader.
1673   - Removed PEP & RFC reference detection code; moved to
1674     parsers/rst/states.py as options (enabled here by default).
1675   - Added support for pre-acceptance PEPs (no PEP number yet).
1676   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1677     easy subclassing.
1679 * docutils/readers/python: Python Source Reader subpackage added to
1680   project, including preliminary versions of:
1682   - __init__.py
1683   - moduleparser.py: Parser for Python modules.
1685 * docutils/transforms/__init__.py:
1687   - Added ``Transformer`` class and completed transform reform.
1688   - Added unknown_reference_resolvers list for each transformer. This list holds
1689     the list of functions provided by each component of the transformer that
1690     help resolve references.
1692 * docutils/transforms/frontmatter.py:
1694   - Improved support for generic fields.
1695   - Fixed bibliographic field language lookups.
1697 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1698   transforms.
1700 * docutils/transforms/parts.py:
1702   - Moved the "id" attribute from TOC list items to the references
1703     (``Contents.build_contents()``).
1704   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1705   - Added "class" attribute support to ``Contents``.
1707 * docutils/transforms/peps.py:
1709   - Added ``mask_email()`` function, updating to pep2html.py's
1710     functionality.
1711   - Linked "Content-Type: text/x-rst" to PEP 12.
1712   - Added the ``TargetNotes`` PEP-specific transform.
1713   - Added ``TargetNotes.cleanup_callback``.
1714   - Added title check to ``Headers``.
1716 * docutils/transforms/references.py:
1718   - Added the ``TargetNotes`` generic transform.
1719   - Split ``Hyperlinks`` into multiple transforms.
1720   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1721   - Added check for circular indirect references.
1722   - Made substitutions case-sensitive-but-forgiving.
1724 * docutils/transforms/universal.py:
1726   - Added support for the "--expose-internal-attributes" option.
1727   - Removed ``Pending`` transform classes & data.
1729 * docutils/writers/__init__.py:
1731   - Removed ``Writer.transform()`` method.
1733 * docutils/writers/docutils-xml.py:
1735   - Added XML and doctype declarations.
1736   - Added "--no-doctype" and "--no-xml-declaration" options.
1738 * docutils/writers/html4css1.py:
1740   - "name" attributes only on these tags: a, applet, form, frame,
1741     iframe, img, map.
1742   - Added "name" attribute to <a> in section titles for Netscape 4
1743     support (bug report: Pearu Peterson).
1744   - Fixed targets (names) on footnote, citation, topic title,
1745     problematic, and system_message nodes (for Netscape 4).
1746   - Changed field names from "<td>" to "<th>".
1747   - Added "@" to "&#64;" encoding to thwart address harvesters.
1748   - Improved the vertical whitespace optimization; ignore "invisible"
1749     nodes (targets, comments, etc.).
1750   - Improved inline literals with ``<span class="pre">`` around chunks
1751     of text and ``&nbsp;`` for runs of spaces.
1752   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1753     ``self.docinfo`` segments.
1754   - Added support for "line_block", "address" elements.
1755   - Improved backlinks (footnotes & system_messages).
1756   - Improved system_message output.
1757   - Redefined "--stylesheet" as containing an invariant URL, used
1758     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1759     working directory.
1760   - Added "--footnote-references" option (superscript or brackets).
1761   - Added "--compact-lists" and "--no-compact-lists" options.
1762   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1763     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1764   - Improved field list rendering.
1765   - Added Docutils version to "generator" meta tag.
1766   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1767   - Improved layout of <pre> HTML source.
1768   - Fixed attribute typo on <colspec>.
1769   - Refined XML prologue.
1770   - Support for no stylesheet.
1771   - Removed "interpreted" element support.
1772   - Added support for "title_reference", "sidebar", "attribution",
1773     "rubric", and generic "admonition" elements.
1774   - Added "--attribution" option.
1775   - Added support for "inline", "subscript", "superscript" elements.
1776   - Added initial support for "abbreviation" and "acronym";
1777     incomplete.
1779 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1780   (from the sandbox).
1782   - Added french.
1783   - Double quotes in literal blocks (special treatment for de/ngerman).
1784   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1785   - Added  "--attribution" option.
1786   - Right align attributions.
1788 * docutils/writers/pep_html.py:
1790   - Parameterized output encoding in PEP template.
1791   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1792   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1793     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1794     working directory.
1795   - Added an override on the "--footnote-references" option.
1796   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1797   - Added Docutils version to "generator" meta tag.
1798   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1800 * docs/tools.txt:
1802   - Added a "silent" setting for ``buildhtml.py``.
1803   - Added a "Getting Help" section.
1804   - Rearranged the structure.
1805   - Kept up to date, with new settings, command-line options etc.
1806   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1807   - Converted settings table into a definition list.
1809 * docs/rst/quickstart.txt:
1811   - Added a table of contents.
1812   - Added feedback information.
1813   - Added mention of minimum section title underline lengths.
1814   - Removed the 4-character minimum for section title underlines.
1816 * docs/rst/quickref.html:
1818   - Added a "Getting Help" section.
1819   - Added a style to make section title backlinks more subtle.
1820   - Added mention of minimum section title underline lengths.
1821   - Removed the 4-character minimum for section title underlines.
1823 * extras: Directory added to project; contains third-party modules
1824   that Docutils depends on (optparse, textwrap, roman).  These are
1825   only installed if they're not already present.
1827 * licenses: Directory added to project; contains copies of license
1828   files for non-public-domain files.
1830 * spec/doctree.txt:
1832   - Changed the focus.  It's about DTD elements:  structural
1833     relationships, semantics, and external (public) attributes.  Not
1834     about the element class library.
1835   - Moved some implementation-specific stuff into ``docutils.nodes``
1836     docstrings.
1837   - Wrote descriptions of all common attributes and parameter
1838     entities.  Filled in introductory material.
1839   - Working through the element descriptions: 55 down, 37 to go.
1840   - Removed "Representation of Horizontal Rules" to
1841     spec/rst/alternatives.txt.
1843 * spec/docutils.dtd:
1845   - Added "generated" inline element.
1846   - Added "line_block" body element.
1847   - Added "auto" attribute to "title".
1848   - Changed content models of "literal_block" and "doctest_block" to
1849     ``%text.model``.
1850   - Added ``%number;`` attribute type parameter entity.
1851   - Changed ``%structural.elements;`` to ``%section.elements``.
1852   - Updated attribute types; made more specific.
1853   - Added "address" bibliographic element.
1854   - Added "line" attribute to ``system_message`` element.
1855   - Removed "field_argument" element; "field_name" may contain
1856     multiple words and whitespace.
1857   - Changed public identifier to docutils.sf.net.
1858   - Removed "interpreted" element; added "title_reference",
1859     "abbreviation", "acronym".
1860   - Removed "refuri" attribute from "footnote_reference" and
1861     "citation_reference".
1862   - Added "sidebar", "rubric", "attribution", "admonition",
1863     "superscript", "subscript", and "inline" elements.
1865 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1867 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1869 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1871 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1872   Dallas Mahrt.
1874 * spec/transforms.txt: Added to project.
1876 * spec/howto: Added subdirectory, for developer how-to docs.
1878 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1879   Elza, edited & extended by David Goodger.
1881 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1882   project.
1884 * spec/rst/alternatives.txt:
1886   - Added "Doctree Representation of Transitions" from
1887     spec/doctree.txt.
1888   - Updated "Inline External Targets" & closed the debate.
1889   - Added ideas for interpreted text syntax extensions.
1890   - Added "Nested Inline Markup" section.
1892 * spec/rst/directives.txt:
1894   - Added directives: "topic", "sectnum", "target-notes",
1895     "line-block", "parsed-literal", "include", "replace", "sidebar",
1896     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1897     "class".
1898   - Formalized descriptions of directive details.
1899   - Added an "align" attribute to the "image" & "figure" directives
1900     (by Adam Chodorowski).
1901   - Added "class" options to "topic", "sidebar", "line-block",
1902     "parsed-literal", "contents", and "image"; and "figclass" to
1903     "figure".
1905 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1906   interpreted text roles.
1908 * spec/rst/introduction.txt:
1910   - Added pointers to material for new users.
1912 * spec/rst/reStructuredText.txt:
1914   - Disambiguated comments (just add a newline after the "::").
1915   - Updated enumerated list description; added a discussion of the
1916     second-line validity checking.
1917   - Updated directive description.
1918   - Added a note redirecting newbies to the user docs.
1919   - Expanded description of inline markup start-strings in non-markup
1920     contexts.
1921   - Removed field arguments and made field lists a generic construct.
1922   - Removed the 4-character minimum for section title underlines.
1923   - Clarified term/classifier delimiter & inline markup ambiguity
1924     (definition lists).
1925   - Added "Embedded URIs".
1926   - Updated "Interpreted Text" section.
1927   - Added "Character-Level Inline Markup" section.
1929 * test: Continually adding & updating tests.
1931   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1932   - Moved test/test_pep/ to test/test_readers/test_pep/.
1933   - Added test/test_readers/test_python/.
1934   - Added test/test_writers/ (Engelbert Gruber).
1936 * tools:
1938   - Made the ``locale.setlocale()`` calls in front ends
1939     fault-tolerant.
1941 * tools/buildhtml.py:
1943   - Added "--silent" option.
1944   - Fixed bug with absolute paths & "--config".
1945   - Updated for new I/O classes.
1946   - Added some exception handling.
1947   - Separated publishers' setting defaults; prevents interference.
1948   - Updated for new ``publish_file()`` convenience function.
1950 * tools/pep-html-template:
1952   - Allow for "--embed-stylesheet".
1953   - Added Docutils version to "generator" meta tag.
1954   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1955   - Conform to XHTML spec.
1957 * tools/pep2html.py:
1959   - Made ``argv`` a parameter to ``main()``.
1960   - Added support for "Content-Type:" header & arbitrary PEP formats.
1961   - Linked "Content-Type: text/plain" to PEP 9.
1962   - Files skipped (due to an error) are not pushed onto the server.
1963   - Updated for new I/O classes.
1964   - Added ``check_requirements()`` & ``pep_type_error()``.
1965   - Added some exception handling.
1966   - Updated for new ``publish_string()`` convenience function.
1967   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1969 * tools/quicktest.py:
1971   - Added "-V"/"--version" option.
1973 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1975 * tools/unicode2rstsubs.py: Added to project.  Produces character
1976   entity files (reSructuredText substitutions) from the MathML master
1977   unicode.xml file.
1979 * tools/editors: Support code for editors, added to project.  Contains
1980   ``emacs/restructuredtext.el``.
1982 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1984   - Added style for chunks of inline literals.
1985   - Removed margin for first child of table cells.
1986   - Right-aligned field list names.
1987   - Support for auto-numbered section titles in TOCs.
1988   - Increased the size of inline literals (<tt>) in titles.
1989   - Restored the light gray background for inline literals.
1990   - Added support for "line_block" elements.
1991   - Added style for "address" elements.
1992   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1993   - Improved field list rendering.
1994   - Vertical whitespace improvements.
1995   - Removed "a.target" style.
1997 * tools/stylesheets/pep.css:
1999   - Fixed nested section margins.
2000   - Other changes parallel those of ``../default.css``.
2003 Release 0.2 (2002-07-31)
2004 ========================
2006 General:
2008 - The word "component" was being used ambiguously.  From now on,
2009   "component" will be used to mean "Docutils component", as in Reader,
2010   Writer, Parser, or Transform.  Portions of documents (Table of
2011   Contents, sections, etc.)  will be called "document parts".
2012 - Did a grand renaming: a lot of ``verylongnames`` became
2013   ``very_long_names``.
2014 - Cleaned up imports: no more relative package imports or
2015   comma-separated lists of top-level modules.
2016 - Added support for an option values object which carries default
2017   settings and overrides (from command-line options and library use).
2018 - Added internal Unicode support, and support for both input and
2019   output encodings.
2020 - Added support for the ``docutils.io.IO`` class & subclasses.
2022 Specific:
2024 * docutils/__init__.py:
2026   - Added ``ApplicationError`` and ``DataError``, for use throughout
2027     the package.
2028   - Added ``Component`` base class for Docutils components; implements
2029     the ``supports`` method.
2030   - Added ``__version__`` (thus, ``docutils.__version__``).
2032 * docutils/core.py:
2034   - Removed many keyword parameters to ``Publisher.__init__()`` and
2035     ``publish()``; bundled into an option values object.  Added
2036     "argv", "usage", "description", and "option_spec" parameters for
2037     command-line support.
2038   - Added ``Publisher.process_command_line()`` and ``.set_options()``
2039     methods.
2040   - Reworked I/O model for ``docutils.io`` wrappers.
2041   - Updated ``Publisher.set_options()``; now returns option values
2042     object.
2043   - Added support for configuration files (/etc/docutils.conf,
2044     ./docutils.conf, ~/.docutils).
2045   - Added ``Publisher.setup_option_parser()``.
2046   - Added default usage message and description.
2048 * docutils/frontend.py: Added to project; support for front-end
2049   (command-line) scripts.  Option specifications may be augmented by
2050   components.  Requires Optik (http://optik.sf.net/) for option
2051   processing (installed locally as docutils/optik.py).
2053 * docutils/io.py: Added to project; uniform API for a variety of input
2054   output mechanisms.
2056 * docutils/nodes.py:
2058   - Added ``TreeCopyVisitor`` class.
2059   - Added a ``copy`` method to ``Node`` and subclasses.
2060   - Added a ``SkipDeparture`` exception for visitors.
2061   - Renamed ``TreePruningException`` from ``VisitorException``.
2062   - Added docstrings to ``TreePruningException``, subclasses, and
2063     ``Nodes.walk()``.
2064   - Improved docstrings.
2065   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2066   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2067     imports.
2068   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2069     ``PreDecorative`` mixin.
2070   - Reworked the name/id bookkeeping; to ``document``, removed
2071     ``explicit_targets`` and ``implicit_targets`` attributes, added
2072     ``nametypes`` attribute and ``set_name_id_map`` method.
2073   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2074     traversals.
2075   - Added ``document.has_name()`` method.
2076   - Fixed DOM generation for list-attributes.
2077   - Added category class ``Labeled`` (used by footnotes & citations).
2078   - Added ``Element.set_class()`` method (sets "class" attribute).
2080 * docutils/optik.py: Added to project.  Combined from the Optik
2081   package, with added option groups and other modifications.  The use
2082   of this module is probably only temporary.
2084 * docutils/statemachine.py:
2086   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2087   - Added underscores to improve many awkward names.
2088   - In ``string2lines()``, changed whitespace normalizing translation
2089     table to regexp; restores Python 2.0 compatibility with Unicode.
2091 * docutils/urischemes.py:
2093   - Filled in some descriptions.
2094   - Added "shttp" scheme.
2096 * docutils/utils.py:
2098   - Added ``clean_rcs_keywords`` function (moved from
2099     docutils/transforms/frontmatter.py
2100     ``DocInfo.filter_rcs_keywords``).
2101   - Added underscores to improve many awkward names.
2102   - Changed names of Reporter's thresholds:
2103     warning_level -> report_level; error_level -> halt_level.
2104   - Moved ``utils.id()`` to ``nodes.make_id()``.
2105   - Added ``relative_path(source, target)``.
2107 * docutils/languages/de.py: German mappings; added to project.  Thanks
2108   to Gunnar Schwant for the translations.
2110 * docutils/languages/en.py: Added "Dedication" bibliographic field
2111   mappings.
2113 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2114   Chodorowski.
2116 * docutils/parsers/rst/states.py:
2118   - Added underscores to improve many awkward names.
2119   - Added RFC-2822 header support.
2120   - Extracted the inline parsing code from ``RSTState`` to a separate
2121     class, ``Inliner``, which will allow easy subclassing.
2122   - Made local bindings for ``memo`` container & often-used contents
2123     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2124   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2125   - Added ``MarkupMismatch`` exception; for late corrections.
2126   - Added ``-/:`` characters to inline markup's start string prefix,
2127     ``/`` to end string suffix.
2128   - Fixed a footnote bug.
2129   - Fixed a bug with literal blocks.
2130   - Applied patch from Simon Budig: simplified regexps with symbolic
2131     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2132   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2133   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2134   - Allowed non-ASCII in "simple names" (directive names, field names,
2135     references, etc.).
2136   - Converted ``Inliner.patterns.initial`` to be dynamically built
2137     from parts with ``build_regexp()`` function.
2138   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2139   - Updated docstrings.
2140   - Changed "table" to "grid_table"; added "simple_table" support.
2142 * docutils/parsers/rst/tableparser.py:
2144   - Changed ``TableParser`` to ``GridTableParser``.
2145   - Added ``SimpleTableParser``.
2146   - Refactored naming.
2148 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2149   a fallback language for directive names.
2151 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2152   directive to use a ``pending`` element, used only by HTML writers.
2154 * docutils/parsers/rst/directives/parts.py: Renamed from
2155   components.py.
2157   - Added "backlinks" attribute to "contents" directive.
2159 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2160   project by Adam Chodorowski.
2162 * docutils/readers/__init__.py: Gave Readers more control over
2163   choosing and instantiating Parsers.
2165 * docutils/readers/pep.py: Added to project; for PEP processing.
2167 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2168   requires a ``component`` parameter.
2170 * docutils/transforms/components.py: Added to project; transforms
2171   related to Docutils components.
2173 * docutils/transforms/frontmatter.py:
2175   - In ``DocInfo.extract_authors``, check for a single "author" in an
2176     "authors" group, and convert it to a single "author" element.
2177   - Added support for "Dedication" and generic bibliographic fields.
2179 * docutils/transforms/peps.py: Added to project; PEP-specific.
2181 * docutils/transforms/parts.py: Renamed from old components.py.
2183   - Added filter for `Contents`, to use alt-text for inline images,
2184     and to remove inline markup that doesn't make sense in the ToC.
2185   - Added "name" attribute to TOC topic depending on its title.
2186   - Added support for optional TOC backlinks.
2188 * docutils/transforms/references.py: Fixed indirect target resolution
2189   in ``Hyperlinks`` transform.
2191 * docutils/transforms/universal.py:
2193   - Changed ``Messages`` transform to properly filter out system
2194     messages below the warning threshold.
2195   - Added ``Decorations`` transform (support for ``--generator``,
2196     ``--date``, ``--time``, ``--source-link`` options).
2198 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2199   Engelbert Gruber's PDF writer.
2201 * docutils/writers/html4css1.py:
2203   - Made XHTML-compatible (switched to lowercase element & attribute
2204     names; empty tag format).
2205   - Escape double-dashes in comment text.
2206   - Improved boilerplate & modularity of output.
2207   - Exposed modular output in Writer class.
2208   - Added a "generator" meta tag to <head>.
2209   - Added support for the ``--stylesheet`` option.
2210   - Added support for ``decoration``, ``header``, and ``footer``
2211     elements.
2212   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2213     translation table to regexp; restores Python 2.0 compatibility
2214     with Unicode.
2215   - Added the translator class as instance variable to the Writer, to
2216     make it easily subclassable.
2217   - Improved option list spacing (thanks to Richard Jones).
2218   - Modified field list output.
2219   - Added backlinks to footnotes & citations.
2220   - Added percentage widths to "<col>" tags (from colspec).
2221   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2222     "<span>" changed to "<var>".
2223   - Inline literals: "<code>" changed to "<tt>".
2224   - Many changes to optimize vertical space: compact simple lists etc.
2225   - Add a command-line options & directive attributes to control TOC
2226     and footnote/citation backlinks.
2227   - Added support for optional footnote/citation backlinks.
2228   - Added support for generic bibliographic fields.
2229   - Identify backrefs.
2230   - Relative URLs for stylesheet links.
2232 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2233   PEPs (subclass of ``html4css1.Writer``).
2235 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2237 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2238   of the Docutils internal doctree in XML.
2240 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2242 * spec/doctree.txt:
2244   - Changed the title to "The Docutils Document Tree".
2245   - Added "Hyperlink Bookkeeping" section.
2247 * spec/docutils.dtd:
2249   - Added ``decoration``, ``header``, and ``footer`` elements.
2250   - Brought ``interpreted`` element in line with the parser: changed
2251     attribute "type" to "role", added "position".
2252   - Added support for generic bibliographic fields.
2254 * spec/notes.txt: Continual updates.  Added "Project Policies".
2256 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2257   section.
2259 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2261 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2262   mailing list discussions.
2264 * spec/pep-0287.txt:
2266   - Renamed to "reStructuredText Docstring Format".
2267   - Minor edits.
2268   - Reworked Q&A as an enumerated list.
2269   - Converted to reStructuredText format.
2271 * spec/pysource.dtd:
2273   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2275 * spec/pysource.txt: Removed from project.  Moved much of its contents
2276   to pep-0258.txt.
2278 * spec/rst/alternatives.txt:
2280   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2281   - Added "Inline External Targets" section.
2283 * spec/rst/directives.txt:
2285   - Added "backlinks" attribute to "contents" directive.
2287 * spec/rst/problems.txt:
2289   - Updated the Enumerated List Markup discussion.
2290   - Added new alternative table markup syntaxes.
2292 * spec/rst/reStructuredText.txt:
2294   - Clarified field list usage.
2295   - Updated enumerated list description.
2296   - Clarified purpose of directives.
2297   - Added ``-/:`` characters to inline markup's start string prefix,
2298     ``/`` to end string suffix.
2299   - Updated "Authors" bibliographic field behavior.
2300   - Changed "inline hyperlink targets" to "inline internal targets".
2301   - Added "simple table" syntax to supplement the existing but
2302     newly-renamed "grid tables".
2303   - Added cautions for anonymous hyperlink use.
2304   - Added "Dedication" and generic bibliographic fields.
2306 * test: Made test modules standalone (subdirectories became packages).
2308 * test/DocutilsTestSupport.py:
2310   - Added support for PEP extensions to reStructuredText.
2311   - Added support for simple tables.
2312   - Refactored naming.
2314 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2316   - Now supports true packages containing test modules
2317     (``__init__.py`` files required); fixes duplicate module name bug.
2319 * test/test_pep/: Subpackage added to project; PEP testing.
2321 * test/test_rst/test_SimpleTableParser.py: Added to project.
2323 * tools:
2325   - Updated html.py and publish.py front-end tools to use the new
2326     command-line processing facilities of ``docutils.frontend``
2327     (exposed in ``docutils.core.Publisher``), reducing each to just a
2328     few lines of code.
2329   - Added ``locale.setlocale()`` calls to front-end tools.
2331 * tools/buildhtml.py: Added to project; batch-generates .html from all
2332   the .txt files in directories and subdirectories.
2334 * tools/default.css:
2336   - Added support for ``header`` and ``footer`` elements.
2337   - Added styles for "Dedication" topics (biblio fields).
2339 * tools/docutils.conf: A configuration file; added to project.
2341 * tools/docutils-xml.py: Added to project.
2343 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2345 * tools/pep-html-template: Added to project.
2347 * tools/pep2html.py: Added to project from Python (nondist/peps).
2348   Added support for Docutils (reStructuredText PEPs).
2350 * tools/quicktest.py:
2352   - Added the ``--attributes`` option, hacked a bit.
2353   - Added a second command-line argument (output file); cleaned up.
2355 * tools/stylesheets/: Subdirectory added to project.
2357 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2360 Release 0.1 (2002-04-20)
2361 ========================
2363 This is the first release of Docutils, merged from the now inactive
2364 reStructuredText__ and `Docstring Processing System`__ projects.  For
2365 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2366 `DPS HISTORY`__ files.
2368 __ http://structuredtext.sourceforge.net/
2369 __ http://docstring.sourceforge.net/
2370 __ http://structuredtext.sourceforge.net/HISTORY.html
2371 __ http://docstring.sourceforge.net/HISTORY.html
2373 General changes: renamed 'dps' package to 'docutils'; renamed
2374 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2375 the test suites (reStructuredText's test/test_states renamed to
2376 test/test_rst); and all modifications required to make it all work.
2378 * docutils/parsers/rst/states.py:
2380   - Improved diagnostic system messages for missing blank lines.
2381   - Fixed substitution_reference bug.
2385    Local Variables:
2386    mode: indented-text
2387    indent-tabs-mode: nil
2388    sentence-end-double-space: t
2389    fill-column: 70
2390    End: