cpan/Pod-Simple/ChangeLog

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