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 - (partially) Fix reporting for problems in included files.
26 - FileInput opens files as text files with universal newline support
27 (mode "rU", configurable with the new optional argument "mode").
31 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
35 - Fix [ 2923723 ] let decode_path() tolerate path == None
37 * docutils/writers/html4css1/__init__.py
39 - Support SVG and SWF images (thanks to Stefan Rank).
41 * docutils/writers/latex2e/__init__.py
43 - Use `transforms.writer_aux.Admonitions` to "normalize" special
45 - Use the ``\url`` command for URLs (breaks long URLs instead of
46 writing into the margin).
47 - Preserve runs of spaces in `inline literals`__.
48 - Deprecate ``figure_footnotes`` setting.
49 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
50 - New ``latex_preamble`` setting.
51 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
52 - Fix hyperlink targets (labels) for images, figures, and tables.
53 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
54 - Apply [ 2961991 ] Call hyperref with unicode option.
56 __ docs/ref/restructuredtext.html#inline-literals
57 __ docs/user/config.html#docutils-footnotes
59 * docutils/writers/manpage.py
61 - Fix: supported attribute (thanks to peter2108).
62 - Remove trailing blanks in code (keep in sync with mercurial version).
63 - Titles level 1, that is ``.SH``, always uppercase.
64 - Apply patch from mg: literal text should be bold in man-pages.
68 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
73 - Python 3 support: copy test/ and tools/ to the build-dir
74 and convert Python sources with 2to3.
77 Release 0.6 (2009-10-11)
78 ========================
82 - Docutils is now compatible with Python versions from 2.3 up to 2.6
83 and convertible to 3.1 code.
85 + Node.__nonzero__ returns True instead of 1.
86 + use os.walk instead os.path.walk.
87 + minimize "types" module where possible.
88 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
89 + Text nodes now subclass unicode rather than UserString
90 (which is gone in python 3.0).
91 + 3.0 compatibility module docutils._compat
93 + Drop 2.2 compatibility workarounds.
94 + Drop extras/optparse.py and extras/textwrap.py
95 (stdlib modules since 2.3).
97 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
98 - Unix man page export: manpage writer moved from sandbox to Doctutils
101 - Apply [ 1719345 ] Galician translation
102 - Apply [ 1905741 ] Polish translation
103 - Apply [ 1878977 ] make_id(): deaccent characters.
104 - Apply [ 2029251 ] return nonzero when tests fail.
105 - Fix [ 1692788 ] allow UTF-8 in style sheets.
106 - Fix [ 2781629 ] support non-ASCII chars in file names.
107 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
108 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
109 - Fix [ 2821266 ] --strict option works now like --halt=info.
110 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
111 - Fix [ 1627229 ] hyperlink references in substitutions.
113 - The "newlatex" writer is orphaned.
117 - Documented Unicode characters allowed as inline markup openers,
118 closers, and delimiters.
119 - Allow units for all length specifications.
120 - Allow percent sign in "scale" argument of "figure" and "image" directives.
121 - Bugfix: The "figalign" argument of a figure now works as intended
122 (aligning the figure, not its contents).
123 - Align images with class "align-[right|center|left]"
124 (allows setting the alignment of an image in a figure).
128 - Added ``Element.__contains__`` method, for the in-operator.
130 * docutils/parsers/rst/states.py:
132 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
133 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
134 " " (non-breaking space), and "¡ ¿" openers.
136 * docutils/parsers/directives/misc.py:
138 - Added ``start-line`` and ``end-line`` options to "include"
139 directive to select a range of lines.
140 - Hard tabs in literal inclusions are replaced by spaces. This is
141 configurable via the new ``tab-width`` option of the "include" directive
142 (a negative tab-width prevents tab expansion).
146 - Add ``get_stylesheet_list`` function.
147 - Apply [ 2834836 ] print info at halt
149 * docutils/transforms/universal.py:
151 - Raise default priority of StripClasses to exclude stripped classes from
154 * docutils/writers/html4css1/__init__.py:
156 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
157 separated list of stylesheets.
158 - Address [ 1938891 ] Inline literal text creates "pre" span only when
159 needed to prevent inter-word line wraps.
160 - Use `translate` method instead of repeated `replace` calls.
161 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
162 classes to allow CSS styling that does not interfere with other
163 table-using constructs (field lists, citations, ...).
165 * docutils/writers/newlatex2e/__init__.py:
167 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
169 * docutils/writers/latex2e/__init__.py (see also
170 `<docs/user/docutils-05-compat.sty.html>`__) :
172 - Add ``--embed-stylesheet`` option.
173 - Apply [ 1474017 ] image vertical alignment is reversed.
174 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
175 - Change: has_key for dictionaries (not Nodes) to in-operator.
176 - Merge adjacent citations into one latex cite command.
177 - Failsave implementation of custom roles. LaTeX compilation now ignores
178 unknown classes instead of aborting with an error.
179 - Support custom roles based on standard roles.
180 - LaTeX packages can be used as ``--stylesheet`` arguments without
181 restriction. (A style sheet is now referenced with the ``\usepackage``
182 command, if it ends with ``.sty`` or has no extension.)
183 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
184 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
185 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
186 2005-02-04 as a configurable length unit).
187 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
188 if font-encoding is set to ''. LaTeX defaults to OT1 then.
189 - Set sub- and superscript role argument in text mode not as math.
190 Use a custom role based on sub-/superscript if you want italic shape.
191 - Shorter preamble and less dependencies: Load packages and define macros
192 only if required in the document.
193 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
194 - New custom environments and commands with optional "classes" argument.
195 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
196 - Better conformance to Docutils specifications with ``--use-latex-toc``.
197 Support for LaTeX generated ToC also with unnumbered sections.
198 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
199 section numbering by LaTeX.
200 - Use default font in admonitions and sidebar.
201 - Align of image in a figure defaults to 'center'.
202 - Bugfix: Newlines around targets and references prevent run-together
204 - Fix internal hyperlinks.
205 - Use class defaults for page margins ('typearea' now optional).
206 - Float placement made configurable, default changed to "here definitely".
207 - Typeset generic topic as "quote block with title".
208 - Use template (file and configuration option).
209 - In the default template, load cmap.sty (fix text extraction in PDF) and
210 fixltx2e.sty (LaTeX patches, \textsubscript).
211 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
212 - Use `translate` instead of repeated `replace` calls for text encoding.
213 - Hyperlinked footnotes and support for symbol footnotes and
214 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
215 - Complete pairs of binary options
216 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
217 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
219 - font-encoding: "T1" (formerly implicitely set by 'ae').
220 - use-latex-toc: true (ToC with page numbers).
221 - use-latex-footnotes: true (no mixup with figures).
223 * docutils/writers/manpage.py
225 - Do not print version at document end, this is done by the viewer.
226 - Do not print date at document end, this is done by the viewer.
227 - Fix storage of docinfo fields for none standard fields.
229 * docutils/tools/rst2man.py
231 Release 0.5 (2008-06-25)
232 ========================
234 * docutils/languages/he.py: Added to project: Hebrew mappings by
237 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
238 mappings by Meir Kriheli.
240 * docutils/frontend.py:
242 - Configuration files are now assumed and required to be
244 - Paths of applied configuration files are now recorded in the
245 runtime setting ``_config_files`` (accessible via
246 ``--dump-settings``).
247 - Added ``--strip-elements-with-class`` and ``--strip-class``
248 options (``strip_elements_with_classes`` and ``strip_classes``
253 - Added code to determine the input encoding from data: encoding
254 declarations or the presence of byte order marks (UTF-8 & UTF-16).
255 - Added support for IronPython 1.0.
259 - Added ``document.__getstate__`` method, for pickling.
261 * docutils/parsers/rst/states.py:
263 - Allow ``+`` and ``:`` in reference names.
264 - Unquoted targets beginning with an underscore (``.. __target:
265 URI``) are no longer accepted.
266 - Added support for multiple attributions in a physical block quote
267 (indented text block), dividing it into multiple logical block
269 - Added support for unicode bullets in bullet lists: "•", "‣", and
271 - Added support for new object-oriented directive interface,
272 retaining compatibility to the old functional interface.
273 - Added support for throwing ``DirectiveError``'s from within
276 * docutils/parsers/rst/__init__.py:
278 - Added ``Directive`` base class.
279 - Added ``DirectiveError`` base class.
280 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
283 * docutils/parsers/directives/:
285 - Refactored all reStructuredText directives to use the new
286 object-oriented directive interface. Errors are now (mostly)
287 thrown using the new ``DirectiveError`` class.
289 * docutils/parsers/directives/misc.py:
291 - Added ``start-after`` and ``end-before`` options to ``include``
292 directive; thanks to Stefan Rank.
294 * docutils/transforms/universal.py:
296 - Added ``StripClassesAndElements`` transform to remove from the
297 document tree all elements with classes in
298 ``settings.strip_elements_with_classes`` and all "classes"
299 attribute values in ``self.document.settings.strip_classes``.
301 * docutils/transforms/writer_aux.py:
303 - Added ``Admonitions`` transform to transform specific admonitions
304 (like ``note``, ``warning``, etc.) into generic admonitions with a
307 * docutils/writers/html4css1/__init__.py:
309 - Moved template functionality from the PEP/HTML writer here.
310 - Expanded the fragments available in the ``parts`` attribute.
311 - Moved ``id`` attributes from titles to surrounding ``div``
313 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
314 universally supported now).
315 - ``template.txt`` is now opened in text mode instead of binary mode
316 (to ensure Windows compatibility).
317 - ``a`` elements now have an "internal" or "external" class,
318 depending on reference type.
320 * docutils/writers/html4css1/template.txt: Added to project.
322 * docutils/writers/pep_html/:
324 - Moved template functionality to the HTML writer.
326 * docutils/writers/s5_html/__init__.py:
328 - Added ``view_mode`` & ``hidden_controls`` settings
329 (``--view-mode`` & ``--hidden-controls/--visible-controls``
332 * docutils/writers/latex2e/__init__.py:
334 - Add ``--literal-block-env``
335 - Fix: escaping ``%`` in href urls.
336 - Move usepackage hyperref after stylesheet inclusion.
337 - Fix: scrartcl does not have chapter but scrreprt.
338 - Add newline after ``\end{verbatim}``.
339 - Merge smaller differences from latex2e_adaptive_preamble.
340 - Add ``use-part-section``.
341 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
342 - Using leavemode option_list no longer needs to check if parent
343 is a definition list.
344 - Append ``\leavemode`` to definition list terms.
345 - No longer write visit\_/depart_definition_list_item comments to
347 - Table column width with 3 decimal places.
348 - Add table stubs support (boldfont).
349 - Add assemble_parts to writer.
350 - Add simply support for nested tables.
351 - Fix verbatim in tables if use-verbatim-when-possible.
352 - Use section commands down to subparagraph.
353 - Put ensuremath around some latin1 chars.
354 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
355 - New option ``--use-bibtex=style,db1,db2``.
356 - New option ``--reference-label`` to allow usage of LaTeX ref for
357 labels in section references.
358 - Add a label after every section to support sectionnumbers as reference
360 - Fix: bug# 1605376 rst2latex: bad options group list
361 - Remove inactive code for use_optionlist_for_option_list.
362 - Remove latex comments from option_list output.
363 - Fix: bug# 1612270 double qoutes in italian literal.
364 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
365 - Add option --use-latex-abstract.
366 - Image width unit ``px`` is translated to ``pt``.
367 - Add image height support.
368 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
370 - Fix: Do not escape underscores in citation reference labels if
371 use-latex-citations is set.
372 - Use centering instead of center for figure contents, to avoid vertical
374 - Recognize table class: borderless, nolines, booktabs, standard.
375 - Fix: Renaming contents section does not work with latex writer; SF
377 - Applied patch for custom roles with classes from Edward Loper.
378 - Fixed bug that caused crashes with more than 256 lists.
380 * docutils/writers/pep_html/__init__.py:
382 - Changed to support new python.org website structure and
385 * docs/howto/security.txt: "Deploying Docutils Securely", added to
388 * tools/buildhtml.py:
390 -- Added ``ignore`` setting to exclude a list of shell patterns
391 (default: ``.svn:CVS``).
393 * tools/editors/emacs/rst.el:
395 - Changed license to "GPL".
396 - Added ``rst-straighten-decorations`` function.
397 - The ``compile`` module is now always loaded.
398 - Added ``rst-toggle-line-block`` function.
399 - Headings consisting only of non-ASCII characters are now
400 recognized by ``rst-toc`` and ``rst-adjust``.
401 - Added font-lock support for multi-line comments where the first
402 comment line is empty.
403 - Added ``(require 'font-lock)``.
407 - Provide descriptive error message if distutils is missing.
410 Release 0.4 (2006-01-09)
411 ========================
415 - Updated the project policies for trunk/branch development &
418 * docutils/__init__.py:
420 - Added ``__version_details__`` attribute to describe code source
421 (repository/snapshot/release).
422 - Replaced ``default_transforms`` attribute of TransformSpec with
423 ``get_transforms()`` method.
427 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
428 functions, for document tree extraction and reprocessing.
432 - Added ``DocTreeInput`` class, for reprocessing existing documents.
433 - Added support for non-Unicode (e.g. binary) writer output.
437 - Re-introduced ``Targetable.indirect_reference_name``, for
438 MoinMoin/reST compatibility (removed in r3124/r3129).
439 - Added ``serial_escape`` function; escapes string values that are
440 elements of a list, for serialization. Modified Docutils-XML
441 writing (``Element._dom_node``) and pseudo-XML writing
442 (``Element.starttag``) to use ``serial_escape``.
443 - Added ``Node.deepcopy()`` method.
444 - Removed the internal lists ``document.substitution_refs``,
445 ``document.anonymous_refs``, and ``document.anonymous_targets``.
446 - Added a "container" element.
447 - Fixed bug where values of list-valued attributes of elements
448 originating from custom interpreted text roles (i.e., with custom
449 classes) were being shared between element instances. Reported by
452 * docutils/statemachine.py:
454 - Added trailing whitespace stripping to ``string2lines()``.
455 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
456 Asian double-width character support.
460 - Added ``east_asian_column_width()`` for double-width character
463 * docutils/languages/ja.py: Added to project: Japanese mappings by
466 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
467 mappings by Panjunyong.
469 * docutils/parsers/null.py: Added to project; a do-nothing parser.
471 * docutils/parsers/rst/__init__.py:
473 - Added validator to tab_width setting, with test. Closes SF bug
474 #1212515, report from Wu Wei.
476 * docutils/parsers/rst/states.py:
478 - Fixed bug with escaped colons indicating a literal block.
479 - Fixed bug with enumerated lists (SF#1254145).
480 - Backslash-escaped colons inside of field names are now allowed.
481 - Targets (implicit and explicit), anonymous hyperlink references
482 and auto-numbered footnote references inside of substitution
483 definitions are now disallowed.
484 - Fixed bug: list items with blank first lines.
485 - Fixed bug: block quote attributions with indented second lines.
486 - Added East Asian double-width character support (Python 2.4 only).
488 * docutils/parsers/rst/tableparser.py:
490 - Added East Asian double-width character support (Python 2.4 only).
492 * docutils/parsers/rst/directives/body.py:
494 - Added the "container" directive.
496 * docutils/parsers/rst/directives/misc.py:
498 - Added the "default-role", "title", and "date" directives.
499 - Added standard data file syntax to the "include" directive.
500 - Added support for "class" directive content.
502 * docutils/parsers/rst/directives/images.py:
504 - Added ``indirect_reference_name`` support for images with a target
506 - Added support for image width and height units.
507 - Fixed bug with image "target" options.
509 * docutils/parsers/rst/directives/references.py:
511 - Added "class" attribute to "target-notes" directive, for
512 footnote_reference classes.
514 * docutils/parsers/rst/include/: Directory added to project; contains
515 standard data files for the "include" directive. Initial contents:
516 character entity substitution definition sets, and a set of
517 definitions for S5/HTML presentations.
519 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
520 mappings by David Goodger.
522 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
523 Simplified Chinese mappings by Panjunyong.
525 * docutils/readers/__init__.py:
527 - Added universal.Decorations and universal.ExposeInternals
528 transforms as default transforms for all readers.
529 - Added ``ReReader`` base class for readers that reread an existing
532 * docutils/readers/doctree.py: Added to project; a reader for existing
535 * docutils/transforms/frontmatter.py:
537 - Fixed the DocInfo transform to handle SVN-style expansion of the
539 - In ``DocInfo.extract_authors``, treat the contents of "authors"
542 * docutils/transforms/misc.py:
544 - Added misc.Transitions transform, extracted from
545 universal.FinalChecks.
547 * docutils/transforms/references.py:
549 - Added references.DanglingReferences transform, extracted from
550 universal.FinalChecks.
551 - Fixed bug with doubly-indirect substitutions.
552 - Added footnote_reference classes attribute to "TargetNotes".
553 - Fixed bug with circular substitution definitions that put Docutils
554 into an infinite loop.
556 * docutils/transforms/universal.py:
558 - Added universal.ExposeInternals transform, extracted from
559 universal.FinalChecks.
560 - Removed universal.FinalChecks transform (logic has been moved to
561 several new transforms).
562 - Fixed bug with the "expose_internals" setting and Text nodes
563 (exposed by the "rawsource" internal attribute).
564 - Added the universal.StripComments transform, implementation of the
565 "strip_comments" setting.
567 * docutils/transforms/writer_aux.py: Added to project; auxiliary
568 transforms for writers.
570 - Added ``Compound`` transform, which flattens compound paragraphs.
572 * docutils/writers/: Several writer modules (html4css1.py) were
573 converted into packages. Support modules and data files have been
574 moved into the packages. The stylesheets for the HTML writers are
575 now installed along with the code, the code knows where to find
576 them, and the default is to use them (actually, to embed them).
577 Some adjustments to configuration files may be necessary. The
578 easiest way to obtain the new default behavior is to remove all
579 settings whose name includes "stylesheet".
581 * docutils/writers/__init__.py:
583 - Added universal.Messages and universal.FilterMessages transforms
584 as default transforms for all writers.
585 - Added ``UnfilteredWriter`` base class for writers that pass the
586 document tree on unchanged.
588 * docutils/writers/docutils_xml.py:
590 - Made ``xmlcharrefreplace`` the default output encoding error
593 * docutils/writers/html4css1/:
595 - Added support for image width and height units.
596 - Made ``xmlcharrefreplace`` the default output encoding error
598 - Made ``--embed-stylesheet`` the default rather than
599 ``--link-stylesheet``.
600 - Moved "id" attribute from container (section etc.) to title's <a>
601 tag, to be on the same tag as "name".
602 (!!! To be reverted in Docutils 0.5.)
603 - Added vertical space between fields of field lists.
604 - Added ``--compact-field-lists`` option to remove vertical space in
606 - Made cloaking of email addresses with ``--cloak-email-addresses``
608 - Fixed support for centered images.
609 - Added support for class="compact" & class="open" lists.
611 * docutils/writers/latex2e/:
613 - Underscores in citekeys are no longer escaped.
615 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
616 mapping of Unicode characters to LaTeX equivalents.
618 * docutils/writers/s5_html/: Package added to project; writer for
621 * docs/dev/distributing.txt: Added to project; guide for distributors
622 (package maintainers).
624 * docs/dev/hacking.txt: Added to project; guide for developers.
626 * docs/ref/doctree.txt:
628 - Updated for plural attributes "classes", "ids", "names",
630 - Added the "container" element.
632 * docs/ref/docutils.dtd:
634 - Updated for plural attributes "classes", "ids", "names",
637 * docs/user/emacs.txt: Added to project; a document about Emacs
638 support for reStructuredText and Docutils.
640 * docs/user/links.txt: Added to project; lists of Docutils-related
643 * docs/user/mailing-lists.txt: Added to project; information about
644 Docutils-related mailing lists and how to access them.
646 * docs/user/slide-shows.txt: Added to project; example of and docs for
647 the S5/HTML writer (``rst2s5.py`` front end).
649 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
650 Files", added to project.
652 * test/coverage.sh: Added to project; test coverage script.
654 * test/DocutilsTestSupport.py:
656 - Added support for specifying runtime settings at the suite level.
658 * test/test_functional.py:
660 - Added the ``clear_output_directory`` function.
661 - Added support for ``_test_more`` functions in functional test
664 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
666 * tools/rstpep2html.py: Renamed from pep.py.
668 * tools/dev/create_unimap.py: Added to project; script to create the
669 docutils/writers/unimap_latex.py mapping file.
671 * tools/dev/profile_docutils.py: Added to project; profiler script.
673 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
675 * tools/editors/emacs/restructuredtext.el,
676 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
677 Removed from project; the functionality is now contained in rst.el.
679 * tools/editors/emacs/rst.el: Added to project. Added many features
680 and fixed many bugs. See docs/user/emacs.txt for details.
682 * tools/stylesheets: Removed from project. Stylesheets have been
683 renamed and moved into writer packages.
686 Release 0.3.9 (2005-05-26)
687 ==========================
691 - Eliminated and replaced all uses of the old string attributes
692 ``id``, ``name``, ``dupname`` and ``class`` with references to the
693 new list attributes ``ids``, ``names``, ``dupnames`` and
694 ``classes`` throughout the whole source tree.
698 - Enabled ``--dump-*`` options when ``--traceback`` specified,
699 allowing for easier debugging.
700 - In ``Publisher.publish()``, expanded the generic top-level
703 * docutils/examples.py:
705 - Added ``internals`` function for exploration.
709 - Fixed ``Input.decode`` method to apply heuristics only if no
710 encoding is explicitly given, and to provide better reporting of
712 - The ``Input.decode`` method now removes byte order marks (BOMs)
717 - ``image`` element class changed to subclass of Element, not
718 TextElement (it's an empty element, and cannot contain text).
719 - Added ``attr_defaults`` dictionary for default attribute values.
720 - Added empty list as default value for the following attributes:
721 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
722 - Added ``document.decoration`` attribute,
723 ``document.get_decoration`` method, and ``decoration.get_header``
724 & ``.get_footer`` methods.
725 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
730 - Removed ``docutils.utils.Reporter.categories``,
731 ``docutils.utils.ConditionSet``, and all references to them, to
732 simplify error reporting.
734 * docutils/languages/nl.py: Added to project; Dutch mappings by
737 * docutils/parsers/rst/__init__.py:
739 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
741 * docutils/parsers/rst/states.py:
743 - Added check for escaped at-mark to prevent email address recognition.
744 - Fixed option lists to allow spaces inside ``<angle-bracketed option
746 - Allowed whitespace in paths and URLs.
747 - Added auto-enumerated list items.
748 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
750 - Added support for table stub columns.
752 * docutils/parsers/rst/directives/__init__.py:
754 - Allowed whitespace in paths (``path`` function).
755 - Added ``uri`` directive option conversion function.
757 * docutils/parsers/rst/directives/body.py:
759 - Fixed illegal context bug with "topic" directive (allowed within
760 sidebars; not within body elements).
762 * docutils/parsers/rst/directives/images.py:
764 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
765 - Added support for the ``file_insertion_enabled`` setting in the
766 "figure" directive (disables "figwidth" option).
767 - "image" directive: added checks for valid values of "align" option,
768 depending on context. "figure" directive: added specialized
769 "align" option and attribute on "figure" element.
770 - Made ":figwidth: image" option of "figure" directive work again.
771 - Fixed bug with reference names containing uppercase letters
772 (e.g. ``Name_``) in "target" option of "image" directive.
774 * docutils/parsers/rst/directives/misc.py:
776 - Fixed "include" and "raw" directives to catch text decoding
778 - Allowed whitespace in "include" & "raw" directive paths.
779 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
780 settings in "include" & "raw" directives.
782 * docutils/parsers/rst/directives/parts.py:
784 - Added "header" & "footer" directives.
785 - Fixed illegal context bug with "contents" directive (topics
786 allowed within sidebars; not within body elements).
788 * docutils/parsers/rst/directives/tables.py:
790 - Added "list-table" directive.
791 - Caught empty CSV table bug.
792 - Added support for the ``file_insertion_enabled`` setting in the
793 "csv-table" directive.
794 - Added ``stub-columns`` option to "csv-table" and "list-table"
797 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
798 mappings by Martijn Pieters.
800 * docutils/readers/standalone.py:
802 - Added ``--section-subtitles`` and ``--no-section-subtitles``
803 options to activate or deactivate the SectSubTitle transform.
805 * docutils/transforms/frontmatter.py:
807 - Added SectSubTitle transform to promote titles of lone
808 subsections to subtitles.
810 * docutils/transforms/references.py:
812 - Fixed mislocated internal targets bug, by propagating internal
813 targets to the next node, making use of the newly added support
814 for multiple names and IDs.
815 - Fixed duplicate footnote label bug.
816 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
819 * docutils/writers/html4css1.py:
821 - Fixed unencoded stylesheet reference bug (characters like "&" in
822 stylesheet references).
823 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
825 - Added support for multiple IDs per node by creating empty ``span``
827 - Added the ``field_name_limit`` & ``option_limit`` settings &
829 - Added support for table stub columns.
830 - Added support for the ``align`` attribute on ``figure`` elements.
831 - Added the ``cloak_email_addresses`` setting & support.
832 - Added ``html_prolog``, ``html_head``, ``html_body``,
833 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
834 ``docutils.core.publish_parts``.
835 - Added support for section subtitles.
837 * docutils/writers/latex2e.py:
839 - Fixed tables starting with more than one multirow cell.
840 - Improved --use-latex-docinfo so that organization/contact/address
841 fields are lumped with the last author field and appear on the
843 - Made sure the titlepage is always shown with --use-latex-docinfo,
844 even if the document has no title.
845 - Made sure that latex doesn't fill in today's date if no date field
847 - Added support for section subtitles.
849 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
852 * docutils/writers/null.py: Added to project; a do-nothing Writer.
854 * docs/api/publisher.txt:
856 - Added "``publish_parts`` Details" section.
858 * docutils/dev/repository.txt: Added to project; information about the
859 Docutils Subversion repository.
861 * docs/ref/docutils.dtd:
863 - Added a ``stub`` attribute to the ``colspec`` element via the
864 ``tbl.colspec.att`` parameter entity.
865 - Allowed topic elements within sidebars
866 - Added an ``align`` attribute to the ``figure`` element.
868 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
872 Release 0.3.7 (2004-12-24)
873 ==========================
875 * docutils/frontend.py:
877 - Added options: --input-encoding-error-handler,
878 --record-dependencies, --leave-footnote-reference-space,
880 - Added command-line and config file support for "overrides" setting
885 - Added support for input encoding error handler.
889 - Added dispatch_visit and dispatch_departure methods to
890 NodeVisitor; useful as a hook for Visitors.
891 - Changed structure of ``line_block``; added ``line``.
892 - Added ``compound`` node class.
893 - Added a mechanism for Visitors to transitionally ignore new node
898 - Moved ``escape2null`` and ``unescape`` functions from
899 docutils/parsers/rst/states.py.
901 * docutils/parsers/rst/roles.py:
904 - Changed role function API: the "text" parameter now takes
905 null-escaped interpreted text content.
907 * docutils/parsers/rst/states.py:
909 - Fixed bug where a "role" directive in a nested parse would crash
910 the parser; the state machine's "language" attribute was not being
912 - Added support for line block syntax.
913 - Fixed directive parsing bug: argument-less directives didn't
914 notice that arguments were present.
915 - Removed error checking for transitions.
916 - Added support for multiple classifiers in definition list items.
917 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
918 - Changed role function API: the "text" parameter now takes
919 null-escaped interpreted text content.
920 - Empty sections and documents are allowed now.
922 * docutils/parsers/rst/directives/__init__.py:
924 - Added ``encoding`` directive option conversion function.
925 - Allow multiple class names in class_option conversion function.
927 * docutils/parsers/rst/directives/body.py:
929 - Converted the line-block directive to use the new structure.
930 - Extracted the old line-block functionality to the ``block``
931 function (still used).
932 - Added ``compound`` directive (thanks to Lea Wiemann).
934 * docutils/parsers/rst/directives/misc.py:
936 - Added "encoding" option to "include" and "raw" directives.
937 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
938 - Allow multiple class names in the "class" directive.
940 * docutils/parsers/rst/directives/parts.py:
942 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
943 options. Thanks to Lele Gaifax.
945 * docutils/parsers/rst/directives/tables.py:
947 - Added "encoding" directive to "csv-table" directive.
948 - Added workaround for lack of Unicode support in csv.py, for
951 * docutils/transforms/misc.py:
953 - Fixed bug when multiple "class" directives are applied to a single
955 - Enabled multiple format names for "raw" directive.
957 * docutils/transforms/references.py:
959 - Added support for trimming whitespace from beside substitution
962 * docutils/transforms/universal.py:
964 - FinalChecks now checks for illegal transitions and moves
965 transitions between sections.
967 * docutils/writers/html4css1.py:
969 - HTMLTranslator.encode now converts U+00A0 to " ".
970 - "stylesheet" and "stylesheet_path" settings are now mutually
972 - Added support for the new line_block/line structure.
973 - --footnote-references now overrides
974 --trim-footnote-reference-space, if applicable.
975 - Added support for ``compound`` elements.
976 - Enabled multiple format names for "raw" directive.
977 - ``<p>`` tags of a paragraph which is the only visible child of the
978 document node are no longer stripped.
979 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
980 new method ``should_be_compact_paragraph()``.
981 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
983 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
984 the output if they have their ``class`` attribute set.
985 - The whole document is now surrounded by a ``<div
986 class="document">`` element.
987 - Body-level images are now wrapped by their own ``<div>`` elements,
988 with image classes copied to the wrapper, and for images which
989 have the ``:align:`` option set, the surrounding ``<div>`` now
990 receives a class attribute (like ``class="align-left"``).
992 * docutils/writers/latex2e.py:
994 - no newline after depart_term.
995 - Added translations for some Unicode quotes.
996 - Added option "font-encoding", made package AE the default.
997 - "stylesheet" and "stylesheet_path" settings are now mutually
999 - --footnote-references now overrides
1000 --trim-footnote-reference-space, if applicable.
1001 - The footnote label style now matches the footnote reference style
1002 ("brackets" or "superscript").
1003 - Added support for ``compound`` elements.
1004 - Enabled multiple format names for "raw" directive.
1006 * docs/ref/docutils.dtd:
1008 - Changed structure of the ``line_block`` element; added ``line``.
1009 - Added ``compound`` element.
1010 - Added "ltrim" and "rtrim" attributes to
1011 ``substitution_definition`` element.
1012 - Enabled multiple format names for ``raw`` element.
1013 - Enabled multiple classifiers in ``definition_list_item`` elements.
1015 * docs/ref/rst/directives.txt
1017 - Marked "line-block" as deprecated.
1018 - "Class" directive now allows multiple class names.
1019 - Added "Rationale for Class Attribute Value Conversion".
1020 - Added warning about "raw" overuse/abuse.
1022 * docs/ref/rst/restructuredtext.txt:
1024 - Added syntax for line blocks.
1025 - Definition list items may have multiple classifiers.
1027 * docs/ref/rst/roles.txt:
1031 * tools/stylesheets/default.css:
1033 - Added support for the new line_block structure.
1034 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1037 Release 0.3.5 (2004-07-29)
1038 ==========================
1042 * _`Documentation cleanup/reorganization`.
1044 - Created new subdirectories of docs/:
1046 * ``docs/user/``: introductory/tutorial material for end-users
1047 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1048 * ``docs/api/``: API reference material for client-developers
1049 * ``docs/ref/``: reference material for all groups
1050 * ``docs/howto/``: for component-developers and core-developers
1051 * ``docs/peps/``: Python Enhancement Proposals
1053 - Moved ``docs/*`` to ``docs/user/``.
1054 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1055 ``spec/`` to ``docs/dev``.
1056 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1057 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1058 - Moved ``alternatives.txt``, and ``problems.txt`` from
1059 ``spec/rst/`` to ``docs/dev/rst/``.
1060 - Moved ``reStructuredText.txt``, ``directives.txt``,
1061 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1062 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1063 ``roles.txt``, ``reStructuredText.txt`` to
1064 ``restructuredtext.txt``.
1065 - Moved ``spec/howto/`` to ``docs/howto``.
1067 In order to keep the CVS history of moved files, we supplied
1068 SourceForge with a `script for modifying the Docutils CVS
1071 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1073 After running the cleanup script:
1075 - Added ``docs/index.txt``.
1076 - Added a ``.htaccess`` file to the ``web`` module, containing
1077 redirects for all old paths to new paths. They'll preserve
1078 fragments (the "#name" part of a URL), and won't clutter up the
1079 file system, and will correct the URL in the user's browser.
1080 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1081 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1082 the "To Do" list itself in ``docs/dev/todo.txt``.
1083 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1084 section of ``docs/dev/todo.txt``.
1085 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1086 - Added "How To Report Bugs" to ``BUGS.txt``.
1087 - Went through all the sources and docs (including under web/) and
1088 updated links. Mostly done by Lea Wiemann; thanks Lea!
1089 (Still need to update links in the sandboxes.)
1093 * BUGS.txt: Added to project.
1095 * THANKS.txt: Added to project.
1097 * docutils/__init__.py:
1099 - 0.3.4: Post-release.
1103 - Added special error handling & advice for UnicodeEncodeError.
1104 - Refactored Publisher.publish (simplified exception handling &
1105 extracted debug dumps).
1106 - Renamed "enable_exit" parameter of convenience functions to
1107 "enable_exit_status".
1108 - Enabled traceback (exception propagation) by default in
1109 programmatic convenience functions.
1110 - Now publish_file and publish_cmdline convenience functions return
1111 the encoded string results in addition to their regular I/O.
1112 - Extracted common code from publish_file, publish_string, and
1113 publish_parts, into new publish_programmatically. Extracted
1114 settings code to ``Publisher.process_programmatic_settings``.
1115 - In Publisher.publish, disabled ``settings_overrides`` when
1116 ``settings`` is supplied; redundant.
1118 * docutils/frontend.py:
1120 - Added help text for "--output-encoding-error-handler" and
1121 "--error-encoding-error-handler".
1122 - Renamed "--exit" to "--exit-status".
1123 - Simplified default-setting code.
1125 * docutils/parsers/rst/__init__.py:
1127 - Added "--pep-base-url" and "--rfc-base-url" options.
1129 * docutils/parsers/rst/states.py:
1131 - Made URI recognition more aggressive and intelligent.
1133 * docutils/parsers/rst/directives/__init__.py:
1135 - Added several directive option conversion functions.
1137 * docutils/parsers/rst/directives/body.py:
1139 - Moved "table" directive to tables.py.
1141 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1144 * docutils/writers/latex2e.py:
1146 - Added "--table-style=(standard|booktabs|nolines)"
1147 - figures get "here" option (LaTeX per default puts them at bottom),
1148 and figure content is centered.
1149 - Rowspan support for tables.
1150 - Fix: admonition titles before first section.
1151 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1152 - Replave ``_`` in literal by an underlined blank, because it has the correct
1154 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1155 - A few unicode replacements, if output_encoding != utf
1156 - Add "--graphicx-option".
1157 - Indent literal-blocks.
1158 - Fix: omit ``\maketitle`` when there is no document title.
1160 * docs/index.txt: "Docutils Project Documentation Overview", added to
1163 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1164 Tool", added to project.
1166 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1168 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1170 * docs/dev/policies.txt: Added to project (extracted from
1171 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1173 * docs/dev/release.txt: Added to project (extracted from
1174 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1176 * docs/dev/testing.txt: Added to project.
1178 * docs/dev/website.txt: Added to project (extracted from
1179 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1181 * docs/ref/rst/directives.txt:
1183 - Added directives: "table", "csv-table".
1185 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1186 added to project. 1 page for syntax, and a 1 page reference for
1187 directives and roles. Source text to be used as-is; not meant to be
1190 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1191 with a change of title.
1193 * test/functional/, contents, and test/test_functional.py: Added to
1196 * tools/buildhtml.py: Fixed bug with config file handling.
1198 * tools/html.py: Removed from project (duplicate of rst2html.py).
1200 * tools/pep2html.py: Removed from project (duplicate of Python's
1201 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1202 Docutils-related PEPs in docs/peps/).
1204 * tools/rst2pseudoxml.py: Renamed from publish.py.
1206 * tools/rst2xml.py: Renamed from docutils-xml.py.
1208 * tools/test.txt: Removed from project; moved to
1209 docs/user/rst/demo.txt.
1211 * setup.py: Now also installs ``rst2latex.py``.
1214 Release 0.3.3 (2004-05-09)
1215 ==========================
1217 * docutils/__init__.py:
1219 - 0.3.1: Reorganized config file format (multiple sections); see
1221 - Added unknown_reference_resolvers attribute to TransformSpec.
1222 - 0.3.2: Interpreted text reorganization.
1227 - Catch system messages to stop tracebacks from parsing errors.
1228 - Catch exceptions during processing report & exit without
1229 tracebacks, except when "--traceback" used.
1230 - Reordered components for OptionParser; application comes last.
1231 - Added "config_section" parameter to several methods and functions,
1232 allowing front ends to easily specify their config file sections.
1233 - Added publish_parts convenience function to allow access to individual
1234 parts of a document.
1236 * docutils/examples.py: Added to project; practical examples of
1237 Docutils client code, to be used as-is or as models for variations.
1239 * docutils/frontend.py:
1241 - Added "--traceback" & "--no-traceback" options ("traceback"
1243 - Implemented support for config file reorganization:
1244 ``standard_config_files`` moved from ``ConfigParser`` to
1245 ``OptionParser``; added
1246 ``OptionParser.get_config_file_settings()`` and
1247 ``.get_standard_config_settings()``; support for old "[options]"
1248 section (with deprecation warning) and mapping from old to new
1250 - Reimplemented setting validation.
1251 - Enabled flexible boolean values: yes/no, true/false, on/off.
1252 - Added ``Values``, a subclass of ``optparse.Values``, with support
1253 for list setting attributes.
1254 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1255 thanks to Beni Cherniavsky.
1256 - Added "--no-section-numbering" option.
1260 - Catch IOErrors when opening source & destination files, report &
1261 exit without tracebacks. Added ``handle_io_errors`` parameter to
1262 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1264 * docutils/nodes.py:
1266 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1267 method definitions (via ``exec``) to dynamic assignments (via
1268 ``setattr``); thanks to Roman Suzi.
1269 - Encapsulated visitor dynamic assignments in a function; thanks to
1271 - Added indirect_reference_name attribute to the Targetable
1272 class. This attribute holds the whitespace_normalized_name
1273 (contains mixed case) of a target.
1275 * docutils/statemachine.py:
1277 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1278 - Added ``StringList.get_2D_block``.
1280 * docutils/utils.py:
1282 - Added "level" attribute to SystemMessage exceptions.
1284 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1287 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1290 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1291 Marcelo Huerta San Martin.
1293 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1294 mappings by Lalo Martins.
1296 * docutils/languages/ru.py: Added to project; Russian mappings by
1299 * docutils/parsers/rst/roles.py: Added to project. Contains
1300 interpreted text role functions, a registry for interpreted text
1301 roles, and an API for adding to and retrieving from the registry.
1302 Contributed by Edward Loper.
1304 * docutils/parsers/rst/states.py:
1306 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1307 - Allowed true em-dash character and "---" as block quote
1309 - Added support for <angle-bracketed> complex option arguments
1311 - Fixed handling of backslashes in substitution definitions.
1312 - Fixed off-by-1 error with extra whitespace after substitution
1313 definition directive.
1314 - Added inline markup parsing to field lists' field names.
1315 - Added support for quoted (and unindented) literal blocks.
1316 Driven in part by a bribe from Frank Siebenlist (thanks!).
1317 - Parser now handles escapes in URIs correctly.
1318 - Made embedded-URIs' reference text omittable. Idea from Beni
1320 - Refactored explicit target processing code.
1321 - Added name attribute to references containing the reference name only
1322 through whitespace_normalize_name (no case changes).
1323 - parse_target no longer returns the refname after going through
1324 normalize_name. This is now handled in make_target.
1325 - Fixed bug relating to role-less interpreted text in non-English
1327 - Reorganized interpreted text processing; moved code into the new
1328 roles.py module. Contributed by Edward Loper.
1329 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1330 ``parse_directive_block``.
1332 * docutils/parsers/rst/tableparser.py:
1334 - Reworked for ``StringList``, to support "include" directives in
1337 * docutils/parsers/rst/directives/__init__.py:
1339 - Renamed ``unchanged()`` directive option conversion function to
1340 ``unchanged_required``, and added a new ``unchanged``.
1341 - Catch unicode value too high error; fixes bug 781766.
1342 - Beefed up directive error reporting.
1344 * docutils/parsers/rst/directives/body.py:
1346 - Added basic "table" directive.
1348 * docutils/parsers/rst/directives/images.py:
1350 - Added "target" option to "image" directive.
1351 - Added name attribute to references containing the reference name only
1352 through whitespace_normalize_name (no case changes).
1354 * docutils/parsers/rst/directives/misc.py:
1356 - Isolated the import of the ``urllib2`` module; was causing
1357 problems on SourceForge (``libssl.so.2`` unavailable?).
1358 - Added the "role" directive for declaring custom interpreted text
1361 * docutils/parsers/rst/directives/parts.py:
1363 - The "contents" directive does more work up-front, creating the
1364 "topic" and "title", and leaving the "pending" node for the
1365 transform. Allows earlier reference resolution; fixes subtle bug.
1367 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1368 mappings by Jannie Hofmeyr.
1370 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1371 mappings by Marek Blaha.
1373 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1374 mappings by Marcelo Huerta San Martin.
1376 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1377 Portuguese mappings by Lalo Martins.
1379 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1380 mappings by Roman Suzi.
1382 * docutils/transforms/parts.py:
1384 - The "contents" directive does more work up-front, creating the
1385 "topic" and "title", and leaving the "pending" node for the
1386 transform. Allows earlier reference resolution; fixes subtle bug.
1387 - Added support for disabling of section numbering.
1389 * docutils/transforms/references.py:
1391 - Verifying that external targets are truly targets and not indirect
1392 references. This is because we are now adding a "name" attribute to
1393 references in addition to targets. Note sure if this is correct!
1394 - Added code to hook into the unknown_reference_resolvers list for a
1395 transformer in resolve_indirect_target. This allows the
1396 unknown_reference_resolvers to keep around indirect targets which
1397 docutils doesn't know about.
1398 - Added specific error message for duplicate targets.
1400 * docutils/transforms/universal.py:
1402 - Added FilterMessages transform (removes system messages below the
1403 verbosity threshold).
1404 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1405 to FinalCheckVisitor for application-specific handling of
1406 unresolvable references.
1407 - Added specific error message for duplicate targets.
1409 * docutils/writers/__init__.py:
1411 - Added assemble_parts method to the Writer class to allow for
1412 access to a documents individual parts.
1413 - Documented & set default for ``Writer.output`` attribute.
1415 * docutils/writers/html4css1.py:
1417 - Fixed unicode handling of attribute values (bug 760673).
1418 - Prevent duplication of "class" attribute values (bug report from
1420 - Improved table grid/border handling (prompted by report from Bob
1422 - Added support for table titles.
1423 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1425 - Added functionality to keep track of individual parts of a document
1426 and store them in a dictionary as the "parts" attribute of the writer.
1427 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1428 - Added proper support for the "scale" attribute of the "image"
1429 element. Contributed by Brent Cook.
1430 - Added ``--initial-header-level`` option.
1431 - Fixed bug: the body_pre_docinfo segment depended on there being a
1432 docinfo; if no docinfo, the document title was incorporated into
1433 the body segment. Adversely affected the publish_parts interface.
1435 * docutils/writers/latex2e.py:
1437 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1438 about a missing file.
1439 - Added options and support: ``--compound-enumerators``,
1440 ``--section-prefix-for-enumerators``, and
1441 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1443 - Added option ``--use-verbatim-when-possible``, to avoid
1444 problematic characters (eg, '~' in italian) in literal blocks.
1445 - It's now possible to use four section levels in the `book` and
1446 `report` LaTeX classes. The default `article` class still has
1449 * docs/config.txt: "Docutils Configuration Files", added to project.
1450 Moved config file entry descriptions from tools.txt.
1454 - Moved config file entry descriptions to config.txt.
1456 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1459 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1460 Text Roles", added to project.
1462 * spec/rst/reStructuredText.txt:
1464 - Added description of support for <angle-bracketed> complex option
1465 arguments to option lists.
1466 - Added subsections for indented and quoted literal blocks.
1468 * test: Continually adding & updating tests.
1470 - Added test/test_settings.py & test/data/config_*.txt support
1472 - Added test/test_writers/test_htmlfragment.py.
1474 * test/DocutilsTestSupport.py:
1476 - Refactored LaTeX publisher test suite/case class names to make
1477 testing other writers easier.
1478 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1479 to test the processing of HTML fragments which use the new
1480 publish_parts convenience function.
1482 * tools/buildhtml.py:
1484 - Added support for the "--prune" option.
1485 - Removed dependency on pep2html.py; plaintext PEPs no longer
1488 * tools/docutils.conf:
1490 - Updated for configuration file reorganization.
1492 * tools/rst2html.py:
1494 - copied from tools/html.py
1498 - added a 'scripts' section to configuration
1499 - added 'tools/rst2html.py' to the scripts section
1502 Release 0.3 (2003-06-24)
1503 ========================
1507 * Renamed "attribute" to "option" for directives/extensions.
1509 * Renamed transform method "transform" to "apply".
1511 * Renamed "options" to "settings" for runtime settings (as set by
1512 command-line options). Sometimes "option" (singular) became
1513 "settings" (plural). Some variations below:
1515 - document.options -> document.settings (stored in other objects as
1517 - option_spec -> settings_spec (not directives though)
1518 - OptionSpec -> SettingsSpec
1519 - cmdline_options -> settings_spec
1520 - relative_path_options -> relative_path_settings
1521 - option_default_overrides -> settings_default_overrides
1522 - Publisher.set_options -> Publisher.get_settings
1526 * COPYING.txt: Added "Public Domain Dedication".
1528 * FAQ.txt: Frequently asked questions, added to project.
1532 - Updated with PyPI Trove classifiers.
1533 - Conditional installation of third-party modules.
1535 * docutils/__init__.py:
1537 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1538 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1539 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1540 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1541 option and its effect on the PEP template & writer.
1542 - Bumped version to 0.2.4 due to changes to the PEP template &
1544 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1545 - Added ``TransformSpec`` class for new transform system.
1546 - Bumped version to 0.2.6 for API changes (renaming).
1547 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1548 convenience functions.
1549 - Added ``Component.component_type`` attribute.
1550 - Bumped version to 0.2.8 because of the internal parser switch from
1551 plain lists to the docutils.statemachine.StringList objects.
1552 - Bumped version to 0.2.9 because of the frontend.py API changes.
1553 - Bumped version to 0.2.10 due to changes to the project layout
1554 (third-party modules removed from the "docutils" package), and
1555 signature changes in ``io.Input``/``io.Output``.
1556 - Changed version to 0.3.0 for release.
1560 - Made ``publish()`` a bit more convenient.
1561 - Generalized ``Publisher.set_io``.
1562 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1563 parameters; improved its docstring.
1564 - Added ``publish_file()`` and ``publish_string()``.
1565 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1567 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1568 "--dump-transforms" hidden options.
1569 - Added ``Publisher.apply_transforms()`` method.
1570 - Added ``Publisher.set_components()`` method; support for
1571 ``publish_*()`` conveninece functions.
1572 - Moved config file processing to docutils/frontend.py.
1573 - Added support for exit status ("exit_level" setting &
1574 ``enable_exit`` parameter for Publisher.publish() and convenience
1577 * docutils/frontend.py:
1579 - Check for & exit on identical source & destination paths.
1580 - Fixed bug with absolute paths & "--config".
1581 - Set non-command-line defaults in ``OptionParser.__init__()``:
1582 ``_source`` & ``_destination``.
1583 - Distributed ``relative_path_settings`` to components; updated
1584 ``OptionParser.populate_from_components()`` to combine it all.
1585 - Require list of keys in ``make_paths_absolute`` (was implicit in
1586 global ``relative_path_settings``).
1587 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1588 "--dump-settings", and "--dump-transforms" hidden options.
1589 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1590 code, replaced with correct code.
1591 - Added validation functionality for config files.
1592 - Added "--error-encoding" option/setting, "_disable_config"
1594 - Added encoding validation; updated "--input-encoding" and
1595 "--output-encoding"; added "--error-encoding-error-handler" and
1596 "--output-encoding-error-handler".
1597 - Moved config file processing from docutils/core.py.
1598 - Updated ``OptionParser.populate_from_components`` to handle new
1599 ``SettingsSpec.settings_defaults`` dict.
1600 - Added support for "-" => stdin/stdout.
1601 - Added "exit_level" setting ("--exit" option).
1605 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1606 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1607 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1608 - ``FileOutput.write()`` now returns the encoded output string.
1609 - Try to get path/stream name automatically in ``FileInput`` &
1611 - Added defaults for source & destination paths.
1612 - Allow for Unicode I/O with an explicit "unicode" encoding.
1613 - Added ``Output.encode()``.
1614 - Removed dependency on runtime settings; pass encoding directly.
1615 - Recognize Unicode strings in ``Input.decode()``.
1616 - Added support for output encoding error handlers.
1618 * docutils/nodes.py:
1620 - Added "Invisible" element category class.
1621 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1622 modification during a traversal.
1623 - Added element classes: ``line_block``, ``generated``, ``address``,
1624 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1625 ``superscript``, ``subscript``, ``inline``
1626 - Added support for lists of nodes to ``Element.insert()``.
1627 - Fixed parent linking in ``Element.replace()``.
1628 - Added new abstract superclass ``FixedTextElement``; adds
1629 "xml:space" attribute.
1630 - Added support for "line" attribute of ``system_message`` nodes.
1631 - Added support for the observer pattern from ``utils.Reporter``.
1632 Added ``parse_messages`` and ``transform_messages`` attributes to
1633 ``document``, removed ``messages``. Added ``note_parse_message``
1634 and ``note_transform_message`` methods.
1635 - Added support for improved diagnostics:
1637 - Added "document", "source", and "line" internal attributes to
1638 ``Node``, set by ``Node.setup_child()``.
1639 - Converted variations on ``node.parent = self`` to
1640 ``self.setup_child(node)``.
1641 - Added ``document.current_source`` & ``.current_line``
1642 attributes, and ``.note_source`` observer method.
1643 - Changed "system_message" output to GNU-Tools format.
1645 - Added a "rawsource" attribute to the ``Text`` class, for text
1646 before backslash-escape resolution.
1647 - Support for new transform system.
1648 - Reworked ``pending`` element.
1649 - Fixed XML DOM bug (SF #660611).
1650 - Removed the ``interpeted`` element class and added
1651 ``title_reference``, ``abbreviation``, ``acronym``.
1652 - Made substitutions case-sensitive-but-forgiving; moved some code
1654 - Fixed Unicode bug on element attributes (report: William Dode).
1656 * docutils/optik.py: Removed from project; replaced with
1657 extras/optparse.py and extras/textwrap.py. These will be installed
1658 only if they're not already present in the Python installation.
1660 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1661 only if it's not already present in the Python installation.
1663 * docutils/statemachine.py:
1665 - Factored out ``State.add_initial_transitions()`` so it can be
1667 - Converted whitespace-specific "blank" and "indent" transitions
1668 from special-case code to ordinary transitions: removed
1669 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1670 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1671 ``ws_initial_transitions`` attributes.
1672 - Removed ``State.match_transition()`` after merging it into
1674 - Added ``StateCorrection`` exception.
1675 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1676 (moved ``TransitionCorrection`` support there too.)
1677 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1678 ``EOFError`` instead of ``IndexError``.
1679 - Added ``State.no_match`` method.
1680 - Added support for the Observer pattern, triggered by input line
1682 - Added ``strip_top`` parameter to
1683 ``StateMachineWS.get_first_known_indented``.
1684 - Made ``context`` a parameter to ``StateMachine.run()``.
1685 - Added ``ViewList`` & ``StringList`` classes;
1686 ``extract_indented()`` becomes ``StringList.get_indented()``.
1687 - Added ``StateMachine.insert_input()``.
1688 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1689 thanks to) Fred Drake.
1691 * docutils/utils.py:
1693 - Added a ``source`` attribute to Reporter instances and
1694 ``system_message`` elements.
1695 - Added an observer pattern to ``utils.Reporter`` to keep track of
1697 - Fixed bugs in ``relative_path()``.
1698 - Added support for improved diagnostics.
1699 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1700 - Added support for encoding Reporter stderr output, and encoding
1702 - Reporter keeps track of the highest level system message yet
1705 * docutils/languages: Fixed bibliographic field language lookups.
1707 * docutils/languages/es.py: Added to project; Spanish mappings by
1708 Marcelo Huerta San Martin.
1710 * docutils/languages/fr.py: Added to project; French mappings by
1713 * docutils/languages/it.py: Added to project; Italian mappings by
1716 * docutils/languages/sk.py: Added to project; Slovak mappings by
1719 * docutils/parser/__init__.py:
1721 - Added ``Parser.finish_parse()`` method.
1723 * docutils/parser/rst/__init__.py:
1725 - Added options: "--pep-references", "--rfc-references",
1726 "--tab-width", "--trim-footnote-reference-space".
1728 * docutils/parsers/rst/states.py:
1730 - Changed "title under/overline too short" system messages from INFO
1731 to WARNING, and fixed its insertion location.
1732 - Fixed enumerated list item parsing to allow paragraphs & section
1733 titles to begin with enumerators.
1734 - Converted system messages to use the new "line" attribute.
1735 - Fixed a substitution reference edge case.
1736 - Added support for "--pep-references" and "--rfc-references"
1737 options; reworked ``Inliner`` code to make customization easier.
1738 - Removed field argument parsing.
1739 - Added support for short section title over/underlines.
1740 - Fixed "simple reference name" regexp to ignore text like
1741 "object.__method__"; not an anonymous reference.
1742 - Added support for improved diagnostics.
1743 - Reworked directive API, based on Dethe Elza's contribution. Added
1744 ``Body.parse_directive()``, ``.parse_directive_options()``,
1745 ``.parse_directive_arguments()`` methods.
1746 - Added ``ExtensionOptions`` class, to parse directive options
1747 without parsing field bodies. Factored
1748 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1749 ``ExtensionOptions``.
1750 - Improved definition list term/classifier parsing.
1751 - Added warnings for unknown directives.
1752 - Renamed ``Stuff`` to ``Struct``.
1753 - Now flagged as errors: transitions at the beginning or end of
1754 sections, empty sections (except title), and empty documents.
1755 - Updated for ``statemachine.StringList``.
1756 - Enabled recognition of schemeless email addresses in targets.
1757 - Added support for embedded URIs in hyperlink references.
1758 - Added backslash-escapes to inline markup end-string suffix.
1759 - Added support for correct interpreted text processing.
1760 - Fixed nested title parsing (topic, sidebar directives).
1761 - Added special processing of backslash-escaped whitespace (idea
1762 from David Abrahams).
1763 - Made substitutions case-sensitive-but-forgiving; moved some code
1764 to ``docutils.nodes``.
1765 - Added support for block quote attributions.
1766 - Added a kludge to work-around a conflict between the bubble-up
1767 parser strategy and short titles (<= 3 char-long over- &
1768 underlines). Fixes SF bug #738803 "infinite loop with multiple
1769 titles" submitted by Jason Diamond.
1770 - Added explicit interpreted text roles for standard inline markup:
1771 "emphasis", "strong", "literal".
1772 - Implemented "superscript" and "subscript" interpreted text roles.
1773 - Added initial support for "abbreviation" and "acronym" roles;
1775 - Added support for "--trim-footnote-reference-space" option.
1776 - Optional space before colons in directives & hyperlink targets.
1778 * docutils/parsers/rst/tableparser.py:
1780 - Fixed a bug that was producing unwanted empty rows in "simple"
1782 - Detect bad column spans in "simple" tables.
1784 * docutils/parsers/rst/directives: Updated all directive functions to
1787 * docutils/parsers/rst/directives/__init__.py:
1789 - Added ``flag()``, ``unchanged()``, ``path()``,
1790 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1791 directive option helper functions.
1792 - Added warnings for unknown directives.
1793 - Return ``None`` for missing directives.
1794 - Added ``register_directive()``, thanks to William Dode and Paul
1797 * docutils/parsers/rst/directives/admonitions.py:
1799 - Added "admonition" directive.
1801 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1802 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1803 "parsed-literal", "rubric", "epigraph", "highlights" and
1804 "pull-quote" directives.
1806 * docutils/parsers/rst/directives/images.py:
1808 - Added an "align" attribute to the "image" & "figure" directives
1809 (by Adam Chodorowski).
1810 - Added "class" option to "image", and "figclass" to "figure".
1812 * docutils/parsers/rst/directives/misc.py:
1814 - Added "include", "raw", and "replace" directives, courtesy of
1816 - Added "unicode" and "class" directives.
1818 * docutils/parsers/rst/directives/parts.py:
1820 - Added the "sectnum" directive; by Dmitry Jemerov.
1821 - Added "class" option to "contents" directive.
1823 * docutils/parsers/rst/directives/references.py: Added to project.
1824 Contains the "target-notes" directive.
1826 * docutils/parsers/rst/languages/__init__.py:
1828 - Return ``None`` from get_language() for missing language modules.
1830 * docutils/parsers/rst/languages/de.py: Added to project; German
1831 mappings by Engelbert Gruber.
1833 * docutils/parsers/rst/languages/en.py:
1835 - Added interpreted text roles mapping.
1837 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1838 mappings by Marcelo Huerta San Martin.
1840 * docutils/parsers/rst/languages/fr.py: Added to project; French
1841 mappings by William Dode.
1843 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1844 mappings by Nicola Larosa.
1846 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1847 mappings by Miroslav Vasko.
1849 * docutils/readers/__init__.py:
1851 - Added support for the observer pattern from ``utils.Reporter``, in
1852 ``Reader.parse`` and ``Reader.transform``.
1853 - Removed ``Reader.transform()`` method.
1854 - Added default parameter values to ``Reader.__init__()`` to make
1855 instantiation easier.
1856 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1858 * docutils/readers/pep.py:
1860 - Added the ``peps.TargetNotes`` transform to the Reader.
1861 - Removed PEP & RFC reference detection code; moved to
1862 parsers/rst/states.py as options (enabled here by default).
1863 - Added support for pre-acceptance PEPs (no PEP number yet).
1864 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1867 * docutils/readers/python: Python Source Reader subpackage added to
1868 project, including preliminary versions of:
1871 - moduleparser.py: Parser for Python modules.
1873 * docutils/transforms/__init__.py:
1875 - Added ``Transformer`` class and completed transform reform.
1876 - Added unknown_reference_resolvers list for each transformer. This list holds
1877 the list of functions provided by each component of the transformer that
1878 help resolve references.
1880 * docutils/transforms/frontmatter.py:
1882 - Improved support for generic fields.
1883 - Fixed bibliographic field language lookups.
1885 * docutils/transforms/misc.py: Added to project. Miscellaneous
1888 * docutils/transforms/parts.py:
1890 - Moved the "id" attribute from TOC list items to the references
1891 (``Contents.build_contents()``).
1892 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1893 - Added "class" attribute support to ``Contents``.
1895 * docutils/transforms/peps.py:
1897 - Added ``mask_email()`` function, updating to pep2html.py's
1899 - Linked "Content-Type: text/x-rst" to PEP 12.
1900 - Added the ``TargetNotes`` PEP-specific transform.
1901 - Added ``TargetNotes.cleanup_callback``.
1902 - Added title check to ``Headers``.
1904 * docutils/transforms/references.py:
1906 - Added the ``TargetNotes`` generic transform.
1907 - Split ``Hyperlinks`` into multiple transforms.
1908 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1909 - Added check for circular indirect references.
1910 - Made substitutions case-sensitive-but-forgiving.
1912 * docutils/transforms/universal.py:
1914 - Added support for the "--expose-internal-attributes" option.
1915 - Removed ``Pending`` transform classes & data.
1917 * docutils/writers/__init__.py:
1919 - Removed ``Writer.transform()`` method.
1921 * docutils/writers/docutils-xml.py:
1923 - Added XML and doctype declarations.
1924 - Added "--no-doctype" and "--no-xml-declaration" options.
1926 * docutils/writers/html4css1.py:
1928 - "name" attributes only on these tags: a, applet, form, frame,
1930 - Added "name" attribute to <a> in section titles for Netscape 4
1931 support (bug report: Pearu Peterson).
1932 - Fixed targets (names) on footnote, citation, topic title,
1933 problematic, and system_message nodes (for Netscape 4).
1934 - Changed field names from "<td>" to "<th>".
1935 - Added "@" to "@" encoding to thwart address harvesters.
1936 - Improved the vertical whitespace optimization; ignore "invisible"
1937 nodes (targets, comments, etc.).
1938 - Improved inline literals with ``<span class="pre">`` around chunks
1939 of text and `` `` for runs of spaces.
1940 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1941 ``self.docinfo`` segments.
1942 - Added support for "line_block", "address" elements.
1943 - Improved backlinks (footnotes & system_messages).
1944 - Improved system_message output.
1945 - Redefined "--stylesheet" as containing an invariant URL, used
1946 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1948 - Added "--footnote-references" option (superscript or brackets).
1949 - Added "--compact-lists" and "--no-compact-lists" options.
1950 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1951 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1952 - Improved field list rendering.
1953 - Added Docutils version to "generator" meta tag.
1954 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1955 - Improved layout of <pre> HTML source.
1956 - Fixed attribute typo on <colspec>.
1957 - Refined XML prologue.
1958 - Support for no stylesheet.
1959 - Removed "interpreted" element support.
1960 - Added support for "title_reference", "sidebar", "attribution",
1961 "rubric", and generic "admonition" elements.
1962 - Added "--attribution" option.
1963 - Added support for "inline", "subscript", "superscript" elements.
1964 - Added initial support for "abbreviation" and "acronym";
1967 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1971 - Double quotes in literal blocks (special treatment for de/ngerman).
1972 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1973 - Added "--attribution" option.
1974 - Right align attributions.
1976 * docutils/writers/pep_html.py:
1978 - Parameterized output encoding in PEP template.
1979 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1980 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1981 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1983 - Added an override on the "--footnote-references" option.
1984 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1985 - Added Docutils version to "generator" meta tag.
1986 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1990 - Added a "silent" setting for ``buildhtml.py``.
1991 - Added a "Getting Help" section.
1992 - Rearranged the structure.
1993 - Kept up to date, with new settings, command-line options etc.
1994 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1995 - Converted settings table into a definition list.
1997 * docs/rst/quickstart.txt:
1999 - Added a table of contents.
2000 - Added feedback information.
2001 - Added mention of minimum section title underline lengths.
2002 - Removed the 4-character minimum for section title underlines.
2004 * docs/rst/quickref.html:
2006 - Added a "Getting Help" section.
2007 - Added a style to make section title backlinks more subtle.
2008 - Added mention of minimum section title underline lengths.
2009 - Removed the 4-character minimum for section title underlines.
2011 * extras: Directory added to project; contains third-party modules
2012 that Docutils depends on (optparse, textwrap, roman). These are
2013 only installed if they're not already present.
2015 * licenses: Directory added to project; contains copies of license
2016 files for non-public-domain files.
2020 - Changed the focus. It's about DTD elements: structural
2021 relationships, semantics, and external (public) attributes. Not
2022 about the element class library.
2023 - Moved some implementation-specific stuff into ``docutils.nodes``
2025 - Wrote descriptions of all common attributes and parameter
2026 entities. Filled in introductory material.
2027 - Working through the element descriptions: 55 down, 37 to go.
2028 - Removed "Representation of Horizontal Rules" to
2029 spec/rst/alternatives.txt.
2031 * spec/docutils.dtd:
2033 - Added "generated" inline element.
2034 - Added "line_block" body element.
2035 - Added "auto" attribute to "title".
2036 - Changed content models of "literal_block" and "doctest_block" to
2038 - Added ``%number;`` attribute type parameter entity.
2039 - Changed ``%structural.elements;`` to ``%section.elements``.
2040 - Updated attribute types; made more specific.
2041 - Added "address" bibliographic element.
2042 - Added "line" attribute to ``system_message`` element.
2043 - Removed "field_argument" element; "field_name" may contain
2044 multiple words and whitespace.
2045 - Changed public identifier to docutils.sf.net.
2046 - Removed "interpreted" element; added "title_reference",
2047 "abbreviation", "acronym".
2048 - Removed "refuri" attribute from "footnote_reference" and
2049 "citation_reference".
2050 - Added "sidebar", "rubric", "attribution", "admonition",
2051 "superscript", "subscript", and "inline" elements.
2053 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2055 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2057 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2059 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2062 * spec/transforms.txt: Added to project.
2064 * spec/howto: Added subdirectory, for developer how-to docs.
2066 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2067 Elza, edited & extended by David Goodger.
2069 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2072 * spec/rst/alternatives.txt:
2074 - Added "Doctree Representation of Transitions" from
2076 - Updated "Inline External Targets" & closed the debate.
2077 - Added ideas for interpreted text syntax extensions.
2078 - Added "Nested Inline Markup" section.
2080 * spec/rst/directives.txt:
2082 - Added directives: "topic", "sectnum", "target-notes",
2083 "line-block", "parsed-literal", "include", "replace", "sidebar",
2084 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2086 - Formalized descriptions of directive details.
2087 - Added an "align" attribute to the "image" & "figure" directives
2088 (by Adam Chodorowski).
2089 - Added "class" options to "topic", "sidebar", "line-block",
2090 "parsed-literal", "contents", and "image"; and "figclass" to
2093 * spec/rst/interpreted.txt: Added to project. Descriptions of
2094 interpreted text roles.
2096 * spec/rst/introduction.txt:
2098 - Added pointers to material for new users.
2100 * spec/rst/reStructuredText.txt:
2102 - Disambiguated comments (just add a newline after the "::").
2103 - Updated enumerated list description; added a discussion of the
2104 second-line validity checking.
2105 - Updated directive description.
2106 - Added a note redirecting newbies to the user docs.
2107 - Expanded description of inline markup start-strings in non-markup
2109 - Removed field arguments and made field lists a generic construct.
2110 - Removed the 4-character minimum for section title underlines.
2111 - Clarified term/classifier delimiter & inline markup ambiguity
2113 - Added "Embedded URIs".
2114 - Updated "Interpreted Text" section.
2115 - Added "Character-Level Inline Markup" section.
2117 * test: Continually adding & updating tests.
2119 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2120 - Moved test/test_pep/ to test/test_readers/test_pep/.
2121 - Added test/test_readers/test_python/.
2122 - Added test/test_writers/ (Engelbert Gruber).
2126 - Made the ``locale.setlocale()`` calls in front ends
2129 * tools/buildhtml.py:
2131 - Added "--silent" option.
2132 - Fixed bug with absolute paths & "--config".
2133 - Updated for new I/O classes.
2134 - Added some exception handling.
2135 - Separated publishers' setting defaults; prevents interference.
2136 - Updated for new ``publish_file()`` convenience function.
2138 * tools/pep-html-template:
2140 - Allow for "--embed-stylesheet".
2141 - Added Docutils version to "generator" meta tag.
2142 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2143 - Conform to XHTML spec.
2145 * tools/pep2html.py:
2147 - Made ``argv`` a parameter to ``main()``.
2148 - Added support for "Content-Type:" header & arbitrary PEP formats.
2149 - Linked "Content-Type: text/plain" to PEP 9.
2150 - Files skipped (due to an error) are not pushed onto the server.
2151 - Updated for new I/O classes.
2152 - Added ``check_requirements()`` & ``pep_type_error()``.
2153 - Added some exception handling.
2154 - Updated for new ``publish_string()`` convenience function.
2155 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2157 * tools/quicktest.py:
2159 - Added "-V"/"--version" option.
2161 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2163 * tools/unicode2rstsubs.py: Added to project. Produces character
2164 entity files (reSructuredText substitutions) from the MathML master
2167 * tools/editors: Support code for editors, added to project. Contains
2168 ``emacs/restructuredtext.el``.
2170 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2172 - Added style for chunks of inline literals.
2173 - Removed margin for first child of table cells.
2174 - Right-aligned field list names.
2175 - Support for auto-numbered section titles in TOCs.
2176 - Increased the size of inline literals (<tt>) in titles.
2177 - Restored the light gray background for inline literals.
2178 - Added support for "line_block" elements.
2179 - Added style for "address" elements.
2180 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2181 - Improved field list rendering.
2182 - Vertical whitespace improvements.
2183 - Removed "a.target" style.
2185 * tools/stylesheets/pep.css:
2187 - Fixed nested section margins.
2188 - Other changes parallel those of ``../default.css``.
2191 Release 0.2 (2002-07-31)
2192 ========================
2196 - The word "component" was being used ambiguously. From now on,
2197 "component" will be used to mean "Docutils component", as in Reader,
2198 Writer, Parser, or Transform. Portions of documents (Table of
2199 Contents, sections, etc.) will be called "document parts".
2200 - Did a grand renaming: a lot of ``verylongnames`` became
2201 ``very_long_names``.
2202 - Cleaned up imports: no more relative package imports or
2203 comma-separated lists of top-level modules.
2204 - Added support for an option values object which carries default
2205 settings and overrides (from command-line options and library use).
2206 - Added internal Unicode support, and support for both input and
2208 - Added support for the ``docutils.io.IO`` class & subclasses.
2212 * docutils/__init__.py:
2214 - Added ``ApplicationError`` and ``DataError``, for use throughout
2216 - Added ``Component`` base class for Docutils components; implements
2217 the ``supports`` method.
2218 - Added ``__version__`` (thus, ``docutils.__version__``).
2222 - Removed many keyword parameters to ``Publisher.__init__()`` and
2223 ``publish()``; bundled into an option values object. Added
2224 "argv", "usage", "description", and "option_spec" parameters for
2225 command-line support.
2226 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2228 - Reworked I/O model for ``docutils.io`` wrappers.
2229 - Updated ``Publisher.set_options()``; now returns option values
2231 - Added support for configuration files (/etc/docutils.conf,
2232 ./docutils.conf, ~/.docutils).
2233 - Added ``Publisher.setup_option_parser()``.
2234 - Added default usage message and description.
2236 * docutils/frontend.py: Added to project; support for front-end
2237 (command-line) scripts. Option specifications may be augmented by
2238 components. Requires Optik (http://optik.sf.net/) for option
2239 processing (installed locally as docutils/optik.py).
2241 * docutils/io.py: Added to project; uniform API for a variety of input
2244 * docutils/nodes.py:
2246 - Added ``TreeCopyVisitor`` class.
2247 - Added a ``copy`` method to ``Node`` and subclasses.
2248 - Added a ``SkipDeparture`` exception for visitors.
2249 - Renamed ``TreePruningException`` from ``VisitorException``.
2250 - Added docstrings to ``TreePruningException``, subclasses, and
2252 - Improved docstrings.
2253 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2254 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2256 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2257 ``PreDecorative`` mixin.
2258 - Reworked the name/id bookkeeping; to ``document``, removed
2259 ``explicit_targets`` and ``implicit_targets`` attributes, added
2260 ``nametypes`` attribute and ``set_name_id_map`` method.
2261 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2263 - Added ``document.has_name()`` method.
2264 - Fixed DOM generation for list-attributes.
2265 - Added category class ``Labeled`` (used by footnotes & citations).
2266 - Added ``Element.set_class()`` method (sets "class" attribute).
2268 * docutils/optik.py: Added to project. Combined from the Optik
2269 package, with added option groups and other modifications. The use
2270 of this module is probably only temporary.
2272 * docutils/statemachine.py:
2274 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2275 - Added underscores to improve many awkward names.
2276 - In ``string2lines()``, changed whitespace normalizing translation
2277 table to regexp; restores Python 2.0 compatibility with Unicode.
2279 * docutils/urischemes.py:
2281 - Filled in some descriptions.
2282 - Added "shttp" scheme.
2284 * docutils/utils.py:
2286 - Added ``clean_rcs_keywords`` function (moved from
2287 docutils/transforms/frontmatter.py
2288 ``DocInfo.filter_rcs_keywords``).
2289 - Added underscores to improve many awkward names.
2290 - Changed names of Reporter's thresholds:
2291 warning_level -> report_level; error_level -> halt_level.
2292 - Moved ``utils.id()`` to ``nodes.make_id()``.
2293 - Added ``relative_path(source, target)``.
2295 * docutils/languages/de.py: German mappings; added to project. Thanks
2296 to Gunnar Schwant for the translations.
2298 * docutils/languages/en.py: Added "Dedication" bibliographic field
2301 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2304 * docutils/parsers/rst/states.py:
2306 - Added underscores to improve many awkward names.
2307 - Added RFC-2822 header support.
2308 - Extracted the inline parsing code from ``RSTState`` to a separate
2309 class, ``Inliner``, which will allow easy subclassing.
2310 - Made local bindings for ``memo`` container & often-used contents
2311 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2312 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2313 - Added ``MarkupMismatch`` exception; for late corrections.
2314 - Added ``-/:`` characters to inline markup's start string prefix,
2315 ``/`` to end string suffix.
2316 - Fixed a footnote bug.
2317 - Fixed a bug with literal blocks.
2318 - Applied patch from Simon Budig: simplified regexps with symbolic
2319 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2320 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2321 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2322 - Allowed non-ASCII in "simple names" (directive names, field names,
2324 - Converted ``Inliner.patterns.initial`` to be dynamically built
2325 from parts with ``build_regexp()`` function.
2326 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2327 - Updated docstrings.
2328 - Changed "table" to "grid_table"; added "simple_table" support.
2330 * docutils/parsers/rst/tableparser.py:
2332 - Changed ``TableParser`` to ``GridTableParser``.
2333 - Added ``SimpleTableParser``.
2334 - Refactored naming.
2336 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2337 a fallback language for directive names.
2339 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2340 directive to use a ``pending`` element, used only by HTML writers.
2342 * docutils/parsers/rst/directives/parts.py: Renamed from
2345 - Added "backlinks" attribute to "contents" directive.
2347 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2348 project by Adam Chodorowski.
2350 * docutils/readers/__init__.py: Gave Readers more control over
2351 choosing and instantiating Parsers.
2353 * docutils/readers/pep.py: Added to project; for PEP processing.
2355 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2356 requires a ``component`` parameter.
2358 * docutils/transforms/components.py: Added to project; transforms
2359 related to Docutils components.
2361 * docutils/transforms/frontmatter.py:
2363 - In ``DocInfo.extract_authors``, check for a single "author" in an
2364 "authors" group, and convert it to a single "author" element.
2365 - Added support for "Dedication" and generic bibliographic fields.
2367 * docutils/transforms/peps.py: Added to project; PEP-specific.
2369 * docutils/transforms/parts.py: Renamed from old components.py.
2371 - Added filter for `Contents`, to use alt-text for inline images,
2372 and to remove inline markup that doesn't make sense in the ToC.
2373 - Added "name" attribute to TOC topic depending on its title.
2374 - Added support for optional TOC backlinks.
2376 * docutils/transforms/references.py: Fixed indirect target resolution
2377 in ``Hyperlinks`` transform.
2379 * docutils/transforms/universal.py:
2381 - Changed ``Messages`` transform to properly filter out system
2382 messages below the warning threshold.
2383 - Added ``Decorations`` transform (support for ``--generator``,
2384 ``--date``, ``--time``, ``--source-link`` options).
2386 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2387 Engelbert Gruber's PDF writer.
2389 * docutils/writers/html4css1.py:
2391 - Made XHTML-compatible (switched to lowercase element & attribute
2392 names; empty tag format).
2393 - Escape double-dashes in comment text.
2394 - Improved boilerplate & modularity of output.
2395 - Exposed modular output in Writer class.
2396 - Added a "generator" meta tag to <head>.
2397 - Added support for the ``--stylesheet`` option.
2398 - Added support for ``decoration``, ``header``, and ``footer``
2400 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2401 translation table to regexp; restores Python 2.0 compatibility
2403 - Added the translator class as instance variable to the Writer, to
2404 make it easily subclassable.
2405 - Improved option list spacing (thanks to Richard Jones).
2406 - Modified field list output.
2407 - Added backlinks to footnotes & citations.
2408 - Added percentage widths to "<col>" tags (from colspec).
2409 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2410 "<span>" changed to "<var>".
2411 - Inline literals: "<code>" changed to "<tt>".
2412 - Many changes to optimize vertical space: compact simple lists etc.
2413 - Add a command-line options & directive attributes to control TOC
2414 and footnote/citation backlinks.
2415 - Added support for optional footnote/citation backlinks.
2416 - Added support for generic bibliographic fields.
2417 - Identify backrefs.
2418 - Relative URLs for stylesheet links.
2420 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2421 PEPs (subclass of ``html4css1.Writer``).
2423 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2425 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2426 of the Docutils internal doctree in XML.
2428 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2432 - Changed the title to "The Docutils Document Tree".
2433 - Added "Hyperlink Bookkeeping" section.
2435 * spec/docutils.dtd:
2437 - Added ``decoration``, ``header``, and ``footer`` elements.
2438 - Brought ``interpreted`` element in line with the parser: changed
2439 attribute "type" to "role", added "position".
2440 - Added support for generic bibliographic fields.
2442 * spec/notes.txt: Continual updates. Added "Project Policies".
2444 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2447 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2449 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2450 mailing list discussions.
2452 * spec/pep-0287.txt:
2454 - Renamed to "reStructuredText Docstring Format".
2456 - Reworked Q&A as an enumerated list.
2457 - Converted to reStructuredText format.
2459 * spec/pysource.dtd:
2461 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2463 * spec/pysource.txt: Removed from project. Moved much of its contents
2466 * spec/rst/alternatives.txt:
2468 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2469 - Added "Inline External Targets" section.
2471 * spec/rst/directives.txt:
2473 - Added "backlinks" attribute to "contents" directive.
2475 * spec/rst/problems.txt:
2477 - Updated the Enumerated List Markup discussion.
2478 - Added new alternative table markup syntaxes.
2480 * spec/rst/reStructuredText.txt:
2482 - Clarified field list usage.
2483 - Updated enumerated list description.
2484 - Clarified purpose of directives.
2485 - Added ``-/:`` characters to inline markup's start string prefix,
2486 ``/`` to end string suffix.
2487 - Updated "Authors" bibliographic field behavior.
2488 - Changed "inline hyperlink targets" to "inline internal targets".
2489 - Added "simple table" syntax to supplement the existing but
2490 newly-renamed "grid tables".
2491 - Added cautions for anonymous hyperlink use.
2492 - Added "Dedication" and generic bibliographic fields.
2494 * test: Made test modules standalone (subdirectories became packages).
2496 * test/DocutilsTestSupport.py:
2498 - Added support for PEP extensions to reStructuredText.
2499 - Added support for simple tables.
2500 - Refactored naming.
2502 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2504 - Now supports true packages containing test modules
2505 (``__init__.py`` files required); fixes duplicate module name bug.
2507 * test/test_pep/: Subpackage added to project; PEP testing.
2509 * test/test_rst/test_SimpleTableParser.py: Added to project.
2513 - Updated html.py and publish.py front-end tools to use the new
2514 command-line processing facilities of ``docutils.frontend``
2515 (exposed in ``docutils.core.Publisher``), reducing each to just a
2517 - Added ``locale.setlocale()`` calls to front-end tools.
2519 * tools/buildhtml.py: Added to project; batch-generates .html from all
2520 the .txt files in directories and subdirectories.
2522 * tools/default.css:
2524 - Added support for ``header`` and ``footer`` elements.
2525 - Added styles for "Dedication" topics (biblio fields).
2527 * tools/docutils.conf: A configuration file; added to project.
2529 * tools/docutils-xml.py: Added to project.
2531 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2533 * tools/pep-html-template: Added to project.
2535 * tools/pep2html.py: Added to project from Python (nondist/peps).
2536 Added support for Docutils (reStructuredText PEPs).
2538 * tools/quicktest.py:
2540 - Added the ``--attributes`` option, hacked a bit.
2541 - Added a second command-line argument (output file); cleaned up.
2543 * tools/stylesheets/: Subdirectory added to project.
2545 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2548 Release 0.1 (2002-04-20)
2549 ========================
2551 This is the first release of Docutils, merged from the now inactive
2552 reStructuredText__ and `Docstring Processing System`__ projects. For
2553 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2554 `DPS HISTORY`__ files.
2556 __ http://structuredtext.sourceforge.net/
2557 __ http://docstring.sourceforge.net/
2558 __ http://structuredtext.sourceforge.net/HISTORY.html
2559 __ http://docstring.sourceforge.net/HISTORY.html
2561 General changes: renamed 'dps' package to 'docutils'; renamed
2562 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2563 the test suites (reStructuredText's test/test_states renamed to
2564 test/test_rst); and all modifications required to make it all work.
2566 * docutils/parsers/rst/states.py:
2568 - Improved diagnostic system messages for missing blank lines.
2569 - Fixed substitution_reference bug.
2575 indent-tabs-mode: nil
2576 sentence-end-double-space: t