DukeCooks - User Guide

Be the most efficient person in the room! Use the goto command to bring you to the awesome features that make up DukeCooks.

Have you just created a new dish, or tried a new exercise? Then you may want to save your new discoveries to DukeCooks with the Add command! Add commands will be used whenever you want to create new things, be it exercises, tasks, recipes, health records or diaries.

Edit commands will be used to edit whatever entries you have made to any part of DukeCooks.

List commands will show you all your saved entries. They are also useful to navigate to different parts of DukeCooks.

Find commands will enable you to search through all of your data to find entries matching your keywords.

View commands will be used to open up a one specific entry within DukeCooks.

Delete commands will be used to delete a specific entry within DukeCooks.

Clear commands will be used to clear all saved data.

Find yourself lost and not knowing what to do? Help command will bring you to this informative User Guide and you can learn how to use DukeCooks.

Exit command will be used to stop DukeCooks.

Although DukeCooks is developed for expert CLI users, beginners fret not as DukeCooks' interface is very easy to pick up. For first time users of the CLI, we acknowledge that working with it can be a daunting task. So, let’s first start off by understanding what makes up the Dashboard!

In the image below (Figure 3), accompanied with text on the right, provides a brief explanation of the key components found in the Dashboard.

Alright, now you are ready to use DukeCooks! The following are the instructions on all the commands available in the Dashboard.

A quick way to get to the Dashboard and start getting work done!

Command: goto dashboard

Let’s start by using the add command to add some tasks into DukeCooks!

Command: add task
Format: add task tn/<insert task here> td/<insert date here>

Example usage (Figure 4 & 5): add task tn/Bake CupCakes td/11/11/2019

Step 1. Enter the task you want to add into the command box and hit enter.

Step 2. If you have correctly inputted the information for adding a task, DukeCooks will tell you that the task is successfully added in the message box.
Step 3. You can view the newly added task under the Dashboard.

Made some typos when adding a task?
Fret not! You are able to make changes to them.

Command: edit task
Format: edit task <index number> tn/ <insert new name> td/ <insert new date>

Example usage (Figure 6 & 7): edit task 1 tn/Bake cupcakes td/21/10/2019

Step 1. Look at the index number corresponding to the task you want to edit.
Step 2. Enter the task information you want to edit into the command box and hit enter.

Step 3. If you have correctly inputted the information for editing a task, DukeCooks will tell you that the task is successfully edited in the message box.
Step 4. You can view the newly edited task under the Dashboard.

Decided that this task is not needed?
Well you can delete them off from DukeCooks.

Command: delete task
Format: delete task <index number>

Example usage (Figure 8 & 9): delete task 1

Step 1. Look at the index number corresponding to the task you want to delete.
Step 2. Enter the task index number you want to delete into the command box and hit enter.

Step 3. If you have correctly inputted the information for deleting a task, DukeCooks will tell you that the task is successfully removed from DukeCooks in the message box.

Finished with a task?
Check it off the list!

Command: done task
Format: done task <index number>

Example usage (Figure 10 & 11): done 1

Step 1. Look at the index number corresponding to the task you want to mark as complete.
Step 2. Enter the task index number you want to mark as complete into the command box and hit enter.

Step 3. If you have correctly inputted the information for marking a task as complete, DukeCooks will tell you that the task is successfully marked in the message box.
Step 4. You can view the newly marked task under the Dashboard.

For those who want to know what are the tasks relevant given a keyword.

Command: find task
Format: find task <keyword>

Example usage (Figure 12 & 13): find task project

Step 1. Enter the a keyword for that tasks you to find into the command box and hit enter.

Step 3. If you have correctly inputted the information for finding a task, DukeCooks will tell you that the number of tasks relating to the keyword found in the message box.
Step 4. You can view the task relating to the keyword under the Dashboard.

Look at all those tasks!

To view completed tasks:
Command: list taskcomplete

For incomplete tasks:
Command: list taskincomplete

Think you need a little bit more time to complete a task?

Command: postpone task
Format: postpone task <index number> by <number of days>

Example usage: postpone task 1 by 5
The above example will postpone the date of task 1 by 5 days.

