home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / health / beerlink.zip / BEERLINK.DOC next >
Text File  |  1993-02-07  |  11KB  |  228 lines
  1.                   ┌──────────────────────────────────────┐
  2.                   │ BeerLink...        Alpha Version 0.1 │
  3.                   │   ...A HomeBrewer's Development Tool │
  4.                   └──────────────────────────────────────┘
  5.  
  6. SECTION 1: INTRODUCTION
  7.  
  8. BeerLink is designed to handle all of the information you need to make your 
  9. Homebrewing better! Almost any successful Homebrewer will tell you that 
  10. recording your recipe ingredients and your boiling time, etc., is an 
  11. important step in brewing better beer.  Collecting recipes from Fido, a BBS,
  12. Text Files (like the Cat's Meow!), and so on, has also become very popular.
  13. There is plenty of important information to be found regarding Hops, Malts, 
  14. Grains, Yeasts, and other stuff!  Before you know it, you are *swamped* with
  15. data, and it's hard to make sense of it...  BeerLink to the Rescue!! :)
  16.  
  17. SECTION 2: BEERLINK SETUP
  18.  
  19. The files that make up BeerLink can be divided into three types:
  20. Program Files, Data Files and Associated Text Files.  You will find each
  21. type in a ARJ file within BEERLINK.ARJ.  
  22.  
  23. To Install:
  24.  
  25. (1) Create a Program directory for BeerLink, along with subdirectories for
  26. the Data and Associated Text Files.
  27.     Example directory structure:   BEERLINK
  28.                        |_____DATA
  29.                        |_____TEXT
  30.  
  31. (2) UnARJ the following files into the following directories:
  32.     BEERPROG.ARJ into the BEERLINK directory
  33.     BEERDATA.ARJ into the DATA directory
  34.     BEERTEXT.ARJ into the TEXT directory
  35.  
  36. (3) Edit the BEERLINK.CFG file (in the BEERLINK directory) to match your
  37.     setup, as follows:
  38.     Line 1: Path and Filename of the external viewer/editor you want to 
  39.         use to view/edit the Associated Text Files. (See below)
  40.     Line 2: Path to the Associated Text Files (MUST! have a trailing
  41.         backslash!!)
  42.     Line 3: Path to the Data Files (MUST! have a trailing backslash!!)
  43.  
  44.     Notes: (Viewer/Editor) - BeerLink has been tested with Van Buerg's
  45.     LIST.COM, the popular BROWSE.COM, and PCMag's TED.COM.  I am working
  46.     on memory usage so that larger editors (like DOS 5.0's EDIT.COM) 
  47.     can be used.
  48.  
  49. (4) Run It!
  50.  
  51. SECTION 3: BEERLINK USAGE
  52.  
  53. Here's the FUN part! :)  Some of you may want to dive right in and play with
  54. the program.  That's fine!  I suggest you read the part of this section called
  55. KEY ASSIGNMENTS, and then have fun.  To get the MOST out of BeerLink, you 
  56. should read the following description of how it is designed...
  57.  
  58. For each of us, the Homebrewing experience is centered around our sessions
  59. at the stove, and at the tasting table! :)  BeerLink is designed to link all
  60. of your brewing information in a hierarchical structure (like a database!),
  61. with the Brewing Log (information about a single batch of beer) as the 
  62. starting point.  Individual recipes are linked to logs, and ingredients and
  63. styles are linked to recipes.  A diagram follows:
  64.  
  65. Brewing Logs (with comments...)
  66.     |______Recipes (with comments...)
  67.               |_______Ingredients (Malts, Grains, Yeast, Hops, Specials)
  68.               |_______Styles (Porters, Stouts, Ales... create your own!)
  69.               
  70. Each screen has an Associated Text File.  Pressing Alt-E from any screen
  71. loads your viewer with the appropriate text file.  You can use these files
  72. to store important information about each topic.  Read the KEY ASSIGNMENTS
  73. part of this section for more info on Alt Keys.
  74.  
  75.     KEY ASSIGNMENTS
  76.  
  77.     The following keys are used in BeerLink:
  78.     
  79.     From Any Screen:
  80.     Alt-A     Add a Record
  81.     Alt-D     Delete current Record 
  82.     Alt-E     External Viewer (loads Associated Text File)
  83.     Alt-I     Info on linked fields (see FIELD COLORS for more info)
  84.  
  85.     From the Recipe Screen only:
  86.     Alt-C     Recipe Comments
  87.     Alt-K     Calculate HBU/IBU, Alcohol and Gravity
  88.  
  89.     From the Recipe and Style Screens only:
  90.     Alt-G     Jump to Grains Section
  91.     Alt-H     Jump to Hops Section
  92.     Alt-M     Jump to Malts Section
  93.     Alt-S     Jump to Specials Section
  94.  
  95.     Naviagtion Keys:
  96.     Esc       Back up a screen
  97.     Tab       Move to next field
  98.     Shift-Tab Move to previous field
  99.     Home      Move to first field
  100.     End       Move to last field
  101.     PgDown    Move to next record
  102.     PgUp      Move to previous record
  103.     DownArrow Next record of scrollable field
  104.     UpArrow   Previous record of scrollable field
  105.  
  106.     FIELD COLORS
  107.  
  108.     Each field is colored for easy identification as follows:
  109.     Yellow = Linked Field (Alt-I moves to next level of info)
  110.     Blue   = Scrollable Field (Up/Down Arrow changes value)
  111.     Green  = Calcualted Field (Only updated through a calculation)
  112.     Red    = User Input Field (User must enter data)
  113.  
  114.  
  115. SECTION 4: A QUICK TUTORIAL
  116.  
  117. Let's run through a quick example to see how BeerLink can work for you:
  118. Load BeerLink and choose the first menu option "Start With BeerLink LogBook".
  119. You are now in the Log Screen, looking at the first record.  BeerLink comes
  120. with some example records to get you started.  First, let's take a look at
  121. how information is linked together in BeerLink.  Move around the Log Screen
  122. using the Tab and Shift-Tab keys.  This takes you from field to field, and
  123. allows you to edit each one.  Move to the "Total Time of Boil Field".  Notice
  124. that this field is colored BLUE.  That means you can change its value with the
  125. arrow keys.  Press the UpArrow.  You'll see the minutes scroll up in 
  126. increments of 10.  Pressing the DownArrow will scroll the value down.  This
  127. feature is available on all BLUE fields.  Using the Up and Down Arrows on a 
  128. linked (YELLOW) field will also change its value (to the next record in that
  129. fields database).  Now press the Home key to move to the first field of 
  130. the Log Screen (the "Recipe Name" field).  The name here is the recipe
  131. that was brewed during this session.  This field is linked to the Recipe
  132. Screen.  Press Alt-I, and you will see the Recipe Screen load, with
  133. the linked recipe name as the current record.  You can Tab and Shift-Tab 
  134. through this screen as well.  Press Alt-Y to jump to the Yeasts Section.  You
  135. can scroll through the Yeasts in the database by using the Up and Down Arrows,
  136. or you can press Alt-I to load the Yeasts Screen.  Now you can see how info
  137. is linked...  You just moved from the Log Screen to a screen which provides
  138. you with detailed information about the Yeast used in this session's recipe!
  139.  
  140. Anytime you change information about a recipe, you should press Alt-K to 
  141. recalculate the IBU/HBU, Alcohol and Bittering information.  Try this now.
  142. (If you are still in the Yeasts Screen, press Esc, to return to Recipes)
  143. You'll see exactly how BeerLink is calculating the values.  All of this
  144. information is extracted from the database records for each ingredient, so
  145. you can be sure that this is up to date information! :)
  146.  
  147. Now let's try the external viewer/editor!  Press Alt-E, and (assuming you 
  148. have your CFG file pointing to a valid viewer) you will see the RECIPE.TXT 
  149. file.  I suggest that you begin to store all of that information that you 
  150. are gathering into each of these files.  If you find a file with good info
  151. about Hops, put it in the HOPS.TXT file!  Then you can easily reference that
  152. info the next time you are using BeerLink.  Another idea would be to put new
  153. recipes that you find (in notes on Fido or elsewhere!) into the RECIPE.TXT
  154. file, and then you can add them to BeerLink when you have time!  The
  155. HOMEBREW Digest (available on Internet and on your favorite Brewing BBS!)
  156. is an excellent place to find good information about all kinds of things.
  157. Tom Kaltenbach's utility called THREAD will help you extract info about
  158. a given topic from these digests, and save them to seperate files.  These
  159. files can be the basis of your Associated Text Files!!  OK, nuff said!
  160. Leave your viewer/editor and you will be returned to the Recipe Screen.
  161.  
  162. Finally, press the Home key to move to the first field (the "Beer Type" 
  163. field).  Pressing Alt-I now will load the Styles Screen, where there is
  164. information regarding the Style of this recipe.  This screen is very similar
  165. to the Recipe Screen, except it is less exacting, so that you can *generally*
  166. define the ingredients of the style without regard to exact proportions.  This
  167. info can be very useful when adventuring into the Creation of recipes of a
  168. given style.  Press Esc again to return to the Recipe Screen, and one more time
  169. to return to the Log Screen.  One last look around... :), and press Esc again 
  170. to return to the Main Menu.  
  171.  
  172. You'll notice that you can start from any point in the data structure from 
  173. the Main Menu.  You can go directly to the Recipe Screen to input a new recipe
  174. (or edit an old one!).  You can even go directly to the Ingredients Screens 
  175. and do the same.  Just remember that you'll come back to the Main Menu from
  176. wherever you started, so if you started with the Recipe Screen, you will go
  177. back to the Main Menu from there, and *not* to the Log Screen.
  178.  
  179. That's about it for the tour.  There is *MUCH* more to BeerLink than this, so
  180. take some time experimenting with it!  Ultimately, it can be used as a tool
  181. to help you develop new recipes, and to record your sessions brewing them, so
  182. that you will earn from your experiences.  The Associated Text Files can be
  183. a great asset, as you begin to gather important details about ingredients, 
  184. styles, and brewing methods.
  185.  
  186. SECTION 5: TO ALPHA TESTERS
  187.  
  188. THANK YOU! for taking whatever time you do to test and improve this program!
  189. I am *not* a professional programmer, but I want to continue to develop this
  190. application into something that is useful.  I have a "day job" (as they say!),
  191. and will be updating the program within *reasonable* periods (every month or
  192. so until we get any major changes in).  At this point, I *have not* gotten
  193. the OK to use the ZYMURGY echo for development, so please make all 
  194. correspondence via NetMail.  My FIDONET address is 1:106/7851.
  195. I would appreciate hearing of any bugs that you find, as well as any ideas
  196. for improvement.  I won't guarantee that they will all be implemented, but
  197. I plan on maintaining "The List" so that I can prioritize the changes.
  198.  
  199. I would also be VERY appreciative of any work that can be done to load 
  200. Recipe, Ingredients, and Style records into the database.  It would make alot
  201. of sense to distribute BeerLink with plenty of good info, so that folks can
  202. use it right away.  What better way to share recipes?! :)  This will, of
  203. course, require that I write a Data File Merge function into BeerLink! (See
  204. the COMING FEATURES? section! :):)
  205.  
  206. P.S. - Feel Free to write over the bogus test records that I've included!
  207. I was too lazy to put more than that in the databases!! :):)
  208.  
  209. SECTION 6: COMING FEATURES?
  210.  
  211. -    A Search or Filter function to allow the user to only view records
  212.     that meet a certain criteria.
  213. -    A Data File Merge function that will allow the user to merge data files
  214.     from other BeerLink users (and exclude dup records!)
  215. -    What Else??
  216.  
  217. SECTION 7: LEGAL STUFF
  218.  
  219. BeerLink is only guaranteed to take up space on your hard drive!  You use
  220. this application at your own risk... (although it ain't much of a risk!) :)
  221.  
  222. BeerLink is FreeWare!  That means if you like it, good!  If you think it is
  223. really good, and wouldn't mind sending a few bucks somewhere, make a donation
  224. to your favorite charity.  They need it much more than any of us do...
  225.  
  226. Doug Cox - The Back Room BBS - Richmond, TX - 713-341-7851 - 1:106/7851
  227.  
  228.