Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

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

Per castaway's request:


General Guidelines for Picking Keywords

Since I have been starting with my writeups - nodes whose roots I've authored or to which I've replied - I have tried to take into consideration both the root node and its replies when picking keywords. (As opposed to keywording nodes which have no replies yet.) So...

  • Modules mentioned in the root node or in replies (those that are either the problem or a possible solution, such as "XML::Simple", for example); problems with modules (or installing modules) in a more general sense get tagged with "modules" and/or "installing".

  • "Automation" is what MS calls it when you use one app to drive another, so that's what I'm calling using Win32::OLE to drive an app such as Excel from Perl (since people more familiar with MS stuff than Perl are more likely to type that into a keyword search than the module name); plus I mention the module, Win32::OLE, for the more Perly types. In other words, I try to use keywords that people coming from "outside" the Monastery might try first.

  • If I know of a term(s) that is synonymous, I try to get that in, too... Like "Ngram" and "Markov Chain," or "course," "class," and "training"...

  • If there is a common abbreviation for something mentioned in the offered solutions (such as "LCS" for "Longest Common Substring", or "KWIC" for "KeyWord in Context"), then I include that... especially since "Longest Common Substring" won't fit in the input area for the Keyword Nodelet. ;-)

  • When the question (and/or solution) depends heavily on a particular method, option, or hash key (Text::ExtractWords minwordlen and maxwordlen re: "minlen/minwordlen - maxlen/maxwordlen" and Re: XML::Simple "transforming data" re: "NoAttr"), I try to get those in.

HTH,

planetscape

In reply to Re: Keyword Nodelet / Tagging documentation by planetscape
in thread Keyword Nodelet / Tagging documentation by castaway

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 surveying the Monastery: (4)
As of 2024-03-29 11:22 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found