Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

comment on

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

Wow, what an improvement over the old FAQ which, every time I reread it, led me to use the Chatterbox incorrectly.

I suppose it's probably a little late for this, but the interface seems a little inconsistent, and I'm a big fan of consistency even if I'm terrible about keeping it. ;^)

For instance, it might be nice if the documented interface ran something like:

  • [user:vroom] for user links
  • [node:979] for nodes
  • [cpan:Parser::XML] for cpan

This is just off-the-cuff you understand, but something like that would certainly be easier for me to remember/use in a day-to-day context.

In reply to RE: (Ovid) RE: Beginning of some quality documentation... hopefully by jreades
in thread Beginning of some quality documentation... hopefully by vroom

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

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?

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

    How do I use this? | Other CB clients
    Other Users?
    Others wandering the Monastery: (5)
    As of 2019-07-18 08:43 GMT
    Find Nodes?
      Voting Booth?

      No recent polls found