the rename hooks names waltz seems over
[ikiwiki.git] / doc / plugins / contrib / po.mdwn
1 I've been working on a plugin called "po", that adds support for multi-lingual wikis,
2 translated with gettext, using [po4a](http://po4a.alioth.debian.org/).
3
4 More information:
5
6 * It can be found in my "po" branch:
7   `git clone git://gaffer.ptitcanardnoir.org/ikiwiki.git`
8 * It is self-contained, *i.e.* it does not modify ikiwiki core at all.
9 * It is documented (including TODO and plans for next work steps) in
10   `doc/plugins/po.mdwn`, which can be found in the same branch.
11 * No public demo site is available so far, I'm working on this.
12
13 My plan is to get this plugin clean enough to be included in ikiwiki.
14
15 The current version is a proof-of-concept, mature enough for me to dare submitting it here,
16 but I'm prepared to hear various helpful remarks, and to rewrite parts of it as needed.
17
18 Any thoughts on this?
19
20 > Well, I think it's pretty stunning what you've done here. Seems very
21 > complete and well thought out. I have not read the code in great detail
22 > yet.
23
24 > Just using po files is an approach I've never seen tried with a wiki. I
25 > suspect it will work better for some wikis than others. For wikis that
26 > just want translations that match the master language as closely as
27 > possible and don't wander off and diverge, it seems perfect. (But what happens
28 > if someone edits the Discussion page of a translated page?)
29
30 > Please keep me posted, when you get closer to having all issues solved
31 > and ready for merging I can do a review and hopefully help with the
32 > security items you listed. --[[Joey]]
33
34 >> Thanks a lot for your quick review, it's reassuring to hear such nice words
35 >> from you. I did not want to design and write a full translation system, when
36 >> tools such as gettext/po4a already have all the needed functionality, for cases
37 >> where the master/slave languages paradigm fits.
38 >> Integrating these tools into ikiwiki plugin system was a pleasure.
39 >>
40 >> I'll tell you when I'm ready for merging, but in the meantime,
41 >> I'd like you to review the changes I did to the core (3 added hooks).
42 >> Can you please do this? If not, I'll go on and hope I'm not going to far in
43 >> the wrong direction.
44 >>
45 >>> Sure.. I'm not completly happy with any of the hooks since they're very
46 >>> special purpose, and also since `run_hooks` is not the best interface
47 >>> for a hook that modifies a variable, where only the last hook run will
48 >>> actually do anything. It might be better to just wrap
49 >>> `targetpage`, `bestlink`, and `beautify_urlpath`. But, I noticed
50 >>> the other day that such wrappers around exported functions are only visible by
51 >>> plugins loaded after the plugin that defines them.
52 >>> 
53 >>> Update: Take a look at the new "Function overriding" section of
54 >>> [[plugins/write]]. I think you can just inject wrappers about a few ikiwiki
55 >>> functions, rather than adding hooks. The `inject` function is pretty
56 >>> insane^Wlow level, but seems to work great. --[[Joey]]
57 >>>
58 >>>> Thanks a lot, it seems to be a nice interface for what I was trying to achieve.
59 >>>> I may be forced to wait two long weeks before I have a chance to confirm
60 >>>> this. Stay tuned. --[[intrigeri]]
61 >>>>
62 >>>>> I've updated the plugin to use `inject`. It is now fully self-contained,
63 >>>>> and does not modify the core anymore. --[[intrigeri]]
64 >>
65 >> The Discussion pages issue is something I am not sure about yet. But I will
66 >> probably decide that "slave" pages, being only translations, don't deserve
67 >> a discussion page: the discussion should happen in the language in which the
68 >> pages are written for real, which is the "master" one. --[[intrigeri]]
69 >> 
70 >> I think that's a good decision, you don't want to translate discussion,
71 >> and if the discussion page turns out multilingual, well, se la vi. ;-)
72 >> 
73 >> Relatedly, what happens if a translated page has a broken link, and you
74 >> click on it to edit it? Seems you'd first have to create a master page
75 >> and could only then translate it, right? I wonder if this will be clear
76 >> though to the user.
77 >>
78 >>> Right: a broken link points to the URL that allows to create
79 >>> a page that can either be a new master page or a non-translatable
80 >>> page, depending on `po_translatable_pages` value. The best
81 >>> solution I can thing of is to use [[plugins/edittemplate]] to
82 >>> insert something like "Warning: this is a master page, that must
83 >>> be written in $MASTER_LANGUAGE" into newly created master pages,
84 >>> and maybe another warning message on newly created
85 >>> non-translatable pages. It seems quite doable to me, but in order
86 >>> to avoid breaking existing functionality, it implies to hack a bit
87 >>> [[plugins/edittemplate]] so that multiple templates can be
88 >>> inserted at page creation time. [[--intrigeri]]
89 >>>
90 >>>> I implemented such a warning using the formbuilder_setup hook.
91 >>>> --[[intrigeri]]
92 >>
93 >> And also, is there any way to start a translation of a page into a new
94 >> lanauge using the web interface?
95 >>
96 >>> When a new language is added to `po_slave_languages`, a rebuild is
97 >>> triggered, and all missing PO files are created and checked into
98 >>> VCS. An unpriviledged wiki user can not add a new language to
99 >>> `po_slave_languages`, though. One could think of adding the needed
100 >>> interface to translate a page into a yet-unsupported slave
101 >>> language, and this would automagically add this new language to
102 >>> `po_slave_languages`. It would probably be useful in some
103 >>> usecases, but I'm not comfortable with letting unpriviledged wiki
104 >>> users change the wiki configuration as a side effect of their
105 >>> actions; if this were to be implemented, special care would be
106 >>> needed. [[--intrigeri]]
107 >>>
108 >>>> Actually I meant into any of the currently supported languages.
109 >>>> I guess that if the template modification is made, it will list those
110 >>>> languages on the page, and if a translation to a language is missing,
111 >>>> the link will allow creating it?
112 >>>>
113 >>>>> Any translation page always exist for every supported slave
114 >>>>> language, even if no string at all have been translated yet.
115 >>>>> This implies the po plugin is especially friendly to people who
116 >>>>> prefer reading in their native language if available, but don't
117 >>>>> mind reading in English else.
118 >>>>>
119 >>>>> While I'm at it, there is a remaining issue that needs to be
120 >>>>> sorted out: how painful it could be for non-English speakers
121 >>>>> (assuming the master language is English) to be perfectly able
122 >>>>> to navigate between translation pages supposed to be written in
123 >>>>> their own language, when their translation level is most
124 >>>>> often low.
125 >>>>>
126 >>>>> (It is currently easy to display this status on the translation
127 >>>>> page itself, but then it's too late, and how frustrating to load
128 >>>>> a page just to realize it's actually not translated enough for
129 >>>>> you. The "other languages" loop also allows displaying this
130 >>>>> information, but it is generally not the primary
131 >>>>> navigation tool.)
132 >>>>>
133 >>>>> IMHO, this is actually a social problem (i.e. it's no use adding
134 >>>>> a language to the supported slave ones if you don't have the
135 >>>>> manpower to actually do the translations), that can't be fully
136 >>>>> solved by technical solutions, but I can think of some hacks
137 >>>>> that would limit the negative impact: a given translation's
138 >>>>> status (currently = percent translated) could be displayed next
139 >>>>> to the link that leads to it; a color code could as well be used
140 >>>>> ("just" a matter of adding a CSS id or class to the links,
141 >>>>> depending on this variable). As there is already work to be done
142 >>>>> to have the links text generation more customizable through
143 >>>>> plugins, I could do both at the same time if we consider this
144 >>>>> matter to be important enough. --[[intrigeri]]
145 >>>>>
146 >>>>>> The translation status in links is now implemented in my
147 >>>>>> `po`branch. It requires my `meta` branch changes to
148 >>>>>> work, though. I consider the latter to be mature enough to
149 >>>>>> be merged. --[[intrigeri]]
150
151 >> FWIW, I'm tracking your po branch in ikiwiki master git in the po
152 >> branch. One thing I'd like to try in there is setting up a translated
153 >> basewiki, which seems like it should be pretty easy to do, and would be
154 >> a great demo! --[[Joey]]
155 >>
156 >>> I've merged your changes into my own branch, and made great
157 >>> progress on the various todo items. Please note my repository
158 >>> location has changed a few days ago, my user page was updated
159 >>> accordingly, but I forgot to update this page at the same time.
160 >>> Hoping it's not too complicated to relocated an existing remote...
161 >>> (never done that, I'm a Git beginner as well as a Perl
162 >>> newbie) --[[intrigeri]]
163 >>>>
164 >>>> Just a matter of editing .git/config, thanks for the heads up.
165 >>>>>
166 >>>>> Joey, please have a look at my branch, your help would be really
167 >>>>> welcome for the security research, as I'm almost done with what
168 >>>>> I am able to do myself in this area. --[[intrigeri]]
169 >>>>>>
170 >>>>>> I came up with a patch for the WrapI18N issue --[[Joey]]
171
172 I've set this plugin development aside for a while. I will be back and
173 finish it at some point in the first quarter of 2009. --[[intrigeri]]
174
175 > Abstract: Joey, please have a look at my po and meta branches.
176
177 > Detailed progress report:
178
179 > * it seems the po branch in your repository has not been tracking my
180 >   own po branch for two months. any config issue?
181 > * all the plugin's todo items have been completed, robustness tests
182 >   done
183 > * I've finished the detailed security audit, and the fix for po4a
184 >   bugs has entered upstream CVS last week
185 > * I've merged your new `checkcontent` hook with the `cansave` hook
186 >   I previously introduced in my own branch; blogspam plugin updated
187 >   accordingly
188 > * the rename hook changes we discussed elsewhere are also part of my
189 >   branch
190 > * I've introduced two new hooks (`canremove` and `canrename`), not
191 >   a big deal; IMHO, they extend quite logically the plugin interface
192 > * as highlighted on [[bugs/pagetitle_function_does_not_respect_meta_titles]],
193 >   my `meta` branch contains a new feature that is really useful in a
194 >   translatable wiki
195
196 > As a conclusion, I'm feeling that my branches are ready to be
197 > merged; only thing missing, I guess, are a bit of discussion and
198 > subsequent adjustments.
199
200 > --[[intrigeri]]
201
202 > I've looked it over and updated my branch with some (untested)
203 > changes.
204
205 >> I've merged your changes into my branch. Only one was buggy.
206
207 > Sorry, I'd forgotten about your cansave hook.. sorry for the duplicate
208 > work there.
209
210 > Reviewing the changes, mostly outside of `po.pm`, I have
211 > the following issues.
212 >  
213 > * renamepage to renamelink change would break the ikiwiki
214 >   3.x API, which I've promised not to do, so needs to be avoided
215 >   somehow. (Sorry, I guess I dropped the ball on not getting this
216 >   API change in before cutting 3.0..)
217 >> 
218 >> Fixed, see [[todo/need_global_renamepage_hook]].
219 >>
220 > * I don't understand the parentlinks code change and need to figure it
221 >   out. Can you explain what is going on there?
222 >> 
223 >> I'm calling `bestlink` there so that po's injected `bestlink` is
224 >> run. This way, the parent links of a page link to the parent page
225 >> version in the proper language, depending on the
226 >> `po_link_to=current` and `po_link_to=negotiated` settings.
227 >> Moreover, when using my meta branch enhancements plus meta title to
228 >> make pages titles translatable, this small patch is needed to get
229 >> the translated titles into parentlinks.
230 >> 
231 > * canrename's mix of positional and named parameters is way too
232 >   ugly to get into an ikiwiki API. Use named parameters
233 >   entirely. Also probably should just use named parameters
234 >   for canremove.
235 > * `skeleton.pm.example`'s canrename needs fixing to use either
236 >   the current or my suggested parameters.
237 >> 
238 >> Done.
239 >> 
240 > * I don't like the exporting of `%backlinks` and `$backlinks_calculated`
241 >   (the latter is exported but not used).
242 >> 
243 >> The commit message for 85f865b5d98e0122934d11e3f3eb6703e4f4c620
244 >> contains the rationale for this change. I guess I don't understand
245 >> the subtleties of `our` use, and perldoc does not help me a lot.
246 >> IIRC, I actually did not use `our` to "export" these variables, but
247 >> rather to have them shared between `Render.pm` uses.
248 >> 
249 > * What is this `IkiWiki::nicepagetitle` and why are you
250 >   injecting it into that namespace when only your module uses it?
251 >   Actually, I can't even find a caller of it in your module.
252 >> 
253 >> I guess you should have a look to my `meta` branch and to
254 >> [[bugs/pagetitle_function_does_not_respect_meta_titles]] in order
255 >> to understand this :)
256 >> 
257 > * I'm very fearful of the `add_depends` in `postscan`. 
258 >   Does this make every page depend on every page that links
259 >   to it? Won't this absurdly bloat the dependency pagespecs
260 >   and slow everything down? And since nicepagetitle is given
261 >   as the reason for doing it, and nicepagetitle isn't used,
262 >   why do it?
263 >> 
264 >> As explained in the 85f865b5d98e0122934d11e3f3eb6703e4f4c620 log:
265 >> this feature hits performance a bit. Its cost was quite small in my
266 >> real-world use-cases (a few percents bigger refresh time), but
267 >> could be bigger in worst cases. When using the po plugin with my
268 >> meta branch changes (i.e. the `nicepagetitle` thing), and having
269 >> enabled the option to display translation status in links, this
270 >> maintains the translation status up-to-date in backlinks. Same when
271 >> using meta title to make the pages titles translatable. It does
272 >> help having a nice and consistent translated wiki, but as it hurts
273 >> performance, I'm proposing to turn it into an option.
274 >> 
275 > * The po4a Suggests should be versioned to the first version
276 >   that can be used safely, and that version documented in 
277 >   `plugins/po.mdwn`.
278 >>
279 >> Done.
280 >> 
281 >> --[[intrigeri]]
282
283 > --[[Joey]]