# The &krecipes; Handbook

Colleen
Beamer

    cbeamer@interlynx.net

Jason
Kivlighn

    mizunoami44@users.sourceforge.net

2004-2005
Colleen Beamer and Jason Kivlighn
&FDLNotice;
2005-03-01
0.7

&krecipes; is an application to manage recipes.

KDE
kdeextragear-3
Krecipes
cookbook
recipes

## Introduction

&krecipes; is a program that lets you to manage your recipes, create shopping lists, choose a recipe based on available ingredients and plan your menu/diet in advance.

## Using &krecipes;

### Getting Familiar

When &krecipes; starts, the window displays the following components −

- A menubar containing selections for File, Edit, Tools, Settings, and Help

- A toolbar with icons for New, Save, and Print

- A left-hand pane containing icons depicting and buttons for access to the various components of &krecipes;

- A right-hand pane, which is the main &krecipes; window, that by default contains a recipe category list

Here's a screenshot of the main &krecipes; window. Screenshot

The Main &krecipes; Screen

### Finding and Editing Recipes

By default, &krecipes; starts with the "Find/Edit Recipes" component selected in the left pane of the window.

This section describes the method of finding recipes in the "Find/Edit Recipes" component. For more specific details on Editing recipes, see the section Editing Saved Recipes

With the Find/Edit Recipes component button selected, the main &krecipes; window displays the following −

- A title showing the name of the component selected

- Basic (the default) and Advanced tabs

- A textbox to `enter search criteria`

- A drop-down menu for selecting the recipe category to search, or which can be used to select a single category of recipes to display

- A list of all recipe categories

- Buttons for Open, Edit and Delete for performing the corresponding action on a recipe

For more information on the basic search functionality, click the icon in the bottom, right-hand corner of the pane containing the component list.

With the Basic tab active and the list of recipe categories displayed, a category with a plus (+) sign beside it indicates that the category contains recipes.

#### The Advanced Tab

The purpose of the Advanced tab is to provide advanced search capability. Queries for recipes can be made based on five search criteria −

- Ingredients

- Categories

- Servings

- Preparation Time

- Authors

Ingredients, Categories, and Authors each have their own tab. Servings/Preparation Time appear on the same tab. To enable one of the tabs for search purposes, select the appropriate tab and click the tickbox beside the label Enabled that appears on the left side of the screen.

For "Categories", "Ingredients", and "Authors", the search can be narrowed further by selecting sub-criteria. To select sub-criteria, click on the check box beside the name of a specific "Category", "Ingredient" or "Author". Also in these tabs, the Select All button may be used as an alternative means of selection. If this button has been pressed and it is decided that all sub-criteria are not desired, the Unselect All button can be utilized to clear the selections.

For "Servings" and "Preparation Time" criteria, a "Spin button" is used to increase/decrease the values.

When all desired criteria have been selected, click the Find button that appears on the right-hand side of the screen near the top to reveal a list of recipes meeting the specified criteria. This button may be selected from within any of the tabs once all search criteria have been selected.

The results of the search will appear in the list area below the criteria under the heading Title. The Clear button, which appears below the Find button is used to clear the results in order to perform a new search.

Here's a screenshot of a completed search in &krecipes; after selecting criteria in the Advanced Search tab. Screenshot

Advanced Search with Search Results

- Searching is case-sensitive. If the ingredient list contains Eggs and eggs and eggs is specified as one of the criteria, only recipes containing eggs will display, although recipes containing the ingredient Eggs might exist.

- Only recipes meeting ALL criteria will display!

### Entering and Editing Recipes

#### Adding a New Recipe

To add a new recipe, click on the icon that appears in the first position on the &krecipes; toolbar. The "Edit Recipe" screen will display.

The "Edit Recipe" screen has three tabs. Each permits entry of a different aspect of the recipe. These tabs are −

- Recipe

- Ingredients

- Instructions

Here's a screenshot of the recipe entry screen showing the 3 tabs. Screenshot

The Recipe Entry Interface

It should also be noted that in the left-hand pane of the window, a button shows at the bottom of the component list that initially displays "Write the recipe title here". This will change to the name of the recipe once it has been entered.

#### The Recipe Description

##### Adding the Recipe Name

The title of the recipe is entered in the textbox containing the prompt "Write the recipe title here".

##### Adding the Recipe Author/Contributor

To enter an author for the recipe, click on the + that appears to the right of the "Authors" box.

A window will appear where the author or contributor of the recipe can be selected from the drop-down menu. Once selected, transfer the name to the list box below by clicking on the button that appears to the right of the list box.

- An author's name can be typed into the textbox and transferred to the list box as described above. In this situation an alert box will appear with the message "A new author "Name of New Author" was successfully added to the list of authors". Also see The Authors Component. for information on adding an author to the list.

- An author may also be removed from the list by clicking the button.

Click on the OK button to accept. The window will close and the name of the selected author will appear under the heading.

To cancel selection of an author, click on the Cancel button.

##### Selecting the Recipe Category

Next, the recipe category is selected by clicking on the + beside the category box.

To select a category, click on the checkbox beside the category name and click the OK button to accept the selection or, the Cancel button to cancel the selection. Either way, the window will close.

It is also possible to add a category here. Simply click on the New Category... button. Add a new category in the same manner as described in the section entitled The Categories Component.

##### Setting the Number of Servings

Setting the number of servings provided by the recipe is performed by utilizing a spinbox. Simply increment (or decrement if a mistake is made) the number until the desired number is displayed.

##### Specifying Preparation Time

Similar to setting the number of servings for the recipe, the time it takes to prepare a recipe is also done utilizing a spinbox.

However, the time must be specified in two steps −

1. Select the digits prior to the : symbol that specify the hours and increment the time until the desired number is reached.

2. Select the digits after to the : symbol that specify the minutes and increment the time until the desired number is reached.

##### Changing the Default Photo

In the Recipe tab, the displayed photo can also be changed by clicking on the ... button and selecting a photo for insertion. Alternatively, a photo may be inserted by dragging a graphic from any other application, for example a web page, and dropping it onto the photo in the Recipe tab while in edit mode.

The change in the graphic applies only to the current recipe.

- To revert to the original, &krecipes; graphic, click on the button. This can be done before the recipe is saved or after saving it.

- To display NO photo in the recipe, refer to the section Selecting Items to Display for further instructions.

Here's a screenshot of a completed recipe description in the Recipe tab of the &krecipes; recipe entry interface. Screenshot

New Recipe Entry - The Completed Recipe Tab

#### Entering Recipe Ingredients

To enter the recipe ingredients, click on the Ingredients tab. By default, the radio button beside the label Ingredient: is selected. However, &krecipes; also allows the entry of a Header: by selecting the radio button beside this label.

Ideally, the header should be created first, for example "Cake" or "Frosting". To do this, ensure that the Header: radio button is selected. Enter the desired name for the header in the textbox then, press the Enter key, or click the Add ingredient button located at the top right-hand side of the ingredient list. Once this is done, the radio button will automatically revert to the Ingredient: selection. Then, ingredients can be entered. You will note that as you enter each ingredient, it will appear below the header indented in a "file tree" type of format.

Although it is ideal to enter the header first and then the ingredients associated with that header, you can also enter the header after entering the ingredients. Enter the header as described above, then move the ingredient into the header by utilizing the or button to position the ingredient until it appears indented below the appropriate header.

Ingredients are entered by filling in the appropriate textbox under the headings −

- Ingredient: the ingredient is entered here, for example, Sugar

  - Type in the first few letters of the ingredient. If it exists in the ingredient list, it will appear in the textbox "grayed-out". To select the gray-out ingredient, tab to the next textbox.

  - The Ingredient can also be selected from the "drop-down" menu.

- Amount: the amount of the ingredient required, for example, ½

- Unit: the unit of measurement, for example, tsp. When you enter a unit, if it does not exist in your Units list, it will automatically be added and a dialog box will appear prompting for the entry of a plural for the unit. Enter the plural in the textbox beside the label Plural:. For more information on adding and maintaining units of measure, see The Units Component.

- Preparation Method: the method of preparing the ingredient, for example, chopped

  The Preparation Method can also be selected from a drop-down menu.

To add the ingredient to the ingredient list, simply press the Enter key.

Alternatively, click on the Add Ingredient button on the right-hand side of the ingredient list.

