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