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

2005-07-25 Thread Enrico Sorcinelli
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
perlfunc intro.
Again, if POD2::code-search_perlfunc_re fails (or doesn't exist), we'll come
back to the default behavoiur.
This plugin-like mechanism allows to add additional POD2::* translations without
need to patch Perldoc.pm every time.

What do you think?

Regards

- Enrico


Perldoc.pm-3.14-patch
Description: Binary data


[ANNOUNCE] POD2::IT 0.09

2005-09-08 Thread Enrico Sorcinelli
Hi all,

the pod2it[1] team is proud to announce a new POD2::IT release available on
CPAN[2]

CHANGES FROM PREVIOUS VERSION

+ Added perlunicode.pod translation [dakkar]
+ Added resources/podenc.pl script in order to encode
  italian characters with E sequence [dakkar, bepi]
! Updated E pod entities [bepi]
! Updated IT.pm pod documentation [bepi]
! Fixed Changes and README typos [bepi]

POD2::IT also contains the patch to Pod/Perldoc.pm in order to continue to use
-f and -q switches with translated pods (not only italian).

Regards

- Enrico

[1] http://pod2it.sf.net - Italian translation project of core Perl pods
[2] http://cpan.uwinnipeg.ca/dist/POD2-IT


[ANNOUNCE] POD2::IT 0.10

2005-11-20 Thread Enrico Sorcinelli
Hi all,

the pod2it[1] team is proud to announce a new POD2::IT release available on
CPAN[2]

CHANGES FROM PREVIOUS VERSION

+ Added perlmod.pod translation [frodo72]
+ Added perldata.pod translation [frodo72]
+ Added perlnewmod.pod translation [dree]
+ Added perlxstut.pod translation [frodo72]
! resources/podenc.pl fixes [frodo72]
! Minor fixes to perlfaq4, perlfaq7, perlfunc, perlreref
! Added 'TRANSLATION' section to all pods, containing
  some infos about pod translator(s) and reviewer(s) [bepi]

POD2::IT also contains the patch to Pod/Perldoc.pm (3.14) in order to continue
to use -f and -q switches with translated pods (not only italian):

% perldoc -L IT podname
% perldoc -L IT -f function
% perldoc -L FR -q FAQregex

(french guys just released a huge POD2::FR package :-))

Regards

- Enrico

[1] http://pod2it.sf.net - Italian translation project of core Perl pods
[2] http://cpan.uwinnipeg.ca/dist/POD2-IT, http://search.cpan.org/~enrys/POD2-IT


Re: Official translations of the Perl documentation

2009-04-30 Thread Enrico Sorcinelli
Hi,

2009/4/30 Alberto Simões al...@alfarrabio.di.uminho.pt:
 Hi

 Enrico Sorcinelli wrote:
 I think there should be a module (say, Perl::Documentation::PT -- did
 not think about it, just an idea) for the interested languages.

 POD2::* existing packages (POD2::IT, POD2::FR) already does it.
 Why adding a new namespace? :-)

 My bad. Didn't read all the backlog :$

 This module version should be given accordingly with the perl vesion
 they document, so people can install the respective module.

 It could be difficult to sync module version number with exactly same
 Perl release number.
 You think about translation package updates (for example by adding new
 translated pod).
 However we could use some conventions. For example:

 - each translation release should contain pods from same Perl release
 - at least, the translation team should maintain current and previous
 Perl release translation package

 These are good principles, but I think they are more suggestions than rules.

 - each release should have same version number that Perl plus a
 specific translation version number. For example, 5.10.0.1. In this
 scenario, we could also upload later a package like 5.8.9.3, where 3
 is relative to a translation package update like a fix o new pod. (I
 think this versioning is possible even if it is maybe a discouraged
 CPAN practice and should cause problem with CPAN shel?l)

 This was my idea. And this, I think should be a rule.

 Go, go, translators, go!

 Should we ask Ask for a new ml?

IMHO, we've already one: perl-documentation. I used it in the past in
order to announce new POD2::IT releases, to discuss about pods
translations and perldoc improvements.
Moreover, there's a very interesting (and strangely unreplied) post
about translations:

http://www.xray.mpe.mpg.de/mailing-lists/perl-documentation/2006-10/msg0.html

It should be read.

Regards

   - Enrico

PS: I cross posted to perl-documentation since I think that here we
are a little bit off topic for Perl 5 porters and we can continue
there.


Re: Official translations of the Perl documentation

2009-04-30 Thread Enrico Sorcinelli
Hi,

2009/4/30 Daisuke Maki dais...@endeworks.jp:

  * core perldoc should be properly versioned (i.e., perldoc
for 5.8, perldoc for 5.10). People googling easily get
confused by old docs. we need to make it clear what version
of perl we're describing.
POD2:: stuff doesn't seem to differentiate that?

POD2 packages contains description of translated pods and relative
perl original version.
Another versioning (parallel) approach could be to use package version
number. For example:

POD2::IT 5.8.9.x for distributions containing only perl 5.8.9 core pods
POD2::IT 5.10.0.x for distributions containing only perl 5.10.0 core pods

Regards

   - Enrico


[ANNOUNCE] POD2::IT 0.13

2009-08-27 Thread Enrico Sorcinelli
Hi all,

the pod2it[1] team is proud to announce a new POD2::IT release
available on CPAN[2]

CHANGES FROM PREVIOUS VERSION

   + Added perlreftut.pod [larsen, polettix, bepi]
   + Added new() and pod_dirs() functions (for Perl 5.10.1's perldoc
compatibility) [bepi]
   ! Several fixes to perlfunc.pod, perlfaq2, perlfaq6 and perlfaq9 [dree]

Regards

- Enrico

[1] http://pod2it.sf.net - Italian translation project of core Perl pods
[2] http://cpan.uwinnipeg.ca/dist/POD2-IT


[ANNOUNCE] pod2.perl.org!

2009-10-06 Thread Enrico Sorcinelli
Hi all,

after several emails, discussions and feedback with worldwide Perl
translators (thank you to all), I'm very happy to announce
pod2.perl.org site and p...@perl.org mailing list.

pod2.perl.org is intended to be the umbrella for several goals:

   * build a community of translators, by writing the guidelines, by
sharing experience, resource and tools, and so on.
   * (of course) do the translations of pods (core and extra) and
publish them using POD2:: namespace.
   * discuss about a translation platform for pods (by creating a new
one or better deciding to use an existing one, without to reinvent the
wheel).
   * perldoc/Pod::Perldoc improvements.
   * publish readable version of translated pods using perldoc.perl.org code.
   * promote, more in general, localized Perl documentation.

If you are interested and/or you are involved in some Perl
documentation translation project, please subscribe to the maling list
(by sending a mail to pod2-subscr...@perl.org). The list archives are
available at http://www.nntp.perl.org/.
Currently pod2.perl.org contains a temporary home page. The main site
is under http://pod2.perl.org/wiki (MojoMojo powered) and it contains
a brief summary of translation projects.

Have fun with pod2.perl.org!

Best

   - Enrico