Want to know how many tasks you have done over the week?
DukeCooks will show you how many tasks you did each day for the past week.
Look at your progress and perhaps learn something about yourself!

Command: progress task

DukeCooks knows you are hard at work. But for the times where you need an extra push, DukeCooks is here for you!
DukeCooks has a specially curated gif list that is sure to put a smile on your face!

Command: humour me

A picture paints a thousand words. Same can be said with a calendar. Change to calendar view for a clearer view of all tasks due on a certain date!

Command: calendar

The recipe book allows you to look at all the recipes you have stored within DukeCooks!

Look at the diagram for a better understanding of how the Recipe Book is laid out!

Here’s a quick way to pop into the recipe book!

Command: goto recipe

Adds a recipe into the recipe book.
Command: add recipe
Format: add recipe n/<name> i/<ingredients>…​ cal/<calories> carb/<carbs> fats/<fats> prot/<protein>

Examples:

Edit a recipe according to a specified index.
Command: edit recipe
Format: edit recipe <index> [parameters]

The possible parameters are:

Examples:

Lists all recipes.
Command: list recipe
Format: list recipe

Examples:

Finds recipes with names containing a specified keyword.
Command: find recipe
Format: find recipe <keyword>

Examples:

Deletes recipe according to a specified index.
Command: delete recipe
Format: delete recipe <index>

Examples:

Clears all recipes stored in the recipe book.
Command: clear recipe
Format: clear recipe

Examples: * clear recipe
Deletes all recipes within the recipe book.

Brings up an in depth view of a recipe according to a specified index.

Here you will be able to see the recipe’s total nutritional value, image, difficulty and preparation time.+ Command view recipe
Format: view recipe <index>

Examples:

Give images to your recipes according to its index
Command: image recipe
Format: image recipe <index> <filepath>

Examples:

Tag your recipes difficulty level.
Command: diff recipe
Format: diff recipe <index> <difficulty>

Examples:

Give your recipes a preparation time
Command: prep recipe
Format: prep recipe <index> <time>

Examples:

Generates a shopping list based on the input indexes of recipes
Command: shoppinglist recipe
Format: shoppinglist recipe <index>…​

Examples:

Using Meal Plans, you will be able to take all the recipes you have in DukeCooks and use them to plan your meal plans for the week.

Look at the diagram for a better understanding of how Meal Plans are laid out!

Here’s a quick way to check out your meal plans!

Command: goto mealplan

Adds a new meal plan into the meal plan book.
Command: add mealplan Format: add mealplan n/<name> day1/[name]…​ day2/[name]…​ day3/[name]…​ day4/[name]…​ day5/[name]…​ day6/[name]…​ day7/[name]…​

Examples:

Edit a meal plan according to a specified index.
Command edit mealplan
Format: edit mealplan <index> [parameters]

The possible parameters are:

Examples:

Lists all meal plans.
Command: list mealplan
Format: list mealplan

Examples:

Finds meal plans with names containing a specified keyword.
Command: find mealplan
Format: find mealplan <keyword>

Examples:

Finds meal plans with a specified recipe name.
Command: find mealplanwith
Format: find mealplanwith <recipe name keyword>

Examples:

Brings up an in depth view of the meal plan according to a specified index.

Here you will be able to see the meal plan’s total nutritional value, as well as the recipe details for each day.+ Command view mealplan
Format: view mealplan <index>

Examples:

Deletes meal plan according to a specified index.
Command: delete mealplan
Format: delete mealplan <index>

Examples:

Clears all meal plans stored in the meal plan book.
Command: clear mealplan
Format: clear mealplan

Examples:

Generates a shopping list based on the input index of a meal plan
Command: shoppinglist mealplan
Format: shoppinglist mealplan <index>

Examples:

Before you get overwhelmed by what’s in Health Records, here’s everything you need to know to get you started! Keep scrolling!

Refer to the following diagrams for a better understanding.

Looking for just a specific record type? DukeCooks got you covered! Refer to diagram below!

The following record types are supported by DukeCooks:

Here’s a quick way to get to the Health Records!

Command: goto health

Want to have a personalized profile of your own? This is just the perfect command you’re looking for!

Command: add profile
Format: add profile n/<name> d/<date of birth> g/<gender> bt/<blood type> w/<weight> h/<height> [m/<medical history>]

