po/README

   1 NOTES FOR TRANSLATORS
   2 =====================
   3
   4 Introduction
   5 ------------
   6
   7 The dgit source package contains dgit and git-debrebase.
   8 These are useful for a variety of different users and in different
   9 situations.  So there are various documents aimed at various users.
  10
  11 * dgit and git-debrebase both support message translation.
  12
  13 * Documentation translation is handled via po4a, in the po4a
  14   directory.  The documeents are all manpages.
  15
  16 * git-debrebase is currently mostly useful within the Debian project,
  17   but this will change and its document translations will then be more
  18   important.
  19
  20 The en_US message translation is slightly special.  It is used for
  21 testing the translation machinery, and since the source native
  22 language is en_GB, there is not much other need for the en_US
  23 translation.
  24
  25
  26 Translatation priorities
  27 ------------------------
  28
  29   HIGH
  30
  31     po4a/dgit-user_1.pot    How to use dgit to as a downstream or user
  32
  33   MEDIUM
  34
  35     po/messages.pot         All the messages for both programs
  36
  37     po4a/dgit_1
  38     po4a/dgit-downstream-dsc_7
  39     po4a/dgit-sponshorship_7
  40     po4a/dgit_7
  41
  42   LOW
  43
  44     po4a/dgit-maint-*       } For work within the Debian project
  45     po4a/dgit-nmu-simple_7  }  (where one needs good English anyway)
  46
  47     po4a/git-debrebase_*    Currently low priority but this will change
  48
  49
  50 Translation organisation
  51 ------------------------
  52
  53   po/messages.pot      all messages from both dgit and git-debrebase
  54   po/LANG.po           translations of those
  55   po/mo                output directory, do not look here
  56
  57   po4a/MAN_S.pot       paragraphs from manpage MAN in section S
  58   po4a/MAN_S.LANG.po   translation of manpage MAN(S) into LANG
  59   po4a/po4a.cfg        config file for po4a
  60   po4a/LANG.preview    preview for you, see below
  61   po4a/translated/     output directory, do not look here
  62
  63
  64 Note on git-debrebase
  65 ---------------------
  66
  67 git-debrebase has a fairly complex underlying model, which is defined
  68 in git-debrebase(5).
  69
  70 It is importnt when translating both documents and messages for
  71 git-derebase, that consistent translations are used for the words
  72 defined in `TERMINOLOGY' and `BRANCH CONTENTS'.
  73
  74 You may want to start by reading git-debrebase(5).
  75
  76 When translating git-debrebaase(5) itself, please add the English term
  77 after the definining use of each word.  For example
  78    Your-word-for-pseudomerge (Pseudomerge)
  79        translation of the definition
  80 This will be useful because some of these words appear in
  81 necessarily-untranslated but user-visible protocol elements
  82 (eg sometimes in annotations in autogenerated git commit messages)
  83
  84
  85 To start translating
  86 --------------------
  87
  88 In po/
  89
  90   1. run
  91       make LANGUAGE.po
  92   2. edit LANGUAGE.po to add translations.
  93
  94 In po4a/
  95
  96   1. edit po4a.cfg to add your language to [po4a_langs]
  97   2. then run
  98      po4a po4a.cfg
  99   3. edit each MANPAGE_SECTION.LANG.po to add translations.
 100
 101
 102 Important commands for translators
 103 ----------------------------------
 104
 105 In po/
 106
 107   make LANGUAGE.po     Creates or updates messages.pot and LANGUAGE.po.
 108
 109   make pofiles         Updates messages.pot from all the sources,
 110                        with new messages, and merges them into
 111                        all the language-specific .po files
 112
 113   make check           Updates everything and then checks everything,
 114                        printing translation statistics.
 115
 116 In po4a/
 117
 118   po4a po4a.cfg        Updates all pot and po files
 119
 120   make preview.LANG    Makes a directory preview.LANG containing
 121                        translated and compiled manpages which can
 122                        be previewed with `man -l', and prints a
 123                        list of appropriate `man -l' commands.