home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / 1997 / 904.ZIP / README.TXT < prev    next >
Encoding:
Text File  |  1997-01-23  |  11.3 KB  |  255 lines
  1.   ========================================================================
  2.     (c) Martin N Dunstan  (mnd@dcs.st-andrews.ac.uk)  January 22nd, 1996
  3.   ========================================================================
  4.  
  5. Program:
  6.    Txt2Agn
  7.  
  8.  
  9. Version:
  10.    1.00
  11.  
  12.  
  13. Platforms:
  14.    Psion 3a, 3c and Siena. Also runs on the Acorn Pocketbook II.
  15.  
  16.  
  17. Purpose:
  18.    Convert a plain text file of dates and events into an Agenda file.
  19.    Examples of use include converting rota sheets prepared in a spreadsheet
  20.    or simply processing a timetable from work. An example of the input file
  21.    (using dd/mm/yy format) is:
  22.  
  23.       14/2/97 Valentines day
  24.       25/12/97 Christmas day
  25.       25/12/1997 Visit parents
  26.  
  27.    Invalid dates are detected and can be corrected by the user or
  28.    automatically by the program. A variety of preference settings are
  29.    available to control the conversion process and context-sensitive help is
  30.    accessible at all times.
  31.  
  32.  
  33. Author:
  34.    Martin N Dunstan (mnd@dcs.st-andrews.ac.uk)
  35.        (http://www-theory.dcs.st-andrews.ac.uk/~mnd/)
  36.  
  37.  
  38. Txt2Agn is available from:
  39.    http://www-theory.dcs.st-andrews.ac.uk/~mnd/export/txt2agn
  40.    ftp://www-theory.dcs.st-andrews.ac.uk/user/mnd/txt2agn
  41.  
  42.  
  43. Registration:
  44.    This program is shareware - if you find it useful please register
  45.    your copy by sending your name and a UK cheque for รบ5 to the
  46.    address below. Please include your email address (if you have one)
  47.    so that I can inform you of your code which will remove the nag
  48.    screens and the "annoying window".
  49.  
  50.       Martin Dunstan
  51.       1 Cupar Mills,
  52.       Cupar,
  53.       Fife KY15 5EH
  54.       U.K.
  55.  
  56.    If you live outside the UK you might want to use a service such as Ruesch
  57.    International Financial Services (details of this can be found on the
  58.    Web page http://www.os.qub.ac.uk/nifhs/ruesch.html) to obtain a UK cheque
  59.    relatively cheaply. 
  60.  
  61.  
  62. Installation:
  63.    1) Create a \APP\TXT2AGN directory on the internal drive (M:)
  64.    2) Copy TXT2AGN.OPA into a \APP directory
  65.    3) Copy TXT2AGN.AGN into a \APP\TXT2AGN directory (note that PsiWin may
  66.       complain that this is non-standard - continue anyway!)
  67.    4) Create a \TXT directory
  68.    5) Place any files to be converted into \TXT
  69.    6) Choose "Install" from the "Apps" menu (Psion-I) and
  70.       select Txt2Agn. Press ENTER to install it.
  71.  
  72.    You can place TXT2AGN.OPA in a \APP directory on any drive. You can also
  73.    place TXT2AGN.AGN in a \APP\TXT2AGN directory on any drive.
  74.  
  75.  
  76. Memory usage:
  77.    Txt2Agn.opa ....  22K
  78.    Txt2Agn.rsc .....  0K
  79.    Txt2Agn.agn .....  0K
  80.    User memory ..... 12K
  81.    System memory ... 30K
  82.    Total ........... 64K
  83.  
  84.  
  85. Tutorial:
  86.    This section briefly describes the use of Txt2Agn on the demo file
  87.    DEMO.TXT that accompanies the distribution. It assumes you have
  88.    installed the application as described in the previous section and copied
  89.    the DEMO.TXT file in a \TXT directory. Note that this file has a number of
  90.    faulty entries for the purposes of example.
  91.  
  92.    1) From the system screen highlight the DEMO file listed under the Txt2Agn
  93.       icon (try pressing the System button if it can't be seen). Press ENTER
  94.       to start the application.
  95.  
  96.    2) A title screen will appear followed by a window asking you to register.
  97.       Try pressing the Help key - this will normally bring up context
  98.       sensitive help at other dialogs. If you have been sent your
  99.       registration code press R otherwise press C to continue.
  100.  
  101.    3) Having pressed C an "annoying window" will appear - this will not be
  102.       present in registered versions. After a brief pause the preferences
  103.       dialog will appear. The settings here are stored ready for the next
  104.       time you use the program.
  105.  
  106.    4) Use the up and down arrow keys to move between the options and the left
  107.       and right arrow keys to cycle through the choices for each option. To
  108.       leave the program at this point press Escape. Dealing with each of the
  109.       options in turn:
  110.  
  111.       a) Errors: this controls how the program behaves when an error is found
  112.          in the input file (an illegal date).
  113.  
  114.          Ignore:   any illegal entries will be skipped.
  115.          Auto-fix: the program will try and guess what date you really meant
  116.                    when an illegal entry is found.
  117.          Ask user: Illegal entries will be displayed in a dialog box for the
  118.                    user to correct or skip over.
  119.  
  120.          I will assume "Ask user" is selected.
  121.  
  122.       b) Dates: choose the date format used in the input file. This may be
  123.          either dd/mm/yy or mm/dd/yy.
  124.  
  125.       c) Logfile: if set to "On" then any errors will be written to the
  126.          logfile specified on the next two lines.
  127.  
  128.    5) Press M to get more options and another dialog box will appear. The two
  129.       choices are:
  130.  
  131.       a) Partial dates: assuming we are using the dd/mm/yy date format then a
  132.          partial date is one which has the year or even the month missing. If
  133.          partial dates are allowed then the program uses the current year and
  134.          month to fill in the missing information. Thus if today is January
  135.          22nd, 1997 then 25/4 stands for April 25th 1997 and 28 stands for
  136.          January 28th 1997. If partial dates are not allowed then they are
  137.          considered to be an error and the program will act accordingly
  138.          (ignore them, fix them or ask the user).
  139.  
  140.       b) Logfile: use this setting to control what happens if logging is
  141.          turned on and the logfile already exists. If "always overwrite" is
  142.          selected then the logfile will be deleted without asking or telling
  143.          the user.
  144.  
  145.       Press Enter when you've set things up the way you want and you will be
  146.       returned to the previous dialog. Press Enter to move on to the next
  147.       dialog. If the logfile already exists and you haven't chosen the
  148.       "always overwrite" mode you will be asked if you want to overwrite it.
  149.       Pressing N will return you to the preferences dialog so that you can
  150.       you can choose another filename.
  151.  
  152.    6) At this dialog you are requested to provide the name of the Agenda file
  153.       you want to create. The program will supply a default name based on the
  154.       name of the input file. Thus converting DEMO.TXT will mean DEMO.AGN is
  155.       the default Agenda filename. Either type in a new name or press TAB and
  156.       use the Psion file selector to overwrite an existing file. Press Escape
  157.       to quit the program.
  158.  
  159.    7) Press ENTER when you have selected a file - if it already exists you
  160.       will be asked if you wish to overwrite it. Pressing N will return you
  161.       to the file selection dialog; Escape will quit the program.
  162.  
  163.    8) A progress indicator (sliderbar) will appear on the screen with the
  164.       title "Creating Agenda file". There will be an initial pause of about 7
  165.       seconds while the indicator is 1/3 filled and then it will quickly
  166.       reach the filled state. Pressing Escape will pause the program and you
  167.       will be asked if you want to quit. Pressing N will allow the conversion
  168.       to continue while Y will stop the program. Note that the program will
  169.       be slow to react to the key press so you should press Escape firmly
  170.       once and then wait for a second or two.
  171.  
  172.    9) The first indicator will be replaced by a second which shows how much
  173.       of the input file has been processed. I you are converting the demo
  174.       file with error mode set to "Ask user" then about 3/4 of the way
  175.       through the input file a dialog box will appear asking you to fix the
  176.       mistake.
  177.  
  178.       Press Escape to skip the entry otherwise correct it by using the arrow
  179.       keys to select the faulty date and typing the correct one in it's
  180.       place. Part of the line that was causing the problem is shown for
  181.       reference at the top of the window. Press Enter when you are satisfied
  182.       with the entry.
  183.  
  184.   10) Another faulty entry will appear (assuming "ask user" mode which should
  185.       be dealt with as before.
  186.  
  187.   11) Once the whole file has been processed the program checks to see if any
  188.       errors were noted in the logfile (i.e. error logging was on and at
  189.       least one error occurred). If so a window will appear informing the
  190.       user of this.
  191.  
  192.   12) Finally, if the program is unregistered you will be given the
  193.       opportunity to do so!
  194.  
  195.   13) If errors were found you should check the logfile for details. This
  196.       file is plain text and can be examined using the Word application or
  197.       any other text reader.
  198.  
  199.  
  200. Hints:
  201.    * Make sure the program always has logging turned on if you are converting
  202.      files in "ignore" or "auto-fix" mode and check the logfile afterwards to
  203.      see what happened if any errors occurred.
  204.  
  205.    * Run in "ask user" mode - usually there would be no errors and thus no
  206.      need for user intervention. If any errors do appear then it is probably
  207.      quicker to fix them during conversion rather than do it later in Agenda.
  208.  
  209.    * If you already have a \TXT directory which you use to keep other text
  210.      files in try using the "Create new list" option from the "Special" menu
  211.      on the system screen. Refer to the Psion User Guide for details.
  212.  
  213.  
  214. Frequently asked questions:
  215.    Q) How can I control the settings of the Agenda files produced by Txt2Agn
  216.       (e.g. diamond list, printing)?
  217.    A) Use Agenda to load \APP\TXT2AGN\TXT2AGN.AGN and change any settings you
  218.       want. Make sure the file is saved and quit Agenda. The next time you
  219.       use Txt2Agn the new settings will be used.
  220.  
  221.       An alternative method is to open an Agenda file which has already been
  222.       configured and use the "Merge" option in Agenda.
  223.  
  224.    Q) Why can't I enter dates after the year 2049 or before 1970?
  225.    A) This is due to limits imposed by the Psion OS. The text converter will
  226.       recognise dates outside this range but the Agenda program may not be
  227.       able to display them!
  228.  
  229.    Q) Why doesn't auto-fix mode work very well?
  230.    A) It is extremely difficult (impossible generally!) to correctly guess
  231.       what date the user actually meant. Thus the program simply works back
  232.       to find the first valid date prior to the illegal one. Hence 12/13/98
  233.       is guessed as being 12/12/98 and 31/09/04 is guessed as 30/09/04.
  234.  
  235.    Q) Can I use four figure years such as 1997 instead of 97?
  236.    A) Yes but you are only allowed years between 1970 and 2069.
  237.  
  238.    Q) How can I quit from the program once it has started?
  239.    A) From the main dialogs you can leave the program by pressing the Escape
  240.       key. If the program is actually creating the Agenda file or processing
  241.       the input file Escape will pause the program and give you the chance to
  242.       quit.
  243.  
  244.       If you really need to stop the program urgently hold down the Psion key
  245.       and press Escape. If this fails choose "Kill Application" from the
  246.       "Apps" menu on the system screen. If you use any of these emergency
  247.       exits you should remove the Agenda file that was being created as it
  248.       will be corrupted and might crash the Agenda program if you try to use
  249.       it inadvertently.
  250.  
  251.   ========================================================================
  252.     (c) Martin N Dunstan  (mnd@dcs.st-andrews.ac.uk)  January 22nd, 1996
  253.   ========================================================================
  254.  
  255.