prest/ChangeLog

   1 .. -*-rst-*-
   2
   3 Release Notes
   4 ===============
   5
   6 .. contents::
   7
   8 Release 0.3.37
   9 --------------
  10
  11 reStructuredText parsing:
  12
  13 * Added "-D relax-citation-characters" option.
  14 * Added roles "mathml-display" and "mathml-inline" to force
  15   display/inline mode.
  16 * Role name is now passed in as fourth argument to role attribute
  17   subroutines.
  18 * DefineRole now allows defining other info about the role than just
  19   its options.
  20 * Plug-in directives can now have an init routine that gets called to
  21   define and initialize them.
  22 * Plug-ins can now define roles as well as directives.
  23 * Roles can now define a reparse option which will cause the output to
  24   be reparsed as reStructuredText.
  25
  26 Writer 'latex':
  27
  28 * Added "-W chapter" and "-W cloak-email-addresses" options.
  29 * Added a new '\styleliteralblock' style command.
  30 * Fixed a problem with inferring minus signs.
  31 * Fixed a problem with converting opening single quotes.
  32 * Fixed handling of raw latex.
  33
  34
  35 Release 0.3.36
  36 --------------
  37
  38 Directive 'code-block':
  39
  40 * Allow the 'states' executable to be found anywhere on the path, but
  41   check standard locations first.
  42
  43 Writer 'latex':
  44
  45 * Sort the dependent \usepackage modules so that there is a canonical
  46   order for regression testing
  47
  48 Writer 'index':
  49
  50 * Sort the inline targets so that there is a canonical order for
  51   regression testing
  52
  53 Release 0.3.35
  54 --------------
  55
  56 There were no functional changes in this release.
  57
  58 Fixed the latex simple test not to use a code-block directive, which
  59 compiles differently on different machines.
  60
  61 Release 0.3.34
  62 --------------
  63
  64 reStructuredText transforms:
  65
  66 * Fixed a bug with hyperlink resolution when a chained target went to
  67   an indirect target to an internal target.
  68
  69 Writer 'index':
  70
  71 * Fixed a bug in dealing with raw DOM objects.
  72
  73 Writer 'latex':
  74
  75 * Fixed bugs in line blocks
  76 * Fixed bugs in parsed literals
  77 * Fixed a bug where a paragraph ending in an interpreted text item did
  78   not result in a new paragraph
  79 * Fixed a bug with processing quotes around marked up text
  80 * Fixed a bug with special characters in options
  81 * Added support for outputting mathml to latex (requires
  82   Text::ASCIIMathML 0.4 or later)
  83
  84 Release 0.3.33
  85 --------------
  86
  87 There were no functional changes in this release.
  88
  89 * Fixed some tests and expects to be compatible with perl 5.9.5.
  90 * Modified Makefile.PL hopefully to be compatible with more versions
  91   of make.
  92 * Changed the way the system plug-in directive gets the message from
  93   STDERR so that it will hopefully be compatible with more systems.
  94
  95 Release 0.3.32
  96 --------------
  97 prest script:
  98
  99 * Generated a fatal error if an input file cannot be opened.
 100
 101 ReStructuredText parsing:
 102
 103 * The target role now keeps the case of the target in creating its
 104   name.
 105
 106 Writer 'html':
 107
 108 * Process the :class: option on images.
 109 * If the "-W image-exts" option is used (it's actually deprecated in
 110   favor of "-D image-exts"), the default alt attribute now also uses
 111   the substituted extension.
 112
 113 Writer 'index':
 114
 115 * Improved help text.
 116 * Added "-W index-indirect-targets" option.
 117 * Added "-W index-role-target" option.
 118
 119 Writer 'xref':
 120
 121 * Added a "-W xref-role-target" option to specify which target role
 122   (if any) should be used for cross references.
 123 * The "-W xref-role-targets" option has been removed.
 124
 125 In general:
 126
 127 * Recoded to remove most dependencies on internal structure of DOM
 128   objects outside of DOM.pm.
 129
 130 Release 0.3.31
 131 --------------
 132 ReStructuredText parsing:
 133
 134 * Added a "target" role that allows separation of inline target tags
 135   from the text that is displayed.
 136 * Fixed a bug where, if two items in an enumerated list occurred with
 137   no blank line between them and a third item was separated by a blank
 138   line, the third item was put into a separate list.
 139
 140 Directive 'perl':
 141
 142 * Exported the following new global variables: ``$DIRECTIVE`` and
 143   ``$PARSER``.
 144
 145 Writer 'html':
 146
 147 * Mark a single paragraph in a compound as both class "compound-first"
 148   and "compound-last".
 149 * Fixed a bug where a class attribute on a field list did not
 150   propagate to the output.
 151 * Fixed a bug where an align attribute on a table did not propagate to
 152   the output.
 153
 154 Writer 'index':
 155
 156 * Implemented the '-W doc-titles' and '-W index-role-targets' options.
 157 * Output nothing instead of an empty table if there are no index
 158   entries.
 159
 160 Writer 'xref':
 161
 162 * Added the ``-W xref-role-targets`` option.
 163 * Allowed the suffix to be an empty string.
 164
 165 Release 0.3.30
 166 --------------
 167 * Fixed problem with find command in Makefile.PL that used a Linuxism.
 168 * Made most of the perl modules use the subversion release as version number.
 169
 170 Release 0.3.29
 171 --------------
 172 * Renamed ReleaseNotes.txt to ChangeLog so that it will appear as a
 173   special file on CPAN.
 174 * Made one more effort to fix the indexing of version numbers.
 175
 176 Release 0.3.28
 177 --------------
 178 * Create lib/Text/Restructured.pm from lib/Text/Restructured.pm.PL so
 179   we can insert the version number in to allow CPAN to index it
 180   correctly.
 181 * Fixed a problem with creating regular-expression expects for tests.
 182
 183 Release 0.3.27
 184 --------------
 185 Fixed problem with CPAN indexing of versions.
 186
 187 Release 0.3.26
 188 --------------
 189 * Completely reworked the regression test structure so as not to be
 190   dependent upon GNU make.
 191
 192 Writers 'dom' and 'xml':
 193
 194 * Fixed a bug with attribute strings that contain double quotes.
 195
 196
 197 Release 0.3.25
 198 --------------
 199 * Fixed a problem with Makefile.PL.
 200
 201 ReStructuredText parsing:
 202
 203 * Don't write messages to STDERR for errors in directives in test
 204   data.
 205
 206 Writer 'html':
 207
 208 * Fixed a problem with quote markes in "alt" image text.
 209 * Added "-W body-only" flag.
 210
 211 Release 0.3.24
 212 --------------
 213 * Fixed problems with running with -T.
 214 * Fixed Makefile.
 215
 216 Release 0.3.23
 217 --------------
 218 * Fixed the help to parse as reStructuredText.
 219 * Execute evals in ``Text::Restructured::Writer::Eval`` instead of ``Eval_::``.
 220 * Initialize some of the opt variables to avoid warnings if not driven
 221   by prest.
 222
 223 ReStructuredText parsing:
 224
 225 * Added "-D image-exts" flag so that each writer doesn't have to
 226   support the functionality separately.
 227
 228 Writer 'html':
 229
 230 * Added "-W enum-list-prefixes" flag.
 231 * Documentation deprecates "-W image-exts".
 232
 233 Writer 'latex':
 234
 235 * Be more lenient about including graphics for files that aren't in
 236   the current directory.
 237 * Fixed the processing of raw DOM elements to ignore those not
 238   intended for latex.
 239 * Added a newline before admonitions so they're processed in vertical
 240   mode.
 241
 242 Writer 'toc':
 243
 244 * Added "-W parent-role" flag.
 245
 246
 247
 248 Release 0.3.22
 249 --------------
 250
 251 Release 0.3.21
 252 --------------
 253
 254 Updated the ``toc`` writer to have expanded abilities with the ``-W
 255 file-suffix`` option.
 256
 257 Fixed the Makefile.PL so that hopefully at least some platforms will
 258 pass regression tests.
 259
 260 Added release notes to the prest documentation.
 261
 262 Release 0.3.20
 263 --------------
 264
 265 Made the ``html``, ``toc``, and ``xref`` writers compatible with
 266 non-breaking spaces in Perl 5.8.0 implementation of Unicode.  (Unicode
 267 implementation was fixed in Perl 5.8.6.)
 268
 269 All ``-D`` or ``-W`` option names can use either hyphens ("-") or
 270 underscores ("_") for word separators; internally everything uses
 271 underscores.
 272
 273 reStructuredText parsing:
 274
 275 * Added hyphens to the following ``-D`` options: ``entry-attr``,
 276   ``include-ext``, ``include-path``, ``nest-inline``, ``perl-path``,
 277   ``row-attr``, ``table-attr``.
 278 * Added the following ``-D`` options: ``file-insertion-enabled``,
 279   ``ignore-include-errs``, ``raw-enabled``.
 280 * Fixed a bug where explicit targets were not permitted within an
 281   embedded url (e.g., '``reference <#explicit-target>``').
 282 * Don't consider targets defined on the same source/line number to be
 283   duplicate targets (can happen with multiply-included files).
 284 * Fixed the checking for inconsistent title levels to be more robust.
 285 * Keep an ``@INCLUDES`` array to keep track of the include stack.  This
 286   variable can be accessed in a ``perl``/``if`` directive.
 287 * Fixed a bug where large grid tables could result in a deep
 288   recursion error.
 289
 290 reStructuredText transforms:
 291
 292 * Added the ``-D docinfo-levels`` option.
 293 * Changed the documentation to show the ``-D`` options with hyphens ("-")
 294   instead of underscores ("_") separting words.
 295 * The ``sectnum`` directive now processes starting from its containing
 296   section, rather than from the top of the DOM tree.
 297
 298 Directive '``raw``':
 299
 300 * Added a ``:head:`` option.
 301
 302 Directive '``if``':
 303
 304 * Export the ``$SOURCE``, ``$LINE``, and ``@INCLUDES`` for use in Perl
 305   code.
 306
 307 Directive '``perl``':
 308
 309 * Implemented ``:file:`` option.
 310 * Exported ``@INCLUDES``.
 311
 312 Directive '``sectnum``':
 313
 314 * Added a ``:prefix-title:`` option.
 315
 316 Writer '``html``':
 317
 318 * Inserted hyphen in the ``-W body-attr`` option.
 319 * Updated for adding hyphens to the following ``-D`` options:
 320   ``table-attr``, ``entry-attr``, ``row-attr``.
 321 * Added ``-W image-exts`` option.
 322 * Added support for ``:head:`` option of ``raw`` DOM.
 323 * Fixed a bug with targets.
 324 * Fixed a potential undefined variable warning for footnote references.
 325
 326 Writer '``index``':
 327
 328 * Changed documentation for ``-W`` options to use hyphens ("-") instead of
 329   underscores ("_") between words.
 330 * Implemented ``-W output-header`` and ``-W title-underline`` options.
 331 * Changed implementation to use a ``compound`` directive instead of a
 332   ``raw`` directive to set the class for the generated contents.
 333 * Removed a potential undefined variable warning for indirect targets.
 334
 335 Writer '``toc``':
 336
 337 * Updated documentation to show ``-W`` options with hyphens ("-") instead of
 338   underscores ("_") to separate words.
 339 * Restructured for simplicity.
 340 * Changed the way non-breaking spaces are removed from generated DOM
 341   objects since the auto-numbering may have things other than numbers
 342   in it.
 343
 344 Writer '``xref``':
 345
 346 * Added the following ``-W`` options: ``appendix``, ``chapter``,
 347   ``section``, ``xref-sections``, ``xref-targets``.
 348 * Restructured the code for simplification.
 349
 350 Release 0.3.19
 351 --------------
 352 Added support for ascii-mathml role and directive to produce mathml
 353 markup.  The mathml markup is only supported in the ``dom`` and ``html``
 354 writers for now.
 355
 356 Release 0.3.18
 357 --------------
 358
 359 Went through code coverage reports and updated the tests to bring the
 360 line and condition coverage up to 100% (except the soon-to-be-outdated
 361 ``latex`` writer).  This analysis resulted in the following fixes:
 362
 363 Prest application:
 364
 365 * Fixed a bug where help prints out multiple times if there are
 366   duplicate writers.
 367 * Relocated all the code for parsing and interpreting writer schemas
 368   to ``Text::Restructured::Writer``.
 369 * Fixed the version number not to end with a period.
 370 * Don't use ``FindBin`` to append the directory in which the script is
 371   found to its ``@INC`` path.
 372 * Don't convert digits in ``-W`` options to underscores.
 373 * Removed code for parsing DOM files to ``Text::Restructured::DOM::Parse``.
 374 * Insert blank line in usage before "Descriptions of Plug-in
 375   Directives" and "Descriptions of Writers".
 376
 377 reStructuredText parsing:
 378
 379 * Stricter option checking in most directives.
 380 * Removed package globals and incorporated into a parser object.
 381 * Initialize ``ANONYMOUS_TARGETS`` in init.
 382 * Fixed the handling of inline literals in definition lists.
 383 * Put a system message in the document rather than dying if a plug-in
 384   directive fails to compile.
 385 * Simplified the code by removing tests whose conditions were
 386   invariant.
 387 * Fixed an infinite loop that could come up in processing nested
 388   inline markup.
 389 * Fixed an infinite loop that could come up if a line block started
 390   with two or more blank lines.
 391 * Fixed the removal of inline markup characters from normalized names.
 392 * Have ``include`` directive do nothing if the file is empty, as opposed
 393   to returning an empty paragraph.
 394 * Added checks for the ``:prefix:`` and ``:suffix:`` options to the
 395   ``role`` directive to be sure they're formatted correctly.
 396 * Return a system message if the title in a table-type directive is
 397   not a single paragraph.
 398 * Merged the code for ``csv-table`` and ``list-table`` directives to the
 399   extent possible.
 400 * Fixed the ``:class:`` option for ``target-notes``.
 401
 402 reStructuredText transforms:
 403
 404 * Simplified code by removing branches whose conditions were
 405   invariant.
 406 * Return a system message if evaluating transform code results in an
 407   error.
 408 * Process ``:class:`` option for ``target-notes`` directive.
 409 * Allow ``decorations`` transform to put in link to prest documentation if
 410   DOCURL is specified.
 411
 412 Directive '``code_block``':
 413
 414 * Added ``-D code-block-states-file`` option.
 415 * Do line numbering whether or not states can be run if
 416   ``:numbered:``.
 417
 418 Directive '``system``':
 419
 420 * Return a ``PCDATA`` DOM if in a substitution definition context (instead
 421   of appending it).
 422 * Don't add a null paragraph if the text is empty.
 423
 424 Writer '``dom``':
 425
 426 * Updated to use ``$writer`` argument to access ``ProcessDOMPhase``.
 427
 428 Writer '``html``':
 429
 430 * Changed the semantics of ``-W embed-stylesheet`` and ``-W stylesheet``.
 431 * Added ``-W stylesheet2`` option to specify a secondary embedded stylesheet.
 432 * Changed default of ``-W field-limit`` to 14 from 15.
 433 * Reworked so all the writer's annotations are in DOM's ``{_html}`` member.
 434 * Reworked so that DOM's ``{attr}`` member is read-only; HTML attributes
 435   are all copied to ``{_html}{attr}`` member.
 436 * Factored out much of the attribute handling into a ``GetAttr`` routine.
 437 * Fixed output of literals embedded in literals.
 438
 439 Writer '``index``':
 440
 441 * Restructured code for simplification
 442 * Pass the a writer argument into ``QuoteStart``.
 443 * Fixed processing of ``-W short-titles``.
 444 * Added handler for interpreted roles.
 445
 446 Writer '``toc``':
 447
 448 * Simplified code for ``generated``.
 449
 450 Writer '``xref``':
 451
 452 * Simplified code for substitution definitions.
 453
 454 Release 0.3.17
 455 --------------
 456 Did not exist.
 457
 458 Release 0.3.16
 459 --------------
 460 Updated manifest to add files that will allow the regression to pass
 461 on machines with differing locales.
 462
 463 Release 0.3.15
 464 --------------
 465 Added test files to fix problems when different locales use different
 466 text for system error messages.
 467
 468 Prest application:
 469
 470 * Fixed problem that caused bare subroutines in writers to be compiled
 471   more than once.
 472 * Removed the path out of the subroutine names created when compiling
 473   writer routines.
 474 * Fixed the ``#line`` directives for writer subroutines so that better
 475   error messages/coverage results are obtained.
 476
 477 Made writers more efficient by renaming package subroutines to ``BEGIN``
 478 so that they will always be called exactly once.
 479
 480 Writer '``html``':
 481
 482 * Incorporated changes in docutils ``html`` writer:
 483
 484   * No longer change double-quotes to "``&quot;``".
 485   * No longer put a newline after a ``<pre>``.
 486
 487 Release 0.3.14
 488 --------------
 489 First release that was indexable on CPAN.