X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9c25f5cfe93899f6ac7da3c8c8d0939cff9a20b6..9332457e6c9fb6699181c1b890d0045bd11ef88d:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index d2f572706..6b04afd72 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -41,41 +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 +----------------------------------- -Server support -============== - -Apache ------- - -Using `mod_negotiation` makes it really easy to have Apache serve the -page in the client's preferred language, if available. This is the -default Debian Apache configuration. - -When `usedirs` is enabled, one has to set `DirectoryIndex index` for -the wiki context. - -Setting `DefaultLanguage LL` (replace `LL` with your default MIME -language) for the wiki context can be needed, to ensure -`bla/page/index.en.html` is served as `Content-Language: LL`. -**FIXME**: is it still needed with the new `.en.html` naming convention? - -lighttpd --------- - -lighttpd unfortunately does not support content negotiation. - -**FIXME**: does `mod_magnet` provide the functionality needed to - emulate this? - +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. -TODO -==== +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 -------------- @@ -87,36 +67,90 @@ 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: - `po_link_to => negotiated` provides no useful behavior if `usedirs` - is disabled: + is disabled; this option combination is neither implemented nor + allowed - `po_link_to => negotiated` provides no useful behavior if the web server does not support Content Negotiation ### 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 - `foo/page.LL.html` if `usedirs` is disabled -Display available translations ------------------------------- -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. +Templates +--------- + +The `OTHERLANGUAGES` loop provides ways to display the existing +translations and/or master page. One typically adds the following code +to `templates/page.tmpl`: + + +
+ +
+ + + +Server support +============== + +Apache +------ + +Using `mod_negotiation` makes it really easy to have Apache serve the +page in the client's preferred language, if available. This is the +default Debian Apache configuration. + +When `usedirs` is enabled, one has to set `DirectoryIndex index` for +the wiki context. + +Setting `DefaultLanguage LL` (replace `LL` with your default MIME +language) for the wiki context can be needed, to ensure +`bla/page/index.en.html` is served as `Content-Language: LL`. +**FIXME**: is it still needed with the new `.en.html` naming convention? + +lighttpd +-------- + +lighttpd unfortunately does not support content negotiation. + +**FIXME**: does `mod_magnet` provide the functionality needed to + emulate this? + + +TODO +==== + +Link relationships +------------------ + +Should pages using the `OTHERLANGUAGES` template loop be declared as +linking to the same page in other versions? View translation status ----------------------- @@ -126,41 +160,30 @@ 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. -Decide which pages are translatable ------------------------------------ - -The subset of "master" pages subject to translation must be -configurable: - -- 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. +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: -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 - -The former is to be done at a time when: +1. update the POT file and the PO files for the supported languages; + this is done in the `needsbuild` hook; the updated PO files must + then be put under version control -- 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 +2. trigger a refresh of the corresponding HTML slave pages; this 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. -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. +Also, when the plugin has just been enabled, all the needed POT and PO +files have to be created. UI consistency: rename "Edit" button on slave pages ---------------------------------------------------