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
28 - Use the ``\url`` command for URLs (breaks long URLs instead of writing
30 - Preserve runs of spaces in 'inline literals'.
31 - Deprecate ``figure_footnotes`` setting.
32 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
33 - New ``latex_preamble`` setting.
34 - PDF standard fonts (Times/Helvetica/Courier) as default.
35 - `hyperref` package called with ``unicode`` option (see the
36 `hyperref config tips`__ for how to override).
38 __ docs/user/config.html#docutils-footnotes
39 __ docs/user/latex.html#hyperlinks
43 * io.FileInput opens files as text files with universal newline support
44 (mode "rU", configurable with the new optional argument "mode").
46 Release 0.6 (2009-10-11)
47 ========================
51 Docutils 0.5 is the last version supporting Python 2.2.
53 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
54 and convertible to 3.1 code.
58 The "newlatex" writer is orphaned.
60 The recommended way to generate PDF output is to use either the
61 LaTeX2e writer or one of the alternatives listed at
62 http://docutils.sourceforge.net/docs/user/links.html#pdf.
66 - Allow length units for all length specifications.
67 - Allow percent sign in "scale" argument of "figure" and "image" directives.
68 - Bugfix: The "figalign" argument of a figure now works as intended
69 (aligning the figure not its contents).
70 - Align images with class "align-[right|center|left]"
71 (allows setting the alignment of an image in a figure).
72 - Hard tabs in literal inclusions are replaced by spaces. This is
73 configurable via the new "tab-width" option of the "include" directive
74 (a negative tab-width prevents tab expansion).
78 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
79 separated list of stylesheets.
84 - font-encoding: "T1" (formerly implicitely set by 'ae').
85 - use-latex-toc: true (ToC with page numbers).
86 - use-latex-footnotes: true (no mixup with figures).
87 - Float placement defaults to "here definitely" (configurable).
88 - Align of image in a figure defaults to 'center'.
89 - Use class defaults for page margins ('typearea' now optional).
90 - Support LaTeX packages as ``--stylesheet`` arguments.
91 - Use ``bp`` for lengths without unit or unit ``pt``,
92 do not convert ``px`` to ``pt``.
93 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
94 - Set sub- and superscript role argument as text not math.
95 - Support custom roles based on standard roles.
96 - Load packages and define macros only if required in the document.
97 - All Docutils specific LaTeX macros are prefixed with ``DU``.
98 - Better conformance to Docutils specifications with "use_latex_toc".
99 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
100 section numbering by LaTeX.
101 - Use default font in admonitions and sidebar.
102 - Typeset generic topic as "quote with title".
103 - Use template (file and configuration option).
104 - Render doctest blocks as literal blocks (indented).
108 - moved from sandbox to Doctutils core.
112 - moved from sandbox to Doctutils core.
115 Release 0.5 (2008-06-25)
116 ========================
122 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
123 universally supported now).
127 - Better bibTeX citation support.
128 - Add ``--literal-block-env``
132 - Changed to support new python.org website structure and
137 * Changed the directive API to a new object-oriented system.
138 (Compatibility for the old, functional-style directive interface is
139 retained.) See the updated `Creating reStructuredText Directives`__
142 __ docs/howto/rst-directives.html
144 * Allow ``+`` and ``:`` in reference names requested for citations.
148 * Added `Deploying Docutils Securely`__
150 __ docs/howto/security.txt
152 Internationalization:
154 * Added hebrew mappings.
158 * Configuration files are now assumed and required to be
161 * Added docutils/writers/html4css1/template.txt.
163 * Enhance emacs support.
165 Release 0.4 (2006-01-09)
166 ========================
170 Docutils 0.4.x is the last version that will support Python 2.1.
171 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
172 or later will be required.
174 Docutils 0.4.x is the last version that will make compromises in
175 its HTML output for Netscape Navigator 4. Docutils 0.5 will
176 require more up-to-date browsers (the exact definition is to be
181 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
182 multi-platform, multi-browser HTML slide shows.
184 __ docs/user/slide-shows.html
185 __ docs/user/tools.html#rst2s5-py
187 * The newlatex2e writer is nearing completion.
189 * Added a DocTree reader, ``publish_doctree`` and
190 ``publish_from_doctree`` convenience functions, for document tree
191 extraction and reprocessing.
195 * Added directives: "container__" (generic block-level container),
196 "default-role__" (role used for \`backtick\` syntax), "title__"
197 (document title metadata), and "date__" (generate the current local
198 date, for substitution definitions).
200 __ docs/ref/rst/directives.html#container
201 __ docs/ref/rst/directives.html#default-role
202 __ docs/ref/rst/directives.html#title
203 __ docs/ref/rst/directives.html#date
205 * Length units are now supported for image__ sizes.
207 __ docs/ref/rst/directives.html#image
209 * Added `standard definition files`__ for special characters etc.
211 __ docs/ref/rst/definitions.html
213 Internationalization:
215 * Added Japanese and Simplified Chinese language mappings, and support
216 for double-width CJK-characters in tables and section titles.
220 * Added a `guide for distributors`__ (package maintainers) and a
221 `guide for developers`__.
223 __ docs/dev/distributing.html
224 __ docs/dev/hacking.html
228 * Added significant `Emacs support for reST`__.
230 __ docs/user/emacs.html
232 * Added a `--strip-comments`__ option.
234 __ docs/user/config.html#strip-comments
236 * `--embed-stylesheet`__ is now the default for the HTML writer
237 (rather than --link-stylesheet).
239 __ docs/user/config.html#embed-stylesheet
242 Release 0.3.9 (2005-05-26)
243 ==========================
245 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
247 __ docs/user/config.html#file-insertion-enabled
248 __ docs/user/config.html#raw-enabled
250 * Added `auto-enumerated lists`__.
252 __ docs/ref/rst/restructuredtext.html#enumerated-lists
254 * Added `"header" and "footer"`__ directives.
256 __ docs/ref/rst/directives.html#document-header-footer
258 * Added "list-table__" directive.
260 __ docs/ref/rst/directives.html#list-table
262 * Added support for `section subtitles`__.
264 __ docs/user/config.html#sectsubtitle-xform
266 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
268 __ docs/user/config.html#field-name-limit
269 __ docs/user/config.html#option-limit
271 * Added "cloak_email_addresses__" setting to HTML writer.
273 __ docs/user/config.html#cloak-email-addresses
275 * UTF-8 BOMs are now removed from the input stream.
278 Release 0.3.7 (2004-12-24)
279 ==========================
281 * A special "`line block`__" syntax has been added. (Also see the
282 `quick reference`__.)
284 __ docs/ref/rst/restructuredtext.html#line-blocks
285 __ docs/user/rst/quickref.html#line-blocks
287 * Empty sections are now allowed.
289 * A "raw__" role has been added.
291 __ docs/ref/rst/roles.html#raw
293 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
294 so that they are no longer transformed by LaTeX to en or em dashes.
295 (Please see the FAQ__ for how to represent such dashes.)
297 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
299 * A `dependency recorder`__ has been added.
301 __ docs/user/config.html#record-dependencies
303 * A directive has been added for `compound paragraphs`__.
305 __ docs/ref/rst/directives.html#compound-paragraph
308 Release 0.3.5 (2004-07-29)
309 ==========================
311 * Improved, extended and reorganized the documentation__.
315 * Added "csv-table__" directive.
317 __ docs/ref/rst/directives.html#csv-table