home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 16 / 16.iso / t / t187 / 1.img / T2A.DOC < prev    next >
Encoding:
Text File  |  1992-12-03  |  8.3 KB  |  202 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                      T2A
  7.                             Text to Ansi Convertor
  8.                                  Version 1.2
  9.  
  10.                         (C)Copyright 1992 Rand Nowell
  11.                               RaLin Enterprises
  12.  
  13.                          "Putting Bits Together" (tm)
  14.  
  15.  
  16.                   P R O G R A M   D O C U M E N T A T I O N
  17.  
  18.  
  19.  
  20.  The Legal Stuff:
  21.  
  22.     This version of T2A is free for Non-Commercial use.
  23.     All versions greater than 1.2 are available only to registered users.
  24.  
  25.     You may distribute this version to whomever you desire, I ask that
  26.     you include all files contained in the archive should you do so.
  27.     I also ask that you distribute the original authenticated ZIP file
  28.     of this program.
  29.  
  30.     The author, Rand Nowell is not obligated to provide future versions of
  31.     this program.
  32.  
  33.     This program has been well tested, and should cause you NO problems,
  34.     But.................
  35.     This program is supplied "as is" , no liability is assumed, no warranties
  36.     expressed or implied. If it breaks, you own all the pieces!
  37.     Registered users do receive some guarentees.
  38.  
  39.  
  40.     Registration brings you an enhanced version. More information is
  41.     contained in this documentation.
  42.  
  43.  What It Does:
  44.  
  45.     T2A takes an ascii file for input, this file must have control and
  46.     color codes inserted into it. T2A will read this file and produce a color
  47.     ANSI file that may be displayed to the screen from DOS or as part of a
  48.     BBS package. In order to view an ANSI difplay file you need either to
  49.     have the ANSI.SYS driver loaded in memory, a program such as A_TYPE by
  50.     Ron Huskies/Intersoft, or display the file with a comm/bbs program that
  51.     has its own internal ansi display code.
  52.     The file may be of any page length!
  53.  
  54.  Where To Put It:
  55.  
  56.     T2A should be stored in a directory that is in your path statement, so
  57.     that it can be called from any directory you wish to work in.
  58.  
  59.  Included Files:
  60.  
  61.     Several files have been included in this package.
  62.  
  63.         T2A.EXE         The Convertor Program
  64.         EXAMPLE.TXT     A Template for an ANSI file
  65.         EXAMPLE.ANS     The finished product from the above TXT file.
  66.         CLRCODE.REF     A printable reference sheet. (T2A ver 1.2)
  67.         ENHANCED.ANS    Sample of output from Registered version
  68.         ENHANCED.TXT    Sample of template file for Registered version
  69.         ENHANCED.ASC    Ascii output from Registered version
  70.         ENHANCED.DIF    Whats different in the enhanced version(s)
  71.         COLORS_E.REF    Copy of the color reference for Rgistered Version.
  72.                         These will NOT work with ver 1.2 correctly.
  73.         T2A.DOC         This file. The documentation.
  74.         REGISTER.FRM    To register for Enhanced T2A & BBS access.
  75.         README.1ST      Need I say more?
  76.  
  77.  
  78.  
  79. How To Use It:
  80.  
  81.      Using T2A is pretty simple!
  82.  
  83.      1. Create the file with your favorite Ascii Editor. Format it the
  84.         way you want it to come out. File listing, letter, help screen etc.
  85.      2. Edit the file, inserting the T2A codes as needed.
  86.      3. Run the file through T2A.
  87.         T2A inputfile.exe outputfile
  88.  
  89.         No extension required for the output file. .ANS will be added by
  90.         T2A. The output file name may be different, and is ALWAYS over-
  91.         written if it exists.
  92.  
  93.      4. View the file, use the file, throw it away.........??
  94.  
  95.  
  96.  
  97.   With T2A you can create an Ansi display file of any length. You are not
  98.   limited to 25 lines as you are with many Ansi editors. You don't have to
  99.   create multiple screens then copy file+file+file to get a helpscreen more
  100.   than 25 lines long.
  101.   T2A will NOT create animated screens. It is simply to allow you to add
  102.   color to an otherwise dull ascii screen.
  103.   BBS bulletins, help screens, long directory listings, these are where T2A
  104.   is a great help.
  105.  
  106.   I originaly wrote T2A for my own use, but it works well so I decided to
  107.   release it. But....I decided to release this version, an early one, free to
  108.   the public for private use. T2A is up to ver 1.5 now, and greatly enhanced!
  109.   But versions past 1.2 will NEVER be released to the general public. The
  110.   only way you can obtain one, is by registering.
  111.  
  112.   Version 1.2 is not crippled or really limited. Its just not as easy to use,
  113.   and there is not as much control as later versions.
  114.   Also, version 1.2 will only create the ANSI file. Later versions create
  115.   both an Ascii and an Ansi version from the template file.
  116.   More on that later.
  117.  
  118.  Building The Template:
  119.  
  120.    After your file has been created with your editor, you need to insert the
  121.    codes. Make sure you have printed out CLRCODE.REF so that you can refer to
  122.    it.
  123.  
  124.    T2A 1.2 has 5 control codes, 16 Foreground color codes, and 7 Background
  125.    color codes.
  126.    The reference sheet explains the control codes, but I will cover one of
  127.    them here. [ % ] the percent sign, is used if the resulting file will be
  128.    displayed within a BBS program such as RA/QBBS. This code will cause the
  129.    BBS program to wait for the user to press the ENTER key. Thus you can
  130.    define your own prompt : Please Hit your ENTER key.....% would print
  131.    the prompt and wait for the enter key to be pressed. Again, this will only
  132.    work with BBS programs that read the Ctl-A character as a wait key.
  133.  
  134.  
  135.    You would, in RemoteAccess, display this file created with T2A under a
  136.    type 5 or 45 Text File Display menu command.
  137.  
  138.  Entering Color Codes:
  139.  
  140.    Color codes are entered by typing the @ and a three digit code. In 1.2 all
  141.    codes are 1 or 2 digits, so you must zero pad the number. So color 1 would
  142.    be @001  color 21 would be @021. In later versions there are some 3 digit
  143.    codes.   Have you got your reference sheet handy?
  144.  
  145.    To make green on black text you would enter @003 just befor the text to
  146.    change, if you want bright green, you would type @011 if you wanted
  147.    Blinking Bright Green you would enter ^@011.
  148.    Now if you wanted Blinking Bright Green on a Blue background, you would
  149.    enter @019 ^ @011 AAAAAABBBBBCCCCCC
  150.           |   |  |    |Text to write
  151.           |   |  Bright Green
  152.           |   Turn on blink
  153.           Green Background
  154.  
  155.    To turn OFF blink and bright colors, and leave the color as green, you
  156.    would type ` (the left apostrophe) which turns off all blink and bold
  157.    attributes.
  158.  
  159.    View the included EXAMPLE files, you will see how the codes are used.
  160.    When you enter the codes, remember that they are not shown on the screen
  161.    when the Ansi file is displayed. So though they may move your formatted
  162.    text, don't adjust it, it will display the same as if you had not entered
  163.    the codes at all.
  164.  
  165.    As you will soon discover, version 1.2 requires quite a bit of coding to
  166.    chage background color, you have to enter a new background color code,
  167.    each time you want it changed, along with the new text color code, if its
  168.    different.  As I said, this is an early version. Read the file
  169.    ENHANCED.DIF to see what the differences are when you register.
  170.  
  171.    If this version does the job well enough for you, great! have at it!
  172.    But the newer versions are really much easier to use, and there are
  173.    other pluses too.
  174.  
  175.    If you would like to register T2A, and receive the enhanced version, with
  176.    a more detailed documentation, plus some handy utilities, fill out and
  177.    mail REGISTER.FRM.
  178.  
  179.  
  180.    I realise that this documentation is somewhat sketchy, but with the
  181.    example files and the reference sheet, you should be able to get moving in
  182.    the right direction pretty quick. After all, this =IS= a FREE copy!
  183.    <BIG GRIN>
  184.  
  185.    The author, Rand Nowell, can be reached for comments, problems,
  186.    suggestions, name calling or what ever via the following:
  187.  
  188.    Phone:       510-651-0253
  189.    BBS:         510-651-0253,,3322
  190.    NetMail:     1:161/710
  191.    Snail Mail:  40728 Sundale Dr. Fremont, Ca. 94538
  192.    CIS:         76124,761
  193.    Genie:       R.NOWELL
  194.  
  195.    CIS and Genie are checked for mail usually once a week.
  196.  
  197.    The commas in the BBS # create a four second pause. You can use whatever
  198.    your modem uses for pause. But aprox 4 seconds is needed to insure our
  199.    shuttle switch receives the code, to allow access to the BBS.
  200.    If you have any problems, call voice, we'll work them out.
  201.  
  202.