- Once the ingredient has been added, the textboxes will retain the information from the previous ingredient. The ingredient should be highlighted, in which case it is possible to just start typing. However, if this is not the case, simply delete the entry and start typing the new ingredient information.

- If a particular field is not required to describe an ingredient and it has information retained from a previous ingredient, simply delete the information. A field can be left blank if not required!

- An ingredient may be removed from the list by clicking on the button to the right of the ingredient list.

- An ingredient may also be repositioned in the list by clicking on the or the button that appear on the right of the ingredient list.

- Once an ingredient has been transferred to the ingredient list, the "Amount", "Units" and "Preparation Method" fields may be edited by doubleclicking on the particular component that needs to be changed.

Here's a screenshot of the completed Ingredients tab in the &krecipes; recipe entry interface. Screenshot

New Recipe Entry The Completed Ingredients Tab

#### Entering the Recipe Instructions

To enter the recipe instructions, click on the Instructions tab.

Entering the recipe instructions is simple in the whitespace provided, simply type in the steps necessary to complete the preparation of the recipe.

To make absolutely sure that typing is done in the correct area, the prompt Write the recipe instructions here is displayed! ☺

A VERY COOL part of entering the recipe instructions is the Auto Completion feature! This is a real time and effort saver if your instructions refer to many of the ingredients in your ingredient list, and/or if your ingredient names are lengthy. This is how it works −

In the "Carrot Soup" recipe shown in the screenshot, we have the ingredient "vegetable stock". As you begin typing "vegetable stock" in your recipe instructions, &krecipes; will match typed characters with ingredients in your ingredient list and automatically complete the remaining characters.

For example, if you type "veg", the characters "etable stock" are the ones that will be auto-completed and inserted into the instructions. The auto-completed characters will appear highlighted and you can choose to accept the suggested ingredient by pressing the Enter key.

However, suppose that in your instructions, you simply wanted to refer to "vegetable stock" as stock and you enter the character "s". &krecipes; will search your ingredients and match the first ingredient beginning with "s" that it finds, for instance, salt. The remaining characters, i.e. the "alt", will be auto-completed and highlighted. Simply press the Delete key on the keyboard to remove the unwanted characters and continue typing. Alternatively, you can just continue typing the entire word and your instructions will remain as typed.

#### Recipe Actions

OK! Now that the recipe has been input, what needs to be done?

The following options can be selected −

- Spell-check this is accomplished by clicking on the ABC icon that appears on the bar below the input area in the Instructions tab

- Save click on the Save button that appears on the bottom of the screen

  The Save button can be used to save the recipe at any point during the input. As with any other application, when editing, it is always a good idea to save frequently!

- Show recipe click on the Show recipe button to view the recipe.

  To view a recipe, it must be saved. If the recipe has NOT been saved at the time that the Show recipe button is clicked, the following alert will appear −

  You need to save the recipe before displaying it. Would you like to save it now?

  Click the Yes button to save the recipe, or the No button to close the dialog and return to the recipe entry interface

  If the Show button is pressed, the recipe will display. To return to the Edit Recipe interface in the event that the recipe has not been completely entered, click on the Recipe Name button that appears at the bottom of the component list in the left-hand pane of the window. Alternatively, Tools and Edit can be chosen from the &krecipes; menu, or select the &Ctrl;E key combination.

- Close click the Close button.

  Again, if the recipe has not been saved an alert will appear stating −

  This recipe contains unsaved changes. Would you like to save it before closing?

  The course of action can be selected by clicking the Yes button to save, the No button to close the recipe without saving, or the Cancel button to close the dialog and return to the recipe entry interface.

- Resize click the Resize button to resize the recipe

  The recipe can be resized by either of two methods −

  1. Scale by servings the current number of servings that the recipe will provide is shown. Change in the number of servings is accomplished by using a spinbox. Once the new number of servings has been specified, the recipe ingredients will be sized accordingly

  2. Scale by factor to scale the recipe by a specified factor, for example, ½ to half the recipe, or 3 to triple it

  In either of these scenarios, click the OK button to continue and resize the recipe, or the Cancel to close the window and return to the previous screen.

Here's a screenshot of the completed Instructions tab in the &krecipes; recipe entry interface. Screenshot

New Recipe Entry The Completed Instructions Tab

#### Editing Saved Recipes

The feature for editing recipes can be accessed in a number of ways. With the "Find/Edit Recipes" component selected,

1. Select the recipe to be edited from the recipe list in the main portion of the &krecipes; window. Click on the Open Recipe(s) button. From the Tools menu, select Edit Recipe, or the &Ctrl;E key combination can be pressed.

2. Select the recipe to be edited from the recipe list in the main portion of the &krecipes; window. Click the Edit Recipe button.

Either way, the identical screen that appeared when entering a new recipe displays. For a complete description of this screen, refer to the section Adding a New Recipe.

All aspects of the recipe can now be edited −

- the Recipe Name, Authors, Categories, Servings, Preparation Time and/or graphic from the Recipe tab

- the Amount, Units, and/or Preparation method for each listed ingredients in the Ingredients tab

  Also in this tab, an ingredient can be added by clicking on the New Ingredient button that appears on the top, left-hand side of the ingredient list, or deleted by clicking on the button

- the preparation directions from the Instructions tab

As with entering a new recipe, the buttons Save Recipe, Show Recipe, Close and Resize Recipe are available from each of the tabs

While editing the recipe, if the Show Recipe button is selected, the Unsaved changes - krecipes dialog box appears stating This recipe has changes that will not be displayed unless the recipe is saved. Would you like to save it now?. The Yes, No or Cancel buttons are available for selection.

The important detail to note is that in order to continue editing the recipe, the Edit Recipe interface must be accessed. This can be done in a variety of ways −

- Select Tools and then, Edit Recipe from the &krecipes; menu

- Press the &Ctrl;E key combination

- Click on the Recipe Name button that appears at the bottom of the component list in the left-hand pane of the window this button appears once the recipe to be edited has been loaded and a change has been initiated

With the "Find/Edit Recipes" component selected and the list of recipes showing on the right-hand side of the screen, an entire recipe may be deleted by selecting it from the list and clicking the Delete button.

### Page Setup

To access Page Setup, select View and Page Setup... from the &krecipes; menu bar.

Here's a screenshot of the Page Setup dialog Screenshot

Page Setup

#### Selecting Items to Display

In the Page Setup window, the toolbar displays the icons for Open, Save, Save As and Redisplay.

With regard to Redisplay, a word of caution is in order. Clicking on Redisplay after changes have been made in the Page Setup window, will reload the currently active layout file, erasing all changes unless they have been saved. However, an alert will be provided prompting to save the changes if desired.

If the entire Page Setup window is resized, Redisplay will scale the contents to fit within the limits of the window.

The last icon allows access to a list of items that are available for display in the recipe. These include

- Properties The list of nutrients in the recipe

- Authors The authors or contributors of the recipe

- Ingredients The list of recipe ingredients

- Preparation Time The time for preparation

- Servings The number of servings expected from the recipe

- Instructions The method of preparation

- Title The title of the recipe

- Photo To display a photo in the recipe

- Header This is the recipe database ID

- Categories The category to which the recipe belongs

By default, all items are displayed. To prevent display in the recipe, deselect the item by clicking on the checkbox beside it.

All sections chosen to display in the recipe will also print. It may be desirable to have a section display, but not print. In order to avoid having any section print, deselect it prior to printing.

#### Changing The Recipe Display

Display of the recipe is highly configurable.

Each section can be moved by selecting a it, holding the &LMB; mouse button and dragging to a new position.

To resize a section, hover the mouse over one of the resizing handles until a ↔ arrow appears, hold the &LMB; mouse button and drag until the desired sized is achieved.

#### Changing Attributes

Characteristics of each section can be changed individually.

Right-click on any section in the Page Setup window. A menu will display with the title of the section appearing at the top. From this menu, you can

- Change the Background color...

- Change the Text color...

- Change the Font...

- Choose whether or not to display the section by selecting or deselecting the checkbox beside Show

- Change the Alignment This menu item has a sub-menu that allows you to select the alignment

