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.1 (in preparation)
15 ===============================
19 - Node.traverse() returns a list again to restore backwards
20 compatibility. Fixes bug #431.
22 - New method Node.findall(): like Node.traverse() but returns an
23 iterator. Obsoletes Node.traverse().
25 * docutils/utils/__init__.py:
27 - Fix behaviour of get_stylesheet_list(): do not look up stylesheets
28 given as "stylesheet" setting. Cf. bug #434.
30 * docutils/writers/_html_base.py
32 - Fix handling of ``footnote_backlinks==False`` (report Alan G Isaac).
34 * docutils/writers/html5_polyglot/math.css
36 - Fix typo (bug #432).
38 * docutils/writers/odf_odt/__init__.py:
40 - Fix spurious output with Windows (bug #350).
42 * test/test_error_reporting.py
44 - Fix a false positive (bug #434).
47 Release 0.18 (2021-10-26)
48 =========================
52 - Don't change a list while looping over it (in
53 document.set_name_id_map()). Thanks to Mickey Endito.
55 * docutils/parsers/recommonmark_wrapper.py
57 - Test and update to work with recommonmark version 0.6.0.
60 Unfortunately, recommonmark_ is `no longer maintained`__.
62 __ https://github.com/readthedocs/recommonmark/issues/221
64 * docutils/parsers/rst/directives/misc.py
66 - Fix bug #424 Wrong circular inclusion detection.
67 Use a "magic" comment instead of line numbers
68 to keep a log of recursive inclusions.
70 * docutils/parsers/rst/states.py
72 - Use a "magic" comment to update the log of recursive inclusions.
74 * docutils/writers/html5_polyglot/__init__.py
76 - New option `image_loading`_. Support "lazy" loading of images.
77 Obsoletes "embed_images".
79 .. _image_loading: docs/user/config.html#image-loading
81 * docutils/writers/pseudoxml.py:
83 - Fix spelling of option "detailed".
85 * tools/docutils-cli.py
87 - Read settings from standard configuration files.
89 Fix spelling errors in documentation and docstrings.
90 Thanks to Dimitri Papadopoulos.
93 Release 0.18b1 (2021-10-05)
94 ===========================
96 * docutils/frontend.py
98 - The default value for the "auto_id_prefix" setting changed to "%":
99 auto-generated IDs use the tag name as prefix.
103 - Make meta__ a standard Docutils doctree node. Writers may ignore
104 "meta" nodes if they are not supported by the output format.
106 __ docs/ref/doctree.html#meta
108 - document.make_id(): Do not strip leading number and hyphen characters
109 from `name` if the id_prefix setting is non-empty.
111 - Node.traverse() returns an iterator instead of a list.
113 * docutils/parsers/rst/directives/html.py
115 - Removed. (Meta directive moved to ``misc.py``.)
117 * docutils/parsers/rst/directives/misc.py
119 - `Meta` directive class (moved from html.py) inserts `meta`
120 (instead of `pending`) nodes.
122 - Add `class` option to `Raw` directive.
124 * docutils/parsers/rst/directives/tables.py:
126 - Unify behaviour of `"widths" option`_: check that the length of an
127 integer list equals the number of table columns also for the "table"
130 * docutils/tools/math/math2html.py,
131 docutils/tools/math/tex2unicode.py,
132 docutils/writers/html5/math.css
134 - Fork from elyxer and remove code that is not required
136 - Scale variable sized operators and big delimiters with CSS
137 - Support more commands, fix mapping of commands to Unicode characters
138 (cf. `LaTeX syntax for mathematics`_).
139 - Fix bug #244 Wrong subscript/superscript order.
140 - Don't use <tt> element (deprecated in HTML5).
141 - Use STIX fonts if available.
143 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
145 * docutils/parsers/rst/states.py:
147 - Fix source location (line number) for attribution elements.
148 Patch by Mickey Endito.
149 - Add line, source, and rawsource internal attributes for blockquote
150 elements. Patch by Mickey Endito.
152 * docutils/transforms/references.py
154 - Skip system_messages when propagating targets. Fixes bug #425.
156 * docutils/utils/__init__.py
158 - Removed ``unique_combinations`` (obsoleted by ``itertools.combinations``).
160 * docutils/utils/latex2mathml.py
162 - Major update (fixes and support for additional commands and symbols).
165 * docutils/writers/_html_base.py
167 - Write footnote brackets and field term colons to HTML, so that
168 they are present also without CSS and when copying text.
169 Adapt ``minimal.css``.
171 - Use semantic tags <aside> for footnote text, topics, admonitions,
172 and system-messages and <nav> for the table of contents. Use <div>
175 - Only specify table column widths, if the `"widths" option`_ is set
176 and is not "auto" (fixes bug #426).
177 The `table_style`_ setting "colwidths-grid" restores the current default.
179 .. _"widths" option: docs/ref/rst/directives.html#column-widths
180 .. _table_style: docs/user/config.html#table-style
182 - Use ARIA roles to enable accessible HTML for abstract, dedication,
183 the table of contents, footnote, references, footnotes, citations,
186 - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
187 for headings of deeply nested sections.
189 - Do not set classes "compound-first", "compound-middle", or
190 "compound-last" to elements nested in a compound.
191 Use class value "backrefs" instead of "fn-backref" for a span of
194 - Do not write class values handled by the HTML writer ("colwidths-auto",
195 "colwidths-given", "colwidths-grid") to the output.
197 - Move space character between section number and heading into
200 - Removed attribute ``HTMLTranslator.topic_classes``
202 - Items of a definition list with class argument "details" are
203 converted to `details disclosure elements`.
206 * docutils/writers/html4css1/__init__.py:
208 - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
209 (details, aside, nav, ...) and attributes (role, aria-level).
211 * docutils/writers/latex2e/__init__.py
213 - The setting `legacy_class_functions`_ now defaults to "False".
214 Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
216 - Apply patch #181 "Fix tocdepth when chapter/part in use" by
217 John Thorvald Wodder II.
219 - Fix newlines after/before ids_to_labels() (cf. patch #183).
221 - Refactor/revise ToC writing.
223 - Don't add ``\phantomsection`` to labels in math-blocks.
225 - Improve spacing and allow customization of Docutils-generated table
228 - New algorithm for table column widths. Fixes bug #422.
229 New configuration setting legacy_column_widths_.
231 Table.set_table_style() arguments changed.
233 Only write "continued on next page..." if it fits
234 without making the table columns wider.
236 Table `width` option overrides conflicting "auto" column `widths`.
238 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
241 * docutils/writers/latex2e/docutils.sty
243 - Fix excessive padding above sidebar titles.
245 * docutils/writers/pseudoxml.py:
247 - Fix option "detailed" under Python 2.7.
249 * docutils/writers/s5_html/themes/default
251 - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
252 ``blank.gif`` (fixes bug #169).
254 * docutils/writers/manpage.py
256 - Fix: double quotes need to be escaped on macro invocation.
260 Release 0.17.1 (2021-04-16)
261 ===========================
263 * docutils/utils/math/latex2mathml.py
265 - Fix bug #406 (MathML translation of ``\mathbf``).
267 * docutils/writers/latex2e/__init__.py:
269 - Open "docutils.sty" with encoding set to "utf8".
270 Fixes bug #414: error with Py3k when locale encoding is "ascii".
272 * docutils/parsers/*.py, docutils/transforms/*.py
274 - Provide fallbacks for parser config settings
275 to facilitate programmatic use.
277 * docutils/writers/manpage.py
279 - Apply patch #160: move macro defs above ``.TH``
280 (thanks Willie and sorry for the delay).
283 Release 0.17 (2021-04-03)
284 =========================
288 - Installing with ``setup.py`` now requires ``setuptools``.
289 Alternatively, install with `pip`_ (or "manually").
290 - Use importlib.import_module() to programmatically import modules.
291 - Fix bug #385: Import of language modules.
293 .. _pip: https://pypi.org/project/pip/
295 * docutils/MANIFEST.in
297 - Exclude test outputs.
299 * docutils/__init__.py
301 - VersionInfo: ValueError for invalid values, fix comparison to tuples.
303 * docutils/languages/
304 docutils/parsers/rst/languages/
306 - Apply patch # 177 Arabic mappings by Shahin.
307 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
311 - Apply patch #165 "Fix error when copying `system_message` node"
313 - Apply version of patch #167 "Let document.set_id() register all
314 existing IDs". Thanks to Takeshi KOMIYA.
315 - Fix bug #410: Use a "property" function to recursively fetch
316 `Node.document` value from parent node.
318 * docutils/parsers/recommonmark_wrapper.py
320 - New, **experimental** wrapper to integrate the
321 `recommonmark`_ Markdown parser for use with Docutils.
322 Currently only tested with recommonmark version 0.4.0.
324 .. _recommonmark: https://pypi.org/project/recommonmark/
326 * docutils/parsers/rst/directives/body.py
328 - Make the sidebar's "title" argument optional (feature request #69).
330 * docutils/parsers/rst/directives/html.py
332 - Make "meta" elements available for "latex" and "odt".
334 * docutils/parsers/rst/directives/misc.py
336 - Prevent infinite inclusion loops.
338 * docutils/parsers/rst/roles.py
340 - Apply patch #174 `Lowercase new role names on registration`
341 by John Thorvald Wodder II.
343 * docutils/utils/smartquotes.py
345 - Fix bug #383: Smart quotes around opening and separator characters.
347 * docutils/transforms/components.py
349 - Allow a comma-separated list of formats for the Filter transform.
351 * docutils/writers/html*
353 - Implement feature request #40 `Option to embed images as data URI`.
355 * docutils/writers/html5_polyglot/__init__.py
357 - Use the new semantic tags <main>, <section>, <header>,
358 <footer>, <aside>, <figure>, and <figcaption>.
359 See ``minimal.css`` and ``plain.css`` for styling rule examples.
361 Change the `initial_header_level` setting default to "2", as browsers
362 use the `same style for <h1> and <h2> when nested in a <section\>`__.
364 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
366 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
367 <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
368 is found in `inline`__ and `literal`__ elements.
369 Use <ins> and <del> if a unique matching class value
370 is found in `inline`, `literal`, or `container` elements.
371 Use <small> for generated code line numbers.
373 __ docs/ref/doctree.html#inline
374 __ docs/ref/doctree.html#literal
376 - Fix bug #398: properly close link tag to "schema.dcterms".
378 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
380 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
382 - Use <video> for images with video MIME types supported by HTML5.
384 * docutils/writers/html5_polyglot/minimal.css
386 - Move non-essential styling to ``plain.css``.
387 Small fixes and tweaks.
389 - Support "captionbelow" class value for tables.
391 - Display code line numbers as pseudo-elements which are skipped
392 when copying text from code blocks. Solves feature request #32.
394 * docutils/writers/html5_polyglot/plain.css
396 - Support numbered figures.
398 * docutils/writers/html5_polyglot/responsive.css
400 - New optional style that adapts to different screen sizes.
402 * docutils/writers/latex2e/__init__.py:
404 - Use LaTeX environments for admonitions and "class wrappers" for styling
405 admonitions and titles if the new configuration setting
406 `legacy_class_functions`_ is False.
408 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
410 - Remove backwards compatibility code for the deprecated
411 `styling command`__ prefix ``\docutilsrole``.
413 __ docs/user/latex.html#custom-interpreted-text-roles
415 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
417 - Support the `memoir` LaTeX document class.
418 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
420 - The special value "auto" for the `graphicx_option`_ setting
421 is no longer supported (it never worked for xetex/luatex).
423 .. _graphicx_option: docs/user/config.html#graphicx-option
425 - Most helper commands and element definitions are now defined in the
426 LaTeX package `docutils.sty`_ and only inserted in the document
427 preamble if the `stylesheet`__ setting does not list "docutils".
429 .. _docutils.sty: https://ctan.org/pkg/docutils
430 __ docs/user/config.html#stylesheet-latex-writers
432 - Apply patch #173 "Make \*TeX writers convert nonstandard table
433 classes to DUclass environments" by John Thorvald Wodder II.
435 - Fix bug #408 "Incorrect assert in latex writer
436 for multiple citation references".
438 - Apply patch #175 "Fix alignment of nested tables"
439 by John Thorvald Wodder II. Additional fixes to table alignment.
441 - Do not write Docutils-generated ToC, when ``use_latex_toc``
442 is True. (This did happen when publishing from a doctree.)
444 - Set PDF document properties from "meta" directive content.
446 - Apply version of patch #176 "LaTeX writer: Append \leavevmode to
447 non-docinfo field names" by John Thorvald Wodder II.
449 * docutils/writers/manpage.py
451 - Fix #394 fix missing new line after rubric.
452 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
453 - Fix #126 manpage title with spaces.
454 - Fix #380 command line option problem in sphinx.
456 * docutils/writers/odf_odt/__init__.py:
458 - Fix/improve metadata handling:
459 fix "keyword" splitting,
460 allow generic fields (stored as "Custom Properties").
462 * docutils/writers/pseudoxml.py:
464 - New option `detailled`__.
466 __ docs/user/config.html#detailed
468 * test/DocutilsTestSupport.py
470 - Run python3 test like python2 against source not the build/-directory
472 * tools/docutils-cli.py
474 - New generic command line front end that allows the free selection of
475 reader, parser, and writer components.
478 Release 0.16 (2020-01-16)
479 =========================
483 - Dropped support for Python 2.6, 3.3 and 3.4
484 - Docutils now supports Python 2.7 and Python 3.5+ natively
485 (without conversion by ``2to3``).
486 - Keep `backslash escapes`__ in the document tree. Backslash characters in
487 text are be represented by NULL characters in the `text` attribute of
488 Doctree nodes and removed in the writing stage by the node's
491 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
495 - Remove the `handle_io_errors` option from io.FileInput/Output.
499 - Speed up Node.next_node().
500 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
501 - Warn about Node.traverse() returning an iterator instead of a list
504 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
506 * docutils/statemachine.py
508 - Patch [ 158 ]: Speed up patterns by saving compiled versions (eric89gxl)
510 * docutils/transforms/universal.py
512 - Fix [ 332 ]: Standard backslash escape for smartquotes.
513 - Fix [ 342 ]: No escape in roles descending from `inline literal`.
515 * docutils/utils/__init__.py
517 - unescape() definition moved to `nodes` to avoid circular import
518 dependency. Fixes [ 366 ].
520 * docutils/writers/latex2e/__init__.py:
522 - Fix topic subtitle.
523 - Make "rubric" bold-italic and left aligned.
524 - Fix [ 339 ] don't use "alltt" or literal-block-environment
525 in admonitions and footnotes.
526 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
527 - Add "latex writers" to the `config_section_dependencies`.
528 - Ignore classes for `rubric` elements
529 (class wrapper interferes with LaTeX formatting).
531 * docutils/writers/manpage.py
533 - Apply fix for [ 287 ] comma after option is bold.
534 - Apply fix for [ 289 ], line starting with ``.`` in a text.
536 * docutils/writers/odf_odt/__init__.py:
538 - Fix: ElementTree.getchildren deprecated warning
540 * docutils/writers/xetex/__init__.py:
542 - Add "latex writers" to the `config_section_dependencies`.
546 - Fix: 377 ResourceWarning: unclosed file python3.8
547 Close alltests.out with atexit.
551 - Fix: 377 ResourceWarning: unclosed file python3.8
552 Read defaults file with context.
554 - Set "auto_id_prefix" to "%" (expands to tag-names).
555 Results in descriptive links in HTML and more localized changes when
556 editions to the input add or remove auto-ids.
560 - Apply patch #157: avoid test failure because of a ``ResourceWarning``.
562 * test/test_writers/test_odt.py:
564 - Fix [ 359 ]: Test suite fails on Python 3.8. odt XML sorting.
565 Use ElementTree instead of minidom.
569 - New option `html-writer`_.
571 .. _html-writer: docs/user/config.html#html-writer
574 Release 0.15.1 (2019-07-24)
575 ===========================
577 source: branches/rel-0.15
579 Bugs #366 fix release for python2 only.
582 Release 0.15 (2019-07-20)
583 =========================
587 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
588 - Infrastructure automation.
590 * docs/ref/rst/restructuredtext.txt:
592 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
593 field list names (instead of ordinary text).
597 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
598 deprecated. Thanks to hugovk.
600 * docutils/languages/ko.py
601 docutils/parsers/rst/languages/ko.py:
603 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
607 - Fix [ 251 ] system_message.copy() TypeError.
608 - Element.copy() also copies `document`, `line`, and `source` attributes.
610 * docutils/parsers/rst/__init__.py:
612 - Apply [ 152 ] reset `default role` at end of document.
614 * docutils/parsers/rst/states.py:
616 - Allow embedded colons in field list field names.
618 * docutils/parsers/rst/directives/html.py:
620 - Fix bug #281: Remove escaping backslashes in meta directive content.
622 * docutils/parsers/rst/directives/misc.py:
624 - Don't convert tabs to spaces, if `tab_width` is negative in
625 `include` directive with `code` option.
627 * docutils/parsers/rst/directives/tables.py:
629 - Apply patch #121: Add "width" option for the table directives.
631 * docutils/transforms/frontmatter.py:
633 - Add field name as class argument to generic docinfo fields unconditionally.
635 * docutils/transforms/references.py:
637 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
639 * docutils/utils/__init__.py:
641 - Deprecate `unique_combinations` (obsoleted by `itertools.combinations`).
643 * docutils/utils/smartquotes.py:
645 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
647 * docutils/writers/html5_polyglot/
649 - automatically add HTML5-compatible meta tags for docinfo items
650 "authors", "date", and "copyright".
652 * docutils/writers/_html_base.py
654 - Fix bug #358: Non-breaking space removed from fixed-width literal.
656 * docutils/writers/latex2e/__init__.py:
658 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
660 - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
661 - Fixes to literal block handling.
664 Release 0.14 (2017-08-03)
665 =========================
667 * docs/ref/docutils.dtd:
669 - Enable validation of Docutils XML documents against the DTD:
671 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
672 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
673 however, the `ids` attribute cannot use the ID type because `XML only
674 allows one ID per Element Type`__ and doesn't support a multiple-ID
675 "IDS" attribute type.
677 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
679 * docs/ref/rst/restructuredtext.txt:
681 - Added documentation for escaped whitespace in URI contexts.
682 - Clarify use of Unicode character categories.
684 * docutils/parsers/rst/states.py:
686 - Added functionality: escaped whitespace in URI contexts.
687 - Consistent handling of all whitespace characters in inline markup
688 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
690 * docutils/parsers/rst/directives/images.py:
692 - Added support for escaped whitespace in URI contexts.
694 * docutils/parsers/rst/directives/tables.py:
696 - Rework patch [ 120 ] (revert change to Table.get_column_widths()
697 that led to problems in an application with a custom table directive).
699 * docutils/transforms/frontmatter.py:
701 - Fix [ 320 ] Russian docinfo fields not recognized.
703 * docutils/transforms/references.py:
705 - Don't add a second ID to problematic references.
707 * docutils/transforms/universal.py:
709 Fix SmartQuotes: warn only once if language is unsupported,
710 keep "rawsource" when "educating" quotes.
712 * docutils/utils/__init__.py:
714 - Added ``split_escaped_whitespace`` function, support for escaped
715 whitespace in URI contexts.
717 * docutils/utils/error_reporting.py:
719 - Fix [ 321 ] Import block might cause name error.
721 * docutils/utils/smartquotes.py:
723 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
724 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
725 - Fix [ 313 ] Differentiate apostrophe from closing single quote
727 - Fix [ 317 ] Extra space inserted with French smartquotes.
728 - Add command line interface for stand-alone use (requires 2.7).
730 * docutils/writers/_html_base.py:
732 - Provide default title in metadata (required by HTML5).
733 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
734 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
735 reasons, we don't use a third party public installation as default but
736 warn if math-output_ is set to MathJax without specifying a URL.
738 * docutils/writers/html4css1/__init__.py:
740 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
742 * docutils/writers/latex2e/__init__.py:
744 - Handle class arguments for block-level elements by wrapping them
745 in a "DUclass" environment. This replaces the special handling for
746 "epigraph" and "topic" elements.
748 * docutils/writers/manpage.py:
750 - Apply [ 141 ] Handling inline in manpage writer.
752 * docutils/writers/odf_odt/__init__.py:
754 - Command setting ``language`` now sets the default language
755 of the generated ODF document.
756 - The use of image directive options :width: (%), :scale:, etc now
757 set the width/height/size of images in the generated ODF
759 - The heading/title of admonitions now reflects the language
760 specified by the ``language`` setting.
761 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
763 - Fixed [ 282 ] python3: AttributeError.
765 * tools/rst2html4.py: New front-end.
767 * tools/dev/generate_punctuation_chars.py: New script
768 to test and update utils.punctuation_chars.
771 Release 0.13.1 (2016-12-09)
772 ===========================
774 * docutils/languages/fa.py
775 docutils/parsers/rst/languages/fa.py
776 docutils/languages/la.py
777 docutils/parsers/rst/languages/la.py:
779 - Apply [ 133 ] Persian mappings by Shahin Azad.
780 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
784 - Fix [ 253 ] Attribute key without value not allowed in XML.
788 - Apply [ 103 ] Recognize inline markups without word boundaries.
789 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
791 * docutils/parsers/rst/__init__.py
793 - Fix [ 233 ] Change the base URL for the :rfc: role.
795 * docutils/parsers/rst/directives/tables.py
797 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
800 - Implement feature request [ 48 ]
801 Add :align: option to the table directives.
802 Thanks to Takeshi KOMIYA for the patch.
804 * docutils/parsers/rst/roles.py
806 - Fix [ 295 ] Class argument for custom role inheriting from math.
808 * docutils/parsers/rst/tableparser.py
810 - Really fix [ 159 ] Spurious table column alignment errors.
812 * docutils/transforms/frontmatter.py
814 - Add name of generic bibliographic fields as a "classes" attribute value
815 (after conversion to a valid identifier form).
817 * docutils/utils/error_reporting.py
819 - Fix [ 130 ] support streams expecting byte-strings in ErrorOutput.
821 * docutils/utils/math/math2html.py
823 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
824 - New upstream version (additional macros, piece-wise integrals and sums).
826 * docutils/writers/_html_base.py
828 - New auxiliary module for definitions common to all HTML writers.
830 * docutils/writers/html5_polyglot/
832 - New HTML writer generating clean, polyglot_ markup conforming to
835 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
836 and recommended layout rules.
838 * docutils/writers/html4css1/__init__.py
840 - Add "docutils" to class values for "container" object to address [ 267 ].
841 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
842 ``default_stylesheet_path`` and ``default_template_path``.
843 - Fix [ 266 ] creating labels/class values in description list items.
844 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
845 - Fix footnotes with content that does not start with a paragraph.
846 - Use https in default MathJax URL (report Alan G Isaac).
847 - Outsourcing of common code to _html_base.py.
849 * docutils/writers/latex2e/__init__.py
851 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
852 admonitions and docinfo.
854 - Use absolute path for ``default_template_path``.
856 - Removed deprecated options ``--use-latex-footnotes`` and
857 ``--figure-footnotes``.
859 - Cleaner LaTeX code for enumerations and literal blocks.
861 - Use "hyperref" package together with "bookmark" (improved hyperlinking
864 - Fix [ 286 ] Empty column title cause invalid latex file.
866 - Fix [ 224 ] Fix rowspan support for tables.
868 - Let LaTeX determine the column widths in tables with "colwidths-auto".
869 Not suited for multi-paragraph cells!
871 * docutils/writers/odf_odt/__init__.py
873 - remove decode.encode of filename stored in zip.
875 * docutils/writers/xetex/__init__.py
877 - LuaLaTex compatibility: do not load "xunicode".
881 - New front-end ``rst2html5.py``.
885 - Test py26, py27, py33 and py34.
887 To use, install the ``tox`` package via pip or easy_install and use
888 tox from the project root directory.
890 .. _polyglot: http://www.w3.org/TR/html-polyglot/
891 .. _HTML 5: http://www.w3.org/TR/html5/
892 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
895 Release 0.12 (2014-07-06)
896 =========================
898 * docs/ref/rst/directives.txt
900 - Update "math" and "csv-table" descriptions.
902 * docutils/parsers/rst/directives/images.py
904 - Fix [ 258 ] figwidth="image" generates unitless width value.
906 * docutils/parsers/rst/states.py
908 - Improve error report when a non-ASCII character is specified as
909 delimiter, quote or escape character under Python 2.
910 Fixes [ 249 ] and [ 250 ].
912 * docutils/writers/html4css1/__init__.py
914 - Don't add newline after inline math.
915 Thanks to Yury G. Kudryashov for the patch.
917 * docutils/writers/latex2e/__init__.py
919 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
920 - Apply [ 116 ] by Kirill Smelkov. Don't hard code \large for subtitle.
922 * docutils/writers/odf_odt/__init__.py
924 - Apply patch by Jakub Wilk to fix bug [ 100 ].
926 * test/test_error_reporting.py
928 - Fix [ 223 ] by removing redundant tests we do not have control over.
932 - Apply [ 115 ] respect fixed 2to3 string literal conversion behaviour.
935 Release 0.11 (2013-07-22)
936 =========================
940 - Apply [ 2714873 ] Fix for the overwriting of document attributes.
941 - Support embedded aliases within hyperlink references.
942 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
943 language module) before global search.
947 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
949 * docutils/parsers/rst/directives/__init__.py
951 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
953 * docutils/parsers/rst/directives/images.py
955 - Apply [ 3599485 ] node source/line information for sphinx translation.
957 * docutils/parsers/rst/directives/tables.py
959 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
961 * docutils/parsers/rst/states.py
963 - Fix [ 157 ] Line block parsing doesn't like system message.
964 - Always import our local copy of roman.py (report Larry Hastings).
966 * docutils/transforms/references.py
968 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
970 * docutils/utils/__init__.py
972 - Fix [ 3596884 ] exception importing ``docutils.io``.
974 * docutils/writers/html4css1/__init__.py
976 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
977 - New setting `stylesheet_dirs`: Comma-separated list of directories
978 where stylesheets are found. Used by `stylesheet_path` when expanding
979 relative path arguments.
980 - New default for math-output_: ``HTML math.css``.
981 - Avoid repeated class declarations in html4css1 writer
982 (modified version of patch [ 104 ]).
984 .. _math-output: docs/user/config.html#math-output
986 * docutils/writers/latex2e/__init__.py
988 - Drop the simple algorithm replacing straight double quotes with
989 English typographic ones.
990 Activate the SmartQuotes_ transform if you want this feature.
991 - Fix literal use of babel shorthands (straight quote, tilde, ...).
992 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
993 - New setting `stylesheet_dirs`.
995 .. _SmartQuotes: docs/user/config.html#smart-quotes
997 * docutils/writers/manpage.py
999 - Fix [3607063] handle lines starting with a period.
1000 - Fix option separating comma was bold (thanks to Bill Morris).
1003 Release 0.10 (2012-12-16)
1004 =========================
1008 - Dropped support for Python 2.3.
1009 - ``docutils/math``, ``docutils/error_reporting.py``, and
1010 ``docutils/urischemes.py`` moved to the utils package.
1011 - Fix [3541369] Relative __import__ also with Python 3.3.
1012 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
1013 and parsers for Python 2.7 up.
1014 - Fix import of PIL.Image.
1015 - Change default of "syntax highlight" option to "long",
1016 basic syntax highlight styles for LaTeX and HTML.
1020 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
1021 option is ignored and will be removed in a future release.
1022 - Fix Py3k error writing to stdout with encoding differing from default.
1023 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
1025 * docutils/parsers/rst/directives/misc.py
1027 - Fix [ 3546533 ] Unicode error with `date` directive.
1029 * docutils/transforms/universal.py
1031 - SmartQuotes transform for typographic quotes and dashes.
1033 * docutils/utils/__init__.py
1035 - normalize_language_tag() now returns `BCP 47`_ conforming tags
1036 with sub-tags separated by ``-``.
1038 * docutils/writers/html4css1/__init__.py
1040 - Use ``<code>`` tag for inline "code",
1041 do not drop nested inline nodes (syntax highlight tokens).
1042 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
1043 - No line break after opening inline math tag.
1045 * docutils/writers/manpage.py
1047 - Apply [ 3527401 ] admonition's don't preserve indentation
1048 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
1050 * docutils/writers/xetex/__init__.py
1052 - Apply [ 3555160 ] ensure order of "otherlanguages".
1053 - Fix section numbering by LaTeX.
1055 * docutils/writers/s5_html/__init__.py
1057 - Fix [ 3556388 ] MathJax does not work with rst2s5.
1059 * docutils/writers/s5_html/docutils_xml.py
1061 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
1062 - Fix/improve output with ``--indent`` option.
1066 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
1068 * tools/test/test_buildhtml.py
1070 - Fix [ 3521167 ] allow running in any directory.
1071 - Fix [ 3521168 ] allow running with Python 3.
1074 Release 0.9.1 (2012-06-17)
1075 ==========================
1079 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
1080 installed in the PYTHONPATH. Converted tests are now
1081 stored in ``test3/``, tools no longer need conversion.
1083 If you installed one of Docutils versions 0.7 ... 0.9 with
1084 ``setup.py install`` under Python 3, remove the spurious
1085 ``test/`` and ``tools/`` directories in the site library root.
1089 - Make tests independent from the location of the ``test/`` directory.
1090 - Use converted sources (from the ``build/`` directory) for tests under
1095 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
1099 - Fix writing binary data to sys.stdout under Python 3 (allows
1100 ``rst2odt.py`` to be used with output redirection).
1102 * docutils/parsers/rst/directives/misc.py
1104 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
1105 ``locale == C`` and 8-bit char in path argument of `include` directive.
1109 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
1110 file under Python 3.
1113 Release 0.9 (2012-05-02)
1114 ========================
1118 - New reStructuredText "code" role and directive and "code" option
1119 of the "include" directive with syntax highlighting by Pygments_.
1120 - Fix parse_option_marker for option arguments containing ``=``.
1121 - Fix [ 2993756 ]: import Python Imaging Library's Image module
1122 via ``import PIL`` as starting with PIL 1.2,
1123 "PIL lives in the PIL namespace only" (announcement__).
1125 .. _Pygments: http://pygments.org/
1126 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
1130 - Fix [ 2971827 ] and [ 3442827 ]
1131 extras/roman.py moved to docutils/utils/roman.py
1133 * docutils/frontend.py
1135 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
1139 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
1140 - `mode` argument for FileOutput avoids code replication in
1142 - New exceptions InputError and OutputError for IO errors in
1143 FileInput/FileOutput.
1147 - No "hard" system exit on file IO errors: catch and report them in
1148 `Publisher.reportException` instead. Allows handling by a calling
1149 application if the configuration setting `traceback` is True.
1151 * docutils/utils.py -> docutils/utils/__init__.py
1153 - docutils.utils is now a package (providing a place for sub-modules)
1155 .. note:: docutils/math, docutils/error_reporting.py, and
1156 docutils/urischemes.py will move to the utils package in the next
1157 release, too. See RELEASE-NOTES__
1159 __ RELEASE-NOTES.html
1161 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
1162 errors recording non-ASCII filenames (fixes [ 3434355 ]).
1164 - Fix relative_path() with source=None and `unicode` target.
1166 * docutils/parsers/rst/states.py
1168 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
1169 characters and "international" quotes around inline markup.
1170 - Use `field_marker` pattern to look for start of a
1171 directive option block (fixes [ 3484857 ]).
1173 * docutils/parsers/rst/tableparser.py
1175 - Fix [ 2926161 ] for simple tables.
1176 (Combining chars in grid tables still contribute to cell width.)
1178 * docutils/writers/latex2e/__init__.py
1180 - Support the `abbreviation` and `acronym` standard roles.
1181 - Record only files required to generate the LaTeX source as dependencies.
1182 - Fix handling of missing stylesheets.
1183 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
1184 when suppressing LaTeX section numbering.
1185 - Use ``\DUtitle`` for unsupported section levels
1186 - Apply [ 3512791 ] do not compare string literals with "is"
1188 * docutils/writers/xetex/__init__.py
1190 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
1192 * docutils/writers/html4css1/__init__.py
1194 - Change default for `math-output` setting to MathJax.
1195 - Fix handling of missing stylesheets.
1197 * docutils/writers/docutils_xml.py
1199 - Use the visitor pattern with default_visit()/default_depart() methods
1200 instead of minidom to facilitate special handling of selected nodes.
1201 - Support raw XML (inserted as-is inside a <raw></raw> node).
1203 * docutils/writers/manpage.py
1205 - Do not emit comment line with trailing blank. Problematic for VCS.
1208 Release 0.8.1 (2011-08-30)
1209 ==========================
1213 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
1214 and [ 3395920 ] (correct copyright info for rst.el).
1218 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
1220 * docutils/writers/latex2e/__init__.py
1222 - Clean up Babel language setting. Restores Sphinx compatibility.
1225 Release 0.8 (2011-07-07)
1226 ========================
1230 - Handle language codes according to `BCP 47`_.
1231 - If the specified language is not supported by Docutils,
1232 warn and fall back to English.
1233 - Math support: reStructuredText "math" role and directive,
1234 ``math`` and ``math_block`` doctree elements.
1235 - Decode command line arguments with the locale's preferred encoding
1236 (to allow, e.g., ``--title=Dornröschen``).
1237 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
1238 - New sub-module `error_reporting`: handle encoding/decoding errors
1239 when reporting exceptions.
1240 - Some additions to the Docutils core are released under the 2-Clause BSD
1241 license, see COPYING_ for details.
1243 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
1244 .. _COPYING: COPYING.html
1248 - Most directives now support a "name" option that attaches a
1251 - Directive content may start on the first line also when the directive
1252 type accepts options.
1254 * docs/dev/policies.txt:
1256 - Recommend the 2-Clause BSD license
1257 (http://opensource.org/licenses/BSD-2-Clause)
1258 for code that is kept under the author's copyright.
1260 * tools/buildhtml.py:
1262 - Fix ``--local`` switch.
1264 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1266 * docutils/writers/html4css1/__init__.py
1268 - Set "lang" argument for objects with class argument
1269 "language-<language tag>".
1270 - New setting "math-output" with support for HTML, MathML, and LaTeX.
1272 * docutils/writers/latex2e/__init__.py
1274 - Fix [ 3043986 ] AttributeError using :local: with table of content.
1275 - Place title data in the document preamble.
1276 - Load `babel` package only if required.
1277 - Update list of supported languages.
1278 - New config setting "hyperref-options".
1279 No hard-coded "unicode" hyperref option (clash with xetex).
1280 - Set language for custom roles, paragraphs, block-quotes, and
1281 line-quotes with class argument "language-<language tag>".
1282 - Fix [ 3095603 ] wrong quotes output for Russian and other languages.
1283 - Convert image URI to a local file path.
1284 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1285 has more than one paragraph (Wolfgang Scherer).
1286 - \leavevmode before longtable only when needed (prevents spurious vspace)
1287 - do not advance table counter for tables without caption
1289 * docutils/writers/xetex/__init__.py
1291 - New writer generating LaTeX code for compiling with ``xelatex``.
1293 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1294 option allows separate config options for XeTeX vs. LaTeX2e.
1296 * docutils/writers/manpage.py
1298 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1299 - Fix: vertical space cleaning for option group ``.``.
1301 * tools/editors/emacs/rst.el:
1303 - Fix [ 3001100 ] does not handle spaces in filenames.
1304 Thanks to Jakub Wilk.
1306 * docutils/utils.py:
1308 - strip whitespace from stylesheet arguments
1309 - exclude combining chars from column_width()
1310 (partial fix for [ 2926161 ])
1312 * docutils/parsers/rst/directives/misc.py:
1314 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1319 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
1320 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1323 Release 0.7 (2010-07-07)
1324 ========================
1328 - Fix [ 2881769 ] setup configuration.
1329 - Fix [ 2788716 ] reporting problems in included files.
1333 - FileInput opens files as text files with universal newline support
1334 (mode "rU", configurable with the new optional argument "mode").
1338 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1342 - Fix [ 2923723 ] let decode_path() tolerate path == None
1344 * docutils/writers/html4css1/__init__.py
1346 - Support SVG and SWF images (thanks to Stefan Rank).
1347 - Generate valid XHTML for centred images with targets.
1348 Use CSS classes instead of "align" tags for image alignment.
1350 * docutils/writers/latex2e/__init__.py
1352 - Use `transforms.writer_aux.Admonitions` to "normalize" special
1354 - Use the ``\url`` command for URLs (breaks long URLs instead of
1355 writing into the margin).
1356 - Preserve runs of spaces in `inline literals`__.
1357 - Deprecate ``figure_footnotes`` setting.
1358 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
1359 - New ``latex_preamble`` setting.
1360 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1361 - Fix hyperlink targets (labels) for images, figures, and tables.
1362 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1363 - Apply [ 2961991 ] Call hyperref with unicode option.
1364 - Drop the special `output_encoding`__ default ("latin-1").
1365 The Docutils wide default (usually "UTF-8") is used instead.
1366 - Render inline markup in document title and subtitle.
1367 - Fix numbering depth with LaTeX section numbering.
1368 - Update Unicode -> LaTeX translations.
1369 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1371 __ docs/ref/restructuredtext.html#inline-literals
1372 __ docs/user/config.html#docutils-footnotes
1373 __ docs/user/config.html#output_encoding
1375 * docutils/writers/manpage.py
1377 - Fix: supported attribute (thanks to peter2108).
1378 - Remove trailing blanks in code (keep in sync with mercurial version).
1379 - Titles level 1, that is ``.SH``, always uppercase.
1380 - Apply patch from mg: literal text should be bold in man-pages.
1384 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1389 - Python 3 support: copy test/ and tools/ to the build-dir
1390 and convert Python sources with 2to3.
1393 Release 0.6 (2009-10-11)
1394 ========================
1398 - Docutils is now compatible with Python versions from 2.3 up to 2.6
1399 and convertible to 3.1 code.
1401 + Node.__nonzero__ returns True instead of 1.
1402 + use os.walk instead os.path.walk.
1403 + minimize "types" module where possible.
1404 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1405 + Text nodes now subclass unicode rather than UserString
1406 (which is gone in python 3.0).
1407 + 3.0 compatibility module docutils._compat
1409 + Drop 2.2 compatibility workarounds.
1410 + Drop extras/optparse.py and extras/textwrap.py
1411 (stdlib modules since 2.3).
1413 - OpenOffice export: ODT writer moved from sandbox to Docutils core.
1414 - Unix man page export: manpage writer moved from sandbox to Docutils
1417 - Apply [ 1719345 ] Galician translation
1418 - Apply [ 1905741 ] Polish translation
1419 - Apply [ 1878977 ] make_id(): deaccent characters.
1420 - Apply [ 2029251 ] return nonzero when tests fail.
1421 - Fix [ 1692788 ] allow UTF-8 in style sheets.
1422 - Fix [ 2781629 ] support non-ASCII chars in file names.
1423 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1424 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
1425 - Fix [ 2821266 ] --strict option works now like --halt=info.
1426 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
1427 - Fix [ 1627229 ] hyperlink references in substitutions.
1429 - The "newlatex" writer is orphaned.
1433 - Documented Unicode characters allowed as inline markup openers,
1434 closers, and delimiters.
1435 - Allow units for all length specifications.
1436 - Allow percent sign in "scale" argument of "figure" and "image" directives.
1437 - Bugfix: The "figalign" argument of a figure now works as intended
1438 (aligning the figure, not its contents).
1439 - Align images with class "align-[right|center|left]"
1440 (allows setting the alignment of an image in a figure).
1442 * docutils/nodes.py:
1444 - Added ``Element.__contains__`` method, for the in-operator.
1446 * docutils/parsers/rst/states.py:
1448 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1449 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1450 " " (non-breaking space), and "¡ ¿" openers.
1452 * docutils/parsers/directives/misc.py:
1454 - Added ``start-line`` and ``end-line`` options to "include"
1455 directive to select a range of lines.
1456 - Hard tabs in literal inclusions are replaced by spaces. This is
1457 configurable via the new ``tab-width`` option of the "include" directive
1458 (a negative tab-width prevents tab expansion).
1460 * docutils/utils.py:
1462 - Add ``get_stylesheet_list`` function.
1463 - Apply [ 2834836 ] print info at halt
1465 * docutils/transforms/universal.py:
1467 - Raise default priority of StripClasses to exclude stripped classes from
1470 * docutils/writers/html4css1/__init__.py:
1472 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
1473 separated list of stylesheets.
1474 - Address [ 1938891 ] Inline literal text creates "pre" span only when
1475 needed to prevent inter-word line wraps.
1476 - Use `translate` method instead of repeated `replace` calls.
1477 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
1478 classes to allow CSS styling that does not interfere with other
1479 table-using constructs (field lists, citations, ...).
1481 * docutils/writers/newlatex2e/__init__.py:
1483 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1485 * docutils/writers/latex2e/__init__.py:
1487 - Add ``--embed-stylesheet`` option.
1488 - Apply [ 1474017 ] image vertical alignment is reversed.
1489 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1490 - Change: has_key for dictionaries (not Nodes) to in-operator.
1491 - Merge adjacent citations into one latex cite command.
1492 - Failsafe implementation of custom roles. LaTeX compilation now ignores
1493 unknown classes instead of aborting with an error.
1494 - Support custom roles based on standard roles.
1495 - LaTeX packages can be used as ``--stylesheet`` arguments without
1496 restriction. (A style sheet is now referenced with the ``\usepackage``
1497 command, if it ends with ``.sty`` or has no extension.)
1498 - Add ``bp`` to lengths without unit (prevents LaTeX errors).
1499 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1500 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1501 2005-02-04 as a configurable length unit).
1502 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1503 if font-encoding is set to ''. LaTeX defaults to OT1 then.
1504 - Set sub- and superscript role argument in text mode not as math.
1505 Use a custom role based on sub-/superscript if you want italic shape.
1506 - Shorter preamble and less dependencies: Load packages and define macros
1507 only if required in the document.
1508 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1509 - New custom environments and commands with optional "classes" argument.
1510 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1511 - Better conformance to Docutils specifications with ``--use-latex-toc``.
1512 Support for LaTeX generated ToC also with unnumbered sections.
1513 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1514 section numbering by LaTeX.
1515 - Use default font in admonitions and sidebar.
1516 - Align of image in a figure defaults to 'center'.
1517 - Bugfix: Newlines around targets and references prevent run-together
1519 - Fix internal hyperlinks.
1520 - Use class defaults for page margins ('typearea' now optional).
1521 - Float placement made configurable, default changed to "here definitely".
1522 - Typeset generic topic as "quote block with title".
1523 - Use template (file and configuration option).
1524 - In the default template, load cmap.sty (fix text extraction in PDF) and
1525 fixltx2e.sty (LaTeX patches, \textsubscript).
1526 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1527 - Use `translate` instead of repeated `replace` calls for text encoding.
1528 - Hyperlinked footnotes and support for symbol footnotes and
1529 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
1530 - Complete pairs of binary options
1531 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
1532 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
1534 - font-encoding: "T1" (formerly implicitly set by 'ae').
1535 - use-latex-toc: true (ToC with page numbers).
1536 - use-latex-footnotes: true (no mixup with figures).
1538 * docutils/writers/manpage.py
1540 - Do not print version at document end, this is done by the viewer.
1541 - Do not print date at document end, this is done by the viewer.
1542 - Fix storage of docinfo fields for none standard fields.
1544 * docutils/tools/rst2man.py
1547 Release 0.5 (2008-06-25)
1548 ========================
1550 * docutils/languages/he.py: Added to project: Hebrew mappings by
1553 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
1554 mappings by Meir Kriheli.
1556 * docutils/frontend.py:
1558 - Configuration files are now assumed and required to be
1560 - Paths of applied configuration files are now recorded in the
1561 runtime setting ``_config_files`` (accessible via
1562 ``--dump-settings``).
1563 - Added ``--strip-elements-with-class`` and ``--strip-class``
1564 options (``strip_elements_with_classes`` and ``strip_classes``
1569 - Added code to determine the input encoding from data: encoding
1570 declarations or the presence of byte order marks (UTF-8 & UTF-16).
1571 - Added support for IronPython 1.0.
1573 * docutils/nodes.py:
1575 - Added ``document.__getstate__`` method, for pickling.
1577 * docutils/parsers/rst/states.py:
1579 - Allow ``+`` and ``:`` in reference names.
1580 - Unquoted targets beginning with an underscore (``.. __target:
1581 URI``) are no longer accepted.
1582 - Added support for multiple attributions in a physical block quote
1583 (indented text block), dividing it into multiple logical block
1585 - Added support for unicode bullets in bullet lists: "•", "‣", and
1587 - Added support for new object-oriented directive interface,
1588 retaining compatibility to the old functional interface.
1589 - Added support for throwing ``DirectiveError``'s from within
1592 * docutils/parsers/rst/__init__.py:
1594 - Added ``Directive`` base class.
1595 - Added ``DirectiveError`` base class.
1596 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
1599 * docutils/parsers/directives/:
1601 - Refactored all reStructuredText directives to use the new
1602 object-oriented directive interface. Errors are now (mostly)
1603 thrown using the new ``DirectiveError`` class.
1605 * docutils/parsers/directives/misc.py:
1607 - Added ``start-after`` and ``end-before`` options to ``include``
1608 directive; thanks to Stefan Rank.
1610 * docutils/transforms/universal.py:
1612 - Added ``StripClassesAndElements`` transform to remove from the
1613 document tree all elements with classes in
1614 ``settings.strip_elements_with_classes`` and all "classes"
1615 attribute values in ``self.document.settings.strip_classes``.
1617 * docutils/transforms/writer_aux.py:
1619 - Added ``Admonitions`` transform to transform specific admonitions
1620 (like ``note``, ``warning``, etc.) into generic admonitions with a
1623 * docutils/writers/html4css1/__init__.py:
1625 - Moved template functionality from the PEP/HTML writer here.
1626 - Expanded the fragments available in the ``parts`` attribute.
1627 - Moved ``id`` attributes from titles to surrounding ``div``
1629 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
1630 universally supported now).
1631 - ``template.txt`` is now opened in text mode instead of binary mode
1632 (to ensure Windows compatibility).
1633 - ``a`` elements now have an "internal" or "external" class,
1634 depending on reference type.
1636 * docutils/writers/html4css1/template.txt: Added to project.
1638 * docutils/writers/pep_html/:
1640 - Moved template functionality to the HTML writer.
1642 * docutils/writers/s5_html/__init__.py:
1644 - Added ``view_mode`` & ``hidden_controls`` settings
1645 (``--view-mode`` & ``--hidden-controls/--visible-controls``
1648 * docutils/writers/latex2e/__init__.py:
1650 - Add ``--literal-block-env``
1651 - Fix: escaping ``%`` in href urls.
1652 - Move usepackage hyperref after stylesheet inclusion.
1653 - Fix: scrartcl does not have chapter but scrreprt.
1654 - Add newline after ``\end{verbatim}``.
1655 - Merge smaller differences from latex2e_adaptive_preamble.
1656 - Add ``use-part-section``.
1657 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
1658 - Using leavemode option_list no longer needs to check if parent
1659 is a definition list.
1660 - Append ``\leavemode`` to definition list terms.
1661 - No longer write visit\_/depart_definition_list_item comments to
1663 - Table column width with 3 decimal places.
1664 - Add table stubs support (boldfont).
1665 - Add assemble_parts to writer.
1666 - Add simply support for nested tables.
1667 - Fix verbatim in tables if use-verbatim-when-possible.
1668 - Use section commands down to subparagraph.
1669 - Put ensuremath around some latin1 chars.
1670 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
1671 - New option ``--use-bibtex=style,db1,db2``.
1672 - New option ``--reference-label`` to allow usage of LaTeX ref for
1673 labels in section references.
1674 - Add a label after every section to support sectionnumbers as reference
1676 - Fix: bug# 1605376 rst2latex: bad options group list
1677 - Remove inactive code for use_optionlist_for_option_list.
1678 - Remove latex comments from option_list output.
1679 - Fix: bug# 1612270 double quotes in italian literal.
1680 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
1681 - Add option --use-latex-abstract.
1682 - Image width unit ``px`` is translated to ``pt``.
1683 - Add image height support.
1684 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
1686 - Fix: Do not escape underscores in citation reference labels if
1687 use-latex-citations is set.
1688 - Use centering instead of center for figure contents, to avoid vertical
1690 - Recognize table class: borderless, nolines, booktabs, standard.
1691 - Fix: Renaming contents section does not work with latex writer; SF
1693 - Applied patch for custom roles with classes from Edward Loper.
1694 - Fixed bug that caused crashes with more than 256 lists.
1696 * docutils/writers/pep_html/__init__.py:
1698 - Changed to support new python.org website structure and
1701 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1704 * tools/buildhtml.py:
1706 -- Added ``ignore`` setting to exclude a list of shell patterns
1707 (default: ``.svn:CVS``).
1709 * tools/editors/emacs/rst.el:
1711 - Changed license to "GPL".
1712 - Added ``rst-straighten-decorations`` function.
1713 - The ``compile`` module is now always loaded.
1714 - Added ``rst-toggle-line-block`` function.
1715 - Headings consisting only of non-ASCII characters are now
1716 recognized by ``rst-toc`` and ``rst-adjust``.
1717 - Added font-lock support for multi-line comments where the first
1718 comment line is empty.
1719 - Added ``(require 'font-lock)``.
1723 - Provide descriptive error message if distutils is missing.
1726 Release 0.4 (2006-01-09)
1727 ========================
1731 - Updated the project policies for trunk/branch development &
1734 * docutils/__init__.py:
1736 - Added ``__version_details__`` attribute to describe code source
1737 (repository/snapshot/release).
1738 - Replaced ``default_transforms`` attribute of TransformSpec with
1739 ``get_transforms()`` method.
1743 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1744 functions, for document tree extraction and reprocessing.
1748 - Added ``DocTreeInput`` class, for reprocessing existing documents.
1749 - Added support for non-Unicode (e.g. binary) writer output.
1751 * docutils/nodes.py:
1753 - Re-introduced ``Targetable.indirect_reference_name``, for
1754 MoinMoin/reST compatibility (removed in r3124/r3129).
1755 - Added ``serial_escape`` function; escapes string values that are
1756 elements of a list, for serialization. Modified Docutils-XML
1757 writing (``Element._dom_node``) and pseudo-XML writing
1758 (``Element.starttag``) to use ``serial_escape``.
1759 - Added ``Node.deepcopy()`` method.
1760 - Removed the internal lists ``document.substitution_refs``,
1761 ``document.anonymous_refs``, and ``document.anonymous_targets``.
1762 - Added a "container" element.
1763 - Fixed bug where values of list-valued attributes of elements
1764 originating from custom interpreted text roles (i.e., with custom
1765 classes) were being shared between element instances. Reported by
1768 * docutils/statemachine.py:
1770 - Added trailing whitespace stripping to ``string2lines()``.
1771 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1772 Asian double-width character support.
1774 * docutils/utils.py:
1776 - Added ``east_asian_column_width()`` for double-width character
1779 * docutils/languages/ja.py: Added to project: Japanese mappings by
1782 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1783 mappings by Panjunyong.
1785 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1787 * docutils/parsers/rst/__init__.py:
1789 - Added validator to tab_width setting, with test. Closes SF bug
1790 #1212515, report from Wu Wei.
1792 * docutils/parsers/rst/states.py:
1794 - Fixed bug with escaped colons indicating a literal block.
1795 - Fixed bug with enumerated lists (SF#1254145).
1796 - Backslash-escaped colons inside of field names are now allowed.
1797 - Targets (implicit and explicit), anonymous hyperlink references
1798 and auto-numbered footnote references inside of substitution
1799 definitions are now disallowed.
1800 - Fixed bug: list items with blank first lines.
1801 - Fixed bug: block quote attributions with indented second lines.
1802 - Added East Asian double-width character support (Python 2.4 only).
1804 * docutils/parsers/rst/tableparser.py:
1806 - Added East Asian double-width character support (Python 2.4 only).
1808 * docutils/parsers/rst/directives/body.py:
1810 - Added the "container" directive.
1812 * docutils/parsers/rst/directives/misc.py:
1814 - Added the "default-role", "title", and "date" directives.
1815 - Added standard data file syntax to the "include" directive.
1816 - Added support for "class" directive content.
1818 * docutils/parsers/rst/directives/images.py:
1820 - Added ``indirect_reference_name`` support for images with a target
1822 - Added support for image width and height units.
1823 - Fixed bug with image "target" options.
1825 * docutils/parsers/rst/directives/references.py:
1827 - Added "class" attribute to "target-notes" directive, for
1828 footnote_reference classes.
1830 * docutils/parsers/rst/include/: Directory added to project; contains
1831 standard data files for the "include" directive. Initial contents:
1832 character entity substitution definition sets, and a set of
1833 definitions for S5/HTML presentations.
1835 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1836 mappings by David Goodger.
1838 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1839 Simplified Chinese mappings by Panjunyong.
1841 * docutils/readers/__init__.py:
1843 - Added universal.Decorations and universal.ExposeInternals
1844 transforms as default transforms for all readers.
1845 - Added ``ReReader`` base class for readers that reread an existing
1848 * docutils/readers/doctree.py: Added to project; a reader for existing
1851 * docutils/transforms/frontmatter.py:
1853 - Fixed the DocInfo transform to handle SVN-style expansion of the
1855 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1858 * docutils/transforms/misc.py:
1860 - Added misc.Transitions transform, extracted from
1861 universal.FinalChecks.
1863 * docutils/transforms/references.py:
1865 - Added references.DanglingReferences transform, extracted from
1866 universal.FinalChecks.
1867 - Fixed bug with doubly-indirect substitutions.
1868 - Added footnote_reference classes attribute to "TargetNotes".
1869 - Fixed bug with circular substitution definitions that put Docutils
1870 into an infinite loop.
1872 * docutils/transforms/universal.py:
1874 - Added universal.ExposeInternals transform, extracted from
1875 universal.FinalChecks.
1876 - Removed universal.FinalChecks transform (logic has been moved to
1877 several new transforms).
1878 - Fixed bug with the "expose_internals" setting and Text nodes
1879 (exposed by the "rawsource" internal attribute).
1880 - Added the universal.StripComments transform, implementation of the
1881 "strip_comments" setting.
1883 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1884 transforms for writers.
1886 - Added ``Compound`` transform, which flattens compound paragraphs.
1888 * docutils/writers/: Several writer modules (html4css1.py) were
1889 converted into packages. Support modules and data files have been
1890 moved into the packages. The stylesheets for the HTML writers are
1891 now installed along with the code, the code knows where to find
1892 them, and the default is to use them (actually, to embed them).
1893 Some adjustments to configuration files may be necessary. The
1894 easiest way to obtain the new default behavior is to remove all
1895 settings whose name includes "stylesheet".
1897 * docutils/writers/__init__.py:
1899 - Added universal.Messages and universal.FilterMessages transforms
1900 as default transforms for all writers.
1901 - Added ``UnfilteredWriter`` base class for writers that pass the
1902 document tree on unchanged.
1904 * docutils/writers/docutils_xml.py:
1906 - Made ``xmlcharrefreplace`` the default output encoding error
1909 * docutils/writers/html4css1/:
1911 - Added support for image width and height units.
1912 - Made ``xmlcharrefreplace`` the default output encoding error
1914 - Made ``--embed-stylesheet`` the default rather than
1915 ``--link-stylesheet``.
1916 - Moved "id" attribute from container (section etc.) to title's <a>
1917 tag, to be on the same tag as "name".
1918 (!!! To be reverted in Docutils 0.5.)
1919 - Added vertical space between fields of field lists.
1920 - Added ``--compact-field-lists`` option to remove vertical space in
1922 - Made cloaking of email addresses with ``--cloak-email-addresses``
1924 - Fixed support for centered images.
1925 - Added support for class="compact" & class="open" lists.
1927 * docutils/writers/latex2e/:
1929 - Underscores in citekeys are no longer escaped.
1931 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1932 mapping of Unicode characters to LaTeX equivalents.
1934 * docutils/writers/s5_html/: Package added to project; writer for
1935 S5/HTML slide shows.
1937 * docs/dev/distributing.txt: Added to project; guide for distributors
1938 (package maintainers).
1940 * docs/dev/hacking.txt: Added to project; guide for developers.
1942 * docs/ref/doctree.txt:
1944 - Updated for plural attributes "classes", "ids", "names",
1946 - Added the "container" element.
1948 * docs/ref/docutils.dtd:
1950 - Updated for plural attributes "classes", "ids", "names",
1953 * docs/user/emacs.txt: Added to project; a document about Emacs
1954 support for reStructuredText and Docutils.
1956 * docs/user/links.txt: Added to project; lists of Docutils-related
1959 * docs/user/mailing-lists.txt: Added to project; information about
1960 Docutils-related mailing lists and how to access them.
1962 * docs/user/slide-shows.txt: Added to project; example of and docs for
1963 the S5/HTML writer (``rst2s5.py`` front end).
1965 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1966 Files", added to project.
1968 * test/coverage.sh: Added to project; test coverage script.
1970 * test/DocutilsTestSupport.py:
1972 - Added support for specifying runtime settings at the suite level.
1974 * test/test_functional.py:
1976 - Added the ``clear_output_directory`` function.
1977 - Added support for ``_test_more`` functions in functional test
1980 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1982 * tools/rstpep2html.py: Renamed from pep.py.
1984 * tools/dev/create_unimap.py: Added to project; script to create the
1985 docutils/writers/unimap_latex.py mapping file.
1987 * tools/dev/profile_docutils.py: Added to project; profiler script.
1989 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1991 * tools/editors/emacs/restructuredtext.el,
1992 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1993 Removed from project; the functionality is now contained in rst.el.
1995 * tools/editors/emacs/rst.el: Added to project. Added many features
1996 and fixed many bugs. See docs/user/emacs.txt for details.
1998 * tools/stylesheets: Removed from project. Stylesheets have been
1999 renamed and moved into writer packages.
2002 Release 0.3.9 (2005-05-26)
2003 ==========================
2007 - Eliminated and replaced all uses of the old string attributes
2008 ``id``, ``name``, ``dupname`` and ``class`` with references to the
2009 new list attributes ``ids``, ``names``, ``dupnames`` and
2010 ``classes`` throughout the whole source tree.
2014 - Enabled ``--dump-*`` options when ``--traceback`` specified,
2015 allowing for easier debugging.
2016 - In ``Publisher.publish()``, expanded the generic top-level
2019 * docutils/examples.py:
2021 - Added ``internals`` function for exploration.
2025 - Fixed ``Input.decode`` method to apply heuristics only if no
2026 encoding is explicitly given, and to provide better reporting of
2028 - The ``Input.decode`` method now removes byte order marks (BOMs)
2031 * docutils/nodes.py:
2033 - ``image`` element class changed to subclass of Element, not
2034 TextElement (it's an empty element, and cannot contain text).
2035 - Added ``attr_defaults`` dictionary for default attribute values.
2036 - Added empty list as default value for the following attributes:
2037 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
2038 - Added ``document.decoration`` attribute,
2039 ``document.get_decoration`` method, and ``decoration.get_header``
2040 & ``.get_footer`` methods.
2041 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
2044 * docutils/utils.py:
2046 - Removed ``docutils.utils.Reporter.categories``,
2047 ``docutils.utils.ConditionSet``, and all references to them, to
2048 simplify error reporting.
2050 * docutils/languages/nl.py: Added to project; Dutch mappings by
2053 * docutils/parsers/rst/__init__.py:
2055 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
2057 * docutils/parsers/rst/states.py:
2059 - Added check for escaped at-mark to prevent email address recognition.
2060 - Fixed option lists to allow spaces inside ``<angle-bracketed option
2062 - Allowed whitespace in paths and URLs.
2063 - Added auto-enumerated list items.
2064 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
2066 - Added support for table stub columns.
2068 * docutils/parsers/rst/directives/__init__.py:
2070 - Allowed whitespace in paths (``path`` function).
2071 - Added ``uri`` directive option conversion function.
2073 * docutils/parsers/rst/directives/body.py:
2075 - Fixed illegal context bug with "topic" directive (allowed within
2076 sidebars; not within body elements).
2078 * docutils/parsers/rst/directives/images.py:
2080 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
2081 - Added support for the ``file_insertion_enabled`` setting in the
2082 "figure" directive (disables "figwidth" option).
2083 - "image" directive: added checks for valid values of "align" option,
2084 depending on context. "figure" directive: added specialized
2085 "align" option and attribute on "figure" element.
2086 - Made ":figwidth: image" option of "figure" directive work again.
2087 - Fixed bug with reference names containing uppercase letters
2088 (e.g. ``Name_``) in "target" option of "image" directive.
2090 * docutils/parsers/rst/directives/misc.py:
2092 - Fixed "include" and "raw" directives to catch text decoding
2094 - Allowed whitespace in "include" & "raw" directive paths.
2095 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
2096 settings in "include" & "raw" directives.
2098 * docutils/parsers/rst/directives/parts.py:
2100 - Added "header" & "footer" directives.
2101 - Fixed illegal context bug with "contents" directive (topics
2102 allowed within sidebars; not within body elements).
2104 * docutils/parsers/rst/directives/tables.py:
2106 - Added "list-table" directive.
2107 - Caught empty CSV table bug.
2108 - Added support for the ``file_insertion_enabled`` setting in the
2109 "csv-table" directive.
2110 - Added ``stub-columns`` option to "csv-table" and "list-table"
2113 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
2114 mappings by Martijn Pieters.
2116 * docutils/readers/standalone.py:
2118 - Added ``--section-subtitles`` and ``--no-section-subtitles``
2119 options to activate or deactivate the SectSubTitle transform.
2121 * docutils/transforms/frontmatter.py:
2123 - Added SectSubTitle transform to promote titles of lone
2124 subsections to subtitles.
2126 * docutils/transforms/references.py:
2128 - Fixed mislocated internal targets bug, by propagating internal
2129 targets to the next node, making use of the newly added support
2130 for multiple names and IDs.
2131 - Fixed duplicate footnote label bug.
2132 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
2135 * docutils/writers/html4css1.py:
2137 - Fixed unencoded stylesheet reference bug (characters like "&" in
2138 stylesheet references).
2139 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
2141 - Added support for multiple IDs per node by creating empty ``span``
2143 - Added the ``field_name_limit`` & ``option_limit`` settings &
2145 - Added support for table stub columns.
2146 - Added support for the ``align`` attribute on ``figure`` elements.
2147 - Added the ``cloak_email_addresses`` setting & support.
2148 - Added ``html_prolog``, ``html_head``, ``html_body``,
2149 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
2150 ``docutils.core.publish_parts``.
2151 - Added support for section subtitles.
2153 * docutils/writers/latex2e.py:
2155 - Fixed tables starting with more than one multirow cell.
2156 - Improved --use-latex-docinfo so that organization/contact/address
2157 fields are lumped with the last author field and appear on the
2159 - Made sure the titlepage is always shown with --use-latex-docinfo,
2160 even if the document has no title.
2161 - Made sure that latex doesn't fill in today's date if no date field
2163 - Added support for section subtitles.
2165 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
2166 (under development).
2168 * docutils/writers/null.py: Added to project; a do-nothing Writer.
2170 * docs/api/publisher.txt:
2172 - Added "``publish_parts`` Details" section.
2174 * docutils/dev/repository.txt: Added to project; information about the
2175 Docutils Subversion repository.
2177 * docs/ref/docutils.dtd:
2179 - Added a ``stub`` attribute to the ``colspec`` element via the
2180 ``tbl.colspec.att`` parameter entity.
2181 - Allowed topic elements within sidebars
2182 - Added an ``align`` attribute to the ``figure`` element.
2184 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
2188 Release 0.3.7 (2004-12-24)
2189 ==========================
2191 * docutils/frontend.py:
2193 - Added options: --input-encoding-error-handler,
2194 --record-dependencies, --leave-footnote-reference-space,
2196 - Added command-line and config file support for "overrides" setting
2201 - Added support for input encoding error handler.
2203 * docutils/nodes.py:
2205 - Added dispatch_visit and dispatch_departure methods to
2206 NodeVisitor; useful as a hook for Visitors.
2207 - Changed structure of ``line_block``; added ``line``.
2208 - Added ``compound`` node class.
2209 - Added a mechanism for Visitors to transitionally ignore new node
2212 * docutils/utils.py:
2214 - Moved ``escape2null`` and ``unescape`` functions from
2215 docutils/parsers/rst/states.py.
2217 * docutils/parsers/rst/roles.py:
2220 - Changed role function API: the "text" parameter now takes
2221 null-escaped interpreted text content.
2223 * docutils/parsers/rst/states.py:
2225 - Fixed bug where a "role" directive in a nested parse would crash
2226 the parser; the state machine's "language" attribute was not being
2228 - Added support for line block syntax.
2229 - Fixed directive parsing bug: argument-less directives didn't
2230 notice that arguments were present.
2231 - Removed error checking for transitions.
2232 - Added support for multiple classifiers in definition list items.
2233 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
2234 - Changed role function API: the "text" parameter now takes
2235 null-escaped interpreted text content.
2236 - Empty sections and documents are allowed now.
2238 * docutils/parsers/rst/directives/__init__.py:
2240 - Added ``encoding`` directive option conversion function.
2241 - Allow multiple class names in class_option conversion function.
2243 * docutils/parsers/rst/directives/body.py:
2245 - Converted the line-block directive to use the new structure.
2246 - Extracted the old line-block functionality to the ``block``
2247 function (still used).
2248 - Added ``compound`` directive (thanks to Lea Wiemann).
2250 * docutils/parsers/rst/directives/misc.py:
2252 - Added "encoding" option to "include" and "raw" directives.
2253 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
2254 - Allow multiple class names in the "class" directive.
2256 * docutils/parsers/rst/directives/parts.py:
2258 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
2259 options. Thanks to Lele Gaifax.
2261 * docutils/parsers/rst/directives/tables.py:
2263 - Added "encoding" directive to "csv-table" directive.
2264 - Added workaround for lack of Unicode support in csv.py, for
2265 non-ASCII CSV input.
2267 * docutils/transforms/misc.py:
2269 - Fixed bug when multiple "class" directives are applied to a single
2271 - Enabled multiple format names for "raw" directive.
2273 * docutils/transforms/references.py:
2275 - Added support for trimming whitespace from beside substitution
2278 * docutils/transforms/universal.py:
2280 - FinalChecks now checks for illegal transitions and moves
2281 transitions between sections.
2283 * docutils/writers/html4css1.py:
2285 - HTMLTranslator.encode now converts U+00A0 to " ".
2286 - "stylesheet" and "stylesheet_path" settings are now mutually
2288 - Added support for the new line_block/line structure.
2289 - --footnote-references now overrides
2290 --trim-footnote-reference-space, if applicable.
2291 - Added support for ``compound`` elements.
2292 - Enabled multiple format names for "raw" directive.
2293 - ``<p>`` tags of a paragraph which is the only visible child of the
2294 document node are no longer stripped.
2295 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2296 new method ``should_be_compact_paragraph()``.
2297 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2299 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2300 the output if they have their ``class`` attribute set.
2301 - The whole document is now surrounded by a ``<div
2302 class="document">`` element.
2303 - Body-level images are now wrapped by their own ``<div>`` elements,
2304 with image classes copied to the wrapper, and for images which
2305 have the ``:align:`` option set, the surrounding ``<div>`` now
2306 receives a class attribute (like ``class="align-left"``).
2308 * docutils/writers/latex2e.py:
2310 - no newline after depart_term.
2311 - Added translations for some Unicode quotes.
2312 - Added option "font-encoding", made package AE the default.
2313 - "stylesheet" and "stylesheet_path" settings are now mutually
2315 - --footnote-references now overrides
2316 --trim-footnote-reference-space, if applicable.
2317 - The footnote label style now matches the footnote reference style
2318 ("brackets" or "superscript").
2319 - Added support for ``compound`` elements.
2320 - Enabled multiple format names for "raw" directive.
2322 * docs/ref/docutils.dtd:
2324 - Changed structure of the ``line_block`` element; added ``line``.
2325 - Added ``compound`` element.
2326 - Added "ltrim" and "rtrim" attributes to
2327 ``substitution_definition`` element.
2328 - Enabled multiple format names for ``raw`` element.
2329 - Enabled multiple classifiers in ``definition_list_item`` elements.
2331 * docs/ref/rst/directives.txt
2333 - Marked "line-block" as deprecated.
2334 - "Class" directive now allows multiple class names.
2335 - Added "Rationale for Class Attribute Value Conversion".
2336 - Added warning about "raw" overuse/abuse.
2338 * docs/ref/rst/restructuredtext.txt:
2340 - Added syntax for line blocks.
2341 - Definition list items may have multiple classifiers.
2343 * docs/ref/rst/roles.txt:
2347 * tools/stylesheets/default.css:
2349 - Added support for the new line_block structure.
2350 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2353 Release 0.3.5 (2004-07-29)
2354 ==========================
2358 * _`Documentation cleanup/reorganization`.
2360 - Created new subdirectories of docs/:
2362 * ``docs/user/``: introductory/tutorial material for end-users
2363 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2364 * ``docs/api/``: API reference material for client-developers
2365 * ``docs/ref/``: reference material for all groups
2366 * ``docs/howto/``: for component-developers and core-developers
2367 * ``docs/peps/``: Python Enhancement Proposals
2369 - Moved ``docs/*`` to ``docs/user/``.
2370 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2371 ``spec/`` to ``docs/dev``.
2372 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2373 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2374 - Moved ``alternatives.txt``, and ``problems.txt`` from
2375 ``spec/rst/`` to ``docs/dev/rst/``.
2376 - Moved ``reStructuredText.txt``, ``directives.txt``,
2377 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2378 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
2379 ``roles.txt``, ``reStructuredText.txt`` to
2380 ``restructuredtext.txt``.
2381 - Moved ``spec/howto/`` to ``docs/howto``.
2383 In order to keep the CVS history of moved files, we supplied
2384 SourceForge with a `script for modifying the Docutils CVS
2387 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
2389 After running the cleanup script:
2391 - Added ``docs/index.txt``.
2392 - Added a ``.htaccess`` file to the ``web`` module, containing
2393 redirects for all old paths to new paths. They'll preserve
2394 fragments (the "#name" part of a URL), and won't clutter up the
2395 file system, and will correct the URL in the user's browser.
2396 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2397 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2398 the "To Do" list itself in ``docs/dev/todo.txt``.
2399 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2400 section of ``docs/dev/todo.txt``.
2401 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2402 - Added "How To Report Bugs" to ``BUGS.txt``.
2403 - Went through all the sources and docs (including under web/) and
2404 updated links. Mostly done by Lea Wiemann; thanks Lea!
2405 (Still need to update links in the sandboxes.)
2409 * BUGS.txt: Added to project.
2411 * THANKS.txt: Added to project.
2413 * docutils/__init__.py:
2415 - 0.3.4: Post-release.
2419 - Added special error handling & advice for UnicodeEncodeError.
2420 - Refactored Publisher.publish (simplified exception handling &
2421 extracted debug dumps).
2422 - Renamed "enable_exit" parameter of convenience functions to
2423 "enable_exit_status".
2424 - Enabled traceback (exception propagation) by default in
2425 programmatic convenience functions.
2426 - Now publish_file and publish_cmdline convenience functions return
2427 the encoded string results in addition to their regular I/O.
2428 - Extracted common code from publish_file, publish_string, and
2429 publish_parts, into new publish_programmatically. Extracted
2430 settings code to ``Publisher.process_programmatic_settings``.
2431 - In Publisher.publish, disabled ``settings_overrides`` when
2432 ``settings`` is supplied; redundant.
2434 * docutils/frontend.py:
2436 - Added help text for "--output-encoding-error-handler" and
2437 "--error-encoding-error-handler".
2438 - Renamed "--exit" to "--exit-status".
2439 - Simplified default-setting code.
2441 * docutils/parsers/rst/__init__.py:
2443 - Added "--pep-base-url" and "--rfc-base-url" options.
2445 * docutils/parsers/rst/states.py:
2447 - Made URI recognition more aggressive and intelligent.
2449 * docutils/parsers/rst/directives/__init__.py:
2451 - Added several directive option conversion functions.
2453 * docutils/parsers/rst/directives/body.py:
2455 - Moved "table" directive to tables.py.
2457 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2460 * docutils/writers/latex2e.py:
2462 - Added "--table-style=(standard|booktabs|nolines)"
2463 - figures get "here" option (LaTeX per default puts them at bottom),
2464 and figure content is centered.
2465 - Rowspan support for tables.
2466 - Fix: admonition titles before first section.
2467 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2468 - Replave ``_`` in literal by an underlined blank, because it has the correct
2470 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2471 - A few unicode replacements, if output_encoding != utf
2472 - Add "--graphicx-option".
2473 - Indent literal-blocks.
2474 - Fix: omit ``\maketitle`` when there is no document title.
2476 * docs/index.txt: "Docutils Project Documentation Overview", added to
2479 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2480 Tool", added to project.
2482 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2484 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2486 * docs/dev/policies.txt: Added to project (extracted from
2487 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2489 * docs/dev/release.txt: Added to project (extracted from
2490 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2492 * docs/dev/testing.txt: Added to project.
2494 * docs/dev/website.txt: Added to project (extracted from
2495 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2497 * docs/ref/rst/directives.txt:
2499 - Added directives: "table", "csv-table".
2501 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2502 added to project. 1 page for syntax, and a 1 page reference for
2503 directives and roles. Source text to be used as-is; not meant to be
2506 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2507 with a change of title.
2509 * test/functional/, contents, and test/test_functional.py: Added to
2512 * tools/buildhtml.py: Fixed bug with config file handling.
2514 * tools/html.py: Removed from project (duplicate of rst2html.py).
2516 * tools/pep2html.py: Removed from project (duplicate of Python's
2517 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2518 Docutils-related PEPs in docs/peps/).
2520 * tools/rst2pseudoxml.py: Renamed from publish.py.
2522 * tools/rst2xml.py: Renamed from docutils-xml.py.
2524 * tools/test.txt: Removed from project; moved to
2525 docs/user/rst/demo.txt.
2527 * setup.py: Now also installs ``rst2latex.py``.
2530 Release 0.3.3 (2004-05-09)
2531 ==========================
2533 * docutils/__init__.py:
2535 - 0.3.1: Reorganized config file format (multiple sections); see
2537 - Added unknown_reference_resolvers attribute to TransformSpec.
2538 - 0.3.2: Interpreted text reorganization.
2543 - Catch system messages to stop tracebacks from parsing errors.
2544 - Catch exceptions during processing report & exit without
2545 tracebacks, except when "--traceback" used.
2546 - Reordered components for OptionParser; application comes last.
2547 - Added "config_section" parameter to several methods and functions,
2548 allowing front ends to easily specify their config file sections.
2549 - Added publish_parts convenience function to allow access to individual
2550 parts of a document.
2552 * docutils/examples.py: Added to project; practical examples of
2553 Docutils client code, to be used as-is or as models for variations.
2555 * docutils/frontend.py:
2557 - Added "--traceback" & "--no-traceback" options ("traceback"
2559 - Implemented support for config file reorganization:
2560 ``standard_config_files`` moved from ``ConfigParser`` to
2561 ``OptionParser``; added
2562 ``OptionParser.get_config_file_settings()`` and
2563 ``.get_standard_config_settings()``; support for old "[options]"
2564 section (with deprecation warning) and mapping from old to new
2566 - Reimplemented setting validation.
2567 - Enabled flexible boolean values: yes/no, true/false, on/off.
2568 - Added ``Values``, a subclass of ``optparse.Values``, with support
2569 for list setting attributes.
2570 - Added support for new ``DOCUTILSCONFIG`` environment variable;
2571 thanks to Beni Cherniavsky.
2572 - Added "--no-section-numbering" option.
2576 - Catch IOErrors when opening source & destination files, report &
2577 exit without tracebacks. Added ``handle_io_errors`` parameter to
2578 ``FileInput`` & ``FileOutput`` to enable caller error handling.
2580 * docutils/nodes.py:
2582 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
2583 method definitions (via ``exec``) to dynamic assignments (via
2584 ``setattr``); thanks to Roman Suzi.
2585 - Encapsulated visitor dynamic assignments in a function; thanks to
2587 - Added indirect_reference_name attribute to the Targetable
2588 class. This attribute holds the whitespace_normalized_name
2589 (contains mixed case) of a target.
2591 * docutils/statemachine.py:
2593 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
2594 - Added ``StringList.get_2D_block``.
2596 * docutils/utils.py:
2598 - Added "level" attribute to SystemMessage exceptions.
2600 * docutils/languages/af.py: Added to project; Afrikaans mappings by
2603 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
2606 * docutils/languages/eo.py: Added to project; Esperanto mappings by
2607 Marcelo Huerta San Martin.
2609 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
2610 mappings by Lalo Martins.
2612 * docutils/languages/ru.py: Added to project; Russian mappings by
2615 * docutils/parsers/rst/roles.py: Added to project. Contains
2616 interpreted text role functions, a registry for interpreted text
2617 roles, and an API for adding to and retrieving from the registry.
2618 Contributed by Edward Loper.
2620 * docutils/parsers/rst/states.py:
2622 - Updated ``RSTState.nested_parse`` for "include" in table cells.
2623 - Allowed true em-dash character and "---" as block quote
2625 - Added support for <angle-bracketed> complex option arguments
2627 - Fixed handling of backslashes in substitution definitions.
2628 - Fixed off-by-1 error with extra whitespace after substitution
2629 definition directive.
2630 - Added inline markup parsing to field lists' field names.
2631 - Added support for quoted (and unindented) literal blocks.
2632 Driven in part by a bribe from Frank Siebenlist (thanks!).
2633 - Parser now handles escapes in URIs correctly.
2634 - Made embedded-URIs' reference text omittable. Idea from Beni
2636 - Refactored explicit target processing code.
2637 - Added name attribute to references containing the reference name only
2638 through whitespace_normalize_name (no case changes).
2639 - parse_target no longer returns the refname after going through
2640 normalize_name. This is now handled in make_target.
2641 - Fixed bug relating to role-less interpreted text in non-English
2643 - Reorganized interpreted text processing; moved code into the new
2644 roles.py module. Contributed by Edward Loper.
2645 - Refactored ``Body.parse_directive`` into ``run_directive`` and
2646 ``parse_directive_block``.
2648 * docutils/parsers/rst/tableparser.py:
2650 - Reworked for ``StringList``, to support "include" directives in
2653 * docutils/parsers/rst/directives/__init__.py:
2655 - Renamed ``unchanged()`` directive option conversion function to
2656 ``unchanged_required``, and added a new ``unchanged``.
2657 - Catch unicode value too high error; fixes bug 781766.
2658 - Beefed up directive error reporting.
2660 * docutils/parsers/rst/directives/body.py:
2662 - Added basic "table" directive.
2664 * docutils/parsers/rst/directives/images.py:
2666 - Added "target" option to "image" directive.
2667 - Added name attribute to references containing the reference name only
2668 through whitespace_normalize_name (no case changes).
2670 * docutils/parsers/rst/directives/misc.py:
2672 - Isolated the import of the ``urllib2`` module; was causing
2673 problems on SourceForge (``libssl.so.2`` unavailable?).
2674 - Added the "role" directive for declaring custom interpreted text
2677 * docutils/parsers/rst/directives/parts.py:
2679 - The "contents" directive does more work up-front, creating the
2680 "topic" and "title", and leaving the "pending" node for the
2681 transform. Allows earlier reference resolution; fixes subtle bug.
2683 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
2684 mappings by Jannie Hofmeyr.
2686 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
2687 mappings by Marek Blaha.
2689 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
2690 mappings by Marcelo Huerta San Martin.
2692 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2693 Portuguese mappings by Lalo Martins.
2695 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2696 mappings by Roman Suzi.
2698 * docutils/transforms/parts.py:
2700 - The "contents" directive does more work up-front, creating the
2701 "topic" and "title", and leaving the "pending" node for the
2702 transform. Allows earlier reference resolution; fixes subtle bug.
2703 - Added support for disabling of section numbering.
2705 * docutils/transforms/references.py:
2707 - Verifying that external targets are truly targets and not indirect
2708 references. This is because we are now adding a "name" attribute to
2709 references in addition to targets. Note sure if this is correct!
2710 - Added code to hook into the unknown_reference_resolvers list for a
2711 transformer in resolve_indirect_target. This allows the
2712 unknown_reference_resolvers to keep around indirect targets which
2713 docutils doesn't know about.
2714 - Added specific error message for duplicate targets.
2716 * docutils/transforms/universal.py:
2718 - Added FilterMessages transform (removes system messages below the
2719 verbosity threshold).
2720 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2721 to FinalCheckVisitor for application-specific handling of
2722 unresolvable references.
2723 - Added specific error message for duplicate targets.
2725 * docutils/writers/__init__.py:
2727 - Added assemble_parts method to the Writer class to allow for
2728 access to a documents individual parts.
2729 - Documented & set default for ``Writer.output`` attribute.
2731 * docutils/writers/html4css1.py:
2733 - Fixed unicode handling of attribute values (bug 760673).
2734 - Prevent duplication of "class" attribute values (bug report from
2736 - Improved table grid/border handling (prompted by report from Bob
2738 - Added support for table titles.
2739 - Added "<title />" for untitled docs, for XHTML conformance; thanks
2741 - Added functionality to keep track of individual parts of a document
2742 and store them in a dictionary as the "parts" attribute of the writer.
2743 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2744 - Added proper support for the "scale" attribute of the "image"
2745 element. Contributed by Brent Cook.
2746 - Added ``--initial-header-level`` option.
2747 - Fixed bug: the body_pre_docinfo segment depended on there being a
2748 docinfo; if no docinfo, the document title was incorporated into
2749 the body segment. Adversely affected the publish_parts interface.
2751 * docutils/writers/latex2e.py:
2753 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2754 about a missing file.
2755 - Added options and support: ``--compound-enumerators``,
2756 ``--section-prefix-for-enumerators``, and
2757 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
2759 - Added option ``--use-verbatim-when-possible``, to avoid
2760 problematic characters (eg, '~' in italian) in literal blocks.
2761 - It's now possible to use four section levels in the `book` and
2762 `report` LaTeX classes. The default `article` class still has
2765 * docs/config.txt: "Docutils Configuration Files", added to project.
2766 Moved config file entry descriptions from tools.txt.
2770 - Moved config file entry descriptions to config.txt.
2772 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
2775 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2776 Text Roles", added to project.
2778 * spec/rst/reStructuredText.txt:
2780 - Added description of support for <angle-bracketed> complex option
2781 arguments to option lists.
2782 - Added subsections for indented and quoted literal blocks.
2784 * test: Continually adding & updating tests.
2786 - Added test/test_settings.py & test/data/config_*.txt support
2788 - Added test/test_writers/test_htmlfragment.py.
2790 * test/DocutilsTestSupport.py:
2792 - Refactored LaTeX publisher test suite/case class names to make
2793 testing other writers easier.
2794 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2795 to test the processing of HTML fragments which use the new
2796 publish_parts convenience function.
2798 * tools/buildhtml.py:
2800 - Added support for the "--prune" option.
2801 - Removed dependency on pep2html.py; plaintext PEPs no longer
2804 * tools/docutils.conf:
2806 - Updated for configuration file reorganization.
2808 * tools/rst2html.py:
2810 - copied from tools/html.py
2814 - added a 'scripts' section to configuration
2815 - added 'tools/rst2html.py' to the scripts section
2818 Release 0.3 (2003-06-24)
2819 ========================
2823 * Renamed "attribute" to "option" for directives/extensions.
2825 * Renamed transform method "transform" to "apply".
2827 * Renamed "options" to "settings" for runtime settings (as set by
2828 command-line options). Sometimes "option" (singular) became
2829 "settings" (plural). Some variations below:
2831 - document.options -> document.settings (stored in other objects as
2833 - option_spec -> settings_spec (not directives though)
2834 - OptionSpec -> SettingsSpec
2835 - cmdline_options -> settings_spec
2836 - relative_path_options -> relative_path_settings
2837 - option_default_overrides -> settings_default_overrides
2838 - Publisher.set_options -> Publisher.get_settings
2842 * COPYING.txt: Added "Public Domain Dedication".
2844 * FAQ.txt: Frequently asked questions, added to project.
2848 - Updated with PyPI Trove classifiers.
2849 - Conditional installation of third-party modules.
2851 * docutils/__init__.py:
2853 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2854 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2855 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2856 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2857 option and its effect on the PEP template & writer.
2858 - Bumped version to 0.2.4 due to changes to the PEP template &
2860 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2861 - Added ``TransformSpec`` class for new transform system.
2862 - Bumped version to 0.2.6 for API changes (renaming).
2863 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2864 convenience functions.
2865 - Added ``Component.component_type`` attribute.
2866 - Bumped version to 0.2.8 because of the internal parser switch from
2867 plain lists to the docutils.statemachine.StringList objects.
2868 - Bumped version to 0.2.9 because of the frontend.py API changes.
2869 - Bumped version to 0.2.10 due to changes to the project layout
2870 (third-party modules removed from the "docutils" package), and
2871 signature changes in ``io.Input``/``io.Output``.
2872 - Changed version to 0.3.0 for release.
2876 - Made ``publish()`` a bit more convenient.
2877 - Generalized ``Publisher.set_io``.
2878 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2879 parameters; improved its docstring.
2880 - Added ``publish_file()`` and ``publish_string()``.
2881 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2883 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2884 "--dump-transforms" hidden options.
2885 - Added ``Publisher.apply_transforms()`` method.
2886 - Added ``Publisher.set_components()`` method; support for
2887 ``publish_*()`` conveninece functions.
2888 - Moved config file processing to docutils/frontend.py.
2889 - Added support for exit status ("exit_level" setting &
2890 ``enable_exit`` parameter for Publisher.publish() and convenience
2893 * docutils/frontend.py:
2895 - Check for & exit on identical source & destination paths.
2896 - Fixed bug with absolute paths & "--config".
2897 - Set non-command-line defaults in ``OptionParser.__init__()``:
2898 ``_source`` & ``_destination``.
2899 - Distributed ``relative_path_settings`` to components; updated
2900 ``OptionParser.populate_from_components()`` to combine it all.
2901 - Require list of keys in ``make_paths_absolute`` (was implicit in
2902 global ``relative_path_settings``).
2903 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2904 "--dump-settings", and "--dump-transforms" hidden options.
2905 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2906 code, replaced with correct code.
2907 - Added validation functionality for config files.
2908 - Added "--error-encoding" option/setting, "_disable_config"
2910 - Added encoding validation; updated "--input-encoding" and
2911 "--output-encoding"; added "--error-encoding-error-handler" and
2912 "--output-encoding-error-handler".
2913 - Moved config file processing from docutils/core.py.
2914 - Updated ``OptionParser.populate_from_components`` to handle new
2915 ``SettingsSpec.settings_defaults`` dict.
2916 - Added support for "-" => stdin/stdout.
2917 - Added "exit_level" setting ("--exit" option).
2921 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2922 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2923 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2924 - ``FileOutput.write()`` now returns the encoded output string.
2925 - Try to get path/stream name automatically in ``FileInput`` &
2927 - Added defaults for source & destination paths.
2928 - Allow for Unicode I/O with an explicit "unicode" encoding.
2929 - Added ``Output.encode()``.
2930 - Removed dependency on runtime settings; pass encoding directly.
2931 - Recognize Unicode strings in ``Input.decode()``.
2932 - Added support for output encoding error handlers.
2934 * docutils/nodes.py:
2936 - Added "Invisible" element category class.
2937 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2938 modification during a traversal.
2939 - Added element classes: ``line_block``, ``generated``, ``address``,
2940 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2941 ``superscript``, ``subscript``, ``inline``
2942 - Added support for lists of nodes to ``Element.insert()``.
2943 - Fixed parent linking in ``Element.replace()``.
2944 - Added new abstract superclass ``FixedTextElement``; adds
2945 "xml:space" attribute.
2946 - Added support for "line" attribute of ``system_message`` nodes.
2947 - Added support for the observer pattern from ``utils.Reporter``.
2948 Added ``parse_messages`` and ``transform_messages`` attributes to
2949 ``document``, removed ``messages``. Added ``note_parse_message``
2950 and ``note_transform_message`` methods.
2951 - Added support for improved diagnostics:
2953 - Added "document", "source", and "line" internal attributes to
2954 ``Node``, set by ``Node.setup_child()``.
2955 - Converted variations on ``node.parent = self`` to
2956 ``self.setup_child(node)``.
2957 - Added ``document.current_source`` & ``.current_line``
2958 attributes, and ``.note_source`` observer method.
2959 - Changed "system_message" output to GNU-Tools format.
2961 - Added a "rawsource" attribute to the ``Text`` class, for text
2962 before backslash-escape resolution.
2963 - Support for new transform system.
2964 - Reworked ``pending`` element.
2965 - Fixed XML DOM bug (SF #660611).
2966 - Removed the ``interpeted`` element class and added
2967 ``title_reference``, ``abbreviation``, ``acronym``.
2968 - Made substitutions case-sensitive-but-forgiving; moved some code
2970 - Fixed Unicode bug on element attributes (report: William Dode).
2972 * docutils/optik.py: Removed from project; replaced with
2973 extras/optparse.py and extras/textwrap.py. These will be installed
2974 only if they're not already present in the Python installation.
2976 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2977 only if it's not already present in the Python installation.
2979 * docutils/statemachine.py:
2981 - Factored out ``State.add_initial_transitions()`` so it can be
2983 - Converted whitespace-specific "blank" and "indent" transitions
2984 from special-case code to ordinary transitions: removed
2985 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2986 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2987 ``ws_initial_transitions`` attributes.
2988 - Removed ``State.match_transition()`` after merging it into
2990 - Added ``StateCorrection`` exception.
2991 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2992 (moved ``TransitionCorrection`` support there too.)
2993 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2994 ``EOFError`` instead of ``IndexError``.
2995 - Added ``State.no_match`` method.
2996 - Added support for the Observer pattern, triggered by input line
2998 - Added ``strip_top`` parameter to
2999 ``StateMachineWS.get_first_known_indented``.
3000 - Made ``context`` a parameter to ``StateMachine.run()``.
3001 - Added ``ViewList`` & ``StringList`` classes;
3002 ``extract_indented()`` becomes ``StringList.get_indented()``.
3003 - Added ``StateMachine.insert_input()``.
3004 - Fixed ViewList slice handling for Python 2.3. Patch from (and
3005 thanks to) Fred Drake.
3007 * docutils/utils.py:
3009 - Added a ``source`` attribute to Reporter instances and
3010 ``system_message`` elements.
3011 - Added an observer pattern to ``utils.Reporter`` to keep track of
3013 - Fixed bugs in ``relative_path()``.
3014 - Added support for improved diagnostics.
3015 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
3016 - Added support for encoding Reporter stderr output, and encoding
3018 - Reporter keeps track of the highest level system message yet
3021 * docutils/languages: Fixed bibliographic field language lookups.
3023 * docutils/languages/es.py: Added to project; Spanish mappings by
3024 Marcelo Huerta San Martin.
3026 * docutils/languages/fr.py: Added to project; French mappings by
3029 * docutils/languages/it.py: Added to project; Italian mappings by
3032 * docutils/languages/sk.py: Added to project; Slovak mappings by
3035 * docutils/parser/__init__.py:
3037 - Added ``Parser.finish_parse()`` method.
3039 * docutils/parser/rst/__init__.py:
3041 - Added options: "--pep-references", "--rfc-references",
3042 "--tab-width", "--trim-footnote-reference-space".
3044 * docutils/parsers/rst/states.py:
3046 - Changed "title under/overline too short" system messages from INFO
3047 to WARNING, and fixed its insertion location.
3048 - Fixed enumerated list item parsing to allow paragraphs & section
3049 titles to begin with enumerators.
3050 - Converted system messages to use the new "line" attribute.
3051 - Fixed a substitution reference edge case.
3052 - Added support for "--pep-references" and "--rfc-references"
3053 options; reworked ``Inliner`` code to make customization easier.
3054 - Removed field argument parsing.
3055 - Added support for short section title over/underlines.
3056 - Fixed "simple reference name" regexp to ignore text like
3057 "object.__method__"; not an anonymous reference.
3058 - Added support for improved diagnostics.
3059 - Reworked directive API, based on Dethe Elza's contribution. Added
3060 ``Body.parse_directive()``, ``.parse_directive_options()``,
3061 ``.parse_directive_arguments()`` methods.
3062 - Added ``ExtensionOptions`` class, to parse directive options
3063 without parsing field bodies. Factored
3064 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
3065 ``ExtensionOptions``.
3066 - Improved definition list term/classifier parsing.
3067 - Added warnings for unknown directives.
3068 - Renamed ``Stuff`` to ``Struct``.
3069 - Now flagged as errors: transitions at the beginning or end of
3070 sections, empty sections (except title), and empty documents.
3071 - Updated for ``statemachine.StringList``.
3072 - Enabled recognition of schemeless email addresses in targets.
3073 - Added support for embedded URIs in hyperlink references.
3074 - Added backslash-escapes to inline markup end-string suffix.
3075 - Added support for correct interpreted text processing.
3076 - Fixed nested title parsing (topic, sidebar directives).
3077 - Added special processing of backslash-escaped whitespace (idea
3078 from David Abrahams).
3079 - Made substitutions case-sensitive-but-forgiving; moved some code
3080 to ``docutils.nodes``.
3081 - Added support for block quote attributions.
3082 - Added a kludge to work-around a conflict between the bubble-up
3083 parser strategy and short titles (<= 3 char-long over- &
3084 underlines). Fixes SF bug #738803 "infinite loop with multiple
3085 titles" submitted by Jason Diamond.
3086 - Added explicit interpreted text roles for standard inline markup:
3087 "emphasis", "strong", "literal".
3088 - Implemented "superscript" and "subscript" interpreted text roles.
3089 - Added initial support for "abbreviation" and "acronym" roles;
3091 - Added support for "--trim-footnote-reference-space" option.
3092 - Optional space before colons in directives & hyperlink targets.
3094 * docutils/parsers/rst/tableparser.py:
3096 - Fixed a bug that was producing unwanted empty rows in "simple"
3098 - Detect bad column spans in "simple" tables.
3100 * docutils/parsers/rst/directives: Updated all directive functions to
3103 * docutils/parsers/rst/directives/__init__.py:
3105 - Added ``flag()``, ``unchanged()``, ``path()``,
3106 ``nonnegative_int()``, ``choice()``, and ``class_option()``
3107 directive option helper functions.
3108 - Added warnings for unknown directives.
3109 - Return ``None`` for missing directives.
3110 - Added ``register_directive()``, thanks to William Dode and Paul
3113 * docutils/parsers/rst/directives/admonitions.py:
3115 - Added "admonition" directive.
3117 * docutils/parsers/rst/directives/body.py: Added to project. Contains
3118 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
3119 "parsed-literal", "rubric", "epigraph", "highlights" and
3120 "pull-quote" directives.
3122 * docutils/parsers/rst/directives/images.py:
3124 - Added an "align" attribute to the "image" & "figure" directives
3125 (by Adam Chodorowski).
3126 - Added "class" option to "image", and "figclass" to "figure".
3128 * docutils/parsers/rst/directives/misc.py:
3130 - Added "include", "raw", and "replace" directives, courtesy of
3132 - Added "unicode" and "class" directives.
3134 * docutils/parsers/rst/directives/parts.py:
3136 - Added the "sectnum" directive; by Dmitry Jemerov.
3137 - Added "class" option to "contents" directive.
3139 * docutils/parsers/rst/directives/references.py: Added to project.
3140 Contains the "target-notes" directive.
3142 * docutils/parsers/rst/languages/__init__.py:
3144 - Return ``None`` from get_language() for missing language modules.
3146 * docutils/parsers/rst/languages/de.py: Added to project; German
3147 mappings by Engelbert Gruber.
3149 * docutils/parsers/rst/languages/en.py:
3151 - Added interpreted text roles mapping.
3153 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
3154 mappings by Marcelo Huerta San Martin.
3156 * docutils/parsers/rst/languages/fr.py: Added to project; French
3157 mappings by William Dode.
3159 * docutils/parsers/rst/languages/it.py: Added to project; Italian
3160 mappings by Nicola Larosa.
3162 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
3163 mappings by Miroslav Vasko.
3165 * docutils/readers/__init__.py:
3167 - Added support for the observer pattern from ``utils.Reporter``, in
3168 ``Reader.parse`` and ``Reader.transform``.
3169 - Removed ``Reader.transform()`` method.
3170 - Added default parameter values to ``Reader.__init__()`` to make
3171 instantiation easier.
3172 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
3174 * docutils/readers/pep.py:
3176 - Added the ``peps.TargetNotes`` transform to the Reader.
3177 - Removed PEP & RFC reference detection code; moved to
3178 parsers/rst/states.py as options (enabled here by default).
3179 - Added support for pre-acceptance PEPs (no PEP number yet).
3180 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
3183 * docutils/readers/python: Python Source Reader subpackage added to
3184 project, including preliminary versions of:
3187 - moduleparser.py: Parser for Python modules.
3189 * docutils/transforms/__init__.py:
3191 - Added ``Transformer`` class and completed transform reform.
3192 - Added unknown_reference_resolvers list for each transformer. This list holds
3193 the list of functions provided by each component of the transformer that
3194 help resolve references.
3196 * docutils/transforms/frontmatter.py:
3198 - Improved support for generic fields.
3199 - Fixed bibliographic field language lookups.
3201 * docutils/transforms/misc.py: Added to project. Miscellaneous
3204 * docutils/transforms/parts.py:
3206 - Moved the "id" attribute from TOC list items to the references
3207 (``Contents.build_contents()``).
3208 - Added the ``SectNum`` transform; by Dmitry Jemerov.
3209 - Added "class" attribute support to ``Contents``.
3211 * docutils/transforms/peps.py:
3213 - Added ``mask_email()`` function, updating to pep2html.py's
3215 - Linked "Content-Type: text/x-rst" to PEP 12.
3216 - Added the ``TargetNotes`` PEP-specific transform.
3217 - Added ``TargetNotes.cleanup_callback``.
3218 - Added title check to ``Headers``.
3220 * docutils/transforms/references.py:
3222 - Added the ``TargetNotes`` generic transform.
3223 - Split ``Hyperlinks`` into multiple transforms.
3224 - Fixed bug with multiply-indirect references (report: Bruce Smith).
3225 - Added check for circular indirect references.
3226 - Made substitutions case-sensitive-but-forgiving.
3228 * docutils/transforms/universal.py:
3230 - Added support for the "--expose-internal-attributes" option.
3231 - Removed ``Pending`` transform classes & data.
3233 * docutils/writers/__init__.py:
3235 - Removed ``Writer.transform()`` method.
3237 * docutils/writers/docutils-xml.py:
3239 - Added XML and doctype declarations.
3240 - Added "--no-doctype" and "--no-xml-declaration" options.
3242 * docutils/writers/html4css1.py:
3244 - "name" attributes only on these tags: a, applet, form, frame,
3246 - Added "name" attribute to <a> in section titles for Netscape 4
3247 support (bug report: Pearu Peterson).
3248 - Fixed targets (names) on footnote, citation, topic title,
3249 problematic, and system_message nodes (for Netscape 4).
3250 - Changed field names from "<td>" to "<th>".
3251 - Added "@" to "@" encoding to thwart address harvesters.
3252 - Improved the vertical whitespace optimization; ignore "invisible"
3253 nodes (targets, comments, etc.).
3254 - Improved inline literals with ``<span class="pre">`` around chunks
3255 of text and `` `` for runs of spaces.
3256 - Improved modularity of output; added ``self.body_pre_docinfo`` and
3257 ``self.docinfo`` segments.
3258 - Added support for "line_block", "address" elements.
3259 - Improved backlinks (footnotes & system_messages).
3260 - Improved system_message output.
3261 - Redefined "--stylesheet" as containing an invariant URL, used
3262 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
3264 - Added "--footnote-references" option (superscript or brackets).
3265 - Added "--compact-lists" and "--no-compact-lists" options.
3266 - Added "--embed-stylesheet" and "--link-stylesheet" options;
3267 factored out ``HTMLTranslator.get_stylesheet_reference()``.
3268 - Improved field list rendering.
3269 - Added Docutils version to "generator" meta tag.
3270 - Fixed a bug with images; they must be inline, so wrapped in <p>.
3271 - Improved layout of <pre> HTML source.
3272 - Fixed attribute typo on <colspec>.
3273 - Refined XML prologue.
3274 - Support for no stylesheet.
3275 - Removed "interpreted" element support.
3276 - Added support for "title_reference", "sidebar", "attribution",
3277 "rubric", and generic "admonition" elements.
3278 - Added "--attribution" option.
3279 - Added support for "inline", "subscript", "superscript" elements.
3280 - Added initial support for "abbreviation" and "acronym";
3283 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3287 - Double quotes in literal blocks (special treatment for de/ngerman).
3288 - Added '--hyperlink-color' option ('0' turns off coloring of links).
3289 - Added "--attribution" option.
3290 - Right align attributions.
3292 * docutils/writers/pep_html.py:
3294 - Parameterized output encoding in PEP template.
3295 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3296 - Redefined "--pep-stylesheet" as containing an invariant URL, used
3297 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
3299 - Added an override on the "--footnote-references" option.
3300 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3301 - Added Docutils version to "generator" meta tag.
3302 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3306 - Added a "silent" setting for ``buildhtml.py``.
3307 - Added a "Getting Help" section.
3308 - Rearranged the structure.
3309 - Kept up to date, with new settings, command-line options etc.
3310 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3311 - Converted settings table into a definition list.
3313 * docs/rst/quickstart.txt:
3315 - Added a table of contents.
3316 - Added feedback information.
3317 - Added mention of minimum section title underline lengths.
3318 - Removed the 4-character minimum for section title underlines.
3320 * docs/rst/quickref.html:
3322 - Added a "Getting Help" section.
3323 - Added a style to make section title backlinks more subtle.
3324 - Added mention of minimum section title underline lengths.
3325 - Removed the 4-character minimum for section title underlines.
3327 * extras: Directory added to project; contains third-party modules
3328 that Docutils depends on (optparse, textwrap, roman). These are
3329 only installed if they're not already present.
3331 * licenses: Directory added to project; contains copies of license
3332 files for non-public-domain files.
3336 - Changed the focus. It's about DTD elements: structural
3337 relationships, semantics, and external (public) attributes. Not
3338 about the element class library.
3339 - Moved some implementation-specific stuff into ``docutils.nodes``
3341 - Wrote descriptions of all common attributes and parameter
3342 entities. Filled in introductory material.
3343 - Working through the element descriptions: 55 down, 37 to go.
3344 - Removed "Representation of Horizontal Rules" to
3345 spec/rst/alternatives.txt.
3347 * spec/docutils.dtd:
3349 - Added "generated" inline element.
3350 - Added "line_block" body element.
3351 - Added "auto" attribute to "title".
3352 - Changed content models of "literal_block" and "doctest_block" to
3354 - Added ``%number;`` attribute type parameter entity.
3355 - Changed ``%structural.elements;`` to ``%section.elements``.
3356 - Updated attribute types; made more specific.
3357 - Added "address" bibliographic element.
3358 - Added "line" attribute to ``system_message`` element.
3359 - Removed "field_argument" element; "field_name" may contain
3360 multiple words and whitespace.
3361 - Changed public identifier to docutils.sf.net.
3362 - Removed "interpreted" element; added "title_reference",
3363 "abbreviation", "acronym".
3364 - Removed "refuri" attribute from "footnote_reference" and
3365 "citation_reference".
3366 - Added "sidebar", "rubric", "attribution", "admonition",
3367 "superscript", "subscript", and "inline" elements.
3369 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3371 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3373 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3375 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3378 * spec/transforms.txt: Added to project.
3380 * spec/howto: Added subdirectory, for developer how-to docs.
3382 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
3383 Elza, edited & extended by David Goodger.
3385 * spec/howto/i18n.txt: Docutils Internationalization. Added to
3388 * spec/rst/alternatives.txt:
3390 - Added "Doctree Representation of Transitions" from
3392 - Updated "Inline External Targets" & closed the debate.
3393 - Added ideas for interpreted text syntax extensions.
3394 - Added "Nested Inline Markup" section.
3396 * spec/rst/directives.txt:
3398 - Added directives: "topic", "sectnum", "target-notes",
3399 "line-block", "parsed-literal", "include", "replace", "sidebar",
3400 "admonition", "rubric", "epigraph", "highlights", "unicode" and
3402 - Formalized descriptions of directive details.
3403 - Added an "align" attribute to the "image" & "figure" directives
3404 (by Adam Chodorowski).
3405 - Added "class" options to "topic", "sidebar", "line-block",
3406 "parsed-literal", "contents", and "image"; and "figclass" to
3409 * spec/rst/interpreted.txt: Added to project. Descriptions of
3410 interpreted text roles.
3412 * spec/rst/introduction.txt:
3414 - Added pointers to material for new users.
3416 * spec/rst/reStructuredText.txt:
3418 - Disambiguated comments (just add a newline after the "::").
3419 - Updated enumerated list description; added a discussion of the
3420 second-line validity checking.
3421 - Updated directive description.
3422 - Added a note redirecting newbies to the user docs.
3423 - Expanded description of inline markup start-strings in non-markup
3425 - Removed field arguments and made field lists a generic construct.
3426 - Removed the 4-character minimum for section title underlines.
3427 - Clarified term/classifier delimiter & inline markup ambiguity
3429 - Added "Embedded URIs".
3430 - Updated "Interpreted Text" section.
3431 - Added "Character-Level Inline Markup" section.
3433 * test: Continually adding & updating tests.
3435 - Moved test/test_rst/ to test/test_parsers/test_rst/.
3436 - Moved test/test_pep/ to test/test_readers/test_pep/.
3437 - Added test/test_readers/test_python/.
3438 - Added test/test_writers/ (Engelbert Gruber).
3442 - Made the ``locale.setlocale()`` calls in front ends
3445 * tools/buildhtml.py:
3447 - Added "--silent" option.
3448 - Fixed bug with absolute paths & "--config".
3449 - Updated for new I/O classes.
3450 - Added some exception handling.
3451 - Separated publishers' setting defaults; prevents interference.
3452 - Updated for new ``publish_file()`` convenience function.
3454 * tools/pep-html-template:
3456 - Allow for "--embed-stylesheet".
3457 - Added Docutils version to "generator" meta tag.
3458 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3459 - Conform to XHTML spec.
3461 * tools/pep2html.py:
3463 - Made ``argv`` a parameter to ``main()``.
3464 - Added support for "Content-Type:" header & arbitrary PEP formats.
3465 - Linked "Content-Type: text/plain" to PEP 9.
3466 - Files skipped (due to an error) are not pushed onto the server.
3467 - Updated for new I/O classes.
3468 - Added ``check_requirements()`` & ``pep_type_error()``.
3469 - Added some exception handling.
3470 - Updated for new ``publish_string()`` convenience function.
3471 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3473 * tools/quicktest.py:
3475 - Added "-V"/"--version" option.
3477 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3479 * tools/unicode2rstsubs.py: Added to project. Produces character
3480 entity files (reSructuredText substitutions) from the MathML master
3483 * tools/editors: Support code for editors, added to project. Contains
3484 ``emacs/restructuredtext.el``.
3486 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3488 - Added style for chunks of inline literals.
3489 - Removed margin for first child of table cells.
3490 - Right-aligned field list names.
3491 - Support for auto-numbered section titles in TOCs.
3492 - Increased the size of inline literals (<tt>) in titles.
3493 - Restored the light gray background for inline literals.
3494 - Added support for "line_block" elements.
3495 - Added style for "address" elements.
3496 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3497 - Improved field list rendering.
3498 - Vertical whitespace improvements.
3499 - Removed "a.target" style.
3501 * tools/stylesheets/pep.css:
3503 - Fixed nested section margins.
3504 - Other changes parallel those of ``../default.css``.
3507 Release 0.2 (2002-07-31)
3508 ========================
3512 - The word "component" was being used ambiguously. From now on,
3513 "component" will be used to mean "Docutils component", as in Reader,
3514 Writer, Parser, or Transform. Portions of documents (Table of
3515 Contents, sections, etc.) will be called "document parts".
3516 - Did a grand renaming: a lot of ``verylongnames`` became
3517 ``very_long_names``.
3518 - Cleaned up imports: no more relative package imports or
3519 comma-separated lists of top-level modules.
3520 - Added support for an option values object which carries default
3521 settings and overrides (from command-line options and library use).
3522 - Added internal Unicode support, and support for both input and
3524 - Added support for the ``docutils.io.IO`` class & subclasses.
3528 * docutils/__init__.py:
3530 - Added ``ApplicationError`` and ``DataError``, for use throughout
3532 - Added ``Component`` base class for Docutils components; implements
3533 the ``supports`` method.
3534 - Added ``__version__`` (thus, ``docutils.__version__``).
3538 - Removed many keyword parameters to ``Publisher.__init__()`` and
3539 ``publish()``; bundled into an option values object. Added
3540 "argv", "usage", "description", and "option_spec" parameters for
3541 command-line support.
3542 - Added ``Publisher.process_command_line()`` and ``.set_options()``
3544 - Reworked I/O model for ``docutils.io`` wrappers.
3545 - Updated ``Publisher.set_options()``; now returns option values
3547 - Added support for configuration files (/etc/docutils.conf,
3548 ./docutils.conf, ~/.docutils).
3549 - Added ``Publisher.setup_option_parser()``.
3550 - Added default usage message and description.
3552 * docutils/frontend.py: Added to project; support for front-end
3553 (command-line) scripts. Option specifications may be augmented by
3554 components. Requires Optik (http://optik.sf.net/) for option
3555 processing (installed locally as docutils/optik.py).
3557 * docutils/io.py: Added to project; uniform API for a variety of input
3560 * docutils/nodes.py:
3562 - Added ``TreeCopyVisitor`` class.
3563 - Added a ``copy`` method to ``Node`` and subclasses.
3564 - Added a ``SkipDeparture`` exception for visitors.
3565 - Renamed ``TreePruningException`` from ``VisitorException``.
3566 - Added docstrings to ``TreePruningException``, subclasses, and
3568 - Improved docstrings.
3569 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
3570 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
3572 - Added ``decoration``, ``header``, and ``footer`` node classes, and
3573 ``PreDecorative`` mixin.
3574 - Reworked the name/id bookkeeping; to ``document``, removed
3575 ``explicit_targets`` and ``implicit_targets`` attributes, added
3576 ``nametypes`` attribute and ``set_name_id_map`` method.
3577 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
3579 - Added ``document.has_name()`` method.
3580 - Fixed DOM generation for list-attributes.
3581 - Added category class ``Labeled`` (used by footnotes & citations).
3582 - Added ``Element.set_class()`` method (sets "class" attribute).
3584 * docutils/optik.py: Added to project. Combined from the Optik
3585 package, with added option groups and other modifications. The use
3586 of this module is probably only temporary.
3588 * docutils/statemachine.py:
3590 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
3591 - Added underscores to improve many awkward names.
3592 - In ``string2lines()``, changed whitespace normalizing translation
3593 table to regexp; restores Python 2.0 compatibility with Unicode.
3595 * docutils/urischemes.py:
3597 - Filled in some descriptions.
3598 - Added "shttp" scheme.
3600 * docutils/utils.py:
3602 - Added ``clean_rcs_keywords`` function (moved from
3603 docutils/transforms/frontmatter.py
3604 ``DocInfo.filter_rcs_keywords``).
3605 - Added underscores to improve many awkward names.
3606 - Changed names of Reporter's thresholds:
3607 warning_level -> report_level; error_level -> halt_level.
3608 - Moved ``utils.id()`` to ``nodes.make_id()``.
3609 - Added ``relative_path(source, target)``.
3611 * docutils/languages/de.py: German mappings; added to project. Thanks
3612 to Gunnar Schwant for the translations.
3614 * docutils/languages/en.py: Added "Dedication" bibliographic field
3617 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
3620 * docutils/parsers/rst/states.py:
3622 - Added underscores to improve many awkward names.
3623 - Added RFC-2822 header support.
3624 - Extracted the inline parsing code from ``RSTState`` to a separate
3625 class, ``Inliner``, which will allow easy subclassing.
3626 - Made local bindings for ``memo`` container & often-used contents
3627 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
3628 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
3629 - Added ``MarkupMismatch`` exception; for late corrections.
3630 - Added ``-/:`` characters to inline markup's start string prefix,
3631 ``/`` to end string suffix.
3632 - Fixed a footnote bug.
3633 - Fixed a bug with literal blocks.
3634 - Applied patch from Simon Budig: simplified regexps with symbolic
3635 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
3636 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
3637 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
3638 - Allowed non-ASCII in "simple names" (directive names, field names,
3640 - Converted ``Inliner.patterns.initial`` to be dynamically built
3641 from parts with ``build_regexp()`` function.
3642 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
3643 - Updated docstrings.
3644 - Changed "table" to "grid_table"; added "simple_table" support.
3646 * docutils/parsers/rst/tableparser.py:
3648 - Changed ``TableParser`` to ``GridTableParser``.
3649 - Added ``SimpleTableParser``.
3650 - Refactored naming.
3652 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
3653 a fallback language for directive names.
3655 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
3656 directive to use a ``pending`` element, used only by HTML writers.
3658 * docutils/parsers/rst/directives/parts.py: Renamed from
3661 - Added "backlinks" attribute to "contents" directive.
3663 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
3664 project by Adam Chodorowski.
3666 * docutils/readers/__init__.py: Gave Readers more control over
3667 choosing and instantiating Parsers.
3669 * docutils/readers/pep.py: Added to project; for PEP processing.
3671 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
3672 requires a ``component`` parameter.
3674 * docutils/transforms/components.py: Added to project; transforms
3675 related to Docutils components.
3677 * docutils/transforms/frontmatter.py:
3679 - In ``DocInfo.extract_authors``, check for a single "author" in an
3680 "authors" group, and convert it to a single "author" element.
3681 - Added support for "Dedication" and generic bibliographic fields.
3683 * docutils/transforms/peps.py: Added to project; PEP-specific.
3685 * docutils/transforms/parts.py: Renamed from old components.py.
3687 - Added filter for `Contents`, to use alt-text for inline images,
3688 and to remove inline markup that doesn't make sense in the ToC.
3689 - Added "name" attribute to TOC topic depending on its title.
3690 - Added support for optional TOC backlinks.
3692 * docutils/transforms/references.py: Fixed indirect target resolution
3693 in ``Hyperlinks`` transform.
3695 * docutils/transforms/universal.py:
3697 - Changed ``Messages`` transform to properly filter out system
3698 messages below the warning threshold.
3699 - Added ``Decorations`` transform (support for ``--generator``,
3700 ``--date``, ``--time``, ``--source-link`` options).
3702 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3703 Engelbert Gruber's PDF writer.
3705 * docutils/writers/html4css1.py:
3707 - Made XHTML-compatible (switched to lowercase element & attribute
3708 names; empty tag format).
3709 - Escape double-dashes in comment text.
3710 - Improved boilerplate & modularity of output.
3711 - Exposed modular output in Writer class.
3712 - Added a "generator" meta tag to <head>.
3713 - Added support for the ``--stylesheet`` option.
3714 - Added support for ``decoration``, ``header``, and ``footer``
3716 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3717 translation table to regexp; restores Python 2.0 compatibility
3719 - Added the translator class as instance variable to the Writer, to
3720 make it easily subclassable.
3721 - Improved option list spacing (thanks to Richard Jones).
3722 - Modified field list output.
3723 - Added backlinks to footnotes & citations.
3724 - Added percentage widths to "<col>" tags (from colspec).
3725 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3726 "<span>" changed to "<var>".
3727 - Inline literals: "<code>" changed to "<tt>".
3728 - Many changes to optimize vertical space: compact simple lists etc.
3729 - Add a command-line options & directive attributes to control TOC
3730 and footnote/citation backlinks.
3731 - Added support for optional footnote/citation backlinks.
3732 - Added support for generic bibliographic fields.
3733 - Identify backrefs.
3734 - Relative URLs for stylesheet links.
3736 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3737 PEPs (subclass of ``html4css1.Writer``).
3739 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3741 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3742 of the Docutils internal doctree in XML.
3744 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3748 - Changed the title to "The Docutils Document Tree".
3749 - Added "Hyperlink Bookkeeping" section.
3751 * spec/docutils.dtd:
3753 - Added ``decoration``, ``header``, and ``footer`` elements.
3754 - Brought ``interpreted`` element in line with the parser: changed
3755 attribute "type" to "role", added "position".
3756 - Added support for generic bibliographic fields.
3758 * spec/notes.txt: Continual updates. Added "Project Policies".
3760 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
3763 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3765 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
3766 mailing list discussions.
3768 * spec/pep-0287.txt:
3770 - Renamed to "reStructuredText Docstring Format".
3772 - Reworked Q&A as an enumerated list.
3773 - Converted to reStructuredText format.
3775 * spec/pysource.dtd:
3777 - Reworked structural elements, incorporating ideas from Tony Ibbs.
3779 * spec/pysource.txt: Removed from project. Moved much of its contents
3782 * spec/rst/alternatives.txt:
3784 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3785 - Added "Inline External Targets" section.
3787 * spec/rst/directives.txt:
3789 - Added "backlinks" attribute to "contents" directive.
3791 * spec/rst/problems.txt:
3793 - Updated the Enumerated List Markup discussion.
3794 - Added new alternative table markup syntaxes.
3796 * spec/rst/reStructuredText.txt:
3798 - Clarified field list usage.
3799 - Updated enumerated list description.
3800 - Clarified purpose of directives.
3801 - Added ``-/:`` characters to inline markup's start string prefix,
3802 ``/`` to end string suffix.
3803 - Updated "Authors" bibliographic field behavior.
3804 - Changed "inline hyperlink targets" to "inline internal targets".
3805 - Added "simple table" syntax to supplement the existing but
3806 newly-renamed "grid tables".
3807 - Added cautions for anonymous hyperlink use.
3808 - Added "Dedication" and generic bibliographic fields.
3810 * test: Made test modules standalone (subdirectories became packages).
3812 * test/DocutilsTestSupport.py:
3814 - Added support for PEP extensions to reStructuredText.
3815 - Added support for simple tables.
3816 - Refactored naming.
3818 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3820 - Now supports true packages containing test modules
3821 (``__init__.py`` files required); fixes duplicate module name bug.
3823 * test/test_pep/: Subpackage added to project; PEP testing.
3825 * test/test_rst/test_SimpleTableParser.py: Added to project.
3829 - Updated html.py and publish.py front-end tools to use the new
3830 command-line processing facilities of ``docutils.frontend``
3831 (exposed in ``docutils.core.Publisher``), reducing each to just a
3833 - Added ``locale.setlocale()`` calls to front-end tools.
3835 * tools/buildhtml.py: Added to project; batch-generates .html from all
3836 the .txt files in directories and subdirectories.
3838 * tools/default.css:
3840 - Added support for ``header`` and ``footer`` elements.
3841 - Added styles for "Dedication" topics (biblio fields).
3843 * tools/docutils.conf: A configuration file; added to project.
3845 * tools/docutils-xml.py: Added to project.
3847 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3849 * tools/pep-html-template: Added to project.
3851 * tools/pep2html.py: Added to project from Python (nondist/peps).
3852 Added support for Docutils (reStructuredText PEPs).
3854 * tools/quicktest.py:
3856 - Added the ``--attributes`` option, hacked a bit.
3857 - Added a second command-line argument (output file); cleaned up.
3859 * tools/stylesheets/: Subdirectory added to project.
3861 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3864 Release 0.1 (2002-04-20)
3865 ========================
3867 This is the first release of Docutils, merged from the now inactive
3868 reStructuredText__ and `Docstring Processing System`__ projects. For
3869 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3870 `DPS HISTORY`__ files.
3872 __ http://structuredtext.sourceforge.net/
3873 __ http://docstring.sourceforge.net/
3874 __ http://structuredtext.sourceforge.net/HISTORY.html
3875 __ http://docstring.sourceforge.net/HISTORY.html
3877 General changes: renamed 'dps' package to 'docutils'; renamed
3878 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3879 the test suites (reStructuredText's test/test_states renamed to
3880 test/test_rst); and all modifications required to make it all work.
3882 * docutils/parsers/rst/states.py:
3884 - Improved diagnostic system messages for missing blank lines.
3885 - Fixed substitution_reference bug.
3891 indent-tabs-mode: nil
3892 sentence-end-double-space: t