[patch] Perldoc.pm, for POD2::IT and other pods translations

Hi all,

after almost two years from RFC, italian Perl users (finally!) published a large
part of translated core Perl pods (including perlfunc and perlfaq*) into the
package POD2::IT where 'IT' is the language code. This has been (and currently
still is) a very impressive work! 

Once the package has been installed, the translated documentation can be
accessed with:

	%> perldoc POD2::IT::<podname>

However the -f and -q swithces don't work no longer.

So, I've attached the patch to Pod/Perldoc.pm in order to allow also the
syntax:

	%> perldoc -L IT <podname>
	%> perldoc -L IT -f <function>
	%> perldoc -L IT -q <FAQregex>

I added a -L switch that allow to define language code for desired language
translation. If POD2::<code> package doesn't exists, the effect of the switch
will be ignored.

Since 'search_perlfunc' uses hard coded string 'Alphabetical Listing of Perl
Functions' to skip introduction, in order to make to work it with other
languages with the option -L, I used a simple plugin-like mechanism.
POD2::<code> language package must export 'search_perlfunc_re' that returns a
localized translation of the paragraph string. This string will be used to skip

POD indexing project

[Sending this message again because I sent it from the wrong address and 
it didn't seem to get through...]

This project started with the discussion at
http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2005-07/msg01215.html 

.

I'm attaching a copy of the "Perldoc indexer's HOWTO", for those who
need more information.

This is a thread where people who volunteer to do the indexing can
coordinate their efforts. Maybe we can use a wiki or something like that
at some point but, for now, this is the situation:

* perlop - almost done
* perlsyn - I'm starting it

Post to the list when you start working on a document. Post the patch
when done.

Good luck!

Ivan

PERLDOC INDEXER'S GUIDE

Thanks for your interest in helping index Perl's core documentation!

Re: POD indexing project

Ivan Tubert-Brohman wrote:
> This is a thread where people who volunteer to do the indexing can
> coordinate their efforts. Maybe we can use a wiki or something like that
> at some point but, for now, this is the situation:
> 
> * perlop - almost done
> * perlsyn - I'm starting it
> 

perlsyn done.
Now I'm starting perlobj, and after that I'll do perlsub.

Ivan

POD indexing project

This project started with the discussion at 
http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2005-07/msg01215.html 
.

I'm attaching a copy of the "Perldoc indexer's HOWTO", for those who 
need more information.

This is a thread where people who volunteer to do the indexing can 
coordinate their efforts. Maybe we can use a wiki or something like that 
at some point but, for now, this is the situation:

* perlop - almost done
* perlsyn - I'm starting it

Post to the list when you start working on a document. Post the patch 
when done.

Good luck!

Ivan

PERLDOC INDEXER'S GUIDE

Thanks for your interest in helping index Perl's core documentation!
This guide lists the steps you should follow to become a Perldoc Indexer (tm).

I - GETTING THE SOURCE

All patches we provide should be against the latest development perl, also

Re: POD indexing project

Ivan Tubert-Brohman wrote:
> Now I'm starting perlobj, and after that I'll do perlsub.

perldata and perlref are next on my to-do list.

I've created a snapshot with the current pods, patches, and code, 
available at

   http://pod-indexing.annocpan.org/

You can use it if you want to test the experimental perldoc -k and see 
what's been indexed.

Ivan