sf-bug 1488740: unicode strings dont support translate delete-chars.
[docutils.git] / HISTORY.txt
blob4f74e6aca5859bbeba18205a11ee6fe32fa2f359
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).
30 * docutils/nodes.py:
32   - Added ``document.__getstate__`` method, for pickling.
34 * docutils/parsers/rst/states.py:
36   - Unquoted targets beginning with an underscore (``.. __target:
37     URI``) are no longer accepted.
38   - Added support for multiple attributions in a physical block quote
39     (indented text block), dividing it into multiple logical block
40     quotes.
41   - Added support for unicode bullets in bullet lists: "•", "‣", and
42     "⁃".
44 * docutils/writers/html4css1/__init__.py:
46   - Moved template functionality from the PEP/HTML writer here.
47   - Expanded the fragments available in the ``parts`` attribute.
49 * docutils/writers/html4css1/template.txt: Added to project.
51 * docutils/writers/pep_html/:
53   - Moved template functionality to the HTML writer.
55 * docutils/writers/s5_html/__init__.py:
57   - Added ``view_mode`` & ``hidden_controls`` settings
58     (``--view-mode`` & ``--hidden-controls/--visible-controls``
59     options).
61 * docutils/writers/latex2e/__init__.py:
63   - Fix: Renaming contents section does not work with latex writer; SF
64     bug #1487405.
65   - Applied patch for custom roles with classes from Edward Loper.
66   - Fixed bug that caused crashes with more than 256 lists.
68 * docutils/writers/pep_html/__init__.py:
70   - Changed to support new python.org website structure and
71     pep2pyramid.py.
73 * tools/editors/emacs/rst.el:
75   - Changed license to "GPL".
76   - Added ``rst-straighten-decorations`` function.
77   - The ``compile`` module is now always loaded.
78   - Added ``rst-toggle-line-block`` function.
80 * setup.py:
82   - Provide descriptive error message if distutils is missing.
85 Release 0.4 (2006-01-09)
86 ========================
88 * General:
90   - Updated the project policies for trunk/branch development &
91     version numbering.
93 * docutils/__init__.py:
95   - Added ``__version_details__`` attribute to describe code source
96     (repository/snapshot/release).
97   - Replaced ``default_transforms`` attribute of TransformSpec with
98     ``get_transforms()`` method.
100 * docutils/core.py:
102   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
103     functions, for document tree extraction and reprocessing.
105 * docutils/io.py:
107   - Added ``DocTreeInput`` class, for reprocessing existing documents.
108   - Added support for non-Unicode (e.g. binary) writer output.
110 * docutils/nodes.py:
112   - Re-introduced ``Targetable.indirect_reference_name``, for
113     MoinMoin/reST compatibility (removed in r3124/r3129).
114   - Added ``serial_escape`` function; escapes string values that are
115     elements of a list, for serialization.  Modified Docutils-XML
116     writing (``Element._dom_node``) and pseudo-XML writing
117     (``Element.starttag``) to use ``serial_escape``.
118   - Added ``Node.deepcopy()`` method.
119   - Removed the internal lists ``document.substitution_refs``,
120     ``document.anonymous_refs``, and ``document.anonymous_targets``.
121   - Added a "container" element.
122   - Fixed bug where values of list-valued attributes of elements
123     originating from custom interpreted text roles (i.e., with custom
124     classes) were being shared between element instances.  Reported by
125     Shmuel Zeigerman.
127 * docutils/statemachine.py:
129   - Added trailing whitespace stripping to ``string2lines()``.
130   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
131     Asian double-width character support.
133 * docutils/utils.py:
135   - Added ``east_asian_column_width()`` for double-width character
136     support.
138 * docutils/languages/ja.py: Added to project: Japanese mappings by
139   Hisashi Morita.
141 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
142   mappings by Panjunyong.
144 * docutils/parsers/null.py: Added to project; a do-nothing parser.
146 * docutils/parsers/rst/__init__.py:
148   - Added validator to tab_width setting, with test.  Closes SF bug
149     #1212515, report from Wu Wei.
151 * docutils/parsers/rst/states.py:
153   - Fixed bug with escaped colons indicating a literal block.
154   - Fixed bug with enumerated lists (SF#1254145).
155   - Backslash-escaped colons inside of field names are now allowed.
156   - Targets (implicit and explicit), anonymous hyperlink references
157     and auto-numbered footnote references inside of substitution
158     definitions are now disallowed.
159   - Fixed bug: list items with blank first lines.
160   - Fixed bug: block quote attributions with indented second lines.
161   - Added East Asian double-width character support (Python 2.4 only).
163 * docutils/parsers/rst/tableparser.py:
165   - Added East Asian double-width character support (Python 2.4 only).
167 * docutils/parsers/rst/directives/body.py:
169   - Added the "container" directive.
171 * docutils/parsers/rst/directives/misc.py:
173   - Added the "default-role", "title", and "date" directives.
174   - Added standard data file syntax to the "include" directive.
175   - Added support for "class" directive content.
177 * docutils/parsers/rst/directives/images.py:
179   - Added ``indirect_reference_name`` support for images with a target
180     option.
181   - Added support for image width and height units.
182   - Fixed bug with image "target" options.
184 * docutils/parsers/rst/directives/references.py:
186   - Added "class" attribute to "target-notes" directive, for
187     footnote_reference classes.
189 * docutils/parsers/rst/include/: Directory added to project; contains
190   standard data files for the "include" directive.  Initial contents:
191   character entity substitution definition sets, and a set of
192   definitions for S5/HTML presentations.
194 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
195   mappings by David Goodger.
196   
197 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
198   Simplified Chinese mappings by Panjunyong.
200 * docutils/readers/__init__.py:
202   - Added universal.Decorations and universal.ExposeInternals
203     transforms as default transforms for all readers.
204   - Added ``ReReader`` base class for readers that reread an existing
205     document tree.
207 * docutils/readers/doctree.py: Added to project; a reader for existing
208   document trees.
210 * docutils/transforms/frontmatter.py:
212   - Fixed the DocInfo transform to handle SVN-style expansion of the
213     "Date" keyword.
214   - In ``DocInfo.extract_authors``, treat the contents of "authors"
215     fields uniformly.
217 * docutils/transforms/misc.py:
219   - Added misc.Transitions transform, extracted from
220     universal.FinalChecks.
222 * docutils/transforms/references.py:
224   - Added references.DanglingReferences transform, extracted from
225     universal.FinalChecks.
226   - Fixed bug with doubly-indirect substitutions.
227   - Added footnote_reference classes attribute to "TargetNotes".
228   - Fixed bug with circular substitution definitions that put Docutils
229     into an infinite loop.
231 * docutils/transforms/universal.py:
233   - Added universal.ExposeInternals transform, extracted from
234     universal.FinalChecks.
235   - Removed universal.FinalChecks transform (logic has been moved to
236     several new transforms).
237   - Fixed bug with the "expose_internals" setting and Text nodes
238     (exposed by the "rawsource" internal attribute).
239   - Added the universal.StripComments transform, implementation of the
240     "strip_comments" setting.
242 * docutils/transforms/writer_aux.py: Added to project; auxiliary
243   transforms for writers.
245   - Added ``Compound`` transform, which flattens compound paragraphs.
247 * docutils/writers/: Several writer modules (html4css1.py) were
248   converted into packages.  Support modules and data files have been
249   moved into the packages.  The stylesheets for the HTML writers are
250   now installed along with the code, the code knows where to find
251   them, and the default is to use them (actually, to embed them).
252   Some adjustments to configuration files may be necessary.  The
253   easiest way to obtain the new default behavior is to remove all
254   settings whose name includes "stylesheet".
256 * docutils/writers/__init__.py:
258   - Added universal.Messages and universal.FilterMessages transforms
259     as default transforms for all writers.
260   - Added ``UnfilteredWriter`` base class for writers that pass the
261     document tree on unchanged.
263 * docutils/writers/docutils_xml.py:
265   - Made ``xmlcharrefreplace`` the default output encoding error
266     handler.
268 * docutils/writers/html4css1/: 
270   - Added support for image width and height units.
271   - Made ``xmlcharrefreplace`` the default output encoding error
272     handler.
273   - Made ``--embed-stylesheet`` the default rather than
274     ``--link-stylesheet``.
275   - Moved "id" attribute from container (section etc.) to title's <a>
276     tag, to be on the same tag as "name".
277     (!!! To be reverted in Docutils 0.5.)
278   - Added vertical space between fields of field lists.
279   - Added ``--compact-field-lists`` option to remove vertical space in
280     simple field lists.
281   - Made cloaking of email addresses with ``--cloak-email-addresses``
282     less obtrusive.
283   - Fixed support for centered images.
284   - Added support for class="compact" & class="open" lists.
286 * docutils/writers/latex2e/:
288   - Underscores in citekeys are no longer escaped.
290 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
291   mapping of Unicode characters to LaTeX equivalents.
293 * docutils/writers/s5_html/: Package added to project; writer for
294   S5/HTML slide shows.
296 * docs/dev/distributing.txt: Added to project; guide for distributors
297   (package maintainers).
299 * docs/dev/hacking.txt: Added to project; guide for developers.
301 * docs/ref/doctree.txt:
303   - Updated for plural attributes "classes", "ids", "names",
304     "dupnames".
305   - Added the "container" element.
307 * docs/ref/docutils.dtd:
309   - Updated for plural attributes "classes", "ids", "names",
310     "dupnames".
312 * docs/user/emacs.txt: Added to project; a document about Emacs
313   support for reStructuredText and Docutils.
315 * docs/user/links.txt: Added to project; lists of Docutils-related
316   links.
318 * docs/user/mailing-lists.txt: Added to project; information about
319   Docutils-related mailing lists and how to access them.
321 * docs/user/slide-shows.txt: Added to project; example of and docs for
322   the S5/HTML writer (``rst2s5.py`` front end).
324 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
325   Files", added to project.
327 * test/coverage.sh: Added to project; test coverage script.
329 * test/DocutilsTestSupport.py:
331   - Added support for specifying runtime settings at the suite level.
333 * test/test_functional.py:
335   - Added the ``clear_output_directory`` function.
336   - Added support for ``_test_more`` functions in functional test
337     config files.
339 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
341 * tools/rstpep2html.py: Renamed from pep.py.
343 * tools/dev/create_unimap.py: Added to project; script to create the
344   docutils/writers/unimap_latex.py mapping file.
346 * tools/dev/profile_docutils.py: Added to project; profiler script.
348 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
350 * tools/editors/emacs/restructuredtext.el,
351   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
352   Removed from project; the functionality is now contained in rst.el.
354 * tools/editors/emacs/rst.el: Added to project.  Added many features
355   and fixed many bugs.  See docs/user/emacs.txt for details.
357 * tools/stylesheets: Removed from project.  Stylesheets have been
358   renamed and moved into writer packages.
361 Release 0.3.9 (2005-05-26)
362 ==========================
364 * General:
366   - Eliminated and replaced all uses of the old string attributes
367     ``id``, ``name``, ``dupname`` and ``class`` with references to the
368     new list attributes ``ids``, ``names``, ``dupnames`` and
369     ``classes`` throughout the whole source tree.
371 * docutils/core.py:
373   - Enabled ``--dump-*`` options when ``--traceback`` specified,
374     allowing for easier debugging.
375   - In ``Publisher.publish()``, expanded the generic top-level
376     exception catching.
378 * docutils/examples.py:
380   - Added ``internals`` function for exploration.
382 * docutils/io.py:
384   - Fixed ``Input.decode`` method to apply heuristics only if no
385     encoding is explicitly given, and to provide better reporting of
386     decoding errors.
387   - The ``Input.decode`` method now removes byte order marks (BOMs)
388     from input streams.
390 * docutils/nodes.py:
392   - ``image`` element class changed to subclass of Element, not
393     TextElement (it's an empty element, and cannot contain text).
394   - Added ``attr_defaults`` dictionary for default attribute values.
395   - Added empty list as default value for the following attributes:
396     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
397   - Added ``document.decoration`` attribute,
398     ``document.get_decoration`` method, and ``decoration.get_header``
399     & ``.get_footer`` methods.
400   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
401     methods.
403 * docutils/utils.py:
405   - Removed ``docutils.utils.Reporter.categories``,
406     ``docutils.utils.ConditionSet``, and all references to them, to
407     simplify error reporting.
409 * docutils/languages/nl.py: Added to project; Dutch mappings by
410   Martijn Pieters.
412 * docutils/parsers/rst/__init__.py:
414   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
416 * docutils/parsers/rst/states.py:
418   - Added check for escaped at-mark to prevent email address recognition.
419   - Fixed option lists to allow spaces inside ``<angle-bracketed option
420     arguments>``.
421   - Allowed whitespace in paths and URLs.
422   - Added auto-enumerated list items.
423   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
424     followed by text.
425   - Added support for table stub columns.
427 * docutils/parsers/rst/directives/__init__.py:
429   - Allowed whitespace in paths (``path`` function).
430   - Added ``uri`` directive option conversion function.
432 * docutils/parsers/rst/directives/body.py:
434   - Fixed illegal context bug with "topic" directive (allowed within
435     sidebars; not within body elements).
437 * docutils/parsers/rst/directives/images.py:
439   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
440   - Added support for the ``file_insertion_enabled`` setting in the
441     "figure" directive (disables "figwidth" option).
442   - "image" directive: added checks for valid values of "align" option,
443     depending on context.  "figure" directive: added specialized
444     "align" option and attribute on "figure" element.
445   - Made ":figwidth: image" option of "figure" directive work again.
446   - Fixed bug with reference names containing uppercase letters
447     (e.g. ``Name_``) in "target" option of "image" directive.
449 * docutils/parsers/rst/directives/misc.py:
451   - Fixed "include" and "raw" directives to catch text decoding
452     errors.
453   - Allowed whitespace in "include" & "raw" directive paths.
454   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
455     settings in "include" & "raw" directives.
457 * docutils/parsers/rst/directives/parts.py:
459   - Added "header" & "footer" directives.
460   - Fixed illegal context bug with "contents" directive (topics
461     allowed within sidebars; not within body elements).
463 * docutils/parsers/rst/directives/tables.py:
465   - Added "list-table" directive.
466   - Caught empty CSV table bug.
467   - Added support for the ``file_insertion_enabled`` setting in the
468     "csv-table" directive.
469   - Added ``stub-columns`` option to "csv-table" and "list-table"
470     directives.
472 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
473   mappings by Martijn Pieters.
475 * docutils/readers/standalone.py:
477   - Added ``--section-subtitles`` and ``--no-section-subtitles``
478     options to activate or deactivate the SectSubTitle transform.
480 * docutils/transforms/frontmatter.py:
482   - Added SectSubTitle transform to promote titles of lone
483     subsections to subtitles.
485 * docutils/transforms/references.py:
487   - Fixed mislocated internal targets bug, by propagating internal
488     targets to the next node, making use of the newly added support
489     for multiple names and IDs.
490   - Fixed duplicate footnote label bug.
491   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
492     transform.
494 * docutils/writers/html4css1.py:
496   - Fixed unencoded stylesheet reference bug (characters like "&" in
497     stylesheet references).
498   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
499     tags).
500   - Added support for multiple IDs per node by creating empty ``span``
501     tags.
502   - Added the ``field_name_limit`` & ``option_limit`` settings &
503     support.
504   - Added support for table stub columns.
505   - Added support for the ``align`` attribute on ``figure`` elements.
506   - Added the ``cloak_email_addresses`` setting & support.
507   - Added ``html_prolog``, ``html_head``, ``html_body``,
508     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
509     ``docutils.core.publish_parts``.
510   - Added support for section subtitles.
512 * docutils/writers/latex2e.py:
514   - Fixed tables starting with more than one multirow cell.
515   - Improved --use-latex-docinfo so that organization/contact/address
516     fields are lumped with the last author field and appear on the
517     titlepage.
518   - Made sure the titlepage is always shown with --use-latex-docinfo,
519     even if the document has no title.
520   - Made sure that latex doesn't fill in today's date if no date field
521     was given.
522   - Added support for section subtitles.
524 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
525   (under development).
527 * docutils/writers/null.py: Added to project; a do-nothing Writer.
529 * docs/api/publisher.txt:
531   - Added "``publish_parts`` Details" section.
533 * docutils/dev/repository.txt: Added to project; information about the
534   Docutils Subversion repository.
536 * docs/ref/docutils.dtd:
538   - Added a ``stub`` attribute to the ``colspec`` element via the
539     ``tbl.colspec.att`` parameter entity.
540   - Allowed topic elements within sidebars
541   - Added an ``align`` attribute to the ``figure`` element.
543 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
544   writer.
547 Release 0.3.7 (2004-12-24)
548 ==========================
550 * docutils/frontend.py:
552   - Added options: --input-encoding-error-handler,
553     --record-dependencies, --leave-footnote-reference-space,
554     --strict-visitor.
555   - Added command-line and config file support for "overrides" setting
556     parameter.
558 * docutils/io.py:
560   - Added support for input encoding error handler.
562 * docutils/nodes.py:
564   - Added dispatch_visit and dispatch_departure methods to
565     NodeVisitor; useful as a hook for Visitors.
566   - Changed structure of ``line_block``; added ``line``.
567   - Added ``compound`` node class.
568   - Added a mechanism for Visitors to transitionally ignore new node
569     classes.
571 * docutils/utils.py:
573   - Moved ``escape2null`` and ``unescape`` functions from
574     docutils/parsers/rst/states.py.
576 * docutils/parsers/rst/roles.py:
578   - Added "raw" role.
579   - Changed role function API: the "text" parameter now takes
580     null-escaped interpreted text content.
582 * docutils/parsers/rst/states.py:
584   - Fixed bug where a "role" directive in a nested parse would crash
585     the parser; the state machine's "language" attribute was not being
586     copied over.
587   - Added support for line block syntax.
588   - Fixed directive parsing bug: argument-less directives didn't
589     notice that arguments were present.
590   - Removed error checking for transitions.
591   - Added support for multiple classifiers in definition list items.
592   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
593   - Changed role function API: the "text" parameter now takes
594     null-escaped interpreted text content.
595   - Empty sections and documents are allowed now.
597 * docutils/parsers/rst/directives/__init__.py:
599   - Added ``encoding`` directive option conversion function.
600   - Allow multiple class names in class_option conversion function.
602 * docutils/parsers/rst/directives/body.py:
604   - Converted the line-block directive to use the new structure.
605   - Extracted the old line-block functionality to the ``block``
606     function (still used).
607   - Added ``compound`` directive (thanks to Felix Wiemann).
609 * docutils/parsers/rst/directives/misc.py:
611   - Added "encoding" option to "include" and "raw" directives.
612   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
613   - Allow multiple class names in the "class" directive.
615 * docutils/parsers/rst/directives/parts.py:
617   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
618     options.  Thanks to Lele Gaifax.
620 * docutils/parsers/rst/directives/tables.py:
622   - Added "encoding" directive to "csv-table" directive.
623   - Added workaround for lack of Unicode support in csv.py, for
624     non-ASCII CSV input.
626 * docutils/transforms/misc.py:
628   - Fixed bug when multiple "class" directives are applied to a single
629     element.
630   - Enabled multiple format names for "raw" directive.
632 * docutils/transforms/references.py:
634   - Added support for trimming whitespace from beside substitution
635     references.
637 * docutils/transforms/universal.py:
639   - FinalChecks now checks for illegal transitions and moves
640     transitions between sections.
642 * docutils/writers/html4css1.py:
644   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
645   - "stylesheet" and "stylesheet_path" settings are now mutually
646     exclusive.
647   - Added support for the new line_block/line structure.
648   - --footnote-references now overrides
649     --trim-footnote-reference-space, if applicable.
650   - Added support for ``compound`` elements.
651   - Enabled multiple format names for "raw" directive.
652   - ``<p>`` tags of a paragraph which is the only visible child of the
653     document node are no longer stripped.
654   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
655     new method ``should_be_compact_paragraph()``.
656   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
657     elements.
658   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
659     the output if they have their ``class`` attribute set.
660   - The whole document is now surrounded by a ``<div
661     class="document">`` element.
662   - Body-level images are now wrapped by their own ``<div>`` elements,
663     with image classes copied to the wrapper, and for images which
664     have the ``:align:`` option set, the surrounding ``<div>`` now
665     receives a class attribute (like ``class="align-left"``).
667 * docutils/writers/latex2e.py:
669   - no newline after depart_term.
670   - Added translations for some Unicode quotes.
671   - Added option "font-encoding", made package AE the default.
672   - "stylesheet" and "stylesheet_path" settings are now mutually
673     exclusive.
674   - --footnote-references now overrides
675     --trim-footnote-reference-space, if applicable.
676   - The footnote label style now matches the footnote reference style
677     ("brackets" or "superscript").
678   - Added support for ``compound`` elements.
679   - Enabled multiple format names for "raw" directive.
681 * docs/ref/docutils.dtd:
683   - Changed structure of the ``line_block`` element; added ``line``.
684   - Added ``compound`` element.
685   - Added "ltrim" and "rtrim" attributes to
686     ``substitution_definition`` element.
687   - Enabled multiple format names for ``raw`` element.
688   - Enabled multiple classifiers in ``definition_list_item`` elements.
690 * docs/ref/rst/directives.txt
692   - Marked "line-block" as deprecated.
693   - "Class" directive now allows multiple class names.
694   - Added "Rationale for Class Attribute Value Conversion".
695   - Added warning about "raw" overuse/abuse.
697 * docs/ref/rst/restructuredtext.txt:
699   - Added syntax for line blocks.
700   - Definition list items may have multiple classifiers.
702 * docs/ref/rst/roles.txt:
704   - Added "raw" role.
706 * tools/stylesheets/default.css:
708   - Added support for the new line_block structure.
709   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
712 Release 0.3.5 (2004-07-29)
713 ==========================
715 General:
717 * _`Documentation cleanup/reorganization`.
719   - Created new subdirectories of docs/:
721     * ``docs/user/``: introductory/tutorial material for end-users
722     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
723     * ``docs/api/``: API reference material for client-developers
724     * ``docs/ref/``: reference material for all groups
725     * ``docs/howto/``: for component-developers and core-developers
726     * ``docs/peps/``: Python Enhancement Proposals
728   - Moved ``docs/*`` to ``docs/user/``.
729   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
730     ``spec/`` to ``docs/dev``.
731   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
732     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
733   - Moved ``alternatives.txt``, and ``problems.txt`` from
734     ``spec/rst/`` to ``docs/dev/rst/``.
735   - Moved ``reStructuredText.txt``, ``directives.txt``,
736     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
737     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
738     ``roles.txt``, ``reStructuredText.txt`` to
739     ``restructuredtext.txt``.
740   - Moved ``spec/howto/`` to ``docs/howto``.
742   In order to keep the CVS history of moved files, we supplied
743   SourceForge with a `script for modifying the Docutils CVS
744   repository`__.
746   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
748   After running the cleanup script:
750   - Added ``docs/index.txt``.
751   - Added a ``.htaccess`` file to the ``web`` module, containing
752     redirects for all old paths to new paths.  They'll preserve
753     fragments (the "#name" part of a URL), and won't clutter up the
754     file system, and will correct the URL in the user's browser.
755   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
756     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
757     the "To Do" list itself in ``docs/dev/todo.txt``.
758   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
759     section of ``docs/dev/todo.txt``.
760   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
761   - Added "How To Report Bugs" to ``BUGS.txt``.
762   - Went through all the sources and docs (including under web/) and
763     updated links.  Mostly done by Felix Wiemann; thanks Felix!
764     (Still need to update links in the sandboxes.)
766 Specific:
768 * BUGS.txt: Added to project.
770 * THANKS.txt: Added to project.
772 * docutils/__init__.py:
774   - 0.3.4: Post-release.
776 * docutils/core.py:
778   - Added special error handling & advice for UnicodeEncodeError.
779   - Refactored Publisher.publish (simplified exception handling &
780     extracted debug dumps).
781   - Renamed "enable_exit" parameter of convenience functions to
782     "enable_exit_status".
783   - Enabled traceback (exception propagation) by default in
784     programmatic convenience functions.
785   - Now publish_file and publish_cmdline convenience functions return
786     the encoded string results in addition to their regular I/O.
787   - Extracted common code from publish_file, publish_string, and
788     publish_parts, into new publish_programmatically.  Extracted
789     settings code to ``Publisher.process_programmatic_settings``.
790   - In Publisher.publish, disabled ``settings_overrides`` when
791     ``settings`` is supplied; redundant.
793 * docutils/frontend.py:
795   - Added help text for "--output-encoding-error-handler" and
796     "--error-encoding-error-handler".
797   - Renamed "--exit" to "--exit-status".
798   - Simplified default-setting code.
800 * docutils/parsers/rst/__init__.py:
802   - Added "--pep-base-url" and "--rfc-base-url" options.
804 * docutils/parsers/rst/states.py:
806   - Made URI recognition more aggressive and intelligent.
808 * docutils/parsers/rst/directives/__init__.py:
810   - Added several directive option conversion functions.
812 * docutils/parsers/rst/directives/body.py:
814   - Moved "table" directive to tables.py.
816 * docutils/parsers/rst/directives/tables.py: Table-related directives,
817   added to project.
819 * docutils/writers/latex2e.py:
821   - Added "--table-style=(standard|booktabs|nolines)"
822   - figures get "here" option (LaTeX per default puts them at bottom),
823     and figure content is centered.
824   - Rowspan support for tables.
825   - Fix: admonition titles before first section.
826   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
827   - Replave ``_`` in literal by an underlined blank, because it has the correct
828     width.
829   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
830   - A few unicode replacements, if output_encoding != utf
831   - Add "--graphicx-option".
832   - Indent literal-blocks.
833   - Fix: omit ``\maketitle`` when there is no document title.
835 * docs/index.txt: "Docutils Project Documentation Overview", added to
836   project.
838 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
839   Tool", added to project.
841 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
843 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
845 * docs/dev/policies.txt: Added to project (extracted from
846   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
848 * docs/dev/release.txt: Added to project (extracted from
849   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
851 * docs/dev/testing.txt: Added to project.
853 * docs/dev/website.txt: Added to project (extracted from
854   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
856 * docs/ref/rst/directives.txt:
858   - Added directives: "table", "csv-table".
860 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
861   added to project.  1 page for syntax, and a 1 page reference for
862   directives and roles.  Source text to be used as-is; not meant to be
863   converted to HTML.
865 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
866   with a change of title.
868 * test/functional/, contents, and test/test_functional.py: Added to
869   project.
871 * tools/buildhtml.py: Fixed bug with config file handling.
873 * tools/html.py: Removed from project (duplicate of rst2html.py).
875 * tools/pep2html.py: Removed from project (duplicate of Python's
876   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
877   Docutils-related PEPs in docs/peps/).
879 * tools/rst2pseudoxml.py: Renamed from publish.py.
881 * tools/rst2xml.py: Renamed from docutils-xml.py.
883 * tools/test.txt: Removed from project; moved to
884   docs/user/rst/demo.txt.
886 * setup.py: Now also installs ``rst2latex.py``.
889 Release 0.3.3 (2004-05-09)
890 ==========================
892 * docutils/__init__.py:
894   - 0.3.1: Reorganized config file format (multiple sections); see
895     docs/config.txt.
896   - Added unknown_reference_resolvers attribute to TransformSpec.
897   - 0.3.2: Interpreted text reorganization.
898   - 0.3.3: Released.
900 * docutils/core.py:
902   - Catch system messages to stop tracebacks from parsing errors.
903   - Catch exceptions during processing report & exit without
904     tracebacks, except when "--traceback" used.
905   - Reordered components for OptionParser; application comes last.
906   - Added "config_section" parameter to several methods and functions,
907     allowing front ends to easily specify their config file sections.
908   - Added publish_parts convenience function to allow access to individual
909     parts of a document.
911 * docutils/examples.py: Added to project; practical examples of
912   Docutils client code, to be used as-is or as models for variations.
914 * docutils/frontend.py:
916   - Added "--traceback" & "--no-traceback" options ("traceback"
917     setting).
918   - Implemented support for config file reorganization:
919     ``standard_config_files`` moved from ``ConfigParser`` to
920     ``OptionParser``; added
921     ``OptionParser.get_config_file_settings()`` and
922     ``.get_standard_config_settings()``; support for old "[options]"
923     section (with deprecation warning) and mapping from old to new
924     settings.
925   - Reimplemented setting validation.
926   - Enabled flexible boolean values: yes/no, true/false, on/off.
927   - Added ``Values``, a subclass of ``optparse.Values``, with support
928     for list setting attributes.
929   - Added support for new ``DOCUTILSCONFIG`` environment variable;
930     thanks to Beni Cherniavsky.
931   - Added "--no-section-numbering" option.
933 * docutils/io.py:
935   - Catch IOErrors when opening source & destination files, report &
936     exit without tracebacks.  Added ``handle_io_errors`` parameter to
937     ``FileInput`` & ``FileOutput`` to enable caller error handling.
939 * docutils/nodes.py:
941   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
942     method definitions (via ``exec``) to dynamic assignments (via
943     ``setattr``); thanks to Roman Suzi.
944   - Encapsulated visitor dynamic assignments in a function; thanks to
945     Ian Bicking.
946   - Added indirect_reference_name attribute to the Targetable
947     class. This attribute holds the whitespace_normalized_name
948     (contains mixed case) of a target.
950 * docutils/statemachine.py:
952   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
953   - Added ``StringList.get_2D_block``.
955 * docutils/utils.py:
957   - Added "level" attribute to SystemMessage exceptions.
959 * docutils/languages/af.py: Added to project; Afrikaans mappings by
960   Jannie Hofmeyr.
962 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
963   Blaha.
965 * docutils/languages/eo.py: Added to project; Esperanto mappings by
966   Marcelo Huerta San Martin.
968 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
969   mappings by Lalo Martins.
971 * docutils/languages/ru.py: Added to project; Russian mappings by
972   Roman Suzi.
974 * docutils/parsers/rst/roles.py: Added to project.  Contains
975   interpreted text role functions, a registry for interpreted text
976   roles, and an API for adding to and retrieving from the registry.
977   Contributed by Edward Loper.
979 * docutils/parsers/rst/states.py:
981   - Updated ``RSTState.nested_parse`` for "include" in table cells.
982   - Allowed true em-dash character and "---" as block quote
983     attribution marker.
984   - Added support for <angle-bracketed> complex option arguments
985     (option lists).
986   - Fixed handling of backslashes in substitution definitions.
987   - Fixed off-by-1 error with extra whitespace after substitution
988     definition directive.
989   - Added inline markup parsing to field lists' field names.
990   - Added support for quoted (and unindented) literal blocks.
991     Driven in part by a bribe from Frank Siebenlist (thanks!).
992   - Parser now handles escapes in URIs correctly.
993   - Made embedded-URIs' reference text omittable.  Idea from Beni
994     Cherniavsky.
995   - Refactored explicit target processing code.
996   - Added name attribute to references containing the reference name only
997     through whitespace_normalize_name (no case changes).
998   - parse_target no longer returns the refname after going through
999     normalize_name. This is now handled in make_target.
1000   - Fixed bug relating to role-less interpreted text in non-English
1001     contexts.
1002   - Reorganized interpreted text processing; moved code into the new
1003     roles.py module.  Contributed by Edward Loper.
1004   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1005     ``parse_directive_block``.
1007 * docutils/parsers/rst/tableparser.py:
1009   - Reworked for ``StringList``, to support "include" directives in
1010     table cells.
1012 * docutils/parsers/rst/directives/__init__.py:
1014   - Renamed ``unchanged()`` directive option conversion function to
1015     ``unchanged_required``, and added a new ``unchanged``.
1016   - Catch unicode value too high error; fixes bug 781766.
1017   - Beefed up directive error reporting.
1019 * docutils/parsers/rst/directives/body.py:
1021   - Added basic "table" directive.
1023 * docutils/parsers/rst/directives/images.py:
1025   - Added "target" option to "image" directive.
1026   - Added name attribute to references containing the reference name only
1027     through whitespace_normalize_name (no case changes).
1029 * docutils/parsers/rst/directives/misc.py:
1031   - Isolated the import of the ``urllib2`` module; was causing
1032     problems on SourceForge (``libssl.so.2`` unavailable?).
1033   - Added the "role" directive for declaring custom interpreted text
1034     roles.
1036 * docutils/parsers/rst/directives/parts.py:
1038   - The "contents" directive does more work up-front, creating the
1039     "topic" and "title", and leaving the "pending" node for the
1040     transform.  Allows earlier reference resolution; fixes subtle bug.
1042 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1043   mappings by Jannie Hofmeyr.
1045 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1046   mappings by Marek Blaha.
1048 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1049   mappings by Marcelo Huerta San Martin.
1051 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1052   Portuguese mappings by Lalo Martins.
1054 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1055   mappings by Roman Suzi.
1057 * docutils/transforms/parts.py:
1059   - The "contents" directive does more work up-front, creating the
1060     "topic" and "title", and leaving the "pending" node for the
1061     transform.  Allows earlier reference resolution; fixes subtle bug.
1062   - Added support for disabling of section numbering.
1064 * docutils/transforms/references.py:
1066   - Verifying that external targets are truly targets and not indirect
1067     references. This is because we are now adding a "name" attribute to
1068     references in addition to targets. Note sure if this is correct!
1069   - Added code to hook into the unknown_reference_resolvers list for a
1070     transformer in resolve_indirect_target. This allows the
1071     unknown_reference_resolvers to keep around indirect targets which
1072     docutils doesn't know about.
1073   - Added specific error message for duplicate targets.
1075 * docutils/transforms/universal.py:
1077   - Added FilterMessages transform (removes system messages below the
1078     verbosity threshold).
1079   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1080     to FinalCheckVisitor for application-specific handling of
1081     unresolvable references.
1082   - Added specific error message for duplicate targets.
1084 * docutils/writers/__init__.py:
1086   - Added assemble_parts method to the Writer class to allow for
1087     access to a documents individual parts.
1088   - Documented & set default for ``Writer.output`` attribute.
1090 * docutils/writers/html4css1.py:
1092   - Fixed unicode handling of attribute values (bug 760673).
1093   - Prevent duplication of "class" attribute values (bug report from
1094     Kirill Lapshin).
1095   - Improved table grid/border handling (prompted by report from Bob
1096     Marshall).
1097   - Added support for table titles.
1098   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1099     to Darek Suchojad.
1100   - Added functionality to keep track of individual parts of a document
1101     and store them in a dictionary as the "parts" attribute of the writer.
1102     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1103   - Added proper support for the "scale" attribute of the "image"
1104     element.  Contributed by Brent Cook.
1105   - Added ``--initial-header-level`` option.
1106   - Fixed bug: the body_pre_docinfo segment depended on there being a
1107     docinfo; if no docinfo, the document title was incorporated into
1108     the body segment.  Adversely affected the publish_parts interface.
1110 * docutils/writers/latex2e.py:
1112   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1113     about a missing file.
1114   - Added options and support: ``--compound-enumerators``,
1115     ``--section-prefix-for-enumerators``, and
1116     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1117     934322).
1118   - Added option ``--use-verbatim-when-possible``, to avoid
1119     problematic characters (eg, '~' in italian) in literal blocks.
1120   - It's now possible to use four section levels in the `book` and
1121     `report` LaTeX classes.  The default `article` class still has
1122     three levels limit.
1124 * docs/config.txt: "Docutils Configuration Files", added to project.
1125   Moved config file entry descriptions from tools.txt.
1127 * docs/tools.txt:
1129   - Moved config file entry descriptions to config.txt.
1131 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1132   Development".
1134 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1135   Text Roles", added to project.
1137 * spec/rst/reStructuredText.txt:
1139   - Added description of support for <angle-bracketed> complex option
1140     arguments to option lists.
1141   - Added subsections for indented and quoted literal blocks.
1143 * test: Continually adding & updating tests.
1145   - Added test/test_settings.py & test/data/config_*.txt support
1146     files.
1147   - Added test/test_writers/test_htmlfragment.py.
1149 * test/DocutilsTestSupport.py:
1151   - Refactored LaTeX publisher test suite/case class names to make
1152     testing other writers easier.
1153   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1154     to test the processing of HTML fragments which use the new
1155     publish_parts convenience function.
1157 * tools/buildhtml.py:
1159   - Added support for the "--prune" option.
1160   - Removed dependency on pep2html.py; plaintext PEPs no longer
1161     supported.
1163 * tools/docutils.conf:
1165   - Updated for configuration file reorganization.
1167 * tools/rst2html.py:
1169   - copied from tools/html.py
1171 * setup.py:
1173   - added a 'scripts' section to configuration
1174   - added 'tools/rst2html.py' to the scripts section
1177 Release 0.3 (2003-06-24)
1178 ========================
1180 General:
1182 * Renamed "attribute" to "option" for directives/extensions.
1184 * Renamed transform method "transform" to "apply".
1186 * Renamed "options" to "settings" for runtime settings (as set by
1187   command-line options).  Sometimes "option" (singular) became
1188   "settings" (plural).  Some variations below:
1190   - document.options -> document.settings (stored in other objects as
1191     well)
1192   - option_spec -> settings_spec (not directives though)
1193   - OptionSpec -> SettingsSpec
1194   - cmdline_options -> settings_spec
1195   - relative_path_options -> relative_path_settings
1196   - option_default_overrides -> settings_default_overrides
1197   - Publisher.set_options -> Publisher.get_settings
1199 Specific:
1201 * COPYING.txt: Added "Public Domain Dedication".
1203 * FAQ.txt: Frequently asked questions, added to project.
1205 * setup.py:
1207   - Updated with PyPI Trove classifiers.
1208   - Conditional installation of third-party modules.
1210 * docutils/__init__.py:
1212   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1213   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1214   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1215   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1216     option and its effect on the PEP template & writer.
1217   - Bumped version to 0.2.4 due to changes to the PEP template &
1218     stylesheet.
1219   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1220   - Added ``TransformSpec`` class for new transform system.
1221   - Bumped version to 0.2.6 for API changes (renaming).
1222   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1223     convenience functions.
1224   - Added ``Component.component_type`` attribute.
1225   - Bumped version to 0.2.8 because of the internal parser switch from
1226     plain lists to the docutils.statemachine.StringList objects.
1227   - Bumped version to 0.2.9 because of the frontend.py API changes.
1228   - Bumped version to 0.2.10 due to changes to the project layout
1229     (third-party modules removed from the "docutils" package), and
1230     signature changes in ``io.Input``/``io.Output``.
1231   - Changed version to 0.3.0 for release.
1233 * docutils/core.py:
1235   - Made ``publish()`` a bit more convenient.
1236   - Generalized ``Publisher.set_io``.
1237   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1238     parameters; improved its docstring.
1239   - Added ``publish_file()`` and ``publish_string()``.
1240   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1241     out of ``.set_io``.
1242   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1243     "--dump-transforms" hidden options.
1244   - Added ``Publisher.apply_transforms()`` method.
1245   - Added ``Publisher.set_components()`` method; support for
1246     ``publish_*()`` conveninece functions.
1247   - Moved config file processing to docutils/frontend.py.
1248   - Added support for exit status ("exit_level" setting &
1249     ``enable_exit`` parameter for Publisher.publish() and convenience
1250     functions).
1252 * docutils/frontend.py:
1254   - Check for & exit on identical source & destination paths.
1255   - Fixed bug with absolute paths & "--config".
1256   - Set non-command-line defaults in ``OptionParser.__init__()``:
1257     ``_source`` & ``_destination``.
1258   - Distributed ``relative_path_settings`` to components; updated
1259     ``OptionParser.populate_from_components()`` to combine it all.
1260   - Require list of keys in ``make_paths_absolute`` (was implicit in
1261     global ``relative_path_settings``).
1262   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1263     "--dump-settings", and "--dump-transforms" hidden options.
1264   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1265     code, replaced with correct code.
1266   - Added validation functionality for config files.
1267   - Added "--error-encoding" option/setting, "_disable_config"
1268     internal setting.
1269   - Added encoding validation; updated "--input-encoding" and
1270     "--output-encoding"; added "--error-encoding-error-handler" and
1271     "--output-encoding-error-handler".
1272   - Moved config file processing from docutils/core.py.
1273   - Updated ``OptionParser.populate_from_components`` to handle new
1274     ``SettingsSpec.settings_defaults`` dict.
1275   - Added support for "-" => stdin/stdout.
1276   - Added "exit_level" setting ("--exit" option).
1278 * docutils/io.py:
1280   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1281   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1282   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1283   - ``FileOutput.write()`` now returns the encoded output string.
1284   - Try to get path/stream name automatically in ``FileInput`` &
1285     ``FileOutput``.
1286   - Added defaults for source & destination paths.
1287   - Allow for Unicode I/O with an explicit "unicode" encoding.
1288   - Added ``Output.encode()``.
1289   - Removed dependency on runtime settings; pass encoding directly.
1290   - Recognize Unicode strings in ``Input.decode()``.
1291   - Added support for output encoding error handlers.
1293 * docutils/nodes.py:
1295   - Added "Invisible" element category class.
1296   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1297     modification during a traversal.
1298   - Added element classes: ``line_block``, ``generated``, ``address``,
1299     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1300     ``superscript``, ``subscript``, ``inline``
1301   - Added support for lists of nodes to ``Element.insert()``.
1302   - Fixed parent linking in ``Element.replace()``.
1303   - Added new abstract superclass ``FixedTextElement``; adds
1304     "xml:space" attribute.
1305   - Added support for "line" attribute of ``system_message`` nodes.
1306   - Added support for the observer pattern from ``utils.Reporter``.
1307     Added ``parse_messages`` and ``transform_messages`` attributes to
1308     ``document``, removed ``messages``.  Added ``note_parse_message``
1309     and ``note_transform_message`` methods.
1310   - Added support for improved diagnostics:
1312     - Added "document", "source", and "line" internal attributes to
1313       ``Node``, set by ``Node.setup_child()``.
1314     - Converted variations on ``node.parent = self`` to
1315       ``self.setup_child(node)``.
1316     - Added ``document.current_source`` & ``.current_line``
1317       attributes, and ``.note_source`` observer method.
1318     - Changed "system_message" output to GNU-Tools format.
1320   - Added a "rawsource" attribute to the ``Text`` class, for text
1321     before backslash-escape resolution.
1322   - Support for new transform system.
1323   - Reworked ``pending`` element.
1324   - Fixed XML DOM bug (SF #660611).
1325   - Removed the ``interpeted`` element class and added
1326     ``title_reference``, ``abbreviation``, ``acronym``.
1327   - Made substitutions case-sensitive-but-forgiving; moved some code
1328     from the parser.
1329   - Fixed Unicode bug on element attributes (report: William Dode).
1331 * docutils/optik.py: Removed from project; replaced with
1332   extras/optparse.py and extras/textwrap.py.  These will be installed
1333   only if they're not already present in the Python installation.
1335 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1336   only if it's not already present in the Python installation.
1338 * docutils/statemachine.py:
1340   - Factored out ``State.add_initial_transitions()`` so it can be
1341     extended.
1342   - Converted whitespace-specific "blank" and "indent" transitions
1343     from special-case code to ordinary transitions: removed
1344     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1345     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1346     ``ws_initial_transitions`` attributes.
1347   - Removed ``State.match_transition()`` after merging it into
1348     ``.check_line()``.
1349   - Added ``StateCorrection`` exception.
1350   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1351     (moved ``TransitionCorrection`` support there too.)
1352   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1353     ``EOFError`` instead of ``IndexError``.
1354   - Added ``State.no_match`` method.
1355   - Added support for the Observer pattern, triggered by input line
1356     changes.
1357   - Added ``strip_top`` parameter to
1358     ``StateMachineWS.get_first_known_indented``.
1359   - Made ``context`` a parameter to ``StateMachine.run()``.
1360   - Added ``ViewList`` & ``StringList`` classes;
1361     ``extract_indented()`` becomes ``StringList.get_indented()``.
1362   - Added ``StateMachine.insert_input()``.
1363   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1364     thanks to) Fred Drake.
1366 * docutils/utils.py:
1368   - Added a ``source`` attribute to Reporter instances and
1369     ``system_message`` elements.
1370   - Added an observer pattern to ``utils.Reporter`` to keep track of
1371     system messages.
1372   - Fixed bugs in ``relative_path()``.
1373   - Added support for improved diagnostics.
1374   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1375   - Added support for encoding Reporter stderr output, and encoding
1376     error handlers.
1377   - Reporter keeps track of the highest level system message yet
1378     generated.
1380 * docutils/languages: Fixed bibliographic field language lookups.
1382 * docutils/languages/es.py: Added to project; Spanish mappings by
1383   Marcelo Huerta San Martin.
1385 * docutils/languages/fr.py: Added to project; French mappings by
1386   Stefane Fermigier.
1388 * docutils/languages/it.py: Added to project; Italian mappings by
1389   Nicola Larosa.
1391 * docutils/languages/sk.py: Added to project; Slovak mappings by
1392   Miroslav Vasko.
1394 * docutils/parser/__init__.py:
1396   - Added ``Parser.finish_parse()`` method.
1398 * docutils/parser/rst/__init__.py:
1400   - Added options: "--pep-references", "--rfc-references",
1401     "--tab-width", "--trim-footnote-reference-space".
1403 * docutils/parsers/rst/states.py:
1405   - Changed "title under/overline too short" system messages from INFO
1406     to WARNING, and fixed its insertion location.
1407   - Fixed enumerated list item parsing to allow paragraphs & section
1408     titles to begin with enumerators.
1409   - Converted system messages to use the new "line" attribute.
1410   - Fixed a substitution reference edge case.
1411   - Added support for "--pep-references" and "--rfc-references"
1412     options; reworked ``Inliner`` code to make customization easier.
1413   - Removed field argument parsing.
1414   - Added support for short section title over/underlines.
1415   - Fixed "simple reference name" regexp to ignore text like
1416     "object.__method__"; not an anonymous reference.
1417   - Added support for improved diagnostics.
1418   - Reworked directive API, based on Dethe Elza's contribution.  Added
1419     ``Body.parse_directive()``, ``.parse_directive_options()``,
1420     ``.parse_directive_arguments()`` methods.
1421   - Added ``ExtensionOptions`` class, to parse directive options
1422     without parsing field bodies.  Factored
1423     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1424     ``ExtensionOptions``.
1425   - Improved definition list term/classifier parsing.
1426   - Added warnings for unknown directives.
1427   - Renamed ``Stuff`` to ``Struct``.
1428   - Now flagged as errors: transitions at the beginning or end of
1429     sections, empty sections (except title), and empty documents.
1430   - Updated for ``statemachine.StringList``.
1431   - Enabled recognition of schemeless email addresses in targets.
1432   - Added support for embedded URIs in hyperlink references.
1433   - Added backslash-escapes to inline markup end-string suffix.
1434   - Added support for correct interpreted text processing.
1435   - Fixed nested title parsing (topic, sidebar directives).
1436   - Added special processing of backslash-escaped whitespace (idea
1437     from David Abrahams).
1438   - Made substitutions case-sensitive-but-forgiving; moved some code
1439     to ``docutils.nodes``.
1440   - Added support for block quote attributions.
1441   - Added a kludge to work-around a conflict between the bubble-up
1442     parser strategy and short titles (<= 3 char-long over- &
1443     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1444     titles" submitted by Jason Diamond.
1445   - Added explicit interpreted text roles for standard inline markup:
1446     "emphasis", "strong", "literal".
1447   - Implemented "superscript" and "subscript" interpreted text roles.
1448   - Added initial support for "abbreviation" and "acronym" roles;
1449     incomplete.
1450   - Added support for "--trim-footnote-reference-space" option.
1451   - Optional space before colons in directives & hyperlink targets.
1453 * docutils/parsers/rst/tableparser.py:
1455   - Fixed a bug that was producing unwanted empty rows in "simple"
1456     tables.
1457   - Detect bad column spans in "simple" tables.
1459 * docutils/parsers/rst/directives: Updated all directive functions to
1460   new API.
1462 * docutils/parsers/rst/directives/__init__.py:
1464   - Added ``flag()``, ``unchanged()``, ``path()``,
1465     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1466     directive option helper functions.
1467   - Added warnings for unknown directives.
1468   - Return ``None`` for missing directives.
1469   - Added ``register_directive()``, thanks to William Dode and Paul
1470     Moore.
1472 * docutils/parsers/rst/directives/admonitions.py:
1474   - Added "admonition" directive.
1476 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1477   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1478   "parsed-literal", "rubric", "epigraph", "highlights" and
1479   "pull-quote" directives.
1481 * docutils/parsers/rst/directives/images.py:
1483   - Added an "align" attribute to the "image" & "figure" directives
1484     (by Adam Chodorowski).
1485   - Added "class" option to "image", and "figclass" to "figure".
1487 * docutils/parsers/rst/directives/misc.py:
1489   - Added "include", "raw", and "replace" directives, courtesy of
1490     Dethe Elza.
1491   - Added "unicode" and "class" directives.
1493 * docutils/parsers/rst/directives/parts.py:
1495   - Added the "sectnum" directive; by Dmitry Jemerov.
1496   - Added "class" option to "contents" directive.
1498 * docutils/parsers/rst/directives/references.py: Added to project.
1499   Contains the "target-notes" directive.
1501 * docutils/parsers/rst/languages/__init__.py:
1503   - Return ``None`` from get_language() for missing language modules.
1505 * docutils/parsers/rst/languages/de.py: Added to project; German
1506   mappings by Engelbert Gruber.
1508 * docutils/parsers/rst/languages/en.py:
1510   - Added interpreted text roles mapping.
1512 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1513   mappings by Marcelo Huerta San Martin.
1515 * docutils/parsers/rst/languages/fr.py: Added to project; French
1516   mappings by William Dode.
1518 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1519   mappings by Nicola Larosa.
1521 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1522   mappings by Miroslav Vasko.
1524 * docutils/readers/__init__.py:
1526   - Added support for the observer pattern from ``utils.Reporter``, in
1527     ``Reader.parse`` and ``Reader.transform``.
1528   - Removed ``Reader.transform()`` method.
1529   - Added default parameter values to ``Reader.__init__()`` to make
1530     instantiation easier.
1531   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1533 * docutils/readers/pep.py:
1535   - Added the ``peps.TargetNotes`` transform to the Reader.
1536   - Removed PEP & RFC reference detection code; moved to
1537     parsers/rst/states.py as options (enabled here by default).
1538   - Added support for pre-acceptance PEPs (no PEP number yet).
1539   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1540     easy subclassing.
1542 * docutils/readers/python: Python Source Reader subpackage added to
1543   project, including preliminary versions of:
1545   - __init__.py
1546   - moduleparser.py: Parser for Python modules.
1548 * docutils/transforms/__init__.py:
1550   - Added ``Transformer`` class and completed transform reform.
1551   - Added unknown_reference_resolvers list for each transformer. This list holds
1552     the list of functions provided by each component of the transformer that
1553     help resolve references.
1555 * docutils/transforms/frontmatter.py:
1557   - Improved support for generic fields.
1558   - Fixed bibliographic field language lookups.
1560 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1561   transforms.
1563 * docutils/transforms/parts.py:
1565   - Moved the "id" attribute from TOC list items to the references
1566     (``Contents.build_contents()``).
1567   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1568   - Added "class" attribute support to ``Contents``.
1570 * docutils/transforms/peps.py:
1572   - Added ``mask_email()`` function, updating to pep2html.py's
1573     functionality.
1574   - Linked "Content-Type: text/x-rst" to PEP 12.
1575   - Added the ``TargetNotes`` PEP-specific transform.
1576   - Added ``TargetNotes.cleanup_callback``.
1577   - Added title check to ``Headers``.
1579 * docutils/transforms/references.py:
1581   - Added the ``TargetNotes`` generic transform.
1582   - Split ``Hyperlinks`` into multiple transforms.
1583   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1584   - Added check for circular indirect references.
1585   - Made substitutions case-sensitive-but-forgiving.
1587 * docutils/transforms/universal.py:
1589   - Added support for the "--expose-internal-attributes" option.
1590   - Removed ``Pending`` transform classes & data.
1592 * docutils/writers/__init__.py:
1594   - Removed ``Writer.transform()`` method.
1596 * docutils/writers/docutils-xml.py:
1598   - Added XML and doctype declarations.
1599   - Added "--no-doctype" and "--no-xml-declaration" options.
1601 * docutils/writers/html4css1.py:
1603   - "name" attributes only on these tags: a, applet, form, frame,
1604     iframe, img, map.
1605   - Added "name" attribute to <a> in section titles for Netscape 4
1606     support (bug report: Pearu Peterson).
1607   - Fixed targets (names) on footnote, citation, topic title,
1608     problematic, and system_message nodes (for Netscape 4).
1609   - Changed field names from "<td>" to "<th>".
1610   - Added "@" to "&#64;" encoding to thwart address harvesters.
1611   - Improved the vertical whitespace optimization; ignore "invisible"
1612     nodes (targets, comments, etc.).
1613   - Improved inline literals with ``<span class="pre">`` around chunks
1614     of text and ``&nbsp;`` for runs of spaces.
1615   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1616     ``self.docinfo`` segments.
1617   - Added support for "line_block", "address" elements.
1618   - Improved backlinks (footnotes & system_messages).
1619   - Improved system_message output.
1620   - Redefined "--stylesheet" as containing an invariant URL, used
1621     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1622     working directory.
1623   - Added "--footnote-references" option (superscript or brackets).
1624   - Added "--compact-lists" and "--no-compact-lists" options.
1625   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1626     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1627   - Improved field list rendering.
1628   - Added Docutils version to "generator" meta tag.
1629   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1630   - Improved layout of <pre> HTML source.
1631   - Fixed attribute typo on <colspec>.
1632   - Refined XML prologue.
1633   - Support for no stylesheet.
1634   - Removed "interpreted" element support.
1635   - Added support for "title_reference", "sidebar", "attribution",
1636     "rubric", and generic "admonition" elements.
1637   - Added "--attribution" option.
1638   - Added support for "inline", "subscript", "superscript" elements.
1639   - Added initial support for "abbreviation" and "acronym";
1640     incomplete.
1642 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1643   (from the sandbox).
1645   - Added french.
1646   - Double quotes in literal blocks (special treatment for de/ngerman).
1647   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1648   - Added  "--attribution" option.
1649   - Right align attributions.
1651 * docutils/writers/pep_html.py:
1653   - Parameterized output encoding in PEP template.
1654   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1655   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1656     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1657     working directory.
1658   - Added an override on the "--footnote-references" option.
1659   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1660   - Added Docutils version to "generator" meta tag.
1661   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1663 * docs/tools.txt:
1665   - Added a "silent" setting for ``buildhtml.py``.
1666   - Added a "Getting Help" section.
1667   - Rearranged the structure.
1668   - Kept up to date, with new settings, command-line options etc.
1669   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1670   - Converted settings table into a definition list.
1672 * docs/rst/quickstart.txt:
1674   - Added a table of contents.
1675   - Added feedback information.
1676   - Added mention of minimum section title underline lengths.
1677   - Removed the 4-character minimum for section title underlines.
1679 * docs/rst/quickref.html:
1681   - Added a "Getting Help" section.
1682   - Added a style to make section title backlinks more subtle.
1683   - Added mention of minimum section title underline lengths.
1684   - Removed the 4-character minimum for section title underlines.
1686 * extras: Directory added to project; contains third-party modules
1687   that Docutils depends on (optparse, textwrap, roman).  These are
1688   only installed if they're not already present.
1690 * licenses: Directory added to project; contains copies of license
1691   files for non-public-domain files.
1693 * spec/doctree.txt:
1695   - Changed the focus.  It's about DTD elements:  structural
1696     relationships, semantics, and external (public) attributes.  Not
1697     about the element class library.
1698   - Moved some implementation-specific stuff into ``docutils.nodes``
1699     docstrings.
1700   - Wrote descriptions of all common attributes and parameter
1701     entities.  Filled in introductory material.
1702   - Working through the element descriptions: 55 down, 37 to go.
1703   - Removed "Representation of Horizontal Rules" to
1704     spec/rst/alternatives.txt.
1706 * spec/docutils.dtd:
1708   - Added "generated" inline element.
1709   - Added "line_block" body element.
1710   - Added "auto" attribute to "title".
1711   - Changed content models of "literal_block" and "doctest_block" to
1712     ``%text.model``.
1713   - Added ``%number;`` attribute type parameter entity.
1714   - Changed ``%structural.elements;`` to ``%section.elements``.
1715   - Updated attribute types; made more specific.
1716   - Added "address" bibliographic element.
1717   - Added "line" attribute to ``system_message`` element.
1718   - Removed "field_argument" element; "field_name" may contain
1719     multiple words and whitespace.
1720   - Changed public identifier to docutils.sf.net.
1721   - Removed "interpreted" element; added "title_reference",
1722     "abbreviation", "acronym".
1723   - Removed "refuri" attribute from "footnote_reference" and
1724     "citation_reference".
1725   - Added "sidebar", "rubric", "attribution", "admonition",
1726     "superscript", "subscript", and "inline" elements.
1728 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1730 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1732 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1734 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1735   Dallas Mahrt.
1737 * spec/transforms.txt: Added to project.
1739 * spec/howto: Added subdirectory, for developer how-to docs.
1741 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1742   Elza, edited & extended by David Goodger.
1744 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1745   project.
1747 * spec/rst/alternatives.txt:
1749   - Added "Doctree Representation of Transitions" from
1750     spec/doctree.txt.
1751   - Updated "Inline External Targets" & closed the debate.
1752   - Added ideas for interpreted text syntax extensions.
1753   - Added "Nested Inline Markup" section.
1755 * spec/rst/directives.txt:
1757   - Added directives: "topic", "sectnum", "target-notes",
1758     "line-block", "parsed-literal", "include", "replace", "sidebar",
1759     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1760     "class".
1761   - Formalized descriptions of directive details.
1762   - Added an "align" attribute to the "image" & "figure" directives
1763     (by Adam Chodorowski).
1764   - Added "class" options to "topic", "sidebar", "line-block",
1765     "parsed-literal", "contents", and "image"; and "figclass" to
1766     "figure".
1768 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1769   interpreted text roles.
1771 * spec/rst/introduction.txt:
1773   - Added pointers to material for new users.
1775 * spec/rst/reStructuredText.txt:
1777   - Disambiguated comments (just add a newline after the "::").
1778   - Updated enumerated list description; added a discussion of the
1779     second-line validity checking.
1780   - Updated directive description.
1781   - Added a note redirecting newbies to the user docs.
1782   - Expanded description of inline markup start-strings in non-markup
1783     contexts.
1784   - Removed field arguments and made field lists a generic construct.
1785   - Removed the 4-character minimum for section title underlines.
1786   - Clarified term/classifier delimiter & inline markup ambiguity
1787     (definition lists).
1788   - Added "Embedded URIs".
1789   - Updated "Interpreted Text" section.
1790   - Added "Character-Level Inline Markup" section.
1792 * test: Continually adding & updating tests.
1794   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1795   - Moved test/test_pep/ to test/test_readers/test_pep/.
1796   - Added test/test_readers/test_python/.
1797   - Added test/test_writers/ (Engelbert Gruber).
1799 * tools:
1801   - Made the ``locale.setlocale()`` calls in front ends
1802     fault-tolerant.
1804 * tools/buildhtml.py:
1806   - Added "--silent" option.
1807   - Fixed bug with absolute paths & "--config".
1808   - Updated for new I/O classes.
1809   - Added some exception handling.
1810   - Separated publishers' setting defaults; prevents interference.
1811   - Updated for new ``publish_file()`` convenience function.
1813 * tools/pep-html-template:
1815   - Allow for "--embed-stylesheet".
1816   - Added Docutils version to "generator" meta tag.
1817   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1818   - Conform to XHTML spec.
1820 * tools/pep2html.py:
1822   - Made ``argv`` a parameter to ``main()``.
1823   - Added support for "Content-Type:" header & arbitrary PEP formats.
1824   - Linked "Content-Type: text/plain" to PEP 9.
1825   - Files skipped (due to an error) are not pushed onto the server.
1826   - Updated for new I/O classes.
1827   - Added ``check_requirements()`` & ``pep_type_error()``.
1828   - Added some exception handling.
1829   - Updated for new ``publish_string()`` convenience function.
1830   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1832 * tools/quicktest.py:
1834   - Added "-V"/"--version" option.
1836 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1838 * tools/unicode2rstsubs.py: Added to project.  Produces character
1839   entity files (reSructuredText substitutions) from the MathML master
1840   unicode.xml file.
1842 * tools/editors: Support code for editors, added to project.  Contains
1843   ``emacs/restructuredtext.el``.
1845 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1847   - Added style for chunks of inline literals.
1848   - Removed margin for first child of table cells.
1849   - Right-aligned field list names.
1850   - Support for auto-numbered section titles in TOCs.
1851   - Increased the size of inline literals (<tt>) in titles.
1852   - Restored the light gray background for inline literals.
1853   - Added support for "line_block" elements.
1854   - Added style for "address" elements.
1855   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1856   - Improved field list rendering.
1857   - Vertical whitespace improvements.
1858   - Removed "a.target" style.
1860 * tools/stylesheets/pep.css:
1862   - Fixed nested section margins.
1863   - Other changes parallel those of ``../default.css``.
1866 Release 0.2 (2002-07-31)
1867 ========================
1869 General:
1871 - The word "component" was being used ambiguously.  From now on,
1872   "component" will be used to mean "Docutils component", as in Reader,
1873   Writer, Parser, or Transform.  Portions of documents (Table of
1874   Contents, sections, etc.)  will be called "document parts".
1875 - Did a grand renaming: a lot of ``verylongnames`` became
1876   ``very_long_names``.
1877 - Cleaned up imports: no more relative package imports or
1878   comma-separated lists of top-level modules.
1879 - Added support for an option values object which carries default
1880   settings and overrides (from command-line options and library use).
1881 - Added internal Unicode support, and support for both input and
1882   output encodings.
1883 - Added support for the ``docutils.io.IO`` class & subclasses.
1885 Specific:
1887 * docutils/__init__.py:
1889   - Added ``ApplicationError`` and ``DataError``, for use throughout
1890     the package.
1891   - Added ``Component`` base class for Docutils components; implements
1892     the ``supports`` method.
1893   - Added ``__version__`` (thus, ``docutils.__version__``).
1895 * docutils/core.py:
1897   - Removed many keyword parameters to ``Publisher.__init__()`` and
1898     ``publish()``; bundled into an option values object.  Added
1899     "argv", "usage", "description", and "option_spec" parameters for
1900     command-line support.
1901   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1902     methods.
1903   - Reworked I/O model for ``docutils.io`` wrappers.
1904   - Updated ``Publisher.set_options()``; now returns option values
1905     object.
1906   - Added support for configuration files (/etc/docutils.conf,
1907     ./docutils.conf, ~/.docutils).
1908   - Added ``Publisher.setup_option_parser()``.
1909   - Added default usage message and description.
1911 * docutils/frontend.py: Added to project; support for front-end
1912   (command-line) scripts.  Option specifications may be augmented by
1913   components.  Requires Optik (http://optik.sf.net/) for option
1914   processing (installed locally as docutils/optik.py).
1916 * docutils/io.py: Added to project; uniform API for a variety of input
1917   output mechanisms.
1919 * docutils/nodes.py:
1921   - Added ``TreeCopyVisitor`` class.
1922   - Added a ``copy`` method to ``Node`` and subclasses.
1923   - Added a ``SkipDeparture`` exception for visitors.
1924   - Renamed ``TreePruningException`` from ``VisitorException``.
1925   - Added docstrings to ``TreePruningException``, subclasses, and
1926     ``Nodes.walk()``.
1927   - Improved docstrings.
1928   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1929   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1930     imports.
1931   - Added ``decoration``, ``header``, and ``footer`` node classes, and
1932     ``PreDecorative`` mixin.
1933   - Reworked the name/id bookkeeping; to ``document``, removed
1934     ``explicit_targets`` and ``implicit_targets`` attributes, added
1935     ``nametypes`` attribute and ``set_name_id_map`` method.
1936   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1937     traversals.
1938   - Added ``document.has_name()`` method.
1939   - Fixed DOM generation for list-attributes.
1940   - Added category class ``Labeled`` (used by footnotes & citations).
1941   - Added ``Element.set_class()`` method (sets "class" attribute).
1943 * docutils/optik.py: Added to project.  Combined from the Optik
1944   package, with added option groups and other modifications.  The use
1945   of this module is probably only temporary.
1947 * docutils/statemachine.py:
1949   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1950   - Added underscores to improve many awkward names.
1951   - In ``string2lines()``, changed whitespace normalizing translation
1952     table to regexp; restores Python 2.0 compatibility with Unicode.
1954 * docutils/urischemes.py:
1956   - Filled in some descriptions.
1957   - Added "shttp" scheme.
1959 * docutils/utils.py:
1961   - Added ``clean_rcs_keywords`` function (moved from
1962     docutils/transforms/frontmatter.py
1963     ``DocInfo.filter_rcs_keywords``).
1964   - Added underscores to improve many awkward names.
1965   - Changed names of Reporter's thresholds:
1966     warning_level -> report_level; error_level -> halt_level.
1967   - Moved ``utils.id()`` to ``nodes.make_id()``.
1968   - Added ``relative_path(source, target)``.
1970 * docutils/languages/de.py: German mappings; added to project.  Thanks
1971   to Gunnar Schwant for the translations.
1973 * docutils/languages/en.py: Added "Dedication" bibliographic field
1974   mappings.
1976 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1977   Chodorowski.
1979 * docutils/parsers/rst/states.py:
1981   - Added underscores to improve many awkward names.
1982   - Added RFC-2822 header support.
1983   - Extracted the inline parsing code from ``RSTState`` to a separate
1984     class, ``Inliner``, which will allow easy subclassing.
1985   - Made local bindings for ``memo`` container & often-used contents
1986     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
1987   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1988   - Added ``MarkupMismatch`` exception; for late corrections.
1989   - Added ``-/:`` characters to inline markup's start string prefix,
1990     ``/`` to end string suffix.
1991   - Fixed a footnote bug.
1992   - Fixed a bug with literal blocks.
1993   - Applied patch from Simon Budig: simplified regexps with symbolic
1994     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1995   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1996   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1997   - Allowed non-ASCII in "simple names" (directive names, field names,
1998     references, etc.).
1999   - Converted ``Inliner.patterns.initial`` to be dynamically built
2000     from parts with ``build_regexp()`` function.
2001   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2002   - Updated docstrings.
2003   - Changed "table" to "grid_table"; added "simple_table" support.
2005 * docutils/parsers/rst/tableparser.py:
2007   - Changed ``TableParser`` to ``GridTableParser``.
2008   - Added ``SimpleTableParser``.
2009   - Refactored naming.
2011 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2012   a fallback language for directive names.
2014 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2015   directive to use a ``pending`` element, used only by HTML writers.
2017 * docutils/parsers/rst/directives/parts.py: Renamed from
2018   components.py.
2020   - Added "backlinks" attribute to "contents" directive.
2022 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2023   project by Adam Chodorowski.
2025 * docutils/readers/__init__.py: Gave Readers more control over
2026   choosing and instantiating Parsers.
2028 * docutils/readers/pep.py: Added to project; for PEP processing.
2030 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2031   requires a ``component`` parameter.
2033 * docutils/transforms/components.py: Added to project; transforms
2034   related to Docutils components.
2036 * docutils/transforms/frontmatter.py:
2038   - In ``DocInfo.extract_authors``, check for a single "author" in an
2039     "authors" group, and convert it to a single "author" element.
2040   - Added support for "Dedication" and generic bibliographic fields.
2042 * docutils/transforms/peps.py: Added to project; PEP-specific.
2044 * docutils/transforms/parts.py: Renamed from old components.py.
2046   - Added filter for `Contents`, to use alt-text for inline images,
2047     and to remove inline markup that doesn't make sense in the ToC.
2048   - Added "name" attribute to TOC topic depending on its title.
2049   - Added support for optional TOC backlinks.
2051 * docutils/transforms/references.py: Fixed indirect target resolution
2052   in ``Hyperlinks`` transform.
2054 * docutils/transforms/universal.py:
2056   - Changed ``Messages`` transform to properly filter out system
2057     messages below the warning threshold.
2058   - Added ``Decorations`` transform (support for ``--generator``,
2059     ``--date``, ``--time``, ``--source-link`` options).
2061 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2062   Engelbert Gruber's PDF writer.
2064 * docutils/writers/html4css1.py:
2066   - Made XHTML-compatible (switched to lowercase element & attribute
2067     names; empty tag format).
2068   - Escape double-dashes in comment text.
2069   - Improved boilerplate & modularity of output.
2070   - Exposed modular output in Writer class.
2071   - Added a "generator" meta tag to <head>.
2072   - Added support for the ``--stylesheet`` option.
2073   - Added support for ``decoration``, ``header``, and ``footer``
2074     elements.
2075   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2076     translation table to regexp; restores Python 2.0 compatibility
2077     with Unicode.
2078   - Added the translator class as instance variable to the Writer, to
2079     make it easily subclassable.
2080   - Improved option list spacing (thanks to Richard Jones).
2081   - Modified field list output.
2082   - Added backlinks to footnotes & citations.
2083   - Added percentage widths to "<col>" tags (from colspec).
2084   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2085     "<span>" changed to "<var>".
2086   - Inline literals: "<code>" changed to "<tt>".
2087   - Many changes to optimize vertical space: compact simple lists etc.
2088   - Add a command-line options & directive attributes to control TOC
2089     and footnote/citation backlinks.
2090   - Added support for optional footnote/citation backlinks.
2091   - Added support for generic bibliographic fields.
2092   - Identify backrefs.
2093   - Relative URLs for stylesheet links.
2095 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2096   PEPs (subclass of ``html4css1.Writer``).
2098 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2100 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2101   of the Docutils internal doctree in XML.
2103 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2105 * spec/doctree.txt:
2107   - Changed the title to "The Docutils Document Tree".
2108   - Added "Hyperlink Bookkeeping" section.
2110 * spec/docutils.dtd:
2112   - Added ``decoration``, ``header``, and ``footer`` elements.
2113   - Brought ``interpreted`` element in line with the parser: changed
2114     attribute "type" to "role", added "position".
2115   - Added support for generic bibliographic fields.
2117 * spec/notes.txt: Continual updates.  Added "Project Policies".
2119 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2120   section.
2122 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2124 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2125   mailing list discussions.
2127 * spec/pep-0287.txt:
2129   - Renamed to "reStructuredText Docstring Format".
2130   - Minor edits.
2131   - Reworked Q&A as an enumerated list.
2132   - Converted to reStructuredText format.
2134 * spec/pysource.dtd:
2136   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2138 * spec/pysource.txt: Removed from project.  Moved much of its contents
2139   to pep-0258.txt.
2141 * spec/rst/alternatives.txt:
2143   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2144   - Added "Inline External Targets" section.
2146 * spec/rst/directives.txt:
2148   - Added "backlinks" attribute to "contents" directive.
2150 * spec/rst/problems.txt:
2152   - Updated the Enumerated List Markup discussion.
2153   - Added new alternative table markup syntaxes.
2155 * spec/rst/reStructuredText.txt:
2157   - Clarified field list usage.
2158   - Updated enumerated list description.
2159   - Clarified purpose of directives.
2160   - Added ``-/:`` characters to inline markup's start string prefix,
2161     ``/`` to end string suffix.
2162   - Updated "Authors" bibliographic field behavior.
2163   - Changed "inline hyperlink targets" to "inline internal targets".
2164   - Added "simple table" syntax to supplement the existing but
2165     newly-renamed "grid tables".
2166   - Added cautions for anonymous hyperlink use.
2167   - Added "Dedication" and generic bibliographic fields.
2169 * test: Made test modules standalone (subdirectories became packages).
2171 * test/DocutilsTestSupport.py:
2173   - Added support for PEP extensions to reStructuredText.
2174   - Added support for simple tables.
2175   - Refactored naming.
2177 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2179   - Now supports true packages containing test modules
2180     (``__init__.py`` files required); fixes duplicate module name bug.
2182 * test/test_pep/: Subpackage added to project; PEP testing.
2184 * test/test_rst/test_SimpleTableParser.py: Added to project.
2186 * tools:
2188   - Updated html.py and publish.py front-end tools to use the new
2189     command-line processing facilities of ``docutils.frontend``
2190     (exposed in ``docutils.core.Publisher``), reducing each to just a
2191     few lines of code.
2192   - Added ``locale.setlocale()`` calls to front-end tools.
2194 * tools/buildhtml.py: Added to project; batch-generates .html from all
2195   the .txt files in directories and subdirectories.
2197 * tools/default.css:
2199   - Added support for ``header`` and ``footer`` elements.
2200   - Added styles for "Dedication" topics (biblio fields).
2202 * tools/docutils.conf: A configuration file; added to project.
2204 * tools/docutils-xml.py: Added to project.
2206 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2208 * tools/pep-html-template: Added to project.
2210 * tools/pep2html.py: Added to project from Python (nondist/peps).
2211   Added support for Docutils (reStructuredText PEPs).
2213 * tools/quicktest.py:
2215   - Added the ``--attributes`` option, hacked a bit.
2216   - Added a second command-line argument (output file); cleaned up.
2218 * tools/stylesheets/: Subdirectory added to project.
2220 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2223 Release 0.1 (2002-04-20)
2224 ========================
2226 This is the first release of Docutils, merged from the now inactive
2227 reStructuredText__ and `Docstring Processing System`__ projects.  For
2228 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2229 `DPS HISTORY`__ files.
2231 __ http://structuredtext.sourceforge.net/
2232 __ http://docstring.sourceforge.net/
2233 __ http://structuredtext.sourceforge.net/HISTORY.html
2234 __ http://docstring.sourceforge.net/HISTORY.html
2236 General changes: renamed 'dps' package to 'docutils'; renamed
2237 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2238 the test suites (reStructuredText's test/test_states renamed to
2239 test/test_rst); and all modifications required to make it all work.
2241 * docutils/parsers/rst/states.py:
2243   - Improved diagnostic system messages for missing blank lines.
2244   - Fixed substitution_reference bug.
2248    Local Variables:
2249    mode: indented-text
2250    indent-tabs-mode: nil
2251    sentence-end-double-space: t
2252    fill-column: 70
2253    End: