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>2017
  83 <ul>
  84
  85 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/01/">January (4)</a></li>
  86
  87 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/02/">February (3)</a></li>
  88
  89 <li><a href="http://people.skolelinux.org/pere/blog/archive/2017/03/">March (4)</a></li>
  90
  91 </ul></li>
  92
  93 <li>2016
  94 <ul>
  95
  96 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/01/">January (3)</a></li>
  97
  98 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/02/">February (2)</a></li>
  99
 100 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/03/">March (3)</a></li>
 101
 102 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/04/">April (8)</a></li>
 103
 104 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/05/">May (8)</a></li>
 105
 106 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/06/">June (2)</a></li>
 107
 108 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/07/">July (2)</a></li>
 109
 110 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/08/">August (5)</a></li>
 111
 112 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/09/">September (2)</a></li>
 113
 114 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/10/">October (3)</a></li>
 115
 116 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/11/">November (8)</a></li>
 117
 118 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/12/">December (5)</a></li>
 119
 120 </ul></li>
 121
 122 <li>2015
 123 <ul>
 124
 125 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/01/">January (7)</a></li>
 126
 127 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/02/">February (6)</a></li>
 128
 129 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/03/">March (1)</a></li>
 130
 131 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/04/">April (4)</a></li>
 132
 133 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/05/">May (3)</a></li>
 134
 135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/06/">June (4)</a></li>
 136
 137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/07/">July (6)</a></li>
 138
 139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/08/">August (2)</a></li>
 140
 141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/09/">September (2)</a></li>
 142
 143 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/10/">October (9)</a></li>
 144
 145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/11/">November (6)</a></li>
 146
 147 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/12/">December (3)</a></li>
 148
 149 </ul></li>
 150
 151 <li>2014
 152 <ul>
 153
 154 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/01/">January (2)</a></li>
 155
 156 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/02/">February (3)</a></li>
 157
 158 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/03/">March (8)</a></li>
 159
 160 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/04/">April (7)</a></li>
 161
 162 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/05/">May (1)</a></li>
 163
 164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/06/">June (2)</a></li>
 165
 166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/07/">July (2)</a></li>
 167
 168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/08/">August (2)</a></li>
 169
 170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/09/">September (5)</a></li>
 171
 172 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/10/">October (6)</a></li>
 173
 174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/11/">November (3)</a></li>
 175
 176 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/12/">December (5)</a></li>
 177
 178 </ul></li>
 179
 180 <li>2013
 181 <ul>
 182
 183 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/01/">January (11)</a></li>
 184
 185 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/02/">February (9)</a></li>
 186
 187 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/03/">March (9)</a></li>
 188
 189 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/04/">April (6)</a></li>
 190
 191 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/05/">May (9)</a></li>
 192
 193 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/06/">June (10)</a></li>
 194
 195 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/07/">July (7)</a></li>
 196
 197 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/08/">August (3)</a></li>
 198
 199 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/09/">September (5)</a></li>
 200
 201 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/10/">October (7)</a></li>
 202
 203 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/11/">November (9)</a></li>
 204
 205 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/12/">December (3)</a></li>
 206
 207 </ul></li>
 208
 209 <li>2012
 210 <ul>
 211
 212 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
 213
 214 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
 215
 216 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
 217
 218 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
 219
 220 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
 221
 222 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
 223
 224 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (17)</a></li>
 225
 226 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/08/">August (6)</a></li>
 227
 228 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/09/">September (9)</a></li>
 229
 230 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/10/">October (17)</a></li>
 231
 232 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/11/">November (10)</a></li>
 233
 234 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/12/">December (7)</a></li>
 235
 236 </ul></li>
 237
 238 <li>2011
 239 <ul>
 240
 241 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
 242
 243 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
 244
 245 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
 246
 247 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 248
 249 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 250
 251 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 252
 253 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 254
 255 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 256
 257 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 258
 259 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 260
 261 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 262
 263 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 264
 265 </ul></li>
 266
 267 <li>2010
 268 <ul>
 269
 270 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 271
 272 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 273
 274 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 275
 276 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 277
 278 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 279
 280 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 281
 282 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 283
 284 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 285
 286 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 287
 288 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 289
 290 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 291
 292 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 293
 294 </ul></li>
 295
 296 <li>2009
 297 <ul>
 298
 299 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 300
 301 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 302
 303 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 304
 305 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 306
 307 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 308
 309 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 310
 311 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 312
 313 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 314
 315 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 316
 317 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 318
 319 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 320
 321 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 322
 323 </ul></li>
 324
 325 <li>2008
 326 <ul>
 327
 328 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 329
 330 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 331
 332 </ul></li>
 333
 334 </ul>
 335
 336
 337
 338 <h2>Tags</h2>
 339 <ul>
 340
 341  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 342
 343  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 344
 345  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 346
 347  <li><a href="http://people.skolelinux.org/pere/blog/tags/bankid">bankid (4)</a></li>
 348
 349  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (9)</a></li>
 350
 351  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (16)</a></li>
 352
 353  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 354
 355  <li><a href="http://people.skolelinux.org/pere/blog/tags/chrpath">chrpath (2)</a></li>
 356
 357  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (148)</a></li>
 358
 359  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (158)</a></li>
 360
 361  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian-handbook">debian-handbook (3)</a></li>
 362
 363  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (10)</a></li>
 364
 365  <li><a href="http://people.skolelinux.org/pere/blog/tags/dld">dld (16)</a></li>
 366
 367  <li><a href="http://people.skolelinux.org/pere/blog/tags/docbook">docbook (23)</a></li>
 368
 369  <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
 370
 371  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (345)</a></li>
 372
 373  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (23)</a></li>
 374
 375  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 376
 377  <li><a href="http://people.skolelinux.org/pere/blog/tags/freeculture">freeculture (29)</a></li>
 378
 379  <li><a href="http://people.skolelinux.org/pere/blog/tags/freedombox">freedombox (9)</a></li>
 380
 381  <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (18)</a></li>
 382
 383  <li><a href="http://people.skolelinux.org/pere/blog/tags/h264">h264 (20)</a></li>
 384
 385  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (42)</a></li>
 386
 387  <li><a href="http://people.skolelinux.org/pere/blog/tags/isenkram">isenkram (15)</a></li>
 388
 389  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (20)</a></li>
 390
 391  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (9)</a></li>
 392
 393  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (8)</a></li>
 394
 395  <li><a href="http://people.skolelinux.org/pere/blog/tags/lsdvd">lsdvd (2)</a></li>
 396
 397  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 398
 399  <li><a href="http://people.skolelinux.org/pere/blog/tags/mesh network">mesh network (8)</a></li>
 400
 401  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (39)</a></li>
 402
 403  <li><a href="http://people.skolelinux.org/pere/blog/tags/nice free software">nice free software (9)</a></li>
 404
 405  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (287)</a></li>
 406
 407  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (187)</a></li>
 408
 409  <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (28)</a></li>
 410
 411  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 412
 413  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (64)</a></li>
 414
 415  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (99)</a></li>
 416
 417  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 418
 419  <li><a href="http://people.skolelinux.org/pere/blog/tags/reactos">reactos (1)</a></li>
 420
 421  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 422
 423  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (3)</a></li>
 424
 425  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (10)</a></li>
 426
 427  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 428
 429  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (5)</a></li>
 430
 431  <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
 432
 433  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (52)</a></li>
 434
 435  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 436
 437  <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (5)</a></li>
 438
 439  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (51)</a></li>
 440
 441  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (5)</a></li>
 442
 443  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (11)</a></li>
 444
 445  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (48)</a></li>
 446
 447  <li><a href="http://people.skolelinux.org/pere/blog/tags/sysadmin">sysadmin (3)</a></li>
 448
 449  <li><a href="http://people.skolelinux.org/pere/blog/tags/usenix">usenix (2)</a></li>
 450
 451  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (8)</a></li>
 452
 453  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (59)</a></li>
 454
 455  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (4)</a></li>
 456
 457  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (40)</a></li>
 458
 459 </ul>
 460
 461
 462     </div>
 463     <p style="text-align: right">
 464  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.6</a>
 465 </p>
 466
 467   </body>
 468 </html>