fixed markup bugs in docstrings; now works with Endo
[docutils.git] / HISTORY.txt
blob56248d142f99f8340efa1619b63c31fa8c773491
1 ==================
2  Docutils History
3 ==================
5 :Author: David Goodger; open to all Docutils developers
6 :Contact: goodger@python.org
7 :Date: $Date$
8 :Revision: $Revision$
9 :Web site: http://docutils.sourceforge.net/
10 :Copyright: This document has been placed in the public domain.
12 .. contents::
15 Changes Since 0.3.9
16 ===================
18 * General:
20   - Updated the project policies for trunk/branch development &
21     version numbering.
23 * docutils/__init__.py:
25   - Added ``__version_details__`` attribute to describe code source
26     (repository/snapshot/release).
27   - Replaced ``default_transforms`` attribute of TransformSpec with
28     ``get_transforms()`` method.
30 * docutils/core.py:
32   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
33     functions, for document tree extraction and reprocessing.
35 * docutils/io.py:
37   - Added ``DocTreeInput`` class, for reprocessing existing documents.
38   - Added support for non-Unicode (e.g. binary) writer output.
40 * docutils/nodes.py:
42   - Re-introduced ``Targetable.indirect_reference_name``, for
43     MoinMoin/reST compatibility (removed in r3124/r3129).
44   - Added ``serial_escape`` function; escapes string values that are
45     elements of a list, for serialization.  Modified Docutils-XML
46     writing (``Element._dom_node``) and pseudo-XML writing
47     (``Element.starttag``) to use ``serial_escape``.
48   - Added ``Node.deepcopy()`` method.
49   - Removed the internal lists ``document.substitution_refs``,
50     ``document.anonymous_refs``, and ``document.anonymous_targets``.
51   - Added a "container" element.
52   - Fixed bug where values of list-valued attributes of elements
53     originating from custom interpreted text roles (i.e., with custom
54     classes) were being shared between element instances.  Reported by
55     Shmuel Zeigerman.
57 * docutils/statemachine.py:
59   - Added trailing whitespace stripping to ``string2lines()``.
60   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
61     Asian double-width character support.
63 * docutils/utils.py:
65   - Added ``east_asian_column_width()`` for double-width character
66     support.
68 * docutils/languages/ja.py: Added to project: Japanese mappings by
69   Hisashi Morita.
71 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
72   mappings by Panjunyong.
74 * docutils/parsers/null.py: Added to project; a do-nothing parser.
76 * docutils/parsers/rst/__init__.py:
78   - Added validator to tab_width setting, with test.  Closes SF bug
79     #1212515, report from Wu Wei.
81 * docutils/parsers/rst/states.py:
83   - Fixed bug with escaped colons indicating a literal block.
84   - Fixed bug with enumerated lists (SF#1254145).
85   - Backslash-escaped colons inside of field names are now allowed.
86   - Targets (implicit and explicit), anonymous hyperlink references
87     and auto-numbered footnote references inside of substitution
88     definitions are now disallowed.
89   - Fixed bug: list items with blank first lines.
90   - Fixed bug: block quote attributions with indented second lines.
91   - Added East Asian double-width character support (Python 2.4 only).
93 * docutils/parsers/rst/tableparser.py:
95   - Added East Asian double-width character support (Python 2.4 only).
97 * docutils/parsers/rst/directives/body.py:
99   - Added the "container" directive.
101 * docutils/parsers/rst/directives/misc.py:
103   - Added the "default-role", "title", and "date" directives.
104   - Added standard data file syntax to the "include" directive.
105   - Added support for "class" directive content.
107 * docutils/parsers/rst/directives/images.py:
109   - Added ``indirect_reference_name`` support for images with a target
110     option.
111   - Added support for image width and height units.
112   - Fixed bug with image "target" options.
114 * docutils/parsers/rst/directives/references.py:
116   - Added "class" attribute to "target-notes" directive, for
117     footnote_reference classes.
119 * docutils/parsers/rst/include/: Directory added to project; contains
120   standard data files for the "include" directive.  Initial contents:
121   character entity substitution definition sets, and a set of
122   definitions for S5/HTML presentations.
124 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
125   mappings by David Goodger.
126   
127 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
128   Simplified Chinese mappings by Panjunyong.
130 * docutils/readers/__init__.py:
132   - Added universal.Decorations and universal.ExposeInternals
133     transforms as default transforms for all readers.
134   - Added ``ReReader`` base class for readers that reread an existing
135     document tree.
137 * docutils/readers/doctree.py: Added to project; a reader for existing
138   document trees.
140 * docutils/transforms/frontmatter.py:
142   - Fixed the DocInfo transform to handle SVN-style expansion of the
143     "Date" keyword.
144   - In ``DocInfo.extract_authors``, treat the contents of "authors"
145     fields uniformly.
147 * docutils/transforms/misc.py:
149   - Added misc.Transitions transform, extracted from
150     universal.FinalChecks.
152 * docutils/transforms/references.py:
154   - Added references.DanglingReferences transform, extracted from
155     universal.FinalChecks.
156   - Fixed bug with doubly-indirect substitutions.
157   - Added footnote_reference classes attribute to "TargetNotes".
158   - Fixed bug with circular substitution definitions that put Docutils
159     into an infinite loop.
161 * docutils/transforms/universal.py:
163   - Added universal.ExposeInternals transform, extracted from
164     universal.FinalChecks.
165   - Removed universal.FinalChecks transform (logic has been moved to
166     several new transforms).
167   - Fixed bug with the "expose_internals" setting and Text nodes
168     (exposed by the "rawsource" internal attribute).
169   - Added the universal.StripComments transform, implementation of the
170     "strip_comments" setting.
172 * docutils/transforms/writer_aux.py: Added to project; auxiliary
173   transforms for writers.
175   - Added ``Compound`` transform, which flattens compound paragraphs.
177 * docutils/writers/: Several writer modules (html4css1.py) were
178   converted into packages.  Support modules and data files have been
179   moved into the packages.
181   The stylesheets for the HTML writers are now installed along with
182   the code, the code knows where to find them, and the default is to
183   use them (actually, to embed them).  Some adjustments to
184   configuration files may be necessary.  The easiest way to obtain the
185   new default behavior is to remove all settings whose name includes
186   "stylesheet".
188 * docutils/writers/__init__.py:
190   - Added universal.Messages and universal.FilterMessages transforms
191     as default transforms for all writers.
192   - Added ``UnfilteredWriter`` base class for writers that pass the
193     document tree on unchanged.
195 * docutils/writers/docutils_xml.py:
197   - Made ``xmlcharrefreplace`` the default output encoding error
198     handler.
200 * docutils/writers/html4css1/: 
202   - Added support for image width and height units.
203   - Made ``xmlcharrefreplace`` the default output encoding error
204     handler.
205   - Made ``--embed-stylesheet`` the default rather than
206     ``--link-stylesheet``.
207   - Moved "id" attribute from container (section etc.) to title's <a>
208     tag, to be on the same tag as "name".
209     (!!! To be reverted in Docutils 0.5.)
210   - Added vertical space between fields of field lists.
211   - Added ``--compact-field-lists`` option to remove vertical space in
212     simple field lists.
213   - Made cloaking of email addresses with ``--cloak-email-addresses``
214     less obtrusive.
215   - Fixed support for centered images.
216   - Added support for class="compact" & class="open" lists.
218 * docutils/writers/latex2e/:
220   - Underscores in citekeys are no longer escaped.
222 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
223   mapping of Unicode characters to LaTeX equivalents.
225 * docutils/writers/s5_html/: Package added to project; writer for
226   S5/HTML slide shows.
228 * docs/dev/distributing.txt: Added to project; guide for distributors
229   (package maintainers).
231 * docs/dev/hacking.txt: Added to project; guide for developers.
233 * docs/ref/doctree.txt:
235   - Updated for plural attributes "classes", "ids", "names",
236     "dupnames".
237   - Added the "container" element.
239 * docs/ref/docutils.dtd:
241   - Updated for plural attributes "classes", "ids", "names",
242     "dupnames".
244 * docs/user/emacs.txt: Added to project; a document about Emacs
245   support for reStructuredText and Docutils.
247 * docs/user/links.txt: Added to project; lists of Docutils-related
248   links.
250 * docs/user/mailing-lists.txt: Added to project; information about
251   Docutils-related mailing lists and how to access them.
253 * docs/user/slide-shows.txt: Added to project; example of and docs for
254   the S5/HTML writer (``rst2s5.py`` front end).
256 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
257   Files", added to project.
259 * test/coverage.sh: Added to project; test coverage script.
261 * test/DocutilsTestSupport.py:
263   - Added support for specifying runtime settings at the suite level.
265 * test/test_functional.py:
267   - Added the ``clear_output_directory`` function.
268   - Added support for ``_test_more`` functions in functional test
269     config files.
271 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
273 * tools/rstpep2html.py: Renamed from pep.py.
275 * tools/dev/create_unimap.py: Added to project; script to create the
276   docutils/writers/unimap_latex.py mapping file.
278 * tools/dev/profile_docutils.py: Added to project; profiler script.
280 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
282 * tools/editors/emacs/restructuredtext.el,
283   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
284   Removed from project; the functionality is now contained in rst.el.
286 * tools/editors/emacs/rst.el: Added to project.  Added many features
287   and fixed many bugs.  See docs/user/emacs.txt for details.
289 * tools/stylesheets: Removed from project.  Stylesheets have been
290   renamed and moved into writer packages.
293 Release 0.3.9 (2005-05-26)
294 ==========================
296 * General:
298   - Eliminated and replaced all uses of the old string attributes
299     ``id``, ``name``, ``dupname`` and ``class`` with references to the
300     new list attributes ``ids``, ``names``, ``dupnames`` and
301     ``classes`` throughout the whole source tree.
303 * docutils/core.py:
305   - Enabled ``--dump-*`` options when ``--traceback`` specified,
306     allowing for easier debugging.
307   - In ``Publisher.publish()``, expanded the generic top-level
308     exception catching.
310 * docutils/examples.py:
312   - Added ``internals`` function for exploration.
314 * docutils/io.py:
316   - Fixed ``Input.decode`` method to apply heuristics only if no
317     encoding is explicitly given, and to provide better reporting of
318     decoding errors.
319   - The ``Input.decode`` method now removes byte order marks (BOMs)
320     from input streams.
322 * docutils/nodes.py:
324   - ``image`` element class changed to subclass of Element, not
325     TextElement (it's an empty element, and cannot contain text).
326   - Added ``attr_defaults`` dictionary for default attribute values.
327   - Added empty list as default value for the following attributes:
328     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
329   - Added ``document.decoration`` attribute,
330     ``document.get_decoration`` method, and ``decoration.get_header``
331     & ``.get_footer`` methods.
332   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
333     methods.
335 * docutils/utils.py:
337   - Removed ``docutils.utils.Reporter.categories``,
338     ``docutils.utils.ConditionSet``, and all references to them, to
339     simplify error reporting.
341 * docutils/languages/nl.py: Added to project; Dutch mappings by
342   Martijn Pieters.
344 * docutils/parsers/rst/__init__.py:
346   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
348 * docutils/parsers/rst/states.py:
350   - Added check for escaped at-mark to prevent email address recognition.
351   - Fixed option lists to allow spaces inside ``<angle-bracketed option
352     arguments>``.
353   - Allowed whitespace in paths and URLs.
354   - Added auto-enumerated list items.
355   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
356     followed by text.
357   - Added support for table stub columns.
359 * docutils/parsers/rst/directives/__init__.py:
361   - Allowed whitespace in paths (``path`` function).
362   - Added ``uri`` directive option conversion function.
364 * docutils/parsers/rst/directives/body.py:
366   - Fixed illegal context bug with "topic" directive (allowed within
367     sidebars; not within body elements).
369 * docutils/parsers/rst/directives/images.py:
371   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
372   - Added support for the ``file_insertion_enabled`` setting in the
373     "figure" directive (disables "figwidth" option).
374   - "image" directive: added checks for valid values of "align" option,
375     depending on context.  "figure" directive: added specialized
376     "align" option and attribute on "figure" element.
377   - Made ":figwidth: image" option of "figure" directive work again.
378   - Fixed bug with reference names containing uppercase letters
379     (e.g. ``Name_``) in "target" option of "image" directive.
381 * docutils/parsers/rst/directives/misc.py:
383   - Fixed "include" and "raw" directives to catch text decoding
384     errors.
385   - Allowed whitespace in "include" & "raw" directive paths.
386   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
387     settings in "include" & "raw" directives.
389 * docutils/parsers/rst/directives/parts.py:
391   - Added "header" & "footer" directives.
392   - Fixed illegal context bug with "contents" directive (topics
393     allowed within sidebars; not within body elements).
395 * docutils/parsers/rst/directives/tables.py:
397   - Added "list-table" directive.
398   - Caught empty CSV table bug.
399   - Added support for the ``file_insertion_enabled`` setting in the
400     "csv-table" directive.
401   - Added ``stub-columns`` option to "csv-table" and "list-table"
402     directives.
404 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
405   mappings by Martijn Pieters.
407 * docutils/readers/standalone.py:
409   - Added ``--section-subtitles`` and ``--no-section-subtitles``
410     options to activate or deactivate the SectSubTitle transform.
412 * docutils/transforms/frontmatter.py:
414   - Added SectSubTitle transform to promote titles of lone
415     subsections to subtitles.
417 * docutils/transforms/references.py:
419   - Fixed mislocated internal targets bug, by propagating internal
420     targets to the next node, making use of the newly added support
421     for multiple names and IDs.
422   - Fixed duplicate footnote label bug.
423   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
424     transform.
426 * docutils/writers/html4css1.py:
428   - Fixed unencoded stylesheet reference bug (characters like "&" in
429     stylesheet references).
430   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
431     tags).
432   - Added support for multiple IDs per node by creating empty ``span``
433     tags.
434   - Added the ``field_name_limit`` & ``option_limit`` settings &
435     support.
436   - Added support for table stub columns.
437   - Added support for the ``align`` attribute on ``figure`` elements.
438   - Added the ``cloak_email_addresses`` setting & support.
439   - Added ``html_prolog``, ``html_head``, ``html_body``,
440     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
441     ``docutils.core.publish_parts``.
442   - Added support for section subtitles.
444 * docutils/writers/latex2e.py:
446   - Fixed tables starting with more than one multirow cell.
447   - Improved --use-latex-docinfo so that organization/contact/address
448     fields are lumped with the last author field and appear on the
449     titlepage.
450   - Made sure the titlepage is always shown with --use-latex-docinfo,
451     even if the document has no title.
452   - Made sure that latex doesn't fill in today's date if no date field
453     was given.
454   - Added support for section subtitles.
456 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
457   (under development).
459 * docutils/writers/null.py: Added to project; a do-nothing Writer.
461 * docs/api/publisher.txt:
463   - Added "``publish_parts`` Details" section.
465 * docutils/dev/repository.txt: Added to project; information about the
466   Docutils Subversion repository.
468 * docs/ref/docutils.dtd:
470   - Added a ``stub`` attribute to the ``colspec`` element via the
471     ``tbl.colspec.att`` parameter entity.
472   - Allowed topic elements within sidebars
473   - Added an ``align`` attribute to the ``figure`` element.
475 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
476   writer.
479 Release 0.3.7 (2004-12-24)
480 ==========================
482 * docutils/frontend.py:
484   - Added options: --input-encoding-error-handler,
485     --record-dependencies, --leave-footnote-reference-space,
486     --strict-visitor.
487   - Added command-line and config file support for "overrides" setting
488     parameter.
490 * docutils/io.py:
492   - Added support for input encoding error handler.
494 * docutils/nodes.py:
496   - Added dispatch_visit and dispatch_departure methods to
497     NodeVisitor; useful as a hook for Visitors.
498   - Changed structure of ``line_block``; added ``line``.
499   - Added ``compound`` node class.
500   - Added a mechanism for Visitors to transitionally ignore new node
501     classes.
503 * docutils/utils.py:
505   - Moved ``escape2null`` and ``unescape`` functions from
506     docutils/parsers/rst/states.py.
508 * docutils/parsers/rst/roles.py:
510   - Added "raw" role.
511   - Changed role function API: the "text" parameter now takes
512     null-escaped interpreted text content.
514 * docutils/parsers/rst/states.py:
516   - Fixed bug where a "role" directive in a nested parse would crash
517     the parser; the state machine's "language" attribute was not being
518     copied over.
519   - Added support for line block syntax.
520   - Fixed directive parsing bug: argument-less directives didn't
521     notice that arguments were present.
522   - Removed error checking for transitions.
523   - Added support for multiple classifiers in definition list items.
524   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
525   - Changed role function API: the "text" parameter now takes
526     null-escaped interpreted text content.
527   - Empty sections and documents are allowed now.
529 * docutils/parsers/rst/directives/__init__.py:
531   - Added ``encoding`` directive option conversion function.
532   - Allow multiple class names in class_option conversion function.
534 * docutils/parsers/rst/directives/body.py:
536   - Converted the line-block directive to use the new structure.
537   - Extracted the old line-block functionality to the ``block``
538     function (still used).
539   - Added ``compound`` directive (thanks to Felix Wiemann).
541 * docutils/parsers/rst/directives/misc.py:
543   - Added "encoding" option to "include" and "raw" directives.
544   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
545   - Allow multiple class names in the "class" directive.
547 * docutils/parsers/rst/directives/parts.py:
549   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
550     options.  Thanks to Lele Gaifax.
552 * docutils/parsers/rst/directives/tables.py:
554   - Added "encoding" directive to "csv-table" directive.
555   - Added workaround for lack of Unicode support in csv.py, for
556     non-ASCII CSV input.
558 * docutils/transforms/misc.py:
560   - Fixed bug when multiple "class" directives are applied to a single
561     element.
562   - Enabled multiple format names for "raw" directive.
564 * docutils/transforms/references.py:
566   - Added support for trimming whitespace from beside substitution
567     references.
569 * docutils/transforms/universal.py:
571   - FinalChecks now checks for illegal transitions and moves
572     transitions between sections.
574 * docutils/writers/html4css1.py:
576   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
577   - "stylesheet" and "stylesheet_path" settings are now mutually
578     exclusive.
579   - Added support for the new line_block/line structure.
580   - --footnote-references now overrides
581     --trim-footnote-reference-space, if applicable.
582   - Added support for ``compound`` elements.
583   - Enabled multiple format names for "raw" directive.
584   - ``<p>`` tags of a paragraph which is the only visible child of the
585     document node are no longer stripped.
586   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
587     new method ``should_be_compact_paragraph()``.
588   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
589     elements.
590   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
591     the output if they have their ``class`` attribute set.
592   - The whole document is now surrounded by a ``<div
593     class="document">`` element.
594   - Body-level images are now wrapped by their own ``<div>`` elements,
595     with image classes copied to the wrapper, and for images which
596     have the ``:align:`` option set, the surrounding ``<div>`` now
597     receives a class attribute (like ``class="align-left"``).
599 * docutils/writers/latex2e.py:
601   - no newline after depart_term.
602   - Added translations for some Unicode quotes.
603   - Added option "font-encoding", made package AE the default.
604   - "stylesheet" and "stylesheet_path" settings are now mutually
605     exclusive.
606   - --footnote-references now overrides
607     --trim-footnote-reference-space, if applicable.
608   - The footnote label style now matches the footnote reference style
609     ("brackets" or "superscript").
610   - Added support for ``compound`` elements.
611   - Enabled multiple format names for "raw" directive.
613 * docs/ref/docutils.dtd:
615   - Changed structure of the ``line_block`` element; added ``line``.
616   - Added ``compound`` element.
617   - Added "ltrim" and "rtrim" attributes to
618     ``substitution_definition`` element.
619   - Enabled multiple format names for ``raw`` element.
620   - Enabled multiple classifiers in ``definition_list_item`` elements.
622 * docs/ref/rst/directives.txt
624   - Marked "line-block" as deprecated.
625   - "Class" directive now allows multiple class names.
626   - Added "Rationale for Class Attribute Value Conversion".
627   - Added warning about "raw" overuse/abuse.
629 * docs/ref/rst/restructuredtext.txt:
631   - Added syntax for line blocks.
632   - Definition list items may have multiple classifiers.
634 * docs/ref/rst/roles.txt:
636   - Added "raw" role.
638 * tools/stylesheets/default.css:
640   - Added support for the new line_block structure.
641   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
644 Release 0.3.5 (2004-07-29)
645 ==========================
647 General:
649 * _`Documentation cleanup/reorganization`.
651   - Created new subdirectories of docs/:
653     * ``docs/user/``: introductory/tutorial material for end-users
654     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
655     * ``docs/api/``: API reference material for client-developers
656     * ``docs/ref/``: reference material for all groups
657     * ``docs/howto/``: for component-developers and core-developers
658     * ``docs/peps/``: Python Enhancement Proposals
660   - Moved ``docs/*`` to ``docs/user/``.
661   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
662     ``spec/`` to ``docs/dev``.
663   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
664     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
665   - Moved ``alternatives.txt``, and ``problems.txt`` from
666     ``spec/rst/`` to ``docs/dev/rst/``.
667   - Moved ``reStructuredText.txt``, ``directives.txt``,
668     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
669     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
670     ``roles.txt``, ``reStructuredText.txt`` to
671     ``restructuredtext.txt``.
672   - Moved ``spec/howto/`` to ``docs/howto``.
674   In order to keep the CVS history of moved files, we supplied
675   SourceForge with a `script for modifying the Docutils CVS
676   repository`__.
678   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
680   After running the cleanup script:
682   - Added ``docs/index.txt``.
683   - Added a ``.htaccess`` file to the ``web`` module, containing
684     redirects for all old paths to new paths.  They'll preserve
685     fragments (the "#name" part of a URL), and won't clutter up the
686     file system, and will correct the URL in the user's browser.
687   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
688     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
689     the "To Do" list itself in ``docs/dev/todo.txt``.
690   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
691     section of ``docs/dev/todo.txt``.
692   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
693   - Added "How To Report Bugs" to ``BUGS.txt``.
694   - Went through all the sources and docs (including under web/) and
695     updated links.  Mostly done by Felix Wiemann; thanks Felix!
696     (Still need to update links in the sandboxes.)
698 Specific:
700 * BUGS.txt: Added to project.
702 * THANKS.txt: Added to project.
704 * docutils/__init__.py:
706   - 0.3.4: Post-release.
708 * docutils/core.py:
710   - Added special error handling & advice for UnicodeEncodeError.
711   - Refactored Publisher.publish (simplified exception handling &
712     extracted debug dumps).
713   - Renamed "enable_exit" parameter of convenience functions to
714     "enable_exit_status".
715   - Enabled traceback (exception propagation) by default in
716     programmatic convenience functions.
717   - Now publish_file and publish_cmdline convenience functions return
718     the encoded string results in addition to their regular I/O.
719   - Extracted common code from publish_file, publish_string, and
720     publish_parts, into new publish_programmatically.  Extracted
721     settings code to ``Publisher.process_programmatic_settings``.
722   - In Publisher.publish, disabled ``settings_overrides`` when
723     ``settings`` is supplied; redundant.
725 * docutils/frontend.py:
727   - Added help text for "--output-encoding-error-handler" and
728     "--error-encoding-error-handler".
729   - Renamed "--exit" to "--exit-status".
730   - Simplified default-setting code.
732 * docutils/parsers/rst/__init__.py:
734   - Added "--pep-base-url" and "--rfc-base-url" options.
736 * docutils/parsers/rst/states.py:
738   - Made URI recognition more aggressive and intelligent.
740 * docutils/parsers/rst/directives/__init__.py:
742   - Added several directive option conversion functions.
744 * docutils/parsers/rst/directives/body.py:
746   - Moved "table" directive to tables.py.
748 * docutils/parsers/rst/directives/tables.py: Table-related directives,
749   added to project.
751 * docutils/writers/latex2e.py:
753   - Added "--table-style=(standard|booktabs|nolines)"
754   - figures get "here" option (LaTeX per default puts them at bottom),
755     and figure content is centered.
756   - Rowspan support for tables.
757   - Fix: admonition titles before first section.
758   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
759   - Replave ``_`` in literal by an underlined blank, because it has the correct
760     width.
761   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
762   - A few unicode replacements, if output_encoding != utf
763   - Add "--graphicx-option".
764   - Indent literal-blocks.
765   - Fix: omit ``\maketitle`` when there is no document title.
767 * docs/index.txt: "Docutils Project Documentation Overview", added to
768   project.
770 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
771   Tool", added to project.
773 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
775 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
777 * docs/dev/policies.txt: Added to project (extracted from
778   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
780 * docs/dev/release.txt: Added to project (extracted from
781   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
783 * docs/dev/testing.txt: Added to project.
785 * docs/dev/website.txt: Added to project (extracted from
786   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
788 * docs/ref/rst/directives.txt:
790   - Added directives: "table", "csv-table".
792 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
793   added to project.  1 page for syntax, and a 1 page reference for
794   directives and roles.  Source text to be used as-is; not meant to be
795   converted to HTML.
797 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
798   with a change of title.
800 * test/functional/, contents, and test/test_functional.py: Added to
801   project.
803 * tools/buildhtml.py: Fixed bug with config file handling.
805 * tools/html.py: Removed from project (duplicate of rst2html.py).
807 * tools/pep2html.py: Removed from project (duplicate of Python's
808   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
809   Docutils-related PEPs in docs/peps/).
811 * tools/rst2pseudoxml.py: Renamed from publish.py.
813 * tools/rst2xml.py: Renamed from docutils-xml.py.
815 * tools/test.txt: Removed from project; moved to
816   docs/user/rst/demo.txt.
818 * setup.py: Now also installs ``rst2latex.py``.
821 Release 0.3.3 (2004-05-09)
822 ==========================
824 * docutils/__init__.py:
826   - 0.3.1: Reorganized config file format (multiple sections); see
827     docs/config.txt.
828   - Added unknown_reference_resolvers attribute to TransformSpec.
829   - 0.3.2: Interpreted text reorganization.
830   - 0.3.3: Released.
832 * docutils/core.py:
834   - Catch system messages to stop tracebacks from parsing errors.
835   - Catch exceptions during processing report & exit without
836     tracebacks, except when "--traceback" used.
837   - Reordered components for OptionParser; application comes last.
838   - Added "config_section" parameter to several methods and functions,
839     allowing front ends to easily specify their config file sections.
840   - Added publish_parts convenience function to allow access to individual
841     parts of a document.
843 * docutils/examples.py: Added to project; practical examples of
844   Docutils client code, to be used as-is or as models for variations.
846 * docutils/frontend.py:
848   - Added "--traceback" & "--no-traceback" options ("traceback"
849     setting).
850   - Implemented support for config file reorganization:
851     ``standard_config_files`` moved from ``ConfigParser`` to
852     ``OptionParser``; added
853     ``OptionParser.get_config_file_settings()`` and
854     ``.get_standard_config_settings()``; support for old "[options]"
855     section (with deprecation warning) and mapping from old to new
856     settings.
857   - Reimplemented setting validation.
858   - Enabled flexible boolean values: yes/no, true/false, on/off.
859   - Added ``Values``, a subclass of ``optparse.Values``, with support
860     for list setting attributes.
861   - Added support for new ``DOCUTILSCONFIG`` environment variable;
862     thanks to Beni Cherniavsky.
863   - Added "--no-section-numbering" option.
865 * docutils/io.py:
867   - Catch IOErrors when opening source & destination files, report &
868     exit without tracebacks.  Added ``handle_io_errors`` parameter to
869     ``FileInput`` & ``FileOutput`` to enable caller error handling.
871 * docutils/nodes.py:
873   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
874     method definitions (via ``exec``) to dynamic assignments (via
875     ``setattr``); thanks to Roman Suzi.
876   - Encapsulated visitor dynamic assignments in a function; thanks to
877     Ian Bicking.
878   - Added indirect_reference_name attribute to the Targetable
879     class. This attribute holds the whitespace_normalized_name
880     (contains mixed case) of a target.
882 * docutils/statemachine.py:
884   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
885   - Added ``StringList.get_2D_block``.
887 * docutils/utils.py:
889   - Added "level" attribute to SystemMessage exceptions.
891 * docutils/languages/af.py: Added to project; Afrikaans mappings by
892   Jannie Hofmeyr.
894 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
895   Blaha.
897 * docutils/languages/eo.py: Added to project; Esperanto mappings by
898   Marcelo Huerta San Martin.
900 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
901   mappings by Lalo Martins.
903 * docutils/languages/ru.py: Added to project; Russian mappings by
904   Roman Suzi.
906 * docutils/parsers/rst/roles.py: Added to project.  Contains
907   interpreted text role functions, a registry for interpreted text
908   roles, and an API for adding to and retrieving from the registry.
909   Contributed by Edward Loper.
911 * docutils/parsers/rst/states.py:
913   - Updated ``RSTState.nested_parse`` for "include" in table cells.
914   - Allowed true em-dash character and "---" as block quote
915     attribution marker.
916   - Added support for <angle-bracketed> complex option arguments
917     (option lists).
918   - Fixed handling of backslashes in substitution definitions.
919   - Fixed off-by-1 error with extra whitespace after substitution
920     definition directive.
921   - Added inline markup parsing to field lists' field names.
922   - Added support for quoted (and unindented) literal blocks.
923     Driven in part by a bribe from Frank Siebenlist (thanks!).
924   - Parser now handles escapes in URIs correctly.
925   - Made embedded-URIs' reference text omittable.  Idea from Beni
926     Cherniavsky.
927   - Refactored explicit target processing code.
928   - Added name attribute to references containing the reference name only
929     through whitespace_normalize_name (no case changes).
930   - parse_target no longer returns the refname after going through
931     normalize_name. This is now handled in make_target.
932   - Fixed bug relating to role-less interpreted text in non-English
933     contexts.
934   - Reorganized interpreted text processing; moved code into the new
935     roles.py module.  Contributed by Edward Loper.
936   - Refactored ``Body.parse_directive`` into ``run_directive`` and
937     ``parse_directive_block``.
939 * docutils/parsers/rst/tableparser.py:
941   - Reworked for ``StringList``, to support "include" directives in
942     table cells.
944 * docutils/parsers/rst/directives/__init__.py:
946   - Renamed ``unchanged()`` directive option conversion function to
947     ``unchanged_required``, and added a new ``unchanged``.
948   - Catch unicode value too high error; fixes bug 781766.
949   - Beefed up directive error reporting.
951 * docutils/parsers/rst/directives/body.py:
953   - Added basic "table" directive.
955 * docutils/parsers/rst/directives/images.py:
957   - Added "target" option to "image" directive.
958   - Added name attribute to references containing the reference name only
959     through whitespace_normalize_name (no case changes).
961 * docutils/parsers/rst/directives/misc.py:
963   - Isolated the import of the ``urllib2`` module; was causing
964     problems on SourceForge (``libssl.so.2`` unavailable?).
965   - Added the "role" directive for declaring custom interpreted text
966     roles.
968 * docutils/parsers/rst/directives/parts.py:
970   - The "contents" directive does more work up-front, creating the
971     "topic" and "title", and leaving the "pending" node for the
972     transform.  Allows earlier reference resolution; fixes subtle bug.
974 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
975   mappings by Jannie Hofmeyr.
977 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
978   mappings by Marek Blaha.
980 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
981   mappings by Marcelo Huerta San Martin.
983 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
984   Portuguese mappings by Lalo Martins.
986 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
987   mappings by Roman Suzi.
989 * docutils/transforms/parts.py:
991   - The "contents" directive does more work up-front, creating the
992     "topic" and "title", and leaving the "pending" node for the
993     transform.  Allows earlier reference resolution; fixes subtle bug.
994   - Added support for disabling of section numbering.
996 * docutils/transforms/references.py:
998   - Verifying that external targets are truly targets and not indirect
999     references. This is because we are now adding a "name" attribute to
1000     references in addition to targets. Note sure if this is correct!
1001   - Added code to hook into the unknown_reference_resolvers list for a
1002     transformer in resolve_indirect_target. This allows the
1003     unknown_reference_resolvers to keep around indirect targets which
1004     docutils doesn't know about.
1005   - Added specific error message for duplicate targets.
1007 * docutils/transforms/universal.py:
1009   - Added FilterMessages transform (removes system messages below the
1010     verbosity threshold).
1011   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1012     to FinalCheckVisitor for application-specific handling of
1013     unresolvable references.
1014   - Added specific error message for duplicate targets.
1016 * docutils/writers/__init__.py:
1018   - Added assemble_parts method to the Writer class to allow for
1019     access to a documents individual parts.
1020   - Documented & set default for ``Writer.output`` attribute.
1022 * docutils/writers/html4css1.py:
1024   - Fixed unicode handling of attribute values (bug 760673).
1025   - Prevent duplication of "class" attribute values (bug report from
1026     Kirill Lapshin).
1027   - Improved table grid/border handling (prompted by report from Bob
1028     Marshall).
1029   - Added support for table titles.
1030   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1031     to Darek Suchojad.
1032   - Added functionality to keep track of individual parts of a document
1033     and store them in a dictionary as the "parts" attribute of the writer.
1034     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1035   - Added proper support for the "scale" attribute of the "image"
1036     element.  Contributed by Brent Cook.
1037   - Added ``--initial-header-level`` option.
1038   - Fixed bug: the body_pre_docinfo segment depended on there being a
1039     docinfo; if no docinfo, the document title was incorporated into
1040     the body segment.  Adversely affected the publish_parts interface.
1042 * docutils/writers/latex2e.py:
1044   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1045     about a missing file.
1046   - Added options and support: ``--compound-enumerators``,
1047     ``--section-prefix-for-enumerators``, and
1048     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1049     934322).
1050   - Added option ``--use-verbatim-when-possible``, to avoid
1051     problematic characters (eg, '~' in italian) in literal blocks.
1052   - It's now possible to use four section levels in the `book` and
1053     `report` LaTeX classes.  The default `article` class still has
1054     three levels limit.
1056 * docs/config.txt: "Docutils Configuration Files", added to project.
1057   Moved config file entry descriptions from tools.txt.
1059 * docs/tools.txt:
1061   - Moved config file entry descriptions to config.txt.
1063 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1064   Development".
1066 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1067   Text Roles", added to project.
1069 * spec/rst/reStructuredText.txt:
1071   - Added description of support for <angle-bracketed> complex option
1072     arguments to option lists.
1073   - Added subsections for indented and quoted literal blocks.
1075 * test: Continually adding & updating tests.
1077   - Added test/test_settings.py & test/data/config_*.txt support
1078     files.
1079   - Added test/test_writers/test_htmlfragment.py.
1081 * test/DocutilsTestSupport.py:
1083   - Refactored LaTeX publisher test suite/case class names to make
1084     testing other writers easier.
1085   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1086     to test the processing of HTML fragments which use the new
1087     publish_parts convenience function.
1089 * tools/buildhtml.py:
1091   - Added support for the "--prune" option.
1092   - Removed dependency on pep2html.py; plaintext PEPs no longer
1093     supported.
1095 * tools/docutils.conf:
1097   - Updated for configuration file reorganization.
1099 * tools/rst2html.py:
1101   - copied from tools/html.py
1103 * setup.py:
1105   - added a 'scripts' section to configuration
1106   - added 'tools/rst2html.py' to the scripts section
1109 Release 0.3 (2003-06-24)
1110 ========================
1112 General:
1114 * Renamed "attribute" to "option" for directives/extensions.
1116 * Renamed transform method "transform" to "apply".
1118 * Renamed "options" to "settings" for runtime settings (as set by
1119   command-line options).  Sometimes "option" (singular) became
1120   "settings" (plural).  Some variations below:
1122   - document.options -> document.settings (stored in other objects as
1123     well)
1124   - option_spec -> settings_spec (not directives though)
1125   - OptionSpec -> SettingsSpec
1126   - cmdline_options -> settings_spec
1127   - relative_path_options -> relative_path_settings
1128   - option_default_overrides -> settings_default_overrides
1129   - Publisher.set_options -> Publisher.get_settings
1131 Specific:
1133 * COPYING.txt: Added "Public Domain Dedication".
1135 * FAQ.txt: Frequently asked questions, added to project.
1137 * setup.py:
1139   - Updated with PyPI Trove classifiers.
1140   - Conditional installation of third-party modules.
1142 * docutils/__init__.py:
1144   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1145   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1146   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1147   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1148     option and its effect on the PEP template & writer.
1149   - Bumped version to 0.2.4 due to changes to the PEP template &
1150     stylesheet.
1151   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1152   - Added ``TransformSpec`` class for new transform system.
1153   - Bumped version to 0.2.6 for API changes (renaming).
1154   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1155     convenience functions.
1156   - Added ``Component.component_type`` attribute.
1157   - Bumped version to 0.2.8 because of the internal parser switch from
1158     plain lists to the docutils.statemachine.StringList objects.
1159   - Bumped version to 0.2.9 because of the frontend.py API changes.
1160   - Bumped version to 0.2.10 due to changes to the project layout
1161     (third-party modules removed from the "docutils" package), and
1162     signature changes in ``io.Input``/``io.Output``.
1163   - Changed version to 0.3.0 for release.
1165 * docutils/core.py:
1167   - Made ``publish()`` a bit more convenient.
1168   - Generalized ``Publisher.set_io``.
1169   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1170     parameters; improved its docstring.
1171   - Added ``publish_file()`` and ``publish_string()``.
1172   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1173     out of ``.set_io``.
1174   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1175     "--dump-transforms" hidden options.
1176   - Added ``Publisher.apply_transforms()`` method.
1177   - Added ``Publisher.set_components()`` method; support for
1178     ``publish_*()`` conveninece functions.
1179   - Moved config file processing to docutils/frontend.py.
1180   - Added support for exit status ("exit_level" setting &
1181     ``enable_exit`` parameter for Publisher.publish() and convenience
1182     functions).
1184 * docutils/frontend.py:
1186   - Check for & exit on identical source & destination paths.
1187   - Fixed bug with absolute paths & "--config".
1188   - Set non-command-line defaults in ``OptionParser.__init__()``:
1189     ``_source`` & ``_destination``.
1190   - Distributed ``relative_path_settings`` to components; updated
1191     ``OptionParser.populate_from_components()`` to combine it all.
1192   - Require list of keys in ``make_paths_absolute`` (was implicit in
1193     global ``relative_path_settings``).
1194   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1195     "--dump-settings", and "--dump-transforms" hidden options.
1196   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1197     code, replaced with correct code.
1198   - Added validation functionality for config files.
1199   - Added "--error-encoding" option/setting, "_disable_config"
1200     internal setting.
1201   - Added encoding validation; updated "--input-encoding" and
1202     "--output-encoding"; added "--error-encoding-error-handler" and
1203     "--output-encoding-error-handler".
1204   - Moved config file processing from docutils/core.py.
1205   - Updated ``OptionParser.populate_from_components`` to handle new
1206     ``SettingsSpec.settings_defaults`` dict.
1207   - Added support for "-" => stdin/stdout.
1208   - Added "exit_level" setting ("--exit" option).
1210 * docutils/io.py:
1212   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1213   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1214   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1215   - ``FileOutput.write()`` now returns the encoded output string.
1216   - Try to get path/stream name automatically in ``FileInput`` &
1217     ``FileOutput``.
1218   - Added defaults for source & destination paths.
1219   - Allow for Unicode I/O with an explicit "unicode" encoding.
1220   - Added ``Output.encode()``.
1221   - Removed dependency on runtime settings; pass encoding directly.
1222   - Recognize Unicode strings in ``Input.decode()``.
1223   - Added support for output encoding error handlers.
1225 * docutils/nodes.py:
1227   - Added "Invisible" element category class.
1228   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1229     modification during a traversal.
1230   - Added element classes: ``line_block``, ``generated``, ``address``,
1231     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1232     ``superscript``, ``subscript``, ``inline``
1233   - Added support for lists of nodes to ``Element.insert()``.
1234   - Fixed parent linking in ``Element.replace()``.
1235   - Added new abstract superclass ``FixedTextElement``; adds
1236     "xml:space" attribute.
1237   - Added support for "line" attribute of ``system_message`` nodes.
1238   - Added support for the observer pattern from ``utils.Reporter``.
1239     Added ``parse_messages`` and ``transform_messages`` attributes to
1240     ``document``, removed ``messages``.  Added ``note_parse_message``
1241     and ``note_transform_message`` methods.
1242   - Added support for improved diagnostics:
1244     - Added "document", "source", and "line" internal attributes to
1245       ``Node``, set by ``Node.setup_child()``.
1246     - Converted variations on ``node.parent = self`` to
1247       ``self.setup_child(node)``.
1248     - Added ``document.current_source`` & ``.current_line``
1249       attributes, and ``.note_source`` observer method.
1250     - Changed "system_message" output to GNU-Tools format.
1252   - Added a "rawsource" attribute to the ``Text`` class, for text
1253     before backslash-escape resolution.
1254   - Support for new transform system.
1255   - Reworked ``pending`` element.
1256   - Fixed XML DOM bug (SF #660611).
1257   - Removed the ``interpeted`` element class and added
1258     ``title_reference``, ``abbreviation``, ``acronym``.
1259   - Made substitutions case-sensitive-but-forgiving; moved some code
1260     from the parser.
1261   - Fixed Unicode bug on element attributes (report: William Dode).
1263 * docutils/optik.py: Removed from project; replaced with
1264   extras/optparse.py and extras/textwrap.py.  These will be installed
1265   only if they're not already present in the Python installation.
1267 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1268   only if it's not already present in the Python installation.
1270 * docutils/statemachine.py:
1272   - Factored out ``State.add_initial_transitions()`` so it can be
1273     extended.
1274   - Converted whitespace-specific "blank" and "indent" transitions
1275     from special-case code to ordinary transitions: removed
1276     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1277     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1278     ``ws_initial_transitions`` attributes.
1279   - Removed ``State.match_transition()`` after merging it into
1280     ``.check_line()``.
1281   - Added ``StateCorrection`` exception.
1282   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1283     (moved ``TransitionCorrection`` support there too.)
1284   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1285     ``EOFError`` instead of ``IndexError``.
1286   - Added ``State.no_match`` method.
1287   - Added support for the Observer pattern, triggered by input line
1288     changes.
1289   - Added ``strip_top`` parameter to
1290     ``StateMachineWS.get_first_known_indented``.
1291   - Made ``context`` a parameter to ``StateMachine.run()``.
1292   - Added ``ViewList`` & ``StringList`` classes;
1293     ``extract_indented()`` becomes ``StringList.get_indented()``.
1294   - Added ``StateMachine.insert_input()``.
1295   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1296     thanks to) Fred Drake.
1298 * docutils/utils.py:
1300   - Added a ``source`` attribute to Reporter instances and
1301     ``system_message`` elements.
1302   - Added an observer pattern to ``utils.Reporter`` to keep track of
1303     system messages.
1304   - Fixed bugs in ``relative_path()``.
1305   - Added support for improved diagnostics.
1306   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1307   - Added support for encoding Reporter stderr output, and encoding
1308     error handlers.
1309   - Reporter keeps track of the highest level system message yet
1310     generated.
1312 * docutils/languages: Fixed bibliographic field language lookups.
1314 * docutils/languages/es.py: Added to project; Spanish mappings by
1315   Marcelo Huerta San Martin.
1317 * docutils/languages/fr.py: Added to project; French mappings by
1318   Stefane Fermigier.
1320 * docutils/languages/it.py: Added to project; Italian mappings by
1321   Nicola Larosa.
1323 * docutils/languages/sk.py: Added to project; Slovak mappings by
1324   Miroslav Vasko.
1326 * docutils/parser/__init__.py:
1328   - Added ``Parser.finish_parse()`` method.
1330 * docutils/parser/rst/__init__.py:
1332   - Added options: "--pep-references", "--rfc-references",
1333     "--tab-width", "--trim-footnote-reference-space".
1335 * docutils/parsers/rst/states.py:
1337   - Changed "title under/overline too short" system messages from INFO
1338     to WARNING, and fixed its insertion location.
1339   - Fixed enumerated list item parsing to allow paragraphs & section
1340     titles to begin with enumerators.
1341   - Converted system messages to use the new "line" attribute.
1342   - Fixed a substitution reference edge case.
1343   - Added support for "--pep-references" and "--rfc-references"
1344     options; reworked ``Inliner`` code to make customization easier.
1345   - Removed field argument parsing.
1346   - Added support for short section title over/underlines.
1347   - Fixed "simple reference name" regexp to ignore text like
1348     "object.__method__"; not an anonymous reference.
1349   - Added support for improved diagnostics.
1350   - Reworked directive API, based on Dethe Elza's contribution.  Added
1351     ``Body.parse_directive()``, ``.parse_directive_options()``,
1352     ``.parse_directive_arguments()`` methods.
1353   - Added ``ExtensionOptions`` class, to parse directive options
1354     without parsing field bodies.  Factored
1355     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1356     ``ExtensionOptions``.
1357   - Improved definition list term/classifier parsing.
1358   - Added warnings for unknown directives.
1359   - Renamed ``Stuff`` to ``Struct``.
1360   - Now flagged as errors: transitions at the beginning or end of
1361     sections, empty sections (except title), and empty documents.
1362   - Updated for ``statemachine.StringList``.
1363   - Enabled recognition of schemeless email addresses in targets.
1364   - Added support for embedded URIs in hyperlink references.
1365   - Added backslash-escapes to inline markup end-string suffix.
1366   - Added support for correct interpreted text processing.
1367   - Fixed nested title parsing (topic, sidebar directives).
1368   - Added special processing of backslash-escaped whitespace (idea
1369     from David Abrahams).
1370   - Made substitutions case-sensitive-but-forgiving; moved some code
1371     to ``docutils.nodes``.
1372   - Added support for block quote attributions.
1373   - Added a kludge to work-around a conflict between the bubble-up
1374     parser strategy and short titles (<= 3 char-long over- &
1375     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1376     titles" submitted by Jason Diamond.
1377   - Added explicit interpreted text roles for standard inline markup:
1378     "emphasis", "strong", "literal".
1379   - Implemented "superscript" and "subscript" interpreted text roles.
1380   - Added initial support for "abbreviation" and "acronym" roles;
1381     incomplete.
1382   - Added support for "--trim-footnote-reference-space" option.
1383   - Optional space before colons in directives & hyperlink targets.
1385 * docutils/parsers/rst/tableparser.py:
1387   - Fixed a bug that was producing unwanted empty rows in "simple"
1388     tables.
1389   - Detect bad column spans in "simple" tables.
1391 * docutils/parsers/rst/directives: Updated all directive functions to
1392   new API.
1394 * docutils/parsers/rst/directives/__init__.py:
1396   - Added ``flag()``, ``unchanged()``, ``path()``,
1397     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1398     directive option helper functions.
1399   - Added warnings for unknown directives.
1400   - Return ``None`` for missing directives.
1401   - Added ``register_directive()``, thanks to William Dode and Paul
1402     Moore.
1404 * docutils/parsers/rst/directives/admonitions.py:
1406   - Added "admonition" directive.
1408 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1409   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1410   "parsed-literal", "rubric", "epigraph", "highlights" and
1411   "pull-quote" directives.
1413 * docutils/parsers/rst/directives/images.py:
1415   - Added an "align" attribute to the "image" & "figure" directives
1416     (by Adam Chodorowski).
1417   - Added "class" option to "image", and "figclass" to "figure".
1419 * docutils/parsers/rst/directives/misc.py:
1421   - Added "include", "raw", and "replace" directives, courtesy of
1422     Dethe Elza.
1423   - Added "unicode" and "class" directives.
1425 * docutils/parsers/rst/directives/parts.py:
1427   - Added the "sectnum" directive; by Dmitry Jemerov.
1428   - Added "class" option to "contents" directive.
1430 * docutils/parsers/rst/directives/references.py: Added to project.
1431   Contains the "target-notes" directive.
1433 * docutils/parsers/rst/languages/__init__.py:
1435   - Return ``None`` from get_language() for missing language modules.
1437 * docutils/parsers/rst/languages/de.py: Added to project; German
1438   mappings by Engelbert Gruber.
1440 * docutils/parsers/rst/languages/en.py:
1442   - Added interpreted text roles mapping.
1444 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1445   mappings by Marcelo Huerta San Martin.
1447 * docutils/parsers/rst/languages/fr.py: Added to project; French
1448   mappings by William Dode.
1450 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1451   mappings by Nicola Larosa.
1453 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1454   mappings by Miroslav Vasko.
1456 * docutils/readers/__init__.py:
1458   - Added support for the observer pattern from ``utils.Reporter``, in
1459     ``Reader.parse`` and ``Reader.transform``.
1460   - Removed ``Reader.transform()`` method.
1461   - Added default parameter values to ``Reader.__init__()`` to make
1462     instantiation easier.
1463   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1465 * docutils/readers/pep.py:
1467   - Added the ``peps.TargetNotes`` transform to the Reader.
1468   - Removed PEP & RFC reference detection code; moved to
1469     parsers/rst/states.py as options (enabled here by default).
1470   - Added support for pre-acceptance PEPs (no PEP number yet).
1471   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1472     easy subclassing.
1474 * docutils/readers/python: Python Source Reader subpackage added to
1475   project, including preliminary versions of:
1477   - __init__.py
1478   - moduleparser.py: Parser for Python modules.
1480 * docutils/transforms/__init__.py:
1482   - Added ``Transformer`` class and completed transform reform.
1483   - Added unknown_reference_resolvers list for each transformer. This list holds
1484     the list of functions provided by each component of the transformer that
1485     help resolve references.
1487 * docutils/transforms/frontmatter.py:
1489   - Improved support for generic fields.
1490   - Fixed bibliographic field language lookups.
1492 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1493   transforms.
1495 * docutils/transforms/parts.py:
1497   - Moved the "id" attribute from TOC list items to the references
1498     (``Contents.build_contents()``).
1499   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1500   - Added "class" attribute support to ``Contents``.
1502 * docutils/transforms/peps.py:
1504   - Added ``mask_email()`` function, updating to pep2html.py's
1505     functionality.
1506   - Linked "Content-Type: text/x-rst" to PEP 12.
1507   - Added the ``TargetNotes`` PEP-specific transform.
1508   - Added ``TargetNotes.cleanup_callback``.
1509   - Added title check to ``Headers``.
1511 * docutils/transforms/references.py:
1513   - Added the ``TargetNotes`` generic transform.
1514   - Split ``Hyperlinks`` into multiple transforms.
1515   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1516   - Added check for circular indirect references.
1517   - Made substitutions case-sensitive-but-forgiving.
1519 * docutils/transforms/universal.py:
1521   - Added support for the "--expose-internal-attributes" option.
1522   - Removed ``Pending`` transform classes & data.
1524 * docutils/writers/__init__.py:
1526   - Removed ``Writer.transform()`` method.
1528 * docutils/writers/docutils-xml.py:
1530   - Added XML and doctype declarations.
1531   - Added "--no-doctype" and "--no-xml-declaration" options.
1533 * docutils/writers/html4css1.py:
1535   - "name" attributes only on these tags: a, applet, form, frame,
1536     iframe, img, map.
1537   - Added "name" attribute to <a> in section titles for Netscape 4
1538     support (bug report: Pearu Peterson).
1539   - Fixed targets (names) on footnote, citation, topic title,
1540     problematic, and system_message nodes (for Netscape 4).
1541   - Changed field names from "<td>" to "<th>".
1542   - Added "@" to "&#64;" encoding to thwart address harvesters.
1543   - Improved the vertical whitespace optimization; ignore "invisible"
1544     nodes (targets, comments, etc.).
1545   - Improved inline literals with ``<span class="pre">`` around chunks
1546     of text and ``&nbsp;`` for runs of spaces.
1547   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1548     ``self.docinfo`` segments.
1549   - Added support for "line_block", "address" elements.
1550   - Improved backlinks (footnotes & system_messages).
1551   - Improved system_message output.
1552   - Redefined "--stylesheet" as containing an invariant URL, used
1553     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1554     working directory.
1555   - Added "--footnote-references" option (superscript or brackets).
1556   - Added "--compact-lists" and "--no-compact-lists" options.
1557   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1558     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1559   - Improved field list rendering.
1560   - Added Docutils version to "generator" meta tag.
1561   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1562   - Improved layout of <pre> HTML source.
1563   - Fixed attribute typo on <colspec>.
1564   - Refined XML prologue.
1565   - Support for no stylesheet.
1566   - Removed "interpreted" element support.
1567   - Added support for "title_reference", "sidebar", "attribution",
1568     "rubric", and generic "admonition" elements.
1569   - Added "--attribution" option.
1570   - Added support for "inline", "subscript", "superscript" elements.
1571   - Added initial support for "abbreviation" and "acronym";
1572     incomplete.
1574 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1575   (from the sandbox).
1577   - Added french.
1578   - Double quotes in literal blocks (special treatment for de/ngerman).
1579   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1580   - Added  "--attribution" option.
1581   - Right align attributions.
1583 * docutils/writers/pep_html.py:
1585   - Parameterized output encoding in PEP template.
1586   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1587   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1588     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1589     working directory.
1590   - Added an override on the "--footnote-references" option.
1591   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1592   - Added Docutils version to "generator" meta tag.
1593   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1595 * docs/tools.txt:
1597   - Added a "silent" setting for ``buildhtml.py``.
1598   - Added a "Getting Help" section.
1599   - Rearranged the structure.
1600   - Kept up to date, with new settings, command-line options etc.
1601   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1602   - Converted settings table into a definition list.
1604 * docs/rst/quickstart.txt:
1606   - Added a table of contents.
1607   - Added feedback information.
1608   - Added mention of minimum section title underline lengths.
1609   - Removed the 4-character minimum for section title underlines.
1611 * docs/rst/quickref.html:
1613   - Added a "Getting Help" section.
1614   - Added a style to make section title backlinks more subtle.
1615   - Added mention of minimum section title underline lengths.
1616   - Removed the 4-character minimum for section title underlines.
1618 * extras: Directory added to project; contains third-party modules
1619   that Docutils depends on (optparse, textwrap, roman).  These are
1620   only installed if they're not already present.
1622 * licenses: Directory added to project; contains copies of license
1623   files for non-public-domain files.
1625 * spec/doctree.txt:
1627   - Changed the focus.  It's about DTD elements:  structural
1628     relationships, semantics, and external (public) attributes.  Not
1629     about the element class library.
1630   - Moved some implementation-specific stuff into ``docutils.nodes``
1631     docstrings.
1632   - Wrote descriptions of all common attributes and parameter
1633     entities.  Filled in introductory material.
1634   - Working through the element descriptions: 55 down, 37 to go.
1635   - Removed "Representation of Horizontal Rules" to
1636     spec/rst/alternatives.txt.
1638 * spec/docutils.dtd:
1640   - Added "generated" inline element.
1641   - Added "line_block" body element.
1642   - Added "auto" attribute to "title".
1643   - Changed content models of "literal_block" and "doctest_block" to
1644     ``%text.model``.
1645   - Added ``%number;`` attribute type parameter entity.
1646   - Changed ``%structural.elements;`` to ``%section.elements``.
1647   - Updated attribute types; made more specific.
1648   - Added "address" bibliographic element.
1649   - Added "line" attribute to ``system_message`` element.
1650   - Removed "field_argument" element; "field_name" may contain
1651     multiple words and whitespace.
1652   - Changed public identifier to docutils.sf.net.
1653   - Removed "interpreted" element; added "title_reference",
1654     "abbreviation", "acronym".
1655   - Removed "refuri" attribute from "footnote_reference" and
1656     "citation_reference".
1657   - Added "sidebar", "rubric", "attribution", "admonition",
1658     "superscript", "subscript", and "inline" elements.
1660 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1662 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1664 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1666 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1667   Dallas Mahrt.
1669 * spec/transforms.txt: Added to project.
1671 * spec/howto: Added subdirectory, for developer how-to docs.
1673 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1674   Elza, edited & extended by David Goodger.
1676 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1677   project.
1679 * spec/rst/alternatives.txt:
1681   - Added "Doctree Representation of Transitions" from
1682     spec/doctree.txt.
1683   - Updated "Inline External Targets" & closed the debate.
1684   - Added ideas for interpreted text syntax extensions.
1685   - Added "Nested Inline Markup" section.
1687 * spec/rst/directives.txt:
1689   - Added directives: "topic", "sectnum", "target-notes",
1690     "line-block", "parsed-literal", "include", "replace", "sidebar",
1691     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1692     "class".
1693   - Formalized descriptions of directive details.
1694   - Added an "align" attribute to the "image" & "figure" directives
1695     (by Adam Chodorowski).
1696   - Added "class" options to "topic", "sidebar", "line-block",
1697     "parsed-literal", "contents", and "image"; and "figclass" to
1698     "figure".
1700 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1701   interpreted text roles.
1703 * spec/rst/introduction.txt:
1705   - Added pointers to material for new users.
1707 * spec/rst/reStructuredText.txt:
1709   - Disambiguated comments (just add a newline after the "::").
1710   - Updated enumerated list description; added a discussion of the
1711     second-line validity checking.
1712   - Updated directive description.
1713   - Added a note redirecting newbies to the user docs.
1714   - Expanded description of inline markup start-strings in non-markup
1715     contexts.
1716   - Removed field arguments and made field lists a generic construct.
1717   - Removed the 4-character minimum for section title underlines.
1718   - Clarified term/classifier delimiter & inline markup ambiguity
1719     (definition lists).
1720   - Added "Embedded URIs".
1721   - Updated "Interpreted Text" section.
1722   - Added "Character-Level Inline Markup" section.
1724 * test: Continually adding & updating tests.
1726   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1727   - Moved test/test_pep/ to test/test_readers/test_pep/.
1728   - Added test/test_readers/test_python/.
1729   - Added test/test_writers/ (Engelbert Gruber).
1731 * tools:
1733   - Made the ``locale.setlocale()`` calls in front ends
1734     fault-tolerant.
1736 * tools/buildhtml.py:
1738   - Added "--silent" option.
1739   - Fixed bug with absolute paths & "--config".
1740   - Updated for new I/O classes.
1741   - Added some exception handling.
1742   - Separated publishers' setting defaults; prevents interference.
1743   - Updated for new ``publish_file()`` convenience function.
1745 * tools/pep-html-template:
1747   - Allow for "--embed-stylesheet".
1748   - Added Docutils version to "generator" meta tag.
1749   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1750   - Conform to XHTML spec.
1752 * tools/pep2html.py:
1754   - Made ``argv`` a parameter to ``main()``.
1755   - Added support for "Content-Type:" header & arbitrary PEP formats.
1756   - Linked "Content-Type: text/plain" to PEP 9.
1757   - Files skipped (due to an error) are not pushed onto the server.
1758   - Updated for new I/O classes.
1759   - Added ``check_requirements()`` & ``pep_type_error()``.
1760   - Added some exception handling.
1761   - Updated for new ``publish_string()`` convenience function.
1762   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1764 * tools/quicktest.py:
1766   - Added "-V"/"--version" option.
1768 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1770 * tools/unicode2rstsubs.py: Added to project.  Produces character
1771   entity files (reSructuredText substitutions) from the MathML master
1772   unicode.xml file.
1774 * tools/editors: Support code for editors, added to project.  Contains
1775   ``emacs/restructuredtext.el``.
1777 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1779   - Added style for chunks of inline literals.
1780   - Removed margin for first child of table cells.
1781   - Right-aligned field list names.
1782   - Support for auto-numbered section titles in TOCs.
1783   - Increased the size of inline literals (<tt>) in titles.
1784   - Restored the light gray background for inline literals.
1785   - Added support for "line_block" elements.
1786   - Added style for "address" elements.
1787   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1788   - Improved field list rendering.
1789   - Vertical whitespace improvements.
1790   - Removed "a.target" style.
1792 * tools/stylesheets/pep.css:
1794   - Fixed nested section margins.
1795   - Other changes parallel those of ``../default.css``.
1798 Release 0.2 (2002-07-31)
1799 ========================
1801 General:
1803 - The word "component" was being used ambiguously.  From now on,
1804   "component" will be used to mean "Docutils component", as in Reader,
1805   Writer, Parser, or Transform.  Portions of documents (Table of
1806   Contents, sections, etc.)  will be called "document parts".
1807 - Did a grand renaming: a lot of ``verylongnames`` became
1808   ``very_long_names``.
1809 - Cleaned up imports: no more relative package imports or
1810   comma-separated lists of top-level modules.
1811 - Added support for an option values object which carries default
1812   settings and overrides (from command-line options and library use).
1813 - Added internal Unicode support, and support for both input and
1814   output encodings.
1815 - Added support for the ``docutils.io.IO`` class & subclasses.
1817 Specific:
1819 * docutils/__init__.py:
1821   - Added ``ApplicationError`` and ``DataError``, for use throughout
1822     the package.
1823   - Added ``Component`` base class for Docutils components; implements
1824     the ``supports`` method.
1825   - Added ``__version__`` (thus, ``docutils.__version__``).
1827 * docutils/core.py:
1829   - Removed many keyword parameters to ``Publisher.__init__()`` and
1830     ``publish()``; bundled into an option values object.  Added
1831     "argv", "usage", "description", and "option_spec" parameters for
1832     command-line support.
1833   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1834     methods.
1835   - Reworked I/O model for ``docutils.io`` wrappers.
1836   - Updated ``Publisher.set_options()``; now returns option values
1837     object.
1838   - Added support for configuration files (/etc/docutils.conf,
1839     ./docutils.conf, ~/.docutils).
1840   - Added ``Publisher.setup_option_parser()``.
1841   - Added default usage message and description.
1843 * docutils/frontend.py: Added to project; support for front-end
1844   (command-line) scripts.  Option specifications may be augmented by
1845   components.  Requires Optik (http://optik.sf.net/) for option
1846   processing (installed locally as docutils/optik.py).
1848 * docutils/io.py: Added to project; uniform API for a variety of input
1849   output mechanisms.
1851 * docutils/nodes.py:
1853   - Added ``TreeCopyVisitor`` class.
1854   - Added a ``copy`` method to ``Node`` and subclasses.
1855   - Added a ``SkipDeparture`` exception for visitors.
1856   - Renamed ``TreePruningException`` from ``VisitorException``.
1857   - Added docstrings to ``TreePruningException``, subclasses, and
1858     ``Nodes.walk()``.
1859   - Improved docstrings.
1860   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1861   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1862     imports.
1863   - Added ``decoration``, ``header``, and ``footer`` node classes, and
1864     ``PreDecorative`` mixin.
1865   - Reworked the name/id bookkeeping; to ``document``, removed
1866     ``explicit_targets`` and ``implicit_targets`` attributes, added
1867     ``nametypes`` attribute and ``set_name_id_map`` method.
1868   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1869     traversals.
1870   - Added ``document.has_name()`` method.
1871   - Fixed DOM generation for list-attributes.
1872   - Added category class ``Labeled`` (used by footnotes & citations).
1873   - Added ``Element.set_class()`` method (sets "class" attribute).
1875 * docutils/optik.py: Added to project.  Combined from the Optik
1876   package, with added option groups and other modifications.  The use
1877   of this module is probably only temporary.
1879 * docutils/statemachine.py:
1881   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1882   - Added underscores to improve many awkward names.
1883   - In ``string2lines()``, changed whitespace normalizing translation
1884     table to regexp; restores Python 2.0 compatibility with Unicode.
1886 * docutils/urischemes.py:
1888   - Filled in some descriptions.
1889   - Added "shttp" scheme.
1891 * docutils/utils.py:
1893   - Added ``clean_rcs_keywords`` function (moved from
1894     docutils/transforms/frontmatter.py
1895     ``DocInfo.filter_rcs_keywords``).
1896   - Added underscores to improve many awkward names.
1897   - Changed names of Reporter's thresholds:
1898     warning_level -> report_level; error_level -> halt_level.
1899   - Moved ``utils.id()`` to ``nodes.make_id()``.
1900   - Added ``relative_path(source, target)``.
1902 * docutils/languages/de.py: German mappings; added to project.  Thanks
1903   to Gunnar Schwant for the translations.
1905 * docutils/languages/en.py: Added "Dedication" bibliographic field
1906   mappings.
1908 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1909   Chodorowski.
1911 * docutils/parsers/rst/states.py:
1913   - Added underscores to improve many awkward names.
1914   - Added RFC-2822 header support.
1915   - Extracted the inline parsing code from ``RSTState`` to a separate
1916     class, ``Inliner``, which will allow easy subclassing.
1917   - Made local bindings for ``memo`` container & often-used contents
1918     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
1919   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1920   - Added ``MarkupMismatch`` exception; for late corrections.
1921   - Added ``-/:`` characters to inline markup's start string prefix,
1922     ``/`` to end string suffix.
1923   - Fixed a footnote bug.
1924   - Fixed a bug with literal blocks.
1925   - Applied patch from Simon Budig: simplified regexps with symbolic
1926     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1927   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1928   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1929   - Allowed non-ASCII in "simple names" (directive names, field names,
1930     references, etc.).
1931   - Converted ``Inliner.patterns.initial`` to be dynamically built
1932     from parts with ``build_regexp()`` function.
1933   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1934   - Updated docstrings.
1935   - Changed "table" to "grid_table"; added "simple_table" support.
1937 * docutils/parsers/rst/tableparser.py:
1939   - Changed ``TableParser`` to ``GridTableParser``.
1940   - Added ``SimpleTableParser``.
1941   - Refactored naming.
1943 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1944   a fallback language for directive names.
1946 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1947   directive to use a ``pending`` element, used only by HTML writers.
1949 * docutils/parsers/rst/directives/parts.py: Renamed from
1950   components.py.
1952   - Added "backlinks" attribute to "contents" directive.
1954 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1955   project by Adam Chodorowski.
1957 * docutils/readers/__init__.py: Gave Readers more control over
1958   choosing and instantiating Parsers.
1960 * docutils/readers/pep.py: Added to project; for PEP processing.
1962 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1963   requires a ``component`` parameter.
1965 * docutils/transforms/components.py: Added to project; transforms
1966   related to Docutils components.
1968 * docutils/transforms/frontmatter.py:
1970   - In ``DocInfo.extract_authors``, check for a single "author" in an
1971     "authors" group, and convert it to a single "author" element.
1972   - Added support for "Dedication" and generic bibliographic fields.
1974 * docutils/transforms/peps.py: Added to project; PEP-specific.
1976 * docutils/transforms/parts.py: Renamed from old components.py.
1978   - Added filter for `Contents`, to use alt-text for inline images,
1979     and to remove inline markup that doesn't make sense in the ToC.
1980   - Added "name" attribute to TOC topic depending on its title.
1981   - Added support for optional TOC backlinks.
1983 * docutils/transforms/references.py: Fixed indirect target resolution
1984   in ``Hyperlinks`` transform.
1986 * docutils/transforms/universal.py:
1988   - Changed ``Messages`` transform to properly filter out system
1989     messages below the warning threshold.
1990   - Added ``Decorations`` transform (support for ``--generator``,
1991     ``--date``, ``--time``, ``--source-link`` options).
1993 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1994   Engelbert Gruber's PDF writer.
1996 * docutils/writers/html4css1.py:
1998   - Made XHTML-compatible (switched to lowercase element & attribute
1999     names; empty tag format).
2000   - Escape double-dashes in comment text.
2001   - Improved boilerplate & modularity of output.
2002   - Exposed modular output in Writer class.
2003   - Added a "generator" meta tag to <head>.
2004   - Added support for the ``--stylesheet`` option.
2005   - Added support for ``decoration``, ``header``, and ``footer``
2006     elements.
2007   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2008     translation table to regexp; restores Python 2.0 compatibility
2009     with Unicode.
2010   - Added the translator class as instance variable to the Writer, to
2011     make it easily subclassable.
2012   - Improved option list spacing (thanks to Richard Jones).
2013   - Modified field list output.
2014   - Added backlinks to footnotes & citations.
2015   - Added percentage widths to "<col>" tags (from colspec).
2016   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2017     "<span>" changed to "<var>".
2018   - Inline literals: "<code>" changed to "<tt>".
2019   - Many changes to optimize vertical space: compact simple lists etc.
2020   - Add a command-line options & directive attributes to control TOC
2021     and footnote/citation backlinks.
2022   - Added support for optional footnote/citation backlinks.
2023   - Added support for generic bibliographic fields.
2024   - Identify backrefs.
2025   - Relative URLs for stylesheet links.
2027 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2028   PEPs (subclass of ``html4css1.Writer``).
2030 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2032 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2033   of the Docutils internal doctree in XML.
2035 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2037 * spec/doctree.txt:
2039   - Changed the title to "The Docutils Document Tree".
2040   - Added "Hyperlink Bookkeeping" section.
2042 * spec/docutils.dtd:
2044   - Added ``decoration``, ``header``, and ``footer`` elements.
2045   - Brought ``interpreted`` element in line with the parser: changed
2046     attribute "type" to "role", added "position".
2047   - Added support for generic bibliographic fields.
2049 * spec/notes.txt: Continual updates.  Added "Project Policies".
2051 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2052   section.
2054 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2056 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2057   mailing list discussions.
2059 * spec/pep-0287.txt:
2061   - Renamed to "reStructuredText Docstring Format".
2062   - Minor edits.
2063   - Reworked Q&A as an enumerated list.
2064   - Converted to reStructuredText format.
2066 * spec/pysource.dtd:
2068   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2070 * spec/pysource.txt: Removed from project.  Moved much of its contents
2071   to pep-0258.txt.
2073 * spec/rst/alternatives.txt:
2075   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2076   - Added "Inline External Targets" section.
2078 * spec/rst/directives.txt:
2080   - Added "backlinks" attribute to "contents" directive.
2082 * spec/rst/problems.txt:
2084   - Updated the Enumerated List Markup discussion.
2085   - Added new alternative table markup syntaxes.
2087 * spec/rst/reStructuredText.txt:
2089   - Clarified field list usage.
2090   - Updated enumerated list description.
2091   - Clarified purpose of directives.
2092   - Added ``-/:`` characters to inline markup's start string prefix,
2093     ``/`` to end string suffix.
2094   - Updated "Authors" bibliographic field behavior.
2095   - Changed "inline hyperlink targets" to "inline internal targets".
2096   - Added "simple table" syntax to supplement the existing but
2097     newly-renamed "grid tables".
2098   - Added cautions for anonymous hyperlink use.
2099   - Added "Dedication" and generic bibliographic fields.
2101 * test: Made test modules standalone (subdirectories became packages).
2103 * test/DocutilsTestSupport.py:
2105   - Added support for PEP extensions to reStructuredText.
2106   - Added support for simple tables.
2107   - Refactored naming.
2109 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2111   - Now supports true packages containing test modules
2112     (``__init__.py`` files required); fixes duplicate module name bug.
2114 * test/test_pep/: Subpackage added to project; PEP testing.
2116 * test/test_rst/test_SimpleTableParser.py: Added to project.
2118 * tools:
2120   - Updated html.py and publish.py front-end tools to use the new
2121     command-line processing facilities of ``docutils.frontend``
2122     (exposed in ``docutils.core.Publisher``), reducing each to just a
2123     few lines of code.
2124   - Added ``locale.setlocale()`` calls to front-end tools.
2126 * tools/buildhtml.py: Added to project; batch-generates .html from all
2127   the .txt files in directories and subdirectories.
2129 * tools/default.css:
2131   - Added support for ``header`` and ``footer`` elements.
2132   - Added styles for "Dedication" topics (biblio fields).
2134 * tools/docutils.conf: A configuration file; added to project.
2136 * tools/docutils-xml.py: Added to project.
2138 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2140 * tools/pep-html-template: Added to project.
2142 * tools/pep2html.py: Added to project from Python (nondist/peps).
2143   Added support for Docutils (reStructuredText PEPs).
2145 * tools/quicktest.py:
2147   - Added the ``--attributes`` option, hacked a bit.
2148   - Added a second command-line argument (output file); cleaned up.
2150 * tools/stylesheets/: Subdirectory added to project.
2152 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2155 Release 0.1 (2002-04-20)
2156 ========================
2158 This is the first release of Docutils, merged from the now inactive
2159 reStructuredText__ and `Docstring Processing System`__ projects.  For
2160 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2161 `DPS HISTORY`__ files.
2163 __ http://structuredtext.sourceforge.net/
2164 __ http://docstring.sourceforge.net/
2165 __ http://structuredtext.sourceforge.net/HISTORY.html
2166 __ http://docstring.sourceforge.net/HISTORY.html
2168 General changes: renamed 'dps' package to 'docutils'; renamed
2169 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2170 the test suites (reStructuredText's test/test_states renamed to
2171 test/test_rst); and all modifications required to make it all work.
2173 * docutils/parsers/rst/states.py:
2175   - Improved diagnostic system messages for missing blank lines.
2176   - Fixed substitution_reference bug.
2180    Local Variables:
2181    mode: indented-text
2182    indent-tabs-mode: nil
2183    sentence-end-double-space: t
2184    fill-column: 70
2185    End: