~ubuntu-branches/ubuntu/karmic/python-docutils/karmic

« back to all changes in this revision

Viewing changes to HISTORY.txt

  • Committer: Bazaar Package Importer
  • Author(s): martin f. krafft
  • Date: 2006-07-10 11:45:05 UTC
  • mfrom: (2.1.4 edgy)
  • Revision ID: james.westby@ubuntu.com-20060710114505-otkhqcslevewxmz5
Tags: 0.4-3
Added build dependency on python-central (closes: #377580).

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
 Docutils History
3
3
==================
4
4
 
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.
10
11
 
11
12
.. contents::
12
13
 
13
 
Acknowledgements
14
 
================
15
 
 
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,
19
 
and related projects:
20
 
 
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
47
 
 
48
 
Thank you!
49
 
 
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.
53
 
 
54
 
 
55
 
Future Plans
56
 
============
57
 
 
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.
61
 
 
62
 
* Rename front-end tools (perhaps to "rst2*" pattern) and have
63
 
  setup.py install them.
64
 
 
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!
68
 
 
69
 
 
70
 
Changes Since 0.3.3
71
 
===================
72
 
 
73
 
(None yet.)
 
14
 
 
15
Release 0.4 (2006-01-09)
 
16
========================
 
17
 
 
18
* General:
 
19
 
 
20
  - Updated the project policies for trunk/branch development &
 
21
    version numbering.
 
22
 
 
23
* docutils/__init__.py:
 
24
 
 
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.
 
29
 
 
30
* docutils/core.py:
 
31
 
 
32
  - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
 
33
    functions, for document tree extraction and reprocessing.
 
34
 
 
35
* docutils/io.py:
 
36
 
 
37
  - Added ``DocTreeInput`` class, for reprocessing existing documents.
 
38
  - Added support for non-Unicode (e.g. binary) writer output.
 
39
 
 
40
* docutils/nodes.py:
 
41
 
 
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
 
55
    Shmuel Zeigerman.
 
56
 
 
57
* docutils/statemachine.py:
 
58
 
 
59
  - Added trailing whitespace stripping to ``string2lines()``.
 
60
  - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
 
61
    Asian double-width character support.
 
62
 
 
63
* docutils/utils.py:
 
64
 
 
65
  - Added ``east_asian_column_width()`` for double-width character
 
66
    support.
 
67
 
 
68
* docutils/languages/ja.py: Added to project: Japanese mappings by
 
69
  Hisashi Morita.
 
70
 
 
71
* docutils/languages/zh_cn.py: Added to project: Simplified Chinese
 
72
  mappings by Panjunyong.
 
73
 
 
74
* docutils/parsers/null.py: Added to project; a do-nothing parser.
 
75
 
 
76
* docutils/parsers/rst/__init__.py:
 
77
 
 
78
  - Added validator to tab_width setting, with test.  Closes SF bug
 
79
    #1212515, report from Wu Wei.
 
80
 
 
81
* docutils/parsers/rst/states.py:
 
82
 
 
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).
 
92
 
 
93
* docutils/parsers/rst/tableparser.py:
 
94
 
 
95
  - Added East Asian double-width character support (Python 2.4 only).
 
96
 
 
97
* docutils/parsers/rst/directives/body.py:
 
98
 
 
99
  - Added the "container" directive.
 
100
 
 
101
* docutils/parsers/rst/directives/misc.py:
 
102
 
 
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.
 
106
 
 
107
* docutils/parsers/rst/directives/images.py:
 
108
 
 
109
  - Added ``indirect_reference_name`` support for images with a target
 
110
    option.
 
111
  - Added support for image width and height units.
 
112
  - Fixed bug with image "target" options.
 
113
 
 
114
* docutils/parsers/rst/directives/references.py:
 
115
 
 
116
  - Added "class" attribute to "target-notes" directive, for
 
117
    footnote_reference classes.
 
118
 
 
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.
 
123
 
 
124
* docutils/parsers/rst/languages/ja.py: Added to project: Japanese
 
