1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
22 - Handle language codes according to `BCP 47`_.
23 - If the specified language is not supported by Docutils,
24 warn and fall back to English.
25 - Math support: reStructuredText "math" role and directive,
26 ``math`` and ``math_block`` doctree elements.
27 - Decode command line arguments with the locales preferred encoding
28 (to allow, e.g., ``--title=Dornröschen``.
30 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
34 - Fix ``--local`` switch.
37 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
39 * docutils/writers/html4css1/__init__.py
41 - Set "lang" argument for objects with class argument
42 "language-<language tag>".
44 * docutils/writers/latex2e/__init__.py
46 - Fix [ 3043986 ] AttributeError using :local: with table of content.
47 - Place title data in the document preamble.
48 - Load `babel` package only if required.
49 - Update list of supported languages.
50 - New config setting "hyperref-options".
51 No hard-coded "unicode" hyperref option (clash with xetex).
52 - Set language for custom roles, paragraphs, block-quotes, and
53 line-quotes with class argument "language-<language tag>".
54 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
56 * docutils/writers/xetex/__init__.py
58 - New writer generating LaTeX code for compiling with ``xelatex``.
60 A separate writer (inheriting from latex2e) instead of a ``--xetex``
61 option allows separate config options for XeTeX vs. LaTeX2e.
63 * tools/editors/emacs/rst.el:
65 - Fix [ 3001100 ] does not handle spaces in filenames
66 (thanks to Jakub Wilk)
70 - strip whitespace from stylesheet arguments
71 - exclude combining chars from column_width
72 (partial fix for [ 2926161 ])
75 Release 0.7 (2010-07-07)
76 ========================
80 - Fix [ 2881769 ] setup configuration.
81 - Fix [ 2788716 ] reporting problems in included files.
85 - FileInput opens files as text files with universal newline support
86 (mode "rU", configurable with the new optional argument "mode").
90 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
94 - Fix [ 2923723 ] let decode_path() tolerate path == None
96 * docutils/writers/html4css1/__init__.py
98 - Support SVG and SWF images (thanks to Stefan Rank).
99 - Generate valid XHTML for centered images with targets.
100 Use CSS classes instead of "align" tags for image alignment.
102 * docutils/writers/latex2e/__init__.py
104 - Use `transforms.writer_aux.Admonitions` to "normalize" special
106 - Use the ``\url`` command for URLs (breaks long URLs instead of
107 writing into the margin).
108 - Preserve runs of spaces in `inline literals`__.
109 - Deprecate ``figure_footnotes`` setting.
110 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
111 - New ``latex_preamble`` setting.
112 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
113 - Fix hyperlink targets (labels) for images, figures, and tables.
114 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
115 - Apply [ 2961991 ] Call hyperref with unicode option.
116 - Drop the special `output_encoding`__ default ("latin-1").
117 The Docutils wide default (usually "UTF-8") is used instead.
118 - Render inline markup in document title and subtitle.
119 - Fix numbering depth with LaTeX section numbering.
120 - Update Unicode -> LaTeX translations.
121 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
123 __ docs/ref/restructuredtext.html#inline-literals
124 __ docs/user/config.html#docutils-footnotes
125 __ docs/user/config.html#output_encoding
127 * docutils/writers/manpage.py
129 - Fix: supported attribute (thanks to peter2108).
130 - Remove trailing blanks in code (keep in sync with mercurial version).
131 - Titles level 1, that is ``.SH``, always uppercase.
132 - Apply patch from mg: literal text should be bold in man-pages.
136 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
141 - Python 3 support: copy test/ and tools/ to the build-dir
142 and convert Python sources with 2to3.
145 Release 0.6 (2009-10-11)
146 ========================
150 - Docutils is now compatible with Python versions from 2.3 up to 2.6
151 and convertible to 3.1 code.
153 + Node.__nonzero__ returns True instead of 1.
154 + use os.walk instead os.path.walk.
155 + minimize "types" module where possible.
156 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
157 + Text nodes now subclass unicode rather than UserString
158 (which is gone in python 3.0).
159 + 3.0 compatibility module docutils._compat
161 + Drop 2.2 compatibility workarounds.
162 + Drop extras/optparse.py and extras/textwrap.py
163 (stdlib modules since 2.3).
165 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
166 - Unix man page export: manpage writer moved from sandbox to Doctutils
169 - Apply [ 1719345 ] Galician translation
170 - Apply [ 1905741 ] Polish translation
171 - Apply [ 1878977 ] make_id(): deaccent characters.
172 - Apply [ 2029251 ] return nonzero when tests fail.
173 - Fix [ 1692788 ] allow UTF-8 in style sheets.
174 - Fix [ 2781629 ] support non-ASCII chars in file names.
175 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
176 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
177 - Fix [ 2821266 ] --strict option works now like --halt=info.
178 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
179 - Fix [ 1627229 ] hyperlink references in substitutions.
181 - The "newlatex" writer is orphaned.
185 - Documented Unicode characters allowed as inline markup openers,
186 closers, and delimiters.
187 - Allow units for all length specifications.
188 - Allow percent sign in "scale" argument of "figure" and "image" directives.
189 - Bugfix: The "figalign" argument of a figure now works as intended
190 (aligning the figure, not its contents).
191 - Align images with class "align-[right|center|left]"
192 (allows setting the alignment of an image in a figure).
196 - Added ``Element.__contains__`` method, for the in-operator.
198 * docutils/parsers/rst/states.py:
200 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
201 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
202 " " (non-breaking space), and "¡ ¿" openers.
204 * docutils/parsers/directives/misc.py:
206 - Added ``start-line`` and ``end-line`` options to "include"
207 directive to select a range of lines.
208 - Hard tabs in literal inclusions are replaced by spaces. This is
209 configurable via the new ``tab-width`` option of the "include" directive
210 (a negative tab-width prevents tab expansion).
214 - Add ``get_stylesheet_list`` function.
215 - Apply [ 2834836 ] print info at halt
217 * docutils/transforms/universal.py:
219 - Raise default priority of StripClasses to exclude stripped classes from
222 * docutils/writers/html4css1/__init__.py:
224 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
225 separated list of stylesheets.
226 - Address [ 1938891 ] Inline literal text creates "pre" span only when
227 needed to prevent inter-word line wraps.
228 - Use `translate` method instead of repeated `replace` calls.
229 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
230 classes to allow CSS styling that does not interfere with other
231 table-using constructs (field lists, citations, ...).
233 * docutils/writers/newlatex2e/__init__.py:
235 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
237 * docutils/writers/latex2e/__init__.py (see also
238 `<docs/user/docutils-05-compat.sty.html>`__) :
240 - Add ``--embed-stylesheet`` option.
241 - Apply [ 1474017 ] image vertical alignment is reversed.
242 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
243 - Change: has_key for dictionaries (not Nodes) to in-operator.
244 - Merge adjacent citations into one latex cite command.
245 - Failsave implementation of custom roles. LaTeX compilation now ignores
246 unknown classes instead of aborting with an error.
247 - Support custom roles based on standard roles.
248 - LaTeX packages can be used as ``--stylesheet`` arguments without
249 restriction. (A style sheet is now referenced with the ``\usepackage``
250 command, if it ends with ``.sty`` or has no extension.)
251 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
252 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
253 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
254 2005-02-04 as a configurable length unit).
255 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
256 if font-encoding is set to ''. LaTeX defaults to OT1 then.
257 - Set sub- and superscript role argument in text mode not as math.
258 Use a custom role based on sub-/superscript if you want italic shape.
259 - Shorter preamble and less dependencies: Load packages and define macros
260 only if required in the document.
261 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
262 - New custom environments and commands with optional "classes" argument.
263 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
264 - Better conformance to Docutils specifications with ``--use-latex-toc``.
265 Support for LaTeX generated ToC also with unnumbered sections.
266 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
267 section numbering by LaTeX.
268 - Use default font in admonitions and sidebar.
269 - Align of image in a figure defaults to 'center'.
270 - Bugfix: Newlines around targets and references prevent run-together
272 - Fix internal hyperlinks.
273 - Use class defaults for page margins ('typearea' now optional).
274 - Float placement made configurable, default changed to "here definitely".
275 - Typeset generic topic as "quote block with title".
276 - Use template (file and configuration option).
277 - In the default template, load cmap.sty (fix text extraction in PDF) and
278 fixltx2e.sty (LaTeX patches, \textsubscript).
279 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
280 - Use `translate` instead of repeated `replace` calls for text encoding.
281 - Hyperlinked footnotes and support for symbol footnotes and
282 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
283 - Complete pairs of binary options
284 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
285 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
287 - font-encoding: "T1" (formerly implicitely set by 'ae').
288 - use-latex-toc: true (ToC with page numbers).
289 - use-latex-footnotes: true (no mixup with figures).
291 * docutils/writers/manpage.py
293 - Do not print version at document end, this is done by the viewer.
294 - Do not print date at document end, this is done by the viewer.
295 - Fix storage of docinfo fields for none standard fields.
297 * docutils/tools/rst2man.py
299 Release 0.5 (2008-06-25)
300 ========================
302 * docutils/languages/he.py: Added to project: Hebrew mappings by
305 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
306 mappings by Meir Kriheli.
308 * docutils/frontend.py:
310 - Configuration files are now assumed and required to be
312 - Paths of applied configuration files are now recorded in the
313 runtime setting ``_config_files`` (accessible via
314 ``--dump-settings``).
315 - Added ``--strip-elements-with-class`` and ``--strip-class``
316 options (``strip_elements_with_classes`` and ``strip_classes``
321 - Added code to determine the input encoding from data: encoding
322 declarations or the presence of byte order marks (UTF-8 & UTF-16).
323 - Added support for IronPython 1.0.
327 - Added ``document.__getstate__`` method, for pickling.
329 * docutils/parsers/rst/states.py:
331 - Allow ``+`` and ``:`` in reference names.
332 - Unquoted targets beginning with an underscore (``.. __target:
333 URI``) are no longer accepted.
334 - Added support for multiple attributions in a physical block quote
335 (indented text block), dividing it into multiple logical block
337 - Added support for unicode bullets in bullet lists: "•", "‣", and
339 - Added support for new object-oriented directive interface,
340 retaining compatibility to the old functional interface.
341 - Added support for throwing ``DirectiveError``'s from within
344 * docutils/parsers/rst/__init__.py:
346 - Added ``Directive`` base class.
347 - Added ``DirectiveError`` base class.
348 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
351 * docutils/parsers/directives/:
353 - Refactored all reStructuredText directives to use the new
354 object-oriented directive interface. Errors are now (mostly)
355 thrown using the new ``DirectiveError`` class.
357 * docutils/parsers/directives/misc.py:
359 - Added ``start-after`` and ``end-before`` options to ``include``
360 directive; thanks to Stefan Rank.
362 * docutils/transforms/universal.py:
364 - Added ``StripClassesAndElements`` transform to remove from the
365 document tree all elements with classes in
366 ``settings.strip_elements_with_classes`` and all "classes"
367 attribute values in ``self.document.settings.strip_classes``.
369 * docutils/transforms/writer_aux.py:
371 - Added ``Admonitions`` transform to transform specific admonitions
372 (like ``note``, ``warning``, etc.) into generic admonitions with a
375 * docutils/writers/html4css1/__init__.py:
377 - Moved template functionality from the PEP/HTML writer here.
378 - Expanded the fragments available in the ``parts`` attribute.
379 - Moved ``id`` attributes from titles to surrounding ``div``
381 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
382 universally supported now).
383 - ``template.txt`` is now opened in text mode instead of binary mode
384 (to ensure Windows compatibility).
385 - ``a`` elements now have an "internal" or "external" class,
386 depending on reference type.
388 * docutils/writers/html4css1/template.txt: Added to project.
390 * docutils/writers/pep_html/:
392 - Moved template functionality to the HTML writer.
394 * docutils/writers/s5_html/__init__.py:
396 - Added ``view_mode`` & ``hidden_controls`` settings
397 (``--view-mode`` & ``--hidden-controls/--visible-controls``
400 * docutils/writers/latex2e/__init__.py:
402 - Add ``--literal-block-env``
403 - Fix: escaping ``%`` in href urls.
404 - Move usepackage hyperref after stylesheet inclusion.
405 - Fix: scrartcl does not have chapter but scrreprt.
406 - Add newline after ``\end{verbatim}``.
407 - Merge smaller differences from latex2e_adaptive_preamble.
408 - Add ``use-part-section``.
409 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
410 - Using leavemode option_list no longer needs to check if parent
411 is a definition list.
412 - Append ``\leavemode`` to definition list terms.
413 - No longer write visit\_/depart_definition_list_item comments to
415 - Table column width with 3 decimal places.
416 - Add table stubs support (boldfont).
417 - Add assemble_parts to writer.
418 - Add simply support for nested tables.
419 - Fix verbatim in tables if use-verbatim-when-possible.
420 - Use section commands down to subparagraph.
421 - Put ensuremath around some latin1 chars.
422 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
423 - New option ``--use-bibtex=style,db1,db2``.
424 - New option ``--reference-label`` to allow usage of LaTeX ref for
425 labels in section references.
426 - Add a label after every section to support sectionnumbers as reference
428 - Fix: bug# 1605376 rst2latex: bad options group list
429 - Remove inactive code for use_optionlist_for_option_list.
430 - Remove latex comments from option_list output.
431 - Fix: bug# 1612270 double qoutes in italian literal.
432 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
433 - Add option --use-latex-abstract.
434 - Image width unit ``px`` is translated to ``pt``.
435 - Add image height support.
436 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
438 - Fix: Do not escape underscores in citation reference labels if
439 use-latex-citations is set.
440 - Use centering instead of center for figure contents, to avoid vertical
442 - Recognize table class: borderless, nolines, booktabs, standard.
443 - Fix: Renaming contents section does not work with latex writer; SF
445 - Applied patch for custom roles with classes from Edward Loper.
446 - Fixed bug that caused crashes with more than 256 lists.
448 * docutils/writers/pep_html/__init__.py:
450 - Changed to support new python.org website structure and
453 * docs/howto/security.txt: "Deploying Docutils Securely", added to
456 * tools/buildhtml.py:
458 -- Added ``ignore`` setting to exclude a list of shell patterns
459 (default: ``.svn:CVS``).
461 * tools/editors/emacs/rst.el:
463 - Changed license to "GPL".
464 - Added ``rst-straighten-decorations`` function.
465 - The ``compile`` module is now always loaded.
466 - Added ``rst-toggle-line-block`` function.
467 - Headings consisting only of non-ASCII characters are now
468 recognized by ``rst-toc`` and ``rst-adjust``.
469 - Added font-lock support for multi-line comments where the first
470 comment line is empty.
471 - Added ``(require 'font-lock)``.
475 - Provide descriptive error message if distutils is missing.
478 Release 0.4 (2006-01-09)
479 ========================
483 - Updated the project policies for trunk/branch development &
486 * docutils/__init__.py:
488 - Added ``__version_details__`` attribute to describe code source
489 (repository/snapshot/release).
490 - Replaced ``default_transforms`` attribute of TransformSpec with
491 ``get_transforms()`` method.
495 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
496 functions, for document tree extraction and reprocessing.
500 - Added ``DocTreeInput`` class, for reprocessing existing documents.
501 - Added support for non-Unicode (e.g. binary) writer output.
505 - Re-introduced ``Targetable.indirect_reference_name``, for
506 MoinMoin/reST compatibility (removed in r3124/r3129).
507 - Added ``serial_escape`` function; escapes string values that are
508 elements of a list, for serialization. Modified Docutils-XML
509 writing (``Element._dom_node``) and pseudo-XML writing
510 (``Element.starttag``) to use ``serial_escape``.
511 - Added ``Node.deepcopy()`` method.
512 - Removed the internal lists ``document.substitution_refs``,
513 ``document.anonymous_refs``, and ``document.anonymous_targets``.
514 - Added a "container" element.
515 - Fixed bug where values of list-valued attributes of elements
516 originating from custom interpreted text roles (i.e., with custom
517 classes) were being shared between element instances. Reported by
520 * docutils/statemachine.py:
522 - Added trailing whitespace stripping to ``string2lines()``.
523 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
524 Asian double-width character support.
528 - Added ``east_asian_column_width()`` for double-width character
531 * docutils/languages/ja.py: Added to project: Japanese mappings by
534 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
535 mappings by Panjunyong.
537 * docutils/parsers/null.py: Added to project; a do-nothing parser.
539 * docutils/parsers/rst/__init__.py:
541 - Added validator to tab_width setting, with test. Closes SF bug
542 #1212515, report from Wu Wei.
544 * docutils/parsers/rst/states.py:
546 - Fixed bug with escaped colons indicating a literal block.
547 - Fixed bug with enumerated lists (SF#1254145).
548 - Backslash-escaped colons inside of field names are now allowed.
549 - Targets (implicit and explicit), anonymous hyperlink references
550 and auto-numbered footnote references inside of substitution
551 definitions are now disallowed.
552 - Fixed bug: list items with blank first lines.
553 - Fixed bug: block quote attributions with indented second lines.
554 - Added East Asian double-width character support (Python 2.4 only).
556 * docutils/parsers/rst/tableparser.py:
558 - Added East Asian double-width character support (Python 2.4 only).
560 * docutils/parsers/rst/directives/body.py:
562 - Added the "container" directive.
564 * docutils/parsers/rst/directives/misc.py:
566 - Added the "default-role", "title", and "date" directives.
567 - Added standard data file syntax to the "include" directive.
568 - Added support for "class" directive content.
570 * docutils/parsers/rst/directives/images.py:
572 - Added ``indirect_reference_name`` support for images with a target
574 - Added support for image width and height units.
575 - Fixed bug with image "target" options.
577 * docutils/parsers/rst/directives/references.py:
579 - Added "class" attribute to "target-notes" directive, for
580 footnote_reference classes.
582 * docutils/parsers/rst/include/: Directory added to project; contains
583 standard data files for the "include" directive. Initial contents:
584 character entity substitution definition sets, and a set of
585 definitions for S5/HTML presentations.
587 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
588 mappings by David Goodger.
590 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
591 Simplified Chinese mappings by Panjunyong.
593 * docutils/readers/__init__.py:
595 - Added universal.Decorations and universal.ExposeInternals
596 transforms as default transforms for all readers.
597 - Added ``ReReader`` base class for readers that reread an existing
600 * docutils/readers/doctree.py: Added to project; a reader for existing
603 * docutils/transforms/frontmatter.py:
605 - Fixed the DocInfo transform to handle SVN-style expansion of the
607 - In ``DocInfo.extract_authors``, treat the contents of "authors"
610 * docutils/transforms/misc.py:
612 - Added misc.Transitions transform, extracted from
613 universal.FinalChecks.
615 * docutils/transforms/references.py:
617 - Added references.DanglingReferences transform, extracted from
618 universal.FinalChecks.
619 - Fixed bug with doubly-indirect substitutions.
620 - Added footnote_reference classes attribute to "TargetNotes".
621 - Fixed bug with circular substitution definitions that put Docutils
622 into an infinite loop.
624 * docutils/transforms/universal.py:
626 - Added universal.ExposeInternals transform, extracted from
627 universal.FinalChecks.
628 - Removed universal.FinalChecks transform (logic has been moved to
629 several new transforms).
630 - Fixed bug with the "expose_internals" setting and Text nodes
631 (exposed by the "rawsource" internal attribute).
632 - Added the universal.StripComments transform, implementation of the
633 "strip_comments" setting.
635 * docutils/transforms/writer_aux.py: Added to project; auxiliary
636 transforms for writers.
638 - Added ``Compound`` transform, which flattens compound paragraphs.
640 * docutils/writers/: Several writer modules (html4css1.py) were
641 converted into packages. Support modules and data files have been
642 moved into the packages. The stylesheets for the HTML writers are
643 now installed along with the code, the code knows where to find
644 them, and the default is to use them (actually, to embed them).
645 Some adjustments to configuration files may be necessary. The
646 easiest way to obtain the new default behavior is to remove all
647 settings whose name includes "stylesheet".
649 * docutils/writers/__init__.py:
651 - Added universal.Messages and universal.FilterMessages transforms
652 as default transforms for all writers.
653 - Added ``UnfilteredWriter`` base class for writers that pass the
654 document tree on unchanged.
656 * docutils/writers/docutils_xml.py:
658 - Made ``xmlcharrefreplace`` the default output encoding error
661 * docutils/writers/html4css1/:
663 - Added support for image width and height units.
664 - Made ``xmlcharrefreplace`` the default output encoding error
666 - Made ``--embed-stylesheet`` the default rather than
667 ``--link-stylesheet``.
668 - Moved "id" attribute from container (section etc.) to title's <a>
669 tag, to be on the same tag as "name".
670 (!!! To be reverted in Docutils 0.5.)
671 - Added vertical space between fields of field lists.
672 - Added ``--compact-field-lists`` option to remove vertical space in
674 - Made cloaking of email addresses with ``--cloak-email-addresses``
676 - Fixed support for centered images.
677 - Added support for class="compact" & class="open" lists.
679 * docutils/writers/latex2e/:
681 - Underscores in citekeys are no longer escaped.
683 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
684 mapping of Unicode characters to LaTeX equivalents.
686 * docutils/writers/s5_html/: Package added to project; writer for
689 * docs/dev/distributing.txt: Added to project; guide for distributors
690 (package maintainers).
692 * docs/dev/hacking.txt: Added to project; guide for developers.
694 * docs/ref/doctree.txt:
696 - Updated for plural attributes "classes", "ids", "names",
698 - Added the "container" element.
700 * docs/ref/docutils.dtd:
702 - Updated for plural attributes "classes", "ids", "names",
705 * docs/user/emacs.txt: Added to project; a document about Emacs
706 support for reStructuredText and Docutils.
708 * docs/user/links.txt: Added to project; lists of Docutils-related
711 * docs/user/mailing-lists.txt: Added to project; information about
712 Docutils-related mailing lists and how to access them.
714 * docs/user/slide-shows.txt: Added to project; example of and docs for
715 the S5/HTML writer (``rst2s5.py`` front end).
717 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
718 Files", added to project.
720 * test/coverage.sh: Added to project; test coverage script.
722 * test/DocutilsTestSupport.py:
724 - Added support for specifying runtime settings at the suite level.
726 * test/test_functional.py:
728 - Added the ``clear_output_directory`` function.
729 - Added support for ``_test_more`` functions in functional test
732 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
734 * tools/rstpep2html.py: Renamed from pep.py.
736 * tools/dev/create_unimap.py: Added to project; script to create the
737 docutils/writers/unimap_latex.py mapping file.
739 * tools/dev/profile_docutils.py: Added to project; profiler script.
741 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
743 * tools/editors/emacs/restructuredtext.el,
744 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
745 Removed from project; the functionality is now contained in rst.el.
747 * tools/editors/emacs/rst.el: Added to project. Added many features
748 and fixed many bugs. See docs/user/emacs.txt for details.
750 * tools/stylesheets: Removed from project. Stylesheets have been
751 renamed and moved into writer packages.
754 Release 0.3.9 (2005-05-26)
755 ==========================
759 - Eliminated and replaced all uses of the old string attributes
760 ``id``, ``name``, ``dupname`` and ``class`` with references to the
761 new list attributes ``ids``, ``names``, ``dupnames`` and
762 ``classes`` throughout the whole source tree.
766 - Enabled ``--dump-*`` options when ``--traceback`` specified,
767 allowing for easier debugging.
768 - In ``Publisher.publish()``, expanded the generic top-level
771 * docutils/examples.py:
773 - Added ``internals`` function for exploration.
777 - Fixed ``Input.decode`` method to apply heuristics only if no
778 encoding is explicitly given, and to provide better reporting of
780 - The ``Input.decode`` method now removes byte order marks (BOMs)
785 - ``image`` element class changed to subclass of Element, not
786 TextElement (it's an empty element, and cannot contain text).
787 - Added ``attr_defaults`` dictionary for default attribute values.
788 - Added empty list as default value for the following attributes:
789 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
790 - Added ``document.decoration`` attribute,
791 ``document.get_decoration`` method, and ``decoration.get_header``
792 & ``.get_footer`` methods.
793 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
798 - Removed ``docutils.utils.Reporter.categories``,
799 ``docutils.utils.ConditionSet``, and all references to them, to
800 simplify error reporting.
802 * docutils/languages/nl.py: Added to project; Dutch mappings by
805 * docutils/parsers/rst/__init__.py:
807 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
809 * docutils/parsers/rst/states.py:
811 - Added check for escaped at-mark to prevent email address recognition.
812 - Fixed option lists to allow spaces inside ``<angle-bracketed option
814 - Allowed whitespace in paths and URLs.
815 - Added auto-enumerated list items.
816 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
818 - Added support for table stub columns.
820 * docutils/parsers/rst/directives/__init__.py:
822 - Allowed whitespace in paths (``path`` function).
823 - Added ``uri`` directive option conversion function.
825 * docutils/parsers/rst/directives/body.py:
827 - Fixed illegal context bug with "topic" directive (allowed within
828 sidebars; not within body elements).
830 * docutils/parsers/rst/directives/images.py:
832 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
833 - Added support for the ``file_insertion_enabled`` setting in the
834 "figure" directive (disables "figwidth" option).
835 - "image" directive: added checks for valid values of "align" option,
836 depending on context. "figure" directive: added specialized
837 "align" option and attribute on "figure" element.
838 - Made ":figwidth: image" option of "figure" directive work again.
839 - Fixed bug with reference names containing uppercase letters
840 (e.g. ``Name_``) in "target" option of "image" directive.
842 * docutils/parsers/rst/directives/misc.py:
844 - Fixed "include" and "raw" directives to catch text decoding
846 - Allowed whitespace in "include" & "raw" directive paths.
847 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
848 settings in "include" & "raw" directives.
850 * docutils/parsers/rst/directives/parts.py:
852 - Added "header" & "footer" directives.
853 - Fixed illegal context bug with "contents" directive (topics
854 allowed within sidebars; not within body elements).
856 * docutils/parsers/rst/directives/tables.py:
858 - Added "list-table" directive.
859 - Caught empty CSV table bug.
860 - Added support for the ``file_insertion_enabled`` setting in the
861 "csv-table" directive.
862 - Added ``stub-columns`` option to "csv-table" and "list-table"
865 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
866 mappings by Martijn Pieters.
868 * docutils/readers/standalone.py:
870 - Added ``--section-subtitles`` and ``--no-section-subtitles``
871 options to activate or deactivate the SectSubTitle transform.
873 * docutils/transforms/frontmatter.py:
875 - Added SectSubTitle transform to promote titles of lone
876 subsections to subtitles.
878 * docutils/transforms/references.py:
880 - Fixed mislocated internal targets bug, by propagating internal
881 targets to the next node, making use of the newly added support
882 for multiple names and IDs.
883 - Fixed duplicate footnote label bug.
884 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
887 * docutils/writers/html4css1.py:
889 - Fixed unencoded stylesheet reference bug (characters like "&" in
890 stylesheet references).
891 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
893 - Added support for multiple IDs per node by creating empty ``span``
895 - Added the ``field_name_limit`` & ``option_limit`` settings &
897 - Added support for table stub columns.
898 - Added support for the ``align`` attribute on ``figure`` elements.
899 - Added the ``cloak_email_addresses`` setting & support.
900 - Added ``html_prolog``, ``html_head``, ``html_body``,
901 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
902 ``docutils.core.publish_parts``.
903 - Added support for section subtitles.
905 * docutils/writers/latex2e.py:
907 - Fixed tables starting with more than one multirow cell.
908 - Improved --use-latex-docinfo so that organization/contact/address
909 fields are lumped with the last author field and appear on the
911 - Made sure the titlepage is always shown with --use-latex-docinfo,
912 even if the document has no title.
913 - Made sure that latex doesn't fill in today's date if no date field
915 - Added support for section subtitles.
917 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
920 * docutils/writers/null.py: Added to project; a do-nothing Writer.
922 * docs/api/publisher.txt:
924 - Added "``publish_parts`` Details" section.
926 * docutils/dev/repository.txt: Added to project; information about the
927 Docutils Subversion repository.
929 * docs/ref/docutils.dtd:
931 - Added a ``stub`` attribute to the ``colspec`` element via the
932 ``tbl.colspec.att`` parameter entity.
933 - Allowed topic elements within sidebars
934 - Added an ``align`` attribute to the ``figure`` element.
936 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
940 Release 0.3.7 (2004-12-24)
941 ==========================
943 * docutils/frontend.py:
945 - Added options: --input-encoding-error-handler,
946 --record-dependencies, --leave-footnote-reference-space,
948 - Added command-line and config file support for "overrides" setting
953 - Added support for input encoding error handler.
957 - Added dispatch_visit and dispatch_departure methods to
958 NodeVisitor; useful as a hook for Visitors.
959 - Changed structure of ``line_block``; added ``line``.
960 - Added ``compound`` node class.
961 - Added a mechanism for Visitors to transitionally ignore new node
966 - Moved ``escape2null`` and ``unescape`` functions from
967 docutils/parsers/rst/states.py.
969 * docutils/parsers/rst/roles.py:
972 - Changed role function API: the "text" parameter now takes
973 null-escaped interpreted text content.
975 * docutils/parsers/rst/states.py:
977 - Fixed bug where a "role" directive in a nested parse would crash
978 the parser; the state machine's "language" attribute was not being
980 - Added support for line block syntax.
981 - Fixed directive parsing bug: argument-less directives didn't
982 notice that arguments were present.
983 - Removed error checking for transitions.
984 - Added support for multiple classifiers in definition list items.
985 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
986 - Changed role function API: the "text" parameter now takes
987 null-escaped interpreted text content.
988 - Empty sections and documents are allowed now.
990 * docutils/parsers/rst/directives/__init__.py:
992 - Added ``encoding`` directive option conversion function.
993 - Allow multiple class names in class_option conversion function.
995 * docutils/parsers/rst/directives/body.py:
997 - Converted the line-block directive to use the new structure.
998 - Extracted the old line-block functionality to the ``block``
999 function (still used).
1000 - Added ``compound`` directive (thanks to Lea Wiemann).
1002 * docutils/parsers/rst/directives/misc.py:
1004 - Added "encoding" option to "include" and "raw" directives.
1005 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1006 - Allow multiple class names in the "class" directive.
1008 * docutils/parsers/rst/directives/parts.py:
1010 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1011 options. Thanks to Lele Gaifax.
1013 * docutils/parsers/rst/directives/tables.py:
1015 - Added "encoding" directive to "csv-table" directive.
1016 - Added workaround for lack of Unicode support in csv.py, for
1017 non-ASCII CSV input.
1019 * docutils/transforms/misc.py:
1021 - Fixed bug when multiple "class" directives are applied to a single
1023 - Enabled multiple format names for "raw" directive.
1025 * docutils/transforms/references.py:
1027 - Added support for trimming whitespace from beside substitution
1030 * docutils/transforms/universal.py:
1032 - FinalChecks now checks for illegal transitions and moves
1033 transitions between sections.
1035 * docutils/writers/html4css1.py:
1037 - HTMLTranslator.encode now converts U+00A0 to " ".
1038 - "stylesheet" and "stylesheet_path" settings are now mutually
1040 - Added support for the new line_block/line structure.
1041 - --footnote-references now overrides
1042 --trim-footnote-reference-space, if applicable.
1043 - Added support for ``compound`` elements.
1044 - Enabled multiple format names for "raw" directive.
1045 - ``<p>`` tags of a paragraph which is the only visible child of the
1046 document node are no longer stripped.
1047 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1048 new method ``should_be_compact_paragraph()``.
1049 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1051 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1052 the output if they have their ``class`` attribute set.
1053 - The whole document is now surrounded by a ``<div
1054 class="document">`` element.
1055 - Body-level images are now wrapped by their own ``<div>`` elements,
1056 with image classes copied to the wrapper, and for images which
1057 have the ``:align:`` option set, the surrounding ``<div>`` now
1058 receives a class attribute (like ``class="align-left"``).
1060 * docutils/writers/latex2e.py:
1062 - no newline after depart_term.
1063 - Added translations for some Unicode quotes.
1064 - Added option "font-encoding", made package AE the default.
1065 - "stylesheet" and "stylesheet_path" settings are now mutually
1067 - --footnote-references now overrides
1068 --trim-footnote-reference-space, if applicable.
1069 - The footnote label style now matches the footnote reference style
1070 ("brackets" or "superscript").
1071 - Added support for ``compound`` elements.
1072 - Enabled multiple format names for "raw" directive.
1074 * docs/ref/docutils.dtd:
1076 - Changed structure of the ``line_block`` element; added ``line``.
1077 - Added ``compound`` element.
1078 - Added "ltrim" and "rtrim" attributes to
1079 ``substitution_definition`` element.
1080 - Enabled multiple format names for ``raw`` element.
1081 - Enabled multiple classifiers in ``definition_list_item`` elements.
1083 * docs/ref/rst/directives.txt
1085 - Marked "line-block" as deprecated.
1086 - "Class" directive now allows multiple class names.
1087 - Added "Rationale for Class Attribute Value Conversion".
1088 - Added warning about "raw" overuse/abuse.
1090 * docs/ref/rst/restructuredtext.txt:
1092 - Added syntax for line blocks.
1093 - Definition list items may have multiple classifiers.
1095 * docs/ref/rst/roles.txt:
1099 * tools/stylesheets/default.css:
1101 - Added support for the new line_block structure.
1102 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1105 Release 0.3.5 (2004-07-29)
1106 ==========================
1110 * _`Documentation cleanup/reorganization`.
1112 - Created new subdirectories of docs/:
1114 * ``docs/user/``: introductory/tutorial material for end-users
1115 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1116 * ``docs/api/``: API reference material for client-developers
1117 * ``docs/ref/``: reference material for all groups
1118 * ``docs/howto/``: for component-developers and core-developers
1119 * ``docs/peps/``: Python Enhancement Proposals
1121 - Moved ``docs/*`` to ``docs/user/``.
1122 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1123 ``spec/`` to ``docs/dev``.
1124 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1125 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1126 - Moved ``alternatives.txt``, and ``problems.txt`` from
1127 ``spec/rst/`` to ``docs/dev/rst/``.
1128 - Moved ``reStructuredText.txt``, ``directives.txt``,
1129 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1130 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1131 ``roles.txt``, ``reStructuredText.txt`` to
1132 ``restructuredtext.txt``.
1133 - Moved ``spec/howto/`` to ``docs/howto``.
1135 In order to keep the CVS history of moved files, we supplied
1136 SourceForge with a `script for modifying the Docutils CVS
1139 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1141 After running the cleanup script:
1143 - Added ``docs/index.txt``.
1144 - Added a ``.htaccess`` file to the ``web`` module, containing
1145 redirects for all old paths to new paths. They'll preserve
1146 fragments (the "#name" part of a URL), and won't clutter up the
1147 file system, and will correct the URL in the user's browser.
1148 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1149 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1150 the "To Do" list itself in ``docs/dev/todo.txt``.
1151 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1152 section of ``docs/dev/todo.txt``.
1153 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1154 - Added "How To Report Bugs" to ``BUGS.txt``.
1155 - Went through all the sources and docs (including under web/) and
1156 updated links. Mostly done by Lea Wiemann; thanks Lea!
1157 (Still need to update links in the sandboxes.)
1161 * BUGS.txt: Added to project.
1163 * THANKS.txt: Added to project.
1165 * docutils/__init__.py:
1167 - 0.3.4: Post-release.
1171 - Added special error handling & advice for UnicodeEncodeError.
1172 - Refactored Publisher.publish (simplified exception handling &
1173 extracted debug dumps).
1174 - Renamed "enable_exit" parameter of convenience functions to
1175 "enable_exit_status".
1176 - Enabled traceback (exception propagation) by default in
1177 programmatic convenience functions.
1178 - Now publish_file and publish_cmdline convenience functions return
1179 the encoded string results in addition to their regular I/O.
1180 - Extracted common code from publish_file, publish_string, and
1181 publish_parts, into new publish_programmatically. Extracted
1182 settings code to ``Publisher.process_programmatic_settings``.
1183 - In Publisher.publish, disabled ``settings_overrides`` when
1184 ``settings`` is supplied; redundant.
1186 * docutils/frontend.py:
1188 - Added help text for "--output-encoding-error-handler" and
1189 "--error-encoding-error-handler".
1190 - Renamed "--exit" to "--exit-status".
1191 - Simplified default-setting code.
1193 * docutils/parsers/rst/__init__.py:
1195 - Added "--pep-base-url" and "--rfc-base-url" options.
1197 * docutils/parsers/rst/states.py:
1199 - Made URI recognition more aggressive and intelligent.
1201 * docutils/parsers/rst/directives/__init__.py:
1203 - Added several directive option conversion functions.
1205 * docutils/parsers/rst/directives/body.py:
1207 - Moved "table" directive to tables.py.
1209 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1212 * docutils/writers/latex2e.py:
1214 - Added "--table-style=(standard|booktabs|nolines)"
1215 - figures get "here" option (LaTeX per default puts them at bottom),
1216 and figure content is centered.
1217 - Rowspan support for tables.
1218 - Fix: admonition titles before first section.
1219 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1220 - Replave ``_`` in literal by an underlined blank, because it has the correct
1222 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1223 - A few unicode replacements, if output_encoding != utf
1224 - Add "--graphicx-option".
1225 - Indent literal-blocks.
1226 - Fix: omit ``\maketitle`` when there is no document title.
1228 * docs/index.txt: "Docutils Project Documentation Overview", added to
1231 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1232 Tool", added to project.
1234 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1236 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1238 * docs/dev/policies.txt: Added to project (extracted from
1239 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1241 * docs/dev/release.txt: Added to project (extracted from
1242 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1244 * docs/dev/testing.txt: Added to project.
1246 * docs/dev/website.txt: Added to project (extracted from
1247 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1249 * docs/ref/rst/directives.txt:
1251 - Added directives: "table", "csv-table".
1253 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1254 added to project. 1 page for syntax, and a 1 page reference for
1255 directives and roles. Source text to be used as-is; not meant to be
1258 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1259 with a change of title.
1261 * test/functional/, contents, and test/test_functional.py: Added to
1264 * tools/buildhtml.py: Fixed bug with config file handling.
1266 * tools/html.py: Removed from project (duplicate of rst2html.py).
1268 * tools/pep2html.py: Removed from project (duplicate of Python's
1269 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1270 Docutils-related PEPs in docs/peps/).
1272 * tools/rst2pseudoxml.py: Renamed from publish.py.
1274 * tools/rst2xml.py: Renamed from docutils-xml.py.
1276 * tools/test.txt: Removed from project; moved to
1277 docs/user/rst/demo.txt.
1279 * setup.py: Now also installs ``rst2latex.py``.
1282 Release 0.3.3 (2004-05-09)
1283 ==========================
1285 * docutils/__init__.py:
1287 - 0.3.1: Reorganized config file format (multiple sections); see
1289 - Added unknown_reference_resolvers attribute to TransformSpec.
1290 - 0.3.2: Interpreted text reorganization.
1295 - Catch system messages to stop tracebacks from parsing errors.
1296 - Catch exceptions during processing report & exit without
1297 tracebacks, except when "--traceback" used.
1298 - Reordered components for OptionParser; application comes last.
1299 - Added "config_section" parameter to several methods and functions,
1300 allowing front ends to easily specify their config file sections.
1301 - Added publish_parts convenience function to allow access to individual
1302 parts of a document.
1304 * docutils/examples.py: Added to project; practical examples of
1305 Docutils client code, to be used as-is or as models for variations.
1307 * docutils/frontend.py:
1309 - Added "--traceback" & "--no-traceback" options ("traceback"
1311 - Implemented support for config file reorganization:
1312 ``standard_config_files`` moved from ``ConfigParser`` to
1313 ``OptionParser``; added
1314 ``OptionParser.get_config_file_settings()`` and
1315 ``.get_standard_config_settings()``; support for old "[options]"
1316 section (with deprecation warning) and mapping from old to new
1318 - Reimplemented setting validation.
1319 - Enabled flexible boolean values: yes/no, true/false, on/off.
1320 - Added ``Values``, a subclass of ``optparse.Values``, with support
1321 for list setting attributes.
1322 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1323 thanks to Beni Cherniavsky.
1324 - Added "--no-section-numbering" option.
1328 - Catch IOErrors when opening source & destination files, report &
1329 exit without tracebacks. Added ``handle_io_errors`` parameter to
1330 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1332 * docutils/nodes.py:
1334 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1335 method definitions (via ``exec``) to dynamic assignments (via
1336 ``setattr``); thanks to Roman Suzi.
1337 - Encapsulated visitor dynamic assignments in a function; thanks to
1339 - Added indirect_reference_name attribute to the Targetable
1340 class. This attribute holds the whitespace_normalized_name
1341 (contains mixed case) of a target.
1343 * docutils/statemachine.py:
1345 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1346 - Added ``StringList.get_2D_block``.
1348 * docutils/utils.py:
1350 - Added "level" attribute to SystemMessage exceptions.
1352 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1355 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1358 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1359 Marcelo Huerta San Martin.
1361 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1362 mappings by Lalo Martins.
1364 * docutils/languages/ru.py: Added to project; Russian mappings by
1367 * docutils/parsers/rst/roles.py: Added to project. Contains
1368 interpreted text role functions, a registry for interpreted text
1369 roles, and an API for adding to and retrieving from the registry.
1370 Contributed by Edward Loper.
1372 * docutils/parsers/rst/states.py:
1374 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1375 - Allowed true em-dash character and "---" as block quote
1377 - Added support for <angle-bracketed> complex option arguments
1379 - Fixed handling of backslashes in substitution definitions.
1380 - Fixed off-by-1 error with extra whitespace after substitution
1381 definition directive.
1382 - Added inline markup parsing to field lists' field names.
1383 - Added support for quoted (and unindented) literal blocks.
1384 Driven in part by a bribe from Frank Siebenlist (thanks!).
1385 - Parser now handles escapes in URIs correctly.
1386 - Made embedded-URIs' reference text omittable. Idea from Beni
1388 - Refactored explicit target processing code.
1389 - Added name attribute to references containing the reference name only
1390 through whitespace_normalize_name (no case changes).
1391 - parse_target no longer returns the refname after going through
1392 normalize_name. This is now handled in make_target.
1393 - Fixed bug relating to role-less interpreted text in non-English
1395 - Reorganized interpreted text processing; moved code into the new
1396 roles.py module. Contributed by Edward Loper.
1397 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1398 ``parse_directive_block``.
1400 * docutils/parsers/rst/tableparser.py:
1402 - Reworked for ``StringList``, to support "include" directives in
1405 * docutils/parsers/rst/directives/__init__.py:
1407 - Renamed ``unchanged()`` directive option conversion function to
1408 ``unchanged_required``, and added a new ``unchanged``.
1409 - Catch unicode value too high error; fixes bug 781766.
1410 - Beefed up directive error reporting.
1412 * docutils/parsers/rst/directives/body.py:
1414 - Added basic "table" directive.
1416 * docutils/parsers/rst/directives/images.py:
1418 - Added "target" option to "image" directive.
1419 - Added name attribute to references containing the reference name only
1420 through whitespace_normalize_name (no case changes).
1422 * docutils/parsers/rst/directives/misc.py:
1424 - Isolated the import of the ``urllib2`` module; was causing
1425 problems on SourceForge (``libssl.so.2`` unavailable?).
1426 - Added the "role" directive for declaring custom interpreted text
1429 * docutils/parsers/rst/directives/parts.py:
1431 - The "contents" directive does more work up-front, creating the
1432 "topic" and "title", and leaving the "pending" node for the
1433 transform. Allows earlier reference resolution; fixes subtle bug.
1435 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1436 mappings by Jannie Hofmeyr.
1438 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1439 mappings by Marek Blaha.
1441 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1442 mappings by Marcelo Huerta San Martin.
1444 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1445 Portuguese mappings by Lalo Martins.
1447 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1448 mappings by Roman Suzi.
1450 * docutils/transforms/parts.py:
1452 - The "contents" directive does more work up-front, creating the
1453 "topic" and "title", and leaving the "pending" node for the
1454 transform. Allows earlier reference resolution; fixes subtle bug.
1455 - Added support for disabling of section numbering.
1457 * docutils/transforms/references.py:
1459 - Verifying that external targets are truly targets and not indirect
1460 references. This is because we are now adding a "name" attribute to
1461 references in addition to targets. Note sure if this is correct!
1462 - Added code to hook into the unknown_reference_resolvers list for a
1463 transformer in resolve_indirect_target. This allows the
1464 unknown_reference_resolvers to keep around indirect targets which
1465 docutils doesn't know about.
1466 - Added specific error message for duplicate targets.
1468 * docutils/transforms/universal.py:
1470 - Added FilterMessages transform (removes system messages below the
1471 verbosity threshold).
1472 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1473 to FinalCheckVisitor for application-specific handling of
1474 unresolvable references.
1475 - Added specific error message for duplicate targets.
1477 * docutils/writers/__init__.py:
1479 - Added assemble_parts method to the Writer class to allow for
1480 access to a documents individual parts.
1481 - Documented & set default for ``Writer.output`` attribute.
1483 * docutils/writers/html4css1.py:
1485 - Fixed unicode handling of attribute values (bug 760673).
1486 - Prevent duplication of "class" attribute values (bug report from
1488 - Improved table grid/border handling (prompted by report from Bob
1490 - Added support for table titles.
1491 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1493 - Added functionality to keep track of individual parts of a document
1494 and store them in a dictionary as the "parts" attribute of the writer.
1495 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1496 - Added proper support for the "scale" attribute of the "image"
1497 element. Contributed by Brent Cook.
1498 - Added ``--initial-header-level`` option.
1499 - Fixed bug: the body_pre_docinfo segment depended on there being a
1500 docinfo; if no docinfo, the document title was incorporated into
1501 the body segment. Adversely affected the publish_parts interface.
1503 * docutils/writers/latex2e.py:
1505 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1506 about a missing file.
1507 - Added options and support: ``--compound-enumerators``,
1508 ``--section-prefix-for-enumerators``, and
1509 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1511 - Added option ``--use-verbatim-when-possible``, to avoid
1512 problematic characters (eg, '~' in italian) in literal blocks.
1513 - It's now possible to use four section levels in the `book` and
1514 `report` LaTeX classes. The default `article` class still has
1517 * docs/config.txt: "Docutils Configuration Files", added to project.
1518 Moved config file entry descriptions from tools.txt.
1522 - Moved config file entry descriptions to config.txt.
1524 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1527 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1528 Text Roles", added to project.
1530 * spec/rst/reStructuredText.txt:
1532 - Added description of support for <angle-bracketed> complex option
1533 arguments to option lists.
1534 - Added subsections for indented and quoted literal blocks.
1536 * test: Continually adding & updating tests.
1538 - Added test/test_settings.py & test/data/config_*.txt support
1540 - Added test/test_writers/test_htmlfragment.py.
1542 * test/DocutilsTestSupport.py:
1544 - Refactored LaTeX publisher test suite/case class names to make
1545 testing other writers easier.
1546 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1547 to test the processing of HTML fragments which use the new
1548 publish_parts convenience function.
1550 * tools/buildhtml.py:
1552 - Added support for the "--prune" option.
1553 - Removed dependency on pep2html.py; plaintext PEPs no longer
1556 * tools/docutils.conf:
1558 - Updated for configuration file reorganization.
1560 * tools/rst2html.py:
1562 - copied from tools/html.py
1566 - added a 'scripts' section to configuration
1567 - added 'tools/rst2html.py' to the scripts section
1570 Release 0.3 (2003-06-24)
1571 ========================
1575 * Renamed "attribute" to "option" for directives/extensions.
1577 * Renamed transform method "transform" to "apply".
1579 * Renamed "options" to "settings" for runtime settings (as set by
1580 command-line options). Sometimes "option" (singular) became
1581 "settings" (plural). Some variations below:
1583 - document.options -> document.settings (stored in other objects as
1585 - option_spec -> settings_spec (not directives though)
1586 - OptionSpec -> SettingsSpec
1587 - cmdline_options -> settings_spec
1588 - relative_path_options -> relative_path_settings
1589 - option_default_overrides -> settings_default_overrides
1590 - Publisher.set_options -> Publisher.get_settings
1594 * COPYING.txt: Added "Public Domain Dedication".
1596 * FAQ.txt: Frequently asked questions, added to project.
1600 - Updated with PyPI Trove classifiers.
1601 - Conditional installation of third-party modules.
1603 * docutils/__init__.py:
1605 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1606 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1607 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1608 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1609 option and its effect on the PEP template & writer.
1610 - Bumped version to 0.2.4 due to changes to the PEP template &
1612 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1613 - Added ``TransformSpec`` class for new transform system.
1614 - Bumped version to 0.2.6 for API changes (renaming).
1615 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1616 convenience functions.
1617 - Added ``Component.component_type`` attribute.
1618 - Bumped version to 0.2.8 because of the internal parser switch from
1619 plain lists to the docutils.statemachine.StringList objects.
1620 - Bumped version to 0.2.9 because of the frontend.py API changes.
1621 - Bumped version to 0.2.10 due to changes to the project layout
1622 (third-party modules removed from the "docutils" package), and
1623 signature changes in ``io.Input``/``io.Output``.
1624 - Changed version to 0.3.0 for release.
1628 - Made ``publish()`` a bit more convenient.
1629 - Generalized ``Publisher.set_io``.
1630 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1631 parameters; improved its docstring.
1632 - Added ``publish_file()`` and ``publish_string()``.
1633 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1635 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1636 "--dump-transforms" hidden options.
1637 - Added ``Publisher.apply_transforms()`` method.
1638 - Added ``Publisher.set_components()`` method; support for
1639 ``publish_*()`` conveninece functions.
1640 - Moved config file processing to docutils/frontend.py.
1641 - Added support for exit status ("exit_level" setting &
1642 ``enable_exit`` parameter for Publisher.publish() and convenience
1645 * docutils/frontend.py:
1647 - Check for & exit on identical source & destination paths.
1648 - Fixed bug with absolute paths & "--config".
1649 - Set non-command-line defaults in ``OptionParser.__init__()``:
1650 ``_source`` & ``_destination``.
1651 - Distributed ``relative_path_settings`` to components; updated
1652 ``OptionParser.populate_from_components()`` to combine it all.
1653 - Require list of keys in ``make_paths_absolute`` (was implicit in
1654 global ``relative_path_settings``).
1655 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1656 "--dump-settings", and "--dump-transforms" hidden options.
1657 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1658 code, replaced with correct code.
1659 - Added validation functionality for config files.
1660 - Added "--error-encoding" option/setting, "_disable_config"
1662 - Added encoding validation; updated "--input-encoding" and
1663 "--output-encoding"; added "--error-encoding-error-handler" and
1664 "--output-encoding-error-handler".
1665 - Moved config file processing from docutils/core.py.
1666 - Updated ``OptionParser.populate_from_components`` to handle new
1667 ``SettingsSpec.settings_defaults`` dict.
1668 - Added support for "-" => stdin/stdout.
1669 - Added "exit_level" setting ("--exit" option).
1673 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1674 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1675 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1676 - ``FileOutput.write()`` now returns the encoded output string.
1677 - Try to get path/stream name automatically in ``FileInput`` &
1679 - Added defaults for source & destination paths.
1680 - Allow for Unicode I/O with an explicit "unicode" encoding.
1681 - Added ``Output.encode()``.
1682 - Removed dependency on runtime settings; pass encoding directly.
1683 - Recognize Unicode strings in ``Input.decode()``.
1684 - Added support for output encoding error handlers.
1686 * docutils/nodes.py:
1688 - Added "Invisible" element category class.
1689 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1690 modification during a traversal.
1691 - Added element classes: ``line_block``, ``generated``, ``address``,
1692 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1693 ``superscript``, ``subscript``, ``inline``
1694 - Added support for lists of nodes to ``Element.insert()``.
1695 - Fixed parent linking in ``Element.replace()``.
1696 - Added new abstract superclass ``FixedTextElement``; adds
1697 "xml:space" attribute.
1698 - Added support for "line" attribute of ``system_message`` nodes.
1699 - Added support for the observer pattern from ``utils.Reporter``.
1700 Added ``parse_messages`` and ``transform_messages`` attributes to
1701 ``document``, removed ``messages``. Added ``note_parse_message``
1702 and ``note_transform_message`` methods.
1703 - Added support for improved diagnostics:
1705 - Added "document", "source", and "line" internal attributes to
1706 ``Node``, set by ``Node.setup_child()``.
1707 - Converted variations on ``node.parent = self`` to
1708 ``self.setup_child(node)``.
1709 - Added ``document.current_source`` & ``.current_line``
1710 attributes, and ``.note_source`` observer method.
1711 - Changed "system_message" output to GNU-Tools format.
1713 - Added a "rawsource" attribute to the ``Text`` class, for text
1714 before backslash-escape resolution.
1715 - Support for new transform system.
1716 - Reworked ``pending`` element.
1717 - Fixed XML DOM bug (SF #660611).
1718 - Removed the ``interpeted`` element class and added
1719 ``title_reference``, ``abbreviation``, ``acronym``.
1720 - Made substitutions case-sensitive-but-forgiving; moved some code
1722 - Fixed Unicode bug on element attributes (report: William Dode).
1724 * docutils/optik.py: Removed from project; replaced with
1725 extras/optparse.py and extras/textwrap.py. These will be installed
1726 only if they're not already present in the Python installation.
1728 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1729 only if it's not already present in the Python installation.
1731 * docutils/statemachine.py:
1733 - Factored out ``State.add_initial_transitions()`` so it can be
1735 - Converted whitespace-specific "blank" and "indent" transitions
1736 from special-case code to ordinary transitions: removed
1737 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1738 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1739 ``ws_initial_transitions`` attributes.
1740 - Removed ``State.match_transition()`` after merging it into
1742 - Added ``StateCorrection`` exception.
1743 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1744 (moved ``TransitionCorrection`` support there too.)
1745 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1746 ``EOFError`` instead of ``IndexError``.
1747 - Added ``State.no_match`` method.
1748 - Added support for the Observer pattern, triggered by input line
1750 - Added ``strip_top`` parameter to
1751 ``StateMachineWS.get_first_known_indented``.
1752 - Made ``context`` a parameter to ``StateMachine.run()``.
1753 - Added ``ViewList`` & ``StringList`` classes;
1754 ``extract_indented()`` becomes ``StringList.get_indented()``.
1755 - Added ``StateMachine.insert_input()``.
1756 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1757 thanks to) Fred Drake.
1759 * docutils/utils.py:
1761 - Added a ``source`` attribute to Reporter instances and
1762 ``system_message`` elements.
1763 - Added an observer pattern to ``utils.Reporter`` to keep track of
1765 - Fixed bugs in ``relative_path()``.
1766 - Added support for improved diagnostics.
1767 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1768 - Added support for encoding Reporter stderr output, and encoding
1770 - Reporter keeps track of the highest level system message yet
1773 * docutils/languages: Fixed bibliographic field language lookups.
1775 * docutils/languages/es.py: Added to project; Spanish mappings by
1776 Marcelo Huerta San Martin.
1778 * docutils/languages/fr.py: Added to project; French mappings by
1781 * docutils/languages/it.py: Added to project; Italian mappings by
1784 * docutils/languages/sk.py: Added to project; Slovak mappings by
1787 * docutils/parser/__init__.py:
1789 - Added ``Parser.finish_parse()`` method.
1791 * docutils/parser/rst/__init__.py:
1793 - Added options: "--pep-references", "--rfc-references",
1794 "--tab-width", "--trim-footnote-reference-space".
1796 * docutils/parsers/rst/states.py:
1798 - Changed "title under/overline too short" system messages from INFO
1799 to WARNING, and fixed its insertion location.
1800 - Fixed enumerated list item parsing to allow paragraphs & section
1801 titles to begin with enumerators.
1802 - Converted system messages to use the new "line" attribute.
1803 - Fixed a substitution reference edge case.
1804 - Added support for "--pep-references" and "--rfc-references"
1805 options; reworked ``Inliner`` code to make customization easier.
1806 - Removed field argument parsing.
1807 - Added support for short section title over/underlines.
1808 - Fixed "simple reference name" regexp to ignore text like
1809 "object.__method__"; not an anonymous reference.
1810 - Added support for improved diagnostics.
1811 - Reworked directive API, based on Dethe Elza's contribution. Added
1812 ``Body.parse_directive()``, ``.parse_directive_options()``,
1813 ``.parse_directive_arguments()`` methods.
1814 - Added ``ExtensionOptions`` class, to parse directive options
1815 without parsing field bodies. Factored
1816 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1817 ``ExtensionOptions``.
1818 - Improved definition list term/classifier parsing.
1819 - Added warnings for unknown directives.
1820 - Renamed ``Stuff`` to ``Struct``.
1821 - Now flagged as errors: transitions at the beginning or end of
1822 sections, empty sections (except title), and empty documents.
1823 - Updated for ``statemachine.StringList``.
1824 - Enabled recognition of schemeless email addresses in targets.
1825 - Added support for embedded URIs in hyperlink references.
1826 - Added backslash-escapes to inline markup end-string suffix.
1827 - Added support for correct interpreted text processing.
1828 - Fixed nested title parsing (topic, sidebar directives).
1829 - Added special processing of backslash-escaped whitespace (idea
1830 from David Abrahams).
1831 - Made substitutions case-sensitive-but-forgiving; moved some code
1832 to ``docutils.nodes``.
1833 - Added support for block quote attributions.
1834 - Added a kludge to work-around a conflict between the bubble-up
1835 parser strategy and short titles (<= 3 char-long over- &
1836 underlines). Fixes SF bug #738803 "infinite loop with multiple
1837 titles" submitted by Jason Diamond.
1838 - Added explicit interpreted text roles for standard inline markup:
1839 "emphasis", "strong", "literal".
1840 - Implemented "superscript" and "subscript" interpreted text roles.
1841 - Added initial support for "abbreviation" and "acronym" roles;
1843 - Added support for "--trim-footnote-reference-space" option.
1844 - Optional space before colons in directives & hyperlink targets.
1846 * docutils/parsers/rst/tableparser.py:
1848 - Fixed a bug that was producing unwanted empty rows in "simple"
1850 - Detect bad column spans in "simple" tables.
1852 * docutils/parsers/rst/directives: Updated all directive functions to
1855 * docutils/parsers/rst/directives/__init__.py:
1857 - Added ``flag()``, ``unchanged()``, ``path()``,
1858 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1859 directive option helper functions.
1860 - Added warnings for unknown directives.
1861 - Return ``None`` for missing directives.
1862 - Added ``register_directive()``, thanks to William Dode and Paul
1865 * docutils/parsers/rst/directives/admonitions.py:
1867 - Added "admonition" directive.
1869 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1870 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1871 "parsed-literal", "rubric", "epigraph", "highlights" and
1872 "pull-quote" directives.
1874 * docutils/parsers/rst/directives/images.py:
1876 - Added an "align" attribute to the "image" & "figure" directives
1877 (by Adam Chodorowski).
1878 - Added "class" option to "image", and "figclass" to "figure".
1880 * docutils/parsers/rst/directives/misc.py:
1882 - Added "include", "raw", and "replace" directives, courtesy of
1884 - Added "unicode" and "class" directives.
1886 * docutils/parsers/rst/directives/parts.py:
1888 - Added the "sectnum" directive; by Dmitry Jemerov.
1889 - Added "class" option to "contents" directive.
1891 * docutils/parsers/rst/directives/references.py: Added to project.
1892 Contains the "target-notes" directive.
1894 * docutils/parsers/rst/languages/__init__.py:
1896 - Return ``None`` from get_language() for missing language modules.
1898 * docutils/parsers/rst/languages/de.py: Added to project; German
1899 mappings by Engelbert Gruber.
1901 * docutils/parsers/rst/languages/en.py:
1903 - Added interpreted text roles mapping.
1905 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1906 mappings by Marcelo Huerta San Martin.
1908 * docutils/parsers/rst/languages/fr.py: Added to project; French
1909 mappings by William Dode.
1911 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1912 mappings by Nicola Larosa.
1914 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1915 mappings by Miroslav Vasko.
1917 * docutils/readers/__init__.py:
1919 - Added support for the observer pattern from ``utils.Reporter``, in
1920 ``Reader.parse`` and ``Reader.transform``.
1921 - Removed ``Reader.transform()`` method.
1922 - Added default parameter values to ``Reader.__init__()`` to make
1923 instantiation easier.
1924 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1926 * docutils/readers/pep.py:
1928 - Added the ``peps.TargetNotes`` transform to the Reader.
1929 - Removed PEP & RFC reference detection code; moved to
1930 parsers/rst/states.py as options (enabled here by default).
1931 - Added support for pre-acceptance PEPs (no PEP number yet).
1932 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1935 * docutils/readers/python: Python Source Reader subpackage added to
1936 project, including preliminary versions of:
1939 - moduleparser.py: Parser for Python modules.
1941 * docutils/transforms/__init__.py:
1943 - Added ``Transformer`` class and completed transform reform.
1944 - Added unknown_reference_resolvers list for each transformer. This list holds
1945 the list of functions provided by each component of the transformer that
1946 help resolve references.
1948 * docutils/transforms/frontmatter.py:
1950 - Improved support for generic fields.
1951 - Fixed bibliographic field language lookups.
1953 * docutils/transforms/misc.py: Added to project. Miscellaneous
1956 * docutils/transforms/parts.py:
1958 - Moved the "id" attribute from TOC list items to the references
1959 (``Contents.build_contents()``).
1960 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1961 - Added "class" attribute support to ``Contents``.
1963 * docutils/transforms/peps.py:
1965 - Added ``mask_email()`` function, updating to pep2html.py's
1967 - Linked "Content-Type: text/x-rst" to PEP 12.
1968 - Added the ``TargetNotes`` PEP-specific transform.
1969 - Added ``TargetNotes.cleanup_callback``.
1970 - Added title check to ``Headers``.
1972 * docutils/transforms/references.py:
1974 - Added the ``TargetNotes`` generic transform.
1975 - Split ``Hyperlinks`` into multiple transforms.
1976 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1977 - Added check for circular indirect references.
1978 - Made substitutions case-sensitive-but-forgiving.
1980 * docutils/transforms/universal.py:
1982 - Added support for the "--expose-internal-attributes" option.
1983 - Removed ``Pending`` transform classes & data.
1985 * docutils/writers/__init__.py:
1987 - Removed ``Writer.transform()`` method.
1989 * docutils/writers/docutils-xml.py:
1991 - Added XML and doctype declarations.
1992 - Added "--no-doctype" and "--no-xml-declaration" options.
1994 * docutils/writers/html4css1.py:
1996 - "name" attributes only on these tags: a, applet, form, frame,
1998 - Added "name" attribute to <a> in section titles for Netscape 4
1999 support (bug report: Pearu Peterson).
2000 - Fixed targets (names) on footnote, citation, topic title,
2001 problematic, and system_message nodes (for Netscape 4).
2002 - Changed field names from "<td>" to "<th>".
2003 - Added "@" to "@" encoding to thwart address harvesters.
2004 - Improved the vertical whitespace optimization; ignore "invisible"
2005 nodes (targets, comments, etc.).
2006 - Improved inline literals with ``<span class="pre">`` around chunks
2007 of text and `` `` for runs of spaces.
2008 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2009 ``self.docinfo`` segments.
2010 - Added support for "line_block", "address" elements.
2011 - Improved backlinks (footnotes & system_messages).
2012 - Improved system_message output.
2013 - Redefined "--stylesheet" as containing an invariant URL, used
2014 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2016 - Added "--footnote-references" option (superscript or brackets).
2017 - Added "--compact-lists" and "--no-compact-lists" options.
2018 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2019 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2020 - Improved field list rendering.
2021 - Added Docutils version to "generator" meta tag.
2022 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2023 - Improved layout of <pre> HTML source.
2024 - Fixed attribute typo on <colspec>.
2025 - Refined XML prologue.
2026 - Support for no stylesheet.
2027 - Removed "interpreted" element support.
2028 - Added support for "title_reference", "sidebar", "attribution",
2029 "rubric", and generic "admonition" elements.
2030 - Added "--attribution" option.
2031 - Added support for "inline", "subscript", "superscript" elements.
2032 - Added initial support for "abbreviation" and "acronym";
2035 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2039 - Double quotes in literal blocks (special treatment for de/ngerman).
2040 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2041 - Added "--attribution" option.
2042 - Right align attributions.
2044 * docutils/writers/pep_html.py:
2046 - Parameterized output encoding in PEP template.
2047 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2048 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2049 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2051 - Added an override on the "--footnote-references" option.
2052 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2053 - Added Docutils version to "generator" meta tag.
2054 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2058 - Added a "silent" setting for ``buildhtml.py``.
2059 - Added a "Getting Help" section.
2060 - Rearranged the structure.
2061 - Kept up to date, with new settings, command-line options etc.
2062 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2063 - Converted settings table into a definition list.
2065 * docs/rst/quickstart.txt:
2067 - Added a table of contents.
2068 - Added feedback information.
2069 - Added mention of minimum section title underline lengths.
2070 - Removed the 4-character minimum for section title underlines.
2072 * docs/rst/quickref.html:
2074 - Added a "Getting Help" section.
2075 - Added a style to make section title backlinks more subtle.
2076 - Added mention of minimum section title underline lengths.
2077 - Removed the 4-character minimum for section title underlines.
2079 * extras: Directory added to project; contains third-party modules
2080 that Docutils depends on (optparse, textwrap, roman). These are
2081 only installed if they're not already present.
2083 * licenses: Directory added to project; contains copies of license
2084 files for non-public-domain files.
2088 - Changed the focus. It's about DTD elements: structural
2089 relationships, semantics, and external (public) attributes. Not
2090 about the element class library.
2091 - Moved some implementation-specific stuff into ``docutils.nodes``
2093 - Wrote descriptions of all common attributes and parameter
2094 entities. Filled in introductory material.
2095 - Working through the element descriptions: 55 down, 37 to go.
2096 - Removed "Representation of Horizontal Rules" to
2097 spec/rst/alternatives.txt.
2099 * spec/docutils.dtd:
2101 - Added "generated" inline element.
2102 - Added "line_block" body element.
2103 - Added "auto" attribute to "title".
2104 - Changed content models of "literal_block" and "doctest_block" to
2106 - Added ``%number;`` attribute type parameter entity.
2107 - Changed ``%structural.elements;`` to ``%section.elements``.
2108 - Updated attribute types; made more specific.
2109 - Added "address" bibliographic element.
2110 - Added "line" attribute to ``system_message`` element.
2111 - Removed "field_argument" element; "field_name" may contain
2112 multiple words and whitespace.
2113 - Changed public identifier to docutils.sf.net.
2114 - Removed "interpreted" element; added "title_reference",
2115 "abbreviation", "acronym".
2116 - Removed "refuri" attribute from "footnote_reference" and
2117 "citation_reference".
2118 - Added "sidebar", "rubric", "attribution", "admonition",
2119 "superscript", "subscript", and "inline" elements.
2121 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2123 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2125 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2127 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2130 * spec/transforms.txt: Added to project.
2132 * spec/howto: Added subdirectory, for developer how-to docs.
2134 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2135 Elza, edited & extended by David Goodger.
2137 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2140 * spec/rst/alternatives.txt:
2142 - Added "Doctree Representation of Transitions" from
2144 - Updated "Inline External Targets" & closed the debate.
2145 - Added ideas for interpreted text syntax extensions.
2146 - Added "Nested Inline Markup" section.
2148 * spec/rst/directives.txt:
2150 - Added directives: "topic", "sectnum", "target-notes",
2151 "line-block", "parsed-literal", "include", "replace", "sidebar",
2152 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2154 - Formalized descriptions of directive details.
2155 - Added an "align" attribute to the "image" & "figure" directives
2156 (by Adam Chodorowski).
2157 - Added "class" options to "topic", "sidebar", "line-block",
2158 "parsed-literal", "contents", and "image"; and "figclass" to
2161 * spec/rst/interpreted.txt: Added to project. Descriptions of
2162 interpreted text roles.
2164 * spec/rst/introduction.txt:
2166 - Added pointers to material for new users.
2168 * spec/rst/reStructuredText.txt:
2170 - Disambiguated comments (just add a newline after the "::").
2171 - Updated enumerated list description; added a discussion of the
2172 second-line validity checking.
2173 - Updated directive description.
2174 - Added a note redirecting newbies to the user docs.
2175 - Expanded description of inline markup start-strings in non-markup
2177 - Removed field arguments and made field lists a generic construct.
2178 - Removed the 4-character minimum for section title underlines.
2179 - Clarified term/classifier delimiter & inline markup ambiguity
2181 - Added "Embedded URIs".
2182 - Updated "Interpreted Text" section.
2183 - Added "Character-Level Inline Markup" section.
2185 * test: Continually adding & updating tests.
2187 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2188 - Moved test/test_pep/ to test/test_readers/test_pep/.
2189 - Added test/test_readers/test_python/.
2190 - Added test/test_writers/ (Engelbert Gruber).
2194 - Made the ``locale.setlocale()`` calls in front ends
2197 * tools/buildhtml.py:
2199 - Added "--silent" option.
2200 - Fixed bug with absolute paths & "--config".
2201 - Updated for new I/O classes.
2202 - Added some exception handling.
2203 - Separated publishers' setting defaults; prevents interference.
2204 - Updated for new ``publish_file()`` convenience function.
2206 * tools/pep-html-template:
2208 - Allow for "--embed-stylesheet".
2209 - Added Docutils version to "generator" meta tag.
2210 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2211 - Conform to XHTML spec.
2213 * tools/pep2html.py:
2215 - Made ``argv`` a parameter to ``main()``.
2216 - Added support for "Content-Type:" header & arbitrary PEP formats.
2217 - Linked "Content-Type: text/plain" to PEP 9.
2218 - Files skipped (due to an error) are not pushed onto the server.
2219 - Updated for new I/O classes.
2220 - Added ``check_requirements()`` & ``pep_type_error()``.
2221 - Added some exception handling.
2222 - Updated for new ``publish_string()`` convenience function.
2223 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2225 * tools/quicktest.py:
2227 - Added "-V"/"--version" option.
2229 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2231 * tools/unicode2rstsubs.py: Added to project. Produces character
2232 entity files (reSructuredText substitutions) from the MathML master
2235 * tools/editors: Support code for editors, added to project. Contains
2236 ``emacs/restructuredtext.el``.
2238 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2240 - Added style for chunks of inline literals.
2241 - Removed margin for first child of table cells.
2242 - Right-aligned field list names.
2243 - Support for auto-numbered section titles in TOCs.
2244 - Increased the size of inline literals (<tt>) in titles.
2245 - Restored the light gray background for inline literals.
2246 - Added support for "line_block" elements.
2247 - Added style for "address" elements.
2248 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2249 - Improved field list rendering.
2250 - Vertical whitespace improvements.
2251 - Removed "a.target" style.
2253 * tools/stylesheets/pep.css:
2255 - Fixed nested section margins.
2256 - Other changes parallel those of ``../default.css``.
2259 Release 0.2 (2002-07-31)
2260 ========================
2264 - The word "component" was being used ambiguously. From now on,
2265 "component" will be used to mean "Docutils component", as in Reader,
2266 Writer, Parser, or Transform. Portions of documents (Table of
2267 Contents, sections, etc.) will be called "document parts".
2268 - Did a grand renaming: a lot of ``verylongnames`` became
2269 ``very_long_names``.
2270 - Cleaned up imports: no more relative package imports or
2271 comma-separated lists of top-level modules.
2272 - Added support for an option values object which carries default
2273 settings and overrides (from command-line options and library use).
2274 - Added internal Unicode support, and support for both input and
2276 - Added support for the ``docutils.io.IO`` class & subclasses.
2280 * docutils/__init__.py:
2282 - Added ``ApplicationError`` and ``DataError``, for use throughout
2284 - Added ``Component`` base class for Docutils components; implements
2285 the ``supports`` method.
2286 - Added ``__version__`` (thus, ``docutils.__version__``).
2290 - Removed many keyword parameters to ``Publisher.__init__()`` and
2291 ``publish()``; bundled into an option values object. Added
2292 "argv", "usage", "description", and "option_spec" parameters for
2293 command-line support.
2294 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2296 - Reworked I/O model for ``docutils.io`` wrappers.
2297 - Updated ``Publisher.set_options()``; now returns option values
2299 - Added support for configuration files (/etc/docutils.conf,
2300 ./docutils.conf, ~/.docutils).
2301 - Added ``Publisher.setup_option_parser()``.
2302 - Added default usage message and description.
2304 * docutils/frontend.py: Added to project; support for front-end
2305 (command-line) scripts. Option specifications may be augmented by
2306 components. Requires Optik (http://optik.sf.net/) for option
2307 processing (installed locally as docutils/optik.py).
2309 * docutils/io.py: Added to project; uniform API for a variety of input
2312 * docutils/nodes.py:
2314 - Added ``TreeCopyVisitor`` class.
2315 - Added a ``copy`` method to ``Node`` and subclasses.
2316 - Added a ``SkipDeparture`` exception for visitors.
2317 - Renamed ``TreePruningException`` from ``VisitorException``.
2318 - Added docstrings to ``TreePruningException``, subclasses, and
2320 - Improved docstrings.
2321 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2322 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2324 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2325 ``PreDecorative`` mixin.
2326 - Reworked the name/id bookkeeping; to ``document``, removed
2327 ``explicit_targets`` and ``implicit_targets`` attributes, added
2328 ``nametypes`` attribute and ``set_name_id_map`` method.
2329 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2331 - Added ``document.has_name()`` method.
2332 - Fixed DOM generation for list-attributes.
2333 - Added category class ``Labeled`` (used by footnotes & citations).
2334 - Added ``Element.set_class()`` method (sets "class" attribute).
2336 * docutils/optik.py: Added to project. Combined from the Optik
2337 package, with added option groups and other modifications. The use
2338 of this module is probably only temporary.
2340 * docutils/statemachine.py:
2342 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2343 - Added underscores to improve many awkward names.
2344 - In ``string2lines()``, changed whitespace normalizing translation
2345 table to regexp; restores Python 2.0 compatibility with Unicode.
2347 * docutils/urischemes.py:
2349 - Filled in some descriptions.
2350 - Added "shttp" scheme.
2352 * docutils/utils.py:
2354 - Added ``clean_rcs_keywords`` function (moved from
2355 docutils/transforms/frontmatter.py
2356 ``DocInfo.filter_rcs_keywords``).
2357 - Added underscores to improve many awkward names.
2358 - Changed names of Reporter's thresholds:
2359 warning_level -> report_level; error_level -> halt_level.
2360 - Moved ``utils.id()`` to ``nodes.make_id()``.
2361 - Added ``relative_path(source, target)``.
2363 * docutils/languages/de.py: German mappings; added to project. Thanks
2364 to Gunnar Schwant for the translations.
2366 * docutils/languages/en.py: Added "Dedication" bibliographic field
2369 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2372 * docutils/parsers/rst/states.py:
2374 - Added underscores to improve many awkward names.
2375 - Added RFC-2822 header support.
2376 - Extracted the inline parsing code from ``RSTState`` to a separate
2377 class, ``Inliner``, which will allow easy subclassing.
2378 - Made local bindings for ``memo`` container & often-used contents
2379 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2380 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2381 - Added ``MarkupMismatch`` exception; for late corrections.
2382 - Added ``-/:`` characters to inline markup's start string prefix,
2383 ``/`` to end string suffix.
2384 - Fixed a footnote bug.
2385 - Fixed a bug with literal blocks.
2386 - Applied patch from Simon Budig: simplified regexps with symbolic
2387 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2388 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2389 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2390 - Allowed non-ASCII in "simple names" (directive names, field names,
2392 - Converted ``Inliner.patterns.initial`` to be dynamically built
2393 from parts with ``build_regexp()`` function.
2394 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2395 - Updated docstrings.
2396 - Changed "table" to "grid_table"; added "simple_table" support.
2398 * docutils/parsers/rst/tableparser.py:
2400 - Changed ``TableParser`` to ``GridTableParser``.
2401 - Added ``SimpleTableParser``.
2402 - Refactored naming.
2404 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2405 a fallback language for directive names.
2407 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2408 directive to use a ``pending`` element, used only by HTML writers.
2410 * docutils/parsers/rst/directives/parts.py: Renamed from
2413 - Added "backlinks" attribute to "contents" directive.
2415 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2416 project by Adam Chodorowski.
2418 * docutils/readers/__init__.py: Gave Readers more control over
2419 choosing and instantiating Parsers.
2421 * docutils/readers/pep.py: Added to project; for PEP processing.
2423 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2424 requires a ``component`` parameter.
2426 * docutils/transforms/components.py: Added to project; transforms
2427 related to Docutils components.
2429 * docutils/transforms/frontmatter.py:
2431 - In ``DocInfo.extract_authors``, check for a single "author" in an
2432 "authors" group, and convert it to a single "author" element.
2433 - Added support for "Dedication" and generic bibliographic fields.
2435 * docutils/transforms/peps.py: Added to project; PEP-specific.
2437 * docutils/transforms/parts.py: Renamed from old components.py.
2439 - Added filter for `Contents`, to use alt-text for inline images,
2440 and to remove inline markup that doesn't make sense in the ToC.
2441 - Added "name" attribute to TOC topic depending on its title.
2442 - Added support for optional TOC backlinks.
2444 * docutils/transforms/references.py: Fixed indirect target resolution
2445 in ``Hyperlinks`` transform.
2447 * docutils/transforms/universal.py:
2449 - Changed ``Messages`` transform to properly filter out system
2450 messages below the warning threshold.
2451 - Added ``Decorations`` transform (support for ``--generator``,
2452 ``--date``, ``--time``, ``--source-link`` options).
2454 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2455 Engelbert Gruber's PDF writer.
2457 * docutils/writers/html4css1.py:
2459 - Made XHTML-compatible (switched to lowercase element & attribute
2460 names; empty tag format).
2461 - Escape double-dashes in comment text.
2462 - Improved boilerplate & modularity of output.
2463 - Exposed modular output in Writer class.
2464 - Added a "generator" meta tag to <head>.
2465 - Added support for the ``--stylesheet`` option.
2466 - Added support for ``decoration``, ``header``, and ``footer``
2468 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2469 translation table to regexp; restores Python 2.0 compatibility
2471 - Added the translator class as instance variable to the Writer, to
2472 make it easily subclassable.
2473 - Improved option list spacing (thanks to Richard Jones).
2474 - Modified field list output.
2475 - Added backlinks to footnotes & citations.
2476 - Added percentage widths to "<col>" tags (from colspec).
2477 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2478 "<span>" changed to "<var>".
2479 - Inline literals: "<code>" changed to "<tt>".
2480 - Many changes to optimize vertical space: compact simple lists etc.
2481 - Add a command-line options & directive attributes to control TOC
2482 and footnote/citation backlinks.
2483 - Added support for optional footnote/citation backlinks.
2484 - Added support for generic bibliographic fields.
2485 - Identify backrefs.
2486 - Relative URLs for stylesheet links.
2488 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2489 PEPs (subclass of ``html4css1.Writer``).
2491 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2493 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2494 of the Docutils internal doctree in XML.
2496 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2500 - Changed the title to "The Docutils Document Tree".
2501 - Added "Hyperlink Bookkeeping" section.
2503 * spec/docutils.dtd:
2505 - Added ``decoration``, ``header``, and ``footer`` elements.
2506 - Brought ``interpreted`` element in line with the parser: changed
2507 attribute "type" to "role", added "position".
2508 - Added support for generic bibliographic fields.
2510 * spec/notes.txt: Continual updates. Added "Project Policies".
2512 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2515 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2517 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2518 mailing list discussions.
2520 * spec/pep-0287.txt:
2522 - Renamed to "reStructuredText Docstring Format".
2524 - Reworked Q&A as an enumerated list.
2525 - Converted to reStructuredText format.
2527 * spec/pysource.dtd:
2529 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2531 * spec/pysource.txt: Removed from project. Moved much of its contents
2534 * spec/rst/alternatives.txt:
2536 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2537 - Added "Inline External Targets" section.
2539 * spec/rst/directives.txt:
2541 - Added "backlinks" attribute to "contents" directive.
2543 * spec/rst/problems.txt:
2545 - Updated the Enumerated List Markup discussion.
2546 - Added new alternative table markup syntaxes.
2548 * spec/rst/reStructuredText.txt:
2550 - Clarified field list usage.
2551 - Updated enumerated list description.
2552 - Clarified purpose of directives.
2553 - Added ``-/:`` characters to inline markup's start string prefix,
2554 ``/`` to end string suffix.
2555 - Updated "Authors" bibliographic field behavior.
2556 - Changed "inline hyperlink targets" to "inline internal targets".
2557 - Added "simple table" syntax to supplement the existing but
2558 newly-renamed "grid tables".
2559 - Added cautions for anonymous hyperlink use.
2560 - Added "Dedication" and generic bibliographic fields.
2562 * test: Made test modules standalone (subdirectories became packages).
2564 * test/DocutilsTestSupport.py:
2566 - Added support for PEP extensions to reStructuredText.
2567 - Added support for simple tables.
2568 - Refactored naming.
2570 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2572 - Now supports true packages containing test modules
2573 (``__init__.py`` files required); fixes duplicate module name bug.
2575 * test/test_pep/: Subpackage added to project; PEP testing.
2577 * test/test_rst/test_SimpleTableParser.py: Added to project.
2581 - Updated html.py and publish.py front-end tools to use the new
2582 command-line processing facilities of ``docutils.frontend``
2583 (exposed in ``docutils.core.Publisher``), reducing each to just a
2585 - Added ``locale.setlocale()`` calls to front-end tools.
2587 * tools/buildhtml.py: Added to project; batch-generates .html from all
2588 the .txt files in directories and subdirectories.
2590 * tools/default.css:
2592 - Added support for ``header`` and ``footer`` elements.
2593 - Added styles for "Dedication" topics (biblio fields).
2595 * tools/docutils.conf: A configuration file; added to project.
2597 * tools/docutils-xml.py: Added to project.
2599 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2601 * tools/pep-html-template: Added to project.
2603 * tools/pep2html.py: Added to project from Python (nondist/peps).
2604 Added support for Docutils (reStructuredText PEPs).
2606 * tools/quicktest.py:
2608 - Added the ``--attributes`` option, hacked a bit.
2609 - Added a second command-line argument (output file); cleaned up.
2611 * tools/stylesheets/: Subdirectory added to project.
2613 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2616 Release 0.1 (2002-04-20)
2617 ========================
2619 This is the first release of Docutils, merged from the now inactive
2620 reStructuredText__ and `Docstring Processing System`__ projects. For
2621 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2622 `DPS HISTORY`__ files.
2624 __ http://structuredtext.sourceforge.net/
2625 __ http://docstring.sourceforge.net/
2626 __ http://structuredtext.sourceforge.net/HISTORY.html
2627 __ http://docstring.sourceforge.net/HISTORY.html
2629 General changes: renamed 'dps' package to 'docutils'; renamed
2630 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2631 the test suites (reStructuredText's test/test_states renamed to
2632 test/test_rst); and all modifications required to make it all work.
2634 * docutils/parsers/rst/states.py:
2636 - Improved diagnostic system messages for missing blank lines.
2637 - Fixed substitution_reference bug.
2643 indent-tabs-mode: nil
2644 sentence-end-double-space: t