HISTORY.txt 115 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243
  1. .. -*- coding: utf-8 -*-
  2. ==================
  3. Docutils History
  4. ==================
  5. :Author: David Goodger; open to all Docutils developers
  6. :Contact: docutils-develop@lists.sourceforge.net
  7. :Date: $Date: 2017-08-03 11:01:16 +0200 (Do, 03 Aug 2017) $
  8. :Revision: $Revision: 8147 $
  9. :Web site: http://docutils.sourceforge.net/
  10. :Copyright: This document has been placed in the public domain.
  11. .. contents::
  12. Release 0.14 (2017-08-03)
  13. =========================
  14. As rc2.
  15. * docs/ref/docutils.dtd:
  16. - Enable validation of Docutils XML documents against the DTD:
  17. Use attribute type NMTOKEN instead of REFID for the `refid` attribute
  18. and NMTOKENS for `backrefs`: REFID refers to an ID type instance,
  19. however, the `ids` attribute cannot use the ID type because `XML only
  20. allows one ID per Element Type`__ and doesn't support a multiple-ID
  21. "IDS" attribute type.
  22. __ https://www.w3.org/TR/REC-xml/#sec-attribute-types
  23. * docs/ref/rst/restructuredtext.txt:
  24. - Added documentation for escaped whitespace in URI contexts.
  25. - Clarify use of Unicode character categories.
  26. * docutils/parsers/rst/states.py:
  27. - Added functionality: escaped whitespace in URI contexts.
  28. - Consistent handling of all whitespace characters in inline markup
  29. recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
  30. * docutils/parsers/rst/directives/images.py:
  31. - Added support for escaped whitespace in URI contexts.
  32. * docutils/parsers/rst/directives/tables.py:
  33. - Rework patch [ 120 ] (revert change to ``Table.get_column_widths()``
  34. that led to problems in an application with a custom table directive).
  35. * docutils/transforms/frontmatter.py
  36. - Fix [ 320 ] Russian docinfo fields not recognized.
  37. * docutils/transforms/references.py
  38. - Don't add a second ID to problematic references.
  39. * docutils/transforms/universal.py
  40. Fix SmartQuotes: warn only once if language is unsupported,
  41. keep "rawsource" when "educating" quotes.
  42. * docutils/utils/__init__.py:
  43. - Added ``split_escaped_whitespace`` function, support for escaped
  44. whitespace in URI contexts.
  45. * docutils/utils/error_reporting.py
  46. - Fix [ 321 ] Import block might cause name error.
  47. * docutils/utils/smartquotes.py:
  48. - Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
  49. - New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
  50. - Fix [ 313 ] Differentiate apostrophe from closing single quote
  51. (if possible).
  52. - Fix [ 317 ] Extra space inserted with French smartquotes.
  53. - Add command line interface for stand-alone use (requires 2.7).
  54. * docutils/writers/_html_base.py
  55. - Provide default title in metadata (required by HTML5).
  56. - Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
  57. - Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security
  58. reasons, we don't use a third party public installation as default but
  59. warn if math-output_ is set to MathJax without specifying a URL.
  60. * docutils/writers/html4css1/__init__.py
  61. - Apply [ 125 ] HTML writer: respect automatic table column sizing.
  62. * docutils/writers/latex2e/__init__.py
  63. - Handle class arguments for block-level elements by wrapping them
  64. in a "DUclass" environment. This replaces the special handling for
  65. "epigraph" and "topic" elements.
  66. * docutils/writers/manpage.py
  67. - Apply [ 141 ] Handling inline in manpage writer.
  68. * docutils/writers/odf_odt/__init__.py:
  69. - Command setting ``language`` now sets the default language
  70. of the generated ODF document.
  71. - The use of image directive options :width: (%), :scale:, etc now
  72. set the width/height/size of images in the generated ODF
  73. documents.
  74. - The heading/title of admonitions now reflects the language
  75. specified by the ``language`` setting.
  76. - Fixed [ 306 ] only first of multiple "image" directives with the same URL
  77. shown in output.
  78. - Fixed [ 282 ] python3: AttributeError.
  79. * tools/rst2html4.py: New front-end.
  80. * tools/dev/generate_punctuation_chars.py: New skript
  81. to test and update utils.punctuation_chars.
  82. Release 0.13.1 (2016-12-09)
  83. ===========================
  84. * docutils/languages/fa.py
  85. docutils/parsers/rst/languages/fa.py
  86. docutils/languages/la.py
  87. docutils/parsers/rst/languages/la.py:
  88. - Apply [ 133 ] Persian mappings by Shahin Azad.
  89. - Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
  90. * docutils/nodes.py
  91. - Fix [ 253 ] Attribute key without value not allowed in XML.
  92. * docutils/parsers/
  93. - Apply [ 103 ] Recognize inline markups without word boundaries.
  94. - Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
  95. * docutils/parsers/rst/__init__.py
  96. - Fix [ 233 ] Change the base URL for the :rfc: role.
  97. * docutils/parsers/rst/directives/tables.py
  98. - Apply [ 120 ] tables accept option widths: list of relative widths, 'auto'
  99. or 'grid'.
  100. - Implement feature request [ 48 ]
  101. Add :align: option to the table directives.
  102. Thanks to Takeshi KOMIYA for the patch.
  103. * docutils/parsers/rst/roles.py
  104. - Fix [ 295 ] Class argument for custom role inheriting from math.
  105. * docutils/parsers/rst/tableparser.py
  106. - Really fix [ 159 ] Spurious table column alignment errors.
  107. * docutils/transforms/frontmatter.py
  108. - Add name of generic bibliographic fields as a "classes" attribute value
  109. (after conversion to a valid identifier form).
  110. * docutils/utils/error_reporting.py
  111. - Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
  112. * docutils/utils/math/math2html.py
  113. - Add ``\colon`` macro, fix spacing around colons. Fixes [ 246 ].
  114. - New upstream version (additional macros, piecewise integrals and sums).
  115. * docutils/writers/_html_base.py
  116. - New auxiliary module for definitions common to all HTML writers.
  117. * docutils/writers/html5_polyglot/
  118. - New HTML writer generating clean, polyglot_ markup conforming to
  119. `HTML 5`_.
  120. The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
  121. and recommended layout rules.
  122. * docutils/writers/html4css1/__init__.py
  123. - Add "docutils" to class values for "container" object to address [ 267 ].
  124. - Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
  125. ``default_stylesheet_path`` and ``default_template_path``.
  126. - Fix [ 266 ] creating labels/class values in description list items.
  127. - Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
  128. - Fix footnotes with content that does not start with a paragraph.
  129. - Use https in default MathJax URL (report Alan G Isaac).
  130. - Outsourcing of common code to _html_base.py.
  131. * docutils/writers/latex2e/__init__.py
  132. - Fix [ 262 ] Use ``\linewidth`` instead of ``\textwidth`` for figures,
  133. admonitions and docinfo.
  134. - Use absolute path for ``default_template_path``.
  135. - Removed deprecated options ``--use-latex-footnotes`` and
  136. ``--figure-footnotes``.
  137. - Cleaner LaTeX code for enumerations and literal blocks.
  138. - Use "hyperref" package together with "bookmark" (improved hyperlinking
  139. by the same author).
  140. - Fix [ 286 ] Empty column title cause invalid latex file.
  141. - Fix [ 224 ] Fix rowspan support for tables.
  142. - Let LaTeX determine the column widths in tables with "colwidths-auto".
  143. Not suited for multi-paragraph cells!
  144. * docutils/writers/odf_odt/__init__.py
  145. - remove decode.encode of filename stored in zip.
  146. * docutils/writers/xetex/__init__.py
  147. - LuaLaTex compatibility: do not load "xunicode".
  148. * tools/
  149. - New front-end ``rst2html5.py``.
  150. * tox.ini
  151. - Test py26, py27, py33 and py34.
  152. To use, install the ``tox`` package via pip or easy_install and use
  153. tox from the project root directory.
  154. .. _polyglot: http://www.w3.org/TR/html-polyglot/
  155. .. _HTML 5: http://www.w3.org/TR/html5/
  156. .. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
  157. Release 0.12 (2014-07-06)
  158. =========================
  159. * docs/ref/rst/directives.txt
  160. - Update "math" and "csv-table" descriptions.
  161. * docutils/parsers/rst/directives/images.py
  162. - Fix [ 258 ] figwidth="image" generates unitless width value.
  163. * docutils/parsers/rst/states.py
  164. - Improve error report when a non-ASCII character is specified as
  165. delimiter, quote or escape character under Python 2.
  166. Fixes [ 249 ] and [ 250 ].
  167. * docutils/writers/html4css1/__init__.py
  168. - Don't add newline after inline math.
  169. Thanks to Yury G. Kudryashov for the patch.
  170. * docutils/writers/latex2e/__init__.py
  171. - Fix [ 239 ] Latex writer glues paragraphs with figure floats.
  172. - Apply [ 116 ] by Kirill Smelkov. Don't hardcode \large for subtitle.
  173. * docutils/writers/odf_odt/__init__.py
  174. - Apply patch by Jakub Wilk to fix bug [ 100 ].
  175. * test/test_error_reporting.py
  176. - Fix [ 223 ] by removing redundant tests we do not have control over.
  177. * test/test_nodes.py
  178. - Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
  179. Release 0.11 (2013-07-22)
  180. =========================
  181. * General
  182. - Apply [ 2714873 ] Fix for the overwritting of document attributes.
  183. - Support embedded aliases within hyperlink references.
  184. - Fix [ 228 ] try local import of docutils components (reader, writer, parser,
  185. language module) before global search.
  186. * docutils/nodes.py
  187. - Fix [ 3601607 ] node.__repr__() must return `str` instance.
  188. * docutils/parsers/rst/directives/__init__.py
  189. - Fix [ 3606028 ] ``assert`` is skipped with ``python -O``.
  190. * docutils/parsers/rst/directives/images.py
  191. - Apply [ 3599485 ] node source/line information for sphinx translation.
  192. * docutils/parsers/rst/directives/tables.py
  193. - Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
  194. * docutils/parsers/rst/states.py
  195. - Fix [ 157 ] Line block parsing doesn't like system message.
  196. - Always import our local copy of roman.py (report Larry Hastings).
  197. * docutils/transforms/references.py
  198. - Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
  199. * docutils/utils/__init__.py
  200. - Fix [ 3596884 ] exception importing ``docutils.io``.
  201. * docutils/writers/html4css1/__init__.py
  202. - Fix [ 3600051 ] for tables in a list, table cells are not compacted.
  203. - New setting `stylesheet_dirs`: Comma-separated list of directories
  204. where stylesheets are found. Used by `stylesheet_path` when expanding
  205. relative path arguments.
  206. - New default for math-output_: ``HTML math.css``.
  207. - Avoid repeated class declarations in html4css1 writer
  208. (modified version of patch [ 104 ]).
  209. .. _math-output: docs/user/config.html#math-output
  210. * docutils/writers/latex2e/__init__.py
  211. - Drop the simple algorithm replacing straight double quotes with
  212. English typographic ones.
  213. Activate the SmartQuotes_ transform if you want this feature.
  214. - Fix literal use of babel shorthands (straight quote, tilde, ...).
  215. - Fix [ 3603246 ] Bug in option "--graphicx-option=auto".
  216. - New setting `stylesheet_dirs`.
  217. .. _SmartQuotes: docs/user/config.html#smart-quotes
  218. * docutils/writers/manpage.py
  219. - Fix [3607063] handle lines starting with a period.
  220. - Fix option separating comma was bold (thanks to Bill Morris).
  221. Release 0.10 (2012-12-16)
  222. =========================
  223. * General
  224. - Dropped support for Python 2.3.
  225. - ``docutils/math``, ``docutils/error_reporting.py``, and
  226. ``docutils/urischemes.py`` moved to the utils package.
  227. - Fix [3541369] Relative __import__ also with Python 3.3.
  228. - Fix [3559988] and [3560841] __import__ local writer, reader, languages
  229. and parsers for Python 2.7 up.
  230. - Fix import of PIL.Image.
  231. - Change default of "syntax highlight" option to "long",
  232. basic syntax highlight styles for LaTeX and HTML.
  233. * docutils/io.py
  234. - FileInput/FileOutput: no system-exit on IOError. The `handle_io_errors`
  235. option is ignored and will be removed in a future release.
  236. - Fix Py3k error writing to stdout with encoding differing from default.
  237. - Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
  238. * docutils/parsers/rst/directives/misc.py
  239. - Fix [ 3546533 ] Unicode error with `date` directive.
  240. * docutils/transforms/universal.py
  241. - SmartQuotes transform for typographic quotes and dashes.
  242. * docutils/utils/__init__.py
  243. - normalize_language_tag() now returns `BCP 47`_ conformant tags
  244. with subtags separated by ``-``.
  245. * docutils/writers/html4css1/__init__.py
  246. - Use ``<code>`` tag for inline "code",
  247. do not drop nested inline nodes (syntax highlight tokens).
  248. - Customizable MathJax URL (based on patch by Dmitry Shachnev).
  249. - No line break after opening inline math tag.
  250. * docutils/writers/manpage.py
  251. - Apply [ 3527401 ] addmonition's don't preserve indentation
  252. - Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
  253. * docutils/writers/xetex/__init__.py
  254. - Apply [ 3555160 ] ensure order of "otherlanguages".
  255. - Fix section numbering by LaTeX.
  256. * docutils/writers/s5_html/__init__.py
  257. - Fix [ 3556388 ] Mathjax does not work with rst2s5.
  258. * docutils/writers/s5_html/docutils_xml.py
  259. - Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
  260. - Fix/improve output with ``--indent`` option.
  261. * setup.py
  262. - Tag ``math.css`` stylesheet as data file (patch by Dmitry Shachnev).
  263. * tools/test/test_buildhtml.py
  264. - Fix [ 3521167 ] allow running in any directory.
  265. - Fix [ 3521168 ] allow running with Python 3.
  266. Release 0.9.1 (2012-06-17)
  267. ==========================
  268. * setup.py
  269. - Fix [ 3527842 ]. Under Python 3, converted tests and tools were
  270. installed in the PYTHONPATH. Converted tests are now
  271. stored in ``test3/``, tools no longer need conversion.
  272. If you installed one of Docutils versions 0.7 ... 0.9 with
  273. ``setup.py install`` under Python 3, remove the spurious
  274. ``test/`` and ``tools/`` directories in the site library root.
  275. * test/
  276. - Make tests independent from the location of the ``test/`` directory.
  277. - Use converted sources (from the ``build/`` directory) for tests under
  278. Python 3.
  279. * tools/
  280. - Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
  281. * docutils/io.py
  282. - Fix writing binary data to sys.stdout under Python 3 (allows
  283. ``rst2odt.py`` to be used with output redirection).
  284. * docutils/parsers/rst/directives/misc.py
  285. - Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
  286. ``locale == C`` and 8-bit char in path argument of `include` directive.
  287. * test/alltests.py
  288. - class `Tee`: catch UnicodeError when writing to "ascii" stream or
  289. file under Python 3.
  290. Release 0.9 (2012-05-02)
  291. ========================
  292. * General:
  293. - New reStructuredText "code" role and directive and "code" option
  294. of the "include" directive with syntax highlighting by Pygments_.
  295. - Fix parse_option_marker for option arguments containing ``=``.
  296. - Fix [ 2993756 ]: import Python Imaging Library's Image module
  297. via ``import PIL`` as starting with PIL 1.2,
  298. "PIL lives in the PIL namespace only" (announcement__).
  299. .. _Pygments: http://pygments.org/
  300. __ http://mail.python.org/pipermail/image-sig/2011-January/006650.html
  301. * setup.py
  302. - Fix [ 2971827 ] and [ 3442827 ]
  303. extras/roman.py moved to docutils/utils/roman.py
  304. * docutils/frontend.py
  305. - Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
  306. * docutils/io.py
  307. - Fix [ 3395948 ] (Work around encoding problems in Py3k).
  308. - `mode` argument for FileOutput avoids code replication in
  309. BinaryFileOutput.
  310. - New exceptions InputError and OutputError for IO errors in
  311. FileInput/FileOutput.
  312. * docutils/core.py:
  313. - No "hard" system exit on file IO errors: catch and report them in
  314. `Publisher.reportException` instead. Allows handling by a calling
  315. application if the configuration setting `traceback` is True.
  316. * docutils/utils.py -> docutils/utils/__init__.py
  317. - docutils.utils is now a package (providing a place for sub-modules)
  318. .. note:: docutils/math, docutils/error_reporting.py, and
  319. docutils/urischemes.py will move to the utils package in the next
  320. release, too. See RELEASE-NOTES__
  321. __ RELEASE-NOTES.html
  322. - DependencyList uses io.FileOutput and 'utf8' encoding to prevent
  323. errors recording non-ASCII filenames (fixes [ 3434355 ]).
  324. - Fix relative_path() with source=None and `unicode` target.
  325. * docutils/parsers/rst/states.py
  326. - Fix [ 3402314 ] allow non-ASCII whitespace, punctuation
  327. characters and "international" quotes around inline markup.
  328. - Use `field_marker` pattern to look for start of a
  329. directive option block (fixes [ 3484857 ]).
  330. * docutils/parsers/rst/tableparser.py
  331. - Fix [ 2926161 ] for simple tables.
  332. (Combining chars in grid tables still contribute to cell width.)
  333. * docutils/writers/latex2e/__init__.py
  334. - Support the `abbreviation` and `acronym` standard roles.
  335. - Record only files required to generate the LaTeX source as dependencies.
  336. - Fix handling of missing stylesheets.
  337. - Use ``\setcounter{secnumdepth}{0}`` instead of ``*``-versions
  338. when suppressing LaTeX section numbering.
  339. - Use ``\DUtitle`` for unsupported section levels
  340. - Apply [ 3512791 ] do not compare string literals with "is"
  341. * docutils/writers/xetex/__init__.py
  342. - Avoid code duplication with latex2e writer (solves [ 3512728 ]).
  343. * docutils/writers/html4css1/__init__.py
  344. - Change default for `math-output` setting to MathJax.
  345. - Fix handling of missing stylesheets.
  346. * docutils/writers/docutils_xml.py
  347. - Use the visitor pattern with default_visit()/default_depart() methods
  348. instead of minidom to facilitate special handling of selected nodes.
  349. - Support raw XML (inserted as-is inside a <raw></raw> node).
  350. * docutils/writers/manpage.py
  351. - Do not emit comment line with trailing blank. Problematic for VCS.
  352. Release 0.8.1 (2011-08-30)
  353. ==========================
  354. * General:
  355. - Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause)
  356. and [ 3395920 ] (correct copyright info for rst.el).
  357. * test/
  358. - Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
  359. * docutils/writers/latex2e/__init__.py
  360. - Clean up Babel language setting. Restores Sphinx compatibility.
  361. Release 0.8 (2011-07-07)
  362. ========================
  363. * General:
  364. - Handle language codes according to `BCP 47`_.
  365. - If the specified language is not supported by Docutils,
  366. warn and fall back to English.
  367. - Math support: reStructuredText "math" role and directive,
  368. ``math`` and ``math_block`` doctree elements.
  369. - Decode command line arguments with the locale's preferred encoding
  370. (to allow, e.g., ``--title=Dornröschen``).
  371. - Orphaned "python" reader and "newlatex2e" writer moved to the sandbox.
  372. - New sub-module `error_reporting`: handle encoding/decoding errors
  373. when reporting exceptions.
  374. - Some additions to the Docutils core are released under the 2-Clause BSD
  375. license, see COPYING_ for details.
  376. .. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
  377. .. _COPYING: COPYING.html
  378. * reStructuredText:
  379. - Most directives now support a "name" option that attaches a
  380. reference name.
  381. - Directive content may start on the first line also when the directive
  382. type accepts options.
  383. * docs/dev/policies.txt:
  384. - Recommend the 2-Clause BSD license
  385. (http://www.spdx.org/licenses/BSD-2-Clause)
  386. for code that is kept under the author's copyright.
  387. * tools/buildhtml.py:
  388. - Fix ``--local`` switch.
  389. * Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
  390. * docutils/writers/html4css1/__init__.py
  391. - Set "lang" argument for objects with class argument
  392. "language-<language tag>".
  393. - New setting "math-output" with support for HTML, MathML, and LaTeX.
  394. * docutils/writers/latex2e/__init__.py
  395. - Fix [ 3043986 ] AttributeError using :local: with table of content.
  396. - Place title data in the document preamble.
  397. - Load `babel` package only if required.
  398. - Update list of supported languages.
  399. - New config setting "hyperref-options".
  400. No hard-coded "unicode" hyperref option (clash with xetex).
  401. - Set language for custom roles, paragraphs, block-quotes, and
  402. line-quotes with class argument "language-<language tag>".
  403. - Fix [ 3095603 ] wrong quotes output for russian and other languages.
  404. - Convert image URI to a local file path.
  405. - Apply [ 3148141 ] fix multicolumn support when a colspanning cell
  406. has more than one paragraph (Wolfgang Scherer).
  407. - \leavevmode before longtable only when needed (prevents spurious vspace)
  408. - do not advance table counter for tables without caption
  409. * docutils/writers/xetex/__init__.py
  410. - New writer generating LaTeX code for compiling with ``xelatex``.
  411. A separate writer (inheriting from latex2e) instead of a ``--xetex``
  412. option allows separate config options for XeTeX vs. LaTeX2e.
  413. * docutils/writers/manpage.py
  414. - Fix: BUG#3219183 - vertical space in definition lists containing markup.
  415. - Fix: vertical space cleaning for option group ``.``.
  416. * tools/editors/emacs/rst.el:
  417. - Fix [ 3001100 ] does not handle spaces in filenames
  418. (thanks to Jakub Wilk)
  419. * docutils/utils.py:
  420. - strip whitespace from stylesheet arguments
  421. - exclude combining chars from column_width()
  422. (partial fix for [ 2926161 ])
  423. * docutils/parsers/rst/directives/misc.py:
  424. - Fix [ 1830389 ] Replace not breaking on getting system_messages from
  425. nested_parse
  426. * docutils/io.py:
  427. - Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
  428. ``Exception ValueError: 'I/O operation on closed file.'`` with Python 3.
  429. Release 0.7 (2010-07-07)
  430. ========================
  431. * General:
  432. - Fix [ 2881769 ] setup configuration.
  433. - Fix [ 2788716 ] reporting problems in included files.
  434. * docutils/io.py
  435. - FileInput opens files as text files with universal newline support
  436. (mode "rU", configurable with the new optional argument "mode").
  437. * docutils/nodes.py
  438. - Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
  439. * docutils/utils.py
  440. - Fix [ 2923723 ] let decode_path() tolerate path == None
  441. * docutils/writers/html4css1/__init__.py
  442. - Support SVG and SWF images (thanks to Stefan Rank).
  443. - Generate valid XHTML for centered images with targets.
  444. Use CSS classes instead of "align" tags for image alignment.
  445. * docutils/writers/latex2e/__init__.py
  446. - Use `transforms.writer_aux.Admonitions` to "normalize" special
  447. admonitions.
  448. - Use the ``\url`` command for URLs (breaks long URLs instead of
  449. writing into the margin).
  450. - Preserve runs of spaces in `inline literals`__.
  451. - Deprecate ``figure_footnotes`` setting.
  452. - Rename ``use_latex_footnotes`` setting to `docutils_footnotes`__.
  453. - New ``latex_preamble`` setting.
  454. - Use PDF standard fonts (Times/Helvetica/Courier) as default.
  455. - Fix hyperlink targets (labels) for images, figures, and tables.
  456. - Apply [ 2961988 ] Load babel after inputenc and fontenc.
  457. - Apply [ 2961991 ] Call hyperref with unicode option.
  458. - Drop the special `output_encoding`__ default ("latin-1").
  459. The Docutils wide default (usually "UTF-8") is used instead.
  460. - Render inline markup in document title and subtitle.
  461. - Fix numbering depth with LaTeX section numbering.
  462. - Update Unicode -> LaTeX translations.
  463. - Fix bug with topic directive (thanks to Alan G Isaac for reporting).
  464. __ docs/ref/restructuredtext.html#inline-literals
  465. __ docs/user/config.html#docutils-footnotes
  466. __ docs/user/config.html#output_encoding
  467. * docutils/writers/manpage.py
  468. - Fix: supported attribute (thanks to peter2108).
  469. - Remove trailing blanks in code (keep in sync with mercurial version).
  470. - Titles level 1, that is ``.SH``, always uppercase.
  471. - Apply patch from mg: literal text should be bold in man-pages.
  472. * docutils/nodes.py
  473. - Fix: encoding ``'ascii'`` must be lowercase to prevent problems for
  474. turkish locale.
  475. * setup.py:
  476. - Python 3 support: copy test/ and tools/ to the build-dir
  477. and convert Python sources with 2to3.
  478. Release 0.6 (2009-10-11)
  479. ========================
  480. * General:
  481. - Docutils is now compatible with Python versions from 2.3 up to 2.6
  482. and convertible to 3.1 code.
  483. + Node.__nonzero__ returns True instead of 1.
  484. + use os.walk instead os.path.walk.
  485. + minimize "types" module where possible.
  486. + Backwards-compatible changes to remove python2.6 -3 deprecation warnings
  487. + Text nodes now subclass unicode rather than UserString
  488. (which is gone in python 3.0).
  489. + 3.0 compatibility module docutils._compat
  490. + Drop 2.2 compatibility workarounds.
  491. + Drop extras/optparse.py and extras/textwrap.py
  492. (stdlib modules since 2.3).
  493. - OpenOffice export: ODT writer moved from sandbox to Doctutils core.
  494. - Unix man page export: manpage writer moved from sandbox to Doctutils
  495. core.
  496. - Apply [ 1719345 ] Galician translation
  497. - Apply [ 1905741 ] Polish translation
  498. - Apply [ 1878977 ] make_id(): deaccent characters.
  499. - Apply [ 2029251 ] return nonzero when tests fail.
  500. - Fix [ 1692788 ] allow UTF-8 in style sheets.
  501. - Fix [ 2781629 ] support non-ASCII chars in file names.
  502. - Apply [ 2845002 ] let ``--no-raw`` disable raw *roles* too.
  503. - Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
  504. - Fix [ 2821266 ] --strict option works now like --halt=info.
  505. - Fix [ 2788716 ] DirectiveError now correctly reports source and line.
  506. - Fix [ 1627229 ] hyperlink references in substitutions.
  507. - The "newlatex" writer is orphaned.
  508. * reStructuredText:
  509. - Documented Unicode characters allowed as inline markup openers,
  510. closers, and delimiters.
  511. - Allow units for all length specifications.
  512. - Allow percent sign in "scale" argument of "figure" and "image" directives.
  513. - Bugfix: The "figalign" argument of a figure now works as intended
  514. (aligning the figure, not its contents).
  515. - Align images with class "align-[right|center|left]"
  516. (allows setting the alignment of an image in a figure).
  517. * docutils/nodes.py:
  518. - Added ``Element.__contains__`` method, for the in-operator.
  519. * docutils/parsers/rst/states.py:
  520. - Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
  521. - Added support for Unicode inline markup delimiters "‐ ‑ ‒ – —" and
  522. " " (non-breaking space), and "¡ ¿" openers.
  523. * docutils/parsers/directives/misc.py:
  524. - Added ``start-line`` and ``end-line`` options to "include"
  525. directive to select a range of lines.
  526. - Hard tabs in literal inclusions are replaced by spaces. This is
  527. configurable via the new ``tab-width`` option of the "include" directive
  528. (a negative tab-width prevents tab expansion).
  529. * docutils/utils.py:
  530. - Add ``get_stylesheet_list`` function.
  531. - Apply [ 2834836 ] print info at halt
  532. * docutils/transforms/universal.py:
  533. - Raise default priority of StripClasses to exclude stripped classes from
  534. the ToC.
  535. * docutils/writers/html4css1/__init__.py:
  536. - ``--stylesheet`` and ``--stylesheet-path`` options support a comma
  537. separated list of stylesheets.
  538. - Address [ 1938891 ] Inline literal text creates "pre" span only when
  539. needed to prevent inter-word line wraps.
  540. - Use `translate` method instead of repeated `replace` calls.
  541. - Fix [ 1757105 ] New ``table-style`` option. Added to standard table
  542. classes to allow CSS styling that does not interfere with other
  543. table-using constructs (field lists, citations, ...).
  544. * docutils/writers/newlatex2e/__init__.py:
  545. - Apply [ 1612821 ] Double quotes in literal text in Italian/German
  546. * docutils/writers/latex2e/__init__.py (see also
  547. `<docs/user/docutils-05-compat.sty.html>`__) :
  548. - Add ``--embed-stylesheet`` option.
  549. - Apply [ 1474017 ] image vertical alignment is reversed.
  550. - Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
  551. - Change: has_key for dictionaries (not Nodes) to in-operator.
  552. - Merge adjacent citations into one latex cite command.
  553. - Failsave implementation of custom roles. LaTeX compilation now ignores
  554. unknown classes instead of aborting with an error.
  555. - Support custom roles based on standard roles.
  556. - LaTeX packages can be used as ``--stylesheet`` arguments without
  557. restriction. (A style sheet is now referenced with the ``\usepackage``
  558. command, if it ends with ``.sty`` or has no extension.)
  559. - Add ``bp`` to lenghts without unit (prevents LaTex errors).
  560. - Correctly write length unit ``pt`` as ``bp`` in LaTeX.
  561. - Do not convert ``px`` to ``pt`` (``px`` is supported by pdfTeX since
  562. 2005-02-04 as a configurable length unit).
  563. - Do not use fontenc, nor the obsolete 'ae' and 'aeguill' packages
  564. if font-encoding is set to ''. LaTeX defaults to OT1 then.
  565. - Set sub- and superscript role argument in text mode not as math.
  566. Use a custom role based on sub-/superscript if you want italic shape.
  567. - Shorter preamble and less dependencies: Load packages and define macros
  568. only if required in the document.
  569. - Use the name prefix ``DU`` for all Docutils specific LaTeX macros.
  570. - New custom environments and commands with optional "classes" argument.
  571. - Simpler LaTeX encoding, e.g. "\%" instead of "{\%}".
  572. - Better conformance to Docutils specifications with ``--use-latex-toc``.
  573. Support for LaTeX generated ToC also with unnumbered sections.
  574. - If 'sectnum_xform' is False, the 'sectnum' directive triggers
  575. section numbering by LaTeX.
  576. - Use default font in admonitions and sidebar.
  577. - Align of image in a figure defaults to 'center'.
  578. - Bugfix: Newlines around targets and references prevent run-together
  579. paragraphs.
  580. - Fix internal hyperlinks.
  581. - Use class defaults for page margins ('typearea' now optional).
  582. - Float placement made configurable, default changed to "here definitely".
  583. - Typeset generic topic as "quote block with title".
  584. - Use template (file and configuration option).
  585. - In the default template, load cmap.sty (fix text extraction in PDF) and
  586. fixltx2e.sty (LaTeX patches, \textsubscript).
  587. - Render doctest blocks as literal blocks (fixes [ 1586058 ]).
  588. - Use `translate` instead of repeated `replace` calls for text encoding.
  589. - Hyperlinked footnotes and support for symbol footnotes and
  590. ``--footnote-references=brackets`` with ``--use-latex-footnotes``.
  591. - Complete pairs of binary options
  592. (``--figure-footnotes, --figure-citations, --link-stylesheet``,
  593. ``--use-docutils-toc, --use-docutils-docinfo, --topic-abstract``)
  594. - New defaults:
  595. - font-encoding: "T1" (formerly implicitely set by 'ae').
  596. - use-latex-toc: true (ToC with page numbers).
  597. - use-latex-footnotes: true (no mixup with figures).
  598. * docutils/writers/manpage.py
  599. - Do not print version at document end, this is done by the viewer.
  600. - Do not print date at document end, this is done by the viewer.
  601. - Fix storage of docinfo fields for none standard fields.
  602. * docutils/tools/rst2man.py
  603. Release 0.5 (2008-06-25)
  604. ========================
  605. * docutils/languages/he.py: Added to project: Hebrew mappings by
  606. Meir Kriheli.
  607. * docutils/parsers/rst/languages/he.py: Added to project: Hebrew
  608. mappings by Meir Kriheli.
  609. * docutils/frontend.py:
  610. - Configuration files are now assumed and required to be
  611. UTF-8-encoded.
  612. - Paths of applied configuration files are now recorded in the
  613. runtime setting ``_config_files`` (accessible via
  614. ``--dump-settings``).
  615. - Added ``--strip-elements-with-class`` and ``--strip-class``
  616. options (``strip_elements_with_classes`` and ``strip_classes``
  617. settings).
  618. * docutils/io.py:
  619. - Added code to determine the input encoding from data: encoding
  620. declarations or the presence of byte order marks (UTF-8 & UTF-16).
  621. - Added support for IronPython 1.0.
  622. * docutils/nodes.py:
  623. - Added ``document.__getstate__`` method, for pickling.
  624. * docutils/parsers/rst/states.py:
  625. - Allow ``+`` and ``:`` in reference names.
  626. - Unquoted targets beginning with an underscore (``.. __target:
  627. URI``) are no longer accepted.
  628. - Added support for multiple attributions in a physical block quote
  629. (indented text block), dividing it into multiple logical block
  630. quotes.
  631. - Added support for unicode bullets in bullet lists: "•", "‣", and
  632. "⁃".
  633. - Added support for new object-oriented directive interface,
  634. retaining compatibility to the old functional interface.
  635. - Added support for throwing ``DirectiveError``'s from within
  636. directive code.
  637. * docutils/parsers/rst/__init__.py:
  638. - Added ``Directive`` base class.
  639. - Added ``DirectiveError`` base class.
  640. - Fixed ``file_insertion_enabled`` & ``raw_enabled`` setting
  641. definitions.
  642. * docutils/parsers/directives/:
  643. - Refactored all reStructuredText directives to use the new
  644. object-oriented directive interface. Errors are now (mostly)
  645. thrown using the new ``DirectiveError`` class.
  646. * docutils/parsers/directives/misc.py:
  647. - Added ``start-after`` and ``end-before`` options to ``include``
  648. directive; thanks to Stefan Rank.
  649. * docutils/transforms/universal.py:
  650. - Added ``StripClassesAndElements`` transform to remove from the
  651. document tree all elements with classes in
  652. ``settings.strip_elements_with_classes`` and all "classes"
  653. attribute values in ``self.document.settings.strip_classes``.
  654. * docutils/transforms/writer_aux.py:
  655. - Added ``Admonitions`` transform to transform specific admonitions
  656. (like ``note``, ``warning``, etc.) into generic admonitions with a
  657. localized title.
  658. * docutils/writers/html4css1/__init__.py:
  659. - Moved template functionality from the PEP/HTML writer here.
  660. - Expanded the fragments available in the ``parts`` attribute.
  661. - Moved ``id`` attributes from titles to surrounding ``div``
  662. elements.
  663. - Dropped all ``name`` attributes of ``a`` elements (``id`` is
  664. universally supported now).
  665. - ``template.txt`` is now opened in text mode instead of binary mode
  666. (to ensure Windows compatibility).
  667. - ``a`` elements now have an "internal" or "external" class,
  668. depending on reference type.
  669. * docutils/writers/html4css1/template.txt: Added to project.
  670. * docutils/writers/pep_html/:
  671. - Moved template functionality to the HTML writer.
  672. * docutils/writers/s5_html/__init__.py:
  673. - Added ``view_mode`` & ``hidden_controls`` settings
  674. (``--view-mode`` & ``--hidden-controls/--visible-controls``
  675. options).
  676. * docutils/writers/latex2e/__init__.py:
  677. - Add ``--literal-block-env``
  678. - Fix: escaping ``%`` in href urls.
  679. - Move usepackage hyperref after stylesheet inclusion.
  680. - Fix: scrartcl does not have chapter but scrreprt.
  681. - Add newline after ``\end{verbatim}``.
  682. - Merge smaller differences from latex2e_adaptive_preamble.
  683. - Add ``use-part-section``.
  684. - Put leavevmode before longtable to avoid having it moved before sub/pargraph.
  685. - Using leavemode option_list no longer needs to check if parent
  686. is a definition list.
  687. - Append ``\leavemode`` to definition list terms.
  688. - No longer write visit\_/depart_definition_list_item comments to
  689. output.
  690. - Table column width with 3 decimal places.
  691. - Add table stubs support (boldfont).
  692. - Add assemble_parts to writer.
  693. - Add simply support for nested tables.
  694. - Fix verbatim in tables if use-verbatim-when-possible.
  695. - Use section commands down to subparagraph.
  696. - Put ensuremath around some latin1 chars.
  697. - Set ``usepackage[utf8x]{inputenc}`` for utf-8.
  698. - New option ``--use-bibtex=style,db1,db2``.
  699. - New option ``--reference-label`` to allow usage of LaTeX ref for
  700. labels in section references.
  701. - Add a label after every section to support sectionnumbers as reference
  702. labels.
  703. - Fix: bug# 1605376 rst2latex: bad options group list
  704. - Remove inactive code for use_optionlist_for_option_list.
  705. - Remove latex comments from option_list output.
  706. - Fix: bug# 1612270 double qoutes in italian literal.
  707. - Fix: output ``hypertarget{ node.get(refid) }{}`` from visit_target.
  708. - Add option --use-latex-abstract.
  709. - Image width unit ``px`` is translated to ``pt``.
  710. - Add image height support.
  711. - Fix: image width ``70%`` is converted ``0.700\linewidth``.
  712. bug #1457388
  713. - Fix: Do not escape underscores in citation reference labels if
  714. use-latex-citations is set.
  715. - Use centering instead of center for figure contents, to avoid vertical
  716. space.
  717. - Recognize table class: borderless, nolines, booktabs, standard.
  718. - Fix: Renaming contents section does not work with latex writer; SF
  719. bug #1487405.
  720. - Applied patch for custom roles with classes from Edward Loper.
  721. - Fixed bug that caused crashes with more than 256 lists.
  722. * docutils/writers/pep_html/__init__.py:
  723. - Changed to support new python.org website structure and
  724. pep2pyramid.py.
  725. * docs/howto/security.txt: "Deploying Docutils Securely", added to
  726. project.
  727. * tools/buildhtml.py:
  728. -- Added ``ignore`` setting to exclude a list of shell patterns
  729. (default: ``.svn:CVS``).
  730. * tools/editors/emacs/rst.el:
  731. - Changed license to "GPL".
  732. - Added ``rst-straighten-decorations`` function.
  733. - The ``compile`` module is now always loaded.
  734. - Added ``rst-toggle-line-block`` function.
  735. - Headings consisting only of non-ASCII characters are now
  736. recognized by ``rst-toc`` and ``rst-adjust``.
  737. - Added font-lock support for multi-line comments where the first
  738. comment line is empty.
  739. - Added ``(require 'font-lock)``.
  740. * setup.py:
  741. - Provide descriptive error message if distutils is missing.
  742. Release 0.4 (2006-01-09)
  743. ========================
  744. * General:
  745. - Updated the project policies for trunk/branch development &
  746. version numbering.
  747. * docutils/__init__.py:
  748. - Added ``__version_details__`` attribute to describe code source
  749. (repository/snapshot/release).
  750. - Replaced ``default_transforms`` attribute of TransformSpec with
  751. ``get_transforms()`` method.
  752. * docutils/core.py:
  753. - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
  754. functions, for document tree extraction and reprocessing.
  755. * docutils/io.py:
  756. - Added ``DocTreeInput`` class, for reprocessing existing documents.
  757. - Added support for non-Unicode (e.g. binary) writer output.
  758. * docutils/nodes.py:
  759. - Re-introduced ``Targetable.indirect_reference_name``, for
  760. MoinMoin/reST compatibility (removed in r3124/r3129).
  761. - Added ``serial_escape`` function; escapes string values that are
  762. elements of a list, for serialization. Modified Docutils-XML
  763. writing (``Element._dom_node``) and pseudo-XML writing
  764. (``Element.starttag``) to use ``serial_escape``.
  765. - Added ``Node.deepcopy()`` method.
  766. - Removed the internal lists ``document.substitution_refs``,
  767. ``document.anonymous_refs``, and ``document.anonymous_targets``.
  768. - Added a "container" element.
  769. - Fixed bug where values of list-valued attributes of elements
  770. originating from custom interpreted text roles (i.e., with custom
  771. classes) were being shared between element instances. Reported by
  772. Shmuel Zeigerman.
  773. * docutils/statemachine.py:
  774. - Added trailing whitespace stripping to ``string2lines()``.
  775. - Added ``StringList.pad_double_width()`` & ``.replace()`` for East
  776. Asian double-width character support.
  777. * docutils/utils.py:
  778. - Added ``east_asian_column_width()`` for double-width character
  779. support.
  780. * docutils/languages/ja.py: Added to project: Japanese mappings by
  781. Hisashi Morita.
  782. * docutils/languages/zh_cn.py: Added to project: Simplified Chinese
  783. mappings by Panjunyong.
  784. * docutils/parsers/null.py: Added to project; a do-nothing parser.
  785. * docutils/parsers/rst/__init__.py:
  786. - Added validator to tab_width setting, with test. Closes SF bug
  787. #1212515, report from Wu Wei.
  788. * docutils/parsers/rst/states.py:
  789. - Fixed bug with escaped colons indicating a literal block.
  790. - Fixed bug with enumerated lists (SF#1254145).
  791. - Backslash-escaped colons inside of field names are now allowed.
  792. - Targets (implicit and explicit), anonymous hyperlink references
  793. and auto-numbered footnote references inside of substitution
  794. definitions are now disallowed.
  795. - Fixed bug: list items with blank first lines.
  796. - Fixed bug: block quote attributions with indented second lines.
  797. - Added East Asian double-width character support (Python 2.4 only).
  798. * docutils/parsers/rst/tableparser.py:
  799. - Added East Asian double-width character support (Python 2.4 only).
  800. * docutils/parsers/rst/directives/body.py:
  801. - Added the "container" directive.
  802. * docutils/parsers/rst/directives/misc.py:
  803. - Added the "default-role", "title", and "date" directives.
  804. - Added standard data file syntax to the "include" directive.
  805. - Added support for "class" directive content.
  806. * docutils/parsers/rst/directives/images.py:
  807. - Added ``indirect_reference_name`` support for images with a target
  808. option.
  809. - Added support for image width and height units.
  810. - Fixed bug with image "target" options.
  811. * docutils/parsers/rst/directives/references.py:
  812. - Added "class" attribute to "target-notes" directive, for
  813. footnote_reference classes.
  814. * docutils/parsers/rst/include/: Directory added to project; contains
  815. standard data files for the "include" directive. Initial contents:
  816. character entity substitution definition sets, and a set of
  817. definitions for S5/HTML presentations.
  818. * docutils/parsers/rst/languages/ja.py: Added to project: Japanese
  819. mappings by David Goodger.
  820. * docutils/parsers/rst/languages/zh_cn.py: Added to project:
  821. Simplified Chinese mappings by Panjunyong.
  822. * docutils/readers/__init__.py:
  823. - Added universal.Decorations and universal.ExposeInternals
  824. transforms as default transforms for all readers.
  825. - Added ``ReReader`` base class for readers that reread an existing
  826. document tree.
  827. * docutils/readers/doctree.py: Added to project; a reader for existing
  828. document trees.
  829. * docutils/transforms/frontmatter.py:
  830. - Fixed the DocInfo transform to handle SVN-style expansion of the
  831. "Date" keyword.
  832. - In ``DocInfo.extract_authors``, treat the contents of "authors"
  833. fields uniformly.
  834. * docutils/transforms/misc.py:
  835. - Added misc.Transitions transform, extracted from
  836. universal.FinalChecks.
  837. * docutils/transforms/references.py:
  838. - Added references.DanglingReferences transform, extracted from
  839. universal.FinalChecks.
  840. - Fixed bug with doubly-indirect substitutions.
  841. - Added footnote_reference classes attribute to "TargetNotes".
  842. - Fixed bug with circular substitution definitions that put Docutils
  843. into an infinite loop.
  844. * docutils/transforms/universal.py:
  845. - Added universal.ExposeInternals transform, extracted from
  846. universal.FinalChecks.
  847. - Removed universal.FinalChecks transform (logic has been moved to
  848. several new transforms).
  849. - Fixed bug with the "expose_internals" setting and Text nodes
  850. (exposed by the "rawsource" internal attribute).
  851. - Added the universal.StripComments transform, implementation of the
  852. "strip_comments" setting.
  853. * docutils/transforms/writer_aux.py: Added to project; auxiliary
  854. transforms for writers.
  855. - Added ``Compound`` transform, which flattens compound paragraphs.
  856. * docutils/writers/: Several writer modules (html4css1.py) were
  857. converted into packages. Support modules and data files have been
  858. moved into the packages. The stylesheets for the HTML writers are
  859. now installed along with the code, the code knows where to find
  860. them, and the default is to use them (actually, to embed them).
  861. Some adjustments to configuration files may be necessary. The
  862. easiest way to obtain the new default behavior is to remove all
  863. settings whose name includes "stylesheet".
  864. * docutils/writers/__init__.py:
  865. - Added universal.Messages and universal.FilterMessages transforms
  866. as default transforms for all writers.
  867. - Added ``UnfilteredWriter`` base class for writers that pass the
  868. document tree on unchanged.
  869. * docutils/writers/docutils_xml.py:
  870. - Made ``xmlcharrefreplace`` the default output encoding error
  871. handler.
  872. * docutils/writers/html4css1/:
  873. - Added support for image width and height units.
  874. - Made ``xmlcharrefreplace`` the default output encoding error
  875. handler.
  876. - Made ``--embed-stylesheet`` the default rather than
  877. ``--link-stylesheet``.
  878. - Moved "id" attribute from container (section etc.) to title's <a>
  879. tag, to be on the same tag as "name".
  880. (!!! To be reverted in Docutils 0.5.)
  881. - Added vertical space between fields of field lists.
  882. - Added ``--compact-field-lists`` option to remove vertical space in
  883. simple field lists.
  884. - Made cloaking of email addresses with ``--cloak-email-addresses``
  885. less obtrusive.
  886. - Fixed support for centered images.
  887. - Added support for class="compact" & class="open" lists.
  888. * docutils/writers/latex2e/:
  889. - Underscores in citekeys are no longer escaped.
  890. * docutils/writers/newlatex2e/unicode_map.py: Added to project;
  891. mapping of Unicode characters to LaTeX equivalents.
  892. * docutils/writers/s5_html/: Package added to project; writer for
  893. S5/HTML slide shows.
  894. * docs/dev/distributing.txt: Added to project; guide for distributors
  895. (package maintainers).
  896. * docs/dev/hacking.txt: Added to project; guide for developers.
  897. * docs/ref/doctree.txt:
  898. - Updated for plural attributes "classes", "ids", "names",
  899. "dupnames".
  900. - Added the "container" element.
  901. * docs/ref/docutils.dtd:
  902. - Updated for plural attributes "classes", "ids", "names",
  903. "dupnames".
  904. * docs/user/emacs.txt: Added to project; a document about Emacs
  905. support for reStructuredText and Docutils.
  906. * docs/user/links.txt: Added to project; lists of Docutils-related
  907. links.
  908. * docs/user/mailing-lists.txt: Added to project; information about
  909. Docutils-related mailing lists and how to access them.
  910. * docs/user/slide-shows.txt: Added to project; example of and docs for
  911. the S5/HTML writer (``rst2s5.py`` front end).
  912. * docs/ref/rst/definitions.txt: "reStructuredText Standard Definition
  913. Files", added to project.
  914. * test/coverage.sh: Added to project; test coverage script.
  915. * test/DocutilsTestSupport.py:
  916. - Added support for specifying runtime settings at the suite level.
  917. * test/test_functional.py:
  918. - Added the ``clear_output_directory`` function.
  919. - Added support for ``_test_more`` functions in functional test
  920. config files.
  921. * tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
  922. * tools/rstpep2html.py: Renamed from pep.py.
  923. * tools/dev/create_unimap.py: Added to project; script to create the
  924. docutils/writers/unimap_latex.py mapping file.
  925. * tools/dev/profile_docutils.py: Added to project; profiler script.
  926. * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
  927. * tools/editors/emacs/restructuredtext.el,
  928. tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el:
  929. Removed from project; the functionality is now contained in rst.el.
  930. * tools/editors/emacs/rst.el: Added to project. Added many features
  931. and fixed many bugs. See docs/user/emacs.txt for details.
  932. * tools/stylesheets: Removed from project. Stylesheets have been
  933. renamed and moved into writer packages.
  934. Release 0.3.9 (2005-05-26)
  935. ==========================
  936. * General:
  937. - Eliminated and replaced all uses of the old string attributes
  938. ``id``, ``name``, ``dupname`` and ``class`` with references to the
  939. new list attributes ``ids``, ``names``, ``dupnames`` and
  940. ``classes`` throughout the whole source tree.
  941. * docutils/core.py:
  942. - Enabled ``--dump-*`` options when ``--traceback`` specified,
  943. allowing for easier debugging.
  944. - In ``Publisher.publish()``, expanded the generic top-level
  945. exception catching.
  946. * docutils/examples.py:
  947. - Added ``internals`` function for exploration.
  948. * docutils/io.py:
  949. - Fixed ``Input.decode`` method to apply heuristics only if no
  950. encoding is explicitly given, and to provide better reporting of
  951. decoding errors.
  952. - The ``Input.decode`` method now removes byte order marks (BOMs)
  953. from input streams.
  954. * docutils/nodes.py:
  955. - ``image`` element class changed to subclass of Element, not
  956. TextElement (it's an empty element, and cannot contain text).
  957. - Added ``attr_defaults`` dictionary for default attribute values.
  958. - Added empty list as default value for the following attributes:
  959. ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
  960. - Added ``document.decoration`` attribute,
  961. ``document.get_decoration`` method, and ``decoration.get_header``
  962. & ``.get_footer`` methods.
  963. - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
  964. methods.
  965. * docutils/utils.py:
  966. - Removed ``docutils.utils.Reporter.categories``,
  967. ``docutils.utils.ConditionSet``, and all references to them, to
  968. simplify error reporting.
  969. * docutils/languages/nl.py: Added to project; Dutch mappings by
  970. Martijn Pieters.
  971. * docutils/parsers/rst/__init__.py:
  972. - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
  973. * docutils/parsers/rst/states.py:
  974. - Added check for escaped at-mark to prevent email address recognition.
  975. - Fixed option lists to allow spaces inside ``<angle-bracketed option
  976. arguments>``.
  977. - Allowed whitespace in paths and URLs.
  978. - Added auto-enumerated list items.
  979. - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
  980. followed by text.
  981. - Added support for table stub columns.
  982. * docutils/parsers/rst/directives/__init__.py:
  983. - Allowed whitespace in paths (``path`` function).
  984. - Added ``uri`` directive option conversion function.
  985. * docutils/parsers/rst/directives/body.py:
  986. - Fixed illegal context bug with "topic" directive (allowed within
  987. sidebars; not within body elements).
  988. * docutils/parsers/rst/directives/images.py:
  989. - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
  990. - Added support for the ``file_insertion_enabled`` setting in the
  991. "figure" directive (disables "figwidth" option).
  992. - "image" directive: added checks for valid values of "align" option,
  993. depending on context. "figure" directive: added specialized
  994. "align" option and attribute on "figure" element.
  995. - Made ":figwidth: image" option of "figure" directive work again.
  996. - Fixed bug with reference names containing uppercase letters
  997. (e.g. ``Name_``) in "target" option of "image" directive.
  998. * docutils/parsers/rst/directives/misc.py:
  999. - Fixed "include" and "raw" directives to catch text decoding
  1000. errors.
  1001. - Allowed whitespace in "include" & "raw" directive paths.
  1002. - Added support for ``file_insertion_enabled`` & ``raw_enabled``
  1003. settings in "include" & "raw" directives.
  1004. * docutils/parsers/rst/directives/parts.py:
  1005. - Added "header" & "footer" directives.
  1006. - Fixed illegal context bug with "contents" directive (topics
  1007. allowed within sidebars; not within body elements).
  1008. * docutils/parsers/rst/directives/tables.py:
  1009. - Added "list-table" directive.
  1010. - Caught empty CSV table bug.
  1011. - Added support for the ``file_insertion_enabled`` setting in the
  1012. "csv-table" directive.
  1013. - Added ``stub-columns`` option to "csv-table" and "list-table"
  1014. directives.
  1015. * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
  1016. mappings by Martijn Pieters.
  1017. * docutils/readers/standalone.py:
  1018. - Added ``--section-subtitles`` and ``--no-section-subtitles``
  1019. options to activate or deactivate the SectSubTitle transform.
  1020. * docutils/transforms/frontmatter.py:
  1021. - Added SectSubTitle transform to promote titles of lone
  1022. subsections to subtitles.
  1023. * docutils/transforms/references.py:
  1024. - Fixed mislocated internal targets bug, by propagating internal
  1025. targets to the next node, making use of the newly added support
  1026. for multiple names and IDs.
  1027. - Fixed duplicate footnote label bug.
  1028. - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
  1029. transform.
  1030. * docutils/writers/html4css1.py:
  1031. - Fixed unencoded stylesheet reference bug (characters like "&" in
  1032. stylesheet references).
  1033. - ``target`` nodes now appear as ``span`` tags (instead of ``a``
  1034. tags).
  1035. - Added support for multiple IDs per node by creating empty ``span``
  1036. tags.
  1037. - Added the ``field_name_limit`` & ``option_limit`` settings &
  1038. support.
  1039. - Added support for table stub columns.
  1040. - Added support for the ``align`` attribute on ``figure`` elements.
  1041. - Added the ``cloak_email_addresses`` setting & support.
  1042. - Added ``html_prolog``, ``html_head``, ``html_body``,
  1043. ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
  1044. ``docutils.core.publish_parts``.
  1045. - Added support for section subtitles.
  1046. * docutils/writers/latex2e.py:
  1047. - Fixed tables starting with more than one multirow cell.
  1048. - Improved --use-latex-docinfo so that organization/contact/address
  1049. fields are lumped with the last author field and appear on the
  1050. titlepage.
  1051. - Made sure the titlepage is always shown with --use-latex-docinfo,
  1052. even if the document has no title.
  1053. - Made sure that latex doesn't fill in today's date if no date field
  1054. was given.
  1055. - Added support for section subtitles.
  1056. * docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer
  1057. (under development).
  1058. * docutils/writers/null.py: Added to project; a do-nothing Writer.
  1059. * docs/api/publisher.txt:
  1060. - Added "``publish_parts`` Details" section.
  1061. * docutils/dev/repository.txt: Added to project; information about the
  1062. Docutils Subversion repository.
  1063. * docs/ref/docutils.dtd:
  1064. - Added a ``stub`` attribute to the ``colspec`` element via the
  1065. ``tbl.colspec.att`` parameter entity.
  1066. - Allowed topic elements within sidebars
  1067. - Added an ``align`` attribute to the ``figure`` element.
  1068. * tools/rst2newlatex.py: Added to project; front end for the new LaTeX
  1069. writer.
  1070. Release 0.3.7 (2004-12-24)
  1071. ==========================
  1072. * docutils/frontend.py:
  1073. - Added options: --input-encoding-error-handler,
  1074. --record-dependencies, --leave-footnote-reference-space,
  1075. --strict-visitor.
  1076. - Added command-line and config file support for "overrides" setting
  1077. parameter.
  1078. * docutils/io.py:
  1079. - Added support for input encoding error handler.
  1080. * docutils/nodes.py:
  1081. - Added dispatch_visit and dispatch_departure methods to
  1082. NodeVisitor; useful as a hook for Visitors.
  1083. - Changed structure of ``line_block``; added ``line``.
  1084. - Added ``compound`` node class.
  1085. - Added a mechanism for Visitors to transitionally ignore new node
  1086. classes.
  1087. * docutils/utils.py:
  1088. - Moved ``escape2null`` and ``unescape`` functions from
  1089. docutils/parsers/rst/states.py.
  1090. * docutils/parsers/rst/roles.py:
  1091. - Added "raw" role.
  1092. - Changed role function API: the "text" parameter now takes
  1093. null-escaped interpreted text content.
  1094. * docutils/parsers/rst/states.py:
  1095. - Fixed bug where a "role" directive in a nested parse would crash
  1096. the parser; the state machine's "language" attribute was not being
  1097. copied over.
  1098. - Added support for line block syntax.
  1099. - Fixed directive parsing bug: argument-less directives didn't
  1100. notice that arguments were present.
  1101. - Removed error checking for transitions.
  1102. - Added support for multiple classifiers in definition list items.
  1103. - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
  1104. - Changed role function API: the "text" parameter now takes
  1105. null-escaped interpreted text content.
  1106. - Empty sections and documents are allowed now.
  1107. * docutils/parsers/rst/directives/__init__.py:
  1108. - Added ``encoding`` directive option conversion function.
  1109. - Allow multiple class names in class_option conversion function.
  1110. * docutils/parsers/rst/directives/body.py:
  1111. - Converted the line-block directive to use the new structure.
  1112. - Extracted the old line-block functionality to the ``block``
  1113. function (still used).
  1114. - Added ``compound`` directive (thanks to Lea Wiemann).
  1115. * docutils/parsers/rst/directives/misc.py:
  1116. - Added "encoding" option to "include" and "raw" directives.
  1117. - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
  1118. - Allow multiple class names in the "class" directive.
  1119. * docutils/parsers/rst/directives/parts.py:
  1120. - Directive "sectnum" now accepts "prefix", "suffix", and "start"
  1121. options. Thanks to Lele Gaifax.
  1122. * docutils/parsers/rst/directives/tables.py:
  1123. - Added "encoding" directive to "csv-table" directive.
  1124. - Added workaround for lack of Unicode support in csv.py, for
  1125. non-ASCII CSV input.
  1126. * docutils/transforms/misc.py:
  1127. - Fixed bug when multiple "class" directives are applied to a single
  1128. element.
  1129. - Enabled multiple format names for "raw" directive.
  1130. * docutils/transforms/references.py:
  1131. - Added support for trimming whitespace from beside substitution
  1132. references.
  1133. * docutils/transforms/universal.py:
  1134. - FinalChecks now checks for illegal transitions and moves
  1135. transitions between sections.
  1136. * docutils/writers/html4css1.py:
  1137. - HTMLTranslator.encode now converts U+00A0 to "&nbsp;".
  1138. - "stylesheet" and "stylesheet_path" settings are now mutually
  1139. exclusive.
  1140. - Added support for the new line_block/line structure.
  1141. - --footnote-references now overrides
  1142. --trim-footnote-reference-space, if applicable.
  1143. - Added support for ``compound`` elements.
  1144. - Enabled multiple format names for "raw" directive.
  1145. - ``<p>`` tags of a paragraph which is the only visible child of the
  1146. document node are no longer stripped.
  1147. - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
  1148. new method ``should_be_compact_paragraph()``.
  1149. - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
  1150. elements.
  1151. - "raw" elements are now surrounded by ``span`` or ``div`` tags in
  1152. the output if they have their ``class`` attribute set.
  1153. - The whole document is now surrounded by a ``<div
  1154. class="document">`` element.
  1155. - Body-level images are now wrapped by their own ``<div>`` elements,
  1156. with image classes copied to the wrapper, and for images which
  1157. have the ``:align:`` option set, the surrounding ``<div>`` now
  1158. receives a class attribute (like ``class="align-left"``).
  1159. * docutils/writers/latex2e.py:
  1160. - no newline after depart_term.
  1161. - Added translations for some Unicode quotes.
  1162. - Added option "font-encoding", made package AE the default.
  1163. - "stylesheet" and "stylesheet_path" settings are now mutually
  1164. exclusive.
  1165. - --footnote-references now overrides
  1166. --trim-footnote-reference-space, if applicable.
  1167. - The footnote label style now matches the footnote reference style
  1168. ("brackets" or "superscript").
  1169. - Added support for ``compound`` elements.
  1170. - Enabled multiple format names for "raw" directive.
  1171. * docs/ref/docutils.dtd:
  1172. - Changed structure of the ``line_block`` element; added ``line``.
  1173. - Added ``compound`` element.
  1174. - Added "ltrim" and "rtrim" attributes to
  1175. ``substitution_definition`` element.
  1176. - Enabled multiple format names for ``raw`` element.
  1177. - Enabled multiple classifiers in ``definition_list_item`` elements.
  1178. * docs/ref/rst/directives.txt
  1179. - Marked "line-block" as deprecated.
  1180. - "Class" directive now allows multiple class names.
  1181. - Added "Rationale for Class Attribute Value Conversion".
  1182. - Added warning about "raw" overuse/abuse.
  1183. * docs/ref/rst/restructuredtext.txt:
  1184. - Added syntax for line blocks.
  1185. - Definition list items may have multiple classifiers.
  1186. * docs/ref/rst/roles.txt:
  1187. - Added "raw" role.
  1188. * tools/stylesheets/default.css:
  1189. - Added support for the new line_block structure.
  1190. - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
  1191. Release 0.3.5 (2004-07-29)
  1192. ==========================
  1193. General:
  1194. * _`Documentation cleanup/reorganization`.
  1195. - Created new subdirectories of docs/:
  1196. * ``docs/user/``: introductory/tutorial material for end-users
  1197. * ``docs/dev/``: for core-developers (development notes, plans, etc.)
  1198. * ``docs/api/``: API reference material for client-developers
  1199. * ``docs/ref/``: reference material for all groups
  1200. * ``docs/howto/``: for component-developers and core-developers
  1201. * ``docs/peps/``: Python Enhancement Proposals
  1202. - Moved ``docs/*`` to ``docs/user/``.
  1203. - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
  1204. ``spec/`` to ``docs/dev``.
  1205. - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
  1206. ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
  1207. - Moved ``alternatives.txt``, and ``problems.txt`` from
  1208. ``spec/rst/`` to ``docs/dev/rst/``.
  1209. - Moved ``reStructuredText.txt``, ``directives.txt``,
  1210. ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
  1211. to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
  1212. ``roles.txt``, ``reStructuredText.txt`` to
  1213. ``restructuredtext.txt``.
  1214. - Moved ``spec/howto/`` to ``docs/howto``.
  1215. In order to keep the CVS history of moved files, we supplied
  1216. SourceForge with a `script for modifying the Docutils CVS
  1217. repository`__.
  1218. __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
  1219. After running the cleanup script:
  1220. - Added ``docs/index.txt``.
  1221. - Added a ``.htaccess`` file to the ``web`` module, containing
  1222. redirects for all old paths to new paths. They'll preserve
  1223. fragments (the "#name" part of a URL), and won't clutter up the
  1224. file system, and will correct the URL in the user's browser.
  1225. - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
  1226. ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
  1227. the "To Do" list itself in ``docs/dev/todo.txt``.
  1228. - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
  1229. section of ``docs/dev/todo.txt``.
  1230. - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
  1231. - Added "How To Report Bugs" to ``BUGS.txt``.
  1232. - Went through all the sources and docs (including under web/) and
  1233. updated links. Mostly done by Lea Wiemann; thanks Lea!
  1234. (Still need to update links in the sandboxes.)
  1235. Specific:
  1236. * BUGS.txt: Added to project.
  1237. * THANKS.txt: Added to project.
  1238. * docutils/__init__.py:
  1239. - 0.3.4: Post-release.
  1240. * docutils/core.py:
  1241. - Added special error handling & advice for UnicodeEncodeError.
  1242. - Refactored Publisher.publish (simplified exception handling &
  1243. extracted debug dumps).
  1244. - Renamed "enable_exit" parameter of convenience functions to
  1245. "enable_exit_status".
  1246. - Enabled traceback (exception propagation) by default in
  1247. programmatic convenience functions.
  1248. - Now publish_file and publish_cmdline convenience functions return
  1249. the encoded string results in addition to their regular I/O.
  1250. - Extracted common code from publish_file, publish_string, and
  1251. publish_parts, into new publish_programmatically. Extracted
  1252. settings code to ``Publisher.process_programmatic_settings``.
  1253. - In Publisher.publish, disabled ``settings_overrides`` when
  1254. ``settings`` is supplied; redundant.
  1255. * docutils/frontend.py:
  1256. - Added help text for "--output-encoding-error-handler" and
  1257. "--error-encoding-error-handler".
  1258. - Renamed "--exit" to "--exit-status".
  1259. - Simplified default-setting code.
  1260. * docutils/parsers/rst/__init__.py:
  1261. - Added "--pep-base-url" and "--rfc-base-url" options.
  1262. * docutils/parsers/rst/states.py:
  1263. - Made URI recognition more aggressive and intelligent.
  1264. * docutils/parsers/rst/directives/__init__.py:
  1265. - Added several directive option conversion functions.
  1266. * docutils/parsers/rst/directives/body.py:
  1267. - Moved "table" directive to tables.py.
  1268. * docutils/parsers/rst/directives/tables.py: Table-related directives,
  1269. added to project.
  1270. * docutils/writers/latex2e.py:
  1271. - Added "--table-style=(standard|booktabs|nolines)"
  1272. - figures get "here" option (LaTeX per default puts them at bottom),
  1273. and figure content is centered.
  1274. - Rowspan support for tables.
  1275. - Fix: admonition titles before first section.
  1276. - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
  1277. - Replave ``_`` in literal by an underlined blank, because it has the correct
  1278. width.
  1279. - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
  1280. - A few unicode replacements, if output_encoding != utf
  1281. - Add "--graphicx-option".
  1282. - Indent literal-blocks.
  1283. - Fix: omit ``\maketitle`` when there is no document title.
  1284. * docs/index.txt: "Docutils Project Documentation Overview", added to
  1285. project.
  1286. * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
  1287. Tool", added to project.
  1288. * docs/api/publisher.txt: "The Docutils Publisher", added to project.
  1289. * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
  1290. * docs/dev/policies.txt: Added to project (extracted from
  1291. ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
  1292. * docs/dev/release.txt: Added to project (extracted from
  1293. ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
  1294. * docs/dev/testing.txt: Added to project.
  1295. * docs/dev/website.txt: Added to project (extracted from
  1296. ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
  1297. * docs/ref/rst/directives.txt:
  1298. - Added directives: "table", "csv-table".
  1299. * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
  1300. added to project. 1 page for syntax, and a 1 page reference for
  1301. directives and roles. Source text to be used as-is; not meant to be
  1302. converted to HTML.
  1303. * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
  1304. with a change of title.
  1305. * test/functional/, contents, and test/test_functional.py: Added to
  1306. project.
  1307. * tools/buildhtml.py: Fixed bug with config file handling.
  1308. * tools/html.py: Removed from project (duplicate of rst2html.py).
  1309. * tools/pep2html.py: Removed from project (duplicate of Python's
  1310. nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
  1311. Docutils-related PEPs in docs/peps/).
  1312. * tools/rst2pseudoxml.py: Renamed from publish.py.
  1313. * tools/rst2xml.py: Renamed from docutils-xml.py.
  1314. * tools/test.txt: Removed from project; moved to
  1315. docs/user/rst/demo.txt.
  1316. * setup.py: Now also installs ``rst2latex.py``.
  1317. Release 0.3.3 (2004-05-09)
  1318. ==========================
  1319. * docutils/__init__.py:
  1320. - 0.3.1: Reorganized config file format (multiple sections); see
  1321. docs/config.txt.
  1322. - Added unknown_reference_resolvers attribute to TransformSpec.
  1323. - 0.3.2: Interpreted text reorganization.
  1324. - 0.3.3: Released.
  1325. * docutils/core.py:
  1326. - Catch system messages to stop tracebacks from parsing errors.
  1327. - Catch exceptions during processing report & exit without
  1328. tracebacks, except when "--traceback" used.
  1329. - Reordered components for OptionParser; application comes last.
  1330. - Added "config_section" parameter to several methods and functions,
  1331. allowing front ends to easily specify their config file sections.
  1332. - Added publish_parts convenience function to allow access to individual
  1333. parts of a document.
  1334. * docutils/examples.py: Added to project; practical examples of
  1335. Docutils client code, to be used as-is or as models for variations.
  1336. * docutils/frontend.py:
  1337. - Added "--traceback" & "--no-traceback" options ("traceback"
  1338. setting).
  1339. - Implemented support for config file reorganization:
  1340. ``standard_config_files`` moved from ``ConfigParser`` to
  1341. ``OptionParser``; added
  1342. ``OptionParser.get_config_file_settings()`` and
  1343. ``.get_standard_config_settings()``; support for old "[options]"
  1344. section (with deprecation warning) and mapping from old to new
  1345. settings.
  1346. - Reimplemented setting validation.
  1347. - Enabled flexible boolean values: yes/no, true/false, on/off.
  1348. - Added ``Values``, a subclass of ``optparse.Values``, with support
  1349. for list setting attributes.
  1350. - Added support for new ``DOCUTILSCONFIG`` environment variable;
  1351. thanks to Beni Cherniavsky.
  1352. - Added "--no-section-numbering" option.
  1353. * docutils/io.py:
  1354. - Catch IOErrors when opening source & destination files, report &
  1355. exit without tracebacks. Added ``handle_io_errors`` parameter to
  1356. ``FileInput`` & ``FileOutput`` to enable caller error handling.
  1357. * docutils/nodes.py:
  1358. - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
  1359. method definitions (via ``exec``) to dynamic assignments (via
  1360. ``setattr``); thanks to Roman Suzi.
  1361. - Encapsulated visitor dynamic assignments in a function; thanks to
  1362. Ian Bicking.
  1363. - Added indirect_reference_name attribute to the Targetable
  1364. class. This attribute holds the whitespace_normalized_name
  1365. (contains mixed case) of a target.
  1366. * docutils/statemachine.py:
  1367. - Renamed ``StringList.strip_indent`` to ``.trim_left``.
  1368. - Added ``StringList.get_2D_block``.
  1369. * docutils/utils.py:
  1370. - Added "level" attribute to SystemMessage exceptions.
  1371. * docutils/languages/af.py: Added to project; Afrikaans mappings by
  1372. Jannie Hofmeyr.
  1373. * docutils/languages/cs.py: Added to project; Czech mappings by Marek
  1374. Blaha.
  1375. * docutils/languages/eo.py: Added to project; Esperanto mappings by
  1376. Marcelo Huerta San Martin.
  1377. * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
  1378. mappings by Lalo Martins.
  1379. * docutils/languages/ru.py: Added to project; Russian mappings by
  1380. Roman Suzi.
  1381. * docutils/parsers/rst/roles.py: Added to project. Contains
  1382. interpreted text role functions, a registry for interpreted text
  1383. roles, and an API for adding to and retrieving from the registry.
  1384. Contributed by Edward Loper.
  1385. * docutils/parsers/rst/states.py:
  1386. - Updated ``RSTState.nested_parse`` for "include" in table cells.
  1387. - Allowed true em-dash character and "---" as block quote
  1388. attribution marker.
  1389. - Added support for <angle-bracketed> complex option arguments
  1390. (option lists).
  1391. - Fixed handling of backslashes in substitution definitions.
  1392. - Fixed off-by-1 error with extra whitespace after substitution
  1393. definition directive.
  1394. - Added inline markup parsing to field lists' field names.
  1395. - Added support for quoted (and unindented) literal blocks.
  1396. Driven in part by a bribe from Frank Siebenlist (thanks!).
  1397. - Parser now handles escapes in URIs correctly.
  1398. - Made embedded-URIs' reference text omittable. Idea from Beni
  1399. Cherniavsky.
  1400. - Refactored explicit target processing code.
  1401. - Added name attribute to references containing the reference name only
  1402. through whitespace_normalize_name (no case changes).
  1403. - parse_target no longer returns the refname after going through
  1404. normalize_name. This is now handled in make_target.
  1405. - Fixed bug relating to role-less interpreted text in non-English
  1406. contexts.
  1407. - Reorganized interpreted text processing; moved code into the new
  1408. roles.py module. Contributed by Edward Loper.
  1409. - Refactored ``Body.parse_directive`` into ``run_directive`` and
  1410. ``parse_directive_block``.
  1411. * docutils/parsers/rst/tableparser.py:
  1412. - Reworked for ``StringList``, to support "include" directives in
  1413. table cells.
  1414. * docutils/parsers/rst/directives/__init__.py:
  1415. - Renamed ``unchanged()`` directive option conversion function to
  1416. ``unchanged_required``, and added a new ``unchanged``.
  1417. - Catch unicode value too high error; fixes bug 781766.
  1418. - Beefed up directive error reporting.
  1419. * docutils/parsers/rst/directives/body.py:
  1420. - Added basic "table" directive.
  1421. * docutils/parsers/rst/directives/images.py:
  1422. - Added "target" option to "image" directive.
  1423. - Added name attribute to references containing the reference name only
  1424. through whitespace_normalize_name (no case changes).
  1425. * docutils/parsers/rst/directives/misc.py:
  1426. - Isolated the import of the ``urllib2`` module; was causing
  1427. problems on SourceForge (``libssl.so.2`` unavailable?).
  1428. - Added the "role" directive for declaring custom interpreted text
  1429. roles.
  1430. * docutils/parsers/rst/directives/parts.py:
  1431. - The "contents" directive does more work up-front, creating the
  1432. "topic" and "title", and leaving the "pending" node for the
  1433. transform. Allows earlier reference resolution; fixes subtle bug.
  1434. * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
  1435. mappings by Jannie Hofmeyr.
  1436. * docutils/parsers/rst/languages/cs.py: Added to project; Czech
  1437. mappings by Marek Blaha.
  1438. * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
  1439. mappings by Marcelo Huerta San Martin.
  1440. * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
  1441. Portuguese mappings by Lalo Martins.
  1442. * docutils/parsers/rst/languages/ru.py: Added to project; Russian
  1443. mappings by Roman Suzi.
  1444. * docutils/transforms/parts.py:
  1445. - The "contents" directive does more work up-front, creating the
  1446. "topic" and "title", and leaving the "pending" node for the
  1447. transform. Allows earlier reference resolution; fixes subtle bug.
  1448. - Added support for disabling of section numbering.
  1449. * docutils/transforms/references.py:
  1450. - Verifying that external targets are truly targets and not indirect
  1451. references. This is because we are now adding a "name" attribute to
  1452. references in addition to targets. Note sure if this is correct!
  1453. - Added code to hook into the unknown_reference_resolvers list for a
  1454. transformer in resolve_indirect_target. This allows the
  1455. unknown_reference_resolvers to keep around indirect targets which
  1456. docutils doesn't know about.
  1457. - Added specific error message for duplicate targets.
  1458. * docutils/transforms/universal.py:
  1459. - Added FilterMessages transform (removes system messages below the
  1460. verbosity threshold).
  1461. - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
  1462. to FinalCheckVisitor for application-specific handling of
  1463. unresolvable references.
  1464. - Added specific error message for duplicate targets.
  1465. * docutils/writers/__init__.py:
  1466. - Added assemble_parts method to the Writer class to allow for
  1467. access to a documents individual parts.
  1468. - Documented & set default for ``Writer.output`` attribute.
  1469. * docutils/writers/html4css1.py:
  1470. - Fixed unicode handling of attribute values (bug 760673).
  1471. - Prevent duplication of "class" attribute values (bug report from
  1472. Kirill Lapshin).
  1473. - Improved table grid/border handling (prompted by report from Bob
  1474. Marshall).
  1475. - Added support for table titles.
  1476. - Added "<title />" for untitled docs, for XHTML conformance; thanks
  1477. to Darek Suchojad.
  1478. - Added functionality to keep track of individual parts of a document
  1479. and store them in a dictionary as the "parts" attribute of the writer.
  1480. Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
  1481. - Added proper support for the "scale" attribute of the "image"
  1482. element. Contributed by Brent Cook.
  1483. - Added ``--initial-header-level`` option.
  1484. - Fixed bug: the body_pre_docinfo segment depended on there being a
  1485. docinfo; if no docinfo, the document title was incorporated into
  1486. the body segment. Adversely affected the publish_parts interface.
  1487. * docutils/writers/latex2e.py:
  1488. - Changed default stylesheet to "no stylesheet" to avoid latex complaining
  1489. about a missing file.
  1490. - Added options and support: ``--compound-enumerators``,
  1491. ``--section-prefix-for-enumerators``, and
  1492. ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
  1493. 934322).
  1494. - Added option ``--use-verbatim-when-possible``, to avoid
  1495. problematic characters (eg, '~' in italian) in literal blocks.
  1496. - It's now possible to use four section levels in the `book` and
  1497. `report` LaTeX classes. The default `article` class still has
  1498. three levels limit.
  1499. * docs/config.txt: "Docutils Configuration Files", added to project.
  1500. Moved config file entry descriptions from tools.txt.
  1501. * docs/tools.txt:
  1502. - Moved config file entry descriptions to config.txt.
  1503. * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
  1504. Development".
  1505. * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
  1506. Text Roles", added to project.
  1507. * spec/rst/reStructuredText.txt:
  1508. - Added description of support for <angle-bracketed> complex option
  1509. arguments to option lists.
  1510. - Added subsections for indented and quoted literal blocks.
  1511. * test: Continually adding & updating tests.
  1512. - Added test/test_settings.py & test/data/config_*.txt support
  1513. files.
  1514. - Added test/test_writers/test_htmlfragment.py.
  1515. * test/DocutilsTestSupport.py:
  1516. - Refactored LaTeX publisher test suite/case class names to make
  1517. testing other writers easier.
  1518. - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
  1519. to test the processing of HTML fragments which use the new
  1520. publish_parts convenience function.
  1521. * tools/buildhtml.py:
  1522. - Added support for the "--prune" option.
  1523. - Removed dependency on pep2html.py; plaintext PEPs no longer
  1524. supported.
  1525. * tools/docutils.conf:
  1526. - Updated for configuration file reorganization.
  1527. * tools/rst2html.py:
  1528. - copied from tools/html.py
  1529. * setup.py:
  1530. - added a 'scripts' section to configuration
  1531. - added 'tools/rst2html.py' to the scripts section
  1532. Release 0.3 (2003-06-24)
  1533. ========================
  1534. General:
  1535. * Renamed "attribute" to "option" for directives/extensions.
  1536. * Renamed transform method "transform" to "apply".
  1537. * Renamed "options" to "settings" for runtime settings (as set by
  1538. command-line options). Sometimes "option" (singular) became
  1539. "settings" (plural). Some variations below:
  1540. - document.options -> document.settings (stored in other objects as
  1541. well)
  1542. - option_spec -> settings_spec (not directives though)
  1543. - OptionSpec -> SettingsSpec
  1544. - cmdline_options -> settings_spec
  1545. - relative_path_options -> relative_path_settings
  1546. - option_default_overrides -> settings_default_overrides
  1547. - Publisher.set_options -> Publisher.get_settings
  1548. Specific:
  1549. * COPYING.txt: Added "Public Domain Dedication".
  1550. * FAQ.txt: Frequently asked questions, added to project.
  1551. * setup.py:
  1552. - Updated with PyPI Trove classifiers.
  1553. - Conditional installation of third-party modules.
  1554. * docutils/__init__.py:
  1555. - Bumped version to 0.2.1 to reflect changes to I/O classes.
  1556. - Bumped version to 0.2.2 to reflect changes to stylesheet options.
  1557. - Factored ``SettingsSpec`` out of ``Component``; separately useful.
  1558. - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
  1559. option and its effect on the PEP template & writer.
  1560. - Bumped version to 0.2.4 due to changes to the PEP template &
  1561. stylesheet.
  1562. - Bumped version to 0.2.5 to reflect changes to Reporter output.
  1563. - Added ``TransformSpec`` class for new transform system.
  1564. - Bumped version to 0.2.6 for API changes (renaming).
  1565. - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
  1566. convenience functions.
  1567. - Added ``Component.component_type`` attribute.
  1568. - Bumped version to 0.2.8 because of the internal parser switch from
  1569. plain lists to the docutils.statemachine.StringList objects.
  1570. - Bumped version to 0.2.9 because of the frontend.py API changes.
  1571. - Bumped version to 0.2.10 due to changes to the project layout
  1572. (third-party modules removed from the "docutils" package), and
  1573. signature changes in ``io.Input``/``io.Output``.
  1574. - Changed version to 0.3.0 for release.
  1575. * docutils/core.py:
  1576. - Made ``publish()`` a bit more convenient.
  1577. - Generalized ``Publisher.set_io``.
  1578. - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
  1579. parameters; improved its docstring.
  1580. - Added ``publish_file()`` and ``publish_string()``.
  1581. - Factored ``Publisher.set_source()`` and ``.set_destination()``
  1582. out of ``.set_io``.
  1583. - Added support for "--dump-pseudo-xml", "--dump-settings", and
  1584. "--dump-transforms" hidden options.
  1585. - Added ``Publisher.apply_transforms()`` method.
  1586. - Added ``Publisher.set_components()`` method; support for
  1587. ``publish_*()`` conveninece functions.
  1588. - Moved config file processing to docutils/frontend.py.
  1589. - Added support for exit status ("exit_level" setting &
  1590. ``enable_exit`` parameter for Publisher.publish() and convenience
  1591. functions).
  1592. * docutils/frontend.py:
  1593. - Check for & exit on identical source & destination paths.
  1594. - Fixed bug with absolute paths & "--config".
  1595. - Set non-command-line defaults in ``OptionParser.__init__()``:
  1596. ``_source`` & ``_destination``.
  1597. - Distributed ``relative_path_settings`` to components; updated
  1598. ``OptionParser.populate_from_components()`` to combine it all.
  1599. - Require list of keys in ``make_paths_absolute`` (was implicit in
  1600. global ``relative_path_settings``).
  1601. - Added "--expose-internal-attribute", "--dump-pseudo-xml",
  1602. "--dump-settings", and "--dump-transforms" hidden options.
  1603. - Removed nasty internals-fiddling ``ConfigParser.get_section``
  1604. code, replaced with correct code.
  1605. - Added validation functionality for config files.
  1606. - Added "--error-encoding" option/setting, "_disable_config"
  1607. internal setting.
  1608. - Added encoding validation; updated "--input-encoding" and
  1609. "--output-encoding"; added "--error-encoding-error-handler" and
  1610. "--output-encoding-error-handler".
  1611. - Moved config file processing from docutils/core.py.
  1612. - Updated ``OptionParser.populate_from_components`` to handle new
  1613. ``SettingsSpec.settings_defaults`` dict.
  1614. - Added support for "-" => stdin/stdout.
  1615. - Added "exit_level" setting ("--exit" option).
  1616. * docutils/io.py:
  1617. - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
  1618. - Added automatic closing to ``FileInput`` and ``FileOutput``.
  1619. - Delayed opening of ``FileOutput`` file until ``write()`` called.
  1620. - ``FileOutput.write()`` now returns the encoded output string.
  1621. - Try to get path/stream name automatically in ``FileInput`` &
  1622. ``FileOutput``.
  1623. - Added defaults for source & destination paths.
  1624. - Allow for Unicode I/O with an explicit "unicode" encoding.
  1625. - Added ``Output.encode()``.
  1626. - Removed dependency on runtime settings; pass encoding directly.
  1627. - Recognize Unicode strings in ``Input.decode()``.
  1628. - Added support for output encoding error handlers.
  1629. * docutils/nodes.py:
  1630. - Added "Invisible" element category class.
  1631. - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
  1632. modification during a traversal.
  1633. - Added element classes: ``line_block``, ``generated``, ``address``,
  1634. ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
  1635. ``superscript``, ``subscript``, ``inline``
  1636. - Added support for lists of nodes to ``Element.insert()``.
  1637. - Fixed parent linking in ``Element.replace()``.
  1638. - Added new abstract superclass ``FixedTextElement``; adds
  1639. "xml:space" attribute.
  1640. - Added support for "line" attribute of ``system_message`` nodes.
  1641. - Added support for the observer pattern from ``utils.Reporter``.
  1642. Added ``parse_messages`` and ``transform_messages`` attributes to
  1643. ``document``, removed ``messages``. Added ``note_parse_message``
  1644. and ``note_transform_message`` methods.
  1645. - Added support for improved diagnostics:
  1646. - Added "document", "source", and "line" internal attributes to
  1647. ``Node``, set by ``Node.setup_child()``.
  1648. - Converted variations on ``node.parent = self`` to
  1649. ``self.setup_child(node)``.
  1650. - Added ``document.current_source`` & ``.current_line``
  1651. attributes, and ``.note_source`` observer method.
  1652. - Changed "system_message" output to GNU-Tools format.
  1653. - Added a "rawsource" attribute to the ``Text`` class, for text
  1654. before backslash-escape resolution.
  1655. - Support for new transform system.
  1656. - Reworked ``pending`` element.
  1657. - Fixed XML DOM bug (SF #660611).
  1658. - Removed the ``interpeted`` element class and added
  1659. ``title_reference``, ``abbreviation``, ``acronym``.
  1660. - Made substitutions case-sensitive-but-forgiving; moved some code
  1661. from the parser.
  1662. - Fixed Unicode bug on element attributes (report: William Dode).
  1663. * docutils/optik.py: Removed from project; replaced with
  1664. extras/optparse.py and extras/textwrap.py. These will be installed
  1665. only if they're not already present in the Python installation.
  1666. * docutils/roman.py: Moved to extras/roman.py; this will be installed
  1667. only if it's not already present in the Python installation.
  1668. * docutils/statemachine.py:
  1669. - Factored out ``State.add_initial_transitions()`` so it can be
  1670. extended.
  1671. - Converted whitespace-specific "blank" and "indent" transitions
  1672. from special-case code to ordinary transitions: removed
  1673. ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
  1674. ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
  1675. ``ws_initial_transitions`` attributes.
  1676. - Removed ``State.match_transition()`` after merging it into
  1677. ``.check_line()``.
  1678. - Added ``StateCorrection`` exception.
  1679. - Added support for ``StateCorrection`` in ``StateMachine.run()``
  1680. (moved ``TransitionCorrection`` support there too.)
  1681. - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
  1682. ``EOFError`` instead of ``IndexError``.
  1683. - Added ``State.no_match`` method.
  1684. - Added support for the Observer pattern, triggered by input line
  1685. changes.
  1686. - Added ``strip_top`` parameter to
  1687. ``StateMachineWS.get_first_known_indented``.
  1688. - Made ``context`` a parameter to ``StateMachine.run()``.
  1689. - Added ``ViewList`` & ``StringList`` classes;
  1690. ``extract_indented()`` becomes ``StringList.get_indented()``.
  1691. - Added ``StateMachine.insert_input()``.
  1692. - Fixed ViewList slice handling for Python 2.3. Patch from (and
  1693. thanks to) Fred Drake.
  1694. * docutils/utils.py:
  1695. - Added a ``source`` attribute to Reporter instances and
  1696. ``system_message`` elements.
  1697. - Added an observer pattern to ``utils.Reporter`` to keep track of
  1698. system messages.
  1699. - Fixed bugs in ``relative_path()``.
  1700. - Added support for improved diagnostics.
  1701. - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
  1702. - Added support for encoding Reporter stderr output, and encoding
  1703. error handlers.
  1704. - Reporter keeps track of the highest level system message yet
  1705. generated.
  1706. * docutils/languages: Fixed bibliographic field language lookups.
  1707. * docutils/languages/es.py: Added to project; Spanish mappings by
  1708. Marcelo Huerta San Martin.
  1709. * docutils/languages/fr.py: Added to project; French mappings by
  1710. Stefane Fermigier.
  1711. * docutils/languages/it.py: Added to project; Italian mappings by
  1712. Nicola Larosa.
  1713. * docutils/languages/sk.py: Added to project; Slovak mappings by
  1714. Miroslav Vasko.
  1715. * docutils/parser/__init__.py:
  1716. - Added ``Parser.finish_parse()`` method.
  1717. * docutils/parser/rst/__init__.py:
  1718. - Added options: "--pep-references", "--rfc-references",
  1719. "--tab-width", "--trim-footnote-reference-space".
  1720. * docutils/parsers/rst/states.py:
  1721. - Changed "title under/overline too short" system messages from INFO
  1722. to WARNING, and fixed its insertion location.
  1723. - Fixed enumerated list item parsing to allow paragraphs & section
  1724. titles to begin with enumerators.
  1725. - Converted system messages to use the new "line" attribute.
  1726. - Fixed a substitution reference edge case.
  1727. - Added support for "--pep-references" and "--rfc-references"
  1728. options; reworked ``Inliner`` code to make customization easier.
  1729. - Removed field argument parsing.
  1730. - Added support for short section title over/underlines.
  1731. - Fixed "simple reference name" regexp to ignore text like
  1732. "object.__method__"; not an anonymous reference.
  1733. - Added support for improved diagnostics.
  1734. - Reworked directive API, based on Dethe Elza's contribution. Added
  1735. ``Body.parse_directive()``, ``.parse_directive_options()``,
  1736. ``.parse_directive_arguments()`` methods.
  1737. - Added ``ExtensionOptions`` class, to parse directive options
  1738. without parsing field bodies. Factored
  1739. ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
  1740. ``ExtensionOptions``.
  1741. - Improved definition list term/classifier parsing.
  1742. - Added warnings for unknown directives.
  1743. - Renamed ``Stuff`` to ``Struct``.
  1744. - Now flagged as errors: transitions at the beginning or end of
  1745. sections, empty sections (except title), and empty documents.
  1746. - Updated for ``statemachine.StringList``.
  1747. - Enabled recognition of schemeless email addresses in targets.
  1748. - Added support for embedded URIs in hyperlink references.
  1749. - Added backslash-escapes to inline markup end-string suffix.
  1750. - Added support for correct interpreted text processing.
  1751. - Fixed nested title parsing (topic, sidebar directives).
  1752. - Added special processing of backslash-escaped whitespace (idea
  1753. from David Abrahams).
  1754. - Made substitutions case-sensitive-but-forgiving; moved some code
  1755. to ``docutils.nodes``.
  1756. - Added support for block quote attributions.
  1757. - Added a kludge to work-around a conflict between the bubble-up
  1758. parser strategy and short titles (<= 3 char-long over- &
  1759. underlines). Fixes SF bug #738803 "infinite loop with multiple
  1760. titles" submitted by Jason Diamond.
  1761. - Added explicit interpreted text roles for standard inline markup:
  1762. "emphasis", "strong", "literal".
  1763. - Implemented "superscript" and "subscript" interpreted text roles.
  1764. - Added initial support for "abbreviation" and "acronym" roles;
  1765. incomplete.
  1766. - Added support for "--trim-footnote-reference-space" option.
  1767. - Optional space before colons in directives & hyperlink targets.
  1768. * docutils/parsers/rst/tableparser.py:
  1769. - Fixed a bug that was producing unwanted empty rows in "simple"
  1770. tables.
  1771. - Detect bad column spans in "simple" tables.
  1772. * docutils/parsers/rst/directives: Updated all directive functions to
  1773. new API.
  1774. * docutils/parsers/rst/directives/__init__.py:
  1775. - Added ``flag()``, ``unchanged()``, ``path()``,
  1776. ``nonnegative_int()``, ``choice()``, and ``class_option()``
  1777. directive option helper functions.
  1778. - Added warnings for unknown directives.
  1779. - Return ``None`` for missing directives.
  1780. - Added ``register_directive()``, thanks to William Dode and Paul
  1781. Moore.
  1782. * docutils/parsers/rst/directives/admonitions.py:
  1783. - Added "admonition" directive.
  1784. * docutils/parsers/rst/directives/body.py: Added to project. Contains
  1785. the "topic", "sidebar" (from Patrick O'Brien), "line-block",
  1786. "parsed-literal", "rubric", "epigraph", "highlights" and
  1787. "pull-quote" directives.
  1788. * docutils/parsers/rst/directives/images.py:
  1789. - Added an "align" attribute to the "image" & "figure" directives
  1790. (by Adam Chodorowski).
  1791. - Added "class" option to "image", and "figclass" to "figure".
  1792. * docutils/parsers/rst/directives/misc.py:
  1793. - Added "include", "raw", and "replace" directives, courtesy of
  1794. Dethe Elza.
  1795. - Added "unicode" and "class" directives.
  1796. * docutils/parsers/rst/directives/parts.py:
  1797. - Added the "sectnum" directive; by Dmitry Jemerov.
  1798. - Added "class" option to "contents" directive.
  1799. * docutils/parsers/rst/directives/references.py: Added to project.
  1800. Contains the "target-notes" directive.
  1801. * docutils/parsers/rst/languages/__init__.py:
  1802. - Return ``None`` from get_language() for missing language modules.
  1803. * docutils/parsers/rst/languages/de.py: Added to project; German
  1804. mappings by Engelbert Gruber.
  1805. * docutils/parsers/rst/languages/en.py:
  1806. - Added interpreted text roles mapping.
  1807. * docutils/parsers/rst/languages/es.py: Added to project; Spanish
  1808. mappings by Marcelo Huerta San Martin.
  1809. * docutils/parsers/rst/languages/fr.py: Added to project; French
  1810. mappings by William Dode.
  1811. * docutils/parsers/rst/languages/it.py: Added to project; Italian
  1812. mappings by Nicola Larosa.
  1813. * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
  1814. mappings by Miroslav Vasko.
  1815. * docutils/readers/__init__.py:
  1816. - Added support for the observer pattern from ``utils.Reporter``, in
  1817. ``Reader.parse`` and ``Reader.transform``.
  1818. - Removed ``Reader.transform()`` method.
  1819. - Added default parameter values to ``Reader.__init__()`` to make
  1820. instantiation easier.
  1821. - Removed bogus aliases: "restructuredtext" is *not* a Reader.
  1822. * docutils/readers/pep.py:
  1823. - Added the ``peps.TargetNotes`` transform to the Reader.
  1824. - Removed PEP & RFC reference detection code; moved to
  1825. parsers/rst/states.py as options (enabled here by default).
  1826. - Added support for pre-acceptance PEPs (no PEP number yet).
  1827. - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
  1828. easy subclassing.
  1829. * docutils/readers/python: Python Source Reader subpackage added to
  1830. project, including preliminary versions of:
  1831. - __init__.py
  1832. - moduleparser.py: Parser for Python modules.
  1833. * docutils/transforms/__init__.py:
  1834. - Added ``Transformer`` class and completed transform reform.
  1835. - Added unknown_reference_resolvers list for each transformer. This list holds
  1836. the list of functions provided by each component of the transformer that
  1837. help resolve references.
  1838. * docutils/transforms/frontmatter.py:
  1839. - Improved support for generic fields.
  1840. - Fixed bibliographic field language lookups.
  1841. * docutils/transforms/misc.py: Added to project. Miscellaneous
  1842. transforms.
  1843. * docutils/transforms/parts.py:
  1844. - Moved the "id" attribute from TOC list items to the references
  1845. (``Contents.build_contents()``).
  1846. - Added the ``SectNum`` transform; by Dmitry Jemerov.
  1847. - Added "class" attribute support to ``Contents``.
  1848. * docutils/transforms/peps.py:
  1849. - Added ``mask_email()`` function, updating to pep2html.py's
  1850. functionality.
  1851. - Linked "Content-Type: text/x-rst" to PEP 12.
  1852. - Added the ``TargetNotes`` PEP-specific transform.
  1853. - Added ``TargetNotes.cleanup_callback``.
  1854. - Added title check to ``Headers``.
  1855. * docutils/transforms/references.py:
  1856. - Added the ``TargetNotes`` generic transform.
  1857. - Split ``Hyperlinks`` into multiple transforms.
  1858. - Fixed bug with multiply-indirect references (report: Bruce Smith).
  1859. - Added check for circular indirect references.
  1860. - Made substitutions case-sensitive-but-forgiving.
  1861. * docutils/transforms/universal.py:
  1862. - Added support for the "--expose-internal-attributes" option.
  1863. - Removed ``Pending`` transform classes & data.
  1864. * docutils/writers/__init__.py:
  1865. - Removed ``Writer.transform()`` method.
  1866. * docutils/writers/docutils-xml.py:
  1867. - Added XML and doctype declarations.
  1868. - Added "--no-doctype" and "--no-xml-declaration" options.
  1869. * docutils/writers/html4css1.py:
  1870. - "name" attributes only on these tags: a, applet, form, frame,
  1871. iframe, img, map.
  1872. - Added "name" attribute to <a> in section titles for Netscape 4
  1873. support (bug report: Pearu Peterson).
  1874. - Fixed targets (names) on footnote, citation, topic title,
  1875. problematic, and system_message nodes (for Netscape 4).
  1876. - Changed field names from "<td>" to "<th>".
  1877. - Added "@" to "&#64;" encoding to thwart address harvesters.
  1878. - Improved the vertical whitespace optimization; ignore "invisible"
  1879. nodes (targets, comments, etc.).
  1880. - Improved inline literals with ``<span class="pre">`` around chunks
  1881. of text and ``&nbsp;`` for runs of spaces.
  1882. - Improved modularity of output; added ``self.body_pre_docinfo`` and
  1883. ``self.docinfo`` segments.
  1884. - Added support for "line_block", "address" elements.
  1885. - Improved backlinks (footnotes & system_messages).
  1886. - Improved system_message output.
  1887. - Redefined "--stylesheet" as containing an invariant URL, used
  1888. verbatim. Added "--stylesheet-path", interpreted w.r.t. the
  1889. working directory.
  1890. - Added "--footnote-references" option (superscript or brackets).
  1891. - Added "--compact-lists" and "--no-compact-lists" options.
  1892. - Added "--embed-stylesheet" and "--link-stylesheet" options;
  1893. factored out ``HTMLTranslator.get_stylesheet_reference()``.
  1894. - Improved field list rendering.
  1895. - Added Docutils version to "generator" meta tag.
  1896. - Fixed a bug with images; they must be inline, so wrapped in <p>.
  1897. - Improved layout of <pre> HTML source.
  1898. - Fixed attribute typo on <colspec>.
  1899. - Refined XML prologue.
  1900. - Support for no stylesheet.
  1901. - Removed "interpreted" element support.
  1902. - Added support for "title_reference", "sidebar", "attribution",
  1903. "rubric", and generic "admonition" elements.
  1904. - Added "--attribution" option.
  1905. - Added support for "inline", "subscript", "superscript" elements.
  1906. - Added initial support for "abbreviation" and "acronym";
  1907. incomplete.
  1908. * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
  1909. (from the sandbox).
  1910. - Added french.
  1911. - Double quotes in literal blocks (special treatment for de/ngerman).
  1912. - Added '--hyperlink-color' option ('0' turns off coloring of links).
  1913. - Added "--attribution" option.
  1914. - Right align attributions.
  1915. * docutils/writers/pep_html.py:
  1916. - Parameterized output encoding in PEP template.
  1917. - Reworked substitutions from ``locals()`` into ``subs`` dict.
  1918. - Redefined "--pep-stylesheet" as containing an invariant URL, used
  1919. verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
  1920. working directory.
  1921. - Added an override on the "--footnote-references" option.
  1922. - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
  1923. - Added Docutils version to "generator" meta tag.
  1924. - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
  1925. * docs/tools.txt:
  1926. - Added a "silent" setting for ``buildhtml.py``.
  1927. - Added a "Getting Help" section.
  1928. - Rearranged the structure.
  1929. - Kept up to date, with new settings, command-line options etc.
  1930. - Added section for ``rst2latex.py`` (Engelbert Gruber).
  1931. - Converted settings table into a definition list.
  1932. * docs/rst/quickstart.txt:
  1933. - Added a table of contents.
  1934. - Added feedback information.
  1935. - Added mention of minimum section title underline lengths.
  1936. - Removed the 4-character minimum for section title underlines.
  1937. * docs/rst/quickref.html:
  1938. - Added a "Getting Help" section.
  1939. - Added a style to make section title backlinks more subtle.
  1940. - Added mention of minimum section title underline lengths.
  1941. - Removed the 4-character minimum for section title underlines.
  1942. * extras: Directory added to project; contains third-party modules
  1943. that Docutils depends on (optparse, textwrap, roman). These are
  1944. only installed if they're not already present.
  1945. * licenses: Directory added to project; contains copies of license
  1946. files for non-public-domain files.
  1947. * spec/doctree.txt:
  1948. - Changed the focus. It's about DTD elements: structural
  1949. relationships, semantics, and external (public) attributes. Not
  1950. about the element class library.
  1951. - Moved some implementation-specific stuff into ``docutils.nodes``
  1952. docstrings.
  1953. - Wrote descriptions of all common attributes and parameter
  1954. entities. Filled in introductory material.
  1955. - Working through the element descriptions: 55 down, 37 to go.
  1956. - Removed "Representation of Horizontal Rules" to
  1957. spec/rst/alternatives.txt.
  1958. * spec/docutils.dtd:
  1959. - Added "generated" inline element.
  1960. - Added "line_block" body element.
  1961. - Added "auto" attribute to "title".
  1962. - Changed content models of "literal_block" and "doctest_block" to
  1963. ``%text.model``.
  1964. - Added ``%number;`` attribute type parameter entity.
  1965. - Changed ``%structural.elements;`` to ``%section.elements``.
  1966. - Updated attribute types; made more specific.
  1967. - Added "address" bibliographic element.
  1968. - Added "line" attribute to ``system_message`` element.
  1969. - Removed "field_argument" element; "field_name" may contain
  1970. multiple words and whitespace.
  1971. - Changed public identifier to docutils.sf.net.
  1972. - Removed "interpreted" element; added "title_reference",
  1973. "abbreviation", "acronym".
  1974. - Removed "refuri" attribute from "footnote_reference" and
  1975. "citation_reference".
  1976. - Added "sidebar", "rubric", "attribution", "admonition",
  1977. "superscript", "subscript", and "inline" elements.
  1978. * spec/pep-0256.txt: Converted to reStructuredText & updated.
  1979. * spec/pep-0257.txt: Converted to reStructuredText & updated.
  1980. * spec/pep-0258.txt: Converted to reStructuredText & updated.
  1981. * spec/semantics.txt: Updated with text from a Doc-SIG response to
  1982. Dallas Mahrt.
  1983. * spec/transforms.txt: Added to project.
  1984. * spec/howto: Added subdirectory, for developer how-to docs.
  1985. * spec/howto/rst-directives.txt: Added to project. Original by Dethe
  1986. Elza, edited & extended by David Goodger.
  1987. * spec/howto/i18n.txt: Docutils Internationalization. Added to
  1988. project.
  1989. * spec/rst/alternatives.txt:
  1990. - Added "Doctree Representation of Transitions" from
  1991. spec/doctree.txt.
  1992. - Updated "Inline External Targets" & closed the debate.
  1993. - Added ideas for interpreted text syntax extensions.
  1994. - Added "Nested Inline Markup" section.
  1995. * spec/rst/directives.txt:
  1996. - Added directives: "topic", "sectnum", "target-notes",
  1997. "line-block", "parsed-literal", "include", "replace", "sidebar",
  1998. "admonition", "rubric", "epigraph", "highlights", "unicode" and
  1999. "class".
  2000. - Formalized descriptions of directive details.
  2001. - Added an "align" attribute to the "image" & "figure" directives
  2002. (by Adam Chodorowski).
  2003. - Added "class" options to "topic", "sidebar", "line-block",
  2004. "parsed-literal", "contents", and "image"; and "figclass" to
  2005. "figure".
  2006. * spec/rst/interpreted.txt: Added to project. Descriptions of
  2007. interpreted text roles.
  2008. * spec/rst/introduction.txt:
  2009. - Added pointers to material for new users.
  2010. * spec/rst/reStructuredText.txt:
  2011. - Disambiguated comments (just add a newline after the "::").
  2012. - Updated enumerated list description; added a discussion of the
  2013. second-line validity checking.
  2014. - Updated directive description.
  2015. - Added a note redirecting newbies to the user docs.
  2016. - Expanded description of inline markup start-strings in non-markup
  2017. contexts.
  2018. - Removed field arguments and made field lists a generic construct.
  2019. - Removed the 4-character minimum for section title underlines.
  2020. - Clarified term/classifier delimiter & inline markup ambiguity
  2021. (definition lists).
  2022. - Added "Embedded URIs".
  2023. - Updated "Interpreted Text" section.
  2024. - Added "Character-Level Inline Markup" section.
  2025. * test: Continually adding & updating tests.
  2026. - Moved test/test_rst/ to test/test_parsers/test_rst/.
  2027. - Moved test/test_pep/ to test/test_readers/test_pep/.
  2028. - Added test/test_readers/test_python/.
  2029. - Added test/test_writers/ (Engelbert Gruber).
  2030. * tools:
  2031. - Made the ``locale.setlocale()`` calls in front ends
  2032. fault-tolerant.
  2033. * tools/buildhtml.py:
  2034. - Added "--silent" option.
  2035. - Fixed bug with absolute paths & "--config".
  2036. - Updated for new I/O classes.
  2037. - Added some exception handling.
  2038. - Separated publishers' setting defaults; prevents interference.
  2039. - Updated for new ``publish_file()`` convenience function.
  2040. * tools/pep-html-template:
  2041. - Allow for "--embed-stylesheet".
  2042. - Added Docutils version to "generator" meta tag.
  2043. - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
  2044. - Conform to XHTML spec.
  2045. * tools/pep2html.py:
  2046. - Made ``argv`` a parameter to ``main()``.
  2047. - Added support for "Content-Type:" header & arbitrary PEP formats.
  2048. - Linked "Content-Type: text/plain" to PEP 9.
  2049. - Files skipped (due to an error) are not pushed onto the server.
  2050. - Updated for new I/O classes.
  2051. - Added ``check_requirements()`` & ``pep_type_error()``.
  2052. - Added some exception handling.
  2053. - Updated for new ``publish_string()`` convenience function.
  2054. - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
  2055. * tools/quicktest.py:
  2056. - Added "-V"/"--version" option.
  2057. * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
  2058. * tools/unicode2rstsubs.py: Added to project. Produces character
  2059. entity files (reSructuredText substitutions) from the MathML master
  2060. unicode.xml file.
  2061. * tools/editors: Support code for editors, added to project. Contains
  2062. ``emacs/restructuredtext.el``.
  2063. * tools/stylesheets/default.css: Moved into the stylesheets directory.
  2064. - Added style for chunks of inline literals.
  2065. - Removed margin for first child of table cells.
  2066. - Right-aligned field list names.
  2067. - Support for auto-numbered section titles in TOCs.
  2068. - Increased the size of inline literals (<tt>) in titles.
  2069. - Restored the light gray background for inline literals.
  2070. - Added support for "line_block" elements.
  2071. - Added style for "address" elements.
  2072. - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
  2073. - Improved field list rendering.
  2074. - Vertical whitespace improvements.
  2075. - Removed "a.target" style.
  2076. * tools/stylesheets/pep.css:
  2077. - Fixed nested section margins.
  2078. - Other changes parallel those of ``../default.css``.
  2079. Release 0.2 (2002-07-31)
  2080. ========================
  2081. General:
  2082. - The word "component" was being used ambiguously. From now on,
  2083. "component" will be used to mean "Docutils component", as in Reader,
  2084. Writer, Parser, or Transform. Portions of documents (Table of
  2085. Contents, sections, etc.) will be called "document parts".
  2086. - Did a grand renaming: a lot of ``verylongnames`` became
  2087. ``very_long_names``.
  2088. - Cleaned up imports: no more relative package imports or
  2089. comma-separated lists of top-level modules.
  2090. - Added support for an option values object which carries default
  2091. settings and overrides (from command-line options and library use).
  2092. - Added internal Unicode support, and support for both input and
  2093. output encodings.
  2094. - Added support for the ``docutils.io.IO`` class & subclasses.
  2095. Specific:
  2096. * docutils/__init__.py:
  2097. - Added ``ApplicationError`` and ``DataError``, for use throughout
  2098. the package.
  2099. - Added ``Component`` base class for Docutils components; implements
  2100. the ``supports`` method.
  2101. - Added ``__version__`` (thus, ``docutils.__version__``).
  2102. * docutils/core.py:
  2103. - Removed many keyword parameters to ``Publisher.__init__()`` and
  2104. ``publish()``; bundled into an option values object. Added
  2105. "argv", "usage", "description", and "option_spec" parameters for
  2106. command-line support.
  2107. - Added ``Publisher.process_command_line()`` and ``.set_options()``
  2108. methods.
  2109. - Reworked I/O model for ``docutils.io`` wrappers.
  2110. - Updated ``Publisher.set_options()``; now returns option values
  2111. object.
  2112. - Added support for configuration files (/etc/docutils.conf,
  2113. ./docutils.conf, ~/.docutils).
  2114. - Added ``Publisher.setup_option_parser()``.
  2115. - Added default usage message and description.
  2116. * docutils/frontend.py: Added to project; support for front-end
  2117. (command-line) scripts. Option specifications may be augmented by
  2118. components. Requires Optik (http://optik.sf.net/) for option
  2119. processing (installed locally as docutils/optik.py).
  2120. * docutils/io.py: Added to project; uniform API for a variety of input
  2121. output mechanisms.
  2122. * docutils/nodes.py:
  2123. - Added ``TreeCopyVisitor`` class.
  2124. - Added a ``copy`` method to ``Node`` and subclasses.
  2125. - Added a ``SkipDeparture`` exception for visitors.
  2126. - Renamed ``TreePruningException`` from ``VisitorException``.
  2127. - Added docstrings to ``TreePruningException``, subclasses, and
  2128. ``Nodes.walk()``.
  2129. - Improved docstrings.
  2130. - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
  2131. - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
  2132. imports.
  2133. - Added ``decoration``, ``header``, and ``footer`` node classes, and
  2134. ``PreDecorative`` mixin.
  2135. - Reworked the name/id bookkeeping; to ``document``, removed
  2136. ``explicit_targets`` and ``implicit_targets`` attributes, added
  2137. ``nametypes`` attribute and ``set_name_id_map`` method.
  2138. - Added ``NodeFound`` exception, for use with ``NodeVisitor``
  2139. traversals.
  2140. - Added ``document.has_name()`` method.
  2141. - Fixed DOM generation for list-attributes.
  2142. - Added category class ``Labeled`` (used by footnotes & citations).
  2143. - Added ``Element.set_class()`` method (sets "class" attribute).
  2144. * docutils/optik.py: Added to project. Combined from the Optik
  2145. package, with added option groups and other modifications. The use
  2146. of this module is probably only temporary.
  2147. * docutils/statemachine.py:
  2148. - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
  2149. - Added underscores to improve many awkward names.
  2150. - In ``string2lines()``, changed whitespace normalizing translation
  2151. table to regexp; restores Python 2.0 compatibility with Unicode.
  2152. * docutils/urischemes.py:
  2153. - Filled in some descriptions.
  2154. - Added "shttp" scheme.
  2155. * docutils/utils.py:
  2156. - Added ``clean_rcs_keywords`` function (moved from
  2157. docutils/transforms/frontmatter.py
  2158. ``DocInfo.filter_rcs_keywords``).
  2159. - Added underscores to improve many awkward names.
  2160. - Changed names of Reporter's thresholds:
  2161. warning_level -> report_level; error_level -> halt_level.
  2162. - Moved ``utils.id()`` to ``nodes.make_id()``.
  2163. - Added ``relative_path(source, target)``.
  2164. * docutils/languages/de.py: German mappings; added to project. Thanks
  2165. to Gunnar Schwant for the translations.
  2166. * docutils/languages/en.py: Added "Dedication" bibliographic field
  2167. mappings.
  2168. * docutils/languages/sv.py: Swedish mappings; added to project by Adam
  2169. Chodorowski.
  2170. * docutils/parsers/rst/states.py:
  2171. - Added underscores to improve many awkward names.
  2172. - Added RFC-2822 header support.
  2173. - Extracted the inline parsing code from ``RSTState`` to a separate
  2174. class, ``Inliner``, which will allow easy subclassing.
  2175. - Made local bindings for ``memo`` container & often-used contents
  2176. (reduces code complexity a lot). See ``RSTState.runtime_init()``.
  2177. - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
  2178. - Added ``MarkupMismatch`` exception; for late corrections.
  2179. - Added ``-/:`` characters to inline markup's start string prefix,
  2180. ``/`` to end string suffix.
  2181. - Fixed a footnote bug.
  2182. - Fixed a bug with literal blocks.
  2183. - Applied patch from Simon Budig: simplified regexps with symbolic
  2184. names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
  2185. - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
  2186. - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
  2187. - Allowed non-ASCII in "simple names" (directive names, field names,
  2188. references, etc.).
  2189. - Converted ``Inliner.patterns.initial`` to be dynamically built
  2190. from parts with ``build_regexp()`` function.
  2191. - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
  2192. - Updated docstrings.
  2193. - Changed "table" to "grid_table"; added "simple_table" support.
  2194. * docutils/parsers/rst/tableparser.py:
  2195. - Changed ``TableParser`` to ``GridTableParser``.
  2196. - Added ``SimpleTableParser``.
  2197. - Refactored naming.
  2198. * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
  2199. a fallback language for directive names.
  2200. * docutils/parsers/rst/directives/html.py: Changed the ``meta``
  2201. directive to use a ``pending`` element, used only by HTML writers.
  2202. * docutils/parsers/rst/directives/parts.py: Renamed from
  2203. components.py.
  2204. - Added "backlinks" attribute to "contents" directive.
  2205. * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
  2206. project by Adam Chodorowski.
  2207. * docutils/readers/__init__.py: Gave Readers more control over
  2208. choosing and instantiating Parsers.
  2209. * docutils/readers/pep.py: Added to project; for PEP processing.
  2210. * docutils/transforms/__init__.py: ``Transform.__init__()`` now
  2211. requires a ``component`` parameter.
  2212. * docutils/transforms/components.py: Added to project; transforms
  2213. related to Docutils components.
  2214. * docutils/transforms/frontmatter.py:
  2215. - In ``DocInfo.extract_authors``, check for a single "author" in an
  2216. "authors" group, and convert it to a single "author" element.
  2217. - Added support for "Dedication" and generic bibliographic fields.
  2218. * docutils/transforms/peps.py: Added to project; PEP-specific.
  2219. * docutils/transforms/parts.py: Renamed from old components.py.
  2220. - Added filter for `Contents`, to use alt-text for inline images,
  2221. and to remove inline markup that doesn't make sense in the ToC.
  2222. - Added "name" attribute to TOC topic depending on its title.
  2223. - Added support for optional TOC backlinks.
  2224. * docutils/transforms/references.py: Fixed indirect target resolution
  2225. in ``Hyperlinks`` transform.
  2226. * docutils/transforms/universal.py:
  2227. - Changed ``Messages`` transform to properly filter out system
  2228. messages below the warning threshold.
  2229. - Added ``Decorations`` transform (support for ``--generator``,
  2230. ``--date``, ``--time``, ``--source-link`` options).
  2231. * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
  2232. Engelbert Gruber's PDF writer.
  2233. * docutils/writers/html4css1.py:
  2234. - Made XHTML-compatible (switched to lowercase element & attribute
  2235. names; empty tag format).
  2236. - Escape double-dashes in comment text.
  2237. - Improved boilerplate & modularity of output.
  2238. - Exposed modular output in Writer class.
  2239. - Added a "generator" meta tag to <head>.
  2240. - Added support for the ``--stylesheet`` option.
  2241. - Added support for ``decoration``, ``header``, and ``footer``
  2242. elements.
  2243. - In ``HTMLTranslator.attval()``, changed whitespace normalizing
  2244. translation table to regexp; restores Python 2.0 compatibility
  2245. with Unicode.
  2246. - Added the translator class as instance variable to the Writer, to
  2247. make it easily subclassable.
  2248. - Improved option list spacing (thanks to Richard Jones).
  2249. - Modified field list output.
  2250. - Added backlinks to footnotes & citations.
  2251. - Added percentage widths to "<col>" tags (from colspec).
  2252. - Option lists: "<code>" changed to "<kbd>", ``option_argument``
  2253. "<span>" changed to "<var>".
  2254. - Inline literals: "<code>" changed to "<tt>".
  2255. - Many changes to optimize vertical space: compact simple lists etc.
  2256. - Add a command-line options & directive attributes to control TOC
  2257. and footnote/citation backlinks.
  2258. - Added support for optional footnote/citation backlinks.
  2259. - Added support for generic bibliographic fields.
  2260. - Identify backrefs.
  2261. - Relative URLs for stylesheet links.
  2262. * docutils/writers/pep_html.py: Added to project; HTML Writer for
  2263. PEPs (subclass of ``html4css1.Writer``).
  2264. * docutils/writers/pseudoxml.py: Renamed from pprint.py.
  2265. * docutils/writers/docutils_xml.py: Added to project; trivial writer
  2266. of the Docutils internal doctree in XML.
  2267. * docs/tools.txt: "Docutils Front-End Tools", added to project.
  2268. * spec/doctree.txt:
  2269. - Changed the title to "The Docutils Document Tree".
  2270. - Added "Hyperlink Bookkeeping" section.
  2271. * spec/docutils.dtd:
  2272. - Added ``decoration``, ``header``, and ``footer`` elements.
  2273. - Brought ``interpreted`` element in line with the parser: changed
  2274. attribute "type" to "role", added "position".
  2275. - Added support for generic bibliographic fields.
  2276. * spec/notes.txt: Continual updates. Added "Project Policies".
  2277. * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
  2278. section.
  2279. * spec/pep-0257.txt: Clarified prohibition of signature repetition.
  2280. * spec/pep-0258.txt: Updated. Added text from pysource.txt and
  2281. mailing list discussions.
  2282. * spec/pep-0287.txt:
  2283. - Renamed to "reStructuredText Docstring Format".
  2284. - Minor edits.
  2285. - Reworked Q&A as an enumerated list.
  2286. - Converted to reStructuredText format.
  2287. * spec/pysource.dtd:
  2288. - Reworked structural elements, incorporating ideas from Tony Ibbs.
  2289. * spec/pysource.txt: Removed from project. Moved much of its contents
  2290. to pep-0258.txt.
  2291. * spec/rst/alternatives.txt:
  2292. - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
  2293. - Added "Inline External Targets" section.
  2294. * spec/rst/directives.txt:
  2295. - Added "backlinks" attribute to "contents" directive.
  2296. * spec/rst/problems.txt:
  2297. - Updated the Enumerated List Markup discussion.
  2298. - Added new alternative table markup syntaxes.
  2299. * spec/rst/reStructuredText.txt:
  2300. - Clarified field list usage.
  2301. - Updated enumerated list description.
  2302. - Clarified purpose of directives.
  2303. - Added ``-/:`` characters to inline markup's start string prefix,
  2304. ``/`` to end string suffix.
  2305. - Updated "Authors" bibliographic field behavior.
  2306. - Changed "inline hyperlink targets" to "inline internal targets".
  2307. - Added "simple table" syntax to supplement the existing but
  2308. newly-renamed "grid tables".
  2309. - Added cautions for anonymous hyperlink use.
  2310. - Added "Dedication" and generic bibliographic fields.
  2311. * test: Made test modules standalone (subdirectories became packages).
  2312. * test/DocutilsTestSupport.py:
  2313. - Added support for PEP extensions to reStructuredText.
  2314. - Added support for simple tables.
  2315. - Refactored naming.
  2316. * test/package_unittest.py: Renamed from UnitTestFolder.py.
  2317. - Now supports true packages containing test modules
  2318. (``__init__.py`` files required); fixes duplicate module name bug.
  2319. * test/test_pep/: Subpackage added to project; PEP testing.
  2320. * test/test_rst/test_SimpleTableParser.py: Added to project.
  2321. * tools:
  2322. - Updated html.py and publish.py front-end tools to use the new
  2323. command-line processing facilities of ``docutils.frontend``
  2324. (exposed in ``docutils.core.Publisher``), reducing each to just a
  2325. few lines of code.
  2326. - Added ``locale.setlocale()`` calls to front-end tools.
  2327. * tools/buildhtml.py: Added to project; batch-generates .html from all
  2328. the .txt files in directories and subdirectories.
  2329. * tools/default.css:
  2330. - Added support for ``header`` and ``footer`` elements.
  2331. - Added styles for "Dedication" topics (biblio fields).
  2332. * tools/docutils.conf: A configuration file; added to project.
  2333. * tools/docutils-xml.py: Added to project.
  2334. * tools/pep.py: Added to project; PEP to HTML front-end tool.
  2335. * tools/pep-html-template: Added to project.
  2336. * tools/pep2html.py: Added to project from Python (nondist/peps).
  2337. Added support for Docutils (reStructuredText PEPs).
  2338. * tools/quicktest.py:
  2339. - Added the ``--attributes`` option, hacked a bit.
  2340. - Added a second command-line argument (output file); cleaned up.
  2341. * tools/stylesheets/: Subdirectory added to project.
  2342. * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
  2343. Release 0.1 (2002-04-20)
  2344. ========================
  2345. This is the first release of Docutils, merged from the now inactive
  2346. reStructuredText__ and `Docstring Processing System`__ projects. For
  2347. the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
  2348. `DPS HISTORY`__ files.
  2349. __ http://structuredtext.sourceforge.net/
  2350. __ http://docstring.sourceforge.net/
  2351. __ http://structuredtext.sourceforge.net/HISTORY.html
  2352. __ http://docstring.sourceforge.net/HISTORY.html
  2353. General changes: renamed 'dps' package to 'docutils'; renamed
  2354. 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
  2355. the test suites (reStructuredText's test/test_states renamed to
  2356. test/test_rst); and all modifications required to make it all work.
  2357. * docutils/parsers/rst/states.py:
  2358. - Improved diagnostic system messages for missing blank lines.
  2359. - Fixed substitution_reference bug.
  2360. ..
  2361. Local Variables:
  2362. mode: indented-text
  2363. indent-tabs-mode: nil
  2364. sentence-end-double-space: t
  2365. fill-column: 70
  2366. End: