X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f42cf38076ab8fe6dcf6d9695f0950ccb61fbc01..654adc105e008b57aa5b9700d7aece2a0f7b0682:/doc/plugins/po.mdwn?ds=sidebyside

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 4e7553a11..1412cfea2 100644
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -128,6 +128,9 @@ Usage
 Templates
 ---------
 
+The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
+display things only on translatable or translation pages.
+
 ### Display page's versions in other languages
 
 The `OTHERLANGUAGES` loop provides ways to display other languages'
@@ -163,12 +166,35 @@ The following variables are available inside the loop (for every page in):
 The `PERCENTTRANSLATED` variable is set to the translation
 completeness, expressed in percent, on "slave" pages.
 
+One can use it this way:
+
+	<TMPL_IF NAME="ISTRANSLATION">
+	<div id="percenttranslated">
+	  <TMPL_VAR NAME="PERCENTTRANSLATED">
+	</div>
+	</TMPL_IF>
+
 Additional PageSpec tests
 -------------------------
 
 This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
 additional tests that are documented [[here|ikiwiki/pagespec/po]].
 
+Automatic PO files update
+-------------------------
+
+Committing changes to a "master" page:
+
+1. updates the POT file and the PO files for the supported languages
+   (this is done in the `needsbuild` hook); the updated PO files are
+   then put under version control
+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)
+
+Also, when the plugin has just been enabled, or when a page has just
+been declared as being translatable, the needed POT and PO files are
+created, and the PO files are checked into version control.
 
 TODO
 ====
@@ -176,36 +202,50 @@ TODO
 OTHERLANGUAGES dependencies
 ---------------------------
 
-Pages using `OTHERLANGUAGES` must depend on any "master" and "slave"
-pages whose status is being displayed. It will trigger dependency
-loops; how to sort this out?
+Pages using `OTHERLANGUAGES` depend on any "master" and "slave" pages
+whose status is being displayed. It is supposed to trigger dependency
+loops, but no practical bugs were noticed yet.
 
 Should pages using the `OTHERLANGUAGES` template loop be declared as
 linking to the same page in other versions? To be rigorous, they
 should, but this may clutter the backlinks.
 
-Automatic PO files update
--------------------------
+Security checks
+---------------
+
+- `refreshpofiles` uses `system()`, whose args have to be checked more
+  thoroughly to prevent any security issue (command injection, etc.).
+- `refreshpofiles` and `refreshpot` create new files; this may need
+  some checks, e.g. using `IkiWiki::prep_writefile()`
+
+gettext/po4a rough corners
+--------------------------
+
+- fix the duplicated PO header mysterious bug
+- fix the "duplicate message definition" error when updating a PO
+  file; do PO files need normalizing? (may be a side effect of
+  previous bug)
+- fix infinite loop when synchronizing two ikiwiki (when checkouts
+  live in different directories): say bla.fr.po has been updated in
+  repo2; pulling repo2 from repo1 seems to trigger a PO update, that
+  changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers
+  a PO update, that changes bla.fr.po in repo2; etc.; fixed in
+  `629968fc89bced6727981c0a1138072631751fee` ?
+
+Misc. improvements
+------------------
 
-Committing changes to a "master" page:
+### automatic POT/PO update
 
-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
+Use the `change` hook instead of `needsbuild`?
 
-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.
+### page titles
 
-**FIXME** Also, when the plugin has just been enabled, or when a page
-has just been declared as being translatable:
+Use nice page titles from meta plugin in links, as inline already does.
 
-- all the needed POT and PO files have to be created
-- the PO files must be checked into version control
+### websetup
 
-**FIXME** `refreshpofiles` uses `system()`, whose args have to be
-checked more thoroughly to prevent any security issue (command
-injection, etc.).
+Which configuration settings are safe enough for websetup?
 
 Translation quality assurance
 -----------------------------
@@ -225,6 +265,8 @@ Translating online
 As PO is a wiki page type, we already have an online PO editor, that
 is ikiwiki's CGI.
 
+**FIXME** preview does not work for PO files.
+
 A message-by-message interface could also be implemented at some
 point; a nice way to do offline translation work (without VCS access)
 still has to be offered, though.