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