1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
20 * docutils/languages/he.py: Added to project: Hebrew mappings by
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
30 - Paths of applied configuration files are now recorded in the
31 runtime setting ``_config_files`` (accessible via
33 - Added ``--strip-elements-with-class`` and ``--strip-class``
34 options (``strip_elements_with_classes`` and ``strip_classes``
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.
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
54 - Added support for unicode bullets in bullet lists: "•", "‣", and
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
61 * docutils/parsers/rst/__init__.py:
63 - Added ``Directive`` base class.
64 - Added ``DirectiveError`` base class.
65 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
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/parsers/directives/misc.py:
76 - Added ``start-after`` and ``end-before`` options to ``include``
77 directive; thanks to Stefan Rank.
79 * docutils/transforms/universal.py:
81 - Added ``StripClassesAndElements`` transform to remove from the
82 document tree all elements with classes in
83 ``settings.strip_elements_with_classes`` and all "classes"
84 attribute values in ``self.document.settings.strip_classes``.
86 * docutils/transforms/writer_aux.py:
88 - Added ``Admonitions`` transform to transform specific admonitions
89 (like ``note``, ``warning``, etc.) into generic admonitions with a
92 * docutils/writers/html4css1/__init__.py:
94 - Moved template functionality from the PEP/HTML writer here.
95 - Expanded the fragments available in the ``parts`` attribute.
96 - Moved ``id`` attributes from titles to surrounding ``div``
98 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
99 universally supported now).
100 - ``template.txt`` is now opened in text mode instead of binary mode
101 (to ensure Windows compatibility).
102 - ``a`` elements now have an "internal" or "external" class,
103 depending on reference type.
105 * docutils/writers/html4css1/template.txt: Added to project.
107 * docutils/writers/pep_html/:
109 - Moved template functionality to the HTML writer.
111 * docutils/writers/s5_html/__init__.py:
113 - Added ``view_mode`` & ``hidden_controls`` settings
114 (``--view-mode`` & ``--hidden-controls/--visible-controls``
117 * docutils/writers/latex2e/__init__.py:
119 - Add table stubs support (boldfont).
120 - Add assemble_parts to writer.
121 - Add simply support for nested tables.
122 - Fix verbatim in tables if use-verbatim-when-possible.
123 - Use section commands down to subparagraph.
124 - Put ensuremath around some latin1 chars.
125 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
126 - New option ``--use-bibtex=style,db1,db2``.
127 - New option ``--reference-label`` to allow usage of LaTeX ref for
128 labels in section references.
129 - Add a label after every section to support sectionnumbers as reference
131 - Fix: bug# 1605376 rst2latex: bad options group list
132 - Remove inactive code for use_optionlist_for_option_list.
133 - Remove latex comments from option_list output.
134 - Fix: bug# 1612270 double qoutes in italian literal.
135 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
136 - Add option --use-latex-abstract.
137 - Image width unit ``px`` is translated to ``pt``.
138 - Add image height support.
139 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
141 - Fix: Do not escape underscores in citation reference labels if
142 use-latex-citations is set.
143 - Use centering instead of center for figure contents, to avoid vertical
145 - Recognize table class: borderless, nolines, booktabs, standard.
146 - Fix: Renaming contents section does not work with latex writer; SF
148 - Applied patch for custom roles with classes from Edward Loper.
149 - Fixed bug that caused crashes with more than 256 lists.
151 * docutils/writers/pep_html/__init__.py:
153 - Changed to support new python.org website structure and
156 * docs/howto/security.txt: "Deploying Docutils Securely", added to
159 * tools/buildhtml.py:
161 -- Added ``ignore`` setting to exclude a list of shell patterns
162 (default: ``.svn:CVS``).
164 * tools/editors/emacs/rst.el:
166 - Changed license to "GPL".
167 - Added ``rst-straighten-decorations`` function.
168 - The ``compile`` module is now always loaded.
169 - Added ``rst-toggle-line-block`` function.
170 - Headings consisting only of non-ASCII characters are now
171 recognized by ``rst-toc`` and ``rst-adjust``.
172 - Added font-lock support for multi-line comments where the first
173 comment line is empty.
174 - Added ``(require 'font-lock)``.
178 - Provide descriptive error message if distutils is missing.
181 Release 0.4 (2006-01-09)
182 ========================
186 - Updated the project policies for trunk/branch development &
189 * docutils/__init__.py:
191 - Added ``__version_details__`` attribute to describe code source
192 (repository/snapshot/release).
193 - Replaced ``default_transforms`` attribute of TransformSpec with
194 ``get_transforms()`` method.
198 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
199 functions, for document tree extraction and reprocessing.
203 - Added ``DocTreeInput`` class, for reprocessing existing documents.
204 - Added support for non-Unicode (e.g. binary) writer output.
208 - Re-introduced ``Targetable.indirect_reference_name``, for
209 MoinMoin/reST compatibility (removed in r3124/r3129).
210 - Added ``serial_escape`` function; escapes string values that are
211 elements of a list, for serialization. Modified Docutils-XML
212 writing (``Element._dom_node``) and pseudo-XML writing
213 (``Element.starttag``) to use ``serial_escape``.
214 - Added ``Node.deepcopy()`` method.
215 - Removed the internal lists ``document.substitution_refs``,
216 ``document.anonymous_refs``, and ``document.anonymous_targets``.
217 - Added a "container" element.
218 - Fixed bug where values of list-valued attributes of elements
219 originating from custom interpreted text roles (i.e., with custom
220 classes) were being shared between element instances. Reported by
223 * docutils/statemachine.py:
225 - Added trailing whitespace stripping to ``string2lines()``.
226 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
227 Asian double-width character support.
231 - Added ``east_asian_column_width()`` for double-width character
234 * docutils/languages/ja.py: Added to project: Japanese mappings by
237 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
238 mappings by Panjunyong.
240 * docutils/parsers/null.py: Added to project; a do-nothing parser.
242 * docutils/parsers/rst/__init__.py:
244 - Added validator to tab_width setting, with test. Closes SF bug
245 #1212515, report from Wu Wei.
247 * docutils/parsers/rst/states.py:
249 - Fixed bug with escaped colons indicating a literal block.
250 - Fixed bug with enumerated lists (SF#1254145).
251 - Backslash-escaped colons inside of field names are now allowed.
252 - Targets (implicit and explicit), anonymous hyperlink references
253 and auto-numbered footnote references inside of substitution
254 definitions are now disallowed.
255 - Fixed bug: list items with blank first lines.
256 - Fixed bug: block quote attributions with indented second lines.
257 - Added East Asian double-width character support (Python 2.4 only).
259 * docutils/parsers/rst/tableparser.py:
261 - Added East Asian double-width character support (Python 2.4 only).
263 * docutils/parsers/rst/directives/body.py:
265 - Added the "container" directive.
267 * docutils/parsers/rst/directives/misc.py:
269 - Added the "default-role", "title", and "date" directives.
270 - Added standard data file syntax to the "include" directive.
271 - Added support for "class" directive content.
273 * docutils/parsers/rst/directives/images.py:
275 - Added ``indirect_reference_name`` support for images with a target
277 - Added support for image width and height units.
278 - Fixed bug with image "target" options.
280 * docutils/parsers/rst/directives/references.py:
282 - Added "class" attribute to "target-notes" directive, for
283 footnote_reference classes.
285 * docutils/parsers/rst/include/: Directory added to project; contains
286 standard data files for the "include" directive. Initial contents:
287 character entity substitution definition sets, and a set of
288 definitions for S5/HTML presentations.
290 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
291 mappings by David Goodger.
293 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
294 Simplified Chinese mappings by Panjunyong.
296 * docutils/readers/__init__.py:
298 - Added universal.Decorations and universal.ExposeInternals
299 transforms as default transforms for all readers.
300 - Added ``ReReader`` base class for readers that reread an existing
303 * docutils/readers/doctree.py: Added to project; a reader for existing
306 * docutils/transforms/frontmatter.py:
308 - Fixed the DocInfo transform to handle SVN-style expansion of the
310 - In ``DocInfo.extract_authors``, treat the contents of "authors"
313 * docutils/transforms/misc.py:
315 - Added misc.Transitions transform, extracted from
316 universal.FinalChecks.
318 * docutils/transforms/references.py:
320 - Added references.DanglingReferences transform, extracted from
321 universal.FinalChecks.
322 - Fixed bug with doubly-indirect substitutions.
323 - Added footnote_reference classes attribute to "TargetNotes".
324 - Fixed bug with circular substitution definitions that put Docutils
325 into an infinite loop.
327 * docutils/transforms/universal.py:
329 - Added universal.ExposeInternals transform, extracted from
330 universal.FinalChecks.
331 - Removed universal.FinalChecks transform (logic has been moved to
332 several new transforms).
333 - Fixed bug with the "expose_internals" setting and Text nodes
334 (exposed by the "rawsource" internal attribute).
335 - Added the universal.StripComments transform, implementation of the
336 "strip_comments" setting.
338 * docutils/transforms/writer_aux.py: Added to project; auxiliary
339 transforms for writers.
341 - Added ``Compound`` transform, which flattens compound paragraphs.
343 * docutils/writers/: Several writer modules (html4css1.py) were
344 converted into packages. Support modules and data files have been
345 moved into the packages. The stylesheets for the HTML writers are
346 now installed along with the code, the code knows where to find
347 them, and the default is to use them (actually, to embed them).
348 Some adjustments to configuration files may be necessary. The
349 easiest way to obtain the new default behavior is to remove all
350 settings whose name includes "stylesheet".
352 * docutils/writers/__init__.py:
354 - Added universal.Messages and universal.FilterMessages transforms
355 as default transforms for all writers.
356 - Added ``UnfilteredWriter`` base class for writers that pass the
357 document tree on unchanged.
359 * docutils/writers/docutils_xml.py:
361 - Made ``xmlcharrefreplace`` the default output encoding error
364 * docutils/writers/html4css1/:
366 - Added support for image width and height units.
367 - Made ``xmlcharrefreplace`` the default output encoding error
369 - Made ``--embed-stylesheet`` the default rather than
370 ``--link-stylesheet``.
371 - Moved "id" attribute from container (section etc.) to title's <a>
372 tag, to be on the same tag as "name".
373 (!!! To be reverted in Docutils 0.5.)
374 - Added vertical space between fields of field lists.
375 - Added ``--compact-field-lists`` option to remove vertical space in
377 - Made cloaking of email addresses with ``--cloak-email-addresses``
379 - Fixed support for centered images.
380 - Added support for class="compact" & class="open" lists.
382 * docutils/writers/latex2e/:
384 - Underscores in citekeys are no longer escaped.
386 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
387 mapping of Unicode characters to LaTeX equivalents.
389 * docutils/writers/s5_html/: Package added to project; writer for
392 * docs/dev/distributing.txt: Added to project; guide for distributors
393 (package maintainers).
395 * docs/dev/hacking.txt: Added to project; guide for developers.
397 * docs/ref/doctree.txt:
399 - Updated for plural attributes "classes", "ids", "names",
401 - Added the "container" element.
403 * docs/ref/docutils.dtd:
405 - Updated for plural attributes "classes", "ids", "names",
408 * docs/user/emacs.txt: Added to project; a document about Emacs
409 support for reStructuredText and Docutils.
411 * docs/user/links.txt: Added to project; lists of Docutils-related
414 * docs/user/mailing-lists.txt: Added to project; information about
415 Docutils-related mailing lists and how to access them.
417 * docs/user/slide-shows.txt: Added to project; example of and docs for
418 the S5/HTML writer (``rst2s5.py`` front end).
420 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
421 Files", added to project.
423 * test/coverage.sh: Added to project; test coverage script.
425 * test/DocutilsTestSupport.py:
427 - Added support for specifying runtime settings at the suite level.
429 * test/test_functional.py:
431 - Added the ``clear_output_directory`` function.
432 - Added support for ``_test_more`` functions in functional test
435 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
437 * tools/rstpep2html.py: Renamed from pep.py.
439 * tools/dev/create_unimap.py: Added to project; script to create the
440 docutils/writers/unimap_latex.py mapping file.
442 * tools/dev/profile_docutils.py: Added to project; profiler script.
444 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
446 * tools/editors/emacs/restructuredtext.el,
447 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
448 Removed from project; the functionality is now contained in rst.el.
450 * tools/editors/emacs/rst.el: Added to project. Added many features
451 and fixed many bugs. See docs/user/emacs.txt for details.
453 * tools/stylesheets: Removed from project. Stylesheets have been
454 renamed and moved into writer packages.
457 Release 0.3.9 (2005-05-26)
458 ==========================
462 - Eliminated and replaced all uses of the old string attributes
463 ``id``, ``name``, ``dupname`` and ``class`` with references to the
464 new list attributes ``ids``, ``names``, ``dupnames`` and
465 ``classes`` throughout the whole source tree.
469 - Enabled ``--dump-*`` options when ``--traceback`` specified,
470 allowing for easier debugging.
471 - In ``Publisher.publish()``, expanded the generic top-level
474 * docutils/examples.py:
476 - Added ``internals`` function for exploration.
480 - Fixed ``Input.decode`` method to apply heuristics only if no
481 encoding is explicitly given, and to provide better reporting of
483 - The ``Input.decode`` method now removes byte order marks (BOMs)
488 - ``image`` element class changed to subclass of Element, not
489 TextElement (it's an empty element, and cannot contain text).
490 - Added ``attr_defaults`` dictionary for default attribute values.
491 - Added empty list as default value for the following attributes:
492 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
493 - Added ``document.decoration`` attribute,
494 ``document.get_decoration`` method, and ``decoration.get_header``
495 & ``.get_footer`` methods.
496 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
501 - Removed ``docutils.utils.Reporter.categories``,
502 ``docutils.utils.ConditionSet``, and all references to them, to
503 simplify error reporting.
505 * docutils/languages/nl.py: Added to project; Dutch mappings by
508 * docutils/parsers/rst/__init__.py:
510 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
512 * docutils/parsers/rst/states.py:
514 - Added check for escaped at-mark to prevent email address recognition.
515 - Fixed option lists to allow spaces inside ``<angle-bracketed option
517 - Allowed whitespace in paths and URLs.
518 - Added auto-enumerated list items.
519 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
521 - Added support for table stub columns.
523 * docutils/parsers/rst/directives/__init__.py:
525 - Allowed whitespace in paths (``path`` function).
526 - Added ``uri`` directive option conversion function.
528 * docutils/parsers/rst/directives/body.py:
530 - Fixed illegal context bug with "topic" directive (allowed within
531 sidebars; not within body elements).
533 * docutils/parsers/rst/directives/images.py:
535 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
536 - Added support for the ``file_insertion_enabled`` setting in the
537 "figure" directive (disables "figwidth" option).
538 - "image" directive: added checks for valid values of "align" option,
539 depending on context. "figure" directive: added specialized
540 "align" option and attribute on "figure" element.
541 - Made ":figwidth: image" option of "figure" directive work again.
542 - Fixed bug with reference names containing uppercase letters
543 (e.g. ``Name_``) in "target" option of "image" directive.
545 * docutils/parsers/rst/directives/misc.py:
547 - Fixed "include" and "raw" directives to catch text decoding
549 - Allowed whitespace in "include" & "raw" directive paths.
550 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
551 settings in "include" & "raw" directives.
553 * docutils/parsers/rst/directives/parts.py:
555 - Added "header" & "footer" directives.
556 - Fixed illegal context bug with "contents" directive (topics
557 allowed within sidebars; not within body elements).
559 * docutils/parsers/rst/directives/tables.py:
561 - Added "list-table" directive.
562 - Caught empty CSV table bug.
563 - Added support for the ``file_insertion_enabled`` setting in the
564 "csv-table" directive.
565 - Added ``stub-columns`` option to "csv-table" and "list-table"
568 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
569 mappings by Martijn Pieters.
571 * docutils/readers/standalone.py:
573 - Added ``--section-subtitles`` and ``--no-section-subtitles``
574 options to activate or deactivate the SectSubTitle transform.
576 * docutils/transforms/frontmatter.py:
578 - Added SectSubTitle transform to promote titles of lone
579 subsections to subtitles.
581 * docutils/transforms/references.py:
583 - Fixed mislocated internal targets bug, by propagating internal
584 targets to the next node, making use of the newly added support
585 for multiple names and IDs.
586 - Fixed duplicate footnote label bug.
587 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
590 * docutils/writers/html4css1.py:
592 - Fixed unencoded stylesheet reference bug (characters like "&" in
593 stylesheet references).
594 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
596 - Added support for multiple IDs per node by creating empty ``span``
598 - Added the ``field_name_limit`` & ``option_limit`` settings &
600 - Added support for table stub columns.
601 - Added support for the ``align`` attribute on ``figure`` elements.
602 - Added the ``cloak_email_addresses`` setting & support.
603 - Added ``html_prolog``, ``html_head``, ``html_body``,
604 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
605 ``docutils.core.publish_parts``.
606 - Added support for section subtitles.
608 * docutils/writers/latex2e.py:
610 - Fixed tables starting with more than one multirow cell.
611 - Improved --use-latex-docinfo so that organization/contact/address
612 fields are lumped with the last author field and appear on the
614 - Made sure the titlepage is always shown with --use-latex-docinfo,
615 even if the document has no title.
616 - Made sure that latex doesn't fill in today's date if no date field
618 - Added support for section subtitles.
620 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
623 * docutils/writers/null.py: Added to project; a do-nothing Writer.
625 * docs/api/publisher.txt:
627 - Added "``publish_parts`` Details" section.
629 * docutils/dev/repository.txt: Added to project; information about the
630 Docutils Subversion repository.
632 * docs/ref/docutils.dtd:
634 - Added a ``stub`` attribute to the ``colspec`` element via the
635 ``tbl.colspec.att`` parameter entity.
636 - Allowed topic elements within sidebars
637 - Added an ``align`` attribute to the ``figure`` element.
639 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
643 Release 0.3.7 (2004-12-24)
644 ==========================
646 * docutils/frontend.py:
648 - Added options: --input-encoding-error-handler,
649 --record-dependencies, --leave-footnote-reference-space,
651 - Added command-line and config file support for "overrides" setting
656 - Added support for input encoding error handler.
660 - Added dispatch_visit and dispatch_departure methods to
661 NodeVisitor; useful as a hook for Visitors.
662 - Changed structure of ``line_block``; added ``line``.
663 - Added ``compound`` node class.
664 - Added a mechanism for Visitors to transitionally ignore new node
669 - Moved ``escape2null`` and ``unescape`` functions from
670 docutils/parsers/rst/states.py.
672 * docutils/parsers/rst/roles.py:
675 - Changed role function API: the "text" parameter now takes
676 null-escaped interpreted text content.
678 * docutils/parsers/rst/states.py:
680 - Fixed bug where a "role" directive in a nested parse would crash
681 the parser; the state machine's "language" attribute was not being
683 - Added support for line block syntax.
684 - Fixed directive parsing bug: argument-less directives didn't
685 notice that arguments were present.
686 - Removed error checking for transitions.
687 - Added support for multiple classifiers in definition list items.
688 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
689 - Changed role function API: the "text" parameter now takes
690 null-escaped interpreted text content.
691 - Empty sections and documents are allowed now.
693 * docutils/parsers/rst/directives/__init__.py:
695 - Added ``encoding`` directive option conversion function.
696 - Allow multiple class names in class_option conversion function.
698 * docutils/parsers/rst/directives/body.py:
700 - Converted the line-block directive to use the new structure.
701 - Extracted the old line-block functionality to the ``block``
702 function (still used).
703 - Added ``compound`` directive (thanks to Felix Wiemann).
705 * docutils/parsers/rst/directives/misc.py:
707 - Added "encoding" option to "include" and "raw" directives.
708 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
709 - Allow multiple class names in the "class" directive.
711 * docutils/parsers/rst/directives/parts.py:
713 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
714 options. Thanks to Lele Gaifax.
716 * docutils/parsers/rst/directives/tables.py:
718 - Added "encoding" directive to "csv-table" directive.
719 - Added workaround for lack of Unicode support in csv.py, for
722 * docutils/transforms/misc.py:
724 - Fixed bug when multiple "class" directives are applied to a single
726 - Enabled multiple format names for "raw" directive.
728 * docutils/transforms/references.py:
730 - Added support for trimming whitespace from beside substitution
733 * docutils/transforms/universal.py:
735 - FinalChecks now checks for illegal transitions and moves
736 transitions between sections.
738 * docutils/writers/html4css1.py:
740 - HTMLTranslator.encode now converts U+00A0 to " ".
741 - "stylesheet" and "stylesheet_path" settings are now mutually
743 - Added support for the new line_block/line structure.
744 - --footnote-references now overrides
745 --trim-footnote-reference-space, if applicable.
746 - Added support for ``compound`` elements.
747 - Enabled multiple format names for "raw" directive.
748 - ``<p>`` tags of a paragraph which is the only visible child of the
749 document node are no longer stripped.
750 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
751 new method ``should_be_compact_paragraph()``.
752 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
754 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
755 the output if they have their ``class`` attribute set.
756 - The whole document is now surrounded by a ``<div
757 class="document">`` element.
758 - Body-level images are now wrapped by their own ``<div>`` elements,
759 with image classes copied to the wrapper, and for images which
760 have the ``:align:`` option set, the surrounding ``<div>`` now
761 receives a class attribute (like ``class="align-left"``).
763 * docutils/writers/latex2e.py:
765 - no newline after depart_term.
766 - Added translations for some Unicode quotes.
767 - Added option "font-encoding", made package AE the default.
768 - "stylesheet" and "stylesheet_path" settings are now mutually
770 - --footnote-references now overrides
771 --trim-footnote-reference-space, if applicable.
772 - The footnote label style now matches the footnote reference style
773 ("brackets" or "superscript").
774 - Added support for ``compound`` elements.
775 - Enabled multiple format names for "raw" directive.
777 * docs/ref/docutils.dtd:
779 - Changed structure of the ``line_block`` element; added ``line``.
780 - Added ``compound`` element.
781 - Added "ltrim" and "rtrim" attributes to
782 ``substitution_definition`` element.
783 - Enabled multiple format names for ``raw`` element.
784 - Enabled multiple classifiers in ``definition_list_item`` elements.
786 * docs/ref/rst/directives.txt
788 - Marked "line-block" as deprecated.
789 - "Class" directive now allows multiple class names.
790 - Added "Rationale for Class Attribute Value Conversion".
791 - Added warning about "raw" overuse/abuse.
793 * docs/ref/rst/restructuredtext.txt:
795 - Added syntax for line blocks.
796 - Definition list items may have multiple classifiers.
798 * docs/ref/rst/roles.txt:
802 * tools/stylesheets/default.css:
804 - Added support for the new line_block structure.
805 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
808 Release 0.3.5 (2004-07-29)
809 ==========================
813 * _`Documentation cleanup/reorganization`.
815 - Created new subdirectories of docs/:
817 * ``docs/user/``: introductory/tutorial material for end-users
818 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
819 * ``docs/api/``: API reference material for client-developers
820 * ``docs/ref/``: reference material for all groups
821 * ``docs/howto/``: for component-developers and core-developers
822 * ``docs/peps/``: Python Enhancement Proposals
824 - Moved ``docs/*`` to ``docs/user/``.
825 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
826 ``spec/`` to ``docs/dev``.
827 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
828 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
829 - Moved ``alternatives.txt``, and ``problems.txt`` from
830 ``spec/rst/`` to ``docs/dev/rst/``.
831 - Moved ``reStructuredText.txt``, ``directives.txt``,
832 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
833 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
834 ``roles.txt``, ``reStructuredText.txt`` to
835 ``restructuredtext.txt``.
836 - Moved ``spec/howto/`` to ``docs/howto``.
838 In order to keep the CVS history of moved files, we supplied
839 SourceForge with a `script for modifying the Docutils CVS
842 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
844 After running the cleanup script:
846 - Added ``docs/index.txt``.
847 - Added a ``.htaccess`` file to the ``web`` module, containing
848 redirects for all old paths to new paths. They'll preserve
849 fragments (the "#name" part of a URL), and won't clutter up the
850 file system, and will correct the URL in the user's browser.
851 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
852 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
853 the "To Do" list itself in ``docs/dev/todo.txt``.
854 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
855 section of ``docs/dev/todo.txt``.
856 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
857 - Added "How To Report Bugs" to ``BUGS.txt``.
858 - Went through all the sources and docs (including under web/) and
859 updated links. Mostly done by Felix Wiemann; thanks Felix!
860 (Still need to update links in the sandboxes.)
864 * BUGS.txt: Added to project.
866 * THANKS.txt: Added to project.
868 * docutils/__init__.py:
870 - 0.3.4: Post-release.
874 - Added special error handling & advice for UnicodeEncodeError.
875 - Refactored Publisher.publish (simplified exception handling &
876 extracted debug dumps).
877 - Renamed "enable_exit" parameter of convenience functions to
878 "enable_exit_status".
879 - Enabled traceback (exception propagation) by default in
880 programmatic convenience functions.
881 - Now publish_file and publish_cmdline convenience functions return
882 the encoded string results in addition to their regular I/O.
883 - Extracted common code from publish_file, publish_string, and
884 publish_parts, into new publish_programmatically. Extracted
885 settings code to ``Publisher.process_programmatic_settings``.
886 - In Publisher.publish, disabled ``settings_overrides`` when
887 ``settings`` is supplied; redundant.
889 * docutils/frontend.py:
891 - Added help text for "--output-encoding-error-handler" and
892 "--error-encoding-error-handler".
893 - Renamed "--exit" to "--exit-status".
894 - Simplified default-setting code.
896 * docutils/parsers/rst/__init__.py:
898 - Added "--pep-base-url" and "--rfc-base-url" options.
900 * docutils/parsers/rst/states.py:
902 - Made URI recognition more aggressive and intelligent.
904 * docutils/parsers/rst/directives/__init__.py:
906 - Added several directive option conversion functions.
908 * docutils/parsers/rst/directives/body.py:
910 - Moved "table" directive to tables.py.
912 * docutils/parsers/rst/directives/tables.py: Table-related directives,
915 * docutils/writers/latex2e.py:
917 - Added "--table-style=(standard|booktabs|nolines)"
918 - figures get "here" option (LaTeX per default puts them at bottom),
919 and figure content is centered.
920 - Rowspan support for tables.
921 - Fix: admonition titles before first section.
922 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
923 - Replave ``_`` in literal by an underlined blank, because it has the correct
925 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
926 - A few unicode replacements, if output_encoding != utf
927 - Add "--graphicx-option".
928 - Indent literal-blocks.
929 - Fix: omit ``\maketitle`` when there is no document title.
931 * docs/index.txt: "Docutils Project Documentation Overview", added to
934 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
935 Tool", added to project.
937 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
939 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
941 * docs/dev/policies.txt: Added to project (extracted from
942 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
944 * docs/dev/release.txt: Added to project (extracted from
945 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
947 * docs/dev/testing.txt: Added to project.
949 * docs/dev/website.txt: Added to project (extracted from
950 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
952 * docs/ref/rst/directives.txt:
954 - Added directives: "table", "csv-table".
956 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
957 added to project. 1 page for syntax, and a 1 page reference for
958 directives and roles. Source text to be used as-is; not meant to be
961 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
962 with a change of title.
964 * test/functional/, contents, and test/test_functional.py: Added to
967 * tools/buildhtml.py: Fixed bug with config file handling.
969 * tools/html.py: Removed from project (duplicate of rst2html.py).
971 * tools/pep2html.py: Removed from project (duplicate of Python's
972 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
973 Docutils-related PEPs in docs/peps/).
975 * tools/rst2pseudoxml.py: Renamed from publish.py.
977 * tools/rst2xml.py: Renamed from docutils-xml.py.
979 * tools/test.txt: Removed from project; moved to
980 docs/user/rst/demo.txt.
982 * setup.py: Now also installs ``rst2latex.py``.
985 Release 0.3.3 (2004-05-09)
986 ==========================
988 * docutils/__init__.py:
990 - 0.3.1: Reorganized config file format (multiple sections); see
992 - Added unknown_reference_resolvers attribute to TransformSpec.
993 - 0.3.2: Interpreted text reorganization.
998 - Catch system messages to stop tracebacks from parsing errors.
999 - Catch exceptions during processing report & exit without
1000 tracebacks, except when "--traceback" used.
1001 - Reordered components for OptionParser; application comes last.
1002 - Added "config_section" parameter to several methods and functions,
1003 allowing front ends to easily specify their config file sections.
1004 - Added publish_parts convenience function to allow access to individual
1005 parts of a document.
1007 * docutils/examples.py: Added to project; practical examples of
1008 Docutils client code, to be used as-is or as models for variations.
1010 * docutils/frontend.py:
1012 - Added "--traceback" & "--no-traceback" options ("traceback"
1014 - Implemented support for config file reorganization:
1015 ``standard_config_files`` moved from ``ConfigParser`` to
1016 ``OptionParser``; added
1017 ``OptionParser.get_config_file_settings()`` and
1018 ``.get_standard_config_settings()``; support for old "[options]"
1019 section (with deprecation warning) and mapping from old to new
1021 - Reimplemented setting validation.
1022 - Enabled flexible boolean values: yes/no, true/false, on/off.
1023 - Added ``Values``, a subclass of ``optparse.Values``, with support
1024 for list setting attributes.
1025 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1026 thanks to Beni Cherniavsky.
1027 - Added "--no-section-numbering" option.
1031 - Catch IOErrors when opening source & destination files, report &
1032 exit without tracebacks. Added ``handle_io_errors`` parameter to
1033 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1035 * docutils/nodes.py:
1037 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1038 method definitions (via ``exec``) to dynamic assignments (via
1039 ``setattr``); thanks to Roman Suzi.
1040 - Encapsulated visitor dynamic assignments in a function; thanks to
1042 - Added indirect_reference_name attribute to the Targetable
1043 class. This attribute holds the whitespace_normalized_name
1044 (contains mixed case) of a target.
1046 * docutils/statemachine.py:
1048 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1049 - Added ``StringList.get_2D_block``.
1051 * docutils/utils.py:
1053 - Added "level" attribute to SystemMessage exceptions.
1055 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1058 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1061 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1062 Marcelo Huerta San Martin.
1064 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1065 mappings by Lalo Martins.
1067 * docutils/languages/ru.py: Added to project; Russian mappings by
1070 * docutils/parsers/rst/roles.py: Added to project. Contains
1071 interpreted text role functions, a registry for interpreted text
1072 roles, and an API for adding to and retrieving from the registry.
1073 Contributed by Edward Loper.
1075 * docutils/parsers/rst/states.py:
1077 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1078 - Allowed true em-dash character and "---" as block quote
1080 - Added support for <angle-bracketed> complex option arguments
1082 - Fixed handling of backslashes in substitution definitions.
1083 - Fixed off-by-1 error with extra whitespace after substitution
1084 definition directive.
1085 - Added inline markup parsing to field lists' field names.
1086 - Added support for quoted (and unindented) literal blocks.
1087 Driven in part by a bribe from Frank Siebenlist (thanks!).
1088 - Parser now handles escapes in URIs correctly.
1089 - Made embedded-URIs' reference text omittable. Idea from Beni
1091 - Refactored explicit target processing code.
1092 - Added name attribute to references containing the reference name only
1093 through whitespace_normalize_name (no case changes).
1094 - parse_target no longer returns the refname after going through
1095 normalize_name. This is now handled in make_target.
1096 - Fixed bug relating to role-less interpreted text in non-English
1098 - Reorganized interpreted text processing; moved code into the new
1099 roles.py module. Contributed by Edward Loper.
1100 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1101 ``parse_directive_block``.
1103 * docutils/parsers/rst/tableparser.py:
1105 - Reworked for ``StringList``, to support "include" directives in
1108 * docutils/parsers/rst/directives/__init__.py:
1110 - Renamed ``unchanged()`` directive option conversion function to
1111 ``unchanged_required``, and added a new ``unchanged``.
1112 - Catch unicode value too high error; fixes bug 781766.
1113 - Beefed up directive error reporting.
1115 * docutils/parsers/rst/directives/body.py:
1117 - Added basic "table" directive.
1119 * docutils/parsers/rst/directives/images.py:
1121 - Added "target" option to "image" directive.
1122 - Added name attribute to references containing the reference name only
1123 through whitespace_normalize_name (no case changes).
1125 * docutils/parsers/rst/directives/misc.py:
1127 - Isolated the import of the ``urllib2`` module; was causing
1128 problems on SourceForge (``libssl.so.2`` unavailable?).
1129 - Added the "role" directive for declaring custom interpreted text
1132 * docutils/parsers/rst/directives/parts.py:
1134 - The "contents" directive does more work up-front, creating the
1135 "topic" and "title", and leaving the "pending" node for the
1136 transform. Allows earlier reference resolution; fixes subtle bug.
1138 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1139 mappings by Jannie Hofmeyr.
1141 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1142 mappings by Marek Blaha.
1144 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1145 mappings by Marcelo Huerta San Martin.
1147 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1148 Portuguese mappings by Lalo Martins.
1150 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1151 mappings by Roman Suzi.
1153 * docutils/transforms/parts.py:
1155 - The "contents" directive does more work up-front, creating the
1156 "topic" and "title", and leaving the "pending" node for the
1157 transform. Allows earlier reference resolution; fixes subtle bug.
1158 - Added support for disabling of section numbering.
1160 * docutils/transforms/references.py:
1162 - Verifying that external targets are truly targets and not indirect
1163 references. This is because we are now adding a "name" attribute to
1164 references in addition to targets. Note sure if this is correct!
1165 - Added code to hook into the unknown_reference_resolvers list for a
1166 transformer in resolve_indirect_target. This allows the
1167 unknown_reference_resolvers to keep around indirect targets which
1168 docutils doesn't know about.
1169 - Added specific error message for duplicate targets.
1171 * docutils/transforms/universal.py:
1173 - Added FilterMessages transform (removes system messages below the
1174 verbosity threshold).
1175 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1176 to FinalCheckVisitor for application-specific handling of
1177 unresolvable references.
1178 - Added specific error message for duplicate targets.
1180 * docutils/writers/__init__.py:
1182 - Added assemble_parts method to the Writer class to allow for
1183 access to a documents individual parts.
1184 - Documented & set default for ``Writer.output`` attribute.
1186 * docutils/writers/html4css1.py:
1188 - Fixed unicode handling of attribute values (bug 760673).
1189 - Prevent duplication of "class" attribute values (bug report from
1191 - Improved table grid/border handling (prompted by report from Bob
1193 - Added support for table titles.
1194 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1196 - Added functionality to keep track of individual parts of a document
1197 and store them in a dictionary as the "parts" attribute of the writer.
1198 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1199 - Added proper support for the "scale" attribute of the "image"
1200 element. Contributed by Brent Cook.
1201 - Added ``--initial-header-level`` option.
1202 - Fixed bug: the body_pre_docinfo segment depended on there being a
1203 docinfo; if no docinfo, the document title was incorporated into
1204 the body segment. Adversely affected the publish_parts interface.
1206 * docutils/writers/latex2e.py:
1208 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1209 about a missing file.
1210 - Added options and support: ``--compound-enumerators``,
1211 ``--section-prefix-for-enumerators``, and
1212 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1214 - Added option ``--use-verbatim-when-possible``, to avoid
1215 problematic characters (eg, '~' in italian) in literal blocks.
1216 - It's now possible to use four section levels in the `book` and
1217 `report` LaTeX classes. The default `article` class still has
1220 * docs/config.txt: "Docutils Configuration Files", added to project.
1221 Moved config file entry descriptions from tools.txt.
1225 - Moved config file entry descriptions to config.txt.
1227 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1230 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1231 Text Roles", added to project.
1233 * spec/rst/reStructuredText.txt:
1235 - Added description of support for <angle-bracketed> complex option
1236 arguments to option lists.
1237 - Added subsections for indented and quoted literal blocks.
1239 * test: Continually adding & updating tests.
1241 - Added test/test_settings.py & test/data/config_*.txt support
1243 - Added test/test_writers/test_htmlfragment.py.
1245 * test/DocutilsTestSupport.py:
1247 - Refactored LaTeX publisher test suite/case class names to make
1248 testing other writers easier.
1249 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1250 to test the processing of HTML fragments which use the new
1251 publish_parts convenience function.
1253 * tools/buildhtml.py:
1255 - Added support for the "--prune" option.
1256 - Removed dependency on pep2html.py; plaintext PEPs no longer
1259 * tools/docutils.conf:
1261 - Updated for configuration file reorganization.
1263 * tools/rst2html.py:
1265 - copied from tools/html.py
1269 - added a 'scripts' section to configuration
1270 - added 'tools/rst2html.py' to the scripts section
1273 Release 0.3 (2003-06-24)
1274 ========================
1278 * Renamed "attribute" to "option" for directives/extensions.
1280 * Renamed transform method "transform" to "apply".
1282 * Renamed "options" to "settings" for runtime settings (as set by
1283 command-line options). Sometimes "option" (singular) became
1284 "settings" (plural). Some variations below:
1286 - document.options -> document.settings (stored in other objects as
1288 - option_spec -> settings_spec (not directives though)
1289 - OptionSpec -> SettingsSpec
1290 - cmdline_options -> settings_spec
1291 - relative_path_options -> relative_path_settings
1292 - option_default_overrides -> settings_default_overrides
1293 - Publisher.set_options -> Publisher.get_settings
1297 * COPYING.txt: Added "Public Domain Dedication".
1299 * FAQ.txt: Frequently asked questions, added to project.
1303 - Updated with PyPI Trove classifiers.
1304 - Conditional installation of third-party modules.
1306 * docutils/__init__.py:
1308 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1309 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1310 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1311 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1312 option and its effect on the PEP template & writer.
1313 - Bumped version to 0.2.4 due to changes to the PEP template &
1315 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1316 - Added ``TransformSpec`` class for new transform system.
1317 - Bumped version to 0.2.6 for API changes (renaming).
1318 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1319 convenience functions.
1320 - Added ``Component.component_type`` attribute.
1321 - Bumped version to 0.2.8 because of the internal parser switch from
1322 plain lists to the docutils.statemachine.StringList objects.
1323 - Bumped version to 0.2.9 because of the frontend.py API changes.
1324 - Bumped version to 0.2.10 due to changes to the project layout
1325 (third-party modules removed from the "docutils" package), and
1326 signature changes in ``io.Input``/``io.Output``.
1327 - Changed version to 0.3.0 for release.
1331 - Made ``publish()`` a bit more convenient.
1332 - Generalized ``Publisher.set_io``.
1333 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1334 parameters; improved its docstring.
1335 - Added ``publish_file()`` and ``publish_string()``.
1336 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1338 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1339 "--dump-transforms" hidden options.
1340 - Added ``Publisher.apply_transforms()`` method.
1341 - Added ``Publisher.set_components()`` method; support for
1342 ``publish_*()`` conveninece functions.
1343 - Moved config file processing to docutils/frontend.py.
1344 - Added support for exit status ("exit_level" setting &
1345 ``enable_exit`` parameter for Publisher.publish() and convenience
1348 * docutils/frontend.py:
1350 - Check for & exit on identical source & destination paths.
1351 - Fixed bug with absolute paths & "--config".
1352 - Set non-command-line defaults in ``OptionParser.__init__()``:
1353 ``_source`` & ``_destination``.
1354 - Distributed ``relative_path_settings`` to components; updated
1355 ``OptionParser.populate_from_components()`` to combine it all.
1356 - Require list of keys in ``make_paths_absolute`` (was implicit in
1357 global ``relative_path_settings``).
1358 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1359 "--dump-settings", and "--dump-transforms" hidden options.
1360 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1361 code, replaced with correct code.
1362 - Added validation functionality for config files.
1363 - Added "--error-encoding" option/setting, "_disable_config"
1365 - Added encoding validation; updated "--input-encoding" and
1366 "--output-encoding"; added "--error-encoding-error-handler" and
1367 "--output-encoding-error-handler".
1368 - Moved config file processing from docutils/core.py.
1369 - Updated ``OptionParser.populate_from_components`` to handle new
1370 ``SettingsSpec.settings_defaults`` dict.
1371 - Added support for "-" => stdin/stdout.
1372 - Added "exit_level" setting ("--exit" option).
1376 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1377 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1378 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1379 - ``FileOutput.write()`` now returns the encoded output string.
1380 - Try to get path/stream name automatically in ``FileInput`` &
1382 - Added defaults for source & destination paths.
1383 - Allow for Unicode I/O with an explicit "unicode" encoding.
1384 - Added ``Output.encode()``.
1385 - Removed dependency on runtime settings; pass encoding directly.
1386 - Recognize Unicode strings in ``Input.decode()``.
1387 - Added support for output encoding error handlers.
1389 * docutils/nodes.py:
1391 - Added "Invisible" element category class.
1392 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1393 modification during a traversal.
1394 - Added element classes: ``line_block``, ``generated``, ``address``,
1395 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1396 ``superscript``, ``subscript``, ``inline``
1397 - Added support for lists of nodes to ``Element.insert()``.
1398 - Fixed parent linking in ``Element.replace()``.
1399 - Added new abstract superclass ``FixedTextElement``; adds
1400 "xml:space" attribute.
1401 - Added support for "line" attribute of ``system_message`` nodes.
1402 - Added support for the observer pattern from ``utils.Reporter``.
1403 Added ``parse_messages`` and ``transform_messages`` attributes to
1404 ``document``, removed ``messages``. Added ``note_parse_message``
1405 and ``note_transform_message`` methods.
1406 - Added support for improved diagnostics:
1408 - Added "document", "source", and "line" internal attributes to
1409 ``Node``, set by ``Node.setup_child()``.
1410 - Converted variations on ``node.parent = self`` to
1411 ``self.setup_child(node)``.
1412 - Added ``document.current_source`` & ``.current_line``
1413 attributes, and ``.note_source`` observer method.
1414 - Changed "system_message" output to GNU-Tools format.
1416 - Added a "rawsource" attribute to the ``Text`` class, for text
1417 before backslash-escape resolution.
1418 - Support for new transform system.
1419 - Reworked ``pending`` element.
1420 - Fixed XML DOM bug (SF #660611).
1421 - Removed the ``interpeted`` element class and added
1422 ``title_reference``, ``abbreviation``, ``acronym``.
1423 - Made substitutions case-sensitive-but-forgiving; moved some code
1425 - Fixed Unicode bug on element attributes (report: William Dode).
1427 * docutils/optik.py: Removed from project; replaced with
1428 extras/optparse.py and extras/textwrap.py. These will be installed
1429 only if they're not already present in the Python installation.
1431 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1432 only if it's not already present in the Python installation.
1434 * docutils/statemachine.py:
1436 - Factored out ``State.add_initial_transitions()`` so it can be
1438 - Converted whitespace-specific "blank" and "indent" transitions
1439 from special-case code to ordinary transitions: removed
1440 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1441 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1442 ``ws_initial_transitions`` attributes.
1443 - Removed ``State.match_transition()`` after merging it into
1445 - Added ``StateCorrection`` exception.
1446 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1447 (moved ``TransitionCorrection`` support there too.)
1448 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1449 ``EOFError`` instead of ``IndexError``.
1450 - Added ``State.no_match`` method.
1451 - Added support for the Observer pattern, triggered by input line
1453 - Added ``strip_top`` parameter to
1454 ``StateMachineWS.get_first_known_indented``.
1455 - Made ``context`` a parameter to ``StateMachine.run()``.
1456 - Added ``ViewList`` & ``StringList`` classes;
1457 ``extract_indented()`` becomes ``StringList.get_indented()``.
1458 - Added ``StateMachine.insert_input()``.
1459 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1460 thanks to) Fred Drake.
1462 * docutils/utils.py:
1464 - Added a ``source`` attribute to Reporter instances and
1465 ``system_message`` elements.
1466 - Added an observer pattern to ``utils.Reporter`` to keep track of
1468 - Fixed bugs in ``relative_path()``.
1469 - Added support for improved diagnostics.
1470 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1471 - Added support for encoding Reporter stderr output, and encoding
1473 - Reporter keeps track of the highest level system message yet
1476 * docutils/languages: Fixed bibliographic field language lookups.
1478 * docutils/languages/es.py: Added to project; Spanish mappings by
1479 Marcelo Huerta San Martin.
1481 * docutils/languages/fr.py: Added to project; French mappings by
1484 * docutils/languages/it.py: Added to project; Italian mappings by
1487 * docutils/languages/sk.py: Added to project; Slovak mappings by
1490 * docutils/parser/__init__.py:
1492 - Added ``Parser.finish_parse()`` method.
1494 * docutils/parser/rst/__init__.py:
1496 - Added options: "--pep-references", "--rfc-references",
1497 "--tab-width", "--trim-footnote-reference-space".
1499 * docutils/parsers/rst/states.py:
1501 - Changed "title under/overline too short" system messages from INFO
1502 to WARNING, and fixed its insertion location.
1503 - Fixed enumerated list item parsing to allow paragraphs & section
1504 titles to begin with enumerators.
1505 - Converted system messages to use the new "line" attribute.
1506 - Fixed a substitution reference edge case.
1507 - Added support for "--pep-references" and "--rfc-references"
1508 options; reworked ``Inliner`` code to make customization easier.
1509 - Removed field argument parsing.
1510 - Added support for short section title over/underlines.
1511 - Fixed "simple reference name" regexp to ignore text like
1512 "object.__method__"; not an anonymous reference.
1513 - Added support for improved diagnostics.
1514 - Reworked directive API, based on Dethe Elza's contribution. Added
1515 ``Body.parse_directive()``, ``.parse_directive_options()``,
1516 ``.parse_directive_arguments()`` methods.
1517 - Added ``ExtensionOptions`` class, to parse directive options
1518 without parsing field bodies. Factored
1519 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1520 ``ExtensionOptions``.
1521 - Improved definition list term/classifier parsing.
1522 - Added warnings for unknown directives.
1523 - Renamed ``Stuff`` to ``Struct``.
1524 - Now flagged as errors: transitions at the beginning or end of
1525 sections, empty sections (except title), and empty documents.
1526 - Updated for ``statemachine.StringList``.
1527 - Enabled recognition of schemeless email addresses in targets.
1528 - Added support for embedded URIs in hyperlink references.
1529 - Added backslash-escapes to inline markup end-string suffix.
1530 - Added support for correct interpreted text processing.
1531 - Fixed nested title parsing (topic, sidebar directives).
1532 - Added special processing of backslash-escaped whitespace (idea
1533 from David Abrahams).
1534 - Made substitutions case-sensitive-but-forgiving; moved some code
1535 to ``docutils.nodes``.
1536 - Added support for block quote attributions.
1537 - Added a kludge to work-around a conflict between the bubble-up
1538 parser strategy and short titles (<= 3 char-long over- &
1539 underlines). Fixes SF bug #738803 "infinite loop with multiple
1540 titles" submitted by Jason Diamond.
1541 - Added explicit interpreted text roles for standard inline markup:
1542 "emphasis", "strong", "literal".
1543 - Implemented "superscript" and "subscript" interpreted text roles.
1544 - Added initial support for "abbreviation" and "acronym" roles;
1546 - Added support for "--trim-footnote-reference-space" option.
1547 - Optional space before colons in directives & hyperlink targets.
1549 * docutils/parsers/rst/tableparser.py:
1551 - Fixed a bug that was producing unwanted empty rows in "simple"
1553 - Detect bad column spans in "simple" tables.
1555 * docutils/parsers/rst/directives: Updated all directive functions to
1558 * docutils/parsers/rst/directives/__init__.py:
1560 - Added ``flag()``, ``unchanged()``, ``path()``,
1561 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1562 directive option helper functions.
1563 - Added warnings for unknown directives.
1564 - Return ``None`` for missing directives.
1565 - Added ``register_directive()``, thanks to William Dode and Paul
1568 * docutils/parsers/rst/directives/admonitions.py:
1570 - Added "admonition" directive.
1572 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1573 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1574 "parsed-literal", "rubric", "epigraph", "highlights" and
1575 "pull-quote" directives.
1577 * docutils/parsers/rst/directives/images.py:
1579 - Added an "align" attribute to the "image" & "figure" directives
1580 (by Adam Chodorowski).
1581 - Added "class" option to "image", and "figclass" to "figure".
1583 * docutils/parsers/rst/directives/misc.py:
1585 - Added "include", "raw", and "replace" directives, courtesy of
1587 - Added "unicode" and "class" directives.
1589 * docutils/parsers/rst/directives/parts.py:
1591 - Added the "sectnum" directive; by Dmitry Jemerov.
1592 - Added "class" option to "contents" directive.
1594 * docutils/parsers/rst/directives/references.py: Added to project.
1595 Contains the "target-notes" directive.
1597 * docutils/parsers/rst/languages/__init__.py:
1599 - Return ``None`` from get_language() for missing language modules.
1601 * docutils/parsers/rst/languages/de.py: Added to project; German
1602 mappings by Engelbert Gruber.
1604 * docutils/parsers/rst/languages/en.py:
1606 - Added interpreted text roles mapping.
1608 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1609 mappings by Marcelo Huerta San Martin.
1611 * docutils/parsers/rst/languages/fr.py: Added to project; French
1612 mappings by William Dode.
1614 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1615 mappings by Nicola Larosa.
1617 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1618 mappings by Miroslav Vasko.
1620 * docutils/readers/__init__.py:
1622 - Added support for the observer pattern from ``utils.Reporter``, in
1623 ``Reader.parse`` and ``Reader.transform``.
1624 - Removed ``Reader.transform()`` method.
1625 - Added default parameter values to ``Reader.__init__()`` to make
1626 instantiation easier.
1627 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1629 * docutils/readers/pep.py:
1631 - Added the ``peps.TargetNotes`` transform to the Reader.
1632 - Removed PEP & RFC reference detection code; moved to
1633 parsers/rst/states.py as options (enabled here by default).
1634 - Added support for pre-acceptance PEPs (no PEP number yet).
1635 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1638 * docutils/readers/python: Python Source Reader subpackage added to
1639 project, including preliminary versions of:
1642 - moduleparser.py: Parser for Python modules.
1644 * docutils/transforms/__init__.py:
1646 - Added ``Transformer`` class and completed transform reform.
1647 - Added unknown_reference_resolvers list for each transformer. This list holds
1648 the list of functions provided by each component of the transformer that
1649 help resolve references.
1651 * docutils/transforms/frontmatter.py:
1653 - Improved support for generic fields.
1654 - Fixed bibliographic field language lookups.
1656 * docutils/transforms/misc.py: Added to project. Miscellaneous
1659 * docutils/transforms/parts.py:
1661 - Moved the "id" attribute from TOC list items to the references
1662 (``Contents.build_contents()``).
1663 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1664 - Added "class" attribute support to ``Contents``.
1666 * docutils/transforms/peps.py:
1668 - Added ``mask_email()`` function, updating to pep2html.py's
1670 - Linked "Content-Type: text/x-rst" to PEP 12.
1671 - Added the ``TargetNotes`` PEP-specific transform.
1672 - Added ``TargetNotes.cleanup_callback``.
1673 - Added title check to ``Headers``.
1675 * docutils/transforms/references.py:
1677 - Added the ``TargetNotes`` generic transform.
1678 - Split ``Hyperlinks`` into multiple transforms.
1679 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1680 - Added check for circular indirect references.
1681 - Made substitutions case-sensitive-but-forgiving.
1683 * docutils/transforms/universal.py:
1685 - Added support for the "--expose-internal-attributes" option.
1686 - Removed ``Pending`` transform classes & data.
1688 * docutils/writers/__init__.py:
1690 - Removed ``Writer.transform()`` method.
1692 * docutils/writers/docutils-xml.py:
1694 - Added XML and doctype declarations.
1695 - Added "--no-doctype" and "--no-xml-declaration" options.
1697 * docutils/writers/html4css1.py:
1699 - "name" attributes only on these tags: a, applet, form, frame,
1701 - Added "name" attribute to <a> in section titles for Netscape 4
1702 support (bug report: Pearu Peterson).
1703 - Fixed targets (names) on footnote, citation, topic title,
1704 problematic, and system_message nodes (for Netscape 4).
1705 - Changed field names from "<td>" to "<th>".
1706 - Added "@" to "@" encoding to thwart address harvesters.
1707 - Improved the vertical whitespace optimization; ignore "invisible"
1708 nodes (targets, comments, etc.).
1709 - Improved inline literals with ``<span class="pre">`` around chunks
1710 of text and `` `` for runs of spaces.
1711 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1712 ``self.docinfo`` segments.
1713 - Added support for "line_block", "address" elements.
1714 - Improved backlinks (footnotes & system_messages).
1715 - Improved system_message output.
1716 - Redefined "--stylesheet" as containing an invariant URL, used
1717 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1719 - Added "--footnote-references" option (superscript or brackets).
1720 - Added "--compact-lists" and "--no-compact-lists" options.
1721 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1722 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1723 - Improved field list rendering.
1724 - Added Docutils version to "generator" meta tag.
1725 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1726 - Improved layout of <pre> HTML source.
1727 - Fixed attribute typo on <colspec>.
1728 - Refined XML prologue.
1729 - Support for no stylesheet.
1730 - Removed "interpreted" element support.
1731 - Added support for "title_reference", "sidebar", "attribution",
1732 "rubric", and generic "admonition" elements.
1733 - Added "--attribution" option.
1734 - Added support for "inline", "subscript", "superscript" elements.
1735 - Added initial support for "abbreviation" and "acronym";
1738 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1742 - Double quotes in literal blocks (special treatment for de/ngerman).
1743 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1744 - Added "--attribution" option.
1745 - Right align attributions.
1747 * docutils/writers/pep_html.py:
1749 - Parameterized output encoding in PEP template.
1750 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1751 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1752 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1754 - Added an override on the "--footnote-references" option.
1755 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1756 - Added Docutils version to "generator" meta tag.
1757 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1761 - Added a "silent" setting for ``buildhtml.py``.
1762 - Added a "Getting Help" section.
1763 - Rearranged the structure.
1764 - Kept up to date, with new settings, command-line options etc.
1765 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1766 - Converted settings table into a definition list.
1768 * docs/rst/quickstart.txt:
1770 - Added a table of contents.
1771 - Added feedback information.
1772 - Added mention of minimum section title underline lengths.
1773 - Removed the 4-character minimum for section title underlines.
1775 * docs/rst/quickref.html:
1777 - Added a "Getting Help" section.
1778 - Added a style to make section title backlinks more subtle.
1779 - Added mention of minimum section title underline lengths.
1780 - Removed the 4-character minimum for section title underlines.
1782 * extras: Directory added to project; contains third-party modules
1783 that Docutils depends on (optparse, textwrap, roman). These are
1784 only installed if they're not already present.
1786 * licenses: Directory added to project; contains copies of license
1787 files for non-public-domain files.
1791 - Changed the focus. It's about DTD elements: structural
1792 relationships, semantics, and external (public) attributes. Not
1793 about the element class library.
1794 - Moved some implementation-specific stuff into ``docutils.nodes``
1796 - Wrote descriptions of all common attributes and parameter
1797 entities. Filled in introductory material.
1798 - Working through the element descriptions: 55 down, 37 to go.
1799 - Removed "Representation of Horizontal Rules" to
1800 spec/rst/alternatives.txt.
1802 * spec/docutils.dtd:
1804 - Added "generated" inline element.
1805 - Added "line_block" body element.
1806 - Added "auto" attribute to "title".
1807 - Changed content models of "literal_block" and "doctest_block" to
1809 - Added ``%number;`` attribute type parameter entity.
1810 - Changed ``%structural.elements;`` to ``%section.elements``.
1811 - Updated attribute types; made more specific.
1812 - Added "address" bibliographic element.
1813 - Added "line" attribute to ``system_message`` element.
1814 - Removed "field_argument" element; "field_name" may contain
1815 multiple words and whitespace.
1816 - Changed public identifier to docutils.sf.net.
1817 - Removed "interpreted" element; added "title_reference",
1818 "abbreviation", "acronym".
1819 - Removed "refuri" attribute from "footnote_reference" and
1820 "citation_reference".
1821 - Added "sidebar", "rubric", "attribution", "admonition",
1822 "superscript", "subscript", and "inline" elements.
1824 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1826 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1828 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1830 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1833 * spec/transforms.txt: Added to project.
1835 * spec/howto: Added subdirectory, for developer how-to docs.
1837 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1838 Elza, edited & extended by David Goodger.
1840 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1843 * spec/rst/alternatives.txt:
1845 - Added "Doctree Representation of Transitions" from
1847 - Updated "Inline External Targets" & closed the debate.
1848 - Added ideas for interpreted text syntax extensions.
1849 - Added "Nested Inline Markup" section.
1851 * spec/rst/directives.txt:
1853 - Added directives: "topic", "sectnum", "target-notes",
1854 "line-block", "parsed-literal", "include", "replace", "sidebar",
1855 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1857 - Formalized descriptions of directive details.
1858 - Added an "align" attribute to the "image" & "figure" directives
1859 (by Adam Chodorowski).
1860 - Added "class" options to "topic", "sidebar", "line-block",
1861 "parsed-literal", "contents", and "image"; and "figclass" to
1864 * spec/rst/interpreted.txt: Added to project. Descriptions of
1865 interpreted text roles.
1867 * spec/rst/introduction.txt:
1869 - Added pointers to material for new users.
1871 * spec/rst/reStructuredText.txt:
1873 - Disambiguated comments (just add a newline after the "::").
1874 - Updated enumerated list description; added a discussion of the
1875 second-line validity checking.
1876 - Updated directive description.
1877 - Added a note redirecting newbies to the user docs.
1878 - Expanded description of inline markup start-strings in non-markup
1880 - Removed field arguments and made field lists a generic construct.
1881 - Removed the 4-character minimum for section title underlines.
1882 - Clarified term/classifier delimiter & inline markup ambiguity
1884 - Added "Embedded URIs".
1885 - Updated "Interpreted Text" section.
1886 - Added "Character-Level Inline Markup" section.
1888 * test: Continually adding & updating tests.
1890 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1891 - Moved test/test_pep/ to test/test_readers/test_pep/.
1892 - Added test/test_readers/test_python/.
1893 - Added test/test_writers/ (Engelbert Gruber).
1897 - Made the ``locale.setlocale()`` calls in front ends
1900 * tools/buildhtml.py:
1902 - Added "--silent" option.
1903 - Fixed bug with absolute paths & "--config".
1904 - Updated for new I/O classes.
1905 - Added some exception handling.
1906 - Separated publishers' setting defaults; prevents interference.
1907 - Updated for new ``publish_file()`` convenience function.
1909 * tools/pep-html-template:
1911 - Allow for "--embed-stylesheet".
1912 - Added Docutils version to "generator" meta tag.
1913 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1914 - Conform to XHTML spec.
1916 * tools/pep2html.py:
1918 - Made ``argv`` a parameter to ``main()``.
1919 - Added support for "Content-Type:" header & arbitrary PEP formats.
1920 - Linked "Content-Type: text/plain" to PEP 9.
1921 - Files skipped (due to an error) are not pushed onto the server.
1922 - Updated for new I/O classes.
1923 - Added ``check_requirements()`` & ``pep_type_error()``.
1924 - Added some exception handling.
1925 - Updated for new ``publish_string()`` convenience function.
1926 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1928 * tools/quicktest.py:
1930 - Added "-V"/"--version" option.
1932 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1934 * tools/unicode2rstsubs.py: Added to project. Produces character
1935 entity files (reSructuredText substitutions) from the MathML master
1938 * tools/editors: Support code for editors, added to project. Contains
1939 ``emacs/restructuredtext.el``.
1941 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1943 - Added style for chunks of inline literals.
1944 - Removed margin for first child of table cells.
1945 - Right-aligned field list names.
1946 - Support for auto-numbered section titles in TOCs.
1947 - Increased the size of inline literals (<tt>) in titles.
1948 - Restored the light gray background for inline literals.
1949 - Added support for "line_block" elements.
1950 - Added style for "address" elements.
1951 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1952 - Improved field list rendering.
1953 - Vertical whitespace improvements.
1954 - Removed "a.target" style.
1956 * tools/stylesheets/pep.css:
1958 - Fixed nested section margins.
1959 - Other changes parallel those of ``../default.css``.
1962 Release 0.2 (2002-07-31)
1963 ========================
1967 - The word "component" was being used ambiguously. From now on,
1968 "component" will be used to mean "Docutils component", as in Reader,
1969 Writer, Parser, or Transform. Portions of documents (Table of
1970 Contents, sections, etc.) will be called "document parts".
1971 - Did a grand renaming: a lot of ``verylongnames`` became
1972 ``very_long_names``.
1973 - Cleaned up imports: no more relative package imports or
1974 comma-separated lists of top-level modules.
1975 - Added support for an option values object which carries default
1976 settings and overrides (from command-line options and library use).
1977 - Added internal Unicode support, and support for both input and
1979 - Added support for the ``docutils.io.IO`` class & subclasses.
1983 * docutils/__init__.py:
1985 - Added ``ApplicationError`` and ``DataError``, for use throughout
1987 - Added ``Component`` base class for Docutils components; implements
1988 the ``supports`` method.
1989 - Added ``__version__`` (thus, ``docutils.__version__``).
1993 - Removed many keyword parameters to ``Publisher.__init__()`` and
1994 ``publish()``; bundled into an option values object. Added
1995 "argv", "usage", "description", and "option_spec" parameters for
1996 command-line support.
1997 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1999 - Reworked I/O model for ``docutils.io`` wrappers.
2000 - Updated ``Publisher.set_options()``; now returns option values
2002 - Added support for configuration files (/etc/docutils.conf,
2003 ./docutils.conf, ~/.docutils).
2004 - Added ``Publisher.setup_option_parser()``.
2005 - Added default usage message and description.
2007 * docutils/frontend.py: Added to project; support for front-end
2008 (command-line) scripts. Option specifications may be augmented by
2009 components. Requires Optik (http://optik.sf.net/) for option
2010 processing (installed locally as docutils/optik.py).
2012 * docutils/io.py: Added to project; uniform API for a variety of input
2015 * docutils/nodes.py:
2017 - Added ``TreeCopyVisitor`` class.
2018 - Added a ``copy`` method to ``Node`` and subclasses.
2019 - Added a ``SkipDeparture`` exception for visitors.
2020 - Renamed ``TreePruningException`` from ``VisitorException``.
2021 - Added docstrings to ``TreePruningException``, subclasses, and
2023 - Improved docstrings.
2024 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2025 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2027 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2028 ``PreDecorative`` mixin.
2029 - Reworked the name/id bookkeeping; to ``document``, removed
2030 ``explicit_targets`` and ``implicit_targets`` attributes, added
2031 ``nametypes`` attribute and ``set_name_id_map`` method.
2032 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2034 - Added ``document.has_name()`` method.
2035 - Fixed DOM generation for list-attributes.
2036 - Added category class ``Labeled`` (used by footnotes & citations).
2037 - Added ``Element.set_class()`` method (sets "class" attribute).
2039 * docutils/optik.py: Added to project. Combined from the Optik
2040 package, with added option groups and other modifications. The use
2041 of this module is probably only temporary.
2043 * docutils/statemachine.py:
2045 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2046 - Added underscores to improve many awkward names.
2047 - In ``string2lines()``, changed whitespace normalizing translation
2048 table to regexp; restores Python 2.0 compatibility with Unicode.
2050 * docutils/urischemes.py:
2052 - Filled in some descriptions.
2053 - Added "shttp" scheme.
2055 * docutils/utils.py:
2057 - Added ``clean_rcs_keywords`` function (moved from
2058 docutils/transforms/frontmatter.py
2059 ``DocInfo.filter_rcs_keywords``).
2060 - Added underscores to improve many awkward names.
2061 - Changed names of Reporter's thresholds:
2062 warning_level -> report_level; error_level -> halt_level.
2063 - Moved ``utils.id()`` to ``nodes.make_id()``.
2064 - Added ``relative_path(source, target)``.
2066 * docutils/languages/de.py: German mappings; added to project. Thanks
2067 to Gunnar Schwant for the translations.
2069 * docutils/languages/en.py: Added "Dedication" bibliographic field
2072 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2075 * docutils/parsers/rst/states.py:
2077 - Added underscores to improve many awkward names.
2078 - Added RFC-2822 header support.
2079 - Extracted the inline parsing code from ``RSTState`` to a separate
2080 class, ``Inliner``, which will allow easy subclassing.
2081 - Made local bindings for ``memo`` container & often-used contents
2082 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2083 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2084 - Added ``MarkupMismatch`` exception; for late corrections.
2085 - Added ``-/:`` characters to inline markup's start string prefix,
2086 ``/`` to end string suffix.
2087 - Fixed a footnote bug.
2088 - Fixed a bug with literal blocks.
2089 - Applied patch from Simon Budig: simplified regexps with symbolic
2090 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2091 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2092 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2093 - Allowed non-ASCII in "simple names" (directive names, field names,
2095 - Converted ``Inliner.patterns.initial`` to be dynamically built
2096 from parts with ``build_regexp()`` function.
2097 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2098 - Updated docstrings.
2099 - Changed "table" to "grid_table"; added "simple_table" support.
2101 * docutils/parsers/rst/tableparser.py:
2103 - Changed ``TableParser`` to ``GridTableParser``.
2104 - Added ``SimpleTableParser``.
2105 - Refactored naming.
2107 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2108 a fallback language for directive names.
2110 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2111 directive to use a ``pending`` element, used only by HTML writers.
2113 * docutils/parsers/rst/directives/parts.py: Renamed from
2116 - Added "backlinks" attribute to "contents" directive.
2118 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2119 project by Adam Chodorowski.
2121 * docutils/readers/__init__.py: Gave Readers more control over
2122 choosing and instantiating Parsers.
2124 * docutils/readers/pep.py: Added to project; for PEP processing.
2126 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2127 requires a ``component`` parameter.
2129 * docutils/transforms/components.py: Added to project; transforms
2130 related to Docutils components.
2132 * docutils/transforms/frontmatter.py:
2134 - In ``DocInfo.extract_authors``, check for a single "author" in an
2135 "authors" group, and convert it to a single "author" element.
2136 - Added support for "Dedication" and generic bibliographic fields.
2138 * docutils/transforms/peps.py: Added to project; PEP-specific.
2140 * docutils/transforms/parts.py: Renamed from old components.py.
2142 - Added filter for `Contents`, to use alt-text for inline images,
2143 and to remove inline markup that doesn't make sense in the ToC.
2144 - Added "name" attribute to TOC topic depending on its title.
2145 - Added support for optional TOC backlinks.
2147 * docutils/transforms/references.py: Fixed indirect target resolution
2148 in ``Hyperlinks`` transform.
2150 * docutils/transforms/universal.py:
2152 - Changed ``Messages`` transform to properly filter out system
2153 messages below the warning threshold.
2154 - Added ``Decorations`` transform (support for ``--generator``,
2155 ``--date``, ``--time``, ``--source-link`` options).
2157 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2158 Engelbert Gruber's PDF writer.
2160 * docutils/writers/html4css1.py:
2162 - Made XHTML-compatible (switched to lowercase element & attribute
2163 names; empty tag format).
2164 - Escape double-dashes in comment text.
2165 - Improved boilerplate & modularity of output.
2166 - Exposed modular output in Writer class.
2167 - Added a "generator" meta tag to <head>.
2168 - Added support for the ``--stylesheet`` option.
2169 - Added support for ``decoration``, ``header``, and ``footer``
2171 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2172 translation table to regexp; restores Python 2.0 compatibility
2174 - Added the translator class as instance variable to the Writer, to
2175 make it easily subclassable.
2176 - Improved option list spacing (thanks to Richard Jones).
2177 - Modified field list output.
2178 - Added backlinks to footnotes & citations.
2179 - Added percentage widths to "<col>" tags (from colspec).
2180 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2181 "<span>" changed to "<var>".
2182 - Inline literals: "<code>" changed to "<tt>".
2183 - Many changes to optimize vertical space: compact simple lists etc.
2184 - Add a command-line options & directive attributes to control TOC
2185 and footnote/citation backlinks.
2186 - Added support for optional footnote/citation backlinks.
2187 - Added support for generic bibliographic fields.
2188 - Identify backrefs.
2189 - Relative URLs for stylesheet links.
2191 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2192 PEPs (subclass of ``html4css1.Writer``).
2194 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2196 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2197 of the Docutils internal doctree in XML.
2199 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2203 - Changed the title to "The Docutils Document Tree".
2204 - Added "Hyperlink Bookkeeping" section.
2206 * spec/docutils.dtd:
2208 - Added ``decoration``, ``header``, and ``footer`` elements.
2209 - Brought ``interpreted`` element in line with the parser: changed
2210 attribute "type" to "role", added "position".
2211 - Added support for generic bibliographic fields.
2213 * spec/notes.txt: Continual updates. Added "Project Policies".
2215 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2218 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2220 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2221 mailing list discussions.
2223 * spec/pep-0287.txt:
2225 - Renamed to "reStructuredText Docstring Format".
2227 - Reworked Q&A as an enumerated list.
2228 - Converted to reStructuredText format.
2230 * spec/pysource.dtd:
2232 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2234 * spec/pysource.txt: Removed from project. Moved much of its contents
2237 * spec/rst/alternatives.txt:
2239 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2240 - Added "Inline External Targets" section.
2242 * spec/rst/directives.txt:
2244 - Added "backlinks" attribute to "contents" directive.
2246 * spec/rst/problems.txt:
2248 - Updated the Enumerated List Markup discussion.
2249 - Added new alternative table markup syntaxes.
2251 * spec/rst/reStructuredText.txt:
2253 - Clarified field list usage.
2254 - Updated enumerated list description.
2255 - Clarified purpose of directives.
2256 - Added ``-/:`` characters to inline markup's start string prefix,
2257 ``/`` to end string suffix.
2258 - Updated "Authors" bibliographic field behavior.
2259 - Changed "inline hyperlink targets" to "inline internal targets".
2260 - Added "simple table" syntax to supplement the existing but
2261 newly-renamed "grid tables".
2262 - Added cautions for anonymous hyperlink use.
2263 - Added "Dedication" and generic bibliographic fields.
2265 * test: Made test modules standalone (subdirectories became packages).
2267 * test/DocutilsTestSupport.py:
2269 - Added support for PEP extensions to reStructuredText.
2270 - Added support for simple tables.
2271 - Refactored naming.
2273 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2275 - Now supports true packages containing test modules
2276 (``__init__.py`` files required); fixes duplicate module name bug.
2278 * test/test_pep/: Subpackage added to project; PEP testing.
2280 * test/test_rst/test_SimpleTableParser.py: Added to project.
2284 - Updated html.py and publish.py front-end tools to use the new
2285 command-line processing facilities of ``docutils.frontend``
2286 (exposed in ``docutils.core.Publisher``), reducing each to just a
2288 - Added ``locale.setlocale()`` calls to front-end tools.
2290 * tools/buildhtml.py: Added to project; batch-generates .html from all
2291 the .txt files in directories and subdirectories.
2293 * tools/default.css:
2295 - Added support for ``header`` and ``footer`` elements.
2296 - Added styles for "Dedication" topics (biblio fields).
2298 * tools/docutils.conf: A configuration file; added to project.
2300 * tools/docutils-xml.py: Added to project.
2302 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2304 * tools/pep-html-template: Added to project.
2306 * tools/pep2html.py: Added to project from Python (nondist/peps).
2307 Added support for Docutils (reStructuredText PEPs).
2309 * tools/quicktest.py:
2311 - Added the ``--attributes`` option, hacked a bit.
2312 - Added a second command-line argument (output file); cleaned up.
2314 * tools/stylesheets/: Subdirectory added to project.
2316 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2319 Release 0.1 (2002-04-20)
2320 ========================
2322 This is the first release of Docutils, merged from the now inactive
2323 reStructuredText__ and `Docstring Processing System`__ projects. For
2324 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2325 `DPS HISTORY`__ files.
2327 __ http://structuredtext.sourceforge.net/
2328 __ http://docstring.sourceforge.net/
2329 __ http://structuredtext.sourceforge.net/HISTORY.html
2330 __ http://docstring.sourceforge.net/HISTORY.html
2332 General changes: renamed 'dps' package to 'docutils'; renamed
2333 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2334 the test suites (reStructuredText's test/test_states renamed to
2335 test/test_rst); and all modifications required to make it all work.
2337 * docutils/parsers/rst/states.py:
2339 - Improved diagnostic system messages for missing blank lines.
2340 - Fixed substitution_reference bug.
2346 indent-tabs-mode: nil
2347 sentence-end-double-space: t