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.
32 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
35 Release 0.7 (2010-07-07)
36 ========================
42 - Support SVG and SWF images (thanks to Stefan Rank).
43 - Generate valid XHTML for centered images with targets.
44 Use CSS classes instead of "align" tags for image alignment.
48 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
50 - Preserve runs of spaces in 'inline literals'.
51 - Deprecate ``figure_footnotes`` setting.
52 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
53 - New ``latex_preamble`` setting.
54 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
55 - `hyperref` package called with ``unicode`` option (see the
56 `hyperref config tips`__ for how to override).
57 - Drop the special `output_encoding`__ default ("latin-1").
58 The Docutils wide default (usually "UTF-8") is used instead.
60 __ docs/user/config.html#docutils-footnotes
61 __ docs/user/latex.html#hyperlinks
62 __ docs/user/latex.html#output-encoding
66 - Titles level 1, that is ``.SH``, always uppercase.
67 - Apply patch from mg: literal text should be bold in man-pages.
71 * io.FileInput opens files as text files with universal newline support
72 (mode "rU", configurable with the new optional argument "mode").
76 - Python 3 support: copy test/ and tools/ to the build-dir
77 and convert Python sources with 2to3.
79 Release 0.6 (2009-10-11)
80 ========================
84 Docutils 0.5 is the last version supporting Python 2.2.
86 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
87 and convertible to 3.1 code.
91 The "newlatex" writer is orphaned.
93 The recommended way to generate PDF output is to use either the
94 LaTeX2e writer or one of the alternatives listed at
95 http://docutils.sourceforge.net/docs/user/links.html#pdf.
99 - Allow length units for all length specifications.
100 - Allow percent sign in "scale" argument of "figure" and "image" directives.
101 - Bugfix: The "figalign" argument of a figure now works as intended
102 (aligning the figure not its contents).
103 - Align images with class "align-[right|center|left]"
104 (allows setting the alignment of an image in a figure).
105 - Hard tabs in literal inclusions are replaced by spaces. This is
106 configurable via the new "tab-width" option of the "include" directive
107 (a negative tab-width prevents tab expansion).
111 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
112 separated list of stylesheets.
117 - font-encoding: "T1" (formerly implicitely set by 'ae').
118 - use-latex-toc: true (ToC with page numbers).
119 - use-latex-footnotes: true (no mixup with figures).
120 - Float placement defaults to "here definitely" (configurable).
121 - Align of image in a figure defaults to 'center'.
122 - Use class defaults for page margins ('typearea' now optional).
123 - Support LaTeX packages as ``--stylesheet`` arguments.
124 - Use ``bp`` for lengths without unit or unit ``pt``,
125 do not convert ``px`` to ``pt``.
126 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
127 - Set sub- and superscript role argument as text not math.
128 - Support custom roles based on standard roles.
129 - Load packages and define macros only if required in the document.
130 - All Docutils specific LaTeX macros are prefixed with ``DU``.
131 - Better conformance to Docutils specifications with "use_latex_toc".
132 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
133 section numbering by LaTeX.
134 - Use default font in admonitions and sidebar.
135 - Typeset generic topic as "quote with title".
136 - Use template (file and configuration option).
137 - Render doctest blocks as literal blocks (indented).
141 - moved from sandbox to Doctutils core.
145 - moved from sandbox to Doctutils core.
148 Release 0.5 (2008-06-25)
149 ========================
155 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
156 universally supported now).
160 - Better bibTeX citation support.
161 - Add ``--literal-block-env``
165 - Changed to support new python.org website structure and
170 * Changed the directive API to a new object-oriented system.
171 (Compatibility for the old, functional-style directive interface is
172 retained.) See the updated `Creating reStructuredText Directives`__
175 __ docs/howto/rst-directives.html
177 * Allow ``+`` and ``:`` in reference names requested for citations.
181 * Added `Deploying Docutils Securely`__
183 __ docs/howto/security.txt
185 Internationalization:
187 * Added hebrew mappings.
191 * Configuration files are now assumed and required to be
194 * Added docutils/writers/html4css1/template.txt.
196 * Enhance emacs support.
198 Release 0.4 (2006-01-09)
199 ========================
203 Docutils 0.4.x is the last version that will support Python 2.1.
204 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
205 or later will be required.
207 Docutils 0.4.x is the last version that will make compromises in
208 its HTML output for Netscape Navigator 4. Docutils 0.5 will
209 require more up-to-date browsers (the exact definition is to be
214 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
215 multi-platform, multi-browser HTML slide shows.
217 __ docs/user/slide-shows.html
218 __ docs/user/tools.html#rst2s5-py
220 * The newlatex2e writer is nearing completion.
222 * Added a DocTree reader, ``publish_doctree`` and
223 ``publish_from_doctree`` convenience functions, for document tree
224 extraction and reprocessing.
228 * Added directives: "container__" (generic block-level container),
229 "default-role__" (role used for \`backtick\` syntax), "title__"
230 (document title metadata), and "date__" (generate the current local
231 date, for substitution definitions).
233 __ docs/ref/rst/directives.html#container
234 __ docs/ref/rst/directives.html#default-role
235 __ docs/ref/rst/directives.html#title
236 __ docs/ref/rst/directives.html#date
238 * Length units are now supported for image__ sizes.
240 __ docs/ref/rst/directives.html#image
242 * Added `standard definition files`__ for special characters etc.
244 __ docs/ref/rst/definitions.html
246 Internationalization:
248 * Added Japanese and Simplified Chinese language mappings, and support
249 for double-width CJK-characters in tables and section titles.
253 * Added a `guide for distributors`__ (package maintainers) and a
254 `guide for developers`__.
256 __ docs/dev/distributing.html
257 __ docs/dev/hacking.html
261 * Added significant `Emacs support for reST`__.
263 __ docs/user/emacs.html
265 * Added a `--strip-comments`__ option.
267 __ docs/user/config.html#strip-comments
269 * `--embed-stylesheet`__ is now the default for the HTML writer
270 (rather than --link-stylesheet).
272 __ docs/user/config.html#embed-stylesheet
275 Release 0.3.9 (2005-05-26)
276 ==========================
278 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
280 __ docs/user/config.html#file-insertion-enabled
281 __ docs/user/config.html#raw-enabled
283 * Added `auto-enumerated lists`__.
285 __ docs/ref/rst/restructuredtext.html#enumerated-lists
287 * Added `"header" and "footer"`__ directives.
289 __ docs/ref/rst/directives.html#document-header-footer
291 * Added "list-table__" directive.
293 __ docs/ref/rst/directives.html#list-table
295 * Added support for `section subtitles`__.
297 __ docs/user/config.html#sectsubtitle-xform
299 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
301 __ docs/user/config.html#field-name-limit
302 __ docs/user/config.html#option-limit
304 * Added "cloak_email_addresses__" setting to HTML writer.
306 __ docs/user/config.html#cloak-email-addresses
308 * UTF-8 BOMs are now removed from the input stream.
311 Release 0.3.7 (2004-12-24)
312 ==========================
314 * A special "`line block`__" syntax has been added. (Also see the
315 `quick reference`__.)
317 __ docs/ref/rst/restructuredtext.html#line-blocks
318 __ docs/user/rst/quickref.html#line-blocks
320 * Empty sections are now allowed.
322 * A "raw__" role has been added.
324 __ docs/ref/rst/roles.html#raw
326 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
327 so that they are no longer transformed by LaTeX to en or em dashes.
328 (Please see the FAQ__ for how to represent such dashes.)
330 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
332 * A `dependency recorder`__ has been added.
334 __ docs/user/config.html#record-dependencies
336 * A directive has been added for `compound paragraphs`__.
338 __ docs/ref/rst/directives.html#compound-paragraph
341 Release 0.3.5 (2004-07-29)
342 ==========================
344 * Improved, extended and reorganized the documentation__.
348 * Added "csv-table__" directive.
350 __ docs/ref/rst/directives.html#csv-table