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 Use <blockquote> instead of <div> tags for topics and admonitions.
31 Use <summary> and <details> tags for term and definition of a
32 definition list with class value "details".
35 Remove the IE PNG Fix by Angus Turnbull. IE has native PNG
36 support since version 7.
38 * ``Node.traverse()`` will return an iterator instead of a list.
40 * Remove ``utils.unique_combinations``
41 (obsoleted by ``itertools.combinations``).
43 * Eventually remove the "rawsource" attribute and argument from nodes.Text:
44 we store the null-escaped text in Text nodes since 0.16 so there is no
45 additional information in the rawsource.
47 * If the id_prefix_ setting is non-empty, leading number and hyphen characters
48 will not be stripped from a `reference name`_ during `identifier
49 normalization`_. This may change generated `identifier keys`.
51 Example: with ``--id-prefix="DU-"``, a section with title "34. May"
52 currently gets the identifier key ``DU-may`` and after the change the
53 identifier key ``DU-34-may``.
55 * The default value for auto_id_prefix_ will change to "%". This means
56 auto-generated IDs will use the tag name as prefix. Set auto_id_prefix_ to
57 "id" if you want unchanged auto-IDs or to "%" if you want descriptive IDs.
59 * The default HTML writer "html" with frontend ``rst2html.py`` may change
60 from "html4css1" to "html5".
62 Use ``get_writer_by_name('html')`` or the rst2html.py_ front end, if you
63 want the output to be up-to-date automatically.
65 Use a specific writer name or front end, if you depend on stability of the
66 generated HTML code, e.g. because you use a custom style sheet or
67 post-processing that may break otherwise.
69 .. _id_prefix: docs/user/config.html#id-prefix
70 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
71 .. _rst2html.py: docs/user/tools.html#rst2html-py
72 .. _reference name: docs/ref/rst/restructuredtext.html#reference-names
73 .. _identifier normalization: directives.html#identifier-normalization
79 * Installing with ``setup.py`` now requires setuptools_.
80 Alternatively, install with pip_.
84 - Use the new semantic tags <main>, <section>, <header>,
85 <footer>, <aside>, <figure>, and <figcaption>.
86 See ``minimal.css`` and ``plain.css`` for styling rule examples.
88 Change the `initial_header_level`_ setting's default to "2", as browsers
89 use the `same style for <h1> and <h2> when nested in a section`__.
91 - Use HTML text-level tags <small>, <s>, <q>, <dfn>, <var>, <samp>, <kbd>,
92 <i>, <b>, <u>, <mark>, and <bdi> if a matching class value
93 is found in `inline` and `literal` elements.
94 Use <ins> and <del> if a matching class value
95 is found in `inline`, `literal`, or `container` elements.
97 - Wrap block-level image elements in <p> (except for figures).
98 Move non-essential styling from ``minimal.css`` to ``plain.css``.
99 Support numbered figures in ``plain.css``.
101 .. _initial_header_level: docs/user/config.html#initial-header-level
102 __ https://stackoverflow.com/questions/39547412/same-font-size-for-h1-and-h2-in-article
108 - New configuration setting `legacy_class_functions`_.
110 - The special value "auto" for the `graphicx_option`_ setting
111 is no longer supported (it never worked for xetex/luatex).
113 - `Styling commands`__ using the legacy ``\docutilsrole`` prefix are
114 now ignored. Use ``\DUrole``.
116 __ docs/user/latex.html#classes
118 - Most helper commands and element definitions are now defined in the
119 LaTeX package `docutils.sty`_ and only inserted in the document
120 preamble if the stylesheet__ setting does not lists "docutils".
122 __ docs/user/config.html#stylesheet-latex-writers
124 .. _setuptools: https://pypi.org/project/setuptools/
125 .. _pip: https://pypi.org/project/pip/
126 .. _legacy_class_functions: docs/user/config.html#legacy-class-functions
127 .. _graphicx_option: docs/user/config.html#graphicx-option
128 .. _docutils.sty: https://ctan.org/pkg/docutils
131 Release 0.16 (2020-01-12)
132 =========================
136 Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
138 Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
139 without the use of the ``2to3`` tool.
143 - Keep `backslash escapes`__ in the document tree. This allows, e.g.,
144 escaping of author-separators in `bibliographic fields`__.
146 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
147 __ docs/ref/rst/restructuredtext.html#bibliographic-fields
151 - Informal titles of type "rubric" default to bold-italic and left aligned.
152 - Deprecate ``\docutilsrole`` prefix for styling commands:
153 use ``\DUrole`` instead.
154 - Fix topic subtitle.
155 - Add "latex writers" to the `config_section_dependencies`.
156 - Ignore classes for `rubric` elements
157 (class wrapper interferes with LaTeX formatting).
161 - New option "--html-writer" allows to select "html__" (default),
164 __ html: docs/user/html.html#html
168 - Remove the `handle_io_errors` option from io.FileInput/Output.
172 - If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
174 .. _auto_id_prefix: docs/user/config.html#auto-id-prefix
176 * Various bugfixes and improvements (see HISTORY_).
179 Release 0.15 (2019-07-20)
180 =========================
184 Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
187 Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
188 (cf. `Python 3 compatibility`_).
192 - Allow embedded colons in field list field names (before, tokens like
193 ``:this:example:`` were considered ordinary text).
195 - Fixed a bug with the "trim" options of the "unicode" directive.
197 * languages: Added Korean localisation (ko).
200 Release 0.14 (2017-08-03)
201 =========================
203 * docutils/docs/ref/docutils.dtd:
205 - Enable validation of Docutils XML documents against the DTD:
207 * docutils/parsers/rst/:
209 - Added functionality: escaped whitespace in URI contexts.
210 - Consistent handling of all whitespace characters in inline markup
211 recognition. (May break documents that relied on some whitespace
212 characters (NBSP, ...) *not* to be recognized as whitespace.)
214 * docutils/utils/smartquotes.py:
216 - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
217 - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
218 - Differentiate apostrophe from closing single quote (if possible).
219 - Add command line interface for stand-alone use (requires 2.7).
221 * docutils/writers/_html_base:
223 - Provide default title in metadata.
224 - The MathJax CDN shut down on April 30, 2017. For security reasons, we
225 don't use a third party public installation as default but warn
226 if `math-output` is set to MathJax without specifying a URL.
227 See math-output_ for details.
229 * docutils/writers/html4css1:
231 - Respect automatic table column sizing.
233 * docutils/writers/latex2e/__init__.py
235 - Handle class arguments for block-level elements by wrapping them
236 in a "DUclass" environment. This replaces the special handling for
237 "epigraph" and "topic" elements.
239 * docutils/writers/odf_odt:
241 - Language option sets ODF document's default language
242 - Image width, scale, ... set image size in generated ODF.
246 - New front-end ``rst2html4.py``.
249 Release 0.13.1 (2016-12-09)
250 ===========================
252 * docutils/writers/html5_polyglot
254 - New HTML writer generating `HTML 5`_.
256 .. _HTML 5: http://www.w3.org/TR/html5/
260 - New front-end ``rst2html5.py``.
262 * languages: persian/farsi (fa) and latvian (la) mappings.
264 * change default base url for :rfc: to http://tools.ietf.org/html/
266 * tables accept widths, a list and align
268 * latex2e: Fix admonition width, remove deprecated options,
269 better tablewidth auto, ...
271 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
274 Release 0.12 (2014-07-06)
275 =========================
277 Small changes only, release current state
280 Release 0.11 (2013-07-22)
281 =========================
285 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
286 - Support embedded aliases within hyperlink references.
287 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
288 language module) before global search.
290 * docutils/parsers/rst/directives/tables.py
292 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
294 * docutils/writers/html4css1/__init__.py
295 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
296 - New setting `stylesheet_dirs` (see above).
298 Now, it is easy to add a custom stylesheet to Docutils' default
299 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
301 Changed behaviour of the default settings:
302 if there is a file ``html4css1.css`` in the working directory of the
303 process at launch, it is used instead of the one provided by Docutils
304 in the writer source directory.
306 - New default for math-output_: ``HTML math.css``.
307 - Avoid repeated class declarations in html4css1 writer
308 (modified version of patch [ 104 ]).
310 .. _math-output: docs/user/config.html#math-output
312 * docutils/writers/latex2e/__init__.py
314 - Drop the simple algorithm replacing straight double quotes with
315 English typographic ones.
316 Activate the SmartQuotes_ transform if you want this feature.
317 - New setting `stylesheet_dirs`: Comma-separated list of directories
318 where stylesheets are found. Used by `stylesheet_path` when expanding
319 relative path arguments.
321 .. _SmartQuotes: docs/user/config.html#smart-quotes
323 * docutils/writers/manpage.py
325 - Fix [3607063] handle lines starting with a period.
326 - Fix option separating comma was bold (thanks to Bill Morris).
328 Release 0.10 (2012-12-16)
329 =========================
333 Docutils 0.9.x is the last version supporting Python 2.3.
335 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
336 (cf. `Python 3 compatibility`_).
340 - SmartQuotes transform for typographic quotes and dashes.
342 - ``docutils/math``, ``docutils/error_reporting.py``, and
343 ``docutils/urischemes.py`` moved to the utils package.
344 Code importing these modules needs to adapt, e.g.::
347 import docutils.math as math
349 import docutils.utils.math as math
351 - enhanced math and error handling.
355 - FileInput/FileOutput: no system-exit on IOError.
356 The `handle_io_errors` option is ignored.
358 * docutils/writers/html4css1/__init__.py
360 - Use ``<code>`` tag for inline "code",
361 do not drop nested inline nodes (syntax highlight tokens).
362 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
363 - No line break after opening inline math tag.
365 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
367 - Fix section numbering by LaTeX.
369 * docutils/writers/s5_html/__init__.py
371 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
374 Release 0.9.1 (2012-06-17)
375 ==========================
379 Several fixes for Python 3 usage.
383 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
384 installed in the PYTHONPATH. Converted tests are now
385 stored in ``docutils/test3/``, tools no longer need conversion.
387 If you installed one of Docutils versions 0.7 ... 0.9 with
388 ``setup.py install`` under Python 3, remove the spurious
389 ``test/`` and ``tools/`` directories in the site library root.
392 Release 0.9 (2012-05-02)
393 =========================
397 - reStructuredText "code" role and directive with syntax highlighting
399 - "code" option of the "include" directive.
401 .. _Pygments: http://pygments.org/
403 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
404 characters and "international" quotes around inline markup.
406 - Fix handling of missing stylesheets.
410 - Fix [ 2971827 ] and [ 3442827 ]
411 extras/roman.py moved to docutils/utils/roman.py
413 * docutils/utils.py -> docutils/utils/__init__.py
415 - docutils.utils is now a package (providing a place for sub-modules)
417 * docutils/writers/html4css1/__init__.py
419 - change default for `math-output` setting to MathJax
421 * docutils/writers/latex2e/__init__.py
423 - Support the `abbreviation` and `acronym` standard roles.
424 - Record only files required to generate the LaTeX source as dependencies.
425 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
426 when suppressing LaTeX section numbering.
429 Release 0.8.1 (2011-08-30)
430 ==========================
434 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
435 and [ 3395920 ] (correct copyright info for rst.el).
437 * docutils/writers/latex2e/__init__.py
439 - Clean up Babel language setting. Restores Sphinx compatibility.
442 Release 0.8 (2011-07-07)
443 ========================
447 - Some additions to the Docutils core are released under the 2-Clause BSD
452 - Handle language codes according to `BCP 47`_.
453 - If the specified langauage is not supported by Docutils,
454 warn and fall back to English.
455 - Math support: reStructuredText "math" role and directive,
456 ``math`` and ``math_block`` doctree elements.
457 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
459 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
463 - most directives now support a "name" option that attaches a
464 reference name. So you can write ::
466 .. figure:: image.png
469 as a short form of ::
473 .. figure:: image.png
475 Internationalization:
477 * Added lithuanian mappings.
483 - New setting "math-output" with support for HTML, MathML, and LaTeX.
487 - Convert image URI to a local file path.
488 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
489 has more than one paragraph (Wolfgang Scherer).
493 - New writer generating LaTeX code for compiling with ``xelatex``.
495 XeTeX uses unicode and modern font technologies.
497 * and fixes and enhancements here and there.
500 Release 0.7 (2010-07-07)
501 ========================
507 - Support SVG and SWF images (thanks to Stefan Rank).
508 - Generate valid XHTML for centered images with targets.
509 Use CSS classes instead of "align" tags for image alignment.
513 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
515 - Preserve runs of spaces in 'inline literals'.
516 - Deprecate ``figure_footnotes`` setting.
517 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
518 - New ``latex_preamble`` setting.
519 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
520 - `hyperref` package called with ``unicode`` option (see the
521 `hyperref config tips`__ for how to override).
522 - Drop the special `output_encoding`__ default ("latin-1").
523 The Docutils wide default (usually "UTF-8") is used instead.
525 __ docs/user/config.html#docutils-footnotes
526 __ docs/user/latex.html#hyperlinks
527 __ docs/user/latex.html#output-encoding
531 - Titles level 1, that is ``.SH``, always uppercase.
532 - Apply patch from mg: literal text should be bold in man-pages.
536 * io.FileInput opens files as text files with universal newline support
537 (mode "rU", configurable with the new optional argument "mode").
541 - Python 3 support: copy test/ and tools/ to the build-dir
542 and convert Python sources with 2to3.
545 Release 0.6 (2009-10-11)
546 ========================
550 Docutils 0.5 is the last version supporting Python 2.2.
552 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
553 and convertible to 3.1 code.
557 The "newlatex" writer is orphaned.
559 The recommended way to generate PDF output is to use either the
560 LaTeX2e writer or one of the alternatives listed at
561 http://docutils.sourceforge.net/docs/user/links.html#pdf.
565 - Allow length units for all length specifications.
566 - Allow percent sign in "scale" argument of "figure" and "image" directives.
567 - Bugfix: The "figalign" argument of a figure now works as intended
568 (aligning the figure not its contents).
569 - Align images with class "align-[right|center|left]"
570 (allows setting the alignment of an image in a figure).
571 - Hard tabs in literal inclusions are replaced by spaces. This is
572 configurable via the new "tab-width" option of the "include" directive
573 (a negative tab-width prevents tab expansion).
577 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
578 separated list of stylesheets.
583 - font-encoding: "T1" (formerly implicitely set by 'ae').
584 - use-latex-toc: true (ToC with page numbers).
585 - use-latex-footnotes: true (no mixup with figures).
586 - Float placement defaults to "here definitely" (configurable).
587 - Align of image in a figure defaults to 'center'.
588 - Use class defaults for page margins ('typearea' now optional).
589 - Support LaTeX packages as ``--stylesheet`` arguments.
590 - Use ``bp`` for lengths without unit or unit ``pt``,
591 do not convert ``px`` to ``pt``.
592 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
593 - Set sub- and superscript role argument as text not math.
594 - Support custom roles based on standard roles.
595 - Load packages and define macros only if required in the document.
596 - All Docutils specific LaTeX macros are prefixed with ``DU``.
597 - Better conformance to Docutils specifications with "use_latex_toc".
598 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
599 section numbering by LaTeX.
600 - Use default font in admonitions and sidebar.
601 - Typeset generic topic as "quote with title".
602 - Use template (file and configuration option).
603 - Render doctest blocks as literal blocks (indented).
607 - moved from sandbox to Doctutils core.
611 - moved from sandbox to Doctutils core.
614 Release 0.5 (2008-06-25)
615 ========================
621 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
622 universally supported now).
626 - Better bibTeX citation support.
627 - Add ``--literal-block-env``
631 - Changed to support new python.org website structure and
636 * Changed the directive API to a new object-oriented system.
637 (Compatibility for the old, functional-style directive interface is
638 retained.) See the updated `Creating reStructuredText Directives`__
641 __ docs/howto/rst-directives.html
643 * Allow ``+`` and ``:`` in reference names requested for citations.
647 * Added `Deploying Docutils Securely`__
649 __ docs/howto/security.txt
651 Internationalization:
653 * Added hebrew mappings.
657 * Configuration files are now assumed and required to be
660 * Added docutils/writers/html4css1/template.txt.
662 * Enhance emacs support.
665 Release 0.4 (2006-01-09)
666 ========================
670 Docutils 0.4.x is the last version that will support Python 2.1.
671 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
672 or later will be required.
674 Docutils 0.4.x is the last version that will make compromises in
675 its HTML output for Netscape Navigator 4. Docutils 0.5 will
676 require more up-to-date browsers (the exact definition is to be
681 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
682 multi-platform, multi-browser HTML slide shows.
684 __ docs/user/slide-shows.html
685 __ docs/user/tools.html#rst2s5-py
687 * The newlatex2e writer is nearing completion.
689 * Added a DocTree reader, ``publish_doctree`` and
690 ``publish_from_doctree`` convenience functions, for document tree
691 extraction and reprocessing.
695 * Added directives: "container__" (generic block-level container),
696 "default-role__" (role used for \`backtick\` syntax), "title__"
697 (document title metadata), and "date__" (generate the current local
698 date, for substitution definitions).
700 __ docs/ref/rst/directives.html#container
701 __ docs/ref/rst/directives.html#default-role
702 __ docs/ref/rst/directives.html#title
703 __ docs/ref/rst/directives.html#date
705 * Length units are now supported for image__ sizes.
707 __ docs/ref/rst/directives.html#image
709 * Added `standard definition files`__ for special characters etc.
711 __ docs/ref/rst/definitions.html
713 Internationalization:
715 * Added Japanese and Simplified Chinese language mappings, and support
716 for double-width CJK-characters in tables and section titles.
720 * Added a `guide for distributors`__ (package maintainers) and a
721 `guide for developers`__.
723 __ docs/dev/distributing.html
724 __ docs/dev/hacking.html
728 * Added significant `Emacs support for reST`__.
730 __ docs/user/emacs.html
732 * Added a `--strip-comments`__ option.
734 __ docs/user/config.html#strip-comments
736 * `--embed-stylesheet`__ is now the default for the HTML writer
737 (rather than --link-stylesheet).
739 __ docs/user/config.html#embed-stylesheet
742 Release 0.3.9 (2005-05-26)
743 ==========================
745 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
747 __ docs/user/config.html#file-insertion-enabled
748 __ docs/user/config.html#raw-enabled
750 * Added `auto-enumerated lists`__.
752 __ docs/ref/rst/restructuredtext.html#enumerated-lists
754 * Added `"header" and "footer"`__ directives.
756 __ docs/ref/rst/directives.html#document-header-footer
758 * Added "list-table__" directive.
760 __ docs/ref/rst/directives.html#list-table
762 * Added support for `section subtitles`__.
764 __ docs/user/config.html#sectsubtitle-xform
766 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
768 __ docs/user/config.html#field-name-limit
769 __ docs/user/config.html#option-limit
771 * Added "cloak_email_addresses__" setting to HTML writer.
773 __ docs/user/config.html#cloak-email-addresses
775 * UTF-8 BOMs are now removed from the input stream.
778 Release 0.3.7 (2004-12-24)
779 ==========================
781 * A special "`line block`__" syntax has been added. (Also see the
782 `quick reference`__.)
784 __ docs/ref/rst/restructuredtext.html#line-blocks
785 __ docs/user/rst/quickref.html#line-blocks
787 * Empty sections are now allowed.
789 * A "raw__" role has been added.
791 __ docs/ref/rst/roles.html#raw
793 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
794 so that they are no longer transformed by LaTeX to en or em dashes.
795 (Please see the FAQ__ for how to represent such dashes.)
797 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
799 * A `dependency recorder`__ has been added.
801 __ docs/user/config.html#record-dependencies
803 * A directive has been added for `compound paragraphs`__.
805 __ docs/ref/rst/directives.html#compound-paragraph
808 Release 0.3.5 (2004-07-29)
809 ==========================
811 * Improved, extended and reorganized the documentation__.
815 * Added "csv-table__" directive.
817 __ docs/ref/rst/directives.html#csv-table
819 .. _HISTORY: HISTORY.html
820 .. _Python 3 compatibility: README.html#python-3-compatibility