# The &krecipes; Handbook

Colleen
Beamer

    colleen.beamer@gmail.com

Jason
Kivlighn

    jkivlighn@gmail.com

2004-2005
Colleen Beamer and Jason Kivlighn
&FDLNotice;
2005-11-29
0.9

&krecipes; is an application to manage recipes.

KDE
kdeextragear
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, when a category is selected, it will automatically expand to show your recipes and/or subcategories if there are any. From this list, you may select a recipe to open, edit or delete (see the section Editing Saved Recipes for more information). Additionally, if you hover the mouse pointer over any recipe title, a dialog box will appear showing the recipe title and the date that it was created, modified and last accessed.

#### The "Right-Click" Menu

&krecipes; allows a multitude of ways to perform various actions on your recipes. These actions are described in their corresponding sections in this Handbook. However, in addition to the various key combinations and/or menu selections, right-clicking on a recipe in the Basic search pane will bring up a menu from which the following actions can be selected —

- Open – Opens the selected recipe.

- Edit – Open the selected recipe for editing.

- Export – Exports the selected recipe. See the section Exporting Recipes to Other Formats for a complete description of this function.

- Remove From Category – Removes the recipe from its current category and places it in the Uncategorized group. From the Uncategorized group, the recipe can be selected for editing to re-categorize it. See the section Editing Saved Recipes for more information.

- Delete – Deletes the recipe from the database.

- Add to Shopping List – Adds the selected recipe to your shopping list. See the section The Shopping List for information regarding the use of the Shopping List.

- Copy to Clipboard – Makes a copy of the recipe and places in on the clipboard so that it can be pasted into another application for example, an e-mail. The format of the copy is dependent on what is selected as a preference. For a complete description of the Copy to Clipboard functionality, see the section Copying to the Clipboard.

#### The Advanced Tab

The purpose of the Advanced tab is to provide advanced search capability. Queries for recipes can be made based on nine search criteria, alone or in combination —

- Title

- Ingredients

- Categories

- Authors

- Yield

- Preparation Time

- Instructions

- Meta Data

- Ratings

Here's a screenshot of the available components in the &krecipes; Advanced Search tab. Screenshot

The &krecipes; Advanced Search Components

When the Advanced tab is selected, the components will be collapsed and show >> beside the label of the component. To expand a section, simply click on the label of the component. Conversely, with the component expanded, << will show beside the label and clicking on the label will collapse the section.

A section can be collaped simply to get it out of the way when it is not needed for a search. However, if you enter search criteria in any one of the search components, you can close the component and the search criteria will still be considered in the search.

For all search components in the Advanced tab, click the Search button to initiate the search once all desired search criteria have been selected. Clicking the Clear button will clear the search selections and the search results.

Only recipes meeting ALL criteria will display! No matter which parameters are used for the recipe search, should no recipes meeting the specified criteria be found, the message — No matching recipes found — will display in the recipe list area.

The various components are used as follows —

##### The Title Search

Enter words that appear as part of the recipe title, for example, Chicken Rice. Using these words, recipes that contain the words Chicken, or Rice, or both in the title will appear in your results. However, if you click the tickbox beside the Require All Words label, only those recipes that have both Chicken AND Rice in the title will be found.

##### The Ingredients Search

In the Ingredients component of the Advanced tab, single or multi-word ingredients can be searched for. Single word ingredients are entered in the text box with a space between each ingredient. Multi-word ingredients are enclosed in quotes, for example, "ice cream".

Searches may also be done using wild cards – * to replace any number of characters, or ? to replace a single character. For an explanation on the use of wildcards, see the section Using Wildcards in Searches.

Although the ingredient that you are searching for might appear in the title of the recipe listed in the search results, it is the ingredient that has caused a particular recipe to show in the list, NOT the fact that the ingredient name might appear in the title.

Recipes can be searched for based on various criteria —

- Uses all: – If the search terms are entered in this text box, it is being stated that the recipe(s) MUST contain all ingredients listed and therefore, only those recipes that contain ALL ingredients will be returned as results of the search.

- Uses any of: – If the search terms are entered in this text box, it is being stated that the recipe(s) MAY contain any of the ingredients specified. The search results will return recipes that contain ANY OR ALL of the ingredients.

- Without: – If the search terms are entered in this text box, it is being specified that the recipes returned as results of the search MUST NOT contain ANY of the listed ingredients.

##### The Categories Search

As in the Ingredients component of the Advanced tab, search parameters in the Categories component are entered with a space between each parameter, or enclosed in quotes for multi-word parameters. You can also use wildcards for searching categories. See the section, Using Wildcards in Searches for an explanation on the use of wildcards.

Searching for recipes in Categories is done by specifying the criteria on which you wish to base the search as follows —

- In all: – indicates that the recipes returned in the search should be in all the categories listed. This search might be used if you are looking for a recipe that appears in the Dessert category and also, in the Cakes category.

- In any of: – is specifying that recipes returned in the search may be from ANY of the categories, but a recipe may not necessarily be found in all categories listed.

- Not in: – is indicating that the recipes returned in the search MUST NOT be from the categories listed.

The use of the Categories search is most useful when combined with other search parameters.

In the following screenshot, it is being specified that recipes should be searched for in the Chicken and Main Dishes categories.

Here's a screenshot of a completed search in &krecipes; specifying a category only. Screenshot

Advanced Search – Category Only Specified

In this screenshot, recipes are still being searched for in the Chicken and Main Dishes categories. However, recipes that contain some form of the word tomato (note the use of the wildcard) are being excluded.

Here's a screenshot of a completed search in &krecipes; specifying a category and and additional criteria. Screenshot

Advanced Search - Ingredient and Category Specified

##### The Authors Search

Are you looking for a recipe given to you by a certain person or input into &krecipes; from a specific magazine? The Authors component of the Advanced tab allows you to find that recipe!

As with the searches previously described, you can search using wildcards. For a description of using wildcards, see the section Using Wildcards in Searches. Names are entered with a space between if, for instance, you are searching for a recipe by only a first name. Whole names, or for situations where you have entered a magazine name as the recipe source (Author), the name is entered enclosed in quotes, for example, Jason Kivlighn, or Vegetarian Times.

Searches can be performed in the following ways —

- By any of: – This search would be used if the recipes desired are by ANY of the authors listed in the text box.

- By all: – This search would be used in situations where recipes have co-authors. An example of this would be: Canadian Living Cooks Elizabeth Baird. This would return only recipes where Canadian Living Cooks and Elizabeth Baird are both listed as the recipe source/author.

- Not by: – This search would be used when you want to exclude certain authors from your search.

##### The Yield Search

The Yield component in the Advanced tab is slightly different from the searches described thus far in that it must be Enabled in order to have it utilized in the search criteria.

To enable Yield as a criteria for your search, click the tick box beside the Enabled label. Once you have designated this to be part of your search, you can define the yield by selecting from the drop-down menu as follows —

- Yields at least: – This would be specified if you want the recipe(s) to be able to provide a minimum number of portions. The recipe(s) returned COULD yield MORE than this number, but it cannot yield less.

- Yields at most: – This would be specified if you want recipe(s) that are returned in the search to yield NO MORE THAN a specified number of portions.

- Yields about: – This would be used to approximate the number of portions you want in the recipe(s). The recipes(s) returned could yield SLIGHTLY MORE or SLIGHTLY LESS than a specified number of portions.

After defining the type of search that is desired, the spinbox next to the drop-down menu is used to increment (or decrement) the actual yield amount that goes along with the defined parameters.

When inputting recipes, a yield type, for example, servings or dozen is allowed. Keep in mind that when including Yield as a search parameter, using a yield of 2 in a search will return results for 2 dozen, 2 servings, 2 loaves, but will NOT return results for 24 cookies, 24 squares, etc., even though these are technically 2 dozen.

##### The Preparation Time Search

The Preparation Time component in the Advanced tab is used in the same manner as the Yield component. It must be Enabled in order to have it utilized in the search criteria.

To enable Preparation Time as a criteria for your search, click the tick box beside the Enabled label. Once you have designated this to be part of your search, you can define the time criteria by selecting from the drop-down menu as follows —

- Ready in at most: – This would be utilized if you want the recipe(s) to be ready within a specified time frame. The recipe(s) returned COULD be ready in LESS THAN or EXACTLY the time specified, but cannot be ready in greater than the time chosen for preparation.

- Ready in about: – This choice allows some flexibility and would be used to approximate the time needed to prepare the recipe. The recipe(s) that are returned in the search can be ready in SLIGHTLY MORE, EXACTLY, or SLIGHTLY LESS than the time specified for preparation.

After defining the type of search that is desired, the spinbox next to the drop-down menu is used to increment (or decrement) the actual time parameter. Select the digits before the : symbol to increment the hour portion of the time and then select the digits after the : symbol to increment the minute portion of the time. The hour and minute parameters can be used alone or in combination.

##### The Instructions Search

Are you interested in finding a recipe that contains certain instructions or is prepared a certain way? The Instructions component in the Advanced tab allows you to search the recipe instructions for specific terms that might include a preparation method, such as Bake at 350, or a suggested garnish. However, these are just examples of how this component might be used. Any term(s) that might appear in the Instructions of a recipe can be used.

To utilize the Instructions search, simply type the keyword or keywords in the text box beside the Keywords: label. Enter keywords separated by spaces, or multi-word instructions enclosed in quotes. Wild cards can also be used. For instructions on the use of wildcards, see the section Using Wildcards in Searches.

Should you require that the search contain all the keywords listed, click the tick box beside the Require All Words label.

##### The Meta Data Search

By definition, Meta Data is data about data, or expressed another way, is information that describes another set of data. The Meta Data component in the Advanced tab allows you to search your recipes based on information about them, as follows —

- Created: – This is the date that the recipe was created on.

- Modified: – This is the date that the last revision was made to the recipe.

- Last accessed: – This is the date that the recipe was last opened or used.

For each of the Meta Data descriptions, the date may be entered as an exact date if this is known or desired, or as a date range. Dates are interpreted in the format that has been set within the &kde; environment. For example, if the date format has been set to display as DD-MM-YYYY, you may enter the date directly into the text box in the format of "DD-MM-YY". When entering the date, the two initial digits of the year may be entered, but are not absolutely necessary. However, it is imperative that you use the exact separator i.e. the dash (–), in the example, as set in the date format in &kde;. You may also use the drop-down arrow beside the box in which you want to enter the date to reveal a calendar.

If you choose to enter the date directly into the text box and are using a date range as opposed to an exact date, ensure that the dates for the start and end of the range are entered in the same format. For example, if you enter the starting date for the range in the format of "DD-MM-YY" and the ending date for the range in the format of "DD/MM/YY", either no recipes will be found or the results returned will include only those recipes that fit the criteria for the starting date, if this date agrees with the format as set in &kde;.

###### Using the Calendar Interface

The calendar allows you to easily navigate though months and years to select any date.

When the calendar is revealed, the current month is shown and the current day is highlighted. Below the calendar is a text box, which shows the date and beside this a drop-down menu that displays the specific week of the year.

One way to select a date would be to use the drop-down menu to select a particular week in the year, for example Week 26. Doing this will change the date in the text box and will also position the highlighted date in the calendar to the beginning of Week 26. Note that Monday is used as the starting day for the week. To use a date from this week either, click the highlighted date in the calendar, or select another date from the week and the date will be transferred to the Meta Data text box where the calendar was utilized.

Below the text box that is displaying the date at the beginning of the chosen week of the year (or the current week if no choice has been made), there is a list of additional choices for date selection. Specifically, these are: – Today, Yesterday, Last Week, and Last Month. Clicking on one of these selections, will result in this date being shown in the Meta Data text box being used. It should be noted here that each of the choices is relevant to today's date. For instance, if today's date is the 15th, clicking the Today would place today's date in the Meta Data text box being used. Clicking Yesterday would, of course, place yesterday's date in the box. Last Week would place the date that is one week ago today in the box. Last Month would place last month's date that corresponds to today's date in the box, in the example from above, the 15th of the previous month.

Additionally, the calendar itself can be utilized to navigate to a specific date. When the arrow beside the text box in which you want to display the date is clicked, thus revealing the calendar, there are a number of ways to select a date —

- Click on the month displayed – This will reveal a list from which you can select a desired month.

- Click on the year displayed – This is reveal a text box that displays the current year, but in which another year can be entered.

To the left and right of the month and year heading on the calendar, there are arrows that can be used to navigate through various months and years. Clicking on the icon will reveal the previous month's calendar. Conversely, clicking the icon will advance the calendar to the next month.

Navigating between years is done in the same manner, but the is used to navigate to previous years and the is used to navigate to following years. In each case, once a date is selected, it will be transferred to the text box at the point where the calendar was selected.

##### The Ratings Search

When a Rating search is selected, it can be done in two ways —

1. By average:

2. By criteria:

###### Searching by Average Rating

If you choose to search by average rating, select the Radio Button beside the By average: label. Then, enter a numerical value in the text box that precedes the label stars. This value is the average of the number of stars assigned to each parameter under which the recipe was rated and can be a fixed value or a range, for example 3-4 stars. Fractional amounts are also permitted, for example, 3.5.

Once you have entered your search parameters, click the Search button and the recipes that meet the search criteria will display under the Title label on the right. Should no recipes meet the criteria, --- No matching recipes found --- will display.

###### Searching by Rating Criteria

To search by rating criteria, select the Radio Button beside the By criteria: label. First, select the criteria that you want to use for your rating from the drop down menu. In the text box next to this, enter the value of the number of stars for which you want recipes displayed, for example, 4. Entry is permitted in the following formats —

- whole numbers, e.g. 3

- numbers that include fractional amounts, e.g. 3.5

- whole number ranges, e.g. 3-4

- ranges that include fractional amounts, e.g. 3.5-4

Note that, if you enter a fractional amount, for instance, 3.5, it will display in the format that you have chosen for your preferences when transferred to the listbox – i.e.3.5 will display as 3.5 if you have chosen numbers to display in decimal format, or 3½ if you have chosen numbers to display as fractions. See the section Customizing Formatting for an explanation of setting formatting preferences.

Additionally, if no range is specified, the search will find recipes that have an assigned star rating in a range of ±½ of the value entered, 3½ to 4½ stars in the example.

Once you have chosen the parameters by which you want to search, click the + beside the text box in which you entered the number of stars to have the criteria added to the list. More than one criteria may be utilized in the search. Once you have entered your search parameters, click the Search button and the recipes that meet the search criteria will display under the Title label on the right. Should no recipes meet the criteria, --- No matching recipes found --- will display.

#### Using Wildcards in Searches

Wildcards are a single character used to replace either multiple or single characters in a text string. Wildcards supported in &krecipes; are the * and ? characters. The * character is used to replace any number of characters in a string, while the ? is used to replace a single character. Both can be used to replace any alpha-numeric character, including a space.

Examples of Wildcard Searches

Wildcard Search | Possible Results Returned
--- | ---

chick*

- chicken broth

- chicken breast

- chicken

can*cherries

- canned cherries

- candied red cherries

- candied green cherries

egg?

- egg

- eggs

### 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 four tabs. Each permits entry of a different aspect of the recipe. These tabs are —

- Recipe

- Ingredients

- Instructions

- Ratings

Here's a screenshot of the recipe entry screen showing the 4 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 drop-down menu.

- An author's name can be typed directly into the textbox and transferred to the list box as described above. As you start entering characters, if there are authors that match the text string typed, the menu will display a list of existing choices from which you can choose to transfer the author's name to the list box, as described above.

  However, in the situation where the author does not exist in your list, no choices will be listed and when you click the button to transfer the author to the listbox, 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 The Yield Amount and Type

Setting the the amount that the recipe will yield is performed by entering a value in the textbox beneath the Amount label. It is possible to enter a numerical range for this number, for example, 3-4. When entering a range, if an incorrect value or format is entered, the entry will turn red indicating that a correction is necessary.

The second part of entering a yield is to enter the type. This is done by entering text in the text box beneath the Type label. The text entered can be anything you choose that is appropriate for the recipe yield type, for example, servings, dozen, or squares.

##### Specifying Preparation Time

The time it takes to prepare a recipe is 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, ½ or 1-2 --> note that &krecipes; will allow the entry of ranges for ingredients

- 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 double-clicking 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

Entering Ingredients – Ranges for the Amount are permitted

##### Adding Recipe Ratings

&krecipes; allows you to rate your recipes! Ratings by multiple people are allowed, so each of your recipe tasters can provide their own input. Additionally, each rating can include multiple rating parameters. The default parameters against which you can rate your recipe are —

- Taste

- Appearance

- Ease of Preparation

- Originality

- Overall

Initially, in the Ratings tab, there is only a blank screen with the Add Rating... button at the bottom. Clicking this button will start the interface for entering ratings.

The Ratings interface is comprised of the following elements —

- Rater: – this is the name of the person providing their opinion of the recipe

  To complete this element `enter the rater's name` in the text box that appears beside the label Rater:.

- Criteria: – this is the criteria on which the recipe is rated

  Select the criteria against which you want to rate the recipe from the drop-down menu that appears beside the Criteria: label. Five default choices exist for rating criteria, as listed above, but if you have another against which you want to rate your recipe, it can be typed directly into the text box and will automatically be added to your rating criteria list.

- Stars: – this is the number of stars that you wish to assign to the particular criteria that you are rating on

  Star ratings are completed by clicking on a star. Clicking on the left-hand side of any star will provide a ½ star rating. Clicking on the right-hand side of the star will provide a full star rating.

  It is unnecessary to click on each star individually. For instance, if you are rating the recipe on the Taste criteria and you want to assign this a 4½ star rating, click on the left hand side of the 5th star.

  Once you have completed the star rating for the recipe, click the Add button to add the rating to the rating list. At this point, you can continue to rate the recipe against other criteria in the same manner.

  From within the rating list, both the rating criteria and the star rating can be edited by double clicking on either item. The rating criteria is edited the same way any text edit is done. To edit the star rating, double click the stars and then type the numerical value for the number of stars that you wish to assign to the rating. Once you press the Enter key, the rating will show the graphical stars.

  Should you change your mind and wish to remove any of the rating criteria, select it in your rating list and click the Delete key.

- Comments: – this is any added information that you wish to note for the recipe, for example, an enhancement to improve the recipe, or a serving suggestion such as Great served with ice cream

  To enter a comment, simply position your cursor in the white space beneath the Comments: label and begin typing.

Once you are satisfied with your ratings, click the OK button to complete the addition. The smiley graphic that appears to the left of the rating list is indicative of the overall rating of the recipe, from poor to excellent. This graphic will not appear in your recipe when it is viewed.

Any rating can be removed from the screen by clicking the Remove button beneath the rating that you wish to remove. Additionally, you can use the &Alt;M key combination. A rating can be edited by clicking on the Edit... button. When you choose to edit a rating, the same interface that was used to originally enter the rating is opened. Each rating has its own Delete and Edit... buttons.

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

New Recipe Entry – The Completed Ratings Tab

##### Copying Recipes from Other Sources

Do you need an easy method of getting recipe ingredients into &krecipes;? You can do that with the Copy/Paste functionality!

Find the recipe that you wish to enter into &krecipes;. Start the interface for entering a new recipe and enter the appropriate parameters in the Recipe tab. Move to the Ingredients tab. Copy the recipe ingredients from your chosen source and initiate the Copy/Paste interface by clicking the which appears as the last item in the group of icons to the right of the ingredient list. The recipe ingredients will appear in the upper portion of the Ingredient Parser window.

Make any edits that you wish in this portion of the screen. For example, if the recipe lists an ingredient as sugar and you know that the corresponding item in your ingredient list is granulated sugar, you may want to change this. For any ingredient or unit that you do not alter in this portion of the screen, the ingredient and/or unit will be added to your ingredient and/or units list if it does not exist.

Once your ingredients are formatted to your liking, click the Parse Text button. The ingredient list will be transferred to the lower portion of the window beneath the label Ingredients as understood by &krecipes;:. From this portion of the screen, you can set any Headers by clicking on the Set Header button to the right.

Click the OK button that appears in the top right-hand corner of window to transfer you ingredients to your recipe. You can also choose not to proceed with the addition of the ingredients by clicking on the Cancel button which will close the window.

Once the ingredients have been transferred into the ingredient list for your new recipe, they can be moved or removed as describe in the section Entering Recipe Ingredients above. In addition the amount, unit or preparation methods can be edited, also as described above.

You can now proceed to enter the recipe instructions as described below. The method for preparing your recipe can be copied from the source that you are using and pasted into the Instructions tab.

Here's a screenshot of the edited ingredients in the &krecipes; Parser interface. Screenshot

The Completed Ingredient Parser

#### 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 Apple Brown Betty recipe shown in the screenshot, we have the ingredient brown sugar. As you begin typing brown sugar in your recipe instructions, &krecipes; will match typed characters with ingredients in your recipe ingredient list and automatically complete the remaining characters.

For example, if you type b, the characters rown sugar 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 brown sugar as sugar and you enter the character s. &krecipes; will search the ingredients in your recipe and match the first ingredient beginning with s that it finds, if there is one. If there is no ingredient in your recipe ingredient list beginning with s, nothing will happen – you will just continue typing the word sugar.

If there is another ingredient beginning with s in your recipe ingredient list, 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 yield –

     To scale by yield, select the Radio Button beside the Scale by yield label. Below this and beside the Current yield: label, the current yield of your recipe is shown. Beside the New yield:, there is a text box in which to `enter the new yield amount desired`.

  2. Scale by factor –

     To scale by factor, click the Radio Button beside theScale by factor label. Enter `the desired scaling factor` in the text box beside the Factor (i.e. 1/2 to half 3 to triple): label.

  In either of these scenarios, click the OK button to continue. Your recipe will be reproportioned appropriately. Alternatively, click the Cancel button 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.

Be sure that you have selected the recipe that you want to edit. If a recipe is not selected, an alert box will appear displaying the message No recipe selected!

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, Yield Amount, Yield Type, Preparation Time and/or graphic from the Recipe tab

- the Amount, Units, and/or Preparation method for each of the 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, right-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

- Yield – The yield amount 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 button to close the file selection window and return to the previous screen.

If you have selected the Ask which recipes to import tickbox in the Configure &krecipes;, Import interface, when you click on the OK button, the &krecipes; Import Recipes window will appear from which you can select the recipes that you want to import. For instructions on how to select this choice see the section Choosing Import/Export Preferences. If this selection is not made, your recipes will be imported silently with no prompt.

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.

Below the All label, all the remaining Categories will be listed and the tickbox to the left of each category label will contain a check mark indicating that the category is selected. These categories will be collapsed by default and in brackets to the right of the category label, the number of recipes in the category will be shown.

Each category can be expanded to reveal the list of recipes in the category by clicking on the + sign that appears to the left of the tickbox. Again, by default, recipes within each category are selected as indicated by the checkmark in the tickbox to the left of the category name. Any recipes that do not have a category attached to them will appear under the Uncategorized group. To deselect any recipes that you do not wish to import, simply clear the tickbox beside the recipe name by clicking on it.

Once you are satisfied with the selection(s) you have made, 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.

Any recipes that have been placed in the Uncategorized group can be individually edited to place them in the appropriate existing category. You may also define a new category in which to place them. See the section Editing Saved Recipes and The Categories Component for instruction on how to do this. After editing the recipes in order to place them in categories, the Uncategorized label will still show in your list. Closing &krecipes; and restarting the program will remove it from the list.

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 to cancel the import and return to the previous screen.

##### Steps Common to All Database Imports

Similar to importing recipes from a file, if you have selected the Ask which recipes to import tickbox in the Configure &krecipes;, Import/Export interface, when you click on the OK button, the &krecipes; Import Recipes window will appear from which you can select the recipes that you want to import. For instructions on how to select this choice see the section Choosing Import/Export Preferences. If this selection is not made, your recipes will be imported silently with no prompt.

Again the All label will show and beneath this, the list of all categories being imported. 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 an means of backup in addition to the backup functionality in &krecipes;. See the section Backing up Your Krecipes Database for further information.

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

  Using this format exports your recipe in a readable format that 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 without any warning.

- Plain Text – files of this format will have extentions of .txt

  Using this format exports your recipe information without the photo into plain text format. The idea here is not to be able to import back into &krecipes;, nor import into any other recipe format. The purpose is to be a handy tool for such tasks as e-mail.

- 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.

- Rezkonv – files of this format will have extensions of .rk

  This is the format for Rezkonv Suite, a popular German recipe program. When recipes are exported in this format, the human-readable and section names (Title, Yield, etc.) will be in German.

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.

Whether you are exporting a single recipe, a category of recipes or your entire database, if no recipe or category of recipes is selected, an alert box will appear containing the message No recipes are currently selected. Would you like to export all recipes in the current view? Click the Yes button (or use the &Alt;Y) to proceed with the export of all recipes. You can also cancel the process in order to select recipes for export by clicking the No button (or use the &Alt;N key combination).

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, simply 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.

### Backing Up and Restoring Your &krecipes; Database

With &krecipes; it is an easy task to Backup and Restore your database. The Backup tool is extremely important so that you never lose your recipe database in the event of a hard drive failure. It is wise to ensure that you have a backup copy of your database in a location other than your hard drive. The Backup functionality is also useful when you simply want to revert to a previous version of your recipe database.

