diff options
Diffstat (limited to 'contrib/perl5/pod/perlpod.pod')
| -rw-r--r-- | contrib/perl5/pod/perlpod.pod | 69 |
1 files changed, 48 insertions, 21 deletions
diff --git a/contrib/perl5/pod/perlpod.pod b/contrib/perl5/pod/perlpod.pod index 7fa8290..6c0c534 100644 --- a/contrib/perl5/pod/perlpod.pod +++ b/contrib/perl5/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,20 +146,19 @@ Some examples of lists include: =back - =back - =head2 Ordinary Block of Text It will be filled, and maybe even justified. Certain interior sequences are recognized both here and in commands: - I<text> italicize text, used for emphasis or variables - B<text> embolden text, used for switches and programs - S<text> text contains non-breaking spaces - C<code> literal code + I<text> Italicize text, used for emphasis or variables + B<text> Embolden text, used for switches and programs + S<text> Text contains non-breaking spaces + C<code> Render code in a typewriter font, or give some other + indication that this represents program text L<name> A link (cross reference) to name L<name> manual page L<name/ident> item in manual page @@ -178,7 +174,7 @@ here and in commands: L<text|name/"sec"> L<text|"sec"> L<text|/"sec"> - + F<file> Used for filenames X<index> An index entry Z<> A zero-width character @@ -193,6 +189,40 @@ here and in commands: E<html> Some non-numeric HTML entity, such as E<Agrave> +Most of the time, you will only need a single set of angle brackets to +delimit the beginning and end of interior sequences. However, sometimes +you will want to put a right angle bracket (or greater-than sign '>') +inside of a sequence. This is particularly common when using a sequence +to provide a different font-type for a snippet of code. As with all +things in Perl, there is more than one way to do it. One way is to +simply escape the closing bracket using an C<E> sequence: + + C<$a E<lt>=E<gt> $b> + +This will produce: "C<$a E<lt>=E<gt> $b>" + +A more readable, and perhaps more "plain" way is to use an alternate set of +delimiters that doesn't require a ">" to be escaped. As of perl5.5.660, +doubled angle brackets ("<<" and ">>") may be used I<if and only if there +is whitespace immediately following the opening delimiter and immediately +preceding the closing delimiter!> For example, the following will do the +trick: + + C<< $a <=> $b >> + +In fact, you can use as many repeated angle-brackets as you like so +long as you have the same number of them in the opening and closing +delimiters, and make sure that whitespace immediately follows the last +'<' of the opening delimiter, and immediately precedes the first '>' of +the closing delimiter. So the following will also work: + + C<<< $a <=> $b >>> + C<<<< $a <=> $b >>>> + +This is currently supported by pod2text (Pod::Text), pod2man (Pod::Man), +and any other pod2xxx and Pod::Xxxx translator that uses Pod::Parser +1.093 or later. + =head2 The Intent @@ -223,7 +253,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 @@ -236,7 +265,6 @@ directive. __END__ - =head1 NAME modern - I am a modern module @@ -244,7 +272,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 @@ -263,16 +290,15 @@ B<pod2man> for details). Thus, you shouldn't write things like C<the LE<lt>fooE<gt> manpage>, if you want the translated document to read sensibly. -If you don need or want total control of the text used for a -link in the output use the form LE<lt>show this text|fooE<gt> -instead. +If you need total control of the text used for a link in the output +use the form LE<lt>show this text|fooE<gt> instead. =item * -The script F<pod/checkpods.PL> in the Perl source distribution -provides skeletal checking for lines that look empty but aren't -B<only>, but is there as a placeholder until someone writes -Pod::Checker. The best way to check your pod is to pass it through +The B<podchecker> command is provided to check pod syntax +for errors and warnings. For example, it checks for completely +blank lines in pod segments and for unknown escape sequences. +It is still advised to pass it through one or more translators and proofread the result, or print out the result and proofread that. Some of the problems found may be bugs in the translators, which you may or may not wish to work around. @@ -281,7 +307,8 @@ the translators, which you may or may not wish to work around. =head1 SEE ALSO -L<pod2man> and L<perlsyn/"PODs: Embedded Documentation"> +L<pod2man>, L<perlsyn/"PODs: Embedded Documentation">, +L<podchecker> =head1 AUTHOR |
