Put ensuremath around some latin1 chars.
[docutils.git] / HISTORY.txt
blob111ff38cf567f7e8af5d88ef90ff6b40c83106ec
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/languages/he.py: Added to project: Hebrew mappings by
21   Meir Kriheli.
23 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew 
24   mappings by Meir Kriheli.
26 * docutils/frontend.py:
28   - Configuration files are now assumed and required to be
29     UTF-8-encoded.
30   - Paths of applied configuration files are now recorded in the
31     runtime setting ``_config_files`` (accessible via
32     ``--dump-settings``).
33   - Added ``--strip-elements-with-class`` and ``--strip-class``
34     options (``strip_elements_with_classes`` and ``strip_classes``
35     settings).
37 * docutils/io.py:
39   - Added code to determine the input encoding from data: encoding
40     declarations or the presence of byte order marks (UTF-8 & UTF-16).
41   - Added support for IronPython 1.0.
43 * docutils/nodes.py:
45   - Added ``document.__getstate__`` method, for pickling.
47 * docutils/parsers/rst/states.py:
49   - Unquoted targets beginning with an underscore (``.. __target:
50     URI``) are no longer accepted.
51   - Added support for multiple attributions in a physical block quote
52     (indented text block), dividing it into multiple logical block
53     quotes.
54   - Added support for unicode bullets in bullet lists: "•", "‣", and
55     "⁃".
56   - Added support for new object-oriented directive interface,
57     retaining compatibility to the old functional interface.
58   - Added support for throwing ``DirectiveError``'s from within
59     directive code.
61 * docutils/parsers/rst/__init__.py:
63   - Added ``Directive`` base class.
64   - Added ``DirectiveError`` base class.
65   - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
66     definitions.
68 * docutils/parsers/directives/:
70   - Refactored all reStructuredText directives to use the new
71     object-oriented directive interface.  Errors are now (mostly)
72     thrown using the new ``DirectiveError`` class.
74 * docutils/transforms/universal.py:
76   - Added ``StripClassesAndElements`` transform to remove from the
77     document tree all elements with classes in
78     ``settings.strip_elements_with_classes`` and all "classes"
79     attribute values in ``self.document.settings.strip_classes``.
81 * docutils/transforms/writer_aux.py:
83   - Added ``Admonitions`` transform to transform specific admonitions
84     (like ``note``, ``warning``, etc.) into generic admonitions with a
85     localized title.
87 * docutils/writers/html4css1/__init__.py:
89   - Moved template functionality from the PEP/HTML writer here.
90   - Expanded the fragments available in the ``parts`` attribute.
91   - Moved ``id`` attributes from titles to surrounding ``div``
92     elements.
93   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
94     universally supported now).
95   - ``template.txt`` is now opened in text mode instead of binary mode
96     (to ensure Windows compatibility).
98 * docutils/writers/html4css1/template.txt: Added to project.
100 * docutils/writers/pep_html/:
102   - Moved template functionality to the HTML writer.
104 * docutils/writers/s5_html/__init__.py:
106   - Added ``view_mode`` & ``hidden_controls`` settings
107     (``--view-mode`` & ``--hidden-controls/--visible-controls``
108     options).
110 * docutils/writers/latex2e/__init__.py:
112   - Put ensuremath around some latin1 chars.
113   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
114   - New option ``--use-bibtex=style,db1,db2``.
115   - New option ``--reference-label`` to allow usage of LaTeX ref for 
116     labels in section references.
117   - Add a label after every section to support sectionnumbers as reference
118     labels.
119   - Fix: bug# 1605376 rst2latex: bad options group list
120   - Remove inactive code for use_optionlist_for_option_list.
121   - Remove latex comments from option_list output.
122   - Fix: bug# 1612270 double qoutes in italian literal.
123   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target. 
124   - Add option --use-latex-abstract.
125   - Image width unit ``px`` is translated to ``pt``.
126   - Add image height support.
127   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
128     bug #1457388
129   - Fix: Do not escape underscores in citation reference labels if
130     use-latex-citations is set.
131   - Use centering instead of center for figure contents, to avoid vertical
132     space.
133   - Recognize table class: borderless, nolines, booktabs, standard.
134   - Fix: Renaming contents section does not work with latex writer; SF
135     bug #1487405.
136   - Applied patch for custom roles with classes from Edward Loper.
137   - Fixed bug that caused crashes with more than 256 lists.
139 * docutils/writers/pep_html/__init__.py:
141   - Changed to support new python.org website structure and
142     pep2pyramid.py.
144 * docs/howto/security.txt: "Deploying Docutils Securely", added to
145   project.
147 * tools/editors/emacs/rst.el:
149   - Changed license to "GPL".
150   - Added ``rst-straighten-decorations`` function.
151   - The ``compile`` module is now always loaded.
152   - Added ``rst-toggle-line-block`` function.
153   - Headings consisting only of non-ASCII characters are now
154     recognized by ``rst-toc`` and ``rst-adjust``.
155   - Added font-lock support for multi-line comments where the first
156     comment line is empty.
157   - Added ``(require 'font-lock)``.
159 * setup.py:
161   - Provide descriptive error message if distutils is missing.
164 Release 0.4 (2006-01-09)
165 ========================
167 * General:
169   - Updated the project policies for trunk/branch development &
170     version numbering.
172 * docutils/__init__.py:
174   - Added ``__version_details__`` attribute to describe code source
175     (repository/snapshot/release).
176   - Replaced ``default_transforms`` attribute of TransformSpec with
177     ``get_transforms()`` method.
179 * docutils/core.py:
181   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
182     functions, for document tree extraction and reprocessing.
184 * docutils/io.py:
186   - Added ``DocTreeInput`` class, for reprocessing existing documents.
187   - Added support for non-Unicode (e.g. binary) writer output.
189 * docutils/nodes.py:
191   - Re-introduced ``Targetable.indirect_reference_name``, for
192     MoinMoin/reST compatibility (removed in r3124/r3129).
193   - Added ``serial_escape`` function; escapes string values that are
194     elements of a list, for serialization.  Modified Docutils-XML
195     writing (``Element._dom_node``) and pseudo-XML writing
196     (``Element.starttag``) to use ``serial_escape``.
197   - Added ``Node.deepcopy()`` method.
198   - Removed the internal lists ``document.substitution_refs``,
199     ``document.anonymous_refs``, and ``document.anonymous_targets``.
200   - Added a "container" element.
201   - Fixed bug where values of list-valued attributes of elements
202     originating from custom interpreted text roles (i.e., with custom
203     classes) were being shared between element instances.  Reported by
204     Shmuel Zeigerman.
206 * docutils/statemachine.py:
208   - Added trailing whitespace stripping to ``string2lines()``.
209   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
210     Asian double-width character support.
212 * docutils/utils.py:
214   - Added ``east_asian_column_width()`` for double-width character
215     support.
217 * docutils/languages/ja.py: Added to project: Japanese mappings by
218   Hisashi Morita.
220 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
221   mappings by Panjunyong.
223 * docutils/parsers/null.py: Added to project; a do-nothing parser.
225 * docutils/parsers/rst/__init__.py:
227   - Added validator to tab_width setting, with test.  Closes SF bug
228     #1212515, report from Wu Wei.
230 * docutils/parsers/rst/states.py:
232   - Fixed bug with escaped colons indicating a literal block.
233   - Fixed bug with enumerated lists (SF#1254145).
234   - Backslash-escaped colons inside of field names are now allowed.
235   - Targets (implicit and explicit), anonymous hyperlink references
236     and auto-numbered footnote references inside of substitution
237     definitions are now disallowed.
238   - Fixed bug: list items with blank first lines.
239   - Fixed bug: block quote attributions with indented second lines.
240   - Added East Asian double-width character support (Python 2.4 only).
242 * docutils/parsers/rst/tableparser.py:
244   - Added East Asian double-width character support (Python 2.4 only).
246 * docutils/parsers/rst/directives/body.py:
248   - Added the "container" directive.
250 * docutils/parsers/rst/directives/misc.py:
252   - Added the "default-role", "title", and "date" directives.
253   - Added standard data file syntax to the "include" directive.
254   - Added support for "class" directive content.
256 * docutils/parsers/rst/directives/images.py:
258   - Added ``indirect_reference_name`` support for images with a target
259     option.
260   - Added support for image width and height units.
261   - Fixed bug with image "target" options.
263 * docutils/parsers/rst/directives/references.py:
265   - Added "class" attribute to "target-notes" directive, for
266     footnote_reference classes.
268 * docutils/parsers/rst/include/: Directory added to project; contains
269   standard data files for the "include" directive.  Initial contents:
270   character entity substitution definition sets, and a set of
271   definitions for S5/HTML presentations.
273 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
274   mappings by David Goodger.
275   
276 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
277   Simplified Chinese mappings by Panjunyong.
279 * docutils/readers/__init__.py:
281   - Added universal.Decorations and universal.ExposeInternals
282     transforms as default transforms for all readers.
283   - Added ``ReReader`` base class for readers that reread an existing
284     document tree.
286 * docutils/readers/doctree.py: Added to project; a reader for existing
287   document trees.
289 * docutils/transforms/frontmatter.py:
291   - Fixed the DocInfo transform to handle SVN-style expansion of the
292     "Date" keyword.
293   - In ``DocInfo.extract_authors``, treat the contents of "authors"
294     fields uniformly.
296 * docutils/transforms/misc.py:
298   - Added misc.Transitions transform, extracted from
299     universal.FinalChecks.
301 * docutils/transforms/references.py:
303   - Added references.DanglingReferences transform, extracted from
304     universal.FinalChecks.
305   - Fixed bug with doubly-indirect substitutions.
306   - Added footnote_reference classes attribute to "TargetNotes".
307   - Fixed bug with circular substitution definitions that put Docutils
308     into an infinite loop.
310 * docutils/transforms/universal.py:
312   - Added universal.ExposeInternals transform, extracted from
313     universal.FinalChecks.
314   - Removed universal.FinalChecks transform (logic has been moved to
315     several new transforms).
316   - Fixed bug with the "expose_internals" setting and Text nodes
317     (exposed by the "rawsource" internal attribute).
318   - Added the universal.StripComments transform, implementation of the
319     "strip_comments" setting.
321 * docutils/transforms/writer_aux.py: Added to project; auxiliary
322   transforms for writers.
324   - Added ``Compound`` transform, which flattens compound paragraphs.
326 * docutils/writers/: Several writer modules (html4css1.py) were
327   converted into packages.  Support modules and data files have been
328   moved into the packages.  The stylesheets for the HTML writers are
329   now installed along with the code, the code knows where to find
330   them, and the default is to use them (actually, to embed them).
331   Some adjustments to configuration files may be necessary.  The
332   easiest way to obtain the new default behavior is to remove all
333   settings whose name includes "stylesheet".
335 * docutils/writers/__init__.py:
337   - Added universal.Messages and universal.FilterMessages transforms
338     as default transforms for all writers.
339   - Added ``UnfilteredWriter`` base class for writers that pass the
340     document tree on unchanged.
342 * docutils/writers/docutils_xml.py:
344   - Made ``xmlcharrefreplace`` the default output encoding error
345     handler.
347 * docutils/writers/html4css1/: 
349   - Added support for image width and height units.
350   - Made ``xmlcharrefreplace`` the default output encoding error
351     handler.
352   - Made ``--embed-stylesheet`` the default rather than
353     ``--link-stylesheet``.
354   - Moved "id" attribute from container (section etc.) to title's <a>
355     tag, to be on the same tag as "name".
356     (!!! To be reverted in Docutils 0.5.)
357   - Added vertical space between fields of field lists.
358   - Added ``--compact-field-lists`` option to remove vertical space in
359     simple field lists.
360   - Made cloaking of email addresses with ``--cloak-email-addresses``
361     less obtrusive.
362   - Fixed support for centered images.
363   - Added support for class="compact" & class="open" lists.
365 * docutils/writers/latex2e/:
367   - Underscores in citekeys are no longer escaped.
369 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
370   mapping of Unicode characters to LaTeX equivalents.
372 * docutils/writers/s5_html/: Package added to project; writer for
373   S5/HTML slide shows.
375 * docs/dev/distributing.txt: Added to project; guide for distributors
376   (package maintainers).
378 * docs/dev/hacking.txt: Added to project; guide for developers.
380 * docs/ref/doctree.txt:
382   - Updated for plural attributes "classes", "ids", "names",
383     "dupnames".
384   - Added the "container" element.
386 * docs/ref/docutils.dtd:
388   - Updated for plural attributes "classes", "ids", "names",
389     "dupnames".
391 * docs/user/emacs.txt: Added to project; a document about Emacs
392   support for reStructuredText and Docutils.
394 * docs/user/links.txt: Added to project; lists of Docutils-related
395   links.
397 * docs/user/mailing-lists.txt: Added to project; information about
398   Docutils-related mailing lists and how to access them.
400 * docs/user/slide-shows.txt: Added to project; example of and docs for
401   the S5/HTML writer (``rst2s5.py`` front end).
403 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
404   Files", added to project.
406 * test/coverage.sh: Added to project; test coverage script.
408 * test/DocutilsTestSupport.py:
410   - Added support for specifying runtime settings at the suite level.
412 * test/test_functional.py:
414   - Added the ``clear_output_directory`` function.
415   - Added support for ``_test_more`` functions in functional test
416     config files.
418 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
420 * tools/rstpep2html.py: Renamed from pep.py.
422 * tools/dev/create_unimap.py: Added to project; script to create the
423   docutils/writers/unimap_latex.py mapping file.
425 * tools/dev/profile_docutils.py: Added to project; profiler script.
427 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
429 * tools/editors/emacs/restructuredtext.el,
430   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
431   Removed from project; the functionality is now contained in rst.el.
433 * tools/editors/emacs/rst.el: Added to project.  Added many features
434   and fixed many bugs.  See docs/user/emacs.txt for details.
436 * tools/stylesheets: Removed from project.  Stylesheets have been
437   renamed and moved into writer packages.
440 Release 0.3.9 (2005-05-26)
441 ==========================
443 * General:
445   - Eliminated and replaced all uses of the old string attributes
446     ``id``, ``name``, ``dupname`` and ``class`` with references to the
447     new list attributes ``ids``, ``names``, ``dupnames`` and
448     ``classes`` throughout the whole source tree.
450 * docutils/core.py:
452   - Enabled ``--dump-*`` options when ``--traceback`` specified,
453     allowing for easier debugging.
454   - In ``Publisher.publish()``, expanded the generic top-level
455     exception catching.
457 * docutils/examples.py:
459   - Added ``internals`` function for exploration.
461 * docutils/io.py:
463   - Fixed ``Input.decode`` method to apply heuristics only if no
464     encoding is explicitly given, and to provide better reporting of
465     decoding errors.
466   - The ``Input.decode`` method now removes byte order marks (BOMs)
467     from input streams.
469 * docutils/nodes.py:
471   - ``image`` element class changed to subclass of Element, not
472     TextElement (it's an empty element, and cannot contain text).
473   - Added ``attr_defaults`` dictionary for default attribute values.
474   - Added empty list as default value for the following attributes:
475     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
476   - Added ``document.decoration`` attribute,
477     ``document.get_decoration`` method, and ``decoration.get_header``
478     & ``.get_footer`` methods.
479   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
480     methods.
482 * docutils/utils.py:
484   - Removed ``docutils.utils.Reporter.categories``,
485     ``docutils.utils.ConditionSet``, and all references to them, to
486     simplify error reporting.
488 * docutils/languages/nl.py: Added to project; Dutch mappings by
489   Martijn Pieters.
491 * docutils/parsers/rst/__init__.py:
493   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
495 * docutils/parsers/rst/states.py:
497   - Added check for escaped at-mark to prevent email address recognition.
498   - Fixed option lists to allow spaces inside ``<angle-bracketed option
499     arguments>``.
500   - Allowed whitespace in paths and URLs.
501   - Added auto-enumerated list items.
502   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
503     followed by text.
504   - Added support for table stub columns.
506 * docutils/parsers/rst/directives/__init__.py:
508   - Allowed whitespace in paths (``path`` function).
509   - Added ``uri`` directive option conversion function.
511 * docutils/parsers/rst/directives/body.py:
513   - Fixed illegal context bug with "topic" directive (allowed within
514     sidebars; not within body elements).
516 * docutils/parsers/rst/directives/images.py:
518   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
519   - Added support for the ``file_insertion_enabled`` setting in the
520     "figure" directive (disables "figwidth" option).
521   - "image" directive: added checks for valid values of "align" option,
522     depending on context.  "figure" directive: added specialized
523     "align" option and attribute on "figure" element.
524   - Made ":figwidth: image" option of "figure" directive work again.
525   - Fixed bug with reference names containing uppercase letters
526     (e.g. ``Name_``) in "target" option of "image" directive.
528 * docutils/parsers/rst/directives/misc.py:
530   - Fixed "include" and "raw" directives to catch text decoding
531     errors.
532   - Allowed whitespace in "include" & "raw" directive paths.
533   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
534     settings in "include" & "raw" directives.
536 * docutils/parsers/rst/directives/parts.py:
538   - Added "header" & "footer" directives.
539   - Fixed illegal context bug with "contents" directive (topics
540     allowed within sidebars; not within body elements).
542 * docutils/parsers/rst/directives/tables.py:
544   - Added "list-table" directive.
545   - Caught empty CSV table bug.
546   - Added support for the ``file_insertion_enabled`` setting in the
547     "csv-table" directive.
548   - Added ``stub-columns`` option to "csv-table" and "list-table"
549     directives.
551 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
552   mappings by Martijn Pieters.
554 * docutils/readers/standalone.py:
556   - Added ``--section-subtitles`` and ``--no-section-subtitles``
557     options to activate or deactivate the SectSubTitle transform.
559 * docutils/transforms/frontmatter.py:
561   - Added SectSubTitle transform to promote titles of lone
562     subsections to subtitles.
564 * docutils/transforms/references.py:
566   - Fixed mislocated internal targets bug, by propagating internal
567     targets to the next node, making use of the newly added support
568     for multiple names and IDs.
569   - Fixed duplicate footnote label bug.
570   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
571     transform.
573 * docutils/writers/html4css1.py:
575   - Fixed unencoded stylesheet reference bug (characters like "&" in
576     stylesheet references).
577   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
578     tags).
579   - Added support for multiple IDs per node by creating empty ``span``
580     tags.
581   - Added the ``field_name_limit`` & ``option_limit`` settings &
582     support.
583   - Added support for table stub columns.
584   - Added support for the ``align`` attribute on ``figure`` elements.
585   - Added the ``cloak_email_addresses`` setting & support.
586   - Added ``html_prolog``, ``html_head``, ``html_body``,
587     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
588     ``docutils.core.publish_parts``.
589   - Added support for section subtitles.
591 * docutils/writers/latex2e.py:
593   - Fixed tables starting with more than one multirow cell.
594   - Improved --use-latex-docinfo so that organization/contact/address
595     fields are lumped with the last author field and appear on the
596     titlepage.
597   - Made sure the titlepage is always shown with --use-latex-docinfo,
598     even if the document has no title.
599   - Made sure that latex doesn't fill in today's date if no date field
600     was given.
601   - Added support for section subtitles.
603 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
604   (under development).
606 * docutils/writers/null.py: Added to project; a do-nothing Writer.
608 * docs/api/publisher.txt:
610   - Added "``publish_parts`` Details" section.
612 * docutils/dev/repository.txt: Added to project; information about the
613   Docutils Subversion repository.
615 * docs/ref/docutils.dtd:
617   - Added a ``stub`` attribute to the ``colspec`` element via the
618     ``tbl.colspec.att`` parameter entity.
619   - Allowed topic elements within sidebars
620   - Added an ``align`` attribute to the ``figure`` element.
622 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
623   writer.
626 Release 0.3.7 (2004-12-24)
627 ==========================
629 * docutils/frontend.py:
631   - Added options: --input-encoding-error-handler,
632     --record-dependencies, --leave-footnote-reference-space,
633     --strict-visitor.
634   - Added command-line and config file support for "overrides" setting
635     parameter.
637 * docutils/io.py:
639   - Added support for input encoding error handler.
641 * docutils/nodes.py:
643   - Added dispatch_visit and dispatch_departure methods to
644     NodeVisitor; useful as a hook for Visitors.
645   - Changed structure of ``line_block``; added ``line``.
646   - Added ``compound`` node class.
647   - Added a mechanism for Visitors to transitionally ignore new node
648     classes.
650 * docutils/utils.py:
652   - Moved ``escape2null`` and ``unescape`` functions from
653     docutils/parsers/rst/states.py.
655 * docutils/parsers/rst/roles.py:
657   - Added "raw" role.
658   - Changed role function API: the "text" parameter now takes
659     null-escaped interpreted text content.
661 * docutils/parsers/rst/states.py:
663   - Fixed bug where a "role" directive in a nested parse would crash
664     the parser; the state machine's "language" attribute was not being
665     copied over.
666   - Added support for line block syntax.
667   - Fixed directive parsing bug: argument-less directives didn't
668     notice that arguments were present.
669   - Removed error checking for transitions.
670   - Added support for multiple classifiers in definition list items.
671   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
672   - Changed role function API: the "text" parameter now takes
673     null-escaped interpreted text content.
674   - Empty sections and documents are allowed now.
676 * docutils/parsers/rst/directives/__init__.py:
678   - Added ``encoding`` directive option conversion function.
679   - Allow multiple class names in class_option conversion function.
681 * docutils/parsers/rst/directives/body.py:
683   - Converted the line-block directive to use the new structure.
684   - Extracted the old line-block functionality to the ``block``
685     function (still used).
686   - Added ``compound`` directive (thanks to Felix Wiemann).
688 * docutils/parsers/rst/directives/misc.py:
690   - Added "encoding" option to "include" and "raw" directives.
691   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
692   - Allow multiple class names in the "class" directive.
694 * docutils/parsers/rst/directives/parts.py:
696   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
697     options.  Thanks to Lele Gaifax.
699 * docutils/parsers/rst/directives/tables.py:
701   - Added "encoding" directive to "csv-table" directive.
702   - Added workaround for lack of Unicode support in csv.py, for
703     non-ASCII CSV input.
705 * docutils/transforms/misc.py:
707   - Fixed bug when multiple "class" directives are applied to a single
708     element.
709   - Enabled multiple format names for "raw" directive.
711 * docutils/transforms/references.py:
713   - Added support for trimming whitespace from beside substitution
714     references.
716 * docutils/transforms/universal.py:
718   - FinalChecks now checks for illegal transitions and moves
719     transitions between sections.
721 * docutils/writers/html4css1.py:
723   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
724   - "stylesheet" and "stylesheet_path" settings are now mutually
725     exclusive.
726   - Added support for the new line_block/line structure.
727   - --footnote-references now overrides
728     --trim-footnote-reference-space, if applicable.
729   - Added support for ``compound`` elements.
730   - Enabled multiple format names for "raw" directive.
731   - ``<p>`` tags of a paragraph which is the only visible child of the
732     document node are no longer stripped.
733   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
734     new method ``should_be_compact_paragraph()``.
735   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
736     elements.
737   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
738     the output if they have their ``class`` attribute set.
739   - The whole document is now surrounded by a ``<div
740     class="document">`` element.
741   - Body-level images are now wrapped by their own ``<div>`` elements,
742     with image classes copied to the wrapper, and for images which
743     have the ``:align:`` option set, the surrounding ``<div>`` now
744     receives a class attribute (like ``class="align-left"``).
746 * docutils/writers/latex2e.py:
748   - no newline after depart_term.
749   - Added translations for some Unicode quotes.
750   - Added option "font-encoding", made package AE the default.
751   - "stylesheet" and "stylesheet_path" settings are now mutually
752     exclusive.
753   - --footnote-references now overrides
754     --trim-footnote-reference-space, if applicable.
755   - The footnote label style now matches the footnote reference style
756     ("brackets" or "superscript").
757   - Added support for ``compound`` elements.
758   - Enabled multiple format names for "raw" directive.
760 * docs/ref/docutils.dtd:
762   - Changed structure of the ``line_block`` element; added ``line``.
763   - Added ``compound`` element.
764   - Added "ltrim" and "rtrim" attributes to
765     ``substitution_definition`` element.
766   - Enabled multiple format names for ``raw`` element.
767   - Enabled multiple classifiers in ``definition_list_item`` elements.
769 * docs/ref/rst/directives.txt
771   - Marked "line-block" as deprecated.
772   - "Class" directive now allows multiple class names.
773   - Added "Rationale for Class Attribute Value Conversion".
774   - Added warning about "raw" overuse/abuse.
776 * docs/ref/rst/restructuredtext.txt:
778   - Added syntax for line blocks.
779   - Definition list items may have multiple classifiers.
781 * docs/ref/rst/roles.txt:
783   - Added "raw" role.
785 * tools/stylesheets/default.css:
787   - Added support for the new line_block structure.
788   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
791 Release 0.3.5 (2004-07-29)
792 ==========================
794 General:
796 * _`Documentation cleanup/reorganization`.
798   - Created new subdirectories of docs/:
800     * ``docs/user/``: introductory/tutorial material for end-users
801     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
802     * ``docs/api/``: API reference material for client-developers
803     * ``docs/ref/``: reference material for all groups
804     * ``docs/howto/``: for component-developers and core-developers
805     * ``docs/peps/``: Python Enhancement Proposals
807   - Moved ``docs/*`` to ``docs/user/``.
808   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
809     ``spec/`` to ``docs/dev``.
810   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
811     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
812   - Moved ``alternatives.txt``, and ``problems.txt`` from
813     ``spec/rst/`` to ``docs/dev/rst/``.
814   - Moved ``reStructuredText.txt``, ``directives.txt``,
815     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
816     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
817     ``roles.txt``, ``reStructuredText.txt`` to
818     ``restructuredtext.txt``.
819   - Moved ``spec/howto/`` to ``docs/howto``.
821   In order to keep the CVS history of moved files, we supplied
822   SourceForge with a `script for modifying the Docutils CVS
823   repository`__.
825   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
827   After running the cleanup script:
829   - Added ``docs/index.txt``.
830   - Added a ``.htaccess`` file to the ``web`` module, containing
831     redirects for all old paths to new paths.  They'll preserve
832     fragments (the "#name" part of a URL), and won't clutter up the
833     file system, and will correct the URL in the user's browser.
834   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
835     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
836     the "To Do" list itself in ``docs/dev/todo.txt``.
837   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
838     section of ``docs/dev/todo.txt``.
839   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
840   - Added "How To Report Bugs" to ``BUGS.txt``.
841   - Went through all the sources and docs (including under web/) and
842     updated links.  Mostly done by Felix Wiemann; thanks Felix!
843     (Still need to update links in the sandboxes.)
845 Specific:
847 * BUGS.txt: Added to project.
849 * THANKS.txt: Added to project.
851 * docutils/__init__.py:
853   - 0.3.4: Post-release.
855 * docutils/core.py:
857   - Added special error handling & advice for UnicodeEncodeError.
858   - Refactored Publisher.publish (simplified exception handling &
859     extracted debug dumps).
860   - Renamed "enable_exit" parameter of convenience functions to
861     "enable_exit_status".
862   - Enabled traceback (exception propagation) by default in
863     programmatic convenience functions.
864   - Now publish_file and publish_cmdline convenience functions return
865     the encoded string results in addition to their regular I/O.
866   - Extracted common code from publish_file, publish_string, and
867     publish_parts, into new publish_programmatically.  Extracted
868     settings code to ``Publisher.process_programmatic_settings``.
869   - In Publisher.publish, disabled ``settings_overrides`` when
870     ``settings`` is supplied; redundant.
872 * docutils/frontend.py:
874   - Added help text for "--output-encoding-error-handler" and
875     "--error-encoding-error-handler".
876   - Renamed "--exit" to "--exit-status".
877   - Simplified default-setting code.
879 * docutils/parsers/rst/__init__.py:
881   - Added "--pep-base-url" and "--rfc-base-url" options.
883 * docutils/parsers/rst/states.py:
885   - Made URI recognition more aggressive and intelligent.
887 * docutils/parsers/rst/directives/__init__.py:
889   - Added several directive option conversion functions.
891 * docutils/parsers/rst/directives/body.py:
893   - Moved "table" directive to tables.py.
895 * docutils/parsers/rst/directives/tables.py: Table-related directives,
896   added to project.
898 * docutils/writers/latex2e.py:
900   - Added "--table-style=(standard|booktabs|nolines)"
901   - figures get "here" option (LaTeX per default puts them at bottom),
902     and figure content is centered.
903   - Rowspan support for tables.
904   - Fix: admonition titles before first section.
905   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
906   - Replave ``_`` in literal by an underlined blank, because it has the correct
907     width.
908   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
909   - A few unicode replacements, if output_encoding != utf
910   - Add "--graphicx-option".
911   - Indent literal-blocks.
912   - Fix: omit ``\maketitle`` when there is no document title.
914 * docs/index.txt: "Docutils Project Documentation Overview", added to
915   project.
917 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
918   Tool", added to project.
920 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
922 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
924 * docs/dev/policies.txt: Added to project (extracted from
925   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
927 * docs/dev/release.txt: Added to project (extracted from
928   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
930 * docs/dev/testing.txt: Added to project.
932 * docs/dev/website.txt: Added to project (extracted from
933   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
935 * docs/ref/rst/directives.txt:
937   - Added directives: "table", "csv-table".
939 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
940   added to project.  1 page for syntax, and a 1 page reference for
941   directives and roles.  Source text to be used as-is; not meant to be
942   converted to HTML.
944 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
945   with a change of title.
947 * test/functional/, contents, and test/test_functional.py: Added to
948   project.
950 * tools/buildhtml.py: Fixed bug with config file handling.
952 * tools/html.py: Removed from project (duplicate of rst2html.py).
954 * tools/pep2html.py: Removed from project (duplicate of Python's
955   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
956   Docutils-related PEPs in docs/peps/).
958 * tools/rst2pseudoxml.py: Renamed from publish.py.
960 * tools/rst2xml.py: Renamed from docutils-xml.py.
962 * tools/test.txt: Removed from project; moved to
963   docs/user/rst/demo.txt.
965 * setup.py: Now also installs ``rst2latex.py``.
968 Release 0.3.3 (2004-05-09)
969 ==========================
971 * docutils/__init__.py:
973   - 0.3.1: Reorganized config file format (multiple sections); see
974     docs/config.txt.
975   - Added unknown_reference_resolvers attribute to TransformSpec.
976   - 0.3.2: Interpreted text reorganization.
977   - 0.3.3: Released.
979 * docutils/core.py:
981   - Catch system messages to stop tracebacks from parsing errors.
982   - Catch exceptions during processing report & exit without
983     tracebacks, except when "--traceback" used.
984   - Reordered components for OptionParser; application comes last.
985   - Added "config_section" parameter to several methods and functions,
986     allowing front ends to easily specify their config file sections.
987   - Added publish_parts convenience function to allow access to individual
988     parts of a document.
990 * docutils/examples.py: Added to project; practical examples of
991   Docutils client code, to be used as-is or as models for variations.
993 * docutils/frontend.py:
995   - Added "--traceback" & "--no-traceback" options ("traceback"
996     setting).
997   - Implemented support for config file reorganization:
998     ``standard_config_files`` moved from ``ConfigParser`` to
999     ``OptionParser``; added
1000     ``OptionParser.get_config_file_settings()`` and
1001     ``.get_standard_config_settings()``; support for old "[options]"
1002     section (with deprecation warning) and mapping from old to new
1003     settings.
1004   - Reimplemented setting validation.
1005   - Enabled flexible boolean values: yes/no, true/false, on/off.
1006   - Added ``Values``, a subclass of ``optparse.Values``, with support
1007     for list setting attributes.
1008   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1009     thanks to Beni Cherniavsky.
1010   - Added "--no-section-numbering" option.
1012 * docutils/io.py:
1014   - Catch IOErrors when opening source & destination files, report &
1015     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1016     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1018 * docutils/nodes.py:
1020   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1021     method definitions (via ``exec``) to dynamic assignments (via
1022     ``setattr``); thanks to Roman Suzi.
1023   - Encapsulated visitor dynamic assignments in a function; thanks to
1024     Ian Bicking.
1025   - Added indirect_reference_name attribute to the Targetable
1026     class. This attribute holds the whitespace_normalized_name
1027     (contains mixed case) of a target.
1029 * docutils/statemachine.py:
1031   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1032   - Added ``StringList.get_2D_block``.
1034 * docutils/utils.py:
1036   - Added "level" attribute to SystemMessage exceptions.
1038 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1039   Jannie Hofmeyr.
1041 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1042   Blaha.
1044 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1045   Marcelo Huerta San Martin.
1047 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1048   mappings by Lalo Martins.
1050 * docutils/languages/ru.py: Added to project; Russian mappings by
1051   Roman Suzi.
1053 * docutils/parsers/rst/roles.py: Added to project.  Contains
1054   interpreted text role functions, a registry for interpreted text
1055   roles, and an API for adding to and retrieving from the registry.
1056   Contributed by Edward Loper.
1058 * docutils/parsers/rst/states.py:
1060   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1061   - Allowed true em-dash character and "---" as block quote
1062     attribution marker.
1063   - Added support for <angle-bracketed> complex option arguments
1064     (option lists).
1065   - Fixed handling of backslashes in substitution definitions.
1066   - Fixed off-by-1 error with extra whitespace after substitution
1067     definition directive.
1068   - Added inline markup parsing to field lists' field names.
1069   - Added support for quoted (and unindented) literal blocks.
1070     Driven in part by a bribe from Frank Siebenlist (thanks!).
1071   - Parser now handles escapes in URIs correctly.
1072   - Made embedded-URIs' reference text omittable.  Idea from Beni
1073     Cherniavsky.
1074   - Refactored explicit target processing code.
1075   - Added name attribute to references containing the reference name only
1076     through whitespace_normalize_name (no case changes).
1077   - parse_target no longer returns the refname after going through
1078     normalize_name. This is now handled in make_target.
1079   - Fixed bug relating to role-less interpreted text in non-English
1080     contexts.
1081   - Reorganized interpreted text processing; moved code into the new
1082     roles.py module.  Contributed by Edward Loper.
1083   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1084     ``parse_directive_block``.
1086 * docutils/parsers/rst/tableparser.py:
1088   - Reworked for ``StringList``, to support "include" directives in
1089     table cells.
1091 * docutils/parsers/rst/directives/__init__.py:
1093   - Renamed ``unchanged()`` directive option conversion function to
1094     ``unchanged_required``, and added a new ``unchanged``.
1095   - Catch unicode value too high error; fixes bug 781766.
1096   - Beefed up directive error reporting.
1098 * docutils/parsers/rst/directives/body.py:
1100   - Added basic "table" directive.
1102 * docutils/parsers/rst/directives/images.py:
1104   - Added "target" option to "image" directive.
1105   - Added name attribute to references containing the reference name only
1106     through whitespace_normalize_name (no case changes).
1108 * docutils/parsers/rst/directives/misc.py:
1110   - Isolated the import of the ``urllib2`` module; was causing
1111     problems on SourceForge (``libssl.so.2`` unavailable?).
1112   - Added the "role" directive for declaring custom interpreted text
1113     roles.
1115 * docutils/parsers/rst/directives/parts.py:
1117   - The "contents" directive does more work up-front, creating the
1118     "topic" and "title", and leaving the "pending" node for the
1119     transform.  Allows earlier reference resolution; fixes subtle bug.
1121 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1122   mappings by Jannie Hofmeyr.
1124 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1125   mappings by Marek Blaha.
1127 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1128   mappings by Marcelo Huerta San Martin.
1130 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1131   Portuguese mappings by Lalo Martins.
1133 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1134   mappings by Roman Suzi.
1136 * docutils/transforms/parts.py:
1138   - The "contents" directive does more work up-front, creating the
1139     "topic" and "title", and leaving the "pending" node for the
1140     transform.  Allows earlier reference resolution; fixes subtle bug.
1141   - Added support for disabling of section numbering.
1143 * docutils/transforms/references.py:
1145   - Verifying that external targets are truly targets and not indirect
1146     references. This is because we are now adding a "name" attribute to
1147     references in addition to targets. Note sure if this is correct!
1148   - Added code to hook into the unknown_reference_resolvers list for a
1149     transformer in resolve_indirect_target. This allows the
1150     unknown_reference_resolvers to keep around indirect targets which
1151     docutils doesn't know about.
1152   - Added specific error message for duplicate targets.
1154 * docutils/transforms/universal.py:
1156   - Added FilterMessages transform (removes system messages below the
1157     verbosity threshold).
1158   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1159     to FinalCheckVisitor for application-specific handling of
1160     unresolvable references.
1161   - Added specific error message for duplicate targets.
1163 * docutils/writers/__init__.py:
1165   - Added assemble_parts method to the Writer class to allow for
1166     access to a documents individual parts.
1167   - Documented & set default for ``Writer.output`` attribute.
1169 * docutils/writers/html4css1.py:
1171   - Fixed unicode handling of attribute values (bug 760673).
1172   - Prevent duplication of "class" attribute values (bug report from
1173     Kirill Lapshin).
1174   - Improved table grid/border handling (prompted by report from Bob
1175     Marshall).
1176   - Added support for table titles.
1177   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1178     to Darek Suchojad.
1179   - Added functionality to keep track of individual parts of a document
1180     and store them in a dictionary as the "parts" attribute of the writer.
1181     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1182   - Added proper support for the "scale" attribute of the "image"
1183     element.  Contributed by Brent Cook.
1184   - Added ``--initial-header-level`` option.
1185   - Fixed bug: the body_pre_docinfo segment depended on there being a
1186     docinfo; if no docinfo, the document title was incorporated into
1187     the body segment.  Adversely affected the publish_parts interface.
1189 * docutils/writers/latex2e.py:
1191   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1192     about a missing file.
1193   - Added options and support: ``--compound-enumerators``,
1194     ``--section-prefix-for-enumerators``, and
1195     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1196     934322).
1197   - Added option ``--use-verbatim-when-possible``, to avoid
1198     problematic characters (eg, '~' in italian) in literal blocks.
1199   - It's now possible to use four section levels in the `book` and
1200     `report` LaTeX classes.  The default `article` class still has
1201     three levels limit.
1203 * docs/config.txt: "Docutils Configuration Files", added to project.
1204   Moved config file entry descriptions from tools.txt.
1206 * docs/tools.txt:
1208   - Moved config file entry descriptions to config.txt.
1210 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1211   Development".
1213 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1214   Text Roles", added to project.
1216 * spec/rst/reStructuredText.txt:
1218   - Added description of support for <angle-bracketed> complex option
1219     arguments to option lists.
1220   - Added subsections for indented and quoted literal blocks.
1222 * test: Continually adding & updating tests.
1224   - Added test/test_settings.py & test/data/config_*.txt support
1225     files.
1226   - Added test/test_writers/test_htmlfragment.py.
1228 * test/DocutilsTestSupport.py:
1230   - Refactored LaTeX publisher test suite/case class names to make
1231     testing other writers easier.
1232   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1233     to test the processing of HTML fragments which use the new
1234     publish_parts convenience function.
1236 * tools/buildhtml.py:
1238   - Added support for the "--prune" option.
1239   - Removed dependency on pep2html.py; plaintext PEPs no longer
1240     supported.
1242 * tools/docutils.conf:
1244   - Updated for configuration file reorganization.
1246 * tools/rst2html.py:
1248   - copied from tools/html.py
1250 * setup.py:
1252   - added a 'scripts' section to configuration
1253   - added 'tools/rst2html.py' to the scripts section
1256 Release 0.3 (2003-06-24)
1257 ========================
1259 General:
1261 * Renamed "attribute" to "option" for directives/extensions.
1263 * Renamed transform method "transform" to "apply".
1265 * Renamed "options" to "settings" for runtime settings (as set by
1266   command-line options).  Sometimes "option" (singular) became
1267   "settings" (plural).  Some variations below:
1269   - document.options -> document.settings (stored in other objects as
1270     well)
1271   - option_spec -> settings_spec (not directives though)
1272   - OptionSpec -> SettingsSpec
1273   - cmdline_options -> settings_spec
1274   - relative_path_options -> relative_path_settings
1275   - option_default_overrides -> settings_default_overrides
1276   - Publisher.set_options -> Publisher.get_settings
1278 Specific:
1280 * COPYING.txt: Added "Public Domain Dedication".
1282 * FAQ.txt: Frequently asked questions, added to project.
1284 * setup.py:
1286   - Updated with PyPI Trove classifiers.
1287   - Conditional installation of third-party modules.
1289 * docutils/__init__.py:
1291   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1292   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1293   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1294   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1295     option and its effect on the PEP template & writer.
1296   - Bumped version to 0.2.4 due to changes to the PEP template &
1297     stylesheet.
1298   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1299   - Added ``TransformSpec`` class for new transform system.
1300   - Bumped version to 0.2.6 for API changes (renaming).
1301   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1302     convenience functions.
1303   - Added ``Component.component_type`` attribute.
1304   - Bumped version to 0.2.8 because of the internal parser switch from
1305     plain lists to the docutils.statemachine.StringList objects.
1306   - Bumped version to 0.2.9 because of the frontend.py API changes.
1307   - Bumped version to 0.2.10 due to changes to the project layout
1308     (third-party modules removed from the "docutils" package), and
1309     signature changes in ``io.Input``/``io.Output``.
1310   - Changed version to 0.3.0 for release.
1312 * docutils/core.py:
1314   - Made ``publish()`` a bit more convenient.
1315   - Generalized ``Publisher.set_io``.
1316   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1317     parameters; improved its docstring.
1318   - Added ``publish_file()`` and ``publish_string()``.
1319   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1320     out of ``.set_io``.
1321   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1322     "--dump-transforms" hidden options.
1323   - Added ``Publisher.apply_transforms()`` method.
1324   - Added ``Publisher.set_components()`` method; support for
1325     ``publish_*()`` conveninece functions.
1326   - Moved config file processing to docutils/frontend.py.
1327   - Added support for exit status ("exit_level" setting &
1328     ``enable_exit`` parameter for Publisher.publish() and convenience
1329     functions).
1331 * docutils/frontend.py:
1333   - Check for & exit on identical source & destination paths.
1334   - Fixed bug with absolute paths & "--config".
1335   - Set non-command-line defaults in ``OptionParser.__init__()``:
1336     ``_source`` & ``_destination``.
1337   - Distributed ``relative_path_settings`` to components; updated
1338     ``OptionParser.populate_from_components()`` to combine it all.
1339   - Require list of keys in ``make_paths_absolute`` (was implicit in
1340     global ``relative_path_settings``).
1341   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1342     "--dump-settings", and "--dump-transforms" hidden options.
1343   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1344     code, replaced with correct code.
1345   - Added validation functionality for config files.
1346   - Added "--error-encoding" option/setting, "_disable_config"
1347     internal setting.
1348   - Added encoding validation; updated "--input-encoding" and
1349     "--output-encoding"; added "--error-encoding-error-handler" and
1350     "--output-encoding-error-handler".
1351   - Moved config file processing from docutils/core.py.
1352   - Updated ``OptionParser.populate_from_components`` to handle new
1353     ``SettingsSpec.settings_defaults`` dict.
1354   - Added support for "-" => stdin/stdout.
1355   - Added "exit_level" setting ("--exit" option).
1357 * docutils/io.py:
1359   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1360   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1361   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1362   - ``FileOutput.write()`` now returns the encoded output string.
1363   - Try to get path/stream name automatically in ``FileInput`` &
1364     ``FileOutput``.
1365   - Added defaults for source & destination paths.
1366   - Allow for Unicode I/O with an explicit "unicode" encoding.
1367   - Added ``Output.encode()``.
1368   - Removed dependency on runtime settings; pass encoding directly.
1369   - Recognize Unicode strings in ``Input.decode()``.
1370   - Added support for output encoding error handlers.
1372 * docutils/nodes.py:
1374   - Added "Invisible" element category class.
1375   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1376     modification during a traversal.
1377   - Added element classes: ``line_block``, ``generated``, ``address``,
1378     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1379     ``superscript``, ``subscript``, ``inline``
1380   - Added support for lists of nodes to ``Element.insert()``.
1381   - Fixed parent linking in ``Element.replace()``.
1382   - Added new abstract superclass ``FixedTextElement``; adds
1383     "xml:space" attribute.
1384   - Added support for "line" attribute of ``system_message`` nodes.
1385   - Added support for the observer pattern from ``utils.Reporter``.
1386     Added ``parse_messages`` and ``transform_messages`` attributes to
1387     ``document``, removed ``messages``.  Added ``note_parse_message``
1388     and ``note_transform_message`` methods.
1389   - Added support for improved diagnostics:
1391     - Added "document", "source", and "line" internal attributes to
1392       ``Node``, set by ``Node.setup_child()``.
1393     - Converted variations on ``node.parent = self`` to
1394       ``self.setup_child(node)``.
1395     - Added ``document.current_source`` & ``.current_line``
1396       attributes, and ``.note_source`` observer method.
1397     - Changed "system_message" output to GNU-Tools format.
1399   - Added a "rawsource" attribute to the ``Text`` class, for text
1400     before backslash-escape resolution.
1401   - Support for new transform system.
1402   - Reworked ``pending`` element.
1403   - Fixed XML DOM bug (SF #660611).
1404   - Removed the ``interpeted`` element class and added
1405     ``title_reference``, ``abbreviation``, ``acronym``.
1406   - Made substitutions case-sensitive-but-forgiving; moved some code
1407     from the parser.
1408   - Fixed Unicode bug on element attributes (report: William Dode).
1410 * docutils/optik.py: Removed from project; replaced with
1411   extras/optparse.py and extras/textwrap.py.  These will be installed
1412   only if they're not already present in the Python installation.
1414 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1415   only if it's not already present in the Python installation.
1417 * docutils/statemachine.py:
1419   - Factored out ``State.add_initial_transitions()`` so it can be
1420     extended.
1421   - Converted whitespace-specific "blank" and "indent" transitions
1422     from special-case code to ordinary transitions: removed
1423     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1424     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1425     ``ws_initial_transitions`` attributes.
1426   - Removed ``State.match_transition()`` after merging it into
1427     ``.check_line()``.
1428   - Added ``StateCorrection`` exception.
1429   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1430     (moved ``TransitionCorrection`` support there too.)
1431   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1432     ``EOFError`` instead of ``IndexError``.
1433   - Added ``State.no_match`` method.
1434   - Added support for the Observer pattern, triggered by input line
1435     changes.
1436   - Added ``strip_top`` parameter to
1437     ``StateMachineWS.get_first_known_indented``.
1438   - Made ``context`` a parameter to ``StateMachine.run()``.
1439   - Added ``ViewList`` & ``StringList`` classes;
1440     ``extract_indented()`` becomes ``StringList.get_indented()``.
1441   - Added ``StateMachine.insert_input()``.
1442   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1443     thanks to) Fred Drake.
1445 * docutils/utils.py:
1447   - Added a ``source`` attribute to Reporter instances and
1448     ``system_message`` elements.
1449   - Added an observer pattern to ``utils.Reporter`` to keep track of
1450     system messages.
1451   - Fixed bugs in ``relative_path()``.
1452   - Added support for improved diagnostics.
1453   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1454   - Added support for encoding Reporter stderr output, and encoding
1455     error handlers.
1456   - Reporter keeps track of the highest level system message yet
1457     generated.
1459 * docutils/languages: Fixed bibliographic field language lookups.
1461 * docutils/languages/es.py: Added to project; Spanish mappings by
1462   Marcelo Huerta San Martin.
1464 * docutils/languages/fr.py: Added to project; French mappings by
1465   Stefane Fermigier.
1467 * docutils/languages/it.py: Added to project; Italian mappings by
1468   Nicola Larosa.
1470 * docutils/languages/sk.py: Added to project; Slovak mappings by
1471   Miroslav Vasko.
1473 * docutils/parser/__init__.py:
1475   - Added ``Parser.finish_parse()`` method.
1477 * docutils/parser/rst/__init__.py:
1479   - Added options: "--pep-references", "--rfc-references",
1480     "--tab-width", "--trim-footnote-reference-space".
1482 * docutils/parsers/rst/states.py:
1484   - Changed "title under/overline too short" system messages from INFO
1485     to WARNING, and fixed its insertion location.
1486   - Fixed enumerated list item parsing to allow paragraphs & section
1487     titles to begin with enumerators.
1488   - Converted system messages to use the new "line" attribute.
1489   - Fixed a substitution reference edge case.
1490   - Added support for "--pep-references" and "--rfc-references"
1491     options; reworked ``Inliner`` code to make customization easier.
1492   - Removed field argument parsing.
1493   - Added support for short section title over/underlines.
1494   - Fixed "simple reference name" regexp to ignore text like
1495     "object.__method__"; not an anonymous reference.
1496   - Added support for improved diagnostics.
1497   - Reworked directive API, based on Dethe Elza's contribution.  Added
1498     ``Body.parse_directive()``, ``.parse_directive_options()``,
1499     ``.parse_directive_arguments()`` methods.
1500   - Added ``ExtensionOptions`` class, to parse directive options
1501     without parsing field bodies.  Factored
1502     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1503     ``ExtensionOptions``.
1504   - Improved definition list term/classifier parsing.
1505   - Added warnings for unknown directives.
1506   - Renamed ``Stuff`` to ``Struct``.
1507   - Now flagged as errors: transitions at the beginning or end of
1508     sections, empty sections (except title), and empty documents.
1509   - Updated for ``statemachine.StringList``.
1510   - Enabled recognition of schemeless email addresses in targets.
1511   - Added support for embedded URIs in hyperlink references.
1512   - Added backslash-escapes to inline markup end-string suffix.
1513   - Added support for correct interpreted text processing.
1514   - Fixed nested title parsing (topic, sidebar directives).
1515   - Added special processing of backslash-escaped whitespace (idea
1516     from David Abrahams).
1517   - Made substitutions case-sensitive-but-forgiving; moved some code
1518     to ``docutils.nodes``.
1519   - Added support for block quote attributions.
1520   - Added a kludge to work-around a conflict between the bubble-up
1521     parser strategy and short titles (<= 3 char-long over- &
1522     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1523     titles" submitted by Jason Diamond.
1524   - Added explicit interpreted text roles for standard inline markup:
1525     "emphasis", "strong", "literal".
1526   - Implemented "superscript" and "subscript" interpreted text roles.
1527   - Added initial support for "abbreviation" and "acronym" roles;
1528     incomplete.
1529   - Added support for "--trim-footnote-reference-space" option.
1530   - Optional space before colons in directives & hyperlink targets.
1532 * docutils/parsers/rst/tableparser.py:
1534   - Fixed a bug that was producing unwanted empty rows in "simple"
1535     tables.
1536   - Detect bad column spans in "simple" tables.
1538 * docutils/parsers/rst/directives: Updated all directive functions to
1539   new API.
1541 * docutils/parsers/rst/directives/__init__.py:
1543   - Added ``flag()``, ``unchanged()``, ``path()``,
1544     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1545     directive option helper functions.
1546   - Added warnings for unknown directives.
1547   - Return ``None`` for missing directives.
1548   - Added ``register_directive()``, thanks to William Dode and Paul
1549     Moore.
1551 * docutils/parsers/rst/directives/admonitions.py:
1553   - Added "admonition" directive.
1555 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1556   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1557   "parsed-literal", "rubric", "epigraph", "highlights" and
1558   "pull-quote" directives.
1560 * docutils/parsers/rst/directives/images.py:
1562   - Added an "align" attribute to the "image" & "figure" directives
1563     (by Adam Chodorowski).
1564   - Added "class" option to "image", and "figclass" to "figure".
1566 * docutils/parsers/rst/directives/misc.py:
1568   - Added "include", "raw", and "replace" directives, courtesy of
1569     Dethe Elza.
1570   - Added "unicode" and "class" directives.
1572 * docutils/parsers/rst/directives/parts.py:
1574   - Added the "sectnum" directive; by Dmitry Jemerov.
1575   - Added "class" option to "contents" directive.
1577 * docutils/parsers/rst/directives/references.py: Added to project.
1578   Contains the "target-notes" directive.
1580 * docutils/parsers/rst/languages/__init__.py:
1582   - Return ``None`` from get_language() for missing language modules.
1584 * docutils/parsers/rst/languages/de.py: Added to project; German
1585   mappings by Engelbert Gruber.
1587 * docutils/parsers/rst/languages/en.py:
1589   - Added interpreted text roles mapping.
1591 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1592   mappings by Marcelo Huerta San Martin.
1594 * docutils/parsers/rst/languages/fr.py: Added to project; French
1595   mappings by William Dode.
1597 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1598   mappings by Nicola Larosa.
1600 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1601   mappings by Miroslav Vasko.
1603 * docutils/readers/__init__.py:
1605   - Added support for the observer pattern from ``utils.Reporter``, in
1606     ``Reader.parse`` and ``Reader.transform``.
1607   - Removed ``Reader.transform()`` method.
1608   - Added default parameter values to ``Reader.__init__()`` to make
1609     instantiation easier.
1610   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1612 * docutils/readers/pep.py:
1614   - Added the ``peps.TargetNotes`` transform to the Reader.
1615   - Removed PEP & RFC reference detection code; moved to
1616     parsers/rst/states.py as options (enabled here by default).
1617   - Added support for pre-acceptance PEPs (no PEP number yet).
1618   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1619     easy subclassing.
1621 * docutils/readers/python: Python Source Reader subpackage added to
1622   project, including preliminary versions of:
1624   - __init__.py
1625   - moduleparser.py: Parser for Python modules.
1627 * docutils/transforms/__init__.py:
1629   - Added ``Transformer`` class and completed transform reform.
1630   - Added unknown_reference_resolvers list for each transformer. This list holds
1631     the list of functions provided by each component of the transformer that
1632     help resolve references.
1634 * docutils/transforms/frontmatter.py:
1636   - Improved support for generic fields.
1637   - Fixed bibliographic field language lookups.
1639 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1640   transforms.
1642 * docutils/transforms/parts.py:
1644   - Moved the "id" attribute from TOC list items to the references
1645     (``Contents.build_contents()``).
1646   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1647   - Added "class" attribute support to ``Contents``.
1649 * docutils/transforms/peps.py:
1651   - Added ``mask_email()`` function, updating to pep2html.py's
1652     functionality.
1653   - Linked "Content-Type: text/x-rst" to PEP 12.
1654   - Added the ``TargetNotes`` PEP-specific transform.
1655   - Added ``TargetNotes.cleanup_callback``.
1656   - Added title check to ``Headers``.
1658 * docutils/transforms/references.py:
1660   - Added the ``TargetNotes`` generic transform.
1661   - Split ``Hyperlinks`` into multiple transforms.
1662   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1663   - Added check for circular indirect references.
1664   - Made substitutions case-sensitive-but-forgiving.
1666 * docutils/transforms/universal.py:
1668   - Added support for the "--expose-internal-attributes" option.
1669   - Removed ``Pending`` transform classes & data.
1671 * docutils/writers/__init__.py:
1673   - Removed ``Writer.transform()`` method.
1675 * docutils/writers/docutils-xml.py:
1677   - Added XML and doctype declarations.
1678   - Added "--no-doctype" and "--no-xml-declaration" options.
1680 * docutils/writers/html4css1.py:
1682   - "name" attributes only on these tags: a, applet, form, frame,
1683     iframe, img, map.
1684   - Added "name" attribute to <a> in section titles for Netscape 4
1685     support (bug report: Pearu Peterson).
1686   - Fixed targets (names) on footnote, citation, topic title,
1687     problematic, and system_message nodes (for Netscape 4).
1688   - Changed field names from "<td>" to "<th>".
1689   - Added "@" to "&#64;" encoding to thwart address harvesters.
1690   - Improved the vertical whitespace optimization; ignore "invisible"
1691     nodes (targets, comments, etc.).
1692   - Improved inline literals with ``<span class="pre">`` around chunks
1693     of text and ``&nbsp;`` for runs of spaces.
1694   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1695     ``self.docinfo`` segments.
1696   - Added support for "line_block", "address" elements.
1697   - Improved backlinks (footnotes & system_messages).
1698   - Improved system_message output.
1699   - Redefined "--stylesheet" as containing an invariant URL, used
1700     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1701     working directory.
1702   - Added "--footnote-references" option (superscript or brackets).
1703   - Added "--compact-lists" and "--no-compact-lists" options.
1704   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1705     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1706   - Improved field list rendering.
1707   - Added Docutils version to "generator" meta tag.
1708   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1709   - Improved layout of <pre> HTML source.
1710   - Fixed attribute typo on <colspec>.
1711   - Refined XML prologue.
1712   - Support for no stylesheet.
1713   - Removed "interpreted" element support.
1714   - Added support for "title_reference", "sidebar", "attribution",
1715     "rubric", and generic "admonition" elements.
1716   - Added "--attribution" option.
1717   - Added support for "inline", "subscript", "superscript" elements.
1718   - Added initial support for "abbreviation" and "acronym";
1719     incomplete.
1721 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1722   (from the sandbox).
1724   - Added french.
1725   - Double quotes in literal blocks (special treatment for de/ngerman).
1726   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1727   - Added  "--attribution" option.
1728   - Right align attributions.
1730 * docutils/writers/pep_html.py:
1732   - Parameterized output encoding in PEP template.
1733   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1734   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1735     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1736     working directory.
1737   - Added an override on the "--footnote-references" option.
1738   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1739   - Added Docutils version to "generator" meta tag.
1740   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1742 * docs/tools.txt:
1744   - Added a "silent" setting for ``buildhtml.py``.
1745   - Added a "Getting Help" section.
1746   - Rearranged the structure.
1747   - Kept up to date, with new settings, command-line options etc.
1748   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1749   - Converted settings table into a definition list.
1751 * docs/rst/quickstart.txt:
1753   - Added a table of contents.
1754   - Added feedback information.
1755   - Added mention of minimum section title underline lengths.
1756   - Removed the 4-character minimum for section title underlines.
1758 * docs/rst/quickref.html:
1760   - Added a "Getting Help" section.
1761   - Added a style to make section title backlinks more subtle.
1762   - Added mention of minimum section title underline lengths.
1763   - Removed the 4-character minimum for section title underlines.
1765 * extras: Directory added to project; contains third-party modules
1766   that Docutils depends on (optparse, textwrap, roman).  These are
1767   only installed if they're not already present.
1769 * licenses: Directory added to project; contains copies of license
1770   files for non-public-domain files.
1772 * spec/doctree.txt:
1774   - Changed the focus.  It's about DTD elements:  structural
1775     relationships, semantics, and external (public) attributes.  Not
1776     about the element class library.
1777   - Moved some implementation-specific stuff into ``docutils.nodes``
1778     docstrings.
1779   - Wrote descriptions of all common attributes and parameter
1780     entities.  Filled in introductory material.
1781   - Working through the element descriptions: 55 down, 37 to go.
1782   - Removed "Representation of Horizontal Rules" to
1783     spec/rst/alternatives.txt.
1785 * spec/docutils.dtd:
1787   - Added "generated" inline element.
1788   - Added "line_block" body element.
1789   - Added "auto" attribute to "title".
1790   - Changed content models of "literal_block" and "doctest_block" to
1791     ``%text.model``.
1792   - Added ``%number;`` attribute type parameter entity.
1793   - Changed ``%structural.elements;`` to ``%section.elements``.
1794   - Updated attribute types; made more specific.
1795   - Added "address" bibliographic element.
1796   - Added "line" attribute to ``system_message`` element.
1797   - Removed "field_argument" element; "field_name" may contain
1798     multiple words and whitespace.
1799   - Changed public identifier to docutils.sf.net.
1800   - Removed "interpreted" element; added "title_reference",
1801     "abbreviation", "acronym".
1802   - Removed "refuri" attribute from "footnote_reference" and
1803     "citation_reference".
1804   - Added "sidebar", "rubric", "attribution", "admonition",
1805     "superscript", "subscript", and "inline" elements.
1807 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1809 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1811 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1813 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1814   Dallas Mahrt.
1816 * spec/transforms.txt: Added to project.
1818 * spec/howto: Added subdirectory, for developer how-to docs.
1820 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1821   Elza, edited & extended by David Goodger.
1823 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1824   project.
1826 * spec/rst/alternatives.txt:
1828   - Added "Doctree Representation of Transitions" from
1829     spec/doctree.txt.
1830   - Updated "Inline External Targets" & closed the debate.
1831   - Added ideas for interpreted text syntax extensions.
1832   - Added "Nested Inline Markup" section.
1834 * spec/rst/directives.txt:
1836   - Added directives: "topic", "sectnum", "target-notes",
1837     "line-block", "parsed-literal", "include", "replace", "sidebar",
1838     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1839     "class".
1840   - Formalized descriptions of directive details.
1841   - Added an "align" attribute to the "image" & "figure" directives
1842     (by Adam Chodorowski).
1843   - Added "class" options to "topic", "sidebar", "line-block",
1844     "parsed-literal", "contents", and "image"; and "figclass" to
1845     "figure".
1847 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1848   interpreted text roles.
1850 * spec/rst/introduction.txt:
1852   - Added pointers to material for new users.
1854 * spec/rst/reStructuredText.txt:
1856   - Disambiguated comments (just add a newline after the "::").
1857   - Updated enumerated list description; added a discussion of the
1858     second-line validity checking.
1859   - Updated directive description.
1860   - Added a note redirecting newbies to the user docs.
1861   - Expanded description of inline markup start-strings in non-markup
1862     contexts.
1863   - Removed field arguments and made field lists a generic construct.
1864   - Removed the 4-character minimum for section title underlines.
1865   - Clarified term/classifier delimiter & inline markup ambiguity
1866     (definition lists).
1867   - Added "Embedded URIs".
1868   - Updated "Interpreted Text" section.
1869   - Added "Character-Level Inline Markup" section.
1871 * test: Continually adding & updating tests.
1873   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1874   - Moved test/test_pep/ to test/test_readers/test_pep/.
1875   - Added test/test_readers/test_python/.
1876   - Added test/test_writers/ (Engelbert Gruber).
1878 * tools:
1880   - Made the ``locale.setlocale()`` calls in front ends
1881     fault-tolerant.
1883 * tools/buildhtml.py:
1885   - Added "--silent" option.
1886   - Fixed bug with absolute paths & "--config".
1887   - Updated for new I/O classes.
1888   - Added some exception handling.
1889   - Separated publishers' setting defaults; prevents interference.
1890   - Updated for new ``publish_file()`` convenience function.
1892 * tools/pep-html-template:
1894   - Allow for "--embed-stylesheet".
1895   - Added Docutils version to "generator" meta tag.
1896   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1897   - Conform to XHTML spec.
1899 * tools/pep2html.py:
1901   - Made ``argv`` a parameter to ``main()``.
1902   - Added support for "Content-Type:" header & arbitrary PEP formats.
1903   - Linked "Content-Type: text/plain" to PEP 9.
1904   - Files skipped (due to an error) are not pushed onto the server.
1905   - Updated for new I/O classes.
1906   - Added ``check_requirements()`` & ``pep_type_error()``.
1907   - Added some exception handling.
1908   - Updated for new ``publish_string()`` convenience function.
1909   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1911 * tools/quicktest.py:
1913   - Added "-V"/"--version" option.
1915 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1917 * tools/unicode2rstsubs.py: Added to project.  Produces character
1918   entity files (reSructuredText substitutions) from the MathML master
1919   unicode.xml file.
1921 * tools/editors: Support code for editors, added to project.  Contains
1922   ``emacs/restructuredtext.el``.
1924 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1926   - Added style for chunks of inline literals.
1927   - Removed margin for first child of table cells.
1928   - Right-aligned field list names.
1929   - Support for auto-numbered section titles in TOCs.
1930   - Increased the size of inline literals (<tt>) in titles.
1931   - Restored the light gray background for inline literals.
1932   - Added support for "line_block" elements.
1933   - Added style for "address" elements.
1934   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1935   - Improved field list rendering.
1936   - Vertical whitespace improvements.
1937   - Removed "a.target" style.
1939 * tools/stylesheets/pep.css:
1941   - Fixed nested section margins.
1942   - Other changes parallel those of ``../default.css``.
1945 Release 0.2 (2002-07-31)
1946 ========================
1948 General:
1950 - The word "component" was being used ambiguously.  From now on,
1951   "component" will be used to mean "Docutils component", as in Reader,
1952   Writer, Parser, or Transform.  Portions of documents (Table of
1953   Contents, sections, etc.)  will be called "document parts".
1954 - Did a grand renaming: a lot of ``verylongnames`` became
1955   ``very_long_names``.
1956 - Cleaned up imports: no more relative package imports or
1957   comma-separated lists of top-level modules.
1958 - Added support for an option values object which carries default
1959   settings and overrides (from command-line options and library use).
1960 - Added internal Unicode support, and support for both input and
1961   output encodings.
1962 - Added support for the ``docutils.io.IO`` class & subclasses.
1964 Specific:
1966 * docutils/__init__.py:
1968   - Added ``ApplicationError`` and ``DataError``, for use throughout
1969     the package.
1970   - Added ``Component`` base class for Docutils components; implements
1971     the ``supports`` method.
1972   - Added ``__version__`` (thus, ``docutils.__version__``).
1974 * docutils/core.py:
1976   - Removed many keyword parameters to ``Publisher.__init__()`` and
1977     ``publish()``; bundled into an option values object.  Added
1978     "argv", "usage", "description", and "option_spec" parameters for
1979     command-line support.
1980   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1981     methods.
1982   - Reworked I/O model for ``docutils.io`` wrappers.
1983   - Updated ``Publisher.set_options()``; now returns option values
1984     object.
1985   - Added support for configuration files (/etc/docutils.conf,
1986     ./docutils.conf, ~/.docutils).
1987   - Added ``Publisher.setup_option_parser()``.
1988   - Added default usage message and description.
1990 * docutils/frontend.py: Added to project; support for front-end
1991   (command-line) scripts.  Option specifications may be augmented by
1992   components.  Requires Optik (http://optik.sf.net/) for option
1993   processing (installed locally as docutils/optik.py).
1995 * docutils/io.py: Added to project; uniform API for a variety of input
1996   output mechanisms.
1998 * docutils/nodes.py:
2000   - Added ``TreeCopyVisitor`` class.
2001   - Added a ``copy`` method to ``Node`` and subclasses.
2002   - Added a ``SkipDeparture`` exception for visitors.
2003   - Renamed ``TreePruningException`` from ``VisitorException``.
2004   - Added docstrings to ``TreePruningException``, subclasses, and
2005     ``Nodes.walk()``.
2006   - Improved docstrings.
2007   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2008   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2009     imports.
2010   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2011     ``PreDecorative`` mixin.
2012   - Reworked the name/id bookkeeping; to ``document``, removed
2013     ``explicit_targets`` and ``implicit_targets`` attributes, added
2014     ``nametypes`` attribute and ``set_name_id_map`` method.
2015   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2016     traversals.
2017   - Added ``document.has_name()`` method.
2018   - Fixed DOM generation for list-attributes.
2019   - Added category class ``Labeled`` (used by footnotes & citations).
2020   - Added ``Element.set_class()`` method (sets "class" attribute).
2022 * docutils/optik.py: Added to project.  Combined from the Optik
2023   package, with added option groups and other modifications.  The use
2024   of this module is probably only temporary.
2026 * docutils/statemachine.py:
2028   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2029   - Added underscores to improve many awkward names.
2030   - In ``string2lines()``, changed whitespace normalizing translation
2031     table to regexp; restores Python 2.0 compatibility with Unicode.
2033 * docutils/urischemes.py:
2035   - Filled in some descriptions.
2036   - Added "shttp" scheme.
2038 * docutils/utils.py:
2040   - Added ``clean_rcs_keywords`` function (moved from
2041     docutils/transforms/frontmatter.py
2042     ``DocInfo.filter_rcs_keywords``).
2043   - Added underscores to improve many awkward names.
2044   - Changed names of Reporter's thresholds:
2045     warning_level -> report_level; error_level -> halt_level.
2046   - Moved ``utils.id()`` to ``nodes.make_id()``.
2047   - Added ``relative_path(source, target)``.
2049 * docutils/languages/de.py: German mappings; added to project.  Thanks
2050   to Gunnar Schwant for the translations.
2052 * docutils/languages/en.py: Added "Dedication" bibliographic field
2053   mappings.
2055 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2056   Chodorowski.
2058 * docutils/parsers/rst/states.py:
2060   - Added underscores to improve many awkward names.
2061   - Added RFC-2822 header support.
2062   - Extracted the inline parsing code from ``RSTState`` to a separate
2063     class, ``Inliner``, which will allow easy subclassing.
2064   - Made local bindings for ``memo`` container & often-used contents
2065     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2066   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2067   - Added ``MarkupMismatch`` exception; for late corrections.
2068   - Added ``-/:`` characters to inline markup's start string prefix,
2069     ``/`` to end string suffix.
2070   - Fixed a footnote bug.
2071   - Fixed a bug with literal blocks.
2072   - Applied patch from Simon Budig: simplified regexps with symbolic
2073     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2074   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2075   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2076   - Allowed non-ASCII in "simple names" (directive names, field names,
2077     references, etc.).
2078   - Converted ``Inliner.patterns.initial`` to be dynamically built
2079     from parts with ``build_regexp()`` function.
2080   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2081   - Updated docstrings.
2082   - Changed "table" to "grid_table"; added "simple_table" support.
2084 * docutils/parsers/rst/tableparser.py:
2086   - Changed ``TableParser`` to ``GridTableParser``.
2087   - Added ``SimpleTableParser``.
2088   - Refactored naming.
2090 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2091   a fallback language for directive names.
2093 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2094   directive to use a ``pending`` element, used only by HTML writers.
2096 * docutils/parsers/rst/directives/parts.py: Renamed from
2097   components.py.
2099   - Added "backlinks" attribute to "contents" directive.
2101 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2102   project by Adam Chodorowski.
2104 * docutils/readers/__init__.py: Gave Readers more control over
2105   choosing and instantiating Parsers.
2107 * docutils/readers/pep.py: Added to project; for PEP processing.
2109 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2110   requires a ``component`` parameter.
2112 * docutils/transforms/components.py: Added to project; transforms
2113   related to Docutils components.
2115 * docutils/transforms/frontmatter.py:
2117   - In ``DocInfo.extract_authors``, check for a single "author" in an
2118     "authors" group, and convert it to a single "author" element.
2119   - Added support for "Dedication" and generic bibliographic fields.
2121 * docutils/transforms/peps.py: Added to project; PEP-specific.
2123 * docutils/transforms/parts.py: Renamed from old components.py.
2125   - Added filter for `Contents`, to use alt-text for inline images,
2126     and to remove inline markup that doesn't make sense in the ToC.
2127   - Added "name" attribute to TOC topic depending on its title.
2128   - Added support for optional TOC backlinks.
2130 * docutils/transforms/references.py: Fixed indirect target resolution
2131   in ``Hyperlinks`` transform.
2133 * docutils/transforms/universal.py:
2135   - Changed ``Messages`` transform to properly filter out system
2136     messages below the warning threshold.
2137   - Added ``Decorations`` transform (support for ``--generator``,
2138     ``--date``, ``--time``, ``--source-link`` options).
2140 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2141   Engelbert Gruber's PDF writer.
2143 * docutils/writers/html4css1.py:
2145   - Made XHTML-compatible (switched to lowercase element & attribute
2146     names; empty tag format).
2147   - Escape double-dashes in comment text.
2148   - Improved boilerplate & modularity of output.
2149   - Exposed modular output in Writer class.
2150   - Added a "generator" meta tag to <head>.
2151   - Added support for the ``--stylesheet`` option.
2152   - Added support for ``decoration``, ``header``, and ``footer``
2153     elements.
2154   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2155     translation table to regexp; restores Python 2.0 compatibility
2156     with Unicode.
2157   - Added the translator class as instance variable to the Writer, to
2158     make it easily subclassable.
2159   - Improved option list spacing (thanks to Richard Jones).
2160   - Modified field list output.
2161   - Added backlinks to footnotes & citations.
2162   - Added percentage widths to "<col>" tags (from colspec).
2163   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2164     "<span>" changed to "<var>".
2165   - Inline literals: "<code>" changed to "<tt>".
2166   - Many changes to optimize vertical space: compact simple lists etc.
2167   - Add a command-line options & directive attributes to control TOC
2168     and footnote/citation backlinks.
2169   - Added support for optional footnote/citation backlinks.
2170   - Added support for generic bibliographic fields.
2171   - Identify backrefs.
2172   - Relative URLs for stylesheet links.
2174 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2175   PEPs (subclass of ``html4css1.Writer``).
2177 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2179 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2180   of the Docutils internal doctree in XML.
2182 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2184 * spec/doctree.txt:
2186   - Changed the title to "The Docutils Document Tree".
2187   - Added "Hyperlink Bookkeeping" section.
2189 * spec/docutils.dtd:
2191   - Added ``decoration``, ``header``, and ``footer`` elements.
2192   - Brought ``interpreted`` element in line with the parser: changed
2193     attribute "type" to "role", added "position".
2194   - Added support for generic bibliographic fields.
2196 * spec/notes.txt: Continual updates.  Added "Project Policies".
2198 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2199   section.
2201 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2203 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2204   mailing list discussions.
2206 * spec/pep-0287.txt:
2208   - Renamed to "reStructuredText Docstring Format".
2209   - Minor edits.
2210   - Reworked Q&A as an enumerated list.
2211   - Converted to reStructuredText format.
2213 * spec/pysource.dtd:
2215   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2217 * spec/pysource.txt: Removed from project.  Moved much of its contents
2218   to pep-0258.txt.
2220 * spec/rst/alternatives.txt:
2222   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2223   - Added "Inline External Targets" section.
2225 * spec/rst/directives.txt:
2227   - Added "backlinks" attribute to "contents" directive.
2229 * spec/rst/problems.txt:
2231   - Updated the Enumerated List Markup discussion.
2232   - Added new alternative table markup syntaxes.
2234 * spec/rst/reStructuredText.txt:
2236   - Clarified field list usage.
2237   - Updated enumerated list description.
2238   - Clarified purpose of directives.
2239   - Added ``-/:`` characters to inline markup's start string prefix,
2240     ``/`` to end string suffix.
2241   - Updated "Authors" bibliographic field behavior.
2242   - Changed "inline hyperlink targets" to "inline internal targets".
2243   - Added "simple table" syntax to supplement the existing but
2244     newly-renamed "grid tables".
2245   - Added cautions for anonymous hyperlink use.
2246   - Added "Dedication" and generic bibliographic fields.
2248 * test: Made test modules standalone (subdirectories became packages).
2250 * test/DocutilsTestSupport.py:
2252   - Added support for PEP extensions to reStructuredText.
2253   - Added support for simple tables.
2254   - Refactored naming.
2256 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2258   - Now supports true packages containing test modules
2259     (``__init__.py`` files required); fixes duplicate module name bug.
2261 * test/test_pep/: Subpackage added to project; PEP testing.
2263 * test/test_rst/test_SimpleTableParser.py: Added to project.
2265 * tools:
2267   - Updated html.py and publish.py front-end tools to use the new
2268     command-line processing facilities of ``docutils.frontend``
2269     (exposed in ``docutils.core.Publisher``), reducing each to just a
2270     few lines of code.
2271   - Added ``locale.setlocale()`` calls to front-end tools.
2273 * tools/buildhtml.py: Added to project; batch-generates .html from all
2274   the .txt files in directories and subdirectories.
2276 * tools/default.css:
2278   - Added support for ``header`` and ``footer`` elements.
2279   - Added styles for "Dedication" topics (biblio fields).
2281 * tools/docutils.conf: A configuration file; added to project.
2283 * tools/docutils-xml.py: Added to project.
2285 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2287 * tools/pep-html-template: Added to project.
2289 * tools/pep2html.py: Added to project from Python (nondist/peps).
2290   Added support for Docutils (reStructuredText PEPs).
2292 * tools/quicktest.py:
2294   - Added the ``--attributes`` option, hacked a bit.
2295   - Added a second command-line argument (output file); cleaned up.
2297 * tools/stylesheets/: Subdirectory added to project.
2299 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2302 Release 0.1 (2002-04-20)
2303 ========================
2305 This is the first release of Docutils, merged from the now inactive
2306 reStructuredText__ and `Docstring Processing System`__ projects.  For
2307 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2308 `DPS HISTORY`__ files.
2310 __ http://structuredtext.sourceforge.net/
2311 __ http://docstring.sourceforge.net/
2312 __ http://structuredtext.sourceforge.net/HISTORY.html
2313 __ http://docstring.sourceforge.net/HISTORY.html
2315 General changes: renamed 'dps' package to 'docutils'; renamed
2316 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2317 the test suites (reStructuredText's test/test_states renamed to
2318 test/test_rst); and all modifications required to make it all work.
2320 * docutils/parsers/rst/states.py:
2322   - Improved diagnostic system messages for missing blank lines.
2323   - Fixed substitution_reference bug.
2327    Local Variables:
2328    mode: indented-text
2329    indent-tabs-mode: nil
2330    sentence-end-double-space: t
2331    fill-column: 70
2332    End: