lib/perl5/5.6.1/pods/perlpod.pod

   1 =head1 NAME
   2
   3 perlpod - plain old documentation
   4
   5 =head1 DESCRIPTION
   6
   7 A pod-to-whatever translator reads a pod file paragraph by paragraph,
   8 and translates it to the appropriate output format.  There are
   9 three kinds of paragraphs:
  10 L<verbatim|/"Verbatim Paragraph">,
  11 L<command|/"Command Paragraph">, and
  12 L<ordinary text|/"Ordinary Block of Text">.
  13
  14 =head2 Verbatim Paragraph
  15
  16 A verbatim paragraph, distinguished by being indented (that is,
  17 it starts with space or tab).  It should be reproduced exactly,
  18 with tabs assumed to be on 8-column boundaries.  There are no
  19 special formatting escapes, so you can't italicize or anything
  20 like that.  A \ means \, and nothing else.
  21
  22 =head2 Command Paragraph
  23
  24 All command paragraphs start with "=", followed by an
  25 identifier, followed by arbitrary text that the command can
  26 use however it pleases.  Currently recognized commands are
  27
  28     =head1 heading
  29     =head2 heading
  30     =item text
  31     =over N
  32     =back
  33     =cut
  34     =pod
  35     =for X
  36     =begin X
  37     =end X
  38
  39 =over 4
  40
  41 =item =pod
  42
  43 =item =cut
  44
  45 The "=pod" directive does nothing beyond telling the compiler to lay
  46 off parsing code through the next "=cut".  It's useful for adding
  47 another paragraph to the doc if you're mixing up code and pod a lot.
  48
  49 =item =head1
  50
  51 =item =head2
  52
  53 Head1 and head2 produce first and second level headings, with the text in
  54 the same paragraph as the "=headn" directive forming the heading description.
  55
  56 =item =over
  57
  58 =item =back
  59
  60 =item =item
  61
  62 Item, over, and back require a little more explanation: "=over" starts a
  63 section specifically for the generation of a list using "=item" commands. At
  64 the end of your list, use "=back" to end it. You will probably want to give
  65 "4" as the number to "=over", as some formatters will use this for indentation.
  66 The unit of indentation is optional. If the unit is not given the natural
  67 indentation of the formatting system applied will be used. Note also that
  68 there are some basic rules to using =item: don't use them outside of
  69 an =over/=back block, use at least one inside an =over/=back block, you don't
  70 _have_ to include the =back if the list just runs off the document, and
  71 perhaps most importantly, keep the items consistent: either use "=item *" for
  72 all of them, to produce bullets, or use "=item 1.", "=item 2.", etc., to
  73 produce numbered lists, or use "=item foo", "=item bar", etc., i.e., things
  74 that looks nothing like bullets or numbers. If you start with bullets or
  75 numbers, stick with them, as many formatters use the first "=item" type to
  76 decide how to format the list.
  77
  78 =item =for
  79
  80 =item =begin
  81
  82 =item =end
  83
  84 For, begin, and end let you include sections that are not interpreted
  85 as pod text, but passed directly to particular formatters. A formatter
  86 that can utilize that format will use the section, otherwise it will be
  87 completely ignored.  The directive "=for" specifies that the entire next
  88 paragraph is in the format indicated by the first word after
  89 "=for", like this:
  90
  91  =for html <br>
  92   <p> This is a raw HTML paragraph </p>
  93
  94 The paired commands "=begin" and "=end" work very similarly to "=for", but
  95 instead of only accepting a single paragraph, all text from "=begin" to a
  96 paragraph with a matching "=end" are treated as a particular format.
  97
  98 Here are some examples of how to use these:
  99
 100  =begin html
 101
 102  <br>Figure 1.<IMG SRC="figure1.png"><br>
 103
 104  =end html
 105
 106  =begin text
 107
 108    ---------------
 109    |  foo        |
 110    |        bar  |
 111    ---------------
 112
 113  ^^^^ Figure 1. ^^^^
 114
 115  =end text
 116
 117 Some format names that formatters currently are known to accept include
 118 "roff", "man", "latex", "tex", "text", and "html". (Some formatters will
 119 treat some of these as synonyms.)
 120
 121 And don't forget, when using any command, that the command lasts up until
 122 the end of the B<paragraph>, not the line. Hence in the examples below, you
 123 can see the empty lines after each command to end its paragraph.
 124
 125 Some examples of lists include:
 126
 127  =over 4
 128
 129  =item *
 130
 131  First item
 132
 133  =item *
 134
 135  Second item
 136
 137  =back
 138
 139  =over 4
 140
 141  =item Foo()
 142
 143  Description of Foo function
 144
 145  =item Bar()
 146
 147  Description of Bar function
 148
 149  =back
 150
 151 =back
 152
 153 =head2 Ordinary Block of Text
 154
 155 It will be filled, and maybe even
 156 justified.  Certain interior sequences are recognized both
 157 here and in commands:
 158
 159     I<text>     Italicize text, used for emphasis or variables
 160     B<text>     Embolden text, used for switches and programs
 161     S<text>     Text contains non-breaking spaces
 162     C<code>     Render code in a typewriter font, or give some other
 163                 indication that this represents program text
 164     L<name>     A link (cross reference) to name
 165                     L<name>             manual page
 166                     L<name/ident>       item in manual page
 167                     L<name/"sec">       section in other manual page
 168                     L<"sec">            section in this manual page
 169                                         (the quotes are optional)
 170                     L</"sec">           ditto
 171                 same as above but only 'text' is used for output.
 172                 (Text can not contain the characters '/' and '|',
 173                 and should contain matched '<' or '>')
 174                     L<text|name>
 175                     L<text|name/ident>
 176                     L<text|name/"sec">
 177                     L<text|"sec">
 178                     L<text|/"sec">
 179
 180     F<file>     Used for filenames
 181     X<index>    An index entry
 182     Z<>         A zero-width character
 183     E<escape>   A named character (very similar to HTML escapes)
 184                     E<lt>               A literal <
 185                     E<gt>               A literal >
 186                     E<sol>              A literal /
 187                     E<verbar>           A literal |
 188                     (these are optional except in other interior
 189                      sequences and when preceded by a capital letter)
 190                     E<n>                Character number n (probably in ASCII)
 191                     E<html>             Some non-numeric HTML entity, such
 192                                         as E<Agrave>
 193
 194 Most of the time, you will only need a single set of angle brackets to
 195 delimit the beginning and end of interior sequences.  However, sometimes
 196 you will want to put a right angle bracket (or greater-than sign '>')
 197 inside of a sequence.  This is particularly common when using a sequence
 198 to provide a different font-type for a snippet of code.  As with all
 199 things in Perl, there is more than one way to do it.  One way is to
 200 simply escape the closing bracket using an C<E> sequence:
 201
 202     C<$a E<lt>=E<gt> $b>
 203
 204 This will produce: "C<$a E<lt>=E<gt> $b>"
 205
 206 A more readable, and perhaps more "plain" way is to use an alternate set of
 207 delimiters that doesn't require a ">" to be escaped.  As of perl5.5.660,
 208 doubled angle brackets ("<<" and ">>") may be used I<if and only if there
 209 is whitespace immediately following the opening delimiter and immediately
 210 preceding the closing delimiter!> For example, the following will do the
 211 trick:
 212
 213     C<< $a <=> $b >>
 214
 215 In fact, you can use as many repeated angle-brackets as you like so
 216 long as you have the same number of them in the opening and closing
 217 delimiters, and make sure that whitespace immediately follows the last
 218 '<' of the opening delimiter, and immediately precedes the first '>' of
 219 the closing delimiter.  So the following will also work:
 220
 221     C<<< $a <=> $b >>>
 222     C<<<< $a <=> $b >>>>
 223
 224 This is currently supported by pod2text (Pod::Text), pod2man (Pod::Man),
 225 and any other pod2xxx and Pod::Xxxx translator that uses Pod::Parser
 226 1.093 or later.
 227
 228
 229 =head2 The Intent
 230
 231 That's it.  The intent is simplicity, not power.  I wanted paragraphs
 232 to look like paragraphs (block format), so that they stand out
 233 visually, and so that I could run them through fmt easily to reformat
 234 them (that's F7 in my version of B<vi>).  I wanted the translator (and not
 235 me) to worry about whether " or ' is a left quote or a right quote
 236 within filled text, and I wanted it to leave the quotes alone, dammit, in
 237 verbatim mode, so I could slurp in a working program, shift it over 4
 238 spaces, and have it print out, er, verbatim.  And presumably in a
 239 constant width font.
 240
 241 In particular, you can leave things like this verbatim in your text:
 242
 243     Perl
 244     FILEHANDLE
 245     $variable
 246     function()
 247     manpage(3r)
 248
 249 Doubtless a few other commands or sequences will need to be added along
 250 the way, but I've gotten along surprisingly well with just these.
 251
 252 Note that I'm not at all claiming this to be sufficient for producing a
 253 book.  I'm just trying to make an idiot-proof common source for nroff,
 254 TeX, and other markup languages, as used for online documentation.
 255 Translators exist for B<pod2man>  (that's for nroff(1) and troff(1)),
 256 B<pod2text>, B<pod2html>, B<pod2latex>, and B<pod2fm>.
 257
 258 =head2 Embedding Pods in Perl Modules
 259
 260 You can embed pod documentation in your Perl scripts.  Start your
 261 documentation with a "=head1" command at the beginning, and end it
 262 with a "=cut" command.  Perl will ignore the pod text.  See any of the
 263 supplied library modules for examples.  If you're going to put your
 264 pods at the end of the file, and you're using an __END__ or __DATA__
 265 cut mark, make sure to put an empty line there before the first pod
 266 directive.
 267
 268     __END__
 269
 270     =head1 NAME
 271
 272     modern - I am a modern module
 273
 274 If you had not had that empty line there, then the translators wouldn't
 275 have seen it.
 276
 277 =head2 Common Pod Pitfalls
 278
 279 =over 4
 280
 281 =item *
 282
 283 Pod translators usually will require paragraphs to be separated by
 284 completely empty lines.  If you have an apparently empty line with
 285 some spaces on it, this can cause odd formatting.
 286
 287 =item *
 288
 289 Translators will mostly add wording around a LE<lt>E<gt> link, so that
 290 C<LE<lt>foo(1)E<gt>> becomes "the I<foo>(1) manpage", for example (see
 291 B<pod2man> for details).  Thus, you shouldn't write things like C<the
 292 LE<lt>fooE<gt> manpage>, if you want the translated document to read
 293 sensibly.
 294
 295 If you need total control of the text used for a link in the output
 296 use the form LE<lt>show this text|fooE<gt> instead.
 297
 298 =item *
 299
 300 The B<podchecker> command is provided to check pod syntax
 301 for errors and warnings. For example, it checks for completely
 302 blank lines in pod segments and for unknown escape sequences.
 303 It is still advised to pass it through
 304 one or more translators and proofread the result, or print out the
 305 result and proofread that.  Some of the problems found may be bugs in
 306 the translators, which you may or may not wish to work around.
 307
 308 =back
 309
 310 =head1 SEE ALSO
 311
 312 L<pod2man>, L<perlsyn/"PODs: Embedded Documentation">,
 313 L<podchecker>
 314
 315 =head1 AUTHOR
 316
 317 Larry Wall
 318