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