125
  mappings by David Goodger.
 
126
  
 
127
* docutils/parsers/rst/languages/zh_cn.py: Added to project:
 
128
  Simplified Chinese mappings by Panjunyong.
 
129
 
 
130
* docutils/readers/__init__.py:
 
131
 
 
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
 
135
    document tree.
 
136
 
 
137
* docutils/readers/doctree.py: Added to project; a reader for existing
 
138
  document trees.
 
139
 
 
140
* docutils/transforms/frontmatter.py:
 
141
 
 
142
  - Fixed the DocInfo transform to handle SVN-style expansion of the
 
143
    "Date" keyword.
 
144
  - In ``DocInfo.extract_authors``, treat the contents of "authors"
 
145
    fields uniformly.
 
146
 
 
147
* docutils/transforms/misc.py:
 
148
 
 
149
  - Added misc.Transitions transform, extracted from
 
150
    universal.FinalChecks.
 
151
 
 
152
* docutils/transforms/references.py:
 
153
 
 
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.
 
160
 
 
161
* docutils/transforms/universal.py:
 
162
 
 
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.
 
171
 
 
172
* docutils/transforms/writer_aux.py: Added to project; auxiliary
 
173
  transforms for writers.
 
174
 
 
175
  - Added ``Compound`` transform, which flattens compound paragraphs.
 
176
 
 
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".
 
185
 
 
186
* docutils/writers/__init__.py:
 
187
 
 
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.
 
192
 
 
193
* docutils/writers/docutils_xml.py:
 
194
 
 
195
  - Made ``xmlcharrefreplace`` the default output encoding error
 
196
    handler.
 
197
 
 
198
* docutils/writers/html4css1/: 
 
199
 
 
200
  - Added support for image width and height units.
 
201
  - Made ``xmlcharrefreplace`` the default output encoding error
 
202
    handler.
 
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
 
210
    simple field lists.
 
211
  - Made cloaking of email addresses with ``--cloak-email-addresses``
 
212
    less obtrusive.
 
213
  - Fixed support for centered images.
 
214
  - Added support for class="compact" & class="open" lists.
 
215
 
 
216
* docutils/writers/latex2e/:
 
217
 
 
218
  - Underscores in citekeys are no longer escaped.
 
219
 
 
220
* docutils/writers/newlatex2e/unicode_map.py: Added to project;
 
221
  mapping of Unicode characters to LaTeX equivalents.
 
222
 
 
223
* docutils/writers/s5_html/: Package added to project; writer for
 
224
  S5/HTML slide shows.
 
225
 
 
226
* docs/dev/distributing.txt: Added to project; guide for distributors
 
227
  (package maintainers).
 
228
 
 
229
* docs/dev/hacking.txt: Added to project; guide for developers.
 
230
 
 
231
* docs/ref/doctree.txt:
 
232
 
 
233
  - Updated for plural attributes "classes", "ids", "names",
 
234
    "dupnames".
 
235
  - Added the "container" element.
 
236
 
 
237
* docs/ref/docutils.dtd:
 
238
 
 
239
  - Updated for plural attributes "classes", "ids", "names",
 
240
    "dupnames".
 
241
 
 
242
* docs/user/emacs.txt: Added to project; a document about Emacs
 
243
  support for reStructuredText and Docutils.
 
244
 
 
245
* docs/user/links.txt: Added to project; lists of Docutils-related
 
246
  links.
 
247
 
 
248
* docs/user/mailing-lists.txt: Added to project; information about
 
249
  Docutils-related mailing lists and how to access them.
 
250
 
 
251
* docs/user/slide-shows.txt: Added to project; example of and docs for
 
252
  the S5/HTML writer (``rst2s5.py`` front end).
 
253
 
 
254
* docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
 
255
  Files", added to project.
 
256
 
 
257
* test/coverage.sh: Added to project; test coverage script.
 
258
 
 
259
* test/DocutilsTestSupport.py:
 
