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