home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RATE10.ZIP / DOC.ZIP / T2A.DOC < prev    next >
Encoding:
Text File  |  1993-07-25  |  8.8 KB  |  201 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.        ▒▒▒▒▒▒▒▒▄    ▒▒▒▒▒▒▄    ▒▒▒▒▒▒▄
  8.    ─────▀▀▒▒█▀▀▀─────▀▀▀▒▒█────▒▒█▀▒▒█────
  9.    ───────▒▒█───────▒▒▒▒▒▒█────▒▒▒▒▒▒█──────Version 3.0───
  10.    ───────▒▒█───────▒▒█▀▀▀▀────▒▒█▀▒▒█────
  11.           ▒▒█       ▒▒▒▒▒▒▄    ▒▒█ ▒▒█
  12.            ▀▀        ▀▀▀▀▀▀     ▀▀  ▀▀
  13.            Text      To         Ansi/Avatar/Ascii
  14.  
  15.  
  16.                               Screen  Compiler
  17.                                     For
  18.                          The RaLin Ansi Text Editor
  19.  
  20.  
  21.            (C)Copyright 1992,1993 Rand Nowell, RaLin Enterprises
  22.                         "Putting Bits Together" (tm)
  23.  
  24.                           - ALL RIGHTS RESERVED -
  25.  
  26.  
  27.                  P R O G R A M    D O C U M E N T A T I O N
  28.  
  29.                                  July 1993
  30.  
  31.  
  32.  
  33.  
  34.  
  35. T2A.DOC             The Text to Ansi/Avatar/Ascii Compiler..        Page   1
  36.  
  37. ┌─────────────────────────────────────────────────────────────────────────────┐
  38. │▒▒▒ LEGAL STUFF ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  39. └─────────────────────────────────────────────────────────────────────────────┘
  40.  
  41.   All Copyright, License and Legal stuff has been put in a separate file,
  42.   please read LEGAL.DOC
  43.  
  44. ┌─────────────────────────────────────────────────────────────────────────────┐
  45. │▒▒▒ SYSTEM REQUIREMENTS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  46. └─────────────────────────────────────────────────────────────────────────────┘
  47.  
  48.   T2A  will  run on a XT,AT, PC compatible system. It is  designed  for  a 
  49.   color monitor, it will function on a monochrome, but no effort has  been 
  50.   made in making the display mono compatible.
  51.  
  52.   Follow  the  memory requirements for RATE and RCC, though it  uses  much 
  53.   less memory, you will most often be running from RATE or RCC.
  54.  
  55. ┌─────────────────────────────────────────────────────────────────────────────┐
  56. │▒▒▒ OVERVIEW ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  57. └─────────────────────────────────────────────────────────────────────────────┘
  58.  
  59.   T2A is the screen compiler which reads the "Template Files" created with 
  60.   the Ansi Text Editor, RATE, and then generates a ANSI, AVATAR and  ASCII 
  61.   version  of  the file.  These screens can then be used for  DOS  or  BBS 
  62.   screens.   When run from the command line, T2A will compile one  screen. 
  63.   When run from the Command Center (RCC) you can compile multiple screens.
  64.  
  65. ┌─────────────────────────────────────────────────────────────────────────────┐
  66. │▒▒▒ RUNNING T2A ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  67. └─────────────────────────────────────────────────────────────────────────────┘
  68.  
  69.   If  you are compiling an editor template file, with the extension  .T2A, 
  70.   you  need only supply the filename with no extension. If perchance,  the 
  71.   template  file  has  a different extension, you must give  it  with  the 
  72.   filename.  
  73.   When  no extension is given, T2A searches for a file of the  given  name 
  74.   with the extension .T2A, if not found, an error message is displayed.
  75.  
  76.   Example:  To compile the screen(s) from the template file  MYSCREEN.T2A, 
  77.   you  would enter T2A MYSCREEN and it will create the ANSI,AVATAR,  ASCII 
  78.   screens.   To  compile  the  file  MYSCREEN.TXT  you  would  enter   T2A 
  79.   MYSCREEN.TXT.   See PROGRAM SCREEN below....
  80.  
  81. ┌─────────────────────────────────────────────────────────────────────────────┐
  82. │▒▒▒ OUTPUT FILE(S) ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  83. └─────────────────────────────────────────────────────────────────────────────┘
  84.  
  85.   You  may specify a name for the generated screens, this is optional,  if 
  86.   you do not, the screen files created will be given the same name as  the 
  87.   Template File, with the proper extensions.
  88.   Typing   T2A  MYSCREEN   will  result  in  MYSCREEN.ANS,   MYSCREEN.AVT, 
  89.   MYSCREEN.ASC
  90.   Typing  T2A  MYSCREEN YORSCRN will result in  YORSCRN.ANS,  YORSCRN.AVT, 
  91.   YORSCRN.ASC.
  92.  
  93.               Compile RATE templates for RemoteAccess Screens
  94.  
  95.  
  96. T2A.DOC             The Text to Ansi/Avatar/Ascii Compiler..        Page  2
  97.  
  98.  
  99. ┌─────────────────────────────────────────────────────────────────────────────┐
  100. │▒▒▒ A GOOD HABIT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  101. └─────────────────────────────────────────────────────────────────────────────┘
  102.  
  103.   As  the  compiler,  editor, and the command center  all  work  with  the 
  104.   default extension of .T2A, it is recommended that you use that extension 
  105.   for  all template files. And name it to the name you want your  compiled 
  106.   screens to have.
  107.  
  108. ┌─────────────────────────────────────────────────────────────────────────────┐
  109. │▒▒▒ COMPILER SWITCHES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  110. └─────────────────────────────────────────────────────────────────────────────┘
  111.  
  112.   There are three command line switches that T2A recognizes, they must  be 
  113.   proceeded  with  the minus (-) character, and must be separated  by  one 
  114.   space. They may be UPPER or lower case. 
  115.  
  116.   They Are:
  117.   -A      : Do NOT create the Avatar screen.
  118.   -I      : Do NOT create the ASCII screen.
  119.   -V      : Do NOT prompt to view after compiling.
  120.  
  121.   By  default,  all  screens are generated, these switches  allow  you  to 
  122.   "eliminate" two screens. The ANSI version is ALWAYS created.
  123.  
  124.   All three switches may be used, in any order.
  125.  
  126.   T2A ? will display a help screen.
  127.  
  128.   Upon completion of compiling the screen, T2A will ask if you would  like 
  129.   to view the Ansi screen with T2AVIEW. You answer with 'Y' or 'N'.
  130.   If you don't want to be bothered with this, use the -V switch. 
  131.  
  132. ┌─────────────────────────────────────────────────────────────────────────────┐
  133. │▒▒▒ RESERVED CHARACTERS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  134. └─────────────────────────────────────────────────────────────────────────────┘
  135.  
  136.   Several characters are considered "reserved" Compiler Codes, These are:
  137.   (~) The tilde character          : Clear Screen
  138.   (@) The "at" sign                : Start and End of a RA code
  139.   (%) The percent sign             : Start of a color code
  140.   (;) The semi colon               : Filter character
  141.  
  142.   Unless properly handled, using these characters above in your text body, 
  143.   will either generate unwanted results, or cause an error.
  144.  
  145.   They  "CAN" be used, by enclosing them in the FILTER character (;),  the 
  146.   semi-colon.  If you wanted to use the percent sign, such as in 
  147.   "Our DOOR area reconstruction is 90% complete"  you would type 90% as
  148.   90;%; ..... the semicolon tells T2A that all characters between the two, 
  149.   are not to be interpreted as compiler codes.
  150.  
  151.   The  only  downside to this, is you cannot use the  semi-colon  in  your 
  152.   text.  This should not be a problem in most cases.
  153.  
  154.               Compile RATE templates for RemoteAccess Screens
  155.  
  156.  
  157. T2A.DOC             The Text to Ansi/Avatar/Ascii Compiler..        Page  3
  158.  
  159.  
  160.   With the addition of the Ansi Text Editor, the compiler codes have been 
  161.   drastically changed from earlier versions of the T2A compiler.  
  162.   The  only  one that has remained the same, is the tilde  (~)  while  not 
  163.   inserted  into  the text by the editor, it is still  recognized  by  the 
  164.   compiler. This is the only compiler "reserved" character you do not have 
  165.   to change, if you have templates for an older version of T2A.
  166.  
  167. ┌─────────────────────────────────────────────────────────────────────────────┐
  168. │▒▒▒ PROGRAM SCREEN ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  169. └─────────────────────────────────────────────────────────────────────────────┘
  170.  
  171.   When  T2A  runs,  first you will see the  program  title  and  copyright 
  172.   notice.
  173.   Below,  T2A shows the name of the file being compiled, and to the  right 
  174.   of that, the name(s) of the screens being created.
  175.   It also displays a running count of the lines being read, processed  and 
  176.   compiled.
  177.  
  178.   After  compiling, T2A will prompt you, would you like to view  the  ANSI 
  179.   version  of the screen?  Answer (Y)es or (N)o.  IF you have used the  -V 
  180.   switch, this prompt will not appear.
  181.  
  182.   That's about it, a very simple yet powerful program.
  183.  
  184. ┌─────────────────────────────────────────────────────────────────────────────┐
  185. │▒▒▒ CONTACT AND SUPPORT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  186. └─────────────────────────────────────────────────────────────────────────────┘
  187.  
  188.   Please see SUPPORT.DOC
  189. ┌─────────────────────────────────────────────────────────────────────────────┐
  190. │▒▒▒ REGISTRATION ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  191. └─────────────────────────────────────────────────────────────────────────────┘
  192.  
  193.   The compiler is the same Registered or Unregistered. It's a part of  the 
  194.   RATE  package.  It  becomes  Registered to you  when  you  register  the 
  195.   package.
  196.  
  197.   Please see REGISTER.FRM
  198.  
  199.               Compile RATE templates for RemoteAccess Screens
  200.  
  201.