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