- Define a Border... that will appear around the selected section

  When the "Requested Border" configuration window appears, there are sections that allow the definition of various elements under the appropriate headings. For example −

  - Under the heading "Style", a border style can be selected

  - Under the heading "Color", a color can be selected from the color spectrum and this can be fine-tuned, using the color slider

  - Under the heading "Width" the width of the border, in pixels, can be selected. For a border such as "Groove", or "Ridge" a minimum pixel size of 4 to 6 has been found to work best. The border size can be selected using a spinbox or selecting a numeric value from a list

  Finally, at the bottom is a section that allows the preview of the border as it will appear in the recipe.

  When "OK" is selected to insert the border, the main Page Setup window appears. The selected border definition will NOT show in this window, but will appear properly when the recipe is viewed or printed.

### Importing and Exporting Recipes

&krecipes; allows the import of recipes from a file or from a database. Recipes can also be exported to other formats.

#### Importing from a File

&krecipes; allows the import of recipes from the following formats −

- &krecipes; files of this format will have extensions of .kre or .kreml

- MasterCook files of this format will have extensions of .mx2 and originate from MasterCook 5 or 6

- MasterCook Export files of this format will have extensions of .mxp or .txt and originate from MasterCook 4

- Meal-Master files of this format will have extensions of .mmf or .txt

- "Now You're Cooking" Generic Export files of this format will have extensions of .txt

- RecipeML files of this format will have extensions of .xml or .recipeml

- Rezkonv files of this format will have extensions of .rk or .txt

To import a recipe from a file of one of the above formats, select File from the &krecipes; menu bar. From the available choices, select Import from File ...

A window will appear that allows the navigation to the file that you wish to import. Navigation can be done using the "point and click" method, or the location of the file may be entered directly into the box labelled Location:.

The Filter: box is used to select the format of the recipe being imported from the drop-down menu.

To position the cursor for entry into the Location: box, the key combination &Alt;L can be used. To position the cursor for entry into the Filter: box, the key combination &Alt;F can be used.

Once you have navigated to the location of the recipe file that you want to import and have selected the correct format, all the recipes saved in the selected format will appear in the file list. If import of only one recipe is desired, select the file that you wish to import and its name will appear in the Location: box. Press the OK button to proceed with the import, or the Cancel to close the file selection window and return to the previous screen.

When you click on the OK button, the &krecipes; Import Recipes window will appear.

Here's a screenshot of the Import Recipes screen. Screenshot

The Import Recipes Window this window will appear when you are importing from a file OR from a Database.

Under the heading Recipes, drop-down lists will appear −

- All This list will be expanded by default and is selected by default whether one recipe or multiple recipes are being imported (the tickbox to the left of the label will contain a check mark). In brackets, to the right of the label, the number of recipes being imported will appear.

- Uncategorized You may have to click on the + button to expand the list to reveal the recipe names. Again, to the left of the label, the tick box will be selected and the number of recipes being imported will show to the right. From the list of recipes, any recipes that you do not wish to import can be deselected by clicking on the tickbox to remove the check mark.

  You may also see (or only see) a list item named "Categorized" if any of the recipes that are being import have had categories, for example "Desserts", attached to them.

Click the OK button to proceed with the import, or the Cancel button to prevent the import and close the window.

It should be noted that the Cancel button can be pressed after the import starts. In this situation, any recipes that have been imported prior to pressing the Cancel button will remain in the database &krecipes; does not "rollback" completed imports on cancellation of the import process.

If the recipe(s) being imported are uncategorized, the recipe name(s) will appear intermingled with the category names in the &krecipes; Find/Edit Recipes window. In this case, you would select each recipe and edit it to either place it into its appropriate category or define a new category in which to place it. See the section Editing Saved Recipes and The Categories Component for instruction on how to do this.

If the recipe(s) are categorized, &krecipes; will put the recipe(s) into the appropriate category or create a new category if the appropriate one does not exist.

Regardless of whether the recipe being imported is uncategorized or categorized, it may still be appropriate to edit the recipe to define "Preparation Time", or otherwise fine-tune the recipe.

The manner in which the recipe imports into &krecipes; is DEPENDENT ON THE WAY IT HAS BEEN INPUT INTO THE ORIGINAL PROGRAM! If the recipe has been input into the original program in a sloppy manner, it will not import neatly into &krecipes;!

#### Importing from a Database

To import a recipe from an existing database, select File from the &krecipes; menu bar. From the available choices, select Import from Database ... The Database Import window will appear. Under the heading Database, you can make one of three selections. Your selection can be made by clicking the radio button beside SQLite, MySQL, or PostgreSQL.

##### Importing from SQLite

Here's a screenshot of the import dialog when importing from an SQLite database. Screenshot

Importing from an SQLite Database

If you choose SQLite, beneath the heading Database file:, there is a textbox and beside this, the Open File Dialog icon which, when clicked, will open the file dialog window. This window is used to navigate to the location of the database that you want to import. Once you have located the appropriate database file, select it from the file list. The name will appear in the Location: box. Click the OK button to proceed or the Cancel button to close the file dialog window and return to the previous screen.

Once the OK button is pressed, the file dialog window will close. You will be returned to the Database Import window and you should see the name of the database file with its "path" showing in the textbox. Click the OK button to proceed with the import, or the Cancel button to discontinue the import.

At this point, the import becomes common for whatever database you are importing.

##### Importing from MySQL

Here's a screenshot of the import dialog when importing from a MySQL database. Screenshot

Importing from a MySQL Database (The same interface would appear if the PostgreSQL radio button was selected.)

If the MySQL radio button is selected in the Database Import window, you will be required to enter the following parameters in the textbox beside the appropriate label −

- Server:

- Username:

- Password:

- Database name:

Once this information has been supplied, click the OK button to proceed with the import steps that are common to all. At this point, you may also click the Cancel button the cancel the import and return to the previous screen.

##### Importing from PostgreSQL

If the PostgreSQL radio button is selected in the Database Import window, you will be required to enter the following parameters in the textbox beside the appropriate label −

- Server:

- Username:

- Password:

- Database name:

Once this information has been supplied, click the OK button to proceed with the import steps that are common to all. At this point, you may also click the Cancel button the cancel the import and return to the previous screen.

##### Steps Common to All Database Imports

Similar to importing recipes from a file, the Import Recipes window will appear with the list item "All" and beneath this, sub-lists showing the categories being import. Also like importing from a file, the list items will have tick boxes on the left from which whole categories and/or recipes can be deselected by clicking on the box to remove the check mark. The total number of recipes will show to the right of the "All" list item and the number of recipes in each category will display to the right of the category item.

Click the OK button to proceed with importing the database, or the Cancel button to stop the import. If you choose to proceed, the categories and recipes that are in the database file being imported will appear in your &krecipes; recipe list.

#### Exporting Recipes to Other Formats

&krecipes; can export your recipes to the following formats −

- Compressed Krecipes format files of this format will have extensions of .kre

  This export format will result in a smaller file size and as a result disk space is saved. The smaller file size also makes sending over the Internet easier. This format also provides a useful means of backup.

- Krecipes files of this format will have extensions of .kreml

  Using this format exports your recipe in plain text which makes it easier to edit the recipe XML.

  When exporting in either Krecipes and Krecipes Compressed format, all information is guaranteed to be preserved. Other formats may support only certain information. If your recipes contain, for example, "Headers", and this is not supported by the export format that you have specified, that information is lost.

- Web page files of this format will have extensions of .html

  You might choose to export in this format in order to create a web page that contains your recipes. However, it should be noted that once exported in Web page format, you are unable to import these recipes back into &krecipes;.

- Meal-Master files of this format will have extensions of .mmf and you might want to export in this format to be able to import into the Meal-Master program to share will other Meal-Master users

  This is the most widely-used recipe format. However, you should note that if your choose to export in this format, certain &krecipes; recipe information will be lost.

- RecipeML files of this format will have extensions of .xml

  This is a standard recipe XML format, although not yet widely used by most recipe software. However, you may wish to use this format to have recipes recognized by programs that use it.

To export a single recipe to one of the above formats, first select the recipe that you wish to export. Then, select File from the &krecipes; menu bar. From the available choices, select Export ...

A window will appear that allows you to navigate to location where you wish to save your exported recipe. The location will default to your home directory, but another existing directory can be chosen, or you can create a new directory. The name of the recipe will appear in the box labelled Location: and this will default to the name that was given to the recipe in the &krecipes; database. However, this name can be changed to another at your discretion.

The Filter: box is used to select the format that you wish to use for the exported recipe from the drop-down menu.

You will also note that at the bottom of this window, there is a tickbox that allows you to select or deselect to Automatically select filename extension. The extension of the chosen export format will appear beside the phrase. If you choose to keep the tickbox selected, this extension will automatically be attached to the filename of your exported recipe.

To position the cursor for entry into the Location: box, the key combination &Alt;L can be used. To position the cursor for entry into the Filter: box, the key combination &Alt;F can be used.

Once the name of the exported recipe appears in the Location: box and you have chosen the format you wish to use for your exported recipe, click the Save button to proceed with the export, or the Cancel button to halt the export process and return to the previous screen.

When the Save button is clicked, the recipe will save in the chosen format and you will be able to open it with the program that accepts that file format for example, if you have chosen to export your recipe in "Meal-Master" format, you will be able to open it in any program that accepts .mmf format files. You will also notice that the export process has created a directory in which the graphics related to your exported recipe are stored.

You may also export categories of recipes or your whole database in this same manner. However, if you want to export your entire database, you must ensure that no recipe or category is selected in your recipe list.

If you recall, when &krecipes; starts, by default the "Find/Edit Recipes" component is active and if you have recipes and categories, they appear in the right pane of the window. At this point nothing is selected, so you could choose to export your entire database. However, if there is something selected and you want to export, simple click on the white area of the category/recipe list. The highlight will disappear from the choice and you can now proceed to export your entire database.

### Other Krecipes Components

#### The Shopping List

The "Shopping List" component appears when the Shopping List button is clicked in the left pane of the &krecipes; window.

Here's a screenshot of the &krecipes; Shopping List component. Screenshot

The Shopping List Component

When selected, the component title appears at the top in the right pane of the window.

Below this is a textbox to `enter the specific name of a recipe` to search for. Recipes can also be chosen by selecting them from the list. Either way, the selected recipe must by transferred to the right-hand side of the screen under the heading Shopping List by clicking on the button between the two portions of the screen.

Once the desired recipes have been transferred to the shopping list side of the screen, click the OK button.

- Recipe names can also be transferred out of the shopping list side of the screen by clicking on the button.

- The entire list of recipes that has been selected for producing the shopping list can be cleared by clicking the Clear button.

When the OK button is clicked, a window will appear that lists all ingredients contained in the &krecipes; database on the left and the ingredients required for the selected recipe(s) on the right. Above each of these is a Search: textbox to `enter the name of an ingredient` to search for within each of the lists.

Ingredients can be transferred to and from either side by clicking on the or button that appears between the lists, as needed.

In the recipe ingredient list on the right, the "Amount" and the "Unit" of each ingredient can be edited by double-clicking on the appropriate value. For example, if the recipe requires 4 eggs and a purchase of eggs is required to make the recipe, it is unlikely that you would buy 4 eggs. In this case, the eggs ingredient could be selected, the "Amount" changed to 1 and the "Unit" changed to doz. or dozen.

When all desired changes have been made to the ingredients for the recipe(s) selected, click the Done button and the Shopping List will display.

From the Shopping List window, click the Print button to print the shopping list, or click the Close button to close the window.

#### The Diet Helper

The purpose of the "Diet Helper" component is to help plan menus for days, or weeks, at a time. Because of the ability to select nutrient values in this component, you are also able to plan your meals to adhere to nutrient limits. This makes either restricting or enhancing your diet much easier and more efficient.

Here's a screenshot of the &krecipes; Diet Helper component. Screenshot

The Diet Helper Component

The "Diet Helper" component is accessed by clicking on the Diet Helper button in the left pane of the &krecipes; window. As with other &krecipes; components, the user interface appears in the right pane under the heading Diet Helper.

To start setting up your menus, the first thing your have to do is select the number of days that you are planning for and the number of meals per day.

In the rectangular area under the heading Number of Days, the number of days is set at "- 1 -". To increase this value, click and hold the &LMB; and move the slider to the right. The value will increment up to "- 6 -" and then, change to "- 1 week -". After the number of days changes to "- 1 week -", increases are in increments of 1 week to a maximum of 4 weeks.

Similarly, in the rectangular area under the heading Meals per Day, the number of meals displays as "- 1 -". This value is incremented by clicking and holding the &LMB; and moving the slider to the right until the desired number of meals is displayed, up to a maximum of 10. When the slider is adjusted, a tab will appear for each of the meals.

The next step is to specify the number of dishes per meal. This is done by using the spinbox beside the No. of dishes: label to adjust the number.

Beside the No. of dishes: are the Previous Dish and Next Dish buttons that are used to navigate back and forth between dishes as you specify the type of recipe for each. As you utilize these buttons to move back and forth between dishes, you will note that in the Dish Characteristics area of the screen, the dish label changes as follows −

- 1st Course

- 2nd Course

- Dessert

And for subsequent meals −

- Dish 4, Dish 5, etc.

##### Planning Menus

In the Dish Characteristics area of the screen and beside the dish label, there is a tick box to Enable Category Filtering. Clicking this box enables the feature. It is important that you choose to do this because you may otherwise end up having Cheesecake, or some other unreasonable dish for breakfast!

With "category filtering" turned on, you can select the category to be used for the dish as specified by the dish label located beside the category selection box. For instance, the dish label might show 1st Course. If you are selecting courses for your dinner meal, you might then select the category Salads from the category list. A scrollbar exists to the right that allows moving up and down within the list.

Continuing with the example of selecting dishes for your dinner meal, you would then click the Next Dish button. When you do this, you will note that the dish label changes to 2nd Course and that again, you must turn category filtering on. Now, you can proceed with the selection of the category for your next dish, for example, Pasta.

Continue selecting the types of dishes for your meals in this same manner. When you have completed selecting the types of dishes, at this point, you can click the Create the diet button.

At this point, you are planning a menu only and not taking any dietary and nutrient constraints into consideration. To plan menus and consider nutrient consumption, see the section Planning Diet-Conscious Menus.

When you click the Create the diet button, the Diet window appears which displays your menus for the number of days that you have selected. In this window, you can click the Create Shopping List button to create the shopping list for your menus. You can also choose to print the menu by clicking the Print button. Clicking the Cancel button closes the Diet window and returns you to the previous screen.

##### Planning Diet-Conscious Menus

All the steps listed in the section Planning Menus also apply here. This section will discuss the incorporation of nutrient values into your menus.

Before you can include nutrients in your menu plan, you must ensure the following −

1. Nutrients or properties must be loaded for the ingredients. See the section Properties in Ingredients for further instructions. If an ingredient does not contain nutrient values, it will be ignored.

2. Units of measure must be associated with the ingredients. Since most nutrients are measured in g/g or mg/g, ensure that g is one of the units associated with each ingredient. See the section Units in Ingredients for additional information.

3. The equivalencies between the units of measure must be completed in the "Units Component" within the Unit Conversions tab. See the section Setting Equivalencies for instructions.

Once you have ensured that all necessary details have been provided for your ingredients, you are ready to consider nutrients in your menu plan. Of course, attending to these details should be done prior to the start of creating your menu/diet, since the consideration of nutrient values is a continuation of planning a basic menu.

In the portion of the screen that lists the nutrients, under the heading Enabled, select the nutrient that you want to consider by clicking on the tick box that appears to the left of the nutrient name. Note that you do not have to select every ingredient, only those that you wish to take into consideration. A scrollbar exists to the right that allows moving up and down within the list.

To the right of the nutrient name, columns labeled Min. Value and Max. Value exist. These are used to set the minimum and maximum values of nutrients so that when the search for appropriate recipes is done, only recipes that have a particular nutrient falling into the specified range will be considered for your menu/diet.

To set the minimum value for the nutrient in question, double-click on the "0" beside the nutrient name and under the Min. Value. A spinbox will appear that you can utilize to set the value that you want, or you can highlight the "0.00" value and manually type the value that you want to set. Once the desired value has been entered, click the OK to set it. Likewise, the maximum value is set in the same way under the Max. Value heading. These steps must be completed in each course category for each nutrient that you want to consider.

It should be noted that you may omit providing a minimum value for a nutrient, in which case the minimum value would remain as "0". However, if you provide a minimum value, you must provide a maximum because, obviously, a maximum cannot be less than a minimum.

At any point in the process of planning a menu/diet, you can click the Clear to clear all entries and begin again.

Once you have completed entering all the nutrient information, click the Create the diet to create your menu/diet.

When you click the Create the diet button, the Diet window appears which displays your menus for the number of days that you have selected. In this window, you can click the Create Shopping List button to create the shopping list for your menus. You can also choose to print the menu by clicking the Print button. Clicking the Cancel button closes the Diet window and returns you to the previous screen.

