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