Update podlators to version 4.03
[perl.git] / cpan / podlators / Changes
1                       User-Visible podlators Changes
2
3 podlators 4.03 (2015-12-06)
4
5     Fix tests when POD_MAN_DATE or SOURCE_DATE_EPOCH are already set in
6     the environment.  Thanks, Niko Tyni.  (Debian Bug#807086)
7
8     Continue general improvements and refactoring of the test suite to
9     make it more maintainable and clean out duplicate or unnecessary code.
10
11 podlators 4.02 (2015-12-02)
12
13     For versions of Perl prior to 5.11, install the modules into the Perl
14     core module directories, since in those versions site modules did not
15     take precedence over Perl core modules.  Thanks, Peter Rabbitson.
16     (#110024)
17
18 podlators 4.01 (2015-12-01)
19
20     [Pod::Text::Termcap] Do not override the TERMPATH environment variable
21     if it's already set.  This should fix the test suite with Term::Cap
22     1.16 (which has a bug in termcap handling if TERMPATH doesn't point to
23     a valid file).  Also document the manipulation of TERMPATH.
24
25     Revert the switch to Module::Build as the build system.  This creates
26     a circular dependency with Module::Build, since it wants a newer
27     version of Pod::Man than in Perl versions prior to 5.10.1.  Instead,
28     add the new metadata to Makefile.PL and stick with a single build
29     system that will also work inside Perl core.
30
31 podlators 4.00 (2015-11-28)
32
33     Increase the version number of the package to be larger than any of
34     the previous version numbers of any of the modules, and change all
35     modules to use the same version as the overall podlators package.
36     Switch to a simple decimal version number to avoid complexity with
37     v-strings and portability to old versions of Perl.
38
39     podlators now requires Perl 5.006 or later.  All modules enable
40     warnings.  Please report any unexpected or confusing warnings as bugs
41     in the bug tracker.
42
43     [pod2man] In previous versions, the -r or --release option could be
44     specified without an argument and was interpreted as setting that
45     value to the empty string.  That never made a great deal of sense, and
46     the original change to Perl was apparently because no one realized one
47     could pass the empty string as the argument value.  The argument is
48     now mandatory, but may be the empty string, which will cause some
49     *roff implementations to use the system default.
50
51     Allow any even number of characters to be specified as the quote marks
52     for Pod::Text and Pod::Man (and the corresponding --quotes options of
53     pod2text and pod2man), rather than being artificially limited to one-
54     or two-character quotes.  The first half of the string will be used as
55     the left quote and the second half as the right quote.  This allows
56     Unicode characters or groff escapes like \(lq and \(rq to be used.
57     (Partly addresses #103298)
58
59     [Pod::Man] Attempt to detect if the input came from a pipe and
60     therefore has a completely unhelpful (and nonreproducible) source file
61     name, and diagnose this as an error.  Document that the name option
62     (--name to pod2man) is required when processing POD source from
63     standard input.  (Debian Bug#777405)
64
65     [Pod::Man] Honor the environment variable SOURCE_DATE_EPOCH and use it
66     as the timestamp from which to derive the left-hand footer if the date
67     option is not set, overriding the timestamp of the input file.  This
68     is primarily useful to ensure reproducible builds of the same output
69     file given the same souce and Pod::Man version, even when file
70     timestamps may not be consistent.  Thanks, Niko Tyni.  (Debian
71     Bug#801621)
72
73     [Pod::Man] Honor the environment variable POD_MAN_DATE and use its
74     contents, if set, as the value of the left-hand footer if the date
75     option is not set, overriding the timestamp of the input file.  This
76     was an earlier version of SOURCE_DATE_EPOCH, but has been supported in
77     Debian for a while and doesn't serve exactly the same purpose, so both
78     continue to be supported.  Thanks, Niko Tyni.
79
80     [Pod::Man] The default left-hand footer date is now based on UTC
81     rather than the local time zone to make the output more reproducible.
82     Thanks, Chris Lamb.  (Debian Bug#780259)
83
84     [Pod::Man] Simplify the preamble code for handling the F register and
85     index entries, and add backslashes after the braces in the preamble
86     code for handling the F register to avoid introducing a spurious page
87     break before at the first page with AT&T *roff.  Thanks, Carsten
88     Kunze and Daphne Pfister.  (#92979)
89
90     [Pod::Man] Support setting the left-hand footer to the empty string.
91
92     Fix documentation of the utf8 option to Pod::Man and Pod::Text, and
93     the corresponding -u option to pod2man and pod2text, to reflect that
94     Pod::Simple now autodetects Latin-1 and UTF-8 but warns.
95
96     More clearly document the options that set values in the .TH header in
97     the pod2man and Pod::Man documentation.  Thanks, Guillem Jover.
98     (#103297)
99
100     [Pod::Text] Fix encoding handling in documents that start without an
101     encoding declaration and then declare an encoding partway through.
102     Previously, this would result in attempts to print wide characters if
103     there were non-ASCII characters in the document.  Thanks, Magnolia K.
104     (#101722)
105
106     [Pod::Text] Change the documentation to not say Pod::Text only
107     generates ASCII text.  (#89355)
108
109     Switch the preferred module build system to Module::Build, but still
110     provide a Makefile.PL file for backward compatibility and for the use
111     of Perl core.  (#108714)
112
113     Installation of this package no longer tries to overwrite the Pod::Man
114     and Pod::Text modules that come with Perl core, and instead relies on
115     the normal precedence rules in Perl's module search path that prefer
116     locally-installed modules over core modules.
117
118     Rename NEWS to Changes to match the normal Perl convention.
119
120     Work around a bug in Term::Cap 1.16 that caused the test suite to fail
121     by forcing a setting of TERMPATH to a termcap file provided by the
122     test suite while running tests.  (#98272)
123
124 podlators 2.5.3 (2013-10-05)
125
126     Fix documentation of the default for the errors constructor parameter.
127
128     Skip the empty text and man page errors tests if Pod::Simple didn't
129     produce any errors, which happens with the version shipped with Perl
130     versions prior to 5.18.  Catch warnings as well as exceptions in these
131     tests.
132
133 podlators 2.5.2 (2013-09-22)
134
135     The parse_lines and parse_string_document methods in Pod::Man and
136     Pod::Text now set a default output file handle of STDOUT if none was
137     set.
138
139     Perform document initialization even if the document is contentless.
140     Documents with only errors are shown as contentless but then have a
141     POD ERRORS section, and previously this led to internal errors because
142     state variables weren't properly initialized.  Thanks, Andreas Koenig.
143     (#88724)
144
145     Apply various optimization improvements from Dagfinn Ilmari MannsÃ¥ker.
146     There should be no changes in the output.  (#83253)
147
148     Fix an erroneous output_fh reference in the Pod::Man documentation.
149     Thanks, Andreas Koenig.  (#88723)
150
151     Fix various comment typos.  Thanks, David Steinbrunner.  (#85683)
152
153     In perlpodstyle, wrap verbatim license line in POD that was over 79
154     characters after the man page indentation.  Thanks, Brian Gottreu and
155     Steve Hay.  (#87440)
156
157 podlators 2.5.1 (2013-02-27)
158
159     Adjust the tag width tests and the list handling tests to avoid
160     spurious warnings from Pod::Simple about mismatched =item types.
161
162 podlators 2.5.0 (2013-01-02)
163
164     Support a new errors option in Pod::Man and Pod::Text.  Valid values
165     are die, stderr, pod, and none.  Convert the stderr option to the
166     errors option with value stderr.  Add the corresponding --errors
167     option to pod2man and pod2text.  (#39007)
168
169     Add a new nourls option to Pod::Man and Pod::Text to suppress the URL
170     from L<> formatting codes that contain anchor text, and add the
171     corresponding --nourls option to pod2man and pod2text.  (#62210)
172
173     [Pod::Man] Extend a small-caps section through the punctuation that
174     commonly appears in license disclaimers so that small caps isn't
175     turned on and off at the boundaries of every word, producing
176     unreadable *roff.
177
178     [Pod::Man] Collapse consecutive whitespace and remove newlines in
179     index term text.  Thanks, Kevin Ryde.  (#82332)
180
181 podlators 2.4.2 (2012-06-01)
182
183     Remove the test of a POD document without an encoding.  We previously
184     tested that this interpreted the document as ISO 8859-1, but
185     Pod::Simple behavior has changed so that the test started failing,
186     plus Pod::Simple now warns about a missing =encoding.  (#77553)
187
188 podlators 2.4.1 (2012-05-30)
189
190     Fix detection of PerlIO UTF-8 handling by requesting details on PerlIO
191     layers to look for the UTF8 flag, which is not a layer in its own
192     right.  Thanks, Leon Timmermans.  (#76440)
193
194     [Pod::Man] Fix handling of the F register when processing multiple
195     documents at once.  .IX will now continue to be defined for documents
196     after the first, and the page number will not be reset at the start of
197     each document.  Thanks to Nicholas Clark for the analysis.  (perl
198     #103202)
199
200     In the pod2man and pod2text driver scripts, report an error and remove
201     the empty output file if the input file had no content (if it did not
202     exist, for example).  Exit with non-zero status if there were any
203     errors.  Track contentless status inside Pod::Man and Pod::Text.
204     Thanks, Dmitry Smirnov.  (#75099)
205
206     Override parse_file in Pod::Man and Pod::Text to set output_fh to
207     STDOUT if it is not already set.  (#77530)
208
209     [Pod::Man] Format the URL text before comparing it to the anchor when
210     deciding whether to show separate anchor text.  This avoids spurious
211     mismatches between the URL target and anchor text because the anchor
212     text was already formatted and has (for example) hyphens escaped.
213     (#76396)
214
215     [Pod::Man] Define \*(C` and \*(C' to the empty string when processed
216     through troff to avoid groff warnings.  Avoid warnings from checking
217     the F register (used to enable index output) when running under groff.
218     Patch from Bjarni Ingi Gislason.  (#75434)
219
220     [Pod::Man] Fix the ASCII fallback string for the AE ligature to use
221     the string that was actually defined.
222
223     Stop removing pod2man and pod2text on make realclean, left over from
224     when they were generated from *.PL scripts.  (#74848)
225
226     Embed the PID in file names generated by the test suite to avoid
227     conflicts when running the test suite in parallel.  (#62083)
228
229 podlators 2.4.0 (2010-10-10)
230
231     Switch UTF-8 output encoding to use Encode directly instead of adding
232     a PerlIO layer.  Probe the PerlIO layers with protection for Perl
233     versions without PerlIO and set a flag indicating whether we also need
234     to encode, to avoid double-encoding when writing to a file handle that
235     is already doing UTF-8 encoding via PerlIO.
236
237     [Pod::Man] Do not strip escaped trailing whitespace such as that
238     created by S<> at the end of a line, since the backslash is then taken
239     by *roff as escaping the newline.  Thanks, Kevin Ryde.  (#61781)
240
241     Add perlpodstyle, a new style guide for POD documentation, split
242     mostly from the NOTES section of the pod2man man page.  Remove the
243     NOTES section of pod2man's documentation.
244
245     Convert pod2man and pod2text from scripts generated from *.PL files to
246     simple scripts, relying on ExtUtils::MakeMaker to handle replacing the
247     #! path during the package build.
248
249 podlators 2.3.1 (2010-02-17)
250
251     Increase $VERSION in Pod::Text::Color and Pod::Text::Termcap, missed
252     in the previous release.
253
254 podlators 2.3.0 (2009-12-28)
255
256     Support anchor text for L<> links of type URL by rendering the anchor
257     text and then the URL in angle brackets.  Now requires Pod::Simple
258     3.06 or later.
259
260     [Pod::Text] When formatting item tags, use the width of the tag
261     without formatting codes.  This fixes formatting issues with
262     Pod::Text::Color, Pod::Text::Termcap, and Pod::Text::Overstrike.
263
264     [Pod::Man] Suppress all formatting in the NAME section to avoid
265     confusing lexgrog and fix mishandling of C<> markup in NAME.  Clarify
266     in the pod2man documentation that no markup should be used in the NAME
267     section of a manual page.  Thanks, Niko Tyni.
268
269     [Pod::Man] Escape backslashes in the quoted text of .IX macros
270     generated from X<> formatting code.
271
272     [Pod::Man] Avoid using POSIX::strftime because POSIX requires Fcntl,
273     which is an XS module, and hence can't build in miniperl.  This allows
274     ExtUtils::MakeMaker to build as a normal module in Perl core.  Thanks,
275     Michael G Schwern.
276
277     [Pod::ParseLink] Allow anchor text for URLs.  Fix the check of the
278     anchor text to not think no text was provided when the text was "0".
279
280     Remove the temporary files created by the test suite in a loop to
281     ensure that all versions are deleted on VMS.  Thanks, John
282     E. Malmberg.
283
284     Convert the test suite to Test::More.
285
286 podlators 2.2.2 (2009-01-17)
287
288     [Pod::Text] Correctly handle indentation of verbatim paragraphs that
289     contain lines with only whitespace.  Thanks, Renee Baecker.
290
291 podlators 2.2.1 (2008-12-19)
292
293     [Pod::Text] In the legacy pod2text method, properly initialize the
294     output file handle when called with only one argument.  Thanks,
295     Michael G Schwern.
296
297     Fix the t/text-encoding.t test on Windows by setting raw encoding on
298     the output file handle.  Thanks, Steve Hay.
299
300 podlators 2.2.0 (2008-10-05)
301
302     [Pod::Text] Try to preserve the previous behavior of setting the
303     output encoding to match the input encoding if utf8 is not set, but
304     support forcing an output encoding of utf8 with the utf8 option.  Add
305     a corresponding --utf8 option to pod2text.  Document the PerlIO
306     limitations of the current utf8 support.
307
308     Quote all module version numbers to preserve any trailing zeroes.
309
310     Skip spelling tests unless RRA_MAINTAINER_TESTS is set in the
311     environment.  Spelling dictionaries are too different between systems.
312
313 podlators 2.1.4 (2008-09-21)
314
315     Support aspell as a spell checker for spelling tests.
316
317     Skip UTF-8 tests for versions of Perl prior to 5.8.
318
319 podlators 2.1.3 (2008-09-14)
320
321     Add a stderr option to Pod::Man and Pod::Text that sends POD errors to
322     standard error instead of adding a POD ERRORS section to the generated
323     documentation.  Add a corresponding --stderr option to pod2man and
324     pod2text.
325
326     [Pod::Man] Stop remapping the code point for non-breaking space.  This
327     should not be necessary and was wrong when the string from Pod::Simple
328     was a character string and not a byte string.  It was papering over a
329     bug in setting the encoding of an input POD file.
330
331     In the test suite, properly set encoding on file descriptors so that
332     the UTF-8 tests are handled with the correct encoding.  Test that
333     non-breaking spaces don't interfere with hyphen detection.
334
335 podlators 2.1.2 (2008-07-20)
336
337     [Pod::Man] Use .SS instead of a local .Sh macro for subheadings, and
338     stop defining .Sh.
339
340     [Pod::Man] Remap ISO 8850-1 non-breaking spaces produced by
341     Pod::Simple to the corresponding UTF-8 code point for UTF-8 output.
342
343     Add a test for spelling and fix multiple spelling and markup errors.
344
345 podlators 2.1.1 (2008-07-03)
346
347     [Pod::Man] Do not include the accent mark definitions in generated
348     *roff if the output is in UTF-8.
349
350     Fix the test for S<> handling with all whitespace to not give a
351     spurious failure with Pod::Simple 3.06.
352
353 podlators 2.1.0 (2008-06-01)
354
355     Add a new utf8 option to Pod::Man.  If set, do not convert non-ASCII
356     characters to *roff escapes or X, and instead output literal UTF-8
357     characters.  Add a new --utf8 option to pod2man.
358
359     [Pod::Man] Match text between \f(CW and \fP or \fR in headings
360     non-greedily to get the fonts right with multiple C<> formatting
361     codes.
362
363     [Pod::Man] Protect .Sh text against leading *roff control characters
364     since some *roff implementations apparently "look through" font
365     escapes at the beginning of lines.
366
367     [Pod::Man] Escape backslashes separately from processing non-ASCII
368     characters and do that, dash escaping, and underscore adjustment
369     before processing non-ASCII characters.  Otherwise, we escape the
370     hyphen in eth characters.
371
372 podlators 2.0.6 (2007-11-28)
373
374     [Pod::Man] Escape apostrophes and backquotes in verbatim and C<> text.
375
376     [Pod::Man] Define the IX macro to empty rather than leaving it
377     undefined when indexing is not requested to eliminate warnings when
378     groff warnings are enabled.
379
380     [Pod::Man] Simplify the logic to skip lib directories to avoid Perl
381     warnings and unnecessary checks.
382
383 podlators 2.0.5 (2006-09-16)
384
385     Accept and mostly ignore a hash of options as the first option to
386     parse_from_file.  Support an option of -cutting and configure
387     Pod::Simple to assume the POD has already started.  This is for
388     backward compatibility with Pod::Parser.
389
390     [Pod::Man] Recognize more uses of hyphens in regular English text and
391     allow them to be regular hyphens.
392
393     [Pod::Man] Turn off hyphenation and, for nroff, justification after
394     the .TH macro since that's where groff turns them on.
395
396     [Pod::Man] Stop mapping vertical bar to \(bv, since it produces
397     Unicode characters where they aren't desirable.  Remove the preamble
398     reference to the Tr string, which was never defined.
399
400 podlators 2.0.4 (2006-02-19)
401
402     [Pod::Man] Pod::Simple's source_filename method returns garbage if
403     we're parsing from a file handle, so use the current time if stating
404     the returned input file fails.
405
406     Add parse_from_filehandle methods to Pod::Man and Pod::Text for
407     backward compatibility with the earlier versions based on Pod::Parser.
408
409 podlators 2.0.3 (2006-01-28)
410
411     In the test suite, pass in a file handle for Pod::Simple output and
412     then close it afterwards.  This works around Pod::Simple leaving file
413     handles open and preventing removal of temporary files on Windows.
414     This is temporary until a new Pod::Simple release offers a better
415     approach.
416
417 podlators 2.0.2 (2006-01-25)
418
419     In the parse_from_file method, flush the output file handle rather
420     than closing it.  Closing it is unexpected and could break callers.
421
422     In Pod::Text::Termcap and Pod::Text::Color, Use additional temporary
423     variables to avoid ${char}{0,$width}, which only works in very recent
424     Perls.
425
426     Fix man test that needs an ISO 8859-1 encoding.
427
428 podlators 2.0.1 (2006-01-20)
429
430     Call reinit before calling the Pod::Simple parse_from_file method to
431     preserve the previous capability of reusing the same Pod::Man object
432     for multiple documents.  Close the output file handle after
433     Pod::Simple returns to force the output to flush.
434
435     [Pod::Text] The legacy pod2text method was broken because
436     Pod::Simple's parse_file method only takes one argument.  Pass the
437     second argument to output_fh instead.
438
439     Fix portability issues with Perl 5.005.
440
441     Use a single object for all conversions in pod2man and pod2text for a
442     minor speedup.
443
444 podlators 2.00 (2005-11-28)
445
446     Rewrite all modules and driver scripts to use Pod::Simple instead of
447     Pod::Parser.  The output should be identical except that C<> with no
448     content outputs quotes for Pod::Text-based parsers, E<> handling is
449     improved, and various small bugs have been fixed.  Thanks, Sean Burke.
450
451     [pod2man] Create a new parser for each file since Pod::Simple parsers
452     are not reusable.
453
454     [pod2text] Add support for multiple pairs of input and output files,
455     similar to pod2man.
456
457     [Pod::Man] Strip vendor_perl as well as site_perl when determining the
458     man page title.  Thanks, Alexey Tourbin.
459
460     Fall back on fullstop_space_harden if preserve_whitespace is not
461     available, for compatibility with older Pod::Simple.
462
463     Count text lengths correctly when wrapping in Pod::Text::Color and
464     Pod::Text::Termcap when there are multiple adjacent escape sequences.
465     Use a temporary variable to make the regex clearer.
466
467     Change section ordering in some documentation following perl5-porters
468     discussion.
469
470     Remove obsolete documentation caution against enclosing URLs in L<>.
471
472     Force a particular terminal configuration to get reliable results in
473     the Pod::Text::Termcap test suite.
474
475     Enhance the test suite substantially with additional tests from Sean
476     Burke.
477
478 podlators 1.27 (2003-07-09)
479
480     [Pod::Text::Termcap] Handle the case where the HOME environment
481     variable isn't set, mostly for Windows.
482
483 podlators 1.26 (2003-03-30)
484
485     [Pod::Man] Make sure the module returns 1 to keep Perl 5.8.0 happy.
486
487 podlators 1.25 (2003-01-04)
488
489     [Pod::Man] Track the type of items in an =over list and only map
490     asterisk to a real bullet if the item type is bullet.  Fix a bug where
491     =item 0 was treated the same as =item with no tag.
492
493 podlators 1.24 (2002-08-03)
494
495     Support a margin option in Pod::Text and use it to set the initial
496     indentation level.  Fix handling of the colon in the margin when the
497     alt format is enabled.  Add a new -m option to pod2text to set the
498     margin.
499
500 podlators 1.23 (2002-07-14)
501
502     Clean up some old-style L<> links in pod2text that were workarounds
503     for fixed bugs in Pod::Man and Pod::Text.
504
505     Add a pointer to the module web site in the documentation.
506
507 podlators 1.22 (2002-06-23)
508
509     Tweak the regex for matching numbers in C<> to not consider a single
510     period to be a number, which affects whether surrounding quotes are
511     added.
512
513 podlators 1.21 (2002-02-16)
514
515     [Pod::Text::Overstrike] Fix the regex for wrapping lines to use a
516     non-backtracking section for each character to avoid exponential
517     backtracking on lines with a lot of markup.
518
519 podlators 1.20 (2002-01-27)
520
521     [Pod::Text::Overstrike] Use [\b] instead of \cH in regexes to match
522     backspaces, for platforms that use EBCDIC where \b and \cH aren't the
523     same character.
524
525 podlators 1.19 (2002-01-02)
526
527     [Pod::Man] Do not apply guesswork to the text inside the NAME section,
528     since it may confuse programs like catman.  Do not output .UC after
529     the .TH macro.  catman doesn't like anything between the NAME section
530     and .TH, and .UC doesn't appear to actually do anything on any modern
531     platform.
532
533     [Pod::Man] Correctly handle a verbatim paragraph right before a
534     heading.
535
536     [Pod::Text] Fix error reporting for unknown sequences and unknown
537     commands to be more consistent and update the documentation to match.
538
539     [Pod::Text::Termcap] Terminal speed should be a number, not a string.
540     Also fall back on a hard-coded terminal speed if getospeed doesn't
541     work.
542
543 podlators 1.18 (2001-11-30)
544
545     [Pod::Text::Termcap] Fall back on a hard-coded terminal speed if
546     POSIX::Termios doesn't work, such as on VMS.
547
548     [Pod::ParseLink] Escape L<> in the NAME section of the documentation.
549
550 podlators 1.17 (2001-11-27)
551
552     [Pod::Man] Return references to arrays rather than references to
553     scalars for already-formatted text.  There are too many odd bugs with
554     scalar references in older versions of Perl.  No longer bless
555     references since the current Pod::Parser doesn't require it.  Now
556     requires Pod::Parser 1.13 or later.
557
558     Change all documentation references from interior sequences to
559     formatting codes to match the terminology of perlpodspec.
560
561     [Pod::Text::Termcap] Fix an incorrect heading in the documentation.
562
563 podlators 1.16 (2001-11-26)
564
565     Use an @INC path of ../lib and a new function to find source files for
566     when the module test suite is being run as part of the Perl core
567     tests.
568
569 podlators 1.15 (2001-11-26)
570
571     [Pod::Text::Termcap] Wrap the call to Term::Cap with eval because it
572     throws exceptions if the terminal can't be found.  Fall back on the
573     ANSI escape sequences rather than dying if the termcap entry is
574     incomplete.  Note the fallback in the documentation.
575
576     Delete the lax option in pod2man before calling Pod::Man and document
577     that it is obsolete and podchecker should be used instead.
578
579     Improve the pod2man and Pod::Man documentation to refer to podchecker,
580     add discussion of guesswork and 8-bit character handling, and mention
581     the fragility of the heuristics.
582
583 podlators 1.14 (2001-11-23)
584
585     [Pod::Text::Overstrike] Interpolate before formatting to prevent the
586     formatting codes from ending up in the output, and strip any existing
587     formatting before applying new formatting.
588
589     [Pod::Man] Use font escapes rather than .I to avoid strange problems
590     with quoting, at least for =head3.  =head1 and =head2 likely still
591     have troubles with repeated double-quotes.  Fix all fixed-width font
592     changes for nroff, not just the simple ones, and don't hard-code the
593     value of any fixed-width font.
594
595     [Pod::Man] Improve and simplify the handling of indentation shifts.
596
597     [Pod::Man] When intuiting the man page name for a module, also strip
598     $^O by itself as a directory component even when not preceeded or
599     followed by a dash and other text.
600
601     [Pod::Text] Fix handling of =for or =begin/=end in =item paragraphs.
602     Default to a tag of "*" if none is given.  Insert some whitespace for
603     empty item paragraphs to keep them from blending into subsequent text.
604
605     [Pod::ParseLink] Fix a bug in the handling of link text that's
606     entirely in quotes.  Double quotes are now only removed around
607     sections, not names.  Text enclosed entirely in double quotes is
608     interpreted as a link to a section.
609
610     Fix various -w warnings.
611
612 podlators 1.13 (2001-11-15)
613
614     Fix -w warnings with hyphen handling.
615
616 podlators 1.12 (2001-11-15)
617
618     Add a new module, Pod::ParseLink, to parse the contents of an L<>
619     sequence.  Use it everywhere.  Defer expansion of formatting escapes
620     inside L<> until after L<> is processed.  Surround URLs with angle
621     brackets in the output.
622
623     Remove the special handling of consecutive L</section> links.
624
625     Support E<apos>, E<nbsp>, and E<shy>.
626
627     [Pod::Man] Completely rewrite the name parsing code for modules to use
628     File::Spec.  In the process, fix a bug in dealing with the new
629     three-component version number directories.  Swap the order of date
630     and release in the .TH line to better comply with the man macro
631     documentation.
632
633     [Pod::Man] Rewrite the handling of dashes and hyphens.  Be much more
634     conservative about which hyphens are turned into dashes, and make all
635     hyphens non-breaking unless we can be fairly sure that they're inside
636     normal words.
637
638     [Pod::Man] Handle indentation of =item-less =over/=back blocks.
639
640     [Pod::Man] Include the version of Pod::Parser in the header.
641
642     [Pod::Man] Only try to determine a module name from the path for the
643     man page name if the man page we're generating is in section 3.
644
645     [Pod::Man] No longer insert a timestamp into the generated man page;
646     it just causes unnecessary differences and merge conflicts.
647
648     [Pod::Text] Inside S<>, convert all whitespace to non-breaking spaces,
649     not just spaces.
650
651     Add the --name option to pod2man and document the name option in
652     Pod::Man.
653
654     [Pod::Man] Use L<> for all man page references in the documentation
655     that should be highlighted.  Switch the rest to bold versions of the
656     program name.  Change func(n) to func(3) in the example of things that
657     are automatically formatted so that it will be formatted.  Remove from
658     BUGS the note that some of the path mangling assumes Unix directory
659     separators.  Don't give anchor text for L<> links that no longer
660     require it.
661
662     Update the documentation in Pod::Text and subclasses to use
663     now-allowable POD constructs like C<< >>.  Don't escape angle brackets
664     that don't require escaping.  Don't give anchor text for L<> links
665     that no longer require it.
666
667 podlators 1.11 (2001-10-20)
668
669     Add the code option to Pod::Text to include the non-POD text of the
670     input file and document it.  Add the corresponding --code flag to
671     pod2text.
672
673     Converted warnings for unknown escapes, unknown sequences, and
674     unmatched =back into warnings from carps and include the file and line
675     number of the POD data instead of the Perl code.
676
677     [Pod::Text::Overstrike] Better handle the case where a highlighted
678     portion of text ends a line.
679
680     Add --verbose flag to pod2man to print out each output file as it is
681     generated.
682
683     [Pod::Man] Fix *roff syntax error from using .if with .el during quote
684     handling.
685
686     [Pod::Man] Fix output for X<> sequences.
687
688 podlators 1.10 (2001-07-10)
689
690     Add heuristics to decide whether to quote the argument of C<>.
691
692     [Pod::Man] Remove font changes for nroff with C<> to work around a bug
693     in the Solaris 2.6 version of nroff's handling of \fP in headings.  No
694     longer add an extra level of quoting for =item; it isn't necessary.
695
696     [Pod::Man] Remove the logic turning PI into a pretty pi character.  It
697     produces too many false positives.
698
699     [Pod::Man] Remove the definition .Ip from the preamble.  Remove .bd B
700     3 from the preamble; this isn't part of the accent mark definitions
701     but instead changes the way bolding is done, confusing some other
702     translators.  Use .IP instead of .Ip everywhere.
703
704     In the POD style section of pod2man, add a description of the
705     COPYRIGHT AND LICENSE section, add a mention of a mailing list in SEE
706     ALSO, and mention that large logs are better kept separate from
707     HISTORY in the description of a standard manual page.
708
709     Standardize on COPYRIGHT AND LICENSE for licensing information across
710     all of the package documentation.
711
712 podlators 1.09 (2001-04-09)
713
714     [Pod::Man] Fine-tune formatting guesswork.  Don't allow colons after
715     sequences to put in small caps since they're already handled by being
716     rolled into the sequence and were causing weird things to happen in
717     references to functions.  Allow small caps before an open paren.
718     Teach the handling of functions and manual page references about small
719     caps escapes, and be pickier about what constitutes a manual page
720     reference.
721
722     [Pod::Text] Fix again the incorrect mappings for E<Iacute> and
723     E<iacute>, and this time for E<Igrave> and E<igrave> too.  Thanks,
724     Sean Burke.
725
726 podlators 1.08 (2001-02-09)
727
728     Output anything that looks like a URL verbatim rather than
729     interpreting it as a manual page reference.
730
731 podlators 1.07 (2001-01-16)
732
733     [Pod::Man] Remove newlines from heading contents.
734
735     [Pod::Man] Quote the file name in the man page header if it contains
736     spaces.
737
738 podlators 1.06 (2000-12-25)
739
740     New Pod::Text::Overstrike contributed by Joe Smith.  Add -o or
741     --overstrike to pod2text to use it for formatting.
742
743     [Pod::Man] =item text requires another level of quoting of double
744     quotes, which was already present but not working for C<> text because
745     it was in the wrong order.  Fix.
746
747 podlators 1.05 (2000-11-18)
748
749     Change the default quote character for C<> to be double quotes rather
750     than matched left/right single quotes.
751
752     Add support for =head3 and =head4.
753
754     Allow pod2man to take multiple pairs of input and output files on the
755     command line to decrease the time that it takes to process all of
756     Perl's documentation.
757
758     [Pod::Man] Switch \*C` and \*C' sequences from C<> as well as literal
759     double-quotes if the quote character contains double quotes.  Not
760     doing this was causing weird output on some systems in some
761     circumstances.  Use a separate quote mapping function for text blocks
762     to work around a Solaris 2.6 nroff bug.
763
764     [Pod::Man] Use \fP to switch back to the default font rather than
765     changing back to \fR so that font changes work correctly in headings
766     using a different font.  Sprinkle \fP through all font changes so that
767     the default font is always the "previous" font so that the above
768     works.
769
770 podlators 1.04 (2000-10-09)
771
772     [Pod::Man] Output .PD 0 and .PD around repeated =item tags so that
773     they're formatted without intervening blank lines, improving
774     formatting of, e.g., perlfunc.pod.
775
776     [Pod::Text] Fix incorrect mappings for E<Iacute> and E<iacute>.
777     Thanks, Sean Burke.
778
779 podlators 1.03 (2000-09-03)
780
781     Support configuration of what quote characters to use around C<>
782     text.  Add a new --quotes option to pod2man and pod2text.
783
784     Report nicer errors when encountering an unknown paragraph command.
785
786     Add support for E<sol> and E<verbar>.
787
788     [Pod::Man] Fix the regex for stripping bullets from index entries so
789     that it doesn't strip a leading "o".
790
791     [Pod::Man] In the prelude, terminate the .IX definition with ".."
792     instead of ".    ." for groff.
793
794     [Pod::Text] The pod2text method, when given two arguments, was
795     incorrectly assigning to $_[0], causing other sane problems.  Fix.
796
797 podlators 1.02 (2000-04-25)
798
799     [Pod::Man] Fix hyphens and underscores only in literal C<> content,
800     fixing mangling of hyphens and underscores that are the result of
801     other sequence processing.
802
803 podlators 1.01 (2000-03-30)
804
805     Install the modules in the Perl core area if the Perl version is 5.6.0
806     or higher.
807
808     [Pod::Man] Strip a leading lib/ from a file name for module man pages,
809     needed for ExtUtils::MakeMaker.
810
811 podlators 1.00 (2000-03-16)
812
813     This has now been incorporated into Perl core as pod2man and pod2text.
814     Rename pod2roff to pod2man accordingly.
815
816     Hide "-" arguments to the driver scripts from Getopt::Long so that
817     Pod::Parser will interpret them as STDIN or STDOUT.
818
819     [Pod::Man] Protect any line that starts with a backlash and leading
820     periods following font escapes.  Replace embedded newlines in titles
821     with spaces.
822
823     [Pod::Man] Use "perl v5.6.0" instead of "perl 5.6, patch 0" for the
824     default release string, handle both pre-5.6 and post-5.6 version
825     numbering schemes.  Zero-pad the month and day in the modification
826     date.  Avoid warnings when center, date, or release aren't set.
827
828     [Pod::Man] Allow for two-character fonts.
829
830     [Pod::Man] Work around a Perl 5.6 bug affecting L<> text generation.
831     Fix Z<> handling with current Perl.
832
833     [Pod::Man] Make filename munging safe even when $* is set and the
834     filenames contain embedded newlines.
835
836     [Pod::Man] Fix the regex to concatenate multiple L<> section links and
837     fix whitespace handling for it around "and".
838
839     [Pod::Text] Add the remaining ISO 8859-1 HTML entities.  Thanks, Tim
840     Jenness.
841
842     [pod2man] Change Getopt::Long config from bundling to
843     bundling_override so that options like -center work for backwards
844     compatibility.
845
846     [pod2text] Don't default to Pod::Text::Termcap even if STDOUT is a tty
847     until it works right on Windows, VMS, etc.
848
849 podlators 0.08 (1999-10-07)
850
851     Add support for numeric E<> escapes.
852
853     [Pod::Man] Fix doubled quotes in links to sections.
854
855     [Pod::Text] Export pod2text for backwards compatibility.
856
857     [pod2roff] Fix argument passing to Pod::Parser to use an expanded hash
858     instead of a hash reference.
859
860 podlators 0.07 (1999-09-25)
861
862     [Pod::Man] Change the parsing model so that, rather than deferring E<>
863     escapes until just before output, *roff output is generated by the
864     interior sequence parsing and the result is passed up the parse trees
865     as Pod::Man::String objects instead of scalars to mark the output as
866     already processed.  In the process, clean up what *roff escaping and
867     guesswork is applied where, and clean up the whole process of applying
868     guesswork.  Improve the escaping of dashes and hyphens to use a single
869     pass.
870
871     [Pod::Man] Improve the small caps guesswork to allow for more cases,
872     including several adjacent all caps words.
873
874     [Pod::Man] Fix some bugs with the link text generation for man page
875     references.
876
877     [Pod::Man] Improve the index generation slightly.
878
879     [Pod::Man] Fix several places that were clobbering the caller's $_.
880
881 podlators 0.06 (1999-09-20)
882
883     Add pod2roff and Pod::Man, which convert POD to man pages.
884
885     Rename pod2txt to pod2text and Pod::PlainText to Pod::Text.
886
887     [Pod::Text] =begin text blocks are now output verbatim rather than
888     interpreted as POD.
889
890     [Pod::Text] Document the oddity with Ctrl-As as a restriction.
891
892     [Pod::Text] Always treat =for paragraphs as verbatim text.
893
894     [Pod::Text::Color] Add a BUGS note that the implementation is rather
895     incomplete, and document the reliance on Term::ANSIColor.
896
897     [pod2text] Add an explicit check for Term::ANSIColor if -c was given.
898
899     [Pod::Man] Add a BUGS entry for index entries for stuff in NAME.
900
901     [Pod::Text] Document two more diagnostics and a cross-reference to
902     pod2text.
903
904     [pod2text] Add documentation of -h and expand the DIAGNOSTICS section
905     to include directly-generated error messages and the most common
906     Getopt::Long message.
907
908 podlators 0.05 (1999-09-18)
909
910     [Pod::Text::Color] Rename Pod::SimpleText to Pod::PlainText in one
911     more place in the documentation.
912
913 podlators 0.04 (1999-08-30)
914
915     Use File::Spec during the build to build file paths for portability,
916     and remove the dist setting since current Perls get this right.
917
918     Fix the #! line in pod2txt during the build.
919
920 podlators 0.03 (1999-08-30)
921
922     Rename Pod::SimpleText to Pod::PlainText.
923
924     [pod2txt] Document that Pod::Text::Termcap is used by default if
925     STDOUT is a tty.  Clarify the documentation of --loose.
926
927 podlators 0.02 (1999-07-29)
928
929     Rename the package itself from Pod::SimpleText to podlators.
930
931     [Pod::SimpleText] Add a pod2text function for backwards compatibility.
932
933     [Pod::SimpleText] Properly wrap multiline =item tags.
934
935     [Pod::SimpleText] Fix a spurious space with =for text commands.
936
937     [Pod::SimpleText] Check the content of sequences against the empty
938     string specifically rather than testing truth so that it does the
939     right thing with 0.
940
941     [Pod::SimpleText] Process sequences for =head headings.
942
943 podlators 0.01 (1999-06-12)
944
945     Initial release with pod2txt and Pod::SimpleText.