1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: docutils-develop@lists.sourceforge.net
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
21 - Fix [ 253 ] Attribute key without value not allowed in XML.
23 * docutils/parsers/rst/__init__.py
25 - Fix [ 233 ] Change the base URL for the :rfc: role.
27 * docutils/parsers/rst/directives/tables.py
29 - patch [ 120 ] tables accept option widths: list of relative widths, 'auto'
32 * docutils/utils/math/math2html.py
34 - add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
36 * docutils/writers/html4css1/__init__.py
38 - Add "docutils" to class values for "container" object to address [ 267 ].
39 - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
40 ``default_stylesheet_path`` and ``default_template_path``.
42 * docutils/writers/xhtml11/
44 - New HTML writer generating `XHTML1.1`_ styled with CSS2.
46 Moved to the docutils core from sandbox/html4strict.
48 .. _XHTML1.1: http://www.w3.org/TR/xhtml11/
50 * docutils/writers/latex2e/__init__.py
52 - use absolute path for ``default_template_path``.
54 * docutils/writers/odf_odt/__init__.py
56 - remove decode.encode of filename stored in zip.
58 * docutils/writers/latex2e/__init__.py
60 - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
61 admonitions and docinfo.
63 Release 0.12 (2014-07-06)
64 =========================
66 * docs/ref/rst/directives.txt
68 - Update "math" and "csv-table" descriptions.
70 * docutils/parsers/rst/directives/images.py
72 - Fix [ 258 ] figwidth="image" generates unitless width value.
74 * docutils/parsers/rst/states.py
76 - Improve error report when a non-ASCII character is specified as
77 delimiter, quote or escape character under Python 2.
78 Fixes [ 249 ] and [ 250 ].
80 * docutils/writers/html4css1/__init__.py
82 - Don't add newline after inline math.
83 Thanks to Yury G. Kudryashov for the patch.
85 * docutils/writers/latex2e/__init__.py
87 - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
88 - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
90 * docutils/writers/odf_odt/__init__.py
92 - Apply patch by Jakub Wilk to fix bug [ 100 ].
94 * test/test_error_reporting.py
96 - Fix [ 223 ] by removing redundant tests we do not have control over.
100 - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
102 Release 0.11 (2013-07-22)
103 =========================
107 - Apply [ 2714873 ] Fix for the overwritting of document attributes.
108 - Support embedded aliases within hyperlink references.
109 - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
110 language module) before global search.
114 - Fix [ 3601607 ] node.__repr__() must return `str` instance.
116 * docutils/parsers/rst/directives/__init__.py
118 - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
120 * docutils/parsers/rst/directives/images.py
122 - Apply [ 3599485 ] node source/line information for sphinx translation.
124 * docutils/parsers/rst/directives/tables.py
126 - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
128 * docutils/parsers/rst/states.py
130 - Fix [ 157 ] Line block parsing doesn't like system message.
131 - Always import our local copy of roman.py (report Larry Hastings).
133 * docutils/transforms/references.py
135 - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
137 * docutils/utils/__init__.py
139 - Fix [ 3596884 ] exception importing ``docutils.io``.
141 * docutils/writers/html4css1/__init__.py
143 - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
144 - New setting `stylesheet_dirs`: Comma-separated list of directories
145 where stylesheets are found. Used by `stylesheet_path` when expanding
146 relative path arguments.
147 - New default for math-output_: ``HTML math.css``.
148 - Avoid repeated class declarations in html4css1 writer
149 (modified version of patch [ 104 ]).
151 .. _math-output: docs/user/config.html#math-output
153 * docutils/writers/latex2e/__init__.py
155 - Drop the simple algorithm replacing straight double quotes with
156 English typographic ones.
157 Activate the SmartQuotes_ transform if you want this feature.
158 - Fix literal use of babel shorthands (straight quote, tilde, ...).
159 - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
160 - New setting `stylesheet_dirs`.
162 .. _SmartQuotes: docs/user/config.html#smart-quotes
164 * docutils/writers/manpage.py
166 - Fix [3607063] handle lines starting with a period.
167 - Fix option separating comma was bold (thanks to Bill Morris).
169 Release 0.10 (2012-12-16)
170 =========================
174 - Dropped support for Python 2.3.
175 - ``docutils/math``, ``docutils/error_reporting.py``, and
176 ``docutils/urischemes.py`` moved to the utils package.
177 - Fix [3541369] Relative __import__ also with Python 3.3.
178 - Fix [3559988] and [3560841] __import__ local writer, reader, languages
179 and parsers for Python 2.7 up.
180 - Fix import of PIL.Image.
181 - Change default of "syntax highlight" option to "long",
182 basic syntax highlight styles for LaTeX and HTML.
186 - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
187 option is ignored and will be removed in a future release.
188 - Fix Py3k error writing to stdout with encoding differing from default.
189 - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
191 * docutils/parsers/rst/directives/misc.py
193 - Fix [ 3546533 ] Unicode error with `date` directive.
195 * docutils/transforms/universal.py
197 - SmartQuotes transform for typographic quotes and dashes.
199 * docutils/utils/__init__.py
201 - normalize_language_tag() now returns `BCP 47`_ conformant tags
202 with subtags separated by ``-``.
204 * docutils/writers/html4css1/__init__.py
206 - Use ``<code>`` tag for inline "code",
207 do not drop nested inline nodes (syntax highlight tokens).
208 - Customizable MathJax URL (based on patch by Dmitry Shachnev).
209 - No line break after opening inline math tag.
211 * docutils/writers/manpage.py
213 - Apply [ 3527401 ] addmonition's don't preserve indentation
214 - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
216 , docutils/writers/xetex/__init__.py
218 - Apply [ 3555160 ] ensure order of "otherlanguages".
219 - Fix section numbering by LaTeX.
221 * docutils/writers/s5_html/__init__.py
223 - Fix [ 3556388 ] Mathjax does not work with rst2s5.
225 * docutils/writers/s5_html/docutils_xml.py
227 - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
231 - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
233 * tools/test/test_buildhtml.py
235 - Fix [ 3521167 ] allow running in any directory.
236 - Fix [ 3521168 ] allow running with Python 3.
239 Release 0.9.1 (2012-06-17)
240 ==========================
244 - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
245 installed in the PYTHONPATH. Converted tests are now
246 stored in ``test3/``, tools no longer need conversion.
248 If you installed one of Docutils versions 0.7 ... 0.9 with
249 ``setup.py install`` under Python 3, remove the spurious
250 ``test/`` and ``tools/`` directories in the site library root.
254 - Make tests independent from the location of the ``test/`` directory.
255 - Use converted sources (from the ``build/`` directory) for tests under
260 - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
264 - Fix writing binary data to sys.stdout under Python 3 (allows
265 ``rst2odt.py`` to be used with output redirection).
267 * docutils/parsers/rst/directives/misc.py
269 - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
270 ``locale == C`` and 8-bit char in path argument of `include` directive.
274 - class `Tee`: catch UnicodeError when writing to "ascii" stream or
277 Release 0.9 (2012-05-02)
278 ========================
282 - New reStructuredText "code" role and directive and "code" option
283 of the "include" directive with syntax highlighting by Pygments_.
284 - Fix parse_option_marker for option arguments containing ``=``.
285 - Fix [ 2993756 ]: import Python Imaging Library's Image module
286 via ``import PIL`` as starting with PIL 1.2,
287 "PIL lives in the PIL namespace only" (announcement__).
289 .. _Pygments: http://pygments.org/
290 __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
294 - Fix [ 2971827 ] and [ 3442827 ]
295 extras/roman.py moved to docutils/utils/roman.py
297 * docutils/frontend.py
299 - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
303 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
304 - `mode` argument for FileOutput avoids code replication in
306 - New exceptions InputError and OutputError for IO errors in
307 FileInput/FileOutput.
311 - No "hard" system exit on file IO errors: catch and report them in
312 `Publisher.reportException` instead. Allows handling by a calling
313 application if the configuration setting `traceback` is True.
315 * docutils/utils.py -> docutils/utils/__init__.py
317 - docutils.utils is now a package (providing a place for sub-modules)
319 .. note:: docutils/math, docutils/error_reporting.py, and
320 docutils/urischemes.py will move to the utils package in the next
321 release, too. See RELEASE-NOTES__
323 __ RELEASE-NOTES.html
325 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
326 errors recording non-ASCII filenames (fixes [ 3434355 ]).
328 - Fix relative_path() with source=None and `unicode` target.
330 * docutils/parsers/rst/states.py
332 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
333 characters and "international" quotes around inline markup.
334 - Use `field_marker` pattern to look for start of a
335 directive option block (fixes [ 3484857 ]).
337 * docutils/parsers/rst/tableparser.py
339 - Fix [ 2926161 ] for simple tables.
340 (Combining chars in grid tables still contribute to cell width.)
342 * docutils/writers/latex2e/__init__.py
344 - Support the `abbreviation` and `acronym` standard roles.
345 - Record only files required to generate the LaTeX source as dependencies.
346 - Fix handling of missing stylesheets.
347 - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
348 when suppressing LaTeX section numbering.
349 - Use ``\DUtitle`` for unsupported section levels
350 - Apply [ 3512791 ] do not compare string literals with "is"
352 * docutils/writers/xetex/__init__.py
354 - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
356 * docutils/writers/html4css1/__init__.py
358 - Change default for `math-output` setting to MathJax.
359 - Fix handling of missing stylesheets.
361 * docutils/writers/docutils_xml.py
363 - Use the visitor pattern with default_visit()/default_depart() methods
364 instead of minidom to facilitate special handling of selected nodes.
365 - Support raw XML (inserted as-is inside a <raw></raw> node).
367 * docutils/writers/manpage.py
369 - Do not emit comment line with trailing blank. Problematic for VCS.
371 Release 0.8.1 (2011-08-30)
372 ==========================
376 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
377 and [ 3395920 ] (correct copyright info for rst.el).
381 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
383 * docutils/writers/latex2e/__init__.py
385 - Clean up Babel language setting. Restores Sphinx compatibility.
387 Release 0.8 (2011-07-07)
388 ========================
392 - Handle language codes according to `BCP 47`_.
393 - If the specified language is not supported by Docutils,
394 warn and fall back to English.
395 - Math support: reStructuredText "math" role and directive,
396 ``math`` and ``math_block`` doctree elements.
397 - Decode command line arguments with the locale's preferred encoding
398 (to allow, e.g., ``--title=Dornröschen``).
399 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
400 - New sub-module `error_reporting`: handle encoding/decoding errors
401 when reporting exceptions.
402 - Some additions to the Docutils core are released under the 2-Clause BSD
403 license, see COPYING_ for details.
405 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
406 .. _COPYING: COPYING.html
410 - Most directives now support a "name" option that attaches a
413 - Directive content may start on the first line also when the directive
414 type accepts options.
416 * docs/dev/policies.txt:
418 - Recommend the 2-Clause BSD license
419 (http://www.spdx.org/licenses/BSD-2-Clause)
420 for code that is kept under the author's copyright.
422 * tools/buildhtml.py:
424 - Fix ``--local`` switch.
426 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
428 * docutils/writers/html4css1/__init__.py
430 - Set "lang" argument for objects with class argument
431 "language-<language tag>".
432 - New setting "math-output" with support for HTML, MathML, and LaTeX.
434 * docutils/writers/latex2e/__init__.py
436 - Fix [ 3043986 ] AttributeError using :local: with table of content.
437 - Place title data in the document preamble.
438 - Load `babel` package only if required.
439 - Update list of supported languages.
440 - New config setting "hyperref-options".
441 No hard-coded "unicode" hyperref option (clash with xetex).
442 - Set language for custom roles, paragraphs, block-quotes, and
443 line-quotes with class argument "language-<language tag>".
444 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
445 - Convert image URI to a local file path.
446 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
447 has more than one paragraph (Wolfgang Scherer).
448 - \leavevmode before longtable only when needed (prevents spurious vspace)
449 - do not advance table counter for tables without caption
451 * docutils/writers/xetex/__init__.py
453 - New writer generating LaTeX code for compiling with ``xelatex``.
455 A separate writer (inheriting from latex2e) instead of a ``--xetex``
456 option allows separate config options for XeTeX vs. LaTeX2e.
458 * docutils/writers/manpage.py
460 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
461 - Fix: vertical space cleaning for option group ``.``.
463 * tools/editors/emacs/rst.el:
465 - Fix [ 3001100 ] does not handle spaces in filenames
466 (thanks to Jakub Wilk)
470 - strip whitespace from stylesheet arguments
471 - exclude combining chars from column_width()
472 (partial fix for [ 2926161 ])
474 * docutils/parsers/rst/directives/misc.py:
476 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
481 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
482 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
484 Release 0.7 (2010-07-07)
485 ========================
489 - Fix [ 2881769 ] setup configuration.
490 - Fix [ 2788716 ] reporting problems in included files.
494 - FileInput opens files as text files with universal newline support
495 (mode "rU", configurable with the new optional argument "mode").
499 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
503 - Fix [ 2923723 ] let decode_path() tolerate path == None
505 * docutils/writers/html4css1/__init__.py
507 - Support SVG and SWF images (thanks to Stefan Rank).
508 - Generate valid XHTML for centered images with targets.
509 Use CSS classes instead of "align" tags for image alignment.
511 * docutils/writers/latex2e/__init__.py
513 - Use `transforms.writer_aux.Admonitions` to "normalize" special
515 - Use the ``\url`` command for URLs (breaks long URLs instead of
516 writing into the margin).
517 - Preserve runs of spaces in `inline literals`__.
518 - Deprecate ``figure_footnotes`` setting.
519 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
520 - New ``latex_preamble`` setting.
521 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
522 - Fix hyperlink targets (labels) for images, figures, and tables.
523 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
524 - Apply [ 2961991 ] Call hyperref with unicode option.
525 - Drop the special `output_encoding`__ default ("latin-1").
526 The Docutils wide default (usually "UTF-8") is used instead.
527 - Render inline markup in document title and subtitle.
528 - Fix numbering depth with LaTeX section numbering.
529 - Update Unicode -> LaTeX translations.
530 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
532 __ docs/ref/restructuredtext.html#inline-literals
533 __ docs/user/config.html#docutils-footnotes
534 __ docs/user/config.html#output_encoding
536 * docutils/writers/manpage.py
538 - Fix: supported attribute (thanks to peter2108).
539 - Remove trailing blanks in code (keep in sync with mercurial version).
540 - Titles level 1, that is ``.SH``, always uppercase.
541 - Apply patch from mg: literal text should be bold in man-pages.
545 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
550 - Python 3 support: copy test/ and tools/ to the build-dir
551 and convert Python sources with 2to3.
554 Release 0.6 (2009-10-11)
555 ========================
559 - Docutils is now compatible with Python versions from 2.3 up to 2.6
560 and convertible to 3.1 code.
562 + Node.__nonzero__ returns True instead of 1.
563 + use os.walk instead os.path.walk.
564 + minimize "types" module where possible.
565 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
566 + Text nodes now subclass unicode rather than UserString
567 (which is gone in python 3.0).
568 + 3.0 compatibility module docutils._compat
570 + Drop 2.2 compatibility workarounds.
571 + Drop extras/optparse.py and extras/textwrap.py
572 (stdlib modules since 2.3).
574 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
575 - Unix man page export: manpage writer moved from sandbox to Doctutils
578 - Apply [ 1719345 ] Galician translation
579 - Apply [ 1905741 ] Polish translation
580 - Apply [ 1878977 ] make_id(): deaccent characters.
581 - Apply [ 2029251 ] return nonzero when tests fail.
582 - Fix [ 1692788 ] allow UTF-8 in style sheets.
583 - Fix [ 2781629 ] support non-ASCII chars in file names.
584 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
585 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
586 - Fix [ 2821266 ] --strict option works now like --halt=info.
587 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
588 - Fix [ 1627229 ] hyperlink references in substitutions.
590 - The "newlatex" writer is orphaned.
594 - Documented Unicode characters allowed as inline markup openers,
595 closers, and delimiters.
596 - Allow units for all length specifications.
597 - Allow percent sign in "scale" argument of "figure" and "image" directives.
598 - Bugfix: The "figalign" argument of a figure now works as intended
599 (aligning the figure, not its contents).
600 - Align images with class "align-[right|center|left]"
601 (allows setting the alignment of an image in a figure).
605 - Added ``Element.__contains__`` method, for the in-operator.
607 * docutils/parsers/rst/states.py:
609 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
610 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
611 " " (non-breaking space), and "¡ ¿" openers.
613 * docutils/parsers/directives/misc.py:
615 - Added ``start-line`` and ``end-line`` options to "include"
616 directive to select a range of lines.
617 - Hard tabs in literal inclusions are replaced by spaces. This is
618 configurable via the new ``tab-width`` option of the "include" directive
619 (a negative tab-width prevents tab expansion).
623 - Add ``get_stylesheet_list`` function.
624 - Apply [ 2834836 ] print info at halt
626 * docutils/transforms/universal.py:
628 - Raise default priority of StripClasses to exclude stripped classes from
631 * docutils/writers/html4css1/__init__.py:
633 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
634 separated list of stylesheets.
635 - Address [ 1938891 ] Inline literal text creates "pre" span only when
636 needed to prevent inter-word line wraps.
637 - Use `translate` method instead of repeated `replace` calls.
638 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
639 classes to allow CSS styling that does not interfere with other
640 table-using constructs (field lists, citations, ...).
642 * docutils/writers/newlatex2e/__init__.py:
644 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
646 * docutils/writers/latex2e/__init__.py (see also
647 `<docs/user/docutils-05-compat.sty.html>`__) :
649 - Add ``--embed-stylesheet`` option.
650 - Apply [ 1474017 ] image vertical alignment is reversed.
651 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
652 - Change: has_key for dictionaries (not Nodes) to in-operator.
653 - Merge adjacent citations into one latex cite command.
654 - Failsave implementation of custom roles. LaTeX compilation now ignores
655 unknown classes instead of aborting with an error.
656 - Support custom roles based on standard roles.
657 - LaTeX packages can be used as ``--stylesheet`` arguments without
658 restriction. (A style sheet is now referenced with the ``\usepackage``
659 command, if it ends with ``.sty`` or has no extension.)
660 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
661 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
662 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
663 2005-02-04 as a configurable length unit).
664 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
665 if font-encoding is set to ''. LaTeX defaults to OT1 then.
666 - Set sub- and superscript role argument in text mode not as math.
667 Use a custom role based on sub-/superscript if you want italic shape.
668 - Shorter preamble and less dependencies: Load packages and define macros
669 only if required in the document.
670 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
671 - New custom environments and commands with optional "classes" argument.
672 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
673 - Better conformance to Docutils specifications with ``--use-latex-toc``.
674 Support for LaTeX generated ToC also with unnumbered sections.
675 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
676 section numbering by LaTeX.
677 - Use default font in admonitions and sidebar.
678 - Align of image in a figure defaults to 'center'.
679 - Bugfix: Newlines around targets and references prevent run-together
681 - Fix internal hyperlinks.
682 - Use class defaults for page margins ('typearea' now optional).
683 - Float placement made configurable, default changed to "here definitely".
684 - Typeset generic topic as "quote block with title".
685 - Use template (file and configuration option).
686 - In the default template, load cmap.sty (fix text extraction in PDF) and
687 fixltx2e.sty (LaTeX patches, \textsubscript).
688 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
689 - Use `translate` instead of repeated `replace` calls for text encoding.
690 - Hyperlinked footnotes and support for symbol footnotes and
691 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
692 - Complete pairs of binary options
693 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
694 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
696 - font-encoding: "T1" (formerly implicitely set by 'ae').
697 - use-latex-toc: true (ToC with page numbers).
698 - use-latex-footnotes: true (no mixup with figures).
700 * docutils/writers/manpage.py
702 - Do not print version at document end, this is done by the viewer.
703 - Do not print date at document end, this is done by the viewer.
704 - Fix storage of docinfo fields for none standard fields.
706 * docutils/tools/rst2man.py
708 Release 0.5 (2008-06-25)
709 ========================
711 * docutils/languages/he.py: Added to project: Hebrew mappings by
714 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
715 mappings by Meir Kriheli.
717 * docutils/frontend.py:
719 - Configuration files are now assumed and required to be
721 - Paths of applied configuration files are now recorded in the
722 runtime setting ``_config_files`` (accessible via
723 ``--dump-settings``).
724 - Added ``--strip-elements-with-class`` and ``--strip-class``
725 options (``strip_elements_with_classes`` and ``strip_classes``
730 - Added code to determine the input encoding from data: encoding
731 declarations or the presence of byte order marks (UTF-8 & UTF-16).
732 - Added support for IronPython 1.0.
736 - Added ``document.__getstate__`` method, for pickling.
738 * docutils/parsers/rst/states.py:
740 - Allow ``+`` and ``:`` in reference names.
741 - Unquoted targets beginning with an underscore (``.. __target:
742 URI``) are no longer accepted.
743 - Added support for multiple attributions in a physical block quote
744 (indented text block), dividing it into multiple logical block
746 - Added support for unicode bullets in bullet lists: "•", "‣", and
748 - Added support for new object-oriented directive interface,
749 retaining compatibility to the old functional interface.
750 - Added support for throwing ``DirectiveError``'s from within
753 * docutils/parsers/rst/__init__.py:
755 - Added ``Directive`` base class.
756 - Added ``DirectiveError`` base class.
757 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
760 * docutils/parsers/directives/:
762 - Refactored all reStructuredText directives to use the new
763 object-oriented directive interface. Errors are now (mostly)
764 thrown using the new ``DirectiveError`` class.
766 * docutils/parsers/directives/misc.py:
768 - Added ``start-after`` and ``end-before`` options to ``include``
769 directive; thanks to Stefan Rank.
771 * docutils/transforms/universal.py:
773 - Added ``StripClassesAndElements`` transform to remove from the
774 document tree all elements with classes in
775 ``settings.strip_elements_with_classes`` and all "classes"
776 attribute values in ``self.document.settings.strip_classes``.
778 * docutils/transforms/writer_aux.py:
780 - Added ``Admonitions`` transform to transform specific admonitions
781 (like ``note``, ``warning``, etc.) into generic admonitions with a
784 * docutils/writers/html4css1/__init__.py:
786 - Moved template functionality from the PEP/HTML writer here.
787 - Expanded the fragments available in the ``parts`` attribute.
788 - Moved ``id`` attributes from titles to surrounding ``div``
790 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
791 universally supported now).
792 - ``template.txt`` is now opened in text mode instead of binary mode
793 (to ensure Windows compatibility).
794 - ``a`` elements now have an "internal" or "external" class,
795 depending on reference type.
797 * docutils/writers/html4css1/template.txt: Added to project.
799 * docutils/writers/pep_html/:
801 - Moved template functionality to the HTML writer.
803 * docutils/writers/s5_html/__init__.py:
805 - Added ``view_mode`` & ``hidden_controls`` settings
806 (``--view-mode`` & ``--hidden-controls/--visible-controls``
809 * docutils/writers/latex2e/__init__.py:
811 - Add ``--literal-block-env``
812 - Fix: escaping ``%`` in href urls.
813 - Move usepackage hyperref after stylesheet inclusion.
814 - Fix: scrartcl does not have chapter but scrreprt.
815 - Add newline after ``\end{verbatim}``.
816 - Merge smaller differences from latex2e_adaptive_preamble.
817 - Add ``use-part-section``.
818 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
819 - Using leavemode option_list no longer needs to check if parent
820 is a definition list.
821 - Append ``\leavemode`` to definition list terms.
822 - No longer write visit\_/depart_definition_list_item comments to
824 - Table column width with 3 decimal places.
825 - Add table stubs support (boldfont).
826 - Add assemble_parts to writer.
827 - Add simply support for nested tables.
828 - Fix verbatim in tables if use-verbatim-when-possible.
829 - Use section commands down to subparagraph.
830 - Put ensuremath around some latin1 chars.
831 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
832 - New option ``--use-bibtex=style,db1,db2``.
833 - New option ``--reference-label`` to allow usage of LaTeX ref for
834 labels in section references.
835 - Add a label after every section to support sectionnumbers as reference
837 - Fix: bug# 1605376 rst2latex: bad options group list
838 - Remove inactive code for use_optionlist_for_option_list.
839 - Remove latex comments from option_list output.
840 - Fix: bug# 1612270 double qoutes in italian literal.
841 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
842 - Add option --use-latex-abstract.
843 - Image width unit ``px`` is translated to ``pt``.
844 - Add image height support.
845 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
847 - Fix: Do not escape underscores in citation reference labels if
848 use-latex-citations is set.
849 - Use centering instead of center for figure contents, to avoid vertical
851 - Recognize table class: borderless, nolines, booktabs, standard.
852 - Fix: Renaming contents section does not work with latex writer; SF
854 - Applied patch for custom roles with classes from Edward Loper.
855 - Fixed bug that caused crashes with more than 256 lists.
857 * docutils/writers/pep_html/__init__.py:
859 - Changed to support new python.org website structure and
862 * docs/howto/security.txt: "Deploying Docutils Securely", added to
865 * tools/buildhtml.py:
867 -- Added ``ignore`` setting to exclude a list of shell patterns
868 (default: ``.svn:CVS``).
870 * tools/editors/emacs/rst.el:
872 - Changed license to "GPL".
873 - Added ``rst-straighten-decorations`` function.
874 - The ``compile`` module is now always loaded.
875 - Added ``rst-toggle-line-block`` function.
876 - Headings consisting only of non-ASCII characters are now
877 recognized by ``rst-toc`` and ``rst-adjust``.
878 - Added font-lock support for multi-line comments where the first
879 comment line is empty.
880 - Added ``(require 'font-lock)``.
884 - Provide descriptive error message if distutils is missing.
887 Release 0.4 (2006-01-09)
888 ========================
892 - Updated the project policies for trunk/branch development &
895 * docutils/__init__.py:
897 - Added ``__version_details__`` attribute to describe code source
898 (repository/snapshot/release).
899 - Replaced ``default_transforms`` attribute of TransformSpec with
900 ``get_transforms()`` method.
904 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
905 functions, for document tree extraction and reprocessing.
909 - Added ``DocTreeInput`` class, for reprocessing existing documents.
910 - Added support for non-Unicode (e.g. binary) writer output.
914 - Re-introduced ``Targetable.indirect_reference_name``, for
915 MoinMoin/reST compatibility (removed in r3124/r3129).
916 - Added ``serial_escape`` function; escapes string values that are
917 elements of a list, for serialization. Modified Docutils-XML
918 writing (``Element._dom_node``) and pseudo-XML writing
919 (``Element.starttag``) to use ``serial_escape``.
920 - Added ``Node.deepcopy()`` method.
921 - Removed the internal lists ``document.substitution_refs``,
922 ``document.anonymous_refs``, and ``document.anonymous_targets``.
923 - Added a "container" element.
924 - Fixed bug where values of list-valued attributes of elements
925 originating from custom interpreted text roles (i.e., with custom
926 classes) were being shared between element instances. Reported by
929 * docutils/statemachine.py:
931 - Added trailing whitespace stripping to ``string2lines()``.
932 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
933 Asian double-width character support.
937 - Added ``east_asian_column_width()`` for double-width character
940 * docutils/languages/ja.py: Added to project: Japanese mappings by
943 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
944 mappings by Panjunyong.
946 * docutils/parsers/null.py: Added to project; a do-nothing parser.
948 * docutils/parsers/rst/__init__.py:
950 - Added validator to tab_width setting, with test. Closes SF bug
951 #1212515, report from Wu Wei.
953 * docutils/parsers/rst/states.py:
955 - Fixed bug with escaped colons indicating a literal block.
956 - Fixed bug with enumerated lists (SF#1254145).
957 - Backslash-escaped colons inside of field names are now allowed.
958 - Targets (implicit and explicit), anonymous hyperlink references
959 and auto-numbered footnote references inside of substitution
960 definitions are now disallowed.
961 - Fixed bug: list items with blank first lines.
962 - Fixed bug: block quote attributions with indented second lines.
963 - Added East Asian double-width character support (Python 2.4 only).
965 * docutils/parsers/rst/tableparser.py:
967 - Added East Asian double-width character support (Python 2.4 only).
969 * docutils/parsers/rst/directives/body.py:
971 - Added the "container" directive.
973 * docutils/parsers/rst/directives/misc.py:
975 - Added the "default-role", "title", and "date" directives.
976 - Added standard data file syntax to the "include" directive.
977 - Added support for "class" directive content.
979 * docutils/parsers/rst/directives/images.py:
981 - Added ``indirect_reference_name`` support for images with a target
983 - Added support for image width and height units.
984 - Fixed bug with image "target" options.
986 * docutils/parsers/rst/directives/references.py:
988 - Added "class" attribute to "target-notes" directive, for
989 footnote_reference classes.
991 * docutils/parsers/rst/include/: Directory added to project; contains
992 standard data files for the "include" directive. Initial contents:
993 character entity substitution definition sets, and a set of
994 definitions for S5/HTML presentations.
996 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
997 mappings by David Goodger.
999 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
1000 Simplified Chinese mappings by Panjunyong.
1002 * docutils/readers/__init__.py:
1004 - Added universal.Decorations and universal.ExposeInternals
1005 transforms as default transforms for all readers.
1006 - Added ``ReReader`` base class for readers that reread an existing
1009 * docutils/readers/doctree.py: Added to project; a reader for existing
1012 * docutils/transforms/frontmatter.py:
1014 - Fixed the DocInfo transform to handle SVN-style expansion of the
1016 - In ``DocInfo.extract_authors``, treat the contents of "authors"
1019 * docutils/transforms/misc.py:
1021 - Added misc.Transitions transform, extracted from
1022 universal.FinalChecks.
1024 * docutils/transforms/references.py:
1026 - Added references.DanglingReferences transform, extracted from
1027 universal.FinalChecks.
1028 - Fixed bug with doubly-indirect substitutions.
1029 - Added footnote_reference classes attribute to "TargetNotes".
1030 - Fixed bug with circular substitution definitions that put Docutils
1031 into an infinite loop.
1033 * docutils/transforms/universal.py:
1035 - Added universal.ExposeInternals transform, extracted from
1036 universal.FinalChecks.
1037 - Removed universal.FinalChecks transform (logic has been moved to
1038 several new transforms).
1039 - Fixed bug with the "expose_internals" setting and Text nodes
1040 (exposed by the "rawsource" internal attribute).
1041 - Added the universal.StripComments transform, implementation of the
1042 "strip_comments" setting.
1044 * docutils/transforms/writer_aux.py: Added to project; auxiliary
1045 transforms for writers.
1047 - Added ``Compound`` transform, which flattens compound paragraphs.
1049 * docutils/writers/: Several writer modules (html4css1.py) were
1050 converted into packages. Support modules and data files have been
1051 moved into the packages. The stylesheets for the HTML writers are
1052 now installed along with the code, the code knows where to find
1053 them, and the default is to use them (actually, to embed them).
1054 Some adjustments to configuration files may be necessary. The
1055 easiest way to obtain the new default behavior is to remove all
1056 settings whose name includes "stylesheet".
1058 * docutils/writers/__init__.py:
1060 - Added universal.Messages and universal.FilterMessages transforms
1061 as default transforms for all writers.
1062 - Added ``UnfilteredWriter`` base class for writers that pass the
1063 document tree on unchanged.
1065 * docutils/writers/docutils_xml.py:
1067 - Made ``xmlcharrefreplace`` the default output encoding error
1070 * docutils/writers/html4css1/:
1072 - Added support for image width and height units.
1073 - Made ``xmlcharrefreplace`` the default output encoding error
1075 - Made ``--embed-stylesheet`` the default rather than
1076 ``--link-stylesheet``.
1077 - Moved "id" attribute from container (section etc.) to title's <a>
1078 tag, to be on the same tag as "name".
1079 (!!! To be reverted in Docutils 0.5.)
1080 - Added vertical space between fields of field lists.
1081 - Added ``--compact-field-lists`` option to remove vertical space in
1083 - Made cloaking of email addresses with ``--cloak-email-addresses``
1085 - Fixed support for centered images.
1086 - Added support for class="compact" & class="open" lists.
1088 * docutils/writers/latex2e/:
1090 - Underscores in citekeys are no longer escaped.
1092 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
1093 mapping of Unicode characters to LaTeX equivalents.
1095 * docutils/writers/s5_html/: Package added to project; writer for
1096 S5/HTML slide shows.
1098 * docs/dev/distributing.txt: Added to project; guide for distributors
1099 (package maintainers).
1101 * docs/dev/hacking.txt: Added to project; guide for developers.
1103 * docs/ref/doctree.txt:
1105 - Updated for plural attributes "classes", "ids", "names",
1107 - Added the "container" element.
1109 * docs/ref/docutils.dtd:
1111 - Updated for plural attributes "classes", "ids", "names",
1114 * docs/user/emacs.txt: Added to project; a document about Emacs
1115 support for reStructuredText and Docutils.
1117 * docs/user/links.txt: Added to project; lists of Docutils-related
1120 * docs/user/mailing-lists.txt: Added to project; information about
1121 Docutils-related mailing lists and how to access them.
1123 * docs/user/slide-shows.txt: Added to project; example of and docs for
1124 the S5/HTML writer (``rst2s5.py`` front end).
1126 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
1127 Files", added to project.
1129 * test/coverage.sh: Added to project; test coverage script.
1131 * test/DocutilsTestSupport.py:
1133 - Added support for specifying runtime settings at the suite level.
1135 * test/test_functional.py:
1137 - Added the ``clear_output_directory`` function.
1138 - Added support for ``_test_more`` functions in functional test
1141 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
1143 * tools/rstpep2html.py: Renamed from pep.py.
1145 * tools/dev/create_unimap.py: Added to project; script to create the
1146 docutils/writers/unimap_latex.py mapping file.
1148 * tools/dev/profile_docutils.py: Added to project; profiler script.
1150 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
1152 * tools/editors/emacs/restructuredtext.el,
1153 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
1154 Removed from project; the functionality is now contained in rst.el.
1156 * tools/editors/emacs/rst.el: Added to project. Added many features
1157 and fixed many bugs. See docs/user/emacs.txt for details.
1159 * tools/stylesheets: Removed from project. Stylesheets have been
1160 renamed and moved into writer packages.
1163 Release 0.3.9 (2005-05-26)
1164 ==========================
1168 - Eliminated and replaced all uses of the old string attributes
1169 ``id``, ``name``, ``dupname`` and ``class`` with references to the
1170 new list attributes ``ids``, ``names``, ``dupnames`` and
1171 ``classes`` throughout the whole source tree.
1175 - Enabled ``--dump-*`` options when ``--traceback`` specified,
1176 allowing for easier debugging.
1177 - In ``Publisher.publish()``, expanded the generic top-level
1180 * docutils/examples.py:
1182 - Added ``internals`` function for exploration.
1186 - Fixed ``Input.decode`` method to apply heuristics only if no
1187 encoding is explicitly given, and to provide better reporting of
1189 - The ``Input.decode`` method now removes byte order marks (BOMs)
1192 * docutils/nodes.py:
1194 - ``image`` element class changed to subclass of Element, not
1195 TextElement (it's an empty element, and cannot contain text).
1196 - Added ``attr_defaults`` dictionary for default attribute values.
1197 - Added empty list as default value for the following attributes:
1198 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
1199 - Added ``document.decoration`` attribute,
1200 ``document.get_decoration`` method, and ``decoration.get_header``
1201 & ``.get_footer`` methods.
1202 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
1205 * docutils/utils.py:
1207 - Removed ``docutils.utils.Reporter.categories``,
1208 ``docutils.utils.ConditionSet``, and all references to them, to
1209 simplify error reporting.
1211 * docutils/languages/nl.py: Added to project; Dutch mappings by
1214 * docutils/parsers/rst/__init__.py:
1216 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
1218 * docutils/parsers/rst/states.py:
1220 - Added check for escaped at-mark to prevent email address recognition.
1221 - Fixed option lists to allow spaces inside ``<angle-bracketed option
1223 - Allowed whitespace in paths and URLs.
1224 - Added auto-enumerated list items.
1225 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
1227 - Added support for table stub columns.
1229 * docutils/parsers/rst/directives/__init__.py:
1231 - Allowed whitespace in paths (``path`` function).
1232 - Added ``uri`` directive option conversion function.
1234 * docutils/parsers/rst/directives/body.py:
1236 - Fixed illegal context bug with "topic" directive (allowed within
1237 sidebars; not within body elements).
1239 * docutils/parsers/rst/directives/images.py:
1241 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
1242 - Added support for the ``file_insertion_enabled`` setting in the
1243 "figure" directive (disables "figwidth" option).
1244 - "image" directive: added checks for valid values of "align" option,
1245 depending on context. "figure" directive: added specialized
1246 "align" option and attribute on "figure" element.
1247 - Made ":figwidth: image" option of "figure" directive work again.
1248 - Fixed bug with reference names containing uppercase letters
1249 (e.g. ``Name_``) in "target" option of "image" directive.
1251 * docutils/parsers/rst/directives/misc.py:
1253 - Fixed "include" and "raw" directives to catch text decoding
1255 - Allowed whitespace in "include" & "raw" directive paths.
1256 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
1257 settings in "include" & "raw" directives.
1259 * docutils/parsers/rst/directives/parts.py:
1261 - Added "header" & "footer" directives.
1262 - Fixed illegal context bug with "contents" directive (topics
1263 allowed within sidebars; not within body elements).
1265 * docutils/parsers/rst/directives/tables.py:
1267 - Added "list-table" directive.
1268 - Caught empty CSV table bug.
1269 - Added support for the ``file_insertion_enabled`` setting in the
1270 "csv-table" directive.
1271 - Added ``stub-columns`` option to "csv-table" and "list-table"
1274 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
1275 mappings by Martijn Pieters.
1277 * docutils/readers/standalone.py:
1279 - Added ``--section-subtitles`` and ``--no-section-subtitles``
1280 options to activate or deactivate the SectSubTitle transform.
1282 * docutils/transforms/frontmatter.py:
1284 - Added SectSubTitle transform to promote titles of lone
1285 subsections to subtitles.
1287 * docutils/transforms/references.py:
1289 - Fixed mislocated internal targets bug, by propagating internal
1290 targets to the next node, making use of the newly added support
1291 for multiple names and IDs.
1292 - Fixed duplicate footnote label bug.
1293 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1296 * docutils/writers/html4css1.py:
1298 - Fixed unencoded stylesheet reference bug (characters like "&" in
1299 stylesheet references).
1300 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1302 - Added support for multiple IDs per node by creating empty ``span``
1304 - Added the ``field_name_limit`` & ``option_limit`` settings &
1306 - Added support for table stub columns.
1307 - Added support for the ``align`` attribute on ``figure`` elements.
1308 - Added the ``cloak_email_addresses`` setting & support.
1309 - Added ``html_prolog``, ``html_head``, ``html_body``,
1310 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1311 ``docutils.core.publish_parts``.
1312 - Added support for section subtitles.
1314 * docutils/writers/latex2e.py:
1316 - Fixed tables starting with more than one multirow cell.
1317 - Improved --use-latex-docinfo so that organization/contact/address
1318 fields are lumped with the last author field and appear on the
1320 - Made sure the titlepage is always shown with --use-latex-docinfo,
1321 even if the document has no title.
1322 - Made sure that latex doesn't fill in today's date if no date field
1324 - Added support for section subtitles.
1326 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1327 (under development).
1329 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1331 * docs/api/publisher.txt:
1333 - Added "``publish_parts`` Details" section.
1335 * docutils/dev/repository.txt: Added to project; information about the
1336 Docutils Subversion repository.
1338 * docs/ref/docutils.dtd:
1340 - Added a ``stub`` attribute to the ``colspec`` element via the
1341 ``tbl.colspec.att`` parameter entity.
1342 - Allowed topic elements within sidebars
1343 - Added an ``align`` attribute to the ``figure`` element.
1345 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1349 Release 0.3.7 (2004-12-24)
1350 ==========================
1352 * docutils/frontend.py:
1354 - Added options: --input-encoding-error-handler,
1355 --record-dependencies, --leave-footnote-reference-space,
1357 - Added command-line and config file support for "overrides" setting
1362 - Added support for input encoding error handler.
1364 * docutils/nodes.py:
1366 - Added dispatch_visit and dispatch_departure methods to
1367 NodeVisitor; useful as a hook for Visitors.
1368 - Changed structure of ``line_block``; added ``line``.
1369 - Added ``compound`` node class.
1370 - Added a mechanism for Visitors to transitionally ignore new node
1373 * docutils/utils.py:
1375 - Moved ``escape2null`` and ``unescape`` functions from
1376 docutils/parsers/rst/states.py.
1378 * docutils/parsers/rst/roles.py:
1381 - Changed role function API: the "text" parameter now takes
1382 null-escaped interpreted text content.
1384 * docutils/parsers/rst/states.py:
1386 - Fixed bug where a "role" directive in a nested parse would crash
1387 the parser; the state machine's "language" attribute was not being
1389 - Added support for line block syntax.
1390 - Fixed directive parsing bug: argument-less directives didn't
1391 notice that arguments were present.
1392 - Removed error checking for transitions.
1393 - Added support for multiple classifiers in definition list items.
1394 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1395 - Changed role function API: the "text" parameter now takes
1396 null-escaped interpreted text content.
1397 - Empty sections and documents are allowed now.
1399 * docutils/parsers/rst/directives/__init__.py:
1401 - Added ``encoding`` directive option conversion function.
1402 - Allow multiple class names in class_option conversion function.
1404 * docutils/parsers/rst/directives/body.py:
1406 - Converted the line-block directive to use the new structure.
1407 - Extracted the old line-block functionality to the ``block``
1408 function (still used).
1409 - Added ``compound`` directive (thanks to Lea Wiemann).
1411 * docutils/parsers/rst/directives/misc.py:
1413 - Added "encoding" option to "include" and "raw" directives.
1414 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1415 - Allow multiple class names in the "class" directive.
1417 * docutils/parsers/rst/directives/parts.py:
1419 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1420 options. Thanks to Lele Gaifax.
1422 * docutils/parsers/rst/directives/tables.py:
1424 - Added "encoding" directive to "csv-table" directive.
1425 - Added workaround for lack of Unicode support in csv.py, for
1426 non-ASCII CSV input.
1428 * docutils/transforms/misc.py:
1430 - Fixed bug when multiple "class" directives are applied to a single
1432 - Enabled multiple format names for "raw" directive.
1434 * docutils/transforms/references.py:
1436 - Added support for trimming whitespace from beside substitution
1439 * docutils/transforms/universal.py:
1441 - FinalChecks now checks for illegal transitions and moves
1442 transitions between sections.
1444 * docutils/writers/html4css1.py:
1446 - HTMLTranslator.encode now converts U+00A0 to " ".
1447 - "stylesheet" and "stylesheet_path" settings are now mutually
1449 - Added support for the new line_block/line structure.
1450 - --footnote-references now overrides
1451 --trim-footnote-reference-space, if applicable.
1452 - Added support for ``compound`` elements.
1453 - Enabled multiple format names for "raw" directive.
1454 - ``<p>`` tags of a paragraph which is the only visible child of the
1455 document node are no longer stripped.
1456 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1457 new method ``should_be_compact_paragraph()``.
1458 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1460 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1461 the output if they have their ``class`` attribute set.
1462 - The whole document is now surrounded by a ``<div
1463 class="document">`` element.
1464 - Body-level images are now wrapped by their own ``<div>`` elements,
1465 with image classes copied to the wrapper, and for images which
1466 have the ``:align:`` option set, the surrounding ``<div>`` now
1467 receives a class attribute (like ``class="align-left"``).
1469 * docutils/writers/latex2e.py:
1471 - no newline after depart_term.
1472 - Added translations for some Unicode quotes.
1473 - Added option "font-encoding", made package AE the default.
1474 - "stylesheet" and "stylesheet_path" settings are now mutually
1476 - --footnote-references now overrides
1477 --trim-footnote-reference-space, if applicable.
1478 - The footnote label style now matches the footnote reference style
1479 ("brackets" or "superscript").
1480 - Added support for ``compound`` elements.
1481 - Enabled multiple format names for "raw" directive.
1483 * docs/ref/docutils.dtd:
1485 - Changed structure of the ``line_block`` element; added ``line``.
1486 - Added ``compound`` element.
1487 - Added "ltrim" and "rtrim" attributes to
1488 ``substitution_definition`` element.
1489 - Enabled multiple format names for ``raw`` element.
1490 - Enabled multiple classifiers in ``definition_list_item`` elements.
1492 * docs/ref/rst/directives.txt
1494 - Marked "line-block" as deprecated.
1495 - "Class" directive now allows multiple class names.
1496 - Added "Rationale for Class Attribute Value Conversion".
1497 - Added warning about "raw" overuse/abuse.
1499 * docs/ref/rst/restructuredtext.txt:
1501 - Added syntax for line blocks.
1502 - Definition list items may have multiple classifiers.
1504 * docs/ref/rst/roles.txt:
1508 * tools/stylesheets/default.css:
1510 - Added support for the new line_block structure.
1511 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1514 Release 0.3.5 (2004-07-29)
1515 ==========================
1519 * _`Documentation cleanup/reorganization`.
1521 - Created new subdirectories of docs/:
1523 * ``docs/user/``: introductory/tutorial material for end-users
1524 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1525 * ``docs/api/``: API reference material for client-developers
1526 * ``docs/ref/``: reference material for all groups
1527 * ``docs/howto/``: for component-developers and core-developers
1528 * ``docs/peps/``: Python Enhancement Proposals
1530 - Moved ``docs/*`` to ``docs/user/``.
1531 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1532 ``spec/`` to ``docs/dev``.
1533 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1534 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1535 - Moved ``alternatives.txt``, and ``problems.txt`` from
1536 ``spec/rst/`` to ``docs/dev/rst/``.
1537 - Moved ``reStructuredText.txt``, ``directives.txt``,
1538 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1539 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1540 ``roles.txt``, ``reStructuredText.txt`` to
1541 ``restructuredtext.txt``.
1542 - Moved ``spec/howto/`` to ``docs/howto``.
1544 In order to keep the CVS history of moved files, we supplied
1545 SourceForge with a `script for modifying the Docutils CVS
1548 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1550 After running the cleanup script:
1552 - Added ``docs/index.txt``.
1553 - Added a ``.htaccess`` file to the ``web`` module, containing
1554 redirects for all old paths to new paths. They'll preserve
1555 fragments (the "#name" part of a URL), and won't clutter up the
1556 file system, and will correct the URL in the user's browser.
1557 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1558 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1559 the "To Do" list itself in ``docs/dev/todo.txt``.
1560 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1561 section of ``docs/dev/todo.txt``.
1562 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1563 - Added "How To Report Bugs" to ``BUGS.txt``.
1564 - Went through all the sources and docs (including under web/) and
1565 updated links. Mostly done by Lea Wiemann; thanks Lea!
1566 (Still need to update links in the sandboxes.)
1570 * BUGS.txt: Added to project.
1572 * THANKS.txt: Added to project.
1574 * docutils/__init__.py:
1576 - 0.3.4: Post-release.
1580 - Added special error handling & advice for UnicodeEncodeError.
1581 - Refactored Publisher.publish (simplified exception handling &
1582 extracted debug dumps).
1583 - Renamed "enable_exit" parameter of convenience functions to
1584 "enable_exit_status".
1585 - Enabled traceback (exception propagation) by default in
1586 programmatic convenience functions.
1587 - Now publish_file and publish_cmdline convenience functions return
1588 the encoded string results in addition to their regular I/O.
1589 - Extracted common code from publish_file, publish_string, and
1590 publish_parts, into new publish_programmatically. Extracted
1591 settings code to ``Publisher.process_programmatic_settings``.
1592 - In Publisher.publish, disabled ``settings_overrides`` when
1593 ``settings`` is supplied; redundant.
1595 * docutils/frontend.py:
1597 - Added help text for "--output-encoding-error-handler" and
1598 "--error-encoding-error-handler".
1599 - Renamed "--exit" to "--exit-status".
1600 - Simplified default-setting code.
1602 * docutils/parsers/rst/__init__.py:
1604 - Added "--pep-base-url" and "--rfc-base-url" options.
1606 * docutils/parsers/rst/states.py:
1608 - Made URI recognition more aggressive and intelligent.
1610 * docutils/parsers/rst/directives/__init__.py:
1612 - Added several directive option conversion functions.
1614 * docutils/parsers/rst/directives/body.py:
1616 - Moved "table" directive to tables.py.
1618 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1621 * docutils/writers/latex2e.py:
1623 - Added "--table-style=(standard|booktabs|nolines)"
1624 - figures get "here" option (LaTeX per default puts them at bottom),
1625 and figure content is centered.
1626 - Rowspan support for tables.
1627 - Fix: admonition titles before first section.
1628 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1629 - Replave ``_`` in literal by an underlined blank, because it has the correct
1631 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1632 - A few unicode replacements, if output_encoding != utf
1633 - Add "--graphicx-option".
1634 - Indent literal-blocks.
1635 - Fix: omit ``\maketitle`` when there is no document title.
1637 * docs/index.txt: "Docutils Project Documentation Overview", added to
1640 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1641 Tool", added to project.
1643 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1645 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1647 * docs/dev/policies.txt: Added to project (extracted from
1648 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1650 * docs/dev/release.txt: Added to project (extracted from
1651 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1653 * docs/dev/testing.txt: Added to project.
1655 * docs/dev/website.txt: Added to project (extracted from
1656 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1658 * docs/ref/rst/directives.txt:
1660 - Added directives: "table", "csv-table".
1662 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1663 added to project. 1 page for syntax, and a 1 page reference for
1664 directives and roles. Source text to be used as-is; not meant to be
1667 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1668 with a change of title.
1670 * test/functional/, contents, and test/test_functional.py: Added to
1673 * tools/buildhtml.py: Fixed bug with config file handling.
1675 * tools/html.py: Removed from project (duplicate of rst2html.py).
1677 * tools/pep2html.py: Removed from project (duplicate of Python's
1678 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1679 Docutils-related PEPs in docs/peps/).
1681 * tools/rst2pseudoxml.py: Renamed from publish.py.
1683 * tools/rst2xml.py: Renamed from docutils-xml.py.
1685 * tools/test.txt: Removed from project; moved to
1686 docs/user/rst/demo.txt.
1688 * setup.py: Now also installs ``rst2latex.py``.
1691 Release 0.3.3 (2004-05-09)
1692 ==========================
1694 * docutils/__init__.py:
1696 - 0.3.1: Reorganized config file format (multiple sections); see
1698 - Added unknown_reference_resolvers attribute to TransformSpec.
1699 - 0.3.2: Interpreted text reorganization.
1704 - Catch system messages to stop tracebacks from parsing errors.
1705 - Catch exceptions during processing report & exit without
1706 tracebacks, except when "--traceback" used.
1707 - Reordered components for OptionParser; application comes last.
1708 - Added "config_section" parameter to several methods and functions,
1709 allowing front ends to easily specify their config file sections.
1710 - Added publish_parts convenience function to allow access to individual
1711 parts of a document.
1713 * docutils/examples.py: Added to project; practical examples of
1714 Docutils client code, to be used as-is or as models for variations.
1716 * docutils/frontend.py:
1718 - Added "--traceback" & "--no-traceback" options ("traceback"
1720 - Implemented support for config file reorganization:
1721 ``standard_config_files`` moved from ``ConfigParser`` to
1722 ``OptionParser``; added
1723 ``OptionParser.get_config_file_settings()`` and
1724 ``.get_standard_config_settings()``; support for old "[options]"
1725 section (with deprecation warning) and mapping from old to new
1727 - Reimplemented setting validation.
1728 - Enabled flexible boolean values: yes/no, true/false, on/off.
1729 - Added ``Values``, a subclass of ``optparse.Values``, with support
1730 for list setting attributes.
1731 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1732 thanks to Beni Cherniavsky.
1733 - Added "--no-section-numbering" option.
1737 - Catch IOErrors when opening source & destination files, report &
1738 exit without tracebacks. Added ``handle_io_errors`` parameter to
1739 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1741 * docutils/nodes.py:
1743 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1744 method definitions (via ``exec``) to dynamic assignments (via
1745 ``setattr``); thanks to Roman Suzi.
1746 - Encapsulated visitor dynamic assignments in a function; thanks to
1748 - Added indirect_reference_name attribute to the Targetable
1749 class. This attribute holds the whitespace_normalized_name
1750 (contains mixed case) of a target.
1752 * docutils/statemachine.py:
1754 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1755 - Added ``StringList.get_2D_block``.
1757 * docutils/utils.py:
1759 - Added "level" attribute to SystemMessage exceptions.
1761 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1764 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1767 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1768 Marcelo Huerta San Martin.
1770 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1771 mappings by Lalo Martins.
1773 * docutils/languages/ru.py: Added to project; Russian mappings by
1776 * docutils/parsers/rst/roles.py: Added to project. Contains
1777 interpreted text role functions, a registry for interpreted text
1778 roles, and an API for adding to and retrieving from the registry.
1779 Contributed by Edward Loper.
1781 * docutils/parsers/rst/states.py:
1783 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1784 - Allowed true em-dash character and "---" as block quote
1786 - Added support for <angle-bracketed> complex option arguments
1788 - Fixed handling of backslashes in substitution definitions.
1789 - Fixed off-by-1 error with extra whitespace after substitution
1790 definition directive.
1791 - Added inline markup parsing to field lists' field names.
1792 - Added support for quoted (and unindented) literal blocks.
1793 Driven in part by a bribe from Frank Siebenlist (thanks!).
1794 - Parser now handles escapes in URIs correctly.
1795 - Made embedded-URIs' reference text omittable. Idea from Beni
1797 - Refactored explicit target processing code.
1798 - Added name attribute to references containing the reference name only
1799 through whitespace_normalize_name (no case changes).
1800 - parse_target no longer returns the refname after going through
1801 normalize_name. This is now handled in make_target.
1802 - Fixed bug relating to role-less interpreted text in non-English
1804 - Reorganized interpreted text processing; moved code into the new
1805 roles.py module. Contributed by Edward Loper.
1806 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1807 ``parse_directive_block``.
1809 * docutils/parsers/rst/tableparser.py:
1811 - Reworked for ``StringList``, to support "include" directives in
1814 * docutils/parsers/rst/directives/__init__.py:
1816 - Renamed ``unchanged()`` directive option conversion function to
1817 ``unchanged_required``, and added a new ``unchanged``.
1818 - Catch unicode value too high error; fixes bug 781766.
1819 - Beefed up directive error reporting.
1821 * docutils/parsers/rst/directives/body.py:
1823 - Added basic "table" directive.
1825 * docutils/parsers/rst/directives/images.py:
1827 - Added "target" option to "image" directive.
1828 - Added name attribute to references containing the reference name only
1829 through whitespace_normalize_name (no case changes).
1831 * docutils/parsers/rst/directives/misc.py:
1833 - Isolated the import of the ``urllib2`` module; was causing
1834 problems on SourceForge (``libssl.so.2`` unavailable?).
1835 - Added the "role" directive for declaring custom interpreted text
1838 * docutils/parsers/rst/directives/parts.py:
1840 - The "contents" directive does more work up-front, creating the
1841 "topic" and "title", and leaving the "pending" node for the
1842 transform. Allows earlier reference resolution; fixes subtle bug.
1844 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1845 mappings by Jannie Hofmeyr.
1847 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1848 mappings by Marek Blaha.
1850 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1851 mappings by Marcelo Huerta San Martin.
1853 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1854 Portuguese mappings by Lalo Martins.
1856 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1857 mappings by Roman Suzi.
1859 * docutils/transforms/parts.py:
1861 - The "contents" directive does more work up-front, creating the
1862 "topic" and "title", and leaving the "pending" node for the
1863 transform. Allows earlier reference resolution; fixes subtle bug.
1864 - Added support for disabling of section numbering.
1866 * docutils/transforms/references.py:
1868 - Verifying that external targets are truly targets and not indirect
1869 references. This is because we are now adding a "name" attribute to
1870 references in addition to targets. Note sure if this is correct!
1871 - Added code to hook into the unknown_reference_resolvers list for a
1872 transformer in resolve_indirect_target. This allows the
1873 unknown_reference_resolvers to keep around indirect targets which
1874 docutils doesn't know about.
1875 - Added specific error message for duplicate targets.
1877 * docutils/transforms/universal.py:
1879 - Added FilterMessages transform (removes system messages below the
1880 verbosity threshold).
1881 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1882 to FinalCheckVisitor for application-specific handling of
1883 unresolvable references.
1884 - Added specific error message for duplicate targets.
1886 * docutils/writers/__init__.py:
1888 - Added assemble_parts method to the Writer class to allow for
1889 access to a documents individual parts.
1890 - Documented & set default for ``Writer.output`` attribute.
1892 * docutils/writers/html4css1.py:
1894 - Fixed unicode handling of attribute values (bug 760673).
1895 - Prevent duplication of "class" attribute values (bug report from
1897 - Improved table grid/border handling (prompted by report from Bob
1899 - Added support for table titles.
1900 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1902 - Added functionality to keep track of individual parts of a document
1903 and store them in a dictionary as the "parts" attribute of the writer.
1904 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1905 - Added proper support for the "scale" attribute of the "image"
1906 element. Contributed by Brent Cook.
1907 - Added ``--initial-header-level`` option.
1908 - Fixed bug: the body_pre_docinfo segment depended on there being a
1909 docinfo; if no docinfo, the document title was incorporated into
1910 the body segment. Adversely affected the publish_parts interface.
1912 * docutils/writers/latex2e.py:
1914 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1915 about a missing file.
1916 - Added options and support: ``--compound-enumerators``,
1917 ``--section-prefix-for-enumerators``, and
1918 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1920 - Added option ``--use-verbatim-when-possible``, to avoid
1921 problematic characters (eg, '~' in italian) in literal blocks.
1922 - It's now possible to use four section levels in the `book` and
1923 `report` LaTeX classes. The default `article` class still has
1926 * docs/config.txt: "Docutils Configuration Files", added to project.
1927 Moved config file entry descriptions from tools.txt.
1931 - Moved config file entry descriptions to config.txt.
1933 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1936 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1937 Text Roles", added to project.
1939 * spec/rst/reStructuredText.txt:
1941 - Added description of support for <angle-bracketed> complex option
1942 arguments to option lists.
1943 - Added subsections for indented and quoted literal blocks.
1945 * test: Continually adding & updating tests.
1947 - Added test/test_settings.py & test/data/config_*.txt support
1949 - Added test/test_writers/test_htmlfragment.py.
1951 * test/DocutilsTestSupport.py:
1953 - Refactored LaTeX publisher test suite/case class names to make
1954 testing other writers easier.
1955 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1956 to test the processing of HTML fragments which use the new
1957 publish_parts convenience function.
1959 * tools/buildhtml.py:
1961 - Added support for the "--prune" option.
1962 - Removed dependency on pep2html.py; plaintext PEPs no longer
1965 * tools/docutils.conf:
1967 - Updated for configuration file reorganization.
1969 * tools/rst2html.py:
1971 - copied from tools/html.py
1975 - added a 'scripts' section to configuration
1976 - added 'tools/rst2html.py' to the scripts section
1979 Release 0.3 (2003-06-24)
1980 ========================
1984 * Renamed "attribute" to "option" for directives/extensions.
1986 * Renamed transform method "transform" to "apply".
1988 * Renamed "options" to "settings" for runtime settings (as set by
1989 command-line options). Sometimes "option" (singular) became
1990 "settings" (plural). Some variations below:
1992 - document.options -> document.settings (stored in other objects as
1994 - option_spec -> settings_spec (not directives though)
1995 - OptionSpec -> SettingsSpec
1996 - cmdline_options -> settings_spec
1997 - relative_path_options -> relative_path_settings
1998 - option_default_overrides -> settings_default_overrides
1999 - Publisher.set_options -> Publisher.get_settings
2003 * COPYING.txt: Added "Public Domain Dedication".
2005 * FAQ.txt: Frequently asked questions, added to project.
2009 - Updated with PyPI Trove classifiers.
2010 - Conditional installation of third-party modules.
2012 * docutils/__init__.py:
2014 - Bumped version to 0.2.1 to reflect changes to I/O classes.
2015 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
2016 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
2017 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
2018 option and its effect on the PEP template & writer.
2019 - Bumped version to 0.2.4 due to changes to the PEP template &
2021 - Bumped version to 0.2.5 to reflect changes to Reporter output.
2022 - Added ``TransformSpec`` class for new transform system.
2023 - Bumped version to 0.2.6 for API changes (renaming).
2024 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
2025 convenience functions.
2026 - Added ``Component.component_type`` attribute.
2027 - Bumped version to 0.2.8 because of the internal parser switch from
2028 plain lists to the docutils.statemachine.StringList objects.
2029 - Bumped version to 0.2.9 because of the frontend.py API changes.
2030 - Bumped version to 0.2.10 due to changes to the project layout
2031 (third-party modules removed from the "docutils" package), and
2032 signature changes in ``io.Input``/``io.Output``.
2033 - Changed version to 0.3.0 for release.
2037 - Made ``publish()`` a bit more convenient.
2038 - Generalized ``Publisher.set_io``.
2039 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
2040 parameters; improved its docstring.
2041 - Added ``publish_file()`` and ``publish_string()``.
2042 - Factored ``Publisher.set_source()`` and ``.set_destination()``
2044 - Added support for "--dump-pseudo-xml", "--dump-settings", and
2045 "--dump-transforms" hidden options.
2046 - Added ``Publisher.apply_transforms()`` method.
2047 - Added ``Publisher.set_components()`` method; support for
2048 ``publish_*()`` conveninece functions.
2049 - Moved config file processing to docutils/frontend.py.
2050 - Added support for exit status ("exit_level" setting &
2051 ``enable_exit`` parameter for Publisher.publish() and convenience
2054 * docutils/frontend.py:
2056 - Check for & exit on identical source & destination paths.
2057 - Fixed bug with absolute paths & "--config".
2058 - Set non-command-line defaults in ``OptionParser.__init__()``:
2059 ``_source`` & ``_destination``.
2060 - Distributed ``relative_path_settings`` to components; updated
2061 ``OptionParser.populate_from_components()`` to combine it all.
2062 - Require list of keys in ``make_paths_absolute`` (was implicit in
2063 global ``relative_path_settings``).
2064 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
2065 "--dump-settings", and "--dump-transforms" hidden options.
2066 - Removed nasty internals-fiddling ``ConfigParser.get_section``
2067 code, replaced with correct code.
2068 - Added validation functionality for config files.
2069 - Added "--error-encoding" option/setting, "_disable_config"
2071 - Added encoding validation; updated "--input-encoding" and
2072 "--output-encoding"; added "--error-encoding-error-handler" and
2073 "--output-encoding-error-handler".
2074 - Moved config file processing from docutils/core.py.
2075 - Updated ``OptionParser.populate_from_components`` to handle new
2076 ``SettingsSpec.settings_defaults`` dict.
2077 - Added support for "-" => stdin/stdout.
2078 - Added "exit_level" setting ("--exit" option).
2082 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
2083 - Added automatic closing to ``FileInput`` and ``FileOutput``.
2084 - Delayed opening of ``FileOutput`` file until ``write()`` called.
2085 - ``FileOutput.write()`` now returns the encoded output string.
2086 - Try to get path/stream name automatically in ``FileInput`` &
2088 - Added defaults for source & destination paths.
2089 - Allow for Unicode I/O with an explicit "unicode" encoding.
2090 - Added ``Output.encode()``.
2091 - Removed dependency on runtime settings; pass encoding directly.
2092 - Recognize Unicode strings in ``Input.decode()``.
2093 - Added support for output encoding error handlers.
2095 * docutils/nodes.py:
2097 - Added "Invisible" element category class.
2098 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
2099 modification during a traversal.
2100 - Added element classes: ``line_block``, ``generated``, ``address``,
2101 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
2102 ``superscript``, ``subscript``, ``inline``
2103 - Added support for lists of nodes to ``Element.insert()``.
2104 - Fixed parent linking in ``Element.replace()``.
2105 - Added new abstract superclass ``FixedTextElement``; adds
2106 "xml:space" attribute.
2107 - Added support for "line" attribute of ``system_message`` nodes.
2108 - Added support for the observer pattern from ``utils.Reporter``.
2109 Added ``parse_messages`` and ``transform_messages`` attributes to
2110 ``document``, removed ``messages``. Added ``note_parse_message``
2111 and ``note_transform_message`` methods.
2112 - Added support for improved diagnostics:
2114 - Added "document", "source", and "line" internal attributes to
2115 ``Node``, set by ``Node.setup_child()``.
2116 - Converted variations on ``node.parent = self`` to
2117 ``self.setup_child(node)``.
2118 - Added ``document.current_source`` & ``.current_line``
2119 attributes, and ``.note_source`` observer method.
2120 - Changed "system_message" output to GNU-Tools format.
2122 - Added a "rawsource" attribute to the ``Text`` class, for text
2123 before backslash-escape resolution.
2124 - Support for new transform system.
2125 - Reworked ``pending`` element.
2126 - Fixed XML DOM bug (SF #660611).
2127 - Removed the ``interpeted`` element class and added
2128 ``title_reference``, ``abbreviation``, ``acronym``.
2129 - Made substitutions case-sensitive-but-forgiving; moved some code
2131 - Fixed Unicode bug on element attributes (report: William Dode).
2133 * docutils/optik.py: Removed from project; replaced with
2134 extras/optparse.py and extras/textwrap.py. These will be installed
2135 only if they're not already present in the Python installation.
2137 * docutils/roman.py: Moved to extras/roman.py; this will be installed
2138 only if it's not already present in the Python installation.
2140 * docutils/statemachine.py:
2142 - Factored out ``State.add_initial_transitions()`` so it can be
2144 - Converted whitespace-specific "blank" and "indent" transitions
2145 from special-case code to ordinary transitions: removed
2146 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
2147 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
2148 ``ws_initial_transitions`` attributes.
2149 - Removed ``State.match_transition()`` after merging it into
2151 - Added ``StateCorrection`` exception.
2152 - Added support for ``StateCorrection`` in ``StateMachine.run()``
2153 (moved ``TransitionCorrection`` support there too.)
2154 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
2155 ``EOFError`` instead of ``IndexError``.
2156 - Added ``State.no_match`` method.
2157 - Added support for the Observer pattern, triggered by input line
2159 - Added ``strip_top`` parameter to
2160 ``StateMachineWS.get_first_known_indented``.
2161 - Made ``context`` a parameter to ``StateMachine.run()``.
2162 - Added ``ViewList`` & ``StringList`` classes;
2163 ``extract_indented()`` becomes ``StringList.get_indented()``.
2164 - Added ``StateMachine.insert_input()``.
2165 - Fixed ViewList slice handling for Python 2.3. Patch from (and
2166 thanks to) Fred Drake.
2168 * docutils/utils.py:
2170 - Added a ``source`` attribute to Reporter instances and
2171 ``system_message`` elements.
2172 - Added an observer pattern to ``utils.Reporter`` to keep track of
2174 - Fixed bugs in ``relative_path()``.
2175 - Added support for improved diagnostics.
2176 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
2177 - Added support for encoding Reporter stderr output, and encoding
2179 - Reporter keeps track of the highest level system message yet
2182 * docutils/languages: Fixed bibliographic field language lookups.
2184 * docutils/languages/es.py: Added to project; Spanish mappings by
2185 Marcelo Huerta San Martin.
2187 * docutils/languages/fr.py: Added to project; French mappings by
2190 * docutils/languages/it.py: Added to project; Italian mappings by
2193 * docutils/languages/sk.py: Added to project; Slovak mappings by
2196 * docutils/parser/__init__.py:
2198 - Added ``Parser.finish_parse()`` method.
2200 * docutils/parser/rst/__init__.py:
2202 - Added options: "--pep-references", "--rfc-references",
2203 "--tab-width", "--trim-footnote-reference-space".
2205 * docutils/parsers/rst/states.py:
2207 - Changed "title under/overline too short" system messages from INFO
2208 to WARNING, and fixed its insertion location.
2209 - Fixed enumerated list item parsing to allow paragraphs & section
2210 titles to begin with enumerators.
2211 - Converted system messages to use the new "line" attribute.
2212 - Fixed a substitution reference edge case.
2213 - Added support for "--pep-references" and "--rfc-references"
2214 options; reworked ``Inliner`` code to make customization easier.
2215 - Removed field argument parsing.
2216 - Added support for short section title over/underlines.
2217 - Fixed "simple reference name" regexp to ignore text like
2218 "object.__method__"; not an anonymous reference.
2219 - Added support for improved diagnostics.
2220 - Reworked directive API, based on Dethe Elza's contribution. Added
2221 ``Body.parse_directive()``, ``.parse_directive_options()``,
2222 ``.parse_directive_arguments()`` methods.
2223 - Added ``ExtensionOptions`` class, to parse directive options
2224 without parsing field bodies. Factored
2225 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
2226 ``ExtensionOptions``.
2227 - Improved definition list term/classifier parsing.
2228 - Added warnings for unknown directives.
2229 - Renamed ``Stuff`` to ``Struct``.
2230 - Now flagged as errors: transitions at the beginning or end of
2231 sections, empty sections (except title), and empty documents.
2232 - Updated for ``statemachine.StringList``.
2233 - Enabled recognition of schemeless email addresses in targets.
2234 - Added support for embedded URIs in hyperlink references.
2235 - Added backslash-escapes to inline markup end-string suffix.
2236 - Added support for correct interpreted text processing.
2237 - Fixed nested title parsing (topic, sidebar directives).
2238 - Added special processing of backslash-escaped whitespace (idea
2239 from David Abrahams).
2240 - Made substitutions case-sensitive-but-forgiving; moved some code
2241 to ``docutils.nodes``.
2242 - Added support for block quote attributions.
2243 - Added a kludge to work-around a conflict between the bubble-up
2244 parser strategy and short titles (<= 3 char-long over- &
2245 underlines). Fixes SF bug #738803 "infinite loop with multiple
2246 titles" submitted by Jason Diamond.
2247 - Added explicit interpreted text roles for standard inline markup:
2248 "emphasis", "strong", "literal".
2249 - Implemented "superscript" and "subscript" interpreted text roles.
2250 - Added initial support for "abbreviation" and "acronym" roles;
2252 - Added support for "--trim-footnote-reference-space" option.
2253 - Optional space before colons in directives & hyperlink targets.
2255 * docutils/parsers/rst/tableparser.py:
2257 - Fixed a bug that was producing unwanted empty rows in "simple"
2259 - Detect bad column spans in "simple" tables.
2261 * docutils/parsers/rst/directives: Updated all directive functions to
2264 * docutils/parsers/rst/directives/__init__.py:
2266 - Added ``flag()``, ``unchanged()``, ``path()``,
2267 ``nonnegative_int()``, ``choice()``, and ``class_option()``
2268 directive option helper functions.
2269 - Added warnings for unknown directives.
2270 - Return ``None`` for missing directives.
2271 - Added ``register_directive()``, thanks to William Dode and Paul
2274 * docutils/parsers/rst/directives/admonitions.py:
2276 - Added "admonition" directive.
2278 * docutils/parsers/rst/directives/body.py: Added to project. Contains
2279 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
2280 "parsed-literal", "rubric", "epigraph", "highlights" and
2281 "pull-quote" directives.
2283 * docutils/parsers/rst/directives/images.py:
2285 - Added an "align" attribute to the "image" & "figure" directives
2286 (by Adam Chodorowski).
2287 - Added "class" option to "image", and "figclass" to "figure".
2289 * docutils/parsers/rst/directives/misc.py:
2291 - Added "include", "raw", and "replace" directives, courtesy of
2293 - Added "unicode" and "class" directives.
2295 * docutils/parsers/rst/directives/parts.py:
2297 - Added the "sectnum" directive; by Dmitry Jemerov.
2298 - Added "class" option to "contents" directive.
2300 * docutils/parsers/rst/directives/references.py: Added to project.
2301 Contains the "target-notes" directive.
2303 * docutils/parsers/rst/languages/__init__.py:
2305 - Return ``None`` from get_language() for missing language modules.
2307 * docutils/parsers/rst/languages/de.py: Added to project; German
2308 mappings by Engelbert Gruber.
2310 * docutils/parsers/rst/languages/en.py:
2312 - Added interpreted text roles mapping.
2314 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2315 mappings by Marcelo Huerta San Martin.
2317 * docutils/parsers/rst/languages/fr.py: Added to project; French
2318 mappings by William Dode.
2320 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2321 mappings by Nicola Larosa.
2323 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2324 mappings by Miroslav Vasko.
2326 * docutils/readers/__init__.py:
2328 - Added support for the observer pattern from ``utils.Reporter``, in
2329 ``Reader.parse`` and ``Reader.transform``.
2330 - Removed ``Reader.transform()`` method.
2331 - Added default parameter values to ``Reader.__init__()`` to make
2332 instantiation easier.
2333 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2335 * docutils/readers/pep.py:
2337 - Added the ``peps.TargetNotes`` transform to the Reader.
2338 - Removed PEP & RFC reference detection code; moved to
2339 parsers/rst/states.py as options (enabled here by default).
2340 - Added support for pre-acceptance PEPs (no PEP number yet).
2341 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2344 * docutils/readers/python: Python Source Reader subpackage added to
2345 project, including preliminary versions of:
2348 - moduleparser.py: Parser for Python modules.
2350 * docutils/transforms/__init__.py:
2352 - Added ``Transformer`` class and completed transform reform.
2353 - Added unknown_reference_resolvers list for each transformer. This list holds
2354 the list of functions provided by each component of the transformer that
2355 help resolve references.
2357 * docutils/transforms/frontmatter.py:
2359 - Improved support for generic fields.
2360 - Fixed bibliographic field language lookups.
2362 * docutils/transforms/misc.py: Added to project. Miscellaneous
2365 * docutils/transforms/parts.py:
2367 - Moved the "id" attribute from TOC list items to the references
2368 (``Contents.build_contents()``).
2369 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2370 - Added "class" attribute support to ``Contents``.
2372 * docutils/transforms/peps.py:
2374 - Added ``mask_email()`` function, updating to pep2html.py's
2376 - Linked "Content-Type: text/x-rst" to PEP 12.
2377 - Added the ``TargetNotes`` PEP-specific transform.
2378 - Added ``TargetNotes.cleanup_callback``.
2379 - Added title check to ``Headers``.
2381 * docutils/transforms/references.py:
2383 - Added the ``TargetNotes`` generic transform.
2384 - Split ``Hyperlinks`` into multiple transforms.
2385 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2386 - Added check for circular indirect references.
2387 - Made substitutions case-sensitive-but-forgiving.
2389 * docutils/transforms/universal.py:
2391 - Added support for the "--expose-internal-attributes" option.
2392 - Removed ``Pending`` transform classes & data.
2394 * docutils/writers/__init__.py:
2396 - Removed ``Writer.transform()`` method.
2398 * docutils/writers/docutils-xml.py:
2400 - Added XML and doctype declarations.
2401 - Added "--no-doctype" and "--no-xml-declaration" options.
2403 * docutils/writers/html4css1.py:
2405 - "name" attributes only on these tags: a, applet, form, frame,
2407 - Added "name" attribute to <a> in section titles for Netscape 4
2408 support (bug report: Pearu Peterson).
2409 - Fixed targets (names) on footnote, citation, topic title,
2410 problematic, and system_message nodes (for Netscape 4).
2411 - Changed field names from "<td>" to "<th>".
2412 - Added "@" to "@" encoding to thwart address harvesters.
2413 - Improved the vertical whitespace optimization; ignore "invisible"
2414 nodes (targets, comments, etc.).
2415 - Improved inline literals with ``<span class="pre">`` around chunks
2416 of text and `` `` for runs of spaces.
2417 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2418 ``self.docinfo`` segments.
2419 - Added support for "line_block", "address" elements.
2420 - Improved backlinks (footnotes & system_messages).
2421 - Improved system_message output.
2422 - Redefined "--stylesheet" as containing an invariant URL, used
2423 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2425 - Added "--footnote-references" option (superscript or brackets).
2426 - Added "--compact-lists" and "--no-compact-lists" options.
2427 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2428 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2429 - Improved field list rendering.
2430 - Added Docutils version to "generator" meta tag.
2431 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2432 - Improved layout of <pre> HTML source.
2433 - Fixed attribute typo on <colspec>.
2434 - Refined XML prologue.
2435 - Support for no stylesheet.
2436 - Removed "interpreted" element support.
2437 - Added support for "title_reference", "sidebar", "attribution",
2438 "rubric", and generic "admonition" elements.
2439 - Added "--attribution" option.
2440 - Added support for "inline", "subscript", "superscript" elements.
2441 - Added initial support for "abbreviation" and "acronym";
2444 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2448 - Double quotes in literal blocks (special treatment for de/ngerman).
2449 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2450 - Added "--attribution" option.
2451 - Right align attributions.
2453 * docutils/writers/pep_html.py:
2455 - Parameterized output encoding in PEP template.
2456 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2457 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2458 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2460 - Added an override on the "--footnote-references" option.
2461 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2462 - Added Docutils version to "generator" meta tag.
2463 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2467 - Added a "silent" setting for ``buildhtml.py``.
2468 - Added a "Getting Help" section.
2469 - Rearranged the structure.
2470 - Kept up to date, with new settings, command-line options etc.
2471 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2472 - Converted settings table into a definition list.
2474 * docs/rst/quickstart.txt:
2476 - Added a table of contents.
2477 - Added feedback information.
2478 - Added mention of minimum section title underline lengths.
2479 - Removed the 4-character minimum for section title underlines.
2481 * docs/rst/quickref.html:
2483 - Added a "Getting Help" section.
2484 - Added a style to make section title backlinks more subtle.
2485 - Added mention of minimum section title underline lengths.
2486 - Removed the 4-character minimum for section title underlines.
2488 * extras: Directory added to project; contains third-party modules
2489 that Docutils depends on (optparse, textwrap, roman). These are
2490 only installed if they're not already present.
2492 * licenses: Directory added to project; contains copies of license
2493 files for non-public-domain files.
2497 - Changed the focus. It's about DTD elements: structural
2498 relationships, semantics, and external (public) attributes. Not
2499 about the element class library.
2500 - Moved some implementation-specific stuff into ``docutils.nodes``
2502 - Wrote descriptions of all common attributes and parameter
2503 entities. Filled in introductory material.
2504 - Working through the element descriptions: 55 down, 37 to go.
2505 - Removed "Representation of Horizontal Rules" to
2506 spec/rst/alternatives.txt.
2508 * spec/docutils.dtd:
2510 - Added "generated" inline element.
2511 - Added "line_block" body element.
2512 - Added "auto" attribute to "title".
2513 - Changed content models of "literal_block" and "doctest_block" to
2515 - Added ``%number;`` attribute type parameter entity.
2516 - Changed ``%structural.elements;`` to ``%section.elements``.
2517 - Updated attribute types; made more specific.
2518 - Added "address" bibliographic element.
2519 - Added "line" attribute to ``system_message`` element.
2520 - Removed "field_argument" element; "field_name" may contain
2521 multiple words and whitespace.
2522 - Changed public identifier to docutils.sf.net.
2523 - Removed "interpreted" element; added "title_reference",
2524 "abbreviation", "acronym".
2525 - Removed "refuri" attribute from "footnote_reference" and
2526 "citation_reference".
2527 - Added "sidebar", "rubric", "attribution", "admonition",
2528 "superscript", "subscript", and "inline" elements.
2530 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2532 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2534 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2536 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2539 * spec/transforms.txt: Added to project.
2541 * spec/howto: Added subdirectory, for developer how-to docs.
2543 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2544 Elza, edited & extended by David Goodger.
2546 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2549 * spec/rst/alternatives.txt:
2551 - Added "Doctree Representation of Transitions" from
2553 - Updated "Inline External Targets" & closed the debate.
2554 - Added ideas for interpreted text syntax extensions.
2555 - Added "Nested Inline Markup" section.
2557 * spec/rst/directives.txt:
2559 - Added directives: "topic", "sectnum", "target-notes",
2560 "line-block", "parsed-literal", "include", "replace", "sidebar",
2561 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2563 - Formalized descriptions of directive details.
2564 - Added an "align" attribute to the "image" & "figure" directives
2565 (by Adam Chodorowski).
2566 - Added "class" options to "topic", "sidebar", "line-block",
2567 "parsed-literal", "contents", and "image"; and "figclass" to
2570 * spec/rst/interpreted.txt: Added to project. Descriptions of
2571 interpreted text roles.
2573 * spec/rst/introduction.txt:
2575 - Added pointers to material for new users.
2577 * spec/rst/reStructuredText.txt:
2579 - Disambiguated comments (just add a newline after the "::").
2580 - Updated enumerated list description; added a discussion of the
2581 second-line validity checking.
2582 - Updated directive description.
2583 - Added a note redirecting newbies to the user docs.
2584 - Expanded description of inline markup start-strings in non-markup
2586 - Removed field arguments and made field lists a generic construct.
2587 - Removed the 4-character minimum for section title underlines.
2588 - Clarified term/classifier delimiter & inline markup ambiguity
2590 - Added "Embedded URIs".
2591 - Updated "Interpreted Text" section.
2592 - Added "Character-Level Inline Markup" section.
2594 * test: Continually adding & updating tests.
2596 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2597 - Moved test/test_pep/ to test/test_readers/test_pep/.
2598 - Added test/test_readers/test_python/.
2599 - Added test/test_writers/ (Engelbert Gruber).
2603 - Made the ``locale.setlocale()`` calls in front ends
2606 * tools/buildhtml.py:
2608 - Added "--silent" option.
2609 - Fixed bug with absolute paths & "--config".
2610 - Updated for new I/O classes.
2611 - Added some exception handling.
2612 - Separated publishers' setting defaults; prevents interference.
2613 - Updated for new ``publish_file()`` convenience function.
2615 * tools/pep-html-template:
2617 - Allow for "--embed-stylesheet".
2618 - Added Docutils version to "generator" meta tag.
2619 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2620 - Conform to XHTML spec.
2622 * tools/pep2html.py:
2624 - Made ``argv`` a parameter to ``main()``.
2625 - Added support for "Content-Type:" header & arbitrary PEP formats.
2626 - Linked "Content-Type: text/plain" to PEP 9.
2627 - Files skipped (due to an error) are not pushed onto the server.
2628 - Updated for new I/O classes.
2629 - Added ``check_requirements()`` & ``pep_type_error()``.
2630 - Added some exception handling.
2631 - Updated for new ``publish_string()`` convenience function.
2632 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2634 * tools/quicktest.py:
2636 - Added "-V"/"--version" option.
2638 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2640 * tools/unicode2rstsubs.py: Added to project. Produces character
2641 entity files (reSructuredText substitutions) from the MathML master
2644 * tools/editors: Support code for editors, added to project. Contains
2645 ``emacs/restructuredtext.el``.
2647 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2649 - Added style for chunks of inline literals.
2650 - Removed margin for first child of table cells.
2651 - Right-aligned field list names.
2652 - Support for auto-numbered section titles in TOCs.
2653 - Increased the size of inline literals (<tt>) in titles.
2654 - Restored the light gray background for inline literals.
2655 - Added support for "line_block" elements.
2656 - Added style for "address" elements.
2657 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2658 - Improved field list rendering.
2659 - Vertical whitespace improvements.
2660 - Removed "a.target" style.
2662 * tools/stylesheets/pep.css:
2664 - Fixed nested section margins.
2665 - Other changes parallel those of ``../default.css``.
2668 Release 0.2 (2002-07-31)
2669 ========================
2673 - The word "component" was being used ambiguously. From now on,
2674 "component" will be used to mean "Docutils component", as in Reader,
2675 Writer, Parser, or Transform. Portions of documents (Table of
2676 Contents, sections, etc.) will be called "document parts".
2677 - Did a grand renaming: a lot of ``verylongnames`` became
2678 ``very_long_names``.
2679 - Cleaned up imports: no more relative package imports or
2680 comma-separated lists of top-level modules.
2681 - Added support for an option values object which carries default
2682 settings and overrides (from command-line options and library use).
2683 - Added internal Unicode support, and support for both input and
2685 - Added support for the ``docutils.io.IO`` class & subclasses.
2689 * docutils/__init__.py:
2691 - Added ``ApplicationError`` and ``DataError``, for use throughout
2693 - Added ``Component`` base class for Docutils components; implements
2694 the ``supports`` method.
2695 - Added ``__version__`` (thus, ``docutils.__version__``).
2699 - Removed many keyword parameters to ``Publisher.__init__()`` and
2700 ``publish()``; bundled into an option values object. Added
2701 "argv", "usage", "description", and "option_spec" parameters for
2702 command-line support.
2703 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2705 - Reworked I/O model for ``docutils.io`` wrappers.
2706 - Updated ``Publisher.set_options()``; now returns option values
2708 - Added support for configuration files (/etc/docutils.conf,
2709 ./docutils.conf, ~/.docutils).
2710 - Added ``Publisher.setup_option_parser()``.
2711 - Added default usage message and description.
2713 * docutils/frontend.py: Added to project; support for front-end
2714 (command-line) scripts. Option specifications may be augmented by
2715 components. Requires Optik (http://optik.sf.net/) for option
2716 processing (installed locally as docutils/optik.py).
2718 * docutils/io.py: Added to project; uniform API for a variety of input
2721 * docutils/nodes.py:
2723 - Added ``TreeCopyVisitor`` class.
2724 - Added a ``copy`` method to ``Node`` and subclasses.
2725 - Added a ``SkipDeparture`` exception for visitors.
2726 - Renamed ``TreePruningException`` from ``VisitorException``.
2727 - Added docstrings to ``TreePruningException``, subclasses, and
2729 - Improved docstrings.
2730 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2731 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2733 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2734 ``PreDecorative`` mixin.
2735 - Reworked the name/id bookkeeping; to ``document``, removed
2736 ``explicit_targets`` and ``implicit_targets`` attributes, added
2737 ``nametypes`` attribute and ``set_name_id_map`` method.
2738 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2740 - Added ``document.has_name()`` method.
2741 - Fixed DOM generation for list-attributes.
2742 - Added category class ``Labeled`` (used by footnotes & citations).
2743 - Added ``Element.set_class()`` method (sets "class" attribute).
2745 * docutils/optik.py: Added to project. Combined from the Optik
2746 package, with added option groups and other modifications. The use
2747 of this module is probably only temporary.
2749 * docutils/statemachine.py:
2751 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2752 - Added underscores to improve many awkward names.
2753 - In ``string2lines()``, changed whitespace normalizing translation
2754 table to regexp; restores Python 2.0 compatibility with Unicode.
2756 * docutils/urischemes.py:
2758 - Filled in some descriptions.
2759 - Added "shttp" scheme.
2761 * docutils/utils.py:
2763 - Added ``clean_rcs_keywords`` function (moved from
2764 docutils/transforms/frontmatter.py
2765 ``DocInfo.filter_rcs_keywords``).
2766 - Added underscores to improve many awkward names.
2767 - Changed names of Reporter's thresholds:
2768 warning_level -> report_level; error_level -> halt_level.
2769 - Moved ``utils.id()`` to ``nodes.make_id()``.
2770 - Added ``relative_path(source, target)``.
2772 * docutils/languages/de.py: German mappings; added to project. Thanks
2773 to Gunnar Schwant for the translations.
2775 * docutils/languages/en.py: Added "Dedication" bibliographic field
2778 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2781 * docutils/parsers/rst/states.py:
2783 - Added underscores to improve many awkward names.
2784 - Added RFC-2822 header support.
2785 - Extracted the inline parsing code from ``RSTState`` to a separate
2786 class, ``Inliner``, which will allow easy subclassing.
2787 - Made local bindings for ``memo`` container & often-used contents
2788 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2789 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2790 - Added ``MarkupMismatch`` exception; for late corrections.
2791 - Added ``-/:`` characters to inline markup's start string prefix,
2792 ``/`` to end string suffix.
2793 - Fixed a footnote bug.
2794 - Fixed a bug with literal blocks.
2795 - Applied patch from Simon Budig: simplified regexps with symbolic
2796 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2797 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2798 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2799 - Allowed non-ASCII in "simple names" (directive names, field names,
2801 - Converted ``Inliner.patterns.initial`` to be dynamically built
2802 from parts with ``build_regexp()`` function.
2803 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2804 - Updated docstrings.
2805 - Changed "table" to "grid_table"; added "simple_table" support.
2807 * docutils/parsers/rst/tableparser.py:
2809 - Changed ``TableParser`` to ``GridTableParser``.
2810 - Added ``SimpleTableParser``.
2811 - Refactored naming.
2813 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2814 a fallback language for directive names.
2816 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2817 directive to use a ``pending`` element, used only by HTML writers.
2819 * docutils/parsers/rst/directives/parts.py: Renamed from
2822 - Added "backlinks" attribute to "contents" directive.
2824 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2825 project by Adam Chodorowski.
2827 * docutils/readers/__init__.py: Gave Readers more control over
2828 choosing and instantiating Parsers.
2830 * docutils/readers/pep.py: Added to project; for PEP processing.
2832 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2833 requires a ``component`` parameter.
2835 * docutils/transforms/components.py: Added to project; transforms
2836 related to Docutils components.
2838 * docutils/transforms/frontmatter.py:
2840 - In ``DocInfo.extract_authors``, check for a single "author" in an
2841 "authors" group, and convert it to a single "author" element.
2842 - Added support for "Dedication" and generic bibliographic fields.
2844 * docutils/transforms/peps.py: Added to project; PEP-specific.
2846 * docutils/transforms/parts.py: Renamed from old components.py.
2848 - Added filter for `Contents`, to use alt-text for inline images,
2849 and to remove inline markup that doesn't make sense in the ToC.
2850 - Added "name" attribute to TOC topic depending on its title.
2851 - Added support for optional TOC backlinks.
2853 * docutils/transforms/references.py: Fixed indirect target resolution
2854 in ``Hyperlinks`` transform.
2856 * docutils/transforms/universal.py:
2858 - Changed ``Messages`` transform to properly filter out system
2859 messages below the warning threshold.
2860 - Added ``Decorations`` transform (support for ``--generator``,
2861 ``--date``, ``--time``, ``--source-link`` options).
2863 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2864 Engelbert Gruber's PDF writer.
2866 * docutils/writers/html4css1.py:
2868 - Made XHTML-compatible (switched to lowercase element & attribute
2869 names; empty tag format).
2870 - Escape double-dashes in comment text.
2871 - Improved boilerplate & modularity of output.
2872 - Exposed modular output in Writer class.
2873 - Added a "generator" meta tag to <head>.
2874 - Added support for the ``--stylesheet`` option.
2875 - Added support for ``decoration``, ``header``, and ``footer``
2877 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2878 translation table to regexp; restores Python 2.0 compatibility
2880 - Added the translator class as instance variable to the Writer, to
2881 make it easily subclassable.
2882 - Improved option list spacing (thanks to Richard Jones).
2883 - Modified field list output.
2884 - Added backlinks to footnotes & citations.
2885 - Added percentage widths to "<col>" tags (from colspec).
2886 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2887 "<span>" changed to "<var>".
2888 - Inline literals: "<code>" changed to "<tt>".
2889 - Many changes to optimize vertical space: compact simple lists etc.
2890 - Add a command-line options & directive attributes to control TOC
2891 and footnote/citation backlinks.
2892 - Added support for optional footnote/citation backlinks.
2893 - Added support for generic bibliographic fields.
2894 - Identify backrefs.
2895 - Relative URLs for stylesheet links.
2897 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2898 PEPs (subclass of ``html4css1.Writer``).
2900 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2902 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2903 of the Docutils internal doctree in XML.
2905 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2909 - Changed the title to "The Docutils Document Tree".
2910 - Added "Hyperlink Bookkeeping" section.
2912 * spec/docutils.dtd:
2914 - Added ``decoration``, ``header``, and ``footer`` elements.
2915 - Brought ``interpreted`` element in line with the parser: changed
2916 attribute "type" to "role", added "position".
2917 - Added support for generic bibliographic fields.
2919 * spec/notes.txt: Continual updates. Added "Project Policies".
2921 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2924 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2926 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2927 mailing list discussions.
2929 * spec/pep-0287.txt:
2931 - Renamed to "reStructuredText Docstring Format".
2933 - Reworked Q&A as an enumerated list.
2934 - Converted to reStructuredText format.
2936 * spec/pysource.dtd:
2938 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2940 * spec/pysource.txt: Removed from project. Moved much of its contents
2943 * spec/rst/alternatives.txt:
2945 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2946 - Added "Inline External Targets" section.
2948 * spec/rst/directives.txt:
2950 - Added "backlinks" attribute to "contents" directive.
2952 * spec/rst/problems.txt:
2954 - Updated the Enumerated List Markup discussion.
2955 - Added new alternative table markup syntaxes.
2957 * spec/rst/reStructuredText.txt:
2959 - Clarified field list usage.
2960 - Updated enumerated list description.
2961 - Clarified purpose of directives.
2962 - Added ``-/:`` characters to inline markup's start string prefix,
2963 ``/`` to end string suffix.
2964 - Updated "Authors" bibliographic field behavior.
2965 - Changed "inline hyperlink targets" to "inline internal targets".
2966 - Added "simple table" syntax to supplement the existing but
2967 newly-renamed "grid tables".
2968 - Added cautions for anonymous hyperlink use.
2969 - Added "Dedication" and generic bibliographic fields.
2971 * test: Made test modules standalone (subdirectories became packages).
2973 * test/DocutilsTestSupport.py:
2975 - Added support for PEP extensions to reStructuredText.
2976 - Added support for simple tables.
2977 - Refactored naming.
2979 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2981 - Now supports true packages containing test modules
2982 (``__init__.py`` files required); fixes duplicate module name bug.
2984 * test/test_pep/: Subpackage added to project; PEP testing.
2986 * test/test_rst/test_SimpleTableParser.py: Added to project.
2990 - Updated html.py and publish.py front-end tools to use the new
2991 command-line processing facilities of ``docutils.frontend``
2992 (exposed in ``docutils.core.Publisher``), reducing each to just a
2994 - Added ``locale.setlocale()`` calls to front-end tools.
2996 * tools/buildhtml.py: Added to project; batch-generates .html from all
2997 the .txt files in directories and subdirectories.
2999 * tools/default.css:
3001 - Added support for ``header`` and ``footer`` elements.
3002 - Added styles for "Dedication" topics (biblio fields).
3004 * tools/docutils.conf: A configuration file; added to project.
3006 * tools/docutils-xml.py: Added to project.
3008 * tools/pep.py: Added to project; PEP to HTML front-end tool.
3010 * tools/pep-html-template: Added to project.
3012 * tools/pep2html.py: Added to project from Python (nondist/peps).
3013 Added support for Docutils (reStructuredText PEPs).
3015 * tools/quicktest.py:
3017 - Added the ``--attributes`` option, hacked a bit.
3018 - Added a second command-line argument (output file); cleaned up.
3020 * tools/stylesheets/: Subdirectory added to project.
3022 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
3025 Release 0.1 (2002-04-20)
3026 ========================
3028 This is the first release of Docutils, merged from the now inactive
3029 reStructuredText__ and `Docstring Processing System`__ projects. For
3030 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
3031 `DPS HISTORY`__ files.
3033 __ http://structuredtext.sourceforge.net/
3034 __ http://docstring.sourceforge.net/
3035 __ http://structuredtext.sourceforge.net/HISTORY.html
3036 __ http://docstring.sourceforge.net/HISTORY.html
3038 General changes: renamed 'dps' package to 'docutils'; renamed
3039 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
3040 the test suites (reStructuredText's test/test_states renamed to
3041 test/test_rst); and all modifications required to make it all work.
3043 * docutils/parsers/rst/states.py:
3045 - Improved diagnostic system messages for missing blank lines.
3046 - Fixed substitution_reference bug.
3052 indent-tabs-mode: nil
3053 sentence-end-double-space: t