Example usage: add profile n/Alex Yeoh d/23/02/1995 g/female bt/a+ w/57.8 h/173.2 m/Stroke m/Diabetes

Need to make amendments to your profile? Simply follow the format below!

Command: edit profile
Format: edit profile n/<name> d/<date of birth> g/<gender> bt/<blood type> w/<weight> h/<height> [m/<medical history>] [m-/<medical history>]

Example usage: edit profile g/male bt/a- w/57.5 h/173 m-/Stroke m/High Blood Pressure

Want to get rid of your profile? This command helps to remove your existing profile.

Format: delete profile

Example usage: delete profile

Looking for just a specific record type? This command directs you to the details page with beautiful visual illustrations of your records!

Command: list health
Format: list health t/<type>

Example usage: list health t/weight

Unsure of what record types are available? Refer to the list below!

Adding a new health record? Easy! Just follow the given format below!

Command: add health
Format: add health t/<type> val/<value> dt/<date time> [remark/<remark>]

Example usage: add health t/weight val/60 dt/10/11/2019 12:00 remark/after meal

Made some mistakes and need to update your record? Simply fire away the edit command below to start editing!

Command: edit health
Format: add health <index> val/<value> dt/<date time> [remark/<remark>] [remark-/<remark>]

Example usage: edit health 1 val/62 dt/10/11/2019 10:30 remark-/after meal remark/before meal

Deleting a duplicate health record? DukeCooks can help with that!

Command: delete health
Format: delete health <index>

Example usage: delete health 1

Want to start afresh with your health records? DukeCooks can help you restart to a clean state!

Format: clear health

A feature to track user’s food consumption based on existing recipes.

Adds relevant records based on the recipe’s nutritional information
Format: link recipe n/<recipename> /to health dt/<date time> [remarks/<remarks>]

Examples:

Based on user’s profile data and existing health records, DukeCooks will generate some recommendations.

Example:

Generates a PDF copy of health records.
Format: print health t/<type> [MORE_TYPES] period/<time period>

Examples:

Alright, I’m now at the workout screen! What’s next?

As seen in the screenshot above, the Workout Planner screen is similar to the other screens, with the main difference being the list of Exercise cards and Workout Cards. Not too sure about what to work on or need suggestions? Workout Planner begins with prebuilt Exercises and Workouts installed to get you started.

Over on the left, is the list of Exercise Cards. Each card informs you of the name, primary muscle as well as the intensity of the exercise. To get more information of the exercise, you can use the view command which will be covered in section 3.7.3 of the User Guide.

Similarly on the right we have the list of Workout Cards. The Workout Cards shows the Workout name, the number of Exercises in the workout as well as the last time the workout was ran. You can also tell the intensity of the workout from the image of the card.

Similarly, to find more information on the workout, you can use the view command which is covered in a later section of this User Guide.

"I now know the components of the Workout Planner! So what can I do with it?"

Well I’m glad you asked kind person! To start off, we have the add exercise command which creates new exercises for your workouts. To add an exercise, you must first specify its name, primary muscle trained as well as its intensity. You can also add optional fields such as secondary muscles and exercise details like sets and reps. The following shows all the possible fields that can be added:
* Name
* Primary Muscle
* Intensity
* Secondary Muscles (optional)
* Number of sets (optional)
* Number of repetitions (optional)
* Timing (optional)
* Distance (optional)
* Exercise Weight (optional)
To add the exercise, simply input the fields in the Command Box in the following format:
Format: add exercise n/EXERCISE_NAME p/PRIMARY_MUSCLE sm/SECONDARY_MUSCLE i/INTENSITY s/SETS r/REPETITIONS d/ DISTANCE w/WEIGHT t/TIMING

Examples:

The following images show an example of the command being inputted and its corresponding outputs.

Ok, now that you’ve added your exercise, you probably want to know all of its details. Simply input the command view exercise followed by the index of the exercise you want to view as shown below.

The screen should now show the full details of the exercise in question. Let’s get you up to speed with what’s what.

The details on this page is automatically updated with each workout run. To return back to the exercise page, simply invoke the goto exercise command.

More statistics as well as graph view will be implemented in version 2.0.