#### The Ingredient Matcher

The purpose of the "Ingredient Matcher" component is to find recipes that you are able to make (or almost make) with ingredients that you have on hand. To access the "Ingredient Matcher" component, click on the Ingredient Matcher button that is visible in the left frame of the &krecipes; window.

Once the component starts, typical of all &krecipes; components, the name will appear at the top of the window in the right frame. Beneath this, beside the Search: label, there is a textbox to `enter the recipe ingredient` that you want to search for.

Here's a screenshot of the &krecipes; Ingredient Matcher component. Screenshot

The Ingredient Matcher Component

Below the Search: box, under the heading Ingredient there is a list of all the ingredients that are in the &krecipes; database, both ones provided by default and those that you have entered by either adding them in the "Ingredients" component or by entering them in a recipe, which automatically adds the ingredient to the database. Elsewhere in this document, further information is provided on the use of the Ingredients Component.

Beside each ingredient in the list is a tick box which will allow the selection of the ingredient(s) that you have on hand that might be utilized in some of your recipes. Click on the tick box to select the ingredient. The scrollbar to the right of the list allows you to scroll through the entire list of ingredients. &krecipes; dictates that at least one of the selected ingredients be in each of the recipes listed in the search results.

Before the recipes containing the selected ingredients will display, you must select the number of missing ingredients permitted in your recipes. This is accomplished by using the spinbox beside the label Missing ingredients allowed:. There will always be certain ingredients that you have on hand, for example, Salt or Sugar. One of the purposes of allowing missing ingredients is to compensate for those ingredients that are normally in your cupboard.

Setting the missing ingredients too high will result in a longer list of recipes. Setting the missing ingredients too low will result in either no recipes being found, or cause the search to exclude recipes that you might also be able to make had you allowed for slightly more missing ingredients.

Click the Find matching recipes button to display the search results in the area that, by default, displays Possible recipes with the specified ingredients. The recipe title will appear under the heading Title. The recipe id will appear under the heading Id and the missing ingredients will display under the heading Missing ingredients. The width of the columns that apply to each of these headings can be adjusted for viewing purposes. The recipe list provided by the search is further sectioned under a heading that specifies the number of missing ingredients.

If your search does not provide recipes that are of interest, you can adjust the number of missing ingredients and click the Find matching recipes button to display new results based on the ingredients selected. Alternatively, you can press the Clear recipe list button to clear the recipe list to perform a whole new search with different ingredients.

&krecipes; makes in easy for you to find a recipe that you can make with ingredients on hand. However, if you do have to run to the store, once you decide on the recipe that you want to make, you can use the The Shopping List to make your shopping list.

#### The Data Button

The Data button performs one simple function when clicked, it gives access to additional components.

When the additional components are revealed, click the Up button to return to the previous list.

#### The Ingredients Component

The "Ingredients" component is accessed by first, clicking on the Data button to reveal the additional &krecipes; components, and then, clicking on the Ingredients button.

When the "Ingredients" component opens, the component title will be seen at the top. Below this, there are 3 sections −

1. Below the heading Ingredient list, the list of ingredients contained in the &krecipes; database is shown. These include ingredients that have be provided as defaults in the program and also, ingredients that you have added.

   Beside the heading is a textbox to `enter an ingredient` to search for in the ingredient list.

   To the right of this section is a + button, for adding ingredients to the list, and a - button, for removing ingredients. See the section on Working with Ingredients for more details.

2. On the right-hand side of the window under the heading Unit list, the section for listing the ingredient units of measure is displayed. These include default units of measure that have been provided with the program, as well as ones you have added.

   Again, a + button, for adding units of measure to the list, and a -, for removing units, appears to the right of this section. See the section on Units in Ingredients for more details.

3. Below the "Units list" is the Ingredient Properties list. This list contains the nutrient values of each ingredient.

   In this list, the name of the nutrient is shown under the heading Property, the amount of the nutrient present in the ingredient is shown under the heading Amount and the measurement value for the nutrient is shown under the heading Units. For example, if the ingredient orange juice has been selected, one of the nutrients displayed will be Vitamin C. Under the Units heading, mg/g will display, which means that there are the number of milligrams shown under the amount (in this case, 0.5) per gram of the nutrient.

   For those ingredients provided by default in the program, the USDA data has been loaded and this is what provides the nutrient values (or "Properties") for each ingredient. However, if you have added an ingredient to the list, in order to display the nutrient value, the USDA data must be loaded by clicking on the Load USDA data button that appears below the Ingredient Properties list.

   Again, a + button, for adding ingredient properties to the list, and a -, for removing properties, appears to the right of the section to allow addition and removal of nutrient values for an ingredient. See the section on Properties in Ingredients for more details.

Here's a screenshot of the &krecipes;Ingredients component. Screenshot

The Ingredients Component

##### Working with Ingredients

Ingredients may be added, removed or edited in the &krecipes; "Ingredients" Component.

###### Adding:

To add an ingredient to the list, click on the + button that appears beside the ingredient list. A window will be presented where `the name of the new ingredient` can be typed in the textbox beneath the heading New Ingredient. Once the name has been added, click the OK button to complete the addition and close the window. The ingredient will now appear in the ingredient list. If you do not wish to add the ingredient to the list, click the Cancel button to close the window and return to the previous screen.

###### Removing:

To remove an ingredient from the list, click on the - button that appears beside the ingredient list. The ingredient will be removed provided there are no recipes using that ingredient.

If recipes exist that use the ingredient, a window will display with the prompt The following elements will have to be removed also, since currently they use the element you have chosen to be removed. Below the prompt, under the heading Recipe, a list of recipes that use that ingredient will display, showing the recipe Id and Recipe Title under the appropriate headings. Click the OK button to proceed with the removal of the ingredient AND recipe, or the Cancel to close the window and return to the previous screen.

###### Editing:

An ingredient may be edited by selecting the ingredient in the list and double-clicking on it. The ingredient will remain highlighted, but if either the ← or → directional arrows is pressed, the cursor can be positioned to the point you wish to edit. If you wish to rename the entire ingredient, for example from "butter" to "BUTTER", simply begin typing with the ingredient highlighted.

If you choose to rename an ingredient and another ingredient exists with the name chosen, an alert box will appear with the prompt This ingredient already exists. Continuing will merge these two ingredients into one. Are you sure? Click the Continue button to proceed with renaming the ingredient, or the Cancel button to abort.

If you have two ingredients, one named "cinnamon" and the other named "Cinnamon" and you would like all recipes to show the ingredient as "Cinnamon", first check which of the ingredients lists the properties i.e. the nutrient values. If the nutrient values show for the ingredient "cinnamon", renaming "cinnamon" to "Cinnamon" will result in a loss of the properties for that ingredient and they will have to be reloaded.

However, if you rename "Cinnamon" to "cinnamon" and then after the two ingredients have been merged, the single ingredient "cinnamon" to "Cinnamon", your nutrient values will be retained.

###### Alternatively:

An alternative method to either add, remove, or edit an ingredient is to first, select the ingredient and then, right-click to display a menu from which you can select Create, Delete, or Rename. Each choice performs as explained in the previous sections.

For quick functionality, the &Ctrl;C key combination can be used to Create a new ingredient. To Delete an ingredient, press the Del key on the keyboard a prompt will be received if the ingredient is used by a recipe. The key combination &Ctrl;R can be used to Rename an ingredient.

##### Units in Ingredients

This section describes how to work with the units of measure, or Units, that apply to specific ingredients in the &krecipes; "Ingredients" component. For details on working with ingredients globally, see the section The Units Component.

Within the "Ingredients" component, select an ingredient. In the Unit list portion of the screen, the units of measure that are associated with that ingredient will display.

Units can be added by clicking on the + button that appears to the right of the Unit list.

For example, one of the preloaded ingredients in the ingredients list is "apple juice". By default, the units associated with this ingredient are "g", for grams, and "mg", for milligrams. If apple juice is a required ingredient in a recipe, it is more likely that it will be measured by cup, or portion thereof. Therefore, it may be desired that "cup" or "c." be added to the Unit list. To do this, click on the + button that is beside the Unit list. The Choose Unit window will appear, from which you can select cup, for example, from the list. Then, click the OK button to add the unit, or the Cancel button to close the window and return to the previous screen.

