RELEASE-NOTES.txt

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