Fix reST samples for raw directive.
[docutils.git] / HISTORY.txt
blob3d17e2a62c05e3f39e2f9dcb62dd462a05407c36
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.4
18 =================
20 * docutils/frontend.py:
22   - Configuration files are now assumed and required to be
23     UTF-8-encoded.
25 * docutils/io.py:
27   - Added code to determine the input encoding from data: encoding
28     declarations or the presence of byte order marks (UTF-8 & UTF-16).
29   - Added support for IronPython 1.0.
31 * docutils/nodes.py:
33   - Added ``document.__getstate__`` method, for pickling.
35 * docutils/parsers/rst/states.py:
37   - Unquoted targets beginning with an underscore (``.. __target:
38     URI``) are no longer accepted.
39   - Added support for multiple attributions in a physical block quote
40     (indented text block), dividing it into multiple logical block
41     quotes.
42   - Added support for unicode bullets in bullet lists: "•", "‣", and
43     "⁃".
44   - Added support for new object-oriented directive interface,
45     retaining compatibility to the old functional interface.
46   - Added support for throwing ``DirectiveError``'s from within
47     directive code.
49 * docutils/parsers/rst/__init__.py:
51   - Added ``Directive`` base class.
52   - Added ``DirectiveError`` base class.
54 * docutils/parsers/directives/:
56   - Refactored all reStructuredText directives to use the new
57     object-oriented directive interface.  Errors are now (mostly)
58     thrown using the new ``DirectiveError`` class.
60 * docutils/transforms/writer_aux/:
62   - Added ``Admonitions`` transform to transform specific admonitions
63     (like ``note``, ``warning``, etc.) into generic admonitions with a
64     localized title.
66 * docutils/writers/html4css1/__init__.py:
68   - Moved template functionality from the PEP/HTML writer here.
69   - Expanded the fragments available in the ``parts`` attribute.
71 * docutils/writers/html4css1/template.txt: Added to project.
73 * docutils/writers/pep_html/:
75   - Moved template functionality to the HTML writer.
77 * docutils/writers/s5_html/__init__.py:
79   - Added ``view_mode`` & ``hidden_controls`` settings
80     (``--view-mode`` & ``--hidden-controls/--visible-controls``
81     options).
83 * docutils/writers/latex2e/__init__.py:
85   - Recognize table class: borderless, nolines, booktabs, standard.
86   - Fix: Renaming contents section does not work with latex writer; SF
87     bug #1487405.
88   - Applied patch for custom roles with classes from Edward Loper.
89   - Fixed bug that caused crashes with more than 256 lists.
91 * docutils/writers/pep_html/__init__.py:
93   - Changed to support new python.org website structure and
94     pep2pyramid.py.
96 * tools/editors/emacs/rst.el:
98   - Changed license to "GPL".
99   - Added ``rst-straighten-decorations`` function.
100   - The ``compile`` module is now always loaded.
101   - Added ``rst-toggle-line-block`` function.
102   - Headings consisting only of non-ASCII characters are now
103     recognized by ``rst-toc`` and ``rst-adjust``.
104   - Added font-lock support for multi-line comments where the first
105     comment line is empty.
106   - Added ``(require 'font-lock)``.
108 * setup.py:
110   - Provide descriptive error message if distutils is missing.
113 Release 0.4 (2006-01-09)
114 ========================
116 * General:
118   - Updated the project policies for trunk/branch development &
119     version numbering.
121 * docutils/__init__.py:
123   - Added ``__version_details__`` attribute to describe code source
124     (repository/snapshot/release).
125   - Replaced ``default_transforms`` attribute of TransformSpec with
126     ``get_transforms()`` method.
128 * docutils/core.py:
130   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
131     functions, for document tree extraction and reprocessing.
133 * docutils/io.py:
135   - Added ``DocTreeInput`` class, for reprocessing existing documents.
136   - Added support for non-Unicode (e.g. binary) writer output.
138 * docutils/nodes.py:
140   - Re-introduced ``Targetable.indirect_reference_name``, for
141     MoinMoin/reST compatibility (removed in r3124/r3129).
142   - Added ``serial_escape`` function; escapes string values that are
143     elements of a list, for serialization.  Modified Docutils-XML
144     writing (``Element._dom_node``) and pseudo-XML writing
145     (``Element.starttag``) to use ``serial_escape``.
146   - Added ``Node.deepcopy()`` method.
147   - Removed the internal lists ``document.substitution_refs``,
148     ``document.anonymous_refs``, and ``document.anonymous_targets``.
149   - Added a "container" element.
150   - Fixed bug where values of list-valued attributes of elements
151     originating from custom interpreted text roles (i.e., with custom
152     classes) were being shared between element instances.  Reported by
153     Shmuel Zeigerman.
155 * docutils/statemachine.py:
157   - Added trailing whitespace stripping to ``string2lines()``.
158   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
159     Asian double-width character support.
161 * docutils/utils.py:
163   - Added ``east_asian_column_width()`` for double-width character
164     support.
166 * docutils/languages/ja.py: Added to project: Japanese mappings by
167   Hisashi Morita.
169 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
170   mappings by Panjunyong.
172 * docutils/parsers/null.py: Added to project; a do-nothing parser.
174 * docutils/parsers/rst/__init__.py:
176   - Added validator to tab_width setting, with test.  Closes SF bug
177     #1212515, report from Wu Wei.
179 * docutils/parsers/rst/states.py:
181   - Fixed bug with escaped colons indicating a literal block.
182   - Fixed bug with enumerated lists (SF#1254145).
183   - Backslash-escaped colons inside of field names are now allowed.
184   - Targets (implicit and explicit), anonymous hyperlink references
185     and auto-numbered footnote references inside of substitution
186     definitions are now disallowed.
187   - Fixed bug: list items with blank first lines.
188   - Fixed bug: block quote attributions with indented second lines.
189   - Added East Asian double-width character support (Python 2.4 only).
191 * docutils/parsers/rst/tableparser.py:
193   - Added East Asian double-width character support (Python 2.4 only).
195 * docutils/parsers/rst/directives/body.py:
197   - Added the "container" directive.
199 * docutils/parsers/rst/directives/misc.py:
201   - Added the "default-role", "title", and "date" directives.
202   - Added standard data file syntax to the "include" directive.
203   - Added support for "class" directive content.
205 * docutils/parsers/rst/directives/images.py:
207   - Added ``indirect_reference_name`` support for images with a target
208     option.
209   - Added support for image width and height units.
210   - Fixed bug with image "target" options.
212 * docutils/parsers/rst/directives/references.py:
214   - Added "class" attribute to "target-notes" directive, for
215     footnote_reference classes.
217 * docutils/parsers/rst/include/: Directory added to project; contains
218   standard data files for the "include" directive.  Initial contents:
219   character entity substitution definition sets, and a set of
220   definitions for S5/HTML presentations.
222 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
223   mappings by David Goodger.
224   
225 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
226   Simplified Chinese mappings by Panjunyong.
228 * docutils/readers/__init__.py:
230   - Added universal.Decorations and universal.ExposeInternals
231     transforms as default transforms for all readers.
232   - Added ``ReReader`` base class for readers that reread an existing
233     document tree.
235 * docutils/readers/doctree.py: Added to project; a reader for existing
236   document trees.
238 * docutils/transforms/frontmatter.py:
240   - Fixed the DocInfo transform to handle SVN-style expansion of the
241     "Date" keyword.
242   - In ``DocInfo.extract_authors``, treat the contents of "authors"
243     fields uniformly.
245 * docutils/transforms/misc.py:
247   - Added misc.Transitions transform, extracted from
248     universal.FinalChecks.
250 * docutils/transforms/references.py:
252   - Added references.DanglingReferences transform, extracted from
253     universal.FinalChecks.
254   - Fixed bug with doubly-indirect substitutions.
255   - Added footnote_reference classes attribute to "TargetNotes".
256   - Fixed bug with circular substitution definitions that put Docutils
257     into an infinite loop.
259 * docutils/transforms/universal.py:
261   - Added universal.ExposeInternals transform, extracted from
262     universal.FinalChecks.
263   - Removed universal.FinalChecks transform (logic has been moved to
264     several new transforms).
265   - Fixed bug with the "expose_internals" setting and Text nodes
266     (exposed by the "rawsource" internal attribute).
267   - Added the universal.StripComments transform, implementation of the
268     "strip_comments" setting.
270 * docutils/transforms/writer_aux.py: Added to project; auxiliary
271   transforms for writers.
273   - Added ``Compound`` transform, which flattens compound paragraphs.
275 * docutils/writers/: Several writer modules (html4css1.py) were
276   converted into packages.  Support modules and data files have been
277   moved into the packages.  The stylesheets for the HTML writers are
278   now installed along with the code, the code knows where to find
279   them, and the default is to use them (actually, to embed them).
280   Some adjustments to configuration files may be necessary.  The
281   easiest way to obtain the new default behavior is to remove all
282   settings whose name includes "stylesheet".
284 * docutils/writers/__init__.py:
286   - Added universal.Messages and universal.FilterMessages transforms
287     as default transforms for all writers.
288   - Added ``UnfilteredWriter`` base class for writers that pass the
289     document tree on unchanged.
291 * docutils/writers/docutils_xml.py:
293   - Made ``xmlcharrefreplace`` the default output encoding error
294     handler.
296 * docutils/writers/html4css1/: 
298   - Added support for image width and height units.
299   - Made ``xmlcharrefreplace`` the default output encoding error
300     handler.
301   - Made ``--embed-stylesheet`` the default rather than
302     ``--link-stylesheet``.
303   - Moved "id" attribute from container (section etc.) to title's <a>
304     tag, to be on the same tag as "name".
305     (!!! To be reverted in Docutils 0.5.)
306   - Added vertical space between fields of field lists.
307   - Added ``--compact-field-lists`` option to remove vertical space in
308     simple field lists.
309   - Made cloaking of email addresses with ``--cloak-email-addresses``
310     less obtrusive.
311   - Fixed support for centered images.
312   - Added support for class="compact" & class="open" lists.
314 * docutils/writers/latex2e/:
316   - Underscores in citekeys are no longer escaped.
318 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
319   mapping of Unicode characters to LaTeX equivalents.
321 * docutils/writers/s5_html/: Package added to project; writer for
322   S5/HTML slide shows.
324 * docs/dev/distributing.txt: Added to project; guide for distributors
325   (package maintainers).
327 * docs/dev/hacking.txt: Added to project; guide for developers.
329 * docs/ref/doctree.txt:
331   - Updated for plural attributes "classes", "ids", "names",
332     "dupnames".
333   - Added the "container" element.
335 * docs/ref/docutils.dtd:
337   - Updated for plural attributes "classes", "ids", "names",
338     "dupnames".
340 * docs/user/emacs.txt: Added to project; a document about Emacs
341   support for reStructuredText and Docutils.
343 * docs/user/links.txt: Added to project; lists of Docutils-related
344   links.
346 * docs/user/mailing-lists.txt: Added to project; information about
347   Docutils-related mailing lists and how to access them.
349 * docs/user/slide-shows.txt: Added to project; example of and docs for
350   the S5/HTML writer (``rst2s5.py`` front end).
352 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
353   Files", added to project.
355 * test/coverage.sh: Added to project; test coverage script.
357 * test/DocutilsTestSupport.py:
359   - Added support for specifying runtime settings at the suite level.
361 * test/test_functional.py:
363   - Added the ``clear_output_directory`` function.
364   - Added support for ``_test_more`` functions in functional test
365     config files.
367 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
369 * tools/rstpep2html.py: Renamed from pep.py.
371 * tools/dev/create_unimap.py: Added to project; script to create the
372   docutils/writers/unimap_latex.py mapping file.
374 * tools/dev/profile_docutils.py: Added to project; profiler script.
376 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
378 * tools/editors/emacs/restructuredtext.el,
379   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
380   Removed from project; the functionality is now contained in rst.el.
382 * tools/editors/emacs/rst.el: Added to project.  Added many features
383   and fixed many bugs.  See docs/user/emacs.txt for details.
385 * tools/stylesheets: Removed from project.  Stylesheets have been
386   renamed and moved into writer packages.
389 Release 0.3.9 (2005-05-26)
390 ==========================
392 * General:
394   - Eliminated and replaced all uses of the old string attributes
395     ``id``, ``name``, ``dupname`` and ``class`` with references to the
396     new list attributes ``ids``, ``names``, ``dupnames`` and
397     ``classes`` throughout the whole source tree.
399 * docutils/core.py:
401   - Enabled ``--dump-*`` options when ``--traceback`` specified,
402     allowing for easier debugging.
403   - In ``Publisher.publish()``, expanded the generic top-level
404     exception catching.
406 * docutils/examples.py:
408   - Added ``internals`` function for exploration.
410 * docutils/io.py:
412   - Fixed ``Input.decode`` method to apply heuristics only if no
413     encoding is explicitly given, and to provide better reporting of
414     decoding errors.
415   - The ``Input.decode`` method now removes byte order marks (BOMs)
416     from input streams.
418 * docutils/nodes.py:
420   - ``image`` element class changed to subclass of Element, not
421     TextElement (it's an empty element, and cannot contain text).
422   - Added ``attr_defaults`` dictionary for default attribute values.
423   - Added empty list as default value for the following attributes:
424     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
425   - Added ``document.decoration`` attribute,
426     ``document.get_decoration`` method, and ``decoration.get_header``
427     & ``.get_footer`` methods.
428   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
429     methods.
431 * docutils/utils.py:
433   - Removed ``docutils.utils.Reporter.categories``,
434     ``docutils.utils.ConditionSet``, and all references to them, to
435     simplify error reporting.
437 * docutils/languages/nl.py: Added to project; Dutch mappings by
438   Martijn Pieters.
440 * docutils/parsers/rst/__init__.py:
442   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
444 * docutils/parsers/rst/states.py:
446   - Added check for escaped at-mark to prevent email address recognition.
447   - Fixed option lists to allow spaces inside ``<angle-bracketed option
448     arguments>``.
449   - Allowed whitespace in paths and URLs.
450   - Added auto-enumerated list items.
451   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
452     followed by text.
453   - Added support for table stub columns.
455 * docutils/parsers/rst/directives/__init__.py:
457   - Allowed whitespace in paths (``path`` function).
458   - Added ``uri`` directive option conversion function.
460 * docutils/parsers/rst/directives/body.py:
462   - Fixed illegal context bug with "topic" directive (allowed within
463     sidebars; not within body elements).
465 * docutils/parsers/rst/directives/images.py:
467   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
468   - Added support for the ``file_insertion_enabled`` setting in the
469     "figure" directive (disables "figwidth" option).
470   - "image" directive: added checks for valid values of "align" option,
471     depending on context.  "figure" directive: added specialized
472     "align" option and attribute on "figure" element.
473   - Made ":figwidth: image" option of "figure" directive work again.
474   - Fixed bug with reference names containing uppercase letters
475     (e.g. ``Name_``) in "target" option of "image" directive.
477 * docutils/parsers/rst/directives/misc.py:
479   - Fixed "include" and "raw" directives to catch text decoding
480     errors.
481   - Allowed whitespace in "include" & "raw" directive paths.
482   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
483     settings in "include" & "raw" directives.
485 * docutils/parsers/rst/directives/parts.py:
487   - Added "header" & "footer" directives.
488   - Fixed illegal context bug with "contents" directive (topics
489     allowed within sidebars; not within body elements).
491 * docutils/parsers/rst/directives/tables.py:
493   - Added "list-table" directive.
494   - Caught empty CSV table bug.
495   - Added support for the ``file_insertion_enabled`` setting in the
496     "csv-table" directive.
497   - Added ``stub-columns`` option to "csv-table" and "list-table"
498     directives.
500 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
501   mappings by Martijn Pieters.
503 * docutils/readers/standalone.py:
505   - Added ``--section-subtitles`` and ``--no-section-subtitles``
506     options to activate or deactivate the SectSubTitle transform.
508 * docutils/transforms/frontmatter.py:
510   - Added SectSubTitle transform to promote titles of lone
511     subsections to subtitles.
513 * docutils/transforms/references.py:
515   - Fixed mislocated internal targets bug, by propagating internal
516     targets to the next node, making use of the newly added support
517     for multiple names and IDs.
518   - Fixed duplicate footnote label bug.
519   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
520     transform.
522 * docutils/writers/html4css1.py:
524   - Fixed unencoded stylesheet reference bug (characters like "&" in
525     stylesheet references).
526   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
527     tags).
528   - Added support for multiple IDs per node by creating empty ``span``
529     tags.
530   - Added the ``field_name_limit`` & ``option_limit`` settings &
531     support.
532   - Added support for table stub columns.
533   - Added support for the ``align`` attribute on ``figure`` elements.
534   - Added the ``cloak_email_addresses`` setting & support.
535   - Added ``html_prolog``, ``html_head``, ``html_body``,
536     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
537     ``docutils.core.publish_parts``.
538   - Added support for section subtitles.
540 * docutils/writers/latex2e.py:
542   - Fixed tables starting with more than one multirow cell.
543   - Improved --use-latex-docinfo so that organization/contact/address
544     fields are lumped with the last author field and appear on the
545     titlepage.
546   - Made sure the titlepage is always shown with --use-latex-docinfo,
547     even if the document has no title.
548   - Made sure that latex doesn't fill in today's date if no date field
549     was given.
550   - Added support for section subtitles.
552 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
553   (under development).
555 * docutils/writers/null.py: Added to project; a do-nothing Writer.
557 * docs/api/publisher.txt:
559   - Added "``publish_parts`` Details" section.
561 * docutils/dev/repository.txt: Added to project; information about the
562   Docutils Subversion repository.
564 * docs/ref/docutils.dtd:
566   - Added a ``stub`` attribute to the ``colspec`` element via the
567     ``tbl.colspec.att`` parameter entity.
568   - Allowed topic elements within sidebars
569   - Added an ``align`` attribute to the ``figure`` element.
571 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
572   writer.
575 Release 0.3.7 (2004-12-24)
576 ==========================
578 * docutils/frontend.py:
580   - Added options: --input-encoding-error-handler,
581     --record-dependencies, --leave-footnote-reference-space,
582     --strict-visitor.
583   - Added command-line and config file support for "overrides" setting
584     parameter.
586 * docutils/io.py:
588   - Added support for input encoding error handler.
590 * docutils/nodes.py:
592   - Added dispatch_visit and dispatch_departure methods to
593     NodeVisitor; useful as a hook for Visitors.
594   - Changed structure of ``line_block``; added ``line``.
595   - Added ``compound`` node class.
596   - Added a mechanism for Visitors to transitionally ignore new node
597     classes.
599 * docutils/utils.py:
601   - Moved ``escape2null`` and ``unescape`` functions from
602     docutils/parsers/rst/states.py.
604 * docutils/parsers/rst/roles.py:
606   - Added "raw" role.
607   - Changed role function API: the "text" parameter now takes
608     null-escaped interpreted text content.
610 * docutils/parsers/rst/states.py:
612   - Fixed bug where a "role" directive in a nested parse would crash
613     the parser; the state machine's "language" attribute was not being
614     copied over.
615   - Added support for line block syntax.
616   - Fixed directive parsing bug: argument-less directives didn't
617     notice that arguments were present.
618   - Removed error checking for transitions.
619   - Added support for multiple classifiers in definition list items.
620   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
621   - Changed role function API: the "text" parameter now takes
622     null-escaped interpreted text content.
623   - Empty sections and documents are allowed now.
625 * docutils/parsers/rst/directives/__init__.py:
627   - Added ``encoding`` directive option conversion function.
628   - Allow multiple class names in class_option conversion function.
630 * docutils/parsers/rst/directives/body.py:
632   - Converted the line-block directive to use the new structure.
633   - Extracted the old line-block functionality to the ``block``
634     function (still used).
635   - Added ``compound`` directive (thanks to Felix Wiemann).
637 * docutils/parsers/rst/directives/misc.py:
639   - Added "encoding" option to "include" and "raw" directives.
640   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
641   - Allow multiple class names in the "class" directive.
643 * docutils/parsers/rst/directives/parts.py:
645   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
646     options.  Thanks to Lele Gaifax.
648 * docutils/parsers/rst/directives/tables.py:
650   - Added "encoding" directive to "csv-table" directive.
651   - Added workaround for lack of Unicode support in csv.py, for
652     non-ASCII CSV input.
654 * docutils/transforms/misc.py:
656   - Fixed bug when multiple "class" directives are applied to a single
657     element.
658   - Enabled multiple format names for "raw" directive.
660 * docutils/transforms/references.py:
662   - Added support for trimming whitespace from beside substitution
663     references.
665 * docutils/transforms/universal.py:
667   - FinalChecks now checks for illegal transitions and moves
668     transitions between sections.
670 * docutils/writers/html4css1.py:
672   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
673   - "stylesheet" and "stylesheet_path" settings are now mutually
674     exclusive.
675   - Added support for the new line_block/line structure.
676   - --footnote-references now overrides
677     --trim-footnote-reference-space, if applicable.
678   - Added support for ``compound`` elements.
679   - Enabled multiple format names for "raw" directive.
680   - ``<p>`` tags of a paragraph which is the only visible child of the
681     document node are no longer stripped.
682   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
683     new method ``should_be_compact_paragraph()``.
684   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
685     elements.
686   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
687     the output if they have their ``class`` attribute set.
688   - The whole document is now surrounded by a ``<div
689     class="document">`` element.
690   - Body-level images are now wrapped by their own ``<div>`` elements,
691     with image classes copied to the wrapper, and for images which
692     have the ``:align:`` option set, the surrounding ``<div>`` now
693     receives a class attribute (like ``class="align-left"``).
695 * docutils/writers/latex2e.py:
697   - no newline after depart_term.
698   - Added translations for some Unicode quotes.
699   - Added option "font-encoding", made package AE the default.
700   - "stylesheet" and "stylesheet_path" settings are now mutually
701     exclusive.
702   - --footnote-references now overrides
703     --trim-footnote-reference-space, if applicable.
704   - The footnote label style now matches the footnote reference style
705     ("brackets" or "superscript").
706   - Added support for ``compound`` elements.
707   - Enabled multiple format names for "raw" directive.
709 * docs/ref/docutils.dtd:
711   - Changed structure of the ``line_block`` element; added ``line``.
712   - Added ``compound`` element.
713   - Added "ltrim" and "rtrim" attributes to
714     ``substitution_definition`` element.
715   - Enabled multiple format names for ``raw`` element.
716   - Enabled multiple classifiers in ``definition_list_item`` elements.
718 * docs/ref/rst/directives.txt
720   - Marked "line-block" as deprecated.
721   - "Class" directive now allows multiple class names.
722   - Added "Rationale for Class Attribute Value Conversion".
723   - Added warning about "raw" overuse/abuse.
725 * docs/ref/rst/restructuredtext.txt:
727   - Added syntax for line blocks.
728   - Definition list items may have multiple classifiers.
730 * docs/ref/rst/roles.txt:
732   - Added "raw" role.
734 * tools/stylesheets/default.css:
736   - Added support for the new line_block structure.
737   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
740 Release 0.3.5 (2004-07-29)
741 ==========================
743 General:
745 * _`Documentation cleanup/reorganization`.
747   - Created new subdirectories of docs/:
749     * ``docs/user/``: introductory/tutorial material for end-users
750     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
751     * ``docs/api/``: API reference material for client-developers
752     * ``docs/ref/``: reference material for all groups
753     * ``docs/howto/``: for component-developers and core-developers
754     * ``docs/peps/``: Python Enhancement Proposals
756   - Moved ``docs/*`` to ``docs/user/``.
757   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
758     ``spec/`` to ``docs/dev``.
759   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
760     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
761   - Moved ``alternatives.txt``, and ``problems.txt`` from
762     ``spec/rst/`` to ``docs/dev/rst/``.
763   - Moved ``reStructuredText.txt``, ``directives.txt``,
764     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
765     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
766     ``roles.txt``, ``reStructuredText.txt`` to
767     ``restructuredtext.txt``.
768   - Moved ``spec/howto/`` to ``docs/howto``.
770   In order to keep the CVS history of moved files, we supplied
771   SourceForge with a `script for modifying the Docutils CVS
772   repository`__.
774   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
776   After running the cleanup script:
778   - Added ``docs/index.txt``.
779   - Added a ``.htaccess`` file to the ``web`` module, containing
780     redirects for all old paths to new paths.  They'll preserve
781     fragments (the "#name" part of a URL), and won't clutter up the
782     file system, and will correct the URL in the user's browser.
783   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
784     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
785     the "To Do" list itself in ``docs/dev/todo.txt``.
786   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
787     section of ``docs/dev/todo.txt``.
788   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
789   - Added "How To Report Bugs" to ``BUGS.txt``.
790   - Went through all the sources and docs (including under web/) and
791     updated links.  Mostly done by Felix Wiemann; thanks Felix!
792     (Still need to update links in the sandboxes.)
794 Specific:
796 * BUGS.txt: Added to project.
798 * THANKS.txt: Added to project.
800 * docutils/__init__.py:
802   - 0.3.4: Post-release.
804 * docutils/core.py:
806   - Added special error handling & advice for UnicodeEncodeError.
807   - Refactored Publisher.publish (simplified exception handling &
808     extracted debug dumps).
809   - Renamed "enable_exit" parameter of convenience functions to
810     "enable_exit_status".
811   - Enabled traceback (exception propagation) by default in
812     programmatic convenience functions.
813   - Now publish_file and publish_cmdline convenience functions return
814     the encoded string results in addition to their regular I/O.
815   - Extracted common code from publish_file, publish_string, and
816     publish_parts, into new publish_programmatically.  Extracted
817     settings code to ``Publisher.process_programmatic_settings``.
818   - In Publisher.publish, disabled ``settings_overrides`` when
819     ``settings`` is supplied; redundant.
821 * docutils/frontend.py:
823   - Added help text for "--output-encoding-error-handler" and
824     "--error-encoding-error-handler".
825   - Renamed "--exit" to "--exit-status".
826   - Simplified default-setting code.
828 * docutils/parsers/rst/__init__.py:
830   - Added "--pep-base-url" and "--rfc-base-url" options.
832 * docutils/parsers/rst/states.py:
834   - Made URI recognition more aggressive and intelligent.
836 * docutils/parsers/rst/directives/__init__.py:
838   - Added several directive option conversion functions.
840 * docutils/parsers/rst/directives/body.py:
842   - Moved "table" directive to tables.py.
844 * docutils/parsers/rst/directives/tables.py: Table-related directives,
845   added to project.
847 * docutils/writers/latex2e.py:
849   - Added "--table-style=(standard|booktabs|nolines)"
850   - figures get "here" option (LaTeX per default puts them at bottom),
851     and figure content is centered.
852   - Rowspan support for tables.
853   - Fix: admonition titles before first section.
854   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
855   - Replave ``_`` in literal by an underlined blank, because it has the correct
856     width.
857   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
858   - A few unicode replacements, if output_encoding != utf
859   - Add "--graphicx-option".
860   - Indent literal-blocks.
861   - Fix: omit ``\maketitle`` when there is no document title.
863 * docs/index.txt: "Docutils Project Documentation Overview", added to
864   project.
866 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
867   Tool", added to project.
869 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
871 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
873 * docs/dev/policies.txt: Added to project (extracted from
874   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
876 * docs/dev/release.txt: Added to project (extracted from
877   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
879 * docs/dev/testing.txt: Added to project.
881 * docs/dev/website.txt: Added to project (extracted from
882   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
884 * docs/ref/rst/directives.txt:
886   - Added directives: "table", "csv-table".
888 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
889   added to project.  1 page for syntax, and a 1 page reference for
890   directives and roles.  Source text to be used as-is; not meant to be
891   converted to HTML.
893 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
894   with a change of title.
896 * test/functional/, contents, and test/test_functional.py: Added to
897   project.
899 * tools/buildhtml.py: Fixed bug with config file handling.
901 * tools/html.py: Removed from project (duplicate of rst2html.py).
903 * tools/pep2html.py: Removed from project (duplicate of Python's
904   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
905   Docutils-related PEPs in docs/peps/).
907 * tools/rst2pseudoxml.py: Renamed from publish.py.
909 * tools/rst2xml.py: Renamed from docutils-xml.py.
911 * tools/test.txt: Removed from project; moved to
912   docs/user/rst/demo.txt.
914 * setup.py: Now also installs ``rst2latex.py``.
917 Release 0.3.3 (2004-05-09)
918 ==========================
920 * docutils/__init__.py:
922   - 0.3.1: Reorganized config file format (multiple sections); see
923     docs/config.txt.
924   - Added unknown_reference_resolvers attribute to TransformSpec.
925   - 0.3.2: Interpreted text reorganization.
926   - 0.3.3: Released.
928 * docutils/core.py:
930   - Catch system messages to stop tracebacks from parsing errors.
931   - Catch exceptions during processing report & exit without
932     tracebacks, except when "--traceback" used.
933   - Reordered components for OptionParser; application comes last.
934   - Added "config_section" parameter to several methods and functions,
935     allowing front ends to easily specify their config file sections.
936   - Added publish_parts convenience function to allow access to individual
937     parts of a document.
939 * docutils/examples.py: Added to project; practical examples of
940   Docutils client code, to be used as-is or as models for variations.
942 * docutils/frontend.py:
944   - Added "--traceback" & "--no-traceback" options ("traceback"
945     setting).
946   - Implemented support for config file reorganization:
947     ``standard_config_files`` moved from ``ConfigParser`` to
948     ``OptionParser``; added
949     ``OptionParser.get_config_file_settings()`` and
950     ``.get_standard_config_settings()``; support for old "[options]"
951     section (with deprecation warning) and mapping from old to new
952     settings.
953   - Reimplemented setting validation.
954   - Enabled flexible boolean values: yes/no, true/false, on/off.
955   - Added ``Values``, a subclass of ``optparse.Values``, with support
956     for list setting attributes.
957   - Added support for new ``DOCUTILSCONFIG`` environment variable;
958     thanks to Beni Cherniavsky.
959   - Added "--no-section-numbering" option.
961 * docutils/io.py:
963   - Catch IOErrors when opening source & destination files, report &
964     exit without tracebacks.  Added ``handle_io_errors`` parameter to
965     ``FileInput`` & ``FileOutput`` to enable caller error handling.
967 * docutils/nodes.py:
969   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
970     method definitions (via ``exec``) to dynamic assignments (via
971     ``setattr``); thanks to Roman Suzi.
972   - Encapsulated visitor dynamic assignments in a function; thanks to
973     Ian Bicking.
974   - Added indirect_reference_name attribute to the Targetable
975     class. This attribute holds the whitespace_normalized_name
976     (contains mixed case) of a target.
978 * docutils/statemachine.py:
980   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
981   - Added ``StringList.get_2D_block``.
983 * docutils/utils.py:
985   - Added "level" attribute to SystemMessage exceptions.
987 * docutils/languages/af.py: Added to project; Afrikaans mappings by
988   Jannie Hofmeyr.
990 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
991   Blaha.
993 * docutils/languages/eo.py: Added to project; Esperanto mappings by
994   Marcelo Huerta San Martin.
996 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
997   mappings by Lalo Martins.
999 * docutils/languages/ru.py: Added to project; Russian mappings by
1000   Roman Suzi.
1002 * docutils/parsers/rst/roles.py: Added to project.  Contains
1003   interpreted text role functions, a registry for interpreted text
1004   roles, and an API for adding to and retrieving from the registry.
1005   Contributed by Edward Loper.
1007 * docutils/parsers/rst/states.py:
1009   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1010   - Allowed true em-dash character and "---" as block quote
1011     attribution marker.
1012   - Added support for <angle-bracketed> complex option arguments
1013     (option lists).
1014   - Fixed handling of backslashes in substitution definitions.
1015   - Fixed off-by-1 error with extra whitespace after substitution
1016     definition directive.
1017   - Added inline markup parsing to field lists' field names.
1018   - Added support for quoted (and unindented) literal blocks.
1019     Driven in part by a bribe from Frank Siebenlist (thanks!).
1020   - Parser now handles escapes in URIs correctly.
1021   - Made embedded-URIs' reference text omittable.  Idea from Beni
1022     Cherniavsky.
1023   - Refactored explicit target processing code.
1024   - Added name attribute to references containing the reference name only
1025     through whitespace_normalize_name (no case changes).
1026   - parse_target no longer returns the refname after going through
1027     normalize_name. This is now handled in make_target.
1028   - Fixed bug relating to role-less interpreted text in non-English
1029     contexts.
1030   - Reorganized interpreted text processing; moved code into the new
1031     roles.py module.  Contributed by Edward Loper.
1032   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1033     ``parse_directive_block``.
1035 * docutils/parsers/rst/tableparser.py:
1037   - Reworked for ``StringList``, to support "include" directives in
1038     table cells.
1040 * docutils/parsers/rst/directives/__init__.py:
1042   - Renamed ``unchanged()`` directive option conversion function to
1043     ``unchanged_required``, and added a new ``unchanged``.
1044   - Catch unicode value too high error; fixes bug 781766.
1045   - Beefed up directive error reporting.
1047 * docutils/parsers/rst/directives/body.py:
1049   - Added basic "table" directive.
1051 * docutils/parsers/rst/directives/images.py:
1053   - Added "target" option to "image" directive.
1054   - Added name attribute to references containing the reference name only
1055     through whitespace_normalize_name (no case changes).
1057 * docutils/parsers/rst/directives/misc.py:
1059   - Isolated the import of the ``urllib2`` module; was causing
1060     problems on SourceForge (``libssl.so.2`` unavailable?).
1061   - Added the "role" directive for declaring custom interpreted text
1062     roles.
1064 * docutils/parsers/rst/directives/parts.py:
1066   - The "contents" directive does more work up-front, creating the
1067     "topic" and "title", and leaving the "pending" node for the
1068     transform.  Allows earlier reference resolution; fixes subtle bug.
1070 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1071   mappings by Jannie Hofmeyr.
1073 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1074   mappings by Marek Blaha.
1076 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1077   mappings by Marcelo Huerta San Martin.
1079 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1080   Portuguese mappings by Lalo Martins.
1082 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1083   mappings by Roman Suzi.
1085 * docutils/transforms/parts.py:
1087   - The "contents" directive does more work up-front, creating the
1088     "topic" and "title", and leaving the "pending" node for the
1089     transform.  Allows earlier reference resolution; fixes subtle bug.
1090   - Added support for disabling of section numbering.
1092 * docutils/transforms/references.py:
1094   - Verifying that external targets are truly targets and not indirect
1095     references. This is because we are now adding a "name" attribute to
1096     references in addition to targets. Note sure if this is correct!
1097   - Added code to hook into the unknown_reference_resolvers list for a
1098     transformer in resolve_indirect_target. This allows the
1099     unknown_reference_resolvers to keep around indirect targets which
1100     docutils doesn't know about.
1101   - Added specific error message for duplicate targets.
1103 * docutils/transforms/universal.py:
1105   - Added FilterMessages transform (removes system messages below the
1106     verbosity threshold).
1107   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1108     to FinalCheckVisitor for application-specific handling of
1109     unresolvable references.
1110   - Added specific error message for duplicate targets.
1112 * docutils/writers/__init__.py:
1114   - Added assemble_parts method to the Writer class to allow for
1115     access to a documents individual parts.
1116   - Documented & set default for ``Writer.output`` attribute.
1118 * docutils/writers/html4css1.py:
1120   - Fixed unicode handling of attribute values (bug 760673).
1121   - Prevent duplication of "class" attribute values (bug report from
1122     Kirill Lapshin).
1123   - Improved table grid/border handling (prompted by report from Bob
1124     Marshall).
1125   - Added support for table titles.
1126   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1127     to Darek Suchojad.
1128   - Added functionality to keep track of individual parts of a document
1129     and store them in a dictionary as the "parts" attribute of the writer.
1130     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1131   - Added proper support for the "scale" attribute of the "image"
1132     element.  Contributed by Brent Cook.
1133   - Added ``--initial-header-level`` option.
1134   - Fixed bug: the body_pre_docinfo segment depended on there being a
1135     docinfo; if no docinfo, the document title was incorporated into
1136     the body segment.  Adversely affected the publish_parts interface.
1138 * docutils/writers/latex2e.py:
1140   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1141     about a missing file.
1142   - Added options and support: ``--compound-enumerators``,
1143     ``--section-prefix-for-enumerators``, and
1144     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1145     934322).
1146   - Added option ``--use-verbatim-when-possible``, to avoid
1147     problematic characters (eg, '~' in italian) in literal blocks.
1148   - It's now possible to use four section levels in the `book` and
1149     `report` LaTeX classes.  The default `article` class still has
1150     three levels limit.
1152 * docs/config.txt: "Docutils Configuration Files", added to project.
1153   Moved config file entry descriptions from tools.txt.
1155 * docs/tools.txt:
1157   - Moved config file entry descriptions to config.txt.
1159 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1160   Development".
1162 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1163   Text Roles", added to project.
1165 * spec/rst/reStructuredText.txt:
1167   - Added description of support for <angle-bracketed> complex option
1168     arguments to option lists.
1169   - Added subsections for indented and quoted literal blocks.
1171 * test: Continually adding & updating tests.
1173   - Added test/test_settings.py & test/data/config_*.txt support
1174     files.
1175   - Added test/test_writers/test_htmlfragment.py.
1177 * test/DocutilsTestSupport.py:
1179   - Refactored LaTeX publisher test suite/case class names to make
1180     testing other writers easier.
1181   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1182     to test the processing of HTML fragments which use the new
1183     publish_parts convenience function.
1185 * tools/buildhtml.py:
1187   - Added support for the "--prune" option.
1188   - Removed dependency on pep2html.py; plaintext PEPs no longer
1189     supported.
1191 * tools/docutils.conf:
1193   - Updated for configuration file reorganization.
1195 * tools/rst2html.py:
1197   - copied from tools/html.py
1199 * setup.py:
1201   - added a 'scripts' section to configuration
1202   - added 'tools/rst2html.py' to the scripts section
1205 Release 0.3 (2003-06-24)
1206 ========================
1208 General:
1210 * Renamed "attribute" to "option" for directives/extensions.
1212 * Renamed transform method "transform" to "apply".
1214 * Renamed "options" to "settings" for runtime settings (as set by
1215   command-line options).  Sometimes "option" (singular) became
1216   "settings" (plural).  Some variations below:
1218   - document.options -> document.settings (stored in other objects as
1219     well)
1220   - option_spec -> settings_spec (not directives though)
1221   - OptionSpec -> SettingsSpec
1222   - cmdline_options -> settings_spec
1223   - relative_path_options -> relative_path_settings
1224   - option_default_overrides -> settings_default_overrides
1225   - Publisher.set_options -> Publisher.get_settings
1227 Specific:
1229 * COPYING.txt: Added "Public Domain Dedication".
1231 * FAQ.txt: Frequently asked questions, added to project.
1233 * setup.py:
1235   - Updated with PyPI Trove classifiers.
1236   - Conditional installation of third-party modules.
1238 * docutils/__init__.py:
1240   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1241   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1242   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1243   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1244     option and its effect on the PEP template & writer.
1245   - Bumped version to 0.2.4 due to changes to the PEP template &
1246     stylesheet.
1247   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1248   - Added ``TransformSpec`` class for new transform system.
1249   - Bumped version to 0.2.6 for API changes (renaming).
1250   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1251     convenience functions.
1252   - Added ``Component.component_type`` attribute.
1253   - Bumped version to 0.2.8 because of the internal parser switch from
1254     plain lists to the docutils.statemachine.StringList objects.
1255   - Bumped version to 0.2.9 because of the frontend.py API changes.
1256   - Bumped version to 0.2.10 due to changes to the project layout
1257     (third-party modules removed from the "docutils" package), and
1258     signature changes in ``io.Input``/``io.Output``.
1259   - Changed version to 0.3.0 for release.
1261 * docutils/core.py:
1263   - Made ``publish()`` a bit more convenient.
1264   - Generalized ``Publisher.set_io``.
1265   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1266     parameters; improved its docstring.
1267   - Added ``publish_file()`` and ``publish_string()``.
1268   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1269     out of ``.set_io``.
1270   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1271     "--dump-transforms" hidden options.
1272   - Added ``Publisher.apply_transforms()`` method.
1273   - Added ``Publisher.set_components()`` method; support for
1274     ``publish_*()`` conveninece functions.
1275   - Moved config file processing to docutils/frontend.py.
1276   - Added support for exit status ("exit_level" setting &
1277     ``enable_exit`` parameter for Publisher.publish() and convenience
1278     functions).
1280 * docutils/frontend.py:
1282   - Check for & exit on identical source & destination paths.
1283   - Fixed bug with absolute paths & "--config".
1284   - Set non-command-line defaults in ``OptionParser.__init__()``:
1285     ``_source`` & ``_destination``.
1286   - Distributed ``relative_path_settings`` to components; updated
1287     ``OptionParser.populate_from_components()`` to combine it all.
1288   - Require list of keys in ``make_paths_absolute`` (was implicit in
1289     global ``relative_path_settings``).
1290   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1291     "--dump-settings", and "--dump-transforms" hidden options.
1292   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1293     code, replaced with correct code.
1294   - Added validation functionality for config files.
1295   - Added "--error-encoding" option/setting, "_disable_config"
1296     internal setting.
1297   - Added encoding validation; updated "--input-encoding" and
1298     "--output-encoding"; added "--error-encoding-error-handler" and
1299     "--output-encoding-error-handler".
1300   - Moved config file processing from docutils/core.py.
1301   - Updated ``OptionParser.populate_from_components`` to handle new
1302     ``SettingsSpec.settings_defaults`` dict.
1303   - Added support for "-" => stdin/stdout.
1304   - Added "exit_level" setting ("--exit" option).
1306 * docutils/io.py:
1308   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1309   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1310   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1311   - ``FileOutput.write()`` now returns the encoded output string.
1312   - Try to get path/stream name automatically in ``FileInput`` &
1313     ``FileOutput``.
1314   - Added defaults for source & destination paths.
1315   - Allow for Unicode I/O with an explicit "unicode" encoding.
1316   - Added ``Output.encode()``.
1317   - Removed dependency on runtime settings; pass encoding directly.
1318   - Recognize Unicode strings in ``Input.decode()``.
1319   - Added support for output encoding error handlers.
1321 * docutils/nodes.py:
1323   - Added "Invisible" element category class.
1324   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1325     modification during a traversal.
1326   - Added element classes: ``line_block``, ``generated``, ``address``,
1327     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1328     ``superscript``, ``subscript``, ``inline``
1329   - Added support for lists of nodes to ``Element.insert()``.
1330   - Fixed parent linking in ``Element.replace()``.
1331   - Added new abstract superclass ``FixedTextElement``; adds
1332     "xml:space" attribute.
1333   - Added support for "line" attribute of ``system_message`` nodes.
1334   - Added support for the observer pattern from ``utils.Reporter``.
1335     Added ``parse_messages`` and ``transform_messages`` attributes to
1336     ``document``, removed ``messages``.  Added ``note_parse_message``
1337     and ``note_transform_message`` methods.
1338   - Added support for improved diagnostics:
1340     - Added "document", "source", and "line" internal attributes to
1341       ``Node``, set by ``Node.setup_child()``.
1342     - Converted variations on ``node.parent = self`` to
1343       ``self.setup_child(node)``.
1344     - Added ``document.current_source`` & ``.current_line``
1345       attributes, and ``.note_source`` observer method.
1346     - Changed "system_message" output to GNU-Tools format.
1348   - Added a "rawsource" attribute to the ``Text`` class, for text
1349     before backslash-escape resolution.
1350   - Support for new transform system.
1351   - Reworked ``pending`` element.
1352   - Fixed XML DOM bug (SF #660611).
1353   - Removed the ``interpeted`` element class and added
1354     ``title_reference``, ``abbreviation``, ``acronym``.
1355   - Made substitutions case-sensitive-but-forgiving; moved some code
1356     from the parser.
1357   - Fixed Unicode bug on element attributes (report: William Dode).
1359 * docutils/optik.py: Removed from project; replaced with
1360   extras/optparse.py and extras/textwrap.py.  These will be installed
1361   only if they're not already present in the Python installation.
1363 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1364   only if it's not already present in the Python installation.
1366 * docutils/statemachine.py:
1368   - Factored out ``State.add_initial_transitions()`` so it can be
1369     extended.
1370   - Converted whitespace-specific "blank" and "indent" transitions
1371     from special-case code to ordinary transitions: removed
1372     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1373     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1374     ``ws_initial_transitions`` attributes.
1375   - Removed ``State.match_transition()`` after merging it into
1376     ``.check_line()``.
1377   - Added ``StateCorrection`` exception.
1378   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1379     (moved ``TransitionCorrection`` support there too.)
1380   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1381     ``EOFError`` instead of ``IndexError``.
1382   - Added ``State.no_match`` method.
1383   - Added support for the Observer pattern, triggered by input line
1384     changes.
1385   - Added ``strip_top`` parameter to
1386     ``StateMachineWS.get_first_known_indented``.
1387   - Made ``context`` a parameter to ``StateMachine.run()``.
1388   - Added ``ViewList`` & ``StringList`` classes;
1389     ``extract_indented()`` becomes ``StringList.get_indented()``.
1390   - Added ``StateMachine.insert_input()``.
1391   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1392     thanks to) Fred Drake.
1394 * docutils/utils.py:
1396   - Added a ``source`` attribute to Reporter instances and
1397     ``system_message`` elements.
1398   - Added an observer pattern to ``utils.Reporter`` to keep track of
1399     system messages.
1400   - Fixed bugs in ``relative_path()``.
1401   - Added support for improved diagnostics.
1402   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1403   - Added support for encoding Reporter stderr output, and encoding
1404     error handlers.
1405   - Reporter keeps track of the highest level system message yet
1406     generated.
1408 * docutils/languages: Fixed bibliographic field language lookups.
1410 * docutils/languages/es.py: Added to project; Spanish mappings by
1411   Marcelo Huerta San Martin.
1413 * docutils/languages/fr.py: Added to project; French mappings by
1414   Stefane Fermigier.
1416 * docutils/languages/it.py: Added to project; Italian mappings by
1417   Nicola Larosa.
1419 * docutils/languages/sk.py: Added to project; Slovak mappings by
1420   Miroslav Vasko.
1422 * docutils/parser/__init__.py:
1424   - Added ``Parser.finish_parse()`` method.
1426 * docutils/parser/rst/__init__.py:
1428   - Added options: "--pep-references", "--rfc-references",
1429     "--tab-width", "--trim-footnote-reference-space".
1431 * docutils/parsers/rst/states.py:
1433   - Changed "title under/overline too short" system messages from INFO
1434     to WARNING, and fixed its insertion location.
1435   - Fixed enumerated list item parsing to allow paragraphs & section
1436     titles to begin with enumerators.
1437   - Converted system messages to use the new "line" attribute.
1438   - Fixed a substitution reference edge case.
1439   - Added support for "--pep-references" and "--rfc-references"
1440     options; reworked ``Inliner`` code to make customization easier.
1441   - Removed field argument parsing.
1442   - Added support for short section title over/underlines.
1443   - Fixed "simple reference name" regexp to ignore text like
1444     "object.__method__"; not an anonymous reference.
1445   - Added support for improved diagnostics.
1446   - Reworked directive API, based on Dethe Elza's contribution.  Added
1447     ``Body.parse_directive()``, ``.parse_directive_options()``,
1448     ``.parse_directive_arguments()`` methods.
1449   - Added ``ExtensionOptions`` class, to parse directive options
1450     without parsing field bodies.  Factored
1451     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1452     ``ExtensionOptions``.
1453   - Improved definition list term/classifier parsing.
1454   - Added warnings for unknown directives.
1455   - Renamed ``Stuff`` to ``Struct``.
1456   - Now flagged as errors: transitions at the beginning or end of
1457     sections, empty sections (except title), and empty documents.
1458   - Updated for ``statemachine.StringList``.
1459   - Enabled recognition of schemeless email addresses in targets.
1460   - Added support for embedded URIs in hyperlink references.
1461   - Added backslash-escapes to inline markup end-string suffix.
1462   - Added support for correct interpreted text processing.
1463   - Fixed nested title parsing (topic, sidebar directives).
1464   - Added special processing of backslash-escaped whitespace (idea
1465     from David Abrahams).
1466   - Made substitutions case-sensitive-but-forgiving; moved some code
1467     to ``docutils.nodes``.
1468   - Added support for block quote attributions.
1469   - Added a kludge to work-around a conflict between the bubble-up
1470     parser strategy and short titles (<= 3 char-long over- &
1471     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1472     titles" submitted by Jason Diamond.
1473   - Added explicit interpreted text roles for standard inline markup:
1474     "emphasis", "strong", "literal".
1475   - Implemented "superscript" and "subscript" interpreted text roles.
1476   - Added initial support for "abbreviation" and "acronym" roles;
1477     incomplete.
1478   - Added support for "--trim-footnote-reference-space" option.
1479   - Optional space before colons in directives & hyperlink targets.
1481 * docutils/parsers/rst/tableparser.py:
1483   - Fixed a bug that was producing unwanted empty rows in "simple"
1484     tables.
1485   - Detect bad column spans in "simple" tables.
1487 * docutils/parsers/rst/directives: Updated all directive functions to
1488   new API.
1490 * docutils/parsers/rst/directives/__init__.py:
1492   - Added ``flag()``, ``unchanged()``, ``path()``,
1493     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1494     directive option helper functions.
1495   - Added warnings for unknown directives.
1496   - Return ``None`` for missing directives.
1497   - Added ``register_directive()``, thanks to William Dode and Paul
1498     Moore.
1500 * docutils/parsers/rst/directives/admonitions.py:
1502   - Added "admonition" directive.
1504 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1505   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1506   "parsed-literal", "rubric", "epigraph", "highlights" and
1507   "pull-quote" directives.
1509 * docutils/parsers/rst/directives/images.py:
1511   - Added an "align" attribute to the "image" & "figure" directives
1512     (by Adam Chodorowski).
1513   - Added "class" option to "image", and "figclass" to "figure".
1515 * docutils/parsers/rst/directives/misc.py:
1517   - Added "include", "raw", and "replace" directives, courtesy of
1518     Dethe Elza.
1519   - Added "unicode" and "class" directives.
1521 * docutils/parsers/rst/directives/parts.py:
1523   - Added the "sectnum" directive; by Dmitry Jemerov.
1524   - Added "class" option to "contents" directive.
1526 * docutils/parsers/rst/directives/references.py: Added to project.
1527   Contains the "target-notes" directive.
1529 * docutils/parsers/rst/languages/__init__.py:
1531   - Return ``None`` from get_language() for missing language modules.
1533 * docutils/parsers/rst/languages/de.py: Added to project; German
1534   mappings by Engelbert Gruber.
1536 * docutils/parsers/rst/languages/en.py:
1538   - Added interpreted text roles mapping.
1540 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1541   mappings by Marcelo Huerta San Martin.
1543 * docutils/parsers/rst/languages/fr.py: Added to project; French
1544   mappings by William Dode.
1546 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1547   mappings by Nicola Larosa.
1549 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1550   mappings by Miroslav Vasko.
1552 * docutils/readers/__init__.py:
1554   - Added support for the observer pattern from ``utils.Reporter``, in
1555     ``Reader.parse`` and ``Reader.transform``.
1556   - Removed ``Reader.transform()`` method.
1557   - Added default parameter values to ``Reader.__init__()`` to make
1558     instantiation easier.
1559   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1561 * docutils/readers/pep.py:
1563   - Added the ``peps.TargetNotes`` transform to the Reader.
1564   - Removed PEP & RFC reference detection code; moved to
1565     parsers/rst/states.py as options (enabled here by default).
1566   - Added support for pre-acceptance PEPs (no PEP number yet).
1567   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1568     easy subclassing.
1570 * docutils/readers/python: Python Source Reader subpackage added to
1571   project, including preliminary versions of:
1573   - __init__.py
1574   - moduleparser.py: Parser for Python modules.
1576 * docutils/transforms/__init__.py:
1578   - Added ``Transformer`` class and completed transform reform.
1579   - Added unknown_reference_resolvers list for each transformer. This list holds
1580     the list of functions provided by each component of the transformer that
1581     help resolve references.
1583 * docutils/transforms/frontmatter.py:
1585   - Improved support for generic fields.
1586   - Fixed bibliographic field language lookups.
1588 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1589   transforms.
1591 * docutils/transforms/parts.py:
1593   - Moved the "id" attribute from TOC list items to the references
1594     (``Contents.build_contents()``).
1595   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1596   - Added "class" attribute support to ``Contents``.
1598 * docutils/transforms/peps.py:
1600   - Added ``mask_email()`` function, updating to pep2html.py's
1601     functionality.
1602   - Linked "Content-Type: text/x-rst" to PEP 12.
1603   - Added the ``TargetNotes`` PEP-specific transform.
1604   - Added ``TargetNotes.cleanup_callback``.
1605   - Added title check to ``Headers``.
1607 * docutils/transforms/references.py:
1609   - Added the ``TargetNotes`` generic transform.
1610   - Split ``Hyperlinks`` into multiple transforms.
1611   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1612   - Added check for circular indirect references.
1613   - Made substitutions case-sensitive-but-forgiving.
1615 * docutils/transforms/universal.py:
1617   - Added support for the "--expose-internal-attributes" option.
1618   - Removed ``Pending`` transform classes & data.
1620 * docutils/writers/__init__.py:
1622   - Removed ``Writer.transform()`` method.
1624 * docutils/writers/docutils-xml.py:
1626   - Added XML and doctype declarations.
1627   - Added "--no-doctype" and "--no-xml-declaration" options.
1629 * docutils/writers/html4css1.py:
1631   - "name" attributes only on these tags: a, applet, form, frame,
1632     iframe, img, map.
1633   - Added "name" attribute to <a> in section titles for Netscape 4
1634     support (bug report: Pearu Peterson).
1635   - Fixed targets (names) on footnote, citation, topic title,
1636     problematic, and system_message nodes (for Netscape 4).
1637   - Changed field names from "<td>" to "<th>".
1638   - Added "@" to "&#64;" encoding to thwart address harvesters.
1639   - Improved the vertical whitespace optimization; ignore "invisible"
1640     nodes (targets, comments, etc.).
1641   - Improved inline literals with ``<span class="pre">`` around chunks
1642     of text and ``&nbsp;`` for runs of spaces.
1643   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1644     ``self.docinfo`` segments.
1645   - Added support for "line_block", "address" elements.
1646   - Improved backlinks (footnotes & system_messages).
1647   - Improved system_message output.
1648   - Redefined "--stylesheet" as containing an invariant URL, used
1649     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1650     working directory.
1651   - Added "--footnote-references" option (superscript or brackets).
1652   - Added "--compact-lists" and "--no-compact-lists" options.
1653   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1654     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1655   - Improved field list rendering.
1656   - Added Docutils version to "generator" meta tag.
1657   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1658   - Improved layout of <pre> HTML source.
1659   - Fixed attribute typo on <colspec>.
1660   - Refined XML prologue.
1661   - Support for no stylesheet.
1662   - Removed "interpreted" element support.
1663   - Added support for "title_reference", "sidebar", "attribution",
1664     "rubric", and generic "admonition" elements.
1665   - Added "--attribution" option.
1666   - Added support for "inline", "subscript", "superscript" elements.
1667   - Added initial support for "abbreviation" and "acronym";
1668     incomplete.
1670 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1671   (from the sandbox).
1673   - Added french.
1674   - Double quotes in literal blocks (special treatment for de/ngerman).
1675   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1676   - Added  "--attribution" option.
1677   - Right align attributions.
1679 * docutils/writers/pep_html.py:
1681   - Parameterized output encoding in PEP template.
1682   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1683   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1684     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1685     working directory.
1686   - Added an override on the "--footnote-references" option.
1687   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1688   - Added Docutils version to "generator" meta tag.
1689   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1691 * docs/tools.txt:
1693   - Added a "silent" setting for ``buildhtml.py``.
1694   - Added a "Getting Help" section.
1695   - Rearranged the structure.
1696   - Kept up to date, with new settings, command-line options etc.
1697   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1698   - Converted settings table into a definition list.
1700 * docs/rst/quickstart.txt:
1702   - Added a table of contents.
1703   - Added feedback information.
1704   - Added mention of minimum section title underline lengths.
1705   - Removed the 4-character minimum for section title underlines.
1707 * docs/rst/quickref.html:
1709   - Added a "Getting Help" section.
1710   - Added a style to make section title backlinks more subtle.
1711   - Added mention of minimum section title underline lengths.
1712   - Removed the 4-character minimum for section title underlines.
1714 * extras: Directory added to project; contains third-party modules
1715   that Docutils depends on (optparse, textwrap, roman).  These are
1716   only installed if they're not already present.
1718 * licenses: Directory added to project; contains copies of license
1719   files for non-public-domain files.
1721 * spec/doctree.txt:
1723   - Changed the focus.  It's about DTD elements:  structural
1724     relationships, semantics, and external (public) attributes.  Not
1725     about the element class library.
1726   - Moved some implementation-specific stuff into ``docutils.nodes``
1727     docstrings.
1728   - Wrote descriptions of all common attributes and parameter
1729     entities.  Filled in introductory material.
1730   - Working through the element descriptions: 55 down, 37 to go.
1731   - Removed "Representation of Horizontal Rules" to
1732     spec/rst/alternatives.txt.
1734 * spec/docutils.dtd:
1736   - Added "generated" inline element.
1737   - Added "line_block" body element.
1738   - Added "auto" attribute to "title".
1739   - Changed content models of "literal_block" and "doctest_block" to
1740     ``%text.model``.
1741   - Added ``%number;`` attribute type parameter entity.
1742   - Changed ``%structural.elements;`` to ``%section.elements``.
1743   - Updated attribute types; made more specific.
1744   - Added "address" bibliographic element.
1745   - Added "line" attribute to ``system_message`` element.
1746   - Removed "field_argument" element; "field_name" may contain
1747     multiple words and whitespace.
1748   - Changed public identifier to docutils.sf.net.
1749   - Removed "interpreted" element; added "title_reference",
1750     "abbreviation", "acronym".
1751   - Removed "refuri" attribute from "footnote_reference" and
1752     "citation_reference".
1753   - Added "sidebar", "rubric", "attribution", "admonition",
1754     "superscript", "subscript", and "inline" elements.
1756 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1758 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1760 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1762 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1763   Dallas Mahrt.
1765 * spec/transforms.txt: Added to project.
1767 * spec/howto: Added subdirectory, for developer how-to docs.
1769 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1770   Elza, edited & extended by David Goodger.
1772 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1773   project.
1775 * spec/rst/alternatives.txt:
1777   - Added "Doctree Representation of Transitions" from
1778     spec/doctree.txt.
1779   - Updated "Inline External Targets" & closed the debate.
1780   - Added ideas for interpreted text syntax extensions.
1781   - Added "Nested Inline Markup" section.
1783 * spec/rst/directives.txt:
1785   - Added directives: "topic", "sectnum", "target-notes",
1786     "line-block", "parsed-literal", "include", "replace", "sidebar",
1787     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1788     "class".
1789   - Formalized descriptions of directive details.
1790   - Added an "align" attribute to the "image" & "figure" directives
1791     (by Adam Chodorowski).
1792   - Added "class" options to "topic", "sidebar", "line-block",
1793     "parsed-literal", "contents", and "image"; and "figclass" to
1794     "figure".
1796 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1797   interpreted text roles.
1799 * spec/rst/introduction.txt:
1801   - Added pointers to material for new users.
1803 * spec/rst/reStructuredText.txt:
1805   - Disambiguated comments (just add a newline after the "::").
1806   - Updated enumerated list description; added a discussion of the
1807     second-line validity checking.
1808   - Updated directive description.
1809   - Added a note redirecting newbies to the user docs.
1810   - Expanded description of inline markup start-strings in non-markup
1811     contexts.
1812   - Removed field arguments and made field lists a generic construct.
1813   - Removed the 4-character minimum for section title underlines.
1814   - Clarified term/classifier delimiter & inline markup ambiguity
1815     (definition lists).
1816   - Added "Embedded URIs".
1817   - Updated "Interpreted Text" section.
1818   - Added "Character-Level Inline Markup" section.
1820 * test: Continually adding & updating tests.
1822   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1823   - Moved test/test_pep/ to test/test_readers/test_pep/.
1824   - Added test/test_readers/test_python/.
1825   - Added test/test_writers/ (Engelbert Gruber).
1827 * tools:
1829   - Made the ``locale.setlocale()`` calls in front ends
1830     fault-tolerant.
1832 * tools/buildhtml.py:
1834   - Added "--silent" option.
1835   - Fixed bug with absolute paths & "--config".
1836   - Updated for new I/O classes.
1837   - Added some exception handling.
1838   - Separated publishers' setting defaults; prevents interference.
1839   - Updated for new ``publish_file()`` convenience function.
1841 * tools/pep-html-template:
1843   - Allow for "--embed-stylesheet".
1844   - Added Docutils version to "generator" meta tag.
1845   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1846   - Conform to XHTML spec.
1848 * tools/pep2html.py:
1850   - Made ``argv`` a parameter to ``main()``.
1851   - Added support for "Content-Type:" header & arbitrary PEP formats.
1852   - Linked "Content-Type: text/plain" to PEP 9.
1853   - Files skipped (due to an error) are not pushed onto the server.
1854   - Updated for new I/O classes.
1855   - Added ``check_requirements()`` & ``pep_type_error()``.
1856   - Added some exception handling.
1857   - Updated for new ``publish_string()`` convenience function.
1858   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1860 * tools/quicktest.py:
1862   - Added "-V"/"--version" option.
1864 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1866 * tools/unicode2rstsubs.py: Added to project.  Produces character
1867   entity files (reSructuredText substitutions) from the MathML master
1868   unicode.xml file.
1870 * tools/editors: Support code for editors, added to project.  Contains
1871   ``emacs/restructuredtext.el``.
1873 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1875   - Added style for chunks of inline literals.
1876   - Removed margin for first child of table cells.
1877   - Right-aligned field list names.
1878   - Support for auto-numbered section titles in TOCs.
1879   - Increased the size of inline literals (<tt>) in titles.
1880   - Restored the light gray background for inline literals.
1881   - Added support for "line_block" elements.
1882   - Added style for "address" elements.
1883   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1884   - Improved field list rendering.
1885   - Vertical whitespace improvements.
1886   - Removed "a.target" style.
1888 * tools/stylesheets/pep.css:
1890   - Fixed nested section margins.
1891   - Other changes parallel those of ``../default.css``.
1894 Release 0.2 (2002-07-31)
1895 ========================
1897 General:
1899 - The word "component" was being used ambiguously.  From now on,
1900   "component" will be used to mean "Docutils component", as in Reader,
1901   Writer, Parser, or Transform.  Portions of documents (Table of
1902   Contents, sections, etc.)  will be called "document parts".
1903 - Did a grand renaming: a lot of ``verylongnames`` became
1904   ``very_long_names``.
1905 - Cleaned up imports: no more relative package imports or
1906   comma-separated lists of top-level modules.
1907 - Added support for an option values object which carries default
1908   settings and overrides (from command-line options and library use).
1909 - Added internal Unicode support, and support for both input and
1910   output encodings.
1911 - Added support for the ``docutils.io.IO`` class & subclasses.
1913 Specific:
1915 * docutils/__init__.py:
1917   - Added ``ApplicationError`` and ``DataError``, for use throughout
1918     the package.
1919   - Added ``Component`` base class for Docutils components; implements
1920     the ``supports`` method.
1921   - Added ``__version__`` (thus, ``docutils.__version__``).
1923 * docutils/core.py:
1925   - Removed many keyword parameters to ``Publisher.__init__()`` and
1926     ``publish()``; bundled into an option values object.  Added
1927     "argv", "usage", "description", and "option_spec" parameters for
1928     command-line support.
1929   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1930     methods.
1931   - Reworked I/O model for ``docutils.io`` wrappers.
1932   - Updated ``Publisher.set_options()``; now returns option values
1933     object.
1934   - Added support for configuration files (/etc/docutils.conf,
1935     ./docutils.conf, ~/.docutils).
1936   - Added ``Publisher.setup_option_parser()``.
1937   - Added default usage message and description.
1939 * docutils/frontend.py: Added to project; support for front-end
1940   (command-line) scripts.  Option specifications may be augmented by
1941   components.  Requires Optik (http://optik.sf.net/) for option
1942   processing (installed locally as docutils/optik.py).
1944 * docutils/io.py: Added to project; uniform API for a variety of input
1945   output mechanisms.
1947 * docutils/nodes.py:
1949   - Added ``TreeCopyVisitor`` class.
1950   - Added a ``copy`` method to ``Node`` and subclasses.
1951   - Added a ``SkipDeparture`` exception for visitors.
1952   - Renamed ``TreePruningException`` from ``VisitorException``.
1953   - Added docstrings to ``TreePruningException``, subclasses, and
1954     ``Nodes.walk()``.
1955   - Improved docstrings.
1956   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1957   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1958     imports.
1959   - Added ``decoration``, ``header``, and ``footer`` node classes, and
1960     ``PreDecorative`` mixin.
1961   - Reworked the name/id bookkeeping; to ``document``, removed
1962     ``explicit_targets`` and ``implicit_targets`` attributes, added
1963     ``nametypes`` attribute and ``set_name_id_map`` method.
1964   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1965     traversals.
1966   - Added ``document.has_name()`` method.
1967   - Fixed DOM generation for list-attributes.
1968   - Added category class ``Labeled`` (used by footnotes & citations).
1969   - Added ``Element.set_class()`` method (sets "class" attribute).
1971 * docutils/optik.py: Added to project.  Combined from the Optik
1972   package, with added option groups and other modifications.  The use
1973   of this module is probably only temporary.
1975 * docutils/statemachine.py:
1977   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1978   - Added underscores to improve many awkward names.
1979   - In ``string2lines()``, changed whitespace normalizing translation
1980     table to regexp; restores Python 2.0 compatibility with Unicode.
1982 * docutils/urischemes.py:
1984   - Filled in some descriptions.
1985   - Added "shttp" scheme.
1987 * docutils/utils.py:
1989   - Added ``clean_rcs_keywords`` function (moved from
1990     docutils/transforms/frontmatter.py
1991     ``DocInfo.filter_rcs_keywords``).
1992   - Added underscores to improve many awkward names.
1993   - Changed names of Reporter's thresholds:
1994     warning_level -> report_level; error_level -> halt_level.
1995   - Moved ``utils.id()`` to ``nodes.make_id()``.
1996   - Added ``relative_path(source, target)``.
1998 * docutils/languages/de.py: German mappings; added to project.  Thanks
1999   to Gunnar Schwant for the translations.
2001 * docutils/languages/en.py: Added "Dedication" bibliographic field
2002   mappings.
2004 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2005   Chodorowski.
2007 * docutils/parsers/rst/states.py:
2009   - Added underscores to improve many awkward names.
2010   - Added RFC-2822 header support.
2011   - Extracted the inline parsing code from ``RSTState`` to a separate
2012     class, ``Inliner``, which will allow easy subclassing.
2013   - Made local bindings for ``memo`` container & often-used contents
2014     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2015   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2016   - Added ``MarkupMismatch`` exception; for late corrections.
2017   - Added ``-/:`` characters to inline markup's start string prefix,
2018     ``/`` to end string suffix.
2019   - Fixed a footnote bug.
2020   - Fixed a bug with literal blocks.
2021   - Applied patch from Simon Budig: simplified regexps with symbolic
2022     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2023   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2024   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2025   - Allowed non-ASCII in "simple names" (directive names, field names,
2026     references, etc.).
2027   - Converted ``Inliner.patterns.initial`` to be dynamically built
2028     from parts with ``build_regexp()`` function.
2029   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2030   - Updated docstrings.
2031   - Changed "table" to "grid_table"; added "simple_table" support.
2033 * docutils/parsers/rst/tableparser.py:
2035   - Changed ``TableParser`` to ``GridTableParser``.
2036   - Added ``SimpleTableParser``.
2037   - Refactored naming.
2039 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2040   a fallback language for directive names.
2042 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2043   directive to use a ``pending`` element, used only by HTML writers.
2045 * docutils/parsers/rst/directives/parts.py: Renamed from
2046   components.py.
2048   - Added "backlinks" attribute to "contents" directive.
2050 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2051   project by Adam Chodorowski.
2053 * docutils/readers/__init__.py: Gave Readers more control over
2054   choosing and instantiating Parsers.
2056 * docutils/readers/pep.py: Added to project; for PEP processing.
2058 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2059   requires a ``component`` parameter.
2061 * docutils/transforms/components.py: Added to project; transforms
2062   related to Docutils components.
2064 * docutils/transforms/frontmatter.py:
2066   - In ``DocInfo.extract_authors``, check for a single "author" in an
2067     "authors" group, and convert it to a single "author" element.
2068   - Added support for "Dedication" and generic bibliographic fields.
2070 * docutils/transforms/peps.py: Added to project; PEP-specific.
2072 * docutils/transforms/parts.py: Renamed from old components.py.
2074   - Added filter for `Contents`, to use alt-text for inline images,
2075     and to remove inline markup that doesn't make sense in the ToC.
2076   - Added "name" attribute to TOC topic depending on its title.
2077   - Added support for optional TOC backlinks.
2079 * docutils/transforms/references.py: Fixed indirect target resolution
2080   in ``Hyperlinks`` transform.
2082 * docutils/transforms/universal.py:
2084   - Changed ``Messages`` transform to properly filter out system
2085     messages below the warning threshold.
2086   - Added ``Decorations`` transform (support for ``--generator``,
2087     ``--date``, ``--time``, ``--source-link`` options).
2089 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2090   Engelbert Gruber's PDF writer.
2092 * docutils/writers/html4css1.py:
2094   - Made XHTML-compatible (switched to lowercase element & attribute
2095     names; empty tag format).
2096   - Escape double-dashes in comment text.
2097   - Improved boilerplate & modularity of output.
2098   - Exposed modular output in Writer class.
2099   - Added a "generator" meta tag to <head>.
2100   - Added support for the ``--stylesheet`` option.
2101   - Added support for ``decoration``, ``header``, and ``footer``
2102     elements.
2103   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2104     translation table to regexp; restores Python 2.0 compatibility
2105     with Unicode.
2106   - Added the translator class as instance variable to the Writer, to
2107     make it easily subclassable.
2108   - Improved option list spacing (thanks to Richard Jones).
2109   - Modified field list output.
2110   - Added backlinks to footnotes & citations.
2111   - Added percentage widths to "<col>" tags (from colspec).
2112   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2113     "<span>" changed to "<var>".
2114   - Inline literals: "<code>" changed to "<tt>".
2115   - Many changes to optimize vertical space: compact simple lists etc.
2116   - Add a command-line options & directive attributes to control TOC
2117     and footnote/citation backlinks.
2118   - Added support for optional footnote/citation backlinks.
2119   - Added support for generic bibliographic fields.
2120   - Identify backrefs.
2121   - Relative URLs for stylesheet links.
2123 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2124   PEPs (subclass of ``html4css1.Writer``).
2126 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2128 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2129   of the Docutils internal doctree in XML.
2131 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2133 * spec/doctree.txt:
2135   - Changed the title to "The Docutils Document Tree".
2136   - Added "Hyperlink Bookkeeping" section.
2138 * spec/docutils.dtd:
2140   - Added ``decoration``, ``header``, and ``footer`` elements.
2141   - Brought ``interpreted`` element in line with the parser: changed
2142     attribute "type" to "role", added "position".
2143   - Added support for generic bibliographic fields.
2145 * spec/notes.txt: Continual updates.  Added "Project Policies".
2147 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2148   section.
2150 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2152 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2153   mailing list discussions.
2155 * spec/pep-0287.txt:
2157   - Renamed to "reStructuredText Docstring Format".
2158   - Minor edits.
2159   - Reworked Q&A as an enumerated list.
2160   - Converted to reStructuredText format.
2162 * spec/pysource.dtd:
2164   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2166 * spec/pysource.txt: Removed from project.  Moved much of its contents
2167   to pep-0258.txt.
2169 * spec/rst/alternatives.txt:
2171   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2172   - Added "Inline External Targets" section.
2174 * spec/rst/directives.txt:
2176   - Added "backlinks" attribute to "contents" directive.
2178 * spec/rst/problems.txt:
2180   - Updated the Enumerated List Markup discussion.
2181   - Added new alternative table markup syntaxes.
2183 * spec/rst/reStructuredText.txt:
2185   - Clarified field list usage.
2186   - Updated enumerated list description.
2187   - Clarified purpose of directives.
2188   - Added ``-/:`` characters to inline markup's start string prefix,
2189     ``/`` to end string suffix.
2190   - Updated "Authors" bibliographic field behavior.
2191   - Changed "inline hyperlink targets" to "inline internal targets".
2192   - Added "simple table" syntax to supplement the existing but
2193     newly-renamed "grid tables".
2194   - Added cautions for anonymous hyperlink use.
2195   - Added "Dedication" and generic bibliographic fields.
2197 * test: Made test modules standalone (subdirectories became packages).
2199 * test/DocutilsTestSupport.py:
2201   - Added support for PEP extensions to reStructuredText.
2202   - Added support for simple tables.
2203   - Refactored naming.
2205 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2207   - Now supports true packages containing test modules
2208     (``__init__.py`` files required); fixes duplicate module name bug.
2210 * test/test_pep/: Subpackage added to project; PEP testing.
2212 * test/test_rst/test_SimpleTableParser.py: Added to project.
2214 * tools:
2216   - Updated html.py and publish.py front-end tools to use the new
2217     command-line processing facilities of ``docutils.frontend``
2218     (exposed in ``docutils.core.Publisher``), reducing each to just a
2219     few lines of code.
2220   - Added ``locale.setlocale()`` calls to front-end tools.
2222 * tools/buildhtml.py: Added to project; batch-generates .html from all
2223   the .txt files in directories and subdirectories.
2225 * tools/default.css:
2227   - Added support for ``header`` and ``footer`` elements.
2228   - Added styles for "Dedication" topics (biblio fields).
2230 * tools/docutils.conf: A configuration file; added to project.
2232 * tools/docutils-xml.py: Added to project.
2234 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2236 * tools/pep-html-template: Added to project.
2238 * tools/pep2html.py: Added to project from Python (nondist/peps).
2239   Added support for Docutils (reStructuredText PEPs).
2241 * tools/quicktest.py:
2243   - Added the ``--attributes`` option, hacked a bit.
2244   - Added a second command-line argument (output file); cleaned up.
2246 * tools/stylesheets/: Subdirectory added to project.
2248 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2251 Release 0.1 (2002-04-20)
2252 ========================
2254 This is the first release of Docutils, merged from the now inactive
2255 reStructuredText__ and `Docstring Processing System`__ projects.  For
2256 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2257 `DPS HISTORY`__ files.
2259 __ http://structuredtext.sourceforge.net/
2260 __ http://docstring.sourceforge.net/
2261 __ http://structuredtext.sourceforge.net/HISTORY.html
2262 __ http://docstring.sourceforge.net/HISTORY.html
2264 General changes: renamed 'dps' package to 'docutils'; renamed
2265 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2266 the test suites (reStructuredText's test/test_states renamed to
2267 test/test_rst); and all modifications required to make it all work.
2269 * docutils/parsers/rst/states.py:
2271   - Improved diagnostic system messages for missing blank lines.
2272   - Fixed substitution_reference bug.
2276    Local Variables:
2277    mode: indented-text
2278    indent-tabs-mode: nil
2279    sentence-end-double-space: t
2280    fill-column: 70
2281    End: