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