NAME

POD2::IT - Italian translation of Perl core documentation

SYNOPSIS

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

use POD2::IT;
print_pods();
print_pod('pod_foo', 'pod_baz', ...); 

%> perl -MPOD2::IT -e print_pods
%> perl -MPOD2::IT -e print_pod <podname1> <podname2> ...

DESCRIPTION

pod2it is the italian translation project of core Perl pods. This has been (and currently still is) a very big work! :-)

See http://pod2it.sf.net for more details about the project.

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

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

EXTENDING perldoc

With the translated pods, unfortunately, the useful perldoc's -f and -q switches don't work no longer.

So, we made a simple patch to Pod/Perldoc.pm 3.14 in order to allow also the syntax:

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

The patch adds the -L switch that allows to define language code for desired language translation. If POD2::<code> package doesn't exists, the effect of the switch will be ignored.

If you are particularly lazy you can add a system alias like:

perldoc-it="perldoc -L IT "

in order to avoid to write the -L switch every time and to type directly:

 %> perldoc-it -f map 

You can apply the patch with:

%> patch -p0 `/path/to/perl -MPod::Perldoc -e 'print $INC{"Pod/Perldoc.pm"}'` < /path/to/Perldoc.pm-3.14-patch

The patch lives under ./patches/Perldoc.pm-3.14-patch shipped in this distribution.

Note that the patch is for version 3.14 of Pod::Perldoc (included into Perl 5.8.7 and Perl 5.8.8). If you have a previous Perl distro (but >= 5.8.1) and you are impatient to apply the patch, please upgrade your Pod::Perldoc module to 3.14! ;-)

See search_perlfunc_re API for more information.

Note: Perl 5.10 already contains this functionality, so you don't have to apply any patch.

API

The package exports following functions:

• new

  Added for compatibilty with Perl 5.10.1's perldoc. Used by Pod::Perldoc in order to return translation package name.

• pod_dirs

  Added for compatibilty with Perl 5.10.1's perldoc. Used by Pod::Perldoc in order to find out where to look for translated pods.

• print_pods

  Prints all translated pods and relative Perl original version.

• print_pod

  Prints relative Perl original version of all pods passed as arguments.

• search_perlfunc_re

  Since Pod/Perldoc.pm's search_perlfunc method uses hard coded string "Alphabetical Listing of Perl Functions" (as regexp) to skip introduction, in order to make the patch to work with other languages with the option -L,we used a simple plugin-like mechanism.

  POD2::<code> language package must export search_perlfunc_re that returns a localized translation of the paragraph string above. This string will be used to skip perlfunc.pod intro. Again, if POD2::<code>->search_perlfunc_re fails (or doesn't exist), we'll come back to the default behavoiur. This mechanism allows to add additional POD2::* translations without need to patch Pod/Perldoc.pm every time.

Come funziona il progetto

pod2it è la traduzione in italiano della documentazione in lingua inglese che viene distribuita assieme al Perl.

L'ultima versione delle traduzioni e` disponibile a tutti, in lettura, su un server CVS.

Accedere al server CVS

cvs -d:pserver:anonymous@cvs.pod2it.sourceforge.net:/cvsroot/pod2it login

cvs -z3 -d:pserver:anonymous@cvs.pod2it.sourceforge.net:/cvsroot/pod2it co modulename

Soltanto un piccolo numero di sviluppatori registrati ha accesso in scrittura al repository. Ciascuno di questi sviluppatori e` il responsabile di un certo numero di pagine della documentazione. Il responsabile di un documento ne sovraintende la traduzione, facendo da referente per l'invio di patch, traducendo lui stesso il testo, oppure assegnando ad un collaboratore la traduzione dell'intero documento.

La lista dei responsabili dei moduli e` consultabile a questo URL: http://pod2it.sourceforge.net/pods/responsibles.html

Come collaborare

Abbiamo bisogno sia di traduttori che di revisori. Come revisori, potete proporre patch ad un traduzione, sottoponendole al responsabile del documento in questione. Come traduttori, avete due strade. Potete limitarvi a tradurre un singolo documento, mandandolo al suo responsabile. Oppure potete diventare voi stessi responsabili per un gruppo di documenti. Per farlo e` necessario possedere un account Sourceforge.

La lista dei responsabili dei moduli e` consultabile a questo URL: http://pod2it.sourceforge.net/pods/responsibles.html

AUTHORS

pod2it is a larger translation project owned by larsen, dree, dada, arthas, dakkar, bepi, shishii, frodo72, gmax, alberto-re, kral, osfameron, oha, TheHobbit & others.

See http://pod2it.sourceforge.net for more detalis.

POD2::IT package is currently maintained by Enrico Sorcinelli <bepi at perl.it>

SEE ALSO

POD2::FR, POD2::LT, perl.

COPYRIGHT AND LICENCE

Copyright (C) 2004-2009 Perl.it / Perl Mongers Italia

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm POD2::IT

perl -MCPAN -e shell
install POD2::IT