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