1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
24 - Installing with ``setup.py`` now requires ``setuptools``.
25 Alternatively, install with `pip`_ (or "manually").
26 - Use importlib.import_module() to programmatically import modules.
27 - Fix bug #385: Import of language modules.
29 .. _pip: https://pypi.org/project/pip/
31 * docutils/MANIFEST.in
33 - Exclude test outputs.
35 * docutils/__init__.py
37 - VersionInfo: ValueError for invalid values, fix comparison to tuples.
40 docutils/parsers/rst/languages/
42 - Apply patch # 177 Arabic mappings by Shahin.
43 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
47 - Apply patch #165 "Fix error when copying `system_message` node"
49 - Apply version of patch #167 "Let document.set_id() register all
50 existing IDs" (thanks to Takeshi KOMIYA).
51 - Fix bug #410: Use a "property" function to recursively fetch
52 `Node.document` value from parent node.
54 * docutils/parsers/recommonmark_wrapper.py
56 - New, experimental wrapper to integrate the
57 `recommonmark`__ Markdown parser for use with Docutils.
59 __ https://pypi.org/project/recommonmark/
61 * docutils/parsers/rst/directives/body.py
63 - Make the sidebar's "title" argument optional (feature request #69).
65 * docutils/parsers/rst/directives/html.py
67 - Make "meta" elements available for "latex" and "odt".
69 * docutils/parsers/rst/directives/misc.py
71 - Prevent infinite inclusion loops.
73 * docutils/parsers/rst/roles.py
75 - Apply patch #174 `Lowercase new role names on registration`
76 by John Thorvald Wodder II.
78 * docutils/utils/smartquotes.py
80 - Fix bug #383: Smart quotes around opening and separator characters.
82 * docutils/transforms/components.py
84 - Allow a comma-separated list of formats for the Filter transform.
86 * docutils/writers/html*
88 - Implement feature request #40 `Option to embed images as data URI`.
90 * docutils/writers/html5_polyglot/__init__.py
92 - Use the new semantic tags <main>, <section>, <header>,
93 <footer>, <aside>, <figure>, and <figcaption>.
94 See ``minimal.css`` and ``plain.css`` for styling rule examples.
96 Change the `initial_header_level` setting default to "2", as browsers
97 use the `same style for <h1> and <h2> when nested in a <section\>`__.
99 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
101 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
102 <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
103 is found in `inline` and `literal` elements.
104 Use <ins> and <del> if a matching class value
105 is found in `inline`, `literal`, or `container` elements.
107 - Fix bug #398: properly close link tag to "schema.dcterms".
109 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
111 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
113 - Add code line numbers as "data-*" arguments.
114 This way, they may be skipped when copying text from code blocks
115 (see minimal.css). Solves feature request #32.
117 * docutils/writers/html5_polyglot/minimal.css
119 - Move non-essential styling to ``plain.css``.
120 Support "captionbelow" class value for tables.
121 Small fixes and tweaks.
123 * docutils/writers/html5_polyglot/plain.css
125 - Support numbered figures.
127 * docutils/writers/html5_polyglot/responsive.css
129 - New optional style that adapts to different screen sizes.
131 * docutils/writers/latex2e/__init__.py:
133 - Use LaTeX environments for admonitions and "class wrappers" for styling
134 admonitions and titles if the new configuration setting
135 `legacy_class_functions`_ is False.
137 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
139 - Remove backwards compatibility code for the deprecated
140 `styling command`__ prefix ``\docutilsrole``.
142 __ docs/user/latex.html#custom-interpreted-text-roles
144 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
146 - Support the `memoir` LaTeX document class.
147 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
149 - The special value "auto" for the `graphicx_option`_ setting
150 is no longer supported (it never worked for xetex/luatex).
152 .. _graphicx_option: docs/user/config.html#graphicx-option
154 - Most helper commands and element definitions are now defined in the
155 LaTeX package `docutils.sty`_ and only inserted in the document
156 preamble if the `stylesheet`__ setting does not list "docutils".
158 .. _docutils.sty: https://ctan.org/pkg/docutils
159 __ docs/user/config.html#stylesheet-latex-writers
161 - Apply patch #173 "Make \*TeX writers convert nonstandard table
162 classes to DUclass environments" by John Thorvald Wodder II.
164 - Fix bug #408 "Incorrect assert in latex writer
165 for multiple citation references".
167 - Apply patch #175 "Fix alignment of nested tables"
168 by John Thorvald Wodder II. Additional fixes to table alignment.
170 - Do not write Docutils-generated ToC, when ``use_latex_toc``
171 is True. (This did happen when publishing from a doctree.)
173 - Set PDF document properties from "meta" directive content.
175 - Apply version of patch #176 "LaTeX writer: Append \leavevmode to
176 non-docinfo field names" by John Thorvald Wodder II.
178 * docutils/writers/manpage.py
180 - Fix #394 fix missing new line after rubric.
181 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
182 - Fix #126 manpage title with spaces.
183 - Fix #380 commandline option problem in sphinx.
185 * docutils/writers/odf_odt/__init__.py:
187 - Fix/improve metadata handling:
188 fix "keyword" splitting,
189 allow generic fields (stored as "Custom Properties").
191 * docutils/writers/pseudoxml.py:
193 - New option `detailled`__.
195 __ docs/user/config.html#detailled
197 * test/DocutilsTestSupport.py
199 - Run python3 test like python2 against source not the build/-directory
201 * tools/docutils_cli.py
203 - New generic command line front end that allows the free selection of
204 reader, parser, and writer components.
207 Release 0.16 (2020-01-16)
208 =========================
212 - Dropped support for Python 2.6, 3.3 and 3.4
213 - Docutils now supports Python 2.7 and Python 3.5+ natively
214 (without conversion by ``2to3``).
215 - Keep `backslash escapes`__ in the document tree. Backslash characters in
216 text are be represented by NULL characters in the ``text`` attribute of
217 Doctree nodes and removed in the writing stage by the node's
220 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
224 - Remove the `handle_io_errors` option from io.FileInput/Output.
228 - Speed up Node.next_node().
229 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
230 - Warn about Node.traverse() returning an iterator instead of a list
233 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
235 * docutils/statemachine.py
237 - Patch [ 158 ]: Speed up patterns by saving compiled versions (eric89gxl)
239 * docutils/transforms/universal.py
241 - Fix [ 332 ]: Standard backslash escape for smartquotes.
242 - Fix [ 342 ]: No escape in roles descending from `inline literal`.
244 * docutils/utils/__init__.py
246 - unescape() definition moved to `nodes` to avoid circular import
247 dependency. Fixes [ 366 ].
249 * docutils/writers/latex2e/__init__.py:
251 - Fix topic subtitle.
252 - Make "rubric" bold-italic and left aligned.
253 - Fix [ 339 ] don't use "alltt" or literal-block-environment
254 in admonitions and footnotes.
255 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
256 - Add "latex writers" to the `config_section_dependencies`.
257 - Ignore classes for `rubric` elements
258 (class wrapper interferes with LaTeX formatting).
260 * docutils/writers/manpage.py
262 - Apply fix for [ 287 ] comma after option is bold.
263 - Apply fix for [ 289 ], line starting with ``.`` in a text.
265 * docutils/writers/odf_odt/__init__.py:
267 - Fix: ElementTree.getchildren deprecated warning
269 * docutils/writers/xetex/__init__.py:
271 - Add "latex writers" to the `config_section_dependencies`.
275 - Fix: 377 ResourceWarning: unclosed file python3.8
276 Close alltests.out with atexit.
280 - Fix: 377 ResourceWarning: unclosed file python3.8
281 Read defaults file with context.
283 - Set "auto_id_prefix" to "%" (expands to tag-names).
284 Results in descriptive links in HTML and more localized changes when
285 editions to the input add or remove auto-ids.
289 - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
291 * test/test_writers/test_odt.py:
293 - Fix [ 359 ]: Test suite failes on Python 3.8. odt xml sorting.
294 Use ElementTree instead of minidom.
298 - New option `html-writer`_.
300 .. _html-writer: docs/user/config.html#html-writer
303 Release 0.15.1 (2019-07-24)
304 ===========================
306 source: branches/rel-0.15
308 Bugs #366 fix release for python2 only.
311 Release 0.15 (2019-07-20)
312 =========================
316 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
317 - Infrastructure automation.
319 * docs/ref/rst/restructuredtext.txt:
321 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
322 field list names (instead of ordinary text).
326 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
327 deprecated (thanks to hugovk).
329 * docutils/languages/ko.py
330 docutils/parsers/rst/languages/ko.py:
332 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
336 - Fix [ 251 ] system_message.copy() TypeError.
337 - Element.copy() also copies `document`, `line`, and `source` attributes.
339 * docutils/parsers/rst/__init__.py:
341 - Apply [ 152 ] reset `default role` at end of document.
343 * docutils/parsers/rst/states.py:
345 - Allow embedded colons in field list field names.
347 * docutils/parsers/rst/directives/html.py:
349 - Fix bug #281: Remove escaping backslashes in meta directive content.
351 * docutils/parsers/rst/directives/misc.py:
353 - Don't convert tabs to spaces, if `tab_width` is negative in
354 `include` directive with `code` option.
356 * docutils/parsers/rst/directives/tables.py:
358 - Apply patch #121: Add "width" option for the table directives.
360 * docutils/transforms/frontmatter.py:
362 - Add field name as class argument to generic docinfo fields unconditionally.
364 * docutils/transforms/references.py:
366 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
368 * docutils/utils/__init__.py:
370 - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
372 * docutils/utils/smartquotes.py:
374 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
376 * docutils/writers/html5_polyglot/
378 - automatically add HTML5-compatible meta tags for docinfo items
379 "authors", "date", and "copyright".
381 * docutils/writers/_html_base.py
383 - Fix bug #358: Non-breaking space removed from fixed-width literal.
385 * docutils/writers/latex2e/__init__.py:
387 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
389 - Fix bug #324: Invalid LaTeX for table with empty multicolumn cell.
390 - Fixes to literal block handling.
393 Release 0.14 (2017-08-03)
394 =========================
396 * docs/ref/docutils.dtd:
398 - Enable validation of Docutils XML documents against the DTD:
400 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
401 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
402 however, the `ids` attribute cannot use the ID type because `XML only
403 allows one ID per Element Type`__ and doesn't support a multiple-ID
404 "IDS" attribute type.
406 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
408 * docs/ref/rst/restructuredtext.txt:
410 - Added documentation for escaped whitespace in URI contexts.
411 - Clarify use of Unicode character categories.
413 * docutils/parsers/rst/states.py:
415 - Added functionality: escaped whitespace in URI contexts.
416 - Consistent handling of all whitespace characters in inline markup
417 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
419 * docutils/parsers/rst/directives/images.py:
421 - Added support for escaped whitespace in URI contexts.
423 * docutils/parsers/rst/directives/tables.py:
425 - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
426 that led to problems in an application with a custom table directive).
428 * docutils/transforms/frontmatter.py:
430 - Fix [ 320 ] Russian docinfo fields not recognized.
432 * docutils/transforms/references.py:
434 - Don't add a second ID to problematic references.
436 * docutils/transforms/universal.py:
438 Fix SmartQuotes: warn only once if language is unsupported,
439 keep "rawsource" when "educating" quotes.
441 * docutils/utils/__init__.py:
443 - Added ``split_escaped_whitespace`` function, support for escaped
444 whitespace in URI contexts.
446 * docutils/utils/error_reporting.py:
448 - Fix [ 321 ] Import block might cause name error.
450 * docutils/utils/smartquotes.py:
452 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
453 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
454 - Fix [ 313 ] Differentiate apostrophe from closing single quote
456 - Fix [ 317 ] Extra space inserted with French smartquotes.
457 - Add command line interface for stand-alone use (requires 2.7).
459 * docutils/writers/_html_base.py:
461 - Provide default title in metadata (required by HTML5).
462 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
463 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
464 reasons, we don't use a third party public installation as default but
465 warn if math-output_ is set to MathJax without specifying a URL.
467 * docutils/writers/html4css1/__init__.py:
469 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
471 * docutils/writers/latex2e/__init__.py:
473 - Handle class arguments for block-level elements by wrapping them
474 in a "DUclass" environment. This replaces the special handling for
475 "epigraph" and "topic" elements.
477 * docutils/writers/manpage.py:
479 - Apply [ 141 ] Handling inline in manpage writer.
481 * docutils/writers/odf_odt/__init__.py:
483 - Command setting ``language`` now sets the default language
484 of the generated ODF document.
485 - The use of image directive options :width: (%), :scale:, etc now
486 set the width/height/size of images in the generated ODF
488 - The heading/title of admonitions now reflects the language
489 specified by the ``language`` setting.
490 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
492 - Fixed [ 282 ] python3: AttributeError.
494 * tools/rst2html4.py: New front-end.
496 * tools/dev/generate_punctuation_chars.py: New skript
497 to test and update utils.punctuation_chars.
500 Release 0.13.1 (2016-12-09)
501 ===========================
503 * docutils/languages/fa.py
504 docutils/parsers/rst/languages/fa.py
505 docutils/languages/la.py
506 docutils/parsers/rst/languages/la.py:
508 - Apply [ 133 ] Persian mappings by Shahin Azad.
509 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
513 - Fix [ 253 ] Attribute key without value not allowed in XML.
517 - Apply [ 103 ] Recognize inline markups without word boundaries.
518 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
520 * docutils/parsers/rst/__init__.py
522 - Fix [ 233 ] Change the base URL for the :rfc: role.
524 * docutils/parsers/rst/directives/tables.py
526 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
529 - Implement feature request [ 48 ]
530 Add :align: option to the table directives.
531 Thanks to Takeshi KOMIYA for the patch.
533 * docutils/parsers/rst/roles.py
535 - Fix [ 295 ] Class argument for custom role inheriting from math.
537 * docutils/parsers/rst/tableparser.py
539 - Really fix [ 159 ] Spurious table column alignment errors.
541 * docutils/transforms/frontmatter.py
543 - Add name of generic bibliographic fields as a "classes" attribute value
544 (after conversion to a valid identifier form).
546 * docutils/utils/error_reporting.py
548 - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
550 * docutils/utils/math/math2html.py
552 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
553 - New upstream version (additional macros, piecewise integrals and sums).
555 * docutils/writers/_html_base.py
557 - New auxiliary module for definitions common to all HTML writers.
559 * docutils/writers/html5_polyglot/
561 - New HTML writer generating clean, polyglot_ markup conforming to
564 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
565 and recommended layout rules.
567 * docutils/writers/html4css1/__init__.py
569 - Add "docutils" to class values for "container" object to address [ 267 ].
570 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
571 ``default_stylesheet_path`` and ``default_template_path``.
572 - Fix [ 266 ] creating labels/class values in description list items.
573 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
574 - Fix footnotes with content that does not start with a paragraph.
575 - Use https in default MathJax URL (report Alan G Isaac).
576 - Outsourcing of common code to _html_base.py.
578 * docutils/writers/latex2e/__init__.py
580 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
581 admonitions and docinfo.
583 - Use absolute path for ``default_template_path``.
585 - Removed deprecated options ``--use-latex-footnotes`` and
586 ``--figure-footnotes``.
588 - Cleaner LaTeX code for enumerations and literal blocks.
590 - Use "hyperref" package together with "bookmark" (improved hyperlinking
593 - Fix [ 286 ] Empty column title cause invalid latex file.
595 - Fix [ 224 ] Fix rowspan support for tables.
597 - Let LaTeX determine the column widths in tables with "colwidths-auto".
598 Not suited for multi-paragraph cells!
600 * docutils/writers/odf_odt/__init__.py
602 - remove decode.encode of filename stored in zip.
604 * docutils/writers/xetex/__init__.py
606 - LuaLaTex compatibility: do not load "xunicode".
610 - New front-end ``rst2html5.py``.
614 - Test py26, py27, py33 and py34.
616 To use, install the ``tox`` package via pip or easy_install and use
617 tox from the project root directory.
619 .. _polyglot: http://www.w3.org/TR/html-polyglot/
620 .. _HTML 5: http://www.w3.org/TR/html5/
621 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
624 Release 0.12 (2014-07-06)
625 =========================
627 * docs/ref/rst/directives.txt
629 - Update "math" and "csv-table" descriptions.
631 * docutils/parsers/rst/directives/images.py
633 - Fix [ 258 ] figwidth="image" generates unitless width value.
635 * docutils/parsers/rst/states.py
637 - Improve error report when a non-ASCII character is specified as
638 delimiter, quote or escape character under Python 2.
639 Fixes [ 249 ] and [ 250 ].
641 * docutils/writers/html4css1/__init__.py
643 - Don't add newline after inline math.
644 Thanks to Yury G. Kudryashov for the patch.
646 * docutils/writers/latex2e/__init__.py
648 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
649 - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
651 * docutils/writers/odf_odt/__init__.py
653 - Apply patch by Jakub Wilk to fix bug [ 100 ].
655 * test/test_error_reporting.py
657 - Fix [ 223 ] by removing redundant tests we do not have control over.
661 - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
663 Release 0.11 (2013-07-22)
664 =========================
668 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
669 - Support embedded aliases within hyperlink references.
670 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
671 language module) before global search.
675 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
677 * docutils/parsers/rst/directives/__init__.py
679 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
681 * docutils/parsers/rst/directives/images.py
683 - Apply [ 3599485 ] node source/line information for sphinx translation.
685 * docutils/parsers/rst/directives/tables.py
687 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
689 * docutils/parsers/rst/states.py
691 - Fix [ 157 ] Line block parsing doesn't like system message.
692 - Always import our local copy of roman.py (report Larry Hastings).
694 * docutils/transforms/references.py
696 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
698 * docutils/utils/__init__.py
700 - Fix [ 3596884 ] exception importing ``docutils.io``.
702 * docutils/writers/html4css1/__init__.py
704 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
705 - New setting `stylesheet_dirs`: Comma-separated list of directories
706 where stylesheets are found. Used by `stylesheet_path` when expanding
707 relative path arguments.
708 - New default for math-output_: ``HTML math.css``.
709 - Avoid repeated class declarations in html4css1 writer
710 (modified version of patch [ 104 ]).
712 .. _math-output: docs/user/config.html#math-output
714 * docutils/writers/latex2e/__init__.py
716 - Drop the simple algorithm replacing straight double quotes with
717 English typographic ones.
718 Activate the SmartQuotes_ transform if you want this feature.
719 - Fix literal use of babel shorthands (straight quote, tilde, ...).
720 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
721 - New setting `stylesheet_dirs`.
723 .. _SmartQuotes: docs/user/config.html#smart-quotes
725 * docutils/writers/manpage.py
727 - Fix [3607063] handle lines starting with a period.
728 - Fix option separating comma was bold (thanks to Bill Morris).
730 Release 0.10 (2012-12-16)
731 =========================
735 - Dropped support for Python 2.3.
736 - ``docutils/math``, ``docutils/error_reporting.py``, and
737 ``docutils/urischemes.py`` moved to the utils package.
738 - Fix [3541369] Relative __import__ also with Python 3.3.
739 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
740 and parsers for Python 2.7 up.
741 - Fix import of PIL.Image.
742 - Change default of "syntax highlight" option to "long",
743 basic syntax highlight styles for LaTeX and HTML.
747 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
748 option is ignored and will be removed in a future release.
749 - Fix Py3k error writing to stdout with encoding differing from default.
750 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
752 * docutils/parsers/rst/directives/misc.py
754 - Fix [ 3546533 ] Unicode error with `date` directive.
756 * docutils/transforms/universal.py
758 - SmartQuotes transform for typographic quotes and dashes.
760 * docutils/utils/__init__.py
762 - normalize_language_tag() now returns `BCP 47`_ conformant tags
763 with subtags separated by ``-``.
765 * docutils/writers/html4css1/__init__.py
767 - Use ``<code>`` tag for inline "code",
768 do not drop nested inline nodes (syntax highlight tokens).
769 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
770 - No line break after opening inline math tag.
772 * docutils/writers/manpage.py
774 - Apply [ 3527401 ] addmonition's don't preserve indentation
775 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
777 * docutils/writers/xetex/__init__.py
779 - Apply [ 3555160 ] ensure order of "otherlanguages".
780 - Fix section numbering by LaTeX.
782 * docutils/writers/s5_html/__init__.py
784 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
786 * docutils/writers/s5_html/docutils_xml.py
788 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
789 - Fix/improve output with ``--indent`` option.
793 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
795 * tools/test/test_buildhtml.py
797 - Fix [ 3521167 ] allow running in any directory.
798 - Fix [ 3521168 ] allow running with Python 3.
801 Release 0.9.1 (2012-06-17)
802 ==========================
806 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
807 installed in the PYTHONPATH. Converted tests are now
808 stored in ``test3/``, tools no longer need conversion.
810 If you installed one of Docutils versions 0.7 ... 0.9 with
811 ``setup.py install`` under Python 3, remove the spurious
812 ``test/`` and ``tools/`` directories in the site library root.
816 - Make tests independent from the location of the ``test/`` directory.
817 - Use converted sources (from the ``build/`` directory) for tests under
822 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
826 - Fix writing binary data to sys.stdout under Python 3 (allows
827 ``rst2odt.py`` to be used with output redirection).
829 * docutils/parsers/rst/directives/misc.py
831 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
832 ``locale == C`` and 8-bit char in path argument of `include` directive.
836 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
839 Release 0.9 (2012-05-02)
840 ========================
844 - New reStructuredText "code" role and directive and "code" option
845 of the "include" directive with syntax highlighting by Pygments_.
846 - Fix parse_option_marker for option arguments containing ``=``.
847 - Fix [ 2993756 ]: import Python Imaging Library's Image module
848 via ``import PIL`` as starting with PIL 1.2,
849 "PIL lives in the PIL namespace only" (announcement__).
851 .. _Pygments: http://pygments.org/
852 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
856 - Fix [ 2971827 ] and [ 3442827 ]
857 extras/roman.py moved to docutils/utils/roman.py
859 * docutils/frontend.py
861 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
865 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
866 - `mode` argument for FileOutput avoids code replication in
868 - New exceptions InputError and OutputError for IO errors in
869 FileInput/FileOutput.
873 - No "hard" system exit on file IO errors: catch and report them in
874 `Publisher.reportException` instead. Allows handling by a calling
875 application if the configuration setting `traceback` is True.
877 * docutils/utils.py -> docutils/utils/__init__.py
879 - docutils.utils is now a package (providing a place for sub-modules)
881 .. note:: docutils/math, docutils/error_reporting.py, and
882 docutils/urischemes.py will move to the utils package in the next
883 release, too. See RELEASE-NOTES__
885 __ RELEASE-NOTES.html
887 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
888 errors recording non-ASCII filenames (fixes [ 3434355 ]).
890 - Fix relative_path() with source=None and `unicode` target.
892 * docutils/parsers/rst/states.py
894 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
895 characters and "international" quotes around inline markup.
896 - Use `field_marker` pattern to look for start of a
897 directive option block (fixes [ 3484857 ]).
899 * docutils/parsers/rst/tableparser.py
901 - Fix [ 2926161 ] for simple tables.
902 (Combining chars in grid tables still contribute to cell width.)
904 * docutils/writers/latex2e/__init__.py
906 - Support the `abbreviation` and `acronym` standard roles.
907 - Record only files required to generate the LaTeX source as dependencies.
908 - Fix handling of missing stylesheets.
909 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
910 when suppressing LaTeX section numbering.
911 - Use ``\DUtitle`` for unsupported section levels
912 - Apply [ 3512791 ] do not compare string literals with "is"
914 * docutils/writers/xetex/__init__.py
916 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
918 * docutils/writers/html4css1/__init__.py
920 - Change default for `math-output` setting to MathJax.
921 - Fix handling of missing stylesheets.
923 * docutils/writers/docutils_xml.py
925 - Use the visitor pattern with default_visit()/default_depart() methods
926 instead of minidom to facilitate special handling of selected nodes.
927 - Support raw XML (inserted as-is inside a <raw></raw> node).
929 * docutils/writers/manpage.py
931 - Do not emit comment line with trailing blank. Problematic for VCS.
933 Release 0.8.1 (2011-08-30)
934 ==========================
938 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
939 and [ 3395920 ] (correct copyright info for rst.el).
943 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
945 * docutils/writers/latex2e/__init__.py
947 - Clean up Babel language setting. Restores Sphinx compatibility.
949 Release 0.8 (2011-07-07)
950 ========================
954 - Handle language codes according to `BCP 47`_.
955 - If the specified language is not supported by Docutils,
956 warn and fall back to English.
957 - Math support: reStructuredText "math" role and directive,
958 ``math`` and ``math_block`` doctree elements.
959 - Decode command line arguments with the locale's preferred encoding
960 (to allow, e.g., ``--title=Dornröschen``).
961 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
962 - New sub-module `error_reporting`: handle encoding/decoding errors
963 when reporting exceptions.
964 - Some additions to the Docutils core are released under the 2-Clause BSD
965 license, see COPYING_ for details.
967 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
968 .. _COPYING: COPYING.html
972 - Most directives now support a "name" option that attaches a
975 - Directive content may start on the first line also when the directive
976 type accepts options.
978 * docs/dev/policies.txt:
980 - Recommend the 2-Clause BSD license
981 (http://opensource.org/licenses/BSD-2-Clause)
982 for code that is kept under the author's copyright.
984 * tools/buildhtml.py:
986 - Fix ``--local`` switch.
988 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
990 * docutils/writers/html4css1/__init__.py
992 - Set "lang" argument for objects with class argument
993 "language-<language tag>".
994 - New setting "math-output" with support for HTML, MathML, and LaTeX.
996 * docutils/writers/latex2e/__init__.py
998 - Fix [ 3043986 ] AttributeError using :local: with table of content.
999 - Place title data in the document preamble.
1000 - Load `babel` package only if required.
1001 - Update list of supported languages.
1002 - New config setting "hyperref-options".
1003 No hard-coded "unicode" hyperref option (clash with xetex).
1004 - Set language for custom roles, paragraphs, block-quotes, and
1005 line-quotes with class argument "language-<language tag>".
1006 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
1007 - Convert image URI to a local file path.
1008 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1009 has more than one paragraph (Wolfgang Scherer).
1010 - \leavevmode before longtable only when needed (prevents spurious vspace)
1011 - do not advance table counter for tables without caption
1013 * docutils/writers/xetex/__init__.py
1015 - New writer generating LaTeX code for compiling with ``xelatex``.
1017 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1018 option allows separate config options for XeTeX vs. LaTeX2e.
1020 * docutils/writers/manpage.py
1022 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1023 - Fix: vertical space cleaning for option group ``.``.
1025 * tools/editors/emacs/rst.el:
1027 - Fix [ 3001100 ] does not handle spaces in filenames
1028 (thanks to Jakub Wilk)
1030 * docutils/utils.py:
1032 - strip whitespace from stylesheet arguments
1033 - exclude combining chars from column_width()
1034 (partial fix for [ 2926161 ])
1036 * docutils/parsers/rst/directives/misc.py:
1038 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1043 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
1044 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1046 Release 0.7 (2010-07-07)
1047 ========================
1051 - Fix [ 2881769 ] setup configuration.
1052 - Fix [ 2788716 ] reporting problems in included files.
1056 - FileInput opens files as text files with universal newline support
1057 (mode "rU", configurable with the new optional argument "mode").
1061 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1065 - Fix [ 2923723 ] let decode_path() tolerate path == None
1067 * docutils/writers/html4css1/__init__.py
1069 - Support SVG and SWF images (thanks to Stefan Rank).
1070 - Generate valid XHTML for centered images with targets.
1071 Use CSS classes instead of "align" tags for image alignment.
1073 * docutils/writers/latex2e/__init__.py
1075 - Use `transforms.writer_aux.Admonitions` to "normalize" special
1077 - Use the ``\url`` command for URLs (breaks long URLs instead of
1078 writing into the margin).
1079 - Preserve runs of spaces in `inline literals`__.
1080 - Deprecate ``figure_footnotes`` setting.
1081 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
1082 - New ``latex_preamble`` setting.
1083 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1084 - Fix hyperlink targets (labels) for images, figures, and tables.
1085 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1086 - Apply [ 2961991 ] Call hyperref with unicode option.
1087 - Drop the special `output_encoding`__ default ("latin-1").
1088 The Docutils wide default (usually "UTF-8") is used instead.
1089 - Render inline markup in document title and subtitle.
1090 - Fix numbering depth with LaTeX section numbering.
1091 - Update Unicode -> LaTeX translations.
1092 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1094 __ docs/ref/restructuredtext.html#inline-literals
1095 __ docs/user/config.html#docutils-footnotes
1096 __ docs/user/config.html#output_encoding
1098 * docutils/writers/manpage.py
1100 - Fix: supported attribute (thanks to peter2108).
1101 - Remove trailing blanks in code (keep in sync with mercurial version).
1102 - Titles level 1, that is ``.SH``, always uppercase.
1103 - Apply patch from mg: literal text should be bold in man-pages.
1107 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1112 - Python 3 support: copy test/ and tools/ to the build-dir
1113 and convert Python sources with 2to3.
1116 Release 0.6 (2009-10-11)
1117 ========================
1121 - Docutils is now compatible with Python versions from 2.3 up to 2.6
1122 and convertible to 3.1 code.
1124 + Node.__nonzero__ returns True instead of 1.
1125 + use os.walk instead os.path.walk.
1126 + minimize "types" module where possible.
1127 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1128 + Text nodes now subclass unicode rather than UserString
1129 (which is gone in python 3.0).
1130 + 3.0 compatibility module docutils._compat
1132 + Drop 2.2 compatibility workarounds.
1133 + Drop extras/optparse.py and extras/textwrap.py
1134 (stdlib modules since 2.3).
1136 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
1137 - Unix man page export: manpage writer moved from sandbox to Doctutils
1140 - Apply [ 1719345 ] Galician translation
1141 - Apply [ 1905741 ] Polish translation
1142 - Apply [ 1878977 ] make_id(): deaccent characters.
1143 - Apply [ 2029251 ] return nonzero when tests fail.
1144 - Fix [ 1692788 ] allow UTF-8 in style sheets.
1145 - Fix [ 2781629 ] support non-ASCII chars in file names.
1146 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1147 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
1148 - Fix [ 2821266 ] --strict option works now like --halt=info.
1149 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
1150 - Fix [ 1627229 ] hyperlink references in substitutions.
1152 - The "newlatex" writer is orphaned.
1156 - Documented Unicode characters allowed as inline markup openers,
1157 closers, and delimiters.
1158 - Allow units for all length specifications.
1159 - Allow percent sign in "scale" argument of "figure" and "image" directives.
1160 - Bugfix: The "figalign" argument of a figure now works as intended
1161 (aligning the figure, not its contents).
1162 - Align images with class "align-[right|center|left]"
1163 (allows setting the alignment of an image in a figure).
1165 * docutils/nodes.py:
1167 - Added ``Element.__contains__`` method, for the in-operator.
1169 * docutils/parsers/rst/states.py:
1171 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1172 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1173 " " (non-breaking space), and "¡ ¿" openers.
1175 * docutils/parsers/directives/misc.py:
1177 - Added ``start-line`` and ``end-line`` options to "include"
1178 directive to select a range of lines.
1179 - Hard tabs in literal inclusions are replaced by spaces. This is
1180 configurable via the new ``tab-width`` option of the "include" directive
1181 (a negative tab-width prevents tab expansion).
1183 * docutils/utils.py:
1185 - Add ``get_stylesheet_list`` function.
1186 - Apply [ 2834836 ] print info at halt
1188 * docutils/transforms/universal.py:
1190 - Raise default priority of StripClasses to exclude stripped classes from
1193 * docutils/writers/html4css1/__init__.py:
1195 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
1196 separated list of stylesheets.
1197 - Address [ 1938891 ] Inline literal text creates "pre" span only when
1198 needed to prevent inter-word line wraps.
1199 - Use `translate` method instead of repeated `replace` calls.
1200 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
1201 classes to allow CSS styling that does not interfere with other
1202 table-using constructs (field lists, citations, ...).
1204 * docutils/writers/newlatex2e/__init__.py:
1206 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1208 * docutils/writers/latex2e/__init__.py:
1210 - Add ``--embed-stylesheet`` option.
1211 - Apply [ 1474017 ] image vertical alignment is reversed.
1212 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1213 - Change: has_key for dictionaries (not Nodes) to in-operator.
1214 - Merge adjacent citations into one latex cite command.
1215 - Failsave implementation of custom roles. LaTeX compilation now ignores
1216 unknown classes instead of aborting with an error.
1217 - Support custom roles based on standard roles.
1218 - LaTeX packages can be used as ``--stylesheet`` arguments without
1219 restriction. (A style sheet is now referenced with the ``\usepackage``
1220 command, if it ends with ``.sty`` or has no extension.)
1221 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
1222 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1223 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1224 2005-02-04 as a configurable length unit).
1225 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1226 if font-encoding is set to ''. LaTeX defaults to OT1 then.
1227 - Set sub- and superscript role argument in text mode not as math.
1228 Use a custom role based on sub-/superscript if you want italic shape.
1229 - Shorter preamble and less dependencies: Load packages and define macros
1230 only if required in the document.
1231 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1232 - New custom environments and commands with optional "classes" argument.
1233 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1234 - Better conformance to Docutils specifications with ``--use-latex-toc``.
1235 Support for LaTeX generated ToC also with unnumbered sections.
1236 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1237 section numbering by LaTeX.
1238 - Use default font in admonitions and sidebar.
1239 - Align of image in a figure defaults to 'center'.
1240 - Bugfix: Newlines around targets and references prevent run-together
1242 - Fix internal hyperlinks.
1243 - Use class defaults for page margins ('typearea' now optional).
1244 - Float placement made configurable, default changed to "here definitely".
1245 - Typeset generic topic as "quote block with title".
1246 - Use template (file and configuration option).
1247 - In the default template, load cmap.sty (fix text extraction in PDF) and
1248 fixltx2e.sty (LaTeX patches, \textsubscript).
1249 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1250 - Use `translate` instead of repeated `replace` calls for text encoding.
1251 - Hyperlinked footnotes and support for symbol footnotes and
1252 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
1253 - Complete pairs of binary options
1254 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
1255 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
1257 - font-encoding: "T1" (formerly implicitely set by 'ae').
1258 - use-latex-toc: true (ToC with page numbers).
1259 - use-latex-footnotes: true (no mixup with figures).
1261 * docutils/writers/manpage.py
1263 - Do not print version at document end, this is done by the viewer.
1264 - Do not print date at document end, this is done by the viewer.
1265 - Fix storage of docinfo fields for none standard fields.
1267 * docutils/tools/rst2man.py
1269 Release 0.5 (2008-06-25)
1270 ========================
1272 * docutils/languages/he.py: Added to project: Hebrew mappings by
1275 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
1276 mappings by Meir Kriheli.
1278 * docutils/frontend.py:
1280 - Configuration files are now assumed and required to be
1282 - Paths of applied configuration files are now recorded in the
1283 runtime setting ``_config_files`` (accessible via
1284 ``--dump-settings``).
1285 - Added ``--strip-elements-with-class`` and ``--strip-class``
1286 options (``strip_elements_with_classes`` and ``strip_classes``
1291 - Added code to determine the input encoding from data: encoding
1292 declarations or the presence of byte order marks (UTF-8 & UTF-16).
1293 - Added support for IronPython 1.0.
1295 * docutils/nodes.py:
1297 - Added ``document.__getstate__`` method, for pickling.
1299 * docutils/parsers/rst/states.py:
1301 - Allow ``+`` and ``:`` in reference names.
1302 - Unquoted targets beginning with an underscore (``.. __target:
1303 URI``) are no longer accepted.
1304 - Added support for multiple attributions in a physical block quote
1305 (indented text block), dividing it into multiple logical block
1307 - Added support for unicode bullets in bullet lists: "•", "‣", and
1309 - Added support for new object-oriented directive interface,
1310 retaining compatibility to the old functional interface.
1311 - Added support for throwing ``DirectiveError``'s from within
1314 * docutils/parsers/rst/__init__.py:
1316 - Added ``Directive`` base class.
1317 - Added ``DirectiveError`` base class.
1318 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
1321 * docutils/parsers/directives/:
1323 - Refactored all reStructuredText directives to use the new
1324 object-oriented directive interface. Errors are now (mostly)
1325 thrown using the new ``DirectiveError`` class.
1327 * docutils/parsers/directives/misc.py:
1329 - Added ``start-after`` and ``end-before`` options to ``include``
1330 directive; thanks to Stefan Rank.
1332 * docutils/transforms/universal.py:
1334 - Added ``StripClassesAndElements`` transform to remove from the
1335 document tree all elements with classes in
1336 ``settings.strip_elements_with_classes`` and all "classes"
1337 attribute values in ``self.document.settings.strip_classes``.
1339 * docutils/transforms/writer_aux.py:
1341 - Added ``Admonitions`` transform to transform specific admonitions
1342 (like ``note``, ``warning``, etc.) into generic admonitions with a
1345 * docutils/writers/html4css1/__init__.py:
1347 - Moved template functionality from the PEP/HTML writer here.
1348 - Expanded the fragments available in the ``parts`` attribute.
1349 - Moved ``id`` attributes from titles to surrounding ``div``
1351 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
1352 universally supported now).
1353 - ``template.txt`` is now opened in text mode instead of binary mode
1354 (to ensure Windows compatibility).
1355 - ``a`` elements now have an "internal" or "external" class,
1356 depending on reference type.
1358 * docutils/writers/html4css1/template.txt: Added to project.
1360 * docutils/writers/pep_html/:
1362 - Moved template functionality to the HTML writer.
1364 * docutils/writers/s5_html/__init__.py:
1366 - Added ``view_mode`` & ``hidden_controls`` settings
1367 (``--view-mode`` & ``--hidden-controls/--visible-controls``
1370 * docutils/writers/latex2e/__init__.py:
1372 - Add ``--literal-block-env``
1373 - Fix: escaping ``%`` in href urls.
1374 - Move usepackage hyperref after stylesheet inclusion.
1375 - Fix: scrartcl does not have chapter but scrreprt.
1376 - Add newline after ``\end{verbatim}``.
1377 - Merge smaller differences from latex2e_adaptive_preamble.
1378 - Add ``use-part-section``.
1379 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
1380 - Using leavemode option_list no longer needs to check if parent
1381 is a definition list.
1382 - Append ``\leavemode`` to definition list terms.
1383 - No longer write visit\_/depart_definition_list_item comments to
1385 - Table column width with 3 decimal places.
1386 - Add table stubs support (boldfont).
1387 - Add assemble_parts to writer.
1388 - Add simply support for nested tables.
1389 - Fix verbatim in tables if use-verbatim-when-possible.
1390 - Use section commands down to subparagraph.
1391 - Put ensuremath around some latin1 chars.
1392 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
1393 - New option ``--use-bibtex=style,db1,db2``.
1394 - New option ``--reference-label`` to allow usage of LaTeX ref for
1395 labels in section references.
1396 - Add a label after every section to support sectionnumbers as reference
1398 - Fix: bug# 1605376 rst2latex: bad options group list
1399 - Remove inactive code for use_optionlist_for_option_list.
1400 - Remove latex comments from option_list output.
1401 - Fix: bug# 1612270 double qoutes in italian literal.
1402 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
1403 - Add option --use-latex-abstract.
1404 - Image width unit ``px`` is translated to ``pt``.
1405 - Add image height support.
1406 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
1408 - Fix: Do not escape underscores in citation reference labels if
1409 use-latex-citations is set.
1410 - Use centering instead of center for figure contents, to avoid vertical
1412 - Recognize table class: borderless, nolines, booktabs, standard.
1413 - Fix: Renaming contents section does not work with latex writer; SF
1415 - Applied patch for custom roles with classes from Edward Loper.
1416 - Fixed bug that caused crashes with more than 256 lists.
1418 * docutils/writers/pep_html/__init__.py:
1420 - Changed to support new python.org website structure and
1423 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1426 * tools/buildhtml.py:
1428 -- Added ``ignore`` setting to exclude a list of shell patterns
1429 (default: ``.svn:CVS``).
1431 * tools/editors/emacs/rst.el:
1433 - Changed license to "GPL".
1434 - Added ``rst-straighten-decorations`` function.
1435 - The ``compile`` module is now always loaded.
1436 - Added ``rst-toggle-line-block`` function.
1437 - Headings consisting only of non-ASCII characters are now
1438 recognized by ``rst-toc`` and ``rst-adjust``.
1439 - Added font-lock support for multi-line comments where the first
1440 comment line is empty.
1441 - Added ``(require 'font-lock)``.
1445 - Provide descriptive error message if distutils is missing.
1448 Release 0.4 (2006-01-09)
1449 ========================
1453 - Updated the project policies for trunk/branch development &
1456 * docutils/__init__.py:
1458 - Added ``__version_details__`` attribute to describe code source
1459 (repository/snapshot/release).
1460 - Replaced ``default_transforms`` attribute of TransformSpec with
1461 ``get_transforms()`` method.
1465 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1466 functions, for document tree extraction and reprocessing.
1470 - Added ``DocTreeInput`` class, for reprocessing existing documents.
1471 - Added support for non-Unicode (e.g. binary) writer output.
1473 * docutils/nodes.py:
1475 - Re-introduced ``Targetable.indirect_reference_name``, for
1476 MoinMoin/reST compatibility (removed in r3124/r3129).
1477 - Added ``serial_escape`` function; escapes string values that are
1478 elements of a list, for serialization. Modified Docutils-XML
1479 writing (``Element._dom_node``) and pseudo-XML writing
1480 (``Element.starttag``) to use ``serial_escape``.
1481 - Added ``Node.deepcopy()`` method.
1482 - Removed the internal lists ``document.substitution_refs``,
1483 ``document.anonymous_refs``, and ``document.anonymous_targets``.
1484 - Added a "container" element.
1485 - Fixed bug where values of list-valued attributes of elements
1486 originating from custom interpreted text roles (i.e., with custom
1487 classes) were being shared between element instances. Reported by
1490 * docutils/statemachine.py:
1492 - Added trailing whitespace stripping to ``string2lines()``.
1493 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1494 Asian double-width character support.
1496 * docutils/utils.py:
1498 - Added ``east_asian_column_width()`` for double-width character
1501 * docutils/languages/ja.py: Added to project: Japanese mappings by
1504 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1505 mappings by Panjunyong.
1507 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1509 * docutils/parsers/rst/__init__.py:
1511 - Added validator to tab_width setting, with test. Closes SF bug
1512 #1212515, report from Wu Wei.
1514 * docutils/parsers/rst/states.py:
1516 - Fixed bug with escaped colons indicating a literal block.
1517 - Fixed bug with enumerated lists (SF#1254145).
1518 - Backslash-escaped colons inside of field names are now allowed.
1519 - Targets (implicit and explicit), anonymous hyperlink references
1520 and auto-numbered footnote references inside of substitution
1521 definitions are now disallowed.
1522 - Fixed bug: list items with blank first lines.
1523 - Fixed bug: block quote attributions with indented second lines.
1524 - Added East Asian double-width character support (Python 2.4 only).
1526 * docutils/parsers/rst/tableparser.py:
1528 - Added East Asian double-width character support (Python 2.4 only).
1530 * docutils/parsers/rst/directives/body.py:
1532 - Added the "container" directive.
1534 * docutils/parsers/rst/directives/misc.py:
1536 - Added the "default-role", "title", and "date" directives.
1537 - Added standard data file syntax to the "include" directive.
1538 - Added support for "class" directive content.
1540 * docutils/parsers/rst/directives/images.py:
1542 - Added ``indirect_reference_name`` support for images with a target
1544 - Added support for image width and height units.
1545 - Fixed bug with image "target" options.
1547 * docutils/parsers/rst/directives/references.py:
1549 - Added "class" attribute to "target-notes" directive, for
1550 footnote_reference classes.
1552 * docutils/parsers/rst/include/: Directory added to project; contains
1553 standard data files for the "include" directive. Initial contents:
1554 character entity substitution definition sets, and a set of
1555 definitions for S5/HTML presentations.
1557 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1558 mappings by David Goodger.
1560 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1561 Simplified Chinese mappings by Panjunyong.
1563 * docutils/readers/__init__.py:
1565 - Added universal.Decorations and universal.ExposeInternals
1566 transforms as default transforms for all readers.
1567 - Added ``ReReader`` base class for readers that reread an existing
1570 * docutils/readers/doctree.py: Added to project; a reader for existing
1573 * docutils/transforms/frontmatter.py:
1575 - Fixed the DocInfo transform to handle SVN-style expansion of the
1577 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1580 * docutils/transforms/misc.py:
1582 - Added misc.Transitions transform, extracted from
1583 universal.FinalChecks.
1585 * docutils/transforms/references.py:
1587 - Added references.DanglingReferences transform, extracted from
1588 universal.FinalChecks.
1589 - Fixed bug with doubly-indirect substitutions.
1590 - Added footnote_reference classes attribute to "TargetNotes".
1591 - Fixed bug with circular substitution definitions that put Docutils
1592 into an infinite loop.
1594 * docutils/transforms/universal.py:
1596 - Added universal.ExposeInternals transform, extracted from
1597 universal.FinalChecks.
1598 - Removed universal.FinalChecks transform (logic has been moved to
1599 several new transforms).
1600 - Fixed bug with the "expose_internals" setting and Text nodes
1601 (exposed by the "rawsource" internal attribute).
1602 - Added the universal.StripComments transform, implementation of the
1603 "strip_comments" setting.
1605 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1606 transforms for writers.
1608 - Added ``Compound`` transform, which flattens compound paragraphs.
1610 * docutils/writers/: Several writer modules (html4css1.py) were
1611 converted into packages. Support modules and data files have been
1612 moved into the packages. The stylesheets for the HTML writers are
1613 now installed along with the code, the code knows where to find
1614 them, and the default is to use them (actually, to embed them).
1615 Some adjustments to configuration files may be necessary. The
1616 easiest way to obtain the new default behavior is to remove all
1617 settings whose name includes "stylesheet".
1619 * docutils/writers/__init__.py:
1621 - Added universal.Messages and universal.FilterMessages transforms
1622 as default transforms for all writers.
1623 - Added ``UnfilteredWriter`` base class for writers that pass the
1624 document tree on unchanged.
1626 * docutils/writers/docutils_xml.py:
1628 - Made ``xmlcharrefreplace`` the default output encoding error
1631 * docutils/writers/html4css1/:
1633 - Added support for image width and height units.
1634 - Made ``xmlcharrefreplace`` the default output encoding error
1636 - Made ``--embed-stylesheet`` the default rather than
1637 ``--link-stylesheet``.
1638 - Moved "id" attribute from container (section etc.) to title's <a>
1639 tag, to be on the same tag as "name".
1640 (!!! To be reverted in Docutils 0.5.)
1641 - Added vertical space between fields of field lists.
1642 - Added ``--compact-field-lists`` option to remove vertical space in
1644 - Made cloaking of email addresses with ``--cloak-email-addresses``
1646 - Fixed support for centered images.
1647 - Added support for class="compact" & class="open" lists.
1649 * docutils/writers/latex2e/:
1651 - Underscores in citekeys are no longer escaped.
1653 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1654 mapping of Unicode characters to LaTeX equivalents.
1656 * docutils/writers/s5_html/: Package added to project; writer for
1657 S5/HTML slide shows.
1659 * docs/dev/distributing.txt: Added to project; guide for distributors
1660 (package maintainers).
1662 * docs/dev/hacking.txt: Added to project; guide for developers.
1664 * docs/ref/doctree.txt:
1666 - Updated for plural attributes "classes", "ids", "names",
1668 - Added the "container" element.
1670 * docs/ref/docutils.dtd:
1672 - Updated for plural attributes "classes", "ids", "names",
1675 * docs/user/emacs.txt: Added to project; a document about Emacs
1676 support for reStructuredText and Docutils.
1678 * docs/user/links.txt: Added to project; lists of Docutils-related
1681 * docs/user/mailing-lists.txt: Added to project; information about
1682 Docutils-related mailing lists and how to access them.
1684 * docs/user/slide-shows.txt: Added to project; example of and docs for
1685 the S5/HTML writer (``rst2s5.py`` front end).
1687 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1688 Files", added to project.
1690 * test/coverage.sh: Added to project; test coverage script.
1692 * test/DocutilsTestSupport.py:
1694 - Added support for specifying runtime settings at the suite level.
1696 * test/test_functional.py:
1698 - Added the ``clear_output_directory`` function.
1699 - Added support for ``_test_more`` functions in functional test
1702 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1704 * tools/rstpep2html.py: Renamed from pep.py.
1706 * tools/dev/create_unimap.py: Added to project; script to create the
1707 docutils/writers/unimap_latex.py mapping file.
1709 * tools/dev/profile_docutils.py: Added to project; profiler script.
1711 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1713 * tools/editors/emacs/restructuredtext.el,
1714 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1715 Removed from project; the functionality is now contained in rst.el.
1717 * tools/editors/emacs/rst.el: Added to project. Added many features
1718 and fixed many bugs. See docs/user/emacs.txt for details.
1720 * tools/stylesheets: Removed from project. Stylesheets have been
1721 renamed and moved into writer packages.
1724 Release 0.3.9 (2005-05-26)
1725 ==========================
1729 - Eliminated and replaced all uses of the old string attributes
1730 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1731 new list attributes ``ids``, ``names``, ``dupnames`` and
1732 ``classes`` throughout the whole source tree.
1736 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1737 allowing for easier debugging.
1738 - In ``Publisher.publish()``, expanded the generic top-level
1741 * docutils/examples.py:
1743 - Added ``internals`` function for exploration.
1747 - Fixed ``Input.decode`` method to apply heuristics only if no
1748 encoding is explicitly given, and to provide better reporting of
1750 - The ``Input.decode`` method now removes byte order marks (BOMs)
1753 * docutils/nodes.py:
1755 - ``image`` element class changed to subclass of Element, not
1756 TextElement (it's an empty element, and cannot contain text).
1757 - Added ``attr_defaults`` dictionary for default attribute values.
1758 - Added empty list as default value for the following attributes:
1759 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1760 - Added ``document.decoration`` attribute,
1761 ``document.get_decoration`` method, and ``decoration.get_header``
1762 & ``.get_footer`` methods.
1763 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1766 * docutils/utils.py:
1768 - Removed ``docutils.utils.Reporter.categories``,
1769 ``docutils.utils.ConditionSet``, and all references to them, to
1770 simplify error reporting.
1772 * docutils/languages/nl.py: Added to project; Dutch mappings by
1775 * docutils/parsers/rst/__init__.py:
1777 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1779 * docutils/parsers/rst/states.py:
1781 - Added check for escaped at-mark to prevent email address recognition.
1782 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1784 - Allowed whitespace in paths and URLs.
1785 - Added auto-enumerated list items.
1786 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1788 - Added support for table stub columns.
1790 * docutils/parsers/rst/directives/__init__.py:
1792 - Allowed whitespace in paths (``path`` function).
1793 - Added ``uri`` directive option conversion function.
1795 * docutils/parsers/rst/directives/body.py:
1797 - Fixed illegal context bug with "topic" directive (allowed within
1798 sidebars; not within body elements).
1800 * docutils/parsers/rst/directives/images.py:
1802 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1803 - Added support for the ``file_insertion_enabled`` setting in the
1804 "figure" directive (disables "figwidth" option).
1805 - "image" directive: added checks for valid values of "align" option,
1806 depending on context. "figure" directive: added specialized
1807 "align" option and attribute on "figure" element.
1808 - Made ":figwidth: image" option of "figure" directive work again.
1809 - Fixed bug with reference names containing uppercase letters
1810 (e.g. ``Name_``) in "target" option of "image" directive.
1812 * docutils/parsers/rst/directives/misc.py:
1814 - Fixed "include" and "raw" directives to catch text decoding
1816 - Allowed whitespace in "include" & "raw" directive paths.
1817 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1818 settings in "include" & "raw" directives.
1820 * docutils/parsers/rst/directives/parts.py:
1822 - Added "header" & "footer" directives.
1823 - Fixed illegal context bug with "contents" directive (topics
1824 allowed within sidebars; not within body elements).
1826 * docutils/parsers/rst/directives/tables.py:
1828 - Added "list-table" directive.
1829 - Caught empty CSV table bug.
1830 - Added support for the ``file_insertion_enabled`` setting in the
1831 "csv-table" directive.
1832 - Added ``stub-columns`` option to "csv-table" and "list-table"
1835 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1836 mappings by Martijn Pieters.
1838 * docutils/readers/standalone.py:
1840 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1841 options to activate or deactivate the SectSubTitle transform.
1843 * docutils/transforms/frontmatter.py:
1845 - Added SectSubTitle transform to promote titles of lone
1846 subsections to subtitles.
1848 * docutils/transforms/references.py:
1850 - Fixed mislocated internal targets bug, by propagating internal
1851 targets to the next node, making use of the newly added support
1852 for multiple names and IDs.
1853 - Fixed duplicate footnote label bug.
1854 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1857 * docutils/writers/html4css1.py:
1859 - Fixed unencoded stylesheet reference bug (characters like "&" in
1860 stylesheet references).
1861 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1863 - Added support for multiple IDs per node by creating empty ``span``
1865 - Added the ``field_name_limit`` & ``option_limit`` settings &
1867 - Added support for table stub columns.
1868 - Added support for the ``align`` attribute on ``figure`` elements.
1869 - Added the ``cloak_email_addresses`` setting & support.
1870 - Added ``html_prolog``, ``html_head``, ``html_body``,
1871 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1872 ``docutils.core.publish_parts``.
1873 - Added support for section subtitles.
1875 * docutils/writers/latex2e.py:
1877 - Fixed tables starting with more than one multirow cell.
1878 - Improved --use-latex-docinfo so that organization/contact/address
1879 fields are lumped with the last author field and appear on the
1881 - Made sure the titlepage is always shown with --use-latex-docinfo,
1882 even if the document has no title.
1883 - Made sure that latex doesn't fill in today's date if no date field
1885 - Added support for section subtitles.
1887 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1888 (under development).
1890 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1892 * docs/api/publisher.txt:
1894 - Added "``publish_parts`` Details" section.
1896 * docutils/dev/repository.txt: Added to project; information about the
1897 Docutils Subversion repository.
1899 * docs/ref/docutils.dtd:
1901 - Added a ``stub`` attribute to the ``colspec`` element via the
1902 ``tbl.colspec.att`` parameter entity.
1903 - Allowed topic elements within sidebars
1904 - Added an ``align`` attribute to the ``figure`` element.
1906 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1910 Release 0.3.7 (2004-12-24)
1911 ==========================
1913 * docutils/frontend.py:
1915 - Added options: --input-encoding-error-handler,
1916 --record-dependencies, --leave-footnote-reference-space,
1918 - Added command-line and config file support for "overrides" setting
1923 - Added support for input encoding error handler.
1925 * docutils/nodes.py:
1927 - Added dispatch_visit and dispatch_departure methods to
1928 NodeVisitor; useful as a hook for Visitors.
1929 - Changed structure of ``line_block``; added ``line``.
1930 - Added ``compound`` node class.
1931 - Added a mechanism for Visitors to transitionally ignore new node
1934 * docutils/utils.py:
1936 - Moved ``escape2null`` and ``unescape`` functions from
1937 docutils/parsers/rst/states.py.
1939 * docutils/parsers/rst/roles.py:
1942 - Changed role function API: the "text" parameter now takes
1943 null-escaped interpreted text content.
1945 * docutils/parsers/rst/states.py:
1947 - Fixed bug where a "role" directive in a nested parse would crash
1948 the parser; the state machine's "language" attribute was not being
1950 - Added support for line block syntax.
1951 - Fixed directive parsing bug: argument-less directives didn't
1952 notice that arguments were present.
1953 - Removed error checking for transitions.
1954 - Added support for multiple classifiers in definition list items.
1955 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1956 - Changed role function API: the "text" parameter now takes
1957 null-escaped interpreted text content.
1958 - Empty sections and documents are allowed now.
1960 * docutils/parsers/rst/directives/__init__.py:
1962 - Added ``encoding`` directive option conversion function.
1963 - Allow multiple class names in class_option conversion function.
1965 * docutils/parsers/rst/directives/body.py:
1967 - Converted the line-block directive to use the new structure.
1968 - Extracted the old line-block functionality to the ``block``
1969 function (still used).
1970 - Added ``compound`` directive (thanks to Lea Wiemann).
1972 * docutils/parsers/rst/directives/misc.py:
1974 - Added "encoding" option to "include" and "raw" directives.
1975 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1976 - Allow multiple class names in the "class" directive.
1978 * docutils/parsers/rst/directives/parts.py:
1980 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1981 options. Thanks to Lele Gaifax.
1983 * docutils/parsers/rst/directives/tables.py:
1985 - Added "encoding" directive to "csv-table" directive.
1986 - Added workaround for lack of Unicode support in csv.py, for
1987 non-ASCII CSV input.
1989 * docutils/transforms/misc.py:
1991 - Fixed bug when multiple "class" directives are applied to a single
1993 - Enabled multiple format names for "raw" directive.
1995 * docutils/transforms/references.py:
1997 - Added support for trimming whitespace from beside substitution
2000 * docutils/transforms/universal.py:
2002 - FinalChecks now checks for illegal transitions and moves
2003 transitions between sections.
2005 * docutils/writers/html4css1.py:
2007 - HTMLTranslator.encode now converts U+00A0 to " ".
2008 - "stylesheet" and "stylesheet_path" settings are now mutually
2010 - Added support for the new line_block/line structure.
2011 - --footnote-references now overrides
2012 --trim-footnote-reference-space, if applicable.
2013 - Added support for ``compound`` elements.
2014 - Enabled multiple format names for "raw" directive.
2015 - ``<p>`` tags of a paragraph which is the only visible child of the
2016 document node are no longer stripped.
2017 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2018 new method ``should_be_compact_paragraph()``.
2019 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2021 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2022 the output if they have their ``class`` attribute set.
2023 - The whole document is now surrounded by a ``<div
2024 class="document">`` element.
2025 - Body-level images are now wrapped by their own ``<div>`` elements,
2026 with image classes copied to the wrapper, and for images which
2027 have the ``:align:`` option set, the surrounding ``<div>`` now
2028 receives a class attribute (like ``class="align-left"``).
2030 * docutils/writers/latex2e.py:
2032 - no newline after depart_term.
2033 - Added translations for some Unicode quotes.
2034 - Added option "font-encoding", made package AE the default.
2035 - "stylesheet" and "stylesheet_path" settings are now mutually
2037 - --footnote-references now overrides
2038 --trim-footnote-reference-space, if applicable.
2039 - The footnote label style now matches the footnote reference style
2040 ("brackets" or "superscript").
2041 - Added support for ``compound`` elements.
2042 - Enabled multiple format names for "raw" directive.
2044 * docs/ref/docutils.dtd:
2046 - Changed structure of the ``line_block`` element; added ``line``.
2047 - Added ``compound`` element.
2048 - Added "ltrim" and "rtrim" attributes to
2049 ``substitution_definition`` element.
2050 - Enabled multiple format names for ``raw`` element.
2051 - Enabled multiple classifiers in ``definition_list_item`` elements.
2053 * docs/ref/rst/directives.txt
2055 - Marked "line-block" as deprecated.
2056 - "Class" directive now allows multiple class names.
2057 - Added "Rationale for Class Attribute Value Conversion".
2058 - Added warning about "raw" overuse/abuse.
2060 * docs/ref/rst/restructuredtext.txt:
2062 - Added syntax for line blocks.
2063 - Definition list items may have multiple classifiers.
2065 * docs/ref/rst/roles.txt:
2069 * tools/stylesheets/default.css:
2071 - Added support for the new line_block structure.
2072 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2075 Release 0.3.5 (2004-07-29)
2076 ==========================
2080 * _`Documentation cleanup/reorganization`.
2082 - Created new subdirectories of docs/:
2084 * ``docs/user/``: introductory/tutorial material for end-users
2085 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2086 * ``docs/api/``: API reference material for client-developers
2087 * ``docs/ref/``: reference material for all groups
2088 * ``docs/howto/``: for component-developers and core-developers
2089 * ``docs/peps/``: Python Enhancement Proposals
2091 - Moved ``docs/*`` to ``docs/user/``.
2092 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2093 ``spec/`` to ``docs/dev``.
2094 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2095 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2096 - Moved ``alternatives.txt``, and ``problems.txt`` from
2097 ``spec/rst/`` to ``docs/dev/rst/``.
2098 - Moved ``reStructuredText.txt``, ``directives.txt``,
2099 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2100 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
2101 ``roles.txt``, ``reStructuredText.txt`` to
2102 ``restructuredtext.txt``.
2103 - Moved ``spec/howto/`` to ``docs/howto``.
2105 In order to keep the CVS history of moved files, we supplied
2106 SourceForge with a `script for modifying the Docutils CVS
2109 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
2111 After running the cleanup script:
2113 - Added ``docs/index.txt``.
2114 - Added a ``.htaccess`` file to the ``web`` module, containing
2115 redirects for all old paths to new paths. They'll preserve
2116 fragments (the "#name" part of a URL), and won't clutter up the
2117 file system, and will correct the URL in the user's browser.
2118 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2119 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2120 the "To Do" list itself in ``docs/dev/todo.txt``.
2121 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2122 section of ``docs/dev/todo.txt``.
2123 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2124 - Added "How To Report Bugs" to ``BUGS.txt``.
2125 - Went through all the sources and docs (including under web/) and
2126 updated links. Mostly done by Lea Wiemann; thanks Lea!
2127 (Still need to update links in the sandboxes.)
2131 * BUGS.txt: Added to project.
2133 * THANKS.txt: Added to project.
2135 * docutils/__init__.py:
2137 - 0.3.4: Post-release.
2141 - Added special error handling & advice for UnicodeEncodeError.
2142 - Refactored Publisher.publish (simplified exception handling &
2143 extracted debug dumps).
2144 - Renamed "enable_exit" parameter of convenience functions to
2145 "enable_exit_status".
2146 - Enabled traceback (exception propagation) by default in
2147 programmatic convenience functions.
2148 - Now publish_file and publish_cmdline convenience functions return
2149 the encoded string results in addition to their regular I/O.
2150 - Extracted common code from publish_file, publish_string, and
2151 publish_parts, into new publish_programmatically. Extracted
2152 settings code to ``Publisher.process_programmatic_settings``.
2153 - In Publisher.publish, disabled ``settings_overrides`` when
2154 ``settings`` is supplied; redundant.
2156 * docutils/frontend.py:
2158 - Added help text for "--output-encoding-error-handler" and
2159 "--error-encoding-error-handler".
2160 - Renamed "--exit" to "--exit-status".
2161 - Simplified default-setting code.
2163 * docutils/parsers/rst/__init__.py:
2165 - Added "--pep-base-url" and "--rfc-base-url" options.
2167 * docutils/parsers/rst/states.py:
2169 - Made URI recognition more aggressive and intelligent.
2171 * docutils/parsers/rst/directives/__init__.py:
2173 - Added several directive option conversion functions.
2175 * docutils/parsers/rst/directives/body.py:
2177 - Moved "table" directive to tables.py.
2179 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2182 * docutils/writers/latex2e.py:
2184 - Added "--table-style=(standard|booktabs|nolines)"
2185 - figures get "here" option (LaTeX per default puts them at bottom),
2186 and figure content is centered.
2187 - Rowspan support for tables.
2188 - Fix: admonition titles before first section.
2189 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2190 - Replave ``_`` in literal by an underlined blank, because it has the correct
2192 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2193 - A few unicode replacements, if output_encoding != utf
2194 - Add "--graphicx-option".
2195 - Indent literal-blocks.
2196 - Fix: omit ``\maketitle`` when there is no document title.
2198 * docs/index.txt: "Docutils Project Documentation Overview", added to
2201 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2202 Tool", added to project.
2204 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2206 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2208 * docs/dev/policies.txt: Added to project (extracted from
2209 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2211 * docs/dev/release.txt: Added to project (extracted from
2212 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2214 * docs/dev/testing.txt: Added to project.
2216 * docs/dev/website.txt: Added to project (extracted from
2217 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2219 * docs/ref/rst/directives.txt:
2221 - Added directives: "table", "csv-table".
2223 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2224 added to project. 1 page for syntax, and a 1 page reference for
2225 directives and roles. Source text to be used as-is; not meant to be
2228 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2229 with a change of title.
2231 * test/functional/, contents, and test/test_functional.py: Added to
2234 * tools/buildhtml.py: Fixed bug with config file handling.
2236 * tools/html.py: Removed from project (duplicate of rst2html.py).
2238 * tools/pep2html.py: Removed from project (duplicate of Python's
2239 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2240 Docutils-related PEPs in docs/peps/).
2242 * tools/rst2pseudoxml.py: Renamed from publish.py.
2244 * tools/rst2xml.py: Renamed from docutils-xml.py.
2246 * tools/test.txt: Removed from project; moved to
2247 docs/user/rst/demo.txt.
2249 * setup.py: Now also installs ``rst2latex.py``.
2252 Release 0.3.3 (2004-05-09)
2253 ==========================
2255 * docutils/__init__.py:
2257 - 0.3.1: Reorganized config file format (multiple sections); see
2259 - Added unknown_reference_resolvers attribute to TransformSpec.
2260 - 0.3.2: Interpreted text reorganization.
2265 - Catch system messages to stop tracebacks from parsing errors.
2266 - Catch exceptions during processing report & exit without
2267 tracebacks, except when "--traceback" used.
2268 - Reordered components for OptionParser; application comes last.
2269 - Added "config_section" parameter to several methods and functions,
2270 allowing front ends to easily specify their config file sections.
2271 - Added publish_parts convenience function to allow access to individual
2272 parts of a document.
2274 * docutils/examples.py: Added to project; practical examples of
2275 Docutils client code, to be used as-is or as models for variations.
2277 * docutils/frontend.py:
2279 - Added "--traceback" & "--no-traceback" options ("traceback"
2281 - Implemented support for config file reorganization:
2282 ``standard_config_files`` moved from ``ConfigParser`` to
2283 ``OptionParser``; added
2284 ``OptionParser.get_config_file_settings()`` and
2285 ``.get_standard_config_settings()``; support for old "[options]"
2286 section (with deprecation warning) and mapping from old to new
2288 - Reimplemented setting validation.
2289 - Enabled flexible boolean values: yes/no, true/false, on/off.
2290 - Added ``Values``, a subclass of ``optparse.Values``, with support
2291 for list setting attributes.
2292 - Added support for new ``DOCUTILSCONFIG`` environment variable;
2293 thanks to Beni Cherniavsky.
2294 - Added "--no-section-numbering" option.
2298 - Catch IOErrors when opening source & destination files, report &
2299 exit without tracebacks. Added ``handle_io_errors`` parameter to
2300 ``FileInput`` & ``FileOutput`` to enable caller error handling.
2302 * docutils/nodes.py:
2304 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
2305 method definitions (via ``exec``) to dynamic assignments (via
2306 ``setattr``); thanks to Roman Suzi.
2307 - Encapsulated visitor dynamic assignments in a function; thanks to
2309 - Added indirect_reference_name attribute to the Targetable
2310 class. This attribute holds the whitespace_normalized_name
2311 (contains mixed case) of a target.
2313 * docutils/statemachine.py:
2315 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
2316 - Added ``StringList.get_2D_block``.
2318 * docutils/utils.py:
2320 - Added "level" attribute to SystemMessage exceptions.
2322 * docutils/languages/af.py: Added to project; Afrikaans mappings by
2325 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
2328 * docutils/languages/eo.py: Added to project; Esperanto mappings by
2329 Marcelo Huerta San Martin.
2331 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
2332 mappings by Lalo Martins.
2334 * docutils/languages/ru.py: Added to project; Russian mappings by
2337 * docutils/parsers/rst/roles.py: Added to project. Contains
2338 interpreted text role functions, a registry for interpreted text
2339 roles, and an API for adding to and retrieving from the registry.
2340 Contributed by Edward Loper.
2342 * docutils/parsers/rst/states.py:
2344 - Updated ``RSTState.nested_parse`` for "include" in table cells.
2345 - Allowed true em-dash character and "---" as block quote
2347 - Added support for <angle-bracketed> complex option arguments
2349 - Fixed handling of backslashes in substitution definitions.
2350 - Fixed off-by-1 error with extra whitespace after substitution
2351 definition directive.
2352 - Added inline markup parsing to field lists' field names.
2353 - Added support for quoted (and unindented) literal blocks.
2354 Driven in part by a bribe from Frank Siebenlist (thanks!).
2355 - Parser now handles escapes in URIs correctly.
2356 - Made embedded-URIs' reference text omittable. Idea from Beni
2358 - Refactored explicit target processing code.
2359 - Added name attribute to references containing the reference name only
2360 through whitespace_normalize_name (no case changes).
2361 - parse_target no longer returns the refname after going through
2362 normalize_name. This is now handled in make_target.
2363 - Fixed bug relating to role-less interpreted text in non-English
2365 - Reorganized interpreted text processing; moved code into the new
2366 roles.py module. Contributed by Edward Loper.
2367 - Refactored ``Body.parse_directive`` into ``run_directive`` and
2368 ``parse_directive_block``.
2370 * docutils/parsers/rst/tableparser.py:
2372 - Reworked for ``StringList``, to support "include" directives in
2375 * docutils/parsers/rst/directives/__init__.py:
2377 - Renamed ``unchanged()`` directive option conversion function to
2378 ``unchanged_required``, and added a new ``unchanged``.
2379 - Catch unicode value too high error; fixes bug 781766.
2380 - Beefed up directive error reporting.
2382 * docutils/parsers/rst/directives/body.py:
2384 - Added basic "table" directive.
2386 * docutils/parsers/rst/directives/images.py:
2388 - Added "target" option to "image" directive.
2389 - Added name attribute to references containing the reference name only
2390 through whitespace_normalize_name (no case changes).
2392 * docutils/parsers/rst/directives/misc.py:
2394 - Isolated the import of the ``urllib2`` module; was causing
2395 problems on SourceForge (``libssl.so.2`` unavailable?).
2396 - Added the "role" directive for declaring custom interpreted text
2399 * docutils/parsers/rst/directives/parts.py:
2401 - The "contents" directive does more work up-front, creating the
2402 "topic" and "title", and leaving the "pending" node for the
2403 transform. Allows earlier reference resolution; fixes subtle bug.
2405 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
2406 mappings by Jannie Hofmeyr.
2408 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
2409 mappings by Marek Blaha.
2411 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
2412 mappings by Marcelo Huerta San Martin.
2414 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2415 Portuguese mappings by Lalo Martins.
2417 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2418 mappings by Roman Suzi.
2420 * docutils/transforms/parts.py:
2422 - The "contents" directive does more work up-front, creating the
2423 "topic" and "title", and leaving the "pending" node for the
2424 transform. Allows earlier reference resolution; fixes subtle bug.
2425 - Added support for disabling of section numbering.
2427 * docutils/transforms/references.py:
2429 - Verifying that external targets are truly targets and not indirect
2430 references. This is because we are now adding a "name" attribute to
2431 references in addition to targets. Note sure if this is correct!
2432 - Added code to hook into the unknown_reference_resolvers list for a
2433 transformer in resolve_indirect_target. This allows the
2434 unknown_reference_resolvers to keep around indirect targets which
2435 docutils doesn't know about.
2436 - Added specific error message for duplicate targets.
2438 * docutils/transforms/universal.py:
2440 - Added FilterMessages transform (removes system messages below the
2441 verbosity threshold).
2442 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2443 to FinalCheckVisitor for application-specific handling of
2444 unresolvable references.
2445 - Added specific error message for duplicate targets.
2447 * docutils/writers/__init__.py:
2449 - Added assemble_parts method to the Writer class to allow for
2450 access to a documents individual parts.
2451 - Documented & set default for ``Writer.output`` attribute.
2453 * docutils/writers/html4css1.py:
2455 - Fixed unicode handling of attribute values (bug 760673).
2456 - Prevent duplication of "class" attribute values (bug report from
2458 - Improved table grid/border handling (prompted by report from Bob
2460 - Added support for table titles.
2461 - Added "<title />" for untitled docs, for XHTML conformance; thanks
2463 - Added functionality to keep track of individual parts of a document
2464 and store them in a dictionary as the "parts" attribute of the writer.
2465 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2466 - Added proper support for the "scale" attribute of the "image"
2467 element. Contributed by Brent Cook.
2468 - Added ``--initial-header-level`` option.
2469 - Fixed bug: the body_pre_docinfo segment depended on there being a
2470 docinfo; if no docinfo, the document title was incorporated into
2471 the body segment. Adversely affected the publish_parts interface.
2473 * docutils/writers/latex2e.py:
2475 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2476 about a missing file.
2477 - Added options and support: ``--compound-enumerators``,
2478 ``--section-prefix-for-enumerators``, and
2479 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
2481 - Added option ``--use-verbatim-when-possible``, to avoid
2482 problematic characters (eg, '~' in italian) in literal blocks.
2483 - It's now possible to use four section levels in the `book` and
2484 `report` LaTeX classes. The default `article` class still has
2487 * docs/config.txt: "Docutils Configuration Files", added to project.
2488 Moved config file entry descriptions from tools.txt.
2492 - Moved config file entry descriptions to config.txt.
2494 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
2497 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2498 Text Roles", added to project.
2500 * spec/rst/reStructuredText.txt:
2502 - Added description of support for <angle-bracketed> complex option
2503 arguments to option lists.
2504 - Added subsections for indented and quoted literal blocks.
2506 * test: Continually adding & updating tests.
2508 - Added test/test_settings.py & test/data/config_*.txt support
2510 - Added test/test_writers/test_htmlfragment.py.
2512 * test/DocutilsTestSupport.py:
2514 - Refactored LaTeX publisher test suite/case class names to make
2515 testing other writers easier.
2516 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2517 to test the processing of HTML fragments which use the new
2518 publish_parts convenience function.
2520 * tools/buildhtml.py:
2522 - Added support for the "--prune" option.
2523 - Removed dependency on pep2html.py; plaintext PEPs no longer
2526 * tools/docutils.conf:
2528 - Updated for configuration file reorganization.
2530 * tools/rst2html.py:
2532 - copied from tools/html.py
2536 - added a 'scripts' section to configuration
2537 - added 'tools/rst2html.py' to the scripts section
2540 Release 0.3 (2003-06-24)
2541 ========================
2545 * Renamed "attribute" to "option" for directives/extensions.
2547 * Renamed transform method "transform" to "apply".
2549 * Renamed "options" to "settings" for runtime settings (as set by
2550 command-line options). Sometimes "option" (singular) became
2551 "settings" (plural). Some variations below:
2553 - document.options -> document.settings (stored in other objects as
2555 - option_spec -> settings_spec (not directives though)
2556 - OptionSpec -> SettingsSpec
2557 - cmdline_options -> settings_spec
2558 - relative_path_options -> relative_path_settings
2559 - option_default_overrides -> settings_default_overrides
2560 - Publisher.set_options -> Publisher.get_settings
2564 * COPYING.txt: Added "Public Domain Dedication".
2566 * FAQ.txt: Frequently asked questions, added to project.
2570 - Updated with PyPI Trove classifiers.
2571 - Conditional installation of third-party modules.
2573 * docutils/__init__.py:
2575 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2576 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2577 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2578 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2579 option and its effect on the PEP template & writer.
2580 - Bumped version to 0.2.4 due to changes to the PEP template &
2582 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2583 - Added ``TransformSpec`` class for new transform system.
2584 - Bumped version to 0.2.6 for API changes (renaming).
2585 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2586 convenience functions.
2587 - Added ``Component.component_type`` attribute.
2588 - Bumped version to 0.2.8 because of the internal parser switch from
2589 plain lists to the docutils.statemachine.StringList objects.
2590 - Bumped version to 0.2.9 because of the frontend.py API changes.
2591 - Bumped version to 0.2.10 due to changes to the project layout
2592 (third-party modules removed from the "docutils" package), and
2593 signature changes in ``io.Input``/``io.Output``.
2594 - Changed version to 0.3.0 for release.
2598 - Made ``publish()`` a bit more convenient.
2599 - Generalized ``Publisher.set_io``.
2600 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2601 parameters; improved its docstring.
2602 - Added ``publish_file()`` and ``publish_string()``.
2603 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2605 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2606 "--dump-transforms" hidden options.
2607 - Added ``Publisher.apply_transforms()`` method.
2608 - Added ``Publisher.set_components()`` method; support for
2609 ``publish_*()`` conveninece functions.
2610 - Moved config file processing to docutils/frontend.py.
2611 - Added support for exit status ("exit_level" setting &
2612 ``enable_exit`` parameter for Publisher.publish() and convenience
2615 * docutils/frontend.py:
2617 - Check for & exit on identical source & destination paths.
2618 - Fixed bug with absolute paths & "--config".
2619 - Set non-command-line defaults in ``OptionParser.__init__()``:
2620 ``_source`` & ``_destination``.
2621 - Distributed ``relative_path_settings`` to components; updated
2622 ``OptionParser.populate_from_components()`` to combine it all.
2623 - Require list of keys in ``make_paths_absolute`` (was implicit in
2624 global ``relative_path_settings``).
2625 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2626 "--dump-settings", and "--dump-transforms" hidden options.
2627 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2628 code, replaced with correct code.
2629 - Added validation functionality for config files.
2630 - Added "--error-encoding" option/setting, "_disable_config"
2632 - Added encoding validation; updated "--input-encoding" and
2633 "--output-encoding"; added "--error-encoding-error-handler" and
2634 "--output-encoding-error-handler".
2635 - Moved config file processing from docutils/core.py.
2636 - Updated ``OptionParser.populate_from_components`` to handle new
2637 ``SettingsSpec.settings_defaults`` dict.
2638 - Added support for "-" => stdin/stdout.
2639 - Added "exit_level" setting ("--exit" option).
2643 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2644 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2645 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2646 - ``FileOutput.write()`` now returns the encoded output string.
2647 - Try to get path/stream name automatically in ``FileInput`` &
2649 - Added defaults for source & destination paths.
2650 - Allow for Unicode I/O with an explicit "unicode" encoding.
2651 - Added ``Output.encode()``.
2652 - Removed dependency on runtime settings; pass encoding directly.
2653 - Recognize Unicode strings in ``Input.decode()``.
2654 - Added support for output encoding error handlers.
2656 * docutils/nodes.py:
2658 - Added "Invisible" element category class.
2659 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2660 modification during a traversal.
2661 - Added element classes: ``line_block``, ``generated``, ``address``,
2662 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2663 ``superscript``, ``subscript``, ``inline``
2664 - Added support for lists of nodes to ``Element.insert()``.
2665 - Fixed parent linking in ``Element.replace()``.
2666 - Added new abstract superclass ``FixedTextElement``; adds
2667 "xml:space" attribute.
2668 - Added support for "line" attribute of ``system_message`` nodes.
2669 - Added support for the observer pattern from ``utils.Reporter``.
2670 Added ``parse_messages`` and ``transform_messages`` attributes to
2671 ``document``, removed ``messages``. Added ``note_parse_message``
2672 and ``note_transform_message`` methods.
2673 - Added support for improved diagnostics:
2675 - Added "document", "source", and "line" internal attributes to
2676 ``Node``, set by ``Node.setup_child()``.
2677 - Converted variations on ``node.parent = self`` to
2678 ``self.setup_child(node)``.
2679 - Added ``document.current_source`` & ``.current_line``
2680 attributes, and ``.note_source`` observer method.
2681 - Changed "system_message" output to GNU-Tools format.
2683 - Added a "rawsource" attribute to the ``Text`` class, for text
2684 before backslash-escape resolution.
2685 - Support for new transform system.
2686 - Reworked ``pending`` element.
2687 - Fixed XML DOM bug (SF #660611).
2688 - Removed the ``interpeted`` element class and added
2689 ``title_reference``, ``abbreviation``, ``acronym``.
2690 - Made substitutions case-sensitive-but-forgiving; moved some code
2692 - Fixed Unicode bug on element attributes (report: William Dode).
2694 * docutils/optik.py: Removed from project; replaced with
2695 extras/optparse.py and extras/textwrap.py. These will be installed
2696 only if they're not already present in the Python installation.
2698 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2699 only if it's not already present in the Python installation.
2701 * docutils/statemachine.py:
2703 - Factored out ``State.add_initial_transitions()`` so it can be
2705 - Converted whitespace-specific "blank" and "indent" transitions
2706 from special-case code to ordinary transitions: removed
2707 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2708 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2709 ``ws_initial_transitions`` attributes.
2710 - Removed ``State.match_transition()`` after merging it into
2712 - Added ``StateCorrection`` exception.
2713 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2714 (moved ``TransitionCorrection`` support there too.)
2715 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2716 ``EOFError`` instead of ``IndexError``.
2717 - Added ``State.no_match`` method.
2718 - Added support for the Observer pattern, triggered by input line
2720 - Added ``strip_top`` parameter to
2721 ``StateMachineWS.get_first_known_indented``.
2722 - Made ``context`` a parameter to ``StateMachine.run()``.
2723 - Added ``ViewList`` & ``StringList`` classes;
2724 ``extract_indented()`` becomes ``StringList.get_indented()``.
2725 - Added ``StateMachine.insert_input()``.
2726 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2727 thanks to) Fred Drake.
2729 * docutils/utils.py:
2731 - Added a ``source`` attribute to Reporter instances and
2732 ``system_message`` elements.
2733 - Added an observer pattern to ``utils.Reporter`` to keep track of
2735 - Fixed bugs in ``relative_path()``.
2736 - Added support for improved diagnostics.
2737 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2738 - Added support for encoding Reporter stderr output, and encoding
2740 - Reporter keeps track of the highest level system message yet
2743 * docutils/languages: Fixed bibliographic field language lookups.
2745 * docutils/languages/es.py: Added to project; Spanish mappings by
2746 Marcelo Huerta San Martin.
2748 * docutils/languages/fr.py: Added to project; French mappings by
2751 * docutils/languages/it.py: Added to project; Italian mappings by
2754 * docutils/languages/sk.py: Added to project; Slovak mappings by
2757 * docutils/parser/__init__.py:
2759 - Added ``Parser.finish_parse()`` method.
2761 * docutils/parser/rst/__init__.py:
2763 - Added options: "--pep-references", "--rfc-references",
2764 "--tab-width", "--trim-footnote-reference-space".
2766 * docutils/parsers/rst/states.py:
2768 - Changed "title under/overline too short" system messages from INFO
2769 to WARNING, and fixed its insertion location.
2770 - Fixed enumerated list item parsing to allow paragraphs & section
2771 titles to begin with enumerators.
2772 - Converted system messages to use the new "line" attribute.
2773 - Fixed a substitution reference edge case.
2774 - Added support for "--pep-references" and "--rfc-references"
2775 options; reworked ``Inliner`` code to make customization easier.
2776 - Removed field argument parsing.
2777 - Added support for short section title over/underlines.
2778 - Fixed "simple reference name" regexp to ignore text like
2779 "object.__method__"; not an anonymous reference.
2780 - Added support for improved diagnostics.
2781 - Reworked directive API, based on Dethe Elza's contribution. Added
2782 ``Body.parse_directive()``, ``.parse_directive_options()``,
2783 ``.parse_directive_arguments()`` methods.
2784 - Added ``ExtensionOptions`` class, to parse directive options
2785 without parsing field bodies. Factored
2786 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2787 ``ExtensionOptions``.
2788 - Improved definition list term/classifier parsing.
2789 - Added warnings for unknown directives.
2790 - Renamed ``Stuff`` to ``Struct``.
2791 - Now flagged as errors: transitions at the beginning or end of
2792 sections, empty sections (except title), and empty documents.
2793 - Updated for ``statemachine.StringList``.
2794 - Enabled recognition of schemeless email addresses in targets.
2795 - Added support for embedded URIs in hyperlink references.
2796 - Added backslash-escapes to inline markup end-string suffix.
2797 - Added support for correct interpreted text processing.
2798 - Fixed nested title parsing (topic, sidebar directives).
2799 - Added special processing of backslash-escaped whitespace (idea
2800 from David Abrahams).
2801 - Made substitutions case-sensitive-but-forgiving; moved some code
2802 to ``docutils.nodes``.
2803 - Added support for block quote attributions.
2804 - Added a kludge to work-around a conflict between the bubble-up
2805 parser strategy and short titles (<= 3 char-long over- &
2806 underlines). Fixes SF bug #738803 "infinite loop with multiple
2807 titles" submitted by Jason Diamond.
2808 - Added explicit interpreted text roles for standard inline markup:
2809 "emphasis", "strong", "literal".
2810 - Implemented "superscript" and "subscript" interpreted text roles.
2811 - Added initial support for "abbreviation" and "acronym" roles;
2813 - Added support for "--trim-footnote-reference-space" option.
2814 - Optional space before colons in directives & hyperlink targets.
2816 * docutils/parsers/rst/tableparser.py:
2818 - Fixed a bug that was producing unwanted empty rows in "simple"
2820 - Detect bad column spans in "simple" tables.
2822 * docutils/parsers/rst/directives: Updated all directive functions to
2825 * docutils/parsers/rst/directives/__init__.py:
2827 - Added ``flag()``, ``unchanged()``, ``path()``,
2828 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2829 directive option helper functions.
2830 - Added warnings for unknown directives.
2831 - Return ``None`` for missing directives.
2832 - Added ``register_directive()``, thanks to William Dode and Paul
2835 * docutils/parsers/rst/directives/admonitions.py:
2837 - Added "admonition" directive.
2839 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2840 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2841 "parsed-literal", "rubric", "epigraph", "highlights" and
2842 "pull-quote" directives.
2844 * docutils/parsers/rst/directives/images.py:
2846 - Added an "align" attribute to the "image" & "figure" directives
2847 (by Adam Chodorowski).
2848 - Added "class" option to "image", and "figclass" to "figure".
2850 * docutils/parsers/rst/directives/misc.py:
2852 - Added "include", "raw", and "replace" directives, courtesy of
2854 - Added "unicode" and "class" directives.
2856 * docutils/parsers/rst/directives/parts.py:
2858 - Added the "sectnum" directive; by Dmitry Jemerov.
2859 - Added "class" option to "contents" directive.
2861 * docutils/parsers/rst/directives/references.py: Added to project.
2862 Contains the "target-notes" directive.
2864 * docutils/parsers/rst/languages/__init__.py:
2866 - Return ``None`` from get_language() for missing language modules.
2868 * docutils/parsers/rst/languages/de.py: Added to project; German
2869 mappings by Engelbert Gruber.
2871 * docutils/parsers/rst/languages/en.py:
2873 - Added interpreted text roles mapping.
2875 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2876 mappings by Marcelo Huerta San Martin.
2878 * docutils/parsers/rst/languages/fr.py: Added to project; French
2879 mappings by William Dode.
2881 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2882 mappings by Nicola Larosa.
2884 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2885 mappings by Miroslav Vasko.
2887 * docutils/readers/__init__.py:
2889 - Added support for the observer pattern from ``utils.Reporter``, in
2890 ``Reader.parse`` and ``Reader.transform``.
2891 - Removed ``Reader.transform()`` method.
2892 - Added default parameter values to ``Reader.__init__()`` to make
2893 instantiation easier.
2894 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2896 * docutils/readers/pep.py:
2898 - Added the ``peps.TargetNotes`` transform to the Reader.
2899 - Removed PEP & RFC reference detection code; moved to
2900 parsers/rst/states.py as options (enabled here by default).
2901 - Added support for pre-acceptance PEPs (no PEP number yet).
2902 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2905 * docutils/readers/python: Python Source Reader subpackage added to
2906 project, including preliminary versions of:
2909 - moduleparser.py: Parser for Python modules.
2911 * docutils/transforms/__init__.py:
2913 - Added ``Transformer`` class and completed transform reform.
2914 - Added unknown_reference_resolvers list for each transformer. This list holds
2915 the list of functions provided by each component of the transformer that
2916 help resolve references.
2918 * docutils/transforms/frontmatter.py:
2920 - Improved support for generic fields.
2921 - Fixed bibliographic field language lookups.
2923 * docutils/transforms/misc.py: Added to project. Miscellaneous
2926 * docutils/transforms/parts.py:
2928 - Moved the "id" attribute from TOC list items to the references
2929 (``Contents.build_contents()``).
2930 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2931 - Added "class" attribute support to ``Contents``.
2933 * docutils/transforms/peps.py:
2935 - Added ``mask_email()`` function, updating to pep2html.py's
2937 - Linked "Content-Type: text/x-rst" to PEP 12.
2938 - Added the ``TargetNotes`` PEP-specific transform.
2939 - Added ``TargetNotes.cleanup_callback``.
2940 - Added title check to ``Headers``.
2942 * docutils/transforms/references.py:
2944 - Added the ``TargetNotes`` generic transform.
2945 - Split ``Hyperlinks`` into multiple transforms.
2946 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2947 - Added check for circular indirect references.
2948 - Made substitutions case-sensitive-but-forgiving.
2950 * docutils/transforms/universal.py:
2952 - Added support for the "--expose-internal-attributes" option.
2953 - Removed ``Pending`` transform classes & data.
2955 * docutils/writers/__init__.py:
2957 - Removed ``Writer.transform()`` method.
2959 * docutils/writers/docutils-xml.py:
2961 - Added XML and doctype declarations.
2962 - Added "--no-doctype" and "--no-xml-declaration" options.
2964 * docutils/writers/html4css1.py:
2966 - "name" attributes only on these tags: a, applet, form, frame,
2968 - Added "name" attribute to <a> in section titles for Netscape 4
2969 support (bug report: Pearu Peterson).
2970 - Fixed targets (names) on footnote, citation, topic title,
2971 problematic, and system_message nodes (for Netscape 4).
2972 - Changed field names from "<td>" to "<th>".
2973 - Added "@" to "@" encoding to thwart address harvesters.
2974 - Improved the vertical whitespace optimization; ignore "invisible"
2975 nodes (targets, comments, etc.).
2976 - Improved inline literals with ``<span class="pre">`` around chunks
2977 of text and `` `` for runs of spaces.
2978 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2979 ``self.docinfo`` segments.
2980 - Added support for "line_block", "address" elements.
2981 - Improved backlinks (footnotes & system_messages).
2982 - Improved system_message output.
2983 - Redefined "--stylesheet" as containing an invariant URL, used
2984 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2986 - Added "--footnote-references" option (superscript or brackets).
2987 - Added "--compact-lists" and "--no-compact-lists" options.
2988 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2989 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2990 - Improved field list rendering.
2991 - Added Docutils version to "generator" meta tag.
2992 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2993 - Improved layout of <pre> HTML source.
2994 - Fixed attribute typo on <colspec>.
2995 - Refined XML prologue.
2996 - Support for no stylesheet.
2997 - Removed "interpreted" element support.
2998 - Added support for "title_reference", "sidebar", "attribution",
2999 "rubric", and generic "admonition" elements.
3000 - Added "--attribution" option.
3001 - Added support for "inline", "subscript", "superscript" elements.
3002 - Added initial support for "abbreviation" and "acronym";
3005 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3009 - Double quotes in literal blocks (special treatment for de/ngerman).
3010 - Added '--hyperlink-color' option ('0' turns off coloring of links).
3011 - Added "--attribution" option.
3012 - Right align attributions.
3014 * docutils/writers/pep_html.py:
3016 - Parameterized output encoding in PEP template.
3017 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3018 - Redefined "--pep-stylesheet" as containing an invariant URL, used
3019 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
3021 - Added an override on the "--footnote-references" option.
3022 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3023 - Added Docutils version to "generator" meta tag.
3024 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3028 - Added a "silent" setting for ``buildhtml.py``.
3029 - Added a "Getting Help" section.
3030 - Rearranged the structure.
3031 - Kept up to date, with new settings, command-line options etc.
3032 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3033 - Converted settings table into a definition list.
3035 * docs/rst/quickstart.txt:
3037 - Added a table of contents.
3038 - Added feedback information.
3039 - Added mention of minimum section title underline lengths.
3040 - Removed the 4-character minimum for section title underlines.
3042 * docs/rst/quickref.html:
3044 - Added a "Getting Help" section.
3045 - Added a style to make section title backlinks more subtle.
3046 - Added mention of minimum section title underline lengths.
3047 - Removed the 4-character minimum for section title underlines.
3049 * extras: Directory added to project; contains third-party modules
3050 that Docutils depends on (optparse, textwrap, roman). These are
3051 only installed if they're not already present.
3053 * licenses: Directory added to project; contains copies of license
3054 files for non-public-domain files.
3058 - Changed the focus. It's about DTD elements: structural
3059 relationships, semantics, and external (public) attributes. Not
3060 about the element class library.
3061 - Moved some implementation-specific stuff into ``docutils.nodes``
3063 - Wrote descriptions of all common attributes and parameter
3064 entities. Filled in introductory material.
3065 - Working through the element descriptions: 55 down, 37 to go.
3066 - Removed "Representation of Horizontal Rules" to
3067 spec/rst/alternatives.txt.
3069 * spec/docutils.dtd:
3071 - Added "generated" inline element.
3072 - Added "line_block" body element.
3073 - Added "auto" attribute to "title".
3074 - Changed content models of "literal_block" and "doctest_block" to
3076 - Added ``%number;`` attribute type parameter entity.
3077 - Changed ``%structural.elements;`` to ``%section.elements``.
3078 - Updated attribute types; made more specific.
3079 - Added "address" bibliographic element.
3080 - Added "line" attribute to ``system_message`` element.
3081 - Removed "field_argument" element; "field_name" may contain
3082 multiple words and whitespace.
3083 - Changed public identifier to docutils.sf.net.
3084 - Removed "interpreted" element; added "title_reference",
3085 "abbreviation", "acronym".
3086 - Removed "refuri" attribute from "footnote_reference" and
3087 "citation_reference".
3088 - Added "sidebar", "rubric", "attribution", "admonition",
3089 "superscript", "subscript", and "inline" elements.
3091 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3093 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3095 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3097 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3100 * spec/transforms.txt: Added to project.
3102 * spec/howto: Added subdirectory, for developer how-to docs.
3104 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
3105 Elza, edited & extended by David Goodger.
3107 * spec/howto/i18n.txt: Docutils Internationalization. Added to
3110 * spec/rst/alternatives.txt:
3112 - Added "Doctree Representation of Transitions" from
3114 - Updated "Inline External Targets" & closed the debate.
3115 - Added ideas for interpreted text syntax extensions.
3116 - Added "Nested Inline Markup" section.
3118 * spec/rst/directives.txt:
3120 - Added directives: "topic", "sectnum", "target-notes",
3121 "line-block", "parsed-literal", "include", "replace", "sidebar",
3122 "admonition", "rubric", "epigraph", "highlights", "unicode" and
3124 - Formalized descriptions of directive details.
3125 - Added an "align" attribute to the "image" & "figure" directives
3126 (by Adam Chodorowski).
3127 - Added "class" options to "topic", "sidebar", "line-block",
3128 "parsed-literal", "contents", and "image"; and "figclass" to
3131 * spec/rst/interpreted.txt: Added to project. Descriptions of
3132 interpreted text roles.
3134 * spec/rst/introduction.txt:
3136 - Added pointers to material for new users.
3138 * spec/rst/reStructuredText.txt:
3140 - Disambiguated comments (just add a newline after the "::").
3141 - Updated enumerated list description; added a discussion of the
3142 second-line validity checking.
3143 - Updated directive description.
3144 - Added a note redirecting newbies to the user docs.
3145 - Expanded description of inline markup start-strings in non-markup
3147 - Removed field arguments and made field lists a generic construct.
3148 - Removed the 4-character minimum for section title underlines.
3149 - Clarified term/classifier delimiter & inline markup ambiguity
3151 - Added "Embedded URIs".
3152 - Updated "Interpreted Text" section.
3153 - Added "Character-Level Inline Markup" section.
3155 * test: Continually adding & updating tests.
3157 - Moved test/test_rst/ to test/test_parsers/test_rst/.
3158 - Moved test/test_pep/ to test/test_readers/test_pep/.
3159 - Added test/test_readers/test_python/.
3160 - Added test/test_writers/ (Engelbert Gruber).
3164 - Made the ``locale.setlocale()`` calls in front ends
3167 * tools/buildhtml.py:
3169 - Added "--silent" option.
3170 - Fixed bug with absolute paths & "--config".
3171 - Updated for new I/O classes.
3172 - Added some exception handling.
3173 - Separated publishers' setting defaults; prevents interference.
3174 - Updated for new ``publish_file()`` convenience function.
3176 * tools/pep-html-template:
3178 - Allow for "--embed-stylesheet".
3179 - Added Docutils version to "generator" meta tag.
3180 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3181 - Conform to XHTML spec.
3183 * tools/pep2html.py:
3185 - Made ``argv`` a parameter to ``main()``.
3186 - Added support for "Content-Type:" header & arbitrary PEP formats.
3187 - Linked "Content-Type: text/plain" to PEP 9.
3188 - Files skipped (due to an error) are not pushed onto the server.
3189 - Updated for new I/O classes.
3190 - Added ``check_requirements()`` & ``pep_type_error()``.
3191 - Added some exception handling.
3192 - Updated for new ``publish_string()`` convenience function.
3193 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3195 * tools/quicktest.py:
3197 - Added "-V"/"--version" option.
3199 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3201 * tools/unicode2rstsubs.py: Added to project. Produces character
3202 entity files (reSructuredText substitutions) from the MathML master
3205 * tools/editors: Support code for editors, added to project. Contains
3206 ``emacs/restructuredtext.el``.
3208 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3210 - Added style for chunks of inline literals.
3211 - Removed margin for first child of table cells.
3212 - Right-aligned field list names.
3213 - Support for auto-numbered section titles in TOCs.
3214 - Increased the size of inline literals (<tt>) in titles.
3215 - Restored the light gray background for inline literals.
3216 - Added support for "line_block" elements.
3217 - Added style for "address" elements.
3218 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3219 - Improved field list rendering.
3220 - Vertical whitespace improvements.
3221 - Removed "a.target" style.
3223 * tools/stylesheets/pep.css:
3225 - Fixed nested section margins.
3226 - Other changes parallel those of ``../default.css``.
3229 Release 0.2 (2002-07-31)
3230 ========================
3234 - The word "component" was being used ambiguously. From now on,
3235 "component" will be used to mean "Docutils component", as in Reader,
3236 Writer, Parser, or Transform. Portions of documents (Table of
3237 Contents, sections, etc.) will be called "document parts".
3238 - Did a grand renaming: a lot of ``verylongnames`` became
3239 ``very_long_names``.
3240 - Cleaned up imports: no more relative package imports or
3241 comma-separated lists of top-level modules.
3242 - Added support for an option values object which carries default
3243 settings and overrides (from command-line options and library use).
3244 - Added internal Unicode support, and support for both input and
3246 - Added support for the ``docutils.io.IO`` class & subclasses.
3250 * docutils/__init__.py:
3252 - Added ``ApplicationError`` and ``DataError``, for use throughout
3254 - Added ``Component`` base class for Docutils components; implements
3255 the ``supports`` method.
3256 - Added ``__version__`` (thus, ``docutils.__version__``).
3260 - Removed many keyword parameters to ``Publisher.__init__()`` and
3261 ``publish()``; bundled into an option values object. Added
3262 "argv", "usage", "description", and "option_spec" parameters for
3263 command-line support.
3264 - Added ``Publisher.process_command_line()`` and ``.set_options()``
3266 - Reworked I/O model for ``docutils.io`` wrappers.
3267 - Updated ``Publisher.set_options()``; now returns option values
3269 - Added support for configuration files (/etc/docutils.conf,
3270 ./docutils.conf, ~/.docutils).
3271 - Added ``Publisher.setup_option_parser()``.
3272 - Added default usage message and description.
3274 * docutils/frontend.py: Added to project; support for front-end
3275 (command-line) scripts. Option specifications may be augmented by
3276 components. Requires Optik (http://optik.sf.net/) for option
3277 processing (installed locally as docutils/optik.py).
3279 * docutils/io.py: Added to project; uniform API for a variety of input
3282 * docutils/nodes.py:
3284 - Added ``TreeCopyVisitor`` class.
3285 - Added a ``copy`` method to ``Node`` and subclasses.
3286 - Added a ``SkipDeparture`` exception for visitors.
3287 - Renamed ``TreePruningException`` from ``VisitorException``.
3288 - Added docstrings to ``TreePruningException``, subclasses, and
3290 - Improved docstrings.
3291 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
3292 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
3294 - Added ``decoration``, ``header``, and ``footer`` node classes, and
3295 ``PreDecorative`` mixin.
3296 - Reworked the name/id bookkeeping; to ``document``, removed
3297 ``explicit_targets`` and ``implicit_targets`` attributes, added
3298 ``nametypes`` attribute and ``set_name_id_map`` method.
3299 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
3301 - Added ``document.has_name()`` method.
3302 - Fixed DOM generation for list-attributes.
3303 - Added category class ``Labeled`` (used by footnotes & citations).
3304 - Added ``Element.set_class()`` method (sets "class" attribute).
3306 * docutils/optik.py: Added to project. Combined from the Optik
3307 package, with added option groups and other modifications. The use
3308 of this module is probably only temporary.
3310 * docutils/statemachine.py:
3312 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
3313 - Added underscores to improve many awkward names.
3314 - In ``string2lines()``, changed whitespace normalizing translation
3315 table to regexp; restores Python 2.0 compatibility with Unicode.
3317 * docutils/urischemes.py:
3319 - Filled in some descriptions.
3320 - Added "shttp" scheme.
3322 * docutils/utils.py:
3324 - Added ``clean_rcs_keywords`` function (moved from
3325 docutils/transforms/frontmatter.py
3326 ``DocInfo.filter_rcs_keywords``).
3327 - Added underscores to improve many awkward names.
3328 - Changed names of Reporter's thresholds:
3329 warning_level -> report_level; error_level -> halt_level.
3330 - Moved ``utils.id()`` to ``nodes.make_id()``.
3331 - Added ``relative_path(source, target)``.
3333 * docutils/languages/de.py: German mappings; added to project. Thanks
3334 to Gunnar Schwant for the translations.
3336 * docutils/languages/en.py: Added "Dedication" bibliographic field
3339 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
3342 * docutils/parsers/rst/states.py:
3344 - Added underscores to improve many awkward names.
3345 - Added RFC-2822 header support.
3346 - Extracted the inline parsing code from ``RSTState`` to a separate
3347 class, ``Inliner``, which will allow easy subclassing.
3348 - Made local bindings for ``memo`` container & often-used contents
3349 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
3350 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
3351 - Added ``MarkupMismatch`` exception; for late corrections.
3352 - Added ``-/:`` characters to inline markup's start string prefix,
3353 ``/`` to end string suffix.
3354 - Fixed a footnote bug.
3355 - Fixed a bug with literal blocks.
3356 - Applied patch from Simon Budig: simplified regexps with symbolic
3357 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
3358 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
3359 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
3360 - Allowed non-ASCII in "simple names" (directive names, field names,
3362 - Converted ``Inliner.patterns.initial`` to be dynamically built
3363 from parts with ``build_regexp()`` function.
3364 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
3365 - Updated docstrings.
3366 - Changed "table" to "grid_table"; added "simple_table" support.
3368 * docutils/parsers/rst/tableparser.py:
3370 - Changed ``TableParser`` to ``GridTableParser``.
3371 - Added ``SimpleTableParser``.
3372 - Refactored naming.
3374 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
3375 a fallback language for directive names.
3377 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
3378 directive to use a ``pending`` element, used only by HTML writers.
3380 * docutils/parsers/rst/directives/parts.py: Renamed from
3383 - Added "backlinks" attribute to "contents" directive.
3385 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
3386 project by Adam Chodorowski.
3388 * docutils/readers/__init__.py: Gave Readers more control over
3389 choosing and instantiating Parsers.
3391 * docutils/readers/pep.py: Added to project; for PEP processing.
3393 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
3394 requires a ``component`` parameter.
3396 * docutils/transforms/components.py: Added to project; transforms
3397 related to Docutils components.
3399 * docutils/transforms/frontmatter.py:
3401 - In ``DocInfo.extract_authors``, check for a single "author" in an
3402 "authors" group, and convert it to a single "author" element.
3403 - Added support for "Dedication" and generic bibliographic fields.
3405 * docutils/transforms/peps.py: Added to project; PEP-specific.
3407 * docutils/transforms/parts.py: Renamed from old components.py.
3409 - Added filter for `Contents`, to use alt-text for inline images,
3410 and to remove inline markup that doesn't make sense in the ToC.
3411 - Added "name" attribute to TOC topic depending on its title.
3412 - Added support for optional TOC backlinks.
3414 * docutils/transforms/references.py: Fixed indirect target resolution
3415 in ``Hyperlinks`` transform.
3417 * docutils/transforms/universal.py:
3419 - Changed ``Messages`` transform to properly filter out system
3420 messages below the warning threshold.
3421 - Added ``Decorations`` transform (support for ``--generator``,
3422 ``--date``, ``--time``, ``--source-link`` options).
3424 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3425 Engelbert Gruber's PDF writer.
3427 * docutils/writers/html4css1.py:
3429 - Made XHTML-compatible (switched to lowercase element & attribute
3430 names; empty tag format).
3431 - Escape double-dashes in comment text.
3432 - Improved boilerplate & modularity of output.
3433 - Exposed modular output in Writer class.
3434 - Added a "generator" meta tag to <head>.
3435 - Added support for the ``--stylesheet`` option.
3436 - Added support for ``decoration``, ``header``, and ``footer``
3438 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3439 translation table to regexp; restores Python 2.0 compatibility
3441 - Added the translator class as instance variable to the Writer, to
3442 make it easily subclassable.
3443 - Improved option list spacing (thanks to Richard Jones).
3444 - Modified field list output.
3445 - Added backlinks to footnotes & citations.
3446 - Added percentage widths to "<col>" tags (from colspec).
3447 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3448 "<span>" changed to "<var>".
3449 - Inline literals: "<code>" changed to "<tt>".
3450 - Many changes to optimize vertical space: compact simple lists etc.
3451 - Add a command-line options & directive attributes to control TOC
3452 and footnote/citation backlinks.
3453 - Added support for optional footnote/citation backlinks.
3454 - Added support for generic bibliographic fields.
3455 - Identify backrefs.
3456 - Relative URLs for stylesheet links.
3458 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3459 PEPs (subclass of ``html4css1.Writer``).
3461 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3463 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3464 of the Docutils internal doctree in XML.
3466 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3470 - Changed the title to "The Docutils Document Tree".
3471 - Added "Hyperlink Bookkeeping" section.
3473 * spec/docutils.dtd:
3475 - Added ``decoration``, ``header``, and ``footer`` elements.
3476 - Brought ``interpreted`` element in line with the parser: changed
3477 attribute "type" to "role", added "position".
3478 - Added support for generic bibliographic fields.
3480 * spec/notes.txt: Continual updates. Added "Project Policies".
3482 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
3485 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3487 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
3488 mailing list discussions.
3490 * spec/pep-0287.txt:
3492 - Renamed to "reStructuredText Docstring Format".
3494 - Reworked Q&A as an enumerated list.
3495 - Converted to reStructuredText format.
3497 * spec/pysource.dtd:
3499 - Reworked structural elements, incorporating ideas from Tony Ibbs.
3501 * spec/pysource.txt: Removed from project. Moved much of its contents
3504 * spec/rst/alternatives.txt:
3506 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3507 - Added "Inline External Targets" section.
3509 * spec/rst/directives.txt:
3511 - Added "backlinks" attribute to "contents" directive.
3513 * spec/rst/problems.txt:
3515 - Updated the Enumerated List Markup discussion.
3516 - Added new alternative table markup syntaxes.
3518 * spec/rst/reStructuredText.txt:
3520 - Clarified field list usage.
3521 - Updated enumerated list description.
3522 - Clarified purpose of directives.
3523 - Added ``-/:`` characters to inline markup's start string prefix,
3524 ``/`` to end string suffix.
3525 - Updated "Authors" bibliographic field behavior.
3526 - Changed "inline hyperlink targets" to "inline internal targets".
3527 - Added "simple table" syntax to supplement the existing but
3528 newly-renamed "grid tables".
3529 - Added cautions for anonymous hyperlink use.
3530 - Added "Dedication" and generic bibliographic fields.
3532 * test: Made test modules standalone (subdirectories became packages).
3534 * test/DocutilsTestSupport.py:
3536 - Added support for PEP extensions to reStructuredText.
3537 - Added support for simple tables.
3538 - Refactored naming.
3540 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3542 - Now supports true packages containing test modules
3543 (``__init__.py`` files required); fixes duplicate module name bug.
3545 * test/test_pep/: Subpackage added to project; PEP testing.
3547 * test/test_rst/test_SimpleTableParser.py: Added to project.
3551 - Updated html.py and publish.py front-end tools to use the new
3552 command-line processing facilities of ``docutils.frontend``
3553 (exposed in ``docutils.core.Publisher``), reducing each to just a
3555 - Added ``locale.setlocale()`` calls to front-end tools.
3557 * tools/buildhtml.py: Added to project; batch-generates .html from all
3558 the .txt files in directories and subdirectories.
3560 * tools/default.css:
3562 - Added support for ``header`` and ``footer`` elements.
3563 - Added styles for "Dedication" topics (biblio fields).
3565 * tools/docutils.conf: A configuration file; added to project.
3567 * tools/docutils-xml.py: Added to project.
3569 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3571 * tools/pep-html-template: Added to project.
3573 * tools/pep2html.py: Added to project from Python (nondist/peps).
3574 Added support for Docutils (reStructuredText PEPs).
3576 * tools/quicktest.py:
3578 - Added the ``--attributes`` option, hacked a bit.
3579 - Added a second command-line argument (output file); cleaned up.
3581 * tools/stylesheets/: Subdirectory added to project.
3583 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3586 Release 0.1 (2002-04-20)
3587 ========================
3589 This is the first release of Docutils, merged from the now inactive
3590 reStructuredText__ and `Docstring Processing System`__ projects. For
3591 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3592 `DPS HISTORY`__ files.
3594 __ http://structuredtext.sourceforge.net/
3595 __ http://docstring.sourceforge.net/
3596 __ http://structuredtext.sourceforge.net/HISTORY.html
3597 __ http://docstring.sourceforge.net/HISTORY.html
3599 General changes: renamed 'dps' package to 'docutils'; renamed
3600 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3601 the test suites (reStructuredText's test/test_states renamed to
3602 test/test_rst); and all modifications required to make it all work.
3604 * docutils/parsers/rst/states.py:
3606 - Improved diagnostic system messages for missing blank lines.
3607 - Fixed substitution_reference bug.
3613 indent-tabs-mode: nil
3614 sentence-end-double-space: t