Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
Maybe it's me, but it seems like alot of posts to SoPW have been vague and/or ambiguous. After doing a search of this site, the only information regarding and writeup do's dont's is Writeup Formatting Tips , I want to ask a question of the Perl Monks; where do I start?. Now, possibly, if I did a more exhaustive search, I may come up with more reference to this topic, but I feel that this type of information should be contained directly in Perl Monks Site FAQ or Site How To. So, I decided to write a little something:

Seekers of Perl Wisdom Writeup Guidelines


Here are some basic guidelines for submitting a question to Seekers of Perl Wisdom:

  • First, and foremost, be able to articulate your question. Chances are, that if you can't, monks will not understand your problem and you won't get the answer(s) that you need.
  • Written "descriptions" of what you're trying to do, and what problems you are running into will rarely suffice, without accompanying code. Don't be bashful! Post what you have - as "ugly" or "wrong" as it might be. No one will persecute you for trying to figure out a problem on your own!
  • Which brings me to the next point: PLEASE, don't post a question, like, "I want a program that will do XYZ, then mail the output to ABC, and write it to a file. How can I write it?....". Chances are if you post a question like that, you will be downvoted, or altogether ignored.
  • Read Writing Formatting Tips before actually posting code. As you write your post, you will always have the option to preview your post. Exersise that option =).
  • Use Super Search to search for possible answers to your question. As this is a large, and active community here, there is a good chance that your question has been answered before.
  • Read previous Seekers of Perl Wisdom posts for ideas on how to pose your question.
  • There is rarely (if ever) a need to post hundreds of lines of code to get an answer to your problem. If you feel the need to do that, step back for a minute, attempt to debug your program yourself (I assume that you are already using -w and use strict;. Post only the code which is pertinent to the specific problem you are having. If you're post is going to be lengthy, be considerate and use <READMORE> tags.
  • There are alot of online resources here; take the time to read through them.
  • Read through: Voting Guidelines (or 'How should I spend my votes?'). There are some helpful hints contained in this document.

My final suggestion is that you are not already, become a member of PerlMonks.org. This is an extremely knowledgeable and helpful community we have.

Edit 2001-05-12 by tye to add a missing > that was preventing the subsequent </ul> from being parsed


In reply to Writeup Guidelines by Tuna

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 admiring the Monastery: (5)
As of 2024-03-28 13:08 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found