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