Author: jhoblitt
Date: Wed Jan 18 00:59:05 2006
New Revision: 11236
Added:
trunk/config/gen/PodText.pm
Modified:
trunk/MANIFEST
Log:
add gen::PodText
Modified: trunk/MANIFEST
==============================================================================
--- trunk/MANIFEST (original)
+++ trunk/MANIFEST Wed Jan 18 00:59:05 2006
@@ -137,6 +137,7 @@ config/auto/snprintf.pm
config/auto/snprintf/test.in []
config/auto/va_ptr.pm []
config/auto/va_ptr/test_c.in []
+config/gen/PodText.pm []
config/gen/config_h.pm []
config/gen/config_h/config_h.in []
config/gen/config_h/feature_h.in []
@@ -162,10 +163,10 @@ config/gen/makefiles/befunge.in
config/gen/makefiles/bf.in []
config/gen/makefiles/cola.in []
config/gen/makefiles/docs.in []
-config/gen/makefiles/dynpmc.in []
-config/gen/makefiles/dynpmc_pl.in []
config/gen/makefiles/dynoplibs.in []
config/gen/makefiles/dynoplibs_pl.in []
+config/gen/makefiles/dynpmc.in []
+config/gen/makefiles/dynpmc_pl.in []
config/gen/makefiles/editor.in []
config/gen/makefiles/jako.in []
config/gen/makefiles/languages.in []
Added: trunk/config/gen/PodText.pm
==============================================================================
--- (empty file)
+++ trunk/config/gen/PodText.pm Wed Jan 18 00:59:05 2006
@@ -0,0 +1,69 @@
+# Copyright: 2001-2004 The Perl Foundation. All Rights Reserved.
+# $Id: /mirror/trunk/config/gen/cpu.pm 10933 2006-01-06T01:43:24.870411Z
particle $
+
+=head1 NAME
+
+config/gen/PodText.pm - generate plain text docs from Pod files
+
+=head1 SYNOPSIS
+
+ use gen::PodText;
+
+ gen::PodText->runstep($conf,
+ "source1.pod" => "dest1.pod"
+ "source2.pod" => "dest2.pod"
+ );
+
+=head1 DESCRIPTION
+
+Uses L<Pod::Text> to convert Pod documents into their plain text equivalents.
+
+=head1 USAGE
+
+=head2 Methods
+
+=head3 Class Methods
+
+=over
+
+=item * C<runstep()>
+
+Converts Pod documents into plain text. Documents to be converted as specified
+as a hash with the keys being the source Pod document and the values being the
+destination plain text file.
+
+Accepts a L<Parrot::Configure> object followed by a flattened hash.
+
+=back
+
+=cut
+
+package gen::PodText;
+
+use strict;
+use vars qw($description $result @args);
+
+use base qw(Parrot::Configure::Step::Base);
+
+use Pod::Text;
+
+$description = "Generating plain text docs...";
+
[EMAIL PROTECTED] = qw(verbose);
+
+sub runstep
+{
+ my ($self, $conf, %docs) = @_;
+
+ my $verbose = $conf->options->get('verbose');
+
+ my $parser = Pod::Text->new(width => 79);
+
+ foreach my $pod (keys %docs) {
+ $parser->parse_from_file($pod, $docs{$pod});
+ }
+
+ $result = 'Done';
+}
+
+1;
