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 * Remove the `handle_io_errors` option from io.FileInput/Output.
26 Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
28 * Drop support for Python 2.4 and 2.5.
30 * »Prune« the doctree (no change to the reST input syntax):
32 - "doctest" element -> literal block with "pycon" (python-console)
33 class argument and syntax highlight (like the "code" directive),
34 - special admonitions (note, hint, warning, ...) -> generic "admonition"
35 element with class attribute and auto-generated title.
38 * The default HTML writer "html" with frontend ``rst2html.py`` may change
39 from "html4css1" to "html5".
41 Use `get_writer_by_name('html')` or the rst2html.py_ front end, if you
42 want the output to be up-to-date automatically.
44 Use a specific writer name or front end, if you depend on stability of the
45 generated HTML code, e.g. because you use a custom style sheet or
46 post-processing that may break otherwise.
48 .. _rst2html.py: docs/user/tools.html#rst2html-py
51 Prerelease 0.14rc1 (2017-05-27)
52 ===============================
54 * docutils/docutils/transforms/universal.py
56 Fix: warn only once if language is unsupported
58 * docutils/docs/ref/docutils.dtd:
60 - Enable validation of Docutils XML documents against the DTD:
62 * docutils/parsers/rst/:
64 - Added functionality: escaped whitespace in URI contexts.
65 - Consistent handling of all whitespace characters in inline markup
66 recognition. (May break documents that relied on some whitespace
67 characters (NBSP, ...) not to be recognized as whitespace.)
69 * docutils/utils/smartquotes.py:
71 - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
72 - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
73 - Fix [ 313 ] Differentiate apostrophe from closing single quote
75 - Fix [ 317 ] Extra space inserted with French smartquotes.
76 - Add command line interface for stand-alone use (requires 2.7).
78 * docutils/writers/_html_base:
80 - Provide default title in metadata.
81 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
83 * docutils/writers/html4css1:
85 - Respect automatic table column sizing.
87 * docutils/writers/latex2e/__init__.py
89 - Handle class arguments for block-level elements by wrapping them
90 in a "DUclass" environment. This replaces the special handling for
91 "epigraph" and "topic" elements.
93 * docutils/writers/odf_ odt:
95 - Language option sets ODF document's default language
96 - Image width, scale, ... set image size in generated ODF.
100 - New front-end ``rst2html4.py``.
103 Release 0.13.1 (2016-12-09)
104 ===========================
106 * docutils/writers/html5_polyglot
108 - New HTML writer generating `HTML 5`_.
112 - New front-end ``rst2html5.py``.
114 .. _HTML 5: http://www.w3.org/TR/html5/
116 * languages: persian/farsi (fa) and latvian (la) mappings.
118 * change default base url for :rfc: to http://tools.ietf.org/html/
120 * tables accept widths, a list and align
122 * latex2e: Fix admonition width, remove deprecated options,
123 better tablewidth auto, ...
125 * rst.el: The problem with ``electric-indent-mode`` has been fixed.
128 Release 0.12 (2014-07-06)
129 =========================
131 Small changes only, release current state
134 Release 0.11 (2013-07-22)
135 =========================
139 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
140 - Support embedded aliases within hyperlink references.
141 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
142 language module) before global search.
144 * docutils/parsers/rst/directives/tables.py
146 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
148 * docutils/writers/html4css1/__init__.py
149 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
150 - New setting `stylesheet_dirs` (see above).
152 Now, it is easy to add a custom stylesheet to Docutils' default
153 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
155 Changed behaviour of the default settings:
156 if there is a file ``html4css1.css`` in the working directory of the
157 process at launch, it is used instead of the one provided by Docutils
158 in the writer source directory.
160 - New default for math-output_: ``HTML math.css``.
161 - Avoid repeated class declarations in html4css1 writer
162 (modified version of patch [ 104 ]).
164 .. _math-output: docs/user/config.html#math-output
166 * docutils/writers/latex2e/__init__.py
168 - Drop the simple algorithm replacing straight double quotes with
169 English typographic ones.
170 Activate the SmartQuotes_ transform if you want this feature.
171 - New setting `stylesheet_dirs`: Comma-separated list of directories
172 where stylesheets are found. Used by `stylesheet_path` when expanding
173 relative path arguments.
175 .. _SmartQuotes: docs/user/config.html#smart-quotes
177 * docutils/writers/manpage.py
179 - Fix [3607063] handle lines starting with a period.
180 - Fix option separating comma was bold (thanks to Bill Morris).
182 Release 0.10 (2012-12-16)
183 =========================
187 Docutils 0.9.x is the last version supporting Python 2.3.
189 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
190 (cf. `Python 3 compatibility`_).
194 - SmartQuotes transform for typographic quotes and dashes.
196 - ``docutils/math``, ``docutils/error_reporting.py``, and
197 ``docutils/urischemes.py`` moved to the utils package.
198 Code importing these modules needs to adapt, e.g.::
201 import docutils.math as math
203 import docutils.utils.math as math
205 - enhanced math and error handling.
209 - FileInput/FileOutput: no system-exit on IOError.
210 The `handle_io_errors` option is ignored.
212 .. _Python 3 compatibility: README.html#python-3-compatibility
214 * docutils/writers/html4css1/__init__.py
216 - Use ``<code>`` tag for inline "code",
217 do not drop nested inline nodes (syntax highlight tokens).
218 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
219 - No line break after opening inline math tag.
221 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
223 - Fix section numbering by LaTeX.
225 * docutils/writers/s5_html/__init__.py
227 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
230 Release 0.9.1 (2012-06-17)
231 ==========================
235 Several fixes for Python 3 usage.
239 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
240 installed in the PYTHONPATH. Converted tests are now
241 stored in ``docutils/test3/``, tools no longer need conversion.
243 If you installed one of Docutils versions 0.7 ... 0.9 with
244 ``setup.py install`` under Python 3, remove the spurious
245 ``test/`` and ``tools/`` directories in the site library root.
248 Release 0.9 (2012-05-02)
249 =========================
253 - reStructuredText "code" role and directive with syntax highlighting
255 - "code" option of the "include" directive.
257 .. _Pygments: http://pygments.org/
259 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
260 characters and "international" quotes around inline markup.
262 - Fix handling of missing stylesheets.
266 - Fix [ 2971827 ] and [ 3442827 ]
267 extras/roman.py moved to docutils/utils/roman.py
269 * docutils/utils.py -> docutils/utils/__init__.py
271 - docutils.utils is now a package (providing a place for sub-modules)
273 * docutils/writers/html4css1/__init__.py
275 - change default for `math-output` setting to MathJax
277 * docutils/writers/latex2e/__init__.py
279 - Support the `abbreviation` and `acronym` standard roles.
280 - Record only files required to generate the LaTeX source as dependencies.
281 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
282 when suppressing LaTeX section numbering.
285 Release 0.8.1 (2011-08-30)
286 ==========================
290 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
291 and [ 3395920 ] (correct copyright info for rst.el).
293 * docutils/writers/latex2e/__init__.py
295 - Clean up Babel language setting. Restores Sphinx compatibility.
298 Release 0.8 (2011-07-07)
299 ========================
303 - Some additions to the Docutils core are released under the 2-Clause BSD
308 - Handle language codes according to `BCP 47`_.
309 - If the specified langauage is not supported by Docutils,
310 warn and fall back to English.
311 - Math support: reStructuredText "math" role and directive,
312 ``math`` and ``math_block`` doctree elements.
313 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
315 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
319 - most directives now support a "name" option that attaches a
320 reference name. So you can write ::
322 .. figure:: image.png
325 as a short form of ::
329 .. figure:: image.png
331 Internationalization:
333 * Added lithuanian mappings.
339 - New setting "math-output" with support for HTML, MathML, and LaTeX.
343 - Convert image URI to a local file path.
344 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
345 has more than one paragraph (Wolfgang Scherer).
349 - New writer generating LaTeX code for compiling with ``xelatex``.
351 XeTeX uses unicode and modern font technologies.
353 * and fixes and enhancements here and there.
356 Release 0.7 (2010-07-07)
357 ========================
363 - Support SVG and SWF images (thanks to Stefan Rank).
364 - Generate valid XHTML for centered images with targets.
365 Use CSS classes instead of "align" tags for image alignment.
369 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
371 - Preserve runs of spaces in 'inline literals'.
372 - Deprecate ``figure_footnotes`` setting.
373 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
374 - New ``latex_preamble`` setting.
375 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
376 - `hyperref` package called with ``unicode`` option (see the
377 `hyperref config tips`__ for how to override).
378 - Drop the special `output_encoding`__ default ("latin-1").
379 The Docutils wide default (usually "UTF-8") is used instead.
381 __ docs/user/config.html#docutils-footnotes
382 __ docs/user/latex.html#hyperlinks
383 __ docs/user/latex.html#output-encoding
387 - Titles level 1, that is ``.SH``, always uppercase.
388 - Apply patch from mg: literal text should be bold in man-pages.
392 * io.FileInput opens files as text files with universal newline support
393 (mode "rU", configurable with the new optional argument "mode").
397 - Python 3 support: copy test/ and tools/ to the build-dir
398 and convert Python sources with 2to3.
401 Release 0.6 (2009-10-11)
402 ========================
406 Docutils 0.5 is the last version supporting Python 2.2.
408 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
409 and convertible to 3.1 code.
413 The "newlatex" writer is orphaned.
415 The recommended way to generate PDF output is to use either the
416 LaTeX2e writer or one of the alternatives listed at
417 http://docutils.sourceforge.net/docs/user/links.html#pdf.
421 - Allow length units for all length specifications.
422 - Allow percent sign in "scale" argument of "figure" and "image" directives.
423 - Bugfix: The "figalign" argument of a figure now works as intended
424 (aligning the figure not its contents).
425 - Align images with class "align-[right|center|left]"
426 (allows setting the alignment of an image in a figure).
427 - Hard tabs in literal inclusions are replaced by spaces. This is
428 configurable via the new "tab-width" option of the "include" directive
429 (a negative tab-width prevents tab expansion).
433 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
434 separated list of stylesheets.
439 - font-encoding: "T1" (formerly implicitely set by 'ae').
440 - use-latex-toc: true (ToC with page numbers).
441 - use-latex-footnotes: true (no mixup with figures).
442 - Float placement defaults to "here definitely" (configurable).
443 - Align of image in a figure defaults to 'center'.
444 - Use class defaults for page margins ('typearea' now optional).
445 - Support LaTeX packages as ``--stylesheet`` arguments.
446 - Use ``bp`` for lengths without unit or unit ``pt``,
447 do not convert ``px`` to ``pt``.
448 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
449 - Set sub- and superscript role argument as text not math.
450 - Support custom roles based on standard roles.
451 - Load packages and define macros only if required in the document.
452 - All Docutils specific LaTeX macros are prefixed with ``DU``.
453 - Better conformance to Docutils specifications with "use_latex_toc".
454 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
455 section numbering by LaTeX.
456 - Use default font in admonitions and sidebar.
457 - Typeset generic topic as "quote with title".
458 - Use template (file and configuration option).
459 - Render doctest blocks as literal blocks (indented).
463 - moved from sandbox to Doctutils core.
467 - moved from sandbox to Doctutils core.
470 Release 0.5 (2008-06-25)
471 ========================
477 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
478 universally supported now).
482 - Better bibTeX citation support.
483 - Add ``--literal-block-env``
487 - Changed to support new python.org website structure and
492 * Changed the directive API to a new object-oriented system.
493 (Compatibility for the old, functional-style directive interface is
494 retained.) See the updated `Creating reStructuredText Directives`__
497 __ docs/howto/rst-directives.html
499 * Allow ``+`` and ``:`` in reference names requested for citations.
503 * Added `Deploying Docutils Securely`__
505 __ docs/howto/security.txt
507 Internationalization:
509 * Added hebrew mappings.
513 * Configuration files are now assumed and required to be
516 * Added docutils/writers/html4css1/template.txt.
518 * Enhance emacs support.
521 Release 0.4 (2006-01-09)
522 ========================
526 Docutils 0.4.x is the last version that will support Python 2.1.
527 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
528 or later will be required.
530 Docutils 0.4.x is the last version that will make compromises in
531 its HTML output for Netscape Navigator 4. Docutils 0.5 will
532 require more up-to-date browsers (the exact definition is to be
537 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
538 multi-platform, multi-browser HTML slide shows.
540 __ docs/user/slide-shows.html
541 __ docs/user/tools.html#rst2s5-py
543 * The newlatex2e writer is nearing completion.
545 * Added a DocTree reader, ``publish_doctree`` and
546 ``publish_from_doctree`` convenience functions, for document tree
547 extraction and reprocessing.
551 * Added directives: "container__" (generic block-level container),
552 "default-role__" (role used for \`backtick\` syntax), "title__"
553 (document title metadata), and "date__" (generate the current local
554 date, for substitution definitions).
556 __ docs/ref/rst/directives.html#container
557 __ docs/ref/rst/directives.html#default-role
558 __ docs/ref/rst/directives.html#title
559 __ docs/ref/rst/directives.html#date
561 * Length units are now supported for image__ sizes.
563 __ docs/ref/rst/directives.html#image
565 * Added `standard definition files`__ for special characters etc.
567 __ docs/ref/rst/definitions.html
569 Internationalization:
571 * Added Japanese and Simplified Chinese language mappings, and support
572 for double-width CJK-characters in tables and section titles.
576 * Added a `guide for distributors`__ (package maintainers) and a
577 `guide for developers`__.
579 __ docs/dev/distributing.html
580 __ docs/dev/hacking.html
584 * Added significant `Emacs support for reST`__.
586 __ docs/user/emacs.html
588 * Added a `--strip-comments`__ option.
590 __ docs/user/config.html#strip-comments
592 * `--embed-stylesheet`__ is now the default for the HTML writer
593 (rather than --link-stylesheet).
595 __ docs/user/config.html#embed-stylesheet
598 Release 0.3.9 (2005-05-26)
599 ==========================
601 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
603 __ docs/user/config.html#file-insertion-enabled
604 __ docs/user/config.html#raw-enabled
606 * Added `auto-enumerated lists`__.
608 __ docs/ref/rst/restructuredtext.html#enumerated-lists
610 * Added `"header" and "footer"`__ directives.
612 __ docs/ref/rst/directives.html#document-header-footer
614 * Added "list-table__" directive.
616 __ docs/ref/rst/directives.html#list-table
618 * Added support for `section subtitles`__.
620 __ docs/user/config.html#sectsubtitle-xform
622 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
624 __ docs/user/config.html#field-name-limit
625 __ docs/user/config.html#option-limit
627 * Added "cloak_email_addresses__" setting to HTML writer.
629 __ docs/user/config.html#cloak-email-addresses
631 * UTF-8 BOMs are now removed from the input stream.
634 Release 0.3.7 (2004-12-24)
635 ==========================
637 * A special "`line block`__" syntax has been added. (Also see the
638 `quick reference`__.)
640 __ docs/ref/rst/restructuredtext.html#line-blocks
641 __ docs/user/rst/quickref.html#line-blocks
643 * Empty sections are now allowed.
645 * A "raw__" role has been added.
647 __ docs/ref/rst/roles.html#raw
649 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
650 so that they are no longer transformed by LaTeX to en or em dashes.
651 (Please see the FAQ__ for how to represent such dashes.)
653 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
655 * A `dependency recorder`__ has been added.
657 __ docs/user/config.html#record-dependencies
659 * A directive has been added for `compound paragraphs`__.
661 __ docs/ref/rst/directives.html#compound-paragraph
664 Release 0.3.5 (2004-07-29)
665 ==========================
667 * Improved, extended and reorganized the documentation__.
671 * Added "csv-table__" directive.
673 __ docs/ref/rst/directives.html#csv-table