260
 
 
261
  - Added support for specifying runtime settings at the suite level.
 
262
 
 
263
* test/test_functional.py:
 
264
 
 
265
  - Added the ``clear_output_directory`` function.
 
266
  - Added support for ``_test_more`` functions in functional test
 
267
    config files.
 
268
 
 
269
* tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
 
270
 
 
271
* tools/rstpep2html.py: Renamed from pep.py.
 
272
 
 
273
* tools/dev/create_unimap.py: Added to project; script to create the
 
274
  docutils/writers/unimap_latex.py mapping file.
 
275
 
 
276
* tools/dev/profile_docutils.py: Added to project; profiler script.
 
277
 
 
278
* tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
 
279
 
 
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.
 
283
 
 
284
* tools/editors/emacs/rst.el: Added to project.  Added many features
 
285
  and fixed many bugs.  See docs/user/emacs.txt for details.
 
286
 
 
287
* tools/stylesheets: Removed from project.  Stylesheets have been
 
288
  renamed and moved into writer packages.
 
289
 
 
290
 
 
291
Release 0.3.9 (2005-05-26)
 
292
==========================
 
293
 
 
294
* General:
 
295
 
 
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.
 
300
 
 
301
* docutils/core.py:
 
302
 
 
303
  - Enabled ``--dump-*`` options when ``--traceback`` specified,
 
304
    allowing for easier debugging.
 
305
  - In ``Publisher.publish()``, expanded the generic top-level
 
306
    exception catching.
 
307
 
 
308
* docutils/examples.py:
 
309
 
 
310
  - Added ``internals`` function for exploration.
 
311
 
 
312
* docutils/io.py:
 
313
 
 
314
  - Fixed ``Input.decode`` method to apply heuristics only if no
 
315
    encoding is explicitly given, and to provide better reporting of
 
316
    decoding errors.
 
317
  - The ``Input.decode`` method now removes byte order marks (BOMs)
 
318
    from input streams.
 
319
 
 
320
* docutils/nodes.py:
 
321
 
 
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()``
 
331
    methods.
 
332
 
 
333
* docutils/utils.py:
 
334
 
 
335
  - Removed ``docutils.utils.Reporter.categories``,
 
336
    ``docutils.utils.ConditionSet``, and all references to them, to
 
337
    simplify error reporting.
 
338
 
 
339
* docutils/languages/nl.py: Added to project; Dutch mappings by
 
340
  Martijn Pieters.
 
341
 
 
342
* docutils/parsers/rst/__init__.py:
 
343
 
 
344
  - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
 
345
 
 
346
* docutils/parsers/rst/states.py:
 
347
 
 
348
  - Added check for escaped at-mark to prevent email address recognition.
 
349
  - Fixed option lists to allow spaces inside ``<angle-bracketed option
 
350
    arguments>``.
 
351
  - Allowed whitespace in paths and URLs.
 
352
  - Added auto-enumerated list items.
 
353
  - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
 
354
    followed by text.
 
355
  - Added support for table stub columns.
 
356
 
 
357
* docutils/parsers/rst/directives/__init__.py:
 
358
 
 
359
  - Allowed whitespace in paths (``path`` function).
 
360
  - Added ``uri`` directive option conversion function.
 
361
 
 
362
* docutils/parsers/rst/directives/body.py:
 
363
 
 
364
  - Fixed illegal context bug with "topic" directive (allowed within
 
365
    sidebars; not within body elements).
 
366
 
 
367
* docutils/parsers/rst/directives/images.py:
 
368
 
 
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.
 
378
 
 
379
* docutils/parsers/rst/directives/misc.py:
 
380
 
 
381
  - Fixed "include" and "raw" directives to catch text decoding
 
382
    errors.
 
383
  - Allowed whitespace in "include" & "raw" directive paths.
 
384
  - Added support for ``file_insertion_enabled`` & ``raw_enabled``
 
385
    settings in "include" & "raw" directives.
 
386
 
 
387
* docutils/parsers/rst/directives/parts.py:
 
