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??
tye:

No argument; my wording -- as originally posted and still, as revised -- sucks compared to Luis.Roca's (at Re: RFC - shortform posting guidance for newcomers which is much better. Maybe the existing language is best.

But (yep, clarifying info here) I'm still thinking in terms of forcing newcomers to see (and sure, some incorrigibles may just click thru) the advice either before getting to the text entry box or at the preview phase.

If at the preview phase, it seems to me we could automate a test (are there any code tags? para tags). If the previewed text fails the test, then our code could automatically spit out the relevant guidance (such as "Use <p> around narrative </p>"). That's something done by many commercial sites which require (validate) entries. That doesn't seem to stop commerce... and though that's commonly done with js, we do have (pure-Perl) alternate options, do we not?

Objections (and answers):

  • The test, as sketched above, would fail in the case of a one-sentence reply where the lack of para tags makes no difference to the rendering.
    But this is an edge case, and if someone has to put para tags around that single sentence, perhaps they'll remember to do so when next they post something more complex.
  • Such a test would be hard to write.
    Disagree and believe I can do that. What I find hard -- and where I defer to those with stronger 'everything-fu' is how to retain the user's input for correction, without js.

Finally, (I think I'm agreeing here), the below-box help needs help. It is "busy" but needs, in your words, "terseness, clarity, snappiness."

Update - Note to protect the good Monks reputation: this was posted after Re^3: RFC - shortform posting guidance for newcomers (meh) and Re^4: RFC - shortform posting guidance for newcomers (meh) and is merely a very rough PofC:

#!/usr/bin/perl use Modern::Perl; # test the content submitted for preview -- for code and para tags $/="#####"; # will be followed by addtl samples -- good and bad my $nopara = 0; my $nocode = 0; my $preview = <DATA>; # print $preview; my @preview = split /\n/, $preview; for $_(@preview) { # say "\t Ln14, \$_: $_"; if ( $_ =~ /!<p/) { $nopara++; } if ( $_ =~ /(<\/\s*br>)/ ) { # arguably, this could be a s/ +// rather than a warning say "\n\t Bad tag -- &quot;$1&quot; -- found in \n \t $_\n"; } if ( $_ =~ /!<(c.*).*[;}] <\/c$1>/) { $nocode++; say "\n\t Do you need code tags in \n\t $_?\n?"; } } if ($nopara == 0 ) { print "\n\t You don't have any &lt;p> paragraph tags &lt;/p> in yo +ur draft. Do you need some?\n"; } if ($nocode == 0 ) { print "\n\t You don't have a &lt;c> code tag pair &lt;/c> in your +draft. Is that correct?\n"; } print "\n\n @preview\n"; # imperfect, as a good <br> gets ignored, b +ut perfectable __DATA__ I wantz to know if i can do this</br> <c>my $foo = 'bar' if (bar == bar); cuz that would be really cool.<br> oh, also, would somebody teach me how to use your parlmenks markup? love, foobar ########

Output:

Bad tag -- &quot;</br>&quot; -- found in I wantz to know if i can do this</br> You don't have any &lt;p> paragraph tags &lt;/p> in your draf +t. Do you need some? You don't have a &lt;c> code tag pair &lt;/c> in your draft. +Is that correct? I wantz to know if i can do this</br> <c>my $foo = 'bar' if (bar == b +ar); cuz that would be really cool.<br> oh, also, would somebody tea +ch me how to use your parlmenks markup? love, foobar #####

More to come, but please pile in (or "on" if that's your preference). :-)


In reply to Re^2: RFC - shortform posting guidance for newcomers (meh) by ww
in thread RFC - shortform posting guidance for newcomers by ww

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 contemplating the Monastery: (2)
As of 2024-04-25 02:17 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found