1 ========================
3 ========================
5 :Contact: grubert@users.sourceforge.net
6 :Maintainer: docutils-develop@lists.sourceforge.net
9 :Web site: http://docutils.sourceforge.net/
10 :Copyright: This document has been placed in the public domain.
13 This document summarizes the major changes in recent releases. For a
14 more detailed list of changes, please see the `Docutils History`_.
16 .. _Docutils History: HISTORY.html
23 * remove the `handle_io_errors` option from io.FileInput/Output.
25 * remove deprecated options from the latex2e writer:
27 --use-latex-footnotes Alias for --docutils-footnotes (deprecated)
28 --figure-footnotes Use figure floats for footnote text (deprecated)
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.
37 * Move to single source for Python 2 and Python 3, slowly.
38 See `Porting Python 2 Code to Python 3`_ and
39 `future: clean single-source support for Python 2/3`_
41 - Drop support for python 2.4 after release 0.12.
43 .. _Porting Python 2 Code to Python 3: https://docs.python.org/3/howto/pyporting.html
44 .. _future\: clean single-source support for Python 2/3: http://python-future.org
51 - New HTML writers generating `HTML 5`_ and `XHTML 1.1`_.
53 New stylesheet ``html-base.css`` for default layout using CSS 2.1.
57 - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the
58 corresponding writers.
60 .. _HTML 5: http://www.w3.org/TR/html5/
61 .. _XHTML 1.1: http://www.w3.org/TR/xhtml11/
64 Release 0.12 (2014-07-06)
65 =========================
67 Small changes only, release current state
69 Release 0.11 (2013-07-22)
70 =========================
74 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
75 - Support embedded aliases within hyperlink references.
76 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
77 language module) before global search.
79 * docutils/parsers/rst/directives/tables.py
81 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
83 * docutils/writers/html4css1/__init__.py
84 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
85 - New setting `stylesheet_dirs` (see above).
87 Now, it is easy to add a custom stylesheet to Docutils' default
88 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
90 Changed behaviour of the default settings:
91 if there is a file ``html4css1.css`` in the working directory of the
92 process at launch, it is used instead of the one provided by Docutils
93 in the writer source directory.
95 - New default for math-output_: ``HTML math.css``.
96 - Avoid repeated class declarations in html4css1 writer
97 (modified version of patch [ 104 ]).
99 .. _math-output: docs/user/config.html#math-output
101 * docutils/writers/latex2e/__init__.py
103 - Drop the simple algorithm replacing straight double quotes with
104 English typographic ones.
105 Activate the SmartQuotes_ transform if you want this feature.
106 - New setting `stylesheet_dirs`: Comma-separated list of directories
107 where stylesheets are found. Used by `stylesheet_path` when expanding
108 relative path arguments.
110 .. _SmartQuotes: docs/user/config.html#smart-quotes
112 * docutils/writers/manpage.py
114 - Fix [3607063] handle lines starting with a period.
115 - Fix option separating comma was bold (thanks to Bill Morris).
117 Release 0.10 (2012-12-16)
118 =========================
122 Docutils 0.9.x is the last version supporting Python 2.3.
124 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
125 (cf. `Python 3 compatibility`_).
129 - SmartQuotes transform for typographic quotes and dashes.
131 - ``docutils/math``, ``docutils/error_reporting.py``, and
132 ``docutils/urischemes.py`` moved to the utils package.
133 Code importing these modules needs to adapt, e.g.::
136 import docutils.math as math
138 import docutils.utils.math as math
140 - enhanced math and error handling.
144 - FileInput/FileOutput: no system-exit on IOError.
145 The `handle_io_errors` option is ignored.
147 .. _Python 3 compatibility: README.html#python-3-compatibility
149 * docutils/writers/html4css1/__init__.py
151 - Use ``<code>`` tag for inline "code",
152 do not drop nested inline nodes (syntax highlight tokens).
153 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
154 - No line break after opening inline math tag.
156 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
158 - Fix section numbering by LaTeX.
160 * docutils/writers/s5_html/__init__.py
162 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
165 Release 0.9.1 (2012-06-17)
166 ==========================
170 Several fixes for Python 3 usage.
174 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
175 installed in the PYTHONPATH. Converted tests are now
176 stored in ``docutils/test3/``, tools no longer need conversion.
178 If you installed one of Docutils versions 0.7 ... 0.9 with
179 ``setup.py install`` under Python 3, remove the spurious
180 ``test/`` and ``tools/`` directories in the site library root.
183 Release 0.9 (2012-05-02)
184 =========================
188 - reStructuredText "code" role and directive with syntax highlighting
190 - "code" option of the "include" directive.
192 .. _Pygments: http://pygments.org/
194 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
195 characters and "international" quotes around inline markup.
197 - Fix handling of missing stylesheets.
201 - Fix [ 2971827 ] and [ 3442827 ]
202 extras/roman.py moved to docutils/utils/roman.py
204 * docutils/utils.py -> docutils/utils/__init__.py
206 - docutils.utils is now a package (providing a place for sub-modules)
208 * docutils/writers/html4css1/__init__.py
210 - change default for `math-output` setting to MathJax
212 * docutils/writers/latex2e/__init__.py
214 - Support the `abbreviation` and `acronym` standard roles.
215 - Record only files required to generate the LaTeX source as dependencies.
216 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
217 when suppressing LaTeX section numbering.
220 Release 0.8.1 (2011-08-30)
221 ==========================
225 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
226 and [ 3395920 ] (correct copyright info for rst.el).
228 * docutils/writers/latex2e/__init__.py
230 - Clean up Babel language setting. Restores Sphinx compatibility.
233 Release 0.8 (2011-07-07)
234 ========================
238 - Some additions to the Docutils core are released under the 2-Clause BSD
243 - Handle language codes according to `BCP 47`_.
244 - If the specified langauage is not supported by Docutils,
245 warn and fall back to English.
246 - Math support: reStructuredText "math" role and directive,
247 ``math`` and ``math_block`` doctree elements.
248 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
250 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
254 - most directives now support a "name" option that attaches a
255 reference name. So you can write ::
257 .. figure:: image.png
260 as a short form of ::
264 .. figure:: image.png
266 Internationalization:
268 * Added lithuanian mappings.
274 - New setting "math-output" with support for HTML, MathML, and LaTeX.
278 - Convert image URI to a local file path.
279 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
280 has more than one paragraph (Wolfgang Scherer).
284 - New writer generating LaTeX code for compiling with ``xelatex``.
286 XeTeX uses unicode and modern font technologies.
288 * and fixes and enhancements here and there.
291 Release 0.7 (2010-07-07)
292 ========================
298 - Support SVG and SWF images (thanks to Stefan Rank).
299 - Generate valid XHTML for centered images with targets.
300 Use CSS classes instead of "align" tags for image alignment.
304 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
306 - Preserve runs of spaces in 'inline literals'.
307 - Deprecate ``figure_footnotes`` setting.
308 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
309 - New ``latex_preamble`` setting.
310 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
311 - `hyperref` package called with ``unicode`` option (see the
312 `hyperref config tips`__ for how to override).
313 - Drop the special `output_encoding`__ default ("latin-1").
314 The Docutils wide default (usually "UTF-8") is used instead.
316 __ docs/user/config.html#docutils-footnotes
317 __ docs/user/latex.html#hyperlinks
318 __ docs/user/latex.html#output-encoding
322 - Titles level 1, that is ``.SH``, always uppercase.
323 - Apply patch from mg: literal text should be bold in man-pages.
327 * io.FileInput opens files as text files with universal newline support
328 (mode "rU", configurable with the new optional argument "mode").
332 - Python 3 support: copy test/ and tools/ to the build-dir
333 and convert Python sources with 2to3.
336 Release 0.6 (2009-10-11)
337 ========================
341 Docutils 0.5 is the last version supporting Python 2.2.
343 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
344 and convertible to 3.1 code.
348 The "newlatex" writer is orphaned.
350 The recommended way to generate PDF output is to use either the
351 LaTeX2e writer or one of the alternatives listed at
352 http://docutils.sourceforge.net/docs/user/links.html#pdf.
356 - Allow length units for all length specifications.
357 - Allow percent sign in "scale" argument of "figure" and "image" directives.
358 - Bugfix: The "figalign" argument of a figure now works as intended
359 (aligning the figure not its contents).
360 - Align images with class "align-[right|center|left]"
361 (allows setting the alignment of an image in a figure).
362 - Hard tabs in literal inclusions are replaced by spaces. This is
363 configurable via the new "tab-width" option of the "include" directive
364 (a negative tab-width prevents tab expansion).
368 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
369 separated list of stylesheets.
374 - font-encoding: "T1" (formerly implicitely set by 'ae').
375 - use-latex-toc: true (ToC with page numbers).
376 - use-latex-footnotes: true (no mixup with figures).
377 - Float placement defaults to "here definitely" (configurable).
378 - Align of image in a figure defaults to 'center'.
379 - Use class defaults for page margins ('typearea' now optional).
380 - Support LaTeX packages as ``--stylesheet`` arguments.
381 - Use ``bp`` for lengths without unit or unit ``pt``,
382 do not convert ``px`` to ``pt``.
383 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
384 - Set sub- and superscript role argument as text not math.
385 - Support custom roles based on standard roles.
386 - Load packages and define macros only if required in the document.
387 - All Docutils specific LaTeX macros are prefixed with ``DU``.
388 - Better conformance to Docutils specifications with "use_latex_toc".
389 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
390 section numbering by LaTeX.
391 - Use default font in admonitions and sidebar.
392 - Typeset generic topic as "quote with title".
393 - Use template (file and configuration option).
394 - Render doctest blocks as literal blocks (indented).
398 - moved from sandbox to Doctutils core.
402 - moved from sandbox to Doctutils core.
405 Release 0.5 (2008-06-25)
406 ========================
412 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
413 universally supported now).
417 - Better bibTeX citation support.
418 - Add ``--literal-block-env``
422 - Changed to support new python.org website structure and
427 * Changed the directive API to a new object-oriented system.
428 (Compatibility for the old, functional-style directive interface is
429 retained.) See the updated `Creating reStructuredText Directives`__
432 __ docs/howto/rst-directives.html
434 * Allow ``+`` and ``:`` in reference names requested for citations.
438 * Added `Deploying Docutils Securely`__
440 __ docs/howto/security.txt
442 Internationalization:
444 * Added hebrew mappings.
448 * Configuration files are now assumed and required to be
451 * Added docutils/writers/html4css1/template.txt.
453 * Enhance emacs support.
456 Release 0.4 (2006-01-09)
457 ========================
461 Docutils 0.4.x is the last version that will support Python 2.1.
462 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
463 or later will be required.
465 Docutils 0.4.x is the last version that will make compromises in
466 its HTML output for Netscape Navigator 4. Docutils 0.5 will
467 require more up-to-date browsers (the exact definition is to be
472 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
473 multi-platform, multi-browser HTML slide shows.
475 __ docs/user/slide-shows.html
476 __ docs/user/tools.html#rst2s5-py
478 * The newlatex2e writer is nearing completion.
480 * Added a DocTree reader, ``publish_doctree`` and
481 ``publish_from_doctree`` convenience functions, for document tree
482 extraction and reprocessing.
486 * Added directives: "container__" (generic block-level container),
487 "default-role__" (role used for \`backtick\` syntax), "title__"
488 (document title metadata), and "date__" (generate the current local
489 date, for substitution definitions).
491 __ docs/ref/rst/directives.html#container
492 __ docs/ref/rst/directives.html#default-role
493 __ docs/ref/rst/directives.html#title
494 __ docs/ref/rst/directives.html#date
496 * Length units are now supported for image__ sizes.
498 __ docs/ref/rst/directives.html#image
500 * Added `standard definition files`__ for special characters etc.
502 __ docs/ref/rst/definitions.html
504 Internationalization:
506 * Added Japanese and Simplified Chinese language mappings, and support
507 for double-width CJK-characters in tables and section titles.
511 * Added a `guide for distributors`__ (package maintainers) and a
512 `guide for developers`__.
514 __ docs/dev/distributing.html
515 __ docs/dev/hacking.html
519 * Added significant `Emacs support for reST`__.
521 __ docs/user/emacs.html
523 * Added a `--strip-comments`__ option.
525 __ docs/user/config.html#strip-comments
527 * `--embed-stylesheet`__ is now the default for the HTML writer
528 (rather than --link-stylesheet).
530 __ docs/user/config.html#embed-stylesheet
533 Release 0.3.9 (2005-05-26)
534 ==========================
536 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
538 __ docs/user/config.html#file-insertion-enabled
539 __ docs/user/config.html#raw-enabled
541 * Added `auto-enumerated lists`__.
543 __ docs/ref/rst/restructuredtext.html#enumerated-lists
545 * Added `"header" and "footer"`__ directives.
547 __ docs/ref/rst/directives.html#document-header-footer
549 * Added "list-table__" directive.
551 __ docs/ref/rst/directives.html#list-table
553 * Added support for `section subtitles`__.
555 __ docs/user/config.html#sectsubtitle-xform
557 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
559 __ docs/user/config.html#field-name-limit
560 __ docs/user/config.html#option-limit
562 * Added "cloak_email_addresses__" setting to HTML writer.
564 __ docs/user/config.html#cloak-email-addresses
566 * UTF-8 BOMs are now removed from the input stream.
569 Release 0.3.7 (2004-12-24)
570 ==========================
572 * A special "`line block`__" syntax has been added. (Also see the
573 `quick reference`__.)
575 __ docs/ref/rst/restructuredtext.html#line-blocks
576 __ docs/user/rst/quickref.html#line-blocks
578 * Empty sections are now allowed.
580 * A "raw__" role has been added.
582 __ docs/ref/rst/roles.html#raw
584 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
585 so that they are no longer transformed by LaTeX to en or em dashes.
586 (Please see the FAQ__ for how to represent such dashes.)
588 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
590 * A `dependency recorder`__ has been added.
592 __ docs/user/config.html#record-dependencies
594 * A directive has been added for `compound paragraphs`__.
596 __ docs/ref/rst/directives.html#compound-paragraph
599 Release 0.3.5 (2004-07-29)
600 ==========================
602 * Improved, extended and reorganized the documentation__.
606 * Added "csv-table__" directive.
608 __ docs/ref/rst/directives.html#csv-table