1 .. include:: docs/header0.txt
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
11 :Web site: https://docutils.sourceforge.io/
12 :Copyright: This document has been placed in the public domain.
22 - Drop support for Python 3.7 and 3.8.
23 - Updated build system to use Flit_ (patch #186 by Adam Turner).
25 - Provide ``rst2*`` "console_scripts" `entry points`_
26 (without the ``.py`` extension) instead of installing the
27 ``rst2*.py`` front end tools in the binary PATH.
29 .. _Flit: https://github.com/pypa/flit/
31 * docs/ref/docutils.dtd
33 - The <image> element accepts a new attribute "loading".
35 - Fix definitions (no change to actual behaviour):
37 * The <math_block> element uses the attribute "xml:space".
38 * The <raw> element may contain text only (no inline elements).
40 * docutils/frontend.py
42 - Allow `validate_*()` functions to be called with just the "value"
43 argument but keep the legacy interface for use with optparse.
44 - New function `frontend.validate_math_output()`.
48 - Simpler and more secure `input encoding`_ default behaviour:
50 Do not use the locale encoding as fallback if Python is started in
51 `UTF-8 mode`_. Stop using "latin1" as second fallback.
53 Remove BOM (U+FEFF ZWNBSP at start of data) only if the "input_encoding"
54 configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'.
55 Do not remove other ZWNBSPs.
57 .. _UTF-8 mode: https://docs.python.org/3/library/os.html#utf8-mode
58 .. _input encoding: docs/api/publisher.html#encodings
60 - Auto-close `FileInput.source` in case of reading/decoding errors.
62 * docutils/languages/, docutils/parsers/rst/languages/
64 - Mark/Fix mistranslated localizations of the "admonition" directive
65 name. In Docutils, "admonition" is used as a generic term for
66 "advice"/"advisory"/"remark", not a reprimand.
67 - Add support for Georgian language (patch #204 by Temuri Doghonadze).
68 - Update/complete Catalan translations (patch #203 by Antoni Bella Pérez).
72 - Remove compatibility hacks `nodes.reprunicode` and `nodes.ensure_str()`.
74 * docutils/parsers/rst/directives/images.py
76 - New "image" directive option "loading".
78 * docutils/parsers/rst/directives/tables.py
80 - Use the same CSV format for the ``:header:`` option and the main data
81 of the "csv-table" directive.
83 - Move `parsers.rst.directives.Table.process_header_option()` method
84 to `parsers.rst.directives.CSVTable`.
86 * docutils/parsers/rst/states.py
88 - Don't split inside "< >" when parsing "option groups" (fixes bug #474).
90 * docutils/parsers/rst/directives/misc.py,
91 docutils/parsers/rst/directives/tables.py
93 - Consider the new root_prefix_ setting when including files with
94 "include", "raw", or "csv-table" directives.
96 * docutils/utils/math/*
98 - Use custom exception `utils.math.MathError` instead of
99 abusing `SyntaxError` for LaTeX math syntax errors.
100 - Unify interface of LaTeX -> MathML conversion functions.
101 Improve error reporting.
102 - Sort ℏ (`\hslash`) as "mathord", not "mathalpha".
104 * docutils/utils/math/latex2mathml.py
106 - Generate "MathML Core" to fix rendering with Chromium/Android.
108 Use CSS rules instead of the deprecated "columnalign" attribute
109 to style <mtable> as "align" environment.
111 Use Mathematical Alphanumeric Symbols instead of <mstyle> with
112 "mathvariant" attribute.
114 - Use <mi> instead of <mo> for character class "mathord".
116 - Support "aligned" environment.
118 - Eliminate side-effect on later import of "tex2unichar".
120 * docutils/utils/math/mathml_elements.py
122 - New module defining MathML element classes
123 (outsourced from latex2mathml.py).
124 - Base MathML element classes on `xml.etree.ElementTree`.
126 * docutils/utils/roman.py
128 - Update to version `1.4 <https://pypi.org/project/roman/4.1/>`__.
129 Fixes feature-request #95 (license is now ZPL 2.1).
131 * docutils/utils/smartquotes.py
133 - Pre-compile regexps once, not with every call of `educateQuotes()`
134 (patch #206 by Chris Sewell).
135 - Simplify regexps; skip replacement rules if there is nothing to replace.
137 * docutils/writers/html4css1/__init__.py
139 - Support video inclusion via ``<object>`` tags.
141 * docutils/writers/html5_polyglot/\*.css
143 - Move MathML styles to "minimal.css" (required for correct rendering).
144 - Highlight heading of target section also with explicit hyperlink target.
146 * docutils/writers/_html_base.py
148 - Stop setting the "footnote-reference" class value for footnote references.
149 Since 0.18, you can use the CSS selector ``[role="doc-noteref"]``.
150 - Support reading/embedding images also with "file:" URI.
151 - Warn, if image scaling fails because the image file cannot be read.
152 - Support video inclusion via ``<video>`` tags
153 (moved here from writers/html5_polyglot/__init__.py).
154 - New auxiliary method `HTMLTranslator.uri2imagepath()` ensures the
155 image file can also be read when CWD and output directory differ.
156 - Consider the root_prefix_ setting when converting an image URI
157 to a local filesystem path.
158 - New `\<image>`_ attribute "loading" overrides image_loading_ setting.
159 - Embed SVG images as ``<svg>`` instead of data-URI.
160 Fixes feature-request #100.
161 - Generate system messages for errors/warnings during the writing stage
162 (image transformations, math content conversion, ...).
163 - Close ``<dt>`` element in `depart_term()` to allow a
164 "definition_list_item" with multiple "terms" (cf. feature-request #60).
165 - Link to the document "#top" from the ToC heading
166 (unless toc_backlinks_ is False).
168 * docutils/writers/latex2e/__init__.py
170 - Fix placement of hyperlink target (label) for tables (bug #440).
171 - More compact LaTeX source for option-lists and description-lists
172 (no change in output).
174 * docutils/writers/manpage.py
176 - Add multiple definition list term support, see feature #60.
177 - Add preprocessor hinting tbl first line, see bug #477.
178 - Change tbl-Tables using box option, see bug #475.
179 - Apply literal block patch #205. Use ``.EE`` and ``.EX`` macros.
180 Thanks to G. Branden Robinson.
182 * docutils/writers/odf_odt/__init__.py
184 - Use context manager for image reading operations.
185 Catch `URLError` when `urllib.request.urlopen()` fails.
187 - Convert image URI to path if accessing a local file. Fixes bug #153.
189 * docutils/writers/s5_html/__init__.py
191 - Warn if the S5 writer cannot copy the theme files.
192 - Programmatic customization of theme_url_ setting no longer
193 overridden by the default for theme_.
197 - New configuration setting `sources`_.
198 - Match `prune`_ values with `fnmatch.fnmatch()`.
201 Release 0.20.1 (2023-05-17)
202 ===========================
204 * docutils/MANIFEST.in
206 - Include tox.ini and docutils.conf in the source package
207 (cf. bug #467 and bug #461).
209 * tools/rst2odt_prepstyles.py
211 - Moved to ``docutils/writers/odf_odt/prepstyles.py``.
212 Replaced with a provisional backwards compatibility script.
215 Release 0.20 (2023-05-09)
216 =========================
220 - Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
221 - Support Python 3.11 (patch #198 by Hugo van Kemenade).
225 - New functions `rst2…()` for use as "console_scripts" `entry points`_.
226 (cf. `Future changes` in the RELEASE-NOTES_).
228 * docutils/frontend.py
230 - New configuration setting "output_". Obsoletes the ``<destination>``
231 positional argument (cf. `Future changes` in the RELEASE-NOTES_).
233 * docutils/languages/
234 docutils/parsers/rst/languages/
236 - Support Ukrainian. Patch by Dmytro Kazanzhy.
240 - Fix `previous_sibling()` method that led to invalid HTML in some cases
242 - Fix bug #463. Spurious comma in deprecation warning.
244 * docutils/parsers/recommonmark_wrapper.py
246 - Improved mock Sphinx module.
248 * docutils/transforms/__init__.py
250 - `Transformer.populate_from_components()` now silently ignores
251 components that are not instances of `docutils.TransformSpec`.
253 * docutils/transforms/frontmatter.py
255 - Accept author names with initials like ``A. Einstein`` in the "author"
256 `bibliographic field`_ instead of rising an error
257 (generally, such names are `parsed as enumerated list`__).
259 .. _bibliographic field:
260 docs/ref/rst/restructuredtext.html#bibliographic-fields
261 __ docs/ref/rst/restructuredtext.html#enumerated-lists
263 * docutils/transforms/references.py
265 - `DanglingReferences` ignores `citation_reference` nodes if the
266 "use_bibex" setting is active. (In this case, citations are provided
267 by LaTeX/BibTeX.) Fixes bug #384.
269 * docutils/utils/__init__.py
271 - New utility function `xml_declaration()`.
272 - `DependencyList.add()` accepts `pathlib.Path` instances.
273 - `find_file_in_dirs()` now returns a POSIX path also on Windows;
274 `get_stylesheet_list()` no longer converts ``\`` to ``/``.
276 * docutils/utils/math/latex2mathml.py
278 - Support "mod" notation for modulo operation / modulus arithmetic.
280 * docutils/utils/math/tex2mathml_extern.py
282 - Support `Pandoc` as alternative LaTeX to MathML converter.
285 * docutils/writers/_html_base.py
287 - Refactoring of `HTMLTranslator` initialization and collecting of
288 document "parts". Adapt HTML writers importing `_html_base`.
290 Changes to the HTML output (no space character before closing tag of
291 XML declaration, order of metadata elements)
292 don't affect the HTML semantics, styling, and rendering.
294 - Wrap definition lists with "details" class argument in a <div>
295 with the "id" and "class" values of the list node.
297 - Use dpub-ARIA role "doc-footnote__" (instead of ARIA role "note")
300 __ https://www.w3.org/TR/dpub-aria-1.1/#doc-footnote
302 * docutils/writers/html5_polyglot/__init__.py
304 - Do not convert class values to HTML5 text-level tags inside
305 <code> and <code-block> (fixes bug #476).
307 * docutils/writers/latex2e/__init__.py
309 - Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
310 (UTF-8 is the default encoding for LaTeX2e since 2018).
311 - Fix behaviour of the use_bibtex_ setting.
312 - Outsource parts of `depart_document()` to new auxiliary methods
313 `make_title()` and `append_bibliography()`.
314 - Ensure POSIX paths in stylesheet loading macros.
316 * docutils/writers/latex2e/titlepage.tex
318 - Drop ``\usepackage{fixltx2e}`` from template.
319 (Obsolete since 2015 and dropped from other templates in Docutils 0.14.)
321 * docutils/writers/manpage.py
323 - Do not output empty "manual" in ``.TH``.
325 * docutils/writers/xetex/__init__.py
327 - Ignore settings in the [latex2e writer] configuration file section.
328 Place common settings in section [latex writers].
332 - Fix SetuptoolsDeprecationWarning: ``Installing '' as data is deprecated``
333 by adding data directories to package_data.packages list.
337 - Extracted flake8 configuration and moved to ``.flake8``.
338 - changedir to directory ``test`` to avoid path problems.
342 - Refactored tests to use common `unittest` idioms.
343 Fixes errors when running the test suite with ``python -m unittest``
344 or external test frameworks, such as Pytest_.
346 .. _pytest: https://pypi.org/project/pytest/
350 - Removed. Use the coverage.py_ project instead,
351 ``coverage run test/alltests.py`` and ``coverage report``.
353 .. _coverage.py: https://pypi.org/project/coverage/
357 - Moved ``quicktest.py`` to ``tools/dev/``.
360 Release 0.19 (2022-07-05)
361 =========================
365 - Dropped support for Python 2.7, 3.5, and 3.6. and removed compatibility
366 hacks from code and tests.
368 check PEP 8 conformity with `flake8` (exceptions in file tox.ini).
370 * docutils/__main__.py
372 - New module. Support for ``python -m docutils``.
373 Also used for the ``docutils`` console script `entry point`_.
377 - Let `Publisher.publish()` print info and prompt when waiting for input
378 from a terminal (cf. https://clig.dev/#interactivity).
379 - Respect `input_encoding_error_handler`_ setting when opening a source.
383 - New function `error_string()`
384 obsoletes `utils.error_reporting.ErrorString`.
385 - Class `ErrorOutput` moved here from `utils.error_reporting` module.
386 - Use "utf-8-sig" instead of Python's default encoding if the
387 `input_encoding`_ setting is None.
388 - Fix error when reading of UTF-16 encoded source without trailing newline.
389 - Suppress deprecation warning (fixes bug #464).
391 * docutils/parsers/__init__.py
393 - Aliases "markdown" and "commonmark" point to "commonmark_wrapper".
394 - Alias for the "myst" parser (https://pypi.org/project/myst-docutils).
395 - Use absolute module names in `_parser_aliases` instead of two
396 import attempts. (Keeps details if the `recommonmark_wrapper` module
397 raises an `ImportError`.)
398 - Prepend parser name to `ImportError` if importing a parser class fails.
400 * docutils/parsers/commonmark_wrapper.py
402 - New module for parsing CommonMark input. Selects a locally installed
403 3rd-party parser (`pycmark`, `myst`, or `recommonmark`).
405 * docutils/parsers/recommonmark_wrapper.py
407 - Raise `ImportError`, if import of the upstream parser module fails.
408 If called from an `"include" directive`_,
409 the system-message now has source/line info.
410 - Adapt to and test with `recommonmark` versions 0.6.0 and 0.7.1.
412 .. _"include" directive: docs/ref/rst/directives.html#include
414 * docutils/parsers/rst/__init__.py
416 - Update PEP base URL (fixes bug #445),
417 use "https:" scheme in RFC base URL.
418 - Add `reporter` to `Directive` class attributes.
420 * docutils/parsers/rst/directives/__init__.py
422 - `parser_name()` keeps details if converting `ImportError` to `ValueError`.
424 * docutils/parsers/rst/roles.py
426 - Don't use mutable default values for function arguments. Fixes bug #430.
428 * docutils/transforms/universal.py
430 - Fix bug #435: invalid references in `problematic` nodes
433 * docutils/utils/__init__.py
435 - `decode_path()` returns `str` instance instead of `nodes.reprunicode`.
437 * docutils/utils/error_reporting.py
439 - Add deprecation warning.
441 * docutils/writers/_html_base.py
443 - Add "html writers" to `config_section_dependencies`. Fixes bug #443.
444 - Write table column widths with 3 digits precision. Fixes bug #444.
446 * docutils/writers/html5_polyglot/__init__.py
448 - Add space before "charset" meta tag closing sequence.
449 - Remove class value "controls" from an `image` node with video content
450 after converting it to a "control" attribute of the <video> tag.
451 - Wrap groups of footnotes in an ``<aside>`` for easier styling.
453 * docutils/writers/pep_html/
455 - Use "https:" scheme in "python_home" URL default.
456 - Fix links in template.txt.
460 - New ``docutils``" console script `entry point`_. Fixes bug #447.
464 - Always encode the log file ``alltests.out`` using "utf-8".
466 * test/DocutilsTestSupport.py
468 - `exception_data()` now returns None if no exception was raised.
469 - `recommonmark_wrapper` only imported if upstream parser is present.
471 * test/test_parsers/test_rst/test_directives/test_tables.py
473 - Fix bug #436: Null char valid in CSV since Python 3.11.
475 * tools/docutils-cli.py
477 - Allow 3rd-party drop-in components for reader and parser, too.
479 - Actual code moved to docutils.__main__.py.
481 * tools/rst2odt_prepstyles.py
483 - Options ``-h`` and ``--help`` print short usage message.
487 https://packaging.python.org/en/latest/specifications/entry-points/
490 Release 0.18.1 (2021-11-23)
491 ===========================
495 - `Node.traverse()` returns a list again to restore backwards
496 compatibility. Fixes bug #431.
498 - New method `Node.findall()`: like `Node.traverse()` but returns an
499 iterator. Obsoletes `Node.traverse()`.
501 * docutils/utils/__init__.py
503 - Fix behaviour of `get_stylesheet_list()`: do not look up stylesheets
504 given as `stylesheet`_ setting. Cf. bug #434.
506 * docutils/writers/_html_base.py
508 - Fix handling of ``footnote_backlinks == False`` (report Alan G Isaac).
510 * docutils/writers/html5_polyglot/math.css
512 - Fix typo (bug #432).
514 * docutils/writers/odf_odt/__init__.py
516 - Fix spurious output with Windows (bug #350).
518 * test/test_error_reporting.py
520 - Fix a false positive (bug #434).
523 Release 0.18 (2021-10-26)
524 =========================
526 * docutils/frontend.py
527 - Mark as provisional (will switch from using `optparse` to `argparse`).
528 - Remove hack for the now obsolete "mod_python" Apache module.
529 - New function `get_default_settings()`.
533 - Don't change a list while looping over it (in
534 `document.set_name_id_map()`). Thanks to Mickey Endito.
536 * docutils/parsers/recommonmark_wrapper.py
538 - Test and update to work with `recommonmark` version 0.6.0.
541 Unfortunately, recommonmark_ is `no longer maintained`__.
543 __ https://github.com/readthedocs/recommonmark/issues/221
545 * docutils/parsers/rst/directives/misc.py
547 - Fix bug #424 Wrong circular inclusion detection.
548 Use a "magic" comment instead of line numbers
549 to keep a log of recursive inclusions.
551 * docutils/parsers/rst/states.py
553 - Use a "magic" comment to update the log of recursive inclusions.
555 * docutils/writers/html5_polyglot/__init__.py
557 - New option `image_loading`_. Support "lazy" loading of images.
558 Obsoletes `embed_images`_.
560 * docutils/writers/pseudoxml.py
562 - Fix spelling of setting `detailed`_.
564 * tools/docutils-cli.py
566 - Read settings from standard configuration files.
568 Fix spelling errors in documentation and docstrings.
569 Thanks to Dimitri Papadopoulos.
572 Release 0.18b1 (2021-10-05)
573 ===========================
575 * docs/ref/docutils.dtd
577 - New document tree element <meta>.
579 * docutils/frontend.py
581 - The default value for the `auto_id_prefix`_ setting changed to "%":
582 auto-generated IDs use the tag name as prefix.
586 - Make `\<meta>`_ a standard Docutils doctree node. Writers may ignore
587 <meta> nodes if they are not supported by the output format.
589 - document.make_id(): Do not strip leading number and hyphen characters
590 from `name` if the `id_prefix`_ setting is non-empty.
592 - `Node.traverse()` returns an iterator instead of a list.
594 * docutils/parsers/rst/directives/html.py
596 - Removed. (Meta directive moved to ``misc.py``.)
598 * docutils/parsers/rst/directives/misc.py
600 - `Meta` directive class (moved from html.py) inserts `meta`
601 (instead of `pending`) nodes.
603 - Add `class` option to `Raw` directive.
605 * docutils/parsers/rst/directives/tables.py
607 - Unify behaviour of `"widths" option`_: check that the length of an
608 integer list equals the number of table columns also for the "table"
611 * docutils/tools/math/math2html.py,
612 docutils/tools/math/tex2unicode.py,
613 docutils/writers/html5/math.css
615 - Fork from elyxer and remove code that is not required
617 - Scale variable sized operators and big delimiters with CSS
618 - Support more commands, fix mapping of commands to Unicode characters
619 (cf. `LaTeX syntax for mathematics`_).
620 - Fix bug #244 Wrong subscript/superscript order.
621 - Don't use <tt> element (deprecated in HTML5).
622 - Use STIX fonts if available.
624 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
626 * docutils/parsers/rst/states.py
628 - Fix source location (line number) for attribution elements.
629 Patch by Mickey Endito.
630 - Add line, source, and rawsource internal attributes for blockquote
631 elements. Patch by Mickey Endito.
633 * docutils/transforms/references.py
635 - Skip system_messages when propagating targets. Fixes bug #425.
637 * docutils/utils/__init__.py
639 - Removed `unique_combinations()` (obsoleted by `itertools.combinations()`).
641 * docutils/utils/latex2mathml.py
643 - Major update (fixes and support for additional commands and symbols).
646 * docutils/writers/_html_base.py
648 - Write footnote brackets and field term colons to HTML, so that
649 they are present also without CSS and when copying text.
650 Adapt ``minimal.css``.
652 - Use semantic tags <aside> for footnote text, topics, admonitions,
653 and system-messages and <nav> for the table of contents. Use <div>
656 - Only specify table column widths, if the `"widths" option`_ is set
657 and is not "auto" (fixes bug #426).
658 The `table_style`_ setting "colwidths-grid" restores the current default.
660 .. _"widths" option: docs/ref/rst/directives.html#column-widths
662 - Use ARIA roles to enable accessible HTML for abstract, dedication,
663 the table of contents, footnote, references, footnotes, citations,
666 - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
667 for headings of deeply nested sections.
669 - Do not set classes "compound-first", "compound-middle", or
670 "compound-last" to elements nested in a compound.
671 Use class value "backrefs" instead of "fn-backref" for a span of
674 - Do not write class values handled by the HTML writer ("colwidths-auto",
675 "colwidths-given", "colwidths-grid") to the output.
677 - Move space character between section number and heading into
680 - Removed attribute `HTMLTranslator.topic_classes`
682 - Items of a definition list with class argument "details" are
683 converted to <details> disclosure elements.
685 * docutils/writers/html4css1/__init__.py
687 - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
688 (details, aside, nav, ...) and attributes (role, aria-level).
690 * docutils/writers/latex2e/__init__.py
692 - The setting `legacy_class_functions`_ now defaults to "False".
693 Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
695 - Apply patch #181 "Fix tocdepth when chapter/part in use" by
696 John Thorvald Wodder II.
698 - Fix newlines after/before `ids_to_labels()` (cf. patch #183).
700 - Refactor/revise ToC writing.
702 - Don't add ``\phantomsection`` to labels in math-blocks.
704 - Improve spacing and allow customization of Docutils-generated table
707 - New algorithm for table column widths. Fixes bug #422.
708 New configuration setting `legacy_column_widths`_.
710 `Table.set_table_style()` arguments changed.
712 Only write "continued on next page..." if it fits
713 without making the table columns wider.
715 Table "width" option overrides conflicting "auto" column "widths".
717 * docutils/writers/latex2e/docutils.sty
719 - Fix excessive padding above sidebar titles.
721 * docutils/writers/pseudoxml.py
723 - Fix option `detailed`_ under Python 2.7.
725 * docutils/writers/s5_html/themes/default
727 - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
728 ``blank.gif`` (fixes bug #169).
730 * docutils/writers/manpage.py
732 - Fix: double quotes need to be escaped on macro invocation.
736 Release 0.17.1 (2021-04-16)
737 ===========================
739 * docutils/utils/math/latex2mathml.py
741 - Fix bug #406 (MathML translation of ``\mathbf``).
743 * docutils/writers/latex2e/__init__.py
745 - Open ``docutils.sty`` with encoding set to "utf-8".
746 Fixes bug #414: error with Py3k when locale encoding is "ascii".
748 * docutils/parsers/*.py, docutils/transforms/*.py
750 - Provide fallbacks for parser config settings
751 to facilitate programmatic use.
753 * docutils/writers/manpage.py
755 - Apply patch #166: move macro defs above ``.TH``
756 (thanks Willie and sorry for the delay).
759 Release 0.17 (2021-04-03)
760 =========================
764 - Installing with ``setup.py`` now requires `setuptools`.
765 Alternatively, install with `pip`_ (or "manually").
766 - Use `importlib.import_module()` to programmatically import modules.
767 - Fix bug #385: Import of language modules.
769 .. _pip: https://pypi.org/project/pip/
771 * docs/ref/docutils.dtd
773 - The "title" attribute of <sidebar> elements is now optional.
775 * docutils/MANIFEST.in
777 - Exclude test outputs.
779 * docutils/__init__.py
781 - VersionInfo: `ValueError` for invalid values, fix comparison to tuples.
783 * docutils/languages/
784 docutils/parsers/rst/languages/
786 - Apply patch # 177 Arabic mappings by Shahin.
787 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
791 - Apply patch #165 "Fix error when copying `system_message` node"
793 - Apply version of patch #167 "Let `document.set_id()` register all
794 existing IDs". Thanks to Takeshi KOMIYA.
795 - Fix bug #410: Use a "property" function to recursively fetch
796 `Node.document` value from parent node.
798 * docutils/parsers/recommonmark_wrapper.py
800 - New, **experimental** wrapper to integrate the
801 `recommonmark`_ Markdown parser for use with Docutils.
802 Currently only tested with `recommonmark` version 0.4.0.
804 .. _recommonmark: https://pypi.org/project/recommonmark/
806 * docutils/parsers/rst/directives/body.py
808 - Make the sidebar's "title" argument optional (feature request #69).
810 * docutils/parsers/rst/directives/html.py
812 - Make `meta` elements available for "latex" and "odt" writers.
814 * docutils/parsers/rst/directives/misc.py
816 - Prevent infinite inclusion loops.
818 * docutils/parsers/rst/roles.py
820 - Apply patch #174 "Lowercase new role names on registration"
821 by John Thorvald Wodder II.
823 * docutils/utils/smartquotes.py
825 - Fix bug #383: Smart quotes around opening and separator characters.
827 * docutils/transforms/components.py
829 - Allow a comma-separated list of formats for the Filter transform.
831 * docutils/writers/html*
833 - Implement feature request #40 "Option to embed images as data URI".
835 * docutils/writers/html5_polyglot/__init__.py
837 - Use the new semantic tags <main>, <section>, <header>,
838 <footer>, <aside>, <figure>, and <figcaption>.
839 See ``minimal.css`` and ``plain.css`` for styling rule examples.
841 Change the `initial_header_level`_ setting default to "2", as browsers
842 use the `same style for <h1> and <h2> when nested in a <section\>`__.
844 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
846 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
847 <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
848 is found in `\<inline>`_ and `\<literal>`_ elements.
849 Use <ins> and <del> if a unique matching class value
850 is found in `inline`, `literal`, or `container` elements.
851 Use <small> for generated code line numbers.
853 - Fix bug #398: properly close link tag to "schema.dcterms".
855 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
857 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
859 - Use <video> for images with video MIME types supported by HTML5.
861 * docutils/writers/html5_polyglot/minimal.css
863 - Move non-essential styling to ``plain.css``.
864 Small fixes and tweaks.
866 - Support "captionbelow" class value for tables.
868 - Display code line numbers as pseudo-elements which are skipped
869 when copying text from code blocks. Solves feature request #32.
871 * docutils/writers/html5_polyglot/plain.css
873 - Support numbered figures.
875 * docutils/writers/html5_polyglot/responsive.css
877 - New optional style that adapts to different screen sizes.
879 * docutils/writers/latex2e/__init__.py
881 - Use LaTeX environments for admonitions and "class wrappers" for styling
882 admonitions and titles if the new configuration setting
883 `legacy_class_functions`_ is False.
885 - Remove backwards compatibility code for the deprecated
886 `styling command`__ prefix ``\docutilsrole``.
888 __ docs/user/latex.html#custom-interpreted-text-roles
890 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
892 - Support the `memoir` LaTeX document class.
893 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
895 - The special value "auto" for the `graphicx_option`_ setting
896 is no longer supported (it never worked for xetex/luatex).
898 - Most helper commands and element definitions are now defined in the
899 LaTeX package `docutils.sty`_ and only inserted in the document
900 preamble if the `stylesheet`__ setting does not list "docutils".
902 .. _docutils.sty: https://ctan.org/pkg/docutils
903 __ docs/user/config.html#stylesheet-latex-writers
905 - Apply patch #173 "Make \*TeX writers convert nonstandard table
906 classes to DUclass environments" by John Thorvald Wodder II.
908 - Fix bug #408 "Incorrect assert in latex writer
909 for multiple citation references".
911 - Apply patch #175 "Fix alignment of nested tables"
912 by John Thorvald Wodder II. Additional fixes to table alignment.
914 - Do not write Docutils-generated ToC, when ``use_latex_toc == True``.
915 (This did happen when publishing from a doctree.)
917 - Set PDF document properties from "meta" directive content.
919 - Apply version of patch #176 "LaTeX writer: Append ``\leavevmode`` to
920 non-docinfo field names" by John Thorvald Wodder II.
922 * docutils/writers/manpage.py
924 - Fix #394 fix missing new line after rubric.
925 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
926 - Fix #126 manpage title with spaces.
927 - Fix #380 command line option problem in sphinx.
929 * docutils/writers/odf_odt/__init__.py
931 - Fix/improve metadata handling:
932 fix "keyword" splitting,
933 allow generic fields (stored as "Custom Properties").
935 * docutils/writers/pseudoxml.py
937 - New option `detailled`_.
939 * test/DocutilsTestSupport.py
941 - Run python3 test like python2 against source not the build/-directory
943 * tools/docutils-cli.py
945 - New generic command line front end that allows the free selection of
946 reader, parser, and writer components.
949 Release 0.16 (2020-01-16)
950 =========================
954 - Dropped support for Python 2.6, 3.3 and 3.4
955 - Docutils now supports Python 2.7 and Python 3.5+ natively
956 (without conversion by `2to3`).
957 - Keep `backslash escapes`__ in the document tree. Backslash characters in
958 text are be represented by NULL characters in the `text` attribute of
959 Doctree nodes and removed in the writing stage by the node's
962 __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
964 * docs/ref/docutils.dtd
966 - Use "parameter entities" for `class names`, `reference names`,
971 - Remove the `handle_io_errors` option from io.FileInput/Output.
975 - Speed up Node.next_node().
976 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
977 - Warn about `Node.traverse()` returning an iterator instead of a list
980 * docutils/statemachine.py
982 - Patch [ 158 ] Speed up patterns by saving compiled versions (eric89gxl)
984 * docutils/transforms/universal.py
986 - Fix [ 332 ] Standard backslash escape for smartquotes.
987 - Fix [ 342 ] No escape in roles descending from `inline literal`.
989 * docutils/utils/__init__.py
991 - `unescape()` definition moved to `nodes` to avoid circular import
992 dependency. Fixes [ 366 ].
994 * docutils/writers/latex2e/__init__.py
996 - Fix topic subtitle.
997 - Make "rubric" bold-italic and left aligned.
998 - Fix [ 339 ] don't use "alltt" or literal-block-environment
999 in admonitions and footnotes.
1000 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
1001 - Add "latex writers" to the `config_section_dependencies`.
1002 - Ignore classes for `rubric` elements
1003 (class wrapper interferes with LaTeX formatting).
1005 * docutils/writers/manpage.py
1007 - Apply fix for [ 287 ] comma after option is bold.
1008 - Apply fix for [ 289 ], line starting with ``.`` in a text.
1010 * docutils/writers/odf_odt/__init__.py
1012 - Fix: ElementTree.getchildren deprecated warning
1014 * docutils/writers/xetex/__init__.py
1016 - Add "latex writers" to the `config_section_dependencies`.
1020 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1021 Close alltests.out with atexit.
1025 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1026 Read defaults file with context.
1028 - Set `auto_id_prefix`_ to "%" (expands to tag-names).
1029 Results in descriptive links in HTML and more localized changes when
1030 editions to the input add or remove auto-ids.
1034 - Apply patch #157: avoid test failure because of a `ResourceWarning`.
1036 * test/test_writers/test_odt.py
1038 - Fix [ 359 ] Test suite fails on Python 3.8. odt XML sorting.
1039 Use ElementTree instead of minidom.
1041 * tools/buildhtml.py
1043 - New option `html_writer`_.
1046 Release 0.15.1 (2019-07-24)
1047 ===========================
1049 source: branches/rel-0.15
1051 Fix [ 366 ] circular dependency. Release for Python 2 only.
1054 Release 0.15 (2019-07-20)
1055 =========================
1059 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
1060 - Infrastructure automation.
1062 * docs/ref/docutils.dtd
1064 - The <table> element accepts the new attribute "width".
1066 * docs/ref/rst/restructuredtext.txt
1068 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
1069 field list names (instead of ordinary text).
1073 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
1074 deprecated. Thanks to hugovk.
1076 * docutils/languages/ko.py, docutils/parsers/rst/languages/ko.py
1078 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
1082 - Fix [ 251 ] `system_message.copy()` `TypeError`.
1083 - `Element.copy()` also copies `document`, `line`, and `source` attributes.
1085 * docutils/parsers/rst/__init__.py
1087 - Apply [ 152 ] reset `default role` at end of document.
1089 * docutils/parsers/rst/states.py
1091 - Allow embedded colons in field list field names.
1093 * docutils/parsers/rst/directives/html.py
1095 - Fix bug #281: Remove escaping backslashes in meta directive content.
1097 * docutils/parsers/rst/directives/misc.py
1099 - Don't convert tabs to spaces, if `tab_width` is negative in
1100 "include" directive with "code" option.
1102 * docutils/parsers/rst/directives/tables.py
1104 - Apply patch #121: Add "width" option for the table directives.
1106 * docutils/transforms/frontmatter.py
1108 - Add field name as class argument to generic docinfo fields unconditionally.
1110 * docutils/transforms/references.py
1112 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
1114 * docutils/utils/__init__.py
1116 - Deprecate `unique_combination()` (obsoleted by `itertools.combination()`.
1118 * docutils/utils/smartquotes.py
1120 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
1122 * docutils/writers/html5_polyglot/
1124 - automatically add HTML5-compatible meta tags for docinfo items
1125 "authors", "date", and "copyright".
1127 * docutils/writers/_html_base.py
1129 - Fix bug #358: Non-breaking space removed from fixed-width literal.
1131 * docutils/writers/latex2e/__init__.py
1133 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
1135 - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
1136 - Fixes to literal block handling.
1139 Release 0.14 (2017-08-03)
1140 =========================
1142 * docs/ref/docutils.dtd
1144 - Enable validation of Docutils XML documents against the DTD:
1146 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
1147 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
1148 however, the `ids` attribute cannot use the ID type because `XML only
1149 allows one ID per Element Type`__ and doesn't support a multiple-ID
1150 "IDS" attribute type.
1152 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
1154 * docs/ref/rst/restructuredtext.txt
1156 - Added documentation for escaped whitespace in URI contexts.
1157 - Clarify use of Unicode character categories.
1159 * docutils/parsers/rst/states.py
1161 - Added functionality: escaped whitespace in URI contexts.
1162 - Consistent handling of all whitespace characters in inline markup
1163 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
1165 * docutils/parsers/rst/directives/images.py
1167 - Added support for escaped whitespace in URI contexts.
1169 * docutils/parsers/rst/directives/tables.py
1171 - Rework patch [ 120 ] (revert change to Table.get_column_widths()
1172 that led to problems in an application with a custom table directive).
1174 * docutils/transforms/frontmatter.py
1176 - Fix [ 320 ] Russian docinfo fields not recognized.
1178 * docutils/transforms/references.py
1180 - Don't add a second ID to problematic references.
1182 * docutils/transforms/universal.py
1184 Fix `SmartQuotes`: warn only once if language is unsupported,
1185 keep "rawsource" when "educating" quotes.
1187 * docutils/utils/__init__.py
1189 - Added `split_escaped_whitespac()` function, support for escaped
1190 whitespace in URI contexts.
1192 * docutils/utils/error_reporting.py
1194 - Fix [ 321 ] Import block might cause name error.
1196 * docutils/utils/smartquotes.py
1198 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
1199 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
1200 - Fix [ 313 ] Differentiate apostrophe from closing single quote
1202 - Fix [ 317 ] Extra space inserted with French smartquotes.
1203 - Add command line interface for stand-alone use (requires 2.7).
1205 * docutils/writers/_html_base.py
1207 - Provide default title in metadata (required by HTML5).
1208 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
1209 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
1210 reasons, we don't use a third party public installation as default but
1211 warn if `math_output`_ is set to MathJax without specifying a URL.
1213 * docutils/writers/html4css1/__init__.py
1215 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
1217 * docutils/writers/latex2e/__init__.py
1219 - Handle class arguments for block-level elements by wrapping them
1220 in a "DUclass" environment. This replaces the special handling for
1221 `epigraph` and `topic` elements.
1223 * docutils/writers/manpage.py
1225 - Apply [ 141 ] Handling inline in manpage writer.
1227 * docutils/writers/odf_odt/__init__.py
1229 - Command line setting `language`_ now sets the default language of the
1230 generated ODF document.
1231 - The use of image directive options :width: (%), :scale:, etc now
1232 set the width/height/size of images in the generated ODF
1234 - The heading/title of admonitions now reflects the language
1235 specified by the `language`_ setting.
1236 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
1238 - Fixed [ 282 ] python3: `AttributeError`.
1240 * tools/rst2html4.py: New front-end.
1242 * tools/dev/generate_punctuation_chars.py: New script
1243 to test and update utils.punctuation_chars.
1246 Release 0.13.1 (2016-12-09)
1247 ===========================
1249 * docs/ref/docutils.dtd
1251 - Add the document tree elements <math> and <math_block> (already in use).
1253 * docutils/languages/fa.py
1254 docutils/parsers/rst/languages/fa.py
1255 docutils/languages/la.py
1256 docutils/parsers/rst/languages/la.py:
1258 - Apply [ 133 ] Persian mappings by Shahin Azad.
1259 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
1263 - Fix [ 253 ] Attribute key without value not allowed in XML.
1267 - Apply [ 103 ] Recognize inline markups without word boundaries.
1268 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
1270 * docutils/parsers/rst/__init__.py
1272 - Fix [ 233 ] Change the base URL for the :rfc: role.
1274 * docutils/parsers/rst/directives/tables.py
1276 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
1279 - Implement feature request [ 48 ]
1280 Add :align: option to the table directives.
1281 Thanks to Takeshi KOMIYA for the patch.
1283 * docutils/parsers/rst/roles.py
1285 - Fix [ 295 ] Class argument for custom role inheriting from math.
1287 * docutils/parsers/rst/tableparser.py
1289 - Really fix [ 159 ] Spurious table column alignment errors.
1291 * docutils/transforms/frontmatter.py
1293 - Add name of generic bibliographic fields as a "classes" attribute value
1294 (after conversion to a valid identifier form).
1296 * docutils/utils/error_reporting.py
1298 - Fix [ 130 ] support streams expecting byte-strings in ErrorOutput.
1300 * docutils/utils/math/math2html.py
1302 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
1303 - New upstream version (additional macros, piece-wise integrals and sums).
1305 * docutils/writers/_html_base.py
1307 - New auxiliary module for definitions common to all HTML writers.
1309 * docutils/writers/html5_polyglot/
1311 - New HTML writer generating clean, polyglot_ markup conforming to
1314 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
1315 and recommended layout rules.
1317 * docutils/writers/html4css1/__init__.py
1319 - Add "docutils" to class values for "container" object to address [ 267 ].
1320 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
1321 `default_stylesheet_path` and `default_template_path`.
1322 - Fix [ 266 ] creating labels/class values in description list items.
1323 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
1324 - Fix footnotes with content that does not start with a paragraph.
1325 - Use https in default MathJax URL (report Alan G Isaac).
1326 - Outsourcing of common code to _html_base.py.
1328 * docutils/writers/latex2e/__init__.py
1330 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
1331 admonitions and docinfo.
1333 - Use absolute path for `default_template_path`.
1335 - Removed deprecated options ``--use-latex-footnotes`` and
1336 ``--figure-footnotes``.
1338 - Cleaner LaTeX code for enumerations and literal blocks.
1340 - Use `hyperref` package together with `bookmark` (improved hyperlinking
1341 by the same author).
1343 - Fix [ 286 ] Empty column title cause invalid latex file.
1345 - Fix [ 224 ] Fix rowspan support for tables.
1347 - Let LaTeX determine the column widths in tables with "colwidths-auto".
1348 Not suited for multi-paragraph cells!
1350 * docutils/writers/odf_odt/__init__.py
1352 - remove decode.encode of filename stored in zip.
1354 * docutils/writers/xetex/__init__.py
1356 - LuaLaTex compatibility: do not load `xunicode` package.
1360 - New front-end ``rst2html5.py``.
1364 - Test py26, py27, py33 and py34.
1366 To use, install the `tox` package via pip or easy_install and use
1367 tox from the project root directory.
1369 .. _polyglot: https://www.w3.org/TR/html-polyglot/
1370 .. _HTML 5: https://www.w3.org/TR/html5/
1373 Release 0.12 (2014-07-06)
1374 =========================
1376 * docs/ref/rst/directives.txt
1378 - Update "math" and "csv-table" descriptions.
1380 * docutils/parsers/rst/directives/images.py
1382 - Fix [ 258 ] ``figwidth="image"`` generates unitless width value.
1384 * docutils/parsers/rst/states.py
1386 - Improve error report when a non-ASCII character is specified as
1387 delimiter, quote or escape character under Python 2.
1388 Fixes [ 249 ] and [ 250 ].
1390 * docutils/writers/html4css1/__init__.py
1392 - Don't add newline after inline math.
1393 Thanks to Yury G. Kudryashov for the patch.
1395 * docutils/writers/latex2e/__init__.py
1397 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
1398 - Apply [ 116 ] by Kirill Smelkov. Don't hard code \large for subtitle.
1400 * docutils/writers/odf_odt/__init__.py
1402 - Apply patch by Jakub Wilk to fix bug [ 100 ].
1404 * test/test_error_reporting.py
1406 - Fix [ 223 ] by removing redundant tests we do not have control over.
1408 * test/test_nodes.py
1410 - Apply [ 115 ] respect fixed 2to3 string literal conversion behaviour.
1413 Release 0.11 (2013-07-22)
1414 =========================
1418 - Apply [ 2714873 ] Fix for the overwriting of document attributes.
1419 - Support embedded aliases within hyperlink references.
1420 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
1421 language module) before global search.
1425 - Fix [ 3601607 ] `node.__repr__()` must return `str` instance.
1427 * docutils/parsers/rst/directives/__init__.py
1429 - Fix [ 3606028 ] `assert` is skipped with ``python -O``.
1431 * docutils/parsers/rst/directives/images.py
1433 - Apply [ 3599485 ] node source/line information for sphinx translation.
1435 * docutils/parsers/rst/directives/tables.py
1437 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
1439 * docutils/parsers/rst/states.py
1441 - Fix [ 157 ] Line block parsing doesn't like system message.
1442 - Always import our local copy of roman.py (report Larry Hastings).
1444 * docutils/transforms/references.py
1446 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
1448 * docutils/utils/__init__.py
1450 - Fix [ 3596884 ] exception importing `docutils.io`.
1452 * docutils/writers/html4css1/__init__.py
1454 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
1455 - New setting `stylesheet_dirs`_: Comma-separated list of directories
1456 where stylesheets are found. Used by `stylesheet_path` when expanding
1457 relative path arguments.
1458 - New default for `math_output`_: ``HTML math.css``.
1459 - Avoid repeated class declarations in html4css1 writer
1460 (modified version of patch [ 104 ]).
1463 * docutils/writers/latex2e/__init__.py
1465 - Drop the simple algorithm replacing straight double quotes with
1466 English typographic ones.
1467 Use the `smart_quotes`_ setting to activate this feature.
1468 - Fix literal use of babel shorthands (straight quote, tilde, ...).
1469 - Fix [ 3603246 ] Bug in option ``--graphicx-option=auto``.
1470 - New setting `stylesheet_dirs`__.
1472 __ docs/user/config.html#stylesheet-dirs-latex-writers
1475 * docutils/writers/manpage.py
1477 - Fix [3607063] handle lines starting with a period.
1478 - Fix option separating comma was bold (thanks to Bill Morris).
1481 Release 0.10 (2012-12-16)
1482 =========================
1486 - Dropped support for Python 2.3.
1487 - ``docutils/math``, ``docutils/error_reporting.py``, and
1488 ``docutils/urischemes.py`` moved to the utils package.
1489 - Fix [3541369] Relative __import__ also with Python 3.3.
1490 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
1491 and parsers for Python 2.7 up.
1492 - Fix import of PIL.Image.
1493 - Change default of `syntax_highlight`_ option to "long",
1494 basic syntax highlight styles for LaTeX and HTML.
1498 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
1499 option is ignored and will be removed in a future release.
1500 - Fix Py3k error writing to stdout with encoding differing from default.
1501 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
1503 * docutils/parsers/rst/directives/misc.py
1505 - Fix [ 3546533 ] Unicode error with "date" directive.
1507 * docutils/transforms/universal.py
1509 - SmartQuotes transform for typographic quotes and dashes.
1511 * docutils/utils/__init__.py
1513 - `normalize_language_tag()` now returns `BCP 47`_ conforming tags
1514 with sub-tags separated by ``-``.
1516 * docutils/writers/html4css1/__init__.py
1518 - Use ``<code>`` tag for inline "code",
1519 do not drop nested inline nodes (syntax highlight tokens).
1520 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
1521 - No line break after opening inline math tag.
1523 * docutils/writers/manpage.py
1525 - Apply [ 3527401 ] admonition's don't preserve indentation
1526 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
1528 * docutils/writers/xetex/__init__.py
1530 - Apply [ 3555160 ] ensure order of "otherlanguages".
1531 - Fix section numbering by LaTeX.
1533 * docutils/writers/s5_html/__init__.py
1535 - Fix [ 3556388 ] MathJax does not work with rst2s5.
1537 * docutils/writers/docutils_xml.py
1539 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
1540 - Fix/improve output with `indents`_ setting.
1544 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
1546 * tools/test/test_buildhtml.py
1548 - Fix [ 3521167 ] allow running in any directory.
1549 - Fix [ 3521168 ] allow running with Python 3.
1552 Release 0.9.1 (2012-06-17)
1553 ==========================
1557 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
1558 installed in the PYTHONPATH. Converted tests are now
1559 stored in ``test3/``, tools no longer need conversion.
1561 If you installed one of Docutils versions 0.7 ... 0.9 with
1562 ``setup.py install`` under Python 3, remove the spurious
1563 ``test/`` and ``tools/`` directories in the site library root.
1567 - Make tests independent from the location of the ``test/`` directory.
1568 - Use converted sources (from the ``build/`` directory) for tests under
1573 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
1577 - Fix writing binary data to sys.stdout under Python 3 (allows
1578 ``rst2odt.py`` to be used with output redirection).
1580 * docutils/parsers/rst/directives/misc.py
1582 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
1583 ``locale == C`` and 8-bit char in path argument of `include` directive.
1587 - class `Tee`: catch `UnicodeError` when writing to "ascii" stream or
1588 file under Python 3.
1591 Release 0.9 (2012-05-02)
1592 ========================
1596 - New reStructuredText "code" role and directive and "code" option
1597 of the "include" directive with syntax highlighting by Pygments_.
1598 - Fix parse_option_marker for option arguments containing ``=``.
1599 - Fix [ 2993756 ] import Python Imaging Library's Image module
1600 via ``import PIL`` as starting with PIL 1.2,
1601 "PIL lives in the PIL namespace only" (announcement__).
1603 .. _Pygments: https://pygments.org/
1604 __ https://mail.python.org/pipermail/image-sig/2011-January/006650.html
1608 - Fix [ 2971827 ] and [ 3442827 ]
1609 extras/roman.py moved to docutils/utils/roman.py
1611 * docutils/frontend.py
1613 - Fix [ 3481980 ] Use `os.getcwdu()` in `make_paths_absolute()`.
1617 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
1618 - `mode` argument for FileOutput avoids code replication in
1620 - New exceptions `InputError` and `OutputError` for IO errors in
1621 FileInput/FileOutput.
1625 - No "hard" system exit on file IO errors: catch and report them in
1626 `Publisher.reportException` instead. Allows handling by a calling
1627 application if the configuration setting `traceback`_ is True.
1629 * docutils/utils.py -> docutils/utils/__init__.py
1631 - docutils.utils is now a package (providing a place for sub-modules)
1633 - DependencyList uses io.FileOutput and 'utf-8' encoding to prevent
1634 errors recording non-ASCII filenames (fixes [ 3434355 ]).
1636 - Fix `relative_path()` with source=None and `unicode` target.
1638 * docutils/parsers/rst/states.py
1640 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
1641 characters and "international" quotes around inline markup.
1642 - Use `field_marker` pattern to look for start of a
1643 directive option block (fixes [ 3484857 ]).
1645 * docutils/parsers/rst/tableparser.py
1647 - Fix [ 2926161 ] for simple tables.
1648 (Combining chars in grid tables still contribute to cell width.)
1650 * docutils/writers/latex2e/__init__.py
1652 - Support the `abbreviation` and `acronym` standard roles.
1653 - Record only files required to generate the LaTeX source as dependencies.
1654 - Fix handling of missing stylesheets.
1655 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
1656 when suppressing LaTeX section numbering.
1657 - Use ``\DUtitle`` for unsupported section levels.
1658 - Apply [ 3512791 ] do not compare string literals with "is".
1660 * docutils/writers/xetex/__init__.py
1662 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
1664 * docutils/writers/html4css1/__init__.py
1666 - Change default for `math_output`_ setting to MathJax.
1667 - Fix handling of missing stylesheets.
1669 * docutils/writers/docutils_xml.py
1671 - Use the visitor pattern with `default_visit()`/`default_depart()` methods
1672 instead of minidom to facilitate special handling of selected nodes.
1673 - Support raw XML (inserted as-is inside a <raw></raw> node).
1675 * docutils/writers/manpage.py
1677 - Do not emit comment line with trailing blank. Problematic for VCS.
1680 Release 0.8.1 (2011-08-30)
1681 ==========================
1685 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
1686 and [ 3395920 ] (correct copyright info for rst.el).
1690 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
1692 * docutils/writers/latex2e/__init__.py
1694 - Clean up Babel language setting. Restores Sphinx compatibility.
1697 Release 0.8 (2011-07-07)
1698 ========================
1702 - Handle language codes according to `BCP 47`_.
1703 - If the specified language is not supported by Docutils,
1704 warn and fall back to English.
1705 - Math support: reStructuredText "math" role and directive,
1706 `math` and `math_block` doctree elements.
1707 - Decode command line arguments with the locale's preferred encoding
1708 (to allow, e.g., ``--title=Dornröschen``).
1709 - Orphaned `python` reader and `newlatex2e` writer moved to the sandbox.
1710 - New sub-module `error_reporting`: handle encoding/decoding errors
1711 when reporting exceptions.
1712 - Some additions to the Docutils core are released under the 2-Clause BSD
1713 license, see COPYING_ for details.
1715 .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
1716 .. _COPYING: COPYING.html
1720 - Most directives now support a "name" option that attaches a
1723 - Directive content may start on the first line also when the directive
1724 type accepts options.
1726 * docs/dev/policies.txt
1728 - Recommend the 2-Clause BSD license
1729 (http://opensource.org/licenses/BSD-2-Clause)
1730 for code that is kept under the author's copyright.
1732 * tools/buildhtml.py
1734 - Fix ``--local`` switch.
1736 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1738 * docutils/writers/html4css1/__init__.py
1740 - Set "lang" argument for objects with class argument
1741 "language-<language tag>".
1742 - New setting `math_output`_ with support for HTML, MathML, and LaTeX.
1744 * docutils/writers/latex2e/__init__.py
1746 - Fix [ 3043986 ] `AttributeError` using :local: with table of content.
1747 - Place title data in the document preamble.
1748 - Load `babel` package only if required.
1749 - Update list of supported languages.
1750 - New config setting `hyperref_options`_.
1751 No hard-coded "unicode" hyperref option (clash with xetex).
1752 - Set language for custom roles, paragraphs, block-quotes, and
1753 line-quotes with class argument "language-<language tag>".
1754 - Fix [ 3095603 ] wrong quotes output for Russian and other languages.
1755 - Convert image URI to a local file path.
1756 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1757 has more than one paragraph (Wolfgang Scherer).
1758 - \leavevmode before longtable only when needed (prevents spurious vspace)
1759 - do not advance table counter for tables without caption
1761 * docutils/writers/xetex/__init__.py
1763 - New writer generating LaTeX code for compiling with ``xelatex``.
1765 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1766 option allows separate config options for XeTeX vs. LaTeX2e.
1768 * docutils/writers/manpage.py
1770 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1771 - Fix: vertical space cleaning for option group ``.``.
1773 * tools/editors/emacs/rst.el
1775 - Fix [ 3001100 ] does not handle spaces in filenames.
1776 Thanks to Jakub Wilk.
1780 - strip whitespace from stylesheet arguments
1781 - exclude combining chars from column_width()
1782 (partial fix for [ 2926161 ])
1784 * docutils/parsers/rst/directives/misc.py
1786 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1791 - Do not ``close()`` `sys.stdin`, `sys.stdout`, or `sys.stderr`. Prevents
1792 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1795 Release 0.7 (2010-07-07)
1796 ========================
1800 - Fix [ 2881769 ] setup configuration.
1801 - Fix [ 2788716 ] reporting problems in included files.
1805 - FileInput opens files as text files with universal newline support
1806 (mode "rU", configurable with the new optional argument "mode").
1810 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1814 - Fix [ 2923723 ] let `decode_path()` tolerate ``path == None``.
1816 * docutils/writers/html4css1/__init__.py
1818 - Support SVG and SWF images (thanks to Stefan Rank).
1819 - Generate valid XHTML for centred images with targets.
1820 Use CSS classes instead of "align" tags for image alignment.
1822 * docutils/writers/latex2e/__init__.py
1824 - Use `transforms.writer_aux.Admonitions` to "normalize" special
1826 - Use the ``\url`` command for URLs (breaks long URLs instead of
1827 writing into the margin).
1828 - Preserve runs of spaces in `inline literals`__.
1829 - Deprecate `figure_footnotes`_ setting.
1830 - Rename `use_latex_footnotes`_ setting to `docutils_footnotes`_.
1831 - New `latex_preamble`_ setting.
1832 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1833 - Fix hyperlink targets (labels) for images, figures, and tables.
1834 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1835 - Apply [ 2961991 ] Call hyperref with unicode option.
1836 - Drop the special `output_encoding`_ default ("latin-1").
1837 The Docutils wide default (usually "UTF-8") is used instead.
1838 - Render inline markup in document title and subtitle.
1839 - Fix numbering depth with LaTeX section numbering.
1840 - Update Unicode -> LaTeX translations.
1841 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1843 __ docs/ref/restructuredtext.html#inline-literals
1845 * docutils/writers/manpage.py
1847 - Fix: supported attribute (thanks to peter2108).
1848 - Remove trailing blanks in code (keep in sync with mercurial version).
1849 - Titles level 1, that is ``.SH``, always uppercase.
1850 - Apply patch from mg: literal text should be bold in man-pages.
1854 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1859 - Python 3 support: copy test/ and tools/ to the build-dir
1860 and convert Python sources with 2to3.
1863 Release 0.6 (2009-10-11)
1864 ========================
1868 - Docutils is now compatible with Python versions from 2.3 up to 2.6
1869 and convertible to 3.1 code.
1871 + Node.__nonzero__ returns True instead of 1.
1872 + use os.walk instead os.path.walk.
1873 + minimize `types` module where possible.
1874 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1875 + Text nodes now subclass unicode rather than UserString
1876 (which is gone in python 3.0).
1877 + 3.0 compatibility module docutils._compat
1879 + Drop 2.2 compatibility workarounds.
1880 + Drop extras/optparse.py and extras/textwrap.py
1881 (stdlib modules since 2.3).
1883 - OpenOffice export: ODT writer moved from sandbox to Docutils core.
1884 - Unix man page export: manpage writer moved from sandbox to Docutils
1887 - Apply [ 1719345 ] Galician translation
1888 - Apply [ 1905741 ] Polish translation
1889 - Apply [ 1878977 ] make_id(): deaccent characters.
1890 - Apply [ 2029251 ] return nonzero when tests fail.
1891 - Fix [ 1692788 ] allow UTF-8 in style sheets.
1892 - Fix [ 2781629 ] support non-ASCII chars in file names.
1893 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1894 - Fix [ 2831643 ] renaming `DirectiveError.message` to `DirectiveError.msg`
1895 - Fix [ 2821266 ] ``--strict`` option works now like ``--halt=info``.
1896 - Fix [ 2788716 ] `DirectiveError` now correctly reports source and line.
1897 - Fix [ 1627229 ] hyperlink references in substitutions.
1899 - The `newlatex` writer is orphaned.
1903 - Documented Unicode characters allowed as inline markup openers,
1904 closers, and delimiters.
1905 - Allow units for all length specifications.
1906 - Allow percent sign in "scale" argument of "figure" and "image" directives.
1907 - Bugfix: The "figalign" argument of a figure now works as intended
1908 (aligning the figure, not its contents).
1909 - Align images with class "align-[right|center|left]"
1910 (allows setting the alignment of an image in a figure).
1912 * docutils/nodes.py:
1914 - Added `Element.__contains_()` method, for the in-operator.
1916 * docutils/parsers/rst/states.py:
1918 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1919 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1920 " " (non-breaking space), and "¡ ¿" openers.
1922 * docutils/parsers/directives/misc.py:
1924 - Added ``start-line`` and ``end-line`` options to "include"
1925 directive to select a range of lines.
1926 - Hard tabs in literal inclusions are replaced by spaces. This is
1927 configurable via the new ``tab-width`` option of the "include" directive
1928 (a negative tab-width prevents tab expansion).
1930 * docutils/utils.py:
1932 - Add `get_stylesheet_lis()` function.
1933 - Apply [ 2834836 ] print info at halt
1935 * docutils/transforms/universal.py:
1937 - Raise default priority of StripClasses to exclude stripped classes from
1940 * docutils/writers/html4css1/__init__.py:
1942 - `stylesheet`_ and `stylesheet_path`_ settings support a comma
1943 separated list of stylesheets.
1944 - Address [ 1938891 ] Inline literal text creates "pre" span only when
1945 needed to prevent inter-word line wraps.
1946 - Use `translate()` method instead of repeated `replace()` calls.
1947 - Fix [ 1757105 ] New `table_style`_ setting. Added to standard table
1948 classes to allow CSS styling that does not interfere with other
1949 table-using constructs (field lists, citations, ...).
1951 * docutils/writers/newlatex2e/__init__.py:
1953 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
1955 * docutils/writers/latex2e/__init__.py:
1957 - Add `embed_stylesheet`_ setting.
1958 - Apply [ 1474017 ] image vertical alignment is reversed.
1959 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
1960 - Change: has_key for dictionaries (not Nodes) to in-operator.
1961 - Merge adjacent citations into one latex cite command.
1962 - Failsafe implementation of custom roles. LaTeX compilation now ignores
1963 unknown classes instead of aborting with an error.
1964 - Support custom roles based on standard roles.
1965 - LaTeX packages can be used as `stylesheet`_ arguments without
1966 restriction. (A style sheet is now referenced with the ``\usepackage``
1967 command, if it ends with ``.sty`` or has no extension.)
1968 - Add ``bp`` to lengths without unit (prevents LaTeX errors).
1969 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
1970 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
1971 2005-02-04 as a configurable length unit).
1972 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
1973 if font-encoding is set to ''. LaTeX defaults to OT1 then.
1974 - Set sub- and superscript role argument in text mode not as math.
1975 Use a custom role based on sub-/superscript if you want italic shape.
1976 - Shorter preamble and less dependencies: Load packages and define macros
1977 only if required in the document.
1978 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
1979 - New custom environments and commands with optional "classes" argument.
1980 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
1981 - Better conformance to Docutils specifications with `use_latex_toc`_.
1982 Support for LaTeX generated ToC also with unnumbered sections.
1983 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
1984 section numbering by LaTeX.
1985 - Use default font in admonitions and sidebar.
1986 - Align of image in a figure defaults to 'center'.
1987 - Bugfix: Newlines around targets and references prevent run-together
1989 - Fix internal hyperlinks.
1990 - Use class defaults for page margins ('typearea' now optional).
1991 - Float placement made configurable, default changed to "here definitely".
1992 - Typeset generic topic as "quote block with title".
1993 - Use template (file and configuration option).
1994 - In the default template, load cmap.sty (fix text extraction in PDF) and
1995 fixltx2e.sty (LaTeX patches, \textsubscript).
1996 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
1997 - Use `translate()` instead of repeated `replace()` calls for text encoding.
1998 - Hyperlinked footnotes and support for symbol footnotes and
1999 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
2000 - Complete pairs of binary options
2001 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
2002 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
2004 - font-encoding: "T1" (formerly implicitly set by 'ae').
2005 - use-latex-toc: true (ToC with page numbers).
2006 - use-latex-footnotes: true (no mixup with figures).
2008 * docutils/writers/manpage.py
2010 - Do not print version at document end, this is done by the viewer.
2011 - Do not print date at document end, this is done by the viewer.
2012 - Fix storage of docinfo fields for none standard fields.
2014 * docutils/tools/rst2man.py
2017 Release 0.5 (2008-06-25)
2018 ========================
2020 * docutils/languages/he.py: Added to project: Hebrew mappings by
2023 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
2024 mappings by Meir Kriheli.
2026 * docutils/frontend.py:
2028 - Configuration files are now assumed and required to be
2030 - Paths of applied configuration files are now recorded in the
2031 runtime setting `_config_files`_ (accessible via `dump_settings`_).
2032 - Added `strip_elements_with_classes`_ and `strip_classes`_ settings.
2036 - Added code to determine the input encoding from data: encoding
2037 declarations or the presence of byte order marks (UTF-8 & UTF-16).
2038 - Added support for IronPython 1.0.
2040 * docutils/nodes.py:
2042 - Added `document.__getstate_()` method, for pickling.
2044 * docutils/parsers/rst/states.py:
2046 - Allow ``+`` and ``:`` in reference names.
2047 - Unquoted targets beginning with an underscore (``.. __target:
2048 URI``) are no longer accepted.
2049 - Added support for multiple attributions in a physical block quote
2050 (indented text block), dividing it into multiple logical block
2052 - Added support for unicode bullets in bullet lists: "•", "‣", and
2054 - Added support for new object-oriented directive interface,
2055 retaining compatibility to the old functional interface.
2056 - Added support for throwing `DirectiveError`'s from within
2059 * docutils/parsers/rst/__init__.py:
2061 - Added `Directive` base class.
2062 - Added `DirectiveError` base class.
2063 - Fixed `file_insertion_enabled`_ & `raw_enabled`_ setting
2066 * docutils/parsers/directives/:
2068 - Refactored all reStructuredText directives to use the new
2069 object-oriented directive interface. Errors are now (mostly)
2070 thrown using the new `DirectiveError` class.
2072 * docutils/parsers/directives/misc.py:
2074 - Added ``start-after`` and ``end-before`` options to ``include``
2075 directive; thanks to Stefan Rank.
2077 * docutils/transforms/universal.py:
2079 - Added `StripClassesAndElements` transform to remove from the
2080 document tree all elements with classes in
2081 `strip_elements_with_classes`_ and all "classes"
2082 attribute values in `strip_classes`_
2084 * docutils/transforms/writer_aux.py:
2086 - Added `Admonitions` transform to transform specific admonitions
2087 (like "note", "warning", etc.) into generic admonitions with a
2090 * docutils/writers/html4css1/__init__.py:
2092 - Moved template functionality from the PEP/HTML writer here.
2093 - Expanded the fragments available in the ``parts`` attribute.
2094 - Moved ``id`` attributes from titles to surrounding ``div``
2096 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
2097 universally supported now).
2098 - ``template.txt`` is now opened in text mode instead of binary mode
2099 (to ensure Windows compatibility).
2100 - ``a`` elements now have an "internal" or "external" class,
2101 depending on reference type.
2103 * docutils/writers/html4css1/template.txt: Added to project.
2105 * docutils/writers/pep_html/:
2107 - Moved template functionality to the HTML writer.
2109 * docutils/writers/s5_html/__init__.py:
2111 - Added `view_mode`_ & `hidden_controls`_ settings.
2113 * docutils/writers/latex2e/__init__.py:
2115 - Add `literal_block_env`_.
2116 - Fix: escaping ``%`` in href urls.
2117 - Move usepackage hyperref after stylesheet inclusion.
2118 - Fix: scrartcl does not have chapter but scrreprt.
2119 - Add newline after ``\end{verbatim}``.
2120 - Merge smaller differences from latex2e_adaptive_preamble.
2121 - Add ``use-part-section``.
2122 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
2123 - Using leavemode option_list no longer needs to check if parent
2124 is a definition list.
2125 - Append ``\leavemode`` to definition list terms.
2126 - No longer write visit\_/depart_definition_list_item comments to
2128 - Table column width with 3 decimal places.
2129 - Add table stubs support (boldfont).
2130 - Add assemble_parts to writer.
2131 - Add simply support for nested tables.
2132 - Fix verbatim in tables if use-verbatim-when-possible.
2133 - Use section commands down to subparagraph.
2134 - Put ensuremath around some latin1 chars.
2135 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
2136 - New experimental setting `use_bibtex`_.
2137 - New setting `reference_label`_ to allow usage of LaTeX ref for
2138 labels in section references.
2139 - Add a label after every section to support sectionnumbers as reference
2141 - Fix: bug# 1605376 rst2latex: bad options group list
2142 - Remove inactive code for use_optionlist_for_option_list.
2143 - Remove latex comments from option_list output.
2144 - Fix: bug# 1612270 double quotes in italian literal.
2145 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
2146 - Add setting `use_latex_abstract`_.
2147 - Image width unit ``px`` is translated to ``pt``.
2148 - Add image height support.
2149 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
2151 - Fix: Do not escape underscores in citation reference labels if
2152 use-latex-citations is set.
2153 - Use centering instead of center for figure contents, to avoid vertical
2155 - Recognize table class: borderless, nolines, booktabs, standard.
2156 - Fix: Renaming contents section does not work with latex writer; SF
2158 - Applied patch for custom roles with classes from Edward Loper.
2159 - Fixed bug that caused crashes with more than 256 lists.
2161 * docutils/writers/pep_html/__init__.py:
2163 - Changed to support new python.org website structure and
2166 * docs/howto/security.txt: "Deploying Docutils Securely", added to
2169 * tools/buildhtml.py:
2171 - Add `ignore`_ setting to exclude a list of shell patterns
2172 (default: ``.svn:CVS``).
2174 * tools/editors/emacs/rst.el:
2176 - Changed license to "GPL".
2177 - Added ``rst-straighten-decorations`` function.
2178 - The ``compile`` module is now always loaded.
2179 - Added ``rst-toggle-line-block`` function.
2180 - Headings consisting only of non-ASCII characters are now
2181 recognized by ``rst-toc`` and ``rst-adjust``.
2182 - Added font-lock support for multi-line comments where the first
2183 comment line is empty.
2184 - Added ``(require 'font-lock)``.
2188 - Provide descriptive error message if distutils is missing.
2191 Release 0.4 (2006-01-09)
2192 ========================
2196 - Updated the project policies for trunk/branch development &
2199 * docutils/__init__.py:
2201 - Added ``__version_details__`` attribute to describe code source
2202 (repository/snapshot/release).
2203 - Replaced ``default_transforms`` attribute of ``TransformSpec`` with
2204 ``get_transforms()`` method.
2208 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
2209 functions, for document tree extraction and reprocessing.
2213 - Added ``DocTreeInput`` class, for reprocessing existing documents.
2214 - Added support for non-Unicode (e.g. binary) writer output.
2216 * docutils/nodes.py:
2218 - Re-introduced ``Targetable.indirect_reference_name``, for
2219 MoinMoin/reST compatibility (removed in r3124/r3129).
2220 - Added ``serial_escape`` function; escapes string values that are
2221 elements of a list, for serialization. Modified Docutils-XML
2222 writing (``Element._dom_node``) and pseudo-XML writing
2223 (``Element.starttag``) to use ``serial_escape``.
2224 - Added ``Node.deepcopy()`` method.
2225 - Removed the internal lists ``document.substitution_refs``,
2226 ``document.anonymous_refs``, and ``document.anonymous_targets``.
2227 - Added a "container" element.
2228 - Fixed bug where values of list-valued attributes of elements
2229 originating from custom interpreted text roles (i.e., with custom
2230 classes) were being shared between element instances. Reported by
2233 * docutils/statemachine.py:
2235 - Added trailing whitespace stripping to ``string2lines()``.
2236 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
2237 Asian double-width character support.
2239 * docutils/utils.py:
2241 - Added ``east_asian_column_width()`` for double-width character
2244 * docutils/languages/ja.py: Added to project: Japanese mappings by
2247 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
2248 mappings by Panjunyong.
2250 * docutils/parsers/null.py: Added to project; a do-nothing parser.
2252 * docutils/parsers/rst/__init__.py:
2254 - Added validator to "tab_width" setting, with test. Closes SF bug
2255 #1212515, report from Wu Wei.
2257 * docutils/parsers/rst/states.py:
2259 - Fixed bug with escaped colons indicating a literal block.
2260 - Fixed bug with enumerated lists (SF#1254145).
2261 - Backslash-escaped colons inside of field names are now allowed.
2262 - Targets (implicit and explicit), anonymous hyperlink references
2263 and auto-numbered footnote references inside of substitution
2264 definitions are now disallowed.
2265 - Fixed bug: list items with blank first lines.
2266 - Fixed bug: block quote attributions with indented second lines.
2267 - Added East Asian double-width character support (Python 2.4 only).
2269 * docutils/parsers/rst/tableparser.py:
2271 - Added East Asian double-width character support (Python 2.4 only).
2273 * docutils/parsers/rst/directives/body.py:
2275 - Added the "container" directive.
2277 * docutils/parsers/rst/directives/misc.py:
2279 - Added the "default-role", "title", and "date" directives.
2280 - Added standard data file syntax to the "include" directive.
2281 - Added support for "class" directive content.
2283 * docutils/parsers/rst/directives/images.py:
2285 - Added ``indirect_reference_name`` support for images with a target
2287 - Added support for image width and height units.
2288 - Fixed bug with image "target" options.
2290 * docutils/parsers/rst/directives/references.py:
2292 - Added "class" attribute to "target-notes" directive, for
2293 footnote_reference classes.
2295 * docutils/parsers/rst/include/: Directory added to project; contains
2296 standard data files for the "include" directive. Initial contents:
2297 character entity substitution definition sets, and a set of
2298 definitions for S5/HTML presentations.
2300 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
2301 mappings by David Goodger.
2303 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
2304 Simplified Chinese mappings by Panjunyong.
2306 * docutils/readers/__init__.py:
2308 - Added universal.Decorations and universal.ExposeInternals
2309 transforms as default transforms for all readers.
2310 - Added ``ReReader`` base class for readers that reread an existing
2313 * docutils/readers/doctree.py: Added to project; a reader for existing
2316 * docutils/transforms/frontmatter.py:
2318 - Fixed the DocInfo transform to handle SVN-style expansion of the
2320 - In ``DocInfo.extract_authors``, treat the contents of "authors"
2323 * docutils/transforms/misc.py:
2325 - Added misc.Transitions transform, extracted from
2326 universal.FinalChecks.
2328 * docutils/transforms/references.py:
2330 - Added references.DanglingReferences transform, extracted from
2331 universal.FinalChecks.
2332 - Fixed bug with doubly-indirect substitutions.
2333 - Added footnote_reference classes attribute to "TargetNotes".
2334 - Fixed bug with circular substitution definitions that put Docutils
2335 into an infinite loop.
2337 * docutils/transforms/universal.py:
2339 - Added universal.ExposeInternals transform, extracted from
2340 universal.FinalChecks.
2341 - Removed universal.FinalChecks transform (logic has been moved to
2342 several new transforms).
2343 - Fixed bug with the "expose_internals" setting and Text nodes
2344 (exposed by the "rawsource" internal attribute).
2345 - Added the universal.StripComments transform, implementation of the
2346 "strip_comments" setting.
2348 * docutils/transforms/writer_aux.py: Added to project; auxiliary
2349 transforms for writers.
2351 - Added ``Compound`` transform, which flattens compound paragraphs.
2353 * docutils/writers/: Several writer modules (html4css1.py) were
2354 converted into packages. Support modules and data files have been
2355 moved into the packages. The stylesheets for the HTML writers are
2356 now installed along with the code, the code knows where to find
2357 them, and the default is to use them (actually, to embed them).
2358 Some adjustments to configuration files may be necessary. The
2359 easiest way to obtain the new default behavior is to remove all
2360 settings whose name includes "stylesheet".
2362 * docutils/writers/__init__.py:
2364 - Added universal.Messages and universal.FilterMessages transforms
2365 as default transforms for all writers.
2366 - Added ``UnfilteredWriter`` base class for writers that pass the
2367 document tree on unchanged.
2369 * docutils/writers/docutils_xml.py:
2371 - Made ``xmlcharrefreplace`` the default output encoding error
2374 * docutils/writers/html4css1/:
2376 - Added support for image width and height units.
2377 - Made ``xmlcharrefreplace`` the default output encoding error
2379 - Made ``--embed-stylesheet`` the default rather than
2380 ``--link-stylesheet``.
2381 - Moved "id" attribute from container (section etc.) to title's <a>
2382 tag, to be on the same tag as "name".
2383 (!!! To be reverted in Docutils 0.5.)
2384 - Added vertical space between fields of field lists.
2385 - Added ``--compact-field-lists`` option to remove vertical space in
2387 - Made cloaking of email addresses with ``--cloak-email-addresses``
2389 - Fixed support for centered images.
2390 - Added support for class="compact" & class="open" lists.
2392 * docutils/writers/latex2e/:
2394 - Underscores in citekeys are no longer escaped.
2396 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
2397 mapping of Unicode characters to LaTeX equivalents.
2399 * docutils/writers/s5_html/: Package added to project; writer for
2400 S5/HTML slide shows.
2402 * docs/dev/distributing.txt: Added to project; guide for distributors
2403 (package maintainers).
2405 * docs/dev/hacking.txt: Added to project; guide for developers.
2407 * docs/ref/doctree.txt:
2409 - Updated for plural attributes "classes", "ids", "names",
2411 - Added the "container" element.
2413 * docs/ref/docutils.dtd:
2415 - Updated for plural attributes "classes", "ids", "names",
2418 * docs/user/emacs.txt: Added to project; a document about Emacs
2419 support for reStructuredText and Docutils.
2421 * docs/user/links.txt: Added to project; lists of Docutils-related
2424 * docs/user/mailing-lists.txt: Added to project; information about
2425 Docutils-related mailing lists and how to access them.
2427 * docs/user/slide-shows.txt: Added to project; example of and docs for
2428 the S5/HTML writer (``rst2s5.py`` front end).
2430 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
2431 Files", added to project.
2433 * test/coverage.sh: Added to project; test coverage script.
2435 * test/DocutilsTestSupport.py:
2437 - Added support for specifying runtime settings at the suite level.
2439 * test/test_functional.py:
2441 - Added the ``clear_output_directory`` function.
2442 - Added support for ``_test_more`` functions in functional test
2445 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
2447 * tools/rstpep2html.py: Renamed from pep.py.
2449 * tools/dev/create_unimap.py: Added to project; script to create the
2450 docutils/writers/unimap_latex.py mapping file.
2452 * tools/dev/profile_docutils.py: Added to project; profiler script.
2454 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
2456 * tools/editors/emacs/restructuredtext.el,
2457 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
2458 Removed from project; the functionality is now contained in rst.el.
2460 * tools/editors/emacs/rst.el: Added to project. Added many features
2461 and fixed many bugs. See docs/user/emacs.txt for details.
2463 * tools/stylesheets: Removed from project. Stylesheets have been
2464 renamed and moved into writer packages.
2467 Release 0.3.9 (2005-05-26)
2468 ==========================
2472 - Eliminated and replaced all uses of the old string attributes
2473 ``id``, ``name``, ``dupname`` and ``class`` with references to the
2474 new list attributes ``ids``, ``names``, ``dupnames`` and
2475 ``classes`` throughout the whole source tree.
2479 - Enabled ``--dump-*`` options when ``--traceback`` specified,
2480 allowing for easier debugging.
2481 - In ``Publisher.publish()``, expanded the generic top-level
2484 * docutils/examples.py:
2486 - Added ``internals`` function for exploration.
2490 - Fixed ``Input.decode`` method to apply heuristics only if no
2491 encoding is explicitly given, and to provide better reporting of
2493 - The ``Input.decode`` method now removes byte order marks (BOMs)
2496 * docutils/nodes.py:
2498 - ``image`` element class changed to subclass of Element, not
2499 TextElement (it's an empty element, and cannot contain text).
2500 - Added ``attr_defaults`` dictionary for default attribute values.
2501 - Added empty list as default value for the following attributes:
2502 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
2503 - Added ``document.decoration`` attribute,
2504 ``document.get_decoration`` method, and ``decoration.get_header``
2505 & ``.get_footer`` methods.
2506 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
2509 * docutils/utils.py:
2511 - Removed ``docutils.utils.Reporter.categories``,
2512 ``docutils.utils.ConditionSet``, and all references to them, to
2513 simplify error reporting.
2515 * docutils/languages/nl.py: Added to project; Dutch mappings by
2518 * docutils/parsers/rst/__init__.py:
2520 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
2522 * docutils/parsers/rst/states.py:
2524 - Added check for escaped at-mark to prevent email address recognition.
2525 - Fixed option lists to allow spaces inside ``<angle-bracketed option
2527 - Allowed whitespace in paths and URLs.
2528 - Added auto-enumerated list items.
2529 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
2531 - Added support for table stub columns.
2533 * docutils/parsers/rst/directives/__init__.py:
2535 - Allowed whitespace in paths (``path`` function).
2536 - Added ``uri`` directive option conversion function.
2538 * docutils/parsers/rst/directives/body.py:
2540 - Fixed illegal context bug with "topic" directive (allowed within
2541 sidebars; not within body elements).
2543 * docutils/parsers/rst/directives/images.py:
2545 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
2546 - Added support for the ``file_insertion_enabled`` setting in the
2547 "figure" directive (disables "figwidth" option).
2548 - "image" directive: added checks for valid values of "align" option,
2549 depending on context. "figure" directive: added specialized
2550 "align" option and attribute on "figure" element.
2551 - Made ":figwidth: image" option of "figure" directive work again.
2552 - Fixed bug with reference names containing uppercase letters
2553 (e.g. ``Name_``) in "target" option of "image" directive.
2555 * docutils/parsers/rst/directives/misc.py:
2557 - Fixed "include" and "raw" directives to catch text decoding
2559 - Allowed whitespace in "include" & "raw" directive paths.
2560 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
2561 settings in "include" & "raw" directives.
2563 * docutils/parsers/rst/directives/parts.py:
2565 - Added "header" & "footer" directives.
2566 - Fixed illegal context bug with "contents" directive (topics
2567 allowed within sidebars; not within body elements).
2569 * docutils/parsers/rst/directives/tables.py:
2571 - Added "list-table" directive.
2572 - Caught empty CSV table bug.
2573 - Added support for the ``file_insertion_enabled`` setting in the
2574 "csv-table" directive.
2575 - Added ``stub-columns`` option to "csv-table" and "list-table"
2578 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
2579 mappings by Martijn Pieters.
2581 * docutils/readers/standalone.py:
2583 - Added ``section_subtitles`` setting to activate or deactivate the
2584 ``SectSubTitle`` transform.
2586 * docutils/transforms/frontmatter.py:
2588 - Added SectSubTitle transform to promote titles of lone
2589 subsections to subtitles.
2591 * docutils/transforms/references.py:
2593 - Fixed mislocated internal targets bug, by propagating internal
2594 targets to the next node, making use of the newly added support
2595 for multiple names and IDs.
2596 - Fixed duplicate footnote label bug.
2597 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
2600 * docutils/writers/html4css1.py:
2602 - Fixed unencoded stylesheet reference bug (characters like "&" in
2603 stylesheet references).
2604 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
2606 - Added support for multiple IDs per node by creating empty ``span``
2608 - Added the ``field_name_limit`` & ``option_limit`` settings &
2610 - Added support for table stub columns.
2611 - Added support for the ``align`` attribute on ``figure`` elements.
2612 - Added the ``cloak_email_addresses`` setting & support.
2613 - Added ``html_prolog``, ``html_head``, ``html_body``,
2614 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
2615 ``docutils.core.publish_parts``.
2616 - Added support for section subtitles.
2618 * docutils/writers/latex2e.py:
2620 - Fixed tables starting with more than one multirow cell.
2621 - Improved ``--use-latex-docinfo`` so that organization/contact/address
2622 fields are lumped with the last author field and appear on the
2624 - Made sure the titlepage is always shown with ``--use-latex-docinfo``,
2625 even if the document has no title.
2626 - Made sure that latex doesn't fill in today's date if no date field
2628 - Added support for section subtitles.
2630 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
2631 (under development).
2633 * docutils/writers/null.py: Added to project; a do-nothing Writer.
2635 * docs/api/publisher.txt:
2637 - Added "``publish_parts`` Details" section.
2639 * docutils/dev/repository.txt: Added to project; information about the
2640 Docutils Subversion repository.
2642 * docs/ref/docutils.dtd:
2644 - Added a ``stub`` attribute to the ``colspec`` element via the
2645 ``tbl.colspec.att`` parameter entity.
2646 - Allowed topic elements within sidebars
2647 - Added an ``align`` attribute to the ``figure`` element.
2649 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
2653 Release 0.3.7 (2004-12-24)
2654 ==========================
2656 * docutils/frontend.py:
2658 - Added options: ``--input-encoding-error-handler``,
2659 ``--record-dependencies``, ``--leave-footnote-reference-space``,
2660 ``--strict-visitor``.
2661 - Added command-line and config file support for "overrides" setting
2666 - Added support for input encoding error handler.
2668 * docutils/nodes.py:
2670 - Added dispatch_visit and dispatch_departure methods to
2671 NodeVisitor; useful as a hook for Visitors.
2672 - Changed structure of ``line_block``; added ``line``.
2673 - Added ``compound`` node class.
2674 - Added a mechanism for Visitors to transitionally ignore new node
2677 * docutils/utils.py:
2679 - Moved ``escape2null`` and ``unescape`` functions from
2680 docutils/parsers/rst/states.py.
2682 * docutils/parsers/rst/roles.py:
2685 - Changed role function API: the "text" parameter now takes
2686 null-escaped interpreted text content.
2688 * docutils/parsers/rst/states.py:
2690 - Fixed bug where a "role" directive in a nested parse would crash
2691 the parser; the state machine's "language" attribute was not being
2693 - Added support for line block syntax.
2694 - Fixed directive parsing bug: argument-less directives didn't
2695 notice that arguments were present.
2696 - Removed error checking for transitions.
2697 - Added support for multiple classifiers in definition list items.
2698 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
2699 - Changed role function API: the "text" parameter now takes
2700 null-escaped interpreted text content.
2701 - Empty sections and documents are allowed now.
2703 * docutils/parsers/rst/directives/__init__.py:
2705 - Added ``encoding`` directive option conversion function.
2706 - Allow multiple class names in class_option conversion function.
2708 * docutils/parsers/rst/directives/body.py:
2710 - Converted the line-block directive to use the new structure.
2711 - Extracted the old line-block functionality to the ``block``
2712 function (still used).
2713 - Added ``compound`` directive (thanks to Lea Wiemann).
2715 * docutils/parsers/rst/directives/misc.py:
2717 - Added "encoding" option to "include" and "raw" directives.
2718 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
2719 - Allow multiple class names in the "class" directive.
2721 * docutils/parsers/rst/directives/parts.py:
2723 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
2724 options. Thanks to Lele Gaifax.
2726 * docutils/parsers/rst/directives/tables.py:
2728 - Added "encoding" directive to "csv-table" directive.
2729 - Added workaround for lack of Unicode support in csv.py, for
2730 non-ASCII CSV input.
2732 * docutils/transforms/misc.py:
2734 - Fixed bug when multiple "class" directives are applied to a single
2736 - Enabled multiple format names for "raw" directive.
2738 * docutils/transforms/references.py:
2740 - Added support for trimming whitespace from beside substitution
2743 * docutils/transforms/universal.py:
2745 - FinalChecks now checks for illegal transitions and moves
2746 transitions between sections.
2748 * docutils/writers/html4css1.py:
2750 - HTMLTranslator.encode now converts U+00A0 to " ".
2751 - "stylesheet" and "stylesheet_path" settings are now mutually
2753 - Added support for the new line_block/line structure.
2754 - ``--footnote-references`` now overrides
2755 ``--trim-footnote-reference-space``, if applicable.
2756 - Added support for ``compound`` elements.
2757 - Enabled multiple format names for "raw" directive.
2758 - ``<p>`` tags of a paragraph which is the only visible child of the
2759 document node are no longer stripped.
2760 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2761 new method ``should_be_compact_paragraph()``.
2762 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2764 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2765 the output if they have their ``class`` attribute set.
2766 - The whole document is now surrounded by a ``<div
2767 class="document">`` element.
2768 - Body-level images are now wrapped by their own ``<div>`` elements,
2769 with image classes copied to the wrapper, and for images which
2770 have the ``:align:`` option set, the surrounding ``<div>`` now
2771 receives a class attribute (like ``class="align-left"``).
2773 * docutils/writers/latex2e.py:
2775 - no newline after depart_term.
2776 - Added translations for some Unicode quotes.
2777 - Added option "font-encoding", made package AE the default.
2778 - `stylesheet`_ and `stylesheet_path`_ settings are now mutually
2780 - ``--footnote-references`` now overrides
2781 ``--trim-footnote-reference-space``, if applicable.
2782 - The footnote label style now matches the footnote reference style
2783 ("brackets" or "superscript").
2784 - Added support for ``compound`` elements.
2785 - Enabled multiple format names for "raw" directive.
2787 * docs/ref/docutils.dtd:
2789 - Changed structure of the ``line_block`` element; added ``line``.
2790 - Added ``compound`` element.
2791 - Added "ltrim" and "rtrim" attributes to
2792 ``substitution_definition`` element.
2793 - Enabled multiple format names for ``raw`` element.
2794 - Enabled multiple classifiers in ``definition_list_item`` elements.
2796 * docs/ref/rst/directives.txt
2798 - Marked "line-block" as deprecated.
2799 - "Class" directive now allows multiple class names.
2800 - Added "Rationale for Class Attribute Value Conversion".
2801 - Added warning about "raw" overuse/abuse.
2803 * docs/ref/rst/restructuredtext.txt:
2805 - Added syntax for line blocks.
2806 - Definition list items may have multiple classifiers.
2808 * docs/ref/rst/roles.txt:
2812 * tools/stylesheets/default.css:
2814 - Added support for the new line_block structure.
2815 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2818 Release 0.3.5 (2004-07-29)
2819 ==========================
2823 * _`Documentation cleanup/reorganization`.
2825 - Created new subdirectories of docs/:
2827 * ``docs/user/``: introductory/tutorial material for end-users
2828 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2829 * ``docs/api/``: API reference material for client-developers
2830 * ``docs/ref/``: reference material for all groups
2831 * ``docs/howto/``: for component-developers and core-developers
2832 * ``docs/peps/``: Python Enhancement Proposals
2834 - Moved ``docs/*`` to ``docs/user/``.
2835 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2836 ``spec/`` to ``docs/dev``.
2837 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2838 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2839 - Moved ``alternatives.txt``, and ``problems.txt`` from
2840 ``spec/rst/`` to ``docs/dev/rst/``.
2841 - Moved ``reStructuredText.txt``, ``directives.txt``,
2842 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2843 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
2844 ``roles.txt``, ``reStructuredText.txt`` to
2845 ``restructuredtext.txt``.
2846 - Moved ``spec/howto/`` to ``docs/howto``.
2848 In order to keep the CVS history of moved files, we supplied
2849 SourceForge with a script for modifying the Docutils CVS repository.
2851 After running the cleanup script:
2853 - Added ``docs/index.txt``.
2854 - Added a ``.htaccess`` file to the ``web`` module, containing
2855 redirects for all old paths to new paths. They'll preserve
2856 fragments (the "#name" part of a URL), and won't clutter up the
2857 file system, and will correct the URL in the user's browser.
2858 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2859 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2860 the "To Do" list itself in ``docs/dev/todo.txt``.
2861 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2862 section of ``docs/dev/todo.txt``.
2863 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2864 - Added "How To Report Bugs" to ``BUGS.txt``.
2865 - Went through all the sources and docs (including under web/) and
2866 updated links. Mostly done by Lea Wiemann; thanks Lea!
2867 (Still need to update links in the sandboxes.)
2871 * BUGS.txt: Added to project.
2873 * THANKS.txt: Added to project.
2875 * docutils/__init__.py:
2877 - 0.3.4: Post-release.
2881 - Added special error handling & advice for UnicodeEncodeError.
2882 - Refactored Publisher.publish (simplified exception handling &
2883 extracted debug dumps).
2884 - Renamed "enable_exit" parameter of convenience functions to
2885 "enable_exit_status".
2886 - Enabled traceback (exception propagation) by default in
2887 programmatic convenience functions.
2888 - Now publish_file and publish_cmdline convenience functions return
2889 the encoded string results in addition to their regular I/O.
2890 - Extracted common code from publish_file, publish_string, and
2891 publish_parts, into new publish_programmatically. Extracted
2892 settings code to ``Publisher.process_programmatic_settings``.
2893 - In Publisher.publish, disabled ``settings_overrides`` when
2894 ``settings`` is supplied; redundant.
2896 * docutils/frontend.py:
2898 - Added help text for ``--output-encoding-error-handler`` and
2899 ``--error-encoding-error-handler``.
2900 - Renamed ``--exit`` to ``--exit-status``.
2901 - Simplified default-setting code.
2903 * docutils/parsers/rst/__init__.py:
2905 - Added ``--pep-base-url`` and ``--rfc-base-url`` options.
2907 * docutils/parsers/rst/states.py:
2909 - Made URI recognition more aggressive and intelligent.
2911 * docutils/parsers/rst/directives/__init__.py:
2913 - Added several directive option conversion functions.
2915 * docutils/parsers/rst/directives/body.py:
2917 - Moved "table" directive to tables.py.
2919 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2922 * docutils/writers/latex2e.py:
2924 - Added ``--table-style=(standard|booktabs|nolines)``
2925 - figures get "here" option (LaTeX per default puts them at bottom),
2926 and figure content is centered.
2927 - Rowspan support for tables.
2928 - Fix: admonition titles before first section.
2929 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2930 - Replave ``_`` in literal by an underlined blank, because it has the correct
2932 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2933 - A few unicode replacements, if output_encoding != utf
2934 - Add `graphicx_option`_ setting.
2935 - Indent literal-blocks.
2936 - Fix: omit ``\maketitle`` when there is no document title.
2938 * docs/index.txt: "Docutils Project Documentation Overview", added to
2941 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2942 Tool", added to project.
2944 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
2946 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
2948 * docs/dev/policies.txt: Added to project (extracted from
2949 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2951 * docs/dev/release.txt: Added to project (extracted from
2952 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2954 * docs/dev/testing.txt: Added to project.
2956 * docs/dev/website.txt: Added to project (extracted from
2957 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
2959 * docs/ref/rst/directives.txt:
2961 - Added directives: "table", "csv-table".
2963 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
2964 added to project. 1 page for syntax, and a 1 page reference for
2965 directives and roles. Source text to be used as-is; not meant to be
2968 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
2969 with a change of title.
2971 * test/functional/, contents, and test/test_functional.py: Added to
2974 * tools/buildhtml.py: Fixed bug with config file handling.
2976 * tools/html.py: Removed from project (duplicate of rst2html.py).
2978 * tools/pep2html.py: Removed from project (duplicate of Python's
2979 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
2980 Docutils-related PEPs in docs/peps/).
2982 * tools/rst2pseudoxml.py: Renamed from publish.py.
2984 * tools/rst2xml.py: Renamed from docutils-xml.py.
2986 * tools/test.txt: Removed from project; moved to
2987 docs/user/rst/demo.txt.
2989 * setup.py: Now also installs ``rst2latex.py``.
2992 Release 0.3.3 (2004-05-09)
2993 ==========================
2995 * docutils/__init__.py:
2997 - 0.3.1: Reorganized config file format (multiple sections); see
2999 - Added unknown_reference_resolvers attribute to TransformSpec.
3000 - 0.3.2: Interpreted text reorganization.
3005 - Catch system messages to stop tracebacks from parsing errors.
3006 - Catch exceptions during processing report & exit without
3007 tracebacks, except when ``--traceback`` used.
3008 - Reordered components for OptionParser; application comes last.
3009 - Added "config_section" parameter to several methods and functions,
3010 allowing front ends to easily specify their config file sections.
3011 - Added publish_parts convenience function to allow access to individual
3012 parts of a document.
3014 * docutils/examples.py: Added to project; practical examples of
3015 Docutils client code, to be used as-is or as models for variations.
3017 * docutils/frontend.py:
3019 - Added "traceback" setting.
3020 - Implemented support for config file reorganization:
3021 ``standard_config_files`` moved from ``ConfigParser`` to
3022 ``OptionParser``; added
3023 ``OptionParser.get_config_file_settings()`` and
3024 ``.get_standard_config_settings()``; support for old "[options]"
3025 section (with deprecation warning) and mapping from old to new
3027 - Reimplemented setting validation.
3028 - Enabled flexible boolean values: yes/no, true/false, on/off.
3029 - Added ``Values``, a subclass of ``optparse.Values``, with support
3030 for list setting attributes.
3031 - Added support for new ``DOCUTILSCONFIG`` environment variable;
3032 thanks to Beni Cherniavsky.
3033 - Added ``--no-section-numbering`` option.
3037 - Catch IOErrors when opening source & destination files, report &
3038 exit without tracebacks. Added ``handle_io_errors`` parameter to
3039 ``FileInput`` & ``FileOutput`` to enable caller error handling.
3041 * docutils/nodes.py:
3043 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
3044 method definitions (via ``exec``) to dynamic assignments (via
3045 ``setattr``); thanks to Roman Suzi.
3046 - Encapsulated visitor dynamic assignments in a function; thanks to
3048 - Added indirect_reference_name attribute to the Targetable
3049 class. This attribute holds the whitespace_normalized_name
3050 (contains mixed case) of a target.
3052 * docutils/statemachine.py:
3054 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
3055 - Added ``StringList.get_2D_block``.
3057 * docutils/utils.py:
3059 - Added "level" attribute to SystemMessage exceptions.
3061 * docutils/languages/af.py: Added to project; Afrikaans mappings by
3064 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
3067 * docutils/languages/eo.py: Added to project; Esperanto mappings by
3068 Marcelo Huerta San Martin.
3070 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
3071 mappings by Lalo Martins.
3073 * docutils/languages/ru.py: Added to project; Russian mappings by
3076 * docutils/parsers/rst/roles.py: Added to project. Contains
3077 interpreted text role functions, a registry for interpreted text
3078 roles, and an API for adding to and retrieving from the registry.
3079 Contributed by Edward Loper.
3081 * docutils/parsers/rst/states.py:
3083 - Updated ``RSTState.nested_parse`` for "include" in table cells.
3084 - Allowed true em-dash character and "``---``" as block quote
3086 - Added support for <angle-bracketed> complex option arguments
3088 - Fixed handling of backslashes in substitution definitions.
3089 - Fixed off-by-1 error with extra whitespace after substitution
3090 definition directive.
3091 - Added inline markup parsing to field lists' field names.
3092 - Added support for quoted (and unindented) literal blocks.
3093 Driven in part by a bribe from Frank Siebenlist (thanks!).
3094 - Parser now handles escapes in URIs correctly.
3095 - Made embedded-URIs' reference text omittable. Idea from Beni
3097 - Refactored explicit target processing code.
3098 - Added name attribute to references containing the reference name only
3099 through whitespace_normalize_name (no case changes).
3100 - parse_target no longer returns the refname after going through
3101 normalize_name. This is now handled in make_target.
3102 - Fixed bug relating to role-less interpreted text in non-English
3104 - Reorganized interpreted text processing; moved code into the new
3105 roles.py module. Contributed by Edward Loper.
3106 - Refactored ``Body.parse_directive`` into ``run_directive`` and
3107 ``parse_directive_block``.
3109 * docutils/parsers/rst/tableparser.py:
3111 - Reworked for ``StringList``, to support "include" directives in
3114 * docutils/parsers/rst/directives/__init__.py:
3116 - Renamed ``unchanged()`` directive option conversion function to
3117 ``unchanged_required``, and added a new ``unchanged``.
3118 - Catch unicode value too high error; fixes bug 781766.
3119 - Beefed up directive error reporting.
3121 * docutils/parsers/rst/directives/body.py:
3123 - Added basic "table" directive.
3125 * docutils/parsers/rst/directives/images.py:
3127 - Added "target" option to "image" directive.
3128 - Added name attribute to references containing the reference name only
3129 through whitespace_normalize_name (no case changes).
3131 * docutils/parsers/rst/directives/misc.py:
3133 - Isolated the import of the ``urllib2`` module; was causing
3134 problems on SourceForge (``libssl.so.2`` unavailable?).
3135 - Added the "role" directive for declaring custom interpreted text
3138 * docutils/parsers/rst/directives/parts.py:
3140 - The "contents" directive does more work up-front, creating the
3141 "topic" and "title", and leaving the "pending" node for the
3142 transform. Allows earlier reference resolution; fixes subtle bug.
3144 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
3145 mappings by Jannie Hofmeyr.
3147 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
3148 mappings by Marek Blaha.
3150 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
3151 mappings by Marcelo Huerta San Martin.
3153 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
3154 Portuguese mappings by Lalo Martins.
3156 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
3157 mappings by Roman Suzi.
3159 * docutils/transforms/parts.py:
3161 - The "contents" directive does more work up-front, creating the
3162 "topic" and "title", and leaving the "pending" node for the
3163 transform. Allows earlier reference resolution; fixes subtle bug.
3164 - Added support for disabling of section numbering.
3166 * docutils/transforms/references.py:
3168 - Verifying that external targets are truly targets and not indirect
3169 references. This is because we are now adding a "name" attribute to
3170 references in addition to targets. Note sure if this is correct!
3171 - Added code to hook into the unknown_reference_resolvers list for a
3172 transformer in resolve_indirect_target. This allows the
3173 unknown_reference_resolvers to keep around indirect targets which
3174 docutils doesn't know about.
3175 - Added specific error message for duplicate targets.
3177 * docutils/transforms/universal.py:
3179 - Added FilterMessages transform (removes system messages below the
3180 verbosity threshold).
3181 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
3182 to FinalCheckVisitor for application-specific handling of
3183 unresolvable references.
3184 - Added specific error message for duplicate targets.
3186 * docutils/writers/__init__.py:
3188 - Added assemble_parts method to the Writer class to allow for
3189 access to a documents individual parts.
3190 - Documented & set default for ``Writer.output`` attribute.
3192 * docutils/writers/html4css1.py:
3194 - Fixed unicode handling of attribute values (bug 760673).
3195 - Prevent duplication of "class" attribute values (bug report from
3197 - Improved table grid/border handling (prompted by report from Bob
3199 - Added support for table titles.
3200 - Added "<title />" for untitled docs, for XHTML conformance; thanks
3202 - Added functionality to keep track of individual parts of a document
3203 and store them in a dictionary as the "parts" attribute of the writer.
3204 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
3205 - Added proper support for the "scale" attribute of the "image"
3206 element. Contributed by Brent Cook.
3207 - Added ``--initial-header-level`` option.
3208 - Fixed bug: the body_pre_docinfo segment depended on there being a
3209 docinfo; if no docinfo, the document title was incorporated into
3210 the body segment. Adversely affected the publish_parts interface.
3212 * docutils/writers/latex2e.py:
3214 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
3215 about a missing file.
3216 - Added options and support: ``--compound-enumerators``,
3217 ``--section-prefix-for-enumerators``, and
3218 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
3220 - Added option ``--use-verbatim-when-possible``, to avoid
3221 problematic characters (eg, '~' in italian) in literal blocks.
3222 - It's now possible to use four section levels in the `book` and
3223 `report` LaTeX document classes. The default `article` class still has
3226 * docs/config.txt: "Docutils Configuration Files", added to project.
3227 Moved config file entry descriptions from tools.txt.
3231 - Moved config file entry descriptions to config.txt.
3233 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
3236 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
3237 Text Roles", added to project.
3239 * spec/rst/reStructuredText.txt:
3241 - Added description of support for <angle-bracketed> complex option
3242 arguments to option lists.
3243 - Added subsections for indented and quoted literal blocks.
3245 * test: Continually adding & updating tests.
3247 - Added test/test_settings.py & test/data/config_*.txt support
3249 - Added test/test_writers/test_htmlfragment.py.
3251 * test/DocutilsTestSupport.py:
3253 - Refactored LaTeX publisher test suite/case class names to make
3254 testing other writers easier.
3255 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
3256 to test the processing of HTML fragments which use the new
3257 publish_parts convenience function.
3259 * tools/buildhtml.py:
3261 - Added support for the ``--prune`` option.
3262 - Removed dependency on pep2html.py; plaintext PEPs no longer
3265 * tools/docutils.conf:
3267 - Updated for configuration file reorganization.
3269 * tools/rst2html.py:
3271 - copied from tools/html.py
3275 - added a 'scripts' section to configuration
3276 - added 'tools/rst2html.py' to the scripts section
3279 Release 0.3 (2003-06-24)
3280 ========================
3284 * Renamed "attribute" to "option" for directives/extensions.
3286 * Renamed transform method "transform" to "apply".
3288 * Renamed "options" to "settings" for runtime settings (as set by
3289 command-line options). Sometimes "option" (singular) became
3290 "settings" (plural). Some variations below:
3292 - document.options -> document.settings (stored in other objects as
3294 - option_spec -> settings_spec (not directives though)
3295 - OptionSpec -> SettingsSpec
3296 - cmdline_options -> settings_spec
3297 - relative_path_options -> relative_path_settings
3298 - option_default_overrides -> settings_default_overrides
3299 - Publisher.set_options -> Publisher.get_settings
3303 * COPYING.txt: Added "Public Domain Dedication".
3305 * FAQ.txt: Frequently asked questions, added to project.
3309 - Updated with PyPI Trove classifiers.
3310 - Conditional installation of third-party modules.
3312 * docutils/__init__.py:
3314 - Bumped version to 0.2.1 to reflect changes to I/O classes.
3315 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
3316 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
3317 - Bumped version to 0.2.3 because of the new ``--embed-stylesheet``
3318 option and its effect on the PEP template & writer.
3319 - Bumped version to 0.2.4 due to changes to the PEP template &
3321 - Bumped version to 0.2.5 to reflect changes to Reporter output.
3322 - Added ``TransformSpec`` class for new transform system.
3323 - Bumped version to 0.2.6 for API changes (renaming).
3324 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
3325 convenience functions.
3326 - Added ``Component.component_type`` attribute.
3327 - Bumped version to 0.2.8 because of the internal parser switch from
3328 plain lists to the docutils.statemachine.StringList objects.
3329 - Bumped version to 0.2.9 because of the frontend.py API changes.
3330 - Bumped version to 0.2.10 due to changes to the project layout
3331 (third-party modules removed from the "docutils" package), and
3332 signature changes in ``io.Input``/``io.Output``.
3333 - Changed version to 0.3.0 for release.
3337 - Made ``publish()`` a bit more convenient.
3338 - Generalized ``Publisher.set_io``.
3339 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
3340 parameters; improved its docstring.
3341 - Added ``publish_file()`` and ``publish_string()``.
3342 - Factored ``Publisher.set_source()`` and ``.set_destination()``
3344 - Added support for ``--dump-pseudo-xml``, ``--dump-settings``, and
3345 ``--dump-transforms`` hidden options.
3346 - Added ``Publisher.apply_transforms()`` method.
3347 - Added ``Publisher.set_components()`` method; support for
3348 ``publish_*()`` conveninece functions.
3349 - Moved config file processing to docutils/frontend.py.
3350 - Added support for exit status ("exit_level" setting &
3351 ``enable_exit`` parameter for Publisher.publish() and convenience
3354 * docutils/frontend.py:
3356 - Check for & exit on identical source & destination paths.
3357 - Fixed bug with absolute paths & ``--config``.
3358 - Set non-command-line defaults in ``OptionParser.__init__()``:
3359 ``_source`` & ``_destination``.
3360 - Distributed ``relative_path_settings`` to components; updated
3361 ``OptionParser.populate_from_components()`` to combine it all.
3362 - Require list of keys in ``make_paths_absolute`` (was implicit in
3363 global ``relative_path_settings``).
3364 - Added ``--expose-internal-attribute``, ``--dump-pseudo-xml``,
3365 ``--dump-settings``, and ``--dump-transforms`` hidden options.
3366 - Removed nasty internals-fiddling ``ConfigParser.get_section``
3367 code, replaced with correct code.
3368 - Added validation functionality for config files.
3369 - Added ``--error-encoding`` option/setting, "_disable_config"
3371 - Added encoding validation; updated ``--input-encoding`` and
3372 ``--output-encoding``; added ``--error-encoding-error-handler`` and
3373 ``--output-encoding-error-handler``.
3374 - Moved config file processing from docutils/core.py.
3375 - Updated ``OptionParser.populate_from_components`` to handle new
3376 ``SettingsSpec.settings_defaults`` dict.
3377 - Added support for "-" => stdin/stdout.
3378 - Added "exit_level" setting (``--exit`` option).
3382 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
3383 - Added automatic closing to ``FileInput`` and ``FileOutput``.
3384 - Delayed opening of ``FileOutput`` file until ``write()`` called.
3385 - ``FileOutput.write()`` now returns the encoded output string.
3386 - Try to get path/stream name automatically in ``FileInput`` &
3388 - Added defaults for source & destination paths.
3389 - Allow for Unicode I/O with an explicit "unicode" encoding.
3390 - Added ``Output.encode()``.
3391 - Removed dependency on runtime settings; pass encoding directly.
3392 - Recognize Unicode strings in ``Input.decode()``.
3393 - Added support for output encoding error handlers.
3395 * docutils/nodes.py:
3397 - Added "Invisible" element category class.
3398 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
3399 modification during a traversal.
3400 - Added element classes: ``line_block``, ``generated``, ``address``,
3401 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
3402 ``superscript``, ``subscript``, ``inline``
3403 - Added support for lists of nodes to ``Element.insert()``.
3404 - Fixed parent linking in ``Element.replace()``.
3405 - Added new abstract superclass ``FixedTextElement``; adds
3406 "xml:space" attribute.
3407 - Added support for "line" attribute of ``system_message`` nodes.
3408 - Added support for the observer pattern from ``utils.Reporter``.
3409 Added ``parse_messages`` and ``transform_messages`` attributes to
3410 ``document``, removed ``messages``. Added ``note_parse_message``
3411 and ``note_transform_message`` methods.
3412 - Added support for improved diagnostics:
3414 - Added "document", "source", and "line" internal attributes to
3415 ``Node``, set by ``Node.setup_child()``.
3416 - Converted variations on ``node.parent = self`` to
3417 ``self.setup_child(node)``.
3418 - Added ``document.current_source`` & ``.current_line``
3419 attributes, and ``.note_source`` observer method.
3420 - Changed "system_message" output to GNU-Tools format.
3422 - Added a "rawsource" attribute to the ``Text`` class, for text
3423 before backslash-escape resolution.
3424 - Support for new transform system.
3425 - Reworked ``pending`` element.
3426 - Fixed XML DOM bug (SF #660611).
3427 - Removed the ``interpeted`` element class and added
3428 ``title_reference``, ``abbreviation``, ``acronym``.
3429 - Made substitutions case-sensitive-but-forgiving; moved some code
3431 - Fixed Unicode bug on element attributes (report: William Dode).
3433 * docutils/optik.py: Removed from project; replaced with
3434 extras/optparse.py and extras/textwrap.py. These will be installed
3435 only if they're not already present in the Python installation.
3437 * docutils/roman.py: Moved to extras/roman.py; this will be installed
3438 only if it's not already present in the Python installation.
3440 * docutils/statemachine.py:
3442 - Factored out ``State.add_initial_transitions()`` so it can be
3444 - Converted whitespace-specific "blank" and "indent" transitions
3445 from special-case code to ordinary transitions: removed
3446 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
3447 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
3448 ``ws_initial_transitions`` attributes.
3449 - Removed ``State.match_transition()`` after merging it into
3451 - Added ``StateCorrection`` exception.
3452 - Added support for ``StateCorrection`` in ``StateMachine.run()``
3453 (moved ``TransitionCorrection`` support there too.)
3454 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
3455 ``EOFError`` instead of ``IndexError``.
3456 - Added ``State.no_match`` method.
3457 - Added support for the Observer pattern, triggered by input line
3459 - Added ``strip_top`` parameter to
3460 ``StateMachineWS.get_first_known_indented``.
3461 - Made ``context`` a parameter to ``StateMachine.run()``.
3462 - Added ``ViewList`` & ``StringList`` classes;
3463 ``extract_indented()`` becomes ``StringList.get_indented()``.
3464 - Added ``StateMachine.insert_input()``.
3465 - Fixed ViewList slice handling for Python 2.3. Patch from (and
3466 thanks to) Fred Drake.
3468 * docutils/utils.py:
3470 - Added a ``source`` attribute to Reporter instances and
3471 ``system_message`` elements.
3472 - Added an observer pattern to ``utils.Reporter`` to keep track of
3474 - Fixed bugs in ``relative_path()``.
3475 - Added support for improved diagnostics.
3476 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
3477 - Added support for encoding Reporter stderr output, and encoding
3479 - Reporter keeps track of the highest level system message yet
3482 * docutils/languages: Fixed bibliographic field language lookups.
3484 * docutils/languages/es.py: Added to project; Spanish mappings by
3485 Marcelo Huerta San Martin.
3487 * docutils/languages/fr.py: Added to project; French mappings by
3490 * docutils/languages/it.py: Added to project; Italian mappings by
3493 * docutils/languages/sk.py: Added to project; Slovak mappings by
3496 * docutils/parser/__init__.py:
3498 - Added ``Parser.finish_parse()`` method.
3500 * docutils/parser/rst/__init__.py:
3502 - Added options: ``--pep-references``, ``--rfc-references``,
3503 ``--tab-width``, ``--trim-footnote-reference-space``.
3505 * docutils/parsers/rst/states.py:
3507 - Changed "title under/overline too short" system messages from INFO
3508 to WARNING, and fixed its insertion location.
3509 - Fixed enumerated list item parsing to allow paragraphs & section
3510 titles to begin with enumerators.
3511 - Converted system messages to use the new "line" attribute.
3512 - Fixed a substitution reference edge case.
3513 - Added support for ``--pep-references`` and ``--rfc-references``
3514 options; reworked ``Inliner`` code to make customization easier.
3515 - Removed field argument parsing.
3516 - Added support for short section title over/underlines.
3517 - Fixed "simple reference name" regexp to ignore text like
3518 "object.__method__"; not an anonymous reference.
3519 - Added support for improved diagnostics.
3520 - Reworked directive API, based on Dethe Elza's contribution. Added
3521 ``Body.parse_directive()``, ``.parse_directive_options()``,
3522 ``.parse_directive_arguments()`` methods.
3523 - Added ``ExtensionOptions`` class, to parse directive options
3524 without parsing field bodies. Factored
3525 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
3526 ``ExtensionOptions``.
3527 - Improved definition list term/classifier parsing.
3528 - Added warnings for unknown directives.
3529 - Renamed ``Stuff`` to ``Struct``.
3530 - Now flagged as errors: transitions at the beginning or end of
3531 sections, empty sections (except title), and empty documents.
3532 - Updated for ``statemachine.StringList``.
3533 - Enabled recognition of schemeless email addresses in targets.
3534 - Added support for embedded URIs in hyperlink references.
3535 - Added backslash-escapes to inline markup end-string suffix.
3536 - Added support for correct interpreted text processing.
3537 - Fixed nested title parsing (topic, sidebar directives).
3538 - Added special processing of backslash-escaped whitespace (idea
3539 from David Abrahams).
3540 - Made substitutions case-sensitive-but-forgiving; moved some code
3541 to ``docutils.nodes``.
3542 - Added support for block quote attributions.
3543 - Added a kludge to work-around a conflict between the bubble-up
3544 parser strategy and short titles (<= 3 char-long over- &
3545 underlines). Fixes SF bug #738803 "infinite loop with multiple
3546 titles" submitted by Jason Diamond.
3547 - Added explicit interpreted text roles for standard inline markup:
3548 "emphasis", "strong", "literal".
3549 - Implemented "superscript" and "subscript" interpreted text roles.
3550 - Added initial support for "abbreviation" and "acronym" roles;
3552 - Added support for ``--trim-footnote-reference-space`` option.
3553 - Optional space before colons in directives & hyperlink targets.
3555 * docutils/parsers/rst/tableparser.py:
3557 - Fixed a bug that was producing unwanted empty rows in "simple"
3559 - Detect bad column spans in "simple" tables.
3561 * docutils/parsers/rst/directives: Updated all directive functions to
3564 * docutils/parsers/rst/directives/__init__.py:
3566 - Added ``flag()``, ``unchanged()``, ``path()``,
3567 ``nonnegative_int()``, ``choice()``, and ``class_option()``
3568 directive option helper functions.
3569 - Added warnings for unknown directives.
3570 - Return ``None`` for missing directives.
3571 - Added ``register_directive()``, thanks to William Dode and Paul
3574 * docutils/parsers/rst/directives/admonitions.py:
3576 - Added "admonition" directive.
3578 * docutils/parsers/rst/directives/body.py: Added to project. Contains
3579 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
3580 "parsed-literal", "rubric", "epigraph", "highlights" and
3581 "pull-quote" directives.
3583 * docutils/parsers/rst/directives/images.py:
3585 - Added an "align" attribute to the "image" & "figure" directives
3586 (by Adam Chodorowski).
3587 - Added "class" option to "image", and "figclass" to "figure".
3589 * docutils/parsers/rst/directives/misc.py:
3591 - Added "include", "raw", and "replace" directives, courtesy of
3593 - Added "unicode" and "class" directives.
3595 * docutils/parsers/rst/directives/parts.py:
3597 - Added the "sectnum" directive; by Dmitry Jemerov.
3598 - Added "class" option to "contents" directive.
3600 * docutils/parsers/rst/directives/references.py: Added to project.
3601 Contains the "target-notes" directive.
3603 * docutils/parsers/rst/languages/__init__.py:
3605 - Return ``None`` from get_language() for missing language modules.
3607 * docutils/parsers/rst/languages/de.py: Added to project; German
3608 mappings by Engelbert Gruber.
3610 * docutils/parsers/rst/languages/en.py:
3612 - Added interpreted text roles mapping.
3614 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
3615 mappings by Marcelo Huerta San Martin.
3617 * docutils/parsers/rst/languages/fr.py: Added to project; French
3618 mappings by William Dode.
3620 * docutils/parsers/rst/languages/it.py: Added to project; Italian
3621 mappings by Nicola Larosa.
3623 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
3624 mappings by Miroslav Vasko.
3626 * docutils/readers/__init__.py:
3628 - Added support for the observer pattern from ``utils.Reporter``, in
3629 ``Reader.parse`` and ``Reader.transform``.
3630 - Removed ``Reader.transform()`` method.
3631 - Added default parameter values to ``Reader.__init__()`` to make
3632 instantiation easier.
3633 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
3635 * docutils/readers/pep.py:
3637 - Added the ``peps.TargetNotes`` transform to the Reader.
3638 - Removed PEP & RFC reference detection code; moved to
3639 parsers/rst/states.py as options (enabled here by default).
3640 - Added support for pre-acceptance PEPs (no PEP number yet).
3641 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
3644 * docutils/readers/python: Python Source Reader subpackage added to
3645 project, including preliminary versions of:
3648 - moduleparser.py: Parser for Python modules.
3650 * docutils/transforms/__init__.py:
3652 - Added ``Transformer`` class and completed transform reform.
3653 - Added unknown_reference_resolvers list for each transformer. This list holds
3654 the list of functions provided by each component of the transformer that
3655 help resolve references.
3657 * docutils/transforms/frontmatter.py:
3659 - Improved support for generic fields.
3660 - Fixed bibliographic field language lookups.
3662 * docutils/transforms/misc.py: Added to project. Miscellaneous
3665 * docutils/transforms/parts.py:
3667 - Moved the "id" attribute from TOC list items to the references
3668 (``Contents.build_contents()``).
3669 - Added the ``SectNum`` transform; by Dmitry Jemerov.
3670 - Added "class" attribute support to ``Contents``.
3672 * docutils/transforms/peps.py:
3674 - Added ``mask_email()`` function, updating to pep2html.py's
3676 - Linked "Content-Type: text/x-rst" to PEP 12.
3677 - Added the ``TargetNotes`` PEP-specific transform.
3678 - Added ``TargetNotes.cleanup_callback``.
3679 - Added title check to ``Headers``.
3681 * docutils/transforms/references.py:
3683 - Added the ``TargetNotes`` generic transform.
3684 - Split ``Hyperlinks`` into multiple transforms.
3685 - Fixed bug with multiply-indirect references (report: Bruce Smith).
3686 - Added check for circular indirect references.
3687 - Made substitutions case-sensitive-but-forgiving.
3689 * docutils/transforms/universal.py:
3691 - Added support for the ``--expose-internal-attributes`` option.
3692 - Removed ``Pending`` transform classes & data.
3694 * docutils/writers/__init__.py:
3696 - Removed ``Writer.transform()`` method.
3698 * docutils/writers/docutils-xml.py:
3700 - Added XML and doctype declarations.
3701 - Added ``--no-doctype`` and ``--no-xml-declaration`` options.
3703 * docutils/writers/html4css1.py:
3705 - "name" attributes only on these tags: a, applet, form, frame,
3707 - Added "name" attribute to <a> in section titles for Netscape 4
3708 support (bug report: Pearu Peterson).
3709 - Fixed targets (names) on footnote, citation, topic title,
3710 problematic, and system_message nodes (for Netscape 4).
3711 - Changed field names from "<td>" to "<th>".
3712 - Added "@" to "@" encoding to thwart address harvesters.
3713 - Improved the vertical whitespace optimization; ignore "invisible"
3714 nodes (targets, comments, etc.).
3715 - Improved inline literals with ``<span class="pre">`` around chunks
3716 of text and `` `` for runs of spaces.
3717 - Improved modularity of output; added ``self.body_pre_docinfo`` and
3718 ``self.docinfo`` segments.
3719 - Added support for "line_block", "address" elements.
3720 - Improved backlinks (footnotes & system_messages).
3721 - Improved system_message output.
3722 - Redefined ``--stylesheet`` as containing an invariant URL, used
3723 verbatim. Added ``--stylesheet-path``, interpreted w.r.t. the
3725 - Added ``--footnote-references`` option (superscript or brackets).
3726 - Added ``--compact-lists`` and ``--no-compact-lists`` options.
3727 - Added ``--embed-stylesheet`` and ``--link-stylesheet`` options;
3728 factored out ``HTMLTranslator.get_stylesheet_reference()``.
3729 - Improved field list rendering.
3730 - Added Docutils version to "generator" meta tag.
3731 - Fixed a bug with images; they must be inline, so wrapped in <p>.
3732 - Improved layout of <pre> HTML source.
3733 - Fixed attribute typo on <colspec>.
3734 - Refined XML prologue.
3735 - Support for no stylesheet.
3736 - Removed "interpreted" element support.
3737 - Added support for "title_reference", "sidebar", "attribution",
3738 "rubric", and generic "admonition" elements.
3739 - Added ``--attribution`` option.
3740 - Added support for "inline", "subscript", "superscript" elements.
3741 - Added initial support for "abbreviation" and "acronym";
3744 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3748 - Double quotes in literal blocks (special treatment for de/ngerman).
3749 - Added ``--hyperlink-color`` option ('0' turns off coloring of links).
3750 - Added ``--attribution`` option.
3751 - Right align attributions.
3753 * docutils/writers/pep_html.py:
3755 - Parameterized output encoding in PEP template.
3756 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3757 - Redefined ``--pep-stylesheet`` as containing an invariant URL, used
3758 verbatim. Added ``--pep-stylesheet-path``, interpreted w.r.t. the
3760 - Added an override on the ``--footnote-references`` option.
3761 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3762 - Added Docutils version to "generator" meta tag.
3763 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3767 - Added a "silent" setting for ``buildhtml.py``.
3768 - Added a "Getting Help" section.
3769 - Rearranged the structure.
3770 - Kept up to date, with new settings, command-line options etc.
3771 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3772 - Converted settings table into a definition list.
3774 * docs/rst/quickstart.txt:
3776 - Added a table of contents.
3777 - Added feedback information.
3778 - Added mention of minimum section title underline lengths.
3779 - Removed the 4-character minimum for section title underlines.
3781 * docs/rst/quickref.html:
3783 - Added a "Getting Help" section.
3784 - Added a style to make section title backlinks more subtle.
3785 - Added mention of minimum section title underline lengths.
3786 - Removed the 4-character minimum for section title underlines.
3788 * extras: Directory added to project; contains third-party modules
3789 that Docutils depends on (optparse, textwrap, roman). These are
3790 only installed if they're not already present.
3792 * licenses: Directory added to project; contains copies of license
3793 files for non-public-domain files.
3797 - Changed the focus. It's about DTD elements: structural
3798 relationships, semantics, and external (public) attributes. Not
3799 about the element class library.
3800 - Moved some implementation-specific stuff into ``docutils.nodes``
3802 - Wrote descriptions of all common attributes and parameter
3803 entities. Filled in introductory material.
3804 - Working through the element descriptions: 55 down, 37 to go.
3805 - Removed "Representation of Horizontal Rules" to
3806 spec/rst/alternatives.txt.
3808 * spec/docutils.dtd:
3810 - Added "generated" inline element.
3811 - Added "line_block" body element.
3812 - Added "auto" attribute to "title".
3813 - Changed content models of "literal_block" and "doctest_block" to
3815 - Added ``%number;`` attribute type parameter entity.
3816 - Changed ``%structural.elements;`` to ``%section.elements``.
3817 - Updated attribute types; made more specific.
3818 - Added "address" bibliographic element.
3819 - Added "line" attribute to ``system_message`` element.
3820 - Removed "field_argument" element; "field_name" may contain
3821 multiple words and whitespace.
3822 - Changed public identifier to docutils.sf.net.
3823 - Removed "interpreted" element; added "title_reference",
3824 "abbreviation", "acronym".
3825 - Removed "refuri" attribute from "footnote_reference" and
3826 "citation_reference".
3827 - Added "sidebar", "rubric", "attribution", "admonition",
3828 "superscript", "subscript", and "inline" elements.
3830 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3832 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3834 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3836 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3839 * spec/transforms.txt: Added to project.
3841 * spec/howto: Added subdirectory, for developer how-to docs.
3843 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
3844 Elza, edited & extended by David Goodger.
3846 * spec/howto/i18n.txt: Docutils Internationalization. Added to
3849 * spec/rst/alternatives.txt:
3851 - Added "Doctree Representation of Transitions" from
3853 - Updated "Inline External Targets" & closed the debate.
3854 - Added ideas for interpreted text syntax extensions.
3855 - Added "Nested Inline Markup" section.
3857 * spec/rst/directives.txt:
3859 - Added directives: "topic", "sectnum", "target-notes",
3860 "line-block", "parsed-literal", "include", "replace", "sidebar",
3861 "admonition", "rubric", "epigraph", "highlights", "unicode" and
3863 - Formalized descriptions of directive details.
3864 - Added an "align" attribute to the "image" & "figure" directives
3865 (by Adam Chodorowski).
3866 - Added "class" options to "topic", "sidebar", "line-block",
3867 "parsed-literal", "contents", and "image"; and "figclass" to
3870 * spec/rst/interpreted.txt: Added to project. Descriptions of
3871 interpreted text roles.
3873 * spec/rst/introduction.txt:
3875 - Added pointers to material for new users.
3877 * spec/rst/reStructuredText.txt:
3879 - Disambiguated comments (just add a newline after the "::").
3880 - Updated enumerated list description; added a discussion of the
3881 second-line validity checking.
3882 - Updated directive description.
3883 - Added a note redirecting newbies to the user docs.
3884 - Expanded description of inline markup start-strings in non-markup
3886 - Removed field arguments and made field lists a generic construct.
3887 - Removed the 4-character minimum for section title underlines.
3888 - Clarified term/classifier delimiter & inline markup ambiguity
3890 - Added "Embedded URIs".
3891 - Updated "Interpreted Text" section.
3892 - Added "Character-Level Inline Markup" section.
3894 * test: Continually adding & updating tests.
3896 - Moved test/test_rst/ to test/test_parsers/test_rst/.
3897 - Moved test/test_pep/ to test/test_readers/test_pep/.
3898 - Added test/test_readers/test_python/.
3899 - Added test/test_writers/ (Engelbert Gruber).
3903 - Made the ``locale.setlocale()`` calls in front ends
3906 * tools/buildhtml.py:
3908 - Added ``--silent`` option.
3909 - Fixed bug with absolute paths & ``--config``.
3910 - Updated for new I/O classes.
3911 - Added some exception handling.
3912 - Separated publishers' setting defaults; prevents interference.
3913 - Updated for new ``publish_file()`` convenience function.
3915 * tools/pep-html-template:
3917 - Allow for ``--embed-stylesheet``.
3918 - Added Docutils version to "generator" meta tag.
3919 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3920 - Conform to XHTML spec.
3922 * tools/pep2html.py:
3924 - Made ``argv`` a parameter to ``main()``.
3925 - Added support for "Content-Type:" header & arbitrary PEP formats.
3926 - Linked "Content-Type: text/plain" to PEP 9.
3927 - Files skipped (due to an error) are not pushed onto the server.
3928 - Updated for new I/O classes.
3929 - Added ``check_requirements()`` & ``pep_type_error()``.
3930 - Added some exception handling.
3931 - Updated for new ``publish_string()`` convenience function.
3932 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3934 * tools/quicktest.py:
3936 - Added ``-V``/``--version`` option.
3938 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3940 * tools/unicode2rstsubs.py: Added to project. Produces character
3941 entity files (reSructuredText substitutions) from the MathML master
3944 * tools/editors: Support code for editors, added to project. Contains
3945 ``emacs/restructuredtext.el``.
3947 * tools/stylesheets/default.css: Moved into the stylesheets directory.
3949 - Added style for chunks of inline literals.
3950 - Removed margin for first child of table cells.
3951 - Right-aligned field list names.
3952 - Support for auto-numbered section titles in TOCs.
3953 - Increased the size of inline literals (<tt>) in titles.
3954 - Restored the light gray background for inline literals.
3955 - Added support for "line_block" elements.
3956 - Added style for "address" elements.
3957 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
3958 - Improved field list rendering.
3959 - Vertical whitespace improvements.
3960 - Removed "a.target" style.
3962 * tools/stylesheets/pep.css:
3964 - Fixed nested section margins.
3965 - Other changes parallel those of ``../default.css``.
3968 Release 0.2 (2002-07-31)
3969 ========================
3973 - The word "component" was being used ambiguously. From now on,
3974 "component" will be used to mean "Docutils component", as in Reader,
3975 Writer, Parser, or Transform. Portions of documents (Table of
3976 Contents, sections, etc.) will be called "document parts".
3977 - Did a grand renaming: a lot of ``verylongnames`` became
3978 ``very_long_names``.
3979 - Cleaned up imports: no more relative package imports or
3980 comma-separated lists of top-level modules.
3981 - Added support for an option values object which carries default
3982 settings and overrides (from command-line options and library use).
3983 - Added internal Unicode support, and support for both input and
3985 - Added support for the ``docutils.io.IO`` class & subclasses.
3989 * docutils/__init__.py:
3991 - Added ``ApplicationError`` and ``DataError``, for use throughout
3993 - Added ``Component`` base class for Docutils components; implements
3994 the ``supports`` method.
3995 - Added ``__version__`` (thus, ``docutils.__version__``).
3999 - Removed many keyword parameters to ``Publisher.__init__()`` and
4000 ``publish()``; bundled into an option values object. Added
4001 "argv", "usage", "description", and "option_spec" parameters for
4002 command-line support.
4003 - Added ``Publisher.process_command_line()`` and ``.set_options()``
4005 - Reworked I/O model for ``docutils.io`` wrappers.
4006 - Updated ``Publisher.set_options()``; now returns option values
4008 - Added support for configuration files (/etc/docutils.conf,
4009 ./docutils.conf, ~/.docutils).
4010 - Added ``Publisher.setup_option_parser()``.
4011 - Added default usage message and description.
4013 * docutils/frontend.py: Added to project; support for front-end
4014 (command-line) scripts. Option specifications may be augmented by
4015 components. Requires Optik (http://optik.sourceforge.net/) for option
4016 processing (installed locally as docutils/optik.py).
4018 * docutils/io.py: Added to project; uniform API for a variety of input
4021 * docutils/nodes.py:
4023 - Added ``TreeCopyVisitor`` class.
4024 - Added a ``copy`` method to ``Node`` and subclasses.
4025 - Added a ``SkipDeparture`` exception for visitors.
4026 - Renamed ``TreePruningException`` from ``VisitorException``.
4027 - Added docstrings to ``TreePruningException``, subclasses, and
4029 - Improved docstrings.
4030 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
4031 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
4033 - Added ``decoration``, ``header``, and ``footer`` node classes, and
4034 ``PreDecorative`` mixin.
4035 - Reworked the name/id bookkeeping; to ``document``, removed
4036 ``explicit_targets`` and ``implicit_targets`` attributes, added
4037 ``nametypes`` attribute and ``set_name_id_map`` method.
4038 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
4040 - Added ``document.has_name()`` method.
4041 - Fixed DOM generation for list-attributes.
4042 - Added category class ``Labeled`` (used by footnotes & citations).
4043 - Added ``Element.set_class()`` method (sets "class" attribute).
4045 * docutils/optik.py: Added to project. Combined from the Optik
4046 package, with added option groups and other modifications. The use
4047 of this module is probably only temporary.
4049 * docutils/statemachine.py:
4051 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
4052 - Added underscores to improve many awkward names.
4053 - In ``string2lines()``, changed whitespace normalizing translation
4054 table to regexp; restores Python 2.0 compatibility with Unicode.
4056 * docutils/urischemes.py:
4058 - Filled in some descriptions.
4059 - Added "shttp" scheme.
4061 * docutils/utils.py:
4063 - Added ``clean_rcs_keywords`` function (moved from
4064 docutils/transforms/frontmatter.py
4065 ``DocInfo.filter_rcs_keywords``).
4066 - Added underscores to improve many awkward names.
4067 - Changed names of Reporter's thresholds:
4068 warning_level -> report_level; error_level -> halt_level.
4069 - Moved ``utils.id()`` to ``nodes.make_id()``.
4070 - Added ``relative_path(source, target)``.
4072 * docutils/languages/de.py: German mappings; added to project. Thanks
4073 to Gunnar Schwant for the translations.
4075 * docutils/languages/en.py: Added "Dedication" bibliographic field
4078 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
4081 * docutils/parsers/rst/states.py:
4083 - Added underscores to improve many awkward names.
4084 - Added RFC-2822 header support.
4085 - Extracted the inline parsing code from ``RSTState`` to a separate
4086 class, ``Inliner``, which will allow easy subclassing.
4087 - Made local bindings for ``memo`` container & often-used contents
4088 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
4089 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
4090 - Added ``MarkupMismatch`` exception; for late corrections.
4091 - Added ``-/:`` characters to inline markup's start string prefix,
4092 ``/`` to end string suffix.
4093 - Fixed a footnote bug.
4094 - Fixed a bug with literal blocks.
4095 - Applied patch from Simon Budig: simplified regexps with symbolic
4096 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
4097 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
4098 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
4099 - Allowed non-ASCII in "simple names" (directive names, field names,
4101 - Converted ``Inliner.patterns.initial`` to be dynamically built
4102 from parts with ``build_regexp()`` function.
4103 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
4104 - Updated docstrings.
4105 - Changed "table" to "grid_table"; added "simple_table" support.
4107 * docutils/parsers/rst/tableparser.py:
4109 - Changed ``TableParser`` to ``GridTableParser``.
4110 - Added ``SimpleTableParser``.
4111 - Refactored naming.
4113 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
4114 a fallback language for directive names.
4116 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
4117 directive to use a ``pending`` element, used only by HTML writers.
4119 * docutils/parsers/rst/directives/parts.py: Renamed from
4122 - Added "backlinks" attribute to "contents" directive.
4124 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
4125 project by Adam Chodorowski.
4127 * docutils/readers/__init__.py: Gave Readers more control over
4128 choosing and instantiating Parsers.
4130 * docutils/readers/pep.py: Added to project; for PEP processing.
4132 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
4133 requires a ``component`` parameter.
4135 * docutils/transforms/components.py: Added to project; transforms
4136 related to Docutils components.
4138 * docutils/transforms/frontmatter.py:
4140 - In ``DocInfo.extract_authors``, check for a single "author" in an
4141 "authors" group, and convert it to a single "author" element.
4142 - Added support for "Dedication" and generic bibliographic fields.
4144 * docutils/transforms/peps.py: Added to project; PEP-specific.
4146 * docutils/transforms/parts.py: Renamed from old components.py.
4148 - Added filter for ``Contents``, to use alt-text for inline images,
4149 and to remove inline markup that doesn't make sense in the ToC.
4150 - Added "name" attribute to TOC topic depending on its title.
4151 - Added support for optional TOC backlinks.
4153 * docutils/transforms/references.py: Fixed indirect target resolution
4154 in ``Hyperlinks`` transform.
4156 * docutils/transforms/universal.py:
4158 - Changed ``Messages`` transform to properly filter out system
4159 messages below the warning threshold.
4160 - Added ``Decorations`` transform (support for ``--generator``,
4161 ``--date``, ``--time``, ``--source-link`` options).
4163 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
4164 Engelbert Gruber's PDF writer.
4166 * docutils/writers/html4css1.py:
4168 - Made XHTML-compatible (switched to lowercase element & attribute
4169 names; empty tag format).
4170 - Escape double-dashes in comment text.
4171 - Improved boilerplate & modularity of output.
4172 - Exposed modular output in Writer class.
4173 - Added a "generator" meta tag to <head>.
4174 - Added support for the ``--stylesheet`` option.
4175 - Added support for ``decoration``, ``header``, and ``footer``
4177 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
4178 translation table to regexp; restores Python 2.0 compatibility
4180 - Added the translator class as instance variable to the Writer, to
4181 make it easily subclassable.
4182 - Improved option list spacing (thanks to Richard Jones).
4183 - Modified field list output.
4184 - Added backlinks to footnotes & citations.
4185 - Added percentage widths to "<col>" tags (from colspec).
4186 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
4187 "<span>" changed to "<var>".
4188 - Inline literals: "<code>" changed to "<tt>".
4189 - Many changes to optimize vertical space: compact simple lists etc.
4190 - Add a command-line options & directive attributes to control TOC
4191 and footnote/citation backlinks.
4192 - Added support for optional footnote/citation backlinks.
4193 - Added support for generic bibliographic fields.
4194 - Identify backrefs.
4195 - Relative URLs for stylesheet links.
4197 * docutils/writers/pep_html.py: Added to project; HTML Writer for
4198 PEPs (subclass of ``html4css1.Writer``).
4200 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
4202 * docutils/writers/docutils_xml.py: Added to project; trivial writer
4203 of the Docutils internal doctree in XML.
4205 * docs/tools.txt: "Docutils Front-End Tools", added to project.
4209 - Changed the title to "The Docutils Document Tree".
4210 - Added "Hyperlink Bookkeeping" section.
4212 * spec/docutils.dtd:
4214 - Added ``decoration``, ``header``, and ``footer`` elements.
4215 - Brought ``interpreted`` element in line with the parser: changed
4216 attribute "type" to "role", added "position".
4217 - Added support for generic bibliographic fields.
4219 * spec/notes.txt: Continual updates. Added "Project Policies".
4221 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
4224 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
4226 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
4227 mailing list discussions.
4229 * spec/pep-0287.txt:
4231 - Renamed to "reStructuredText Docstring Format".
4233 - Reworked Q&A as an enumerated list.
4234 - Converted to reStructuredText format.
4236 * spec/pysource.dtd:
4238 - Reworked structural elements, incorporating ideas from Tony Ibbs.
4240 * spec/pysource.txt: Removed from project. Moved much of its contents
4243 * spec/rst/alternatives.txt:
4245 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
4246 - Added "Inline External Targets" section.
4248 * spec/rst/directives.txt:
4250 - Added "backlinks" attribute to "contents" directive.
4252 * spec/rst/problems.txt:
4254 - Updated the Enumerated List Markup discussion.
4255 - Added new alternative table markup syntaxes.
4257 * spec/rst/reStructuredText.txt:
4259 - Clarified field list usage.
4260 - Updated enumerated list description.
4261 - Clarified purpose of directives.
4262 - Added ``-/:`` characters to inline markup's start string prefix,
4263 ``/`` to end string suffix.
4264 - Updated "Authors" bibliographic field behavior.
4265 - Changed "inline hyperlink targets" to "inline internal targets".
4266 - Added "simple table" syntax to supplement the existing but
4267 newly-renamed "grid tables".
4268 - Added cautions for anonymous hyperlink use.
4269 - Added "Dedication" and generic bibliographic fields.
4271 * test: Made test modules standalone (subdirectories became packages).
4273 * test/DocutilsTestSupport.py:
4275 - Added support for PEP extensions to reStructuredText.
4276 - Added support for simple tables.
4277 - Refactored naming.
4279 * test/package_unittest.py: Renamed from UnitTestFolder.py.
4281 - Now supports true packages containing test modules
4282 (``__init__.py`` files required); fixes duplicate module name bug.
4284 * test/test_pep/: Subpackage added to project; PEP testing.
4286 * test/test_rst/test_SimpleTableParser.py: Added to project.
4290 - Updated html.py and publish.py front-end tools to use the new
4291 command-line processing facilities of ``docutils.frontend``
4292 (exposed in ``docutils.core.Publisher``), reducing each to just a
4294 - Added ``locale.setlocale()`` calls to front-end tools.
4296 * tools/buildhtml.py: Added to project; batch-generates .html from all
4297 the .txt files in directories and subdirectories.
4299 * tools/default.css:
4301 - Added support for ``header`` and ``footer`` elements.
4302 - Added styles for "Dedication" topics (biblio fields).
4304 * tools/docutils.conf: A configuration file; added to project.
4306 * tools/docutils-xml.py: Added to project.
4308 * tools/pep.py: Added to project; PEP to HTML front-end tool.
4310 * tools/pep-html-template: Added to project.
4312 * tools/pep2html.py: Added to project from Python (nondist/peps).
4313 Added support for Docutils (reStructuredText PEPs).
4315 * tools/quicktest.py:
4317 - Added the ``--attributes`` option, hacked a bit.
4318 - Added a second command-line argument (output file); cleaned up.
4320 * tools/stylesheets/: Subdirectory added to project.
4322 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
4325 Release 0.1 (2002-04-20)
4326 ========================
4328 This is the first release of Docutils, merged from the now inactive
4329 reStructuredText__ and `Docstring Processing System`__ projects. For
4330 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
4331 `DPS HISTORY`__ files.
4333 __ http://structuredtext.sourceforge.net/
4334 __ http://docstring.sourceforge.net/
4335 __ http://structuredtext.sourceforge.net/HISTORY.html
4336 __ http://docstring.sourceforge.net/HISTORY.html
4338 General changes: renamed 'dps' package to 'docutils'; renamed
4339 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
4340 the test suites (reStructuredText's test/test_states renamed to
4341 test/test_rst); and all modifications required to make it all work.
4343 * docutils/parsers/rst/states.py:
4345 - Improved diagnostic system messages for missing blank lines.
4346 - Fixed substitution_reference bug.
4351 .. _RELEASE-NOTES: RELEASE-NOTES.html
4352 .. _`_config_files`: docs/user/config.html#config-files
4353 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
4355 .. _detailed: docs/user/config.html#detailed
4356 .. _docutils_footnotes: docs/user/config.html#docutils-footnotes
4357 .. _dump_settings: docs/user/config.html#dump-settings
4358 .. _embed_images: docs/user/config.html#embed-images
4359 .. _embed_stylesheet: docs/user/config.html#embed-stylesheet
4360 .. _figure_footnotes: docs/user/config.html#figure-footnotes
4361 .. _file_insertion_enabled: docs/user/config.html#file-insertion-enabled
4362 .. _graphicx_option: docs/user/config.html#graphicx-option
4363 .. _hidden_controls: docs/user/config.html#hidden-controls
4364 .. _html_writer: docs/user/config.html#html-writer
4365 .. _hyperref_options: docs/user/config.html#hyperref-options
4366 .. _id_prefix: docs/user/config.html#id-prefix
4367 .. _ignore: docs/user/config.html#ignore
4368 .. _image_loading: docs/user/config.html#image-loading
4369 .. _indents: docs/user/config.html#indents
4370 .. _initial_header_level: docs/user/config.html#initial-header-level
4371 .. _input_encoding: docs/user/config.html#input-encoding
4372 .. _input_encoding_error_handler: docs/user/config.html#input-encoding-error-handler
4373 .. _language: docs/user/config.html#language
4374 .. _latex_preamble: docs/user/config.html#latex-preamble
4375 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
4376 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
4377 .. _literal_block_env: docs/user/config.html#literal-block-env
4378 .. _math_output: docs/user/config.html#math-output
4379 .. _output: docs/user/config.html#output
4380 .. _output_encoding: docs/user/config.html#output-encoding
4381 .. _prune: docs/user/config.html#prune
4382 .. _raw_enabled: docs/user/config.html#raw-enabled
4383 .. _reference_label: docs/user/config.html#reference-label
4384 .. _root_prefix: docs/user/config.html#root-prefix
4385 .. _smart_quotes: docs/user/config.html#smart-quotes
4386 .. _sources: docs/user/config.html#sources
4387 .. _strip_classes: docs/user/config.html#strip-classes
4388 .. _strip_elements_with_classes: docs/user/config.html#strip-elements-with-classes
4389 .. _stylesheet: docs/user/config.html#stylesheet
4390 .. _stylesheet_dirs: docs/user/config.html#stylesheet-dirs
4391 .. _stylesheet_path: docs/user/config.html#stylesheet-path
4392 .. _syntax_highlight: docs/user/config.html#syntax-highlight
4393 .. _table_style: docs/user/config.html#table-style
4394 .. _theme: docs/user/config.html#theme
4395 .. _theme_url: docs/user/config.html#theme-url
4396 .. _toc_backlinks: docs/user/config.html#toc-backlinks
4397 .. _traceback: docs/user/config.html#traceback
4398 .. _use_bibtex: docs/user/config.html#use-bibtex
4399 .. _use_latex_abstract: docs/user/config.html#use-latex-abstract
4400 .. _use_latex_footnotes: docs/user/config.html#use-latex-footnotes
4401 .. _use_latex_toc: docs/user/config.html#use-latex-toc
4402 .. _view_mode: docs/user/config.html#view-mode
4404 .. _<meta>: docs/ref/doctree.html#meta
4405 .. _<image>: docs/ref/doctree.html#image
4406 .. _<inline>: docs/ref/doctree.html#inline
4407 .. _<literal>: docs/ref/doctree.html#literal
4413 indent-tabs-mode: nil
4414 sentence-end-double-space: t