Units can be removed by clicking on the - button that appears to the right of the Unit list. In a manner similar to that described in the Working with Ingredients section under the heading Removing:, if an attempt is made to remove a unit that is associated with an ingredient used by a recipe in the database, a prompt will be displayed that permits confirmation of removal of the unit AND the recipe that is associated with the ingredient unit, or that will allow the cancellation of the action.

##### Properties in Ingredients

As previously stated, for those ingredients that are provided by default in the &krecipes; program, the Properties or nutrient values have been pre-loaded with the USDA values.

However, if a property has been added in the "Properties" component, a second step must be completed in the "Ingredients" component to add the Property and its associated value to the list.

###### Adding Ingredient Properties

The first step to adding a new property for an ingredient is to ensure that the appropriate unit is listed in the Unit list in the top right-hand corner of the "Ingredients" component. If the unit is not listed i.e. the unit specified when the property was added, for instance "g", it must be added in the manner described in the section Units in Ingredients.

Assuming that the appropriate unit is listed in the Unit list, to add the new property to the Ingredient Properties list, select an ingredient in the Ingredient list then, click the + button that appears to the right of the properties list.

The "Choose Property" box will appear, from which you can select the property to be added for the ingredient. A drop-down menu shows below the property list, from which the unit associated with the property must be selected. Click the OK button to proceed, or the Cancel button to cancel the addition of the property and close the window.

If you choose to proceed with the addition, the property will be added to the Ingredient Properties list. However, you will note that it has a "0" value. This value must by supplied by you. To add the value, double-click on the property and increment the value using the spin-box that appears, or manually type the value. Once the value is entered, click the OK button that appears beside the spin-box.

If the USDA data does not show for the ingredient for which the new property has been added, it can be loaded either before adding the new property or after. If the USDA data is added after adding the new property, the new property will still show in the list.

The new property must be added to EACH ingredient separately.

###### Removing Ingredient Properties

To remove a property from the Ingredient Properties list, simply select the property to be removed and click the - that appears to the right of the list. The property will be removed without a prompt. However, this will remove the property within the "Ingredients" component ONLY. The property will be retained in the list in the "Properties" component.

#### The Properties Component

The "Properties" component is where nutrients are globally added and removed. To access this component, first click on the Data button in the left pane of the &krecipes; window and then, click on the Properties button.

As with other &krecipes; components, the name of the component appears in the right pane of the window at the top. Below this, beneath the heading, Property the list of nutrients is displayed. Beneath the heading Units the units associated with the properties are shown.

Here's a screenshot of the &krecipes; Properties component. Screenshot

The Properties Component

For example, one of the nutrients under the Property heading is "iron". If a recipe ingredient contains this nutrient, the amount of iron contained in the ingredient will show as a number of milligrams or "mg".

##### Adding Properties

A number of nutrients have been provided by default in the &krecipes; program. Although this list is quite extensive, if there is a nutrient missing, it is possible to add it to the list.

To add a missing nutrient, click the Create... button that appears near the top in the right-hand side of the &krecipes; window. The New Property window will appear. In this window, the `name of the nutrient` can be entered in the textbox beside the Property name: label, and the associated `unit of measure` is entered in the textbox beside the Units: label. Click the OK button to proceed with the addition, or the Cancel button to close the window and return to the previous screen.

Adding a nutrient, or Property, is a two-step procedure. First, the nutrient and associated unit is added in the "Properties" component as described above. However, the actual nutrient value i.e. the number of mg of iron, for example, contained in a particular ingredient must be added within the "Ingredients" component. This must be done for EACH ingredient. Refer to the section Properties in Ingredients for more information.

##### Deleting Properties

To remove a nutrient from the list, click the Delete button that appears below the Create... that was used to create a new nutrient.

An "alert" box will appear asking Are you sure you want to delete this property? Click the Continue button to proceed with the removal of the nutrient, or the Cancel button to cancel the action and close the alert.

###### Another method:

An alternative method to either add, remove, or edit a nutrient is to first, select the nutrient and then, right-click to display a menu from which you can select Create, Delete, or Rename.

For quick functionality, the &Ctrl;C key combination can be used to Create a new nutrient. To Delete a nutrient, press the Del key on the keyboard a prompt will be received if the nutrient is used by a recipe. The key combination &Ctrl;R can be used to Rename an nutrient.

#### The Units Component

In the "Units" component, not only can units of measure that are to be used in the &krecipes; program be added and removed, but equivalencies between the various measures can be set up!

The "Units" component is accessed by first, clicking on the Data button to reveal the additional &krecipes; components, and then, clicking on the Units button.

Like other &krecipes; components, the "Units" component appears in the right-hand side of the &krecipes; window with the name of the component appearing at the top. Two tabs exist one for listing and maintaining the units of measure and one for setting up the equivalencies between the various units of measure.

In the Units tab, a list of all the units of measure will appear. This list includes the units of measure that have been provided by default and those that you have added, either by entering a new unit while entering a new recipe, or by adding the unit within the "Units" component.

Here's a screenshot of the Units tab in the &krecipes; Units component. Screenshot

Units Component The Units List

You will also note that each unit allows a singular and plural form of that unit, if one exists. For example, a recipe could require 1 teaspoon of an ingredient, which is the singular form, or it could contain 2 teaspoons, which is the plural. However, for the unit grams in its abbreviated form of "g", both the singular and the plural are the same, so "g" would also be listed under the plural column.

##### Adding Units of Measure

To add a unit of measure, click the Create... button that appears to the right of the Unit list. The New Unit dialog box will appear where the name of the new unit can be added. Beneath the heading New Unit, there is a textbox to `enter the singular form of the unit` and one to `enter the plural form of the unit`. Once the entries have been made for singular and plural of the new unit, click the OK button to complete the addition, or the Cancel button to cancel the addition and close the box.

##### Removing Units of Measure

To remove a unit of measure, in the Unit list, select the unit that you wish to remove. Click the Delete button that appears to the right of the list and below the Create... button that is used to add units of measure. A slight delay will occur while the database is searched to ensure that no recipes exist that use that unit of measure and then, the unit of measure will be removed.

If a recipe exists that uses the unit of measure selected to be removed, a window will appear with the "alert" The following elements will have to be removed also, since currently they use the element you have chosen to be removed. Beneath the heading Recipes, the list of recipes utilizing that unit will appear. Click the OK button to proceed with the removal of the unit of measure AND any or all recipes using that unit. Click the Cancel button to cancel the action and close the window.

##### Setting Equivalencies

Equivalencies are entered in the Unit Conversions tab in a "spreadsheet" style table. Down the side of the table, you will note that each "row" is labelled with a unit name. Similarly, along the top, each "column" is also labelled with a unit name. The"cells" in the body of the table are used to set the equivalencies. 1 to 1 equivalencies are provided by default.

Here's a screenshot of the Unit Conversions tab in the &krecipes; Units component. Screenshot

Units Component Unit Conversions

For instance, down the left side of the spreadsheet, suppose there is a unit of measure labelled pound. Using the "horizontal scroll bar" at the bottom of the window, scroll until the unit ounces is revealed along the top. Double-click the cell that is beside pound and below ounces. This will cause a "spinbox" to appear with a value set to "0.00000" that can be utilized to set the equivalency to 16 i.e. there are 16 ounces in a pound. Once the value of 16 has been set, click the OK button.

In a similar manner, the equivalency between pound and grams could be set by double-clicking on the appropriate cell. However, in this instance, it is unlikely that you would want to use the spinbox to increment the value to 454. To allow the manual typing of the value, simply position the cursor by clicking at the beginning of the "0.00000" value and type `454`. Click the OK button, or simply hit the Enter key to complete.

Once the &krecipes; program knows the equivalency, it can automatically calculate other equivaliencies. For example, if the program has been informed that there are 16 ounces in a pound, &krecipes; will automatically calculate that 1 ounce is equal to 0.0625 pounds.

#### The Preparation Methods Component

To access the "Preparation Methods" component, first click on the Data button to reveal additional components and then, click the Preparation Methods button. In the right-hand pane of the &krecipes; window, a list of preparation methods will be displayed under the heading "Preparation Method". Note that the name of the component also appears at the top of the pane.

Here's a screenshot of the &krecipes; Preparation Methods component. Screenshot

The Preparation Methods Component

The preparation methods listed include those installed by default with the program and those that are automatically added when a method is typed into the "Preparation Method" field while entering a new recipe. See the section Adding a New Recipe.

##### Adding a New Preparation Method

