Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

You've come a long way, baby!

Egads! White space. Lots of it! strict, warnings, polite use of Exporter (with @EXPORT_OK), consistent use of indenting, documentation. All good!

Count Zero has made great suggestions. Here's one more. There are some standard conventions about how sections of POD are organized. Here's how I would revise your pod to use more standard headings and organization. However, there are many styles out there and I encourage you to check CPAN for further examples, as well.

=pod =head1 NAME Games::Random::Alignment - generates random alignments for AD&D 2nd Ed +ition. =head1 USAGE use Games::Random::Alignmnet qw(random_alignment); # generate lawful, chaotic, good, evil or neutral random_alignment("parts"); # generate good, neutral or evil random_alignment("good_vs_evil"); # generate lawful, neutral, or chaotic random_alignment("lawful_vs_chaotic"); # generate lawful evil, neutral evil, or chaotic evil. random_alignment("evil"); # generate lawful good, neutral good, or chaotic good. random_alignment("good"); # generate chaotic good, chaotic neutral, or chaotic evil. random_alignment("chaotic"); # generate lawful good, lawful neutral, or lawful evil. random_alignment("lawful"); # generate lawful neutral, true neutral, or chaotic neutral. random_alignment("neutral_lc"); # generate neutral good, true neutral, or neutral evil. random_alignment("neutral_ge"); # generate any two part alignment. random_alignment("any"); =head1 DESCRIPTION This module generates random alignments for AD&D 2nd Edition. When yo +u want to generate a random alignment with this module, you can choos +e from any of the alignment axes. For examples, see the L</USAGE> se +ction above. =head1 AUTHORS Lady Aleena with lots of help from DrForr, whoppix, and rindolf in the + #perlcafe on freenode. =cut

As you have already probably figured out indenting pod causes it to be formatted as code, so all of the usage section will look like code samples. L</Some heading name here> lets you create a link to any other heading (a name introduced by =head1, =head2, etc) in your pod. See perlpod for all the gory details.

Best, beth


In reply to Re: Lady Aleena's first working module by ELISHEVA
in thread Lady Aleena's first working module by Lady_Aleena

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 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?Last hourOther CB clients
Other Users?
Others avoiding work at the Monastery: (4)
As of 2024-04-19 03:48 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found