*-------------------------------------------------------------------------* *- Text File : SCRIPT.TXT -* *- -* *- Author : Todd Fiske [70451,1424] TeamOz -* *- Section Leader for Section 7, "Scripts/Macros" -* *- -* *- Purpose : Summaries of OzCIS Script Language Commands & Variables -* *- -* *- Revision : 01/21/1994 - first version -* *- History -* *-------------------------------------------------------------------------* Overview Command Summary notes Variable Summary notes Printing considerations Closing notes *-------------------------------------------------------------------------* -- Overview This package contains these three files: SCRIPT.TXT this file CMDSUM.TXT Command Summary VARSUM.TXT Variable Summary The files in this package are provided as interim reference material. We (TeamOz) are presently in the process of rewriting the OzCIS documentation, but until that is done, I thought it would be useful for script writers to get at least a summary of the state of the script langauge. There have been many changes and additions to the script language in the recent patches to OzCIS which are not in the main OzCIS documentation. This package is an attempt to rectify that for the time being. *-------------------------------------------------------------------------* -- Command Summary notes The Command Summary has listings of all of the OzCIS Script Language Commands in these formats: list fields ----------- -------------------------------------------------------- By Name command, category, syntax, summary, log safe By Category category, command, syntax, summary, log safe Synonyms command, category, synonym "Command" is the actual name you use in the script language. "Category" is one of the following: Capture opening, closing, sending output to capture files File IO reading and writing text files Flow Control branching and looping controls Input user interaction routines Numeric number manipulation, conversion to strings Online commands that can only be used when actually online Output commands that write to the screen and/or the modem String string manipulation, conversion to numbers Variable creating and defining variables Wait commands to handle incoming data "Syntax" describes the parameters expected by the command. "Summary" is a brief one-line description of the command. "Log safe" indicates whether or not a command is wise to use in a logon/logoff script. Note that this is not just a yes/no field - some commands are safe to be used, if used "with caution". "Synonym" is an alternate name that produces the same results as the given command. *-------------------------------------------------------------------------* -- Variable Summary notes The Variable Summary has listings of all of the OzCIS Script Language Pre-defined Variables in these formats: list fields ----------- -------------------------------------------------------- By Name variable, category, summary By Category category, variable, type By Type type, variable, category "Variable" is the actual name you use in the script language. "Category" is one of the following: Constant always return the same value Forum values relative to the current or most recent forum Host values relative to the current host Script values to describe or control the current script User values that contain user information Variable values that change over time not already covered above "Summary" is a brief one-line description of the variable. "Type" is one of the following: Boolean true/false logical values General returns/expects any type Numeric numbers and numerical values String text, character Strictly speaking, "Boolean" variables are "Numeric" variables, but it's useful to think of them as a separate thing since they are usually used that way. *-------------------------------------------------------------------------* -- Printing considerations These files are not immediately suitable for printing except perhaps on wide-carriage printers. Both summary files contain lines that are wider than 80 characters, and neither file contains formfeeds nor do they have breaks between sections that fall on natural page lengths (typically 66 lines). Here are the overall stats for each one: CMDSUM.TXT is 140 characters wide, and 232 lines long chars lines subsection wide long ----------- ----- ----- By Name 140 77 By Category 140 82 Synonyms 34 73 VARSUM.TXT is 83 characters wide, and 101 lines long chars lines subsection wide long ----------- ----- ----- By Name 83 34 By Category 30 35 By Type 30 32 There are three methods you can use, either separately or in combinations, to get these lists into more printable formats: edit the files use different paper sizes use printer settings to control the size of printed characters For example, you may wish to discard some of the columns of information in the CMDSUM.TXT "By Name" list, the widest list, to get it to fit width-wise on piece of normal letter paper (8.5" x 11"). Printed at the normal 6 lines per inch, this list would also fit length-wise on a piece of legal paper (8.5" x 14") Alternatively, you may be able to squeeze the CMDSUM.TXT "By Name" list on to normal sized paper by adjusting your printer. Setting the lines per inch to 8 will easily accomodate all of the lists here. Setting the pitch to a compressed mode of about 17 characters per inch will almost, but not quite, allow the CMDSUM.TXT "By Name" list to print without editing. If you have a 24 pin printer like the Epson LQ 2500 or the Panasonic KX-P1124, you can set both Compressed and Elite modes on to achieve a 20 characters per inch mode, easily accomodating all of these lists. For those with laser printers, you can experiment with smaller fonts and some of the numerous "4-up" type page printing programs out there. In the end, you may need to do a bit of experimenting in order to get these lists to print out in a suitable manner. If you have any questions, or would like some suggestions, feel free to contact me on the OzCIS Forum, Section 7 "Scripts/Macros". *-------------------------------------------------------------------------* -- Closing notes I hope you find this information useful. As I mentioned above, I'm in the process of rewriting the OzCIS Script documentation. If you have any comments or questions, either regarding this material or in general, I would very much appreciate hearing it. Best of luck in your OzCIS Script programming pursuits! Cheers - Todd [TeamOz] [70451,1424]