Multilingual POD Documentation

Question

Is there a way to write multilingual documentation using POD? If not, what should I write in it (I already have the POD documentation in English, so I want to convert it and then translate it)?

Answer 1

• If you ask if POD supports non-English encoding, the answer will be YES. Here is an example of an article by Brian Di Foy (in POD format) translated into Russian: http://perlrussia.ru/article/brians-guide/brian%27s_guide.ru.pod

• If you're wondering if you can insert a multilingual POD into the same file, there is a rather interesting example here: http://cpansearch.perl.org/src/HIO/Unicode-Japanese-0.47/lib/Unicode/Japanese.mlpod

  It uses Pod :: Multilang

  However, I'm not quite sure how (or even if) it works, since I could not find two html examples generated directly from this mlpod.

• See http://perldoc2.sourceforge.net/ - this is a project for international perldoc

Answer 2

If you are preparing your module for distribution via CPAN, create separate files .podfor translating your documentation.

For example, if you have included the English documentation in My/Module.pm, you can create files My/Module-jp.pod, My/Module-ru.podetc .:

=head1 NAME

My::Module-pl - Atin-lay Ig-pay ocumentation-day or-fay y-may odule-may

=head1 ERSION-VAY

1.01

=head1 ESCRIPTION-DAY

...