po plugin: make any slave page dependent on the corresponding master page

[ikiwiki.git] / doc / plugins / po.mdwn

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 28b69e04bcb657ae675669e03512672c96b86193..06ecedc246dfdc9af0973646e9ec7768f76b88e3 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -93,6 +93,29 @@ page's language, *i.e.*:
 - `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
 ==============
 
@@ -123,12 +146,11 @@ lighttpd unfortunately does not support content negotiation.
 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
 -----------------------
@@ -138,30 +160,29 @@ 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:
 
-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 is
+   achieved by making any "slave" page dependent on the corresponding
+   "master" page, in the `needsbuild` 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
 ---------------------------------------------------