[debian-edu-commits] debian-edu/debian-edu-doc.git (#292) - wheezy (branch) updated: 0.8.20071115-11-ge7b4b80

[David Prévot]

The branch, wheezy has been updated
       via  e7b4b80a9723193fe554f67cd1c636bae61113f1 (commit)
      from  6717e1b7e08f5d48abfb6ab988be10db00ed05e9 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
-----------------------------------------------------------------------

Summary of changes:
 debian/changelog                    |    1 +
 documentation/release-manual/README |   82 ++++++++++++++++++++++-------------
 2 files changed, 53 insertions(+), 30 deletions(-)

The diff of changes is:
diff --git a/debian/changelog b/debian/changelog
index 428e985..8a9718e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,7 @@ debian-edu-doc (0.8.20071117) unstable; urgency=low
   * new script, get_itil (based on get_release-manual) to download the itil
     book as docbook and modify it like the release manual, ie add id=name to
     the section tags
+  * release-manual/README: rewritten to be much more verbose and clear
 
  -- Holger Levsen <holger at debian.org>  Sun, 18 Nov 2007 00:21:26 +0100
 
diff --git a/documentation/release-manual/README b/documentation/release-manual/README
index 0274bdf..fd56e30 100644
--- a/documentation/release-manual/README
+++ b/documentation/release-manual/README
@@ -1,46 +1,62 @@
-IMPORTANT note:
----------------
-
-This document needs a rewrite and better structure.
-
-
+README for translators of the release-manual
+--------------------------------------------
 
 Before you start:
 -----------------
 
-Dependencies: po4a texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra dblatex wget docbook-utils
+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):
 
-Please note: pdflatex depends on ($texlive-packages | $tetex-packages) - we need the texlive packages.
+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 
 
+Please note: pdflatex depends on ($texlive-packages | $tetex-packages) - we 
+need the texlive packages.
+
+For the following commands it's assumed your in the directory 
+debian-edu-doc/documentation/release-manual
 
 
-How to document stuff
----------------------
-Just edit the wiki at http://wiki.skolelinux.no/DebianEdu/Documentation/Etch/ - but you need an account on that wiki first.
 
 How to start a translation
 --------------------------
-## this only needs to be done _once_ per language
-$ ./start_new_translation de
-$ svn add release-manual.de.po
-$ vi release-manual.de.po
+
+This only needs to be done _once_ per language:
+
+$ ./start_new_translation fr	# create a new french .po file
+$ svn add release-manual.fr.po	# add it to svn
+$ vi release-manual.fr.po	# better use kbabel for this :)
+$ svn ci release-manual.fr.po	# commit the new translation for the first time
+
+
 
 How to update the translations
 ------------------------------
-$ ./update_translations         
-$ vi release-manual.de.po
-$ svn ci release-manual.de.po
 
-How to build the html and pdf version
--------------------------------------
+Update the translations every time before you start translating some new 
+strings:
+
+$ svn up			# update from svn, maybe someone else 
+				# translated something
+$ ./update_translations         # updates the original from the wiki
+				# and merge it with the existing translation
+$ vi release-manual.fr.po	# again, better use kbabel 
+$ svn ci release-manual.fr.po	# commit your changes
+
+
+
+How to build the html version
+-----------------------------
+
 $ make
 
-Don't add generated files to svn
---------------------------------
-no release-manual.CC.xml
-no release-manual.*pdf
-no html/
-(This needs to be enforced with svn properties.)
+For technical reasons, related to the localized images, the pdf version is only
+build when the debian package is build. But for checking your translation as 
+you work on it, just having the html should be fine.
+
+
 
 Translating notes
 -----------------
@@ -48,17 +64,23 @@ Don't translate FIXMEs, that's unfinished text and needs fixing.
 
 Don't translate tags.
 
+In the string "<phrase>attachment:network-arch.png </phrase>" also don't 
+translate "attachment".
+
 Don't translate URLs - be careful: some wiki-URLs might be harder to notice 
 they are URLs.
 
-In the String "<phrase>attachment:network-arch.png </phrase>" also don't 
-translate "attachment".
-
 To "translate" images, add them to SVN 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 improve, 
+please do contribute to the english version too. Just edit the wiki at 
+http://wiki.skolelinux.no/DebianEdu/Documentation/Etch/ - an user account 
+is needed to edit these pages, so you will probably need to create a wiki 
+user first (via the login link).
+
 
 
 And what about lenny?
 
--- Holger Levsen, holger at debian.org, last updated: 2007-11-14
+-- Holger Levsen, holger at debian.org, last updated: 2007-11-17


hooks/post-receive
-- 
debian-edu-doc.git (Debian package debian-edu-doc)

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "debian-edu-doc.git" (Debian package debian-edu-doc).