- `foo/page.LL.html` if `usedirs` is disabled
-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`:
-
- <TMPL_IF NAME="OTHERLANGUAGES">
- <div id="otherlanguages">
- <ul>
- <TMPL_LOOP NAME="OTHERLANGUAGES">
- <li>
- <a href="<TMPL_VAR NAME="URL">"
- class="is_master_<TMPL_VAR NAME="MASTER">">
- <TMPL_VAR NAME="LANGUAGE">
- </a>
- </li>
- </TMPL_LOOP>
- </ul>
- </div>
- </TMPL_IF>
-
-
Server support
==============
emulate this?
+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`:
+
+ <TMPL_IF NAME="OTHERLANGUAGES">
+ <div id="otherlanguages">
+ <ul>
+ <TMPL_LOOP NAME="OTHERLANGUAGES">
+ <li>
+ <a href="<TMPL_VAR NAME="URL">"><TMPL_VAR NAME="LANGUAGE"></a>
+ <TMPL_UNLESS NAME="MASTER">
+ (<TMPL_VAR NAME="PERCENT"> %)
+ </TMPL_UNLESS>
+ </li>
+ </TMPL_LOOP>
+ </ul>
+ </div>
+ </TMPL_IF>
+
+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
+-------------------------
+
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].
+
+
TODO
====
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
+
+**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
---------------------------------------------------
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
-----------------------------