home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 106 / af106a.adf / archives / serious.lzx / ViNCEd / Localize! / ReadMe < prev    next >
Text File  |  1997-11-19  |  6KB  |  138 lines
  1. ******************************************************************************
  2. ** ViNCEd localization package                                              **
  3. **                                                                          **
  4. ** © 1990-1997 THOR-Software                                                **
  5. **      Version 40.50                                                       **
  6. **                                                                          **
  7. ** All the restrictions of the THOR-Software licence apply to this package  **
  8. ** read the VNC.guide to find out more about this licence                   **
  9. ******************************************************************************
  10.  
  11. This is the localization package for THOR's ViNCEd shell editor. 
  12.  
  13. Since at the time of writing ViNCEd, I had no access to the commodore 
  14. standard localization tools, ViNCEd's locale is setup by a private program,
  15. called CreateCatalog. There are many pro's and con's about this program,
  16. and propably even more con's than pro's, but at least it is freely dis-
  17. tributable (only the licence apply), and it is sometimes more flexible
  18. than the standard tool. Besides this program, which can be found in the
  19. "bin" foulder, an assembler is needed. The prepared scripts are setup for
  20. Frank Wille's PhxAss, which is also freely available at the AmiNet, but
  21. is not included in this package cause my licence does not apply to it.
  22. However, each other assembler will work as well, with some minimal changes.
  23. Copy it to the "bin" folder, where CreateCatalog is located.
  24.  
  25. Besides the assembler, no assembly language knowledge is needed, all you
  26. need to do is to change some strings in the files.
  27.  
  28.  
  29. A word about the CreateCatalog tool: It usually takes only one input file,
  30. the .construct file. This file has two purposes and can be read thanks to
  31. the unique CreateCatalog syntax by both the shell and CreateCatalog itself.
  32. First, it is a shell script that has to be executed with the Execute command
  33. to build the complete catalog. Second, it acts as a command file for
  34. CreateCatalog, which may contain the localized strings, plus some comments
  35. plus links to files with more strings. So don't worry if something seems
  36. to miss: The .construct file is good enough and contains all information.
  37.  
  38.  
  39. Here's a step-by-step instruction how to localize ViNCEd:
  40.  
  41.  
  42. 1) Download the PhxAss assembler package from AmiNet. Only one file from
  43. this distribution is needed, namely the "PhxAss" command. Place it in the
  44. bin folder of this directory, near the CreateCatalog tool.
  45.  
  46.  
  47. 2) Add an assign VL: to this drawer. This is not needed permanently, only for
  48. the time of localization.
  49.  
  50. >assign VL: ""
  51.  
  52.  
  53.  
  54. 3) Edit the "sys.construct" file, follow the instructions there. You need to change
  55. the name of the language, and some requester texts. The english versions of the
  56. strings are present there as well. It contains one empty string - leave it
  57. alone and DON'T REMOVE it.
  58.  
  59.  
  60. 4) Edit the "sys1.asm" file. This one contains a structure encoded in 
  61. assembly language which is used by the ViNCEd menu builder. Only the strings
  62. between double quotes "..." need to be translated there. Don't forget to
  63. include your name and the language at the marked position, since people want
  64. to know who did the work. Also read the instructions in this file.
  65.  
  66. 5) Now build the locale. Only one command should suffer:
  67.  
  68. >Execute VL:sys.construct
  69.  
  70. The complete locale database will be put into your RAM: drawer and will be
  71. called "VNC.sys.catalog". Create a subdirectory "VNC" in your catalog
  72. drawer "LOCALE:CATALOGS/<language>" and copy this file there.
  73.  
  74. 6) Now edit the "prefs.construct" file. It contains all strings for the
  75. prefs editor "SetVNC". This time, no assembler intermediate files are
  76. needed, since every string is in the constructor. The only thing worth
  77. remembering is:
  78.  
  79. The first character of a line determinates the meaning of a line:
  80. A blank (or TAB) or a semicolon ";" are used to introduce a comment line.
  81. These lines are ingored by CreateCatalog (and form the shell script).
  82. A ' (apostrophe) is an actual string that is put into the locate database.
  83. Only these lines must be translated.
  84. A # (hash mark) line sets the string counter to a specific value. Do not
  85. edit these lines.
  86.  
  87. Since all the catalog creators are taken from the german localization, the
  88. current strings in the locale database are german. Don't mind about this,
  89. I always added the english original version of the string ON TOP of the
  90. german version, plus some information when this string is used.
  91.  
  92.  
  93. 7) Build the catalog by one command:
  94.  
  95. >Execute VL:prefs.construct
  96.  
  97.  
  98. A file "VNC.prefs.catalog" should appear in the RAM drawer.
  99.  
  100.  
  101. 8) Copy this file to LOCALE:Catalogs/<language>/VNC.
  102.  
  103.  
  104. 9) Setup the language with the prefs editor "Locale" of the workbench.
  105. Open a ViNCEd window and open the prefs editor. Check if your localization
  106. looks properly: Check for example if some of your strings are too long
  107. and leak over the boundaries of the gadgets. Usually the size of the menu
  108. is adapted from the strings in it, however a very big menu may look ugly
  109. again. It might happen that your first try is not very con-vince-ing, so
  110. write down the strings that caused the problems and correct them.
  111. Repeat steps 3 to 12 until the result is acceptable.
  112.  
  113.  
  114. 10) If you like, update the installer script of the ViNCEd package.
  115. If you don't know how to do this, just translate the english or german
  116. strings in there, and send me the translated version.
  117.  
  118.  
  119. 11) If you have still plenty of time (I don't expect this do be done ;-)
  120. translate the guide. This is maybe a lot of work, two weeks of typing...
  121. ;-) Well, as I said, unless you've plenty of time....
  122.  
  123.  
  124. 12) If you're finally happy with your translations, don't forget to mail
  125. them to my address so I can put them into the next release of ViNCEd. Here's
  126. my mail address:
  127.  
  128.         thor@math.tu-berlin.de
  129.  
  130. Please send the locale databases (plus the installer, plus the guide) as
  131. an uuencoded lha archive to this address. If you have trouble with
  132. CreateCatalog, please let me know, too.
  133.  
  134.  
  135. Thanks a lot for your work,
  136.         Thomas
  137.  
  138.