Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Perl index

by szabgab (Priest)
on Jun 05, 2005 at 18:27 UTC ( #463746=perlmeditation: print w/ replies, xml ) Need Help??

In every class I teach I always get into trouble when asked how to locate the documentation of a keyword, or if a keyword exists at all?

For functions its easy using perldoc -f XYZ but how can one find the syntax of while, basename or echo?
Is there a max function in Perl ?

Pointing to the specific docs for the specific keywords does not help as I need to tell them how can they find the docs.

So I created Perl index that should provide an index to all the keywords mentioned (or not) in the Perl documentation.

The source of it is a hand made yaml file from which I create a pod file that is then goes through Pod:Html.

If this is useful then let this be my present to the Perl community for Shavuot

ps. A lot of work is still needed, but it is already usable.

Comment on Perl index
Re: Perl index
by TedPride (Priest) on Jun 05, 2005 at 22:56 UTC
Re: Perl index
by kaif (Friar) on Jun 06, 2005 at 00:20 UTC

    Wow++! I will find this incredibly useful.

    My only recommendation is that m//, s///, tr//, and such include deep links into perlop (for example, here's the match operator). Those are the non-functions I look up most often.

Re: Perl index
by blokhead (Monsignor) on Jun 06, 2005 at 04:41 UTC
    Well done!
    ... or if a keyword exists at all?
    For that task I have found diotalevi's B::Keywords module extremely convenient (I don't even have it installed, I just browse the source in my web browser).

    It also lists a few other things you may want to include links for, like STDOUT, STDIN, STDERR, __DATA__, __FILE__, __END__, etc...

    blokhead

Re: Perl index
by diotalevi (Canon) on Jun 06, 2005 at 06:39 UTC

    I wrote a test script for your YAML. It checks for completeness. There's a bunch of omissions in your YAML file.

    Updated Steve_p - added readmore tags

      thanks, that's huge help ...
      more work ahead with the index
      Could it also test for the exportable functions of all the standard modules ... ?

      thanks for the other suggestions such as STDIN too...

        I don't have any list of exportables from core perl modules. That's actually kind of hard because modules change more frequently than perl and its difficult to programatically detect what the exports are.
Re: Perl index
by ghenry (Vicar) on Jun 06, 2005 at 11:37 UTC

    Hi,

    Have you thought of working with jj808 to get this or something similar onto perldoc?

    There's no point in duplicating the effort ;-)

    Walking the road to enlightenment... I found a penguin and a camel on the way.....
    Fancy a yourname@perl.me.uk? Just ask!!!
      yep, JJ and I already talked about this but I told him to wait till I collect enough XPs for my post...

      But as you can see all the links from the index go (or should go) to http://perldoc.perl.org

Re: Perl index
by QM (Vicar) on Jun 07, 2005 at 16:04 UTC
    I noticed that your index is sorted case sensitively. For instance, STDIN comes before Scope. Is that what you intended?

    -QM
    --
    Quantum Mechanics: The dreams stuff is made of

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: perlmeditation [id://463746]
Approved by ysth
Front-paged by Old_Gray_Bear
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (15)
As of 2014-09-17 14:22 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    How do you remember the number of days in each month?











    Results (82 votes), past polls