#### Backing Up Your &krecipes; Database

To backup your &krecipes; database file, select File and Backup... from the &krecipes; menu bar. However, you might want to consider creating a keyboard shortcut (see the section Creating Shortcuts for more information), or adding an icon to your toolbar (see the section Customizing the Toolbar for instruction on how to do this), since this is an invaluable tool and you will find yourself utilizing it often.

Once you have selected the menu item, shortcut or icon to backup your database, the Save Backup As... -&krecipes; window will appear where you can navigate to the location where you want to store your backup file and provide a name for it. By default, this interface opens to your home directory. You can navigate to another location and then, type the name that you wish to utilize for your backup in the textbox beside the label Location:. To position the cursor in the Location: textbox, either click in the box or use the keyboard shortcut &Alt;L. If you have previously backed up your database, you can also select it from the drop-down menu beside the Location: textbox.

The Filter: textbox shows the type of file that you are creating. In the situation where you are backing up your &krecipes; database file, there is only one type of file available – a &krecipes; Backup File (*.krecbk), and that shows as the default selection.

The final item in this window is a tick box beside the label Automatically select filename extension (.krecbk). With this option active, i.e. there is an x in the tick box, you can provide a filename, but do not have to supply an extention. The extension .krecbk will be attached to your filename automatically. However, you do not have to use the extension .krecdb. Simply clear the tick box and then, when you supply the filename for your backup, include the extension that you choose. For example, you might choose to name your database backup file myrecipes.krback.

When you have chosen the name for your backup and the location where you want to store it, click the Save button to complete the backup process, or the Cancel button to close the interface and return to the main &krecipes; window.

#### Restoring Your &krecipes; Database

To restore your &krecipes; database file, select File and Restore... from the &krecipes; menu bar. As previously mentioned, you might want to consider creating a keyboard shortcut (see the section Creating Shortcuts for more information), or adding an icon to your toolbar (see the section Customizing the Toolbar for instruction on how to do this).

Once you have selected the menu item, shortcut or icon to restore your database, the Restore Backup – &krecipes; window will appear where you can navigate to the location where you saved your backup. Once you have located the file and selected it, its name will appear in the textbox beside the label Location:.

By default, the Restore Backup – &krecipes; window opens to your home directory. An alternative to navigating to the the location of your backup file and selecting it would be to type its name, including the path, directly into the Location: textbox. To position the cursor in the Location: textbox, either click in the box or use the keyboard shortcut &Alt;L. If you have previously backed up your database, you can also select it from the drop-down menu beside the Location: textbox.

As with the backup function, the textbox beside the Filter: label shows the type of file as &krecipes; Backup File (*.krecbk).

Once you have selected your backup file, click the Open button to initiate the restore or the Cancel button to close the window and return to the main &krecipes; interface.

If you chose to proceed with the restore, the Warning – &krecipes; window will appear, as shown in the following screenshot:

Here's a screenshot of the warning that appears when restoring the &krecipes; database. Screenshot

Restoring You Database – Erase Warning

You can select the tick box beside the label Do not ask again to prevent this message from showing in the future. However, if you choose to do this, your backup file will be restored silently and you will not be able to change your mind.

If you choose to continue to show the warning, click the Continue button to proceed with restoring your database file, or the Cancel button to stop the restore process and return to the main &krecipes; screen.

If you choose to continue with the restore, a progress dialog window will appear. The number of recipes in your database determines the length of time that this window will show. Finally, a dialog box will appear containing the message Restore Successful. Click the OK button to clear the window. Your restore is now complete!

### 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 heading. 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 button 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 button to clear all entries and begin again.

Once you have completed entering all the nutrient information, click the Create the diet button 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 beneath the phrase 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. When your recipes are listed, they are grouped according to the number of missing ingredients and for each group, prior to listing the recipes, the number of missing ingredients is specified.

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. This list includes 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(s), 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 pre-loaded 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... button 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. Thecells 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 lb. (the abbreviation for pound). Using the horizontal scroll bar at the bottom of the window, scroll until the unit ounces is revealed along the top. Click on the cell that is beside lb. and below ounces to make it active. You can now enter 16, which is the equivalent in ounces of 1 lb., in the cell. You can also use the directional arrows to navigate to the correct position for entering the equivalent if another cell is already active.

For large number equivalents, &krecipes; will automatically format the number with a thousands separator. For instance, to enter the milligram equivalent of 1 lb, you would enter 454000. Once you move off the cell, &krecipes; will display the number as 454,000.

Once the &krecipes; program knows the equivalency, it can automatically calculate other equivalencies. 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.

Should you find that you made a mistake in entering one of the unit equivalents, removing the erroneous entry is as simple as selecting the cell and pressing the Enter key.

#### 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.

A 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.

The second preference available for configuration in the Server Settings screen is for the Backup operation. It is required that the path to your database program be known for the Backup operation to work properly. Therefore, beside the label that is shown in the screenshot as Path to 'sqlite3':, there is a text box which shows the name of the database program. The text in this box can be changed by directly editing it, or by clicking the File icon, which will activate the screen that allows you to navigate to the location of your database program executable file.

