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.
21 - New reStructuredText "code" role and directive and "code" option
22 of the "include" directive with syntax highlighting by Pygments_.
23 - Fix parse_option_marker for option arguments containing ``=``.
25 .. _Pygments: http://pygments.org/
29 - Fix [ 2971827 ] and [ 3442827 ]
30 extras/roman.py moved to docutils/utils/roman.py
34 - Fix [ 3395948 ] (Work around encoding problems in Py3k).
36 * docutils/utils.py -> docutils/utils/__init__.py
38 - docutils.utils is now a package (providing a place for sub-modules)
40 .. important:: docutils/math, docutils/error_reporting.py, and
41 docutils/urischemes.py will move to the utils package in the next
42 release, too. Code importing these modules needs to adapt
43 (``import docutils.math`` -> ``import docutils.utils.math``, etc.).
45 - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
46 errors recording non-ASCII filenames (fixes [ 3434355 ].
48 * docutils/parsers/rst/states.py
50 - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
51 characters and "international" quotes around inline markup.
53 * docutils/parsers/rst/tableparser.py
55 - Fix [ 2926161 ] for simple tables.
56 (Combining chars in grid tables still contribute to cell width.)
58 * docutils/writers/latex2e/__init__.py
60 - Support the `abbreviation` and `acronym` standard roles.
61 - Record only files required to generate the LaTeX source as dependencies.
62 - Fix handling of missing stylesheets.
64 * docutils/writers/html4css1/__init__.py
66 - Change default for `math-output` setting to MathJax.
67 - Fix handling of missing stylesheets.
69 * docutils/writers/docutils_xml.py
71 - Use the visitor pattern with default_visit()/default_depart() methods
72 instead of minidom to facilitate special handling of selected nodes.
73 - Support raw XML (inserted as-is inside a <raw></raw> node).
75 Release 0.8.1 (2011-08-30)
76 ==========================
80 - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
81 and [ 3395920 ] (correct copyright info for rst.el).
85 - Apply [ 3303733 ] and [ 3365041 ] to fix tests under py3k.
87 * docutils/writers/latex2e/__init__.py
89 - Clean up Babel language setting. Restores Sphinx compatibility.
91 Release 0.8 (2011-07-07)
92 ========================
96 - Handle language codes according to `BCP 47`_.
97 - If the specified language is not supported by Docutils,
98 warn and fall back to English.
99 - Math support: reStructuredText "math" role and directive,
100 ``math`` and ``math_block`` doctree elements.
101 - Decode command line arguments with the locale's preferred encoding
102 (to allow, e.g., ``--title=Dornröschen``).
103 - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
104 - New sub-module `error_reporting`: handle encoding/decoding errors
105 when reporting exceptions.
106 - Some additions to the Docutils core are released under the 2-Clause BSD
107 license, see COPYING_ for details.
109 .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
110 .. _COPYING: COPYING.html
114 - Most directives now support a "name" option that attaches a
117 - Directive content may start on the first line also when the directive
118 type accepts options.
120 * docs/dev/policies.txt:
122 - Recommend the 2-Clause BSD license
123 (http://www.spdx.org/licenses/BSD-2-Clause)
124 for code that is kept under the author's copyright.
126 * tools/buildhtml.py:
128 - Fix ``--local`` switch.
130 * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
132 * docutils/writers/html4css1/__init__.py
134 - Set "lang" argument for objects with class argument
135 "language-<language tag>".
136 - New setting "math-output" with support for HTML, MathML, and LaTeX.
138 * docutils/writers/latex2e/__init__.py
140 - Fix [ 3043986 ] AttributeError using :local: with table of content.
141 - Place title data in the document preamble.
142 - Load `babel` package only if required.
143 - Update list of supported languages.
144 - New config setting "hyperref-options".
145 No hard-coded "unicode" hyperref option (clash with xetex).
146 - Set language for custom roles, paragraphs, block-quotes, and
147 line-quotes with class argument "language-<language tag>".
148 - Fix [ 3095603 ] wrong quotes output for russian and other languages.
149 - Convert image URI to a local file path.
150 - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
151 has more than one paragraph (Wolfgang Scherer).
152 - \leavevmode before longtable only when needed (prevents spurious vspace)
153 - do not advance table counter for tables without caption
155 * docutils/writers/xetex/__init__.py
157 - New writer generating LaTeX code for compiling with ``xelatex``.
159 A separate writer (inheriting from latex2e) instead of a ``--xetex``
160 option allows separate config options for XeTeX vs. LaTeX2e.
162 * docutils/writers/manpage.py
164 - Fix: BUG#3219183 - vertical space in definition lists containing markup.
165 - Fix: vertical space cleaning for option group ``.``.
167 * tools/editors/emacs/rst.el:
169 - Fix [ 3001100 ] does not handle spaces in filenames
170 (thanks to Jakub Wilk)
174 - strip whitespace from stylesheet arguments
175 - exclude combining chars from column_width()
176 (partial fix for [ 2926161 ])
178 * docutils/parsers/rst/directives/misc.py:
180 - Fix [ 1830389 ] Replace not breaking on getting system_messages from
185 - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
186 ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
188 Release 0.7 (2010-07-07)
189 ========================
193 - Fix [ 2881769 ] setup configuration.
194 - Fix [ 2788716 ] reporting problems in included files.
198 - FileInput opens files as text files with universal newline support
199 (mode "rU", configurable with the new optional argument "mode").
203 - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
207 - Fix [ 2923723 ] let decode_path() tolerate path == None
209 * docutils/writers/html4css1/__init__.py
211 - Support SVG and SWF images (thanks to Stefan Rank).
212 - Generate valid XHTML for centered images with targets.
213 Use CSS classes instead of "align" tags for image alignment.
215 * docutils/writers/latex2e/__init__.py
217 - Use `transforms.writer_aux.Admonitions` to "normalize" special
219 - Use the ``\url`` command for URLs (breaks long URLs instead of
220 writing into the margin).
221 - Preserve runs of spaces in `inline literals`__.
222 - Deprecate ``figure_footnotes`` setting.
223 - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
224 - New ``latex_preamble`` setting.
225 - Use PDF standard fonts (Times/Helvetica/Courier) as default.
226 - Fix hyperlink targets (labels) for images, figures, and tables.
227 - Apply [ 2961988 ] Load babel after inputenc and fontenc.
228 - Apply [ 2961991 ] Call hyperref with unicode option.
229 - Drop the special `output_encoding`__ default ("latin-1").
230 The Docutils wide default (usually "UTF-8") is used instead.
231 - Render inline markup in document title and subtitle.
232 - Fix numbering depth with LaTeX section numbering.
233 - Update Unicode -> LaTeX translations.
234 - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
236 __ docs/ref/restructuredtext.html#inline-literals
237 __ docs/user/config.html#docutils-footnotes
238 __ docs/user/config.html#output_encoding
240 * docutils/writers/manpage.py
242 - Fix: supported attribute (thanks to peter2108).
243 - Remove trailing blanks in code (keep in sync with mercurial version).
244 - Titles level 1, that is ``.SH``, always uppercase.
245 - Apply patch from mg: literal text should be bold in man-pages.
249 - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
254 - Python 3 support: copy test/ and tools/ to the build-dir
255 and convert Python sources with 2to3.
258 Release 0.6 (2009-10-11)
259 ========================
263 - Docutils is now compatible with Python versions from 2.3 up to 2.6
264 and convertible to 3.1 code.
266 + Node.__nonzero__ returns True instead of 1.
267 + use os.walk instead os.path.walk.
268 + minimize "types" module where possible.
269 + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
270 + Text nodes now subclass unicode rather than UserString
271 (which is gone in python 3.0).
272 + 3.0 compatibility module docutils._compat
274 + Drop 2.2 compatibility workarounds.
275 + Drop extras/optparse.py and extras/textwrap.py
276 (stdlib modules since 2.3).
278 - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
279 - Unix man page export: manpage writer moved from sandbox to Doctutils
282 - Apply [ 1719345 ] Galician translation
283 - Apply [ 1905741 ] Polish translation
284 - Apply [ 1878977 ] make_id(): deaccent characters.
285 - Apply [ 2029251 ] return nonzero when tests fail.
286 - Fix [ 1692788 ] allow UTF-8 in style sheets.
287 - Fix [ 2781629 ] support non-ASCII chars in file names.
288 - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
289 - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
290 - Fix [ 2821266 ] --strict option works now like --halt=info.
291 - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
292 - Fix [ 1627229 ] hyperlink references in substitutions.
294 - The "newlatex" writer is orphaned.
298 - Documented Unicode characters allowed as inline markup openers,
299 closers, and delimiters.
300 - Allow units for all length specifications.
301 - Allow percent sign in "scale" argument of "figure" and "image" directives.
302 - Bugfix: The "figalign" argument of a figure now works as intended
303 (aligning the figure, not its contents).
304 - Align images with class "align-[right|center|left]"
305 (allows setting the alignment of an image in a figure).
309 - Added ``Element.__contains__`` method, for the in-operator.
311 * docutils/parsers/rst/states.py:
313 - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
314 - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
315 " " (non-breaking space), and "¡ ¿" openers.
317 * docutils/parsers/directives/misc.py:
319 - Added ``start-line`` and ``end-line`` options to "include"
320 directive to select a range of lines.
321 - Hard tabs in literal inclusions are replaced by spaces. This is
322 configurable via the new ``tab-width`` option of the "include" directive
323 (a negative tab-width prevents tab expansion).
327 - Add ``get_stylesheet_list`` function.
328 - Apply [ 2834836 ] print info at halt
330 * docutils/transforms/universal.py:
332 - Raise default priority of StripClasses to exclude stripped classes from
335 * docutils/writers/html4css1/__init__.py:
337 - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
338 separated list of stylesheets.
339 - Address [ 1938891 ] Inline literal text creates "pre" span only when
340 needed to prevent inter-word line wraps.
341 - Use `translate` method instead of repeated `replace` calls.
342 - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
343 classes to allow CSS styling that does not interfere with other
344 table-using constructs (field lists, citations, ...).
346 * docutils/writers/newlatex2e/__init__.py:
348 - Apply [ 1612821 ] Double quotes in literal text in Italian/German
350 * docutils/writers/latex2e/__init__.py (see also
351 `<docs/user/docutils-05-compat.sty.html>`__) :
353 - Add ``--embed-stylesheet`` option.
354 - Apply [ 1474017 ] image vertical alignment is reversed.
355 - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
356 - Change: has_key for dictionaries (not Nodes) to in-operator.
357 - Merge adjacent citations into one latex cite command.
358 - Failsave implementation of custom roles. LaTeX compilation now ignores
359 unknown classes instead of aborting with an error.
360 - Support custom roles based on standard roles.
361 - LaTeX packages can be used as ``--stylesheet`` arguments without
362 restriction. (A style sheet is now referenced with the ``\usepackage``
363 command, if it ends with ``.sty`` or has no extension.)
364 - Add ``bp`` to lenghts without unit (prevents LaTex errors).
365 - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
366 - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
367 2005-02-04 as a configurable length unit).
368 - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
369 if font-encoding is set to ''. LaTeX defaults to OT1 then.
370 - Set sub- and superscript role argument in text mode not as math.
371 Use a custom role based on sub-/superscript if you want italic shape.
372 - Shorter preamble and less dependencies: Load packages and define macros
373 only if required in the document.
374 - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
375 - New custom environments and commands with optional "classes" argument.
376 - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
377 - Better conformance to Docutils specifications with ``--use-latex-toc``.
378 Support for LaTeX generated ToC also with unnumbered sections.
379 - If 'sectnum_xform' is False, the 'sectnum' directive triggers
380 section numbering by LaTeX.
381 - Use default font in admonitions and sidebar.
382 - Align of image in a figure defaults to 'center'.
383 - Bugfix: Newlines around targets and references prevent run-together
385 - Fix internal hyperlinks.
386 - Use class defaults for page margins ('typearea' now optional).
387 - Float placement made configurable, default changed to "here definitely".
388 - Typeset generic topic as "quote block with title".
389 - Use template (file and configuration option).
390 - In the default template, load cmap.sty (fix text extraction in PDF) and
391 fixltx2e.sty (LaTeX patches, \textsubscript).
392 - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
393 - Use `translate` instead of repeated `replace` calls for text encoding.
394 - Hyperlinked footnotes and support for symbol footnotes and
395 ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
396 - Complete pairs of binary options
397 (``--figure-footnotes, --figure-citations, --link-stylesheet``,
398 ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
400 - font-encoding: "T1" (formerly implicitely set by 'ae').
401 - use-latex-toc: true (ToC with page numbers).
402 - use-latex-footnotes: true (no mixup with figures).
404 * docutils/writers/manpage.py
406 - Do not print version at document end, this is done by the viewer.
407 - Do not print date at document end, this is done by the viewer.
408 - Fix storage of docinfo fields for none standard fields.
410 * docutils/tools/rst2man.py
412 Release 0.5 (2008-06-25)
413 ========================
415 * docutils/languages/he.py: Added to project: Hebrew mappings by
418 * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
419 mappings by Meir Kriheli.
421 * docutils/frontend.py:
423 - Configuration files are now assumed and required to be
425 - Paths of applied configuration files are now recorded in the
426 runtime setting ``_config_files`` (accessible via
427 ``--dump-settings``).
428 - Added ``--strip-elements-with-class`` and ``--strip-class``
429 options (``strip_elements_with_classes`` and ``strip_classes``
434 - Added code to determine the input encoding from data: encoding
435 declarations or the presence of byte order marks (UTF-8 & UTF-16).
436 - Added support for IronPython 1.0.
440 - Added ``document.__getstate__`` method, for pickling.
442 * docutils/parsers/rst/states.py:
444 - Allow ``+`` and ``:`` in reference names.
445 - Unquoted targets beginning with an underscore (``.. __target:
446 URI``) are no longer accepted.
447 - Added support for multiple attributions in a physical block quote
448 (indented text block), dividing it into multiple logical block
450 - Added support for unicode bullets in bullet lists: "•", "‣", and
452 - Added support for new object-oriented directive interface,
453 retaining compatibility to the old functional interface.
454 - Added support for throwing ``DirectiveError``'s from within
457 * docutils/parsers/rst/__init__.py:
459 - Added ``Directive`` base class.
460 - Added ``DirectiveError`` base class.
461 - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
464 * docutils/parsers/directives/:
466 - Refactored all reStructuredText directives to use the new
467 object-oriented directive interface. Errors are now (mostly)
468 thrown using the new ``DirectiveError`` class.
470 * docutils/parsers/directives/misc.py:
472 - Added ``start-after`` and ``end-before`` options to ``include``
473 directive; thanks to Stefan Rank.
475 * docutils/transforms/universal.py:
477 - Added ``StripClassesAndElements`` transform to remove from the
478 document tree all elements with classes in
479 ``settings.strip_elements_with_classes`` and all "classes"
480 attribute values in ``self.document.settings.strip_classes``.
482 * docutils/transforms/writer_aux.py:
484 - Added ``Admonitions`` transform to transform specific admonitions
485 (like ``note``, ``warning``, etc.) into generic admonitions with a
488 * docutils/writers/html4css1/__init__.py:
490 - Moved template functionality from the PEP/HTML writer here.
491 - Expanded the fragments available in the ``parts`` attribute.
492 - Moved ``id`` attributes from titles to surrounding ``div``
494 - Dropped all ``name`` attributes of ``a`` elements (``id`` is
495 universally supported now).
496 - ``template.txt`` is now opened in text mode instead of binary mode
497 (to ensure Windows compatibility).
498 - ``a`` elements now have an "internal" or "external" class,
499 depending on reference type.
501 * docutils/writers/html4css1/template.txt: Added to project.
503 * docutils/writers/pep_html/:
505 - Moved template functionality to the HTML writer.
507 * docutils/writers/s5_html/__init__.py:
509 - Added ``view_mode`` & ``hidden_controls`` settings
510 (``--view-mode`` & ``--hidden-controls/--visible-controls``
513 * docutils/writers/latex2e/__init__.py:
515 - Add ``--literal-block-env``
516 - Fix: escaping ``%`` in href urls.
517 - Move usepackage hyperref after stylesheet inclusion.
518 - Fix: scrartcl does not have chapter but scrreprt.
519 - Add newline after ``\end{verbatim}``.
520 - Merge smaller differences from latex2e_adaptive_preamble.
521 - Add ``use-part-section``.
522 - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
523 - Using leavemode option_list no longer needs to check if parent
524 is a definition list.
525 - Append ``\leavemode`` to definition list terms.
526 - No longer write visit\_/depart_definition_list_item comments to
528 - Table column width with 3 decimal places.
529 - Add table stubs support (boldfont).
530 - Add assemble_parts to writer.
531 - Add simply support for nested tables.
532 - Fix verbatim in tables if use-verbatim-when-possible.
533 - Use section commands down to subparagraph.
534 - Put ensuremath around some latin1 chars.
535 - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
536 - New option ``--use-bibtex=style,db1,db2``.
537 - New option ``--reference-label`` to allow usage of LaTeX ref for
538 labels in section references.
539 - Add a label after every section to support sectionnumbers as reference
541 - Fix: bug# 1605376 rst2latex: bad options group list
542 - Remove inactive code for use_optionlist_for_option_list.
543 - Remove latex comments from option_list output.
544 - Fix: bug# 1612270 double qoutes in italian literal.
545 - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
546 - Add option --use-latex-abstract.
547 - Image width unit ``px`` is translated to ``pt``.
548 - Add image height support.
549 - Fix: image width ``70%`` is converted ``0.700\linewidth``.
551 - Fix: Do not escape underscores in citation reference labels if
552 use-latex-citations is set.
553 - Use centering instead of center for figure contents, to avoid vertical
555 - Recognize table class: borderless, nolines, booktabs, standard.
556 - Fix: Renaming contents section does not work with latex writer; SF
558 - Applied patch for custom roles with classes from Edward Loper.
559 - Fixed bug that caused crashes with more than 256 lists.
561 * docutils/writers/pep_html/__init__.py:
563 - Changed to support new python.org website structure and
566 * docs/howto/security.txt: "Deploying Docutils Securely", added to
569 * tools/buildhtml.py:
571 -- Added ``ignore`` setting to exclude a list of shell patterns
572 (default: ``.svn:CVS``).
574 * tools/editors/emacs/rst.el:
576 - Changed license to "GPL".
577 - Added ``rst-straighten-decorations`` function.
578 - The ``compile`` module is now always loaded.
579 - Added ``rst-toggle-line-block`` function.
580 - Headings consisting only of non-ASCII characters are now
581 recognized by ``rst-toc`` and ``rst-adjust``.
582 - Added font-lock support for multi-line comments where the first
583 comment line is empty.
584 - Added ``(require 'font-lock)``.
588 - Provide descriptive error message if distutils is missing.
591 Release 0.4 (2006-01-09)
592 ========================
596 - Updated the project policies for trunk/branch development &
599 * docutils/__init__.py:
601 - Added ``__version_details__`` attribute to describe code source
602 (repository/snapshot/release).
603 - Replaced ``default_transforms`` attribute of TransformSpec with
604 ``get_transforms()`` method.
608 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
609 functions, for document tree extraction and reprocessing.
613 - Added ``DocTreeInput`` class, for reprocessing existing documents.
614 - Added support for non-Unicode (e.g. binary) writer output.
618 - Re-introduced ``Targetable.indirect_reference_name``, for
619 MoinMoin/reST compatibility (removed in r3124/r3129).
620 - Added ``serial_escape`` function; escapes string values that are
621 elements of a list, for serialization. Modified Docutils-XML
622 writing (``Element._dom_node``) and pseudo-XML writing
623 (``Element.starttag``) to use ``serial_escape``.
624 - Added ``Node.deepcopy()`` method.
625 - Removed the internal lists ``document.substitution_refs``,
626 ``document.anonymous_refs``, and ``document.anonymous_targets``.
627 - Added a "container" element.
628 - Fixed bug where values of list-valued attributes of elements
629 originating from custom interpreted text roles (i.e., with custom
630 classes) were being shared between element instances. Reported by
633 * docutils/statemachine.py:
635 - Added trailing whitespace stripping to ``string2lines()``.
636 - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
637 Asian double-width character support.
641 - Added ``east_asian_column_width()`` for double-width character
644 * docutils/languages/ja.py: Added to project: Japanese mappings by
647 * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
648 mappings by Panjunyong.
650 * docutils/parsers/null.py: Added to project; a do-nothing parser.
652 * docutils/parsers/rst/__init__.py:
654 - Added validator to tab_width setting, with test. Closes SF bug
655 #1212515, report from Wu Wei.
657 * docutils/parsers/rst/states.py:
659 - Fixed bug with escaped colons indicating a literal block.
660 - Fixed bug with enumerated lists (SF#1254145).
661 - Backslash-escaped colons inside of field names are now allowed.
662 - Targets (implicit and explicit), anonymous hyperlink references
663 and auto-numbered footnote references inside of substitution
664 definitions are now disallowed.
665 - Fixed bug: list items with blank first lines.
666 - Fixed bug: block quote attributions with indented second lines.
667 - Added East Asian double-width character support (Python 2.4 only).
669 * docutils/parsers/rst/tableparser.py:
671 - Added East Asian double-width character support (Python 2.4 only).
673 * docutils/parsers/rst/directives/body.py:
675 - Added the "container" directive.
677 * docutils/parsers/rst/directives/misc.py:
679 - Added the "default-role", "title", and "date" directives.
680 - Added standard data file syntax to the "include" directive.
681 - Added support for "class" directive content.
683 * docutils/parsers/rst/directives/images.py:
685 - Added ``indirect_reference_name`` support for images with a target
687 - Added support for image width and height units.
688 - Fixed bug with image "target" options.
690 * docutils/parsers/rst/directives/references.py:
692 - Added "class" attribute to "target-notes" directive, for
693 footnote_reference classes.
695 * docutils/parsers/rst/include/: Directory added to project; contains
696 standard data files for the "include" directive. Initial contents:
697 character entity substitution definition sets, and a set of
698 definitions for S5/HTML presentations.
700 * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
701 mappings by David Goodger.
703 * docutils/parsers/rst/languages/zh_cn.py: Added to project:
704 Simplified Chinese mappings by Panjunyong.
706 * docutils/readers/__init__.py:
708 - Added universal.Decorations and universal.ExposeInternals
709 transforms as default transforms for all readers.
710 - Added ``ReReader`` base class for readers that reread an existing
713 * docutils/readers/doctree.py: Added to project; a reader for existing
716 * docutils/transforms/frontmatter.py:
718 - Fixed the DocInfo transform to handle SVN-style expansion of the
720 - In ``DocInfo.extract_authors``, treat the contents of "authors"
723 * docutils/transforms/misc.py:
725 - Added misc.Transitions transform, extracted from
726 universal.FinalChecks.
728 * docutils/transforms/references.py:
730 - Added references.DanglingReferences transform, extracted from
731 universal.FinalChecks.
732 - Fixed bug with doubly-indirect substitutions.
733 - Added footnote_reference classes attribute to "TargetNotes".
734 - Fixed bug with circular substitution definitions that put Docutils
735 into an infinite loop.
737 * docutils/transforms/universal.py:
739 - Added universal.ExposeInternals transform, extracted from
740 universal.FinalChecks.
741 - Removed universal.FinalChecks transform (logic has been moved to
742 several new transforms).
743 - Fixed bug with the "expose_internals" setting and Text nodes
744 (exposed by the "rawsource" internal attribute).
745 - Added the universal.StripComments transform, implementation of the
746 "strip_comments" setting.
748 * docutils/transforms/writer_aux.py: Added to project; auxiliary
749 transforms for writers.
751 - Added ``Compound`` transform, which flattens compound paragraphs.
753 * docutils/writers/: Several writer modules (html4css1.py) were
754 converted into packages. Support modules and data files have been
755 moved into the packages. The stylesheets for the HTML writers are
756 now installed along with the code, the code knows where to find
757 them, and the default is to use them (actually, to embed them).
758 Some adjustments to configuration files may be necessary. The
759 easiest way to obtain the new default behavior is to remove all
760 settings whose name includes "stylesheet".
762 * docutils/writers/__init__.py:
764 - Added universal.Messages and universal.FilterMessages transforms
765 as default transforms for all writers.
766 - Added ``UnfilteredWriter`` base class for writers that pass the
767 document tree on unchanged.
769 * docutils/writers/docutils_xml.py:
771 - Made ``xmlcharrefreplace`` the default output encoding error
774 * docutils/writers/html4css1/:
776 - Added support for image width and height units.
777 - Made ``xmlcharrefreplace`` the default output encoding error
779 - Made ``--embed-stylesheet`` the default rather than
780 ``--link-stylesheet``.
781 - Moved "id" attribute from container (section etc.) to title's <a>
782 tag, to be on the same tag as "name".
783 (!!! To be reverted in Docutils 0.5.)
784 - Added vertical space between fields of field lists.
785 - Added ``--compact-field-lists`` option to remove vertical space in
787 - Made cloaking of email addresses with ``--cloak-email-addresses``
789 - Fixed support for centered images.
790 - Added support for class="compact" & class="open" lists.
792 * docutils/writers/latex2e/:
794 - Underscores in citekeys are no longer escaped.
796 * docutils/writers/newlatex2e/unicode_map.py: Added to project;
797 mapping of Unicode characters to LaTeX equivalents.
799 * docutils/writers/s5_html/: Package added to project; writer for
802 * docs/dev/distributing.txt: Added to project; guide for distributors
803 (package maintainers).
805 * docs/dev/hacking.txt: Added to project; guide for developers.
807 * docs/ref/doctree.txt:
809 - Updated for plural attributes "classes", "ids", "names",
811 - Added the "container" element.
813 * docs/ref/docutils.dtd:
815 - Updated for plural attributes "classes", "ids", "names",
818 * docs/user/emacs.txt: Added to project; a document about Emacs
819 support for reStructuredText and Docutils.
821 * docs/user/links.txt: Added to project; lists of Docutils-related
824 * docs/user/mailing-lists.txt: Added to project; information about
825 Docutils-related mailing lists and how to access them.
827 * docs/user/slide-shows.txt: Added to project; example of and docs for
828 the S5/HTML writer (``rst2s5.py`` front end).
830 * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
831 Files", added to project.
833 * test/coverage.sh: Added to project; test coverage script.
835 * test/DocutilsTestSupport.py:
837 - Added support for specifying runtime settings at the suite level.
839 * test/test_functional.py:
841 - Added the ``clear_output_directory`` function.
842 - Added support for ``_test_more`` functions in functional test
845 * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
847 * tools/rstpep2html.py: Renamed from pep.py.
849 * tools/dev/create_unimap.py: Added to project; script to create the
850 docutils/writers/unimap_latex.py mapping file.
852 * tools/dev/profile_docutils.py: Added to project; profiler script.
854 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
856 * tools/editors/emacs/restructuredtext.el,
857 tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
858 Removed from project; the functionality is now contained in rst.el.
860 * tools/editors/emacs/rst.el: Added to project. Added many features
861 and fixed many bugs. See docs/user/emacs.txt for details.
863 * tools/stylesheets: Removed from project. Stylesheets have been
864 renamed and moved into writer packages.
867 Release 0.3.9 (2005-05-26)
868 ==========================
872 - Eliminated and replaced all uses of the old string attributes
873 ``id``, ``name``, ``dupname`` and ``class`` with references to the
874 new list attributes ``ids``, ``names``, ``dupnames`` and
875 ``classes`` throughout the whole source tree.
879 - Enabled ``--dump-*`` options when ``--traceback`` specified,
880 allowing for easier debugging.
881 - In ``Publisher.publish()``, expanded the generic top-level
884 * docutils/examples.py:
886 - Added ``internals`` function for exploration.
890 - Fixed ``Input.decode`` method to apply heuristics only if no
891 encoding is explicitly given, and to provide better reporting of
893 - The ``Input.decode`` method now removes byte order marks (BOMs)
898 - ``image`` element class changed to subclass of Element, not
899 TextElement (it's an empty element, and cannot contain text).
900 - Added ``attr_defaults`` dictionary for default attribute values.
901 - Added empty list as default value for the following attributes:
902 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
903 - Added ``document.decoration`` attribute,
904 ``document.get_decoration`` method, and ``decoration.get_header``
905 & ``.get_footer`` methods.
906 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
911 - Removed ``docutils.utils.Reporter.categories``,
912 ``docutils.utils.ConditionSet``, and all references to them, to
913 simplify error reporting.
915 * docutils/languages/nl.py: Added to project; Dutch mappings by
918 * docutils/parsers/rst/__init__.py:
920 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
922 * docutils/parsers/rst/states.py:
924 - Added check for escaped at-mark to prevent email address recognition.
925 - Fixed option lists to allow spaces inside ``<angle-bracketed option
927 - Allowed whitespace in paths and URLs.
928 - Added auto-enumerated list items.
929 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
931 - Added support for table stub columns.
933 * docutils/parsers/rst/directives/__init__.py:
935 - Allowed whitespace in paths (``path`` function).
936 - Added ``uri`` directive option conversion function.
938 * docutils/parsers/rst/directives/body.py:
940 - Fixed illegal context bug with "topic" directive (allowed within
941 sidebars; not within body elements).
943 * docutils/parsers/rst/directives/images.py:
945 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
946 - Added support for the ``file_insertion_enabled`` setting in the
947 "figure" directive (disables "figwidth" option).
948 - "image" directive: added checks for valid values of "align" option,
949 depending on context. "figure" directive: added specialized
950 "align" option and attribute on "figure" element.
951 - Made ":figwidth: image" option of "figure" directive work again.
952 - Fixed bug with reference names containing uppercase letters
953 (e.g. ``Name_``) in "target" option of "image" directive.
955 * docutils/parsers/rst/directives/misc.py:
957 - Fixed "include" and "raw" directives to catch text decoding
959 - Allowed whitespace in "include" & "raw" directive paths.
960 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
961 settings in "include" & "raw" directives.
963 * docutils/parsers/rst/directives/parts.py:
965 - Added "header" & "footer" directives.
966 - Fixed illegal context bug with "contents" directive (topics
967 allowed within sidebars; not within body elements).
969 * docutils/parsers/rst/directives/tables.py:
971 - Added "list-table" directive.
972 - Caught empty CSV table bug.
973 - Added support for the ``file_insertion_enabled`` setting in the
974 "csv-table" directive.
975 - Added ``stub-columns`` option to "csv-table" and "list-table"
978 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
979 mappings by Martijn Pieters.
981 * docutils/readers/standalone.py:
983 - Added ``--section-subtitles`` and ``--no-section-subtitles``
984 options to activate or deactivate the SectSubTitle transform.
986 * docutils/transforms/frontmatter.py:
988 - Added SectSubTitle transform to promote titles of lone
989 subsections to subtitles.
991 * docutils/transforms/references.py:
993 - Fixed mislocated internal targets bug, by propagating internal
994 targets to the next node, making use of the newly added support
995 for multiple names and IDs.
996 - Fixed duplicate footnote label bug.
997 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
1000 * docutils/writers/html4css1.py:
1002 - Fixed unencoded stylesheet reference bug (characters like "&" in
1003 stylesheet references).
1004 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
1006 - Added support for multiple IDs per node by creating empty ``span``
1008 - Added the ``field_name_limit`` & ``option_limit`` settings &
1010 - Added support for table stub columns.
1011 - Added support for the ``align`` attribute on ``figure`` elements.
1012 - Added the ``cloak_email_addresses`` setting & support.
1013 - Added ``html_prolog``, ``html_head``, ``html_body``,
1014 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
1015 ``docutils.core.publish_parts``.
1016 - Added support for section subtitles.
1018 * docutils/writers/latex2e.py:
1020 - Fixed tables starting with more than one multirow cell.
1021 - Improved --use-latex-docinfo so that organization/contact/address
1022 fields are lumped with the last author field and appear on the
1024 - Made sure the titlepage is always shown with --use-latex-docinfo,
1025 even if the document has no title.
1026 - Made sure that latex doesn't fill in today's date if no date field
1028 - Added support for section subtitles.
1030 * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
1031 (under development).
1033 * docutils/writers/null.py: Added to project; a do-nothing Writer.
1035 * docs/api/publisher.txt:
1037 - Added "``publish_parts`` Details" section.
1039 * docutils/dev/repository.txt: Added to project; information about the
1040 Docutils Subversion repository.
1042 * docs/ref/docutils.dtd:
1044 - Added a ``stub`` attribute to the ``colspec`` element via the
1045 ``tbl.colspec.att`` parameter entity.
1046 - Allowed topic elements within sidebars
1047 - Added an ``align`` attribute to the ``figure`` element.
1049 * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
1053 Release 0.3.7 (2004-12-24)
1054 ==========================
1056 * docutils/frontend.py:
1058 - Added options: --input-encoding-error-handler,
1059 --record-dependencies, --leave-footnote-reference-space,
1061 - Added command-line and config file support for "overrides" setting
1066 - Added support for input encoding error handler.
1068 * docutils/nodes.py:
1070 - Added dispatch_visit and dispatch_departure methods to
1071 NodeVisitor; useful as a hook for Visitors.
1072 - Changed structure of ``line_block``; added ``line``.
1073 - Added ``compound`` node class.
1074 - Added a mechanism for Visitors to transitionally ignore new node
1077 * docutils/utils.py:
1079 - Moved ``escape2null`` and ``unescape`` functions from
1080 docutils/parsers/rst/states.py.
1082 * docutils/parsers/rst/roles.py:
1085 - Changed role function API: the "text" parameter now takes
1086 null-escaped interpreted text content.
1088 * docutils/parsers/rst/states.py:
1090 - Fixed bug where a "role" directive in a nested parse would crash
1091 the parser; the state machine's "language" attribute was not being
1093 - Added support for line block syntax.
1094 - Fixed directive parsing bug: argument-less directives didn't
1095 notice that arguments were present.
1096 - Removed error checking for transitions.
1097 - Added support for multiple classifiers in definition list items.
1098 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
1099 - Changed role function API: the "text" parameter now takes
1100 null-escaped interpreted text content.
1101 - Empty sections and documents are allowed now.
1103 * docutils/parsers/rst/directives/__init__.py:
1105 - Added ``encoding`` directive option conversion function.
1106 - Allow multiple class names in class_option conversion function.
1108 * docutils/parsers/rst/directives/body.py:
1110 - Converted the line-block directive to use the new structure.
1111 - Extracted the old line-block functionality to the ``block``
1112 function (still used).
1113 - Added ``compound`` directive (thanks to Lea Wiemann).
1115 * docutils/parsers/rst/directives/misc.py:
1117 - Added "encoding" option to "include" and "raw" directives.
1118 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
1119 - Allow multiple class names in the "class" directive.
1121 * docutils/parsers/rst/directives/parts.py:
1123 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
1124 options. Thanks to Lele Gaifax.
1126 * docutils/parsers/rst/directives/tables.py:
1128 - Added "encoding" directive to "csv-table" directive.
1129 - Added workaround for lack of Unicode support in csv.py, for
1130 non-ASCII CSV input.
1132 * docutils/transforms/misc.py:
1134 - Fixed bug when multiple "class" directives are applied to a single
1136 - Enabled multiple format names for "raw" directive.
1138 * docutils/transforms/references.py:
1140 - Added support for trimming whitespace from beside substitution
1143 * docutils/transforms/universal.py:
1145 - FinalChecks now checks for illegal transitions and moves
1146 transitions between sections.
1148 * docutils/writers/html4css1.py:
1150 - HTMLTranslator.encode now converts U+00A0 to " ".
1151 - "stylesheet" and "stylesheet_path" settings are now mutually
1153 - Added support for the new line_block/line structure.
1154 - --footnote-references now overrides
1155 --trim-footnote-reference-space, if applicable.
1156 - Added support for ``compound`` elements.
1157 - Enabled multiple format names for "raw" directive.
1158 - ``<p>`` tags of a paragraph which is the only visible child of the
1159 document node are no longer stripped.
1160 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
1161 new method ``should_be_compact_paragraph()``.
1162 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
1164 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
1165 the output if they have their ``class`` attribute set.
1166 - The whole document is now surrounded by a ``<div
1167 class="document">`` element.
1168 - Body-level images are now wrapped by their own ``<div>`` elements,
1169 with image classes copied to the wrapper, and for images which
1170 have the ``:align:`` option set, the surrounding ``<div>`` now
1171 receives a class attribute (like ``class="align-left"``).
1173 * docutils/writers/latex2e.py:
1175 - no newline after depart_term.
1176 - Added translations for some Unicode quotes.
1177 - Added option "font-encoding", made package AE the default.
1178 - "stylesheet" and "stylesheet_path" settings are now mutually
1180 - --footnote-references now overrides
1181 --trim-footnote-reference-space, if applicable.
1182 - The footnote label style now matches the footnote reference style
1183 ("brackets" or "superscript").
1184 - Added support for ``compound`` elements.
1185 - Enabled multiple format names for "raw" directive.
1187 * docs/ref/docutils.dtd:
1189 - Changed structure of the ``line_block`` element; added ``line``.
1190 - Added ``compound`` element.
1191 - Added "ltrim" and "rtrim" attributes to
1192 ``substitution_definition`` element.
1193 - Enabled multiple format names for ``raw`` element.
1194 - Enabled multiple classifiers in ``definition_list_item`` elements.
1196 * docs/ref/rst/directives.txt
1198 - Marked "line-block" as deprecated.
1199 - "Class" directive now allows multiple class names.
1200 - Added "Rationale for Class Attribute Value Conversion".
1201 - Added warning about "raw" overuse/abuse.
1203 * docs/ref/rst/restructuredtext.txt:
1205 - Added syntax for line blocks.
1206 - Definition list items may have multiple classifiers.
1208 * docs/ref/rst/roles.txt:
1212 * tools/stylesheets/default.css:
1214 - Added support for the new line_block structure.
1215 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
1218 Release 0.3.5 (2004-07-29)
1219 ==========================
1223 * _`Documentation cleanup/reorganization`.
1225 - Created new subdirectories of docs/:
1227 * ``docs/user/``: introductory/tutorial material for end-users
1228 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
1229 * ``docs/api/``: API reference material for client-developers
1230 * ``docs/ref/``: reference material for all groups
1231 * ``docs/howto/``: for component-developers and core-developers
1232 * ``docs/peps/``: Python Enhancement Proposals
1234 - Moved ``docs/*`` to ``docs/user/``.
1235 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
1236 ``spec/`` to ``docs/dev``.
1237 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
1238 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
1239 - Moved ``alternatives.txt``, and ``problems.txt`` from
1240 ``spec/rst/`` to ``docs/dev/rst/``.
1241 - Moved ``reStructuredText.txt``, ``directives.txt``,
1242 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
1243 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
1244 ``roles.txt``, ``reStructuredText.txt`` to
1245 ``restructuredtext.txt``.
1246 - Moved ``spec/howto/`` to ``docs/howto``.
1248 In order to keep the CVS history of moved files, we supplied
1249 SourceForge with a `script for modifying the Docutils CVS
1252 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
1254 After running the cleanup script:
1256 - Added ``docs/index.txt``.
1257 - Added a ``.htaccess`` file to the ``web`` module, containing
1258 redirects for all old paths to new paths. They'll preserve
1259 fragments (the "#name" part of a URL), and won't clutter up the
1260 file system, and will correct the URL in the user's browser.
1261 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
1262 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
1263 the "To Do" list itself in ``docs/dev/todo.txt``.
1264 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
1265 section of ``docs/dev/todo.txt``.
1266 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
1267 - Added "How To Report Bugs" to ``BUGS.txt``.
1268 - Went through all the sources and docs (including under web/) and
1269 updated links. Mostly done by Lea Wiemann; thanks Lea!
1270 (Still need to update links in the sandboxes.)
1274 * BUGS.txt: Added to project.
1276 * THANKS.txt: Added to project.
1278 * docutils/__init__.py:
1280 - 0.3.4: Post-release.
1284 - Added special error handling & advice for UnicodeEncodeError.
1285 - Refactored Publisher.publish (simplified exception handling &
1286 extracted debug dumps).
1287 - Renamed "enable_exit" parameter of convenience functions to
1288 "enable_exit_status".
1289 - Enabled traceback (exception propagation) by default in
1290 programmatic convenience functions.
1291 - Now publish_file and publish_cmdline convenience functions return
1292 the encoded string results in addition to their regular I/O.
1293 - Extracted common code from publish_file, publish_string, and
1294 publish_parts, into new publish_programmatically. Extracted
1295 settings code to ``Publisher.process_programmatic_settings``.
1296 - In Publisher.publish, disabled ``settings_overrides`` when
1297 ``settings`` is supplied; redundant.
1299 * docutils/frontend.py:
1301 - Added help text for "--output-encoding-error-handler" and
1302 "--error-encoding-error-handler".
1303 - Renamed "--exit" to "--exit-status".
1304 - Simplified default-setting code.
1306 * docutils/parsers/rst/__init__.py:
1308 - Added "--pep-base-url" and "--rfc-base-url" options.
1310 * docutils/parsers/rst/states.py:
1312 - Made URI recognition more aggressive and intelligent.
1314 * docutils/parsers/rst/directives/__init__.py:
1316 - Added several directive option conversion functions.
1318 * docutils/parsers/rst/directives/body.py:
1320 - Moved "table" directive to tables.py.
1322 * docutils/parsers/rst/directives/tables.py: Table-related directives,
1325 * docutils/writers/latex2e.py:
1327 - Added "--table-style=(standard|booktabs|nolines)"
1328 - figures get "here" option (LaTeX per default puts them at bottom),
1329 and figure content is centered.
1330 - Rowspan support for tables.
1331 - Fix: admonition titles before first section.
1332 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
1333 - Replave ``_`` in literal by an underlined blank, because it has the correct
1335 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
1336 - A few unicode replacements, if output_encoding != utf
1337 - Add "--graphicx-option".
1338 - Indent literal-blocks.
1339 - Fix: omit ``\maketitle`` when there is no document title.
1341 * docs/index.txt: "Docutils Project Documentation Overview", added to
1344 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
1345 Tool", added to project.
1347 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
1349 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
1351 * docs/dev/policies.txt: Added to project (extracted from
1352 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1354 * docs/dev/release.txt: Added to project (extracted from
1355 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1357 * docs/dev/testing.txt: Added to project.
1359 * docs/dev/website.txt: Added to project (extracted from
1360 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
1362 * docs/ref/rst/directives.txt:
1364 - Added directives: "table", "csv-table".
1366 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
1367 added to project. 1 page for syntax, and a 1 page reference for
1368 directives and roles. Source text to be used as-is; not meant to be
1371 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
1372 with a change of title.
1374 * test/functional/, contents, and test/test_functional.py: Added to
1377 * tools/buildhtml.py: Fixed bug with config file handling.
1379 * tools/html.py: Removed from project (duplicate of rst2html.py).
1381 * tools/pep2html.py: Removed from project (duplicate of Python's
1382 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
1383 Docutils-related PEPs in docs/peps/).
1385 * tools/rst2pseudoxml.py: Renamed from publish.py.
1387 * tools/rst2xml.py: Renamed from docutils-xml.py.
1389 * tools/test.txt: Removed from project; moved to
1390 docs/user/rst/demo.txt.
1392 * setup.py: Now also installs ``rst2latex.py``.
1395 Release 0.3.3 (2004-05-09)
1396 ==========================
1398 * docutils/__init__.py:
1400 - 0.3.1: Reorganized config file format (multiple sections); see
1402 - Added unknown_reference_resolvers attribute to TransformSpec.
1403 - 0.3.2: Interpreted text reorganization.
1408 - Catch system messages to stop tracebacks from parsing errors.
1409 - Catch exceptions during processing report & exit without
1410 tracebacks, except when "--traceback" used.
1411 - Reordered components for OptionParser; application comes last.
1412 - Added "config_section" parameter to several methods and functions,
1413 allowing front ends to easily specify their config file sections.
1414 - Added publish_parts convenience function to allow access to individual
1415 parts of a document.
1417 * docutils/examples.py: Added to project; practical examples of
1418 Docutils client code, to be used as-is or as models for variations.
1420 * docutils/frontend.py:
1422 - Added "--traceback" & "--no-traceback" options ("traceback"
1424 - Implemented support for config file reorganization:
1425 ``standard_config_files`` moved from ``ConfigParser`` to
1426 ``OptionParser``; added
1427 ``OptionParser.get_config_file_settings()`` and
1428 ``.get_standard_config_settings()``; support for old "[options]"
1429 section (with deprecation warning) and mapping from old to new
1431 - Reimplemented setting validation.
1432 - Enabled flexible boolean values: yes/no, true/false, on/off.
1433 - Added ``Values``, a subclass of ``optparse.Values``, with support
1434 for list setting attributes.
1435 - Added support for new ``DOCUTILSCONFIG`` environment variable;
1436 thanks to Beni Cherniavsky.
1437 - Added "--no-section-numbering" option.
1441 - Catch IOErrors when opening source & destination files, report &
1442 exit without tracebacks. Added ``handle_io_errors`` parameter to
1443 ``FileInput`` & ``FileOutput`` to enable caller error handling.
1445 * docutils/nodes.py:
1447 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
1448 method definitions (via ``exec``) to dynamic assignments (via
1449 ``setattr``); thanks to Roman Suzi.
1450 - Encapsulated visitor dynamic assignments in a function; thanks to
1452 - Added indirect_reference_name attribute to the Targetable
1453 class. This attribute holds the whitespace_normalized_name
1454 (contains mixed case) of a target.
1456 * docutils/statemachine.py:
1458 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
1459 - Added ``StringList.get_2D_block``.
1461 * docutils/utils.py:
1463 - Added "level" attribute to SystemMessage exceptions.
1465 * docutils/languages/af.py: Added to project; Afrikaans mappings by
1468 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
1471 * docutils/languages/eo.py: Added to project; Esperanto mappings by
1472 Marcelo Huerta San Martin.
1474 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
1475 mappings by Lalo Martins.
1477 * docutils/languages/ru.py: Added to project; Russian mappings by
1480 * docutils/parsers/rst/roles.py: Added to project. Contains
1481 interpreted text role functions, a registry for interpreted text
1482 roles, and an API for adding to and retrieving from the registry.
1483 Contributed by Edward Loper.
1485 * docutils/parsers/rst/states.py:
1487 - Updated ``RSTState.nested_parse`` for "include" in table cells.
1488 - Allowed true em-dash character and "---" as block quote
1490 - Added support for <angle-bracketed> complex option arguments
1492 - Fixed handling of backslashes in substitution definitions.
1493 - Fixed off-by-1 error with extra whitespace after substitution
1494 definition directive.
1495 - Added inline markup parsing to field lists' field names.
1496 - Added support for quoted (and unindented) literal blocks.
1497 Driven in part by a bribe from Frank Siebenlist (thanks!).
1498 - Parser now handles escapes in URIs correctly.
1499 - Made embedded-URIs' reference text omittable. Idea from Beni
1501 - Refactored explicit target processing code.
1502 - Added name attribute to references containing the reference name only
1503 through whitespace_normalize_name (no case changes).
1504 - parse_target no longer returns the refname after going through
1505 normalize_name. This is now handled in make_target.
1506 - Fixed bug relating to role-less interpreted text in non-English
1508 - Reorganized interpreted text processing; moved code into the new
1509 roles.py module. Contributed by Edward Loper.
1510 - Refactored ``Body.parse_directive`` into ``run_directive`` and
1511 ``parse_directive_block``.
1513 * docutils/parsers/rst/tableparser.py:
1515 - Reworked for ``StringList``, to support "include" directives in
1518 * docutils/parsers/rst/directives/__init__.py:
1520 - Renamed ``unchanged()`` directive option conversion function to
1521 ``unchanged_required``, and added a new ``unchanged``.
1522 - Catch unicode value too high error; fixes bug 781766.
1523 - Beefed up directive error reporting.
1525 * docutils/parsers/rst/directives/body.py:
1527 - Added basic "table" directive.
1529 * docutils/parsers/rst/directives/images.py:
1531 - Added "target" option to "image" directive.
1532 - Added name attribute to references containing the reference name only
1533 through whitespace_normalize_name (no case changes).
1535 * docutils/parsers/rst/directives/misc.py:
1537 - Isolated the import of the ``urllib2`` module; was causing
1538 problems on SourceForge (``libssl.so.2`` unavailable?).
1539 - Added the "role" directive for declaring custom interpreted text
1542 * docutils/parsers/rst/directives/parts.py:
1544 - The "contents" directive does more work up-front, creating the
1545 "topic" and "title", and leaving the "pending" node for the
1546 transform. Allows earlier reference resolution; fixes subtle bug.
1548 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
1549 mappings by Jannie Hofmeyr.
1551 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
1552 mappings by Marek Blaha.
1554 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
1555 mappings by Marcelo Huerta San Martin.
1557 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
1558 Portuguese mappings by Lalo Martins.
1560 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
1561 mappings by Roman Suzi.
1563 * docutils/transforms/parts.py:
1565 - The "contents" directive does more work up-front, creating the
1566 "topic" and "title", and leaving the "pending" node for the
1567 transform. Allows earlier reference resolution; fixes subtle bug.
1568 - Added support for disabling of section numbering.
1570 * docutils/transforms/references.py:
1572 - Verifying that external targets are truly targets and not indirect
1573 references. This is because we are now adding a "name" attribute to
1574 references in addition to targets. Note sure if this is correct!
1575 - Added code to hook into the unknown_reference_resolvers list for a
1576 transformer in resolve_indirect_target. This allows the
1577 unknown_reference_resolvers to keep around indirect targets which
1578 docutils doesn't know about.
1579 - Added specific error message for duplicate targets.
1581 * docutils/transforms/universal.py:
1583 - Added FilterMessages transform (removes system messages below the
1584 verbosity threshold).
1585 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
1586 to FinalCheckVisitor for application-specific handling of
1587 unresolvable references.
1588 - Added specific error message for duplicate targets.
1590 * docutils/writers/__init__.py:
1592 - Added assemble_parts method to the Writer class to allow for
1593 access to a documents individual parts.
1594 - Documented & set default for ``Writer.output`` attribute.
1596 * docutils/writers/html4css1.py:
1598 - Fixed unicode handling of attribute values (bug 760673).
1599 - Prevent duplication of "class" attribute values (bug report from
1601 - Improved table grid/border handling (prompted by report from Bob
1603 - Added support for table titles.
1604 - Added "<title />" for untitled docs, for XHTML conformance; thanks
1606 - Added functionality to keep track of individual parts of a document
1607 and store them in a dictionary as the "parts" attribute of the writer.
1608 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
1609 - Added proper support for the "scale" attribute of the "image"
1610 element. Contributed by Brent Cook.
1611 - Added ``--initial-header-level`` option.
1612 - Fixed bug: the body_pre_docinfo segment depended on there being a
1613 docinfo; if no docinfo, the document title was incorporated into
1614 the body segment. Adversely affected the publish_parts interface.
1616 * docutils/writers/latex2e.py:
1618 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
1619 about a missing file.
1620 - Added options and support: ``--compound-enumerators``,
1621 ``--section-prefix-for-enumerators``, and
1622 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
1624 - Added option ``--use-verbatim-when-possible``, to avoid
1625 problematic characters (eg, '~' in italian) in literal blocks.
1626 - It's now possible to use four section levels in the `book` and
1627 `report` LaTeX classes. The default `article` class still has
1630 * docs/config.txt: "Docutils Configuration Files", added to project.
1631 Moved config file entry descriptions from tools.txt.
1635 - Moved config file entry descriptions to config.txt.
1637 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
1640 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
1641 Text Roles", added to project.
1643 * spec/rst/reStructuredText.txt:
1645 - Added description of support for <angle-bracketed> complex option
1646 arguments to option lists.
1647 - Added subsections for indented and quoted literal blocks.
1649 * test: Continually adding & updating tests.
1651 - Added test/test_settings.py & test/data/config_*.txt support
1653 - Added test/test_writers/test_htmlfragment.py.
1655 * test/DocutilsTestSupport.py:
1657 - Refactored LaTeX publisher test suite/case class names to make
1658 testing other writers easier.
1659 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1660 to test the processing of HTML fragments which use the new
1661 publish_parts convenience function.
1663 * tools/buildhtml.py:
1665 - Added support for the "--prune" option.
1666 - Removed dependency on pep2html.py; plaintext PEPs no longer
1669 * tools/docutils.conf:
1671 - Updated for configuration file reorganization.
1673 * tools/rst2html.py:
1675 - copied from tools/html.py
1679 - added a 'scripts' section to configuration
1680 - added 'tools/rst2html.py' to the scripts section
1683 Release 0.3 (2003-06-24)
1684 ========================
1688 * Renamed "attribute" to "option" for directives/extensions.
1690 * Renamed transform method "transform" to "apply".
1692 * Renamed "options" to "settings" for runtime settings (as set by
1693 command-line options). Sometimes "option" (singular) became
1694 "settings" (plural). Some variations below:
1696 - document.options -> document.settings (stored in other objects as
1698 - option_spec -> settings_spec (not directives though)
1699 - OptionSpec -> SettingsSpec
1700 - cmdline_options -> settings_spec
1701 - relative_path_options -> relative_path_settings
1702 - option_default_overrides -> settings_default_overrides
1703 - Publisher.set_options -> Publisher.get_settings
1707 * COPYING.txt: Added "Public Domain Dedication".
1709 * FAQ.txt: Frequently asked questions, added to project.
1713 - Updated with PyPI Trove classifiers.
1714 - Conditional installation of third-party modules.
1716 * docutils/__init__.py:
1718 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1719 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1720 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1721 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1722 option and its effect on the PEP template & writer.
1723 - Bumped version to 0.2.4 due to changes to the PEP template &
1725 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1726 - Added ``TransformSpec`` class for new transform system.
1727 - Bumped version to 0.2.6 for API changes (renaming).
1728 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1729 convenience functions.
1730 - Added ``Component.component_type`` attribute.
1731 - Bumped version to 0.2.8 because of the internal parser switch from
1732 plain lists to the docutils.statemachine.StringList objects.
1733 - Bumped version to 0.2.9 because of the frontend.py API changes.
1734 - Bumped version to 0.2.10 due to changes to the project layout
1735 (third-party modules removed from the "docutils" package), and
1736 signature changes in ``io.Input``/``io.Output``.
1737 - Changed version to 0.3.0 for release.
1741 - Made ``publish()`` a bit more convenient.
1742 - Generalized ``Publisher.set_io``.
1743 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1744 parameters; improved its docstring.
1745 - Added ``publish_file()`` and ``publish_string()``.
1746 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1748 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1749 "--dump-transforms" hidden options.
1750 - Added ``Publisher.apply_transforms()`` method.
1751 - Added ``Publisher.set_components()`` method; support for
1752 ``publish_*()`` conveninece functions.
1753 - Moved config file processing to docutils/frontend.py.
1754 - Added support for exit status ("exit_level" setting &
1755 ``enable_exit`` parameter for Publisher.publish() and convenience
1758 * docutils/frontend.py:
1760 - Check for & exit on identical source & destination paths.
1761 - Fixed bug with absolute paths & "--config".
1762 - Set non-command-line defaults in ``OptionParser.__init__()``:
1763 ``_source`` & ``_destination``.
1764 - Distributed ``relative_path_settings`` to components; updated
1765 ``OptionParser.populate_from_components()`` to combine it all.
1766 - Require list of keys in ``make_paths_absolute`` (was implicit in
1767 global ``relative_path_settings``).
1768 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1769 "--dump-settings", and "--dump-transforms" hidden options.
1770 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1771 code, replaced with correct code.
1772 - Added validation functionality for config files.
1773 - Added "--error-encoding" option/setting, "_disable_config"
1775 - Added encoding validation; updated "--input-encoding" and
1776 "--output-encoding"; added "--error-encoding-error-handler" and
1777 "--output-encoding-error-handler".
1778 - Moved config file processing from docutils/core.py.
1779 - Updated ``OptionParser.populate_from_components`` to handle new
1780 ``SettingsSpec.settings_defaults`` dict.
1781 - Added support for "-" => stdin/stdout.
1782 - Added "exit_level" setting ("--exit" option).
1786 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1787 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1788 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1789 - ``FileOutput.write()`` now returns the encoded output string.
1790 - Try to get path/stream name automatically in ``FileInput`` &
1792 - Added defaults for source & destination paths.
1793 - Allow for Unicode I/O with an explicit "unicode" encoding.
1794 - Added ``Output.encode()``.
1795 - Removed dependency on runtime settings; pass encoding directly.
1796 - Recognize Unicode strings in ``Input.decode()``.
1797 - Added support for output encoding error handlers.
1799 * docutils/nodes.py:
1801 - Added "Invisible" element category class.
1802 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1803 modification during a traversal.
1804 - Added element classes: ``line_block``, ``generated``, ``address``,
1805 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1806 ``superscript``, ``subscript``, ``inline``
1807 - Added support for lists of nodes to ``Element.insert()``.
1808 - Fixed parent linking in ``Element.replace()``.
1809 - Added new abstract superclass ``FixedTextElement``; adds
1810 "xml:space" attribute.
1811 - Added support for "line" attribute of ``system_message`` nodes.
1812 - Added support for the observer pattern from ``utils.Reporter``.
1813 Added ``parse_messages`` and ``transform_messages`` attributes to
1814 ``document``, removed ``messages``. Added ``note_parse_message``
1815 and ``note_transform_message`` methods.
1816 - Added support for improved diagnostics:
1818 - Added "document", "source", and "line" internal attributes to
1819 ``Node``, set by ``Node.setup_child()``.
1820 - Converted variations on ``node.parent = self`` to
1821 ``self.setup_child(node)``.
1822 - Added ``document.current_source`` & ``.current_line``
1823 attributes, and ``.note_source`` observer method.
1824 - Changed "system_message" output to GNU-Tools format.
1826 - Added a "rawsource" attribute to the ``Text`` class, for text
1827 before backslash-escape resolution.
1828 - Support for new transform system.
1829 - Reworked ``pending`` element.
1830 - Fixed XML DOM bug (SF #660611).
1831 - Removed the ``interpeted`` element class and added
1832 ``title_reference``, ``abbreviation``, ``acronym``.
1833 - Made substitutions case-sensitive-but-forgiving; moved some code
1835 - Fixed Unicode bug on element attributes (report: William Dode).
1837 * docutils/optik.py: Removed from project; replaced with
1838 extras/optparse.py and extras/textwrap.py. These will be installed
1839 only if they're not already present in the Python installation.
1841 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1842 only if it's not already present in the Python installation.
1844 * docutils/statemachine.py:
1846 - Factored out ``State.add_initial_transitions()`` so it can be
1848 - Converted whitespace-specific "blank" and "indent" transitions
1849 from special-case code to ordinary transitions: removed
1850 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1851 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1852 ``ws_initial_transitions`` attributes.
1853 - Removed ``State.match_transition()`` after merging it into
1855 - Added ``StateCorrection`` exception.
1856 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1857 (moved ``TransitionCorrection`` support there too.)
1858 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1859 ``EOFError`` instead of ``IndexError``.
1860 - Added ``State.no_match`` method.
1861 - Added support for the Observer pattern, triggered by input line
1863 - Added ``strip_top`` parameter to
1864 ``StateMachineWS.get_first_known_indented``.
1865 - Made ``context`` a parameter to ``StateMachine.run()``.
1866 - Added ``ViewList`` & ``StringList`` classes;
1867 ``extract_indented()`` becomes ``StringList.get_indented()``.
1868 - Added ``StateMachine.insert_input()``.
1869 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1870 thanks to) Fred Drake.
1872 * docutils/utils.py:
1874 - Added a ``source`` attribute to Reporter instances and
1875 ``system_message`` elements.
1876 - Added an observer pattern to ``utils.Reporter`` to keep track of
1878 - Fixed bugs in ``relative_path()``.
1879 - Added support for improved diagnostics.
1880 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1881 - Added support for encoding Reporter stderr output, and encoding
1883 - Reporter keeps track of the highest level system message yet
1886 * docutils/languages: Fixed bibliographic field language lookups.
1888 * docutils/languages/es.py: Added to project; Spanish mappings by
1889 Marcelo Huerta San Martin.
1891 * docutils/languages/fr.py: Added to project; French mappings by
1894 * docutils/languages/it.py: Added to project; Italian mappings by
1897 * docutils/languages/sk.py: Added to project; Slovak mappings by
1900 * docutils/parser/__init__.py:
1902 - Added ``Parser.finish_parse()`` method.
1904 * docutils/parser/rst/__init__.py:
1906 - Added options: "--pep-references", "--rfc-references",
1907 "--tab-width", "--trim-footnote-reference-space".
1909 * docutils/parsers/rst/states.py:
1911 - Changed "title under/overline too short" system messages from INFO
1912 to WARNING, and fixed its insertion location.
1913 - Fixed enumerated list item parsing to allow paragraphs & section
1914 titles to begin with enumerators.
1915 - Converted system messages to use the new "line" attribute.
1916 - Fixed a substitution reference edge case.
1917 - Added support for "--pep-references" and "--rfc-references"
1918 options; reworked ``Inliner`` code to make customization easier.
1919 - Removed field argument parsing.
1920 - Added support for short section title over/underlines.
1921 - Fixed "simple reference name" regexp to ignore text like
1922 "object.__method__"; not an anonymous reference.
1923 - Added support for improved diagnostics.
1924 - Reworked directive API, based on Dethe Elza's contribution. Added
1925 ``Body.parse_directive()``, ``.parse_directive_options()``,
1926 ``.parse_directive_arguments()`` methods.
1927 - Added ``ExtensionOptions`` class, to parse directive options
1928 without parsing field bodies. Factored
1929 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1930 ``ExtensionOptions``.
1931 - Improved definition list term/classifier parsing.
1932 - Added warnings for unknown directives.
1933 - Renamed ``Stuff`` to ``Struct``.
1934 - Now flagged as errors: transitions at the beginning or end of
1935 sections, empty sections (except title), and empty documents.
1936 - Updated for ``statemachine.StringList``.
1937 - Enabled recognition of schemeless email addresses in targets.
1938 - Added support for embedded URIs in hyperlink references.
1939 - Added backslash-escapes to inline markup end-string suffix.
1940 - Added support for correct interpreted text processing.
1941 - Fixed nested title parsing (topic, sidebar directives).
1942 - Added special processing of backslash-escaped whitespace (idea
1943 from David Abrahams).
1944 - Made substitutions case-sensitive-but-forgiving; moved some code
1945 to ``docutils.nodes``.
1946 - Added support for block quote attributions.
1947 - Added a kludge to work-around a conflict between the bubble-up
1948 parser strategy and short titles (<= 3 char-long over- &
1949 underlines). Fixes SF bug #738803 "infinite loop with multiple
1950 titles" submitted by Jason Diamond.
1951 - Added explicit interpreted text roles for standard inline markup:
1952 "emphasis", "strong", "literal".
1953 - Implemented "superscript" and "subscript" interpreted text roles.
1954 - Added initial support for "abbreviation" and "acronym" roles;
1956 - Added support for "--trim-footnote-reference-space" option.
1957 - Optional space before colons in directives & hyperlink targets.
1959 * docutils/parsers/rst/tableparser.py:
1961 - Fixed a bug that was producing unwanted empty rows in "simple"
1963 - Detect bad column spans in "simple" tables.
1965 * docutils/parsers/rst/directives: Updated all directive functions to
1968 * docutils/parsers/rst/directives/__init__.py:
1970 - Added ``flag()``, ``unchanged()``, ``path()``,
1971 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1972 directive option helper functions.
1973 - Added warnings for unknown directives.
1974 - Return ``None`` for missing directives.
1975 - Added ``register_directive()``, thanks to William Dode and Paul
1978 * docutils/parsers/rst/directives/admonitions.py:
1980 - Added "admonition" directive.
1982 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1983 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1984 "parsed-literal", "rubric", "epigraph", "highlights" and
1985 "pull-quote" directives.
1987 * docutils/parsers/rst/directives/images.py:
1989 - Added an "align" attribute to the "image" & "figure" directives
1990 (by Adam Chodorowski).
1991 - Added "class" option to "image", and "figclass" to "figure".
1993 * docutils/parsers/rst/directives/misc.py:
1995 - Added "include", "raw", and "replace" directives, courtesy of
1997 - Added "unicode" and "class" directives.
1999 * docutils/parsers/rst/directives/parts.py:
2001 - Added the "sectnum" directive; by Dmitry Jemerov.
2002 - Added "class" option to "contents" directive.
2004 * docutils/parsers/rst/directives/references.py: Added to project.
2005 Contains the "target-notes" directive.
2007 * docutils/parsers/rst/languages/__init__.py:
2009 - Return ``None`` from get_language() for missing language modules.
2011 * docutils/parsers/rst/languages/de.py: Added to project; German
2012 mappings by Engelbert Gruber.
2014 * docutils/parsers/rst/languages/en.py:
2016 - Added interpreted text roles mapping.
2018 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
2019 mappings by Marcelo Huerta San Martin.
2021 * docutils/parsers/rst/languages/fr.py: Added to project; French
2022 mappings by William Dode.
2024 * docutils/parsers/rst/languages/it.py: Added to project; Italian
2025 mappings by Nicola Larosa.
2027 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
2028 mappings by Miroslav Vasko.
2030 * docutils/readers/__init__.py:
2032 - Added support for the observer pattern from ``utils.Reporter``, in
2033 ``Reader.parse`` and ``Reader.transform``.
2034 - Removed ``Reader.transform()`` method.
2035 - Added default parameter values to ``Reader.__init__()`` to make
2036 instantiation easier.
2037 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
2039 * docutils/readers/pep.py:
2041 - Added the ``peps.TargetNotes`` transform to the Reader.
2042 - Removed PEP & RFC reference detection code; moved to
2043 parsers/rst/states.py as options (enabled here by default).
2044 - Added support for pre-acceptance PEPs (no PEP number yet).
2045 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
2048 * docutils/readers/python: Python Source Reader subpackage added to
2049 project, including preliminary versions of:
2052 - moduleparser.py: Parser for Python modules.
2054 * docutils/transforms/__init__.py:
2056 - Added ``Transformer`` class and completed transform reform.
2057 - Added unknown_reference_resolvers list for each transformer. This list holds
2058 the list of functions provided by each component of the transformer that
2059 help resolve references.
2061 * docutils/transforms/frontmatter.py:
2063 - Improved support for generic fields.
2064 - Fixed bibliographic field language lookups.
2066 * docutils/transforms/misc.py: Added to project. Miscellaneous
2069 * docutils/transforms/parts.py:
2071 - Moved the "id" attribute from TOC list items to the references
2072 (``Contents.build_contents()``).
2073 - Added the ``SectNum`` transform; by Dmitry Jemerov.
2074 - Added "class" attribute support to ``Contents``.
2076 * docutils/transforms/peps.py:
2078 - Added ``mask_email()`` function, updating to pep2html.py's
2080 - Linked "Content-Type: text/x-rst" to PEP 12.
2081 - Added the ``TargetNotes`` PEP-specific transform.
2082 - Added ``TargetNotes.cleanup_callback``.
2083 - Added title check to ``Headers``.
2085 * docutils/transforms/references.py:
2087 - Added the ``TargetNotes`` generic transform.
2088 - Split ``Hyperlinks`` into multiple transforms.
2089 - Fixed bug with multiply-indirect references (report: Bruce Smith).
2090 - Added check for circular indirect references.
2091 - Made substitutions case-sensitive-but-forgiving.
2093 * docutils/transforms/universal.py:
2095 - Added support for the "--expose-internal-attributes" option.
2096 - Removed ``Pending`` transform classes & data.
2098 * docutils/writers/__init__.py:
2100 - Removed ``Writer.transform()`` method.
2102 * docutils/writers/docutils-xml.py:
2104 - Added XML and doctype declarations.
2105 - Added "--no-doctype" and "--no-xml-declaration" options.
2107 * docutils/writers/html4css1.py:
2109 - "name" attributes only on these tags: a, applet, form, frame,
2111 - Added "name" attribute to <a> in section titles for Netscape 4
2112 support (bug report: Pearu Peterson).
2113 - Fixed targets (names) on footnote, citation, topic title,
2114 problematic, and system_message nodes (for Netscape 4).
2115 - Changed field names from "<td>" to "<th>".
2116 - Added "@" to "@" encoding to thwart address harvesters.
2117 - Improved the vertical whitespace optimization; ignore "invisible"
2118 nodes (targets, comments, etc.).
2119 - Improved inline literals with ``<span class="pre">`` around chunks
2120 of text and `` `` for runs of spaces.
2121 - Improved modularity of output; added ``self.body_pre_docinfo`` and
2122 ``self.docinfo`` segments.
2123 - Added support for "line_block", "address" elements.
2124 - Improved backlinks (footnotes & system_messages).
2125 - Improved system_message output.
2126 - Redefined "--stylesheet" as containing an invariant URL, used
2127 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
2129 - Added "--footnote-references" option (superscript or brackets).
2130 - Added "--compact-lists" and "--no-compact-lists" options.
2131 - Added "--embed-stylesheet" and "--link-stylesheet" options;
2132 factored out ``HTMLTranslator.get_stylesheet_reference()``.
2133 - Improved field list rendering.
2134 - Added Docutils version to "generator" meta tag.
2135 - Fixed a bug with images; they must be inline, so wrapped in <p>.
2136 - Improved layout of <pre> HTML source.
2137 - Fixed attribute typo on <colspec>.
2138 - Refined XML prologue.
2139 - Support for no stylesheet.
2140 - Removed "interpreted" element support.
2141 - Added support for "title_reference", "sidebar", "attribution",
2142 "rubric", and generic "admonition" elements.
2143 - Added "--attribution" option.
2144 - Added support for "inline", "subscript", "superscript" elements.
2145 - Added initial support for "abbreviation" and "acronym";
2148 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
2152 - Double quotes in literal blocks (special treatment for de/ngerman).
2153 - Added '--hyperlink-color' option ('0' turns off coloring of links).
2154 - Added "--attribution" option.
2155 - Right align attributions.
2157 * docutils/writers/pep_html.py:
2159 - Parameterized output encoding in PEP template.
2160 - Reworked substitutions from ``locals()`` into ``subs`` dict.
2161 - Redefined "--pep-stylesheet" as containing an invariant URL, used
2162 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
2164 - Added an override on the "--footnote-references" option.
2165 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
2166 - Added Docutils version to "generator" meta tag.
2167 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2171 - Added a "silent" setting for ``buildhtml.py``.
2172 - Added a "Getting Help" section.
2173 - Rearranged the structure.
2174 - Kept up to date, with new settings, command-line options etc.
2175 - Added section for ``rst2latex.py`` (Engelbert Gruber).
2176 - Converted settings table into a definition list.
2178 * docs/rst/quickstart.txt:
2180 - Added a table of contents.
2181 - Added feedback information.
2182 - Added mention of minimum section title underline lengths.
2183 - Removed the 4-character minimum for section title underlines.
2185 * docs/rst/quickref.html:
2187 - Added a "Getting Help" section.
2188 - Added a style to make section title backlinks more subtle.
2189 - Added mention of minimum section title underline lengths.
2190 - Removed the 4-character minimum for section title underlines.
2192 * extras: Directory added to project; contains third-party modules
2193 that Docutils depends on (optparse, textwrap, roman). These are
2194 only installed if they're not already present.
2196 * licenses: Directory added to project; contains copies of license
2197 files for non-public-domain files.
2201 - Changed the focus. It's about DTD elements: structural
2202 relationships, semantics, and external (public) attributes. Not
2203 about the element class library.
2204 - Moved some implementation-specific stuff into ``docutils.nodes``
2206 - Wrote descriptions of all common attributes and parameter
2207 entities. Filled in introductory material.
2208 - Working through the element descriptions: 55 down, 37 to go.
2209 - Removed "Representation of Horizontal Rules" to
2210 spec/rst/alternatives.txt.
2212 * spec/docutils.dtd:
2214 - Added "generated" inline element.
2215 - Added "line_block" body element.
2216 - Added "auto" attribute to "title".
2217 - Changed content models of "literal_block" and "doctest_block" to
2219 - Added ``%number;`` attribute type parameter entity.
2220 - Changed ``%structural.elements;`` to ``%section.elements``.
2221 - Updated attribute types; made more specific.
2222 - Added "address" bibliographic element.
2223 - Added "line" attribute to ``system_message`` element.
2224 - Removed "field_argument" element; "field_name" may contain
2225 multiple words and whitespace.
2226 - Changed public identifier to docutils.sf.net.
2227 - Removed "interpreted" element; added "title_reference",
2228 "abbreviation", "acronym".
2229 - Removed "refuri" attribute from "footnote_reference" and
2230 "citation_reference".
2231 - Added "sidebar", "rubric", "attribution", "admonition",
2232 "superscript", "subscript", and "inline" elements.
2234 * spec/pep-0256.txt: Converted to reStructuredText & updated.
2236 * spec/pep-0257.txt: Converted to reStructuredText & updated.
2238 * spec/pep-0258.txt: Converted to reStructuredText & updated.
2240 * spec/semantics.txt: Updated with text from a Doc-SIG response to
2243 * spec/transforms.txt: Added to project.
2245 * spec/howto: Added subdirectory, for developer how-to docs.
2247 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
2248 Elza, edited & extended by David Goodger.
2250 * spec/howto/i18n.txt: Docutils Internationalization. Added to
2253 * spec/rst/alternatives.txt:
2255 - Added "Doctree Representation of Transitions" from
2257 - Updated "Inline External Targets" & closed the debate.
2258 - Added ideas for interpreted text syntax extensions.
2259 - Added "Nested Inline Markup" section.
2261 * spec/rst/directives.txt:
2263 - Added directives: "topic", "sectnum", "target-notes",
2264 "line-block", "parsed-literal", "include", "replace", "sidebar",
2265 "admonition", "rubric", "epigraph", "highlights", "unicode" and
2267 - Formalized descriptions of directive details.
2268 - Added an "align" attribute to the "image" & "figure" directives
2269 (by Adam Chodorowski).
2270 - Added "class" options to "topic", "sidebar", "line-block",
2271 "parsed-literal", "contents", and "image"; and "figclass" to
2274 * spec/rst/interpreted.txt: Added to project. Descriptions of
2275 interpreted text roles.
2277 * spec/rst/introduction.txt:
2279 - Added pointers to material for new users.
2281 * spec/rst/reStructuredText.txt:
2283 - Disambiguated comments (just add a newline after the "::").
2284 - Updated enumerated list description; added a discussion of the
2285 second-line validity checking.
2286 - Updated directive description.
2287 - Added a note redirecting newbies to the user docs.
2288 - Expanded description of inline markup start-strings in non-markup
2290 - Removed field arguments and made field lists a generic construct.
2291 - Removed the 4-character minimum for section title underlines.
2292 - Clarified term/classifier delimiter & inline markup ambiguity
2294 - Added "Embedded URIs".
2295 - Updated "Interpreted Text" section.
2296 - Added "Character-Level Inline Markup" section.
2298 * test: Continually adding & updating tests.
2300 - Moved test/test_rst/ to test/test_parsers/test_rst/.
2301 - Moved test/test_pep/ to test/test_readers/test_pep/.
2302 - Added test/test_readers/test_python/.
2303 - Added test/test_writers/ (Engelbert Gruber).
2307 - Made the ``locale.setlocale()`` calls in front ends
2310 * tools/buildhtml.py:
2312 - Added "--silent" option.
2313 - Fixed bug with absolute paths & "--config".
2314 - Updated for new I/O classes.
2315 - Added some exception handling.
2316 - Separated publishers' setting defaults; prevents interference.
2317 - Updated for new ``publish_file()`` convenience function.
2319 * tools/pep-html-template:
2321 - Allow for "--embed-stylesheet".
2322 - Added Docutils version to "generator" meta tag.
2323 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2324 - Conform to XHTML spec.
2326 * tools/pep2html.py:
2328 - Made ``argv`` a parameter to ``main()``.
2329 - Added support for "Content-Type:" header & arbitrary PEP formats.
2330 - Linked "Content-Type: text/plain" to PEP 9.
2331 - Files skipped (due to an error) are not pushed onto the server.
2332 - Updated for new I/O classes.
2333 - Added ``check_requirements()`` & ``pep_type_error()``.
2334 - Added some exception handling.
2335 - Updated for new ``publish_string()`` convenience function.
2336 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
2338 * tools/quicktest.py:
2340 - Added "-V"/"--version" option.
2342 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
2344 * tools/unicode2rstsubs.py: Added to project. Produces character
2345 entity files (reSructuredText substitutions) from the MathML master
2348 * tools/editors: Support code for editors, added to project. Contains
2349 ``emacs/restructuredtext.el``.
2351 * tools/stylesheets/default.css: Moved into the stylesheets directory.
2353 - Added style for chunks of inline literals.
2354 - Removed margin for first child of table cells.
2355 - Right-aligned field list names.
2356 - Support for auto-numbered section titles in TOCs.
2357 - Increased the size of inline literals (<tt>) in titles.
2358 - Restored the light gray background for inline literals.
2359 - Added support for "line_block" elements.
2360 - Added style for "address" elements.
2361 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
2362 - Improved field list rendering.
2363 - Vertical whitespace improvements.
2364 - Removed "a.target" style.
2366 * tools/stylesheets/pep.css:
2368 - Fixed nested section margins.
2369 - Other changes parallel those of ``../default.css``.
2372 Release 0.2 (2002-07-31)
2373 ========================
2377 - The word "component" was being used ambiguously. From now on,
2378 "component" will be used to mean "Docutils component", as in Reader,
2379 Writer, Parser, or Transform. Portions of documents (Table of
2380 Contents, sections, etc.) will be called "document parts".
2381 - Did a grand renaming: a lot of ``verylongnames`` became
2382 ``very_long_names``.
2383 - Cleaned up imports: no more relative package imports or
2384 comma-separated lists of top-level modules.
2385 - Added support for an option values object which carries default
2386 settings and overrides (from command-line options and library use).
2387 - Added internal Unicode support, and support for both input and
2389 - Added support for the ``docutils.io.IO`` class & subclasses.
2393 * docutils/__init__.py:
2395 - Added ``ApplicationError`` and ``DataError``, for use throughout
2397 - Added ``Component`` base class for Docutils components; implements
2398 the ``supports`` method.
2399 - Added ``__version__`` (thus, ``docutils.__version__``).
2403 - Removed many keyword parameters to ``Publisher.__init__()`` and
2404 ``publish()``; bundled into an option values object. Added
2405 "argv", "usage", "description", and "option_spec" parameters for
2406 command-line support.
2407 - Added ``Publisher.process_command_line()`` and ``.set_options()``
2409 - Reworked I/O model for ``docutils.io`` wrappers.
2410 - Updated ``Publisher.set_options()``; now returns option values
2412 - Added support for configuration files (/etc/docutils.conf,
2413 ./docutils.conf, ~/.docutils).
2414 - Added ``Publisher.setup_option_parser()``.
2415 - Added default usage message and description.
2417 * docutils/frontend.py: Added to project; support for front-end
2418 (command-line) scripts. Option specifications may be augmented by
2419 components. Requires Optik (http://optik.sf.net/) for option
2420 processing (installed locally as docutils/optik.py).
2422 * docutils/io.py: Added to project; uniform API for a variety of input
2425 * docutils/nodes.py:
2427 - Added ``TreeCopyVisitor`` class.
2428 - Added a ``copy`` method to ``Node`` and subclasses.
2429 - Added a ``SkipDeparture`` exception for visitors.
2430 - Renamed ``TreePruningException`` from ``VisitorException``.
2431 - Added docstrings to ``TreePruningException``, subclasses, and
2433 - Improved docstrings.
2434 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
2435 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
2437 - Added ``decoration``, ``header``, and ``footer`` node classes, and
2438 ``PreDecorative`` mixin.
2439 - Reworked the name/id bookkeeping; to ``document``, removed
2440 ``explicit_targets`` and ``implicit_targets`` attributes, added
2441 ``nametypes`` attribute and ``set_name_id_map`` method.
2442 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
2444 - Added ``document.has_name()`` method.
2445 - Fixed DOM generation for list-attributes.
2446 - Added category class ``Labeled`` (used by footnotes & citations).
2447 - Added ``Element.set_class()`` method (sets "class" attribute).
2449 * docutils/optik.py: Added to project. Combined from the Optik
2450 package, with added option groups and other modifications. The use
2451 of this module is probably only temporary.
2453 * docutils/statemachine.py:
2455 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
2456 - Added underscores to improve many awkward names.
2457 - In ``string2lines()``, changed whitespace normalizing translation
2458 table to regexp; restores Python 2.0 compatibility with Unicode.
2460 * docutils/urischemes.py:
2462 - Filled in some descriptions.
2463 - Added "shttp" scheme.
2465 * docutils/utils.py:
2467 - Added ``clean_rcs_keywords`` function (moved from
2468 docutils/transforms/frontmatter.py
2469 ``DocInfo.filter_rcs_keywords``).
2470 - Added underscores to improve many awkward names.
2471 - Changed names of Reporter's thresholds:
2472 warning_level -> report_level; error_level -> halt_level.
2473 - Moved ``utils.id()`` to ``nodes.make_id()``.
2474 - Added ``relative_path(source, target)``.
2476 * docutils/languages/de.py: German mappings; added to project. Thanks
2477 to Gunnar Schwant for the translations.
2479 * docutils/languages/en.py: Added "Dedication" bibliographic field
2482 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
2485 * docutils/parsers/rst/states.py:
2487 - Added underscores to improve many awkward names.
2488 - Added RFC-2822 header support.
2489 - Extracted the inline parsing code from ``RSTState`` to a separate
2490 class, ``Inliner``, which will allow easy subclassing.
2491 - Made local bindings for ``memo`` container & often-used contents
2492 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
2493 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
2494 - Added ``MarkupMismatch`` exception; for late corrections.
2495 - Added ``-/:`` characters to inline markup's start string prefix,
2496 ``/`` to end string suffix.
2497 - Fixed a footnote bug.
2498 - Fixed a bug with literal blocks.
2499 - Applied patch from Simon Budig: simplified regexps with symbolic
2500 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
2501 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
2502 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
2503 - Allowed non-ASCII in "simple names" (directive names, field names,
2505 - Converted ``Inliner.patterns.initial`` to be dynamically built
2506 from parts with ``build_regexp()`` function.
2507 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
2508 - Updated docstrings.
2509 - Changed "table" to "grid_table"; added "simple_table" support.
2511 * docutils/parsers/rst/tableparser.py:
2513 - Changed ``TableParser`` to ``GridTableParser``.
2514 - Added ``SimpleTableParser``.
2515 - Refactored naming.
2517 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
2518 a fallback language for directive names.
2520 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
2521 directive to use a ``pending`` element, used only by HTML writers.
2523 * docutils/parsers/rst/directives/parts.py: Renamed from
2526 - Added "backlinks" attribute to "contents" directive.
2528 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
2529 project by Adam Chodorowski.
2531 * docutils/readers/__init__.py: Gave Readers more control over
2532 choosing and instantiating Parsers.
2534 * docutils/readers/pep.py: Added to project; for PEP processing.
2536 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
2537 requires a ``component`` parameter.
2539 * docutils/transforms/components.py: Added to project; transforms
2540 related to Docutils components.
2542 * docutils/transforms/frontmatter.py:
2544 - In ``DocInfo.extract_authors``, check for a single "author" in an
2545 "authors" group, and convert it to a single "author" element.
2546 - Added support for "Dedication" and generic bibliographic fields.
2548 * docutils/transforms/peps.py: Added to project; PEP-specific.
2550 * docutils/transforms/parts.py: Renamed from old components.py.
2552 - Added filter for `Contents`, to use alt-text for inline images,
2553 and to remove inline markup that doesn't make sense in the ToC.
2554 - Added "name" attribute to TOC topic depending on its title.
2555 - Added support for optional TOC backlinks.
2557 * docutils/transforms/references.py: Fixed indirect target resolution
2558 in ``Hyperlinks`` transform.
2560 * docutils/transforms/universal.py:
2562 - Changed ``Messages`` transform to properly filter out system
2563 messages below the warning threshold.
2564 - Added ``Decorations`` transform (support for ``--generator``,
2565 ``--date``, ``--time``, ``--source-link`` options).
2567 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
2568 Engelbert Gruber's PDF writer.
2570 * docutils/writers/html4css1.py:
2572 - Made XHTML-compatible (switched to lowercase element & attribute
2573 names; empty tag format).
2574 - Escape double-dashes in comment text.
2575 - Improved boilerplate & modularity of output.
2576 - Exposed modular output in Writer class.
2577 - Added a "generator" meta tag to <head>.
2578 - Added support for the ``--stylesheet`` option.
2579 - Added support for ``decoration``, ``header``, and ``footer``
2581 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
2582 translation table to regexp; restores Python 2.0 compatibility
2584 - Added the translator class as instance variable to the Writer, to
2585 make it easily subclassable.
2586 - Improved option list spacing (thanks to Richard Jones).
2587 - Modified field list output.
2588 - Added backlinks to footnotes & citations.
2589 - Added percentage widths to "<col>" tags (from colspec).
2590 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
2591 "<span>" changed to "<var>".
2592 - Inline literals: "<code>" changed to "<tt>".
2593 - Many changes to optimize vertical space: compact simple lists etc.
2594 - Add a command-line options & directive attributes to control TOC
2595 and footnote/citation backlinks.
2596 - Added support for optional footnote/citation backlinks.
2597 - Added support for generic bibliographic fields.
2598 - Identify backrefs.
2599 - Relative URLs for stylesheet links.
2601 * docutils/writers/pep_html.py: Added to project; HTML Writer for
2602 PEPs (subclass of ``html4css1.Writer``).
2604 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
2606 * docutils/writers/docutils_xml.py: Added to project; trivial writer
2607 of the Docutils internal doctree in XML.
2609 * docs/tools.txt: "Docutils Front-End Tools", added to project.
2613 - Changed the title to "The Docutils Document Tree".
2614 - Added "Hyperlink Bookkeeping" section.
2616 * spec/docutils.dtd:
2618 - Added ``decoration``, ``header``, and ``footer`` elements.
2619 - Brought ``interpreted`` element in line with the parser: changed
2620 attribute "type" to "role", added "position".
2621 - Added support for generic bibliographic fields.
2623 * spec/notes.txt: Continual updates. Added "Project Policies".
2625 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
2628 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
2630 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
2631 mailing list discussions.
2633 * spec/pep-0287.txt:
2635 - Renamed to "reStructuredText Docstring Format".
2637 - Reworked Q&A as an enumerated list.
2638 - Converted to reStructuredText format.
2640 * spec/pysource.dtd:
2642 - Reworked structural elements, incorporating ideas from Tony Ibbs.
2644 * spec/pysource.txt: Removed from project. Moved much of its contents
2647 * spec/rst/alternatives.txt:
2649 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
2650 - Added "Inline External Targets" section.
2652 * spec/rst/directives.txt:
2654 - Added "backlinks" attribute to "contents" directive.
2656 * spec/rst/problems.txt:
2658 - Updated the Enumerated List Markup discussion.
2659 - Added new alternative table markup syntaxes.
2661 * spec/rst/reStructuredText.txt:
2663 - Clarified field list usage.
2664 - Updated enumerated list description.
2665 - Clarified purpose of directives.
2666 - Added ``-/:`` characters to inline markup's start string prefix,
2667 ``/`` to end string suffix.
2668 - Updated "Authors" bibliographic field behavior.
2669 - Changed "inline hyperlink targets" to "inline internal targets".
2670 - Added "simple table" syntax to supplement the existing but
2671 newly-renamed "grid tables".
2672 - Added cautions for anonymous hyperlink use.
2673 - Added "Dedication" and generic bibliographic fields.
2675 * test: Made test modules standalone (subdirectories became packages).
2677 * test/DocutilsTestSupport.py:
2679 - Added support for PEP extensions to reStructuredText.
2680 - Added support for simple tables.
2681 - Refactored naming.
2683 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2685 - Now supports true packages containing test modules
2686 (``__init__.py`` files required); fixes duplicate module name bug.
2688 * test/test_pep/: Subpackage added to project; PEP testing.
2690 * test/test_rst/test_SimpleTableParser.py: Added to project.
2694 - Updated html.py and publish.py front-end tools to use the new
2695 command-line processing facilities of ``docutils.frontend``
2696 (exposed in ``docutils.core.Publisher``), reducing each to just a
2698 - Added ``locale.setlocale()`` calls to front-end tools.
2700 * tools/buildhtml.py: Added to project; batch-generates .html from all
2701 the .txt files in directories and subdirectories.
2703 * tools/default.css:
2705 - Added support for ``header`` and ``footer`` elements.
2706 - Added styles for "Dedication" topics (biblio fields).
2708 * tools/docutils.conf: A configuration file; added to project.
2710 * tools/docutils-xml.py: Added to project.
2712 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2714 * tools/pep-html-template: Added to project.
2716 * tools/pep2html.py: Added to project from Python (nondist/peps).
2717 Added support for Docutils (reStructuredText PEPs).
2719 * tools/quicktest.py:
2721 - Added the ``--attributes`` option, hacked a bit.
2722 - Added a second command-line argument (output file); cleaned up.
2724 * tools/stylesheets/: Subdirectory added to project.
2726 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2729 Release 0.1 (2002-04-20)
2730 ========================
2732 This is the first release of Docutils, merged from the now inactive
2733 reStructuredText__ and `Docstring Processing System`__ projects. For
2734 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2735 `DPS HISTORY`__ files.
2737 __ http://structuredtext.sourceforge.net/
2738 __ http://docstring.sourceforge.net/
2739 __ http://structuredtext.sourceforge.net/HISTORY.html
2740 __ http://docstring.sourceforge.net/HISTORY.html
2742 General changes: renamed 'dps' package to 'docutils'; renamed
2743 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2744 the test suites (reStructuredText's test/test_states renamed to
2745 test/test_rst); and all modifications required to make it all work.
2747 * docutils/parsers/rst/states.py:
2749 - Improved diagnostic system messages for missing blank lines.
2750 - Fixed substitution_reference bug.
2756 indent-tabs-mode: nil
2757 sentence-end-double-space: t