home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / UTILS / SNDOFF2 / MANUAL.TXT next >
Encoding:
Text File  |  1994-11-23  |  24.3 KB  |  556 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                                  Sound Off 2.0
  17.  
  18.                                 Psion Series 3a
  19.  
  20.  
  21.                               Pelican Software Inc.
  22.  
  23.  
  24.                                        
  25.  
  26.                                 TABLE OF CONTENTS
  27.  
  28.  
  29.  
  30.  
  31.      About Sound Off/Getting Started . . . . . . . . . . . . . . . . . .  0-1
  32.      Registering Sound Off . . . . . . . . . . . . . . . . . . . . . . .  0-2
  33.      Installation  . . . . . . . . . . . . . . . . . . . . . . . . . . .  0-3
  34.      New in Version 2.0  . . . . . . . . . . . . . . . . . . . . . . . .  0-4
  35.  
  36.      Event
  37.         New  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1-1
  38.         Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1-2
  39.         Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  1-3
  40.         Cancel Current . . . . . . . . . . . . . . . . . . . . . . . . .  1-4
  41.         View Description . . . . . . . . . . . . . . . . . . . . . . . .  1-5
  42.  
  43.      Search
  44.         Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  2-1
  45.         Find Again . . . . . . . . . . . . . . . . . . . . . . . . . . .  2-2
  46.  
  47.      Agenda
  48.         Read Agenda  . . . . . . . . . . . . . . . . . . . . . . . . . .  3-1
  49.         Select Agenda File . . . . . . . . . . . . . . . . . . . . . . .  3-2
  50.         Change Special Character . . . . . . . . . . . . . . . . . . . .  3-3
  51.         Enable/Disable Auto Search . . . . . . . . . . . . . . . . . . .  3-4
  52.         Force Auto Search  . . . . . . . . . . . . . . . . . . . . . . .  3-5
  53.  
  54.      Special
  55.         Version  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  4-1
  56.         Set Sound  . . . . . . . . . . . . . . . . . . . . . . . . . . .  4-2
  57.         Reconfigure Sound. . . . . . . . . . . . . . . . . . . . . . . .  4-3
  58.         About Sound Off  . . . . . . . . . . . . . . . . . . . . . . . .  4-4
  59.         Exit  . .  . . . . . . . . . . . . . . . . . . . . . . . . . . .  4-5
  60.  
  61.      Miscellaneous
  62.         Resizing Window  . . . . . . . . . . . . . . . . . . . . . . . .  5-1
  63.         Repeats  . . . . . . . . . . . . . . . . . . . . . . . . . . . .  5-2
  64.         Key Commands . . . . . . . . . . . . . . . . . . . . . . . . . .  5-3
  65.         Emergency Shut-Off . . . . . . . . . . . . . . . . . . . . . . .  5-4
  66.         Overlapping Events . . . . . . . . . . . . . . . . . . . . . . .  5-5
  67.         What will Sound Off do to my Agenda file?  . . . . . . . . . . .  5-6
  68.  
  69.                                      
  70.      ABOUT Sound Off/Getting Started                                   0-1
  71.      ─────────────────────────────────────────────────────────────────────
  72.  
  73.      Sound Off is a simple but much needed utility for the Psion Series 3a.
  74.      It is simple only in that it performs a simple function. The programming
  75.      is not simple to accomplish this task, but it was well worth the effort,
  76.      as you will see.
  77.  
  78.      Have you ever been in a meeting and had the Series 3a alarm start ringing.
  79.      It can be embarrassing. Sound OFF will stop that from happening again.
  80.  
  81.      Here's how it does it.
  82.  
  83.      Sound Off lets you build a database of events. An event represents a future
  84.      time and date when the sound should be turned off.
  85.  
  86.      Sound Off will wake up the machine at the minute you want the sound
  87.      turned off. The sound will be turned off by Sound Off. After the event
  88.      duration is completed the machine wakes up and the sound is turned back
  89.      on so you won't miss any future alarms.
  90.  
  91.      The next earliest event will then be queued. If the event that just
  92.      terminated is repeatable, the time/date of that event will be updated
  93.      before finding the next earliest event.
  94.  
  95.      Getting Started
  96.      ───────────────
  97.  
  98.  
  99.      When you first start Sound Off you will be prompted to show the program
  100.      your standard sound settings. This is so that the program will know what
  101.      settings to return your sound to when it turns the sound back on. Choose
  102.      "Re-configure sound" to change these settings at a later date. The program
  103.      does this since when you start up Sound Off your sound may be off, and
  104.      SndOFF would not know what your standard ON settings are.
  105.  
  106.      Press <Enter> to set a New Event. Type in a name for the event. Next type
  107.      in the date, time and duration of the event. Finally using some code
  108.      borrowed from the Pelican Alarm Server, you can make the event repeatable,
  109.      which quickly becomes a necessity with a program like this. This way you
  110.      only have to enter the event time & date once.
  111.  
  112.      For example if you get up every morning to go out and walk, and you don't
  113.      want an alarm going off while you're out walking, just set a Sound Off
  114.      event in the time slot that you normally go out, and make it a Daily
  115.      repeat.
  116.  
  117.      
  118.  
  119.  
  120.                                      
  121.      REGISTERING Sound Off                                             0-2
  122.      ─────────────────────────────────────────────────────────────────────
  123.  
  124.  
  125.      ┌─────────────────────────────────────────────────────────────────────┐
  126.      │                          S o u n d  O F F                           │
  127.      │                                                                     │
  128.      └─────────────────────────────────────────────────────────────────────┘
  129.      ╔═════════════════════════════════════════════════════════════════════╗
  130.      ║  1                        Sound is ON                              ║
  131.      ╟─────────────────────────────────┬───────────────────────────────────╢
  132.      ║     Event: Out to Walk          │            Timer Set              ║
  133.      ║      Date: 11/20/1994           │           "Out to Walk"           ║
  134.      ║      Time: 7:00:00 am           │        Sound will turn OFF        ║
  135.      ║  Duration: 01:00                │    12 Hours 16 min. remaining     ║
  136.      ║    Repeat: Daily                │                                   ║
  137.      ║                                 │                                   ║
  138.      ╚═════════════════════════════════╧═══════════════════════════════════╝
  139.             Sound Off Ver. 2.0  Copyright 1994 by Pelican Software Inc
  140.  
  141.  
  142.      Mailing Address:        Pelican Software Inc.
  143.                              P.O.Box 741072
  144.                              Houston, Tx. 77274-1072
  145.                              713-242-8928 (voice and fax)
  146.  
  147.  
  148.      Sound Off is Shareware from Pelican Software Inc. If you like it, you can
  149.      register it in a few ways. The price of the program is $20.00 USD. The
  150.      program is crippled in a few ways. You can only have 3 events unless you
  151.      register. When you register, you will receive a registration number that
  152.      will allow you to have as many events as you like. The Auto Search feature
  153.      is disabled until registering. The Emergency Shut-Off is also disabled.
  154.  
  155.      If you have Compuserve, you can register online by going to the "SWREG"
  156.      forum. There you can register Sound Off 2.0 and Compuserve will bill your
  157.      account. This is the easiest way.
  158.  
  159.              METHODS     . Compuserve "SWREG" ID = 3924
  160.                          . Send cash through the mail
  161.                          . Send a check through the mail made payable to
  162.                            Pelican Software Inc
  163.  
  164.  
  165.      Crippling: Until Registered, Sound Off will only allow 3 events, and
  166.      some features are disabled or partly disabled. The Auto Search feature
  167.      is the most powerful new feature. Read about it in the "NEW IN 2.0"
  168.      section.
  169.  
  170.                                      
  171.      INSTALLING Sound Off                                              0-3
  172.      ─────────────────────────────────────────────────────────────────────
  173.  
  174.      
  175.      ■ Copy Sndoff.opa into any \App directory.
  176.  
  177.      If you have an earlier version of SndOFF, the Sndoff.pic file is no
  178.      longer needed. You can delete this from the \App\Sndoff directory.
  179.  
  180.      Once you have copied the SndOff.opa file to your S3a, Press Psion<I>
  181.      from the system screen to install Sound Off. Change the disk selector to
  182.      the disk you installed Sound Off to. Select SndOff, and press Enter
  183.      to install it. If you need more help with this, see the section on
  184.      re-inserting icons in chapter 16 of the user manual for your Psion.
  185.  
  186.  
  187.  
  188.  
  189.                                      
  190.      NEW IN 2.0                                                        0-4
  191.      ─────────────────────────────────────────────────────────────────────
  192.  
  193.  
  194.      The newest features allow you to read your Agenda file, and easily bring
  195.      all timed appointments into the SndOFF database. This is done while in
  196.      the Agenda by adding a one character prefix to all appointments that you
  197.      want the sound to be turned off for. Sound Off will know that only
  198.      appointments marked with this prefix are events that should be brought
  199.      into the SndOFF database.
  200.  
  201.      There are five new menu options related to the new Agenda features.
  202.      These options are explained in section 3. (Agenda)
  203.  
  204.         <*> Indicates registered only
  205.  
  206.         Read Agenda                - Reads the Agenda file
  207.         Select Agenda File         - Select your default Agenda file
  208.         Change Special Character   - Sets the special character to search for
  209.        *Auto Search                - Unattended Auto Search of Agenda files
  210.                                      Unregistered imports only 1 event.
  211.        *Force Auto Search          - Causes an Auto Search to start now
  212.  
  213.  
  214.      Other New features:
  215.  
  216.           ■ Ctrl<Menu>, or Diamond key will resize the window.
  217.           ■ Pressing the O key will turn the machine off. (used to be space bar)
  218.           ■ Pressing the space bar will bring up a Description viewer.
  219.           ■ Descriptions can be slightly longer.
  220.           ■ Window size saved on Exit.
  221.           ■ User selectable location for support files.
  222.           ■ Compuserve SWREG supported.
  223.           ■ Emergency Shut-off (registered only).
  224.           ■ 2.0 closes down its windows when in backround to use less memory.
  225.             This frees up 10k when in backround.
  226.  
  227.  
  228.  
  229.                                      
  230.      NEW EVENT           SECTION 1 - Event Menu Heading                1-1
  231.      ─────────────────────────────────────────────────────────────────────
  232.      Psion<E>
  233.  
  234.      Use Psion<E>, Enter, or choose "New Event" from the Event pull-down menu
  235.      to create a new event in the SndOFF database. Do this when you want to
  236.      enter a new time for the machine to turn off.
  237.  
  238.      ■ Fill out the Description. (Give your event a name, like "Lunch meeting".)
  239.      ■ Enter the date. Must be a future date.
  240.      ■ Enter the time you want the sound to be turned off.
  241.      ■ Enter the duration of the event.
  242.      ■ Enter the repeat type. There are many repeat types. See the section on
  243.        repeats if you need help with this.
  244.  
  245.  
  246.  
  247.      UPDATE EVENT                                                      1-2
  248.      ─────────────────────────────────────────────────────────────────────
  249.      Psion<U>, Psion<Enter>
  250.  
  251.      Follow the same guidelines as "New Event". This just gives you the
  252.      opportunity of changing the details of an event.
  253.  
  254.  
  255.  
  256.      DELETE EVENT                                                      1-3
  257.      ─────────────────────────────────────────────────────────────────────
  258.      Psion<D>,Del
  259.  
  260.      Use this option when you want to delete an event from the SndOFF data-
  261.      base. Note that this won't let you delete the current event. You'll
  262.      need to use the "Cancel current" option to do this.
  263.  
  264.  
  265.  
  266.      CANCEL CURRENT EVENT                                              1-4
  267.      ─────────────────────────────────────────────────────────────────────
  268.      Psion<C>
  269.  
  270.      Cancel Current lets you cancel the current queued event. The sound
  271.      will be turned back on when you cancel an event.
  272.  
  273.  
  274.      VIEW DESCRIPTION                                                  1-5
  275.      ─────────────────────────────────────────────────────────────────────
  276.      Psion Shift<V>, spacebar
  277.  
  278.      This option will bring up a window with the full Description of the
  279.      event being viewed in the SndOFF database. Sometimes the event
  280.      description won't fit on the screen, so this lets you view the whole
  281.      text.
  282.  
  283.                                     
  284.      FIND              SECTION 2 - Search Menu Heading                 2-1
  285.      ─────────────────────────────────────────────────────────────────────
  286.      Psion<F>
  287.  
  288.      This option searches through the database to find a particular entry.
  289.      Press Psion<F> to bring up the "Find" dialog.
  290.  
  291.      ■ Type in a clue to search for, and press Enter. If SndOFF can find
  292.      a match, it will be brought to the front.
  293.  
  294.  
  295.  
  296.      FIND AGAIN                                                        2-2
  297.      ─────────────────────────────────────────────────────────────────────
  298.      Psion<G>
  299.  
  300.      Use this option after doing a search, when you want to find another
  301.      match using the same clue.
  302.  
  303.  
  304.  
  305.                                    
  306.      READ AGENDA           SECTION 3 - Agenda Menu Heading             3-1
  307.      ─────────────────────────────────────────────────────────────────────
  308.      Psion<R>
  309.  
  310.      This option starts by finding your Agenda file. If the Agenda is running,
  311.      it will do a safe shutdown. Next it will open the Agenda and start
  312.      searching for appointments. On finding a marked entry, you are given the
  313.      option of editing the data for use with SndOFF. Press Enter to save the
  314.      item to SndOFF, or press Escape to continue searching. When you're done,
  315.      SndOFF will restart your Agenda. Only future appointments are found unless
  316.      you set the "Bring in Old Entries" option.
  317.  
  318.  
  319.      SELECT AGENDA FILE                                                3-2
  320.      ─────────────────────────────────────────────────────────────────────
  321.      Psion<L>
  322.  
  323.      You must choose this option before you can read Agenda files. Show SndOFF
  324.      where you default Agenda file is. It must know this in order to know which
  325.      Agenda file to open.
  326.  
  327.               ----------------------------------------
  328.                 Show SndOff Your Default Agenda File
  329.                 . Default Agenda Name  <-filename->
  330.                                  Disk   internal
  331.                 . Character to Search for
  332.                 . Bring in Old Entries      <-No->
  333.               ----------------------------------------
  334.      Note that the "Character to Search" option allows you to enter a character
  335.      identifier for SndOFF to look for. SndOFF will only allow you to bring in
  336.      Agenda entries that begin with this character. This is the method you use
  337.      for telling SndOFF which appointments can be brought into the SndOFF data-
  338.      base.
  339.  
  340.      If it's still not clear, go into you Agenda. Go into the day view, and
  341.      press Enter to start a new entry. If your "Character" is a period<.>,
  342.      start by typing a period, and then the rest of your message. ( .This is a
  343.      test ) SndOFF will find this entry and pass over all others that don't
  344.      begin with your "Character". The character can be any character you can
  345.      type in. The entry must be a future entry when using Auto Search.
  346.  
  347.      "Bring in Old Entries" forces SndOFF to search even old entries as long
  348.      as they begin with your special character identifier. Turn this on only
  349.      when you need to bring in an old entry. Remember that in SndOFF you have
  350.      repeats. You may have an old entry that you want to bring-in because it
  351.      repeats. Note: This works when using "Read Agenda File", not Auto Search.
  352.  
  353.  
  354.      CHANGE SPECIAL CHARACTER                                          3-3
  355.      ─────────────────────────────────────────────────────────────────────
  356.      Psion<+>
  357.  
  358.      This just gives you a fast way to change the special character.
  359.  
  360.                                      
  361.      ENABLE/DISABLE AUTO SEARCH                                        3-4
  362.      ─────────────────────────────────────────────────────────────────────
  363.      Psion Shift<S>     Registered only
  364.  
  365.      This is an automated Agenda search that will import all marked
  366.      appointments from your Agenda that are set for the current day. This
  367.      allows you to use Sound Off entirely in the backround. The process
  368.      becomes completely automated. Here's how it works...
  369.  
  370.      When you choose to "Enable Auto Search", Sound Off will create a special
  371.      event called "<Auto Search>". The time and date of this event can be
  372.      edited, but not the Description. You should set the Auto Search to happen
  373.      first thing in the morning. When this event comes due, Sound Off will
  374.      automatically read your Agenda looking for todays appointments, adding
  375.      them to the Sound Off database. This all happens in the backround. This
  376.      event will repeat every day. Of course the Agenda entries must have your
  377.      special character prefix as the first character. (Section 3-3)
  378.  
  379.      To Disable Auto Search, you can't delete the Event. Instead use the
  380.      menu option "Disable Auto Search". This will delete the event for you.
  381.  
  382.      Note that when Auto Search adds events from your Agenda, it sets the
  383.      sound to turn off 1 minute after the event begins. This is to give you
  384.      a chance to respond to an alarm. You have one minute to respond to an
  385.      alarm reminding you of the event, and after this the sound is turned
  386.      off. Note that it doesn't matter that the machine is stuck waiting for
  387.      you to clear the alarm. Sound Off is still working in the backround.
  388.  
  389.  
  390.      FORCE AUTO SEARCH                                                 3-5
  391.      ─────────────────────────────────────────────────────────────────────
  392.      Psion<M>     Registered only
  393.  
  394.      Use this feature when you've made a change to your schedule during the
  395.      day. Sound Off will delete all of todays entries in the Sound Off data-
  396.      base, and re-open the Agenda to re-import todays appointments. Note
  397.      that only database entries brought in using the "Auto Search" method
  398.      are deleted. Database entries typed in from Sound Off are not deleted.
  399.  
  400.      When using "Force Auto Search" the Auto Search event is not changed
  401.      in any way. This is the best way to do an update of daily appointments
  402.      in the SndOFF database.
  403.  
  404.                                       
  405.      VERSION           SECTION 4 - Special Menu Heading                4-1
  406.      ─────────────────────────────────────────────────────────────────────
  407.      Psion<V>
  408.  
  409.      Brings up the version number in the top window.
  410.  
  411.  
  412.  
  413.      SET SOUND                                                         4-2
  414.      ─────────────────────────────────────────────────────────────────────
  415.      Psion<S>
  416.  
  417.      This does exactly the same thing as Pressing Psion<S> from the system
  418.      screen to set your sound.
  419.  
  420.  
  421.  
  422.      RE-CONFIGURE SOUND                                                4-3
  423.      ─────────────────────────────────────────────────────────────────────
  424.      Psion<Q>
  425.  
  426.      Use this option when you want to reset your default sound settings for
  427.      SndOFF. To explain this better, SndOFF needs to know what your standard
  428.      sound settings are so that when it turns your sound back on, it will
  429.      set all of your sound settings correctly. When you choose this option,
  430.      you are just showing the program what your default settings are.
  431.  
  432.  
  433.  
  434.      ABOUT SOUND OFF                                                   4-4
  435.      ─────────────────────────────────────────────────────────────────────
  436.      Psion<A>
  437.  
  438.      Tells you how to Register Sound Off.
  439.  
  440.  
  441.  
  442.      EXIT                                                              4-5
  443.      ─────────────────────────────────────────────────────────────────────
  444.      Psion<X>
  445.  
  446.      To exit the program.
  447.  
  448.  
  449.  
  450.  
  451.                                     
  452.      RESIZING WINDOWS       SECTION 5 - Miscellaneous                  5-1
  453.      ─────────────────────────────────────────────────────────────────────
  454.      Control<Menu>, Diamond key
  455.  
  456.      Resizes windows widths in the standard Psion way. There are three
  457.      window width choices.
  458.  
  459.  
  460.  
  461.      REPEATS                                                           5-2
  462.      ─────────────────────────────────────────────────────────────────────
  463.  
  464.      Here's a list of repeat types:
  465.  
  466.         Yearly             (same day next year. Knows about leap years)
  467.         Monthly by date    (same date next month)
  468.         Monthly by day     (same day of week , next month, like third Wed.)
  469.         Monthly(last day)  (last day of the month)
  470.         Weekly             (same day next week)
  471.         Daily              (Every day)
  472.         Workday            (next workday, based on your system settings)
  473.         Restday            (next restday, based on your system settings)
  474.         Every (x) days     (how ever many days you set)
  475.         Every (x) hours    (how ever many hours you set)
  476.  
  477.  
  478.      KEY COMMANDS                                                      5-3
  479.      ─────────────────────────────────────────────────────────────────────
  480.  
  481.      Psion<A>       About SndOFF
  482.      Psion<C>       Cancel Current
  483.      Psion<D>       Delete Event
  484.      Psion<E>       New Event
  485.      Psion<F>       Find Event
  486.      Psion<G>       Find Again
  487.      Psion<L>       Select Agenda File
  488.      Psion<M>       Force Auto Search   (registered version only)
  489.      Psion<Q>       Re-Configure sound
  490.      Psion<R>       Read Agenda
  491.      Psion<S>       Set sound
  492.      Psion Sh<S>    Enable/Disable Auto Search
  493.      Psion<U>       Update Event  ──────────┐
  494.      Psion<V>       Version                 │
  495.      Psion Sh<V>    View Description ─┐     │
  496.      Psion<X>       Quit              │     │
  497.                                       │     │
  498.      Spacebar       View Description ─┘     │
  499.      Psion<Enter>   Update   ───────────────┘
  500.      <O>            Off
  501.      Psion<+>       Change Special Character
  502.      Psion<Home>    Go to First Record
  503.      Psion<Eng>     Go to Last Record
  504.      Diamond key    Resize Windows ─┐
  505.      Control<Menu>  Resize Windows ─┘
  506.      Tab key        Emergency Shut-Off (registered version only)
  507.                                 
  508.  
  509.      EMERGENCY SHUT-OFF                                                5-4
  510.      ─────────────────────────────────────────────────────────────────────
  511.      Tab key            Registered only
  512.  
  513.      This feature is enabled when you register. Pressing the tab key brings
  514.      up a dialog where all you have to decide is how many hours you want the
  515.      machine sound off for. This is for the emergency situation when you
  516.      don't have the time to spend filling out the normal "New Event" dialog.
  517.  
  518.  
  519.  
  520.      OVERLAPPING EVENTS                                                5-5
  521.      ─────────────────────────────────────────────────────────────────────
  522.  
  523.      Note that Sound Off at this time doesn't handle overlapping events. In
  524.      other words you have to watch out not to schedule timed events that
  525.      overlap each other, and expect Sound Off to correctly turn the sound
  526.      off for these. It won't. Suppose you have a meeting at 6:00pm that you've
  527.      set for 1 1/2 hrs. and Dinner at 7:00pm. Sound Off will turn the sound
  528.      off at 6:01 pm and won't look for new events until 1hr 29min later. By
  529.      this time when the sound turns on, your Dinner appointment is considered
  530.      an old event and is dropped.
  531.  
  532.      There is a 2 minute minimum duration for an event in order for Sound Off
  533.      to work correctly. This only applies to events imported using the "Auto
  534.      Search" feature.
  535.  
  536.      Here's how it works:
  537.  
  538.      Sound Off starts an event 1 minute after the appointment time in the Agenda
  539.      file. It does this to give time for you to respond to a alarm if one was
  540.      set. Since it starts one minute late, it has to take one minute off of the
  541.      duration. An event with a one minute duration wouldn't work because
  542.      Sound Off would be starting the event, and the event would already have
  543.      finished. Sounds confusing, I know. Suffice it to say that back to back
  544.      events with a duration of one minute will not work.
  545.  
  546.  
  547.  
  548.      WHAT WILL Sound Off DO TO MY AGENDA FILE?                         5-6
  549.      ─────────────────────────────────────────────────────────────────────
  550.  
  551.      Nothing! It only opens your Agenda file for read only. Sound Off never
  552.      writes to your Agenda file, and therefore CANNOT corrupt it. You can use
  553.      Sound Off without fear.
  554.  
  555.  
  556.