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 * Drop support for Python 2.4 and 2.5 immediately after the 0.14 release.
27 * Remove the `handle_io_errors` option from io.FileInput/Output.
28 Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
30 * The default HTML writer "html" with frontend ``rst2html.py`` may change
31 from "html4css1" to "html5".
33 Use `get_writer_by_name('html')` or the rst2html.py_ front end, if you
34 want the output to be up-to-date automatically.
36 Use a specific writer name or front end, if you depend on stability of the
37 generated HTML code, e.g. because you use a custom style sheet or
38 post-processing that may break otherwise.
40 .. _rst2html.py: docs/user/tools.html#rst2html-py
44 ===============================
46 * docutils/docs/ref/docutils.dtd:
48 - Enable validation of Docutils XML documents against the DTD:
50 * docutils/parsers/rst/:
52 - Added functionality: escaped whitespace in URI contexts.
53 - Consistent handling of all whitespace characters in inline markup
54 recognition. (May break documents that relied on some whitespace
55 characters (NBSP, ...) *not* to be recognized as whitespace.)
57 * docutils/utils/smartquotes.py:
59 - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
60 - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
61 - Differentiate apostrophe from closing single quote (if possible).
62 - Add command line interface for stand-alone use (requires 2.7).
64 * docutils/writers/_html_base:
66 - Provide default title in metadata.
67 - The MathJax CDN shut down on April 30, 2017. For security reasons, we
68 don't use a third party public installation as default but warn
69 if `math-output` is set to MathJax without specifying a URL.
70 See math-output_ for details.
72 * docutils/writers/html4css1:
74 - Respect automatic table column sizing.
76 * docutils/writers/latex2e/__init__.py
78 - Handle class arguments for block-level elements by wrapping them
79 in a "DUclass" environment. This replaces the special handling for
80 "epigraph" and "topic" elements.
82 * docutils/writers/odf_odt:
84 - Language option sets ODF document's default language
85 - Image width, scale, ... set image size in generated ODF.
89 - New front-end ``rst2html4.py``.
92 Release 0.13.1 (2016-12-09)
93 ===========================
95 * docutils/writers/html5_polyglot
97 - New HTML writer generating `HTML 5`_.
99 .. _HTML 5: http://www.w3.org/TR/html5/
103 - New front-end ``rst2html5.py``.
105 * languages: persian/farsi (fa) and latvian (la) mappings.
107 * change default base url for :rfc: to http://tools.ietf.org/html/
109 * tables accept widths, a list and align
111 * latex2e: Fix admonition width, remove deprecated options,
112 better tablewidth auto, ...
114 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
117 Release 0.12 (2014-07-06)
118 =========================
120 Small changes only, release current state
123 Release 0.11 (2013-07-22)
124 =========================
128 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
129 - Support embedded aliases within hyperlink references.
130 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
131 language module) before global search.
133 * docutils/parsers/rst/directives/tables.py
135 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
137 * docutils/writers/html4css1/__init__.py
138 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
139 - New setting `stylesheet_dirs` (see above).
141 Now, it is easy to add a custom stylesheet to Docutils' default
142 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
144 Changed behaviour of the default settings:
145 if there is a file ``html4css1.css`` in the working directory of the
146 process at launch, it is used instead of the one provided by Docutils
147 in the writer source directory.
149 - New default for math-output_: ``HTML math.css``.
150 - Avoid repeated class declarations in html4css1 writer
151 (modified version of patch [ 104 ]).
153 .. _math-output: docs/user/config.html#math-output
155 * docutils/writers/latex2e/__init__.py
157 - Drop the simple algorithm replacing straight double quotes with
158 English typographic ones.
159 Activate the SmartQuotes_ transform if you want this feature.
160 - New setting `stylesheet_dirs`: Comma-separated list of directories
161 where stylesheets are found. Used by `stylesheet_path` when expanding
162 relative path arguments.
164 .. _SmartQuotes: docs/user/config.html#smart-quotes
166 * docutils/writers/manpage.py
168 - Fix [3607063] handle lines starting with a period.
169 - Fix option separating comma was bold (thanks to Bill Morris).
171 Release 0.10 (2012-12-16)
172 =========================
176 Docutils 0.9.x is the last version supporting Python 2.3.
178 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
179 (cf. `Python 3 compatibility`_).
183 - SmartQuotes transform for typographic quotes and dashes.
185 - ``docutils/math``, ``docutils/error_reporting.py``, and
186 ``docutils/urischemes.py`` moved to the utils package.
187 Code importing these modules needs to adapt, e.g.::
190 import docutils.math as math
192 import docutils.utils.math as math
194 - enhanced math and error handling.
198 - FileInput/FileOutput: no system-exit on IOError.
199 The `handle_io_errors` option is ignored.
201 .. _Python 3 compatibility: README.html#python-3-compatibility
203 * docutils/writers/html4css1/__init__.py
205 - Use ``<code>`` tag for inline "code",
206 do not drop nested inline nodes (syntax highlight tokens).
207 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
208 - No line break after opening inline math tag.
210 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
212 - Fix section numbering by LaTeX.
214 * docutils/writers/s5_html/__init__.py
216 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
219 Release 0.9.1 (2012-06-17)
220 ==========================
224 Several fixes for Python 3 usage.
228 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
229 installed in the PYTHONPATH. Converted tests are now
230 stored in ``docutils/test3/``, tools no longer need conversion.
232 If you installed one of Docutils versions 0.7 ... 0.9 with
233 ``setup.py install`` under Python 3, remove the spurious
234 ``test/`` and ``tools/`` directories in the site library root.
237 Release 0.9 (2012-05-02)
238 =========================
242 - reStructuredText "code" role and directive with syntax highlighting
244 - "code" option of the "include" directive.
246 .. _Pygments: http://pygments.org/
248 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
249 characters and "international" quotes around inline markup.
251 - Fix handling of missing stylesheets.
255 - Fix [ 2971827 ] and [ 3442827 ]
256 extras/roman.py moved to docutils/utils/roman.py
258 * docutils/utils.py -> docutils/utils/__init__.py
260 - docutils.utils is now a package (providing a place for sub-modules)
262 * docutils/writers/html4css1/__init__.py
264 - change default for `math-output` setting to MathJax
266 * docutils/writers/latex2e/__init__.py
268 - Support the `abbreviation` and `acronym` standard roles.
269 - Record only files required to generate the LaTeX source as dependencies.
270 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
271 when suppressing LaTeX section numbering.
274 Release 0.8.1 (2011-08-30)
275 ==========================
279 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
280 and [ 3395920 ] (correct copyright info for rst.el).
282 * docutils/writers/latex2e/__init__.py
284 - Clean up Babel language setting. Restores Sphinx compatibility.
287 Release 0.8 (2011-07-07)
288 ========================
292 - Some additions to the Docutils core are released under the 2-Clause BSD
297 - Handle language codes according to `BCP 47`_.
298 - If the specified langauage is not supported by Docutils,
299 warn and fall back to English.
300 - Math support: reStructuredText "math" role and directive,
301 ``math`` and ``math_block`` doctree elements.
302 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
304 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
308 - most directives now support a "name" option that attaches a
309 reference name. So you can write ::
311 .. figure:: image.png
314 as a short form of ::
318 .. figure:: image.png
320 Internationalization:
322 * Added lithuanian mappings.
328 - New setting "math-output" with support for HTML, MathML, and LaTeX.
332 - Convert image URI to a local file path.
333 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
334 has more than one paragraph (Wolfgang Scherer).
338 - New writer generating LaTeX code for compiling with ``xelatex``.
340 XeTeX uses unicode and modern font technologies.
342 * and fixes and enhancements here and there.
345 Release 0.7 (2010-07-07)
346 ========================
352 - Support SVG and SWF images (thanks to Stefan Rank).
353 - Generate valid XHTML for centered images with targets.
354 Use CSS classes instead of "align" tags for image alignment.
358 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
360 - Preserve runs of spaces in 'inline literals'.
361 - Deprecate ``figure_footnotes`` setting.
362 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
363 - New ``latex_preamble`` setting.
364 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
365 - `hyperref` package called with ``unicode`` option (see the
366 `hyperref config tips`__ for how to override).
367 - Drop the special `output_encoding`__ default ("latin-1").
368 The Docutils wide default (usually "UTF-8") is used instead.
370 __ docs/user/config.html#docutils-footnotes
371 __ docs/user/latex.html#hyperlinks
372 __ docs/user/latex.html#output-encoding
376 - Titles level 1, that is ``.SH``, always uppercase.
377 - Apply patch from mg: literal text should be bold in man-pages.
381 * io.FileInput opens files as text files with universal newline support
382 (mode "rU", configurable with the new optional argument "mode").
386 - Python 3 support: copy test/ and tools/ to the build-dir
387 and convert Python sources with 2to3.
390 Release 0.6 (2009-10-11)
391 ========================
395 Docutils 0.5 is the last version supporting Python 2.2.
397 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
398 and convertible to 3.1 code.
402 The "newlatex" writer is orphaned.
404 The recommended way to generate PDF output is to use either the
405 LaTeX2e writer or one of the alternatives listed at
406 http://docutils.sourceforge.net/docs/user/links.html#pdf.
410 - Allow length units for all length specifications.
411 - Allow percent sign in "scale" argument of "figure" and "image" directives.
412 - Bugfix: The "figalign" argument of a figure now works as intended
413 (aligning the figure not its contents).
414 - Align images with class "align-[right|center|left]"
415 (allows setting the alignment of an image in a figure).
416 - Hard tabs in literal inclusions are replaced by spaces. This is
417 configurable via the new "tab-width" option of the "include" directive
418 (a negative tab-width prevents tab expansion).
422 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
423 separated list of stylesheets.
428 - font-encoding: "T1" (formerly implicitely set by 'ae').
429 - use-latex-toc: true (ToC with page numbers).
430 - use-latex-footnotes: true (no mixup with figures).
431 - Float placement defaults to "here definitely" (configurable).
432 - Align of image in a figure defaults to 'center'.
433 - Use class defaults for page margins ('typearea' now optional).
434 - Support LaTeX packages as ``--stylesheet`` arguments.
435 - Use ``bp`` for lengths without unit or unit ``pt``,
436 do not convert ``px`` to ``pt``.
437 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
438 - Set sub- and superscript role argument as text not math.
439 - Support custom roles based on standard roles.
440 - Load packages and define macros only if required in the document.
441 - All Docutils specific LaTeX macros are prefixed with ``DU``.
442 - Better conformance to Docutils specifications with "use_latex_toc".
443 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
444 section numbering by LaTeX.
445 - Use default font in admonitions and sidebar.
446 - Typeset generic topic as "quote with title".
447 - Use template (file and configuration option).
448 - Render doctest blocks as literal blocks (indented).
452 - moved from sandbox to Doctutils core.
456 - moved from sandbox to Doctutils core.
459 Release 0.5 (2008-06-25)
460 ========================
466 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
467 universally supported now).
471 - Better bibTeX citation support.
472 - Add ``--literal-block-env``
476 - Changed to support new python.org website structure and
481 * Changed the directive API to a new object-oriented system.
482 (Compatibility for the old, functional-style directive interface is
483 retained.) See the updated `Creating reStructuredText Directives`__
486 __ docs/howto/rst-directives.html
488 * Allow ``+`` and ``:`` in reference names requested for citations.
492 * Added `Deploying Docutils Securely`__
494 __ docs/howto/security.txt
496 Internationalization:
498 * Added hebrew mappings.
502 * Configuration files are now assumed and required to be
505 * Added docutils/writers/html4css1/template.txt.
507 * Enhance emacs support.
510 Release 0.4 (2006-01-09)
511 ========================
515 Docutils 0.4.x is the last version that will support Python 2.1.
516 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
517 or later will be required.
519 Docutils 0.4.x is the last version that will make compromises in
520 its HTML output for Netscape Navigator 4. Docutils 0.5 will
521 require more up-to-date browsers (the exact definition is to be
526 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
527 multi-platform, multi-browser HTML slide shows.
529 __ docs/user/slide-shows.html
530 __ docs/user/tools.html#rst2s5-py
532 * The newlatex2e writer is nearing completion.
534 * Added a DocTree reader, ``publish_doctree`` and
535 ``publish_from_doctree`` convenience functions, for document tree
536 extraction and reprocessing.
540 * Added directives: "container__" (generic block-level container),
541 "default-role__" (role used for \`backtick\` syntax), "title__"
542 (document title metadata), and "date__" (generate the current local
543 date, for substitution definitions).
545 __ docs/ref/rst/directives.html#container
546 __ docs/ref/rst/directives.html#default-role
547 __ docs/ref/rst/directives.html#title
548 __ docs/ref/rst/directives.html#date
550 * Length units are now supported for image__ sizes.
552 __ docs/ref/rst/directives.html#image
554 * Added `standard definition files`__ for special characters etc.
556 __ docs/ref/rst/definitions.html
558 Internationalization:
560 * Added Japanese and Simplified Chinese language mappings, and support
561 for double-width CJK-characters in tables and section titles.
565 * Added a `guide for distributors`__ (package maintainers) and a
566 `guide for developers`__.
568 __ docs/dev/distributing.html
569 __ docs/dev/hacking.html
573 * Added significant `Emacs support for reST`__.
575 __ docs/user/emacs.html
577 * Added a `--strip-comments`__ option.
579 __ docs/user/config.html#strip-comments
581 * `--embed-stylesheet`__ is now the default for the HTML writer
582 (rather than --link-stylesheet).
584 __ docs/user/config.html#embed-stylesheet
587 Release 0.3.9 (2005-05-26)
588 ==========================
590 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
592 __ docs/user/config.html#file-insertion-enabled
593 __ docs/user/config.html#raw-enabled
595 * Added `auto-enumerated lists`__.
597 __ docs/ref/rst/restructuredtext.html#enumerated-lists
599 * Added `"header" and "footer"`__ directives.
601 __ docs/ref/rst/directives.html#document-header-footer
603 * Added "list-table__" directive.
605 __ docs/ref/rst/directives.html#list-table
607 * Added support for `section subtitles`__.
609 __ docs/user/config.html#sectsubtitle-xform
611 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
613 __ docs/user/config.html#field-name-limit
614 __ docs/user/config.html#option-limit
616 * Added "cloak_email_addresses__" setting to HTML writer.
618 __ docs/user/config.html#cloak-email-addresses
620 * UTF-8 BOMs are now removed from the input stream.
623 Release 0.3.7 (2004-12-24)
624 ==========================
626 * A special "`line block`__" syntax has been added. (Also see the
627 `quick reference`__.)
629 __ docs/ref/rst/restructuredtext.html#line-blocks
630 __ docs/user/rst/quickref.html#line-blocks
632 * Empty sections are now allowed.
634 * A "raw__" role has been added.
636 __ docs/ref/rst/roles.html#raw
638 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
639 so that they are no longer transformed by LaTeX to en or em dashes.
640 (Please see the FAQ__ for how to represent such dashes.)
642 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
644 * A `dependency recorder`__ has been added.
646 __ docs/user/config.html#record-dependencies
648 * A directive has been added for `compound paragraphs`__.
650 __ docs/ref/rst/directives.html#compound-paragraph
653 Release 0.3.5 (2004-07-29)
654 ==========================
656 * Improved, extended and reorganized the documentation__.
660 * Added "csv-table__" directive.
662 __ docs/ref/rst/directives.html#csv-table