Catalogs/HowToTranslate.doc

   1
   2 How to make a new catalog for XModule
   3 *************************************
   4
   5  This file contains all the strings used in XModule.  Lines beginning with
   6 a semicolon (;) are comments and are ignored by the catalog generator.
   7 Every string is made up two lines:
   8
   9     MSG_READING_TYPE_MODULE_CHN (//)
  10     Reading %s module with %ld tracks...
  11
  12  The first line is a symbol which identifies its meaning inside XModule.
  13 You do not need to modify it.  The characters "(//)" are required by the
  14 catalog generator and shouldn't be modified.
  15
  16  The second line is the message itself.  You should insert the
  17 translation in your own language here.  In this example, the sequences
  18 "%s" and "%d" have a special meaning.  At run time, they will be replaced
  19 by a value, let's say "TakeTracker" and "12", so that the resulting
  20 string would become "Reading TakeTracker module with 12 tracks...".
  21
  22  Your language might require a different ordering of the % symbols in the
  23 sentence, for instance "12 tracks TakeTracker module...".  In this case,
  24 you can translate the string as follows:
  25
  26     %2$ld tracks %1$s module...
  27
  28  The template is %<position>$<sequence>, where <position> is the original
  29 position of the % command, <sequence> is the original command sequence.
  30
  31  For those amongst you who are not programmers, the meaning of some strings
  32 may be obscure.  For instance, you might find a string like "Ok|Cancel",
  33 which describes the possible answers to a requesters.  You should leave the
  34 '|' character alone and avoid inserting additional spaces before and after
  35 it.
  36
  37  Gadget labels have a "_GAD" postfix, while menu lables end with "_MEN".
  38 Some gadget labels will have underscore characters ('_') before their key
  39 shortcut.  When you translate these labels, you shoud try to keep the same
  40 key (ie: "_Good Morning" -> "Buon _Giorno").  If it isn't possible,
  41 choose another meaningful letter, but avoid using the same key for two
  42 different gadgets in the same window, otherwise the user will get confused.
  43
  44  To help you with the translation, the template catalog "Empty.ct" is
  45 provided.  This file has blank lines where the translated strings should
  46 be inserted, followed by comment lines with the original english string.
  47 Just rename it to <language>.ct and fill in all the empty lines.
  48
  49  When you are done with the translation, use a catalog generator like
  50 FlexCat, KitKat or CatComp to make the xxx.catalog file.  Then, test the
  51 new catalog with XModule and check that every message is correct.  To make
  52 a catalog with FlexCat, you can use the following command line:
  53
  54     FlexCat Catalogs/XModule.cd Catalogs/<language>.ct
  55         CATALOG=Catalogs/<language>/XModule.catalog
  56
  57  Each time a new version of XModule gets released, the old catalogs will
  58 probably have to be updated to include all the new strings.  In this case,
  59 I'll send you the new catalog translation file and ask you to update it.
  60 Of course, you are free to refuse if you do not want to do it, but, please,
  61 let me know this in time, so I can look around for another translator.