Permalink
Browse files

initial import of Pod-Parser 1.30 from CPAN

git-cpan-module:   Pod-Parser
git-cpan-version:  1.30
git-cpan-authorid: MAREKR
git-cpan-file:     authors/id/M/MA/MAREKR/Pod-Parser-1.30.tar.gz
  • Loading branch information...
0 parents commit 0671fc6d4aa48b4435c5fc6b9100a6bc97146b87 Marek Rouchal committed with schwern Mar 13, 2005
@@ -0,0 +1,18 @@
+
+ This parrot is dead. It has ceased to be. It's gone to meet it's Maker!
+ THIS IS AN EX-PARROT!
+ The Dead Parrot Sketch, Monty Python's Flying Circus
+
+Do s/parrot/package/g and you know the status of this distribution.
+The current version 1.30 has been provided to fix a number of bugs
+and integrate a bunch of useful enhancements, which were provided as
+patches, thanks to the contributers.
+
+But: There is Pod::Simple, which provides a much better and robust parser,
+as well as Unicode support and a lot of other useful things. When thinking
+POD, please (start to) think Pod::Simple!
+
+Some of the other modules bundled here (Pod::Usage, Pod::Find etc.) may
+appear soon in other distributions, as soon as they are ported away from
+Pod::Parser.
+
Oops, something went wrong.
@@ -0,0 +1,55 @@
+ANNOUNCE -- announcement of end of support for this package
+CHANGES -- Change history
+README -- Main information file
+MANIFEST -- This shipping list
+TODO -- Tentative "to do" list for future development
+Makefile.PL -- Perl Makefile template
+
+lib/Pod/InputObjects.pm -- Input objects for Pod::Parser
+lib/Pod/Parser.pm -- The Pod::Parser module source
+lib/Pod/ParseUtils.pm -- The Pod::ParseUtils module source
+lib/Pod/Select.pm -- The Pod::Select module source
+lib/Pod/PlainText.pm -- The Pod::PlainText module source
+lib/Pod/Usage.pm -- The Pod::Usage module source
+lib/Pod/Checker.pm -- The Pod::Checker module source
+lib/Pod/Find.pm -- The Pod::Find module source
+
+scripts/podselect.PL -- Script to print selected sections of pod docs in raw
+ pod format (a command-line interface to podselect()).
+scripts/pod2usage.PL -- Script to print usage from a file's embeded pod docs
+ (a command-line interface to pod2usage()).
+scripts/podchecker.PL -- Script to check syntax of pods in a file
+
+t/pod/testcmp.pl -- module used to compare output against expected results
+t/pod/testp2pt.pl -- module used to test Pod::PlainText for a given file
+t/pod/testpchk.pl -- module used to test Pod::Checker for a given file
+t/pod/emptycmd.t -- test-input file for an empty pod directive
+t/pod/emptycmd.xr -- expected result from processing emptycmd.t
+t/pod/find.t -- test for Pod::Find
+t/pod/for.t -- test-input file for =for directives
+t/pod/for.xr -- expected result from processing for.t
+t/pod/headings.t -- test-input file for =head directives
+t/pod/headings.xr -- expected result from processing headings.t
+t/pod/include.t -- test-input file for an =included file
+t/pod/include.xr -- expected result from processing include.t
+t/pod/included.t -- test-input file for =including another file
+t/pod/included.xr -- expected result from processing included.t
+t/pod/lref.t -- test-input file for L<...> sequences
+t/pod/lref.xr -- expected result from processing lref.t
+t/pod/multiline_items.t -- test-input file for multiline =items
+t/pod/multiline_items.xr -- expected result from processing multiline_items.t
+t/pod/nested_items.t -- test-input file for nested =items
+t/pod/nested_items.xr -- expected result from processing nested_items.t
+t/pod/nested_seqs.t -- test-input file for nested interior sequences
+t/pod/nested_seqs.xr -- expected result from processing nested_seqs.t
+t/pod/oneline_cmds.t -- test-input file for ==cmds
+t/pod/oneline_cmds.xr -- expected result from processing oneline_cmds.t
+t/pod/poderrs.t -- test input file for checking some POD errors
+t/pod/poderrs.xr -- expected result from processing poderrs.t
+t/pod/pod2usage.t -- test input file for processing pod2usage.PL
+t/pod/pod2usage.xr -- expected result from processing pod2usage.PL
+t/pod/podselect.t -- test input file for processing podselect.PL
+t/pod/podselect.xr -- expected result from processing podselect.PL
+t/pod/special_seqs.t -- test-input file for "special" interior sequences
+t/pod/special_seqs.xr -- expected result from processing special_seqs.t
+META.yml Module meta-data (added by MakeMaker)
@@ -0,0 +1,10 @@
+# http://module-build.sourceforge.net/META-spec.html
+#XXXXXXX This is a prototype!!! It will change in the future!!! XXXXX#
+name: PodParser
+version: 1.26
+version_from:
+installdirs: perl
+requires:
+
+distribution_type: module
+generated_by: ExtUtils::MakeMaker version 6.21
@@ -0,0 +1,73 @@
+# Makefile.PL -- Makefile template for PodParser.
+#
+# This file is part of "PodParser". PodParser is free software;
+# you can redistribute it and/or modify it under the same terms
+# as Perl itself.
+
+BEGIN {
+ require 5.005;
+ eval { require File::Spec };
+ $@ and die "You need to install the File::Spec module first!\n";
+ if(($File::Spec::VERSION || 0) < 0.8) {
+ die "You need at least version 0.8 of the File::Spec module!\n";
+ }
+}
+
+use ExtUtils::MakeMaker;
+
+$DISTNAME = "Pod-Parser"; ## The "product" name for this distribution
+$DISTMOD = 'Pod::Parser'; ## The "title" module of this distribution
+@MODULES = ( $DISTMOD, ## Other modules in this distribution
+ qw( Pod::Checker
+ Pod::InputObjects
+ Pod::PlainText
+ Pod::Select
+ Pod::Usage
+ )
+ );
+
+## The executable scripts to be installed
+@SCRIPTS = qw( podchecker
+ podselect
+ pod2usage
+ );
+sub script($) { File::Spec->catfile ('scripts', @_) }
+my @EXE_FILES = ();
+if ( $^O eq 'VMS' ) {
+ @EXE_FILES = map { script "$_.com" } @SCRIPTS;
+}
+else {
+ @EXE_FILES = map { script $_ } @SCRIPTS;
+}
+
+## The test-script to execute regression tests (note that the
+## 'xtra' directory might not exist for some installations)
+@TESTPODS = ();
+my $testdir = File::Spec->catfile('t', 'pod');
+my $test2dir = File::Spec->catfile($testdir, 'xtra');
+my @testdirs = ($testdir);
+push @testdirs, $test2dir if (-d $test2dir);
+@TESTPODS = map { File::Spec->catfile($_, '*.t') } @testdirs;
+@TESTPODS = map { glob } @TESTPODS if $^O eq 'MSWin32';
+
+##-----------------------------------------------------------------------
+## Instructions to write the Makefile (see Ext::MakeMaker)
+
+WriteMakefile(
+ NAME => $DISTMOD,
+ DISTNAME => $DISTNAME,
+ VERSION => '1.30',
+ INSTALLDIRS => ($] >= 5.006 ? 'perl' : 'site'),
+ PL_FILES => { map { (script("$_.PL") => script($_)) } @SCRIPTS },
+ EXE_FILES => [ @EXE_FILES ],
+ dist => { COMPRESS => 'gzip', SUFFIX => 'gz' },
+ clean => { FILES => "@EXE_FILES" },
+ test => { TESTS => "@TESTPODS" },
+ ($] < 5.005 ? ## Need File::Spec if this is 5.004 or earlier
+ (PREREQ_PM => {'File::Spec' => 0}) : ()),
+ ($] >= 5.005 ? ## Add these new keywords supported since 5.005
+ (ABSTRACT => 'Modules for parsing/translating POD format documents',
+ AUTHOR => 'Brad Appleton <bradapp@enteract.com>') : ()),
+);
+
+
@@ -0,0 +1,184 @@
+
+ WHAT IS THIS?
+ =============
+ This software distribution contains the following packages for using
+ Perl5 "pod" (Plain Old Documentation). See the "perlpod" and "perlsyn"
+ manual pages from your Perl5 distribution for more information about pod.
+
+ Pod::Parser
+ -----------
+ The Perl5 module "Pod::Parser", which provides a base class for
+ parsing and selecting sections of POD documentation from an input
+ stream. Please see the POD documentation for this module (embedded
+ in the file "Parser.pm") for more details.
+
+ Pod::Select
+ -----------
+ The Perl5 module "Pod::Select", which provides a subclass of
+ Pod::Parser and an exported function named "podselect()" to dump
+ selected sections of raw pod documentation from an input stream.
+ Please see the POD documentation for this module (embedded in the
+ file "Select.pm") and Pod::Parser for more details.
+
+ Pod::Usage
+ ----------
+ The Perl5 module "Pod::Usage" which provides the function "pod2usage()"
+ to print usage messages for a Perl script based on its embedded pod
+ documentation. Pod::Usage is a subclass of Pod::PlainText. Please see
+ the POD documentation for this module (embedded in the file "Usage.pm")
+ for more details. The pod2usage() function is probably the most
+ generally useful function in this entire distribution since it is
+ useful to just about any Perl5 script that is invoked from the
+ command-line.
+
+ Pod::PlainText
+ --------------
+ A replacement for the Perl5 module "Pod::Text" and the corresponding
+ "pod2text()" function. It is derived from the Pod::Parser class.
+ Please see the POD documentation for this module and Pod::Parser for
+ more details (embedded in the file "PlainText.pm").
+
+ *NOTE*: As of perl 5.00_58, Pod::PlainText has been re-written by
+ Russ Allbery, and has been renamed to Pod::Text in the core Perl
+ distribution (replacing the previous implementation of Pod::Text).
+ The Pod::PlainText module is still provided with Pod::Parser on CPAN
+ solely for backward compatibility. Once Perl 5.6 becomes the latest
+ stable version of Perl, then Pod::PlainText will be removed from the
+ PodParser distribution!!
+
+ Pod::InputObjects
+ -----------------
+ Some input objects needed by Pod::Parser, and for advanced users of
+ Pod::Parser that need more about a command besides its name and text.
+
+ Pod::Checker
+ ------------
+ A module to check the syntax of a POD document. It is just in the
+ very beginning stages right now and is *far* from being thorough or
+ complete. Its just a starting point that I hope others who plan to
+ use it can help me flesh it out further.
+ This module also collects information about hyperlink nodes of the
+ document processed that can be used by converters later on.
+
+ Pod::ParseUtils
+ ---------------
+ A module with several object-oriented helpers for POD parsing and
+ processing. Probably the most important is Pod::Hyperlink for
+ parsing and expanding POD hyperlinks L<...>.
+
+
+ AUTHORS/CONTRIBUTORS
+ ====================
+ Marek Rouchal <marekr@cpan.org>
+ Brad Appleton <bradapp@enteract.com> http://www.enteract.com/~bradapp/
+ Russ Allbery <rra@standford.edu>
+
+
+ ACKNOWLEDGEMENTS
+ ================
+ * Kenneth Albanowski for his extensive assistance with the design and
+ interface of Pod::Parser.
+
+ * Steven McDougall for his help and patience with re-writing the manpage
+ for Pod::Usage and Pod::Parser.
+
+ * Achim Bonnet for helping me get the regression test-suite into a form
+ that works with 'make test' generated by MakeMaker
+
+ * Nick Ing-Simmons, for his considerable time and effort spent trying to
+ make pre-release versions of Pod::Parser work with code and giving me
+ feedback on the implementation and design.
+
+ * Russ Allbery for re-writing Pod::PlainText from scratch and getting it
+ to replace Pod::Text in the core for perl 5.00_58!
+
+ COPY/REUSE POLICY
+ =================
+ Except where explicitly stated otherwise within the contents of a file,
+ this distribution and all the files in it are Copyright (C) 1996-1999
+ by Brad Appleton. All rights reserved.
+
+ PodParser is free software; you can redistribute it and/or modify it
+ under the terms of the Artistic License distributed with Perl version
+ 5.000 or (at your option) any later version. Please refer to the
+ Artistic License that came with your Perl distribution for more
+ details. If your version of Perl was not distributed under the
+ terms of the Artistic License, than you may distribute PodParser
+ under the same terms as Perl itself.
+
+ The Artistic License should have been included in your distribution of
+ Perl. It resides in the file named "Artistic" at the top-level of the
+ Perl source tree (where Perl was downloaded/unpacked -- ask your
+ system administrator if you dont know where this is). Alternatively,
+ the current version of the Artistic License distributed with Perl can
+ be viewed on-line on the World-Wide Web (WWW) from the following URL:
+
+ http://www.perl.com/perl/misc/Artistic.html
+
+ The latest version of Perl can be obtained on the World-Wide web (WWW)
+ from the following URL:
+
+ http://www.perl.com/CPAN/src/latest.tar.gz
+
+
+ DISCLAIMER
+ ===========
+ This software is distributed in the hope that it will be useful, but
+ is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or
+ implied, INCLUDING, without limitation, 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 (the holder of the software). Should the software prove
+ defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+ CORRECTION.
+
+ IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE,
+ MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO
+ ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even
+ if they arise from known or unknown flaws in the software).
+
+ Please refer to the Artistic License that came with your Perl
+ distribution for more details.
+
+
+ CONTENTS
+ ========
+ Please see the file named "MANIFEST" which should have been included
+ in the PodParser distribution.
+
+
+ REQUIREMENTS
+ ============
+ * Perl version 5.005 or later
+
+ * File::Spec from CPAN (already bundled in Perl 5.005)
+ at least version 0.8, previous ones lack some functions needed here
+
+
+ BUILDING & INSTALLING
+ =====================
+ Please see the perl "ExtUtils::MakeMaker" manpage for how to build and
+ install using the Makefile.PL template. In a nutshell, simply typing:
+
+ perl Makefile.PL
+
+ should build a Makefile with the usual targets like "all", "clean",
+ "test", and "install".
+
+
+ BUGS
+ ====
+ Please use the CPAN bug tracking to report bugs:
+ http://rt.cpan.org/NoAuth/Bugs.html?Dist=PodParser
+
+ TO DO
+ =====
+ Please see the file named "TODO" which should have been included
+ in the PodParser distribution.
+
+ HISTORY
+ =======
+ Please see the file named "CHANGES" which should have been included
+ in the PodParser distribution.
+
Oops, something went wrong.

0 comments on commit 0671fc6

Please sign in to comment.