X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/bd50ba3e8392db13c584b4166783ee4794b20365..cc4736d9eef4fba7ec39afe1aa6782142befc3d0:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index e7a93469c..fd8a50e0b 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -10,8 +10,12 @@ 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, and is +written in any supported format but PO. It does not have to be named +a special way: migration from/to this plugin does not imply heavy +renaming work. Example: `bla/page.mdwn` is a "master" Markdown page written in English; if `usedirs` is enabled, it is rendered as @@ -73,6 +77,29 @@ lighttpd unfortunately does not support content negotiation. TODO ==== +Links +----- + +Choice between two behaviors must be possible in `ikiwiki.setup`; +a `po_link_to_current_language` option must allow switching +between them. + +If `po_link_to_current_language` is disabled, `[[page]]` links to the +negotiated preferred language, i.e.: + +- `usedirs` enabled: `bla/page/` +- `usedirs` disabled: `bla/page` + +This obviously does not work in case Content Negotiation is not +supported by the web server, hence one can enable +`po_link_to_current_language` to make `[[page]]` link to the current +page's language, i.e.: + +- `usedirs` enabled: `bla/page/index.LL.html` +- `usedirs` disabled: `bla/page.LL.html` + +**FIXME**: should `po_link_to_current_language` be enabled by default? + Display available translations ------------------------------ @@ -138,12 +165,10 @@ 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 preferredlang()" feeds="no"]] + \[[!map pages="dev/* and lang(LL)" feeds="no"]] \[[!map pages="dev/* and currentlang()" feeds="no"]] -Some new [[ikiwiki/pagespec]] functions have to be written. - Translation quality assurance -----------------------------