home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / TICKLE11.ZIP / TICKLE.DOC < prev    next >
Encoding:
Text File  |  1987-06-29  |  13.5 KB  |  375 lines

  1.                                     TICKLE
  2.  
  3.                    -----------------------------------------
  4.                    Comprehensive Reninder Program for the PC
  5.                    -----------------------------------------
  6.  
  7.        ***************************************************************
  8.        *PLEASE UPLOAD TO YOUR LOCAL COMPUTER BULLETIN BOARD SYSTEMS! *
  9.        ***************************************************************
  10.  
  11. I.    General
  12.  
  13.       A.  Date
  14.  
  15.           This documentaion was prepared on 06-29-87.
  16.  
  17.       B.  Version
  18.  
  19.           This documentation is updated to version 1.01 of the program.
  20.  
  21.       C.  Purpose
  22.  
  23.           In my profession as a patent attorney for a large coporation, it is
  24. my duty to meet deadlines and to remember a large number of date sensitive
  25. tasks to be done.  TICKLE was written to assist me in this effort.  I hope it
  26. will be useful to you also.
  27.  
  28.       D.  The Author
  29.  
  30.           The author is a registered patent attorney working with Rockwell
  31. International Corporation in Cedar Rapids, IA (the old Collins Radio Company).
  32. He can be contacted on Compuserve (ID No.: 71016,1355), or GEnie (Address:
  33. L.MURRAH), or by mail at the following address:
  34.  
  35.                    10 Cottage Grove Woods, S.E.
  36.                    Cedar Rapids, IA 52403
  37.  
  38. The home telephone number is (319) 365-6530.  Please feel free to call about
  39. TICKLE during weekend and early evening hours.
  40.  
  41.       E.  The Software
  42.  
  43.           The development of TICKLE began in June, 1987.  New versions will be
  44. released as features are added and corrections are made to previously released
  45. versions.
  46.  
  47.           TICKLE is written in Turbo Pascal.   The source code is included, but
  48. it may be used only in accordance with the license stated below.
  49.  
  50.       F.  Latest Version
  51.  
  52.           The latest version of TICKLE can usually be found on GEnie.  The
  53. latest version can also be obtained by sending a FORMATTED diskette and a
  54. stamped, self-addressed diskette mailer to the author at the above address.
  55.  
  56.       G.  Conventions
  57.  
  58.           When example command lines are shown, the sequence "<CR>" means to
  59. press RETURN or ENTER.
  60.  
  61. II.   Equipment and Program Configuration
  62.  
  63.       A.  Setup
  64.  
  65.           TICKLE can be run on the IBM-PC and compatibles having 192K of memory
  66. and one floppy disk drive.  A hard disk is not required, although you will find
  67. that a hard disk will enhance operation of this and any other program.
  68.  
  69.       Your CONFIG.SYS file should authorize at least 20 files.  This can be
  70. done with the following statement:
  71.  
  72.                                   FILES = 20
  73.  
  74.       CONFIG.SYS may be edited using a word processor or program editor.
  75.  
  76.       B.  The System Clock
  77.  
  78.           TICKLE depends upon the system calendar being set correctly.  If you
  79. have a real time clock, you will have a program which automatically sets the
  80. clock and which is usually run in the AUTOEXEC.BAT file.  If not, you will
  81. need to set the date and time with the DATE and TIME DOS commands.
  82.  
  83. III.  Your Right to Use TICKLE
  84.  
  85.       A.  License
  86.  
  87.       As you may have noticed I have retained the copyright in TICKLE,
  88. primarily in order to control its orderly development.  However, I have granted
  89. the right to anyone to use the program for private, non-commercial use without
  90. further permission from me.  That is, you can copy it, use it, and share it so
  91. long as you do not charge any money for it.
  92.  
  93.       You may use and change the source code so long as (1) you retain my
  94. name and copyright notices, and (2) you provide me with a copy of any modifi-
  95. cations along with your permission to include them in future versions of
  96. TICKLE.
  97.  
  98.       B.  Contributions
  99.  
  100.       Several users have asked me whether I require payment of a "shareware"
  101. fee in order to use the program.  The answer is "No"; but if you would like
  102. to support TICKLE with a small contribution (say $5), we certainly would not
  103. refuse your generosity.  It would certainly help in continuing to improve
  104. the program.
  105.  
  106. IV.  Using TICKLE
  107.  
  108.      A. Conventions
  109.  
  110.          When a response from the user is called for, the default response,
  111. i.e., the response which is automatically entered if RETURN is pressed, is
  112. indicated in pointed brackets, e.g., '<N>'.
  113.  
  114.      B. Batch File Use
  115.  
  116.         One of the most convenient ways to use TICKLE is in the AUTOEXEC.BAT
  117. file which is run each time the the computer is turned on.  Place it last in
  118. the batch file so that you are forced to look at the TICKLE notes each time
  119. you use the computer.  Select the time period (and thus the command) that is
  120. most convenient for you.
  121.  
  122.          An example AUTOEXEC.BAT file, which can be created with a word
  123. processor (ASCII output mode only!) or a text editor is as follows:
  124.  
  125.                         DATE
  126.                         TIME
  127.                         TICKLE W
  128.  
  129.      C. Command Line Modes
  130.  
  131.         TICKLE has three command line modes as follows:
  132.  
  133.         1. No Argument Mode
  134.  
  135.            If command line is entered with only the program name, i.e.,
  136.  
  137.                         TICKLE <CR>
  138.  
  139. the main title screen will be displayed along with a list of commands.
  140.  
  141.         2. Entry Mode
  142.  
  143.            Notes may be entered into the TICKLE note file by using the
  144. following command line entry:
  145.  
  146.                         TICKLE MM-DD-YY Text of note <CR>
  147.  
  148. where "MM" is the month, "DD" is the day, and "YY" is the year of the note.
  149. Months, days, and years must be entered as two digits each, and the wild card
  150. character "?" may be used in place of any date.  For example, if you wish for
  151. a date to be redisplayed every year without deletion and re-entry, you can
  152. enter a command line such as the following:
  153.  
  154.                         TICKLE 01-01-?? New Year's Day
  155.  
  156. If you wish monthly redisplay, you can enter a command line such as the
  157. following:
  158.  
  159.                         TICKLE ??-01-87 Pay electric bill
  160.  
  161. The text of the note following the date can be up to 80 characters in length.
  162.  
  163.         3. Command Mode
  164.  
  165.            In addition to the entry of notes, you can ask TICKLE to perform
  166. several function on the stored file by using the following command line:
  167.  
  168.                         TICKLE % <CR>
  169.  
  170. where "%" is a one letter command as discussed below.
  171.  
  172.      D.  Dates
  173.  
  174.          1.  Valid Range
  175.  
  176.              All date comparisons and calculations in TICKLE assume that dates
  177. are in the range January 1, 1901 and December 31, 1999.  Dates outside this
  178. range will not work!
  179.  
  180.          2.  Date Format and Content
  181.  
  182.              Dates must be entered in the MM-DD-YY format using two digits for
  183. MM, DD, and YY.  A date such as "2-7-87" will be rejected.  The proper format is
  184. "02-07-87".  Date content is not checked.  Thus 13-56-87 will be accepted even
  185. though it is not a real date. Either "-" or "/" will be accepted to separate
  186. the month from the day from the year.  Thus, "MM/DD/YY" is also an acceptable
  187. format.
  188.  
  189.              Invalid dates may be used for special purposes.  For example, if
  190. you wish to specify that something is to be done during a month without
  191. specifying a particular date, you can use the day "00", e.g., "07-00-87".  The
  192. same trick could be used for the entire year, e.g., "00-00-88".
  193.  
  194.              If you wish to enter non-date-specific notes, you can use an
  195. invalid date such as "00-00-00".  However, this will make your non-dated
  196. notes appear at the beginning of the file.  To make them appear at the
  197. end, you might use "99-99-99".   The invalid date "50-50-50" may not be
  198. used for this purpose.
  199.  
  200.          3.  Wildcard Dates
  201.  
  202.              If a wildcard ("?") is used to replace any digit in a date, then
  203. both digits are assumed to be wildcards.  Thus, if you enter 01-01-8?, it will
  204. be interpreted as 01-01-??.
  205.  
  206.      E.  Examining the Notes File
  207.  
  208.          1.  Display Conventions
  209.  
  210.              When notes and their dates are displayed on the monitor screen,
  211. the notes may be accompanied by several symbols which convey important
  212. information about the note.
  213.  
  214.              A "-" before the date means that the note is overdue, i.e., it
  215. has a date earlier that the current date.
  216.  
  217.              A "*" before the date indicates notes having today's date.
  218.  
  219.              A "+" after the date indicates the the date contains wildcard
  220. characters.
  221.  
  222.          1.  Looking at All the Notes
  223.  
  224.              All the notes in the TICKLE file can be examined by entering the
  225. following command line:
  226.  
  227.                         TICKLE A <CR>
  228.  
  229.          2.  Looking Ahead
  230.  
  231.              You can display notes in the TICKLE file for several selectable
  232. future periods as follows:
  233.  
  234.                         TICKLE T <CR>  -  Today's notes
  235.                         TICKLE D <CR>  -  The next day
  236.                         TICKLE W <CR>  -  The next week
  237.                         TICKLE M <CR>  -  The next month
  238.                         TICKLE Q <CR>  -  The next quarter
  239.                         TICKLE Y <CR>  -  The next year
  240.  
  241.      F.  Manipulating Note Dates
  242.  
  243.          1.  Calculating a Date
  244.  
  245.              If you do not know the date on which to enter a date and instead
  246. know only that it is a certain number of days ahead, you can calculate the date
  247. using the following command:
  248.  
  249.                         TICKLE C <CR>
  250.  
  251. You will be prompted for the start date (the default date is the current
  252. date in your system clock) and a number of days to be added to the start
  253. date.  Currently months and years cannot be added to the start date--only
  254. days.
  255.  
  256.          2.  Resetting a Date
  257.  
  258.              If you would like to reset the date of a note without reentering
  259. it and erasing the old note, you can use the Reset command as follows:
  260.  
  261.                         TICKLE R <CR>
  262.  
  263. When this command is invoked, you will be asked to identify the date of the
  264. note to be reset.  When the note is located, you will be asked to enter a new
  265. date in the MM-DD-YY format.
  266.  
  267.      G.  Searching for a Note
  268.  
  269.          If you cannot remember the date of a note but do remember a word (or
  270. a fragment of a word) in the note, you can search for it using the following
  271. command:
  272.  
  273.                         TICKLE S <CR>
  274.  
  275. Enter the "search string" (i.e., word, part of a word, or character
  276. combination) when prompted.
  277.  
  278.      H.  Removing Notes
  279.  
  280.          1.  Single Notes
  281.  
  282.              Notes can be removed one at a time using the following command:
  283.  
  284.                         TICKLE X <CR>
  285.  
  286. The user will be asked to enter the date of the note to be removed and will be
  287. asked whether to remove each note appearing on that date.
  288.  
  289.          2.  Overdue Notes
  290.  
  291.              The user can review all overdue notes (that is, notes having a
  292. date earlier than the current system clock date) regardless of date using
  293. the following command:
  294.  
  295.                         TICKLE O <CR>
  296.  
  297. The user is asked whether to remove each overdue note.
  298.  
  299.      I.  The Log File
  300.  
  301.          Instead of simply erasing a note from the file, you may wish to move
  302. it to another file for later review.  If you do a monthly report, this "log"
  303. file may be a handy reminder of what you did last month.
  304.  
  305.          1.  Logging Notes
  306.  
  307.              When you have finished with a note, you can move it to the log
  308. file with the Log command as follows:
  309.  
  310.                         TICKLE L <CR>
  311.  
  312. When this command is invoked, the user is asked for the date of the note to be
  313. logged.  When the date is found, the user is asked whether to log the note.
  314. If several notes are listed on the same day,  the user is given the
  315. opportunity to log each one individually.
  316.  
  317.          2.  Viewing the Log
  318.  
  319.              You can view the log by issuing the View command as follows:
  320.  
  321.                         TICKLE V <CR>
  322.  
  323.          3.  Erasing the Log
  324.  
  325.              When you are finished with the log, you can erase it and start
  326. over using the Erase command as follows:
  327.  
  328.                         TICKLE E <CR>
  329.  
  330.      J.  Printing the Notes File
  331.  
  332.          The entire notes file can be printed in chronological order on a
  333. line printer using the following command:
  334.  
  335.                         TICKLE P <CR>
  336.  
  337.      K.  Backing Up Data Files
  338.  
  339.          You can back up the TICKLE.DTA and TICKLOG.DTA files to either drive
  340. A: or B: using the following command:
  341.  
  342.                         TICKLE B <CR>
  343.  
  344. Be sure to have a formatted diskette ready, and enter the desired backup drive
  345. when prompted.
  346.  
  347. V.   We Need Your Feedback!
  348.  
  349.      As I continue to improve TICKLE, it is helpful for me to have your
  350. feedback about what you like about TIKCLE, what you don't like about it, any
  351. bugs or cosmetic defects you have discovered, what you would like to see
  352. changed or added, etc.  Please take the time to fill out and mail the form in
  353. the file FEEDBACK.FRM to me.  It would be much appreciated.
  354.  
  355.          If you would like to have the latest version of TICKLE, please send a
  356. FORMATTED diskette and a self-addressed, stamped diskette mailer along with
  357. your feedback form.
  358.  
  359.                                     APPENDIX
  360.  
  361.                                  TICKLE Commands
  362.  
  363. A - List all notes in TICKLE file       Q - List TICKLE file for next quarter
  364. B - Backup TICKLE file                  R - Reset date of TICKLE note
  365. C - Calculate TICKLE date               S - Search for TICKLE note
  366. D - List TICKLE notes for tomorrow      T - List TICKLE file for today
  367. E - Erase TICKLE log                    V - View TICKLE log
  368. L - Save note to log file               W - List TICKLE notes for next week
  369. M - List TICKLE notes for next month    X - Delete TICKLE note
  370. O - Remove overdue TICKLE notes         Y - List TICKLE notes for next year
  371. P - Print TICKLE notes file');
  372.  
  373.  
  374.  
  375.