1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
21 - Fix [ 253 ] Attribute key without value not allowed in XML.
23 * docutils/parsers/rst/__init__.py
25 - Fix [ 233 ] Change the base URL for the :rfc: role.
27 * docutils/parsers/rst/directives/tables.py
29 - Patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
32 *docutils/parsers/rst/tableparser.py
34 - Really fix [ 159 ] Spurious table column alignment errors.
36 * docutils/transforms/frontmatter.py
38 - Add name of generic bibliographic fields as a "classes" attribute value
39 (after conversion to a valid identifier form).
41 * docutils/utils/math/math2html.py
43 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
44 - New upstream version (additional macros, piecewise integrals and sums).
46 * docutils/writers/html_plain/
48 - New HTML writer generating clean, polyglot_ markup conforming to
49 `HTML 5`_ and compatible with `XHTML 1.0`_ Transitional.
51 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
52 and recommended layout rules.
54 * docutils/writers/html4css1/__init__.py
56 - Add "docutils" to class values for "container" object to address [ 267 ].
57 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
58 ``default_stylesheet_path`` and ``default_template_path``.
59 - Fix [ 266 ] creating labels/class values in description list items.
60 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
61 - Fix footnotes with content that does not start with a paragraph.
63 * docutils/writers/latex2e/__init__.py
65 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
66 admonitions and docinfo.
68 - Use absolute path for ``default_template_path``.
70 - Removed deprecated options ``--use-latex-footnotes`` and
71 ``--figure-footnotes``.
73 - Cleaner LaTeX code for enumerations and literal blocks.
75 - Use "hyperref" package together with "bookmark" (improved hyperlinking
78 * docutils/writers/odf_odt/__init__.py
80 - remove decode.encode of filename stored in zip.
82 * docutils/writers/xetex/__init__.py
84 - LuaLaTex compatibility: do not load "xunicode".
88 - New front-end ``rst2html5.py``.
92 - Test py26, py27, py33 and py34.
94 To use, install the ``tox`` package via pip or easy_install and use
95 tox from the project root directory.
97 .. _polyglot: http://www.w3.org/TR/html-polyglot/
98 .. _HTML 5: http://www.w3.org/TR/html5/
99 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
102 Release 0.12 (2014-07-06)
103 =========================
105 * docs/ref/rst/directives.txt
107 - Update "math" and "csv-table" descriptions.
109 * docutils/parsers/rst/directives/images.py
111 - Fix [ 258 ] figwidth="image" generates unitless width value.
113 * docutils/parsers/rst/states.py
115 - Improve error report when a non-ASCII character is specified as
116 delimiter, quote or escape character under Python 2.
117 Fixes [ 249 ] and [ 250 ].
119 * docutils/writers/html4css1/__init__.py
121 - Don't add newline after inline math.
122 Thanks to Yury G. Kudryashov for the patch.
124 * docutils/writers/latex2e/__init__.py
126 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
127 - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
129 * docutils/writers/odf_odt/__init__.py
131 - Apply patch by Jakub Wilk to fix bug [ 100 ].
133 * test/test_error_reporting.py
135 - Fix [ 223 ] by removing redundant tests we do not have control over.
139 - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
141 Release 0.11 (2013-07-22)
142 =========================
146 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
147 - Support embedded aliases within hyperlink references.
148 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
149 language module) before global search.
153 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
155 * docutils/parsers/rst/directives/__init__.py
157 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
159 * docutils/parsers/rst/directives/images.py
161 - Apply [ 3599485 ] node source/line information for sphinx translation.
163 * docutils/parsers/rst/directives/tables.py
165 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
167 * docutils/parsers/rst/states.py
169 - Fix [ 157 ] Line block parsing doesn't like system message.
170 - Always import our local copy of roman.py (report Larry Hastings).
172 * docutils/transforms/references.py
174 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
176 * docutils/utils/__init__.py
178 - Fix [ 3596884 ] exception importing ``docutils.io``.
180 * docutils/writers/html4css1/__init__.py
182 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
183 - New setting `stylesheet_dirs`: Comma-separated list of directories
184 where stylesheets are found. Used by `stylesheet_path` when expanding
185 relative path arguments.
186 - New default for math-output_: ``HTML math.css``.
187 - Avoid repeated class declarations in html4css1 writer
188 (modified version of patch [ 104 ]).
190 .. _math-output: docs/user/config.html#math-output
192 * docutils/writers/latex2e/__init__.py
194 - Drop the simple algorithm replacing straight double quotes with
195 English typographic ones.
196 Activate the SmartQuotes_ transform if you want this feature.
197 - Fix literal use of babel shorthands (straight quote, tilde, ...).
198 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
199 - New setting `stylesheet_dirs`.
201 .. _SmartQuotes: docs/user/config.html#smart-quotes
203 * docutils/writers/manpage.py
205 - Fix [3607063] handle lines starting with a period.
206 - Fix option separating comma was bold (thanks to Bill Morris).
208 Release 0.10 (2012-12-16)
209 =========================
213 - Dropped support for Python 2.3.
214 - ``docutils/math``, ``docutils/error_reporting.py``, and
215 ``docutils/urischemes.py`` moved to the utils package.
216 - Fix [3541369] Relative __import__ also with Python 3.3.
217 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
218 and parsers for Python 2.7 up.
219 - Fix import of PIL.Image.
220 - Change default of "syntax highlight" option to "long",
221 basic syntax highlight styles for LaTeX and HTML.
225 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
226 option is ignored and will be removed in a future release.
227 - Fix Py3k error writing to stdout with encoding differing from default.
228 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
230 * docutils/parsers/rst/directives/misc.py
232 - Fix [ 3546533 ] Unicode error with `date` directive.
234 * docutils/transforms/universal.py
236 - SmartQuotes transform for typographic quotes and dashes.
238 * docutils/utils/__init__.py
240 - normalize_language_tag() now returns `BCP 47`_ conformant tags
241 with subtags separated by ``-``.
243 * docutils/writers/html4css1/__init__.py
245 - Use ``<code>`` tag for inline "code",
246 do not drop nested inline nodes (syntax highlight tokens).
247 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
248 - No line break after opening inline math tag.
250 * docutils/writers/manpage.py
252 - Apply [ 3527401 ] addmonition's don't preserve indentation
253 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
255 * docutils/writers/xetex/__init__.py
257 - Apply [ 3555160 ] ensure order of "otherlanguages".
258 - Fix section numbering by LaTeX.
260 * docutils/writers/s5_html/__init__.py
262 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
264 * docutils/writers/s5_html/docutils_xml.py
266 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
270 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
272 * tools/test/test_buildhtml.py
274 - Fix [ 3521167 ] allow running in any directory.
275 - Fix [ 3521168 ] allow running with Python 3.
278 Release 0.9.1 (2012-06-17)
279 ==========================
283 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
284 installed in the PYTHONPATH. Converted tests are now
285 stored in ``test3/``, tools no longer need conversion.
287 If you installed one of Docutils versions 0.7 ... 0.9 with
288 ``setup.py install`` under Python 3, remove the spurious
289 ``test/`` and ``tools/`` directories in the site library root.
293 - Make tests independent from the location of the ``test/`` directory.
294 - Use converted sources (from the ``build/`` directory) for tests under
299 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
303 - Fix writing binary data to sys.stdout under Python 3 (allows
304 ``rst2odt.py`` to be used with output redirection).
306 * docutils/parsers/rst/directives/misc.py
308 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
309 ``locale == C`` and 8-bit char in path argument of `include` directive.
313 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
316 Release 0.9 (2012-05-02)
317 ========================
321 - New reStructuredText "code" role and directive and "code" option
322 of the "include" directive with syntax highlighting by Pygments_.
323 - Fix parse_option_marker for option arguments containing ``=``.
324 - Fix [ 2993756 ]: import Python Imaging Library's Image module
325 via ``import PIL`` as starting with PIL 1.2,
326 "PIL lives in the PIL namespace only" (announcement__).
328 .. _Pygments: http://pygments.org/
329 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
333 - Fix [ 2971827 ] and [ 3442827 ]
334 extras/roman.py moved to docutils/utils/roman.py
336 * docutils/frontend.py
338 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
342 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
343 - `mode` argument for FileOutput avoids code replication in
345 - New exceptions InputError and OutputError for IO errors in
346 FileInput/FileOutput.
350 - No "hard" system exit on file IO errors: catch and report them in
351 `Publisher.reportException` instead. Allows handling by a calling
352 application if the configuration setting `traceback` is True.
354 * docutils/utils.py -> docutils/utils/__init__.py
356 - docutils.utils is now a package (providing a place for sub-modules)
358 .. note:: docutils/math, docutils/error_reporting.py, and
359 docutils/urischemes.py will move to the utils package in the next
360 release, too. See RELEASE-NOTES__
362 __ RELEASE-NOTES.html
364 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
365 errors recording non-ASCII filenames (fixes [ 3434355 ]).
367 - Fix relative_path() with source=None and `unicode` target.
369 * docutils/parsers/rst/states.py
371 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
372 characters and "international" quotes around inline markup.
373 - Use `field_marker` pattern to look for start of a
374 directive option block (fixes [ 3484857 ]).
376 * docutils/parsers/rst/tableparser.py
378 - Fix [ 2926161 ] for simple tables.
379 (Combining chars in grid tables still contribute to cell width.)
381 * docutils/writers/latex2e/__init__.py
383 - Support the `abbreviation` and `acronym` standard roles.
384 - Record only files required to generate the LaTeX source as dependencies.
385 - Fix handling of missing stylesheets.
386 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
387 when suppressing LaTeX section numbering.
388 - Use ``\DUtitle`` for unsupported section levels
389 - Apply [ 3512791 ] do not compare string literals with "is"
391 * docutils/writers/xetex/__init__.py
393 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
395 * docutils/writers/html4css1/__init__.py
397 - Change default for `math-output` setting to MathJax.
398 - Fix handling of missing stylesheets.
400 * docutils/writers/docutils_xml.py
402 - Use the visitor pattern with default_visit()/default_depart() methods
403 instead of minidom to facilitate special handling of selected nodes.
404 - Support raw XML (inserted as-is inside a <raw></raw> node).
406 * docutils/writers/manpage.py
408 - Do not emit comment line with trailing blank. Problematic for VCS.
410 Release 0.8.1 (2011-08-30)
411 ==========================
415 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
416 and [ 3395920 ] (correct copyright info for rst.el).
420 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
422 * docutils/writers/latex2e/__init__.py
424 - Clean up Babel language setting. Restores Sphinx compatibility.
426 Release 0.8 (2011-07-07)
427 ========================
431 - Handle language codes according to `BCP 47`_.
432 - If the specified language is not supported by Docutils,
433 warn and fall back to English.
434 - Math support: reStructuredText "math" role and directive,
435 ``math`` and ``math_block`` doctree elements.
436 - Decode command line arguments with the locale's preferred encoding
437 (to allow, e.g., ``--title=Dornröschen``).
438 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
439 - New sub-module `error_reporting`: handle encoding/decoding errors
440 when reporting exceptions.
441 - Some additions to the Docutils core are released under the 2-Clause BSD
442 license, see COPYING_ for details.
444 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
445 .. _COPYING: COPYING.html
449 - Most directives now support a "name" option that attaches a
452 - Directive content may start on the first line also when the directive
453 type accepts options.
455 * docs/dev/policies.txt:
457 - Recommend the 2-Clause BSD license
458 (http://www.spdx.org/licenses/BSD-2-Clause)
459 for code that is kept under the author's copyright.
461 * tools/buildhtml.py:
463 - Fix ``--local`` switch.
465 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
467 * docutils/writers/html4css1/__init__.py
469 - Set "lang" argument for objects with class argument
470 "language-<language tag>".
471 - New setting "math-output" with support for HTML, MathML, and LaTeX.
473 * docutils/writers/latex2e/__init__.py
475 - Fix [ 3043986 ] AttributeError using :local: with table of content.
476 - Place title data in the document preamble.
477 - Load `babel` package only if required.
478 - Update list of supported languages.
479 - New config setting "hyperref-options".
480 No hard-coded "unicode" hyperref option (clash with xetex).
481 - Set language for custom roles, paragraphs, block-quotes, and
482 line-quotes with class argument "language-<language tag>".
483 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
484 - Convert image URI to a local file path.
485 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
486 has more than one paragraph (Wolfgang Scherer).
487 - \leavevmode before longtable only when needed (prevents spurious vspace)
488 - do not advance table counter for tables without caption
490 * docutils/writers/xetex/__init__.py
492 - New writer generating LaTeX code for compiling with ``xelatex``.
494 A separate writer (inheriting from latex2e) instead of a ``--xetex``
495 option allows separate config options for XeTeX vs. LaTeX2e.
497 * docutils/writers/manpage.py
499 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
500 - Fix: vertical space cleaning for option group ``.``.
502 * tools/editors/emacs/rst.el:
504 - Fix [ 3001100 ] does not handle spaces in filenames
505 (thanks to Jakub Wilk)
509 - strip whitespace from stylesheet arguments
510 - exclude combining chars from column_width()
511 (partial fix for [ 2926161 ])
513 * docutils/parsers/rst/directives/misc.py:
515 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
520 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
521 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
523 Release 0.7 (2010-07-07)
524 ========================
528 - Fix [ 2881769 ] setup configuration.
529 - Fix [ 2788716 ] reporting problems in included files.
533 - FileInput opens files as text files with universal newline support
534 (mode "rU", configurable with the new optional argument "mode").
538 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
542 - Fix [ 2923723 ] let decode_path() tolerate path == None
544 * docutils/writers/html4css1/__init__.py
546 - Support SVG and SWF images (thanks to Stefan Rank).
547 - Generate valid XHTML for centered images with targets.
548 Use CSS classes instead of "align" tags for image alignment.
550 * docutils/writers/latex2e/__init__.py
552 - Use `transforms.writer_aux.Admonitions` to "normalize" special
554 - Use the ``\url`` command for URLs (breaks long URLs instead of
555 writing into the margin).
556 - Preserve runs of spaces in `inline literals`__.
557 - Deprecate ``figure_footnotes`` setting.
558 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
559 - New ``latex_preamble`` setting.
560 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
561 - Fix hyperlink targets (labels) for images, figures, and tables.
562 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
563 - Apply [ 2961991 ] Call hyperref with unicode option.
564 - Drop the special `output_encoding`__ default ("latin-1").
565 The Docutils wide default (usually "UTF-8") is used instead.
566 - Render inline markup in document title and subtitle.
567 - Fix numbering depth with LaTeX section numbering.
568 - Update Unicode -> LaTeX translations.
569 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
571 __ docs/ref/restructuredtext.html#inline-literals
572 __ docs/user/config.html#docutils-footnotes
573 __ docs/user/config.html#output_encoding
575 * docutils/writers/manpage.py
577 - Fix: supported attribute (thanks to peter2108).
578 - Remove trailing blanks in code (keep in sync with mercurial version).
579 - Titles level 1, that is ``.SH``, always uppercase.
580 - Apply patch from mg: literal text should be bold in man-pages.
584 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
589 - Python 3 support: copy test/ and tools/ to the build-dir
590 and convert Python sources with 2to3.
593 Release 0.6 (2009-10-11)
594 ========================
598 - Docutils is now compatible with Python versions from 2.3 up to 2.6
599 and convertible to 3.1 code.
601 + Node.__nonzero__ returns True instead of 1.
602 + use os.walk instead os.path.walk.
603 + minimize "types" module where possible.
604 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
605 + Text nodes now subclass unicode rather than UserString
606 (which is gone in python 3.0).
607 + 3.0 compatibility module docutils._compat
609 + Drop 2.2 compatibility workarounds.
610 + Drop extras/optparse.py and extras/textwrap.py
611 (stdlib modules since 2.3).
613 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
614 - Unix man page export: manpage writer moved from sandbox to Doctutils
617 - Apply [ 1719345 ] Galician translation
618 - Apply [ 1905741 ] Polish translation
619 - Apply [ 1878977 ] make_id(): deaccent characters.
620 - Apply [ 2029251 ] return nonzero when tests fail.
621 - Fix [ 1692788 ] allow UTF-8 in style sheets.
622 - Fix [ 2781629 ] support non-ASCII chars in file names.
623 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
624 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
625 - Fix [ 2821266 ] --strict option works now like --halt=info.
626 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
627 - Fix [ 1627229 ] hyperlink references in substitutions.
629 - The "newlatex" writer is orphaned.
633 - Documented Unicode characters allowed as inline markup openers,
634 closers, and delimiters.
635 - Allow units for all length specifications.
636 - Allow percent sign in "scale" argument of "figure" and "image" directives.
637 - Bugfix: The "figalign" argument of a figure now works as intended
638 (aligning the figure, not its contents).
639 - Align images with class "align-[right|center|left]"
640 (allows setting the alignment of an image in a figure).
644 - Added ``Element.__contains__`` method, for the in-operator.
646 * docutils/parsers/rst/states.py:
648 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
649 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
650 " " (non-breaking space), and "¡ ¿" openers.
652 * docutils/parsers/directives/misc.py:
654 - Added ``start-line`` and ``end-line`` options to "include"
655 directive to select a range of lines.
656 - Hard tabs in literal inclusions are replaced by spaces. This is
657 configurable via the new ``tab-width`` option of the "include" directive
658 (a negative tab-width prevents tab expansion).
662 - Add ``get_stylesheet_list`` function.
663 - Apply [ 2834836 ] print info at halt
665 * docutils/transforms/universal.py:
667 - Raise default priority of StripClasses to exclude stripped classes from
670 * docutils/writers/html4css1/__init__.py:
672 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
673 separated list of stylesheets.
674 - Address [ 1938891 ] Inline literal text creates "pre" span only when
675 needed to prevent inter-word line wraps.
676 - Use `translate` method instead of repeated `replace` calls.
677 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
678 classes to allow CSS styling that does not interfere with other
679 table-using constructs (field lists, citations, ...).
681 * docutils/writers/newlatex2e/__init__.py:
683 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
685 * docutils/writers/latex2e/__init__.py (see also
686 `<docs/user/docutils-05-compat.sty.html>`__) :
688 - Add ``--embed-stylesheet`` option.
689 - Apply [ 1474017 ] image vertical alignment is reversed.
690 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
691 - Change: has_key for dictionaries (not Nodes) to in-operator.
692 - Merge adjacent citations into one latex cite command.
693 - Failsave implementation of custom roles. LaTeX compilation now ignores
694 unknown classes instead of aborting with an error.
695 - Support custom roles based on standard roles.
696 - LaTeX packages can be used as ``--stylesheet`` arguments without
697 restriction. (A style sheet is now referenced with the ``\usepackage``
698 command, if it ends with ``.sty`` or has no extension.)
699 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
700 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
701 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
702 2005-02-04 as a configurable length unit).
703 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
704 if font-encoding is set to ''. LaTeX defaults to OT1 then.
705 - Set sub- and superscript role argument in text mode not as math.
706 Use a custom role based on sub-/superscript if you want italic shape.
707 - Shorter preamble and less dependencies: Load packages and define macros
708 only if required in the document.
709 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
710 - New custom environments and commands with optional "classes" argument.
711 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
712 - Better conformance to Docutils specifications with ``--use-latex-toc``.
713 Support for LaTeX generated ToC also with unnumbered sections.
714 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
715 section numbering by LaTeX.
716 - Use default font in admonitions and sidebar.
717 - Align of image in a figure defaults to 'center'.
718 - Bugfix: Newlines around targets and references prevent run-together
720 - Fix internal hyperlinks.
721 - Use class defaults for page margins ('typearea' now optional).
722 - Float placement made configurable, default changed to "here definitely".
723 - Typeset generic topic as "quote block with title".
724 - Use template (file and configuration option).
725 - In the default template, load cmap.sty (fix text extraction in PDF) and
726 fixltx2e.sty (LaTeX patches, \textsubscript).
727 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
728 - Use `translate` instead of repeated `replace` calls for text encoding.
729 - Hyperlinked footnotes and support for symbol footnotes and
730 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
731 - Complete pairs of binary options
732 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
733 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
735 - font-encoding: "T1" (formerly implicitely set by 'ae').
736 - use-latex-toc: true (ToC with page numbers).
737 - use-latex-footnotes: true (no mixup with figures).
739 * docutils/writers/manpage.py
741 - Do not print version at document end, this is done by the viewer.
742 - Do not print date at document end, this is done by the viewer.
743 - Fix storage of docinfo fields for none standard fields.
745 * docutils/tools/rst2man.py
747 Release 0.5 (2008-06-25)
748 ========================
750 * docutils/languages/he.py: Added to project: Hebrew mappings by
753 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
754 mappings by Meir Kriheli.
756 * docutils/frontend.py:
758 - Configuration files are now assumed and required to be
760 - Paths of applied configuration files are now recorded in the
761 runtime setting ``_config_files`` (accessible via
762 ``--dump-settings``).
763 - Added ``--strip-elements-with-class`` and ``--strip-class``
764 options (``strip_elements_with_classes`` and ``strip_classes``
769 - Added code to determine the input encoding from data: encoding
770 declarations or the presence of byte order marks (UTF-8 & UTF-16).
771 - Added support for IronPython 1.0.
775 - Added ``document.__getstate__`` method, for pickling.
777 * docutils/parsers/rst/states.py:
779 - Allow ``+`` and ``:`` in reference names.
780 - Unquoted targets beginning with an underscore (``.. __target:
781 URI``) are no longer accepted.
782 - Added support for multiple attributions in a physical block quote
783 (indented text block), dividing it into multiple logical block
785 - Added support for unicode bullets in bullet lists: "•", "‣", and
787 - Added support for new object-oriented directive interface,
788 retaining compatibility to the old functional interface.
789 - Added support for throwing ``DirectiveError``'s from within
792 * docutils/parsers/rst/__init__.py:
794 - Added ``Directive`` base class.
795 - Added ``DirectiveError`` base class.
796 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
799 * docutils/parsers/directives/:
801 - Refactored all reStructuredText directives to use the new
802 object-oriented directive interface. Errors are now (mostly)
803 thrown using the new ``DirectiveError`` class.
805 * docutils/parsers/directives/misc.py:
807 - Added ``start-after`` and ``end-before`` options to ``include``
808 directive; thanks to Stefan Rank.
810 * docutils/transforms/universal.py:
812 - Added ``StripClassesAndElements`` transform to remove from the
813 document tree all elements with classes in
814 ``settings.strip_elements_with_classes`` and all "classes"
815 attribute values in ``self.document.settings.strip_classes``.
817 * docutils/transforms/writer_aux.py:
819 - Added ``Admonitions`` transform to transform specific admonitions
820 (like ``note``, ``warning``, etc.) into generic admonitions with a
823 * docutils/writers/html4css1/__init__.py:
825 - Moved template functionality from the PEP/HTML writer here.
826 - Expanded the fragments available in the ``parts`` attribute.
827 - Moved ``id`` attributes from titles to surrounding ``div``
829 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
830 universally supported now).
831 - ``template.txt`` is now opened in text mode instead of binary mode
832 (to ensure Windows compatibility).
833 - ``a`` elements now have an "internal" or "external" class,
834 depending on reference type.
836 * docutils/writers/html4css1/template.txt: Added to project.
838 * docutils/writers/pep_html/:
840 - Moved template functionality to the HTML writer.
842 * docutils/writers/s5_html/__init__.py:
844 - Added ``view_mode`` & ``hidden_controls`` settings
845 (``--view-mode`` & ``--hidden-controls/--visible-controls``
848 * docutils/writers/latex2e/__init__.py:
850 - Add ``--literal-block-env``
851 - Fix: escaping ``%`` in href urls.
852 - Move usepackage hyperref after stylesheet inclusion.
853 - Fix: scrartcl does not have chapter but scrreprt.
854 - Add newline after ``\end{verbatim}``.
855 - Merge smaller differences from latex2e_adaptive_preamble.
856 - Add ``use-part-section``.
857 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
858 - Using leavemode option_list no longer needs to check if parent
859 is a definition list.
860 - Append ``\leavemode`` to definition list terms.
861 - No longer write visit\_/depart_definition_list_item comments to
863 - Table column width with 3 decimal places.
864 - Add table stubs support (boldfont).
865 - Add assemble_parts to writer.
866 - Add simply support for nested tables.
867 - Fix verbatim in tables if use-verbatim-when-possible.
868 - Use section commands down to subparagraph.
869 - Put ensuremath around some latin1 chars.
870 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
871 - New option ``--use-bibtex=style,db1,db2``.
872 - New option ``--reference-label`` to allow usage of LaTeX ref for
873 labels in section references.
874 - Add a label after every section to support sectionnumbers as reference
876 - Fix: bug# 1605376 rst2latex: bad options group list
877 - Remove inactive code for use_optionlist_for_option_list.
878 - Remove latex comments from option_list output.
879 - Fix: bug# 1612270 double qoutes in italian literal.
880 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
881 - Add option --use-latex-abstract.
882 - Image width unit ``px`` is translated to ``pt``.
883 - Add image height support.
884 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
886 - Fix: Do not escape underscores in citation reference labels if
887 use-latex-citations is set.
888 - Use centering instead of center for figure contents, to avoid vertical
890 - Recognize table class: borderless, nolines, booktabs, standard.
891 - Fix: Renaming contents section does not work with latex writer; SF
893 - Applied patch for custom roles with classes from Edward Loper.
894 - Fixed bug that caused crashes with more than 256 lists.
896 * docutils/writers/pep_html/__init__.py:
898 - Changed to support new python.org website structure and
901 * docs/howto/security.txt: "Deploying Docutils Securely", added to
904 * tools/buildhtml.py:
906 -- Added ``ignore`` setting to exclude a list of shell patterns
907 (default: ``.svn:CVS``).
909 * tools/editors/emacs/rst.el:
911 - Changed license to "GPL".
912 - Added ``rst-straighten-decorations`` function.
913 - The ``compile`` module is now always loaded.
914 - Added ``rst-toggle-line-block`` function.
915 - Headings consisting only of non-ASCII characters are now
916 recognized by ``rst-toc`` and ``rst-adjust``.
917 - Added font-lock support for multi-line comments where the first
918 comment line is empty.
919 - Added ``(require 'font-lock)``.
923 - Provide descriptive error message if distutils is missing.
926 Release 0.4 (2006-01-09)
927 ========================
931 - Updated the project policies for trunk/branch development &
934 * docutils/__init__.py:
936 - Added ``__version_details__`` attribute to describe code source
937 (repository/snapshot/release).
938 - Replaced ``default_transforms`` attribute of TransformSpec with
939 ``get_transforms()`` method.
943 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
944 functions, for document tree extraction and reprocessing.
948 - Added ``DocTreeInput`` class, for reprocessing existing documents.
949 - Added support for non-Unicode (e.g. binary) writer output.
953 - Re-introduced ``Targetable.indirect_reference_name``, for
954 MoinMoin/reST compatibility (removed in r3124/r3129).
955 - Added ``serial_escape`` function; escapes string values that are
956 elements of a list, for serialization. Modified Docutils-XML
957 writing (``Element._dom_node``) and pseudo-XML writing
958 (``Element.starttag``) to use ``serial_escape``.
959 - Added ``Node.deepcopy()`` method.
960 - Removed the internal lists ``document.substitution_refs``,
961 ``document.anonymous_refs``, and ``document.anonymous_targets``.
962 - Added a "container" element.
963 - Fixed bug where values of list-valued attributes of elements
964 originating from custom interpreted text roles (i.e., with custom
965 classes) were being shared between element instances. Reported by
968 * docutils/statemachine.py:
970 - Added trailing whitespace stripping to ``string2lines()``.
971 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
972 Asian double-width character support.
976 - Added ``east_asian_column_width()`` for double-width character
979 * docutils/languages/ja.py: Added to project: Japanese mappings by
982 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
983 mappings by Panjunyong.
985 * docutils/parsers/null.py: Added to project; a do-nothing parser.
987 * docutils/parsers/rst/__init__.py:
989 - Added validator to tab_width setting, with test. Closes SF bug
990 #1212515, report from Wu Wei.
992 * docutils/parsers/rst/states.py:
994 - Fixed bug with escaped colons indicating a literal block.
995 - Fixed bug with enumerated lists (SF#1254145).
996 - Backslash-escaped colons inside of field names are now allowed.
997 - Targets (implicit and explicit), anonymous hyperlink references
998 and auto-numbered footnote references inside of substitution
999 definitions are now disallowed.
1000 - Fixed bug: list items with blank first lines.
1001 - Fixed bug: block quote attributions with indented second lines.
1002 - Added East Asian double-width character support (Python 2.4 only).
1004 * docutils/parsers/rst/tableparser.py:
1006 - Added East Asian double-width character support (Python 2.4 only).
1008 * docutils/parsers/rst/directives/body.py:
1010 - Added the "container" directive.
1012 * docutils/parsers/rst/directives/misc.py:
1014 - Added the "default-role", "title", and "date" directives.
1015 - Added standard data file syntax to the "include" directive.
1016 - Added support for "class" directive content.
1018 * docutils/parsers/rst/directives/images.py:
1020 - Added ``indirect_reference_name`` support for images with a target
1022 - Added support for image width and height units.
1023 - Fixed bug with image "target" options.
1025 * docutils/parsers/rst/directives/references.py:
1027 - Added "class" attribute to "target-notes" directive, for
1028 footnote_reference classes.
1030 * docutils/parsers/rst/include/: Directory added to project; contains
1031 standard data files for the "include" directive. Initial contents:
1032 character entity substitution definition sets, and a set of
1033 definitions for S5/HTML presentations.
1035 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1036 mappings by David Goodger.
1038 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1039 Simplified Chinese mappings by Panjunyong.
1041 * docutils/readers/__init__.py:
1043 - Added universal.Decorations and universal.ExposeInternals
1044 transforms as default transforms for all readers.
1045 - Added ``ReReader`` base class for readers that reread an existing
1048 * docutils/readers/doctree.py: Added to project; a reader for existing
1051 * docutils/transforms/frontmatter.py:
1053 - Fixed the DocInfo transform to handle SVN-style expansion of the
1055 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1058 * docutils/transforms/misc.py:
1060 - Added misc.Transitions transform, extracted from
1061 universal.FinalChecks.
1063 * docutils/transforms/references.py:
1065 - Added references.DanglingReferences transform, extracted from
1066 universal.FinalChecks.
1067 - Fixed bug with doubly-indirect substitutions.
1068 - Added footnote_reference classes attribute to "TargetNotes".
1069 - Fixed bug with circular substitution definitions that put Docutils
1070 into an infinite loop.
1072 * docutils/transforms/universal.py:
1074 - Added universal.ExposeInternals transform, extracted from
1075 universal.FinalChecks.
1076 - Removed universal.FinalChecks transform (logic has been moved to
1077 several new transforms).
1078 - Fixed bug with the "expose_internals" setting and Text nodes
1079 (exposed by the "rawsource" internal attribute).
1080 - Added the universal.StripComments transform, implementation of the
1081 "strip_comments" setting.
1083 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1084 transforms for writers.
1086 - Added ``Compound`` transform, which flattens compound paragraphs.
1088 * docutils/writers/: Several writer modules (html4css1.py) were
1089 converted into packages. Support modules and data files have been
1090 moved into the packages. The stylesheets for the HTML writers are
1091 now installed along with the code, the code knows where to find
1092 them, and the default is to use them (actually, to embed them).
1093 Some adjustments to configuration files may be necessary. The
1094 easiest way to obtain the new default behavior is to remove all
1095 settings whose name includes "stylesheet".
1097 * docutils/writers/__init__.py:
1099 - Added universal.Messages and universal.FilterMessages transforms
1100 as default transforms for all writers.
1101 - Added ``UnfilteredWriter`` base class for writers that pass the
1102 document tree on unchanged.
1104 * docutils/writers/docutils_xml.py:
1106 - Made ``xmlcharrefreplace`` the default output encoding error
1109 * docutils/writers/html4css1/:
1111 - Added support for image width and height units.
1112 - Made ``xmlcharrefreplace`` the default output encoding error
1114 - Made ``--embed-stylesheet`` the default rather than
1115 ``--link-stylesheet``.
1116 - Moved "id" attribute from container (section etc.) to title's <a>
1117 tag, to be on the same tag as "name".
1118 (!!! To be reverted in Docutils 0.5.)
1119 - Added vertical space between fields of field lists.
1120 - Added ``--compact-field-lists`` option to remove vertical space in
1122 - Made cloaking of email addresses with ``--cloak-email-addresses``
1124 - Fixed support for centered images.
1125 - Added support for class="compact" & class="open" lists.
1127 * docutils/writers/latex2e/:
1129 - Underscores in citekeys are no longer escaped.
1131 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1132 mapping of Unicode characters to LaTeX equivalents.
1134 * docutils/writers/s5_html/: Package added to project; writer for
1135 S5/HTML slide shows.
1137 * docs/dev/distributing.txt: Added to project; guide for distributors
1138 (package maintainers).
1140 * docs/dev/hacking.txt: Added to project; guide for developers.
1142 * docs/ref/doctree.txt:
1144 - Updated for plural attributes "classes", "ids", "names",
1146 - Added the "container" element.
1148 * docs/ref/docutils.dtd:
1150 - Updated for plural attributes "classes", "ids", "names",
1153 * docs/user/emacs.txt: Added to project; a document about Emacs
1154 support for reStructuredText and Docutils.
1156 * docs/user/links.txt: Added to project; lists of Docutils-related
1159 * docs/user/mailing-lists.txt: Added to project; information about
1160 Docutils-related mailing lists and how to access them.
1162 * docs/user/slide-shows.txt: Added to project; example of and docs for
1163 the S5/HTML writer (``rst2s5.py`` front end).
1165 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1166 Files", added to project.
1168 * test/coverage.sh: Added to project; test coverage script.
1170 * test/DocutilsTestSupport.py:
1172 - Added support for specifying runtime settings at the suite level.
1174 * test/test_functional.py:
1176 - Added the ``clear_output_directory`` function.
1177 - Added support for ``_test_more`` functions in functional test
1180 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1182 * tools/rstpep2html.py: Renamed from pep.py.
1184 * tools/dev/create_unimap.py: Added to project; script to create the
1185 docutils/writers/unimap_latex.py mapping file.
1187 * tools/dev/profile_docutils.py: Added to project; profiler script.
1189 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1191 * tools/editors/emacs/restructuredtext.el,
1192 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1193 Removed from project; the functionality is now contained in rst.el.
1195 * tools/editors/emacs/rst.el: Added to project. Added many features
1196 and fixed many bugs. See docs/user/emacs.txt for details.
1198 * tools/stylesheets: Removed from project. Stylesheets have been
1199 renamed and moved into writer packages.
1202 Release 0.3.9 (2005-05-26)
1203 ==========================
1207 - Eliminated and replaced all uses of the old string attributes
1208 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1209 new list attributes ``ids``, ``names``, ``dupnames`` and
1210 ``classes`` throughout the whole source tree.
1214 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1215 allowing for easier debugging.
1216 - In ``Publisher.publish()``, expanded the generic top-level
1219 * docutils/examples.py:
1221 - Added ``internals`` function for exploration.
1225 - Fixed ``Input.decode`` method to apply heuristics only if no
1226 encoding is explicitly given, and to provide better reporting of
1228 - The ``Input.decode`` method now removes byte order marks (BOMs)
1231 * docutils/nodes.py:
1233 - ``image`` element class changed to subclass of Element, not
1234 TextElement (it's an empty element, and cannot contain text).
1235 - Added ``attr_defaults`` dictionary for default attribute values.
1236 - Added empty list as default value for the following attributes:
1237 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1238 - Added ``document.decoration`` attribute,
1239 ``document.get_decoration`` method, and ``decoration.get_header``
1240 & ``.get_footer`` methods.
1241 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1244 * docutils/utils.py:
1246 - Removed ``docutils.utils.Reporter.categories``,
1247 ``docutils.utils.ConditionSet``, and all references to them, to
1248 simplify error reporting.
1250 * docutils/languages/nl.py: Added to project; Dutch mappings by
1253 * docutils/parsers/rst/__init__.py:
1255 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1257 * docutils/parsers/rst/states.py:
1259 - Added check for escaped at-mark to prevent email address recognition.
1260 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1262 - Allowed whitespace in paths and URLs.
1263 - Added auto-enumerated list items.
1264 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1266 - Added support for table stub columns.
1268 * docutils/parsers/rst/directives/__init__.py:
1270 - Allowed whitespace in paths (``path`` function).
1271 - Added ``uri`` directive option conversion function.
1273 * docutils/parsers/rst/directives/body.py:
1275 - Fixed illegal context bug with "topic" directive (allowed within
1276 sidebars; not within body elements).
1278 * docutils/parsers/rst/directives/images.py:
1280 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1281 - Added support for the ``file_insertion_enabled`` setting in the
1282 "figure" directive (disables "figwidth" option).
1283 - "image" directive: added checks for valid values of "align" option,
1284 depending on context. "figure" directive: added specialized
1285 "align" option and attribute on "figure" element.
1286 - Made ":figwidth: image" option of "figure" directive work again.
1287 - Fixed bug with reference names containing uppercase letters
1288 (e.g. ``Name_``) in "target" option of "image" directive.
1290 * docutils/parsers/rst/directives/misc.py:
1292 - Fixed "include" and "raw" directives to catch text decoding
1294 - Allowed whitespace in "include" & "raw" directive paths.
1295 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1296 settings in "include" & "raw" directives.
1298 * docutils/parsers/rst/directives/parts.py:
1300 - Added "header" & "footer" directives.
1301 - Fixed illegal context bug with "contents" directive (topics
1302 allowed within sidebars; not within body elements).
1304 * docutils/parsers/rst/directives/tables.py:
1306 - Added "list-table" directive.
1307 - Caught empty CSV table bug.
1308 - Added support for the ``file_insertion_enabled`` setting in the
1309 "csv-table" directive.
1310 - Added ``stub-columns`` option to "csv-table" and "list-table"
1313 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1314 mappings by Martijn Pieters.
1316 * docutils/readers/standalone.py:
1318 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1319 options to activate or deactivate the SectSubTitle transform.
1321 * docutils/transforms/frontmatter.py:
1323 - Added SectSubTitle transform to promote titles of lone
1324 subsections to subtitles.
1326 * docutils/transforms/references.py:
1328 - Fixed mislocated internal targets bug, by propagating internal
1329 targets to the next node, making use of the newly added support
1330 for multiple names and IDs.
1331 - Fixed duplicate footnote label bug.
1332 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1335 * docutils/writers/html4css1.py:
1337 - Fixed unencoded stylesheet reference bug (characters like "&" in
1338 stylesheet references).
1339 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1341 - Added support for multiple IDs per node by creating empty ``span``
1343 - Added the ``field_name_limit`` & ``option_limit`` settings &
1345 - Added support for table stub columns.
1346 - Added support for the ``align`` attribute on ``figure`` elements.
1347 - Added the ``cloak_email_addresses`` setting & support.
1348 - Added ``html_prolog``, ``html_head``, ``html_body``,
1349 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1350 ``docutils.core.publish_parts``.
1351 - Added support for section subtitles.
1353 * docutils/writers/latex2e.py:
1355 - Fixed tables starting with more than one multirow cell.
1356 - Improved --use-latex-docinfo so that organization/contact/address
1357 fields are lumped with the last author field and appear on the
1359 - Made sure the titlepage is always shown with --use-latex-docinfo,
1360 even if the document has no title.
1361 - Made sure that latex doesn't fill in today's date if no date field
1363 - Added support for section subtitles.
1365 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1366 (under development).
1368 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1370 * docs/api/publisher.txt:
1372 - Added "``publish_parts`` Details" section.
1374 * docutils/dev/repository.txt: Added to project; information about the
1375 Docutils Subversion repository.
1377 * docs/ref/docutils.dtd:
1379 - Added a ``stub`` attribute to the ``colspec`` element via the
1380 ``tbl.colspec.att`` parameter entity.
1381 - Allowed topic elements within sidebars
1382 - Added an ``align`` attribute to the ``figure`` element.
1384 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1388 Release 0.3.7 (2004-12-24)
1389 ==========================
1391 * docutils/frontend.py:
1393 - Added options: --input-encoding-error-handler,
1394 --record-dependencies, --leave-footnote-reference-space,
1396 - Added command-line and config file support for "overrides" setting
1401 - Added support for input encoding error handler.
1403 * docutils/nodes.py:
1405 - Added dispatch_visit and dispatch_departure methods to
1406 NodeVisitor; useful as a hook for Visitors.
1407 - Changed structure of ``line_block``; added ``line``.
1408 - Added ``compound`` node class.
1409 - Added a mechanism for Visitors to transitionally ignore new node
1412 * docutils/utils.py:
1414 - Moved ``escape2null`` and ``unescape`` functions from
1415 docutils/parsers/rst/states.py.
1417 * docutils/parsers/rst/roles.py:
1420 - Changed role function API: the "text" parameter now takes
1421 null-escaped interpreted text content.
1423 * docutils/parsers/rst/states.py:
1425 - Fixed bug where a "role" directive in a nested parse would crash
1426 the parser; the state machine's "language" attribute was not being
1428 - Added support for line block syntax.
1429 - Fixed directive parsing bug: argument-less directives didn't
1430 notice that arguments were present.
1431 - Removed error checking for transitions.
1432 - Added support for multiple classifiers in definition list items.
1433 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1434 - Changed role function API: the "text" parameter now takes
1435 null-escaped interpreted text content.
1436 - Empty sections and documents are allowed now.
1438 * docutils/parsers/rst/directives/__init__.py:
1440 - Added ``encoding`` directive option conversion function.
1441 - Allow multiple class names in class_option conversion function.
1443 * docutils/parsers/rst/directives/body.py:
1445 - Converted the line-block directive to use the new structure.
1446 - Extracted the old line-block functionality to the ``block``
1447 function (still used).
1448 - Added ``compound`` directive (thanks to Lea Wiemann).
1450 * docutils/parsers/rst/directives/misc.py:
1452 - Added "encoding" option to "include" and "raw" directives.
1453 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1454 - Allow multiple class names in the "class" directive.
1456 * docutils/parsers/rst/directives/parts.py:
1458 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1459 options. Thanks to Lele Gaifax.
1461 * docutils/parsers/rst/directives/tables.py:
1463 - Added "encoding" directive to "csv-table" directive.
1464 - Added workaround for lack of Unicode support in csv.py, for
1465 non-ASCII CSV input.
1467 * docutils/transforms/misc.py:
1469 - Fixed bug when multiple "class" directives are applied to a single
1471 - Enabled multiple format names for "raw" directive.
1473 * docutils/transforms/references.py:
1475 - Added support for trimming whitespace from beside substitution
1478 * docutils/transforms/universal.py:
1480 - FinalChecks now checks for illegal transitions and moves
1481 transitions between sections.
1483 * docutils/writers/html4css1.py:
1485 - HTMLTranslator.encode now converts U+00A0 to " ".
1486 - "stylesheet" and "stylesheet_path" settings are now mutually
1488 - Added support for the new line_block/line structure.
1489 - --footnote-references now overrides
1490 --trim-footnote-reference-space, if applicable.
1491 - Added support for ``compound`` elements.
1492 - Enabled multiple format names for "raw" directive.
1493 - ``<p>`` tags of a paragraph which is the only visible child of the
1494 document node are no longer stripped.
1495 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1496 new method ``should_be_compact_paragraph()``.
1497 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1499 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1500 the output if they have their ``class`` attribute set.
1501 - The whole document is now surrounded by a ``<div
1502 class="document">`` element.
1503 - Body-level images are now wrapped by their own ``<div>`` elements,
1504 with image classes copied to the wrapper, and for images which
1505 have the ``:align:`` option set, the surrounding ``<div>`` now
1506 receives a class attribute (like ``class="align-left"``).
1508 * docutils/writers/latex2e.py:
1510 - no newline after depart_term.
1511 - Added translations for some Unicode quotes.
1512 - Added option "font-encoding", made package AE the default.
1513 - "stylesheet" and "stylesheet_path" settings are now mutually
1515 - --footnote-references now overrides
1516 --trim-footnote-reference-space, if applicable.
1517 - The footnote label style now matches the footnote reference style
1518 ("brackets" or "superscript").
1519 - Added support for ``compound`` elements.
1520 - Enabled multiple format names for "raw" directive.
1522 * docs/ref/docutils.dtd:
1524 - Changed structure of the ``line_block`` element; added ``line``.
1525 - Added ``compound`` element.
1526 - Added "ltrim" and "rtrim" attributes to
1527 ``substitution_definition`` element.
1528 - Enabled multiple format names for ``raw`` element.
1529 - Enabled multiple classifiers in ``definition_list_item`` elements.
1531 * docs/ref/rst/directives.txt
1533 - Marked "line-block" as deprecated.
1534 - "Class" directive now allows multiple class names.
1535 - Added "Rationale for Class Attribute Value Conversion".
1536 - Added warning about "raw" overuse/abuse.
1538 * docs/ref/rst/restructuredtext.txt:
1540 - Added syntax for line blocks.
1541 - Definition list items may have multiple classifiers.
1543 * docs/ref/rst/roles.txt:
1547 * tools/stylesheets/default.css:
1549 - Added support for the new line_block structure.
1550 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1553 Release 0.3.5 (2004-07-29)
1554 ==========================
1558 * _`Documentation cleanup/reorganization`.
1560 - Created new subdirectories of docs/:
1562 * ``docs/user/``: introductory/tutorial material for end-users
1563 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1564 * ``docs/api/``: API reference material for client-developers
1565 * ``docs/ref/``: reference material for all groups
1566 * ``docs/howto/``: for component-developers and core-developers
1567 * ``docs/peps/``: Python Enhancement Proposals
1569 - Moved ``docs/*`` to ``docs/user/``.
1570 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1571 ``spec/`` to ``docs/dev``.
1572 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1573 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1574 - Moved ``alternatives.txt``, and ``problems.txt`` from
1575 ``spec/rst/`` to ``docs/dev/rst/``.
1576 - Moved ``reStructuredText.txt``, ``directives.txt``,
1577 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1578 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1579 ``roles.txt``, ``reStructuredText.txt`` to
1580 ``restructuredtext.txt``.
1581 - Moved ``spec/howto/`` to ``docs/howto``.
1583 In order to keep the CVS history of moved files, we supplied
1584 SourceForge with a `script for modifying the Docutils CVS
1587 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1589 After running the cleanup script:
1591 - Added ``docs/index.txt``.
1592 - Added a ``.htaccess`` file to the ``web`` module, containing
1593 redirects for all old paths to new paths. They'll preserve
1594 fragments (the "#name" part of a URL), and won't clutter up the
1595 file system, and will correct the URL in the user's browser.
1596 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1597 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1598 the "To Do" list itself in ``docs/dev/todo.txt``.
1599 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1600 section of ``docs/dev/todo.txt``.
1601 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1602 - Added "How To Report Bugs" to ``BUGS.txt``.
1603 - Went through all the sources and docs (including under web/) and
1604 updated links. Mostly done by Lea Wiemann; thanks Lea!
1605 (Still need to update links in the sandboxes.)
1609 * BUGS.txt: Added to project.
1611 * THANKS.txt: Added to project.
1613 * docutils/__init__.py:
1615 - 0.3.4: Post-release.
1619 - Added special error handling & advice for UnicodeEncodeError.
1620 - Refactored Publisher.publish (simplified exception handling &
1621 extracted debug dumps).
1622 - Renamed "enable_exit" parameter of convenience functions to
1623 "enable_exit_status".
1624 - Enabled traceback (exception propagation) by default in
1625 programmatic convenience functions.
1626 - Now publish_file and publish_cmdline convenience functions return
1627 the encoded string results in addition to their regular I/O.
1628 - Extracted common code from publish_file, publish_string, and
1629 publish_parts, into new publish_programmatically. Extracted
1630 settings code to ``Publisher.process_programmatic_settings``.
1631 - In Publisher.publish, disabled ``settings_overrides`` when
1632 ``settings`` is supplied; redundant.
1634 * docutils/frontend.py:
1636 - Added help text for "--output-encoding-error-handler" and
1637 "--error-encoding-error-handler".
1638 - Renamed "--exit" to "--exit-status".
1639 - Simplified default-setting code.
1641 * docutils/parsers/rst/__init__.py:
1643 - Added "--pep-base-url" and "--rfc-base-url" options.
1645 * docutils/parsers/rst/states.py:
1647 - Made URI recognition more aggressive and intelligent.
1649 * docutils/parsers/rst/directives/__init__.py:
1651 - Added several directive option conversion functions.
1653 * docutils/parsers/rst/directives/body.py:
1655 - Moved "table" directive to tables.py.
1657 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1660 * docutils/writers/latex2e.py:
1662 - Added "--table-style=(standard|booktabs|nolines)"
1663 - figures get "here" option (LaTeX per default puts them at bottom),
1664 and figure content is centered.
1665 - Rowspan support for tables.
1666 - Fix: admonition titles before first section.
1667 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1668 - Replave ``_`` in literal by an underlined blank, because it has the correct
1670 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1671 - A few unicode replacements, if output_encoding != utf
1672 - Add "--graphicx-option".
1673 - Indent literal-blocks.
1674 - Fix: omit ``\maketitle`` when there is no document title.
1676 * docs/index.txt: "Docutils Project Documentation Overview", added to
1679 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1680 Tool", added to project.
1682 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1684 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1686 * docs/dev/policies.txt: Added to project (extracted from
1687 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1689 * docs/dev/release.txt: Added to project (extracted from
1690 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1692 * docs/dev/testing.txt: Added to project.
1694 * docs/dev/website.txt: Added to project (extracted from
1695 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1697 * docs/ref/rst/directives.txt:
1699 - Added directives: "table", "csv-table".
1701 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1702 added to project. 1 page for syntax, and a 1 page reference for
1703 directives and roles. Source text to be used as-is; not meant to be
1706 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1707 with a change of title.
1709 * test/functional/, contents, and test/test_functional.py: Added to
1712 * tools/buildhtml.py: Fixed bug with config file handling.
1714 * tools/html.py: Removed from project (duplicate of rst2html.py).
1716 * tools/pep2html.py: Removed from project (duplicate of Python's
1717 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1718 Docutils-related PEPs in docs/peps/).
1720 * tools/rst2pseudoxml.py: Renamed from publish.py.
1722 * tools/rst2xml.py: Renamed from docutils-xml.py.
1724 * tools/test.txt: Removed from project; moved to
1725 docs/user/rst/demo.txt.
1727 * setup.py: Now also installs ``rst2latex.py``.
1730 Release 0.3.3 (2004-05-09)
1731 ==========================
1733 * docutils/__init__.py:
1735 - 0.3.1: Reorganized config file format (multiple sections); see
1737 - Added unknown_reference_resolvers attribute to TransformSpec.
1738 - 0.3.2: Interpreted text reorganization.
1743 - Catch system messages to stop tracebacks from parsing errors.
1744 - Catch exceptions during processing report & exit without
1745 tracebacks, except when "--traceback" used.
1746 - Reordered components for OptionParser; application comes last.
1747 - Added "config_section" parameter to several methods and functions,
1748 allowing front ends to easily specify their config file sections.
1749 - Added publish_parts convenience function to allow access to individual
1750 parts of a document.
1752 * docutils/examples.py: Added to project; practical examples of
1753 Docutils client code, to be used as-is or as models for variations.
1755 * docutils/frontend.py:
1757 - Added "--traceback" & "--no-traceback" options ("traceback"
1759 - Implemented support for config file reorganization:
1760 ``standard_config_files`` moved from ``ConfigParser`` to
1761 ``OptionParser``; added
1762 ``OptionParser.get_config_file_settings()`` and
1763 ``.get_standard_config_settings()``; support for old "[options]"
1764 section (with deprecation warning) and mapping from old to new
1766 - Reimplemented setting validation.
1767 - Enabled flexible boolean values: yes/no, true/false, on/off.
1768 - Added ``Values``, a subclass of ``optparse.Values``, with support
1769 for list setting attributes.
1770 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1771 thanks to Beni Cherniavsky.
1772 - Added "--no-section-numbering" option.
1776 - Catch IOErrors when opening source & destination files, report &
1777 exit without tracebacks. Added ``handle_io_errors`` parameter to
1778 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1780 * docutils/nodes.py:
1782 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1783 method definitions (via ``exec``) to dynamic assignments (via
1784 ``setattr``); thanks to Roman Suzi.
1785 - Encapsulated visitor dynamic assignments in a function; thanks to
1787 - Added indirect_reference_name attribute to the Targetable
1788 class. This attribute holds the whitespace_normalized_name
1789 (contains mixed case) of a target.
1791 * docutils/statemachine.py:
1793 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1794 - Added ``StringList.get_2D_block``.
1796 * docutils/utils.py:
1798 - Added "level" attribute to SystemMessage exceptions.
1800 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1803 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1806 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1807 Marcelo Huerta San Martin.
1809 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1810 mappings by Lalo Martins.
1812 * docutils/languages/ru.py: Added to project; Russian mappings by
1815 * docutils/parsers/rst/roles.py: Added to project. Contains
1816 interpreted text role functions, a registry for interpreted text
1817 roles, and an API for adding to and retrieving from the registry.
1818 Contributed by Edward Loper.
1820 * docutils/parsers/rst/states.py:
1822 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1823 - Allowed true em-dash character and "---" as block quote
1825 - Added support for <angle-bracketed> complex option arguments
1827 - Fixed handling of backslashes in substitution definitions.
1828 - Fixed off-by-1 error with extra whitespace after substitution
1829 definition directive.
1830 - Added inline markup parsing to field lists' field names.
1831 - Added support for quoted (and unindented) literal blocks.
1832 Driven in part by a bribe from Frank Siebenlist (thanks!).
1833 - Parser now handles escapes in URIs correctly.
1834 - Made embedded-URIs' reference text omittable. Idea from Beni
1836 - Refactored explicit target processing code.
1837 - Added name attribute to references containing the reference name only
1838 through whitespace_normalize_name (no case changes).
1839 - parse_target no longer returns the refname after going through
1840 normalize_name. This is now handled in make_target.
1841 - Fixed bug relating to role-less interpreted text in non-English
1843 - Reorganized interpreted text processing; moved code into the new
1844 roles.py module. Contributed by Edward Loper.
1845 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1846 ``parse_directive_block``.
1848 * docutils/parsers/rst/tableparser.py:
1850 - Reworked for ``StringList``, to support "include" directives in
1853 * docutils/parsers/rst/directives/__init__.py:
1855 - Renamed ``unchanged()`` directive option conversion function to
1856 ``unchanged_required``, and added a new ``unchanged``.
1857 - Catch unicode value too high error; fixes bug 781766.
1858 - Beefed up directive error reporting.
1860 * docutils/parsers/rst/directives/body.py:
1862 - Added basic "table" directive.
1864 * docutils/parsers/rst/directives/images.py:
1866 - Added "target" option to "image" directive.
1867 - Added name attribute to references containing the reference name only
1868 through whitespace_normalize_name (no case changes).
1870 * docutils/parsers/rst/directives/misc.py:
1872 - Isolated the import of the ``urllib2`` module; was causing
1873 problems on SourceForge (``libssl.so.2`` unavailable?).
1874 - Added the "role" directive for declaring custom interpreted text
1877 * docutils/parsers/rst/directives/parts.py:
1879 - The "contents" directive does more work up-front, creating the
1880 "topic" and "title", and leaving the "pending" node for the
1881 transform. Allows earlier reference resolution; fixes subtle bug.
1883 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1884 mappings by Jannie Hofmeyr.
1886 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1887 mappings by Marek Blaha.
1889 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1890 mappings by Marcelo Huerta San Martin.
1892 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1893 Portuguese mappings by Lalo Martins.
1895 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1896 mappings by Roman Suzi.
1898 * docutils/transforms/parts.py:
1900 - The "contents" directive does more work up-front, creating the
1901 "topic" and "title", and leaving the "pending" node for the
1902 transform. Allows earlier reference resolution; fixes subtle bug.
1903 - Added support for disabling of section numbering.
1905 * docutils/transforms/references.py:
1907 - Verifying that external targets are truly targets and not indirect
1908 references. This is because we are now adding a "name" attribute to
1909 references in addition to targets. Note sure if this is correct!
1910 - Added code to hook into the unknown_reference_resolvers list for a
1911 transformer in resolve_indirect_target. This allows the
1912 unknown_reference_resolvers to keep around indirect targets which
1913 docutils doesn't know about.
1914 - Added specific error message for duplicate targets.
1916 * docutils/transforms/universal.py:
1918 - Added FilterMessages transform (removes system messages below the
1919 verbosity threshold).
1920 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1921 to FinalCheckVisitor for application-specific handling of
1922 unresolvable references.
1923 - Added specific error message for duplicate targets.
1925 * docutils/writers/__init__.py:
1927 - Added assemble_parts method to the Writer class to allow for
1928 access to a documents individual parts.
1929 - Documented & set default for ``Writer.output`` attribute.
1931 * docutils/writers/html4css1.py:
1933 - Fixed unicode handling of attribute values (bug 760673).
1934 - Prevent duplication of "class" attribute values (bug report from
1936 - Improved table grid/border handling (prompted by report from Bob
1938 - Added support for table titles.
1939 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1941 - Added functionality to keep track of individual parts of a document
1942 and store them in a dictionary as the "parts" attribute of the writer.
1943 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1944 - Added proper support for the "scale" attribute of the "image"
1945 element. Contributed by Brent Cook.
1946 - Added ``--initial-header-level`` option.
1947 - Fixed bug: the body_pre_docinfo segment depended on there being a
1948 docinfo; if no docinfo, the document title was incorporated into
1949 the body segment. Adversely affected the publish_parts interface.
1951 * docutils/writers/latex2e.py:
1953 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1954 about a missing file.
1955 - Added options and support: ``--compound-enumerators``,
1956 ``--section-prefix-for-enumerators``, and
1957 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1959 - Added option ``--use-verbatim-when-possible``, to avoid
1960 problematic characters (eg, '~' in italian) in literal blocks.
1961 - It's now possible to use four section levels in the `book` and
1962 `report` LaTeX classes. The default `article` class still has
1965 * docs/config.txt: "Docutils Configuration Files", added to project.
1966 Moved config file entry descriptions from tools.txt.
1970 - Moved config file entry descriptions to config.txt.
1972 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1975 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1976 Text Roles", added to project.
1978 * spec/rst/reStructuredText.txt:
1980 - Added description of support for <angle-bracketed> complex option
1981 arguments to option lists.
1982 - Added subsections for indented and quoted literal blocks.
1984 * test: Continually adding & updating tests.
1986 - Added test/test_settings.py & test/data/config_*.txt support
1988 - Added test/test_writers/test_htmlfragment.py.
1990 * test/DocutilsTestSupport.py:
1992 - Refactored LaTeX publisher test suite/case class names to make
1993 testing other writers easier.
1994 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1995 to test the processing of HTML fragments which use the new
1996 publish_parts convenience function.
1998 * tools/buildhtml.py:
2000 - Added support for the "--prune" option.
2001 - Removed dependency on pep2html.py; plaintext PEPs no longer
2004 * tools/docutils.conf:
2006 - Updated for configuration file reorganization.
2008 * tools/rst2html.py:
2010 - copied from tools/html.py
2014 - added a 'scripts' section to configuration
2015 - added 'tools/rst2html.py' to the scripts section
2018 Release 0.3 (2003-06-24)
2019 ========================
2023 * Renamed "attribute" to "option" for directives/extensions.
2025 * Renamed transform method "transform" to "apply".
2027 * Renamed "options" to "settings" for runtime settings (as set by
2028 command-line options). Sometimes "option" (singular) became
2029 "settings" (plural). Some variations below:
2031 - document.options -> document.settings (stored in other objects as
2033 - option_spec -> settings_spec (not directives though)
2034 - OptionSpec -> SettingsSpec
2035 - cmdline_options -> settings_spec
2036 - relative_path_options -> relative_path_settings
2037 - option_default_overrides -> settings_default_overrides
2038 - Publisher.set_options -> Publisher.get_settings
2042 * COPYING.txt: Added "Public Domain Dedication".
2044 * FAQ.txt: Frequently asked questions, added to project.
2048 - Updated with PyPI Trove classifiers.
2049 - Conditional installation of third-party modules.
2051 * docutils/__init__.py:
2053 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2054 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2055 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2056 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2057 option and its effect on the PEP template & writer.
2058 - Bumped version to 0.2.4 due to changes to the PEP template &
2060 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2061 - Added ``TransformSpec`` class for new transform system.
2062 - Bumped version to 0.2.6 for API changes (renaming).
2063 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2064 convenience functions.
2065 - Added ``Component.component_type`` attribute.
2066 - Bumped version to 0.2.8 because of the internal parser switch from
2067 plain lists to the docutils.statemachine.StringList objects.
2068 - Bumped version to 0.2.9 because of the frontend.py API changes.
2069 - Bumped version to 0.2.10 due to changes to the project layout
2070 (third-party modules removed from the "docutils" package), and
2071 signature changes in ``io.Input``/``io.Output``.
2072 - Changed version to 0.3.0 for release.
2076 - Made ``publish()`` a bit more convenient.
2077 - Generalized ``Publisher.set_io``.
2078 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2079 parameters; improved its docstring.
2080 - Added ``publish_file()`` and ``publish_string()``.
2081 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2083 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2084 "--dump-transforms" hidden options.
2085 - Added ``Publisher.apply_transforms()`` method.
2086 - Added ``Publisher.set_components()`` method; support for
2087 ``publish_*()`` conveninece functions.
2088 - Moved config file processing to docutils/frontend.py.
2089 - Added support for exit status ("exit_level" setting &
2090 ``enable_exit`` parameter for Publisher.publish() and convenience
2093 * docutils/frontend.py:
2095 - Check for & exit on identical source & destination paths.
2096 - Fixed bug with absolute paths & "--config".
2097 - Set non-command-line defaults in ``OptionParser.__init__()``:
2098 ``_source`` & ``_destination``.
2099 - Distributed ``relative_path_settings`` to components; updated
2100 ``OptionParser.populate_from_components()`` to combine it all.
2101 - Require list of keys in ``make_paths_absolute`` (was implicit in
2102 global ``relative_path_settings``).
2103 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2104 "--dump-settings", and "--dump-transforms" hidden options.
2105 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2106 code, replaced with correct code.
2107 - Added validation functionality for config files.
2108 - Added "--error-encoding" option/setting, "_disable_config"
2110 - Added encoding validation; updated "--input-encoding" and
2111 "--output-encoding"; added "--error-encoding-error-handler" and
2112 "--output-encoding-error-handler".
2113 - Moved config file processing from docutils/core.py.
2114 - Updated ``OptionParser.populate_from_components`` to handle new
2115 ``SettingsSpec.settings_defaults`` dict.
2116 - Added support for "-" => stdin/stdout.
2117 - Added "exit_level" setting ("--exit" option).
2121 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2122 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2123 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2124 - ``FileOutput.write()`` now returns the encoded output string.
2125 - Try to get path/stream name automatically in ``FileInput`` &
2127 - Added defaults for source & destination paths.
2128 - Allow for Unicode I/O with an explicit "unicode" encoding.
2129 - Added ``Output.encode()``.
2130 - Removed dependency on runtime settings; pass encoding directly.
2131 - Recognize Unicode strings in ``Input.decode()``.
2132 - Added support for output encoding error handlers.
2134 * docutils/nodes.py:
2136 - Added "Invisible" element category class.
2137 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2138 modification during a traversal.
2139 - Added element classes: ``line_block``, ``generated``, ``address``,
2140 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2141 ``superscript``, ``subscript``, ``inline``
2142 - Added support for lists of nodes to ``Element.insert()``.
2143 - Fixed parent linking in ``Element.replace()``.
2144 - Added new abstract superclass ``FixedTextElement``; adds
2145 "xml:space" attribute.
2146 - Added support for "line" attribute of ``system_message`` nodes.
2147 - Added support for the observer pattern from ``utils.Reporter``.
2148 Added ``parse_messages`` and ``transform_messages`` attributes to
2149 ``document``, removed ``messages``. Added ``note_parse_message``
2150 and ``note_transform_message`` methods.
2151 - Added support for improved diagnostics:
2153 - Added "document", "source", and "line" internal attributes to
2154 ``Node``, set by ``Node.setup_child()``.
2155 - Converted variations on ``node.parent = self`` to
2156 ``self.setup_child(node)``.
2157 - Added ``document.current_source`` & ``.current_line``
2158 attributes, and ``.note_source`` observer method.
2159 - Changed "system_message" output to GNU-Tools format.
2161 - Added a "rawsource" attribute to the ``Text`` class, for text
2162 before backslash-escape resolution.
2163 - Support for new transform system.
2164 - Reworked ``pending`` element.
2165 - Fixed XML DOM bug (SF #660611).
2166 - Removed the ``interpeted`` element class and added
2167 ``title_reference``, ``abbreviation``, ``acronym``.
2168 - Made substitutions case-sensitive-but-forgiving; moved some code
2170 - Fixed Unicode bug on element attributes (report: William Dode).
2172 * docutils/optik.py: Removed from project; replaced with
2173 extras/optparse.py and extras/textwrap.py. These will be installed
2174 only if they're not already present in the Python installation.
2176 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2177 only if it's not already present in the Python installation.
2179 * docutils/statemachine.py:
2181 - Factored out ``State.add_initial_transitions()`` so it can be
2183 - Converted whitespace-specific "blank" and "indent" transitions
2184 from special-case code to ordinary transitions: removed
2185 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2186 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2187 ``ws_initial_transitions`` attributes.
2188 - Removed ``State.match_transition()`` after merging it into
2190 - Added ``StateCorrection`` exception.
2191 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2192 (moved ``TransitionCorrection`` support there too.)
2193 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2194 ``EOFError`` instead of ``IndexError``.
2195 - Added ``State.no_match`` method.
2196 - Added support for the Observer pattern, triggered by input line
2198 - Added ``strip_top`` parameter to
2199 ``StateMachineWS.get_first_known_indented``.
2200 - Made ``context`` a parameter to ``StateMachine.run()``.
2201 - Added ``ViewList`` & ``StringList`` classes;
2202 ``extract_indented()`` becomes ``StringList.get_indented()``.
2203 - Added ``StateMachine.insert_input()``.
2204 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2205 thanks to) Fred Drake.
2207 * docutils/utils.py:
2209 - Added a ``source`` attribute to Reporter instances and
2210 ``system_message`` elements.
2211 - Added an observer pattern to ``utils.Reporter`` to keep track of
2213 - Fixed bugs in ``relative_path()``.
2214 - Added support for improved diagnostics.
2215 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2216 - Added support for encoding Reporter stderr output, and encoding
2218 - Reporter keeps track of the highest level system message yet
2221 * docutils/languages: Fixed bibliographic field language lookups.
2223 * docutils/languages/es.py: Added to project; Spanish mappings by
2224 Marcelo Huerta San Martin.
2226 * docutils/languages/fr.py: Added to project; French mappings by
2229 * docutils/languages/it.py: Added to project; Italian mappings by
2232 * docutils/languages/sk.py: Added to project; Slovak mappings by
2235 * docutils/parser/__init__.py:
2237 - Added ``Parser.finish_parse()`` method.
2239 * docutils/parser/rst/__init__.py:
2241 - Added options: "--pep-references", "--rfc-references",
2242 "--tab-width", "--trim-footnote-reference-space".
2244 * docutils/parsers/rst/states.py:
2246 - Changed "title under/overline too short" system messages from INFO
2247 to WARNING, and fixed its insertion location.
2248 - Fixed enumerated list item parsing to allow paragraphs & section
2249 titles to begin with enumerators.
2250 - Converted system messages to use the new "line" attribute.
2251 - Fixed a substitution reference edge case.
2252 - Added support for "--pep-references" and "--rfc-references"
2253 options; reworked ``Inliner`` code to make customization easier.
2254 - Removed field argument parsing.
2255 - Added support for short section title over/underlines.
2256 - Fixed "simple reference name" regexp to ignore text like
2257 "object.__method__"; not an anonymous reference.
2258 - Added support for improved diagnostics.
2259 - Reworked directive API, based on Dethe Elza's contribution. Added
2260 ``Body.parse_directive()``, ``.parse_directive_options()``,
2261 ``.parse_directive_arguments()`` methods.
2262 - Added ``ExtensionOptions`` class, to parse directive options
2263 without parsing field bodies. Factored
2264 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2265 ``ExtensionOptions``.
2266 - Improved definition list term/classifier parsing.
2267 - Added warnings for unknown directives.
2268 - Renamed ``Stuff`` to ``Struct``.
2269 - Now flagged as errors: transitions at the beginning or end of
2270 sections, empty sections (except title), and empty documents.
2271 - Updated for ``statemachine.StringList``.
2272 - Enabled recognition of schemeless email addresses in targets.
2273 - Added support for embedded URIs in hyperlink references.
2274 - Added backslash-escapes to inline markup end-string suffix.
2275 - Added support for correct interpreted text processing.
2276 - Fixed nested title parsing (topic, sidebar directives).
2277 - Added special processing of backslash-escaped whitespace (idea
2278 from David Abrahams).
2279 - Made substitutions case-sensitive-but-forgiving; moved some code
2280 to ``docutils.nodes``.
2281 - Added support for block quote attributions.
2282 - Added a kludge to work-around a conflict between the bubble-up
2283 parser strategy and short titles (<= 3 char-long over- &
2284 underlines). Fixes SF bug #738803 "infinite loop with multiple
2285 titles" submitted by Jason Diamond.
2286 - Added explicit interpreted text roles for standard inline markup:
2287 "emphasis", "strong", "literal".
2288 - Implemented "superscript" and "subscript" interpreted text roles.
2289 - Added initial support for "abbreviation" and "acronym" roles;
2291 - Added support for "--trim-footnote-reference-space" option.
2292 - Optional space before colons in directives & hyperlink targets.
2294 * docutils/parsers/rst/tableparser.py:
2296 - Fixed a bug that was producing unwanted empty rows in "simple"
2298 - Detect bad column spans in "simple" tables.
2300 * docutils/parsers/rst/directives: Updated all directive functions to
2303 * docutils/parsers/rst/directives/__init__.py:
2305 - Added ``flag()``, ``unchanged()``, ``path()``,
2306 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2307 directive option helper functions.
2308 - Added warnings for unknown directives.
2309 - Return ``None`` for missing directives.
2310 - Added ``register_directive()``, thanks to William Dode and Paul
2313 * docutils/parsers/rst/directives/admonitions.py:
2315 - Added "admonition" directive.
2317 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2318 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2319 "parsed-literal", "rubric", "epigraph", "highlights" and
2320 "pull-quote" directives.
2322 * docutils/parsers/rst/directives/images.py:
2324 - Added an "align" attribute to the "image" & "figure" directives
2325 (by Adam Chodorowski).
2326 - Added "class" option to "image", and "figclass" to "figure".
2328 * docutils/parsers/rst/directives/misc.py:
2330 - Added "include", "raw", and "replace" directives, courtesy of
2332 - Added "unicode" and "class" directives.
2334 * docutils/parsers/rst/directives/parts.py:
2336 - Added the "sectnum" directive; by Dmitry Jemerov.
2337 - Added "class" option to "contents" directive.
2339 * docutils/parsers/rst/directives/references.py: Added to project.
2340 Contains the "target-notes" directive.
2342 * docutils/parsers/rst/languages/__init__.py:
2344 - Return ``None`` from get_language() for missing language modules.
2346 * docutils/parsers/rst/languages/de.py: Added to project; German
2347 mappings by Engelbert Gruber.
2349 * docutils/parsers/rst/languages/en.py:
2351 - Added interpreted text roles mapping.
2353 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2354 mappings by Marcelo Huerta San Martin.
2356 * docutils/parsers/rst/languages/fr.py: Added to project; French
2357 mappings by William Dode.
2359 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2360 mappings by Nicola Larosa.
2362 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2363 mappings by Miroslav Vasko.
2365 * docutils/readers/__init__.py:
2367 - Added support for the observer pattern from ``utils.Reporter``, in
2368 ``Reader.parse`` and ``Reader.transform``.
2369 - Removed ``Reader.transform()`` method.
2370 - Added default parameter values to ``Reader.__init__()`` to make
2371 instantiation easier.
2372 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2374 * docutils/readers/pep.py:
2376 - Added the ``peps.TargetNotes`` transform to the Reader.
2377 - Removed PEP & RFC reference detection code; moved to
2378 parsers/rst/states.py as options (enabled here by default).
2379 - Added support for pre-acceptance PEPs (no PEP number yet).
2380 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2383 * docutils/readers/python: Python Source Reader subpackage added to
2384 project, including preliminary versions of:
2387 - moduleparser.py: Parser for Python modules.
2389 * docutils/transforms/__init__.py:
2391 - Added ``Transformer`` class and completed transform reform.
2392 - Added unknown_reference_resolvers list for each transformer. This list holds
2393 the list of functions provided by each component of the transformer that
2394 help resolve references.
2396 * docutils/transforms/frontmatter.py:
2398 - Improved support for generic fields.
2399 - Fixed bibliographic field language lookups.
2401 * docutils/transforms/misc.py: Added to project. Miscellaneous
2404 * docutils/transforms/parts.py:
2406 - Moved the "id" attribute from TOC list items to the references
2407 (``Contents.build_contents()``).
2408 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2409 - Added "class" attribute support to ``Contents``.
2411 * docutils/transforms/peps.py:
2413 - Added ``mask_email()`` function, updating to pep2html.py's
2415 - Linked "Content-Type: text/x-rst" to PEP 12.
2416 - Added the ``TargetNotes`` PEP-specific transform.
2417 - Added ``TargetNotes.cleanup_callback``.
2418 - Added title check to ``Headers``.
2420 * docutils/transforms/references.py:
2422 - Added the ``TargetNotes`` generic transform.
2423 - Split ``Hyperlinks`` into multiple transforms.
2424 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2425 - Added check for circular indirect references.
2426 - Made substitutions case-sensitive-but-forgiving.
2428 * docutils/transforms/universal.py:
2430 - Added support for the "--expose-internal-attributes" option.
2431 - Removed ``Pending`` transform classes & data.
2433 * docutils/writers/__init__.py:
2435 - Removed ``Writer.transform()`` method.
2437 * docutils/writers/docutils-xml.py:
2439 - Added XML and doctype declarations.
2440 - Added "--no-doctype" and "--no-xml-declaration" options.
2442 * docutils/writers/html4css1.py:
2444 - "name" attributes only on these tags: a, applet, form, frame,
2446 - Added "name" attribute to <a> in section titles for Netscape 4
2447 support (bug report: Pearu Peterson).
2448 - Fixed targets (names) on footnote, citation, topic title,
2449 problematic, and system_message nodes (for Netscape 4).
2450 - Changed field names from "<td>" to "<th>".
2451 - Added "@" to "@" encoding to thwart address harvesters.
2452 - Improved the vertical whitespace optimization; ignore "invisible"
2453 nodes (targets, comments, etc.).
2454 - Improved inline literals with ``<span class="pre">`` around chunks
2455 of text and `` `` for runs of spaces.
2456 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2457 ``self.docinfo`` segments.
2458 - Added support for "line_block", "address" elements.
2459 - Improved backlinks (footnotes & system_messages).
2460 - Improved system_message output.
2461 - Redefined "--stylesheet" as containing an invariant URL, used
2462 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2464 - Added "--footnote-references" option (superscript or brackets).
2465 - Added "--compact-lists" and "--no-compact-lists" options.
2466 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2467 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2468 - Improved field list rendering.
2469 - Added Docutils version to "generator" meta tag.
2470 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2471 - Improved layout of <pre> HTML source.
2472 - Fixed attribute typo on <colspec>.
2473 - Refined XML prologue.
2474 - Support for no stylesheet.
2475 - Removed "interpreted" element support.
2476 - Added support for "title_reference", "sidebar", "attribution",
2477 "rubric", and generic "admonition" elements.
2478 - Added "--attribution" option.
2479 - Added support for "inline", "subscript", "superscript" elements.
2480 - Added initial support for "abbreviation" and "acronym";
2483 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2487 - Double quotes in literal blocks (special treatment for de/ngerman).
2488 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2489 - Added "--attribution" option.
2490 - Right align attributions.
2492 * docutils/writers/pep_html.py:
2494 - Parameterized output encoding in PEP template.
2495 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2496 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2497 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2499 - Added an override on the "--footnote-references" option.
2500 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2501 - Added Docutils version to "generator" meta tag.
2502 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2506 - Added a "silent" setting for ``buildhtml.py``.
2507 - Added a "Getting Help" section.
2508 - Rearranged the structure.
2509 - Kept up to date, with new settings, command-line options etc.
2510 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2511 - Converted settings table into a definition list.
2513 * docs/rst/quickstart.txt:
2515 - Added a table of contents.
2516 - Added feedback information.
2517 - Added mention of minimum section title underline lengths.
2518 - Removed the 4-character minimum for section title underlines.
2520 * docs/rst/quickref.html:
2522 - Added a "Getting Help" section.
2523 - Added a style to make section title backlinks more subtle.
2524 - Added mention of minimum section title underline lengths.
2525 - Removed the 4-character minimum for section title underlines.
2527 * extras: Directory added to project; contains third-party modules
2528 that Docutils depends on (optparse, textwrap, roman). These are
2529 only installed if they're not already present.
2531 * licenses: Directory added to project; contains copies of license
2532 files for non-public-domain files.
2536 - Changed the focus. It's about DTD elements: structural
2537 relationships, semantics, and external (public) attributes. Not
2538 about the element class library.
2539 - Moved some implementation-specific stuff into ``docutils.nodes``
2541 - Wrote descriptions of all common attributes and parameter
2542 entities. Filled in introductory material.
2543 - Working through the element descriptions: 55 down, 37 to go.
2544 - Removed "Representation of Horizontal Rules" to
2545 spec/rst/alternatives.txt.
2547 * spec/docutils.dtd:
2549 - Added "generated" inline element.
2550 - Added "line_block" body element.
2551 - Added "auto" attribute to "title".
2552 - Changed content models of "literal_block" and "doctest_block" to
2554 - Added ``%number;`` attribute type parameter entity.
2555 - Changed ``%structural.elements;`` to ``%section.elements``.
2556 - Updated attribute types; made more specific.
2557 - Added "address" bibliographic element.
2558 - Added "line" attribute to ``system_message`` element.
2559 - Removed "field_argument" element; "field_name" may contain
2560 multiple words and whitespace.
2561 - Changed public identifier to docutils.sf.net.
2562 - Removed "interpreted" element; added "title_reference",
2563 "abbreviation", "acronym".
2564 - Removed "refuri" attribute from "footnote_reference" and
2565 "citation_reference".
2566 - Added "sidebar", "rubric", "attribution", "admonition",
2567 "superscript", "subscript", and "inline" elements.
2569 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2571 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2573 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2575 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2578 * spec/transforms.txt: Added to project.
2580 * spec/howto: Added subdirectory, for developer how-to docs.
2582 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2583 Elza, edited & extended by David Goodger.
2585 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2588 * spec/rst/alternatives.txt:
2590 - Added "Doctree Representation of Transitions" from
2592 - Updated "Inline External Targets" & closed the debate.
2593 - Added ideas for interpreted text syntax extensions.
2594 - Added "Nested Inline Markup" section.
2596 * spec/rst/directives.txt:
2598 - Added directives: "topic", "sectnum", "target-notes",
2599 "line-block", "parsed-literal", "include", "replace", "sidebar",
2600 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2602 - Formalized descriptions of directive details.
2603 - Added an "align" attribute to the "image" & "figure" directives
2604 (by Adam Chodorowski).
2605 - Added "class" options to "topic", "sidebar", "line-block",
2606 "parsed-literal", "contents", and "image"; and "figclass" to
2609 * spec/rst/interpreted.txt: Added to project. Descriptions of
2610 interpreted text roles.
2612 * spec/rst/introduction.txt:
2614 - Added pointers to material for new users.
2616 * spec/rst/reStructuredText.txt:
2618 - Disambiguated comments (just add a newline after the "::").
2619 - Updated enumerated list description; added a discussion of the
2620 second-line validity checking.
2621 - Updated directive description.
2622 - Added a note redirecting newbies to the user docs.
2623 - Expanded description of inline markup start-strings in non-markup
2625 - Removed field arguments and made field lists a generic construct.
2626 - Removed the 4-character minimum for section title underlines.
2627 - Clarified term/classifier delimiter & inline markup ambiguity
2629 - Added "Embedded URIs".
2630 - Updated "Interpreted Text" section.
2631 - Added "Character-Level Inline Markup" section.
2633 * test: Continually adding & updating tests.
2635 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2636 - Moved test/test_pep/ to test/test_readers/test_pep/.
2637 - Added test/test_readers/test_python/.
2638 - Added test/test_writers/ (Engelbert Gruber).
2642 - Made the ``locale.setlocale()`` calls in front ends
2645 * tools/buildhtml.py:
2647 - Added "--silent" option.
2648 - Fixed bug with absolute paths & "--config".
2649 - Updated for new I/O classes.
2650 - Added some exception handling.
2651 - Separated publishers' setting defaults; prevents interference.
2652 - Updated for new ``publish_file()`` convenience function.
2654 * tools/pep-html-template:
2656 - Allow for "--embed-stylesheet".
2657 - Added Docutils version to "generator" meta tag.
2658 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2659 - Conform to XHTML spec.
2661 * tools/pep2html.py:
2663 - Made ``argv`` a parameter to ``main()``.
2664 - Added support for "Content-Type:" header & arbitrary PEP formats.
2665 - Linked "Content-Type: text/plain" to PEP 9.
2666 - Files skipped (due to an error) are not pushed onto the server.
2667 - Updated for new I/O classes.
2668 - Added ``check_requirements()`` & ``pep_type_error()``.
2669 - Added some exception handling.
2670 - Updated for new ``publish_string()`` convenience function.
2671 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2673 * tools/quicktest.py:
2675 - Added "-V"/"--version" option.
2677 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2679 * tools/unicode2rstsubs.py: Added to project. Produces character
2680 entity files (reSructuredText substitutions) from the MathML master
2683 * tools/editors: Support code for editors, added to project. Contains
2684 ``emacs/restructuredtext.el``.
2686 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2688 - Added style for chunks of inline literals.
2689 - Removed margin for first child of table cells.
2690 - Right-aligned field list names.
2691 - Support for auto-numbered section titles in TOCs.
2692 - Increased the size of inline literals (<tt>) in titles.
2693 - Restored the light gray background for inline literals.
2694 - Added support for "line_block" elements.
2695 - Added style for "address" elements.
2696 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2697 - Improved field list rendering.
2698 - Vertical whitespace improvements.
2699 - Removed "a.target" style.
2701 * tools/stylesheets/pep.css:
2703 - Fixed nested section margins.
2704 - Other changes parallel those of ``../default.css``.
2707 Release 0.2 (2002-07-31)
2708 ========================
2712 - The word "component" was being used ambiguously. From now on,
2713 "component" will be used to mean "Docutils component", as in Reader,
2714 Writer, Parser, or Transform. Portions of documents (Table of
2715 Contents, sections, etc.) will be called "document parts".
2716 - Did a grand renaming: a lot of ``verylongnames`` became
2717 ``very_long_names``.
2718 - Cleaned up imports: no more relative package imports or
2719 comma-separated lists of top-level modules.
2720 - Added support for an option values object which carries default
2721 settings and overrides (from command-line options and library use).
2722 - Added internal Unicode support, and support for both input and
2724 - Added support for the ``docutils.io.IO`` class & subclasses.
2728 * docutils/__init__.py:
2730 - Added ``ApplicationError`` and ``DataError``, for use throughout
2732 - Added ``Component`` base class for Docutils components; implements
2733 the ``supports`` method.
2734 - Added ``__version__`` (thus, ``docutils.__version__``).
2738 - Removed many keyword parameters to ``Publisher.__init__()`` and
2739 ``publish()``; bundled into an option values object. Added
2740 "argv", "usage", "description", and "option_spec" parameters for
2741 command-line support.
2742 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2744 - Reworked I/O model for ``docutils.io`` wrappers.
2745 - Updated ``Publisher.set_options()``; now returns option values
2747 - Added support for configuration files (/etc/docutils.conf,
2748 ./docutils.conf, ~/.docutils).
2749 - Added ``Publisher.setup_option_parser()``.
2750 - Added default usage message and description.
2752 * docutils/frontend.py: Added to project; support for front-end
2753 (command-line) scripts. Option specifications may be augmented by
2754 components. Requires Optik (http://optik.sf.net/) for option
2755 processing (installed locally as docutils/optik.py).
2757 * docutils/io.py: Added to project; uniform API for a variety of input
2760 * docutils/nodes.py:
2762 - Added ``TreeCopyVisitor`` class.
2763 - Added a ``copy`` method to ``Node`` and subclasses.
2764 - Added a ``SkipDeparture`` exception for visitors.
2765 - Renamed ``TreePruningException`` from ``VisitorException``.
2766 - Added docstrings to ``TreePruningException``, subclasses, and
2768 - Improved docstrings.
2769 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2770 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2772 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2773 ``PreDecorative`` mixin.
2774 - Reworked the name/id bookkeeping; to ``document``, removed
2775 ``explicit_targets`` and ``implicit_targets`` attributes, added
2776 ``nametypes`` attribute and ``set_name_id_map`` method.
2777 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2779 - Added ``document.has_name()`` method.
2780 - Fixed DOM generation for list-attributes.
2781 - Added category class ``Labeled`` (used by footnotes & citations).
2782 - Added ``Element.set_class()`` method (sets "class" attribute).
2784 * docutils/optik.py: Added to project. Combined from the Optik
2785 package, with added option groups and other modifications. The use
2786 of this module is probably only temporary.
2788 * docutils/statemachine.py:
2790 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2791 - Added underscores to improve many awkward names.
2792 - In ``string2lines()``, changed whitespace normalizing translation
2793 table to regexp; restores Python 2.0 compatibility with Unicode.
2795 * docutils/urischemes.py:
2797 - Filled in some descriptions.
2798 - Added "shttp" scheme.
2800 * docutils/utils.py:
2802 - Added ``clean_rcs_keywords`` function (moved from
2803 docutils/transforms/frontmatter.py
2804 ``DocInfo.filter_rcs_keywords``).
2805 - Added underscores to improve many awkward names.
2806 - Changed names of Reporter's thresholds:
2807 warning_level -> report_level; error_level -> halt_level.
2808 - Moved ``utils.id()`` to ``nodes.make_id()``.
2809 - Added ``relative_path(source, target)``.
2811 * docutils/languages/de.py: German mappings; added to project. Thanks
2812 to Gunnar Schwant for the translations.
2814 * docutils/languages/en.py: Added "Dedication" bibliographic field
2817 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2820 * docutils/parsers/rst/states.py:
2822 - Added underscores to improve many awkward names.
2823 - Added RFC-2822 header support.
2824 - Extracted the inline parsing code from ``RSTState`` to a separate
2825 class, ``Inliner``, which will allow easy subclassing.
2826 - Made local bindings for ``memo`` container & often-used contents
2827 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2828 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2829 - Added ``MarkupMismatch`` exception; for late corrections.
2830 - Added ``-/:`` characters to inline markup's start string prefix,
2831 ``/`` to end string suffix.
2832 - Fixed a footnote bug.
2833 - Fixed a bug with literal blocks.
2834 - Applied patch from Simon Budig: simplified regexps with symbolic
2835 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2836 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2837 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2838 - Allowed non-ASCII in "simple names" (directive names, field names,
2840 - Converted ``Inliner.patterns.initial`` to be dynamically built
2841 from parts with ``build_regexp()`` function.
2842 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2843 - Updated docstrings.
2844 - Changed "table" to "grid_table"; added "simple_table" support.
2846 * docutils/parsers/rst/tableparser.py:
2848 - Changed ``TableParser`` to ``GridTableParser``.
2849 - Added ``SimpleTableParser``.
2850 - Refactored naming.
2852 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2853 a fallback language for directive names.
2855 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2856 directive to use a ``pending`` element, used only by HTML writers.
2858 * docutils/parsers/rst/directives/parts.py: Renamed from
2861 - Added "backlinks" attribute to "contents" directive.
2863 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2864 project by Adam Chodorowski.
2866 * docutils/readers/__init__.py: Gave Readers more control over
2867 choosing and instantiating Parsers.
2869 * docutils/readers/pep.py: Added to project; for PEP processing.
2871 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2872 requires a ``component`` parameter.
2874 * docutils/transforms/components.py: Added to project; transforms
2875 related to Docutils components.
2877 * docutils/transforms/frontmatter.py:
2879 - In ``DocInfo.extract_authors``, check for a single "author" in an
2880 "authors" group, and convert it to a single "author" element.
2881 - Added support for "Dedication" and generic bibliographic fields.
2883 * docutils/transforms/peps.py: Added to project; PEP-specific.
2885 * docutils/transforms/parts.py: Renamed from old components.py.
2887 - Added filter for `Contents`, to use alt-text for inline images,
2888 and to remove inline markup that doesn't make sense in the ToC.
2889 - Added "name" attribute to TOC topic depending on its title.
2890 - Added support for optional TOC backlinks.
2892 * docutils/transforms/references.py: Fixed indirect target resolution
2893 in ``Hyperlinks`` transform.
2895 * docutils/transforms/universal.py:
2897 - Changed ``Messages`` transform to properly filter out system
2898 messages below the warning threshold.
2899 - Added ``Decorations`` transform (support for ``--generator``,
2900 ``--date``, ``--time``, ``--source-link`` options).
2902 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2903 Engelbert Gruber's PDF writer.
2905 * docutils/writers/html4css1.py:
2907 - Made XHTML-compatible (switched to lowercase element & attribute
2908 names; empty tag format).
2909 - Escape double-dashes in comment text.
2910 - Improved boilerplate & modularity of output.
2911 - Exposed modular output in Writer class.
2912 - Added a "generator" meta tag to <head>.
2913 - Added support for the ``--stylesheet`` option.
2914 - Added support for ``decoration``, ``header``, and ``footer``
2916 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2917 translation table to regexp; restores Python 2.0 compatibility
2919 - Added the translator class as instance variable to the Writer, to
2920 make it easily subclassable.
2921 - Improved option list spacing (thanks to Richard Jones).
2922 - Modified field list output.
2923 - Added backlinks to footnotes & citations.
2924 - Added percentage widths to "<col>" tags (from colspec).
2925 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2926 "<span>" changed to "<var>".
2927 - Inline literals: "<code>" changed to "<tt>".
2928 - Many changes to optimize vertical space: compact simple lists etc.
2929 - Add a command-line options & directive attributes to control TOC
2930 and footnote/citation backlinks.
2931 - Added support for optional footnote/citation backlinks.
2932 - Added support for generic bibliographic fields.
2933 - Identify backrefs.
2934 - Relative URLs for stylesheet links.
2936 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2937 PEPs (subclass of ``html4css1.Writer``).
2939 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2941 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2942 of the Docutils internal doctree in XML.
2944 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2948 - Changed the title to "The Docutils Document Tree".
2949 - Added "Hyperlink Bookkeeping" section.
2951 * spec/docutils.dtd:
2953 - Added ``decoration``, ``header``, and ``footer`` elements.
2954 - Brought ``interpreted`` element in line with the parser: changed
2955 attribute "type" to "role", added "position".
2956 - Added support for generic bibliographic fields.
2958 * spec/notes.txt: Continual updates. Added "Project Policies".
2960 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2963 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2965 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2966 mailing list discussions.
2968 * spec/pep-0287.txt:
2970 - Renamed to "reStructuredText Docstring Format".
2972 - Reworked Q&A as an enumerated list.
2973 - Converted to reStructuredText format.
2975 * spec/pysource.dtd:
2977 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2979 * spec/pysource.txt: Removed from project. Moved much of its contents
2982 * spec/rst/alternatives.txt:
2984 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2985 - Added "Inline External Targets" section.
2987 * spec/rst/directives.txt:
2989 - Added "backlinks" attribute to "contents" directive.
2991 * spec/rst/problems.txt:
2993 - Updated the Enumerated List Markup discussion.
2994 - Added new alternative table markup syntaxes.
2996 * spec/rst/reStructuredText.txt:
2998 - Clarified field list usage.
2999 - Updated enumerated list description.
3000 - Clarified purpose of directives.
3001 - Added ``-/:`` characters to inline markup's start string prefix,
3002 ``/`` to end string suffix.
3003 - Updated "Authors" bibliographic field behavior.
3004 - Changed "inline hyperlink targets" to "inline internal targets".
3005 - Added "simple table" syntax to supplement the existing but
3006 newly-renamed "grid tables".
3007 - Added cautions for anonymous hyperlink use.
3008 - Added "Dedication" and generic bibliographic fields.
3010 * test: Made test modules standalone (subdirectories became packages).
3012 * test/DocutilsTestSupport.py:
3014 - Added support for PEP extensions to reStructuredText.
3015 - Added support for simple tables.
3016 - Refactored naming.
3018 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3020 - Now supports true packages containing test modules
3021 (``__init__.py`` files required); fixes duplicate module name bug.
3023 * test/test_pep/: Subpackage added to project; PEP testing.
3025 * test/test_rst/test_SimpleTableParser.py: Added to project.
3029 - Updated html.py and publish.py front-end tools to use the new
3030 command-line processing facilities of ``docutils.frontend``
3031 (exposed in ``docutils.core.Publisher``), reducing each to just a
3033 - Added ``locale.setlocale()`` calls to front-end tools.
3035 * tools/buildhtml.py: Added to project; batch-generates .html from all
3036 the .txt files in directories and subdirectories.
3038 * tools/default.css:
3040 - Added support for ``header`` and ``footer`` elements.
3041 - Added styles for "Dedication" topics (biblio fields).
3043 * tools/docutils.conf: A configuration file; added to project.
3045 * tools/docutils-xml.py: Added to project.
3047 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3049 * tools/pep-html-template: Added to project.
3051 * tools/pep2html.py: Added to project from Python (nondist/peps).
3052 Added support for Docutils (reStructuredText PEPs).
3054 * tools/quicktest.py:
3056 - Added the ``--attributes`` option, hacked a bit.
3057 - Added a second command-line argument (output file); cleaned up.
3059 * tools/stylesheets/: Subdirectory added to project.
3061 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3064 Release 0.1 (2002-04-20)
3065 ========================
3067 This is the first release of Docutils, merged from the now inactive
3068 reStructuredText__ and `Docstring Processing System`__ projects. For
3069 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3070 `DPS HISTORY`__ files.
3072 __ http://structuredtext.sourceforge.net/
3073 __ http://docstring.sourceforge.net/
3074 __ http://structuredtext.sourceforge.net/HISTORY.html
3075 __ http://docstring.sourceforge.net/HISTORY.html
3077 General changes: renamed 'dps' package to 'docutils'; renamed
3078 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3079 the test suites (reStructuredText's test/test_states renamed to
3080 test/test_rst); and all modifications required to make it all work.
3082 * docutils/parsers/rst/states.py:
3084 - Improved diagnostic system messages for missing blank lines.
3085 - Fixed substitution_reference bug.
3091 indent-tabs-mode: nil
3092 sentence-end-double-space: t