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`_.
18 .. _Docutils History: HISTORY.html
25 * The "latex" writer will handle admonitions like other block-level elements
26 and wrap them in a "DUclass" environment. The current implementation fails
27 with some content, see docs/user/latex.txt and
28 https://sourceforge.net/p/docutils/bugs/339/
29 If your custom stylesheets modify "\DUadmonition" to style admonitions,
30 you will need to adapt them after upgrading to versions > 0.15.
32 * Remove the `handle_io_errors` option from io.FileInput/Output.
33 Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
35 * Remove `utils.unique_combinations` (obsoleted by `itertools.combinations`).
37 * The default HTML writer "html" with frontend ``rst2html.py`` may change
38 from "html4css1" to "html5".
40 Use `get_writer_by_name('html')` or the rst2html.py_ front end, if you
41 want the output to be up-to-date automatically.
43 Use a specific writer name or front end, if you depend on stability of the
44 generated HTML code, e.g. because you use a custom style sheet or
45 post-processing that may break otherwise.
47 .. _rst2html.py: docs/user/tools.html#rst2html-py
49 * Allow escaping of author-separators in `bibliographic fields`__.
51 __ docs/ref/rst/restructuredtext.html#bibliographic-fields
59 Docutils 0.15.x is the last version supporting Python 2.6, 3.3, and 3.4.
61 Docutils 0.16 is compatible with Python versions 2.7 and 3.5 to 3.7.
62 (cf. `Python 3 compatibility`_).
64 * Keep `backslash escapes`__ in the document tree.
66 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism
74 Docutils 0.14.x is the last version supporting Python 2.4, 2.5,
77 Docutils 0.15.x is compatible with Python versions 2.6, 2.7 and 3.3 to 3.5
78 (cf. `Python 3 compatibility`_).
82 - Allow embedded colons in field list field names (before, tokens like
83 ``:this:example:`` were considered ordinary text).
85 - Fixed a bug with the "trim" options of the "unicode" directive.
87 * languages: Added Korean localisation (ko).
89 * Bugfixes (see HISTORY.txt).
92 Release 0.14 (2017-08-03)
93 =========================
95 * docutils/docs/ref/docutils.dtd:
97 - Enable validation of Docutils XML documents against the DTD:
99 * docutils/parsers/rst/:
101 - Added functionality: escaped whitespace in URI contexts.
102 - Consistent handling of all whitespace characters in inline markup
103 recognition. (May break documents that relied on some whitespace
104 characters (NBSP, ...) *not* to be recognized as whitespace.)
106 * docutils/utils/smartquotes.py:
108 - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
109 - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
110 - Differentiate apostrophe from closing single quote (if possible).
111 - Add command line interface for stand-alone use (requires 2.7).
113 * docutils/writers/_html_base:
115 - Provide default title in metadata.
116 - The MathJax CDN shut down on April 30, 2017. For security reasons, we
117 don't use a third party public installation as default but warn
118 if `math-output` is set to MathJax without specifying a URL.
119 See math-output_ for details.
121 * docutils/writers/html4css1:
123 - Respect automatic table column sizing.
125 * docutils/writers/latex2e/__init__.py
127 - Handle class arguments for block-level elements by wrapping them
128 in a "DUclass" environment. This replaces the special handling for
129 "epigraph" and "topic" elements.
131 * docutils/writers/odf_odt:
133 - Language option sets ODF document's default language
134 - Image width, scale, ... set image size in generated ODF.
138 - New front-end ``rst2html4.py``.
141 Release 0.13.1 (2016-12-09)
142 ===========================
144 * docutils/writers/html5_polyglot
146 - New HTML writer generating `HTML 5`_.
148 .. _HTML 5: http://www.w3.org/TR/html5/
152 - New front-end ``rst2html5.py``.
154 * languages: persian/farsi (fa) and latvian (la) mappings.
156 * change default base url for :rfc: to http://tools.ietf.org/html/
158 * tables accept widths, a list and align
160 * latex2e: Fix admonition width, remove deprecated options,
161 better tablewidth auto, ...
163 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
166 Release 0.12 (2014-07-06)
167 =========================
169 Small changes only, release current state
172 Release 0.11 (2013-07-22)
173 =========================
177 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
178 - Support embedded aliases within hyperlink references.
179 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
180 language module) before global search.
182 * docutils/parsers/rst/directives/tables.py
184 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
186 * docutils/writers/html4css1/__init__.py
187 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
188 - New setting `stylesheet_dirs` (see above).
190 Now, it is easy to add a custom stylesheet to Docutils' default
191 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
193 Changed behaviour of the default settings:
194 if there is a file ``html4css1.css`` in the working directory of the
195 process at launch, it is used instead of the one provided by Docutils
196 in the writer source directory.
198 - New default for math-output_: ``HTML math.css``.
199 - Avoid repeated class declarations in html4css1 writer
200 (modified version of patch [ 104 ]).
202 .. _math-output: docs/user/config.html#math-output
204 * docutils/writers/latex2e/__init__.py
206 - Drop the simple algorithm replacing straight double quotes with
207 English typographic ones.
208 Activate the SmartQuotes_ transform if you want this feature.
209 - New setting `stylesheet_dirs`: Comma-separated list of directories
210 where stylesheets are found. Used by `stylesheet_path` when expanding
211 relative path arguments.
213 .. _SmartQuotes: docs/user/config.html#smart-quotes
215 * docutils/writers/manpage.py
217 - Fix [3607063] handle lines starting with a period.
218 - Fix option separating comma was bold (thanks to Bill Morris).
220 Release 0.10 (2012-12-16)
221 =========================
225 Docutils 0.9.x is the last version supporting Python 2.3.
227 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
228 (cf. `Python 3 compatibility`_).
232 - SmartQuotes transform for typographic quotes and dashes.
234 - ``docutils/math``, ``docutils/error_reporting.py``, and
235 ``docutils/urischemes.py`` moved to the utils package.
236 Code importing these modules needs to adapt, e.g.::
239 import docutils.math as math
241 import docutils.utils.math as math
243 - enhanced math and error handling.
247 - FileInput/FileOutput: no system-exit on IOError.
248 The `handle_io_errors` option is ignored.
250 .. _Python 3 compatibility: README.html#python-3-compatibility
252 * docutils/writers/html4css1/__init__.py
254 - Use ``<code>`` tag for inline "code",
255 do not drop nested inline nodes (syntax highlight tokens).
256 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
257 - No line break after opening inline math tag.
259 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
261 - Fix section numbering by LaTeX.
263 * docutils/writers/s5_html/__init__.py
265 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
268 Release 0.9.1 (2012-06-17)
269 ==========================
273 Several fixes for Python 3 usage.
277 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
278 installed in the PYTHONPATH. Converted tests are now
279 stored in ``docutils/test3/``, tools no longer need conversion.
281 If you installed one of Docutils versions 0.7 ... 0.9 with
282 ``setup.py install`` under Python 3, remove the spurious
283 ``test/`` and ``tools/`` directories in the site library root.
286 Release 0.9 (2012-05-02)
287 =========================
291 - reStructuredText "code" role and directive with syntax highlighting
293 - "code" option of the "include" directive.
295 .. _Pygments: http://pygments.org/
297 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
298 characters and "international" quotes around inline markup.
300 - Fix handling of missing stylesheets.
304 - Fix [ 2971827 ] and [ 3442827 ]
305 extras/roman.py moved to docutils/utils/roman.py
307 * docutils/utils.py -> docutils/utils/__init__.py
309 - docutils.utils is now a package (providing a place for sub-modules)
311 * docutils/writers/html4css1/__init__.py
313 - change default for `math-output` setting to MathJax
315 * docutils/writers/latex2e/__init__.py
317 - Support the `abbreviation` and `acronym` standard roles.
318 - Record only files required to generate the LaTeX source as dependencies.
319 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
320 when suppressing LaTeX section numbering.
323 Release 0.8.1 (2011-08-30)
324 ==========================
328 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
329 and [ 3395920 ] (correct copyright info for rst.el).
331 * docutils/writers/latex2e/__init__.py
333 - Clean up Babel language setting. Restores Sphinx compatibility.
336 Release 0.8 (2011-07-07)
337 ========================
341 - Some additions to the Docutils core are released under the 2-Clause BSD
346 - Handle language codes according to `BCP 47`_.
347 - If the specified langauage is not supported by Docutils,
348 warn and fall back to English.
349 - Math support: reStructuredText "math" role and directive,
350 ``math`` and ``math_block`` doctree elements.
351 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
353 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
357 - most directives now support a "name" option that attaches a
358 reference name. So you can write ::
360 .. figure:: image.png
363 as a short form of ::
367 .. figure:: image.png
369 Internationalization:
371 * Added lithuanian mappings.
377 - New setting "math-output" with support for HTML, MathML, and LaTeX.
381 - Convert image URI to a local file path.
382 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
383 has more than one paragraph (Wolfgang Scherer).
387 - New writer generating LaTeX code for compiling with ``xelatex``.
389 XeTeX uses unicode and modern font technologies.
391 * and fixes and enhancements here and there.
394 Release 0.7 (2010-07-07)
395 ========================
401 - Support SVG and SWF images (thanks to Stefan Rank).
402 - Generate valid XHTML for centered images with targets.
403 Use CSS classes instead of "align" tags for image alignment.
407 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
409 - Preserve runs of spaces in 'inline literals'.
410 - Deprecate ``figure_footnotes`` setting.
411 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
412 - New ``latex_preamble`` setting.
413 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
414 - `hyperref` package called with ``unicode`` option (see the
415 `hyperref config tips`__ for how to override).
416 - Drop the special `output_encoding`__ default ("latin-1").
417 The Docutils wide default (usually "UTF-8") is used instead.
419 __ docs/user/config.html#docutils-footnotes
420 __ docs/user/latex.html#hyperlinks
421 __ docs/user/latex.html#output-encoding
425 - Titles level 1, that is ``.SH``, always uppercase.
426 - Apply patch from mg: literal text should be bold in man-pages.
430 * io.FileInput opens files as text files with universal newline support
431 (mode "rU", configurable with the new optional argument "mode").
435 - Python 3 support: copy test/ and tools/ to the build-dir
436 and convert Python sources with 2to3.
439 Release 0.6 (2009-10-11)
440 ========================
444 Docutils 0.5 is the last version supporting Python 2.2.
446 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
447 and convertible to 3.1 code.
451 The "newlatex" writer is orphaned.
453 The recommended way to generate PDF output is to use either the
454 LaTeX2e writer or one of the alternatives listed at
455 http://docutils.sourceforge.net/docs/user/links.html#pdf.
459 - Allow length units for all length specifications.
460 - Allow percent sign in "scale" argument of "figure" and "image" directives.
461 - Bugfix: The "figalign" argument of a figure now works as intended
462 (aligning the figure not its contents).
463 - Align images with class "align-[right|center|left]"
464 (allows setting the alignment of an image in a figure).
465 - Hard tabs in literal inclusions are replaced by spaces. This is
466 configurable via the new "tab-width" option of the "include" directive
467 (a negative tab-width prevents tab expansion).
471 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
472 separated list of stylesheets.
477 - font-encoding: "T1" (formerly implicitely set by 'ae').
478 - use-latex-toc: true (ToC with page numbers).
479 - use-latex-footnotes: true (no mixup with figures).
480 - Float placement defaults to "here definitely" (configurable).
481 - Align of image in a figure defaults to 'center'.
482 - Use class defaults for page margins ('typearea' now optional).
483 - Support LaTeX packages as ``--stylesheet`` arguments.
484 - Use ``bp`` for lengths without unit or unit ``pt``,
485 do not convert ``px`` to ``pt``.
486 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
487 - Set sub- and superscript role argument as text not math.
488 - Support custom roles based on standard roles.
489 - Load packages and define macros only if required in the document.
490 - All Docutils specific LaTeX macros are prefixed with ``DU``.
491 - Better conformance to Docutils specifications with "use_latex_toc".
492 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
493 section numbering by LaTeX.
494 - Use default font in admonitions and sidebar.
495 - Typeset generic topic as "quote with title".
496 - Use template (file and configuration option).
497 - Render doctest blocks as literal blocks (indented).
501 - moved from sandbox to Doctutils core.
505 - moved from sandbox to Doctutils core.
508 Release 0.5 (2008-06-25)
509 ========================
515 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
516 universally supported now).
520 - Better bibTeX citation support.
521 - Add ``--literal-block-env``
525 - Changed to support new python.org website structure and
530 * Changed the directive API to a new object-oriented system.
531 (Compatibility for the old, functional-style directive interface is
532 retained.) See the updated `Creating reStructuredText Directives`__
535 __ docs/howto/rst-directives.html
537 * Allow ``+`` and ``:`` in reference names requested for citations.
541 * Added `Deploying Docutils Securely`__
543 __ docs/howto/security.txt
545 Internationalization:
547 * Added hebrew mappings.
551 * Configuration files are now assumed and required to be
554 * Added docutils/writers/html4css1/template.txt.
556 * Enhance emacs support.
559 Release 0.4 (2006-01-09)
560 ========================
564 Docutils 0.4.x is the last version that will support Python 2.1.
565 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
566 or later will be required.
568 Docutils 0.4.x is the last version that will make compromises in
569 its HTML output for Netscape Navigator 4. Docutils 0.5 will
570 require more up-to-date browsers (the exact definition is to be
575 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
576 multi-platform, multi-browser HTML slide shows.
578 __ docs/user/slide-shows.html
579 __ docs/user/tools.html#rst2s5-py
581 * The newlatex2e writer is nearing completion.
583 * Added a DocTree reader, ``publish_doctree`` and
584 ``publish_from_doctree`` convenience functions, for document tree
585 extraction and reprocessing.
589 * Added directives: "container__" (generic block-level container),
590 "default-role__" (role used for \`backtick\` syntax), "title__"
591 (document title metadata), and "date__" (generate the current local
592 date, for substitution definitions).
594 __ docs/ref/rst/directives.html#container
595 __ docs/ref/rst/directives.html#default-role
596 __ docs/ref/rst/directives.html#title
597 __ docs/ref/rst/directives.html#date
599 * Length units are now supported for image__ sizes.
601 __ docs/ref/rst/directives.html#image
603 * Added `standard definition files`__ for special characters etc.
605 __ docs/ref/rst/definitions.html
607 Internationalization:
609 * Added Japanese and Simplified Chinese language mappings, and support
610 for double-width CJK-characters in tables and section titles.
614 * Added a `guide for distributors`__ (package maintainers) and a
615 `guide for developers`__.
617 __ docs/dev/distributing.html
618 __ docs/dev/hacking.html
622 * Added significant `Emacs support for reST`__.
624 __ docs/user/emacs.html
626 * Added a `--strip-comments`__ option.
628 __ docs/user/config.html#strip-comments
630 * `--embed-stylesheet`__ is now the default for the HTML writer
631 (rather than --link-stylesheet).
633 __ docs/user/config.html#embed-stylesheet
636 Release 0.3.9 (2005-05-26)
637 ==========================
639 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
641 __ docs/user/config.html#file-insertion-enabled
642 __ docs/user/config.html#raw-enabled
644 * Added `auto-enumerated lists`__.
646 __ docs/ref/rst/restructuredtext.html#enumerated-lists
648 * Added `"header" and "footer"`__ directives.
650 __ docs/ref/rst/directives.html#document-header-footer
652 * Added "list-table__" directive.
654 __ docs/ref/rst/directives.html#list-table
656 * Added support for `section subtitles`__.
658 __ docs/user/config.html#sectsubtitle-xform
660 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
662 __ docs/user/config.html#field-name-limit
663 __ docs/user/config.html#option-limit
665 * Added "cloak_email_addresses__" setting to HTML writer.
667 __ docs/user/config.html#cloak-email-addresses
669 * UTF-8 BOMs are now removed from the input stream.
672 Release 0.3.7 (2004-12-24)
673 ==========================
675 * A special "`line block`__" syntax has been added. (Also see the
676 `quick reference`__.)
678 __ docs/ref/rst/restructuredtext.html#line-blocks
679 __ docs/user/rst/quickref.html#line-blocks
681 * Empty sections are now allowed.
683 * A "raw__" role has been added.
685 __ docs/ref/rst/roles.html#raw
687 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
688 so that they are no longer transformed by LaTeX to en or em dashes.
689 (Please see the FAQ__ for how to represent such dashes.)
691 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
693 * A `dependency recorder`__ has been added.
695 __ docs/user/config.html#record-dependencies
697 * A directive has been added for `compound paragraphs`__.
699 __ docs/ref/rst/directives.html#compound-paragraph
702 Release 0.3.5 (2004-07-29)
703 ==========================
705 * Improved, extended and reorganized the documentation__.
709 * Added "csv-table__" directive.
711 __ docs/ref/rst/directives.html#csv-table