1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
21 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
22 installed in the PYTHONPATH. Converted tests are now
23 stored in ``test3/``, tools no longer need conversion.
25 If you installed one of Docutils versions 0.7 ... 0.9 with
26 ``setup.py install`` under Python 3, remove the spurious
27 ``test/`` and ``tools/`` directories in the site library root.
31 - Make tests independent from the location of the ``test/`` directory.
32 - Use converted sources (from the ``build/`` directory) for tests under
37 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
41 - Fix writing binary data to sys.stdout under Python 3 (allows
42 ``rst2odt.py`` to be used with output redirection).
44 * docutils/parsers/rst/directives/misc.py
46 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
47 ``locale == C`` and 8-bit char in path argument of `include` directive.
49 * docutils/test/alltests.py
51 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
54 Release 0.9 (2012-05-02)
55 ========================
59 - New reStructuredText "code" role and directive and "code" option
60 of the "include" directive with syntax highlighting by Pygments_.
61 - Fix parse_option_marker for option arguments containing ``=``.
62 - Fix [ 2993756 ]: import Python Imaging Library's Image module
63 via ``import PIL`` as starting with PIL 1.2,
64 "PIL lives in the PIL namespace only" (announcement__).
66 .. _Pygments: http://pygments.org/
67 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
71 - Fix [ 2971827 ] and [ 3442827 ]
72 extras/roman.py moved to docutils/utils/roman.py
74 * docutils/frontend.py
76 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
80 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
81 - `mode` argument for FileOutput avoids code replication in
83 - New exceptions InputError and OutputError for IO errors in
88 - No "hard" system exit on file IO errors: catch and report them in
89 `Publisher.reportException` instead. Allows handling by a calling
90 application if the configuration setting `traceback` is True.
92 * docutils/utils.py -> docutils/utils/__init__.py
94 - docutils.utils is now a package (providing a place for sub-modules)
96 .. note:: docutils/math, docutils/error_reporting.py, and
97 docutils/urischemes.py will move to the utils package in the next
98 release, too. See RELEASE-NOTES__
100 __ RELEASE-NOTES.html
102 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
103 errors recording non-ASCII filenames (fixes [ 3434355 ]).
105 - Fix relative_path() with source=None and `unicode` target.
107 * docutils/parsers/rst/states.py
109 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
110 characters and "international" quotes around inline markup.
111 - Use `field_marker` pattern to look for start of a
112 directive option block (fixes [ 3484857 ]).
114 * docutils/parsers/rst/tableparser.py
116 - Fix [ 2926161 ] for simple tables.
117 (Combining chars in grid tables still contribute to cell width.)
119 * docutils/writers/latex2e/__init__.py
121 - Support the `abbreviation` and `acronym` standard roles.
122 - Record only files required to generate the LaTeX source as dependencies.
123 - Fix handling of missing stylesheets.
124 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
125 when suppressing LaTeX section numbering.
126 - Use ``\DUtitle`` for unsupported section levels
127 - Apply [ 3512791 ] do not compare string literals with "is"
129 * docutils/writers/xetex/__init__.py
131 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
133 * docutils/writers/html4css1/__init__.py
135 - Change default for `math-output` setting to MathJax.
136 - Fix handling of missing stylesheets.
138 * docutils/writers/docutils_xml.py
140 - Use the visitor pattern with default_visit()/default_depart() methods
141 instead of minidom to facilitate special handling of selected nodes.
142 - Support raw XML (inserted as-is inside a <raw></raw> node).
144 * docutils/writers/manpage.py
146 - Do not emit comment line with trailing blank. Problematic for VCS.
148 Release 0.8.1 (2011-08-30)
149 ==========================
153 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
154 and [ 3395920 ] (correct copyright info for rst.el).
158 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
160 * docutils/writers/latex2e/__init__.py
162 - Clean up Babel language setting. Restores Sphinx compatibility.
164 Release 0.8 (2011-07-07)
165 ========================
169 - Handle language codes according to `BCP 47`_.
170 - If the specified language is not supported by Docutils,
171 warn and fall back to English.
172 - Math support: reStructuredText "math" role and directive,
173 ``math`` and ``math_block`` doctree elements.
174 - Decode command line arguments with the locale's preferred encoding
175 (to allow, e.g., ``--title=Dornröschen``).
176 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
177 - New sub-module `error_reporting`: handle encoding/decoding errors
178 when reporting exceptions.
179 - Some additions to the Docutils core are released under the 2-Clause BSD
180 license, see COPYING_ for details.
182 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
183 .. _COPYING: COPYING.html
187 - Most directives now support a "name" option that attaches a
190 - Directive content may start on the first line also when the directive
191 type accepts options.
193 * docs/dev/policies.txt:
195 - Recommend the 2-Clause BSD license
196 (http://www.spdx.org/licenses/BSD-2-Clause)
197 for code that is kept under the author's copyright.
199 * tools/buildhtml.py:
201 - Fix ``--local`` switch.
203 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
205 * docutils/writers/html4css1/__init__.py
207 - Set "lang" argument for objects with class argument
208 "language-<language tag>".
209 - New setting "math-output" with support for HTML, MathML, and LaTeX.
211 * docutils/writers/latex2e/__init__.py
213 - Fix [ 3043986 ] AttributeError using :local: with table of content.
214 - Place title data in the document preamble.
215 - Load `babel` package only if required.
216 - Update list of supported languages.
217 - New config setting "hyperref-options".
218 No hard-coded "unicode" hyperref option (clash with xetex).
219 - Set language for custom roles, paragraphs, block-quotes, and
220 line-quotes with class argument "language-<language tag>".
221 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
222 - Convert image URI to a local file path.
223 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
224 has more than one paragraph (Wolfgang Scherer).
225 - \leavevmode before longtable only when needed (prevents spurious vspace)
226 - do not advance table counter for tables without caption
228 * docutils/writers/xetex/__init__.py
230 - New writer generating LaTeX code for compiling with ``xelatex``.
232 A separate writer (inheriting from latex2e) instead of a ``--xetex``
233 option allows separate config options for XeTeX vs. LaTeX2e.
235 * docutils/writers/manpage.py
237 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
238 - Fix: vertical space cleaning for option group ``.``.
240 * tools/editors/emacs/rst.el:
242 - Fix [ 3001100 ] does not handle spaces in filenames
243 (thanks to Jakub Wilk)
247 - strip whitespace from stylesheet arguments
248 - exclude combining chars from column_width()
249 (partial fix for [ 2926161 ])
251 * docutils/parsers/rst/directives/misc.py:
253 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
258 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
259 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
261 Release 0.7 (2010-07-07)
262 ========================
266 - Fix [ 2881769 ] setup configuration.
267 - Fix [ 2788716 ] reporting problems in included files.
271 - FileInput opens files as text files with universal newline support
272 (mode "rU", configurable with the new optional argument "mode").
276 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
280 - Fix [ 2923723 ] let decode_path() tolerate path == None
282 * docutils/writers/html4css1/__init__.py
284 - Support SVG and SWF images (thanks to Stefan Rank).
285 - Generate valid XHTML for centered images with targets.
286 Use CSS classes instead of "align" tags for image alignment.
288 * docutils/writers/latex2e/__init__.py
290 - Use `transforms.writer_aux.Admonitions` to "normalize" special
292 - Use the ``\url`` command for URLs (breaks long URLs instead of
293 writing into the margin).
294 - Preserve runs of spaces in `inline literals`__.
295 - Deprecate ``figure_footnotes`` setting.
296 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
297 - New ``latex_preamble`` setting.
298 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
299 - Fix hyperlink targets (labels) for images, figures, and tables.
300 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
301 - Apply [ 2961991 ] Call hyperref with unicode option.
302 - Drop the special `output_encoding`__ default ("latin-1").
303 The Docutils wide default (usually "UTF-8") is used instead.
304 - Render inline markup in document title and subtitle.
305 - Fix numbering depth with LaTeX section numbering.
306 - Update Unicode -> LaTeX translations.
307 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
309 __ docs/ref/restructuredtext.html#inline-literals
310 __ docs/user/config.html#docutils-footnotes
311 __ docs/user/config.html#output_encoding
313 * docutils/writers/manpage.py
315 - Fix: supported attribute (thanks to peter2108).
316 - Remove trailing blanks in code (keep in sync with mercurial version).
317 - Titles level 1, that is ``.SH``, always uppercase.
318 - Apply patch from mg: literal text should be bold in man-pages.
322 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
327 - Python 3 support: copy test/ and tools/ to the build-dir
328 and convert Python sources with 2to3.
331 Release 0.6 (2009-10-11)
332 ========================
336 - Docutils is now compatible with Python versions from 2.3 up to 2.6
337 and convertible to 3.1 code.
339 + Node.__nonzero__ returns True instead of 1.
340 + use os.walk instead os.path.walk.
341 + minimize "types" module where possible.
342 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
343 + Text nodes now subclass unicode rather than UserString
344 (which is gone in python 3.0).
345 + 3.0 compatibility module docutils._compat
347 + Drop 2.2 compatibility workarounds.
348 + Drop extras/optparse.py and extras/textwrap.py
349 (stdlib modules since 2.3).
351 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
352 - Unix man page export: manpage writer moved from sandbox to Doctutils
355 - Apply [ 1719345 ] Galician translation
356 - Apply [ 1905741 ] Polish translation
357 - Apply [ 1878977 ] make_id(): deaccent characters.
358 - Apply [ 2029251 ] return nonzero when tests fail.
359 - Fix [ 1692788 ] allow UTF-8 in style sheets.
360 - Fix [ 2781629 ] support non-ASCII chars in file names.
361 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
362 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
363 - Fix [ 2821266 ] --strict option works now like --halt=info.
364 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
365 - Fix [ 1627229 ] hyperlink references in substitutions.
367 - The "newlatex" writer is orphaned.
371 - Documented Unicode characters allowed as inline markup openers,
372 closers, and delimiters.
373 - Allow units for all length specifications.
374 - Allow percent sign in "scale" argument of "figure" and "image" directives.
375 - Bugfix: The "figalign" argument of a figure now works as intended
376 (aligning the figure, not its contents).
377 - Align images with class "align-[right|center|left]"
378 (allows setting the alignment of an image in a figure).
382 - Added ``Element.__contains__`` method, for the in-operator.
384 * docutils/parsers/rst/states.py:
386 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
387 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
388 " " (non-breaking space), and "¡ ¿" openers.
390 * docutils/parsers/directives/misc.py:
392 - Added ``start-line`` and ``end-line`` options to "include"
393 directive to select a range of lines.
394 - Hard tabs in literal inclusions are replaced by spaces. This is
395 configurable via the new ``tab-width`` option of the "include" directive
396 (a negative tab-width prevents tab expansion).
400 - Add ``get_stylesheet_list`` function.
401 - Apply [ 2834836 ] print info at halt
403 * docutils/transforms/universal.py:
405 - Raise default priority of StripClasses to exclude stripped classes from
408 * docutils/writers/html4css1/__init__.py:
410 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
411 separated list of stylesheets.
412 - Address [ 1938891 ] Inline literal text creates "pre" span only when
413 needed to prevent inter-word line wraps.
414 - Use `translate` method instead of repeated `replace` calls.
415 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
416 classes to allow CSS styling that does not interfere with other
417 table-using constructs (field lists, citations, ...).
419 * docutils/writers/newlatex2e/__init__.py:
421 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
423 * docutils/writers/latex2e/__init__.py (see also
424 `<docs/user/docutils-05-compat.sty.html>`__) :
426 - Add ``--embed-stylesheet`` option.
427 - Apply [ 1474017 ] image vertical alignment is reversed.
428 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
429 - Change: has_key for dictionaries (not Nodes) to in-operator.
430 - Merge adjacent citations into one latex cite command.
431 - Failsave implementation of custom roles. LaTeX compilation now ignores
432 unknown classes instead of aborting with an error.
433 - Support custom roles based on standard roles.
434 - LaTeX packages can be used as ``--stylesheet`` arguments without
435 restriction. (A style sheet is now referenced with the ``\usepackage``
436 command, if it ends with ``.sty`` or has no extension.)
437 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
438 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
439 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
440 2005-02-04 as a configurable length unit).
441 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
442 if font-encoding is set to ''. LaTeX defaults to OT1 then.
443 - Set sub- and superscript role argument in text mode not as math.
444 Use a custom role based on sub-/superscript if you want italic shape.
445 - Shorter preamble and less dependencies: Load packages and define macros
446 only if required in the document.
447 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
448 - New custom environments and commands with optional "classes" argument.
449 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
450 - Better conformance to Docutils specifications with ``--use-latex-toc``.
451 Support for LaTeX generated ToC also with unnumbered sections.
452 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
453 section numbering by LaTeX.
454 - Use default font in admonitions and sidebar.
455 - Align of image in a figure defaults to 'center'.
456 - Bugfix: Newlines around targets and references prevent run-together
458 - Fix internal hyperlinks.
459 - Use class defaults for page margins ('typearea' now optional).
460 - Float placement made configurable, default changed to "here definitely".
461 - Typeset generic topic as "quote block with title".
462 - Use template (file and configuration option).
463 - In the default template, load cmap.sty (fix text extraction in PDF) and
464 fixltx2e.sty (LaTeX patches, \textsubscript).
465 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
466 - Use `translate` instead of repeated `replace` calls for text encoding.
467 - Hyperlinked footnotes and support for symbol footnotes and
468 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
469 - Complete pairs of binary options
470 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
471 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
473 - font-encoding: "T1" (formerly implicitely set by 'ae').
474 - use-latex-toc: true (ToC with page numbers).
475 - use-latex-footnotes: true (no mixup with figures).
477 * docutils/writers/manpage.py
479 - Do not print version at document end, this is done by the viewer.
480 - Do not print date at document end, this is done by the viewer.
481 - Fix storage of docinfo fields for none standard fields.
483 * docutils/tools/rst2man.py
485 Release 0.5 (2008-06-25)
486 ========================
488 * docutils/languages/he.py: Added to project: Hebrew mappings by
491 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
492 mappings by Meir Kriheli.
494 * docutils/frontend.py:
496 - Configuration files are now assumed and required to be
498 - Paths of applied configuration files are now recorded in the
499 runtime setting ``_config_files`` (accessible via
500 ``--dump-settings``).
501 - Added ``--strip-elements-with-class`` and ``--strip-class``
502 options (``strip_elements_with_classes`` and ``strip_classes``
507 - Added code to determine the input encoding from data: encoding
508 declarations or the presence of byte order marks (UTF-8 & UTF-16).
509 - Added support for IronPython 1.0.
513 - Added ``document.__getstate__`` method, for pickling.
515 * docutils/parsers/rst/states.py:
517 - Allow ``+`` and ``:`` in reference names.
518 - Unquoted targets beginning with an underscore (``.. __target:
519 URI``) are no longer accepted.
520 - Added support for multiple attributions in a physical block quote
521 (indented text block), dividing it into multiple logical block
523 - Added support for unicode bullets in bullet lists: "•", "‣", and
525 - Added support for new object-oriented directive interface,
526 retaining compatibility to the old functional interface.
527 - Added support for throwing ``DirectiveError``'s from within
530 * docutils/parsers/rst/__init__.py:
532 - Added ``Directive`` base class.
533 - Added ``DirectiveError`` base class.
534 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
537 * docutils/parsers/directives/:
539 - Refactored all reStructuredText directives to use the new
540 object-oriented directive interface. Errors are now (mostly)
541 thrown using the new ``DirectiveError`` class.
543 * docutils/parsers/directives/misc.py:
545 - Added ``start-after`` and ``end-before`` options to ``include``
546 directive; thanks to Stefan Rank.
548 * docutils/transforms/universal.py:
550 - Added ``StripClassesAndElements`` transform to remove from the
551 document tree all elements with classes in
552 ``settings.strip_elements_with_classes`` and all "classes"
553 attribute values in ``self.document.settings.strip_classes``.
555 * docutils/transforms/writer_aux.py:
557 - Added ``Admonitions`` transform to transform specific admonitions
558 (like ``note``, ``warning``, etc.) into generic admonitions with a
561 * docutils/writers/html4css1/__init__.py:
563 - Moved template functionality from the PEP/HTML writer here.
564 - Expanded the fragments available in the ``parts`` attribute.
565 - Moved ``id`` attributes from titles to surrounding ``div``
567 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
568 universally supported now).
569 - ``template.txt`` is now opened in text mode instead of binary mode
570 (to ensure Windows compatibility).
571 - ``a`` elements now have an "internal" or "external" class,
572 depending on reference type.
574 * docutils/writers/html4css1/template.txt: Added to project.
576 * docutils/writers/pep_html/:
578 - Moved template functionality to the HTML writer.
580 * docutils/writers/s5_html/__init__.py:
582 - Added ``view_mode`` & ``hidden_controls`` settings
583 (``--view-mode`` & ``--hidden-controls/--visible-controls``
586 * docutils/writers/latex2e/__init__.py:
588 - Add ``--literal-block-env``
589 - Fix: escaping ``%`` in href urls.
590 - Move usepackage hyperref after stylesheet inclusion.
591 - Fix: scrartcl does not have chapter but scrreprt.
592 - Add newline after ``\end{verbatim}``.
593 - Merge smaller differences from latex2e_adaptive_preamble.
594 - Add ``use-part-section``.
595 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
596 - Using leavemode option_list no longer needs to check if parent
597 is a definition list.
598 - Append ``\leavemode`` to definition list terms.
599 - No longer write visit\_/depart_definition_list_item comments to
601 - Table column width with 3 decimal places.
602 - Add table stubs support (boldfont).
603 - Add assemble_parts to writer.
604 - Add simply support for nested tables.
605 - Fix verbatim in tables if use-verbatim-when-possible.
606 - Use section commands down to subparagraph.
607 - Put ensuremath around some latin1 chars.
608 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
609 - New option ``--use-bibtex=style,db1,db2``.
610 - New option ``--reference-label`` to allow usage of LaTeX ref for
611 labels in section references.
612 - Add a label after every section to support sectionnumbers as reference
614 - Fix: bug# 1605376 rst2latex: bad options group list
615 - Remove inactive code for use_optionlist_for_option_list.
616 - Remove latex comments from option_list output.
617 - Fix: bug# 1612270 double qoutes in italian literal.
618 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
619 - Add option --use-latex-abstract.
620 - Image width unit ``px`` is translated to ``pt``.
621 - Add image height support.
622 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
624 - Fix: Do not escape underscores in citation reference labels if
625 use-latex-citations is set.
626 - Use centering instead of center for figure contents, to avoid vertical
628 - Recognize table class: borderless, nolines, booktabs, standard.
629 - Fix: Renaming contents section does not work with latex writer; SF
631 - Applied patch for custom roles with classes from Edward Loper.
632 - Fixed bug that caused crashes with more than 256 lists.
634 * docutils/writers/pep_html/__init__.py:
636 - Changed to support new python.org website structure and
639 * docs/howto/security.txt: "Deploying Docutils Securely", added to
642 * tools/buildhtml.py:
644 -- Added ``ignore`` setting to exclude a list of shell patterns
645 (default: ``.svn:CVS``).
647 * tools/editors/emacs/rst.el:
649 - Changed license to "GPL".
650 - Added ``rst-straighten-decorations`` function.
651 - The ``compile`` module is now always loaded.
652 - Added ``rst-toggle-line-block`` function.
653 - Headings consisting only of non-ASCII characters are now
654 recognized by ``rst-toc`` and ``rst-adjust``.
655 - Added font-lock support for multi-line comments where the first
656 comment line is empty.
657 - Added ``(require 'font-lock)``.
661 - Provide descriptive error message if distutils is missing.
664 Release 0.4 (2006-01-09)
665 ========================
669 - Updated the project policies for trunk/branch development &
672 * docutils/__init__.py:
674 - Added ``__version_details__`` attribute to describe code source
675 (repository/snapshot/release).
676 - Replaced ``default_transforms`` attribute of TransformSpec with
677 ``get_transforms()`` method.
681 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
682 functions, for document tree extraction and reprocessing.
686 - Added ``DocTreeInput`` class, for reprocessing existing documents.
687 - Added support for non-Unicode (e.g. binary) writer output.
691 - Re-introduced ``Targetable.indirect_reference_name``, for
692 MoinMoin/reST compatibility (removed in r3124/r3129).
693 - Added ``serial_escape`` function; escapes string values that are
694 elements of a list, for serialization. Modified Docutils-XML
695 writing (``Element._dom_node``) and pseudo-XML writing
696 (``Element.starttag``) to use ``serial_escape``.
697 - Added ``Node.deepcopy()`` method.
698 - Removed the internal lists ``document.substitution_refs``,
699 ``document.anonymous_refs``, and ``document.anonymous_targets``.
700 - Added a "container" element.
701 - Fixed bug where values of list-valued attributes of elements
702 originating from custom interpreted text roles (i.e., with custom
703 classes) were being shared between element instances. Reported by
706 * docutils/statemachine.py:
708 - Added trailing whitespace stripping to ``string2lines()``.
709 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
710 Asian double-width character support.
714 - Added ``east_asian_column_width()`` for double-width character
717 * docutils/languages/ja.py: Added to project: Japanese mappings by
720 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
721 mappings by Panjunyong.
723 * docutils/parsers/null.py: Added to project; a do-nothing parser.
725 * docutils/parsers/rst/__init__.py:
727 - Added validator to tab_width setting, with test. Closes SF bug
728 #1212515, report from Wu Wei.
730 * docutils/parsers/rst/states.py:
732 - Fixed bug with escaped colons indicating a literal block.
733 - Fixed bug with enumerated lists (SF#1254145).
734 - Backslash-escaped colons inside of field names are now allowed.
735 - Targets (implicit and explicit), anonymous hyperlink references
736 and auto-numbered footnote references inside of substitution
737 definitions are now disallowed.
738 - Fixed bug: list items with blank first lines.
739 - Fixed bug: block quote attributions with indented second lines.
740 - Added East Asian double-width character support (Python 2.4 only).
742 * docutils/parsers/rst/tableparser.py:
744 - Added East Asian double-width character support (Python 2.4 only).
746 * docutils/parsers/rst/directives/body.py:
748 - Added the "container" directive.
750 * docutils/parsers/rst/directives/misc.py:
752 - Added the "default-role", "title", and "date" directives.
753 - Added standard data file syntax to the "include" directive.
754 - Added support for "class" directive content.
756 * docutils/parsers/rst/directives/images.py:
758 - Added ``indirect_reference_name`` support for images with a target
760 - Added support for image width and height units.
761 - Fixed bug with image "target" options.
763 * docutils/parsers/rst/directives/references.py:
765 - Added "class" attribute to "target-notes" directive, for
766 footnote_reference classes.
768 * docutils/parsers/rst/include/: Directory added to project; contains
769 standard data files for the "include" directive. Initial contents:
770 character entity substitution definition sets, and a set of
771 definitions for S5/HTML presentations.
773 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
774 mappings by David Goodger.
776 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
777 Simplified Chinese mappings by Panjunyong.
779 * docutils/readers/__init__.py:
781 - Added universal.Decorations and universal.ExposeInternals
782 transforms as default transforms for all readers.
783 - Added ``ReReader`` base class for readers that reread an existing
786 * docutils/readers/doctree.py: Added to project; a reader for existing
789 * docutils/transforms/frontmatter.py:
791 - Fixed the DocInfo transform to handle SVN-style expansion of the
793 - In ``DocInfo.extract_authors``, treat the contents of "authors"
796 * docutils/transforms/misc.py:
798 - Added misc.Transitions transform, extracted from
799 universal.FinalChecks.
801 * docutils/transforms/references.py:
803 - Added references.DanglingReferences transform, extracted from
804 universal.FinalChecks.
805 - Fixed bug with doubly-indirect substitutions.
806 - Added footnote_reference classes attribute to "TargetNotes".
807 - Fixed bug with circular substitution definitions that put Docutils
808 into an infinite loop.
810 * docutils/transforms/universal.py:
812 - Added universal.ExposeInternals transform, extracted from
813 universal.FinalChecks.
814 - Removed universal.FinalChecks transform (logic has been moved to
815 several new transforms).
816 - Fixed bug with the "expose_internals" setting and Text nodes
817 (exposed by the "rawsource" internal attribute).
818 - Added the universal.StripComments transform, implementation of the
819 "strip_comments" setting.
821 * docutils/transforms/writer_aux.py: Added to project; auxiliary
822 transforms for writers.
824 - Added ``Compound`` transform, which flattens compound paragraphs.
826 * docutils/writers/: Several writer modules (html4css1.py) were
827 converted into packages. Support modules and data files have been
828 moved into the packages. The stylesheets for the HTML writers are
829 now installed along with the code, the code knows where to find
830 them, and the default is to use them (actually, to embed them).
831 Some adjustments to configuration files may be necessary. The
832 easiest way to obtain the new default behavior is to remove all
833 settings whose name includes "stylesheet".
835 * docutils/writers/__init__.py:
837 - Added universal.Messages and universal.FilterMessages transforms
838 as default transforms for all writers.
839 - Added ``UnfilteredWriter`` base class for writers that pass the
840 document tree on unchanged.
842 * docutils/writers/docutils_xml.py:
844 - Made ``xmlcharrefreplace`` the default output encoding error
847 * docutils/writers/html4css1/:
849 - Added support for image width and height units.
850 - Made ``xmlcharrefreplace`` the default output encoding error
852 - Made ``--embed-stylesheet`` the default rather than
853 ``--link-stylesheet``.
854 - Moved "id" attribute from container (section etc.) to title's <a>
855 tag, to be on the same tag as "name".
856 (!!! To be reverted in Docutils 0.5.)
857 - Added vertical space between fields of field lists.
858 - Added ``--compact-field-lists`` option to remove vertical space in
860 - Made cloaking of email addresses with ``--cloak-email-addresses``
862 - Fixed support for centered images.
863 - Added support for class="compact" & class="open" lists.
865 * docutils/writers/latex2e/:
867 - Underscores in citekeys are no longer escaped.
869 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
870 mapping of Unicode characters to LaTeX equivalents.
872 * docutils/writers/s5_html/: Package added to project; writer for
875 * docs/dev/distributing.txt: Added to project; guide for distributors
876 (package maintainers).
878 * docs/dev/hacking.txt: Added to project; guide for developers.
880 * docs/ref/doctree.txt:
882 - Updated for plural attributes "classes", "ids", "names",
884 - Added the "container" element.
886 * docs/ref/docutils.dtd:
888 - Updated for plural attributes "classes", "ids", "names",
891 * docs/user/emacs.txt: Added to project; a document about Emacs
892 support for reStructuredText and Docutils.
894 * docs/user/links.txt: Added to project; lists of Docutils-related
897 * docs/user/mailing-lists.txt: Added to project; information about
898 Docutils-related mailing lists and how to access them.
900 * docs/user/slide-shows.txt: Added to project; example of and docs for
901 the S5/HTML writer (``rst2s5.py`` front end).
903 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
904 Files", added to project.
906 * test/coverage.sh: Added to project; test coverage script.
908 * test/DocutilsTestSupport.py:
910 - Added support for specifying runtime settings at the suite level.
912 * test/test_functional.py:
914 - Added the ``clear_output_directory`` function.
915 - Added support for ``_test_more`` functions in functional test
918 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
920 * tools/rstpep2html.py: Renamed from pep.py.
922 * tools/dev/create_unimap.py: Added to project; script to create the
923 docutils/writers/unimap_latex.py mapping file.
925 * tools/dev/profile_docutils.py: Added to project; profiler script.
927 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
929 * tools/editors/emacs/restructuredtext.el,
930 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
931 Removed from project; the functionality is now contained in rst.el.
933 * tools/editors/emacs/rst.el: Added to project. Added many features
934 and fixed many bugs. See docs/user/emacs.txt for details.
936 * tools/stylesheets: Removed from project. Stylesheets have been
937 renamed and moved into writer packages.
940 Release 0.3.9 (2005-05-26)
941 ==========================
945 - Eliminated and replaced all uses of the old string attributes
946 ``id``, ``name``, ``dupname`` and ``class`` with references to the
947 new list attributes ``ids``, ``names``, ``dupnames`` and
948 ``classes`` throughout the whole source tree.
952 - Enabled ``--dump-*`` options when ``--traceback`` specified,
953 allowing for easier debugging.
954 - In ``Publisher.publish()``, expanded the generic top-level
957 * docutils/examples.py:
959 - Added ``internals`` function for exploration.
963 - Fixed ``Input.decode`` method to apply heuristics only if no
964 encoding is explicitly given, and to provide better reporting of
966 - The ``Input.decode`` method now removes byte order marks (BOMs)
971 - ``image`` element class changed to subclass of Element, not
972 TextElement (it's an empty element, and cannot contain text).
973 - Added ``attr_defaults`` dictionary for default attribute values.
974 - Added empty list as default value for the following attributes:
975 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
976 - Added ``document.decoration`` attribute,
977 ``document.get_decoration`` method, and ``decoration.get_header``
978 & ``.get_footer`` methods.
979 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
984 - Removed ``docutils.utils.Reporter.categories``,
985 ``docutils.utils.ConditionSet``, and all references to them, to
986 simplify error reporting.
988 * docutils/languages/nl.py: Added to project; Dutch mappings by
991 * docutils/parsers/rst/__init__.py:
993 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
995 * docutils/parsers/rst/states.py:
997 - Added check for escaped at-mark to prevent email address recognition.
998 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1000 - Allowed whitespace in paths and URLs.
1001 - Added auto-enumerated list items.
1002 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1004 - Added support for table stub columns.
1006 * docutils/parsers/rst/directives/__init__.py:
1008 - Allowed whitespace in paths (``path`` function).
1009 - Added ``uri`` directive option conversion function.
1011 * docutils/parsers/rst/directives/body.py:
1013 - Fixed illegal context bug with "topic" directive (allowed within
1014 sidebars; not within body elements).
1016 * docutils/parsers/rst/directives/images.py:
1018 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1019 - Added support for the ``file_insertion_enabled`` setting in the
1020 "figure" directive (disables "figwidth" option).
1021 - "image" directive: added checks for valid values of "align" option,
1022 depending on context. "figure" directive: added specialized
1023 "align" option and attribute on "figure" element.
1024 - Made ":figwidth: image" option of "figure" directive work again.
1025 - Fixed bug with reference names containing uppercase letters
1026 (e.g. ``Name_``) in "target" option of "image" directive.
1028 * docutils/parsers/rst/directives/misc.py:
1030 - Fixed "include" and "raw" directives to catch text decoding
1032 - Allowed whitespace in "include" & "raw" directive paths.
1033 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1034 settings in "include" & "raw" directives.
1036 * docutils/parsers/rst/directives/parts.py:
1038 - Added "header" & "footer" directives.
1039 - Fixed illegal context bug with "contents" directive (topics
1040 allowed within sidebars; not within body elements).
1042 * docutils/parsers/rst/directives/tables.py:
1044 - Added "list-table" directive.
1045 - Caught empty CSV table bug.
1046 - Added support for the ``file_insertion_enabled`` setting in the
1047 "csv-table" directive.
1048 - Added ``stub-columns`` option to "csv-table" and "list-table"
1051 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1052 mappings by Martijn Pieters.
1054 * docutils/readers/standalone.py:
1056 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1057 options to activate or deactivate the SectSubTitle transform.
1059 * docutils/transforms/frontmatter.py:
1061 - Added SectSubTitle transform to promote titles of lone
1062 subsections to subtitles.
1064 * docutils/transforms/references.py:
1066 - Fixed mislocated internal targets bug, by propagating internal
1067 targets to the next node, making use of the newly added support
1068 for multiple names and IDs.
1069 - Fixed duplicate footnote label bug.
1070 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1073 * docutils/writers/html4css1.py:
1075 - Fixed unencoded stylesheet reference bug (characters like "&" in
1076 stylesheet references).
1077 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1079 - Added support for multiple IDs per node by creating empty ``span``
1081 - Added the ``field_name_limit`` & ``option_limit`` settings &
1083 - Added support for table stub columns.
1084 - Added support for the ``align`` attribute on ``figure`` elements.
1085 - Added the ``cloak_email_addresses`` setting & support.
1086 - Added ``html_prolog``, ``html_head``, ``html_body``,
1087 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1088 ``docutils.core.publish_parts``.
1089 - Added support for section subtitles.
1091 * docutils/writers/latex2e.py:
1093 - Fixed tables starting with more than one multirow cell.
1094 - Improved --use-latex-docinfo so that organization/contact/address
1095 fields are lumped with the last author field and appear on the
1097 - Made sure the titlepage is always shown with --use-latex-docinfo,
1098 even if the document has no title.
1099 - Made sure that latex doesn't fill in today's date if no date field
1101 - Added support for section subtitles.
1103 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1104 (under development).
1106 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1108 * docs/api/publisher.txt:
1110 - Added "``publish_parts`` Details" section.
1112 * docutils/dev/repository.txt: Added to project; information about the
1113 Docutils Subversion repository.
1115 * docs/ref/docutils.dtd:
1117 - Added a ``stub`` attribute to the ``colspec`` element via the
1118 ``tbl.colspec.att`` parameter entity.
1119 - Allowed topic elements within sidebars
1120 - Added an ``align`` attribute to the ``figure`` element.
1122 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1126 Release 0.3.7 (2004-12-24)
1127 ==========================
1129 * docutils/frontend.py:
1131 - Added options: --input-encoding-error-handler,
1132 --record-dependencies, --leave-footnote-reference-space,
1134 - Added command-line and config file support for "overrides" setting
1139 - Added support for input encoding error handler.
1141 * docutils/nodes.py:
1143 - Added dispatch_visit and dispatch_departure methods to
1144 NodeVisitor; useful as a hook for Visitors.
1145 - Changed structure of ``line_block``; added ``line``.
1146 - Added ``compound`` node class.
1147 - Added a mechanism for Visitors to transitionally ignore new node
1150 * docutils/utils.py:
1152 - Moved ``escape2null`` and ``unescape`` functions from
1153 docutils/parsers/rst/states.py.
1155 * docutils/parsers/rst/roles.py:
1158 - Changed role function API: the "text" parameter now takes
1159 null-escaped interpreted text content.
1161 * docutils/parsers/rst/states.py:
1163 - Fixed bug where a "role" directive in a nested parse would crash
1164 the parser; the state machine's "language" attribute was not being
1166 - Added support for line block syntax.
1167 - Fixed directive parsing bug: argument-less directives didn't
1168 notice that arguments were present.
1169 - Removed error checking for transitions.
1170 - Added support for multiple classifiers in definition list items.
1171 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1172 - Changed role function API: the "text" parameter now takes
1173 null-escaped interpreted text content.
1174 - Empty sections and documents are allowed now.
1176 * docutils/parsers/rst/directives/__init__.py:
1178 - Added ``encoding`` directive option conversion function.
1179 - Allow multiple class names in class_option conversion function.
1181 * docutils/parsers/rst/directives/body.py:
1183 - Converted the line-block directive to use the new structure.
1184 - Extracted the old line-block functionality to the ``block``
1185 function (still used).
1186 - Added ``compound`` directive (thanks to Lea Wiemann).
1188 * docutils/parsers/rst/directives/misc.py:
1190 - Added "encoding" option to "include" and "raw" directives.
1191 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1192 - Allow multiple class names in the "class" directive.
1194 * docutils/parsers/rst/directives/parts.py:
1196 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1197 options. Thanks to Lele Gaifax.
1199 * docutils/parsers/rst/directives/tables.py:
1201 - Added "encoding" directive to "csv-table" directive.
1202 - Added workaround for lack of Unicode support in csv.py, for
1203 non-ASCII CSV input.
1205 * docutils/transforms/misc.py:
1207 - Fixed bug when multiple "class" directives are applied to a single
1209 - Enabled multiple format names for "raw" directive.
1211 * docutils/transforms/references.py:
1213 - Added support for trimming whitespace from beside substitution
1216 * docutils/transforms/universal.py:
1218 - FinalChecks now checks for illegal transitions and moves
1219 transitions between sections.
1221 * docutils/writers/html4css1.py:
1223 - HTMLTranslator.encode now converts U+00A0 to " ".
1224 - "stylesheet" and "stylesheet_path" settings are now mutually
1226 - Added support for the new line_block/line structure.
1227 - --footnote-references now overrides
1228 --trim-footnote-reference-space, if applicable.
1229 - Added support for ``compound`` elements.
1230 - Enabled multiple format names for "raw" directive.
1231 - ``<p>`` tags of a paragraph which is the only visible child of the
1232 document node are no longer stripped.
1233 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1234 new method ``should_be_compact_paragraph()``.
1235 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1237 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1238 the output if they have their ``class`` attribute set.
1239 - The whole document is now surrounded by a ``<div
1240 class="document">`` element.
1241 - Body-level images are now wrapped by their own ``<div>`` elements,
1242 with image classes copied to the wrapper, and for images which
1243 have the ``:align:`` option set, the surrounding ``<div>`` now
1244 receives a class attribute (like ``class="align-left"``).
1246 * docutils/writers/latex2e.py:
1248 - no newline after depart_term.
1249 - Added translations for some Unicode quotes.
1250 - Added option "font-encoding", made package AE the default.
1251 - "stylesheet" and "stylesheet_path" settings are now mutually
1253 - --footnote-references now overrides
1254 --trim-footnote-reference-space, if applicable.
1255 - The footnote label style now matches the footnote reference style
1256 ("brackets" or "superscript").
1257 - Added support for ``compound`` elements.
1258 - Enabled multiple format names for "raw" directive.
1260 * docs/ref/docutils.dtd:
1262 - Changed structure of the ``line_block`` element; added ``line``.
1263 - Added ``compound`` element.
1264 - Added "ltrim" and "rtrim" attributes to
1265 ``substitution_definition`` element.
1266 - Enabled multiple format names for ``raw`` element.
1267 - Enabled multiple classifiers in ``definition_list_item`` elements.
1269 * docs/ref/rst/directives.txt
1271 - Marked "line-block" as deprecated.
1272 - "Class" directive now allows multiple class names.
1273 - Added "Rationale for Class Attribute Value Conversion".
1274 - Added warning about "raw" overuse/abuse.
1276 * docs/ref/rst/restructuredtext.txt:
1278 - Added syntax for line blocks.
1279 - Definition list items may have multiple classifiers.
1281 * docs/ref/rst/roles.txt:
1285 * tools/stylesheets/default.css:
1287 - Added support for the new line_block structure.
1288 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1291 Release 0.3.5 (2004-07-29)
1292 ==========================
1296 * _`Documentation cleanup/reorganization`.
1298 - Created new subdirectories of docs/:
1300 * ``docs/user/``: introductory/tutorial material for end-users
1301 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1302 * ``docs/api/``: API reference material for client-developers
1303 * ``docs/ref/``: reference material for all groups
1304 * ``docs/howto/``: for component-developers and core-developers
1305 * ``docs/peps/``: Python Enhancement Proposals
1307 - Moved ``docs/*`` to ``docs/user/``.
1308 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1309 ``spec/`` to ``docs/dev``.
1310 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1311 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1312 - Moved ``alternatives.txt``, and ``problems.txt`` from
1313 ``spec/rst/`` to ``docs/dev/rst/``.
1314 - Moved ``reStructuredText.txt``, ``directives.txt``,
1315 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1316 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1317 ``roles.txt``, ``reStructuredText.txt`` to
1318 ``restructuredtext.txt``.
1319 - Moved ``spec/howto/`` to ``docs/howto``.
1321 In order to keep the CVS history of moved files, we supplied
1322 SourceForge with a `script for modifying the Docutils CVS
1325 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1327 After running the cleanup script:
1329 - Added ``docs/index.txt``.
1330 - Added a ``.htaccess`` file to the ``web`` module, containing
1331 redirects for all old paths to new paths. They'll preserve
1332 fragments (the "#name" part of a URL), and won't clutter up the
1333 file system, and will correct the URL in the user's browser.
1334 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1335 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1336 the "To Do" list itself in ``docs/dev/todo.txt``.
1337 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1338 section of ``docs/dev/todo.txt``.
1339 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1340 - Added "How To Report Bugs" to ``BUGS.txt``.
1341 - Went through all the sources and docs (including under web/) and
1342 updated links. Mostly done by Lea Wiemann; thanks Lea!
1343 (Still need to update links in the sandboxes.)
1347 * BUGS.txt: Added to project.
1349 * THANKS.txt: Added to project.
1351 * docutils/__init__.py:
1353 - 0.3.4: Post-release.
1357 - Added special error handling & advice for UnicodeEncodeError.
1358 - Refactored Publisher.publish (simplified exception handling &
1359 extracted debug dumps).
1360 - Renamed "enable_exit" parameter of convenience functions to
1361 "enable_exit_status".
1362 - Enabled traceback (exception propagation) by default in
1363 programmatic convenience functions.
1364 - Now publish_file and publish_cmdline convenience functions return
1365 the encoded string results in addition to their regular I/O.
1366 - Extracted common code from publish_file, publish_string, and
1367 publish_parts, into new publish_programmatically. Extracted
1368 settings code to ``Publisher.process_programmatic_settings``.
1369 - In Publisher.publish, disabled ``settings_overrides`` when
1370 ``settings`` is supplied; redundant.
1372 * docutils/frontend.py:
1374 - Added help text for "--output-encoding-error-handler" and
1375 "--error-encoding-error-handler".
1376 - Renamed "--exit" to "--exit-status".
1377 - Simplified default-setting code.
1379 * docutils/parsers/rst/__init__.py:
1381 - Added "--pep-base-url" and "--rfc-base-url" options.
1383 * docutils/parsers/rst/states.py:
1385 - Made URI recognition more aggressive and intelligent.
1387 * docutils/parsers/rst/directives/__init__.py:
1389 - Added several directive option conversion functions.
1391 * docutils/parsers/rst/directives/body.py:
1393 - Moved "table" directive to tables.py.
1395 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1398 * docutils/writers/latex2e.py:
1400 - Added "--table-style=(standard|booktabs|nolines)"
1401 - figures get "here" option (LaTeX per default puts them at bottom),
1402 and figure content is centered.
1403 - Rowspan support for tables.
1404 - Fix: admonition titles before first section.
1405 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1406 - Replave ``_`` in literal by an underlined blank, because it has the correct
1408 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1409 - A few unicode replacements, if output_encoding != utf
1410 - Add "--graphicx-option".
1411 - Indent literal-blocks.
1412 - Fix: omit ``\maketitle`` when there is no document title.
1414 * docs/index.txt: "Docutils Project Documentation Overview", added to
1417 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1418 Tool", added to project.
1420 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1422 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1424 * docs/dev/policies.txt: Added to project (extracted from
1425 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1427 * docs/dev/release.txt: Added to project (extracted from
1428 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1430 * docs/dev/testing.txt: Added to project.
1432 * docs/dev/website.txt: Added to project (extracted from
1433 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1435 * docs/ref/rst/directives.txt:
1437 - Added directives: "table", "csv-table".
1439 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1440 added to project. 1 page for syntax, and a 1 page reference for
1441 directives and roles. Source text to be used as-is; not meant to be
1444 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1445 with a change of title.
1447 * test/functional/, contents, and test/test_functional.py: Added to
1450 * tools/buildhtml.py: Fixed bug with config file handling.
1452 * tools/html.py: Removed from project (duplicate of rst2html.py).
1454 * tools/pep2html.py: Removed from project (duplicate of Python's
1455 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1456 Docutils-related PEPs in docs/peps/).
1458 * tools/rst2pseudoxml.py: Renamed from publish.py.
1460 * tools/rst2xml.py: Renamed from docutils-xml.py.
1462 * tools/test.txt: Removed from project; moved to
1463 docs/user/rst/demo.txt.
1465 * setup.py: Now also installs ``rst2latex.py``.
1468 Release 0.3.3 (2004-05-09)
1469 ==========================
1471 * docutils/__init__.py:
1473 - 0.3.1: Reorganized config file format (multiple sections); see
1475 - Added unknown_reference_resolvers attribute to TransformSpec.
1476 - 0.3.2: Interpreted text reorganization.
1481 - Catch system messages to stop tracebacks from parsing errors.
1482 - Catch exceptions during processing report & exit without
1483 tracebacks, except when "--traceback" used.
1484 - Reordered components for OptionParser; application comes last.
1485 - Added "config_section" parameter to several methods and functions,
1486 allowing front ends to easily specify their config file sections.
1487 - Added publish_parts convenience function to allow access to individual
1488 parts of a document.
1490 * docutils/examples.py: Added to project; practical examples of
1491 Docutils client code, to be used as-is or as models for variations.
1493 * docutils/frontend.py:
1495 - Added "--traceback" & "--no-traceback" options ("traceback"
1497 - Implemented support for config file reorganization:
1498 ``standard_config_files`` moved from ``ConfigParser`` to
1499 ``OptionParser``; added
1500 ``OptionParser.get_config_file_settings()`` and
1501 ``.get_standard_config_settings()``; support for old "[options]"
1502 section (with deprecation warning) and mapping from old to new
1504 - Reimplemented setting validation.
1505 - Enabled flexible boolean values: yes/no, true/false, on/off.
1506 - Added ``Values``, a subclass of ``optparse.Values``, with support
1507 for list setting attributes.
1508 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1509 thanks to Beni Cherniavsky.
1510 - Added "--no-section-numbering" option.
1514 - Catch IOErrors when opening source & destination files, report &
1515 exit without tracebacks. Added ``handle_io_errors`` parameter to
1516 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1518 * docutils/nodes.py:
1520 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1521 method definitions (via ``exec``) to dynamic assignments (via
1522 ``setattr``); thanks to Roman Suzi.
1523 - Encapsulated visitor dynamic assignments in a function; thanks to
1525 - Added indirect_reference_name attribute to the Targetable
1526 class. This attribute holds the whitespace_normalized_name
1527 (contains mixed case) of a target.
1529 * docutils/statemachine.py:
1531 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1532 - Added ``StringList.get_2D_block``.
1534 * docutils/utils.py:
1536 - Added "level" attribute to SystemMessage exceptions.
1538 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1541 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1544 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1545 Marcelo Huerta San Martin.
1547 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1548 mappings by Lalo Martins.
1550 * docutils/languages/ru.py: Added to project; Russian mappings by
1553 * docutils/parsers/rst/roles.py: Added to project. Contains
1554 interpreted text role functions, a registry for interpreted text
1555 roles, and an API for adding to and retrieving from the registry.
1556 Contributed by Edward Loper.
1558 * docutils/parsers/rst/states.py:
1560 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1561 - Allowed true em-dash character and "---" as block quote
1563 - Added support for <angle-bracketed> complex option arguments
1565 - Fixed handling of backslashes in substitution definitions.
1566 - Fixed off-by-1 error with extra whitespace after substitution
1567 definition directive.
1568 - Added inline markup parsing to field lists' field names.
1569 - Added support for quoted (and unindented) literal blocks.
1570 Driven in part by a bribe from Frank Siebenlist (thanks!).
1571 - Parser now handles escapes in URIs correctly.
1572 - Made embedded-URIs' reference text omittable. Idea from Beni
1574 - Refactored explicit target processing code.
1575 - Added name attribute to references containing the reference name only
1576 through whitespace_normalize_name (no case changes).
1577 - parse_target no longer returns the refname after going through
1578 normalize_name. This is now handled in make_target.
1579 - Fixed bug relating to role-less interpreted text in non-English
1581 - Reorganized interpreted text processing; moved code into the new
1582 roles.py module. Contributed by Edward Loper.
1583 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1584 ``parse_directive_block``.
1586 * docutils/parsers/rst/tableparser.py:
1588 - Reworked for ``StringList``, to support "include" directives in
1591 * docutils/parsers/rst/directives/__init__.py:
1593 - Renamed ``unchanged()`` directive option conversion function to
1594 ``unchanged_required``, and added a new ``unchanged``.
1595 - Catch unicode value too high error; fixes bug 781766.
1596 - Beefed up directive error reporting.
1598 * docutils/parsers/rst/directives/body.py:
1600 - Added basic "table" directive.
1602 * docutils/parsers/rst/directives/images.py:
1604 - Added "target" option to "image" directive.
1605 - Added name attribute to references containing the reference name only
1606 through whitespace_normalize_name (no case changes).
1608 * docutils/parsers/rst/directives/misc.py:
1610 - Isolated the import of the ``urllib2`` module; was causing
1611 problems on SourceForge (``libssl.so.2`` unavailable?).
1612 - Added the "role" directive for declaring custom interpreted text
1615 * docutils/parsers/rst/directives/parts.py:
1617 - The "contents" directive does more work up-front, creating the
1618 "topic" and "title", and leaving the "pending" node for the
1619 transform. Allows earlier reference resolution; fixes subtle bug.
1621 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1622 mappings by Jannie Hofmeyr.
1624 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1625 mappings by Marek Blaha.
1627 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1628 mappings by Marcelo Huerta San Martin.
1630 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1631 Portuguese mappings by Lalo Martins.
1633 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1634 mappings by Roman Suzi.
1636 * docutils/transforms/parts.py:
1638 - The "contents" directive does more work up-front, creating the
1639 "topic" and "title", and leaving the "pending" node for the
1640 transform. Allows earlier reference resolution; fixes subtle bug.
1641 - Added support for disabling of section numbering.
1643 * docutils/transforms/references.py:
1645 - Verifying that external targets are truly targets and not indirect
1646 references. This is because we are now adding a "name" attribute to
1647 references in addition to targets. Note sure if this is correct!
1648 - Added code to hook into the unknown_reference_resolvers list for a
1649 transformer in resolve_indirect_target. This allows the
1650 unknown_reference_resolvers to keep around indirect targets which
1651 docutils doesn't know about.
1652 - Added specific error message for duplicate targets.
1654 * docutils/transforms/universal.py:
1656 - Added FilterMessages transform (removes system messages below the
1657 verbosity threshold).
1658 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1659 to FinalCheckVisitor for application-specific handling of
1660 unresolvable references.
1661 - Added specific error message for duplicate targets.
1663 * docutils/writers/__init__.py:
1665 - Added assemble_parts method to the Writer class to allow for
1666 access to a documents individual parts.
1667 - Documented & set default for ``Writer.output`` attribute.
1669 * docutils/writers/html4css1.py:
1671 - Fixed unicode handling of attribute values (bug 760673).
1672 - Prevent duplication of "class" attribute values (bug report from
1674 - Improved table grid/border handling (prompted by report from Bob
1676 - Added support for table titles.
1677 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1679 - Added functionality to keep track of individual parts of a document
1680 and store them in a dictionary as the "parts" attribute of the writer.
1681 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1682 - Added proper support for the "scale" attribute of the "image"
1683 element. Contributed by Brent Cook.
1684 - Added ``--initial-header-level`` option.
1685 - Fixed bug: the body_pre_docinfo segment depended on there being a
1686 docinfo; if no docinfo, the document title was incorporated into
1687 the body segment. Adversely affected the publish_parts interface.
1689 * docutils/writers/latex2e.py:
1691 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1692 about a missing file.
1693 - Added options and support: ``--compound-enumerators``,
1694 ``--section-prefix-for-enumerators``, and
1695 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1697 - Added option ``--use-verbatim-when-possible``, to avoid
1698 problematic characters (eg, '~' in italian) in literal blocks.
1699 - It's now possible to use four section levels in the `book` and
1700 `report` LaTeX classes. The default `article` class still has
1703 * docs/config.txt: "Docutils Configuration Files", added to project.
1704 Moved config file entry descriptions from tools.txt.
1708 - Moved config file entry descriptions to config.txt.
1710 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1713 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1714 Text Roles", added to project.
1716 * spec/rst/reStructuredText.txt:
1718 - Added description of support for <angle-bracketed> complex option
1719 arguments to option lists.
1720 - Added subsections for indented and quoted literal blocks.
1722 * test: Continually adding & updating tests.
1724 - Added test/test_settings.py & test/data/config_*.txt support
1726 - Added test/test_writers/test_htmlfragment.py.
1728 * test/DocutilsTestSupport.py:
1730 - Refactored LaTeX publisher test suite/case class names to make
1731 testing other writers easier.
1732 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1733 to test the processing of HTML fragments which use the new
1734 publish_parts convenience function.
1736 * tools/buildhtml.py:
1738 - Added support for the "--prune" option.
1739 - Removed dependency on pep2html.py; plaintext PEPs no longer
1742 * tools/docutils.conf:
1744 - Updated for configuration file reorganization.
1746 * tools/rst2html.py:
1748 - copied from tools/html.py
1752 - added a 'scripts' section to configuration
1753 - added 'tools/rst2html.py' to the scripts section
1756 Release 0.3 (2003-06-24)
1757 ========================
1761 * Renamed "attribute" to "option" for directives/extensions.
1763 * Renamed transform method "transform" to "apply".
1765 * Renamed "options" to "settings" for runtime settings (as set by
1766 command-line options). Sometimes "option" (singular) became
1767 "settings" (plural). Some variations below:
1769 - document.options -> document.settings (stored in other objects as
1771 - option_spec -> settings_spec (not directives though)
1772 - OptionSpec -> SettingsSpec
1773 - cmdline_options -> settings_spec
1774 - relative_path_options -> relative_path_settings
1775 - option_default_overrides -> settings_default_overrides
1776 - Publisher.set_options -> Publisher.get_settings
1780 * COPYING.txt: Added "Public Domain Dedication".
1782 * FAQ.txt: Frequently asked questions, added to project.
1786 - Updated with PyPI Trove classifiers.
1787 - Conditional installation of third-party modules.
1789 * docutils/__init__.py:
1791 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1792 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1793 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1794 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1795 option and its effect on the PEP template & writer.
1796 - Bumped version to 0.2.4 due to changes to the PEP template &
1798 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1799 - Added ``TransformSpec`` class for new transform system.
1800 - Bumped version to 0.2.6 for API changes (renaming).
1801 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1802 convenience functions.
1803 - Added ``Component.component_type`` attribute.
1804 - Bumped version to 0.2.8 because of the internal parser switch from
1805 plain lists to the docutils.statemachine.StringList objects.
1806 - Bumped version to 0.2.9 because of the frontend.py API changes.
1807 - Bumped version to 0.2.10 due to changes to the project layout
1808 (third-party modules removed from the "docutils" package), and
1809 signature changes in ``io.Input``/``io.Output``.
1810 - Changed version to 0.3.0 for release.
1814 - Made ``publish()`` a bit more convenient.
1815 - Generalized ``Publisher.set_io``.
1816 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1817 parameters; improved its docstring.
1818 - Added ``publish_file()`` and ``publish_string()``.
1819 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1821 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1822 "--dump-transforms" hidden options.
1823 - Added ``Publisher.apply_transforms()`` method.
1824 - Added ``Publisher.set_components()`` method; support for
1825 ``publish_*()`` conveninece functions.
1826 - Moved config file processing to docutils/frontend.py.
1827 - Added support for exit status ("exit_level" setting &
1828 ``enable_exit`` parameter for Publisher.publish() and convenience
1831 * docutils/frontend.py:
1833 - Check for & exit on identical source & destination paths.
1834 - Fixed bug with absolute paths & "--config".
1835 - Set non-command-line defaults in ``OptionParser.__init__()``:
1836 ``_source`` & ``_destination``.
1837 - Distributed ``relative_path_settings`` to components; updated
1838 ``OptionParser.populate_from_components()`` to combine it all.
1839 - Require list of keys in ``make_paths_absolute`` (was implicit in
1840 global ``relative_path_settings``).
1841 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1842 "--dump-settings", and "--dump-transforms" hidden options.
1843 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1844 code, replaced with correct code.
1845 - Added validation functionality for config files.
1846 - Added "--error-encoding" option/setting, "_disable_config"
1848 - Added encoding validation; updated "--input-encoding" and
1849 "--output-encoding"; added "--error-encoding-error-handler" and
1850 "--output-encoding-error-handler".
1851 - Moved config file processing from docutils/core.py.
1852 - Updated ``OptionParser.populate_from_components`` to handle new
1853 ``SettingsSpec.settings_defaults`` dict.
1854 - Added support for "-" => stdin/stdout.
1855 - Added "exit_level" setting ("--exit" option).
1859 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1860 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1861 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1862 - ``FileOutput.write()`` now returns the encoded output string.
1863 - Try to get path/stream name automatically in ``FileInput`` &
1865 - Added defaults for source & destination paths.
1866 - Allow for Unicode I/O with an explicit "unicode" encoding.
1867 - Added ``Output.encode()``.
1868 - Removed dependency on runtime settings; pass encoding directly.
1869 - Recognize Unicode strings in ``Input.decode()``.
1870 - Added support for output encoding error handlers.
1872 * docutils/nodes.py:
1874 - Added "Invisible" element category class.
1875 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1876 modification during a traversal.
1877 - Added element classes: ``line_block``, ``generated``, ``address``,
1878 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1879 ``superscript``, ``subscript``, ``inline``
1880 - Added support for lists of nodes to ``Element.insert()``.
1881 - Fixed parent linking in ``Element.replace()``.
1882 - Added new abstract superclass ``FixedTextElement``; adds
1883 "xml:space" attribute.
1884 - Added support for "line" attribute of ``system_message`` nodes.
1885 - Added support for the observer pattern from ``utils.Reporter``.
1886 Added ``parse_messages`` and ``transform_messages`` attributes to
1887 ``document``, removed ``messages``. Added ``note_parse_message``
1888 and ``note_transform_message`` methods.
1889 - Added support for improved diagnostics:
1891 - Added "document", "source", and "line" internal attributes to
1892 ``Node``, set by ``Node.setup_child()``.
1893 - Converted variations on ``node.parent = self`` to
1894 ``self.setup_child(node)``.
1895 - Added ``document.current_source`` & ``.current_line``
1896 attributes, and ``.note_source`` observer method.
1897 - Changed "system_message" output to GNU-Tools format.
1899 - Added a "rawsource" attribute to the ``Text`` class, for text
1900 before backslash-escape resolution.
1901 - Support for new transform system.
1902 - Reworked ``pending`` element.
1903 - Fixed XML DOM bug (SF #660611).
1904 - Removed the ``interpeted`` element class and added
1905 ``title_reference``, ``abbreviation``, ``acronym``.
1906 - Made substitutions case-sensitive-but-forgiving; moved some code
1908 - Fixed Unicode bug on element attributes (report: William Dode).
1910 * docutils/optik.py: Removed from project; replaced with
1911 extras/optparse.py and extras/textwrap.py. These will be installed
1912 only if they're not already present in the Python installation.
1914 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1915 only if it's not already present in the Python installation.
1917 * docutils/statemachine.py:
1919 - Factored out ``State.add_initial_transitions()`` so it can be
1921 - Converted whitespace-specific "blank" and "indent" transitions
1922 from special-case code to ordinary transitions: removed
1923 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1924 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1925 ``ws_initial_transitions`` attributes.
1926 - Removed ``State.match_transition()`` after merging it into
1928 - Added ``StateCorrection`` exception.
1929 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1930 (moved ``TransitionCorrection`` support there too.)
1931 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1932 ``EOFError`` instead of ``IndexError``.
1933 - Added ``State.no_match`` method.
1934 - Added support for the Observer pattern, triggered by input line
1936 - Added ``strip_top`` parameter to
1937 ``StateMachineWS.get_first_known_indented``.
1938 - Made ``context`` a parameter to ``StateMachine.run()``.
1939 - Added ``ViewList`` & ``StringList`` classes;
1940 ``extract_indented()`` becomes ``StringList.get_indented()``.
1941 - Added ``StateMachine.insert_input()``.
1942 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1943 thanks to) Fred Drake.
1945 * docutils/utils.py:
1947 - Added a ``source`` attribute to Reporter instances and
1948 ``system_message`` elements.
1949 - Added an observer pattern to ``utils.Reporter`` to keep track of
1951 - Fixed bugs in ``relative_path()``.
1952 - Added support for improved diagnostics.
1953 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1954 - Added support for encoding Reporter stderr output, and encoding
1956 - Reporter keeps track of the highest level system message yet
1959 * docutils/languages: Fixed bibliographic field language lookups.
1961 * docutils/languages/es.py: Added to project; Spanish mappings by
1962 Marcelo Huerta San Martin.
1964 * docutils/languages/fr.py: Added to project; French mappings by
1967 * docutils/languages/it.py: Added to project; Italian mappings by
1970 * docutils/languages/sk.py: Added to project; Slovak mappings by
1973 * docutils/parser/__init__.py:
1975 - Added ``Parser.finish_parse()`` method.
1977 * docutils/parser/rst/__init__.py:
1979 - Added options: "--pep-references", "--rfc-references",
1980 "--tab-width", "--trim-footnote-reference-space".
1982 * docutils/parsers/rst/states.py:
1984 - Changed "title under/overline too short" system messages from INFO
1985 to WARNING, and fixed its insertion location.
1986 - Fixed enumerated list item parsing to allow paragraphs & section
1987 titles to begin with enumerators.
1988 - Converted system messages to use the new "line" attribute.
1989 - Fixed a substitution reference edge case.
1990 - Added support for "--pep-references" and "--rfc-references"
1991 options; reworked ``Inliner`` code to make customization easier.
1992 - Removed field argument parsing.
1993 - Added support for short section title over/underlines.
1994 - Fixed "simple reference name" regexp to ignore text like
1995 "object.__method__"; not an anonymous reference.
1996 - Added support for improved diagnostics.
1997 - Reworked directive API, based on Dethe Elza's contribution. Added
1998 ``Body.parse_directive()``, ``.parse_directive_options()``,
1999 ``.parse_directive_arguments()`` methods.
2000 - Added ``ExtensionOptions`` class, to parse directive options
2001 without parsing field bodies. Factored
2002 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2003 ``ExtensionOptions``.
2004 - Improved definition list term/classifier parsing.
2005 - Added warnings for unknown directives.
2006 - Renamed ``Stuff`` to ``Struct``.
2007 - Now flagged as errors: transitions at the beginning or end of
2008 sections, empty sections (except title), and empty documents.
2009 - Updated for ``statemachine.StringList``.
2010 - Enabled recognition of schemeless email addresses in targets.
2011 - Added support for embedded URIs in hyperlink references.
2012 - Added backslash-escapes to inline markup end-string suffix.
2013 - Added support for correct interpreted text processing.
2014 - Fixed nested title parsing (topic, sidebar directives).
2015 - Added special processing of backslash-escaped whitespace (idea
2016 from David Abrahams).
2017 - Made substitutions case-sensitive-but-forgiving; moved some code
2018 to ``docutils.nodes``.
2019 - Added support for block quote attributions.
2020 - Added a kludge to work-around a conflict between the bubble-up
2021 parser strategy and short titles (<= 3 char-long over- &
2022 underlines). Fixes SF bug #738803 "infinite loop with multiple
2023 titles" submitted by Jason Diamond.
2024 - Added explicit interpreted text roles for standard inline markup:
2025 "emphasis", "strong", "literal".
2026 - Implemented "superscript" and "subscript" interpreted text roles.
2027 - Added initial support for "abbreviation" and "acronym" roles;
2029 - Added support for "--trim-footnote-reference-space" option.
2030 - Optional space before colons in directives & hyperlink targets.
2032 * docutils/parsers/rst/tableparser.py:
2034 - Fixed a bug that was producing unwanted empty rows in "simple"
2036 - Detect bad column spans in "simple" tables.
2038 * docutils/parsers/rst/directives: Updated all directive functions to
2041 * docutils/parsers/rst/directives/__init__.py:
2043 - Added ``flag()``, ``unchanged()``, ``path()``,
2044 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2045 directive option helper functions.
2046 - Added warnings for unknown directives.
2047 - Return ``None`` for missing directives.
2048 - Added ``register_directive()``, thanks to William Dode and Paul
2051 * docutils/parsers/rst/directives/admonitions.py:
2053 - Added "admonition" directive.
2055 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2056 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2057 "parsed-literal", "rubric", "epigraph", "highlights" and
2058 "pull-quote" directives.
2060 * docutils/parsers/rst/directives/images.py:
2062 - Added an "align" attribute to the "image" & "figure" directives
2063 (by Adam Chodorowski).
2064 - Added "class" option to "image", and "figclass" to "figure".
2066 * docutils/parsers/rst/directives/misc.py:
2068 - Added "include", "raw", and "replace" directives, courtesy of
2070 - Added "unicode" and "class" directives.
2072 * docutils/parsers/rst/directives/parts.py:
2074 - Added the "sectnum" directive; by Dmitry Jemerov.
2075 - Added "class" option to "contents" directive.
2077 * docutils/parsers/rst/directives/references.py: Added to project.
2078 Contains the "target-notes" directive.
2080 * docutils/parsers/rst/languages/__init__.py:
2082 - Return ``None`` from get_language() for missing language modules.
2084 * docutils/parsers/rst/languages/de.py: Added to project; German
2085 mappings by Engelbert Gruber.
2087 * docutils/parsers/rst/languages/en.py:
2089 - Added interpreted text roles mapping.
2091 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2092 mappings by Marcelo Huerta San Martin.
2094 * docutils/parsers/rst/languages/fr.py: Added to project; French
2095 mappings by William Dode.
2097 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2098 mappings by Nicola Larosa.
2100 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2101 mappings by Miroslav Vasko.
2103 * docutils/readers/__init__.py:
2105 - Added support for the observer pattern from ``utils.Reporter``, in
2106 ``Reader.parse`` and ``Reader.transform``.
2107 - Removed ``Reader.transform()`` method.
2108 - Added default parameter values to ``Reader.__init__()`` to make
2109 instantiation easier.
2110 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2112 * docutils/readers/pep.py:
2114 - Added the ``peps.TargetNotes`` transform to the Reader.
2115 - Removed PEP & RFC reference detection code; moved to
2116 parsers/rst/states.py as options (enabled here by default).
2117 - Added support for pre-acceptance PEPs (no PEP number yet).
2118 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2121 * docutils/readers/python: Python Source Reader subpackage added to
2122 project, including preliminary versions of:
2125 - moduleparser.py: Parser for Python modules.
2127 * docutils/transforms/__init__.py:
2129 - Added ``Transformer`` class and completed transform reform.
2130 - Added unknown_reference_resolvers list for each transformer. This list holds
2131 the list of functions provided by each component of the transformer that
2132 help resolve references.
2134 * docutils/transforms/frontmatter.py:
2136 - Improved support for generic fields.
2137 - Fixed bibliographic field language lookups.
2139 * docutils/transforms/misc.py: Added to project. Miscellaneous
2142 * docutils/transforms/parts.py:
2144 - Moved the "id" attribute from TOC list items to the references
2145 (``Contents.build_contents()``).
2146 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2147 - Added "class" attribute support to ``Contents``.
2149 * docutils/transforms/peps.py:
2151 - Added ``mask_email()`` function, updating to pep2html.py's
2153 - Linked "Content-Type: text/x-rst" to PEP 12.
2154 - Added the ``TargetNotes`` PEP-specific transform.
2155 - Added ``TargetNotes.cleanup_callback``.
2156 - Added title check to ``Headers``.
2158 * docutils/transforms/references.py:
2160 - Added the ``TargetNotes`` generic transform.
2161 - Split ``Hyperlinks`` into multiple transforms.
2162 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2163 - Added check for circular indirect references.
2164 - Made substitutions case-sensitive-but-forgiving.
2166 * docutils/transforms/universal.py:
2168 - Added support for the "--expose-internal-attributes" option.
2169 - Removed ``Pending`` transform classes & data.
2171 * docutils/writers/__init__.py:
2173 - Removed ``Writer.transform()`` method.
2175 * docutils/writers/docutils-xml.py:
2177 - Added XML and doctype declarations.
2178 - Added "--no-doctype" and "--no-xml-declaration" options.
2180 * docutils/writers/html4css1.py:
2182 - "name" attributes only on these tags: a, applet, form, frame,
2184 - Added "name" attribute to <a> in section titles for Netscape 4
2185 support (bug report: Pearu Peterson).
2186 - Fixed targets (names) on footnote, citation, topic title,
2187 problematic, and system_message nodes (for Netscape 4).
2188 - Changed field names from "<td>" to "<th>".
2189 - Added "@" to "@" encoding to thwart address harvesters.
2190 - Improved the vertical whitespace optimization; ignore "invisible"
2191 nodes (targets, comments, etc.).
2192 - Improved inline literals with ``<span class="pre">`` around chunks
2193 of text and `` `` for runs of spaces.
2194 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2195 ``self.docinfo`` segments.
2196 - Added support for "line_block", "address" elements.
2197 - Improved backlinks (footnotes & system_messages).
2198 - Improved system_message output.
2199 - Redefined "--stylesheet" as containing an invariant URL, used
2200 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2202 - Added "--footnote-references" option (superscript or brackets).
2203 - Added "--compact-lists" and "--no-compact-lists" options.
2204 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2205 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2206 - Improved field list rendering.
2207 - Added Docutils version to "generator" meta tag.
2208 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2209 - Improved layout of <pre> HTML source.
2210 - Fixed attribute typo on <colspec>.
2211 - Refined XML prologue.
2212 - Support for no stylesheet.
2213 - Removed "interpreted" element support.
2214 - Added support for "title_reference", "sidebar", "attribution",
2215 "rubric", and generic "admonition" elements.
2216 - Added "--attribution" option.
2217 - Added support for "inline", "subscript", "superscript" elements.
2218 - Added initial support for "abbreviation" and "acronym";
2221 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2225 - Double quotes in literal blocks (special treatment for de/ngerman).
2226 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2227 - Added "--attribution" option.
2228 - Right align attributions.
2230 * docutils/writers/pep_html.py:
2232 - Parameterized output encoding in PEP template.
2233 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2234 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2235 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2237 - Added an override on the "--footnote-references" option.
2238 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2239 - Added Docutils version to "generator" meta tag.
2240 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2244 - Added a "silent" setting for ``buildhtml.py``.
2245 - Added a "Getting Help" section.
2246 - Rearranged the structure.
2247 - Kept up to date, with new settings, command-line options etc.
2248 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2249 - Converted settings table into a definition list.
2251 * docs/rst/quickstart.txt:
2253 - Added a table of contents.
2254 - Added feedback information.
2255 - Added mention of minimum section title underline lengths.
2256 - Removed the 4-character minimum for section title underlines.
2258 * docs/rst/quickref.html:
2260 - Added a "Getting Help" section.
2261 - Added a style to make section title backlinks more subtle.
2262 - Added mention of minimum section title underline lengths.
2263 - Removed the 4-character minimum for section title underlines.
2265 * extras: Directory added to project; contains third-party modules
2266 that Docutils depends on (optparse, textwrap, roman). These are
2267 only installed if they're not already present.
2269 * licenses: Directory added to project; contains copies of license
2270 files for non-public-domain files.
2274 - Changed the focus. It's about DTD elements: structural
2275 relationships, semantics, and external (public) attributes. Not
2276 about the element class library.
2277 - Moved some implementation-specific stuff into ``docutils.nodes``
2279 - Wrote descriptions of all common attributes and parameter
2280 entities. Filled in introductory material.
2281 - Working through the element descriptions: 55 down, 37 to go.
2282 - Removed "Representation of Horizontal Rules" to
2283 spec/rst/alternatives.txt.
2285 * spec/docutils.dtd:
2287 - Added "generated" inline element.
2288 - Added "line_block" body element.
2289 - Added "auto" attribute to "title".
2290 - Changed content models of "literal_block" and "doctest_block" to
2292 - Added ``%number;`` attribute type parameter entity.
2293 - Changed ``%structural.elements;`` to ``%section.elements``.
2294 - Updated attribute types; made more specific.
2295 - Added "address" bibliographic element.
2296 - Added "line" attribute to ``system_message`` element.
2297 - Removed "field_argument" element; "field_name" may contain
2298 multiple words and whitespace.
2299 - Changed public identifier to docutils.sf.net.
2300 - Removed "interpreted" element; added "title_reference",
2301 "abbreviation", "acronym".
2302 - Removed "refuri" attribute from "footnote_reference" and
2303 "citation_reference".
2304 - Added "sidebar", "rubric", "attribution", "admonition",
2305 "superscript", "subscript", and "inline" elements.
2307 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2309 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2311 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2313 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2316 * spec/transforms.txt: Added to project.
2318 * spec/howto: Added subdirectory, for developer how-to docs.
2320 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2321 Elza, edited & extended by David Goodger.
2323 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2326 * spec/rst/alternatives.txt:
2328 - Added "Doctree Representation of Transitions" from
2330 - Updated "Inline External Targets" & closed the debate.
2331 - Added ideas for interpreted text syntax extensions.
2332 - Added "Nested Inline Markup" section.
2334 * spec/rst/directives.txt:
2336 - Added directives: "topic", "sectnum", "target-notes",
2337 "line-block", "parsed-literal", "include", "replace", "sidebar",
2338 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2340 - Formalized descriptions of directive details.
2341 - Added an "align" attribute to the "image" & "figure" directives
2342 (by Adam Chodorowski).
2343 - Added "class" options to "topic", "sidebar", "line-block",
2344 "parsed-literal", "contents", and "image"; and "figclass" to
2347 * spec/rst/interpreted.txt: Added to project. Descriptions of
2348 interpreted text roles.
2350 * spec/rst/introduction.txt:
2352 - Added pointers to material for new users.
2354 * spec/rst/reStructuredText.txt:
2356 - Disambiguated comments (just add a newline after the "::").
2357 - Updated enumerated list description; added a discussion of the
2358 second-line validity checking.
2359 - Updated directive description.
2360 - Added a note redirecting newbies to the user docs.
2361 - Expanded description of inline markup start-strings in non-markup
2363 - Removed field arguments and made field lists a generic construct.
2364 - Removed the 4-character minimum for section title underlines.
2365 - Clarified term/classifier delimiter & inline markup ambiguity
2367 - Added "Embedded URIs".
2368 - Updated "Interpreted Text" section.
2369 - Added "Character-Level Inline Markup" section.
2371 * test: Continually adding & updating tests.
2373 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2374 - Moved test/test_pep/ to test/test_readers/test_pep/.
2375 - Added test/test_readers/test_python/.
2376 - Added test/test_writers/ (Engelbert Gruber).
2380 - Made the ``locale.setlocale()`` calls in front ends
2383 * tools/buildhtml.py:
2385 - Added "--silent" option.
2386 - Fixed bug with absolute paths & "--config".
2387 - Updated for new I/O classes.
2388 - Added some exception handling.
2389 - Separated publishers' setting defaults; prevents interference.
2390 - Updated for new ``publish_file()`` convenience function.
2392 * tools/pep-html-template:
2394 - Allow for "--embed-stylesheet".
2395 - Added Docutils version to "generator" meta tag.
2396 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2397 - Conform to XHTML spec.
2399 * tools/pep2html.py:
2401 - Made ``argv`` a parameter to ``main()``.
2402 - Added support for "Content-Type:" header & arbitrary PEP formats.
2403 - Linked "Content-Type: text/plain" to PEP 9.
2404 - Files skipped (due to an error) are not pushed onto the server.
2405 - Updated for new I/O classes.
2406 - Added ``check_requirements()`` & ``pep_type_error()``.
2407 - Added some exception handling.
2408 - Updated for new ``publish_string()`` convenience function.
2409 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2411 * tools/quicktest.py:
2413 - Added "-V"/"--version" option.
2415 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2417 * tools/unicode2rstsubs.py: Added to project. Produces character
2418 entity files (reSructuredText substitutions) from the MathML master
2421 * tools/editors: Support code for editors, added to project. Contains
2422 ``emacs/restructuredtext.el``.
2424 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2426 - Added style for chunks of inline literals.
2427 - Removed margin for first child of table cells.
2428 - Right-aligned field list names.
2429 - Support for auto-numbered section titles in TOCs.
2430 - Increased the size of inline literals (<tt>) in titles.
2431 - Restored the light gray background for inline literals.
2432 - Added support for "line_block" elements.
2433 - Added style for "address" elements.
2434 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2435 - Improved field list rendering.
2436 - Vertical whitespace improvements.
2437 - Removed "a.target" style.
2439 * tools/stylesheets/pep.css:
2441 - Fixed nested section margins.
2442 - Other changes parallel those of ``../default.css``.
2445 Release 0.2 (2002-07-31)
2446 ========================
2450 - The word "component" was being used ambiguously. From now on,
2451 "component" will be used to mean "Docutils component", as in Reader,
2452 Writer, Parser, or Transform. Portions of documents (Table of
2453 Contents, sections, etc.) will be called "document parts".
2454 - Did a grand renaming: a lot of ``verylongnames`` became
2455 ``very_long_names``.
2456 - Cleaned up imports: no more relative package imports or
2457 comma-separated lists of top-level modules.
2458 - Added support for an option values object which carries default
2459 settings and overrides (from command-line options and library use).
2460 - Added internal Unicode support, and support for both input and
2462 - Added support for the ``docutils.io.IO`` class & subclasses.
2466 * docutils/__init__.py:
2468 - Added ``ApplicationError`` and ``DataError``, for use throughout
2470 - Added ``Component`` base class for Docutils components; implements
2471 the ``supports`` method.
2472 - Added ``__version__`` (thus, ``docutils.__version__``).
2476 - Removed many keyword parameters to ``Publisher.__init__()`` and
2477 ``publish()``; bundled into an option values object. Added
2478 "argv", "usage", "description", and "option_spec" parameters for
2479 command-line support.
2480 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2482 - Reworked I/O model for ``docutils.io`` wrappers.
2483 - Updated ``Publisher.set_options()``; now returns option values
2485 - Added support for configuration files (/etc/docutils.conf,
2486 ./docutils.conf, ~/.docutils).
2487 - Added ``Publisher.setup_option_parser()``.
2488 - Added default usage message and description.
2490 * docutils/frontend.py: Added to project; support for front-end
2491 (command-line) scripts. Option specifications may be augmented by
2492 components. Requires Optik (http://optik.sf.net/) for option
2493 processing (installed locally as docutils/optik.py).
2495 * docutils/io.py: Added to project; uniform API for a variety of input
2498 * docutils/nodes.py:
2500 - Added ``TreeCopyVisitor`` class.
2501 - Added a ``copy`` method to ``Node`` and subclasses.
2502 - Added a ``SkipDeparture`` exception for visitors.
2503 - Renamed ``TreePruningException`` from ``VisitorException``.
2504 - Added docstrings to ``TreePruningException``, subclasses, and
2506 - Improved docstrings.
2507 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2508 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2510 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2511 ``PreDecorative`` mixin.
2512 - Reworked the name/id bookkeeping; to ``document``, removed
2513 ``explicit_targets`` and ``implicit_targets`` attributes, added
2514 ``nametypes`` attribute and ``set_name_id_map`` method.
2515 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2517 - Added ``document.has_name()`` method.
2518 - Fixed DOM generation for list-attributes.
2519 - Added category class ``Labeled`` (used by footnotes & citations).
2520 - Added ``Element.set_class()`` method (sets "class" attribute).
2522 * docutils/optik.py: Added to project. Combined from the Optik
2523 package, with added option groups and other modifications. The use
2524 of this module is probably only temporary.
2526 * docutils/statemachine.py:
2528 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2529 - Added underscores to improve many awkward names.
2530 - In ``string2lines()``, changed whitespace normalizing translation
2531 table to regexp; restores Python 2.0 compatibility with Unicode.
2533 * docutils/urischemes.py:
2535 - Filled in some descriptions.
2536 - Added "shttp" scheme.
2538 * docutils/utils.py:
2540 - Added ``clean_rcs_keywords`` function (moved from
2541 docutils/transforms/frontmatter.py
2542 ``DocInfo.filter_rcs_keywords``).
2543 - Added underscores to improve many awkward names.
2544 - Changed names of Reporter's thresholds:
2545 warning_level -> report_level; error_level -> halt_level.
2546 - Moved ``utils.id()`` to ``nodes.make_id()``.
2547 - Added ``relative_path(source, target)``.
2549 * docutils/languages/de.py: German mappings; added to project. Thanks
2550 to Gunnar Schwant for the translations.
2552 * docutils/languages/en.py: Added "Dedication" bibliographic field
2555 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2558 * docutils/parsers/rst/states.py:
2560 - Added underscores to improve many awkward names.
2561 - Added RFC-2822 header support.
2562 - Extracted the inline parsing code from ``RSTState`` to a separate
2563 class, ``Inliner``, which will allow easy subclassing.
2564 - Made local bindings for ``memo`` container & often-used contents
2565 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2566 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2567 - Added ``MarkupMismatch`` exception; for late corrections.
2568 - Added ``-/:`` characters to inline markup's start string prefix,
2569 ``/`` to end string suffix.
2570 - Fixed a footnote bug.
2571 - Fixed a bug with literal blocks.
2572 - Applied patch from Simon Budig: simplified regexps with symbolic
2573 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2574 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2575 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2576 - Allowed non-ASCII in "simple names" (directive names, field names,
2578 - Converted ``Inliner.patterns.initial`` to be dynamically built
2579 from parts with ``build_regexp()`` function.
2580 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2581 - Updated docstrings.
2582 - Changed "table" to "grid_table"; added "simple_table" support.
2584 * docutils/parsers/rst/tableparser.py:
2586 - Changed ``TableParser`` to ``GridTableParser``.
2587 - Added ``SimpleTableParser``.
2588 - Refactored naming.
2590 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2591 a fallback language for directive names.
2593 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2594 directive to use a ``pending`` element, used only by HTML writers.
2596 * docutils/parsers/rst/directives/parts.py: Renamed from
2599 - Added "backlinks" attribute to "contents" directive.
2601 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2602 project by Adam Chodorowski.
2604 * docutils/readers/__init__.py: Gave Readers more control over
2605 choosing and instantiating Parsers.
2607 * docutils/readers/pep.py: Added to project; for PEP processing.
2609 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2610 requires a ``component`` parameter.
2612 * docutils/transforms/components.py: Added to project; transforms
2613 related to Docutils components.
2615 * docutils/transforms/frontmatter.py:
2617 - In ``DocInfo.extract_authors``, check for a single "author" in an
2618 "authors" group, and convert it to a single "author" element.
2619 - Added support for "Dedication" and generic bibliographic fields.
2621 * docutils/transforms/peps.py: Added to project; PEP-specific.
2623 * docutils/transforms/parts.py: Renamed from old components.py.
2625 - Added filter for `Contents`, to use alt-text for inline images,
2626 and to remove inline markup that doesn't make sense in the ToC.
2627 - Added "name" attribute to TOC topic depending on its title.
2628 - Added support for optional TOC backlinks.
2630 * docutils/transforms/references.py: Fixed indirect target resolution
2631 in ``Hyperlinks`` transform.
2633 * docutils/transforms/universal.py:
2635 - Changed ``Messages`` transform to properly filter out system
2636 messages below the warning threshold.
2637 - Added ``Decorations`` transform (support for ``--generator``,
2638 ``--date``, ``--time``, ``--source-link`` options).
2640 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2641 Engelbert Gruber's PDF writer.
2643 * docutils/writers/html4css1.py:
2645 - Made XHTML-compatible (switched to lowercase element & attribute
2646 names; empty tag format).
2647 - Escape double-dashes in comment text.
2648 - Improved boilerplate & modularity of output.
2649 - Exposed modular output in Writer class.
2650 - Added a "generator" meta tag to <head>.
2651 - Added support for the ``--stylesheet`` option.
2652 - Added support for ``decoration``, ``header``, and ``footer``
2654 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2655 translation table to regexp; restores Python 2.0 compatibility
2657 - Added the translator class as instance variable to the Writer, to
2658 make it easily subclassable.
2659 - Improved option list spacing (thanks to Richard Jones).
2660 - Modified field list output.
2661 - Added backlinks to footnotes & citations.
2662 - Added percentage widths to "<col>" tags (from colspec).
2663 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2664 "<span>" changed to "<var>".
2665 - Inline literals: "<code>" changed to "<tt>".
2666 - Many changes to optimize vertical space: compact simple lists etc.
2667 - Add a command-line options & directive attributes to control TOC
2668 and footnote/citation backlinks.
2669 - Added support for optional footnote/citation backlinks.
2670 - Added support for generic bibliographic fields.
2671 - Identify backrefs.
2672 - Relative URLs for stylesheet links.
2674 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2675 PEPs (subclass of ``html4css1.Writer``).
2677 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2679 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2680 of the Docutils internal doctree in XML.
2682 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2686 - Changed the title to "The Docutils Document Tree".
2687 - Added "Hyperlink Bookkeeping" section.
2689 * spec/docutils.dtd:
2691 - Added ``decoration``, ``header``, and ``footer`` elements.
2692 - Brought ``interpreted`` element in line with the parser: changed
2693 attribute "type" to "role", added "position".
2694 - Added support for generic bibliographic fields.
2696 * spec/notes.txt: Continual updates. Added "Project Policies".
2698 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2701 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2703 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2704 mailing list discussions.
2706 * spec/pep-0287.txt:
2708 - Renamed to "reStructuredText Docstring Format".
2710 - Reworked Q&A as an enumerated list.
2711 - Converted to reStructuredText format.
2713 * spec/pysource.dtd:
2715 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2717 * spec/pysource.txt: Removed from project. Moved much of its contents
2720 * spec/rst/alternatives.txt:
2722 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2723 - Added "Inline External Targets" section.
2725 * spec/rst/directives.txt:
2727 - Added "backlinks" attribute to "contents" directive.
2729 * spec/rst/problems.txt:
2731 - Updated the Enumerated List Markup discussion.
2732 - Added new alternative table markup syntaxes.
2734 * spec/rst/reStructuredText.txt:
2736 - Clarified field list usage.
2737 - Updated enumerated list description.
2738 - Clarified purpose of directives.
2739 - Added ``-/:`` characters to inline markup's start string prefix,
2740 ``/`` to end string suffix.
2741 - Updated "Authors" bibliographic field behavior.
2742 - Changed "inline hyperlink targets" to "inline internal targets".
2743 - Added "simple table" syntax to supplement the existing but
2744 newly-renamed "grid tables".
2745 - Added cautions for anonymous hyperlink use.
2746 - Added "Dedication" and generic bibliographic fields.
2748 * test: Made test modules standalone (subdirectories became packages).
2750 * test/DocutilsTestSupport.py:
2752 - Added support for PEP extensions to reStructuredText.
2753 - Added support for simple tables.
2754 - Refactored naming.
2756 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2758 - Now supports true packages containing test modules
2759 (``__init__.py`` files required); fixes duplicate module name bug.
2761 * test/test_pep/: Subpackage added to project; PEP testing.
2763 * test/test_rst/test_SimpleTableParser.py: Added to project.
2767 - Updated html.py and publish.py front-end tools to use the new
2768 command-line processing facilities of ``docutils.frontend``
2769 (exposed in ``docutils.core.Publisher``), reducing each to just a
2771 - Added ``locale.setlocale()`` calls to front-end tools.
2773 * tools/buildhtml.py: Added to project; batch-generates .html from all
2774 the .txt files in directories and subdirectories.
2776 * tools/default.css:
2778 - Added support for ``header`` and ``footer`` elements.
2779 - Added styles for "Dedication" topics (biblio fields).
2781 * tools/docutils.conf: A configuration file; added to project.
2783 * tools/docutils-xml.py: Added to project.
2785 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2787 * tools/pep-html-template: Added to project.
2789 * tools/pep2html.py: Added to project from Python (nondist/peps).
2790 Added support for Docutils (reStructuredText PEPs).
2792 * tools/quicktest.py:
2794 - Added the ``--attributes`` option, hacked a bit.
2795 - Added a second command-line argument (output file); cleaned up.
2797 * tools/stylesheets/: Subdirectory added to project.
2799 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2802 Release 0.1 (2002-04-20)
2803 ========================
2805 This is the first release of Docutils, merged from the now inactive
2806 reStructuredText__ and `Docstring Processing System`__ projects. For
2807 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2808 `DPS HISTORY`__ files.
2810 __ http://structuredtext.sourceforge.net/
2811 __ http://docstring.sourceforge.net/
2812 __ http://structuredtext.sourceforge.net/HISTORY.html
2813 __ http://docstring.sourceforge.net/HISTORY.html
2815 General changes: renamed 'dps' package to 'docutils'; renamed
2816 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2817 the test suites (reStructuredText's test/test_states renamed to
2818 test/test_rst); and all modifications required to make it all work.
2820 * docutils/parsers/rst/states.py:
2822 - Improved diagnostic system messages for missing blank lines.
2823 - Fixed substitution_reference bug.
2829 indent-tabs-mode: nil
2830 sentence-end-double-space: t