Skip to content

Commit

Permalink
v0.19
Browse files Browse the repository at this point in the history
  • Loading branch information
xdg committed Feb 23, 2012
1 parent bb6cffc commit edf0637
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion META.json
@@ -1,5 +1,5 @@
{
"abstract" : "Generate Pod from inline wiki style text ",
"abstract" : "Generate Pod from inline wiki style text",
"author" : [
"David A Golden <dagolden@cpan.org>"
],
Expand Down
42 changes: 21 additions & 21 deletions README.pod
Expand Up @@ -2,7 +2,7 @@

=head1 NAME

Pod::WikiDoc - Generate Pod from inline wiki style text
Pod::WikiDoc - Generate Pod from inline wiki style text

=head1 VERSION

Expand Down Expand Up @@ -42,11 +42,11 @@ In a source file, wikidoc comment-block style:
Generate Pod from wikidoc, programmatically:

use Pod::WikiDoc;
my $parser = Pod::WikiDoc->new( {
my $parser = Pod::WikiDoc->new( {
comment_blocks => 1,
keywords => { KEYWORD => "foo" },
} );
$parser->filter(
$parser->filter(
{ input => "my_module.pm", output => "my_module.pod" }
);

Expand All @@ -65,20 +65,20 @@ file.

Documentation written in wikidoc may be embedded in Pod format blocks, or,
optionally, in specially marked comment blocks. Wikidoc uses simple text-based
markup like wiki websites to indicate formatting and links. (See
markup like wiki websites to indicate formatting and links. (See
L</WIKIDOC MARKUP>, below.)

Pod::WikiDoc processes text files (or text strings) by extracting both
existing Pod and wikidoc, converting the wikidoc to Pod, and then writing
the combined document back to a file or standard output.
the combined document back to a file or standard output.

Summary of major features of Pod::WikiDoc:

=over

=item *

Extracts and converts wikidoc from Pod format blocks or special
Extracts and converts wikidoc from Pod format blocks or special
wikidoc comment blocks

=item *
Expand Down Expand Up @@ -107,7 +107,7 @@ Preserves other Pod escape sequences, e.g. EE<lt>euroE<gt>
In addition, Pod::WikiDoc provides a command-line utility, L<wikidoc>,
to simplify wikidoc translation.

See the L<Pod::WikiDoc::Cookbook> for more detailed usage examples,
See the L<Pod::WikiDoc::Cookbook> for more detailed usage examples,
including how to automate C<<< .pod >>> generation when using L<Module::Build>.

=head1 INTERFACE
Expand All @@ -116,7 +116,7 @@ including how to automate C<<< .pod >>> generation when using L<Module::Build>.

$parser = Pod::WikiDoc->new( \%args );

Constructor for a new Pod::WikiDoc object. It takes a single, optional
Constructor for a new Pod::WikiDoc object. It takes a single, optional
argument: a hash reference with the following optional keys:

=over
Expand All @@ -128,7 +128,7 @@ blocks. Default is false.

=item *

C<<< comment_prefix_length >>>: the number of leading sharp (#) symbols to
C<<< comment_prefix_length >>>: the number of leading sharp (#) symbols to
denote a comment block. Default is 3.

=item *
Expand All @@ -151,19 +151,19 @@ a 'Generated by' header.

$parser->filter( \%args );

Filters from an input file for Pod and wikidoc, translating it to Pod
Filters from an input file for Pod and wikidoc, translating it to Pod
and writing it to an output file. The output file will be prefixed with
a 'Generated by' comment with the version of Pod::WikiDoc and timestamp,
as required by L<perlpodspec>.

C<<< filter >>> takes a single, optional argument: a hash reference with
C<<< filter >>> takes a single, optional argument: a hash reference with
the following optional keys:

=over

=item *

C<<< input >>>: a filename or filehandle to read from. Defaults to STDIN.
C<<< input >>>: a filename or filehandle to read from. Defaults to STDIN.

=item *

Expand All @@ -177,16 +177,16 @@ and the file already exists, it will be clobbered. Defaults to STDOUT.
my $pod_text = $parser->format( $wiki_text );

Given a string with valid Pod andE<sol>or wikidoc markup, filterE<sol>translate it to
Pod. Unlike C<<< convert >>>, no 'Generated by' comment is added. This
Pod. Unlike C<<< convert >>>, no 'Generated by' comment is added. This
function is used internally by Pod::WikiDoc, but is being made available
as a public method for users who want more granular control of the
as a public method for users who want more granular control of the
translation process or who want to convert wikidoc to Pod for other
creative purposes using the Pod::WikiDoc engine.

=head1 WIKIDOC MARKUP

Pod::WikiDoc uses a wiki-style text markup, called wikidoc. It is heavily
influenced by L<Kwiki>. Like other wiki markup, it has both block and
influenced by L<Kwiki>. Like other wiki markup, it has both block and
inline elements, which map directly to their Pod equivalents.

Block elements include:
Expand Down Expand Up @@ -215,7 +215,7 @@ Ordinary paragraphs

=back

Block elements should be separated by a blank line (though Pod::WikiDoc
Block elements should be separated by a blank line (though Pod::WikiDoc
will do the right thing in many cases if you don't).

Inline elements include:
Expand Down Expand Up @@ -258,7 +258,7 @@ a backslash (\). Including a literal backslash requires a double-backslash

Headers are indicated with one or more equals signs followed by whitespace in
the first column. The number of equals signs indicates the level of the
header (the maximum is four). Headers can not span multiple lines.
header (the maximum is four). Headers can not span multiple lines.

= header level 1

Expand All @@ -269,7 +269,7 @@ header (the maximum is four). Headers can not span multiple lines.
Verbatim text is indicated with leading whitespace in each line of text,
just as with Pod.

#<--- first column
#<--- first column

sub verbatim {}

Expand Down Expand Up @@ -343,7 +343,7 @@ inside of other markup.
Pod-style escape text is passed through as normal to support international
or other unusual characters.

This is the euro symbol: E<euro>
This is the euro symbol: E<euro>

=head2 Keyword markup

Expand Down Expand Up @@ -414,8 +414,8 @@ conflict.

=item *

Module::Build before 0.28 does not look in external C<<< .pod >>> files
to generate a C<<< README >>> with the C<<< create_readme >>> option or to find a module
Module::Build before 0.28 does not look in external C<<< .pod >>> files
to generate a C<<< README >>> with the C<<< create_readme >>> option or to find a module
abstract. Set the abstract manually in the C<<< Build.PL >>> file with the
C<<< dist_abstract >>> option.

Expand Down

0 comments on commit edf0637

Please sign in to comment.