1 ========================
3 ========================
6 :Contact: LeWiemann@gmail.com
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
26 - Handle language codes according to `BCP 47`_.
27 - If the specified langauage is not supported by Docutils,
28 warn and fall back to English.
29 - Math support: reStructuredText "math" role and directive,
30 ``math`` and ``math_block`` doctree elements.
31 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
33 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
36 Release 0.7 (2010-07-07)
37 ========================
43 - Support SVG and SWF images (thanks to Stefan Rank).
44 - Generate valid XHTML for centered images with targets.
45 Use CSS classes instead of "align" tags for image alignment.
49 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
51 - Preserve runs of spaces in 'inline literals'.
52 - Deprecate ``figure_footnotes`` setting.
53 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
54 - New ``latex_preamble`` setting.
55 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
56 - `hyperref` package called with ``unicode`` option (see the
57 `hyperref config tips`__ for how to override).
58 - Drop the special `output_encoding`__ default ("latin-1").
59 The Docutils wide default (usually "UTF-8") is used instead.
61 __ docs/user/config.html#docutils-footnotes
62 __ docs/user/latex.html#hyperlinks
63 __ docs/user/latex.html#output-encoding
67 - Titles level 1, that is ``.SH``, always uppercase.
68 - Apply patch from mg: literal text should be bold in man-pages.
72 * io.FileInput opens files as text files with universal newline support
73 (mode "rU", configurable with the new optional argument "mode").
77 - Python 3 support: copy test/ and tools/ to the build-dir
78 and convert Python sources with 2to3.
80 Release 0.6 (2009-10-11)
81 ========================
85 Docutils 0.5 is the last version supporting Python 2.2.
87 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
88 and convertible to 3.1 code.
92 The "newlatex" writer is orphaned.
94 The recommended way to generate PDF output is to use either the
95 LaTeX2e writer or one of the alternatives listed at
96 http://docutils.sourceforge.net/docs/user/links.html#pdf.
100 - Allow length units for all length specifications.
101 - Allow percent sign in "scale" argument of "figure" and "image" directives.
102 - Bugfix: The "figalign" argument of a figure now works as intended
103 (aligning the figure not its contents).
104 - Align images with class "align-[right|center|left]"
105 (allows setting the alignment of an image in a figure).
106 - Hard tabs in literal inclusions are replaced by spaces. This is
107 configurable via the new "tab-width" option of the "include" directive
108 (a negative tab-width prevents tab expansion).
112 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
113 separated list of stylesheets.
118 - font-encoding: "T1" (formerly implicitely set by 'ae').
119 - use-latex-toc: true (ToC with page numbers).
120 - use-latex-footnotes: true (no mixup with figures).
121 - Float placement defaults to "here definitely" (configurable).
122 - Align of image in a figure defaults to 'center'.
123 - Use class defaults for page margins ('typearea' now optional).
124 - Support LaTeX packages as ``--stylesheet`` arguments.
125 - Use ``bp`` for lengths without unit or unit ``pt``,
126 do not convert ``px`` to ``pt``.
127 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
128 - Set sub- and superscript role argument as text not math.
129 - Support custom roles based on standard roles.
130 - Load packages and define macros only if required in the document.
131 - All Docutils specific LaTeX macros are prefixed with ``DU``.
132 - Better conformance to Docutils specifications with "use_latex_toc".
133 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
134 section numbering by LaTeX.
135 - Use default font in admonitions and sidebar.
136 - Typeset generic topic as "quote with title".
137 - Use template (file and configuration option).
138 - Render doctest blocks as literal blocks (indented).
142 - moved from sandbox to Doctutils core.
146 - moved from sandbox to Doctutils core.
149 Release 0.5 (2008-06-25)
150 ========================
156 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
157 universally supported now).
161 - Better bibTeX citation support.
162 - Add ``--literal-block-env``
166 - Changed to support new python.org website structure and
171 * Changed the directive API to a new object-oriented system.
172 (Compatibility for the old, functional-style directive interface is
173 retained.) See the updated `Creating reStructuredText Directives`__
176 __ docs/howto/rst-directives.html
178 * Allow ``+`` and ``:`` in reference names requested for citations.
182 * Added `Deploying Docutils Securely`__
184 __ docs/howto/security.txt
186 Internationalization:
188 * Added hebrew mappings.
192 * Configuration files are now assumed and required to be
195 * Added docutils/writers/html4css1/template.txt.
197 * Enhance emacs support.
199 Release 0.4 (2006-01-09)
200 ========================
204 Docutils 0.4.x is the last version that will support Python 2.1.
205 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
206 or later will be required.
208 Docutils 0.4.x is the last version that will make compromises in
209 its HTML output for Netscape Navigator 4. Docutils 0.5 will
210 require more up-to-date browsers (the exact definition is to be
215 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
216 multi-platform, multi-browser HTML slide shows.
218 __ docs/user/slide-shows.html
219 __ docs/user/tools.html#rst2s5-py
221 * The newlatex2e writer is nearing completion.
223 * Added a DocTree reader, ``publish_doctree`` and
224 ``publish_from_doctree`` convenience functions, for document tree
225 extraction and reprocessing.
229 * Added directives: "container__" (generic block-level container),
230 "default-role__" (role used for \`backtick\` syntax), "title__"
231 (document title metadata), and "date__" (generate the current local
232 date, for substitution definitions).
234 __ docs/ref/rst/directives.html#container
235 __ docs/ref/rst/directives.html#default-role
236 __ docs/ref/rst/directives.html#title
237 __ docs/ref/rst/directives.html#date
239 * Length units are now supported for image__ sizes.
241 __ docs/ref/rst/directives.html#image
243 * Added `standard definition files`__ for special characters etc.
245 __ docs/ref/rst/definitions.html
247 Internationalization:
249 * Added Japanese and Simplified Chinese language mappings, and support
250 for double-width CJK-characters in tables and section titles.
254 * Added a `guide for distributors`__ (package maintainers) and a
255 `guide for developers`__.
257 __ docs/dev/distributing.html
258 __ docs/dev/hacking.html
262 * Added significant `Emacs support for reST`__.
264 __ docs/user/emacs.html
266 * Added a `--strip-comments`__ option.
268 __ docs/user/config.html#strip-comments
270 * `--embed-stylesheet`__ is now the default for the HTML writer
271 (rather than --link-stylesheet).
273 __ docs/user/config.html#embed-stylesheet
276 Release 0.3.9 (2005-05-26)
277 ==========================
279 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
281 __ docs/user/config.html#file-insertion-enabled
282 __ docs/user/config.html#raw-enabled
284 * Added `auto-enumerated lists`__.
286 __ docs/ref/rst/restructuredtext.html#enumerated-lists
288 * Added `"header" and "footer"`__ directives.
290 __ docs/ref/rst/directives.html#document-header-footer
292 * Added "list-table__" directive.
294 __ docs/ref/rst/directives.html#list-table
296 * Added support for `section subtitles`__.
298 __ docs/user/config.html#sectsubtitle-xform
300 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
302 __ docs/user/config.html#field-name-limit
303 __ docs/user/config.html#option-limit
305 * Added "cloak_email_addresses__" setting to HTML writer.
307 __ docs/user/config.html#cloak-email-addresses
309 * UTF-8 BOMs are now removed from the input stream.
312 Release 0.3.7 (2004-12-24)
313 ==========================
315 * A special "`line block`__" syntax has been added. (Also see the
316 `quick reference`__.)
318 __ docs/ref/rst/restructuredtext.html#line-blocks
319 __ docs/user/rst/quickref.html#line-blocks
321 * Empty sections are now allowed.
323 * A "raw__" role has been added.
325 __ docs/ref/rst/roles.html#raw
327 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
328 so that they are no longer transformed by LaTeX to en or em dashes.
329 (Please see the FAQ__ for how to represent such dashes.)
331 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
333 * A `dependency recorder`__ has been added.
335 __ docs/user/config.html#record-dependencies
337 * A directive has been added for `compound paragraphs`__.
339 __ docs/ref/rst/directives.html#compound-paragraph
342 Release 0.3.5 (2004-07-29)
343 ==========================
345 * Improved, extended and reorganized the documentation__.
349 * Added "csv-table__" directive.
351 __ docs/ref/rst/directives.html#csv-table