Merge commit 'upstream/master' into pub/master

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

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 4e7553a11c43fb053f03026dc53e91c55bfc566e..fe6b6b562a9260459aec13a20a5c458e19fc9a8e 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -128,6 +128,9 @@ Usage
 Templates
 ---------
 
 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'
 ### Display page's versions in other languages
 
 The `OTHERLANGUAGES` loop provides ways to display other languages'


@@ -163,12 +166,51 @@ 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.
 
 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]].
 
 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.
+
+Discussion pages
+----------------
+
+Discussion should happen in the language in which the pages are written for
+real, *i.e.* the "master" one. If discussion pages are enabled, "slave" pages
+therefore link to the "master" page's discussion page.
+
+Translating
+-----------
+
+One can edit the PO files using ikiwiki's CGI (a message-by-message interface
+could also be implemented at some point).
+
+If [[tips/untrusted_git_push]] is setup, one can edit the PO files in her
+preferred `$EDITOR`, without needing to be online.

 
 TODO
 ====
 
 TODO
 ====


@@ -176,36 +218,71 @@ TODO
 OTHERLANGUAGES dependencies
 ---------------------------
 
 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.
 
 
 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 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`?
+- new translations created in the web interface must get proper charset/encoding
+  gettext metadata, else the next automatic PO update removes any non-ascii
+  chars; possible solution: put such metadata into the Pot file, and let it
+  propagate; should be fixed in `773de05a7a1ee68d2bed173367cf5e716884945a`, time
+  will tell.
+
+Misc. improvements
+------------------

 
 

-Committing changes to a "master" page:
+### preview

 
 

-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
+preview does not work for PO files.

 
 

-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.
+### automatic POT/PO update
+
+Use the `change` hook instead of `needsbuild`?
+
+### page titles
+
+Use nice page titles from meta plugin in links, as inline already does. This is
+actually a duplicate for
+[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might be fixed
+by something like [[todo/using_meta_titles_for_parentlinks]].

 
 

-**FIXME** Also, when the plugin has just been enabled, or when a page
-has just been declared as being translatable:
+### websetup

 
 

-- all the needed POT and PO files have to be created
-- the PO files must be checked into version control
+Which configuration settings are safe enough for websetup?

 
 

-**FIXME** `refreshpofiles` uses `system()`, whose args have to be
-checked more thoroughly to prevent any security issue (command
-injection, etc.).
+### parentlinks
+
+When the wiki home page is translatable, the parentlinks plugin sets
+`./index.html` as its translations' single parent link. Ideally, the home page's
+translations should get no parent link at all, just like the version written in
+the master language.
+
+### backlinks
+
+If a given translatable `sourcepage.mdwn` links to \[[destpage]],
+`sourcepage.LL.po` also link to \[[destpage]], and the latter has the master
+page *and* all its translations listed in the backlinks.

 
 Translation quality assurance
 -----------------------------
 
 Translation quality assurance
 -----------------------------


@@ -218,41 +295,3 @@ A new `cansave` type of hook would be needed to implement this.
 
 Note: committing to the underlying repository is a way to bypass
 this check.
 
 Note: committing to the underlying repository is a way to bypass
 this check.

-
-Translating online
-------------------
-
-As PO is a wiki page type, we already have an online PO editor, that
-is ikiwiki's CGI.
-
-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.
-
-Translating offline without VCS access
---------------------------------------
-
-The following workflow should be made possible for translators without
-VCS access who need to edit the PO files in another editor than a web
-browser:
-
-- download the page's PO file
-- use any PO editor to update the translation
-- upload the updated PO file
-
-Implementation note: a generic mechanism to upload a page's source is
-needed: it's only an alternative way to allow saving a the modified
-page's source with the CGI.
-
-### Short-term workflow
-
-A possible workaround is:
-
-- pretend to edit the PO file online
-- copy the PO file content from the textarea
-- cancel the edit
-- paste the content into a local file.
-- edit the local file in any PO editor
-- pretend to edit the PO file online
-- paste the modified local file's content into the edit textarea
-- save