RELEASE-NOTES.txt 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665
  1. .. -*- coding: utf-8 -*-
  2. ========================
  3. Docutils Release Notes
  4. ========================
  5. :Contact: grubert@users.sourceforge.net
  6. :Maintainer: docutils-develop@lists.sourceforge.net
  7. :Date: $Date: 2017-08-03 11:01:16 +0200 (Do, 03 Aug 2017) $
  8. :Revision: $Revision: 8147 $
  9. :Web site: http://docutils.sourceforge.net/
  10. :Copyright: This document has been placed in the public domain.
  11. This document summarizes the major changes in recent and upcoming releases.
  12. For a more detailed list of changes, please see the `Docutils History`_.
  13. .. _Docutils History: HISTORY.html
  14. .. contents::
  15. Future changes
  16. ==============
  17. * Drop support for Python 2.4, 2.5, 3.1, and 3.2 immediately after the 0.14
  18. release.
  19. * Remove the `handle_io_errors` option from io.FileInput/Output.
  20. Used by Sphinx up to version 1.3.1, fixed in 1.3.2 (Nov 29, 2015).
  21. * The default HTML writer "html" with frontend ``rst2html.py`` may change
  22. from "html4css1" to "html5".
  23. Use `get_writer_by_name('html')` or the rst2html.py_ front end, if you
  24. want the output to be up-to-date automatically.
  25. Use a specific writer name or front end, if you depend on stability of the
  26. generated HTML code, e.g. because you use a custom style sheet or
  27. post-processing that may break otherwise.
  28. .. _rst2html.py: docs/user/tools.html#rst2html-py
  29. Release 0.14 (2017-08-03)
  30. =========================
  31. As rc2.
  32. * docutils/docs/ref/docutils.dtd:
  33. - Enable validation of Docutils XML documents against the DTD:
  34. * docutils/parsers/rst/:
  35. - Added functionality: escaped whitespace in URI contexts.
  36. - Consistent handling of all whitespace characters in inline markup
  37. recognition. (May break documents that relied on some whitespace
  38. characters (NBSP, ...) *not* to be recognized as whitespace.)
  39. * docutils/utils/smartquotes.py:
  40. - Update quote definitions for et, fi, fr, ro, sv, tr, uk.
  41. - Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
  42. - Differentiate apostrophe from closing single quote (if possible).
  43. - Add command line interface for stand-alone use (requires 2.7).
  44. * docutils/writers/_html_base:
  45. - Provide default title in metadata.
  46. - The MathJax CDN shut down on April 30, 2017. For security reasons, we
  47. don't use a third party public installation as default but warn
  48. if `math-output` is set to MathJax without specifying a URL.
  49. See math-output_ for details.
  50. * docutils/writers/html4css1:
  51. - Respect automatic table column sizing.
  52. * docutils/writers/latex2e/__init__.py
  53. - Handle class arguments for block-level elements by wrapping them
  54. in a "DUclass" environment. This replaces the special handling for
  55. "epigraph" and "topic" elements.
  56. * docutils/writers/odf_odt:
  57. - Language option sets ODF document's default language
  58. - Image width, scale, ... set image size in generated ODF.
  59. * tools/
  60. - New front-end ``rst2html4.py``.
  61. Release 0.13.1 (2016-12-09)
  62. ===========================
  63. * docutils/writers/html5_polyglot
  64. - New HTML writer generating `HTML 5`_.
  65. .. _HTML 5: http://www.w3.org/TR/html5/
  66. * tools/
  67. - New front-end ``rst2html5.py``.
  68. * languages: persian/farsi (fa) and latvian (la) mappings.
  69. * change default base url for :rfc: to http://tools.ietf.org/html/
  70. * tables accept widths, a list and align
  71. * latex2e: Fix admonition width, remove deprecated options,
  72. better tablewidth auto, ...
  73. * rst.el: The problem with ``electric-indent-mode`` has been fixed.
  74. Release 0.12 (2014-07-06)
  75. =========================
  76. Small changes only, release current state
  77. Release 0.11 (2013-07-22)
  78. =========================
  79. * General
  80. - Apply [ 2714873 ] Fix for the overwritting of document attributes.
  81. - Support embedded aliases within hyperlink references.
  82. - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
  83. language module) before global search.
  84. * docutils/parsers/rst/directives/tables.py
  85. - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
  86. * docutils/writers/html4css1/__init__.py
  87. - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
  88. - New setting `stylesheet_dirs` (see above).
  89. Now, it is easy to add a custom stylesheet to Docutils' default
  90. stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
  91. Changed behaviour of the default settings:
  92. if there is a file ``html4css1.css`` in the working directory of the
  93. process at launch, it is used instead of the one provided by Docutils
  94. in the writer source directory.
  95. - New default for math-output_: ``HTML math.css``.
  96. - Avoid repeated class declarations in html4css1 writer
  97. (modified version of patch [ 104 ]).
  98. .. _math-output: docs/user/config.html#math-output
  99. * docutils/writers/latex2e/__init__.py
  100. - Drop the simple algorithm replacing straight double quotes with
  101. English typographic ones.
  102. Activate the SmartQuotes_ transform if you want this feature.
  103. - New setting `stylesheet_dirs`: Comma-separated list of directories
  104. where stylesheets are found. Used by `stylesheet_path` when expanding
  105. relative path arguments.
  106. .. _SmartQuotes: docs/user/config.html#smart-quotes
  107. * docutils/writers/manpage.py
  108. - Fix [3607063] handle lines starting with a period.
  109. - Fix option separating comma was bold (thanks to Bill Morris).
  110. Release 0.10 (2012-12-16)
  111. =========================
  112. .. Note::
  113. Docutils 0.9.x is the last version supporting Python 2.3.
  114. Docutils 0.10 is compatible with Python versions from 2.4 to 3.2
  115. (cf. `Python 3 compatibility`_).
  116. * General:
  117. - SmartQuotes transform for typographic quotes and dashes.
  118. - ``docutils/math``, ``docutils/error_reporting.py``, and
  119. ``docutils/urischemes.py`` moved to the utils package.
  120. Code importing these modules needs to adapt, e.g.::
  121. try:
  122. import docutils.math as math
  123. except ImportError:
  124. import docutils.utils.math as math
  125. - enhanced math and error handling.
  126. * docutils/io.py
  127. - FileInput/FileOutput: no system-exit on IOError.
  128. The `handle_io_errors` option is ignored.
  129. .. _Python 3 compatibility: README.html#python-3-compatibility
  130. * docutils/writers/html4css1/__init__.py
  131. - Use ``<code>`` tag for inline "code",
  132. do not drop nested inline nodes (syntax highlight tokens).
  133. - Customizable MathJax URL (based on patch by Dmitry Shachnev).
  134. - No line break after opening inline math tag.
  135. * docutils/writers/latex2e/__init__.py, docutils/writers/xetex/__init__.py
  136. - Fix section numbering by LaTeX.
  137. * docutils/writers/s5_html/__init__.py
  138. - Fix [ 3556388 ] Mathjax does not work with rst2s5.
  139. Release 0.9.1 (2012-06-17)
  140. ==========================
  141. * General:
  142. Several fixes for Python 3 usage.
  143. * docutils/setup.py
  144. - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
  145. installed in the PYTHONPATH. Converted tests are now
  146. stored in ``docutils/test3/``, tools no longer need conversion.
  147. If you installed one of Docutils versions 0.7 ... 0.9 with
  148. ``setup.py install`` under Python 3, remove the spurious
  149. ``test/`` and ``tools/`` directories in the site library root.
  150. Release 0.9 (2012-05-02)
  151. =========================
  152. * General:
  153. - reStructuredText "code" role and directive with syntax highlighting
  154. by Pygments_.
  155. - "code" option of the "include" directive.
  156. .. _Pygments: http://pygments.org/
  157. - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
  158. characters and "international" quotes around inline markup.
  159. - Fix handling of missing stylesheets.
  160. * setup.py
  161. - Fix [ 2971827 ] and [ 3442827 ]
  162. extras/roman.py moved to docutils/utils/roman.py
  163. * docutils/utils.py -> docutils/utils/__init__.py
  164. - docutils.utils is now a package (providing a place for sub-modules)
  165. * docutils/writers/html4css1/__init__.py
  166. - change default for `math-output` setting to MathJax
  167. * docutils/writers/latex2e/__init__.py
  168. - Support the `abbreviation` and `acronym` standard roles.
  169. - Record only files required to generate the LaTeX source as dependencies.
  170. - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
  171. when suppressing LaTeX section numbering.
  172. Release 0.8.1 (2011-08-30)
  173. ==========================
  174. * General:
  175. - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
  176. and [ 3395920 ] (correct copyright info for rst.el).
  177. * docutils/writers/latex2e/__init__.py
  178. - Clean up Babel language setting. Restores Sphinx compatibility.
  179. Release 0.8 (2011-07-07)
  180. ========================
  181. * COPYING:
  182. - Some additions to the Docutils core are released under the 2-Clause BSD
  183. license.
  184. * General:
  185. - Handle language codes according to `BCP 47`_.
  186. - If the specified langauage is not supported by Docutils,
  187. warn and fall back to English.
  188. - Math support: reStructuredText "math" role and directive,
  189. ``math`` and ``math_block`` doctree elements.
  190. - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
  191. .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
  192. * reStructuredText:
  193. - most directives now support a "name" option that attaches a
  194. reference name. So you can write ::
  195. .. figure:: image.png
  196. :name: figure name
  197. as a short form of ::
  198. .. _figure name:
  199. .. figure:: image.png
  200. Internationalization:
  201. * Added lithuanian mappings.
  202. Components:
  203. * HTML writer:
  204. - New setting "math-output" with support for HTML, MathML, and LaTeX.
  205. * LaTeX2e writer:
  206. - Convert image URI to a local file path.
  207. - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
  208. has more than one paragraph (Wolfgang Scherer).
  209. * XeTeX writer:
  210. - New writer generating LaTeX code for compiling with ``xelatex``.
  211. XeTeX uses unicode and modern font technologies.
  212. * and fixes and enhancements here and there.
  213. Release 0.7 (2010-07-07)
  214. ========================
  215. Components:
  216. * HTML writer:
  217. - Support SVG and SWF images (thanks to Stefan Rank).
  218. - Generate valid XHTML for centered images with targets.
  219. Use CSS classes instead of "align" tags for image alignment.
  220. * LaTeX2e writer:
  221. - Use the ``\url`` command for URLs (breaks long URLs instead of writing
  222. into the margin).
  223. - Preserve runs of spaces in 'inline literals'.
  224. - Deprecate ``figure_footnotes`` setting.
  225. - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
  226. - New ``latex_preamble`` setting.
  227. - Use PDF standard fonts (Times/Helvetica/Courier) as default.
  228. - `hyperref` package called with ``unicode`` option (see the
  229. `hyperref config tips`__ for how to override).
  230. - Drop the special `output_encoding`__ default ("latin-1").
  231. The Docutils wide default (usually "UTF-8") is used instead.
  232. __ docs/user/config.html#docutils-footnotes
  233. __ docs/user/latex.html#hyperlinks
  234. __ docs/user/latex.html#output-encoding
  235. * manpage writer:
  236. - Titles level 1, that is ``.SH``, always uppercase.
  237. - Apply patch from mg: literal text should be bold in man-pages.
  238. General:
  239. * io.FileInput opens files as text files with universal newline support
  240. (mode "rU", configurable with the new optional argument "mode").
  241. * setup.py:
  242. - Python 3 support: copy test/ and tools/ to the build-dir
  243. and convert Python sources with 2to3.
  244. Release 0.6 (2009-10-11)
  245. ========================
  246. .. Note::
  247. Docutils 0.5 is the last version supporting Python 2.2.
  248. Docutils 0.6 is compatible with Python versions from 2.3 up to 2.6
  249. and convertible to 3.1 code.
  250. .. note::
  251. The "newlatex" writer is orphaned.
  252. The recommended way to generate PDF output is to use either the
  253. LaTeX2e writer or one of the alternatives listed at
  254. http://docutils.sourceforge.net/docs/user/links.html#pdf.
  255. * reStructuredText:
  256. - Allow length units for all length specifications.
  257. - Allow percent sign in "scale" argument of "figure" and "image" directives.
  258. - Bugfix: The "figalign" argument of a figure now works as intended
  259. (aligning the figure not its contents).
  260. - Align images with class "align-[right|center|left]"
  261. (allows setting the alignment of an image in a figure).
  262. - Hard tabs in literal inclusions are replaced by spaces. This is
  263. configurable via the new "tab-width" option of the "include" directive
  264. (a negative tab-width prevents tab expansion).
  265. * HTML writer:
  266. - ``--stylesheet`` and ``--stylesheet-path`` options now support a comma
  267. separated list of stylesheets.
  268. * LaTeX2e writer:
  269. - New defaults:
  270. - font-encoding: "T1" (formerly implicitely set by 'ae').
  271. - use-latex-toc: true (ToC with page numbers).
  272. - use-latex-footnotes: true (no mixup with figures).
  273. - Float placement defaults to "here definitely" (configurable).
  274. - Align of image in a figure defaults to 'center'.
  275. - Use class defaults for page margins ('typearea' now optional).
  276. - Support LaTeX packages as ``--stylesheet`` arguments.
  277. - Use ``bp`` for lengths without unit or unit ``pt``,
  278. do not convert ``px`` to ``pt``.
  279. - Do not use 'ae' and 'aeguill' packages if font-encoding is set to ''.
  280. - Set sub- and superscript role argument as text not math.
  281. - Support custom roles based on standard roles.
  282. - Load packages and define macros only if required in the document.
  283. - All Docutils specific LaTeX macros are prefixed with ``DU``.
  284. - Better conformance to Docutils specifications with "use_latex_toc".
  285. - If 'sectnum_xform' is False, the 'sectnum' directive triggers
  286. section numbering by LaTeX.
  287. - Use default font in admonitions and sidebar.
  288. - Typeset generic topic as "quote with title".
  289. - Use template (file and configuration option).
  290. - Render doctest blocks as literal blocks (indented).
  291. * ODT writer:
  292. - moved from sandbox to Doctutils core.
  293. * manpage writer:
  294. - moved from sandbox to Doctutils core.
  295. Release 0.5 (2008-06-25)
  296. ========================
  297. Components:
  298. * HTML writer.
  299. - Dropped all ``name`` attributes of ``a`` elements (``id`` is
  300. universally supported now).
  301. * LaTeX2e writer:
  302. - Better bibTeX citation support.
  303. - Add ``--literal-block-env``
  304. * PEP writer:
  305. - Changed to support new python.org website structure and
  306. pep2pyramid.py.
  307. reStructuredText:
  308. * Changed the directive API to a new object-oriented system.
  309. (Compatibility for the old, functional-style directive interface is
  310. retained.) See the updated `Creating reStructuredText Directives`__
  311. how-to.
  312. __ docs/howto/rst-directives.html
  313. * Allow ``+`` and ``:`` in reference names requested for citations.
  314. Documentation:
  315. * Added `Deploying Docutils Securely`__
  316. __ docs/howto/security.txt
  317. Internationalization:
  318. * Added hebrew mappings.
  319. General:
  320. * Configuration files are now assumed and required to be
  321. UTF-8-encoded.
  322. * Added docutils/writers/html4css1/template.txt.
  323. * Enhance emacs support.
  324. Release 0.4 (2006-01-09)
  325. ========================
  326. .. Note::
  327. Docutils 0.4.x is the last version that will support Python 2.1.
  328. Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
  329. or later will be required.
  330. Docutils 0.4.x is the last version that will make compromises in
  331. its HTML output for Netscape Navigator 4. Docutils 0.5 will
  332. require more up-to-date browsers (the exact definition is to be
  333. determined).
  334. Components:
  335. * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
  336. multi-platform, multi-browser HTML slide shows.
  337. __ docs/user/slide-shows.html
  338. __ docs/user/tools.html#rst2s5-py
  339. * The newlatex2e writer is nearing completion.
  340. * Added a DocTree reader, ``publish_doctree`` and
  341. ``publish_from_doctree`` convenience functions, for document tree
  342. extraction and reprocessing.
  343. reStructuredText:
  344. * Added directives: "container__" (generic block-level container),
  345. "default-role__" (role used for \`backtick\` syntax), "title__"
  346. (document title metadata), and "date__" (generate the current local
  347. date, for substitution definitions).
  348. __ docs/ref/rst/directives.html#container
  349. __ docs/ref/rst/directives.html#default-role
  350. __ docs/ref/rst/directives.html#title
  351. __ docs/ref/rst/directives.html#date
  352. * Length units are now supported for image__ sizes.
  353. __ docs/ref/rst/directives.html#image
  354. * Added `standard definition files`__ for special characters etc.
  355. __ docs/ref/rst/definitions.html
  356. Internationalization:
  357. * Added Japanese and Simplified Chinese language mappings, and support
  358. for double-width CJK-characters in tables and section titles.
  359. Documentation:
  360. * Added a `guide for distributors`__ (package maintainers) and a
  361. `guide for developers`__.
  362. __ docs/dev/distributing.html
  363. __ docs/dev/hacking.html
  364. General:
  365. * Added significant `Emacs support for reST`__.
  366. __ docs/user/emacs.html
  367. * Added a `--strip-comments`__ option.
  368. __ docs/user/config.html#strip-comments
  369. * `--embed-stylesheet`__ is now the default for the HTML writer
  370. (rather than --link-stylesheet).
  371. __ docs/user/config.html#embed-stylesheet
  372. Release 0.3.9 (2005-05-26)
  373. ==========================
  374. * Added "file_insertion_enabled__" and "raw_enabled__" settings.
  375. __ docs/user/config.html#file-insertion-enabled
  376. __ docs/user/config.html#raw-enabled
  377. * Added `auto-enumerated lists`__.
  378. __ docs/ref/rst/restructuredtext.html#enumerated-lists
  379. * Added `"header" and "footer"`__ directives.
  380. __ docs/ref/rst/directives.html#document-header-footer
  381. * Added "list-table__" directive.
  382. __ docs/ref/rst/directives.html#list-table
  383. * Added support for `section subtitles`__.
  384. __ docs/user/config.html#sectsubtitle-xform
  385. * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
  386. __ docs/user/config.html#field-name-limit
  387. __ docs/user/config.html#option-limit
  388. * Added "cloak_email_addresses__" setting to HTML writer.
  389. __ docs/user/config.html#cloak-email-addresses
  390. * UTF-8 BOMs are now removed from the input stream.
  391. Release 0.3.7 (2004-12-24)
  392. ==========================
  393. * A special "`line block`__" syntax has been added. (Also see the
  394. `quick reference`__.)
  395. __ docs/ref/rst/restructuredtext.html#line-blocks
  396. __ docs/user/rst/quickref.html#line-blocks
  397. * Empty sections are now allowed.
  398. * A "raw__" role has been added.
  399. __ docs/ref/rst/roles.html#raw
  400. * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
  401. so that they are no longer transformed by LaTeX to en or em dashes.
  402. (Please see the FAQ__ for how to represent such dashes.)
  403. __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
  404. * A `dependency recorder`__ has been added.
  405. __ docs/user/config.html#record-dependencies
  406. * A directive has been added for `compound paragraphs`__.
  407. __ docs/ref/rst/directives.html#compound-paragraph
  408. Release 0.3.5 (2004-07-29)
  409. ==========================
  410. * Improved, extended and reorganized the documentation__.
  411. __ docs/index.html
  412. * Added "csv-table__" directive.
  413. __ docs/ref/rst/directives.html#csv-table