1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
[[!template id=plugin name=po core=0 author="[[intrigeri]]"]]
[[!tag type/format]]
This plugin adds support for multi-lingual wikis, translated with
gettext, using [po4a](http://po4a.alioth.debian.org/).
It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
Introduction
============
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.
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`.
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
rendered as `bla/page/index.html.fr`, else as `bla/page.html.fr`
Configuration
=============
`po_master_language` is used to set the master language in
`ikiwiki.setup`, such as:
po_master_language => { 'code' => 'en', 'name' => 'English' }
`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', }
}
Server support
==============
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.
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?
lighttpd
--------
lighttpd unfortunately does not support content negotiation.
**FIXME**: does `mod_magnet` provide the functionality needed to
emulate this?
TODO
====
Display available translations
------------------------------
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.
View translation status
-----------------------
One should be able to view some information about the translation
completeness, either for a given page or for the whole wiki.
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.
Decide which pages are translatable
-----------------------------------
The subset of "master" pages subject to translation must be
configurable:
- a `[[!translatable ]]` directive, when put on a page, makes it
translatable
- to set at once a bunch of pages as being translatable, use this
[[ikiwiki/directive]] with the `match=PageSpec` argument.
Automatic PO files update
-------------------------
Committing changes to a "master" page must:
1. update the POT file and the PO files for the supported languages,
before putting them under version control
2. trigger a refresh of the corresponding HTML slave pages
The former is to be done at a time when:
- we know which "master" page was modified, and thus, which POT/PO
files have to be updated: the `needsbuild` hook is the first one to
run that provides us with the necessary information
- we can modify the list of pages needing a refresh; this is
`needsbuild` hook's job
The latter can be implemented by making any "slave" page depend on the
corresponding "master" page. The `add_depends` function can achieve
this, if used in a **FIXME** hook.
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
-------------------------------------
To improve user navigation in a multi-lingual wiki, site developers
must be enabled to write:
\[[!map pages="dev/* and preferredlang()" feeds="no"]]
\[[!map pages="dev/* and currentlang()" feeds="no"]]
Some new [[ikiwiki/pagespec]] functions have to be written.
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
complete translation than the existing one.
A new `cansave` type of hook would be needed to implement this.
Note: committing to the underlying repository is a way to bypass
this check.
Translating online
------------------
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 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
--------------------------------------
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:
- download the page's PO file
- use any PO editor to update the translation
- upload the updated PO file
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
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.
- 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
|