Release 0.18.1
[docutils.git] / docutils / RELEASE-NOTES.txt
blob1d341d0f05e20b1d92cf56285bdaafc5f4ec167f
1 .. -*- coding: utf-8 -*-
3 ========================
4  Docutils Release Notes
5 ========================
7 :Contact: grubert@users.sourceforge.net
8 :Maintainer: docutils-develop@lists.sourceforge.net
9 :Date: $Date$
10 :Revision: $Revision$
11 :Web site: https://docutils.sourceforge.io/
12 :Copyright: This document has been placed in the public domain.
15 This document summarizes the major changes in recent and upcoming releases.
16 For a more detailed list of changes, please see the Docutils `HISTORY`_.
18 .. contents::
20 Future changes
21 ==============
23 Drop support for Python 2.7, 3.5, and 3.6.
25 Drop support for `old-format configuration files`_.
27 * `html5` writer:
29   - Stop setting the "footnote-reference" class value for footnote
30     references. Since 0.18, you can use the CSS selector
31     ``[role="doc-noteref"]`` instead of ``.footnote-reference``
32     (see minimal.css for examples).
34   - Remove option "embed_images" (obsoleted by "image_loading_").
36     .. _image_loading: docs/user/config.html#image-loading
38   - Move attribution behind the blockquote to comply with the `"living
39     standard"`__. (HTML5__ allows <cite> elements inside a blockquote.)
41     __ https://html.spec.whatwg.org/#the-blockquote-element
42     __ https://www.w3.org/TR/2014/REC-html5-20141028/grouping-content.html
43        #the-blockquote-element
45 * `latex2e` writer:
47   - Change default of use_latex_citations_ setting to True.
49   - Change default of legacy_column_widths_ setting to False.
51   - Remove ``use_verbatim_when_possible`` setting
52     (use literal_block_env_: verbatim).
54 * Remove the "rawsource" attribute and argument from nodes.Text:
55   we store the null-escaped text in Text nodes since 0.16 so there is no
56   additional information in the rawsource.
58 * Move math format conversion from docutils/utils/math (called from
59   docutils/writers/_html_base.py) to a transform__.
61   __ docs/ref/transforms.html
63 * The default HTML writer "html" with frontend ``rst2html.py`` may change
64   from "html4css1" to "html5".
66   Use ``get_writer_by_name('html')`` or the rst2html.py_ front end, if you
67   want the output to be up-to-date automatically.
69   Use the "html4" writer or ``rst2html4.py``, if you depend on
70   stability of the generated HTML code, e.g. because you use a custom
71   style sheet or post-processing that may break otherwise.
73 * Remove the "html_writer" option of the ``buildhtml.py`` application
74   (obsoleted by "writer__").
76   __ docs/user/config.html#writer
78 .. _old-format configuration files:
79    docs/user/config.html#old-format-configuration-files
80 .. _rst2html.py: docs/user/tools.html#rst2html-py
81 .. _reference name: docs/ref/rst/restructuredtext.html#reference-names
82 .. _literal_block_env: docs/user/config.html#literal-block-env
83 .. _use_latex_citations: docs/user/config.html#use-latex-citations
86 Release 0.18.1
87 ==============
89 .. Note::
91    Docutils 0.18.x is the last version supporting Python 2.7, 3.5, and 3.6.
93 * nodes.Node.traverse() returns a list again to restore
94   backwards compatibility (fixes bug #431).
96 * Small bugfixes (see HISTORY_).
99 Release 0.18 (2021-10-26)
100 =========================
102 * Output changes:
104   Identifiers:
105     During `identifier normalization`_, leading number and hyphen
106     characters are no longer stripped from a `reference name`_, if the
107     id_prefix_ setting is non-empty.
109     Example:
110       with ``--id-prefix="DU-"``, a section with title "34. May"
111       currently gets the identifier key ``DU-may`` and after the
112       change the identifier key ``DU-34-may``.
114     The default value for the auto_id_prefix_ setting changed to ``%``:
115     "use the tag name as prefix for auto-generated IDs".
116     Set auto_id_prefix_ to ``id`` for unchanged auto-IDs.
118   HTML5:
119     Use the semantic tag <aside> for footnote text and citations, topics
120     (except abstract and toc), admonitions, and system messages.
121     Use <nav> for the Table of Contents.
123     Make "auto" table column widths the default: Only specify column
124     widths, if the `"widths" option`_ is set and not "auto".
125     The table-style__ setting "colwidths-grid" restores the current default.
127     .. _"widths" option: __ docs/ref/rst/directives.html#table
128     __ docs/user/config.html#table-style
130     Items of a definition list with class argument "details" are
131     converted to `details disclosure elements`_. Example::
133       ..class:: details
135       Summary
136         This additional information should be hidden.
138     Do not add "compound-first", "compound-middle", or "compound-last" to
139     elements nested in a compound. Use child selector and ":first-child",
140     ":last-child" pseudo classes instead.
141     Use class value "backrefs" instead of "fn-backref" for a span of
142     back-references.
144     Write footnote brackets and field term colons to HTML, so that they
145     are present also without CSS and when copying text.
147     Move space character between section number and heading into
148     "sectnum" span.
150   math-output: html
151     Support more commands, fix mapping of commands to Unicode characters.
152     Scale variable sized operators and big delimiters with CSS.
153     Don't use <tt> element (deprecated in HTML5).
154     Use STIX fonts if available.
156   LaTeX:
157      `legacy_class_functions`_ setting default changed to "False",
158      admonitions are now environments.
160 * New standard Docutils doctree node: <meta__>.
162 * New configuration settings:
163   [latex writers] legacy_column_widths_ and
164   [html5 writer] image_loading_.
166 * Removed files:
167   ``iepngfix.htc`` and ``blank.gif`` (IE 6 workaround for `s5_html`).
169 * Removed sub-module:
170   ``parsers.rst.directives.html``
171   (Meta directive moved to ``parsers.rst.directives.misc``.)
173 * Removed function: utils.unique_combinations()
174   (obsoleted by itertools.combinations()).
176 * Removed attribute: ``HTMLTranslator.topic_classes``
177   (check node.parent.classes instead).
179 * Major refactoring and fixes/additions in
180   ``docutils/utils/math/math2html.py`` and
181   ``docutils/utils/math/latex2mathml.py``
182   (mathematical notation in HTML, cf. `LaTeX syntax for mathematics`_).
184 * nodes.Node.traverse() returns an iterator instead of a list.
186 * Various bugfixes and improvements (see HISTORY_).
188   Fix spelling errors in documentation and docstrings.
189   Thanks to Dimitri Papadopoulos.
191 __ docs/ref/doctree.html#meta
192 .. _identifier normalization:
193    docs/ref/rst/directives.html#identifier-normalization
194 .. _id_prefix: docs/user/config.html#id-prefix
195 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
196 .. _details disclosure elements:
197     https://www.w3.org/TR/html52/interactive-elements.html#the-details-element
198 .. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
199 .. _legacy_column_widths: docs/user/config.html#legacy-column-widths
202 Release 0.17.1 (2021-04-16)
203 ===========================
205 * Bug fixes (for details see the Docutils `HISTORY`_).
207 Release 0.17 (2021-04-03)
208 =========================
210 * Numerous bug fixes and improvements
211   (for details see the Docutils `HISTORY`_).
213 * Installing with ``setup.py`` now requires setuptools_.
214   Alternatively, install with pip_.
216 * The generic command line front end tool docutils-cli.py_ allows
217   the free selection of reader, parser, and writer components.
219 * Support Arabic language.
221 * New, **experimental** wrapper to integrate the `recommonmark`__
222   Markdown parser for use with Docutils.
223   Currently only tested with recommonmark version 0.4.0.
225   __ https://pypi.org/project/recommonmark/
227 * HTML5 writer:
229   - New option embed_images_.
231   - Use semantic tags (for details see the Docutils `HISTORY`_).
233   - Change the `initial_header_level`_ setting's default to "2", as browsers
234     use the `same style for <h1> and <h2> when nested in a section`__.
236   - New optional style ``responsive.css``, adapts to different screen
237     sizes.
239   - Move non-essential styling from ``minimal.css`` to ``plain.css``
240     rsp. ``responsive.css``.
242   - Show code line numbers as pseudo-elements so they are skipped when
243     copying the code block from the page.
245   .. _initial_header_level: docs/user/config.html#initial-header-level
246   __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
247   .. _embed_images: docs/user/config.html#embed-images
249 * LaTeX writer:
251   - New configuration setting `legacy_class_functions`_.
253   - The special value "auto" for the `graphicx_option`_ setting
254     is no longer supported (it never worked for xetex/luatex).
256   - `Styling commands`__ using the legacy ``\docutilsrole`` prefix are
257     now ignored. Use ``\DUrole``.
259     __ docs/user/latex.html#classes
261   - Most helper commands and element definitions are now defined in the
262     LaTeX package `docutils.sty`_ and only inserted in the document
263     preamble if the stylesheet__ setting does not lists "docutils".
265     __ docs/user/config.html#stylesheet-latex-writers
267   - Remove legacy LaTeX stylesheet ``docutils-05-compat.sty``.
269 .. _setuptools: https://pypi.org/project/setuptools/
270 .. _pip: https://pypi.org/project/pip/
271 .. _docutils-cli.py: docs/user/tools.html#docutils-cli-py
272 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
273 .. _graphicx_option: docs/user/config.html#graphicx-option
274 .. _docutils.sty: https://ctan.org/pkg/docutils
277 Release 0.16 (2020-01-12)
278 =========================
280 .. Note::
282    Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
284    Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
285    without the use of the ``2to3`` tool.
287 * reStructuredText:
289   - Keep `backslash escapes`__ in the document tree. This allows, e.g.,
290     escaping of author-separators in `bibliographic fields`__.
292   __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
293   __ docs/ref/rst/restructuredtext.html#bibliographic-fields
295 * LaTeX writer:
297   - Informal titles of type "rubric" default to bold-italic and left aligned.
298   - Deprecate ``\docutilsrole`` prefix for styling commands:
299     use ``\DUrole`` instead.
300   - Fix topic subtitle.
301   - Add "latex writers" to the `config_section_dependencies`.
302   - Ignore classes for `rubric` elements
303     (class wrapper interferes with LaTeX formatting).
305 * tools/buildhtml.py
307   - New option "--html-writer" allows to select "html__" (default),
308     "html4" or "html5".
310   __ html: docs/user/html.html#html
312 * docutils/io.py
314   - Remove the `handle_io_errors` option from io.FileInput/Output.
316 * docutils/nodes.py
318   - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
320   .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
322 * Various bugfixes and improvements (see HISTORY_).
325 Release 0.15 (2019-07-20)
326 =========================
328 .. Note::
330    Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
331    3.1, and 3.2.
333    Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
334    (cf. `Python 3 compatibility`_).
336 * reStructuredText:
338   - Allow embedded colons in field list field names (before, tokens like
339     ``:this:example:`` were considered ordinary text).
341   - Fixed a bug with the "trim" options of the "unicode" directive.
343 * languages: Added Korean localisation (ko).
346 Release 0.14 (2017-08-03)
347 =========================
349 * docutils/docs/ref/docutils.dtd:
351   - Enable validation of Docutils XML documents against the DTD:
353 * docutils/parsers/rst/:
355   - Added functionality: escaped whitespace in URI contexts.
356   - Consistent handling of all whitespace characters in inline markup
357     recognition. (May break documents that relied on some whitespace
358     characters (NBSP, ...) *not* to be recognized as whitespace.)
360 * docutils/utils/smartquotes.py:
362   - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
363   - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
364   - Differentiate apostrophe from closing single quote (if possible).
365   - Add command line interface for stand-alone use (requires 2.7).
367 * docutils/writers/_html_base:
369   - Provide default title in metadata.
370   - The MathJax CDN shut down on April 30, 2017. For security reasons, we
371     don't use a third party public installation as default but warn
372     if `math-output` is set to MathJax without specifying a URL.
373     See math-output_ for details.
375 * docutils/writers/html4css1:
377   - Respect automatic table column sizing.
379 * docutils/writers/latex2e/__init__.py
381   - Handle class arguments for block-level elements by wrapping them
382     in a "DUclass" environment. This replaces the special handling for
383     "epigraph" and "topic" elements.
385 * docutils/writers/odf_odt:
387   - Language option sets ODF document's default language
388   - Image width, scale, ... set image size in generated ODF.
390 * tools/
392   - New front-end ``rst2html4.py``.
395 Release 0.13.1 (2016-12-09)
396 ===========================
398 * docutils/writers/html5_polyglot
400   - New HTML writer generating `HTML 5`_.
402   .. _HTML 5: http://www.w3.org/TR/html5/
404 * tools/
406   - New front-end ``rst2html5.py``.
408 * languages: persian/farsi (fa) and latvian (la) mappings.
410 * change default base url for :rfc: to http://tools.ietf.org/html/
412 * tables accept widths, a list and align
414 * latex2e: Fix admonition width, remove deprecated options,
415   better tablewidth auto, ...
417 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
420 Release 0.12 (2014-07-06)
421 =========================
423 Small changes only, release current state
426 Release 0.11 (2013-07-22)
427 =========================
429 * General
431   - Apply [ 2714873 ] Fix for the overwriting of document attributes.
432   - Support embedded aliases within hyperlink references.
433   - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
434     language module) before global search.
436 * docutils/parsers/rst/directives/tables.py
438   - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
440 * docutils/writers/html4css1/__init__.py
441   - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
442   - New setting `stylesheet_dirs` (see above).
444     Now, it is easy to add a custom stylesheet to Docutils' default
445     stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
447     Changed behaviour of the default settings:
448       if there is a file ``html4css1.css`` in the working directory of the
449       process at launch, it is used instead of the one provided by Docutils
450       in the writer source directory.
452   - New default for math-output_: ``HTML math.css``.
453   - Avoid repeated class declarations in html4css1 writer
454     (modified version of patch [ 104 ]).
456   .. _math-output: docs/user/config.html#math-output
458 * docutils/writers/latex2e/__init__.py
460   - Drop the simple algorithm replacing straight double quotes with
461     English typographic ones.
462     Activate the SmartQuotes_ transform if you want this feature.
463   - New setting `stylesheet_dirs`: Comma-separated list of directories
464     where stylesheets are found. Used by `stylesheet_path` when expanding
465     relative path arguments.
467   .. _SmartQuotes: docs/user/config.html#smart-quotes
469 * docutils/writers/manpage.py
471   - Fix [3607063] handle lines starting with a period.
472   - Fix option separating comma was bold (thanks to Bill Morris).
474 Release 0.10 (2012-12-16)
475 =========================
477 .. Note::
479    Docutils 0.9.x is the last version supporting Python 2.3.
481    Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
482    (cf. `Python 3 compatibility`_).
484 * General:
486   - SmartQuotes transform for typographic quotes and dashes.
488   - ``docutils/math``, ``docutils/error_reporting.py``, and
489     ``docutils/urischemes.py`` moved to the utils package.
490     Code importing these modules needs to adapt, e.g.::
492       try:
493           import docutils.math as math
494       except ImportError:
495           import docutils.utils.math as math
497   - enhanced math and error handling.
499 * docutils/io.py
501   - FileInput/FileOutput: no system-exit on IOError.
502     The `handle_io_errors` option is ignored.
504 * docutils/writers/html4css1/__init__.py
506   - Use ``<code>`` tag for inline "code",
507     do not drop nested inline nodes (syntax highlight tokens).
508   - Customizable MathJax URL (based on patch by Dmitry Shachnev).
509   - No line break after opening inline math tag.
511 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
513   - Fix section numbering by LaTeX.
515 * docutils/writers/s5_html/__init__.py
517   - Fix [ 3556388 ] Mathjax does not work with rst2s5.
520 Release 0.9.1 (2012-06-17)
521 ==========================
523 * General:
525   Several fixes for Python 3 usage.
527 * docutils/setup.py
529   - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
530     installed in the PYTHONPATH. Converted tests are now
531     stored in ``docutils/test3/``, tools no longer need conversion.
533     If you installed one of Docutils versions 0.7 ... 0.9 with
534     ``setup.py install`` under Python 3, remove the spurious
535     ``test/`` and ``tools/`` directories in the site library root.
538 Release 0.9 (2012-05-02)
539 =========================
541 * General:
543   - reStructuredText "code" role and directive with syntax highlighting
544     by Pygments_.
545   - "code" option of the "include" directive.
547   .. _Pygments: http://pygments.org/
549   - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
550     characters and "international" quotes around inline markup.
552   - Fix handling of missing stylesheets.
554 * setup.py
556   - Fix [ 2971827 ] and [ 3442827 ]
557     extras/roman.py moved to docutils/utils/roman.py
559 * docutils/utils.py -> docutils/utils/__init__.py
561   - docutils.utils is now a package (providing a place for sub-modules)
563 * docutils/writers/html4css1/__init__.py
565   - change default for `math-output` setting to MathJax
567 * docutils/writers/latex2e/__init__.py
569   - Support the `abbreviation` and `acronym` standard roles.
570   - Record only files required to generate the LaTeX source as dependencies.
571   - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
572     when suppressing LaTeX section numbering.
575 Release 0.8.1 (2011-08-30)
576 ==========================
578 * General:
580   - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
581     and [ 3395920 ] (correct copyright info for rst.el).
583 * docutils/writers/latex2e/__init__.py
585   - Clean up Babel language setting. Restores Sphinx compatibility.
588 Release 0.8 (2011-07-07)
589 ========================
591 * COPYING:
593   - Some additions to the Docutils core are released under the 2-Clause BSD
594     license.
596 * General:
598   - Handle language codes according to `BCP 47`_.
599   - If the specified language is not supported by Docutils,
600     warn and fall back to English.
601   - Math support: reStructuredText "math" role and directive,
602     ``math`` and ``math_block`` doctree elements.
603   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
605   .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
607 * reStructuredText:
609   - most directives now support a "name" option that attaches a
610     reference name. So you can write ::
612       .. figure:: image.png
613          :name: figure name
615     as a short form of ::
617       .. _figure name:
619       .. figure:: image.png
621 Internationalization:
623 * Added lithuanian mappings.
625 Components:
627 * HTML writer:
629   - New setting "math-output" with support for HTML, MathML, and LaTeX.
631 * LaTeX2e writer:
633   - Convert image URI to a local file path.
634   - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
635     has more than one paragraph (Wolfgang Scherer).
637 * XeTeX writer:
639   - New writer generating LaTeX code for compiling with ``xelatex``.
641     XeTeX uses unicode and modern font technologies.
643 * and fixes and enhancements here and there.
646 Release 0.7 (2010-07-07)
647 ========================
649 Components:
651 * HTML writer:
653   - Support SVG and SWF images (thanks to Stefan Rank).
654   - Generate valid XHTML for centered images with targets.
655     Use CSS classes instead of "align" tags for image alignment.
657 * LaTeX2e writer:
659   - Use the ``\url`` command for URLs (breaks long URLs instead of writing
660     into the margin).
661   - Preserve runs of spaces in 'inline literals'.
662   - Deprecate ``figure_footnotes`` setting.
663   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
664   - New ``latex_preamble`` setting.
665   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
666   - `hyperref` package called with ``unicode`` option (see the
667     `hyperref config tips`__ for how to override).
668   - Drop the special `output_encoding`__ default ("latin-1").
669     The Docutils wide default (usually "UTF-8") is used instead.
671 __ docs/user/config.html#docutils-footnotes
672 __ docs/user/latex.html#hyperlinks
673 __ docs/user/latex.html#output-encoding
675 * manpage writer:
677   - Titles level 1, that is ``.SH``, always uppercase.
678   - Apply patch from mg: literal text should be bold in man-pages.
680 General:
682 * io.FileInput opens files as text files with universal newline support
683   (mode "rU", configurable with the new optional argument "mode").
685 * setup.py:
687   - Python 3 support: copy test/ and tools/ to the build-dir
688     and convert Python sources with 2to3.
691 Release 0.6 (2009-10-11)
692 ========================
694 .. Note::
696    Docutils 0.5 is the last version supporting Python 2.2.
698    Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
699    and convertible to 3.1 code.
701 .. note::
703    The "newlatex" writer is orphaned.
705    The recommended way to generate PDF output is to use either the
706    LaTeX2e writer or one of the alternatives listed at
707    http://docutils.sourceforge.net/docs/user/links.html#pdf.
709 * reStructuredText:
711   - Allow length units for all length specifications.
712   - Allow percent sign in "scale" argument of "figure" and "image" directives.
713   - Bugfix: The "figalign" argument of a figure now works as intended
714     (aligning the figure not its contents).
715   - Align images with class "align-[right|center|left]"
716     (allows setting the alignment of an image in a figure).
717   - Hard tabs in literal inclusions are replaced by spaces. This is
718     configurable via the new "tab-width" option of the "include" directive
719     (a negative tab-width prevents tab expansion).
721 * HTML writer:
723   - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
724     separated list of stylesheets.
726 * LaTeX2e writer:
728   - New defaults:
729     - font-encoding: "T1" (formerly implicitly set by 'ae').
730     - use-latex-toc: true (ToC with page numbers).
731     - use-latex-footnotes: true (no mixup with figures).
732     - Float placement defaults to "here definitely" (configurable).
733     - Align of image in a figure defaults to 'center'.
734     - Use class defaults for page margins ('typearea' now optional).
735   - Support LaTeX packages as ``--stylesheet`` arguments.
736   - Use ``bp`` for lengths without unit or unit ``pt``,
737     do not convert ``px`` to ``pt``.
738   - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
739   - Set sub- and superscript role argument as text not math.
740   - Support custom roles based on standard roles.
741   - Load packages and define macros only if required in the document.
742   - All Docutils specific LaTeX macros are prefixed with ``DU``.
743   - Better conformance to Docutils specifications with "use_latex_toc".
744   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
745     section numbering by LaTeX.
746   - Use default font in admonitions and sidebar.
747   - Typeset generic topic as "quote with title".
748   - Use template (file and configuration option).
749   - Render doctest blocks as literal blocks (indented).
751 * ODT writer:
753   - moved from sandbox to Doctutils core.
755 * manpage writer:
757   - moved from sandbox to Doctutils core.
760 Release 0.5 (2008-06-25)
761 ========================
763 Components:
765 * HTML writer.
767   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
768     universally supported now).
770 * LaTeX2e writer:
772   - Better bibTeX citation support.
773   - Add ``--literal-block-env``
775 * PEP writer:
777   - Changed to support new python.org website structure and
778     pep2pyramid.py.
780 reStructuredText:
782 * Changed the directive API to a new object-oriented system.
783   (Compatibility for the old, functional-style directive interface is
784   retained.)  See the updated `Creating reStructuredText Directives`__
785   how-to.
787   __ docs/howto/rst-directives.html
789 * Allow ``+`` and ``:`` in reference names requested for citations.
791 Documentation:
793 * Added `Deploying Docutils Securely`__
795   __ docs/howto/security.txt
797 Internationalization:
799 * Added hebrew mappings.
801 General:
803 * Configuration files are now assumed and required to be
804   UTF-8-encoded.
806 * Added docutils/writers/html4css1/template.txt.
808 * Enhance emacs support.
811 Release 0.4 (2006-01-09)
812 ========================
814 .. Note::
816    Docutils 0.4.x is the last version that will support Python 2.1.
817    Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
818    or later will be required.
820    Docutils 0.4.x is the last version that will make compromises in
821    its HTML output for Netscape Navigator 4.  Docutils 0.5 will
822    require more up-to-date browsers (the exact definition is to be
823    determined).
825 Components:
827 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
828   multi-platform, multi-browser HTML slide shows.
830   __ docs/user/slide-shows.html
831   __ docs/user/tools.html#rst2s5-py
833 * The newlatex2e writer is nearing completion.
835 * Added a DocTree reader, ``publish_doctree`` and
836   ``publish_from_doctree`` convenience functions, for document tree
837   extraction and reprocessing.
839 reStructuredText:
841 * Added directives: "container__" (generic block-level container),
842   "default-role__" (role used for \`backtick\` syntax), "title__"
843   (document title metadata), and "date__" (generate the current local
844   date, for substitution definitions).
846   __ docs/ref/rst/directives.html#container
847   __ docs/ref/rst/directives.html#default-role
848   __ docs/ref/rst/directives.html#title
849   __ docs/ref/rst/directives.html#date
851 * Length units are now supported for image__ sizes.
853   __ docs/ref/rst/directives.html#image
855 * Added `standard definition files`__ for special characters etc.
857   __ docs/ref/rst/definitions.html
859 Internationalization:
861 * Added Japanese and Simplified Chinese language mappings, and support
862   for double-width CJK-characters in tables and section titles.
864 Documentation:
866 * Added a `guide for distributors`__ (package maintainers) and a
867   `guide for developers`__.
869   __ docs/dev/distributing.html
870   __ docs/dev/hacking.html
872 General:
874 * Added significant `Emacs support for reST`__.
876   __ docs/user/emacs.html
878 * Added a `--strip-comments`__ option.
880   __ docs/user/config.html#strip-comments
882 * `--embed-stylesheet`__ is now the default for the HTML writer
883   (rather than --link-stylesheet).
885   __ docs/user/config.html#embed-stylesheet
888 Release 0.3.9 (2005-05-26)
889 ==========================
891 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
893   __ docs/user/config.html#file-insertion-enabled
894   __ docs/user/config.html#raw-enabled
896 * Added `auto-enumerated lists`__.
898   __ docs/ref/rst/restructuredtext.html#enumerated-lists
900 * Added `"header" and "footer"`__ directives.
902   __ docs/ref/rst/directives.html#document-header-footer
904 * Added "list-table__" directive.
906   __ docs/ref/rst/directives.html#list-table
908 * Added support for `section subtitles`__.
910   __ docs/user/config.html#sectsubtitle-xform
912 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
914   __ docs/user/config.html#field-name-limit
915   __ docs/user/config.html#option-limit
917 * Added "cloak_email_addresses__" setting to HTML writer.
919   __ docs/user/config.html#cloak-email-addresses
921 * UTF-8 BOMs are now removed from the input stream.
924 Release 0.3.7 (2004-12-24)
925 ==========================
927 * A special "`line block`__" syntax has been added.  (Also see the
928   `quick reference`__.)
930   __ docs/ref/rst/restructuredtext.html#line-blocks
931   __ docs/user/rst/quickref.html#line-blocks
933 * Empty sections are now allowed.
935 * A "raw__" role has been added.
937   __ docs/ref/rst/roles.html#raw
939 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
940   so that they are no longer transformed by LaTeX to en or em dashes.
941   (Please see the FAQ__ for how to represent such dashes.)
943   __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
945 * A `dependency recorder`__ has been added.
947   __ docs/user/config.html#record-dependencies
949 * A directive has been added for `compound paragraphs`__.
951   __ docs/ref/rst/directives.html#compound-paragraph
954 Release 0.3.5 (2004-07-29)
955 ==========================
957 * Improved, extended and reorganized the documentation__.
959   __ docs/index.html
961 * Added "csv-table__" directive.
963   __ docs/ref/rst/directives.html#csv-table
965 .. _HISTORY: HISTORY.html
966 .. _Python 3 compatibility: README.html#python-3-compatibility