home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 2224.dms / in.adf / docs / event-doc.pp / event-doc
Encoding:
Text File  |  1990-09-13  |  16.2 KB  |  463 lines
  1.  
  2.                              ////// //  // //////
  3.                               //   //  // //
  4.                              //   ////// /////
  5.                             //   //  // //
  6.                            //   //  // //////
  7.   
  8.  
  9.        //   //  /////  // //   //    ////// //   // ////// //   // //////
  10.       /// ///  // //  // ///  //    //     //   // //     ///  //   //
  11.      /////// /////// // //// //    /////  //   // /////  //// //   //
  12.     // / // //   // // //  ///    //      // //  //     //  ///   //
  13.    //   // //   // // //   //    //////   ///   ////// //   //   //
  14.    
  15.                                             Timespan Software V1.0 © 1992
  16.                                             ~~~~~~~~~~~~~~~~~~~~~~   ~~~~
  17.   
  18.               The Main Event - An Amiga Event Processor
  19.    
  20.    
  21.  
  22.    What is an event processor ?
  23.    ~~~~~~~~~~~~~~~~~~~~~~~~~~
  24.    
  25.    
  26.    An event processor is basically a dedicated timer system that allows
  27.    user selected actions to occur at given dates and times. The action or
  28.    "event" could be running a specific program or displaying a reminder.
  29.    These events are collated and formed into a file using an editor, the
  30.    event processor when run reads this file and causes the required events
  31.    to occur according to the system time, therefore a real-time clock is
  32.    essential to automate the event processor within your startup-sequence.
  33.    The Main Event consists of two such programs - "EventED" a dedicated
  34.    event editor and "MainEvent" a stand alone event processor. The Main
  35.    Event allows you to select between five types of event:
  36.    
  37.    [1]   CLI Command    -   Run a Shell/CLI command string
  38.    [2]   Post Message   -   Display chosen text in a workbench window
  39.    [3]   Show Date/Time -   Display date & time etc using the above window
  40.    [4]   Flash Screens  -   Flash all open screens
  41.    [5]   Display Alert  -   Display chosen text as an alert
  42.    
  43.    
  44.    
  45.    What can I use it for ?
  46.    ~~~~~~~~~~~~~~~~~~~~~
  47.    
  48.    
  49.    Anything, the ability to post messages allows you to run a daily memo on
  50.    significant days ie. birthdays/anniversaries etc. It is assumed that the
  51.    alert would be used only where a resonse MUST be obtained, and therefore
  52.    used only for very important reminders. Both the screenflash and the
  53.    date/time options are recommended as general prompts, for example every
  54.    five minutes from 15:00 or on the 15mins/hour etc. As The Main Event
  55.    also permits the user to run programs, the possibilities are limited
  56.    only by the user's software collection. Slide shows, backup programs,
  57.    playing music, can all be run at chosen dates(or days), and times. All
  58.    events can also repeat at user selected time intervals. MainEvents's
  59.    functions are described in detail at a later stage. 
  60.    
  61.    
  62.    
  63.    How do I install The Main Event ?
  64.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  65.    
  66.    
  67.    The event processor "MainEvent" should be copied to the your C:
  68.    directory. The event editor "EventEd" can be used direct from this disk
  69.    or copied to your system disk using either the workbench or CLI. Two
  70.    versions are available for 1.3 and 2.0 configurations.
  71.    
  72.    The 1.3 version of the editor requires the ARP library to exist within
  73.    the user's LIBS: directory, however "MainEvent" does not.
  74.    
  75.    The 2.0 version of the editor requires the ASL library. As with
  76.    the former version this requirement is for the editor only.
  77.    
  78.    
  79.    
  80.    
  81.    
  82.    EventED
  83.    """""""
  84.    
  85.    How do I run the editor ?
  86.    ~~~~~~~~~~~~~~~~~~~~~~~
  87.    
  88.    
  89.    Via workbench     - Click on the EventED icon
  90.   
  91.    Via the Shell/CLI - VOL:Dir/EventEd
  92.    
  93.    As with any other form of editor, EventEd assumes responsibility for 
  94.    loading/editing/saving files.
  95.    
  96.    
  97.    [1] Trial version
  98.  
  99.    EventEd maintains up to 20 events in any project. Files are valid for up
  100.    to one month from the project's creation date.
  101.    
  102.    [2] Registered version 
  103.  
  104.    EventEd maintains up to 50 events in any project. Files are always
  105.    valid. Also your registration details are displayed on the the "About 
  106.    Program" window available from the project menu.
  107.    
  108.    
  109.    
  110.    The Gadgets
  111.    ~~~~~~~~~~~
  112.    
  113.    [1]    Highlight Gadgets
  114.         
  115.         MON TUE WED ... SUN    -  Days in week 
  116.         
  117.         01 02 03 04 ... 30     -  Dates in month }
  118.                                                   } Use both to select date
  119.         JAN FEB MAR ... DEC    -  Months in year }
  120.         
  121.         These gadgets interact ie if MON/FEB/APR/21 gadgets were selected
  122.         then Feb 21st, Apr 21st, and every Monday is assumed.
  123.         
  124.         
  125.    [2]  Tick Gadgets
  126.         
  127.         At Startup ......      -  Event occurs as MainEvent is run
  128.         
  129.         Event At ........      -  Event occurs at chosen time
  130.         
  131.         Use intervals ...      -  Event repeats at chosen intervals
  132.         
  133.         These choices are only queried if any of the above day or date 
  134.         selections match the current day/date. Once again all selections
  135.         are interactive for example:
  136.         
  137.         At Startup + Event At  = occurs when run and at nn:nn hours
  138.         Event At + Intervals   = occurs at nn:nn and every nn:nn
  139.         At Startup + Intervals = occurs at startup and every nn:nn
  140.         
  141.         If all three are selected then event occurs at startup, again at
  142.         nn:nn then every nn:nn intervals.    
  143.           
  144.         
  145.    [3]  Time Gadgets
  146.    
  147.         Enter time into these gadgets using the 24 hour clock, if you enter
  148.         figures in excess of 23 hours/59 minutes then only the modulo is
  149.         used. ie if 37 hours are input the end result is 13, if the return
  150.         key is used to end input then this result is displayed immediately.
  151.         
  152.    
  153.    [4]  String Gadget
  154.    
  155.         Just the one universal string gadget, enter chosen text for your
  156.         command line/message here. Please note that text used to post
  157.         messages is restricted to the visible text entry area.
  158.                 
  159.    
  160.    [5]  Cycle Gadget
  161.    
  162.         This gadget cycles between the various event options as shown
  163.         above. Simply click to select the next option.
  164.         
  165.    
  166.    [6]  Action Gadgets
  167.   
  168.         Reset     -  Revert to event in memory 
  169.      
  170.      ««««      -  Move to previous event
  171.      
  172.      »»»»      -  Move to next event
  173.      
  174.      Clear     -  Clear this event
  175.      
  176.      Abort     -  Quit EventEd
  177.         
  178.    
  179.    
  180.    The Project Menu
  181.    ~~~~~~~~~~~~~~~~
  182.    
  183.         New            -  Clears the current project
  184.         
  185.         Open...        -  Open an event file using the requester
  186.         
  187.         Save           -  Save the current project using the file requester
  188.                           if the project is still untitled
  189.         
  190.         Save As...     -  Save the current project using the file requester
  191.  
  192.         About...       -  Shows version No. and registration details
  193.                           
  194.         Quit Editor    -  Quit the editor program, any event project still
  195.                           running is NOT stopped
  196.    
  197.                            
  198.  
  199.    The Edit Menu
  200.    ~~~~~~~~~~~~~        
  201.    
  202.         Cut            -  Copies the displayed event to the buffer and then
  203.                           clears the event displayed
  204.                           
  205.         Copy           -  Copies the displayed event to the buffer
  206.                           
  207.         Paste          -  Copies the buffer to the displayed event
  208.         
  209.         Clear          -  Clears the displayed event
  210.         
  211.         Undo           -  Copies the current event (from memory) to the
  212.                           displayed event
  213.                             
  214.         Select All     -  Selects all tick and highlight gadgets
  215.         
  216.  
  217.    
  218.    The MainEvent Menu
  219.    ~~~~~~~~~~~~~~~~~~
  220.         
  221.         Run            -  The event processor "MainEvent" is launched with
  222.                           a copy of the events currently being edited
  223.  
  224.         Stop           -  Terminate MainEvent if it was run from the
  225.                           editor
  226.                            
  227.         Stop All       -  Terminate all MainEvent programs regardless of
  228.                           their origin
  229.                 
  230.    
  231.    
  232.    The Settings Menu
  233.    ~~~~~~~~~~~~~~~~~
  234.         
  235.         Create Icons ? -  Allows the editor to save a project icon when
  236.                           saving event files. Note the icon saved with
  237.                           your project allows you to run MainEvent - the
  238.                           event processor, NOT the editor. In order to
  239.                           utilise these icons, MainEvent should be placed
  240.                           within your "C:" directory.
  241.                              
  242.         
  243.    
  244.    The Keyboard
  245.    ~~~~~~~~~~~~
  246.    
  247.    Right cursor        -  Moves to next event
  248.    
  249.    Left cursor         -  Moves to previous event
  250.    
  251.    Shift/right cursor  -  Moves to last non-clear event, if already past
  252.                           this point moves to the last available event
  253.                           
  254.    Shift/left cursor   -  Moves to the first event
  255.    
  256.    Escape key          -  Quit editor
  257.    
  258.    
  259.    Keyboard shortcuts for the menu items are as follows:
  260.    
  261.    Right Amiga + A     -  Save As... 
  262.    Right Amiga + C     -  Copy
  263.    Right Amiga + K     -  Stop All (Kill) 
  264.    Right Amiga + N     -  New  
  265.    Right Amiga + O     -  Open...
  266.    Right Amiga + Q     -  Quit Editor 
  267.    Right Amiga + R     -  Run
  268.    Right Amiga + S     -  Save 
  269.    Right Amiga + V     -  Paste
  270.    Right Amiga + X     -  Cut
  271.    Right Amiga + Z     -  Undo
  272.    
  273.    
  274.    
  275.    Error Messages
  276.    ~~~~~~~~~~~~~~
  277.    
  278.    [1]   ERROR - Can't initialise editor
  279.    The system will not allow EventEd the resources it is asking for,
  280.    usually this will only occur if memory is very low.
  281.    
  282.    [2]   ERROR - Can't Open "Events" file
  283.    You have selected a non-existant filename (via the requester) the file
  284.    is read only, or AmigaDos is unable to find your file. Use "RETRY" and
  285.    select the correct file.
  286.    
  287.    [3]   ERROR - File not "Events" file
  288.    You have selected a file that has not been saved by the event editor,
  289.    select "RETRY" and select an events file.
  290.    
  291.    [4]   ERROR - Can't save "Events" file
  292.    You have selected an incorrect filename, the volume is locked, full 
  293.    protected or non-existant. Use "RETRY" and select a valid filename.
  294.    
  295.    [5]   ERROR - Can't locate "MainEvent"
  296.    The Event processor "MainEvent" should be placed in your C: directory.
  297.    EventED searches both the C: directory and the current directory for
  298.    MainEvent and if not found issues this message. Copy MainEvent to
  299.    the C:directory.
  300.    
  301.    [6]   ERROR - Can't stop "MainEvent"
  302.    EventEd has tried to abort one or more instances of MainEvent and failed.
  303.    In practice this should never happen, however it is posssible if an
  304.    earlier project has been suspended or an alert is in progress.
  305.    
  306.    [7]   NOTE - Current project not saved
  307.    The action you are about to undertake will overwrite the current
  308.    project which has been edited since the the last save/load. Choose
  309.    retry to continue, or cancel to stop your intented action.
  310.    
  311.    
  312.    
  313.    
  314.    
  315.    MainEvent
  316.    """""""""
  317.       
  318.    How do I start the event processor ?
  319.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  320.    
  321.    Via workbench     - Click on the project's icon
  322.                        (Only if the editor is allowed to create icons)
  323.   
  324.   
  325.    Via the shell/cli - Run >Nil: <Nil: MainEvent [event.filename]
  326.    
  327.    
  328.    Via the editor    - Select "Run" from the "MainEvent" menu to launch
  329.                        MainEvent with the project being edited.
  330.    
  331.    
  332.    To initiate MainEvent whilst your workbench loads 1.3 users should
  333.    include "Run >Nil: <Nil: MainEvent [File]" within their startup
  334.    sequence.  2.x users can include this same command within their User-
  335.    Startup, or if you have allowed the editor to create icons when saving
  336.    your project then drop the relevant project icon into the WB_Startup
  337.    draw.
  338.    
  339.    If no filename is passed to MainEvent then the default filename S:events
  340.    is assumed, if this file cannot be found then MainEvent will terminate.
  341.    Assuming that your file exists and is of the proper type, if no other
  342.    events happen at startup then a date and time display will occur in
  343.    order to indicate that your file has been found and the program is 
  344.    running.
  345.    
  346.    As MainEvent starts, it checks to see if an identical project exists, if
  347.    so then the existing project is terminated (if possible) and MainEvent
  348.    then reads the new file and proceeds as normal. Hardware resources are
  349.    the only limitation to the number of projects possible, as long as unique
  350.    filenames are used. Note that S:TimeFile and Sys:Events/Timefile would
  351.    NOT be considered unique as MainEvent compares basenames only.
  352.    
  353.    
  354.    
  355.    How do I stop MainEvent ?
  356.    ~~~~~~~~~~~~~~~~~~~~~~~
  357.    In order to terminate the event processor from the editor, use the "Stop
  358.    All" option within the event editor's menu.
  359.    
  360.    From the shell use MainEvents Kill option, enter "MainEvent    KILL" at
  361.    the Shell prompt. MainEvent will then attempt to abort all projects,
  362.    report as to it's success, and then terminate.
  363.    
  364.    As MainEvent only operates once every minute, very little computer time
  365.    is demanded, and you should not be aware of the program running until
  366.    an event occurs.
  367.    
  368.    
  369.    
  370.    MainEvent's Functions
  371.    ~~~~~~~~~~~~~~~~~~~~~
  372.    
  373.    
  374.    The event processor searches the event file, checks the event date/time
  375.    against the system date/time, If there is a match the event occurs, then
  376.    the next event is compared. As of version 1.0, MainEvent is capable of
  377.    causing five types of events.
  378.    
  379.    
  380.    [1]   CLI Command
  381.    
  382.          This function uses the "Run" command, therefore in order to use it
  383.          this command must exist. Input from the editor's string gadget is
  384.          treated as though it is a shell/CLI command line. Your command is
  385.          automatically run for you, do **NOT** use the run command. In most
  386.          cases the full file path should be given for both the command and
  387.          any filename arguments required. To run more than one command
  388.          within the same event would require the use of an AmigaDos script,
  389.          the following format should be used :
  390.  
  391.                       Execute VOL:Dir/MyScript
  392.    
  393.         
  394.    [2]   Post Message
  395.    
  396.         Input from EventED's string gadget is displayed in MainEvent's
  397.         workbench window. This window stays open for five seconds, a
  398.         click anywhere within the window closes it immediately. Should
  399.         workbench be closed, this function is aborted. If you are using
  400.         another screen and the workbench screen is hidden from veiw, then
  401.         the message window may remain unseen. (To force you back to the
  402.         workbench screen and possibly having to open it first is very
  403.         unfriendly and could be extremely tiresome.) However in most
  404.         circumstances this should not be a problem.
  405.  
  406.  
  407.    [3]   Show Date/Time
  408.  
  409.      A date/day/time string is used and a message posted as above.
  410.          
  411.    
  412.    [4]   Flash Screens
  413.    
  414.         All open screens are flashed - A la Intuition.
  415.         
  416.         
  417.    [5]   Display Alert  -   Display chosen text as an alert
  418.    
  419.          Input from EventED's string gadget is used to create a custom
  420.          recoverable Alert. All other subsequent events have to wait for
  421.          user response to each alert. This may prevent some events from 
  422.          actually happening. 
  423.          
  424.          
  425.  
  426.    Registration
  427.    ~~~~~~~~~~~~
  428.    
  429.    All registered users receive the full versions of these programs in both
  430.    1.3 and 2.0 configurations.
  431.    
  432.    To register send £5:00 to the address shown below - please state your
  433.    full name.
  434.    
  435.    Your registered copy is NOT public domain, please do not pass copies
  436.    around. The registered user's details on the "About Program" window are
  437.    designed to encourage users to purchase their own copy, not copy yours.
  438.    Only the trial version is public domain and may be freely distributed.
  439.  
  440.    The trial version of "The Main Event" is available to genuine public
  441.    domain libraries (at no cost) with details of their library and phone
  442.    number etc shown on the "About Program" window. 
  443.    
  444.    
  445.    
  446.    Disclaimer
  447.    ~~~~~~~~~~
  448.    
  449.    Although every attempt has been made to ensure these programs are bug
  450.    free, no warranty is given or implied as to the suitability of this
  451.    software.
  452.    
  453.    
  454.    Please send bug reports or suggestions to:
  455.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  456.    
  457.    Timespan Software
  458.    49 Craydene Road
  459.    Erith
  460.    Kent      DA8 2HA
  461.  
  462.  
  463.