tp

RecipEditor

Introducing RecipEditor

RecipEditor is a hybrid CLI-GUI application that allows you to manage your recipes.

RecipEditor can be used across all operating systems such as Windows, Mac OS X, Linux and Unix. It is optimised for use via a complement of Command-Line Interface (CLI) and Graphical user interface (GUI). Both the CLI and GUI are made to be as simple as possible so that it would be especially beneficial for fast typers who needs a platform to keep track of the countless recipes.

If you type fast, and you need an easy and quick way to record your recipes, RecipEditor is the app for you! 💯

About This User Guide

This guide explains how you can use all the features available on RecipEditor and maximise your user experience.

To preface, we do expect users to have a basic level of comfort with using computers, and it would be even better if you are familiar with CLI to be using RecipEditor. However, if you do not, do not worry as we have provided a comprehensive set of instructions to get started!

Throughout this guide, we will be using some special formatting and symbols to bring your attention to certain aspects:

Formatting Meaning
italics Text that has been italicised indicates that it is a term specific to RecipEditor.
bold Text that has been bolded indicates that it is important.
abc Text with a highlight indicates that it is code that can be typed by you into the command line or displayed by RecipEditor.
ℹ️ This symbol indicates important information.
⏫ This symbol indicates a shortcut to the content page. You may click it to quickly navigate back to the content page.

Content Page

Quick Start

  1. Ensure that you have Java 11 or above installed.
  2. Down the latest version of RecipEditor from here.
  3. Go to the directory of the RecipEditor.jar
  4. Use command line to start the program java -jar RecipEditor.jar

If successfully loaded, you will see this screen:

⏫ Back to content page

Features

ℹ️ Command Format

Add Command

Adds new recipe to your recipe list. This feature allows you to record down the recipe title, recipe description, ingredients used and the steps involved. To record the ingredients used, user can note down the ingredient name, amount and the respective units. As for the steps involved, user will specify the steps in the order of execution.

ℹ This feature brings out a GUI editor that allows user to quickly type all the different sections at once.

Format: /add

GUI Editor

A simple GUI text editor will open and loaded with a template file as shown below:

ℹ Ingredient amount takes in floats (eg. 0.5), but not fraction (eg. 1/2)

Edit the corresponding field according to the following convention:

Example:

# TITLE 
Carbonara

# DESCRIPTION
Carbonara is an Italian pasta dish from Rome made with eggs, hard cheese, cured pork and black pepper.
Hot pasta tossed with a creamy sauce of raw beaten eggs, accentuated with crisp bits of guanciale, and 
finished with a shower of grated aged Pecorino Romano cheese plus freshly ground black pepper.

# INGREDIENTS ingredient_name / amount / unit
1. Extra virgin olive oil / 1 / table spoon
2. Eggs / 3 / whole
3. Parmesan cheese / 1 / cup
4. Spaghetti / 0.9 / pound

# STEPS 
1. Heat the pasta water.
2. Sauté the pancetta or bacon and garlic.
3. In a small bowl, beat the eggs and mix in about half of the cheese.
4. Once the water has reached a rolling boil, add the dry pasta, and cook, uncovered, at a rolling boil.
5. Add the beaten egg mixture.
6. Pour the mixture over the pasta.

ℹ After inputting all the relevant field, you can click on the “Save and Exit” button in the top left corner of the GUI editor.

ℹ Otherwise, if you decide not to save the information you have inputted, you can click on the “Exit Only” button to exit the add mode.

⏫ Back to content page

Edit Command

Edit existing recipe with the given INDEX as shown in the recipe list. To see the index of the recipe, you can use the /list command to show all the recipe titles that is in your current recipe list. The INDEX will be the number on the left of the recipe title.

ℹ This feature allows you to choose between using GUI editor or CLI editor. For GUI editor, it will load the recipe information that was previously saved by the user. For CLI, you can make the relevant edits using the commands and flags as shown below.

GUI Editor

The GUI Editor workflow is similar to GUI Editor

Format: /edit INDEX

Example:

/edit 1

CLI Editor

The CLI Editor updates the recipe directly on the CLI. Users have to input the appropriate flags (recipe and command flags) and take note of the format before entering the command.

Format: /edit RECIPE_INDEX COMMAND_FLAG RECIPE_FLAG PARAMETERS

Recipe flags: Specify the part of recipe that will be changed

Command flags: Specify the type of function to be used**

ℹ The flag order (recipe and command flag) does not matter, but exactly 1 (one) command flag and 1 (one) recipe flag are allowed in an edit command.

ℹ Not including the index, adding the wrong flags or using inappropriate parameters will throw an error.

ℹ Trailing arguments and extra input before the last flag will be discarded.

The following two commands are identical to each other:

