po: mark po_translatable_pages as a safe configuration setting
[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. It can be
16 of any page type supported by ikiwiki, except `po`. It does not have to be
17 named a special way: migration to this plugin does not imply any page
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 Supported languages
37 -------------------
38
39 `po_master_language` is used to set the "master" language in
40 `ikiwiki.setup`, such as:
41
42         po_master_language => { 'code' => 'en', 'name' => 'English' }
43
44 `po_slave_languages` is used to set the list of supported "slave"
45 languages, such as:
46
47         po_slave_languages => { 'fr' => 'Fran├žais',
48                                 'es' => 'Castellano',
49                                 'de' => 'Deutsch',
50         }
51
52 Decide which pages are translatable
53 -----------------------------------
54
55 The `po_translatable_pages` setting configures what pages are
56 translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
57 control over what kind of pages are translatable.
58
59 The `.po` files are not considered as being translatable, so you don't need to
60 worry about excluding them explicitly from this [[ikiwiki/PageSpec]].
61
62 Internal links
63 --------------
64
65 The `po_link_to` option in `ikiwiki.setup` is used to decide how
66 internal links should be generated, depending on web server features
67 and site-specific preferences.
68
69 ### Default linking behavior
70
71 If `po_link_to` is unset, or set to `default`, ikiwiki's default
72 linking behavior is preserved: `\[[destpage]]` links to the master
73 language's page.
74
75 ### Link to current language
76
77 If `po_link_to` is set to `current`, `\[[destpage]]` links to the
78 `destpage`'s version written in the current page's language, if
79 available, *i.e.*:
80
81 - `foo/destpage/index.LL.html` if `usedirs` is enabled
82 - `foo/destpage.LL.html` if `usedirs` is disabled
83
84 ### Link to negotiated language
85
86 If `po_link_to` is set to `negotiated`, `\[[page]]` links to the
87 negotiated preferred language, *i.e.* `foo/page/`.
88
89 (In)compatibility notes:
90
91 - if `usedirs` is disabled, it does not make sense to set `po_link_to`
92   to `negotiated`; this option combination is neither implemented
93   nor allowed.
94 - if the web server does not support Content Negotiation, setting
95   `po_link_to` to `negotiated` will produce a unusable website.
96
97
98 Server support
99 ==============
100
101 Apache
102 ------
103
104 Using Apache `mod_negotiation` makes it really easy to have Apache
105 serve any page in the client's preferred language, if available.
106 This is the default Debian Apache configuration.
107
108 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
109 the wiki context.
110
111 Setting `DefaultLanguage LL` (replace `LL` with your default MIME
112 language code) for the wiki context can help to ensure
113 `bla/page/index.en.html` is served as `Content-Language: LL`.
114
115 lighttpd
116 --------
117
118 lighttpd unfortunately does not support content negotiation.
119
120 **FIXME**: does `mod_magnet` provide the functionality needed to
121  emulate this?
122
123
124 Usage
125 =====
126
127 Templates
128 ---------
129
130 The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
131 display things only on translatable or translation pages.
132
133 ### Display page's versions in other languages
134
135 The `OTHERLANGUAGES` loop provides ways to display other languages'
136 versions of the same page, and the translations' status.
137
138 One typically adds the following code to `templates/page.tmpl`:
139
140         <TMPL_IF NAME="OTHERLANGUAGES">
141         <div id="otherlanguages">
142           <ul>
143           <TMPL_LOOP NAME="OTHERLANGUAGES">
144             <li>
145               <a href="<TMPL_VAR NAME="URL">"><TMPL_VAR NAME="LANGUAGE"></a>
146               <TMPL_UNLESS NAME="MASTER">
147                 (<TMPL_VAR NAME="PERCENT">&nbsp;%)
148               </TMPL_UNLESS>
149             </li>
150           </TMPL_LOOP>
151           </ul>
152         </div>
153         </TMPL_IF>
154
155 The following variables are available inside the loop (for every page in):
156
157 - `URL` - url to the page
158 - `CODE` - two-letters language code
159 - `LANGUAGE` - language name (as defined in `po_slave_languages`)
160 - `MASTER` - is true (1) if, and only if the page is a "master" page
161 - `PERCENT` - for "slave" pages, is set to the translation completeness, in percents
162
163 ### Display the current translation status
164
165 The `PERCENTTRANSLATED` variable is set to the translation
166 completeness, expressed in percent, on "slave" pages.
167
168 One can use it this way:
169
170         <TMPL_IF NAME="ISTRANSLATION">
171         <div id="percenttranslated">
172           <TMPL_VAR NAME="PERCENTTRANSLATED">
173         </div>
174         </TMPL_IF>
175
176 Additional PageSpec tests
177 -------------------------
178
179 This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with some
180 additional tests that are documented [[here|ikiwiki/pagespec/po]].
181
182 Automatic PO file update
183 ------------------------
184
185 Committing changes to a "master" page:
186
187 1. updates the POT file and the PO files for the "slave" languages;
188    the updated PO files are then put under version control;
189 2. triggers a refresh of the corresponding HTML slave pages.
190
191 Also, when the plugin has just been enabled, or when a page has just
192 been declared as being translatable, the needed POT and PO files are
193 created, and the PO files are checked into version control.
194
195 Discussion pages
196 ----------------
197
198 Discussion should happen in the language in which the pages are
199 written for real, *i.e.* the "master" one. If discussion pages are
200 enabled, "slave" pages therefore link to the "master" page's
201 discussion page.
202
203 Translating
204 -----------
205
206 One can edit the PO files using ikiwiki's CGI (a message-by-message
207 interface could also be implemented at some point).
208
209 If [[tips/untrusted_git_push]] is setup, one can edit the PO files in one's
210 preferred `$EDITOR`, without needing to be online.
211
212 TODO
213 ====
214
215 Security checks
216 ---------------
217
218 - `refreshpofiles` uses `system()`, whose args have to be checked more
219   thoroughly to prevent any security issue (command injection, etc.).
220   > Always pass `system()` a list of parameters to avoid the shell.
221   > I've checked in a change fixing that. --[[Joey]]
222 - `refreshpofiles` and `refreshpot` create new files; this may need
223   some checks, e.g. using `IkiWiki::prep_writefile()`
224   > Yes, it would be ideal to call `prep_writefile` on each file 
225   > that they write, beforehand. This way you'd avoid symlink attacks etc to the
226   > generated po/pot files. I haven't done it, but it seems pretty trivial.
227   > --[[Joey]]
228 - Can any sort of directives be put in po files that will
229   cause mischief (ie, include other files, run commands, crash gettext,
230   whatever).
231 - Any security issues on running po4a on untrusted content?
232
233 gettext/po4a rough corners
234 --------------------------
235
236 - fix infinite loop when synchronizing two ikiwiki (when checkouts
237   live in different directories): say bla.fr.po has been updated in
238   repo2; pulling repo2 from repo1 seems to trigger a PO update, that
239   changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers
240   a PO update, that changes bla.fr.po in repo2; etc.; fixed in
241   `629968fc89bced6727981c0a1138072631751fee`?
242 - new translations created in the web interface must get proper
243   charset/encoding gettext metadata, else the next automatic PO update
244   removes any non-ascii chars; possible solution: put such metadata
245   into the Pot file, and let it propagate; should be fixed in
246   `773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell.
247
248 Misc. improvements
249 ------------------
250
251 ### page titles
252
253 Use nice page titles from meta plugin in links, as inline already
254 does. This is actually a duplicate for
255 [[bugs/pagetitle_function_does_not_respect_meta_titles]], which might
256 be fixed by something like [[todo/using_meta_titles_for_parentlinks]].
257
258 ### websetup
259
260 Which configuration settings are safe enough for websetup, apart of
261 `po_master_language`, `po_slave_languages` and `po_translatable_pages`
262 that have been checked already?
263
264 > `po_link_to` w/o usedirs causes ikiwiki to error out. If it were
265 > changed to fall back to a safe setting in this case rather than
266 > error, it would be safe.
267 > --[[Joey]]
268
269 ### backlinks
270
271 `po_link_to = negotiated`: if a given translatable `sourcepage.mdwn`
272 links to \[[destpage]], `sourcepage.LL.po` also link to \[[destpage]],
273 and the latter has the master page *and* all its translations listed
274 in the backlinks.
275
276 `po_link_to = current`: seems to work nicely
277
278 Translation quality assurance
279 -----------------------------
280
281 Modifying a PO file via the CGI must be forbidden if the new version
282 is not a valid PO file. As a bonus, check that it provides a more
283 complete translation than the existing one.
284
285 A new `cansave` type of hook would be needed to implement this.
286
287 Note: committing to the underlying repository is a way to bypass
288 this check.