home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR9 / SCRSUM.ZIP / SCRIPT.TXT < prev    next >
Text File  |  1994-01-21  |  8KB  |  193 lines
  1. *-------------------------------------------------------------------------*
  2. *- Text File  : SCRIPT.TXT                                               -*
  3. *-                                                                       -*
  4. *- Author     : Todd Fiske [70451,1424] TeamOz                           -*
  5. *-              Section Leader for Section 7, "Scripts/Macros"           -*
  6. *-                                                                       -*
  7. *- Purpose    : Summaries of OzCIS Script Language Commands & Variables  -*
  8. *-                                                                       -*
  9. *- Revision   : 01/21/1994 - first version                               -*
  10. *- History                                                               -*
  11. *-------------------------------------------------------------------------*
  12.  
  13.    Overview
  14.    Command Summary notes
  15.    Variable Summary notes
  16.    Printing considerations
  17.    Closing notes
  18.  
  19.  
  20. *-------------------------------------------------------------------------*
  21.  
  22. -- Overview
  23.  
  24. This package contains these three files:
  25.  
  26.    SCRIPT.TXT   this file
  27.    CMDSUM.TXT   Command Summary
  28.    VARSUM.TXT   Variable Summary
  29.  
  30. The files in this package are provided as interim reference material. We
  31. (TeamOz) are presently in the process of rewriting the OzCIS documentation,
  32. but until that is done, I thought it would be useful for script writers to
  33. get at least a summary of the state of the script langauge. There have been
  34. many changes and additions to the script language in the recent patches to
  35. OzCIS which are not in the main OzCIS documentation. This package is an
  36. attempt to rectify that for the time being.
  37.  
  38.  
  39. *-------------------------------------------------------------------------*
  40.  
  41. -- Command Summary notes
  42.  
  43. The Command Summary has listings of all of the OzCIS Script Language
  44. Commands in these formats:
  45.  
  46.    list         fields
  47.    -----------  --------------------------------------------------------
  48.    By Name      command, category, syntax, summary, log safe
  49.    By Category  category, command, syntax, summary, log safe
  50.    Synonyms     command, category, synonym
  51.  
  52. "Command" is the actual name you use in the script language.
  53.  
  54. "Category" is one of the following:
  55.  
  56.    Capture       opening, closing, sending output to capture files
  57.    File IO       reading and writing text files
  58.    Flow Control  branching and looping controls
  59.    Input         user interaction routines
  60.    Numeric       number manipulation, conversion to strings
  61.    Online        commands that can only be used when actually online
  62.    Output        commands that write to the screen and/or the modem
  63.    String        string manipulation, conversion to numbers
  64.    Variable      creating and defining variables
  65.    Wait          commands to handle incoming data
  66.  
  67. "Syntax" describes the parameters expected by the command.
  68.  
  69. "Summary" is a brief one-line description of the command.
  70.  
  71. "Log safe" indicates whether or not a command is wise to use in a
  72. logon/logoff script. Note that this is not just a yes/no field - some
  73. commands are safe to be used, if used "with caution".
  74.  
  75. "Synonym" is an alternate name that produces the same results as the given
  76. command.
  77.  
  78.  
  79. *-------------------------------------------------------------------------*
  80.  
  81. -- Variable Summary notes
  82.  
  83. The Variable Summary has listings of all of the OzCIS Script Language
  84. Pre-defined Variables in these formats:
  85.  
  86.    list         fields
  87.    -----------  --------------------------------------------------------
  88.    By Name      variable, category, summary
  89.    By Category  category, variable, type
  90.    By Type      type, variable, category
  91.  
  92. "Variable" is the actual name you use in the script language.
  93.  
  94. "Category" is one of the following:
  95.  
  96.    Constant  always return the same value
  97.    Forum     values relative to the current or most recent forum
  98.    Host      values relative to the current host
  99.    Script    values to describe or control the current script
  100.    User      values that contain user information
  101.    Variable  values that change over time not already covered above
  102.  
  103. "Summary" is a brief one-line description of the variable.
  104.  
  105. "Type" is one of the following:
  106.  
  107.    Boolean  true/false logical values
  108.    General  returns/expects any type
  109.    Numeric  numbers and numerical values
  110.    String   text, character
  111.  
  112. Strictly speaking, "Boolean" variables are "Numeric" variables, but it's
  113. useful to think of them as a separate thing since they are usually used
  114. that way.
  115.  
  116.  
  117. *-------------------------------------------------------------------------*
  118.  
  119. -- Printing considerations
  120.  
  121. These files are not immediately suitable for printing except perhaps on
  122. wide-carriage printers. Both summary files contain lines that are wider
  123. than 80 characters, and neither file contains formfeeds nor do they have
  124. breaks between sections that fall on natural page lengths (typically 66
  125. lines). Here are the overall stats for each one:
  126.  
  127.    CMDSUM.TXT is 140 characters wide, and 232 lines long
  128.  
  129.                    chars  lines
  130.       subsection    wide   long
  131.       -----------  -----  -----
  132.       By Name        140     77
  133.       By Category    140     82
  134.       Synonyms        34     73
  135.  
  136.  
  137.    VARSUM.TXT is 83 characters wide, and 101 lines long
  138.  
  139.                    chars  lines
  140.       subsection    wide   long
  141.       -----------  -----  -----
  142.       By Name         83     34
  143.       By Category     30     35
  144.       By Type         30     32
  145.  
  146.  
  147. There are three methods you can use, either separately or in combinations,
  148. to get these lists into more printable formats:
  149.  
  150.    edit the files
  151.    use different paper sizes
  152.    use printer settings to control the size of printed characters
  153.  
  154.  
  155. For example, you may wish to discard some of the columns of information in
  156. the CMDSUM.TXT "By Name" list, the widest list, to get it to fit width-wise
  157. on piece of normal letter paper (8.5" x 11").
  158.  
  159. Printed at the normal 6 lines per inch, this list would also fit
  160. length-wise on a piece of legal paper (8.5" x 14")
  161.  
  162. Alternatively, you may be able to squeeze the CMDSUM.TXT "By Name" list on
  163. to normal sized paper by adjusting your printer. Setting the lines per inch
  164. to 8 will easily accomodate all of the lists here. Setting the pitch to a
  165. compressed mode of about 17 characters per inch will almost, but not quite,
  166. allow the CMDSUM.TXT "By Name" list to print without editing.
  167.  
  168. If you have a 24 pin printer like the Epson LQ 2500 or the Panasonic
  169. KX-P1124, you can set both Compressed and Elite modes on to achieve a 20
  170. characters per inch mode, easily accomodating all of these lists.
  171.  
  172. For those with laser printers, you can experiment with smaller fonts and
  173. some of the numerous "4-up" type page printing programs out there.
  174.  
  175. In the end, you may need to do a bit of experimenting in order to get these
  176. lists to print out in a suitable manner. If you have any questions, or
  177. would like some suggestions, feel free to contact me on the OzCIS Forum,
  178. Section 7 "Scripts/Macros".
  179.  
  180.  
  181. *-------------------------------------------------------------------------*
  182.  
  183. -- Closing notes
  184.  
  185. I hope you find this information useful. As I mentioned above, I'm in the
  186. process of rewriting the OzCIS Script documentation. If you have any
  187. comments or questions, either regarding this material or in general, I
  188. would very much appreciate hearing it.
  189.  
  190. Best of luck in your OzCIS Script programming pursuits! <g>
  191.  
  192. Cheers - Todd [TeamOz] [70451,1424]
  193.