1 .. -*- coding: utf-8 -*-
3 ========================
5 ========================
7 :Contact: grubert@users.sourceforge.net
8 :Maintainer: docutils-develop@lists.sourceforge.net
11 :Web site: http://docutils.sourceforge.net/
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`_.
24 The default for the configuration setting `legacy_class_functions`_ will
25 change to "False". Adapt stylesheets modifying ``\DUadmonition``
26 and/or ``\DUtitle`` or set to "True".
29 Do not use <h1> for section headings when it is used for the document
30 title. https://www.w3.org/wiki/HTML/Usage/Headings/h1only
32 Use <blockquote> instead of <div> tags for topics and admonitions.
34 * ``Node.traverse()`` will return an iterator instead of a list.
36 * Remove ``utils.unique_combinations``
37 (obsoleted by ``itertools.combinations``).
39 * Eventually remove the "rawsource" attribute and argument from nodes.Text: we
40 store the null-escaped text in Text nodes since 0.16 so there is no additional
41 information in the rawsource.
43 * If the id_prefix_ setting is non-empty, leading number and hyphen characters
44 will not be stripped from a `reference name`_ during `identifier
45 normalization`_. This may change generated `identifier keys`.
47 Example: with ``--id-prefix="DU-"``, a section with title "34. May"
48 currently gets the identifier key ``DU-may`` and after the change the
49 identifier key ``DU-34-may``.
51 * The default value for auto_id_prefix_ will change to "%". This means
52 auto-generated IDs will use the tag name as prefix. Set auto_id_prefix_ to
53 "id" if you want unchanged auto-IDs or to "%" if you want descriptive IDs.
55 * The default HTML writer "html" with frontend ``rst2html.py`` may change
56 from "html4css1" to "html5".
58 Use ``get_writer_by_name('html')`` or the rst2html.py_ front end, if you
59 want the output to be up-to-date automatically.
61 Use a specific writer name or front end, if you depend on stability of the
62 generated HTML code, e.g. because you use a custom style sheet or
63 post-processing that may break otherwise.
65 .. _id_prefix: docs/user/config.html#id-prefix
66 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
67 .. _rst2html.py: docs/user/tools.html#rst2html-py
68 .. _reference name: docs/ref/rst/restructuredtext.html#reference-names
69 .. _identifier normalization: directives.html#identifier-normalization
75 * Installing with ``setup.py`` now requires setuptools_.
76 Alternatively, install with pip_.
80 - Use the new semantic tags <main>, <section>, <header>,
81 <footer>, <aside>, <figure>, and <figcaption>.
82 See ``minimal.css`` and ``plain.css`` for styling rule examples.
84 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
85 <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
86 is found in `inline` and `literal` elements.
87 Use <ins> and <del> if a matching class value
88 is found in `inline`, `literal`, or `container` elements.
90 - Wrap block-level image elements in <p> (except for figures).
91 Move non-essential styling from ``minimal.css`` to ``plain.css``.
92 Support numbered figures in ``plain.css``.
97 - New configuration setting `legacy_class_functions`_.
99 - `Styling commands`__ using the legacy ``\docutilsrole`` prefix are
100 now ignored. Use ``\DUrole``.
102 __ docs/user/latex.html#classes
104 .. _setuptools: https://pypi.org/project/setuptools/
105 .. _pip: https://pypi.org/project/pip/
106 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
109 Release 0.16 (2020-01-12)
110 =========================
114 Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
116 Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
117 without the use of the ``2to3`` tool.
121 - Keep `backslash escapes`__ in the document tree. This allows, e.g.,
122 escaping of author-separators in `bibliographic fields`__.
124 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
125 __ docs/ref/rst/restructuredtext.html#bibliographic-fields
129 - Informal titles of type "rubric" default to bold-italic and left aligned.
130 - Deprecate ``\docutilsrole`` prefix for styling commands:
131 use ``\DUrole`` instead.
132 - Fix topic subtitle.
133 - Add "latex writers" to the `config_section_dependencies`.
134 - Ignore classes for `rubric` elements
135 (class wrapper interferes with LaTeX formatting).
139 - New option "--html-writer" allows to select "html__" (default),
142 __ html: docs/user/html.html#html
146 - Remove the `handle_io_errors` option from io.FileInput/Output.
150 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
152 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
154 * Various bugfixes and improvements (see HISTORY_).
157 Release 0.15 (2019-07-20)
158 =========================
162 Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
165 Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
166 (cf. `Python 3 compatibility`_).
170 - Allow embedded colons in field list field names (before, tokens like
171 ``:this:example:`` were considered ordinary text).
173 - Fixed a bug with the "trim" options of the "unicode" directive.
175 * languages: Added Korean localisation (ko).
178 Release 0.14 (2017-08-03)
179 =========================
181 * docutils/docs/ref/docutils.dtd:
183 - Enable validation of Docutils XML documents against the DTD:
185 * docutils/parsers/rst/:
187 - Added functionality: escaped whitespace in URI contexts.
188 - Consistent handling of all whitespace characters in inline markup
189 recognition. (May break documents that relied on some whitespace
190 characters (NBSP, ...) *not* to be recognized as whitespace.)
192 * docutils/utils/smartquotes.py:
194 - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
195 - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
196 - Differentiate apostrophe from closing single quote (if possible).
197 - Add command line interface for stand-alone use (requires 2.7).
199 * docutils/writers/_html_base:
201 - Provide default title in metadata.
202 - The MathJax CDN shut down on April 30, 2017. For security reasons, we
203 don't use a third party public installation as default but warn
204 if `math-output` is set to MathJax without specifying a URL.
205 See math-output_ for details.
207 * docutils/writers/html4css1:
209 - Respect automatic table column sizing.
211 * docutils/writers/latex2e/__init__.py
213 - Handle class arguments for block-level elements by wrapping them
214 in a "DUclass" environment. This replaces the special handling for
215 "epigraph" and "topic" elements.
217 * docutils/writers/odf_odt:
219 - Language option sets ODF document's default language
220 - Image width, scale, ... set image size in generated ODF.
224 - New front-end ``rst2html4.py``.
227 Release 0.13.1 (2016-12-09)
228 ===========================
230 * docutils/writers/html5_polyglot
232 - New HTML writer generating `HTML 5`_.
234 .. _HTML 5: http://www.w3.org/TR/html5/
238 - New front-end ``rst2html5.py``.
240 * languages: persian/farsi (fa) and latvian (la) mappings.
242 * change default base url for :rfc: to http://tools.ietf.org/html/
244 * tables accept widths, a list and align
246 * latex2e: Fix admonition width, remove deprecated options,
247 better tablewidth auto, ...
249 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
252 Release 0.12 (2014-07-06)
253 =========================
255 Small changes only, release current state
258 Release 0.11 (2013-07-22)
259 =========================
263 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
264 - Support embedded aliases within hyperlink references.
265 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
266 language module) before global search.
268 * docutils/parsers/rst/directives/tables.py
270 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
272 * docutils/writers/html4css1/__init__.py
273 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
274 - New setting `stylesheet_dirs` (see above).
276 Now, it is easy to add a custom stylesheet to Docutils' default
277 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
279 Changed behaviour of the default settings:
280 if there is a file ``html4css1.css`` in the working directory of the
281 process at launch, it is used instead of the one provided by Docutils
282 in the writer source directory.
284 - New default for math-output_: ``HTML math.css``.
285 - Avoid repeated class declarations in html4css1 writer
286 (modified version of patch [ 104 ]).
288 .. _math-output: docs/user/config.html#math-output
290 * docutils/writers/latex2e/__init__.py
292 - Drop the simple algorithm replacing straight double quotes with
293 English typographic ones.
294 Activate the SmartQuotes_ transform if you want this feature.
295 - New setting `stylesheet_dirs`: Comma-separated list of directories
296 where stylesheets are found. Used by `stylesheet_path` when expanding
297 relative path arguments.
299 .. _SmartQuotes: docs/user/config.html#smart-quotes
301 * docutils/writers/manpage.py
303 - Fix [3607063] handle lines starting with a period.
304 - Fix option separating comma was bold (thanks to Bill Morris).
306 Release 0.10 (2012-12-16)
307 =========================
311 Docutils 0.9.x is the last version supporting Python 2.3.
313 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
314 (cf. `Python 3 compatibility`_).
318 - SmartQuotes transform for typographic quotes and dashes.
320 - ``docutils/math``, ``docutils/error_reporting.py``, and
321 ``docutils/urischemes.py`` moved to the utils package.
322 Code importing these modules needs to adapt, e.g.::
325 import docutils.math as math
327 import docutils.utils.math as math
329 - enhanced math and error handling.
333 - FileInput/FileOutput: no system-exit on IOError.
334 The `handle_io_errors` option is ignored.
336 * docutils/writers/html4css1/__init__.py
338 - Use ``<code>`` tag for inline "code",
339 do not drop nested inline nodes (syntax highlight tokens).
340 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
341 - No line break after opening inline math tag.
343 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
345 - Fix section numbering by LaTeX.
347 * docutils/writers/s5_html/__init__.py
349 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
352 Release 0.9.1 (2012-06-17)
353 ==========================
357 Several fixes for Python 3 usage.
361 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
362 installed in the PYTHONPATH. Converted tests are now
363 stored in ``docutils/test3/``, tools no longer need conversion.
365 If you installed one of Docutils versions 0.7 ... 0.9 with
366 ``setup.py install`` under Python 3, remove the spurious
367 ``test/`` and ``tools/`` directories in the site library root.
370 Release 0.9 (2012-05-02)
371 =========================
375 - reStructuredText "code" role and directive with syntax highlighting
377 - "code" option of the "include" directive.
379 .. _Pygments: http://pygments.org/
381 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
382 characters and "international" quotes around inline markup.
384 - Fix handling of missing stylesheets.
388 - Fix [ 2971827 ] and [ 3442827 ]
389 extras/roman.py moved to docutils/utils/roman.py
391 * docutils/utils.py -> docutils/utils/__init__.py
393 - docutils.utils is now a package (providing a place for sub-modules)
395 * docutils/writers/html4css1/__init__.py
397 - change default for `math-output` setting to MathJax
399 * docutils/writers/latex2e/__init__.py
401 - Support the `abbreviation` and `acronym` standard roles.
402 - Record only files required to generate the LaTeX source as dependencies.
403 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
404 when suppressing LaTeX section numbering.
407 Release 0.8.1 (2011-08-30)
408 ==========================
412 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
413 and [ 3395920 ] (correct copyright info for rst.el).
415 * docutils/writers/latex2e/__init__.py
417 - Clean up Babel language setting. Restores Sphinx compatibility.
420 Release 0.8 (2011-07-07)
421 ========================
425 - Some additions to the Docutils core are released under the 2-Clause BSD
430 - Handle language codes according to `BCP 47`_.
431 - If the specified langauage is not supported by Docutils,
432 warn and fall back to English.
433 - Math support: reStructuredText "math" role and directive,
434 ``math`` and ``math_block`` doctree elements.
435 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
437 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
441 - most directives now support a "name" option that attaches a
442 reference name. So you can write ::
444 .. figure:: image.png
447 as a short form of ::
451 .. figure:: image.png
453 Internationalization:
455 * Added lithuanian mappings.
461 - New setting "math-output" with support for HTML, MathML, and LaTeX.
465 - Convert image URI to a local file path.
466 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
467 has more than one paragraph (Wolfgang Scherer).
471 - New writer generating LaTeX code for compiling with ``xelatex``.
473 XeTeX uses unicode and modern font technologies.
475 * and fixes and enhancements here and there.
478 Release 0.7 (2010-07-07)
479 ========================
485 - Support SVG and SWF images (thanks to Stefan Rank).
486 - Generate valid XHTML for centered images with targets.
487 Use CSS classes instead of "align" tags for image alignment.
491 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
493 - Preserve runs of spaces in 'inline literals'.
494 - Deprecate ``figure_footnotes`` setting.
495 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
496 - New ``latex_preamble`` setting.
497 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
498 - `hyperref` package called with ``unicode`` option (see the
499 `hyperref config tips`__ for how to override).
500 - Drop the special `output_encoding`__ default ("latin-1").
501 The Docutils wide default (usually "UTF-8") is used instead.
503 __ docs/user/config.html#docutils-footnotes
504 __ docs/user/latex.html#hyperlinks
505 __ docs/user/latex.html#output-encoding
509 - Titles level 1, that is ``.SH``, always uppercase.
510 - Apply patch from mg: literal text should be bold in man-pages.
514 * io.FileInput opens files as text files with universal newline support
515 (mode "rU", configurable with the new optional argument "mode").
519 - Python 3 support: copy test/ and tools/ to the build-dir
520 and convert Python sources with 2to3.
523 Release 0.6 (2009-10-11)
524 ========================
528 Docutils 0.5 is the last version supporting Python 2.2.
530 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
531 and convertible to 3.1 code.
535 The "newlatex" writer is orphaned.
537 The recommended way to generate PDF output is to use either the
538 LaTeX2e writer or one of the alternatives listed at
539 http://docutils.sourceforge.net/docs/user/links.html#pdf.
543 - Allow length units for all length specifications.
544 - Allow percent sign in "scale" argument of "figure" and "image" directives.
545 - Bugfix: The "figalign" argument of a figure now works as intended
546 (aligning the figure not its contents).
547 - Align images with class "align-[right|center|left]"
548 (allows setting the alignment of an image in a figure).
549 - Hard tabs in literal inclusions are replaced by spaces. This is
550 configurable via the new "tab-width" option of the "include" directive
551 (a negative tab-width prevents tab expansion).
555 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
556 separated list of stylesheets.
561 - font-encoding: "T1" (formerly implicitely set by 'ae').
562 - use-latex-toc: true (ToC with page numbers).
563 - use-latex-footnotes: true (no mixup with figures).
564 - Float placement defaults to "here definitely" (configurable).
565 - Align of image in a figure defaults to 'center'.
566 - Use class defaults for page margins ('typearea' now optional).
567 - Support LaTeX packages as ``--stylesheet`` arguments.
568 - Use ``bp`` for lengths without unit or unit ``pt``,
569 do not convert ``px`` to ``pt``.
570 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
571 - Set sub- and superscript role argument as text not math.
572 - Support custom roles based on standard roles.
573 - Load packages and define macros only if required in the document.
574 - All Docutils specific LaTeX macros are prefixed with ``DU``.
575 - Better conformance to Docutils specifications with "use_latex_toc".
576 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
577 section numbering by LaTeX.
578 - Use default font in admonitions and sidebar.
579 - Typeset generic topic as "quote with title".
580 - Use template (file and configuration option).
581 - Render doctest blocks as literal blocks (indented).
585 - moved from sandbox to Doctutils core.
589 - moved from sandbox to Doctutils core.
592 Release 0.5 (2008-06-25)
593 ========================
599 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
600 universally supported now).
604 - Better bibTeX citation support.
605 - Add ``--literal-block-env``
609 - Changed to support new python.org website structure and
614 * Changed the directive API to a new object-oriented system.
615 (Compatibility for the old, functional-style directive interface is
616 retained.) See the updated `Creating reStructuredText Directives`__
619 __ docs/howto/rst-directives.html
621 * Allow ``+`` and ``:`` in reference names requested for citations.
625 * Added `Deploying Docutils Securely`__
627 __ docs/howto/security.txt
629 Internationalization:
631 * Added hebrew mappings.
635 * Configuration files are now assumed and required to be
638 * Added docutils/writers/html4css1/template.txt.
640 * Enhance emacs support.
643 Release 0.4 (2006-01-09)
644 ========================
648 Docutils 0.4.x is the last version that will support Python 2.1.
649 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
650 or later will be required.
652 Docutils 0.4.x is the last version that will make compromises in
653 its HTML output for Netscape Navigator 4. Docutils 0.5 will
654 require more up-to-date browsers (the exact definition is to be
659 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
660 multi-platform, multi-browser HTML slide shows.
662 __ docs/user/slide-shows.html
663 __ docs/user/tools.html#rst2s5-py
665 * The newlatex2e writer is nearing completion.
667 * Added a DocTree reader, ``publish_doctree`` and
668 ``publish_from_doctree`` convenience functions, for document tree
669 extraction and reprocessing.
673 * Added directives: "container__" (generic block-level container),
674 "default-role__" (role used for \`backtick\` syntax), "title__"
675 (document title metadata), and "date__" (generate the current local
676 date, for substitution definitions).
678 __ docs/ref/rst/directives.html#container
679 __ docs/ref/rst/directives.html#default-role
680 __ docs/ref/rst/directives.html#title
681 __ docs/ref/rst/directives.html#date
683 * Length units are now supported for image__ sizes.
685 __ docs/ref/rst/directives.html#image
687 * Added `standard definition files`__ for special characters etc.
689 __ docs/ref/rst/definitions.html
691 Internationalization:
693 * Added Japanese and Simplified Chinese language mappings, and support
694 for double-width CJK-characters in tables and section titles.
698 * Added a `guide for distributors`__ (package maintainers) and a
699 `guide for developers`__.
701 __ docs/dev/distributing.html
702 __ docs/dev/hacking.html
706 * Added significant `Emacs support for reST`__.
708 __ docs/user/emacs.html
710 * Added a `--strip-comments`__ option.
712 __ docs/user/config.html#strip-comments
714 * `--embed-stylesheet`__ is now the default for the HTML writer
715 (rather than --link-stylesheet).
717 __ docs/user/config.html#embed-stylesheet
720 Release 0.3.9 (2005-05-26)
721 ==========================
723 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
725 __ docs/user/config.html#file-insertion-enabled
726 __ docs/user/config.html#raw-enabled
728 * Added `auto-enumerated lists`__.
730 __ docs/ref/rst/restructuredtext.html#enumerated-lists
732 * Added `"header" and "footer"`__ directives.
734 __ docs/ref/rst/directives.html#document-header-footer
736 * Added "list-table__" directive.
738 __ docs/ref/rst/directives.html#list-table
740 * Added support for `section subtitles`__.
742 __ docs/user/config.html#sectsubtitle-xform
744 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
746 __ docs/user/config.html#field-name-limit
747 __ docs/user/config.html#option-limit
749 * Added "cloak_email_addresses__" setting to HTML writer.
751 __ docs/user/config.html#cloak-email-addresses
753 * UTF-8 BOMs are now removed from the input stream.
756 Release 0.3.7 (2004-12-24)
757 ==========================
759 * A special "`line block`__" syntax has been added. (Also see the
760 `quick reference`__.)
762 __ docs/ref/rst/restructuredtext.html#line-blocks
763 __ docs/user/rst/quickref.html#line-blocks
765 * Empty sections are now allowed.
767 * A "raw__" role has been added.
769 __ docs/ref/rst/roles.html#raw
771 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
772 so that they are no longer transformed by LaTeX to en or em dashes.
773 (Please see the FAQ__ for how to represent such dashes.)
775 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
777 * A `dependency recorder`__ has been added.
779 __ docs/user/config.html#record-dependencies
781 * A directive has been added for `compound paragraphs`__.
783 __ docs/ref/rst/directives.html#compound-paragraph
786 Release 0.3.5 (2004-07-29)
787 ==========================
789 * Improved, extended and reorganized the documentation__.
793 * Added "csv-table__" directive.
795 __ docs/ref/rst/directives.html#csv-table
797 .. _HISTORY: HISTORY.html
798 .. _Python 3 compatibility: README.html#python-3-compatibility