Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

I've always found it very useful and handy to be able to refer to print in a normal sentence, whithout having to think about linking too consciously. Just like how people sometimes use "()", like in int() to indicate something is a function, it is handy on Perl monks to do so with "[]", like in [int], and have it link to the documentatin. The power of usability in these links is the lack of schema. (And the high threshold in using Perl Monks's schema links is made even higher by the mandatory "//" after the colon.)

Even if just a stub page linking to the perldoc.perl.org, perldoc pages here would be a good idea. It's laudable that you don't want to break old links (though in that respect, changing titles of 2 year old nodes certainly doesn't help much), but I think there should also be a focus on the future. This focus should not just be pure, it should also dwim. (I'm referring to Perl versus other languages. I think it's dwimmy to say [perlop], and needlessly (unperlishly) verbose to say [doc://perlop].)

Perldocs are very well defined, and only very few are added. When one is added, the stub can be introduced by any user. I volunteer for updating perlcheat to point to the actual up-to-date document on perldoc.perl.org; In fact, I'll do so right away. :)

There are two things regarding perldocs on Perl Monks that "seemed like a good idea [at the time]", namely mirroring documents here, and having short intuitive dwimmy links. One of them still is.

As for updating old nodes, you're kidding, right?

Juerd # { site => 'juerd.nl', do_not_use => 'spamtrap', perl6_server => 'feather' }


In reply to Re^2: I want site documentation updates and I want them now. by Juerd
in thread I want site documentation updates and I want them now. by Juerd

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 learning in the Monastery: (5)
As of 2024-04-19 12:35 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found