X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/886f35153b0945ec39568c61d3e7451c18be6be8..1a670d3aca228fb9baed05890b175ef9aed9b102:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 2b0fba628..ab37ae419 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -41,20 +41,21 @@ Configuration `po_slave_languages` is used to set the list of supported "slave" languages, such as: - po_slave_languages => { 'fr' => { 'name' => 'Français', }, - 'es' => { 'name' => 'Castellano', }, - 'de' => { 'name' => 'Deutsch', } + po_slave_languages => { 'fr' => 'Français', + 'es' => 'Castellano', + 'de' => 'Deutsch', } Decide which pages are translatable ----------------------------------- -The subset of "master" pages subject to translation is configurable: +The `po_translatable_pages` setting configures what pages are +translatable. It is a [[ikiwiki/PageSpec]], so you have lots of +control over what kind of pages are translatable. -- a `[[!translatable ]]` directive, when put on a page, makes it - translatable -- to set at once a bunch of pages as being translatable, use this - [[ikiwiki/directive]] with the `match=PageSpec` argument. +The `*.LL.po` translations files are anyway not considered as being +translatable, so you don't need to worry about excluding them manually +from this [[ikiwiki/PageSpec]]. Internal links -------------- @@ -66,12 +67,12 @@ and site-specific preferences. ### Default linking behavior If `po_link_to` is unset, or set to `default`, ikiwiki's default -linking behavior is preserved: `[[page]]` links to the master +linking behavior is preserved: `\[[page]]` links to the master language's page. ### Link to negotiated language -If `po_link_to` is set to `negotiated`, `[[page]]` links to the +If `po_link_to` is set to `negotiated`, `\[[page]]` links to the negotiated preferred language, *i.e.* `foo/page/`. (In)compatibility notes: @@ -85,7 +86,7 @@ negotiated preferred language, *i.e.* `foo/page/`. ### Link to current language If `po_link_to` is set to `current` and the destination page is either -a translatable page or a translation, `[[page]]` links to the current +a translatable page or a translation, `\[[page]]` links to the current page's language, *i.e.*: - `foo/page/index.LL.html` if `usedirs` is enabled @@ -119,24 +120,55 @@ lighttpd unfortunately does not support content negotiation. emulate this? -TODO -==== +Usage +===== + +Templates +--------- + +The `OTHERLANGUAGES` loop provides ways to display other languages' +versions of the same page, and the translations' status. + +One typically adds the following code to `templates/page.tmpl`: + + +
+ +
+ + +The following variables are available inside the loop (for every page in): + +- `URL` - url to the page +- `CODE` - two-letters language code +- `LANGUAGE` - language name (as defined in `po_slave_languages`) +- `MASTER` - is true (1) if, and only if the page is a "master" page +- `PERCENT` - for "slave" pages, is set to the translation completeness, in percents + +Additional PageSpec tests +------------------------- -Optimization ------------- +This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some +additional tests that are documented [[here|ikiwiki/pagespec/po]]. -Move `match_istranslation` and `match_istranslatable` code into helper -functions, and pre-compute what can be early in the build process: -- the list of translatable (master) pages -- for every translatable page, the list of slave pages +TODO +==== -Display available translations ------------------------------- +Link relationships +------------------ -The [[linguas|plugins/contrib/linguas]] plugin has some code that can -be used as a basis to display the existing translations, and allow to -navigate between them. +Should pages using the `OTHERLANGUAGES` template loop be declared as +linking to the same page in other versions? View translation status ----------------------- @@ -146,32 +178,36 @@ completeness, either for a given page or for the whole wiki. This should not be too hard using gettext tools. If this is implemented as a -[[HTML::Template|http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate]] +[HTML::Template](http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate) loop, a page using it should depend on any "master" and "slave" pages whose status is being displayed. +If it's not too heavy to compute, this status data may be made +available in the `OTHERLANGUAGES` template loop; else, a dedicated +loop would be needed. + Automatic PO files update ------------------------- -Committing changes to a "master" page must: +Committing changes to a "master" page: -1. update the POT file and the PO files for the supported languages, - before putting them under version control -2. trigger a refresh of the corresponding HTML slave pages +1. updates the POT file and the PO files for the supported languages; + this is done in the `needsbuild` hook; **FIXME**: the updated PO + files must then be put under version control -The former is to be done at a time when: +2. triggers a refresh of the corresponding HTML slave pages: this is + achieved by making any "slave" page dependent on the corresponding + "master" page, in the `needsbuild` hook. -- we know which "master" page was modified, and thus, which POT/PO - files have to be updated: the `needsbuild` hook is the first one to - run that provides us with the necessary information -- we can modify the list of pages needing a refresh; this is - `needsbuild` hook's job +**FIXME** Also, when the plugin has just been enabled, or when a page +has just been declared as being translatable: -The latter can be implemented by making any "slave" page depend on the -corresponding "master" page. The `add_depends` function can achieve -this, if used in a **FIXME** hook. +- all the needed POT and PO files have to be created +- the PO files must be checked into version control -The POT files should not be published on the wiki. +**FIXME** `refreshpofiles` uses `system()`, whose args have to be +checked more thoroughly to prevent any security issue (command +injection, etc.). UI consistency: rename "Edit" button on slave pages --------------------------------------------------- @@ -181,16 +217,6 @@ page, to end up editing a strange looking PO file. The *Edit* button displayed on "slave" pages must therefore be renamed *Improve translation* . -Pages selection depending on language -------------------------------------- - -To improve user navigation in a multi-lingual wiki, site developers -must be enabled to write: - - \[[!map pages="dev/* and lang(LL)" feeds="no"]] - - \[[!map pages="dev/* and currentlang()" feeds="no"]] - Translation quality assurance -----------------------------