X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/968106cc80c4f24ae02a3e54877939cd00e33258..f42cf38076ab8fe6dcf6d9695f0950ccb61fbc01:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index fddfe5c41..4e7553a11 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -10,12 +10,16 @@ Introduction ============ A language is chosen as the "master" one, and any other supported -language is a "slave" one. A page written in the "master" language is -a "master" page, and is written in any supported format but PO. +language is a "slave" one. + +A page written in the "master" language is a "master" page. It can be +of any page type supported by ikiwiki, but PO. It does not have to be +named a special way: migration to this plugin does not imply any page +renaming work. Example: `bla/page.mdwn` is a "master" Markdown page written in English; if `usedirs` is enabled, it is rendered as -`bla/page/index.html.en`, else as `bla/page.html.en`. +`bla/page/index.en.html`, else as `bla/page.en.html`. Any translation of a "master" page into a "slave" language is called a "slave" page; it is written in the gettext PO format. PO is now @@ -23,13 +27,16 @@ a page type supported by ikiwiki. Example: `bla/page.fr.po` is the PO "message catalog" used to translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is -rendered as `bla/page/index.html.fr`, else as `bla/page.html.fr` +rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html` Configuration ============= -`po_master_language` is used to set the master language in +Supported languages +------------------- + +`po_master_language` is used to set the "master" language in `ikiwiki.setup`, such as: po_master_language => { 'code' => 'en', 'name' => 'English' } @@ -37,11 +44,57 @@ 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 `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. + +The PO translations files are anyway not considered as being +translatable, so you don't need to worry about excluding them +explicitly from this [[ikiwiki/PageSpec]]. + +Internal links +-------------- + +The `po_link_to` option in `ikiwiki.setup` is used to decide how +internal links should be generated, depending on web server features +and site-specific preferences. + +### Default linking behavior + +If `po_link_to` is unset, or set to `default`, ikiwiki's default +linking behavior is preserved: `\[[destpage]]` links to the master +language's page. + +### Link to current language + +If `po_link_to` is set to `current`, `\[[destpage]]` links to the +`destpage`'s version written in the current page's language, if +available, *i.e.*: + +- `foo/destpage/index.LL.html` if `usedirs` is enabled +- `foo/destpage.LL.html` if `usedirs` is disabled + +### Link to negotiated language + +If `po_link_to` is set to `negotiated`, `\[[page]]` links to the +negotiated preferred language, *i.e.* `foo/page/`. + +(In)compatibility notes: + +- if `usedirs` is disabled, it does not make sense to set `po_link_to` + to `negotiated`; this option combination is neither implemented + nor allowed. +- if the web server does not support Content Negotiation, setting + `po_link_to` to `negotiated` will produce a unusable website. + Server support ============== @@ -49,17 +102,16 @@ 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. +Using Apache `mod_negotiation` makes it really easy to have Apache +serve any 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.html.en` is served as `Content-Language: LL`. -**FIXME**: is it still needed with the new `.html.en` naming convention? +language code) for the wiki context can help to ensure +`bla/page/index.en.html` is served as `Content-Language: LL`. lighttpd -------- @@ -70,85 +122,96 @@ lighttpd unfortunately does not support content negotiation. emulate this? -TODO -==== +Usage +===== -Display available translations ------------------------------- +Templates +--------- -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. +### Display page's versions in other languages -View translation status ------------------------ +The `OTHERLANGUAGES` loop provides ways to display other languages' +versions of the same page, and the translations' status. -One should be able to view some information about the translation -completeness, either for a given page or for the whole wiki. +One typically adds the following code to `templates/page.tmpl`: -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]] -loop, a page using it should depend on any "master" and "slave" pages -whose status is being displayed. + +
+ +
+ -Decide which pages are translatable ------------------------------------ +The following variables are available inside the loop (for every page in): -The subset of "master" pages subject to translation must be -configurable: +- `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 -- 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. +### Display the current translation status -Automatic PO files update +The `PERCENTTRANSLATED` variable is set to the translation +completeness, expressed in percent, on "slave" pages. + +Additional PageSpec tests ------------------------- -Committing changes to a "master" page must: +This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some +additional tests that are documented [[here|ikiwiki/pagespec/po]]. -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: +TODO +==== -- 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 +OTHERLANGUAGES dependencies +--------------------------- -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. +Pages using `OTHERLANGUAGES` must depend on any "master" and "slave" +pages whose status is being displayed. It will trigger dependency +loops; how to sort this out? -UI consistency: rename "Edit" button on slave pages ---------------------------------------------------- +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. + +Automatic PO files update +------------------------- -It may be surprising to some, after having pressed *Edit* on a wiki -page, to end up editing a strange looking PO file. The *Edit* button -displayed on "slave" pages must therefore be renamed *Improve -translation* . +Committing changes to a "master" page: -Pages selection depending on language -------------------------------------- +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 -To improve user navigation in a multi-lingual wiki, site developers -must be enabled to write: +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. - \[[!map pages="dev/* and preferredlang()" feeds="no"]] +**FIXME** Also, when the plugin has just been enabled, or when a page +has just been declared as being translatable: - \[[!map pages="dev/* and currentlang()" feeds="no"]] +- all the needed POT and PO files have to be created +- the PO files must be checked into version control -Some new [[ikiwiki/pagespec]] functions have to be written. +**FIXME** `refreshpofiles` uses `system()`, whose args have to be +checked more thoroughly to prevent any security issue (command +injection, etc.). Translation quality assurance ----------------------------- -Modifying a PO file via the CGI must only be allowed if the new -version is a valid PO file. As a bonus, check that it provides a more +Modifying a PO file via the CGI must be forbidden if the new version +is not a valid PO file. As a bonus, check that it provides a more complete translation than the existing one. A new `cansave` type of hook would be needed to implement this.