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 [ 2923723 ] let decode_path() tolerate path == None
33 * docutils/writers/latex2e/__init__.py
35 - Use `transforms.writer_aux.Admonitions` to "normalize" special
37 - Use the ``\url`` command for URLs (breaks long URLs instead of
38 writing into the margin).
39 - Preserve runs of spaces in `inline literals`__.
40 - Deprecate ``figure_footnotes`` setting.
41 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
42 - New ``latex_preamble`` setting.
43 - PDF standard fonts (Times/Helvetica/Courier) as default.
45 __ docs/ref/restructuredtext.html#inline-literals
46 __ docs/user/config.html#docutils-footnotes
48 * docutils/writers/manpage.py
50 - Titles level 1, that is ``.SH``, always uppercase.
51 - Apply patch from mg: literal text should be bold in man-pages.
55 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
58 Release 0.6 (2009-10-11)
59 ========================
63 - Docutils is now compatible with Python versions from 2.3 up to 2.6
64 and convertible to 3.1 code.
66 + Node.__nonzero__ returns True instead of 1.
67 + use os.walk instead os.path.walk.
68 + minimize "types" module where possible.
69 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
70 + Text nodes now subclass unicode rather than UserString
71 (which is gone in python 3.0).
72 + 3.0 compatibility module docutils._compat
74 + Drop 2.2 compatibility workarounds.
75 + Drop extras/optparse.py and extras/textwrap.py
76 (stdlib modules since 2.3).
78 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
79 - Unix man page export: manpage writer moved from sandbox to Doctutils
82 - Apply [ 1719345 ] Galician translation
83 - Apply [ 1905741 ] Polish translation
84 - Apply [ 1878977 ] make_id(): deaccent characters.
85 - Apply [ 2029251 ] return nonzero when tests fail.
86 - Fix [ 1692788 ] allow UTF-8 in style sheets.
87 - Fix [ 2781629 ] support non-ASCII chars in file names.
88 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
89 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
90 - Fix [ 2821266 ] --strict option works now like --halt=info.
91 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
92 - Fix [ 1627229 ] hyperlink references in substitutions.
94 - The "newlatex" writer is orphaned.
98 - Documented Unicode characters allowed as inline markup openers,
99 closers, and delimiters.
100 - Allow units for all length specifications.
101 - Allow percent sign in "scale" argument of "figure" and "image" directives.
102 - Bugfix: The "figalign" argument of a figure now works as intended
103 (aligning the figure, not its contents).
104 - Align images with class "align-[right|center|left]"
105 (allows setting the alignment of an image in a figure).
109 - Added ``Element.__contains__`` method, for the in-operator.
111 * docutils/parsers/rst/states.py:
113 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
114 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
115 " " (non-breaking space), and "¡ ¿" openers.
117 * docutils/parsers/directives/misc.py:
119 - Added ``start-line`` and ``end-line`` options to "include"
120 directive to select a range of lines.
121 - Hard tabs in literal inclusions are replaced by spaces. This is
122 configurable via the new ``tab-width`` option of the "include" directive
123 (a negative tab-width prevents tab expansion).
127 - Add ``get_stylesheet_list`` function.
128 - Apply [ 2834836 ] print info at halt
130 * docutils/transforms/universal.py:
132 - Raise default priority of StripClasses to exclude stripped classes from
135 * docutils/writers/html4css1/__init__.py:
137 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
138 separated list of stylesheets.
139 - Address [ 1938891 ] Inline literal text creates "pre" span only when
140 needed to prevent inter-word line wraps.
141 - Use `translate` method instead of repeated `replace` calls.
142 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
143 classes to allow CSS styling that does not interfere with other
144 table-using constructs (field lists, citations, ...).
146 * docutils/writers/newlatex2e/__init__.py:
148 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
150 * docutils/writers/latex2e/__init__.py (see also
151 `<docs/user/docutils-05-compat.sty.html>`__) :
153 - Add ``--embed-stylesheet`` option.
154 - Apply [ 1474017 ] image vertical alignment is reversed.
155 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
156 - Change: has_key for dictionaries (not Nodes) to in-operator.
157 - Merge adjacent citations into one latex cite command.
158 - Failsave implementation of custom roles. LaTeX compilation now ignores
159 unknown classes instead of aborting with an error.
160 - Support custom roles based on standard roles.
161 - LaTeX packages can be used as ``--stylesheet`` arguments without
162 restriction. (A style sheet is now referenced with the ``\usepackage``
163 command, if it ends with ``.sty`` or has no extension.)
164 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
165 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
166 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
167 2005-02-04 as a configurable length unit).
168 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
169 if font-encoding is set to ''. LaTeX defaults to OT1 then.
170 - Set sub- and superscript role argument in text mode not as math.
171 Use a custom role based on sub-/superscript if you want italic shape.
172 - Shorter preamble and less dependencies: Load packages and define macros
173 only if required in the document.
174 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
175 - New custom environments and commands with optional "classes" argument.
176 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
177 - Better conformance to Docutils specifications with ``--use-latex-toc``.
178 Support for LaTeX generated ToC also with unnumbered sections.
179 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
180 section numbering by LaTeX.
181 - Use default font in admonitions and sidebar.
182 - Align of image in a figure defaults to 'center'.
183 - Bugfix: Newlines around targets and references prevent run-together
185 - Fix internal hyperlinks.
186 - Use class defaults for page margins ('typearea' now optional).
187 - Float placement made configurable, default changed to "here definitely".
188 - Typeset generic topic as "quote block with title".
189 - Use template (file and configuration option).
190 - In the default template, load cmap.sty (fix text extraction in PDF) and
191 fixltx2e.sty (LaTeX patches, \textsubscript).
192 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
193 - Use `translate` instead of repeated `replace` calls for text encoding.
194 - Hyperlinked footnotes and support for symbol footnotes and
195 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
196 - Complete pairs of binary options
197 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
198 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
200 - font-encoding: "T1" (formerly implicitely set by 'ae').
201 - use-latex-toc: true (ToC with page numbers).
202 - use-latex-footnotes: true (no mixup with figures).
204 * docutils/writers/manpage.py
206 - Do not print version at document end, this is done by the viewer.
207 - Do not print date at document end, this is done by the viewer.
208 - Fix storage of docinfo fields for none standard fields.
210 * docutils/tools/rst2man.py
212 Release 0.5 (2008-06-25)
213 ========================
215 * docutils/languages/he.py: Added to project: Hebrew mappings by
218 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
219 mappings by Meir Kriheli.
221 * docutils/frontend.py:
223 - Configuration files are now assumed and required to be
225 - Paths of applied configuration files are now recorded in the
226 runtime setting ``_config_files`` (accessible via
227 ``--dump-settings``).
228 - Added ``--strip-elements-with-class`` and ``--strip-class``
229 options (``strip_elements_with_classes`` and ``strip_classes``
234 - Added code to determine the input encoding from data: encoding
235 declarations or the presence of byte order marks (UTF-8 & UTF-16).
236 - Added support for IronPython 1.0.
240 - Added ``document.__getstate__`` method, for pickling.
242 * docutils/parsers/rst/states.py:
244 - Allow ``+`` and ``:`` in reference names.
245 - Unquoted targets beginning with an underscore (``.. __target:
246 URI``) are no longer accepted.
247 - Added support for multiple attributions in a physical block quote
248 (indented text block), dividing it into multiple logical block
250 - Added support for unicode bullets in bullet lists: "•", "‣", and
252 - Added support for new object-oriented directive interface,
253 retaining compatibility to the old functional interface.
254 - Added support for throwing ``DirectiveError``'s from within
257 * docutils/parsers/rst/__init__.py:
259 - Added ``Directive`` base class.
260 - Added ``DirectiveError`` base class.
261 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
264 * docutils/parsers/directives/:
266 - Refactored all reStructuredText directives to use the new
267 object-oriented directive interface. Errors are now (mostly)
268 thrown using the new ``DirectiveError`` class.
270 * docutils/parsers/directives/misc.py:
272 - Added ``start-after`` and ``end-before`` options to ``include``
273 directive; thanks to Stefan Rank.
275 * docutils/transforms/universal.py:
277 - Added ``StripClassesAndElements`` transform to remove from the
278 document tree all elements with classes in
279 ``settings.strip_elements_with_classes`` and all "classes"
280 attribute values in ``self.document.settings.strip_classes``.
282 * docutils/transforms/writer_aux.py:
284 - Added ``Admonitions`` transform to transform specific admonitions
285 (like ``note``, ``warning``, etc.) into generic admonitions with a
288 * docutils/writers/html4css1/__init__.py:
290 - Moved template functionality from the PEP/HTML writer here.
291 - Expanded the fragments available in the ``parts`` attribute.
292 - Moved ``id`` attributes from titles to surrounding ``div``
294 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
295 universally supported now).
296 - ``template.txt`` is now opened in text mode instead of binary mode
297 (to ensure Windows compatibility).
298 - ``a`` elements now have an "internal" or "external" class,
299 depending on reference type.
301 * docutils/writers/html4css1/template.txt: Added to project.
303 * docutils/writers/pep_html/:
305 - Moved template functionality to the HTML writer.
307 * docutils/writers/s5_html/__init__.py:
309 - Added ``view_mode`` & ``hidden_controls`` settings
310 (``--view-mode`` & ``--hidden-controls/--visible-controls``
313 * docutils/writers/latex2e/__init__.py:
315 - Add ``--literal-block-env``
316 - Fix: escaping ``%`` in href urls.
317 - Move usepackage hyperref after stylesheet inclusion.
318 - Fix: scrartcl does not have chapter but scrreprt.
319 - Add newline after ``\end{verbatim}``.
320 - Merge smaller differences from latex2e_adaptive_preamble.
321 - Add ``use-part-section``.
322 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
323 - Using leavemode option_list no longer needs to check if parent
324 is a definition list.
325 - Append ``\leavemode`` to definition list terms.
326 - No longer write visit\_/depart_definition_list_item comments to
328 - Table column width with 3 decimal places.
329 - Add table stubs support (boldfont).
330 - Add assemble_parts to writer.
331 - Add simply support for nested tables.
332 - Fix verbatim in tables if use-verbatim-when-possible.
333 - Use section commands down to subparagraph.
334 - Put ensuremath around some latin1 chars.
335 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
336 - New option ``--use-bibtex=style,db1,db2``.
337 - New option ``--reference-label`` to allow usage of LaTeX ref for
338 labels in section references.
339 - Add a label after every section to support sectionnumbers as reference
341 - Fix: bug# 1605376 rst2latex: bad options group list
342 - Remove inactive code for use_optionlist_for_option_list.
343 - Remove latex comments from option_list output.
344 - Fix: bug# 1612270 double qoutes in italian literal.
345 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
346 - Add option --use-latex-abstract.
347 - Image width unit ``px`` is translated to ``pt``.
348 - Add image height support.
349 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
351 - Fix: Do not escape underscores in citation reference labels if
352 use-latex-citations is set.
353 - Use centering instead of center for figure contents, to avoid vertical
355 - Recognize table class: borderless, nolines, booktabs, standard.
356 - Fix: Renaming contents section does not work with latex writer; SF
358 - Applied patch for custom roles with classes from Edward Loper.
359 - Fixed bug that caused crashes with more than 256 lists.
361 * docutils/writers/pep_html/__init__.py:
363 - Changed to support new python.org website structure and
366 * docs/howto/security.txt: "Deploying Docutils Securely", added to
369 * tools/buildhtml.py:
371 -- Added ``ignore`` setting to exclude a list of shell patterns
372 (default: ``.svn:CVS``).
374 * tools/editors/emacs/rst.el:
376 - Changed license to "GPL".
377 - Added ``rst-straighten-decorations`` function.
378 - The ``compile`` module is now always loaded.
379 - Added ``rst-toggle-line-block`` function.
380 - Headings consisting only of non-ASCII characters are now
381 recognized by ``rst-toc`` and ``rst-adjust``.
382 - Added font-lock support for multi-line comments where the first
383 comment line is empty.
384 - Added ``(require 'font-lock)``.
388 - Provide descriptive error message if distutils is missing.
391 Release 0.4 (2006-01-09)
392 ========================
396 - Updated the project policies for trunk/branch development &
399 * docutils/__init__.py:
401 - Added ``__version_details__`` attribute to describe code source
402 (repository/snapshot/release).
403 - Replaced ``default_transforms`` attribute of TransformSpec with
404 ``get_transforms()`` method.
408 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
409 functions, for document tree extraction and reprocessing.
413 - Added ``DocTreeInput`` class, for reprocessing existing documents.
414 - Added support for non-Unicode (e.g. binary) writer output.
418 - Re-introduced ``Targetable.indirect_reference_name``, for
419 MoinMoin/reST compatibility (removed in r3124/r3129).
420 - Added ``serial_escape`` function; escapes string values that are
421 elements of a list, for serialization. Modified Docutils-XML
422 writing (``Element._dom_node``) and pseudo-XML writing
423 (``Element.starttag``) to use ``serial_escape``.
424 - Added ``Node.deepcopy()`` method.
425 - Removed the internal lists ``document.substitution_refs``,
426 ``document.anonymous_refs``, and ``document.anonymous_targets``.
427 - Added a "container" element.
428 - Fixed bug where values of list-valued attributes of elements
429 originating from custom interpreted text roles (i.e., with custom
430 classes) were being shared between element instances. Reported by
433 * docutils/statemachine.py:
435 - Added trailing whitespace stripping to ``string2lines()``.
436 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
437 Asian double-width character support.
441 - Added ``east_asian_column_width()`` for double-width character
444 * docutils/languages/ja.py: Added to project: Japanese mappings by
447 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
448 mappings by Panjunyong.
450 * docutils/parsers/null.py: Added to project; a do-nothing parser.
452 * docutils/parsers/rst/__init__.py:
454 - Added validator to tab_width setting, with test. Closes SF bug
455 #1212515, report from Wu Wei.
457 * docutils/parsers/rst/states.py:
459 - Fixed bug with escaped colons indicating a literal block.
460 - Fixed bug with enumerated lists (SF#1254145).
461 - Backslash-escaped colons inside of field names are now allowed.
462 - Targets (implicit and explicit), anonymous hyperlink references
463 and auto-numbered footnote references inside of substitution
464 definitions are now disallowed.
465 - Fixed bug: list items with blank first lines.
466 - Fixed bug: block quote attributions with indented second lines.
467 - Added East Asian double-width character support (Python 2.4 only).
469 * docutils/parsers/rst/tableparser.py:
471 - Added East Asian double-width character support (Python 2.4 only).
473 * docutils/parsers/rst/directives/body.py:
475 - Added the "container" directive.
477 * docutils/parsers/rst/directives/misc.py:
479 - Added the "default-role", "title", and "date" directives.
480 - Added standard data file syntax to the "include" directive.
481 - Added support for "class" directive content.
483 * docutils/parsers/rst/directives/images.py:
485 - Added ``indirect_reference_name`` support for images with a target
487 - Added support for image width and height units.
488 - Fixed bug with image "target" options.
490 * docutils/parsers/rst/directives/references.py:
492 - Added "class" attribute to "target-notes" directive, for
493 footnote_reference classes.
495 * docutils/parsers/rst/include/: Directory added to project; contains
496 standard data files for the "include" directive. Initial contents:
497 character entity substitution definition sets, and a set of
498 definitions for S5/HTML presentations.
500 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
501 mappings by David Goodger.
503 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
504 Simplified Chinese mappings by Panjunyong.
506 * docutils/readers/__init__.py:
508 - Added universal.Decorations and universal.ExposeInternals
509 transforms as default transforms for all readers.
510 - Added ``ReReader`` base class for readers that reread an existing
513 * docutils/readers/doctree.py: Added to project; a reader for existing
516 * docutils/transforms/frontmatter.py:
518 - Fixed the DocInfo transform to handle SVN-style expansion of the
520 - In ``DocInfo.extract_authors``, treat the contents of "authors"
523 * docutils/transforms/misc.py:
525 - Added misc.Transitions transform, extracted from
526 universal.FinalChecks.
528 * docutils/transforms/references.py:
530 - Added references.DanglingReferences transform, extracted from
531 universal.FinalChecks.
532 - Fixed bug with doubly-indirect substitutions.
533 - Added footnote_reference classes attribute to "TargetNotes".
534 - Fixed bug with circular substitution definitions that put Docutils
535 into an infinite loop.
537 * docutils/transforms/universal.py:
539 - Added universal.ExposeInternals transform, extracted from
540 universal.FinalChecks.
541 - Removed universal.FinalChecks transform (logic has been moved to
542 several new transforms).
543 - Fixed bug with the "expose_internals" setting and Text nodes
544 (exposed by the "rawsource" internal attribute).
545 - Added the universal.StripComments transform, implementation of the
546 "strip_comments" setting.
548 * docutils/transforms/writer_aux.py: Added to project; auxiliary
549 transforms for writers.
551 - Added ``Compound`` transform, which flattens compound paragraphs.
553 * docutils/writers/: Several writer modules (html4css1.py) were
554 converted into packages. Support modules and data files have been
555 moved into the packages. The stylesheets for the HTML writers are
556 now installed along with the code, the code knows where to find
557 them, and the default is to use them (actually, to embed them).
558 Some adjustments to configuration files may be necessary. The
559 easiest way to obtain the new default behavior is to remove all
560 settings whose name includes "stylesheet".
562 * docutils/writers/__init__.py:
564 - Added universal.Messages and universal.FilterMessages transforms
565 as default transforms for all writers.
566 - Added ``UnfilteredWriter`` base class for writers that pass the
567 document tree on unchanged.
569 * docutils/writers/docutils_xml.py:
571 - Made ``xmlcharrefreplace`` the default output encoding error
574 * docutils/writers/html4css1/:
576 - Added support for image width and height units.
577 - Made ``xmlcharrefreplace`` the default output encoding error
579 - Made ``--embed-stylesheet`` the default rather than
580 ``--link-stylesheet``.
581 - Moved "id" attribute from container (section etc.) to title's <a>
582 tag, to be on the same tag as "name".
583 (!!! To be reverted in Docutils 0.5.)
584 - Added vertical space between fields of field lists.
585 - Added ``--compact-field-lists`` option to remove vertical space in
587 - Made cloaking of email addresses with ``--cloak-email-addresses``
589 - Fixed support for centered images.
590 - Added support for class="compact" & class="open" lists.
592 * docutils/writers/latex2e/:
594 - Underscores in citekeys are no longer escaped.
596 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
597 mapping of Unicode characters to LaTeX equivalents.
599 * docutils/writers/s5_html/: Package added to project; writer for
602 * docs/dev/distributing.txt: Added to project; guide for distributors
603 (package maintainers).
605 * docs/dev/hacking.txt: Added to project; guide for developers.
607 * docs/ref/doctree.txt:
609 - Updated for plural attributes "classes", "ids", "names",
611 - Added the "container" element.
613 * docs/ref/docutils.dtd:
615 - Updated for plural attributes "classes", "ids", "names",
618 * docs/user/emacs.txt: Added to project; a document about Emacs
619 support for reStructuredText and Docutils.
621 * docs/user/links.txt: Added to project; lists of Docutils-related
624 * docs/user/mailing-lists.txt: Added to project; information about
625 Docutils-related mailing lists and how to access them.
627 * docs/user/slide-shows.txt: Added to project; example of and docs for
628 the S5/HTML writer (``rst2s5.py`` front end).
630 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
631 Files", added to project.
633 * test/coverage.sh: Added to project; test coverage script.
635 * test/DocutilsTestSupport.py:
637 - Added support for specifying runtime settings at the suite level.
639 * test/test_functional.py:
641 - Added the ``clear_output_directory`` function.
642 - Added support for ``_test_more`` functions in functional test
645 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
647 * tools/rstpep2html.py: Renamed from pep.py.
649 * tools/dev/create_unimap.py: Added to project; script to create the
650 docutils/writers/unimap_latex.py mapping file.
652 * tools/dev/profile_docutils.py: Added to project; profiler script.
654 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
656 * tools/editors/emacs/restructuredtext.el,
657 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
658 Removed from project; the functionality is now contained in rst.el.
660 * tools/editors/emacs/rst.el: Added to project. Added many features
661 and fixed many bugs. See docs/user/emacs.txt for details.
663 * tools/stylesheets: Removed from project. Stylesheets have been
664 renamed and moved into writer packages.
667 Release 0.3.9 (2005-05-26)
668 ==========================
672 - Eliminated and replaced all uses of the old string attributes
673 ``id``, ``name``, ``dupname`` and ``class`` with references to the
674 new list attributes ``ids``, ``names``, ``dupnames`` and
675 ``classes`` throughout the whole source tree.
679 - Enabled ``--dump-*`` options when ``--traceback`` specified,
680 allowing for easier debugging.
681 - In ``Publisher.publish()``, expanded the generic top-level
684 * docutils/examples.py:
686 - Added ``internals`` function for exploration.
690 - Fixed ``Input.decode`` method to apply heuristics only if no
691 encoding is explicitly given, and to provide better reporting of
693 - The ``Input.decode`` method now removes byte order marks (BOMs)
698 - ``image`` element class changed to subclass of Element, not
699 TextElement (it's an empty element, and cannot contain text).
700 - Added ``attr_defaults`` dictionary for default attribute values.
701 - Added empty list as default value for the following attributes:
702 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
703 - Added ``document.decoration`` attribute,
704 ``document.get_decoration`` method, and ``decoration.get_header``
705 & ``.get_footer`` methods.
706 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
711 - Removed ``docutils.utils.Reporter.categories``,
712 ``docutils.utils.ConditionSet``, and all references to them, to
713 simplify error reporting.
715 * docutils/languages/nl.py: Added to project; Dutch mappings by
718 * docutils/parsers/rst/__init__.py:
720 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
722 * docutils/parsers/rst/states.py:
724 - Added check for escaped at-mark to prevent email address recognition.
725 - Fixed option lists to allow spaces inside ``<angle-bracketed option
727 - Allowed whitespace in paths and URLs.
728 - Added auto-enumerated list items.
729 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
731 - Added support for table stub columns.
733 * docutils/parsers/rst/directives/__init__.py:
735 - Allowed whitespace in paths (``path`` function).
736 - Added ``uri`` directive option conversion function.
738 * docutils/parsers/rst/directives/body.py:
740 - Fixed illegal context bug with "topic" directive (allowed within
741 sidebars; not within body elements).
743 * docutils/parsers/rst/directives/images.py:
745 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
746 - Added support for the ``file_insertion_enabled`` setting in the
747 "figure" directive (disables "figwidth" option).
748 - "image" directive: added checks for valid values of "align" option,
749 depending on context. "figure" directive: added specialized
750 "align" option and attribute on "figure" element.
751 - Made ":figwidth: image" option of "figure" directive work again.
752 - Fixed bug with reference names containing uppercase letters
753 (e.g. ``Name_``) in "target" option of "image" directive.
755 * docutils/parsers/rst/directives/misc.py:
757 - Fixed "include" and "raw" directives to catch text decoding
759 - Allowed whitespace in "include" & "raw" directive paths.
760 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
761 settings in "include" & "raw" directives.
763 * docutils/parsers/rst/directives/parts.py:
765 - Added "header" & "footer" directives.
766 - Fixed illegal context bug with "contents" directive (topics
767 allowed within sidebars; not within body elements).
769 * docutils/parsers/rst/directives/tables.py:
771 - Added "list-table" directive.
772 - Caught empty CSV table bug.
773 - Added support for the ``file_insertion_enabled`` setting in the
774 "csv-table" directive.
775 - Added ``stub-columns`` option to "csv-table" and "list-table"
778 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
779 mappings by Martijn Pieters.
781 * docutils/readers/standalone.py:
783 - Added ``--section-subtitles`` and ``--no-section-subtitles``
784 options to activate or deactivate the SectSubTitle transform.
786 * docutils/transforms/frontmatter.py:
788 - Added SectSubTitle transform to promote titles of lone
789 subsections to subtitles.
791 * docutils/transforms/references.py:
793 - Fixed mislocated internal targets bug, by propagating internal
794 targets to the next node, making use of the newly added support
795 for multiple names and IDs.
796 - Fixed duplicate footnote label bug.
797 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
800 * docutils/writers/html4css1.py:
802 - Fixed unencoded stylesheet reference bug (characters like "&" in
803 stylesheet references).
804 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
806 - Added support for multiple IDs per node by creating empty ``span``
808 - Added the ``field_name_limit`` & ``option_limit`` settings &
810 - Added support for table stub columns.
811 - Added support for the ``align`` attribute on ``figure`` elements.
812 - Added the ``cloak_email_addresses`` setting & support.
813 - Added ``html_prolog``, ``html_head``, ``html_body``,
814 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
815 ``docutils.core.publish_parts``.
816 - Added support for section subtitles.
818 * docutils/writers/latex2e.py:
820 - Fixed tables starting with more than one multirow cell.
821 - Improved --use-latex-docinfo so that organization/contact/address
822 fields are lumped with the last author field and appear on the
824 - Made sure the titlepage is always shown with --use-latex-docinfo,
825 even if the document has no title.
826 - Made sure that latex doesn't fill in today's date if no date field
828 - Added support for section subtitles.
830 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
833 * docutils/writers/null.py: Added to project; a do-nothing Writer.
835 * docs/api/publisher.txt:
837 - Added "``publish_parts`` Details" section.
839 * docutils/dev/repository.txt: Added to project; information about the
840 Docutils Subversion repository.
842 * docs/ref/docutils.dtd:
844 - Added a ``stub`` attribute to the ``colspec`` element via the
845 ``tbl.colspec.att`` parameter entity.
846 - Allowed topic elements within sidebars
847 - Added an ``align`` attribute to the ``figure`` element.
849 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
853 Release 0.3.7 (2004-12-24)
854 ==========================
856 * docutils/frontend.py:
858 - Added options: --input-encoding-error-handler,
859 --record-dependencies, --leave-footnote-reference-space,
861 - Added command-line and config file support for "overrides" setting
866 - Added support for input encoding error handler.
870 - Added dispatch_visit and dispatch_departure methods to
871 NodeVisitor; useful as a hook for Visitors.
872 - Changed structure of ``line_block``; added ``line``.
873 - Added ``compound`` node class.
874 - Added a mechanism for Visitors to transitionally ignore new node
879 - Moved ``escape2null`` and ``unescape`` functions from
880 docutils/parsers/rst/states.py.
882 * docutils/parsers/rst/roles.py:
885 - Changed role function API: the "text" parameter now takes
886 null-escaped interpreted text content.
888 * docutils/parsers/rst/states.py:
890 - Fixed bug where a "role" directive in a nested parse would crash
891 the parser; the state machine's "language" attribute was not being
893 - Added support for line block syntax.
894 - Fixed directive parsing bug: argument-less directives didn't
895 notice that arguments were present.
896 - Removed error checking for transitions.
897 - Added support for multiple classifiers in definition list items.
898 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
899 - Changed role function API: the "text" parameter now takes
900 null-escaped interpreted text content.
901 - Empty sections and documents are allowed now.
903 * docutils/parsers/rst/directives/__init__.py:
905 - Added ``encoding`` directive option conversion function.
906 - Allow multiple class names in class_option conversion function.
908 * docutils/parsers/rst/directives/body.py:
910 - Converted the line-block directive to use the new structure.
911 - Extracted the old line-block functionality to the ``block``
912 function (still used).
913 - Added ``compound`` directive (thanks to Lea Wiemann).
915 * docutils/parsers/rst/directives/misc.py:
917 - Added "encoding" option to "include" and "raw" directives.
918 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
919 - Allow multiple class names in the "class" directive.
921 * docutils/parsers/rst/directives/parts.py:
923 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
924 options. Thanks to Lele Gaifax.
926 * docutils/parsers/rst/directives/tables.py:
928 - Added "encoding" directive to "csv-table" directive.
929 - Added workaround for lack of Unicode support in csv.py, for
932 * docutils/transforms/misc.py:
934 - Fixed bug when multiple "class" directives are applied to a single
936 - Enabled multiple format names for "raw" directive.
938 * docutils/transforms/references.py:
940 - Added support for trimming whitespace from beside substitution
943 * docutils/transforms/universal.py:
945 - FinalChecks now checks for illegal transitions and moves
946 transitions between sections.
948 * docutils/writers/html4css1.py:
950 - HTMLTranslator.encode now converts U+00A0 to " ".
951 - "stylesheet" and "stylesheet_path" settings are now mutually
953 - Added support for the new line_block/line structure.
954 - --footnote-references now overrides
955 --trim-footnote-reference-space, if applicable.
956 - Added support for ``compound`` elements.
957 - Enabled multiple format names for "raw" directive.
958 - ``<p>`` tags of a paragraph which is the only visible child of the
959 document node are no longer stripped.
960 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
961 new method ``should_be_compact_paragraph()``.
962 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
964 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
965 the output if they have their ``class`` attribute set.
966 - The whole document is now surrounded by a ``<div
967 class="document">`` element.
968 - Body-level images are now wrapped by their own ``<div>`` elements,
969 with image classes copied to the wrapper, and for images which
970 have the ``:align:`` option set, the surrounding ``<div>`` now
971 receives a class attribute (like ``class="align-left"``).
973 * docutils/writers/latex2e.py:
975 - no newline after depart_term.
976 - Added translations for some Unicode quotes.
977 - Added option "font-encoding", made package AE the default.
978 - "stylesheet" and "stylesheet_path" settings are now mutually
980 - --footnote-references now overrides
981 --trim-footnote-reference-space, if applicable.
982 - The footnote label style now matches the footnote reference style
983 ("brackets" or "superscript").
984 - Added support for ``compound`` elements.
985 - Enabled multiple format names for "raw" directive.
987 * docs/ref/docutils.dtd:
989 - Changed structure of the ``line_block`` element; added ``line``.
990 - Added ``compound`` element.
991 - Added "ltrim" and "rtrim" attributes to
992 ``substitution_definition`` element.
993 - Enabled multiple format names for ``raw`` element.
994 - Enabled multiple classifiers in ``definition_list_item`` elements.
996 * docs/ref/rst/directives.txt
998 - Marked "line-block" as deprecated.
999 - "Class" directive now allows multiple class names.
1000 - Added "Rationale for Class Attribute Value Conversion".
1001 - Added warning about "raw" overuse/abuse.
1003 * docs/ref/rst/restructuredtext.txt:
1005 - Added syntax for line blocks.
1006 - Definition list items may have multiple classifiers.
1008 * docs/ref/rst/roles.txt:
1012 * tools/stylesheets/default.css:
1014 - Added support for the new line_block structure.
1015 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1018 Release 0.3.5 (2004-07-29)
1019 ==========================
1023 * _`Documentation cleanup/reorganization`.
1025 - Created new subdirectories of docs/:
1027 * ``docs/user/``: introductory/tutorial material for end-users
1028 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1029 * ``docs/api/``: API reference material for client-developers
1030 * ``docs/ref/``: reference material for all groups
1031 * ``docs/howto/``: for component-developers and core-developers
1032 * ``docs/peps/``: Python Enhancement Proposals
1034 - Moved ``docs/*`` to ``docs/user/``.
1035 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1036 ``spec/`` to ``docs/dev``.
1037 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1038 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1039 - Moved ``alternatives.txt``, and ``problems.txt`` from
1040 ``spec/rst/`` to ``docs/dev/rst/``.
1041 - Moved ``reStructuredText.txt``, ``directives.txt``,
1042 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1043 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1044 ``roles.txt``, ``reStructuredText.txt`` to
1045 ``restructuredtext.txt``.
1046 - Moved ``spec/howto/`` to ``docs/howto``.
1048 In order to keep the CVS history of moved files, we supplied
1049 SourceForge with a `script for modifying the Docutils CVS
1052 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1054 After running the cleanup script:
1056 - Added ``docs/index.txt``.
1057 - Added a ``.htaccess`` file to the ``web`` module, containing
1058 redirects for all old paths to new paths. They'll preserve
1059 fragments (the "#name" part of a URL), and won't clutter up the
1060 file system, and will correct the URL in the user's browser.
1061 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1062 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1063 the "To Do" list itself in ``docs/dev/todo.txt``.
1064 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1065 section of ``docs/dev/todo.txt``.
1066 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1067 - Added "How To Report Bugs" to ``BUGS.txt``.
1068 - Went through all the sources and docs (including under web/) and
1069 updated links. Mostly done by Lea Wiemann; thanks Lea!
1070 (Still need to update links in the sandboxes.)
1074 * BUGS.txt: Added to project.
1076 * THANKS.txt: Added to project.
1078 * docutils/__init__.py:
1080 - 0.3.4: Post-release.
1084 - Added special error handling & advice for UnicodeEncodeError.
1085 - Refactored Publisher.publish (simplified exception handling &
1086 extracted debug dumps).
1087 - Renamed "enable_exit" parameter of convenience functions to
1088 "enable_exit_status".
1089 - Enabled traceback (exception propagation) by default in
1090 programmatic convenience functions.
1091 - Now publish_file and publish_cmdline convenience functions return
1092 the encoded string results in addition to their regular I/O.
1093 - Extracted common code from publish_file, publish_string, and
1094 publish_parts, into new publish_programmatically. Extracted
1095 settings code to ``Publisher.process_programmatic_settings``.
1096 - In Publisher.publish, disabled ``settings_overrides`` when
1097 ``settings`` is supplied; redundant.
1099 * docutils/frontend.py:
1101 - Added help text for "--output-encoding-error-handler" and
1102 "--error-encoding-error-handler".
1103 - Renamed "--exit" to "--exit-status".
1104 - Simplified default-setting code.
1106 * docutils/parsers/rst/__init__.py:
1108 - Added "--pep-base-url" and "--rfc-base-url" options.
1110 * docutils/parsers/rst/states.py:
1112 - Made URI recognition more aggressive and intelligent.
1114 * docutils/parsers/rst/directives/__init__.py:
1116 - Added several directive option conversion functions.
1118 * docutils/parsers/rst/directives/body.py:
1120 - Moved "table" directive to tables.py.
1122 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1125 * docutils/writers/latex2e.py:
1127 - Added "--table-style=(standard|booktabs|nolines)"
1128 - figures get "here" option (LaTeX per default puts them at bottom),
1129 and figure content is centered.
1130 - Rowspan support for tables.
1131 - Fix: admonition titles before first section.
1132 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1133 - Replave ``_`` in literal by an underlined blank, because it has the correct
1135 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1136 - A few unicode replacements, if output_encoding != utf
1137 - Add "--graphicx-option".
1138 - Indent literal-blocks.
1139 - Fix: omit ``\maketitle`` when there is no document title.
1141 * docs/index.txt: "Docutils Project Documentation Overview", added to
1144 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1145 Tool", added to project.
1147 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1149 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1151 * docs/dev/policies.txt: Added to project (extracted from
1152 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1154 * docs/dev/release.txt: Added to project (extracted from
1155 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1157 * docs/dev/testing.txt: Added to project.
1159 * docs/dev/website.txt: Added to project (extracted from
1160 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1162 * docs/ref/rst/directives.txt:
1164 - Added directives: "table", "csv-table".
1166 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1167 added to project. 1 page for syntax, and a 1 page reference for
1168 directives and roles. Source text to be used as-is; not meant to be
1171 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1172 with a change of title.
1174 * test/functional/, contents, and test/test_functional.py: Added to
1177 * tools/buildhtml.py: Fixed bug with config file handling.
1179 * tools/html.py: Removed from project (duplicate of rst2html.py).
1181 * tools/pep2html.py: Removed from project (duplicate of Python's
1182 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1183 Docutils-related PEPs in docs/peps/).
1185 * tools/rst2pseudoxml.py: Renamed from publish.py.
1187 * tools/rst2xml.py: Renamed from docutils-xml.py.
1189 * tools/test.txt: Removed from project; moved to
1190 docs/user/rst/demo.txt.
1192 * setup.py: Now also installs ``rst2latex.py``.
1195 Release 0.3.3 (2004-05-09)
1196 ==========================
1198 * docutils/__init__.py:
1200 - 0.3.1: Reorganized config file format (multiple sections); see
1202 - Added unknown_reference_resolvers attribute to TransformSpec.
1203 - 0.3.2: Interpreted text reorganization.
1208 - Catch system messages to stop tracebacks from parsing errors.
1209 - Catch exceptions during processing report & exit without
1210 tracebacks, except when "--traceback" used.
1211 - Reordered components for OptionParser; application comes last.
1212 - Added "config_section" parameter to several methods and functions,
1213 allowing front ends to easily specify their config file sections.
1214 - Added publish_parts convenience function to allow access to individual
1215 parts of a document.
1217 * docutils/examples.py: Added to project; practical examples of
1218 Docutils client code, to be used as-is or as models for variations.
1220 * docutils/frontend.py:
1222 - Added "--traceback" & "--no-traceback" options ("traceback"
1224 - Implemented support for config file reorganization:
1225 ``standard_config_files`` moved from ``ConfigParser`` to
1226 ``OptionParser``; added
1227 ``OptionParser.get_config_file_settings()`` and
1228 ``.get_standard_config_settings()``; support for old "[options]"
1229 section (with deprecation warning) and mapping from old to new
1231 - Reimplemented setting validation.
1232 - Enabled flexible boolean values: yes/no, true/false, on/off.
1233 - Added ``Values``, a subclass of ``optparse.Values``, with support
1234 for list setting attributes.
1235 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1236 thanks to Beni Cherniavsky.
1237 - Added "--no-section-numbering" option.
1241 - Catch IOErrors when opening source & destination files, report &
1242 exit without tracebacks. Added ``handle_io_errors`` parameter to
1243 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1245 * docutils/nodes.py:
1247 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1248 method definitions (via ``exec``) to dynamic assignments (via
1249 ``setattr``); thanks to Roman Suzi.
1250 - Encapsulated visitor dynamic assignments in a function; thanks to
1252 - Added indirect_reference_name attribute to the Targetable
1253 class. This attribute holds the whitespace_normalized_name
1254 (contains mixed case) of a target.
1256 * docutils/statemachine.py:
1258 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1259 - Added ``StringList.get_2D_block``.
1261 * docutils/utils.py:
1263 - Added "level" attribute to SystemMessage exceptions.
1265 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1268 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1271 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1272 Marcelo Huerta San Martin.
1274 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1275 mappings by Lalo Martins.
1277 * docutils/languages/ru.py: Added to project; Russian mappings by
1280 * docutils/parsers/rst/roles.py: Added to project. Contains
1281 interpreted text role functions, a registry for interpreted text
1282 roles, and an API for adding to and retrieving from the registry.
1283 Contributed by Edward Loper.
1285 * docutils/parsers/rst/states.py:
1287 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1288 - Allowed true em-dash character and "---" as block quote
1290 - Added support for <angle-bracketed> complex option arguments
1292 - Fixed handling of backslashes in substitution definitions.
1293 - Fixed off-by-1 error with extra whitespace after substitution
1294 definition directive.
1295 - Added inline markup parsing to field lists' field names.
1296 - Added support for quoted (and unindented) literal blocks.
1297 Driven in part by a bribe from Frank Siebenlist (thanks!).
1298 - Parser now handles escapes in URIs correctly.
1299 - Made embedded-URIs' reference text omittable. Idea from Beni
1301 - Refactored explicit target processing code.
1302 - Added name attribute to references containing the reference name only
1303 through whitespace_normalize_name (no case changes).
1304 - parse_target no longer returns the refname after going through
1305 normalize_name. This is now handled in make_target.
1306 - Fixed bug relating to role-less interpreted text in non-English
1308 - Reorganized interpreted text processing; moved code into the new
1309 roles.py module. Contributed by Edward Loper.
1310 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1311 ``parse_directive_block``.
1313 * docutils/parsers/rst/tableparser.py:
1315 - Reworked for ``StringList``, to support "include" directives in
1318 * docutils/parsers/rst/directives/__init__.py:
1320 - Renamed ``unchanged()`` directive option conversion function to
1321 ``unchanged_required``, and added a new ``unchanged``.
1322 - Catch unicode value too high error; fixes bug 781766.
1323 - Beefed up directive error reporting.
1325 * docutils/parsers/rst/directives/body.py:
1327 - Added basic "table" directive.
1329 * docutils/parsers/rst/directives/images.py:
1331 - Added "target" option to "image" directive.
1332 - Added name attribute to references containing the reference name only
1333 through whitespace_normalize_name (no case changes).
1335 * docutils/parsers/rst/directives/misc.py:
1337 - Isolated the import of the ``urllib2`` module; was causing
1338 problems on SourceForge (``libssl.so.2`` unavailable?).
1339 - Added the "role" directive for declaring custom interpreted text
1342 * docutils/parsers/rst/directives/parts.py:
1344 - The "contents" directive does more work up-front, creating the
1345 "topic" and "title", and leaving the "pending" node for the
1346 transform. Allows earlier reference resolution; fixes subtle bug.
1348 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1349 mappings by Jannie Hofmeyr.
1351 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1352 mappings by Marek Blaha.
1354 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1355 mappings by Marcelo Huerta San Martin.
1357 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1358 Portuguese mappings by Lalo Martins.
1360 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1361 mappings by Roman Suzi.
1363 * docutils/transforms/parts.py:
1365 - The "contents" directive does more work up-front, creating the
1366 "topic" and "title", and leaving the "pending" node for the
1367 transform. Allows earlier reference resolution; fixes subtle bug.
1368 - Added support for disabling of section numbering.
1370 * docutils/transforms/references.py:
1372 - Verifying that external targets are truly targets and not indirect
1373 references. This is because we are now adding a "name" attribute to
1374 references in addition to targets. Note sure if this is correct!
1375 - Added code to hook into the unknown_reference_resolvers list for a
1376 transformer in resolve_indirect_target. This allows the
1377 unknown_reference_resolvers to keep around indirect targets which
1378 docutils doesn't know about.
1379 - Added specific error message for duplicate targets.
1381 * docutils/transforms/universal.py:
1383 - Added FilterMessages transform (removes system messages below the
1384 verbosity threshold).
1385 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1386 to FinalCheckVisitor for application-specific handling of
1387 unresolvable references.
1388 - Added specific error message for duplicate targets.
1390 * docutils/writers/__init__.py:
1392 - Added assemble_parts method to the Writer class to allow for
1393 access to a documents individual parts.
1394 - Documented & set default for ``Writer.output`` attribute.
1396 * docutils/writers/html4css1.py:
1398 - Fixed unicode handling of attribute values (bug 760673).
1399 - Prevent duplication of "class" attribute values (bug report from
1401 - Improved table grid/border handling (prompted by report from Bob
1403 - Added support for table titles.
1404 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1406 - Added functionality to keep track of individual parts of a document
1407 and store them in a dictionary as the "parts" attribute of the writer.
1408 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1409 - Added proper support for the "scale" attribute of the "image"
1410 element. Contributed by Brent Cook.
1411 - Added ``--initial-header-level`` option.
1412 - Fixed bug: the body_pre_docinfo segment depended on there being a
1413 docinfo; if no docinfo, the document title was incorporated into
1414 the body segment. Adversely affected the publish_parts interface.
1416 * docutils/writers/latex2e.py:
1418 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1419 about a missing file.
1420 - Added options and support: ``--compound-enumerators``,
1421 ``--section-prefix-for-enumerators``, and
1422 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1424 - Added option ``--use-verbatim-when-possible``, to avoid
1425 problematic characters (eg, '~' in italian) in literal blocks.
1426 - It's now possible to use four section levels in the `book` and
1427 `report` LaTeX classes. The default `article` class still has
1430 * docs/config.txt: "Docutils Configuration Files", added to project.
1431 Moved config file entry descriptions from tools.txt.
1435 - Moved config file entry descriptions to config.txt.
1437 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1440 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1441 Text Roles", added to project.
1443 * spec/rst/reStructuredText.txt:
1445 - Added description of support for <angle-bracketed> complex option
1446 arguments to option lists.
1447 - Added subsections for indented and quoted literal blocks.
1449 * test: Continually adding & updating tests.
1451 - Added test/test_settings.py & test/data/config_*.txt support
1453 - Added test/test_writers/test_htmlfragment.py.
1455 * test/DocutilsTestSupport.py:
1457 - Refactored LaTeX publisher test suite/case class names to make
1458 testing other writers easier.
1459 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1460 to test the processing of HTML fragments which use the new
1461 publish_parts convenience function.
1463 * tools/buildhtml.py:
1465 - Added support for the "--prune" option.
1466 - Removed dependency on pep2html.py; plaintext PEPs no longer
1469 * tools/docutils.conf:
1471 - Updated for configuration file reorganization.
1473 * tools/rst2html.py:
1475 - copied from tools/html.py
1479 - added a 'scripts' section to configuration
1480 - added 'tools/rst2html.py' to the scripts section
1483 Release 0.3 (2003-06-24)
1484 ========================
1488 * Renamed "attribute" to "option" for directives/extensions.
1490 * Renamed transform method "transform" to "apply".
1492 * Renamed "options" to "settings" for runtime settings (as set by
1493 command-line options). Sometimes "option" (singular) became
1494 "settings" (plural). Some variations below:
1496 - document.options -> document.settings (stored in other objects as
1498 - option_spec -> settings_spec (not directives though)
1499 - OptionSpec -> SettingsSpec
1500 - cmdline_options -> settings_spec
1501 - relative_path_options -> relative_path_settings
1502 - option_default_overrides -> settings_default_overrides
1503 - Publisher.set_options -> Publisher.get_settings
1507 * COPYING.txt: Added "Public Domain Dedication".
1509 * FAQ.txt: Frequently asked questions, added to project.
1513 - Updated with PyPI Trove classifiers.
1514 - Conditional installation of third-party modules.
1516 * docutils/__init__.py:
1518 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1519 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1520 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1521 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1522 option and its effect on the PEP template & writer.
1523 - Bumped version to 0.2.4 due to changes to the PEP template &
1525 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1526 - Added ``TransformSpec`` class for new transform system.
1527 - Bumped version to 0.2.6 for API changes (renaming).
1528 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1529 convenience functions.
1530 - Added ``Component.component_type`` attribute.
1531 - Bumped version to 0.2.8 because of the internal parser switch from
1532 plain lists to the docutils.statemachine.StringList objects.
1533 - Bumped version to 0.2.9 because of the frontend.py API changes.
1534 - Bumped version to 0.2.10 due to changes to the project layout
1535 (third-party modules removed from the "docutils" package), and
1536 signature changes in ``io.Input``/``io.Output``.
1537 - Changed version to 0.3.0 for release.
1541 - Made ``publish()`` a bit more convenient.
1542 - Generalized ``Publisher.set_io``.
1543 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1544 parameters; improved its docstring.
1545 - Added ``publish_file()`` and ``publish_string()``.
1546 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1548 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1549 "--dump-transforms" hidden options.
1550 - Added ``Publisher.apply_transforms()`` method.
1551 - Added ``Publisher.set_components()`` method; support for
1552 ``publish_*()`` conveninece functions.
1553 - Moved config file processing to docutils/frontend.py.
1554 - Added support for exit status ("exit_level" setting &
1555 ``enable_exit`` parameter for Publisher.publish() and convenience
1558 * docutils/frontend.py:
1560 - Check for & exit on identical source & destination paths.
1561 - Fixed bug with absolute paths & "--config".
1562 - Set non-command-line defaults in ``OptionParser.__init__()``:
1563 ``_source`` & ``_destination``.
1564 - Distributed ``relative_path_settings`` to components; updated
1565 ``OptionParser.populate_from_components()`` to combine it all.
1566 - Require list of keys in ``make_paths_absolute`` (was implicit in
1567 global ``relative_path_settings``).
1568 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1569 "--dump-settings", and "--dump-transforms" hidden options.
1570 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1571 code, replaced with correct code.
1572 - Added validation functionality for config files.
1573 - Added "--error-encoding" option/setting, "_disable_config"
1575 - Added encoding validation; updated "--input-encoding" and
1576 "--output-encoding"; added "--error-encoding-error-handler" and
1577 "--output-encoding-error-handler".
1578 - Moved config file processing from docutils/core.py.
1579 - Updated ``OptionParser.populate_from_components`` to handle new
1580 ``SettingsSpec.settings_defaults`` dict.
1581 - Added support for "-" => stdin/stdout.
1582 - Added "exit_level" setting ("--exit" option).
1586 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1587 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1588 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1589 - ``FileOutput.write()`` now returns the encoded output string.
1590 - Try to get path/stream name automatically in ``FileInput`` &
1592 - Added defaults for source & destination paths.
1593 - Allow for Unicode I/O with an explicit "unicode" encoding.
1594 - Added ``Output.encode()``.
1595 - Removed dependency on runtime settings; pass encoding directly.
1596 - Recognize Unicode strings in ``Input.decode()``.
1597 - Added support for output encoding error handlers.
1599 * docutils/nodes.py:
1601 - Added "Invisible" element category class.
1602 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1603 modification during a traversal.
1604 - Added element classes: ``line_block``, ``generated``, ``address``,
1605 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1606 ``superscript``, ``subscript``, ``inline``
1607 - Added support for lists of nodes to ``Element.insert()``.
1608 - Fixed parent linking in ``Element.replace()``.
1609 - Added new abstract superclass ``FixedTextElement``; adds
1610 "xml:space" attribute.
1611 - Added support for "line" attribute of ``system_message`` nodes.
1612 - Added support for the observer pattern from ``utils.Reporter``.
1613 Added ``parse_messages`` and ``transform_messages`` attributes to
1614 ``document``, removed ``messages``. Added ``note_parse_message``
1615 and ``note_transform_message`` methods.
1616 - Added support for improved diagnostics:
1618 - Added "document", "source", and "line" internal attributes to
1619 ``Node``, set by ``Node.setup_child()``.
1620 - Converted variations on ``node.parent = self`` to
1621 ``self.setup_child(node)``.
1622 - Added ``document.current_source`` & ``.current_line``
1623 attributes, and ``.note_source`` observer method.
1624 - Changed "system_message" output to GNU-Tools format.
1626 - Added a "rawsource" attribute to the ``Text`` class, for text
1627 before backslash-escape resolution.
1628 - Support for new transform system.
1629 - Reworked ``pending`` element.
1630 - Fixed XML DOM bug (SF #660611).
1631 - Removed the ``interpeted`` element class and added
1632 ``title_reference``, ``abbreviation``, ``acronym``.
1633 - Made substitutions case-sensitive-but-forgiving; moved some code
1635 - Fixed Unicode bug on element attributes (report: William Dode).
1637 * docutils/optik.py: Removed from project; replaced with
1638 extras/optparse.py and extras/textwrap.py. These will be installed
1639 only if they're not already present in the Python installation.
1641 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1642 only if it's not already present in the Python installation.
1644 * docutils/statemachine.py:
1646 - Factored out ``State.add_initial_transitions()`` so it can be
1648 - Converted whitespace-specific "blank" and "indent" transitions
1649 from special-case code to ordinary transitions: removed
1650 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1651 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1652 ``ws_initial_transitions`` attributes.
1653 - Removed ``State.match_transition()`` after merging it into
1655 - Added ``StateCorrection`` exception.
1656 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1657 (moved ``TransitionCorrection`` support there too.)
1658 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1659 ``EOFError`` instead of ``IndexError``.
1660 - Added ``State.no_match`` method.
1661 - Added support for the Observer pattern, triggered by input line
1663 - Added ``strip_top`` parameter to
1664 ``StateMachineWS.get_first_known_indented``.
1665 - Made ``context`` a parameter to ``StateMachine.run()``.
1666 - Added ``ViewList`` & ``StringList`` classes;
1667 ``extract_indented()`` becomes ``StringList.get_indented()``.
1668 - Added ``StateMachine.insert_input()``.
1669 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1670 thanks to) Fred Drake.
1672 * docutils/utils.py:
1674 - Added a ``source`` attribute to Reporter instances and
1675 ``system_message`` elements.
1676 - Added an observer pattern to ``utils.Reporter`` to keep track of
1678 - Fixed bugs in ``relative_path()``.
1679 - Added support for improved diagnostics.
1680 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1681 - Added support for encoding Reporter stderr output, and encoding
1683 - Reporter keeps track of the highest level system message yet
1686 * docutils/languages: Fixed bibliographic field language lookups.
1688 * docutils/languages/es.py: Added to project; Spanish mappings by
1689 Marcelo Huerta San Martin.
1691 * docutils/languages/fr.py: Added to project; French mappings by
1694 * docutils/languages/it.py: Added to project; Italian mappings by
1697 * docutils/languages/sk.py: Added to project; Slovak mappings by
1700 * docutils/parser/__init__.py:
1702 - Added ``Parser.finish_parse()`` method.
1704 * docutils/parser/rst/__init__.py:
1706 - Added options: "--pep-references", "--rfc-references",
1707 "--tab-width", "--trim-footnote-reference-space".
1709 * docutils/parsers/rst/states.py:
1711 - Changed "title under/overline too short" system messages from INFO
1712 to WARNING, and fixed its insertion location.
1713 - Fixed enumerated list item parsing to allow paragraphs & section
1714 titles to begin with enumerators.
1715 - Converted system messages to use the new "line" attribute.
1716 - Fixed a substitution reference edge case.
1717 - Added support for "--pep-references" and "--rfc-references"
1718 options; reworked ``Inliner`` code to make customization easier.
1719 - Removed field argument parsing.
1720 - Added support for short section title over/underlines.
1721 - Fixed "simple reference name" regexp to ignore text like
1722 "object.__method__"; not an anonymous reference.
1723 - Added support for improved diagnostics.
1724 - Reworked directive API, based on Dethe Elza's contribution. Added
1725 ``Body.parse_directive()``, ``.parse_directive_options()``,
1726 ``.parse_directive_arguments()`` methods.
1727 - Added ``ExtensionOptions`` class, to parse directive options
1728 without parsing field bodies. Factored
1729 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1730 ``ExtensionOptions``.
1731 - Improved definition list term/classifier parsing.
1732 - Added warnings for unknown directives.
1733 - Renamed ``Stuff`` to ``Struct``.
1734 - Now flagged as errors: transitions at the beginning or end of
1735 sections, empty sections (except title), and empty documents.
1736 - Updated for ``statemachine.StringList``.
1737 - Enabled recognition of schemeless email addresses in targets.
1738 - Added support for embedded URIs in hyperlink references.
1739 - Added backslash-escapes to inline markup end-string suffix.
1740 - Added support for correct interpreted text processing.
1741 - Fixed nested title parsing (topic, sidebar directives).
1742 - Added special processing of backslash-escaped whitespace (idea
1743 from David Abrahams).
1744 - Made substitutions case-sensitive-but-forgiving; moved some code
1745 to ``docutils.nodes``.
1746 - Added support for block quote attributions.
1747 - Added a kludge to work-around a conflict between the bubble-up
1748 parser strategy and short titles (<= 3 char-long over- &
1749 underlines). Fixes SF bug #738803 "infinite loop with multiple
1750 titles" submitted by Jason Diamond.
1751 - Added explicit interpreted text roles for standard inline markup:
1752 "emphasis", "strong", "literal".
1753 - Implemented "superscript" and "subscript" interpreted text roles.
1754 - Added initial support for "abbreviation" and "acronym" roles;
1756 - Added support for "--trim-footnote-reference-space" option.
1757 - Optional space before colons in directives & hyperlink targets.
1759 * docutils/parsers/rst/tableparser.py:
1761 - Fixed a bug that was producing unwanted empty rows in "simple"
1763 - Detect bad column spans in "simple" tables.
1765 * docutils/parsers/rst/directives: Updated all directive functions to
1768 * docutils/parsers/rst/directives/__init__.py:
1770 - Added ``flag()``, ``unchanged()``, ``path()``,
1771 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1772 directive option helper functions.
1773 - Added warnings for unknown directives.
1774 - Return ``None`` for missing directives.
1775 - Added ``register_directive()``, thanks to William Dode and Paul
1778 * docutils/parsers/rst/directives/admonitions.py:
1780 - Added "admonition" directive.
1782 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1783 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1784 "parsed-literal", "rubric", "epigraph", "highlights" and
1785 "pull-quote" directives.
1787 * docutils/parsers/rst/directives/images.py:
1789 - Added an "align" attribute to the "image" & "figure" directives
1790 (by Adam Chodorowski).
1791 - Added "class" option to "image", and "figclass" to "figure".
1793 * docutils/parsers/rst/directives/misc.py:
1795 - Added "include", "raw", and "replace" directives, courtesy of
1797 - Added "unicode" and "class" directives.
1799 * docutils/parsers/rst/directives/parts.py:
1801 - Added the "sectnum" directive; by Dmitry Jemerov.
1802 - Added "class" option to "contents" directive.
1804 * docutils/parsers/rst/directives/references.py: Added to project.
1805 Contains the "target-notes" directive.
1807 * docutils/parsers/rst/languages/__init__.py:
1809 - Return ``None`` from get_language() for missing language modules.
1811 * docutils/parsers/rst/languages/de.py: Added to project; German
1812 mappings by Engelbert Gruber.
1814 * docutils/parsers/rst/languages/en.py:
1816 - Added interpreted text roles mapping.
1818 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1819 mappings by Marcelo Huerta San Martin.
1821 * docutils/parsers/rst/languages/fr.py: Added to project; French
1822 mappings by William Dode.
1824 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1825 mappings by Nicola Larosa.
1827 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1828 mappings by Miroslav Vasko.
1830 * docutils/readers/__init__.py:
1832 - Added support for the observer pattern from ``utils.Reporter``, in
1833 ``Reader.parse`` and ``Reader.transform``.
1834 - Removed ``Reader.transform()`` method.
1835 - Added default parameter values to ``Reader.__init__()`` to make
1836 instantiation easier.
1837 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1839 * docutils/readers/pep.py:
1841 - Added the ``peps.TargetNotes`` transform to the Reader.
1842 - Removed PEP & RFC reference detection code; moved to
1843 parsers/rst/states.py as options (enabled here by default).
1844 - Added support for pre-acceptance PEPs (no PEP number yet).
1845 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1848 * docutils/readers/python: Python Source Reader subpackage added to
1849 project, including preliminary versions of:
1852 - moduleparser.py: Parser for Python modules.
1854 * docutils/transforms/__init__.py:
1856 - Added ``Transformer`` class and completed transform reform.
1857 - Added unknown_reference_resolvers list for each transformer. This list holds
1858 the list of functions provided by each component of the transformer that
1859 help resolve references.
1861 * docutils/transforms/frontmatter.py:
1863 - Improved support for generic fields.
1864 - Fixed bibliographic field language lookups.
1866 * docutils/transforms/misc.py: Added to project. Miscellaneous
1869 * docutils/transforms/parts.py:
1871 - Moved the "id" attribute from TOC list items to the references
1872 (``Contents.build_contents()``).
1873 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1874 - Added "class" attribute support to ``Contents``.
1876 * docutils/transforms/peps.py:
1878 - Added ``mask_email()`` function, updating to pep2html.py's
1880 - Linked "Content-Type: text/x-rst" to PEP 12.
1881 - Added the ``TargetNotes`` PEP-specific transform.
1882 - Added ``TargetNotes.cleanup_callback``.
1883 - Added title check to ``Headers``.
1885 * docutils/transforms/references.py:
1887 - Added the ``TargetNotes`` generic transform.
1888 - Split ``Hyperlinks`` into multiple transforms.
1889 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1890 - Added check for circular indirect references.
1891 - Made substitutions case-sensitive-but-forgiving.
1893 * docutils/transforms/universal.py:
1895 - Added support for the "--expose-internal-attributes" option.
1896 - Removed ``Pending`` transform classes & data.
1898 * docutils/writers/__init__.py:
1900 - Removed ``Writer.transform()`` method.
1902 * docutils/writers/docutils-xml.py:
1904 - Added XML and doctype declarations.
1905 - Added "--no-doctype" and "--no-xml-declaration" options.
1907 * docutils/writers/html4css1.py:
1909 - "name" attributes only on these tags: a, applet, form, frame,
1911 - Added "name" attribute to <a> in section titles for Netscape 4
1912 support (bug report: Pearu Peterson).
1913 - Fixed targets (names) on footnote, citation, topic title,
1914 problematic, and system_message nodes (for Netscape 4).
1915 - Changed field names from "<td>" to "<th>".
1916 - Added "@" to "@" encoding to thwart address harvesters.
1917 - Improved the vertical whitespace optimization; ignore "invisible"
1918 nodes (targets, comments, etc.).
1919 - Improved inline literals with ``<span class="pre">`` around chunks
1920 of text and `` `` for runs of spaces.
1921 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1922 ``self.docinfo`` segments.
1923 - Added support for "line_block", "address" elements.
1924 - Improved backlinks (footnotes & system_messages).
1925 - Improved system_message output.
1926 - Redefined "--stylesheet" as containing an invariant URL, used
1927 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1929 - Added "--footnote-references" option (superscript or brackets).
1930 - Added "--compact-lists" and "--no-compact-lists" options.
1931 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1932 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1933 - Improved field list rendering.
1934 - Added Docutils version to "generator" meta tag.
1935 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1936 - Improved layout of <pre> HTML source.
1937 - Fixed attribute typo on <colspec>.
1938 - Refined XML prologue.
1939 - Support for no stylesheet.
1940 - Removed "interpreted" element support.
1941 - Added support for "title_reference", "sidebar", "attribution",
1942 "rubric", and generic "admonition" elements.
1943 - Added "--attribution" option.
1944 - Added support for "inline", "subscript", "superscript" elements.
1945 - Added initial support for "abbreviation" and "acronym";
1948 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1952 - Double quotes in literal blocks (special treatment for de/ngerman).
1953 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1954 - Added "--attribution" option.
1955 - Right align attributions.
1957 * docutils/writers/pep_html.py:
1959 - Parameterized output encoding in PEP template.
1960 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1961 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1962 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1964 - Added an override on the "--footnote-references" option.
1965 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1966 - Added Docutils version to "generator" meta tag.
1967 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1971 - Added a "silent" setting for ``buildhtml.py``.
1972 - Added a "Getting Help" section.
1973 - Rearranged the structure.
1974 - Kept up to date, with new settings, command-line options etc.
1975 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1976 - Converted settings table into a definition list.
1978 * docs/rst/quickstart.txt:
1980 - Added a table of contents.
1981 - Added feedback information.
1982 - Added mention of minimum section title underline lengths.
1983 - Removed the 4-character minimum for section title underlines.
1985 * docs/rst/quickref.html:
1987 - Added a "Getting Help" section.
1988 - Added a style to make section title backlinks more subtle.
1989 - Added mention of minimum section title underline lengths.
1990 - Removed the 4-character minimum for section title underlines.
1992 * extras: Directory added to project; contains third-party modules
1993 that Docutils depends on (optparse, textwrap, roman). These are
1994 only installed if they're not already present.
1996 * licenses: Directory added to project; contains copies of license
1997 files for non-public-domain files.
2001 - Changed the focus. It's about DTD elements: structural
2002 relationships, semantics, and external (public) attributes. Not
2003 about the element class library.
2004 - Moved some implementation-specific stuff into ``docutils.nodes``
2006 - Wrote descriptions of all common attributes and parameter
2007 entities. Filled in introductory material.
2008 - Working through the element descriptions: 55 down, 37 to go.
2009 - Removed "Representation of Horizontal Rules" to
2010 spec/rst/alternatives.txt.
2012 * spec/docutils.dtd:
2014 - Added "generated" inline element.
2015 - Added "line_block" body element.
2016 - Added "auto" attribute to "title".
2017 - Changed content models of "literal_block" and "doctest_block" to
2019 - Added ``%number;`` attribute type parameter entity.
2020 - Changed ``%structural.elements;`` to ``%section.elements``.
2021 - Updated attribute types; made more specific.
2022 - Added "address" bibliographic element.
2023 - Added "line" attribute to ``system_message`` element.
2024 - Removed "field_argument" element; "field_name" may contain
2025 multiple words and whitespace.
2026 - Changed public identifier to docutils.sf.net.
2027 - Removed "interpreted" element; added "title_reference",
2028 "abbreviation", "acronym".
2029 - Removed "refuri" attribute from "footnote_reference" and
2030 "citation_reference".
2031 - Added "sidebar", "rubric", "attribution", "admonition",
2032 "superscript", "subscript", and "inline" elements.
2034 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2036 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2038 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2040 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2043 * spec/transforms.txt: Added to project.
2045 * spec/howto: Added subdirectory, for developer how-to docs.
2047 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2048 Elza, edited & extended by David Goodger.
2050 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2053 * spec/rst/alternatives.txt:
2055 - Added "Doctree Representation of Transitions" from
2057 - Updated "Inline External Targets" & closed the debate.
2058 - Added ideas for interpreted text syntax extensions.
2059 - Added "Nested Inline Markup" section.
2061 * spec/rst/directives.txt:
2063 - Added directives: "topic", "sectnum", "target-notes",
2064 "line-block", "parsed-literal", "include", "replace", "sidebar",
2065 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2067 - Formalized descriptions of directive details.
2068 - Added an "align" attribute to the "image" & "figure" directives
2069 (by Adam Chodorowski).
2070 - Added "class" options to "topic", "sidebar", "line-block",
2071 "parsed-literal", "contents", and "image"; and "figclass" to
2074 * spec/rst/interpreted.txt: Added to project. Descriptions of
2075 interpreted text roles.
2077 * spec/rst/introduction.txt:
2079 - Added pointers to material for new users.
2081 * spec/rst/reStructuredText.txt:
2083 - Disambiguated comments (just add a newline after the "::").
2084 - Updated enumerated list description; added a discussion of the
2085 second-line validity checking.
2086 - Updated directive description.
2087 - Added a note redirecting newbies to the user docs.
2088 - Expanded description of inline markup start-strings in non-markup
2090 - Removed field arguments and made field lists a generic construct.
2091 - Removed the 4-character minimum for section title underlines.
2092 - Clarified term/classifier delimiter & inline markup ambiguity
2094 - Added "Embedded URIs".
2095 - Updated "Interpreted Text" section.
2096 - Added "Character-Level Inline Markup" section.
2098 * test: Continually adding & updating tests.
2100 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2101 - Moved test/test_pep/ to test/test_readers/test_pep/.
2102 - Added test/test_readers/test_python/.
2103 - Added test/test_writers/ (Engelbert Gruber).
2107 - Made the ``locale.setlocale()`` calls in front ends
2110 * tools/buildhtml.py:
2112 - Added "--silent" option.
2113 - Fixed bug with absolute paths & "--config".
2114 - Updated for new I/O classes.
2115 - Added some exception handling.
2116 - Separated publishers' setting defaults; prevents interference.
2117 - Updated for new ``publish_file()`` convenience function.
2119 * tools/pep-html-template:
2121 - Allow for "--embed-stylesheet".
2122 - Added Docutils version to "generator" meta tag.
2123 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2124 - Conform to XHTML spec.
2126 * tools/pep2html.py:
2128 - Made ``argv`` a parameter to ``main()``.
2129 - Added support for "Content-Type:" header & arbitrary PEP formats.
2130 - Linked "Content-Type: text/plain" to PEP 9.
2131 - Files skipped (due to an error) are not pushed onto the server.
2132 - Updated for new I/O classes.
2133 - Added ``check_requirements()`` & ``pep_type_error()``.
2134 - Added some exception handling.
2135 - Updated for new ``publish_string()`` convenience function.
2136 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2138 * tools/quicktest.py:
2140 - Added "-V"/"--version" option.
2142 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2144 * tools/unicode2rstsubs.py: Added to project. Produces character
2145 entity files (reSructuredText substitutions) from the MathML master
2148 * tools/editors: Support code for editors, added to project. Contains
2149 ``emacs/restructuredtext.el``.
2151 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2153 - Added style for chunks of inline literals.
2154 - Removed margin for first child of table cells.
2155 - Right-aligned field list names.
2156 - Support for auto-numbered section titles in TOCs.
2157 - Increased the size of inline literals (<tt>) in titles.
2158 - Restored the light gray background for inline literals.
2159 - Added support for "line_block" elements.
2160 - Added style for "address" elements.
2161 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2162 - Improved field list rendering.
2163 - Vertical whitespace improvements.
2164 - Removed "a.target" style.
2166 * tools/stylesheets/pep.css:
2168 - Fixed nested section margins.
2169 - Other changes parallel those of ``../default.css``.
2172 Release 0.2 (2002-07-31)
2173 ========================
2177 - The word "component" was being used ambiguously. From now on,
2178 "component" will be used to mean "Docutils component", as in Reader,
2179 Writer, Parser, or Transform. Portions of documents (Table of
2180 Contents, sections, etc.) will be called "document parts".
2181 - Did a grand renaming: a lot of ``verylongnames`` became
2182 ``very_long_names``.
2183 - Cleaned up imports: no more relative package imports or
2184 comma-separated lists of top-level modules.
2185 - Added support for an option values object which carries default
2186 settings and overrides (from command-line options and library use).
2187 - Added internal Unicode support, and support for both input and
2189 - Added support for the ``docutils.io.IO`` class & subclasses.
2193 * docutils/__init__.py:
2195 - Added ``ApplicationError`` and ``DataError``, for use throughout
2197 - Added ``Component`` base class for Docutils components; implements
2198 the ``supports`` method.
2199 - Added ``__version__`` (thus, ``docutils.__version__``).
2203 - Removed many keyword parameters to ``Publisher.__init__()`` and
2204 ``publish()``; bundled into an option values object. Added
2205 "argv", "usage", "description", and "option_spec" parameters for
2206 command-line support.
2207 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2209 - Reworked I/O model for ``docutils.io`` wrappers.
2210 - Updated ``Publisher.set_options()``; now returns option values
2212 - Added support for configuration files (/etc/docutils.conf,
2213 ./docutils.conf, ~/.docutils).
2214 - Added ``Publisher.setup_option_parser()``.
2215 - Added default usage message and description.
2217 * docutils/frontend.py: Added to project; support for front-end
2218 (command-line) scripts. Option specifications may be augmented by
2219 components. Requires Optik (http://optik.sf.net/) for option
2220 processing (installed locally as docutils/optik.py).
2222 * docutils/io.py: Added to project; uniform API for a variety of input
2225 * docutils/nodes.py:
2227 - Added ``TreeCopyVisitor`` class.
2228 - Added a ``copy`` method to ``Node`` and subclasses.
2229 - Added a ``SkipDeparture`` exception for visitors.
2230 - Renamed ``TreePruningException`` from ``VisitorException``.
2231 - Added docstrings to ``TreePruningException``, subclasses, and
2233 - Improved docstrings.
2234 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2235 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2237 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2238 ``PreDecorative`` mixin.
2239 - Reworked the name/id bookkeeping; to ``document``, removed
2240 ``explicit_targets`` and ``implicit_targets`` attributes, added
2241 ``nametypes`` attribute and ``set_name_id_map`` method.
2242 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2244 - Added ``document.has_name()`` method.
2245 - Fixed DOM generation for list-attributes.
2246 - Added category class ``Labeled`` (used by footnotes & citations).
2247 - Added ``Element.set_class()`` method (sets "class" attribute).
2249 * docutils/optik.py: Added to project. Combined from the Optik
2250 package, with added option groups and other modifications. The use
2251 of this module is probably only temporary.
2253 * docutils/statemachine.py:
2255 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2256 - Added underscores to improve many awkward names.
2257 - In ``string2lines()``, changed whitespace normalizing translation
2258 table to regexp; restores Python 2.0 compatibility with Unicode.
2260 * docutils/urischemes.py:
2262 - Filled in some descriptions.
2263 - Added "shttp" scheme.
2265 * docutils/utils.py:
2267 - Added ``clean_rcs_keywords`` function (moved from
2268 docutils/transforms/frontmatter.py
2269 ``DocInfo.filter_rcs_keywords``).
2270 - Added underscores to improve many awkward names.
2271 - Changed names of Reporter's thresholds:
2272 warning_level -> report_level; error_level -> halt_level.
2273 - Moved ``utils.id()`` to ``nodes.make_id()``.
2274 - Added ``relative_path(source, target)``.
2276 * docutils/languages/de.py: German mappings; added to project. Thanks
2277 to Gunnar Schwant for the translations.
2279 * docutils/languages/en.py: Added "Dedication" bibliographic field
2282 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2285 * docutils/parsers/rst/states.py:
2287 - Added underscores to improve many awkward names.
2288 - Added RFC-2822 header support.
2289 - Extracted the inline parsing code from ``RSTState`` to a separate
2290 class, ``Inliner``, which will allow easy subclassing.
2291 - Made local bindings for ``memo`` container & often-used contents
2292 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2293 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2294 - Added ``MarkupMismatch`` exception; for late corrections.
2295 - Added ``-/:`` characters to inline markup's start string prefix,
2296 ``/`` to end string suffix.
2297 - Fixed a footnote bug.
2298 - Fixed a bug with literal blocks.
2299 - Applied patch from Simon Budig: simplified regexps with symbolic
2300 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2301 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2302 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2303 - Allowed non-ASCII in "simple names" (directive names, field names,
2305 - Converted ``Inliner.patterns.initial`` to be dynamically built
2306 from parts with ``build_regexp()`` function.
2307 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2308 - Updated docstrings.
2309 - Changed "table" to "grid_table"; added "simple_table" support.
2311 * docutils/parsers/rst/tableparser.py:
2313 - Changed ``TableParser`` to ``GridTableParser``.
2314 - Added ``SimpleTableParser``.
2315 - Refactored naming.
2317 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2318 a fallback language for directive names.
2320 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2321 directive to use a ``pending`` element, used only by HTML writers.
2323 * docutils/parsers/rst/directives/parts.py: Renamed from
2326 - Added "backlinks" attribute to "contents" directive.
2328 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2329 project by Adam Chodorowski.
2331 * docutils/readers/__init__.py: Gave Readers more control over
2332 choosing and instantiating Parsers.
2334 * docutils/readers/pep.py: Added to project; for PEP processing.
2336 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2337 requires a ``component`` parameter.
2339 * docutils/transforms/components.py: Added to project; transforms
2340 related to Docutils components.
2342 * docutils/transforms/frontmatter.py:
2344 - In ``DocInfo.extract_authors``, check for a single "author" in an
2345 "authors" group, and convert it to a single "author" element.
2346 - Added support for "Dedication" and generic bibliographic fields.
2348 * docutils/transforms/peps.py: Added to project; PEP-specific.
2350 * docutils/transforms/parts.py: Renamed from old components.py.
2352 - Added filter for `Contents`, to use alt-text for inline images,
2353 and to remove inline markup that doesn't make sense in the ToC.
2354 - Added "name" attribute to TOC topic depending on its title.
2355 - Added support for optional TOC backlinks.
2357 * docutils/transforms/references.py: Fixed indirect target resolution
2358 in ``Hyperlinks`` transform.
2360 * docutils/transforms/universal.py:
2362 - Changed ``Messages`` transform to properly filter out system
2363 messages below the warning threshold.
2364 - Added ``Decorations`` transform (support for ``--generator``,
2365 ``--date``, ``--time``, ``--source-link`` options).
2367 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2368 Engelbert Gruber's PDF writer.
2370 * docutils/writers/html4css1.py:
2372 - Made XHTML-compatible (switched to lowercase element & attribute
2373 names; empty tag format).
2374 - Escape double-dashes in comment text.
2375 - Improved boilerplate & modularity of output.
2376 - Exposed modular output in Writer class.
2377 - Added a "generator" meta tag to <head>.
2378 - Added support for the ``--stylesheet`` option.
2379 - Added support for ``decoration``, ``header``, and ``footer``
2381 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2382 translation table to regexp; restores Python 2.0 compatibility
2384 - Added the translator class as instance variable to the Writer, to
2385 make it easily subclassable.
2386 - Improved option list spacing (thanks to Richard Jones).
2387 - Modified field list output.
2388 - Added backlinks to footnotes & citations.
2389 - Added percentage widths to "<col>" tags (from colspec).
2390 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2391 "<span>" changed to "<var>".
2392 - Inline literals: "<code>" changed to "<tt>".
2393 - Many changes to optimize vertical space: compact simple lists etc.
2394 - Add a command-line options & directive attributes to control TOC
2395 and footnote/citation backlinks.
2396 - Added support for optional footnote/citation backlinks.
2397 - Added support for generic bibliographic fields.
2398 - Identify backrefs.
2399 - Relative URLs for stylesheet links.
2401 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2402 PEPs (subclass of ``html4css1.Writer``).
2404 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2406 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2407 of the Docutils internal doctree in XML.
2409 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2413 - Changed the title to "The Docutils Document Tree".
2414 - Added "Hyperlink Bookkeeping" section.
2416 * spec/docutils.dtd:
2418 - Added ``decoration``, ``header``, and ``footer`` elements.
2419 - Brought ``interpreted`` element in line with the parser: changed
2420 attribute "type" to "role", added "position".
2421 - Added support for generic bibliographic fields.
2423 * spec/notes.txt: Continual updates. Added "Project Policies".
2425 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2428 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2430 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2431 mailing list discussions.
2433 * spec/pep-0287.txt:
2435 - Renamed to "reStructuredText Docstring Format".
2437 - Reworked Q&A as an enumerated list.
2438 - Converted to reStructuredText format.
2440 * spec/pysource.dtd:
2442 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2444 * spec/pysource.txt: Removed from project. Moved much of its contents
2447 * spec/rst/alternatives.txt:
2449 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2450 - Added "Inline External Targets" section.
2452 * spec/rst/directives.txt:
2454 - Added "backlinks" attribute to "contents" directive.
2456 * spec/rst/problems.txt:
2458 - Updated the Enumerated List Markup discussion.
2459 - Added new alternative table markup syntaxes.
2461 * spec/rst/reStructuredText.txt:
2463 - Clarified field list usage.
2464 - Updated enumerated list description.
2465 - Clarified purpose of directives.
2466 - Added ``-/:`` characters to inline markup's start string prefix,
2467 ``/`` to end string suffix.
2468 - Updated "Authors" bibliographic field behavior.
2469 - Changed "inline hyperlink targets" to "inline internal targets".
2470 - Added "simple table" syntax to supplement the existing but
2471 newly-renamed "grid tables".
2472 - Added cautions for anonymous hyperlink use.
2473 - Added "Dedication" and generic bibliographic fields.
2475 * test: Made test modules standalone (subdirectories became packages).
2477 * test/DocutilsTestSupport.py:
2479 - Added support for PEP extensions to reStructuredText.
2480 - Added support for simple tables.
2481 - Refactored naming.
2483 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2485 - Now supports true packages containing test modules
2486 (``__init__.py`` files required); fixes duplicate module name bug.
2488 * test/test_pep/: Subpackage added to project; PEP testing.
2490 * test/test_rst/test_SimpleTableParser.py: Added to project.
2494 - Updated html.py and publish.py front-end tools to use the new
2495 command-line processing facilities of ``docutils.frontend``
2496 (exposed in ``docutils.core.Publisher``), reducing each to just a
2498 - Added ``locale.setlocale()`` calls to front-end tools.
2500 * tools/buildhtml.py: Added to project; batch-generates .html from all
2501 the .txt files in directories and subdirectories.
2503 * tools/default.css:
2505 - Added support for ``header`` and ``footer`` elements.
2506 - Added styles for "Dedication" topics (biblio fields).
2508 * tools/docutils.conf: A configuration file; added to project.
2510 * tools/docutils-xml.py: Added to project.
2512 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2514 * tools/pep-html-template: Added to project.
2516 * tools/pep2html.py: Added to project from Python (nondist/peps).
2517 Added support for Docutils (reStructuredText PEPs).
2519 * tools/quicktest.py:
2521 - Added the ``--attributes`` option, hacked a bit.
2522 - Added a second command-line argument (output file); cleaned up.
2524 * tools/stylesheets/: Subdirectory added to project.
2526 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2529 Release 0.1 (2002-04-20)
2530 ========================
2532 This is the first release of Docutils, merged from the now inactive
2533 reStructuredText__ and `Docstring Processing System`__ projects. For
2534 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2535 `DPS HISTORY`__ files.
2537 __ http://structuredtext.sourceforge.net/
2538 __ http://docstring.sourceforge.net/
2539 __ http://structuredtext.sourceforge.net/HISTORY.html
2540 __ http://docstring.sourceforge.net/HISTORY.html
2542 General changes: renamed 'dps' package to 'docutils'; renamed
2543 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2544 the test suites (reStructuredText's test/test_states renamed to
2545 test/test_rst); and all modifications required to make it all work.
2547 * docutils/parsers/rst/states.py:
2549 - Improved diagnostic system messages for missing blank lines.
2550 - Fixed substitution_reference bug.
2556 indent-tabs-mode: nil
2557 sentence-end-double-space: t