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