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 - Use 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).
37 - Drop the special `output_encoding`__ default ("latin-1").
38 The Docutils wide default (usually "UTF-8") is used instead.
40 __ docs/user/config.html#docutils-footnotes
41 __ docs/user/latex.html#hyperlinks
42 __ docs/user/latex.html#output-encoding
46 * io.FileInput opens files as text files with universal newline support
47 (mode "rU", configurable with the new optional argument "mode").
49 Release 0.6 (2009-10-11)
50 ========================
54 Docutils 0.5 is the last version supporting Python 2.2.
56 Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
57 and convertible to 3.1 code.
61 The "newlatex" writer is orphaned.
63 The recommended way to generate PDF output is to use either the
64 LaTeX2e writer or one of the alternatives listed at
65 http://docutils.sourceforge.net/docs/user/links.html#pdf.
69 - Allow length units for all length specifications.
70 - Allow percent sign in "scale" argument of "figure" and "image" directives.
71 - Bugfix: The "figalign" argument of a figure now works as intended
72 (aligning the figure not its contents).
73 - Align images with class "align-[right|center|left]"
74 (allows setting the alignment of an image in a figure).
75 - Hard tabs in literal inclusions are replaced by spaces. This is
76 configurable via the new "tab-width" option of the "include" directive
77 (a negative tab-width prevents tab expansion).
81 - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
82 separated list of stylesheets.
87 - font-encoding: "T1" (formerly implicitely set by 'ae').
88 - use-latex-toc: true (ToC with page numbers).
89 - use-latex-footnotes: true (no mixup with figures).
90 - Float placement defaults to "here definitely" (configurable).
91 - Align of image in a figure defaults to 'center'.
92 - Use class defaults for page margins ('typearea' now optional).
93 - Support LaTeX packages as ``--stylesheet`` arguments.
94 - Use ``bp`` for lengths without unit or unit ``pt``,
95 do not convert ``px`` to ``pt``.
96 - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
97 - Set sub- and superscript role argument as text not math.
98 - Support custom roles based on standard roles.
99 - Load packages and define macros only if required in the document.
100 - All Docutils specific LaTeX macros are prefixed with ``DU``.
101 - Better conformance to Docutils specifications with "use_latex_toc".
102 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
103 section numbering by LaTeX.
104 - Use default font in admonitions and sidebar.
105 - Typeset generic topic as "quote with title".
106 - Use template (file and configuration option).
107 - Render doctest blocks as literal blocks (indented).
111 - moved from sandbox to Doctutils core.
115 - moved from sandbox to Doctutils core.
118 Release 0.5 (2008-06-25)
119 ========================
125 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
126 universally supported now).
130 - Better bibTeX citation support.
131 - Add ``--literal-block-env``
135 - Changed to support new python.org website structure and
140 * Changed the directive API to a new object-oriented system.
141 (Compatibility for the old, functional-style directive interface is
142 retained.) See the updated `Creating reStructuredText Directives`__
145 __ docs/howto/rst-directives.html
147 * Allow ``+`` and ``:`` in reference names requested for citations.
151 * Added `Deploying Docutils Securely`__
153 __ docs/howto/security.txt
155 Internationalization:
157 * Added hebrew mappings.
161 * Configuration files are now assumed and required to be
164 * Added docutils/writers/html4css1/template.txt.
166 * Enhance emacs support.
168 Release 0.4 (2006-01-09)
169 ========================
173 Docutils 0.4.x is the last version that will support Python 2.1.
174 Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
175 or later will be required.
177 Docutils 0.4.x is the last version that will make compromises in
178 its HTML output for Netscape Navigator 4. Docutils 0.5 will
179 require more up-to-date browsers (the exact definition is to be
184 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
185 multi-platform, multi-browser HTML slide shows.
187 __ docs/user/slide-shows.html
188 __ docs/user/tools.html#rst2s5-py
190 * The newlatex2e writer is nearing completion.
192 * Added a DocTree reader, ``publish_doctree`` and
193 ``publish_from_doctree`` convenience functions, for document tree
194 extraction and reprocessing.
198 * Added directives: "container__" (generic block-level container),
199 "default-role__" (role used for \`backtick\` syntax), "title__"
200 (document title metadata), and "date__" (generate the current local
201 date, for substitution definitions).
203 __ docs/ref/rst/directives.html#container
204 __ docs/ref/rst/directives.html#default-role
205 __ docs/ref/rst/directives.html#title
206 __ docs/ref/rst/directives.html#date
208 * Length units are now supported for image__ sizes.
210 __ docs/ref/rst/directives.html#image
212 * Added `standard definition files`__ for special characters etc.
214 __ docs/ref/rst/definitions.html
216 Internationalization:
218 * Added Japanese and Simplified Chinese language mappings, and support
219 for double-width CJK-characters in tables and section titles.
223 * Added a `guide for distributors`__ (package maintainers) and a
224 `guide for developers`__.
226 __ docs/dev/distributing.html
227 __ docs/dev/hacking.html
231 * Added significant `Emacs support for reST`__.
233 __ docs/user/emacs.html
235 * Added a `--strip-comments`__ option.
237 __ docs/user/config.html#strip-comments
239 * `--embed-stylesheet`__ is now the default for the HTML writer
240 (rather than --link-stylesheet).
242 __ docs/user/config.html#embed-stylesheet
245 Release 0.3.9 (2005-05-26)
246 ==========================
248 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
250 __ docs/user/config.html#file-insertion-enabled
251 __ docs/user/config.html#raw-enabled
253 * Added `auto-enumerated lists`__.
255 __ docs/ref/rst/restructuredtext.html#enumerated-lists
257 * Added `"header" and "footer"`__ directives.
259 __ docs/ref/rst/directives.html#document-header-footer
261 * Added "list-table__" directive.
263 __ docs/ref/rst/directives.html#list-table
265 * Added support for `section subtitles`__.
267 __ docs/user/config.html#sectsubtitle-xform
269 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
271 __ docs/user/config.html#field-name-limit
272 __ docs/user/config.html#option-limit
274 * Added "cloak_email_addresses__" setting to HTML writer.
276 __ docs/user/config.html#cloak-email-addresses
278 * UTF-8 BOMs are now removed from the input stream.
281 Release 0.3.7 (2004-12-24)
282 ==========================
284 * A special "`line block`__" syntax has been added. (Also see the
285 `quick reference`__.)
287 __ docs/ref/rst/restructuredtext.html#line-blocks
288 __ docs/user/rst/quickref.html#line-blocks
290 * Empty sections are now allowed.
292 * A "raw__" role has been added.
294 __ docs/ref/rst/roles.html#raw
296 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
297 so that they are no longer transformed by LaTeX to en or em dashes.
298 (Please see the FAQ__ for how to represent such dashes.)
300 __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
302 * A `dependency recorder`__ has been added.
304 __ docs/user/config.html#record-dependencies
306 * A directive has been added for `compound paragraphs`__.
308 __ docs/ref/rst/directives.html#compound-paragraph
311 Release 0.3.5 (2004-07-29)
312 ==========================
314 * Improved, extended and reorganized the documentation__.
318 * Added "csv-table__" directive.
320 __ docs/ref/rst/directives.html#csv-table