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