| 1 |
Debian Installation Manual - notes for translation
|
| 2 |
--------------------------------------------------
|
| 3 |
|
| 4 |
Note: if you happen to modify this file, please don't forget to
|
| 5 |
update the trailing changelog
|
| 6 |
|
| 7 |
Where is the manual kept?
|
| 8 |
=========================
|
| 9 |
|
| 10 |
The manual is kept in a Subversion repository on alioth.debian.org
|
| 11 |
as part of the Debian Installer (d-i) project.
|
| 12 |
You can browse this repository using the following URL:
|
| 13 |
http://svn.debian.org/viewcvs/d-i/trunk/debian-installer/
|
| 14 |
|
| 15 |
The manual and it's translations can be found in ./installer/doc/manual.
|
| 16 |
|
| 17 |
How to join the translation effort for an existing translation
|
| 18 |
==============================================================
|
| 19 |
|
| 20 |
Try to find out who is working on the translation and contact them.
|
| 21 |
Alternatively you can send a mail to the mailing list for your language
|
| 22 |
(debian-l10n-<language>@lists.debian.org), if one exists or to the mailing
|
| 23 |
list for the debian installer project: debian-boot@lists.debian.org.
|
| 24 |
|
| 25 |
You should also coordinate with current translators on which parts to
|
| 26 |
translate and how to submit your translations.
|
| 27 |
|
| 28 |
How to start a new translation
|
| 29 |
==============================
|
| 30 |
|
| 31 |
Starting a translation for a new language without write access to the d-i SVN
|
| 32 |
repository realy is not practical. See the section on getting SVN access below;
|
| 33 |
you will also have to get a local working copy of the manual as described there.
|
| 34 |
|
| 35 |
1. Create a new directory structure for your translation
|
| 36 |
--------------------------------------------------------
|
| 37 |
Use the following commands to create a copy of the English documents as a
|
| 38 |
base for your translation. This also ensures that your translation will be
|
| 39 |
complete and can be build. A text that has not be translated yet, will be
|
| 40 |
included in English.
|
| 41 |
- change directory to: installer/doc/manual/
|
| 42 |
- cp -R en/ <lang>
|
| 43 |
(where <lang> is the ISO code for your language: xx or xx_XX)
|
| 44 |
- find <lang> -name .svn | xargs rm -Rf
|
| 45 |
(this removes all .svn subdirectories)
|
| 46 |
|
| 47 |
2. Create the install.<lang.xml file
|
| 48 |
------------------------------------
|
| 49 |
This file contains the basic information used to build the manual.
|
| 50 |
- change directory to: installer/doc/manual/build/
|
| 51 |
- cp install.en.xml install.<lang>.xml
|
| 52 |
- edit this new file changing the line '<book>' to '<book lang="<lang>">'
|
| 53 |
(again replacing <lang> by the ISO code for your language)
|
| 54 |
|
| 55 |
3. Convert revision comments
|
| 56 |
----------------------------
|
| 57 |
This enables you to track changes is the original English documents.
|
| 58 |
see 'Keeping your translation up to date' below for an explanation.
|
| 59 |
- change directory to: installer/doc/manual/
|
| 60 |
- ./rev-update <lang>
|
| 61 |
|
| 62 |
4. Commit the changes to SVN
|
| 63 |
----------------------------
|
| 64 |
- change directory to: installer/doc/manual/
|
| 65 |
- svn add <lang>
|
| 66 |
- svn add build/install.<lang>.xml
|
| 67 |
- svn ci -m "Manual: creating new translation for <lang>"
|
| 68 |
|
| 69 |
One more change is needed to get your translation build automatically:
|
| 70 |
<lang> needs to be added to the 'languages' variable in build/build.sh.
|
| 71 |
However, this is only usefull after you have translated your first couple
|
| 72 |
of chapters. Please send a request to the debian-boot mail list for your
|
| 73 |
language to be added.
|
| 74 |
|
| 75 |
Encoding
|
| 76 |
========
|
| 77 |
|
| 78 |
The default encoding for all .xml files is UTF-8. If you want to keep your
|
| 79 |
translation in UTF-8 encoding, you should use an editor that supports UTF-8
|
| 80 |
and make sure that UTF-8 encoding is selected when you open a .xml document.
|
| 81 |
|
| 82 |
If it is easier for you to work using another encoding, you will have to
|
| 83 |
specify which encoding you use in the first line of each translated document.
|
| 84 |
For example, to use ISO-8859-1 encoding (for most Western European languages),
|
| 85 |
add the following line at the top of each .xml file:
|
| 86 |
<?xml version="1.0" encoding="ISO-8859-1"?>
|
| 87 |
|
| 88 |
The use of HTML codes (like è) is possible but not advised.
|
| 89 |
|
| 90 |
Note: If you do not specify the correct encoding, your translation will fail
|
| 91 |
to build.
|
| 92 |
Note: You should _not_ change the encoding of the following documents:
|
| 93 |
- administrativa/contributors.xml
|
| 94 |
|
| 95 |
Translation order
|
| 96 |
=================
|
| 97 |
|
| 98 |
Suggested translation order:
|
| 99 |
- ./preface.xml
|
| 100 |
- ./welcome/*.xml
|
| 101 |
- ./using-d-i/*.xml
|
| 102 |
- ./boot-new/*.xml
|
| 103 |
- ./boot-new/modules/*.xml
|
| 104 |
- ./module/*.xml
|
| 105 |
|
| 106 |
Note that currently (may 10, 2004) it look like there will be a fairly major
|
| 107 |
reorganization of parts of the manual in the next month(s).
|
| 108 |
|
| 109 |
Keeping your translation up to date
|
| 110 |
===================================
|
| 111 |
|
| 112 |
There are two perl scripts to help you keep track of changes in the original
|
| 113 |
English text of the manual. These scripts make use of special revision
|
| 114 |
comments that should be included in each file.
|
| 115 |
|
| 116 |
An original English file contains something like:
|
| 117 |
<!-- retain these comments for translator revision tracking -->
|
| 118 |
<!-- $Id: preface.xml 12756 2004-04-06 22:23:56Z some-user $ -->
|
| 119 |
|
| 120 |
The second line is important. It contains the filename, the revision number,
|
| 121 |
the date and time the last revision was committed, the user that committed
|
| 122 |
the last revision. The string '$Id:' is necessary for SVN to automatically
|
| 123 |
update this line each time the file is committed.
|
| 124 |
|
| 125 |
A document in a directory containing a translation should contain either:
|
| 126 |
<!-- original version: 12756 -->
|
| 127 |
or
|
| 128 |
<!-- original version: 12756 untranslated -->
|
| 129 |
|
| 130 |
When you translate a document, you should of course remove the word
|
| 131 |
'untranslated' from this comment.
|
| 132 |
|
| 133 |
The scripts will do several things:
|
| 134 |
- show which translated files have a different revision number from the
|
| 135 |
original English files
|
| 136 |
- show what changes have been made in the original English file
|
| 137 |
- help you update revision comments
|
| 138 |
- help you keep track of which files have not yet been translated
|
| 139 |
You can find both scripts in the root directory for the manual. Both
|
| 140 |
scripts should be run from this directory.
|
| 141 |
|
| 142 |
The procedure below can be used for relatively simple changes. If there
|
| 143 |
have been major reorganizations in the English documents, you may have to
|
| 144 |
do additional checks to find out exactly what changes have been made.
|
| 145 |
Use 'svn st -u' before you start this procedure to check the status of
|
| 146 |
your working copy.
|
| 147 |
|
| 148 |
1. Update your local working copy from SVN
|
| 149 |
------------------------------------------
|
| 150 |
- change directory to: installer/doc/manual/
|
| 151 |
- svn up
|
| 152 |
|
| 153 |
2. Copy new files (if any)
|
| 154 |
--------------------------
|
| 155 |
If there are any new files (marked 'A' in the output from 'svn up'),
|
| 156 |
copy them to the directory for your translation and then:
|
| 157 |
- ./rev-update <lang>
|
| 158 |
This will change the revision comment in the copied file to:
|
| 159 |
<!-- original version: ##### untranslated -->
|
| 160 |
You will also have to run 'svn add' for the new documents.
|
| 161 |
|
| 162 |
3. Check for other changes
|
| 163 |
--------------------------
|
| 164 |
- ./doc-check <lang>
|
| 165 |
If changes are listed for documents that are marked 'untranslated', you
|
| 166 |
can just copy the new English version to the directory for your translation
|
| 167 |
and again use rev-update to change the revision comments.
|
| 168 |
If changes are listed for documents that are not marked 'untranslated',
|
| 169 |
you can create a diff to find out what the changes are by running:
|
| 170 |
- ./doc-check -d <lang>
|
| 171 |
|
| 172 |
4. Update your translations
|
| 173 |
---------------------------
|
| 174 |
Edit your translations to reflect the changes in the English documents.
|
| 175 |
!! Don't forget to also update the revision number in the revision comment
|
| 176 |
after you updated a translation. The revision number should be the same
|
| 177 |
as the revision number in the new version of the English document.
|
| 178 |
You should run './doc-check <lang>' again after you finish all updates and
|
| 179 |
before you commit your changes to SVN; there should be no output.
|
| 180 |
|
| 181 |
Other uses of the scripts
|
| 182 |
-------------------------
|
| 183 |
- doc-check -s <lang>: show which documents are marked untranslated
|
| 184 |
- rev-update -u <lang>: automatically update revision numbers in the directory
|
| 185 |
containing your translation to the revision numbers in the original English
|
| 186 |
documents (use only after you have made sure there are no changes in content)
|
| 187 |
|
| 188 |
How to remain consistent with the installer
|
| 189 |
===========================================
|
| 190 |
|
| 191 |
It is important that your translation of the manual remains consistent with
|
| 192 |
the translation of Debian Installer and packages for your languages.
|
| 193 |
|
| 194 |
Probably the best way to do this, is to run the installer in 'expert' mode,
|
| 195 |
both in English and your own language.
|
| 196 |
|
| 197 |
As strings and their translations in the installer may change, you may have
|
| 198 |
to perform an installation once in a while to check if there have been
|
| 199 |
important changes (the main burden to check for changes in strings falls on
|
| 200 |
the maintainers of the English original, but is you spot inconsistencies,
|
| 201 |
please report them to the debian-boot list).
|
| 202 |
|
| 203 |
You can also use the xx(_XX).po files for packages (including d-i) to see
|
| 204 |
how strings have been translated. For more information on these files,
|
| 205 |
please refer to the translations.txt file in the parent directory of the
|
| 206 |
directory where this file is.
|
| 207 |
|
| 208 |
You can also try contacting the translator for a package or the maillist
|
| 209 |
for your language (debian-l10n-<language>@lists.debian.org) to try to clear
|
| 210 |
questions about translations.
|
| 211 |
|
| 212 |
How to test your work
|
| 213 |
=====================
|
| 214 |
|
| 215 |
When you have finished your translation, always re-read your file at
|
| 216 |
least once to correct all meaning-, spelling-, grammar-, typo-, etc-
|
| 217 |
mistakes.
|
| 218 |
|
| 219 |
You can also try to build the manual (create HTML pages) for a specific
|
| 220 |
architecture for your language.
|
| 221 |
See ./build/README for more information on building the manual.
|
| 222 |
|
| 223 |
How to get write access to the SVN repository
|
| 224 |
=============================================
|
| 225 |
|
| 226 |
1) Installing subversion
|
| 227 |
------------------------
|
| 228 |
|
| 229 |
You need to install subversion on your system. For Debian unstable users,
|
| 230 |
just do "apt-get install svn".
|
| 231 |
|
| 232 |
Others may use backports from www.backports.org. Please add this entry to
|
| 233 |
your /etc/apt/sources.list file:
|
| 234 |
deb http://www.backports.org/debian stable subversion
|
| 235 |
Or use Colin Watson's Woody backports:
|
| 236 |
http://people.debian.org/~cjwatson/subversion-woody/
|
| 237 |
|
| 238 |
2) Getting write access to the subversion repository
|
| 239 |
----------------------------------------------------
|
| 240 |
|
| 241 |
If you are not a Debian Developper, you first need to create a guest account
|
| 242 |
on http://alioth.debian.org/, than ask on debian-boot@lists.debian.org
|
| 243 |
for somebody to add your guest account to the debian-installer project.
|
| 244 |
|
| 245 |
3) Using subversion to get files
|
| 246 |
--------------------------------
|
| 247 |
|
| 248 |
Once your account is allowed to write to the project, you can retreive the
|
| 249 |
full project using this:
|
| 250 |
svn co svn+ssh://<username>@svn.debian.org/svn/d-i/trunk debian-installer
|
| 251 |
If you only want to work on the manual, you can retrieve the relevant part
|
| 252 |
of the repository using:
|
| 253 |
svn co svn+ssh://<username>@svn.debian.org/svn/d-i/trunk debian-installer/installer/doc
|
| 254 |
|
| 255 |
You can find a good manual for SVN at http://svnbook.red-bean.com/svnbook.
|
| 256 |
|
| 257 |
How to get help
|
| 258 |
===============
|
| 259 |
|
| 260 |
If you need further assistance, feel free to ask for help on
|
| 261 |
debian-boot (for debian-installer related stuff) or debian-i18n (for
|
| 262 |
l10n related questions) Debian mailing lists.
|
| 263 |
|
| 264 |
--------------------------------------------------------------------------
|
| 265 |
|
| 266 |
This guide is supposed to be be a first start for translators. There
|
| 267 |
are probably errors. Please fix it if you find errors.
|
| 268 |
|
| 269 |
--------------------------------------------------------------------------
|
| 270 |
Changelog:
|
| 271 |
|
| 272 |
2004/06/04 Frans Pop
|
| 273 |
- Added paragraph on updating translations
|
| 274 |
|
| 275 |
2004/05/10 Frans Pop
|
| 276 |
- file creation
|
Parent Directory
| 
Revision Log