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