po plugin: build %translations at scan time
[ikiwiki.git] / 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' => { 'name' => 'Fran├žais', },
45                                 'es' => { 'name' => 'Castellano', },
46                                 'de' => { 'name' => '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 TODO
124 ====
125
126 Display available translations
127 ------------------------------
128
129 The [[linguas|plugins/contrib/linguas]] plugin has some code that can
130 be used as a basis to display the existing translations, and allow to
131 navigate between them.
132
133 View translation status
134 -----------------------
135
136 One should be able to view some information about the translation
137 completeness, either for a given page or for the whole wiki.
138
139 This should not be too hard using gettext tools. If this is
140 implemented as a
141 [[HTML::Template|http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate]]
142 loop, a page using it should depend on any "master" and "slave" pages
143 whose status is being displayed.
144
145 Automatic PO files update
146 -------------------------
147
148 Committing changes to a "master" page must:
149
150 1. update the POT file and the PO files for the supported languages,
151    before putting them under version control
152 2. trigger a refresh of the corresponding HTML slave pages
153
154 The former is to be done at a time when:
155
156 - we know which "master" page was modified, and thus, which POT/PO
157   files have to be updated: the `needsbuild` hook is the first one to
158   run that provides us with the necessary information
159 - we can modify the list of pages needing a refresh; this is
160   `needsbuild` hook's job
161
162 The latter can be implemented by making any "slave" page depend on the
163 corresponding "master" page. The `add_depends` function can achieve
164 this, if used in a **FIXME** hook.
165
166 UI consistency: rename "Edit" button on slave pages
167 ---------------------------------------------------
168
169 It may be surprising to some, after having pressed *Edit* on a wiki
170 page, to end up editing a strange looking PO file. The *Edit* button
171 displayed on "slave" pages must therefore be renamed *Improve
172 translation* .
173
174 Pages selection depending on language
175 -------------------------------------
176
177 To improve user navigation in a multi-lingual wiki, site developers
178 must be enabled to write:
179
180         \[[!map pages="dev/* and lang(LL)" feeds="no"]]
181
182         \[[!map pages="dev/* and currentlang()" feeds="no"]]
183
184 Translation quality assurance
185 -----------------------------
186
187 Modifying a PO file via the CGI must only be allowed if the new
188 version is a valid PO file. As a bonus, check that it provides a more
189 complete translation than the existing one.
190
191 A new `cansave` type of hook would be needed to implement this.
192
193 Note: committing to the underlying repository is a way to bypass
194 this check.
195
196 Translating online
197 ------------------
198
199 As PO is a wiki page type, we already have an online PO editor, that
200 is ikiwiki's CGI.
201
202 A message-by-message interface could also be implemented at some
203 point; a nice way to do offline translation work (without VCS access)
204 still has to be offered, though.
205
206 Translating offline without VCS access
207 --------------------------------------
208
209 The following workflow should be made possible for translators without
210 VCS access who need to edit the PO files in another editor than a web
211 browser:
212
213 - download the page's PO file
214 - use any PO editor to update the translation
215 - upload the updated PO file
216
217 Implementation note: a generic mechanism to upload a page's source is
218 needed: it's only an alternative way to allow saving a the modified
219 page's source with the CGI.
220
221 ### Short-term workflow
222
223 A possible workaround is:
224
225 - pretend to edit the PO file online
226 - copy the PO file content from the textarea
227 - cancel the edit
228 - paste the content into a local file.
229 - edit the local file in any PO editor
230 - pretend to edit the PO file online
231 - paste the modified local file's content into the edit textarea
232 - save