home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / biz / videomaxe-4.33.lha / VideoMaxe / catalogs / Translaters.readme next >
Text File  |  1993-09-15  |  4KB  |  130 lines
  1.  
  2.  
  3.             INFORMATION FOR TRANSLATERS
  4.  
  5.  
  6.  
  7. Preface
  8. -------
  9.  
  10. There are five basic points on style suggested in the
  11. CatComp documentation:
  12.  
  13.   1.List all names in capital letters. This will make it clear they are
  14.     constants as this is the convention used in all Amiga include files.
  15.  
  16.   2.Prefix each name with the string MSG_. This will make it clear to the
  17.     programmer that a given constant is in fact a string ID value.
  18.  
  19.   3.Append the string _GAD to strings that are used for gadget labels.
  20.  
  21.   4.Append the string _MENU to strings that are used for menu titles. For
  22.     example, MSG_EDIT_MENU.
  23.  
  24.   5.Expand the path leading to a menu item when specifying strings that are
  25.     used for menu items. For example, for the Cut item in the Edit menu
  26.     would be written as MSG_EDIT_CUT.
  27.  
  28. I will NOT regard these rules (except the second) as they are limiting the
  29. use of a string and one has to use more texts than actually needed. I admit
  30. that for a consequent use of menu & gadget shortcuts the above mentioned
  31. rules are absolutely necessary. But I will not use catalog defined
  32. shortcuts.
  33.  
  34. For my purpose, I have categorized strings in the following six categories:
  35.  
  36.  
  37. Text Categories
  38. ---------------
  39.  
  40. (1) _C_ommands    : Verbs or texts describing an action to be done
  41. (2) _N_ames    : Pronouns or texts describing an object
  42. (3) _Q_estions    : Questions
  43. (4) _E_Errors    : Texts that describe why an error has occured
  44. (5) _A_djectives: Adjectives or texts that describe something
  45. (6) _T_exts    : Texts that can`t be categorized into (1)-(5)
  46.  
  47.  
  48. The first character of the name of each category - seperated from the other
  49. text by underlines (_) - will appear in each string id, indicating the
  50. string`s category. For example, `MSG_N_Title` is the id for a string of
  51. the category _N_ames.
  52.  
  53.  
  54. EBNF of a string id
  55. -------------------
  56.  
  57. StringID    = "MSG_" Category "_" Text [Appendix]
  58. Category    = "C"|"N"|"Q"|"E"|"A"|"T"
  59. Text        = {"a"|"A"|...|"z"|"Z"}
  60.  
  61.  
  62. Category guidelines
  63. -------------------
  64.  
  65. (1) Command    : Begin the text with a big character, end it without a
  66.           punctuation mark. E.g. "Edit" or "Copy title"
  67. (2) Name    : Begin the text with a big character, end it without a
  68.           punctuation mark. E.g. "Title" or "Spool information"
  69. (3) Question    : Begin the text with a big character, end it with a
  70.           question mark. E.g. "Delete changed project?"
  71. (4) Error    : Begin the text with a big character, end it with an
  72.           exclamation mark. E.g. "Length is too big!"
  73. (5) Adjective    : Begin the text with a small character, end it without a
  74.           punctuation mark. E.g. "small" or "verbose"
  75. (6) Text    : Choose a text you think fulfils its purpose best.
  76.  
  77.  
  78. CT-Head
  79. -------
  80.  
  81.  Starting translation, a head will be given (in your VideoMaxe.ct file)
  82. that looks as follows:
  83.  
  84. ## version $VER: VideoMaxe.catalog <major_version>.<minor_version> (<date>)
  85. ## language <the_language_you_think_to_conquer>
  86. ## codeset 0
  87.  
  88. LEAVE ALL VALUES AS THEY ARE, except:
  89.  
  90. <minor_version>: A two-digits-number that you can use freely to label your
  91.                  different versions.
  92. <date>: Any date string that should include the date of your <minor_version>.
  93.  
  94. You may certainly add any other texts you think are suitable in comment lines
  95. (lines starting with a semikolon).
  96.  
  97. New translation
  98. ---------------
  99.  
  100.  Use the CT-File in the "blank" directory.
  101.  
  102. Updating
  103. --------
  104.  
  105.  An VideoMaxe.ct file has to be updated if the VideoMaxe.cd file changes.
  106. For minor changes, I will try to do the updating myself, otherwise I will
  107. give you an updated version of your CT-File, and you have to fill in the
  108. new/missing strings.
  109.  
  110.  
  111. Very near to the end of this text
  112. ---------------------------------
  113.  
  114. That`s it for now.
  115.  
  116. If you really want to do a translation, better contact me first to make
  117. sure there is no translator for that language yet. Use the CT-File
  118. in the `blank' directory as template - you have to replace all strings
  119. starting with a "(*) ".
  120. See my address(es) in the documentation.
  121.  
  122.  
  123. The end of this text
  124. --------------------
  125.  
  126. At this point, this text unfortunately ends.
  127.  
  128.  
  129. Stephan, 26 Aug 1993
  130.