To add a new preparation method, click the Create... button that is seen in the upper right-hand portion of the screen. A dialog box will appear containing a textbox that allows entry of the new preparation method under the heading "New Preparation Method".

`Enter the name of the new preparation method`, for example, Slightly beaten in the textbox provided. Click the OK button to complete the addition, or the Cancel button to cancel the addition and return to the "Preparation Method" list.

##### Deleting a Preparation Method

To remove a preparation method, first select the method to be removed from the list of preparation methods displayed. Then, click on the Delete button that is displayed in the upper, right-hand portion of the screen beneath the Create... button.

Should the preparation method selected for deletion be used by a recipe, a dialog box will appear stating The following elements will have to be removed also, since currently they use the element you have chosen to be removed. Below this, the list of recipes utilizing the preparation method will show. Click the OK button to proceed REMINDER: This will delete not only the preparation method, but the recipes utilizing that method as well! To cancel removal of the preparation method, click the Cancel button.

Should no recipe utilize the preparation method selected for deletion, no prompt will be given.

##### Editing Preparation Methods

Preparation methods can also be edited simply by double-clicking on the desired method.

For example, to change the method Slightly beaten to Slightly Beaten, double-click on the method in the list. A box will appear around the method, the method will be highlighted and an insertion point will appear. Use the ← or the → directional arrow keys as required to position the cursor in the appropriate position to change the lowercase b in "beaten" to uppercase. Press the Enter key to complete the change.

#### The Categories Component

When the "Categories" component is selected, the list of all created categories will appear under the heading Category.

Here's a screenshot of the &krecipes; Categories component. Screenshot

The Categories Component

##### Adding a New Category

To add a new category, click on the Create... button.

A window will pop up where the name of the new category can be entered in a textbox under the label New Category. A subcategory can be selected using the Subcategory of drop-down menu, which lists existing categories. The default for the subcategory is **NONE**.

Once the name of the new category has been entered in the textbox, click the OK button to create the category and return to the category list. The list will now show the new category.

To cancel the addition of a new category and clear the window, click on the Cancel button.

##### Removing a Category

To remove a category, select it from the list of categories and click the Delete button.

An prompt will appear asking, Are you sure you want to remove this category and all its subcategories?. Click the Continue button to remove the category, or the Cancel button to cancel the removal.

Before deleting a category, ensure that it contains NO recipes! Despite the warning Are you sure you want to remove this category and all its subcategories?, clicking the Continue button will result in the deletion of the category whether or not it contains recipes!

#### The Authors Component

The "Authors" component is where the author or contributor of the recipe is maintained.

Within this component, the component title appears at the top and the list of authors appears in the main portion of the window.

##### Adding an Author or Contributor

To add an author/contributor, click on the Create... button on the right-hand side of the screen.

A window will appear that allows entry of the author's name in the textbox labelled New Author

Here's a screenshot of the &krecipes; Authors Component showing the addition of a new author. Screenshot

Authors Component Adding an Author

Once a name has been entered, click the OK button to create the entry, or the Cancel button to cancel entry of a new author's name and close the window.

##### Removing an Author/Contributor

To remove an author/contributor from the list, select the author from the list and click the Delete button on the right-hand side of the screen.

When this button has been clicked, an alert will appear with the prompt Are your sure you want to remove this author? Click the Continue button to delete the author, or the Cancel button to cancel the deletion.

## Setting Preferences in &krecipes;

&krecipes; is extremely configurable and allows the setting of many preferences besides those defined in the Page Setup section.

### Creating Shortcuts

To access the Shortcut configuration interface, select Settings and Configure Shortcuts... from the &krecipes; menu. The Configure Shortcuts &krecipes; screen will appear.

In the Search: textbox, type the name of the Action for which you want to create the shortcut. Under the heading Action, the cursor will position itself on an item in the list that matches the characters typed. As more characters are typed, the cursor will reposition itself on another item in the list. If an exact match is typed, the cursor will be positioned on this item. However, if multiple matches exist for the characters typed, the cursor will be positioned on the first match.

For example, in the screenshot below, two Actions exist for the expression "Import" Therefore, if you type "Import", the cursor will be positioned on "Import from Database...", although it may not be this Action that you want to create the shortcut for. However, if you type "Import from File", the cursor will be positioned on the "Import from File..." Action.

Clicking the icon located beside the Search: textbox clears the contents of the textbox.

Alternatively, you can use the scroll bars to scroll through the Actions until the one for which you want to change the shortcut is found.

Here's a screenshot of the Configure Shortcuts &krecipes; starting screen. Screenshot

Configure Shortcuts &krecipes; Starting Point

To begin creating your shortcut, ensure that the Action for which you want to create the shortcut is selected.

If the Action has no attached shortcut, the radio button beside None will be selected by default. If there is a shortcut attached, the Default radio button will be selected as shown in the example in the screenshot.

To create a shortcut for an Action that does not have one attached, or to change an existing shortcut, click the radio button beside the Custom label.

When you click the Custom radio button, the window for doing the actual defining of your shortcut will appear.

Here's a screenshot of the &krecipes; Basic Shortcut configuration screen. Screenshot

Configure Shortcuts Basic Configuration

If a shortcut already exists, the textbox will contain an entry, as seen in the screenshot above. To clear this entry in order to enter a new one, click on the icon on the left of the textbox.

If no shortcut exists, position the cursor in the textbox and enter your key combination. For example, to enter the key combination &Ctrl;I, hold the Ctrl and simultaneously, press the I key. Entering the key combination in the text box will close the entry window and return you to the main Configure Shortcuts &krecipes; screen. The shortcut will show on the Shortcut button that appears to the left of the Custom label.

Clicking the OK button, will set a change made, for instance if you cleared a shortcut and didn't want to set another, and return you to the main Configure Shortcuts &krecipes; screen. The Cancel button on the shortcut entry screen will cancel setting of the shortcut and return you to the main interface.

Clicking the Advanced>> button will expand the shortcut entry screen as shown in the screenshot below.

Here's a screenshot of the &krecipes; Advanced Shortcut configuration screen. Screenshot

Configure Shortcuts Advanced Configuration

On the Advanced shortcut entry screen, shortcuts are defined in the same manner as previously described. However, you will note that the definition of an Alternate shortcut: is possible.

The OK and Cancel buttons also operate in the same manner as previously described. The Advanced<< button collapses the window to the single shortcut entry interface.

You will also notice beneath the Alternate shortcut: textbox, that there is a tickbox labeled Multi-key mode. Selecting this provides very cool functionality! Follow these steps to see how it works −

1. From the main Configure Shortcuts &krecipes; screen, choose an Action for which you would like to configure a shortcut. As an example, let's choose "About KDE".

2. Select the Custom radio button.

3. In the shortcut input screen, click the Advanced>> button, if the window is not already expanded.

4. Click the Multi-key mode tickbox to select.

5. Type A,A by pressing the A key twice this will cause A,A to appear in the shortcut entry textbox.

6. Click the OK button. You will be returned to the main Configure Shortcuts &krecipes; screen.

7. Select another Action, for example, "About Krecipes".

8. Again, make sure that you have selected the Multi-key mode tickbox.

9. For your shortcut combination, type A,B by pressing the A key and then, the B key A,B will show in the shortcut textbox.

10. Click the OK button.

11. Back on the main Configure Shortcuts &krecipes; screen, click the OK button to close the window.

Now the fun begins! Anywhere in the program, as long as your cursor is not focused on text, for example, in a textbox or in a recipe edit input area, press the A key on your keyboard. In the top, left-hand corner of your screen, using the example outlined, a small menu will appear, as follows −

You can press the A or B key on the keyboard to select your choice, or you can use the directional arrows on the keyboard to highlight your selection and then, press the Enter key.

Although we have used "About KDE" and "About Krecipes" in our example, this functionality could be applied to other choices. For example, you could choose to use the Multi-key mode for your import shortcuts, defining "Import from Database" as I,D and "Import from File" as I,F. Then, pressing the I key on your keyboard will bring up the import choices menu. Note here that for the "Import from File" choice, there is already a shortcut attached by default. However, &krecipes; is so configurable that you will be able to change this.

Back on the main Configure Shortcuts &krecipes; screen, below the radio buttons, the default shortcut appears beside the Default key: label.

Below the Default key: label, functions of the buttons are as follows −

- Defaults returns all shortcut settings to their defaults

