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