home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / drawing / air20.zip / AIR.DOC next >
Text File  |  1993-11-02  |  45KB  |  1,031 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.     ▒▒▒▒▒▒▒▒▄       ▒▒▒▒▄      ▒▒▒▒▒▒▒▒▒▒▄
  8.     ▒▒█▀▀▀▒▒█        ▒▒█▀       ▒▒█▀▀▀▀▒▒█
  9.     ▒▒█   ▒▒█        ▒▒█        ▒▒█    ▒▒█
  10.     ▒▒▒▒▒▒▒▒█        ▒▒█        ▒▒▒▒▒▒▒▒▒█
  11.     ▒▒█▀▀▀▒▒█        ▒▒█        ▒▒█▀▀▒▒█▀▀
  12.     ▒▒█   ▒▒█        ▒▒█        ▒▒█  ▒▒█
  13.    ▒▒▒▒█ ▒▒▒▒█      ▒▒▒▒█      ▒▒▒▒█ ▒▒▒▒█
  14.     ▀▀▀▀  ▀▀▀▀       ▀▀▀▀       ▀▀▀▀  ▀▀▀▀
  15.    Ansi/Avatr/Ascii   In         RIP
  16.  
  17.  
  18.  
  19.                               - Version 2.0 -
  20.              (C)Copyright 1993, Rand Nowell - RaLin Enterprises
  21.                         "Putting Bits Together" (tm)
  22.  
  23.  
  24.                - P R O G R A M   D O C U M E N T A T I O N -
  25.  
  26.                             ( FREEWARE Release!)
  27.  
  28.  
  29.  
  30.  
  31.                               - Manual Index -
  32.  
  33.             Copyright.........................................1
  34.             Distribution......................................1
  35.             Disclaimer......................................1,2
  36.             Version Numbers...................................2
  37.             Overview........................................2,3
  38.             Running AIR.......................................3
  39.               Command Line with parameters..................3,4
  40.               Command Line with "Command File"................5
  41.               Interactive Mode............................5,6,7
  42.             Commands and Colors.............................7,8
  43.               Editing Keys....................................8
  44.               Color Codes.....................................8
  45.             External Lists....................................9
  46.             Format of AIR screens..........................9,10
  47.             Available Frame Templates........................10
  48.             Creating a screen file.....................10,11,12
  49.             Error Levels.....................................13
  50.             Why Register?.................................13,14
  51.             Your Suggestions.................................14
  52.               Submit your screen for use in AIR..............14
  53.             Author Contact................................14,15
  54.             Support..........................................15
  55.             Acknowledgements.................................16
  56.  
  57.  
  58.   
  59. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page   1
  60.  
  61. ┌─────────────────────────────────────────────────────────────────────────────┐
  62. │▒▒▒ COPYRIGHT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  63. └─────────────────────────────────────────────────────────────────────────────┘
  64.  
  65.    AIR, Ansi/Avatar/Ascii In RIP, the program and documentation,
  66.    are not a Public Domain program. It is the
  67.    (C)Copyrighted 1993 work of Rand Nowell dba Ralin Enterprises.
  68.    All rights are reserved. Copying, duplicating, selling or otherwise
  69.    distributing this product except as noted in the Distribution Policy
  70.    below is a violation of Federal Copyright Law.
  71.  
  72.    This version is released as FREEWARE. A Registered version is available,
  73.    with several more options.
  74.  
  75.    Though this copy is FREEWARE, the author maintains all Copyrights to
  76.    code, documentation etc.
  77.  
  78.    If you would like to receive the Registered version, fill out AIR.REG.
  79.  
  80. ┌─────────────────────────────────────────────────────────────────────────────┐
  81. │▒▒▒ DISTRIBUTION ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  82. └─────────────────────────────────────────────────────────────────────────────┘
  83.  
  84.    1. Feel free to distribute the FREEWARE version of this program as
  85.       often as you like to any interested parties. Distribution to
  86.       Electronic Bulletin Boards is encouraged.
  87.    2. Please do not distribute this program without all the original
  88.       related files such as documentation, readme files, registration
  89.       forms etc.
  90.    3. Please distribute ONLY the original authenticated ZIP format file.
  91.    4. Please obtain our written permission before including the program
  92.       with any "bundled" software packages.
  93.    5. Please do not accept payment for the program; a copying fee of
  94.       $5.00 per diskette may be charged by a non-profit user-group.
  95.    6. Please do not alter the program or documentation in any way.
  96.    7. Individuals, groups, vendors or other software distribution
  97.       companies which market diskettes containing shareware or test-drive
  98.       evaluation programs, for profit, must obtain written permission
  99.       from RaLin Enterprises prior to distribution. This will insure that
  100.       you have the most current copy.
  101.  
  102.     DISTRIBUTION of the REGISTERED version of this program is in
  103.     violation of the license agreement and copyright law.
  104.  
  105.  
  106. ┌─────────────────────────────────────────────────────────────────────────────┐
  107. │▒▒▒ *** DISCLAIMER *** ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  108. └─────────────────────────────────────────────────────────────────────────────┘
  109.  
  110.     This program is supplied "as is" without warranty of any kind. The
  111.     entire risk of using, and results from the use of, is assumed by you
  112.     the user.  You assume all costs of repair, servicing and corrections
  113.     stemming from the use of this program.
  114.     Rand Nowell and/or RaLin Enterprises, or any other associated
  115.     company of the program author will not be held liable for any
  116.  
  117.                In todays SMOG.... Give your callers some AIR!
  118.  
  119.  
  120. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  2
  121.  
  122.     damages from the use of this program. No warranties are expressed or
  123.     implied.
  124.     ********************************************************************
  125.     To the original licensee of the REGISTERED version of the program,
  126.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  127.     program is recorded, be free from defects in material and
  128.     workmanship under normal use and service for a period of (90) ninety
  129.     days from date of delivery as evidenced by your receipt. Our entire
  130.     liability and your exclusive remedy shall be replacement of the
  131.     defective disk not meeting the standards of this limited warranty.
  132.     And in no case shall exceed the cost of reimbursement of monies paid for
  133.     program registration.
  134.  
  135.     The Author is not obligated to produce further versions of this program.
  136.     The Author also reserves the right to convert any SHAREWARE program, to
  137.     that of COMMERCIAL status without prior notice.
  138.  
  139. ┌─────────────────────────────────────────────────────────────────────────────┐
  140. │▒▒▒ VERSION NUMBERS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  141. └─────────────────────────────────────────────────────────────────────────────┘
  142.  
  143.   Version 1.0 DOC stated that all FREE versions would be X.0 and Registered
  144.   would be X.xx, but that has already shown to be messy. So starting with
  145.   this release, 2.0, updates will follow the standard, next release will be
  146.   2.01 and so forth.
  147.  
  148.   If major enhancements or additions warrant it, the major version number
  149.   will change.
  150.  
  151. ┌─────────────────────────────────────────────────────────────────────────────┐
  152. │▒▒▒ OVERVIEW ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  153. └─────────────────────────────────────────────────────────────────────────────┘
  154.  
  155.  AIR was created to allow Sysops to easily include Ansi,Avatar,Ascii screens
  156.  in a RIP graphic window.
  157.  
  158.  It is being distributed as FREEWARE, but a more useful and configurable
  159.  copy is available if you wish to register.
  160.  
  161.  AIR can be run from a batch file, or in interactive mode. Here are a few
  162.  features:
  163.  
  164.  Features.... {+} = in Registered copy only
  165.  
  166.   a) Three modes to run in,
  167.      1) Command line mode with parameters
  168.      2) Command line mode with "Command File" {+}
  169.      3) User friendly interface, with pick lists for files and colors.
  170.   b) Currently 9 pre-defined RIP frames available,
  171.      three with Mouse/Key button(s). More being added.
  172.      ** Four frames available to "use" in FREEWARE version. **
  173.   c) Edit the "Sysop Message" displayed in frame. {+}
  174.   d) Specify color message is displayed in.
  175.   e) Testing mode, does not reset RIP text window, for test viewing.
  176.   f) Includes a copy of FLATVIEW.EXE from Jon Kent, author of the
  177.  
  178.                In todays SMOG.... Give your callers some AIR!
  179.  
  180.  
  181. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  3
  182.  
  183.      FLATLINE RIP Editor/Painter,  for viewing files.
  184.      *** New version, interprets Ansi codes! ***
  185.      (Distributed with Authors permission)
  186.   g) Command to create samples of ALL available frames, samples contain a
  187.      ruler line, to show width allowed/wrap columns for text window.
  188.   h) Manual contains directions on how to set up a screen file to be used
  189.      with AIR, and the proper menu setup for the RemoteAccess BBS system.
  190.   i) AIR is FAST!  Works great for BBS maintenance event.
  191.   j) Now uses external lists, that you create/maintain, to store
  192.      frequently used screen file names, and RIP file names.
  193.  
  194.  Though there are a couple of features de-activated in the FREEWARE copy,
  195.  it is a fully functional program, and will serve you well as is.
  196.  Registration is not required, but if you want the extra features, and
  197.  updated releases, then........
  198.  
  199. ┌─────────────────────────────────────────────────────────────────────────────┐
  200. │▒▒▒ RUNNING AIR! ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  201. └─────────────────────────────────────────────────────────────────────────────┘
  202.  
  203.   There are three ways to run AIR, two command line modes, and one
  204.   interactive mode. They will be covered separately in the following text.
  205.  
  206.   No matter which way you run AIR, the screen will display a program Name
  207.   and Copyright line at the top, and also display what copy you have. That
  208.   display will either say "FREEWARE Version" or "Registered Version"
  209.  
  210.   You can type AIR ?  for a command syntax Help Screen = OR =
  211.  
  212.   AIR SAMPLES,  to generate a sample of ALL screens available, named
  213.   SAMPLE1.RIP, SAMPLE2.RIP etc. These samples will contain a ruler line,to
  214.   advise you of what the wrap column is.
  215.  
  216.   (NEW) If you give a directory name as in AIR <directory>, AIR will change
  217.   to that directory, and put you in interactive mode. All files created will
  218.   be created in that directory, considered the "working" directory.
  219.  
  220.  ┌──────────────────────────────┐
  221.  │Command Line with Parameters: │
  222.  └──────────────────────────────┘
  223.  
  224. Run AIR with parameters on the DOS command line. The Syntax is as such:
  225. AIR <screenfile> <new rip file> <sysop message> <message color> <frame#> [TEST]
  226.  
  227.  A minimum of 5 parameters must be used on the command line, else you are taken
  228.  into Interactive mode. The parameters in <> are required, [] are optional.
  229.  If more than 6 parameters are given, AIR will abort.
  230.  
  231.  Parameters must have one space between them.
  232.  See note below on spaces in the Sysop Message.
  233.  
  234.  Screenfile and RipFile can be 40 characters in length, but totaled together
  235.  with other parameters, cannot exceed the DOS maximum line length.
  236.  
  237.  
  238.  
  239.                In todays SMOG.... Give your callers some AIR!
  240.  
  241.  
  242. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  4
  243.  
  244.  <screenfile>
  245.  Name of the file to display, Ansi/Avatar/Ascii. This file will be displayed in
  246.  the text window of the RIP frame that AIR creates. If the file cannot be
  247.  found, AIR will abort with an error message.
  248.  
  249.    NOTE: The program RipTerm, the free communications program from
  250.    TeleGraphix, does not properly display Avatar files, so you may want to
  251.    limit your screens to Ansi and Ascii for now. While QModemPro, will display
  252.    the Avatar screen properly, it does not work well with the current 1.54 RIP
  253.    specs, and will incorrectly display many screens.
  254.  
  255.  
  256.  <new ripfile>
  257.  The name you wish to save the new Ansi/RIP file under, if for some reason
  258.  AIR cannot create the file, it will abort with an error message.
  259.  If you want the file created in a directory other than the current one,
  260.  supply a full path name. Up to 40 characters allowed.
  261.  
  262.  <sysop message> {+}
  263.  A message of up to 65 characters to be displayed in the RIP frame, this is not
  264.  configurable in the FREEWARE copy, a pre-defined message will be displayed.
  265.  
  266.  When you enter this message on the DOS command line, it must contain SOLID or
  267.  HARD spaces between the words, this is to insure that the message is treated
  268.  as ONE parameter. Use the Alt-255 char for your spaces.
  269.  
  270.  Hold down the ALT key, and type 255 on the numeric key pad.  A sample line is
  271.  shown here, each * represents the Alt-255 solid space....
  272.  
  273.  MESSAGE = The*Daily*News,*From***The*RaLin*BBS
  274.  
  275.  do not put a solid space after the message.
  276.  
  277.  <message color>
  278.  The color in which to display the Sysop Message. Color must be in HEX format,
  279.  if you type a lower case char, 0a instead of 0A, AIR will take care of the
  280.  conversion. A list of color numbers is provided at the end of this section.
  281.  
  282.  <frame#>
  283.  Number of AIR/RIP frame to be used. If an invalid number is given, AIR will
  284.  abort with an error message.
  285.  
  286.  [TEST]
  287.  This is an "optional" parameter, by default AIR writes code to the end of your
  288.  screen file, to reset the RIP text window, so any following BBS menu will have
  289.  the complete screen to display in. But if you want to do a test view of the
  290.  screen, with the supplied FLATVIEW.EXE, or any other program, using the TEST
  291.  keyword will inhibit the writing of this code.
  292.  
  293.  IMPORTANT!! Do NOT use TEST for a finished product that will be displayed on
  294.  the system.
  295.  TEST may be upper or lower case, and is only supported in the  DOS command
  296.  line mode, and interactive mode.
  297.  
  298.  
  299.                In todays SMOG.... Give your callers some AIR!
  300.  
  301.  
  302. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  5
  303.  
  304.  ┌───────────────────────┐
  305.  │ Using a COMMAND file: │
  306.  └───────────────────────┘
  307.  
  308.    AIR supports the use of an external file, containing all the command line
  309.    parameters to be used.
  310.  
  311.    See the included file AIRTEST.DAT for format instructions.
  312.  
  313.    To use the external file, you specify it on the command line as such:
  314.  
  315.    AIR @filename  (no space between the @ and the filename.)
  316.  
  317.    The filename can be a full path name if you wish.
  318.  
  319.    The TEST switch is NOT supported when using an external file.
  320.  
  321.  
  322.  Either of the command line modes, using online parameters, or a Command
  323.  File, are perfect for updating screens in a daily or nightly event on your
  324.  BBS. Multiple screens can be created by wrapping the command lines in a
  325.  batch file.
  326.  
  327.  You can even maintain a log file of the actions performed.
  328.  AIR does not currently write to a log file, I will probably add this soon.
  329.  But you can do it in your batch file, a sample is in order.....
  330.  
  331.  
  332.  *=solid space, Chr(255)
  333.  
  334.  @echo off
  335.  AIR onceonly.ans onceonly Shows*once*unless*updated.**Read*It! 0E 4
  336.  echo Onceonly Screen updated >> AIRMAINT.LOG
  337.  AIR @mailcall.dat  (using a command file here)
  338.  echo New Mail Call screen created >> AIRMAINT.LOG
  339.  RUNBBS
  340.  
  341.  
  342.  And the last line will re-start your BBS.
  343.  Remember to use >>  not just > to direct your text to the file, if it
  344.  doesn't exist in the first line, it will be created, after that it will
  345.  append the entry to the log.
  346.  
  347.  As mentioned, the ability to write log entries will most likely be added
  348.  soon, probably as an optional command.
  349.  
  350.  Error levels may be checked in the batch file for problems. A listing of
  351.  error levels returned by AIR is included later on.
  352.  
  353.  ┌───────────────────┐
  354.  │ Interactive Mode: │
  355.  └───────────────────┘
  356.  
  357.    Typing AIR with no parameters, will place you in interactive mode.
  358.    Here you type all specs into data fields.
  359.  
  360.  
  361.                In todays SMOG.... Give your callers some AIR!
  362.  
  363.  
  364. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  6
  365.  
  366.    After each successful RIP creation, AIR will ask you if you'd like to do
  367.    another... Hitting 'Y' or the ENTER key will run you through the process
  368.    again, hitting 'N' will Exit AIR.
  369.  
  370.    There are pick lists available for choosing the Screen File, and the
  371.    Sysop Message color.
  372.    At the bottom of the data area, a help line is displayed for each field
  373.    you enter, explaining what this value is for, and some warnings.
  374.  
  375.    Lets cover each field now, in the order you will enter data.
  376.    At the end of this section, a list of several command keys, not
  377.    displayed, will be given.
  378.  
  379.  
  380.   Scrn File:  Enter the name of the file, Ansi,Avatar etc. that you wish to
  381.               have displayed in the RIP frame. If you forget the name of a
  382.               file, pressing the F1 function key will display a picklist of
  383.               all files in the current directory. Select the file you want,
  384.               and press <ENTER>, it will be placed in the data field, press
  385.               ENTER again to accept it.
  386.  
  387.               You can also travel through the directories, when you select a
  388.               directory, the name will be displayed just below the pick
  389.               list.
  390.  
  391.               Once a file name has been selected, you will be returned to
  392.               the working directory (the one you started in, or specified),
  393.               before processing/editing continues.
  394.  
  395.    Rip Name:  The name you wish to assign to the newly created Rip file.
  396.               If you do not give an extension, .RIP will be added by AIR.
  397.  
  398.               If you have the external file RIPNAMES.AIR available, you can
  399.               load it into a window, by pressing F1, then select the
  400.               filename to create, from that list.
  401.               See the file RIPNAMES.AIR for examples.
  402.  
  403. {+} Message:  Here you type in the message, up to 65 characters, that you
  404.               would like displayed in the message area on the AIR/RIP frame.
  405.               The freeware version does not allow editing of this message.
  406.  
  407.               This is 5 more than 1.0's 60 character limit, it may be a bit
  408.               tight on a couple of frames, you will have to experiment.
  409.  
  410.               If you have the external file MESSAGES.AIR available, you can
  411.               load it into a window, by pressing F1, then select the
  412.               message to use, from that list.
  413.               See the file MESSAGES.AIR for examples.
  414.  
  415.        NOTE:  In the FREEWARE version, you can choose a message from the
  416.               list, but when you leave the field, it will be replaced with
  417.               the default message.
  418.  
  419. Message Color:Enter the color value, the color you want the message to be
  420.               displayed in. Be sure you have viewed the samples, so you know
  421.  
  422.                In todays SMOG.... Give your callers some AIR!
  423.  
  424.  
  425. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  7
  426.  
  427.               what color is appropriate for the template you choose. Most
  428.               have a light gray area for the message line, but some are of a
  429.               different color.
  430.               If you press the F1 function key while in this field, a list
  431.               of colors will display. Choose the one you want, and press
  432.               <ENTER>.
  433.  
  434.               The color always defaults to Black (00).
  435.  
  436.               NOTE: If you enter a color that's out of range, AIR will insert
  437.               a color of its own choice, not always the right one!
  438.               Until you, or unless you, know the color codes by heart, it is
  439.               suggested you make use of the F1 key!!
  440.  
  441.    Template:  Select the template you wish to use for this file.
  442.               The FREEWARE version is limited to template #1 thru #4.
  443.               Should you enter a number beyond what is allowed, or
  444.               available, a message will display at the top of the screen,
  445.               giving you the valid range.
  446.  
  447.               The template always defaults to #1
  448.  
  449.   Win Reset:  In most cases this will always be left at (Y)es.
  450.               Setting this to (N)o, will tell AIR to not write the re-set
  451.               code to the RIP file.
  452.  
  453.    Explanation:
  454.  
  455.      Lets say you create a screen with the Win Reset set to No.
  456.      The screen will display properly, but when it exits, the text or TTY
  457.      window will be as was set in the RIP file, if your next screen is a
  458.      Menu, it's display will be done in that window, probably NOT in the
  459.      correct display format.
  460.  
  461.      When Win Reset is Yes, as soon as the RIP frame exits, the text frame
  462.      will be reset to the complete screen height and width, allowing any
  463.      screen to display properly.
  464.  
  465.      This will also be explained further in the "Creating Screens" section
  466.      later.
  467.  
  468.      Setting Win Reset to NO, is great for test viewing your screen, but
  469.      most assuredly should be set to YES before you display the screen on
  470.      your BBS.
  471.  
  472.  
  473. ┌─────────────────────────────────────────────────────────────────────────────┐
  474. │▒▒▒ COMMANDS AND COLORS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  475. └─────────────────────────────────────────────────────────────────────────────┘
  476.  
  477.   Following are lists or keys available during Interactive Edit mode,
  478.   and Color Values.
  479.  
  480.   Editing Keys:
  481.  
  482.  
  483.                In todays SMOG.... Give your callers some AIR!
  484.  
  485.  
  486. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  8
  487.  
  488.     During the editing of the screen parameters in the data entry section,
  489.     you can use these keys,
  490.  
  491.     ESC:     Abort editing and exit AIR
  492.     CTL-W:   Save current info and create RIP
  493.     CTL-U:   Will restore previous contents of field, must be used "before"
  494.              accepting with <ENTER>
  495.  
  496.     All fields, except the Sysop Message are required to have a value in
  497.     them, they will not allow you to leave, unless they do, or in some cases
  498.     will insert the default value if you leave it blank.
  499.  
  500.     Once a field contains data, the Up and Down arrow keys will move between
  501.     fields.
  502.  
  503.     If you press ENTER or Down Arrow on the last field, AIR will exit the
  504.     data entry, and create the RIP file. This will also happen if you press
  505.     Up Arrow while in the first field.
  506.  
  507.     All other normal editing keys are available, HOME,END INS,DEL,CTL-T etc,
  508.     conforming to the Wordstar editing key commands.
  509.  
  510.     Fields may be moved to by placing the mouse cursor on the field and
  511.     clicking the left mouse button.
  512.  
  513.  
  514.   Color Codes:
  515.  
  516.      This is a chart of the proper color codes to be used for the
  517.      message color.
  518.      They must be given with two digits/character, forced to upper case if
  519.      you enter in lower case. Use the pick list (F1)
  520.  
  521.              00         Black
  522.              01         Blue
  523.              02         Green
  524.              03         Cyan
  525.              04         Red
  526.              05         Magenta
  527.              06         Brown
  528.              07         Light Gray
  529.              08         Dark Gray
  530.              09         Light Blue
  531.              0A         Light Green
  532.              0B         Light Cyan
  533.              0C         Light Red
  534.              0D         Light Magenta
  535.              0E         Yellow
  536.              0F         White
  537.  
  538. ┌─────────────────────────────────────────────────────────────────────────────┐
  539. │▒▒▒ EXTERNAL FILES/LISTS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  540. └─────────────────────────────────────────────────────────────────────────────┘
  541.  
  542.    As mentioned earlier, AIR will make use of two external files,
  543.  
  544.                In todays SMOG.... Give your callers some AIR!
  545.  
  546.  
  547. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page  9
  548.  
  549.    MESSAGES.AIR and RIPNAMES.AIR
  550.  
  551.    These are plain Ascii files which you maintain.
  552.  
  553.    They will be displayed in a window, when you press F1 while in the
  554.    appropriate field in interactive mode.
  555.  
  556.    RIPNAMES.AIR: Here you keep a list of names to be assigned to your newly
  557.    created RIP frames, these can be full path names, or just a standard file
  558.    name, which will be created in the current working directory.
  559.    File names can be up to 40 characters in length.
  560.  
  561.    MESSAGES.AIR: In this file, you can keep a list of Sysop Messages to
  562.    be displayed in the Frame. When you are in the Message field, pressing
  563.    F1 will display this list, and allow you to choose a line to use.
  564.    Messages can be up to 65 characters in length.
  565.  
  566.    Both these files will allow and use up to 20 lines. You should make sure
  567.    that the first 20 lines contain the information you want.
  568.    I suggest you modify and use then included copies.
  569.  
  570.    AIR will display the first 20 lines, regardless of what they contain, if
  571.    you have a comment in that range of lines, it will display.
  572.  
  573.    Selection is made by either highlighting the line you want and pressing
  574.    ENTER, or clicking with the left mouse button.
  575.  
  576. ┌─────────────────────────────────────────────────────────────────────────────┐
  577. │▒▒▒ FORMAT OF AIR/RIP SCREENS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  578. └─────────────────────────────────────────────────────────────────────────────┘
  579.  
  580.   A little info on what AIR creates.
  581.  
  582.   There is a Created by/Copyright notice displayed on every AIR screen,
  583.   we have tried to not make it to obtrusive.
  584.  
  585.   Some of AIR's RIP frames enclose the screen area, then within these is
  586.   defined a Text Window, where the screen file you choose will be displayed
  587.   to the user. These windows use word wrapping, so if a line of text is
  588.   longer than the space allowed, the balance will wrap to the next line.
  589.  
  590.   Some of the AIR frames, have a full 80 column text window width.
  591.  
  592.   This is why we have supplied FLATVIEW from Jon Kent, the author of the
  593.   FLATLINE RIP Editor/Painter. Which, by the way, is probably the greatest
  594.   shareware RIP editor on the market. And we owe Jon a big thanks for
  595.   letting us distribute FLATVIEW with AIR!!
  596.  
  597.   The latest version of FlatView (1.04) now handles the Ansi codes, to a
  598.   degree that gives you a real good look at what your user will see. It of
  599.   course does NOT recognize any pausing or wait for Enter codes.
  600.   The defined TEXT output area is enclosed in a green dashed line.
  601.  
  602.   When the samples are viewed, a ruler line is displayed, which shows you
  603.   where the wrap will take place. This will be handy when you create a
  604.  
  605.                In todays SMOG.... Give your callers some AIR!
  606.  
  607.  
  608. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 10
  609.  
  610.   screen to use with AIR, and will be covered in the Creating a File
  611.   section.
  612.  
  613.  
  614. ┌─────────────────────────────────────────────────────────────────────────────┐
  615. │▒▒▒ AVAILABLE TEMPLATES ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  616. └─────────────────────────────────────────────────────────────────────────────┘
  617.  
  618.   This section will run down the available templates as of version 2.0
  619.   It will list the template number, Message Area background color, text
  620.   window width/wrap column, if it has an available Mouse/Keypress button,
  621.   and if you should have Win Reset On/Off.
  622.  
  623.  
  624.   If a screen has a button, when the user hits 'C' or clicks the button
  625.   it will reset the window automatically. All you need to provide is the
  626.   code to force your BBS software to wait for a ENTER keypress, the button
  627.   will send the ENTER and reset code.
  628.  
  629.   "Choice" in the Window Reset column, means either way will work.
  630.  
  631.  
  632.   Template      Message Area      Wrap       Button          Window
  633.   Number        Background        Column     Available       Reset
  634.   ────────      ───────────       ──────     ─────────       ───────
  635.  
  636.      1           Light Gray         72          No             Yes
  637.      2           Blue               70          No             Yes
  638.      3           Light Gray         80          No             Yes
  639.      4           Light Gray         80          Yes(1)         Choice
  640.      5       *   Light Gray         80          Yes(1)         Choice
  641.      6       *   Light Gray         80          Yes(4)         Choice
  642.      7           Light Gray         64          No             Yes
  643.      8           Cyan               66          No             Yes
  644.      9           Light Gray         68          No             Yes
  645.  
  646.  
  647.  
  648.   Notes: (*)
  649.     Templates 4 and 5 are pre-designed headers for your NEWS display.
  650.     They use FONTS other than the standard, if you use ver 1.04 of
  651.     FlatView, they will display properly, if not, you need the GOTH.CHR and
  652.     LITT.CHR font files available.
  653.  
  654.     Template #6 has 4 buttons, and they are coded for Host Commands
  655.     specific to Remote Access, if you don't run RA, you probably should not
  656.     use #6.
  657.  
  658.  More screens available soon!
  659.  
  660. ┌─────────────────────────────────────────────────────────────────────────────┐
  661. │▒▒▒ CREATING A SCREEN FILE ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  662. └─────────────────────────────────────────────────────────────────────────────┘
  663.  
  664.   You will want to save your Ansi files with a line length that will fit
  665.  
  666.   In todays SMOG.... Give your callers some AIR!
  667.  
  668.  
  669. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 11
  670.  
  671.   within the wrap width for the specified AIR frame.
  672.   Files saved with unlimited line length in programs such as TheDraw, seem
  673.   to have a problem.
  674.  
  675.   Sometimes, with a length of 255 or less, using the 80 column templates, a
  676.   file done in TheDraw, will display correctly. I am still testing different
  677.   variations of screens. I guess you can perhaps call the FREEWARE release of
  678.   AIR, an open beta.
  679.  
  680.   Don't let the word BETA scare you, AIR will not harm your system, it's
  681.   just that not all the questions have been answered as to all the
  682.   variations of screens that will display properly in different windows.
  683.  
  684.   The best thing to do is, as stated above, save your drawing in the line
  685.   length that matches, or is a little less than the column width for the
  686.   AIR frame you wish to use.
  687.  
  688.   If you do want to experiment with longer lines, in no case save the
  689.   screens with unlimited length, 255 at a maximum. AIR will not currently
  690.   read in a line over 255 characters in length.
  691.  
  692.   Using TheDraw, you can save with Video Prep = Home Cursor or None.
  693.   Do NOT use Clear Screen, that will erase the RIP frame in some cases.
  694.   As for other Ansi drawing programs (are there any other <g>? ), I cannot
  695.   tell you what to do, I have not used them, or tested with them.
  696.  
  697.   **************************************************************************
  698.  
  699.   Not to try and sell you anything, <heh heh> but if you run Remote Access,
  700.   may I suggest you look at our program RATE, the RaLin Ansi Test Editor.
  701.   Its great for creating multi-page Ansi Text files, full word processor
  702.   editing commands, pick lists, menus etc.
  703.  
  704.   Screens created by RATE, work perfectly with AIR!
  705.  
  706.   ***************************************************************************
  707.  
  708.   Anyway.......
  709.  
  710.  
  711.   No matter what BBS software you are using, it should provide a character
  712.   string that you can include in a screen file, that will wait for the
  713.   caller to press ENTER, for Remote Access this is ^A (Ctl-A).
  714.  
  715.   You need to have one of these at the end of the screen file, do not add it
  716.   after AIR has added the screen file to the RIP header, because AIR writes
  717.   the Window Reset code, if used, "after" the LAST line in your screen file.
  718.  
  719.   If your BBS software has a provision for displaying a prompt at the end of
  720.   the file, and waiting for the ENTER key.....do not rely on this, as it may
  721.   not display when being used in a RIP screen. Manually insert the code
  722.   required to generate the Wait For Enter signal.
  723.  
  724.   In TheDraw, with RemoteAccess, you would place the cursor at the end of
  725.   the last line of of text or line character, or on a separate line, then
  726.  
  727.                In todays SMOG.... Give your callers some AIR!
  728.  
  729.  
  730. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 12
  731.  
  732.   press Ctl-A, TheDraw will insert the "happy face" character.
  733.  
  734.   If you are displaying multi-page Ansi files, such as those created with
  735.   our program RATE, you can insert the PAUSE code in the screen file, which
  736.   will pause and wait for the ENTER key (same as ^A).
  737.  
  738.   Something to remember, when a caller is in RIP graphics mode, they are in
  739.   real time Graphics mode, the screen is now 80 characters by 43 rows in
  740.   size, so 43 lines can be displayed per screen size.
  741.   Of course if you are using a windowed screen, such as AIR templates, none
  742.   of them have a full 43 lines visible. I think the largest is about 35
  743.   lines. So you need to make sure the screen will pause in respect to how
  744.   many lines are visible at a time in the AIR/RIP window.
  745.  
  746.   A little side note.........
  747.  
  748.   I have a Viewing area set up on my RemoteAccess BBS system, where callers
  749.   can view RIP screens and drawings made by others.
  750.   All screens were loaded into the Flatline RIP editor, where I defined a
  751.   one character by one character Text Frame, in which I placed a ^A
  752.   character. This causes the system to wait for ENTER.
  753.  
  754.   I then created a Button, mousable, that reacts to the "C" key being
  755.   pressed, or a mouse click.  Of course, pressing ENTER works too.
  756.   All screens are displayed via RemoteAccess's type 5 menu command, and it
  757.   works GREAT!!
  758.  
  759.   Ascii files will work in RIP text windows too.
  760.  
  761.  
  762.   Now, a NOTE on Avatar files.
  763.   Most people are using the free program RIPTERM to call RIP compatible BBS
  764.   systems. RIPTERM is from the same folks who got the RIP graphics rolling.
  765.  
  766.   Problem is, RipTerm will not handle Avatar graphics, so it is suggested
  767.   that, for the time, all your screen files for use with AIR, be ANSI or
  768.   ASCII.
  769.  
  770.   While it's true that Qmodem Pro, from Mustang Software, will handle
  771.   Avatar, and supports RIP graphics too, Qmodem Pro, to my knowledge, is
  772.   still using RIP ver 1.53 specs, all the AIR screens are done in 1.54
  773.   specs, and will many times NOT display properly when the caller is using
  774.   QmodemPro.
  775.  
  776.   I have the Pro, and I speak from the experience of calling several systems
  777.   using RIP, and having problems.  I use RipTerm to call all RIP BBS
  778.   systems.
  779.  
  780.   That should be enough for you to create some nice Ansi/RIP screens for
  781.   your callers.
  782.  
  783.   Now....Go RIP 'em up!!!
  784.  
  785. ┌─────────────────────────────────────────────────────────────────────────────┐
  786. │▒▒▒ ERROR LEVELS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  787. └─────────────────────────────────────────────────────────────────────────────┘
  788.  
  789.                In todays SMOG.... Give your callers some AIR!
  790.  
  791.  
  792. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 13
  793.  
  794.  
  795.   The following error levels are returned by AIR!
  796.  
  797.        0        No errors, successful operation.
  798.      181        Unable to locate screen file.
  799.      182        Unable to create specified RIP file.
  800.      183        Unable to locate specified Command File (@filename)
  801.      184        Invalid template number specified.
  802.      185        To many parameters
  803.  
  804.  
  805.    0    Self explanatory
  806.  
  807.  181    Invalid filename given, or not in current directory.
  808.  
  809.  182    Should not occur, unless you use invalid characters in filename.
  810.  
  811.  183    Command File does not exist, or not exist in the directory given.
  812.  
  813.  184    Specified a template not allowed in the FREEWARE version, or one
  814.         that is not available in the Registered version.
  815.  
  816.  185    This will occur if you give more than the five parameters+the TEST
  817.         switch. Total of 6 parameters allowed.
  818.         The main cause is forgetting to use solid spaces between the words
  819.         in the Sysop Message.
  820.  
  821.  
  822.  IMPORTANT!!!
  823.  
  824.    When running in Command Line mode, in a batch file, be SURE you give all
  825.    the parameters, total of 5 not counting the TEST switch, which you
  826.    wouldn't be using.
  827.  
  828.    If you have less that the 5 required, AIR will go into Interactive Mode,
  829.    and sit there waiting for an entry.
  830.  
  831.    There you are..... cutting Z's while the mail's waiting, callers can't
  832.    log on, all because AIR is sitting there waiting....
  833.    Make sure you give the correct number of commands!!
  834.  
  835. ┌─────────────────────────────────────────────────────────────────────────────┐
  836. │▒▒▒ WHY REGISTER? ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  837. └─────────────────────────────────────────────────────────────────────────────┘
  838.  
  839.   First, it will get you the latest copy, and will allow you to receive all
  840.   future Registered versions free of charge*
  841.  
  842.   Also, it will show me that you think AIR is a useful tool for Sysops, and
  843.   will cause development to progress. Registrations do not make me rich!
  844.   They simply help offset the cost of developing programs, and distributing
  845.   them.
  846.  
  847.   * You will be given a password to use, and a filename, for down loading or
  848.  
  849.                In todays SMOG.... Give your callers some AIR!
  850.  
  851.  
  852. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 14
  853.  
  854.   file requesting the Registered version.
  855.   Or we may need a message from you stating the desire for the upgrade, and
  856.   we will attache to either a Netmail or BBS message, for you to come and
  857.   get.... undecided at present.
  858.  
  859.   If you need or want to receive updates via disk, then a $3.00 charge for
  860.   material and shipping will be required.
  861.  
  862.   We read our download and file request lists "carefully", if it appears
  863.   that the privilege of getting registered copies from our system is being
  864.   abused, it will end.  Not directed at anyone in particular, but this has
  865.   been known to happen.
  866.  
  867. ┌─────────────────────────────────────────────────────────────────────────────┐
  868. │▒▒▒ YOUR SUGGESTIONS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  869. └─────────────────────────────────────────────────────────────────────────────┘
  870.  
  871.    If you have comments or suggestions on ways to enhance or better AIR,
  872.    by all means send them! I listen to the users, most of my programs have
  873.    more than one feature that was requested by a user....
  874.  
  875.  ┌────────────────────┐
  876.  │ SUBMIT YOUR SCREEN │
  877.  └────────────────────┘
  878.  
  879.    If you have a nice screen you would like to see used in AIR, please
  880.    submit it via upload or Fido mail to our system. If we use it, you will
  881.    be given credit in the documentation.
  882.  
  883.    Submitted screens must have a place for the Sysop Message, that will
  884.    accept a line of 60 characters, and a place for the program notice would
  885.    be nice, if not it will be placed at the bottom of the screen, just under
  886.    the text window.
  887.  
  888.    Submitted screens become the property of RaLin Enterprises, and we
  889.    reserve the right to modify them as required to work properly with AIR!
  890.    You will receive credit in the DOC's, pointing to the frame you designed.
  891.  
  892.    See the section below, for contacting us, or the means with which to
  893.    send your screen to us.
  894.  
  895. ┌─────────────────────────────────────────────────────────────────────────────┐
  896. │▒▒▒ AUTHOR CONTACT  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  897. └─────────────────────────────────────────────────────────────────────────────┘
  898.  
  899.      I can be reached by several means.
  900.  
  901.         Phone: (510) 651-0253 Ask for Rand
  902.           If you get my wife, or the answering machine, please leave your
  903.           name, number, and a brief description of the problem, and I will
  904.           get back to you ASAP! (See SUPPORT below)
  905.  
  906.         Net Mail:        1:161/710   ->  Rand Nowell
  907.         FIDO Echos:      Shareware, RA_UTILS ->   Rand Nowell
  908.         Mail:            Rand Nowell
  909.  
  910.                In todays SMOG.... Give your callers some AIR!
  911.  
  912.  
  913. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 15
  914.  
  915.                          RaLin Enterprises Software
  916.                          40728 Sundale Dr.
  917.                          Fremont, Ca. 94538
  918.         BBS:             (510) 651-0253,,3322
  919.  
  920.   PHONE NUMBER:
  921.   Our Mailer/BBS shares a voice line at the present, so connecting can
  922.   sometimes be a problem. It also requires a modified dialing string.
  923.   To switch to the Mailer/BBS requires that you send a 4 second pause, and a
  924.   special code.
  925.  
  926.   The code is 3322
  927.  
  928.   Most modems use a comma for a pause code, and most are set at 2 seconds
  929.   per comma. Given the standard, your dialing string to connect to our
  930.   system would be: 1-510-651-0253,,3322
  931.  
  932.   Now, if you use a long distance call service, you may require more delay
  933.   time than 4 seconds, before sending the code. The main thing is that the
  934.   pause and the code should be sent after connecting to "our" number....
  935.  
  936.   With a mailer: I can only tell you how to do it with FrontDoor, due to our
  937.   number containing the commas, we cannot have our number in the nodelist,
  938.   so we are listed UNPUBLISHED and PVT. You can over-ride this in FDNODE.CTL
  939.  
  940.   Simply enter a line as such:   PHONE  1:161/710  1-510-651-0253,,3322
  941.   or whatever you end up needing to connect.  Then re-compile the Nodelist.
  942.  
  943.   My business looks like it's going pick up, so a new dedicated line may be
  944.   in store shortly. The programming certainly does not pay for the addition
  945.   of such. <grin>
  946.  
  947.   Sorry for the gruesome phone situation, but hopefully it will be fixed
  948.   soon.
  949.  
  950.  
  951. ┌─────────────────────────────────────────────────────────────────────────────┐
  952. │▒▒▒ SUPPORT ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  953. └─────────────────────────────────────────────────────────────────────────────┘
  954.  
  955.          Registered users receive full unlimited support, if I have to call
  956.          you back, it will be on my dime!
  957.          Unregistered users will receive help, but if I have to call, expect
  958.          a collect one.
  959.  
  960.    See the AIR.REG file for our Registration plans. There are two
  961.    ways to receive your Registration and Utilities.
  962.  
  963.    Disk by Mail and FIDO File Attach.
  964.  
  965.    NOTE: The FidoNet file attach is an experimental procedure, if it proves
  966.    to NOT be cost efficient, we will be switching to DISK only shipping.
  967.  
  968.    If you have any comments (good or bad) or suggestions, please send them!
  969.    Your help, and comments are appreciated, read, and often implemented!
  970.  
  971.                In todays SMOG.... Give your callers some AIR!
  972.  
  973.  
  974. Ansi In RIP!        AIR 2.0  - Program Documentation -              Page 16
  975.  
  976.  
  977.    Thank You!
  978.  
  979. ┌─────────────────────────────────────────────────────────────────────────────┐
  980. │▒▒▒ ACKNOWLEDGEMENTS ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  981. └─────────────────────────────────────────────────────────────────────────────┘
  982.  
  983.     AIR was compiled under Turbo Pascal - Borland International.
  984.  
  985.     TheDraw is Copyright Ian Davis - TheSoft Programming Services
  986.  
  987.     Qmodem Pro is Copyright Mustang Software
  988.  
  989.     Flatline and Flatview are Copyright Jon Kent, The Thabes Co.
  990.  
  991.      And a special thanks to Jon for allowing us to include FLATVIEW
  992.      with AIR....If you haven't tried the FLATLINE RIP Editor/Painter, you
  993.      are missing out on a GREAT program! Available on many systems as
  994.      FLTLN###.EXE - self installing file, ###= version number. Current is
  995.      103
  996.  
  997.     RIPTerm is Copyright TeleGrafix Communications Inc.
  998.  
  999.  
  1000.     AIR is coded with RIP commands, taken from the
  1001.     RIPscript Graphics Protocol Specification Manual, Copyright by
  1002.     TeleGrafix Communications Inc.
  1003.  
  1004.     I would like to thank them for a job well done on their Specifications
  1005.     manual, while this project did not require a huge amount of knowledge of
  1006.     RIP graphics, what I did need was "clearly" explained. And will be a big
  1007.     help in future projects. Thanks guys.....
  1008.  
  1009.  
  1010.     Of course I need to thank my wife and kids for putting up with my
  1011.     countless hours at the PC, without complaining......well not much
  1012.     anyway.
  1013.  
  1014.     To those of you who do decide to Register, thank you!
  1015.     Registrations will show me that AIR has potential, and that I should
  1016.     continue to develop and enhance it.
  1017.  
  1018.  
  1019.     I hope you enjoy the FREEWARE copy, you'd like the Registered better!
  1020.  
  1021.     See the included file WHATSUP.DOC for plans for future additions to AIR.
  1022.  
  1023. ┌─────────────────────────────────────────────────────────────────────────────┐
  1024. │▒▒▒ End-Of-File AIR.DOC ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  1025. └─────────────────────────────────────────────────────────────────────────────┘
  1026.  
  1027.  
  1028.  
  1029.                In todays SMOG.... Give your callers some AIR!
  1030.  
  1031.