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 9e9ba1fd841631ce6204a834229ca908050d05cf..ab37ae419befcbfb0d36cc489ed3d7565b532033 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -10,8 +10,12 @@ Introduction
 ============
 
 A language is chosen as the "master" one, and any other supported
 ============
 
 A language is chosen as the "master" one, and any other supported

-language is a "slave" one. A page written in the "master" language is
-a "master" page, and is written in any supported format but PO.
+language is a "slave" one.
+
+A page written in the "master" language is a "master" page, and is
+written in any supported format but PO. It does not have to be named
+a special way: migration from/to this plugin does not imply heavy
+renaming work.

 
 Example: `bla/page.mdwn` is a "master" Markdown page written in
 English; if `usedirs` is enabled, it is rendered as
 
 Example: `bla/page.mdwn` is a "master" Markdown page written in
 English; if `usedirs` is enabled, it is rendered as


@@ -37,11 +41,57 @@ Configuration
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 
 `po_slave_languages` is used to set the list of supported "slave"
 languages, such as:
 

-        po_slave_languages => { 'fr' => { 'name' => 'Français', },
-                                'es' => { 'name' => 'Castellano', },
-                                'de' => { 'name' => 'Deutsch', }
+        po_slave_languages => { 'fr' => 'Français',
+                                'es' => 'Castellano',
+                                'de' => 'Deutsch',

         }
 
         }
 

+Decide which pages are translatable
+-----------------------------------
+
+The `po_translatable_pages` setting configures what pages are
+translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
+control over what kind of pages are translatable.
+
+The `*.LL.po` translations files are anyway not considered as being
+translatable, so you don't need to worry about excluding them manually
+from this [[ikiwiki/PageSpec]].
+
+Internal links
+--------------
+
+One can use the `po_link_to_` option in `ikiwiki.setup` to choose how
+internal links should be generated, depending on web server features
+and site-specific preferences.
+
+### Default linking behavior
+
+If `po_link_to` is unset, or set to `default`, ikiwiki's default
+linking behavior is preserved: `\[[page]]` links to the master
+language's page.
+
+### Link to negotiated language
+
+If `po_link_to` is set to `negotiated`, `\[[page]]` links to the
+negotiated preferred language, *i.e.* `foo/page/`.
+
+(In)compatibility notes:
+
+- `po_link_to => negotiated` provides no useful behavior if `usedirs`
+  is disabled; this option combination is neither implemented nor
+  allowed
+- `po_link_to => negotiated` provides no useful behavior if the web
+  server does not support Content Negotiation
+
+### Link to current language
+
+If `po_link_to` is set to `current` and the destination page is either
+a translatable page or a translation, `\[[page]]` links to the current
+page's language, *i.e.*:
+
+- `foo/page/index.LL.html` if `usedirs` is enabled
+- `foo/page.LL.html` if `usedirs` is disabled
+

 
 Server support
 ==============
 
 Server support
 ==============


@@ -70,38 +120,55 @@ lighttpd unfortunately does not support content negotiation.
  emulate this?
 
 
  emulate this?
 
 

-TODO
-====
+Usage
+=====
+
+Templates
+---------

 
 

-Links
------
+The `OTHERLANGUAGES` loop provides ways to display other languages'
+versions of the same page, and the translations' status.

 
 

-Choice between two behaviors must be possible in `ikiwiki.setup`;
-a `po_link_to_current_language` option must allow switching
-between them.
+One typically adds the following code to `templates/page.tmpl`:

 
 

-If `po_link_to_current_language` is disabled, `[[page]]` links to the
-negotiated preferred language, i.e.:
+       <TMPL_IF NAME="OTHERLANGUAGES">
+       <div id="otherlanguages">
+         <ul>
+         <TMPL_LOOP NAME="OTHERLANGUAGES">
+           <li>
+             <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>

 
 

-- `usedirs` enabled: `bla/page/`
-- `usedirs` disabled: `bla/page`
+The following variables are available inside the loop (for every page in):

 
 

-This obviously does not work in case Content Negotiation is not
-supported by the web server, hence one can enable
-`po_link_to_current_language` to make `[[page]]` link to the current
-page's language, i.e.:
+- `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

 
 

-- `usedirs` enabled: `bla/page/index.LL.html`
-- `usedirs` disabled: `bla/page.LL.html`
+Additional PageSpec tests
+-------------------------

 
 

-**FIXME**: should `po_link_to_current_language` be enabled by default?
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].

 
 

-Display available translations
-------------------------------

 
 

-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.
+TODO
+====
+
+Link relationships
+------------------
+
+Should pages using the `OTHERLANGUAGES` template loop be declared as
+linking to the same page in other versions?

 
 View translation status
 -----------------------
 
 View translation status
 -----------------------


@@ -111,41 +178,36 @@ 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
 
 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.
 
 loop, a page using it should depend on any "master" and "slave" pages
 whose status is being displayed.
 

-Decide which pages are translatable
------------------------------------
-
-The subset of "master" pages subject to translation must be
-configurable:
-
-- a `[[!translatable ]]` directive, when put on a page, makes it
-  translatable
-- to set at once a bunch of pages as being translatable, use this
-  [[ikiwiki/directive]] with the `match=PageSpec` argument.
+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
 -------------------------
 
 
 Automatic PO files update
 -------------------------
 

-Committing changes to a "master" page must:
+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; **FIXME**: the updated PO
+   files must then be put under version control

 
 

-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
+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.

 
 

-The former is to be done at a time when:
+**FIXME** Also, when the plugin has just been enabled, or when a page
+has just been declared as being translatable:

 
 

-- 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
+- all the needed POT and PO files have to be created
+- the PO files must be checked into version control

 
 

-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.
+**FIXME** `refreshpofiles` uses `system()`, whose args have to be
+checked more thoroughly to prevent any security issue (command
+injection, etc.).

 
 UI consistency: rename "Edit" button on slave pages
 ---------------------------------------------------
 
 UI consistency: rename "Edit" button on slave pages
 ---------------------------------------------------


@@ -155,16 +217,6 @@ page, to end up editing a strange looking PO file. The *Edit* button
 displayed on "slave" pages must therefore be renamed *Improve
 translation* .
 
 displayed on "slave" pages must therefore be renamed *Improve
 translation* .
 

-Pages selection depending on language
--------------------------------------
-
-To improve user navigation in a multi-lingual wiki, site developers
-must be enabled to write:
-
-        \[[!map pages="dev/* and lang(LL)" feeds="no"]]
-
-        \[[!map pages="dev/* and currentlang()" feeds="no"]]
-

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