RFC. First Draft of proposed, shortform, guide to posting SOPW. Cuts, refs, negatives (but, yes, we all know that some people won't read guidance, no matter how brief) welcomed!
5 Jan update: Reviewing Marto's suggestion, below, and the ++'s -- which in this case, I read as agreement -- how say ye to adding (as I've done below) li 7? Or do you lean to Eliya's view? I've also replaced the "Ditto" in li 3. Also, reordered to keep code questions together.
So, you're gonna' post a SOPW? Unneeded in last-second checklist. Stricken 5 Jan
Here's a brief checklist for your question.
- Code tags ( <c> ... </c> ) tags around data and code?
- Includes a tiny snippet of (compilable) code that reproduces/illustrates your problem?
- Narrative description (not "doesn't work") of how that code falls short of your needs or expectations?
- Also provides sample data?
- Quoted, verbatim, all error messages and warnings (again, inside code tags!)?
- A title that identifies your topic (and no, that doesn't mean "Help, please" or a module name alone)?
- Post your OS, Perl (perl -v) and module (if relevant) versions?
Here's some additional reference material:
On asking for help | How do I post a question effectively?
I know what I mean. Why don't you? | Markup in the Monastery
... and read the formatting tips around the the text-input and preview-edit boxes!
See luis.roca's Re: RFC - shortform posting guidance for newcomers.
-
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.
|
