5 :Author: David Goodger; open to all Docutils developers
6 :Contact: docutils-develop@lists.sourceforge.net
9 :Web site: https://docutils.sourceforge.io/
10 :Copyright: This document has been placed in the public domain.
14 Release 0.18 (2021-10-26)
15 =========================
19 - Don't change a list while looping over it (in
20 document.set_name_id_map()). Thanks to Mickey Endito.
22 * docutils/parsers/recommonmark_wrapper.py
24 - Test and update to work with recommonmark version 0.6.0.
27 Unfortunately, recommonmark_ is `no longer maintained`__.
29 __ https://github.com/readthedocs/recommonmark/issues/221
31 * docutils/parsers/rst/directives/misc.py
33 - Fix bug #424 Wrong circular inclusion detection.
34 Use a "magic" comment instead of line numbers
35 to keep a log of recursive inclusions.
37 * docutils/parsers/rst/states.py
39 - Use a "magic" comment to update the log of recursive inclusions.
41 * docutils/writers/html5_polyglot/__init__.py
43 - New option "image_loading". Support "lazy" loading of images.
44 Obsoletes "embed_images".
46 * docutils/writers/pseudoxml.py:
48 - Fix spelling of option "detailed".
50 * tools/docutils-cli.py
52 - Read settings from standard configuration files.
54 Fix spelling errors in documentation and docstrings.
55 Thanks to Dimitri Papadopoulos.
58 Release 0.18b1 (2021-10-05)
59 ===========================
61 * docutils/frontend.py
63 - The default value for the "auto_id_prefix" setting changed to "%":
64 auto-generated IDs use the tag name as prefix.
68 - Make meta__ a standard Docutils doctree node. Writers may ignore
69 "meta" nodes if they are not supported by the output format.
71 __ docs/ref/doctree.html#meta
73 - document.make_id(): Do not strip leading number and hyphen characters
74 from `name` if the id_prefix setting is non-empty.
76 - ``Node.traverse()`` returns an iterator instead of a list.
78 * docutils/parsers/rst/directives/html.py
80 - Removed. (Meta directive moved to ``misc.py``.)
82 * docutils/parsers/rst/directives/misc.py
84 - `Meta` directive class (moved from html.py) inserts `meta`
85 (instead of `pending`) nodes.
87 - Add `class` option to `Raw` directive.
89 * docutils/parsers/rst/directives/tables.py:
91 - Unify behaviour of `"widths" option`_: check that the length of an
92 integer list equals the number of table columns also for the "table"
95 * docutils/tools/math/math2html.py,
96 docutils/tools/math/tex2unicode.py,
97 docutils/writers/html5/math.css
99 - Fork from elyxer and remove code that is not required
101 - Scale variable sized operators and big delimiters with CSS
102 - Support more commands, fix mapping of commands to Unicode characters
103 (cf. `LaTeX syntax for mathematics`_).
104 - Fix bug #244 Wrong subscript/superscript order.
105 - Don't use <tt> element (deprecated in HTML5).
106 - Use STIX fonts if available.
108 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
110 * docutils/parsers/rst/states.py:
112 - Fix source location (line number) for attribution elements.
113 Patch by Mickey Endito.
114 - Add line, source, and rawsource internal attributes for blockquote
115 elements. Patch by Mickey Endito.
117 * docutils/transforms/references.py
119 - Skip system_messages when propagating targets. Fixes bug #425.
121 * docutils/utils/__init__.py
123 - Removed ``unique_combinations`` (obsoleted by ``itertools.combinations``).
125 * docutils/utils/latex2mathml.py
127 - Major update (fixes and support for additional commands and symbols).
130 * docutils/writers/_html_base.py
132 - Write footnote brackets and field term colons to HTML, so that
133 they are present also without CSS and when copying text.
134 Adapt ``minimal.css``.
136 - Use semantic tags <aside> for footnote text, topics, admonitions,
137 and system-messages and <nav> for the table of contents. Use <div>
140 - Only specify table column widths, if the `"widths" option`_ is set
141 and is not "auto" (fixes bug #426).
142 The `table_style`_ setting "colwidths-grid" restores the current default.
144 .. _"widths" option: docs/ref/rst/directives.html#column-widths
145 .. _table_style: docs/user/config.html#table-style
147 - Use ARIA roles to enable accessible HTML for abstract, dedication,
148 the table of contents, footnote, references, footnotes, citations,
151 - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
152 for headings of deeply nested sections.
154 - Do not set classes "compound-first", "compound-middle", or
155 "compound-last" to elements nested in a compound.
156 Use class value "backrefs" instead of "fn-backref" for a span of
159 - Do not write class values handled by the HTML writer ("colwidths-auto",
160 "colwidths-given", "colwidths-grid") to the output.
162 - Move space character between section number and heading into
165 - Removed attribute ``HTMLTranslator.topic_classes``
167 - Items of a definition list with class argument "details" are
168 converted to `details disclosure elements`.
171 * docutils/writers/html4css1/__init__.py:
173 - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
174 (details, aside, nav, ...) and attributes (role, aria-level).
176 * docutils/writers/latex2e/__init__.py
178 - The setting `legacy_class_functions`_ now defaults to "False".
179 Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
181 - Apply patch #181 "Fix tocdepth when chapter/part in use" by
182 John Thorvald Wodder II.
184 - Fix newlines after/before ids_to_labels() (cf. patch #183).
186 - Refactor/revise ToC writing.
188 - Don't add ``\phantomsection`` to labels in math-blocks.
190 - Improve spacing and allow customization of Docutils-generated table
193 - New algorithm for table column widths. Fixes bug #422.
194 New configuration setting legacy_column_widths_.
196 Table.set_table_style() arguments changed.
198 Only write "continued on next page..." if it fits
199 without making the table columns wider.
201 Table `width` option overrides conflicting "auto" column `widths`.
203 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
206 * docutils/writers/latex2e/docutils.sty
208 - Fix excessive padding above sidebar titles.
210 * docutils/writers/pseudoxml.py:
212 - Fix option "detailed" under Python 2.7.
214 * docutils/writers/s5_html/themes/default
216 - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
217 ``blank.gif`` (fixes bug #169).
219 * docutils/writers/manpage.py
221 - Fix: double quotes need to be escaped on macro invocation.
225 Release 0.17.1 (2021-04-16)
226 ===========================
228 * docutils/utils/math/latex2mathml.py
230 - Fix bug #406 (MathML translation of ``\mathbf``).
232 * docutils/writers/latex2e/__init__.py:
234 - Open "docutils.sty" with encoding set to "utf8".
235 Fixes bug #414: error with Py3k when locale encoding is "ascii".
237 * docutils/parsers/*.py, docutils/transforms/*.py
239 - Provide fallbacks for parser config settings
240 to facilitate programmatic use.
242 * docutils/writers/manpage.py
244 - Apply patch #160: move macro defs above ``.TH``
245 (thanks Willie and sorry for the delay).
248 Release 0.17 (2021-04-03)
249 =========================
253 - Installing with ``setup.py`` now requires ``setuptools``.
254 Alternatively, install with `pip`_ (or "manually").
255 - Use importlib.import_module() to programmatically import modules.
256 - Fix bug #385: Import of language modules.
258 .. _pip: https://pypi.org/project/pip/
260 * docutils/MANIFEST.in
262 - Exclude test outputs.
264 * docutils/__init__.py
266 - VersionInfo: ValueError for invalid values, fix comparison to tuples.
268 * docutils/languages/
269 docutils/parsers/rst/languages/
271 - Apply patch # 177 Arabic mappings by Shahin.
272 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
276 - Apply patch #165 "Fix error when copying `system_message` node"
278 - Apply version of patch #167 "Let document.set_id() register all
279 existing IDs". Thanks to Takeshi KOMIYA.
280 - Fix bug #410: Use a "property" function to recursively fetch
281 `Node.document` value from parent node.
283 * docutils/parsers/recommonmark_wrapper.py
285 - New, **experimental** wrapper to integrate the
286 `recommonmark`_ Markdown parser for use with Docutils.
287 Currently only tested with recommonmark version 0.4.0.
289 .. _recommonmark: https://pypi.org/project/recommonmark/
291 * docutils/parsers/rst/directives/body.py
293 - Make the sidebar's "title" argument optional (feature request #69).
295 * docutils/parsers/rst/directives/html.py
297 - Make "meta" elements available for "latex" and "odt".
299 * docutils/parsers/rst/directives/misc.py
301 - Prevent infinite inclusion loops.
303 * docutils/parsers/rst/roles.py
305 - Apply patch #174 `Lowercase new role names on registration`
306 by John Thorvald Wodder II.
308 * docutils/utils/smartquotes.py
310 - Fix bug #383: Smart quotes around opening and separator characters.
312 * docutils/transforms/components.py
314 - Allow a comma-separated list of formats for the Filter transform.
316 * docutils/writers/html*
318 - Implement feature request #40 `Option to embed images as data URI`.
320 * docutils/writers/html5_polyglot/__init__.py
322 - Use the new semantic tags <main>, <section>, <header>,
323 <footer>, <aside>, <figure>, and <figcaption>.
324 See ``minimal.css`` and ``plain.css`` for styling rule examples.
326 Change the `initial_header_level` setting default to "2", as browsers
327 use the `same style for <h1> and <h2> when nested in a <section\>`__.
329 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
331 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
332 <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
333 is found in `inline`__ and `literal`__ elements.
334 Use <ins> and <del> if a unique matching class value
335 is found in `inline`, `literal`, or `container` elements.
336 Use <small> for generated code line numbers.
338 __ docs/ref/doctree.html#inline
339 __ docs/ref/doctree.html#literal
341 - Fix bug #398: properly close link tag to "schema.dcterms".
343 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
345 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
347 - Use <video> for images with video MIME types supported by HTML5.
349 * docutils/writers/html5_polyglot/minimal.css
351 - Move non-essential styling to ``plain.css``.
352 Small fixes and tweaks.
354 - Support "captionbelow" class value for tables.
356 - Display code line numbers as pseudo-elements which are skipped
357 when copying text from code blocks. Solves feature request #32.
359 * docutils/writers/html5_polyglot/plain.css
361 - Support numbered figures.
363 * docutils/writers/html5_polyglot/responsive.css
365 - New optional style that adapts to different screen sizes.
367 * docutils/writers/latex2e/__init__.py:
369 - Use LaTeX environments for admonitions and "class wrappers" for styling
370 admonitions and titles if the new configuration setting
371 `legacy_class_functions`_ is False.
373 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
375 - Remove backwards compatibility code for the deprecated
376 `styling command`__ prefix ``\docutilsrole``.
378 __ docs/user/latex.html#custom-interpreted-text-roles
380 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
382 - Support the `memoir` LaTeX document class.
383 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
385 - The special value "auto" for the `graphicx_option`_ setting
386 is no longer supported (it never worked for xetex/luatex).
388 .. _graphicx_option: docs/user/config.html#graphicx-option
390 - Most helper commands and element definitions are now defined in the
391 LaTeX package `docutils.sty`_ and only inserted in the document
392 preamble if the `stylesheet`__ setting does not list "docutils".
394 .. _docutils.sty: https://ctan.org/pkg/docutils
395 __ docs/user/config.html#stylesheet-latex-writers
397 - Apply patch #173 "Make \*TeX writers convert nonstandard table
398 classes to DUclass environments" by John Thorvald Wodder II.
400 - Fix bug #408 "Incorrect assert in latex writer
401 for multiple citation references".
403 - Apply patch #175 "Fix alignment of nested tables"
404 by John Thorvald Wodder II. Additional fixes to table alignment.
406 - Do not write Docutils-generated ToC, when ``use_latex_toc``
407 is True. (This did happen when publishing from a doctree.)
409 - Set PDF document properties from "meta" directive content.
411 - Apply version of patch #176 "LaTeX writer: Append \leavevmode to
412 non-docinfo field names" by John Thorvald Wodder II.
414 * docutils/writers/manpage.py
416 - Fix #394 fix missing new line after rubric.
417 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
418 - Fix #126 manpage title with spaces.
419 - Fix #380 command line option problem in sphinx.
421 * docutils/writers/odf_odt/__init__.py:
423 - Fix/improve metadata handling:
424 fix "keyword" splitting,
425 allow generic fields (stored as "Custom Properties").
427 * docutils/writers/pseudoxml.py:
429 - New option `detailled`__.
431 __ docs/user/config.html#detailed
433 * test/DocutilsTestSupport.py
435 - Run python3 test like python2 against source not the build/-directory
437 * tools/docutils-cli.py
439 - New generic command line front end that allows the free selection of
440 reader, parser, and writer components.
443 Release 0.16 (2020-01-16)
444 =========================
448 - Dropped support for Python 2.6, 3.3 and 3.4
449 - Docutils now supports Python 2.7 and Python 3.5+ natively
450 (without conversion by ``2to3``).
451 - Keep `backslash escapes`__ in the document tree. Backslash characters in
452 text are be represented by NULL characters in the ``text`` attribute of
453 Doctree nodes and removed in the writing stage by the node's
456 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
460 - Remove the `handle_io_errors` option from io.FileInput/Output.
464 - Speed up Node.next_node().
465 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
466 - Warn about Node.traverse() returning an iterator instead of a list
469 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
471 * docutils/statemachine.py
473 - Patch [ 158 ]: Speed up patterns by saving compiled versions (eric89gxl)
475 * docutils/transforms/universal.py
477 - Fix [ 332 ]: Standard backslash escape for smartquotes.
478 - Fix [ 342 ]: No escape in roles descending from `inline literal`.
480 * docutils/utils/__init__.py
482 - unescape() definition moved to `nodes` to avoid circular import
483 dependency. Fixes [ 366 ].
485 * docutils/writers/latex2e/__init__.py:
487 - Fix topic subtitle.
488 - Make "rubric" bold-italic and left aligned.
489 - Fix [ 339 ] don't use "alltt" or literal-block-environment
490 in admonitions and footnotes.
491 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
492 - Add "latex writers" to the `config_section_dependencies`.
493 - Ignore classes for `rubric` elements
494 (class wrapper interferes with LaTeX formatting).
496 * docutils/writers/manpage.py
498 - Apply fix for [ 287 ] comma after option is bold.
499 - Apply fix for [ 289 ], line starting with ``.`` in a text.
501 * docutils/writers/odf_odt/__init__.py:
503 - Fix: ElementTree.getchildren deprecated warning
505 * docutils/writers/xetex/__init__.py:
507 - Add "latex writers" to the `config_section_dependencies`.
511 - Fix: 377 ResourceWarning: unclosed file python3.8
512 Close alltests.out with atexit.
516 - Fix: 377 ResourceWarning: unclosed file python3.8
517 Read defaults file with context.
519 - Set "auto_id_prefix" to "%" (expands to tag-names).
520 Results in descriptive links in HTML and more localized changes when
521 editions to the input add or remove auto-ids.
525 - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
527 * test/test_writers/test_odt.py:
529 - Fix [ 359 ]: Test suite fails on Python 3.8. odt XML sorting.
530 Use ElementTree instead of minidom.
534 - New option `html-writer`_.
536 .. _html-writer: docs/user/config.html#html-writer
539 Release 0.15.1 (2019-07-24)
540 ===========================
542 source: branches/rel-0.15
544 Bugs #366 fix release for python2 only.
547 Release 0.15 (2019-07-20)
548 =========================
552 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
553 - Infrastructure automation.
555 * docs/ref/rst/restructuredtext.txt:
557 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
558 field list names (instead of ordinary text).
562 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
563 deprecated. Thanks to hugovk.
565 * docutils/languages/ko.py
566 docutils/parsers/rst/languages/ko.py:
568 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
572 - Fix [ 251 ] system_message.copy() TypeError.
573 - Element.copy() also copies `document`, `line`, and `source` attributes.
575 * docutils/parsers/rst/__init__.py:
577 - Apply [ 152 ] reset `default role` at end of document.
579 * docutils/parsers/rst/states.py:
581 - Allow embedded colons in field list field names.
583 * docutils/parsers/rst/directives/html.py:
585 - Fix bug #281: Remove escaping backslashes in meta directive content.
587 * docutils/parsers/rst/directives/misc.py:
589 - Don't convert tabs to spaces, if `tab_width` is negative in
590 `include` directive with `code` option.
592 * docutils/parsers/rst/directives/tables.py:
594 - Apply patch #121: Add "width" option for the table directives.
596 * docutils/transforms/frontmatter.py:
598 - Add field name as class argument to generic docinfo fields unconditionally.
600 * docutils/transforms/references.py:
602 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
604 * docutils/utils/__init__.py:
606 - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
608 * docutils/utils/smartquotes.py:
610 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
612 * docutils/writers/html5_polyglot/
614 - automatically add HTML5-compatible meta tags for docinfo items
615 "authors", "date", and "copyright".
617 * docutils/writers/_html_base.py
619 - Fix bug #358: Non-breaking space removed from fixed-width literal.
621 * docutils/writers/latex2e/__init__.py:
623 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
625 - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
626 - Fixes to literal block handling.
629 Release 0.14 (2017-08-03)
630 =========================
632 * docs/ref/docutils.dtd:
634 - Enable validation of Docutils XML documents against the DTD:
636 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
637 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
638 however, the `ids` attribute cannot use the ID type because `XML only
639 allows one ID per Element Type`__ and doesn't support a multiple-ID
640 "IDS" attribute type.
642 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
644 * docs/ref/rst/restructuredtext.txt:
646 - Added documentation for escaped whitespace in URI contexts.
647 - Clarify use of Unicode character categories.
649 * docutils/parsers/rst/states.py:
651 - Added functionality: escaped whitespace in URI contexts.
652 - Consistent handling of all whitespace characters in inline markup
653 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
655 * docutils/parsers/rst/directives/images.py:
657 - Added support for escaped whitespace in URI contexts.
659 * docutils/parsers/rst/directives/tables.py:
661 - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
662 that led to problems in an application with a custom table directive).
664 * docutils/transforms/frontmatter.py:
666 - Fix [ 320 ] Russian docinfo fields not recognized.
668 * docutils/transforms/references.py:
670 - Don't add a second ID to problematic references.
672 * docutils/transforms/universal.py:
674 Fix SmartQuotes: warn only once if language is unsupported,
675 keep "rawsource" when "educating" quotes.
677 * docutils/utils/__init__.py:
679 - Added ``split_escaped_whitespace`` function, support for escaped
680 whitespace in URI contexts.
682 * docutils/utils/error_reporting.py:
684 - Fix [ 321 ] Import block might cause name error.
686 * docutils/utils/smartquotes.py:
688 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
689 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
690 - Fix [ 313 ] Differentiate apostrophe from closing single quote
692 - Fix [ 317 ] Extra space inserted with French smartquotes.
693 - Add command line interface for stand-alone use (requires 2.7).
695 * docutils/writers/_html_base.py:
697 - Provide default title in metadata (required by HTML5).
698 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
699 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
700 reasons, we don't use a third party public installation as default but
701 warn if math-output_ is set to MathJax without specifying a URL.
703 * docutils/writers/html4css1/__init__.py:
705 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
707 * docutils/writers/latex2e/__init__.py:
709 - Handle class arguments for block-level elements by wrapping them
710 in a "DUclass" environment. This replaces the special handling for
711 "epigraph" and "topic" elements.
713 * docutils/writers/manpage.py:
715 - Apply [ 141 ] Handling inline in manpage writer.
717 * docutils/writers/odf_odt/__init__.py:
719 - Command setting ``language`` now sets the default language
720 of the generated ODF document.
721 - The use of image directive options :width: (%), :scale:, etc now
722 set the width/height/size of images in the generated ODF
724 - The heading/title of admonitions now reflects the language
725 specified by the ``language`` setting.
726 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
728 - Fixed [ 282 ] python3: AttributeError.
730 * tools/rst2html4.py: New front-end.
732 * tools/dev/generate_punctuation_chars.py: New script
733 to test and update utils.punctuation_chars.
736 Release 0.13.1 (2016-12-09)
737 ===========================
739 * docutils/languages/fa.py
740 docutils/parsers/rst/languages/fa.py
741 docutils/languages/la.py
742 docutils/parsers/rst/languages/la.py:
744 - Apply [ 133 ] Persian mappings by Shahin Azad.
745 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
749 - Fix [ 253 ] Attribute key without value not allowed in XML.
753 - Apply [ 103 ] Recognize inline markups without word boundaries.
754 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
756 * docutils/parsers/rst/__init__.py
758 - Fix [ 233 ] Change the base URL for the :rfc: role.
760 * docutils/parsers/rst/directives/tables.py
762 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
765 - Implement feature request [ 48 ]
766 Add :align: option to the table directives.
767 Thanks to Takeshi KOMIYA for the patch.
769 * docutils/parsers/rst/roles.py
771 - Fix [ 295 ] Class argument for custom role inheriting from math.
773 * docutils/parsers/rst/tableparser.py
775 - Really fix [ 159 ] Spurious table column alignment errors.
777 * docutils/transforms/frontmatter.py
779 - Add name of generic bibliographic fields as a "classes" attribute value
780 (after conversion to a valid identifier form).
782 * docutils/utils/error_reporting.py
784 - Fix [ 130 ] support streams expecting byte-strings in ErrorOutput.
786 * docutils/utils/math/math2html.py
788 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
789 - New upstream version (additional macros, piece-wise integrals and sums).
791 * docutils/writers/_html_base.py
793 - New auxiliary module for definitions common to all HTML writers.
795 * docutils/writers/html5_polyglot/
797 - New HTML writer generating clean, polyglot_ markup conforming to
800 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
801 and recommended layout rules.
803 * docutils/writers/html4css1/__init__.py
805 - Add "docutils" to class values for "container" object to address [ 267 ].
806 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
807 ``default_stylesheet_path`` and ``default_template_path``.
808 - Fix [ 266 ] creating labels/class values in description list items.
809 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
810 - Fix footnotes with content that does not start with a paragraph.
811 - Use https in default MathJax URL (report Alan G Isaac).
812 - Outsourcing of common code to _html_base.py.
814 * docutils/writers/latex2e/__init__.py
816 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
817 admonitions and docinfo.
819 - Use absolute path for ``default_template_path``.
821 - Removed deprecated options ``--use-latex-footnotes`` and
822 ``--figure-footnotes``.
824 - Cleaner LaTeX code for enumerations and literal blocks.
826 - Use "hyperref" package together with "bookmark" (improved hyperlinking
829 - Fix [ 286 ] Empty column title cause invalid latex file.
831 - Fix [ 224 ] Fix rowspan support for tables.
833 - Let LaTeX determine the column widths in tables with "colwidths-auto".
834 Not suited for multi-paragraph cells!
836 * docutils/writers/odf_odt/__init__.py
838 - remove decode.encode of filename stored in zip.
840 * docutils/writers/xetex/__init__.py
842 - LuaLaTex compatibility: do not load "xunicode".
846 - New front-end ``rst2html5.py``.
850 - Test py26, py27, py33 and py34.
852 To use, install the ``tox`` package via pip or easy_install and use
853 tox from the project root directory.
855 .. _polyglot: http://www.w3.org/TR/html-polyglot/
856 .. _HTML 5: http://www.w3.org/TR/html5/
857 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
860 Release 0.12 (2014-07-06)
861 =========================
863 * docs/ref/rst/directives.txt
865 - Update "math" and "csv-table" descriptions.
867 * docutils/parsers/rst/directives/images.py
869 - Fix [ 258 ] figwidth="image" generates unitless width value.
871 * docutils/parsers/rst/states.py
873 - Improve error report when a non-ASCII character is specified as
874 delimiter, quote or escape character under Python 2.
875 Fixes [ 249 ] and [ 250 ].
877 * docutils/writers/html4css1/__init__.py
879 - Don't add newline after inline math.
880 Thanks to Yury G. Kudryashov for the patch.
882 * docutils/writers/latex2e/__init__.py
884 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
885 - Apply [ 116 ] by Kirill Smelkov. Don't hard code \large for subtitle.
887 * docutils/writers/odf_odt/__init__.py
889 - Apply patch by Jakub Wilk to fix bug [ 100 ].
891 * test/test_error_reporting.py
893 - Fix [ 223 ] by removing redundant tests we do not have control over.
897 - Apply [ 115 ] respect fixed 2to3 string literal conversion behaviour.
900 Release 0.11 (2013-07-22)
901 =========================
905 - Apply [ 2714873 ] Fix for the overwriting of document attributes.
906 - Support embedded aliases within hyperlink references.
907 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
908 language module) before global search.
912 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
914 * docutils/parsers/rst/directives/__init__.py
916 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
918 * docutils/parsers/rst/directives/images.py
920 - Apply [ 3599485 ] node source/line information for sphinx translation.
922 * docutils/parsers/rst/directives/tables.py
924 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
926 * docutils/parsers/rst/states.py
928 - Fix [ 157 ] Line block parsing doesn't like system message.
929 - Always import our local copy of roman.py (report Larry Hastings).
931 * docutils/transforms/references.py
933 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
935 * docutils/utils/__init__.py
937 - Fix [ 3596884 ] exception importing ``docutils.io``.
939 * docutils/writers/html4css1/__init__.py
941 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
942 - New setting `stylesheet_dirs`: Comma-separated list of directories
943 where stylesheets are found. Used by `stylesheet_path` when expanding
944 relative path arguments.
945 - New default for math-output_: ``HTML math.css``.
946 - Avoid repeated class declarations in html4css1 writer
947 (modified version of patch [ 104 ]).
949 .. _math-output: docs/user/config.html#math-output
951 * docutils/writers/latex2e/__init__.py
953 - Drop the simple algorithm replacing straight double quotes with
954 English typographic ones.
955 Activate the SmartQuotes_ transform if you want this feature.
956 - Fix literal use of babel shorthands (straight quote, tilde, ...).
957 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
958 - New setting `stylesheet_dirs`.
960 .. _SmartQuotes: docs/user/config.html#smart-quotes
962 * docutils/writers/manpage.py
964 - Fix [3607063] handle lines starting with a period.
965 - Fix option separating comma was bold (thanks to Bill Morris).
968 Release 0.10 (2012-12-16)
969 =========================
973 - Dropped support for Python 2.3.
974 - ``docutils/math``, ``docutils/error_reporting.py``, and
975 ``docutils/urischemes.py`` moved to the utils package.
976 - Fix [3541369] Relative __import__ also with Python 3.3.
977 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
978 and parsers for Python 2.7 up.
979 - Fix import of PIL.Image.
980 - Change default of "syntax highlight" option to "long",
981 basic syntax highlight styles for LaTeX and HTML.
985 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
986 option is ignored and will be removed in a future release.
987 - Fix Py3k error writing to stdout with encoding differing from default.
988 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
990 * docutils/parsers/rst/directives/misc.py
992 - Fix [ 3546533 ] Unicode error with `date` directive.
994 * docutils/transforms/universal.py
996 - SmartQuotes transform for typographic quotes and dashes.
998 * docutils/utils/__init__.py
1000 - normalize_language_tag() now returns `BCP 47`_ conforming tags
1001 with sub-tags separated by ``-``.
1003 * docutils/writers/html4css1/__init__.py
1005 - Use ``<code>`` tag for inline "code",
1006 do not drop nested inline nodes (syntax highlight tokens).
1007 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
1008 - No line break after opening inline math tag.
1010 * docutils/writers/manpage.py
1012 - Apply [ 3527401 ] admonition's don't preserve indentation
1013 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
1015 * docutils/writers/xetex/__init__.py
1017 - Apply [ 3555160 ] ensure order of "otherlanguages".
1018 - Fix section numbering by LaTeX.
1020 * docutils/writers/s5_html/__init__.py
1022 - Fix [ 3556388 ] MathJax does not work with rst2s5.
1024 * docutils/writers/s5_html/docutils_xml.py
1026 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
1027 - Fix/improve output with ``--indent`` option.
1031 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
1033 * tools/test/test_buildhtml.py
1035 - Fix [ 3521167 ] allow running in any directory.
1036 - Fix [ 3521168 ] allow running with Python 3.
1039 Release 0.9.1 (2012-06-17)
1040 ==========================
1044 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
1045 installed in the PYTHONPATH. Converted tests are now
1046 stored in ``test3/``, tools no longer need conversion.
1048 If you installed one of Docutils versions 0.7 ... 0.9 with
1049 ``setup.py install`` under Python 3, remove the spurious
1050 ``test/`` and ``tools/`` directories in the site library root.
1054 - Make tests independent from the location of the ``test/`` directory.
1055 - Use converted sources (from the ``build/`` directory) for tests under
1060 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
1064 - Fix writing binary data to sys.stdout under Python 3 (allows
1065 ``rst2odt.py`` to be used with output redirection).
1067 * docutils/parsers/rst/directives/misc.py
1069 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
1070 ``locale == C`` and 8-bit char in path argument of `include` directive.
1074 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
1075 file under Python 3.
1078 Release 0.9 (2012-05-02)
1079 ========================
1083 - New reStructuredText "code" role and directive and "code" option
1084 of the "include" directive with syntax highlighting by Pygments_.
1085 - Fix parse_option_marker for option arguments containing ``=``.
1086 - Fix [ 2993756 ]: import Python Imaging Library's Image module
1087 via ``import PIL`` as starting with PIL 1.2,
1088 "PIL lives in the PIL namespace only" (announcement__).
1090 .. _Pygments: http://pygments.org/
1091 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
1095 - Fix [ 2971827 ] and [ 3442827 ]
1096 extras/roman.py moved to docutils/utils/roman.py
1098 * docutils/frontend.py
1100 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
1104 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
1105 - `mode` argument for FileOutput avoids code replication in
1107 - New exceptions InputError and OutputError for IO errors in
1108 FileInput/FileOutput.
1112 - No "hard" system exit on file IO errors: catch and report them in
1113 `Publisher.reportException` instead. Allows handling by a calling
1114 application if the configuration setting `traceback` is True.
1116 * docutils/utils.py -> docutils/utils/__init__.py
1118 - docutils.utils is now a package (providing a place for sub-modules)
1120 .. note:: docutils/math, docutils/error_reporting.py, and
1121 docutils/urischemes.py will move to the utils package in the next
1122 release, too. See RELEASE-NOTES__
1124 __ RELEASE-NOTES.html
1126 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
1127 errors recording non-ASCII filenames (fixes [ 3434355 ]).
1129 - Fix relative_path() with source=None and `unicode` target.
1131 * docutils/parsers/rst/states.py
1133 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
1134 characters and "international" quotes around inline markup.
1135 - Use `field_marker` pattern to look for start of a
1136 directive option block (fixes [ 3484857 ]).
1138 * docutils/parsers/rst/tableparser.py
1140 - Fix [ 2926161 ] for simple tables.
1141 (Combining chars in grid tables still contribute to cell width.)
1143 * docutils/writers/latex2e/__init__.py
1145 - Support the `abbreviation` and `acronym` standard roles.
1146 - Record only files required to generate the LaTeX source as dependencies.
1147 - Fix handling of missing stylesheets.
1148 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
1149 when suppressing LaTeX section numbering.
1150 - Use ``\DUtitle`` for unsupported section levels
1151 - Apply [ 3512791 ] do not compare string literals with "is"
1153 * docutils/writers/xetex/__init__.py
1155 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
1157 * docutils/writers/html4css1/__init__.py
1159 - Change default for `math-output` setting to MathJax.
1160 - Fix handling of missing stylesheets.
1162 * docutils/writers/docutils_xml.py
1164 - Use the visitor pattern with default_visit()/default_depart() methods
1165 instead of minidom to facilitate special handling of selected nodes.
1166 - Support raw XML (inserted as-is inside a <raw></raw> node).
1168 * docutils/writers/manpage.py
1170 - Do not emit comment line with trailing blank. Problematic for VCS.
1173 Release 0.8.1 (2011-08-30)
1174 ==========================
1178 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
1179 and [ 3395920 ] (correct copyright info for rst.el).
1183 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
1185 * docutils/writers/latex2e/__init__.py
1187 - Clean up Babel language setting. Restores Sphinx compatibility.
1190 Release 0.8 (2011-07-07)
1191 ========================
1195 - Handle language codes according to `BCP 47`_.
1196 - If the specified language is not supported by Docutils,
1197 warn and fall back to English.
1198 - Math support: reStructuredText "math" role and directive,
1199 ``math`` and ``math_block`` doctree elements.
1200 - Decode command line arguments with the locale's preferred encoding
1201 (to allow, e.g., ``--title=Dornröschen``).
1202 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
1203 - New sub-module `error_reporting`: handle encoding/decoding errors
1204 when reporting exceptions.
1205 - Some additions to the Docutils core are released under the 2-Clause BSD
1206 license, see COPYING_ for details.
1208 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
1209 .. _COPYING: COPYING.html
1213 - Most directives now support a "name" option that attaches a
1216 - Directive content may start on the first line also when the directive
1217 type accepts options.
1219 * docs/dev/policies.txt:
1221 - Recommend the 2-Clause BSD license
1222 (http://opensource.org/licenses/BSD-2-Clause)
1223 for code that is kept under the author's copyright.
1225 * tools/buildhtml.py:
1227 - Fix ``--local`` switch.
1229 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1231 * docutils/writers/html4css1/__init__.py
1233 - Set "lang" argument for objects with class argument
1234 "language-<language tag>".
1235 - New setting "math-output" with support for HTML, MathML, and LaTeX.
1237 * docutils/writers/latex2e/__init__.py
1239 - Fix [ 3043986 ] AttributeError using :local: with table of content.
1240 - Place title data in the document preamble.
1241 - Load `babel` package only if required.
1242 - Update list of supported languages.
1243 - New config setting "hyperref-options".
1244 No hard-coded "unicode" hyperref option (clash with xetex).
1245 - Set language for custom roles, paragraphs, block-quotes, and
1246 line-quotes with class argument "language-<language tag>".
1247 - Fix [ 3095603 ] wrong quotes output for Russian and other languages.
1248 - Convert image URI to a local file path.
1249 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1250 has more than one paragraph (Wolfgang Scherer).
1251 - \leavevmode before longtable only when needed (prevents spurious vspace)
1252 - do not advance table counter for tables without caption
1254 * docutils/writers/xetex/__init__.py
1256 - New writer generating LaTeX code for compiling with ``xelatex``.
1258 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1259 option allows separate config options for XeTeX vs. LaTeX2e.
1261 * docutils/writers/manpage.py
1263 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1264 - Fix: vertical space cleaning for option group ``.``.
1266 * tools/editors/emacs/rst.el:
1268 - Fix [ 3001100 ] does not handle spaces in filenames.
1269 Thanks to Jakub Wilk.
1271 * docutils/utils.py:
1273 - strip whitespace from stylesheet arguments
1274 - exclude combining chars from column_width()
1275 (partial fix for [ 2926161 ])
1277 * docutils/parsers/rst/directives/misc.py:
1279 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1284 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
1285 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1288 Release 0.7 (2010-07-07)
1289 ========================
1293 - Fix [ 2881769 ] setup configuration.
1294 - Fix [ 2788716 ] reporting problems in included files.
1298 - FileInput opens files as text files with universal newline support
1299 (mode "rU", configurable with the new optional argument "mode").
1303 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1307 - Fix [ 2923723 ] let decode_path() tolerate path == None
1309 * docutils/writers/html4css1/__init__.py
1311 - Support SVG and SWF images (thanks to Stefan Rank).
1312 - Generate valid XHTML for centred images with targets.
1313 Use CSS classes instead of "align" tags for image alignment.
1315 * docutils/writers/latex2e/__init__.py
1317 - Use `transforms.writer_aux.Admonitions` to "normalize" special
1319 - Use the ``\url`` command for URLs (breaks long URLs instead of
1320 writing into the margin).
1321 - Preserve runs of spaces in `inline literals`__.
1322 - Deprecate ``figure_footnotes`` setting.
1323 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
1324 - New ``latex_preamble`` setting.
1325 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1326 - Fix hyperlink targets (labels) for images, figures, and tables.
1327 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1328 - Apply [ 2961991 ] Call hyperref with unicode option.
1329 - Drop the special `output_encoding`__ default ("latin-1").
1330 The Docutils wide default (usually "UTF-8") is used instead.
1331 - Render inline markup in document title and subtitle.
1332 - Fix numbering depth with LaTeX section numbering.
1333 - Update Unicode -> LaTeX translations.
1334 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1336 __ docs/ref/restructuredtext.html#inline-literals
1337 __ docs/user/config.html#docutils-footnotes
1338 __ docs/user/config.html#output_encoding
1340 * docutils/writers/manpage.py
1342 - Fix: supported attribute (thanks to peter2108).
1343 - Remove trailing blanks in code (keep in sync with mercurial version).
1344 - Titles level 1, that is ``.SH``, always uppercase.
1345 - Apply patch from mg: literal text should be bold in man-pages.
1349 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1354 - Python 3 support: copy test/ and tools/ to the build-dir
1355 and convert Python sources with 2to3.
1358 Release 0.6 (2009-10-11)
1359 ========================
1363 - Docutils is now compatible with Python versions from 2.3 up to 2.6
1364 and convertible to 3.1 code.
1366 + Node.__nonzero__ returns True instead of 1.
1367 + use os.walk instead os.path.walk.
1368 + minimize "types" module where possible.
1369 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1370 + Text nodes now subclass unicode rather than UserString
1371 (which is gone in python 3.0).
1372 + 3.0 compatibility module docutils._compat
1374 + Drop 2.2 compatibility workarounds.
1375 + Drop extras/optparse.py and extras/textwrap.py
1376 (stdlib modules since 2.3).
1378 - OpenOffice export: ODT writer moved from sandbox to Docutils core.
1379 - Unix man page export: manpage writer moved from sandbox to Docutils
1382 - Apply [ 1719345 ] Galician translation
1383 - Apply [ 1905741 ] Polish translation
1384 - Apply [ 1878977 ] make_id(): deaccent characters.
1385 - Apply [ 2029251 ] return nonzero when tests fail.
1386 - Fix [ 1692788 ] allow UTF-8 in style sheets.
1387 - Fix [ 2781629 ] support non-ASCII chars in file names.
1388 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1389 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
1390 - Fix [ 2821266 ] --strict option works now like --halt=info.
1391 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
1392 - Fix [ 1627229 ] hyperlink references in substitutions.
1394 - The "newlatex" writer is orphaned.
1398 - Documented Unicode characters allowed as inline markup openers,
1399 closers, and delimiters.
1400 - Allow units for all length specifications.
1401 - Allow percent sign in "scale" argument of "figure" and "image" directives.
1402 - Bugfix: The "figalign" argument of a figure now works as intended
1403 (aligning the figure, not its contents).
1404 - Align images with class "align-[right|center|left]"
1405 (allows setting the alignment of an image in a figure).
1407 * docutils/nodes.py:
1409 - Added ``Element.__contains__`` method, for the in-operator.
1411 * docutils/parsers/rst/states.py:
1413 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1414 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1415 " " (non-breaking space), and "¡ ¿" openers.
1417 * docutils/parsers/directives/misc.py:
1419 - Added ``start-line`` and ``end-line`` options to "include"
1420 directive to select a range of lines.
1421 - Hard tabs in literal inclusions are replaced by spaces. This is
1422 configurable via the new ``tab-width`` option of the "include" directive
1423 (a negative tab-width prevents tab expansion).
1425 * docutils/utils.py:
1427 - Add ``get_stylesheet_list`` function.
1428 - Apply [ 2834836 ] print info at halt
1430 * docutils/transforms/universal.py:
1432 - Raise default priority of StripClasses to exclude stripped classes from
1435 * docutils/writers/html4css1/__init__.py:
1437 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
1438 separated list of stylesheets.
1439 - Address [ 1938891 ] Inline literal text creates "pre" span only when
1440 needed to prevent inter-word line wraps.
1441 - Use `translate` method instead of repeated `replace` calls.
1442 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
1443 classes to allow CSS styling that does not interfere with other
1444 table-using constructs (field lists, citations, ...).
1446 * docutils/writers/newlatex2e/__init__.py:
1448 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1450 * docutils/writers/latex2e/__init__.py:
1452 - Add ``--embed-stylesheet`` option.
1453 - Apply [ 1474017 ] image vertical alignment is reversed.
1454 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1455 - Change: has_key for dictionaries (not Nodes) to in-operator.
1456 - Merge adjacent citations into one latex cite command.
1457 - Failsafe implementation of custom roles. LaTeX compilation now ignores
1458 unknown classes instead of aborting with an error.
1459 - Support custom roles based on standard roles.
1460 - LaTeX packages can be used as ``--stylesheet`` arguments without
1461 restriction. (A style sheet is now referenced with the ``\usepackage``
1462 command, if it ends with ``.sty`` or has no extension.)
1463 - Add ``bp`` to lengths without unit (prevents LaTeX errors).
1464 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1465 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1466 2005-02-04 as a configurable length unit).
1467 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1468 if font-encoding is set to ''. LaTeX defaults to OT1 then.
1469 - Set sub- and superscript role argument in text mode not as math.
1470 Use a custom role based on sub-/superscript if you want italic shape.
1471 - Shorter preamble and less dependencies: Load packages and define macros
1472 only if required in the document.
1473 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1474 - New custom environments and commands with optional "classes" argument.
1475 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1476 - Better conformance to Docutils specifications with ``--use-latex-toc``.
1477 Support for LaTeX generated ToC also with unnumbered sections.
1478 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1479 section numbering by LaTeX.
1480 - Use default font in admonitions and sidebar.
1481 - Align of image in a figure defaults to 'center'.
1482 - Bugfix: Newlines around targets and references prevent run-together
1484 - Fix internal hyperlinks.
1485 - Use class defaults for page margins ('typearea' now optional).
1486 - Float placement made configurable, default changed to "here definitely".
1487 - Typeset generic topic as "quote block with title".
1488 - Use template (file and configuration option).
1489 - In the default template, load cmap.sty (fix text extraction in PDF) and
1490 fixltx2e.sty (LaTeX patches, \textsubscript).
1491 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1492 - Use `translate` instead of repeated `replace` calls for text encoding.
1493 - Hyperlinked footnotes and support for symbol footnotes and
1494 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
1495 - Complete pairs of binary options
1496 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
1497 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
1499 - font-encoding: "T1" (formerly implicitly set by 'ae').
1500 - use-latex-toc: true (ToC with page numbers).
1501 - use-latex-footnotes: true (no mixup with figures).
1503 * docutils/writers/manpage.py
1505 - Do not print version at document end, this is done by the viewer.
1506 - Do not print date at document end, this is done by the viewer.
1507 - Fix storage of docinfo fields for none standard fields.
1509 * docutils/tools/rst2man.py
1512 Release 0.5 (2008-06-25)
1513 ========================
1515 * docutils/languages/he.py: Added to project: Hebrew mappings by
1518 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
1519 mappings by Meir Kriheli.
1521 * docutils/frontend.py:
1523 - Configuration files are now assumed and required to be
1525 - Paths of applied configuration files are now recorded in the
1526 runtime setting ``_config_files`` (accessible via
1527 ``--dump-settings``).
1528 - Added ``--strip-elements-with-class`` and ``--strip-class``
1529 options (``strip_elements_with_classes`` and ``strip_classes``
1534 - Added code to determine the input encoding from data: encoding
1535 declarations or the presence of byte order marks (UTF-8 & UTF-16).
1536 - Added support for IronPython 1.0.
1538 * docutils/nodes.py:
1540 - Added ``document.__getstate__`` method, for pickling.
1542 * docutils/parsers/rst/states.py:
1544 - Allow ``+`` and ``:`` in reference names.
1545 - Unquoted targets beginning with an underscore (``.. __target:
1546 URI``) are no longer accepted.
1547 - Added support for multiple attributions in a physical block quote
1548 (indented text block), dividing it into multiple logical block
1550 - Added support for unicode bullets in bullet lists: "•", "‣", and
1552 - Added support for new object-oriented directive interface,
1553 retaining compatibility to the old functional interface.
1554 - Added support for throwing ``DirectiveError``'s from within
1557 * docutils/parsers/rst/__init__.py:
1559 - Added ``Directive`` base class.
1560 - Added ``DirectiveError`` base class.
1561 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
1564 * docutils/parsers/directives/:
1566 - Refactored all reStructuredText directives to use the new
1567 object-oriented directive interface. Errors are now (mostly)
1568 thrown using the new ``DirectiveError`` class.
1570 * docutils/parsers/directives/misc.py:
1572 - Added ``start-after`` and ``end-before`` options to ``include``
1573 directive; thanks to Stefan Rank.
1575 * docutils/transforms/universal.py:
1577 - Added ``StripClassesAndElements`` transform to remove from the
1578 document tree all elements with classes in
1579 ``settings.strip_elements_with_classes`` and all "classes"
1580 attribute values in ``self.document.settings.strip_classes``.
1582 * docutils/transforms/writer_aux.py:
1584 - Added ``Admonitions`` transform to transform specific admonitions
1585 (like ``note``, ``warning``, etc.) into generic admonitions with a
1588 * docutils/writers/html4css1/__init__.py:
1590 - Moved template functionality from the PEP/HTML writer here.
1591 - Expanded the fragments available in the ``parts`` attribute.
1592 - Moved ``id`` attributes from titles to surrounding ``div``
1594 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
1595 universally supported now).
1596 - ``template.txt`` is now opened in text mode instead of binary mode
1597 (to ensure Windows compatibility).
1598 - ``a`` elements now have an "internal" or "external" class,
1599 depending on reference type.
1601 * docutils/writers/html4css1/template.txt: Added to project.
1603 * docutils/writers/pep_html/:
1605 - Moved template functionality to the HTML writer.
1607 * docutils/writers/s5_html/__init__.py:
1609 - Added ``view_mode`` & ``hidden_controls`` settings
1610 (``--view-mode`` & ``--hidden-controls/--visible-controls``
1613 * docutils/writers/latex2e/__init__.py:
1615 - Add ``--literal-block-env``
1616 - Fix: escaping ``%`` in href urls.
1617 - Move usepackage hyperref after stylesheet inclusion.
1618 - Fix: scrartcl does not have chapter but scrreprt.
1619 - Add newline after ``\end{verbatim}``.
1620 - Merge smaller differences from latex2e_adaptive_preamble.
1621 - Add ``use-part-section``.
1622 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
1623 - Using leavemode option_list no longer needs to check if parent
1624 is a definition list.
1625 - Append ``\leavemode`` to definition list terms.
1626 - No longer write visit\_/depart_definition_list_item comments to
1628 - Table column width with 3 decimal places.
1629 - Add table stubs support (boldfont).
1630 - Add assemble_parts to writer.
1631 - Add simply support for nested tables.
1632 - Fix verbatim in tables if use-verbatim-when-possible.
1633 - Use section commands down to subparagraph.
1634 - Put ensuremath around some latin1 chars.
1635 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
1636 - New option ``--use-bibtex=style,db1,db2``.
1637 - New option ``--reference-label`` to allow usage of LaTeX ref for
1638 labels in section references.
1639 - Add a label after every section to support sectionnumbers as reference
1641 - Fix: bug# 1605376 rst2latex: bad options group list
1642 - Remove inactive code for use_optionlist_for_option_list.
1643 - Remove latex comments from option_list output.
1644 - Fix: bug# 1612270 double quotes in italian literal.
1645 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
1646 - Add option --use-latex-abstract.
1647 - Image width unit ``px`` is translated to ``pt``.
1648 - Add image height support.
1649 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
1651 - Fix: Do not escape underscores in citation reference labels if
1652 use-latex-citations is set.
1653 - Use centering instead of center for figure contents, to avoid vertical
1655 - Recognize table class: borderless, nolines, booktabs, standard.
1656 - Fix: Renaming contents section does not work with latex writer; SF
1658 - Applied patch for custom roles with classes from Edward Loper.
1659 - Fixed bug that caused crashes with more than 256 lists.
1661 * docutils/writers/pep_html/__init__.py:
1663 - Changed to support new python.org website structure and
1666 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1669 * tools/buildhtml.py:
1671 -- Added ``ignore`` setting to exclude a list of shell patterns
1672 (default: ``.svn:CVS``).
1674 * tools/editors/emacs/rst.el:
1676 - Changed license to "GPL".
1677 - Added ``rst-straighten-decorations`` function.
1678 - The ``compile`` module is now always loaded.
1679 - Added ``rst-toggle-line-block`` function.
1680 - Headings consisting only of non-ASCII characters are now
1681 recognized by ``rst-toc`` and ``rst-adjust``.
1682 - Added font-lock support for multi-line comments where the first
1683 comment line is empty.
1684 - Added ``(require 'font-lock)``.
1688 - Provide descriptive error message if distutils is missing.
1691 Release 0.4 (2006-01-09)
1692 ========================
1696 - Updated the project policies for trunk/branch development &
1699 * docutils/__init__.py:
1701 - Added ``__version_details__`` attribute to describe code source
1702 (repository/snapshot/release).
1703 - Replaced ``default_transforms`` attribute of TransformSpec with
1704 ``get_transforms()`` method.
1708 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1709 functions, for document tree extraction and reprocessing.
1713 - Added ``DocTreeInput`` class, for reprocessing existing documents.
1714 - Added support for non-Unicode (e.g. binary) writer output.
1716 * docutils/nodes.py:
1718 - Re-introduced ``Targetable.indirect_reference_name``, for
1719 MoinMoin/reST compatibility (removed in r3124/r3129).
1720 - Added ``serial_escape`` function; escapes string values that are
1721 elements of a list, for serialization. Modified Docutils-XML
1722 writing (``Element._dom_node``) and pseudo-XML writing
1723 (``Element.starttag``) to use ``serial_escape``.
1724 - Added ``Node.deepcopy()`` method.
1725 - Removed the internal lists ``document.substitution_refs``,
1726 ``document.anonymous_refs``, and ``document.anonymous_targets``.
1727 - Added a "container" element.
1728 - Fixed bug where values of list-valued attributes of elements
1729 originating from custom interpreted text roles (i.e., with custom
1730 classes) were being shared between element instances. Reported by
1733 * docutils/statemachine.py:
1735 - Added trailing whitespace stripping to ``string2lines()``.
1736 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1737 Asian double-width character support.
1739 * docutils/utils.py:
1741 - Added ``east_asian_column_width()`` for double-width character
1744 * docutils/languages/ja.py: Added to project: Japanese mappings by
1747 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1748 mappings by Panjunyong.
1750 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1752 * docutils/parsers/rst/__init__.py:
1754 - Added validator to tab_width setting, with test. Closes SF bug
1755 #1212515, report from Wu Wei.
1757 * docutils/parsers/rst/states.py:
1759 - Fixed bug with escaped colons indicating a literal block.
1760 - Fixed bug with enumerated lists (SF#1254145).
1761 - Backslash-escaped colons inside of field names are now allowed.
1762 - Targets (implicit and explicit), anonymous hyperlink references
1763 and auto-numbered footnote references inside of substitution
1764 definitions are now disallowed.
1765 - Fixed bug: list items with blank first lines.
1766 - Fixed bug: block quote attributions with indented second lines.
1767 - Added East Asian double-width character support (Python 2.4 only).
1769 * docutils/parsers/rst/tableparser.py:
1771 - Added East Asian double-width character support (Python 2.4 only).
1773 * docutils/parsers/rst/directives/body.py:
1775 - Added the "container" directive.
1777 * docutils/parsers/rst/directives/misc.py:
1779 - Added the "default-role", "title", and "date" directives.
1780 - Added standard data file syntax to the "include" directive.
1781 - Added support for "class" directive content.
1783 * docutils/parsers/rst/directives/images.py:
1785 - Added ``indirect_reference_name`` support for images with a target
1787 - Added support for image width and height units.
1788 - Fixed bug with image "target" options.
1790 * docutils/parsers/rst/directives/references.py:
1792 - Added "class" attribute to "target-notes" directive, for
1793 footnote_reference classes.
1795 * docutils/parsers/rst/include/: Directory added to project; contains
1796 standard data files for the "include" directive. Initial contents:
1797 character entity substitution definition sets, and a set of
1798 definitions for S5/HTML presentations.
1800 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1801 mappings by David Goodger.
1803 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1804 Simplified Chinese mappings by Panjunyong.
1806 * docutils/readers/__init__.py:
1808 - Added universal.Decorations and universal.ExposeInternals
1809 transforms as default transforms for all readers.
1810 - Added ``ReReader`` base class for readers that reread an existing
1813 * docutils/readers/doctree.py: Added to project; a reader for existing
1816 * docutils/transforms/frontmatter.py:
1818 - Fixed the DocInfo transform to handle SVN-style expansion of the
1820 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1823 * docutils/transforms/misc.py:
1825 - Added misc.Transitions transform, extracted from
1826 universal.FinalChecks.
1828 * docutils/transforms/references.py:
1830 - Added references.DanglingReferences transform, extracted from
1831 universal.FinalChecks.
1832 - Fixed bug with doubly-indirect substitutions.
1833 - Added footnote_reference classes attribute to "TargetNotes".
1834 - Fixed bug with circular substitution definitions that put Docutils
1835 into an infinite loop.
1837 * docutils/transforms/universal.py:
1839 - Added universal.ExposeInternals transform, extracted from
1840 universal.FinalChecks.
1841 - Removed universal.FinalChecks transform (logic has been moved to
1842 several new transforms).
1843 - Fixed bug with the "expose_internals" setting and Text nodes
1844 (exposed by the "rawsource" internal attribute).
1845 - Added the universal.StripComments transform, implementation of the
1846 "strip_comments" setting.
1848 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1849 transforms for writers.
1851 - Added ``Compound`` transform, which flattens compound paragraphs.
1853 * docutils/writers/: Several writer modules (html4css1.py) were
1854 converted into packages. Support modules and data files have been
1855 moved into the packages. The stylesheets for the HTML writers are
1856 now installed along with the code, the code knows where to find
1857 them, and the default is to use them (actually, to embed them).
1858 Some adjustments to configuration files may be necessary. The
1859 easiest way to obtain the new default behavior is to remove all
1860 settings whose name includes "stylesheet".
1862 * docutils/writers/__init__.py:
1864 - Added universal.Messages and universal.FilterMessages transforms
1865 as default transforms for all writers.
1866 - Added ``UnfilteredWriter`` base class for writers that pass the
1867 document tree on unchanged.
1869 * docutils/writers/docutils_xml.py:
1871 - Made ``xmlcharrefreplace`` the default output encoding error
1874 * docutils/writers/html4css1/:
1876 - Added support for image width and height units.
1877 - Made ``xmlcharrefreplace`` the default output encoding error
1879 - Made ``--embed-stylesheet`` the default rather than
1880 ``--link-stylesheet``.
1881 - Moved "id" attribute from container (section etc.) to title's <a>
1882 tag, to be on the same tag as "name".
1883 (!!! To be reverted in Docutils 0.5.)
1884 - Added vertical space between fields of field lists.
1885 - Added ``--compact-field-lists`` option to remove vertical space in
1887 - Made cloaking of email addresses with ``--cloak-email-addresses``
1889 - Fixed support for centered images.
1890 - Added support for class="compact" & class="open" lists.
1892 * docutils/writers/latex2e/:
1894 - Underscores in citekeys are no longer escaped.
1896 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1897 mapping of Unicode characters to LaTeX equivalents.
1899 * docutils/writers/s5_html/: Package added to project; writer for
1900 S5/HTML slide shows.
1902 * docs/dev/distributing.txt: Added to project; guide for distributors
1903 (package maintainers).
1905 * docs/dev/hacking.txt: Added to project; guide for developers.
1907 * docs/ref/doctree.txt:
1909 - Updated for plural attributes "classes", "ids", "names",
1911 - Added the "container" element.
1913 * docs/ref/docutils.dtd:
1915 - Updated for plural attributes "classes", "ids", "names",
1918 * docs/user/emacs.txt: Added to project; a document about Emacs
1919 support for reStructuredText and Docutils.
1921 * docs/user/links.txt: Added to project; lists of Docutils-related
1924 * docs/user/mailing-lists.txt: Added to project; information about
1925 Docutils-related mailing lists and how to access them.
1927 * docs/user/slide-shows.txt: Added to project; example of and docs for
1928 the S5/HTML writer (``rst2s5.py`` front end).
1930 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1931 Files", added to project.
1933 * test/coverage.sh: Added to project; test coverage script.
1935 * test/DocutilsTestSupport.py:
1937 - Added support for specifying runtime settings at the suite level.
1939 * test/test_functional.py:
1941 - Added the ``clear_output_directory`` function.
1942 - Added support for ``_test_more`` functions in functional test
1945 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1947 * tools/rstpep2html.py: Renamed from pep.py.
1949 * tools/dev/create_unimap.py: Added to project; script to create the
1950 docutils/writers/unimap_latex.py mapping file.
1952 * tools/dev/profile_docutils.py: Added to project; profiler script.
1954 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1956 * tools/editors/emacs/restructuredtext.el,
1957 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1958 Removed from project; the functionality is now contained in rst.el.
1960 * tools/editors/emacs/rst.el: Added to project. Added many features
1961 and fixed many bugs. See docs/user/emacs.txt for details.
1963 * tools/stylesheets: Removed from project. Stylesheets have been
1964 renamed and moved into writer packages.
1967 Release 0.3.9 (2005-05-26)
1968 ==========================
1972 - Eliminated and replaced all uses of the old string attributes
1973 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1974 new list attributes ``ids``, ``names``, ``dupnames`` and
1975 ``classes`` throughout the whole source tree.
1979 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1980 allowing for easier debugging.
1981 - In ``Publisher.publish()``, expanded the generic top-level
1984 * docutils/examples.py:
1986 - Added ``internals`` function for exploration.
1990 - Fixed ``Input.decode`` method to apply heuristics only if no
1991 encoding is explicitly given, and to provide better reporting of
1993 - The ``Input.decode`` method now removes byte order marks (BOMs)
1996 * docutils/nodes.py:
1998 - ``image`` element class changed to subclass of Element, not
1999 TextElement (it's an empty element, and cannot contain text).
2000 - Added ``attr_defaults`` dictionary for default attribute values.
2001 - Added empty list as default value for the following attributes:
2002 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
2003 - Added ``document.decoration`` attribute,
2004 ``document.get_decoration`` method, and ``decoration.get_header``
2005 & ``.get_footer`` methods.
2006 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
2009 * docutils/utils.py:
2011 - Removed ``docutils.utils.Reporter.categories``,
2012 ``docutils.utils.ConditionSet``, and all references to them, to
2013 simplify error reporting.
2015 * docutils/languages/nl.py: Added to project; Dutch mappings by
2018 * docutils/parsers/rst/__init__.py:
2020 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
2022 * docutils/parsers/rst/states.py:
2024 - Added check for escaped at-mark to prevent email address recognition.
2025 - Fixed option lists to allow spaces inside ``<angle-bracketed option
2027 - Allowed whitespace in paths and URLs.
2028 - Added auto-enumerated list items.
2029 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
2031 - Added support for table stub columns.
2033 * docutils/parsers/rst/directives/__init__.py:
2035 - Allowed whitespace in paths (``path`` function).
2036 - Added ``uri`` directive option conversion function.
2038 * docutils/parsers/rst/directives/body.py:
2040 - Fixed illegal context bug with "topic" directive (allowed within
2041 sidebars; not within body elements).
2043 * docutils/parsers/rst/directives/images.py:
2045 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
2046 - Added support for the ``file_insertion_enabled`` setting in the
2047 "figure" directive (disables "figwidth" option).
2048 - "image" directive: added checks for valid values of "align" option,
2049 depending on context. "figure" directive: added specialized
2050 "align" option and attribute on "figure" element.
2051 - Made ":figwidth: image" option of "figure" directive work again.
2052 - Fixed bug with reference names containing uppercase letters
2053 (e.g. ``Name_``) in "target" option of "image" directive.
2055 * docutils/parsers/rst/directives/misc.py:
2057 - Fixed "include" and "raw" directives to catch text decoding
2059 - Allowed whitespace in "include" & "raw" directive paths.
2060 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
2061 settings in "include" & "raw" directives.
2063 * docutils/parsers/rst/directives/parts.py:
2065 - Added "header" & "footer" directives.
2066 - Fixed illegal context bug with "contents" directive (topics
2067 allowed within sidebars; not within body elements).
2069 * docutils/parsers/rst/directives/tables.py:
2071 - Added "list-table" directive.
2072 - Caught empty CSV table bug.
2073 - Added support for the ``file_insertion_enabled`` setting in the
2074 "csv-table" directive.
2075 - Added ``stub-columns`` option to "csv-table" and "list-table"
2078 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
2079 mappings by Martijn Pieters.
2081 * docutils/readers/standalone.py:
2083 - Added ``--section-subtitles`` and ``--no-section-subtitles``
2084 options to activate or deactivate the SectSubTitle transform.
2086 * docutils/transforms/frontmatter.py:
2088 - Added SectSubTitle transform to promote titles of lone
2089 subsections to subtitles.
2091 * docutils/transforms/references.py:
2093 - Fixed mislocated internal targets bug, by propagating internal
2094 targets to the next node, making use of the newly added support
2095 for multiple names and IDs.
2096 - Fixed duplicate footnote label bug.
2097 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
2100 * docutils/writers/html4css1.py:
2102 - Fixed unencoded stylesheet reference bug (characters like "&" in
2103 stylesheet references).
2104 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
2106 - Added support for multiple IDs per node by creating empty ``span``
2108 - Added the ``field_name_limit`` & ``option_limit`` settings &
2110 - Added support for table stub columns.
2111 - Added support for the ``align`` attribute on ``figure`` elements.
2112 - Added the ``cloak_email_addresses`` setting & support.
2113 - Added ``html_prolog``, ``html_head``, ``html_body``,
2114 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
2115 ``docutils.core.publish_parts``.
2116 - Added support for section subtitles.
2118 * docutils/writers/latex2e.py:
2120 - Fixed tables starting with more than one multirow cell.
2121 - Improved --use-latex-docinfo so that organization/contact/address
2122 fields are lumped with the last author field and appear on the
2124 - Made sure the titlepage is always shown with --use-latex-docinfo,
2125 even if the document has no title.
2126 - Made sure that latex doesn't fill in today's date if no date field
2128 - Added support for section subtitles.
2130 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
2131 (under development).
2133 * docutils/writers/null.py: Added to project; a do-nothing Writer.
2135 * docs/api/publisher.txt:
2137 - Added "``publish_parts`` Details" section.
2139 * docutils/dev/repository.txt: Added to project; information about the
2140 Docutils Subversion repository.
2142 * docs/ref/docutils.dtd:
2144 - Added a ``stub`` attribute to the ``colspec`` element via the
2145 ``tbl.colspec.att`` parameter entity.
2146 - Allowed topic elements within sidebars
2147 - Added an ``align`` attribute to the ``figure`` element.
2149 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
2153 Release 0.3.7 (2004-12-24)
2154 ==========================
2156 * docutils/frontend.py:
2158 - Added options: --input-encoding-error-handler,
2159 --record-dependencies, --leave-footnote-reference-space,
2161 - Added command-line and config file support for "overrides" setting
2166 - Added support for input encoding error handler.
2168 * docutils/nodes.py:
2170 - Added dispatch_visit and dispatch_departure methods to
2171 NodeVisitor; useful as a hook for Visitors.
2172 - Changed structure of ``line_block``; added ``line``.
2173 - Added ``compound`` node class.
2174 - Added a mechanism for Visitors to transitionally ignore new node
2177 * docutils/utils.py:
2179 - Moved ``escape2null`` and ``unescape`` functions from
2180 docutils/parsers/rst/states.py.
2182 * docutils/parsers/rst/roles.py:
2185 - Changed role function API: the "text" parameter now takes
2186 null-escaped interpreted text content.
2188 * docutils/parsers/rst/states.py:
2190 - Fixed bug where a "role" directive in a nested parse would crash
2191 the parser; the state machine's "language" attribute was not being
2193 - Added support for line block syntax.
2194 - Fixed directive parsing bug: argument-less directives didn't
2195 notice that arguments were present.
2196 - Removed error checking for transitions.
2197 - Added support for multiple classifiers in definition list items.
2198 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
2199 - Changed role function API: the "text" parameter now takes
2200 null-escaped interpreted text content.
2201 - Empty sections and documents are allowed now.
2203 * docutils/parsers/rst/directives/__init__.py:
2205 - Added ``encoding`` directive option conversion function.
2206 - Allow multiple class names in class_option conversion function.
2208 * docutils/parsers/rst/directives/body.py:
2210 - Converted the line-block directive to use the new structure.
2211 - Extracted the old line-block functionality to the ``block``
2212 function (still used).
2213 - Added ``compound`` directive (thanks to Lea Wiemann).
2215 * docutils/parsers/rst/directives/misc.py:
2217 - Added "encoding" option to "include" and "raw" directives.
2218 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
2219 - Allow multiple class names in the "class" directive.
2221 * docutils/parsers/rst/directives/parts.py:
2223 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
2224 options. Thanks to Lele Gaifax.
2226 * docutils/parsers/rst/directives/tables.py:
2228 - Added "encoding" directive to "csv-table" directive.
2229 - Added workaround for lack of Unicode support in csv.py, for
2230 non-ASCII CSV input.
2232 * docutils/transforms/misc.py:
2234 - Fixed bug when multiple "class" directives are applied to a single
2236 - Enabled multiple format names for "raw" directive.
2238 * docutils/transforms/references.py:
2240 - Added support for trimming whitespace from beside substitution
2243 * docutils/transforms/universal.py:
2245 - FinalChecks now checks for illegal transitions and moves
2246 transitions between sections.
2248 * docutils/writers/html4css1.py:
2250 - HTMLTranslator.encode now converts U+00A0 to " ".
2251 - "stylesheet" and "stylesheet_path" settings are now mutually
2253 - Added support for the new line_block/line structure.
2254 - --footnote-references now overrides
2255 --trim-footnote-reference-space, if applicable.
2256 - Added support for ``compound`` elements.
2257 - Enabled multiple format names for "raw" directive.
2258 - ``<p>`` tags of a paragraph which is the only visible child of the
2259 document node are no longer stripped.
2260 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2261 new method ``should_be_compact_paragraph()``.
2262 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2264 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2265 the output if they have their ``class`` attribute set.
2266 - The whole document is now surrounded by a ``<div
2267 class="document">`` element.
2268 - Body-level images are now wrapped by their own ``<div>`` elements,
2269 with image classes copied to the wrapper, and for images which
2270 have the ``:align:`` option set, the surrounding ``<div>`` now
2271 receives a class attribute (like ``class="align-left"``).
2273 * docutils/writers/latex2e.py:
2275 - no newline after depart_term.
2276 - Added translations for some Unicode quotes.
2277 - Added option "font-encoding", made package AE the default.
2278 - "stylesheet" and "stylesheet_path" settings are now mutually
2280 - --footnote-references now overrides
2281 --trim-footnote-reference-space, if applicable.
2282 - The footnote label style now matches the footnote reference style
2283 ("brackets" or "superscript").
2284 - Added support for ``compound`` elements.
2285 - Enabled multiple format names for "raw" directive.
2287 * docs/ref/docutils.dtd:
2289 - Changed structure of the ``line_block`` element; added ``line``.
2290 - Added ``compound`` element.
2291 - Added "ltrim" and "rtrim" attributes to
2292 ``substitution_definition`` element.
2293 - Enabled multiple format names for ``raw`` element.
2294 - Enabled multiple classifiers in ``definition_list_item`` elements.
2296 * docs/ref/rst/directives.txt
2298 - Marked "line-block" as deprecated.
2299 - "Class" directive now allows multiple class names.
2300 - Added "Rationale for Class Attribute Value Conversion".
2301 - Added warning about "raw" overuse/abuse.
2303 * docs/ref/rst/restructuredtext.txt:
2305 - Added syntax for line blocks.
2306 - Definition list items may have multiple classifiers.
2308 * docs/ref/rst/roles.txt:
2312 * tools/stylesheets/default.css:
2314 - Added support for the new line_block structure.
2315 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2318 Release 0.3.5 (2004-07-29)
2319 ==========================
2323 * _`Documentation cleanup/reorganization`.
2325 - Created new subdirectories of docs/:
2327 * ``docs/user/``: introductory/tutorial material for end-users
2328 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2329 * ``docs/api/``: API reference material for client-developers
2330 * ``docs/ref/``: reference material for all groups
2331 * ``docs/howto/``: for component-developers and core-developers
2332 * ``docs/peps/``: Python Enhancement Proposals
2334 - Moved ``docs/*`` to ``docs/user/``.
2335 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2336 ``spec/`` to ``docs/dev``.
2337 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2338 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2339 - Moved ``alternatives.txt``, and ``problems.txt`` from
2340 ``spec/rst/`` to ``docs/dev/rst/``.
2341 - Moved ``reStructuredText.txt``, ``directives.txt``,
2342 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2343 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
2344 ``roles.txt``, ``reStructuredText.txt`` to
2345 ``restructuredtext.txt``.
2346 - Moved ``spec/howto/`` to ``docs/howto``.
2348 In order to keep the CVS history of moved files, we supplied
2349 SourceForge with a `script for modifying the Docutils CVS
2352 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
2354 After running the cleanup script:
2356 - Added ``docs/index.txt``.
2357 - Added a ``.htaccess`` file to the ``web`` module, containing
2358 redirects for all old paths to new paths. They'll preserve
2359 fragments (the "#name" part of a URL), and won't clutter up the
2360 file system, and will correct the URL in the user's browser.
2361 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2362 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2363 the "To Do" list itself in ``docs/dev/todo.txt``.
2364 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2365 section of ``docs/dev/todo.txt``.
2366 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2367 - Added "How To Report Bugs" to ``BUGS.txt``.
2368 - Went through all the sources and docs (including under web/) and
2369 updated links. Mostly done by Lea Wiemann; thanks Lea!
2370 (Still need to update links in the sandboxes.)
2374 * BUGS.txt: Added to project.
2376 * THANKS.txt: Added to project.
2378 * docutils/__init__.py:
2380 - 0.3.4: Post-release.
2384 - Added special error handling & advice for UnicodeEncodeError.
2385 - Refactored Publisher.publish (simplified exception handling &
2386 extracted debug dumps).
2387 - Renamed "enable_exit" parameter of convenience functions to
2388 "enable_exit_status".
2389 - Enabled traceback (exception propagation) by default in
2390 programmatic convenience functions.
2391 - Now publish_file and publish_cmdline convenience functions return
2392 the encoded string results in addition to their regular I/O.
2393 - Extracted common code from publish_file, publish_string, and
2394 publish_parts, into new publish_programmatically. Extracted
2395 settings code to ``Publisher.process_programmatic_settings``.
2396 - In Publisher.publish, disabled ``settings_overrides`` when
2397 ``settings`` is supplied; redundant.
2399 * docutils/frontend.py:
2401 - Added help text for "--output-encoding-error-handler" and
2402 "--error-encoding-error-handler".
2403 - Renamed "--exit" to "--exit-status".
2404 - Simplified default-setting code.
2406 * docutils/parsers/rst/__init__.py:
2408 - Added "--pep-base-url" and "--rfc-base-url" options.
2410 * docutils/parsers/rst/states.py:
2412 - Made URI recognition more aggressive and intelligent.
2414 * docutils/parsers/rst/directives/__init__.py:
2416 - Added several directive option conversion functions.
2418 * docutils/parsers/rst/directives/body.py:
2420 - Moved "table" directive to tables.py.
2422 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2425 * docutils/writers/latex2e.py:
2427 - Added "--table-style=(standard|booktabs|nolines)"
2428 - figures get "here" option (LaTeX per default puts them at bottom),
2429 and figure content is centered.
2430 - Rowspan support for tables.
2431 - Fix: admonition titles before first section.
2432 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2433 - Replave ``_`` in literal by an underlined blank, because it has the correct
2435 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2436 - A few unicode replacements, if output_encoding != utf
2437 - Add "--graphicx-option".
2438 - Indent literal-blocks.
2439 - Fix: omit ``\maketitle`` when there is no document title.
2441 * docs/index.txt: "Docutils Project Documentation Overview", added to
2444 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2445 Tool", added to project.
2447 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2449 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2451 * docs/dev/policies.txt: Added to project (extracted from
2452 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2454 * docs/dev/release.txt: Added to project (extracted from
2455 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2457 * docs/dev/testing.txt: Added to project.
2459 * docs/dev/website.txt: Added to project (extracted from
2460 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2462 * docs/ref/rst/directives.txt:
2464 - Added directives: "table", "csv-table".
2466 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2467 added to project. 1 page for syntax, and a 1 page reference for
2468 directives and roles. Source text to be used as-is; not meant to be
2471 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2472 with a change of title.
2474 * test/functional/, contents, and test/test_functional.py: Added to
2477 * tools/buildhtml.py: Fixed bug with config file handling.
2479 * tools/html.py: Removed from project (duplicate of rst2html.py).
2481 * tools/pep2html.py: Removed from project (duplicate of Python's
2482 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2483 Docutils-related PEPs in docs/peps/).
2485 * tools/rst2pseudoxml.py: Renamed from publish.py.
2487 * tools/rst2xml.py: Renamed from docutils-xml.py.
2489 * tools/test.txt: Removed from project; moved to
2490 docs/user/rst/demo.txt.
2492 * setup.py: Now also installs ``rst2latex.py``.
2495 Release 0.3.3 (2004-05-09)
2496 ==========================
2498 * docutils/__init__.py:
2500 - 0.3.1: Reorganized config file format (multiple sections); see
2502 - Added unknown_reference_resolvers attribute to TransformSpec.
2503 - 0.3.2: Interpreted text reorganization.
2508 - Catch system messages to stop tracebacks from parsing errors.
2509 - Catch exceptions during processing report & exit without
2510 tracebacks, except when "--traceback" used.
2511 - Reordered components for OptionParser; application comes last.
2512 - Added "config_section" parameter to several methods and functions,
2513 allowing front ends to easily specify their config file sections.
2514 - Added publish_parts convenience function to allow access to individual
2515 parts of a document.
2517 * docutils/examples.py: Added to project; practical examples of
2518 Docutils client code, to be used as-is or as models for variations.
2520 * docutils/frontend.py:
2522 - Added "--traceback" & "--no-traceback" options ("traceback"
2524 - Implemented support for config file reorganization:
2525 ``standard_config_files`` moved from ``ConfigParser`` to
2526 ``OptionParser``; added
2527 ``OptionParser.get_config_file_settings()`` and
2528 ``.get_standard_config_settings()``; support for old "[options]"
2529 section (with deprecation warning) and mapping from old to new
2531 - Reimplemented setting validation.
2532 - Enabled flexible boolean values: yes/no, true/false, on/off.
2533 - Added ``Values``, a subclass of ``optparse.Values``, with support
2534 for list setting attributes.
2535 - Added support for new ``DOCUTILSCONFIG`` environment variable;
2536 thanks to Beni Cherniavsky.
2537 - Added "--no-section-numbering" option.
2541 - Catch IOErrors when opening source & destination files, report &
2542 exit without tracebacks. Added ``handle_io_errors`` parameter to
2543 ``FileInput`` & ``FileOutput`` to enable caller error handling.
2545 * docutils/nodes.py:
2547 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
2548 method definitions (via ``exec``) to dynamic assignments (via
2549 ``setattr``); thanks to Roman Suzi.
2550 - Encapsulated visitor dynamic assignments in a function; thanks to
2552 - Added indirect_reference_name attribute to the Targetable
2553 class. This attribute holds the whitespace_normalized_name
2554 (contains mixed case) of a target.
2556 * docutils/statemachine.py:
2558 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
2559 - Added ``StringList.get_2D_block``.
2561 * docutils/utils.py:
2563 - Added "level" attribute to SystemMessage exceptions.
2565 * docutils/languages/af.py: Added to project; Afrikaans mappings by
2568 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
2571 * docutils/languages/eo.py: Added to project; Esperanto mappings by
2572 Marcelo Huerta San Martin.
2574 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
2575 mappings by Lalo Martins.
2577 * docutils/languages/ru.py: Added to project; Russian mappings by
2580 * docutils/parsers/rst/roles.py: Added to project. Contains
2581 interpreted text role functions, a registry for interpreted text
2582 roles, and an API for adding to and retrieving from the registry.
2583 Contributed by Edward Loper.
2585 * docutils/parsers/rst/states.py:
2587 - Updated ``RSTState.nested_parse`` for "include" in table cells.
2588 - Allowed true em-dash character and "---" as block quote
2590 - Added support for <angle-bracketed> complex option arguments
2592 - Fixed handling of backslashes in substitution definitions.
2593 - Fixed off-by-1 error with extra whitespace after substitution
2594 definition directive.
2595 - Added inline markup parsing to field lists' field names.
2596 - Added support for quoted (and unindented) literal blocks.
2597 Driven in part by a bribe from Frank Siebenlist (thanks!).
2598 - Parser now handles escapes in URIs correctly.
2599 - Made embedded-URIs' reference text omittable. Idea from Beni
2601 - Refactored explicit target processing code.
2602 - Added name attribute to references containing the reference name only
2603 through whitespace_normalize_name (no case changes).
2604 - parse_target no longer returns the refname after going through
2605 normalize_name. This is now handled in make_target.
2606 - Fixed bug relating to role-less interpreted text in non-English
2608 - Reorganized interpreted text processing; moved code into the new
2609 roles.py module. Contributed by Edward Loper.
2610 - Refactored ``Body.parse_directive`` into ``run_directive`` and
2611 ``parse_directive_block``.
2613 * docutils/parsers/rst/tableparser.py:
2615 - Reworked for ``StringList``, to support "include" directives in
2618 * docutils/parsers/rst/directives/__init__.py:
2620 - Renamed ``unchanged()`` directive option conversion function to
2621 ``unchanged_required``, and added a new ``unchanged``.
2622 - Catch unicode value too high error; fixes bug 781766.
2623 - Beefed up directive error reporting.
2625 * docutils/parsers/rst/directives/body.py:
2627 - Added basic "table" directive.
2629 * docutils/parsers/rst/directives/images.py:
2631 - Added "target" option to "image" directive.
2632 - Added name attribute to references containing the reference name only
2633 through whitespace_normalize_name (no case changes).
2635 * docutils/parsers/rst/directives/misc.py:
2637 - Isolated the import of the ``urllib2`` module; was causing
2638 problems on SourceForge (``libssl.so.2`` unavailable?).
2639 - Added the "role" directive for declaring custom interpreted text
2642 * docutils/parsers/rst/directives/parts.py:
2644 - The "contents" directive does more work up-front, creating the
2645 "topic" and "title", and leaving the "pending" node for the
2646 transform. Allows earlier reference resolution; fixes subtle bug.
2648 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
2649 mappings by Jannie Hofmeyr.
2651 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
2652 mappings by Marek Blaha.
2654 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
2655 mappings by Marcelo Huerta San Martin.
2657 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2658 Portuguese mappings by Lalo Martins.
2660 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2661 mappings by Roman Suzi.
2663 * docutils/transforms/parts.py:
2665 - The "contents" directive does more work up-front, creating the
2666 "topic" and "title", and leaving the "pending" node for the
2667 transform. Allows earlier reference resolution; fixes subtle bug.
2668 - Added support for disabling of section numbering.
2670 * docutils/transforms/references.py:
2672 - Verifying that external targets are truly targets and not indirect
2673 references. This is because we are now adding a "name" attribute to
2674 references in addition to targets. Note sure if this is correct!
2675 - Added code to hook into the unknown_reference_resolvers list for a
2676 transformer in resolve_indirect_target. This allows the
2677 unknown_reference_resolvers to keep around indirect targets which
2678 docutils doesn't know about.
2679 - Added specific error message for duplicate targets.
2681 * docutils/transforms/universal.py:
2683 - Added FilterMessages transform (removes system messages below the
2684 verbosity threshold).
2685 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2686 to FinalCheckVisitor for application-specific handling of
2687 unresolvable references.
2688 - Added specific error message for duplicate targets.
2690 * docutils/writers/__init__.py:
2692 - Added assemble_parts method to the Writer class to allow for
2693 access to a documents individual parts.
2694 - Documented & set default for ``Writer.output`` attribute.
2696 * docutils/writers/html4css1.py:
2698 - Fixed unicode handling of attribute values (bug 760673).
2699 - Prevent duplication of "class" attribute values (bug report from
2701 - Improved table grid/border handling (prompted by report from Bob
2703 - Added support for table titles.
2704 - Added "<title />" for untitled docs, for XHTML conformance; thanks
2706 - Added functionality to keep track of individual parts of a document
2707 and store them in a dictionary as the "parts" attribute of the writer.
2708 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2709 - Added proper support for the "scale" attribute of the "image"
2710 element. Contributed by Brent Cook.
2711 - Added ``--initial-header-level`` option.
2712 - Fixed bug: the body_pre_docinfo segment depended on there being a
2713 docinfo; if no docinfo, the document title was incorporated into
2714 the body segment. Adversely affected the publish_parts interface.
2716 * docutils/writers/latex2e.py:
2718 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2719 about a missing file.
2720 - Added options and support: ``--compound-enumerators``,
2721 ``--section-prefix-for-enumerators``, and
2722 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
2724 - Added option ``--use-verbatim-when-possible``, to avoid
2725 problematic characters (eg, '~' in italian) in literal blocks.
2726 - It's now possible to use four section levels in the `book` and
2727 `report` LaTeX classes. The default `article` class still has
2730 * docs/config.txt: "Docutils Configuration Files", added to project.
2731 Moved config file entry descriptions from tools.txt.
2735 - Moved config file entry descriptions to config.txt.
2737 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
2740 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2741 Text Roles", added to project.
2743 * spec/rst/reStructuredText.txt:
2745 - Added description of support for <angle-bracketed> complex option
2746 arguments to option lists.
2747 - Added subsections for indented and quoted literal blocks.
2749 * test: Continually adding & updating tests.
2751 - Added test/test_settings.py & test/data/config_*.txt support
2753 - Added test/test_writers/test_htmlfragment.py.
2755 * test/DocutilsTestSupport.py:
2757 - Refactored LaTeX publisher test suite/case class names to make
2758 testing other writers easier.
2759 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2760 to test the processing of HTML fragments which use the new
2761 publish_parts convenience function.
2763 * tools/buildhtml.py:
2765 - Added support for the "--prune" option.
2766 - Removed dependency on pep2html.py; plaintext PEPs no longer
2769 * tools/docutils.conf:
2771 - Updated for configuration file reorganization.
2773 * tools/rst2html.py:
2775 - copied from tools/html.py
2779 - added a 'scripts' section to configuration
2780 - added 'tools/rst2html.py' to the scripts section
2783 Release 0.3 (2003-06-24)
2784 ========================
2788 * Renamed "attribute" to "option" for directives/extensions.
2790 * Renamed transform method "transform" to "apply".
2792 * Renamed "options" to "settings" for runtime settings (as set by
2793 command-line options). Sometimes "option" (singular) became
2794 "settings" (plural). Some variations below:
2796 - document.options -> document.settings (stored in other objects as
2798 - option_spec -> settings_spec (not directives though)
2799 - OptionSpec -> SettingsSpec
2800 - cmdline_options -> settings_spec
2801 - relative_path_options -> relative_path_settings
2802 - option_default_overrides -> settings_default_overrides
2803 - Publisher.set_options -> Publisher.get_settings
2807 * COPYING.txt: Added "Public Domain Dedication".
2809 * FAQ.txt: Frequently asked questions, added to project.
2813 - Updated with PyPI Trove classifiers.
2814 - Conditional installation of third-party modules.
2816 * docutils/__init__.py:
2818 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2819 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2820 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2821 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2822 option and its effect on the PEP template & writer.
2823 - Bumped version to 0.2.4 due to changes to the PEP template &
2825 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2826 - Added ``TransformSpec`` class for new transform system.
2827 - Bumped version to 0.2.6 for API changes (renaming).
2828 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2829 convenience functions.
2830 - Added ``Component.component_type`` attribute.
2831 - Bumped version to 0.2.8 because of the internal parser switch from
2832 plain lists to the docutils.statemachine.StringList objects.
2833 - Bumped version to 0.2.9 because of the frontend.py API changes.
2834 - Bumped version to 0.2.10 due to changes to the project layout
2835 (third-party modules removed from the "docutils" package), and
2836 signature changes in ``io.Input``/``io.Output``.
2837 - Changed version to 0.3.0 for release.
2841 - Made ``publish()`` a bit more convenient.
2842 - Generalized ``Publisher.set_io``.
2843 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2844 parameters; improved its docstring.
2845 - Added ``publish_file()`` and ``publish_string()``.
2846 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2848 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2849 "--dump-transforms" hidden options.
2850 - Added ``Publisher.apply_transforms()`` method.
2851 - Added ``Publisher.set_components()`` method; support for
2852 ``publish_*()`` conveninece functions.
2853 - Moved config file processing to docutils/frontend.py.
2854 - Added support for exit status ("exit_level" setting &
2855 ``enable_exit`` parameter for Publisher.publish() and convenience
2858 * docutils/frontend.py:
2860 - Check for & exit on identical source & destination paths.
2861 - Fixed bug with absolute paths & "--config".
2862 - Set non-command-line defaults in ``OptionParser.__init__()``:
2863 ``_source`` & ``_destination``.
2864 - Distributed ``relative_path_settings`` to components; updated
2865 ``OptionParser.populate_from_components()`` to combine it all.
2866 - Require list of keys in ``make_paths_absolute`` (was implicit in
2867 global ``relative_path_settings``).
2868 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2869 "--dump-settings", and "--dump-transforms" hidden options.
2870 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2871 code, replaced with correct code.
2872 - Added validation functionality for config files.
2873 - Added "--error-encoding" option/setting, "_disable_config"
2875 - Added encoding validation; updated "--input-encoding" and
2876 "--output-encoding"; added "--error-encoding-error-handler" and
2877 "--output-encoding-error-handler".
2878 - Moved config file processing from docutils/core.py.
2879 - Updated ``OptionParser.populate_from_components`` to handle new
2880 ``SettingsSpec.settings_defaults`` dict.
2881 - Added support for "-" => stdin/stdout.
2882 - Added "exit_level" setting ("--exit" option).
2886 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2887 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2888 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2889 - ``FileOutput.write()`` now returns the encoded output string.
2890 - Try to get path/stream name automatically in ``FileInput`` &
2892 - Added defaults for source & destination paths.
2893 - Allow for Unicode I/O with an explicit "unicode" encoding.
2894 - Added ``Output.encode()``.
2895 - Removed dependency on runtime settings; pass encoding directly.
2896 - Recognize Unicode strings in ``Input.decode()``.
2897 - Added support for output encoding error handlers.
2899 * docutils/nodes.py:
2901 - Added "Invisible" element category class.
2902 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2903 modification during a traversal.
2904 - Added element classes: ``line_block``, ``generated``, ``address``,
2905 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2906 ``superscript``, ``subscript``, ``inline``
2907 - Added support for lists of nodes to ``Element.insert()``.
2908 - Fixed parent linking in ``Element.replace()``.
2909 - Added new abstract superclass ``FixedTextElement``; adds
2910 "xml:space" attribute.
2911 - Added support for "line" attribute of ``system_message`` nodes.
2912 - Added support for the observer pattern from ``utils.Reporter``.
2913 Added ``parse_messages`` and ``transform_messages`` attributes to
2914 ``document``, removed ``messages``. Added ``note_parse_message``
2915 and ``note_transform_message`` methods.
2916 - Added support for improved diagnostics:
2918 - Added "document", "source", and "line" internal attributes to
2919 ``Node``, set by ``Node.setup_child()``.
2920 - Converted variations on ``node.parent = self`` to
2921 ``self.setup_child(node)``.
2922 - Added ``document.current_source`` & ``.current_line``
2923 attributes, and ``.note_source`` observer method.
2924 - Changed "system_message" output to GNU-Tools format.
2926 - Added a "rawsource" attribute to the ``Text`` class, for text
2927 before backslash-escape resolution.
2928 - Support for new transform system.
2929 - Reworked ``pending`` element.
2930 - Fixed XML DOM bug (SF #660611).
2931 - Removed the ``interpeted`` element class and added
2932 ``title_reference``, ``abbreviation``, ``acronym``.
2933 - Made substitutions case-sensitive-but-forgiving; moved some code
2935 - Fixed Unicode bug on element attributes (report: William Dode).
2937 * docutils/optik.py: Removed from project; replaced with
2938 extras/optparse.py and extras/textwrap.py. These will be installed
2939 only if they're not already present in the Python installation.
2941 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2942 only if it's not already present in the Python installation.
2944 * docutils/statemachine.py:
2946 - Factored out ``State.add_initial_transitions()`` so it can be
2948 - Converted whitespace-specific "blank" and "indent" transitions
2949 from special-case code to ordinary transitions: removed
2950 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2951 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2952 ``ws_initial_transitions`` attributes.
2953 - Removed ``State.match_transition()`` after merging it into
2955 - Added ``StateCorrection`` exception.
2956 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2957 (moved ``TransitionCorrection`` support there too.)
2958 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2959 ``EOFError`` instead of ``IndexError``.
2960 - Added ``State.no_match`` method.
2961 - Added support for the Observer pattern, triggered by input line
2963 - Added ``strip_top`` parameter to
2964 ``StateMachineWS.get_first_known_indented``.
2965 - Made ``context`` a parameter to ``StateMachine.run()``.
2966 - Added ``ViewList`` & ``StringList`` classes;
2967 ``extract_indented()`` becomes ``StringList.get_indented()``.
2968 - Added ``StateMachine.insert_input()``.
2969 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2970 thanks to) Fred Drake.
2972 * docutils/utils.py:
2974 - Added a ``source`` attribute to Reporter instances and
2975 ``system_message`` elements.
2976 - Added an observer pattern to ``utils.Reporter`` to keep track of
2978 - Fixed bugs in ``relative_path()``.
2979 - Added support for improved diagnostics.
2980 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2981 - Added support for encoding Reporter stderr output, and encoding
2983 - Reporter keeps track of the highest level system message yet
2986 * docutils/languages: Fixed bibliographic field language lookups.
2988 * docutils/languages/es.py: Added to project; Spanish mappings by
2989 Marcelo Huerta San Martin.
2991 * docutils/languages/fr.py: Added to project; French mappings by
2994 * docutils/languages/it.py: Added to project; Italian mappings by
2997 * docutils/languages/sk.py: Added to project; Slovak mappings by
3000 * docutils/parser/__init__.py:
3002 - Added ``Parser.finish_parse()`` method.
3004 * docutils/parser/rst/__init__.py:
3006 - Added options: "--pep-references", "--rfc-references",
3007 "--tab-width", "--trim-footnote-reference-space".
3009 * docutils/parsers/rst/states.py:
3011 - Changed "title under/overline too short" system messages from INFO
3012 to WARNING, and fixed its insertion location.
3013 - Fixed enumerated list item parsing to allow paragraphs & section
3014 titles to begin with enumerators.
3015 - Converted system messages to use the new "line" attribute.
3016 - Fixed a substitution reference edge case.
3017 - Added support for "--pep-references" and "--rfc-references"
3018 options; reworked ``Inliner`` code to make customization easier.
3019 - Removed field argument parsing.
3020 - Added support for short section title over/underlines.
3021 - Fixed "simple reference name" regexp to ignore text like
3022 "object.__method__"; not an anonymous reference.
3023 - Added support for improved diagnostics.
3024 - Reworked directive API, based on Dethe Elza's contribution. Added
3025 ``Body.parse_directive()``, ``.parse_directive_options()``,
3026 ``.parse_directive_arguments()`` methods.
3027 - Added ``ExtensionOptions`` class, to parse directive options
3028 without parsing field bodies. Factored
3029 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
3030 ``ExtensionOptions``.
3031 - Improved definition list term/classifier parsing.
3032 - Added warnings for unknown directives.
3033 - Renamed ``Stuff`` to ``Struct``.
3034 - Now flagged as errors: transitions at the beginning or end of
3035 sections, empty sections (except title), and empty documents.
3036 - Updated for ``statemachine.StringList``.
3037 - Enabled recognition of schemeless email addresses in targets.
3038 - Added support for embedded URIs in hyperlink references.
3039 - Added backslash-escapes to inline markup end-string suffix.
3040 - Added support for correct interpreted text processing.
3041 - Fixed nested title parsing (topic, sidebar directives).
3042 - Added special processing of backslash-escaped whitespace (idea
3043 from David Abrahams).
3044 - Made substitutions case-sensitive-but-forgiving; moved some code
3045 to ``docutils.nodes``.
3046 - Added support for block quote attributions.
3047 - Added a kludge to work-around a conflict between the bubble-up
3048 parser strategy and short titles (<= 3 char-long over- &
3049 underlines). Fixes SF bug #738803 "infinite loop with multiple
3050 titles" submitted by Jason Diamond.
3051 - Added explicit interpreted text roles for standard inline markup:
3052 "emphasis", "strong", "literal".
3053 - Implemented "superscript" and "subscript" interpreted text roles.
3054 - Added initial support for "abbreviation" and "acronym" roles;
3056 - Added support for "--trim-footnote-reference-space" option.
3057 - Optional space before colons in directives & hyperlink targets.
3059 * docutils/parsers/rst/tableparser.py:
3061 - Fixed a bug that was producing unwanted empty rows in "simple"
3063 - Detect bad column spans in "simple" tables.
3065 * docutils/parsers/rst/directives: Updated all directive functions to
3068 * docutils/parsers/rst/directives/__init__.py:
3070 - Added ``flag()``, ``unchanged()``, ``path()``,
3071 ``nonnegative_int()``, ``choice()``, and ``class_option()``
3072 directive option helper functions.
3073 - Added warnings for unknown directives.
3074 - Return ``None`` for missing directives.
3075 - Added ``register_directive()``, thanks to William Dode and Paul
3078 * docutils/parsers/rst/directives/admonitions.py:
3080 - Added "admonition" directive.
3082 * docutils/parsers/rst/directives/body.py: Added to project. Contains
3083 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
3084 "parsed-literal", "rubric", "epigraph", "highlights" and
3085 "pull-quote" directives.
3087 * docutils/parsers/rst/directives/images.py:
3089 - Added an "align" attribute to the "image" & "figure" directives
3090 (by Adam Chodorowski).
3091 - Added "class" option to "image", and "figclass" to "figure".
3093 * docutils/parsers/rst/directives/misc.py:
3095 - Added "include", "raw", and "replace" directives, courtesy of
3097 - Added "unicode" and "class" directives.
3099 * docutils/parsers/rst/directives/parts.py:
3101 - Added the "sectnum" directive; by Dmitry Jemerov.
3102 - Added "class" option to "contents" directive.
3104 * docutils/parsers/rst/directives/references.py: Added to project.
3105 Contains the "target-notes" directive.
3107 * docutils/parsers/rst/languages/__init__.py:
3109 - Return ``None`` from get_language() for missing language modules.
3111 * docutils/parsers/rst/languages/de.py: Added to project; German
3112 mappings by Engelbert Gruber.
3114 * docutils/parsers/rst/languages/en.py:
3116 - Added interpreted text roles mapping.
3118 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
3119 mappings by Marcelo Huerta San Martin.
3121 * docutils/parsers/rst/languages/fr.py: Added to project; French
3122 mappings by William Dode.
3124 * docutils/parsers/rst/languages/it.py: Added to project; Italian
3125 mappings by Nicola Larosa.
3127 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
3128 mappings by Miroslav Vasko.
3130 * docutils/readers/__init__.py:
3132 - Added support for the observer pattern from ``utils.Reporter``, in
3133 ``Reader.parse`` and ``Reader.transform``.
3134 - Removed ``Reader.transform()`` method.
3135 - Added default parameter values to ``Reader.__init__()`` to make
3136 instantiation easier.
3137 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
3139 * docutils/readers/pep.py:
3141 - Added the ``peps.TargetNotes`` transform to the Reader.
3142 - Removed PEP & RFC reference detection code; moved to
3143 parsers/rst/states.py as options (enabled here by default).
3144 - Added support for pre-acceptance PEPs (no PEP number yet).
3145 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
3148 * docutils/readers/python: Python Source Reader subpackage added to
3149 project, including preliminary versions of:
3152 - moduleparser.py: Parser for Python modules.
3154 * docutils/transforms/__init__.py:
3156 - Added ``Transformer`` class and completed transform reform.
3157 - Added unknown_reference_resolvers list for each transformer. This list holds
3158 the list of functions provided by each component of the transformer that
3159 help resolve references.
3161 * docutils/transforms/frontmatter.py:
3163 - Improved support for generic fields.
3164 - Fixed bibliographic field language lookups.
3166 * docutils/transforms/misc.py: Added to project. Miscellaneous
3169 * docutils/transforms/parts.py:
3171 - Moved the "id" attribute from TOC list items to the references
3172 (``Contents.build_contents()``).
3173 - Added the ``SectNum`` transform; by Dmitry Jemerov.
3174 - Added "class" attribute support to ``Contents``.
3176 * docutils/transforms/peps.py:
3178 - Added ``mask_email()`` function, updating to pep2html.py's
3180 - Linked "Content-Type: text/x-rst" to PEP 12.
3181 - Added the ``TargetNotes`` PEP-specific transform.
3182 - Added ``TargetNotes.cleanup_callback``.
3183 - Added title check to ``Headers``.
3185 * docutils/transforms/references.py:
3187 - Added the ``TargetNotes`` generic transform.
3188 - Split ``Hyperlinks`` into multiple transforms.
3189 - Fixed bug with multiply-indirect references (report: Bruce Smith).
3190 - Added check for circular indirect references.
3191 - Made substitutions case-sensitive-but-forgiving.
3193 * docutils/transforms/universal.py:
3195 - Added support for the "--expose-internal-attributes" option.
3196 - Removed ``Pending`` transform classes & data.
3198 * docutils/writers/__init__.py:
3200 - Removed ``Writer.transform()`` method.
3202 * docutils/writers/docutils-xml.py:
3204 - Added XML and doctype declarations.
3205 - Added "--no-doctype" and "--no-xml-declaration" options.
3207 * docutils/writers/html4css1.py:
3209 - "name" attributes only on these tags: a, applet, form, frame,
3211 - Added "name" attribute to <a> in section titles for Netscape 4
3212 support (bug report: Pearu Peterson).
3213 - Fixed targets (names) on footnote, citation, topic title,
3214 problematic, and system_message nodes (for Netscape 4).
3215 - Changed field names from "<td>" to "<th>".
3216 - Added "@" to "@" encoding to thwart address harvesters.
3217 - Improved the vertical whitespace optimization; ignore "invisible"
3218 nodes (targets, comments, etc.).
3219 - Improved inline literals with ``<span class="pre">`` around chunks
3220 of text and `` `` for runs of spaces.
3221 - Improved modularity of output; added ``self.body_pre_docinfo`` and
3222 ``self.docinfo`` segments.
3223 - Added support for "line_block", "address" elements.
3224 - Improved backlinks (footnotes & system_messages).
3225 - Improved system_message output.
3226 - Redefined "--stylesheet" as containing an invariant URL, used
3227 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
3229 - Added "--footnote-references" option (superscript or brackets).
3230 - Added "--compact-lists" and "--no-compact-lists" options.
3231 - Added "--embed-stylesheet" and "--link-stylesheet" options;
3232 factored out ``HTMLTranslator.get_stylesheet_reference()``.
3233 - Improved field list rendering.
3234 - Added Docutils version to "generator" meta tag.
3235 - Fixed a bug with images; they must be inline, so wrapped in <p>.
3236 - Improved layout of <pre> HTML source.
3237 - Fixed attribute typo on <colspec>.
3238 - Refined XML prologue.
3239 - Support for no stylesheet.
3240 - Removed "interpreted" element support.
3241 - Added support for "title_reference", "sidebar", "attribution",
3242 "rubric", and generic "admonition" elements.
3243 - Added "--attribution" option.
3244 - Added support for "inline", "subscript", "superscript" elements.
3245 - Added initial support for "abbreviation" and "acronym";
3248 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3252 - Double quotes in literal blocks (special treatment for de/ngerman).
3253 - Added '--hyperlink-color' option ('0' turns off coloring of links).
3254 - Added "--attribution" option.
3255 - Right align attributions.
3257 * docutils/writers/pep_html.py:
3259 - Parameterized output encoding in PEP template.
3260 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3261 - Redefined "--pep-stylesheet" as containing an invariant URL, used
3262 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
3264 - Added an override on the "--footnote-references" option.
3265 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3266 - Added Docutils version to "generator" meta tag.
3267 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3271 - Added a "silent" setting for ``buildhtml.py``.
3272 - Added a "Getting Help" section.
3273 - Rearranged the structure.
3274 - Kept up to date, with new settings, command-line options etc.
3275 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3276 - Converted settings table into a definition list.
3278 * docs/rst/quickstart.txt:
3280 - Added a table of contents.
3281 - Added feedback information.
3282 - Added mention of minimum section title underline lengths.
3283 - Removed the 4-character minimum for section title underlines.
3285 * docs/rst/quickref.html:
3287 - Added a "Getting Help" section.
3288 - Added a style to make section title backlinks more subtle.
3289 - Added mention of minimum section title underline lengths.
3290 - Removed the 4-character minimum for section title underlines.
3292 * extras: Directory added to project; contains third-party modules
3293 that Docutils depends on (optparse, textwrap, roman). These are
3294 only installed if they're not already present.
3296 * licenses: Directory added to project; contains copies of license
3297 files for non-public-domain files.
3301 - Changed the focus. It's about DTD elements: structural
3302 relationships, semantics, and external (public) attributes. Not
3303 about the element class library.
3304 - Moved some implementation-specific stuff into ``docutils.nodes``
3306 - Wrote descriptions of all common attributes and parameter
3307 entities. Filled in introductory material.
3308 - Working through the element descriptions: 55 down, 37 to go.
3309 - Removed "Representation of Horizontal Rules" to
3310 spec/rst/alternatives.txt.
3312 * spec/docutils.dtd:
3314 - Added "generated" inline element.
3315 - Added "line_block" body element.
3316 - Added "auto" attribute to "title".
3317 - Changed content models of "literal_block" and "doctest_block" to
3319 - Added ``%number;`` attribute type parameter entity.
3320 - Changed ``%structural.elements;`` to ``%section.elements``.
3321 - Updated attribute types; made more specific.
3322 - Added "address" bibliographic element.
3323 - Added "line" attribute to ``system_message`` element.
3324 - Removed "field_argument" element; "field_name" may contain
3325 multiple words and whitespace.
3326 - Changed public identifier to docutils.sf.net.
3327 - Removed "interpreted" element; added "title_reference",
3328 "abbreviation", "acronym".
3329 - Removed "refuri" attribute from "footnote_reference" and
3330 "citation_reference".
3331 - Added "sidebar", "rubric", "attribution", "admonition",
3332 "superscript", "subscript", and "inline" elements.
3334 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3336 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3338 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3340 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3343 * spec/transforms.txt: Added to project.
3345 * spec/howto: Added subdirectory, for developer how-to docs.
3347 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
3348 Elza, edited & extended by David Goodger.
3350 * spec/howto/i18n.txt: Docutils Internationalization. Added to
3353 * spec/rst/alternatives.txt:
3355 - Added "Doctree Representation of Transitions" from
3357 - Updated "Inline External Targets" & closed the debate.
3358 - Added ideas for interpreted text syntax extensions.
3359 - Added "Nested Inline Markup" section.
3361 * spec/rst/directives.txt:
3363 - Added directives: "topic", "sectnum", "target-notes",
3364 "line-block", "parsed-literal", "include", "replace", "sidebar",
3365 "admonition", "rubric", "epigraph", "highlights", "unicode" and
3367 - Formalized descriptions of directive details.
3368 - Added an "align" attribute to the "image" & "figure" directives
3369 (by Adam Chodorowski).
3370 - Added "class" options to "topic", "sidebar", "line-block",
3371 "parsed-literal", "contents", and "image"; and "figclass" to
3374 * spec/rst/interpreted.txt: Added to project. Descriptions of
3375 interpreted text roles.
3377 * spec/rst/introduction.txt:
3379 - Added pointers to material for new users.
3381 * spec/rst/reStructuredText.txt:
3383 - Disambiguated comments (just add a newline after the "::").
3384 - Updated enumerated list description; added a discussion of the
3385 second-line validity checking.
3386 - Updated directive description.
3387 - Added a note redirecting newbies to the user docs.
3388 - Expanded description of inline markup start-strings in non-markup
3390 - Removed field arguments and made field lists a generic construct.
3391 - Removed the 4-character minimum for section title underlines.
3392 - Clarified term/classifier delimiter & inline markup ambiguity
3394 - Added "Embedded URIs".
3395 - Updated "Interpreted Text" section.
3396 - Added "Character-Level Inline Markup" section.
3398 * test: Continually adding & updating tests.
3400 - Moved test/test_rst/ to test/test_parsers/test_rst/.
3401 - Moved test/test_pep/ to test/test_readers/test_pep/.
3402 - Added test/test_readers/test_python/.
3403 - Added test/test_writers/ (Engelbert Gruber).
3407 - Made the ``locale.setlocale()`` calls in front ends
3410 * tools/buildhtml.py:
3412 - Added "--silent" option.
3413 - Fixed bug with absolute paths & "--config".
3414 - Updated for new I/O classes.
3415 - Added some exception handling.
3416 - Separated publishers' setting defaults; prevents interference.
3417 - Updated for new ``publish_file()`` convenience function.
3419 * tools/pep-html-template:
3421 - Allow for "--embed-stylesheet".
3422 - Added Docutils version to "generator" meta tag.
3423 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3424 - Conform to XHTML spec.
3426 * tools/pep2html.py:
3428 - Made ``argv`` a parameter to ``main()``.
3429 - Added support for "Content-Type:" header & arbitrary PEP formats.
3430 - Linked "Content-Type: text/plain" to PEP 9.
3431 - Files skipped (due to an error) are not pushed onto the server.
3432 - Updated for new I/O classes.
3433 - Added ``check_requirements()`` & ``pep_type_error()``.
3434 - Added some exception handling.
3435 - Updated for new ``publish_string()`` convenience function.
3436 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3438 * tools/quicktest.py:
3440 - Added "-V"/"--version" option.
3442 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3444 * tools/unicode2rstsubs.py: Added to project. Produces character
3445 entity files (reSructuredText substitutions) from the MathML master
3448 * tools/editors: Support code for editors, added to project. Contains
3449 ``emacs/restructuredtext.el``.
3451 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3453 - Added style for chunks of inline literals.
3454 - Removed margin for first child of table cells.
3455 - Right-aligned field list names.
3456 - Support for auto-numbered section titles in TOCs.
3457 - Increased the size of inline literals (<tt>) in titles.
3458 - Restored the light gray background for inline literals.
3459 - Added support for "line_block" elements.
3460 - Added style for "address" elements.
3461 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3462 - Improved field list rendering.
3463 - Vertical whitespace improvements.
3464 - Removed "a.target" style.
3466 * tools/stylesheets/pep.css:
3468 - Fixed nested section margins.
3469 - Other changes parallel those of ``../default.css``.
3472 Release 0.2 (2002-07-31)
3473 ========================
3477 - The word "component" was being used ambiguously. From now on,
3478 "component" will be used to mean "Docutils component", as in Reader,
3479 Writer, Parser, or Transform. Portions of documents (Table of
3480 Contents, sections, etc.) will be called "document parts".
3481 - Did a grand renaming: a lot of ``verylongnames`` became
3482 ``very_long_names``.
3483 - Cleaned up imports: no more relative package imports or
3484 comma-separated lists of top-level modules.
3485 - Added support for an option values object which carries default
3486 settings and overrides (from command-line options and library use).
3487 - Added internal Unicode support, and support for both input and
3489 - Added support for the ``docutils.io.IO`` class & subclasses.
3493 * docutils/__init__.py:
3495 - Added ``ApplicationError`` and ``DataError``, for use throughout
3497 - Added ``Component`` base class for Docutils components; implements
3498 the ``supports`` method.
3499 - Added ``__version__`` (thus, ``docutils.__version__``).
3503 - Removed many keyword parameters to ``Publisher.__init__()`` and
3504 ``publish()``; bundled into an option values object. Added
3505 "argv", "usage", "description", and "option_spec" parameters for
3506 command-line support.
3507 - Added ``Publisher.process_command_line()`` and ``.set_options()``
3509 - Reworked I/O model for ``docutils.io`` wrappers.
3510 - Updated ``Publisher.set_options()``; now returns option values
3512 - Added support for configuration files (/etc/docutils.conf,
3513 ./docutils.conf, ~/.docutils).
3514 - Added ``Publisher.setup_option_parser()``.
3515 - Added default usage message and description.
3517 * docutils/frontend.py: Added to project; support for front-end
3518 (command-line) scripts. Option specifications may be augmented by
3519 components. Requires Optik (http://optik.sf.net/) for option
3520 processing (installed locally as docutils/optik.py).
3522 * docutils/io.py: Added to project; uniform API for a variety of input
3525 * docutils/nodes.py:
3527 - Added ``TreeCopyVisitor`` class.
3528 - Added a ``copy`` method to ``Node`` and subclasses.
3529 - Added a ``SkipDeparture`` exception for visitors.
3530 - Renamed ``TreePruningException`` from ``VisitorException``.
3531 - Added docstrings to ``TreePruningException``, subclasses, and
3533 - Improved docstrings.
3534 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
3535 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
3537 - Added ``decoration``, ``header``, and ``footer`` node classes, and
3538 ``PreDecorative`` mixin.
3539 - Reworked the name/id bookkeeping; to ``document``, removed
3540 ``explicit_targets`` and ``implicit_targets`` attributes, added
3541 ``nametypes`` attribute and ``set_name_id_map`` method.
3542 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
3544 - Added ``document.has_name()`` method.
3545 - Fixed DOM generation for list-attributes.
3546 - Added category class ``Labeled`` (used by footnotes & citations).
3547 - Added ``Element.set_class()`` method (sets "class" attribute).
3549 * docutils/optik.py: Added to project. Combined from the Optik
3550 package, with added option groups and other modifications. The use
3551 of this module is probably only temporary.
3553 * docutils/statemachine.py:
3555 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
3556 - Added underscores to improve many awkward names.
3557 - In ``string2lines()``, changed whitespace normalizing translation
3558 table to regexp; restores Python 2.0 compatibility with Unicode.
3560 * docutils/urischemes.py:
3562 - Filled in some descriptions.
3563 - Added "shttp" scheme.
3565 * docutils/utils.py:
3567 - Added ``clean_rcs_keywords`` function (moved from
3568 docutils/transforms/frontmatter.py
3569 ``DocInfo.filter_rcs_keywords``).
3570 - Added underscores to improve many awkward names.
3571 - Changed names of Reporter's thresholds:
3572 warning_level -> report_level; error_level -> halt_level.
3573 - Moved ``utils.id()`` to ``nodes.make_id()``.
3574 - Added ``relative_path(source, target)``.
3576 * docutils/languages/de.py: German mappings; added to project. Thanks
3577 to Gunnar Schwant for the translations.
3579 * docutils/languages/en.py: Added "Dedication" bibliographic field
3582 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
3585 * docutils/parsers/rst/states.py:
3587 - Added underscores to improve many awkward names.
3588 - Added RFC-2822 header support.
3589 - Extracted the inline parsing code from ``RSTState`` to a separate
3590 class, ``Inliner``, which will allow easy subclassing.
3591 - Made local bindings for ``memo`` container & often-used contents
3592 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
3593 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
3594 - Added ``MarkupMismatch`` exception; for late corrections.
3595 - Added ``-/:`` characters to inline markup's start string prefix,
3596 ``/`` to end string suffix.
3597 - Fixed a footnote bug.
3598 - Fixed a bug with literal blocks.
3599 - Applied patch from Simon Budig: simplified regexps with symbolic
3600 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
3601 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
3602 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
3603 - Allowed non-ASCII in "simple names" (directive names, field names,
3605 - Converted ``Inliner.patterns.initial`` to be dynamically built
3606 from parts with ``build_regexp()`` function.
3607 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
3608 - Updated docstrings.
3609 - Changed "table" to "grid_table"; added "simple_table" support.
3611 * docutils/parsers/rst/tableparser.py:
3613 - Changed ``TableParser`` to ``GridTableParser``.
3614 - Added ``SimpleTableParser``.
3615 - Refactored naming.
3617 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
3618 a fallback language for directive names.
3620 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
3621 directive to use a ``pending`` element, used only by HTML writers.
3623 * docutils/parsers/rst/directives/parts.py: Renamed from
3626 - Added "backlinks" attribute to "contents" directive.
3628 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
3629 project by Adam Chodorowski.
3631 * docutils/readers/__init__.py: Gave Readers more control over
3632 choosing and instantiating Parsers.
3634 * docutils/readers/pep.py: Added to project; for PEP processing.
3636 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
3637 requires a ``component`` parameter.
3639 * docutils/transforms/components.py: Added to project; transforms
3640 related to Docutils components.
3642 * docutils/transforms/frontmatter.py:
3644 - In ``DocInfo.extract_authors``, check for a single "author" in an
3645 "authors" group, and convert it to a single "author" element.
3646 - Added support for "Dedication" and generic bibliographic fields.
3648 * docutils/transforms/peps.py: Added to project; PEP-specific.
3650 * docutils/transforms/parts.py: Renamed from old components.py.
3652 - Added filter for `Contents`, to use alt-text for inline images,
3653 and to remove inline markup that doesn't make sense in the ToC.
3654 - Added "name" attribute to TOC topic depending on its title.
3655 - Added support for optional TOC backlinks.
3657 * docutils/transforms/references.py: Fixed indirect target resolution
3658 in ``Hyperlinks`` transform.
3660 * docutils/transforms/universal.py:
3662 - Changed ``Messages`` transform to properly filter out system
3663 messages below the warning threshold.
3664 - Added ``Decorations`` transform (support for ``--generator``,
3665 ``--date``, ``--time``, ``--source-link`` options).
3667 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3668 Engelbert Gruber's PDF writer.
3670 * docutils/writers/html4css1.py:
3672 - Made XHTML-compatible (switched to lowercase element & attribute
3673 names; empty tag format).
3674 - Escape double-dashes in comment text.
3675 - Improved boilerplate & modularity of output.
3676 - Exposed modular output in Writer class.
3677 - Added a "generator" meta tag to <head>.
3678 - Added support for the ``--stylesheet`` option.
3679 - Added support for ``decoration``, ``header``, and ``footer``
3681 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3682 translation table to regexp; restores Python 2.0 compatibility
3684 - Added the translator class as instance variable to the Writer, to
3685 make it easily subclassable.
3686 - Improved option list spacing (thanks to Richard Jones).
3687 - Modified field list output.
3688 - Added backlinks to footnotes & citations.
3689 - Added percentage widths to "<col>" tags (from colspec).
3690 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3691 "<span>" changed to "<var>".
3692 - Inline literals: "<code>" changed to "<tt>".
3693 - Many changes to optimize vertical space: compact simple lists etc.
3694 - Add a command-line options & directive attributes to control TOC
3695 and footnote/citation backlinks.
3696 - Added support for optional footnote/citation backlinks.
3697 - Added support for generic bibliographic fields.
3698 - Identify backrefs.
3699 - Relative URLs for stylesheet links.
3701 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3702 PEPs (subclass of ``html4css1.Writer``).
3704 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3706 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3707 of the Docutils internal doctree in XML.
3709 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3713 - Changed the title to "The Docutils Document Tree".
3714 - Added "Hyperlink Bookkeeping" section.
3716 * spec/docutils.dtd:
3718 - Added ``decoration``, ``header``, and ``footer`` elements.
3719 - Brought ``interpreted`` element in line with the parser: changed
3720 attribute "type" to "role", added "position".
3721 - Added support for generic bibliographic fields.
3723 * spec/notes.txt: Continual updates. Added "Project Policies".
3725 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
3728 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3730 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
3731 mailing list discussions.
3733 * spec/pep-0287.txt:
3735 - Renamed to "reStructuredText Docstring Format".
3737 - Reworked Q&A as an enumerated list.
3738 - Converted to reStructuredText format.
3740 * spec/pysource.dtd:
3742 - Reworked structural elements, incorporating ideas from Tony Ibbs.
3744 * spec/pysource.txt: Removed from project. Moved much of its contents
3747 * spec/rst/alternatives.txt:
3749 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3750 - Added "Inline External Targets" section.
3752 * spec/rst/directives.txt:
3754 - Added "backlinks" attribute to "contents" directive.
3756 * spec/rst/problems.txt:
3758 - Updated the Enumerated List Markup discussion.
3759 - Added new alternative table markup syntaxes.
3761 * spec/rst/reStructuredText.txt:
3763 - Clarified field list usage.
3764 - Updated enumerated list description.
3765 - Clarified purpose of directives.
3766 - Added ``-/:`` characters to inline markup's start string prefix,
3767 ``/`` to end string suffix.
3768 - Updated "Authors" bibliographic field behavior.
3769 - Changed "inline hyperlink targets" to "inline internal targets".
3770 - Added "simple table" syntax to supplement the existing but
3771 newly-renamed "grid tables".
3772 - Added cautions for anonymous hyperlink use.
3773 - Added "Dedication" and generic bibliographic fields.
3775 * test: Made test modules standalone (subdirectories became packages).
3777 * test/DocutilsTestSupport.py:
3779 - Added support for PEP extensions to reStructuredText.
3780 - Added support for simple tables.
3781 - Refactored naming.
3783 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3785 - Now supports true packages containing test modules
3786 (``__init__.py`` files required); fixes duplicate module name bug.
3788 * test/test_pep/: Subpackage added to project; PEP testing.
3790 * test/test_rst/test_SimpleTableParser.py: Added to project.
3794 - Updated html.py and publish.py front-end tools to use the new
3795 command-line processing facilities of ``docutils.frontend``
3796 (exposed in ``docutils.core.Publisher``), reducing each to just a
3798 - Added ``locale.setlocale()`` calls to front-end tools.
3800 * tools/buildhtml.py: Added to project; batch-generates .html from all
3801 the .txt files in directories and subdirectories.
3803 * tools/default.css:
3805 - Added support for ``header`` and ``footer`` elements.
3806 - Added styles for "Dedication" topics (biblio fields).
3808 * tools/docutils.conf: A configuration file; added to project.
3810 * tools/docutils-xml.py: Added to project.
3812 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3814 * tools/pep-html-template: Added to project.
3816 * tools/pep2html.py: Added to project from Python (nondist/peps).
3817 Added support for Docutils (reStructuredText PEPs).
3819 * tools/quicktest.py:
3821 - Added the ``--attributes`` option, hacked a bit.
3822 - Added a second command-line argument (output file); cleaned up.
3824 * tools/stylesheets/: Subdirectory added to project.
3826 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3829 Release 0.1 (2002-04-20)
3830 ========================
3832 This is the first release of Docutils, merged from the now inactive
3833 reStructuredText__ and `Docstring Processing System`__ projects. For
3834 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3835 `DPS HISTORY`__ files.
3837 __ http://structuredtext.sourceforge.net/
3838 __ http://docstring.sourceforge.net/
3839 __ http://structuredtext.sourceforge.net/HISTORY.html
3840 __ http://docstring.sourceforge.net/HISTORY.html
3842 General changes: renamed 'dps' package to 'docutils'; renamed
3843 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3844 the test suites (reStructuredText's test/test_states renamed to
3845 test/test_rst); and all modifications required to make it all work.
3847 * docutils/parsers/rst/states.py:
3849 - Improved diagnostic system messages for missing blank lines.
3850 - Fixed substitution_reference bug.
3856 indent-tabs-mode: nil
3857 sentence-end-double-space: t