5
:Authors: David Goodger, and all Docutils developers
5
:Author: David Goodger; open to all Docutils developers
6
6
:Contact: goodger@python.org
7
:Date: $Date: 2004/05/09 16:21:41 $
7
:Date: $Date: 2006-01-09 20:54:47 +0100 (Mon, 09 Jan 2006) $
8
:Revision: $Revision: 4262 $
8
9
:Web site: http://docutils.sourceforge.net/
9
10
:Copyright: This document has been placed in the public domain.
16
I would like to acknowledge the people who have made a direct impact
17
on the Docutils project, knowingly or not, in terms of encouragement,
18
suggestions, criticism, bug reports, code contributions, tasty treats,
21
Aahz, David Abrahams, David Ascher, Heiko Baumann, Eric Bellot,
22
Ian Bicking, Marek Blaha, Martin Blais, Stephen Boulet, Fred
23
Bremmer, Simon Budig, Bill Bumgarner, Brett Cannon, Greg Chapman,
24
Nicolas Chauveau, Beni Cherniavsky, Adam Chodorowski, Brent Cook,
25
Laura Creighton, Artur de Sousa Rocha, Jason Diamond, William
26
Dode, Fred Drake, Reggie Dugard, Dethe Elza, Marcus Ertl, Benja
27
Fallenstein, fantasai, Stefane Fermigier, Jim Fulton, Peter Funk,
28
Lele Gaifax, Dinu C. Gherman, Matt Gilbert, Jorge Gonzalez,
29
Engelbert Gruber, Jacob Hallen, Simon Hefti, Doug Hellmann,
30
Juergen Hermann, Jannie Hofmeyr, Steve Holden, Michael Hudson,
31
Marcelo Huerta San Martin, Ludger Humbert, Jeremy Hylton, Tony
32
Ibbs, Alan Jaffray, Dmitry Jemerov, Richard Jones, Andreas Jung,
33
Garth Kidd, Axel Kollmorgen, Jeff Kowalczyk, Dave Kuhlman, Lloyd
34
Kvam, Kirill Lapshin, Nicola Larosa, Daniel Larsson, Marc-Andre
35
Lemburg, Julien Letessier, Wolfgang Lipp, Edward Loper, Dallas
36
Mahrt, Ken Manheimer, Bob Marshall, Mark McEahern, Vincent
37
McIntyre, John F Meinel Jr, Vasko Miroslav, Skip Montanaro, Paul
38
Moore, Nigel W. Moriarty, Mark Nodine, Patrick K. O'Brien, Michel
39
Pelletier, Sam Penrose, Tim Peters, Pearu Peterson, Mark Pilgrim,
40
Brett g Porter, David Priest, Jens Quade, Andy Robinson, Tavis
41
Rudd, Tracy Ruggles, Oliver Rutherfurd, Kenichi Sato, Ueli
42
Schlaepfer, Gunnar Schwant, Bill Sconce, Frank Siebenlist, Bruce
43
Smith, Darek Suchojad, Roman Suzi, tav, Kent Tenney, Bob Tolbert,
44
Paul Tremblay, Laurence Tratt, Adrian van den Dries, Guido van
45
Rossum, Paul Viren, Martin von Loewis, Greg Ward, Barry Warsaw,
46
Edward Welbourne, Felix Wiemann, Ka-Ping Yee, Moshe Zadka
50
(I'm still waiting for contributions of computer equipment and cold
51
hard cash :-).) Hopefully I haven't forgotten anyone or misspelled
52
any names; apologies (and please let me know!) if I have.
58
* Include substitution files for character entities, produced by the
59
tools/unicode2rstsubs.py. As static data, these files could go
60
inside the docutils package somewhere.
62
* Rename front-end tools (perhaps to "rst2*" pattern) and have
63
setup.py install them.
65
* A Python Source Reader component (Python auto-documentation) will be
66
added as soon as there's enough time, effort, and will. If you'd
67
like to help, let me know!
15
Release 0.4 (2006-01-09)
16
========================
20
- Updated the project policies for trunk/branch development &
23
* docutils/__init__.py:
25
- Added ``__version_details__`` attribute to describe code source
26
(repository/snapshot/release).
27
- Replaced ``default_transforms`` attribute of TransformSpec with
28
``get_transforms()`` method.
32
- Added ``publish_doctree`` and ``publish_from_doctree`` convenience
33
functions, for document tree extraction and reprocessing.
37
- Added ``DocTreeInput`` class, for reprocessing existing documents.
38
- Added support for non-Unicode (e.g. binary) writer output.
42
- Re-introduced ``Targetable.indirect_reference_name``, for
43
MoinMoin/reST compatibility (removed in r3124/r3129).
44
- Added ``serial_escape`` function; escapes string values that are
45
elements of a list, for serialization. Modified Docutils-XML
46
writing (``Element._dom_node``) and pseudo-XML writing
47
(``Element.starttag``) to use ``serial_escape``.
48
- Added ``Node.deepcopy()`` method.
49
- Removed the internal lists ``document.substitution_refs``,
50
``document.anonymous_refs``, and ``document.anonymous_targets``.
51
- Added a "container" element.
52
- Fixed bug where values of list-valued attributes of elements
53
originating from custom interpreted text roles (i.e., with custom
54
classes) were being shared between element instances. Reported by
57
* docutils/statemachine.py:
59
- Added trailing whitespace stripping to ``string2lines()``.
60
- Added ``StringList.pad_double_width()`` & ``.replace()`` for East
61
Asian double-width character support.
65
- Added ``east_asian_column_width()`` for double-width character
68
* docutils/languages/ja.py: Added to project: Japanese mappings by
71
* docutils/languages/zh_cn.py: Added to project: Simplified Chinese
72
mappings by Panjunyong.
74
* docutils/parsers/null.py: Added to project; a do-nothing parser.
76
* docutils/parsers/rst/__init__.py:
78
- Added validator to tab_width setting, with test. Closes SF bug
79
#1212515, report from Wu Wei.
81
* docutils/parsers/rst/states.py:
83
- Fixed bug with escaped colons indicating a literal block.
84
- Fixed bug with enumerated lists (SF#1254145).
85
- Backslash-escaped colons inside of field names are now allowed.
86
- Targets (implicit and explicit), anonymous hyperlink references
87
and auto-numbered footnote references inside of substitution
88
definitions are now disallowed.
89
- Fixed bug: list items with blank first lines.
90
- Fixed bug: block quote attributions with indented second lines.
91
- Added East Asian double-width character support (Python 2.4 only).
93
* docutils/parsers/rst/tableparser.py:
95
- Added East Asian double-width character support (Python 2.4 only).
97
* docutils/parsers/rst/directives/body.py:
99
- Added the "container" directive.
101
* docutils/parsers/rst/directives/misc.py:
103
- Added the "default-role", "title", and "date" directives.
104
- Added standard data file syntax to the "include" directive.
105
- Added support for "class" directive content.
107
* docutils/parsers/rst/directives/images.py:
109
- Added ``indirect_reference_name`` support for images with a target
111
- Added support for image width and height units.
112
- Fixed bug with image "target" options.
114
* docutils/parsers/rst/directives/references.py:
116
- Added "class" attribute to "target-notes" directive, for
117
footnote_reference classes.
119
* docutils/parsers/rst/include/: Directory added to project; contains
120
standard data files for the "include" directive. Initial contents:
121
character entity substitution definition sets, and a set of
122
definitions for S5/HTML presentations.
124
* docutils/parsers/rst/languages/ja.py: Added to project: Japanese
125
mappings by David Goodger.
127
* docutils/parsers/rst/languages/zh_cn.py: Added to project:
128
Simplified Chinese mappings by Panjunyong.
130
* docutils/readers/__init__.py:
132
- Added universal.Decorations and universal.ExposeInternals
133
transforms as default transforms for all readers.
134
- Added ``ReReader`` base class for readers that reread an existing
137
* docutils/readers/doctree.py: Added to project; a reader for existing
140
* docutils/transforms/frontmatter.py:
142
- Fixed the DocInfo transform to handle SVN-style expansion of the
144
- In ``DocInfo.extract_authors``, treat the contents of "authors"
147
* docutils/transforms/misc.py:
149
- Added misc.Transitions transform, extracted from
150
universal.FinalChecks.
152
* docutils/transforms/references.py:
154
- Added references.DanglingReferences transform, extracted from
155
universal.FinalChecks.
156
- Fixed bug with doubly-indirect substitutions.
157
- Added footnote_reference classes attribute to "TargetNotes".
158
- Fixed bug with circular substitution definitions that put Docutils
159
into an infinite loop.
161
* docutils/transforms/universal.py:
163
- Added universal.ExposeInternals transform, extracted from
164
universal.FinalChecks.
165
- Removed universal.FinalChecks transform (logic has been moved to
166
several new transforms).
167
- Fixed bug with the "expose_internals" setting and Text nodes
168
(exposed by the "rawsource" internal attribute).
169
- Added the universal.StripComments transform, implementation of the
170
"strip_comments" setting.
172
* docutils/transforms/writer_aux.py: Added to project; auxiliary
173
transforms for writers.
175
- Added ``Compound`` transform, which flattens compound paragraphs.
177
* docutils/writers/: Several writer modules (html4css1.py) were
178
converted into packages. Support modules and data files have been
179
moved into the packages. The stylesheets for the HTML writers are
180
now installed along with the code, the code knows where to find
181
them, and the default is to use them (actually, to embed them).
182
Some adjustments to configuration files may be necessary. The
183
easiest way to obtain the new default behavior is to remove all
184
settings whose name includes "stylesheet".
186
* docutils/writers/__init__.py:
188
- Added universal.Messages and universal.FilterMessages transforms
189
as default transforms for all writers.
190
- Added ``UnfilteredWriter`` base class for writers that pass the
191
document tree on unchanged.
193
* docutils/writers/docutils_xml.py:
195
- Made ``xmlcharrefreplace`` the default output encoding error
198
* docutils/writers/html4css1/:
200
- Added support for image width and height units.
201
- Made ``xmlcharrefreplace`` the default output encoding error
203
- Made ``--embed-stylesheet`` the default rather than
204
``--link-stylesheet``.
205
- Moved "id" attribute from container (section etc.) to title's <a>
206
tag, to be on the same tag as "name".
207
(!!! To be reverted in Docutils 0.5.)
208
- Added vertical space between fields of field lists.
209
- Added ``--compact-field-lists`` option to remove vertical space in
211
- Made cloaking of email addresses with ``--cloak-email-addresses``
213
- Fixed support for centered images.
214
- Added support for class="compact" & class="open" lists.
216
* docutils/writers/latex2e/:
218
- Underscores in citekeys are no longer escaped.
220
* docutils/writers/newlatex2e/unicode_map.py: Added to project;
221
mapping of Unicode characters to LaTeX equivalents.
223
* docutils/writers/s5_html/: Package added to project; writer for
226
* docs/dev/distributing.txt: Added to project; guide for distributors
227
(package maintainers).
229
* docs/dev/hacking.txt: Added to project; guide for developers.
231
* docs/ref/doctree.txt:
233
- Updated for plural attributes "classes", "ids", "names",
235
- Added the "container" element.
237
* docs/ref/docutils.dtd:
239
- Updated for plural attributes "classes", "ids", "names",
242
* docs/user/emacs.txt: Added to project; a document about Emacs
243
support for reStructuredText and Docutils.
245
* docs/user/links.txt: Added to project; lists of Docutils-related
248
* docs/user/mailing-lists.txt: Added to project; information about
249
Docutils-related mailing lists and how to access them.
251
* docs/user/slide-shows.txt: Added to project; example of and docs for
252
the S5/HTML writer (``rst2s5.py`` front end).
254
* docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
255
Files", added to project.
257
* test/coverage.sh: Added to project; test coverage script.
259
* test/DocutilsTestSupport.py:
261
- Added support for specifying runtime settings at the suite level.
263
* test/test_functional.py:
265
- Added the ``clear_output_directory`` function.
266
- Added support for ``_test_more`` functions in functional test
269
* tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
271
* tools/rstpep2html.py: Renamed from pep.py.
273
* tools/dev/create_unimap.py: Added to project; script to create the
274
docutils/writers/unimap_latex.py mapping file.
276
* tools/dev/profile_docutils.py: Added to project; profiler script.
278
* tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
280
* tools/editors/emacs/restructuredtext.el,
281
tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
282
Removed from project; the functionality is now contained in rst.el.
284
* tools/editors/emacs/rst.el: Added to project. Added many features
285
and fixed many bugs. See docs/user/emacs.txt for details.
287
* tools/stylesheets: Removed from project. Stylesheets have been
288
renamed and moved into writer packages.
291
Release 0.3.9 (2005-05-26)
292
==========================
296
- Eliminated and replaced all uses of the old string attributes
297
``id``, ``name``, ``dupname`` and ``class`` with references to the
298
new list attributes ``ids``, ``names``, ``dupnames`` and
299
``classes`` throughout the whole source tree.
303
- Enabled ``--dump-*`` options when ``--traceback`` specified,
304
allowing for easier debugging.
305
- In ``Publisher.publish()``, expanded the generic top-level
308
* docutils/examples.py:
310
- Added ``internals`` function for exploration.
314
- Fixed ``Input.decode`` method to apply heuristics only if no
315
encoding is explicitly given, and to provide better reporting of
317
- The ``Input.decode`` method now removes byte order marks (BOMs)
322
- ``image`` element class changed to subclass of Element, not
323
TextElement (it's an empty element, and cannot contain text).
324
- Added ``attr_defaults`` dictionary for default attribute values.
325
- Added empty list as default value for the following attributes:
326
``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
327
- Added ``document.decoration`` attribute,
328
``document.get_decoration`` method, and ``decoration.get_header``
329
& ``.get_footer`` methods.
330
- Added ``Element.update_basic_atts()`` and ``Element.substitute()``
335
- Removed ``docutils.utils.Reporter.categories``,
336
``docutils.utils.ConditionSet``, and all references to them, to
337
simplify error reporting.
339
* docutils/languages/nl.py: Added to project; Dutch mappings by
342
* docutils/parsers/rst/__init__.py:
344
- Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
346
* docutils/parsers/rst/states.py:
348
- Added check for escaped at-mark to prevent email address recognition.
349
- Fixed option lists to allow spaces inside ``<angle-bracketed option
351
- Allowed whitespace in paths and URLs.
352
- Added auto-enumerated list items.
353
- Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
355
- Added support for table stub columns.
357
* docutils/parsers/rst/directives/__init__.py:
359
- Allowed whitespace in paths (``path`` function).
360
- Added ``uri`` directive option conversion function.
362
* docutils/parsers/rst/directives/body.py:
364
- Fixed illegal context bug with "topic" directive (allowed within
365
sidebars; not within body elements).
367
* docutils/parsers/rst/directives/images.py:
369
- Allowed whitespace (stripped) in "image" & "figure" directive URLs.
370
- Added support for the ``file_insertion_enabled`` setting in the
371
"figure" directive (disables "figwidth" option).
372
- "image" directive: added checks for valid values of "align" option,
373
depending on context. "figure" directive: added specialized
374
"align" option and attribute on "figure" element.
375
- Made ":figwidth: image" option of "figure" directive work again.
376
- Fixed bug with reference names containing uppercase letters
377
(e.g. ``Name_``) in "target" option of "image" directive.
379
* docutils/parsers/rst/directives/misc.py:
381
- Fixed "include" and "raw" directives to catch text decoding
383
- Allowed whitespace in "include" & "raw" directive paths.
384
- Added support for ``file_insertion_enabled`` & ``raw_enabled``
385
settings in "include" & "raw" directives.
387
* docutils/parsers/rst/directives/parts.py:
389
- Added "header" & "footer" directives.
390
- Fixed illegal context bug with "contents" directive (topics
391
allowed within sidebars; not within body elements).
393
* docutils/parsers/rst/directives/tables.py:
395
- Added "list-table" directive.
396
- Caught empty CSV table bug.
397
- Added support for the ``file_insertion_enabled`` setting in the
398
"csv-table" directive.
399
- Added ``stub-columns`` option to "csv-table" and "list-table"
402
* docutils/parsers/rst/languages/nl.py: Added to project; Dutch
403
mappings by Martijn Pieters.
405
* docutils/readers/standalone.py:
407
- Added ``--section-subtitles`` and ``--no-section-subtitles``
408
options to activate or deactivate the SectSubTitle transform.
410
* docutils/transforms/frontmatter.py:
412
- Added SectSubTitle transform to promote titles of lone
413
subsections to subtitles.
415
* docutils/transforms/references.py:
417
- Fixed mislocated internal targets bug, by propagating internal
418
targets to the next node, making use of the newly added support
419
for multiple names and IDs.
420
- Fixed duplicate footnote label bug.
421
- Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
424
* docutils/writers/html4css1.py:
426
- Fixed unencoded stylesheet reference bug (characters like "&" in
427
stylesheet references).
428
- ``target`` nodes now appear as ``span`` tags (instead of ``a``
430
- Added support for multiple IDs per node by creating empty ``span``
432
- Added the ``field_name_limit`` & ``option_limit`` settings &
434
- Added support for table stub columns.
435
- Added support for the ``align`` attribute on ``figure`` elements.
436
- Added the ``cloak_email_addresses`` setting & support.
437
- Added ``html_prolog``, ``html_head``, ``html_body``,
438
``html_title``, & ``html_subtitle`` to parts dictionary exposed by
439
``docutils.core.publish_parts``.
440
- Added support for section subtitles.
442
* docutils/writers/latex2e.py:
444
- Fixed tables starting with more than one multirow cell.
445
- Improved --use-latex-docinfo so that organization/contact/address
446
fields are lumped with the last author field and appear on the
448
- Made sure the titlepage is always shown with --use-latex-docinfo,
449
even if the document has no title.
450
- Made sure that latex doesn't fill in today's date if no date field
452
- Added support for section subtitles.
454
* docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
457
* docutils/writers/null.py: Added to project; a do-nothing Writer.
459
* docs/api/publisher.txt:
461
- Added "``publish_parts`` Details" section.
463
* docutils/dev/repository.txt: Added to project; information about the
464
Docutils Subversion repository.
466
* docs/ref/docutils.dtd:
468
- Added a ``stub`` attribute to the ``colspec`` element via the
469
``tbl.colspec.att`` parameter entity.
470
- Allowed topic elements within sidebars
471
- Added an ``align`` attribute to the ``figure`` element.
473
* tools/rst2newlatex.py: Added to project; front end for the new LaTeX
477
Release 0.3.7 (2004-12-24)
478
==========================
480
* docutils/frontend.py:
482
- Added options: --input-encoding-error-handler,
483
--record-dependencies, --leave-footnote-reference-space,
485
- Added command-line and config file support for "overrides" setting
490
- Added support for input encoding error handler.
494
- Added dispatch_visit and dispatch_departure methods to
495
NodeVisitor; useful as a hook for Visitors.
496
- Changed structure of ``line_block``; added ``line``.
497
- Added ``compound`` node class.
498
- Added a mechanism for Visitors to transitionally ignore new node
503
- Moved ``escape2null`` and ``unescape`` functions from
504
docutils/parsers/rst/states.py.
506
* docutils/parsers/rst/roles.py:
509
- Changed role function API: the "text" parameter now takes
510
null-escaped interpreted text content.
512
* docutils/parsers/rst/states.py:
514
- Fixed bug where a "role" directive in a nested parse would crash
515
the parser; the state machine's "language" attribute was not being
517
- Added support for line block syntax.
518
- Fixed directive parsing bug: argument-less directives didn't
519
notice that arguments were present.
520
- Removed error checking for transitions.
521
- Added support for multiple classifiers in definition list items.
522
- Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
523
- Changed role function API: the "text" parameter now takes
524
null-escaped interpreted text content.
525
- Empty sections and documents are allowed now.
527
* docutils/parsers/rst/directives/__init__.py:
529
- Added ``encoding`` directive option conversion function.
530
- Allow multiple class names in class_option conversion function.
532
* docutils/parsers/rst/directives/body.py:
534
- Converted the line-block directive to use the new structure.
535
- Extracted the old line-block functionality to the ``block``
536
function (still used).
537
- Added ``compound`` directive (thanks to Felix Wiemann).
539
* docutils/parsers/rst/directives/misc.py:
541
- Added "encoding" option to "include" and "raw" directives.
542
- Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
543
- Allow multiple class names in the "class" directive.
545
* docutils/parsers/rst/directives/parts.py:
547
- Directive "sectnum" now accepts "prefix", "suffix", and "start"
548
options. Thanks to Lele Gaifax.
550
* docutils/parsers/rst/directives/tables.py:
552
- Added "encoding" directive to "csv-table" directive.
553
- Added workaround for lack of Unicode support in csv.py, for
556
* docutils/transforms/misc.py:
558
- Fixed bug when multiple "class" directives are applied to a single
560
- Enabled multiple format names for "raw" directive.
562
* docutils/transforms/references.py:
564
- Added support for trimming whitespace from beside substitution
567
* docutils/transforms/universal.py:
569
- FinalChecks now checks for illegal transitions and moves
570
transitions between sections.
572
* docutils/writers/html4css1.py:
574
- HTMLTranslator.encode now converts U+00A0 to " ".
575
- "stylesheet" and "stylesheet_path" settings are now mutually
577
- Added support for the new line_block/line structure.
578
- --footnote-references now overrides
579
--trim-footnote-reference-space, if applicable.
580
- Added support for ``compound`` elements.
581
- Enabled multiple format names for "raw" directive.
582
- ``<p>`` tags of a paragraph which is the only visible child of the
583
document node are no longer stripped.
584
- Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
585
new method ``should_be_compact_paragraph()``.
586
- Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
588
- "raw" elements are now surrounded by ``span`` or ``div`` tags in
589
the output if they have their ``class`` attribute set.
590
- The whole document is now surrounded by a ``<div
591
class="document">`` element.
592
- Body-level images are now wrapped by their own ``<div>`` elements,
593
with image classes copied to the wrapper, and for images which
594
have the ``:align:`` option set, the surrounding ``<div>`` now
595
receives a class attribute (like ``class="align-left"``).
597
* docutils/writers/latex2e.py:
599
- no newline after depart_term.
600
- Added translations for some Unicode quotes.
601
- Added option "font-encoding", made package AE the default.
602
- "stylesheet" and "stylesheet_path" settings are now mutually
604
- --footnote-references now overrides
605
--trim-footnote-reference-space, if applicable.
606
- The footnote label style now matches the footnote reference style
607
("brackets" or "superscript").
608
- Added support for ``compound`` elements.
609
- Enabled multiple format names for "raw" directive.
611
* docs/ref/docutils.dtd:
613
- Changed structure of the ``line_block`` element; added ``line``.
614
- Added ``compound`` element.
615
- Added "ltrim" and "rtrim" attributes to
616
``substitution_definition`` element.
617
- Enabled multiple format names for ``raw`` element.
618
- Enabled multiple classifiers in ``definition_list_item`` elements.
620
* docs/ref/rst/directives.txt
622
- Marked "line-block" as deprecated.
623
- "Class" directive now allows multiple class names.
624
- Added "Rationale for Class Attribute Value Conversion".
625
- Added warning about "raw" overuse/abuse.
627
* docs/ref/rst/restructuredtext.txt:
629
- Added syntax for line blocks.
630
- Definition list items may have multiple classifiers.
632
* docs/ref/rst/roles.txt:
636
* tools/stylesheets/default.css:
638
- Added support for the new line_block structure.
639
- Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
642
Release 0.3.5 (2004-07-29)
643
==========================
647
* _`Documentation cleanup/reorganization`.
649
- Created new subdirectories of docs/:
651
* ``docs/user/``: introductory/tutorial material for end-users
652
* ``docs/dev/``: for core-developers (development notes, plans, etc.)
653
* ``docs/api/``: API reference material for client-developers
654
* ``docs/ref/``: reference material for all groups
655
* ``docs/howto/``: for component-developers and core-developers
656
* ``docs/peps/``: Python Enhancement Proposals
658
- Moved ``docs/*`` to ``docs/user/``.
659
- Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
660
``spec/`` to ``docs/dev``.
661
- Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
662
``transforms.txt`` from ``spec/`` to ``docs/ref/``.
663
- Moved ``alternatives.txt``, and ``problems.txt`` from
664
``spec/rst/`` to ``docs/dev/rst/``.
665
- Moved ``reStructuredText.txt``, ``directives.txt``,
666
``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
667
to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
668
``roles.txt``, ``reStructuredText.txt`` to
669
``restructuredtext.txt``.
670
- Moved ``spec/howto/`` to ``docs/howto``.
672
In order to keep the CVS history of moved files, we supplied
673
SourceForge with a `script for modifying the Docutils CVS
676
__ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
678
After running the cleanup script:
680
- Added ``docs/index.txt``.
681
- Added a ``.htaccess`` file to the ``web`` module, containing
682
redirects for all old paths to new paths. They'll preserve
683
fragments (the "#name" part of a URL), and won't clutter up the
684
file system, and will correct the URL in the user's browser.
685
- Added ``BUGS.txt``, ``docs/dev/policies.txt``,
686
``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
687
the "To Do" list itself in ``docs/dev/todo.txt``.
688
- Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
689
section of ``docs/dev/todo.txt``.
690
- Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
691
- Added "How To Report Bugs" to ``BUGS.txt``.
692
- Went through all the sources and docs (including under web/) and
693
updated links. Mostly done by Felix Wiemann; thanks Felix!
694
(Still need to update links in the sandboxes.)
698
* BUGS.txt: Added to project.
700
* THANKS.txt: Added to project.
702
* docutils/__init__.py:
704
- 0.3.4: Post-release.
708
- Added special error handling & advice for UnicodeEncodeError.
709
- Refactored Publisher.publish (simplified exception handling &
710
extracted debug dumps).
711
- Renamed "enable_exit" parameter of convenience functions to
712
"enable_exit_status".
713
- Enabled traceback (exception propagation) by default in
714
programmatic convenience functions.
715
- Now publish_file and publish_cmdline convenience functions return
716
the encoded string results in addition to their regular I/O.
717
- Extracted common code from publish_file, publish_string, and
718
publish_parts, into new publish_programmatically. Extracted
719
settings code to ``Publisher.process_programmatic_settings``.
720
- In Publisher.publish, disabled ``settings_overrides`` when
721
``settings`` is supplied; redundant.
723
* docutils/frontend.py:
725
- Added help text for "--output-encoding-error-handler" and
726
"--error-encoding-error-handler".
727
- Renamed "--exit" to "--exit-status".
728
- Simplified default-setting code.
730
* docutils/parsers/rst/__init__.py:
732
- Added "--pep-base-url" and "--rfc-base-url" options.
734
* docutils/parsers/rst/states.py:
736
- Made URI recognition more aggressive and intelligent.
738
* docutils/parsers/rst/directives/__init__.py:
740
- Added several directive option conversion functions.
742
* docutils/parsers/rst/directives/body.py:
744
- Moved "table" directive to tables.py.
746
* docutils/parsers/rst/directives/tables.py: Table-related directives,
749
* docutils/writers/latex2e.py:
751
- Added "--table-style=(standard|booktabs|nolines)"
752
- figures get "here" option (LaTeX per default puts them at bottom),
753
and figure content is centered.
754
- Rowspan support for tables.
755
- Fix: admonition titles before first section.
756
- Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
757
- Replave ``_`` in literal by an underlined blank, because it has the correct
759
- Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
760
- A few unicode replacements, if output_encoding != utf
761
- Add "--graphicx-option".
762
- Indent literal-blocks.
763
- Fix: omit ``\maketitle`` when there is no document title.
765
* docs/index.txt: "Docutils Project Documentation Overview", added to
768
* docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
769
Tool", added to project.
771
* docs/api/publisher.txt: "The Docutils Publisher", added to project.
773
* docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
775
* docs/dev/policies.txt: Added to project (extracted from
776
``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
778
* docs/dev/release.txt: Added to project (extracted from
779
``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
781
* docs/dev/testing.txt: Added to project.
783
* docs/dev/website.txt: Added to project (extracted from
784
``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
786
* docs/ref/rst/directives.txt:
788
- Added directives: "table", "csv-table".
790
* docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
791
added to project. 1 page for syntax, and a 1 page reference for
792
directives and roles. Source text to be used as-is; not meant to be
795
* docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
796
with a change of title.
798
* test/functional/, contents, and test/test_functional.py: Added to
801
* tools/buildhtml.py: Fixed bug with config file handling.
803
* tools/html.py: Removed from project (duplicate of rst2html.py).
805
* tools/pep2html.py: Removed from project (duplicate of Python's
806
nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
807
Docutils-related PEPs in docs/peps/).
809
* tools/rst2pseudoxml.py: Renamed from publish.py.
811
* tools/rst2xml.py: Renamed from docutils-xml.py.
813
* tools/test.txt: Removed from project; moved to
814
docs/user/rst/demo.txt.
816
* setup.py: Now also installs ``rst2latex.py``.
76
819
Release 0.3.3 (2004-05-09)