From 1a670d3aca228fb9baed05890b175ef9aed9b102 Mon Sep 17 00:00:00 2001
From: intrigeri <intrigeri@boum.org>
Date: Wed, 15 Oct 2008 02:13:56 +0200
Subject: po plugin: make translation percentage available in OTHERLANGUAGES
 loop

Signed-off-by: intrigeri <intrigeri@boum.org>
---
 doc/plugins/po.mdwn | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

(limited to 'doc')

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 64d22d34c..ab37ae419 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -126,25 +126,34 @@ Usage
 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>
-	      <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>
 
+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
 -------------------------
 
-- 
cgit v1.2.3