You might want to do this if you have chosen to install your database program to a location that is different from the default. Also note that, in the screenshot, the database program shows as sqlite3. However, if you use another database program, for instance MySQL or PostgreSQL, the appropriate database would be shown.

This setting is for the purpose of setting the location of the database file. For specific information on backing up your database, see the section Backing Up Your &krecipes; Database.

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/Export Preferences

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

Configure &krecipes; – Import/Export interface

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

On this screen under the heading Import, two options exist —

The first is Overwrite recipes with same title and this feature can be turned on by clicking the tickbox beside the label. 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)

The second option is Ask which recipes to import and again, this feature can be turned on by selecting the textbox. If this feature is not turned on, your recipes will be imported silently with no prompt. See the section Importing and Exporting Recipes for a screenshot that will show the result of this option being selected.

##### Copying to the Clipboard

Under the heading Export, a drop-down menu exists from which you can select the Copy to Clipboard format you wish to use.

Essentially, copying to the clipboard is the same as exporting a recipe. The difference lies in the end result of the export. The traditional export function creates a file (see the section Exporting Recipes to Other Formats for a complete description of this). The Copy to Clipboard function creates a copy of the recipe in the specified format and places the copy on the clipboard. This provides the ability to paste that copy into an e-mail, for example. The usefulness of this might be in the situation where an attachment to an e-mail might be scrubbed.

The available choices for Copy to Clipboard are —

- Plain Text (*.txt) – If copied to the clipboard in this format, the result will be a plain text copy of the recipe.

- Krecipes (*.kreml) – If copied to the clipboard in this format, the result will contain all the associated markup tags that allow formatting which is associated with &krecipes;.

- Meal-Master (*.mmf) – If copied to the clipboard in this format, the result will be a format that is recognized by the Meal-Master program.

- Rezkonv (*.rk) – If copied to the clipboard in this format, the result will be a format that is recognized by the Rezkonv program.

- RecipeML (*.xml) – If copied to the clipboard in this format, the result will contain all the associated markup tags that allow formatting associated with RecipeML.

As previously stated, once the recipe is copied to the clipboard in the desired format, it can be pasted into an e-mail. It can also be pasted into a text editor for the purpose of saving the document. When a recipe is copied to the clipboard in a plain text format and then pasted into an e-mail or another document, it is not intended to be imported back into &krecipes; or any other recipe program. However, suppose another format has been selected for Copy to Clipboard. What do you do then and how do you get it back into a related recipe program?

If the recipe has been copied into an e-mail and sent, the recipient could just copy the section associated with the recipe and then, paste it into a text editor and save it to a file with the extension associated with the format – .kreml for &krecipes; format, .mmf for Meal-Master format, .rk for Rezkonv format, or .xml for RecipeML format. Once saved, this file could then be imported back into the associated recipe program.

If the contents of the clipboard have been pasted directly into a text editor, the file can then be saved with the appropriate extension as previously listed and imported back into the associated recipe program.

#### Enhancing Performance

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

Configure &krecipes; – Performance interface

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

In this interface, you are customizing two settings. For a reason that you might want to do this, see the section Reasons for Configuring Performance Settings. These settings can be used individually or together or not at all.

The first is to set the number of categories that appear in the list when the Find/Edit Recipes component is selected. By default, this number is set to Unlimited, which means that all categories will be displayed. To change this setting, adjust the slider that appears below the label Number of categories to display at once: until the desired number appears, or use the spinbox to set the number.

The second setting that you might wish to change is for the number of items that are displayed in lists, for example, the Ingredients list or Properties list. Again, by default this is set to Unlimited and to change the setting you would adjust the slider that appears below the label Number of elements to display at once:, or use the spinbox until the desired number appears.

It should be noted that for the Number of elements to display at once: setting, the adjustment is done in increments of 1000 when using the spinbox. Should you wish to set smaller numbers, you can do this by highlighting the word Unlimited or whatever numeric entry appears in the box and type the number that you wish to use. However, this feature is ideally used when you have a very large database of recipes.

##### Reasons for Configuring Performance Settings

In most instances, the settings to adjust the Number of categories to display at once: and/or the Number of elements to display at once: will not have to be changed. The ultimate reason that you might want to do so occurs when you have a very large database of recipes. Adjusting these settings so that your Categories or list items are loaded in groups will greatly improve the speed of loading for these items.

## Reporting Problems

In the event that &krecipes; program does something unexpected and you think this might be a bug, you can submit a bug report to the program maintainer. Even if you do not encounter any problems and you have an idea to improve &krecipes;, you can submit this request as well. By submitting a report in either of these situations, it will help us to continually improve &krecipes;.

### Reporting Bugs/Requesting Feature Enhancements

To submit a bug report, select Help and Report Bug from the &krecipes; menu bar. The Submit Bug Report – &krecipes; window appears as in the screenshot below:

Here's a screenshot of the &krecipes; interface for submitting bugs or feature requests. Screenshot

Submitting Bug Reports and Feature Requests

This is the actual e-mail interface used to submit the bug report or feature enhancement. In addition to the section for typing the e-mail, it provides a wealth of information, some of which provides information that will assist the maintainer in acting on your e-mail. The information provided is as follows: —

- From: – the e-mail address of the person sending the e-mail shows beside this label, i.e.your e-mail address

