1 .. -*- coding: utf-8 -*-
7 :Author: David Goodger; open to all Docutils developers
8 :Contact: goodger@python.org
11 :Web site: http://docutils.sourceforge.net/
12 :Copyright: This document has been placed in the public domain.
22 - Handle language codes according to `BCP 47`_.
23 - If the specified language is not supported by Docutils,
24 warn and fall back to English.
25 - Math support: reStructuredText "math" role and directive,
26 ``math`` and ``math_block`` doctree elements.
27 - Decode command line arguments with the locales preferred encoding
28 (to allow, e.g., ``--title=Dornröschen``).
29 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
31 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
35 - Fix ``--local`` switch.
38 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
40 * docutils/writers/html4css1/__init__.py
42 - Set "lang" argument for objects with class argument
43 "language-<language tag>".
44 - New setting "math-output" with support for HTML, MathML, and LaTeX.
46 * docutils/writers/latex2e/__init__.py
48 - Fix [ 3043986 ] AttributeError using :local: with table of content.
49 - Place title data in the document preamble.
50 - Load `babel` package only if required.
51 - Update list of supported languages.
52 - New config setting "hyperref-options".
53 No hard-coded "unicode" hyperref option (clash with xetex).
54 - Set language for custom roles, paragraphs, block-quotes, and
55 line-quotes with class argument "language-<language tag>".
56 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
57 - Convert image URI to a local file path.
58 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
59 has more than one paragraph (Wolfgang Scherer).
60 - \leavevmode before longtable only when needed (prevents spurious vspace)
61 - do not advance table counter for tables without caption
63 * docutils/writers/xetex/__init__.py
65 - New writer generating LaTeX code for compiling with ``xelatex``.
67 A separate writer (inheriting from latex2e) instead of a ``--xetex``
68 option allows separate config options for XeTeX vs. LaTeX2e.
70 * tools/editors/emacs/rst.el:
72 - Fix [ 3001100 ] does not handle spaces in filenames
73 (thanks to Jakub Wilk)
77 - strip whitespace from stylesheet arguments
78 - exclude combining chars from column_width
79 (partial fix for [ 2926161 ])
82 Release 0.7 (2010-07-07)
83 ========================
87 - Fix [ 2881769 ] setup configuration.
88 - Fix [ 2788716 ] reporting problems in included files.
92 - FileInput opens files as text files with universal newline support
93 (mode "rU", configurable with the new optional argument "mode").
97 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
101 - Fix [ 2923723 ] let decode_path() tolerate path == None
103 * docutils/writers/html4css1/__init__.py
105 - Support SVG and SWF images (thanks to Stefan Rank).
106 - Generate valid XHTML for centered images with targets.
107 Use CSS classes instead of "align" tags for image alignment.
109 * docutils/writers/latex2e/__init__.py
111 - Use `transforms.writer_aux.Admonitions` to "normalize" special
113 - Use the ``\url`` command for URLs (breaks long URLs instead of
114 writing into the margin).
115 - Preserve runs of spaces in `inline literals`__.
116 - Deprecate ``figure_footnotes`` setting.
117 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
118 - New ``latex_preamble`` setting.
119 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
120 - Fix hyperlink targets (labels) for images, figures, and tables.
121 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
122 - Apply [ 2961991 ] Call hyperref with unicode option.
123 - Drop the special `output_encoding`__ default ("latin-1").
124 The Docutils wide default (usually "UTF-8") is used instead.
125 - Render inline markup in document title and subtitle.
126 - Fix numbering depth with LaTeX section numbering.
127 - Update Unicode -> LaTeX translations.
128 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
130 __ docs/ref/restructuredtext.html#inline-literals
131 __ docs/user/config.html#docutils-footnotes
132 __ docs/user/config.html#output_encoding
134 * docutils/writers/manpage.py
136 - Fix: supported attribute (thanks to peter2108).
137 - Remove trailing blanks in code (keep in sync with mercurial version).
138 - Titles level 1, that is ``.SH``, always uppercase.
139 - Apply patch from mg: literal text should be bold in man-pages.
143 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
148 - Python 3 support: copy test/ and tools/ to the build-dir
149 and convert Python sources with 2to3.
152 Release 0.6 (2009-10-11)
153 ========================
157 - Docutils is now compatible with Python versions from 2.3 up to 2.6
158 and convertible to 3.1 code.
160 + Node.__nonzero__ returns True instead of 1.
161 + use os.walk instead os.path.walk.
162 + minimize "types" module where possible.
163 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
164 + Text nodes now subclass unicode rather than UserString
165 (which is gone in python 3.0).
166 + 3.0 compatibility module docutils._compat
168 + Drop 2.2 compatibility workarounds.
169 + Drop extras/optparse.py and extras/textwrap.py
170 (stdlib modules since 2.3).
172 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
173 - Unix man page export: manpage writer moved from sandbox to Doctutils
176 - Apply [ 1719345 ] Galician translation
177 - Apply [ 1905741 ] Polish translation
178 - Apply [ 1878977 ] make_id(): deaccent characters.
179 - Apply [ 2029251 ] return nonzero when tests fail.
180 - Fix [ 1692788 ] allow UTF-8 in style sheets.
181 - Fix [ 2781629 ] support non-ASCII chars in file names.
182 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
183 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
184 - Fix [ 2821266 ] --strict option works now like --halt=info.
185 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
186 - Fix [ 1627229 ] hyperlink references in substitutions.
188 - The "newlatex" writer is orphaned.
192 - Documented Unicode characters allowed as inline markup openers,
193 closers, and delimiters.
194 - Allow units for all length specifications.
195 - Allow percent sign in "scale" argument of "figure" and "image" directives.
196 - Bugfix: The "figalign" argument of a figure now works as intended
197 (aligning the figure, not its contents).
198 - Align images with class "align-[right|center|left]"
199 (allows setting the alignment of an image in a figure).
203 - Added ``Element.__contains__`` method, for the in-operator.
205 * docutils/parsers/rst/states.py:
207 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
208 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
209 " " (non-breaking space), and "¡ ¿" openers.
211 * docutils/parsers/directives/misc.py:
213 - Added ``start-line`` and ``end-line`` options to "include"
214 directive to select a range of lines.
215 - Hard tabs in literal inclusions are replaced by spaces. This is
216 configurable via the new ``tab-width`` option of the "include" directive
217 (a negative tab-width prevents tab expansion).
221 - Add ``get_stylesheet_list`` function.
222 - Apply [ 2834836 ] print info at halt
224 * docutils/transforms/universal.py:
226 - Raise default priority of StripClasses to exclude stripped classes from
229 * docutils/writers/html4css1/__init__.py:
231 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
232 separated list of stylesheets.
233 - Address [ 1938891 ] Inline literal text creates "pre" span only when
234 needed to prevent inter-word line wraps.
235 - Use `translate` method instead of repeated `replace` calls.
236 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
237 classes to allow CSS styling that does not interfere with other
238 table-using constructs (field lists, citations, ...).
240 * docutils/writers/newlatex2e/__init__.py:
242 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
244 * docutils/writers/latex2e/__init__.py (see also
245 `<docs/user/docutils-05-compat.sty.html>`__) :
247 - Add ``--embed-stylesheet`` option.
248 - Apply [ 1474017 ] image vertical alignment is reversed.
249 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
250 - Change: has_key for dictionaries (not Nodes) to in-operator.
251 - Merge adjacent citations into one latex cite command.
252 - Failsave implementation of custom roles. LaTeX compilation now ignores
253 unknown classes instead of aborting with an error.
254 - Support custom roles based on standard roles.
255 - LaTeX packages can be used as ``--stylesheet`` arguments without
256 restriction. (A style sheet is now referenced with the ``\usepackage``
257 command, if it ends with ``.sty`` or has no extension.)
258 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
259 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
260 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
261 2005-02-04 as a configurable length unit).
262 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
263 if font-encoding is set to ''. LaTeX defaults to OT1 then.
264 - Set sub- and superscript role argument in text mode not as math.
265 Use a custom role based on sub-/superscript if you want italic shape.
266 - Shorter preamble and less dependencies: Load packages and define macros
267 only if required in the document.
268 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
269 - New custom environments and commands with optional "classes" argument.
270 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
271 - Better conformance to Docutils specifications with ``--use-latex-toc``.
272 Support for LaTeX generated ToC also with unnumbered sections.
273 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
274 section numbering by LaTeX.
275 - Use default font in admonitions and sidebar.
276 - Align of image in a figure defaults to 'center'.
277 - Bugfix: Newlines around targets and references prevent run-together
279 - Fix internal hyperlinks.
280 - Use class defaults for page margins ('typearea' now optional).
281 - Float placement made configurable, default changed to "here definitely".
282 - Typeset generic topic as "quote block with title".
283 - Use template (file and configuration option).
284 - In the default template, load cmap.sty (fix text extraction in PDF) and
285 fixltx2e.sty (LaTeX patches, \textsubscript).
286 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
287 - Use `translate` instead of repeated `replace` calls for text encoding.
288 - Hyperlinked footnotes and support for symbol footnotes and
289 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
290 - Complete pairs of binary options
291 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
292 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
294 - font-encoding: "T1" (formerly implicitely set by 'ae').
295 - use-latex-toc: true (ToC with page numbers).
296 - use-latex-footnotes: true (no mixup with figures).
298 * docutils/writers/manpage.py
300 - Do not print version at document end, this is done by the viewer.
301 - Do not print date at document end, this is done by the viewer.
302 - Fix storage of docinfo fields for none standard fields.
304 * docutils/tools/rst2man.py
306 Release 0.5 (2008-06-25)
307 ========================
309 * docutils/languages/he.py: Added to project: Hebrew mappings by
312 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
313 mappings by Meir Kriheli.
315 * docutils/frontend.py:
317 - Configuration files are now assumed and required to be
319 - Paths of applied configuration files are now recorded in the
320 runtime setting ``_config_files`` (accessible via
321 ``--dump-settings``).
322 - Added ``--strip-elements-with-class`` and ``--strip-class``
323 options (``strip_elements_with_classes`` and ``strip_classes``
328 - Added code to determine the input encoding from data: encoding
329 declarations or the presence of byte order marks (UTF-8 & UTF-16).
330 - Added support for IronPython 1.0.
334 - Added ``document.__getstate__`` method, for pickling.
336 * docutils/parsers/rst/states.py:
338 - Allow ``+`` and ``:`` in reference names.
339 - Unquoted targets beginning with an underscore (``.. __target:
340 URI``) are no longer accepted.
341 - Added support for multiple attributions in a physical block quote
342 (indented text block), dividing it into multiple logical block
344 - Added support for unicode bullets in bullet lists: "•", "‣", and
346 - Added support for new object-oriented directive interface,
347 retaining compatibility to the old functional interface.
348 - Added support for throwing ``DirectiveError``'s from within
351 * docutils/parsers/rst/__init__.py:
353 - Added ``Directive`` base class.
354 - Added ``DirectiveError`` base class.
355 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
358 * docutils/parsers/directives/:
360 - Refactored all reStructuredText directives to use the new
361 object-oriented directive interface. Errors are now (mostly)
362 thrown using the new ``DirectiveError`` class.
364 * docutils/parsers/directives/misc.py:
366 - Added ``start-after`` and ``end-before`` options to ``include``
367 directive; thanks to Stefan Rank.
369 * docutils/transforms/universal.py:
371 - Added ``StripClassesAndElements`` transform to remove from the
372 document tree all elements with classes in
373 ``settings.strip_elements_with_classes`` and all "classes"
374 attribute values in ``self.document.settings.strip_classes``.
376 * docutils/transforms/writer_aux.py:
378 - Added ``Admonitions`` transform to transform specific admonitions
379 (like ``note``, ``warning``, etc.) into generic admonitions with a
382 * docutils/writers/html4css1/__init__.py:
384 - Moved template functionality from the PEP/HTML writer here.
385 - Expanded the fragments available in the ``parts`` attribute.
386 - Moved ``id`` attributes from titles to surrounding ``div``
388 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
389 universally supported now).
390 - ``template.txt`` is now opened in text mode instead of binary mode
391 (to ensure Windows compatibility).
392 - ``a`` elements now have an "internal" or "external" class,
393 depending on reference type.
395 * docutils/writers/html4css1/template.txt: Added to project.
397 * docutils/writers/pep_html/:
399 - Moved template functionality to the HTML writer.
401 * docutils/writers/s5_html/__init__.py:
403 - Added ``view_mode`` & ``hidden_controls`` settings
404 (``--view-mode`` & ``--hidden-controls/--visible-controls``
407 * docutils/writers/latex2e/__init__.py:
409 - Add ``--literal-block-env``
410 - Fix: escaping ``%`` in href urls.
411 - Move usepackage hyperref after stylesheet inclusion.
412 - Fix: scrartcl does not have chapter but scrreprt.
413 - Add newline after ``\end{verbatim}``.
414 - Merge smaller differences from latex2e_adaptive_preamble.
415 - Add ``use-part-section``.
416 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
417 - Using leavemode option_list no longer needs to check if parent
418 is a definition list.
419 - Append ``\leavemode`` to definition list terms.
420 - No longer write visit\_/depart_definition_list_item comments to
422 - Table column width with 3 decimal places.
423 - Add table stubs support (boldfont).
424 - Add assemble_parts to writer.
425 - Add simply support for nested tables.
426 - Fix verbatim in tables if use-verbatim-when-possible.
427 - Use section commands down to subparagraph.
428 - Put ensuremath around some latin1 chars.
429 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
430 - New option ``--use-bibtex=style,db1,db2``.
431 - New option ``--reference-label`` to allow usage of LaTeX ref for
432 labels in section references.
433 - Add a label after every section to support sectionnumbers as reference
435 - Fix: bug# 1605376 rst2latex: bad options group list
436 - Remove inactive code for use_optionlist_for_option_list.
437 - Remove latex comments from option_list output.
438 - Fix: bug# 1612270 double qoutes in italian literal.
439 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
440 - Add option --use-latex-abstract.
441 - Image width unit ``px`` is translated to ``pt``.
442 - Add image height support.
443 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
445 - Fix: Do not escape underscores in citation reference labels if
446 use-latex-citations is set.
447 - Use centering instead of center for figure contents, to avoid vertical
449 - Recognize table class: borderless, nolines, booktabs, standard.
450 - Fix: Renaming contents section does not work with latex writer; SF
452 - Applied patch for custom roles with classes from Edward Loper.
453 - Fixed bug that caused crashes with more than 256 lists.
455 * docutils/writers/pep_html/__init__.py:
457 - Changed to support new python.org website structure and
460 * docs/howto/security.txt: "Deploying Docutils Securely", added to
463 * tools/buildhtml.py:
465 -- Added ``ignore`` setting to exclude a list of shell patterns
466 (default: ``.svn:CVS``).
468 * tools/editors/emacs/rst.el:
470 - Changed license to "GPL".
471 - Added ``rst-straighten-decorations`` function.
472 - The ``compile`` module is now always loaded.
473 - Added ``rst-toggle-line-block`` function.
474 - Headings consisting only of non-ASCII characters are now
475 recognized by ``rst-toc`` and ``rst-adjust``.
476 - Added font-lock support for multi-line comments where the first
477 comment line is empty.
478 - Added ``(require 'font-lock)``.
482 - Provide descriptive error message if distutils is missing.
485 Release 0.4 (2006-01-09)
486 ========================
490 - Updated the project policies for trunk/branch development &
493 * docutils/__init__.py:
495 - Added ``__version_details__`` attribute to describe code source
496 (repository/snapshot/release).
497 - Replaced ``default_transforms`` attribute of TransformSpec with
498 ``get_transforms()`` method.
502 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
503 functions, for document tree extraction and reprocessing.
507 - Added ``DocTreeInput`` class, for reprocessing existing documents.
508 - Added support for non-Unicode (e.g. binary) writer output.
512 - Re-introduced ``Targetable.indirect_reference_name``, for
513 MoinMoin/reST compatibility (removed in r3124/r3129).
514 - Added ``serial_escape`` function; escapes string values that are
515 elements of a list, for serialization. Modified Docutils-XML
516 writing (``Element._dom_node``) and pseudo-XML writing
517 (``Element.starttag``) to use ``serial_escape``.
518 - Added ``Node.deepcopy()`` method.
519 - Removed the internal lists ``document.substitution_refs``,
520 ``document.anonymous_refs``, and ``document.anonymous_targets``.
521 - Added a "container" element.
522 - Fixed bug where values of list-valued attributes of elements
523 originating from custom interpreted text roles (i.e., with custom
524 classes) were being shared between element instances. Reported by
527 * docutils/statemachine.py:
529 - Added trailing whitespace stripping to ``string2lines()``.
530 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
531 Asian double-width character support.
535 - Added ``east_asian_column_width()`` for double-width character
538 * docutils/languages/ja.py: Added to project: Japanese mappings by
541 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
542 mappings by Panjunyong.
544 * docutils/parsers/null.py: Added to project; a do-nothing parser.
546 * docutils/parsers/rst/__init__.py:
548 - Added validator to tab_width setting, with test. Closes SF bug
549 #1212515, report from Wu Wei.
551 * docutils/parsers/rst/states.py:
553 - Fixed bug with escaped colons indicating a literal block.
554 - Fixed bug with enumerated lists (SF#1254145).
555 - Backslash-escaped colons inside of field names are now allowed.
556 - Targets (implicit and explicit), anonymous hyperlink references
557 and auto-numbered footnote references inside of substitution
558 definitions are now disallowed.
559 - Fixed bug: list items with blank first lines.
560 - Fixed bug: block quote attributions with indented second lines.
561 - Added East Asian double-width character support (Python 2.4 only).
563 * docutils/parsers/rst/tableparser.py:
565 - Added East Asian double-width character support (Python 2.4 only).
567 * docutils/parsers/rst/directives/body.py:
569 - Added the "container" directive.
571 * docutils/parsers/rst/directives/misc.py:
573 - Added the "default-role", "title", and "date" directives.
574 - Added standard data file syntax to the "include" directive.
575 - Added support for "class" directive content.
577 * docutils/parsers/rst/directives/images.py:
579 - Added ``indirect_reference_name`` support for images with a target
581 - Added support for image width and height units.
582 - Fixed bug with image "target" options.
584 * docutils/parsers/rst/directives/references.py:
586 - Added "class" attribute to "target-notes" directive, for
587 footnote_reference classes.
589 * docutils/parsers/rst/include/: Directory added to project; contains
590 standard data files for the "include" directive. Initial contents:
591 character entity substitution definition sets, and a set of
592 definitions for S5/HTML presentations.
594 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
595 mappings by David Goodger.
597 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
598 Simplified Chinese mappings by Panjunyong.
600 * docutils/readers/__init__.py:
602 - Added universal.Decorations and universal.ExposeInternals
603 transforms as default transforms for all readers.
604 - Added ``ReReader`` base class for readers that reread an existing
607 * docutils/readers/doctree.py: Added to project; a reader for existing
610 * docutils/transforms/frontmatter.py:
612 - Fixed the DocInfo transform to handle SVN-style expansion of the
614 - In ``DocInfo.extract_authors``, treat the contents of "authors"
617 * docutils/transforms/misc.py:
619 - Added misc.Transitions transform, extracted from
620 universal.FinalChecks.
622 * docutils/transforms/references.py:
624 - Added references.DanglingReferences transform, extracted from
625 universal.FinalChecks.
626 - Fixed bug with doubly-indirect substitutions.
627 - Added footnote_reference classes attribute to "TargetNotes".
628 - Fixed bug with circular substitution definitions that put Docutils
629 into an infinite loop.
631 * docutils/transforms/universal.py:
633 - Added universal.ExposeInternals transform, extracted from
634 universal.FinalChecks.
635 - Removed universal.FinalChecks transform (logic has been moved to
636 several new transforms).
637 - Fixed bug with the "expose_internals" setting and Text nodes
638 (exposed by the "rawsource" internal attribute).
639 - Added the universal.StripComments transform, implementation of the
640 "strip_comments" setting.
642 * docutils/transforms/writer_aux.py: Added to project; auxiliary
643 transforms for writers.
645 - Added ``Compound`` transform, which flattens compound paragraphs.
647 * docutils/writers/: Several writer modules (html4css1.py) were
648 converted into packages. Support modules and data files have been
649 moved into the packages. The stylesheets for the HTML writers are
650 now installed along with the code, the code knows where to find
651 them, and the default is to use them (actually, to embed them).
652 Some adjustments to configuration files may be necessary. The
653 easiest way to obtain the new default behavior is to remove all
654 settings whose name includes "stylesheet".
656 * docutils/writers/__init__.py:
658 - Added universal.Messages and universal.FilterMessages transforms
659 as default transforms for all writers.
660 - Added ``UnfilteredWriter`` base class for writers that pass the
661 document tree on unchanged.
663 * docutils/writers/docutils_xml.py:
665 - Made ``xmlcharrefreplace`` the default output encoding error
668 * docutils/writers/html4css1/:
670 - Added support for image width and height units.
671 - Made ``xmlcharrefreplace`` the default output encoding error
673 - Made ``--embed-stylesheet`` the default rather than
674 ``--link-stylesheet``.
675 - Moved "id" attribute from container (section etc.) to title's <a>
676 tag, to be on the same tag as "name".
677 (!!! To be reverted in Docutils 0.5.)
678 - Added vertical space between fields of field lists.
679 - Added ``--compact-field-lists`` option to remove vertical space in
681 - Made cloaking of email addresses with ``--cloak-email-addresses``
683 - Fixed support for centered images.
684 - Added support for class="compact" & class="open" lists.
686 * docutils/writers/latex2e/:
688 - Underscores in citekeys are no longer escaped.
690 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
691 mapping of Unicode characters to LaTeX equivalents.
693 * docutils/writers/s5_html/: Package added to project; writer for
696 * docs/dev/distributing.txt: Added to project; guide for distributors
697 (package maintainers).
699 * docs/dev/hacking.txt: Added to project; guide for developers.
701 * docs/ref/doctree.txt:
703 - Updated for plural attributes "classes", "ids", "names",
705 - Added the "container" element.
707 * docs/ref/docutils.dtd:
709 - Updated for plural attributes "classes", "ids", "names",
712 * docs/user/emacs.txt: Added to project; a document about Emacs
713 support for reStructuredText and Docutils.
715 * docs/user/links.txt: Added to project; lists of Docutils-related
718 * docs/user/mailing-lists.txt: Added to project; information about
719 Docutils-related mailing lists and how to access them.
721 * docs/user/slide-shows.txt: Added to project; example of and docs for
722 the S5/HTML writer (``rst2s5.py`` front end).
724 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
725 Files", added to project.
727 * test/coverage.sh: Added to project; test coverage script.
729 * test/DocutilsTestSupport.py:
731 - Added support for specifying runtime settings at the suite level.
733 * test/test_functional.py:
735 - Added the ``clear_output_directory`` function.
736 - Added support for ``_test_more`` functions in functional test
739 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
741 * tools/rstpep2html.py: Renamed from pep.py.
743 * tools/dev/create_unimap.py: Added to project; script to create the
744 docutils/writers/unimap_latex.py mapping file.
746 * tools/dev/profile_docutils.py: Added to project; profiler script.
748 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
750 * tools/editors/emacs/restructuredtext.el,
751 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
752 Removed from project; the functionality is now contained in rst.el.
754 * tools/editors/emacs/rst.el: Added to project. Added many features
755 and fixed many bugs. See docs/user/emacs.txt for details.
757 * tools/stylesheets: Removed from project. Stylesheets have been
758 renamed and moved into writer packages.
761 Release 0.3.9 (2005-05-26)
762 ==========================
766 - Eliminated and replaced all uses of the old string attributes
767 ``id``, ``name``, ``dupname`` and ``class`` with references to the
768 new list attributes ``ids``, ``names``, ``dupnames`` and
769 ``classes`` throughout the whole source tree.
773 - Enabled ``--dump-*`` options when ``--traceback`` specified,
774 allowing for easier debugging.
775 - In ``Publisher.publish()``, expanded the generic top-level
778 * docutils/examples.py:
780 - Added ``internals`` function for exploration.
784 - Fixed ``Input.decode`` method to apply heuristics only if no
785 encoding is explicitly given, and to provide better reporting of
787 - The ``Input.decode`` method now removes byte order marks (BOMs)
792 - ``image`` element class changed to subclass of Element, not
793 TextElement (it's an empty element, and cannot contain text).
794 - Added ``attr_defaults`` dictionary for default attribute values.
795 - Added empty list as default value for the following attributes:
796 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
797 - Added ``document.decoration`` attribute,
798 ``document.get_decoration`` method, and ``decoration.get_header``
799 & ``.get_footer`` methods.
800 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
805 - Removed ``docutils.utils.Reporter.categories``,
806 ``docutils.utils.ConditionSet``, and all references to them, to
807 simplify error reporting.
809 * docutils/languages/nl.py: Added to project; Dutch mappings by
812 * docutils/parsers/rst/__init__.py:
814 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
816 * docutils/parsers/rst/states.py:
818 - Added check for escaped at-mark to prevent email address recognition.
819 - Fixed option lists to allow spaces inside ``<angle-bracketed option
821 - Allowed whitespace in paths and URLs.
822 - Added auto-enumerated list items.
823 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
825 - Added support for table stub columns.
827 * docutils/parsers/rst/directives/__init__.py:
829 - Allowed whitespace in paths (``path`` function).
830 - Added ``uri`` directive option conversion function.
832 * docutils/parsers/rst/directives/body.py:
834 - Fixed illegal context bug with "topic" directive (allowed within
835 sidebars; not within body elements).
837 * docutils/parsers/rst/directives/images.py:
839 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
840 - Added support for the ``file_insertion_enabled`` setting in the
841 "figure" directive (disables "figwidth" option).
842 - "image" directive: added checks for valid values of "align" option,
843 depending on context. "figure" directive: added specialized
844 "align" option and attribute on "figure" element.
845 - Made ":figwidth: image" option of "figure" directive work again.
846 - Fixed bug with reference names containing uppercase letters
847 (e.g. ``Name_``) in "target" option of "image" directive.
849 * docutils/parsers/rst/directives/misc.py:
851 - Fixed "include" and "raw" directives to catch text decoding
853 - Allowed whitespace in "include" & "raw" directive paths.
854 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
855 settings in "include" & "raw" directives.
857 * docutils/parsers/rst/directives/parts.py:
859 - Added "header" & "footer" directives.
860 - Fixed illegal context bug with "contents" directive (topics
861 allowed within sidebars; not within body elements).
863 * docutils/parsers/rst/directives/tables.py:
865 - Added "list-table" directive.
866 - Caught empty CSV table bug.
867 - Added support for the ``file_insertion_enabled`` setting in the
868 "csv-table" directive.
869 - Added ``stub-columns`` option to "csv-table" and "list-table"
872 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
873 mappings by Martijn Pieters.
875 * docutils/readers/standalone.py:
877 - Added ``--section-subtitles`` and ``--no-section-subtitles``
878 options to activate or deactivate the SectSubTitle transform.
880 * docutils/transforms/frontmatter.py:
882 - Added SectSubTitle transform to promote titles of lone
883 subsections to subtitles.
885 * docutils/transforms/references.py:
887 - Fixed mislocated internal targets bug, by propagating internal
888 targets to the next node, making use of the newly added support
889 for multiple names and IDs.
890 - Fixed duplicate footnote label bug.
891 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
894 * docutils/writers/html4css1.py:
896 - Fixed unencoded stylesheet reference bug (characters like "&" in
897 stylesheet references).
898 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
900 - Added support for multiple IDs per node by creating empty ``span``
902 - Added the ``field_name_limit`` & ``option_limit`` settings &
904 - Added support for table stub columns.
905 - Added support for the ``align`` attribute on ``figure`` elements.
906 - Added the ``cloak_email_addresses`` setting & support.
907 - Added ``html_prolog``, ``html_head``, ``html_body``,
908 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
909 ``docutils.core.publish_parts``.
910 - Added support for section subtitles.
912 * docutils/writers/latex2e.py:
914 - Fixed tables starting with more than one multirow cell.
915 - Improved --use-latex-docinfo so that organization/contact/address
916 fields are lumped with the last author field and appear on the
918 - Made sure the titlepage is always shown with --use-latex-docinfo,
919 even if the document has no title.
920 - Made sure that latex doesn't fill in today's date if no date field
922 - Added support for section subtitles.
924 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
927 * docutils/writers/null.py: Added to project; a do-nothing Writer.
929 * docs/api/publisher.txt:
931 - Added "``publish_parts`` Details" section.
933 * docutils/dev/repository.txt: Added to project; information about the
934 Docutils Subversion repository.
936 * docs/ref/docutils.dtd:
938 - Added a ``stub`` attribute to the ``colspec`` element via the
939 ``tbl.colspec.att`` parameter entity.
940 - Allowed topic elements within sidebars
941 - Added an ``align`` attribute to the ``figure`` element.
943 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
947 Release 0.3.7 (2004-12-24)
948 ==========================
950 * docutils/frontend.py:
952 - Added options: --input-encoding-error-handler,
953 --record-dependencies, --leave-footnote-reference-space,
955 - Added command-line and config file support for "overrides" setting
960 - Added support for input encoding error handler.
964 - Added dispatch_visit and dispatch_departure methods to
965 NodeVisitor; useful as a hook for Visitors.
966 - Changed structure of ``line_block``; added ``line``.
967 - Added ``compound`` node class.
968 - Added a mechanism for Visitors to transitionally ignore new node
973 - Moved ``escape2null`` and ``unescape`` functions from
974 docutils/parsers/rst/states.py.
976 * docutils/parsers/rst/roles.py:
979 - Changed role function API: the "text" parameter now takes
980 null-escaped interpreted text content.
982 * docutils/parsers/rst/states.py:
984 - Fixed bug where a "role" directive in a nested parse would crash
985 the parser; the state machine's "language" attribute was not being
987 - Added support for line block syntax.
988 - Fixed directive parsing bug: argument-less directives didn't
989 notice that arguments were present.
990 - Removed error checking for transitions.
991 - Added support for multiple classifiers in definition list items.
992 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
993 - Changed role function API: the "text" parameter now takes
994 null-escaped interpreted text content.
995 - Empty sections and documents are allowed now.
997 * docutils/parsers/rst/directives/__init__.py:
999 - Added ``encoding`` directive option conversion function.
1000 - Allow multiple class names in class_option conversion function.
1002 * docutils/parsers/rst/directives/body.py:
1004 - Converted the line-block directive to use the new structure.
1005 - Extracted the old line-block functionality to the ``block``
1006 function (still used).
1007 - Added ``compound`` directive (thanks to Lea Wiemann).
1009 * docutils/parsers/rst/directives/misc.py:
1011 - Added "encoding" option to "include" and "raw" directives.
1012 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1013 - Allow multiple class names in the "class" directive.
1015 * docutils/parsers/rst/directives/parts.py:
1017 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1018 options. Thanks to Lele Gaifax.
1020 * docutils/parsers/rst/directives/tables.py:
1022 - Added "encoding" directive to "csv-table" directive.
1023 - Added workaround for lack of Unicode support in csv.py, for
1024 non-ASCII CSV input.
1026 * docutils/transforms/misc.py:
1028 - Fixed bug when multiple "class" directives are applied to a single
1030 - Enabled multiple format names for "raw" directive.
1032 * docutils/transforms/references.py:
1034 - Added support for trimming whitespace from beside substitution
1037 * docutils/transforms/universal.py:
1039 - FinalChecks now checks for illegal transitions and moves
1040 transitions between sections.
1042 * docutils/writers/html4css1.py:
1044 - HTMLTranslator.encode now converts U+00A0 to " ".
1045 - "stylesheet" and "stylesheet_path" settings are now mutually
1047 - Added support for the new line_block/line structure.
1048 - --footnote-references now overrides
1049 --trim-footnote-reference-space, if applicable.
1050 - Added support for ``compound`` elements.
1051 - Enabled multiple format names for "raw" directive.
1052 - ``<p>`` tags of a paragraph which is the only visible child of the
1053 document node are no longer stripped.
1054 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1055 new method ``should_be_compact_paragraph()``.
1056 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1058 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1059 the output if they have their ``class`` attribute set.
1060 - The whole document is now surrounded by a ``<div
1061 class="document">`` element.
1062 - Body-level images are now wrapped by their own ``<div>`` elements,
1063 with image classes copied to the wrapper, and for images which
1064 have the ``:align:`` option set, the surrounding ``<div>`` now
1065 receives a class attribute (like ``class="align-left"``).
1067 * docutils/writers/latex2e.py:
1069 - no newline after depart_term.
1070 - Added translations for some Unicode quotes.
1071 - Added option "font-encoding", made package AE the default.
1072 - "stylesheet" and "stylesheet_path" settings are now mutually
1074 - --footnote-references now overrides
1075 --trim-footnote-reference-space, if applicable.
1076 - The footnote label style now matches the footnote reference style
1077 ("brackets" or "superscript").
1078 - Added support for ``compound`` elements.
1079 - Enabled multiple format names for "raw" directive.
1081 * docs/ref/docutils.dtd:
1083 - Changed structure of the ``line_block`` element; added ``line``.
1084 - Added ``compound`` element.
1085 - Added "ltrim" and "rtrim" attributes to
1086 ``substitution_definition`` element.
1087 - Enabled multiple format names for ``raw`` element.
1088 - Enabled multiple classifiers in ``definition_list_item`` elements.
1090 * docs/ref/rst/directives.txt
1092 - Marked "line-block" as deprecated.
1093 - "Class" directive now allows multiple class names.
1094 - Added "Rationale for Class Attribute Value Conversion".
1095 - Added warning about "raw" overuse/abuse.
1097 * docs/ref/rst/restructuredtext.txt:
1099 - Added syntax for line blocks.
1100 - Definition list items may have multiple classifiers.
1102 * docs/ref/rst/roles.txt:
1106 * tools/stylesheets/default.css:
1108 - Added support for the new line_block structure.
1109 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1112 Release 0.3.5 (2004-07-29)
1113 ==========================
1117 * _`Documentation cleanup/reorganization`.
1119 - Created new subdirectories of docs/:
1121 * ``docs/user/``: introductory/tutorial material for end-users
1122 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1123 * ``docs/api/``: API reference material for client-developers
1124 * ``docs/ref/``: reference material for all groups
1125 * ``docs/howto/``: for component-developers and core-developers
1126 * ``docs/peps/``: Python Enhancement Proposals
1128 - Moved ``docs/*`` to ``docs/user/``.
1129 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1130 ``spec/`` to ``docs/dev``.
1131 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1132 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1133 - Moved ``alternatives.txt``, and ``problems.txt`` from
1134 ``spec/rst/`` to ``docs/dev/rst/``.
1135 - Moved ``reStructuredText.txt``, ``directives.txt``,
1136 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1137 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1138 ``roles.txt``, ``reStructuredText.txt`` to
1139 ``restructuredtext.txt``.
1140 - Moved ``spec/howto/`` to ``docs/howto``.
1142 In order to keep the CVS history of moved files, we supplied
1143 SourceForge with a `script for modifying the Docutils CVS
1146 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1148 After running the cleanup script:
1150 - Added ``docs/index.txt``.
1151 - Added a ``.htaccess`` file to the ``web`` module, containing
1152 redirects for all old paths to new paths. They'll preserve
1153 fragments (the "#name" part of a URL), and won't clutter up the
1154 file system, and will correct the URL in the user's browser.
1155 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1156 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1157 the "To Do" list itself in ``docs/dev/todo.txt``.
1158 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1159 section of ``docs/dev/todo.txt``.
1160 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1161 - Added "How To Report Bugs" to ``BUGS.txt``.
1162 - Went through all the sources and docs (including under web/) and
1163 updated links. Mostly done by Lea Wiemann; thanks Lea!
1164 (Still need to update links in the sandboxes.)
1168 * BUGS.txt: Added to project.
1170 * THANKS.txt: Added to project.
1172 * docutils/__init__.py:
1174 - 0.3.4: Post-release.
1178 - Added special error handling & advice for UnicodeEncodeError.
1179 - Refactored Publisher.publish (simplified exception handling &
1180 extracted debug dumps).
1181 - Renamed "enable_exit" parameter of convenience functions to
1182 "enable_exit_status".
1183 - Enabled traceback (exception propagation) by default in
1184 programmatic convenience functions.
1185 - Now publish_file and publish_cmdline convenience functions return
1186 the encoded string results in addition to their regular I/O.
1187 - Extracted common code from publish_file, publish_string, and
1188 publish_parts, into new publish_programmatically. Extracted
1189 settings code to ``Publisher.process_programmatic_settings``.
1190 - In Publisher.publish, disabled ``settings_overrides`` when
1191 ``settings`` is supplied; redundant.
1193 * docutils/frontend.py:
1195 - Added help text for "--output-encoding-error-handler" and
1196 "--error-encoding-error-handler".
1197 - Renamed "--exit" to "--exit-status".
1198 - Simplified default-setting code.
1200 * docutils/parsers/rst/__init__.py:
1202 - Added "--pep-base-url" and "--rfc-base-url" options.
1204 * docutils/parsers/rst/states.py:
1206 - Made URI recognition more aggressive and intelligent.
1208 * docutils/parsers/rst/directives/__init__.py:
1210 - Added several directive option conversion functions.
1212 * docutils/parsers/rst/directives/body.py:
1214 - Moved "table" directive to tables.py.
1216 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1219 * docutils/writers/latex2e.py:
1221 - Added "--table-style=(standard|booktabs|nolines)"
1222 - figures get "here" option (LaTeX per default puts them at bottom),
1223 and figure content is centered.
1224 - Rowspan support for tables.
1225 - Fix: admonition titles before first section.
1226 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1227 - Replave ``_`` in literal by an underlined blank, because it has the correct
1229 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1230 - A few unicode replacements, if output_encoding != utf
1231 - Add "--graphicx-option".
1232 - Indent literal-blocks.
1233 - Fix: omit ``\maketitle`` when there is no document title.
1235 * docs/index.txt: "Docutils Project Documentation Overview", added to
1238 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1239 Tool", added to project.
1241 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1243 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1245 * docs/dev/policies.txt: Added to project (extracted from
1246 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1248 * docs/dev/release.txt: Added to project (extracted from
1249 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1251 * docs/dev/testing.txt: Added to project.
1253 * docs/dev/website.txt: Added to project (extracted from
1254 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1256 * docs/ref/rst/directives.txt:
1258 - Added directives: "table", "csv-table".
1260 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1261 added to project. 1 page for syntax, and a 1 page reference for
1262 directives and roles. Source text to be used as-is; not meant to be
1265 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1266 with a change of title.
1268 * test/functional/, contents, and test/test_functional.py: Added to
1271 * tools/buildhtml.py: Fixed bug with config file handling.
1273 * tools/html.py: Removed from project (duplicate of rst2html.py).
1275 * tools/pep2html.py: Removed from project (duplicate of Python's
1276 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1277 Docutils-related PEPs in docs/peps/).
1279 * tools/rst2pseudoxml.py: Renamed from publish.py.
1281 * tools/rst2xml.py: Renamed from docutils-xml.py.
1283 * tools/test.txt: Removed from project; moved to
1284 docs/user/rst/demo.txt.
1286 * setup.py: Now also installs ``rst2latex.py``.
1289 Release 0.3.3 (2004-05-09)
1290 ==========================
1292 * docutils/__init__.py:
1294 - 0.3.1: Reorganized config file format (multiple sections); see
1296 - Added unknown_reference_resolvers attribute to TransformSpec.
1297 - 0.3.2: Interpreted text reorganization.
1302 - Catch system messages to stop tracebacks from parsing errors.
1303 - Catch exceptions during processing report & exit without
1304 tracebacks, except when "--traceback" used.
1305 - Reordered components for OptionParser; application comes last.
1306 - Added "config_section" parameter to several methods and functions,
1307 allowing front ends to easily specify their config file sections.
1308 - Added publish_parts convenience function to allow access to individual
1309 parts of a document.
1311 * docutils/examples.py: Added to project; practical examples of
1312 Docutils client code, to be used as-is or as models for variations.
1314 * docutils/frontend.py:
1316 - Added "--traceback" & "--no-traceback" options ("traceback"
1318 - Implemented support for config file reorganization:
1319 ``standard_config_files`` moved from ``ConfigParser`` to
1320 ``OptionParser``; added
1321 ``OptionParser.get_config_file_settings()`` and
1322 ``.get_standard_config_settings()``; support for old "[options]"
1323 section (with deprecation warning) and mapping from old to new
1325 - Reimplemented setting validation.
1326 - Enabled flexible boolean values: yes/no, true/false, on/off.
1327 - Added ``Values``, a subclass of ``optparse.Values``, with support
1328 for list setting attributes.
1329 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1330 thanks to Beni Cherniavsky.
1331 - Added "--no-section-numbering" option.
1335 - Catch IOErrors when opening source & destination files, report &
1336 exit without tracebacks. Added ``handle_io_errors`` parameter to
1337 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1339 * docutils/nodes.py:
1341 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1342 method definitions (via ``exec``) to dynamic assignments (via
1343 ``setattr``); thanks to Roman Suzi.
1344 - Encapsulated visitor dynamic assignments in a function; thanks to
1346 - Added indirect_reference_name attribute to the Targetable
1347 class. This attribute holds the whitespace_normalized_name
1348 (contains mixed case) of a target.
1350 * docutils/statemachine.py:
1352 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1353 - Added ``StringList.get_2D_block``.
1355 * docutils/utils.py:
1357 - Added "level" attribute to SystemMessage exceptions.
1359 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1362 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1365 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1366 Marcelo Huerta San Martin.
1368 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1369 mappings by Lalo Martins.
1371 * docutils/languages/ru.py: Added to project; Russian mappings by
1374 * docutils/parsers/rst/roles.py: Added to project. Contains
1375 interpreted text role functions, a registry for interpreted text
1376 roles, and an API for adding to and retrieving from the registry.
1377 Contributed by Edward Loper.
1379 * docutils/parsers/rst/states.py:
1381 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1382 - Allowed true em-dash character and "---" as block quote
1384 - Added support for <angle-bracketed> complex option arguments
1386 - Fixed handling of backslashes in substitution definitions.
1387 - Fixed off-by-1 error with extra whitespace after substitution
1388 definition directive.
1389 - Added inline markup parsing to field lists' field names.
1390 - Added support for quoted (and unindented) literal blocks.
1391 Driven in part by a bribe from Frank Siebenlist (thanks!).
1392 - Parser now handles escapes in URIs correctly.
1393 - Made embedded-URIs' reference text omittable. Idea from Beni
1395 - Refactored explicit target processing code.
1396 - Added name attribute to references containing the reference name only
1397 through whitespace_normalize_name (no case changes).
1398 - parse_target no longer returns the refname after going through
1399 normalize_name. This is now handled in make_target.
1400 - Fixed bug relating to role-less interpreted text in non-English
1402 - Reorganized interpreted text processing; moved code into the new
1403 roles.py module. Contributed by Edward Loper.
1404 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1405 ``parse_directive_block``.
1407 * docutils/parsers/rst/tableparser.py:
1409 - Reworked for ``StringList``, to support "include" directives in
1412 * docutils/parsers/rst/directives/__init__.py:
1414 - Renamed ``unchanged()`` directive option conversion function to
1415 ``unchanged_required``, and added a new ``unchanged``.
1416 - Catch unicode value too high error; fixes bug 781766.
1417 - Beefed up directive error reporting.
1419 * docutils/parsers/rst/directives/body.py:
1421 - Added basic "table" directive.
1423 * docutils/parsers/rst/directives/images.py:
1425 - Added "target" option to "image" directive.
1426 - Added name attribute to references containing the reference name only
1427 through whitespace_normalize_name (no case changes).
1429 * docutils/parsers/rst/directives/misc.py:
1431 - Isolated the import of the ``urllib2`` module; was causing
1432 problems on SourceForge (``libssl.so.2`` unavailable?).
1433 - Added the "role" directive for declaring custom interpreted text
1436 * docutils/parsers/rst/directives/parts.py:
1438 - The "contents" directive does more work up-front, creating the
1439 "topic" and "title", and leaving the "pending" node for the
1440 transform. Allows earlier reference resolution; fixes subtle bug.
1442 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1443 mappings by Jannie Hofmeyr.
1445 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1446 mappings by Marek Blaha.
1448 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1449 mappings by Marcelo Huerta San Martin.
1451 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1452 Portuguese mappings by Lalo Martins.
1454 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1455 mappings by Roman Suzi.
1457 * docutils/transforms/parts.py:
1459 - The "contents" directive does more work up-front, creating the
1460 "topic" and "title", and leaving the "pending" node for the
1461 transform. Allows earlier reference resolution; fixes subtle bug.
1462 - Added support for disabling of section numbering.
1464 * docutils/transforms/references.py:
1466 - Verifying that external targets are truly targets and not indirect
1467 references. This is because we are now adding a "name" attribute to
1468 references in addition to targets. Note sure if this is correct!
1469 - Added code to hook into the unknown_reference_resolvers list for a
1470 transformer in resolve_indirect_target. This allows the
1471 unknown_reference_resolvers to keep around indirect targets which
1472 docutils doesn't know about.
1473 - Added specific error message for duplicate targets.
1475 * docutils/transforms/universal.py:
1477 - Added FilterMessages transform (removes system messages below the
1478 verbosity threshold).
1479 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1480 to FinalCheckVisitor for application-specific handling of
1481 unresolvable references.
1482 - Added specific error message for duplicate targets.
1484 * docutils/writers/__init__.py:
1486 - Added assemble_parts method to the Writer class to allow for
1487 access to a documents individual parts.
1488 - Documented & set default for ``Writer.output`` attribute.
1490 * docutils/writers/html4css1.py:
1492 - Fixed unicode handling of attribute values (bug 760673).
1493 - Prevent duplication of "class" attribute values (bug report from
1495 - Improved table grid/border handling (prompted by report from Bob
1497 - Added support for table titles.
1498 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1500 - Added functionality to keep track of individual parts of a document
1501 and store them in a dictionary as the "parts" attribute of the writer.
1502 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1503 - Added proper support for the "scale" attribute of the "image"
1504 element. Contributed by Brent Cook.
1505 - Added ``--initial-header-level`` option.
1506 - Fixed bug: the body_pre_docinfo segment depended on there being a
1507 docinfo; if no docinfo, the document title was incorporated into
1508 the body segment. Adversely affected the publish_parts interface.
1510 * docutils/writers/latex2e.py:
1512 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1513 about a missing file.
1514 - Added options and support: ``--compound-enumerators``,
1515 ``--section-prefix-for-enumerators``, and
1516 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1518 - Added option ``--use-verbatim-when-possible``, to avoid
1519 problematic characters (eg, '~' in italian) in literal blocks.
1520 - It's now possible to use four section levels in the `book` and
1521 `report` LaTeX classes. The default `article` class still has
1524 * docs/config.txt: "Docutils Configuration Files", added to project.
1525 Moved config file entry descriptions from tools.txt.
1529 - Moved config file entry descriptions to config.txt.
1531 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1534 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1535 Text Roles", added to project.
1537 * spec/rst/reStructuredText.txt:
1539 - Added description of support for <angle-bracketed> complex option
1540 arguments to option lists.
1541 - Added subsections for indented and quoted literal blocks.
1543 * test: Continually adding & updating tests.
1545 - Added test/test_settings.py & test/data/config_*.txt support
1547 - Added test/test_writers/test_htmlfragment.py.
1549 * test/DocutilsTestSupport.py:
1551 - Refactored LaTeX publisher test suite/case class names to make
1552 testing other writers easier.
1553 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1554 to test the processing of HTML fragments which use the new
1555 publish_parts convenience function.
1557 * tools/buildhtml.py:
1559 - Added support for the "--prune" option.
1560 - Removed dependency on pep2html.py; plaintext PEPs no longer
1563 * tools/docutils.conf:
1565 - Updated for configuration file reorganization.
1567 * tools/rst2html.py:
1569 - copied from tools/html.py
1573 - added a 'scripts' section to configuration
1574 - added 'tools/rst2html.py' to the scripts section
1577 Release 0.3 (2003-06-24)
1578 ========================
1582 * Renamed "attribute" to "option" for directives/extensions.
1584 * Renamed transform method "transform" to "apply".
1586 * Renamed "options" to "settings" for runtime settings (as set by
1587 command-line options). Sometimes "option" (singular) became
1588 "settings" (plural). Some variations below:
1590 - document.options -> document.settings (stored in other objects as
1592 - option_spec -> settings_spec (not directives though)
1593 - OptionSpec -> SettingsSpec
1594 - cmdline_options -> settings_spec
1595 - relative_path_options -> relative_path_settings
1596 - option_default_overrides -> settings_default_overrides
1597 - Publisher.set_options -> Publisher.get_settings
1601 * COPYING.txt: Added "Public Domain Dedication".
1603 * FAQ.txt: Frequently asked questions, added to project.
1607 - Updated with PyPI Trove classifiers.
1608 - Conditional installation of third-party modules.
1610 * docutils/__init__.py:
1612 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1613 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1614 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1615 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1616 option and its effect on the PEP template & writer.
1617 - Bumped version to 0.2.4 due to changes to the PEP template &
1619 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1620 - Added ``TransformSpec`` class for new transform system.
1621 - Bumped version to 0.2.6 for API changes (renaming).
1622 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1623 convenience functions.
1624 - Added ``Component.component_type`` attribute.
1625 - Bumped version to 0.2.8 because of the internal parser switch from
1626 plain lists to the docutils.statemachine.StringList objects.
1627 - Bumped version to 0.2.9 because of the frontend.py API changes.
1628 - Bumped version to 0.2.10 due to changes to the project layout
1629 (third-party modules removed from the "docutils" package), and
1630 signature changes in ``io.Input``/``io.Output``.
1631 - Changed version to 0.3.0 for release.
1635 - Made ``publish()`` a bit more convenient.
1636 - Generalized ``Publisher.set_io``.
1637 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1638 parameters; improved its docstring.
1639 - Added ``publish_file()`` and ``publish_string()``.
1640 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1642 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1643 "--dump-transforms" hidden options.
1644 - Added ``Publisher.apply_transforms()`` method.
1645 - Added ``Publisher.set_components()`` method; support for
1646 ``publish_*()`` conveninece functions.
1647 - Moved config file processing to docutils/frontend.py.
1648 - Added support for exit status ("exit_level" setting &
1649 ``enable_exit`` parameter for Publisher.publish() and convenience
1652 * docutils/frontend.py:
1654 - Check for & exit on identical source & destination paths.
1655 - Fixed bug with absolute paths & "--config".
1656 - Set non-command-line defaults in ``OptionParser.__init__()``:
1657 ``_source`` & ``_destination``.
1658 - Distributed ``relative_path_settings`` to components; updated
1659 ``OptionParser.populate_from_components()`` to combine it all.
1660 - Require list of keys in ``make_paths_absolute`` (was implicit in
1661 global ``relative_path_settings``).
1662 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1663 "--dump-settings", and "--dump-transforms" hidden options.
1664 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1665 code, replaced with correct code.
1666 - Added validation functionality for config files.
1667 - Added "--error-encoding" option/setting, "_disable_config"
1669 - Added encoding validation; updated "--input-encoding" and
1670 "--output-encoding"; added "--error-encoding-error-handler" and
1671 "--output-encoding-error-handler".
1672 - Moved config file processing from docutils/core.py.
1673 - Updated ``OptionParser.populate_from_components`` to handle new
1674 ``SettingsSpec.settings_defaults`` dict.
1675 - Added support for "-" => stdin/stdout.
1676 - Added "exit_level" setting ("--exit" option).
1680 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1681 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1682 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1683 - ``FileOutput.write()`` now returns the encoded output string.
1684 - Try to get path/stream name automatically in ``FileInput`` &
1686 - Added defaults for source & destination paths.
1687 - Allow for Unicode I/O with an explicit "unicode" encoding.
1688 - Added ``Output.encode()``.
1689 - Removed dependency on runtime settings; pass encoding directly.
1690 - Recognize Unicode strings in ``Input.decode()``.
1691 - Added support for output encoding error handlers.
1693 * docutils/nodes.py:
1695 - Added "Invisible" element category class.
1696 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1697 modification during a traversal.
1698 - Added element classes: ``line_block``, ``generated``, ``address``,
1699 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1700 ``superscript``, ``subscript``, ``inline``
1701 - Added support for lists of nodes to ``Element.insert()``.
1702 - Fixed parent linking in ``Element.replace()``.
1703 - Added new abstract superclass ``FixedTextElement``; adds
1704 "xml:space" attribute.
1705 - Added support for "line" attribute of ``system_message`` nodes.
1706 - Added support for the observer pattern from ``utils.Reporter``.
1707 Added ``parse_messages`` and ``transform_messages`` attributes to
1708 ``document``, removed ``messages``. Added ``note_parse_message``
1709 and ``note_transform_message`` methods.
1710 - Added support for improved diagnostics:
1712 - Added "document", "source", and "line" internal attributes to
1713 ``Node``, set by ``Node.setup_child()``.
1714 - Converted variations on ``node.parent = self`` to
1715 ``self.setup_child(node)``.
1716 - Added ``document.current_source`` & ``.current_line``
1717 attributes, and ``.note_source`` observer method.
1718 - Changed "system_message" output to GNU-Tools format.
1720 - Added a "rawsource" attribute to the ``Text`` class, for text
1721 before backslash-escape resolution.
1722 - Support for new transform system.
1723 - Reworked ``pending`` element.
1724 - Fixed XML DOM bug (SF #660611).
1725 - Removed the ``interpeted`` element class and added
1726 ``title_reference``, ``abbreviation``, ``acronym``.
1727 - Made substitutions case-sensitive-but-forgiving; moved some code
1729 - Fixed Unicode bug on element attributes (report: William Dode).
1731 * docutils/optik.py: Removed from project; replaced with
1732 extras/optparse.py and extras/textwrap.py. These will be installed
1733 only if they're not already present in the Python installation.
1735 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1736 only if it's not already present in the Python installation.
1738 * docutils/statemachine.py:
1740 - Factored out ``State.add_initial_transitions()`` so it can be
1742 - Converted whitespace-specific "blank" and "indent" transitions
1743 from special-case code to ordinary transitions: removed
1744 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1745 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1746 ``ws_initial_transitions`` attributes.
1747 - Removed ``State.match_transition()`` after merging it into
1749 - Added ``StateCorrection`` exception.
1750 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1751 (moved ``TransitionCorrection`` support there too.)
1752 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1753 ``EOFError`` instead of ``IndexError``.
1754 - Added ``State.no_match`` method.
1755 - Added support for the Observer pattern, triggered by input line
1757 - Added ``strip_top`` parameter to
1758 ``StateMachineWS.get_first_known_indented``.
1759 - Made ``context`` a parameter to ``StateMachine.run()``.
1760 - Added ``ViewList`` & ``StringList`` classes;
1761 ``extract_indented()`` becomes ``StringList.get_indented()``.
1762 - Added ``StateMachine.insert_input()``.
1763 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1764 thanks to) Fred Drake.
1766 * docutils/utils.py:
1768 - Added a ``source`` attribute to Reporter instances and
1769 ``system_message`` elements.
1770 - Added an observer pattern to ``utils.Reporter`` to keep track of
1772 - Fixed bugs in ``relative_path()``.
1773 - Added support for improved diagnostics.
1774 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1775 - Added support for encoding Reporter stderr output, and encoding
1777 - Reporter keeps track of the highest level system message yet
1780 * docutils/languages: Fixed bibliographic field language lookups.
1782 * docutils/languages/es.py: Added to project; Spanish mappings by
1783 Marcelo Huerta San Martin.
1785 * docutils/languages/fr.py: Added to project; French mappings by
1788 * docutils/languages/it.py: Added to project; Italian mappings by
1791 * docutils/languages/sk.py: Added to project; Slovak mappings by
1794 * docutils/parser/__init__.py:
1796 - Added ``Parser.finish_parse()`` method.
1798 * docutils/parser/rst/__init__.py:
1800 - Added options: "--pep-references", "--rfc-references",
1801 "--tab-width", "--trim-footnote-reference-space".
1803 * docutils/parsers/rst/states.py:
1805 - Changed "title under/overline too short" system messages from INFO
1806 to WARNING, and fixed its insertion location.
1807 - Fixed enumerated list item parsing to allow paragraphs & section
1808 titles to begin with enumerators.
1809 - Converted system messages to use the new "line" attribute.
1810 - Fixed a substitution reference edge case.
1811 - Added support for "--pep-references" and "--rfc-references"
1812 options; reworked ``Inliner`` code to make customization easier.
1813 - Removed field argument parsing.
1814 - Added support for short section title over/underlines.
1815 - Fixed "simple reference name" regexp to ignore text like
1816 "object.__method__"; not an anonymous reference.
1817 - Added support for improved diagnostics.
1818 - Reworked directive API, based on Dethe Elza's contribution. Added
1819 ``Body.parse_directive()``, ``.parse_directive_options()``,
1820 ``.parse_directive_arguments()`` methods.
1821 - Added ``ExtensionOptions`` class, to parse directive options
1822 without parsing field bodies. Factored
1823 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1824 ``ExtensionOptions``.
1825 - Improved definition list term/classifier parsing.
1826 - Added warnings for unknown directives.
1827 - Renamed ``Stuff`` to ``Struct``.
1828 - Now flagged as errors: transitions at the beginning or end of
1829 sections, empty sections (except title), and empty documents.
1830 - Updated for ``statemachine.StringList``.
1831 - Enabled recognition of schemeless email addresses in targets.
1832 - Added support for embedded URIs in hyperlink references.
1833 - Added backslash-escapes to inline markup end-string suffix.
1834 - Added support for correct interpreted text processing.
1835 - Fixed nested title parsing (topic, sidebar directives).
1836 - Added special processing of backslash-escaped whitespace (idea
1837 from David Abrahams).
1838 - Made substitutions case-sensitive-but-forgiving; moved some code
1839 to ``docutils.nodes``.
1840 - Added support for block quote attributions.
1841 - Added a kludge to work-around a conflict between the bubble-up
1842 parser strategy and short titles (<= 3 char-long over- &
1843 underlines). Fixes SF bug #738803 "infinite loop with multiple
1844 titles" submitted by Jason Diamond.
1845 - Added explicit interpreted text roles for standard inline markup:
1846 "emphasis", "strong", "literal".
1847 - Implemented "superscript" and "subscript" interpreted text roles.
1848 - Added initial support for "abbreviation" and "acronym" roles;
1850 - Added support for "--trim-footnote-reference-space" option.
1851 - Optional space before colons in directives & hyperlink targets.
1853 * docutils/parsers/rst/tableparser.py:
1855 - Fixed a bug that was producing unwanted empty rows in "simple"
1857 - Detect bad column spans in "simple" tables.
1859 * docutils/parsers/rst/directives: Updated all directive functions to
1862 * docutils/parsers/rst/directives/__init__.py:
1864 - Added ``flag()``, ``unchanged()``, ``path()``,
1865 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1866 directive option helper functions.
1867 - Added warnings for unknown directives.
1868 - Return ``None`` for missing directives.
1869 - Added ``register_directive()``, thanks to William Dode and Paul
1872 * docutils/parsers/rst/directives/admonitions.py:
1874 - Added "admonition" directive.
1876 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1877 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1878 "parsed-literal", "rubric", "epigraph", "highlights" and
1879 "pull-quote" directives.
1881 * docutils/parsers/rst/directives/images.py:
1883 - Added an "align" attribute to the "image" & "figure" directives
1884 (by Adam Chodorowski).
1885 - Added "class" option to "image", and "figclass" to "figure".
1887 * docutils/parsers/rst/directives/misc.py:
1889 - Added "include", "raw", and "replace" directives, courtesy of
1891 - Added "unicode" and "class" directives.
1893 * docutils/parsers/rst/directives/parts.py:
1895 - Added the "sectnum" directive; by Dmitry Jemerov.
1896 - Added "class" option to "contents" directive.
1898 * docutils/parsers/rst/directives/references.py: Added to project.
1899 Contains the "target-notes" directive.
1901 * docutils/parsers/rst/languages/__init__.py:
1903 - Return ``None`` from get_language() for missing language modules.
1905 * docutils/parsers/rst/languages/de.py: Added to project; German
1906 mappings by Engelbert Gruber.
1908 * docutils/parsers/rst/languages/en.py:
1910 - Added interpreted text roles mapping.
1912 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1913 mappings by Marcelo Huerta San Martin.
1915 * docutils/parsers/rst/languages/fr.py: Added to project; French
1916 mappings by William Dode.
1918 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1919 mappings by Nicola Larosa.
1921 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1922 mappings by Miroslav Vasko.
1924 * docutils/readers/__init__.py:
1926 - Added support for the observer pattern from ``utils.Reporter``, in
1927 ``Reader.parse`` and ``Reader.transform``.
1928 - Removed ``Reader.transform()`` method.
1929 - Added default parameter values to ``Reader.__init__()`` to make
1930 instantiation easier.
1931 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1933 * docutils/readers/pep.py:
1935 - Added the ``peps.TargetNotes`` transform to the Reader.
1936 - Removed PEP & RFC reference detection code; moved to
1937 parsers/rst/states.py as options (enabled here by default).
1938 - Added support for pre-acceptance PEPs (no PEP number yet).
1939 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1942 * docutils/readers/python: Python Source Reader subpackage added to
1943 project, including preliminary versions of:
1946 - moduleparser.py: Parser for Python modules.
1948 * docutils/transforms/__init__.py:
1950 - Added ``Transformer`` class and completed transform reform.
1951 - Added unknown_reference_resolvers list for each transformer. This list holds
1952 the list of functions provided by each component of the transformer that
1953 help resolve references.
1955 * docutils/transforms/frontmatter.py:
1957 - Improved support for generic fields.
1958 - Fixed bibliographic field language lookups.
1960 * docutils/transforms/misc.py: Added to project. Miscellaneous
1963 * docutils/transforms/parts.py:
1965 - Moved the "id" attribute from TOC list items to the references
1966 (``Contents.build_contents()``).
1967 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1968 - Added "class" attribute support to ``Contents``.
1970 * docutils/transforms/peps.py:
1972 - Added ``mask_email()`` function, updating to pep2html.py's
1974 - Linked "Content-Type: text/x-rst" to PEP 12.
1975 - Added the ``TargetNotes`` PEP-specific transform.
1976 - Added ``TargetNotes.cleanup_callback``.
1977 - Added title check to ``Headers``.
1979 * docutils/transforms/references.py:
1981 - Added the ``TargetNotes`` generic transform.
1982 - Split ``Hyperlinks`` into multiple transforms.
1983 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1984 - Added check for circular indirect references.
1985 - Made substitutions case-sensitive-but-forgiving.
1987 * docutils/transforms/universal.py:
1989 - Added support for the "--expose-internal-attributes" option.
1990 - Removed ``Pending`` transform classes & data.
1992 * docutils/writers/__init__.py:
1994 - Removed ``Writer.transform()`` method.
1996 * docutils/writers/docutils-xml.py:
1998 - Added XML and doctype declarations.
1999 - Added "--no-doctype" and "--no-xml-declaration" options.
2001 * docutils/writers/html4css1.py:
2003 - "name" attributes only on these tags: a, applet, form, frame,
2005 - Added "name" attribute to <a> in section titles for Netscape 4
2006 support (bug report: Pearu Peterson).
2007 - Fixed targets (names) on footnote, citation, topic title,
2008 problematic, and system_message nodes (for Netscape 4).
2009 - Changed field names from "<td>" to "<th>".
2010 - Added "@" to "@" encoding to thwart address harvesters.
2011 - Improved the vertical whitespace optimization; ignore "invisible"
2012 nodes (targets, comments, etc.).
2013 - Improved inline literals with ``<span class="pre">`` around chunks
2014 of text and `` `` for runs of spaces.
2015 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2016 ``self.docinfo`` segments.
2017 - Added support for "line_block", "address" elements.
2018 - Improved backlinks (footnotes & system_messages).
2019 - Improved system_message output.
2020 - Redefined "--stylesheet" as containing an invariant URL, used
2021 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2023 - Added "--footnote-references" option (superscript or brackets).
2024 - Added "--compact-lists" and "--no-compact-lists" options.
2025 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2026 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2027 - Improved field list rendering.
2028 - Added Docutils version to "generator" meta tag.
2029 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2030 - Improved layout of <pre> HTML source.
2031 - Fixed attribute typo on <colspec>.
2032 - Refined XML prologue.
2033 - Support for no stylesheet.
2034 - Removed "interpreted" element support.
2035 - Added support for "title_reference", "sidebar", "attribution",
2036 "rubric", and generic "admonition" elements.
2037 - Added "--attribution" option.
2038 - Added support for "inline", "subscript", "superscript" elements.
2039 - Added initial support for "abbreviation" and "acronym";
2042 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2046 - Double quotes in literal blocks (special treatment for de/ngerman).
2047 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2048 - Added "--attribution" option.
2049 - Right align attributions.
2051 * docutils/writers/pep_html.py:
2053 - Parameterized output encoding in PEP template.
2054 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2055 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2056 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2058 - Added an override on the "--footnote-references" option.
2059 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2060 - Added Docutils version to "generator" meta tag.
2061 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2065 - Added a "silent" setting for ``buildhtml.py``.
2066 - Added a "Getting Help" section.
2067 - Rearranged the structure.
2068 - Kept up to date, with new settings, command-line options etc.
2069 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2070 - Converted settings table into a definition list.
2072 * docs/rst/quickstart.txt:
2074 - Added a table of contents.
2075 - Added feedback information.
2076 - Added mention of minimum section title underline lengths.
2077 - Removed the 4-character minimum for section title underlines.
2079 * docs/rst/quickref.html:
2081 - Added a "Getting Help" section.
2082 - Added a style to make section title backlinks more subtle.
2083 - Added mention of minimum section title underline lengths.
2084 - Removed the 4-character minimum for section title underlines.
2086 * extras: Directory added to project; contains third-party modules
2087 that Docutils depends on (optparse, textwrap, roman). These are
2088 only installed if they're not already present.
2090 * licenses: Directory added to project; contains copies of license
2091 files for non-public-domain files.
2095 - Changed the focus. It's about DTD elements: structural
2096 relationships, semantics, and external (public) attributes. Not
2097 about the element class library.
2098 - Moved some implementation-specific stuff into ``docutils.nodes``
2100 - Wrote descriptions of all common attributes and parameter
2101 entities. Filled in introductory material.
2102 - Working through the element descriptions: 55 down, 37 to go.
2103 - Removed "Representation of Horizontal Rules" to
2104 spec/rst/alternatives.txt.
2106 * spec/docutils.dtd:
2108 - Added "generated" inline element.
2109 - Added "line_block" body element.
2110 - Added "auto" attribute to "title".
2111 - Changed content models of "literal_block" and "doctest_block" to
2113 - Added ``%number;`` attribute type parameter entity.
2114 - Changed ``%structural.elements;`` to ``%section.elements``.
2115 - Updated attribute types; made more specific.
2116 - Added "address" bibliographic element.
2117 - Added "line" attribute to ``system_message`` element.
2118 - Removed "field_argument" element; "field_name" may contain
2119 multiple words and whitespace.
2120 - Changed public identifier to docutils.sf.net.
2121 - Removed "interpreted" element; added "title_reference",
2122 "abbreviation", "acronym".
2123 - Removed "refuri" attribute from "footnote_reference" and
2124 "citation_reference".
2125 - Added "sidebar", "rubric", "attribution", "admonition",
2126 "superscript", "subscript", and "inline" elements.
2128 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2130 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2132 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2134 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2137 * spec/transforms.txt: Added to project.
2139 * spec/howto: Added subdirectory, for developer how-to docs.
2141 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2142 Elza, edited & extended by David Goodger.
2144 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2147 * spec/rst/alternatives.txt:
2149 - Added "Doctree Representation of Transitions" from
2151 - Updated "Inline External Targets" & closed the debate.
2152 - Added ideas for interpreted text syntax extensions.
2153 - Added "Nested Inline Markup" section.
2155 * spec/rst/directives.txt:
2157 - Added directives: "topic", "sectnum", "target-notes",
2158 "line-block", "parsed-literal", "include", "replace", "sidebar",
2159 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2161 - Formalized descriptions of directive details.
2162 - Added an "align" attribute to the "image" & "figure" directives
2163 (by Adam Chodorowski).
2164 - Added "class" options to "topic", "sidebar", "line-block",
2165 "parsed-literal", "contents", and "image"; and "figclass" to
2168 * spec/rst/interpreted.txt: Added to project. Descriptions of
2169 interpreted text roles.
2171 * spec/rst/introduction.txt:
2173 - Added pointers to material for new users.
2175 * spec/rst/reStructuredText.txt:
2177 - Disambiguated comments (just add a newline after the "::").
2178 - Updated enumerated list description; added a discussion of the
2179 second-line validity checking.
2180 - Updated directive description.
2181 - Added a note redirecting newbies to the user docs.
2182 - Expanded description of inline markup start-strings in non-markup
2184 - Removed field arguments and made field lists a generic construct.
2185 - Removed the 4-character minimum for section title underlines.
2186 - Clarified term/classifier delimiter & inline markup ambiguity
2188 - Added "Embedded URIs".
2189 - Updated "Interpreted Text" section.
2190 - Added "Character-Level Inline Markup" section.
2192 * test: Continually adding & updating tests.
2194 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2195 - Moved test/test_pep/ to test/test_readers/test_pep/.
2196 - Added test/test_readers/test_python/.
2197 - Added test/test_writers/ (Engelbert Gruber).
2201 - Made the ``locale.setlocale()`` calls in front ends
2204 * tools/buildhtml.py:
2206 - Added "--silent" option.
2207 - Fixed bug with absolute paths & "--config".
2208 - Updated for new I/O classes.
2209 - Added some exception handling.
2210 - Separated publishers' setting defaults; prevents interference.
2211 - Updated for new ``publish_file()`` convenience function.
2213 * tools/pep-html-template:
2215 - Allow for "--embed-stylesheet".
2216 - Added Docutils version to "generator" meta tag.
2217 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2218 - Conform to XHTML spec.
2220 * tools/pep2html.py:
2222 - Made ``argv`` a parameter to ``main()``.
2223 - Added support for "Content-Type:" header & arbitrary PEP formats.
2224 - Linked "Content-Type: text/plain" to PEP 9.
2225 - Files skipped (due to an error) are not pushed onto the server.
2226 - Updated for new I/O classes.
2227 - Added ``check_requirements()`` & ``pep_type_error()``.
2228 - Added some exception handling.
2229 - Updated for new ``publish_string()`` convenience function.
2230 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2232 * tools/quicktest.py:
2234 - Added "-V"/"--version" option.
2236 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2238 * tools/unicode2rstsubs.py: Added to project. Produces character
2239 entity files (reSructuredText substitutions) from the MathML master
2242 * tools/editors: Support code for editors, added to project. Contains
2243 ``emacs/restructuredtext.el``.
2245 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2247 - Added style for chunks of inline literals.
2248 - Removed margin for first child of table cells.
2249 - Right-aligned field list names.
2250 - Support for auto-numbered section titles in TOCs.
2251 - Increased the size of inline literals (<tt>) in titles.
2252 - Restored the light gray background for inline literals.
2253 - Added support for "line_block" elements.
2254 - Added style for "address" elements.
2255 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2256 - Improved field list rendering.
2257 - Vertical whitespace improvements.
2258 - Removed "a.target" style.
2260 * tools/stylesheets/pep.css:
2262 - Fixed nested section margins.
2263 - Other changes parallel those of ``../default.css``.
2266 Release 0.2 (2002-07-31)
2267 ========================
2271 - The word "component" was being used ambiguously. From now on,
2272 "component" will be used to mean "Docutils component", as in Reader,
2273 Writer, Parser, or Transform. Portions of documents (Table of
2274 Contents, sections, etc.) will be called "document parts".
2275 - Did a grand renaming: a lot of ``verylongnames`` became
2276 ``very_long_names``.
2277 - Cleaned up imports: no more relative package imports or
2278 comma-separated lists of top-level modules.
2279 - Added support for an option values object which carries default
2280 settings and overrides (from command-line options and library use).
2281 - Added internal Unicode support, and support for both input and
2283 - Added support for the ``docutils.io.IO`` class & subclasses.
2287 * docutils/__init__.py:
2289 - Added ``ApplicationError`` and ``DataError``, for use throughout
2291 - Added ``Component`` base class for Docutils components; implements
2292 the ``supports`` method.
2293 - Added ``__version__`` (thus, ``docutils.__version__``).
2297 - Removed many keyword parameters to ``Publisher.__init__()`` and
2298 ``publish()``; bundled into an option values object. Added
2299 "argv", "usage", "description", and "option_spec" parameters for
2300 command-line support.
2301 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2303 - Reworked I/O model for ``docutils.io`` wrappers.
2304 - Updated ``Publisher.set_options()``; now returns option values
2306 - Added support for configuration files (/etc/docutils.conf,
2307 ./docutils.conf, ~/.docutils).
2308 - Added ``Publisher.setup_option_parser()``.
2309 - Added default usage message and description.
2311 * docutils/frontend.py: Added to project; support for front-end
2312 (command-line) scripts. Option specifications may be augmented by
2313 components. Requires Optik (http://optik.sf.net/) for option
2314 processing (installed locally as docutils/optik.py).
2316 * docutils/io.py: Added to project; uniform API for a variety of input
2319 * docutils/nodes.py:
2321 - Added ``TreeCopyVisitor`` class.
2322 - Added a ``copy`` method to ``Node`` and subclasses.
2323 - Added a ``SkipDeparture`` exception for visitors.
2324 - Renamed ``TreePruningException`` from ``VisitorException``.
2325 - Added docstrings to ``TreePruningException``, subclasses, and
2327 - Improved docstrings.
2328 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2329 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2331 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2332 ``PreDecorative`` mixin.
2333 - Reworked the name/id bookkeeping; to ``document``, removed
2334 ``explicit_targets`` and ``implicit_targets`` attributes, added
2335 ``nametypes`` attribute and ``set_name_id_map`` method.
2336 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2338 - Added ``document.has_name()`` method.
2339 - Fixed DOM generation for list-attributes.
2340 - Added category class ``Labeled`` (used by footnotes & citations).
2341 - Added ``Element.set_class()`` method (sets "class" attribute).
2343 * docutils/optik.py: Added to project. Combined from the Optik
2344 package, with added option groups and other modifications. The use
2345 of this module is probably only temporary.
2347 * docutils/statemachine.py:
2349 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2350 - Added underscores to improve many awkward names.
2351 - In ``string2lines()``, changed whitespace normalizing translation
2352 table to regexp; restores Python 2.0 compatibility with Unicode.
2354 * docutils/urischemes.py:
2356 - Filled in some descriptions.
2357 - Added "shttp" scheme.
2359 * docutils/utils.py:
2361 - Added ``clean_rcs_keywords`` function (moved from
2362 docutils/transforms/frontmatter.py
2363 ``DocInfo.filter_rcs_keywords``).
2364 - Added underscores to improve many awkward names.
2365 - Changed names of Reporter's thresholds:
2366 warning_level -> report_level; error_level -> halt_level.
2367 - Moved ``utils.id()`` to ``nodes.make_id()``.
2368 - Added ``relative_path(source, target)``.
2370 * docutils/languages/de.py: German mappings; added to project. Thanks
2371 to Gunnar Schwant for the translations.
2373 * docutils/languages/en.py: Added "Dedication" bibliographic field
2376 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2379 * docutils/parsers/rst/states.py:
2381 - Added underscores to improve many awkward names.
2382 - Added RFC-2822 header support.
2383 - Extracted the inline parsing code from ``RSTState`` to a separate
2384 class, ``Inliner``, which will allow easy subclassing.
2385 - Made local bindings for ``memo`` container & often-used contents
2386 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2387 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2388 - Added ``MarkupMismatch`` exception; for late corrections.
2389 - Added ``-/:`` characters to inline markup's start string prefix,
2390 ``/`` to end string suffix.
2391 - Fixed a footnote bug.
2392 - Fixed a bug with literal blocks.
2393 - Applied patch from Simon Budig: simplified regexps with symbolic
2394 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2395 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2396 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2397 - Allowed non-ASCII in "simple names" (directive names, field names,
2399 - Converted ``Inliner.patterns.initial`` to be dynamically built
2400 from parts with ``build_regexp()`` function.
2401 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2402 - Updated docstrings.
2403 - Changed "table" to "grid_table"; added "simple_table" support.
2405 * docutils/parsers/rst/tableparser.py:
2407 - Changed ``TableParser`` to ``GridTableParser``.
2408 - Added ``SimpleTableParser``.
2409 - Refactored naming.
2411 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2412 a fallback language for directive names.
2414 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2415 directive to use a ``pending`` element, used only by HTML writers.
2417 * docutils/parsers/rst/directives/parts.py: Renamed from
2420 - Added "backlinks" attribute to "contents" directive.
2422 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2423 project by Adam Chodorowski.
2425 * docutils/readers/__init__.py: Gave Readers more control over
2426 choosing and instantiating Parsers.
2428 * docutils/readers/pep.py: Added to project; for PEP processing.
2430 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2431 requires a ``component`` parameter.
2433 * docutils/transforms/components.py: Added to project; transforms
2434 related to Docutils components.
2436 * docutils/transforms/frontmatter.py:
2438 - In ``DocInfo.extract_authors``, check for a single "author" in an
2439 "authors" group, and convert it to a single "author" element.
2440 - Added support for "Dedication" and generic bibliographic fields.
2442 * docutils/transforms/peps.py: Added to project; PEP-specific.
2444 * docutils/transforms/parts.py: Renamed from old components.py.
2446 - Added filter for `Contents`, to use alt-text for inline images,
2447 and to remove inline markup that doesn't make sense in the ToC.
2448 - Added "name" attribute to TOC topic depending on its title.
2449 - Added support for optional TOC backlinks.
2451 * docutils/transforms/references.py: Fixed indirect target resolution
2452 in ``Hyperlinks`` transform.
2454 * docutils/transforms/universal.py:
2456 - Changed ``Messages`` transform to properly filter out system
2457 messages below the warning threshold.
2458 - Added ``Decorations`` transform (support for ``--generator``,
2459 ``--date``, ``--time``, ``--source-link`` options).
2461 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2462 Engelbert Gruber's PDF writer.
2464 * docutils/writers/html4css1.py:
2466 - Made XHTML-compatible (switched to lowercase element & attribute
2467 names; empty tag format).
2468 - Escape double-dashes in comment text.
2469 - Improved boilerplate & modularity of output.
2470 - Exposed modular output in Writer class.
2471 - Added a "generator" meta tag to <head>.
2472 - Added support for the ``--stylesheet`` option.
2473 - Added support for ``decoration``, ``header``, and ``footer``
2475 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2476 translation table to regexp; restores Python 2.0 compatibility
2478 - Added the translator class as instance variable to the Writer, to
2479 make it easily subclassable.
2480 - Improved option list spacing (thanks to Richard Jones).
2481 - Modified field list output.
2482 - Added backlinks to footnotes & citations.
2483 - Added percentage widths to "<col>" tags (from colspec).
2484 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2485 "<span>" changed to "<var>".
2486 - Inline literals: "<code>" changed to "<tt>".
2487 - Many changes to optimize vertical space: compact simple lists etc.
2488 - Add a command-line options & directive attributes to control TOC
2489 and footnote/citation backlinks.
2490 - Added support for optional footnote/citation backlinks.
2491 - Added support for generic bibliographic fields.
2492 - Identify backrefs.
2493 - Relative URLs for stylesheet links.
2495 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2496 PEPs (subclass of ``html4css1.Writer``).
2498 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2500 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2501 of the Docutils internal doctree in XML.
2503 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2507 - Changed the title to "The Docutils Document Tree".
2508 - Added "Hyperlink Bookkeeping" section.
2510 * spec/docutils.dtd:
2512 - Added ``decoration``, ``header``, and ``footer`` elements.
2513 - Brought ``interpreted`` element in line with the parser: changed
2514 attribute "type" to "role", added "position".
2515 - Added support for generic bibliographic fields.
2517 * spec/notes.txt: Continual updates. Added "Project Policies".
2519 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2522 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2524 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2525 mailing list discussions.
2527 * spec/pep-0287.txt:
2529 - Renamed to "reStructuredText Docstring Format".
2531 - Reworked Q&A as an enumerated list.
2532 - Converted to reStructuredText format.
2534 * spec/pysource.dtd:
2536 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2538 * spec/pysource.txt: Removed from project. Moved much of its contents
2541 * spec/rst/alternatives.txt:
2543 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2544 - Added "Inline External Targets" section.
2546 * spec/rst/directives.txt:
2548 - Added "backlinks" attribute to "contents" directive.
2550 * spec/rst/problems.txt:
2552 - Updated the Enumerated List Markup discussion.
2553 - Added new alternative table markup syntaxes.
2555 * spec/rst/reStructuredText.txt:
2557 - Clarified field list usage.
2558 - Updated enumerated list description.
2559 - Clarified purpose of directives.
2560 - Added ``-/:`` characters to inline markup's start string prefix,
2561 ``/`` to end string suffix.
2562 - Updated "Authors" bibliographic field behavior.
2563 - Changed "inline hyperlink targets" to "inline internal targets".
2564 - Added "simple table" syntax to supplement the existing but
2565 newly-renamed "grid tables".
2566 - Added cautions for anonymous hyperlink use.
2567 - Added "Dedication" and generic bibliographic fields.
2569 * test: Made test modules standalone (subdirectories became packages).
2571 * test/DocutilsTestSupport.py:
2573 - Added support for PEP extensions to reStructuredText.
2574 - Added support for simple tables.
2575 - Refactored naming.
2577 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2579 - Now supports true packages containing test modules
2580 (``__init__.py`` files required); fixes duplicate module name bug.
2582 * test/test_pep/: Subpackage added to project; PEP testing.
2584 * test/test_rst/test_SimpleTableParser.py: Added to project.
2588 - Updated html.py and publish.py front-end tools to use the new
2589 command-line processing facilities of ``docutils.frontend``
2590 (exposed in ``docutils.core.Publisher``), reducing each to just a
2592 - Added ``locale.setlocale()`` calls to front-end tools.
2594 * tools/buildhtml.py: Added to project; batch-generates .html from all
2595 the .txt files in directories and subdirectories.
2597 * tools/default.css:
2599 - Added support for ``header`` and ``footer`` elements.
2600 - Added styles for "Dedication" topics (biblio fields).
2602 * tools/docutils.conf: A configuration file; added to project.
2604 * tools/docutils-xml.py: Added to project.
2606 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2608 * tools/pep-html-template: Added to project.
2610 * tools/pep2html.py: Added to project from Python (nondist/peps).
2611 Added support for Docutils (reStructuredText PEPs).
2613 * tools/quicktest.py:
2615 - Added the ``--attributes`` option, hacked a bit.
2616 - Added a second command-line argument (output file); cleaned up.
2618 * tools/stylesheets/: Subdirectory added to project.
2620 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2623 Release 0.1 (2002-04-20)
2624 ========================
2626 This is the first release of Docutils, merged from the now inactive
2627 reStructuredText__ and `Docstring Processing System`__ projects. For
2628 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2629 `DPS HISTORY`__ files.
2631 __ http://structuredtext.sourceforge.net/
2632 __ http://docstring.sourceforge.net/
2633 __ http://structuredtext.sourceforge.net/HISTORY.html
2634 __ http://docstring.sourceforge.net/HISTORY.html
2636 General changes: renamed 'dps' package to 'docutils'; renamed
2637 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2638 the test suites (reStructuredText's test/test_states renamed to
2639 test/test_rst); and all modifications required to make it all work.
2641 * docutils/parsers/rst/states.py:
2643 - Improved diagnostic system messages for missing blank lines.
2644 - Fixed substitution_reference bug.
2650 indent-tabs-mode: nil
2651 sentence-end-double-space: t