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 - removed the `handle_io_errors` option from io.FileInput/Output.
25 - Fix [ 253 ] Attribute key without value not allowed in XML.
27 * docutils/parsers/rst/__init__.py
29 - Fix [ 233 ] Change the base URL for the :rfc: role.
31 * docutils/parsers/rst/directives/tables.py
33 - Patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
36 * docutils/utils/math/math2html.py
38 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
39 - New upstream version (additional macros, piecewise integrals and sums).
41 * docutils/writers/html_base/
43 - New HTML writer generating basic HTML (`polyglot markup`_ conforming to
44 both, `HTML 5`_ and `XHTML 1.0`_ (transitional)).
46 New stylesheet ``html-base.css`` for default layout using CSS 2.1 rules.
48 Also base for the `xhtml11` writer.
50 * docutils/writers/html4css1/__init__.py
52 - Add "docutils" to class values for "container" object to address [ 267 ].
53 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
54 ``default_stylesheet_path`` and ``default_template_path``.
55 - Fix [ 266 ] creating labels/class values in description list items.
56 - Wrap literal blocks in a <span> to support sub- and superscript (not
57 allowed in <pre> but possible in parsed-literal).
59 * docutils/writers/latex2e/__init__.py
61 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
62 admonitions and docinfo.
64 - Use absolute path for ``default_template_path``.
66 - Removed deprecated options ``--use-latex-footnotes`` and
67 ``--figure-footnotes``.
69 - Cleaner LaTeX code for enumerations and literal blocks.
71 - Use "hyperref" package together with "bookmark" (improved hyperlinking
74 * docutils/writers/odf_odt/__init__.py
76 - remove decode.encode of filename stored in zip.
78 * docutils/writers/xetex/__init__.py
80 - LuaLaTex compatibility: do not load "xunicode".
82 * docutils/writers/xhtml11/
84 - New HTML writer generating `XHTML 1.1`_ styled with CSS2.1
85 Moved to the docutils core from sandbox/html4strict.
90 - New front-ends ``rst2xhtml.py`` and ``rst2html5.py`` for the
91 corresponding writers.
93 .. _polyglot markup: http://www.w3.org/TR/html-polyglot/
94 .. _HTML 5: http://www.w3.org/TR/html5/
95 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
96 .. _XHTML 1.1: http://www.w3.org/TR/xhtml11/
99 Release 0.12 (2014-07-06)
100 =========================
102 * docs/ref/rst/directives.txt
104 - Update "math" and "csv-table" descriptions.
106 * docutils/parsers/rst/directives/images.py
108 - Fix [ 258 ] figwidth="image" generates unitless width value.
110 * docutils/parsers/rst/states.py
112 - Improve error report when a non-ASCII character is specified as
113 delimiter, quote or escape character under Python 2.
114 Fixes [ 249 ] and [ 250 ].
116 * docutils/writers/html4css1/__init__.py
118 - Don't add newline after inline math.
119 Thanks to Yury G. Kudryashov for the patch.
121 * docutils/writers/latex2e/__init__.py
123 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
124 - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
126 * docutils/writers/odf_odt/__init__.py
128 - Apply patch by Jakub Wilk to fix bug [ 100 ].
130 * test/test_error_reporting.py
132 - Fix [ 223 ] by removing redundant tests we do not have control over.
136 - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
138 Release 0.11 (2013-07-22)
139 =========================
143 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
144 - Support embedded aliases within hyperlink references.
145 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
146 language module) before global search.
150 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
152 * docutils/parsers/rst/directives/__init__.py
154 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
156 * docutils/parsers/rst/directives/images.py
158 - Apply [ 3599485 ] node source/line information for sphinx translation.
160 * docutils/parsers/rst/directives/tables.py
162 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
164 * docutils/parsers/rst/states.py
166 - Fix [ 157 ] Line block parsing doesn't like system message.
167 - Always import our local copy of roman.py (report Larry Hastings).
169 * docutils/transforms/references.py
171 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
173 * docutils/utils/__init__.py
175 - Fix [ 3596884 ] exception importing ``docutils.io``.
177 * docutils/writers/html4css1/__init__.py
179 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
180 - New setting `stylesheet_dirs`: Comma-separated list of directories
181 where stylesheets are found. Used by `stylesheet_path` when expanding
182 relative path arguments.
183 - New default for math-output_: ``HTML math.css``.
184 - Avoid repeated class declarations in html4css1 writer
185 (modified version of patch [ 104 ]).
187 .. _math-output: docs/user/config.html#math-output
189 * docutils/writers/latex2e/__init__.py
191 - Drop the simple algorithm replacing straight double quotes with
192 English typographic ones.
193 Activate the SmartQuotes_ transform if you want this feature.
194 - Fix literal use of babel shorthands (straight quote, tilde, ...).
195 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
196 - New setting `stylesheet_dirs`.
198 .. _SmartQuotes: docs/user/config.html#smart-quotes
200 * docutils/writers/manpage.py
202 - Fix [3607063] handle lines starting with a period.
203 - Fix option separating comma was bold (thanks to Bill Morris).
205 Release 0.10 (2012-12-16)
206 =========================
210 - Dropped support for Python 2.3.
211 - ``docutils/math``, ``docutils/error_reporting.py``, and
212 ``docutils/urischemes.py`` moved to the utils package.
213 - Fix [3541369] Relative __import__ also with Python 3.3.
214 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
215 and parsers for Python 2.7 up.
216 - Fix import of PIL.Image.
217 - Change default of "syntax highlight" option to "long",
218 basic syntax highlight styles for LaTeX and HTML.
222 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
223 option is ignored and will be removed in a future release.
224 - Fix Py3k error writing to stdout with encoding differing from default.
225 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
227 * docutils/parsers/rst/directives/misc.py
229 - Fix [ 3546533 ] Unicode error with `date` directive.
231 * docutils/transforms/universal.py
233 - SmartQuotes transform for typographic quotes and dashes.
235 * docutils/utils/__init__.py
237 - normalize_language_tag() now returns `BCP 47`_ conformant tags
238 with subtags separated by ``-``.
240 * docutils/writers/html4css1/__init__.py
242 - Use ``<code>`` tag for inline "code",
243 do not drop nested inline nodes (syntax highlight tokens).
244 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
245 - No line break after opening inline math tag.
247 * docutils/writers/manpage.py
249 - Apply [ 3527401 ] addmonition's don't preserve indentation
250 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
252 * docutils/writers/xetex/__init__.py
254 - Apply [ 3555160 ] ensure order of "otherlanguages".
255 - Fix section numbering by LaTeX.
257 * docutils/writers/s5_html/__init__.py
259 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
261 * docutils/writers/s5_html/docutils_xml.py
263 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
267 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
269 * tools/test/test_buildhtml.py
271 - Fix [ 3521167 ] allow running in any directory.
272 - Fix [ 3521168 ] allow running with Python 3.
275 Release 0.9.1 (2012-06-17)
276 ==========================
280 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
281 installed in the PYTHONPATH. Converted tests are now
282 stored in ``test3/``, tools no longer need conversion.
284 If you installed one of Docutils versions 0.7 ... 0.9 with
285 ``setup.py install`` under Python 3, remove the spurious
286 ``test/`` and ``tools/`` directories in the site library root.
290 - Make tests independent from the location of the ``test/`` directory.
291 - Use converted sources (from the ``build/`` directory) for tests under
296 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
300 - Fix writing binary data to sys.stdout under Python 3 (allows
301 ``rst2odt.py`` to be used with output redirection).
303 * docutils/parsers/rst/directives/misc.py
305 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
306 ``locale == C`` and 8-bit char in path argument of `include` directive.
310 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
313 Release 0.9 (2012-05-02)
314 ========================
318 - New reStructuredText "code" role and directive and "code" option
319 of the "include" directive with syntax highlighting by Pygments_.
320 - Fix parse_option_marker for option arguments containing ``=``.
321 - Fix [ 2993756 ]: import Python Imaging Library's Image module
322 via ``import PIL`` as starting with PIL 1.2,
323 "PIL lives in the PIL namespace only" (announcement__).
325 .. _Pygments: http://pygments.org/
326 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
330 - Fix [ 2971827 ] and [ 3442827 ]
331 extras/roman.py moved to docutils/utils/roman.py
333 * docutils/frontend.py
335 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
339 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
340 - `mode` argument for FileOutput avoids code replication in
342 - New exceptions InputError and OutputError for IO errors in
343 FileInput/FileOutput.
347 - No "hard" system exit on file IO errors: catch and report them in
348 `Publisher.reportException` instead. Allows handling by a calling
349 application if the configuration setting `traceback` is True.
351 * docutils/utils.py -> docutils/utils/__init__.py
353 - docutils.utils is now a package (providing a place for sub-modules)
355 .. note:: docutils/math, docutils/error_reporting.py, and
356 docutils/urischemes.py will move to the utils package in the next
357 release, too. See RELEASE-NOTES__
359 __ RELEASE-NOTES.html
361 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
362 errors recording non-ASCII filenames (fixes [ 3434355 ]).
364 - Fix relative_path() with source=None and `unicode` target.
366 * docutils/parsers/rst/states.py
368 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
369 characters and "international" quotes around inline markup.
370 - Use `field_marker` pattern to look for start of a
371 directive option block (fixes [ 3484857 ]).
373 * docutils/parsers/rst/tableparser.py
375 - Fix [ 2926161 ] for simple tables.
376 (Combining chars in grid tables still contribute to cell width.)
378 * docutils/writers/latex2e/__init__.py
380 - Support the `abbreviation` and `acronym` standard roles.
381 - Record only files required to generate the LaTeX source as dependencies.
382 - Fix handling of missing stylesheets.
383 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
384 when suppressing LaTeX section numbering.
385 - Use ``\DUtitle`` for unsupported section levels
386 - Apply [ 3512791 ] do not compare string literals with "is"
388 * docutils/writers/xetex/__init__.py
390 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
392 * docutils/writers/html4css1/__init__.py
394 - Change default for `math-output` setting to MathJax.
395 - Fix handling of missing stylesheets.
397 * docutils/writers/docutils_xml.py
399 - Use the visitor pattern with default_visit()/default_depart() methods
400 instead of minidom to facilitate special handling of selected nodes.
401 - Support raw XML (inserted as-is inside a <raw></raw> node).
403 * docutils/writers/manpage.py
405 - Do not emit comment line with trailing blank. Problematic for VCS.
407 Release 0.8.1 (2011-08-30)
408 ==========================
412 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
413 and [ 3395920 ] (correct copyright info for rst.el).
417 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
419 * docutils/writers/latex2e/__init__.py
421 - Clean up Babel language setting. Restores Sphinx compatibility.
423 Release 0.8 (2011-07-07)
424 ========================
428 - Handle language codes according to `BCP 47`_.
429 - If the specified language is not supported by Docutils,
430 warn and fall back to English.
431 - Math support: reStructuredText "math" role and directive,
432 ``math`` and ``math_block`` doctree elements.
433 - Decode command line arguments with the locale's preferred encoding
434 (to allow, e.g., ``--title=Dornröschen``).
435 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
436 - New sub-module `error_reporting`: handle encoding/decoding errors
437 when reporting exceptions.
438 - Some additions to the Docutils core are released under the 2-Clause BSD
439 license, see COPYING_ for details.
441 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
442 .. _COPYING: COPYING.html
446 - Most directives now support a "name" option that attaches a
449 - Directive content may start on the first line also when the directive
450 type accepts options.
452 * docs/dev/policies.txt:
454 - Recommend the 2-Clause BSD license
455 (http://www.spdx.org/licenses/BSD-2-Clause)
456 for code that is kept under the author's copyright.
458 * tools/buildhtml.py:
460 - Fix ``--local`` switch.
462 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
464 * docutils/writers/html4css1/__init__.py
466 - Set "lang" argument for objects with class argument
467 "language-<language tag>".
468 - New setting "math-output" with support for HTML, MathML, and LaTeX.
470 * docutils/writers/latex2e/__init__.py
472 - Fix [ 3043986 ] AttributeError using :local: with table of content.
473 - Place title data in the document preamble.
474 - Load `babel` package only if required.
475 - Update list of supported languages.
476 - New config setting "hyperref-options".
477 No hard-coded "unicode" hyperref option (clash with xetex).
478 - Set language for custom roles, paragraphs, block-quotes, and
479 line-quotes with class argument "language-<language tag>".
480 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
481 - Convert image URI to a local file path.
482 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
483 has more than one paragraph (Wolfgang Scherer).
484 - \leavevmode before longtable only when needed (prevents spurious vspace)
485 - do not advance table counter for tables without caption
487 * docutils/writers/xetex/__init__.py
489 - New writer generating LaTeX code for compiling with ``xelatex``.
491 A separate writer (inheriting from latex2e) instead of a ``--xetex``
492 option allows separate config options for XeTeX vs. LaTeX2e.
494 * docutils/writers/manpage.py
496 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
497 - Fix: vertical space cleaning for option group ``.``.
499 * tools/editors/emacs/rst.el:
501 - Fix [ 3001100 ] does not handle spaces in filenames
502 (thanks to Jakub Wilk)
506 - strip whitespace from stylesheet arguments
507 - exclude combining chars from column_width()
508 (partial fix for [ 2926161 ])
510 * docutils/parsers/rst/directives/misc.py:
512 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
517 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
518 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
520 Release 0.7 (2010-07-07)
521 ========================
525 - Fix [ 2881769 ] setup configuration.
526 - Fix [ 2788716 ] reporting problems in included files.
530 - FileInput opens files as text files with universal newline support
531 (mode "rU", configurable with the new optional argument "mode").
535 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
539 - Fix [ 2923723 ] let decode_path() tolerate path == None
541 * docutils/writers/html4css1/__init__.py
543 - Support SVG and SWF images (thanks to Stefan Rank).
544 - Generate valid XHTML for centered images with targets.
545 Use CSS classes instead of "align" tags for image alignment.
547 * docutils/writers/latex2e/__init__.py
549 - Use `transforms.writer_aux.Admonitions` to "normalize" special
551 - Use the ``\url`` command for URLs (breaks long URLs instead of
552 writing into the margin).
553 - Preserve runs of spaces in `inline literals`__.
554 - Deprecate ``figure_footnotes`` setting.
555 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
556 - New ``latex_preamble`` setting.
557 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
558 - Fix hyperlink targets (labels) for images, figures, and tables.
559 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
560 - Apply [ 2961991 ] Call hyperref with unicode option.
561 - Drop the special `output_encoding`__ default ("latin-1").
562 The Docutils wide default (usually "UTF-8") is used instead.
563 - Render inline markup in document title and subtitle.
564 - Fix numbering depth with LaTeX section numbering.
565 - Update Unicode -> LaTeX translations.
566 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
568 __ docs/ref/restructuredtext.html#inline-literals
569 __ docs/user/config.html#docutils-footnotes
570 __ docs/user/config.html#output_encoding
572 * docutils/writers/manpage.py
574 - Fix: supported attribute (thanks to peter2108).
575 - Remove trailing blanks in code (keep in sync with mercurial version).
576 - Titles level 1, that is ``.SH``, always uppercase.
577 - Apply patch from mg: literal text should be bold in man-pages.
581 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
586 - Python 3 support: copy test/ and tools/ to the build-dir
587 and convert Python sources with 2to3.
590 Release 0.6 (2009-10-11)
591 ========================
595 - Docutils is now compatible with Python versions from 2.3 up to 2.6
596 and convertible to 3.1 code.
598 + Node.__nonzero__ returns True instead of 1.
599 + use os.walk instead os.path.walk.
600 + minimize "types" module where possible.
601 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
602 + Text nodes now subclass unicode rather than UserString
603 (which is gone in python 3.0).
604 + 3.0 compatibility module docutils._compat
606 + Drop 2.2 compatibility workarounds.
607 + Drop extras/optparse.py and extras/textwrap.py
608 (stdlib modules since 2.3).
610 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
611 - Unix man page export: manpage writer moved from sandbox to Doctutils
614 - Apply [ 1719345 ] Galician translation
615 - Apply [ 1905741 ] Polish translation
616 - Apply [ 1878977 ] make_id(): deaccent characters.
617 - Apply [ 2029251 ] return nonzero when tests fail.
618 - Fix [ 1692788 ] allow UTF-8 in style sheets.
619 - Fix [ 2781629 ] support non-ASCII chars in file names.
620 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
621 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
622 - Fix [ 2821266 ] --strict option works now like --halt=info.
623 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
624 - Fix [ 1627229 ] hyperlink references in substitutions.
626 - The "newlatex" writer is orphaned.
630 - Documented Unicode characters allowed as inline markup openers,
631 closers, and delimiters.
632 - Allow units for all length specifications.
633 - Allow percent sign in "scale" argument of "figure" and "image" directives.
634 - Bugfix: The "figalign" argument of a figure now works as intended
635 (aligning the figure, not its contents).
636 - Align images with class "align-[right|center|left]"
637 (allows setting the alignment of an image in a figure).
641 - Added ``Element.__contains__`` method, for the in-operator.
643 * docutils/parsers/rst/states.py:
645 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
646 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
647 " " (non-breaking space), and "¡ ¿" openers.
649 * docutils/parsers/directives/misc.py:
651 - Added ``start-line`` and ``end-line`` options to "include"
652 directive to select a range of lines.
653 - Hard tabs in literal inclusions are replaced by spaces. This is
654 configurable via the new ``tab-width`` option of the "include" directive
655 (a negative tab-width prevents tab expansion).
659 - Add ``get_stylesheet_list`` function.
660 - Apply [ 2834836 ] print info at halt
662 * docutils/transforms/universal.py:
664 - Raise default priority of StripClasses to exclude stripped classes from
667 * docutils/writers/html4css1/__init__.py:
669 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
670 separated list of stylesheets.
671 - Address [ 1938891 ] Inline literal text creates "pre" span only when
672 needed to prevent inter-word line wraps.
673 - Use `translate` method instead of repeated `replace` calls.
674 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
675 classes to allow CSS styling that does not interfere with other
676 table-using constructs (field lists, citations, ...).
678 * docutils/writers/newlatex2e/__init__.py:
680 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
682 * docutils/writers/latex2e/__init__.py (see also
683 `<docs/user/docutils-05-compat.sty.html>`__) :
685 - Add ``--embed-stylesheet`` option.
686 - Apply [ 1474017 ] image vertical alignment is reversed.
687 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
688 - Change: has_key for dictionaries (not Nodes) to in-operator.
689 - Merge adjacent citations into one latex cite command.
690 - Failsave implementation of custom roles. LaTeX compilation now ignores
691 unknown classes instead of aborting with an error.
692 - Support custom roles based on standard roles.
693 - LaTeX packages can be used as ``--stylesheet`` arguments without
694 restriction. (A style sheet is now referenced with the ``\usepackage``
695 command, if it ends with ``.sty`` or has no extension.)
696 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
697 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
698 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
699 2005-02-04 as a configurable length unit).
700 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
701 if font-encoding is set to ''. LaTeX defaults to OT1 then.
702 - Set sub- and superscript role argument in text mode not as math.
703 Use a custom role based on sub-/superscript if you want italic shape.
704 - Shorter preamble and less dependencies: Load packages and define macros
705 only if required in the document.
706 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
707 - New custom environments and commands with optional "classes" argument.
708 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
709 - Better conformance to Docutils specifications with ``--use-latex-toc``.
710 Support for LaTeX generated ToC also with unnumbered sections.
711 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
712 section numbering by LaTeX.
713 - Use default font in admonitions and sidebar.
714 - Align of image in a figure defaults to 'center'.
715 - Bugfix: Newlines around targets and references prevent run-together
717 - Fix internal hyperlinks.
718 - Use class defaults for page margins ('typearea' now optional).
719 - Float placement made configurable, default changed to "here definitely".
720 - Typeset generic topic as "quote block with title".
721 - Use template (file and configuration option).
722 - In the default template, load cmap.sty (fix text extraction in PDF) and
723 fixltx2e.sty (LaTeX patches, \textsubscript).
724 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
725 - Use `translate` instead of repeated `replace` calls for text encoding.
726 - Hyperlinked footnotes and support for symbol footnotes and
727 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
728 - Complete pairs of binary options
729 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
730 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
732 - font-encoding: "T1" (formerly implicitely set by 'ae').
733 - use-latex-toc: true (ToC with page numbers).
734 - use-latex-footnotes: true (no mixup with figures).
736 * docutils/writers/manpage.py
738 - Do not print version at document end, this is done by the viewer.
739 - Do not print date at document end, this is done by the viewer.
740 - Fix storage of docinfo fields for none standard fields.
742 * docutils/tools/rst2man.py
744 Release 0.5 (2008-06-25)
745 ========================
747 * docutils/languages/he.py: Added to project: Hebrew mappings by
750 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
751 mappings by Meir Kriheli.
753 * docutils/frontend.py:
755 - Configuration files are now assumed and required to be
757 - Paths of applied configuration files are now recorded in the
758 runtime setting ``_config_files`` (accessible via
759 ``--dump-settings``).
760 - Added ``--strip-elements-with-class`` and ``--strip-class``
761 options (``strip_elements_with_classes`` and ``strip_classes``
766 - Added code to determine the input encoding from data: encoding
767 declarations or the presence of byte order marks (UTF-8 & UTF-16).
768 - Added support for IronPython 1.0.
772 - Added ``document.__getstate__`` method, for pickling.
774 * docutils/parsers/rst/states.py:
776 - Allow ``+`` and ``:`` in reference names.
777 - Unquoted targets beginning with an underscore (``.. __target:
778 URI``) are no longer accepted.
779 - Added support for multiple attributions in a physical block quote
780 (indented text block), dividing it into multiple logical block
782 - Added support for unicode bullets in bullet lists: "•", "‣", and
784 - Added support for new object-oriented directive interface,
785 retaining compatibility to the old functional interface.
786 - Added support for throwing ``DirectiveError``'s from within
789 * docutils/parsers/rst/__init__.py:
791 - Added ``Directive`` base class.
792 - Added ``DirectiveError`` base class.
793 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
796 * docutils/parsers/directives/:
798 - Refactored all reStructuredText directives to use the new
799 object-oriented directive interface. Errors are now (mostly)
800 thrown using the new ``DirectiveError`` class.
802 * docutils/parsers/directives/misc.py:
804 - Added ``start-after`` and ``end-before`` options to ``include``
805 directive; thanks to Stefan Rank.
807 * docutils/transforms/universal.py:
809 - Added ``StripClassesAndElements`` transform to remove from the
810 document tree all elements with classes in
811 ``settings.strip_elements_with_classes`` and all "classes"
812 attribute values in ``self.document.settings.strip_classes``.
814 * docutils/transforms/writer_aux.py:
816 - Added ``Admonitions`` transform to transform specific admonitions
817 (like ``note``, ``warning``, etc.) into generic admonitions with a
820 * docutils/writers/html4css1/__init__.py:
822 - Moved template functionality from the PEP/HTML writer here.
823 - Expanded the fragments available in the ``parts`` attribute.
824 - Moved ``id`` attributes from titles to surrounding ``div``
826 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
827 universally supported now).
828 - ``template.txt`` is now opened in text mode instead of binary mode
829 (to ensure Windows compatibility).
830 - ``a`` elements now have an "internal" or "external" class,
831 depending on reference type.
833 * docutils/writers/html4css1/template.txt: Added to project.
835 * docutils/writers/pep_html/:
837 - Moved template functionality to the HTML writer.
839 * docutils/writers/s5_html/__init__.py:
841 - Added ``view_mode`` & ``hidden_controls`` settings
842 (``--view-mode`` & ``--hidden-controls/--visible-controls``
845 * docutils/writers/latex2e/__init__.py:
847 - Add ``--literal-block-env``
848 - Fix: escaping ``%`` in href urls.
849 - Move usepackage hyperref after stylesheet inclusion.
850 - Fix: scrartcl does not have chapter but scrreprt.
851 - Add newline after ``\end{verbatim}``.
852 - Merge smaller differences from latex2e_adaptive_preamble.
853 - Add ``use-part-section``.
854 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
855 - Using leavemode option_list no longer needs to check if parent
856 is a definition list.
857 - Append ``\leavemode`` to definition list terms.
858 - No longer write visit\_/depart_definition_list_item comments to
860 - Table column width with 3 decimal places.
861 - Add table stubs support (boldfont).
862 - Add assemble_parts to writer.
863 - Add simply support for nested tables.
864 - Fix verbatim in tables if use-verbatim-when-possible.
865 - Use section commands down to subparagraph.
866 - Put ensuremath around some latin1 chars.
867 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
868 - New option ``--use-bibtex=style,db1,db2``.
869 - New option ``--reference-label`` to allow usage of LaTeX ref for
870 labels in section references.
871 - Add a label after every section to support sectionnumbers as reference
873 - Fix: bug# 1605376 rst2latex: bad options group list
874 - Remove inactive code for use_optionlist_for_option_list.
875 - Remove latex comments from option_list output.
876 - Fix: bug# 1612270 double qoutes in italian literal.
877 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
878 - Add option --use-latex-abstract.
879 - Image width unit ``px`` is translated to ``pt``.
880 - Add image height support.
881 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
883 - Fix: Do not escape underscores in citation reference labels if
884 use-latex-citations is set.
885 - Use centering instead of center for figure contents, to avoid vertical
887 - Recognize table class: borderless, nolines, booktabs, standard.
888 - Fix: Renaming contents section does not work with latex writer; SF
890 - Applied patch for custom roles with classes from Edward Loper.
891 - Fixed bug that caused crashes with more than 256 lists.
893 * docutils/writers/pep_html/__init__.py:
895 - Changed to support new python.org website structure and
898 * docs/howto/security.txt: "Deploying Docutils Securely", added to
901 * tools/buildhtml.py:
903 -- Added ``ignore`` setting to exclude a list of shell patterns
904 (default: ``.svn:CVS``).
906 * tools/editors/emacs/rst.el:
908 - Changed license to "GPL".
909 - Added ``rst-straighten-decorations`` function.
910 - The ``compile`` module is now always loaded.
911 - Added ``rst-toggle-line-block`` function.
912 - Headings consisting only of non-ASCII characters are now
913 recognized by ``rst-toc`` and ``rst-adjust``.
914 - Added font-lock support for multi-line comments where the first
915 comment line is empty.
916 - Added ``(require 'font-lock)``.
920 - Provide descriptive error message if distutils is missing.
923 Release 0.4 (2006-01-09)
924 ========================
928 - Updated the project policies for trunk/branch development &
931 * docutils/__init__.py:
933 - Added ``__version_details__`` attribute to describe code source
934 (repository/snapshot/release).
935 - Replaced ``default_transforms`` attribute of TransformSpec with
936 ``get_transforms()`` method.
940 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
941 functions, for document tree extraction and reprocessing.
945 - Added ``DocTreeInput`` class, for reprocessing existing documents.
946 - Added support for non-Unicode (e.g. binary) writer output.
950 - Re-introduced ``Targetable.indirect_reference_name``, for
951 MoinMoin/reST compatibility (removed in r3124/r3129).
952 - Added ``serial_escape`` function; escapes string values that are
953 elements of a list, for serialization. Modified Docutils-XML
954 writing (``Element._dom_node``) and pseudo-XML writing
955 (``Element.starttag``) to use ``serial_escape``.
956 - Added ``Node.deepcopy()`` method.
957 - Removed the internal lists ``document.substitution_refs``,
958 ``document.anonymous_refs``, and ``document.anonymous_targets``.
959 - Added a "container" element.
960 - Fixed bug where values of list-valued attributes of elements
961 originating from custom interpreted text roles (i.e., with custom
962 classes) were being shared between element instances. Reported by
965 * docutils/statemachine.py:
967 - Added trailing whitespace stripping to ``string2lines()``.
968 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
969 Asian double-width character support.
973 - Added ``east_asian_column_width()`` for double-width character
976 * docutils/languages/ja.py: Added to project: Japanese mappings by
979 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
980 mappings by Panjunyong.
982 * docutils/parsers/null.py: Added to project; a do-nothing parser.
984 * docutils/parsers/rst/__init__.py:
986 - Added validator to tab_width setting, with test. Closes SF bug
987 #1212515, report from Wu Wei.
989 * docutils/parsers/rst/states.py:
991 - Fixed bug with escaped colons indicating a literal block.
992 - Fixed bug with enumerated lists (SF#1254145).
993 - Backslash-escaped colons inside of field names are now allowed.
994 - Targets (implicit and explicit), anonymous hyperlink references
995 and auto-numbered footnote references inside of substitution
996 definitions are now disallowed.
997 - Fixed bug: list items with blank first lines.
998 - Fixed bug: block quote attributions with indented second lines.
999 - Added East Asian double-width character support (Python 2.4 only).
1001 * docutils/parsers/rst/tableparser.py:
1003 - Added East Asian double-width character support (Python 2.4 only).
1005 * docutils/parsers/rst/directives/body.py:
1007 - Added the "container" directive.
1009 * docutils/parsers/rst/directives/misc.py:
1011 - Added the "default-role", "title", and "date" directives.
1012 - Added standard data file syntax to the "include" directive.
1013 - Added support for "class" directive content.
1015 * docutils/parsers/rst/directives/images.py:
1017 - Added ``indirect_reference_name`` support for images with a target
1019 - Added support for image width and height units.
1020 - Fixed bug with image "target" options.
1022 * docutils/parsers/rst/directives/references.py:
1024 - Added "class" attribute to "target-notes" directive, for
1025 footnote_reference classes.
1027 * docutils/parsers/rst/include/: Directory added to project; contains
1028 standard data files for the "include" directive. Initial contents:
1029 character entity substitution definition sets, and a set of
1030 definitions for S5/HTML presentations.
1032 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1033 mappings by David Goodger.
1035 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1036 Simplified Chinese mappings by Panjunyong.
1038 * docutils/readers/__init__.py:
1040 - Added universal.Decorations and universal.ExposeInternals
1041 transforms as default transforms for all readers.
1042 - Added ``ReReader`` base class for readers that reread an existing
1045 * docutils/readers/doctree.py: Added to project; a reader for existing
1048 * docutils/transforms/frontmatter.py:
1050 - Fixed the DocInfo transform to handle SVN-style expansion of the
1052 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1055 * docutils/transforms/misc.py:
1057 - Added misc.Transitions transform, extracted from
1058 universal.FinalChecks.
1060 * docutils/transforms/references.py:
1062 - Added references.DanglingReferences transform, extracted from
1063 universal.FinalChecks.
1064 - Fixed bug with doubly-indirect substitutions.
1065 - Added footnote_reference classes attribute to "TargetNotes".
1066 - Fixed bug with circular substitution definitions that put Docutils
1067 into an infinite loop.
1069 * docutils/transforms/universal.py:
1071 - Added universal.ExposeInternals transform, extracted from
1072 universal.FinalChecks.
1073 - Removed universal.FinalChecks transform (logic has been moved to
1074 several new transforms).
1075 - Fixed bug with the "expose_internals" setting and Text nodes
1076 (exposed by the "rawsource" internal attribute).
1077 - Added the universal.StripComments transform, implementation of the
1078 "strip_comments" setting.
1080 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1081 transforms for writers.
1083 - Added ``Compound`` transform, which flattens compound paragraphs.
1085 * docutils/writers/: Several writer modules (html4css1.py) were
1086 converted into packages. Support modules and data files have been
1087 moved into the packages. The stylesheets for the HTML writers are
1088 now installed along with the code, the code knows where to find
1089 them, and the default is to use them (actually, to embed them).
1090 Some adjustments to configuration files may be necessary. The
1091 easiest way to obtain the new default behavior is to remove all
1092 settings whose name includes "stylesheet".
1094 * docutils/writers/__init__.py:
1096 - Added universal.Messages and universal.FilterMessages transforms
1097 as default transforms for all writers.
1098 - Added ``UnfilteredWriter`` base class for writers that pass the
1099 document tree on unchanged.
1101 * docutils/writers/docutils_xml.py:
1103 - Made ``xmlcharrefreplace`` the default output encoding error
1106 * docutils/writers/html4css1/:
1108 - Added support for image width and height units.
1109 - Made ``xmlcharrefreplace`` the default output encoding error
1111 - Made ``--embed-stylesheet`` the default rather than
1112 ``--link-stylesheet``.
1113 - Moved "id" attribute from container (section etc.) to title's <a>
1114 tag, to be on the same tag as "name".
1115 (!!! To be reverted in Docutils 0.5.)
1116 - Added vertical space between fields of field lists.
1117 - Added ``--compact-field-lists`` option to remove vertical space in
1119 - Made cloaking of email addresses with ``--cloak-email-addresses``
1121 - Fixed support for centered images.
1122 - Added support for class="compact" & class="open" lists.
1124 * docutils/writers/latex2e/:
1126 - Underscores in citekeys are no longer escaped.
1128 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1129 mapping of Unicode characters to LaTeX equivalents.
1131 * docutils/writers/s5_html/: Package added to project; writer for
1132 S5/HTML slide shows.
1134 * docs/dev/distributing.txt: Added to project; guide for distributors
1135 (package maintainers).
1137 * docs/dev/hacking.txt: Added to project; guide for developers.
1139 * docs/ref/doctree.txt:
1141 - Updated for plural attributes "classes", "ids", "names",
1143 - Added the "container" element.
1145 * docs/ref/docutils.dtd:
1147 - Updated for plural attributes "classes", "ids", "names",
1150 * docs/user/emacs.txt: Added to project; a document about Emacs
1151 support for reStructuredText and Docutils.
1153 * docs/user/links.txt: Added to project; lists of Docutils-related
1156 * docs/user/mailing-lists.txt: Added to project; information about
1157 Docutils-related mailing lists and how to access them.
1159 * docs/user/slide-shows.txt: Added to project; example of and docs for
1160 the S5/HTML writer (``rst2s5.py`` front end).
1162 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1163 Files", added to project.
1165 * test/coverage.sh: Added to project; test coverage script.
1167 * test/DocutilsTestSupport.py:
1169 - Added support for specifying runtime settings at the suite level.
1171 * test/test_functional.py:
1173 - Added the ``clear_output_directory`` function.
1174 - Added support for ``_test_more`` functions in functional test
1177 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1179 * tools/rstpep2html.py: Renamed from pep.py.
1181 * tools/dev/create_unimap.py: Added to project; script to create the
1182 docutils/writers/unimap_latex.py mapping file.
1184 * tools/dev/profile_docutils.py: Added to project; profiler script.
1186 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1188 * tools/editors/emacs/restructuredtext.el,
1189 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1190 Removed from project; the functionality is now contained in rst.el.
1192 * tools/editors/emacs/rst.el: Added to project. Added many features
1193 and fixed many bugs. See docs/user/emacs.txt for details.
1195 * tools/stylesheets: Removed from project. Stylesheets have been
1196 renamed and moved into writer packages.
1199 Release 0.3.9 (2005-05-26)
1200 ==========================
1204 - Eliminated and replaced all uses of the old string attributes
1205 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1206 new list attributes ``ids``, ``names``, ``dupnames`` and
1207 ``classes`` throughout the whole source tree.
1211 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1212 allowing for easier debugging.
1213 - In ``Publisher.publish()``, expanded the generic top-level
1216 * docutils/examples.py:
1218 - Added ``internals`` function for exploration.
1222 - Fixed ``Input.decode`` method to apply heuristics only if no
1223 encoding is explicitly given, and to provide better reporting of
1225 - The ``Input.decode`` method now removes byte order marks (BOMs)
1228 * docutils/nodes.py:
1230 - ``image`` element class changed to subclass of Element, not
1231 TextElement (it's an empty element, and cannot contain text).
1232 - Added ``attr_defaults`` dictionary for default attribute values.
1233 - Added empty list as default value for the following attributes:
1234 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1235 - Added ``document.decoration`` attribute,
1236 ``document.get_decoration`` method, and ``decoration.get_header``
1237 & ``.get_footer`` methods.
1238 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1241 * docutils/utils.py:
1243 - Removed ``docutils.utils.Reporter.categories``,
1244 ``docutils.utils.ConditionSet``, and all references to them, to
1245 simplify error reporting.
1247 * docutils/languages/nl.py: Added to project; Dutch mappings by
1250 * docutils/parsers/rst/__init__.py:
1252 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1254 * docutils/parsers/rst/states.py:
1256 - Added check for escaped at-mark to prevent email address recognition.
1257 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1259 - Allowed whitespace in paths and URLs.
1260 - Added auto-enumerated list items.
1261 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1263 - Added support for table stub columns.
1265 * docutils/parsers/rst/directives/__init__.py:
1267 - Allowed whitespace in paths (``path`` function).
1268 - Added ``uri`` directive option conversion function.
1270 * docutils/parsers/rst/directives/body.py:
1272 - Fixed illegal context bug with "topic" directive (allowed within
1273 sidebars; not within body elements).
1275 * docutils/parsers/rst/directives/images.py:
1277 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1278 - Added support for the ``file_insertion_enabled`` setting in the
1279 "figure" directive (disables "figwidth" option).
1280 - "image" directive: added checks for valid values of "align" option,
1281 depending on context. "figure" directive: added specialized
1282 "align" option and attribute on "figure" element.
1283 - Made ":figwidth: image" option of "figure" directive work again.
1284 - Fixed bug with reference names containing uppercase letters
1285 (e.g. ``Name_``) in "target" option of "image" directive.
1287 * docutils/parsers/rst/directives/misc.py:
1289 - Fixed "include" and "raw" directives to catch text decoding
1291 - Allowed whitespace in "include" & "raw" directive paths.
1292 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1293 settings in "include" & "raw" directives.
1295 * docutils/parsers/rst/directives/parts.py:
1297 - Added "header" & "footer" directives.
1298 - Fixed illegal context bug with "contents" directive (topics
1299 allowed within sidebars; not within body elements).
1301 * docutils/parsers/rst/directives/tables.py:
1303 - Added "list-table" directive.
1304 - Caught empty CSV table bug.
1305 - Added support for the ``file_insertion_enabled`` setting in the
1306 "csv-table" directive.
1307 - Added ``stub-columns`` option to "csv-table" and "list-table"
1310 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1311 mappings by Martijn Pieters.
1313 * docutils/readers/standalone.py:
1315 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1316 options to activate or deactivate the SectSubTitle transform.
1318 * docutils/transforms/frontmatter.py:
1320 - Added SectSubTitle transform to promote titles of lone
1321 subsections to subtitles.
1323 * docutils/transforms/references.py:
1325 - Fixed mislocated internal targets bug, by propagating internal
1326 targets to the next node, making use of the newly added support
1327 for multiple names and IDs.
1328 - Fixed duplicate footnote label bug.
1329 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1332 * docutils/writers/html4css1.py:
1334 - Fixed unencoded stylesheet reference bug (characters like "&" in
1335 stylesheet references).
1336 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1338 - Added support for multiple IDs per node by creating empty ``span``
1340 - Added the ``field_name_limit`` & ``option_limit`` settings &
1342 - Added support for table stub columns.
1343 - Added support for the ``align`` attribute on ``figure`` elements.
1344 - Added the ``cloak_email_addresses`` setting & support.
1345 - Added ``html_prolog``, ``html_head``, ``html_body``,
1346 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1347 ``docutils.core.publish_parts``.
1348 - Added support for section subtitles.
1350 * docutils/writers/latex2e.py:
1352 - Fixed tables starting with more than one multirow cell.
1353 - Improved --use-latex-docinfo so that organization/contact/address
1354 fields are lumped with the last author field and appear on the
1356 - Made sure the titlepage is always shown with --use-latex-docinfo,
1357 even if the document has no title.
1358 - Made sure that latex doesn't fill in today's date if no date field
1360 - Added support for section subtitles.
1362 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1363 (under development).
1365 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1367 * docs/api/publisher.txt:
1369 - Added "``publish_parts`` Details" section.
1371 * docutils/dev/repository.txt: Added to project; information about the
1372 Docutils Subversion repository.
1374 * docs/ref/docutils.dtd:
1376 - Added a ``stub`` attribute to the ``colspec`` element via the
1377 ``tbl.colspec.att`` parameter entity.
1378 - Allowed topic elements within sidebars
1379 - Added an ``align`` attribute to the ``figure`` element.
1381 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1385 Release 0.3.7 (2004-12-24)
1386 ==========================
1388 * docutils/frontend.py:
1390 - Added options: --input-encoding-error-handler,
1391 --record-dependencies, --leave-footnote-reference-space,
1393 - Added command-line and config file support for "overrides" setting
1398 - Added support for input encoding error handler.
1400 * docutils/nodes.py:
1402 - Added dispatch_visit and dispatch_departure methods to
1403 NodeVisitor; useful as a hook for Visitors.
1404 - Changed structure of ``line_block``; added ``line``.
1405 - Added ``compound`` node class.
1406 - Added a mechanism for Visitors to transitionally ignore new node
1409 * docutils/utils.py:
1411 - Moved ``escape2null`` and ``unescape`` functions from
1412 docutils/parsers/rst/states.py.
1414 * docutils/parsers/rst/roles.py:
1417 - Changed role function API: the "text" parameter now takes
1418 null-escaped interpreted text content.
1420 * docutils/parsers/rst/states.py:
1422 - Fixed bug where a "role" directive in a nested parse would crash
1423 the parser; the state machine's "language" attribute was not being
1425 - Added support for line block syntax.
1426 - Fixed directive parsing bug: argument-less directives didn't
1427 notice that arguments were present.
1428 - Removed error checking for transitions.
1429 - Added support for multiple classifiers in definition list items.
1430 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1431 - Changed role function API: the "text" parameter now takes
1432 null-escaped interpreted text content.
1433 - Empty sections and documents are allowed now.
1435 * docutils/parsers/rst/directives/__init__.py:
1437 - Added ``encoding`` directive option conversion function.
1438 - Allow multiple class names in class_option conversion function.
1440 * docutils/parsers/rst/directives/body.py:
1442 - Converted the line-block directive to use the new structure.
1443 - Extracted the old line-block functionality to the ``block``
1444 function (still used).
1445 - Added ``compound`` directive (thanks to Lea Wiemann).
1447 * docutils/parsers/rst/directives/misc.py:
1449 - Added "encoding" option to "include" and "raw" directives.
1450 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1451 - Allow multiple class names in the "class" directive.
1453 * docutils/parsers/rst/directives/parts.py:
1455 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1456 options. Thanks to Lele Gaifax.
1458 * docutils/parsers/rst/directives/tables.py:
1460 - Added "encoding" directive to "csv-table" directive.
1461 - Added workaround for lack of Unicode support in csv.py, for
1462 non-ASCII CSV input.
1464 * docutils/transforms/misc.py:
1466 - Fixed bug when multiple "class" directives are applied to a single
1468 - Enabled multiple format names for "raw" directive.
1470 * docutils/transforms/references.py:
1472 - Added support for trimming whitespace from beside substitution
1475 * docutils/transforms/universal.py:
1477 - FinalChecks now checks for illegal transitions and moves
1478 transitions between sections.
1480 * docutils/writers/html4css1.py:
1482 - HTMLTranslator.encode now converts U+00A0 to " ".
1483 - "stylesheet" and "stylesheet_path" settings are now mutually
1485 - Added support for the new line_block/line structure.
1486 - --footnote-references now overrides
1487 --trim-footnote-reference-space, if applicable.
1488 - Added support for ``compound`` elements.
1489 - Enabled multiple format names for "raw" directive.
1490 - ``<p>`` tags of a paragraph which is the only visible child of the
1491 document node are no longer stripped.
1492 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1493 new method ``should_be_compact_paragraph()``.
1494 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1496 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1497 the output if they have their ``class`` attribute set.
1498 - The whole document is now surrounded by a ``<div
1499 class="document">`` element.
1500 - Body-level images are now wrapped by their own ``<div>`` elements,
1501 with image classes copied to the wrapper, and for images which
1502 have the ``:align:`` option set, the surrounding ``<div>`` now
1503 receives a class attribute (like ``class="align-left"``).
1505 * docutils/writers/latex2e.py:
1507 - no newline after depart_term.
1508 - Added translations for some Unicode quotes.
1509 - Added option "font-encoding", made package AE the default.
1510 - "stylesheet" and "stylesheet_path" settings are now mutually
1512 - --footnote-references now overrides
1513 --trim-footnote-reference-space, if applicable.
1514 - The footnote label style now matches the footnote reference style
1515 ("brackets" or "superscript").
1516 - Added support for ``compound`` elements.
1517 - Enabled multiple format names for "raw" directive.
1519 * docs/ref/docutils.dtd:
1521 - Changed structure of the ``line_block`` element; added ``line``.
1522 - Added ``compound`` element.
1523 - Added "ltrim" and "rtrim" attributes to
1524 ``substitution_definition`` element.
1525 - Enabled multiple format names for ``raw`` element.
1526 - Enabled multiple classifiers in ``definition_list_item`` elements.
1528 * docs/ref/rst/directives.txt
1530 - Marked "line-block" as deprecated.
1531 - "Class" directive now allows multiple class names.
1532 - Added "Rationale for Class Attribute Value Conversion".
1533 - Added warning about "raw" overuse/abuse.
1535 * docs/ref/rst/restructuredtext.txt:
1537 - Added syntax for line blocks.
1538 - Definition list items may have multiple classifiers.
1540 * docs/ref/rst/roles.txt:
1544 * tools/stylesheets/default.css:
1546 - Added support for the new line_block structure.
1547 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1550 Release 0.3.5 (2004-07-29)
1551 ==========================
1555 * _`Documentation cleanup/reorganization`.
1557 - Created new subdirectories of docs/:
1559 * ``docs/user/``: introductory/tutorial material for end-users
1560 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1561 * ``docs/api/``: API reference material for client-developers
1562 * ``docs/ref/``: reference material for all groups
1563 * ``docs/howto/``: for component-developers and core-developers
1564 * ``docs/peps/``: Python Enhancement Proposals
1566 - Moved ``docs/*`` to ``docs/user/``.
1567 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1568 ``spec/`` to ``docs/dev``.
1569 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1570 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1571 - Moved ``alternatives.txt``, and ``problems.txt`` from
1572 ``spec/rst/`` to ``docs/dev/rst/``.
1573 - Moved ``reStructuredText.txt``, ``directives.txt``,
1574 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1575 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1576 ``roles.txt``, ``reStructuredText.txt`` to
1577 ``restructuredtext.txt``.
1578 - Moved ``spec/howto/`` to ``docs/howto``.
1580 In order to keep the CVS history of moved files, we supplied
1581 SourceForge with a `script for modifying the Docutils CVS
1584 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1586 After running the cleanup script:
1588 - Added ``docs/index.txt``.
1589 - Added a ``.htaccess`` file to the ``web`` module, containing
1590 redirects for all old paths to new paths. They'll preserve
1591 fragments (the "#name" part of a URL), and won't clutter up the
1592 file system, and will correct the URL in the user's browser.
1593 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1594 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1595 the "To Do" list itself in ``docs/dev/todo.txt``.
1596 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1597 section of ``docs/dev/todo.txt``.
1598 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1599 - Added "How To Report Bugs" to ``BUGS.txt``.
1600 - Went through all the sources and docs (including under web/) and
1601 updated links. Mostly done by Lea Wiemann; thanks Lea!
1602 (Still need to update links in the sandboxes.)
1606 * BUGS.txt: Added to project.
1608 * THANKS.txt: Added to project.
1610 * docutils/__init__.py:
1612 - 0.3.4: Post-release.
1616 - Added special error handling & advice for UnicodeEncodeError.
1617 - Refactored Publisher.publish (simplified exception handling &
1618 extracted debug dumps).
1619 - Renamed "enable_exit" parameter of convenience functions to
1620 "enable_exit_status".
1621 - Enabled traceback (exception propagation) by default in
1622 programmatic convenience functions.
1623 - Now publish_file and publish_cmdline convenience functions return
1624 the encoded string results in addition to their regular I/O.
1625 - Extracted common code from publish_file, publish_string, and
1626 publish_parts, into new publish_programmatically. Extracted
1627 settings code to ``Publisher.process_programmatic_settings``.
1628 - In Publisher.publish, disabled ``settings_overrides`` when
1629 ``settings`` is supplied; redundant.
1631 * docutils/frontend.py:
1633 - Added help text for "--output-encoding-error-handler" and
1634 "--error-encoding-error-handler".
1635 - Renamed "--exit" to "--exit-status".
1636 - Simplified default-setting code.
1638 * docutils/parsers/rst/__init__.py:
1640 - Added "--pep-base-url" and "--rfc-base-url" options.
1642 * docutils/parsers/rst/states.py:
1644 - Made URI recognition more aggressive and intelligent.
1646 * docutils/parsers/rst/directives/__init__.py:
1648 - Added several directive option conversion functions.
1650 * docutils/parsers/rst/directives/body.py:
1652 - Moved "table" directive to tables.py.
1654 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1657 * docutils/writers/latex2e.py:
1659 - Added "--table-style=(standard|booktabs|nolines)"
1660 - figures get "here" option (LaTeX per default puts them at bottom),
1661 and figure content is centered.
1662 - Rowspan support for tables.
1663 - Fix: admonition titles before first section.
1664 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1665 - Replave ``_`` in literal by an underlined blank, because it has the correct
1667 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1668 - A few unicode replacements, if output_encoding != utf
1669 - Add "--graphicx-option".
1670 - Indent literal-blocks.
1671 - Fix: omit ``\maketitle`` when there is no document title.
1673 * docs/index.txt: "Docutils Project Documentation Overview", added to
1676 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1677 Tool", added to project.
1679 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1681 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1683 * docs/dev/policies.txt: Added to project (extracted from
1684 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1686 * docs/dev/release.txt: Added to project (extracted from
1687 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1689 * docs/dev/testing.txt: Added to project.
1691 * docs/dev/website.txt: Added to project (extracted from
1692 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1694 * docs/ref/rst/directives.txt:
1696 - Added directives: "table", "csv-table".
1698 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1699 added to project. 1 page for syntax, and a 1 page reference for
1700 directives and roles. Source text to be used as-is; not meant to be
1703 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1704 with a change of title.
1706 * test/functional/, contents, and test/test_functional.py: Added to
1709 * tools/buildhtml.py: Fixed bug with config file handling.
1711 * tools/html.py: Removed from project (duplicate of rst2html.py).
1713 * tools/pep2html.py: Removed from project (duplicate of Python's
1714 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1715 Docutils-related PEPs in docs/peps/).
1717 * tools/rst2pseudoxml.py: Renamed from publish.py.
1719 * tools/rst2xml.py: Renamed from docutils-xml.py.
1721 * tools/test.txt: Removed from project; moved to
1722 docs/user/rst/demo.txt.
1724 * setup.py: Now also installs ``rst2latex.py``.
1727 Release 0.3.3 (2004-05-09)
1728 ==========================
1730 * docutils/__init__.py:
1732 - 0.3.1: Reorganized config file format (multiple sections); see
1734 - Added unknown_reference_resolvers attribute to TransformSpec.
1735 - 0.3.2: Interpreted text reorganization.
1740 - Catch system messages to stop tracebacks from parsing errors.
1741 - Catch exceptions during processing report & exit without
1742 tracebacks, except when "--traceback" used.
1743 - Reordered components for OptionParser; application comes last.
1744 - Added "config_section" parameter to several methods and functions,
1745 allowing front ends to easily specify their config file sections.
1746 - Added publish_parts convenience function to allow access to individual
1747 parts of a document.
1749 * docutils/examples.py: Added to project; practical examples of
1750 Docutils client code, to be used as-is or as models for variations.
1752 * docutils/frontend.py:
1754 - Added "--traceback" & "--no-traceback" options ("traceback"
1756 - Implemented support for config file reorganization:
1757 ``standard_config_files`` moved from ``ConfigParser`` to
1758 ``OptionParser``; added
1759 ``OptionParser.get_config_file_settings()`` and
1760 ``.get_standard_config_settings()``; support for old "[options]"
1761 section (with deprecation warning) and mapping from old to new
1763 - Reimplemented setting validation.
1764 - Enabled flexible boolean values: yes/no, true/false, on/off.
1765 - Added ``Values``, a subclass of ``optparse.Values``, with support
1766 for list setting attributes.
1767 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1768 thanks to Beni Cherniavsky.
1769 - Added "--no-section-numbering" option.
1773 - Catch IOErrors when opening source & destination files, report &
1774 exit without tracebacks. Added ``handle_io_errors`` parameter to
1775 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1777 * docutils/nodes.py:
1779 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1780 method definitions (via ``exec``) to dynamic assignments (via
1781 ``setattr``); thanks to Roman Suzi.
1782 - Encapsulated visitor dynamic assignments in a function; thanks to
1784 - Added indirect_reference_name attribute to the Targetable
1785 class. This attribute holds the whitespace_normalized_name
1786 (contains mixed case) of a target.
1788 * docutils/statemachine.py:
1790 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1791 - Added ``StringList.get_2D_block``.
1793 * docutils/utils.py:
1795 - Added "level" attribute to SystemMessage exceptions.
1797 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1800 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1803 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1804 Marcelo Huerta San Martin.
1806 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1807 mappings by Lalo Martins.
1809 * docutils/languages/ru.py: Added to project; Russian mappings by
1812 * docutils/parsers/rst/roles.py: Added to project. Contains
1813 interpreted text role functions, a registry for interpreted text
1814 roles, and an API for adding to and retrieving from the registry.
1815 Contributed by Edward Loper.
1817 * docutils/parsers/rst/states.py:
1819 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1820 - Allowed true em-dash character and "---" as block quote
1822 - Added support for <angle-bracketed> complex option arguments
1824 - Fixed handling of backslashes in substitution definitions.
1825 - Fixed off-by-1 error with extra whitespace after substitution
1826 definition directive.
1827 - Added inline markup parsing to field lists' field names.
1828 - Added support for quoted (and unindented) literal blocks.
1829 Driven in part by a bribe from Frank Siebenlist (thanks!).
1830 - Parser now handles escapes in URIs correctly.
1831 - Made embedded-URIs' reference text omittable. Idea from Beni
1833 - Refactored explicit target processing code.
1834 - Added name attribute to references containing the reference name only
1835 through whitespace_normalize_name (no case changes).
1836 - parse_target no longer returns the refname after going through
1837 normalize_name. This is now handled in make_target.
1838 - Fixed bug relating to role-less interpreted text in non-English
1840 - Reorganized interpreted text processing; moved code into the new
1841 roles.py module. Contributed by Edward Loper.
1842 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1843 ``parse_directive_block``.
1845 * docutils/parsers/rst/tableparser.py:
1847 - Reworked for ``StringList``, to support "include" directives in
1850 * docutils/parsers/rst/directives/__init__.py:
1852 - Renamed ``unchanged()`` directive option conversion function to
1853 ``unchanged_required``, and added a new ``unchanged``.
1854 - Catch unicode value too high error; fixes bug 781766.
1855 - Beefed up directive error reporting.
1857 * docutils/parsers/rst/directives/body.py:
1859 - Added basic "table" directive.
1861 * docutils/parsers/rst/directives/images.py:
1863 - Added "target" option to "image" directive.
1864 - Added name attribute to references containing the reference name only
1865 through whitespace_normalize_name (no case changes).
1867 * docutils/parsers/rst/directives/misc.py:
1869 - Isolated the import of the ``urllib2`` module; was causing
1870 problems on SourceForge (``libssl.so.2`` unavailable?).
1871 - Added the "role" directive for declaring custom interpreted text
1874 * docutils/parsers/rst/directives/parts.py:
1876 - The "contents" directive does more work up-front, creating the
1877 "topic" and "title", and leaving the "pending" node for the
1878 transform. Allows earlier reference resolution; fixes subtle bug.
1880 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1881 mappings by Jannie Hofmeyr.
1883 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1884 mappings by Marek Blaha.
1886 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1887 mappings by Marcelo Huerta San Martin.
1889 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1890 Portuguese mappings by Lalo Martins.
1892 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1893 mappings by Roman Suzi.
1895 * docutils/transforms/parts.py:
1897 - The "contents" directive does more work up-front, creating the
1898 "topic" and "title", and leaving the "pending" node for the
1899 transform. Allows earlier reference resolution; fixes subtle bug.
1900 - Added support for disabling of section numbering.
1902 * docutils/transforms/references.py:
1904 - Verifying that external targets are truly targets and not indirect
1905 references. This is because we are now adding a "name" attribute to
1906 references in addition to targets. Note sure if this is correct!
1907 - Added code to hook into the unknown_reference_resolvers list for a
1908 transformer in resolve_indirect_target. This allows the
1909 unknown_reference_resolvers to keep around indirect targets which
1910 docutils doesn't know about.
1911 - Added specific error message for duplicate targets.
1913 * docutils/transforms/universal.py:
1915 - Added FilterMessages transform (removes system messages below the
1916 verbosity threshold).
1917 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1918 to FinalCheckVisitor for application-specific handling of
1919 unresolvable references.
1920 - Added specific error message for duplicate targets.
1922 * docutils/writers/__init__.py:
1924 - Added assemble_parts method to the Writer class to allow for
1925 access to a documents individual parts.
1926 - Documented & set default for ``Writer.output`` attribute.
1928 * docutils/writers/html4css1.py:
1930 - Fixed unicode handling of attribute values (bug 760673).
1931 - Prevent duplication of "class" attribute values (bug report from
1933 - Improved table grid/border handling (prompted by report from Bob
1935 - Added support for table titles.
1936 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1938 - Added functionality to keep track of individual parts of a document
1939 and store them in a dictionary as the "parts" attribute of the writer.
1940 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1941 - Added proper support for the "scale" attribute of the "image"
1942 element. Contributed by Brent Cook.
1943 - Added ``--initial-header-level`` option.
1944 - Fixed bug: the body_pre_docinfo segment depended on there being a
1945 docinfo; if no docinfo, the document title was incorporated into
1946 the body segment. Adversely affected the publish_parts interface.
1948 * docutils/writers/latex2e.py:
1950 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1951 about a missing file.
1952 - Added options and support: ``--compound-enumerators``,
1953 ``--section-prefix-for-enumerators``, and
1954 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1956 - Added option ``--use-verbatim-when-possible``, to avoid
1957 problematic characters (eg, '~' in italian) in literal blocks.
1958 - It's now possible to use four section levels in the `book` and
1959 `report` LaTeX classes. The default `article` class still has
1962 * docs/config.txt: "Docutils Configuration Files", added to project.
1963 Moved config file entry descriptions from tools.txt.
1967 - Moved config file entry descriptions to config.txt.
1969 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1972 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1973 Text Roles", added to project.
1975 * spec/rst/reStructuredText.txt:
1977 - Added description of support for <angle-bracketed> complex option
1978 arguments to option lists.
1979 - Added subsections for indented and quoted literal blocks.
1981 * test: Continually adding & updating tests.
1983 - Added test/test_settings.py & test/data/config_*.txt support
1985 - Added test/test_writers/test_htmlfragment.py.
1987 * test/DocutilsTestSupport.py:
1989 - Refactored LaTeX publisher test suite/case class names to make
1990 testing other writers easier.
1991 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1992 to test the processing of HTML fragments which use the new
1993 publish_parts convenience function.
1995 * tools/buildhtml.py:
1997 - Added support for the "--prune" option.
1998 - Removed dependency on pep2html.py; plaintext PEPs no longer
2001 * tools/docutils.conf:
2003 - Updated for configuration file reorganization.
2005 * tools/rst2html.py:
2007 - copied from tools/html.py
2011 - added a 'scripts' section to configuration
2012 - added 'tools/rst2html.py' to the scripts section
2015 Release 0.3 (2003-06-24)
2016 ========================
2020 * Renamed "attribute" to "option" for directives/extensions.
2022 * Renamed transform method "transform" to "apply".
2024 * Renamed "options" to "settings" for runtime settings (as set by
2025 command-line options). Sometimes "option" (singular) became
2026 "settings" (plural). Some variations below:
2028 - document.options -> document.settings (stored in other objects as
2030 - option_spec -> settings_spec (not directives though)
2031 - OptionSpec -> SettingsSpec
2032 - cmdline_options -> settings_spec
2033 - relative_path_options -> relative_path_settings
2034 - option_default_overrides -> settings_default_overrides
2035 - Publisher.set_options -> Publisher.get_settings
2039 * COPYING.txt: Added "Public Domain Dedication".
2041 * FAQ.txt: Frequently asked questions, added to project.
2045 - Updated with PyPI Trove classifiers.
2046 - Conditional installation of third-party modules.
2048 * docutils/__init__.py:
2050 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2051 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2052 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2053 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2054 option and its effect on the PEP template & writer.
2055 - Bumped version to 0.2.4 due to changes to the PEP template &
2057 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2058 - Added ``TransformSpec`` class for new transform system.
2059 - Bumped version to 0.2.6 for API changes (renaming).
2060 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2061 convenience functions.
2062 - Added ``Component.component_type`` attribute.
2063 - Bumped version to 0.2.8 because of the internal parser switch from
2064 plain lists to the docutils.statemachine.StringList objects.
2065 - Bumped version to 0.2.9 because of the frontend.py API changes.
2066 - Bumped version to 0.2.10 due to changes to the project layout
2067 (third-party modules removed from the "docutils" package), and
2068 signature changes in ``io.Input``/``io.Output``.
2069 - Changed version to 0.3.0 for release.
2073 - Made ``publish()`` a bit more convenient.
2074 - Generalized ``Publisher.set_io``.
2075 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2076 parameters; improved its docstring.
2077 - Added ``publish_file()`` and ``publish_string()``.
2078 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2080 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2081 "--dump-transforms" hidden options.
2082 - Added ``Publisher.apply_transforms()`` method.
2083 - Added ``Publisher.set_components()`` method; support for
2084 ``publish_*()`` conveninece functions.
2085 - Moved config file processing to docutils/frontend.py.
2086 - Added support for exit status ("exit_level" setting &
2087 ``enable_exit`` parameter for Publisher.publish() and convenience
2090 * docutils/frontend.py:
2092 - Check for & exit on identical source & destination paths.
2093 - Fixed bug with absolute paths & "--config".
2094 - Set non-command-line defaults in ``OptionParser.__init__()``:
2095 ``_source`` & ``_destination``.
2096 - Distributed ``relative_path_settings`` to components; updated
2097 ``OptionParser.populate_from_components()`` to combine it all.
2098 - Require list of keys in ``make_paths_absolute`` (was implicit in
2099 global ``relative_path_settings``).
2100 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2101 "--dump-settings", and "--dump-transforms" hidden options.
2102 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2103 code, replaced with correct code.
2104 - Added validation functionality for config files.
2105 - Added "--error-encoding" option/setting, "_disable_config"
2107 - Added encoding validation; updated "--input-encoding" and
2108 "--output-encoding"; added "--error-encoding-error-handler" and
2109 "--output-encoding-error-handler".
2110 - Moved config file processing from docutils/core.py.
2111 - Updated ``OptionParser.populate_from_components`` to handle new
2112 ``SettingsSpec.settings_defaults`` dict.
2113 - Added support for "-" => stdin/stdout.
2114 - Added "exit_level" setting ("--exit" option).
2118 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2119 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2120 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2121 - ``FileOutput.write()`` now returns the encoded output string.
2122 - Try to get path/stream name automatically in ``FileInput`` &
2124 - Added defaults for source & destination paths.
2125 - Allow for Unicode I/O with an explicit "unicode" encoding.
2126 - Added ``Output.encode()``.
2127 - Removed dependency on runtime settings; pass encoding directly.
2128 - Recognize Unicode strings in ``Input.decode()``.
2129 - Added support for output encoding error handlers.
2131 * docutils/nodes.py:
2133 - Added "Invisible" element category class.
2134 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2135 modification during a traversal.
2136 - Added element classes: ``line_block``, ``generated``, ``address``,
2137 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2138 ``superscript``, ``subscript``, ``inline``
2139 - Added support for lists of nodes to ``Element.insert()``.
2140 - Fixed parent linking in ``Element.replace()``.
2141 - Added new abstract superclass ``FixedTextElement``; adds
2142 "xml:space" attribute.
2143 - Added support for "line" attribute of ``system_message`` nodes.
2144 - Added support for the observer pattern from ``utils.Reporter``.
2145 Added ``parse_messages`` and ``transform_messages`` attributes to
2146 ``document``, removed ``messages``. Added ``note_parse_message``
2147 and ``note_transform_message`` methods.
2148 - Added support for improved diagnostics:
2150 - Added "document", "source", and "line" internal attributes to
2151 ``Node``, set by ``Node.setup_child()``.
2152 - Converted variations on ``node.parent = self`` to
2153 ``self.setup_child(node)``.
2154 - Added ``document.current_source`` & ``.current_line``
2155 attributes, and ``.note_source`` observer method.
2156 - Changed "system_message" output to GNU-Tools format.
2158 - Added a "rawsource" attribute to the ``Text`` class, for text
2159 before backslash-escape resolution.
2160 - Support for new transform system.
2161 - Reworked ``pending`` element.
2162 - Fixed XML DOM bug (SF #660611).
2163 - Removed the ``interpeted`` element class and added
2164 ``title_reference``, ``abbreviation``, ``acronym``.
2165 - Made substitutions case-sensitive-but-forgiving; moved some code
2167 - Fixed Unicode bug on element attributes (report: William Dode).
2169 * docutils/optik.py: Removed from project; replaced with
2170 extras/optparse.py and extras/textwrap.py. These will be installed
2171 only if they're not already present in the Python installation.
2173 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2174 only if it's not already present in the Python installation.
2176 * docutils/statemachine.py:
2178 - Factored out ``State.add_initial_transitions()`` so it can be
2180 - Converted whitespace-specific "blank" and "indent" transitions
2181 from special-case code to ordinary transitions: removed
2182 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2183 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2184 ``ws_initial_transitions`` attributes.
2185 - Removed ``State.match_transition()`` after merging it into
2187 - Added ``StateCorrection`` exception.
2188 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2189 (moved ``TransitionCorrection`` support there too.)
2190 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2191 ``EOFError`` instead of ``IndexError``.
2192 - Added ``State.no_match`` method.
2193 - Added support for the Observer pattern, triggered by input line
2195 - Added ``strip_top`` parameter to
2196 ``StateMachineWS.get_first_known_indented``.
2197 - Made ``context`` a parameter to ``StateMachine.run()``.
2198 - Added ``ViewList`` & ``StringList`` classes;
2199 ``extract_indented()`` becomes ``StringList.get_indented()``.
2200 - Added ``StateMachine.insert_input()``.
2201 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2202 thanks to) Fred Drake.
2204 * docutils/utils.py:
2206 - Added a ``source`` attribute to Reporter instances and
2207 ``system_message`` elements.
2208 - Added an observer pattern to ``utils.Reporter`` to keep track of
2210 - Fixed bugs in ``relative_path()``.
2211 - Added support for improved diagnostics.
2212 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2213 - Added support for encoding Reporter stderr output, and encoding
2215 - Reporter keeps track of the highest level system message yet
2218 * docutils/languages: Fixed bibliographic field language lookups.
2220 * docutils/languages/es.py: Added to project; Spanish mappings by
2221 Marcelo Huerta San Martin.
2223 * docutils/languages/fr.py: Added to project; French mappings by
2226 * docutils/languages/it.py: Added to project; Italian mappings by
2229 * docutils/languages/sk.py: Added to project; Slovak mappings by
2232 * docutils/parser/__init__.py:
2234 - Added ``Parser.finish_parse()`` method.
2236 * docutils/parser/rst/__init__.py:
2238 - Added options: "--pep-references", "--rfc-references",
2239 "--tab-width", "--trim-footnote-reference-space".
2241 * docutils/parsers/rst/states.py:
2243 - Changed "title under/overline too short" system messages from INFO
2244 to WARNING, and fixed its insertion location.
2245 - Fixed enumerated list item parsing to allow paragraphs & section
2246 titles to begin with enumerators.
2247 - Converted system messages to use the new "line" attribute.
2248 - Fixed a substitution reference edge case.
2249 - Added support for "--pep-references" and "--rfc-references"
2250 options; reworked ``Inliner`` code to make customization easier.
2251 - Removed field argument parsing.
2252 - Added support for short section title over/underlines.
2253 - Fixed "simple reference name" regexp to ignore text like
2254 "object.__method__"; not an anonymous reference.
2255 - Added support for improved diagnostics.
2256 - Reworked directive API, based on Dethe Elza's contribution. Added
2257 ``Body.parse_directive()``, ``.parse_directive_options()``,
2258 ``.parse_directive_arguments()`` methods.
2259 - Added ``ExtensionOptions`` class, to parse directive options
2260 without parsing field bodies. Factored
2261 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2262 ``ExtensionOptions``.
2263 - Improved definition list term/classifier parsing.
2264 - Added warnings for unknown directives.
2265 - Renamed ``Stuff`` to ``Struct``.
2266 - Now flagged as errors: transitions at the beginning or end of
2267 sections, empty sections (except title), and empty documents.
2268 - Updated for ``statemachine.StringList``.
2269 - Enabled recognition of schemeless email addresses in targets.
2270 - Added support for embedded URIs in hyperlink references.
2271 - Added backslash-escapes to inline markup end-string suffix.
2272 - Added support for correct interpreted text processing.
2273 - Fixed nested title parsing (topic, sidebar directives).
2274 - Added special processing of backslash-escaped whitespace (idea
2275 from David Abrahams).
2276 - Made substitutions case-sensitive-but-forgiving; moved some code
2277 to ``docutils.nodes``.
2278 - Added support for block quote attributions.
2279 - Added a kludge to work-around a conflict between the bubble-up
2280 parser strategy and short titles (<= 3 char-long over- &
2281 underlines). Fixes SF bug #738803 "infinite loop with multiple
2282 titles" submitted by Jason Diamond.
2283 - Added explicit interpreted text roles for standard inline markup:
2284 "emphasis", "strong", "literal".
2285 - Implemented "superscript" and "subscript" interpreted text roles.
2286 - Added initial support for "abbreviation" and "acronym" roles;
2288 - Added support for "--trim-footnote-reference-space" option.
2289 - Optional space before colons in directives & hyperlink targets.
2291 * docutils/parsers/rst/tableparser.py:
2293 - Fixed a bug that was producing unwanted empty rows in "simple"
2295 - Detect bad column spans in "simple" tables.
2297 * docutils/parsers/rst/directives: Updated all directive functions to
2300 * docutils/parsers/rst/directives/__init__.py:
2302 - Added ``flag()``, ``unchanged()``, ``path()``,
2303 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2304 directive option helper functions.
2305 - Added warnings for unknown directives.
2306 - Return ``None`` for missing directives.
2307 - Added ``register_directive()``, thanks to William Dode and Paul
2310 * docutils/parsers/rst/directives/admonitions.py:
2312 - Added "admonition" directive.
2314 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2315 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2316 "parsed-literal", "rubric", "epigraph", "highlights" and
2317 "pull-quote" directives.
2319 * docutils/parsers/rst/directives/images.py:
2321 - Added an "align" attribute to the "image" & "figure" directives
2322 (by Adam Chodorowski).
2323 - Added "class" option to "image", and "figclass" to "figure".
2325 * docutils/parsers/rst/directives/misc.py:
2327 - Added "include", "raw", and "replace" directives, courtesy of
2329 - Added "unicode" and "class" directives.
2331 * docutils/parsers/rst/directives/parts.py:
2333 - Added the "sectnum" directive; by Dmitry Jemerov.
2334 - Added "class" option to "contents" directive.
2336 * docutils/parsers/rst/directives/references.py: Added to project.
2337 Contains the "target-notes" directive.
2339 * docutils/parsers/rst/languages/__init__.py:
2341 - Return ``None`` from get_language() for missing language modules.
2343 * docutils/parsers/rst/languages/de.py: Added to project; German
2344 mappings by Engelbert Gruber.
2346 * docutils/parsers/rst/languages/en.py:
2348 - Added interpreted text roles mapping.
2350 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2351 mappings by Marcelo Huerta San Martin.
2353 * docutils/parsers/rst/languages/fr.py: Added to project; French
2354 mappings by William Dode.
2356 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2357 mappings by Nicola Larosa.
2359 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2360 mappings by Miroslav Vasko.
2362 * docutils/readers/__init__.py:
2364 - Added support for the observer pattern from ``utils.Reporter``, in
2365 ``Reader.parse`` and ``Reader.transform``.
2366 - Removed ``Reader.transform()`` method.
2367 - Added default parameter values to ``Reader.__init__()`` to make
2368 instantiation easier.
2369 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2371 * docutils/readers/pep.py:
2373 - Added the ``peps.TargetNotes`` transform to the Reader.
2374 - Removed PEP & RFC reference detection code; moved to
2375 parsers/rst/states.py as options (enabled here by default).
2376 - Added support for pre-acceptance PEPs (no PEP number yet).
2377 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2380 * docutils/readers/python: Python Source Reader subpackage added to
2381 project, including preliminary versions of:
2384 - moduleparser.py: Parser for Python modules.
2386 * docutils/transforms/__init__.py:
2388 - Added ``Transformer`` class and completed transform reform.
2389 - Added unknown_reference_resolvers list for each transformer. This list holds
2390 the list of functions provided by each component of the transformer that
2391 help resolve references.
2393 * docutils/transforms/frontmatter.py:
2395 - Improved support for generic fields.
2396 - Fixed bibliographic field language lookups.
2398 * docutils/transforms/misc.py: Added to project. Miscellaneous
2401 * docutils/transforms/parts.py:
2403 - Moved the "id" attribute from TOC list items to the references
2404 (``Contents.build_contents()``).
2405 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2406 - Added "class" attribute support to ``Contents``.
2408 * docutils/transforms/peps.py:
2410 - Added ``mask_email()`` function, updating to pep2html.py's
2412 - Linked "Content-Type: text/x-rst" to PEP 12.
2413 - Added the ``TargetNotes`` PEP-specific transform.
2414 - Added ``TargetNotes.cleanup_callback``.
2415 - Added title check to ``Headers``.
2417 * docutils/transforms/references.py:
2419 - Added the ``TargetNotes`` generic transform.
2420 - Split ``Hyperlinks`` into multiple transforms.
2421 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2422 - Added check for circular indirect references.
2423 - Made substitutions case-sensitive-but-forgiving.
2425 * docutils/transforms/universal.py:
2427 - Added support for the "--expose-internal-attributes" option.
2428 - Removed ``Pending`` transform classes & data.
2430 * docutils/writers/__init__.py:
2432 - Removed ``Writer.transform()`` method.
2434 * docutils/writers/docutils-xml.py:
2436 - Added XML and doctype declarations.
2437 - Added "--no-doctype" and "--no-xml-declaration" options.
2439 * docutils/writers/html4css1.py:
2441 - "name" attributes only on these tags: a, applet, form, frame,
2443 - Added "name" attribute to <a> in section titles for Netscape 4
2444 support (bug report: Pearu Peterson).
2445 - Fixed targets (names) on footnote, citation, topic title,
2446 problematic, and system_message nodes (for Netscape 4).
2447 - Changed field names from "<td>" to "<th>".
2448 - Added "@" to "@" encoding to thwart address harvesters.
2449 - Improved the vertical whitespace optimization; ignore "invisible"
2450 nodes (targets, comments, etc.).
2451 - Improved inline literals with ``<span class="pre">`` around chunks
2452 of text and `` `` for runs of spaces.
2453 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2454 ``self.docinfo`` segments.
2455 - Added support for "line_block", "address" elements.
2456 - Improved backlinks (footnotes & system_messages).
2457 - Improved system_message output.
2458 - Redefined "--stylesheet" as containing an invariant URL, used
2459 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2461 - Added "--footnote-references" option (superscript or brackets).
2462 - Added "--compact-lists" and "--no-compact-lists" options.
2463 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2464 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2465 - Improved field list rendering.
2466 - Added Docutils version to "generator" meta tag.
2467 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2468 - Improved layout of <pre> HTML source.
2469 - Fixed attribute typo on <colspec>.
2470 - Refined XML prologue.
2471 - Support for no stylesheet.
2472 - Removed "interpreted" element support.
2473 - Added support for "title_reference", "sidebar", "attribution",
2474 "rubric", and generic "admonition" elements.
2475 - Added "--attribution" option.
2476 - Added support for "inline", "subscript", "superscript" elements.
2477 - Added initial support for "abbreviation" and "acronym";
2480 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2484 - Double quotes in literal blocks (special treatment for de/ngerman).
2485 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2486 - Added "--attribution" option.
2487 - Right align attributions.
2489 * docutils/writers/pep_html.py:
2491 - Parameterized output encoding in PEP template.
2492 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2493 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2494 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2496 - Added an override on the "--footnote-references" option.
2497 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2498 - Added Docutils version to "generator" meta tag.
2499 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2503 - Added a "silent" setting for ``buildhtml.py``.
2504 - Added a "Getting Help" section.
2505 - Rearranged the structure.
2506 - Kept up to date, with new settings, command-line options etc.
2507 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2508 - Converted settings table into a definition list.
2510 * docs/rst/quickstart.txt:
2512 - Added a table of contents.
2513 - Added feedback information.
2514 - Added mention of minimum section title underline lengths.
2515 - Removed the 4-character minimum for section title underlines.
2517 * docs/rst/quickref.html:
2519 - Added a "Getting Help" section.
2520 - Added a style to make section title backlinks more subtle.
2521 - Added mention of minimum section title underline lengths.
2522 - Removed the 4-character minimum for section title underlines.
2524 * extras: Directory added to project; contains third-party modules
2525 that Docutils depends on (optparse, textwrap, roman). These are
2526 only installed if they're not already present.
2528 * licenses: Directory added to project; contains copies of license
2529 files for non-public-domain files.
2533 - Changed the focus. It's about DTD elements: structural
2534 relationships, semantics, and external (public) attributes. Not
2535 about the element class library.
2536 - Moved some implementation-specific stuff into ``docutils.nodes``
2538 - Wrote descriptions of all common attributes and parameter
2539 entities. Filled in introductory material.
2540 - Working through the element descriptions: 55 down, 37 to go.
2541 - Removed "Representation of Horizontal Rules" to
2542 spec/rst/alternatives.txt.
2544 * spec/docutils.dtd:
2546 - Added "generated" inline element.
2547 - Added "line_block" body element.
2548 - Added "auto" attribute to "title".
2549 - Changed content models of "literal_block" and "doctest_block" to
2551 - Added ``%number;`` attribute type parameter entity.
2552 - Changed ``%structural.elements;`` to ``%section.elements``.
2553 - Updated attribute types; made more specific.
2554 - Added "address" bibliographic element.
2555 - Added "line" attribute to ``system_message`` element.
2556 - Removed "field_argument" element; "field_name" may contain
2557 multiple words and whitespace.
2558 - Changed public identifier to docutils.sf.net.
2559 - Removed "interpreted" element; added "title_reference",
2560 "abbreviation", "acronym".
2561 - Removed "refuri" attribute from "footnote_reference" and
2562 "citation_reference".
2563 - Added "sidebar", "rubric", "attribution", "admonition",
2564 "superscript", "subscript", and "inline" elements.
2566 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2568 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2570 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2572 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2575 * spec/transforms.txt: Added to project.
2577 * spec/howto: Added subdirectory, for developer how-to docs.
2579 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2580 Elza, edited & extended by David Goodger.
2582 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2585 * spec/rst/alternatives.txt:
2587 - Added "Doctree Representation of Transitions" from
2589 - Updated "Inline External Targets" & closed the debate.
2590 - Added ideas for interpreted text syntax extensions.
2591 - Added "Nested Inline Markup" section.
2593 * spec/rst/directives.txt:
2595 - Added directives: "topic", "sectnum", "target-notes",
2596 "line-block", "parsed-literal", "include", "replace", "sidebar",
2597 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2599 - Formalized descriptions of directive details.
2600 - Added an "align" attribute to the "image" & "figure" directives
2601 (by Adam Chodorowski).
2602 - Added "class" options to "topic", "sidebar", "line-block",
2603 "parsed-literal", "contents", and "image"; and "figclass" to
2606 * spec/rst/interpreted.txt: Added to project. Descriptions of
2607 interpreted text roles.
2609 * spec/rst/introduction.txt:
2611 - Added pointers to material for new users.
2613 * spec/rst/reStructuredText.txt:
2615 - Disambiguated comments (just add a newline after the "::").
2616 - Updated enumerated list description; added a discussion of the
2617 second-line validity checking.
2618 - Updated directive description.
2619 - Added a note redirecting newbies to the user docs.
2620 - Expanded description of inline markup start-strings in non-markup
2622 - Removed field arguments and made field lists a generic construct.
2623 - Removed the 4-character minimum for section title underlines.
2624 - Clarified term/classifier delimiter & inline markup ambiguity
2626 - Added "Embedded URIs".
2627 - Updated "Interpreted Text" section.
2628 - Added "Character-Level Inline Markup" section.
2630 * test: Continually adding & updating tests.
2632 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2633 - Moved test/test_pep/ to test/test_readers/test_pep/.
2634 - Added test/test_readers/test_python/.
2635 - Added test/test_writers/ (Engelbert Gruber).
2639 - Made the ``locale.setlocale()`` calls in front ends
2642 * tools/buildhtml.py:
2644 - Added "--silent" option.
2645 - Fixed bug with absolute paths & "--config".
2646 - Updated for new I/O classes.
2647 - Added some exception handling.
2648 - Separated publishers' setting defaults; prevents interference.
2649 - Updated for new ``publish_file()`` convenience function.
2651 * tools/pep-html-template:
2653 - Allow for "--embed-stylesheet".
2654 - Added Docutils version to "generator" meta tag.
2655 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2656 - Conform to XHTML spec.
2658 * tools/pep2html.py:
2660 - Made ``argv`` a parameter to ``main()``.
2661 - Added support for "Content-Type:" header & arbitrary PEP formats.
2662 - Linked "Content-Type: text/plain" to PEP 9.
2663 - Files skipped (due to an error) are not pushed onto the server.
2664 - Updated for new I/O classes.
2665 - Added ``check_requirements()`` & ``pep_type_error()``.
2666 - Added some exception handling.
2667 - Updated for new ``publish_string()`` convenience function.
2668 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2670 * tools/quicktest.py:
2672 - Added "-V"/"--version" option.
2674 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2676 * tools/unicode2rstsubs.py: Added to project. Produces character
2677 entity files (reSructuredText substitutions) from the MathML master
2680 * tools/editors: Support code for editors, added to project. Contains
2681 ``emacs/restructuredtext.el``.
2683 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2685 - Added style for chunks of inline literals.
2686 - Removed margin for first child of table cells.
2687 - Right-aligned field list names.
2688 - Support for auto-numbered section titles in TOCs.
2689 - Increased the size of inline literals (<tt>) in titles.
2690 - Restored the light gray background for inline literals.
2691 - Added support for "line_block" elements.
2692 - Added style for "address" elements.
2693 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2694 - Improved field list rendering.
2695 - Vertical whitespace improvements.
2696 - Removed "a.target" style.
2698 * tools/stylesheets/pep.css:
2700 - Fixed nested section margins.
2701 - Other changes parallel those of ``../default.css``.
2704 Release 0.2 (2002-07-31)
2705 ========================
2709 - The word "component" was being used ambiguously. From now on,
2710 "component" will be used to mean "Docutils component", as in Reader,
2711 Writer, Parser, or Transform. Portions of documents (Table of
2712 Contents, sections, etc.) will be called "document parts".
2713 - Did a grand renaming: a lot of ``verylongnames`` became
2714 ``very_long_names``.
2715 - Cleaned up imports: no more relative package imports or
2716 comma-separated lists of top-level modules.
2717 - Added support for an option values object which carries default
2718 settings and overrides (from command-line options and library use).
2719 - Added internal Unicode support, and support for both input and
2721 - Added support for the ``docutils.io.IO`` class & subclasses.
2725 * docutils/__init__.py:
2727 - Added ``ApplicationError`` and ``DataError``, for use throughout
2729 - Added ``Component`` base class for Docutils components; implements
2730 the ``supports`` method.
2731 - Added ``__version__`` (thus, ``docutils.__version__``).
2735 - Removed many keyword parameters to ``Publisher.__init__()`` and
2736 ``publish()``; bundled into an option values object. Added
2737 "argv", "usage", "description", and "option_spec" parameters for
2738 command-line support.
2739 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2741 - Reworked I/O model for ``docutils.io`` wrappers.
2742 - Updated ``Publisher.set_options()``; now returns option values
2744 - Added support for configuration files (/etc/docutils.conf,
2745 ./docutils.conf, ~/.docutils).
2746 - Added ``Publisher.setup_option_parser()``.
2747 - Added default usage message and description.
2749 * docutils/frontend.py: Added to project; support for front-end
2750 (command-line) scripts. Option specifications may be augmented by
2751 components. Requires Optik (http://optik.sf.net/) for option
2752 processing (installed locally as docutils/optik.py).
2754 * docutils/io.py: Added to project; uniform API for a variety of input
2757 * docutils/nodes.py:
2759 - Added ``TreeCopyVisitor`` class.
2760 - Added a ``copy`` method to ``Node`` and subclasses.
2761 - Added a ``SkipDeparture`` exception for visitors.
2762 - Renamed ``TreePruningException`` from ``VisitorException``.
2763 - Added docstrings to ``TreePruningException``, subclasses, and
2765 - Improved docstrings.
2766 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2767 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2769 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2770 ``PreDecorative`` mixin.
2771 - Reworked the name/id bookkeeping; to ``document``, removed
2772 ``explicit_targets`` and ``implicit_targets`` attributes, added
2773 ``nametypes`` attribute and ``set_name_id_map`` method.
2774 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2776 - Added ``document.has_name()`` method.
2777 - Fixed DOM generation for list-attributes.
2778 - Added category class ``Labeled`` (used by footnotes & citations).
2779 - Added ``Element.set_class()`` method (sets "class" attribute).
2781 * docutils/optik.py: Added to project. Combined from the Optik
2782 package, with added option groups and other modifications. The use
2783 of this module is probably only temporary.
2785 * docutils/statemachine.py:
2787 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2788 - Added underscores to improve many awkward names.
2789 - In ``string2lines()``, changed whitespace normalizing translation
2790 table to regexp; restores Python 2.0 compatibility with Unicode.
2792 * docutils/urischemes.py:
2794 - Filled in some descriptions.
2795 - Added "shttp" scheme.
2797 * docutils/utils.py:
2799 - Added ``clean_rcs_keywords`` function (moved from
2800 docutils/transforms/frontmatter.py
2801 ``DocInfo.filter_rcs_keywords``).
2802 - Added underscores to improve many awkward names.
2803 - Changed names of Reporter's thresholds:
2804 warning_level -> report_level; error_level -> halt_level.
2805 - Moved ``utils.id()`` to ``nodes.make_id()``.
2806 - Added ``relative_path(source, target)``.
2808 * docutils/languages/de.py: German mappings; added to project. Thanks
2809 to Gunnar Schwant for the translations.
2811 * docutils/languages/en.py: Added "Dedication" bibliographic field
2814 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2817 * docutils/parsers/rst/states.py:
2819 - Added underscores to improve many awkward names.
2820 - Added RFC-2822 header support.
2821 - Extracted the inline parsing code from ``RSTState`` to a separate
2822 class, ``Inliner``, which will allow easy subclassing.
2823 - Made local bindings for ``memo`` container & often-used contents
2824 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2825 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2826 - Added ``MarkupMismatch`` exception; for late corrections.
2827 - Added ``-/:`` characters to inline markup's start string prefix,
2828 ``/`` to end string suffix.
2829 - Fixed a footnote bug.
2830 - Fixed a bug with literal blocks.
2831 - Applied patch from Simon Budig: simplified regexps with symbolic
2832 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2833 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2834 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2835 - Allowed non-ASCII in "simple names" (directive names, field names,
2837 - Converted ``Inliner.patterns.initial`` to be dynamically built
2838 from parts with ``build_regexp()`` function.
2839 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2840 - Updated docstrings.
2841 - Changed "table" to "grid_table"; added "simple_table" support.
2843 * docutils/parsers/rst/tableparser.py:
2845 - Changed ``TableParser`` to ``GridTableParser``.
2846 - Added ``SimpleTableParser``.
2847 - Refactored naming.
2849 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2850 a fallback language for directive names.
2852 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2853 directive to use a ``pending`` element, used only by HTML writers.
2855 * docutils/parsers/rst/directives/parts.py: Renamed from
2858 - Added "backlinks" attribute to "contents" directive.
2860 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2861 project by Adam Chodorowski.
2863 * docutils/readers/__init__.py: Gave Readers more control over
2864 choosing and instantiating Parsers.
2866 * docutils/readers/pep.py: Added to project; for PEP processing.
2868 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2869 requires a ``component`` parameter.
2871 * docutils/transforms/components.py: Added to project; transforms
2872 related to Docutils components.
2874 * docutils/transforms/frontmatter.py:
2876 - In ``DocInfo.extract_authors``, check for a single "author" in an
2877 "authors" group, and convert it to a single "author" element.
2878 - Added support for "Dedication" and generic bibliographic fields.
2880 * docutils/transforms/peps.py: Added to project; PEP-specific.
2882 * docutils/transforms/parts.py: Renamed from old components.py.
2884 - Added filter for `Contents`, to use alt-text for inline images,
2885 and to remove inline markup that doesn't make sense in the ToC.
2886 - Added "name" attribute to TOC topic depending on its title.
2887 - Added support for optional TOC backlinks.
2889 * docutils/transforms/references.py: Fixed indirect target resolution
2890 in ``Hyperlinks`` transform.
2892 * docutils/transforms/universal.py:
2894 - Changed ``Messages`` transform to properly filter out system
2895 messages below the warning threshold.
2896 - Added ``Decorations`` transform (support for ``--generator``,
2897 ``--date``, ``--time``, ``--source-link`` options).
2899 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2900 Engelbert Gruber's PDF writer.
2902 * docutils/writers/html4css1.py:
2904 - Made XHTML-compatible (switched to lowercase element & attribute
2905 names; empty tag format).
2906 - Escape double-dashes in comment text.
2907 - Improved boilerplate & modularity of output.
2908 - Exposed modular output in Writer class.
2909 - Added a "generator" meta tag to <head>.
2910 - Added support for the ``--stylesheet`` option.
2911 - Added support for ``decoration``, ``header``, and ``footer``
2913 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2914 translation table to regexp; restores Python 2.0 compatibility
2916 - Added the translator class as instance variable to the Writer, to
2917 make it easily subclassable.
2918 - Improved option list spacing (thanks to Richard Jones).
2919 - Modified field list output.
2920 - Added backlinks to footnotes & citations.
2921 - Added percentage widths to "<col>" tags (from colspec).
2922 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2923 "<span>" changed to "<var>".
2924 - Inline literals: "<code>" changed to "<tt>".
2925 - Many changes to optimize vertical space: compact simple lists etc.
2926 - Add a command-line options & directive attributes to control TOC
2927 and footnote/citation backlinks.
2928 - Added support for optional footnote/citation backlinks.
2929 - Added support for generic bibliographic fields.
2930 - Identify backrefs.
2931 - Relative URLs for stylesheet links.
2933 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2934 PEPs (subclass of ``html4css1.Writer``).
2936 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2938 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2939 of the Docutils internal doctree in XML.
2941 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2945 - Changed the title to "The Docutils Document Tree".
2946 - Added "Hyperlink Bookkeeping" section.
2948 * spec/docutils.dtd:
2950 - Added ``decoration``, ``header``, and ``footer`` elements.
2951 - Brought ``interpreted`` element in line with the parser: changed
2952 attribute "type" to "role", added "position".
2953 - Added support for generic bibliographic fields.
2955 * spec/notes.txt: Continual updates. Added "Project Policies".
2957 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2960 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2962 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2963 mailing list discussions.
2965 * spec/pep-0287.txt:
2967 - Renamed to "reStructuredText Docstring Format".
2969 - Reworked Q&A as an enumerated list.
2970 - Converted to reStructuredText format.
2972 * spec/pysource.dtd:
2974 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2976 * spec/pysource.txt: Removed from project. Moved much of its contents
2979 * spec/rst/alternatives.txt:
2981 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2982 - Added "Inline External Targets" section.
2984 * spec/rst/directives.txt:
2986 - Added "backlinks" attribute to "contents" directive.
2988 * spec/rst/problems.txt:
2990 - Updated the Enumerated List Markup discussion.
2991 - Added new alternative table markup syntaxes.
2993 * spec/rst/reStructuredText.txt:
2995 - Clarified field list usage.
2996 - Updated enumerated list description.
2997 - Clarified purpose of directives.
2998 - Added ``-/:`` characters to inline markup's start string prefix,
2999 ``/`` to end string suffix.
3000 - Updated "Authors" bibliographic field behavior.
3001 - Changed "inline hyperlink targets" to "inline internal targets".
3002 - Added "simple table" syntax to supplement the existing but
3003 newly-renamed "grid tables".
3004 - Added cautions for anonymous hyperlink use.
3005 - Added "Dedication" and generic bibliographic fields.
3007 * test: Made test modules standalone (subdirectories became packages).
3009 * test/DocutilsTestSupport.py:
3011 - Added support for PEP extensions to reStructuredText.
3012 - Added support for simple tables.
3013 - Refactored naming.
3015 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3017 - Now supports true packages containing test modules
3018 (``__init__.py`` files required); fixes duplicate module name bug.
3020 * test/test_pep/: Subpackage added to project; PEP testing.
3022 * test/test_rst/test_SimpleTableParser.py: Added to project.
3026 - Updated html.py and publish.py front-end tools to use the new
3027 command-line processing facilities of ``docutils.frontend``
3028 (exposed in ``docutils.core.Publisher``), reducing each to just a
3030 - Added ``locale.setlocale()`` calls to front-end tools.
3032 * tools/buildhtml.py: Added to project; batch-generates .html from all
3033 the .txt files in directories and subdirectories.
3035 * tools/default.css:
3037 - Added support for ``header`` and ``footer`` elements.
3038 - Added styles for "Dedication" topics (biblio fields).
3040 * tools/docutils.conf: A configuration file; added to project.
3042 * tools/docutils-xml.py: Added to project.
3044 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3046 * tools/pep-html-template: Added to project.
3048 * tools/pep2html.py: Added to project from Python (nondist/peps).
3049 Added support for Docutils (reStructuredText PEPs).
3051 * tools/quicktest.py:
3053 - Added the ``--attributes`` option, hacked a bit.
3054 - Added a second command-line argument (output file); cleaned up.
3056 * tools/stylesheets/: Subdirectory added to project.
3058 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3061 Release 0.1 (2002-04-20)
3062 ========================
3064 This is the first release of Docutils, merged from the now inactive
3065 reStructuredText__ and `Docstring Processing System`__ projects. For
3066 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3067 `DPS HISTORY`__ files.
3069 __ http://structuredtext.sourceforge.net/
3070 __ http://docstring.sourceforge.net/
3071 __ http://structuredtext.sourceforge.net/HISTORY.html
3072 __ http://docstring.sourceforge.net/HISTORY.html
3074 General changes: renamed 'dps' package to 'docutils'; renamed
3075 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3076 the test suites (reStructuredText's test/test_states renamed to
3077 test/test_rst); and all modifications required to make it all work.
3079 * docutils/parsers/rst/states.py:
3081 - Improved diagnostic system messages for missing blank lines.
3082 - Fixed substitution_reference bug.
3088 indent-tabs-mode: nil
3089 sentence-end-double-space: t