docutils/RELEASE-NOTES.txt

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