1 |
dpavlin |
3 |
NAME |
2 |
|
|
Pod::Simple::Wiki - A class for creating Pod to Wiki filters. |
3 |
|
|
|
4 |
|
|
|
5 |
|
|
DESCRIPTION |
6 |
|
|
The `Pod::Simple::Wiki' module is used for converting Pod text |
7 |
|
|
to Wiki text. |
8 |
|
|
|
9 |
|
|
Pod (Plain Old Documentation) is a simple markup language used |
10 |
|
|
for writing Perl documentation. |
11 |
|
|
|
12 |
|
|
A Wiki is a user extensible web site. It uses very simple mark- |
13 |
|
|
up that is converted to Html. |
14 |
|
|
|
15 |
|
|
For an introduction to Wikis see: |
16 |
|
|
http://en.wikipedia.org/wiki/Wiki |
17 |
|
|
|
18 |
|
|
|
19 |
|
|
SYNOPSIS |
20 |
|
|
To create a simple `pod2wiki' filter: |
21 |
|
|
|
22 |
|
|
#!/usr/bin/perl -w |
23 |
|
|
|
24 |
|
|
use strict; |
25 |
|
|
use Pod::Simple::Wiki; |
26 |
|
|
|
27 |
|
|
my $parser = Pod::Simple::Wiki->new(); |
28 |
|
|
|
29 |
|
|
if (defined $ARGV[0]) { |
30 |
|
|
open IN, $ARGV[0] or die "Couldn't open $ARGV[0]: $!\n"; |
31 |
|
|
} else { |
32 |
|
|
*IN = *STDIN; |
33 |
|
|
} |
34 |
|
|
|
35 |
|
|
if (defined $ARGV[1]) { |
36 |
|
|
open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n"; |
37 |
|
|
} else { |
38 |
|
|
*OUT = *STDOUT; |
39 |
|
|
} |
40 |
|
|
|
41 |
|
|
$parser->output_fh(*OUT); |
42 |
|
|
$parser->parse_file(*IN); |
43 |
|
|
|
44 |
|
|
__END__ |
45 |
|
|
|
46 |
|
|
|
47 |
|
|
SEE ALSO |
48 |
|
|
This module also installs a `pod2wiki' command line utility. See |
49 |
|
|
`pod2wiki --help' for details. |
50 |
|
|
|
51 |
|
|
|
52 |
|
|
AUTHOR |
53 |
|
|
John McNamara jmcnamara@cpan.org |
54 |
|
|
|
55 |
|
|
|
56 |
|
|
COPYRIGHT |
57 |
|
|
© MMIII-MMV, John McNamara. |
58 |
|
|
|
59 |
|
|
All Rights Reserved. This module is free software. It may be |
60 |
|
|
used, redistributed and/or modified under the same terms as Perl |
61 |
|
|
itself. |
62 |
|
|
|