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 * »Prune« the doctree (no change to the reST input syntax):
27 - "doctest" element -> literal block with class argument,
28 - special admonitions (note, hint, warning, ...) -> generic "admonition"
29 element with class attribute and auto-generated title.
32 Release 0.11 (2013-07-13)
33 =========================
37 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
38 - Support embedded aliases within hyperlink references.
39 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
40 language module) before global search.
42 * docutils/parsers/rst/directives/tables.py
44 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
46 * docutils/writers/html4css1/__init__.py
47 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
48 - New setting `stylesheet_dirs` (see above).
50 Now, it is easy to add a custom stylesheet to Docutils' default
51 stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
53 Changed behaviour of the default settings:
54 if there is a file ``html4css1.css`` in the working directory of the
55 process at launch, it is used instead of the one provided by Docutils
56 in the writer source directory.
58 - New default for math-output_: ``HTML math.css``.
59 - Avoid repeated class declarations in html4css1 writer
60 (modified version of patch [ 104 ]).
62 .. _math-output: docs/user/config.html#math-output
64 * docutils/writers/latex2e/__init__.py
66 - Drop the simple algorithm replacing straight double quotes with
67 English typographic ones.
68 Activate the SmartQuotes_ transform if you want this feature.
69 - New setting `stylesheet_dirs`: Comma-separated list of directories
70 where stylesheets are found. Used by `stylesheet_path` when expanding
71 relative path arguments.
73 .. _SmartQuotes: docs/user/config.html#smart-quotes
75 * docutils/writers/manpage.py
77 - Fix [3607063] handle lines starting with a period.
78 - Fix option separating comma was bold (thanks to Bill Morris).
80 Release 0.10 (2012-12-16)
81 =========================
85 Docutils 0.9.x is the last version supporting Python 2.3.
87 Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
88 (cf. `Python 3 compatibility`_).
92 - SmartQuotes transform for typographic quotes and dashes.
94 - ``docutils/math``, ``docutils/error_reporting.py``, and
95 ``docutils/urischemes.py`` moved to the utils package.
96 Code importing these modules needs to adapt, e.g.::
99 import docutils.math as math
101 import docutils.utils.math as math
103 - enhanced math and error handling.
107 - FileInput/FileOutput: no system-exit on IOError.
108 The `handle_io_errors` option is ignored.
110 .. _Python 3 compatibility: README.html#python-3-compatibility
112 * docutils/writers/html4css1/__init__.py
114 - Use ``<code>`` tag for inline "code",
115 do not drop nested inline nodes (syntax highlight tokens).
116 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
117 - No line break after opening inline math tag.
119 * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
121 - Fix section numbering by LaTeX.
123 * docutils/writers/s5_html/__init__.py
125 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
128 Release 0.9.1 (2012-06-17)
129 ==========================
133 Several fixes for Python 3 usage.
137 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
138 installed in the PYTHONPATH. Converted tests are now
139 stored in ``docutils/test3/``, tools no longer need conversion.
141 If you installed one of Docutils versions 0.7 ... 0.9 with
142 ``setup.py install`` under Python 3, remove the spurious
143 ``test/`` and ``tools/`` directories in the site library root.
146 Release 0.9 (2012-05-02)
147 =========================
151 - reStructuredText "code" role and directive with syntax highlighting
153 - "code" option of the "include" directive.
155 .. _Pygments: http://pygments.org/
157 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
158 characters and "international" quotes around inline markup.
160 - Fix handling of missing stylesheets.
164 - Fix [ 2971827 ] and [ 3442827 ]
165 extras/roman.py moved to docutils/utils/roman.py
167 * docutils/utils.py -> docutils/utils/__init__.py
169 - docutils.utils is now a package (providing a place for sub-modules)
171 * docutils/writers/html4css1/__init__.py
173 - change default for `math-output` setting to MathJax
175 * docutils/writers/latex2e/__init__.py
177 - Support the `abbreviation` and `acronym` standard roles.
178 - Record only files required to generate the LaTeX source as dependencies.
179 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
180 when suppressing LaTeX section numbering.
183 Release 0.8.1 (2011-08-30)
184 ==========================
188 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
189 and [ 3395920 ] (correct copyright info for rst.el).
191 * docutils/writers/latex2e/__init__.py
193 - Clean up Babel language setting. Restores Sphinx compatibility.
196 Release 0.8 (2011-07-07)
197 ========================
201 - Some additions to the Docutils core are released under the 2-Clause BSD
206 - Handle language codes according to `BCP 47`_.
207 - If the specified langauage is not supported by Docutils,
208 warn and fall back to English.
209 - Math support: reStructuredText "math" role and directive,
210 ``math`` and ``math_block`` doctree elements.
211 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
213 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
217 - most directives now support a "name" option that attaches a
218 reference name. So you can write ::
220 .. figure:: image.png
223 as a short form of ::
227 .. figure:: image.png
229 Internationalization:
231 * Added lithuanian mappings.
237 - New setting "math-output" with support for HTML, MathML, and LaTeX.
241 - Convert image URI to a local file path.
242 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
243 has more than one paragraph (Wolfgang Scherer).
247 - New writer generating LaTeX code for compiling with ``xelatex``.
249 XeTeX uses unicode and modern font technologies.
251 * and fixes and enhancements here and there.
254 Release 0.7 (2010-07-07)
255 ========================
261 - Support SVG and SWF images (thanks to Stefan Rank).
262 - Generate valid XHTML for centered images with targets.
263 Use CSS classes instead of "align" tags for image alignment.
267 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
269 - Preserve runs of spaces in 'inline literals'.
270 - Deprecate ``figure_footnotes`` setting.
271 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
272 - New ``latex_preamble`` setting.
273 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
274 - `hyperref` package called with ``unicode`` option (see the
275 `hyperref config tips`__ for how to override).
276 - Drop the special `output_encoding`__ default ("latin-1").
277 The Docutils wide default (usually "UTF-8") is used instead.
279 __ docs/user/config.html#docutils-footnotes
280 __ docs/user/latex.html#hyperlinks
281 __ docs/user/latex.html#output-encoding
285 - Titles level 1, that is ``.SH``, always uppercase.
286 - Apply patch from mg: literal text should be bold in man-pages.
290 * io.FileInput opens files as text files with universal newline support
291 (mode "rU", configurable with the new optional argument "mode").
295 - Python 3 support: copy test/ and tools/ to the build-dir
296 and convert Python sources with 2to3.
299 Release 0.6 (2009-10-11)
300 ========================
304 Docutils 0.5 is the last version supporting Python 2.2.
306 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
307 and convertible to 3.1 code.
311 The "newlatex" writer is orphaned.
313 The recommended way to generate PDF output is to use either the
314 LaTeX2e writer or one of the alternatives listed at
315 http://docutils.sourceforge.net/docs/user/links.html#pdf.
319 - Allow length units for all length specifications.
320 - Allow percent sign in "scale" argument of "figure" and "image" directives.
321 - Bugfix: The "figalign" argument of a figure now works as intended
322 (aligning the figure not its contents).
323 - Align images with class "align-[right|center|left]"
324 (allows setting the alignment of an image in a figure).
325 - Hard tabs in literal inclusions are replaced by spaces. This is
326 configurable via the new "tab-width" option of the "include" directive
327 (a negative tab-width prevents tab expansion).
331 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
332 separated list of stylesheets.
337 - font-encoding: "T1" (formerly implicitely set by 'ae').
338 - use-latex-toc: true (ToC with page numbers).
339 - use-latex-footnotes: true (no mixup with figures).
340 - Float placement defaults to "here definitely" (configurable).
341 - Align of image in a figure defaults to 'center'.
342 - Use class defaults for page margins ('typearea' now optional).
343 - Support LaTeX packages as ``--stylesheet`` arguments.
344 - Use ``bp`` for lengths without unit or unit ``pt``,
345 do not convert ``px`` to ``pt``.
346 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
347 - Set sub- and superscript role argument as text not math.
348 - Support custom roles based on standard roles.
349 - Load packages and define macros only if required in the document.
350 - All Docutils specific LaTeX macros are prefixed with ``DU``.
351 - Better conformance to Docutils specifications with "use_latex_toc".
352 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
353 section numbering by LaTeX.
354 - Use default font in admonitions and sidebar.
355 - Typeset generic topic as "quote with title".
356 - Use template (file and configuration option).
357 - Render doctest blocks as literal blocks (indented).
361 - moved from sandbox to Doctutils core.
365 - moved from sandbox to Doctutils core.
368 Release 0.5 (2008-06-25)
369 ========================
375 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
376 universally supported now).
380 - Better bibTeX citation support.
381 - Add ``--literal-block-env``
385 - Changed to support new python.org website structure and
390 * Changed the directive API to a new object-oriented system.
391 (Compatibility for the old, functional-style directive interface is
392 retained.) See the updated `Creating reStructuredText Directives`__
395 __ docs/howto/rst-directives.html
397 * Allow ``+`` and ``:`` in reference names requested for citations.
401 * Added `Deploying Docutils Securely`__
403 __ docs/howto/security.txt
405 Internationalization:
407 * Added hebrew mappings.
411 * Configuration files are now assumed and required to be
414 * Added docutils/writers/html4css1/template.txt.
416 * Enhance emacs support.
419 Release 0.4 (2006-01-09)
420 ========================
424 Docutils 0.4.x is the last version that will support Python 2.1.
425 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
426 or later will be required.
428 Docutils 0.4.x is the last version that will make compromises in
429 its HTML output for Netscape Navigator 4. Docutils 0.5 will
430 require more up-to-date browsers (the exact definition is to be
435 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
436 multi-platform, multi-browser HTML slide shows.
438 __ docs/user/slide-shows.html
439 __ docs/user/tools.html#rst2s5-py
441 * The newlatex2e writer is nearing completion.
443 * Added a DocTree reader, ``publish_doctree`` and
444 ``publish_from_doctree`` convenience functions, for document tree
445 extraction and reprocessing.
449 * Added directives: "container__" (generic block-level container),
450 "default-role__" (role used for \`backtick\` syntax), "title__"
451 (document title metadata), and "date__" (generate the current local
452 date, for substitution definitions).
454 __ docs/ref/rst/directives.html#container
455 __ docs/ref/rst/directives.html#default-role
456 __ docs/ref/rst/directives.html#title
457 __ docs/ref/rst/directives.html#date
459 * Length units are now supported for image__ sizes.
461 __ docs/ref/rst/directives.html#image
463 * Added `standard definition files`__ for special characters etc.
465 __ docs/ref/rst/definitions.html
467 Internationalization:
469 * Added Japanese and Simplified Chinese language mappings, and support
470 for double-width CJK-characters in tables and section titles.
474 * Added a `guide for distributors`__ (package maintainers) and a
475 `guide for developers`__.
477 __ docs/dev/distributing.html
478 __ docs/dev/hacking.html
482 * Added significant `Emacs support for reST`__.
484 __ docs/user/emacs.html
486 * Added a `--strip-comments`__ option.
488 __ docs/user/config.html#strip-comments
490 * `--embed-stylesheet`__ is now the default for the HTML writer
491 (rather than --link-stylesheet).
493 __ docs/user/config.html#embed-stylesheet
496 Release 0.3.9 (2005-05-26)
497 ==========================
499 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
501 __ docs/user/config.html#file-insertion-enabled
502 __ docs/user/config.html#raw-enabled
504 * Added `auto-enumerated lists`__.
506 __ docs/ref/rst/restructuredtext.html#enumerated-lists
508 * Added `"header" and "footer"`__ directives.
510 __ docs/ref/rst/directives.html#document-header-footer
512 * Added "list-table__" directive.
514 __ docs/ref/rst/directives.html#list-table
516 * Added support for `section subtitles`__.
518 __ docs/user/config.html#sectsubtitle-xform
520 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
522 __ docs/user/config.html#field-name-limit
523 __ docs/user/config.html#option-limit
525 * Added "cloak_email_addresses__" setting to HTML writer.
527 __ docs/user/config.html#cloak-email-addresses
529 * UTF-8 BOMs are now removed from the input stream.
532 Release 0.3.7 (2004-12-24)
533 ==========================
535 * A special "`line block`__" syntax has been added. (Also see the
536 `quick reference`__.)
538 __ docs/ref/rst/restructuredtext.html#line-blocks
539 __ docs/user/rst/quickref.html#line-blocks
541 * Empty sections are now allowed.
543 * A "raw__" role has been added.
545 __ docs/ref/rst/roles.html#raw
547 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
548 so that they are no longer transformed by LaTeX to en or em dashes.
549 (Please see the FAQ__ for how to represent such dashes.)
551 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
553 * A `dependency recorder`__ has been added.
555 __ docs/user/config.html#record-dependencies
557 * A directive has been added for `compound paragraphs`__.
559 __ docs/ref/rst/directives.html#compound-paragraph
562 Release 0.3.5 (2004-07-29)
563 ==========================
565 * Improved, extended and reorganized the documentation__.
569 * Added "csv-table__" directive.
571 __ docs/ref/rst/directives.html#csv-table