RELEASE-NOTES.txt

   1 ========================
   2  Docutils Release Notes
   3 ========================
   4
   5 :Author: Lea Wiemann
   6 :Contact: LeWiemann@gmail.com
   7 :Date: $Date$
   8 :Revision: $Revision$
   9 :Web site: http://docutils.sourceforge.net/
  10 :Copyright: This document has been placed in the public domain.
  11
  12
  13 This document summarizes the major changes in recent releases.  For a
  14 more detailed list of changes, please see the `Docutils History`_.
  15
  16 .. _Docutils History: HISTORY.html
  17
  18 .. contents::
  19
  20
  21 Changes Since 0.7
  22 =================
  23
  24 * COPYING:
  25
  26   The XeTeX writer and the math subpackage are, in accordance with the
  27   `Docutils policies`_, licensed under the `Apache License version 2.0`_.
  28   Note, that this license is `compatible with GPL`_ version 3, but not
  29   GPL version 2.
  30
  31   .. _Docutils policies: docs/dev/policies.txt
  32   .. _Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
  33   .. _compatible with GPL: http://www.gnu.org/licenses/license-list.html
  34
  35 * General:
  36
  37   - Handle language codes according to `BCP 47`_.
  38   - If the specified langauage is not supported by Docutils,
  39     warn and fall back to English.
  40   - Math support: reStructuredText "math" role and directive,
  41     ``math`` and ``math_block`` doctree elements.
  42   - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
  43
  44 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
  45
  46
  47 Release 0.7 (2010-07-07)
  48 ========================
  49
  50 Components:
  51
  52 * HTML writer:
  53
  54   - Support SVG and SWF images (thanks to Stefan Rank).
  55   - Generate valid XHTML for centered images with targets.
  56     Use CSS classes instead of "align" tags for image alignment.
  57
  58 * LaTeX2e writer:
  59
  60   - Use the ``\url`` command for URLs (breaks long URLs instead of writing
  61     into the margin).
  62   - Preserve runs of spaces in 'inline literals'.
  63   - Deprecate ``figure_footnotes`` setting.
  64   - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
  65   - New ``latex_preamble`` setting.
  66   - Use PDF standard fonts (Times/Helvetica/Courier) as default.
  67   - `hyperref` package called with ``unicode`` option (see the
  68     `hyperref config tips`__ for how to override).
  69   - Drop the special `output_encoding`__ default ("latin-1").
  70     The Docutils wide default (usually "UTF-8") is used instead.
  71
  72 __ docs/user/config.html#docutils-footnotes
  73 __ docs/user/latex.html#hyperlinks
  74 __ docs/user/latex.html#output-encoding
  75
  76 * manpage writer:
  77
  78   - Titles level 1, that is ``.SH``, always uppercase.
  79   - Apply patch from mg: literal text should be bold in man-pages.
  80
  81 General:
  82
  83 * io.FileInput opens files as text files with universal newline support
  84   (mode "rU", configurable with the new optional argument "mode").
  85
  86 * setup.py:
  87
  88   - Python 3 support: copy test/ and tools/ to the build-dir
  89     and convert Python sources with 2to3.
  90
  91 Release 0.6 (2009-10-11)
  92 ========================
  93
  94 .. Note::
  95
  96    Docutils 0.5 is the last version supporting Python 2.2.
  97
  98    Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
  99    and convertible to 3.1 code.
 100
 101 .. note::
 102
 103    The "newlatex" writer is orphaned.
 104
 105    The recommended way to generate PDF output is to use either the
 106    LaTeX2e writer or one of the alternatives listed at
 107    http://docutils.sourceforge.net/docs/user/links.html#pdf.
 108
 109 * reStructuredText:
 110
 111   - Allow length units for all length specifications.
 112   - Allow percent sign in "scale" argument of "figure" and "image" directives.
 113   - Bugfix: The "figalign" argument of a figure now works as intended
 114     (aligning the figure not its contents).
 115   - Align images with class "align-[right|center|left]"
 116     (allows setting the alignment of an image in a figure).
 117   - Hard tabs in literal inclusions are replaced by spaces. This is
 118     configurable via the new "tab-width" option of the "include" directive
 119     (a negative tab-width prevents tab expansion).
 120
 121 * HTML writer:
 122
 123   - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
 124     separated list of stylesheets.
 125
 126 * LaTeX2e writer:
 127
 128   - New defaults:
 129     - font-encoding: "T1" (formerly implicitely set by 'ae').
 130     - use-latex-toc: true (ToC with page numbers).
 131     - use-latex-footnotes: true (no mixup with figures).
 132     - Float placement defaults to "here definitely" (configurable).
 133     - Align of image in a figure defaults to 'center'.
 134     - Use class defaults for page margins ('typearea' now optional).
 135   - Support LaTeX packages as ``--stylesheet`` arguments.
 136   - Use ``bp`` for lengths without unit or unit ``pt``,
 137     do not convert ``px`` to ``pt``.
 138   - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
 139   - Set sub- and superscript role argument as text not math.
 140   - Support custom roles based on standard roles.
 141   - Load packages and define macros only if required in the document.
 142   - All Docutils specific LaTeX macros are prefixed with ``DU``.
 143   - Better conformance to Docutils specifications with "use_latex_toc".
 144   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
 145     section numbering by LaTeX.
 146   - Use default font in admonitions and sidebar.
 147   - Typeset generic topic as "quote with title".
 148   - Use template (file and configuration option).
 149   - Render doctest blocks as literal blocks (indented).
 150
 151 * ODT writer:
 152
 153   - moved from sandbox to Doctutils core.
 154
 155 * manpage writer:
 156
 157   - moved from sandbox to Doctutils core.
 158
 159
 160 Release 0.5 (2008-06-25)
 161 ========================
 162
 163 Components:
 164
 165 * HTML writer.
 166
 167   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
 168     universally supported now).
 169
 170 * LaTeX2e writer:
 171
 172   - Better bibTeX citation support.
 173   - Add ``--literal-block-env``
 174
 175 * PEP writer:
 176
 177   - Changed to support new python.org website structure and
 178     pep2pyramid.py.
 179
 180 reStructuredText:
 181
 182 * Changed the directive API to a new object-oriented system.
 183   (Compatibility for the old, functional-style directive interface is
 184   retained.)  See the updated `Creating reStructuredText Directives`__
 185   how-to.
 186
 187   __ docs/howto/rst-directives.html
 188
 189 * Allow ``+`` and ``:`` in reference names requested for citations.
 190
 191 Documentation:
 192
 193 * Added `Deploying Docutils Securely`__
 194
 195   __ docs/howto/security.txt
 196
 197 Internationalization:
 198
 199 * Added hebrew mappings.
 200
 201 General:
 202
 203 * Configuration files are now assumed and required to be
 204   UTF-8-encoded.
 205
 206 * Added docutils/writers/html4css1/template.txt.
 207
 208 * Enhance emacs support.
 209
 210 Release 0.4 (2006-01-09)
 211 ========================
 212
 213 .. Note::
 214
 215    Docutils 0.4.x is the last version that will support Python 2.1.
 216    Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
 217    or later will be required.
 218
 219    Docutils 0.4.x is the last version that will make compromises in
 220    its HTML output for Netscape Navigator 4.  Docutils 0.5 will
 221    require more up-to-date browsers (the exact definition is to be
 222    determined).
 223
 224 Components:
 225
 226 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
 227   multi-platform, multi-browser HTML slide shows.
 228
 229   __ docs/user/slide-shows.html
 230   __ docs/user/tools.html#rst2s5-py
 231
 232 * The newlatex2e writer is nearing completion.
 233
 234 * Added a DocTree reader, ``publish_doctree`` and
 235   ``publish_from_doctree`` convenience functions, for document tree
 236   extraction and reprocessing.
 237
 238 reStructuredText:
 239
 240 * Added directives: "container__" (generic block-level container),
 241   "default-role__" (role used for \`backtick\` syntax), "title__"
 242   (document title metadata), and "date__" (generate the current local
 243   date, for substitution definitions).
 244
 245   __ docs/ref/rst/directives.html#container
 246   __ docs/ref/rst/directives.html#default-role
 247   __ docs/ref/rst/directives.html#title
 248   __ docs/ref/rst/directives.html#date
 249
 250 * Length units are now supported for image__ sizes.
 251
 252   __ docs/ref/rst/directives.html#image
 253
 254 * Added `standard definition files`__ for special characters etc.
 255
 256   __ docs/ref/rst/definitions.html
 257
 258 Internationalization:
 259
 260 * Added Japanese and Simplified Chinese language mappings, and support
 261   for double-width CJK-characters in tables and section titles.
 262
 263 Documentation:
 264
 265 * Added a `guide for distributors`__ (package maintainers) and a
 266   `guide for developers`__.
 267
 268   __ docs/dev/distributing.html
 269   __ docs/dev/hacking.html
 270
 271 General:
 272
 273 * Added significant `Emacs support for reST`__.
 274
 275   __ docs/user/emacs.html
 276
 277 * Added a `--strip-comments`__ option.
 278
 279   __ docs/user/config.html#strip-comments
 280
 281 * `--embed-stylesheet`__ is now the default for the HTML writer
 282   (rather than --link-stylesheet).
 283
 284   __ docs/user/config.html#embed-stylesheet
 285
 286
 287 Release 0.3.9 (2005-05-26)
 288 ==========================
 289
 290 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
 291
 292   __ docs/user/config.html#file-insertion-enabled
 293   __ docs/user/config.html#raw-enabled
 294
 295 * Added `auto-enumerated lists`__.
 296
 297   __ docs/ref/rst/restructuredtext.html#enumerated-lists
 298
 299 * Added `"header" and "footer"`__ directives.
 300
 301   __ docs/ref/rst/directives.html#document-header-footer
 302
 303 * Added "list-table__" directive.
 304
 305   __ docs/ref/rst/directives.html#list-table
 306
 307 * Added support for `section subtitles`__.
 308
 309   __ docs/user/config.html#sectsubtitle-xform
 310
 311 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
 312
 313   __ docs/user/config.html#field-name-limit
 314   __ docs/user/config.html#option-limit
 315
 316 * Added "cloak_email_addresses__" setting to HTML writer.
 317
 318   __ docs/user/config.html#cloak-email-addresses
 319
 320 * UTF-8 BOMs are now removed from the input stream.
 321
 322
 323 Release 0.3.7 (2004-12-24)
 324 ==========================
 325
 326 * A special "`line block`__" syntax has been added.  (Also see the
 327   `quick reference`__.)
 328
 329   __ docs/ref/rst/restructuredtext.html#line-blocks
 330   __ docs/user/rst/quickref.html#line-blocks
 331
 332 * Empty sections are now allowed.
 333
 334 * A "raw__" role has been added.
 335
 336   __ docs/ref/rst/roles.html#raw
 337
 338 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
 339   so that they are no longer transformed by LaTeX to en or em dashes.
 340   (Please see the FAQ__ for how to represent such dashes.)
 341
 342   __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
 343
 344 * A `dependency recorder`__ has been added.
 345
 346   __ docs/user/config.html#record-dependencies
 347
 348 * A directive has been added for `compound paragraphs`__.
 349
 350   __ docs/ref/rst/directives.html#compound-paragraph
 351
 352
 353 Release 0.3.5 (2004-07-29)
 354 ==========================
 355
 356 * Improved, extended and reorganized the documentation__.
 357
 358   __ docs/index.html
 359
 360 * Added "csv-table__" directive.
 361
 362   __ docs/ref/rst/directives.html#csv-table