NAME
perldoc2xhtml_enhanced - Convert Perldoc markup to XHTML
VERSION
This documentation refers to perldoc2xhtml_enhanced version 0.0.1 This version is still a prototype.
USAGE
perldoc2xhtml_enhanced [-toc] [filename]REQUIRED ARGUMENTS
None.
OPTIONS
May be given a single argument specifying the name of the file to convert. If filename not given, input is read from STDIN.
May also be given a -toc flag to autgenerate a table-of-contents at the start of the document.
DESCRIPTION
This utility converts documentation in the Perl 6 "Perldoc" notation to XHTML. It is enhanced in that it recognizes constructs like:
``Open the pod-bay door, Hal!''
I'm sorry Dave, I'm afraid I can't do that.
It's called `Daisy'.
"Daisy, Daisy, give me your answer, do..."in non-verbatim text and "educates" the quote marks. That is, it converts the quote marks to:
“Open the pod-bay door, Hal!”
I’m sorry Dave, I’m afraid I can’t do that.
It’s called ‘Daisy’.
“Daisy, Daisy, give me your answer, do...”The XHTML is always written to STDOUT.
DIAGNOSTICS
See the documentation for Perl6::Perldoc::Parser
CONFIGURATION AND ENVIRONMENT
Requires no configuration files or environment variables.
DEPENDENCIES
Perl6::Perldoc::Parser
BUGS
None reported. Bug reports and other feedback are most welcome.
AUTHOR
Damian Conway DCONWAY@cpan.org
COPYRIGHT
Copyright (c) 2007, Damian Conway <DCONWAY@cpan.org>. All rights reserved.
This module is free software. It may be used, redistributed and/or modified under the terms of the Perl Artistic License (see http://www.perl.com/perl/misc/Artistic.html)
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.