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>2012
  81 <ul>
  82
  83 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
  84
  85 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
  86
  87 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
  88
  89 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
  90
  91 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
  92
  93 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
  94
  95 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (16)</a></li>
  96
  97 </ul></li>
  98
  99 <li>2011
 100 <ul>
 101
 102 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
 103
 104 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
 105
 106 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
 107
 108 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 109
 110 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 111
 112 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 113
 114 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 115
 116 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 117
 118 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 119
 120 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 121
 122 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 123
 124 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 125
 126 </ul></li>
 127
 128 <li>2010
 129 <ul>
 130
 131 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 132
 133 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 134
 135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 136
 137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 138
 139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 140
 141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 142
 143 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 144
 145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 146
 147 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 148
 149 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 150
 151 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 152
 153 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 154
 155 </ul></li>
 156
 157 <li>2009
 158 <ul>
 159
 160 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 161
 162 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 163
 164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 165
 166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 167
 168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 169
 170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 171
 172 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 173
 174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 175
 176 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 177
 178 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 179
 180 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 181
 182 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 183
 184 </ul></li>
 185
 186 <li>2008
 187 <ul>
 188
 189 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 190
 191 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 192
 193 </ul></li>
 194
 195 </ul>
 196
 197
 198
 199 <h2>Tags</h2>
 200 <ul>
 201
 202  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 203
 204  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 205
 206  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 207
 208  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (2)</a></li>
 209
 210  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (12)</a></li>
 211
 212  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 213
 214  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (55)</a></li>
 215
 216  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (110)</a></li>
 217
 218  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (9)</a></li>
 219
 220  <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
 221
 222  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (143)</a></li>
 223
 224  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (17)</a></li>
 225
 226  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 227
 228  <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (6)</a></li>
 229
 230  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (30)</a></li>
 231
 232  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (16)</a></li>
 233
 234  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (8)</a></li>
 235
 236  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (4)</a></li>
 237
 238  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 239
 240  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (22)</a></li>
 241
 242  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (190)</a></li>
 243
 244  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (142)</a></li>
 245
 246  <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (4)</a></li>
 247
 248  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 249
 250  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (34)</a></li>
 251
 252  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (48)</a></li>
 253
 254  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 255
 256  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 257
 258  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (2)</a></li>
 259
 260  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (4)</a></li>
 261
 262  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 263
 264  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
 265
 266  <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
 267
 268  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (23)</a></li>
 269
 270  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 271
 272  <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (1)</a></li>
 273
 274  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (36)</a></li>
 275
 276  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (1)</a></li>
 277
 278  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (4)</a></li>
 279
 280  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (10)</a></li>
 281
 282  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (6)</a></li>
 283
 284  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (32)</a></li>
 285
 286  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (1)</a></li>
 287
 288  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (25)</a></li>
 289
 290 </ul>
 291
 292
 293     </div>
 294     <p style="text-align: right">
 295  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.4</a>
 296 </p>
 297
 298   </body>
 299 </html>