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