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
  21 Changes Since 0.5
  22 =================
  23
  24
  25 Release 0.5 (2008-06-25)
  26 ========================
  27
  28 Components:
  29
  30 * HTML writer.
  31
  32   - Dropped all ``name`` attributes of ``a`` elements (``id`` is
  33     universally supported now).
  34
  35 * LaTeX2e writer:
  36
  37   - Better bibTeX citation support.
  38   - Add ``--literal-block-env``
  39
  40 * PEP writer:
  41
  42   - Changed to support new python.org website structure and
  43     pep2pyramid.py.
  44
  45 reStructuredText:
  46
  47 * Changed the directive API to a new object-oriented system.
  48   (Compatibility for the old, functional-style directive interface is
  49   retained.)  See the updated `Creating reStructuredText Directives`__
  50   how-to.
  51
  52   __ docs/howto/rst-directives.html
  53
  54 * Allow ``+`` and ``:`` in reference names requested for citations.
  55
  56 Documentation:
  57
  58 * Added `Deploying Docutils Securely`__
  59
  60   __ docs/howto/security.txt
  61
  62 Internationalization:
  63
  64 * Added hebrew mappings.
  65
  66 General:
  67
  68 * Configuration files are now assumed and required to be
  69   UTF-8-encoded.
  70
  71 * Added docutils/writers/html4css1/template.txt.
  72
  73 * Enhance emacs support.
  74
  75 Release 0.4 (2006-01-09)
  76 ========================
  77
  78 .. Note::
  79
  80    Docutils 0.4.x is the last version that will support Python 2.1.
  81    Docutils 0.5 will *not* be compatible with Python 2.1; Python 2.2
  82    or later will be required.
  83
  84    Docutils 0.4.x is the last version that will make compromises in
  85    its HTML output for Netscape Navigator 4.  Docutils 0.5 will
  86    require more up-to-date browsers (the exact definition is to be
  87    determined).
  88
  89 Components:
  90
  91 * Added an `S5/HTML writer`__ and the rst2s5.py__ front end:
  92   multi-platform, multi-browser HTML slide shows.
  93
  94   __ docs/user/slide-shows.html
  95   __ docs/user/tools.html#rst2s5-py
  96
  97 * The newlatex2e writer is nearing completion.
  98
  99 * Added a DocTree reader, ``publish_doctree`` and
 100   ``publish_from_doctree`` convenience functions, for document tree
 101   extraction and reprocessing.
 102
 103 reStructuredText:
 104
 105 * Added directives: "container__" (generic block-level container),
 106   "default-role__" (role used for \`backtick\` syntax), "title__"
 107   (document title metadata), and "date__" (generate the current local
 108   date, for substitution definitions).
 109
 110   __ docs/ref/rst/directives.html#container
 111   __ docs/ref/rst/directives.html#default-role
 112   __ docs/ref/rst/directives.html#title
 113   __ docs/ref/rst/directives.html#date
 114
 115 * Length units are now supported for image__ sizes.
 116
 117   __ docs/ref/rst/directives.html#image
 118
 119 * Added `standard definition files`__ for special characters etc.
 120
 121   __ docs/ref/rst/definitions.html
 122
 123 Internationalization:
 124
 125 * Added Japanese and Simplified Chinese language mappings, and support
 126   for double-width CJK-characters in tables and section titles.
 127
 128 Documentation:
 129
 130 * Added a `guide for distributors`__ (package maintainers) and a
 131   `guide for developers`__.
 132
 133   __ docs/dev/distributing.html
 134   __ docs/dev/hacking.html
 135
 136 General:
 137
 138 * Added significant `Emacs support for reST`__.
 139
 140   __ docs/user/emacs.html
 141
 142 * Added a `--strip-comments`__ option.
 143
 144   __ docs/user/config.html#strip-comments
 145
 146 * `--embed-stylesheet`__ is now the default for the HTML writer
 147   (rather than --link-stylesheet).
 148
 149   __ docs/user/config.html#embed-stylesheet
 150
 151
 152 Release 0.3.9 (2005-05-26)
 153 ==========================
 154
 155 * Added "file_insertion_enabled__" and "raw_enabled__" settings.
 156
 157   __ docs/user/config.html#file-insertion-enabled
 158   __ docs/user/config.html#raw-enabled
 159
 160 * Added `auto-enumerated lists`__.
 161
 162   __ docs/ref/rst/restructuredtext.html#enumerated-lists
 163
 164 * Added `"header" and "footer"`__ directives.
 165
 166   __ docs/ref/rst/directives.html#document-header-footer
 167
 168 * Added "list-table__" directive.
 169
 170   __ docs/ref/rst/directives.html#list-table
 171
 172 * Added support for `section subtitles`__.
 173
 174   __ docs/user/config.html#sectsubtitle-xform
 175
 176 * Added "field_name_limit__" and "option_limit__" settings to HTML writer.
 177
 178   __ docs/user/config.html#field-name-limit
 179   __ docs/user/config.html#option-limit
 180
 181 * Added "cloak_email_addresses__" setting to HTML writer.
 182
 183   __ docs/user/config.html#cloak-email-addresses
 184
 185 * UTF-8 BOMs are now removed from the input stream.
 186
 187
 188 Release 0.3.7 (2004-12-24)
 189 ==========================
 190
 191 * A special "`line block`__" syntax has been added.  (Also see the
 192   `quick reference`__.)
 193
 194   __ docs/ref/rst/restructuredtext.html#line-blocks
 195   __ docs/user/rst/quickref.html#line-blocks
 196
 197 * Empty sections are now allowed.
 198
 199 * A "raw__" role has been added.
 200
 201   __ docs/ref/rst/roles.html#raw
 202
 203 * The LaTeX writer now escapes consecutive dashes (like "--" or "---")
 204   so that they are no longer transformed by LaTeX to en or em dashes.
 205   (Please see the FAQ__ for how to represent such dashes.)
 206
 207   __ FAQ.html#how-can-i-represent-esoteric-characters-e-g-character-entities-in-a-document
 208
 209 * A `dependency recorder`__ has been added.
 210
 211   __ docs/user/config.html#record-dependencies
 212
 213 * A directive has been added for `compound paragraphs`__.
 214
 215   __ docs/ref/rst/directives.html#compound-paragraph
 216
 217
 218 Release 0.3.5 (2004-07-29)
 219 ==========================
 220
 221 * Improved, extended and reorganized the documentation__.
 222
 223   __ docs/index.html
 224
 225 * Added "csv-table__" directive.
 226
 227   __ docs/ref/rst/directives.html#csv-table