RELEASE-NOTES.txt

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