ProfitPress Mega CDROM2 Shareware Freeware (MSDOS)(1992)(Eng)

home *** CD-ROM | disk | FTP | other *** search

/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / APPS / DATABASE / FDVW233.ZIP / FOODVIEW.DOC < prev next >

Wrap

Text File | 1991-11-27 | 27.1 KB | 730 lines

WELCOME TO... ┌────╖ ┌─╖ ┌─╖ ┌─╖ ┌─╖ │ ╔══╝ │ ║ │ ║ ┌┘ ║ ╘═╝ │ ╙─╖ ┌────╖ ┌────╖ ┌──┘ ║ │ ║┌┘ ╔╝ ┌─╖ ┌────╖ ┌─╖ ┌─╖ │ ╔═╝ │ ╔╕ ║ │ ╔╕ ║ │ ╔╕ ║ │ ╙┘ ╔╝ │ ║ │ ╔╕ ║ │ ║┌─╖│ ║ │ ║ │ ╙┘ ║ │ ╙┘ ║ │ ╙┘ ║ │ ╔╝ │ ║ │ ╙┴─╢ │ ╙┘ ╙┘ ║ ╘═╝ ╘════╝ ╘════╝ ╘════╝ ╘═══╝ ╘═╝ ╘════╝ ╘═══════╝ General ▀▀▀▀▀▀▀ FOODVIEW allows you to browse USENET recipe files that are in TROFF format. Program Info ▀▀▀▀▀▀▀▀▀▀▀▀ Version:......... 2.33 Date:............ 12-Nov-91 Programmed by:... Paul G.W. Hosken Kirchstr. 23 8082 Grafrath West Germany FOODVIEW(tm) - Copyright (c) 1991 Paul G.W. Hosken - All rights reserved Installation ▀▀▀▀▀▀▀▀▀▀▀▀ The program comes as a ZIP file and should contain the following files: DEMO .REC -- Demonstation TROFF file. FOODVIEW.DOC -- Program documentation. FOODVIEW.EGA -- Screen for EGA displays. FOODVIEW.EXE -- Main program. FOODVIEW.H1 -- Help file (1 of 4) FOODVIEW.H2 -- Help file (2 of 4) FOODVIEW.H3 -- Help file (3 of 4) FOODVIEW.H4 -- Help file (4 of 4) FOODVIEW.PRN -- Printer info. file (initially only an outline). FOODVIEW.HRC -- Screen for Hercules displays. HPLJ2P .PRN -- Example printer info file for HP Laserjet 2P. LICENSE .DOC -- License information. READ .ME -- Last minute information. REGISTER.FRM -- Registration form (copy to printer). To install the program set your current directory to the one where you want the program files to be stored. E.g: cd \ md FOODVIEW cd FOODVIEW Then unpack the file. E.g: PKUNZIP FDVWxxx (where 'xxx' represents the version number of the program (i.e. FDVW233 for version 2.33). The files listed above should then exist in your current directory. Please note that only the files with the name FOODVIEW are essential to the running on the program, the rest are for information or demonstration purposes. To be able to run the program from outside this directory define the environment variable FDVWPATH to point at the directory where the program files are. E.g: set FDVWPATH=C:\FOODVIEW If this variable is not set then the program may not be able to find the help or printer files. Also, to make life easier you may wish to include this directory in the PATH environment variable. This would allow the program to be started just by typing 'FOODVIEW'. There is just one last thing to do for the installation to be complete, and that is to edit the printer information file (FOODVIEW.PRN) to include the escape sequences for your printer. This is explained in detail in the section 'Printer Information File'. I would recommend leaving this step until later as the file is not required until you want to print a recipe. The program should now be 'ready for action', and all you need are some recipe files. Included with the program is a demonstration file called DEMO.REC which you can use when playing with the program for the first time. The Command Line ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ To start the program simply type: FOODVIEW However, a number of parameters can be included on the command line. The full syntax is as follows: FOODVIEW {input_file_name} {switch1 {switch2 {switch3 ... }}} where: {input_file_name} is the name (and path) of a recipe file. E.g: DEMO.REC {switch} can be one or more of the following: -H = monocrome (Hercules) output -K = keyboard only (do not use mouse) -M = set default mesurements to metric -R = register program -T = text only (i.e. suppress ANSI sequences to screen) Note that the switches can be preceeded by a '-' (as above) or '/', and can be in upper or lower case. Example command line input: FOODVIEW DEMO.REC -H -K -M This instructs the program to start and to use the recipe file DEMO.REC. Screen output will be in monochrome and no mouse input will be accepted. The recipes will have any measurements displayed in metric instead of imperial (default). Using FOODVIEW with a Mouse ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ FOODVIEW supports the use of a mouse. The program will automatically detect if a mouse is available and display a mouse symbol (assuming that the program has not been started with the -K switch). The mouse symbol will vary depending on the currect program function that is active, i.e. in the main screen it will be a small sun, whereas in a select screen it will be a small arrow. The mouse window also varies along with the function. This may be a little confusing the first time you use the program, but it will not take long to familiarise yourself with its operation. The Recipe Viewing Screen (Main Screen) ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ After starting FOODVIEW the mask for the main screen will be displayed. The function of this screen is to allow you to view the recipes in the file. If the name of a recipe file was included on the command line then this file will be opened and read in. During this time the message 'WAIT' will be displayed on the bottom right of the screen. After the recipes have been read and indexed the first page of the first recipe will be displayed. If no recipe file was specified then the program will ask you to enter one. Entering a blank file name will terminate the program. When a page of a recipe is being displayed the top line of the screen will contain the UNIX filename, recipe codes, recipe source and date. The bottom line is a status line and will contain a set of mouse icons and status infomation. The Status Line ═══════════════ The bottom line of the screen contains a set of icons for use with a mouse, and four status values as follows: FOODVIEW │xxxxxx│ « │ │ │ » │ │ │ √ │ ? │ ■ │ 1│ 16│ 1│ 16 └─┬──┘ └┬─┘ └┬─┘ └┬─┘ └┬─┘ │ │ │ │ │ └────────────────────────────────────┐ │ │ │ │ │ │ │ │ │ Free memory (bytes)───────────────────────┘ │ │ │ │ Number of current recipe (in selected list)────┘ │ │ │ Number of recipes selected──────────────────────────┘ │ │ Number of current recipe (in file)───────────────────────┘ │ Number of recipes in file─────────────────────────────────────┘ Input ═════ The left-hand set of four icons on the status line control movement within the recipe file, or within a recipe, as follows: « - Fast rewind Mouse left button: Go back 1 page in recipe (F1) Mouse right button: Go back 10 recipes (CTRL/F1) - Rewind Mouse left button: Go back 1 line in recipe (F2) Mouse right button: Go back 1 recipe (CTRL/F2) - Forward Mouse left button: Go forward 1 line in recipe (F3) Mouse right button: Go forward 1 recipe (CTRL/F3) » - Fast forward Mouse left button: Go forward 1 page in recipe (F4) Mouse right button: Go forward 10 recipes (CTRL/F4) The right-hand set of four icons relate to action functions as follows: - Display 'mark/select recipe' screen Mouse left or right button, or (F5 or CTRL/M) √ - Display options menu Mouse left or right button, or (F6 or CTRL/O) ? - Display help screen Mouse left or right button, or (F7) ■ - Exit from program (return to DOS) Mouse left or right button, or (F8 or CTRL/X) Apart from these commands there are four others that can only be entered from the keyboard: Home - Go to first recipe. End - Go to last recipe. Delete - Deselect recipe being viewed and move on to next one. CTRL/A - Select all recipes in file. Mark/Select Recipe Screen ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ After choosing this function a list of all the recipes in the file will be displayed. This list can be scrolled and the individual recipes can be selected/deselected for viewing. Only selected recipes will be displayed on the 'recipe viewing screen'. Here the mouse region is the left-hand column of the screen. The cursor can be moved either by using the mouse or the up/down arrow keys (or F2/F3). The commands are as follows: On RECIPE line Mouse left button: Select/deselect recipe (ENTER) Mouse right button: Select/deselect ALL recipes (CTRL/ENTER) - Scroll list up Mouse left button: Scroll up 1 page (F1 or PgUp) Mouse right button: Scroll up 5 pages (CTRL/F1 or CTRL/PgUp) - Scroll list down Mouse left button: Scroll down 1 page (F4 or PgDn) Mouse right button: Scroll down 5 pages (CTRL/F4 or CTRL/PgDn) √ - Display 'select' options menu Mouse left button, or (F6 or CTRL/O). ■ - Exit from menu Mouse right button, or (F8 or CTRL/X). Note: The mouse can be simulated by using the arrow keys to position the cursor, ENTER for the left button, and CTRL/ENTER for the right button. For example, to scroll the list up by 5 pages press the up arrow key until the cursor is at the top of the screen and then press CTRL/ENTER). Apart from these commands there are six others that can only be entered from the keyboard: Home - Go to top of screen. End - Go to bottom of screen. CTRL/Home - Go to first recipe in list. CTRL/End - Go to last recipe in list. CTRL/R - Reverse all selections (i.e. all selected recipes become deselected and all unselected become selected). F7 - Display help screen Here is an example of how to select a single recipe for display: 1) Deselect all recipes by positioning mouse on any recipe line and pressing the right button (keyboard: CTRL/ENTER). 2) Scroll list up/down until the required recipe is visible on the screen. To do this position the mouse on the appropriate arrow symbol and press the right/left button (keyboard: use PageUp and PageDn keys to scroll) 3) Select recipe by positioning the cursor on the desired recipe line and pressing the left mouse button (keyboard: use the arrow up/ down keys to position the cursor and the ENTER key to select). After doing this and exiting from this screen (press the right button when the mouse is at the bottom of the screen, of press CTRL/X, F8, or CTRL/ENTER) the contents of your selected recipe will be displayed. When a recipe file is newly loaded all recipes are automatically selected. Mark/Select Options Menu ════════════════════════ This menu is entered from the 'Select Recipe Screen' (using F6, CTRL/O, or by positioning the cusor at the bottom of the screen and pressing the left mouse button). The following menu is then displayed: Select recipes using: -KEYWORDS -RECIPE CODES -TEXT SEARCH -Exit from menu This menu allows you to select the recipes in groups according to keywords, recipe codes or the result of a text search. To select one of the items in the menu position the cursor next to the option and press either of the mouse buttons or the ENTER key. After choosing an option, selecting some recipes and then returning to the 'Select Recipe Screen' the recipes that correspond to the keywords, codes, etc. will be marked as selected. Selecting Recipes by KEYWORDS ───────────────────────────── After selecting this option a list of all keywords that have been found in the recipe file will be displayed in alphabetical order. After each keyword appears a number, this is the number of recipes that contain this keyword. The entry .None. (usually the last keyword in the list) represents any recipes that have no keywords at all. Selecting keywords is exactly the same as manually selecting recipes, use the mouse or arrow keys to position the cursor and then select using the mouse buttons or ENTER key. Following is a full list of available commands. On KEYWORD line Mouse left button: Select/deselect recipe (ENTER) Mouse right button: Select/deselect ALL recipes (CTRL/ENTER) - Scroll list up Mouse left button: Scroll up 1 page (F1 or PgUp) Mouse right button: Scroll up 5 pages (CTRL/F1 or CTRL/PgUp) - Scroll list down Mouse left button: Scroll down 1 page (F4 or PgDn) Mouse right button: Scroll down 5 pages (CTRL/F4 or CTRL/PgDn) ■ - Exit from menu Mouse left or right button, or (F8 or CTRL/X). Note: The mouse can be simulated by using the arrow keys to position the cursor, ENTER for the left button, and CTRL/ENTER for the right button. For example, to scroll the list up by 5 pages press the up arrow key until the cursor is at the top of the screen and then press CTRL/ENTER). Apart from these commands there are five others that can only be entered from the keyboard: Home - Go to top of screen. End - Go to bottom of screen. CTRL/Home - Go to first KEYWORD in list. CTRL/End - Go to last KEYWORD in list. F7 - Display help screen Note: It is possible to achieve interesting results when combining keyword selection with the reverse selection command (CTRL/R) in the 'select recipe menu'. For example, assuming that the keyword MICROWAVE is in the list then you can select all recipes that do not contain this keyword by first selecting the keyword and exiting from that screen, and then pressing CTRL/R. This negates the keyword selection and achieves the desired result. Selecting Recipes by RECIPE CODES ───────────────────────────────── After selecting this option a list of the recognised recipe codes will be displayed. The process for selecting RECIPE CODES is exactly the same as for KEYWORDS, use the mouse or arrow keys to position the cursor and then select using the mouse buttons or ENTER key. Following is a full list of available commands. On RECIPE CODE line Mouse left button: Select/deselect recipe (ENTER) Mouse right button: Select/deselect ALL recipes (CTRL/ENTER) ■ - Exit from menu Mouse left or right button, or (F8 or CTRL/X). Apart from these commands there are three others that can only be entered from the keyboard: Home - Go to top of screen. End - Go to bottom of screen. F7 - Display help screen Selecting Recipes by TEXT SEARCH ──────────────────────────────── After selecting this option a small submenu will be displayed: Search method__________HEADER Start search Exit from menu The 'search method' is the way in which each recipe is searched. By positioning the cursor at this option and selecting the displayed method will change. The possible values are: HEADER -------- Only search recipe headers (i.e. lines that start with .RH or .RZ - see section 'Recipe Files - The Commands'). INGREDIENTS --- Only search the ingredient lines (i.e. lines that start with .IG - see section 'Recipe Files - The Commands'). FULL ---------- As the name implies, this searches all recipe lines for a text match. (This can take sometime depending on how large the recipe file is). After the search method has been set select 'start search'. You are then asked to input a text string of upto 32 characters. This string will automatically be converted to uppercase while being input. Don't worry about this because the search is not case dependant. After entering the string press ENTER to start the search. Any recipes found to contain the search string will be marked as selected when returning to the 'Select Recipe Screen'. You can see the number of successes by looking at the value of the 'recipes selected' indicator on the status line. Options Menu ▀▀▀▀▀▀▀▀▀▀▀▀ This menu is entered from the 'recipe viewing screen' (using F6, CTRL/O or by positioning the mouse on the 'v' symbol in the status line and pressing either button). The following menu is then displayed: Imperial/metric ANSI/text Load recipe file Output recipe Exit from menu Here you can set display parameters, load a new recipe file or output recipes to the printer or to a file. To select one of the items position the cursor next to the option and press either of the mouse buttons or the ENTER key. Display Parameter - Imperial/Metric ═══════════════════════════════════ Each time this item is selected it causes this parameter to toggle between 'IMPERIAL' and 'METRIC'. The current value is displayed to the right of this item. The value selected governs which measuring system to use when displaying a recipe (if a choice of measurements is available). Display Parameter - ANSI/Text ═════════════════════════════ Each time this item is selected it causes this parameter to toggle between 'ANSI' and 'TEXT'. The current value is displayed to the right of this item. The value selected governs the use of ANSI escape sequences for displaying recipes (i.e. if coloured/underlined/bold/reverse text attributes are used). The option 'TEXT' means that only text is output to the screen, no escape sequences are used. Load Recipe File ════════════════ After selecting this you will be asked to enter the file name (including path) of a new recipe file. The recipes displayed on the 'recipe viewing screen' will be the contents of this file. This option can be aborted by pressing the ESC key. Output Recipe ═════════════ Selecting this item will cause the following sub-menu to be displayed: Function Destination Index options Start output Exit from menu The menu items displayed here can be selected in the usual way by positioning the cursor and pressing a mouse key or ENTER. Function ──────── This controls the format of the output. By pressing the ENTER key or a mouse button you can select one of the following: PRINTER -- Output selected recipes with printer escape sequences. INDEX ---- Output index of all recipes. TROFF ---- Output selected recipes in troff format (i.e., the same format as in the input file. TEXT ----- Output selected recipes as plain text (no escape sequences). Destination ─────────── This controls where the output goes to - direct to PRINTER or to a FILE. If the output is to bo written to a file you will be later asked to enter the name of this file. Index options ───────────── Selecting this causes a sub-menu to be displayed: Group By Order By Exit from menu These options only effect output in INDEX format (i.e. when FUNCTION = INDEX). Group By ... this can be one of the following: NO GROUPING -- No grouping of the recipe titles will occur. The titles will simply be listed. KEYWORD ------ Group recipes according to any KEYWORDS that they contain. CODE --------- Group recipes according to the recipe code found in the recipe header. Order By ... this can be one of the following: NO ORDERING -- The recipe titles will be listed in the same order that they occur in the input file. TITLE -------- Order recipes by their title. UNIX NAME ---- Order recipes by their 14 character Unix file name. Start output ──────────── After setting the relevant options mentioned above, the output can be started by selecting this option. If the output is to go to a file then you will be asked to input the name for the output file. As the recipes are output a count of the recipes output is displayed on the righthand side of the status line. The name of the recipe currently being output is displayed on the lefthand side of the top line of the screen. If an INDEX is being output the the current state of the program is also displayed next to the recipe count on the status line. When the output is complete the normal status line is redisplayed. Recipe Files ▀▀▀▀▀▀▀▀▀▀▀▀ The Commands ════════════ The format of the recipes files is similar to that used by the USENET Cookbook (alt.gourmand newsgroup). This is basically a subset of the commands used by the text formating program ROFF and is known as TROFF. This format was chosen so that recipes obtained from this newsgroup can immediately be used with FoodView. The basic idea behind Troff is to format a file using as few commands as possible. The commands are embedding in the text as small strings that begin with either the symbol '.' or '\', most of which must occur at the start of a text line. Below is a list of the commands that FoodView understands: CMD - Description Parameters ════ ═══════════════════════ ═══════════════════════════════════════════════ .AB - Measurement conversions "Imperial value", "metric value", punctuation .B - Bold text "Text string" .I - Italic text "Text string" .IG - Ingredient line "Imperial value", "description", "metric value" .IH - Ingredient header "Imperial value", "metric value" .IP - Indented paragraph "Text string" .KY - Keyword List of keywords separated by spaces .NX - Notes header .PD - Paragraph distance Distance .PH - Procedure header .PP - Paragraph break .RE - Relative indent. end .RH - Recipe header Source, Unix file, recipe code, "date", year .RS - Relative indent. start .RZ - Recipe title "Title", "brief description" .SH - Sub-header "Text string" .SK - Procedure step Step number .SM - Small text "Text string" .TE - Temperature "Farenheit", "centigrade", punctuation .WR - Wrap up .br - Start new line .fi - Fill (text float) on .nf - Fill (text float) off NOTE: The commands .if, .ds and .ta are supported by the USENET Cookbook but not by FoodView. (I havenot been able to find an exact description of these commands and would be grateful for any help, so that they can be included in future versions of FoodView). The above commands must be at the start of a new line, which must contain any parameters required, and should not contain any recipe text other than this. Below is a list of the 'in-text' commands that may occur anywhere on a normal text line (or within a command parameter). \fB - Bold on \fI - Italic on \fP - Bold/italic reset \fR - Bold/italic reset \z\(aae - 'e' acute accent (?) \z\(gaa - 'a' grav accent (?) \**:o - 'o' umlaut (?) \- - dash (-) \(12 - half (?) \(14 - quarter (?) \(34 - three quarters (?) \(em - minus (-) \(mu - multiplication (x) \(de - degrees (?) Try examining the included recipe DEMO.REC to see have these commands are used. The following is a 'skeleton' recipe: .RH RECIPE-SOURCE RECIPE-ID CODE "23 Sep 91" 1991 .RZ "RECIPE TITLE IN CAPITALS" "Recipe description" .KY PARTY GREEK Introductory text (use .PP between paragraphs). .IH "Makes 4 cups" "Makes 900 ml" .IG "2 oz" "butter" "50 g" .IG "1" "onion," finely chopped .PH <-- Procedure header .SK 1 <-- Procedure step Prepare onion. <-- Text for step .SK 2 <-- and so forth Fry onion slowly. \fBDO NOT BURN\fR. .NX Notes (commentary) goes here. (Use .PP to separate paragraphs). .SH RATING <-- Sub-header .I Difficulty: easy. .I Time: 10 mins. .I Precision: Approximate measurements. .WR <-- Wrapup information, e.g: Paul Hosken RMCB@DLRVM Measurement System ══════════════════ Most countries in the world use metric measurements for their recipes. The U.S. and England defiantly use an imperial system that uses teaspoons, cups, pints, onces, etc. (Be careful, the U.S. and English systems are slightly different). Attempts to convert U.S. cooks to the metric system have failed, and many American cooks have never seen a metric recipe. With this in mind the Troff format tries to cater for both systems of measurements by including both values in the body of the recipe. The format of commands that reference the measurement system is to first include the imperial value and then the metric one. (Note: by imperial I mean the American measuring system, and not the English one - the English are partly converted to the metric system and should have no problem with metric measurements). If a metric value has not been specified in a command that expects one then the imperial value is used. Printer Information File ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ When outputing a recipe to a printer the program uses a file called FOODVIEW.PRN, which it assumes to contain the escape sequences needed to control the printer. Two PRN files are included in the package, the first (FOODVIEW.PRN) is a demonstration file and contains dummy escape sequences. This file must be edited to contain the escape sequences that match your printer before a recipe can be sensibly printed. The second PRN file (HPLJ2P.PRN) is a completed printer file for a HP Laserjet IIP laser printer. To use this file rename it as FOODVIEW.PRN . The format of a PRN file can be easily understood by studying the initial FOODVIEW.PRN file. In general this file simply contains a list of escape sequences in a specific order. Comments lines may be put anywhere in this file. A comment line must begin with the character ';' . The order of the information in the printer file is as follows: 1) Page width (integer) 2) Printer reset (escape sequence) 3) Attributes off (esc. seq.) 4) Bold on (esc. seq.) 5) Italics on (esc. seq.) 6) Attributes for headers, i.e. bold, underline, etc. (esc. seq.) 7) Attributes for recipe title (esc. seq.) 8) Attributes for notes title (esc. seq.) 9) Attributes for procedure step numbers (esc. seq.) 10) Small printing on (esc. seq.) (Note: The format used in this file has two drawbacks; (i) escape sequences that start with the character ';' will be treated as comments, (ii) because the program reads this file a string at a time the character zero cannot be included in an escape sequence because it marks the end of a string. This is not so problematic as many printers offer alternavite ways on coding a zero.) If the program is unable to find the printer file, or unable to assign any of the escape strings then no escape sequence will be output. This means that if you don't wish to bother with printer escape sequences then just delete the FOODVIEW.PRN file. (The default value for the page width is 80 characters.) Registration ▀▀▀▀▀▀▀▀▀▀▀▀ If you complete the registration form and send it to me along with the fee, you will receive a registration code. To enter this code start the program with the -R switch as follows: FOODVIEW -R If the program has not already been registered you will be asked to enter this registration number and your name. Registering the program will suppress and registration messages and possibly allow the use of extra functions in future versions. The registration code will be valid for ALL versions of FOODVIEW. The version 2.33 of FOODVIEW is pre-registered. This is so that users can try out all aspects and functions of the program and, hopefully, send me any comments or ideas they have about improving the program.