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