Changes between Version 15 and Version 16 of TranslationIntro

Timestamp:

04/28/09 16:24:35 (4 years ago)

Author:

jquelin

Comment:

--

TranslationIntro

@@ -64 +64 @@
 == Plug-ins ==
 
-So far we have not dealt with the translation of the plug-ins. We need a plan.
+Since Padre 0.34, the plugin API has been updated to allow plugin translation.
+
+There is indeed a new method ''plugin_locale_directory()'' that your plugin can implement. It should return a directory where Padre can find the {{{*.mo}}} files for your plugin. This directory will then be added to the locale search path.
+
+Note that you are not forced to implement ''plugin_locale_directory()'', since it defaults to ''$sharedir/locale'' (with ''$sharedir'' as defined by {{{File::ShareDir}}}), and thus should work as is for your plugin if you're using the ''install_share'' command of {{{ Module::Install }}}.
+
+Once this is done, you need to extract the strings to be translated (see above) to a ''messages.pot'' file in your plugin locale directory (yes, the same directory you're advertising with the ''plugin_locale_directory()'' method).
+
+Then, it's translation business as usual, with one minor change: the ''*.po'' (and thus the ''*.mo'' too) files should be named {{{$plugin-$locale.po}}} instead of just {{{$locale.po}}}. That is, the german translation of {{{Padre::Plugin::Vi}}} should be named ''Vi-de.po''.
+
+Don't forget to generate the ''*.mo'' files before the release, and to include them in the dist tarball. For the plugins using {{{Module::Build}}}, replacing {{{my $builder = Module::Builder->new}}} with the following is quite handy:
+
+{{{
+my $class = Module::Build->subclass(
+    class => "Module::Build::Custom",
+    code => <<'SUBCLASS' );
+
+sub ACTION_build {
+    my $self = shift;
+
+    my $msgfmt = $^O =~ /(linux|bsd)/
+        ? `which msgfmt`
+        : "c:/Program Files/GnuWin32/bin/msgfmt.exe";
+    chomp $msgfmt;
+    if ( $msgfmt && -e $msgfmt ) {
+        my @pofiles = glob "lib/Padre/Plugin/SpellCheck/share/locale/*.po";
+        foreach my $pof ( @pofiles ) {
+                my $mof = $pof;
+                $mof =~ s/\.po$/.mo/;
+                $self->do_system( "$msgfmt -o $mof $pof" );
+        }
+    }
+    $self->SUPER::ACTION_build;
+}
+
+SUBCLASS
+
+
+my $builder = $class->new(
+}}}
+
+It will generate the ''*.mo'' files from the ''*.po'' files when issuing the {{{./Build}}} command.
+
+
+So, to summarize:
+
+  1. implement ''plugin_locale_directory()'' (or not if the default suits your needs)
+  1. use Wx::gettext() everywhere instead of plain text
+  1. extract those messages in a ''messages.pot'' file
+  1. create a ''$plugin-$locale.po'' file in your plugin locale directory and translate it - or ask the translators to do it
+  1. upon releasing, create the ''*.mo'' files and ship them with your plugin
+  1. tada! your plugin is now translated...
+
 
 == Perl 5 diagnostics ==