- To: – the e-mail address of the person to whom the e-mail is being sent shows beside this label, i.e.the program maintainer

- Application: – the application that the report pertains to shows beside this label

  &krecipes; is shown by default because you are sending this from within &krecipes;. However, &krecipes; is a &kde; application, so there is a drop-down menu from which you could select another application if you were sending a report from within another program.

- Version: – the version of the &krecipes; program being used when the report is submitted shows beside this label

- OS: – the operating system being used and its version show beside this label

- Compiler: – the compiler used to compile &krecipes; and its version is shown beside this label (A compiler is the program that turns the source code as written by the programmer into what is known as object code, which the computer can understand.)

The next sections are the ones that you will have to complete.

In the section labelled Severity, you provide the information as to the type of report by selecting the pertinent radio button as follows —

- Critical – this selection indicates that there is a serious malfunction in the &krecipes; program. This could be indicated by a program crash

  In the event of a crash, a Backtrace window might appear. This information is useful to the maintainer, so it is wise to copy the text that appears in this window and paste it into the body of your e-mail.

- Grave – this selection might be indicated if &krecipes; has been rendered unusable

- Normal – this selection indicates that some aspect of &krecipes; is failing to perform as expected.

- Wishlist – this selection would be used to request a feature enhancement to &krecipes;. This is the type of report being shown in the screenshot.

- Translation – this selection would be use to request that the &krecipes; be translated into another language.

In the textbox beside the label Subject: you would type a description of the report being submitted and finally, in the large text area, you would type a description of the problem or enhancement and provide any error messages that have been displayed.

When you have completed the e-mail, click the Send button to submit your e-mail or the Cancel button to close the interface and return to the main &krecipes; window.

When you click the Send button, you will be prompted for a password. This is the password that goes along with your system username. However, before you can actually send your e-mail, it must be configured for sending as described in the following section. Click the Configure Email... button to start the e-mail configuration interface.

#### Configuring Email to Enable Submission of Bug Reports

Here's a screenshot of the e-mail configuration screen that enables the ability to send bug reports from within &krecipes;. Screenshot

Configuring Email

From the screenshot, you will notice that there is an icon at the top of the page and beside this your username that you use to log onto your system. This icon can be changed by clicking on it.

The next set of information that you need to provide appears below the label User Information and that is exactly what this section contains. Looking at the screenshot, the information that needs to be provided is self-explantory. Of the first four pieces of information provided, the only ones that are absolutely essential are your Email address: and SMTP server:. An SMTP server is the server used for sending e-mail. This could be the one housed by your internet service provider, or one that is on your local area network.

The last item shown in the User Information section is for the User ID. In the screenshot, nothing shows beside this label, but it would normally default to your numerical User ID as set up on the system.

In the section beneath the label At Password Prompt, three radio buttons appear from which you can make the choice that you want. This selection dictates what will happen when you enter your password when prompted. Each time you press a key for a character in your password, that character is reiterated by the number of stars as determined by the radio button selected – one star if you chose the radio button beside the label Show one star for each letter, or three stars if you chose the radio button beside the label Show three stars for each letter. If you chose the radio button beside the label Show nothing, no stars will be reiterated.

It is not necessary to utilize the Change Password button. You probably already have a password to log onto your system. However, should you wish to change the password associated with your username, you may do so by clicking this button and following the prompts.

Now you are ready to send your e-mail!

## 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

File Backup

  Backs up your &krecipes; database file refer to the section Backing Up Your &krecipes; Database.

File Restore

  Restores your &krecipes; database file refer to the section Restoring Your &krecipes; Database.

&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

&Ctrl;C Edit Copy to Clipboard

  Will make a text copy of a selected recipe and place it on the Clipboard in order to paste into another application, for example an e-mail.

#### 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/Export Preferences for specific configuration instructions.

#### The Help Menu

&help.menu.documentation;

## Questions and Answers

&reporting.bugs; &updating.documentation;

I've put a lot of recipes into Krecipes and now it runs and loads very slowly. Is there anything I can do to speed it up?

Krecipes can work fine with thousands of recipes, even on a modest machine, and it is currently being tested with 50,000+ recipes.

Here's what you can do:

- Select the MySQL or PostgreSQL backends. They provide better overall performance than SQLite, especially for a huge amount of recipes.

- In the Configure Krecipes dialog, tune the Performance options.

- Categorize your recipes. Krecipes will load much faster if all recipes are categorized.

The Ingredient Matcher never matches any recipes. What am I doing wrong?

The purpose of the Ingredient Matcher is to find recipes that you are able to make (or almost make) with ingredients that you select. That means you have to select every single ingredient used in a recipe (or all but a few, depending on how many ingredients can be missing) to match that recipe. See the Ingredient Matcher section for details.

If you want to see which recipes use particular ingredients, then you want to use the The Ingredients Search.

## 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 jkivlighn@gmail.com

  Project Maintainer & Core Developer

Cyril Bosselut bosselut@b1project.com

  Core Developer

Documentation copyright 2004-2005 Colleen Beamer colleen.beamer@gmail.com and Jason Kivlighn jkivlighn@gmail.com

&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 SVN in the extragear/utils module. Instructions for downloading and installing through SVN 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;