- OK sets any changes made and closes the Configure Shortcuts &krecipes; window

- Cancel cancels any changes made and closes the Configure Shortcuts &krecipes; window

### Customizing the Toolbar

To access the Toolbar configuration interface, select Settings and Configure Toolbars... from the &krecipes; menu. The Configure Toolbars &krecipes; screen will appear.

Here's a screenshot of the &krecipes; Toolbar configuration screen. Screenshot

Configure &krecipes; Configure Toolbars interface

From the screenshot, you will notice that choices available for addition to the toolbar are on the left under the heading Available actions:. On the right, under the heading Current actions: are the icons that presently appear on the toolbar note that your toolbar, by default, may appear differently from that displayed in the screenshot.

Between the two lists are four arrows, which allow for directional movement between the lists, or up and down in the list. When an item is selected from either list, the directional arrow(s) that are functional are colored, while the non-functional arrow(s) are grayed. Movement is accomplished by clicking on the appropriate directional arrow, as necessary, to move the selection into the desired position.

The icon for your selection can be changed by clicking the Change Icon... button. This will bring up a window from which you can select the icon that you want to use. Once selected, click the OK button that appears on the icon selection screen to close the window and attach the icon to the toolbar selection.

In order to apply your changes, you must click the Apply button that appears at the bottom of the Configure Toolbars &krecipes; screen. This will apply your changes, but leave the window open in order to make other changes, if desired. To apply your changes and exit the interface, click the OK button. Clicking the Cancel will cancel any changes made since the last time the Apply button was clicked.

### Configuring &krecipes;

When you choose Settings and Configure Krecipes from the &krecipes; menu, the Krecipes Preferences - Krecipes window appears. From this window, you can choose one of three buttons to configure various aspects of &krecipes;.

#### Server Settings

The first preference that you can configure is the Database Server Options. You will notice from the following screenshot that this label shows that an SQLite database has been selected. However, if the database selected is either MySQL or PostgreSQL the label would show the name of the appropriate database format. The Database file: label shows the complete path to the database file.

Here's a screenshot of the &krecipes; Server Settings configuration window. Screenshot

Configure &krecipes; Server Settings interface

If you wanted to choose another database file, you would click on the File icon and in the window that appears, navigate to the location of the database file that you want to use. This change would be reflected in the Database file: textbox.

Also exclusive to the Server Settings screen, is the Re-run wizard on next startup tickbox that can be selected to reload the database with the recipes and USDA data that come as defaults with the &krecipes; program.

Buttons that appear at the bottom of the Server Settings screen are common to each of the preference screens and function as follows −

- OK sets any changes made and closes the Krecipes Preferences - Krecipes window

- Cancel cancels changes, if any have been made, and closes the Krecipes Preferences - Krecipes window

- Help opens the &krecipes; documentation

#### Customizing Formatting

Like accessing the Krecipes Preferences - Krecipes Server Settings preferences, you access the Formatting preferences, by first choosing Settings and Configure &krecipes;... from the &krecipes; menu and then, choosing the Formatting option that appears on the left of the window.

Here's a screenshot of the &krecipes; Formatting configuration window. Screenshot

Configure &krecipes; Formatting interface

From this window, there are two formatting preferences that can be customized −

1. Number Format either Fraction or Decimal can be selected by clicking on the appropriate radio button and this choice controls how the units of measure will display in your recipes

2. Ingredient format this controls how the ingredients are listed in your recipes

   You will notice from the screenshot that each portion of the ingredient has a variable associated with it, %n for "Name", %p for "Preparation method", %a for "Amount", %u for "Unit". The chosen order for display of these items appears in the Ingredient format: textbox and can be changed at will. For example, as shown in the screenshot, the %a %u %n%p ingredient format will result in an ingredient being displayed as follows −

   2½ lbs. cream cheese; softened

#### Choosing Import Preferences

Here's a screenshot of the &krecipes; Import configuration window. Screenshot

Configure &krecipes; Import interface

Accessing the Krecipes Preferences - Krecipes Import preferences, is accomplished by first, choosing Settings and Configure &krecipes;... from the &krecipes; menu and then, choosing the Import option that appears on the left of the window.

From this screen, only one option exists. The Overwrite recipes with same title tickbox can be selected to turn this feature on. This might be a good idea if you are re-importing a currently loaded database.

Should you choose NOT to overwrite existing recipes and you have a recipe titled Chocolate Cheesecake, for example, in your recipe list, if you import another Chocolate Cheesecake recipe, the listing will appear as −

Chocolate Cheesecake

Chocolate Cheesecake (2)

## Command Reference

### The main &krecipes; window

#### The File Menu

&Ctrl;N File New Recipe

  Creates a new recipe

&Ctrl;S File Save

  Saves the recipe

&Ctrl;P File Print

  Prints the currently loaded recipe

F5 File Reload

  Reloads the currently active recipe

&Ctrl;I File Import from File...

  Imports recipes from a file See the section Importing from a File for instructions

File Import from Database...

  Imports recipes from one of 3 database choices

  See the corresponding sections on importing from a Database SQLite, MySQL, or PostgreSQL

File Export...

  Exports either a single recipe or all recipes to a file Exporting Recipes to Other Formats

&Ctrl;Q File Quit

  Quits &krecipes;

#### The Edit Menu

Edit Page Setup...

  Accesses the &krecipes; Page Setup interface for defining the page layout see the section on Page Setup for further details

#### The Tools Menu

&Ctrl;E Tools Edit

  Accesses the &krecipes; Edit mode

#### The Settings Menu

Settings Show Toolbar

  Turns display of Toolbar on and off

Settings Hide Statusbar

  Hides the Statusbar

  If this menu item is selected, the choice changes to Show Statusbar which Shows the Statusbar

Settings Configure Shortcuts...

  Opens the Configure Shortcuts - &krecipes; window from which Shortcuts can be defined

  For complete instructions on configuring shortcuts, see the section Creating Shortcuts

Settings Configure Toolbars...

  Opens the Configure Toolbars - &krecipes; window from which Toolbars can be configured

  See the section Customizing the Toolbar for details.

Settings Configure &krecipes;...

  Opens the &krecipes; Preferences - &krecipes; window from which a number of preferences can be defined

  See the sections, Server Settings, Customizing Formatting, or Choosing Import Preferences for specific configuration instructions.

#### The Help Menu

&help.menu.documentation;

## Questions and Answers

&reporting.bugs; &updating.documentation;

Where are all the questions?

There aren't any... yet.

E-mail us at mizunoami44 users.sourceforge.net if you have any questions or comments.

## Credits and License

&krecipes;. Program copyright 2003, 2004, 2005 by the &krecipes; developer team.

### The &krecipes; team:

Unai Garro ugarro users.sourceforge.net

  Creator & Core Developer

Jason Kivlighn mizunoami44 users.sourceforge.net

  Project Maintainer & Core Developer

Cyril Bosselut bosselut b1project.com

  Core Developer

Documentation copyright 2004-2005 Colleen Beamer cbeamer interlynx.net and Jason Kivlighn mizunoami44 users.sourceforge.net

&underFDL;

&underGPL;

## Installation

### How to obtain &krecipes;

The latest version of &krecipes; is available from its home page at http://krecipes.sourceforge.net

&krecipes; can also be found in KDE CVS in the kdeextragear-3 module. Instructions for downloading and installing through CVS are available at http://krecipes.sourceforge.net/downloading.html

### Requirements

In order to successfully use &krecipes;, make sure you have at least one of the two necessary databases installed: SQLite or MySQL. In case you decide to use MySQL, make sure also that you have &Qt;'s MySQL plugin properly installed. The program won't work without database support.

&krecipes; also requires &kde; >= 3.1 and &Qt; >= 3.1

If you are compiling &krecipes; from source, you may need the following packages (package names may vary depending upon your distribution):

If you have compiled any &kde; application before, then these packages will already be installed.

- libjpeg-devel

- libpng-devel

- libart_lgpl-devel

- arts-devel

- zlib-devel

- XFree86-devel or xorg-x11-devel or libxorg-x11-devel

- kdelibs-devel

- qt-devel or libqt3-devel

&krecipes; currently has support for storing recipes in a PostgreSQL database, although it is currently considered beta. No problems have been found with it, but until there has been more testing, it will be marked as unsupported.

### Compilation and Installation

&install.compile.documentation;

Krecipes can also be compiled without support for certain databases. See `./configure --help`.

&documentation.index;