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.  This make it hard
  57 to upgrade moinmoin.  The docbook support is also buggy, and our build
  58 system contain lots of workarounds to make sure the generated docbook
  59 is usable despite these bugs.</p>
  60
  61 <p>If you want to have a look at our setup, it is all there in the
  62 <a href="http://packages.qa.debian.org/debian-edu-doc">debian-edu-doc
  63 package</a>.</p>
  64 </div>
  65
  66       <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>
  67
  68
  69     </div>
  70
  71
  72
  73
  74     <div id="sidebar">
  75
  76
  77
  78 <h2>Archive</h2>
  79 <ul>
  80
  81 <li>2012
  82 <ul>
  83
  84 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
  85
  86 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
  87
  88 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (10)</a></li>
  89
  90 </ul></li>
  91
  92 <li>2011
  93 <ul>
  94
  95 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
  96
  97 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
  98
  99 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
 100
 101 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 102
 103 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 104
 105 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 106
 107 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 108
 109 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 110
 111 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 112
 113 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 114
 115 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 116
 117 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 118
 119 </ul></li>
 120
 121 <li>2010
 122 <ul>
 123
 124 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 125
 126 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 127
 128 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 129
 130 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 131
 132 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 133
 134 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 135
 136 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 137
 138 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 139
 140 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 141
 142 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 143
 144 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 145
 146 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 147
 148 </ul></li>
 149
 150 <li>2009
 151 <ul>
 152
 153 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 154
 155 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 156
 157 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 158
 159 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 160
 161 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 162
 163 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 164
 165 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 166
 167 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 168
 169 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 170
 171 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 172
 173 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 174
 175 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 176
 177 </ul></li>
 178
 179 <li>2008
 180 <ul>
 181
 182 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 183
 184 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 185
 186 </ul></li>
 187
 188 </ul>
 189
 190
 191
 192 <h2>Tags</h2>
 193 <ul>
 194
 195  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 196
 197  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 198
 199  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 200
 201  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (2)</a></li>
 202
 203  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (12)</a></li>
 204
 205  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 206
 207  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (54)</a></li>
 208
 209  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (88)</a></li>
 210
 211  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (7)</a></li>
 212
 213  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (115)</a></li>
 214
 215  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (14)</a></li>
 216
 217  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 218
 219  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (18)</a></li>
 220
 221  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (15)</a></li>
 222
 223  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (8)</a></li>
 224
 225  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (4)</a></li>
 226
 227  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 228
 229  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (14)</a></li>
 230
 231  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (151)</a></li>
 232
 233  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (120)</a></li>
 234
 235  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 236
 237  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (24)</a></li>
 238
 239  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (46)</a></li>
 240
 241  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 242
 243  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 244
 245  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (2)</a></li>
 246
 247  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (4)</a></li>
 248
 249  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 250
 251  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
 252
 253  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (23)</a></li>
 254
 255  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 256
 257  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (24)</a></li>
 258
 259  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (1)</a></li>
 260
 261  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (3)</a></li>
 262
 263  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (9)</a></li>
 264
 265  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (6)</a></li>
 266
 267  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (23)</a></li>
 268
 269  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (1)</a></li>
 270
 271  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (18)</a></li>
 272
 273 </ul>
 274
 275
 276     </div>
 277     <p style="text-align: right">
 278  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.4</a>
 279 </p>
 280
 281   </body>
 282 </html>