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 Release 0.6 (2009-10-11)
  22 ========================
  23
  24 .. Note::
  25
  26    Docutils 0.5 is the last version supporting Python 2.2.
  27
  28    Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
  29    and convertible to 3.1 code.
  30
  31 .. note::
  32
  33    The "newlatex" writer is orphaned.
  34
  35    The recommended way to generate PDF output is to use either the
  36    LaTeX2e writer or one of the alternatives listed at
  37    http://docutils.sourceforge.net/docs/user/links.html#pdf.
  38
  39 * reStructuredText:
  40
  41   - Allow length units for all length specifications.
  42   - Allow percent sign in "scale" argument of "figure" and "image" directives.
  43   - Bugfix: The "figalign" argument of a figure now works as intended
  44     (aligning the figure not its contents).
  45   - Align images with class "align-[right|center|left]"
  46     (allows setting the alignment of an image in a figure).
  47   - Hard tabs in literal inclusions are replaced by spaces. This is
  48     configurable via the new "tab-width" option of the "include" directive
  49     (a negative tab-width prevents tab expansion).
  50
  51 * HTML writer:
  52
  53   - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
  54     separated list of stylesheets.
  55
  56 * LaTeX2e writer:
  57
  58   - New defaults:
  59     - font-encoding: "T1" (formerly implicitely set by 'ae').
  60     - use-latex-toc: true (ToC with page numbers).
  61     - use-latex-footnotes: true (no mixup with figures).
  62     - Float placement defaults to "here definitely" (configurable).
  63     - Align of image in a figure defaults to 'center'.
  64     - Use class defaults for page margins ('typearea' now optional).
  65   - Support LaTeX packages as ``--stylesheet`` arguments.
  66   - Use ``bp`` for lengths without unit or unit ``pt``,
  67     do not convert ``px`` to ``pt``.
  68   - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
  69   - Set sub- and superscript role argument as text not math.
  70   - Support custom roles based on standard roles.
  71   - Load packages and define macros only if required in the document.
  72   - All Docutils specific LaTeX macros are prefixed with ``DU``.
  73   - Better conformance to Docutils specifications with "use_latex_toc".
  74   - If 'sectnum_xform' is False, the 'sectnum' directive triggers
  75     section numbering by LaTeX.
  76   - Use default font in admonitions and sidebar.
  77   - Typeset generic topic as "quote with title".
  78   - Use template (file and configuration option).
  79   - Render doctest blocks as literal blocks (indented).
  80
  81 * ODT writer:
  82
  83   - moved from sandbox to Doctutils core.
  84
  85 * manpage writer:
  86
  87   - moved from sandbox to Doctutils core.
  88
  89
  90 Release 0.5 (2008-06-25)
  91 ========================
  92
  93 Components:
  94
  95 * HTML writer.
  96
  97   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
  98     universally supported now).
  99
 100 * LaTeX2e writer:
 101
 102   - Better bibTeX citation support.
 103   - Add ``--literal-block-env``
 104
 105 * PEP writer:
 106
 107   - Changed to support new python.org website structure and
 108     pep2pyramid.py.
 109
 110 reStructuredText:
 111
 112 * Changed the directive API to a new object-oriented system.
 113   (Compatibility for the old, functional-style directive interface is
 114   retained.)  See the updated `Creating reStructuredText Directives`__
 115   how-to.
 116
 117   __ docs/howto/rst-directives.html
 118
 119 * Allow ``+`` and ``:`` in reference names requested for citations.
 120
 121 Documentation:
 122
 123 * Added `Deploying Docutils Securely`__
 124
 125   __ docs/howto/security.txt
 126
 127 Internationalization:
 128
 129 * Added hebrew mappings.
 130
 131 General:
 132
 133 * Configuration files are now assumed and required to be
 134   UTF-8-encoded.
 135
 136 * Added docutils/writers/html4css1/template.txt.
 137
 138 * Enhance emacs support.
 139
 140 Release 0.4 (2006-01-09)
 141 ========================
 142
 143 .. Note::
 144
 145    Docutils 0.4.x is the last version that will support Python 2.1.
 146    Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
 147    or later will be required.
 148
 149    Docutils 0.4.x is the last version that will make compromises in
 150    its HTML output for Netscape Navigator 4.  Docutils 0.5 will
 151    require more up-to-date browsers (the exact definition is to be
 152    determined).
 153
 154 Components:
 155
 156 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
 157   multi-platform, multi-browser HTML slide shows.
 158
 159   __ docs/user/slide-shows.html
 160   __ docs/user/tools.html#rst2s5-py
 161
 162 * The newlatex2e writer is nearing completion.
 163
 164 * Added a DocTree reader, ``publish_doctree`` and
 165   ``publish_from_doctree`` convenience functions, for document tree
 166   extraction and reprocessing.
 167
 168 reStructuredText:
 169
 170 * Added directives: "container__" (generic block-level container),
 171   "default-role__" (role used for \`backtick\` syntax), "title__"
 172   (document title metadata), and "date__" (generate the current local
 173   date, for substitution definitions).
 174
 175   __ docs/ref/rst/directives.html#container
 176   __ docs/ref/rst/directives.html#default-role
 177   __ docs/ref/rst/directives.html#title
 178   __ docs/ref/rst/directives.html#date
 179
 180 * Length units are now supported for image__ sizes.
 181
 182   __ docs/ref/rst/directives.html#image
 183
 184 * Added `standard definition files`__ for special characters etc.
 185
 186   __ docs/ref/rst/definitions.html
 187
 188 Internationalization:
 189
 190 * Added Japanese and Simplified Chinese language mappings, and support
 191   for double-width CJK-characters in tables and section titles.
 192
 193 Documentation:
 194
 195 * Added a `guide for distributors`__ (package maintainers) and a
 196   `guide for developers`__.
 197
 198   __ docs/dev/distributing.html
 199   __ docs/dev/hacking.html
 200
 201 General:
 202
 203 * Added significant `Emacs support for reST`__.
 204
 205   __ docs/user/emacs.html
 206
 207 * Added a `--strip-comments`__ option.
 208
 209   __ docs/user/config.html#strip-comments
 210
 211 * `--embed-stylesheet`__ is now the default for the HTML writer
 212   (rather than --link-stylesheet).
 213
 214   __ docs/user/config.html#embed-stylesheet
 215
 216
 217 Release 0.3.9 (2005-05-26)
 218 ==========================
 219
 220 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
 221
 222   __ docs/user/config.html#file-insertion-enabled
 223   __ docs/user/config.html#raw-enabled
 224
 225 * Added `auto-enumerated lists`__.
 226
 227   __ docs/ref/rst/restructuredtext.html#enumerated-lists
 228
 229 * Added `"header" and "footer"`__ directives.
 230
 231   __ docs/ref/rst/directives.html#document-header-footer
 232
 233 * Added "list-table__" directive.
 234
 235   __ docs/ref/rst/directives.html#list-table
 236
 237 * Added support for `section subtitles`__.
 238
 239   __ docs/user/config.html#sectsubtitle-xform
 240
 241 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
 242
 243   __ docs/user/config.html#field-name-limit
 244   __ docs/user/config.html#option-limit
 245
 246 * Added "cloak_email_addresses__" setting to HTML writer.
 247
 248   __ docs/user/config.html#cloak-email-addresses
 249
 250 * UTF-8 BOMs are now removed from the input stream.
 251
 252
 253 Release 0.3.7 (2004-12-24)
 254 ==========================
 255
 256 * A special "`line block`__" syntax has been added.  (Also see the
 257   `quick reference`__.)
 258
 259   __ docs/ref/rst/restructuredtext.html#line-blocks
 260   __ docs/user/rst/quickref.html#line-blocks
 261
 262 * Empty sections are now allowed.
 263
 264 * A "raw__" role has been added.
 265
 266   __ docs/ref/rst/roles.html#raw
 267
 268 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
 269   so that they are no longer transformed by LaTeX to en or em dashes.
 270   (Please see the FAQ__ for how to represent such dashes.)
 271
 272   __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
 273
 274 * A `dependency recorder`__ has been added.
 275
 276   __ docs/user/config.html#record-dependencies
 277
 278 * A directive has been added for `compound paragraphs`__.
 279
 280   __ docs/ref/rst/directives.html#compound-paragraph
 281
 282
 283 Release 0.3.5 (2004-07-29)
 284 ==========================
 285
 286 * Improved, extended and reorganized the documentation__.
 287
 288   __ docs/index.html
 289
 290 * Added "csv-table__" directive.
 291
 292   __ docs/ref/rst/directives.html#csv-table