388
 
 
389
  - Added "header" & "footer" directives.
 
390
  - Fixed illegal context bug with "contents" directive (topics
 
391
    allowed within sidebars; not within body elements).
 
392
 
 
393
* docutils/parsers/rst/directives/tables.py:
 
394
 
 
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"
 
400
    directives.
 
401
 
 
402
* docutils/parsers/rst/languages/nl.py: Added to project; Dutch
 
403
  mappings by Martijn Pieters.
 
404
 
 
405
* docutils/readers/standalone.py:
 
406
 
 
407
  - Added ``--section-subtitles`` and ``--no-section-subtitles``
 
408
    options to activate or deactivate the SectSubTitle transform.
 
409
 
 
410
* docutils/transforms/frontmatter.py:
 
411
 
 
412
  - Added SectSubTitle transform to promote titles of lone
 
413
    subsections to subtitles.
 
414
 
 
415
* docutils/transforms/references.py:
 
416
 
 
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``
 
422
    transform.
 
423
 
 
424
* docutils/writers/html4css1.py:
 
425
 
 
426
  - Fixed unencoded stylesheet reference bug (characters like "&" in
 
427
    stylesheet references).
 
428
  - ``target`` nodes now appear as ``span`` tags (instead of ``a``
 
429
    tags).
 
430
  - Added support for multiple IDs per node by creating empty ``span``
 
431
    tags.
 
432
  - Added the ``field_name_limit`` & ``option_limit`` settings &
 
433
    support.
 
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.
 
441
 
 
442
* docutils/writers/latex2e.py:
 
443
 
 
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
 
447
    titlepage.
 
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
 
451
    was given.
 
452
  - Added support for section subtitles.
 
453
 
 
454
* docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
 
455
  (under development).
 
456
 
 
457
* docutils/writers/null.py: Added to project; a do-nothing Writer.
 
458
 
 
459
* docs/api/publisher.txt:
 
460
 
 
461
  - Added "``publish_parts`` Details" section.
 
462
 
 
463
* docutils/dev/repository.txt: Added to project; information about the
 
464
  Docutils Subversion repository.
 
465
 
 
466
* docs/ref/docutils.dtd:
 
467
 
 
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.
 
472
 
 
473
* tools/rst2newlatex.py: Added to project; front end for the new LaTeX
 
474
  writer.
 
475
 
 
476
 
 
477
Release 0.3.7 (2004-12-24)
 
478
==========================
 
479
 
 
480
* docutils/frontend.py:
 
481
 
 
482
  - Added options: --input-encoding-error-handler,
 
483
    --record-dependencies, --leave-footnote-reference-space,
 
484
    --strict-visitor.
 
485
  - Added command-line and config file support for "overrides" setting
 
486
    parameter.
 
487
 
 
488
* docutils/io.py:
 
489
 
 
490
  - Added support for input encoding error handler.
 
491
 
 
492
* docutils/nodes.py:
 
493
 
 
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
 
499
    classes.
 
500
 
 
501
* docutils/utils.py:
 
502
 
 
503
  - Moved ``escape2null`` and ``unescape`` functions from
 
504
    docutils/parsers/rst/states.py.
 
505
 
 
506
* docutils/parsers/rst/roles.py:
 
507
 
 
508
  - Added "raw" role.
 
509
  - Changed role function API: the "text" parameter now takes
 
510
    null-escaped interpreted text content.
 
511
 
 
512
* docutils/parsers/rst/states.py:
 
513
 
 
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
 
516
    copied over.
 
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.
 
526
 
 
527
* docutils/parsers/rst/directives/__init__.py:
 
528
 
 
529
  - Added ``encoding`` directive option conversion function.
 
530
  - Allow multiple class names in class_option conversion function.
 
531
 
 
532
* docutils/parsers/rst/directives/body.py:
 
533
 
 
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).
 
538
 
 
539
* docutils/parsers/rst/directives/misc.py:
 
540
 
 
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.
 
