Expand description of --use-latex-toc option.
[docutils.git] / HISTORY.txt
blob22fadf854e4fad9a6c42d86d2d71f6d0f20fe62b
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   - Fix: Do not escape underscores in citation reference labels if
86     use-latex-citations is set.
87   - Use centering instead of center for figure contents, to avoid vertical
88     space.
89   - Recognize table class: borderless, nolines, booktabs, standard.
90   - Fix: Renaming contents section does not work with latex writer; SF
91     bug #1487405.
92   - Applied patch for custom roles with classes from Edward Loper.
93   - Fixed bug that caused crashes with more than 256 lists.
95 * docutils/writers/pep_html/__init__.py:
97   - Changed to support new python.org website structure and
98     pep2pyramid.py.
100 * tools/editors/emacs/rst.el:
102   - Changed license to "GPL".
103   - Added ``rst-straighten-decorations`` function.
104   - The ``compile`` module is now always loaded.
105   - Added ``rst-toggle-line-block`` function.
106   - Headings consisting only of non-ASCII characters are now
107     recognized by ``rst-toc`` and ``rst-adjust``.
108   - Added font-lock support for multi-line comments where the first
109     comment line is empty.
110   - Added ``(require 'font-lock)``.
112 * setup.py:
114   - Provide descriptive error message if distutils is missing.
117 Release 0.4 (2006-01-09)
118 ========================
120 * General:
122   - Updated the project policies for trunk/branch development &
123     version numbering.
125 * docutils/__init__.py:
127   - Added ``__version_details__`` attribute to describe code source
128     (repository/snapshot/release).
129   - Replaced ``default_transforms`` attribute of TransformSpec with
130     ``get_transforms()`` method.
132 * docutils/core.py:
134   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
135     functions, for document tree extraction and reprocessing.
137 * docutils/io.py:
139   - Added ``DocTreeInput`` class, for reprocessing existing documents.
140   - Added support for non-Unicode (e.g. binary) writer output.
142 * docutils/nodes.py:
144   - Re-introduced ``Targetable.indirect_reference_name``, for
145     MoinMoin/reST compatibility (removed in r3124/r3129).
146   - Added ``serial_escape`` function; escapes string values that are
147     elements of a list, for serialization.  Modified Docutils-XML
148     writing (``Element._dom_node``) and pseudo-XML writing
149     (``Element.starttag``) to use ``serial_escape``.
150   - Added ``Node.deepcopy()`` method.
151   - Removed the internal lists ``document.substitution_refs``,
152     ``document.anonymous_refs``, and ``document.anonymous_targets``.
153   - Added a "container" element.
154   - Fixed bug where values of list-valued attributes of elements
155     originating from custom interpreted text roles (i.e., with custom
156     classes) were being shared between element instances.  Reported by
157     Shmuel Zeigerman.
159 * docutils/statemachine.py:
161   - Added trailing whitespace stripping to ``string2lines()``.
162   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
163     Asian double-width character support.
165 * docutils/utils.py:
167   - Added ``east_asian_column_width()`` for double-width character
168     support.
170 * docutils/languages/ja.py: Added to project: Japanese mappings by
171   Hisashi Morita.
173 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
174   mappings by Panjunyong.
176 * docutils/parsers/null.py: Added to project; a do-nothing parser.
178 * docutils/parsers/rst/__init__.py:
180   - Added validator to tab_width setting, with test.  Closes SF bug
181     #1212515, report from Wu Wei.
183 * docutils/parsers/rst/states.py:
185   - Fixed bug with escaped colons indicating a literal block.
186   - Fixed bug with enumerated lists (SF#1254145).
187   - Backslash-escaped colons inside of field names are now allowed.
188   - Targets (implicit and explicit), anonymous hyperlink references
189     and auto-numbered footnote references inside of substitution
190     definitions are now disallowed.
191   - Fixed bug: list items with blank first lines.
192   - Fixed bug: block quote attributions with indented second lines.
193   - Added East Asian double-width character support (Python 2.4 only).
195 * docutils/parsers/rst/tableparser.py:
197   - Added East Asian double-width character support (Python 2.4 only).
199 * docutils/parsers/rst/directives/body.py:
201   - Added the "container" directive.
203 * docutils/parsers/rst/directives/misc.py:
205   - Added the "default-role", "title", and "date" directives.
206   - Added standard data file syntax to the "include" directive.
207   - Added support for "class" directive content.
209 * docutils/parsers/rst/directives/images.py:
211   - Added ``indirect_reference_name`` support for images with a target
212     option.
213   - Added support for image width and height units.
214   - Fixed bug with image "target" options.
216 * docutils/parsers/rst/directives/references.py:
218   - Added "class" attribute to "target-notes" directive, for
219     footnote_reference classes.
221 * docutils/parsers/rst/include/: Directory added to project; contains
222   standard data files for the "include" directive.  Initial contents:
223   character entity substitution definition sets, and a set of
224   definitions for S5/HTML presentations.
226 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
227   mappings by David Goodger.
228   
229 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
230   Simplified Chinese mappings by Panjunyong.
232 * docutils/readers/__init__.py:
234   - Added universal.Decorations and universal.ExposeInternals
235     transforms as default transforms for all readers.
236   - Added ``ReReader`` base class for readers that reread an existing
237     document tree.
239 * docutils/readers/doctree.py: Added to project; a reader for existing
240   document trees.
242 * docutils/transforms/frontmatter.py:
244   - Fixed the DocInfo transform to handle SVN-style expansion of the
245     "Date" keyword.
246   - In ``DocInfo.extract_authors``, treat the contents of "authors"
247     fields uniformly.
249 * docutils/transforms/misc.py:
251   - Added misc.Transitions transform, extracted from
252     universal.FinalChecks.
254 * docutils/transforms/references.py:
256   - Added references.DanglingReferences transform, extracted from
257     universal.FinalChecks.
258   - Fixed bug with doubly-indirect substitutions.
259   - Added footnote_reference classes attribute to "TargetNotes".
260   - Fixed bug with circular substitution definitions that put Docutils
261     into an infinite loop.
263 * docutils/transforms/universal.py:
265   - Added universal.ExposeInternals transform, extracted from
266     universal.FinalChecks.
267   - Removed universal.FinalChecks transform (logic has been moved to
268     several new transforms).
269   - Fixed bug with the "expose_internals" setting and Text nodes
270     (exposed by the "rawsource" internal attribute).
271   - Added the universal.StripComments transform, implementation of the
272     "strip_comments" setting.
274 * docutils/transforms/writer_aux.py: Added to project; auxiliary
275   transforms for writers.
277   - Added ``Compound`` transform, which flattens compound paragraphs.
279 * docutils/writers/: Several writer modules (html4css1.py) were
280   converted into packages.  Support modules and data files have been
281   moved into the packages.  The stylesheets for the HTML writers are
282   now installed along with the code, the code knows where to find
283   them, and the default is to use them (actually, to embed them).
284   Some adjustments to configuration files may be necessary.  The
285   easiest way to obtain the new default behavior is to remove all
286   settings whose name includes "stylesheet".
288 * docutils/writers/__init__.py:
290   - Added universal.Messages and universal.FilterMessages transforms
291     as default transforms for all writers.
292   - Added ``UnfilteredWriter`` base class for writers that pass the
293     document tree on unchanged.
295 * docutils/writers/docutils_xml.py:
297   - Made ``xmlcharrefreplace`` the default output encoding error
298     handler.
300 * docutils/writers/html4css1/: 
302   - Added support for image width and height units.
303   - Made ``xmlcharrefreplace`` the default output encoding error
304     handler.
305   - Made ``--embed-stylesheet`` the default rather than
306     ``--link-stylesheet``.
307   - Moved "id" attribute from container (section etc.) to title's <a>
308     tag, to be on the same tag as "name".
309     (!!! To be reverted in Docutils 0.5.)
310   - Added vertical space between fields of field lists.
311   - Added ``--compact-field-lists`` option to remove vertical space in
312     simple field lists.
313   - Made cloaking of email addresses with ``--cloak-email-addresses``
314     less obtrusive.
315   - Fixed support for centered images.
316   - Added support for class="compact" & class="open" lists.
318 * docutils/writers/latex2e/:
320   - Underscores in citekeys are no longer escaped.
322 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
323   mapping of Unicode characters to LaTeX equivalents.
325 * docutils/writers/s5_html/: Package added to project; writer for
326   S5/HTML slide shows.
328 * docs/dev/distributing.txt: Added to project; guide for distributors
329   (package maintainers).
331 * docs/dev/hacking.txt: Added to project; guide for developers.
333 * docs/ref/doctree.txt:
335   - Updated for plural attributes "classes", "ids", "names",
336     "dupnames".
337   - Added the "container" element.
339 * docs/ref/docutils.dtd:
341   - Updated for plural attributes "classes", "ids", "names",
342     "dupnames".
344 * docs/user/emacs.txt: Added to project; a document about Emacs
345   support for reStructuredText and Docutils.
347 * docs/user/links.txt: Added to project; lists of Docutils-related
348   links.
350 * docs/user/mailing-lists.txt: Added to project; information about
351   Docutils-related mailing lists and how to access them.
353 * docs/user/slide-shows.txt: Added to project; example of and docs for
354   the S5/HTML writer (``rst2s5.py`` front end).
356 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
357   Files", added to project.
359 * test/coverage.sh: Added to project; test coverage script.
361 * test/DocutilsTestSupport.py:
363   - Added support for specifying runtime settings at the suite level.
365 * test/test_functional.py:
367   - Added the ``clear_output_directory`` function.
368   - Added support for ``_test_more`` functions in functional test
369     config files.
371 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
373 * tools/rstpep2html.py: Renamed from pep.py.
375 * tools/dev/create_unimap.py: Added to project; script to create the
376   docutils/writers/unimap_latex.py mapping file.
378 * tools/dev/profile_docutils.py: Added to project; profiler script.
380 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
382 * tools/editors/emacs/restructuredtext.el,
383   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
384   Removed from project; the functionality is now contained in rst.el.
386 * tools/editors/emacs/rst.el: Added to project.  Added many features
387   and fixed many bugs.  See docs/user/emacs.txt for details.
389 * tools/stylesheets: Removed from project.  Stylesheets have been
390   renamed and moved into writer packages.
393 Release 0.3.9 (2005-05-26)
394 ==========================
396 * General:
398   - Eliminated and replaced all uses of the old string attributes
399     ``id``, ``name``, ``dupname`` and ``class`` with references to the
400     new list attributes ``ids``, ``names``, ``dupnames`` and
401     ``classes`` throughout the whole source tree.
403 * docutils/core.py:
405   - Enabled ``--dump-*`` options when ``--traceback`` specified,
406     allowing for easier debugging.
407   - In ``Publisher.publish()``, expanded the generic top-level
408     exception catching.
410 * docutils/examples.py:
412   - Added ``internals`` function for exploration.
414 * docutils/io.py:
416   - Fixed ``Input.decode`` method to apply heuristics only if no
417     encoding is explicitly given, and to provide better reporting of
418     decoding errors.
419   - The ``Input.decode`` method now removes byte order marks (BOMs)
420     from input streams.
422 * docutils/nodes.py:
424   - ``image`` element class changed to subclass of Element, not
425     TextElement (it's an empty element, and cannot contain text).
426   - Added ``attr_defaults`` dictionary for default attribute values.
427   - Added empty list as default value for the following attributes:
428     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
429   - Added ``document.decoration`` attribute,
430     ``document.get_decoration`` method, and ``decoration.get_header``
431     & ``.get_footer`` methods.
432   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
433     methods.
435 * docutils/utils.py:
437   - Removed ``docutils.utils.Reporter.categories``,
438     ``docutils.utils.ConditionSet``, and all references to them, to
439     simplify error reporting.
441 * docutils/languages/nl.py: Added to project; Dutch mappings by
442   Martijn Pieters.
444 * docutils/parsers/rst/__init__.py:
446   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
448 * docutils/parsers/rst/states.py:
450   - Added check for escaped at-mark to prevent email address recognition.
451   - Fixed option lists to allow spaces inside ``<angle-bracketed option
452     arguments>``.
453   - Allowed whitespace in paths and URLs.
454   - Added auto-enumerated list items.
455   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
456     followed by text.
457   - Added support for table stub columns.
459 * docutils/parsers/rst/directives/__init__.py:
461   - Allowed whitespace in paths (``path`` function).
462   - Added ``uri`` directive option conversion function.
464 * docutils/parsers/rst/directives/body.py:
466   - Fixed illegal context bug with "topic" directive (allowed within
467     sidebars; not within body elements).
469 * docutils/parsers/rst/directives/images.py:
471   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
472   - Added support for the ``file_insertion_enabled`` setting in the
473     "figure" directive (disables "figwidth" option).
474   - "image" directive: added checks for valid values of "align" option,
475     depending on context.  "figure" directive: added specialized
476     "align" option and attribute on "figure" element.
477   - Made ":figwidth: image" option of "figure" directive work again.
478   - Fixed bug with reference names containing uppercase letters
479     (e.g. ``Name_``) in "target" option of "image" directive.
481 * docutils/parsers/rst/directives/misc.py:
483   - Fixed "include" and "raw" directives to catch text decoding
484     errors.
485   - Allowed whitespace in "include" & "raw" directive paths.
486   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
487     settings in "include" & "raw" directives.
489 * docutils/parsers/rst/directives/parts.py:
491   - Added "header" & "footer" directives.
492   - Fixed illegal context bug with "contents" directive (topics
493     allowed within sidebars; not within body elements).
495 * docutils/parsers/rst/directives/tables.py:
497   - Added "list-table" directive.
498   - Caught empty CSV table bug.
499   - Added support for the ``file_insertion_enabled`` setting in the
500     "csv-table" directive.
501   - Added ``stub-columns`` option to "csv-table" and "list-table"
502     directives.
504 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
505   mappings by Martijn Pieters.
507 * docutils/readers/standalone.py:
509   - Added ``--section-subtitles`` and ``--no-section-subtitles``
510     options to activate or deactivate the SectSubTitle transform.
512 * docutils/transforms/frontmatter.py:
514   - Added SectSubTitle transform to promote titles of lone
515     subsections to subtitles.
517 * docutils/transforms/references.py:
519   - Fixed mislocated internal targets bug, by propagating internal
520     targets to the next node, making use of the newly added support
521     for multiple names and IDs.
522   - Fixed duplicate footnote label bug.
523   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
524     transform.
526 * docutils/writers/html4css1.py:
528   - Fixed unencoded stylesheet reference bug (characters like "&" in
529     stylesheet references).
530   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
531     tags).
532   - Added support for multiple IDs per node by creating empty ``span``
533     tags.
534   - Added the ``field_name_limit`` & ``option_limit`` settings &
535     support.
536   - Added support for table stub columns.
537   - Added support for the ``align`` attribute on ``figure`` elements.
538   - Added the ``cloak_email_addresses`` setting & support.
539   - Added ``html_prolog``, ``html_head``, ``html_body``,
540     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
541     ``docutils.core.publish_parts``.
542   - Added support for section subtitles.
544 * docutils/writers/latex2e.py:
546   - Fixed tables starting with more than one multirow cell.
547   - Improved --use-latex-docinfo so that organization/contact/address
548     fields are lumped with the last author field and appear on the
549     titlepage.
550   - Made sure the titlepage is always shown with --use-latex-docinfo,
551     even if the document has no title.
552   - Made sure that latex doesn't fill in today's date if no date field
553     was given.
554   - Added support for section subtitles.
556 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
557   (under development).
559 * docutils/writers/null.py: Added to project; a do-nothing Writer.
561 * docs/api/publisher.txt:
563   - Added "``publish_parts`` Details" section.
565 * docutils/dev/repository.txt: Added to project; information about the
566   Docutils Subversion repository.
568 * docs/ref/docutils.dtd:
570   - Added a ``stub`` attribute to the ``colspec`` element via the
571     ``tbl.colspec.att`` parameter entity.
572   - Allowed topic elements within sidebars
573   - Added an ``align`` attribute to the ``figure`` element.
575 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
576   writer.
579 Release 0.3.7 (2004-12-24)
580 ==========================
582 * docutils/frontend.py:
584   - Added options: --input-encoding-error-handler,
585     --record-dependencies, --leave-footnote-reference-space,
586     --strict-visitor.
587   - Added command-line and config file support for "overrides" setting
588     parameter.
590 * docutils/io.py:
592   - Added support for input encoding error handler.
594 * docutils/nodes.py:
596   - Added dispatch_visit and dispatch_departure methods to
597     NodeVisitor; useful as a hook for Visitors.
598   - Changed structure of ``line_block``; added ``line``.
599   - Added ``compound`` node class.
600   - Added a mechanism for Visitors to transitionally ignore new node
601     classes.
603 * docutils/utils.py:
605   - Moved ``escape2null`` and ``unescape`` functions from
606     docutils/parsers/rst/states.py.
608 * docutils/parsers/rst/roles.py:
610   - Added "raw" role.
611   - Changed role function API: the "text" parameter now takes
612     null-escaped interpreted text content.
614 * docutils/parsers/rst/states.py:
616   - Fixed bug where a "role" directive in a nested parse would crash
617     the parser; the state machine's "language" attribute was not being
618     copied over.
619   - Added support for line block syntax.
620   - Fixed directive parsing bug: argument-less directives didn't
621     notice that arguments were present.
622   - Removed error checking for transitions.
623   - Added support for multiple classifiers in definition list items.
624   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
625   - Changed role function API: the "text" parameter now takes
626     null-escaped interpreted text content.
627   - Empty sections and documents are allowed now.
629 * docutils/parsers/rst/directives/__init__.py:
631   - Added ``encoding`` directive option conversion function.
632   - Allow multiple class names in class_option conversion function.
634 * docutils/parsers/rst/directives/body.py:
636   - Converted the line-block directive to use the new structure.
637   - Extracted the old line-block functionality to the ``block``
638     function (still used).
639   - Added ``compound`` directive (thanks to Felix Wiemann).
641 * docutils/parsers/rst/directives/misc.py:
643   - Added "encoding" option to "include" and "raw" directives.
644   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
645   - Allow multiple class names in the "class" directive.
647 * docutils/parsers/rst/directives/parts.py:
649   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
650     options.  Thanks to Lele Gaifax.
652 * docutils/parsers/rst/directives/tables.py:
654   - Added "encoding" directive to "csv-table" directive.
655   - Added workaround for lack of Unicode support in csv.py, for
656     non-ASCII CSV input.
658 * docutils/transforms/misc.py:
660   - Fixed bug when multiple "class" directives are applied to a single
661     element.
662   - Enabled multiple format names for "raw" directive.
664 * docutils/transforms/references.py:
666   - Added support for trimming whitespace from beside substitution
667     references.
669 * docutils/transforms/universal.py:
671   - FinalChecks now checks for illegal transitions and moves
672     transitions between sections.
674 * docutils/writers/html4css1.py:
676   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
677   - "stylesheet" and "stylesheet_path" settings are now mutually
678     exclusive.
679   - Added support for the new line_block/line structure.
680   - --footnote-references now overrides
681     --trim-footnote-reference-space, if applicable.
682   - Added support for ``compound`` elements.
683   - Enabled multiple format names for "raw" directive.
684   - ``<p>`` tags of a paragraph which is the only visible child of the
685     document node are no longer stripped.
686   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
687     new method ``should_be_compact_paragraph()``.
688   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
689     elements.
690   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
691     the output if they have their ``class`` attribute set.
692   - The whole document is now surrounded by a ``<div
693     class="document">`` element.
694   - Body-level images are now wrapped by their own ``<div>`` elements,
695     with image classes copied to the wrapper, and for images which
696     have the ``:align:`` option set, the surrounding ``<div>`` now
697     receives a class attribute (like ``class="align-left"``).
699 * docutils/writers/latex2e.py:
701   - no newline after depart_term.
702   - Added translations for some Unicode quotes.
703   - Added option "font-encoding", made package AE the default.
704   - "stylesheet" and "stylesheet_path" settings are now mutually
705     exclusive.
706   - --footnote-references now overrides
707     --trim-footnote-reference-space, if applicable.
708   - The footnote label style now matches the footnote reference style
709     ("brackets" or "superscript").
710   - Added support for ``compound`` elements.
711   - Enabled multiple format names for "raw" directive.
713 * docs/ref/docutils.dtd:
715   - Changed structure of the ``line_block`` element; added ``line``.
716   - Added ``compound`` element.
717   - Added "ltrim" and "rtrim" attributes to
718     ``substitution_definition`` element.
719   - Enabled multiple format names for ``raw`` element.
720   - Enabled multiple classifiers in ``definition_list_item`` elements.
722 * docs/ref/rst/directives.txt
724   - Marked "line-block" as deprecated.
725   - "Class" directive now allows multiple class names.
726   - Added "Rationale for Class Attribute Value Conversion".
727   - Added warning about "raw" overuse/abuse.
729 * docs/ref/rst/restructuredtext.txt:
731   - Added syntax for line blocks.
732   - Definition list items may have multiple classifiers.
734 * docs/ref/rst/roles.txt:
736   - Added "raw" role.
738 * tools/stylesheets/default.css:
740   - Added support for the new line_block structure.
741   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
744 Release 0.3.5 (2004-07-29)
745 ==========================
747 General:
749 * _`Documentation cleanup/reorganization`.
751   - Created new subdirectories of docs/:
753     * ``docs/user/``: introductory/tutorial material for end-users
754     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
755     * ``docs/api/``: API reference material for client-developers
756     * ``docs/ref/``: reference material for all groups
757     * ``docs/howto/``: for component-developers and core-developers
758     * ``docs/peps/``: Python Enhancement Proposals
760   - Moved ``docs/*`` to ``docs/user/``.
761   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
762     ``spec/`` to ``docs/dev``.
763   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
764     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
765   - Moved ``alternatives.txt``, and ``problems.txt`` from
766     ``spec/rst/`` to ``docs/dev/rst/``.
767   - Moved ``reStructuredText.txt``, ``directives.txt``,
768     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
769     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
770     ``roles.txt``, ``reStructuredText.txt`` to
771     ``restructuredtext.txt``.
772   - Moved ``spec/howto/`` to ``docs/howto``.
774   In order to keep the CVS history of moved files, we supplied
775   SourceForge with a `script for modifying the Docutils CVS
776   repository`__.
778   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
780   After running the cleanup script:
782   - Added ``docs/index.txt``.
783   - Added a ``.htaccess`` file to the ``web`` module, containing
784     redirects for all old paths to new paths.  They'll preserve
785     fragments (the "#name" part of a URL), and won't clutter up the
786     file system, and will correct the URL in the user's browser.
787   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
788     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
789     the "To Do" list itself in ``docs/dev/todo.txt``.
790   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
791     section of ``docs/dev/todo.txt``.
792   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
793   - Added "How To Report Bugs" to ``BUGS.txt``.
794   - Went through all the sources and docs (including under web/) and
795     updated links.  Mostly done by Felix Wiemann; thanks Felix!
796     (Still need to update links in the sandboxes.)
798 Specific:
800 * BUGS.txt: Added to project.
802 * THANKS.txt: Added to project.
804 * docutils/__init__.py:
806   - 0.3.4: Post-release.
808 * docutils/core.py:
810   - Added special error handling & advice for UnicodeEncodeError.
811   - Refactored Publisher.publish (simplified exception handling &
812     extracted debug dumps).
813   - Renamed "enable_exit" parameter of convenience functions to
814     "enable_exit_status".
815   - Enabled traceback (exception propagation) by default in
816     programmatic convenience functions.
817   - Now publish_file and publish_cmdline convenience functions return
818     the encoded string results in addition to their regular I/O.
819   - Extracted common code from publish_file, publish_string, and
820     publish_parts, into new publish_programmatically.  Extracted
821     settings code to ``Publisher.process_programmatic_settings``.
822   - In Publisher.publish, disabled ``settings_overrides`` when
823     ``settings`` is supplied; redundant.
825 * docutils/frontend.py:
827   - Added help text for "--output-encoding-error-handler" and
828     "--error-encoding-error-handler".
829   - Renamed "--exit" to "--exit-status".
830   - Simplified default-setting code.
832 * docutils/parsers/rst/__init__.py:
834   - Added "--pep-base-url" and "--rfc-base-url" options.
836 * docutils/parsers/rst/states.py:
838   - Made URI recognition more aggressive and intelligent.
840 * docutils/parsers/rst/directives/__init__.py:
842   - Added several directive option conversion functions.
844 * docutils/parsers/rst/directives/body.py:
846   - Moved "table" directive to tables.py.
848 * docutils/parsers/rst/directives/tables.py: Table-related directives,
849   added to project.
851 * docutils/writers/latex2e.py:
853   - Added "--table-style=(standard|booktabs|nolines)"
854   - figures get "here" option (LaTeX per default puts them at bottom),
855     and figure content is centered.
856   - Rowspan support for tables.
857   - Fix: admonition titles before first section.
858   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
859   - Replave ``_`` in literal by an underlined blank, because it has the correct
860     width.
861   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
862   - A few unicode replacements, if output_encoding != utf
863   - Add "--graphicx-option".
864   - Indent literal-blocks.
865   - Fix: omit ``\maketitle`` when there is no document title.
867 * docs/index.txt: "Docutils Project Documentation Overview", added to
868   project.
870 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
871   Tool", added to project.
873 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
875 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
877 * docs/dev/policies.txt: Added to project (extracted from
878   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
880 * docs/dev/release.txt: Added to project (extracted from
881   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
883 * docs/dev/testing.txt: Added to project.
885 * docs/dev/website.txt: Added to project (extracted from
886   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
888 * docs/ref/rst/directives.txt:
890   - Added directives: "table", "csv-table".
892 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
893   added to project.  1 page for syntax, and a 1 page reference for
894   directives and roles.  Source text to be used as-is; not meant to be
895   converted to HTML.
897 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
898   with a change of title.
900 * test/functional/, contents, and test/test_functional.py: Added to
901   project.
903 * tools/buildhtml.py: Fixed bug with config file handling.
905 * tools/html.py: Removed from project (duplicate of rst2html.py).
907 * tools/pep2html.py: Removed from project (duplicate of Python's
908   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
909   Docutils-related PEPs in docs/peps/).
911 * tools/rst2pseudoxml.py: Renamed from publish.py.
913 * tools/rst2xml.py: Renamed from docutils-xml.py.
915 * tools/test.txt: Removed from project; moved to
916   docs/user/rst/demo.txt.
918 * setup.py: Now also installs ``rst2latex.py``.
921 Release 0.3.3 (2004-05-09)
922 ==========================
924 * docutils/__init__.py:
926   - 0.3.1: Reorganized config file format (multiple sections); see
927     docs/config.txt.
928   - Added unknown_reference_resolvers attribute to TransformSpec.
929   - 0.3.2: Interpreted text reorganization.
930   - 0.3.3: Released.
932 * docutils/core.py:
934   - Catch system messages to stop tracebacks from parsing errors.
935   - Catch exceptions during processing report & exit without
936     tracebacks, except when "--traceback" used.
937   - Reordered components for OptionParser; application comes last.
938   - Added "config_section" parameter to several methods and functions,
939     allowing front ends to easily specify their config file sections.
940   - Added publish_parts convenience function to allow access to individual
941     parts of a document.
943 * docutils/examples.py: Added to project; practical examples of
944   Docutils client code, to be used as-is or as models for variations.
946 * docutils/frontend.py:
948   - Added "--traceback" & "--no-traceback" options ("traceback"
949     setting).
950   - Implemented support for config file reorganization:
951     ``standard_config_files`` moved from ``ConfigParser`` to
952     ``OptionParser``; added
953     ``OptionParser.get_config_file_settings()`` and
954     ``.get_standard_config_settings()``; support for old "[options]"
955     section (with deprecation warning) and mapping from old to new
956     settings.
957   - Reimplemented setting validation.
958   - Enabled flexible boolean values: yes/no, true/false, on/off.
959   - Added ``Values``, a subclass of ``optparse.Values``, with support
960     for list setting attributes.
961   - Added support for new ``DOCUTILSCONFIG`` environment variable;
962     thanks to Beni Cherniavsky.
963   - Added "--no-section-numbering" option.
965 * docutils/io.py:
967   - Catch IOErrors when opening source & destination files, report &
968     exit without tracebacks.  Added ``handle_io_errors`` parameter to
969     ``FileInput`` & ``FileOutput`` to enable caller error handling.
971 * docutils/nodes.py:
973   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
974     method definitions (via ``exec``) to dynamic assignments (via
975     ``setattr``); thanks to Roman Suzi.
976   - Encapsulated visitor dynamic assignments in a function; thanks to
977     Ian Bicking.
978   - Added indirect_reference_name attribute to the Targetable
979     class. This attribute holds the whitespace_normalized_name
980     (contains mixed case) of a target.
982 * docutils/statemachine.py:
984   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
985   - Added ``StringList.get_2D_block``.
987 * docutils/utils.py:
989   - Added "level" attribute to SystemMessage exceptions.
991 * docutils/languages/af.py: Added to project; Afrikaans mappings by
992   Jannie Hofmeyr.
994 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
995   Blaha.
997 * docutils/languages/eo.py: Added to project; Esperanto mappings by
998   Marcelo Huerta San Martin.
1000 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1001   mappings by Lalo Martins.
1003 * docutils/languages/ru.py: Added to project; Russian mappings by
1004   Roman Suzi.
1006 * docutils/parsers/rst/roles.py: Added to project.  Contains
1007   interpreted text role functions, a registry for interpreted text
1008   roles, and an API for adding to and retrieving from the registry.
1009   Contributed by Edward Loper.
1011 * docutils/parsers/rst/states.py:
1013   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1014   - Allowed true em-dash character and "---" as block quote
1015     attribution marker.
1016   - Added support for <angle-bracketed> complex option arguments
1017     (option lists).
1018   - Fixed handling of backslashes in substitution definitions.
1019   - Fixed off-by-1 error with extra whitespace after substitution
1020     definition directive.
1021   - Added inline markup parsing to field lists' field names.
1022   - Added support for quoted (and unindented) literal blocks.
1023     Driven in part by a bribe from Frank Siebenlist (thanks!).
1024   - Parser now handles escapes in URIs correctly.
1025   - Made embedded-URIs' reference text omittable.  Idea from Beni
1026     Cherniavsky.
1027   - Refactored explicit target processing code.
1028   - Added name attribute to references containing the reference name only
1029     through whitespace_normalize_name (no case changes).
1030   - parse_target no longer returns the refname after going through
1031     normalize_name. This is now handled in make_target.
1032   - Fixed bug relating to role-less interpreted text in non-English
1033     contexts.
1034   - Reorganized interpreted text processing; moved code into the new
1035     roles.py module.  Contributed by Edward Loper.
1036   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1037     ``parse_directive_block``.
1039 * docutils/parsers/rst/tableparser.py:
1041   - Reworked for ``StringList``, to support "include" directives in
1042     table cells.
1044 * docutils/parsers/rst/directives/__init__.py:
1046   - Renamed ``unchanged()`` directive option conversion function to
1047     ``unchanged_required``, and added a new ``unchanged``.
1048   - Catch unicode value too high error; fixes bug 781766.
1049   - Beefed up directive error reporting.
1051 * docutils/parsers/rst/directives/body.py:
1053   - Added basic "table" directive.
1055 * docutils/parsers/rst/directives/images.py:
1057   - Added "target" option to "image" directive.
1058   - Added name attribute to references containing the reference name only
1059     through whitespace_normalize_name (no case changes).
1061 * docutils/parsers/rst/directives/misc.py:
1063   - Isolated the import of the ``urllib2`` module; was causing
1064     problems on SourceForge (``libssl.so.2`` unavailable?).
1065   - Added the "role" directive for declaring custom interpreted text
1066     roles.
1068 * docutils/parsers/rst/directives/parts.py:
1070   - The "contents" directive does more work up-front, creating the
1071     "topic" and "title", and leaving the "pending" node for the
1072     transform.  Allows earlier reference resolution; fixes subtle bug.
1074 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1075   mappings by Jannie Hofmeyr.
1077 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1078   mappings by Marek Blaha.
1080 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1081   mappings by Marcelo Huerta San Martin.
1083 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1084   Portuguese mappings by Lalo Martins.
1086 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1087   mappings by Roman Suzi.
1089 * docutils/transforms/parts.py:
1091   - The "contents" directive does more work up-front, creating the
1092     "topic" and "title", and leaving the "pending" node for the
1093     transform.  Allows earlier reference resolution; fixes subtle bug.
1094   - Added support for disabling of section numbering.
1096 * docutils/transforms/references.py:
1098   - Verifying that external targets are truly targets and not indirect
1099     references. This is because we are now adding a "name" attribute to
1100     references in addition to targets. Note sure if this is correct!
1101   - Added code to hook into the unknown_reference_resolvers list for a
1102     transformer in resolve_indirect_target. This allows the
1103     unknown_reference_resolvers to keep around indirect targets which
1104     docutils doesn't know about.
1105   - Added specific error message for duplicate targets.
1107 * docutils/transforms/universal.py:
1109   - Added FilterMessages transform (removes system messages below the
1110     verbosity threshold).
1111   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1112     to FinalCheckVisitor for application-specific handling of
1113     unresolvable references.
1114   - Added specific error message for duplicate targets.
1116 * docutils/writers/__init__.py:
1118   - Added assemble_parts method to the Writer class to allow for
1119     access to a documents individual parts.
1120   - Documented & set default for ``Writer.output`` attribute.
1122 * docutils/writers/html4css1.py:
1124   - Fixed unicode handling of attribute values (bug 760673).
1125   - Prevent duplication of "class" attribute values (bug report from
1126     Kirill Lapshin).
1127   - Improved table grid/border handling (prompted by report from Bob
1128     Marshall).
1129   - Added support for table titles.
1130   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1131     to Darek Suchojad.
1132   - Added functionality to keep track of individual parts of a document
1133     and store them in a dictionary as the "parts" attribute of the writer.
1134     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1135   - Added proper support for the "scale" attribute of the "image"
1136     element.  Contributed by Brent Cook.
1137   - Added ``--initial-header-level`` option.
1138   - Fixed bug: the body_pre_docinfo segment depended on there being a
1139     docinfo; if no docinfo, the document title was incorporated into
1140     the body segment.  Adversely affected the publish_parts interface.
1142 * docutils/writers/latex2e.py:
1144   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1145     about a missing file.
1146   - Added options and support: ``--compound-enumerators``,
1147     ``--section-prefix-for-enumerators``, and
1148     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1149     934322).
1150   - Added option ``--use-verbatim-when-possible``, to avoid
1151     problematic characters (eg, '~' in italian) in literal blocks.
1152   - It's now possible to use four section levels in the `book` and
1153     `report` LaTeX classes.  The default `article` class still has
1154     three levels limit.
1156 * docs/config.txt: "Docutils Configuration Files", added to project.
1157   Moved config file entry descriptions from tools.txt.
1159 * docs/tools.txt:
1161   - Moved config file entry descriptions to config.txt.
1163 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1164   Development".
1166 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1167   Text Roles", added to project.
1169 * spec/rst/reStructuredText.txt:
1171   - Added description of support for <angle-bracketed> complex option
1172     arguments to option lists.
1173   - Added subsections for indented and quoted literal blocks.
1175 * test: Continually adding & updating tests.
1177   - Added test/test_settings.py & test/data/config_*.txt support
1178     files.
1179   - Added test/test_writers/test_htmlfragment.py.
1181 * test/DocutilsTestSupport.py:
1183   - Refactored LaTeX publisher test suite/case class names to make
1184     testing other writers easier.
1185   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1186     to test the processing of HTML fragments which use the new
1187     publish_parts convenience function.
1189 * tools/buildhtml.py:
1191   - Added support for the "--prune" option.
1192   - Removed dependency on pep2html.py; plaintext PEPs no longer
1193     supported.
1195 * tools/docutils.conf:
1197   - Updated for configuration file reorganization.
1199 * tools/rst2html.py:
1201   - copied from tools/html.py
1203 * setup.py:
1205   - added a 'scripts' section to configuration
1206   - added 'tools/rst2html.py' to the scripts section
1209 Release 0.3 (2003-06-24)
1210 ========================
1212 General:
1214 * Renamed "attribute" to "option" for directives/extensions.
1216 * Renamed transform method "transform" to "apply".
1218 * Renamed "options" to "settings" for runtime settings (as set by
1219   command-line options).  Sometimes "option" (singular) became
1220   "settings" (plural).  Some variations below:
1222   - document.options -> document.settings (stored in other objects as
1223     well)
1224   - option_spec -> settings_spec (not directives though)
1225   - OptionSpec -> SettingsSpec
1226   - cmdline_options -> settings_spec
1227   - relative_path_options -> relative_path_settings
1228   - option_default_overrides -> settings_default_overrides
1229   - Publisher.set_options -> Publisher.get_settings
1231 Specific:
1233 * COPYING.txt: Added "Public Domain Dedication".
1235 * FAQ.txt: Frequently asked questions, added to project.
1237 * setup.py:
1239   - Updated with PyPI Trove classifiers.
1240   - Conditional installation of third-party modules.
1242 * docutils/__init__.py:
1244   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1245   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1246   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1247   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1248     option and its effect on the PEP template & writer.
1249   - Bumped version to 0.2.4 due to changes to the PEP template &
1250     stylesheet.
1251   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1252   - Added ``TransformSpec`` class for new transform system.
1253   - Bumped version to 0.2.6 for API changes (renaming).
1254   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1255     convenience functions.
1256   - Added ``Component.component_type`` attribute.
1257   - Bumped version to 0.2.8 because of the internal parser switch from
1258     plain lists to the docutils.statemachine.StringList objects.
1259   - Bumped version to 0.2.9 because of the frontend.py API changes.
1260   - Bumped version to 0.2.10 due to changes to the project layout
1261     (third-party modules removed from the "docutils" package), and
1262     signature changes in ``io.Input``/``io.Output``.
1263   - Changed version to 0.3.0 for release.
1265 * docutils/core.py:
1267   - Made ``publish()`` a bit more convenient.
1268   - Generalized ``Publisher.set_io``.
1269   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1270     parameters; improved its docstring.
1271   - Added ``publish_file()`` and ``publish_string()``.
1272   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1273     out of ``.set_io``.
1274   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1275     "--dump-transforms" hidden options.
1276   - Added ``Publisher.apply_transforms()`` method.
1277   - Added ``Publisher.set_components()`` method; support for
1278     ``publish_*()`` conveninece functions.
1279   - Moved config file processing to docutils/frontend.py.
1280   - Added support for exit status ("exit_level" setting &
1281     ``enable_exit`` parameter for Publisher.publish() and convenience
1282     functions).
1284 * docutils/frontend.py:
1286   - Check for & exit on identical source & destination paths.
1287   - Fixed bug with absolute paths & "--config".
1288   - Set non-command-line defaults in ``OptionParser.__init__()``:
1289     ``_source`` & ``_destination``.
1290   - Distributed ``relative_path_settings`` to components; updated
1291     ``OptionParser.populate_from_components()`` to combine it all.
1292   - Require list of keys in ``make_paths_absolute`` (was implicit in
1293     global ``relative_path_settings``).
1294   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1295     "--dump-settings", and "--dump-transforms" hidden options.
1296   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1297     code, replaced with correct code.
1298   - Added validation functionality for config files.
1299   - Added "--error-encoding" option/setting, "_disable_config"
1300     internal setting.
1301   - Added encoding validation; updated "--input-encoding" and
1302     "--output-encoding"; added "--error-encoding-error-handler" and
1303     "--output-encoding-error-handler".
1304   - Moved config file processing from docutils/core.py.
1305   - Updated ``OptionParser.populate_from_components`` to handle new
1306     ``SettingsSpec.settings_defaults`` dict.
1307   - Added support for "-" => stdin/stdout.
1308   - Added "exit_level" setting ("--exit" option).
1310 * docutils/io.py:
1312   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1313   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1314   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1315   - ``FileOutput.write()`` now returns the encoded output string.
1316   - Try to get path/stream name automatically in ``FileInput`` &
1317     ``FileOutput``.
1318   - Added defaults for source & destination paths.
1319   - Allow for Unicode I/O with an explicit "unicode" encoding.
1320   - Added ``Output.encode()``.
1321   - Removed dependency on runtime settings; pass encoding directly.
1322   - Recognize Unicode strings in ``Input.decode()``.
1323   - Added support for output encoding error handlers.
1325 * docutils/nodes.py:
1327   - Added "Invisible" element category class.
1328   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1329     modification during a traversal.
1330   - Added element classes: ``line_block``, ``generated``, ``address``,
1331     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1332     ``superscript``, ``subscript``, ``inline``
1333   - Added support for lists of nodes to ``Element.insert()``.
1334   - Fixed parent linking in ``Element.replace()``.
1335   - Added new abstract superclass ``FixedTextElement``; adds
1336     "xml:space" attribute.
1337   - Added support for "line" attribute of ``system_message`` nodes.
1338   - Added support for the observer pattern from ``utils.Reporter``.
1339     Added ``parse_messages`` and ``transform_messages`` attributes to
1340     ``document``, removed ``messages``.  Added ``note_parse_message``
1341     and ``note_transform_message`` methods.
1342   - Added support for improved diagnostics:
1344     - Added "document", "source", and "line" internal attributes to
1345       ``Node``, set by ``Node.setup_child()``.
1346     - Converted variations on ``node.parent = self`` to
1347       ``self.setup_child(node)``.
1348     - Added ``document.current_source`` & ``.current_line``
1349       attributes, and ``.note_source`` observer method.
1350     - Changed "system_message" output to GNU-Tools format.
1352   - Added a "rawsource" attribute to the ``Text`` class, for text
1353     before backslash-escape resolution.
1354   - Support for new transform system.
1355   - Reworked ``pending`` element.
1356   - Fixed XML DOM bug (SF #660611).
1357   - Removed the ``interpeted`` element class and added
1358     ``title_reference``, ``abbreviation``, ``acronym``.
1359   - Made substitutions case-sensitive-but-forgiving; moved some code
1360     from the parser.
1361   - Fixed Unicode bug on element attributes (report: William Dode).
1363 * docutils/optik.py: Removed from project; replaced with
1364   extras/optparse.py and extras/textwrap.py.  These will be installed
1365   only if they're not already present in the Python installation.
1367 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1368   only if it's not already present in the Python installation.
1370 * docutils/statemachine.py:
1372   - Factored out ``State.add_initial_transitions()`` so it can be
1373     extended.
1374   - Converted whitespace-specific "blank" and "indent" transitions
1375     from special-case code to ordinary transitions: removed
1376     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1377     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1378     ``ws_initial_transitions`` attributes.
1379   - Removed ``State.match_transition()`` after merging it into
1380     ``.check_line()``.
1381   - Added ``StateCorrection`` exception.
1382   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1383     (moved ``TransitionCorrection`` support there too.)
1384   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1385     ``EOFError`` instead of ``IndexError``.
1386   - Added ``State.no_match`` method.
1387   - Added support for the Observer pattern, triggered by input line
1388     changes.
1389   - Added ``strip_top`` parameter to
1390     ``StateMachineWS.get_first_known_indented``.
1391   - Made ``context`` a parameter to ``StateMachine.run()``.
1392   - Added ``ViewList`` & ``StringList`` classes;
1393     ``extract_indented()`` becomes ``StringList.get_indented()``.
1394   - Added ``StateMachine.insert_input()``.
1395   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1396     thanks to) Fred Drake.
1398 * docutils/utils.py:
1400   - Added a ``source`` attribute to Reporter instances and
1401     ``system_message`` elements.
1402   - Added an observer pattern to ``utils.Reporter`` to keep track of
1403     system messages.
1404   - Fixed bugs in ``relative_path()``.
1405   - Added support for improved diagnostics.
1406   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1407   - Added support for encoding Reporter stderr output, and encoding
1408     error handlers.
1409   - Reporter keeps track of the highest level system message yet
1410     generated.
1412 * docutils/languages: Fixed bibliographic field language lookups.
1414 * docutils/languages/es.py: Added to project; Spanish mappings by
1415   Marcelo Huerta San Martin.
1417 * docutils/languages/fr.py: Added to project; French mappings by
1418   Stefane Fermigier.
1420 * docutils/languages/it.py: Added to project; Italian mappings by
1421   Nicola Larosa.
1423 * docutils/languages/sk.py: Added to project; Slovak mappings by
1424   Miroslav Vasko.
1426 * docutils/parser/__init__.py:
1428   - Added ``Parser.finish_parse()`` method.
1430 * docutils/parser/rst/__init__.py:
1432   - Added options: "--pep-references", "--rfc-references",
1433     "--tab-width", "--trim-footnote-reference-space".
1435 * docutils/parsers/rst/states.py:
1437   - Changed "title under/overline too short" system messages from INFO
1438     to WARNING, and fixed its insertion location.
1439   - Fixed enumerated list item parsing to allow paragraphs & section
1440     titles to begin with enumerators.
1441   - Converted system messages to use the new "line" attribute.
1442   - Fixed a substitution reference edge case.
1443   - Added support for "--pep-references" and "--rfc-references"
1444     options; reworked ``Inliner`` code to make customization easier.
1445   - Removed field argument parsing.
1446   - Added support for short section title over/underlines.
1447   - Fixed "simple reference name" regexp to ignore text like
1448     "object.__method__"; not an anonymous reference.
1449   - Added support for improved diagnostics.
1450   - Reworked directive API, based on Dethe Elza's contribution.  Added
1451     ``Body.parse_directive()``, ``.parse_directive_options()``,
1452     ``.parse_directive_arguments()`` methods.
1453   - Added ``ExtensionOptions`` class, to parse directive options
1454     without parsing field bodies.  Factored
1455     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1456     ``ExtensionOptions``.
1457   - Improved definition list term/classifier parsing.
1458   - Added warnings for unknown directives.
1459   - Renamed ``Stuff`` to ``Struct``.
1460   - Now flagged as errors: transitions at the beginning or end of
1461     sections, empty sections (except title), and empty documents.
1462   - Updated for ``statemachine.StringList``.
1463   - Enabled recognition of schemeless email addresses in targets.
1464   - Added support for embedded URIs in hyperlink references.
1465   - Added backslash-escapes to inline markup end-string suffix.
1466   - Added support for correct interpreted text processing.
1467   - Fixed nested title parsing (topic, sidebar directives).
1468   - Added special processing of backslash-escaped whitespace (idea
1469     from David Abrahams).
1470   - Made substitutions case-sensitive-but-forgiving; moved some code
1471     to ``docutils.nodes``.
1472   - Added support for block quote attributions.
1473   - Added a kludge to work-around a conflict between the bubble-up
1474     parser strategy and short titles (<= 3 char-long over- &
1475     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1476     titles" submitted by Jason Diamond.
1477   - Added explicit interpreted text roles for standard inline markup:
1478     "emphasis", "strong", "literal".
1479   - Implemented "superscript" and "subscript" interpreted text roles.
1480   - Added initial support for "abbreviation" and "acronym" roles;
1481     incomplete.
1482   - Added support for "--trim-footnote-reference-space" option.
1483   - Optional space before colons in directives & hyperlink targets.
1485 * docutils/parsers/rst/tableparser.py:
1487   - Fixed a bug that was producing unwanted empty rows in "simple"
1488     tables.
1489   - Detect bad column spans in "simple" tables.
1491 * docutils/parsers/rst/directives: Updated all directive functions to
1492   new API.
1494 * docutils/parsers/rst/directives/__init__.py:
1496   - Added ``flag()``, ``unchanged()``, ``path()``,
1497     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1498     directive option helper functions.
1499   - Added warnings for unknown directives.
1500   - Return ``None`` for missing directives.
1501   - Added ``register_directive()``, thanks to William Dode and Paul
1502     Moore.
1504 * docutils/parsers/rst/directives/admonitions.py:
1506   - Added "admonition" directive.
1508 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1509   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1510   "parsed-literal", "rubric", "epigraph", "highlights" and
1511   "pull-quote" directives.
1513 * docutils/parsers/rst/directives/images.py:
1515   - Added an "align" attribute to the "image" & "figure" directives
1516     (by Adam Chodorowski).
1517   - Added "class" option to "image", and "figclass" to "figure".
1519 * docutils/parsers/rst/directives/misc.py:
1521   - Added "include", "raw", and "replace" directives, courtesy of
1522     Dethe Elza.
1523   - Added "unicode" and "class" directives.
1525 * docutils/parsers/rst/directives/parts.py:
1527   - Added the "sectnum" directive; by Dmitry Jemerov.
1528   - Added "class" option to "contents" directive.
1530 * docutils/parsers/rst/directives/references.py: Added to project.
1531   Contains the "target-notes" directive.
1533 * docutils/parsers/rst/languages/__init__.py:
1535   - Return ``None`` from get_language() for missing language modules.
1537 * docutils/parsers/rst/languages/de.py: Added to project; German
1538   mappings by Engelbert Gruber.
1540 * docutils/parsers/rst/languages/en.py:
1542   - Added interpreted text roles mapping.
1544 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1545   mappings by Marcelo Huerta San Martin.
1547 * docutils/parsers/rst/languages/fr.py: Added to project; French
1548   mappings by William Dode.
1550 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1551   mappings by Nicola Larosa.
1553 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1554   mappings by Miroslav Vasko.
1556 * docutils/readers/__init__.py:
1558   - Added support for the observer pattern from ``utils.Reporter``, in
1559     ``Reader.parse`` and ``Reader.transform``.
1560   - Removed ``Reader.transform()`` method.
1561   - Added default parameter values to ``Reader.__init__()`` to make
1562     instantiation easier.
1563   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1565 * docutils/readers/pep.py:
1567   - Added the ``peps.TargetNotes`` transform to the Reader.
1568   - Removed PEP & RFC reference detection code; moved to
1569     parsers/rst/states.py as options (enabled here by default).
1570   - Added support for pre-acceptance PEPs (no PEP number yet).
1571   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1572     easy subclassing.
1574 * docutils/readers/python: Python Source Reader subpackage added to
1575   project, including preliminary versions of:
1577   - __init__.py
1578   - moduleparser.py: Parser for Python modules.
1580 * docutils/transforms/__init__.py:
1582   - Added ``Transformer`` class and completed transform reform.
1583   - Added unknown_reference_resolvers list for each transformer. This list holds
1584     the list of functions provided by each component of the transformer that
1585     help resolve references.
1587 * docutils/transforms/frontmatter.py:
1589   - Improved support for generic fields.
1590   - Fixed bibliographic field language lookups.
1592 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1593   transforms.
1595 * docutils/transforms/parts.py:
1597   - Moved the "id" attribute from TOC list items to the references
1598     (``Contents.build_contents()``).
1599   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1600   - Added "class" attribute support to ``Contents``.
1602 * docutils/transforms/peps.py:
1604   - Added ``mask_email()`` function, updating to pep2html.py's
1605     functionality.
1606   - Linked "Content-Type: text/x-rst" to PEP 12.
1607   - Added the ``TargetNotes`` PEP-specific transform.
1608   - Added ``TargetNotes.cleanup_callback``.
1609   - Added title check to ``Headers``.
1611 * docutils/transforms/references.py:
1613   - Added the ``TargetNotes`` generic transform.
1614   - Split ``Hyperlinks`` into multiple transforms.
1615   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1616   - Added check for circular indirect references.
1617   - Made substitutions case-sensitive-but-forgiving.
1619 * docutils/transforms/universal.py:
1621   - Added support for the "--expose-internal-attributes" option.
1622   - Removed ``Pending`` transform classes & data.
1624 * docutils/writers/__init__.py:
1626   - Removed ``Writer.transform()`` method.
1628 * docutils/writers/docutils-xml.py:
1630   - Added XML and doctype declarations.
1631   - Added "--no-doctype" and "--no-xml-declaration" options.
1633 * docutils/writers/html4css1.py:
1635   - "name" attributes only on these tags: a, applet, form, frame,
1636     iframe, img, map.
1637   - Added "name" attribute to <a> in section titles for Netscape 4
1638     support (bug report: Pearu Peterson).
1639   - Fixed targets (names) on footnote, citation, topic title,
1640     problematic, and system_message nodes (for Netscape 4).
1641   - Changed field names from "<td>" to "<th>".
1642   - Added "@" to "&#64;" encoding to thwart address harvesters.
1643   - Improved the vertical whitespace optimization; ignore "invisible"
1644     nodes (targets, comments, etc.).
1645   - Improved inline literals with ``<span class="pre">`` around chunks
1646     of text and ``&nbsp;`` for runs of spaces.
1647   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1648     ``self.docinfo`` segments.
1649   - Added support for "line_block", "address" elements.
1650   - Improved backlinks (footnotes & system_messages).
1651   - Improved system_message output.
1652   - Redefined "--stylesheet" as containing an invariant URL, used
1653     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1654     working directory.
1655   - Added "--footnote-references" option (superscript or brackets).
1656   - Added "--compact-lists" and "--no-compact-lists" options.
1657   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1658     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1659   - Improved field list rendering.
1660   - Added Docutils version to "generator" meta tag.
1661   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1662   - Improved layout of <pre> HTML source.
1663   - Fixed attribute typo on <colspec>.
1664   - Refined XML prologue.
1665   - Support for no stylesheet.
1666   - Removed "interpreted" element support.
1667   - Added support for "title_reference", "sidebar", "attribution",
1668     "rubric", and generic "admonition" elements.
1669   - Added "--attribution" option.
1670   - Added support for "inline", "subscript", "superscript" elements.
1671   - Added initial support for "abbreviation" and "acronym";
1672     incomplete.
1674 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1675   (from the sandbox).
1677   - Added french.
1678   - Double quotes in literal blocks (special treatment for de/ngerman).
1679   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1680   - Added  "--attribution" option.
1681   - Right align attributions.
1683 * docutils/writers/pep_html.py:
1685   - Parameterized output encoding in PEP template.
1686   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1687   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1688     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1689     working directory.
1690   - Added an override on the "--footnote-references" option.
1691   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1692   - Added Docutils version to "generator" meta tag.
1693   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1695 * docs/tools.txt:
1697   - Added a "silent" setting for ``buildhtml.py``.
1698   - Added a "Getting Help" section.
1699   - Rearranged the structure.
1700   - Kept up to date, with new settings, command-line options etc.
1701   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1702   - Converted settings table into a definition list.
1704 * docs/rst/quickstart.txt:
1706   - Added a table of contents.
1707   - Added feedback information.
1708   - Added mention of minimum section title underline lengths.
1709   - Removed the 4-character minimum for section title underlines.
1711 * docs/rst/quickref.html:
1713   - Added a "Getting Help" section.
1714   - Added a style to make section title backlinks more subtle.
1715   - Added mention of minimum section title underline lengths.
1716   - Removed the 4-character minimum for section title underlines.
1718 * extras: Directory added to project; contains third-party modules
1719   that Docutils depends on (optparse, textwrap, roman).  These are
1720   only installed if they're not already present.
1722 * licenses: Directory added to project; contains copies of license
1723   files for non-public-domain files.
1725 * spec/doctree.txt:
1727   - Changed the focus.  It's about DTD elements:  structural
1728     relationships, semantics, and external (public) attributes.  Not
1729     about the element class library.
1730   - Moved some implementation-specific stuff into ``docutils.nodes``
1731     docstrings.
1732   - Wrote descriptions of all common attributes and parameter
1733     entities.  Filled in introductory material.
1734   - Working through the element descriptions: 55 down, 37 to go.
1735   - Removed "Representation of Horizontal Rules" to
1736     spec/rst/alternatives.txt.
1738 * spec/docutils.dtd:
1740   - Added "generated" inline element.
1741   - Added "line_block" body element.
1742   - Added "auto" attribute to "title".
1743   - Changed content models of "literal_block" and "doctest_block" to
1744     ``%text.model``.
1745   - Added ``%number;`` attribute type parameter entity.
1746   - Changed ``%structural.elements;`` to ``%section.elements``.
1747   - Updated attribute types; made more specific.
1748   - Added "address" bibliographic element.
1749   - Added "line" attribute to ``system_message`` element.
1750   - Removed "field_argument" element; "field_name" may contain
1751     multiple words and whitespace.
1752   - Changed public identifier to docutils.sf.net.
1753   - Removed "interpreted" element; added "title_reference",
1754     "abbreviation", "acronym".
1755   - Removed "refuri" attribute from "footnote_reference" and
1756     "citation_reference".
1757   - Added "sidebar", "rubric", "attribution", "admonition",
1758     "superscript", "subscript", and "inline" elements.
1760 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1762 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1764 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1766 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1767   Dallas Mahrt.
1769 * spec/transforms.txt: Added to project.
1771 * spec/howto: Added subdirectory, for developer how-to docs.
1773 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1774   Elza, edited & extended by David Goodger.
1776 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1777   project.
1779 * spec/rst/alternatives.txt:
1781   - Added "Doctree Representation of Transitions" from
1782     spec/doctree.txt.
1783   - Updated "Inline External Targets" & closed the debate.
1784   - Added ideas for interpreted text syntax extensions.
1785   - Added "Nested Inline Markup" section.
1787 * spec/rst/directives.txt:
1789   - Added directives: "topic", "sectnum", "target-notes",
1790     "line-block", "parsed-literal", "include", "replace", "sidebar",
1791     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1792     "class".
1793   - Formalized descriptions of directive details.
1794   - Added an "align" attribute to the "image" & "figure" directives
1795     (by Adam Chodorowski).
1796   - Added "class" options to "topic", "sidebar", "line-block",
1797     "parsed-literal", "contents", and "image"; and "figclass" to
1798     "figure".
1800 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1801   interpreted text roles.
1803 * spec/rst/introduction.txt:
1805   - Added pointers to material for new users.
1807 * spec/rst/reStructuredText.txt:
1809   - Disambiguated comments (just add a newline after the "::").
1810   - Updated enumerated list description; added a discussion of the
1811     second-line validity checking.
1812   - Updated directive description.
1813   - Added a note redirecting newbies to the user docs.
1814   - Expanded description of inline markup start-strings in non-markup
1815     contexts.
1816   - Removed field arguments and made field lists a generic construct.
1817   - Removed the 4-character minimum for section title underlines.
1818   - Clarified term/classifier delimiter & inline markup ambiguity
1819     (definition lists).
1820   - Added "Embedded URIs".
1821   - Updated "Interpreted Text" section.
1822   - Added "Character-Level Inline Markup" section.
1824 * test: Continually adding & updating tests.
1826   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1827   - Moved test/test_pep/ to test/test_readers/test_pep/.
1828   - Added test/test_readers/test_python/.
1829   - Added test/test_writers/ (Engelbert Gruber).
1831 * tools:
1833   - Made the ``locale.setlocale()`` calls in front ends
1834     fault-tolerant.
1836 * tools/buildhtml.py:
1838   - Added "--silent" option.
1839   - Fixed bug with absolute paths & "--config".
1840   - Updated for new I/O classes.
1841   - Added some exception handling.
1842   - Separated publishers' setting defaults; prevents interference.
1843   - Updated for new ``publish_file()`` convenience function.
1845 * tools/pep-html-template:
1847   - Allow for "--embed-stylesheet".
1848   - Added Docutils version to "generator" meta tag.
1849   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1850   - Conform to XHTML spec.
1852 * tools/pep2html.py:
1854   - Made ``argv`` a parameter to ``main()``.
1855   - Added support for "Content-Type:" header & arbitrary PEP formats.
1856   - Linked "Content-Type: text/plain" to PEP 9.
1857   - Files skipped (due to an error) are not pushed onto the server.
1858   - Updated for new I/O classes.
1859   - Added ``check_requirements()`` & ``pep_type_error()``.
1860   - Added some exception handling.
1861   - Updated for new ``publish_string()`` convenience function.
1862   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1864 * tools/quicktest.py:
1866   - Added "-V"/"--version" option.
1868 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1870 * tools/unicode2rstsubs.py: Added to project.  Produces character
1871   entity files (reSructuredText substitutions) from the MathML master
1872   unicode.xml file.
1874 * tools/editors: Support code for editors, added to project.  Contains
1875   ``emacs/restructuredtext.el``.
1877 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1879   - Added style for chunks of inline literals.
1880   - Removed margin for first child of table cells.
1881   - Right-aligned field list names.
1882   - Support for auto-numbered section titles in TOCs.
1883   - Increased the size of inline literals (<tt>) in titles.
1884   - Restored the light gray background for inline literals.
1885   - Added support for "line_block" elements.
1886   - Added style for "address" elements.
1887   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1888   - Improved field list rendering.
1889   - Vertical whitespace improvements.
1890   - Removed "a.target" style.
1892 * tools/stylesheets/pep.css:
1894   - Fixed nested section margins.
1895   - Other changes parallel those of ``../default.css``.
1898 Release 0.2 (2002-07-31)
1899 ========================
1901 General:
1903 - The word "component" was being used ambiguously.  From now on,
1904   "component" will be used to mean "Docutils component", as in Reader,
1905   Writer, Parser, or Transform.  Portions of documents (Table of
1906   Contents, sections, etc.)  will be called "document parts".
1907 - Did a grand renaming: a lot of ``verylongnames`` became
1908   ``very_long_names``.
1909 - Cleaned up imports: no more relative package imports or
1910   comma-separated lists of top-level modules.
1911 - Added support for an option values object which carries default
1912   settings and overrides (from command-line options and library use).
1913 - Added internal Unicode support, and support for both input and
1914   output encodings.
1915 - Added support for the ``docutils.io.IO`` class & subclasses.
1917 Specific:
1919 * docutils/__init__.py:
1921   - Added ``ApplicationError`` and ``DataError``, for use throughout
1922     the package.
1923   - Added ``Component`` base class for Docutils components; implements
1924     the ``supports`` method.
1925   - Added ``__version__`` (thus, ``docutils.__version__``).
1927 * docutils/core.py:
1929   - Removed many keyword parameters to ``Publisher.__init__()`` and
1930     ``publish()``; bundled into an option values object.  Added
1931     "argv", "usage", "description", and "option_spec" parameters for
1932     command-line support.
1933   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1934     methods.
1935   - Reworked I/O model for ``docutils.io`` wrappers.
1936   - Updated ``Publisher.set_options()``; now returns option values
1937     object.
1938   - Added support for configuration files (/etc/docutils.conf,
1939     ./docutils.conf, ~/.docutils).
1940   - Added ``Publisher.setup_option_parser()``.
1941   - Added default usage message and description.
1943 * docutils/frontend.py: Added to project; support for front-end
1944   (command-line) scripts.  Option specifications may be augmented by
1945   components.  Requires Optik (http://optik.sf.net/) for option
1946   processing (installed locally as docutils/optik.py).
1948 * docutils/io.py: Added to project; uniform API for a variety of input
1949   output mechanisms.
1951 * docutils/nodes.py:
1953   - Added ``TreeCopyVisitor`` class.
1954   - Added a ``copy`` method to ``Node`` and subclasses.
1955   - Added a ``SkipDeparture`` exception for visitors.
1956   - Renamed ``TreePruningException`` from ``VisitorException``.
1957   - Added docstrings to ``TreePruningException``, subclasses, and
1958     ``Nodes.walk()``.
1959   - Improved docstrings.
1960   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1961   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1962     imports.
1963   - Added ``decoration``, ``header``, and ``footer`` node classes, and
1964     ``PreDecorative`` mixin.
1965   - Reworked the name/id bookkeeping; to ``document``, removed
1966     ``explicit_targets`` and ``implicit_targets`` attributes, added
1967     ``nametypes`` attribute and ``set_name_id_map`` method.
1968   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1969     traversals.
1970   - Added ``document.has_name()`` method.
1971   - Fixed DOM generation for list-attributes.
1972   - Added category class ``Labeled`` (used by footnotes & citations).
1973   - Added ``Element.set_class()`` method (sets "class" attribute).
1975 * docutils/optik.py: Added to project.  Combined from the Optik
1976   package, with added option groups and other modifications.  The use
1977   of this module is probably only temporary.
1979 * docutils/statemachine.py:
1981   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1982   - Added underscores to improve many awkward names.
1983   - In ``string2lines()``, changed whitespace normalizing translation
1984     table to regexp; restores Python 2.0 compatibility with Unicode.
1986 * docutils/urischemes.py:
1988   - Filled in some descriptions.
1989   - Added "shttp" scheme.
1991 * docutils/utils.py:
1993   - Added ``clean_rcs_keywords`` function (moved from
1994     docutils/transforms/frontmatter.py
1995     ``DocInfo.filter_rcs_keywords``).
1996   - Added underscores to improve many awkward names.
1997   - Changed names of Reporter's thresholds:
1998     warning_level -> report_level; error_level -> halt_level.
1999   - Moved ``utils.id()`` to ``nodes.make_id()``.
2000   - Added ``relative_path(source, target)``.
2002 * docutils/languages/de.py: German mappings; added to project.  Thanks
2003   to Gunnar Schwant for the translations.
2005 * docutils/languages/en.py: Added "Dedication" bibliographic field
2006   mappings.
2008 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2009   Chodorowski.
2011 * docutils/parsers/rst/states.py:
2013   - Added underscores to improve many awkward names.
2014   - Added RFC-2822 header support.
2015   - Extracted the inline parsing code from ``RSTState`` to a separate
2016     class, ``Inliner``, which will allow easy subclassing.
2017   - Made local bindings for ``memo`` container & often-used contents
2018     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2019   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2020   - Added ``MarkupMismatch`` exception; for late corrections.
2021   - Added ``-/:`` characters to inline markup's start string prefix,
2022     ``/`` to end string suffix.
2023   - Fixed a footnote bug.
2024   - Fixed a bug with literal blocks.
2025   - Applied patch from Simon Budig: simplified regexps with symbolic
2026     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2027   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2028   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2029   - Allowed non-ASCII in "simple names" (directive names, field names,
2030     references, etc.).
2031   - Converted ``Inliner.patterns.initial`` to be dynamically built
2032     from parts with ``build_regexp()`` function.
2033   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2034   - Updated docstrings.
2035   - Changed "table" to "grid_table"; added "simple_table" support.
2037 * docutils/parsers/rst/tableparser.py:
2039   - Changed ``TableParser`` to ``GridTableParser``.
2040   - Added ``SimpleTableParser``.
2041   - Refactored naming.
2043 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2044   a fallback language for directive names.
2046 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2047   directive to use a ``pending`` element, used only by HTML writers.
2049 * docutils/parsers/rst/directives/parts.py: Renamed from
2050   components.py.
2052   - Added "backlinks" attribute to "contents" directive.
2054 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2055   project by Adam Chodorowski.
2057 * docutils/readers/__init__.py: Gave Readers more control over
2058   choosing and instantiating Parsers.
2060 * docutils/readers/pep.py: Added to project; for PEP processing.
2062 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2063   requires a ``component`` parameter.
2065 * docutils/transforms/components.py: Added to project; transforms
2066   related to Docutils components.
2068 * docutils/transforms/frontmatter.py:
2070   - In ``DocInfo.extract_authors``, check for a single "author" in an
2071     "authors" group, and convert it to a single "author" element.
2072   - Added support for "Dedication" and generic bibliographic fields.
2074 * docutils/transforms/peps.py: Added to project; PEP-specific.
2076 * docutils/transforms/parts.py: Renamed from old components.py.
2078   - Added filter for `Contents`, to use alt-text for inline images,
2079     and to remove inline markup that doesn't make sense in the ToC.
2080   - Added "name" attribute to TOC topic depending on its title.
2081   - Added support for optional TOC backlinks.
2083 * docutils/transforms/references.py: Fixed indirect target resolution
2084   in ``Hyperlinks`` transform.
2086 * docutils/transforms/universal.py:
2088   - Changed ``Messages`` transform to properly filter out system
2089     messages below the warning threshold.
2090   - Added ``Decorations`` transform (support for ``--generator``,
2091     ``--date``, ``--time``, ``--source-link`` options).
2093 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2094   Engelbert Gruber's PDF writer.
2096 * docutils/writers/html4css1.py:
2098   - Made XHTML-compatible (switched to lowercase element & attribute
2099     names; empty tag format).
2100   - Escape double-dashes in comment text.
2101   - Improved boilerplate & modularity of output.
2102   - Exposed modular output in Writer class.
2103   - Added a "generator" meta tag to <head>.
2104   - Added support for the ``--stylesheet`` option.
2105   - Added support for ``decoration``, ``header``, and ``footer``
2106     elements.
2107   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2108     translation table to regexp; restores Python 2.0 compatibility
2109     with Unicode.
2110   - Added the translator class as instance variable to the Writer, to
2111     make it easily subclassable.
2112   - Improved option list spacing (thanks to Richard Jones).
2113   - Modified field list output.
2114   - Added backlinks to footnotes & citations.
2115   - Added percentage widths to "<col>" tags (from colspec).
2116   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2117     "<span>" changed to "<var>".
2118   - Inline literals: "<code>" changed to "<tt>".
2119   - Many changes to optimize vertical space: compact simple lists etc.
2120   - Add a command-line options & directive attributes to control TOC
2121     and footnote/citation backlinks.
2122   - Added support for optional footnote/citation backlinks.
2123   - Added support for generic bibliographic fields.
2124   - Identify backrefs.
2125   - Relative URLs for stylesheet links.
2127 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2128   PEPs (subclass of ``html4css1.Writer``).
2130 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2132 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2133   of the Docutils internal doctree in XML.
2135 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2137 * spec/doctree.txt:
2139   - Changed the title to "The Docutils Document Tree".
2140   - Added "Hyperlink Bookkeeping" section.
2142 * spec/docutils.dtd:
2144   - Added ``decoration``, ``header``, and ``footer`` elements.
2145   - Brought ``interpreted`` element in line with the parser: changed
2146     attribute "type" to "role", added "position".
2147   - Added support for generic bibliographic fields.
2149 * spec/notes.txt: Continual updates.  Added "Project Policies".
2151 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2152   section.
2154 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2156 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2157   mailing list discussions.
2159 * spec/pep-0287.txt:
2161   - Renamed to "reStructuredText Docstring Format".
2162   - Minor edits.
2163   - Reworked Q&A as an enumerated list.
2164   - Converted to reStructuredText format.
2166 * spec/pysource.dtd:
2168   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2170 * spec/pysource.txt: Removed from project.  Moved much of its contents
2171   to pep-0258.txt.
2173 * spec/rst/alternatives.txt:
2175   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2176   - Added "Inline External Targets" section.
2178 * spec/rst/directives.txt:
2180   - Added "backlinks" attribute to "contents" directive.
2182 * spec/rst/problems.txt:
2184   - Updated the Enumerated List Markup discussion.
2185   - Added new alternative table markup syntaxes.
2187 * spec/rst/reStructuredText.txt:
2189   - Clarified field list usage.
2190   - Updated enumerated list description.
2191   - Clarified purpose of directives.
2192   - Added ``-/:`` characters to inline markup's start string prefix,
2193     ``/`` to end string suffix.
2194   - Updated "Authors" bibliographic field behavior.
2195   - Changed "inline hyperlink targets" to "inline internal targets".
2196   - Added "simple table" syntax to supplement the existing but
2197     newly-renamed "grid tables".
2198   - Added cautions for anonymous hyperlink use.
2199   - Added "Dedication" and generic bibliographic fields.
2201 * test: Made test modules standalone (subdirectories became packages).
2203 * test/DocutilsTestSupport.py:
2205   - Added support for PEP extensions to reStructuredText.
2206   - Added support for simple tables.
2207   - Refactored naming.
2209 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2211   - Now supports true packages containing test modules
2212     (``__init__.py`` files required); fixes duplicate module name bug.
2214 * test/test_pep/: Subpackage added to project; PEP testing.
2216 * test/test_rst/test_SimpleTableParser.py: Added to project.
2218 * tools:
2220   - Updated html.py and publish.py front-end tools to use the new
2221     command-line processing facilities of ``docutils.frontend``
2222     (exposed in ``docutils.core.Publisher``), reducing each to just a
2223     few lines of code.
2224   - Added ``locale.setlocale()`` calls to front-end tools.
2226 * tools/buildhtml.py: Added to project; batch-generates .html from all
2227   the .txt files in directories and subdirectories.
2229 * tools/default.css:
2231   - Added support for ``header`` and ``footer`` elements.
2232   - Added styles for "Dedication" topics (biblio fields).
2234 * tools/docutils.conf: A configuration file; added to project.
2236 * tools/docutils-xml.py: Added to project.
2238 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2240 * tools/pep-html-template: Added to project.
2242 * tools/pep2html.py: Added to project from Python (nondist/peps).
2243   Added support for Docutils (reStructuredText PEPs).
2245 * tools/quicktest.py:
2247   - Added the ``--attributes`` option, hacked a bit.
2248   - Added a second command-line argument (output file); cleaned up.
2250 * tools/stylesheets/: Subdirectory added to project.
2252 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2255 Release 0.1 (2002-04-20)
2256 ========================
2258 This is the first release of Docutils, merged from the now inactive
2259 reStructuredText__ and `Docstring Processing System`__ projects.  For
2260 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2261 `DPS HISTORY`__ files.
2263 __ http://structuredtext.sourceforge.net/
2264 __ http://docstring.sourceforge.net/
2265 __ http://structuredtext.sourceforge.net/HISTORY.html
2266 __ http://docstring.sourceforge.net/HISTORY.html
2268 General changes: renamed 'dps' package to 'docutils'; renamed
2269 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2270 the test suites (reStructuredText's test/test_states renamed to
2271 test/test_rst); and all modifications required to make it all work.
2273 * docutils/parsers/rst/states.py:
2275   - Improved diagnostic system messages for missing blank lines.
2276   - Fixed substitution_reference bug.
2280    Local Variables:
2281    mode: indented-text
2282    indent-tabs-mode: nil
2283    sentence-end-double-space: t
2284    fill-column: 70
2285    End: