diff options
Diffstat (limited to 'docutils/HISTORY.txt')
| -rw-r--r-- | docutils/HISTORY.txt | 1179 |
1 files changed, 0 insertions, 1179 deletions
diff --git a/docutils/HISTORY.txt b/docutils/HISTORY.txt deleted file mode 100644 index b8ef1a128..000000000 --- a/docutils/HISTORY.txt +++ /dev/null @@ -1,1179 +0,0 @@ -================== - Docutils History -================== - -:Author: David Goodger -:Contact: goodger@users.sourceforge.net -:Date: $Date$ -:Web site: http://docutils.sourceforge.net/ -:Copyright: This document has been placed in the public domain. - -.. contents:: - -Acknowledgements -================ - -I would like to acknowledge the people who have made a direct impact -on the Docutils project, knowingly or not, in terms of encouragement, -suggestions, criticism, bug reports, code contributions, tasty treats, -and related projects: - - Aahz, David Abrahams, David Ascher, Eric Bellot, Ian Bicking, - Martin Blais, Fred Bremmer, Simon Budig, Bill Bumgarner, Brett - Cannon, Adam Chodorowski, Jason Diamond, William Dode, Fred Drake, - Dethe Elza, Marcus Ertl, Benja Fallenstein, fantasai, Stefane - Fermigier, Jim Fulton, Peter Funk, Jorge Gonzalez, Engelbert - Gruber, Simon Hefti, Doug Hellmann, Juergen Hermann, Jannie - Hofmeyr, Michael Hudson, Marcelo Huerta San Martin, Ludger - Humbert, Jeremy Hylton, Tony Ibbs, Alan Jaffray, Dmitry Jemerov, - Richard Jones, Andreas Jung, Garth Kidd, Nicola Larosa, Daniel - Larsson, Marc-Andre Lemburg, Julien Letessier, Wolfgang Lipp, - Edward Loper, Dallas Mahrt, Ken Manheimer, Vasko Miroslav, Skip - Montanaro, Paul Moore, Nigel W. Moriarty, Mark Nodine, Patrick - K. O'Brien, Michel Pelletier, Sam Penrose, Tim Peters, Pearu - Peterson, Mark Pilgrim, Brett g Porter, David Priest, Jens Quade, - Andy Robinson, Tavis Rudd, Oliver Rutherfurd, Kenichi Sato, Ueli - Schlaepfer, Gunnar Schwant, Bruce Smith, Roman Suzi, tav, Bob - Tolbert, Paul Tremblay, Laurence Tratt, Adrian van den Dries, - Guido van Rossum, Martin von Loewis, Greg Ward, Barry Warsaw, - Edward Welbourne, Ka-Ping Yee, Moshe Zadka - -Thank you! - -(I'm still waiting for contributions of computer equipment and cold -hard cash :-).) Hopefully I haven't forgotten anyone or misspelled -any names; apologies (and please let me know!) if I have. - - -Future Plans -============ - -* The config file layout will be completely overhauled for the 0.4 - release. - -* Include substitution files for character entities, produced by the - tools/unicode2rstsubs.py. As static data, these files could go - inside the docutils package somewhere. - -* Rename front-end tools (perhaps to "rst2*" pattern) and have - setup.py install them. - -* A Python Source Reader component (Python auto-documentation) will be - added as soon as there's enough time, effort, and will. If you'd - like to help, let me know! - - -Changes Since 0.3 -================= - -* docutils/core.py: - - - Catch system messages to stop tracebacks from parsing errors. - - Catch exceptions during processing report & exit without - tracebacks, except when "--traceback" used. - -* docutils/frontend.py: - - - Added "--traceback" & "--no-traceback" options ("traceback" - setting). - -* docutils/io.py: - - - Catch IOErrors when opening source & destination files, report & - exit without tracebacks. - -* docutils/utils.py: - - - Added "level" attribute to SystemMessage exceptions. - -* docutils/languages/af.py: Added to project; Afrikaans - mappings by Jannie Hofmeyr. - -* docutils/languages/ru.py: Added to project; Russian mappings by - Roman Suzi. - -* docutils/parsers/rst/languages/af.py: Added to project; Afrikaans - mappings by Jannie Hofmeyr. - -* docutils/parsers/rst/languages/ru.py: Added to project; Russian - mappings by Roman Suzi. - -* docutils/writers/html4css1.py: - - - Fixed unicode handling of attribute values (bug 760673). - - -Release 0.3 (2003-06-24) -======================== - -General: - -* Renamed "attribute" to "option" for directives/extensions. - -* Renamed transform method "transform" to "apply". - -* Renamed "options" to "settings" for runtime settings (as set by - command-line options). Sometimes "option" (singular) became - "settings" (plural). Some variations below: - - - document.options -> document.settings (stored in other objects as - well) - - option_spec -> settings_spec (not directives though) - - OptionSpec -> SettingsSpec - - cmdline_options -> settings_spec - - relative_path_options -> relative_path_settings - - option_default_overrides -> settings_default_overrides - - Publisher.set_options -> Publisher.get_settings - -Specific: - -* COPYING.txt: Added "Public Domain Dedication". - -* FAQ.txt: Frequently asked questions, added to project. - -* setup.py: - - - Updated with PyPI Trove classifiers. - - Conditional installation of third-party modules. - -* docutils/__init__.py: - - - Bumped version to 0.2.1 to reflect changes to I/O classes. - - Bumped version to 0.2.2 to reflect changes to stylesheet options. - - Factored ``SettingsSpec`` out of ``Component``; separately useful. - - Bumped version to 0.2.3 because of the new "--embed-stylesheet" - option and its effect on the PEP template & writer. - - Bumped version to 0.2.4 due to changes to the PEP template & - stylesheet. - - Bumped version to 0.2.5 to reflect changes to Reporter output. - - Added ``TransformSpec`` class for new transform system. - - Bumped version to 0.2.6 for API changes (renaming). - - Bumped version to 0.2.7 for new ``docutils.core.publish_*`` - convenience functions. - - Added ``Component.component_type`` attribute. - - Bumped version to 0.2.8 because of the internal parser switch from - plain lists to the docutils.statemachine.StringList objects. - - Bumped version to 0.2.9 because of the frontend.py API changes. - - Bumped version to 0.2.10 due to changes to the project layout - (third-party modules removed from the "docutils" package), and - signature changes in ``io.Input``/``io.Output``. - - Changed version to 0.3.0 for release. - -* docutils/core.py: - - - Made ``publish()`` a bit more convenient. - - Generalized ``Publisher.set_io``. - - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its - parameters; improved its docstring. - - Added ``publish_file()`` and ``publish_string()``. - - Factored ``Publisher.set_source()`` and ``.set_destination()`` - out of ``.set_io``. - - Added support for "--dump-pseudo-xml", "--dump-settings", and - "--dump-transforms" hidden options. - - Added ``Publisher.apply_transforms()`` method. - - Added ``Publisher.set_components()`` method; support for - ``publish_*()`` conveninece functions. - - Moved config file processing to docutils/frontend.py. - - Added support for exit status ("exit_level" setting & - ``enable_exit`` parameter for Publisher.publish() and convenience - functions). - -* docutils/frontend.py: - - - Check for & exit on identical source & destination paths. - - Fixed bug with absolute paths & "--config". - - Set non-command-line defaults in ``OptionParser.__init__()``: - ``_source`` & ``_destination``. - - Distributed ``relative_path_settings`` to components; updated - ``OptionParser.populate_from_components()`` to combine it all. - - Require list of keys in ``make_paths_absolute`` (was implicit in - global ``relative_path_settings``). - - Added "--expose-internal-attribute", "--dump-pseudo-xml", - "--dump-settings", and "--dump-transforms" hidden options. - - Removed nasty internals-fiddling ``ConfigParser.get_section`` - code, replaced with correct code. - - Added validation functionality for config files. - - Added "--error-encoding" option/setting, "_disable_config" - internal setting. - - Added encoding validation; updated "--input-encoding" and - "--output-encoding"; added "--error-encoding-error-handler" and - "--output-encoding-error-handler". - - Moved config file processing from docutils/core.py. - - Updated ``OptionParser.populate_from_components`` to handle new - ``SettingsSpec.settings_defaults`` dict. - - Added support for "-" => stdin/stdout. - - Added "exit_level" setting ("--exit" option). - -* docutils/io.py: - - - Split ``IO`` classes into subclasses of ``Input`` and ``Output``. - - Added automatic closing to ``FileInput`` and ``FileOutput``. - - Delayed opening of ``FileOutput`` file until ``write()`` called. - - ``FileOutput.write()`` now returns the encoded output string. - - Try to get path/stream name automatically in ``FileInput`` & - ``FileOutput``. - - Added defaults for source & destination paths. - - Allow for Unicode I/O with an explicit "unicode" encoding. - - Added ``Output.encode()``. - - Removed dependency on runtime settings; pass encoding directly. - - Recognize Unicode strings in ``Input.decode()``. - - Added support for output encoding error handlers. - -* docutils/nodes.py: - - - Added "Invisible" element category class. - - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree - modification during a traversal. - - Added element classes: ``line_block``, ``generated``, ``address``, - ``sidebar``, ``rubric``, ``attribution``, ``admonition``, - ``superscript``, ``subscript``, ``inline`` - - Added support for lists of nodes to ``Element.insert()``. - - Fixed parent linking in ``Element.replace()``. - - Added new abstract superclass ``FixedTextElement``; adds - "xml:space" attribute. - - Added support for "line" attribute of ``system_message`` nodes. - - Added support for the observer pattern from ``utils.Reporter``. - Added ``parse_messages`` and ``transform_messages`` attributes to - ``document``, removed ``messages``. Added ``note_parse_message`` - and ``note_transform_message`` methods. - - Added support for improved diagnostics: - - - Added "document", "source", and "line" internal attributes to - ``Node``, set by ``Node.setup_child()``. - - Converted variations on ``node.parent = self`` to - ``self.setup_child(node)``. - - Added ``document.current_source`` & ``.current_line`` - attributes, and ``.note_source`` observer method. - - Changed "system_message" output to GNU-Tools format. - - - Added a "rawsource" attribute to the ``Text`` class, for text - before backslash-escape resolution. - - Support for new transform system. - - Reworked ``pending`` element. - - Fixed XML DOM bug (SF #660611). - - Removed the ``interpeted`` element class and added - ``title_reference``, ``abbreviation``, ``acronym``. - - Made substitutions case-sensitive-but-forgiving; moved some code - from the parser. - - Fixed Unicode bug on element attributes (report: William Dode). - -* docutils/optik.py: Removed from project; replaced with - extras/optparse.py and extras/textwrap.py. These will be installed - only if they're not already present in the Python installation. - -* docutils/roman.py: Moved to extras/roman.py; this will be installed - only if it's not already present in the Python installation. - -* docutils/statemachine.py: - - - Factored out ``State.add_initial_transitions()`` so it can be - extended. - - Converted whitespace-specific "blank" and "indent" transitions - from special-case code to ordinary transitions: removed - ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added - ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` & - ``ws_initial_transitions`` attributes. - - Removed ``State.match_transition()`` after merging it into - ``.check_line()``. - - Added ``StateCorrection`` exception. - - Added support for ``StateCorrection`` in ``StateMachine.run()`` - (moved ``TransitionCorrection`` support there too.) - - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise - ``EOFError`` instead of ``IndexError``. - - Added ``State.no_match`` method. - - Added support for the Observer pattern, triggered by input line - changes. - - Added ``strip_top`` parameter to - ``StateMachineWS.get_first_known_indented``. - - Made ``context`` a parameter to ``StateMachine.run()``. - - Added ``ViewList`` & ``StringList`` classes; - ``extract_indented()`` becomes ``StringList.get_indented()``. - - Added ``StateMachine.insert_input()``. - - Fixed ViewList slice handling for Python 2.3. Patch from (and - thanks to) Fred Drake. - -* docutils/utils.py: - - - Added a ``source`` attribute to Reporter instances and - ``system_message`` elements. - - Added an observer pattern to ``utils.Reporter`` to keep track of - system messages. - - Fixed bugs in ``relative_path()``. - - Added support for improved diagnostics. - - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``). - - Added support for encoding Reporter stderr output, and encoding - error handlers. - - Reporter keeps track of the highest level system message yet - generated. - -* docutils/languages: Fixed bibliographic field language lookups. - -* docutils/languages/es.py: Added to project; Spanish mappings by - Marcelo Huerta San Martin. - -* docutils/languages/fr.py: Added to project; French mappings by - Stefane Fermigier. - -* docutils/languages/it.py: Added to project; Italian mappings by - Nicola Larosa. - -* docutils/languages/sk.py: Added to project; Slovak mappings by - Miroslav Vasko. - -* docutils/parser/__init__.py: - - - Added ``Parser.finish_parse()`` method. - -* docutils/parser/rst/__init__.py: - - - Added options: "--pep-references", "--rfc-references", - "--tab-width", "--trim-footnote-reference-space". - -* docutils/parsers/rst/states.py: - - - Changed "title under/overline too short" system messages from INFO - to WARNING, and fixed its insertion location. - - Fixed enumerated list item parsing to allow paragraphs & section - titles to begin with enumerators. - - Converted system messages to use the new "line" attribute. - - Fixed a substitution reference edge case. - - Added support for "--pep-references" and "--rfc-references" - options; reworked ``Inliner`` code to make customization easier. - - Removed field argument parsing. - - Added support for short section title over/underlines. - - Fixed "simple reference name" regexp to ignore text like - "object.__method__"; not an anonymous reference. - - Added support for improved diagnostics. - - Reworked directive API, based on Dethe Elza's contribution. Added - ``Body.parse_directive()``, ``.parse_directive_options()``, - ``.parse_directive_arguments()`` methods. - - Added ``ExtensionOptions`` class, to parse directive options - without parsing field bodies. Factored - ``Body.parse_field_body()`` out of ``Body.field()``, overridden in - ``ExtensionOptions``. - - Improved definition list term/classifier parsing. - - Added warnings for unknown directives. - - Renamed ``Stuff`` to ``Struct``. - - Now flagged as errors: transitions at the beginning or end of - sections, empty sections (except title), and empty documents. - - Updated for ``statemachine.StringList``. - - Enabled recognition of schemeless email addresses in targets. - - Added support for embedded URIs in hyperlink references. - - Added backslash-escapes to inline markup end-string suffix. - - Added support for correct interpreted text processing. - - Fixed nested title parsing (topic, sidebar directives). - - Added special processing of backslash-escaped whitespace (idea - from David Abrahams). - - Made substitutions case-sensitive-but-forgiving; moved some code - to ``docutils.nodes``. - - Added support for block quote attributions. - - Added a kludge to work-around a conflict between the bubble-up - parser strategy and short titles (<= 3 char-long over- & - underlines). Fixes SF bug #738803 "infinite loop with multiple - titles" submitted by Jason Diamond. - - Added explicit interpreted text roles for standard inline markup: - "emphasis", "strong", "literal". - - Implemented "superscript" and "subscript" interpreted text roles. - - Added initial support for "abbreviation" and "acronym" roles; - incomplete. - - Added support for "--trim-footnote-reference-space" option. - - Optional space before colons in directives & hyperlink targets. - -* docutils/parsers/rst/tableparser.py: - - - Fixed a bug that was producing unwanted empty rows in "simple" - tables. - - Detect bad column spans in "simple" tables. - -* docutils/parsers/rst/directives: Updated all directive functions to - new API. - -* docutils/parsers/rst/directives/__init__.py: - - - Added ``flag()``, ``unchanged()``, ``path()``, - ``nonnegative_int()``, ``choice()``, and ``class_option()`` - directive option helper functions. - - Added warnings for unknown directives. - - Return ``None`` for missing directives. - - Added ``register_directive()``, thanks to William Dode and Paul - Moore. - -* docutils/parsers/rst/directives/admonitions.py: - - - Added "admonition" directive. - -* docutils/parsers/rst/directives/body.py: Added to project. Contains - the "topic", "sidebar" (from Patrick O'Brien), "line-block", - "parsed-literal", "rubric", "epigraph", "highlights" and - "pull-quote" directives. - -* docutils/parsers/rst/directives/images.py: - - - Added an "align" attribute to the "image" & "figure" directives - (by Adam Chodorowski). - - Added "class" option to "image", and "figclass" to "figure". - -* docutils/parsers/rst/directives/misc.py: - - - Added "include", "raw", and "replace" directives, courtesy of - Dethe Elza. - - Added "unicode" and "class" directives. - -* docutils/parsers/rst/directives/parts.py: - - - Added the "sectnum" directive; by Dmitry Jemerov. - - Added "class" option to "contents" directive. - -* docutils/parsers/rst/directives/references.py: Added to project. - Contains the "target-notes" directive. - -* docutils/parsers/rst/languages/__init__.py: - - - Return ``None`` from get_language() for missing language modules. - -* docutils/parsers/rst/languages/de.py: Added to project; German - mappings by Engelbert Gruber. - -* docutils/parsers/rst/languages/en.py: - - - Added interpreted text roles mapping. - -* docutils/parsers/rst/languages/es.py: Added to project; Spanish - mappings by Marcelo Huerta San Martin. - -* docutils/parsers/rst/languages/fr.py: Added to project; French - mappings by William Dode. - -* docutils/parsers/rst/languages/it.py: Added to project; Italian - mappings by Nicola Larosa. - -* docutils/parsers/rst/languages/sk.py: Added to project; Slovak - mappings by Miroslav Vasko. - -* docutils/readers/__init__.py: - - - Added support for the observer pattern from ``utils.Reporter``, in - ``Reader.parse`` and ``Reader.transform``. - - Removed ``Reader.transform()`` method. - - Added default parameter values to ``Reader.__init__()`` to make - instantiation easier. - - Removed bogus aliases: "restructuredtext" is *not* a Reader. - -* docutils/readers/pep.py: - - - Added the ``peps.TargetNotes`` transform to the Reader. - - Removed PEP & RFC reference detection code; moved to - parsers/rst/states.py as options (enabled here by default). - - Added support for pre-acceptance PEPs (no PEP number yet). - - Moved ``Inliner`` & made it a class attribute of ``Reader`` for - easy subclassing. - -* docutils/readers/python: Python Source Reader subpackage added to - project, including preliminary versions of: - - - __init__.py - - moduleparser.py: Parser for Python modules. - -* docutils/transforms/__init__.py: - - - Added ``Transformer`` class and completed transform reform. - -* docutils/transforms/frontmatter.py: - - - Improved support for generic fields. - - Fixed bibliographic field language lookups. - -* docutils/transforms/misc.py: Added to project. Miscellaneous - transforms. - -* docutils/transforms/parts.py: - - - Moved the "id" attribute from TOC list items to the references - (``Contents.build_contents()``). - - Added the ``SectNum`` transform; by Dmitry Jemerov. - - Added "class" attribute support to ``Contents``. - -* docutils/transforms/peps.py: - - - Added ``mask_email()`` function, updating to pep2html.py's - functionality. - - Linked "Content-Type: text/x-rst" to PEP 12. - - Added the ``TargetNotes`` PEP-specific transform. - - Added ``TargetNotes.cleanup_callback``. - - Added title check to ``Headers``. - -* docutils/transforms/references.py: - - - Added the ``TargetNotes`` generic transform. - - Split ``Hyperlinks`` into multiple transforms. - - Fixed bug with multiply-indirect references (report: Bruce Smith). - - Added check for circular indirect references. - - Made substitutions case-sensitive-but-forgiving. - -* docutils/transforms/universal.py: - - - Added support for the "--expose-internal-attributes" option. - - Removed ``Pending`` transform classes & data. - -* docutils/writers/__init__.py: - - - Removed ``Writer.transform()`` method. - -* docutils/writers/docutils-xml.py: - - - Added XML and doctype declarations. - - Added "--no-doctype" and "--no-xml-declaration" options. - -* docutils/writers/html4css1.py: - - - "name" attributes only on these tags: a, applet, form, frame, - iframe, img, map. - - Added "name" attribute to <a> in section titles for Netscape 4 - support (bug report: Pearu Peterson). - - Fixed targets (names) on footnote, citation, topic title, - problematic, and system_message nodes (for Netscape 4). - - Changed field names from "<td>" to "<th>". - - Added "@" to "@" encoding to thwart address harvesters. - - Improved the vertical whitespace optimization; ignore "invisible" - nodes (targets, comments, etc.). - - Improved inline literals with ``<span class="pre">`` around chunks - of text and `` `` for runs of spaces. - - Improved modularity of output; added ``self.body_pre_docinfo`` and - ``self.docinfo`` segments. - - Added support for "line_block", "address" elements. - - Improved backlinks (footnotes & system_messages). - - Improved system_message output. - - Redefined "--stylesheet" as containing an invariant URL, used - verbatim. Added "--stylesheet-path", interpreted w.r.t. the - working directory. - - Added "--footnote-references" option (superscript or brackets). - - Added "--compact-lists" and "--no-compact-lists" options. - - Added "--embed-stylesheet" and "--link-stylesheet" options; - factored out ``HTMLTranslator.get_stylesheet_reference()``. - - Improved field list rendering. - - Added Docutils version to "generator" meta tag. - - Fixed a bug with images; they must be inline, so wrapped in <p>. - - Improved layout of <pre> HTML source. - - Fixed attribute typo on <colspec>. - - Refined XML prologue. - - Support for no stylesheet. - - Removed "interpreted" element support. - - Added support for "title_reference", "sidebar", "attribution", - "rubric", and generic "admonition" elements. - - Added "--attribution" option. - - Added support for "inline", "subscript", "superscript" elements. - - Added initial support for "abbreviation" and "acronym"; - incomplete. - -* docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber - (from the sandbox). - - - Added french. - - Double quotes in literal blocks (special treatment for de/ngerman). - - Added '--hyperlink-color' option ('0' turns off coloring of links). - - Added "--attribution" option. - - Right align attributions. - -* docutils/writers/pep_html.py: - - - Parameterized output encoding in PEP template. - - Reworked substitutions from ``locals()`` into ``subs`` dict. - - Redefined "--pep-stylesheet" as containing an invariant URL, used - verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the - working directory. - - Added an override on the "--footnote-references" option. - - Factored out ``HTMLTranslator.get_stylesheet_reference()``. - - Added Docutils version to "generator" meta tag. - - Added a "DO NOT EDIT THIS FILE" comment to generated HTML. - -* docs/tools.txt: - - - Added a "silent" setting for ``buildhtml.py``. - - Added a "Getting Help" section. - - Rearranged the structure. - - Kept up to date, with new settings, command-line options etc. - - Added section for ``rst2latex.py`` (Engelbert Gruber). - - Converted settings table into a definition list. - -* docs/rst/quickstart.txt: - - - Added a table of contents. - - Added feedback information. - - Added mention of minimum section title underline lengths. - - Removed the 4-character minimum for section title underlines. - -* docs/rst/quickref.html: - - - Added a "Getting Help" section. - - Added a style to make section title backlinks more subtle. - - Added mention of minimum section title underline lengths. - - Removed the 4-character minimum for section title underlines. - -* extras: Directory added to project; contains third-party modules - that Docutils depends on (optparse, textwrap, roman). These are - only installed if they're not already present. - -* licenses: Directory added to project; contains copies of license - files for non-public-domain files. - -* spec/doctree.txt: - - - Changed the focus. It's about DTD elements: structural - relationships, semantics, and external (public) attributes. Not - about the element class library. - - Moved some implementation-specific stuff into ``docutils.nodes`` - docstrings. - - Wrote descriptions of all common attributes and parameter - entities. Filled in introductory material. - - Working through the element descriptions: 55 down, 37 to go. - - Removed "Representation of Horizontal Rules" to - spec/rst/alternatives.txt. - -* spec/docutils.dtd: - - - Added "generated" inline element. - - Added "line_block" body element. - - Added "auto" attribute to "title". - - Changed content models of "literal_block" and "doctest_block" to - ``%text.model``. - - Added ``%number;`` attribute type parameter entity. - - Changed ``%structural.elements;`` to ``%section.elements``. - - Updated attribute types; made more specific. - - Added "address" bibliographic element. - - Added "line" attribute to ``system_message`` element. - - Removed "field_argument" element; "field_name" may contain - multiple words and whitespace. - - Changed public identifier to docutils.sf.net. - - Removed "interpreted" element; added "title_reference", - "abbreviation", "acronym". - - Removed "refuri" attribute from "footnote_reference" and - "citation_reference". - - Added "sidebar", "rubric", "attribution", "admonition", - "superscript", "subscript", and "inline" elements. - -* spec/pep-0256.txt: Converted to reStructuredText & updated. - -* spec/pep-0257.txt: Converted to reStructuredText & updated. - -* spec/pep-0258.txt: Converted to reStructuredText & updated. - -* spec/semantics.txt: Updated with text from a Doc-SIG response to - Dallas Mahrt. - -* spec/transforms.txt: Added to project. - -* spec/howto: Added subdirectory, for developer how-to docs. - -* spec/howto/rst-directives.txt: Added to project. Original by Dethe - Elza, edited & extended by David Goodger. - -* spec/howto/i18n.txt: Docutils Internationalization. Added to - project. - -* spec/rst/alternatives.txt: - - - Added "Doctree Representation of Transitions" from - spec/doctree.txt. - - Updated "Inline External Targets" & closed the debate. - - Added ideas for interpreted text syntax extensions. - - Added "Nested Inline Markup" section. - -* spec/rst/directives.txt: - - - Added directives: "topic", "sectnum", "target-notes", - "line-block", "parsed-literal", "include", "replace", "sidebar", - "admonition", "rubric", "epigraph", "highlights", "unicode" and - "class". - - Formalized descriptions of directive details. - - Added an "align" attribute to the "image" & "figure" directives - (by Adam Chodorowski). - - Added "class" options to "topic", "sidebar", "line-block", - "parsed-literal", "contents", and "image"; and "figclass" to - "figure". - -* spec/rst/interpreted.txt: Added to project. Descriptions of - interpreted text roles. - -* spec/rst/introduction.txt: - - - Added pointers to material for new users. - -* spec/rst/reStructuredText.txt: - - - Disambiguated comments (just add a newline after the "::"). - - Updated enumerated list description; added a discussion of the - second-line validity checking. - - Updated directive description. - - Added a note redirecting newbies to the user docs. - - Expanded description of inline markup start-strings in non-markup - contexts. - - Removed field arguments and made field lists a generic construct. - - Removed the 4-character minimum for section title underlines. - - Clarified term/classifier delimiter & inline markup ambiguity - (definition lists). - - Added "Embedded URIs". - - Updated "Interpreted Text" section. - - Added "Character-Level Inline Markup" section. - -* test: Continually adding & updating tests. - - - Moved test/test_rst/ to test/test_parsers/test_rst/. - - Moved test/test_pep/ to test/test_readers/test_pep/. - - Added test/test_readers/test_python/. - - Added test/test_writers/ (Engelbert Gruber). - -* tools: - - - Made the ``locale.setlocale()`` calls in front ends - fault-tolerant. - -* tools/buildhtml.py: - - - Added "--silent" option. - - Fixed bug with absolute paths & "--config". - - Updated for new I/O classes. - - Added some exception handling. - - Separated publishers' setting defaults; prevents interference. - - Updated for new ``publish_file()`` convenience function. - -* tools/pep-html-template: - - - Allow for "--embed-stylesheet". - - Added Docutils version to "generator" meta tag. - - Added a "DO NOT EDIT THIS FILE" comment to generated HTML. - - Conform to XHTML spec. - -* tools/pep2html.py: - - - Made ``argv`` a parameter to ``main()``. - - Added support for "Content-Type:" header & arbitrary PEP formats. - - Linked "Content-Type: text/plain" to PEP 9. - - Files skipped (due to an error) are not pushed onto the server. - - Updated for new I/O classes. - - Added ``check_requirements()`` & ``pep_type_error()``. - - Added some exception handling. - - Updated for new ``publish_string()`` convenience function. - - Added a "DO NOT EDIT THIS FILE" comment to generated HTML. - -* tools/quicktest.py: - - - Added "-V"/"--version" option. - -* tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber. - -* tools/unicode2rstsubs.py: Added to project. Produces character - entity files (reSructuredText substitutions) from the MathML master - unicode.xml file. - -* tools/editors: Support code for editors, added to project. Contains - ``emacs/restructuredtext.el``. - -* tools/stylesheets/default.css: Moved into the stylesheets directory. - - - Added style for chunks of inline literals. - - Removed margin for first child of table cells. - - Right-aligned field list names. - - Support for auto-numbered section titles in TOCs. - - Increased the size of inline literals (<tt>) in titles. - - Restored the light gray background for inline literals. - - Added support for "line_block" elements. - - Added style for "address" elements. - - Removed "a.footnote-reference" style; doing it with ``<sup>`` now. - - Improved field list rendering. - - Vertical whitespace improvements. - - Removed "a.target" style. - -* tools/stylesheets/pep.css: - - - Fixed nested section margins. - - Other changes parallel those of ``../default.css``. - - -Release 0.2 (2002-07-31) -======================== - -General: - -- The word "component" was being used ambiguously. From now on, - "component" will be used to mean "Docutils component", as in Reader, - Writer, Parser, or Transform. Portions of documents (Table of - Contents, sections, etc.) will be called "document parts". -- Did a grand renaming: a lot of ``verylongnames`` became - ``very_long_names``. -- Cleaned up imports: no more relative package imports or - comma-separated lists of top-level modules. -- Added support for an option values object which carries default - settings and overrides (from command-line options and library use). -- Added internal Unicode support, and support for both input and - output encodings. -- Added support for the ``docutils.io.IO`` class & subclasses. - -Specific: - -* docutils/__init__.py: - - - Added ``ApplicationError`` and ``DataError``, for use throughout - the package. - - Added ``Component`` base class for Docutils components; implements - the ``supports`` method. - - Added ``__version__`` (thus, ``docutils.__version__``). - -* docutils/core.py: - - - Removed many keyword parameters to ``Publisher.__init__()`` and - ``publish()``; bundled into an option values object. Added - "argv", "usage", "description", and "option_spec" parameters for - command-line support. - - Added ``Publisher.process_command_line()`` and ``.set_options()`` - methods. - - Reworked I/O model for ``docutils.io`` wrappers. - - Updated ``Publisher.set_options()``; now returns option values - object. - - Added support for configuration files (/etc/docutils.conf, - ./docutils.conf, ~/.docutils). - - Added ``Publisher.setup_option_parser()``. - - Added default usage message and description. - -* docutils/frontend.py: Added to project; support for front-end - (command-line) scripts. Option specifications may be augmented by - components. Requires Optik (http://optik.sf.net/) for option - processing (installed locally as docutils/optik.py). - -* docutils/io.py: Added to project; uniform API for a variety of input - output mechanisms. - -* docutils/nodes.py: - - - Added ``TreeCopyVisitor`` class. - - Added a ``copy`` method to ``Node`` and subclasses. - - Added a ``SkipDeparture`` exception for visitors. - - Renamed ``TreePruningException`` from ``VisitorException``. - - Added docstrings to ``TreePruningException``, subclasses, and - ``Nodes.walk()``. - - Improved docstrings. - - Added ``SparseNodeVisitor``, refined ``NodeVisitor``. - - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular - imports. - - Added ``decoration``, ``header``, and ``footer`` node classes, and - ``PreDecorative`` mixin. - - Reworked the name/id bookkeeping; to ``document``, removed - ``explicit_targets`` and ``implicit_targets`` attributes, added - ``nametypes`` attribute and ``set_name_id_map`` method. - - Added ``NodeFound`` exception, for use with ``NodeVisitor`` - traversals. - - Added ``document.has_name()`` method. - - Fixed DOM generation for list-attributes. - - Added category class ``Labeled`` (used by footnotes & citations). - - Added ``Element.set_class()`` method (sets "class" attribute). - -* docutils/optik.py: Added to project. Combined from the Optik - package, with added option groups and other modifications. The use - of this module is probably only temporary. - -* docutils/statemachine.py: - - - Added ``runtime_init`` method to ``StateMachine`` and ``State``. - - Added underscores to improve many awkward names. - - In ``string2lines()``, changed whitespace normalizing translation - table to regexp; restores Python 2.0 compatibility with Unicode. - -* docutils/urischemes.py: - - - Filled in some descriptions. - - Added "shttp" scheme. - -* docutils/utils.py: - - - Added ``clean_rcs_keywords`` function (moved from - docutils/transforms/frontmatter.py - ``DocInfo.filter_rcs_keywords``). - - Added underscores to improve many awkward names. - - Changed names of Reporter's thresholds: - warning_level -> report_level; error_level -> halt_level. - - Moved ``utils.id()`` to ``nodes.make_id()``. - - Added ``relative_path(source, target)``. - -* docutils/languages/de.py: German mappings; added to project. Thanks - to Gunnar Schwant for the translations. - -* docutils/languages/en.py: Added "Dedication" bibliographic field - mappings. - -* docutils/languages/sv.py: Swedish mappings; added to project by Adam - Chodorowski. - -* docutils/parsers/rst/states.py: - - - Added underscores to improve many awkward names. - - Added RFC-2822 header support. - - Extracted the inline parsing code from ``RSTState`` to a separate - class, ``Inliner``, which will allow easy subclassing. - - Made local bindings for ``memo`` container & often-used contents - (reduces code complexity a lot). See ``RSTState.runtime_init()``. - - ``RSTState.parent`` replaces ``RSTState.statemachine.node``. - - Added ``MarkupMismatch`` exception; for late corrections. - - Added ``-/:`` characters to inline markup's start string prefix, - ``/`` to end string suffix. - - Fixed a footnote bug. - - Fixed a bug with literal blocks. - - Applied patch from Simon Budig: simplified regexps with symbolic - names, removed ``Inliner.groups`` and ``Body.explicit.groups``. - - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``. - - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``. - - Allowed non-ASCII in "simple names" (directive names, field names, - references, etc.). - - Converted ``Inliner.patterns.initial`` to be dynamically built - from parts with ``build_regexp()`` function. - - Changed ``Inliner.inline_target`` to ``.inline_internal_target``. - - Updated docstrings. - - Changed "table" to "grid_table"; added "simple_table" support. - -* docutils/parsers/rst/tableparser.py: - - - Changed ``TableParser`` to ``GridTableParser``. - - Added ``SimpleTableParser``. - - Refactored naming. - -* docutils/parsers/rst/directives/__init__.py: Added "en" (English) as - a fallback language for directive names. - -* docutils/parsers/rst/directives/html.py: Changed the ``meta`` - directive to use a ``pending`` element, used only by HTML writers. - -* docutils/parsers/rst/directives/parts.py: Renamed from - components.py. - - - Added "backlinks" attribute to "contents" directive. - -* docutils/parsers/rst/languages/sv.py: Swedish mappings; added to - project by Adam Chodorowski. - -* docutils/readers/__init__.py: Gave Readers more control over - choosing and instantiating Parsers. - -* docutils/readers/pep.py: Added to project; for PEP processing. - -* docutils/transforms/__init__.py: ``Transform.__init__()`` now - requires a ``component`` parameter. - -* docutils/transforms/components.py: Added to project; transforms - related to Docutils components. - -* docutils/transforms/frontmatter.py: - - - In ``DocInfo.extract_authors``, check for a single "author" in an - "authors" group, and convert it to a single "author" element. - - Added support for "Dedication" and generic bibliographic fields. - -* docutils/transforms/peps.py: Added to project; PEP-specific. - -* docutils/transforms/parts.py: Renamed from old components.py. - - - Added filter for `Contents`, to use alt-text for inline images, - and to remove inline markup that doesn't make sense in the ToC. - - Added "name" attribute to TOC topic depending on its title. - - Added support for optional TOC backlinks. - -* docutils/transforms/references.py: Fixed indirect target resolution - in ``Hyperlinks`` transform. - -* docutils/transforms/universal.py: - - - Changed ``Messages`` transform to properly filter out system - messages below the warning threshold. - - Added ``Decorations`` transform (support for ``--generator``, - ``--date``, ``--time``, ``--source-link`` options). - -* docutils/writers/__init__.py: Added "pdf" alias in anticipation of - Engelbert Gruber's PDF writer. - -* docutils/writers/html4css1.py: - - - Made XHTML-compatible (switched to lowercase element & attribute - names; empty tag format). - - Escape double-dashes in comment text. - - Improved boilerplate & modularity of output. - - Exposed modular output in Writer class. - - Added a "generator" meta tag to <head>. - - Added support for the ``--stylesheet`` option. - - Added support for ``decoration``, ``header``, and ``footer`` - elements. - - In ``HTMLTranslator.attval()``, changed whitespace normalizing - translation table to regexp; restores Python 2.0 compatibility - with Unicode. - - Added the translator class as instance variable to the Writer, to - make it easily subclassable. - - Improved option list spacing (thanks to Richard Jones). - - Modified field list output. - - Added backlinks to footnotes & citations. - - Added percentage widths to "<col>" tags (from colspec). - - Option lists: "<code>" changed to "<kbd>", ``option_argument`` - "<span>" changed to "<var>". - - Inline literals: "<code>" changed to "<tt>". - - Many changes to optimize vertical space: compact simple lists etc. - - Add a command-line options & directive attributes to control TOC - and footnote/citation backlinks. - - Added support for optional footnote/citation backlinks. - - Added support for generic bibliographic fields. - - Identify backrefs. - - Relative URLs for stylesheet links. - -* docutils/writers/pep_html.py: Added to project; HTML Writer for - PEPs (subclass of ``html4css1.Writer``). - -* docutils/writers/pseudoxml.py: Renamed from pprint.py. - -* docutils/writers/docutils_xml.py: Added to project; trivial writer - of the Docutils internal doctree in XML. - -* docs/tools.txt: "Docutils Front-End Tools", added to project. - -* spec/doctree.txt: - - - Changed the title to "The Docutils Document Tree". - - Added "Hyperlink Bookkeeping" section. - -* spec/docutils.dtd: - - - Added ``decoration``, ``header``, and ``footer`` elements. - - Brought ``interpreted`` element in line with the parser: changed - attribute "type" to "role", added "position". - - Added support for generic bibliographic fields. - -* spec/notes.txt: Continual updates. Added "Project Policies". - -* spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs" - section. - -* spec/pep-0257.txt: Clarified prohibition of signature repetition. - -* spec/pep-0258.txt: Updated. Added text from pysource.txt and - mailing list discussions. - -* spec/pep-0287.txt: - - - Renamed to "reStructuredText Docstring Format". - - Minor edits. - - Reworked Q&A as an enumerated list. - - Converted to reStructuredText format. - -* spec/pysource.dtd: - - - Reworked structural elements, incorporating ideas from Tony Ibbs. - -* spec/pysource.txt: Removed from project. Moved much of its contents - to pep-0258.txt. - -* spec/rst/alternatives.txt: - - - Expanded auto-enumerated list idea; thanks to Fred Bremmer. - - Added "Inline External Targets" section. - -* spec/rst/directives.txt: - - - Added "backlinks" attribute to "contents" directive. - -* spec/rst/problems.txt: - - - Updated the Enumerated List Markup discussion. - - Added new alternative table markup syntaxes. - -* spec/rst/reStructuredText.txt: - - - Clarified field list usage. - - Updated enumerated list description. - - Clarified purpose of directives. - - Added ``-/:`` characters to inline markup's start string prefix, - ``/`` to end string suffix. - - Updated "Authors" bibliographic field behavior. - - Changed "inline hyperlink targets" to "inline internal targets". - - Added "simple table" syntax to supplement the existing but - newly-renamed "grid tables". - - Added cautions for anonymous hyperlink use. - - Added "Dedication" and generic bibliographic fields. - -* test: Made test modules standalone (subdirectories became packages). - -* test/DocutilsTestSupport.py: - - - Added support for PEP extensions to reStructuredText. - - Added support for simple tables. - - Refactored naming. - -* test/package_unittest.py: Renamed from UnitTestFolder.py. - - - Now supports true packages containing test modules - (``__init__.py`` files required); fixes duplicate module name bug. - -* test/test_pep/: Subpackage added to project; PEP testing. - -* test/test_rst/test_SimpleTableParser.py: Added to project. - -* tools: - - - Updated html.py and publish.py front-end tools to use the new - command-line processing facilities of ``docutils.frontend`` - (exposed in ``docutils.core.Publisher``), reducing each to just a - few lines of code. - - Added ``locale.setlocale()`` calls to front-end tools. - -* tools/buildhtml.py: Added to project; batch-generates .html from all - the .txt files in directories and subdirectories. - -* tools/default.css: - - - Added support for ``header`` and ``footer`` elements. - - Added styles for "Dedication" topics (biblio fields). - -* tools/docutils.conf: A configuration file; added to project. - -* tools/docutils-xml.py: Added to project. - -* tools/pep.py: Added to project; PEP to HTML front-end tool. - -* tools/pep-html-template: Added to project. - -* tools/pep2html.py: Added to project from Python (nondist/peps). - Added support for Docutils (reStructuredText PEPs). - -* tools/quicktest.py: - - - Added the ``--attributes`` option, hacked a bit. - - Added a second command-line argument (output file); cleaned up. - -* tools/stylesheets/: Subdirectory added to project. - -* tools/stylesheets/pep.css: Added to project; stylesheet for PEPs. - - -Release 0.1 (2002-04-20) -======================== - -This is the first release of Docutils, merged from the now inactive -reStructuredText__ and `Docstring Processing System`__ projects. For -the pre-Docutils history, see the `reStructuredText HISTORY`__ and the -`DPS HISTORY`__ files. - -__ http://structuredtext.sourceforge.net/ -__ http://docstring.sourceforge.net/ -__ http://structuredtext.sourceforge.net/HISTORY.html -__ http://docstring.sourceforge.net/HISTORY.html - -General changes: renamed 'dps' package to 'docutils'; renamed -'restructuredtext' subpackage to 'rst'; merged the codebases; merged -the test suites (reStructuredText's test/test_states renamed to -test/test_rst); and all modifications required to make it all work. - -* docutils/parsers/rst/states.py: - - - Improved diagnostic system messages for missing blank lines. - - Fixed substitution_reference bug. - - -.. - Local Variables: - mode: indented-text - indent-tabs-mode: nil - sentence-end-double-space: t - fill-column: 70 - End: |