544
 
 
545
* docutils/parsers/rst/directives/parts.py:
 
546
 
 
547
  - Directive "sectnum" now accepts "prefix", "suffix", and "start"
 
548
    options.  Thanks to Lele Gaifax.
 
549
 
 
550
* docutils/parsers/rst/directives/tables.py:
 
551
 
 
552
  - Added "encoding" directive to "csv-table" directive.
 
553
  - Added workaround for lack of Unicode support in csv.py, for
 
554
    non-ASCII CSV input.
 
555
 
 
556
* docutils/transforms/misc.py:
 
557
 
 
558
  - Fixed bug when multiple "class" directives are applied to a single
 
559
    element.
 
560
  - Enabled multiple format names for "raw" directive.
 
561
 
 
562
* docutils/transforms/references.py:
 
563
 
 
564
  - Added support for trimming whitespace from beside substitution
 
565
    references.
 
566
 
 
567
* docutils/transforms/universal.py:
 
568
 
 
569
  - FinalChecks now checks for illegal transitions and moves
 
570
    transitions between sections.
 
571
 
 
572
* docutils/writers/html4css1.py:
 
573
 
 
574
  - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
 
575
  - "stylesheet" and "stylesheet_path" settings are now mutually
 
576
    exclusive.
 
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``
 
587
    elements.
 
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"``).
 
596
 
 
597
* docutils/writers/latex2e.py:
 
598
 
 
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
 
603
    exclusive.
 
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.
 
610
 
 
611
* docs/ref/docutils.dtd:
 
612
 
 
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.
 
619
 
 
620
* docs/ref/rst/directives.txt
 
621
 
 
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.
 
626
 
 
627
* docs/ref/rst/restructuredtext.txt:
 
628
 
 
629
  - Added syntax for line blocks.
 
630
  - Definition list items may have multiple classifiers.
 
631
 
 
632
* docs/ref/rst/roles.txt:
 
633
 
 
634
  - Added "raw" role.
 
635
 
 
636
* tools/stylesheets/default.css:
 
637
 
 
638
  - Added support for the new line_block structure.
 
639
  - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
 
640
 
 
641
 
 
642
Release 0.3.5 (2004-07-29)
 
643
==========================
 
644
 
 
645
General:
 
646
 
 
647
* _`Documentation cleanup/reorganization`.
 
648
 
 
649
  - Created new subdirectories of docs/:
 
650
 
 
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
 
657
 
 
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``.
 
671
 
 
672
  In order to keep the CVS history of moved files, we supplied
 
673
  SourceForge with a `script for modifying the Docutils CVS
 
674
  repository`__.
 
675
 
 
676
  __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
 
677
 
 
678
  After running the cleanup script:
 
679
 
 
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.)
 
695
 
 
696
Specific:
 
697
 
 
698
* BUGS.txt: Added to project.
 
699
 
 
700
* THANKS.txt: Added to project.
 
701
 
 
702
* docutils/__init__.py:
 
703
 
 
704
  - 0.3.4: Post-release.
 
705
 
 
706
* docutils/core.py:
 
707
 
 
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.
 
722
 
 
723
* docutils/frontend.py:
 
724
 
 
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.
 
729
 
 
730
* docutils/parsers/rst/__init__.py:
 
731
 
 
732
  - Added "--pep-base-url" and "--rfc-base-url" options.
 
733
 
 
734
* docutils/parsers/rst/states.py:
 
735
 
 
736
  - Made URI recognition more aggressive and intelligent.
 
737
 
 
738
* docutils/parsers/rst/directives/__init__.py:
 
739
 
 
740
  - Added several directive option conversion functions.
 
741
 
 
742
* docutils/parsers/rst/directives/body.py:
 
743
 
 
744
  - Moved "table" directive to tables.py.
 
745
 
 
746
* docutils/parsers/rst/directives/tables.py: Table-related directives,
 
747
  added to project.
 
748
 
 
749
* docutils/writers/latex2e.py:
 
