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 moinmoin wiki (see for example
  31 <a href="http://wiki.debian.org/DebianEdu/Documentation/Squeeze">the
  32 Squeeze release manual</a>) with support for exporting the content as
  33 docbook XML.</li>
  34
  35 <li>This docbook document is given to po4a to extract a gettext style
  36 .pot file with the content, which in turn is used to create .po files
  37 with the translated text.</li>
  38
  39 <li>The .po files are given to translators, and they can always tell
  40 which part of the original wiki document is new or changed.  They can
  41 use their normal translation tools like lokalize or poedit to write
  42 the translation.  There is even a system in place to handle translated
  43 images.</li>
  44
  45 <li>The translated .po files are combined with the original docbook
  46 XML document using po4a to create a translated docbook document.</li>
  47
  48 <li>The final step is to use all the generated docbook files and
  49 create PDF and HTML version of the original and translated documents.</li>
  50
  51 </ol>
  52
  53 <p>This setup work very well, but have a few issues.  The biggest
  54 issue is that the docbook support in moinmoin is not actively
  55 maintained.  This make it hard to upgrade moinmoin.  The docbook
  56 support is also buggy, and our build system contain lots of
  57 workarounds to make sure the generated docbook is usable despite these
  58 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 (10)</a></li>
  88
  89 </ul></li>
  90
  91 <li>2011
  92 <ul>
  93
  94 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
  95
  96 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
  97
  98 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
  99
 100 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 101
 102 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 103
 104 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 105
 106 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 107
 108 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 109
 110 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 111
 112 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 113
 114 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 115
 116 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 117
 118 </ul></li>
 119
 120 <li>2010
 121 <ul>
 122
 123 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 124
 125 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 126
 127 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 128
 129 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 130
 131 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 132
 133 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 134
 135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 136
 137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 138
 139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 140
 141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 142
 143 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 144
 145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 146
 147 </ul></li>
 148
 149 <li>2009
 150 <ul>
 151
 152 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 153
 154 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 155
 156 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 157
 158 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 159
 160 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 161
 162 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 163
 164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 165
 166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 167
 168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 169
 170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 171
 172 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 173
 174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 175
 176 </ul></li>
 177
 178 <li>2008
 179 <ul>
 180
 181 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 182
 183 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 184
 185 </ul></li>
 186
 187 </ul>
 188
 189
 190
 191 <h2>Tags</h2>
 192 <ul>
 193
 194  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 195
 196  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 197
 198  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 199
 200  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (2)</a></li>
 201
 202  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (12)</a></li>
 203
 204  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 205
 206  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (54)</a></li>
 207
 208  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (88)</a></li>
 209
 210  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (7)</a></li>
 211
 212  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (115)</a></li>
 213
 214  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (14)</a></li>
 215
 216  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 217
 218  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (18)</a></li>
 219
 220  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (15)</a></li>
 221
 222  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (8)</a></li>
 223
 224  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (4)</a></li>
 225
 226  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 227
 228  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (14)</a></li>
 229
 230  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (151)</a></li>
 231
 232  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (120)</a></li>
 233
 234  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 235
 236  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (24)</a></li>
 237
 238  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (46)</a></li>
 239
 240  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 241
 242  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 243
 244  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (2)</a></li>
 245
 246  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (4)</a></li>
 247
 248  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 249
 250  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
 251
 252  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (23)</a></li>
 253
 254  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 255
 256  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (24)</a></li>
 257
 258  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (1)</a></li>
 259
 260  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (3)</a></li>
 261
 262  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (9)</a></li>
 263
 264  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (6)</a></li>
 265
 266  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (23)</a></li>
 267
 268  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (1)</a></li>
 269
 270  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (18)</a></li>
 271
 272 </ul>
 273
 274
 275     </div>
 276     <p style="text-align: right">
 277  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.4</a>
 278 </p>
 279
 280   </body>
 281 </html>