X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=po%2FREADME;h=3eb1b0479263ade6195b3e283a39ab4110009782;hb=69323e5f402c84897eaeea7a28cdae1b3da10066;hp=bb3824b1c6c9f421bee808fc4a0b4d9e20865962;hpb=4e31e13244be1694c3725a8e463ad0494635ef30;p=dgit.git diff --git a/po/README b/po/README index bb3824b1..3eb1b047 100644 --- a/po/README +++ b/po/README @@ -1,26 +1,143 @@ +NOTES FOR TRANSLATORS +===================== + +Introduction +------------ + The dgit source package contains dgit and git-debrebase. +These are useful for a variety of different users and in different +situations. So there are various documents aimed at various users. + +* dgit and git-debrebase both support message translation. + +* Documentation translation is handled via po4a, in the po4a + directory. The documeents are all manpages. + +* git-debrebase is currently mostly useful within the Debian project, + but this will change and its document translations will then be more + important. + +The en_US message translation is slightly special. It is used for +testing the translation machinery, and since the source native +language is en_GB, there is not much other need for the en_US +translation. + +The threshold for generation of a translated documents has been set to +10% (of each individual document). The documents are quite sectional +and I expect even a partially translated document to be useful. + + +Translatation priorities +------------------------ + + HIGH + + po4a/dgit-user_7.pot How to use dgit to as a downstream or user + + MEDIUM + + po/messages.pot All the messages for both programs + + po4a/dgit_1 + po4a/dgit-downstream-dsc_7 + po4a/dgit-sponshorship_7 + po4a/dgit_7 + + LOW + + po4a/dgit-maint-* } For work within the Debian project + po4a/dgit-nmu-simple_7 } (where one needs good English anyway) + + po4a/git-debrebase_* Currently low priority but this will change + + +Translation organisation +------------------------ + + po/messages.pot all messages from both dgit and git-debrebase + po/LANG.po translations of those + po/mo output directory, do not look here + + po4a/MAN_S.pot paragraphs from manpage MAN in section S + po4a/MAN_S.LANG.po translation of manpage MAN(S) into LANG + po4a/po4a.cfg config file for po4a + po4a/LANG.preview preview for you, see below + po4a/translated/ output directory, do not look here + + +Note on git-debrebase +--------------------- + +git-debrebase has a fairly complex underlying model, which is defined +in git-debrebase(5). + +It is importnt when translating both documents and messages for +git-derebase, that consistent translations are used for the words +defined in `TERMINOLOGY' and `BRANCH CONTENTS'. + +You may want to start by reading git-debrebase(5). + +When translating git-debrebaase(5) itself, please add the English term +after the definining use of each word. For example + Your-word-for-pseudomerge (Pseudomerge) + translation of the definition +This will be useful because some of these words appear in +necessarily-untranslated but user-visible protocol elements +(eg sometimes in annotations in autogenerated git commit messages) + + +To start translating +-------------------- + +In po/ + + 1. run + make LANGUAGE.po + 2. edit LANGUAGE.po to add translations. + +In po4a/ + + 1. edit po4a.cfg to add your language to [po4a_langs] + 2. then run + po4a po4a.cfg + 3. edit each MANPAGE_SECTION.LANG.po to add translations. + + +Important commands for translators +---------------------------------- + +In po/ + + make LANGUAGE.po Creates or updates messages.pot and LANGUAGE.po. + + make pofiles Updates messages.pot from all the sources, + with new messages, and merges them into + all the language-specific .po files + + make check Updates everything and then checks everything, + printing translation statistics. -Translation organisation: +In po4a/ - po/messages.pot all messages from both dgit and git-debrebase - po/LANG.po translations of those - po/mo output directory, do not look here + po4a po4a.cfg Updates all pot and po files - po4a/ documentation (TBD) + make preview.LANG Makes a directory preview.LANG containing + translated and compiled manpages which can + be previewed with `man -l', and prints a + list of appropriate `man -l' commands. + (Requires `tcl' to be installed.) -Important make targets for translators. -NB all of these are after "cd po/". - make .po Create .po so you can start translating, - or update messages.pot .po. +Committing and contributing your translation +-------------------------------------------- - make all-po Updates messages.pot from all the sources, - with new messages, and merges them into - all the language-specific .po files +When you're done you'll need to commit the changes you have made to +your language's po files. If you started a new translation, don't +forget to `git add' your new files ! - make check Update everything and then check everything - and print translation statistics. +The easiest way to contribute your translation is probably for you to +file a Merge Request on Sala: + https://salsa.debian.org/dgit-team/dgit -The en_US translation is slightly special. It is used for testing the -translation machinery, and since the source native language is en_GB, -there is not much other need for the en_US translation. +Contributions via the Debian Bug Tracking System are also +welcome.