home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / windows / que101d.zip / !QUE.DOC < prev    next >
Text File  |  1990-03-27  |  14KB  |  340 lines
  1.  
  2.  
  3.  
  4.                          <<<<<< !QUE >>>>>>
  5.  
  6.                             Version 1.01d
  7.  
  8.                               (C) 1990
  9.  
  10.                         by Stephen L. Jenkins
  11.  
  12.                          All Rights Reserved
  13.  
  14.  
  15.  
  16.  
  17. DISTRIBUTION RIGHTS
  18.  
  19.    !QUE may be freely copied and distributed as long as
  20.    the following three conditions are met.
  21.  
  22.      1) The code, documentation or data may in no way be altered or
  23.         hacked.
  24.  
  25.      2) All four files(!QUE.XWC,!QUE_OV1.XWC,!QUE.DOC and STARTUP.XWS)
  26.         must be distributed together, either as separate files or
  27.         compressed in an archive file.
  28.  
  29.      3) No sum of money may be charged for the distribution of this
  30.         program. This includes; no charge for the cost of the
  31.         distribution media. In other words, you may only give this
  32.         program away. Although it may be included on a disk with
  33.         purchased programs, nothing may be charged for !QUE
  34.         and it's support files.
  35.  
  36. DESCRIPTION
  37.     !Que is a script for Crosstalk for Windows. It implements a dialing
  38.     queue and logs calls.
  39.  
  40. SYSTEM REQUIREMENTS
  41.      Crosstalk for Windows
  42.      Approximately 35k of memory
  43.  
  44. INCLUDED FILES
  45.           !QUE.DOC - this documentation
  46.           !QUE.XWC - the compiled main script
  47.       !QUE_OV1.XWC - the compiled overlay
  48.        STARTUP.XWS - a new startup script
  49.  
  50.  
  51. INSTALLATION
  52.  
  53.   DIRECTORY
  54.     !Que consists of two script files(!QUE.XWC and !QUE_OV1.XWC).
  55.     Both of these files must be copied to your Crosstalk for
  56.     Windows(here after referred to as WindeX) scripts directory.
  57.     NOTE: Both files are needed.
  58.  
  59.   ALL USERS INSTALLATION
  60.     The first thing to do is configure WindeX to your preferences.
  61.       1) Start WindeX.
  62.       2) Press Alt - F - N - Esc.
  63.          This will cause WindeX to load it's defaults. You should
  64.          not see any profile name next to the CROSSTALK for Windows
  65.          window title.
  66.       3) Press Alt - S - S.
  67.          This will bring up the session setup dialog box.
  68.          Enter your name in the User ID field.
  69.          If you have a password that you use a lot or for most of
  70.          your contacts enter it in the Password field.
  71.          Leave Script and Net ID fields blank as they usually
  72.          change for each entry.
  73.          Select the Ok button.
  74.       4) Press Alt - S - D.
  75.          Select the options for a normal session.
  76.          Select the Ok button.
  77.       5) Press Alt - S - T.
  78.          Select the options for a normal session.
  79.          Select the Ok button.
  80.       6) Press Alt - S - P.
  81.          Select the protocol for a normal session.
  82.          Select the Ok button.
  83.       7) Press Alt - F - S.
  84.          Type in NORMAL and then select Ok.
  85.          (and Ok to overwrite)
  86.       8) Press Alt - S - Y.
  87.          Enter STARTUP in the Startup script field. This will allow you to start
  88.          !Que by clicking on the script name.
  89.  
  90.     You have now configured WindeX for a standard session.
  91.  
  92.   FIRST TIME INSTALLATION
  93.     Start the !Que script by selecting either one of the scripts. At
  94.     this point !Que will look for a directory file(!QUE.DIR - which
  95.     contains the information that !Que maintains about each profile
  96.     entry). Since this is your first time through it won't be found
  97.     and !Que will ask if it's alright to create it. Answer yes, then
  98.     sit back as !Que loads each profile and extracts and stores the
  99.     info it needs (this could take some time, so be patient). When all
  100.     this windows gyrations is through you should be looking at the
  101.     main !Que screen with a list of all of the profiles that have
  102.     phone numbers. The next thing you will probably want to do is sort
  103.     the entries by whatever criteria makes sense to you. To do this
  104.     select the [SORT] button or press [S]. This will pop up the sort
  105.     dialog box. Check the field you want your directory sorted by and
  106.     whether you want it ascending or descending. Then select the
  107.     (Sort) button and !Que will go to work.
  108.       NOTE: This operation takes an exorbitant amount of time due to
  109.       the limitations of the WindeX script language. So above all have
  110.       patience with this operation. One good point is that you don't
  111.       have to sort the list again unless you want to change the sort
  112.       criteria(i.e. !Que remembers your sort preference so when new
  113.       entries are added they will automatically get sorted into their
  114.       proper location).
  115.     When the sorting is done you are ready to start using !Que to
  116.     queue up your WindeX profiles for dialing.
  117.  
  118.   BETA VERSION 0.52 USERS INSTALLATION
  119.     The only thing that is necessary is to delete the old !QUE.XWC and
  120.     place the two new scripts in your WindeX scripts directory. The
  121.     old directory file(!QUE.DIR) has a slightly different format but
  122.     is fully compatible with !Que ver. 1.01d. The difference in format
  123.     is to allow the storage of elapsed days since last connect. Since
  124.     this was not available in ver. 0.52, your copy of !QUE.DIR will
  125.     get updated as you use the new version of !Que to place calls.
  126.     This is totally transparent to you, so no action is required by
  127.     you. Note: You can configure !Que so that it doesn't display
  128.     elapsed days in which case there will be no discernable change in
  129.     the way the directory is displayed(see CONFIGURATION).
  130.  
  131. USING !QUE
  132.     While most of the functions that !Que does are relatively
  133.     intuitive some are not covered in the on-line help, and so will be
  134.     in the rest of this document.
  135.  
  136.   CONFIGURATION - confi[G]
  137.  
  138.     DEFAULTS
  139.       Don't start as icon.
  140.       Run in window.
  141.       Show key caps on terminal screen.
  142.       Make beeps.
  143.       Show civilian time.
  144.       Selection bar moves after tagging.
  145.       Show elapsed days since last connect.
  146.       Log connections to !QUE.LOG.
  147.       All screen colors - yellow.
  148.       Dialing queue active - 10 minutes.
  149.       Don't iconize while dialing.
  150.       Don't quit after active time elapses.
  151.       Sort field - Description.
  152.       Sort order - Descending.
  153.  
  154.     CONFIGURABLE ITEMS
  155.       Icon start
  156.         Controls whether !Que shrinks WindeX to an icon while the
  157.         directory loads. Saves a little time and cleaner appearance.
  158.  
  159.       Full screen
  160.         Controls whether !Que runs full screen or in a window.
  161.  
  162.       Show keys
  163.         Controls whether the key cap legends are displayed at the
  164.         bottom of the !Que directory. Useful if you don't have enough
  165.         screen resolution to display both the directory and the keys.
  166.         If not checked, all of the options that were on the key caps
  167.         are available under the User menu option.
  168.  
  169.       Beeps
  170.         Controls whether !Que beeps when it needs to alert you to
  171.         something. I.E. dialog boxes, connection, errors, ...
  172.  
  173.       24 hour format
  174.         Controls whether civilian or military time is displayed
  175.         at the bottom of the directory window.
  176.  
  177.       Move bar
  178.         Controls whether the selection bar automatically advances to
  179.         the next entry after you have marked/unmarked a directory
  180.         entry for dialing.
  181.  
  182.       Elapsed days(old Days/Date & Time)
  183.         Controls whether to display the number of elapsed days since
  184.         you last connected to this entry or the date and time of your
  185.         last connected.
  186.  
  187.       Log
  188.         Controls whether !Que maintains a log file of your calls.
  189.           Note: In order for this option to work you must use
  190.           !QUE(OFF) as your logoff script(see NEW).
  191.  
  192.       Text colors
  193.         Allows you to change certain colors in the !Que display.
  194.  
  195.       Minutes active
  196.         This controls how long !Que keeps cycling through it's entries
  197.         before it quits. If you enter 0, !Que will dial continuously.
  198.         The maximum number of minutes that can be entered is 240.
  199.  
  200.       Iconize
  201.         Controls whether WindeX runs as an icon while !Que is
  202.         attempting to make a connection.
  203.  
  204.       Close
  205.         Controls whether to close WindeX if the amount of time for
  206.         attempting a connection expires.
  207.  
  208.   UPDATE - [U]pdate
  209.     This is used if you need to update a specific entry(i.e. you have
  210.     changed the phone number, logon script or description of the
  211.     profile while in WindeX) or if you need to totally rebuild your
  212.     directory.
  213.       NOTE: Rebuilding your directory causes !Que to start by getting
  214.       all your profile info and then doing a compare to match any old
  215.       directory info to the same new entry. This will leave the
  216.       directory in an unsorted state. Again this is a slow process.
  217.  
  218.   NEW - [N]ew
  219.     This option is used to add an existing profile or to enter a new
  220.     entry into the !Que directory.
  221.  
  222.     ENTERING AN EXISTING PROFILE
  223.       To have !Que include a new profile that you created in WindeX
  224.       enter the name of the existing profile in the Profile(DOS) name
  225.       field of the new entry dialog box. Select  Save. At this point
  226.       you will be asked if you want to add this profile to the
  227.       directory. If you select add then that profile will be loaded
  228.       and the info extracted and saved to the !Que directory.
  229.  
  230.     ENTERING A NEW ENTRY/PROFILE
  231.       Fill in a valid DOS file name for the new profile in the
  232.       Profile(DOS) name field. Then enter a description for this
  233.       entry. Next fill in the phone number for the new entry. Note
  234.       that this field follows the same convention as WindeX(i.e. you
  235.       may enter multiple phone numbers separated by semicolons). Next
  236.       enter a dial modifier if you need to.  The Logon/off field
  237.       requires some clarification as to what's going on.  First a
  238.       little known or documented fact is that WindeX can have two
  239.       scripts, separated by a semicolon, specified in the scripts
  240.       field.  What WindeX does is use the first one as a logon script
  241.       and the second script gets executed when you disconnect. The
  242.       only limitation is that in order to have a logoff script you
  243.       must have a logon script(i.e.  ';logoff' isn't acceptable). So
  244.       the first script, !QUE(ON), is merely a place holder and can be
  245.       replaced with any logon script you want.  The second script,
  246.       !QUE(OFF), does two things. First, if you have the logging
  247.       option on, it creates a one line entry in the log(!QUE.LOG),
  248.       consisting of the profile description, the logoff time and date,
  249.       and the duration of the call. NOTE: You must use !QUE(OFF) as
  250.       the logoff script if you want your calls logged! The other thing
  251.       that !QUE(OFF) does is allow you to pick up !Que dialing from
  252.       the next entry in the queue.
  253.  
  254.   DIALING - [D]ial...
  255.       While !Que is cycling through the entries in the queue, you can
  256.       monitor the progress on the message line. While !Que is
  257.       attempting to make contact you will see the following message
  258.       line:
  259.  
  260.       [Esc!Que]{###} Description
  261.  
  262.       Where the [Esc!Que] is to remind you the you can pause !Que
  263.       dialing by pressing [Esc]. The number inside the curly braces is
  264.       the number of attempts to contact this entry, and Description is
  265.       the currently loaded profiles' description.
  266.  
  267. So much for this brief documentation. If you have any questions or
  268. problems select the copyright notice and it will display how to
  269. get in touch with me. Enjoy.
  270.  
  271. 03/20/90 ver 1.01 First public release.
  272.  
  273. 03/21/90 ver 1.01 previously undocumented switches.
  274.       When starting !Que there are two swithes you can use.
  275.  
  276.            !Que /H - will cause !Que to behave as if the
  277.                      'Icon start' option had been checked in
  278.                      the configure !Que dialog box.
  279.  
  280.            !Que /D - will cause !Que to start dialing auto-
  281.                      matically without going to the directory
  282.                      listing.
  283.  
  284. 03/22/90 ver 1.01a - not released.
  285.       Added [m]iddle(note lower case letter) button to get to the
  286.       middle of a directory page quickly.
  287.       This required some juggling of the tag[A]ll and [C]lear
  288.       buttons. These options are now found under the [A]ll option.
  289.  
  290. 03/24/90 ver 1.01b - not released.
  291.       Added various ways of using the '!QUE(OFF)' logoff script.
  292.       Addition parameters can be placed after the '!QUE(OFF)'
  293.       They are:
  294.  
  295.          QUIT - will cause Crosstalk for Windows to close.
  296.                 i.e. 'logon;!QUE(OFF)QUIT'
  297.  
  298.           END - will leave the current profile loaded
  299.                 and disconnected, but stop !Que.
  300.                 i.e. 'logon;!QUE(OFF)END'
  301.  
  302.          DIAL - will cause !Que to go ahead and start
  303.                 dialing again automatically.
  304.                 i.e. 'logon;!QUE(OFF)DIAL'
  305.  
  306.       As well as the above three special words you can also have
  307.       !Que run any of your scripts after '!QUE(OFF)'.
  308.  
  309.       EXAMPLES:
  310.  
  311.       'logon;!QUE(OFF)myscript'
  312.       Would run 'myscript' after disconnecting from this profile.
  313.  
  314.       'logon;!QUE(OFF)myscript parms'
  315.       Would run 'myscript' and pass 'parms' to the script after
  316.       disconnecting from this profile.
  317.  
  318.       'logon;!QUE(OFF)myscript(alabel)'
  319.       Would run 'myscript' and jump to the label 'alabel' after
  320.       disconnecting from this profile.
  321.  
  322.       'logon;!QUE(OFF)myscript(alabel)parms'
  323.       Would run 'myscript' and jump to the label 'alabel' and
  324.       pass 'parms' to the script after disconnecting from this
  325.       profile.
  326.  
  327. 03/24/90 ver 1.01c - not released.
  328.       Added ability to print the !Que directory to the disk file '!QUE.PRN'.
  329.  
  330. 03/27/90 ver 1.01d - Second public release.
  331.       Changed the 'Local' profile configuration option to 'Echo/Duplex',
  332.       because the local setting makes no sense for a dialup service and
  333.       sometimes you do need to change the 'Echo' parameter.
  334.  
  335. Again, enjoy.
  336.  
  337. Stephen Jenkins
  338. T/S macroware
  339. 3/27/1990
  340.