diff options
Diffstat (limited to 'pod/perlpod.pod')
| -rw-r--r-- | pod/perlpod.pod | 14 |
1 files changed, 4 insertions, 10 deletions
diff --git a/pod/perlpod.pod b/pod/perlpod.pod index d20d62d06a..731a0fbd3d 100644 --- a/pod/perlpod.pod +++ b/pod/perlpod.pod @@ -11,7 +11,6 @@ L<verbatim|/"Verbatim Paragraph">, L<command|/"Command Paragraph">, and L<ordinary text|/"Ordinary Block of Text">. - =head2 Verbatim Paragraph A verbatim paragraph, distinguished by being indented (that is, @@ -20,7 +19,6 @@ with tabs assumed to be on 8-column boundaries. There are no 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 @@ -75,7 +73,6 @@ or use "=item 1.", "=item 2.", etc., to produce numbered lists, or use 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 @@ -149,10 +146,8 @@ Some examples of lists include: =back - =back - =head2 Ordinary Block of Text It will be filled, and maybe even @@ -171,7 +166,8 @@ here and in commands: (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"> @@ -184,13 +180,14 @@ here and in commands: 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 @@ -220,7 +217,6 @@ TeX, and other markup languages, as used for online documentation. 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 @@ -233,7 +229,6 @@ directive. __END__ - =head1 NAME modern - I am a modern module @@ -241,7 +236,6 @@ directive. If you had not had that empty line there, then the translators wouldn't have seen it. - =head2 Common Pod Pitfalls =over 4 |