Now that you have a sizable amount of Exercises, you realise that you cannot easily find them amongst the sea of cards. To tackle this problem of seamless navigation, we implemented the find command.

Find Exercise works in 3 ways:

To use the following command, simply type find in the command box followed by the variant you wish to utilise and the predicate.

The filtered lists will then be shown as follows:

To show every exercise again, simply invoke the list exercise command.

Now that you’ve created all your exercise, you’re ready to create a workout plan! To create a workout, input add workout n/NAME into the command box, replacing NAME with the name of your workout. This will initialise your Workout with no exercises in it.

Once you have initialised your workout, you are now ready to add your exercise into your workouts! To do so simply locate the index of the exercise you want to push and the workout you want to push your exercise into. Then input the command in the following format push exercise wi/WORKOUT_INDEX ei/EXERCISE_INDEX.

For example, if you want to add Bench Press exercise into Chest Day workout, type in push exercise wi/4 ei/8 in the command box as seen above. You will get the following input.

Now that you know you know how to push exercises, you can go ahead and add in all the exercises needed for your ULITMATE workout regime!

You’ve created your workout regime, but you’re unsure of the details and your progress. With the view workout feature, you can check all the details of your workout as well as its history!

Similar to view exercise, type in view workout followed by the index of the workout you’re interested in. So if you want to view 'Chest Day' you can follow the image below.

The following screen will now appear. To orientate you, here are the components of the screen:

Similarly to view Exercise command, this page will be automatically updated after each run of the workout. You can also return to the workout planner page with goto exercise.

You’ve created all your exercises and added it into your ultimate workout. Now you’re ready to run it! To run the workout, invoke the run workout command with the index of your ultimate workout.

The window above will pop up upon inputting the command. The window can be broken down into 5 major segments which are :

When you have completed a set, you can input done into the command box and it will indicate the set as completed as shown below.

After completing all the sets in all exercises, you will be brought back to the main page where a congratulatory message will greet you!

With that, you have sufficient knowledge to create and run your workout…​ if you’re perfect that is. To make your life easier, we’ve also included some commands to manage your exercises and workout in case you made errors!

Now you know all there is to the workout planner! What are you waiting for? Go out there and put your gym membership to use!

In the diary feature, you will be able to look through all your available diaries and pages at one quick glance! Not only that, you can also enter different commands within the command box.

Still confused? The following diagram explains where you can find the available diaries, their corresponding pages and also highlights the command box, where different commands can be executed.

Here’s a simple way to get into the diary feature!

Command: goto diary

Let’s get started by adding a diary using the add diary command!

Command: add diary
Format: add diary n/ <diary name>

Example usage: add diary n/ Desserts Galore

Accidentally created an unwanted diary? No worries! You can remove it with our delete diary command.

Command: delete diary
Format: delete diary <diary index>

Example usage: delete diary 8

Made a minor mistake and would like to correct it? You can do so with our edit diary command!

Command: edit diary
Format: edit diary <diary index> n/ <new diary name>

Example usage: edit diary 1 n/ Asian Cuisines

Want to take a look into another diary? Use the view diary command!

Command: view diary
Format: view diary <diary index>

Example usage: view diary 2

Having difficulty with locating a particular diary? You can use the find diary command to quickly find your desired diary.

Command: find diary
Format: find diary <keywords>

Example usage: find diary singapore

Want to see all the available diaries? You can use our list diary command to list all available diaries!

Command: list diary
Format: list diary

Example usage: list diary

Looking to customise your diary further? You can do so by adding pages with our add page command.

Command: add page
Command format: add page

Example usage: add page

Want to remove a page? We’ve got that covered with our delete page command.

Command: delete page
Format: delete page <page index> n/ <diary name>

Example usage: delete page 4 n/ Asian Cuisines

Making minor changes to a page? You can do so with the edit page command!

Command: edit page
Format: edit page <page index> n/ <diary name> t/ [new title] tp/ [new type] desc/ [new description] i/ [new image]

Example usage: edit page 1 n/ Asian Cuisines t/ Beef Pho

Find it too troublesome to add a new page from scratch? DukeCooks will simply link existing recipes / exercises / health records and create the page on your behalf!

Command: link