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
25 Release 0.8 (2011-07-07)
26 ========================
30 - Some additions to the Docutils core are released under the 2-Clause BSD
35 - Handle language codes according to `BCP 47`_.
36 - If the specified langauage is not supported by Docutils,
37 warn and fall back to English.
38 - Math support: reStructuredText "math" role and directive,
39 ``math`` and ``math_block`` doctree elements.
40 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
42 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
46 - most directives now support a "name" option that attaches a
47 reference name. So you can write ::
60 * Added lithuanian mappings.
66 - New setting "math-output" with support for HTML, MathML, and LaTeX.
70 - Convert image URI to a local file path.
71 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
72 has more than one paragraph (Wolfgang Scherer).
76 - New writer generating LaTeX code for compiling with ``xelatex``.
78 XeTeX uses unicode and modern font technologies.
80 * and fixes and enhancements here and there.
82 Release 0.7 (2010-07-07)
83 ========================
89 - Support SVG and SWF images (thanks to Stefan Rank).
90 - Generate valid XHTML for centered images with targets.
91 Use CSS classes instead of "align" tags for image alignment.
95 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
97 - Preserve runs of spaces in 'inline literals'.
98 - Deprecate ``figure_footnotes`` setting.
99 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
100 - New ``latex_preamble`` setting.
101 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
102 - `hyperref` package called with ``unicode`` option (see the
103 `hyperref config tips`__ for how to override).
104 - Drop the special `output_encoding`__ default ("latin-1").
105 The Docutils wide default (usually "UTF-8") is used instead.
107 __ docs/user/config.html#docutils-footnotes
108 __ docs/user/latex.html#hyperlinks
109 __ docs/user/latex.html#output-encoding
113 - Titles level 1, that is ``.SH``, always uppercase.
114 - Apply patch from mg: literal text should be bold in man-pages.
118 * io.FileInput opens files as text files with universal newline support
119 (mode "rU", configurable with the new optional argument "mode").
123 - Python 3 support: copy test/ and tools/ to the build-dir
124 and convert Python sources with 2to3.
126 Release 0.6 (2009-10-11)
127 ========================
131 Docutils 0.5 is the last version supporting Python 2.2.
133 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
134 and convertible to 3.1 code.
138 The "newlatex" writer is orphaned.
140 The recommended way to generate PDF output is to use either the
141 LaTeX2e writer or one of the alternatives listed at
142 http://docutils.sourceforge.net/docs/user/links.html#pdf.
146 - Allow length units for all length specifications.
147 - Allow percent sign in "scale" argument of "figure" and "image" directives.
148 - Bugfix: The "figalign" argument of a figure now works as intended
149 (aligning the figure not its contents).
150 - Align images with class "align-[right|center|left]"
151 (allows setting the alignment of an image in a figure).
152 - Hard tabs in literal inclusions are replaced by spaces. This is
153 configurable via the new "tab-width" option of the "include" directive
154 (a negative tab-width prevents tab expansion).
158 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
159 separated list of stylesheets.
164 - font-encoding: "T1" (formerly implicitely set by 'ae').
165 - use-latex-toc: true (ToC with page numbers).
166 - use-latex-footnotes: true (no mixup with figures).
167 - Float placement defaults to "here definitely" (configurable).
168 - Align of image in a figure defaults to 'center'.
169 - Use class defaults for page margins ('typearea' now optional).
170 - Support LaTeX packages as ``--stylesheet`` arguments.
171 - Use ``bp`` for lengths without unit or unit ``pt``,
172 do not convert ``px`` to ``pt``.
173 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
174 - Set sub- and superscript role argument as text not math.
175 - Support custom roles based on standard roles.
176 - Load packages and define macros only if required in the document.
177 - All Docutils specific LaTeX macros are prefixed with ``DU``.
178 - Better conformance to Docutils specifications with "use_latex_toc".
179 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
180 section numbering by LaTeX.
181 - Use default font in admonitions and sidebar.
182 - Typeset generic topic as "quote with title".
183 - Use template (file and configuration option).
184 - Render doctest blocks as literal blocks (indented).
188 - moved from sandbox to Doctutils core.
192 - moved from sandbox to Doctutils core.
195 Release 0.5 (2008-06-25)
196 ========================
202 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
203 universally supported now).
207 - Better bibTeX citation support.
208 - Add ``--literal-block-env``
212 - Changed to support new python.org website structure and
217 * Changed the directive API to a new object-oriented system.
218 (Compatibility for the old, functional-style directive interface is
219 retained.) See the updated `Creating reStructuredText Directives`__
222 __ docs/howto/rst-directives.html
224 * Allow ``+`` and ``:`` in reference names requested for citations.
228 * Added `Deploying Docutils Securely`__
230 __ docs/howto/security.txt
232 Internationalization:
234 * Added hebrew mappings.
238 * Configuration files are now assumed and required to be
241 * Added docutils/writers/html4css1/template.txt.
243 * Enhance emacs support.
245 Release 0.4 (2006-01-09)
246 ========================
250 Docutils 0.4.x is the last version that will support Python 2.1.
251 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
252 or later will be required.
254 Docutils 0.4.x is the last version that will make compromises in
255 its HTML output for Netscape Navigator 4. Docutils 0.5 will
256 require more up-to-date browsers (the exact definition is to be
261 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
262 multi-platform, multi-browser HTML slide shows.
264 __ docs/user/slide-shows.html
265 __ docs/user/tools.html#rst2s5-py
267 * The newlatex2e writer is nearing completion.
269 * Added a DocTree reader, ``publish_doctree`` and
270 ``publish_from_doctree`` convenience functions, for document tree
271 extraction and reprocessing.
275 * Added directives: "container__" (generic block-level container),
276 "default-role__" (role used for \`backtick\` syntax), "title__"
277 (document title metadata), and "date__" (generate the current local
278 date, for substitution definitions).
280 __ docs/ref/rst/directives.html#container
281 __ docs/ref/rst/directives.html#default-role
282 __ docs/ref/rst/directives.html#title
283 __ docs/ref/rst/directives.html#date
285 * Length units are now supported for image__ sizes.
287 __ docs/ref/rst/directives.html#image
289 * Added `standard definition files`__ for special characters etc.
291 __ docs/ref/rst/definitions.html
293 Internationalization:
295 * Added Japanese and Simplified Chinese language mappings, and support
296 for double-width CJK-characters in tables and section titles.
300 * Added a `guide for distributors`__ (package maintainers) and a
301 `guide for developers`__.
303 __ docs/dev/distributing.html
304 __ docs/dev/hacking.html
308 * Added significant `Emacs support for reST`__.
310 __ docs/user/emacs.html
312 * Added a `--strip-comments`__ option.
314 __ docs/user/config.html#strip-comments
316 * `--embed-stylesheet`__ is now the default for the HTML writer
317 (rather than --link-stylesheet).
319 __ docs/user/config.html#embed-stylesheet
322 Release 0.3.9 (2005-05-26)
323 ==========================
325 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
327 __ docs/user/config.html#file-insertion-enabled
328 __ docs/user/config.html#raw-enabled
330 * Added `auto-enumerated lists`__.
332 __ docs/ref/rst/restructuredtext.html#enumerated-lists
334 * Added `"header" and "footer"`__ directives.
336 __ docs/ref/rst/directives.html#document-header-footer
338 * Added "list-table__" directive.
340 __ docs/ref/rst/directives.html#list-table
342 * Added support for `section subtitles`__.
344 __ docs/user/config.html#sectsubtitle-xform
346 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
348 __ docs/user/config.html#field-name-limit
349 __ docs/user/config.html#option-limit
351 * Added "cloak_email_addresses__" setting to HTML writer.
353 __ docs/user/config.html#cloak-email-addresses
355 * UTF-8 BOMs are now removed from the input stream.
358 Release 0.3.7 (2004-12-24)
359 ==========================
361 * A special "`line block`__" syntax has been added. (Also see the
362 `quick reference`__.)
364 __ docs/ref/rst/restructuredtext.html#line-blocks
365 __ docs/user/rst/quickref.html#line-blocks
367 * Empty sections are now allowed.
369 * A "raw__" role has been added.
371 __ docs/ref/rst/roles.html#raw
373 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
374 so that they are no longer transformed by LaTeX to en or em dashes.
375 (Please see the FAQ__ for how to represent such dashes.)
377 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
379 * A `dependency recorder`__ has been added.
381 __ docs/user/config.html#record-dependencies
383 * A directive has been added for `compound paragraphs`__.
385 __ docs/ref/rst/directives.html#compound-paragraph
388 Release 0.3.5 (2004-07-29)
389 ==========================
391 * Improved, extended and reorganized the documentation__.
395 * Added "csv-table__" directive.
397 __ docs/ref/rst/directives.html#csv-table