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.
17 Release 0.22b.dev (unpublished)
18 ===============================
22 - Add tox.ini to pyproject.toml to be in sdist (bug #486).
23 - Fix license issue (bug #487).
25 * docs/ref/docutils.dtd
27 - Allow multiple <term> elements in a <definition_list_item>.
28 Fixes feature-request #60
32 - Removed `Publisher.setup_option_parser()` (internal, obsolete).
33 - Allow a string value (component name or alias) in the
34 "reader", "parser", and "writer" arguments of `Publisher.__init__()`
35 and the `publish_*()` convenience functions.
37 * docutils/frontend.py
39 - Drop short options ``-i`` and ``-o`` for ``--input-encoding``
40 and ``--output-encoding``.
41 - Change the default input encoding from ``None`` (auto-detect) to "utf-8".
45 - Raise TypeError if the "rawsource" argument in `Element.__init__()`
46 is an `Element` instance.
47 Catches errors like ``nodes.hint(nodes.paragraph())``.
48 - New element category classes `SubStructural` and `PureTextElement`.
49 - Fix element categories.
50 - New method `Element.validate()`: raise `nodes.ValidationError` if
51 the element does not comply with the "Docutils Document Model".
53 - New "attribute validating functions"
54 convert string representations to correct data type,
56 raise ValueError for invalid attribute names or values.
57 - Removed `Element.set_class()`.
59 * docutils/parsers/docutils_xml.py
61 - New parser for Docutils XML sources. Provisional.
63 * docutils/parsers/recommonmark_wrapper.py
65 - New method `Parser.finish_parse()` to clean up (before validating).
67 * docutils/parsers/rst/directives/misc.py
69 - Pass the included file's path to the parser when the
70 "include" directive is used with :parser: option.
71 Enables system messages with correct source/line indication.
73 * docutils/parsers/rst/directives/tables.py
75 - Removed `CSVTable.decode_from_csv()` and `CSVTable.encode_from_csv()`.
76 Not required with Python 3.
78 * docutils/parsers/rst/roles.py
80 - Renamed `normalized_role_options()` to `normalized_role_options()`
81 (it is now also used for directive options).
83 * docutils/readers/__init__.py:
85 - Deprecate "parser_name" argument of `Reader.__init__()`.
87 * docutils/transforms/frontmatter.py
89 - Update `DocInfo` to work with corrected element categories.
91 * docutils/transforms/misc.py:
93 - Fix for `misc.Transitions`: report an error if a <transition> element
94 follows a <meta> or <decoration> element as this is invalid
95 according to ``docutils.dtd``.
97 * docutils/transforms/writer_aux.py
99 - Removed `Compound` class.
101 * docutils/transforms/references.py
103 - Make `AnonymousHyperlinks` transform idempotent.
105 * docutils/transforms/universal.py
107 - `Messages` also handles "loose" system messages generated by the parser.
109 * docutils/utils/__init__.py
111 - Removed `Reporter.set_conditions()`.
112 Set attributes via configuration settings or directly.
114 * docutils/utils/error_reporting.py
116 - Removed. Obsolete in Python 3.
118 * docutils/writers/docutils-xml.py
120 - Do not increase indentation of follow-up lines inside inline elements.
121 when formatting with `indents`_.
123 * docutils/writers/_html_base.py
125 - Make MathML the default math_output_.
127 * docutils/writers/html4css1/__init__.py
129 - Keep default math_output_ value "HTML math.css".
131 * docutils/writers/latex2e/__init__.py
133 - Remove optional argument `pxunit` of `LaTeXTranslator.to_latex_length()`
134 (ignored since at least 2012).
136 * docutils/writers/manpage.py
138 - Remove code for unused emdash bullets.
139 - Feature-request #105 more informative document comments.
140 docutils version in header
141 - Stop converting text to full capitals (bug #481).
143 * docutils/writers/null.py
145 - `null.Writer.translate()` sets `self.output` to the empty string.
147 * tools/rst2odt_prepstyles.py
149 - Use `core.publish_file()` instead of `core.publish_file_to_binary()`.
151 * tools/rst2odt_prepstyles.py
153 - Removed. Use `docutils.writers.odf_odt.prepstyles`.
156 Release 0.21.2 (2024-04-23)
157 ===========================
159 * Declare support for languages Georgian and Catalan (Valencian).
161 * docs/ref/docutils.dtd
163 - Remove declaration of element <info>.
164 - Remove <decoration> from content declaration of <section> elements.
169 Release 0.21.1 (2024-04-10)
170 ===========================
172 * Add missing files in Docutils 0.21 source distribution (sdist).
174 Release 0.21 (2024-04-09)
175 =========================
179 - Drop support for Python 3.7 and 3.8.
180 - Updated build system to use Flit_ (patch #186 by Adam Turner).
181 Removed ``setup.py``.
182 - Provide ``rst2*`` "console_scripts" `entry points`_
183 (without the ``.py`` extension) instead of installing the
184 ``rst2*.py`` front end tools in the binary PATH.
186 .. _Flit: https://github.com/pypa/flit/
188 * docs/ref/docutils.dtd
190 - The <image> element accepts a new attribute "loading".
192 - Fix definitions (no change to actual behaviour):
194 * The <math_block> element uses the attribute "xml:space".
195 * The <raw> element may contain text only (no inline elements).
196 * The <topic> element uses the "depth" and "local" attributes to
197 store "contents" directive options when used as placeholder for a
198 generated table of contents (LaTeX writers with `use_latex_toc`_
202 Reference names (``%refname.type`` and ``%refnames.type``)
203 are whitespace-normalized but **not** always downcased.
205 * docutils/frontend.py
207 - Allow `validate_*()` functions to be called with just the "value"
208 argument but keep the legacy interface for use with optparse.
209 - New function `frontend.validate_math_output()`.
213 - Simpler and more secure `input encoding`_ default behaviour:
215 Do not use the locale encoding as fallback if Python is started in
216 `UTF-8 mode`_. Stop using "latin1" as second fallback.
218 Remove BOM (U+FEFF ZWNBSP at start of data) only if the "input_encoding"
219 configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'.
220 Do not remove other ZWNBSPs.
222 .. _UTF-8 mode: https://docs.python.org/3/library/os.html#utf8-mode
223 .. _input encoding: docs/api/publisher.html#encodings
225 - Auto-close `FileInput.source` in case of reading/decoding errors.
227 * docutils/languages/, docutils/parsers/rst/languages/
229 - Mark/Fix mistranslated localizations of the "admonition" directive
230 name. In Docutils, "admonition" is used as a generic term for
231 "advice"/"advisory"/"remark", not a reprimand.
232 - Add support for Georgian language (patch #204 by Temuri Doghonadze).
233 - Update/complete Catalan translations (patch #203 by Antoni Bella Pérez).
237 - Remove compatibility hacks `nodes.reprunicode` and `nodes.ensure_str()`.
239 * docutils/parsers/rst/directives/images.py
241 - New "image" directive option "loading".
243 * docutils/parsers/rst/directives/tables.py
245 - Use the same CSV format for the ``:header:`` option and the main data
246 of the "csv-table" directive.
248 - Move `parsers.rst.directives.Table.process_header_option()` method
249 to `parsers.rst.directives.CSVTable`.
251 * docutils/parsers/rst/states.py
253 - Don't split inside "< >" when parsing "option groups" (fixes bug #474).
255 * docutils/parsers/rst/directives/misc.py,
256 docutils/parsers/rst/directives/tables.py
258 - Consider the new root_prefix_ setting when including files with
259 "include", "raw", or "csv-table" directives.
261 * docutils/utils/math/*
263 - Use custom exception `utils.math.MathError` instead of
264 abusing `SyntaxError` for LaTeX math syntax errors.
265 - Unify interface of LaTeX -> MathML conversion functions.
266 Improve error reporting.
267 - Sort ℏ (`\hslash`) as "mathord", not "mathalpha".
269 * docutils/utils/math/latex2mathml.py
271 - Generate "MathML Core" to fix rendering with Chromium/Android.
273 Use CSS rules instead of the deprecated "columnalign" attribute
274 to style <mtable> as "align" environment.
276 Use Mathematical Alphanumeric Symbols instead of <mstyle> with
277 "mathvariant" attribute.
279 - Use <mi> instead of <mo> for character class "mathord".
281 - Support "aligned" environment.
283 - Eliminate side-effect on later import of "tex2unichar".
285 * docutils/utils/math/mathml_elements.py
287 - New module defining MathML element classes
288 (outsourced from latex2mathml.py).
289 - Base MathML element classes on `xml.etree.ElementTree`.
291 * docutils/utils/roman.py
293 - Update to version `1.4 <https://pypi.org/project/roman/4.1/>`__.
294 Fixes feature-request #95 (license is now ZPL 2.1).
296 * docutils/utils/smartquotes.py
298 - Pre-compile regexps once, not with every call of `educateQuotes()`
299 (patch #206 by Chris Sewell).
300 - Simplify regexps; skip replacement rules if there is nothing to replace.
302 * docutils/writers/html4css1/__init__.py
304 - Support video inclusion via ``<object>`` tags.
306 * docutils/writers/html5_polyglot/\*.css
308 - Move MathML styles to "minimal.css" (required for correct rendering).
309 - Highlight heading of target section also with explicit hyperlink target.
310 - No additional margins for line-blocks.
312 * docutils/writers/_html_base.py
314 - Stop setting the "footnote-reference" class value for footnote references.
315 Since 0.18, you can use the CSS selector ``[role="doc-noteref"]``.
316 - Support reading/embedding images also with "file:" URI.
317 - Warn, if image scaling fails because the image file cannot be read.
318 - Support video inclusion via ``<video>`` tags
319 (moved here from writers/html5_polyglot/__init__.py).
320 - New auxiliary method `HTMLTranslator.uri2imagepath()` ensures the
321 image file can also be read when CWD and output directory differ.
322 - Consider the root_prefix_ setting when converting an image URI
323 to a local filesystem path.
324 - New `\<image>`_ attribute "loading" overrides image_loading_ setting.
325 - Embed SVG images as ``<svg>`` instead of data-URI.
326 Fixes feature-request #100.
327 - Generate system messages for errors/warnings during the writing stage
328 (image transformations, math content conversion, ...).
329 - Close ``<dt>`` element in `depart_term()` to allow a
330 "definition_list_item" with multiple "terms" (cf. feature-request #60).
331 - Link to the document "#top" from the ToC heading
332 (unless toc_backlinks_ is False).
333 - Transfer `id` attribute from <field> elements to the respective
334 <field_name> child element to allow cross-references to field-list items
335 (<field>s are skipped in HTML output).
337 * docutils/writers/latex2e/__init__.py
339 - Fix placement of hyperlink target (label) for tables (bug #440).
340 - More compact LaTeX source for option-lists and description-lists
341 (no change in output).
343 * docutils/writers/manpage.py
345 - Put manual section in .TH in quotes.
346 - Skip footer to avoid the link to document source in the manpage.
347 - Add multiple definition list term support, see feature #60.
348 - Render reference, refid and refuri.
349 Use of ``.UR`` and ``.UE`` macros for reference markup is too brittle.
350 - Add preprocessor hinting tbl first line, see bug #477.
351 - Change tbl-Tables using box option, see bug #475.
352 - Apply literal block patch #205. Use ``.EE`` and ``.EX`` macros.
353 Thanks to G. Branden Robinson.
355 * docutils/writers/odf_odt/__init__.py
357 - Use context manager for image reading operations.
358 Catch `URLError` when `urllib.request.urlopen()` fails.
360 - Convert image URI to path if accessing a local file. Fixes bug #153.
362 * docutils/writers/s5_html/__init__.py
364 - Warn if the S5 writer cannot copy the theme files.
365 - Programmatic customization of theme_url_ setting no longer
366 overridden by the default for theme_.
370 - New configuration setting `sources`_.
371 - Match `prune`_ values with `fnmatch.fnmatch()`.
374 Release 0.20.1 (2023-05-17)
375 ===========================
377 * docutils/MANIFEST.in
379 - Include tox.ini and docutils.conf in the source package
380 (cf. bug #467 and bug #461).
382 * tools/rst2odt_prepstyles.py
384 - Moved to ``docutils/writers/odf_odt/prepstyles.py``.
385 Replaced with a provisional backwards compatibility script.
388 Release 0.20 (2023-05-09)
389 =========================
393 - Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
394 - Support Python 3.11 (patch #198 by Hugo van Kemenade).
398 - New functions `rst2…()` for use as "console_scripts" `entry points`_.
399 (cf. `Future changes` in the RELEASE-NOTES_).
401 * docutils/frontend.py
403 - New configuration setting "output_". Obsoletes the ``<destination>``
404 positional argument (cf. `Future changes` in the RELEASE-NOTES_).
406 * docutils/languages/
407 docutils/parsers/rst/languages/
409 - Support Ukrainian. Patch by Dmytro Kazanzhy.
413 - Fix `previous_sibling()` method that led to invalid HTML in some cases
415 - Fix bug #463. Spurious comma in deprecation warning.
417 * docutils/parsers/recommonmark_wrapper.py
419 - Improved mock Sphinx module.
421 * docutils/transforms/__init__.py
423 - `Transformer.populate_from_components()` now silently ignores
424 components that are not instances of `docutils.TransformSpec`.
426 * docutils/transforms/frontmatter.py
428 - Accept author names with initials like ``A. Einstein`` in the "author"
429 `bibliographic field`_ instead of rising an error
430 (generally, such names are `parsed as enumerated list`__).
432 .. _bibliographic field:
433 docs/ref/rst/restructuredtext.html#bibliographic-fields
434 __ docs/ref/rst/restructuredtext.html#enumerated-lists
436 * docutils/transforms/references.py
438 - `DanglingReferences` ignores `citation_reference` nodes if the
439 "use_bibex" setting is active. (In this case, citations are provided
440 by LaTeX/BibTeX.) Fixes bug #384.
442 * docutils/utils/__init__.py
444 - New utility function `xml_declaration()`.
445 - `DependencyList.add()` accepts `pathlib.Path` instances.
446 - `find_file_in_dirs()` now returns a POSIX path also on Windows;
447 `get_stylesheet_list()` no longer converts ``\`` to ``/``.
449 * docutils/utils/math/latex2mathml.py
451 - Support "mod" notation for modulo operation / modulus arithmetic.
453 * docutils/utils/math/tex2mathml_extern.py
455 - Support `Pandoc` as alternative LaTeX to MathML converter.
458 * docutils/writers/_html_base.py
460 - Refactoring of `HTMLTranslator` initialization and collecting of
461 document "parts". Adapt HTML writers importing `_html_base`.
463 Changes to the HTML output (no space character before closing tag of
464 XML declaration, order of metadata elements)
465 don't affect the HTML semantics, styling, and rendering.
467 - Wrap definition lists with "details" class argument in a <div>
468 with the "id" and "class" values of the list node.
470 - Use dpub-ARIA role "doc-footnote__" (instead of ARIA role "note")
473 __ https://www.w3.org/TR/dpub-aria-1.1/#doc-footnote
475 * docutils/writers/html5_polyglot/__init__.py
477 - Do not convert class values to HTML5 text-level tags inside
478 <code> and <code-block> (fixes bug #476).
480 * docutils/writers/latex2e/__init__.py
482 - Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
483 (UTF-8 is the default encoding for LaTeX2e since 2018).
484 - Fix behaviour of the use_bibtex_ setting.
485 - Outsource parts of `depart_document()` to new auxiliary methods
486 `make_title()` and `append_bibliography()`.
487 - Ensure POSIX paths in stylesheet loading macros.
489 * docutils/writers/latex2e/titlepage.tex
491 - Drop ``\usepackage{fixltx2e}`` from template.
492 (Obsolete since 2015 and dropped from other templates in Docutils 0.14.)
494 * docutils/writers/manpage.py
496 - Do not output empty "manual" in ``.TH``.
498 * docutils/writers/xetex/__init__.py
500 - Ignore settings in the [latex2e writer] configuration file section.
501 Place common settings in section [latex writers].
505 - Fix SetuptoolsDeprecationWarning: ``Installing '' as data is deprecated``
506 by adding data directories to package_data.packages list.
510 - Extracted flake8 configuration and moved to ``.flake8``.
511 - changedir to directory ``test`` to avoid path problems.
515 - Refactored tests to use common `unittest` idioms.
516 Fixes errors when running the test suite with ``python -m unittest``
517 or external test frameworks, such as Pytest_.
519 .. _pytest: https://pypi.org/project/pytest/
523 - Removed. Use the coverage.py_ project instead,
524 ``coverage run test/alltests.py`` and ``coverage report``.
526 .. _coverage.py: https://pypi.org/project/coverage/
530 - Moved ``quicktest.py`` to ``tools/dev/``.
533 Release 0.19 (2022-07-05)
534 =========================
538 - Dropped support for Python 2.7, 3.5, and 3.6. and removed compatibility
539 hacks from code and tests.
541 check PEP 8 conformity with `flake8` (exceptions in file tox.ini).
543 * docutils/__main__.py
545 - New module. Support for ``python -m docutils``.
546 Also used for the ``docutils`` console script `entry point`_.
550 - Let `Publisher.publish()` print info and prompt when waiting for input
551 from a terminal (cf. https://clig.dev/#interactivity).
552 - Respect `input_encoding_error_handler`_ setting when opening a source.
556 - New function `error_string()`
557 obsoletes `utils.error_reporting.ErrorString`.
558 - Class `ErrorOutput` moved here from `utils.error_reporting` module.
559 - Use "utf-8-sig" instead of Python's default encoding if the
560 `input_encoding`_ setting is None.
561 - Fix error when reading of UTF-16 encoded source without trailing newline.
562 - Suppress deprecation warning (fixes bug #464).
564 * docutils/parsers/__init__.py
566 - Aliases "markdown" and "commonmark" point to "commonmark_wrapper".
567 - Alias for the "myst" parser (https://pypi.org/project/myst-docutils).
568 - Use absolute module names in `_parser_aliases` instead of two
569 import attempts. (Keeps details if the `recommonmark_wrapper` module
570 raises an `ImportError`.)
571 - Prepend parser name to `ImportError` if importing a parser class fails.
573 * docutils/parsers/commonmark_wrapper.py
575 - New module for parsing CommonMark input. Selects a locally installed
576 3rd-party parser (`pycmark`, `myst`, or `recommonmark`).
578 * docutils/parsers/recommonmark_wrapper.py
580 - Raise `ImportError`, if import of the upstream parser module fails.
581 If called from an `"include" directive`_,
582 the system-message now has source/line info.
583 - Adapt to and test with `recommonmark` versions 0.6.0 and 0.7.1.
585 .. _"include" directive: docs/ref/rst/directives.html#include
587 * docutils/parsers/rst/__init__.py
589 - Update PEP base URL (fixes bug #445),
590 use "https:" scheme in RFC base URL.
591 - Add `reporter` to `Directive` class attributes.
593 * docutils/parsers/rst/directives/__init__.py
595 - `parser_name()` keeps details if converting `ImportError` to `ValueError`.
597 * docutils/parsers/rst/roles.py
599 - Don't use mutable default values for function arguments. Fixes bug #430.
601 * docutils/transforms/universal.py
603 - Fix bug #435: invalid references in `problematic` nodes
606 * docutils/utils/__init__.py
608 - `decode_path()` returns `str` instance instead of `nodes.reprunicode`.
610 * docutils/utils/error_reporting.py
612 - Add deprecation warning.
614 * docutils/writers/_html_base.py
616 - Add "html writers" to `config_section_dependencies`. Fixes bug #443.
617 - Write table column widths with 3 digits precision. Fixes bug #444.
619 * docutils/writers/html5_polyglot/__init__.py
621 - Add space before "charset" meta tag closing sequence.
622 - Remove class value "controls" from an `image` node with video content
623 after converting it to a "control" attribute of the <video> tag.
624 - Wrap groups of footnotes in an ``<aside>`` for easier styling.
626 * docutils/writers/pep_html/
628 - Use "https:" scheme in "python_home" URL default.
629 - Fix links in template.txt.
633 - New ``docutils``" console script `entry point`_. Fixes bug #447.
637 - Always encode the log file ``alltests.out`` using "utf-8".
639 * test/DocutilsTestSupport.py
641 - `exception_data()` now returns None if no exception was raised.
642 - `recommonmark_wrapper` only imported if upstream parser is present.
644 * test/test_parsers/test_rst/test_directives/test_tables.py
646 - Fix bug #436: Null char valid in CSV since Python 3.11.
648 * tools/docutils-cli.py
650 - Allow 3rd-party drop-in components for reader and parser, too.
652 - Actual code moved to docutils.__main__.py.
654 * tools/rst2odt_prepstyles.py
656 - Options ``-h`` and ``--help`` print short usage message.
660 https://packaging.python.org/en/latest/specifications/entry-points/
663 Release 0.18.1 (2021-11-23)
664 ===========================
668 - `Node.traverse()` returns a list again to restore backwards
669 compatibility. Fixes bug #431.
671 - New method `Node.findall()`: like `Node.traverse()` but returns an
672 iterator. Obsoletes `Node.traverse()`.
674 * docutils/utils/__init__.py
676 - Fix behaviour of `get_stylesheet_list()`: do not look up stylesheets
677 given as `stylesheet`_ setting. Cf. bug #434.
679 * docutils/writers/_html_base.py
681 - Fix handling of ``footnote_backlinks == False`` (report Alan G Isaac).
683 * docutils/writers/html5_polyglot/math.css
685 - Fix typo (bug #432).
687 * docutils/writers/odf_odt/__init__.py
689 - Fix spurious output with Windows (bug #350).
691 * test/test_error_reporting.py
693 - Fix a false positive (bug #434).
696 Release 0.18 (2021-10-26)
697 =========================
699 * docutils/frontend.py
700 - Mark as provisional (will switch from using `optparse` to `argparse`).
701 - Remove hack for the now obsolete "mod_python" Apache module.
702 - New function `get_default_settings()`.
706 - Don't change a list while looping over it (in
707 `document.set_name_id_map()`). Thanks to Mickey Endito.
709 * docutils/parsers/recommonmark_wrapper.py
711 - Test and update to work with `recommonmark` version 0.6.0.
714 Unfortunately, recommonmark_ is `no longer maintained`__.
716 __ https://github.com/readthedocs/recommonmark/issues/221
718 * docutils/parsers/rst/directives/misc.py
720 - Fix bug #424 Wrong circular inclusion detection.
721 Use a "magic" comment instead of line numbers
722 to keep a log of recursive inclusions.
724 * docutils/parsers/rst/states.py
726 - Use a "magic" comment to update the log of recursive inclusions.
728 * docutils/writers/html5_polyglot/__init__.py
730 - New option `image_loading`_. Support "lazy" loading of images.
731 Obsoletes `embed_images`_.
733 * docutils/writers/pseudoxml.py
735 - Fix spelling of setting `detailed`_.
737 * tools/docutils-cli.py
739 - Read settings from standard configuration files.
741 Fix spelling errors in documentation and docstrings.
742 Thanks to Dimitri Papadopoulos.
745 Release 0.18b1 (2021-10-05)
746 ===========================
748 * docs/ref/docutils.dtd
750 - New document tree element <meta>.
752 * docutils/frontend.py
754 - The default value for the `auto_id_prefix`_ setting changed to "%":
755 auto-generated IDs use the tag name as prefix.
759 - Make `\<meta>`_ a standard Docutils doctree node. Writers may ignore
760 <meta> nodes if they are not supported by the output format.
762 - document.make_id(): Do not strip leading number and hyphen characters
763 from `name` if the `id_prefix`_ setting is non-empty.
765 - `Node.traverse()` returns an iterator instead of a list.
767 * docutils/parsers/rst/directives/html.py
769 - Removed. (Meta directive moved to ``misc.py``.)
771 * docutils/parsers/rst/directives/misc.py
773 - `Meta` directive class (moved from html.py) inserts `meta`
774 (instead of `pending`) nodes.
776 - Add `class` option to `Raw` directive.
778 * docutils/parsers/rst/directives/tables.py
780 - Unify behaviour of `"widths" option`_: check that the length of an
781 integer list equals the number of table columns also for the "table"
784 * docutils/tools/math/math2html.py,
785 docutils/tools/math/tex2unicode.py,
786 docutils/writers/html5/math.css
788 - Fork from elyxer and remove code that is not required
790 - Scale variable sized operators and big delimiters with CSS
791 - Support more commands, fix mapping of commands to Unicode characters
792 (cf. `LaTeX syntax for mathematics`_).
793 - Fix bug #244 Wrong subscript/superscript order.
794 - Don't use <tt> element (deprecated in HTML5).
795 - Use STIX fonts if available.
797 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
799 * docutils/parsers/rst/states.py
801 - Fix source location (line number) for attribution elements.
802 Patch by Mickey Endito.
803 - Add line, source, and rawsource internal attributes for blockquote
804 elements. Patch by Mickey Endito.
806 * docutils/transforms/references.py
808 - Skip system_messages when propagating targets. Fixes bug #425.
810 * docutils/utils/__init__.py
812 - Removed `unique_combinations()` (obsoleted by `itertools.combinations()`).
814 * docutils/utils/latex2mathml.py
816 - Major update (fixes and support for additional commands and symbols).
819 * docutils/writers/_html_base.py
821 - Write footnote brackets and field term colons to HTML, so that
822 they are present also without CSS and when copying text.
823 Adapt ``minimal.css``.
825 - Use semantic tags <aside> for footnote text, topics, admonitions,
826 and system-messages and <nav> for the table of contents. Use <div>
829 - Only specify table column widths, if the `"widths" option`_ is set
830 and is not "auto" (fixes bug #426).
831 The `table_style`_ setting "colwidths-grid" restores the current default.
833 .. _"widths" option: docs/ref/rst/directives.html#column-widths
835 - Use ARIA roles to enable accessible HTML for abstract, dedication,
836 the table of contents, footnote, references, footnotes, citations,
839 - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
840 for headings of deeply nested sections.
842 - Do not set classes "compound-first", "compound-middle", or
843 "compound-last" to elements nested in a compound.
844 Use class value "backrefs" instead of "fn-backref" for a span of
847 - Do not write class values handled by the HTML writer ("colwidths-auto",
848 "colwidths-given", "colwidths-grid") to the output.
850 - Move space character between section number and heading into
853 - Removed attribute `HTMLTranslator.topic_classes`
855 - Items of a definition list with class argument "details" are
856 converted to <details> disclosure elements.
858 * docutils/writers/html4css1/__init__.py
860 - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
861 (details, aside, nav, ...) and attributes (role, aria-level).
863 * docutils/writers/latex2e/__init__.py
865 - The setting `legacy_class_functions`_ now defaults to "False".
866 Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
868 - Apply patch #181 "Fix tocdepth when chapter/part in use" by
869 John Thorvald Wodder II.
871 - Fix newlines after/before `ids_to_labels()` (cf. patch #183).
873 - Refactor/revise ToC writing.
875 - Don't add ``\phantomsection`` to labels in math-blocks.
877 - Improve spacing and allow customization of Docutils-generated table
880 - New algorithm for table column widths. Fixes bug #422.
881 New configuration setting `legacy_column_widths`_.
883 `Table.set_table_style()` arguments changed.
885 Only write "continued on next page..." if it fits
886 without making the table columns wider.
888 Table "width" option overrides conflicting "auto" column "widths".
890 * docutils/writers/latex2e/docutils.sty
892 - Fix excessive padding above sidebar titles.
894 * docutils/writers/pseudoxml.py
896 - Fix option `detailed`_ under Python 2.7.
898 * docutils/writers/s5_html/themes/default
900 - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
901 ``blank.gif`` (fixes bug #169).
903 * docutils/writers/manpage.py
905 - Fix: double quotes need to be escaped on macro invocation.
909 Release 0.17.1 (2021-04-16)
910 ===========================
912 * docutils/utils/math/latex2mathml.py
914 - Fix bug #406 (MathML translation of ``\mathbf``).
916 * docutils/writers/latex2e/__init__.py
918 - Open ``docutils.sty`` with encoding set to "utf-8".
919 Fixes bug #414: error with Py3k when locale encoding is "ascii".
921 * docutils/parsers/*.py, docutils/transforms/*.py
923 - Provide fallbacks for parser config settings
924 to facilitate programmatic use.
926 * docutils/writers/manpage.py
928 - Apply patch #166: move macro defs above ``.TH``
929 (thanks Willie and sorry for the delay).
932 Release 0.17 (2021-04-03)
933 =========================
937 - Installing with ``setup.py`` now requires `setuptools`.
938 Alternatively, install with `pip`_ (or "manually").
939 - Use `importlib.import_module()` to programmatically import modules.
940 - Fix bug #385: Import of language modules.
942 .. _pip: https://pypi.org/project/pip/
944 * docs/ref/docutils.dtd
946 - The "title" attribute of <sidebar> elements is now optional.
948 * docutils/MANIFEST.in
950 - Exclude test outputs.
952 * docutils/__init__.py
954 - VersionInfo: `ValueError` for invalid values, fix comparison to tuples.
956 * docutils/languages/
957 docutils/parsers/rst/languages/
959 - Apply patch # 177 Arabic mappings by Shahin.
960 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
964 - Apply patch #165 "Fix error when copying `system_message` node"
966 - Apply version of patch #167 "Let `document.set_id()` register all
967 existing IDs". Thanks to Takeshi KOMIYA.
968 - Fix bug #410: Use a "property" function to recursively fetch
969 `Node.document` value from parent node.
971 * docutils/parsers/recommonmark_wrapper.py
973 - New, **experimental** wrapper to integrate the
974 `recommonmark`_ Markdown parser for use with Docutils.
975 Currently only tested with `recommonmark` version 0.4.0.
977 .. _recommonmark: https://pypi.org/project/recommonmark/
979 * docutils/parsers/rst/directives/body.py
981 - Make the sidebar's "title" argument optional (feature request #69).
983 * docutils/parsers/rst/directives/html.py
985 - Make `meta` elements available for "latex" and "odt" writers.
987 * docutils/parsers/rst/directives/misc.py
989 - Prevent infinite inclusion loops.
991 * docutils/parsers/rst/roles.py
993 - Apply patch #174 "Lowercase new role names on registration"
994 by John Thorvald Wodder II.
996 * docutils/utils/smartquotes.py
998 - Fix bug #383: Smart quotes around opening and separator characters.
1000 * docutils/transforms/components.py
1002 - Allow a comma-separated list of formats for the Filter transform.
1004 * docutils/writers/html*
1006 - Implement feature request #40 "Option to embed images as data URI".
1008 * docutils/writers/html5_polyglot/__init__.py
1010 - Use the new semantic tags <main>, <section>, <header>,
1011 <footer>, <aside>, <figure>, and <figcaption>.
1012 See ``minimal.css`` and ``plain.css`` for styling rule examples.
1014 Change the `initial_header_level`_ setting default to "2", as browsers
1015 use the `same style for <h1> and <h2> when nested in a <section\>`__.
1017 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
1019 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
1020 <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
1021 is found in `\<inline>`_ and `\<literal>`_ elements.
1022 Use <ins> and <del> if a unique matching class value
1023 is found in `inline`, `literal`, or `container` elements.
1024 Use <small> for generated code line numbers.
1026 - Fix bug #398: properly close link tag to "schema.dcterms".
1028 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
1030 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
1032 - Use <video> for images with video MIME types supported by HTML5.
1034 * docutils/writers/html5_polyglot/minimal.css
1036 - Move non-essential styling to ``plain.css``.
1037 Small fixes and tweaks.
1039 - Support "captionbelow" class value for tables.
1041 - Display code line numbers as pseudo-elements which are skipped
1042 when copying text from code blocks. Solves feature request #32.
1044 * docutils/writers/html5_polyglot/plain.css
1046 - Support numbered figures.
1048 * docutils/writers/html5_polyglot/responsive.css
1050 - New optional style that adapts to different screen sizes.
1052 * docutils/writers/latex2e/__init__.py
1054 - Use LaTeX environments for admonitions and "class wrappers" for styling
1055 admonitions and titles if the new configuration setting
1056 `legacy_class_functions`_ is False.
1058 - Remove backwards compatibility code for the deprecated
1059 `styling command`__ prefix ``\docutilsrole``.
1061 __ docs/user/latex.html#custom-interpreted-text-roles
1063 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
1065 - Support the `memoir` LaTeX document class.
1066 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
1068 - The special value "auto" for the `graphicx_option`_ setting
1069 is no longer supported (it never worked for xetex/luatex).
1071 - Most helper commands and element definitions are now defined in the
1072 LaTeX package `docutils.sty`_ and only inserted in the document
1073 preamble if the `stylesheet`__ setting does not list "docutils".
1075 .. _docutils.sty: https://ctan.org/pkg/docutils
1076 __ docs/user/config.html#stylesheet-latex-writers
1078 - Apply patch #173 "Make \*TeX writers convert nonstandard table
1079 classes to DUclass environments" by John Thorvald Wodder II.
1081 - Fix bug #408 "Incorrect assert in latex writer
1082 for multiple citation references".
1084 - Apply patch #175 "Fix alignment of nested tables"
1085 by John Thorvald Wodder II. Additional fixes to table alignment.
1087 - Do not write Docutils-generated ToC, when ``use_latex_toc == True``.
1088 (This did happen when publishing from a doctree.)
1090 - Set PDF document properties from "meta" directive content.
1092 - Apply version of patch #176 "LaTeX writer: Append ``\leavevmode`` to
1093 non-docinfo field names" by John Thorvald Wodder II.
1095 * docutils/writers/manpage.py
1097 - Fix #394 fix missing new line after rubric.
1098 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
1099 - Fix #126 manpage title with spaces.
1100 - Fix #380 command line option problem in sphinx.
1102 * docutils/writers/odf_odt/__init__.py
1104 - Fix/improve metadata handling:
1105 fix "keyword" splitting,
1106 allow generic fields (stored as "Custom Properties").
1108 * docutils/writers/pseudoxml.py
1110 - New option `detailled`__.
1114 * test/DocutilsTestSupport.py
1116 - Run python3 test like python2 against source not the build/-directory
1118 * tools/docutils-cli.py
1120 - New generic command line front end that allows the free selection of
1121 reader, parser, and writer components.
1124 Release 0.16 (2020-01-16)
1125 =========================
1129 - Dropped support for Python 2.6, 3.3 and 3.4
1130 - Docutils now supports Python 2.7 and Python 3.5+ natively
1131 (without conversion by `2to3`).
1132 - Keep `backslash escapes`__ in the document tree. Backslash characters in
1133 text are be represented by NULL characters in the `text` attribute of
1134 Doctree nodes and removed in the writing stage by the node's
1137 __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
1139 * docs/ref/docutils.dtd
1141 - Use "parameter entities" for `class names`, `reference names`,
1146 - Remove the `handle_io_errors` option from io.FileInput/Output.
1150 - Speed up Node.next_node().
1151 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
1152 - Warn about `Node.traverse()` returning an iterator instead of a list
1155 * docutils/statemachine.py
1157 - Patch [ 158 ] Speed up patterns by saving compiled versions (eric89gxl)
1159 * docutils/transforms/universal.py
1161 - Fix [ 332 ] Standard backslash escape for smartquotes.
1162 - Fix [ 342 ] No escape in roles descending from `inline literal`.
1164 * docutils/utils/__init__.py
1166 - `unescape()` definition moved to `nodes` to avoid circular import
1167 dependency. Fixes [ 366 ].
1169 * docutils/writers/latex2e/__init__.py
1171 - Fix topic subtitle.
1172 - Make "rubric" bold-italic and left aligned.
1173 - Fix [ 339 ] don't use "alltt" or literal-block-environment
1174 in admonitions and footnotes.
1175 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
1176 - Add "latex writers" to the `config_section_dependencies`.
1177 - Ignore classes for `rubric` elements
1178 (class wrapper interferes with LaTeX formatting).
1180 * docutils/writers/manpage.py
1182 - Apply fix for [ 287 ] comma after option is bold.
1183 - Apply fix for [ 289 ], line starting with ``.`` in a text.
1185 * docutils/writers/odf_odt/__init__.py
1187 - Fix: ElementTree.getchildren deprecated warning
1189 * docutils/writers/xetex/__init__.py
1191 - Add "latex writers" to the `config_section_dependencies`.
1195 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1196 Close alltests.out with atexit.
1200 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1201 Read defaults file with context.
1203 - Set `auto_id_prefix`_ to "%" (expands to tag-names).
1204 Results in descriptive links in HTML and more localized changes when
1205 editions to the input add or remove auto-ids.
1209 - Apply patch #157: avoid test failure because of a `ResourceWarning`.
1211 * test/test_writers/test_odt.py
1213 - Fix [ 359 ] Test suite fails on Python 3.8. odt XML sorting.
1214 Use ElementTree instead of minidom.
1216 * tools/buildhtml.py
1218 - New option `html_writer`_.
1221 Release 0.15.1 (2019-07-24)
1222 ===========================
1224 source: branches/rel-0.15
1226 Fix [ 366 ] circular dependency. Release for Python 2 only.
1229 Release 0.15 (2019-07-20)
1230 =========================
1234 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
1235 - Infrastructure automation.
1237 * docs/ref/docutils.dtd
1239 - The <table> element accepts the new attribute "width".
1241 * docs/ref/rst/restructuredtext.txt
1243 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
1244 field list names (instead of ordinary text).
1248 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
1249 deprecated. Thanks to hugovk.
1251 * docutils/languages/ko.py, docutils/parsers/rst/languages/ko.py
1253 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
1257 - Fix [ 251 ] `system_message.copy()` `TypeError`.
1258 - `Element.copy()` also copies `document`, `line`, and `source` attributes.
1260 * docutils/parsers/rst/__init__.py
1262 - Apply [ 152 ] reset `default role` at end of document.
1264 * docutils/parsers/rst/states.py
1266 - Allow embedded colons in field list field names.
1268 * docutils/parsers/rst/directives/html.py
1270 - Fix bug #281: Remove escaping backslashes in meta directive content.
1272 * docutils/parsers/rst/directives/misc.py
1274 - Don't convert tabs to spaces, if `tab_width` is negative in
1275 "include" directive with "code" option.
1277 * docutils/parsers/rst/directives/tables.py
1279 - Apply patch #121: Add "width" option for the table directives.
1281 * docutils/transforms/frontmatter.py
1283 - Add field name as class argument to generic docinfo fields unconditionally.
1285 * docutils/transforms/references.py
1287 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
1289 * docutils/utils/__init__.py
1291 - Deprecate `unique_combination()` (obsoleted by `itertools.combination()`.
1293 * docutils/utils/smartquotes.py
1295 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
1297 * docutils/writers/html5_polyglot/
1299 - automatically add HTML5-compatible meta tags for docinfo items
1300 "authors", "date", and "copyright".
1302 * docutils/writers/_html_base.py
1304 - Fix bug #358: Non-breaking space removed from fixed-width literal.
1306 * docutils/writers/latex2e/__init__.py
1308 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
1310 - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
1311 - Fixes to literal block handling.
1314 Release 0.14 (2017-08-03)
1315 =========================
1317 * docs/ref/docutils.dtd
1319 - Enable validation of Docutils XML documents against the DTD:
1321 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
1322 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
1323 however, the `ids` attribute cannot use the ID type because `XML only
1324 allows one ID per Element Type`__ and doesn't support a multiple-ID
1325 "IDS" attribute type.
1327 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
1329 * docs/ref/rst/restructuredtext.txt
1331 - Added documentation for escaped whitespace in URI contexts.
1332 - Clarify use of Unicode character categories.
1334 * docutils/parsers/rst/states.py
1336 - Added functionality: escaped whitespace in URI contexts.
1337 - Consistent handling of all whitespace characters in inline markup
1338 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
1340 * docutils/parsers/rst/directives/images.py
1342 - Added support for escaped whitespace in URI contexts.
1344 * docutils/parsers/rst/directives/tables.py
1346 - Rework patch [ 120 ] (revert change to Table.get_column_widths()
1347 that led to problems in an application with a custom table directive).
1349 * docutils/transforms/frontmatter.py
1351 - Fix [ 320 ] Russian docinfo fields not recognized.
1353 * docutils/transforms/references.py
1355 - Don't add a second ID to problematic references.
1357 * docutils/transforms/universal.py
1359 Fix `SmartQuotes`: warn only once if language is unsupported,
1360 keep "rawsource" when "educating" quotes.
1362 * docutils/utils/__init__.py
1364 - Added `split_escaped_whitespac()` function, support for escaped
1365 whitespace in URI contexts.
1367 * docutils/utils/error_reporting.py
1369 - Fix [ 321 ] Import block might cause name error.
1371 * docutils/utils/smartquotes.py
1373 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
1374 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
1375 - Fix [ 313 ] Differentiate apostrophe from closing single quote
1377 - Fix [ 317 ] Extra space inserted with French smartquotes.
1378 - Add command line interface for stand-alone use (requires 2.7).
1380 * docutils/writers/_html_base.py
1382 - Provide default title in metadata (required by HTML5).
1383 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
1384 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
1385 reasons, we don't use a third party public installation as default but
1386 warn if `math_output`_ is set to MathJax without specifying a URL.
1388 * docutils/writers/html4css1/__init__.py
1390 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
1392 * docutils/writers/latex2e/__init__.py
1394 - Handle class arguments for block-level elements by wrapping them
1395 in a "DUclass" environment. This replaces the special handling for
1396 `epigraph` and `topic` elements.
1398 * docutils/writers/manpage.py
1400 - Apply [ 141 ] Handling inline in manpage writer.
1402 * docutils/writers/odf_odt/__init__.py
1404 - Command line setting `language`_ now sets the default language of the
1405 generated ODF document.
1406 - The use of image directive options :width: (%), :scale:, etc now
1407 set the width/height/size of images in the generated ODF
1409 - The heading/title of admonitions now reflects the language
1410 specified by the `language`_ setting.
1411 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
1413 - Fixed [ 282 ] python3: `AttributeError`.
1415 * tools/rst2html4.py: New front-end.
1417 * tools/dev/generate_punctuation_chars.py: New script
1418 to test and update utils.punctuation_chars.
1421 Release 0.13.1 (2016-12-09)
1422 ===========================
1424 * docs/ref/docutils.dtd
1426 - Add the document tree elements <math> and <math_block> (already in use).
1428 * docutils/languages/fa.py
1429 docutils/parsers/rst/languages/fa.py
1430 docutils/languages/la.py
1431 docutils/parsers/rst/languages/la.py:
1433 - Apply [ 133 ] Persian mappings by Shahin Azad.
1434 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
1438 - Fix [ 253 ] Attribute key without value not allowed in XML.
1442 - Apply [ 103 ] Recognize inline markups without word boundaries.
1443 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
1445 * docutils/parsers/rst/__init__.py
1447 - Fix [ 233 ] Change the base URL for the :rfc: role.
1449 * docutils/parsers/rst/directives/tables.py
1451 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
1454 - Implement feature request [ 48 ]
1455 Add :align: option to the table directives.
1456 Thanks to Takeshi KOMIYA for the patch.
1458 * docutils/parsers/rst/roles.py
1460 - Fix [ 295 ] Class argument for custom role inheriting from math.
1462 * docutils/parsers/rst/tableparser.py
1464 - Really fix [ 159 ] Spurious table column alignment errors.
1466 * docutils/transforms/frontmatter.py
1468 - Add name of generic bibliographic fields as a "classes" attribute value
1469 (after conversion to a valid identifier form).
1471 * docutils/utils/error_reporting.py
1473 - Fix [ 130 ] support streams expecting byte-strings in ErrorOutput.
1475 * docutils/utils/math/math2html.py
1477 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
1478 - New upstream version (additional macros, piece-wise integrals and sums).
1480 * docutils/writers/_html_base.py
1482 - New auxiliary module for definitions common to all HTML writers.
1484 * docutils/writers/html5_polyglot/
1486 - New HTML writer generating clean, polyglot_ markup conforming to
1489 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
1490 and recommended layout rules.
1492 * docutils/writers/html4css1/__init__.py
1494 - Add "docutils" to class values for "container" object to address [ 267 ].
1495 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
1496 `default_stylesheet_path` and `default_template_path`.
1497 - Fix [ 266 ] creating labels/class values in description list items.
1498 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
1499 - Fix footnotes with content that does not start with a paragraph.
1500 - Use https in default MathJax URL (report Alan G Isaac).
1501 - Outsourcing of common code to _html_base.py.
1503 * docutils/writers/latex2e/__init__.py
1505 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
1506 admonitions and docinfo.
1508 - Use absolute path for `default_template_path`.
1510 - Removed deprecated options ``--use-latex-footnotes`` and
1511 ``--figure-footnotes``.
1513 - Cleaner LaTeX code for enumerations and literal blocks.
1515 - Use `hyperref` package together with `bookmark` (improved hyperlinking
1516 by the same author).
1518 - Fix [ 286 ] Empty column title cause invalid latex file.
1520 - Fix [ 224 ] Fix rowspan support for tables.
1522 - Let LaTeX determine the column widths in tables with "colwidths-auto".
1523 Not suited for multi-paragraph cells!
1525 * docutils/writers/odf_odt/__init__.py
1527 - remove decode.encode of filename stored in zip.
1529 * docutils/writers/xetex/__init__.py
1531 - LuaLaTex compatibility: do not load `xunicode` package.
1535 - New front-end ``rst2html5.py``.
1539 - Test py26, py27, py33 and py34.
1541 To use, install the `tox` package via pip or easy_install and use
1542 tox from the project root directory.
1544 .. _polyglot: https://www.w3.org/TR/html-polyglot/
1545 .. _HTML 5: https://www.w3.org/TR/html5/
1548 Release 0.12 (2014-07-06)
1549 =========================
1551 * docs/ref/rst/directives.txt
1553 - Update "math" and "csv-table" descriptions.
1555 * docutils/parsers/rst/directives/images.py
1557 - Fix [ 258 ] ``figwidth="image"`` generates unitless width value.
1559 * docutils/parsers/rst/states.py
1561 - Improve error report when a non-ASCII character is specified as
1562 delimiter, quote or escape character under Python 2.
1563 Fixes [ 249 ] and [ 250 ].
1565 * docutils/writers/html4css1/__init__.py
1567 - Don't add newline after inline math.
1568 Thanks to Yury G. Kudryashov for the patch.
1570 * docutils/writers/latex2e/__init__.py
1572 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
1573 - Apply [ 116 ] by Kirill Smelkov. Don't hard code \large for subtitle.
1575 * docutils/writers/odf_odt/__init__.py
1577 - Apply patch by Jakub Wilk to fix bug [ 100 ].
1579 * test/test_error_reporting.py
1581 - Fix [ 223 ] by removing redundant tests we do not have control over.
1583 * test/test_nodes.py
1585 - Apply [ 115 ] respect fixed 2to3 string literal conversion behaviour.
1588 Release 0.11 (2013-07-22)
1589 =========================
1593 - Apply [ 2714873 ] Fix for the overwriting of document attributes.
1594 - Support embedded aliases within hyperlink references.
1595 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
1596 language module) before global search.
1600 - Fix [ 3601607 ] `node.__repr__()` must return `str` instance.
1602 * docutils/parsers/rst/directives/__init__.py
1604 - Fix [ 3606028 ] `assert` is skipped with ``python -O``.
1606 * docutils/parsers/rst/directives/images.py
1608 - Apply [ 3599485 ] node source/line information for sphinx translation.
1610 * docutils/parsers/rst/directives/tables.py
1612 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
1614 * docutils/parsers/rst/states.py
1616 - Fix [ 157 ] Line block parsing doesn't like system message.
1617 - Always import our local copy of roman.py (report Larry Hastings).
1619 * docutils/transforms/references.py
1621 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
1623 * docutils/utils/__init__.py
1625 - Fix [ 3596884 ] exception importing `docutils.io`.
1627 * docutils/writers/html4css1/__init__.py
1629 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
1630 - New setting `stylesheet_dirs`_: Comma-separated list of directories
1631 where stylesheets are found. Used by `stylesheet_path` when expanding
1632 relative path arguments.
1633 - New default for `math_output`_: ``HTML math.css``.
1634 - Avoid repeated class declarations in html4css1 writer
1635 (modified version of patch [ 104 ]).
1638 * docutils/writers/latex2e/__init__.py
1640 - Drop the simple algorithm replacing straight double quotes with
1641 English typographic ones.
1642 Use the `smart_quotes`_ setting to activate this feature.
1643 - Fix literal use of babel shorthands (straight quote, tilde, ...).
1644 - Fix [ 3603246 ] Bug in option ``--graphicx-option=auto``.
1645 - New setting `stylesheet_dirs`__.
1647 __ docs/user/config.html#stylesheet-dirs-latex-writers
1650 * docutils/writers/manpage.py
1652 - Fix [3607063] handle lines starting with a period.
1653 - Fix option separating comma was bold (thanks to Bill Morris).
1656 Release 0.10 (2012-12-16)
1657 =========================
1661 - Dropped support for Python 2.3.
1662 - ``docutils/math``, ``docutils/error_reporting.py``, and
1663 ``docutils/urischemes.py`` moved to the utils package.
1664 - Fix [3541369] Relative __import__ also with Python 3.3.
1665 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
1666 and parsers for Python 2.7 up.
1667 - Fix import of PIL.Image.
1668 - Change default of `syntax_highlight`_ option to "long",
1669 basic syntax highlight styles for LaTeX and HTML.
1673 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
1674 option is ignored and will be removed in a future release.
1675 - Fix Py3k error writing to stdout with encoding differing from default.
1676 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
1678 * docutils/parsers/rst/directives/misc.py
1680 - Fix [ 3546533 ] Unicode error with "date" directive.
1682 * docutils/transforms/universal.py
1684 - SmartQuotes transform for typographic quotes and dashes.
1686 * docutils/utils/__init__.py
1688 - `normalize_language_tag()` now returns `BCP 47`_ conforming tags
1689 with sub-tags separated by ``-``.
1691 * docutils/writers/html4css1/__init__.py
1693 - Use ``<code>`` tag for inline "code",
1694 do not drop nested inline nodes (syntax highlight tokens).
1695 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
1696 - No line break after opening inline math tag.
1698 * docutils/writers/manpage.py
1700 - Apply [ 3527401 ] admonition's don't preserve indentation
1701 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
1703 * docutils/writers/xetex/__init__.py
1705 - Apply [ 3555160 ] ensure order of "otherlanguages".
1706 - Fix section numbering by LaTeX.
1708 * docutils/writers/s5_html/__init__.py
1710 - Fix [ 3556388 ] MathJax does not work with rst2s5.
1712 * docutils/writers/docutils_xml.py
1714 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
1715 - Fix/improve output with `indents`_ setting.
1719 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
1721 * tools/test/test_buildhtml.py
1723 - Fix [ 3521167 ] allow running in any directory.
1724 - Fix [ 3521168 ] allow running with Python 3.
1727 Release 0.9.1 (2012-06-17)
1728 ==========================
1732 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
1733 installed in the PYTHONPATH. Converted tests are now
1734 stored in ``test3/``, tools no longer need conversion.
1736 If you installed one of Docutils versions 0.7 ... 0.9 with
1737 ``setup.py install`` under Python 3, remove the spurious
1738 ``test/`` and ``tools/`` directories in the site library root.
1742 - Make tests independent from the location of the ``test/`` directory.
1743 - Use converted sources (from the ``build/`` directory) for tests under
1748 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
1752 - Fix writing binary data to sys.stdout under Python 3 (allows
1753 ``rst2odt.py`` to be used with output redirection).
1755 * docutils/parsers/rst/directives/misc.py
1757 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
1758 ``locale == C`` and 8-bit char in path argument of `include` directive.
1762 - class `Tee`: catch `UnicodeError` when writing to "ascii" stream or
1763 file under Python 3.
1766 Release 0.9 (2012-05-02)
1767 ========================
1771 - New reStructuredText "code" role and directive and "code" option
1772 of the "include" directive with syntax highlighting by Pygments_.
1773 - Fix parse_option_marker for option arguments containing ``=``.
1774 - Fix [ 2993756 ] import Python Imaging Library's Image module
1775 via ``import PIL`` as starting with PIL 1.2,
1776 "PIL lives in the PIL namespace only" (announcement__).
1778 .. _Pygments: https://pygments.org/
1779 __ https://mail.python.org/pipermail/image-sig/2011-January/006650.html
1783 - Fix [ 2971827 ] and [ 3442827 ]
1784 extras/roman.py moved to docutils/utils/roman.py
1786 * docutils/frontend.py
1788 - Fix [ 3481980 ] Use `os.getcwdu()` in `make_paths_absolute()`.
1792 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
1793 - `mode` argument for FileOutput avoids code replication in
1795 - New exceptions `InputError` and `OutputError` for IO errors in
1796 FileInput/FileOutput.
1800 - No "hard" system exit on file IO errors: catch and report them in
1801 `Publisher.reportException` instead. Allows handling by a calling
1802 application if the configuration setting `traceback`_ is True.
1804 * docutils/utils.py -> docutils/utils/__init__.py
1806 - docutils.utils is now a package (providing a place for sub-modules)
1808 - DependencyList uses io.FileOutput and 'utf-8' encoding to prevent
1809 errors recording non-ASCII filenames (fixes [ 3434355 ]).
1811 - Fix `relative_path()` with source=None and `unicode` target.
1813 * docutils/parsers/rst/states.py
1815 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
1816 characters and "international" quotes around inline markup.
1817 - Use `field_marker` pattern to look for start of a
1818 directive option block (fixes [ 3484857 ]).
1820 * docutils/parsers/rst/tableparser.py
1822 - Fix [ 2926161 ] for simple tables.
1823 (Combining chars in grid tables still contribute to cell width.)
1825 * docutils/writers/latex2e/__init__.py
1827 - Support the `abbreviation` and `acronym` standard roles.
1828 - Record only files required to generate the LaTeX source as dependencies.
1829 - Fix handling of missing stylesheets.
1830 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
1831 when suppressing LaTeX section numbering.
1832 - Use ``\DUtitle`` for unsupported section levels.
1833 - Apply [ 3512791 ] do not compare string literals with "is".
1835 * docutils/writers/xetex/__init__.py
1837 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
1839 * docutils/writers/html4css1/__init__.py
1841 - Change default for `math_output`_ setting to MathJax.
1842 - Fix handling of missing stylesheets.
1844 * docutils/writers/docutils_xml.py
1846 - Use the visitor pattern with `default_visit()`/`default_depart()` methods
1847 instead of minidom to facilitate special handling of selected nodes.
1848 - Support raw XML (inserted as-is inside a <raw></raw> node).
1850 * docutils/writers/manpage.py
1852 - Do not emit comment line with trailing blank. Problematic for VCS.
1855 Release 0.8.1 (2011-08-30)
1856 ==========================
1860 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
1861 and [ 3395920 ] (correct copyright info for rst.el).
1865 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
1867 * docutils/writers/latex2e/__init__.py
1869 - Clean up Babel language setting. Restores Sphinx compatibility.
1872 Release 0.8 (2011-07-07)
1873 ========================
1877 - Handle language codes according to `BCP 47`_.
1878 - If the specified language is not supported by Docutils,
1879 warn and fall back to English.
1880 - Math support: reStructuredText "math" role and directive,
1881 `math` and `math_block` doctree elements.
1882 - Decode command line arguments with the locale's preferred encoding
1883 (to allow, e.g., ``--title=Dornröschen``).
1884 - Orphaned `python` reader and `newlatex2e` writer moved to the sandbox.
1885 - New sub-module `error_reporting`: handle encoding/decoding errors
1886 when reporting exceptions.
1887 - Some additions to the Docutils core are released under the 2-Clause BSD
1888 license, see COPYING_ for details.
1890 .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
1891 .. _COPYING: COPYING.html
1895 - Most directives now support a "name" option that attaches a
1898 - Directive content may start on the first line also when the directive
1899 type accepts options.
1901 * docs/dev/policies.txt
1903 - Recommend the 2-Clause BSD license
1904 (http://opensource.org/licenses/BSD-2-Clause)
1905 for code that is kept under the author's copyright.
1907 * tools/buildhtml.py
1909 - Fix ``--local`` switch.
1911 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1913 * docutils/writers/html4css1/__init__.py
1915 - Set "lang" argument for objects with class argument
1916 "language-<language tag>".
1917 - New setting `math_output`_ with support for HTML, MathML, and LaTeX.
1919 * docutils/writers/latex2e/__init__.py
1921 - Fix [ 3043986 ] `AttributeError` using :local: with table of content.
1922 - Place title data in the document preamble.
1923 - Load `babel` package only if required.
1924 - Update list of supported languages.
1925 - New config setting `hyperref_options`_.
1926 No hard-coded "unicode" hyperref option (clash with xetex).
1927 - Set language for custom roles, paragraphs, block-quotes, and
1928 line-quotes with class argument "language-<language tag>".
1929 - Fix [ 3095603 ] wrong quotes output for Russian and other languages.
1930 - Convert image URI to a local file path.
1931 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1932 has more than one paragraph (Wolfgang Scherer).
1933 - \leavevmode before longtable only when needed (prevents spurious vspace)
1934 - do not advance table counter for tables without caption
1936 * docutils/writers/xetex/__init__.py
1938 - New writer generating LaTeX code for compiling with ``xelatex``.
1940 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1941 option allows separate config options for XeTeX vs. LaTeX2e.
1943 * docutils/writers/manpage.py
1945 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1946 - Fix: vertical space cleaning for option group ``.``.
1948 * tools/editors/emacs/rst.el
1950 - Fix [ 3001100 ] does not handle spaces in filenames.
1951 Thanks to Jakub Wilk.
1955 - strip whitespace from stylesheet arguments
1956 - exclude combining chars from column_width()
1957 (partial fix for [ 2926161 ])
1959 * docutils/parsers/rst/directives/misc.py
1961 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1966 - Do not ``close()`` `sys.stdin`, `sys.stdout`, or `sys.stderr`. Prevents
1967 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1970 Release 0.7 (2010-07-07)
1971 ========================
1975 - Fix [ 2881769 ] setup configuration.
1976 - Fix [ 2788716 ] reporting problems in included files.
1980 - FileInput opens files as text files with universal newline support
1981 (mode "rU", configurable with the new optional argument "mode").
1985 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1989 - Fix [ 2923723 ] let `decode_path()` tolerate ``path == None``.
1991 * docutils/writers/html4css1/__init__.py
1993 - Support SVG and SWF images (thanks to Stefan Rank).
1994 - Generate valid XHTML for centred images with targets.
1995 Use CSS classes instead of "align" tags for image alignment.
1997 * docutils/writers/latex2e/__init__.py
1999 - Use `transforms.writer_aux.Admonitions` to "normalize" special
2001 - Use the ``\url`` command for URLs (breaks long URLs instead of
2002 writing into the margin).
2003 - Preserve runs of spaces in `inline literals`__.
2004 - Deprecate `figure_footnotes`_ setting.
2005 - Rename `use_latex_footnotes`_ setting to `docutils_footnotes`_.
2006 - New `latex_preamble`_ setting.
2007 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
2008 - Fix hyperlink targets (labels) for images, figures, and tables.
2009 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
2010 - Apply [ 2961991 ] Call hyperref with unicode option.
2011 - Drop the special `output_encoding`_ default ("latin-1").
2012 The Docutils wide default (usually "UTF-8") is used instead.
2013 - Render inline markup in document title and subtitle.
2014 - Fix numbering depth with LaTeX section numbering.
2015 - Update Unicode -> LaTeX translations.
2016 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
2018 __ docs/ref/restructuredtext.html#inline-literals
2020 * docutils/writers/manpage.py
2022 - Fix: supported attribute (thanks to peter2108).
2023 - Remove trailing blanks in code (keep in sync with mercurial version).
2024 - Titles level 1, that is ``.SH``, always uppercase.
2025 - Apply patch from mg: literal text should be bold in man-pages.
2029 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
2034 - Python 3 support: copy test/ and tools/ to the build-dir
2035 and convert Python sources with 2to3.
2038 Release 0.6 (2009-10-11)
2039 ========================
2043 - Docutils is now compatible with Python versions from 2.3 up to 2.6
2044 and convertible to 3.1 code.
2046 + Node.__nonzero__ returns True instead of 1.
2047 + use os.walk instead os.path.walk.
2048 + minimize `types` module where possible.
2049 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
2050 + Text nodes now subclass unicode rather than UserString
2051 (which is gone in python 3.0).
2052 + 3.0 compatibility module docutils._compat
2054 + Drop 2.2 compatibility workarounds.
2055 + Drop extras/optparse.py and extras/textwrap.py
2056 (stdlib modules since 2.3).
2058 - OpenOffice export: ODT writer moved from sandbox to Docutils core.
2059 - Unix man page export: manpage writer moved from sandbox to Docutils
2062 - Apply [ 1719345 ] Galician translation
2063 - Apply [ 1905741 ] Polish translation
2064 - Apply [ 1878977 ] make_id(): deaccent characters.
2065 - Apply [ 2029251 ] return nonzero when tests fail.
2066 - Fix [ 1692788 ] allow UTF-8 in style sheets.
2067 - Fix [ 2781629 ] support non-ASCII chars in file names.
2068 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
2069 - Fix [ 2831643 ] renaming `DirectiveError.message` to `DirectiveError.msg`
2070 - Fix [ 2821266 ] ``--strict`` option works now like ``--halt=info``.
2071 - Fix [ 2788716 ] `DirectiveError` now correctly reports source and line.
2072 - Fix [ 1627229 ] hyperlink references in substitutions.
2074 - The `newlatex` writer is orphaned.
2078 - Documented Unicode characters allowed as inline markup openers,
2079 closers, and delimiters.
2080 - Allow units for all length specifications.
2081 - Allow percent sign in "scale" argument of "figure" and "image" directives.
2082 - Bugfix: The "figalign" argument of a figure now works as intended
2083 (aligning the figure, not its contents).
2084 - Align images with class "align-[right|center|left]"
2085 (allows setting the alignment of an image in a figure).
2087 * docutils/nodes.py:
2089 - Added `Element.__contains_()` method, for the in-operator.
2091 * docutils/parsers/rst/states.py:
2093 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
2094 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
2095 " " (non-breaking space), and "¡ ¿" openers.
2097 * docutils/parsers/directives/misc.py:
2099 - Added ``start-line`` and ``end-line`` options to "include"
2100 directive to select a range of lines.
2101 - Hard tabs in literal inclusions are replaced by spaces. This is
2102 configurable via the new ``tab-width`` option of the "include" directive
2103 (a negative tab-width prevents tab expansion).
2105 * docutils/utils.py:
2107 - Add `get_stylesheet_lis()` function.
2108 - Apply [ 2834836 ] print info at halt
2110 * docutils/transforms/universal.py:
2112 - Raise default priority of StripClasses to exclude stripped classes from
2115 * docutils/writers/html4css1/__init__.py:
2117 - `stylesheet`_ and `stylesheet_path`_ settings support a comma
2118 separated list of stylesheets.
2119 - Address [ 1938891 ] Inline literal text creates "pre" span only when
2120 needed to prevent inter-word line wraps.
2121 - Use `translate()` method instead of repeated `replace()` calls.
2122 - Fix [ 1757105 ] New `table_style`_ setting. Added to standard table
2123 classes to allow CSS styling that does not interfere with other
2124 table-using constructs (field lists, citations, ...).
2126 * docutils/writers/newlatex2e/__init__.py:
2128 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
2130 * docutils/writers/latex2e/__init__.py:
2132 - Add `embed_stylesheet`_ setting.
2133 - Apply [ 1474017 ] image vertical alignment is reversed.
2134 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
2135 - Change: has_key for dictionaries (not Nodes) to in-operator.
2136 - Merge adjacent citations into one latex cite command.
2137 - Failsafe implementation of custom roles. LaTeX compilation now ignores
2138 unknown classes instead of aborting with an error.
2139 - Support custom roles based on standard roles.
2140 - LaTeX packages can be used as `stylesheet`_ arguments without
2141 restriction. (A style sheet is now referenced with the ``\usepackage``
2142 command, if it ends with ``.sty`` or has no extension.)
2143 - Add ``bp`` to lengths without unit (prevents LaTeX errors).
2144 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
2145 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
2146 2005-02-04 as a configurable length unit).
2147 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
2148 if font-encoding is set to ''. LaTeX defaults to OT1 then.
2149 - Set sub- and superscript role argument in text mode not as math.
2150 Use a custom role based on sub-/superscript if you want italic shape.
2151 - Shorter preamble and less dependencies: Load packages and define macros
2152 only if required in the document.
2153 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
2154 - New custom environments and commands with optional "classes" argument.
2155 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
2156 - Better conformance to Docutils specifications with `use_latex_toc`_.
2157 Support for LaTeX generated ToC also with unnumbered sections.
2158 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
2159 section numbering by LaTeX.
2160 - Use default font in admonitions and sidebar.
2161 - Align of image in a figure defaults to 'center'.
2162 - Bugfix: Newlines around targets and references prevent run-together
2164 - Fix internal hyperlinks.
2165 - Use class defaults for page margins ('typearea' now optional).
2166 - Float placement made configurable, default changed to "here definitely".
2167 - Typeset generic topic as "quote block with title".
2168 - Use template (file and configuration option).
2169 - In the default template, load cmap.sty (fix text extraction in PDF) and
2170 fixltx2e.sty (LaTeX patches, \textsubscript).
2171 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
2172 - Use `translate()` instead of repeated `replace()` calls for text encoding.
2173 - Hyperlinked footnotes and support for symbol footnotes and
2174 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
2175 - Complete pairs of binary options
2176 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
2177 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
2179 - font-encoding: "T1" (formerly implicitly set by 'ae').
2180 - use-latex-toc: true (ToC with page numbers).
2181 - use-latex-footnotes: true (no mixup with figures).
2183 * docutils/writers/manpage.py
2185 - Do not print version at document end, this is done by the viewer.
2186 - Do not print date at document end, this is done by the viewer.
2187 - Fix storage of docinfo fields for none standard fields.
2189 * docutils/tools/rst2man.py
2192 Release 0.5 (2008-06-25)
2193 ========================
2195 * docutils/languages/he.py: Added to project: Hebrew mappings by
2198 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
2199 mappings by Meir Kriheli.
2201 * docutils/frontend.py:
2203 - Configuration files are now assumed and required to be
2205 - Paths of applied configuration files are now recorded in the
2206 runtime setting `_config_files`_ (accessible via `dump_settings`_).
2207 - Added `strip_elements_with_classes`_ and `strip_classes`_ settings.
2211 - Added code to determine the input encoding from data: encoding
2212 declarations or the presence of byte order marks (UTF-8 & UTF-16).
2213 - Added support for IronPython 1.0.
2215 * docutils/nodes.py:
2217 - Added `document.__getstate_()` method, for pickling.
2219 * docutils/parsers/rst/states.py:
2221 - Allow ``+`` and ``:`` in reference names.
2222 - Unquoted targets beginning with an underscore (``.. __target:
2223 URI``) are no longer accepted.
2224 - Added support for multiple attributions in a physical block quote
2225 (indented text block), dividing it into multiple logical block
2227 - Added support for unicode bullets in bullet lists: "•", "‣", and
2229 - Added support for new object-oriented directive interface,
2230 retaining compatibility to the old functional interface.
2231 - Added support for throwing `DirectiveError`'s from within
2234 * docutils/parsers/rst/__init__.py:
2236 - Added `Directive` base class.
2237 - Added `DirectiveError` base class.
2238 - Fixed `file_insertion_enabled`_ & `raw_enabled`_ setting
2241 * docutils/parsers/directives/:
2243 - Refactored all reStructuredText directives to use the new
2244 object-oriented directive interface. Errors are now (mostly)
2245 thrown using the new `DirectiveError` class.
2247 * docutils/parsers/directives/misc.py:
2249 - Added ``start-after`` and ``end-before`` options to ``include``
2250 directive; thanks to Stefan Rank.
2252 * docutils/transforms/universal.py:
2254 - Added `StripClassesAndElements` transform to remove from the
2255 document tree all elements with classes in
2256 `strip_elements_with_classes`_ and all "classes"
2257 attribute values in `strip_classes`_
2259 * docutils/transforms/writer_aux.py:
2261 - Added `Admonitions` transform to transform specific admonitions
2262 (like "note", "warning", etc.) into generic admonitions with a
2265 * docutils/writers/html4css1/__init__.py:
2267 - Moved template functionality from the PEP/HTML writer here.
2268 - Expanded the fragments available in the ``parts`` attribute.
2269 - Moved ``id`` attributes from titles to surrounding ``div``
2271 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
2272 universally supported now).
2273 - ``template.txt`` is now opened in text mode instead of binary mode
2274 (to ensure Windows compatibility).
2275 - ``a`` elements now have an "internal" or "external" class,
2276 depending on reference type.
2278 * docutils/writers/html4css1/template.txt: Added to project.
2280 * docutils/writers/pep_html/:
2282 - Moved template functionality to the HTML writer.
2284 * docutils/writers/s5_html/__init__.py:
2286 - Added `view_mode`_ & `hidden_controls`_ settings.
2288 * docutils/writers/latex2e/__init__.py:
2290 - Add `literal_block_env`_.
2291 - Fix: escaping ``%`` in href urls.
2292 - Move usepackage hyperref after stylesheet inclusion.
2293 - Fix: scrartcl does not have chapter but scrreprt.
2294 - Add newline after ``\end{verbatim}``.
2295 - Merge smaller differences from latex2e_adaptive_preamble.
2296 - Add ``use-part-section``.
2297 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
2298 - Using leavemode option_list no longer needs to check if parent
2299 is a definition list.
2300 - Append ``\leavemode`` to definition list terms.
2301 - No longer write visit\_/depart_definition_list_item comments to
2303 - Table column width with 3 decimal places.
2304 - Add table stubs support (boldfont).
2305 - Add assemble_parts to writer.
2306 - Add simply support for nested tables.
2307 - Fix verbatim in tables if use-verbatim-when-possible.
2308 - Use section commands down to subparagraph.
2309 - Put ensuremath around some latin1 chars.
2310 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
2311 - New experimental setting `use_bibtex`_.
2312 - New setting `reference_label`_ to allow usage of LaTeX ref for
2313 labels in section references.
2314 - Add a label after every section to support sectionnumbers as reference
2316 - Fix: bug# 1605376 rst2latex: bad options group list
2317 - Remove inactive code for use_optionlist_for_option_list.
2318 - Remove latex comments from option_list output.
2319 - Fix: bug# 1612270 double quotes in italian literal.
2320 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
2321 - Add setting `use_latex_abstract`_.
2322 - Image width unit ``px`` is translated to ``pt``.
2323 - Add image height support.
2324 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
2326 - Fix: Do not escape underscores in citation reference labels if
2327 use-latex-citations is set.
2328 - Use centering instead of center for figure contents, to avoid vertical
2330 - Recognize table class: borderless, nolines, booktabs, standard.
2331 - Fix: Renaming contents section does not work with latex writer; SF
2333 - Applied patch for custom roles with classes from Edward Loper.
2334 - Fixed bug that caused crashes with more than 256 lists.
2336 * docutils/writers/pep_html/__init__.py:
2338 - Changed to support new python.org website structure and
2341 * docs/howto/security.txt: "Deploying Docutils Securely", added to
2344 * tools/buildhtml.py:
2346 - Add `ignore`_ setting to exclude a list of shell patterns
2347 (default: ``.svn:CVS``).
2349 * tools/editors/emacs/rst.el:
2351 - Changed license to "GPL".
2352 - Added ``rst-straighten-decorations`` function.
2353 - The ``compile`` module is now always loaded.
2354 - Added ``rst-toggle-line-block`` function.
2355 - Headings consisting only of non-ASCII characters are now
2356 recognized by ``rst-toc`` and ``rst-adjust``.
2357 - Added font-lock support for multi-line comments where the first
2358 comment line is empty.
2359 - Added ``(require 'font-lock)``.
2363 - Provide descriptive error message if distutils is missing.
2366 Release 0.4 (2006-01-09)
2367 ========================
2371 - Updated the project policies for trunk/branch development &
2374 * docutils/__init__.py:
2376 - Added ``__version_details__`` attribute to describe code source
2377 (repository/snapshot/release).
2378 - Replaced ``default_transforms`` attribute of ``TransformSpec`` with
2379 ``get_transforms()`` method.
2383 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
2384 functions, for document tree extraction and reprocessing.
2388 - Added ``DocTreeInput`` class, for reprocessing existing documents.
2389 - Added support for non-Unicode (e.g. binary) writer output.
2391 * docutils/nodes.py:
2393 - Re-introduced ``Targetable.indirect_reference_name``, for
2394 MoinMoin/reST compatibility (removed in r3124/r3129).
2395 - Added ``serial_escape`` function; escapes string values that are
2396 elements of a list, for serialization. Modified Docutils-XML
2397 writing (``Element._dom_node``) and pseudo-XML writing
2398 (``Element.starttag``) to use ``serial_escape``.
2399 - Added ``Node.deepcopy()`` method.
2400 - Removed the internal lists ``document.substitution_refs``,
2401 ``document.anonymous_refs``, and ``document.anonymous_targets``.
2402 - Added a "container" element.
2403 - Fixed bug where values of list-valued attributes of elements
2404 originating from custom interpreted text roles (i.e., with custom
2405 classes) were being shared between element instances. Reported by
2408 * docutils/statemachine.py:
2410 - Added trailing whitespace stripping to ``string2lines()``.
2411 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
2412 Asian double-width character support.
2414 * docutils/utils.py:
2416 - Added ``east_asian_column_width()`` for double-width character
2419 * docutils/languages/ja.py: Added to project: Japanese mappings by
2422 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
2423 mappings by Panjunyong.
2425 * docutils/parsers/null.py: Added to project; a do-nothing parser.
2427 * docutils/parsers/rst/__init__.py:
2429 - Added validator to "tab_width" setting, with test. Closes SF bug
2430 #1212515, report from Wu Wei.
2432 * docutils/parsers/rst/states.py:
2434 - Fixed bug with escaped colons indicating a literal block.
2435 - Fixed bug with enumerated lists (SF#1254145).
2436 - Backslash-escaped colons inside of field names are now allowed.
2437 - Targets (implicit and explicit), anonymous hyperlink references
2438 and auto-numbered footnote references inside of substitution
2439 definitions are now disallowed.
2440 - Fixed bug: list items with blank first lines.
2441 - Fixed bug: block quote attributions with indented second lines.
2442 - Added East Asian double-width character support (Python 2.4 only).
2444 * docutils/parsers/rst/tableparser.py:
2446 - Added East Asian double-width character support (Python 2.4 only).
2448 * docutils/parsers/rst/directives/body.py:
2450 - Added the "container" directive.
2452 * docutils/parsers/rst/directives/misc.py:
2454 - Added the "default-role", "title", and "date" directives.
2455 - Added standard data file syntax to the "include" directive.
2456 - Added support for "class" directive content.
2458 * docutils/parsers/rst/directives/images.py:
2460 - Added ``indirect_reference_name`` support for images with a target
2462 - Added support for image width and height units.
2463 - Fixed bug with image "target" options.
2465 * docutils/parsers/rst/directives/references.py:
2467 - Added "class" attribute to "target-notes" directive, for
2468 footnote_reference classes.
2470 * docutils/parsers/rst/include/: Directory added to project; contains
2471 standard data files for the "include" directive. Initial contents:
2472 character entity substitution definition sets, and a set of
2473 definitions for S5/HTML presentations.
2475 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
2476 mappings by David Goodger.
2478 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
2479 Simplified Chinese mappings by Panjunyong.
2481 * docutils/readers/__init__.py:
2483 - Added universal.Decorations and universal.ExposeInternals
2484 transforms as default transforms for all readers.
2485 - Added ``ReReader`` base class for readers that reread an existing
2488 * docutils/readers/doctree.py: Added to project; a reader for existing
2491 * docutils/transforms/frontmatter.py:
2493 - Fixed the DocInfo transform to handle SVN-style expansion of the
2495 - In ``DocInfo.extract_authors``, treat the contents of "authors"
2498 * docutils/transforms/misc.py:
2500 - Added misc.Transitions transform, extracted from
2501 universal.FinalChecks.
2503 * docutils/transforms/references.py:
2505 - Added references.DanglingReferences transform, extracted from
2506 universal.FinalChecks.
2507 - Fixed bug with doubly-indirect substitutions.
2508 - Added footnote_reference classes attribute to "TargetNotes".
2509 - Fixed bug with circular substitution definitions that put Docutils
2510 into an infinite loop.
2512 * docutils/transforms/universal.py:
2514 - Added universal.ExposeInternals transform, extracted from
2515 universal.FinalChecks.
2516 - Removed universal.FinalChecks transform (logic has been moved to
2517 several new transforms).
2518 - Fixed bug with the "expose_internals" setting and Text nodes
2519 (exposed by the "rawsource" internal attribute).
2520 - Added the universal.StripComments transform, implementation of the
2521 "strip_comments" setting.
2523 * docutils/transforms/writer_aux.py: Added to project; auxiliary
2524 transforms for writers.
2526 - Added ``Compound`` transform, which flattens compound paragraphs.
2528 * docutils/writers/: Several writer modules (html4css1.py) were
2529 converted into packages. Support modules and data files have been
2530 moved into the packages. The stylesheets for the HTML writers are
2531 now installed along with the code, the code knows where to find
2532 them, and the default is to use them (actually, to embed them).
2533 Some adjustments to configuration files may be necessary. The
2534 easiest way to obtain the new default behavior is to remove all
2535 settings whose name includes "stylesheet".
2537 * docutils/writers/__init__.py:
2539 - Added universal.Messages and universal.FilterMessages transforms
2540 as default transforms for all writers.
2541 - Added ``UnfilteredWriter`` base class for writers that pass the
2542 document tree on unchanged.
2544 * docutils/writers/docutils_xml.py:
2546 - Made ``xmlcharrefreplace`` the default output encoding error
2549 * docutils/writers/html4css1/:
2551 - Added support for image width and height units.
2552 - Made ``xmlcharrefreplace`` the default output encoding error
2554 - Made ``--embed-stylesheet`` the default rather than
2555 ``--link-stylesheet``.
2556 - Moved "id" attribute from container (section etc.) to title's <a>
2557 tag, to be on the same tag as "name".
2558 (!!! To be reverted in Docutils 0.5.)
2559 - Added vertical space between fields of field lists.
2560 - Added ``--compact-field-lists`` option to remove vertical space in
2562 - Made cloaking of email addresses with ``--cloak-email-addresses``
2564 - Fixed support for centered images.
2565 - Added support for class="compact" & class="open" lists.
2567 * docutils/writers/latex2e/:
2569 - Underscores in citekeys are no longer escaped.
2571 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
2572 mapping of Unicode characters to LaTeX equivalents.
2574 * docutils/writers/s5_html/: Package added to project; writer for
2575 S5/HTML slide shows.
2577 * docs/dev/distributing.txt: Added to project; guide for distributors
2578 (package maintainers).
2580 * docs/dev/hacking.txt: Added to project; guide for developers.
2582 * docs/ref/doctree.txt:
2584 - Updated for plural attributes "classes", "ids", "names",
2586 - Added the "container" element.
2588 * docs/ref/docutils.dtd:
2590 - Updated for plural attributes "classes", "ids", "names",
2593 * docs/user/emacs.txt: Added to project; a document about Emacs
2594 support for reStructuredText and Docutils.
2596 * docs/user/links.txt: Added to project; lists of Docutils-related
2599 * docs/user/mailing-lists.txt: Added to project; information about
2600 Docutils-related mailing lists and how to access them.
2602 * docs/user/slide-shows.txt: Added to project; example of and docs for
2603 the S5/HTML writer (``rst2s5.py`` front end).
2605 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
2606 Files", added to project.
2608 * test/coverage.sh: Added to project; test coverage script.
2610 * test/DocutilsTestSupport.py:
2612 - Added support for specifying runtime settings at the suite level.
2614 * test/test_functional.py:
2616 - Added the ``clear_output_directory`` function.
2617 - Added support for ``_test_more`` functions in functional test
2620 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
2622 * tools/rstpep2html.py: Renamed from pep.py.
2624 * tools/dev/create_unimap.py: Added to project; script to create the
2625 docutils/writers/unimap_latex.py mapping file.
2627 * tools/dev/profile_docutils.py: Added to project; profiler script.
2629 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
2631 * tools/editors/emacs/restructuredtext.el,
2632 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
2633 Removed from project; the functionality is now contained in rst.el.
2635 * tools/editors/emacs/rst.el: Added to project. Added many features
2636 and fixed many bugs. See docs/user/emacs.txt for details.
2638 * tools/stylesheets: Removed from project. Stylesheets have been
2639 renamed and moved into writer packages.
2642 Release 0.3.9 (2005-05-26)
2643 ==========================
2647 - Eliminated and replaced all uses of the old string attributes
2648 ``id``, ``name``, ``dupname`` and ``class`` with references to the
2649 new list attributes ``ids``, ``names``, ``dupnames`` and
2650 ``classes`` throughout the whole source tree.
2654 - Enabled ``--dump-*`` options when ``--traceback`` specified,
2655 allowing for easier debugging.
2656 - In ``Publisher.publish()``, expanded the generic top-level
2659 * docutils/examples.py:
2661 - Added ``internals`` function for exploration.
2665 - Fixed ``Input.decode`` method to apply heuristics only if no
2666 encoding is explicitly given, and to provide better reporting of
2668 - The ``Input.decode`` method now removes byte order marks (BOMs)
2671 * docutils/nodes.py:
2673 - ``image`` element class changed to subclass of Element, not
2674 TextElement (it's an empty element, and cannot contain text).
2675 - Added ``attr_defaults`` dictionary for default attribute values.
2676 - Added empty list as default value for the following attributes:
2677 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
2678 - Added ``document.decoration`` attribute,
2679 ``document.get_decoration`` method, and ``decoration.get_header``
2680 & ``.get_footer`` methods.
2681 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
2684 * docutils/utils.py:
2686 - Removed ``docutils.utils.Reporter.categories``,
2687 ``docutils.utils.ConditionSet``, and all references to them, to
2688 simplify error reporting.
2690 * docutils/languages/nl.py: Added to project; Dutch mappings by
2693 * docutils/parsers/rst/__init__.py:
2695 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
2697 * docutils/parsers/rst/states.py:
2699 - Added check for escaped at-mark to prevent email address recognition.
2700 - Fixed option lists to allow spaces inside ``<angle-bracketed option
2702 - Allowed whitespace in paths and URLs.
2703 - Added auto-enumerated list items.
2704 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
2706 - Added support for table stub columns.
2708 * docutils/parsers/rst/directives/__init__.py:
2710 - Allowed whitespace in paths (``path`` function).
2711 - Added ``uri`` directive option conversion function.
2713 * docutils/parsers/rst/directives/body.py:
2715 - Fixed illegal context bug with "topic" directive (allowed within
2716 sidebars; not within body elements).
2718 * docutils/parsers/rst/directives/images.py:
2720 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
2721 - Added support for the ``file_insertion_enabled`` setting in the
2722 "figure" directive (disables "figwidth" option).
2723 - "image" directive: added checks for valid values of "align" option,
2724 depending on context. "figure" directive: added specialized
2725 "align" option and attribute on "figure" element.
2726 - Made ":figwidth: image" option of "figure" directive work again.
2727 - Fixed bug with reference names containing uppercase letters
2728 (e.g. ``Name_``) in "target" option of "image" directive.
2730 * docutils/parsers/rst/directives/misc.py:
2732 - Fixed "include" and "raw" directives to catch text decoding
2734 - Allowed whitespace in "include" & "raw" directive paths.
2735 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
2736 settings in "include" & "raw" directives.
2738 * docutils/parsers/rst/directives/parts.py:
2740 - Added "header" & "footer" directives.
2741 - Fixed illegal context bug with "contents" directive (topics
2742 allowed within sidebars; not within body elements).
2744 * docutils/parsers/rst/directives/tables.py:
2746 - Added "list-table" directive.
2747 - Caught empty CSV table bug.
2748 - Added support for the ``file_insertion_enabled`` setting in the
2749 "csv-table" directive.
2750 - Added ``stub-columns`` option to "csv-table" and "list-table"
2753 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
2754 mappings by Martijn Pieters.
2756 * docutils/readers/standalone.py:
2758 - Added ``section_subtitles`` setting to activate or deactivate the
2759 ``SectSubTitle`` transform.
2761 * docutils/transforms/frontmatter.py:
2763 - Added SectSubTitle transform to promote titles of lone
2764 subsections to subtitles.
2766 * docutils/transforms/references.py:
2768 - Fixed mislocated internal targets bug, by propagating internal
2769 targets to the next node, making use of the newly added support
2770 for multiple names and IDs.
2771 - Fixed duplicate footnote label bug.
2772 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
2775 * docutils/writers/html4css1.py:
2777 - Fixed unencoded stylesheet reference bug (characters like "&" in
2778 stylesheet references).
2779 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
2781 - Added support for multiple IDs per node by creating empty ``span``
2783 - Added the ``field_name_limit`` & ``option_limit`` settings &
2785 - Added support for table stub columns.
2786 - Added support for the ``align`` attribute on ``figure`` elements.
2787 - Added the ``cloak_email_addresses`` setting & support.
2788 - Added ``html_prolog``, ``html_head``, ``html_body``,
2789 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
2790 ``docutils.core.publish_parts``.
2791 - Added support for section subtitles.
2793 * docutils/writers/latex2e.py:
2795 - Fixed tables starting with more than one multirow cell.
2796 - Improved ``--use-latex-docinfo`` so that organization/contact/address
2797 fields are lumped with the last author field and appear on the
2799 - Made sure the titlepage is always shown with ``--use-latex-docinfo``,
2800 even if the document has no title.
2801 - Made sure that latex doesn't fill in today's date if no date field
2803 - Added support for section subtitles.
2805 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
2806 (under development).
2808 * docutils/writers/null.py: Added to project; a do-nothing Writer.
2810 * docs/api/publisher.txt:
2812 - Added "``publish_parts`` Details" section.
2814 * docutils/dev/repository.txt: Added to project; information about the
2815 Docutils Subversion repository.
2817 * docs/ref/docutils.dtd:
2819 - Added a ``stub`` attribute to the ``colspec`` element via the
2820 ``tbl.colspec.att`` parameter entity.
2821 - Allowed topic elements within sidebars
2822 - Added an ``align`` attribute to the ``figure`` element.
2824 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
2828 Release 0.3.7 (2004-12-24)
2829 ==========================
2831 * docutils/frontend.py:
2833 - Added options: ``--input-encoding-error-handler``,
2834 ``--record-dependencies``, ``--leave-footnote-reference-space``,
2835 ``--strict-visitor``.
2836 - Added command-line and config file support for "overrides" setting
2841 - Added support for input encoding error handler.
2843 * docutils/nodes.py:
2845 - Added dispatch_visit and dispatch_departure methods to
2846 NodeVisitor; useful as a hook for Visitors.
2847 - Changed structure of ``line_block``; added ``line``.
2848 - Added ``compound`` node class.
2849 - Added a mechanism for Visitors to transitionally ignore new node
2852 * docutils/utils.py:
2854 - Moved ``escape2null`` and ``unescape`` functions from
2855 docutils/parsers/rst/states.py.
2857 * docutils/parsers/rst/roles.py:
2860 - Changed role function API: the "text" parameter now takes
2861 null-escaped interpreted text content.
2863 * docutils/parsers/rst/states.py:
2865 - Fixed bug where a "role" directive in a nested parse would crash
2866 the parser; the state machine's "language" attribute was not being
2868 - Added support for line block syntax.
2869 - Fixed directive parsing bug: argument-less directives didn't
2870 notice that arguments were present.
2871 - Removed error checking for transitions.
2872 - Added support for multiple classifiers in definition list items.
2873 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
2874 - Changed role function API: the "text" parameter now takes
2875 null-escaped interpreted text content.
2876 - Empty sections and documents are allowed now.
2878 * docutils/parsers/rst/directives/__init__.py:
2880 - Added ``encoding`` directive option conversion function.
2881 - Allow multiple class names in class_option conversion function.
2883 * docutils/parsers/rst/directives/body.py:
2885 - Converted the line-block directive to use the new structure.
2886 - Extracted the old line-block functionality to the ``block``
2887 function (still used).
2888 - Added ``compound`` directive (thanks to Lea Wiemann).
2890 * docutils/parsers/rst/directives/misc.py:
2892 - Added "encoding" option to "include" and "raw" directives.
2893 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
2894 - Allow multiple class names in the "class" directive.
2896 * docutils/parsers/rst/directives/parts.py:
2898 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
2899 options. Thanks to Lele Gaifax.
2901 * docutils/parsers/rst/directives/tables.py:
2903 - Added "encoding" directive to "csv-table" directive.
2904 - Added workaround for lack of Unicode support in csv.py, for
2905 non-ASCII CSV input.
2907 * docutils/transforms/misc.py:
2909 - Fixed bug when multiple "class" directives are applied to a single
2911 - Enabled multiple format names for "raw" directive.
2913 * docutils/transforms/references.py:
2915 - Added support for trimming whitespace from beside substitution
2918 * docutils/transforms/universal.py:
2920 - FinalChecks now checks for illegal transitions and moves
2921 transitions between sections.
2923 * docutils/writers/html4css1.py:
2925 - HTMLTranslator.encode now converts U+00A0 to " ".
2926 - "stylesheet" and "stylesheet_path" settings are now mutually
2928 - Added support for the new line_block/line structure.
2929 - ``--footnote-references`` now overrides
2930 ``--trim-footnote-reference-space``, if applicable.
2931 - Added support for ``compound`` elements.
2932 - Enabled multiple format names for "raw" directive.
2933 - ``<p>`` tags of a paragraph which is the only visible child of the
2934 document node are no longer stripped.
2935 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2936 new method ``should_be_compact_paragraph()``.
2937 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2939 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2940 the output if they have their ``class`` attribute set.
2941 - The whole document is now surrounded by a ``<div
2942 class="document">`` element.
2943 - Body-level images are now wrapped by their own ``<div>`` elements,
2944 with image classes copied to the wrapper, and for images which
2945 have the ``:align:`` option set, the surrounding ``<div>`` now
2946 receives a class attribute (like ``class="align-left"``).
2948 * docutils/writers/latex2e.py:
2950 - no newline after depart_term.
2951 - Added translations for some Unicode quotes.
2952 - Added option "font-encoding", made package AE the default.
2953 - `stylesheet`_ and `stylesheet_path`_ settings are now mutually
2955 - ``--footnote-references`` now overrides
2956 ``--trim-footnote-reference-space``, if applicable.
2957 - The footnote label style now matches the footnote reference style
2958 ("brackets" or "superscript").
2959 - Added support for ``compound`` elements.
2960 - Enabled multiple format names for "raw" directive.
2962 * docs/ref/docutils.dtd:
2964 - Changed structure of the ``line_block`` element; added ``line``.
2965 - Added ``compound`` element.
2966 - Added "ltrim" and "rtrim" attributes to
2967 ``substitution_definition`` element.
2968 - Enabled multiple format names for ``raw`` element.
2969 - Enabled multiple classifiers in ``definition_list_item`` elements.
2971 * docs/ref/rst/directives.txt
2973 - Marked "line-block" as deprecated.
2974 - "Class" directive now allows multiple class names.
2975 - Added "Rationale for Class Attribute Value Conversion".
2976 - Added warning about "raw" overuse/abuse.
2978 * docs/ref/rst/restructuredtext.txt:
2980 - Added syntax for line blocks.
2981 - Definition list items may have multiple classifiers.
2983 * docs/ref/rst/roles.txt:
2987 * tools/stylesheets/default.css:
2989 - Added support for the new line_block structure.
2990 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2993 Release 0.3.5 (2004-07-29)
2994 ==========================
2998 * _`Documentation cleanup/reorganization`.
3000 - Created new subdirectories of docs/:
3002 * ``docs/user/``: introductory/tutorial material for end-users
3003 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
3004 * ``docs/api/``: API reference material for client-developers
3005 * ``docs/ref/``: reference material for all groups
3006 * ``docs/howto/``: for component-developers and core-developers
3007 * ``docs/peps/``: Python Enhancement Proposals
3009 - Moved ``docs/*`` to ``docs/user/``.
3010 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
3011 ``spec/`` to ``docs/dev``.
3012 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
3013 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
3014 - Moved ``alternatives.txt``, and ``problems.txt`` from
3015 ``spec/rst/`` to ``docs/dev/rst/``.
3016 - Moved ``reStructuredText.txt``, ``directives.txt``,
3017 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
3018 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
3019 ``roles.txt``, ``reStructuredText.txt`` to
3020 ``restructuredtext.txt``.
3021 - Moved ``spec/howto/`` to ``docs/howto``.
3023 In order to keep the CVS history of moved files, we supplied
3024 SourceForge with a script for modifying the Docutils CVS repository.
3026 After running the cleanup script:
3028 - Added ``docs/index.txt``.
3029 - Added a ``.htaccess`` file to the ``web`` module, containing
3030 redirects for all old paths to new paths. They'll preserve
3031 fragments (the "#name" part of a URL), and won't clutter up the
3032 file system, and will correct the URL in the user's browser.
3033 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
3034 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
3035 the "To Do" list itself in ``docs/dev/todo.txt``.
3036 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
3037 section of ``docs/dev/todo.txt``.
3038 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
3039 - Added "How To Report Bugs" to ``BUGS.txt``.
3040 - Went through all the sources and docs (including under web/) and
3041 updated links. Mostly done by Lea Wiemann; thanks Lea!
3042 (Still need to update links in the sandboxes.)
3046 * BUGS.txt: Added to project.
3048 * THANKS.txt: Added to project.
3050 * docutils/__init__.py:
3052 - 0.3.4: Post-release.
3056 - Added special error handling & advice for UnicodeEncodeError.
3057 - Refactored Publisher.publish (simplified exception handling &
3058 extracted debug dumps).
3059 - Renamed "enable_exit" parameter of convenience functions to
3060 "enable_exit_status".
3061 - Enabled traceback (exception propagation) by default in
3062 programmatic convenience functions.
3063 - Now publish_file and publish_cmdline convenience functions return
3064 the encoded string results in addition to their regular I/O.
3065 - Extracted common code from publish_file, publish_string, and
3066 publish_parts, into new publish_programmatically. Extracted
3067 settings code to ``Publisher.process_programmatic_settings``.
3068 - In Publisher.publish, disabled ``settings_overrides`` when
3069 ``settings`` is supplied; redundant.
3071 * docutils/frontend.py:
3073 - Added help text for ``--output-encoding-error-handler`` and
3074 ``--error-encoding-error-handler``.
3075 - Renamed ``--exit`` to ``--exit-status``.
3076 - Simplified default-setting code.
3078 * docutils/parsers/rst/__init__.py:
3080 - Added ``--pep-base-url`` and ``--rfc-base-url`` options.
3082 * docutils/parsers/rst/states.py:
3084 - Made URI recognition more aggressive and intelligent.
3086 * docutils/parsers/rst/directives/__init__.py:
3088 - Added several directive option conversion functions.
3090 * docutils/parsers/rst/directives/body.py:
3092 - Moved "table" directive to tables.py.
3094 * docutils/parsers/rst/directives/tables.py: Table-related directives,
3097 * docutils/writers/latex2e.py:
3099 - Added ``--table-style=(standard|booktabs|nolines)``
3100 - figures get "here" option (LaTeX per default puts them at bottom),
3101 and figure content is centered.
3102 - Rowspan support for tables.
3103 - Fix: admonition titles before first section.
3104 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
3105 - Replave ``_`` in literal by an underlined blank, because it has the correct
3107 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
3108 - A few unicode replacements, if output_encoding != utf
3109 - Add `graphicx_option`_ setting.
3110 - Indent literal-blocks.
3111 - Fix: omit ``\maketitle`` when there is no document title.
3113 * docs/index.txt: "Docutils Project Documentation Overview", added to
3116 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
3117 Tool", added to project.
3119 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
3121 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
3123 * docs/dev/policies.txt: Added to project (extracted from
3124 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3126 * docs/dev/release.txt: Added to project (extracted from
3127 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3129 * docs/dev/testing.txt: Added to project.
3131 * docs/dev/website.txt: Added to project (extracted from
3132 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3134 * docs/ref/rst/directives.txt:
3136 - Added directives: "table", "csv-table".
3138 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
3139 added to project. 1 page for syntax, and a 1 page reference for
3140 directives and roles. Source text to be used as-is; not meant to be
3143 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
3144 with a change of title.
3146 * test/functional/, contents, and test/test_functional.py: Added to
3149 * tools/buildhtml.py: Fixed bug with config file handling.
3151 * tools/html.py: Removed from project (duplicate of rst2html.py).
3153 * tools/pep2html.py: Removed from project (duplicate of Python's
3154 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
3155 Docutils-related PEPs in docs/peps/).
3157 * tools/rst2pseudoxml.py: Renamed from publish.py.
3159 * tools/rst2xml.py: Renamed from docutils-xml.py.
3161 * tools/test.txt: Removed from project; moved to
3162 docs/user/rst/demo.txt.
3164 * setup.py: Now also installs ``rst2latex.py``.
3167 Release 0.3.3 (2004-05-09)
3168 ==========================
3170 * docutils/__init__.py:
3172 - 0.3.1: Reorganized config file format (multiple sections); see
3174 - Added unknown_reference_resolvers attribute to TransformSpec.
3175 - 0.3.2: Interpreted text reorganization.
3180 - Catch system messages to stop tracebacks from parsing errors.
3181 - Catch exceptions during processing report & exit without
3182 tracebacks, except when ``--traceback`` used.
3183 - Reordered components for OptionParser; application comes last.
3184 - Added "config_section" parameter to several methods and functions,
3185 allowing front ends to easily specify their config file sections.
3186 - Added publish_parts convenience function to allow access to individual
3187 parts of a document.
3189 * docutils/examples.py: Added to project; practical examples of
3190 Docutils client code, to be used as-is or as models for variations.
3192 * docutils/frontend.py:
3194 - Added "traceback" setting.
3195 - Implemented support for config file reorganization:
3196 ``standard_config_files`` moved from ``ConfigParser`` to
3197 ``OptionParser``; added
3198 ``OptionParser.get_config_file_settings()`` and
3199 ``.get_standard_config_settings()``; support for old "[options]"
3200 section (with deprecation warning) and mapping from old to new
3202 - Reimplemented setting validation.
3203 - Enabled flexible boolean values: yes/no, true/false, on/off.
3204 - Added ``Values``, a subclass of ``optparse.Values``, with support
3205 for list setting attributes.
3206 - Added support for new ``DOCUTILSCONFIG`` environment variable;
3207 thanks to Beni Cherniavsky.
3208 - Added ``--no-section-numbering`` option.
3212 - Catch IOErrors when opening source & destination files, report &
3213 exit without tracebacks. Added ``handle_io_errors`` parameter to
3214 ``FileInput`` & ``FileOutput`` to enable caller error handling.
3216 * docutils/nodes.py:
3218 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
3219 method definitions (via ``exec``) to dynamic assignments (via
3220 ``setattr``); thanks to Roman Suzi.
3221 - Encapsulated visitor dynamic assignments in a function; thanks to
3223 - Added indirect_reference_name attribute to the Targetable
3224 class. This attribute holds the whitespace_normalized_name
3225 (contains mixed case) of a target.
3227 * docutils/statemachine.py:
3229 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
3230 - Added ``StringList.get_2D_block``.
3232 * docutils/utils.py:
3234 - Added "level" attribute to SystemMessage exceptions.
3236 * docutils/languages/af.py: Added to project; Afrikaans mappings by
3239 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
3242 * docutils/languages/eo.py: Added to project; Esperanto mappings by
3243 Marcelo Huerta San Martin.
3245 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
3246 mappings by Lalo Martins.
3248 * docutils/languages/ru.py: Added to project; Russian mappings by
3251 * docutils/parsers/rst/roles.py: Added to project. Contains
3252 interpreted text role functions, a registry for interpreted text
3253 roles, and an API for adding to and retrieving from the registry.
3254 Contributed by Edward Loper.
3256 * docutils/parsers/rst/states.py:
3258 - Updated ``RSTState.nested_parse`` for "include" in table cells.
3259 - Allowed true em-dash character and "``---``" as block quote
3261 - Added support for <angle-bracketed> complex option arguments
3263 - Fixed handling of backslashes in substitution definitions.
3264 - Fixed off-by-1 error with extra whitespace after substitution
3265 definition directive.
3266 - Added inline markup parsing to field lists' field names.
3267 - Added support for quoted (and unindented) literal blocks.
3268 Driven in part by a bribe from Frank Siebenlist (thanks!).
3269 - Parser now handles escapes in URIs correctly.
3270 - Made embedded-URIs' reference text omittable. Idea from Beni
3272 - Refactored explicit target processing code.
3273 - Added name attribute to references containing the reference name only
3274 through whitespace_normalize_name (no case changes).
3275 - parse_target no longer returns the refname after going through
3276 normalize_name. This is now handled in make_target.
3277 - Fixed bug relating to role-less interpreted text in non-English
3279 - Reorganized interpreted text processing; moved code into the new
3280 roles.py module. Contributed by Edward Loper.
3281 - Refactored ``Body.parse_directive`` into ``run_directive`` and
3282 ``parse_directive_block``.
3284 * docutils/parsers/rst/tableparser.py:
3286 - Reworked for ``StringList``, to support "include" directives in
3289 * docutils/parsers/rst/directives/__init__.py:
3291 - Renamed ``unchanged()`` directive option conversion function to
3292 ``unchanged_required``, and added a new ``unchanged``.
3293 - Catch unicode value too high error; fixes bug 781766.
3294 - Beefed up directive error reporting.
3296 * docutils/parsers/rst/directives/body.py:
3298 - Added basic "table" directive.
3300 * docutils/parsers/rst/directives/images.py:
3302 - Added "target" option to "image" directive.
3303 - Added name attribute to references containing the reference name only
3304 through whitespace_normalize_name (no case changes).
3306 * docutils/parsers/rst/directives/misc.py:
3308 - Isolated the import of the ``urllib2`` module; was causing
3309 problems on SourceForge (``libssl.so.2`` unavailable?).
3310 - Added the "role" directive for declaring custom interpreted text
3313 * docutils/parsers/rst/directives/parts.py:
3315 - The "contents" directive does more work up-front, creating the
3316 "topic" and "title", and leaving the "pending" node for the
3317 transform. Allows earlier reference resolution; fixes subtle bug.
3319 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
3320 mappings by Jannie Hofmeyr.
3322 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
3323 mappings by Marek Blaha.
3325 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
3326 mappings by Marcelo Huerta San Martin.
3328 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
3329 Portuguese mappings by Lalo Martins.
3331 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
3332 mappings by Roman Suzi.
3334 * docutils/transforms/parts.py:
3336 - The "contents" directive does more work up-front, creating the
3337 "topic" and "title", and leaving the "pending" node for the
3338 transform. Allows earlier reference resolution; fixes subtle bug.
3339 - Added support for disabling of section numbering.
3341 * docutils/transforms/references.py:
3343 - Verifying that external targets are truly targets and not indirect
3344 references. This is because we are now adding a "name" attribute to
3345 references in addition to targets. Note sure if this is correct!
3346 - Added code to hook into the unknown_reference_resolvers list for a
3347 transformer in resolve_indirect_target. This allows the
3348 unknown_reference_resolvers to keep around indirect targets which
3349 docutils doesn't know about.
3350 - Added specific error message for duplicate targets.
3352 * docutils/transforms/universal.py:
3354 - Added FilterMessages transform (removes system messages below the
3355 verbosity threshold).
3356 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
3357 to FinalCheckVisitor for application-specific handling of
3358 unresolvable references.
3359 - Added specific error message for duplicate targets.
3361 * docutils/writers/__init__.py:
3363 - Added assemble_parts method to the Writer class to allow for
3364 access to a documents individual parts.
3365 - Documented & set default for ``Writer.output`` attribute.
3367 * docutils/writers/html4css1.py:
3369 - Fixed unicode handling of attribute values (bug 760673).
3370 - Prevent duplication of "class" attribute values (bug report from
3372 - Improved table grid/border handling (prompted by report from Bob
3374 - Added support for table titles.
3375 - Added "<title />" for untitled docs, for XHTML conformance; thanks
3377 - Added functionality to keep track of individual parts of a document
3378 and store them in a dictionary as the "parts" attribute of the writer.
3379 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
3380 - Added proper support for the "scale" attribute of the "image"
3381 element. Contributed by Brent Cook.
3382 - Added ``--initial-header-level`` option.
3383 - Fixed bug: the body_pre_docinfo segment depended on there being a
3384 docinfo; if no docinfo, the document title was incorporated into
3385 the body segment. Adversely affected the publish_parts interface.
3387 * docutils/writers/latex2e.py:
3389 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
3390 about a missing file.
3391 - Added options and support: ``--compound-enumerators``,
3392 ``--section-prefix-for-enumerators``, and
3393 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
3395 - Added option ``--use-verbatim-when-possible``, to avoid
3396 problematic characters (eg, '~' in italian) in literal blocks.
3397 - It's now possible to use four section levels in the `book` and
3398 `report` LaTeX document classes. The default `article` class still has
3401 * docs/config.txt: "Docutils Configuration Files", added to project.
3402 Moved config file entry descriptions from tools.txt.
3406 - Moved config file entry descriptions to config.txt.
3408 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
3411 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
3412 Text Roles", added to project.
3414 * spec/rst/reStructuredText.txt:
3416 - Added description of support for <angle-bracketed> complex option
3417 arguments to option lists.
3418 - Added subsections for indented and quoted literal blocks.
3420 * test: Continually adding & updating tests.
3422 - Added test/test_settings.py & test/data/config_*.txt support
3424 - Added test/test_writers/test_htmlfragment.py.
3426 * test/DocutilsTestSupport.py:
3428 - Refactored LaTeX publisher test suite/case class names to make
3429 testing other writers easier.
3430 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
3431 to test the processing of HTML fragments which use the new
3432 publish_parts convenience function.
3434 * tools/buildhtml.py:
3436 - Added support for the ``--prune`` option.
3437 - Removed dependency on pep2html.py; plaintext PEPs no longer
3440 * tools/docutils.conf:
3442 - Updated for configuration file reorganization.
3444 * tools/rst2html.py:
3446 - copied from tools/html.py
3450 - added a 'scripts' section to configuration
3451 - added 'tools/rst2html.py' to the scripts section
3454 Release 0.3 (2003-06-24)
3455 ========================
3459 * Renamed "attribute" to "option" for directives/extensions.
3461 * Renamed transform method "transform" to "apply".
3463 * Renamed "options" to "settings" for runtime settings (as set by
3464 command-line options). Sometimes "option" (singular) became
3465 "settings" (plural). Some variations below:
3467 - document.options -> document.settings (stored in other objects as
3469 - option_spec -> settings_spec (not directives though)
3470 - OptionSpec -> SettingsSpec
3471 - cmdline_options -> settings_spec
3472 - relative_path_options -> relative_path_settings
3473 - option_default_overrides -> settings_default_overrides
3474 - Publisher.set_options -> Publisher.get_settings
3478 * COPYING.txt: Added "Public Domain Dedication".
3480 * FAQ.txt: Frequently asked questions, added to project.
3484 - Updated with PyPI Trove classifiers.
3485 - Conditional installation of third-party modules.
3487 * docutils/__init__.py:
3489 - Bumped version to 0.2.1 to reflect changes to I/O classes.
3490 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
3491 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
3492 - Bumped version to 0.2.3 because of the new ``--embed-stylesheet``
3493 option and its effect on the PEP template & writer.
3494 - Bumped version to 0.2.4 due to changes to the PEP template &
3496 - Bumped version to 0.2.5 to reflect changes to Reporter output.
3497 - Added ``TransformSpec`` class for new transform system.
3498 - Bumped version to 0.2.6 for API changes (renaming).
3499 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
3500 convenience functions.
3501 - Added ``Component.component_type`` attribute.
3502 - Bumped version to 0.2.8 because of the internal parser switch from
3503 plain lists to the docutils.statemachine.StringList objects.
3504 - Bumped version to 0.2.9 because of the frontend.py API changes.
3505 - Bumped version to 0.2.10 due to changes to the project layout
3506 (third-party modules removed from the "docutils" package), and
3507 signature changes in ``io.Input``/``io.Output``.
3508 - Changed version to 0.3.0 for release.
3512 - Made ``publish()`` a bit more convenient.
3513 - Generalized ``Publisher.set_io``.
3514 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
3515 parameters; improved its docstring.
3516 - Added ``publish_file()`` and ``publish_string()``.
3517 - Factored ``Publisher.set_source()`` and ``.set_destination()``
3519 - Added support for ``--dump-pseudo-xml``, ``--dump-settings``, and
3520 ``--dump-transforms`` hidden options.
3521 - Added ``Publisher.apply_transforms()`` method.
3522 - Added ``Publisher.set_components()`` method; support for
3523 ``publish_*()`` conveninece functions.
3524 - Moved config file processing to docutils/frontend.py.
3525 - Added support for exit status ("exit_level" setting &
3526 ``enable_exit`` parameter for Publisher.publish() and convenience
3529 * docutils/frontend.py:
3531 - Check for & exit on identical source & destination paths.
3532 - Fixed bug with absolute paths & ``--config``.
3533 - Set non-command-line defaults in ``OptionParser.__init__()``:
3534 ``_source`` & ``_destination``.
3535 - Distributed ``relative_path_settings`` to components; updated
3536 ``OptionParser.populate_from_components()`` to combine it all.
3537 - Require list of keys in ``make_paths_absolute`` (was implicit in
3538 global ``relative_path_settings``).
3539 - Added ``--expose-internal-attribute``, ``--dump-pseudo-xml``,
3540 ``--dump-settings``, and ``--dump-transforms`` hidden options.
3541 - Removed nasty internals-fiddling ``ConfigParser.get_section``
3542 code, replaced with correct code.
3543 - Added validation functionality for config files.
3544 - Added ``--error-encoding`` option/setting, "_disable_config"
3546 - Added encoding validation; updated ``--input-encoding`` and
3547 ``--output-encoding``; added ``--error-encoding-error-handler`` and
3548 ``--output-encoding-error-handler``.
3549 - Moved config file processing from docutils/core.py.
3550 - Updated ``OptionParser.populate_from_components`` to handle new
3551 ``SettingsSpec.settings_defaults`` dict.
3552 - Added support for "-" => stdin/stdout.
3553 - Added "exit_level" setting (``--exit`` option).
3557 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
3558 - Added automatic closing to ``FileInput`` and ``FileOutput``.
3559 - Delayed opening of ``FileOutput`` file until ``write()`` called.
3560 - ``FileOutput.write()`` now returns the encoded output string.
3561 - Try to get path/stream name automatically in ``FileInput`` &
3563 - Added defaults for source & destination paths.
3564 - Allow for Unicode I/O with an explicit "unicode" encoding.
3565 - Added ``Output.encode()``.
3566 - Removed dependency on runtime settings; pass encoding directly.
3567 - Recognize Unicode strings in ``Input.decode()``.
3568 - Added support for output encoding error handlers.
3570 * docutils/nodes.py:
3572 - Added "Invisible" element category class.
3573 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
3574 modification during a traversal.
3575 - Added element classes: ``line_block``, ``generated``, ``address``,
3576 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
3577 ``superscript``, ``subscript``, ``inline``
3578 - Added support for lists of nodes to ``Element.insert()``.
3579 - Fixed parent linking in ``Element.replace()``.
3580 - Added new abstract superclass ``FixedTextElement``; adds
3581 "xml:space" attribute.
3582 - Added support for "line" attribute of ``system_message`` nodes.
3583 - Added support for the observer pattern from ``utils.Reporter``.
3584 Added ``parse_messages`` and ``transform_messages`` attributes to
3585 ``document``, removed ``messages``. Added ``note_parse_message``
3586 and ``note_transform_message`` methods.
3587 - Added support for improved diagnostics:
3589 - Added "document", "source", and "line" internal attributes to
3590 ``Node``, set by ``Node.setup_child()``.
3591 - Converted variations on ``node.parent = self`` to
3592 ``self.setup_child(node)``.
3593 - Added ``document.current_source`` & ``.current_line``
3594 attributes, and ``.note_source`` observer method.
3595 - Changed "system_message" output to GNU-Tools format.
3597 - Added a "rawsource" attribute to the ``Text`` class, for text
3598 before backslash-escape resolution.
3599 - Support for new transform system.
3600 - Reworked ``pending`` element.
3601 - Fixed XML DOM bug (SF #660611).
3602 - Removed the ``interpeted`` element class and added
3603 ``title_reference``, ``abbreviation``, ``acronym``.
3604 - Made substitutions case-sensitive-but-forgiving; moved some code
3606 - Fixed Unicode bug on element attributes (report: William Dode).
3608 * docutils/optik.py: Removed from project; replaced with
3609 extras/optparse.py and extras/textwrap.py. These will be installed
3610 only if they're not already present in the Python installation.
3612 * docutils/roman.py: Moved to extras/roman.py; this will be installed
3613 only if it's not already present in the Python installation.
3615 * docutils/statemachine.py:
3617 - Factored out ``State.add_initial_transitions()`` so it can be
3619 - Converted whitespace-specific "blank" and "indent" transitions
3620 from special-case code to ordinary transitions: removed
3621 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
3622 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
3623 ``ws_initial_transitions`` attributes.
3624 - Removed ``State.match_transition()`` after merging it into
3626 - Added ``StateCorrection`` exception.
3627 - Added support for ``StateCorrection`` in ``StateMachine.run()``
3628 (moved ``TransitionCorrection`` support there too.)
3629 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
3630 ``EOFError`` instead of ``IndexError``.
3631 - Added ``State.no_match`` method.
3632 - Added support for the Observer pattern, triggered by input line
3634 - Added ``strip_top`` parameter to
3635 ``StateMachineWS.get_first_known_indented``.
3636 - Made ``context`` a parameter to ``StateMachine.run()``.
3637 - Added ``ViewList`` & ``StringList`` classes;
3638 ``extract_indented()`` becomes ``StringList.get_indented()``.
3639 - Added ``StateMachine.insert_input()``.
3640 - Fixed ViewList slice handling for Python 2.3. Patch from (and
3641 thanks to) Fred Drake.
3643 * docutils/utils.py:
3645 - Added a ``source`` attribute to Reporter instances and
3646 ``system_message`` elements.
3647 - Added an observer pattern to ``utils.Reporter`` to keep track of
3649 - Fixed bugs in ``relative_path()``.
3650 - Added support for improved diagnostics.
3651 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
3652 - Added support for encoding Reporter stderr output, and encoding
3654 - Reporter keeps track of the highest level system message yet
3657 * docutils/languages: Fixed bibliographic field language lookups.
3659 * docutils/languages/es.py: Added to project; Spanish mappings by
3660 Marcelo Huerta San Martin.
3662 * docutils/languages/fr.py: Added to project; French mappings by
3665 * docutils/languages/it.py: Added to project; Italian mappings by
3668 * docutils/languages/sk.py: Added to project; Slovak mappings by
3671 * docutils/parsers/__init__.py:
3673 - Added ``Parser.finish_parse()`` method.
3675 * docutils/parsers/rst/__init__.py:
3677 - Added options: ``--pep-references``, ``--rfc-references``,
3678 ``--tab-width``, ``--trim-footnote-reference-space``.
3680 * docutils/parsers/rst/states.py:
3682 - Changed "title under/overline too short" system messages from INFO
3683 to WARNING, and fixed its insertion location.
3684 - Fixed enumerated list item parsing to allow paragraphs & section
3685 titles to begin with enumerators.
3686 - Converted system messages to use the new "line" attribute.
3687 - Fixed a substitution reference edge case.
3688 - Added support for ``--pep-references`` and ``--rfc-references``
3689 options; reworked ``Inliner`` code to make customization easier.
3690 - Removed field argument parsing.
3691 - Added support for short section title over/underlines.
3692 - Fixed "simple reference name" regexp to ignore text like
3693 "object.__method__"; not an anonymous reference.
3694 - Added support for improved diagnostics.
3695 - Reworked directive API, based on Dethe Elza's contribution. Added
3696 ``Body.parse_directive()``, ``.parse_directive_options()``,
3697 ``.parse_directive_arguments()`` methods.
3698 - Added ``ExtensionOptions`` class, to parse directive options
3699 without parsing field bodies. Factored
3700 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
3701 ``ExtensionOptions``.
3702 - Improved definition list term/classifier parsing.
3703 - Added warnings for unknown directives.
3704 - Renamed ``Stuff`` to ``Struct``.
3705 - Now flagged as errors: transitions at the beginning or end of
3706 sections, empty sections (except title), and empty documents.
3707 - Updated for ``statemachine.StringList``.
3708 - Enabled recognition of schemeless email addresses in targets.
3709 - Added support for embedded URIs in hyperlink references.
3710 - Added backslash-escapes to inline markup end-string suffix.
3711 - Added support for correct interpreted text processing.
3712 - Fixed nested title parsing (topic, sidebar directives).
3713 - Added special processing of backslash-escaped whitespace (idea
3714 from David Abrahams).
3715 - Made substitutions case-sensitive-but-forgiving; moved some code
3716 to ``docutils.nodes``.
3717 - Added support for block quote attributions.
3718 - Added a kludge to work-around a conflict between the bubble-up
3719 parser strategy and short titles (<= 3 char-long over- &
3720 underlines). Fixes SF bug #738803 "infinite loop with multiple
3721 titles" submitted by Jason Diamond.
3722 - Added explicit interpreted text roles for standard inline markup:
3723 "emphasis", "strong", "literal".
3724 - Implemented "superscript" and "subscript" interpreted text roles.
3725 - Added initial support for "abbreviation" and "acronym" roles;
3727 - Added support for ``--trim-footnote-reference-space`` option.
3728 - Optional space before colons in directives & hyperlink targets.
3730 * docutils/parsers/rst/tableparser.py:
3732 - Fixed a bug that was producing unwanted empty rows in "simple"
3734 - Detect bad column spans in "simple" tables.
3736 * docutils/parsers/rst/directives: Updated all directive functions to
3739 * docutils/parsers/rst/directives/__init__.py:
3741 - Added ``flag()``, ``unchanged()``, ``path()``,
3742 ``nonnegative_int()``, ``choice()``, and ``class_option()``
3743 directive option helper functions.
3744 - Added warnings for unknown directives.
3745 - Return ``None`` for missing directives.
3746 - Added ``register_directive()``, thanks to William Dode and Paul
3749 * docutils/parsers/rst/directives/admonitions.py:
3751 - Added "admonition" directive.
3753 * docutils/parsers/rst/directives/body.py: Added to project. Contains
3754 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
3755 "parsed-literal", "rubric", "epigraph", "highlights" and
3756 "pull-quote" directives.
3758 * docutils/parsers/rst/directives/images.py:
3760 - Added an "align" attribute to the "image" & "figure" directives
3761 (by Adam Chodorowski).
3762 - Added "class" option to "image", and "figclass" to "figure".
3764 * docutils/parsers/rst/directives/misc.py:
3766 - Added "include", "raw", and "replace" directives, courtesy of
3768 - Added "unicode" and "class" directives.
3770 * docutils/parsers/rst/directives/parts.py:
3772 - Added the "sectnum" directive; by Dmitry Jemerov.
3773 - Added "class" option to "contents" directive.
3775 * docutils/parsers/rst/directives/references.py: Added to project.
3776 Contains the "target-notes" directive.
3778 * docutils/parsers/rst/languages/__init__.py:
3780 - Return ``None`` from get_language() for missing language modules.
3782 * docutils/parsers/rst/languages/de.py: Added to project; German
3783 mappings by Engelbert Gruber.
3785 * docutils/parsers/rst/languages/en.py:
3787 - Added interpreted text roles mapping.
3789 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
3790 mappings by Marcelo Huerta San Martin.
3792 * docutils/parsers/rst/languages/fr.py: Added to project; French
3793 mappings by William Dode.
3795 * docutils/parsers/rst/languages/it.py: Added to project; Italian
3796 mappings by Nicola Larosa.
3798 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
3799 mappings by Miroslav Vasko.
3801 * docutils/readers/__init__.py:
3803 - Added support for the observer pattern from ``utils.Reporter``, in
3804 ``Reader.parse`` and ``Reader.transform``.
3805 - Removed ``Reader.transform()`` method.
3806 - Added default parameter values to ``Reader.__init__()`` to make
3807 instantiation easier.
3808 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
3810 * docutils/readers/pep.py:
3812 - Added the ``peps.TargetNotes`` transform to the Reader.
3813 - Removed PEP & RFC reference detection code; moved to
3814 parsers/rst/states.py as options (enabled here by default).
3815 - Added support for pre-acceptance PEPs (no PEP number yet).
3816 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
3819 * docutils/readers/python: Python Source Reader subpackage added to
3820 project, including preliminary versions of:
3823 - moduleparser.py: Parser for Python modules.
3825 * docutils/transforms/__init__.py:
3827 - Added ``Transformer`` class and completed transform reform.
3828 - Added unknown_reference_resolvers list for each transformer. This list holds
3829 the list of functions provided by each component of the transformer that
3830 help resolve references.
3832 * docutils/transforms/frontmatter.py:
3834 - Improved support for generic fields.
3835 - Fixed bibliographic field language lookups.
3837 * docutils/transforms/misc.py: Added to project. Miscellaneous
3840 * docutils/transforms/parts.py:
3842 - Moved the "id" attribute from TOC list items to the references
3843 (``Contents.build_contents()``).
3844 - Added the ``SectNum`` transform; by Dmitry Jemerov.
3845 - Added "class" attribute support to ``Contents``.
3847 * docutils/transforms/peps.py:
3849 - Added ``mask_email()`` function, updating to pep2html.py's
3851 - Linked "Content-Type: text/x-rst" to PEP 12.
3852 - Added the ``TargetNotes`` PEP-specific transform.
3853 - Added ``TargetNotes.cleanup_callback``.
3854 - Added title check to ``Headers``.
3856 * docutils/transforms/references.py:
3858 - Added the ``TargetNotes`` generic transform.
3859 - Split ``Hyperlinks`` into multiple transforms.
3860 - Fixed bug with multiply-indirect references (report: Bruce Smith).
3861 - Added check for circular indirect references.
3862 - Made substitutions case-sensitive-but-forgiving.
3864 * docutils/transforms/universal.py:
3866 - Added support for the ``--expose-internal-attributes`` option.
3867 - Removed ``Pending`` transform classes & data.
3869 * docutils/writers/__init__.py:
3871 - Removed ``Writer.transform()`` method.
3873 * docutils/writers/docutils-xml.py:
3875 - Added XML and doctype declarations.
3876 - Added ``--no-doctype`` and ``--no-xml-declaration`` options.
3878 * docutils/writers/html4css1.py:
3880 - "name" attributes only on these tags: a, applet, form, frame,
3882 - Added "name" attribute to <a> in section titles for Netscape 4
3883 support (bug report: Pearu Peterson).
3884 - Fixed targets (names) on footnote, citation, topic title,
3885 problematic, and system_message nodes (for Netscape 4).
3886 - Changed field names from "<td>" to "<th>".
3887 - Added "@" to "@" encoding to thwart address harvesters.
3888 - Improved the vertical whitespace optimization; ignore "invisible"
3889 nodes (targets, comments, etc.).
3890 - Improved inline literals with ``<span class="pre">`` around chunks
3891 of text and `` `` for runs of spaces.
3892 - Improved modularity of output; added ``self.body_pre_docinfo`` and
3893 ``self.docinfo`` segments.
3894 - Added support for "line_block", "address" elements.
3895 - Improved backlinks (footnotes & system_messages).
3896 - Improved system_message output.
3897 - Redefined ``--stylesheet`` as containing an invariant URL, used
3898 verbatim. Added ``--stylesheet-path``, interpreted w.r.t. the
3900 - Added ``--footnote-references`` option (superscript or brackets).
3901 - Added ``--compact-lists`` and ``--no-compact-lists`` options.
3902 - Added ``--embed-stylesheet`` and ``--link-stylesheet`` options;
3903 factored out ``HTMLTranslator.get_stylesheet_reference()``.
3904 - Improved field list rendering.
3905 - Added Docutils version to "generator" meta tag.
3906 - Fixed a bug with images; they must be inline, so wrapped in <p>.
3907 - Improved layout of <pre> HTML source.
3908 - Fixed attribute typo on <colspec>.
3909 - Refined XML prologue.
3910 - Support for no stylesheet.
3911 - Removed "interpreted" element support.
3912 - Added support for "title_reference", "sidebar", "attribution",
3913 "rubric", and generic "admonition" elements.
3914 - Added ``--attribution`` option.
3915 - Added support for "inline", "subscript", "superscript" elements.
3916 - Added initial support for "abbreviation" and "acronym";
3919 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3923 - Double quotes in literal blocks (special treatment for de/ngerman).
3924 - Added ``--hyperlink-color`` option ('0' turns off coloring of links).
3925 - Added ``--attribution`` option.
3926 - Right align attributions.
3928 * docutils/writers/pep_html.py:
3930 - Parameterized output encoding in PEP template.
3931 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3932 - Redefined ``--pep-stylesheet`` as containing an invariant URL, used
3933 verbatim. Added ``--pep-stylesheet-path``, interpreted w.r.t. the
3935 - Added an override on the ``--footnote-references`` option.
3936 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3937 - Added Docutils version to "generator" meta tag.
3938 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3942 - Added a "silent" setting for ``buildhtml.py``.
3943 - Added a "Getting Help" section.
3944 - Rearranged the structure.
3945 - Kept up to date, with new settings, command-line options etc.
3946 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3947 - Converted settings table into a definition list.
3949 * docs/rst/quickstart.txt:
3951 - Added a table of contents.
3952 - Added feedback information.
3953 - Added mention of minimum section title underline lengths.
3954 - Removed the 4-character minimum for section title underlines.
3956 * docs/rst/quickref.html:
3958 - Added a "Getting Help" section.
3959 - Added a style to make section title backlinks more subtle.
3960 - Added mention of minimum section title underline lengths.
3961 - Removed the 4-character minimum for section title underlines.
3963 * extras: Directory added to project; contains third-party modules
3964 that Docutils depends on (optparse, textwrap, roman). These are
3965 only installed if they're not already present.
3967 * licenses: Directory added to project; contains copies of license
3968 files for non-public-domain files.
3972 - Changed the focus. It's about DTD elements: structural
3973 relationships, semantics, and external (public) attributes. Not
3974 about the element class library.
3975 - Moved some implementation-specific stuff into ``docutils.nodes``
3977 - Wrote descriptions of all common attributes and parameter
3978 entities. Filled in introductory material.
3979 - Working through the element descriptions: 55 down, 37 to go.
3980 - Removed "Representation of Horizontal Rules" to
3981 spec/rst/alternatives.txt.
3983 * spec/docutils.dtd:
3985 - Added "generated" inline element.
3986 - Added "line_block" body element.
3987 - Added "auto" attribute to "title".
3988 - Changed content models of "literal_block" and "doctest_block" to
3990 - Added ``%number;`` attribute type parameter entity.
3991 - Changed ``%structural.elements;`` to ``%section.elements``.
3992 - Updated attribute types; made more specific.
3993 - Added "address" bibliographic element.
3994 - Added "line" attribute to ``system_message`` element.
3995 - Removed "field_argument" element; "field_name" may contain
3996 multiple words and whitespace.
3997 - Changed public identifier to docutils.sf.net.
3998 - Removed "interpreted" element; added "title_reference",
3999 "abbreviation", "acronym".
4000 - Removed "refuri" attribute from "footnote_reference" and
4001 "citation_reference".
4002 - Added "sidebar", "rubric", "attribution", "admonition",
4003 "superscript", "subscript", and "inline" elements.
4005 * spec/pep-0256.txt: Converted to reStructuredText & updated.
4007 * spec/pep-0257.txt: Converted to reStructuredText & updated.
4009 * spec/pep-0258.txt: Converted to reStructuredText & updated.
4011 * spec/semantics.txt: Updated with text from a Doc-SIG response to
4014 * spec/transforms.txt: Added to project.
4016 * spec/howto: Added subdirectory, for developer how-to docs.
4018 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
4019 Elza, edited & extended by David Goodger.
4021 * spec/howto/i18n.txt: Docutils Internationalization. Added to
4024 * spec/rst/alternatives.txt:
4026 - Added "Doctree Representation of Transitions" from
4028 - Updated "Inline External Targets" & closed the debate.
4029 - Added ideas for interpreted text syntax extensions.
4030 - Added "Nested Inline Markup" section.
4032 * spec/rst/directives.txt:
4034 - Added directives: "topic", "sectnum", "target-notes",
4035 "line-block", "parsed-literal", "include", "replace", "sidebar",
4036 "admonition", "rubric", "epigraph", "highlights", "unicode" and
4038 - Formalized descriptions of directive details.
4039 - Added an "align" attribute to the "image" & "figure" directives
4040 (by Adam Chodorowski).
4041 - Added "class" options to "topic", "sidebar", "line-block",
4042 "parsed-literal", "contents", and "image"; and "figclass" to
4045 * spec/rst/interpreted.txt: Added to project. Descriptions of
4046 interpreted text roles.
4048 * spec/rst/introduction.txt:
4050 - Added pointers to material for new users.
4052 * spec/rst/reStructuredText.txt:
4054 - Disambiguated comments (just add a newline after the "::").
4055 - Updated enumerated list description; added a discussion of the
4056 second-line validity checking.
4057 - Updated directive description.
4058 - Added a note redirecting newbies to the user docs.
4059 - Expanded description of inline markup start-strings in non-markup
4061 - Removed field arguments and made field lists a generic construct.
4062 - Removed the 4-character minimum for section title underlines.
4063 - Clarified term/classifier delimiter & inline markup ambiguity
4065 - Added "Embedded URIs".
4066 - Updated "Interpreted Text" section.
4067 - Added "Character-Level Inline Markup" section.
4069 * test: Continually adding & updating tests.
4071 - Moved test/test_rst/ to test/test_parsers/test_rst/.
4072 - Moved test/test_pep/ to test/test_readers/test_pep/.
4073 - Added test/test_readers/test_python/.
4074 - Added test/test_writers/ (Engelbert Gruber).
4078 - Made the ``locale.setlocale()`` calls in front ends
4081 * tools/buildhtml.py:
4083 - Added ``--silent`` option.
4084 - Fixed bug with absolute paths & ``--config``.
4085 - Updated for new I/O classes.
4086 - Added some exception handling.
4087 - Separated publishers' setting defaults; prevents interference.
4088 - Updated for new ``publish_file()`` convenience function.
4090 * tools/pep-html-template:
4092 - Allow for ``--embed-stylesheet``.
4093 - Added Docutils version to "generator" meta tag.
4094 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
4095 - Conform to XHTML spec.
4097 * tools/pep2html.py:
4099 - Made ``argv`` a parameter to ``main()``.
4100 - Added support for "Content-Type:" header & arbitrary PEP formats.
4101 - Linked "Content-Type: text/plain" to PEP 9.
4102 - Files skipped (due to an error) are not pushed onto the server.
4103 - Updated for new I/O classes.
4104 - Added ``check_requirements()`` & ``pep_type_error()``.
4105 - Added some exception handling.
4106 - Updated for new ``publish_string()`` convenience function.
4107 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
4109 * tools/quicktest.py:
4111 - Added ``-V``/``--version`` option.
4113 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
4115 * tools/unicode2rstsubs.py: Added to project. Produces character
4116 entity files (reSructuredText substitutions) from the MathML master
4119 * tools/editors: Support code for editors, added to project. Contains
4120 ``emacs/restructuredtext.el``.
4122 * tools/stylesheets/default.css: Moved into the stylesheets directory.
4124 - Added style for chunks of inline literals.
4125 - Removed margin for first child of table cells.
4126 - Right-aligned field list names.
4127 - Support for auto-numbered section titles in TOCs.
4128 - Increased the size of inline literals (<tt>) in titles.
4129 - Restored the light gray background for inline literals.
4130 - Added support for "line_block" elements.
4131 - Added style for "address" elements.
4132 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
4133 - Improved field list rendering.
4134 - Vertical whitespace improvements.
4135 - Removed "a.target" style.
4137 * tools/stylesheets/pep.css:
4139 - Fixed nested section margins.
4140 - Other changes parallel those of ``../default.css``.
4143 Release 0.2 (2002-07-31)
4144 ========================
4148 - The word "component" was being used ambiguously. From now on,
4149 "component" will be used to mean "Docutils component", as in Reader,
4150 Writer, Parser, or Transform. Portions of documents (Table of
4151 Contents, sections, etc.) will be called "document parts".
4152 - Did a grand renaming: a lot of ``verylongnames`` became
4153 ``very_long_names``.
4154 - Cleaned up imports: no more relative package imports or
4155 comma-separated lists of top-level modules.
4156 - Added support for an option values object which carries default
4157 settings and overrides (from command-line options and library use).
4158 - Added internal Unicode support, and support for both input and
4160 - Added support for the ``docutils.io.IO`` class & subclasses.
4164 * docutils/__init__.py:
4166 - Added ``ApplicationError`` and ``DataError``, for use throughout
4168 - Added ``Component`` base class for Docutils components; implements
4169 the ``supports`` method.
4170 - Added ``__version__`` (thus, ``docutils.__version__``).
4174 - Removed many keyword parameters to ``Publisher.__init__()`` and
4175 ``publish()``; bundled into an option values object. Added
4176 "argv", "usage", "description", and "option_spec" parameters for
4177 command-line support.
4178 - Added ``Publisher.process_command_line()`` and ``.set_options()``
4180 - Reworked I/O model for ``docutils.io`` wrappers.
4181 - Updated ``Publisher.set_options()``; now returns option values
4183 - Added support for configuration files (/etc/docutils.conf,
4184 ./docutils.conf, ~/.docutils).
4185 - Added ``Publisher.setup_option_parser()``.
4186 - Added default usage message and description.
4188 * docutils/frontend.py: Added to project; support for front-end
4189 (command-line) scripts. Option specifications may be augmented by
4190 components. Requires Optik (http://optik.sourceforge.net/) for option
4191 processing (installed locally as docutils/optik.py).
4193 * docutils/io.py: Added to project; uniform API for a variety of input
4196 * docutils/nodes.py:
4198 - Added ``TreeCopyVisitor`` class.
4199 - Added a ``copy`` method to ``Node`` and subclasses.
4200 - Added a ``SkipDeparture`` exception for visitors.
4201 - Renamed ``TreePruningException`` from ``VisitorException``.
4202 - Added docstrings to ``TreePruningException``, subclasses, and
4204 - Improved docstrings.
4205 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
4206 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
4208 - Added ``decoration``, ``header``, and ``footer`` node classes, and
4209 ``PreDecorative`` mixin.
4210 - Reworked the name/id bookkeeping; to ``document``, removed
4211 ``explicit_targets`` and ``implicit_targets`` attributes, added
4212 ``nametypes`` attribute and ``set_name_id_map`` method.
4213 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
4215 - Added ``document.has_name()`` method.
4216 - Fixed DOM generation for list-attributes.
4217 - Added category class ``Labeled`` (used by footnotes & citations).
4218 - Added ``Element.set_class()`` method (sets "class" attribute).
4220 * docutils/optik.py: Added to project. Combined from the Optik
4221 package, with added option groups and other modifications. The use
4222 of this module is probably only temporary.
4224 * docutils/statemachine.py:
4226 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
4227 - Added underscores to improve many awkward names.
4228 - In ``string2lines()``, changed whitespace normalizing translation
4229 table to regexp; restores Python 2.0 compatibility with Unicode.
4231 * docutils/urischemes.py:
4233 - Filled in some descriptions.
4234 - Added "shttp" scheme.
4236 * docutils/utils.py:
4238 - Added ``clean_rcs_keywords`` function (moved from
4239 docutils/transforms/frontmatter.py
4240 ``DocInfo.filter_rcs_keywords``).
4241 - Added underscores to improve many awkward names.
4242 - Changed names of Reporter's thresholds:
4243 warning_level -> report_level; error_level -> halt_level.
4244 - Moved ``utils.id()`` to ``nodes.make_id()``.
4245 - Added ``relative_path(source, target)``.
4247 * docutils/languages/de.py: German mappings; added to project. Thanks
4248 to Gunnar Schwant for the translations.
4250 * docutils/languages/en.py: Added "Dedication" bibliographic field
4253 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
4256 * docutils/parsers/rst/states.py:
4258 - Added underscores to improve many awkward names.
4259 - Added RFC-2822 header support.
4260 - Extracted the inline parsing code from ``RSTState`` to a separate
4261 class, ``Inliner``, which will allow easy subclassing.
4262 - Made local bindings for ``memo`` container & often-used contents
4263 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
4264 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
4265 - Added ``MarkupMismatch`` exception; for late corrections.
4266 - Added ``-/:`` characters to inline markup's start string prefix,
4267 ``/`` to end string suffix.
4268 - Fixed a footnote bug.
4269 - Fixed a bug with literal blocks.
4270 - Applied patch from Simon Budig: simplified regexps with symbolic
4271 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
4272 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
4273 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
4274 - Allowed non-ASCII in "simple names" (directive names, field names,
4276 - Converted ``Inliner.patterns.initial`` to be dynamically built
4277 from parts with ``build_regexp()`` function.
4278 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
4279 - Updated docstrings.
4280 - Changed "table" to "grid_table"; added "simple_table" support.
4282 * docutils/parsers/rst/tableparser.py:
4284 - Changed ``TableParser`` to ``GridTableParser``.
4285 - Added ``SimpleTableParser``.
4286 - Refactored naming.
4288 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
4289 a fallback language for directive names.
4291 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
4292 directive to use a ``pending`` element, used only by HTML writers.
4294 * docutils/parsers/rst/directives/parts.py: Renamed from
4297 - Added "backlinks" attribute to "contents" directive.
4299 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
4300 project by Adam Chodorowski.
4302 * docutils/readers/__init__.py: Gave Readers more control over
4303 choosing and instantiating Parsers.
4305 * docutils/readers/pep.py: Added to project; for PEP processing.
4307 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
4308 requires a ``component`` parameter.
4310 * docutils/transforms/components.py: Added to project; transforms
4311 related to Docutils components.
4313 * docutils/transforms/frontmatter.py:
4315 - In ``DocInfo.extract_authors``, check for a single "author" in an
4316 "authors" group, and convert it to a single "author" element.
4317 - Added support for "Dedication" and generic bibliographic fields.
4319 * docutils/transforms/peps.py: Added to project; PEP-specific.
4321 * docutils/transforms/parts.py: Renamed from old components.py.
4323 - Added filter for ``Contents``, to use alt-text for inline images,
4324 and to remove inline markup that doesn't make sense in the ToC.
4325 - Added "name" attribute to TOC topic depending on its title.
4326 - Added support for optional TOC backlinks.
4328 * docutils/transforms/references.py: Fixed indirect target resolution
4329 in ``Hyperlinks`` transform.
4331 * docutils/transforms/universal.py:
4333 - Changed ``Messages`` transform to properly filter out system
4334 messages below the warning threshold.
4335 - Added ``Decorations`` transform (support for ``--generator``,
4336 ``--date``, ``--time``, ``--source-link`` options).
4338 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
4339 Engelbert Gruber's PDF writer.
4341 * docutils/writers/html4css1.py:
4343 - Made XHTML-compatible (switched to lowercase element & attribute
4344 names; empty tag format).
4345 - Escape double-dashes in comment text.
4346 - Improved boilerplate & modularity of output.
4347 - Exposed modular output in Writer class.
4348 - Added a "generator" meta tag to <head>.
4349 - Added support for the ``--stylesheet`` option.
4350 - Added support for ``decoration``, ``header``, and ``footer``
4352 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
4353 translation table to regexp; restores Python 2.0 compatibility
4355 - Added the translator class as instance variable to the Writer, to
4356 make it easily subclassable.
4357 - Improved option list spacing (thanks to Richard Jones).
4358 - Modified field list output.
4359 - Added backlinks to footnotes & citations.
4360 - Added percentage widths to "<col>" tags (from colspec).
4361 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
4362 "<span>" changed to "<var>".
4363 - Inline literals: "<code>" changed to "<tt>".
4364 - Many changes to optimize vertical space: compact simple lists etc.
4365 - Add a command-line options & directive attributes to control TOC
4366 and footnote/citation backlinks.
4367 - Added support for optional footnote/citation backlinks.
4368 - Added support for generic bibliographic fields.
4369 - Identify backrefs.
4370 - Relative URLs for stylesheet links.
4372 * docutils/writers/pep_html.py: Added to project; HTML Writer for
4373 PEPs (subclass of ``html4css1.Writer``).
4375 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
4377 * docutils/writers/docutils_xml.py: Added to project; trivial writer
4378 of the Docutils internal doctree in XML.
4380 * docs/tools.txt: "Docutils Front-End Tools", added to project.
4384 - Changed the title to "The Docutils Document Tree".
4385 - Added "Hyperlink Bookkeeping" section.
4387 * spec/docutils.dtd:
4389 - Added ``decoration``, ``header``, and ``footer`` elements.
4390 - Brought ``interpreted`` element in line with the parser: changed
4391 attribute "type" to "role", added "position".
4392 - Added support for generic bibliographic fields.
4394 * spec/notes.txt: Continual updates. Added "Project Policies".
4396 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
4399 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
4401 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
4402 mailing list discussions.
4404 * spec/pep-0287.txt:
4406 - Renamed to "reStructuredText Docstring Format".
4408 - Reworked Q&A as an enumerated list.
4409 - Converted to reStructuredText format.
4411 * spec/pysource.dtd:
4413 - Reworked structural elements, incorporating ideas from Tony Ibbs.
4415 * spec/pysource.txt: Removed from project. Moved much of its contents
4418 * spec/rst/alternatives.txt:
4420 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
4421 - Added "Inline External Targets" section.
4423 * spec/rst/directives.txt:
4425 - Added "backlinks" attribute to "contents" directive.
4427 * spec/rst/problems.txt:
4429 - Updated the Enumerated List Markup discussion.
4430 - Added new alternative table markup syntaxes.
4432 * spec/rst/reStructuredText.txt:
4434 - Clarified field list usage.
4435 - Updated enumerated list description.
4436 - Clarified purpose of directives.
4437 - Added ``-/:`` characters to inline markup's start string prefix,
4438 ``/`` to end string suffix.
4439 - Updated "Authors" bibliographic field behavior.
4440 - Changed "inline hyperlink targets" to "inline internal targets".
4441 - Added "simple table" syntax to supplement the existing but
4442 newly-renamed "grid tables".
4443 - Added cautions for anonymous hyperlink use.
4444 - Added "Dedication" and generic bibliographic fields.
4446 * test: Made test modules standalone (subdirectories became packages).
4448 * test/DocutilsTestSupport.py:
4450 - Added support for PEP extensions to reStructuredText.
4451 - Added support for simple tables.
4452 - Refactored naming.
4454 * test/package_unittest.py: Renamed from UnitTestFolder.py.
4456 - Now supports true packages containing test modules
4457 (``__init__.py`` files required); fixes duplicate module name bug.
4459 * test/test_pep/: Subpackage added to project; PEP testing.
4461 * test/test_rst/test_SimpleTableParser.py: Added to project.
4465 - Updated html.py and publish.py front-end tools to use the new
4466 command-line processing facilities of ``docutils.frontend``
4467 (exposed in ``docutils.core.Publisher``), reducing each to just a
4469 - Added ``locale.setlocale()`` calls to front-end tools.
4471 * tools/buildhtml.py: Added to project; batch-generates .html from all
4472 the .txt files in directories and subdirectories.
4474 * tools/default.css:
4476 - Added support for ``header`` and ``footer`` elements.
4477 - Added styles for "Dedication" topics (biblio fields).
4479 * tools/docutils.conf: A configuration file; added to project.
4481 * tools/docutils-xml.py: Added to project.
4483 * tools/pep.py: Added to project; PEP to HTML front-end tool.
4485 * tools/pep-html-template: Added to project.
4487 * tools/pep2html.py: Added to project from Python (nondist/peps).
4488 Added support for Docutils (reStructuredText PEPs).
4490 * tools/quicktest.py:
4492 - Added the ``--attributes`` option, hacked a bit.
4493 - Added a second command-line argument (output file); cleaned up.
4495 * tools/stylesheets/: Subdirectory added to project.
4497 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
4500 Release 0.1 (2002-04-20)
4501 ========================
4503 This is the first release of Docutils, merged from the now inactive
4504 reStructuredText__ and `Docstring Processing System`__ projects. For
4505 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
4506 `DPS HISTORY`__ files.
4508 __ http://structuredtext.sourceforge.net/
4509 __ http://docstring.sourceforge.net/
4510 __ http://structuredtext.sourceforge.net/HISTORY.html
4511 __ http://docstring.sourceforge.net/HISTORY.html
4513 General changes: renamed 'dps' package to 'docutils'; renamed
4514 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
4515 the test suites (reStructuredText's test/test_states renamed to
4516 test/test_rst); and all modifications required to make it all work.
4518 * docutils/parsers/rst/states.py:
4520 - Improved diagnostic system messages for missing blank lines.
4521 - Fixed substitution_reference bug.
4526 .. _RELEASE-NOTES: RELEASE-NOTES.html
4527 .. _`_config_files`: docs/user/config.html#config-files
4528 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
4530 .. _detailed: docs/user/config.html#detailed
4531 .. _docutils_footnotes: docs/user/config.html#docutils-footnotes
4532 .. _dump_settings: docs/user/config.html#dump-settings
4533 .. _embed_images: docs/user/config.html#embed-images
4534 .. _embed_stylesheet: docs/user/config.html#embed-stylesheet
4535 .. _figure_footnotes: docs/user/config.html#figure-footnotes
4536 .. _file_insertion_enabled: docs/user/config.html#file-insertion-enabled
4537 .. _graphicx_option: docs/user/config.html#graphicx-option
4538 .. _hidden_controls: docs/user/config.html#hidden-controls
4539 .. _html_writer: docs/user/config.html#html-writer
4540 .. _hyperref_options: docs/user/config.html#hyperref-options
4541 .. _id_prefix: docs/user/config.html#id-prefix
4542 .. _ignore: docs/user/config.html#ignore
4543 .. _image_loading: docs/user/config.html#image-loading
4544 .. _indents: docs/user/config.html#indents
4545 .. _initial_header_level: docs/user/config.html#initial-header-level
4546 .. _input_encoding: docs/user/config.html#input-encoding
4547 .. _input_encoding_error_handler: docs/user/config.html#input-encoding-error-handler
4548 .. _language: docs/user/config.html#language
4549 .. _latex_preamble: docs/user/config.html#latex-preamble
4550 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
4551 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
4552 .. _literal_block_env: docs/user/config.html#literal-block-env
4553 .. _math_output: docs/user/config.html#math-output
4554 .. _output: docs/user/config.html#output
4555 .. _output_encoding: docs/user/config.html#output-encoding
4556 .. _prune: docs/user/config.html#prune
4557 .. _raw_enabled: docs/user/config.html#raw-enabled
4558 .. _reference_label: docs/user/config.html#reference-label
4559 .. _root_prefix: docs/user/config.html#root-prefix
4560 .. _smart_quotes: docs/user/config.html#smart-quotes
4561 .. _sources: docs/user/config.html#sources
4562 .. _strip_classes: docs/user/config.html#strip-classes
4563 .. _strip_elements_with_classes: docs/user/config.html#strip-elements-with-classes
4564 .. _stylesheet: docs/user/config.html#stylesheet
4565 .. _stylesheet_dirs: docs/user/config.html#stylesheet-dirs
4566 .. _stylesheet_path: docs/user/config.html#stylesheet-path
4567 .. _syntax_highlight: docs/user/config.html#syntax-highlight
4568 .. _table_style: docs/user/config.html#table-style
4569 .. _theme: docs/user/config.html#theme
4570 .. _theme_url: docs/user/config.html#theme-url
4571 .. _toc_backlinks: docs/user/config.html#toc-backlinks
4572 .. _traceback: docs/user/config.html#traceback
4573 .. _use_bibtex: docs/user/config.html#use-bibtex
4574 .. _use_latex_abstract: docs/user/config.html#use-latex-abstract
4575 .. _use_latex_footnotes: docs/user/config.html#use-latex-footnotes
4576 .. _use_latex_toc: docs/user/config.html#use-latex-toc
4577 .. _view_mode: docs/user/config.html#view-mode
4579 .. _<meta>: docs/ref/doctree.html#meta
4580 .. _<image>: docs/ref/doctree.html#image
4581 .. _<inline>: docs/ref/doctree.html#inline
4582 .. _<literal>: docs/ref/doctree.html#literal
4590 indent-tabs-mode: nil
4591 sentence-end-double-space: t