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).
27 - New `SubStructural` element category class.
28 - Fix element categories.
29 - New method `Element.validate()` (work in progress).
31 * docutils/transforms/frontmatter.py
33 - Adapt `DocInfo` to fixed element categories.
35 * docutils/writers/manpage.py
37 - Remove code for unused emdash bullets.
39 Release 0.21.2 (2024-04-23)
40 ===========================
42 * Declare support for languages Georgian and Catalan (Valencian).
44 * docs/ref/docutils.dtd
46 - Remove declaration of element <info>.
47 - Remove <decoration> from content declaration of <section> elements.
52 Release 0.21.1 (2024-04-10)
53 ===========================
55 * Add missing files in Docutils 0.21 source distribution (sdist).
57 Release 0.21 (2024-04-09)
58 =========================
62 - Drop support for Python 3.7 and 3.8.
63 - Updated build system to use Flit_ (patch #186 by Adam Turner).
65 - Provide ``rst2*`` "console_scripts" `entry points`_
66 (without the ``.py`` extension) instead of installing the
67 ``rst2*.py`` front end tools in the binary PATH.
69 .. _Flit: https://github.com/pypa/flit/
71 * docs/ref/docutils.dtd
73 - The <image> element accepts a new attribute "loading".
75 - Fix definitions (no change to actual behaviour):
77 * The <math_block> element uses the attribute "xml:space".
78 * The <raw> element may contain text only (no inline elements).
79 * The <topic> element uses the "depth" and "local" attributes to
80 store "contents" directive options when used as placeholder for a
81 generated table of contents (LaTeX writers with `use_latex_toc`_
85 Reference names (``%refname.type`` and ``%refnames.type``)
86 are whitespace-normalized but **not** always downcased.
88 * docutils/frontend.py
90 - Allow `validate_*()` functions to be called with just the "value"
91 argument but keep the legacy interface for use with optparse.
92 - New function `frontend.validate_math_output()`.
96 - Simpler and more secure `input encoding`_ default behaviour:
98 Do not use the locale encoding as fallback if Python is started in
99 `UTF-8 mode`_. Stop using "latin1" as second fallback.
101 Remove BOM (U+FEFF ZWNBSP at start of data) only if the "input_encoding"
102 configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'.
103 Do not remove other ZWNBSPs.
105 .. _UTF-8 mode: https://docs.python.org/3/library/os.html#utf8-mode
106 .. _input encoding: docs/api/publisher.html#encodings
108 - Auto-close `FileInput.source` in case of reading/decoding errors.
110 * docutils/languages/, docutils/parsers/rst/languages/
112 - Mark/Fix mistranslated localizations of the "admonition" directive
113 name. In Docutils, "admonition" is used as a generic term for
114 "advice"/"advisory"/"remark", not a reprimand.
115 - Add support for Georgian language (patch #204 by Temuri Doghonadze).
116 - Update/complete Catalan translations (patch #203 by Antoni Bella Pérez).
120 - Remove compatibility hacks `nodes.reprunicode` and `nodes.ensure_str()`.
122 * docutils/parsers/rst/directives/images.py
124 - New "image" directive option "loading".
126 * docutils/parsers/rst/directives/tables.py
128 - Use the same CSV format for the ``:header:`` option and the main data
129 of the "csv-table" directive.
131 - Move `parsers.rst.directives.Table.process_header_option()` method
132 to `parsers.rst.directives.CSVTable`.
134 * docutils/parsers/rst/states.py
136 - Don't split inside "< >" when parsing "option groups" (fixes bug #474).
138 * docutils/parsers/rst/directives/misc.py,
139 docutils/parsers/rst/directives/tables.py
141 - Consider the new root_prefix_ setting when including files with
142 "include", "raw", or "csv-table" directives.
144 * docutils/utils/math/*
146 - Use custom exception `utils.math.MathError` instead of
147 abusing `SyntaxError` for LaTeX math syntax errors.
148 - Unify interface of LaTeX -> MathML conversion functions.
149 Improve error reporting.
150 - Sort ℏ (`\hslash`) as "mathord", not "mathalpha".
152 * docutils/utils/math/latex2mathml.py
154 - Generate "MathML Core" to fix rendering with Chromium/Android.
156 Use CSS rules instead of the deprecated "columnalign" attribute
157 to style <mtable> as "align" environment.
159 Use Mathematical Alphanumeric Symbols instead of <mstyle> with
160 "mathvariant" attribute.
162 - Use <mi> instead of <mo> for character class "mathord".
164 - Support "aligned" environment.
166 - Eliminate side-effect on later import of "tex2unichar".
168 * docutils/utils/math/mathml_elements.py
170 - New module defining MathML element classes
171 (outsourced from latex2mathml.py).
172 - Base MathML element classes on `xml.etree.ElementTree`.
174 * docutils/utils/roman.py
176 - Update to version `1.4 <https://pypi.org/project/roman/4.1/>`__.
177 Fixes feature-request #95 (license is now ZPL 2.1).
179 * docutils/utils/smartquotes.py
181 - Pre-compile regexps once, not with every call of `educateQuotes()`
182 (patch #206 by Chris Sewell).
183 - Simplify regexps; skip replacement rules if there is nothing to replace.
185 * docutils/writers/html4css1/__init__.py
187 - Support video inclusion via ``<object>`` tags.
189 * docutils/writers/html5_polyglot/\*.css
191 - Move MathML styles to "minimal.css" (required for correct rendering).
192 - Highlight heading of target section also with explicit hyperlink target.
193 - No additional margins for line-blocks.
195 * docutils/writers/_html_base.py
197 - Stop setting the "footnote-reference" class value for footnote references.
198 Since 0.18, you can use the CSS selector ``[role="doc-noteref"]``.
199 - Support reading/embedding images also with "file:" URI.
200 - Warn, if image scaling fails because the image file cannot be read.
201 - Support video inclusion via ``<video>`` tags
202 (moved here from writers/html5_polyglot/__init__.py).
203 - New auxiliary method `HTMLTranslator.uri2imagepath()` ensures the
204 image file can also be read when CWD and output directory differ.
205 - Consider the root_prefix_ setting when converting an image URI
206 to a local filesystem path.
207 - New `\<image>`_ attribute "loading" overrides image_loading_ setting.
208 - Embed SVG images as ``<svg>`` instead of data-URI.
209 Fixes feature-request #100.
210 - Generate system messages for errors/warnings during the writing stage
211 (image transformations, math content conversion, ...).
212 - Close ``<dt>`` element in `depart_term()` to allow a
213 "definition_list_item" with multiple "terms" (cf. feature-request #60).
214 - Link to the document "#top" from the ToC heading
215 (unless toc_backlinks_ is False).
216 - Transfer `id` attribute from <field> elements to the respective
217 <field_name> child element to allow cross-references to field-list items
218 (<field>s are skipped in HTML output).
220 * docutils/writers/latex2e/__init__.py
222 - Fix placement of hyperlink target (label) for tables (bug #440).
223 - More compact LaTeX source for option-lists and description-lists
224 (no change in output).
226 * docutils/writers/manpage.py
228 - Put manual section in .TH in quotes.
229 - Skip footer to avoid the link to document source in the manpage.
230 - Add multiple definition list term support, see feature #60.
231 - Render reference, refid and refuri.
232 Use of ``.UR`` and ``.UE`` macros for reference markup is too brittle.
233 - Add preprocessor hinting tbl first line, see bug #477.
234 - Change tbl-Tables using box option, see bug #475.
235 - Apply literal block patch #205. Use ``.EE`` and ``.EX`` macros.
236 Thanks to G. Branden Robinson.
238 * docutils/writers/odf_odt/__init__.py
240 - Use context manager for image reading operations.
241 Catch `URLError` when `urllib.request.urlopen()` fails.
243 - Convert image URI to path if accessing a local file. Fixes bug #153.
245 * docutils/writers/s5_html/__init__.py
247 - Warn if the S5 writer cannot copy the theme files.
248 - Programmatic customization of theme_url_ setting no longer
249 overridden by the default for theme_.
253 - New configuration setting `sources`_.
254 - Match `prune`_ values with `fnmatch.fnmatch()`.
257 Release 0.20.1 (2023-05-17)
258 ===========================
260 * docutils/MANIFEST.in
262 - Include tox.ini and docutils.conf in the source package
263 (cf. bug #467 and bug #461).
265 * tools/rst2odt_prepstyles.py
267 - Moved to ``docutils/writers/odf_odt/prepstyles.py``.
268 Replaced with a provisional backwards compatibility script.
271 Release 0.20 (2023-05-09)
272 =========================
276 - Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
277 - Support Python 3.11 (patch #198 by Hugo van Kemenade).
281 - New functions `rst2…()` for use as "console_scripts" `entry points`_.
282 (cf. `Future changes` in the RELEASE-NOTES_).
284 * docutils/frontend.py
286 - New configuration setting "output_". Obsoletes the ``<destination>``
287 positional argument (cf. `Future changes` in the RELEASE-NOTES_).
289 * docutils/languages/
290 docutils/parsers/rst/languages/
292 - Support Ukrainian. Patch by Dmytro Kazanzhy.
296 - Fix `previous_sibling()` method that led to invalid HTML in some cases
298 - Fix bug #463. Spurious comma in deprecation warning.
300 * docutils/parsers/recommonmark_wrapper.py
302 - Improved mock Sphinx module.
304 * docutils/transforms/__init__.py
306 - `Transformer.populate_from_components()` now silently ignores
307 components that are not instances of `docutils.TransformSpec`.
309 * docutils/transforms/frontmatter.py
311 - Accept author names with initials like ``A. Einstein`` in the "author"
312 `bibliographic field`_ instead of rising an error
313 (generally, such names are `parsed as enumerated list`__).
315 .. _bibliographic field:
316 docs/ref/rst/restructuredtext.html#bibliographic-fields
317 __ docs/ref/rst/restructuredtext.html#enumerated-lists
319 * docutils/transforms/references.py
321 - `DanglingReferences` ignores `citation_reference` nodes if the
322 "use_bibex" setting is active. (In this case, citations are provided
323 by LaTeX/BibTeX.) Fixes bug #384.
325 * docutils/utils/__init__.py
327 - New utility function `xml_declaration()`.
328 - `DependencyList.add()` accepts `pathlib.Path` instances.
329 - `find_file_in_dirs()` now returns a POSIX path also on Windows;
330 `get_stylesheet_list()` no longer converts ``\`` to ``/``.
332 * docutils/utils/math/latex2mathml.py
334 - Support "mod" notation for modulo operation / modulus arithmetic.
336 * docutils/utils/math/tex2mathml_extern.py
338 - Support `Pandoc` as alternative LaTeX to MathML converter.
341 * docutils/writers/_html_base.py
343 - Refactoring of `HTMLTranslator` initialization and collecting of
344 document "parts". Adapt HTML writers importing `_html_base`.
346 Changes to the HTML output (no space character before closing tag of
347 XML declaration, order of metadata elements)
348 don't affect the HTML semantics, styling, and rendering.
350 - Wrap definition lists with "details" class argument in a <div>
351 with the "id" and "class" values of the list node.
353 - Use dpub-ARIA role "doc-footnote__" (instead of ARIA role "note")
356 __ https://www.w3.org/TR/dpub-aria-1.1/#doc-footnote
358 * docutils/writers/html5_polyglot/__init__.py
360 - Do not convert class values to HTML5 text-level tags inside
361 <code> and <code-block> (fixes bug #476).
363 * docutils/writers/latex2e/__init__.py
365 - Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
366 (UTF-8 is the default encoding for LaTeX2e since 2018).
367 - Fix behaviour of the use_bibtex_ setting.
368 - Outsource parts of `depart_document()` to new auxiliary methods
369 `make_title()` and `append_bibliography()`.
370 - Ensure POSIX paths in stylesheet loading macros.
372 * docutils/writers/latex2e/titlepage.tex
374 - Drop ``\usepackage{fixltx2e}`` from template.
375 (Obsolete since 2015 and dropped from other templates in Docutils 0.14.)
377 * docutils/writers/manpage.py
379 - Do not output empty "manual" in ``.TH``.
381 * docutils/writers/xetex/__init__.py
383 - Ignore settings in the [latex2e writer] configuration file section.
384 Place common settings in section [latex writers].
388 - Fix SetuptoolsDeprecationWarning: ``Installing '' as data is deprecated``
389 by adding data directories to package_data.packages list.
393 - Extracted flake8 configuration and moved to ``.flake8``.
394 - changedir to directory ``test`` to avoid path problems.
398 - Refactored tests to use common `unittest` idioms.
399 Fixes errors when running the test suite with ``python -m unittest``
400 or external test frameworks, such as Pytest_.
402 .. _pytest: https://pypi.org/project/pytest/
406 - Removed. Use the coverage.py_ project instead,
407 ``coverage run test/alltests.py`` and ``coverage report``.
409 .. _coverage.py: https://pypi.org/project/coverage/
413 - Moved ``quicktest.py`` to ``tools/dev/``.
416 Release 0.19 (2022-07-05)
417 =========================
421 - Dropped support for Python 2.7, 3.5, and 3.6. and removed compatibility
422 hacks from code and tests.
424 check PEP 8 conformity with `flake8` (exceptions in file tox.ini).
426 * docutils/__main__.py
428 - New module. Support for ``python -m docutils``.
429 Also used for the ``docutils`` console script `entry point`_.
433 - Let `Publisher.publish()` print info and prompt when waiting for input
434 from a terminal (cf. https://clig.dev/#interactivity).
435 - Respect `input_encoding_error_handler`_ setting when opening a source.
439 - New function `error_string()`
440 obsoletes `utils.error_reporting.ErrorString`.
441 - Class `ErrorOutput` moved here from `utils.error_reporting` module.
442 - Use "utf-8-sig" instead of Python's default encoding if the
443 `input_encoding`_ setting is None.
444 - Fix error when reading of UTF-16 encoded source without trailing newline.
445 - Suppress deprecation warning (fixes bug #464).
447 * docutils/parsers/__init__.py
449 - Aliases "markdown" and "commonmark" point to "commonmark_wrapper".
450 - Alias for the "myst" parser (https://pypi.org/project/myst-docutils).
451 - Use absolute module names in `_parser_aliases` instead of two
452 import attempts. (Keeps details if the `recommonmark_wrapper` module
453 raises an `ImportError`.)
454 - Prepend parser name to `ImportError` if importing a parser class fails.
456 * docutils/parsers/commonmark_wrapper.py
458 - New module for parsing CommonMark input. Selects a locally installed
459 3rd-party parser (`pycmark`, `myst`, or `recommonmark`).
461 * docutils/parsers/recommonmark_wrapper.py
463 - Raise `ImportError`, if import of the upstream parser module fails.
464 If called from an `"include" directive`_,
465 the system-message now has source/line info.
466 - Adapt to and test with `recommonmark` versions 0.6.0 and 0.7.1.
468 .. _"include" directive: docs/ref/rst/directives.html#include
470 * docutils/parsers/rst/__init__.py
472 - Update PEP base URL (fixes bug #445),
473 use "https:" scheme in RFC base URL.
474 - Add `reporter` to `Directive` class attributes.
476 * docutils/parsers/rst/directives/__init__.py
478 - `parser_name()` keeps details if converting `ImportError` to `ValueError`.
480 * docutils/parsers/rst/roles.py
482 - Don't use mutable default values for function arguments. Fixes bug #430.
484 * docutils/transforms/universal.py
486 - Fix bug #435: invalid references in `problematic` nodes
489 * docutils/utils/__init__.py
491 - `decode_path()` returns `str` instance instead of `nodes.reprunicode`.
493 * docutils/utils/error_reporting.py
495 - Add deprecation warning.
497 * docutils/writers/_html_base.py
499 - Add "html writers" to `config_section_dependencies`. Fixes bug #443.
500 - Write table column widths with 3 digits precision. Fixes bug #444.
502 * docutils/writers/html5_polyglot/__init__.py
504 - Add space before "charset" meta tag closing sequence.
505 - Remove class value "controls" from an `image` node with video content
506 after converting it to a "control" attribute of the <video> tag.
507 - Wrap groups of footnotes in an ``<aside>`` for easier styling.
509 * docutils/writers/pep_html/
511 - Use "https:" scheme in "python_home" URL default.
512 - Fix links in template.txt.
516 - New ``docutils``" console script `entry point`_. Fixes bug #447.
520 - Always encode the log file ``alltests.out`` using "utf-8".
522 * test/DocutilsTestSupport.py
524 - `exception_data()` now returns None if no exception was raised.
525 - `recommonmark_wrapper` only imported if upstream parser is present.
527 * test/test_parsers/test_rst/test_directives/test_tables.py
529 - Fix bug #436: Null char valid in CSV since Python 3.11.
531 * tools/docutils-cli.py
533 - Allow 3rd-party drop-in components for reader and parser, too.
535 - Actual code moved to docutils.__main__.py.
537 * tools/rst2odt_prepstyles.py
539 - Options ``-h`` and ``--help`` print short usage message.
543 https://packaging.python.org/en/latest/specifications/entry-points/
546 Release 0.18.1 (2021-11-23)
547 ===========================
551 - `Node.traverse()` returns a list again to restore backwards
552 compatibility. Fixes bug #431.
554 - New method `Node.findall()`: like `Node.traverse()` but returns an
555 iterator. Obsoletes `Node.traverse()`.
557 * docutils/utils/__init__.py
559 - Fix behaviour of `get_stylesheet_list()`: do not look up stylesheets
560 given as `stylesheet`_ setting. Cf. bug #434.
562 * docutils/writers/_html_base.py
564 - Fix handling of ``footnote_backlinks == False`` (report Alan G Isaac).
566 * docutils/writers/html5_polyglot/math.css
568 - Fix typo (bug #432).
570 * docutils/writers/odf_odt/__init__.py
572 - Fix spurious output with Windows (bug #350).
574 * test/test_error_reporting.py
576 - Fix a false positive (bug #434).
579 Release 0.18 (2021-10-26)
580 =========================
582 * docutils/frontend.py
583 - Mark as provisional (will switch from using `optparse` to `argparse`).
584 - Remove hack for the now obsolete "mod_python" Apache module.
585 - New function `get_default_settings()`.
589 - Don't change a list while looping over it (in
590 `document.set_name_id_map()`). Thanks to Mickey Endito.
592 * docutils/parsers/recommonmark_wrapper.py
594 - Test and update to work with `recommonmark` version 0.6.0.
597 Unfortunately, recommonmark_ is `no longer maintained`__.
599 __ https://github.com/readthedocs/recommonmark/issues/221
601 * docutils/parsers/rst/directives/misc.py
603 - Fix bug #424 Wrong circular inclusion detection.
604 Use a "magic" comment instead of line numbers
605 to keep a log of recursive inclusions.
607 * docutils/parsers/rst/states.py
609 - Use a "magic" comment to update the log of recursive inclusions.
611 * docutils/writers/html5_polyglot/__init__.py
613 - New option `image_loading`_. Support "lazy" loading of images.
614 Obsoletes `embed_images`_.
616 * docutils/writers/pseudoxml.py
618 - Fix spelling of setting `detailed`_.
620 * tools/docutils-cli.py
622 - Read settings from standard configuration files.
624 Fix spelling errors in documentation and docstrings.
625 Thanks to Dimitri Papadopoulos.
628 Release 0.18b1 (2021-10-05)
629 ===========================
631 * docs/ref/docutils.dtd
633 - New document tree element <meta>.
635 * docutils/frontend.py
637 - The default value for the `auto_id_prefix`_ setting changed to "%":
638 auto-generated IDs use the tag name as prefix.
642 - Make `\<meta>`_ a standard Docutils doctree node. Writers may ignore
643 <meta> nodes if they are not supported by the output format.
645 - document.make_id(): Do not strip leading number and hyphen characters
646 from `name` if the `id_prefix`_ setting is non-empty.
648 - `Node.traverse()` returns an iterator instead of a list.
650 * docutils/parsers/rst/directives/html.py
652 - Removed. (Meta directive moved to ``misc.py``.)
654 * docutils/parsers/rst/directives/misc.py
656 - `Meta` directive class (moved from html.py) inserts `meta`
657 (instead of `pending`) nodes.
659 - Add `class` option to `Raw` directive.
661 * docutils/parsers/rst/directives/tables.py
663 - Unify behaviour of `"widths" option`_: check that the length of an
664 integer list equals the number of table columns also for the "table"
667 * docutils/tools/math/math2html.py,
668 docutils/tools/math/tex2unicode.py,
669 docutils/writers/html5/math.css
671 - Fork from elyxer and remove code that is not required
673 - Scale variable sized operators and big delimiters with CSS
674 - Support more commands, fix mapping of commands to Unicode characters
675 (cf. `LaTeX syntax for mathematics`_).
676 - Fix bug #244 Wrong subscript/superscript order.
677 - Don't use <tt> element (deprecated in HTML5).
678 - Use STIX fonts if available.
680 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
682 * docutils/parsers/rst/states.py
684 - Fix source location (line number) for attribution elements.
685 Patch by Mickey Endito.
686 - Add line, source, and rawsource internal attributes for blockquote
687 elements. Patch by Mickey Endito.
689 * docutils/transforms/references.py
691 - Skip system_messages when propagating targets. Fixes bug #425.
693 * docutils/utils/__init__.py
695 - Removed `unique_combinations()` (obsoleted by `itertools.combinations()`).
697 * docutils/utils/latex2mathml.py
699 - Major update (fixes and support for additional commands and symbols).
702 * docutils/writers/_html_base.py
704 - Write footnote brackets and field term colons to HTML, so that
705 they are present also without CSS and when copying text.
706 Adapt ``minimal.css``.
708 - Use semantic tags <aside> for footnote text, topics, admonitions,
709 and system-messages and <nav> for the table of contents. Use <div>
712 - Only specify table column widths, if the `"widths" option`_ is set
713 and is not "auto" (fixes bug #426).
714 The `table_style`_ setting "colwidths-grid" restores the current default.
716 .. _"widths" option: docs/ref/rst/directives.html#column-widths
718 - Use ARIA roles to enable accessible HTML for abstract, dedication,
719 the table of contents, footnote, references, footnotes, citations,
722 - Use "aria-level" attribute instead of invalid tags <h7>, <h8>, ...
723 for headings of deeply nested sections.
725 - Do not set classes "compound-first", "compound-middle", or
726 "compound-last" to elements nested in a compound.
727 Use class value "backrefs" instead of "fn-backref" for a span of
730 - Do not write class values handled by the HTML writer ("colwidths-auto",
731 "colwidths-given", "colwidths-grid") to the output.
733 - Move space character between section number and heading into
736 - Removed attribute `HTMLTranslator.topic_classes`
738 - Items of a definition list with class argument "details" are
739 converted to <details> disclosure elements.
741 * docutils/writers/html4css1/__init__.py
743 - Overwrite methods in _html_base.HTMLTranslator that use HTML5 tags
744 (details, aside, nav, ...) and attributes (role, aria-level).
746 * docutils/writers/latex2e/__init__.py
748 - The setting `legacy_class_functions`_ now defaults to "False".
749 Adapt stylesheets modifying ``\DUadmonition`` and/or ``\DUtitle``.
751 - Apply patch #181 "Fix tocdepth when chapter/part in use" by
752 John Thorvald Wodder II.
754 - Fix newlines after/before `ids_to_labels()` (cf. patch #183).
756 - Refactor/revise ToC writing.
758 - Don't add ``\phantomsection`` to labels in math-blocks.
760 - Improve spacing and allow customization of Docutils-generated table
763 - New algorithm for table column widths. Fixes bug #422.
764 New configuration setting `legacy_column_widths`_.
766 `Table.set_table_style()` arguments changed.
768 Only write "continued on next page..." if it fits
769 without making the table columns wider.
771 Table "width" option overrides conflicting "auto" column "widths".
773 * docutils/writers/latex2e/docutils.sty
775 - Fix excessive padding above sidebar titles.
777 * docutils/writers/pseudoxml.py
779 - Fix option `detailed`_ under Python 2.7.
781 * docutils/writers/s5_html/themes/default
783 - Remove IE 6 compatibility workarounds ``iepngfix.htc`` and
784 ``blank.gif`` (fixes bug #169).
786 * docutils/writers/manpage.py
788 - Fix: double quotes need to be escaped on macro invocation.
792 Release 0.17.1 (2021-04-16)
793 ===========================
795 * docutils/utils/math/latex2mathml.py
797 - Fix bug #406 (MathML translation of ``\mathbf``).
799 * docutils/writers/latex2e/__init__.py
801 - Open ``docutils.sty`` with encoding set to "utf-8".
802 Fixes bug #414: error with Py3k when locale encoding is "ascii".
804 * docutils/parsers/*.py, docutils/transforms/*.py
806 - Provide fallbacks for parser config settings
807 to facilitate programmatic use.
809 * docutils/writers/manpage.py
811 - Apply patch #166: move macro defs above ``.TH``
812 (thanks Willie and sorry for the delay).
815 Release 0.17 (2021-04-03)
816 =========================
820 - Installing with ``setup.py`` now requires `setuptools`.
821 Alternatively, install with `pip`_ (or "manually").
822 - Use `importlib.import_module()` to programmatically import modules.
823 - Fix bug #385: Import of language modules.
825 .. _pip: https://pypi.org/project/pip/
827 * docs/ref/docutils.dtd
829 - The "title" attribute of <sidebar> elements is now optional.
831 * docutils/MANIFEST.in
833 - Exclude test outputs.
835 * docutils/__init__.py
837 - VersionInfo: `ValueError` for invalid values, fix comparison to tuples.
839 * docutils/languages/
840 docutils/parsers/rst/languages/
842 - Apply patch # 177 Arabic mappings by Shahin.
843 - Apply patch for bug #399 Fixes in Korean translation by Shinjo Park.
847 - Apply patch #165 "Fix error when copying `system_message` node"
849 - Apply version of patch #167 "Let `document.set_id()` register all
850 existing IDs". Thanks to Takeshi KOMIYA.
851 - Fix bug #410: Use a "property" function to recursively fetch
852 `Node.document` value from parent node.
854 * docutils/parsers/recommonmark_wrapper.py
856 - New, **experimental** wrapper to integrate the
857 `recommonmark`_ Markdown parser for use with Docutils.
858 Currently only tested with `recommonmark` version 0.4.0.
860 .. _recommonmark: https://pypi.org/project/recommonmark/
862 * docutils/parsers/rst/directives/body.py
864 - Make the sidebar's "title" argument optional (feature request #69).
866 * docutils/parsers/rst/directives/html.py
868 - Make `meta` elements available for "latex" and "odt" writers.
870 * docutils/parsers/rst/directives/misc.py
872 - Prevent infinite inclusion loops.
874 * docutils/parsers/rst/roles.py
876 - Apply patch #174 "Lowercase new role names on registration"
877 by John Thorvald Wodder II.
879 * docutils/utils/smartquotes.py
881 - Fix bug #383: Smart quotes around opening and separator characters.
883 * docutils/transforms/components.py
885 - Allow a comma-separated list of formats for the Filter transform.
887 * docutils/writers/html*
889 - Implement feature request #40 "Option to embed images as data URI".
891 * docutils/writers/html5_polyglot/__init__.py
893 - Use the new semantic tags <main>, <section>, <header>,
894 <footer>, <aside>, <figure>, and <figcaption>.
895 See ``minimal.css`` and ``plain.css`` for styling rule examples.
897 Change the `initial_header_level`_ setting default to "2", as browsers
898 use the `same style for <h1> and <h2> when nested in a <section\>`__.
900 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
902 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
903 <i>, <b>, <u>, <mark>, and <bdi> if a unique, matching class value
904 is found in `\<inline>`_ and `\<literal>`_ elements.
905 Use <ins> and <del> if a unique matching class value
906 is found in `inline`, `literal`, or `container` elements.
907 Use <small> for generated code line numbers.
909 - Fix bug #398: properly close link tag to "schema.dcterms".
911 - Add a `viewport meta tag`__ to fix rendering in mobile browsers.
913 __ https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag
915 - Use <video> for images with video MIME types supported by HTML5.
917 * docutils/writers/html5_polyglot/minimal.css
919 - Move non-essential styling to ``plain.css``.
920 Small fixes and tweaks.
922 - Support "captionbelow" class value for tables.
924 - Display code line numbers as pseudo-elements which are skipped
925 when copying text from code blocks. Solves feature request #32.
927 * docutils/writers/html5_polyglot/plain.css
929 - Support numbered figures.
931 * docutils/writers/html5_polyglot/responsive.css
933 - New optional style that adapts to different screen sizes.
935 * docutils/writers/latex2e/__init__.py
937 - Use LaTeX environments for admonitions and "class wrappers" for styling
938 admonitions and titles if the new configuration setting
939 `legacy_class_functions`_ is False.
941 - Remove backwards compatibility code for the deprecated
942 `styling command`__ prefix ``\docutilsrole``.
944 __ docs/user/latex.html#custom-interpreted-text-roles
946 - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
948 - Support the `memoir` LaTeX document class.
949 Fixes bugs #390, #391, and #392. Thanks to John Thorvald Wodder II.
951 - The special value "auto" for the `graphicx_option`_ setting
952 is no longer supported (it never worked for xetex/luatex).
954 - Most helper commands and element definitions are now defined in the
955 LaTeX package `docutils.sty`_ and only inserted in the document
956 preamble if the `stylesheet`__ setting does not list "docutils".
958 .. _docutils.sty: https://ctan.org/pkg/docutils
959 __ docs/user/config.html#stylesheet-latex-writers
961 - Apply patch #173 "Make \*TeX writers convert nonstandard table
962 classes to DUclass environments" by John Thorvald Wodder II.
964 - Fix bug #408 "Incorrect assert in latex writer
965 for multiple citation references".
967 - Apply patch #175 "Fix alignment of nested tables"
968 by John Thorvald Wodder II. Additional fixes to table alignment.
970 - Do not write Docutils-generated ToC, when ``use_latex_toc == True``.
971 (This did happen when publishing from a doctree.)
973 - Set PDF document properties from "meta" directive content.
975 - Apply version of patch #176 "LaTeX writer: Append ``\leavevmode`` to
976 non-docinfo field names" by John Thorvald Wodder II.
978 * docutils/writers/manpage.py
980 - Fix #394 fix missing new line after rubric.
981 - Patch #168 fix crashing on empty citation (by Takeshi KOMIYA).
982 - Fix #126 manpage title with spaces.
983 - Fix #380 command line option problem in sphinx.
985 * docutils/writers/odf_odt/__init__.py
987 - Fix/improve metadata handling:
988 fix "keyword" splitting,
989 allow generic fields (stored as "Custom Properties").
991 * docutils/writers/pseudoxml.py
993 - New option `detailled`_.
995 * test/DocutilsTestSupport.py
997 - Run python3 test like python2 against source not the build/-directory
999 * tools/docutils-cli.py
1001 - New generic command line front end that allows the free selection of
1002 reader, parser, and writer components.
1005 Release 0.16 (2020-01-16)
1006 =========================
1010 - Dropped support for Python 2.6, 3.3 and 3.4
1011 - Docutils now supports Python 2.7 and Python 3.5+ natively
1012 (without conversion by `2to3`).
1013 - Keep `backslash escapes`__ in the document tree. Backslash characters in
1014 text are be represented by NULL characters in the `text` attribute of
1015 Doctree nodes and removed in the writing stage by the node's
1018 __ https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism
1020 * docs/ref/docutils.dtd
1022 - Use "parameter entities" for `class names`, `reference names`,
1027 - Remove the `handle_io_errors` option from io.FileInput/Output.
1031 - Speed up Node.next_node().
1032 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
1033 - Warn about `Node.traverse()` returning an iterator instead of a list
1036 * docutils/statemachine.py
1038 - Patch [ 158 ] Speed up patterns by saving compiled versions (eric89gxl)
1040 * docutils/transforms/universal.py
1042 - Fix [ 332 ] Standard backslash escape for smartquotes.
1043 - Fix [ 342 ] No escape in roles descending from `inline literal`.
1045 * docutils/utils/__init__.py
1047 - `unescape()` definition moved to `nodes` to avoid circular import
1048 dependency. Fixes [ 366 ].
1050 * docutils/writers/latex2e/__init__.py
1052 - Fix topic subtitle.
1053 - Make "rubric" bold-italic and left aligned.
1054 - Fix [ 339 ] don't use "alltt" or literal-block-environment
1055 in admonitions and footnotes.
1056 - Deprecation warning for ``\docutilsrole``-prefixed styling commands.
1057 - Add "latex writers" to the `config_section_dependencies`.
1058 - Ignore classes for `rubric` elements
1059 (class wrapper interferes with LaTeX formatting).
1061 * docutils/writers/manpage.py
1063 - Apply fix for [ 287 ] comma after option is bold.
1064 - Apply fix for [ 289 ], line starting with ``.`` in a text.
1066 * docutils/writers/odf_odt/__init__.py
1068 - Fix: ElementTree.getchildren deprecated warning
1070 * docutils/writers/xetex/__init__.py
1072 - Add "latex writers" to the `config_section_dependencies`.
1076 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1077 Close alltests.out with atexit.
1081 - Fix [ 377 ] ResourceWarning: unclosed file python3.8
1082 Read defaults file with context.
1084 - Set `auto_id_prefix`_ to "%" (expands to tag-names).
1085 Results in descriptive links in HTML and more localized changes when
1086 editions to the input add or remove auto-ids.
1090 - Apply patch #157: avoid test failure because of a `ResourceWarning`.
1092 * test/test_writers/test_odt.py
1094 - Fix [ 359 ] Test suite fails on Python 3.8. odt XML sorting.
1095 Use ElementTree instead of minidom.
1097 * tools/buildhtml.py
1099 - New option `html_writer`_.
1102 Release 0.15.1 (2019-07-24)
1103 ===========================
1105 source: branches/rel-0.15
1107 Fix [ 366 ] circular dependency. Release for Python 2 only.
1110 Release 0.15 (2019-07-20)
1111 =========================
1115 - Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
1116 - Infrastructure automation.
1118 * docs/ref/docutils.dtd
1120 - The <table> element accepts the new attribute "width".
1122 * docs/ref/rst/restructuredtext.txt
1124 - Document rST syntax change: Tokens like ``:this:example:`` are now valid
1125 field list names (instead of ordinary text).
1129 - Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
1130 deprecated. Thanks to hugovk.
1132 * docutils/languages/ko.py, docutils/parsers/rst/languages/ko.py
1134 - Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
1138 - Fix [ 251 ] `system_message.copy()` `TypeError`.
1139 - `Element.copy()` also copies `document`, `line`, and `source` attributes.
1141 * docutils/parsers/rst/__init__.py
1143 - Apply [ 152 ] reset `default role` at end of document.
1145 * docutils/parsers/rst/states.py
1147 - Allow embedded colons in field list field names.
1149 * docutils/parsers/rst/directives/html.py
1151 - Fix bug #281: Remove escaping backslashes in meta directive content.
1153 * docutils/parsers/rst/directives/misc.py
1155 - Don't convert tabs to spaces, if `tab_width` is negative in
1156 "include" directive with "code" option.
1158 * docutils/parsers/rst/directives/tables.py
1160 - Apply patch #121: Add "width" option for the table directives.
1162 * docutils/transforms/frontmatter.py
1164 - Add field name as class argument to generic docinfo fields unconditionally.
1166 * docutils/transforms/references.py
1168 - Fix bug #331: fixed the "trim" options of the "unicode" directive.
1170 * docutils/utils/__init__.py
1172 - Deprecate `unique_combination()` (obsoleted by `itertools.combination()`.
1174 * docutils/utils/smartquotes.py
1176 - Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
1178 * docutils/writers/html5_polyglot/
1180 - automatically add HTML5-compatible meta tags for docinfo items
1181 "authors", "date", and "copyright".
1183 * docutils/writers/_html_base.py
1185 - Fix bug #358: Non-breaking space removed from fixed-width literal.
1187 * docutils/writers/latex2e/__init__.py
1189 - Fix bug #323: spurious ``\phantomsection`` and whitespace in
1191 - Fix bug #324: Invalid LaTeX for table with empty multi-column cell.
1192 - Fixes to literal block handling.
1195 Release 0.14 (2017-08-03)
1196 =========================
1198 * docs/ref/docutils.dtd
1200 - Enable validation of Docutils XML documents against the DTD:
1202 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
1203 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
1204 however, the `ids` attribute cannot use the ID type because `XML only
1205 allows one ID per Element Type`__ and doesn't support a multiple-ID
1206 "IDS" attribute type.
1208 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
1210 * docs/ref/rst/restructuredtext.txt
1212 - Added documentation for escaped whitespace in URI contexts.
1213 - Clarify use of Unicode character categories.
1215 * docutils/parsers/rst/states.py
1217 - Added functionality: escaped whitespace in URI contexts.
1218 - Consistent handling of all whitespace characters in inline markup
1219 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
1221 * docutils/parsers/rst/directives/images.py
1223 - Added support for escaped whitespace in URI contexts.
1225 * docutils/parsers/rst/directives/tables.py
1227 - Rework patch [ 120 ] (revert change to Table.get_column_widths()
1228 that led to problems in an application with a custom table directive).
1230 * docutils/transforms/frontmatter.py
1232 - Fix [ 320 ] Russian docinfo fields not recognized.
1234 * docutils/transforms/references.py
1236 - Don't add a second ID to problematic references.
1238 * docutils/transforms/universal.py
1240 Fix `SmartQuotes`: warn only once if language is unsupported,
1241 keep "rawsource" when "educating" quotes.
1243 * docutils/utils/__init__.py
1245 - Added `split_escaped_whitespac()` function, support for escaped
1246 whitespace in URI contexts.
1248 * docutils/utils/error_reporting.py
1250 - Fix [ 321 ] Import block might cause name error.
1252 * docutils/utils/smartquotes.py
1254 - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
1255 - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
1256 - Fix [ 313 ] Differentiate apostrophe from closing single quote
1258 - Fix [ 317 ] Extra space inserted with French smartquotes.
1259 - Add command line interface for stand-alone use (requires 2.7).
1261 * docutils/writers/_html_base.py
1263 - Provide default title in metadata (required by HTML5).
1264 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
1265 - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
1266 reasons, we don't use a third party public installation as default but
1267 warn if `math_output`_ is set to MathJax without specifying a URL.
1269 * docutils/writers/html4css1/__init__.py
1271 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
1273 * docutils/writers/latex2e/__init__.py
1275 - Handle class arguments for block-level elements by wrapping them
1276 in a "DUclass" environment. This replaces the special handling for
1277 `epigraph` and `topic` elements.
1279 * docutils/writers/manpage.py
1281 - Apply [ 141 ] Handling inline in manpage writer.
1283 * docutils/writers/odf_odt/__init__.py
1285 - Command line setting `language`_ now sets the default language of the
1286 generated ODF document.
1287 - The use of image directive options :width: (%), :scale:, etc now
1288 set the width/height/size of images in the generated ODF
1290 - The heading/title of admonitions now reflects the language
1291 specified by the `language`_ setting.
1292 - Fixed [ 306 ] only first of multiple "image" directives with the same URL
1294 - Fixed [ 282 ] python3: `AttributeError`.
1296 * tools/rst2html4.py: New front-end.
1298 * tools/dev/generate_punctuation_chars.py: New script
1299 to test and update utils.punctuation_chars.
1302 Release 0.13.1 (2016-12-09)
1303 ===========================
1305 * docs/ref/docutils.dtd
1307 - Add the document tree elements <math> and <math_block> (already in use).
1309 * docutils/languages/fa.py
1310 docutils/parsers/rst/languages/fa.py
1311 docutils/languages/la.py
1312 docutils/parsers/rst/languages/la.py:
1314 - Apply [ 133 ] Persian mappings by Shahin Azad.
1315 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
1319 - Fix [ 253 ] Attribute key without value not allowed in XML.
1323 - Apply [ 103 ] Recognize inline markups without word boundaries.
1324 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
1326 * docutils/parsers/rst/__init__.py
1328 - Fix [ 233 ] Change the base URL for the :rfc: role.
1330 * docutils/parsers/rst/directives/tables.py
1332 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
1335 - Implement feature request [ 48 ]
1336 Add :align: option to the table directives.
1337 Thanks to Takeshi KOMIYA for the patch.
1339 * docutils/parsers/rst/roles.py
1341 - Fix [ 295 ] Class argument for custom role inheriting from math.
1343 * docutils/parsers/rst/tableparser.py
1345 - Really fix [ 159 ] Spurious table column alignment errors.
1347 * docutils/transforms/frontmatter.py
1349 - Add name of generic bibliographic fields as a "classes" attribute value
1350 (after conversion to a valid identifier form).
1352 * docutils/utils/error_reporting.py
1354 - Fix [ 130 ] support streams expecting byte-strings in ErrorOutput.
1356 * docutils/utils/math/math2html.py
1358 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
1359 - New upstream version (additional macros, piece-wise integrals and sums).
1361 * docutils/writers/_html_base.py
1363 - New auxiliary module for definitions common to all HTML writers.
1365 * docutils/writers/html5_polyglot/
1367 - New HTML writer generating clean, polyglot_ markup conforming to
1370 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
1371 and recommended layout rules.
1373 * docutils/writers/html4css1/__init__.py
1375 - Add "docutils" to class values for "container" object to address [ 267 ].
1376 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
1377 `default_stylesheet_path` and `default_template_path`.
1378 - Fix [ 266 ] creating labels/class values in description list items.
1379 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
1380 - Fix footnotes with content that does not start with a paragraph.
1381 - Use https in default MathJax URL (report Alan G Isaac).
1382 - Outsourcing of common code to _html_base.py.
1384 * docutils/writers/latex2e/__init__.py
1386 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
1387 admonitions and docinfo.
1389 - Use absolute path for `default_template_path`.
1391 - Removed deprecated options ``--use-latex-footnotes`` and
1392 ``--figure-footnotes``.
1394 - Cleaner LaTeX code for enumerations and literal blocks.
1396 - Use `hyperref` package together with `bookmark` (improved hyperlinking
1397 by the same author).
1399 - Fix [ 286 ] Empty column title cause invalid latex file.
1401 - Fix [ 224 ] Fix rowspan support for tables.
1403 - Let LaTeX determine the column widths in tables with "colwidths-auto".
1404 Not suited for multi-paragraph cells!
1406 * docutils/writers/odf_odt/__init__.py
1408 - remove decode.encode of filename stored in zip.
1410 * docutils/writers/xetex/__init__.py
1412 - LuaLaTex compatibility: do not load `xunicode` package.
1416 - New front-end ``rst2html5.py``.
1420 - Test py26, py27, py33 and py34.
1422 To use, install the `tox` package via pip or easy_install and use
1423 tox from the project root directory.
1425 .. _polyglot: https://www.w3.org/TR/html-polyglot/
1426 .. _HTML 5: https://www.w3.org/TR/html5/
1429 Release 0.12 (2014-07-06)
1430 =========================
1432 * docs/ref/rst/directives.txt
1434 - Update "math" and "csv-table" descriptions.
1436 * docutils/parsers/rst/directives/images.py
1438 - Fix [ 258 ] ``figwidth="image"`` generates unitless width value.
1440 * docutils/parsers/rst/states.py
1442 - Improve error report when a non-ASCII character is specified as
1443 delimiter, quote or escape character under Python 2.
1444 Fixes [ 249 ] and [ 250 ].
1446 * docutils/writers/html4css1/__init__.py
1448 - Don't add newline after inline math.
1449 Thanks to Yury G. Kudryashov for the patch.
1451 * docutils/writers/latex2e/__init__.py
1453 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
1454 - Apply [ 116 ] by Kirill Smelkov. Don't hard code \large for subtitle.
1456 * docutils/writers/odf_odt/__init__.py
1458 - Apply patch by Jakub Wilk to fix bug [ 100 ].
1460 * test/test_error_reporting.py
1462 - Fix [ 223 ] by removing redundant tests we do not have control over.
1464 * test/test_nodes.py
1466 - Apply [ 115 ] respect fixed 2to3 string literal conversion behaviour.
1469 Release 0.11 (2013-07-22)
1470 =========================
1474 - Apply [ 2714873 ] Fix for the overwriting of document attributes.
1475 - Support embedded aliases within hyperlink references.
1476 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
1477 language module) before global search.
1481 - Fix [ 3601607 ] `node.__repr__()` must return `str` instance.
1483 * docutils/parsers/rst/directives/__init__.py
1485 - Fix [ 3606028 ] `assert` is skipped with ``python -O``.
1487 * docutils/parsers/rst/directives/images.py
1489 - Apply [ 3599485 ] node source/line information for sphinx translation.
1491 * docutils/parsers/rst/directives/tables.py
1493 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
1495 * docutils/parsers/rst/states.py
1497 - Fix [ 157 ] Line block parsing doesn't like system message.
1498 - Always import our local copy of roman.py (report Larry Hastings).
1500 * docutils/transforms/references.py
1502 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
1504 * docutils/utils/__init__.py
1506 - Fix [ 3596884 ] exception importing `docutils.io`.
1508 * docutils/writers/html4css1/__init__.py
1510 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
1511 - New setting `stylesheet_dirs`_: Comma-separated list of directories
1512 where stylesheets are found. Used by `stylesheet_path` when expanding
1513 relative path arguments.
1514 - New default for `math_output`_: ``HTML math.css``.
1515 - Avoid repeated class declarations in html4css1 writer
1516 (modified version of patch [ 104 ]).
1519 * docutils/writers/latex2e/__init__.py
1521 - Drop the simple algorithm replacing straight double quotes with
1522 English typographic ones.
1523 Use the `smart_quotes`_ setting to activate this feature.
1524 - Fix literal use of babel shorthands (straight quote, tilde, ...).
1525 - Fix [ 3603246 ] Bug in option ``--graphicx-option=auto``.
1526 - New setting `stylesheet_dirs`__.
1528 __ docs/user/config.html#stylesheet-dirs-latex-writers
1531 * docutils/writers/manpage.py
1533 - Fix [3607063] handle lines starting with a period.
1534 - Fix option separating comma was bold (thanks to Bill Morris).
1537 Release 0.10 (2012-12-16)
1538 =========================
1542 - Dropped support for Python 2.3.
1543 - ``docutils/math``, ``docutils/error_reporting.py``, and
1544 ``docutils/urischemes.py`` moved to the utils package.
1545 - Fix [3541369] Relative __import__ also with Python 3.3.
1546 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
1547 and parsers for Python 2.7 up.
1548 - Fix import of PIL.Image.
1549 - Change default of `syntax_highlight`_ option to "long",
1550 basic syntax highlight styles for LaTeX and HTML.
1554 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
1555 option is ignored and will be removed in a future release.
1556 - Fix Py3k error writing to stdout with encoding differing from default.
1557 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
1559 * docutils/parsers/rst/directives/misc.py
1561 - Fix [ 3546533 ] Unicode error with "date" directive.
1563 * docutils/transforms/universal.py
1565 - SmartQuotes transform for typographic quotes and dashes.
1567 * docutils/utils/__init__.py
1569 - `normalize_language_tag()` now returns `BCP 47`_ conforming tags
1570 with sub-tags separated by ``-``.
1572 * docutils/writers/html4css1/__init__.py
1574 - Use ``<code>`` tag for inline "code",
1575 do not drop nested inline nodes (syntax highlight tokens).
1576 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
1577 - No line break after opening inline math tag.
1579 * docutils/writers/manpage.py
1581 - Apply [ 3527401 ] admonition's don't preserve indentation
1582 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
1584 * docutils/writers/xetex/__init__.py
1586 - Apply [ 3555160 ] ensure order of "otherlanguages".
1587 - Fix section numbering by LaTeX.
1589 * docutils/writers/s5_html/__init__.py
1591 - Fix [ 3556388 ] MathJax does not work with rst2s5.
1593 * docutils/writers/docutils_xml.py
1595 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
1596 - Fix/improve output with `indents`_ setting.
1600 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
1602 * tools/test/test_buildhtml.py
1604 - Fix [ 3521167 ] allow running in any directory.
1605 - Fix [ 3521168 ] allow running with Python 3.
1608 Release 0.9.1 (2012-06-17)
1609 ==========================
1613 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
1614 installed in the PYTHONPATH. Converted tests are now
1615 stored in ``test3/``, tools no longer need conversion.
1617 If you installed one of Docutils versions 0.7 ... 0.9 with
1618 ``setup.py install`` under Python 3, remove the spurious
1619 ``test/`` and ``tools/`` directories in the site library root.
1623 - Make tests independent from the location of the ``test/`` directory.
1624 - Use converted sources (from the ``build/`` directory) for tests under
1629 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
1633 - Fix writing binary data to sys.stdout under Python 3 (allows
1634 ``rst2odt.py`` to be used with output redirection).
1636 * docutils/parsers/rst/directives/misc.py
1638 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
1639 ``locale == C`` and 8-bit char in path argument of `include` directive.
1643 - class `Tee`: catch `UnicodeError` when writing to "ascii" stream or
1644 file under Python 3.
1647 Release 0.9 (2012-05-02)
1648 ========================
1652 - New reStructuredText "code" role and directive and "code" option
1653 of the "include" directive with syntax highlighting by Pygments_.
1654 - Fix parse_option_marker for option arguments containing ``=``.
1655 - Fix [ 2993756 ] import Python Imaging Library's Image module
1656 via ``import PIL`` as starting with PIL 1.2,
1657 "PIL lives in the PIL namespace only" (announcement__).
1659 .. _Pygments: https://pygments.org/
1660 __ https://mail.python.org/pipermail/image-sig/2011-January/006650.html
1664 - Fix [ 2971827 ] and [ 3442827 ]
1665 extras/roman.py moved to docutils/utils/roman.py
1667 * docutils/frontend.py
1669 - Fix [ 3481980 ] Use `os.getcwdu()` in `make_paths_absolute()`.
1673 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
1674 - `mode` argument for FileOutput avoids code replication in
1676 - New exceptions `InputError` and `OutputError` for IO errors in
1677 FileInput/FileOutput.
1681 - No "hard" system exit on file IO errors: catch and report them in
1682 `Publisher.reportException` instead. Allows handling by a calling
1683 application if the configuration setting `traceback`_ is True.
1685 * docutils/utils.py -> docutils/utils/__init__.py
1687 - docutils.utils is now a package (providing a place for sub-modules)
1689 - DependencyList uses io.FileOutput and 'utf-8' encoding to prevent
1690 errors recording non-ASCII filenames (fixes [ 3434355 ]).
1692 - Fix `relative_path()` with source=None and `unicode` target.
1694 * docutils/parsers/rst/states.py
1696 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
1697 characters and "international" quotes around inline markup.
1698 - Use `field_marker` pattern to look for start of a
1699 directive option block (fixes [ 3484857 ]).
1701 * docutils/parsers/rst/tableparser.py
1703 - Fix [ 2926161 ] for simple tables.
1704 (Combining chars in grid tables still contribute to cell width.)
1706 * docutils/writers/latex2e/__init__.py
1708 - Support the `abbreviation` and `acronym` standard roles.
1709 - Record only files required to generate the LaTeX source as dependencies.
1710 - Fix handling of missing stylesheets.
1711 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
1712 when suppressing LaTeX section numbering.
1713 - Use ``\DUtitle`` for unsupported section levels.
1714 - Apply [ 3512791 ] do not compare string literals with "is".
1716 * docutils/writers/xetex/__init__.py
1718 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
1720 * docutils/writers/html4css1/__init__.py
1722 - Change default for `math_output`_ setting to MathJax.
1723 - Fix handling of missing stylesheets.
1725 * docutils/writers/docutils_xml.py
1727 - Use the visitor pattern with `default_visit()`/`default_depart()` methods
1728 instead of minidom to facilitate special handling of selected nodes.
1729 - Support raw XML (inserted as-is inside a <raw></raw> node).
1731 * docutils/writers/manpage.py
1733 - Do not emit comment line with trailing blank. Problematic for VCS.
1736 Release 0.8.1 (2011-08-30)
1737 ==========================
1741 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
1742 and [ 3395920 ] (correct copyright info for rst.el).
1746 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
1748 * docutils/writers/latex2e/__init__.py
1750 - Clean up Babel language setting. Restores Sphinx compatibility.
1753 Release 0.8 (2011-07-07)
1754 ========================
1758 - Handle language codes according to `BCP 47`_.
1759 - If the specified language is not supported by Docutils,
1760 warn and fall back to English.
1761 - Math support: reStructuredText "math" role and directive,
1762 `math` and `math_block` doctree elements.
1763 - Decode command line arguments with the locale's preferred encoding
1764 (to allow, e.g., ``--title=Dornröschen``).
1765 - Orphaned `python` reader and `newlatex2e` writer moved to the sandbox.
1766 - New sub-module `error_reporting`: handle encoding/decoding errors
1767 when reporting exceptions.
1768 - Some additions to the Docutils core are released under the 2-Clause BSD
1769 license, see COPYING_ for details.
1771 .. _BCP 47: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
1772 .. _COPYING: COPYING.html
1776 - Most directives now support a "name" option that attaches a
1779 - Directive content may start on the first line also when the directive
1780 type accepts options.
1782 * docs/dev/policies.txt
1784 - Recommend the 2-Clause BSD license
1785 (http://opensource.org/licenses/BSD-2-Clause)
1786 for code that is kept under the author's copyright.
1788 * tools/buildhtml.py
1790 - Fix ``--local`` switch.
1792 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
1794 * docutils/writers/html4css1/__init__.py
1796 - Set "lang" argument for objects with class argument
1797 "language-<language tag>".
1798 - New setting `math_output`_ with support for HTML, MathML, and LaTeX.
1800 * docutils/writers/latex2e/__init__.py
1802 - Fix [ 3043986 ] `AttributeError` using :local: with table of content.
1803 - Place title data in the document preamble.
1804 - Load `babel` package only if required.
1805 - Update list of supported languages.
1806 - New config setting `hyperref_options`_.
1807 No hard-coded "unicode" hyperref option (clash with xetex).
1808 - Set language for custom roles, paragraphs, block-quotes, and
1809 line-quotes with class argument "language-<language tag>".
1810 - Fix [ 3095603 ] wrong quotes output for Russian and other languages.
1811 - Convert image URI to a local file path.
1812 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
1813 has more than one paragraph (Wolfgang Scherer).
1814 - \leavevmode before longtable only when needed (prevents spurious vspace)
1815 - do not advance table counter for tables without caption
1817 * docutils/writers/xetex/__init__.py
1819 - New writer generating LaTeX code for compiling with ``xelatex``.
1821 A separate writer (inheriting from latex2e) instead of a ``--xetex``
1822 option allows separate config options for XeTeX vs. LaTeX2e.
1824 * docutils/writers/manpage.py
1826 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
1827 - Fix: vertical space cleaning for option group ``.``.
1829 * tools/editors/emacs/rst.el
1831 - Fix [ 3001100 ] does not handle spaces in filenames.
1832 Thanks to Jakub Wilk.
1836 - strip whitespace from stylesheet arguments
1837 - exclude combining chars from column_width()
1838 (partial fix for [ 2926161 ])
1840 * docutils/parsers/rst/directives/misc.py
1842 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
1847 - Do not ``close()`` `sys.stdin`, `sys.stdout`, or `sys.stderr`. Prevents
1848 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
1851 Release 0.7 (2010-07-07)
1852 ========================
1856 - Fix [ 2881769 ] setup configuration.
1857 - Fix [ 2788716 ] reporting problems in included files.
1861 - FileInput opens files as text files with universal newline support
1862 (mode "rU", configurable with the new optional argument "mode").
1866 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
1870 - Fix [ 2923723 ] let `decode_path()` tolerate ``path == None``.
1872 * docutils/writers/html4css1/__init__.py
1874 - Support SVG and SWF images (thanks to Stefan Rank).
1875 - Generate valid XHTML for centred images with targets.
1876 Use CSS classes instead of "align" tags for image alignment.
1878 * docutils/writers/latex2e/__init__.py
1880 - Use `transforms.writer_aux.Admonitions` to "normalize" special
1882 - Use the ``\url`` command for URLs (breaks long URLs instead of
1883 writing into the margin).
1884 - Preserve runs of spaces in `inline literals`__.
1885 - Deprecate `figure_footnotes`_ setting.
1886 - Rename `use_latex_footnotes`_ setting to `docutils_footnotes`_.
1887 - New `latex_preamble`_ setting.
1888 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
1889 - Fix hyperlink targets (labels) for images, figures, and tables.
1890 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
1891 - Apply [ 2961991 ] Call hyperref with unicode option.
1892 - Drop the special `output_encoding`_ default ("latin-1").
1893 The Docutils wide default (usually "UTF-8") is used instead.
1894 - Render inline markup in document title and subtitle.
1895 - Fix numbering depth with LaTeX section numbering.
1896 - Update Unicode -> LaTeX translations.
1897 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
1899 __ docs/ref/restructuredtext.html#inline-literals
1901 * docutils/writers/manpage.py
1903 - Fix: supported attribute (thanks to peter2108).
1904 - Remove trailing blanks in code (keep in sync with mercurial version).
1905 - Titles level 1, that is ``.SH``, always uppercase.
1906 - Apply patch from mg: literal text should be bold in man-pages.
1910 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
1915 - Python 3 support: copy test/ and tools/ to the build-dir
1916 and convert Python sources with 2to3.
1919 Release 0.6 (2009-10-11)
1920 ========================
1924 - Docutils is now compatible with Python versions from 2.3 up to 2.6
1925 and convertible to 3.1 code.
1927 + Node.__nonzero__ returns True instead of 1.
1928 + use os.walk instead os.path.walk.
1929 + minimize `types` module where possible.
1930 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
1931 + Text nodes now subclass unicode rather than UserString
1932 (which is gone in python 3.0).
1933 + 3.0 compatibility module docutils._compat
1935 + Drop 2.2 compatibility workarounds.
1936 + Drop extras/optparse.py and extras/textwrap.py
1937 (stdlib modules since 2.3).
1939 - OpenOffice export: ODT writer moved from sandbox to Docutils core.
1940 - Unix man page export: manpage writer moved from sandbox to Docutils
1943 - Apply [ 1719345 ] Galician translation
1944 - Apply [ 1905741 ] Polish translation
1945 - Apply [ 1878977 ] make_id(): deaccent characters.
1946 - Apply [ 2029251 ] return nonzero when tests fail.
1947 - Fix [ 1692788 ] allow UTF-8 in style sheets.
1948 - Fix [ 2781629 ] support non-ASCII chars in file names.
1949 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
1950 - Fix [ 2831643 ] renaming `DirectiveError.message` to `DirectiveError.msg`
1951 - Fix [ 2821266 ] ``--strict`` option works now like ``--halt=info``.
1952 - Fix [ 2788716 ] `DirectiveError` now correctly reports source and line.
1953 - Fix [ 1627229 ] hyperlink references in substitutions.
1955 - The `newlatex` writer is orphaned.
1959 - Documented Unicode characters allowed as inline markup openers,
1960 closers, and delimiters.
1961 - Allow units for all length specifications.
1962 - Allow percent sign in "scale" argument of "figure" and "image" directives.
1963 - Bugfix: The "figalign" argument of a figure now works as intended
1964 (aligning the figure, not its contents).
1965 - Align images with class "align-[right|center|left]"
1966 (allows setting the alignment of an image in a figure).
1968 * docutils/nodes.py:
1970 - Added `Element.__contains_()` method, for the in-operator.
1972 * docutils/parsers/rst/states.py:
1974 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
1975 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
1976 " " (non-breaking space), and "¡ ¿" openers.
1978 * docutils/parsers/directives/misc.py:
1980 - Added ``start-line`` and ``end-line`` options to "include"
1981 directive to select a range of lines.
1982 - Hard tabs in literal inclusions are replaced by spaces. This is
1983 configurable via the new ``tab-width`` option of the "include" directive
1984 (a negative tab-width prevents tab expansion).
1986 * docutils/utils.py:
1988 - Add `get_stylesheet_lis()` function.
1989 - Apply [ 2834836 ] print info at halt
1991 * docutils/transforms/universal.py:
1993 - Raise default priority of StripClasses to exclude stripped classes from
1996 * docutils/writers/html4css1/__init__.py:
1998 - `stylesheet`_ and `stylesheet_path`_ settings support a comma
1999 separated list of stylesheets.
2000 - Address [ 1938891 ] Inline literal text creates "pre" span only when
2001 needed to prevent inter-word line wraps.
2002 - Use `translate()` method instead of repeated `replace()` calls.
2003 - Fix [ 1757105 ] New `table_style`_ setting. Added to standard table
2004 classes to allow CSS styling that does not interfere with other
2005 table-using constructs (field lists, citations, ...).
2007 * docutils/writers/newlatex2e/__init__.py:
2009 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
2011 * docutils/writers/latex2e/__init__.py:
2013 - Add `embed_stylesheet`_ setting.
2014 - Apply [ 1474017 ] image vertical alignment is reversed.
2015 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
2016 - Change: has_key for dictionaries (not Nodes) to in-operator.
2017 - Merge adjacent citations into one latex cite command.
2018 - Failsafe implementation of custom roles. LaTeX compilation now ignores
2019 unknown classes instead of aborting with an error.
2020 - Support custom roles based on standard roles.
2021 - LaTeX packages can be used as `stylesheet`_ arguments without
2022 restriction. (A style sheet is now referenced with the ``\usepackage``
2023 command, if it ends with ``.sty`` or has no extension.)
2024 - Add ``bp`` to lengths without unit (prevents LaTeX errors).
2025 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
2026 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
2027 2005-02-04 as a configurable length unit).
2028 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
2029 if font-encoding is set to ''. LaTeX defaults to OT1 then.
2030 - Set sub- and superscript role argument in text mode not as math.
2031 Use a custom role based on sub-/superscript if you want italic shape.
2032 - Shorter preamble and less dependencies: Load packages and define macros
2033 only if required in the document.
2034 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
2035 - New custom environments and commands with optional "classes" argument.
2036 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
2037 - Better conformance to Docutils specifications with `use_latex_toc`_.
2038 Support for LaTeX generated ToC also with unnumbered sections.
2039 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
2040 section numbering by LaTeX.
2041 - Use default font in admonitions and sidebar.
2042 - Align of image in a figure defaults to 'center'.
2043 - Bugfix: Newlines around targets and references prevent run-together
2045 - Fix internal hyperlinks.
2046 - Use class defaults for page margins ('typearea' now optional).
2047 - Float placement made configurable, default changed to "here definitely".
2048 - Typeset generic topic as "quote block with title".
2049 - Use template (file and configuration option).
2050 - In the default template, load cmap.sty (fix text extraction in PDF) and
2051 fixltx2e.sty (LaTeX patches, \textsubscript).
2052 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
2053 - Use `translate()` instead of repeated `replace()` calls for text encoding.
2054 - Hyperlinked footnotes and support for symbol footnotes and
2055 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
2056 - Complete pairs of binary options
2057 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
2058 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
2060 - font-encoding: "T1" (formerly implicitly set by 'ae').
2061 - use-latex-toc: true (ToC with page numbers).
2062 - use-latex-footnotes: true (no mixup with figures).
2064 * docutils/writers/manpage.py
2066 - Do not print version at document end, this is done by the viewer.
2067 - Do not print date at document end, this is done by the viewer.
2068 - Fix storage of docinfo fields for none standard fields.
2070 * docutils/tools/rst2man.py
2073 Release 0.5 (2008-06-25)
2074 ========================
2076 * docutils/languages/he.py: Added to project: Hebrew mappings by
2079 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
2080 mappings by Meir Kriheli.
2082 * docutils/frontend.py:
2084 - Configuration files are now assumed and required to be
2086 - Paths of applied configuration files are now recorded in the
2087 runtime setting `_config_files`_ (accessible via `dump_settings`_).
2088 - Added `strip_elements_with_classes`_ and `strip_classes`_ settings.
2092 - Added code to determine the input encoding from data: encoding
2093 declarations or the presence of byte order marks (UTF-8 & UTF-16).
2094 - Added support for IronPython 1.0.
2096 * docutils/nodes.py:
2098 - Added `document.__getstate_()` method, for pickling.
2100 * docutils/parsers/rst/states.py:
2102 - Allow ``+`` and ``:`` in reference names.
2103 - Unquoted targets beginning with an underscore (``.. __target:
2104 URI``) are no longer accepted.
2105 - Added support for multiple attributions in a physical block quote
2106 (indented text block), dividing it into multiple logical block
2108 - Added support for unicode bullets in bullet lists: "•", "‣", and
2110 - Added support for new object-oriented directive interface,
2111 retaining compatibility to the old functional interface.
2112 - Added support for throwing `DirectiveError`'s from within
2115 * docutils/parsers/rst/__init__.py:
2117 - Added `Directive` base class.
2118 - Added `DirectiveError` base class.
2119 - Fixed `file_insertion_enabled`_ & `raw_enabled`_ setting
2122 * docutils/parsers/directives/:
2124 - Refactored all reStructuredText directives to use the new
2125 object-oriented directive interface. Errors are now (mostly)
2126 thrown using the new `DirectiveError` class.
2128 * docutils/parsers/directives/misc.py:
2130 - Added ``start-after`` and ``end-before`` options to ``include``
2131 directive; thanks to Stefan Rank.
2133 * docutils/transforms/universal.py:
2135 - Added `StripClassesAndElements` transform to remove from the
2136 document tree all elements with classes in
2137 `strip_elements_with_classes`_ and all "classes"
2138 attribute values in `strip_classes`_
2140 * docutils/transforms/writer_aux.py:
2142 - Added `Admonitions` transform to transform specific admonitions
2143 (like "note", "warning", etc.) into generic admonitions with a
2146 * docutils/writers/html4css1/__init__.py:
2148 - Moved template functionality from the PEP/HTML writer here.
2149 - Expanded the fragments available in the ``parts`` attribute.
2150 - Moved ``id`` attributes from titles to surrounding ``div``
2152 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
2153 universally supported now).
2154 - ``template.txt`` is now opened in text mode instead of binary mode
2155 (to ensure Windows compatibility).
2156 - ``a`` elements now have an "internal" or "external" class,
2157 depending on reference type.
2159 * docutils/writers/html4css1/template.txt: Added to project.
2161 * docutils/writers/pep_html/:
2163 - Moved template functionality to the HTML writer.
2165 * docutils/writers/s5_html/__init__.py:
2167 - Added `view_mode`_ & `hidden_controls`_ settings.
2169 * docutils/writers/latex2e/__init__.py:
2171 - Add `literal_block_env`_.
2172 - Fix: escaping ``%`` in href urls.
2173 - Move usepackage hyperref after stylesheet inclusion.
2174 - Fix: scrartcl does not have chapter but scrreprt.
2175 - Add newline after ``\end{verbatim}``.
2176 - Merge smaller differences from latex2e_adaptive_preamble.
2177 - Add ``use-part-section``.
2178 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
2179 - Using leavemode option_list no longer needs to check if parent
2180 is a definition list.
2181 - Append ``\leavemode`` to definition list terms.
2182 - No longer write visit\_/depart_definition_list_item comments to
2184 - Table column width with 3 decimal places.
2185 - Add table stubs support (boldfont).
2186 - Add assemble_parts to writer.
2187 - Add simply support for nested tables.
2188 - Fix verbatim in tables if use-verbatim-when-possible.
2189 - Use section commands down to subparagraph.
2190 - Put ensuremath around some latin1 chars.
2191 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
2192 - New experimental setting `use_bibtex`_.
2193 - New setting `reference_label`_ to allow usage of LaTeX ref for
2194 labels in section references.
2195 - Add a label after every section to support sectionnumbers as reference
2197 - Fix: bug# 1605376 rst2latex: bad options group list
2198 - Remove inactive code for use_optionlist_for_option_list.
2199 - Remove latex comments from option_list output.
2200 - Fix: bug# 1612270 double quotes in italian literal.
2201 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
2202 - Add setting `use_latex_abstract`_.
2203 - Image width unit ``px`` is translated to ``pt``.
2204 - Add image height support.
2205 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
2207 - Fix: Do not escape underscores in citation reference labels if
2208 use-latex-citations is set.
2209 - Use centering instead of center for figure contents, to avoid vertical
2211 - Recognize table class: borderless, nolines, booktabs, standard.
2212 - Fix: Renaming contents section does not work with latex writer; SF
2214 - Applied patch for custom roles with classes from Edward Loper.
2215 - Fixed bug that caused crashes with more than 256 lists.
2217 * docutils/writers/pep_html/__init__.py:
2219 - Changed to support new python.org website structure and
2222 * docs/howto/security.txt: "Deploying Docutils Securely", added to
2225 * tools/buildhtml.py:
2227 - Add `ignore`_ setting to exclude a list of shell patterns
2228 (default: ``.svn:CVS``).
2230 * tools/editors/emacs/rst.el:
2232 - Changed license to "GPL".
2233 - Added ``rst-straighten-decorations`` function.
2234 - The ``compile`` module is now always loaded.
2235 - Added ``rst-toggle-line-block`` function.
2236 - Headings consisting only of non-ASCII characters are now
2237 recognized by ``rst-toc`` and ``rst-adjust``.
2238 - Added font-lock support for multi-line comments where the first
2239 comment line is empty.
2240 - Added ``(require 'font-lock)``.
2244 - Provide descriptive error message if distutils is missing.
2247 Release 0.4 (2006-01-09)
2248 ========================
2252 - Updated the project policies for trunk/branch development &
2255 * docutils/__init__.py:
2257 - Added ``__version_details__`` attribute to describe code source
2258 (repository/snapshot/release).
2259 - Replaced ``default_transforms`` attribute of ``TransformSpec`` with
2260 ``get_transforms()`` method.
2264 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
2265 functions, for document tree extraction and reprocessing.
2269 - Added ``DocTreeInput`` class, for reprocessing existing documents.
2270 - Added support for non-Unicode (e.g. binary) writer output.
2272 * docutils/nodes.py:
2274 - Re-introduced ``Targetable.indirect_reference_name``, for
2275 MoinMoin/reST compatibility (removed in r3124/r3129).
2276 - Added ``serial_escape`` function; escapes string values that are
2277 elements of a list, for serialization. Modified Docutils-XML
2278 writing (``Element._dom_node``) and pseudo-XML writing
2279 (``Element.starttag``) to use ``serial_escape``.
2280 - Added ``Node.deepcopy()`` method.
2281 - Removed the internal lists ``document.substitution_refs``,
2282 ``document.anonymous_refs``, and ``document.anonymous_targets``.
2283 - Added a "container" element.
2284 - Fixed bug where values of list-valued attributes of elements
2285 originating from custom interpreted text roles (i.e., with custom
2286 classes) were being shared between element instances. Reported by
2289 * docutils/statemachine.py:
2291 - Added trailing whitespace stripping to ``string2lines()``.
2292 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
2293 Asian double-width character support.
2295 * docutils/utils.py:
2297 - Added ``east_asian_column_width()`` for double-width character
2300 * docutils/languages/ja.py: Added to project: Japanese mappings by
2303 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
2304 mappings by Panjunyong.
2306 * docutils/parsers/null.py: Added to project; a do-nothing parser.
2308 * docutils/parsers/rst/__init__.py:
2310 - Added validator to "tab_width" setting, with test. Closes SF bug
2311 #1212515, report from Wu Wei.
2313 * docutils/parsers/rst/states.py:
2315 - Fixed bug with escaped colons indicating a literal block.
2316 - Fixed bug with enumerated lists (SF#1254145).
2317 - Backslash-escaped colons inside of field names are now allowed.
2318 - Targets (implicit and explicit), anonymous hyperlink references
2319 and auto-numbered footnote references inside of substitution
2320 definitions are now disallowed.
2321 - Fixed bug: list items with blank first lines.
2322 - Fixed bug: block quote attributions with indented second lines.
2323 - Added East Asian double-width character support (Python 2.4 only).
2325 * docutils/parsers/rst/tableparser.py:
2327 - Added East Asian double-width character support (Python 2.4 only).
2329 * docutils/parsers/rst/directives/body.py:
2331 - Added the "container" directive.
2333 * docutils/parsers/rst/directives/misc.py:
2335 - Added the "default-role", "title", and "date" directives.
2336 - Added standard data file syntax to the "include" directive.
2337 - Added support for "class" directive content.
2339 * docutils/parsers/rst/directives/images.py:
2341 - Added ``indirect_reference_name`` support for images with a target
2343 - Added support for image width and height units.
2344 - Fixed bug with image "target" options.
2346 * docutils/parsers/rst/directives/references.py:
2348 - Added "class" attribute to "target-notes" directive, for
2349 footnote_reference classes.
2351 * docutils/parsers/rst/include/: Directory added to project; contains
2352 standard data files for the "include" directive. Initial contents:
2353 character entity substitution definition sets, and a set of
2354 definitions for S5/HTML presentations.
2356 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
2357 mappings by David Goodger.
2359 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
2360 Simplified Chinese mappings by Panjunyong.
2362 * docutils/readers/__init__.py:
2364 - Added universal.Decorations and universal.ExposeInternals
2365 transforms as default transforms for all readers.
2366 - Added ``ReReader`` base class for readers that reread an existing
2369 * docutils/readers/doctree.py: Added to project; a reader for existing
2372 * docutils/transforms/frontmatter.py:
2374 - Fixed the DocInfo transform to handle SVN-style expansion of the
2376 - In ``DocInfo.extract_authors``, treat the contents of "authors"
2379 * docutils/transforms/misc.py:
2381 - Added misc.Transitions transform, extracted from
2382 universal.FinalChecks.
2384 * docutils/transforms/references.py:
2386 - Added references.DanglingReferences transform, extracted from
2387 universal.FinalChecks.
2388 - Fixed bug with doubly-indirect substitutions.
2389 - Added footnote_reference classes attribute to "TargetNotes".
2390 - Fixed bug with circular substitution definitions that put Docutils
2391 into an infinite loop.
2393 * docutils/transforms/universal.py:
2395 - Added universal.ExposeInternals transform, extracted from
2396 universal.FinalChecks.
2397 - Removed universal.FinalChecks transform (logic has been moved to
2398 several new transforms).
2399 - Fixed bug with the "expose_internals" setting and Text nodes
2400 (exposed by the "rawsource" internal attribute).
2401 - Added the universal.StripComments transform, implementation of the
2402 "strip_comments" setting.
2404 * docutils/transforms/writer_aux.py: Added to project; auxiliary
2405 transforms for writers.
2407 - Added ``Compound`` transform, which flattens compound paragraphs.
2409 * docutils/writers/: Several writer modules (html4css1.py) were
2410 converted into packages. Support modules and data files have been
2411 moved into the packages. The stylesheets for the HTML writers are
2412 now installed along with the code, the code knows where to find
2413 them, and the default is to use them (actually, to embed them).
2414 Some adjustments to configuration files may be necessary. The
2415 easiest way to obtain the new default behavior is to remove all
2416 settings whose name includes "stylesheet".
2418 * docutils/writers/__init__.py:
2420 - Added universal.Messages and universal.FilterMessages transforms
2421 as default transforms for all writers.
2422 - Added ``UnfilteredWriter`` base class for writers that pass the
2423 document tree on unchanged.
2425 * docutils/writers/docutils_xml.py:
2427 - Made ``xmlcharrefreplace`` the default output encoding error
2430 * docutils/writers/html4css1/:
2432 - Added support for image width and height units.
2433 - Made ``xmlcharrefreplace`` the default output encoding error
2435 - Made ``--embed-stylesheet`` the default rather than
2436 ``--link-stylesheet``.
2437 - Moved "id" attribute from container (section etc.) to title's <a>
2438 tag, to be on the same tag as "name".
2439 (!!! To be reverted in Docutils 0.5.)
2440 - Added vertical space between fields of field lists.
2441 - Added ``--compact-field-lists`` option to remove vertical space in
2443 - Made cloaking of email addresses with ``--cloak-email-addresses``
2445 - Fixed support for centered images.
2446 - Added support for class="compact" & class="open" lists.
2448 * docutils/writers/latex2e/:
2450 - Underscores in citekeys are no longer escaped.
2452 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
2453 mapping of Unicode characters to LaTeX equivalents.
2455 * docutils/writers/s5_html/: Package added to project; writer for
2456 S5/HTML slide shows.
2458 * docs/dev/distributing.txt: Added to project; guide for distributors
2459 (package maintainers).
2461 * docs/dev/hacking.txt: Added to project; guide for developers.
2463 * docs/ref/doctree.txt:
2465 - Updated for plural attributes "classes", "ids", "names",
2467 - Added the "container" element.
2469 * docs/ref/docutils.dtd:
2471 - Updated for plural attributes "classes", "ids", "names",
2474 * docs/user/emacs.txt: Added to project; a document about Emacs
2475 support for reStructuredText and Docutils.
2477 * docs/user/links.txt: Added to project; lists of Docutils-related
2480 * docs/user/mailing-lists.txt: Added to project; information about
2481 Docutils-related mailing lists and how to access them.
2483 * docs/user/slide-shows.txt: Added to project; example of and docs for
2484 the S5/HTML writer (``rst2s5.py`` front end).
2486 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
2487 Files", added to project.
2489 * test/coverage.sh: Added to project; test coverage script.
2491 * test/DocutilsTestSupport.py:
2493 - Added support for specifying runtime settings at the suite level.
2495 * test/test_functional.py:
2497 - Added the ``clear_output_directory`` function.
2498 - Added support for ``_test_more`` functions in functional test
2501 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
2503 * tools/rstpep2html.py: Renamed from pep.py.
2505 * tools/dev/create_unimap.py: Added to project; script to create the
2506 docutils/writers/unimap_latex.py mapping file.
2508 * tools/dev/profile_docutils.py: Added to project; profiler script.
2510 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
2512 * tools/editors/emacs/restructuredtext.el,
2513 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
2514 Removed from project; the functionality is now contained in rst.el.
2516 * tools/editors/emacs/rst.el: Added to project. Added many features
2517 and fixed many bugs. See docs/user/emacs.txt for details.
2519 * tools/stylesheets: Removed from project. Stylesheets have been
2520 renamed and moved into writer packages.
2523 Release 0.3.9 (2005-05-26)
2524 ==========================
2528 - Eliminated and replaced all uses of the old string attributes
2529 ``id``, ``name``, ``dupname`` and ``class`` with references to the
2530 new list attributes ``ids``, ``names``, ``dupnames`` and
2531 ``classes`` throughout the whole source tree.
2535 - Enabled ``--dump-*`` options when ``--traceback`` specified,
2536 allowing for easier debugging.
2537 - In ``Publisher.publish()``, expanded the generic top-level
2540 * docutils/examples.py:
2542 - Added ``internals`` function for exploration.
2546 - Fixed ``Input.decode`` method to apply heuristics only if no
2547 encoding is explicitly given, and to provide better reporting of
2549 - The ``Input.decode`` method now removes byte order marks (BOMs)
2552 * docutils/nodes.py:
2554 - ``image`` element class changed to subclass of Element, not
2555 TextElement (it's an empty element, and cannot contain text).
2556 - Added ``attr_defaults`` dictionary for default attribute values.
2557 - Added empty list as default value for the following attributes:
2558 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
2559 - Added ``document.decoration`` attribute,
2560 ``document.get_decoration`` method, and ``decoration.get_header``
2561 & ``.get_footer`` methods.
2562 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
2565 * docutils/utils.py:
2567 - Removed ``docutils.utils.Reporter.categories``,
2568 ``docutils.utils.ConditionSet``, and all references to them, to
2569 simplify error reporting.
2571 * docutils/languages/nl.py: Added to project; Dutch mappings by
2574 * docutils/parsers/rst/__init__.py:
2576 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
2578 * docutils/parsers/rst/states.py:
2580 - Added check for escaped at-mark to prevent email address recognition.
2581 - Fixed option lists to allow spaces inside ``<angle-bracketed option
2583 - Allowed whitespace in paths and URLs.
2584 - Added auto-enumerated list items.
2585 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
2587 - Added support for table stub columns.
2589 * docutils/parsers/rst/directives/__init__.py:
2591 - Allowed whitespace in paths (``path`` function).
2592 - Added ``uri`` directive option conversion function.
2594 * docutils/parsers/rst/directives/body.py:
2596 - Fixed illegal context bug with "topic" directive (allowed within
2597 sidebars; not within body elements).
2599 * docutils/parsers/rst/directives/images.py:
2601 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
2602 - Added support for the ``file_insertion_enabled`` setting in the
2603 "figure" directive (disables "figwidth" option).
2604 - "image" directive: added checks for valid values of "align" option,
2605 depending on context. "figure" directive: added specialized
2606 "align" option and attribute on "figure" element.
2607 - Made ":figwidth: image" option of "figure" directive work again.
2608 - Fixed bug with reference names containing uppercase letters
2609 (e.g. ``Name_``) in "target" option of "image" directive.
2611 * docutils/parsers/rst/directives/misc.py:
2613 - Fixed "include" and "raw" directives to catch text decoding
2615 - Allowed whitespace in "include" & "raw" directive paths.
2616 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
2617 settings in "include" & "raw" directives.
2619 * docutils/parsers/rst/directives/parts.py:
2621 - Added "header" & "footer" directives.
2622 - Fixed illegal context bug with "contents" directive (topics
2623 allowed within sidebars; not within body elements).
2625 * docutils/parsers/rst/directives/tables.py:
2627 - Added "list-table" directive.
2628 - Caught empty CSV table bug.
2629 - Added support for the ``file_insertion_enabled`` setting in the
2630 "csv-table" directive.
2631 - Added ``stub-columns`` option to "csv-table" and "list-table"
2634 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
2635 mappings by Martijn Pieters.
2637 * docutils/readers/standalone.py:
2639 - Added ``section_subtitles`` setting to activate or deactivate the
2640 ``SectSubTitle`` transform.
2642 * docutils/transforms/frontmatter.py:
2644 - Added SectSubTitle transform to promote titles of lone
2645 subsections to subtitles.
2647 * docutils/transforms/references.py:
2649 - Fixed mislocated internal targets bug, by propagating internal
2650 targets to the next node, making use of the newly added support
2651 for multiple names and IDs.
2652 - Fixed duplicate footnote label bug.
2653 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
2656 * docutils/writers/html4css1.py:
2658 - Fixed unencoded stylesheet reference bug (characters like "&" in
2659 stylesheet references).
2660 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
2662 - Added support for multiple IDs per node by creating empty ``span``
2664 - Added the ``field_name_limit`` & ``option_limit`` settings &
2666 - Added support for table stub columns.
2667 - Added support for the ``align`` attribute on ``figure`` elements.
2668 - Added the ``cloak_email_addresses`` setting & support.
2669 - Added ``html_prolog``, ``html_head``, ``html_body``,
2670 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
2671 ``docutils.core.publish_parts``.
2672 - Added support for section subtitles.
2674 * docutils/writers/latex2e.py:
2676 - Fixed tables starting with more than one multirow cell.
2677 - Improved ``--use-latex-docinfo`` so that organization/contact/address
2678 fields are lumped with the last author field and appear on the
2680 - Made sure the titlepage is always shown with ``--use-latex-docinfo``,
2681 even if the document has no title.
2682 - Made sure that latex doesn't fill in today's date if no date field
2684 - Added support for section subtitles.
2686 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
2687 (under development).
2689 * docutils/writers/null.py: Added to project; a do-nothing Writer.
2691 * docs/api/publisher.txt:
2693 - Added "``publish_parts`` Details" section.
2695 * docutils/dev/repository.txt: Added to project; information about the
2696 Docutils Subversion repository.
2698 * docs/ref/docutils.dtd:
2700 - Added a ``stub`` attribute to the ``colspec`` element via the
2701 ``tbl.colspec.att`` parameter entity.
2702 - Allowed topic elements within sidebars
2703 - Added an ``align`` attribute to the ``figure`` element.
2705 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
2709 Release 0.3.7 (2004-12-24)
2710 ==========================
2712 * docutils/frontend.py:
2714 - Added options: ``--input-encoding-error-handler``,
2715 ``--record-dependencies``, ``--leave-footnote-reference-space``,
2716 ``--strict-visitor``.
2717 - Added command-line and config file support for "overrides" setting
2722 - Added support for input encoding error handler.
2724 * docutils/nodes.py:
2726 - Added dispatch_visit and dispatch_departure methods to
2727 NodeVisitor; useful as a hook for Visitors.
2728 - Changed structure of ``line_block``; added ``line``.
2729 - Added ``compound`` node class.
2730 - Added a mechanism for Visitors to transitionally ignore new node
2733 * docutils/utils.py:
2735 - Moved ``escape2null`` and ``unescape`` functions from
2736 docutils/parsers/rst/states.py.
2738 * docutils/parsers/rst/roles.py:
2741 - Changed role function API: the "text" parameter now takes
2742 null-escaped interpreted text content.
2744 * docutils/parsers/rst/states.py:
2746 - Fixed bug where a "role" directive in a nested parse would crash
2747 the parser; the state machine's "language" attribute was not being
2749 - Added support for line block syntax.
2750 - Fixed directive parsing bug: argument-less directives didn't
2751 notice that arguments were present.
2752 - Removed error checking for transitions.
2753 - Added support for multiple classifiers in definition list items.
2754 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
2755 - Changed role function API: the "text" parameter now takes
2756 null-escaped interpreted text content.
2757 - Empty sections and documents are allowed now.
2759 * docutils/parsers/rst/directives/__init__.py:
2761 - Added ``encoding`` directive option conversion function.
2762 - Allow multiple class names in class_option conversion function.
2764 * docutils/parsers/rst/directives/body.py:
2766 - Converted the line-block directive to use the new structure.
2767 - Extracted the old line-block functionality to the ``block``
2768 function (still used).
2769 - Added ``compound`` directive (thanks to Lea Wiemann).
2771 * docutils/parsers/rst/directives/misc.py:
2773 - Added "encoding" option to "include" and "raw" directives.
2774 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
2775 - Allow multiple class names in the "class" directive.
2777 * docutils/parsers/rst/directives/parts.py:
2779 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
2780 options. Thanks to Lele Gaifax.
2782 * docutils/parsers/rst/directives/tables.py:
2784 - Added "encoding" directive to "csv-table" directive.
2785 - Added workaround for lack of Unicode support in csv.py, for
2786 non-ASCII CSV input.
2788 * docutils/transforms/misc.py:
2790 - Fixed bug when multiple "class" directives are applied to a single
2792 - Enabled multiple format names for "raw" directive.
2794 * docutils/transforms/references.py:
2796 - Added support for trimming whitespace from beside substitution
2799 * docutils/transforms/universal.py:
2801 - FinalChecks now checks for illegal transitions and moves
2802 transitions between sections.
2804 * docutils/writers/html4css1.py:
2806 - HTMLTranslator.encode now converts U+00A0 to " ".
2807 - "stylesheet" and "stylesheet_path" settings are now mutually
2809 - Added support for the new line_block/line structure.
2810 - ``--footnote-references`` now overrides
2811 ``--trim-footnote-reference-space``, if applicable.
2812 - Added support for ``compound`` elements.
2813 - Enabled multiple format names for "raw" directive.
2814 - ``<p>`` tags of a paragraph which is the only visible child of the
2815 document node are no longer stripped.
2816 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
2817 new method ``should_be_compact_paragraph()``.
2818 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
2820 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
2821 the output if they have their ``class`` attribute set.
2822 - The whole document is now surrounded by a ``<div
2823 class="document">`` element.
2824 - Body-level images are now wrapped by their own ``<div>`` elements,
2825 with image classes copied to the wrapper, and for images which
2826 have the ``:align:`` option set, the surrounding ``<div>`` now
2827 receives a class attribute (like ``class="align-left"``).
2829 * docutils/writers/latex2e.py:
2831 - no newline after depart_term.
2832 - Added translations for some Unicode quotes.
2833 - Added option "font-encoding", made package AE the default.
2834 - `stylesheet`_ and `stylesheet_path`_ settings are now mutually
2836 - ``--footnote-references`` now overrides
2837 ``--trim-footnote-reference-space``, if applicable.
2838 - The footnote label style now matches the footnote reference style
2839 ("brackets" or "superscript").
2840 - Added support for ``compound`` elements.
2841 - Enabled multiple format names for "raw" directive.
2843 * docs/ref/docutils.dtd:
2845 - Changed structure of the ``line_block`` element; added ``line``.
2846 - Added ``compound`` element.
2847 - Added "ltrim" and "rtrim" attributes to
2848 ``substitution_definition`` element.
2849 - Enabled multiple format names for ``raw`` element.
2850 - Enabled multiple classifiers in ``definition_list_item`` elements.
2852 * docs/ref/rst/directives.txt
2854 - Marked "line-block" as deprecated.
2855 - "Class" directive now allows multiple class names.
2856 - Added "Rationale for Class Attribute Value Conversion".
2857 - Added warning about "raw" overuse/abuse.
2859 * docs/ref/rst/restructuredtext.txt:
2861 - Added syntax for line blocks.
2862 - Definition list items may have multiple classifiers.
2864 * docs/ref/rst/roles.txt:
2868 * tools/stylesheets/default.css:
2870 - Added support for the new line_block structure.
2871 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
2874 Release 0.3.5 (2004-07-29)
2875 ==========================
2879 * _`Documentation cleanup/reorganization`.
2881 - Created new subdirectories of docs/:
2883 * ``docs/user/``: introductory/tutorial material for end-users
2884 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
2885 * ``docs/api/``: API reference material for client-developers
2886 * ``docs/ref/``: reference material for all groups
2887 * ``docs/howto/``: for component-developers and core-developers
2888 * ``docs/peps/``: Python Enhancement Proposals
2890 - Moved ``docs/*`` to ``docs/user/``.
2891 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
2892 ``spec/`` to ``docs/dev``.
2893 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
2894 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
2895 - Moved ``alternatives.txt``, and ``problems.txt`` from
2896 ``spec/rst/`` to ``docs/dev/rst/``.
2897 - Moved ``reStructuredText.txt``, ``directives.txt``,
2898 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
2899 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
2900 ``roles.txt``, ``reStructuredText.txt`` to
2901 ``restructuredtext.txt``.
2902 - Moved ``spec/howto/`` to ``docs/howto``.
2904 In order to keep the CVS history of moved files, we supplied
2905 SourceForge with a script for modifying the Docutils CVS repository.
2907 After running the cleanup script:
2909 - Added ``docs/index.txt``.
2910 - Added a ``.htaccess`` file to the ``web`` module, containing
2911 redirects for all old paths to new paths. They'll preserve
2912 fragments (the "#name" part of a URL), and won't clutter up the
2913 file system, and will correct the URL in the user's browser.
2914 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
2915 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
2916 the "To Do" list itself in ``docs/dev/todo.txt``.
2917 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
2918 section of ``docs/dev/todo.txt``.
2919 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
2920 - Added "How To Report Bugs" to ``BUGS.txt``.
2921 - Went through all the sources and docs (including under web/) and
2922 updated links. Mostly done by Lea Wiemann; thanks Lea!
2923 (Still need to update links in the sandboxes.)
2927 * BUGS.txt: Added to project.
2929 * THANKS.txt: Added to project.
2931 * docutils/__init__.py:
2933 - 0.3.4: Post-release.
2937 - Added special error handling & advice for UnicodeEncodeError.
2938 - Refactored Publisher.publish (simplified exception handling &
2939 extracted debug dumps).
2940 - Renamed "enable_exit" parameter of convenience functions to
2941 "enable_exit_status".
2942 - Enabled traceback (exception propagation) by default in
2943 programmatic convenience functions.
2944 - Now publish_file and publish_cmdline convenience functions return
2945 the encoded string results in addition to their regular I/O.
2946 - Extracted common code from publish_file, publish_string, and
2947 publish_parts, into new publish_programmatically. Extracted
2948 settings code to ``Publisher.process_programmatic_settings``.
2949 - In Publisher.publish, disabled ``settings_overrides`` when
2950 ``settings`` is supplied; redundant.
2952 * docutils/frontend.py:
2954 - Added help text for ``--output-encoding-error-handler`` and
2955 ``--error-encoding-error-handler``.
2956 - Renamed ``--exit`` to ``--exit-status``.
2957 - Simplified default-setting code.
2959 * docutils/parsers/rst/__init__.py:
2961 - Added ``--pep-base-url`` and ``--rfc-base-url`` options.
2963 * docutils/parsers/rst/states.py:
2965 - Made URI recognition more aggressive and intelligent.
2967 * docutils/parsers/rst/directives/__init__.py:
2969 - Added several directive option conversion functions.
2971 * docutils/parsers/rst/directives/body.py:
2973 - Moved "table" directive to tables.py.
2975 * docutils/parsers/rst/directives/tables.py: Table-related directives,
2978 * docutils/writers/latex2e.py:
2980 - Added ``--table-style=(standard|booktabs|nolines)``
2981 - figures get "here" option (LaTeX per default puts them at bottom),
2982 and figure content is centered.
2983 - Rowspan support for tables.
2984 - Fix: admonition titles before first section.
2985 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
2986 - Replave ``_`` in literal by an underlined blank, because it has the correct
2988 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
2989 - A few unicode replacements, if output_encoding != utf
2990 - Add `graphicx_option`_ setting.
2991 - Indent literal-blocks.
2992 - Fix: omit ``\maketitle`` when there is no document title.
2994 * docs/index.txt: "Docutils Project Documentation Overview", added to
2997 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
2998 Tool", added to project.
3000 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
3002 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
3004 * docs/dev/policies.txt: Added to project (extracted from
3005 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3007 * docs/dev/release.txt: Added to project (extracted from
3008 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3010 * docs/dev/testing.txt: Added to project.
3012 * docs/dev/website.txt: Added to project (extracted from
3013 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
3015 * docs/ref/rst/directives.txt:
3017 - Added directives: "table", "csv-table".
3019 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
3020 added to project. 1 page for syntax, and a 1 page reference for
3021 directives and roles. Source text to be used as-is; not meant to be
3024 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
3025 with a change of title.
3027 * test/functional/, contents, and test/test_functional.py: Added to
3030 * tools/buildhtml.py: Fixed bug with config file handling.
3032 * tools/html.py: Removed from project (duplicate of rst2html.py).
3034 * tools/pep2html.py: Removed from project (duplicate of Python's
3035 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
3036 Docutils-related PEPs in docs/peps/).
3038 * tools/rst2pseudoxml.py: Renamed from publish.py.
3040 * tools/rst2xml.py: Renamed from docutils-xml.py.
3042 * tools/test.txt: Removed from project; moved to
3043 docs/user/rst/demo.txt.
3045 * setup.py: Now also installs ``rst2latex.py``.
3048 Release 0.3.3 (2004-05-09)
3049 ==========================
3051 * docutils/__init__.py:
3053 - 0.3.1: Reorganized config file format (multiple sections); see
3055 - Added unknown_reference_resolvers attribute to TransformSpec.
3056 - 0.3.2: Interpreted text reorganization.
3061 - Catch system messages to stop tracebacks from parsing errors.
3062 - Catch exceptions during processing report & exit without
3063 tracebacks, except when ``--traceback`` used.
3064 - Reordered components for OptionParser; application comes last.
3065 - Added "config_section" parameter to several methods and functions,
3066 allowing front ends to easily specify their config file sections.
3067 - Added publish_parts convenience function to allow access to individual
3068 parts of a document.
3070 * docutils/examples.py: Added to project; practical examples of
3071 Docutils client code, to be used as-is or as models for variations.
3073 * docutils/frontend.py:
3075 - Added "traceback" setting.
3076 - Implemented support for config file reorganization:
3077 ``standard_config_files`` moved from ``ConfigParser`` to
3078 ``OptionParser``; added
3079 ``OptionParser.get_config_file_settings()`` and
3080 ``.get_standard_config_settings()``; support for old "[options]"
3081 section (with deprecation warning) and mapping from old to new
3083 - Reimplemented setting validation.
3084 - Enabled flexible boolean values: yes/no, true/false, on/off.
3085 - Added ``Values``, a subclass of ``optparse.Values``, with support
3086 for list setting attributes.
3087 - Added support for new ``DOCUTILSCONFIG`` environment variable;
3088 thanks to Beni Cherniavsky.
3089 - Added ``--no-section-numbering`` option.
3093 - Catch IOErrors when opening source & destination files, report &
3094 exit without tracebacks. Added ``handle_io_errors`` parameter to
3095 ``FileInput`` & ``FileOutput`` to enable caller error handling.
3097 * docutils/nodes.py:
3099 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
3100 method definitions (via ``exec``) to dynamic assignments (via
3101 ``setattr``); thanks to Roman Suzi.
3102 - Encapsulated visitor dynamic assignments in a function; thanks to
3104 - Added indirect_reference_name attribute to the Targetable
3105 class. This attribute holds the whitespace_normalized_name
3106 (contains mixed case) of a target.
3108 * docutils/statemachine.py:
3110 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
3111 - Added ``StringList.get_2D_block``.
3113 * docutils/utils.py:
3115 - Added "level" attribute to SystemMessage exceptions.
3117 * docutils/languages/af.py: Added to project; Afrikaans mappings by
3120 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
3123 * docutils/languages/eo.py: Added to project; Esperanto mappings by
3124 Marcelo Huerta San Martin.
3126 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
3127 mappings by Lalo Martins.
3129 * docutils/languages/ru.py: Added to project; Russian mappings by
3132 * docutils/parsers/rst/roles.py: Added to project. Contains
3133 interpreted text role functions, a registry for interpreted text
3134 roles, and an API for adding to and retrieving from the registry.
3135 Contributed by Edward Loper.
3137 * docutils/parsers/rst/states.py:
3139 - Updated ``RSTState.nested_parse`` for "include" in table cells.
3140 - Allowed true em-dash character and "``---``" as block quote
3142 - Added support for <angle-bracketed> complex option arguments
3144 - Fixed handling of backslashes in substitution definitions.
3145 - Fixed off-by-1 error with extra whitespace after substitution
3146 definition directive.
3147 - Added inline markup parsing to field lists' field names.
3148 - Added support for quoted (and unindented) literal blocks.
3149 Driven in part by a bribe from Frank Siebenlist (thanks!).
3150 - Parser now handles escapes in URIs correctly.
3151 - Made embedded-URIs' reference text omittable. Idea from Beni
3153 - Refactored explicit target processing code.
3154 - Added name attribute to references containing the reference name only
3155 through whitespace_normalize_name (no case changes).
3156 - parse_target no longer returns the refname after going through
3157 normalize_name. This is now handled in make_target.
3158 - Fixed bug relating to role-less interpreted text in non-English
3160 - Reorganized interpreted text processing; moved code into the new
3161 roles.py module. Contributed by Edward Loper.
3162 - Refactored ``Body.parse_directive`` into ``run_directive`` and
3163 ``parse_directive_block``.
3165 * docutils/parsers/rst/tableparser.py:
3167 - Reworked for ``StringList``, to support "include" directives in
3170 * docutils/parsers/rst/directives/__init__.py:
3172 - Renamed ``unchanged()`` directive option conversion function to
3173 ``unchanged_required``, and added a new ``unchanged``.
3174 - Catch unicode value too high error; fixes bug 781766.
3175 - Beefed up directive error reporting.
3177 * docutils/parsers/rst/directives/body.py:
3179 - Added basic "table" directive.
3181 * docutils/parsers/rst/directives/images.py:
3183 - Added "target" option to "image" directive.
3184 - Added name attribute to references containing the reference name only
3185 through whitespace_normalize_name (no case changes).
3187 * docutils/parsers/rst/directives/misc.py:
3189 - Isolated the import of the ``urllib2`` module; was causing
3190 problems on SourceForge (``libssl.so.2`` unavailable?).
3191 - Added the "role" directive for declaring custom interpreted text
3194 * docutils/parsers/rst/directives/parts.py:
3196 - The "contents" directive does more work up-front, creating the
3197 "topic" and "title", and leaving the "pending" node for the
3198 transform. Allows earlier reference resolution; fixes subtle bug.
3200 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
3201 mappings by Jannie Hofmeyr.
3203 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
3204 mappings by Marek Blaha.
3206 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
3207 mappings by Marcelo Huerta San Martin.
3209 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
3210 Portuguese mappings by Lalo Martins.
3212 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
3213 mappings by Roman Suzi.
3215 * docutils/transforms/parts.py:
3217 - The "contents" directive does more work up-front, creating the
3218 "topic" and "title", and leaving the "pending" node for the
3219 transform. Allows earlier reference resolution; fixes subtle bug.
3220 - Added support for disabling of section numbering.
3222 * docutils/transforms/references.py:
3224 - Verifying that external targets are truly targets and not indirect
3225 references. This is because we are now adding a "name" attribute to
3226 references in addition to targets. Note sure if this is correct!
3227 - Added code to hook into the unknown_reference_resolvers list for a
3228 transformer in resolve_indirect_target. This allows the
3229 unknown_reference_resolvers to keep around indirect targets which
3230 docutils doesn't know about.
3231 - Added specific error message for duplicate targets.
3233 * docutils/transforms/universal.py:
3235 - Added FilterMessages transform (removes system messages below the
3236 verbosity threshold).
3237 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
3238 to FinalCheckVisitor for application-specific handling of
3239 unresolvable references.
3240 - Added specific error message for duplicate targets.
3242 * docutils/writers/__init__.py:
3244 - Added assemble_parts method to the Writer class to allow for
3245 access to a documents individual parts.
3246 - Documented & set default for ``Writer.output`` attribute.
3248 * docutils/writers/html4css1.py:
3250 - Fixed unicode handling of attribute values (bug 760673).
3251 - Prevent duplication of "class" attribute values (bug report from
3253 - Improved table grid/border handling (prompted by report from Bob
3255 - Added support for table titles.
3256 - Added "<title />" for untitled docs, for XHTML conformance; thanks
3258 - Added functionality to keep track of individual parts of a document
3259 and store them in a dictionary as the "parts" attribute of the writer.
3260 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
3261 - Added proper support for the "scale" attribute of the "image"
3262 element. Contributed by Brent Cook.
3263 - Added ``--initial-header-level`` option.
3264 - Fixed bug: the body_pre_docinfo segment depended on there being a
3265 docinfo; if no docinfo, the document title was incorporated into
3266 the body segment. Adversely affected the publish_parts interface.
3268 * docutils/writers/latex2e.py:
3270 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
3271 about a missing file.
3272 - Added options and support: ``--compound-enumerators``,
3273 ``--section-prefix-for-enumerators``, and
3274 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
3276 - Added option ``--use-verbatim-when-possible``, to avoid
3277 problematic characters (eg, '~' in italian) in literal blocks.
3278 - It's now possible to use four section levels in the `book` and
3279 `report` LaTeX document classes. The default `article` class still has
3282 * docs/config.txt: "Docutils Configuration Files", added to project.
3283 Moved config file entry descriptions from tools.txt.
3287 - Moved config file entry descriptions to config.txt.
3289 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
3292 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
3293 Text Roles", added to project.
3295 * spec/rst/reStructuredText.txt:
3297 - Added description of support for <angle-bracketed> complex option
3298 arguments to option lists.
3299 - Added subsections for indented and quoted literal blocks.
3301 * test: Continually adding & updating tests.
3303 - Added test/test_settings.py & test/data/config_*.txt support
3305 - Added test/test_writers/test_htmlfragment.py.
3307 * test/DocutilsTestSupport.py:
3309 - Refactored LaTeX publisher test suite/case class names to make
3310 testing other writers easier.
3311 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
3312 to test the processing of HTML fragments which use the new
3313 publish_parts convenience function.
3315 * tools/buildhtml.py:
3317 - Added support for the ``--prune`` option.
3318 - Removed dependency on pep2html.py; plaintext PEPs no longer
3321 * tools/docutils.conf:
3323 - Updated for configuration file reorganization.
3325 * tools/rst2html.py:
3327 - copied from tools/html.py
3331 - added a 'scripts' section to configuration
3332 - added 'tools/rst2html.py' to the scripts section
3335 Release 0.3 (2003-06-24)
3336 ========================
3340 * Renamed "attribute" to "option" for directives/extensions.
3342 * Renamed transform method "transform" to "apply".
3344 * Renamed "options" to "settings" for runtime settings (as set by
3345 command-line options). Sometimes "option" (singular) became
3346 "settings" (plural). Some variations below:
3348 - document.options -> document.settings (stored in other objects as
3350 - option_spec -> settings_spec (not directives though)
3351 - OptionSpec -> SettingsSpec
3352 - cmdline_options -> settings_spec
3353 - relative_path_options -> relative_path_settings
3354 - option_default_overrides -> settings_default_overrides
3355 - Publisher.set_options -> Publisher.get_settings
3359 * COPYING.txt: Added "Public Domain Dedication".
3361 * FAQ.txt: Frequently asked questions, added to project.
3365 - Updated with PyPI Trove classifiers.
3366 - Conditional installation of third-party modules.
3368 * docutils/__init__.py:
3370 - Bumped version to 0.2.1 to reflect changes to I/O classes.
3371 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
3372 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
3373 - Bumped version to 0.2.3 because of the new ``--embed-stylesheet``
3374 option and its effect on the PEP template & writer.
3375 - Bumped version to 0.2.4 due to changes to the PEP template &
3377 - Bumped version to 0.2.5 to reflect changes to Reporter output.
3378 - Added ``TransformSpec`` class for new transform system.
3379 - Bumped version to 0.2.6 for API changes (renaming).
3380 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
3381 convenience functions.
3382 - Added ``Component.component_type`` attribute.
3383 - Bumped version to 0.2.8 because of the internal parser switch from
3384 plain lists to the docutils.statemachine.StringList objects.
3385 - Bumped version to 0.2.9 because of the frontend.py API changes.
3386 - Bumped version to 0.2.10 due to changes to the project layout
3387 (third-party modules removed from the "docutils" package), and
3388 signature changes in ``io.Input``/``io.Output``.
3389 - Changed version to 0.3.0 for release.
3393 - Made ``publish()`` a bit more convenient.
3394 - Generalized ``Publisher.set_io``.
3395 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
3396 parameters; improved its docstring.
3397 - Added ``publish_file()`` and ``publish_string()``.
3398 - Factored ``Publisher.set_source()`` and ``.set_destination()``
3400 - Added support for ``--dump-pseudo-xml``, ``--dump-settings``, and
3401 ``--dump-transforms`` hidden options.
3402 - Added ``Publisher.apply_transforms()`` method.
3403 - Added ``Publisher.set_components()`` method; support for
3404 ``publish_*()`` conveninece functions.
3405 - Moved config file processing to docutils/frontend.py.
3406 - Added support for exit status ("exit_level" setting &
3407 ``enable_exit`` parameter for Publisher.publish() and convenience
3410 * docutils/frontend.py:
3412 - Check for & exit on identical source & destination paths.
3413 - Fixed bug with absolute paths & ``--config``.
3414 - Set non-command-line defaults in ``OptionParser.__init__()``:
3415 ``_source`` & ``_destination``.
3416 - Distributed ``relative_path_settings`` to components; updated
3417 ``OptionParser.populate_from_components()`` to combine it all.
3418 - Require list of keys in ``make_paths_absolute`` (was implicit in
3419 global ``relative_path_settings``).
3420 - Added ``--expose-internal-attribute``, ``--dump-pseudo-xml``,
3421 ``--dump-settings``, and ``--dump-transforms`` hidden options.
3422 - Removed nasty internals-fiddling ``ConfigParser.get_section``
3423 code, replaced with correct code.
3424 - Added validation functionality for config files.
3425 - Added ``--error-encoding`` option/setting, "_disable_config"
3427 - Added encoding validation; updated ``--input-encoding`` and
3428 ``--output-encoding``; added ``--error-encoding-error-handler`` and
3429 ``--output-encoding-error-handler``.
3430 - Moved config file processing from docutils/core.py.
3431 - Updated ``OptionParser.populate_from_components`` to handle new
3432 ``SettingsSpec.settings_defaults`` dict.
3433 - Added support for "-" => stdin/stdout.
3434 - Added "exit_level" setting (``--exit`` option).
3438 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
3439 - Added automatic closing to ``FileInput`` and ``FileOutput``.
3440 - Delayed opening of ``FileOutput`` file until ``write()`` called.
3441 - ``FileOutput.write()`` now returns the encoded output string.
3442 - Try to get path/stream name automatically in ``FileInput`` &
3444 - Added defaults for source & destination paths.
3445 - Allow for Unicode I/O with an explicit "unicode" encoding.
3446 - Added ``Output.encode()``.
3447 - Removed dependency on runtime settings; pass encoding directly.
3448 - Recognize Unicode strings in ``Input.decode()``.
3449 - Added support for output encoding error handlers.
3451 * docutils/nodes.py:
3453 - Added "Invisible" element category class.
3454 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
3455 modification during a traversal.
3456 - Added element classes: ``line_block``, ``generated``, ``address``,
3457 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
3458 ``superscript``, ``subscript``, ``inline``
3459 - Added support for lists of nodes to ``Element.insert()``.
3460 - Fixed parent linking in ``Element.replace()``.
3461 - Added new abstract superclass ``FixedTextElement``; adds
3462 "xml:space" attribute.
3463 - Added support for "line" attribute of ``system_message`` nodes.
3464 - Added support for the observer pattern from ``utils.Reporter``.
3465 Added ``parse_messages`` and ``transform_messages`` attributes to
3466 ``document``, removed ``messages``. Added ``note_parse_message``
3467 and ``note_transform_message`` methods.
3468 - Added support for improved diagnostics:
3470 - Added "document", "source", and "line" internal attributes to
3471 ``Node``, set by ``Node.setup_child()``.
3472 - Converted variations on ``node.parent = self`` to
3473 ``self.setup_child(node)``.
3474 - Added ``document.current_source`` & ``.current_line``
3475 attributes, and ``.note_source`` observer method.
3476 - Changed "system_message" output to GNU-Tools format.
3478 - Added a "rawsource" attribute to the ``Text`` class, for text
3479 before backslash-escape resolution.
3480 - Support for new transform system.
3481 - Reworked ``pending`` element.
3482 - Fixed XML DOM bug (SF #660611).
3483 - Removed the ``interpeted`` element class and added
3484 ``title_reference``, ``abbreviation``, ``acronym``.
3485 - Made substitutions case-sensitive-but-forgiving; moved some code
3487 - Fixed Unicode bug on element attributes (report: William Dode).
3489 * docutils/optik.py: Removed from project; replaced with
3490 extras/optparse.py and extras/textwrap.py. These will be installed
3491 only if they're not already present in the Python installation.
3493 * docutils/roman.py: Moved to extras/roman.py; this will be installed
3494 only if it's not already present in the Python installation.
3496 * docutils/statemachine.py:
3498 - Factored out ``State.add_initial_transitions()`` so it can be
3500 - Converted whitespace-specific "blank" and "indent" transitions
3501 from special-case code to ordinary transitions: removed
3502 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
3503 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
3504 ``ws_initial_transitions`` attributes.
3505 - Removed ``State.match_transition()`` after merging it into
3507 - Added ``StateCorrection`` exception.
3508 - Added support for ``StateCorrection`` in ``StateMachine.run()``
3509 (moved ``TransitionCorrection`` support there too.)
3510 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
3511 ``EOFError`` instead of ``IndexError``.
3512 - Added ``State.no_match`` method.
3513 - Added support for the Observer pattern, triggered by input line
3515 - Added ``strip_top`` parameter to
3516 ``StateMachineWS.get_first_known_indented``.
3517 - Made ``context`` a parameter to ``StateMachine.run()``.
3518 - Added ``ViewList`` & ``StringList`` classes;
3519 ``extract_indented()`` becomes ``StringList.get_indented()``.
3520 - Added ``StateMachine.insert_input()``.
3521 - Fixed ViewList slice handling for Python 2.3. Patch from (and
3522 thanks to) Fred Drake.
3524 * docutils/utils.py:
3526 - Added a ``source`` attribute to Reporter instances and
3527 ``system_message`` elements.
3528 - Added an observer pattern to ``utils.Reporter`` to keep track of
3530 - Fixed bugs in ``relative_path()``.
3531 - Added support for improved diagnostics.
3532 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
3533 - Added support for encoding Reporter stderr output, and encoding
3535 - Reporter keeps track of the highest level system message yet
3538 * docutils/languages: Fixed bibliographic field language lookups.
3540 * docutils/languages/es.py: Added to project; Spanish mappings by
3541 Marcelo Huerta San Martin.
3543 * docutils/languages/fr.py: Added to project; French mappings by
3546 * docutils/languages/it.py: Added to project; Italian mappings by
3549 * docutils/languages/sk.py: Added to project; Slovak mappings by
3552 * docutils/parser/__init__.py:
3554 - Added ``Parser.finish_parse()`` method.
3556 * docutils/parser/rst/__init__.py:
3558 - Added options: ``--pep-references``, ``--rfc-references``,
3559 ``--tab-width``, ``--trim-footnote-reference-space``.
3561 * docutils/parsers/rst/states.py:
3563 - Changed "title under/overline too short" system messages from INFO
3564 to WARNING, and fixed its insertion location.
3565 - Fixed enumerated list item parsing to allow paragraphs & section
3566 titles to begin with enumerators.
3567 - Converted system messages to use the new "line" attribute.
3568 - Fixed a substitution reference edge case.
3569 - Added support for ``--pep-references`` and ``--rfc-references``
3570 options; reworked ``Inliner`` code to make customization easier.
3571 - Removed field argument parsing.
3572 - Added support for short section title over/underlines.
3573 - Fixed "simple reference name" regexp to ignore text like
3574 "object.__method__"; not an anonymous reference.
3575 - Added support for improved diagnostics.
3576 - Reworked directive API, based on Dethe Elza's contribution. Added
3577 ``Body.parse_directive()``, ``.parse_directive_options()``,
3578 ``.parse_directive_arguments()`` methods.
3579 - Added ``ExtensionOptions`` class, to parse directive options
3580 without parsing field bodies. Factored
3581 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
3582 ``ExtensionOptions``.
3583 - Improved definition list term/classifier parsing.
3584 - Added warnings for unknown directives.
3585 - Renamed ``Stuff`` to ``Struct``.
3586 - Now flagged as errors: transitions at the beginning or end of
3587 sections, empty sections (except title), and empty documents.
3588 - Updated for ``statemachine.StringList``.
3589 - Enabled recognition of schemeless email addresses in targets.
3590 - Added support for embedded URIs in hyperlink references.
3591 - Added backslash-escapes to inline markup end-string suffix.
3592 - Added support for correct interpreted text processing.
3593 - Fixed nested title parsing (topic, sidebar directives).
3594 - Added special processing of backslash-escaped whitespace (idea
3595 from David Abrahams).
3596 - Made substitutions case-sensitive-but-forgiving; moved some code
3597 to ``docutils.nodes``.
3598 - Added support for block quote attributions.
3599 - Added a kludge to work-around a conflict between the bubble-up
3600 parser strategy and short titles (<= 3 char-long over- &
3601 underlines). Fixes SF bug #738803 "infinite loop with multiple
3602 titles" submitted by Jason Diamond.
3603 - Added explicit interpreted text roles for standard inline markup:
3604 "emphasis", "strong", "literal".
3605 - Implemented "superscript" and "subscript" interpreted text roles.
3606 - Added initial support for "abbreviation" and "acronym" roles;
3608 - Added support for ``--trim-footnote-reference-space`` option.
3609 - Optional space before colons in directives & hyperlink targets.
3611 * docutils/parsers/rst/tableparser.py:
3613 - Fixed a bug that was producing unwanted empty rows in "simple"
3615 - Detect bad column spans in "simple" tables.
3617 * docutils/parsers/rst/directives: Updated all directive functions to
3620 * docutils/parsers/rst/directives/__init__.py:
3622 - Added ``flag()``, ``unchanged()``, ``path()``,
3623 ``nonnegative_int()``, ``choice()``, and ``class_option()``
3624 directive option helper functions.
3625 - Added warnings for unknown directives.
3626 - Return ``None`` for missing directives.
3627 - Added ``register_directive()``, thanks to William Dode and Paul
3630 * docutils/parsers/rst/directives/admonitions.py:
3632 - Added "admonition" directive.
3634 * docutils/parsers/rst/directives/body.py: Added to project. Contains
3635 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
3636 "parsed-literal", "rubric", "epigraph", "highlights" and
3637 "pull-quote" directives.
3639 * docutils/parsers/rst/directives/images.py:
3641 - Added an "align" attribute to the "image" & "figure" directives
3642 (by Adam Chodorowski).
3643 - Added "class" option to "image", and "figclass" to "figure".
3645 * docutils/parsers/rst/directives/misc.py:
3647 - Added "include", "raw", and "replace" directives, courtesy of
3649 - Added "unicode" and "class" directives.
3651 * docutils/parsers/rst/directives/parts.py:
3653 - Added the "sectnum" directive; by Dmitry Jemerov.
3654 - Added "class" option to "contents" directive.
3656 * docutils/parsers/rst/directives/references.py: Added to project.
3657 Contains the "target-notes" directive.
3659 * docutils/parsers/rst/languages/__init__.py:
3661 - Return ``None`` from get_language() for missing language modules.
3663 * docutils/parsers/rst/languages/de.py: Added to project; German
3664 mappings by Engelbert Gruber.
3666 * docutils/parsers/rst/languages/en.py:
3668 - Added interpreted text roles mapping.
3670 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
3671 mappings by Marcelo Huerta San Martin.
3673 * docutils/parsers/rst/languages/fr.py: Added to project; French
3674 mappings by William Dode.
3676 * docutils/parsers/rst/languages/it.py: Added to project; Italian
3677 mappings by Nicola Larosa.
3679 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
3680 mappings by Miroslav Vasko.
3682 * docutils/readers/__init__.py:
3684 - Added support for the observer pattern from ``utils.Reporter``, in
3685 ``Reader.parse`` and ``Reader.transform``.
3686 - Removed ``Reader.transform()`` method.
3687 - Added default parameter values to ``Reader.__init__()`` to make
3688 instantiation easier.
3689 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
3691 * docutils/readers/pep.py:
3693 - Added the ``peps.TargetNotes`` transform to the Reader.
3694 - Removed PEP & RFC reference detection code; moved to
3695 parsers/rst/states.py as options (enabled here by default).
3696 - Added support for pre-acceptance PEPs (no PEP number yet).
3697 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
3700 * docutils/readers/python: Python Source Reader subpackage added to
3701 project, including preliminary versions of:
3704 - moduleparser.py: Parser for Python modules.
3706 * docutils/transforms/__init__.py:
3708 - Added ``Transformer`` class and completed transform reform.
3709 - Added unknown_reference_resolvers list for each transformer. This list holds
3710 the list of functions provided by each component of the transformer that
3711 help resolve references.
3713 * docutils/transforms/frontmatter.py:
3715 - Improved support for generic fields.
3716 - Fixed bibliographic field language lookups.
3718 * docutils/transforms/misc.py: Added to project. Miscellaneous
3721 * docutils/transforms/parts.py:
3723 - Moved the "id" attribute from TOC list items to the references
3724 (``Contents.build_contents()``).
3725 - Added the ``SectNum`` transform; by Dmitry Jemerov.
3726 - Added "class" attribute support to ``Contents``.
3728 * docutils/transforms/peps.py:
3730 - Added ``mask_email()`` function, updating to pep2html.py's
3732 - Linked "Content-Type: text/x-rst" to PEP 12.
3733 - Added the ``TargetNotes`` PEP-specific transform.
3734 - Added ``TargetNotes.cleanup_callback``.
3735 - Added title check to ``Headers``.
3737 * docutils/transforms/references.py:
3739 - Added the ``TargetNotes`` generic transform.
3740 - Split ``Hyperlinks`` into multiple transforms.
3741 - Fixed bug with multiply-indirect references (report: Bruce Smith).
3742 - Added check for circular indirect references.
3743 - Made substitutions case-sensitive-but-forgiving.
3745 * docutils/transforms/universal.py:
3747 - Added support for the ``--expose-internal-attributes`` option.
3748 - Removed ``Pending`` transform classes & data.
3750 * docutils/writers/__init__.py:
3752 - Removed ``Writer.transform()`` method.
3754 * docutils/writers/docutils-xml.py:
3756 - Added XML and doctype declarations.
3757 - Added ``--no-doctype`` and ``--no-xml-declaration`` options.
3759 * docutils/writers/html4css1.py:
3761 - "name" attributes only on these tags: a, applet, form, frame,
3763 - Added "name" attribute to <a> in section titles for Netscape 4
3764 support (bug report: Pearu Peterson).
3765 - Fixed targets (names) on footnote, citation, topic title,
3766 problematic, and system_message nodes (for Netscape 4).
3767 - Changed field names from "<td>" to "<th>".
3768 - Added "@" to "@" encoding to thwart address harvesters.
3769 - Improved the vertical whitespace optimization; ignore "invisible"
3770 nodes (targets, comments, etc.).
3771 - Improved inline literals with ``<span class="pre">`` around chunks
3772 of text and `` `` for runs of spaces.
3773 - Improved modularity of output; added ``self.body_pre_docinfo`` and
3774 ``self.docinfo`` segments.
3775 - Added support for "line_block", "address" elements.
3776 - Improved backlinks (footnotes & system_messages).
3777 - Improved system_message output.
3778 - Redefined ``--stylesheet`` as containing an invariant URL, used
3779 verbatim. Added ``--stylesheet-path``, interpreted w.r.t. the
3781 - Added ``--footnote-references`` option (superscript or brackets).
3782 - Added ``--compact-lists`` and ``--no-compact-lists`` options.
3783 - Added ``--embed-stylesheet`` and ``--link-stylesheet`` options;
3784 factored out ``HTMLTranslator.get_stylesheet_reference()``.
3785 - Improved field list rendering.
3786 - Added Docutils version to "generator" meta tag.
3787 - Fixed a bug with images; they must be inline, so wrapped in <p>.
3788 - Improved layout of <pre> HTML source.
3789 - Fixed attribute typo on <colspec>.
3790 - Refined XML prologue.
3791 - Support for no stylesheet.
3792 - Removed "interpreted" element support.
3793 - Added support for "title_reference", "sidebar", "attribution",
3794 "rubric", and generic "admonition" elements.
3795 - Added ``--attribution`` option.
3796 - Added support for "inline", "subscript", "superscript" elements.
3797 - Added initial support for "abbreviation" and "acronym";
3800 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
3804 - Double quotes in literal blocks (special treatment for de/ngerman).
3805 - Added ``--hyperlink-color`` option ('0' turns off coloring of links).
3806 - Added ``--attribution`` option.
3807 - Right align attributions.
3809 * docutils/writers/pep_html.py:
3811 - Parameterized output encoding in PEP template.
3812 - Reworked substitutions from ``locals()`` into ``subs`` dict.
3813 - Redefined ``--pep-stylesheet`` as containing an invariant URL, used
3814 verbatim. Added ``--pep-stylesheet-path``, interpreted w.r.t. the
3816 - Added an override on the ``--footnote-references`` option.
3817 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
3818 - Added Docutils version to "generator" meta tag.
3819 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3823 - Added a "silent" setting for ``buildhtml.py``.
3824 - Added a "Getting Help" section.
3825 - Rearranged the structure.
3826 - Kept up to date, with new settings, command-line options etc.
3827 - Added section for ``rst2latex.py`` (Engelbert Gruber).
3828 - Converted settings table into a definition list.
3830 * docs/rst/quickstart.txt:
3832 - Added a table of contents.
3833 - Added feedback information.
3834 - Added mention of minimum section title underline lengths.
3835 - Removed the 4-character minimum for section title underlines.
3837 * docs/rst/quickref.html:
3839 - Added a "Getting Help" section.
3840 - Added a style to make section title backlinks more subtle.
3841 - Added mention of minimum section title underline lengths.
3842 - Removed the 4-character minimum for section title underlines.
3844 * extras: Directory added to project; contains third-party modules
3845 that Docutils depends on (optparse, textwrap, roman). These are
3846 only installed if they're not already present.
3848 * licenses: Directory added to project; contains copies of license
3849 files for non-public-domain files.
3853 - Changed the focus. It's about DTD elements: structural
3854 relationships, semantics, and external (public) attributes. Not
3855 about the element class library.
3856 - Moved some implementation-specific stuff into ``docutils.nodes``
3858 - Wrote descriptions of all common attributes and parameter
3859 entities. Filled in introductory material.
3860 - Working through the element descriptions: 55 down, 37 to go.
3861 - Removed "Representation of Horizontal Rules" to
3862 spec/rst/alternatives.txt.
3864 * spec/docutils.dtd:
3866 - Added "generated" inline element.
3867 - Added "line_block" body element.
3868 - Added "auto" attribute to "title".
3869 - Changed content models of "literal_block" and "doctest_block" to
3871 - Added ``%number;`` attribute type parameter entity.
3872 - Changed ``%structural.elements;`` to ``%section.elements``.
3873 - Updated attribute types; made more specific.
3874 - Added "address" bibliographic element.
3875 - Added "line" attribute to ``system_message`` element.
3876 - Removed "field_argument" element; "field_name" may contain
3877 multiple words and whitespace.
3878 - Changed public identifier to docutils.sf.net.
3879 - Removed "interpreted" element; added "title_reference",
3880 "abbreviation", "acronym".
3881 - Removed "refuri" attribute from "footnote_reference" and
3882 "citation_reference".
3883 - Added "sidebar", "rubric", "attribution", "admonition",
3884 "superscript", "subscript", and "inline" elements.
3886 * spec/pep-0256.txt: Converted to reStructuredText & updated.
3888 * spec/pep-0257.txt: Converted to reStructuredText & updated.
3890 * spec/pep-0258.txt: Converted to reStructuredText & updated.
3892 * spec/semantics.txt: Updated with text from a Doc-SIG response to
3895 * spec/transforms.txt: Added to project.
3897 * spec/howto: Added subdirectory, for developer how-to docs.
3899 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
3900 Elza, edited & extended by David Goodger.
3902 * spec/howto/i18n.txt: Docutils Internationalization. Added to
3905 * spec/rst/alternatives.txt:
3907 - Added "Doctree Representation of Transitions" from
3909 - Updated "Inline External Targets" & closed the debate.
3910 - Added ideas for interpreted text syntax extensions.
3911 - Added "Nested Inline Markup" section.
3913 * spec/rst/directives.txt:
3915 - Added directives: "topic", "sectnum", "target-notes",
3916 "line-block", "parsed-literal", "include", "replace", "sidebar",
3917 "admonition", "rubric", "epigraph", "highlights", "unicode" and
3919 - Formalized descriptions of directive details.
3920 - Added an "align" attribute to the "image" & "figure" directives
3921 (by Adam Chodorowski).
3922 - Added "class" options to "topic", "sidebar", "line-block",
3923 "parsed-literal", "contents", and "image"; and "figclass" to
3926 * spec/rst/interpreted.txt: Added to project. Descriptions of
3927 interpreted text roles.
3929 * spec/rst/introduction.txt:
3931 - Added pointers to material for new users.
3933 * spec/rst/reStructuredText.txt:
3935 - Disambiguated comments (just add a newline after the "::").
3936 - Updated enumerated list description; added a discussion of the
3937 second-line validity checking.
3938 - Updated directive description.
3939 - Added a note redirecting newbies to the user docs.
3940 - Expanded description of inline markup start-strings in non-markup
3942 - Removed field arguments and made field lists a generic construct.
3943 - Removed the 4-character minimum for section title underlines.
3944 - Clarified term/classifier delimiter & inline markup ambiguity
3946 - Added "Embedded URIs".
3947 - Updated "Interpreted Text" section.
3948 - Added "Character-Level Inline Markup" section.
3950 * test: Continually adding & updating tests.
3952 - Moved test/test_rst/ to test/test_parsers/test_rst/.
3953 - Moved test/test_pep/ to test/test_readers/test_pep/.
3954 - Added test/test_readers/test_python/.
3955 - Added test/test_writers/ (Engelbert Gruber).
3959 - Made the ``locale.setlocale()`` calls in front ends
3962 * tools/buildhtml.py:
3964 - Added ``--silent`` option.
3965 - Fixed bug with absolute paths & ``--config``.
3966 - Updated for new I/O classes.
3967 - Added some exception handling.
3968 - Separated publishers' setting defaults; prevents interference.
3969 - Updated for new ``publish_file()`` convenience function.
3971 * tools/pep-html-template:
3973 - Allow for ``--embed-stylesheet``.
3974 - Added Docutils version to "generator" meta tag.
3975 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3976 - Conform to XHTML spec.
3978 * tools/pep2html.py:
3980 - Made ``argv`` a parameter to ``main()``.
3981 - Added support for "Content-Type:" header & arbitrary PEP formats.
3982 - Linked "Content-Type: text/plain" to PEP 9.
3983 - Files skipped (due to an error) are not pushed onto the server.
3984 - Updated for new I/O classes.
3985 - Added ``check_requirements()`` & ``pep_type_error()``.
3986 - Added some exception handling.
3987 - Updated for new ``publish_string()`` convenience function.
3988 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
3990 * tools/quicktest.py:
3992 - Added ``-V``/``--version`` option.
3994 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
3996 * tools/unicode2rstsubs.py: Added to project. Produces character
3997 entity files (reSructuredText substitutions) from the MathML master
4000 * tools/editors: Support code for editors, added to project. Contains
4001 ``emacs/restructuredtext.el``.
4003 * tools/stylesheets/default.css: Moved into the stylesheets directory.
4005 - Added style for chunks of inline literals.
4006 - Removed margin for first child of table cells.
4007 - Right-aligned field list names.
4008 - Support for auto-numbered section titles in TOCs.
4009 - Increased the size of inline literals (<tt>) in titles.
4010 - Restored the light gray background for inline literals.
4011 - Added support for "line_block" elements.
4012 - Added style for "address" elements.
4013 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
4014 - Improved field list rendering.
4015 - Vertical whitespace improvements.
4016 - Removed "a.target" style.
4018 * tools/stylesheets/pep.css:
4020 - Fixed nested section margins.
4021 - Other changes parallel those of ``../default.css``.
4024 Release 0.2 (2002-07-31)
4025 ========================
4029 - The word "component" was being used ambiguously. From now on,
4030 "component" will be used to mean "Docutils component", as in Reader,
4031 Writer, Parser, or Transform. Portions of documents (Table of
4032 Contents, sections, etc.) will be called "document parts".
4033 - Did a grand renaming: a lot of ``verylongnames`` became
4034 ``very_long_names``.
4035 - Cleaned up imports: no more relative package imports or
4036 comma-separated lists of top-level modules.
4037 - Added support for an option values object which carries default
4038 settings and overrides (from command-line options and library use).
4039 - Added internal Unicode support, and support for both input and
4041 - Added support for the ``docutils.io.IO`` class & subclasses.
4045 * docutils/__init__.py:
4047 - Added ``ApplicationError`` and ``DataError``, for use throughout
4049 - Added ``Component`` base class for Docutils components; implements
4050 the ``supports`` method.
4051 - Added ``__version__`` (thus, ``docutils.__version__``).
4055 - Removed many keyword parameters to ``Publisher.__init__()`` and
4056 ``publish()``; bundled into an option values object. Added
4057 "argv", "usage", "description", and "option_spec" parameters for
4058 command-line support.
4059 - Added ``Publisher.process_command_line()`` and ``.set_options()``
4061 - Reworked I/O model for ``docutils.io`` wrappers.
4062 - Updated ``Publisher.set_options()``; now returns option values
4064 - Added support for configuration files (/etc/docutils.conf,
4065 ./docutils.conf, ~/.docutils).
4066 - Added ``Publisher.setup_option_parser()``.
4067 - Added default usage message and description.
4069 * docutils/frontend.py: Added to project; support for front-end
4070 (command-line) scripts. Option specifications may be augmented by
4071 components. Requires Optik (http://optik.sourceforge.net/) for option
4072 processing (installed locally as docutils/optik.py).
4074 * docutils/io.py: Added to project; uniform API for a variety of input
4077 * docutils/nodes.py:
4079 - Added ``TreeCopyVisitor`` class.
4080 - Added a ``copy`` method to ``Node`` and subclasses.
4081 - Added a ``SkipDeparture`` exception for visitors.
4082 - Renamed ``TreePruningException`` from ``VisitorException``.
4083 - Added docstrings to ``TreePruningException``, subclasses, and
4085 - Improved docstrings.
4086 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
4087 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
4089 - Added ``decoration``, ``header``, and ``footer`` node classes, and
4090 ``PreDecorative`` mixin.
4091 - Reworked the name/id bookkeeping; to ``document``, removed
4092 ``explicit_targets`` and ``implicit_targets`` attributes, added
4093 ``nametypes`` attribute and ``set_name_id_map`` method.
4094 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
4096 - Added ``document.has_name()`` method.
4097 - Fixed DOM generation for list-attributes.
4098 - Added category class ``Labeled`` (used by footnotes & citations).
4099 - Added ``Element.set_class()`` method (sets "class" attribute).
4101 * docutils/optik.py: Added to project. Combined from the Optik
4102 package, with added option groups and other modifications. The use
4103 of this module is probably only temporary.
4105 * docutils/statemachine.py:
4107 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
4108 - Added underscores to improve many awkward names.
4109 - In ``string2lines()``, changed whitespace normalizing translation
4110 table to regexp; restores Python 2.0 compatibility with Unicode.
4112 * docutils/urischemes.py:
4114 - Filled in some descriptions.
4115 - Added "shttp" scheme.
4117 * docutils/utils.py:
4119 - Added ``clean_rcs_keywords`` function (moved from
4120 docutils/transforms/frontmatter.py
4121 ``DocInfo.filter_rcs_keywords``).
4122 - Added underscores to improve many awkward names.
4123 - Changed names of Reporter's thresholds:
4124 warning_level -> report_level; error_level -> halt_level.
4125 - Moved ``utils.id()`` to ``nodes.make_id()``.
4126 - Added ``relative_path(source, target)``.
4128 * docutils/languages/de.py: German mappings; added to project. Thanks
4129 to Gunnar Schwant for the translations.
4131 * docutils/languages/en.py: Added "Dedication" bibliographic field
4134 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
4137 * docutils/parsers/rst/states.py:
4139 - Added underscores to improve many awkward names.
4140 - Added RFC-2822 header support.
4141 - Extracted the inline parsing code from ``RSTState`` to a separate
4142 class, ``Inliner``, which will allow easy subclassing.
4143 - Made local bindings for ``memo`` container & often-used contents
4144 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
4145 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
4146 - Added ``MarkupMismatch`` exception; for late corrections.
4147 - Added ``-/:`` characters to inline markup's start string prefix,
4148 ``/`` to end string suffix.
4149 - Fixed a footnote bug.
4150 - Fixed a bug with literal blocks.
4151 - Applied patch from Simon Budig: simplified regexps with symbolic
4152 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
4153 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
4154 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
4155 - Allowed non-ASCII in "simple names" (directive names, field names,
4157 - Converted ``Inliner.patterns.initial`` to be dynamically built
4158 from parts with ``build_regexp()`` function.
4159 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
4160 - Updated docstrings.
4161 - Changed "table" to "grid_table"; added "simple_table" support.
4163 * docutils/parsers/rst/tableparser.py:
4165 - Changed ``TableParser`` to ``GridTableParser``.
4166 - Added ``SimpleTableParser``.
4167 - Refactored naming.
4169 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
4170 a fallback language for directive names.
4172 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
4173 directive to use a ``pending`` element, used only by HTML writers.
4175 * docutils/parsers/rst/directives/parts.py: Renamed from
4178 - Added "backlinks" attribute to "contents" directive.
4180 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
4181 project by Adam Chodorowski.
4183 * docutils/readers/__init__.py: Gave Readers more control over
4184 choosing and instantiating Parsers.
4186 * docutils/readers/pep.py: Added to project; for PEP processing.
4188 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
4189 requires a ``component`` parameter.
4191 * docutils/transforms/components.py: Added to project; transforms
4192 related to Docutils components.
4194 * docutils/transforms/frontmatter.py:
4196 - In ``DocInfo.extract_authors``, check for a single "author" in an
4197 "authors" group, and convert it to a single "author" element.
4198 - Added support for "Dedication" and generic bibliographic fields.
4200 * docutils/transforms/peps.py: Added to project; PEP-specific.
4202 * docutils/transforms/parts.py: Renamed from old components.py.
4204 - Added filter for ``Contents``, to use alt-text for inline images,
4205 and to remove inline markup that doesn't make sense in the ToC.
4206 - Added "name" attribute to TOC topic depending on its title.
4207 - Added support for optional TOC backlinks.
4209 * docutils/transforms/references.py: Fixed indirect target resolution
4210 in ``Hyperlinks`` transform.
4212 * docutils/transforms/universal.py:
4214 - Changed ``Messages`` transform to properly filter out system
4215 messages below the warning threshold.
4216 - Added ``Decorations`` transform (support for ``--generator``,
4217 ``--date``, ``--time``, ``--source-link`` options).
4219 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
4220 Engelbert Gruber's PDF writer.
4222 * docutils/writers/html4css1.py:
4224 - Made XHTML-compatible (switched to lowercase element & attribute
4225 names; empty tag format).
4226 - Escape double-dashes in comment text.
4227 - Improved boilerplate & modularity of output.
4228 - Exposed modular output in Writer class.
4229 - Added a "generator" meta tag to <head>.
4230 - Added support for the ``--stylesheet`` option.
4231 - Added support for ``decoration``, ``header``, and ``footer``
4233 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
4234 translation table to regexp; restores Python 2.0 compatibility
4236 - Added the translator class as instance variable to the Writer, to
4237 make it easily subclassable.
4238 - Improved option list spacing (thanks to Richard Jones).
4239 - Modified field list output.
4240 - Added backlinks to footnotes & citations.
4241 - Added percentage widths to "<col>" tags (from colspec).
4242 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
4243 "<span>" changed to "<var>".
4244 - Inline literals: "<code>" changed to "<tt>".
4245 - Many changes to optimize vertical space: compact simple lists etc.
4246 - Add a command-line options & directive attributes to control TOC
4247 and footnote/citation backlinks.
4248 - Added support for optional footnote/citation backlinks.
4249 - Added support for generic bibliographic fields.
4250 - Identify backrefs.
4251 - Relative URLs for stylesheet links.
4253 * docutils/writers/pep_html.py: Added to project; HTML Writer for
4254 PEPs (subclass of ``html4css1.Writer``).
4256 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
4258 * docutils/writers/docutils_xml.py: Added to project; trivial writer
4259 of the Docutils internal doctree in XML.
4261 * docs/tools.txt: "Docutils Front-End Tools", added to project.
4265 - Changed the title to "The Docutils Document Tree".
4266 - Added "Hyperlink Bookkeeping" section.
4268 * spec/docutils.dtd:
4270 - Added ``decoration``, ``header``, and ``footer`` elements.
4271 - Brought ``interpreted`` element in line with the parser: changed
4272 attribute "type" to "role", added "position".
4273 - Added support for generic bibliographic fields.
4275 * spec/notes.txt: Continual updates. Added "Project Policies".
4277 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
4280 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
4282 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
4283 mailing list discussions.
4285 * spec/pep-0287.txt:
4287 - Renamed to "reStructuredText Docstring Format".
4289 - Reworked Q&A as an enumerated list.
4290 - Converted to reStructuredText format.
4292 * spec/pysource.dtd:
4294 - Reworked structural elements, incorporating ideas from Tony Ibbs.
4296 * spec/pysource.txt: Removed from project. Moved much of its contents
4299 * spec/rst/alternatives.txt:
4301 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
4302 - Added "Inline External Targets" section.
4304 * spec/rst/directives.txt:
4306 - Added "backlinks" attribute to "contents" directive.
4308 * spec/rst/problems.txt:
4310 - Updated the Enumerated List Markup discussion.
4311 - Added new alternative table markup syntaxes.
4313 * spec/rst/reStructuredText.txt:
4315 - Clarified field list usage.
4316 - Updated enumerated list description.
4317 - Clarified purpose of directives.
4318 - Added ``-/:`` characters to inline markup's start string prefix,
4319 ``/`` to end string suffix.
4320 - Updated "Authors" bibliographic field behavior.
4321 - Changed "inline hyperlink targets" to "inline internal targets".
4322 - Added "simple table" syntax to supplement the existing but
4323 newly-renamed "grid tables".
4324 - Added cautions for anonymous hyperlink use.
4325 - Added "Dedication" and generic bibliographic fields.
4327 * test: Made test modules standalone (subdirectories became packages).
4329 * test/DocutilsTestSupport.py:
4331 - Added support for PEP extensions to reStructuredText.
4332 - Added support for simple tables.
4333 - Refactored naming.
4335 * test/package_unittest.py: Renamed from UnitTestFolder.py.
4337 - Now supports true packages containing test modules
4338 (``__init__.py`` files required); fixes duplicate module name bug.
4340 * test/test_pep/: Subpackage added to project; PEP testing.
4342 * test/test_rst/test_SimpleTableParser.py: Added to project.
4346 - Updated html.py and publish.py front-end tools to use the new
4347 command-line processing facilities of ``docutils.frontend``
4348 (exposed in ``docutils.core.Publisher``), reducing each to just a
4350 - Added ``locale.setlocale()`` calls to front-end tools.
4352 * tools/buildhtml.py: Added to project; batch-generates .html from all
4353 the .txt files in directories and subdirectories.
4355 * tools/default.css:
4357 - Added support for ``header`` and ``footer`` elements.
4358 - Added styles for "Dedication" topics (biblio fields).
4360 * tools/docutils.conf: A configuration file; added to project.
4362 * tools/docutils-xml.py: Added to project.
4364 * tools/pep.py: Added to project; PEP to HTML front-end tool.
4366 * tools/pep-html-template: Added to project.
4368 * tools/pep2html.py: Added to project from Python (nondist/peps).
4369 Added support for Docutils (reStructuredText PEPs).
4371 * tools/quicktest.py:
4373 - Added the ``--attributes`` option, hacked a bit.
4374 - Added a second command-line argument (output file); cleaned up.
4376 * tools/stylesheets/: Subdirectory added to project.
4378 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
4381 Release 0.1 (2002-04-20)
4382 ========================
4384 This is the first release of Docutils, merged from the now inactive
4385 reStructuredText__ and `Docstring Processing System`__ projects. For
4386 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
4387 `DPS HISTORY`__ files.
4389 __ http://structuredtext.sourceforge.net/
4390 __ http://docstring.sourceforge.net/
4391 __ http://structuredtext.sourceforge.net/HISTORY.html
4392 __ http://docstring.sourceforge.net/HISTORY.html
4394 General changes: renamed 'dps' package to 'docutils'; renamed
4395 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
4396 the test suites (reStructuredText's test/test_states renamed to
4397 test/test_rst); and all modifications required to make it all work.
4399 * docutils/parsers/rst/states.py:
4401 - Improved diagnostic system messages for missing blank lines.
4402 - Fixed substitution_reference bug.
4407 .. _RELEASE-NOTES: RELEASE-NOTES.html
4408 .. _`_config_files`: docs/user/config.html#config-files
4409 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
4411 .. _detailed: docs/user/config.html#detailed
4412 .. _docutils_footnotes: docs/user/config.html#docutils-footnotes
4413 .. _dump_settings: docs/user/config.html#dump-settings
4414 .. _embed_images: docs/user/config.html#embed-images
4415 .. _embed_stylesheet: docs/user/config.html#embed-stylesheet
4416 .. _figure_footnotes: docs/user/config.html#figure-footnotes
4417 .. _file_insertion_enabled: docs/user/config.html#file-insertion-enabled
4418 .. _graphicx_option: docs/user/config.html#graphicx-option
4419 .. _hidden_controls: docs/user/config.html#hidden-controls
4420 .. _html_writer: docs/user/config.html#html-writer
4421 .. _hyperref_options: docs/user/config.html#hyperref-options
4422 .. _id_prefix: docs/user/config.html#id-prefix
4423 .. _ignore: docs/user/config.html#ignore
4424 .. _image_loading: docs/user/config.html#image-loading
4425 .. _indents: docs/user/config.html#indents
4426 .. _initial_header_level: docs/user/config.html#initial-header-level
4427 .. _input_encoding: docs/user/config.html#input-encoding
4428 .. _input_encoding_error_handler: docs/user/config.html#input-encoding-error-handler
4429 .. _language: docs/user/config.html#language
4430 .. _latex_preamble: docs/user/config.html#latex-preamble
4431 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
4432 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
4433 .. _literal_block_env: docs/user/config.html#literal-block-env
4434 .. _math_output: docs/user/config.html#math-output
4435 .. _output: docs/user/config.html#output
4436 .. _output_encoding: docs/user/config.html#output-encoding
4437 .. _prune: docs/user/config.html#prune
4438 .. _raw_enabled: docs/user/config.html#raw-enabled
4439 .. _reference_label: docs/user/config.html#reference-label
4440 .. _root_prefix: docs/user/config.html#root-prefix
4441 .. _smart_quotes: docs/user/config.html#smart-quotes
4442 .. _sources: docs/user/config.html#sources
4443 .. _strip_classes: docs/user/config.html#strip-classes
4444 .. _strip_elements_with_classes: docs/user/config.html#strip-elements-with-classes
4445 .. _stylesheet: docs/user/config.html#stylesheet
4446 .. _stylesheet_dirs: docs/user/config.html#stylesheet-dirs
4447 .. _stylesheet_path: docs/user/config.html#stylesheet-path
4448 .. _syntax_highlight: docs/user/config.html#syntax-highlight
4449 .. _table_style: docs/user/config.html#table-style
4450 .. _theme: docs/user/config.html#theme
4451 .. _theme_url: docs/user/config.html#theme-url
4452 .. _toc_backlinks: docs/user/config.html#toc-backlinks
4453 .. _traceback: docs/user/config.html#traceback
4454 .. _use_bibtex: docs/user/config.html#use-bibtex
4455 .. _use_latex_abstract: docs/user/config.html#use-latex-abstract
4456 .. _use_latex_footnotes: docs/user/config.html#use-latex-footnotes
4457 .. _use_latex_toc: docs/user/config.html#use-latex-toc
4458 .. _view_mode: docs/user/config.html#view-mode
4460 .. _<meta>: docs/ref/doctree.html#meta
4461 .. _<image>: docs/ref/doctree.html#image
4462 .. _<inline>: docs/ref/doctree.html#inline
4463 .. _<literal>: docs/ref/doctree.html#literal
4471 indent-tabs-mode: nil
4472 sentence-end-double-space: t