Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
see Counterexample

Cheers Rolf

UPDATE:

Hints for Writing Pod

...

Many older Pod translators require the lines before every Pod command and after every Pod command (including "=cut"!) to be a blank line. Having something like this:

# - - - - - - - - - - - - =item $firecracker->boom() This noisily detonates the firecracker object. =cut sub boom { ...
...will make such Pod translators completely fail to see the Pod block at all.

Instead, have it like this:

# - - - - - - - - - - - - =item $firecracker->boom() This noisily detonates the firecracker object. =cut sub boom { ...

from perlpod, underlines added

UPDATE:

> perldoc perlpod |grep -2n " empty "|sed 's/ / /' 488- 489- You can embed Pod documentation in your Perl modules and scripts +. 490: Start your documentation with an empty line, a "=head1" command +at the 491: beginning, and end it with a "=cut" command and an empty line. +Perl 492- will ignore the Pod text. See any of the supplied library modul +es for 493- examples. If you’re going to put your Pod at the end of the fil +e, and -- 501- Time::Local - efficiently compute time from local and GMT time 502- 503: Without that empty line before the "=head1", many translators wo +uldn’t 504- have recognized the "=head1" as starting a Pod block. 505- -- 553- · Some older Pod translators require paragraphs (including com +mand 554- paragraphs like "=head2 Functions") to be separated by compl +etely 555: empty lines. If you have an apparently empty line with some + spaces 556- on it, this might not count as a separator for those transla +tors, 557- and that could cause odd formatting.

In reply to Re^7: POD troubles (RTFM) by LanX
in thread POD troubles by John M. Dlugosz

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others wandering the Monastery: (6)
As of 2021-11-30 13:10 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?