]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/po.mdwn
po plugin: documentation work
[git.ikiwiki.info.git] / doc / plugins / po.mdwn
index 326a6f39fcd64af9536788feea4f9973b5176a93..4e7553a11c43fb053f03026dc53e91c55bfc566e 100644 (file)
@@ -2,34 +2,41 @@
 [[!tag type/format]]
 
 This plugin adds support for multi-lingual wikis, translated with
 [[!tag type/format]]
 
 This plugin adds support for multi-lingual wikis, translated with
-gettext, using [po4a|http://po4a.alioth.debian.org/].
+gettext, using [po4a](http://po4a.alioth.debian.org/).
 
 It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
 
 Introduction
 ============
 
 
 It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
 
 Introduction
 ============
 
-A language is decided to be 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.
+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. It can be
+of any page type supported by ikiwiki, but PO. It does not have to be
+named a special way: migration to this plugin does not imply any page
+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
-`bla/page/index.html.en`, else as `bla/page.html.en`.
+`bla/page/index.en.html`, else as `bla/page.en.html`.
 
 
-Translations of a "master" page into a "slave" language are called
-"slave" pages, and is a in gettext PO format. PO is thus promoted to
-the wiki page type status.
+Any translation of a "master" page into a "slave" language is called
+a "slave" page; it is written in the gettext PO format. PO is now
+a page type supported by ikiwiki.
 
 Example: `bla/page.fr.po` is the PO "message catalog" used to
 translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is
 
 Example: `bla/page.fr.po` is the PO "message catalog" used to
 translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is
-rendered as `bla/page/index.html.fr`, else as `bla/page.html.fr`
+rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
 
 
 Configuration
 =============
 
 
 
 Configuration
 =============
 
-`po_master_language` is used to set the master language in
+Supported languages
+-------------------
+
+`po_master_language` is used to set the "master" language in
 `ikiwiki.setup`, such as:
 
         po_master_language => { 'code' => 'en', 'name' => 'English' }
 `ikiwiki.setup`, such as:
 
         po_master_language => { 'code' => 'en', 'name' => 'English' }
@@ -37,10 +44,56 @@ 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 PO translations files are anyway not considered as being
+translatable, so you don't need to worry about excluding them
+explicitly from this [[ikiwiki/PageSpec]].
+
+Internal links
+--------------
+
+The `po_link_to` option in `ikiwiki.setup` is used to decide 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: `\[[destpage]]` links to the master
+language's page.
+
+### Link to current language
+
+If `po_link_to` is set to `current`, `\[[destpage]]` links to the
+`destpage`'s version written in the current page's language, if
+available, *i.e.*:
+
+- `foo/destpage/index.LL.html` if `usedirs` is enabled
+- `foo/destpage.LL.html` if `usedirs` is disabled
+
+### 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:
+
+- if `usedirs` is disabled, it does not make sense to set `po_link_to`
+  to `negotiated`; this option combination is neither implemented
+  nor allowed.
+- if the web server does not support Content Negotiation, setting
+  `po_link_to` to `negotiated` will produce a unusable website.
 
 
 Server support
 
 
 Server support
@@ -49,87 +102,116 @@ Server support
 Apache
 ------
 
 Apache
 ------
 
-Using `mod_negotiation` makes it really easy to have Apache serve the
-page in the client's preferred language, if available. This is the
-default Debian Apache configuration.
+Using Apache `mod_negotiation` makes it really easy to have Apache
+serve any page in the client's preferred language, if available.
+This is the default Debian Apache configuration.
 
 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 the wiki context.
 
 Setting `DefaultLanguage LL` (replace `LL` with your default MIME
 
 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 the wiki context.
 
 Setting `DefaultLanguage LL` (replace `LL` with your default MIME
-language) for the wiki context can be needed, to ensure
-`bla/page/index.html.en` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.html.en` naming convention?
+language code) for the wiki context can help to ensure
+`bla/page/index.en.html` is served as `Content-Language: LL`.
 
 lighttpd
 --------
 
 lighttpd unfortunately does not support content negotiation.
 
 
 lighttpd
 --------
 
 lighttpd unfortunately does not support content negotiation.
 
+**FIXME**: does `mod_magnet` provide the functionality needed to
+ emulate this?
 
 
-TODO
-====
 
 
-Display available translations
-------------------------------
+Usage
+=====
 
 
-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.
+Templates
+---------
 
 
-View translation status
------------------------
+### Display page's versions in other languages
 
 
-One should be able to view some freshness information about the
-translation status, either for a given page or for the whole wiki.
+The `OTHERLANGUAGES` loop provides ways to display other languages'
+versions of the same page, and the translations' status.
 
 
-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]]
-loop, a page using it should depend on any "master" and "slave" pages
-whose status is being displayed.
+One typically adds the following code to `templates/page.tmpl`:
 
 
-Decide which pages are translatable
------------------------------------
+       <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>
+
+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
+
+### Display the current translation status
+
+The `PERCENTTRANSLATED` variable is set to the translation
+completeness, expressed in percent, on "slave" pages.
+
+Additional PageSpec tests
+-------------------------
 
 
-The subset of ("master") pages supporting translation must be
-configurable:
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].
 
 
-- a `[[!translatable ]]` directive, when put on a page, makes it
-  translatable
-- this [[ikiwiki/directive]] can be used with an optional `match=PageSpec`
-  argument, to render translatable a bunch of pages at once
+
+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?
+
+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
 -------------------------
 
 
 Automatic PO files update
 -------------------------
 
-Committing changes to a "master" page must:
+Committing changes to a "master" page:
 
 
-1. update the POT file, the PO files for the supported languages, and
-   put them under version control
-2. trigger a refresh of the corresponding HTML slave pages
+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
 
 
-The former can be implemented as a `needsbuild` hook, which is the
-first type of hook to run after the list of files that need to be
-built is known: that is, at a time when we know which "master" page
-was modified, and thus, which POT/PO files have to be updated.
+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 latter can be implemented by making any "slave" page depend on the
-corresponding "master" page. The `add_depends` function can achieved
-this, if used in a FIXME hook.
+**FIXME** Also, when the plugin has just been enabled, or when a page
+has just been declared as being translatable:
 
 
-UI consistency: rename "Edit" button on slave pages
----------------------------------------------------
+- all the needed POT and PO files have to be created
+- the PO files must be checked into version control
 
 
-It may be surprising to some, after having pressed *Edit* on a wiki
-page, to end up editing a strange PO file. The *Edit* button must then
-be be renamed to *Improve translation* on "slave" pages.
+**FIXME** `refreshpofiles` uses `system()`, whose args have to be
+checked more thoroughly to prevent any security issue (command
+injection, etc.).
 
 Translation quality assurance
 -----------------------------
 
 
 Translation quality assurance
 -----------------------------
 
-Modifying a PO file via the CGI must only be allowed if the new
-version is a valid PO file. As a bonus, check that it provides a more
+Modifying a PO file via the CGI must be forbidden if the new version
+is not a valid PO file. As a bonus, check that it provides a more
 complete translation than the existing one.
 
 A new `cansave` type of hook would be needed to implement this.
 complete translation than the existing one.
 
 A new `cansave` type of hook would be needed to implement this.
@@ -143,8 +225,9 @@ Translating online
 As PO is a wiki page type, we already have an online PO editor, that
 is ikiwiki's CGI.
 
 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 be implemented later, providing
-a nice way to translate offline (without VCS access) is provided.
+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
 --------------------------------------
 
 Translating offline without VCS access
 --------------------------------------
@@ -153,17 +236,23 @@ 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:
 
 VCS access who need to edit the PO files in another editor than a web
 browser:
 
-- download the PO file for the page
+- download the page's PO file
 - use any PO editor to update the translation
 - upload the updated PO file
 
 - use any PO editor to update the translation
 - upload the updated PO file
 
-A generic mechanism to download and upload a page's source is needed.
-It's only an alternative way to do Edit/edit/Save.
+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
 
 
 ### 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.
 - 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