home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / misc3 / foodshop.lzh / DOC.FS < prev    next >
Text File  |  1990-09-30  |  46KB  |  902 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                          "PAT'S FOOD SHOPPER"
  17.  
  18.                               Version 1.0
  19.  
  20.                          Documentation Manual
  21.  
  22.                                                                      2
  23.  
  24. "PAT'S FOOD SHOPPER", Version 1.0  (c) Copyright 1990, Pat Boudreau
  25.  
  26.      This program may be freely copied and distributed on a non-
  27. commercial basis only, provided that the program, documentation, and 
  28. data files on the original distribution diskette are not changed or 
  29. modified in any way.  Furthermore, all files present on the original 
  30. distribution diskette must be present on any copies made for 
  31. distribution.  This program is being distributed under the shareware 
  32. concept.  Try my program and see if you like it.  If you use it, you 
  33. must register with the author.  The registration fee is $20.00 and the 
  34. registration form can be printed out by selecting option #4 on the 
  35. main menu of the program.  Upon receipt of the registration fee you 
  36. will be sent, direct from the author, the following: 
  37.   1. Your registered copy of the program that doesn't display the 
  38.      first two message screens. 
  39.   2. Future versions, as they become available, free of charge. 
  40. Future versions plan to include:
  41. - Update one attribute on all items, and all attributes on one item.
  42. - User defined group names, an inventory feature, and help screens.
  43. - A setup option to configure the software package to your needs.
  44. - User defined meals (select 7 meals instead of 50 or so items).
  45. - Tracking of caloric values (calories per meal, per person).
  46. - Sales tax and deposit attributes, and a coupon feature.
  47. - Suggestions that you, the registered user, would like to see.
  48. Your support will make this a truly successful project.  Thank you.
  49.  
  50. Please Note: 
  51.  
  52.      It is highly recommended that you read through this documentation 
  53. manual before using the program.  Option #4 on the main menu of the 
  54. program allows you to either view the documentation on screen or print 
  55. it.
  56.  
  57.  
  58.  
  59. Disclaimer:
  60.  
  61.      The author makes no guarantees or warranties of any kind, 
  62. expressed or implied, as to the fitness of use of this product or the 
  63. accuracy of the accompanying documentation.  The author also assumes 
  64. no liabilities for any damages resulting from the use of this product.  
  65. These damages, whether actual or imagined, include but are not limited 
  66. to:  financial, emotional, incidental, and or otherwise. 
  67.  
  68.                                                                      3
  69.  
  70.                           Table of Contents:
  71.  
  72.                                                                   
  73. Topic                                                             Pg #
  74.  
  75.  
  76.  
  77. Minimum Requirements --------------------------------------------- 4
  78.  
  79. Installation and Startup ----------------------------------------- 4
  80.  
  81. Introduction ----------------------------------------------------- 5
  82.  
  83.  
  84.  
  85.  
  86. Major Option            Sub-Option
  87.  
  88.  
  89. OPTION 1.0:  ATTRIBUTES    
  90.                         1.1 - Display Attributes ----------------- 6 
  91.                         1.2 - Update Names ----------------------- 6 
  92.                         1.3 - Update Prices ---------------------- 6 
  93.                         1.4 - Update Units ----------------------- 7 
  94.                         1.5 - Update Aisles #'s ------------------ 7
  95.  
  96. Option 2.0:  ITEMS         
  97.                         2.1 - Display ---------------------------- 9
  98.                         2.2 - Create ----------------------------- 9
  99.                         2.3 - Delete ----------------------------- 9
  100.                         2.4 - Sort ------------------------------- 10
  101.  
  102. Option 3.0:  SHOPPING LIST 
  103.                         Introduction to Option 3.0 --------------- 11
  104.                         3.1 - Selection of items ----------------- 11
  105.                         3.2 - Display ---------------------------- 11
  106.                         3.3 - Delete Items ----------------------- 12
  107.                         3.4 - Sort and Print --------------------- 12
  108.                         3.5 - Update Quantities of Items --------- 13
  109.  
  110. Option 4.0:  Documentation and Registration
  111.                         4.1 - Display Documentation Manual ------- 15
  112.                         4.2 - Print Documentation Manual --------- 15
  113.                         4.3 - Display Registration Form ---------- 15
  114.                         4.4 - Print Registration Form ------------ 15
  115.  
  116. Option 5.0   Quit This Program and Return to DOS ----------------- 15
  117.  
  118. Error Messages --------------------------------------------------- 16
  119.  
  120. Glossary --------------------------------------------------------- 17
  121.  
  122.                                                                      4
  123.  
  124. Minimum Requirements:  DOS 2.0 or higher, 256 K RAM (384 K RAM may be
  125.                                           required on future versions)
  126.  
  127. Installation and Startup
  128.  
  129.  
  130.      It is highly recommended that you make a backup copy of the 
  131. original distribution diskette.  Use a working diskette.  Put the 
  132. original away for safe keeping.  This will also allow you to make a 
  133. copy of the original distribution diskette at a later time for 
  134. distribution to friends, without making any changes or modifications 
  135. to the files on the original distribution diskette.  It is also 
  136. recommended that you make regular backups or copies of all the *.FS 
  137. files from your working diskette.  These are the data files.  If 
  138. anything happened to your working diskette, having a copy of the most 
  139. recent price changes or new items would be invaluable.  This 
  140. information may be difficult to reconstruct, if at all. 
  141.      Under no circumstances should you attempt to alter any of the 
  142. *.FS files by means other than through the use of the "PAT'S FOOD 
  143. SHOPPER" program.  Doing so may result in run-time errors. 
  144.      The following files should be present on the original 
  145. distribution diskette that you receive:
  146.               HEALTH  .FS
  147.               SUPPLIES.FS
  148.               DAIRY   .FS
  149.               PRODUCE .FS
  150.               BREADS  .FS
  151.               SNACKS  .FS
  152.               FISHMEAT.FS
  153.               FRZNFOOD.FS
  154.               CANNED  .FS
  155.               BEV     .FS
  156.               STAPLES .FS
  157.               MISC    .FS
  158.               SHOPLIST.FS
  159.               REGFORM .FS
  160.               INITSCRN.FS
  161.               DOC     .FS
  162.               FS      .EXE
  163.      Check to make sure all of the above files are present.  If not, 
  164. you don't have the complete package and the program may not work 
  165. properly, if at all. 
  166.      If you have a hard or fixed disk, copy all of the files into a 
  167. subdirectory of its own.
  168.      To run, the program must have all of the *.FS files present in 
  169. the current subdirectory of the default drive.  To start the program, 
  170. at the DOS prompt simply type FS, ENTER, and you're up and running.  
  171. If the program file, FS.EXE, is located on another drive or 
  172. subdirectory, precede the "FS" with the drive name or subdirectory of 
  173. where FS.EXE resides, such as A:FS or C:\FOOD\FS, or have its name 
  174. included in the path statement.  This may be a situation where you 
  175. have several sets of data files, the *.FS files.  One set of data 
  176. files for each store.  These sets of data files may be located on 
  177. different diskettes or in different subdirectories.  The program file, 
  178. FS.EXE, needs only to exist in one place.  Locate yourself where the 
  179. data files are, and then call upon the program file by preceding its 
  180. name with its location or have its location included in the path 
  181. statement.
  182.  
  183.                                                                      5
  184.  
  185. INTRODUCTION:
  186.  
  187.  
  188.      Welcome to "Pat's Food Shopper".  This a completely menu-driven 
  189. program designed to aid you in selecting and creating a grocery 
  190. shopping list.  It will tell you, throughout the item selection 
  191. process, the dollar total of the list.  It will then sort the list 
  192. according to aisle # when printing so that items within the same store 
  193. aisle will be grouped together on the list.  I have found from 
  194. personal experience that this is a real time saver.  I don't know how 
  195. many times I have gone through the grocery store and, after going 
  196. through 5 or 6 aisles, discovered that I overlooked an item on my 
  197. shopping list that didn't get picked up in aisle # 1.  This program is 
  198. best suited if you do most or all of your shopping at one grocery 
  199. store.  It is entirely possible, however, to have several sets of data 
  200. files - one for each store - if so desired. 
  201.      In the beginning, a small investment of time is needed to 
  202. customize this software package to suit your specific needs and 
  203. situation.  Take a few minutes to map the grocery store and determine 
  204. where items are located.  Do this by assigning them aisle #'s. This 
  205. takes relatively little time to accomplish, and the benefits are well 
  206. worth it.  With all of the information on disk, selection of items for 
  207. the shopping list later on is simple and fast.  Information associated 
  208. with an item can be changed or updated at any time. 
  209.      The program is split up into five major options.  Within each 
  210. major option are several sub-options.  The main menu displays the name 
  211. of each major option along with a brief description of each sub-
  212. option.  The options are discussed in more detail in the following 
  213. sections. 
  214.      Select the number of the desired major option and press ENTER.  
  215. Once you are inside a major option, select the number of the desired 
  216. sub-option and press ENTER.  Once you are inside a sub-option, select 
  217. the desired group #.  Some sub-options don't have group #'s, depending 
  218. on their purpose.  The program won't allow a number selection that 
  219. doesn't exist.  Press ESC or BACKSPACE and try again.  BACKSPACE backs 
  220. you up one character at a time and ESC takes you back to the beginning 
  221. of your input. 
  222.      In certain parts of the program you are prompted to type in text.  
  223. This may be the name of an item, or simply a "Y" or "N" for a yes or 
  224. no action to be taken.  Regardless of where you are located in the 
  225. program, upper case or lower case alphabetical characters, or a 
  226. combination of both, may be typed in.  It is a matter of personal 
  227. preference and doesn't affect the operation of the program.   
  228.      Take note of the message that often appears at the bottom of the 
  229. screen.  It will tell you of alternative actions that can be taken 
  230. instead of choosing a number selection.  As a rule of thumb, pressing 
  231. ENTER without the input of any characters backs you out of the program 
  232. to the previous screen or option.  There are a few exceptions, but 
  233. they will always be noted in the message at the bottom of the screen. 
  234.  
  235.                                                                      6
  236.  
  237. OPTION 1.0   ATTRIBUTES
  238.  
  239.  
  240. Option 1.1 - Display Attributes of Items
  241.  
  242.      This option allows you to display items along with their 
  243. associated characteristics or attributes.  Attributes are things such 
  244. as Name, Price, Units, and Aisle #.  Items in each group have been 
  245. provided as examples of how this information will appear when 
  246. displayed.  You may at some later time probably want to update these 
  247. items or delete them altogether and create new ones. 
  248.  
  249. Options 1.2 through 1.5 - Update the Attributes
  250.  
  251.       You may update any of the four attributes - Name, Price, Units, 
  252. and Aisle #  - with these options. 
  253.      
  254. Option 1.2 - Update Names
  255.  
  256.      The name can be up to twenty characters in length.  Keep 
  257. information between brackets.  This helps you to stay within the 
  258. maximum number of characters allowed when prompted for an input.  
  259. Pressing BACKSPACE or ESC before pressing ENTER will allow you to 
  260. correct a mistake.  Items with the same exact name cannot exist within 
  261. the same group.  If you attempt to ENTER a name that already exists in 
  262. that group, the program beeps and again prompts you for the name.  
  263. Variations of a name, such as "Diapers-large" and "Diapers-small", are 
  264. permitted.  If updating the name of an item which is also on the 
  265. current shopping list (last list created), the name of that item is 
  266. also updated on the shopping list.  When prompted for a price, 
  267. pressing ENTER without the input of any characters causes the current 
  268. name to remain the same. 
  269.      An item can only be selected if it is being displayed as a 
  270. choice.  If there are more than 40 items, press ENTER without the 
  271. input of any characters.  This scrolls to the next 40 items, allowing 
  272. an item here to be selected and updated. 
  273.  
  274. Option 1.3 - Update Prices
  275.  
  276.      This is the price of the product per unit.  Units are things such 
  277. as lb., gal., box, bottle, each or anything you specify in the "Units" 
  278. attribute.  The price should be the cost of one of these units.  
  279. Prices must be from $0.00 to $99.99.  Entering ".5", ".50" and "0.50" 
  280. work equally as well and is a matter of preference.  Decimal points 
  281. are not necessary, however, and whole dollar prices may be entered as 
  282. a "2" or "3".  Do not use the "$" symbol when entering the price.  
  283. When displayed, however, this same number will always be displayed as 
  284. "$ 0.50".  The price can be up to five characters in length, including 
  285. the decimal point.  Keep information between brackets.  This helps you 
  286. to stay within the maximum number of characters allowed when prompted 
  287. for an input.  
  288.      If updating the price of an item which is also on the current 
  289. shopping list (last list created), the price of that item is also 
  290. updated on the shopping list.  This is provided for updating prices 
  291. while not having to update the current shopping list all over again.  
  292. This allows the current dollar total of the shopping list to fluctuate 
  293. with changing prices.  This can also be very useful when updating 
  294. prices after already selecting your shopping list. 
  295.  
  296.                                                                      7
  297.  
  298.      Items which are taxable or which have a deposit of some kind 
  299. should have this extra cost included in the price of the item.  Future 
  300. versions of my program will include tax and deposit attributes so that 
  301. these types of costs are accounted for automatically.  When prompted 
  302. for a price, pressing ENTER without the input of any characters causes 
  303. the current price to remain the same. 
  304.      An item can only be selected if it is being displayed as a 
  305. choice.  If there are more than 40 items, press ENTER without the 
  306. input of any characters.  This scrolls to the next 40 items, allowing 
  307. an item here to be selected and updated. 
  308.  
  309. Option 1.4 - Update Units
  310.  
  311.      Units are the sizes in which items are commonly purchased.  Units 
  312. can be up to seven characters in length.  Keep information between 
  313. brackets.  This helps you to stay within the maximum number of 
  314. characters allowed when prompted for an input.  Please note that 
  315. whatever unit you give an item is the same unit that you will be 
  316. prompted for in selecting the shopping list.  For instance, you give 
  317. "Milk" units of "Gal".  You will be prompted, when selecting items on 
  318. the shopping list, for how many "Gal(s)" are desired.  If updating the 
  319. unit of an item which is also on the current shopping list (last list 
  320. created), the unit of that item is also updated on the shopping list.  
  321. When prompted for a unit, pressing ENTER without the input of any 
  322. characters causes the current units to remain the same. 
  323.      An item can only be selected if it is being displayed as a 
  324. choice.  If there are more than 40 items, press ENTER without the 
  325. input of any characters.  This scrolls to the next 40 items, allowing 
  326. an item here to be selected and updated. 
  327.  
  328. Option 1.5  - Update Aisle #'s  
  329.   
  330.      The aisle # can be up to three characters in length.  Keep 
  331. information between brackets.  This helps you to stay within the 
  332. maximum number of characters allowed when prompted for an input.  The 
  333. aisle you shop in first should be aisle #1, and so forth.  Letters, 
  334. whole numbers, or both may be used.  An aisle # may also be expressed as 
  335. "A6" or "6A".  When prompted for an aisle #, pressing ENTER without 
  336. the input of any characters causes the current aisle # to remain the 
  337. same. 
  338.      An item can only be selected if it is being displayed as a 
  339. choice.  If there are more than 40 items, press ENTER without the 
  340. input of any characters.  This scrolls to the next 40 items, allowing 
  341. an item here to be selected and updated. 
  342.      If updating the aisle # of an item which is also on the current 
  343. shopping list (last list created), the aisle # of that item is also 
  344. updated on the shopping list.  Sorting of the shopping list is done 
  345. according to the alphabetical and numerical values of the aisle #'s.  
  346. Aisle #'s, when sorted, are grouped on the shopping list as follows: 
  347.        
  348.   Aisle #'s expressed as "???" will be grouped together and appear 
  349.   first on shopping list.  Amongst themselves, they will be sorted in 
  350.   the order in which the items they belong to were selected to be on 
  351.   the shopping list. 
  352.          
  353.   Aisle #'s beginning with alphabetical characters will be grouped 
  354.   together and appear second on the shopping list.  Amongst 
  355.   themselves, they will be sorted in alphabetical order. 
  356.  
  357.                                                                      8
  358.  
  359.   Aisle #'s beginning with numbers will be grouped together and appear 
  360.   third on the shopping list.  Amongst themselves, they will be sorted 
  361.   in numerical order first and alphabetical order secondly.  What this 
  362.   means is that if you have aisle #'s with the same numerical value 
  363.   but are also followed by letters, the alphabetical part of the aisle 
  364.   # will also be sorted.  To give an example:  you have three aisle 
  365.   #'s, "6B", "6C", and "6A".  They will be sorted in this order:  
  366.   "6A", "6B", and "6C".  Aisle # "6C" will come before aisle # 7, and 
  367.   so forth.  This can be very useful when a very large aisle exists 
  368.   and you want to break it up into two or more sections.
  369.  
  370.                                                                      9
  371.  
  372. Option 2.0   ITEMS
  373.  
  374.  
  375. Option 2.1 - Display Items 
  376.  
  377.      This option allows you to display the names of items in a group.  
  378. It is very similar to option 1.1 with one exception - it doesn't 
  379. display the other three attributes, just the names.  This is a quick 
  380. way to find out if a particular item exists in a group.  It will 
  381. display forty names per screen instead of only 20 names per screen as 
  382. in option 1.1.  
  383.  
  384. Option 2.2 - Create Items
  385.  
  386.      This option allows you to add items to a group of your choice.  A 
  387. maximum of 80 items are allowed in each group, for a combined total of 
  388. 960 items in 12 groups.  When prompted for the name of a new item, if 
  389. ENTER is pressed without the input of any characters then no item is 
  390. actually created and you are brought back to the previous menu.  If 
  391. you do input characters for the name, then an item is created.  You 
  392. are then prompted for its remaining attributes of price, units, and 
  393. aisle #. 
  394.      Notice what happens to these remaining attributes, however, when 
  395. pressing ENTER without the input of any characters.  The program will 
  396. give these attributes values of its own.  These are called default 
  397. values.  They are the ones shown between the set of brackets to the 
  398. immediate left of where you are prompted for an input.  The default 
  399. price is $ 0.00.  The default units and aisle #'s are given question 
  400. marks.  The number of question marks is equal to the maximum # of 
  401. characters allowed for that type of attribute.  If you are uncertain 
  402. as to what the price, units, or aisle # is, just give it the default 
  403. value.  You can always go back and update it later in option 1.2 
  404. through 1.5.  When displaying the attributes, or displaying or 
  405. printing the shopping list, these default values stick out like sore 
  406. thumbs.  This makes them easier to spot when you need to find them.  
  407. Items given a default value for aisle # will be grouped together and 
  408. appear first on the shopping list.  
  409.      Names can contain up to twenty characters in length.  Prices can 
  410. contain up to five characters in length, including the decimal point, 
  411. and must be from $ 0.00 to $ 99.99.  Decimal points are not necessary, 
  412. however, and whole dollar prices may be entered as a "2" or "3".  Do 
  413. not use the "$" symbol when entering a price.  Items which are taxable 
  414. or which have a deposit of some kind should have this extra cost 
  415. included in the price of the item.  Future versions of my program will 
  416. include tax and deposit attributes so that these types of costs are 
  417. accounted for automatically.  Units can contain up to seven characters 
  418. in length.  Aisle #'s can be up to three characters in length and 
  419. contain letters, whole numbers, or both.  Keep information between 
  420. brackets.  This helps you to stay within the maximum number of 
  421. characters allowed when prompted for an input. 
  422.  
  423. Option 2.3 - Delete Items
  424.  
  425.      This option allows you to delete an item in a group.  The 
  426. remaining items are re-numbered when displayed.  Selecting the letter 
  427. "D" instead of the number choice of an item will allow you to delete 
  428. all items in that group.  Be careful with this command - you can wipe 
  429. out a lot of information in one keystroke.  Deleting all items from 
  430.  
  431.                                                                     10
  432.  
  433. all groups at the same time is not allowed.  This was an intentional 
  434. aspect of the program to have some degree of protection against 
  435. indiscriminately losing all of your data.  If an item is selected 
  436. which is also on the current shopping list, the item will be removed 
  437. from the shopping list as well. 
  438.      An item can only be selected if it is being displayed as a 
  439. choice.  If there are more than 40 items, press ENTER without the 
  440. input of any characters.  This scrolls to the next 40 items, allowing 
  441. an item here to be selected and deleted. 
  442.  
  443. Option 2.4 - Sort Items
  444.  
  445.      This option allows items within a group to be sorted by 
  446. alphabetical order according to name.  This makes it easier to find 
  447. items in a group when selecting items for the shopping list.  
  448. Selecting the letter "S", instead of a group number, will sort all 
  449. items in all groups at one time - a real time saver. 
  450.  
  451.                                                                     11
  452.  
  453. Option 3.0   SHOPPING LIST
  454.  
  455.  
  456. Introduction to Option 3.0
  457.  
  458.      This is the third major option and deals with most aspects of the 
  459. shopping list.  When first gaining access to this section, you will be 
  460. prompted "START A NEW SHOPPING LIST? (Y/N)_".  Selecting "N" loads the 
  461. current or last shopping list on which you were working.  You can then 
  462. add to it and so forth.  Selecting "Y" erases the current or last 
  463. shopping list so that a new shopping list can be started.  Be careful 
  464. - you can wipe out your current working shopping list by selecting 
  465. "Y". 
  466.  
  467. Option 3.1 - Selection of Items
  468.  
  469.      This option allows you to add to the current shopping list the 
  470. items you want to buy.  Select a group #.  After selecting a group # 
  471. and then having its items displayed, notice that the current total is 
  472. displayed at the bottom of the screen.  This increases with every item 
  473. selected, unless an item has a price of zero.  The current total lets 
  474. you know the bottom line while selecting items.  This makes it much 
  475. easier when trying to stay within a budget. 
  476.      Then select an item # within that group.  You will be prompted 
  477. for a quantity.  The quantity represents how many units of the item 
  478. you want.  Let's say you selected milk and the price shown is $2.00 / 
  479. Gal.  Selecting a quantity of "1" Gal(S) will place the item on the 
  480. shopping list and add $2.00 to the current total.  Selecting a 
  481. quantity of "2" Gal(S) will add $4.00 to the current total, and so 
  482. forth.  The program calculates the price multiplied by the quantity, 
  483. to come up with the cost for that item.  Entering fractional 
  484. quantities are allowed and must be entered as a decimal.  For 
  485. instance, "1.5" Gal(S) is fine and will properly calculate the current 
  486. total.  Entering a quantity of zero or one that begins with an 
  487. alphabetical character causes a beep and again prompts you for the 
  488. quantity.  When prompted for a quantity, pressing ENTER without the 
  489. input of any characters brings you back to the previous menu and this 
  490. item is not added to the shopping list. 
  491.      Items can occur only once on the shopping list.  If you select an 
  492. item that is already on the list, the program beeps and displays such 
  493. a message.  Press ENTER to continue and you are brought back to your 
  494. previous choice of items.  This is a very useful function.  In the 
  495. process of selecting items for the shopping list, it is sometimes easy 
  496. to forget that an item has already been selected.  This function 
  497. alerts you to the fact and does not allow the item to be added twice.  
  498. It can be an annoyance having the same item listed twice, not to 
  499. mention the fact that it artificially inflates the current total.  
  500.      There is a limit of 200 items that can be on the shopping list.  
  501. Attempting to put more than 200 items on the list causes a beep and an 
  502. explanatory message is displayed. 
  503.      An item can only be selected if it is being displayed as a 
  504. choice.  If there are more than 40 items, press ENTER without the 
  505. input of any characters.  This scrolls to the next 40 items, allowing 
  506. an item here to be selected and placed on the shopping list. 
  507.  
  508. Option 3.2 - Display Current Shopping List
  509.  
  510.      This option allows you to display the current shopping list, 20 
  511.  
  512.                                                                     12
  513.  
  514. items at a time.  The "PgUp" and "PgDn" keys will allow you to view 
  515. the previous and following screens, respectively.  "Home" and "End" 
  516. keys will allow you to view the first and last screens, respectively.  
  517. Pressing ENTER brings you back to the previous menu.  
  518.      Option 3.2 always shows you an updated shopping list.  Back out 
  519. of this option and add or delete some items, or simply change some of 
  520. their quantities.  When you come back to option 3.2 to display the 
  521. shopping list, these changes will be reflected. 
  522.      The current total is displayed at the bottom of the screen.  
  523. Changes to the number of items or their quantities causes changes to 
  524. be reflected in the current total as well, unless these changes 
  525. involve items with prices of zero. 
  526.      Take note of one of the headings at the top of the screen.  Look 
  527. at the last column on the right.  It reads "GP#".  This stands for 
  528. "Group #".  This refers to the number of the group in which the item 
  529. is located.  "HEALTH AND BEAUTY AIDS" is "GP#" 1, "HOUSEHOLD SUPPLIES" 
  530. is "GP#" 2, and so forth.  This is very useful information.  If you 
  531. want to change an attribute of an item, it may be possible at times to 
  532. forget where the item is located.  "GP#" tells you this. 
  533.      Items are displayed in the order in which they are selected to be 
  534. on the shopping list.  This will change, however, after option 3.4 is 
  535. executed.  Option 3.4 sorts the shopping list according to aisle # and 
  536. then sends it to the printer in this same sorted order.  The shopping 
  537. list is also saved to file in this new sorted order.  As a result, 
  538. displaying the shopping list using option 3.2, after executing option 
  539. 3.4, will show the items in their new sorted order.  This can be 
  540. helpful.  Items displayed on the screen in the same order as the 
  541. printout in your hand can make items easier to locate and compare. 
  542.  
  543. Option 3.3 - Delete Items From Current Shopping List
  544.  
  545.      This option allows you to delete or remove items from the current 
  546. shopping list.  The shopping list is displayed and you select the 
  547. number of the desired item.  The remaining items are re-numbered to 
  548. reflect this change in the shopping list. 
  549.      The current total is displayed at the bottom of the screen.  
  550. Deletions from the shopping list updates the current total.  A new 
  551. lower current total will be displayed after each deletion is made, 
  552. unless the item being deleted has a price of zero. 
  553.      Only an item that is actually being displayed can be selected.  
  554. If the first 20 items are being displayed and you select item # 24, 
  555. nothing happens.  Press BACKSPACE to backup one character at a time or 
  556. ESC to backup all the way to enter a new item #.  "PgUp", "PgDn", 
  557. "Home", and "End" gets you to the particular screen where an item is 
  558. located so that the item can be selected and deleted.  The "PgUp" and 
  559. "PgDn" keys allows you to view the previous and following screens, 
  560. respectively.  "Home" and "End" keys allows you to view the first and 
  561. last screens, respectively.  Pressing ENTER without the input of any 
  562. characters backs you out to the previous menu. 
  563.  
  564. Option 3.4 - Sort and Print Current Shopping List
  565.  
  566.      This option simply sorts the current shopping list according to 
  567. aisle # and then sends it to the printer in this same sorted order.  
  568. If you have an unusually long shopping list, be patient.  The sort may 
  569. take some time.  Future versions of "PAT'S FOOD SHOPPER" will include 
  570. a setup option.  You may decide that only whole numbers, and no 
  571. letters, are going to be used in the aisle #'s.  This fact can be 
  572.  
  573.                                                                     13
  574.  
  575. entered into the setup option.  Every time the program is subsequently 
  576. run, the program automatically recognizes this preset condition and 
  577. won't sort alphabetically, just numerically.  This will make the sort 
  578. much faster. 
  579.      If you wish to print out a second copy of the same shopping list, 
  580. it won't go through another tedious sort.  The program knows if the 
  581. shopping list has already been sorted.  If so, it immediately sends 
  582. the shopping list to the printer.  If any more items are added to the 
  583. shopping list or if any aisle #'s of items on the shopping list are 
  584. changed or updated, it will re-sort before printing the next time 
  585. option 3.4 is executed.  Deleting items from the shopping list does 
  586. not cause a re-sort when option 3.4 is subsequently executed.  
  587. Deleting items doesn't change their order.  It simply takes the 
  588. remaining items and "squeezes" them closer together. 
  589.      When using option 3.2, items are displayed in the order in which 
  590. they are selected to be on the shopping list.  This will change, 
  591. however, after option 3.4 is executed.  In addition to sorting and 
  592. printing, option 3.4 also saves the shopping list to file in this new 
  593. sorted order.  As a result, displaying the shopping list using option 
  594. 3.2, after executing option 3.4, will show the items in their new 
  595. sorted order.  This can be helpful.  Items displayed on the screen in 
  596. the same order as the printout in your hand can make items easier to 
  597. locate and compare. 
  598.      Sorting is done according to the alphabetical and numerical 
  599. values of the aisle #'s.  Aisle #'s are limited to three characters in 
  600. length.  The aisle you shop in first should be aisle #1, and so forth.  
  601. Letters, whole numbers, or both may be used.  An aisle # may also be 
  602. expressed as "A6" or "6A". Aisle #'s, when sorted, will be grouped on 
  603. the shopping list as follows: 
  604.        
  605.    Aisle #'s expressed as "???" will be grouped together and appear 
  606.    first on shopping list.  Amongst themselves, they will be sorted in 
  607.    the order in which the items they belong to were selected to be on 
  608.    the shopping list. 
  609.            
  610.    Aisle #'s beginning with alphabetical characters will be grouped 
  611.    together and appear second on the shopping list.  Amongst 
  612.    themselves, they will be sorted in alphabetical order. 
  613.           
  614.    Aisle #'s beginning with numbers will be grouped together and 
  615.    appear third on the shopping list.  Amongst themselves, they will 
  616.    be sorted in numerical order first and alphabetical order secondly.  
  617.    What this means is that if you have aisle #'s with the same 
  618.    numerical value but are also followed by letters, the alphabetical 
  619.    part of the aisle # will also be sorted.  To give an example:  you 
  620.    have three aisle #'s, "6B", "6C", and "6A".  They will be sorted in 
  621.    this order:  "6A", "6B", and "6C".  Aisle # "6C" will come before 
  622.    aisle # 7, and so forth.  This can be very useful when a very large 
  623.    aisle exists and you want to break it up into two or more sections. 
  624.  
  625.      When printing the shopping list, a new column heading is seen. It 
  626. is located on the far right and is called "NOTES".  This is provided 
  627. so that the shopper may write down any comments about an item.  Maybe 
  628. this item was observed to have a new price, rather than the one 
  629. currently seen on the shopping list.  Make a written note of this new 
  630. price and update the price of that item later on at home. 
  631.  
  632.                                                                     14
  633.  
  634. Option 3.5 - Update Quantities of Items on Current Shopping List
  635.  
  636.      This option allows items already on the current shopping list to 
  637. have their quantities updated.  Select the number of an item on the 
  638. list that you want to change.  The current quantity is displayed and 
  639. you are prompted for a new quantity.  If an attempt is made to enter a 
  640. quantity of zero or a quantity that begins with an alphabetical 
  641. character, the program beeps and again prompts you for the quantity.  
  642. When prompted for a quantity, pressing ENTER without the input of any 
  643. characters causes the current quantity to remain the same and brings 
  644. you back to your previous choice of items.  
  645.      Only an item that is actually being displayed can be selected.  
  646. If the first 20 items are being displayed and you select item # 24, 
  647. nothing happens.  Press BACKSPACE to backup one character at a time or 
  648. ESC to backup all the way to enter a new item #.  "PgUp", "PgDn", 
  649. "Home", and "End" gets you to the particular screen where an item is 
  650. located so that the item can be selected and its quantity updated.  
  651. The "PgUp" and "PgDn" keys allows you to view the previous and 
  652. following screens, respectively.  "Home" and "End" keys allows you to 
  653. view the first and last screens, respectively.  Pressing ENTER without 
  654. the input of any characters backs you out to the previous menu. 
  655.      The current total is displayed at the bottom of the screen.  It 
  656. changes every time the quantity of an item is updated, unless that 
  657. item has a price of zero.  This is a handy feature when wanting to 
  658. know what the immediate bottom line will be when changes in quantities 
  659. are made. 
  660.  
  661.                                                                     15
  662.  
  663. Option 4.0 - Documentation and Registration
  664.  
  665.  
  666. Option 4.1 - Display Documentation Manual
  667.  
  668.      Selecting this option allows you to view the documentation manual 
  669. on the screen, twenty lines at a time.  "PgDn" shows the next screen 
  670. and ENTER backs you out to option 4.0. 
  671.  
  672. Option 4.2 - Print Documentation Manual
  673.  
  674.      This option sends the documentation manual to the printer so that 
  675. you may have a hard copy of it.  The manual is nineteen pages long. 
  676.  
  677. Option 4.3 - Display Registration Form
  678.  
  679.      Selecting this option allows you to view the registration form on 
  680. the screen, twenty lines at a time.  "PgDn" shows the next screen and 
  681. ENTER backs you out to option 4.0. 
  682.  
  683. Option 4.4 - Print Registration Form
  684.  
  685.      This option sends the registration form to the printer so that 
  686. you can fill it out and mail it in.  The registration form is one page 
  687. long. 
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694. Option 5.0   Quit This Program and Return to DOS
  695.  
  696.  
  697.      This option ends the program, clears the screen, and returns you 
  698. to DOS.  Be sure to make backup copies of the *.FS files, the data 
  699. files.  Having a copy of the most recent price changes or new items 
  700. can be invaluable.  This information may be difficult to reconstruct, 
  701. if at all. 
  702.  
  703.                                                                     16
  704. Error Messages
  705.  
  706.  
  707.      If an error occurs, the program beeps several times and then 
  708. displays a message.  The message tells you that an error has occurred 
  709. and why.  Things that can go wrong range from printer and disk drive 
  710. errors to errors of unknown causes. 
  711.      If the "File Not Found" error occurs, this usually means that one 
  712. of the *.FS files is not present.  Check the directory listing on the 
  713. diskette.  The "Installation and Startup" section on page 4 of this 
  714. manual lists all of the files that should be present on the original 
  715. distribution diskette you receive.  Compare this list with what is 
  716. actually on the disk to see if you have all of the *.FS files present.  
  717. If all of the *.FS files are not present, the program may not work 
  718. properly, if at all. 
  719.      If an error occurs and there is no way to immediately correct the 
  720. problem (turn on printer, etc.), you are trapped and won't be able to 
  721. continue on in the program.  Pressing ENTER simply causes the same 
  722. error to occur.  You can, however, exit to DOS from this point.  While 
  723. holding down the CONTROL key, press the BREAK key.  Then press ENTER.  
  724. This causes the program to terminate and bring you back to DOS. 
  725.      Under no circumstances should you attempt to alter any of the 
  726. *.FS files by means other than through the use of the "PAT'S FOOD 
  727. SHOPPER" program.  Doing so may result in run-time errors (error #62).  
  728. Registered users -  please try using your most recent backups of the 
  729. *.FS files before writing to the author for assistance. 
  730.      If an unknown error has occurred, registered users please take 
  731. note of the error number.  Mail this error number, along with a DS/DD 
  732. diskette containing all of the *.FS files that existed at the time the 
  733. error occurred, to the author.  An explanation of what sub-option of 
  734. the program was being used at the time and any other symptoms would be 
  735. extremely helpful to me in pinpointing the problem.  I will make an 
  736. immediate attempt to correct problems that registered users are 
  737. having.  Please include the registration number with on any 
  738. correspondence. 
  739.  
  740.                                                                     17
  741.  
  742. Glossary
  743.  
  744.  
  745.  
  746.  
  747.  
  748. Attribute     A characteristic of an item.  It describes an item.There 
  749.               are four attributes.  They are:  Name, Price, Units, and 
  750.               Aisle #. 
  751.               
  752.  
  753. Aisle #       Aisle # is an attribute of an item.  It describes an 
  754.               item's location in the grocery store.  It can be up to 
  755.               three characters in length and contain letters, whole 
  756.               numbers, or both. 
  757.               
  758.  
  759. Current       The Current Shopping List is the shopping list that 
  760. Shopping      exists at the moment.  It also means the last shopping 
  761. List          list created.  Although you may have created a shopping 
  762.               last week, it is still the current shopping list.  It 
  763.               ceases to be "current" if you select "Y" in option 3.0 
  764.               when prompted "START A NEW SHOPPING LIST? (Y/N)_". 
  765.  
  766.  
  767. Current       The Current Total refers to the total amount of money 
  768. Total         that will be spent on the current shopping list.  It 
  769.               changes when items are added to the current shopping 
  770.               list or items already on the current shopping list have 
  771.               their quantities updated, unless these items have prices 
  772.               of zero.
  773.               
  774.  
  775. Data Files    Collectively, these are referred to as the *.FS files 
  776.               found on the original distribution diskette.  They are 
  777.               the files with filename extensions of "FS".  They must 
  778.               all be present in the current subdirectory of the 
  779.               default drive for the program to work properly. 
  780.                    Under no circumstances should you attempt to alter 
  781.               any of the *.FS files by means other than through the 
  782.               use of the "PAT'S FOOD SHOPPER" program.  Doing so may 
  783.               result in run-time errors (error #62).  Registered users 
  784.               -  please try using your most recent backups of the *.FS 
  785.               files before writing to the author for assistance. 
  786.               
  787.  
  788. Default       These are values assigned to the attributes of items if 
  789. Values        you do not specify a value.  The default value for price 
  790.               is $ 0.00.  The default values for units and aisle # are 
  791.               "???????" and "???", respectively.  The name of an item 
  792.               has no default value.  Default values are assigned in 
  793.               option 2.2 when you are prompted for an attribute value 
  794.               and press ENTER without the input of any characters. 
  795.       
  796.              
  797. Error Number  The number that is generated when an error occurs and 
  798.               refers to a specific type of error known to the author.
  799.               
  800.  
  801.                                                                     18
  802.  
  803. Group         The name of a category in which items are found.  There 
  804.               are 12 groups and a maximum of 80 items can exist in one 
  805.               group.
  806.  
  807.  
  808. Group #       The number of a group in which items are found.  It 
  809.               ranges from 1 to 12.
  810.  
  811. Item          A term referring to something purchased in the grocery 
  812.               store.  It has four attributes - name, price, units, and 
  813.               aisle #.  It is found in a group and is also listed on 
  814.               the current shopping list.
  815.               
  816.  
  817. Main Menu     The screen displaying the five major options with a 
  818.               brief description of each sub-option.
  819.               
  820.  
  821. Major Option  One of the five choices available on the Main Menu.  
  822.               They are:
  823.               
  824.                    1. ATTRIBUTES
  825.                    2. ITEMS
  826.                    3. SHOPPING LIST
  827.                    4. DOCUMENTATION AND REGISTRATION
  828.                    5. QUIT THIS PROGRAM AND RETURN TO DOS
  829.               
  830.  
  831. Name          Name is an attribute of an item.  It describes the 
  832.               identification of an item.  It can be up to 20 
  833.               characters in length.
  834.               
  835.  
  836. Original      The diskette you receive from a distribution company or 
  837. Distribution  friends.  It should contain all of the files listed on 
  838. Diskette      page 4 of this manual.  If you plan to distribute the 
  839.               software package to others, do not change or modify any 
  840.               of the files on the original distribution diskette. 
  841.              
  842.               
  843. Path          Refer to your DOS reference manual for an explanation of 
  844. Statement     how the path statement is used and configured.
  845.  
  846.  
  847. Price         Price is an attribute of an item.  It is equal to the 
  848.               cost of one unit of an item.  It should include any 
  849.               extra costs of the item, such as a tax or deposit.  It 
  850.               can contain up to five characters, including the decimal 
  851.               point, and must be from $ 0.00 to $ 99.99.  Decimal 
  852.               points are not necessary, however, and whole dollar 
  853.               prices may be entered as a "2" or "3". 
  854.               
  855.  
  856. Program File  The file found on the original distribution diskette 
  857.               with the name "FS.EXE".  The program can be started by 
  858.               typing, at the DOS prompt, FS, ENTER and you're up and 
  859.               running.  It is the only file on the original 
  860.               distribution diskette that does not need to be in the 
  861.  
  862.                                                                     19
  863.  
  864.               current subdirectory of the default drive for the 
  865.               program to work properly.  Locate yourself where the 
  866.               data files are and then call upon the program file by 
  867.               preceding its name with its location or include its name 
  868.               in the path statement.
  869.  
  870. Quantity      The number of units of an item which is on the current 
  871.               shopping list.  Whole or fractional numbers are allowed, 
  872.               such as 1 Gal(S) or 1.5 Gal(S) of milk.  If fractional, 
  873.               the number must be represented as a decimal.  Quantities 
  874.               of zero are not allowed.
  875.               
  876.  
  877. Sub-option    One of several choices within a major option.
  878.               
  879.  
  880. Units         Units is an attribute of an item.  It is the size in 
  881.               which items are normally purchased.  They are things 
  882.               such as LB, GAL, QUART, BOTTLE, JAR, EACH, PIECE or 
  883.               anything that you specify.  Whatever unit you give an 
  884.               item is the same unit that you are prompted for when 
  885.               selecting the quantity of an item to be on the shopping 
  886.               list.  The price of an item should equal the cost of one 
  887.               of these units. 
  888.                
  889.  
  890. Working       The diskette containing all of the data files that have 
  891. Diskette      been customized to suit your specific needs and 
  892.               situation.  It is first created by making a copy of the 
  893.               original distribution diskette.  Put the original away 
  894.               for safe keeping and use the copy as your working 
  895.               diskette. It is also recommended that you make regular 
  896.               backups or copies of all the *.FS files from your 
  897.               working diskette.  These are the data files.  If 
  898.               anything happened to your working diskette, having a 
  899.               copy of the most recent price changes or new items would 
  900.               be invaluable.  This information may be difficult to 
  901.               reconstruct, if at all.
  902.