po plugin: make translation percentage available in OTHERLANGUAGES loop

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 64d22d34c47ccf8b29d25e61b5cb5b6a0f859cd7..ab37ae419befcbfb0d36cc489ed3d7565b532033 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -126,25 +126,34 @@ Usage
 Templates
 ---------
 
 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`:
+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>
 
        <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>
+             <a href="<TMPL_VAR NAME="URL">"><TMPL_VAR NAME="LANGUAGE"></a>
+             <TMPL_UNLESS NAME="MASTER">
+               (<TMPL_VAR NAME="PERCENT">&nbsp;%)
+             </TMPL_UNLESS>

            </li>
          </TMPL_LOOP>
          </ul>
        </div>
        </TMPL_IF>
 
            </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
 -------------------------
 
 Additional PageSpec tests
 -------------------------