doc/plugins/po.mdwn

   1 [[!template id=plugin name=po core=0 author="[[intrigeri]]"]]
   2 [[!tag type/format]]
   3
   4 This plugin adds support for multi-lingual wikis, translated with
   5 gettext, using [po4a](http://po4a.alioth.debian.org/).
   6
   7 It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
   8
   9 Introduction
  10 ============
  11
  12 A language is chosen as the "master" one, and any other supported
  13 language is a "slave" one.
  14
  15 A page written in the "master" language is a "master" page, and is
  16 written in any supported format but PO. It does not have to be named
  17 a special way: migration from/to this plugin does not imply heavy
  18 renaming work.
  19
  20 Example: `bla/page.mdwn` is a "master" Markdown page written in
  21 English; if `usedirs` is enabled, it is rendered as
  22 `bla/page/index.en.html`, else as `bla/page.en.html`.
  23
  24 Any translation of a "master" page into a "slave" language is called
  25 a "slave" page; it is written in the gettext PO format. PO is now
  26 a page type supported by ikiwiki.
  27
  28 Example: `bla/page.fr.po` is the PO "message catalog" used to
  29 translate `bla/page.mdwn` into French; if `usedirs` is enabled, it is
  30 rendered as `bla/page/index.fr.html`, else as `bla/page.fr.html`
  31
  32
  33 Configuration
  34 =============
  35
  36 `po_master_language` is used to set the master language in
  37 `ikiwiki.setup`, such as:
  38
  39         po_master_language => { 'code' => 'en', 'name' => 'English' }
  40
  41 `po_slave_languages` is used to set the list of supported "slave"
  42 languages, such as:
  43
  44         po_slave_languages => { 'fr' => 'Français',
  45                                 'es' => 'Castellano',
  46                                 'de' => 'Deutsch',
  47         }
  48
  49 Decide which pages are translatable
  50 -----------------------------------
  51
  52 The `po_translatable_pages` setting configures what pages are
  53 translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
  54 control over what kind of pages are translatable.
  55
  56 The `*.LL.po` translations files are anyway not considered as being
  57 translatable, so you don't need to worry about excluding them manually
  58 from this [[ikiwiki/PageSpec]].
  59
  60 Internal links
  61 --------------
  62
  63 One can use the `po_link_to_` option in `ikiwiki.setup` to choose how
  64 internal links should be generated, depending on web server features
  65 and site-specific preferences.
  66
  67 ### Default linking behavior
  68
  69 If `po_link_to` is unset, or set to `default`, ikiwiki's default
  70 linking behavior is preserved: `\[[page]]` links to the master
  71 language's page.
  72
  73 ### Link to negotiated language
  74
  75 If `po_link_to` is set to `negotiated`, `\[[page]]` links to the
  76 negotiated preferred language, *i.e.* `foo/page/`.
  77
  78 (In)compatibility notes:
  79
  80 - `po_link_to => negotiated` provides no useful behavior if `usedirs`
  81   is disabled; this option combination is neither implemented nor
  82   allowed
  83 - `po_link_to => negotiated` provides no useful behavior if the web
  84   server does not support Content Negotiation
  85
  86 ### Link to current language
  87
  88 If `po_link_to` is set to `current` and the destination page is either
  89 a translatable page or a translation, `\[[page]]` links to the current
  90 page's language, *i.e.*:
  91
  92 - `foo/page/index.LL.html` if `usedirs` is enabled
  93 - `foo/page.LL.html` if `usedirs` is disabled
  94
  95
  96 Server support
  97 ==============
  98
  99 Apache
 100 ------
 101
 102 Using `mod_negotiation` makes it really easy to have Apache serve the
 103 page in the client's preferred language, if available. This is the
 104 default Debian Apache configuration.
 105
 106 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 107 the wiki context.
 108
 109 Setting `DefaultLanguage LL` (replace `LL` with your default MIME
 110 language) for the wiki context can be needed, to ensure
 111 `bla/page/index.en.html` is served as `Content-Language: LL`.
 112 **FIXME**: is it still needed with the new `.en.html` naming convention?
 113
 114 lighttpd
 115 --------
 116
 117 lighttpd unfortunately does not support content negotiation.
 118
 119 **FIXME**: does `mod_magnet` provide the functionality needed to
 120  emulate this?
 121
 122
 123 Usage
 124 =====
 125
 126 Templates
 127 ---------
 128
 129 The `OTHERLANGUAGES` loop provides ways to display the existing
 130 translations and/or master page. One typically adds the following code
 131 to `templates/page.tmpl`:
 132
 133         <TMPL_IF NAME="OTHERLANGUAGES">
 134         <div id="otherlanguages">
 135           <ul>
 136           <TMPL_LOOP NAME="OTHERLANGUAGES">
 137             <li>
 138               <a href="<TMPL_VAR NAME="URL">"
 139                  class="is_master_<TMPL_VAR NAME="MASTER">">
 140               <TMPL_VAR NAME="LANGUAGE">
 141             </a>
 142             </li>
 143           </TMPL_LOOP>
 144           </ul>
 145         </div>
 146         </TMPL_IF>
 147
 148 Additional PageSpec tests
 149 -------------------------
 150
 151 This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
 152 additional tests that are documented [[here|ikiwiki/pagespec/po]].
 153
 154
 155 TODO
 156 ====
 157
 158 Link relationships
 159 ------------------
 160
 161 Should pages using the `OTHERLANGUAGES` template loop be declared as
 162 linking to the same page in other versions?
 163
 164 View translation status
 165 -----------------------
 166
 167 One should be able to view some information about the translation
 168 completeness, either for a given page or for the whole wiki.
 169
 170 This should not be too hard using gettext tools. If this is
 171 implemented as a
 172 [HTML::Template](http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate)
 173 loop, a page using it should depend on any "master" and "slave" pages
 174 whose status is being displayed.
 175
 176 If it's not too heavy to compute, this status data may be made
 177 available in the `OTHERLANGUAGES` template loop; else, a dedicated
 178 loop would be needed.
 179
 180 Automatic PO files update
 181 -------------------------
 182
 183 Committing changes to a "master" page:
 184
 185 1. updates the POT file and the PO files for the supported languages;
 186    this is done in the `needsbuild` hook; **FIXME**: the updated PO
 187    files must then be put under version control
 188
 189 2. triggers a refresh of the corresponding HTML slave pages: this is
 190    achieved by making any "slave" page dependent on the corresponding
 191    "master" page, in the `needsbuild` hook.
 192
 193 **FIXME** Also, when the plugin has just been enabled, or when a page
 194 has just been declared as being translatable:
 195
 196 - all the needed POT and PO files have to be created
 197 - the PO files must be checked into version control
 198
 199 **FIXME** `refreshpofiles` uses `system()`, whose args have to be
 200 checked more thoroughly to prevent any security issue (command
 201 injection, etc.).
 202
 203 UI consistency: rename "Edit" button on slave pages
 204 ---------------------------------------------------
 205
 206 It may be surprising to some, after having pressed *Edit* on a wiki
 207 page, to end up editing a strange looking PO file. The *Edit* button
 208 displayed on "slave" pages must therefore be renamed *Improve
 209 translation* .
 210
 211 Translation quality assurance
 212 -----------------------------
 213
 214 Modifying a PO file via the CGI must only be allowed if the new
 215 version is a valid PO file. As a bonus, check that it provides a more
 216 complete translation than the existing one.
 217
 218 A new `cansave` type of hook would be needed to implement this.
 219
 220 Note: committing to the underlying repository is a way to bypass
 221 this check.
 222
 223 Translating online
 224 ------------------
 225
 226 As PO is a wiki page type, we already have an online PO editor, that
 227 is ikiwiki's CGI.
 228
 229 A message-by-message interface could also be implemented at some
 230 point; a nice way to do offline translation work (without VCS access)
 231 still has to be offered, though.
 232
 233 Translating offline without VCS access
 234 --------------------------------------
 235
 236 The following workflow should be made possible for translators without
 237 VCS access who need to edit the PO files in another editor than a web
 238 browser:
 239
 240 - download the page's PO file
 241 - use any PO editor to update the translation
 242 - upload the updated PO file
 243
 244 Implementation note: a generic mechanism to upload a page's source is
 245 needed: it's only an alternative way to allow saving a the modified
 246 page's source with the CGI.
 247
 248 ### Short-term workflow
 249
 250 A possible workaround is:
 251
 252 - pretend to edit the PO file online
 253 - copy the PO file content from the textarea
 254 - cancel the edit
 255 - paste the content into a local file.
 256 - edit the local file in any PO editor
 257 - pretend to edit the PO file online
 258 - paste the modified local file's content into the edit textarea
 259 - save