diff options
| -rw-r--r-- | IkiWiki/Plugin/po.pm | 107 | ||||
| -rw-r--r-- | doc/plugins/po.mdwn | 70 |
2 files changed, 100 insertions, 77 deletions
diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm index ac56041cf..7861523da 100644 --- a/IkiWiki/Plugin/po.pm +++ b/IkiWiki/Plugin/po.pm @@ -19,11 +19,12 @@ use Memoize; my %translations; our %filtered; -## FIXME: makes some test cases cry once every two tries; this may be -## related to the artificial way the testsuite is run, or not. -# memoize("istranslatable"); memoize("_istranslation"); memoize("percenttranslated"); +# FIXME: memoizing istranslatable() makes some test cases fail once every +# two tries; this may be related to the artificial way the testsuite is +# run, or not. +# memoize("istranslatable"); # backup references to subs that will be overriden my %origsubs; @@ -34,7 +35,8 @@ sub import { #{{{ hook(type => "needsbuild", id => "po", call => \&needsbuild); hook(type => "filter", id => "po", call => \&filter); hook(type => "htmlize", id => "po", call => \&htmlize); - hook(type => "pagetemplate", id => "po", call => \&pagetemplate); + hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1); + hook(type => "editcontent", id => "po", call => \&editcontent); $origsubs{'bestlink'}=\&IkiWiki::bestlink; inject(name => "IkiWiki::bestlink", call => \&mybestlink); @@ -112,7 +114,8 @@ sub potfile ($) { #{{{ my $masterfile=shift; (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); - return File::Spec->catfile($dir, $name . ".pot"); + $dir='' if $dir eq './'; + return File::Spec->catpath('', $dir, $name . ".pot"); } #}}} sub pofile ($$) { #{{{ @@ -120,7 +123,8 @@ sub pofile ($$) { #{{{ my $lang=shift; (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); - return File::Spec->catfile($dir, $name . "." . $lang . ".po"); + $dir='' if $dir eq './'; + return File::Spec->catpath('', $dir, $name . "." . $lang . ".po"); } #}}} sub refreshpot ($) { #{{{ @@ -174,17 +178,22 @@ sub needsbuild () { #{{{ # refresh/create POT and PO files as needed my $updated_po_files=0; foreach my $page (keys %pagesources) { - my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild; if (istranslatable($page)) { + my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild; + my $updated_pot_file=0; my $file=srcfile($pagesources{$page}); if ($pageneedsbuild || ! -e potfile($file)) { refreshpot($file); + $updated_pot_file=1; } my @pofiles; foreach my $lang (keys %{$config{po_slave_languages}}) { my $pofile=pofile($file, $lang); - if ($pageneedsbuild || ! -e $pofile) { + my $pofile_rel=pofile($pagesources{$page}, $lang); + if ($pageneedsbuild || $updated_pot_file || ! -e $pofile) { push @pofiles, $pofile; + push @$needsbuild, $pofile_rel + unless grep { $_ eq $pofile_rel } @$needsbuild; } } if (@pofiles) { @@ -195,7 +204,7 @@ sub needsbuild () { #{{{ } } - # check staged changes in and trigger a wiki refresh. + # check staged changes in if ($updated_po_files) { if ($config{rcs}) { IkiWiki::disable_commit_hook(); @@ -204,8 +213,6 @@ sub needsbuild () { #{{{ IkiWiki::enable_commit_hook(); IkiWiki::rcs_update(); } - IkiWiki::refresh(); - IkiWiki::saveindex(); # refresh module's private variables undef %filtered; undef %translations; @@ -286,8 +293,8 @@ sub mybestlink ($$) { #{{{ return ""; } #}}} -# We use filter to convert PO to the master page's type, -# since other plugins should not work on PO files +# We use filter to convert PO to the master page's format, +# since the rest of ikiwiki should not work on PO files. sub filter (@) { #{{{ my %params = @_; @@ -295,17 +302,37 @@ sub filter (@) { #{{{ my $destpage = $params{destpage}; my $content = decode_utf8(encode_utf8($params{content})); - # decide if this is a PO file that should be converted into a - # translated document, and perform various sanity checks - if (! istranslation($page) || $filtered{$page}{$destpage}) { - return $content; - } + return $content if ( ! istranslation($page) + || ( exists $filtered{$page}{$destpage} + && $filtered{$page}{$destpage} eq 1 )); + + # CRLF line terminators make poor Locale::Po4a feel bad + $content=~s/\r\n/\n/g; + + # Implementation notes + # + # 1. Locale::Po4a reads/writes from/to files, and I'm too lazy + # to learn how to disguise a variable as a file. + # 2. There are incompatibilities between some File::Temp versions + # (including 0.18, bundled with Lenny's perl-modules package) + # and others (e.g. 0.20, previously present in the archive as + # a standalone package): under certain circumstances, some + # return a relative filename, whereas others return an absolute one; + # we here use this module in a way that is at least compatible + # with 0.18 and 0.20. Beware, hit'n'run refactorers! + my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX", + DIR => File::Spec->tmpdir, + UNLINK => 1)->filename; + my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX", + DIR => File::Spec->tmpdir, + UNLINK => 1)->filename; + + writefile(basename($infile), File::Spec->tmpdir, $content); my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); - my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page}); my $masterfile = srcfile($pagesources{$masterpage}); my (@pos,@masters); - push @pos,$file; + push @pos,$infile; push @masters,$masterfile; my %options = ( "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0, @@ -316,12 +343,15 @@ sub filter (@) { #{{{ 'file_in_name' => \@masters, 'file_in_charset' => 'utf-8', 'file_out_charset' => 'utf-8', - ) or error("[po/filter:$file]: failed to translate"); - my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX"); - my $tmpout = $tmpfh->filename; - # XXX is there any way to avoid the useless write to a temp file? --Joey - $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout"); - $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout"); + ) or error("[po/filter:$infile]: failed to translate"); + $doc->write($outfile) or error("[po/filter:$infile] could not write $outfile"); + $content = readfile($outfile) or error("[po/filter:$infile] could not read $outfile"); + + # Unlinking should happen automatically, thanks to File::Temp, + # but it does not work here, probably because of the way writefile() + # and Locale::Po4a::write() work. + unlink $infile, $outfile; + $filtered{$page}{$destpage}=1; return $content; } #}}} @@ -399,10 +429,11 @@ sub otherlanguages ($) { #{{{ sub pagetemplate (@) { #{{{ my %params=@_; - my $page=$params{page}; + my $page=$params{page}; + my $destpage=$params{destpage}; + my $template=$params{template}; - my $destpage=$params{destpage}; - my $template=$params{template}; + my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/) if istranslation($page); if (istranslation($page) && $template->query(name => "percenttranslated")) { $template->param(percenttranslated => percenttranslated($page)); @@ -421,7 +452,6 @@ sub pagetemplate (@) { #{{{ } } elsif (istranslation($page)) { - my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/); add_depends($page, $masterpage); foreach my $translation (values %{$translations{$masterpage}}) { add_depends($page, $translation); @@ -436,7 +466,6 @@ sub pagetemplate (@) { #{{{ # prevent future breakage when ikiwiki internals change. # Known limitations are preferred to future random bugs. if ($template->param('discussionlink') && istranslation($page)) { - my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); $template->param('discussionlink' => htmllink( $page, $destpage, @@ -446,8 +475,24 @@ sub pagetemplate (@) { #{{{ linktext => gettext("Discussion"), )); } + # remove broken parentlink to ./index.html on home page's translations + if ($template->param('parentlinks') + && istranslation($page) + && $masterpage eq "index") { + $template->param('parentlinks' => []); + } } # }}} +sub editcontent () { #{{{ + my %params=@_; + # as we're previewing or saving a page, the content may have + # changed, so tell the next filter() invocation it must not be lazy + if (exists $filtered{$params{page}}{$params{page}}) { + delete $filtered{$params{page}}{$params{page}}; + } + return $params{content}; +} #}}} + sub istranslatable ($) { #{{{ my $page=shift; diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index a2e7b18e3..0a8a77a3c 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -184,9 +184,9 @@ Automatic PO file update Committing changes to a "master" page: -1. updates the POT file and the PO files for the supported languages; - the updated PO files are then put under version control -2. triggers a refresh of the corresponding HTML slave pages +1. updates the POT file and the PO files for the "slave" languages; + the updated PO files are then put under version control; +2. triggers a refresh of the corresponding HTML slave pages. Also, when the plugin has just been enabled, or when a page has just been declared as being translatable, the needed POT and PO files are @@ -195,15 +195,16 @@ created, and the PO files are checked into version control. Discussion pages ---------------- -Discussion should happen in the language in which the pages are written for -real, *i.e.* the "master" one. If discussion pages are enabled, "slave" pages -therefore link to the "master" page's discussion page. +Discussion should happen in the language in which the pages are +written for real, *i.e.* the "master" one. If discussion pages are +enabled, "slave" pages therefore link to the "master" page's +discussion page. Translating ----------- -One can edit the PO files using ikiwiki's CGI (a message-by-message interface -could also be implemented at some point). +One can edit the PO files using ikiwiki's CGI (a message-by-message +interface could also be implemented at some point). If [[tips/untrusted_git_push]] is setup, one can edit the PO files in one's preferred `$EDITOR`, without needing to be online. @@ -211,17 +212,6 @@ preferred `$EDITOR`, without needing to be online. TODO ==== -OTHERLANGUAGES dependencies ---------------------------- - -Pages using `OTHERLANGUAGES` depend on any "master" and "slave" pages -whose status is being displayed. It is supposed to trigger dependency -loops, but no practical bugs were noticed yet. - -Should pages using the `OTHERLANGUAGES` template loop be declared as -linking to the same page in other versions? To be rigorous, they -should, but this may clutter the backlinks. - Security checks --------------- @@ -249,29 +239,21 @@ gettext/po4a rough corners changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers a PO update, that changes bla.fr.po in repo2; etc.; fixed in `629968fc89bced6727981c0a1138072631751fee`? -- new translations created in the web interface must get proper charset/encoding - gettext metadata, else the next automatic PO update removes any non-ascii - chars; possible solution: put such metadata into the Pot file, and let it - propagate; should be fixed in `773de05a7a1ee68d2bed173367cf5e716884945a`, time - will tell. +- new translations created in the web interface must get proper + charset/encoding gettext metadata, else the next automatic PO update + removes any non-ascii chars; possible solution: put such metadata + into the Pot file, and let it propagate; should be fixed in + `773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell. Misc. improvements ------------------ -### preview - -preview does not work for PO files. - -### automatic POT/PO update - -Use the `change` hook instead of `needsbuild`? - ### page titles -Use nice page titles from meta plugin in links, as inline already does. This is -actually a duplicate for -[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might be fixed -by something like [[todo/using_meta_titles_for_parentlinks]]. +Use nice page titles from meta plugin in links, as inline already +does. This is actually a duplicate for +[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might +be fixed by something like [[todo/using_meta_titles_for_parentlinks]]. ### websetup @@ -285,18 +267,14 @@ Which configuration settings are safe enough for websetup? > setting in this case rather than error, it would be safe. > --[[Joey]] -### parentlinks - -When the wiki home page is translatable, the parentlinks plugin sets -`./index.html` as its translations' single parent link. Ideally, the home page's -translations should get no parent link at all, just like the version written in -the master language. - ### backlinks -If a given translatable `sourcepage.mdwn` links to \[[destpage]], -`sourcepage.LL.po` also link to \[[destpage]], and the latter has the master -page *and* all its translations listed in the backlinks. +`po_link_to = negotiated`: if a given translatable `sourcepage.mdwn` +links to \[[destpage]], `sourcepage.LL.po` also link to \[[destpage]], +and the latter has the master page *and* all its translations listed +in the backlinks. + +`po_link_to = current`: seems to work nicely ### license |