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.
20 * docutils/docs/ref/docutils.dtd:
22 - Enable validation of Docutils XML documents against the DTD:
24 Use attribute type NMTOKEN instead of REFID for the `refid` attribute
25 and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
26 however, the `ids` attribute cannot use the ID type because `XML only
27 allows one ID per Element Type`__ and doesn't support a multiple-ID
30 __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
32 * docs/ref/rst/restructuredtext.txt:
34 - Added documentation for escaped whitespace in URI contexts.
35 - Clarify use of Unicode character categories.
37 * docutils/parsers/rst/states.py:
39 - Added functionality: escaped whitespace in URI contexts.
40 - Consistent handling of all whitespace characters in inline markup
41 recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
43 * docutils/parsers/rst/directives/images.py:
45 - Added support for escaped whitespace in URI contexts.
47 * docutils/parsers/rst/directives/tables.py:
49 - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
50 that led to problems in an application with a custom table directive).
52 * docutils/utils/__init__.py:
54 - Added ``split_escaped_whitespace`` function, support for escaped
55 whitespace in URI contexts.
57 * docutils/utils/smartquotes.py:
59 - Update quote definitions for languages et, fi, ro, sv, tr, uk.
60 - New quote definitions for hr, hsb, hu, lv, sl.
61 - Fix [ 313 ] Differentiate apostrophe from closing single quote
64 * docutils/writers/_html_base.py
66 - Provide default title in metadata (required by HTML5).
67 - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
69 * docutils/writers/html4css1/__init__.py
71 - Apply [ 125 ] HTML writer: respect automatic table column sizing.
73 * docutils/writers/latex2e/__init__.py
75 - Handle class arguments for block-level elements by wrapping them
76 in a "DUclass" environment. This replaces the special handling for
77 "epigraph" and "topic" elements.
79 * tools/rst2html4.py: New front-end.
81 * tools/dev/generate_punctuation_chars.py: New skript
82 to test and update utils.punctuation_chars.
85 Release 0.13.1 (2016-12-09)
86 ===========================
88 * docutils/languages/fa.py
89 docutils/parsers/rst/languages/fa.py
90 docutils/languages/la.py
91 docutils/parsers/rst/languages/la.py:
93 - Apply [ 133 ] Persian mappings by Shahin Azad.
94 - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
98 - Fix [ 253 ] Attribute key without value not allowed in XML.
102 - Apply [ 103 ] Recognize inline markups without word boundaries.
103 - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
105 * docutils/parsers/rst/__init__.py
107 - Fix [ 233 ] Change the base URL for the :rfc: role.
109 * docutils/parsers/rst/directives/tables.py
111 - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
114 - Implement feature request [ 48 ]
115 Add :align: option to the table directives.
116 Thanks to Takeshi KOMIYA for the patch.
118 * docutils/parsers/rst/roles.py
120 - Fix [ 295 ] Class argument for custom role inheriting from math.
122 * docutils/parsers/rst/tableparser.py
124 - Really fix [ 159 ] Spurious table column alignment errors.
126 * docutils/transforms/frontmatter.py
128 - Add name of generic bibliographic fields as a "classes" attribute value
129 (after conversion to a valid identifier form).
131 * docutils/utils/error_reporting.py
133 - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
135 * docutils/utils/math/math2html.py
137 - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
138 - New upstream version (additional macros, piecewise integrals and sums).
140 * docutils/writers/_html_base.py
142 - New auxiliary module for definitions common to all HTML writers.
144 * docutils/writers/html5_polyglot/
146 - New HTML writer generating clean, polyglot_ markup conforming to
149 The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
150 and recommended layout rules.
152 * docutils/writers/html4css1/__init__.py
154 - Add "docutils" to class values for "container" object to address [ 267 ].
155 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
156 ``default_stylesheet_path`` and ``default_template_path``.
157 - Fix [ 266 ] creating labels/class values in description list items.
158 - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
159 - Fix footnotes with content that does not start with a paragraph.
160 - Use https in default MathJax URL (report Alan G Isaac).
161 - Outsourcing of common code to _html_base.py.
163 * docutils/writers/latex2e/__init__.py
165 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
166 admonitions and docinfo.
168 - Use absolute path for ``default_template_path``.
170 - Removed deprecated options ``--use-latex-footnotes`` and
171 ``--figure-footnotes``.
173 - Cleaner LaTeX code for enumerations and literal blocks.
175 - Use "hyperref" package together with "bookmark" (improved hyperlinking
178 - Fix [ 286 ] Empty column title cause invalid latex file.
180 - Fix [ 224 ] Fix rowspan support for tables.
182 - Let LaTeX determine the column widths in tables with "colwidths-auto".
183 Not suited for multi-paragraph cells!
185 * docutils/writers/odf_odt/__init__.py
187 - remove decode.encode of filename stored in zip.
189 * docutils/writers/xetex/__init__.py
191 - LuaLaTex compatibility: do not load "xunicode".
195 - New front-end ``rst2html5.py``.
199 - Test py26, py27, py33 and py34.
201 To use, install the ``tox`` package via pip or easy_install and use
202 tox from the project root directory.
204 .. _polyglot: http://www.w3.org/TR/html-polyglot/
205 .. _HTML 5: http://www.w3.org/TR/html5/
206 .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
209 Release 0.12 (2014-07-06)
210 =========================
212 * docs/ref/rst/directives.txt
214 - Update "math" and "csv-table" descriptions.
216 * docutils/parsers/rst/directives/images.py
218 - Fix [ 258 ] figwidth="image" generates unitless width value.
220 * docutils/parsers/rst/states.py
222 - Improve error report when a non-ASCII character is specified as
223 delimiter, quote or escape character under Python 2.
224 Fixes [ 249 ] and [ 250 ].
226 * docutils/writers/html4css1/__init__.py
228 - Don't add newline after inline math.
229 Thanks to Yury G. Kudryashov for the patch.
231 * docutils/writers/latex2e/__init__.py
233 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
234 - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
236 * docutils/writers/odf_odt/__init__.py
238 - Apply patch by Jakub Wilk to fix bug [ 100 ].
240 * test/test_error_reporting.py
242 - Fix [ 223 ] by removing redundant tests we do not have control over.
246 - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
248 Release 0.11 (2013-07-22)
249 =========================
253 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
254 - Support embedded aliases within hyperlink references.
255 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
256 language module) before global search.
260 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
262 * docutils/parsers/rst/directives/__init__.py
264 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
266 * docutils/parsers/rst/directives/images.py
268 - Apply [ 3599485 ] node source/line information for sphinx translation.
270 * docutils/parsers/rst/directives/tables.py
272 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
274 * docutils/parsers/rst/states.py
276 - Fix [ 157 ] Line block parsing doesn't like system message.
277 - Always import our local copy of roman.py (report Larry Hastings).
279 * docutils/transforms/references.py
281 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
283 * docutils/utils/__init__.py
285 - Fix [ 3596884 ] exception importing ``docutils.io``.
287 * docutils/writers/html4css1/__init__.py
289 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
290 - New setting `stylesheet_dirs`: Comma-separated list of directories
291 where stylesheets are found. Used by `stylesheet_path` when expanding
292 relative path arguments.
293 - New default for math-output_: ``HTML math.css``.
294 - Avoid repeated class declarations in html4css1 writer
295 (modified version of patch [ 104 ]).
297 .. _math-output: docs/user/config.html#math-output
299 * docutils/writers/latex2e/__init__.py
301 - Drop the simple algorithm replacing straight double quotes with
302 English typographic ones.
303 Activate the SmartQuotes_ transform if you want this feature.
304 - Fix literal use of babel shorthands (straight quote, tilde, ...).
305 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
306 - New setting `stylesheet_dirs`.
308 .. _SmartQuotes: docs/user/config.html#smart-quotes
310 * docutils/writers/manpage.py
312 - Fix [3607063] handle lines starting with a period.
313 - Fix option separating comma was bold (thanks to Bill Morris).
315 Release 0.10 (2012-12-16)
316 =========================
320 - Dropped support for Python 2.3.
321 - ``docutils/math``, ``docutils/error_reporting.py``, and
322 ``docutils/urischemes.py`` moved to the utils package.
323 - Fix [3541369] Relative __import__ also with Python 3.3.
324 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
325 and parsers for Python 2.7 up.
326 - Fix import of PIL.Image.
327 - Change default of "syntax highlight" option to "long",
328 basic syntax highlight styles for LaTeX and HTML.
332 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
333 option is ignored and will be removed in a future release.
334 - Fix Py3k error writing to stdout with encoding differing from default.
335 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
337 * docutils/parsers/rst/directives/misc.py
339 - Fix [ 3546533 ] Unicode error with `date` directive.
341 * docutils/transforms/universal.py
343 - SmartQuotes transform for typographic quotes and dashes.
345 * docutils/utils/__init__.py
347 - normalize_language_tag() now returns `BCP 47`_ conformant tags
348 with subtags separated by ``-``.
350 * docutils/writers/html4css1/__init__.py
352 - Use ``<code>`` tag for inline "code",
353 do not drop nested inline nodes (syntax highlight tokens).
354 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
355 - No line break after opening inline math tag.
357 * docutils/writers/manpage.py
359 - Apply [ 3527401 ] addmonition's don't preserve indentation
360 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
362 * docutils/writers/xetex/__init__.py
364 - Apply [ 3555160 ] ensure order of "otherlanguages".
365 - Fix section numbering by LaTeX.
367 * docutils/writers/s5_html/__init__.py
369 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
371 * docutils/writers/s5_html/docutils_xml.py
373 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
374 - Fix/improve output with ``--indent`` option.
378 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
380 * tools/test/test_buildhtml.py
382 - Fix [ 3521167 ] allow running in any directory.
383 - Fix [ 3521168 ] allow running with Python 3.
386 Release 0.9.1 (2012-06-17)
387 ==========================
391 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
392 installed in the PYTHONPATH. Converted tests are now
393 stored in ``test3/``, tools no longer need conversion.
395 If you installed one of Docutils versions 0.7 ... 0.9 with
396 ``setup.py install`` under Python 3, remove the spurious
397 ``test/`` and ``tools/`` directories in the site library root.
401 - Make tests independent from the location of the ``test/`` directory.
402 - Use converted sources (from the ``build/`` directory) for tests under
407 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
411 - Fix writing binary data to sys.stdout under Python 3 (allows
412 ``rst2odt.py`` to be used with output redirection).
414 * docutils/parsers/rst/directives/misc.py
416 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
417 ``locale == C`` and 8-bit char in path argument of `include` directive.
421 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
424 Release 0.9 (2012-05-02)
425 ========================
429 - New reStructuredText "code" role and directive and "code" option
430 of the "include" directive with syntax highlighting by Pygments_.
431 - Fix parse_option_marker for option arguments containing ``=``.
432 - Fix [ 2993756 ]: import Python Imaging Library's Image module
433 via ``import PIL`` as starting with PIL 1.2,
434 "PIL lives in the PIL namespace only" (announcement__).
436 .. _Pygments: http://pygments.org/
437 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
441 - Fix [ 2971827 ] and [ 3442827 ]
442 extras/roman.py moved to docutils/utils/roman.py
444 * docutils/frontend.py
446 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
450 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
451 - `mode` argument for FileOutput avoids code replication in
453 - New exceptions InputError and OutputError for IO errors in
454 FileInput/FileOutput.
458 - No "hard" system exit on file IO errors: catch and report them in
459 `Publisher.reportException` instead. Allows handling by a calling
460 application if the configuration setting `traceback` is True.
462 * docutils/utils.py -> docutils/utils/__init__.py
464 - docutils.utils is now a package (providing a place for sub-modules)
466 .. note:: docutils/math, docutils/error_reporting.py, and
467 docutils/urischemes.py will move to the utils package in the next
468 release, too. See RELEASE-NOTES__
470 __ RELEASE-NOTES.html
472 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
473 errors recording non-ASCII filenames (fixes [ 3434355 ]).
475 - Fix relative_path() with source=None and `unicode` target.
477 * docutils/parsers/rst/states.py
479 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
480 characters and "international" quotes around inline markup.
481 - Use `field_marker` pattern to look for start of a
482 directive option block (fixes [ 3484857 ]).
484 * docutils/parsers/rst/tableparser.py
486 - Fix [ 2926161 ] for simple tables.
487 (Combining chars in grid tables still contribute to cell width.)
489 * docutils/writers/latex2e/__init__.py
491 - Support the `abbreviation` and `acronym` standard roles.
492 - Record only files required to generate the LaTeX source as dependencies.
493 - Fix handling of missing stylesheets.
494 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
495 when suppressing LaTeX section numbering.
496 - Use ``\DUtitle`` for unsupported section levels
497 - Apply [ 3512791 ] do not compare string literals with "is"
499 * docutils/writers/xetex/__init__.py
501 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
503 * docutils/writers/html4css1/__init__.py
505 - Change default for `math-output` setting to MathJax.
506 - Fix handling of missing stylesheets.
508 * docutils/writers/docutils_xml.py
510 - Use the visitor pattern with default_visit()/default_depart() methods
511 instead of minidom to facilitate special handling of selected nodes.
512 - Support raw XML (inserted as-is inside a <raw></raw> node).
514 * docutils/writers/manpage.py
516 - Do not emit comment line with trailing blank. Problematic for VCS.
518 Release 0.8.1 (2011-08-30)
519 ==========================
523 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
524 and [ 3395920 ] (correct copyright info for rst.el).
528 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
530 * docutils/writers/latex2e/__init__.py
532 - Clean up Babel language setting. Restores Sphinx compatibility.
534 Release 0.8 (2011-07-07)
535 ========================
539 - Handle language codes according to `BCP 47`_.
540 - If the specified language is not supported by Docutils,
541 warn and fall back to English.
542 - Math support: reStructuredText "math" role and directive,
543 ``math`` and ``math_block`` doctree elements.
544 - Decode command line arguments with the locale's preferred encoding
545 (to allow, e.g., ``--title=Dornröschen``).
546 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
547 - New sub-module `error_reporting`: handle encoding/decoding errors
548 when reporting exceptions.
549 - Some additions to the Docutils core are released under the 2-Clause BSD
550 license, see COPYING_ for details.
552 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
553 .. _COPYING: COPYING.html
557 - Most directives now support a "name" option that attaches a
560 - Directive content may start on the first line also when the directive
561 type accepts options.
563 * docs/dev/policies.txt:
565 - Recommend the 2-Clause BSD license
566 (http://www.spdx.org/licenses/BSD-2-Clause)
567 for code that is kept under the author's copyright.
569 * tools/buildhtml.py:
571 - Fix ``--local`` switch.
573 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
575 * docutils/writers/html4css1/__init__.py
577 - Set "lang" argument for objects with class argument
578 "language-<language tag>".
579 - New setting "math-output" with support for HTML, MathML, and LaTeX.
581 * docutils/writers/latex2e/__init__.py
583 - Fix [ 3043986 ] AttributeError using :local: with table of content.
584 - Place title data in the document preamble.
585 - Load `babel` package only if required.
586 - Update list of supported languages.
587 - New config setting "hyperref-options".
588 No hard-coded "unicode" hyperref option (clash with xetex).
589 - Set language for custom roles, paragraphs, block-quotes, and
590 line-quotes with class argument "language-<language tag>".
591 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
592 - Convert image URI to a local file path.
593 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
594 has more than one paragraph (Wolfgang Scherer).
595 - \leavevmode before longtable only when needed (prevents spurious vspace)
596 - do not advance table counter for tables without caption
598 * docutils/writers/xetex/__init__.py
600 - New writer generating LaTeX code for compiling with ``xelatex``.
602 A separate writer (inheriting from latex2e) instead of a ``--xetex``
603 option allows separate config options for XeTeX vs. LaTeX2e.
605 * docutils/writers/manpage.py
607 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
608 - Fix: vertical space cleaning for option group ``.``.
610 * tools/editors/emacs/rst.el:
612 - Fix [ 3001100 ] does not handle spaces in filenames
613 (thanks to Jakub Wilk)
617 - strip whitespace from stylesheet arguments
618 - exclude combining chars from column_width()
619 (partial fix for [ 2926161 ])
621 * docutils/parsers/rst/directives/misc.py:
623 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
628 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
629 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
631 Release 0.7 (2010-07-07)
632 ========================
636 - Fix [ 2881769 ] setup configuration.
637 - Fix [ 2788716 ] reporting problems in included files.
641 - FileInput opens files as text files with universal newline support
642 (mode "rU", configurable with the new optional argument "mode").
646 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
650 - Fix [ 2923723 ] let decode_path() tolerate path == None
652 * docutils/writers/html4css1/__init__.py
654 - Support SVG and SWF images (thanks to Stefan Rank).
655 - Generate valid XHTML for centered images with targets.
656 Use CSS classes instead of "align" tags for image alignment.
658 * docutils/writers/latex2e/__init__.py
660 - Use `transforms.writer_aux.Admonitions` to "normalize" special
662 - Use the ``\url`` command for URLs (breaks long URLs instead of
663 writing into the margin).
664 - Preserve runs of spaces in `inline literals`__.
665 - Deprecate ``figure_footnotes`` setting.
666 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
667 - New ``latex_preamble`` setting.
668 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
669 - Fix hyperlink targets (labels) for images, figures, and tables.
670 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
671 - Apply [ 2961991 ] Call hyperref with unicode option.
672 - Drop the special `output_encoding`__ default ("latin-1").
673 The Docutils wide default (usually "UTF-8") is used instead.
674 - Render inline markup in document title and subtitle.
675 - Fix numbering depth with LaTeX section numbering.
676 - Update Unicode -> LaTeX translations.
677 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
679 __ docs/ref/restructuredtext.html#inline-literals
680 __ docs/user/config.html#docutils-footnotes
681 __ docs/user/config.html#output_encoding
683 * docutils/writers/manpage.py
685 - Fix: supported attribute (thanks to peter2108).
686 - Remove trailing blanks in code (keep in sync with mercurial version).
687 - Titles level 1, that is ``.SH``, always uppercase.
688 - Apply patch from mg: literal text should be bold in man-pages.
692 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
697 - Python 3 support: copy test/ and tools/ to the build-dir
698 and convert Python sources with 2to3.
701 Release 0.6 (2009-10-11)
702 ========================
706 - Docutils is now compatible with Python versions from 2.3 up to 2.6
707 and convertible to 3.1 code.
709 + Node.__nonzero__ returns True instead of 1.
710 + use os.walk instead os.path.walk.
711 + minimize "types" module where possible.
712 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
713 + Text nodes now subclass unicode rather than UserString
714 (which is gone in python 3.0).
715 + 3.0 compatibility module docutils._compat
717 + Drop 2.2 compatibility workarounds.
718 + Drop extras/optparse.py and extras/textwrap.py
719 (stdlib modules since 2.3).
721 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
722 - Unix man page export: manpage writer moved from sandbox to Doctutils
725 - Apply [ 1719345 ] Galician translation
726 - Apply [ 1905741 ] Polish translation
727 - Apply [ 1878977 ] make_id(): deaccent characters.
728 - Apply [ 2029251 ] return nonzero when tests fail.
729 - Fix [ 1692788 ] allow UTF-8 in style sheets.
730 - Fix [ 2781629 ] support non-ASCII chars in file names.
731 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
732 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
733 - Fix [ 2821266 ] --strict option works now like --halt=info.
734 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
735 - Fix [ 1627229 ] hyperlink references in substitutions.
737 - The "newlatex" writer is orphaned.
741 - Documented Unicode characters allowed as inline markup openers,
742 closers, and delimiters.
743 - Allow units for all length specifications.
744 - Allow percent sign in "scale" argument of "figure" and "image" directives.
745 - Bugfix: The "figalign" argument of a figure now works as intended
746 (aligning the figure, not its contents).
747 - Align images with class "align-[right|center|left]"
748 (allows setting the alignment of an image in a figure).
752 - Added ``Element.__contains__`` method, for the in-operator.
754 * docutils/parsers/rst/states.py:
756 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
757 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
758 " " (non-breaking space), and "¡ ¿" openers.
760 * docutils/parsers/directives/misc.py:
762 - Added ``start-line`` and ``end-line`` options to "include"
763 directive to select a range of lines.
764 - Hard tabs in literal inclusions are replaced by spaces. This is
765 configurable via the new ``tab-width`` option of the "include" directive
766 (a negative tab-width prevents tab expansion).
770 - Add ``get_stylesheet_list`` function.
771 - Apply [ 2834836 ] print info at halt
773 * docutils/transforms/universal.py:
775 - Raise default priority of StripClasses to exclude stripped classes from
778 * docutils/writers/html4css1/__init__.py:
780 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
781 separated list of stylesheets.
782 - Address [ 1938891 ] Inline literal text creates "pre" span only when
783 needed to prevent inter-word line wraps.
784 - Use `translate` method instead of repeated `replace` calls.
785 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
786 classes to allow CSS styling that does not interfere with other
787 table-using constructs (field lists, citations, ...).
789 * docutils/writers/newlatex2e/__init__.py:
791 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
793 * docutils/writers/latex2e/__init__.py (see also
794 `<docs/user/docutils-05-compat.sty.html>`__) :
796 - Add ``--embed-stylesheet`` option.
797 - Apply [ 1474017 ] image vertical alignment is reversed.
798 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
799 - Change: has_key for dictionaries (not Nodes) to in-operator.
800 - Merge adjacent citations into one latex cite command.
801 - Failsave implementation of custom roles. LaTeX compilation now ignores
802 unknown classes instead of aborting with an error.
803 - Support custom roles based on standard roles.
804 - LaTeX packages can be used as ``--stylesheet`` arguments without
805 restriction. (A style sheet is now referenced with the ``\usepackage``
806 command, if it ends with ``.sty`` or has no extension.)
807 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
808 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
809 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
810 2005-02-04 as a configurable length unit).
811 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
812 if font-encoding is set to ''. LaTeX defaults to OT1 then.
813 - Set sub- and superscript role argument in text mode not as math.
814 Use a custom role based on sub-/superscript if you want italic shape.
815 - Shorter preamble and less dependencies: Load packages and define macros
816 only if required in the document.
817 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
818 - New custom environments and commands with optional "classes" argument.
819 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
820 - Better conformance to Docutils specifications with ``--use-latex-toc``.
821 Support for LaTeX generated ToC also with unnumbered sections.
822 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
823 section numbering by LaTeX.
824 - Use default font in admonitions and sidebar.
825 - Align of image in a figure defaults to 'center'.
826 - Bugfix: Newlines around targets and references prevent run-together
828 - Fix internal hyperlinks.
829 - Use class defaults for page margins ('typearea' now optional).
830 - Float placement made configurable, default changed to "here definitely".
831 - Typeset generic topic as "quote block with title".
832 - Use template (file and configuration option).
833 - In the default template, load cmap.sty (fix text extraction in PDF) and
834 fixltx2e.sty (LaTeX patches, \textsubscript).
835 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
836 - Use `translate` instead of repeated `replace` calls for text encoding.
837 - Hyperlinked footnotes and support for symbol footnotes and
838 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
839 - Complete pairs of binary options
840 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
841 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
843 - font-encoding: "T1" (formerly implicitely set by 'ae').
844 - use-latex-toc: true (ToC with page numbers).
845 - use-latex-footnotes: true (no mixup with figures).
847 * docutils/writers/manpage.py
849 - Do not print version at document end, this is done by the viewer.
850 - Do not print date at document end, this is done by the viewer.
851 - Fix storage of docinfo fields for none standard fields.
853 * docutils/tools/rst2man.py
855 Release 0.5 (2008-06-25)
856 ========================
858 * docutils/languages/he.py: Added to project: Hebrew mappings by
861 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
862 mappings by Meir Kriheli.
864 * docutils/frontend.py:
866 - Configuration files are now assumed and required to be
868 - Paths of applied configuration files are now recorded in the
869 runtime setting ``_config_files`` (accessible via
870 ``--dump-settings``).
871 - Added ``--strip-elements-with-class`` and ``--strip-class``
872 options (``strip_elements_with_classes`` and ``strip_classes``
877 - Added code to determine the input encoding from data: encoding
878 declarations or the presence of byte order marks (UTF-8 & UTF-16).
879 - Added support for IronPython 1.0.
883 - Added ``document.__getstate__`` method, for pickling.
885 * docutils/parsers/rst/states.py:
887 - Allow ``+`` and ``:`` in reference names.
888 - Unquoted targets beginning with an underscore (``.. __target:
889 URI``) are no longer accepted.
890 - Added support for multiple attributions in a physical block quote
891 (indented text block), dividing it into multiple logical block
893 - Added support for unicode bullets in bullet lists: "•", "‣", and
895 - Added support for new object-oriented directive interface,
896 retaining compatibility to the old functional interface.
897 - Added support for throwing ``DirectiveError``'s from within
900 * docutils/parsers/rst/__init__.py:
902 - Added ``Directive`` base class.
903 - Added ``DirectiveError`` base class.
904 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
907 * docutils/parsers/directives/:
909 - Refactored all reStructuredText directives to use the new
910 object-oriented directive interface. Errors are now (mostly)
911 thrown using the new ``DirectiveError`` class.
913 * docutils/parsers/directives/misc.py:
915 - Added ``start-after`` and ``end-before`` options to ``include``
916 directive; thanks to Stefan Rank.
918 * docutils/transforms/universal.py:
920 - Added ``StripClassesAndElements`` transform to remove from the
921 document tree all elements with classes in
922 ``settings.strip_elements_with_classes`` and all "classes"
923 attribute values in ``self.document.settings.strip_classes``.
925 * docutils/transforms/writer_aux.py:
927 - Added ``Admonitions`` transform to transform specific admonitions
928 (like ``note``, ``warning``, etc.) into generic admonitions with a
931 * docutils/writers/html4css1/__init__.py:
933 - Moved template functionality from the PEP/HTML writer here.
934 - Expanded the fragments available in the ``parts`` attribute.
935 - Moved ``id`` attributes from titles to surrounding ``div``
937 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
938 universally supported now).
939 - ``template.txt`` is now opened in text mode instead of binary mode
940 (to ensure Windows compatibility).
941 - ``a`` elements now have an "internal" or "external" class,
942 depending on reference type.
944 * docutils/writers/html4css1/template.txt: Added to project.
946 * docutils/writers/pep_html/:
948 - Moved template functionality to the HTML writer.
950 * docutils/writers/s5_html/__init__.py:
952 - Added ``view_mode`` & ``hidden_controls`` settings
953 (``--view-mode`` & ``--hidden-controls/--visible-controls``
956 * docutils/writers/latex2e/__init__.py:
958 - Add ``--literal-block-env``
959 - Fix: escaping ``%`` in href urls.
960 - Move usepackage hyperref after stylesheet inclusion.
961 - Fix: scrartcl does not have chapter but scrreprt.
962 - Add newline after ``\end{verbatim}``.
963 - Merge smaller differences from latex2e_adaptive_preamble.
964 - Add ``use-part-section``.
965 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
966 - Using leavemode option_list no longer needs to check if parent
967 is a definition list.
968 - Append ``\leavemode`` to definition list terms.
969 - No longer write visit\_/depart_definition_list_item comments to
971 - Table column width with 3 decimal places.
972 - Add table stubs support (boldfont).
973 - Add assemble_parts to writer.
974 - Add simply support for nested tables.
975 - Fix verbatim in tables if use-verbatim-when-possible.
976 - Use section commands down to subparagraph.
977 - Put ensuremath around some latin1 chars.
978 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
979 - New option ``--use-bibtex=style,db1,db2``.
980 - New option ``--reference-label`` to allow usage of LaTeX ref for
981 labels in section references.
982 - Add a label after every section to support sectionnumbers as reference
984 - Fix: bug# 1605376 rst2latex: bad options group list
985 - Remove inactive code for use_optionlist_for_option_list.
986 - Remove latex comments from option_list output.
987 - Fix: bug# 1612270 double qoutes in italian literal.
988 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
989 - Add option --use-latex-abstract.
990 - Image width unit ``px`` is translated to ``pt``.
991 - Add image height support.
992 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
994 - Fix: Do not escape underscores in citation reference labels if
995 use-latex-citations is set.
996 - Use centering instead of center for figure contents, to avoid vertical
998 - Recognize table class: borderless, nolines, booktabs, standard.
999 - Fix: Renaming contents section does not work with latex writer; SF
1001 - Applied patch for custom roles with classes from Edward Loper.
1002 - Fixed bug that caused crashes with more than 256 lists.
1004 * docutils/writers/pep_html/__init__.py:
1006 - Changed to support new python.org website structure and
1009 * docs/howto/security.txt: "Deploying Docutils Securely", added to
1012 * tools/buildhtml.py:
1014 -- Added ``ignore`` setting to exclude a list of shell patterns
1015 (default: ``.svn:CVS``).
1017 * tools/editors/emacs/rst.el:
1019 - Changed license to "GPL".
1020 - Added ``rst-straighten-decorations`` function.
1021 - The ``compile`` module is now always loaded.
1022 - Added ``rst-toggle-line-block`` function.
1023 - Headings consisting only of non-ASCII characters are now
1024 recognized by ``rst-toc`` and ``rst-adjust``.
1025 - Added font-lock support for multi-line comments where the first
1026 comment line is empty.
1027 - Added ``(require 'font-lock)``.
1031 - Provide descriptive error message if distutils is missing.
1034 Release 0.4 (2006-01-09)
1035 ========================
1039 - Updated the project policies for trunk/branch development &
1042 * docutils/__init__.py:
1044 - Added ``__version_details__`` attribute to describe code source
1045 (repository/snapshot/release).
1046 - Replaced ``default_transforms`` attribute of TransformSpec with
1047 ``get_transforms()`` method.
1051 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
1052 functions, for document tree extraction and reprocessing.
1056 - Added ``DocTreeInput`` class, for reprocessing existing documents.
1057 - Added support for non-Unicode (e.g. binary) writer output.
1059 * docutils/nodes.py:
1061 - Re-introduced ``Targetable.indirect_reference_name``, for
1062 MoinMoin/reST compatibility (removed in r3124/r3129).
1063 - Added ``serial_escape`` function; escapes string values that are
1064 elements of a list, for serialization. Modified Docutils-XML
1065 writing (``Element._dom_node``) and pseudo-XML writing
1066 (``Element.starttag``) to use ``serial_escape``.
1067 - Added ``Node.deepcopy()`` method.
1068 - Removed the internal lists ``document.substitution_refs``,
1069 ``document.anonymous_refs``, and ``document.anonymous_targets``.
1070 - Added a "container" element.
1071 - Fixed bug where values of list-valued attributes of elements
1072 originating from custom interpreted text roles (i.e., with custom
1073 classes) were being shared between element instances. Reported by
1076 * docutils/statemachine.py:
1078 - Added trailing whitespace stripping to ``string2lines()``.
1079 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
1080 Asian double-width character support.
1082 * docutils/utils.py:
1084 - Added ``east_asian_column_width()`` for double-width character
1087 * docutils/languages/ja.py: Added to project: Japanese mappings by
1090 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
1091 mappings by Panjunyong.
1093 * docutils/parsers/null.py: Added to project; a do-nothing parser.
1095 * docutils/parsers/rst/__init__.py:
1097 - Added validator to tab_width setting, with test. Closes SF bug
1098 #1212515, report from Wu Wei.
1100 * docutils/parsers/rst/states.py:
1102 - Fixed bug with escaped colons indicating a literal block.
1103 - Fixed bug with enumerated lists (SF#1254145).
1104 - Backslash-escaped colons inside of field names are now allowed.
1105 - Targets (implicit and explicit), anonymous hyperlink references
1106 and auto-numbered footnote references inside of substitution
1107 definitions are now disallowed.
1108 - Fixed bug: list items with blank first lines.
1109 - Fixed bug: block quote attributions with indented second lines.
1110 - Added East Asian double-width character support (Python 2.4 only).
1112 * docutils/parsers/rst/tableparser.py:
1114 - Added East Asian double-width character support (Python 2.4 only).
1116 * docutils/parsers/rst/directives/body.py:
1118 - Added the "container" directive.
1120 * docutils/parsers/rst/directives/misc.py:
1122 - Added the "default-role", "title", and "date" directives.
1123 - Added standard data file syntax to the "include" directive.
1124 - Added support for "class" directive content.
1126 * docutils/parsers/rst/directives/images.py:
1128 - Added ``indirect_reference_name`` support for images with a target
1130 - Added support for image width and height units.
1131 - Fixed bug with image "target" options.
1133 * docutils/parsers/rst/directives/references.py:
1135 - Added "class" attribute to "target-notes" directive, for
1136 footnote_reference classes.
1138 * docutils/parsers/rst/include/: Directory added to project; contains
1139 standard data files for the "include" directive. Initial contents:
1140 character entity substitution definition sets, and a set of
1141 definitions for S5/HTML presentations.
1143 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
1144 mappings by David Goodger.
1146 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1147 Simplified Chinese mappings by Panjunyong.
1149 * docutils/readers/__init__.py:
1151 - Added universal.Decorations and universal.ExposeInternals
1152 transforms as default transforms for all readers.
1153 - Added ``ReReader`` base class for readers that reread an existing
1156 * docutils/readers/doctree.py: Added to project; a reader for existing
1159 * docutils/transforms/frontmatter.py:
1161 - Fixed the DocInfo transform to handle SVN-style expansion of the
1163 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1166 * docutils/transforms/misc.py:
1168 - Added misc.Transitions transform, extracted from
1169 universal.FinalChecks.
1171 * docutils/transforms/references.py:
1173 - Added references.DanglingReferences transform, extracted from
1174 universal.FinalChecks.
1175 - Fixed bug with doubly-indirect substitutions.
1176 - Added footnote_reference classes attribute to "TargetNotes".
1177 - Fixed bug with circular substitution definitions that put Docutils
1178 into an infinite loop.
1180 * docutils/transforms/universal.py:
1182 - Added universal.ExposeInternals transform, extracted from
1183 universal.FinalChecks.
1184 - Removed universal.FinalChecks transform (logic has been moved to
1185 several new transforms).
1186 - Fixed bug with the "expose_internals" setting and Text nodes
1187 (exposed by the "rawsource" internal attribute).
1188 - Added the universal.StripComments transform, implementation of the
1189 "strip_comments" setting.
1191 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1192 transforms for writers.
1194 - Added ``Compound`` transform, which flattens compound paragraphs.
1196 * docutils/writers/: Several writer modules (html4css1.py) were
1197 converted into packages. Support modules and data files have been
1198 moved into the packages. The stylesheets for the HTML writers are
1199 now installed along with the code, the code knows where to find
1200 them, and the default is to use them (actually, to embed them).
1201 Some adjustments to configuration files may be necessary. The
1202 easiest way to obtain the new default behavior is to remove all
1203 settings whose name includes "stylesheet".
1205 * docutils/writers/__init__.py:
1207 - Added universal.Messages and universal.FilterMessages transforms
1208 as default transforms for all writers.
1209 - Added ``UnfilteredWriter`` base class for writers that pass the
1210 document tree on unchanged.
1212 * docutils/writers/docutils_xml.py:
1214 - Made ``xmlcharrefreplace`` the default output encoding error
1217 * docutils/writers/html4css1/:
1219 - Added support for image width and height units.
1220 - Made ``xmlcharrefreplace`` the default output encoding error
1222 - Made ``--embed-stylesheet`` the default rather than
1223 ``--link-stylesheet``.
1224 - Moved "id" attribute from container (section etc.) to title's <a>
1225 tag, to be on the same tag as "name".
1226 (!!! To be reverted in Docutils 0.5.)
1227 - Added vertical space between fields of field lists.
1228 - Added ``--compact-field-lists`` option to remove vertical space in
1230 - Made cloaking of email addresses with ``--cloak-email-addresses``
1232 - Fixed support for centered images.
1233 - Added support for class="compact" & class="open" lists.
1235 * docutils/writers/latex2e/:
1237 - Underscores in citekeys are no longer escaped.
1239 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1240 mapping of Unicode characters to LaTeX equivalents.
1242 * docutils/writers/s5_html/: Package added to project; writer for
1243 S5/HTML slide shows.
1245 * docs/dev/distributing.txt: Added to project; guide for distributors
1246 (package maintainers).
1248 * docs/dev/hacking.txt: Added to project; guide for developers.
1250 * docs/ref/doctree.txt:
1252 - Updated for plural attributes "classes", "ids", "names",
1254 - Added the "container" element.
1256 * docs/ref/docutils.dtd:
1258 - Updated for plural attributes "classes", "ids", "names",
1261 * docs/user/emacs.txt: Added to project; a document about Emacs
1262 support for reStructuredText and Docutils.
1264 * docs/user/links.txt: Added to project; lists of Docutils-related
1267 * docs/user/mailing-lists.txt: Added to project; information about
1268 Docutils-related mailing lists and how to access them.
1270 * docs/user/slide-shows.txt: Added to project; example of and docs for
1271 the S5/HTML writer (``rst2s5.py`` front end).
1273 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1274 Files", added to project.
1276 * test/coverage.sh: Added to project; test coverage script.
1278 * test/DocutilsTestSupport.py:
1280 - Added support for specifying runtime settings at the suite level.
1282 * test/test_functional.py:
1284 - Added the ``clear_output_directory`` function.
1285 - Added support for ``_test_more`` functions in functional test
1288 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1290 * tools/rstpep2html.py: Renamed from pep.py.
1292 * tools/dev/create_unimap.py: Added to project; script to create the
1293 docutils/writers/unimap_latex.py mapping file.
1295 * tools/dev/profile_docutils.py: Added to project; profiler script.
1297 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1299 * tools/editors/emacs/restructuredtext.el,
1300 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1301 Removed from project; the functionality is now contained in rst.el.
1303 * tools/editors/emacs/rst.el: Added to project. Added many features
1304 and fixed many bugs. See docs/user/emacs.txt for details.
1306 * tools/stylesheets: Removed from project. Stylesheets have been
1307 renamed and moved into writer packages.
1310 Release 0.3.9 (2005-05-26)
1311 ==========================
1315 - Eliminated and replaced all uses of the old string attributes
1316 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1317 new list attributes ``ids``, ``names``, ``dupnames`` and
1318 ``classes`` throughout the whole source tree.
1322 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1323 allowing for easier debugging.
1324 - In ``Publisher.publish()``, expanded the generic top-level
1327 * docutils/examples.py:
1329 - Added ``internals`` function for exploration.
1333 - Fixed ``Input.decode`` method to apply heuristics only if no
1334 encoding is explicitly given, and to provide better reporting of
1336 - The ``Input.decode`` method now removes byte order marks (BOMs)
1339 * docutils/nodes.py:
1341 - ``image`` element class changed to subclass of Element, not
1342 TextElement (it's an empty element, and cannot contain text).
1343 - Added ``attr_defaults`` dictionary for default attribute values.
1344 - Added empty list as default value for the following attributes:
1345 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1346 - Added ``document.decoration`` attribute,
1347 ``document.get_decoration`` method, and ``decoration.get_header``
1348 & ``.get_footer`` methods.
1349 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1352 * docutils/utils.py:
1354 - Removed ``docutils.utils.Reporter.categories``,
1355 ``docutils.utils.ConditionSet``, and all references to them, to
1356 simplify error reporting.
1358 * docutils/languages/nl.py: Added to project; Dutch mappings by
1361 * docutils/parsers/rst/__init__.py:
1363 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1365 * docutils/parsers/rst/states.py:
1367 - Added check for escaped at-mark to prevent email address recognition.
1368 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1370 - Allowed whitespace in paths and URLs.
1371 - Added auto-enumerated list items.
1372 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1374 - Added support for table stub columns.
1376 * docutils/parsers/rst/directives/__init__.py:
1378 - Allowed whitespace in paths (``path`` function).
1379 - Added ``uri`` directive option conversion function.
1381 * docutils/parsers/rst/directives/body.py:
1383 - Fixed illegal context bug with "topic" directive (allowed within
1384 sidebars; not within body elements).
1386 * docutils/parsers/rst/directives/images.py:
1388 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1389 - Added support for the ``file_insertion_enabled`` setting in the
1390 "figure" directive (disables "figwidth" option).
1391 - "image" directive: added checks for valid values of "align" option,
1392 depending on context. "figure" directive: added specialized
1393 "align" option and attribute on "figure" element.
1394 - Made ":figwidth: image" option of "figure" directive work again.
1395 - Fixed bug with reference names containing uppercase letters
1396 (e.g. ``Name_``) in "target" option of "image" directive.
1398 * docutils/parsers/rst/directives/misc.py:
1400 - Fixed "include" and "raw" directives to catch text decoding
1402 - Allowed whitespace in "include" & "raw" directive paths.
1403 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1404 settings in "include" & "raw" directives.
1406 * docutils/parsers/rst/directives/parts.py:
1408 - Added "header" & "footer" directives.
1409 - Fixed illegal context bug with "contents" directive (topics
1410 allowed within sidebars; not within body elements).
1412 * docutils/parsers/rst/directives/tables.py:
1414 - Added "list-table" directive.
1415 - Caught empty CSV table bug.
1416 - Added support for the ``file_insertion_enabled`` setting in the
1417 "csv-table" directive.
1418 - Added ``stub-columns`` option to "csv-table" and "list-table"
1421 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1422 mappings by Martijn Pieters.
1424 * docutils/readers/standalone.py:
1426 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1427 options to activate or deactivate the SectSubTitle transform.
1429 * docutils/transforms/frontmatter.py:
1431 - Added SectSubTitle transform to promote titles of lone
1432 subsections to subtitles.
1434 * docutils/transforms/references.py:
1436 - Fixed mislocated internal targets bug, by propagating internal
1437 targets to the next node, making use of the newly added support
1438 for multiple names and IDs.
1439 - Fixed duplicate footnote label bug.
1440 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1443 * docutils/writers/html4css1.py:
1445 - Fixed unencoded stylesheet reference bug (characters like "&" in
1446 stylesheet references).
1447 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1449 - Added support for multiple IDs per node by creating empty ``span``
1451 - Added the ``field_name_limit`` & ``option_limit`` settings &
1453 - Added support for table stub columns.
1454 - Added support for the ``align`` attribute on ``figure`` elements.
1455 - Added the ``cloak_email_addresses`` setting & support.
1456 - Added ``html_prolog``, ``html_head``, ``html_body``,
1457 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1458 ``docutils.core.publish_parts``.
1459 - Added support for section subtitles.
1461 * docutils/writers/latex2e.py:
1463 - Fixed tables starting with more than one multirow cell.
1464 - Improved --use-latex-docinfo so that organization/contact/address
1465 fields are lumped with the last author field and appear on the
1467 - Made sure the titlepage is always shown with --use-latex-docinfo,
1468 even if the document has no title.
1469 - Made sure that latex doesn't fill in today's date if no date field
1471 - Added support for section subtitles.
1473 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1474 (under development).
1476 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1478 * docs/api/publisher.txt:
1480 - Added "``publish_parts`` Details" section.
1482 * docutils/dev/repository.txt: Added to project; information about the
1483 Docutils Subversion repository.
1485 * docs/ref/docutils.dtd:
1487 - Added a ``stub`` attribute to the ``colspec`` element via the
1488 ``tbl.colspec.att`` parameter entity.
1489 - Allowed topic elements within sidebars
1490 - Added an ``align`` attribute to the ``figure`` element.
1492 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1496 Release 0.3.7 (2004-12-24)
1497 ==========================
1499 * docutils/frontend.py:
1501 - Added options: --input-encoding-error-handler,
1502 --record-dependencies, --leave-footnote-reference-space,
1504 - Added command-line and config file support for "overrides" setting
1509 - Added support for input encoding error handler.
1511 * docutils/nodes.py:
1513 - Added dispatch_visit and dispatch_departure methods to
1514 NodeVisitor; useful as a hook for Visitors.
1515 - Changed structure of ``line_block``; added ``line``.
1516 - Added ``compound`` node class.
1517 - Added a mechanism for Visitors to transitionally ignore new node
1520 * docutils/utils.py:
1522 - Moved ``escape2null`` and ``unescape`` functions from
1523 docutils/parsers/rst/states.py.
1525 * docutils/parsers/rst/roles.py:
1528 - Changed role function API: the "text" parameter now takes
1529 null-escaped interpreted text content.
1531 * docutils/parsers/rst/states.py:
1533 - Fixed bug where a "role" directive in a nested parse would crash
1534 the parser; the state machine's "language" attribute was not being
1536 - Added support for line block syntax.
1537 - Fixed directive parsing bug: argument-less directives didn't
1538 notice that arguments were present.
1539 - Removed error checking for transitions.
1540 - Added support for multiple classifiers in definition list items.
1541 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1542 - Changed role function API: the "text" parameter now takes
1543 null-escaped interpreted text content.
1544 - Empty sections and documents are allowed now.
1546 * docutils/parsers/rst/directives/__init__.py:
1548 - Added ``encoding`` directive option conversion function.
1549 - Allow multiple class names in class_option conversion function.
1551 * docutils/parsers/rst/directives/body.py:
1553 - Converted the line-block directive to use the new structure.
1554 - Extracted the old line-block functionality to the ``block``
1555 function (still used).
1556 - Added ``compound`` directive (thanks to Lea Wiemann).
1558 * docutils/parsers/rst/directives/misc.py:
1560 - Added "encoding" option to "include" and "raw" directives.
1561 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1562 - Allow multiple class names in the "class" directive.
1564 * docutils/parsers/rst/directives/parts.py:
1566 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1567 options. Thanks to Lele Gaifax.
1569 * docutils/parsers/rst/directives/tables.py:
1571 - Added "encoding" directive to "csv-table" directive.
1572 - Added workaround for lack of Unicode support in csv.py, for
1573 non-ASCII CSV input.
1575 * docutils/transforms/misc.py:
1577 - Fixed bug when multiple "class" directives are applied to a single
1579 - Enabled multiple format names for "raw" directive.
1581 * docutils/transforms/references.py:
1583 - Added support for trimming whitespace from beside substitution
1586 * docutils/transforms/universal.py:
1588 - FinalChecks now checks for illegal transitions and moves
1589 transitions between sections.
1591 * docutils/writers/html4css1.py:
1593 - HTMLTranslator.encode now converts U+00A0 to " ".
1594 - "stylesheet" and "stylesheet_path" settings are now mutually
1596 - Added support for the new line_block/line structure.
1597 - --footnote-references now overrides
1598 --trim-footnote-reference-space, if applicable.
1599 - Added support for ``compound`` elements.
1600 - Enabled multiple format names for "raw" directive.
1601 - ``<p>`` tags of a paragraph which is the only visible child of the
1602 document node are no longer stripped.
1603 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1604 new method ``should_be_compact_paragraph()``.
1605 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1607 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1608 the output if they have their ``class`` attribute set.
1609 - The whole document is now surrounded by a ``<div
1610 class="document">`` element.
1611 - Body-level images are now wrapped by their own ``<div>`` elements,
1612 with image classes copied to the wrapper, and for images which
1613 have the ``:align:`` option set, the surrounding ``<div>`` now
1614 receives a class attribute (like ``class="align-left"``).
1616 * docutils/writers/latex2e.py:
1618 - no newline after depart_term.
1619 - Added translations for some Unicode quotes.
1620 - Added option "font-encoding", made package AE the default.
1621 - "stylesheet" and "stylesheet_path" settings are now mutually
1623 - --footnote-references now overrides
1624 --trim-footnote-reference-space, if applicable.
1625 - The footnote label style now matches the footnote reference style
1626 ("brackets" or "superscript").
1627 - Added support for ``compound`` elements.
1628 - Enabled multiple format names for "raw" directive.
1630 * docs/ref/docutils.dtd:
1632 - Changed structure of the ``line_block`` element; added ``line``.
1633 - Added ``compound`` element.
1634 - Added "ltrim" and "rtrim" attributes to
1635 ``substitution_definition`` element.
1636 - Enabled multiple format names for ``raw`` element.
1637 - Enabled multiple classifiers in ``definition_list_item`` elements.
1639 * docs/ref/rst/directives.txt
1641 - Marked "line-block" as deprecated.
1642 - "Class" directive now allows multiple class names.
1643 - Added "Rationale for Class Attribute Value Conversion".
1644 - Added warning about "raw" overuse/abuse.
1646 * docs/ref/rst/restructuredtext.txt:
1648 - Added syntax for line blocks.
1649 - Definition list items may have multiple classifiers.
1651 * docs/ref/rst/roles.txt:
1655 * tools/stylesheets/default.css:
1657 - Added support for the new line_block structure.
1658 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1661 Release 0.3.5 (2004-07-29)
1662 ==========================
1666 * _`Documentation cleanup/reorganization`.
1668 - Created new subdirectories of docs/:
1670 * ``docs/user/``: introductory/tutorial material for end-users
1671 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1672 * ``docs/api/``: API reference material for client-developers
1673 * ``docs/ref/``: reference material for all groups
1674 * ``docs/howto/``: for component-developers and core-developers
1675 * ``docs/peps/``: Python Enhancement Proposals
1677 - Moved ``docs/*`` to ``docs/user/``.
1678 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1679 ``spec/`` to ``docs/dev``.
1680 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1681 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1682 - Moved ``alternatives.txt``, and ``problems.txt`` from
1683 ``spec/rst/`` to ``docs/dev/rst/``.
1684 - Moved ``reStructuredText.txt``, ``directives.txt``,
1685 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1686 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1687 ``roles.txt``, ``reStructuredText.txt`` to
1688 ``restructuredtext.txt``.
1689 - Moved ``spec/howto/`` to ``docs/howto``.
1691 In order to keep the CVS history of moved files, we supplied
1692 SourceForge with a `script for modifying the Docutils CVS
1695 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1697 After running the cleanup script:
1699 - Added ``docs/index.txt``.
1700 - Added a ``.htaccess`` file to the ``web`` module, containing
1701 redirects for all old paths to new paths. They'll preserve
1702 fragments (the "#name" part of a URL), and won't clutter up the
1703 file system, and will correct the URL in the user's browser.
1704 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1705 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1706 the "To Do" list itself in ``docs/dev/todo.txt``.
1707 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1708 section of ``docs/dev/todo.txt``.
1709 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1710 - Added "How To Report Bugs" to ``BUGS.txt``.
1711 - Went through all the sources and docs (including under web/) and
1712 updated links. Mostly done by Lea Wiemann; thanks Lea!
1713 (Still need to update links in the sandboxes.)
1717 * BUGS.txt: Added to project.
1719 * THANKS.txt: Added to project.
1721 * docutils/__init__.py:
1723 - 0.3.4: Post-release.
1727 - Added special error handling & advice for UnicodeEncodeError.
1728 - Refactored Publisher.publish (simplified exception handling &
1729 extracted debug dumps).
1730 - Renamed "enable_exit" parameter of convenience functions to
1731 "enable_exit_status".
1732 - Enabled traceback (exception propagation) by default in
1733 programmatic convenience functions.
1734 - Now publish_file and publish_cmdline convenience functions return
1735 the encoded string results in addition to their regular I/O.
1736 - Extracted common code from publish_file, publish_string, and
1737 publish_parts, into new publish_programmatically. Extracted
1738 settings code to ``Publisher.process_programmatic_settings``.
1739 - In Publisher.publish, disabled ``settings_overrides`` when
1740 ``settings`` is supplied; redundant.
1742 * docutils/frontend.py:
1744 - Added help text for "--output-encoding-error-handler" and
1745 "--error-encoding-error-handler".
1746 - Renamed "--exit" to "--exit-status".
1747 - Simplified default-setting code.
1749 * docutils/parsers/rst/__init__.py:
1751 - Added "--pep-base-url" and "--rfc-base-url" options.
1753 * docutils/parsers/rst/states.py:
1755 - Made URI recognition more aggressive and intelligent.
1757 * docutils/parsers/rst/directives/__init__.py:
1759 - Added several directive option conversion functions.
1761 * docutils/parsers/rst/directives/body.py:
1763 - Moved "table" directive to tables.py.
1765 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1768 * docutils/writers/latex2e.py:
1770 - Added "--table-style=(standard|booktabs|nolines)"
1771 - figures get "here" option (LaTeX per default puts them at bottom),
1772 and figure content is centered.
1773 - Rowspan support for tables.
1774 - Fix: admonition titles before first section.
1775 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1776 - Replave ``_`` in literal by an underlined blank, because it has the correct
1778 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1779 - A few unicode replacements, if output_encoding != utf
1780 - Add "--graphicx-option".
1781 - Indent literal-blocks.
1782 - Fix: omit ``\maketitle`` when there is no document title.
1784 * docs/index.txt: "Docutils Project Documentation Overview", added to
1787 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1788 Tool", added to project.
1790 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1792 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1794 * docs/dev/policies.txt: Added to project (extracted from
1795 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1797 * docs/dev/release.txt: Added to project (extracted from
1798 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1800 * docs/dev/testing.txt: Added to project.
1802 * docs/dev/website.txt: Added to project (extracted from
1803 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1805 * docs/ref/rst/directives.txt:
1807 - Added directives: "table", "csv-table".
1809 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1810 added to project. 1 page for syntax, and a 1 page reference for
1811 directives and roles. Source text to be used as-is; not meant to be
1814 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1815 with a change of title.
1817 * test/functional/, contents, and test/test_functional.py: Added to
1820 * tools/buildhtml.py: Fixed bug with config file handling.
1822 * tools/html.py: Removed from project (duplicate of rst2html.py).
1824 * tools/pep2html.py: Removed from project (duplicate of Python's
1825 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1826 Docutils-related PEPs in docs/peps/).
1828 * tools/rst2pseudoxml.py: Renamed from publish.py.
1830 * tools/rst2xml.py: Renamed from docutils-xml.py.
1832 * tools/test.txt: Removed from project; moved to
1833 docs/user/rst/demo.txt.
1835 * setup.py: Now also installs ``rst2latex.py``.
1838 Release 0.3.3 (2004-05-09)
1839 ==========================
1841 * docutils/__init__.py:
1843 - 0.3.1: Reorganized config file format (multiple sections); see
1845 - Added unknown_reference_resolvers attribute to TransformSpec.
1846 - 0.3.2: Interpreted text reorganization.
1851 - Catch system messages to stop tracebacks from parsing errors.
1852 - Catch exceptions during processing report & exit without
1853 tracebacks, except when "--traceback" used.
1854 - Reordered components for OptionParser; application comes last.
1855 - Added "config_section" parameter to several methods and functions,
1856 allowing front ends to easily specify their config file sections.
1857 - Added publish_parts convenience function to allow access to individual
1858 parts of a document.
1860 * docutils/examples.py: Added to project; practical examples of
1861 Docutils client code, to be used as-is or as models for variations.
1863 * docutils/frontend.py:
1865 - Added "--traceback" & "--no-traceback" options ("traceback"
1867 - Implemented support for config file reorganization:
1868 ``standard_config_files`` moved from ``ConfigParser`` to
1869 ``OptionParser``; added
1870 ``OptionParser.get_config_file_settings()`` and
1871 ``.get_standard_config_settings()``; support for old "[options]"
1872 section (with deprecation warning) and mapping from old to new
1874 - Reimplemented setting validation.
1875 - Enabled flexible boolean values: yes/no, true/false, on/off.
1876 - Added ``Values``, a subclass of ``optparse.Values``, with support
1877 for list setting attributes.
1878 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1879 thanks to Beni Cherniavsky.
1880 - Added "--no-section-numbering" option.
1884 - Catch IOErrors when opening source & destination files, report &
1885 exit without tracebacks. Added ``handle_io_errors`` parameter to
1886 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1888 * docutils/nodes.py:
1890 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1891 method definitions (via ``exec``) to dynamic assignments (via
1892 ``setattr``); thanks to Roman Suzi.
1893 - Encapsulated visitor dynamic assignments in a function; thanks to
1895 - Added indirect_reference_name attribute to the Targetable
1896 class. This attribute holds the whitespace_normalized_name
1897 (contains mixed case) of a target.
1899 * docutils/statemachine.py:
1901 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1902 - Added ``StringList.get_2D_block``.
1904 * docutils/utils.py:
1906 - Added "level" attribute to SystemMessage exceptions.
1908 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1911 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1914 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1915 Marcelo Huerta San Martin.
1917 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1918 mappings by Lalo Martins.
1920 * docutils/languages/ru.py: Added to project; Russian mappings by
1923 * docutils/parsers/rst/roles.py: Added to project. Contains
1924 interpreted text role functions, a registry for interpreted text
1925 roles, and an API for adding to and retrieving from the registry.
1926 Contributed by Edward Loper.
1928 * docutils/parsers/rst/states.py:
1930 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1931 - Allowed true em-dash character and "---" as block quote
1933 - Added support for <angle-bracketed> complex option arguments
1935 - Fixed handling of backslashes in substitution definitions.
1936 - Fixed off-by-1 error with extra whitespace after substitution
1937 definition directive.
1938 - Added inline markup parsing to field lists' field names.
1939 - Added support for quoted (and unindented) literal blocks.
1940 Driven in part by a bribe from Frank Siebenlist (thanks!).
1941 - Parser now handles escapes in URIs correctly.
1942 - Made embedded-URIs' reference text omittable. Idea from Beni
1944 - Refactored explicit target processing code.
1945 - Added name attribute to references containing the reference name only
1946 through whitespace_normalize_name (no case changes).
1947 - parse_target no longer returns the refname after going through
1948 normalize_name. This is now handled in make_target.
1949 - Fixed bug relating to role-less interpreted text in non-English
1951 - Reorganized interpreted text processing; moved code into the new
1952 roles.py module. Contributed by Edward Loper.
1953 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1954 ``parse_directive_block``.
1956 * docutils/parsers/rst/tableparser.py:
1958 - Reworked for ``StringList``, to support "include" directives in
1961 * docutils/parsers/rst/directives/__init__.py:
1963 - Renamed ``unchanged()`` directive option conversion function to
1964 ``unchanged_required``, and added a new ``unchanged``.
1965 - Catch unicode value too high error; fixes bug 781766.
1966 - Beefed up directive error reporting.
1968 * docutils/parsers/rst/directives/body.py:
1970 - Added basic "table" directive.
1972 * docutils/parsers/rst/directives/images.py:
1974 - Added "target" option to "image" directive.
1975 - Added name attribute to references containing the reference name only
1976 through whitespace_normalize_name (no case changes).
1978 * docutils/parsers/rst/directives/misc.py:
1980 - Isolated the import of the ``urllib2`` module; was causing
1981 problems on SourceForge (``libssl.so.2`` unavailable?).
1982 - Added the "role" directive for declaring custom interpreted text
1985 * docutils/parsers/rst/directives/parts.py:
1987 - The "contents" directive does more work up-front, creating the
1988 "topic" and "title", and leaving the "pending" node for the
1989 transform. Allows earlier reference resolution; fixes subtle bug.
1991 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1992 mappings by Jannie Hofmeyr.
1994 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1995 mappings by Marek Blaha.
1997 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1998 mappings by Marcelo Huerta San Martin.
2000 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
2001 Portuguese mappings by Lalo Martins.
2003 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
2004 mappings by Roman Suzi.
2006 * docutils/transforms/parts.py:
2008 - The "contents" directive does more work up-front, creating the
2009 "topic" and "title", and leaving the "pending" node for the
2010 transform. Allows earlier reference resolution; fixes subtle bug.
2011 - Added support for disabling of section numbering.
2013 * docutils/transforms/references.py:
2015 - Verifying that external targets are truly targets and not indirect
2016 references. This is because we are now adding a "name" attribute to
2017 references in addition to targets. Note sure if this is correct!
2018 - Added code to hook into the unknown_reference_resolvers list for a
2019 transformer in resolve_indirect_target. This allows the
2020 unknown_reference_resolvers to keep around indirect targets which
2021 docutils doesn't know about.
2022 - Added specific error message for duplicate targets.
2024 * docutils/transforms/universal.py:
2026 - Added FilterMessages transform (removes system messages below the
2027 verbosity threshold).
2028 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
2029 to FinalCheckVisitor for application-specific handling of
2030 unresolvable references.
2031 - Added specific error message for duplicate targets.
2033 * docutils/writers/__init__.py:
2035 - Added assemble_parts method to the Writer class to allow for
2036 access to a documents individual parts.
2037 - Documented & set default for ``Writer.output`` attribute.
2039 * docutils/writers/html4css1.py:
2041 - Fixed unicode handling of attribute values (bug 760673).
2042 - Prevent duplication of "class" attribute values (bug report from
2044 - Improved table grid/border handling (prompted by report from Bob
2046 - Added support for table titles.
2047 - Added "<title />" for untitled docs, for XHTML conformance; thanks
2049 - Added functionality to keep track of individual parts of a document
2050 and store them in a dictionary as the "parts" attribute of the writer.
2051 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
2052 - Added proper support for the "scale" attribute of the "image"
2053 element. Contributed by Brent Cook.
2054 - Added ``--initial-header-level`` option.
2055 - Fixed bug: the body_pre_docinfo segment depended on there being a
2056 docinfo; if no docinfo, the document title was incorporated into
2057 the body segment. Adversely affected the publish_parts interface.
2059 * docutils/writers/latex2e.py:
2061 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
2062 about a missing file.
2063 - Added options and support: ``--compound-enumerators``,
2064 ``--section-prefix-for-enumerators``, and
2065 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
2067 - Added option ``--use-verbatim-when-possible``, to avoid
2068 problematic characters (eg, '~' in italian) in literal blocks.
2069 - It's now possible to use four section levels in the `book` and
2070 `report` LaTeX classes. The default `article` class still has
2073 * docs/config.txt: "Docutils Configuration Files", added to project.
2074 Moved config file entry descriptions from tools.txt.
2078 - Moved config file entry descriptions to config.txt.
2080 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
2083 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
2084 Text Roles", added to project.
2086 * spec/rst/reStructuredText.txt:
2088 - Added description of support for <angle-bracketed> complex option
2089 arguments to option lists.
2090 - Added subsections for indented and quoted literal blocks.
2092 * test: Continually adding & updating tests.
2094 - Added test/test_settings.py & test/data/config_*.txt support
2096 - Added test/test_writers/test_htmlfragment.py.
2098 * test/DocutilsTestSupport.py:
2100 - Refactored LaTeX publisher test suite/case class names to make
2101 testing other writers easier.
2102 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
2103 to test the processing of HTML fragments which use the new
2104 publish_parts convenience function.
2106 * tools/buildhtml.py:
2108 - Added support for the "--prune" option.
2109 - Removed dependency on pep2html.py; plaintext PEPs no longer
2112 * tools/docutils.conf:
2114 - Updated for configuration file reorganization.
2116 * tools/rst2html.py:
2118 - copied from tools/html.py
2122 - added a 'scripts' section to configuration
2123 - added 'tools/rst2html.py' to the scripts section
2126 Release 0.3 (2003-06-24)
2127 ========================
2131 * Renamed "attribute" to "option" for directives/extensions.
2133 * Renamed transform method "transform" to "apply".
2135 * Renamed "options" to "settings" for runtime settings (as set by
2136 command-line options). Sometimes "option" (singular) became
2137 "settings" (plural). Some variations below:
2139 - document.options -> document.settings (stored in other objects as
2141 - option_spec -> settings_spec (not directives though)
2142 - OptionSpec -> SettingsSpec
2143 - cmdline_options -> settings_spec
2144 - relative_path_options -> relative_path_settings
2145 - option_default_overrides -> settings_default_overrides
2146 - Publisher.set_options -> Publisher.get_settings
2150 * COPYING.txt: Added "Public Domain Dedication".
2152 * FAQ.txt: Frequently asked questions, added to project.
2156 - Updated with PyPI Trove classifiers.
2157 - Conditional installation of third-party modules.
2159 * docutils/__init__.py:
2161 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2162 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2163 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2164 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2165 option and its effect on the PEP template & writer.
2166 - Bumped version to 0.2.4 due to changes to the PEP template &
2168 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2169 - Added ``TransformSpec`` class for new transform system.
2170 - Bumped version to 0.2.6 for API changes (renaming).
2171 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2172 convenience functions.
2173 - Added ``Component.component_type`` attribute.
2174 - Bumped version to 0.2.8 because of the internal parser switch from
2175 plain lists to the docutils.statemachine.StringList objects.
2176 - Bumped version to 0.2.9 because of the frontend.py API changes.
2177 - Bumped version to 0.2.10 due to changes to the project layout
2178 (third-party modules removed from the "docutils" package), and
2179 signature changes in ``io.Input``/``io.Output``.
2180 - Changed version to 0.3.0 for release.
2184 - Made ``publish()`` a bit more convenient.
2185 - Generalized ``Publisher.set_io``.
2186 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2187 parameters; improved its docstring.
2188 - Added ``publish_file()`` and ``publish_string()``.
2189 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2191 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2192 "--dump-transforms" hidden options.
2193 - Added ``Publisher.apply_transforms()`` method.
2194 - Added ``Publisher.set_components()`` method; support for
2195 ``publish_*()`` conveninece functions.
2196 - Moved config file processing to docutils/frontend.py.
2197 - Added support for exit status ("exit_level" setting &
2198 ``enable_exit`` parameter for Publisher.publish() and convenience
2201 * docutils/frontend.py:
2203 - Check for & exit on identical source & destination paths.
2204 - Fixed bug with absolute paths & "--config".
2205 - Set non-command-line defaults in ``OptionParser.__init__()``:
2206 ``_source`` & ``_destination``.
2207 - Distributed ``relative_path_settings`` to components; updated
2208 ``OptionParser.populate_from_components()`` to combine it all.
2209 - Require list of keys in ``make_paths_absolute`` (was implicit in
2210 global ``relative_path_settings``).
2211 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2212 "--dump-settings", and "--dump-transforms" hidden options.
2213 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2214 code, replaced with correct code.
2215 - Added validation functionality for config files.
2216 - Added "--error-encoding" option/setting, "_disable_config"
2218 - Added encoding validation; updated "--input-encoding" and
2219 "--output-encoding"; added "--error-encoding-error-handler" and
2220 "--output-encoding-error-handler".
2221 - Moved config file processing from docutils/core.py.
2222 - Updated ``OptionParser.populate_from_components`` to handle new
2223 ``SettingsSpec.settings_defaults`` dict.
2224 - Added support for "-" => stdin/stdout.
2225 - Added "exit_level" setting ("--exit" option).
2229 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2230 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2231 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2232 - ``FileOutput.write()`` now returns the encoded output string.
2233 - Try to get path/stream name automatically in ``FileInput`` &
2235 - Added defaults for source & destination paths.
2236 - Allow for Unicode I/O with an explicit "unicode" encoding.
2237 - Added ``Output.encode()``.
2238 - Removed dependency on runtime settings; pass encoding directly.
2239 - Recognize Unicode strings in ``Input.decode()``.
2240 - Added support for output encoding error handlers.
2242 * docutils/nodes.py:
2244 - Added "Invisible" element category class.
2245 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2246 modification during a traversal.
2247 - Added element classes: ``line_block``, ``generated``, ``address``,
2248 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2249 ``superscript``, ``subscript``, ``inline``
2250 - Added support for lists of nodes to ``Element.insert()``.
2251 - Fixed parent linking in ``Element.replace()``.
2252 - Added new abstract superclass ``FixedTextElement``; adds
2253 "xml:space" attribute.
2254 - Added support for "line" attribute of ``system_message`` nodes.
2255 - Added support for the observer pattern from ``utils.Reporter``.
2256 Added ``parse_messages`` and ``transform_messages`` attributes to
2257 ``document``, removed ``messages``. Added ``note_parse_message``
2258 and ``note_transform_message`` methods.
2259 - Added support for improved diagnostics:
2261 - Added "document", "source", and "line" internal attributes to
2262 ``Node``, set by ``Node.setup_child()``.
2263 - Converted variations on ``node.parent = self`` to
2264 ``self.setup_child(node)``.
2265 - Added ``document.current_source`` & ``.current_line``
2266 attributes, and ``.note_source`` observer method.
2267 - Changed "system_message" output to GNU-Tools format.
2269 - Added a "rawsource" attribute to the ``Text`` class, for text
2270 before backslash-escape resolution.
2271 - Support for new transform system.
2272 - Reworked ``pending`` element.
2273 - Fixed XML DOM bug (SF #660611).
2274 - Removed the ``interpeted`` element class and added
2275 ``title_reference``, ``abbreviation``, ``acronym``.
2276 - Made substitutions case-sensitive-but-forgiving; moved some code
2278 - Fixed Unicode bug on element attributes (report: William Dode).
2280 * docutils/optik.py: Removed from project; replaced with
2281 extras/optparse.py and extras/textwrap.py. These will be installed
2282 only if they're not already present in the Python installation.
2284 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2285 only if it's not already present in the Python installation.
2287 * docutils/statemachine.py:
2289 - Factored out ``State.add_initial_transitions()`` so it can be
2291 - Converted whitespace-specific "blank" and "indent" transitions
2292 from special-case code to ordinary transitions: removed
2293 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2294 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2295 ``ws_initial_transitions`` attributes.
2296 - Removed ``State.match_transition()`` after merging it into
2298 - Added ``StateCorrection`` exception.
2299 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2300 (moved ``TransitionCorrection`` support there too.)
2301 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2302 ``EOFError`` instead of ``IndexError``.
2303 - Added ``State.no_match`` method.
2304 - Added support for the Observer pattern, triggered by input line
2306 - Added ``strip_top`` parameter to
2307 ``StateMachineWS.get_first_known_indented``.
2308 - Made ``context`` a parameter to ``StateMachine.run()``.
2309 - Added ``ViewList`` & ``StringList`` classes;
2310 ``extract_indented()`` becomes ``StringList.get_indented()``.
2311 - Added ``StateMachine.insert_input()``.
2312 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2313 thanks to) Fred Drake.
2315 * docutils/utils.py:
2317 - Added a ``source`` attribute to Reporter instances and
2318 ``system_message`` elements.
2319 - Added an observer pattern to ``utils.Reporter`` to keep track of
2321 - Fixed bugs in ``relative_path()``.
2322 - Added support for improved diagnostics.
2323 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2324 - Added support for encoding Reporter stderr output, and encoding
2326 - Reporter keeps track of the highest level system message yet
2329 * docutils/languages: Fixed bibliographic field language lookups.
2331 * docutils/languages/es.py: Added to project; Spanish mappings by
2332 Marcelo Huerta San Martin.
2334 * docutils/languages/fr.py: Added to project; French mappings by
2337 * docutils/languages/it.py: Added to project; Italian mappings by
2340 * docutils/languages/sk.py: Added to project; Slovak mappings by
2343 * docutils/parser/__init__.py:
2345 - Added ``Parser.finish_parse()`` method.
2347 * docutils/parser/rst/__init__.py:
2349 - Added options: "--pep-references", "--rfc-references",
2350 "--tab-width", "--trim-footnote-reference-space".
2352 * docutils/parsers/rst/states.py:
2354 - Changed "title under/overline too short" system messages from INFO
2355 to WARNING, and fixed its insertion location.
2356 - Fixed enumerated list item parsing to allow paragraphs & section
2357 titles to begin with enumerators.
2358 - Converted system messages to use the new "line" attribute.
2359 - Fixed a substitution reference edge case.
2360 - Added support for "--pep-references" and "--rfc-references"
2361 options; reworked ``Inliner`` code to make customization easier.
2362 - Removed field argument parsing.
2363 - Added support for short section title over/underlines.
2364 - Fixed "simple reference name" regexp to ignore text like
2365 "object.__method__"; not an anonymous reference.
2366 - Added support for improved diagnostics.
2367 - Reworked directive API, based on Dethe Elza's contribution. Added
2368 ``Body.parse_directive()``, ``.parse_directive_options()``,
2369 ``.parse_directive_arguments()`` methods.
2370 - Added ``ExtensionOptions`` class, to parse directive options
2371 without parsing field bodies. Factored
2372 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2373 ``ExtensionOptions``.
2374 - Improved definition list term/classifier parsing.
2375 - Added warnings for unknown directives.
2376 - Renamed ``Stuff`` to ``Struct``.
2377 - Now flagged as errors: transitions at the beginning or end of
2378 sections, empty sections (except title), and empty documents.
2379 - Updated for ``statemachine.StringList``.
2380 - Enabled recognition of schemeless email addresses in targets.
2381 - Added support for embedded URIs in hyperlink references.
2382 - Added backslash-escapes to inline markup end-string suffix.
2383 - Added support for correct interpreted text processing.
2384 - Fixed nested title parsing (topic, sidebar directives).
2385 - Added special processing of backslash-escaped whitespace (idea
2386 from David Abrahams).
2387 - Made substitutions case-sensitive-but-forgiving; moved some code
2388 to ``docutils.nodes``.
2389 - Added support for block quote attributions.
2390 - Added a kludge to work-around a conflict between the bubble-up
2391 parser strategy and short titles (<= 3 char-long over- &
2392 underlines). Fixes SF bug #738803 "infinite loop with multiple
2393 titles" submitted by Jason Diamond.
2394 - Added explicit interpreted text roles for standard inline markup:
2395 "emphasis", "strong", "literal".
2396 - Implemented "superscript" and "subscript" interpreted text roles.
2397 - Added initial support for "abbreviation" and "acronym" roles;
2399 - Added support for "--trim-footnote-reference-space" option.
2400 - Optional space before colons in directives & hyperlink targets.
2402 * docutils/parsers/rst/tableparser.py:
2404 - Fixed a bug that was producing unwanted empty rows in "simple"
2406 - Detect bad column spans in "simple" tables.
2408 * docutils/parsers/rst/directives: Updated all directive functions to
2411 * docutils/parsers/rst/directives/__init__.py:
2413 - Added ``flag()``, ``unchanged()``, ``path()``,
2414 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2415 directive option helper functions.
2416 - Added warnings for unknown directives.
2417 - Return ``None`` for missing directives.
2418 - Added ``register_directive()``, thanks to William Dode and Paul
2421 * docutils/parsers/rst/directives/admonitions.py:
2423 - Added "admonition" directive.
2425 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2426 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2427 "parsed-literal", "rubric", "epigraph", "highlights" and
2428 "pull-quote" directives.
2430 * docutils/parsers/rst/directives/images.py:
2432 - Added an "align" attribute to the "image" & "figure" directives
2433 (by Adam Chodorowski).
2434 - Added "class" option to "image", and "figclass" to "figure".
2436 * docutils/parsers/rst/directives/misc.py:
2438 - Added "include", "raw", and "replace" directives, courtesy of
2440 - Added "unicode" and "class" directives.
2442 * docutils/parsers/rst/directives/parts.py:
2444 - Added the "sectnum" directive; by Dmitry Jemerov.
2445 - Added "class" option to "contents" directive.
2447 * docutils/parsers/rst/directives/references.py: Added to project.
2448 Contains the "target-notes" directive.
2450 * docutils/parsers/rst/languages/__init__.py:
2452 - Return ``None`` from get_language() for missing language modules.
2454 * docutils/parsers/rst/languages/de.py: Added to project; German
2455 mappings by Engelbert Gruber.
2457 * docutils/parsers/rst/languages/en.py:
2459 - Added interpreted text roles mapping.
2461 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2462 mappings by Marcelo Huerta San Martin.
2464 * docutils/parsers/rst/languages/fr.py: Added to project; French
2465 mappings by William Dode.
2467 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2468 mappings by Nicola Larosa.
2470 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2471 mappings by Miroslav Vasko.
2473 * docutils/readers/__init__.py:
2475 - Added support for the observer pattern from ``utils.Reporter``, in
2476 ``Reader.parse`` and ``Reader.transform``.
2477 - Removed ``Reader.transform()`` method.
2478 - Added default parameter values to ``Reader.__init__()`` to make
2479 instantiation easier.
2480 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2482 * docutils/readers/pep.py:
2484 - Added the ``peps.TargetNotes`` transform to the Reader.
2485 - Removed PEP & RFC reference detection code; moved to
2486 parsers/rst/states.py as options (enabled here by default).
2487 - Added support for pre-acceptance PEPs (no PEP number yet).
2488 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2491 * docutils/readers/python: Python Source Reader subpackage added to
2492 project, including preliminary versions of:
2495 - moduleparser.py: Parser for Python modules.
2497 * docutils/transforms/__init__.py:
2499 - Added ``Transformer`` class and completed transform reform.
2500 - Added unknown_reference_resolvers list for each transformer. This list holds
2501 the list of functions provided by each component of the transformer that
2502 help resolve references.
2504 * docutils/transforms/frontmatter.py:
2506 - Improved support for generic fields.
2507 - Fixed bibliographic field language lookups.
2509 * docutils/transforms/misc.py: Added to project. Miscellaneous
2512 * docutils/transforms/parts.py:
2514 - Moved the "id" attribute from TOC list items to the references
2515 (``Contents.build_contents()``).
2516 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2517 - Added "class" attribute support to ``Contents``.
2519 * docutils/transforms/peps.py:
2521 - Added ``mask_email()`` function, updating to pep2html.py's
2523 - Linked "Content-Type: text/x-rst" to PEP 12.
2524 - Added the ``TargetNotes`` PEP-specific transform.
2525 - Added ``TargetNotes.cleanup_callback``.
2526 - Added title check to ``Headers``.
2528 * docutils/transforms/references.py:
2530 - Added the ``TargetNotes`` generic transform.
2531 - Split ``Hyperlinks`` into multiple transforms.
2532 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2533 - Added check for circular indirect references.
2534 - Made substitutions case-sensitive-but-forgiving.
2536 * docutils/transforms/universal.py:
2538 - Added support for the "--expose-internal-attributes" option.
2539 - Removed ``Pending`` transform classes & data.
2541 * docutils/writers/__init__.py:
2543 - Removed ``Writer.transform()`` method.
2545 * docutils/writers/docutils-xml.py:
2547 - Added XML and doctype declarations.
2548 - Added "--no-doctype" and "--no-xml-declaration" options.
2550 * docutils/writers/html4css1.py:
2552 - "name" attributes only on these tags: a, applet, form, frame,
2554 - Added "name" attribute to <a> in section titles for Netscape 4
2555 support (bug report: Pearu Peterson).
2556 - Fixed targets (names) on footnote, citation, topic title,
2557 problematic, and system_message nodes (for Netscape 4).
2558 - Changed field names from "<td>" to "<th>".
2559 - Added "@" to "@" encoding to thwart address harvesters.
2560 - Improved the vertical whitespace optimization; ignore "invisible"
2561 nodes (targets, comments, etc.).
2562 - Improved inline literals with ``<span class="pre">`` around chunks
2563 of text and `` `` for runs of spaces.
2564 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2565 ``self.docinfo`` segments.
2566 - Added support for "line_block", "address" elements.
2567 - Improved backlinks (footnotes & system_messages).
2568 - Improved system_message output.
2569 - Redefined "--stylesheet" as containing an invariant URL, used
2570 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2572 - Added "--footnote-references" option (superscript or brackets).
2573 - Added "--compact-lists" and "--no-compact-lists" options.
2574 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2575 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2576 - Improved field list rendering.
2577 - Added Docutils version to "generator" meta tag.
2578 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2579 - Improved layout of <pre> HTML source.
2580 - Fixed attribute typo on <colspec>.
2581 - Refined XML prologue.
2582 - Support for no stylesheet.
2583 - Removed "interpreted" element support.
2584 - Added support for "title_reference", "sidebar", "attribution",
2585 "rubric", and generic "admonition" elements.
2586 - Added "--attribution" option.
2587 - Added support for "inline", "subscript", "superscript" elements.
2588 - Added initial support for "abbreviation" and "acronym";
2591 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2595 - Double quotes in literal blocks (special treatment for de/ngerman).
2596 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2597 - Added "--attribution" option.
2598 - Right align attributions.
2600 * docutils/writers/pep_html.py:
2602 - Parameterized output encoding in PEP template.
2603 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2604 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2605 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2607 - Added an override on the "--footnote-references" option.
2608 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2609 - Added Docutils version to "generator" meta tag.
2610 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2614 - Added a "silent" setting for ``buildhtml.py``.
2615 - Added a "Getting Help" section.
2616 - Rearranged the structure.
2617 - Kept up to date, with new settings, command-line options etc.
2618 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2619 - Converted settings table into a definition list.
2621 * docs/rst/quickstart.txt:
2623 - Added a table of contents.
2624 - Added feedback information.
2625 - Added mention of minimum section title underline lengths.
2626 - Removed the 4-character minimum for section title underlines.
2628 * docs/rst/quickref.html:
2630 - Added a "Getting Help" section.
2631 - Added a style to make section title backlinks more subtle.
2632 - Added mention of minimum section title underline lengths.
2633 - Removed the 4-character minimum for section title underlines.
2635 * extras: Directory added to project; contains third-party modules
2636 that Docutils depends on (optparse, textwrap, roman). These are
2637 only installed if they're not already present.
2639 * licenses: Directory added to project; contains copies of license
2640 files for non-public-domain files.
2644 - Changed the focus. It's about DTD elements: structural
2645 relationships, semantics, and external (public) attributes. Not
2646 about the element class library.
2647 - Moved some implementation-specific stuff into ``docutils.nodes``
2649 - Wrote descriptions of all common attributes and parameter
2650 entities. Filled in introductory material.
2651 - Working through the element descriptions: 55 down, 37 to go.
2652 - Removed "Representation of Horizontal Rules" to
2653 spec/rst/alternatives.txt.
2655 * spec/docutils.dtd:
2657 - Added "generated" inline element.
2658 - Added "line_block" body element.
2659 - Added "auto" attribute to "title".
2660 - Changed content models of "literal_block" and "doctest_block" to
2662 - Added ``%number;`` attribute type parameter entity.
2663 - Changed ``%structural.elements;`` to ``%section.elements``.
2664 - Updated attribute types; made more specific.
2665 - Added "address" bibliographic element.
2666 - Added "line" attribute to ``system_message`` element.
2667 - Removed "field_argument" element; "field_name" may contain
2668 multiple words and whitespace.
2669 - Changed public identifier to docutils.sf.net.
2670 - Removed "interpreted" element; added "title_reference",
2671 "abbreviation", "acronym".
2672 - Removed "refuri" attribute from "footnote_reference" and
2673 "citation_reference".
2674 - Added "sidebar", "rubric", "attribution", "admonition",
2675 "superscript", "subscript", and "inline" elements.
2677 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2679 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2681 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2683 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2686 * spec/transforms.txt: Added to project.
2688 * spec/howto: Added subdirectory, for developer how-to docs.
2690 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2691 Elza, edited & extended by David Goodger.
2693 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2696 * spec/rst/alternatives.txt:
2698 - Added "Doctree Representation of Transitions" from
2700 - Updated "Inline External Targets" & closed the debate.
2701 - Added ideas for interpreted text syntax extensions.
2702 - Added "Nested Inline Markup" section.
2704 * spec/rst/directives.txt:
2706 - Added directives: "topic", "sectnum", "target-notes",
2707 "line-block", "parsed-literal", "include", "replace", "sidebar",
2708 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2710 - Formalized descriptions of directive details.
2711 - Added an "align" attribute to the "image" & "figure" directives
2712 (by Adam Chodorowski).
2713 - Added "class" options to "topic", "sidebar", "line-block",
2714 "parsed-literal", "contents", and "image"; and "figclass" to
2717 * spec/rst/interpreted.txt: Added to project. Descriptions of
2718 interpreted text roles.
2720 * spec/rst/introduction.txt:
2722 - Added pointers to material for new users.
2724 * spec/rst/reStructuredText.txt:
2726 - Disambiguated comments (just add a newline after the "::").
2727 - Updated enumerated list description; added a discussion of the
2728 second-line validity checking.
2729 - Updated directive description.
2730 - Added a note redirecting newbies to the user docs.
2731 - Expanded description of inline markup start-strings in non-markup
2733 - Removed field arguments and made field lists a generic construct.
2734 - Removed the 4-character minimum for section title underlines.
2735 - Clarified term/classifier delimiter & inline markup ambiguity
2737 - Added "Embedded URIs".
2738 - Updated "Interpreted Text" section.
2739 - Added "Character-Level Inline Markup" section.
2741 * test: Continually adding & updating tests.
2743 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2744 - Moved test/test_pep/ to test/test_readers/test_pep/.
2745 - Added test/test_readers/test_python/.
2746 - Added test/test_writers/ (Engelbert Gruber).
2750 - Made the ``locale.setlocale()`` calls in front ends
2753 * tools/buildhtml.py:
2755 - Added "--silent" option.
2756 - Fixed bug with absolute paths & "--config".
2757 - Updated for new I/O classes.
2758 - Added some exception handling.
2759 - Separated publishers' setting defaults; prevents interference.
2760 - Updated for new ``publish_file()`` convenience function.
2762 * tools/pep-html-template:
2764 - Allow for "--embed-stylesheet".
2765 - Added Docutils version to "generator" meta tag.
2766 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2767 - Conform to XHTML spec.
2769 * tools/pep2html.py:
2771 - Made ``argv`` a parameter to ``main()``.
2772 - Added support for "Content-Type:" header & arbitrary PEP formats.
2773 - Linked "Content-Type: text/plain" to PEP 9.
2774 - Files skipped (due to an error) are not pushed onto the server.
2775 - Updated for new I/O classes.
2776 - Added ``check_requirements()`` & ``pep_type_error()``.
2777 - Added some exception handling.
2778 - Updated for new ``publish_string()`` convenience function.
2779 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2781 * tools/quicktest.py:
2783 - Added "-V"/"--version" option.
2785 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2787 * tools/unicode2rstsubs.py: Added to project. Produces character
2788 entity files (reSructuredText substitutions) from the MathML master
2791 * tools/editors: Support code for editors, added to project. Contains
2792 ``emacs/restructuredtext.el``.
2794 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2796 - Added style for chunks of inline literals.
2797 - Removed margin for first child of table cells.
2798 - Right-aligned field list names.
2799 - Support for auto-numbered section titles in TOCs.
2800 - Increased the size of inline literals (<tt>) in titles.
2801 - Restored the light gray background for inline literals.
2802 - Added support for "line_block" elements.
2803 - Added style for "address" elements.
2804 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2805 - Improved field list rendering.
2806 - Vertical whitespace improvements.
2807 - Removed "a.target" style.
2809 * tools/stylesheets/pep.css:
2811 - Fixed nested section margins.
2812 - Other changes parallel those of ``../default.css``.
2815 Release 0.2 (2002-07-31)
2816 ========================
2820 - The word "component" was being used ambiguously. From now on,
2821 "component" will be used to mean "Docutils component", as in Reader,
2822 Writer, Parser, or Transform. Portions of documents (Table of
2823 Contents, sections, etc.) will be called "document parts".
2824 - Did a grand renaming: a lot of ``verylongnames`` became
2825 ``very_long_names``.
2826 - Cleaned up imports: no more relative package imports or
2827 comma-separated lists of top-level modules.
2828 - Added support for an option values object which carries default
2829 settings and overrides (from command-line options and library use).
2830 - Added internal Unicode support, and support for both input and
2832 - Added support for the ``docutils.io.IO`` class & subclasses.
2836 * docutils/__init__.py:
2838 - Added ``ApplicationError`` and ``DataError``, for use throughout
2840 - Added ``Component`` base class for Docutils components; implements
2841 the ``supports`` method.
2842 - Added ``__version__`` (thus, ``docutils.__version__``).
2846 - Removed many keyword parameters to ``Publisher.__init__()`` and
2847 ``publish()``; bundled into an option values object. Added
2848 "argv", "usage", "description", and "option_spec" parameters for
2849 command-line support.
2850 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2852 - Reworked I/O model for ``docutils.io`` wrappers.
2853 - Updated ``Publisher.set_options()``; now returns option values
2855 - Added support for configuration files (/etc/docutils.conf,
2856 ./docutils.conf, ~/.docutils).
2857 - Added ``Publisher.setup_option_parser()``.
2858 - Added default usage message and description.
2860 * docutils/frontend.py: Added to project; support for front-end
2861 (command-line) scripts. Option specifications may be augmented by
2862 components. Requires Optik (http://optik.sf.net/) for option
2863 processing (installed locally as docutils/optik.py).
2865 * docutils/io.py: Added to project; uniform API for a variety of input
2868 * docutils/nodes.py:
2870 - Added ``TreeCopyVisitor`` class.
2871 - Added a ``copy`` method to ``Node`` and subclasses.
2872 - Added a ``SkipDeparture`` exception for visitors.
2873 - Renamed ``TreePruningException`` from ``VisitorException``.
2874 - Added docstrings to ``TreePruningException``, subclasses, and
2876 - Improved docstrings.
2877 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2878 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2880 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2881 ``PreDecorative`` mixin.
2882 - Reworked the name/id bookkeeping; to ``document``, removed
2883 ``explicit_targets`` and ``implicit_targets`` attributes, added
2884 ``nametypes`` attribute and ``set_name_id_map`` method.
2885 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2887 - Added ``document.has_name()`` method.
2888 - Fixed DOM generation for list-attributes.
2889 - Added category class ``Labeled`` (used by footnotes & citations).
2890 - Added ``Element.set_class()`` method (sets "class" attribute).
2892 * docutils/optik.py: Added to project. Combined from the Optik
2893 package, with added option groups and other modifications. The use
2894 of this module is probably only temporary.
2896 * docutils/statemachine.py:
2898 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2899 - Added underscores to improve many awkward names.
2900 - In ``string2lines()``, changed whitespace normalizing translation
2901 table to regexp; restores Python 2.0 compatibility with Unicode.
2903 * docutils/urischemes.py:
2905 - Filled in some descriptions.
2906 - Added "shttp" scheme.
2908 * docutils/utils.py:
2910 - Added ``clean_rcs_keywords`` function (moved from
2911 docutils/transforms/frontmatter.py
2912 ``DocInfo.filter_rcs_keywords``).
2913 - Added underscores to improve many awkward names.
2914 - Changed names of Reporter's thresholds:
2915 warning_level -> report_level; error_level -> halt_level.
2916 - Moved ``utils.id()`` to ``nodes.make_id()``.
2917 - Added ``relative_path(source, target)``.
2919 * docutils/languages/de.py: German mappings; added to project. Thanks
2920 to Gunnar Schwant for the translations.
2922 * docutils/languages/en.py: Added "Dedication" bibliographic field
2925 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2928 * docutils/parsers/rst/states.py:
2930 - Added underscores to improve many awkward names.
2931 - Added RFC-2822 header support.
2932 - Extracted the inline parsing code from ``RSTState`` to a separate
2933 class, ``Inliner``, which will allow easy subclassing.
2934 - Made local bindings for ``memo`` container & often-used contents
2935 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2936 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2937 - Added ``MarkupMismatch`` exception; for late corrections.
2938 - Added ``-/:`` characters to inline markup's start string prefix,
2939 ``/`` to end string suffix.
2940 - Fixed a footnote bug.
2941 - Fixed a bug with literal blocks.
2942 - Applied patch from Simon Budig: simplified regexps with symbolic
2943 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2944 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2945 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2946 - Allowed non-ASCII in "simple names" (directive names, field names,
2948 - Converted ``Inliner.patterns.initial`` to be dynamically built
2949 from parts with ``build_regexp()`` function.
2950 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2951 - Updated docstrings.
2952 - Changed "table" to "grid_table"; added "simple_table" support.
2954 * docutils/parsers/rst/tableparser.py:
2956 - Changed ``TableParser`` to ``GridTableParser``.
2957 - Added ``SimpleTableParser``.
2958 - Refactored naming.
2960 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2961 a fallback language for directive names.
2963 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2964 directive to use a ``pending`` element, used only by HTML writers.
2966 * docutils/parsers/rst/directives/parts.py: Renamed from
2969 - Added "backlinks" attribute to "contents" directive.
2971 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2972 project by Adam Chodorowski.
2974 * docutils/readers/__init__.py: Gave Readers more control over
2975 choosing and instantiating Parsers.
2977 * docutils/readers/pep.py: Added to project; for PEP processing.
2979 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2980 requires a ``component`` parameter.
2982 * docutils/transforms/components.py: Added to project; transforms
2983 related to Docutils components.
2985 * docutils/transforms/frontmatter.py:
2987 - In ``DocInfo.extract_authors``, check for a single "author" in an
2988 "authors" group, and convert it to a single "author" element.
2989 - Added support for "Dedication" and generic bibliographic fields.
2991 * docutils/transforms/peps.py: Added to project; PEP-specific.
2993 * docutils/transforms/parts.py: Renamed from old components.py.
2995 - Added filter for `Contents`, to use alt-text for inline images,
2996 and to remove inline markup that doesn't make sense in the ToC.
2997 - Added "name" attribute to TOC topic depending on its title.
2998 - Added support for optional TOC backlinks.
3000 * docutils/transforms/references.py: Fixed indirect target resolution
3001 in ``Hyperlinks`` transform.
3003 * docutils/transforms/universal.py:
3005 - Changed ``Messages`` transform to properly filter out system
3006 messages below the warning threshold.
3007 - Added ``Decorations`` transform (support for ``--generator``,
3008 ``--date``, ``--time``, ``--source-link`` options).
3010 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
3011 Engelbert Gruber's PDF writer.
3013 * docutils/writers/html4css1.py:
3015 - Made XHTML-compatible (switched to lowercase element & attribute
3016 names; empty tag format).
3017 - Escape double-dashes in comment text.
3018 - Improved boilerplate & modularity of output.
3019 - Exposed modular output in Writer class.
3020 - Added a "generator" meta tag to <head>.
3021 - Added support for the ``--stylesheet`` option.
3022 - Added support for ``decoration``, ``header``, and ``footer``
3024 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
3025 translation table to regexp; restores Python 2.0 compatibility
3027 - Added the translator class as instance variable to the Writer, to
3028 make it easily subclassable.
3029 - Improved option list spacing (thanks to Richard Jones).
3030 - Modified field list output.
3031 - Added backlinks to footnotes & citations.
3032 - Added percentage widths to "<col>" tags (from colspec).
3033 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
3034 "<span>" changed to "<var>".
3035 - Inline literals: "<code>" changed to "<tt>".
3036 - Many changes to optimize vertical space: compact simple lists etc.
3037 - Add a command-line options & directive attributes to control TOC
3038 and footnote/citation backlinks.
3039 - Added support for optional footnote/citation backlinks.
3040 - Added support for generic bibliographic fields.
3041 - Identify backrefs.
3042 - Relative URLs for stylesheet links.
3044 * docutils/writers/pep_html.py: Added to project; HTML Writer for
3045 PEPs (subclass of ``html4css1.Writer``).
3047 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
3049 * docutils/writers/docutils_xml.py: Added to project; trivial writer
3050 of the Docutils internal doctree in XML.
3052 * docs/tools.txt: "Docutils Front-End Tools", added to project.
3056 - Changed the title to "The Docutils Document Tree".
3057 - Added "Hyperlink Bookkeeping" section.
3059 * spec/docutils.dtd:
3061 - Added ``decoration``, ``header``, and ``footer`` elements.
3062 - Brought ``interpreted`` element in line with the parser: changed
3063 attribute "type" to "role", added "position".
3064 - Added support for generic bibliographic fields.
3066 * spec/notes.txt: Continual updates. Added "Project Policies".
3068 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
3071 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
3073 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
3074 mailing list discussions.
3076 * spec/pep-0287.txt:
3078 - Renamed to "reStructuredText Docstring Format".
3080 - Reworked Q&A as an enumerated list.
3081 - Converted to reStructuredText format.
3083 * spec/pysource.dtd:
3085 - Reworked structural elements, incorporating ideas from Tony Ibbs.
3087 * spec/pysource.txt: Removed from project. Moved much of its contents
3090 * spec/rst/alternatives.txt:
3092 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
3093 - Added "Inline External Targets" section.
3095 * spec/rst/directives.txt:
3097 - Added "backlinks" attribute to "contents" directive.
3099 * spec/rst/problems.txt:
3101 - Updated the Enumerated List Markup discussion.
3102 - Added new alternative table markup syntaxes.
3104 * spec/rst/reStructuredText.txt:
3106 - Clarified field list usage.
3107 - Updated enumerated list description.
3108 - Clarified purpose of directives.
3109 - Added ``-/:`` characters to inline markup's start string prefix,
3110 ``/`` to end string suffix.
3111 - Updated "Authors" bibliographic field behavior.
3112 - Changed "inline hyperlink targets" to "inline internal targets".
3113 - Added "simple table" syntax to supplement the existing but
3114 newly-renamed "grid tables".
3115 - Added cautions for anonymous hyperlink use.
3116 - Added "Dedication" and generic bibliographic fields.
3118 * test: Made test modules standalone (subdirectories became packages).
3120 * test/DocutilsTestSupport.py:
3122 - Added support for PEP extensions to reStructuredText.
3123 - Added support for simple tables.
3124 - Refactored naming.
3126 * test/package_unittest.py: Renamed from UnitTestFolder.py.
3128 - Now supports true packages containing test modules
3129 (``__init__.py`` files required); fixes duplicate module name bug.
3131 * test/test_pep/: Subpackage added to project; PEP testing.
3133 * test/test_rst/test_SimpleTableParser.py: Added to project.
3137 - Updated html.py and publish.py front-end tools to use the new
3138 command-line processing facilities of ``docutils.frontend``
3139 (exposed in ``docutils.core.Publisher``), reducing each to just a
3141 - Added ``locale.setlocale()`` calls to front-end tools.
3143 * tools/buildhtml.py: Added to project; batch-generates .html from all
3144 the .txt files in directories and subdirectories.
3146 * tools/default.css:
3148 - Added support for ``header`` and ``footer`` elements.
3149 - Added styles for "Dedication" topics (biblio fields).
3151 * tools/docutils.conf: A configuration file; added to project.
3153 * tools/docutils-xml.py: Added to project.
3155 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3157 * tools/pep-html-template: Added to project.
3159 * tools/pep2html.py: Added to project from Python (nondist/peps).
3160 Added support for Docutils (reStructuredText PEPs).
3162 * tools/quicktest.py:
3164 - Added the ``--attributes`` option, hacked a bit.
3165 - Added a second command-line argument (output file); cleaned up.
3167 * tools/stylesheets/: Subdirectory added to project.
3169 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3172 Release 0.1 (2002-04-20)
3173 ========================
3175 This is the first release of Docutils, merged from the now inactive
3176 reStructuredText__ and `Docstring Processing System`__ projects. For
3177 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3178 `DPS HISTORY`__ files.
3180 __ http://structuredtext.sourceforge.net/
3181 __ http://docstring.sourceforge.net/
3182 __ http://structuredtext.sourceforge.net/HISTORY.html
3183 __ http://docstring.sourceforge.net/HISTORY.html
3185 General changes: renamed 'dps' package to 'docutils'; renamed
3186 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3187 the test suites (reStructuredText's test/test_states renamed to
3188 test/test_rst); and all modifications required to make it all work.
3190 * docutils/parsers/rst/states.py:
3192 - Improved diagnostic system messages for missing blank lines.
3193 - Fixed substitution_reference bug.
3199 indent-tabs-mode: nil
3200 sentence-end-double-space: t