Set ``usepackage[utf8x]{inputenc}`` for utf-8.
[docutils.git] / HISTORY.txt
blobc1c0178d625980372b2c187c598d980790584349
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   - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
113   - New option ``--use-bibtex=style,db1,db2``.
114   - New option ``--reference-label`` to allow usage of LaTeX ref for 
115     labels in section references.
116   - Add a label after every section to support sectionnumbers as reference
117     labels.
118   - Fix: bug# 1605376 rst2latex: bad options group list
119   - Remove inactive code for use_optionlist_for_option_list.
120   - Remove latex comments from option_list output.
121   - Fix: bug# 1612270 double qoutes in italian literal.
122   - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target. 
123   - Add option --use-latex-abstract.
124   - Image width unit ``px`` is translated to ``pt``.
125   - Add image height support.
126   - Fix: image width ``70%`` is converted ``0.700\linewidth``.
127     bug #1457388
128   - Fix: Do not escape underscores in citation reference labels if
129     use-latex-citations is set.
130   - Use centering instead of center for figure contents, to avoid vertical
131     space.
132   - Recognize table class: borderless, nolines, booktabs, standard.
133   - Fix: Renaming contents section does not work with latex writer; SF
134     bug #1487405.
135   - Applied patch for custom roles with classes from Edward Loper.
136   - Fixed bug that caused crashes with more than 256 lists.
138 * docutils/writers/pep_html/__init__.py:
140   - Changed to support new python.org website structure and
141     pep2pyramid.py.
143 * docs/howto/security.txt: "Deploying Docutils Securely", added to
144   project.
146 * tools/editors/emacs/rst.el:
148   - Changed license to "GPL".
149   - Added ``rst-straighten-decorations`` function.
150   - The ``compile`` module is now always loaded.
151   - Added ``rst-toggle-line-block`` function.
152   - Headings consisting only of non-ASCII characters are now
153     recognized by ``rst-toc`` and ``rst-adjust``.
154   - Added font-lock support for multi-line comments where the first
155     comment line is empty.
156   - Added ``(require 'font-lock)``.
158 * setup.py:
160   - Provide descriptive error message if distutils is missing.
163 Release 0.4 (2006-01-09)
164 ========================
166 * General:
168   - Updated the project policies for trunk/branch development &
169     version numbering.
171 * docutils/__init__.py:
173   - Added ``__version_details__`` attribute to describe code source
174     (repository/snapshot/release).
175   - Replaced ``default_transforms`` attribute of TransformSpec with
176     ``get_transforms()`` method.
178 * docutils/core.py:
180   - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
181     functions, for document tree extraction and reprocessing.
183 * docutils/io.py:
185   - Added ``DocTreeInput`` class, for reprocessing existing documents.
186   - Added support for non-Unicode (e.g. binary) writer output.
188 * docutils/nodes.py:
190   - Re-introduced ``Targetable.indirect_reference_name``, for
191     MoinMoin/reST compatibility (removed in r3124/r3129).
192   - Added ``serial_escape`` function; escapes string values that are
193     elements of a list, for serialization.  Modified Docutils-XML
194     writing (``Element._dom_node``) and pseudo-XML writing
195     (``Element.starttag``) to use ``serial_escape``.
196   - Added ``Node.deepcopy()`` method.
197   - Removed the internal lists ``document.substitution_refs``,
198     ``document.anonymous_refs``, and ``document.anonymous_targets``.
199   - Added a "container" element.
200   - Fixed bug where values of list-valued attributes of elements
201     originating from custom interpreted text roles (i.e., with custom
202     classes) were being shared between element instances.  Reported by
203     Shmuel Zeigerman.
205 * docutils/statemachine.py:
207   - Added trailing whitespace stripping to ``string2lines()``.
208   - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
209     Asian double-width character support.
211 * docutils/utils.py:
213   - Added ``east_asian_column_width()`` for double-width character
214     support.
216 * docutils/languages/ja.py: Added to project: Japanese mappings by
217   Hisashi Morita.
219 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
220   mappings by Panjunyong.
222 * docutils/parsers/null.py: Added to project; a do-nothing parser.
224 * docutils/parsers/rst/__init__.py:
226   - Added validator to tab_width setting, with test.  Closes SF bug
227     #1212515, report from Wu Wei.
229 * docutils/parsers/rst/states.py:
231   - Fixed bug with escaped colons indicating a literal block.
232   - Fixed bug with enumerated lists (SF#1254145).
233   - Backslash-escaped colons inside of field names are now allowed.
234   - Targets (implicit and explicit), anonymous hyperlink references
235     and auto-numbered footnote references inside of substitution
236     definitions are now disallowed.
237   - Fixed bug: list items with blank first lines.
238   - Fixed bug: block quote attributions with indented second lines.
239   - Added East Asian double-width character support (Python 2.4 only).
241 * docutils/parsers/rst/tableparser.py:
243   - Added East Asian double-width character support (Python 2.4 only).
245 * docutils/parsers/rst/directives/body.py:
247   - Added the "container" directive.
249 * docutils/parsers/rst/directives/misc.py:
251   - Added the "default-role", "title", and "date" directives.
252   - Added standard data file syntax to the "include" directive.
253   - Added support for "class" directive content.
255 * docutils/parsers/rst/directives/images.py:
257   - Added ``indirect_reference_name`` support for images with a target
258     option.
259   - Added support for image width and height units.
260   - Fixed bug with image "target" options.
262 * docutils/parsers/rst/directives/references.py:
264   - Added "class" attribute to "target-notes" directive, for
265     footnote_reference classes.
267 * docutils/parsers/rst/include/: Directory added to project; contains
268   standard data files for the "include" directive.  Initial contents:
269   character entity substitution definition sets, and a set of
270   definitions for S5/HTML presentations.
272 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
273   mappings by David Goodger.
274   
275 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
276   Simplified Chinese mappings by Panjunyong.
278 * docutils/readers/__init__.py:
280   - Added universal.Decorations and universal.ExposeInternals
281     transforms as default transforms for all readers.
282   - Added ``ReReader`` base class for readers that reread an existing
283     document tree.
285 * docutils/readers/doctree.py: Added to project; a reader for existing
286   document trees.
288 * docutils/transforms/frontmatter.py:
290   - Fixed the DocInfo transform to handle SVN-style expansion of the
291     "Date" keyword.
292   - In ``DocInfo.extract_authors``, treat the contents of "authors"
293     fields uniformly.
295 * docutils/transforms/misc.py:
297   - Added misc.Transitions transform, extracted from
298     universal.FinalChecks.
300 * docutils/transforms/references.py:
302   - Added references.DanglingReferences transform, extracted from
303     universal.FinalChecks.
304   - Fixed bug with doubly-indirect substitutions.
305   - Added footnote_reference classes attribute to "TargetNotes".
306   - Fixed bug with circular substitution definitions that put Docutils
307     into an infinite loop.
309 * docutils/transforms/universal.py:
311   - Added universal.ExposeInternals transform, extracted from
312     universal.FinalChecks.
313   - Removed universal.FinalChecks transform (logic has been moved to
314     several new transforms).
315   - Fixed bug with the "expose_internals" setting and Text nodes
316     (exposed by the "rawsource" internal attribute).
317   - Added the universal.StripComments transform, implementation of the
318     "strip_comments" setting.
320 * docutils/transforms/writer_aux.py: Added to project; auxiliary
321   transforms for writers.
323   - Added ``Compound`` transform, which flattens compound paragraphs.
325 * docutils/writers/: Several writer modules (html4css1.py) were
326   converted into packages.  Support modules and data files have been
327   moved into the packages.  The stylesheets for the HTML writers are
328   now installed along with the code, the code knows where to find
329   them, and the default is to use them (actually, to embed them).
330   Some adjustments to configuration files may be necessary.  The
331   easiest way to obtain the new default behavior is to remove all
332   settings whose name includes "stylesheet".
334 * docutils/writers/__init__.py:
336   - Added universal.Messages and universal.FilterMessages transforms
337     as default transforms for all writers.
338   - Added ``UnfilteredWriter`` base class for writers that pass the
339     document tree on unchanged.
341 * docutils/writers/docutils_xml.py:
343   - Made ``xmlcharrefreplace`` the default output encoding error
344     handler.
346 * docutils/writers/html4css1/: 
348   - Added support for image width and height units.
349   - Made ``xmlcharrefreplace`` the default output encoding error
350     handler.
351   - Made ``--embed-stylesheet`` the default rather than
352     ``--link-stylesheet``.
353   - Moved "id" attribute from container (section etc.) to title's <a>
354     tag, to be on the same tag as "name".
355     (!!! To be reverted in Docutils 0.5.)
356   - Added vertical space between fields of field lists.
357   - Added ``--compact-field-lists`` option to remove vertical space in
358     simple field lists.
359   - Made cloaking of email addresses with ``--cloak-email-addresses``
360     less obtrusive.
361   - Fixed support for centered images.
362   - Added support for class="compact" & class="open" lists.
364 * docutils/writers/latex2e/:
366   - Underscores in citekeys are no longer escaped.
368 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
369   mapping of Unicode characters to LaTeX equivalents.
371 * docutils/writers/s5_html/: Package added to project; writer for
372   S5/HTML slide shows.
374 * docs/dev/distributing.txt: Added to project; guide for distributors
375   (package maintainers).
377 * docs/dev/hacking.txt: Added to project; guide for developers.
379 * docs/ref/doctree.txt:
381   - Updated for plural attributes "classes", "ids", "names",
382     "dupnames".
383   - Added the "container" element.
385 * docs/ref/docutils.dtd:
387   - Updated for plural attributes "classes", "ids", "names",
388     "dupnames".
390 * docs/user/emacs.txt: Added to project; a document about Emacs
391   support for reStructuredText and Docutils.
393 * docs/user/links.txt: Added to project; lists of Docutils-related
394   links.
396 * docs/user/mailing-lists.txt: Added to project; information about
397   Docutils-related mailing lists and how to access them.
399 * docs/user/slide-shows.txt: Added to project; example of and docs for
400   the S5/HTML writer (``rst2s5.py`` front end).
402 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
403   Files", added to project.
405 * test/coverage.sh: Added to project; test coverage script.
407 * test/DocutilsTestSupport.py:
409   - Added support for specifying runtime settings at the suite level.
411 * test/test_functional.py:
413   - Added the ``clear_output_directory`` function.
414   - Added support for ``_test_more`` functions in functional test
415     config files.
417 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
419 * tools/rstpep2html.py: Renamed from pep.py.
421 * tools/dev/create_unimap.py: Added to project; script to create the
422   docutils/writers/unimap_latex.py mapping file.
424 * tools/dev/profile_docutils.py: Added to project; profiler script.
426 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
428 * tools/editors/emacs/restructuredtext.el,
429   tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
430   Removed from project; the functionality is now contained in rst.el.
432 * tools/editors/emacs/rst.el: Added to project.  Added many features
433   and fixed many bugs.  See docs/user/emacs.txt for details.
435 * tools/stylesheets: Removed from project.  Stylesheets have been
436   renamed and moved into writer packages.
439 Release 0.3.9 (2005-05-26)
440 ==========================
442 * General:
444   - Eliminated and replaced all uses of the old string attributes
445     ``id``, ``name``, ``dupname`` and ``class`` with references to the
446     new list attributes ``ids``, ``names``, ``dupnames`` and
447     ``classes`` throughout the whole source tree.
449 * docutils/core.py:
451   - Enabled ``--dump-*`` options when ``--traceback`` specified,
452     allowing for easier debugging.
453   - In ``Publisher.publish()``, expanded the generic top-level
454     exception catching.
456 * docutils/examples.py:
458   - Added ``internals`` function for exploration.
460 * docutils/io.py:
462   - Fixed ``Input.decode`` method to apply heuristics only if no
463     encoding is explicitly given, and to provide better reporting of
464     decoding errors.
465   - The ``Input.decode`` method now removes byte order marks (BOMs)
466     from input streams.
468 * docutils/nodes.py:
470   - ``image`` element class changed to subclass of Element, not
471     TextElement (it's an empty element, and cannot contain text).
472   - Added ``attr_defaults`` dictionary for default attribute values.
473   - Added empty list as default value for the following attributes:
474     ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
475   - Added ``document.decoration`` attribute,
476     ``document.get_decoration`` method, and ``decoration.get_header``
477     & ``.get_footer`` methods.
478   - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
479     methods.
481 * docutils/utils.py:
483   - Removed ``docutils.utils.Reporter.categories``,
484     ``docutils.utils.ConditionSet``, and all references to them, to
485     simplify error reporting.
487 * docutils/languages/nl.py: Added to project; Dutch mappings by
488   Martijn Pieters.
490 * docutils/parsers/rst/__init__.py:
492   - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
494 * docutils/parsers/rst/states.py:
496   - Added check for escaped at-mark to prevent email address recognition.
497   - Fixed option lists to allow spaces inside ``<angle-bracketed option
498     arguments>``.
499   - Allowed whitespace in paths and URLs.
500   - Added auto-enumerated list items.
501   - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
502     followed by text.
503   - Added support for table stub columns.
505 * docutils/parsers/rst/directives/__init__.py:
507   - Allowed whitespace in paths (``path`` function).
508   - Added ``uri`` directive option conversion function.
510 * docutils/parsers/rst/directives/body.py:
512   - Fixed illegal context bug with "topic" directive (allowed within
513     sidebars; not within body elements).
515 * docutils/parsers/rst/directives/images.py:
517   - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
518   - Added support for the ``file_insertion_enabled`` setting in the
519     "figure" directive (disables "figwidth" option).
520   - "image" directive: added checks for valid values of "align" option,
521     depending on context.  "figure" directive: added specialized
522     "align" option and attribute on "figure" element.
523   - Made ":figwidth: image" option of "figure" directive work again.
524   - Fixed bug with reference names containing uppercase letters
525     (e.g. ``Name_``) in "target" option of "image" directive.
527 * docutils/parsers/rst/directives/misc.py:
529   - Fixed "include" and "raw" directives to catch text decoding
530     errors.
531   - Allowed whitespace in "include" & "raw" directive paths.
532   - Added support for ``file_insertion_enabled`` & ``raw_enabled``
533     settings in "include" & "raw" directives.
535 * docutils/parsers/rst/directives/parts.py:
537   - Added "header" & "footer" directives.
538   - Fixed illegal context bug with "contents" directive (topics
539     allowed within sidebars; not within body elements).
541 * docutils/parsers/rst/directives/tables.py:
543   - Added "list-table" directive.
544   - Caught empty CSV table bug.
545   - Added support for the ``file_insertion_enabled`` setting in the
546     "csv-table" directive.
547   - Added ``stub-columns`` option to "csv-table" and "list-table"
548     directives.
550 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
551   mappings by Martijn Pieters.
553 * docutils/readers/standalone.py:
555   - Added ``--section-subtitles`` and ``--no-section-subtitles``
556     options to activate or deactivate the SectSubTitle transform.
558 * docutils/transforms/frontmatter.py:
560   - Added SectSubTitle transform to promote titles of lone
561     subsections to subtitles.
563 * docutils/transforms/references.py:
565   - Fixed mislocated internal targets bug, by propagating internal
566     targets to the next node, making use of the newly added support
567     for multiple names and IDs.
568   - Fixed duplicate footnote label bug.
569   - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
570     transform.
572 * docutils/writers/html4css1.py:
574   - Fixed unencoded stylesheet reference bug (characters like "&" in
575     stylesheet references).
576   - ``target`` nodes now appear as ``span`` tags (instead of ``a``
577     tags).
578   - Added support for multiple IDs per node by creating empty ``span``
579     tags.
580   - Added the ``field_name_limit`` & ``option_limit`` settings &
581     support.
582   - Added support for table stub columns.
583   - Added support for the ``align`` attribute on ``figure`` elements.
584   - Added the ``cloak_email_addresses`` setting & support.
585   - Added ``html_prolog``, ``html_head``, ``html_body``,
586     ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
587     ``docutils.core.publish_parts``.
588   - Added support for section subtitles.
590 * docutils/writers/latex2e.py:
592   - Fixed tables starting with more than one multirow cell.
593   - Improved --use-latex-docinfo so that organization/contact/address
594     fields are lumped with the last author field and appear on the
595     titlepage.
596   - Made sure the titlepage is always shown with --use-latex-docinfo,
597     even if the document has no title.
598   - Made sure that latex doesn't fill in today's date if no date field
599     was given.
600   - Added support for section subtitles.
602 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
603   (under development).
605 * docutils/writers/null.py: Added to project; a do-nothing Writer.
607 * docs/api/publisher.txt:
609   - Added "``publish_parts`` Details" section.
611 * docutils/dev/repository.txt: Added to project; information about the
612   Docutils Subversion repository.
614 * docs/ref/docutils.dtd:
616   - Added a ``stub`` attribute to the ``colspec`` element via the
617     ``tbl.colspec.att`` parameter entity.
618   - Allowed topic elements within sidebars
619   - Added an ``align`` attribute to the ``figure`` element.
621 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
622   writer.
625 Release 0.3.7 (2004-12-24)
626 ==========================
628 * docutils/frontend.py:
630   - Added options: --input-encoding-error-handler,
631     --record-dependencies, --leave-footnote-reference-space,
632     --strict-visitor.
633   - Added command-line and config file support for "overrides" setting
634     parameter.
636 * docutils/io.py:
638   - Added support for input encoding error handler.
640 * docutils/nodes.py:
642   - Added dispatch_visit and dispatch_departure methods to
643     NodeVisitor; useful as a hook for Visitors.
644   - Changed structure of ``line_block``; added ``line``.
645   - Added ``compound`` node class.
646   - Added a mechanism for Visitors to transitionally ignore new node
647     classes.
649 * docutils/utils.py:
651   - Moved ``escape2null`` and ``unescape`` functions from
652     docutils/parsers/rst/states.py.
654 * docutils/parsers/rst/roles.py:
656   - Added "raw" role.
657   - Changed role function API: the "text" parameter now takes
658     null-escaped interpreted text content.
660 * docutils/parsers/rst/states.py:
662   - Fixed bug where a "role" directive in a nested parse would crash
663     the parser; the state machine's "language" attribute was not being
664     copied over.
665   - Added support for line block syntax.
666   - Fixed directive parsing bug: argument-less directives didn't
667     notice that arguments were present.
668   - Removed error checking for transitions.
669   - Added support for multiple classifiers in definition list items.
670   - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
671   - Changed role function API: the "text" parameter now takes
672     null-escaped interpreted text content.
673   - Empty sections and documents are allowed now.
675 * docutils/parsers/rst/directives/__init__.py:
677   - Added ``encoding`` directive option conversion function.
678   - Allow multiple class names in class_option conversion function.
680 * docutils/parsers/rst/directives/body.py:
682   - Converted the line-block directive to use the new structure.
683   - Extracted the old line-block functionality to the ``block``
684     function (still used).
685   - Added ``compound`` directive (thanks to Felix Wiemann).
687 * docutils/parsers/rst/directives/misc.py:
689   - Added "encoding" option to "include" and "raw" directives.
690   - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
691   - Allow multiple class names in the "class" directive.
693 * docutils/parsers/rst/directives/parts.py:
695   - Directive "sectnum" now accepts "prefix", "suffix", and "start"
696     options.  Thanks to Lele Gaifax.
698 * docutils/parsers/rst/directives/tables.py:
700   - Added "encoding" directive to "csv-table" directive.
701   - Added workaround for lack of Unicode support in csv.py, for
702     non-ASCII CSV input.
704 * docutils/transforms/misc.py:
706   - Fixed bug when multiple "class" directives are applied to a single
707     element.
708   - Enabled multiple format names for "raw" directive.
710 * docutils/transforms/references.py:
712   - Added support for trimming whitespace from beside substitution
713     references.
715 * docutils/transforms/universal.py:
717   - FinalChecks now checks for illegal transitions and moves
718     transitions between sections.
720 * docutils/writers/html4css1.py:
722   - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
723   - "stylesheet" and "stylesheet_path" settings are now mutually
724     exclusive.
725   - Added support for the new line_block/line structure.
726   - --footnote-references now overrides
727     --trim-footnote-reference-space, if applicable.
728   - Added support for ``compound`` elements.
729   - Enabled multiple format names for "raw" directive.
730   - ``<p>`` tags of a paragraph which is the only visible child of the
731     document node are no longer stripped.
732   - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
733     new method ``should_be_compact_paragraph()``.
734   - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
735     elements.
736   - "raw" elements are now surrounded by ``span`` or ``div`` tags in
737     the output if they have their ``class`` attribute set.
738   - The whole document is now surrounded by a ``<div
739     class="document">`` element.
740   - Body-level images are now wrapped by their own ``<div>`` elements,
741     with image classes copied to the wrapper, and for images which
742     have the ``:align:`` option set, the surrounding ``<div>`` now
743     receives a class attribute (like ``class="align-left"``).
745 * docutils/writers/latex2e.py:
747   - no newline after depart_term.
748   - Added translations for some Unicode quotes.
749   - Added option "font-encoding", made package AE the default.
750   - "stylesheet" and "stylesheet_path" settings are now mutually
751     exclusive.
752   - --footnote-references now overrides
753     --trim-footnote-reference-space, if applicable.
754   - The footnote label style now matches the footnote reference style
755     ("brackets" or "superscript").
756   - Added support for ``compound`` elements.
757   - Enabled multiple format names for "raw" directive.
759 * docs/ref/docutils.dtd:
761   - Changed structure of the ``line_block`` element; added ``line``.
762   - Added ``compound`` element.
763   - Added "ltrim" and "rtrim" attributes to
764     ``substitution_definition`` element.
765   - Enabled multiple format names for ``raw`` element.
766   - Enabled multiple classifiers in ``definition_list_item`` elements.
768 * docs/ref/rst/directives.txt
770   - Marked "line-block" as deprecated.
771   - "Class" directive now allows multiple class names.
772   - Added "Rationale for Class Attribute Value Conversion".
773   - Added warning about "raw" overuse/abuse.
775 * docs/ref/rst/restructuredtext.txt:
777   - Added syntax for line blocks.
778   - Definition list items may have multiple classifiers.
780 * docs/ref/rst/roles.txt:
782   - Added "raw" role.
784 * tools/stylesheets/default.css:
786   - Added support for the new line_block structure.
787   - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
790 Release 0.3.5 (2004-07-29)
791 ==========================
793 General:
795 * _`Documentation cleanup/reorganization`.
797   - Created new subdirectories of docs/:
799     * ``docs/user/``: introductory/tutorial material for end-users
800     * ``docs/dev/``: for core-developers (development notes, plans, etc.)
801     * ``docs/api/``: API reference material for client-developers
802     * ``docs/ref/``: reference material for all groups
803     * ``docs/howto/``: for component-developers and core-developers
804     * ``docs/peps/``: Python Enhancement Proposals
806   - Moved ``docs/*`` to ``docs/user/``.
807   - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
808     ``spec/`` to ``docs/dev``.
809   - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
810     ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
811   - Moved ``alternatives.txt``, and ``problems.txt`` from
812     ``spec/rst/`` to ``docs/dev/rst/``.
813   - Moved ``reStructuredText.txt``, ``directives.txt``,
814     ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
815     to ``docs/ref/rst/``.  Renamed ``interpreted.txt`` to
816     ``roles.txt``, ``reStructuredText.txt`` to
817     ``restructuredtext.txt``.
818   - Moved ``spec/howto/`` to ``docs/howto``.
820   In order to keep the CVS history of moved files, we supplied
821   SourceForge with a `script for modifying the Docutils CVS
822   repository`__.
824   __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
826   After running the cleanup script:
828   - Added ``docs/index.txt``.
829   - Added a ``.htaccess`` file to the ``web`` module, containing
830     redirects for all old paths to new paths.  They'll preserve
831     fragments (the "#name" part of a URL), and won't clutter up the
832     file system, and will correct the URL in the user's browser.
833   - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
834     ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
835     the "To Do" list itself in ``docs/dev/todo.txt``.
836   - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
837     section of ``docs/dev/todo.txt``.
838   - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
839   - Added "How To Report Bugs" to ``BUGS.txt``.
840   - Went through all the sources and docs (including under web/) and
841     updated links.  Mostly done by Felix Wiemann; thanks Felix!
842     (Still need to update links in the sandboxes.)
844 Specific:
846 * BUGS.txt: Added to project.
848 * THANKS.txt: Added to project.
850 * docutils/__init__.py:
852   - 0.3.4: Post-release.
854 * docutils/core.py:
856   - Added special error handling & advice for UnicodeEncodeError.
857   - Refactored Publisher.publish (simplified exception handling &
858     extracted debug dumps).
859   - Renamed "enable_exit" parameter of convenience functions to
860     "enable_exit_status".
861   - Enabled traceback (exception propagation) by default in
862     programmatic convenience functions.
863   - Now publish_file and publish_cmdline convenience functions return
864     the encoded string results in addition to their regular I/O.
865   - Extracted common code from publish_file, publish_string, and
866     publish_parts, into new publish_programmatically.  Extracted
867     settings code to ``Publisher.process_programmatic_settings``.
868   - In Publisher.publish, disabled ``settings_overrides`` when
869     ``settings`` is supplied; redundant.
871 * docutils/frontend.py:
873   - Added help text for "--output-encoding-error-handler" and
874     "--error-encoding-error-handler".
875   - Renamed "--exit" to "--exit-status".
876   - Simplified default-setting code.
878 * docutils/parsers/rst/__init__.py:
880   - Added "--pep-base-url" and "--rfc-base-url" options.
882 * docutils/parsers/rst/states.py:
884   - Made URI recognition more aggressive and intelligent.
886 * docutils/parsers/rst/directives/__init__.py:
888   - Added several directive option conversion functions.
890 * docutils/parsers/rst/directives/body.py:
892   - Moved "table" directive to tables.py.
894 * docutils/parsers/rst/directives/tables.py: Table-related directives,
895   added to project.
897 * docutils/writers/latex2e.py:
899   - Added "--table-style=(standard|booktabs|nolines)"
900   - figures get "here" option (LaTeX per default puts them at bottom),
901     and figure content is centered.
902   - Rowspan support for tables.
903   - Fix: admonition titles before first section.
904   - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
905   - Replave ``_`` in literal by an underlined blank, because it has the correct
906     width.
907   - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
908   - A few unicode replacements, if output_encoding != utf
909   - Add "--graphicx-option".
910   - Indent literal-blocks.
911   - Fix: omit ``\maketitle`` when there is no document title.
913 * docs/index.txt: "Docutils Project Documentation Overview", added to
914   project.
916 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
917   Tool", added to project.
919 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
921 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
923 * docs/dev/policies.txt: Added to project (extracted from
924   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
926 * docs/dev/release.txt: Added to project (extracted from
927   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
929 * docs/dev/testing.txt: Added to project.
931 * docs/dev/website.txt: Added to project (extracted from
932   ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
934 * docs/ref/rst/directives.txt:
936   - Added directives: "table", "csv-table".
938 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
939   added to project.  1 page for syntax, and a 1 page reference for
940   directives and roles.  Source text to be used as-is; not meant to be
941   converted to HTML.
943 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
944   with a change of title.
946 * test/functional/, contents, and test/test_functional.py: Added to
947   project.
949 * tools/buildhtml.py: Fixed bug with config file handling.
951 * tools/html.py: Removed from project (duplicate of rst2html.py).
953 * tools/pep2html.py: Removed from project (duplicate of Python's
954   nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
955   Docutils-related PEPs in docs/peps/).
957 * tools/rst2pseudoxml.py: Renamed from publish.py.
959 * tools/rst2xml.py: Renamed from docutils-xml.py.
961 * tools/test.txt: Removed from project; moved to
962   docs/user/rst/demo.txt.
964 * setup.py: Now also installs ``rst2latex.py``.
967 Release 0.3.3 (2004-05-09)
968 ==========================
970 * docutils/__init__.py:
972   - 0.3.1: Reorganized config file format (multiple sections); see
973     docs/config.txt.
974   - Added unknown_reference_resolvers attribute to TransformSpec.
975   - 0.3.2: Interpreted text reorganization.
976   - 0.3.3: Released.
978 * docutils/core.py:
980   - Catch system messages to stop tracebacks from parsing errors.
981   - Catch exceptions during processing report & exit without
982     tracebacks, except when "--traceback" used.
983   - Reordered components for OptionParser; application comes last.
984   - Added "config_section" parameter to several methods and functions,
985     allowing front ends to easily specify their config file sections.
986   - Added publish_parts convenience function to allow access to individual
987     parts of a document.
989 * docutils/examples.py: Added to project; practical examples of
990   Docutils client code, to be used as-is or as models for variations.
992 * docutils/frontend.py:
994   - Added "--traceback" & "--no-traceback" options ("traceback"
995     setting).
996   - Implemented support for config file reorganization:
997     ``standard_config_files`` moved from ``ConfigParser`` to
998     ``OptionParser``; added
999     ``OptionParser.get_config_file_settings()`` and
1000     ``.get_standard_config_settings()``; support for old "[options]"
1001     section (with deprecation warning) and mapping from old to new
1002     settings.
1003   - Reimplemented setting validation.
1004   - Enabled flexible boolean values: yes/no, true/false, on/off.
1005   - Added ``Values``, a subclass of ``optparse.Values``, with support
1006     for list setting attributes.
1007   - Added support for new ``DOCUTILSCONFIG`` environment variable;
1008     thanks to Beni Cherniavsky.
1009   - Added "--no-section-numbering" option.
1011 * docutils/io.py:
1013   - Catch IOErrors when opening source & destination files, report &
1014     exit without tracebacks.  Added ``handle_io_errors`` parameter to
1015     ``FileInput`` & ``FileOutput`` to enable caller error handling.
1017 * docutils/nodes.py:
1019   - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1020     method definitions (via ``exec``) to dynamic assignments (via
1021     ``setattr``); thanks to Roman Suzi.
1022   - Encapsulated visitor dynamic assignments in a function; thanks to
1023     Ian Bicking.
1024   - Added indirect_reference_name attribute to the Targetable
1025     class. This attribute holds the whitespace_normalized_name
1026     (contains mixed case) of a target.
1028 * docutils/statemachine.py:
1030   - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1031   - Added ``StringList.get_2D_block``.
1033 * docutils/utils.py:
1035   - Added "level" attribute to SystemMessage exceptions.
1037 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1038   Jannie Hofmeyr.
1040 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1041   Blaha.
1043 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1044   Marcelo Huerta San Martin.
1046 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1047   mappings by Lalo Martins.
1049 * docutils/languages/ru.py: Added to project; Russian mappings by
1050   Roman Suzi.
1052 * docutils/parsers/rst/roles.py: Added to project.  Contains
1053   interpreted text role functions, a registry for interpreted text
1054   roles, and an API for adding to and retrieving from the registry.
1055   Contributed by Edward Loper.
1057 * docutils/parsers/rst/states.py:
1059   - Updated ``RSTState.nested_parse`` for "include" in table cells.
1060   - Allowed true em-dash character and "---" as block quote
1061     attribution marker.
1062   - Added support for <angle-bracketed> complex option arguments
1063     (option lists).
1064   - Fixed handling of backslashes in substitution definitions.
1065   - Fixed off-by-1 error with extra whitespace after substitution
1066     definition directive.
1067   - Added inline markup parsing to field lists' field names.
1068   - Added support for quoted (and unindented) literal blocks.
1069     Driven in part by a bribe from Frank Siebenlist (thanks!).
1070   - Parser now handles escapes in URIs correctly.
1071   - Made embedded-URIs' reference text omittable.  Idea from Beni
1072     Cherniavsky.
1073   - Refactored explicit target processing code.
1074   - Added name attribute to references containing the reference name only
1075     through whitespace_normalize_name (no case changes).
1076   - parse_target no longer returns the refname after going through
1077     normalize_name. This is now handled in make_target.
1078   - Fixed bug relating to role-less interpreted text in non-English
1079     contexts.
1080   - Reorganized interpreted text processing; moved code into the new
1081     roles.py module.  Contributed by Edward Loper.
1082   - Refactored ``Body.parse_directive`` into ``run_directive`` and
1083     ``parse_directive_block``.
1085 * docutils/parsers/rst/tableparser.py:
1087   - Reworked for ``StringList``, to support "include" directives in
1088     table cells.
1090 * docutils/parsers/rst/directives/__init__.py:
1092   - Renamed ``unchanged()`` directive option conversion function to
1093     ``unchanged_required``, and added a new ``unchanged``.
1094   - Catch unicode value too high error; fixes bug 781766.
1095   - Beefed up directive error reporting.
1097 * docutils/parsers/rst/directives/body.py:
1099   - Added basic "table" directive.
1101 * docutils/parsers/rst/directives/images.py:
1103   - Added "target" option to "image" directive.
1104   - Added name attribute to references containing the reference name only
1105     through whitespace_normalize_name (no case changes).
1107 * docutils/parsers/rst/directives/misc.py:
1109   - Isolated the import of the ``urllib2`` module; was causing
1110     problems on SourceForge (``libssl.so.2`` unavailable?).
1111   - Added the "role" directive for declaring custom interpreted text
1112     roles.
1114 * docutils/parsers/rst/directives/parts.py:
1116   - The "contents" directive does more work up-front, creating the
1117     "topic" and "title", and leaving the "pending" node for the
1118     transform.  Allows earlier reference resolution; fixes subtle bug.
1120 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1121   mappings by Jannie Hofmeyr.
1123 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1124   mappings by Marek Blaha.
1126 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1127   mappings by Marcelo Huerta San Martin.
1129 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1130   Portuguese mappings by Lalo Martins.
1132 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1133   mappings by Roman Suzi.
1135 * docutils/transforms/parts.py:
1137   - The "contents" directive does more work up-front, creating the
1138     "topic" and "title", and leaving the "pending" node for the
1139     transform.  Allows earlier reference resolution; fixes subtle bug.
1140   - Added support for disabling of section numbering.
1142 * docutils/transforms/references.py:
1144   - Verifying that external targets are truly targets and not indirect
1145     references. This is because we are now adding a "name" attribute to
1146     references in addition to targets. Note sure if this is correct!
1147   - Added code to hook into the unknown_reference_resolvers list for a
1148     transformer in resolve_indirect_target. This allows the
1149     unknown_reference_resolvers to keep around indirect targets which
1150     docutils doesn't know about.
1151   - Added specific error message for duplicate targets.
1153 * docutils/transforms/universal.py:
1155   - Added FilterMessages transform (removes system messages below the
1156     verbosity threshold).
1157   - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1158     to FinalCheckVisitor for application-specific handling of
1159     unresolvable references.
1160   - Added specific error message for duplicate targets.
1162 * docutils/writers/__init__.py:
1164   - Added assemble_parts method to the Writer class to allow for
1165     access to a documents individual parts.
1166   - Documented & set default for ``Writer.output`` attribute.
1168 * docutils/writers/html4css1.py:
1170   - Fixed unicode handling of attribute values (bug 760673).
1171   - Prevent duplication of "class" attribute values (bug report from
1172     Kirill Lapshin).
1173   - Improved table grid/border handling (prompted by report from Bob
1174     Marshall).
1175   - Added support for table titles.
1176   - Added "<title />" for untitled docs, for XHTML conformance; thanks
1177     to Darek Suchojad.
1178   - Added functionality to keep track of individual parts of a document
1179     and store them in a dictionary as the "parts" attribute of the writer.
1180     Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1181   - Added proper support for the "scale" attribute of the "image"
1182     element.  Contributed by Brent Cook.
1183   - Added ``--initial-header-level`` option.
1184   - Fixed bug: the body_pre_docinfo segment depended on there being a
1185     docinfo; if no docinfo, the document title was incorporated into
1186     the body segment.  Adversely affected the publish_parts interface.
1188 * docutils/writers/latex2e.py:
1190   - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1191     about a missing file.
1192   - Added options and support: ``--compound-enumerators``,
1193     ``--section-prefix-for-enumerators``, and
1194     ``--section-enumerator-separator``.  By John F Meinel Jr (SF patch
1195     934322).
1196   - Added option ``--use-verbatim-when-possible``, to avoid
1197     problematic characters (eg, '~' in italian) in literal blocks.
1198   - It's now possible to use four section levels in the `book` and
1199     `report` LaTeX classes.  The default `article` class still has
1200     three levels limit.
1202 * docs/config.txt: "Docutils Configuration Files", added to project.
1203   Moved config file entry descriptions from tools.txt.
1205 * docs/tools.txt:
1207   - Moved config file entry descriptions to config.txt.
1209 * spec/notes.txt: Continual updates.  Added "Setting Up For Docutils
1210   Development".
1212 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1213   Text Roles", added to project.
1215 * spec/rst/reStructuredText.txt:
1217   - Added description of support for <angle-bracketed> complex option
1218     arguments to option lists.
1219   - Added subsections for indented and quoted literal blocks.
1221 * test: Continually adding & updating tests.
1223   - Added test/test_settings.py & test/data/config_*.txt support
1224     files.
1225   - Added test/test_writers/test_htmlfragment.py.
1227 * test/DocutilsTestSupport.py:
1229   - Refactored LaTeX publisher test suite/case class names to make
1230     testing other writers easier.
1231   - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1232     to test the processing of HTML fragments which use the new
1233     publish_parts convenience function.
1235 * tools/buildhtml.py:
1237   - Added support for the "--prune" option.
1238   - Removed dependency on pep2html.py; plaintext PEPs no longer
1239     supported.
1241 * tools/docutils.conf:
1243   - Updated for configuration file reorganization.
1245 * tools/rst2html.py:
1247   - copied from tools/html.py
1249 * setup.py:
1251   - added a 'scripts' section to configuration
1252   - added 'tools/rst2html.py' to the scripts section
1255 Release 0.3 (2003-06-24)
1256 ========================
1258 General:
1260 * Renamed "attribute" to "option" for directives/extensions.
1262 * Renamed transform method "transform" to "apply".
1264 * Renamed "options" to "settings" for runtime settings (as set by
1265   command-line options).  Sometimes "option" (singular) became
1266   "settings" (plural).  Some variations below:
1268   - document.options -> document.settings (stored in other objects as
1269     well)
1270   - option_spec -> settings_spec (not directives though)
1271   - OptionSpec -> SettingsSpec
1272   - cmdline_options -> settings_spec
1273   - relative_path_options -> relative_path_settings
1274   - option_default_overrides -> settings_default_overrides
1275   - Publisher.set_options -> Publisher.get_settings
1277 Specific:
1279 * COPYING.txt: Added "Public Domain Dedication".
1281 * FAQ.txt: Frequently asked questions, added to project.
1283 * setup.py:
1285   - Updated with PyPI Trove classifiers.
1286   - Conditional installation of third-party modules.
1288 * docutils/__init__.py:
1290   - Bumped version to 0.2.1 to reflect changes to I/O classes.
1291   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1292   - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1293   - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1294     option and its effect on the PEP template & writer.
1295   - Bumped version to 0.2.4 due to changes to the PEP template &
1296     stylesheet.
1297   - Bumped version to 0.2.5 to reflect changes to Reporter output.
1298   - Added ``TransformSpec`` class for new transform system.
1299   - Bumped version to 0.2.6 for API changes (renaming).
1300   - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1301     convenience functions.
1302   - Added ``Component.component_type`` attribute.
1303   - Bumped version to 0.2.8 because of the internal parser switch from
1304     plain lists to the docutils.statemachine.StringList objects.
1305   - Bumped version to 0.2.9 because of the frontend.py API changes.
1306   - Bumped version to 0.2.10 due to changes to the project layout
1307     (third-party modules removed from the "docutils" package), and
1308     signature changes in ``io.Input``/``io.Output``.
1309   - Changed version to 0.3.0 for release.
1311 * docutils/core.py:
1313   - Made ``publish()`` a bit more convenient.
1314   - Generalized ``Publisher.set_io``.
1315   - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1316     parameters; improved its docstring.
1317   - Added ``publish_file()`` and ``publish_string()``.
1318   - Factored ``Publisher.set_source()`` and ``.set_destination()``
1319     out of ``.set_io``.
1320   - Added support for "--dump-pseudo-xml", "--dump-settings", and
1321     "--dump-transforms" hidden options.
1322   - Added ``Publisher.apply_transforms()`` method.
1323   - Added ``Publisher.set_components()`` method; support for
1324     ``publish_*()`` conveninece functions.
1325   - Moved config file processing to docutils/frontend.py.
1326   - Added support for exit status ("exit_level" setting &
1327     ``enable_exit`` parameter for Publisher.publish() and convenience
1328     functions).
1330 * docutils/frontend.py:
1332   - Check for & exit on identical source & destination paths.
1333   - Fixed bug with absolute paths & "--config".
1334   - Set non-command-line defaults in ``OptionParser.__init__()``:
1335     ``_source`` & ``_destination``.
1336   - Distributed ``relative_path_settings`` to components; updated
1337     ``OptionParser.populate_from_components()`` to combine it all.
1338   - Require list of keys in ``make_paths_absolute`` (was implicit in
1339     global ``relative_path_settings``).
1340   - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1341     "--dump-settings", and "--dump-transforms" hidden options.
1342   - Removed nasty internals-fiddling ``ConfigParser.get_section``
1343     code, replaced with correct code.
1344   - Added validation functionality for config files.
1345   - Added "--error-encoding" option/setting, "_disable_config"
1346     internal setting.
1347   - Added encoding validation; updated "--input-encoding" and
1348     "--output-encoding"; added "--error-encoding-error-handler" and
1349     "--output-encoding-error-handler".
1350   - Moved config file processing from docutils/core.py.
1351   - Updated ``OptionParser.populate_from_components`` to handle new
1352     ``SettingsSpec.settings_defaults`` dict.
1353   - Added support for "-" => stdin/stdout.
1354   - Added "exit_level" setting ("--exit" option).
1356 * docutils/io.py:
1358   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1359   - Added automatic closing to ``FileInput`` and ``FileOutput``.
1360   - Delayed opening of ``FileOutput`` file until ``write()`` called.
1361   - ``FileOutput.write()`` now returns the encoded output string.
1362   - Try to get path/stream name automatically in ``FileInput`` &
1363     ``FileOutput``.
1364   - Added defaults for source & destination paths.
1365   - Allow for Unicode I/O with an explicit "unicode" encoding.
1366   - Added ``Output.encode()``.
1367   - Removed dependency on runtime settings; pass encoding directly.
1368   - Recognize Unicode strings in ``Input.decode()``.
1369   - Added support for output encoding error handlers.
1371 * docutils/nodes.py:
1373   - Added "Invisible" element category class.
1374   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1375     modification during a traversal.
1376   - Added element classes: ``line_block``, ``generated``, ``address``,
1377     ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1378     ``superscript``, ``subscript``, ``inline``
1379   - Added support for lists of nodes to ``Element.insert()``.
1380   - Fixed parent linking in ``Element.replace()``.
1381   - Added new abstract superclass ``FixedTextElement``; adds
1382     "xml:space" attribute.
1383   - Added support for "line" attribute of ``system_message`` nodes.
1384   - Added support for the observer pattern from ``utils.Reporter``.
1385     Added ``parse_messages`` and ``transform_messages`` attributes to
1386     ``document``, removed ``messages``.  Added ``note_parse_message``
1387     and ``note_transform_message`` methods.
1388   - Added support for improved diagnostics:
1390     - Added "document", "source", and "line" internal attributes to
1391       ``Node``, set by ``Node.setup_child()``.
1392     - Converted variations on ``node.parent = self`` to
1393       ``self.setup_child(node)``.
1394     - Added ``document.current_source`` & ``.current_line``
1395       attributes, and ``.note_source`` observer method.
1396     - Changed "system_message" output to GNU-Tools format.
1398   - Added a "rawsource" attribute to the ``Text`` class, for text
1399     before backslash-escape resolution.
1400   - Support for new transform system.
1401   - Reworked ``pending`` element.
1402   - Fixed XML DOM bug (SF #660611).
1403   - Removed the ``interpeted`` element class and added
1404     ``title_reference``, ``abbreviation``, ``acronym``.
1405   - Made substitutions case-sensitive-but-forgiving; moved some code
1406     from the parser.
1407   - Fixed Unicode bug on element attributes (report: William Dode).
1409 * docutils/optik.py: Removed from project; replaced with
1410   extras/optparse.py and extras/textwrap.py.  These will be installed
1411   only if they're not already present in the Python installation.
1413 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1414   only if it's not already present in the Python installation.
1416 * docutils/statemachine.py:
1418   - Factored out ``State.add_initial_transitions()`` so it can be
1419     extended.
1420   - Converted whitespace-specific "blank" and "indent" transitions
1421     from special-case code to ordinary transitions: removed
1422     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1423     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1424     ``ws_initial_transitions`` attributes.
1425   - Removed ``State.match_transition()`` after merging it into
1426     ``.check_line()``.
1427   - Added ``StateCorrection`` exception.
1428   - Added support for ``StateCorrection`` in ``StateMachine.run()``
1429     (moved ``TransitionCorrection`` support there too.)
1430   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1431     ``EOFError`` instead of ``IndexError``.
1432   - Added ``State.no_match`` method.
1433   - Added support for the Observer pattern, triggered by input line
1434     changes.
1435   - Added ``strip_top`` parameter to
1436     ``StateMachineWS.get_first_known_indented``.
1437   - Made ``context`` a parameter to ``StateMachine.run()``.
1438   - Added ``ViewList`` & ``StringList`` classes;
1439     ``extract_indented()`` becomes ``StringList.get_indented()``.
1440   - Added ``StateMachine.insert_input()``.
1441   - Fixed ViewList slice handling for Python 2.3.  Patch from (and
1442     thanks to) Fred Drake.
1444 * docutils/utils.py:
1446   - Added a ``source`` attribute to Reporter instances and
1447     ``system_message`` elements.
1448   - Added an observer pattern to ``utils.Reporter`` to keep track of
1449     system messages.
1450   - Fixed bugs in ``relative_path()``.
1451   - Added support for improved diagnostics.
1452   - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1453   - Added support for encoding Reporter stderr output, and encoding
1454     error handlers.
1455   - Reporter keeps track of the highest level system message yet
1456     generated.
1458 * docutils/languages: Fixed bibliographic field language lookups.
1460 * docutils/languages/es.py: Added to project; Spanish mappings by
1461   Marcelo Huerta San Martin.
1463 * docutils/languages/fr.py: Added to project; French mappings by
1464   Stefane Fermigier.
1466 * docutils/languages/it.py: Added to project; Italian mappings by
1467   Nicola Larosa.
1469 * docutils/languages/sk.py: Added to project; Slovak mappings by
1470   Miroslav Vasko.
1472 * docutils/parser/__init__.py:
1474   - Added ``Parser.finish_parse()`` method.
1476 * docutils/parser/rst/__init__.py:
1478   - Added options: "--pep-references", "--rfc-references",
1479     "--tab-width", "--trim-footnote-reference-space".
1481 * docutils/parsers/rst/states.py:
1483   - Changed "title under/overline too short" system messages from INFO
1484     to WARNING, and fixed its insertion location.
1485   - Fixed enumerated list item parsing to allow paragraphs & section
1486     titles to begin with enumerators.
1487   - Converted system messages to use the new "line" attribute.
1488   - Fixed a substitution reference edge case.
1489   - Added support for "--pep-references" and "--rfc-references"
1490     options; reworked ``Inliner`` code to make customization easier.
1491   - Removed field argument parsing.
1492   - Added support for short section title over/underlines.
1493   - Fixed "simple reference name" regexp to ignore text like
1494     "object.__method__"; not an anonymous reference.
1495   - Added support for improved diagnostics.
1496   - Reworked directive API, based on Dethe Elza's contribution.  Added
1497     ``Body.parse_directive()``, ``.parse_directive_options()``,
1498     ``.parse_directive_arguments()`` methods.
1499   - Added ``ExtensionOptions`` class, to parse directive options
1500     without parsing field bodies.  Factored
1501     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1502     ``ExtensionOptions``.
1503   - Improved definition list term/classifier parsing.
1504   - Added warnings for unknown directives.
1505   - Renamed ``Stuff`` to ``Struct``.
1506   - Now flagged as errors: transitions at the beginning or end of
1507     sections, empty sections (except title), and empty documents.
1508   - Updated for ``statemachine.StringList``.
1509   - Enabled recognition of schemeless email addresses in targets.
1510   - Added support for embedded URIs in hyperlink references.
1511   - Added backslash-escapes to inline markup end-string suffix.
1512   - Added support for correct interpreted text processing.
1513   - Fixed nested title parsing (topic, sidebar directives).
1514   - Added special processing of backslash-escaped whitespace (idea
1515     from David Abrahams).
1516   - Made substitutions case-sensitive-but-forgiving; moved some code
1517     to ``docutils.nodes``.
1518   - Added support for block quote attributions.
1519   - Added a kludge to work-around a conflict between the bubble-up
1520     parser strategy and short titles (<= 3 char-long over- &
1521     underlines).  Fixes SF bug #738803 "infinite loop with multiple
1522     titles" submitted by Jason Diamond.
1523   - Added explicit interpreted text roles for standard inline markup:
1524     "emphasis", "strong", "literal".
1525   - Implemented "superscript" and "subscript" interpreted text roles.
1526   - Added initial support for "abbreviation" and "acronym" roles;
1527     incomplete.
1528   - Added support for "--trim-footnote-reference-space" option.
1529   - Optional space before colons in directives & hyperlink targets.
1531 * docutils/parsers/rst/tableparser.py:
1533   - Fixed a bug that was producing unwanted empty rows in "simple"
1534     tables.
1535   - Detect bad column spans in "simple" tables.
1537 * docutils/parsers/rst/directives: Updated all directive functions to
1538   new API.
1540 * docutils/parsers/rst/directives/__init__.py:
1542   - Added ``flag()``, ``unchanged()``, ``path()``,
1543     ``nonnegative_int()``, ``choice()``, and ``class_option()``
1544     directive option helper functions.
1545   - Added warnings for unknown directives.
1546   - Return ``None`` for missing directives.
1547   - Added ``register_directive()``, thanks to William Dode and Paul
1548     Moore.
1550 * docutils/parsers/rst/directives/admonitions.py:
1552   - Added "admonition" directive.
1554 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
1555   the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1556   "parsed-literal", "rubric", "epigraph", "highlights" and
1557   "pull-quote" directives.
1559 * docutils/parsers/rst/directives/images.py:
1561   - Added an "align" attribute to the "image" & "figure" directives
1562     (by Adam Chodorowski).
1563   - Added "class" option to "image", and "figclass" to "figure".
1565 * docutils/parsers/rst/directives/misc.py:
1567   - Added "include", "raw", and "replace" directives, courtesy of
1568     Dethe Elza.
1569   - Added "unicode" and "class" directives.
1571 * docutils/parsers/rst/directives/parts.py:
1573   - Added the "sectnum" directive; by Dmitry Jemerov.
1574   - Added "class" option to "contents" directive.
1576 * docutils/parsers/rst/directives/references.py: Added to project.
1577   Contains the "target-notes" directive.
1579 * docutils/parsers/rst/languages/__init__.py:
1581   - Return ``None`` from get_language() for missing language modules.
1583 * docutils/parsers/rst/languages/de.py: Added to project; German
1584   mappings by Engelbert Gruber.
1586 * docutils/parsers/rst/languages/en.py:
1588   - Added interpreted text roles mapping.
1590 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1591   mappings by Marcelo Huerta San Martin.
1593 * docutils/parsers/rst/languages/fr.py: Added to project; French
1594   mappings by William Dode.
1596 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1597   mappings by Nicola Larosa.
1599 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1600   mappings by Miroslav Vasko.
1602 * docutils/readers/__init__.py:
1604   - Added support for the observer pattern from ``utils.Reporter``, in
1605     ``Reader.parse`` and ``Reader.transform``.
1606   - Removed ``Reader.transform()`` method.
1607   - Added default parameter values to ``Reader.__init__()`` to make
1608     instantiation easier.
1609   - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1611 * docutils/readers/pep.py:
1613   - Added the ``peps.TargetNotes`` transform to the Reader.
1614   - Removed PEP & RFC reference detection code; moved to
1615     parsers/rst/states.py as options (enabled here by default).
1616   - Added support for pre-acceptance PEPs (no PEP number yet).
1617   - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1618     easy subclassing.
1620 * docutils/readers/python: Python Source Reader subpackage added to
1621   project, including preliminary versions of:
1623   - __init__.py
1624   - moduleparser.py: Parser for Python modules.
1626 * docutils/transforms/__init__.py:
1628   - Added ``Transformer`` class and completed transform reform.
1629   - Added unknown_reference_resolvers list for each transformer. This list holds
1630     the list of functions provided by each component of the transformer that
1631     help resolve references.
1633 * docutils/transforms/frontmatter.py:
1635   - Improved support for generic fields.
1636   - Fixed bibliographic field language lookups.
1638 * docutils/transforms/misc.py: Added to project.  Miscellaneous
1639   transforms.
1641 * docutils/transforms/parts.py:
1643   - Moved the "id" attribute from TOC list items to the references
1644     (``Contents.build_contents()``).
1645   - Added the ``SectNum`` transform; by Dmitry Jemerov.
1646   - Added "class" attribute support to ``Contents``.
1648 * docutils/transforms/peps.py:
1650   - Added ``mask_email()`` function, updating to pep2html.py's
1651     functionality.
1652   - Linked "Content-Type: text/x-rst" to PEP 12.
1653   - Added the ``TargetNotes`` PEP-specific transform.
1654   - Added ``TargetNotes.cleanup_callback``.
1655   - Added title check to ``Headers``.
1657 * docutils/transforms/references.py:
1659   - Added the ``TargetNotes`` generic transform.
1660   - Split ``Hyperlinks`` into multiple transforms.
1661   - Fixed bug with multiply-indirect references (report: Bruce Smith).
1662   - Added check for circular indirect references.
1663   - Made substitutions case-sensitive-but-forgiving.
1665 * docutils/transforms/universal.py:
1667   - Added support for the "--expose-internal-attributes" option.
1668   - Removed ``Pending`` transform classes & data.
1670 * docutils/writers/__init__.py:
1672   - Removed ``Writer.transform()`` method.
1674 * docutils/writers/docutils-xml.py:
1676   - Added XML and doctype declarations.
1677   - Added "--no-doctype" and "--no-xml-declaration" options.
1679 * docutils/writers/html4css1.py:
1681   - "name" attributes only on these tags: a, applet, form, frame,
1682     iframe, img, map.
1683   - Added "name" attribute to <a> in section titles for Netscape 4
1684     support (bug report: Pearu Peterson).
1685   - Fixed targets (names) on footnote, citation, topic title,
1686     problematic, and system_message nodes (for Netscape 4).
1687   - Changed field names from "<td>" to "<th>".
1688   - Added "@" to "&#64;" encoding to thwart address harvesters.
1689   - Improved the vertical whitespace optimization; ignore "invisible"
1690     nodes (targets, comments, etc.).
1691   - Improved inline literals with ``<span class="pre">`` around chunks
1692     of text and ``&nbsp;`` for runs of spaces.
1693   - Improved modularity of output; added ``self.body_pre_docinfo`` and
1694     ``self.docinfo`` segments.
1695   - Added support for "line_block", "address" elements.
1696   - Improved backlinks (footnotes & system_messages).
1697   - Improved system_message output.
1698   - Redefined "--stylesheet" as containing an invariant URL, used
1699     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
1700     working directory.
1701   - Added "--footnote-references" option (superscript or brackets).
1702   - Added "--compact-lists" and "--no-compact-lists" options.
1703   - Added "--embed-stylesheet" and "--link-stylesheet" options;
1704     factored out ``HTMLTranslator.get_stylesheet_reference()``.
1705   - Improved field list rendering.
1706   - Added Docutils version to "generator" meta tag.
1707   - Fixed a bug with images; they must be inline, so wrapped in <p>.
1708   - Improved layout of <pre> HTML source.
1709   - Fixed attribute typo on <colspec>.
1710   - Refined XML prologue.
1711   - Support for no stylesheet.
1712   - Removed "interpreted" element support.
1713   - Added support for "title_reference", "sidebar", "attribution",
1714     "rubric", and generic "admonition" elements.
1715   - Added "--attribution" option.
1716   - Added support for "inline", "subscript", "superscript" elements.
1717   - Added initial support for "abbreviation" and "acronym";
1718     incomplete.
1720 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1721   (from the sandbox).
1723   - Added french.
1724   - Double quotes in literal blocks (special treatment for de/ngerman).
1725   - Added '--hyperlink-color' option ('0' turns off coloring of links).
1726   - Added  "--attribution" option.
1727   - Right align attributions.
1729 * docutils/writers/pep_html.py:
1731   - Parameterized output encoding in PEP template.
1732   - Reworked substitutions from ``locals()`` into ``subs`` dict.
1733   - Redefined "--pep-stylesheet" as containing an invariant URL, used
1734     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
1735     working directory.
1736   - Added an override on the "--footnote-references" option.
1737   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1738   - Added Docutils version to "generator" meta tag.
1739   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1741 * docs/tools.txt:
1743   - Added a "silent" setting for ``buildhtml.py``.
1744   - Added a "Getting Help" section.
1745   - Rearranged the structure.
1746   - Kept up to date, with new settings, command-line options etc.
1747   - Added section for ``rst2latex.py`` (Engelbert Gruber).
1748   - Converted settings table into a definition list.
1750 * docs/rst/quickstart.txt:
1752   - Added a table of contents.
1753   - Added feedback information.
1754   - Added mention of minimum section title underline lengths.
1755   - Removed the 4-character minimum for section title underlines.
1757 * docs/rst/quickref.html:
1759   - Added a "Getting Help" section.
1760   - Added a style to make section title backlinks more subtle.
1761   - Added mention of minimum section title underline lengths.
1762   - Removed the 4-character minimum for section title underlines.
1764 * extras: Directory added to project; contains third-party modules
1765   that Docutils depends on (optparse, textwrap, roman).  These are
1766   only installed if they're not already present.
1768 * licenses: Directory added to project; contains copies of license
1769   files for non-public-domain files.
1771 * spec/doctree.txt:
1773   - Changed the focus.  It's about DTD elements:  structural
1774     relationships, semantics, and external (public) attributes.  Not
1775     about the element class library.
1776   - Moved some implementation-specific stuff into ``docutils.nodes``
1777     docstrings.
1778   - Wrote descriptions of all common attributes and parameter
1779     entities.  Filled in introductory material.
1780   - Working through the element descriptions: 55 down, 37 to go.
1781   - Removed "Representation of Horizontal Rules" to
1782     spec/rst/alternatives.txt.
1784 * spec/docutils.dtd:
1786   - Added "generated" inline element.
1787   - Added "line_block" body element.
1788   - Added "auto" attribute to "title".
1789   - Changed content models of "literal_block" and "doctest_block" to
1790     ``%text.model``.
1791   - Added ``%number;`` attribute type parameter entity.
1792   - Changed ``%structural.elements;`` to ``%section.elements``.
1793   - Updated attribute types; made more specific.
1794   - Added "address" bibliographic element.
1795   - Added "line" attribute to ``system_message`` element.
1796   - Removed "field_argument" element; "field_name" may contain
1797     multiple words and whitespace.
1798   - Changed public identifier to docutils.sf.net.
1799   - Removed "interpreted" element; added "title_reference",
1800     "abbreviation", "acronym".
1801   - Removed "refuri" attribute from "footnote_reference" and
1802     "citation_reference".
1803   - Added "sidebar", "rubric", "attribution", "admonition",
1804     "superscript", "subscript", and "inline" elements.
1806 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1808 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1810 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1812 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1813   Dallas Mahrt.
1815 * spec/transforms.txt: Added to project.
1817 * spec/howto: Added subdirectory, for developer how-to docs.
1819 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
1820   Elza, edited & extended by David Goodger.
1822 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
1823   project.
1825 * spec/rst/alternatives.txt:
1827   - Added "Doctree Representation of Transitions" from
1828     spec/doctree.txt.
1829   - Updated "Inline External Targets" & closed the debate.
1830   - Added ideas for interpreted text syntax extensions.
1831   - Added "Nested Inline Markup" section.
1833 * spec/rst/directives.txt:
1835   - Added directives: "topic", "sectnum", "target-notes",
1836     "line-block", "parsed-literal", "include", "replace", "sidebar",
1837     "admonition", "rubric", "epigraph", "highlights", "unicode" and
1838     "class".
1839   - Formalized descriptions of directive details.
1840   - Added an "align" attribute to the "image" & "figure" directives
1841     (by Adam Chodorowski).
1842   - Added "class" options to "topic", "sidebar", "line-block",
1843     "parsed-literal", "contents", and "image"; and "figclass" to
1844     "figure".
1846 * spec/rst/interpreted.txt: Added to project.  Descriptions of
1847   interpreted text roles.
1849 * spec/rst/introduction.txt:
1851   - Added pointers to material for new users.
1853 * spec/rst/reStructuredText.txt:
1855   - Disambiguated comments (just add a newline after the "::").
1856   - Updated enumerated list description; added a discussion of the
1857     second-line validity checking.
1858   - Updated directive description.
1859   - Added a note redirecting newbies to the user docs.
1860   - Expanded description of inline markup start-strings in non-markup
1861     contexts.
1862   - Removed field arguments and made field lists a generic construct.
1863   - Removed the 4-character minimum for section title underlines.
1864   - Clarified term/classifier delimiter & inline markup ambiguity
1865     (definition lists).
1866   - Added "Embedded URIs".
1867   - Updated "Interpreted Text" section.
1868   - Added "Character-Level Inline Markup" section.
1870 * test: Continually adding & updating tests.
1872   - Moved test/test_rst/ to test/test_parsers/test_rst/.
1873   - Moved test/test_pep/ to test/test_readers/test_pep/.
1874   - Added test/test_readers/test_python/.
1875   - Added test/test_writers/ (Engelbert Gruber).
1877 * tools:
1879   - Made the ``locale.setlocale()`` calls in front ends
1880     fault-tolerant.
1882 * tools/buildhtml.py:
1884   - Added "--silent" option.
1885   - Fixed bug with absolute paths & "--config".
1886   - Updated for new I/O classes.
1887   - Added some exception handling.
1888   - Separated publishers' setting defaults; prevents interference.
1889   - Updated for new ``publish_file()`` convenience function.
1891 * tools/pep-html-template:
1893   - Allow for "--embed-stylesheet".
1894   - Added Docutils version to "generator" meta tag.
1895   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1896   - Conform to XHTML spec.
1898 * tools/pep2html.py:
1900   - Made ``argv`` a parameter to ``main()``.
1901   - Added support for "Content-Type:" header & arbitrary PEP formats.
1902   - Linked "Content-Type: text/plain" to PEP 9.
1903   - Files skipped (due to an error) are not pushed onto the server.
1904   - Updated for new I/O classes.
1905   - Added ``check_requirements()`` & ``pep_type_error()``.
1906   - Added some exception handling.
1907   - Updated for new ``publish_string()`` convenience function.
1908   - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1910 * tools/quicktest.py:
1912   - Added "-V"/"--version" option.
1914 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1916 * tools/unicode2rstsubs.py: Added to project.  Produces character
1917   entity files (reSructuredText substitutions) from the MathML master
1918   unicode.xml file.
1920 * tools/editors: Support code for editors, added to project.  Contains
1921   ``emacs/restructuredtext.el``.
1923 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1925   - Added style for chunks of inline literals.
1926   - Removed margin for first child of table cells.
1927   - Right-aligned field list names.
1928   - Support for auto-numbered section titles in TOCs.
1929   - Increased the size of inline literals (<tt>) in titles.
1930   - Restored the light gray background for inline literals.
1931   - Added support for "line_block" elements.
1932   - Added style for "address" elements.
1933   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1934   - Improved field list rendering.
1935   - Vertical whitespace improvements.
1936   - Removed "a.target" style.
1938 * tools/stylesheets/pep.css:
1940   - Fixed nested section margins.
1941   - Other changes parallel those of ``../default.css``.
1944 Release 0.2 (2002-07-31)
1945 ========================
1947 General:
1949 - The word "component" was being used ambiguously.  From now on,
1950   "component" will be used to mean "Docutils component", as in Reader,
1951   Writer, Parser, or Transform.  Portions of documents (Table of
1952   Contents, sections, etc.)  will be called "document parts".
1953 - Did a grand renaming: a lot of ``verylongnames`` became
1954   ``very_long_names``.
1955 - Cleaned up imports: no more relative package imports or
1956   comma-separated lists of top-level modules.
1957 - Added support for an option values object which carries default
1958   settings and overrides (from command-line options and library use).
1959 - Added internal Unicode support, and support for both input and
1960   output encodings.
1961 - Added support for the ``docutils.io.IO`` class & subclasses.
1963 Specific:
1965 * docutils/__init__.py:
1967   - Added ``ApplicationError`` and ``DataError``, for use throughout
1968     the package.
1969   - Added ``Component`` base class for Docutils components; implements
1970     the ``supports`` method.
1971   - Added ``__version__`` (thus, ``docutils.__version__``).
1973 * docutils/core.py:
1975   - Removed many keyword parameters to ``Publisher.__init__()`` and
1976     ``publish()``; bundled into an option values object.  Added
1977     "argv", "usage", "description", and "option_spec" parameters for
1978     command-line support.
1979   - Added ``Publisher.process_command_line()`` and ``.set_options()``
1980     methods.
1981   - Reworked I/O model for ``docutils.io`` wrappers.
1982   - Updated ``Publisher.set_options()``; now returns option values
1983     object.
1984   - Added support for configuration files (/etc/docutils.conf,
1985     ./docutils.conf, ~/.docutils).
1986   - Added ``Publisher.setup_option_parser()``.
1987   - Added default usage message and description.
1989 * docutils/frontend.py: Added to project; support for front-end
1990   (command-line) scripts.  Option specifications may be augmented by
1991   components.  Requires Optik (http://optik.sf.net/) for option
1992   processing (installed locally as docutils/optik.py).
1994 * docutils/io.py: Added to project; uniform API for a variety of input
1995   output mechanisms.
1997 * docutils/nodes.py:
1999   - Added ``TreeCopyVisitor`` class.
2000   - Added a ``copy`` method to ``Node`` and subclasses.
2001   - Added a ``SkipDeparture`` exception for visitors.
2002   - Renamed ``TreePruningException`` from ``VisitorException``.
2003   - Added docstrings to ``TreePruningException``, subclasses, and
2004     ``Nodes.walk()``.
2005   - Improved docstrings.
2006   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2007   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2008     imports.
2009   - Added ``decoration``, ``header``, and ``footer`` node classes, and
2010     ``PreDecorative`` mixin.
2011   - Reworked the name/id bookkeeping; to ``document``, removed
2012     ``explicit_targets`` and ``implicit_targets`` attributes, added
2013     ``nametypes`` attribute and ``set_name_id_map`` method.
2014   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2015     traversals.
2016   - Added ``document.has_name()`` method.
2017   - Fixed DOM generation for list-attributes.
2018   - Added category class ``Labeled`` (used by footnotes & citations).
2019   - Added ``Element.set_class()`` method (sets "class" attribute).
2021 * docutils/optik.py: Added to project.  Combined from the Optik
2022   package, with added option groups and other modifications.  The use
2023   of this module is probably only temporary.
2025 * docutils/statemachine.py:
2027   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2028   - Added underscores to improve many awkward names.
2029   - In ``string2lines()``, changed whitespace normalizing translation
2030     table to regexp; restores Python 2.0 compatibility with Unicode.
2032 * docutils/urischemes.py:
2034   - Filled in some descriptions.
2035   - Added "shttp" scheme.
2037 * docutils/utils.py:
2039   - Added ``clean_rcs_keywords`` function (moved from
2040     docutils/transforms/frontmatter.py
2041     ``DocInfo.filter_rcs_keywords``).
2042   - Added underscores to improve many awkward names.
2043   - Changed names of Reporter's thresholds:
2044     warning_level -> report_level; error_level -> halt_level.
2045   - Moved ``utils.id()`` to ``nodes.make_id()``.
2046   - Added ``relative_path(source, target)``.
2048 * docutils/languages/de.py: German mappings; added to project.  Thanks
2049   to Gunnar Schwant for the translations.
2051 * docutils/languages/en.py: Added "Dedication" bibliographic field
2052   mappings.
2054 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2055   Chodorowski.
2057 * docutils/parsers/rst/states.py:
2059   - Added underscores to improve many awkward names.
2060   - Added RFC-2822 header support.
2061   - Extracted the inline parsing code from ``RSTState`` to a separate
2062     class, ``Inliner``, which will allow easy subclassing.
2063   - Made local bindings for ``memo`` container & often-used contents
2064     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
2065   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2066   - Added ``MarkupMismatch`` exception; for late corrections.
2067   - Added ``-/:`` characters to inline markup's start string prefix,
2068     ``/`` to end string suffix.
2069   - Fixed a footnote bug.
2070   - Fixed a bug with literal blocks.
2071   - Applied patch from Simon Budig: simplified regexps with symbolic
2072     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2073   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2074   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2075   - Allowed non-ASCII in "simple names" (directive names, field names,
2076     references, etc.).
2077   - Converted ``Inliner.patterns.initial`` to be dynamically built
2078     from parts with ``build_regexp()`` function.
2079   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2080   - Updated docstrings.
2081   - Changed "table" to "grid_table"; added "simple_table" support.
2083 * docutils/parsers/rst/tableparser.py:
2085   - Changed ``TableParser`` to ``GridTableParser``.
2086   - Added ``SimpleTableParser``.
2087   - Refactored naming.
2089 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2090   a fallback language for directive names.
2092 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2093   directive to use a ``pending`` element, used only by HTML writers.
2095 * docutils/parsers/rst/directives/parts.py: Renamed from
2096   components.py.
2098   - Added "backlinks" attribute to "contents" directive.
2100 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2101   project by Adam Chodorowski.
2103 * docutils/readers/__init__.py: Gave Readers more control over
2104   choosing and instantiating Parsers.
2106 * docutils/readers/pep.py: Added to project; for PEP processing.
2108 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2109   requires a ``component`` parameter.
2111 * docutils/transforms/components.py: Added to project; transforms
2112   related to Docutils components.
2114 * docutils/transforms/frontmatter.py:
2116   - In ``DocInfo.extract_authors``, check for a single "author" in an
2117     "authors" group, and convert it to a single "author" element.
2118   - Added support for "Dedication" and generic bibliographic fields.
2120 * docutils/transforms/peps.py: Added to project; PEP-specific.
2122 * docutils/transforms/parts.py: Renamed from old components.py.
2124   - Added filter for `Contents`, to use alt-text for inline images,
2125     and to remove inline markup that doesn't make sense in the ToC.
2126   - Added "name" attribute to TOC topic depending on its title.
2127   - Added support for optional TOC backlinks.
2129 * docutils/transforms/references.py: Fixed indirect target resolution
2130   in ``Hyperlinks`` transform.
2132 * docutils/transforms/universal.py:
2134   - Changed ``Messages`` transform to properly filter out system
2135     messages below the warning threshold.
2136   - Added ``Decorations`` transform (support for ``--generator``,
2137     ``--date``, ``--time``, ``--source-link`` options).
2139 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2140   Engelbert Gruber's PDF writer.
2142 * docutils/writers/html4css1.py:
2144   - Made XHTML-compatible (switched to lowercase element & attribute
2145     names; empty tag format).
2146   - Escape double-dashes in comment text.
2147   - Improved boilerplate & modularity of output.
2148   - Exposed modular output in Writer class.
2149   - Added a "generator" meta tag to <head>.
2150   - Added support for the ``--stylesheet`` option.
2151   - Added support for ``decoration``, ``header``, and ``footer``
2152     elements.
2153   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2154     translation table to regexp; restores Python 2.0 compatibility
2155     with Unicode.
2156   - Added the translator class as instance variable to the Writer, to
2157     make it easily subclassable.
2158   - Improved option list spacing (thanks to Richard Jones).
2159   - Modified field list output.
2160   - Added backlinks to footnotes & citations.
2161   - Added percentage widths to "<col>" tags (from colspec).
2162   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2163     "<span>" changed to "<var>".
2164   - Inline literals: "<code>" changed to "<tt>".
2165   - Many changes to optimize vertical space: compact simple lists etc.
2166   - Add a command-line options & directive attributes to control TOC
2167     and footnote/citation backlinks.
2168   - Added support for optional footnote/citation backlinks.
2169   - Added support for generic bibliographic fields.
2170   - Identify backrefs.
2171   - Relative URLs for stylesheet links.
2173 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2174   PEPs (subclass of ``html4css1.Writer``).
2176 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2178 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2179   of the Docutils internal doctree in XML.
2181 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2183 * spec/doctree.txt:
2185   - Changed the title to "The Docutils Document Tree".
2186   - Added "Hyperlink Bookkeeping" section.
2188 * spec/docutils.dtd:
2190   - Added ``decoration``, ``header``, and ``footer`` elements.
2191   - Brought ``interpreted`` element in line with the parser: changed
2192     attribute "type" to "role", added "position".
2193   - Added support for generic bibliographic fields.
2195 * spec/notes.txt: Continual updates.  Added "Project Policies".
2197 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
2198   section.
2200 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2202 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
2203   mailing list discussions.
2205 * spec/pep-0287.txt:
2207   - Renamed to "reStructuredText Docstring Format".
2208   - Minor edits.
2209   - Reworked Q&A as an enumerated list.
2210   - Converted to reStructuredText format.
2212 * spec/pysource.dtd:
2214   - Reworked structural elements, incorporating ideas from Tony Ibbs.
2216 * spec/pysource.txt: Removed from project.  Moved much of its contents
2217   to pep-0258.txt.
2219 * spec/rst/alternatives.txt:
2221   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2222   - Added "Inline External Targets" section.
2224 * spec/rst/directives.txt:
2226   - Added "backlinks" attribute to "contents" directive.
2228 * spec/rst/problems.txt:
2230   - Updated the Enumerated List Markup discussion.
2231   - Added new alternative table markup syntaxes.
2233 * spec/rst/reStructuredText.txt:
2235   - Clarified field list usage.
2236   - Updated enumerated list description.
2237   - Clarified purpose of directives.
2238   - Added ``-/:`` characters to inline markup's start string prefix,
2239     ``/`` to end string suffix.
2240   - Updated "Authors" bibliographic field behavior.
2241   - Changed "inline hyperlink targets" to "inline internal targets".
2242   - Added "simple table" syntax to supplement the existing but
2243     newly-renamed "grid tables".
2244   - Added cautions for anonymous hyperlink use.
2245   - Added "Dedication" and generic bibliographic fields.
2247 * test: Made test modules standalone (subdirectories became packages).
2249 * test/DocutilsTestSupport.py:
2251   - Added support for PEP extensions to reStructuredText.
2252   - Added support for simple tables.
2253   - Refactored naming.
2255 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2257   - Now supports true packages containing test modules
2258     (``__init__.py`` files required); fixes duplicate module name bug.
2260 * test/test_pep/: Subpackage added to project; PEP testing.
2262 * test/test_rst/test_SimpleTableParser.py: Added to project.
2264 * tools:
2266   - Updated html.py and publish.py front-end tools to use the new
2267     command-line processing facilities of ``docutils.frontend``
2268     (exposed in ``docutils.core.Publisher``), reducing each to just a
2269     few lines of code.
2270   - Added ``locale.setlocale()`` calls to front-end tools.
2272 * tools/buildhtml.py: Added to project; batch-generates .html from all
2273   the .txt files in directories and subdirectories.
2275 * tools/default.css:
2277   - Added support for ``header`` and ``footer`` elements.
2278   - Added styles for "Dedication" topics (biblio fields).
2280 * tools/docutils.conf: A configuration file; added to project.
2282 * tools/docutils-xml.py: Added to project.
2284 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2286 * tools/pep-html-template: Added to project.
2288 * tools/pep2html.py: Added to project from Python (nondist/peps).
2289   Added support for Docutils (reStructuredText PEPs).
2291 * tools/quicktest.py:
2293   - Added the ``--attributes`` option, hacked a bit.
2294   - Added a second command-line argument (output file); cleaned up.
2296 * tools/stylesheets/: Subdirectory added to project.
2298 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2301 Release 0.1 (2002-04-20)
2302 ========================
2304 This is the first release of Docutils, merged from the now inactive
2305 reStructuredText__ and `Docstring Processing System`__ projects.  For
2306 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2307 `DPS HISTORY`__ files.
2309 __ http://structuredtext.sourceforge.net/
2310 __ http://docstring.sourceforge.net/
2311 __ http://structuredtext.sourceforge.net/HISTORY.html
2312 __ http://docstring.sourceforge.net/HISTORY.html
2314 General changes: renamed 'dps' package to 'docutils'; renamed
2315 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2316 the test suites (reStructuredText's test/test_states renamed to
2317 test/test_rst); and all modifications required to make it all work.
2319 * docutils/parsers/rst/states.py:
2321   - Improved diagnostic system messages for missing blank lines.
2322   - Fixed substitution_reference bug.
2326    Local Variables:
2327    mode: indented-text
2328    indent-tabs-mode: nil
2329    sentence-end-double-space: t
2330    fill-column: 70
2331    End: