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.
22 - Apply [ 1878977 ] make_id(): deaccent characters.
23 - Backwards-compatible changes to remove python2.6 -3 deprecation warnings
24 - Text nodes now subclass unicode rather than UserString
25 (which is gone in python 3.0)
26 - Apply [ 1719345 ] Galician translation
27 - Apply [ 1905741 ] polish-translation
31 - Added ``Element.__contains__`` method, for the in-operator.
33 * docutils/parsers/rst/states.py:
35 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
36 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
37 " " (non-breaking space), and "¡ ¿" openers.
39 * docutils/writers/newlatex2e/__init__.py:
41 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
43 * docutils/writers/latex2e/__init__.py:
45 - Add option ``--embed-stylesheet``.
46 - Apply [ 1474017 ] image vertical alignment is reversed.
47 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
48 - Fix: for spanish ``~n`` is ``n`` with tilde above, change to ``~{}n``.
49 - Change: has_key for dictionaries (not Nodes) to in-operator.
50 - Merge adjacent citations into one latex cite command.
52 * docs/ref/rst/restructuredtext.txt:
54 - Documented Unicode characters allowed as inline markup openers,
55 closers, and delimiters.
58 Release 0.5 (2008-06-25)
59 ========================
61 * docutils/languages/he.py: Added to project: Hebrew mappings by
64 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
65 mappings by Meir Kriheli.
67 * docutils/frontend.py:
69 - Configuration files are now assumed and required to be
71 - Paths of applied configuration files are now recorded in the
72 runtime setting ``_config_files`` (accessible via
74 - Added ``--strip-elements-with-class`` and ``--strip-class``
75 options (``strip_elements_with_classes`` and ``strip_classes``
80 - Added code to determine the input encoding from data: encoding
81 declarations or the presence of byte order marks (UTF-8 & UTF-16).
82 - Added support for IronPython 1.0.
86 - Added ``document.__getstate__`` method, for pickling.
88 * docutils/parsers/rst/states.py:
90 - Allow ``+`` and ``:`` in reference names.
91 - Unquoted targets beginning with an underscore (``.. __target:
92 URI``) are no longer accepted.
93 - Added support for multiple attributions in a physical block quote
94 (indented text block), dividing it into multiple logical block
96 - Added support for unicode bullets in bullet lists: "•", "‣", and
98 - Added support for new object-oriented directive interface,
99 retaining compatibility to the old functional interface.
100 - Added support for throwing ``DirectiveError``'s from within
103 * docutils/parsers/rst/__init__.py:
105 - Added ``Directive`` base class.
106 - Added ``DirectiveError`` base class.
107 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
110 * docutils/parsers/directives/:
112 - Refactored all reStructuredText directives to use the new
113 object-oriented directive interface. Errors are now (mostly)
114 thrown using the new ``DirectiveError`` class.
116 * docutils/parsers/directives/misc.py:
118 - Added ``start-after`` and ``end-before`` options to ``include``
119 directive; thanks to Stefan Rank.
121 * docutils/transforms/universal.py:
123 - Added ``StripClassesAndElements`` transform to remove from the
124 document tree all elements with classes in
125 ``settings.strip_elements_with_classes`` and all "classes"
126 attribute values in ``self.document.settings.strip_classes``.
128 * docutils/transforms/writer_aux.py:
130 - Added ``Admonitions`` transform to transform specific admonitions
131 (like ``note``, ``warning``, etc.) into generic admonitions with a
134 * docutils/writers/html4css1/__init__.py:
136 - Moved template functionality from the PEP/HTML writer here.
137 - Expanded the fragments available in the ``parts`` attribute.
138 - Moved ``id`` attributes from titles to surrounding ``div``
140 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
141 universally supported now).
142 - ``template.txt`` is now opened in text mode instead of binary mode
143 (to ensure Windows compatibility).
144 - ``a`` elements now have an "internal" or "external" class,
145 depending on reference type.
147 * docutils/writers/html4css1/template.txt: Added to project.
149 * docutils/writers/pep_html/:
151 - Moved template functionality to the HTML writer.
153 * docutils/writers/s5_html/__init__.py:
155 - Added ``view_mode`` & ``hidden_controls`` settings
156 (``--view-mode`` & ``--hidden-controls/--visible-controls``
159 * docutils/writers/latex2e/__init__.py:
161 - Add ``--literal-block-env``
162 - Fix: escaping ``%`` in href urls.
163 - Move usepackage hyperref after stylesheet inclusion.
164 - Fix: scrartcl does not have chapter but scrreprt.
165 - Add newline after ``\end{verbatim}``.
166 - Merge smaller differences from latex2e_adaptive_preamble.
167 - Add ``use-part-section``.
168 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
169 - Using leavemode option_list no longer needs to check if parent
170 is a definition list.
171 - Append ``\leavemode`` to definition list terms.
172 - No longer write visit\_/depart_definition_list_item comments to
174 - Table column width with 3 decimal places.
175 - Add table stubs support (boldfont).
176 - Add assemble_parts to writer.
177 - Add simply support for nested tables.
178 - Fix verbatim in tables if use-verbatim-when-possible.
179 - Use section commands down to subparagraph.
180 - Put ensuremath around some latin1 chars.
181 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
182 - New option ``--use-bibtex=style,db1,db2``.
183 - New option ``--reference-label`` to allow usage of LaTeX ref for
184 labels in section references.
185 - Add a label after every section to support sectionnumbers as reference
187 - Fix: bug# 1605376 rst2latex: bad options group list
188 - Remove inactive code for use_optionlist_for_option_list.
189 - Remove latex comments from option_list output.
190 - Fix: bug# 1612270 double qoutes in italian literal.
191 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
192 - Add option --use-latex-abstract.
193 - Image width unit ``px`` is translated to ``pt``.
194 - Add image height support.
195 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
197 - Fix: Do not escape underscores in citation reference labels if
198 use-latex-citations is set.
199 - Use centering instead of center for figure contents, to avoid vertical
201 - Recognize table class: borderless, nolines, booktabs, standard.
202 - Fix: Renaming contents section does not work with latex writer; SF
204 - Applied patch for custom roles with classes from Edward Loper.
205 - Fixed bug that caused crashes with more than 256 lists.
207 * docutils/writers/pep_html/__init__.py:
209 - Changed to support new python.org website structure and
212 * docs/howto/security.txt: "Deploying Docutils Securely", added to
215 * tools/buildhtml.py:
217 -- Added ``ignore`` setting to exclude a list of shell patterns
218 (default: ``.svn:CVS``).
220 * tools/editors/emacs/rst.el:
222 - Changed license to "GPL".
223 - Added ``rst-straighten-decorations`` function.
224 - The ``compile`` module is now always loaded.
225 - Added ``rst-toggle-line-block`` function.
226 - Headings consisting only of non-ASCII characters are now
227 recognized by ``rst-toc`` and ``rst-adjust``.
228 - Added font-lock support for multi-line comments where the first
229 comment line is empty.
230 - Added ``(require 'font-lock)``.
234 - Provide descriptive error message if distutils is missing.
237 Release 0.4 (2006-01-09)
238 ========================
242 - Updated the project policies for trunk/branch development &
245 * docutils/__init__.py:
247 - Added ``__version_details__`` attribute to describe code source
248 (repository/snapshot/release).
249 - Replaced ``default_transforms`` attribute of TransformSpec with
250 ``get_transforms()`` method.
254 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
255 functions, for document tree extraction and reprocessing.
259 - Added ``DocTreeInput`` class, for reprocessing existing documents.
260 - Added support for non-Unicode (e.g. binary) writer output.
264 - Re-introduced ``Targetable.indirect_reference_name``, for
265 MoinMoin/reST compatibility (removed in r3124/r3129).
266 - Added ``serial_escape`` function; escapes string values that are
267 elements of a list, for serialization. Modified Docutils-XML
268 writing (``Element._dom_node``) and pseudo-XML writing
269 (``Element.starttag``) to use ``serial_escape``.
270 - Added ``Node.deepcopy()`` method.
271 - Removed the internal lists ``document.substitution_refs``,
272 ``document.anonymous_refs``, and ``document.anonymous_targets``.
273 - Added a "container" element.
274 - Fixed bug where values of list-valued attributes of elements
275 originating from custom interpreted text roles (i.e., with custom
276 classes) were being shared between element instances. Reported by
279 * docutils/statemachine.py:
281 - Added trailing whitespace stripping to ``string2lines()``.
282 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
283 Asian double-width character support.
287 - Added ``east_asian_column_width()`` for double-width character
290 * docutils/languages/ja.py: Added to project: Japanese mappings by
293 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
294 mappings by Panjunyong.
296 * docutils/parsers/null.py: Added to project; a do-nothing parser.
298 * docutils/parsers/rst/__init__.py:
300 - Added validator to tab_width setting, with test. Closes SF bug
301 #1212515, report from Wu Wei.
303 * docutils/parsers/rst/states.py:
305 - Fixed bug with escaped colons indicating a literal block.
306 - Fixed bug with enumerated lists (SF#1254145).
307 - Backslash-escaped colons inside of field names are now allowed.
308 - Targets (implicit and explicit), anonymous hyperlink references
309 and auto-numbered footnote references inside of substitution
310 definitions are now disallowed.
311 - Fixed bug: list items with blank first lines.
312 - Fixed bug: block quote attributions with indented second lines.
313 - Added East Asian double-width character support (Python 2.4 only).
315 * docutils/parsers/rst/tableparser.py:
317 - Added East Asian double-width character support (Python 2.4 only).
319 * docutils/parsers/rst/directives/body.py:
321 - Added the "container" directive.
323 * docutils/parsers/rst/directives/misc.py:
325 - Added the "default-role", "title", and "date" directives.
326 - Added standard data file syntax to the "include" directive.
327 - Added support for "class" directive content.
329 * docutils/parsers/rst/directives/images.py:
331 - Added ``indirect_reference_name`` support for images with a target
333 - Added support for image width and height units.
334 - Fixed bug with image "target" options.
336 * docutils/parsers/rst/directives/references.py:
338 - Added "class" attribute to "target-notes" directive, for
339 footnote_reference classes.
341 * docutils/parsers/rst/include/: Directory added to project; contains
342 standard data files for the "include" directive. Initial contents:
343 character entity substitution definition sets, and a set of
344 definitions for S5/HTML presentations.
346 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
347 mappings by David Goodger.
349 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
350 Simplified Chinese mappings by Panjunyong.
352 * docutils/readers/__init__.py:
354 - Added universal.Decorations and universal.ExposeInternals
355 transforms as default transforms for all readers.
356 - Added ``ReReader`` base class for readers that reread an existing
359 * docutils/readers/doctree.py: Added to project; a reader for existing
362 * docutils/transforms/frontmatter.py:
364 - Fixed the DocInfo transform to handle SVN-style expansion of the
366 - In ``DocInfo.extract_authors``, treat the contents of "authors"
369 * docutils/transforms/misc.py:
371 - Added misc.Transitions transform, extracted from
372 universal.FinalChecks.
374 * docutils/transforms/references.py:
376 - Added references.DanglingReferences transform, extracted from
377 universal.FinalChecks.
378 - Fixed bug with doubly-indirect substitutions.
379 - Added footnote_reference classes attribute to "TargetNotes".
380 - Fixed bug with circular substitution definitions that put Docutils
381 into an infinite loop.
383 * docutils/transforms/universal.py:
385 - Added universal.ExposeInternals transform, extracted from
386 universal.FinalChecks.
387 - Removed universal.FinalChecks transform (logic has been moved to
388 several new transforms).
389 - Fixed bug with the "expose_internals" setting and Text nodes
390 (exposed by the "rawsource" internal attribute).
391 - Added the universal.StripComments transform, implementation of the
392 "strip_comments" setting.
394 * docutils/transforms/writer_aux.py: Added to project; auxiliary
395 transforms for writers.
397 - Added ``Compound`` transform, which flattens compound paragraphs.
399 * docutils/writers/: Several writer modules (html4css1.py) were
400 converted into packages. Support modules and data files have been
401 moved into the packages. The stylesheets for the HTML writers are
402 now installed along with the code, the code knows where to find
403 them, and the default is to use them (actually, to embed them).
404 Some adjustments to configuration files may be necessary. The
405 easiest way to obtain the new default behavior is to remove all
406 settings whose name includes "stylesheet".
408 * docutils/writers/__init__.py:
410 - Added universal.Messages and universal.FilterMessages transforms
411 as default transforms for all writers.
412 - Added ``UnfilteredWriter`` base class for writers that pass the
413 document tree on unchanged.
415 * docutils/writers/docutils_xml.py:
417 - Made ``xmlcharrefreplace`` the default output encoding error
420 * docutils/writers/html4css1/:
422 - Added support for image width and height units.
423 - Made ``xmlcharrefreplace`` the default output encoding error
425 - Made ``--embed-stylesheet`` the default rather than
426 ``--link-stylesheet``.
427 - Moved "id" attribute from container (section etc.) to title's <a>
428 tag, to be on the same tag as "name".
429 (!!! To be reverted in Docutils 0.5.)
430 - Added vertical space between fields of field lists.
431 - Added ``--compact-field-lists`` option to remove vertical space in
433 - Made cloaking of email addresses with ``--cloak-email-addresses``
435 - Fixed support for centered images.
436 - Added support for class="compact" & class="open" lists.
438 * docutils/writers/latex2e/:
440 - Underscores in citekeys are no longer escaped.
442 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
443 mapping of Unicode characters to LaTeX equivalents.
445 * docutils/writers/s5_html/: Package added to project; writer for
448 * docs/dev/distributing.txt: Added to project; guide for distributors
449 (package maintainers).
451 * docs/dev/hacking.txt: Added to project; guide for developers.
453 * docs/ref/doctree.txt:
455 - Updated for plural attributes "classes", "ids", "names",
457 - Added the "container" element.
459 * docs/ref/docutils.dtd:
461 - Updated for plural attributes "classes", "ids", "names",
464 * docs/user/emacs.txt: Added to project; a document about Emacs
465 support for reStructuredText and Docutils.
467 * docs/user/links.txt: Added to project; lists of Docutils-related
470 * docs/user/mailing-lists.txt: Added to project; information about
471 Docutils-related mailing lists and how to access them.
473 * docs/user/slide-shows.txt: Added to project; example of and docs for
474 the S5/HTML writer (``rst2s5.py`` front end).
476 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
477 Files", added to project.
479 * test/coverage.sh: Added to project; test coverage script.
481 * test/DocutilsTestSupport.py:
483 - Added support for specifying runtime settings at the suite level.
485 * test/test_functional.py:
487 - Added the ``clear_output_directory`` function.
488 - Added support for ``_test_more`` functions in functional test
491 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
493 * tools/rstpep2html.py: Renamed from pep.py.
495 * tools/dev/create_unimap.py: Added to project; script to create the
496 docutils/writers/unimap_latex.py mapping file.
498 * tools/dev/profile_docutils.py: Added to project; profiler script.
500 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
502 * tools/editors/emacs/restructuredtext.el,
503 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
504 Removed from project; the functionality is now contained in rst.el.
506 * tools/editors/emacs/rst.el: Added to project. Added many features
507 and fixed many bugs. See docs/user/emacs.txt for details.
509 * tools/stylesheets: Removed from project. Stylesheets have been
510 renamed and moved into writer packages.
513 Release 0.3.9 (2005-05-26)
514 ==========================
518 - Eliminated and replaced all uses of the old string attributes
519 ``id``, ``name``, ``dupname`` and ``class`` with references to the
520 new list attributes ``ids``, ``names``, ``dupnames`` and
521 ``classes`` throughout the whole source tree.
525 - Enabled ``--dump-*`` options when ``--traceback`` specified,
526 allowing for easier debugging.
527 - In ``Publisher.publish()``, expanded the generic top-level
530 * docutils/examples.py:
532 - Added ``internals`` function for exploration.
536 - Fixed ``Input.decode`` method to apply heuristics only if no
537 encoding is explicitly given, and to provide better reporting of
539 - The ``Input.decode`` method now removes byte order marks (BOMs)
544 - ``image`` element class changed to subclass of Element, not
545 TextElement (it's an empty element, and cannot contain text).
546 - Added ``attr_defaults`` dictionary for default attribute values.
547 - Added empty list as default value for the following attributes:
548 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
549 - Added ``document.decoration`` attribute,
550 ``document.get_decoration`` method, and ``decoration.get_header``
551 & ``.get_footer`` methods.
552 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
557 - Removed ``docutils.utils.Reporter.categories``,
558 ``docutils.utils.ConditionSet``, and all references to them, to
559 simplify error reporting.
561 * docutils/languages/nl.py: Added to project; Dutch mappings by
564 * docutils/parsers/rst/__init__.py:
566 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
568 * docutils/parsers/rst/states.py:
570 - Added check for escaped at-mark to prevent email address recognition.
571 - Fixed option lists to allow spaces inside ``<angle-bracketed option
573 - Allowed whitespace in paths and URLs.
574 - Added auto-enumerated list items.
575 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
577 - Added support for table stub columns.
579 * docutils/parsers/rst/directives/__init__.py:
581 - Allowed whitespace in paths (``path`` function).
582 - Added ``uri`` directive option conversion function.
584 * docutils/parsers/rst/directives/body.py:
586 - Fixed illegal context bug with "topic" directive (allowed within
587 sidebars; not within body elements).
589 * docutils/parsers/rst/directives/images.py:
591 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
592 - Added support for the ``file_insertion_enabled`` setting in the
593 "figure" directive (disables "figwidth" option).
594 - "image" directive: added checks for valid values of "align" option,
595 depending on context. "figure" directive: added specialized
596 "align" option and attribute on "figure" element.
597 - Made ":figwidth: image" option of "figure" directive work again.
598 - Fixed bug with reference names containing uppercase letters
599 (e.g. ``Name_``) in "target" option of "image" directive.
601 * docutils/parsers/rst/directives/misc.py:
603 - Fixed "include" and "raw" directives to catch text decoding
605 - Allowed whitespace in "include" & "raw" directive paths.
606 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
607 settings in "include" & "raw" directives.
609 * docutils/parsers/rst/directives/parts.py:
611 - Added "header" & "footer" directives.
612 - Fixed illegal context bug with "contents" directive (topics
613 allowed within sidebars; not within body elements).
615 * docutils/parsers/rst/directives/tables.py:
617 - Added "list-table" directive.
618 - Caught empty CSV table bug.
619 - Added support for the ``file_insertion_enabled`` setting in the
620 "csv-table" directive.
621 - Added ``stub-columns`` option to "csv-table" and "list-table"
624 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
625 mappings by Martijn Pieters.
627 * docutils/readers/standalone.py:
629 - Added ``--section-subtitles`` and ``--no-section-subtitles``
630 options to activate or deactivate the SectSubTitle transform.
632 * docutils/transforms/frontmatter.py:
634 - Added SectSubTitle transform to promote titles of lone
635 subsections to subtitles.
637 * docutils/transforms/references.py:
639 - Fixed mislocated internal targets bug, by propagating internal
640 targets to the next node, making use of the newly added support
641 for multiple names and IDs.
642 - Fixed duplicate footnote label bug.
643 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
646 * docutils/writers/html4css1.py:
648 - Fixed unencoded stylesheet reference bug (characters like "&" in
649 stylesheet references).
650 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
652 - Added support for multiple IDs per node by creating empty ``span``
654 - Added the ``field_name_limit`` & ``option_limit`` settings &
656 - Added support for table stub columns.
657 - Added support for the ``align`` attribute on ``figure`` elements.
658 - Added the ``cloak_email_addresses`` setting & support.
659 - Added ``html_prolog``, ``html_head``, ``html_body``,
660 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
661 ``docutils.core.publish_parts``.
662 - Added support for section subtitles.
664 * docutils/writers/latex2e.py:
666 - Fixed tables starting with more than one multirow cell.
667 - Improved --use-latex-docinfo so that organization/contact/address
668 fields are lumped with the last author field and appear on the
670 - Made sure the titlepage is always shown with --use-latex-docinfo,
671 even if the document has no title.
672 - Made sure that latex doesn't fill in today's date if no date field
674 - Added support for section subtitles.
676 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
679 * docutils/writers/null.py: Added to project; a do-nothing Writer.
681 * docs/api/publisher.txt:
683 - Added "``publish_parts`` Details" section.
685 * docutils/dev/repository.txt: Added to project; information about the
686 Docutils Subversion repository.
688 * docs/ref/docutils.dtd:
690 - Added a ``stub`` attribute to the ``colspec`` element via the
691 ``tbl.colspec.att`` parameter entity.
692 - Allowed topic elements within sidebars
693 - Added an ``align`` attribute to the ``figure`` element.
695 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
699 Release 0.3.7 (2004-12-24)
700 ==========================
702 * docutils/frontend.py:
704 - Added options: --input-encoding-error-handler,
705 --record-dependencies, --leave-footnote-reference-space,
707 - Added command-line and config file support for "overrides" setting
712 - Added support for input encoding error handler.
716 - Added dispatch_visit and dispatch_departure methods to
717 NodeVisitor; useful as a hook for Visitors.
718 - Changed structure of ``line_block``; added ``line``.
719 - Added ``compound`` node class.
720 - Added a mechanism for Visitors to transitionally ignore new node
725 - Moved ``escape2null`` and ``unescape`` functions from
726 docutils/parsers/rst/states.py.
728 * docutils/parsers/rst/roles.py:
731 - Changed role function API: the "text" parameter now takes
732 null-escaped interpreted text content.
734 * docutils/parsers/rst/states.py:
736 - Fixed bug where a "role" directive in a nested parse would crash
737 the parser; the state machine's "language" attribute was not being
739 - Added support for line block syntax.
740 - Fixed directive parsing bug: argument-less directives didn't
741 notice that arguments were present.
742 - Removed error checking for transitions.
743 - Added support for multiple classifiers in definition list items.
744 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
745 - Changed role function API: the "text" parameter now takes
746 null-escaped interpreted text content.
747 - Empty sections and documents are allowed now.
749 * docutils/parsers/rst/directives/__init__.py:
751 - Added ``encoding`` directive option conversion function.
752 - Allow multiple class names in class_option conversion function.
754 * docutils/parsers/rst/directives/body.py:
756 - Converted the line-block directive to use the new structure.
757 - Extracted the old line-block functionality to the ``block``
758 function (still used).
759 - Added ``compound`` directive (thanks to Lea Wiemann).
761 * docutils/parsers/rst/directives/misc.py:
763 - Added "encoding" option to "include" and "raw" directives.
764 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
765 - Allow multiple class names in the "class" directive.
767 * docutils/parsers/rst/directives/parts.py:
769 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
770 options. Thanks to Lele Gaifax.
772 * docutils/parsers/rst/directives/tables.py:
774 - Added "encoding" directive to "csv-table" directive.
775 - Added workaround for lack of Unicode support in csv.py, for
778 * docutils/transforms/misc.py:
780 - Fixed bug when multiple "class" directives are applied to a single
782 - Enabled multiple format names for "raw" directive.
784 * docutils/transforms/references.py:
786 - Added support for trimming whitespace from beside substitution
789 * docutils/transforms/universal.py:
791 - FinalChecks now checks for illegal transitions and moves
792 transitions between sections.
794 * docutils/writers/html4css1.py:
796 - HTMLTranslator.encode now converts U+00A0 to " ".
797 - "stylesheet" and "stylesheet_path" settings are now mutually
799 - Added support for the new line_block/line structure.
800 - --footnote-references now overrides
801 --trim-footnote-reference-space, if applicable.
802 - Added support for ``compound`` elements.
803 - Enabled multiple format names for "raw" directive.
804 - ``<p>`` tags of a paragraph which is the only visible child of the
805 document node are no longer stripped.
806 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
807 new method ``should_be_compact_paragraph()``.
808 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
810 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
811 the output if they have their ``class`` attribute set.
812 - The whole document is now surrounded by a ``<div
813 class="document">`` element.
814 - Body-level images are now wrapped by their own ``<div>`` elements,
815 with image classes copied to the wrapper, and for images which
816 have the ``:align:`` option set, the surrounding ``<div>`` now
817 receives a class attribute (like ``class="align-left"``).
819 * docutils/writers/latex2e.py:
821 - no newline after depart_term.
822 - Added translations for some Unicode quotes.
823 - Added option "font-encoding", made package AE the default.
824 - "stylesheet" and "stylesheet_path" settings are now mutually
826 - --footnote-references now overrides
827 --trim-footnote-reference-space, if applicable.
828 - The footnote label style now matches the footnote reference style
829 ("brackets" or "superscript").
830 - Added support for ``compound`` elements.
831 - Enabled multiple format names for "raw" directive.
833 * docs/ref/docutils.dtd:
835 - Changed structure of the ``line_block`` element; added ``line``.
836 - Added ``compound`` element.
837 - Added "ltrim" and "rtrim" attributes to
838 ``substitution_definition`` element.
839 - Enabled multiple format names for ``raw`` element.
840 - Enabled multiple classifiers in ``definition_list_item`` elements.
842 * docs/ref/rst/directives.txt
844 - Marked "line-block" as deprecated.
845 - "Class" directive now allows multiple class names.
846 - Added "Rationale for Class Attribute Value Conversion".
847 - Added warning about "raw" overuse/abuse.
849 * docs/ref/rst/restructuredtext.txt:
851 - Added syntax for line blocks.
852 - Definition list items may have multiple classifiers.
854 * docs/ref/rst/roles.txt:
858 * tools/stylesheets/default.css:
860 - Added support for the new line_block structure.
861 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
864 Release 0.3.5 (2004-07-29)
865 ==========================
869 * _`Documentation cleanup/reorganization`.
871 - Created new subdirectories of docs/:
873 * ``docs/user/``: introductory/tutorial material for end-users
874 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
875 * ``docs/api/``: API reference material for client-developers
876 * ``docs/ref/``: reference material for all groups
877 * ``docs/howto/``: for component-developers and core-developers
878 * ``docs/peps/``: Python Enhancement Proposals
880 - Moved ``docs/*`` to ``docs/user/``.
881 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
882 ``spec/`` to ``docs/dev``.
883 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
884 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
885 - Moved ``alternatives.txt``, and ``problems.txt`` from
886 ``spec/rst/`` to ``docs/dev/rst/``.
887 - Moved ``reStructuredText.txt``, ``directives.txt``,
888 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
889 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
890 ``roles.txt``, ``reStructuredText.txt`` to
891 ``restructuredtext.txt``.
892 - Moved ``spec/howto/`` to ``docs/howto``.
894 In order to keep the CVS history of moved files, we supplied
895 SourceForge with a `script for modifying the Docutils CVS
898 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
900 After running the cleanup script:
902 - Added ``docs/index.txt``.
903 - Added a ``.htaccess`` file to the ``web`` module, containing
904 redirects for all old paths to new paths. They'll preserve
905 fragments (the "#name" part of a URL), and won't clutter up the
906 file system, and will correct the URL in the user's browser.
907 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
908 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
909 the "To Do" list itself in ``docs/dev/todo.txt``.
910 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
911 section of ``docs/dev/todo.txt``.
912 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
913 - Added "How To Report Bugs" to ``BUGS.txt``.
914 - Went through all the sources and docs (including under web/) and
915 updated links. Mostly done by Lea Wiemann; thanks Lea!
916 (Still need to update links in the sandboxes.)
920 * BUGS.txt: Added to project.
922 * THANKS.txt: Added to project.
924 * docutils/__init__.py:
926 - 0.3.4: Post-release.
930 - Added special error handling & advice for UnicodeEncodeError.
931 - Refactored Publisher.publish (simplified exception handling &
932 extracted debug dumps).
933 - Renamed "enable_exit" parameter of convenience functions to
934 "enable_exit_status".
935 - Enabled traceback (exception propagation) by default in
936 programmatic convenience functions.
937 - Now publish_file and publish_cmdline convenience functions return
938 the encoded string results in addition to their regular I/O.
939 - Extracted common code from publish_file, publish_string, and
940 publish_parts, into new publish_programmatically. Extracted
941 settings code to ``Publisher.process_programmatic_settings``.
942 - In Publisher.publish, disabled ``settings_overrides`` when
943 ``settings`` is supplied; redundant.
945 * docutils/frontend.py:
947 - Added help text for "--output-encoding-error-handler" and
948 "--error-encoding-error-handler".
949 - Renamed "--exit" to "--exit-status".
950 - Simplified default-setting code.
952 * docutils/parsers/rst/__init__.py:
954 - Added "--pep-base-url" and "--rfc-base-url" options.
956 * docutils/parsers/rst/states.py:
958 - Made URI recognition more aggressive and intelligent.
960 * docutils/parsers/rst/directives/__init__.py:
962 - Added several directive option conversion functions.
964 * docutils/parsers/rst/directives/body.py:
966 - Moved "table" directive to tables.py.
968 * docutils/parsers/rst/directives/tables.py: Table-related directives,
971 * docutils/writers/latex2e.py:
973 - Added "--table-style=(standard|booktabs|nolines)"
974 - figures get "here" option (LaTeX per default puts them at bottom),
975 and figure content is centered.
976 - Rowspan support for tables.
977 - Fix: admonition titles before first section.
978 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
979 - Replave ``_`` in literal by an underlined blank, because it has the correct
981 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
982 - A few unicode replacements, if output_encoding != utf
983 - Add "--graphicx-option".
984 - Indent literal-blocks.
985 - Fix: omit ``\maketitle`` when there is no document title.
987 * docs/index.txt: "Docutils Project Documentation Overview", added to
990 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
991 Tool", added to project.
993 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
995 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
997 * docs/dev/policies.txt: Added to project (extracted from
998 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1000 * docs/dev/release.txt: Added to project (extracted from
1001 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1003 * docs/dev/testing.txt: Added to project.
1005 * docs/dev/website.txt: Added to project (extracted from
1006 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1008 * docs/ref/rst/directives.txt:
1010 - Added directives: "table", "csv-table".
1012 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1013 added to project. 1 page for syntax, and a 1 page reference for
1014 directives and roles. Source text to be used as-is; not meant to be
1017 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1018 with a change of title.
1020 * test/functional/, contents, and test/test_functional.py: Added to
1023 * tools/buildhtml.py: Fixed bug with config file handling.
1025 * tools/html.py: Removed from project (duplicate of rst2html.py).
1027 * tools/pep2html.py: Removed from project (duplicate of Python's
1028 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1029 Docutils-related PEPs in docs/peps/).
1031 * tools/rst2pseudoxml.py: Renamed from publish.py.
1033 * tools/rst2xml.py: Renamed from docutils-xml.py.
1035 * tools/test.txt: Removed from project; moved to
1036 docs/user/rst/demo.txt.
1038 * setup.py: Now also installs ``rst2latex.py``.
1041 Release 0.3.3 (2004-05-09)
1042 ==========================
1044 * docutils/__init__.py:
1046 - 0.3.1: Reorganized config file format (multiple sections); see
1048 - Added unknown_reference_resolvers attribute to TransformSpec.
1049 - 0.3.2: Interpreted text reorganization.
1054 - Catch system messages to stop tracebacks from parsing errors.
1055 - Catch exceptions during processing report & exit without
1056 tracebacks, except when "--traceback" used.
1057 - Reordered components for OptionParser; application comes last.
1058 - Added "config_section" parameter to several methods and functions,
1059 allowing front ends to easily specify their config file sections.
1060 - Added publish_parts convenience function to allow access to individual
1061 parts of a document.
1063 * docutils/examples.py: Added to project; practical examples of
1064 Docutils client code, to be used as-is or as models for variations.
1066 * docutils/frontend.py:
1068 - Added "--traceback" & "--no-traceback" options ("traceback"
1070 - Implemented support for config file reorganization:
1071 ``standard_config_files`` moved from ``ConfigParser`` to
1072 ``OptionParser``; added
1073 ``OptionParser.get_config_file_settings()`` and
1074 ``.get_standard_config_settings()``; support for old "[options]"
1075 section (with deprecation warning) and mapping from old to new
1077 - Reimplemented setting validation.
1078 - Enabled flexible boolean values: yes/no, true/false, on/off.
1079 - Added ``Values``, a subclass of ``optparse.Values``, with support
1080 for list setting attributes.
1081 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1082 thanks to Beni Cherniavsky.
1083 - Added "--no-section-numbering" option.
1087 - Catch IOErrors when opening source & destination files, report &
1088 exit without tracebacks. Added ``handle_io_errors`` parameter to
1089 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1091 * docutils/nodes.py:
1093 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1094 method definitions (via ``exec``) to dynamic assignments (via
1095 ``setattr``); thanks to Roman Suzi.
1096 - Encapsulated visitor dynamic assignments in a function; thanks to
1098 - Added indirect_reference_name attribute to the Targetable
1099 class. This attribute holds the whitespace_normalized_name
1100 (contains mixed case) of a target.
1102 * docutils/statemachine.py:
1104 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1105 - Added ``StringList.get_2D_block``.
1107 * docutils/utils.py:
1109 - Added "level" attribute to SystemMessage exceptions.
1111 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1114 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1117 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1118 Marcelo Huerta San Martin.
1120 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1121 mappings by Lalo Martins.
1123 * docutils/languages/ru.py: Added to project; Russian mappings by
1126 * docutils/parsers/rst/roles.py: Added to project. Contains
1127 interpreted text role functions, a registry for interpreted text
1128 roles, and an API for adding to and retrieving from the registry.
1129 Contributed by Edward Loper.
1131 * docutils/parsers/rst/states.py:
1133 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1134 - Allowed true em-dash character and "---" as block quote
1136 - Added support for <angle-bracketed> complex option arguments
1138 - Fixed handling of backslashes in substitution definitions.
1139 - Fixed off-by-1 error with extra whitespace after substitution
1140 definition directive.
1141 - Added inline markup parsing to field lists' field names.
1142 - Added support for quoted (and unindented) literal blocks.
1143 Driven in part by a bribe from Frank Siebenlist (thanks!).
1144 - Parser now handles escapes in URIs correctly.
1145 - Made embedded-URIs' reference text omittable. Idea from Beni
1147 - Refactored explicit target processing code.
1148 - Added name attribute to references containing the reference name only
1149 through whitespace_normalize_name (no case changes).
1150 - parse_target no longer returns the refname after going through
1151 normalize_name. This is now handled in make_target.
1152 - Fixed bug relating to role-less interpreted text in non-English
1154 - Reorganized interpreted text processing; moved code into the new
1155 roles.py module. Contributed by Edward Loper.
1156 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1157 ``parse_directive_block``.
1159 * docutils/parsers/rst/tableparser.py:
1161 - Reworked for ``StringList``, to support "include" directives in
1164 * docutils/parsers/rst/directives/__init__.py:
1166 - Renamed ``unchanged()`` directive option conversion function to
1167 ``unchanged_required``, and added a new ``unchanged``.
1168 - Catch unicode value too high error; fixes bug 781766.
1169 - Beefed up directive error reporting.
1171 * docutils/parsers/rst/directives/body.py:
1173 - Added basic "table" directive.
1175 * docutils/parsers/rst/directives/images.py:
1177 - Added "target" option to "image" directive.
1178 - Added name attribute to references containing the reference name only
1179 through whitespace_normalize_name (no case changes).
1181 * docutils/parsers/rst/directives/misc.py:
1183 - Isolated the import of the ``urllib2`` module; was causing
1184 problems on SourceForge (``libssl.so.2`` unavailable?).
1185 - Added the "role" directive for declaring custom interpreted text
1188 * docutils/parsers/rst/directives/parts.py:
1190 - The "contents" directive does more work up-front, creating the
1191 "topic" and "title", and leaving the "pending" node for the
1192 transform. Allows earlier reference resolution; fixes subtle bug.
1194 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1195 mappings by Jannie Hofmeyr.
1197 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1198 mappings by Marek Blaha.
1200 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1201 mappings by Marcelo Huerta San Martin.
1203 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1204 Portuguese mappings by Lalo Martins.
1206 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1207 mappings by Roman Suzi.
1209 * docutils/transforms/parts.py:
1211 - The "contents" directive does more work up-front, creating the
1212 "topic" and "title", and leaving the "pending" node for the
1213 transform. Allows earlier reference resolution; fixes subtle bug.
1214 - Added support for disabling of section numbering.
1216 * docutils/transforms/references.py:
1218 - Verifying that external targets are truly targets and not indirect
1219 references. This is because we are now adding a "name" attribute to
1220 references in addition to targets. Note sure if this is correct!
1221 - Added code to hook into the unknown_reference_resolvers list for a
1222 transformer in resolve_indirect_target. This allows the
1223 unknown_reference_resolvers to keep around indirect targets which
1224 docutils doesn't know about.
1225 - Added specific error message for duplicate targets.
1227 * docutils/transforms/universal.py:
1229 - Added FilterMessages transform (removes system messages below the
1230 verbosity threshold).
1231 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1232 to FinalCheckVisitor for application-specific handling of
1233 unresolvable references.
1234 - Added specific error message for duplicate targets.
1236 * docutils/writers/__init__.py:
1238 - Added assemble_parts method to the Writer class to allow for
1239 access to a documents individual parts.
1240 - Documented & set default for ``Writer.output`` attribute.
1242 * docutils/writers/html4css1.py:
1244 - Fixed unicode handling of attribute values (bug 760673).
1245 - Prevent duplication of "class" attribute values (bug report from
1247 - Improved table grid/border handling (prompted by report from Bob
1249 - Added support for table titles.
1250 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1252 - Added functionality to keep track of individual parts of a document
1253 and store them in a dictionary as the "parts" attribute of the writer.
1254 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1255 - Added proper support for the "scale" attribute of the "image"
1256 element. Contributed by Brent Cook.
1257 - Added ``--initial-header-level`` option.
1258 - Fixed bug: the body_pre_docinfo segment depended on there being a
1259 docinfo; if no docinfo, the document title was incorporated into
1260 the body segment. Adversely affected the publish_parts interface.
1262 * docutils/writers/latex2e.py:
1264 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1265 about a missing file.
1266 - Added options and support: ``--compound-enumerators``,
1267 ``--section-prefix-for-enumerators``, and
1268 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1270 - Added option ``--use-verbatim-when-possible``, to avoid
1271 problematic characters (eg, '~' in italian) in literal blocks.
1272 - It's now possible to use four section levels in the `book` and
1273 `report` LaTeX classes. The default `article` class still has
1276 * docs/config.txt: "Docutils Configuration Files", added to project.
1277 Moved config file entry descriptions from tools.txt.
1281 - Moved config file entry descriptions to config.txt.
1283 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1286 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1287 Text Roles", added to project.
1289 * spec/rst/reStructuredText.txt:
1291 - Added description of support for <angle-bracketed> complex option
1292 arguments to option lists.
1293 - Added subsections for indented and quoted literal blocks.
1295 * test: Continually adding & updating tests.
1297 - Added test/test_settings.py & test/data/config_*.txt support
1299 - Added test/test_writers/test_htmlfragment.py.
1301 * test/DocutilsTestSupport.py:
1303 - Refactored LaTeX publisher test suite/case class names to make
1304 testing other writers easier.
1305 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1306 to test the processing of HTML fragments which use the new
1307 publish_parts convenience function.
1309 * tools/buildhtml.py:
1311 - Added support for the "--prune" option.
1312 - Removed dependency on pep2html.py; plaintext PEPs no longer
1315 * tools/docutils.conf:
1317 - Updated for configuration file reorganization.
1319 * tools/rst2html.py:
1321 - copied from tools/html.py
1325 - added a 'scripts' section to configuration
1326 - added 'tools/rst2html.py' to the scripts section
1329 Release 0.3 (2003-06-24)
1330 ========================
1334 * Renamed "attribute" to "option" for directives/extensions.
1336 * Renamed transform method "transform" to "apply".
1338 * Renamed "options" to "settings" for runtime settings (as set by
1339 command-line options). Sometimes "option" (singular) became
1340 "settings" (plural). Some variations below:
1342 - document.options -> document.settings (stored in other objects as
1344 - option_spec -> settings_spec (not directives though)
1345 - OptionSpec -> SettingsSpec
1346 - cmdline_options -> settings_spec
1347 - relative_path_options -> relative_path_settings
1348 - option_default_overrides -> settings_default_overrides
1349 - Publisher.set_options -> Publisher.get_settings
1353 * COPYING.txt: Added "Public Domain Dedication".
1355 * FAQ.txt: Frequently asked questions, added to project.
1359 - Updated with PyPI Trove classifiers.
1360 - Conditional installation of third-party modules.
1362 * docutils/__init__.py:
1364 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1365 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1366 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1367 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1368 option and its effect on the PEP template & writer.
1369 - Bumped version to 0.2.4 due to changes to the PEP template &
1371 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1372 - Added ``TransformSpec`` class for new transform system.
1373 - Bumped version to 0.2.6 for API changes (renaming).
1374 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1375 convenience functions.
1376 - Added ``Component.component_type`` attribute.
1377 - Bumped version to 0.2.8 because of the internal parser switch from
1378 plain lists to the docutils.statemachine.StringList objects.
1379 - Bumped version to 0.2.9 because of the frontend.py API changes.
1380 - Bumped version to 0.2.10 due to changes to the project layout
1381 (third-party modules removed from the "docutils" package), and
1382 signature changes in ``io.Input``/``io.Output``.
1383 - Changed version to 0.3.0 for release.
1387 - Made ``publish()`` a bit more convenient.
1388 - Generalized ``Publisher.set_io``.
1389 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1390 parameters; improved its docstring.
1391 - Added ``publish_file()`` and ``publish_string()``.
1392 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1394 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1395 "--dump-transforms" hidden options.
1396 - Added ``Publisher.apply_transforms()`` method.
1397 - Added ``Publisher.set_components()`` method; support for
1398 ``publish_*()`` conveninece functions.
1399 - Moved config file processing to docutils/frontend.py.
1400 - Added support for exit status ("exit_level" setting &
1401 ``enable_exit`` parameter for Publisher.publish() and convenience
1404 * docutils/frontend.py:
1406 - Check for & exit on identical source & destination paths.
1407 - Fixed bug with absolute paths & "--config".
1408 - Set non-command-line defaults in ``OptionParser.__init__()``:
1409 ``_source`` & ``_destination``.
1410 - Distributed ``relative_path_settings`` to components; updated
1411 ``OptionParser.populate_from_components()`` to combine it all.
1412 - Require list of keys in ``make_paths_absolute`` (was implicit in
1413 global ``relative_path_settings``).
1414 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1415 "--dump-settings", and "--dump-transforms" hidden options.
1416 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1417 code, replaced with correct code.
1418 - Added validation functionality for config files.
1419 - Added "--error-encoding" option/setting, "_disable_config"
1421 - Added encoding validation; updated "--input-encoding" and
1422 "--output-encoding"; added "--error-encoding-error-handler" and
1423 "--output-encoding-error-handler".
1424 - Moved config file processing from docutils/core.py.
1425 - Updated ``OptionParser.populate_from_components`` to handle new
1426 ``SettingsSpec.settings_defaults`` dict.
1427 - Added support for "-" => stdin/stdout.
1428 - Added "exit_level" setting ("--exit" option).
1432 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1433 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1434 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1435 - ``FileOutput.write()`` now returns the encoded output string.
1436 - Try to get path/stream name automatically in ``FileInput`` &
1438 - Added defaults for source & destination paths.
1439 - Allow for Unicode I/O with an explicit "unicode" encoding.
1440 - Added ``Output.encode()``.
1441 - Removed dependency on runtime settings; pass encoding directly.
1442 - Recognize Unicode strings in ``Input.decode()``.
1443 - Added support for output encoding error handlers.
1445 * docutils/nodes.py:
1447 - Added "Invisible" element category class.
1448 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1449 modification during a traversal.
1450 - Added element classes: ``line_block``, ``generated``, ``address``,
1451 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1452 ``superscript``, ``subscript``, ``inline``
1453 - Added support for lists of nodes to ``Element.insert()``.
1454 - Fixed parent linking in ``Element.replace()``.
1455 - Added new abstract superclass ``FixedTextElement``; adds
1456 "xml:space" attribute.
1457 - Added support for "line" attribute of ``system_message`` nodes.
1458 - Added support for the observer pattern from ``utils.Reporter``.
1459 Added ``parse_messages`` and ``transform_messages`` attributes to
1460 ``document``, removed ``messages``. Added ``note_parse_message``
1461 and ``note_transform_message`` methods.
1462 - Added support for improved diagnostics:
1464 - Added "document", "source", and "line" internal attributes to
1465 ``Node``, set by ``Node.setup_child()``.
1466 - Converted variations on ``node.parent = self`` to
1467 ``self.setup_child(node)``.
1468 - Added ``document.current_source`` & ``.current_line``
1469 attributes, and ``.note_source`` observer method.
1470 - Changed "system_message" output to GNU-Tools format.
1472 - Added a "rawsource" attribute to the ``Text`` class, for text
1473 before backslash-escape resolution.
1474 - Support for new transform system.
1475 - Reworked ``pending`` element.
1476 - Fixed XML DOM bug (SF #660611).
1477 - Removed the ``interpeted`` element class and added
1478 ``title_reference``, ``abbreviation``, ``acronym``.
1479 - Made substitutions case-sensitive-but-forgiving; moved some code
1481 - Fixed Unicode bug on element attributes (report: William Dode).
1483 * docutils/optik.py: Removed from project; replaced with
1484 extras/optparse.py and extras/textwrap.py. These will be installed
1485 only if they're not already present in the Python installation.
1487 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1488 only if it's not already present in the Python installation.
1490 * docutils/statemachine.py:
1492 - Factored out ``State.add_initial_transitions()`` so it can be
1494 - Converted whitespace-specific "blank" and "indent" transitions
1495 from special-case code to ordinary transitions: removed
1496 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1497 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1498 ``ws_initial_transitions`` attributes.
1499 - Removed ``State.match_transition()`` after merging it into
1501 - Added ``StateCorrection`` exception.
1502 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1503 (moved ``TransitionCorrection`` support there too.)
1504 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1505 ``EOFError`` instead of ``IndexError``.
1506 - Added ``State.no_match`` method.
1507 - Added support for the Observer pattern, triggered by input line
1509 - Added ``strip_top`` parameter to
1510 ``StateMachineWS.get_first_known_indented``.
1511 - Made ``context`` a parameter to ``StateMachine.run()``.
1512 - Added ``ViewList`` & ``StringList`` classes;
1513 ``extract_indented()`` becomes ``StringList.get_indented()``.
1514 - Added ``StateMachine.insert_input()``.
1515 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1516 thanks to) Fred Drake.
1518 * docutils/utils.py:
1520 - Added a ``source`` attribute to Reporter instances and
1521 ``system_message`` elements.
1522 - Added an observer pattern to ``utils.Reporter`` to keep track of
1524 - Fixed bugs in ``relative_path()``.
1525 - Added support for improved diagnostics.
1526 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1527 - Added support for encoding Reporter stderr output, and encoding
1529 - Reporter keeps track of the highest level system message yet
1532 * docutils/languages: Fixed bibliographic field language lookups.
1534 * docutils/languages/es.py: Added to project; Spanish mappings by
1535 Marcelo Huerta San Martin.
1537 * docutils/languages/fr.py: Added to project; French mappings by
1540 * docutils/languages/it.py: Added to project; Italian mappings by
1543 * docutils/languages/sk.py: Added to project; Slovak mappings by
1546 * docutils/parser/__init__.py:
1548 - Added ``Parser.finish_parse()`` method.
1550 * docutils/parser/rst/__init__.py:
1552 - Added options: "--pep-references", "--rfc-references",
1553 "--tab-width", "--trim-footnote-reference-space".
1555 * docutils/parsers/rst/states.py:
1557 - Changed "title under/overline too short" system messages from INFO
1558 to WARNING, and fixed its insertion location.
1559 - Fixed enumerated list item parsing to allow paragraphs & section
1560 titles to begin with enumerators.
1561 - Converted system messages to use the new "line" attribute.
1562 - Fixed a substitution reference edge case.
1563 - Added support for "--pep-references" and "--rfc-references"
1564 options; reworked ``Inliner`` code to make customization easier.
1565 - Removed field argument parsing.
1566 - Added support for short section title over/underlines.
1567 - Fixed "simple reference name" regexp to ignore text like
1568 "object.__method__"; not an anonymous reference.
1569 - Added support for improved diagnostics.
1570 - Reworked directive API, based on Dethe Elza's contribution. Added
1571 ``Body.parse_directive()``, ``.parse_directive_options()``,
1572 ``.parse_directive_arguments()`` methods.
1573 - Added ``ExtensionOptions`` class, to parse directive options
1574 without parsing field bodies. Factored
1575 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1576 ``ExtensionOptions``.
1577 - Improved definition list term/classifier parsing.
1578 - Added warnings for unknown directives.
1579 - Renamed ``Stuff`` to ``Struct``.
1580 - Now flagged as errors: transitions at the beginning or end of
1581 sections, empty sections (except title), and empty documents.
1582 - Updated for ``statemachine.StringList``.
1583 - Enabled recognition of schemeless email addresses in targets.
1584 - Added support for embedded URIs in hyperlink references.
1585 - Added backslash-escapes to inline markup end-string suffix.
1586 - Added support for correct interpreted text processing.
1587 - Fixed nested title parsing (topic, sidebar directives).
1588 - Added special processing of backslash-escaped whitespace (idea
1589 from David Abrahams).
1590 - Made substitutions case-sensitive-but-forgiving; moved some code
1591 to ``docutils.nodes``.
1592 - Added support for block quote attributions.
1593 - Added a kludge to work-around a conflict between the bubble-up
1594 parser strategy and short titles (<= 3 char-long over- &
1595 underlines). Fixes SF bug #738803 "infinite loop with multiple
1596 titles" submitted by Jason Diamond.
1597 - Added explicit interpreted text roles for standard inline markup:
1598 "emphasis", "strong", "literal".
1599 - Implemented "superscript" and "subscript" interpreted text roles.
1600 - Added initial support for "abbreviation" and "acronym" roles;
1602 - Added support for "--trim-footnote-reference-space" option.
1603 - Optional space before colons in directives & hyperlink targets.
1605 * docutils/parsers/rst/tableparser.py:
1607 - Fixed a bug that was producing unwanted empty rows in "simple"
1609 - Detect bad column spans in "simple" tables.
1611 * docutils/parsers/rst/directives: Updated all directive functions to
1614 * docutils/parsers/rst/directives/__init__.py:
1616 - Added ``flag()``, ``unchanged()``, ``path()``,
1617 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1618 directive option helper functions.
1619 - Added warnings for unknown directives.
1620 - Return ``None`` for missing directives.
1621 - Added ``register_directive()``, thanks to William Dode and Paul
1624 * docutils/parsers/rst/directives/admonitions.py:
1626 - Added "admonition" directive.
1628 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1629 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1630 "parsed-literal", "rubric", "epigraph", "highlights" and
1631 "pull-quote" directives.
1633 * docutils/parsers/rst/directives/images.py:
1635 - Added an "align" attribute to the "image" & "figure" directives
1636 (by Adam Chodorowski).
1637 - Added "class" option to "image", and "figclass" to "figure".
1639 * docutils/parsers/rst/directives/misc.py:
1641 - Added "include", "raw", and "replace" directives, courtesy of
1643 - Added "unicode" and "class" directives.
1645 * docutils/parsers/rst/directives/parts.py:
1647 - Added the "sectnum" directive; by Dmitry Jemerov.
1648 - Added "class" option to "contents" directive.
1650 * docutils/parsers/rst/directives/references.py: Added to project.
1651 Contains the "target-notes" directive.
1653 * docutils/parsers/rst/languages/__init__.py:
1655 - Return ``None`` from get_language() for missing language modules.
1657 * docutils/parsers/rst/languages/de.py: Added to project; German
1658 mappings by Engelbert Gruber.
1660 * docutils/parsers/rst/languages/en.py:
1662 - Added interpreted text roles mapping.
1664 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1665 mappings by Marcelo Huerta San Martin.
1667 * docutils/parsers/rst/languages/fr.py: Added to project; French
1668 mappings by William Dode.
1670 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1671 mappings by Nicola Larosa.
1673 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1674 mappings by Miroslav Vasko.
1676 * docutils/readers/__init__.py:
1678 - Added support for the observer pattern from ``utils.Reporter``, in
1679 ``Reader.parse`` and ``Reader.transform``.
1680 - Removed ``Reader.transform()`` method.
1681 - Added default parameter values to ``Reader.__init__()`` to make
1682 instantiation easier.
1683 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1685 * docutils/readers/pep.py:
1687 - Added the ``peps.TargetNotes`` transform to the Reader.
1688 - Removed PEP & RFC reference detection code; moved to
1689 parsers/rst/states.py as options (enabled here by default).
1690 - Added support for pre-acceptance PEPs (no PEP number yet).
1691 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1694 * docutils/readers/python: Python Source Reader subpackage added to
1695 project, including preliminary versions of:
1698 - moduleparser.py: Parser for Python modules.
1700 * docutils/transforms/__init__.py:
1702 - Added ``Transformer`` class and completed transform reform.
1703 - Added unknown_reference_resolvers list for each transformer. This list holds
1704 the list of functions provided by each component of the transformer that
1705 help resolve references.
1707 * docutils/transforms/frontmatter.py:
1709 - Improved support for generic fields.
1710 - Fixed bibliographic field language lookups.
1712 * docutils/transforms/misc.py: Added to project. Miscellaneous
1715 * docutils/transforms/parts.py:
1717 - Moved the "id" attribute from TOC list items to the references
1718 (``Contents.build_contents()``).
1719 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1720 - Added "class" attribute support to ``Contents``.
1722 * docutils/transforms/peps.py:
1724 - Added ``mask_email()`` function, updating to pep2html.py's
1726 - Linked "Content-Type: text/x-rst" to PEP 12.
1727 - Added the ``TargetNotes`` PEP-specific transform.
1728 - Added ``TargetNotes.cleanup_callback``.
1729 - Added title check to ``Headers``.
1731 * docutils/transforms/references.py:
1733 - Added the ``TargetNotes`` generic transform.
1734 - Split ``Hyperlinks`` into multiple transforms.
1735 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1736 - Added check for circular indirect references.
1737 - Made substitutions case-sensitive-but-forgiving.
1739 * docutils/transforms/universal.py:
1741 - Added support for the "--expose-internal-attributes" option.
1742 - Removed ``Pending`` transform classes & data.
1744 * docutils/writers/__init__.py:
1746 - Removed ``Writer.transform()`` method.
1748 * docutils/writers/docutils-xml.py:
1750 - Added XML and doctype declarations.
1751 - Added "--no-doctype" and "--no-xml-declaration" options.
1753 * docutils/writers/html4css1.py:
1755 - "name" attributes only on these tags: a, applet, form, frame,
1757 - Added "name" attribute to <a> in section titles for Netscape 4
1758 support (bug report: Pearu Peterson).
1759 - Fixed targets (names) on footnote, citation, topic title,
1760 problematic, and system_message nodes (for Netscape 4).
1761 - Changed field names from "<td>" to "<th>".
1762 - Added "@" to "@" encoding to thwart address harvesters.
1763 - Improved the vertical whitespace optimization; ignore "invisible"
1764 nodes (targets, comments, etc.).
1765 - Improved inline literals with ``<span class="pre">`` around chunks
1766 of text and `` `` for runs of spaces.
1767 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1768 ``self.docinfo`` segments.
1769 - Added support for "line_block", "address" elements.
1770 - Improved backlinks (footnotes & system_messages).
1771 - Improved system_message output.
1772 - Redefined "--stylesheet" as containing an invariant URL, used
1773 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1775 - Added "--footnote-references" option (superscript or brackets).
1776 - Added "--compact-lists" and "--no-compact-lists" options.
1777 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1778 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1779 - Improved field list rendering.
1780 - Added Docutils version to "generator" meta tag.
1781 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1782 - Improved layout of <pre> HTML source.
1783 - Fixed attribute typo on <colspec>.
1784 - Refined XML prologue.
1785 - Support for no stylesheet.
1786 - Removed "interpreted" element support.
1787 - Added support for "title_reference", "sidebar", "attribution",
1788 "rubric", and generic "admonition" elements.
1789 - Added "--attribution" option.
1790 - Added support for "inline", "subscript", "superscript" elements.
1791 - Added initial support for "abbreviation" and "acronym";
1794 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1798 - Double quotes in literal blocks (special treatment for de/ngerman).
1799 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1800 - Added "--attribution" option.
1801 - Right align attributions.
1803 * docutils/writers/pep_html.py:
1805 - Parameterized output encoding in PEP template.
1806 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1807 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1808 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1810 - Added an override on the "--footnote-references" option.
1811 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1812 - Added Docutils version to "generator" meta tag.
1813 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1817 - Added a "silent" setting for ``buildhtml.py``.
1818 - Added a "Getting Help" section.
1819 - Rearranged the structure.
1820 - Kept up to date, with new settings, command-line options etc.
1821 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1822 - Converted settings table into a definition list.
1824 * docs/rst/quickstart.txt:
1826 - Added a table of contents.
1827 - Added feedback information.
1828 - Added mention of minimum section title underline lengths.
1829 - Removed the 4-character minimum for section title underlines.
1831 * docs/rst/quickref.html:
1833 - Added a "Getting Help" section.
1834 - Added a style to make section title backlinks more subtle.
1835 - Added mention of minimum section title underline lengths.
1836 - Removed the 4-character minimum for section title underlines.
1838 * extras: Directory added to project; contains third-party modules
1839 that Docutils depends on (optparse, textwrap, roman). These are
1840 only installed if they're not already present.
1842 * licenses: Directory added to project; contains copies of license
1843 files for non-public-domain files.
1847 - Changed the focus. It's about DTD elements: structural
1848 relationships, semantics, and external (public) attributes. Not
1849 about the element class library.
1850 - Moved some implementation-specific stuff into ``docutils.nodes``
1852 - Wrote descriptions of all common attributes and parameter
1853 entities. Filled in introductory material.
1854 - Working through the element descriptions: 55 down, 37 to go.
1855 - Removed "Representation of Horizontal Rules" to
1856 spec/rst/alternatives.txt.
1858 * spec/docutils.dtd:
1860 - Added "generated" inline element.
1861 - Added "line_block" body element.
1862 - Added "auto" attribute to "title".
1863 - Changed content models of "literal_block" and "doctest_block" to
1865 - Added ``%number;`` attribute type parameter entity.
1866 - Changed ``%structural.elements;`` to ``%section.elements``.
1867 - Updated attribute types; made more specific.
1868 - Added "address" bibliographic element.
1869 - Added "line" attribute to ``system_message`` element.
1870 - Removed "field_argument" element; "field_name" may contain
1871 multiple words and whitespace.
1872 - Changed public identifier to docutils.sf.net.
1873 - Removed "interpreted" element; added "title_reference",
1874 "abbreviation", "acronym".
1875 - Removed "refuri" attribute from "footnote_reference" and
1876 "citation_reference".
1877 - Added "sidebar", "rubric", "attribution", "admonition",
1878 "superscript", "subscript", and "inline" elements.
1880 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1882 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1884 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1886 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1889 * spec/transforms.txt: Added to project.
1891 * spec/howto: Added subdirectory, for developer how-to docs.
1893 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1894 Elza, edited & extended by David Goodger.
1896 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1899 * spec/rst/alternatives.txt:
1901 - Added "Doctree Representation of Transitions" from
1903 - Updated "Inline External Targets" & closed the debate.
1904 - Added ideas for interpreted text syntax extensions.
1905 - Added "Nested Inline Markup" section.
1907 * spec/rst/directives.txt:
1909 - Added directives: "topic", "sectnum", "target-notes",
1910 "line-block", "parsed-literal", "include", "replace", "sidebar",
1911 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1913 - Formalized descriptions of directive details.
1914 - Added an "align" attribute to the "image" & "figure" directives
1915 (by Adam Chodorowski).
1916 - Added "class" options to "topic", "sidebar", "line-block",
1917 "parsed-literal", "contents", and "image"; and "figclass" to
1920 * spec/rst/interpreted.txt: Added to project. Descriptions of
1921 interpreted text roles.
1923 * spec/rst/introduction.txt:
1925 - Added pointers to material for new users.
1927 * spec/rst/reStructuredText.txt:
1929 - Disambiguated comments (just add a newline after the "::").
1930 - Updated enumerated list description; added a discussion of the
1931 second-line validity checking.
1932 - Updated directive description.
1933 - Added a note redirecting newbies to the user docs.
1934 - Expanded description of inline markup start-strings in non-markup
1936 - Removed field arguments and made field lists a generic construct.
1937 - Removed the 4-character minimum for section title underlines.
1938 - Clarified term/classifier delimiter & inline markup ambiguity
1940 - Added "Embedded URIs".
1941 - Updated "Interpreted Text" section.
1942 - Added "Character-Level Inline Markup" section.
1944 * test: Continually adding & updating tests.
1946 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1947 - Moved test/test_pep/ to test/test_readers/test_pep/.
1948 - Added test/test_readers/test_python/.
1949 - Added test/test_writers/ (Engelbert Gruber).
1953 - Made the ``locale.setlocale()`` calls in front ends
1956 * tools/buildhtml.py:
1958 - Added "--silent" option.
1959 - Fixed bug with absolute paths & "--config".
1960 - Updated for new I/O classes.
1961 - Added some exception handling.
1962 - Separated publishers' setting defaults; prevents interference.
1963 - Updated for new ``publish_file()`` convenience function.
1965 * tools/pep-html-template:
1967 - Allow for "--embed-stylesheet".
1968 - Added Docutils version to "generator" meta tag.
1969 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1970 - Conform to XHTML spec.
1972 * tools/pep2html.py:
1974 - Made ``argv`` a parameter to ``main()``.
1975 - Added support for "Content-Type:" header & arbitrary PEP formats.
1976 - Linked "Content-Type: text/plain" to PEP 9.
1977 - Files skipped (due to an error) are not pushed onto the server.
1978 - Updated for new I/O classes.
1979 - Added ``check_requirements()`` & ``pep_type_error()``.
1980 - Added some exception handling.
1981 - Updated for new ``publish_string()`` convenience function.
1982 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1984 * tools/quicktest.py:
1986 - Added "-V"/"--version" option.
1988 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1990 * tools/unicode2rstsubs.py: Added to project. Produces character
1991 entity files (reSructuredText substitutions) from the MathML master
1994 * tools/editors: Support code for editors, added to project. Contains
1995 ``emacs/restructuredtext.el``.
1997 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1999 - Added style for chunks of inline literals.
2000 - Removed margin for first child of table cells.
2001 - Right-aligned field list names.
2002 - Support for auto-numbered section titles in TOCs.
2003 - Increased the size of inline literals (<tt>) in titles.
2004 - Restored the light gray background for inline literals.
2005 - Added support for "line_block" elements.
2006 - Added style for "address" elements.
2007 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2008 - Improved field list rendering.
2009 - Vertical whitespace improvements.
2010 - Removed "a.target" style.
2012 * tools/stylesheets/pep.css:
2014 - Fixed nested section margins.
2015 - Other changes parallel those of ``../default.css``.
2018 Release 0.2 (2002-07-31)
2019 ========================
2023 - The word "component" was being used ambiguously. From now on,
2024 "component" will be used to mean "Docutils component", as in Reader,
2025 Writer, Parser, or Transform. Portions of documents (Table of
2026 Contents, sections, etc.) will be called "document parts".
2027 - Did a grand renaming: a lot of ``verylongnames`` became
2028 ``very_long_names``.
2029 - Cleaned up imports: no more relative package imports or
2030 comma-separated lists of top-level modules.
2031 - Added support for an option values object which carries default
2032 settings and overrides (from command-line options and library use).
2033 - Added internal Unicode support, and support for both input and
2035 - Added support for the ``docutils.io.IO`` class & subclasses.
2039 * docutils/__init__.py:
2041 - Added ``ApplicationError`` and ``DataError``, for use throughout
2043 - Added ``Component`` base class for Docutils components; implements
2044 the ``supports`` method.
2045 - Added ``__version__`` (thus, ``docutils.__version__``).
2049 - Removed many keyword parameters to ``Publisher.__init__()`` and
2050 ``publish()``; bundled into an option values object. Added
2051 "argv", "usage", "description", and "option_spec" parameters for
2052 command-line support.
2053 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2055 - Reworked I/O model for ``docutils.io`` wrappers.
2056 - Updated ``Publisher.set_options()``; now returns option values
2058 - Added support for configuration files (/etc/docutils.conf,
2059 ./docutils.conf, ~/.docutils).
2060 - Added ``Publisher.setup_option_parser()``.
2061 - Added default usage message and description.
2063 * docutils/frontend.py: Added to project; support for front-end
2064 (command-line) scripts. Option specifications may be augmented by
2065 components. Requires Optik (http://optik.sf.net/) for option
2066 processing (installed locally as docutils/optik.py).
2068 * docutils/io.py: Added to project; uniform API for a variety of input
2071 * docutils/nodes.py:
2073 - Added ``TreeCopyVisitor`` class.
2074 - Added a ``copy`` method to ``Node`` and subclasses.
2075 - Added a ``SkipDeparture`` exception for visitors.
2076 - Renamed ``TreePruningException`` from ``VisitorException``.
2077 - Added docstrings to ``TreePruningException``, subclasses, and
2079 - Improved docstrings.
2080 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2081 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2083 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2084 ``PreDecorative`` mixin.
2085 - Reworked the name/id bookkeeping; to ``document``, removed
2086 ``explicit_targets`` and ``implicit_targets`` attributes, added
2087 ``nametypes`` attribute and ``set_name_id_map`` method.
2088 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2090 - Added ``document.has_name()`` method.
2091 - Fixed DOM generation for list-attributes.
2092 - Added category class ``Labeled`` (used by footnotes & citations).
2093 - Added ``Element.set_class()`` method (sets "class" attribute).
2095 * docutils/optik.py: Added to project. Combined from the Optik
2096 package, with added option groups and other modifications. The use
2097 of this module is probably only temporary.
2099 * docutils/statemachine.py:
2101 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2102 - Added underscores to improve many awkward names.
2103 - In ``string2lines()``, changed whitespace normalizing translation
2104 table to regexp; restores Python 2.0 compatibility with Unicode.
2106 * docutils/urischemes.py:
2108 - Filled in some descriptions.
2109 - Added "shttp" scheme.
2111 * docutils/utils.py:
2113 - Added ``clean_rcs_keywords`` function (moved from
2114 docutils/transforms/frontmatter.py
2115 ``DocInfo.filter_rcs_keywords``).
2116 - Added underscores to improve many awkward names.
2117 - Changed names of Reporter's thresholds:
2118 warning_level -> report_level; error_level -> halt_level.
2119 - Moved ``utils.id()`` to ``nodes.make_id()``.
2120 - Added ``relative_path(source, target)``.
2122 * docutils/languages/de.py: German mappings; added to project. Thanks
2123 to Gunnar Schwant for the translations.
2125 * docutils/languages/en.py: Added "Dedication" bibliographic field
2128 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2131 * docutils/parsers/rst/states.py:
2133 - Added underscores to improve many awkward names.
2134 - Added RFC-2822 header support.
2135 - Extracted the inline parsing code from ``RSTState`` to a separate
2136 class, ``Inliner``, which will allow easy subclassing.
2137 - Made local bindings for ``memo`` container & often-used contents
2138 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2139 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2140 - Added ``MarkupMismatch`` exception; for late corrections.
2141 - Added ``-/:`` characters to inline markup's start string prefix,
2142 ``/`` to end string suffix.
2143 - Fixed a footnote bug.
2144 - Fixed a bug with literal blocks.
2145 - Applied patch from Simon Budig: simplified regexps with symbolic
2146 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2147 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2148 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2149 - Allowed non-ASCII in "simple names" (directive names, field names,
2151 - Converted ``Inliner.patterns.initial`` to be dynamically built
2152 from parts with ``build_regexp()`` function.
2153 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2154 - Updated docstrings.
2155 - Changed "table" to "grid_table"; added "simple_table" support.
2157 * docutils/parsers/rst/tableparser.py:
2159 - Changed ``TableParser`` to ``GridTableParser``.
2160 - Added ``SimpleTableParser``.
2161 - Refactored naming.
2163 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2164 a fallback language for directive names.
2166 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2167 directive to use a ``pending`` element, used only by HTML writers.
2169 * docutils/parsers/rst/directives/parts.py: Renamed from
2172 - Added "backlinks" attribute to "contents" directive.
2174 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2175 project by Adam Chodorowski.
2177 * docutils/readers/__init__.py: Gave Readers more control over
2178 choosing and instantiating Parsers.
2180 * docutils/readers/pep.py: Added to project; for PEP processing.
2182 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2183 requires a ``component`` parameter.
2185 * docutils/transforms/components.py: Added to project; transforms
2186 related to Docutils components.
2188 * docutils/transforms/frontmatter.py:
2190 - In ``DocInfo.extract_authors``, check for a single "author" in an
2191 "authors" group, and convert it to a single "author" element.
2192 - Added support for "Dedication" and generic bibliographic fields.
2194 * docutils/transforms/peps.py: Added to project; PEP-specific.
2196 * docutils/transforms/parts.py: Renamed from old components.py.
2198 - Added filter for `Contents`, to use alt-text for inline images,
2199 and to remove inline markup that doesn't make sense in the ToC.
2200 - Added "name" attribute to TOC topic depending on its title.
2201 - Added support for optional TOC backlinks.
2203 * docutils/transforms/references.py: Fixed indirect target resolution
2204 in ``Hyperlinks`` transform.
2206 * docutils/transforms/universal.py:
2208 - Changed ``Messages`` transform to properly filter out system
2209 messages below the warning threshold.
2210 - Added ``Decorations`` transform (support for ``--generator``,
2211 ``--date``, ``--time``, ``--source-link`` options).
2213 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2214 Engelbert Gruber's PDF writer.
2216 * docutils/writers/html4css1.py:
2218 - Made XHTML-compatible (switched to lowercase element & attribute
2219 names; empty tag format).
2220 - Escape double-dashes in comment text.
2221 - Improved boilerplate & modularity of output.
2222 - Exposed modular output in Writer class.
2223 - Added a "generator" meta tag to <head>.
2224 - Added support for the ``--stylesheet`` option.
2225 - Added support for ``decoration``, ``header``, and ``footer``
2227 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2228 translation table to regexp; restores Python 2.0 compatibility
2230 - Added the translator class as instance variable to the Writer, to
2231 make it easily subclassable.
2232 - Improved option list spacing (thanks to Richard Jones).
2233 - Modified field list output.
2234 - Added backlinks to footnotes & citations.
2235 - Added percentage widths to "<col>" tags (from colspec).
2236 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2237 "<span>" changed to "<var>".
2238 - Inline literals: "<code>" changed to "<tt>".
2239 - Many changes to optimize vertical space: compact simple lists etc.
2240 - Add a command-line options & directive attributes to control TOC
2241 and footnote/citation backlinks.
2242 - Added support for optional footnote/citation backlinks.
2243 - Added support for generic bibliographic fields.
2244 - Identify backrefs.
2245 - Relative URLs for stylesheet links.
2247 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2248 PEPs (subclass of ``html4css1.Writer``).
2250 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2252 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2253 of the Docutils internal doctree in XML.
2255 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2259 - Changed the title to "The Docutils Document Tree".
2260 - Added "Hyperlink Bookkeeping" section.
2262 * spec/docutils.dtd:
2264 - Added ``decoration``, ``header``, and ``footer`` elements.
2265 - Brought ``interpreted`` element in line with the parser: changed
2266 attribute "type" to "role", added "position".
2267 - Added support for generic bibliographic fields.
2269 * spec/notes.txt: Continual updates. Added "Project Policies".
2271 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2274 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2276 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2277 mailing list discussions.
2279 * spec/pep-0287.txt:
2281 - Renamed to "reStructuredText Docstring Format".
2283 - Reworked Q&A as an enumerated list.
2284 - Converted to reStructuredText format.
2286 * spec/pysource.dtd:
2288 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2290 * spec/pysource.txt: Removed from project. Moved much of its contents
2293 * spec/rst/alternatives.txt:
2295 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2296 - Added "Inline External Targets" section.
2298 * spec/rst/directives.txt:
2300 - Added "backlinks" attribute to "contents" directive.
2302 * spec/rst/problems.txt:
2304 - Updated the Enumerated List Markup discussion.
2305 - Added new alternative table markup syntaxes.
2307 * spec/rst/reStructuredText.txt:
2309 - Clarified field list usage.
2310 - Updated enumerated list description.
2311 - Clarified purpose of directives.
2312 - Added ``-/:`` characters to inline markup's start string prefix,
2313 ``/`` to end string suffix.
2314 - Updated "Authors" bibliographic field behavior.
2315 - Changed "inline hyperlink targets" to "inline internal targets".
2316 - Added "simple table" syntax to supplement the existing but
2317 newly-renamed "grid tables".
2318 - Added cautions for anonymous hyperlink use.
2319 - Added "Dedication" and generic bibliographic fields.
2321 * test: Made test modules standalone (subdirectories became packages).
2323 * test/DocutilsTestSupport.py:
2325 - Added support for PEP extensions to reStructuredText.
2326 - Added support for simple tables.
2327 - Refactored naming.
2329 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2331 - Now supports true packages containing test modules
2332 (``__init__.py`` files required); fixes duplicate module name bug.
2334 * test/test_pep/: Subpackage added to project; PEP testing.
2336 * test/test_rst/test_SimpleTableParser.py: Added to project.
2340 - Updated html.py and publish.py front-end tools to use the new
2341 command-line processing facilities of ``docutils.frontend``
2342 (exposed in ``docutils.core.Publisher``), reducing each to just a
2344 - Added ``locale.setlocale()`` calls to front-end tools.
2346 * tools/buildhtml.py: Added to project; batch-generates .html from all
2347 the .txt files in directories and subdirectories.
2349 * tools/default.css:
2351 - Added support for ``header`` and ``footer`` elements.
2352 - Added styles for "Dedication" topics (biblio fields).
2354 * tools/docutils.conf: A configuration file; added to project.
2356 * tools/docutils-xml.py: Added to project.
2358 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2360 * tools/pep-html-template: Added to project.
2362 * tools/pep2html.py: Added to project from Python (nondist/peps).
2363 Added support for Docutils (reStructuredText PEPs).
2365 * tools/quicktest.py:
2367 - Added the ``--attributes`` option, hacked a bit.
2368 - Added a second command-line argument (output file); cleaned up.
2370 * tools/stylesheets/: Subdirectory added to project.
2372 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2375 Release 0.1 (2002-04-20)
2376 ========================
2378 This is the first release of Docutils, merged from the now inactive
2379 reStructuredText__ and `Docstring Processing System`__ projects. For
2380 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2381 `DPS HISTORY`__ files.
2383 __ http://structuredtext.sourceforge.net/
2384 __ http://docstring.sourceforge.net/
2385 __ http://structuredtext.sourceforge.net/HISTORY.html
2386 __ http://docstring.sourceforge.net/HISTORY.html
2388 General changes: renamed 'dps' package to 'docutils'; renamed
2389 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2390 the test suites (reStructuredText's test/test_states renamed to
2391 test/test_rst); and all modifications required to make it all work.
2393 * docutils/parsers/rst/states.py:
2395 - Improved diagnostic system messages for missing blank lines.
2396 - Fixed substitution_reference bug.
2402 indent-tabs-mode: nil
2403 sentence-end-double-space: t