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   </head>
  10   <body>
  11     <div class="title">
  12  <h1>
  13      <a href="http://people.skolelinux.org/pere/blog/">Petter Reinholdtsen</a>
  14
  15  </h1>
  16
  17 </div>
  18
  19
  20     <div class="entry">
  21       <div class="title">Writing and translating documentation in Debian Edu</div>
  22       <div class="date">16th March 2012</div>
  23       <div class="body"><p>Documentation in Debian Edu is provided in several languages, and
  24 it is important to make it both easy to contribute and to keep the
  25 translated versions in sync.  To do this we have come up with what we
  26 believe is a very efficient work flow.</p>
  27
  28 <ol>
  29
  30 <li>The documentation is written in a
  31 <a href="http://moinmo.in">moinmoin wiki</a> (see for example
  32 <a href="http://wiki.debian.org/DebianEdu/Documentation/Squeeze">the
  33 Squeeze release manual</a>) with support for exporting the content as
  34 docbook XML.</li>
  35
  36 <li>This docbook document is given to po4a to extract a gettext style
  37 .pot file with the content, which in turn is used to create .po files
  38 with the translated text.</li>
  39
  40 <li>The .po files are given to translators, and they can always tell
  41 which part of the original wiki document is new or changed.  They can
  42 use their normal translation tools like lokalize or poedit to write
  43 the translation.  There is even a system in place to handle translated
  44 images.</li>
  45
  46 <li>The translated .po files are combined with the original docbook
  47 XML document using po4a to create a translated docbook document.</li>
  48
  49 <li>The final step is to use all the generated docbook files and
  50 create PDF and HTML version of the original and translated documents.</li>
  51
  52 </ol>
  53
  54 <p>This setup work very well, but have a few issues.  The biggest
  55 issue is that <a href="http://moinmo.in/DocBook">the docbook support
  56 we use in moinmoin</a> is not actively maintained.  The docbook
  57 support is also buggy, and our build system contain workarounds to
  58 make sure the generated docbook is usable despite these bugs.</p>
  59
  60 <p>If you want to have a look at our setup, it is all there in the
  61 <a href="http://packages.qa.debian.org/debian-edu-doc">debian-edu-doc
  62 package</a>.</p>
  63 </div>
  64
  65       <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>
  66
  67
  68     </div>
  69
  70
  71
  72
  73     <div id="sidebar">
  74
  75
  76
  77 <h2>Archive</h2>
  78 <ul>
  79
  80 <li>2013
  81 <ul>
  82
  83 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/01/">January (3)</a></li>
  84
  85 </ul></li>
  86
  87 <li>2012
  88 <ul>
  89
  90 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
  91
  92 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
  93
  94 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
  95
  96 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
  97
  98 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
  99
 100 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
 101
 102 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (17)</a></li>
 103
 104 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/08/">August (6)</a></li>
 105
 106 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/09/">September (9)</a></li>
 107
 108 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/10/">October (17)</a></li>
 109
 110 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/11/">November (10)</a></li>
 111
 112 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/12/">December (7)</a></li>
 113
 114 </ul></li>
 115
 116 <li>2011
 117 <ul>
 118
 119 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
 120
 121 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
 122
 123 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
 124
 125 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 126
 127 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 128
 129 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 130
 131 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 132
 133 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 134
 135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 136
 137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 138
 139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 140
 141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 142
 143 </ul></li>
 144
 145 <li>2010
 146 <ul>
 147
 148 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 149
 150 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 151
 152 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 153
 154 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 155
 156 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 157
 158 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 159
 160 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 161
 162 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 163
 164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 165
 166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 167
 168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 169
 170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 171
 172 </ul></li>
 173
 174 <li>2009
 175 <ul>
 176
 177 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 178
 179 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 180
 181 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 182
 183 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 184
 185 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 186
 187 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 188
 189 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 190
 191 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 192
 193 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 194
 195 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 196
 197 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 198
 199 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 200
 201 </ul></li>
 202
 203 <li>2008
 204 <ul>
 205
 206 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 207
 208 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 209
 210 </ul></li>
 211
 212 </ul>
 213
 214
 215
 216 <h2>Tags</h2>
 217 <ul>
 218
 219  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 220
 221  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 222
 223  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 224
 225  <li><a href="http://people.skolelinux.org/pere/blog/tags/bankid">bankid (4)</a></li>
 226
 227  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (5)</a></li>
 228
 229  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (12)</a></li>
 230
 231  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 232
 233  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (60)</a></li>
 234
 235  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (118)</a></li>
 236
 237  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (9)</a></li>
 238
 239  <li><a href="http://people.skolelinux.org/pere/blog/tags/docbook">docbook (7)</a></li>
 240
 241  <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
 242
 243  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (167)</a></li>
 244
 245  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (21)</a></li>
 246
 247  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 248
 249  <li><a href="http://people.skolelinux.org/pere/blog/tags/freeculture">freeculture (10)</a></li>
 250
 251  <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (9)</a></li>
 252
 253  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (32)</a></li>
 254
 255  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (17)</a></li>
 256
 257  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (8)</a></li>
 258
 259  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (6)</a></li>
 260
 261  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 262
 263  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (25)</a></li>
 264
 265  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (219)</a></li>
 266
 267  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (148)</a></li>
 268
 269  <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (6)</a></li>
 270
 271  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 272
 273  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (41)</a></li>
 274
 275  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (61)</a></li>
 276
 277  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 278
 279  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 280
 281  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (2)</a></li>
 282
 283  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (5)</a></li>
 284
 285  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 286
 287  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
 288
 289  <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
 290
 291  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (28)</a></li>
 292
 293  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 294
 295  <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (4)</a></li>
 296
 297  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (39)</a></li>
 298
 299  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (3)</a></li>
 300
 301  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (5)</a></li>
 302
 303  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (12)</a></li>
 304
 305  <li><a href="http://people.skolelinux.org/pere/blog/tags/sysadmin">sysadmin (1)</a></li>
 306
 307  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (7)</a></li>
 308
 309  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (35)</a></li>
 310
 311  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (4)</a></li>
 312
 313  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (26)</a></li>
 314
 315 </ul>
 316
 317
 318     </div>
 319     <p style="text-align: right">
 320  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.4</a>
 321 </p>
 322
 323   </body>
 324 </html>