sub import {
hook(type => "getsetup", id => "po", call => \&getsetup);
+ hook(type => "checkconfig", id => "po", call => \&checkconfig);
+ hook(type => "scan", id => "po", call => \&scan);
hook(type => "targetpage", id => "po", call => \&targetpage);
+ hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
+ hook(type => "tweakbestlink", id => "po", call => \&tweakbestlink);
hook(type => "filter", id => "po", call => \&filter);
hook(type => "htmlize", id => "po", call => \&htmlize);
}
safe => 0,
rebuild => 1, # format plugin
},
- po_supported_languages => {
+ po_master_language => {
type => "string",
- example => { 'fr' => { 'name' => 'Français' },
+ example => {
+ 'code' => 'en',
+ 'name' => 'English'
+ },
+ description => "master language (non-PO files)",
+ safe => 1,
+ rebuild => 1,
+ },
+ po_slave_languages => {
+ type => "string",
+ example => {'fr' => { 'name' => 'Français' },
'es' => { 'name' => 'Castellano' },
'de' => { 'name' => 'Deutsch' },
},
+ description => "slave languages (PO files)",
+ safe => 1,
+ rebuild => 1,
+ },
+ po_translatable_pages => {
+ type => "pagespec",
+ example => "!*/Discussion",
+ description => "PageSpec controlling which pages are translatable",
+ link => "ikiwiki/PageSpec",
+ safe => 1,
+ rebuild => 1,
+ },
+ po_link_to => {
+ type => "string",
+ example => "current",
+ description => "internal linking behavior (default/current/negotiated)",
safe => 1,
rebuild => 1,
},
} #}}}
+sub checkconfig () { #{{{
+ foreach my $field (qw{po_master_language po_slave_languages}) {
+ if (! exists $config{$field} || ! defined $config{$field}) {
+ error(sprintf(gettext("Must specify %s"), $field));
+ }
+ }
+ if (! exists $config{po_link_to} ||
+ ! defined $config{po_link_to}) {
+ $config{po_link_to}="default";
+ }
+ if (! exists $config{po_translatable_pages} ||
+ ! defined $config{po_translatable_pages}) {
+ $config{po_translatable_pages}="";
+ }
+ if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
+ error(gettext("po_link_to=negotiated requires usedirs to be set"));
+ }
+} #}}}
+
+sub scan (@) { #{{{
+ my %params=@_;
+ my $page=$params{page};
+
+ # FIXME: cache (or memoize) the list of translatable/translation pages,
+ # and/or istranslation/istranslated results
+} #}}}
+
sub targetpage (@) { #{{{
my %params = @_;
my $page=$params{page};
my $ext=$params{ext};
- if (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
- return;
+ if (istranslation($page)) {
+ my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+ if (! $config{usedirs} || $page eq 'index') {
+ return $masterpage . "." . $lang . "." . $ext;
+ }
+ else {
+ return $masterpage . "/index." . $lang . "." . $ext;
+ }
}
+ elsif (istranslatable($page)) {
+ if (! $config{usedirs} || $page eq 'index') {
+ return $page . "." . $config{po_master_language}{code} . "." . $ext;
+ }
+ else {
+ return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
+ }
+ }
+ return;
+} #}}}
- my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
- if (! $config{usedirs} || $page eq 'index') {
- return $masterpage.".".$ext.".".$lang;
+sub tweakurlpath ($) { #{{{
+ my %params = @_;
+ my $url=$params{url};
+ if ($config{po_link_to} eq "negotiated") {
+ $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
}
- else {
- return $masterpage."/index.".$ext.".".$lang;
+ return $url;
+} #}}}
+
+sub tweakbestlink ($$) { #{{{
+ my %params = @_;
+ my $page=$params{page};
+ my $link=$params{link};
+ if ($config{po_link_to} eq "current"
+ && istranslatable($link)
+ && istranslation($page)) {
+ my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+ return $link . "." . $curlang;
}
+ return $link;
} #}}}
# We use filter to convert PO to the master page's type,
# decide if this is a PO file that should be converted into a translated document,
# and perform various sanity checks
- if (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
+ if (! istranslation($page)) {
return $content;
}
sub htmlize (@) { #{{{
my %params=@_;
+ my $page = $params{page};
my $content = $params{content};
- # FIXME: run master page's type htmlize hook
- return $content;
-} #}}}
+ my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+ my $masterfile = srcfile($pagesources{$masterpage});
-package IkiWiki::PageSpec;
+ # force content to be htmlize'd as if it was the same type as the master page
+ return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
+} #}}}
-sub match_istranslation ($;@) { #{{{
+sub istranslatable ($) { #{{{
my $page=shift;
- my $wanted=shift;
+ my $file=$pagesources{$page};
- my %params=@_;
- my $file=exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page};
+ if (! defined $file
+ || (defined pagetype($file) && pagetype($file) eq 'po')
+ || $file =~ /\.pot$/) {
+ return 0;
+ }
+ return pagespec_match($page, $config{po_translatable_pages});
+} #}}}
+
+sub istranslation ($) { #{{{
+ my $page=shift;
+ my $file=$pagesources{$page};
if (! defined $file) {
return IkiWiki::FailReason->new("no file specified");
}
- if (! IkiWiki::pagetype($page) eq 'po') {
- return IkiWiki::FailReason->new("is not a PO file");
+ if (! defined $file
+ || ! defined pagetype($file)
+ || ! pagetype($file) eq 'po'
+ || $file =~ /\.pot$/) {
+ return 0;
}
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
if (! defined $masterpage || ! defined $lang
- || ! (length($masterpage) > 0) || ! (length($lang) > 0)) {
- return IkiWiki::FailReason->new("is not named like a translation file");
+ || ! (length($masterpage) > 0) || ! (length($lang) > 0)
+ || ! defined $pagesources{$masterpage}
+ || ! defined $config{po_slave_languages}{$lang}) {
+ return 0;
}
- if (! defined $IkiWiki::pagesources{$masterpage}) {
- return IkiWiki::FailReason->new("the master page does not exist");
- }
+ return istranslatable($masterpage);
+} #}}}
- if (! defined $IkiWiki::config{po_supported_languages}{$lang}) {
- return IkiWiki::FailReason->new("language $lang is not supported");
- }
- return IkiWiki::SuccessReason->new("page $page is a translation");
+package IkiWiki::PageSpec;
+use warnings;
+use strict;
+use IkiWiki 2.00;
+sub match_istranslation ($;@) { #{{{
+ my $page=shift;
+ if (IkiWiki::Plugins::po::istranslation($page)) {
+ return IkiWiki::SuccessReason->new("is a translation page");
+ }
+ else {
+ return IkiWiki::FailReason->new("is not a translation page");
+ }
+} #}}}
+
+sub match_istranslatable ($;@) { #{{{
+ my $page=shift;
+ if (IkiWiki::Plugins::po::istranslatable($page)) {
+ return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
+ }
+ else {
+ return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
+ }
} #}}}
1