home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / OPLKIT14.ZIP / OPLKIT.DOC < prev    next >
Encoding:
Text File  |  1991-10-26  |  5.9 KB  |  166 lines
  1.                            OPUS LANGUAGE KIT
  2.                        for Opus CBCS 1.1x & 1.7x
  3.                               version 1.4
  4.                                by Blagi
  5.                          Copyright Blagi, 1991
  6.                        Released to Public Domain.
  7.  
  8.  
  9.  OPUS CBCS LANGUAGE KIT consist of following files:
  10.  
  11.       USL2OLT.EXE         OPUS .USL to .OLT ASCII file
  12.       OLT2USL.EXE         .OLT ASCII file to OPUS .USL
  13.       OPLKIT.DOC          Description of OPUS Language Kit (this file)
  14.       OPLKIT.REV          Revision history
  15.  
  16.  archived into OPLKITxx.ZIP.
  17.  
  18.  The purpose of OPUS LANGUAGE KIT  is to help in translating .USL  (OPUS
  19.  CBCS User Language with messages).
  20.  
  21.  USL2OLT.EXE converts .USL file into ASCII file with extension .OLT  (as
  22.  OPUS Language  Translation).   You can  edit this  file with some plain
  23.  ASCII editor and then convert it back to .USL file with OLT2USL.EXE.
  24.  
  25.  Format of the .OLT  file is similar to  format of the .OEC  files, e.g.
  26.  there are some keywords in square brackets([]) that are translation  of
  27.  Opus Embedded Commands which are used in .USL file.
  28.  
  29.  The following Keywords are recognized:
  30.  
  31.  Keyword          Ctrl key   Hexadecimal    Description
  32.  -------------------------------------------------------------------------
  33.  [bell]              ^G        x07          Ring the caller' bell
  34.  [bs]                ^H        x08          Backspace
  35.  [tab]               ^I        x09          Tab
  36.  [lf]                ^J        x0a          Line feed
  37.  [cls]               ^L        x0c          Clear screen
  38.  [cr]                ^M        x0d          Carriage return
  39.  [can]               ^X        x18          Cancel
  40.  [esc]               ^[        x1b          Escape for ANSI/VT-100 seqence
  41.  [sp]                          x20          Space on the end of line
  42.  
  43.  --- AVATAR Color codes:
  44.  
  45.  [black]             ^V^A^@    x16,x01,x00
  46.  [blue]              ^V^A^A    x16,x01,x01
  47.  [green]             ^V^A^B    x16,x01,x02
  48.  [cyan]              ^V^A^C    x16,x01,x03
  49.  [red]               ^V^A^D    x16,x01,x04
  50.  [magenta]           ^V^A^E    x16,x01,x05
  51.  [brown]             ^V^A^F    x16,x01,x06
  52.  [gray]              ^V^A^G    x16,x01,x07
  53.  [darkgray]          ^V^A^H    x16,x01,x08
  54.  [lightblue]         ^V^A^I    x16,x01,x09
  55.  [lightgreen]        ^V^A^J    x16,x01,x10
  56.  [lightcyan]         ^V^A^K    x16,x01,x11
  57.  [lightred]          ^V^A^L    x16,x01,x12
  58.  [lightmagenta]      ^V^A^M    x16,x01,x13
  59.  [yellow]            ^V^A^N    x16,x01,x14
  60.  [white]             ^V^A^O    x16,x01,x15
  61.  
  62.  [blink]             ^V^B      x16,x02      Blinking
  63.  [cleol]             ^V^G      x16,x07      Clear to end of line
  64.  
  65.  There are also two special keywords:
  66.  
  67.  For repeating chars:
  68.  
  69.     [repeat]            ^Y        x19          Repeat one char
  70.  
  71.     The full format is:
  72.        [repeat][xxx][nn] ,
  73.        where xxx is ASCII decimal code, and nn is number of repetition.
  74.  
  75.  For combination foregraund-background colours, the format is:
  76.        [FG-color on BG-color]
  77.     e.g:  [yellow on black]
  78.  
  79.  Left square bracket used in messages must be preeceded with left square
  80.  bracket.  E.g.   "More[Y,n]" in  .USL is translated  to "More[[Y,n]" in
  81.  .OLT file.  Same  rule must be followed  in adding left square  bracket
  82.  into .OLT file.
  83.  
  84.  First record in .OLT file has a following format:
  85.     [V0000]v n
  86.  where: v       is a version number of .USL file (e.g. 1 for Opus 1.1x, and
  87.                  2 for Opus 1.7x
  88.         n       is number of messages in .USL file
  89.         [V0000] is a constant
  90.  
  91.  Don't change this record.   If you have  to change it when  moving .OLT
  92.  file from one  version to another  do it carefully.   If the  .USL file
  93.  have wrong version number Opus will report LanguageERR.
  94.  
  95.  Preceding  every  message  in  .OLT  file  there  is a record number in
  96.  format:
  97.     [Nxxxx]
  98.     where  xxxx is  a decimal  number with leading zeros.
  99.  
  100.  For messages that points to xFFFF in .USL file, the contents of  record
  101.  (line) is the message number only.
  102.  
  103.  This version  of OPUS  Language Kit  is for  OPUS CBCS  v.1.1x &  1.7x.
  104.  Unlike previous versions  of Opus Language  Kit number of  messages are
  105.  not hard wired into program so it can support next releases of OPUS.
  106.  
  107.  
  108.  USL2OLT.EXE
  109.  -----------
  110.  
  111.  This program converts  .USL file into  .OLT file.   It is started  with
  112.  following format:
  113.  
  114.     USL2OLT <uslfile> [oltfile]
  115.  
  116.  If no extension is specified for <uslfile> .USL is assumed.
  117.  If no extension is specified for [oltfile] .OLT is assumed.
  118.  If [oltfile] is omitted, <uslfile> path name with .OLT extension is
  119.  assumed.
  120.  
  121.  OLT2USL.EXE
  122.  -----------
  123.  
  124.  This program converts  .OLT file into  .USL file.   It is started  with
  125.  following format:
  126.  
  127.     OLT2USL <oltfile> [uslfile]
  128.  
  129.  If no extension is specified for <oltfile> .OLT is assumed.
  130.  If no extension is specified for [uslfile] .USL is assumed.
  131.  If [uslfile] is omitted, <oltfile> path name with .USL extension is
  132.  assumed.
  133.  
  134.  Please  keep  the  original  version  of  .USL file because OLT2USL may
  135.  override it.
  136.  
  137.  
  138.  THANKS
  139.  ------
  140.  
  141.  Thanks to Fred Vlinkervleugel (2:281/603@fidonet) for using OPLKIT  and
  142.  suggestion about space-on-the-end-of-line problem.
  143.  
  144.  Thanks to Bengt Erik Soderstrom (2:204/410@fidonet) for discovering bug
  145.  in handling ASCII chars greater then 128.
  146.  
  147.  NOTE
  148.  ----
  149.  
  150.  The structure of  .USL files is  not described in  Opus.h file
  151.  "Because the language  files directly affect  the "friendly and  legal"
  152.  aspects  of  Opus,  so  to  make  it  slightly  more  difficult for the
  153.  unfriendly and illegal we don't explain how it works.  "
  154.  [as said Doug Boone -  member of Opus 1.20 development team].
  155.  
  156.  Any question and suggestion are welcomed and can be Netmailed to:
  157.  
  158.                             Zdravko Blagdan
  159.                             JUBAS BBS 2:2/900@fidonet
  160.                             ++38-58-561-043
  161.                             Split, Yugoslavia
  162.  
  163.  or posted to MEADOW echo.
  164.  
  165.  In Split, 02. Oct 1991.
  166.