750
 
 
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
 
758
    width.
 
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.
 
764
 
 
765
* docs/index.txt: "Docutils Project Documentation Overview", added to
 
766
  project.
 
767
 
 
768
* docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
 
769
  Tool", added to project.
 
770
 
 
771
* docs/api/publisher.txt: "The Docutils Publisher", added to project.
 
772
 
 
773
* docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
 
774
 
 
775
* docs/dev/policies.txt: Added to project (extracted from
 
776
  ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
 
777
 
 
778
* docs/dev/release.txt: Added to project (extracted from
 
779
  ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
 
780
 
 
781
* docs/dev/testing.txt: Added to project.
 
782
 
 
783
* docs/dev/website.txt: Added to project (extracted from
 
784
  ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
 
785
 
 
786
* docs/ref/rst/directives.txt:
 
787
 
 
788
  - Added directives: "table", "csv-table".
 
789
 
 
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
 
793
  converted to HTML.
 
794
 
 
795
* docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
 
796
  with a change of title.
 
797
 
 
798
* test/functional/, contents, and test/test_functional.py: Added to
 
799
  project.
 
800
 
 
801
* tools/buildhtml.py: Fixed bug with config file handling.
 
802
 
 
803
* tools/html.py: Removed from project (duplicate of rst2html.py).
 
804
 
 
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/).
 
808
 
 
809
* tools/rst2pseudoxml.py: Renamed from publish.py.
 
810
 
 
811
* tools/rst2xml.py: Renamed from docutils-xml.py.
 
812
 
 
813
* tools/test.txt: Removed from project; moved to
 
814
  docs/user/rst/demo.txt.
 
815
 
 
816
* setup.py: Now also installs ``rst2latex.py``.
74
817
 
75
818
 
76
819
Release 0.3.3 (2004-05-09)
82
825
    docs/config.txt.
83
826
  - Added unknown_reference_resolvers attribute to TransformSpec.
84
827
  - 0.3.2: Interpreted text reorganization.
 
828
  - 0.3.3: Released.
85
829
 
86
830
* docutils/core.py:
87
831
 
246
990
    "topic" and "title", and leaving the "pending" node for the
247
991
    transform.  Allows earlier reference resolution; fixes subtle bug.
248
992
  - Added support for disabling of section numbering.
249
 
    
 
993
 
250
994
* docutils/transforms/references.py:
251
995
 
252
 
  - Verifying that external targets are truly targets and not indirect 
253
 
    references. This is because we are now adding a "name" attribute to 
 
996
  - Verifying that external targets are truly targets and not indirect
 
997
    references. This is because we are now adding a "name" attribute to
254
998
    references in addition to targets. Note sure if this is correct!
255
999
  - Added code to hook into the unknown_reference_resolvers list for a
256
1000
    transformer in resolve_indirect_target. This allows the
263
1007
  - Added FilterMessages transform (removes system messages below the
264
1008
    verbosity threshold).
265
1009
  - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
266
 
    to FinalCheckVisitor for application-specific handling of 
 
1010
    to FinalCheckVisitor for application-specific handling of
267
1011
    unresolvable references.
268
1012
  - Added specific error message for duplicate targets.
269
 
  
 
1013
 
270
1014
* docutils/writers/__init__.py:
271
1015
 
272
1016
  - Added assemble_parts method to the Writer class to allow for
306
1050
  - It's now possible to use four section levels in the `book` and
307
1051
    `report` LaTeX classes.  The default `article` class still has
308
1052
    three levels limit.
309
 
    
 
1053
 
310
1054
* docs/config.txt: "Docutils Configuration Files", added to project.
311
1055
  Moved config file entry descriptions from tools.txt.
312
1056
 
343
1087
* tools/buildhtml.py:
344
1088
 
345
1089
  - Added support for the "--prune" option.
 
1090
  - Removed dependency on pep2html.py; plaintext PEPs no longer
 
1091
    supported.
346
1092
 
347
1093
* tools/docutils.conf:
348
1094