cpan/Pod-Simple/ChangeLog

   1 # ChangeLog for Pod::Simple dist
   2 #---------------------------------------------------------------------------
   3
   4 2009-12-17   David E. Wheeler <david@justatheory.org>
   5         * Release 3.13
   6
   7         Removed deleted test file from MANIFEST.
   8
   9 2009-12-17   David E. Wheeler <david@justatheory.org>
  10         * Release 3.12
  11
  12         Removed "All rights reserved" from all files.
  13
  14         Added acknowledgements to man.he.net and search.cpan.org for
  15         permission to link man pages and Perl module links to their sites
  16         in the output of Pod::Simple::HTML and Pod::Simple::XHTML.
  17
  18         Add "html_h_level" option to Pod::Simple::XHTML and ::HTML to allow
  19         a =head1 to become an <h2> and so on. RJBS.
  20
  21         Add batch_mode_page_object_init() method to Pod::Simple::XHTML.
  22         This allows it to be used by Pod::Simple::HTMLBatch.
  23
  24         Fixed a regression in Pod::Simple::XHTML where '=begin html' blocks
  25         were incorrectly escaped rather than simply passed through unmolested.
  26         RJBS.
  27
  28         Removed the undocumented "fullstop_space_harden" attribute, which
  29         apparently was only used by Pod::Text a very long time ago.
  30
  31 2009-12-09   David E. Wheeler <david@justatheory.org>
  32         * Release 3.11
  33
  34         Restored code to HTMLBatch that allows the TOC (index) to be created
  35         in batch jobs (RT #52324 from Martin J. Evans).
  36
  37         Added resources to META.yml, including bug tracker, license, and
  38         repository.
  39
  40         Turned man page links into links to man.he.net in Pod::Simple::HTML
  41         and Pod::Simple::XHTML output. Subclass and override
  42         resolve_man_page_link() to use a different URL.
  43
  44         Added the resolve_pod_page_link() and resolve_man_page_link() methods
  45         to Pod::Simple::XHTML to make it easier for subclasses to change the
  46         URLs created for POD and man page links.
  47
  48         Fixed the output of entities in L<> tags by Pod::Simple::XHTML.
  49
  50         Fixed the output of POD links from Pod::Simple::XHTML so that the
  51         section part (/foo) is turned into a proper fragment identfier (#foo)
  52         in the resulting search.cpan.org link.
  53
  54         Pod::Simple::Text now outputs URLs for links created in the
  55         L<text|URL> format. For example, L<Perl|http://perl.org> is now
  56         output as "Perl <http://perl.org>" rather than just as "Perl".
  57
  58         Updated perlpod.pod and perlpodspec.pod to sync up with Perl core
  59         (and to be released in Perl 5.12). Changes include:
  60         * Removing the prohibition against L<text|href>
  61         * Deprecation of L<section> and L<"section">
  62         * Legalization of "=begin formatname parameter"
  63
  64         A couple of bug fixes in Pod::Simple::HTML from Graham Barr.
  65
  66         Added the do_section() method to Pod::Simple::HTML. Graham Barr.
  67
  68         Word-smithed the "DESCRIPTION" a bit and wrote the README.
  69
  70         Synced up all module version numbers to 3.11 except for
  71         Pod::Simple::HTMLLegacy, which is at 5.01 and should not have its
  72         version number lowered.
  73
  74 2009-11-12   David E. Wheeler <david@justatheory.org>
  75         * Release 3.10
  76
  77         Converted test files that had DOS endings to have Unix endings
  78         (RT #50922 from Steve Hay).
  79
  80         Skip tests on VMS where the lack of filename case preservation can
  81         wreak havoc (RT #51184 from Craig A. Berry).
  82
  83         Fix nested definition list format in the XHTML output
  84         (RT #51187 from Lars Dɪᴇᴄᴋᴏᴡ).
  85
  86         Added some files missing from the MANIFEST (and therefore the
  87         distribution) in the last two releases.
  88
  89 2009-10-27   Allison Randal <allison@perl.org>
  90         * Release 3.09
  91
  92         Add support for an index (TOC) in the XHTML output from David E.
  93         Wheeler.
  94
  95         Add strip_verbatim_indent() from David E. Wheeler.
  96
  97         Added the "nocase" option to PullParser's get_title(),
  98         get_version(), get_description(), and get_author() methods. This
  99         allows one to fetch the contents of those sections regardless of
 100         the case of the labels (e.g., "NAME" and "Name" and "name" are all
 101         valid). Graham Barr.
 102
 103         Added the search_class() accessor to Pod::Simple::HTMLBatch.
 104         David E. Wheeler.
 105
 106         XHTML output now properly encodes entities in all places, not just
 107         in verbatim blocks and code spans. David E. Wheeler.
 108
 109         Fixed XHTML to output definition lists when it should, rather than
 110         (broken) unordered lists. David E. Wheeler.
 111
 112         Fixed XHTML so that multiparagraph list items work correctly.
 113         David E. Wheeler.
 114
 115         Fixed XHTML ordered list output so that it does not include the
 116         number specified in the POD in the output. This is on a par with
 117         out the HTML output works. David E. Wheeler.
 118
 119         Applied URL patch from Leon Brocard for The Perl Journal archives.
 120
 121         Fixed test failures with older versions of HTML::Entities (RT #43903
 122         from Salvador Tercia).
 123
 124         Changed CSS files generated by HTMLBatch to be no more than 8.3
 125         characters long. (RT #40450 from Renee Baecker)
 126
 127         Added entity handling for E<sol> and E<verbar> to Pod::Simple::XHTML.
 128         (RT #49615 from Chas Owens.)
 129
 130         Fixed a bug in Pod::Simple::HTML where a definition term item with
 131         no corresponding definition item would be output with no closing
 132         </a></dt>. (RT # 37107 from Kevin Ryde).
 133
 134         Added entity handling for numeric entities to Pod::Simple::XHTML,
 135         following perlpod specification.
 136
 137         A POD tag found inside a complex POD tag (e.g., "C<<< C<foo> >>>")
 138         is now properly parsed as text and entities instead of a tag
 139         embedded in a tag. This is in compliance with `perldoc perlpod`
 140         (RT #12239 from Michael Schwern).
 141
 142         Thanks to David E. Wheeler for applying patches, resolving bugs,
 143         and generally getting ready for the release.
 144
 145 2009-07-16   Allison Randal <allison@perl.org>
 146         * Release 3.08
 147
 148         Fix installdirs for Perl versions where Pod::Simple was core;
 149         RT#36446 & RT#39709, thanks to Jerry Hedden.
 150
 151         Fix encoding handling for code in paragraphs; RT#45829, thanks
 152         to David Wheeler.
 153
 154 2008-06-04   Allison Randal <allison@perl.org>
 155         * Release 3.07
 156
 157         Fix module dependencies, make HTML::Entities optional and require
 158         Test::More.
 159
 160 2008-06-03   Allison Randal <allison@perl.org>
 161         * Release 3.06
 162
 163         Fix bugs related to passing $1 to File::Spec, reported by Andrew Hamlin and
 164         John McNamara.
 165
 166         Applied a suggested fix from Kevin Ryde to return a successful exit
 167         code when Pod::Simple::HTML is run from the command line.
 168
 169         Fix handling of complex L<URL> entries, thanks to tests supplied in RT#4896.
 170
 171         Fix incorrect handling of S<> entries made up of entirely whitespace, thanks
 172         to test case from Andreas Koenig.
 173
 174         Launch Pod::Simple::XHTML, an XHTML compliant, more easily extensible
 175         HTML formatter.
 176
 177         Add feature to parse additional text after =begin target as a block
 178         title, requested by Adam Kennedy.
 179
 180         Thanks to Hans Dieter Pearcey for applying patches, resolving bugs,
 181         and generally getting ready for the release.
 182
 183 2007-03-03   Allison Randal <allison@perl.org>
 184         * Release 3.05
 185
 186         Standardized all test files on 8.3 naming scheme for Perl core.
 187
 188         Applied test patches from Jerry Hedden for Perl core when
 189         Encode not installed.
 190
 191         Applied test patch from Ken Williams for 5.005_04 compatibility.
 192
 193         Applied a patch from Christopher Madsen to fix architecture
 194         directory searches on Gentoo.
 195
 196         Fixed a failing search test on Debian-based distributions caused
 197         by Debian stripping Pod documentation out of core modules.
 198         (Three cheers to the CPAN testers and James Ponza for sending
 199         enough reports that I could work out the pattern.)
 200
 201 2006-01-18   Allison Randal <allison@perl.org>
 202         * Release 3.04
 203
 204         Applied test patches for Perl core integration from Steve Peters.
 205
 206         Added a 'reinit' method to Pod::Simple::BlackBox for Russ Allbery
 207         so Pod::Man can provide backward compatibility to existing users
 208         (such as Module::Build and ExtUtils::MakeMaker).
 209
 210         Applied patch for extracting case-preserved package names on VMS
 211         from Craig Berry.
 212
 213 2005-11-21   Allison Randal <allison@perl.org>
 214         * Release 3.03
 215
 216         Applied whitespace patches for Pod::Man and Pod::Text from
 217         Russ Allbery.
 218
 219         Applied validation patches to Pod::Simple::HTML from Graham Barr.
 220
 221 2004-05-24   Sean M. Burke <sburke@cpan.org>
 222         * Release 3.02
 223
 224         Just fixing some typos in the CSS generated by Pod::Simple:HTMLBatch.
 225
 226
 227 2004-05-24   Sean M. Burke <sburke@cpan.org>
 228         * Release 3.01
 229
 230         No big changes to the main modules, but there's many changes to
 231         the important Pod::Simple::HTML module.
 232
 233         Also, new modules:
 234           Pod::Simple::HTMLBatch
 235           Pod::Simple::HTMLLegacy
 236           Pod::Simple::Progress
 237           Pod::Simple::Search
 238         and tests for these (well, most).
 239
 240         Some prettying up of the Makefile.PL.
 241
 242         The test 00about.t is a bit more careful and verbose now.
 243
 244         The docs are still incomplete, esp. for Pod::Simple::HTML and
 245         Pod::Simple::HTMLBatch, which I hope to improve quite soon.
 246
 247
 248
 249 2004-05-07   Sean M. Burke <sburke@cpan.org>
 250         * Release 2.06
 251
 252         Allison Randal brilliantly refactors a huge monolithic sub in
 253         Blackbox.pm.  Code is now actually sanely readable!
 254
 255         I add the new option-attributes fullstop_space_harden and
 256         codes_in_verbatim, and the two methods abandon_output_string and
 257         abandon_output_fh.  Not yet documented.
 258
 259         New test fullstop_spaces.t and new corpus document
 260         greek_iso_8859_7.pod.
 261
 262         Another version should be forthcoming in a few days that has the
 263         new Pod::Simple::HTML stuff in it.
 264
 265         Note to self: document =extend and =encoding in perlpodspec ASAP!
 266
 267
 268 2003-11-04  Sean M. Burke <sburke@cpan.org>
 269         * Release 2.05 -- bugfix version
 270
 271         In an attempt to stop Perl 5.6 versions from going completely
 272         crazy, I've tried to basically turn off all Unicode/utf8 support
 273         under 5.6. Under 5.8 and above, Unicode should work fine, and
 274         under 5.6, all Unicode characters should be replaced with a little
 275         "can't render" symbol, either a "¤" or a "?".
 276         Many many thanks to Jarkko Hietaniemi for helping out.
 277
 278         (Works under 5.005 now too?)
 279
 280 2003-10-10  Sean M. Burke <sburke@cpan.org>
 281         * Release 2.04 -- minor bugfix version
 282
 283         * Added some code to insulate Pod::Simple to runtime changes in
 284         the value of $/.  Thanks to Iain Truskett for catching this.
 285         * Added FILENO method to TiedOutFH.pm, to work quietly under some
 286         perls.  Thanks to Jochen Stenzel for catching this.
 287         * Fixed some tests that erroneously failed under some 5.6's
 288         because of chdir()s in *.t files messing up @INC  Thanks to many
 289         who caught this, including Rocco Caputo.
 290
 291 2003-09-07  Sean M. Burke <sburke@cpan.org>
 292         * Release 2.03 -- minor upgrade
 293         * A =head[1234] command now closes any currently open =over, and
 294         warns.
 295         * Fixing a few obscure bugs, including one to do with the
 296         Makefile.
 297         * Added some tests for those bugs.
 298
 299 2003-09-02  Sean M. Burke <sburke@cpan.org>
 300         * Release 2.02 -- fixing a testing bug
 301         * Autrijus Tang found a silly bug of mine in corpustest.t's
 302         testing of corpus/t/nonesuch.txt.  Fixed,
 303         * I add encoding_nonesuch.t to test corpus/t/nonesuch.txt better.
 304
 305
 306 2003-09-01  Sean M. Burke <sburke@cpan.org>
 307         * Release 2.01
 308         * Moved all version numbers up to 2.01 for reasons of Tibetan
 309         numerology.
 310
 311         * Implemented =encoding.  Thanks a million to Jarkko, Autrijus,
 312         Dan Kogai, and many others for their help, patience, and
 313         encouragement.
 314
 315         It's not yet documented, but see ./t/corpus/*.txt for examples at
 316         least.
 317
 318         * Added 'use utf8' to all the modules.  Byebye perl-5.005
 319         compatibility, hello decent perl-5.6 compatibility.
 320
 321 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 322
 323 2003-09-01  Sean M. Burke <sburke@cpan.org>
 324         * Release 0.98
 325         * At Michael Schwern's suggestion, a list that begins with a
 326         "=item [number]" line where number isn't a 1, is no longer
 327         treated as an error, but instead is silently coerced into being a
 328         text-item list, just as if it were "=item wubble" or whatever.
 329
 330 2003-08-12  Sean M. Burke <sburke@cpan.org>
 331         * Release 0.97
 332         * Loooking goooooood.  Not smelling so much like beta anymore!
 333         * I think this might be the last version before I go
 334         putting "use utf8" all over the place.
 335
 336         * Added placefolders for "=encoding" support.  If you use
 337         "=encoding", you'll get an error about "not yet implemented"
 338         instead of "unknown directive".
 339
 340         * Rewrote Pod::Simple::Pullparser's get_title, and added
 341         get_version, get_author, and get_description.  Documented them.
 342         Thanks to Graham Barr for contributing an initial get_title and
 343         then being patient while I seemed to do nothing with it for months
 344         on end!
 345
 346         * More tests.
 347
 348         Otherwise just minor changes since last version:
 349         * Fixed error in Pod::Simple::RTF.
 350         * Added new but undocumented methods to Pod::Simple:
 351            unaccept_directive(s) unaccept_target(s) unaccept_code(s)
 352         * Corrected '=back without =open' error to '=back without =over'
 353         * A little tweaking to the _verbatim_format code.
 354         * Dump routines may use \x{NN} instead of \xNN format.
 355         * Pod::Simple::HTML now uses VerbatimFormatted
 356         * A few changes ot DEBUG messages -- nothing you'd normally see.
 357
 358 2002-11-19  Sean M. Burke <sburke@cpan.org>
 359         * Release 0.96
 360         * Still kinda sorta beta.
 361
 362         * Much much more docs in this version.  Only a few feature
 363         changes:
 364
 365         * Added any_errata_seen to Pod::Simple.  Should've been in there
 366         ages ago.  Oops!
 367         * Fixed some errors in the experimental VerbatimFormatted code.
 368         * Added is_tagname / is_tag to Pod::Simple::PullParserStartToken
 369         and Pod::Simple::PullParserEndToken
 370         * Added RTFDEFLANG stuff to Pod::Simple::RTF.
 371
 372 2002-11-10  Sean M. Burke <sburke@cpan.org>
 373         * Release 0.95
 374         * Beta release.  Much documentation still to write, many features
 375         still to add.  The APIs might change in future versions.
 376
 377         * Now including perlpod and perlpodspec in the dist.
 378
 379         * Pod::Simple -- added parse_from_file
 380         * Pod::Simple::RTF -- minor style changes, and minor change to the
 381         RTF-wrapping logic.
 382         * Pod::Simple::BlackBox -- a =cut opening a block is no longer a
 383         fatal(ish) error.
 384         * Pod::Simple::BlackBox -- added experimental new
 385         VerbatimFormatted stuff.
 386
 387
 388 2002-10-16  Sean M. Burke <sburke@cpan.org>
 389         * Release 0.94
 390         * Beta release.  Much documentation still to write, many features
 391         still to add.  The APIs might change in future versions.
 392
 393         * Pod::Simple::RTF -- minor style tweaks
 394         * Pod::Simple::PullParserEndToken and ::PullParserStartToken --
 395         added ->tag as an alias for ->tagname.
 396         * Pod::Simple and Pod::Simple::BlackBox -- added tolerance for
 397         "=item * Foo" as a variant syntax for "=item *\n\nFoo".  Tests
 398         added/changed accordingly.
 399         * Pod::Simple::HTML -- added <a name="..."> stuff, and a hack at
 400         doing something with X<...>'s.
 401
 402
 403 2002-09-29  Sean M. Burke <sburke@cpan.org>
 404         * Release 0.93
 405         * Beta release.  Much documentation still to write, many features
 406         still to add.  The APIs might change in future versions.
 407
 408         * Pod::Simple -- added errors_seen attribute
 409         * Pod::Simple::HTML -- added support for =for HTML ... directives,
 410         and =extend directives.
 411         * Oh, and I added Pod::Simple::RTF in 0.92 but forgot to note it
 412         until now.
 413
 414 2002-09-29  Sean M. Burke <sburke@cpan.org>
 415         * Release 0.92
 416         * Beta release.  Much documentation still to write, many features
 417         still to add.  The APIs might change in future versions.
 418
 419         * Fixing bungled distribution.
 420
 421 2002-09-29  Sean M. Burke <sburke@cpan.org>
 422         * Release 0.91
 423         * Beta release.  Much documentation still to write, many features
 424         still to add.  The APIs might change in future versions.
 425
 426         * Pod::Simple::PullParserTextToken -- added 'text_r'
 427
 428         * Pod::Simple::PullParser -- added 'get_title' and
 429         'get_title_short' to
 430
 431         * Pod::Simple -- corrected wording of "Format for second =extend
 432         parameter" error message.
 433
 434         * Pod::PullParser -- made its filter() run as intended, like
 435         Pod::Simple's filter.
 436
 437         * Pod::Subclassing -- more docs
 438
 439 2002-09-11  Sean M. Burke <sburke@cpan.org>
 440         * Release 0.90
 441         * Beta release.  Much documentation still to write, many features
 442         still to add.  The APIs might change in future versions.