]> pere.pagekite.me Git - homepage.git/blob - blog/Writing_and_translating_documentation_in_Debian_Edu.html
Generated.
[homepage.git] / blog / Writing_and_translating_documentation_in_Debian_Edu.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" dir="ltr">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
6 <title>Petter Reinholdtsen: Writing and translating documentation in Debian Edu</title>
7 <link rel="stylesheet" type="text/css" media="screen" href="http://people.skolelinux.org/pere/blog/style.css" />
8 <link rel="stylesheet" type="text/css" media="screen" href="http://people.skolelinux.org/pere/blog/vim.css" />
9
10
11 </head>
12 <body>
13 <div class="title">
14 <h1>
15 <a href="http://people.skolelinux.org/pere/blog/">Petter Reinholdtsen</a>
16
17 </h1>
18
19 </div>
20
21
22 <div class="entry">
23 <div class="title">Writing and translating documentation in Debian Edu</div>
24 <div class="date">16th March 2012</div>
25 <div class="body"><p>Documentation in Debian Edu is provided in several languages, and
26 it is important to make it both easy to contribute and to keep the
27 translated versions in sync. To do this we have come up with what we
28 believe is a very efficient work flow.</p>
29
30 <ol>
31
32 <li>The documentation is written in a
33 <a href="http://moinmo.in">moinmoin wiki</a> (see for example
34 <a href="http://wiki.debian.org/DebianEdu/Documentation/Squeeze">the
35 Squeeze release manual</a>) with support for exporting the content as
36 docbook XML.</li>
37
38 <li>This docbook document is given to po4a to extract a gettext style
39 .pot file with the content, which in turn is used to create .po files
40 with the translated text.</li>
41
42 <li>The .po files are given to translators, and they can always tell
43 which part of the original wiki document is new or changed. They can
44 use their normal translation tools like lokalize or poedit to write
45 the translation. There is even a system in place to handle translated
46 images.</li>
47
48 <li>The translated .po files are combined with the original docbook
49 XML document using po4a to create a translated docbook document.</li>
50
51 <li>The final step is to use all the generated docbook files and
52 create PDF and HTML version of the original and translated documents.</li>
53
54 </ol>
55
56 <p>This setup work very well, but have a few issues. The biggest
57 issue is that <a href="http://moinmo.in/DocBook">the docbook support
58 we use in moinmoin</a> is not actively maintained. The docbook
59 support is also buggy, and our build system contain workarounds to
60 make sure the generated docbook is usable despite these bugs.</p>
61
62 <p>If you want to have a look at our setup, it is all there in the
63 <a href="http://packages.qa.debian.org/debian-edu-doc">debian-edu-doc
64 package</a>.</p>
65 </div>
66
67 <div class="tags">Tags: <a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu</a>, <a href="http://people.skolelinux.org/pere/blog/tags/english">english</a>.</div>
68
69
70 </div>
71
72
73
74
75 <div id="sidebar">
76
77
78
79 <h2>Archive</h2>
80 <ul>
81
82 <li>2018
83 <ul>
84
85 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/01/">January (1)</a></li>
86
87 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/02/">February (5)</a></li>
88
89 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/03/">March (5)</a></li>
90
91 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/04/">April (3)</a></li>
92
93 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/06/">June (2)</a></li>
94
95 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/07/">July (5)</a></li>
96
97 <li><a href="http://people.skolelinux.org/pere/blog/archive/2018/08/">August (2)</a></li>
98
99 </ul></li>
100
101 <li>2017
102 <ul>
103
104 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/01/">January (4)</a></li>
105
106 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/02/">February (3)</a></li>
107
108 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/03/">March (5)</a></li>
109
110 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/04/">April (2)</a></li>
111
112 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/06/">June (5)</a></li>
113
114 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/07/">July (1)</a></li>
115
116 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/08/">August (1)</a></li>
117
118 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/09/">September (3)</a></li>
119
120 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/10/">October (5)</a></li>
121
122 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/11/">November (3)</a></li>
123
124 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/12/">December (4)</a></li>
125
126 </ul></li>
127
128 <li>2016
129 <ul>
130
131 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/01/">January (3)</a></li>
132
133 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/02/">February (2)</a></li>
134
135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/03/">March (3)</a></li>
136
137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/04/">April (8)</a></li>
138
139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/05/">May (8)</a></li>
140
141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/06/">June (2)</a></li>
142
143 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/07/">July (2)</a></li>
144
145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/08/">August (5)</a></li>
146
147 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/09/">September (2)</a></li>
148
149 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/10/">October (3)</a></li>
150
151 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/11/">November (8)</a></li>
152
153 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/12/">December (5)</a></li>
154
155 </ul></li>
156
157 <li>2015
158 <ul>
159
160 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/01/">January (7)</a></li>
161
162 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/02/">February (6)</a></li>
163
164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/03/">March (1)</a></li>
165
166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/04/">April (4)</a></li>
167
168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/05/">May (3)</a></li>
169
170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/06/">June (4)</a></li>
171
172 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/07/">July (6)</a></li>
173
174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/08/">August (2)</a></li>
175
176 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/09/">September (2)</a></li>
177
178 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/10/">October (9)</a></li>
179
180 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/11/">November (6)</a></li>
181
182 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/12/">December (3)</a></li>
183
184 </ul></li>
185
186 <li>2014
187 <ul>
188
189 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/01/">January (2)</a></li>
190
191 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/02/">February (3)</a></li>
192
193 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/03/">March (8)</a></li>
194
195 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/04/">April (7)</a></li>
196
197 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/05/">May (1)</a></li>
198
199 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/06/">June (2)</a></li>
200
201 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/07/">July (2)</a></li>
202
203 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/08/">August (2)</a></li>
204
205 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/09/">September (5)</a></li>
206
207 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/10/">October (6)</a></li>
208
209 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/11/">November (3)</a></li>
210
211 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/12/">December (5)</a></li>
212
213 </ul></li>
214
215 <li>2013
216 <ul>
217
218 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/01/">January (11)</a></li>
219
220 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/02/">February (9)</a></li>
221
222 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/03/">March (9)</a></li>
223
224 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/04/">April (6)</a></li>
225
226 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/05/">May (9)</a></li>
227
228 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/06/">June (10)</a></li>
229
230 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/07/">July (7)</a></li>
231
232 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/08/">August (3)</a></li>
233
234 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/09/">September (5)</a></li>
235
236 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/10/">October (7)</a></li>
237
238 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/11/">November (9)</a></li>
239
240 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/12/">December (3)</a></li>
241
242 </ul></li>
243
244 <li>2012
245 <ul>
246
247 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
248
249 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
250
251 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
252
253 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
254
255 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
256
257 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
258
259 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (17)</a></li>
260
261 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/08/">August (6)</a></li>
262
263 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/09/">September (9)</a></li>
264
265 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/10/">October (17)</a></li>
266
267 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/11/">November (10)</a></li>
268
269 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/12/">December (7)</a></li>
270
271 </ul></li>
272
273 <li>2011
274 <ul>
275
276 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
277
278 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
279
280 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
281
282 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
283
284 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
285
286 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
287
288 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
289
290 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
291
292 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
293
294 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
295
296 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
297
298 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
299
300 </ul></li>
301
302 <li>2010
303 <ul>
304
305 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
306
307 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
308
309 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
310
311 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
312
313 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
314
315 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
316
317 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
318
319 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
320
321 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
322
323 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
324
325 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
326
327 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
328
329 </ul></li>
330
331 <li>2009
332 <ul>
333
334 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
335
336 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
337
338 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
339
340 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
341
342 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
343
344 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
345
346 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
347
348 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
349
350 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
351
352 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
353
354 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
355
356 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
357
358 </ul></li>
359
360 <li>2008
361 <ul>
362
363 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
364
365 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
366
367 </ul></li>
368
369 </ul>
370
371
372
373 <h2>Tags</h2>
374 <ul>
375
376 <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (16)</a></li>
377
378 <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
379
380 <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
381
382 <li><a href="http://people.skolelinux.org/pere/blog/tags/bankid">bankid (4)</a></li>
383
384 <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (9)</a></li>
385
386 <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (17)</a></li>
387
388 <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
389
390 <li><a href="http://people.skolelinux.org/pere/blog/tags/chrpath">chrpath (2)</a></li>
391
392 <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (161)</a></li>
393
394 <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (158)</a></li>
395
396 <li><a href="http://people.skolelinux.org/pere/blog/tags/debian-handbook">debian-handbook (4)</a></li>
397
398 <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (10)</a></li>
399
400 <li><a href="http://people.skolelinux.org/pere/blog/tags/dld">dld (17)</a></li>
401
402 <li><a href="http://people.skolelinux.org/pere/blog/tags/docbook">docbook (25)</a></li>
403
404 <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
405
406 <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (381)</a></li>
407
408 <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (23)</a></li>
409
410 <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (13)</a></li>
411
412 <li><a href="http://people.skolelinux.org/pere/blog/tags/freeculture">freeculture (32)</a></li>
413
414 <li><a href="http://people.skolelinux.org/pere/blog/tags/freedombox">freedombox (9)</a></li>
415
416 <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (18)</a></li>
417
418 <li><a href="http://people.skolelinux.org/pere/blog/tags/h264">h264 (20)</a></li>
419
420 <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (42)</a></li>
421
422 <li><a href="http://people.skolelinux.org/pere/blog/tags/isenkram">isenkram (16)</a></li>
423
424 <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (20)</a></li>
425
426 <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (9)</a></li>
427
428 <li><a href="http://people.skolelinux.org/pere/blog/tags/lego">lego (4)</a></li>
429
430 <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (8)</a></li>
431
432 <li><a href="http://people.skolelinux.org/pere/blog/tags/lsdvd">lsdvd (2)</a></li>
433
434 <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
435
436 <li><a href="http://people.skolelinux.org/pere/blog/tags/mesh network">mesh network (8)</a></li>
437
438 <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (41)</a></li>
439
440 <li><a href="http://people.skolelinux.org/pere/blog/tags/nice free software">nice free software (10)</a></li>
441
442 <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (299)</a></li>
443
444 <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (190)</a></li>
445
446 <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (33)</a></li>
447
448 <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
449
450 <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (71)</a></li>
451
452 <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (107)</a></li>
453
454 <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (2)</a></li>
455
456 <li><a href="http://people.skolelinux.org/pere/blog/tags/reactos">reactos (1)</a></li>
457
458 <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
459
460 <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (3)</a></li>
461
462 <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (10)</a></li>
463
464 <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
465
466 <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (6)</a></li>
467
468 <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
469
470 <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (54)</a></li>
471
472 <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
473
474 <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (5)</a></li>
475
476 <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (55)</a></li>
477
478 <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (6)</a></li>
479
480 <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (12)</a></li>
481
482 <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (55)</a></li>
483
484 <li><a href="http://people.skolelinux.org/pere/blog/tags/sysadmin">sysadmin (4)</a></li>
485
486 <li><a href="http://people.skolelinux.org/pere/blog/tags/usenix">usenix (2)</a></li>
487
488 <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (9)</a></li>
489
490 <li><a href="http://people.skolelinux.org/pere/blog/tags/verkidetfri">verkidetfri (11)</a></li>
491
492 <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (66)</a></li>
493
494 <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (4)</a></li>
495
496 <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (41)</a></li>
497
498 </ul>
499
500
501 </div>
502 <p style="text-align: right">
503 Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.6</a>
504 </p>
505
506 </body>
507 </html>