README for translators of the debian-edu-buster-manual
--------------------------------------------


Before you start:
-----------------

Install the build dependencies of the package plus some extra packages (which
are needed for working on the translations, the package itself builds fine without 
them):

sudo apt-get build-dep debian-edu-doc
sudo apt-get install po4a texlive-latex-recommended texlive-latex-extra \ 
texlive-fonts-recommended texlive-fonts-extra dblatex wget libxml2-utils

Please note: pdflatex depends on ($texlive-packages | $tetex-packages) - we 
need the texlive packages.

For the following commands it's assumed you're in the current directory:
debian-edu-doc/documentation/debian-edu-buster



How to start a translation
--------------------------

Simply copy the POT file as a PO file:

$ cp debian-edu-buster-manual.pot debian-edu-buster-manual.da.po	# create a new Danish PO file
$ git add debian-edu-buster-manual.da.po				# add it to the VCS
$ vi debian-edu-buster-manual.da.po					# better use Lokalize for this :)
$ git commit debian-edu-buster-manual.da.po				# commit the new translation for the first time
$ git push								# update the remote repository



How to update the translations
------------------------------

Update the translations every time before you start translating some new 
strings:

$ git pull					# update from the VCS, maybe someone else translated
						# something or the English source was updated
$ vi debian-edu-buster-manual.da.po		# again, better use Lokalize 
$ LINGUA=da make				# check the build and rewrap the PO file
$ git diff debian-edu-buster-manual.da.po	# check the differences from the previous file
$ git commit debian-edu-buster-manual.da.po	# commit changes to your local repository
$ git push					# update the remote repository



How to build the HTML version
-----------------------------

$ make			# build all HTML versions.

Even faster: 

$ LINGUA=da make	# build only the Danish translation in HTML.

You can also build the PDF:

$ LINGUA=da make pdf	# build only the Danish translation in PDF.

The English pictures will used for these test builds, but localized images
will be used during the actual build process (if they exist).



Translating notes
-----------------
Don't translate FIXMEs, that's unfinished text and needs fixing.

Don't translate tags.

Don't translate the image file names: the string
"./images/Debian_Edu_Network_Squeeze.png" must stay as is.
TODO: filter out the fileref Attribute from the PO files

Don't translate URLs - be careful: some wiki-URLs might be harder to notice 
they are URLs.

To "translate" images, add them to the VCS into the images/$CC/ directory, where 
$CC is your language. They will be picked up automatically. 

If you spot errors in the English version or see how it could be improved, 
please do contribute to the English version too. Just edit the wiki at 
https://wiki.debian.org/DebianEdu/Documentation/Buster/ - a user account 
is needed to edit these pages, so you will probably need to create a wiki 
user first (via the login link).

If you cannot commit your work to the VCS directly, please file a bug against
the debian-edu-doc package, see https://bugs.debian.org/debian-edu-doc. Compress
the PO file using gzip and attach the file to the bugreport. Instructions how
to submit bugs are available at https://bugs.debian.org


-- Holger Levsen, holger@debian.org, last updated: 2018-01-25
