home *** CD-ROM | disk | FTP | other *** search
/ Colossal Cookbook / ColossalCookbook.cdr / sw / pcrecipe / pcrecipe.doc next >
Text File  |  1985-09-07  |  11KB  |  354 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                              PCRecipe
  22.  
  23.               a Public Domain Program by PC-Squared
  24.  
  25.                    (C) Copyright by PC-Squared
  26.  
  27.  
  28.              << Documentation & Operating Manual >>
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.                            PC-Squared
  38.                           P.O. Box 1610
  39.                       Morgan Hill, CA 95037
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.                           << LICENSE >>
  48.  
  49. This  program can be freely copied and distributed so long as  no 
  50. consideration is given other than specified in this document. The 
  51. user  of this program which finds that it is of value to  him/her 
  52. should  consider  making  a  donation  to  PC-Squared.  See  this 
  53. document for more information about becoming a registered owner.
  54.  
  55.  
  56.  
  57.  
  58.  
  59. I. Introduction
  60.  
  61.      PCRecipe  is  a  series of programs which allows a  user  to 
  62. maintain their recipe file on computer. The system offers several 
  63. advantages over a manually kept recipe file.
  64.  
  65.  
  66.      This system contains only one program. It is PCRECIPE.EXE.
  67.  
  68.      Data files which are used by the system are as follows:
  69. (NOTE: All  data files MUST reside on the default disk drive.)
  70.  
  71. Filename            Record Len     Contains
  72. ----------------------------------------------------------------
  73. RECIPE.CNT          12  Bytes      Counters & General Sys. Info.
  74. RECIPE.DAT          417            Master Recipe Info
  75. RECIP1.DAT          600              "      "     " 
  76. CLASS.DAT           14             Class Information 
  77. SCLASS.DAT          14             Subclass Information
  78. RECIPE.SRT          12             Temporary file built by the
  79.                                       Sort routine.
  80.  
  81.  
  82.  
  83. GENERAL DESCRIPTION
  84.  
  85.      The system provides a means to maintain recipe  information. 
  86. It will allow you to display,  update, add, change, and calculate 
  87. recipes by two separate classifications. 
  88.  
  89.      These "classifications" are termed CLASS and SUBCLASS.  They 
  90. can be used for categorizing each recipe. They are intended to be 
  91. used in order to retrieve a recipe which "fits" within a class. 
  92.  
  93.      An  example  of  the  uses of  the  classifications  are  as 
  94. follows.  If you used CLASS as the type of meal,  i.e. BREAKFAST, 
  95. LUNCH,  DINNER,  DESSERT,  etc,  and  the SUBCLASS as the type of 
  96. food,  i.e.,  FISH,  BEEF,  LAMB,  PORK,  CAKE, etc, then you can 
  97. retrieve all DINNERS (class) which contain FISH (sub-class).
  98.  
  99.      There  is  no  restriction  on how you  use  the  CLASS  and 
  100. SUBCLASS  data fields.  The only restriction is that each  recipe 
  101. MUST be assigned a class and subclass.
  102.  
  103.      All classes and subclasses are defined by you.
  104.  
  105.  
  106. II. Installation
  107.  
  108.      Simply copy the PCRECIPE program on to a disk which contains 
  109. DOS. All files needed by the system are produced by the system.
  110.  
  111.  
  112.      General Operating Information
  113.  
  114.       Every screen which displays the data field limited by ']' & 
  115. '["  are auto-ending.  This means that if you fill the field  the 
  116. system  will automatically go to the next data element.  The only 
  117. time you need to hit RETURN is when you fail to fill the field.
  118.  
  119. Also ALL commands require that you only press the proper key - NO 
  120. <RETURN> is required.
  121.  
  122.  
  123.  
  124. III. CREATING YOUR BASE DATA
  125.  
  126.      The  only  "pre-defined"  files which is  required  prior  to 
  127. entering any recipes are the CLASS and SUBCLASS files.  These are 
  128. entered by using menu selections 6 and 7.
  129.  
  130.      Once  these  are  entered you can  proceed  and  enter  your 
  131. recipes.
  132.  
  133.  
  134. IV. Program Operation of PCRecipe
  135.  
  136.      The  program  is loaded by typing PCRECIPE <CR>.  A  sign-on 
  137. message  will  be displayed.  Simply hit any key to  display  the 
  138. menu.
  139.  
  140.  
  141. OPTION <1> Enter a New Recipe
  142.  
  143.      By selecting option 1,  the system allows you to enter a new 
  144. recipe. The  system  will respond with form on the screen. 
  145.  
  146.      The  form  which  is displayed will ask  for  the  following 
  147. information:
  148.  
  149. NAME - This is any name which you have assigned to this recipe.
  150.  
  151. NUMBER  - This  is  assigned by the  computer.  It  is  used  for 
  152. reference to the recipe.
  153.  
  154. CLASS  - This  is  CLASS  number by which you  want  this  recipe 
  155. associated with.  This MUST be a VALID class number. Once this is 
  156. entered the name of that class will be displayed.
  157.  
  158.  
  159. SUB-CLASS  - This  is  SUB-CLASS number by which  you  want  this 
  160. recipe  associated with.  This MUST be a VALID sub-class  number. 
  161. Once  this  is  entered the name of that sub-class will  be  dis
  162. played.
  163.  
  164. NOTE:  If  you enter an invalid CLASS or  SUBCLASS,  the  message 
  165. *INVALID* will be displayed. You must reenter a VALID number.
  166.  
  167. #  OF  SERVICE - This is the number of people which  this  recipe 
  168. will serve with the quantity of ingredients entered.
  169.  
  170.  
  171.      The  next  ten  lines  on  the screen  allow  you  to  enter 
  172. information on twenty ingredients.
  173.  
  174.      The data requested is:
  175.  
  176. QTY - The quantity of the ingredient.  NOTE: If you plan on using 
  177. the  CALCULATE  function,  the  data  element  MUST  be  numeric. 
  178. Therefore if you have an ingredient which calls for 1/4  teaspoon 
  179. of salt, this MUST be entered as a decimal number, i.e. ".25".
  180.  
  181. MEAS  - This is  measurement,  i.e.,  cup,  teasp,  tablsp,  lbs, 
  182. ounces, etc.
  183.  
  184. INGREDIENT - The ingredient.
  185.  
  186.      If  you  enter  nothing in the QTY field the  system  will 
  187. advance to the INSTRUCTION section. 
  188.  
  189. INSTRUCTIONS  - This  section allows you to enter five  lines  of 
  190. instructions.  These  can be mixing and cooking instructions  and 
  191. comments about the recipe.
  192.  
  193.      When  all  data is entered the system will write it to  disk 
  194. and  present another blank form.  You can continue to enter  more 
  195. recipes  or  hit <RETURN> in the NAME field and the  system  will 
  196. return to the menu. 
  197.  
  198.  
  199.  
  200. To Display a Recipe - Select option 2.
  201.  
  202.      The  system will ask for the recipe number and will  display 
  203. the recipe data. It will then display the following prompt: 
  204.  
  205. <E>xit, <N>ext, <Shift-PrtSc> to Print Screen
  206.  
  207.      If  you select E,  the system will return the menu.  If  you 
  208. select N, it will respond with the recipe number prompt.
  209.  
  210.  
  211.  
  212. Display Choices by Class - Select option 3.
  213.  
  214.      This  is used to obtain a list of recipes which fit  with  a 
  215. specific class and subclass.
  216.  
  217.      The  system  will  prompt  you for the  CLASS  and  SUBCLASS 
  218. numbers  and  display  a list of recipes  which  fall  into  that 
  219. category.
  220.  
  221.  
  222. Calculate a Meal - Select option 4.
  223.  
  224.      This option will allow you to select a recipe which you have 
  225. entered  and  which  serves  four people (an  example)  and  will 
  226. calculate the quantity of ingredients needed to serve any GREATER 
  227. number of people. An example of its use is, say you have a recipe 
  228. for CHICKEN CORDON BLEU for 4 serving,  and your husband  invites 
  229. his boss and his wife, and the Senior V.P. and his wife, over for 
  230. dinner.  You  now need this recipe for six people.  To obtain the 
  231. recipe  for  six people you would do the  following,  using  this 
  232. option;
  233.  
  234.      The  system will prompt you for the recipe number,  and  the 
  235. number of serving which you want.  The system will then calculate 
  236. the recipe and print it with the calculated quantities.
  237.  
  238. SEE  THE  NOTE  UNDER 'ENTER A NEW RECIPE'  REGARDING  THE  'QTY' 
  239. FIELD.
  240.  
  241.  
  242. To Change a Recipe - Select option 5.
  243.  
  244.      The  system will ask for the recipe number and  display  the 
  245. recipe  data.  It will then prompt to see that it is the  correct 
  246. one. Answer by entering Y or N. If you enter N, you will again be 
  247. prompted for the recipe number.
  248.  
  249.      If you enter Y, the system will allow you to change ALL data 
  250. except the recipe number.
  251.  
  252.      If  you  do  not  want  to change  the  data  in  the  field 
  253. containing the cursor,  simply hit RETURN.  If you want to change 
  254. the data, re-enter the entire field.
  255.  
  256.      To stop the loop which is entered in the QTY-MEAS-INGREDIENT 
  257. fields, enter a '/' in the QTY field.
  258.  
  259.      After  a correction the system will return the recipe number 
  260. prompt. Enter the next number or 0<RETURN> to return to the menu.
  261.  
  262.  
  263.  
  264. To Enter a Class - Select option 6.
  265.  
  266.      The  system  display a form asking for the following data: 
  267.  
  268. CLASS # - Enter the class number which you want assigned and  the 
  269. name.
  270.  
  271.  
  272.  
  273. To Enter a Sub-Class - Select option 7.
  274.  
  275.      The  system  display a form asking for the following data: 
  276.  
  277. SUB-CLASS  # - Enter the sub-class number which you want assigned 
  278. and the name.
  279.  
  280.  
  281. Prt/Dis Choices by Class - Selection # 8
  282.  
  283.      This  option will provide you with a list of  recipes  which 
  284. fit a specific class and subclass. The system will prompt you for 
  285. the  class  and subclass number and whether you want  the  result 
  286. sent to the screen or printer.
  287.  
  288.  
  289.  
  290. Prt/Dis Detail by Class - Selection # 9
  291.  
  292.      This  option  will  provide you with the entire  recipe  for 
  293. recipes which fit a specific class and subclass.  The system will 
  294. prompt you for the class and subclass number and whether you want 
  295. the result sent to the screen or printer.
  296.  
  297.  
  298.  
  299. Prt/Dis Classes/Sub-Classes - Selection # 0
  300.  
  301.      This  selection  will display or print a list of  all  valid 
  302. classes and sub-classes.
  303.  
  304.  
  305. The last function is EXIT TO MAIN MENU - Selection X.
  306.  
  307.   This selection will return you to DOS.
  308.  
  309.  
  310.  
  311.  
  312.  
  313. HOW TO BECOME A REGISTERED OWNER OF PCRecipe
  314.  
  315.  
  316.      PC-Squared  writes commercially available and public  domain 
  317. software  for the IBM PC and compatibles.  The commercial systems 
  318. are designed for specific vertical markets and are of no interest 
  319. to most computer hobbists.
  320.  
  321.      If   you  would  like  to  become  a  registered  owner   of 
  322. PCRecipe,  send  a  contribution (amount is your choice)  to  PC-
  323. Squared  at the below address.  A contribution of $25.00 or  more 
  324. will allow you to receive source code and all future updates  for 
  325. the cost of a diskette.
  326.  
  327.      If  you have suggestions,  comments,  information  regarding 
  328. bugs, ideas about possible other public domain programs which you 
  329. would like to see,  or wish to become a registered owner, you can 
  330. write us at:
  331.  
  332.           PC-SQUARED
  333.           P.O. Box 1610
  334.           Morgan Hill, CA 95037
  335.  
  336.      We  also  would  be  interested  in  writing  public  domain 
  337. programs  with people whose expertise is in some other field  and 
  338. who can see the need for a system...
  339.  
  340.    ....Is there a stock broker out there...who is willing to work 
  341. on a tracking and forecasting program??????
  342.  
  343.  
  344.       << POWER TO THE PUBLIC WITH PUBLIC DOMAIN SOFTWARE >>
  345.  
  346.  
  347. Other Public Domain Programs by PC-Squared:
  348.  
  349.           PC-Accountant - A home accounting system.
  350.           PC-Check - A check writing module for PC-Accountant.
  351.           BLKBOOK - An appointment book.
  352.  
  353. All are available on several BBS.
  354. ck - A check w