Contents of /Pod-Simple-Wiki/README

NAME
    Pod::Simple::Wiki - A class for creating Pod to Wiki filters.


DESCRIPTION
    The `Pod::Simple::Wiki' module is used for converting Pod text
    to Wiki text.

    Pod (Plain Old Documentation) is a simple markup language used
    for writing Perl documentation.

    A Wiki is a user extensible web site. It uses very simple mark-
    up that is converted to Html.

    For an introduction to Wikis see:
    http://en.wikipedia.org/wiki/Wiki


SYNOPSIS
    To create a simple `pod2wiki' filter:

        #!/usr/bin/perl -w

        use strict;
        use Pod::Simple::Wiki;

        my $parser = Pod::Simple::Wiki->new();

        if (defined $ARGV[0]) {
            open IN, $ARGV[0]  or die "Couldn't open $ARGV[0]: $!\n";
        } else {
            *IN = *STDIN;
        }

        if (defined $ARGV[1]) {
            open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n";
        } else {
            *OUT = *STDOUT;
        }

        $parser->output_fh(*OUT);
        $parser->parse_file(*IN);

        __END__


SEE ALSO
    This module also installs a `pod2wiki' command line utility. See
    `pod2wiki --help' for details.


AUTHOR
    John McNamara jmcnamara@cpan.org


COPYRIGHT
    © MMIII-MMV, John McNamara.

    All Rights Reserved. This module is free software. It may be
    used, redistributed and/or modified under the same terms as Perl
    itself.

1	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