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