The updated version (as of 2009-02-15) seems shabby. This criticism doesn't really help, but I am not sure how to describe it. Are you trying to 'dumb it down' for the sake of the readers or something?

Maybe it is the mixture of the different fonts sizes and boldness~

Update: Perhaps the short version could be better organized, so that you do not have the clashing font sizes. Maybe remove the short version intro paragraph and have a fully documented example node.

## Example node - Text in parentheses are side notes from which the us
+er is to learn

<p>Hi all, I have a problem regarding blah blah blah. (Give relevant b
+ackground information and briefly describe the problem.)</p>

<p>I have read the documentation already (Make sure to link to the doc
+umentation, if applicable. Also make sure that you read the documenta
+tion, if applicable), but I am still having a bit of trouble. The pro
+blematic code follows.</p>

(Make sure that the code you post is relevant to the specific issue yo
+u are having, and try to keep it short. Short enough to correctly rep
+licate the problem, anyway.)

<code>
#!/usr/bin/perl

# (The following two lines are important. No one will want to help you
+ if you do not have them. Keep that in mind.)

use warnings;
use strict;

my $var = blah blah;
print $var;
</code>

<p>As previously mentioned, the above code gives me an error:</p>

<code>
Can't locate object method "blah" via package "blah" (perhaps you forg
+ot to load "blah"?) at test.pl line 7.
</code>

<p>Any and all help appreciated.</p>

[download]

I realize that it is usually not as simple as that but I figure it is good enough to copy/paste into their node and edit appropriately (or something). I also realize that the example I gave should be vastly improved in terms of readability and correctness -- mine is just an example :P

And you didn't even know bears could type.

In reply to Re: RFC - How to ask... by Lawliet
in thread RFC - How to ask... by ww

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.