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