UPDATE: Plz see Re^4: using <pre> tags for citing perldocs! (Solution with personal "Display Settings") !

Hi

using <pre> tags are considered a sin within the monastery, but I wanna suggest to use them when citing from perldocs and similar sources.

When displayed in a terminalš the docs already have a hard linebreak only some characters longer than <code> has, always inserting "+" breakes for these <10 chars IMHO doesn't worth it.

Please compare the readability of

using <code>

        The auto-increment operator has a little extra builtin magic t
+o it.
 
...
       "undef" is always treated as numeric, and in particular is chan
+ged to 0
       before incrementing (so that a post-increment of an undef value
+ will
       return 0 rather than "undef").

[download]

using <pre>

        The auto-increment operator has a little extra builtin magic to it.
 
...
       "undef" is always treated as numeric, and in particular is changed to 0
       before incrementing (so that a post-increment of an undef value will
       return 0 rather than "undef").

if someone is concerend about font-size you might add additional <tt>

using <pre><tt>


        The auto-increment operator has a little extra builtin magic to it.
 
...
       "undef" is always treated as numeric, and in particular is changed to 0
       before incrementing (so that a post-increment of an undef value will
       return 0 rather than "undef").

Another possibility could be to augment the chars/line number in <code> to allow easy citing of perldocs.

Cheers Rolf

1) hmm depends on the terminal-with but perldoc seem to have a min-width of 80 chars.

UPDATE: Hmm ... the line-width of perldocs seems to be a convention, it depends on the author if he wraps after 80 chars.

The synopsis of Scalar::Util is an example for bad formatting.

In reply to using <pre> tags for citing perldocs! by LanX

Title:
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, details, 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, summary, 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.