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. It does not have to be named
-a special way: migration from/to this plugin does not imply heavy
+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
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' }
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]].
+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
--------------
-One can use the `po_link_to_` option in `ikiwiki.setup` to choose how
+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: `\[[page]]` links to the master
+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
(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
+- 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.
-### 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.*:
+Server support
+==============
+
+Apache
+------
+
+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
+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.
-- `foo/page/index.LL.html` if `usedirs` is enabled
-- `foo/page.LL.html` if `usedirs` is disabled
+**FIXME**: does `mod_magnet` provide the functionality needed to
+ emulate this?
+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`:
+### Display page's versions in other languages
+
+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"> %)
+ </TMPL_UNLESS>
</li>
</TMPL_LOOP>
</ul>
</div>
</TMPL_IF>
+The following variables are available inside the loop (for every page in):
-Server support
-==============
+- `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
-Apache
-------
+### Display the current translation status
-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.
+The `PERCENTTRANSLATED` variable is set to the translation
+completeness, expressed in percent, on "slave" pages.
-When `usedirs` is enabled, one has to set `DirectoryIndex index` for
-the wiki context.
+Additional PageSpec tests
+-------------------------
-Setting `DefaultLanguage LL` (replace `LL` with your default MIME
-language) for the wiki context can be needed, to ensure
-`bla/page/index.en.html` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.en.html` naming convention?
+This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
+additional tests that are documented [[here|ikiwiki/pagespec/po]].
-lighttpd
---------
+Automatic PO files update
+-------------------------
-lighttpd unfortunately does not support content negotiation.
+Committing changes to a "master" page:
-**FIXME**: does `mod_magnet` provide the functionality needed to
- emulate this?
+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
====
-Link relationships
-------------------
-
-Should pages using the `OTHERLANGUAGES` template loop be declared as
-linking to the same page in other versions?
-
-View translation status
------------------------
+OTHERLANGUAGES dependencies
+---------------------------
-One should be able to view some information about the translation
-completeness, either for a given page or for the whole wiki.
+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.
-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.
+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.
-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.
+Security checks
+---------------
-Automatic PO files update
--------------------------
+- `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()`
-Committing changes to a "master" page must:
+gettext/po4a rough corners
+--------------------------
-1. update the POT file and the PO files for the supported languages;
- this is done in the `needsbuild` hook; the updated PO files must
- then be put under version control
+- 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` ?
-2. trigger 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.
+Misc. bugs
+----------
-Also, when the plugin has just been enabled, all the needed POT and PO
-files have to be created.
-UI consistency: rename "Edit" button on slave pages
----------------------------------------------------
-It may be surprising to some, after having pressed *Edit* on a wiki
-page, to end up editing a strange looking PO file. The *Edit* button
-displayed on "slave" pages must therefore be renamed *Improve
-translation* .
-
-Pages selection depending on language
--------------------------------------
+Misc. improvements
+------------------
-To improve user navigation in a multi-lingual wiki, site developers
-must be enabled to write:
+### page titles
- \[[!map pages="dev/* and lang(LL)" feeds="no"]]
+Use nice page titles from meta plugin in links, as inline already does.
- \[[!map pages="dev/* and currentlang()" feeds="no"]]
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.
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.