Today I posted a message to the perl5-porters mailing list:

Subject: RFC: index core pods with X<>
From: itub@cpan.org

SYNOPSIS

Let's use the X<> POD formatting code for indexing the Perl core documentation. This will allow easier searching of the documentation, and can be incorporated into tools like perldoc or third-party websites.

Followed by a detailed explanation of the project. You can read the original message at http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2005-07/msg01215.html.

The pumpking agreed that it is a good idea, but I need volunteers because otherwise I'll never finish. ;-) The only thing you need to do is go through the documentation and add index entries with X<> in relevant places. If you are interested, please contact me at itub@cpan.org.

When this is done, you'll be able to type 

perldoc -k '<'

[download]
and get the relevant fragments of the documentation that deal with that operator! I already have a preliminary version of perldoc that does that, but the only file I've indexed so far is "perlop".

In reply to The perldoc indexing project needs YOU! by itub

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.