L<command|/"Command Paragraph">, and
L<ordinary text|/"Ordinary Block of Text">.
-
=head2 Verbatim Paragraph
A verbatim paragraph, distinguished by being indented (that is,
special formatting escapes, so you can't italicize or anything
like that. A \ means \, and nothing else.
-
=head2 Command Paragraph
All command paragraphs start with "=", followed by an
or numbers. If you start with bullets or numbers, stick with them, as many
formatters use the first "=item" type to decide how to format the list.
-
=item =for
=item =begin
=back
-
=back
-
=head2 Ordinary Block of Text
It will be filled, and maybe even
(the quotes are optional)
L</"sec"> ditto
same as above but only 'text' is used for output.
- (Text can not contain the characters '|' or '>')
+ (Text can not contain the characters '/' and '|',
+ and should contain matched '<' or '>')
L<text|name>
L<text|name/ident>
L<text|name/"sec">
E<escape> A named character (very similar to HTML escapes)
E<lt> A literal <
E<gt> A literal >
+ E<sol> A literal /
+ E<verbar> A literal |
(these are optional except in other interior
sequences and when preceded by a capital letter)
E<n> Character number n (probably in ASCII)
E<html> Some non-numeric HTML entity, such
as E<Agrave>
-
=head2 The Intent
That's it. The intent is simplicity, not power. I wanted paragraphs
Translators exist for B<pod2man> (that's for nroff(1) and troff(1)),
B<pod2text>, B<pod2html>, B<pod2latex>, and B<pod2fm>.
-
=head2 Embedding Pods in Perl Modules
You can embed pod documentation in your Perl scripts. Start your
__END__
-
=head1 NAME
modern - I am a modern module
If you had not had that empty line there, then the translators wouldn't
have seen it.
-
=head2 Common Pod Pitfalls
=over 4
projects / p5sagit/p5-mst-13.2.git / blobdiff