/edit 1 GARBAGE -i GARBAGE -swp 1 2 GARBAGE

/edit 1 -swp -i 1 2

⏫ Back to content page

Delete Command

Delete existing recipe with given recipe title or recipe index from the list. This helps you to organise your recipe list such that those recipes that ‘outdated’ or no longer used by you can be removed.

Format: /delete -t [RECIPE_TITLE] OR /edit -id [RECIPE_INDEX]

ℹ The RECIPE_TITLE is not case-sensitive. Therefore, inputting recipe_title and RECIPE_TITLE yields the same result.

Example:

/delete -t carbonara

/delete -id 1

⏫ Back to content page

List Command

List the existing recipe titles previously added to the recipe list. This gives you a quick overview of the recipes that you have added previously.

Format: /list

Example:

/list
There are 3 recipes in the recipe list
1. Apple Crumble
2. Gyoza
3. Nasi Briyani

⏫ Back to content page

View Command

View the full details of the specified recipe according to the index shown in the list. The details shown include recipe title, recipe description, ingredients used and steps involved. To record the ingredients used, user can note down the ingredient name, amount and the respective units. As for the steps involved, user will specify the steps in the order of execution.

Format to view with recipe title:/view -t [RECIPE_TITLE]

Format to view with recipe title: /view -id [RECIPE_INDEX]

Example:

/view -id 1
TITLE:
Carbonara

DESCRIPTION:
Carbonara is an Italian pasta dish from Rome made with eggs, hard cheese, cured pork
and black pepper. Hot pasta tossed with a creamy sauce of raw beaten eggs, accentuated with crisp bits of
guanciale, and finished with a shower of grated aged Pecorino Romano cheese plus freshly ground black pepper.

INGREDIENTS:  
1. Extra virgin olive oil / 1 / table spoon
2. Eggs / 3 / whole
3. Parmesan cheese / 1 / cup
4. Spaghetti / 0.9 / pound

STEPS: 
1. Heat the pasta water.
2. Sauté the pancetta or bacon and garlic.
3. In a small bowl, beat the eggs and mix in about half of the cheese.
4. Once the water has reached a rolling boil, add the dry pasta, and cook, uncovered, at a rolling boil.
5. Add the beaten egg mixture.
6. Pour the mixture over the pasta.

⏫ Back to content page

Find Command

Find the recipes with relevant recipe title or ingredient name as what the user inputs. Program will look through all the recipe titles and every ingredient names for all recipes, and list out the recipe title that contains what the user inputs.

ℹ User can input RECIPE_TITLE or INGREDIENT_NAME

ℹ The RECIPE_TITLE is not case-sensitive. Therefore, inputting recipe_title and RECIPE_TITLE yields the same result.

Format: /find -RECIPE_FLAG [RECIPE_TITLE or INGREDIENT_NAME]

Example:

/find -t egg

1. Egg Fried Rice
2. Egg Tofu
3. Maggi with Egg

/find -i egg

1. Carbonara
2. Fried Rice
3. Nasi Lemak

⏫ Back to content page

Help Command

Shows the specific command syntax in RecipeEditor.

Format: /help COMMAND

Example:

/help find

Syntax: /find -<flag> <recipe title/ingredient name>
Description: For the given ingredient or title, find recipes which contains it.

⏫ Back to content page

Exit Command

Exits the RecipEditor.

Format: /exit

/exit

RecipEditor ends here...
Program exiting

⏫ Back to content page

Data Management

Storage

The data files are stored at ./RecipeData directory.

The template file and other miscellaneous files are stored at ./RecipeData/App directory.

The individual recipe data files are stored at ./RecipeData/Recipes directory.

There are 2 types of recipe data files to store recipes:

Saving The Data

There is no need to save manually. Any updates made to the data will be automatically stored into the local drive and reloaded when RecipEditor is restarted.

Editing Data File

Parsing Data File

⏫ Back to content page

Command Summary

Command Action Format Example
add Add new recipe /add /add
edit Edit recipe at INDEX /edit INDEX
/edit RECIPE_INDEX COMMAND_FLAG RECIPE_FLAG PARAMETERS		 /edit 1
/edit 1 -add -s "new step"
delete Deletes recipe of given RECIPE_TITLE /delete -t RECIPE_TITLE
/delete -id RECIPE_INDEX		 /delete carbonara
list List all recipes /list /list
view View recipe at INDEX /view -t RECIPE_TITLE
/view -id RECIPE_INDEX		 /view -t carbonara
/view -id 1
find Find recipe with RECIPE_TITLE or INGREDIENT_NAME /find -t RECIPE_TITLE
/find -i INGREDIENT_NAME		 /find -t rice
/find -i egg
help Show available commands /help COMMAND /help find
exit Exit the program /exit /exit