HISTORY.txt

   1 ==================
   2  Docutils History
   3 ==================
   4
   5 :Author: David Goodger
   6 :Contact: goodger@users.sourceforge.net
   7 :Date: $Date$
   8 :Web site: http://docutils.sourceforge.net/
   9
  10 .. contents::
  11
  12 Acknowledgements
  13 ================
  14
  15 I would like to acknowledge the people who have made a direct impact
  16 on the Docutils project, knowingly or not, in terms of encouragement,
  17 suggestions, criticism, bug reports, code contributions, tasty treats,
  18 and related projects:
  19
  20     Aahz, David Ascher, Fred Bremmer, Simon Budig, Brett Cannon, Adam
  21     Chodorowski, Fred Drake, Dethe Elza, fantasai, Jim Fulton, Peter
  22     Funk, Jorge Gonzalez, Engelbert Gruber, Simon Hefti, Doug
  23     Hellmann, Juergen Hermann, Jeremy Hylton, Tony Ibbs, Alan Jaffray,
  24     Dmitry Jemerov, Richard Jones, Garth Kidd, Daniel Larsson,
  25     Marc-Andre Lemburg, Julien Letessier, Wolfgang Lipp, Edward Loper,
  26     Dallas Mahrt, Ken Manheimer, Skip Montanaro, Paul Moore, Michel
  27     Pelletier, Sam Penrose, Tim Peters, Pearu Peterson, Mark Pilgrim,
  28     Tavis Rudd, Ollie Rutherfurd, Kenichi Sato, Ueli Schlaepfer,
  29     Gunnar Schwant, tav, Bob Tolbert, Laurence Tratt, Guido van
  30     Rossum, Barry Warsaw, Edward Welbourne, Ka-Ping Yee, Moshe Zadka
  31
  32 Thank you!
  33
  34 (I'm still waiting for contributions of computer equipment and cold
  35 hard cash :-).)  Hopefully I haven't forgotten anyone or misspelled
  36 any names; apologies (and please let me know!) if I have.
  37
  38
  39 Changes Since 0.2
  40 ========================
  41
  42 General:
  43
  44 - Changed "attribute" to "option" for directives/extensions.
  45
  46 Specific:
  47
  48 * FAQ.txt: Frequently asked questions, added to project.
  49
  50 * docutils/__init__.py:
  51
  52   - Bumped version to 0.2.1 to reflect changes to I/O classes.
  53   - Bumped version to 0.2.2 to reflect changes to stylesheet options.
  54   - Factored ``OptionSpec`` out of ``Component``; separately useful.
  55   - Bumped version to 0.2.3 because of the new ``--embed-stylesheet``
  56     option and its effect on the PEP template & writer.
  57   - Bumped version to 0.2.4 due to changes to the PEP template &
  58     stylesheet.
  59   - Bumped version to 0.2.5 to reflect changes to Reporter output.
  60   - Added ``TransformSpec`` class for new transform system.
  61
  62 * docutils/core.py:
  63
  64   - Made ``publish()`` a bit more convenient.
  65   - Generalized ``Publisher.set_io``.
  66
  67 * docutils/frontend.py:
  68
  69   - Check for & exit on identical source & destination paths.
  70   - Fixed bug with absolute paths & ``--config``.
  71   - Set non-command-line defaults in ``OptionParser.__init__()``:
  72     ``_source`` & ``_destination``.
  73   - Distributed ``relative_path_options`` to components; updated
  74     ``OptionParser.populate_from_components()`` to combine it all.
  75   - Require list of keys in ``make_paths_absolute`` (was implicit in
  76     global ``relative_path_options``).
  77   - Added ``--expose-internal-attribute`` option.
  78
  79 * docutils/io.py:
  80
  81   - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
  82   - Added automatic closing to ``FileInput`` and ``FileOutput``.
  83   - Delayed opening of ``FileOutput`` file until ``write()`` called.
  84   - ``FileOutput.write()`` now returns the encoded output string.
  85   - Try to get path/stream name automatically in ``FileInput`` &
  86     ``FileOutput``.
  87   - Added defaults for source & destination paths.
  88   - Allow for Unicode string I/O with an explicit "unicode" encoding.
  89
  90 * docutils/nodes.py:
  91
  92   - Added "Invisible" element category class.
  93   - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
  94     modification during a traversal.
  95   - Added element classes: ``line_block``, ``generated``, ``address``.
  96   - Added support for lists of nodes to ``Element.insert()``.
  97   - Fixed parent linking in ``Element.replace()``.
  98   - Added new abstract superclass ``FixedTextElement``; adds
  99     "xml:space" attribute.
 100   - Added support for "line" attribute of ``system_message`` nodes.
 101   - Added support for the observer pattern from ``utils.Reporter``.
 102     Added ``parse_messages`` and ``transform_messages`` attributes to
 103     ``document``, removed ``messages``.  Added ``note_parse_message``
 104     and ``note_transform_message`` methods.
 105   - Added support for improved diagnostics:
 106
 107     - Added "document", "source", and "line" internal attributes to
 108       ``Node``, set by ``Node.setup_child()``.
 109     - Converted variations on ``node.parent = self`` to
 110       ``self.setup_child(node)``.
 111     - Added ``document.current_source`` & ``.current_line``
 112       attributes, and ``.note_state_machine_change`` &
 113       ``.note_source`` observer methods.
 114     - Changed "system_message" output to GNU-Tools format.
 115
 116   - Added a "rawsource" attribute to the ``Text`` class, for text
 117     before backslash-escape resolution.
 118   - Support for new transform system.
 119
 120 * docutils/statemachine.py:
 121
 122   - Factored out ``State.add_initial_transitions()`` so it can be
 123     extended.
 124   - Converted whitespace-specific "blank" and "indent" transitions
 125     from special-case code to ordinary transitions: removed
 126     ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
 127     ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
 128     ``ws_initial_transitions`` attributes.
 129   - Removed ``State.match_transition()`` after merging it into
 130     ``.check_line()``.
 131   - Added ``StateCorrection`` exception.
 132   - Added support for ``StateCorrection`` in ``StateMachine.run()``
 133     (moved ``TransitionCorrection`` support there too.)
 134   - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
 135     ``EOFError`` instead of ``IndexError``.
 136   - Added ``State.no_match`` method.
 137   - Added support for the Observer pattern, triggered by input line
 138     changes.
 139   - Added ``strip_top`` parameter to
 140     ``StateMachineWS.get_first_known_indented``.
 141
 142 * docutils/utils.py:
 143
 144   - Added a ``source`` attribute to Reporter instances and
 145     ``system_message`` elements.
 146   - Added an observer pattern to ``utils.Reporter`` to keep track of
 147     system messages.
 148   - Fixed a bug in ``relative_path()``.
 149   - Added support for improved diagnostics.
 150
 151 * docutils/parser/rst/__init__.py:
 152
 153   - Added options: "--pep-references", "--rfc-references",
 154     "--tab-width".
 155
 156 * docutils/parsers/rst/states.py:
 157
 158   - Changed "title under/overline too short" system messages from INFO
 159     to WARNING, and fixed its insertion location.
 160   - Fixed enumerated list item parsing to allow paragraphs & section
 161     titles to begin with enumerators.
 162   - Converted system messages to use the new "line" attribute.
 163   - Fixed a substitution reference edge case.
 164   - Added support for "--pep-references" and "--rfc-references"
 165     options; reworked ``Inliner`` code to make customization easier.
 166   - Removed field argument parsing.
 167   - Added support for short section title over/underlines.
 168   - Fixed "simple reference name" regexp to ignore text like
 169     "object.__method__"; not an anonymous reference.
 170   - Added support for improved diagnostics.
 171   - Reworked directive API, based on Dethe Elza's contribution.  Added
 172     ``Body.parse_directive()``, ``.parse_directive_options()``,
 173     ``.parse_directive_arguments()`` methods.
 174   - Added ``ExtensionOptions`` class, to parse directive options
 175     without parsing field bodies.  Factored
 176     ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
 177     ``ExtensionOptions``.
 178   - Improved definition list term/classifier parsing.
 179   - Added warnings for unknown directives.
 180
 181 * docutils/parsers/rst/tableparser.py:
 182
 183   - Fixed a bug that was producing unwanted empty rows in "simple"
 184     tables.
 185
 186 * docutils/parsers/rst/directives: Updated all directive functions to
 187   new API.
 188
 189 * docutils/parsers/rst/directives/__init__.py:
 190
 191   - Added ``flag()``, ``unchanged()``, ``path()``,
 192     ``nonnegative_int()``, and ``choice()`` directive option helper
 193     functions.
 194   - Added warnings for unknown directives.
 195
 196 * docutils/parsers/rst/directives/body.py: Added to project.  Contains
 197   the "topic", "line-block", and "parsed-literal" directives.
 198
 199 * docutils/parsers/rst/directives/images.py:
 200
 201   - Added an "align" attribute to the "image" & "figure" directives
 202     (by Adam Chodorowski).
 203
 204 * docutils/parsers/rst/directives/misc.py:
 205
 206   - Added "include", "raw", and "replace" directives, courtesy of
 207     Dethe Elza.
 208
 209 * docutils/parsers/rst/directives/parts.py:
 210
 211   - Added the "sectnum" directive; by Dmitry Jemerov.
 212
 213 * docutils/parsers/rst/directives/references.py: Added to project.
 214   Contains the "target-notes" directive.
 215
 216 * docutils/readers/__init__.py:
 217
 218   - Added support for the observer pattern from ``utils.Reporter``, in
 219     ``Reader.parse`` and ``Reader.transform``.
 220
 221 * docutils/readers/pep.py:
 222
 223   - Added the ``peps.TargetNotes`` transform to the Reader.
 224   - Removed PEP & RFC reference detection code; moved to
 225     parsers/rst/states.py as options (enabled here by default).
 226   - Added support for pre-acceptance PEPs (no PEP number yet).
 227
 228 * docutils/transforms/__init__.py:
 229
 230   - Added ``Transformer`` class.
 231
 232 * docutils/transforms/frontmatter.py:
 233
 234   - Improved support for generic fields.
 235
 236 * docutils/transforms/parts.py:
 237
 238   - Moved the "id" attribute from TOC list items to the references
 239     (``Contents.build_contents()``).
 240   - Added the ``SectNum`` transform; by Dmitry Jemerov.
 241
 242 * docutils/transforms/peps.py:
 243
 244   - Added ``mask_email()`` function, updating to pep2html.py's
 245     functionality.
 246   - Linked "Content-Type: text/x-rst" to PEP 12.
 247   - Added the ``TargetNotes`` PEP-specific transform.
 248
 249 * docutils/transforms/references.py:
 250
 251   - Added the ``TargetNotes`` generic transform.
 252
 253 * docutils/transforms/universal.py:
 254
 255   - Added support for the ``--expose-internal-attributes`` option.
 256
 257 * docutils/writers/docutils-xml.py:
 258
 259   - Added XML and doctype declarations.
 260
 261 * docutils/writers/html4css1.py:
 262
 263   - "name" attributes only on these tags: a, applet, form, frame,
 264     iframe, img, map.
 265   - Added "name" attribute to <a> in section titles for Netscape 4
 266     support (bug report: Pearu Peterson).
 267   - Fixed targets (names) on footnote, citation, topic title,
 268     problematic, and system_message nodes (for Netscape 4).
 269   - Changed field names from "<td>" to "<th>".
 270   - Added "@" to "&#64;" encoding to thwart address harvesters.
 271   - Improved the vertical whitespace optimization; ignore "invisible"
 272     nodes (targets, comments, etc.).
 273   - Improved inline literals with ``<span class="pre">`` around chunks
 274     of text and ``&nbsp;`` for runs of spaces.
 275   - Improved modularity of output; added ``self.body_pre_docinfo`` and
 276     ``self.docinfo`` segments.
 277   - Added support for "line_block", "address" elements.
 278   - Improved backlinks (footnotes & system_messages).
 279   - Improved system_message output.
 280   - Redefined "--stylesheet" as containing an invariant URL, used
 281     verbatim.  Added "--stylesheet-path", interpreted w.r.t. the
 282     working directory.
 283   - Added "--footnote-references" option (superscript or brackets).
 284   - Added "--compact-lists" and "--no-compact-lists" options.
 285   - Added "--embed-stylesheet" and "--link-stylesheet" options;
 286     factored out ``HTMLTranslator.get_stylesheet_reference()``.
 287   - Improved field list rendering.
 288   - Added Docutils version to "generator" meta tag.
 289   - Fixed a bug with images; they must be inline, so wrapped in <p>.
 290
 291 * docutils/writers/pep_html.py:
 292
 293   - Parameterized output encoding in PEP template.
 294   - Reworked substitutions from ``locals()`` into ``subs`` dict.
 295   - Redefined "--pep-stylesheet" as containing an invariant URL, used
 296     verbatim.  Added "--pep-stylesheet-path", interpreted w.r.t. the
 297     working directory.
 298   - Added an override on the "--footnote-references" option.
 299   - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
 300   - Added Docutils version to "generator" meta tag.
 301
 302 * docs/tools.txt:
 303
 304   - Added a "silent" setting for ``buildhtml.py``.
 305   - Added a "Getting Help" section.
 306   - Rearranged the structure.
 307   - Kept up to date, with new command-line options etc.
 308
 309 * docs/rst/quickstart.txt:
 310
 311   - Added a table of contents.
 312   - Added feedback information.
 313   - Added mention of minimum section title underline lengths.
 314   - Removed the 4-character minimum for section title underlines.
 315
 316 * docs/rst/quickref.html:
 317
 318   - Added a "Getting Help" section.
 319   - Added a style to make section title backlinks more subtle.
 320   - Added mention of minimum section title underline lengths.
 321   - Removed the 4-character minimum for section title underlines.
 322
 323 * spec/doctree.txt:
 324
 325   - Changed the focus.  It's about DTD elements:  structural
 326     relationships, semantics, and external (public) attributes.  Not
 327     about the element class library.
 328   - Moved some implementation-specific stuff into ``docutils.nodes``
 329     docstrings.
 330   - Wrote descriptions of all common attributes and parameter
 331     entities.  Filled in introductory material.
 332   - Working through the element descriptions: 33 down, 50 to go.
 333   - Removed "Representation of Horizontal Rules" to
 334     spec/rst/alternatives.txt.
 335
 336 * spec/docutils.dtd:
 337
 338   - Added "generated" inline element.
 339   - Added "line_block" body element.
 340   - Added "auto" attribute to "title".
 341   - Changed content models of "literal_block" and "doctest_block" to
 342     ``%text.model``.
 343   - Added ``%number;`` attribute type parameter entity.
 344   - Changed ``%structural.elements;`` to ``%section.elements``.
 345   - Updated attribute types; made more specific.
 346   - Added "address" bibliographic element.
 347   - Added "line" attribute to ``system_message`` element.
 348   - Removed "field_argument" element; "field_name" may contain
 349     multiple words and whitespace.
 350   - Changed public identifier to docutils.sf.net.
 351
 352 * spec/pep-0256.txt: Converted to reStructuredText & updated.
 353
 354 * spec/pep-0257.txt: Converted to reStructuredText & updated.
 355
 356 * spec/pep-0258.txt: Converted to reStructuredText & updated.
 357
 358 * spec/semantics.txt: Updated with text from a Doc-SIG response to
 359   Dallas Mahrt.
 360
 361 * spec/howto: Added subdirectory, for developer how-to docs.
 362
 363 * spec/howto/rst-directives.txt: Added to project.  Original by Dethe
 364   Elza, edited & extended by David Goodger.
 365
 366 * spec/howto/i18n.txt: Docutils Internationalization.  Added to
 367   project.
 368
 369 * spec/rst/alternatives.txt:
 370
 371   - Added "Doctree Representation of Transitions" from
 372     spec/doctree.txt.
 373
 374 * spec/rst/directives.txt:
 375
 376   - Added directives: "topic", "sectnum", "target-notes",
 377     "line-block", "parsed-literal", "include", "replace".
 378   - Formalized descriptions of directive details.
 379   - Added an "align" attribute to the "image" & "figure" directives
 380     (by Adam Chodorowski).
 381
 382 * spec/rst/introduction.txt:
 383
 384   - Added pointers to material for new users.
 385
 386 * spec/rst/reStructuredText.txt:
 387
 388   - Disambiguated comments (just add a newline after the "::").
 389   - Updated enumerated list description; added a discussion of the
 390     second-line validity checking.
 391   - Updated directive description.
 392   - Added a note redirecting newbies to the user docs.
 393   - Expanded description of inline markup start-strings in non-markup
 394     contexts.
 395   - Removed field arguments and made field lists a generic construct.
 396   - Removed the 4-character minimum for section title underlines.
 397   - Clarified term/classifier delimiter & inline markup ambiguity
 398     (definition lists).
 399
 400 * tools:
 401
 402   - Made the ``locale.setlocale()`` calls in front ends
 403     fault-tolerant.
 404
 405 * tools/buildhtml.py:
 406
 407   - Added ``--silent`` option.
 408   - Fixed bug with absolute paths & ``--config``.
 409   - Updated for new I/O classes.
 410   - Added some exception handling.
 411   - Separated publishers' option defaults; prevents interference.
 412
 413 * tools/pep-html-template:
 414
 415   - Allow for ``--embed-stylesheet``.
 416   - Added Docutils version to "generator" meta tag.
 417
 418 * tools/pep2html.py:
 419
 420   - Made ``argv`` a parameter to ``main()``.
 421   - Added support for "Content-Type:" header & arbitrary PEP formats.
 422   - Linked "Content-Type: text/plain" to PEP 9.
 423   - Files skipped (due to an error) are not pushed onto the server.
 424   - Updated for new I/O classes.
 425   - Added ``check_requirements()`` & ``pep_type_error()``.
 426   - Added some exception handling.
 427
 428 * tools/quicktest.py:
 429
 430   - Added ``-V``/``--version`` option.
 431
 432 * tools/stylesheets/default.css: Moved into the stylesheets directory.
 433
 434   - Added style for chunks of inline literals.
 435   - Removed margin for first child of table cells.
 436   - Right-aligned field list names.
 437   - Support for auto-numbered section titles in TOCs.
 438   - Increased the size of inline literals (<tt>) in titles.
 439   - Restored the light gray background for inline literals.
 440   - Added support for "line_block" elements.
 441   - Added style for "address" elements.
 442   - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
 443   - Improved field list rendering.
 444   - Vertical whitespace improvements.
 445
 446 * tools/stylesheets/pep.css:
 447
 448   - Fixed nested section margins.
 449   - Other changes parallel those of ``../default.css``.
 450
 451
 452 Release 0.2 (2002-07-31)
 453 ========================
 454
 455 General:
 456
 457 - The word "component" was being used ambiguously.  From now on,
 458   "component" will be used to mean "Docutils component", as in Reader,
 459   Writer, Parser, or Transform.  Portions of documents (Table of
 460   Contents, sections, etc.)  will be called "document parts".
 461 - Did a grand renaming: a lot of ``verylongnames`` became
 462   ``very_long_names``.
 463 - Cleaned up imports: no more relative package imports or
 464   comma-separated lists of top-level modules.
 465 - Added support for an option values object which carries default
 466   settings and overrides (from command-line options and library use).
 467 - Added internal Unicode support, and support for both input and
 468   output encodings.
 469 - Added support for the ``docutils.io.IO`` class & subclasses.
 470
 471 Specific:
 472
 473 * docutils/__init__.py:
 474
 475   - Added ``ApplicationError`` and ``DataError``, for use throughout
 476     the package.
 477   - Added ``Component`` base class for Docutils components; implements
 478     the ``supports`` method.
 479   - Added ``__version__`` (thus, ``docutils.__version__``).
 480
 481 * docutils/core.py:
 482
 483   - Removed many keyword parameters to ``Publisher.__init__()`` and
 484     ``publish()``; bundled into an option values object.  Added
 485     "argv", "usage", "description", and "option_spec" parameters for
 486     command-line support.
 487   - Added ``Publisher.process_command_line()`` and ``.set_options()``
 488     methods.
 489   - Reworked I/O model for ``docutils.io`` wrappers.
 490   - Updated ``Publisher.set_options()``; now returns option values
 491     object.
 492   - Added support for configuration files (/etc/docutils.conf,
 493     ./docutils.conf, ~/.docutils).
 494   - Added ``Publisher.setup_option_parser()``.
 495   - Added default usage message and description.
 496
 497 * docutils/frontend.py: Added to project; support for front-end
 498   (command-line) scripts.  Option specifications may be augmented by
 499   components.  Requires Optik (http://optik.sf.net/) for option
 500   processing (installed locally as docutils/optik.py).
 501
 502 * docutils/io.py: Added to project; uniform API for a variety of input
 503   output mechanisms.
 504
 505 * docutils/nodes.py:
 506
 507   - Added ``TreeCopyVisitor`` class.
 508   - Added a ``copy`` method to ``Node`` and subclasses.
 509   - Added a ``SkipDeparture`` exception for visitors.
 510   - Renamed ``TreePruningException`` from ``VisitorException``.
 511   - Added docstrings to ``TreePruningException``, subclasses, and
 512     ``Nodes.walk()``.
 513   - Improved docstrings.
 514   - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
 515   - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
 516     imports.
 517   - Added ``decoration``, ``header``, and ``footer`` node classes, and
 518     ``PreDecorative`` mixin.
 519   - Reworked the name/id bookkeeping; to ``document``, removed
 520     ``explicit_targets`` and ``implicit_targets`` attributes, added
 521     ``nametypes`` attribute and ``set_name_id_map`` method.
 522   - Added ``NodeFound`` exception, for use with ``NodeVisitor``
 523     traversals.
 524   - Added ``document.has_name()`` method.
 525   - Fixed DOM generation for list-attributes.
 526   - Added category class ``Labeled`` (used by footnotes & citations).
 527   - Added ``Element.set_class()`` method (sets "class" attribute).
 528
 529 * docutils/optik.py: Added to project.  Combined from the Optik
 530   package, with added option groups and other modifications.  The use
 531   of this module is probably only temporary.
 532
 533 * docutils/statemachine.py:
 534
 535   - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
 536   - Added underscores to improve many awkward names.
 537   - In ``string2lines()``, changed whitespace normalizing translation
 538     table to regexp; restores Python 2.0 compatibility with Unicode.
 539
 540 * docutils/urischemes.py:
 541
 542   - Filled in some descriptions.
 543   - Added "shttp" scheme.
 544
 545 * docutils/utils.py:
 546
 547   - Added ``clean_rcs_keywords`` function (moved from
 548     docutils/transforms/frontmatter.py
 549     ``DocInfo.filter_rcs_keywords``).
 550   - Added underscores to improve many awkward names.
 551   - Changed names of Reporter's thresholds:
 552     warning_level -> report_level; error_level -> halt_level.
 553   - Moved ``utils.id()`` to ``nodes.make_id()``.
 554   - Added ``relative_path(source, target)``.
 555
 556 * docutils/languages/de.py: German mappings; added to project.  Thanks
 557   to Gunnar Schwant for the translations.
 558
 559 * docutils/languages/en.py: Added "Dedication" bibliographic field
 560   mappings.
 561
 562 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
 563   Chodorowski.
 564
 565 * docutils/parsers/rst/states.py:
 566
 567   - Added underscores to improve many awkward names.
 568   - Added RFC-2822 header support.
 569   - Extracted the inline parsing code from ``RSTState`` to a separate
 570     class, ``Inliner``, which will allow easy subclassing.
 571   - Made local bindings for ``memo`` container & often-used contents
 572     (reduces code complexity a lot).  See ``RSTState.runtime_init()``.
 573   - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
 574   - Added ``MarkupMismatch`` exception; for late corrections.
 575   - Added ``-/:`` characters to inline markup's start string prefix,
 576     ``/`` to end string suffix.
 577   - Fixed a footnote bug.
 578   - Fixed a bug with literal blocks.
 579   - Applied patch from Simon Budig: simplified regexps with symbolic
 580     names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
 581   - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
 582   - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
 583   - Allowed non-ASCII in "simple names" (directive names, field names,
 584     references, etc.).
 585   - Converted ``Inliner.patterns.initial`` to be dynamically built
 586     from parts with ``build_regexp()`` function.
 587   - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
 588   - Updated docstrings.
 589   - Changed "table" to "grid_table"; added "simple_table" support.
 590
 591 * docutils/parsers/rst/tableparser.py:
 592
 593   - Changed ``TableParser`` to ``GridTableParser``.
 594   - Added ``SimpleTableParser``.
 595   - Refactored naming.
 596
 597 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
 598   a fallback language for directive names.
 599
 600 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
 601   directive to use a ``pending`` element, used only by HTML writers.
 602
 603 * docutils/parsers/rst/directives/parts.py: Renamed from
 604   components.py.
 605
 606   - Added "backlinks" attribute to "contents" directive.
 607
 608 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
 609   project by Adam Chodorowski.
 610
 611 * docutils/readers/__init__.py: Gave Readers more control over
 612   choosing and instantiating Parsers.
 613
 614 * docutils/readers/pep.py: Added to project; for PEP processing.
 615
 616 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
 617   requires a ``component`` parameter.
 618
 619 * docutils/transforms/components.py: Added to project; transforms
 620   related to Docutils components.
 621
 622 * docutils/transforms/frontmatter.py:
 623
 624   - In ``DocInfo.extract_authors``, check for a single "author" in an
 625     "authors" group, and convert it to a single "author" element.
 626   - Added support for "Dedication" and generic bibliographic fields.
 627
 628 * docutils/transforms/peps.py: Added to project; PEP-specific.
 629
 630 * docutils/transforms/parts.py: Renamed from old components.py.
 631
 632   - Added filter for `Contents`, to use alt-text for inline images,
 633     and to remove inline markup that doesn't make sense in the ToC.
 634   - Added "name" attribute to TOC topic depending on its title.
 635   - Added support for optional TOC backlinks.
 636
 637 * docutils/transforms/references.py: Fixed indirect target resolution
 638   in ``Hyperlinks`` transform.
 639
 640 * docutils/transforms/universal.py:
 641
 642   - Changed ``Messages`` transform to properly filter out system
 643     messages below the warning threshold.
 644   - Added ``Decorations`` transform (support for ``--generator``,
 645     ``--date``, ``--time``, ``--source-link`` options).
 646
 647 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
 648   Engelbert Gruber's PDF writer.
 649
 650 * docutils/writers/html4css1.py:
 651
 652   - Made XHTML-compatible (switched to lowercase element & attribute
 653     names; empty tag format).
 654   - Escape double-dashes in comment text.
 655   - Improved boilerplate & modularity of output.
 656   - Exposed modular output in Writer class.
 657   - Added a "generator" meta tag to <head>.
 658   - Added support for the ``--stylesheet`` option.
 659   - Added support for ``decoration``, ``header``, and ``footer``
 660     elements.
 661   - In ``HTMLTranslator.attval()``, changed whitespace normalizing
 662     translation table to regexp; restores Python 2.0 compatibility
 663     with Unicode.
 664   - Added the translator class as instance variable to the Writer, to
 665     make it easily subclassable.
 666   - Improved option list spacing (thanks to Richard Jones).
 667   - Modified field list output.
 668   - Added backlinks to footnotes & citations.
 669   - Added percentage widths to "<col>" tags (from colspec).
 670   - Option lists: "<code>" changed to "<kbd>", ``option_argument``
 671     "<span>" changed to "<var>".
 672   - Inline literals: "<code>" changed to "<tt>".
 673   - Many changes to optimize vertical space: compact simple lists etc.
 674   - Add a command-line options & directive attributes to control TOC
 675     and footnote/citation backlinks.
 676   - Added support for optional footnote/citation backlinks.
 677   - Added support for generic bibliographic fields.
 678   - Identify backrefs.
 679   - Relative URLs for stylesheet links.
 680
 681 * docutils/writers/pep_html.py: Added to project; HTML Writer for
 682   PEPs (subclass of ``html4css1.Writer``).
 683
 684 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
 685
 686 * docutils/writers/docutils_xml.py: Added to project; trivial writer
 687   of the Docutils internal doctree in XML.
 688
 689 * docs/tools.txt: "Docutils Front-End Tools", added to project.
 690
 691 * spec/doctree.txt:
 692
 693   - Changed the title to "The Docutils Document Tree".
 694   - Added "Hyperlink Bookkeeping" section.
 695
 696 * spec/docutils.dtd:
 697
 698   - Added ``decoration``, ``header``, and ``footer`` elements.
 699   - Brought ``interpreted`` element in line with the parser: changed
 700     attribute "type" to "role", added "position".
 701   - Added support for generic bibliographic fields.
 702
 703 * spec/notes.txt: Continual updates.  Added "Project Policies".
 704
 705 * spec/pep-0256.txt:  Updated.  Added "Roadmap to the Doctring PEPs"
 706   section.
 707
 708 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
 709
 710 * spec/pep-0258.txt: Updated.  Added text from pysource.txt and
 711   mailing list discussions.
 712
 713 * spec/pep-0287.txt:
 714
 715   - Renamed to "reStructuredText Docstring Format".
 716   - Minor edits.
 717   - Reworked Q&A as an enumerated list.
 718   - Converted to reStructuredText format.
 719
 720 * spec/pysource.dtd:
 721
 722   - Reworked structural elements, incorporating ideas from Tony Ibbs.
 723
 724 * spec/pysource.txt: Removed from project.  Moved much of its contents
 725   to pep-0258.txt.
 726
 727 * spec/rst/alternatives.txt:
 728
 729   - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
 730   - Added "Inline External Targets" section.
 731
 732 * spec/rst/directives.txt:
 733
 734   - Added "backlinks" attribute to "contents" directive.
 735
 736 * spec/rst/problems.txt:
 737
 738   - Updated the Enumerated List Markup discussion.
 739   - Added new alternative table markup syntaxes.
 740
 741 * spec/rst/reStructuredText.txt:
 742
 743   - Clarified field list usage.
 744   - Updated enumerated list description.
 745   - Clarified purpose of directives.
 746   - Added ``-/:`` characters to inline markup's start string prefix,
 747     ``/`` to end string suffix.
 748   - Updated "Authors" bibliographic field behavior.
 749   - Changed "inline hyperlink targets" to "inline internal targets".
 750   - Added "simple table" syntax to supplement the existing but
 751     newly-renamed "grid tables".
 752   - Added cautions for anonymous hyperlink use.
 753   - Added "Dedication" and generic bibliographic fields.
 754
 755 * test: Made test modules standalone (subdirectories became packages).
 756
 757 * test/DocutilsTestSupport.py:
 758
 759   - Added support for PEP extensions to reStructuredText.
 760   - Added support for simple tables.
 761   - Refactored naming.
 762
 763 * test/package_unittest.py: Renamed from UnitTestFolder.py.
 764
 765   - Now supports true packages containing test modules
 766     (``__init__.py`` files required); fixes duplicate module name bug.
 767
 768 * test/test_pep/: Subpackage added to project; PEP testing.
 769
 770 * test/test_rst/test_SimpleTableParser.py: Added to project.
 771
 772 * tools:
 773
 774   - Updated html.py and publish.py front-end tools to use the new
 775     command-line processing facilities of ``docutils.frontend``
 776     (exposed in ``docutils.core.Publisher``), reducing each to just a
 777     few lines of code.
 778   - Added ``locale.setlocale()`` calls to front-end tools.
 779
 780 * tools/buildhtml.py: Added to project; batch-generates .html from all
 781   the .txt files in directories and subdirectories.
 782
 783 * tools/default.css:
 784
 785   - Added support for ``header`` and ``footer`` elements.
 786   - Added styles for "Dedication" topics (biblio fields).
 787
 788 * tools/docutils.conf: A configuration file; added to project.
 789
 790 * tools/docutils-xml.py: Added to project.
 791
 792 * tools/pep.py: Added to project; PEP to HTML front-end tool.
 793
 794 * tools/pep-html-template: Added to project.
 795
 796 * tools/pep2html.py: Added to project from Python (nondist/peps).
 797   Added support for Docutils (reStructuredText PEPs).
 798
 799 * tools/quicktest.py:
 800
 801   - Added the ``--attributes`` option, hacked a bit.
 802   - Added a second command-line argument (output file); cleaned up.
 803
 804 * tools/stylesheets/: Subdirectory added to project.
 805
 806 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
 807
 808
 809 Release 0.1 (2002-04-20)
 810 ========================
 811
 812 This is the first release of Docutils, merged from the now inactive
 813 reStructuredText__ and `Docstring Processing System`__ projects.  For
 814 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
 815 `DPS HISTORY`__ files.
 816
 817 __ http://structuredtext.sourceforge.net/
 818 __ http://docstring.sourceforge.net/
 819 __ http://structuredtext.sourceforge.net/HISTORY.html
 820 __ http://docstring.sourceforge.net/HISTORY.html
 821
 822 General changes: renamed 'dps' package to 'docutils'; renamed
 823 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
 824 the test suites (reStructuredText's test/test_states renamed to
 825 test/test_rst); and all modifications required to make it all work.
 826
 827 * docutils/parsers/rst/states.py:
 828
 829   - Improved diagnostic system messages for missing blank lines.
 830   - Fixed substitution_reference bug.
 831
 832 \f
 833 ..
 834    Local Variables:
 835    mode: indented-text
 836    indent-tabs-mode: nil
 837    sentence-end-double-space: t
 838    fill-column: 70
 839    End: