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