fish/memomaster/mm2.doc

   1                         MemoMaster V2 Doc.
   2                         ~~~~~~~~~~~~~~~~~~
   3
   4 MM2 (MemoMaster V2) is one of those programs which can be used
   5 to avoid forgetting events such as your wedding anniversary.
   6 Instal it on the disk you generally boot with, record all those
   7 birthdays and any other events you feel you might need reminding
   8 of and you will be warned about them when they approach.
   9
  10 Installation.
  11
  12 Beginners:
  13
  14      Boot with the Workbench disk you wish to copy MM2 onto then
  15      double-click on the 'Install_MM' Icon.
  16      A MEMOS directory will be created if it doesn't already exist
  17      and MM2 will be copied over to your disk along with an Icon
  18      with suitable colours for your version of Workbench.
  19
  20      The startup-sequence will be modified for you to automatically
  21      run MM2 every time you boot up.
  22
  23    ** MAKE SURE YOU ARE USING A BACKUP COPY OF YOUR WORKBENCH DISK **
  24
  25      Please note;  You will need to make some space on a standard
  26      1.3 Workbench disk to make room for MM2.  I suggest you delete
  27      the contents of the PREFS drawer or some unwanted UTILITIES.
  28
  29      Workbench2 users will have just enough room on their WB disks
  30      but it is still recommended that you make some room for MEMOS.
  31
  32 Experienced users:
  33
  34      Put the program (MM2) into a location included in your PATH
  35      list. Insert the following two lines in your startup-
  36      sequence (after the PATH has been set up)-
  37           ASSIGN MEMOS: volume:dir/subdir
  38           MM2 check
  39      (NB - at present the word check must be in lower case
  40      letters). You may want to set up a configuration file in
  41      the directory in the above ASSIGN command but this is
  42      unlikely to be necessary. See the Colour Configuration
  43      section near the end of this document if the program seems
  44      to use the wrong colours from your preferences palette. You
  45      should now find that the program will run whenever you boot
  46      using the volume with MM2 installed. If no memos are due
  47      for a reminder, you will not be bothered by the program,
  48      otherwise you will get a requester containing the
  49      reminders. To run the program outside of startup-sequence
  50      (to maintain your list of memos) type "mm2" at a CLI/SHELL
  51      prompt or click on its icon from workbench.
  52
  53 Memo fields.
  54
  55      Date.
  56           Date in format dd-mmm-yy eg 23-feb-92. You can leave
  57           the year part blank or put in other characters if you
  58           like. You might do this if the memo refers to an event
  59           which occurs annually and you do not want the year
  60           recorded for some reason. For example, you might want
  61           to record a birthday but not know (or want to
  62           publicise) the year.
  63
  64      Notice.
  65           The number of days notice you require for this
  66           particular event. You might need 10 days to organise
  67           a birthday present but only need a couple of days
  68           notice of an agreed date to make a phone call. You can
  69           put values up to 99 here. Please remember that you
  70           will only get the reminder if you use your computer
  71           and only then if MM2 gets run.
  72
  73      Type.
  74           At present the program only recognises two types of
  75           memo. Annual ones (type = 'a' or 'A') and others. The
  76           only difference is that annual ones will pop up
  77           irrespective of the year part of the date field whereas
  78           you will only get reminded about others in the period
  79           specified by the full date and the notice required.
  80
  81      Text.
  82           60 characters of free text.
  83
  84 MM2 specific gadgets.
  85
  86      There are 18 custom gadgets on the MM2 window. A group of
  87      6 positions for displaying memos and 12 'action' gadgets in
  88      two rows.
  89
  90      The memo display gadgets can be clicked on to highlight
  91      memos to be acted on using some of the 'action' gadgets.
  92
  93      The upper row of action gadgets are concerned with movement
  94      around your list of memos and (left to right) have the
  95      following effects
  96           Move to beginning of list.
  97           Move back towards the beginning by 6 memos.
  98           Move back 1 memo.
  99           Move forward 1 memo.
 100           Move forward 6 memos.
 101           Move to end of list.
 102
 103      The lower row functions are as follows.
 104           - ADD displays a requester allowing you to add a new
 105           memo.
 106           - EDIT displays a requester allowing you to edit an
 107           existing memo. This will appear for each memo
 108           highlighted when the gadget is clicked on.
 109           - DELETE displays a requester asking you to confirm
 110           that you really wish to remove a memo from the list.
 111           This will appear once for each memo highlighted when
 112           the gadgets is clicked on.
 113           - CHECK looks through the list of memos and displays
 114           a requester to show any which are due. These are the
 115           ones which would be displayed if the program had been
 116           run using the command line "mm2 check". You will need
 117           to use this gadget particularly if you have started
 118           mm2 from workbench.
 119           - SHRINK removes the main mm2 window from the display
 120           and replaces it with a small substitute. You can move
 121           the small one out of the way in the normal manner by
 122           dragging the title bar. Clicking on the central
 123           portion of the window will restore the main mm2
 124           window. If you then SHRINK again, the small window
 125           will reappear where you left it last time.
 126           - HELP puts mm2 into HELP mode. (The gadget stays
 127           highlighted to indicate this). If you now click on any
 128           of the custom gadgets or on the close gadget the
 129           program will display some help on the use of that
 130           gadget.
 131
 132 Colour configuration.
 133      Most people tend to leave their workbench colours untouched
 134      after the novelty of changing them has worn off. If you
 135      normally use a custom palette you can configure MM2 to work
 136      properly even.
 137
 138      Set up a file named "MEMOS:MMASTER.CONFIG" containing just
 139      4 characters. These characters should be some combination
 140      of "0", "1", "2" and "3" eg "0123". If you run an eight
 141      colour workbench you can probably use numbers from 4 to 7
 142      as well. By amending this file you can alter the colour
 143      numbers used for text and boxes etc. by the program. For
 144      example, changing "0123" to "1023" reverses the use of
 145      colours 0 and 1 as set up in preferences. Trial and error
 146      should produce an acceptable combination of colours.
 147
 148 Compilation.
 149      If DICE (by Matt Dillon) is your C compiler, you can
 150      compile the program for yourself by typing DMAKE in a
 151      directory containing the source files, the header file and
 152      the makefile. Obviously your compilation environment will
 153      need to be set up correctly. Also, you will need to have
 154      the registered version since the distributable version does
 155      not include the C header files specifying Amiga specific
 156      structures etc. If you use Lattice, have a look at
 157      dmakefile to work out the dependencies (they are simple)
 158      and your LC command should compile the source files quite
 159      happily without any qualifiers - you will then need to work
 160      out the link info for BLINK (I can't help I'm afraid as I
 161      have took Lattice off my hard disk some time ago).
 162
 163 To Do.
 164      1. ????? (From Kev) If MemoChk() finds non-type-A memo with
 165      date=today, give option to delete.
 166
 167      2. Menu options:-
 168         - Select all 'out of date'.
 169         - Select all of specified type.
 170
 171      3. Any ideas?????
 172
 173 Distribution.
 174      I am releasing this program into the public domain.
 175      Initially distribution is via the Amigaholics disk
 176      magazine, (contact Kev Bryan, Amigaholics, 49 Coutts House,
 177      Charlton Church Lane, Charlton, London, SE7 7AS or telephone
 178      071 580 2000 x240 weekdays between 9 and 3.30) but please feel
 179      free to copy this program to anyone interested so long as you
 180      keep all the files together. Files included should be :-
 181
 182           mm2            - the executable program
 183           mm2.c          - the main source file
 184           deledadd.c     \
 185           listfunc.c      \
 186           display.c        \
 187           datefunc.c       /  - more source files
 188           helpmode.c      /
 189           main_win.c     /
 190           mm2.h          - program specific C header file
 191           dmakefile      - makefile for the DICE C compiler
 192           mm2doc.txt     - this file
 193
 194      As with most releases of software, I don't take any
 195      responsibility for the correct operation of this program -
 196      USE AT YOUR OWN RISK. If you have any comments or
 197      suggestions, and especially if you discover any faults,
 198      please get in touch.
 199
 200           Jeff Flynn
 201           17 Oak Close
 202           Yate
 203           BS17 5TN
 204           England