Merge pull request nus-cs2103-AY2021S1#76 from khor-jingqian/change-d…

…esign Improve User Guide
Licheng-Wu · Oct 20, 2020 · 206e419 · 206e419
2 parents 6c68a23 + 0168c18
commit 206e419
Show file tree

Hide file tree

Showing 22 changed files with 92 additions and 74 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -1,21 +1,14 @@
-#Introduction
+##Introduction
 
 fitNUS is tailored for **NUS students** that are interested in staying healthy and keeping fit. It is suitable for **all
 fitness levels** and is equipped with a **customisable timetable** for you to manage your time wisely and slot in your
 workout routines with ease.
 
 fitNUS is  **optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, fitNUS can get your scheduling tasks done faster than traditional GUI apps.
 
-##Table of Contents
-
-<ol>
-<li> <a href="[Quick Start](#quick-start)">Quick Start</a> </li>
-<li>[Features](#features)</li>
-
-</ol>
+   ![Ui](images/Ui.png)
 
 --------------------------------------------------------------------------------------------------------------------
-<a name="quick-start"></a>
 ## Quick start
 
 1. Ensure you have Java `11` or above installed in your Computer.
@@ -25,68 +18,84 @@ fitNUS is  **optimized for use via a Command Line Interface** (CLI) while still
 1. Copy the file to the folder you want to use as the _home folder_ for your fitNUS.
 
 1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
-   ![Ui](images/Ui.png)
-
-1. Type the command in the command box and press Enter to execute it. Here are some sample commands you can try:
 
-   * **`routine list`** : Lists all routines within fitNUS.
+1. Type the command in the command box and press Enter to execute it. Here are some sample commands you can try:
+
+   * **`exercise_add`**`n/Curls t/Upper` : Creates an Exercise named "Curls" with a "Upper" tag.
 
-   * **`routine create`**`r/Upper Body Session` : Creates a routine names "Upper Body Session"
+   * **`routine_create`**`r/Upper Body Session` : Creates a routine names "Upper Body Session"
 
-   * **`exercise add `**`r/Upper Body Session e/Curls` : Adds an exercise named "Curls" to a routine named "Upper Body Session"
+   * **`routine_add `**`r/Upper Body Session e/Curls` : Adds an exercise named "Curls" to a routine named "Upper Body Session"
 
-   * **`schedule add`**`r/Upper Body Session d/Monday t/1600-1800` : Adds the routine "Upper Body Session" to your
+   * **`timetable_add_routine`**`r/Upper Body Session d/Monday t/1600-1800` : Adds the routine "Upper Body Session" to your
    timetable on Monday at 1600HRS - 1800HRS.
 
 1. Refer to the [Features](#features) below for details of each command.
 
 --------------------------------------------------------------------------------------------------------------------
-<a name="features"></a>
 ## Features 
 
-### Help: `help`
+### Miscellaneous
+
+#### Help: `help`
 
-Lists out all useful commands and their functions.
+Links you to the User Guide where there is comprehensive summary of all command in fitNUS. The link will appear in a
+pop-up.
 
 Format: `help`
 
-### Create new routine : `routine create`
+![Help](./images/help.png)
+
+#### Exit: `exit`
+
+Save fitNUS data and closes the application.
+
+Format: `exit`
+
+### Exercise
+
+### Routine
+#### Create new routine : `routine create`
 
 Creates a new routine by the given routine name.
 
-Format: `routine create r/ROUTINE_NAME`
+Format: `routine_create r/ROUTINE_NAME`
 
 Examples:
-* `routine create r/Leg Day Session` Creates new routine with the name "Leg Day Session".
+* `routine_create r/Leg Workout` Creates new routine with the name "Leg Workout".
 
-### Delete routine : `routine delete`
+![Routine Create](./images/routine_create.png)
+#### Delete routine : `routine delete`
 
 Deletes an existing routine corresponding to the given index.
 
 Format: `routine delete INDEX`
 
 Examples:
-* `routine delete 10` Deletes routine with the index 10.
+* `routine delete 3` Deletes routine with the index 3.
 
-### Add exercise to routine : `exercise add`
+![Routine Delete](./images/routine_delete.png)
+#### Add exercise to routine : `routine_add`
 
 Add a new exercise to a specific routine.
 
-Format: `exercise add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
+Format: `routine_add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
 
 Examples:
-* `exercise add r/Leg Day Session e/Squats` Adds an exercise named "Squats" to the routine "Leg Day Session".
+* `routine_add r/Leg Workout e/Squat` Adds an exercise named "Squat" to the routine "Leg Workout".
 
-### Delete exercise from routine : `exercise delete`
+![Routine Add Exercise](./images/routine_add.png)
+#### Delete exercise from routine : `routine_delete_exercise`
 
 Add a new exercise to a specific routine.
 
-Format: `exercise delete r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
+Format: `routine_delete_exercise r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`
 
 Examples:
-* `exercise delete r/Leg Day Session e/Squats` Delete the exercise "Squats" from the routine "Leg Day Session".
+* `routine_delete_exercise r/Full Workout e/Squat` Delete the exercise "Squat" from the routine "Full Workout".
 
-### View routine details : `routine view`
+![Routine Delete Exercise](./images/routine_delete_exercise.png)
+#### View routine details : `routine view`
 
 View the details of a certain routine.
 
@@ -95,66 +104,75 @@ Format: `routine view INDEX`
 Examples:
 * `routine view 2` Views routine with the index 2.
 
-### List routines : `routine list`
+#### List routines : `routine list`
 
-Lists out all the routines in fitNUS.
+List out all the routines in fitNUS.
 
 Format: `routine list`
 
-### Add routine to schedule : `schedule add`
+### Timetable
+
+#### View timetable : `timetable view`
 
-Adds a complete routine into the application's schedule.
+View the user's timetable.
 
-Format: `schedule add r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING`
+Format: `timetable view`
 
 Examples:
-* `schedule add r/Leg Day Session d/Monday t/1600-1800` Adds routine "Leg Day Session" to schedule on Monday, 1600-1800.
+* `timetable view` Views timetable.
+
+#### Add routine to timetable : `timetable_add_routine`
+
+Add a complete routine into the application's schedule.
+
+Format: `timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING`
 
-### Delete routine from schedule : `schedule delete`
+Examples:
+* `timetable_add_routine r/Leg Workout d/Monday t/1600-1800` Adds routine "Leg Workout" to schedule on Monday, 1600-1800.
+
+![Timetable Add Routine](./images/timetable_add_routine.png)
+#### Delete routine or lesson from schedule : `timetable_delete`
 
-Deletes a routine from the application's schedule.
+Delete a routine or lesson from the application's schedule.
 
-Format: `schedule delete d/DAY_OF_THE_WEEK t/TIMING`
+Format: `timetable_delete d/DAY_OF_THE_WEEK t/TIMING`
 
 Examples:
-* `schedule delete d/Monday t/1600-1800` Deletes the routine scheduled on Monday, 1600-1800.
+* `timetable_delete d/Monday t/1600-1800` Deletes the routine or lesson scheduled on Monday, 1600-1800.
 
-### Add or edit height : `height`
+![Timetable Delete](./images/timetable_delete.png)
 
-Adds height in centimetres.
+###BMI
+#### Add or edit height : `height`
+
+Add height in centimetres.
 
 Format: `height h/HEIGHT`
 
 Examples:
 * `height h/170` Adds or edits the height of the user, which is 170cm.
 
-### Add or edit weight : `weight`
+![Add height](./images/height.png)
+#### Add or edit weight : `weight`
 
-Adds weight in kilograms.
+Add weight in kilograms.
 
 Format: `weight w/WEIGHT`
 
 Examples:
 * `weight w/70` Adds or edits the weight of the user, which is 70kg. 
 
-### View BMI : `bmi`
+![Add weight](./images/weight.png)
+
+#### View BMI : `bmi`
 
-Calculates and views the user's BMI based on his/her height and weight.
+Calculate and view the user's BMI based on his/her height and weight.
 
 Format: `bmi`
 
 Examples:
 * `bmi` Views BMI.
 
-### View timetable : `timetable view`
-
-View the user's timetable.
-
-Format: `timetable view`
-
-Examples:
-* `timetable view` Views timetable.
-
 ### Saving the data
 
 fitNUS data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
@@ -176,14 +194,14 @@ _{explain the feature here}_
 
 Action | Format, Examples
 --------|------------------
-**List commands** | `help`
-**Create routine** | `routine create r/ROUTINE_NAME` <br> e.g., `routine create r/Leg Day Session`
+**Link to User Guide** | `help`
+**Create routine** | `routine_create r/ROUTINE_NAME` <br> e.g., `routine_create r/Leg Day Session`
 **Delete routine** | `routine delete INDEX` <br> e.g., `routine delete 10`
-**Add exercise to routine** | `exercise add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`<br> e.g., `exercise add r/Leg Day Session e/Squats`
-**Delete exercise from routine** | `exercise delete r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`<br> e.g.,`exercise delete r/Leg Day Session e/Squats`
+**Add exercise to routine** | `routine_add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`<br> e.g., `routine_add r/Leg Day Session e/Squats`
+**Delete exercise from routine** | `routine_delete_exercise r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME`<br> e.g.,`routine_delete_exercise r/Leg Day Session e/Squats`
 **View routine details** | `routine view INDEX`<br> e.g., `routine view 2`
 **List routines** | `routine list`
-**Add routine to schedule** | `schedule add r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING` <br> e.g., `schedule add r/Leg Day Session d/Monday t/1600-1800`
-**Delete routine from schedule** | `schedule delete d/DAY_OF_THE_WEEK t/TIMING` <br> e.g., `schedule delete d/Monday t/1600-1800`
+**Add routine to schedule** | `timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK t/TIMING` <br> e.g., `timetable_add_routine add r/Leg Day Session d/Monday t/1600-1800`
+**Delete routine from schedule** | `timetable_delete d/DAY_OF_THE_WEEK t/TIMING` <br> e.g., `timetable_delete d/Monday t/1600-1800`
 **View timetable** | `timetable view`
 
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/exercise_add.png b/docs/images/exercise_add.png
diff --git a/docs/images/exercise_delete.png b/docs/images/exercise_delete.png
diff --git a/docs/images/find_exercises.png b/docs/images/find_exercises.png
diff --git a/docs/images/find_lessons.png b/docs/images/find_lessons.png
diff --git a/docs/images/height.png b/docs/images/height.png
diff --git a/docs/images/help.png b/docs/images/help.png
diff --git a/docs/images/lesson_add.png b/docs/images/lesson_add.png
diff --git a/docs/images/list_exercises.png b/docs/images/list_exercises.png
diff --git a/docs/images/list_lessons.png b/docs/images/list_lessons.png
diff --git a/docs/images/routine_add.png b/docs/images/routine_add.png
diff --git a/docs/images/routine_create.png b/docs/images/routine_create.png
diff --git a/docs/images/routine_delete.png b/docs/images/routine_delete.png
diff --git a/docs/images/routine_delete_exercise.png b/docs/images/routine_delete_exercise.png
diff --git a/docs/images/timetable_add_lesson.png b/docs/images/timetable_add_lesson.png
diff --git a/docs/images/timetable_add_routine.png b/docs/images/timetable_add_routine.png
diff --git a/docs/images/timetable_delete.png b/docs/images/timetable_delete.png
diff --git a/docs/images/weight.png b/docs/images/weight.png
diff --git a/src/main/java/seedu/address/ui/HelpWindow.java b/src/main/java/seedu/address/ui/HelpWindow.java
@@ -15,7 +15,7 @@
  */
 public class HelpWindow extends UiPart<Stage> {
 
-    public static final String USERGUIDE_URL = "https://se-education.org/addressbook-level3/UserGuide.html";
+    public static final String USERGUIDE_URL = "https://ay2021s1-cs2103t-t09-2.github.io/tp/UserGuide.html";
     public static final String HELP_MESSAGE = "Refer to the user guide: " + USERGUIDE_URL;
 
     private static final Logger logger = LogsCenter.getLogger(HelpWindow.class);

diff --git a/src/main/resources/view/DarkTheme.css b/src/main/resources/view/DarkTheme.css
@@ -327,7 +327,7 @@
 }
 
 #calories {
-    -fx-background-color: #000FFF;
+    -fx-background-color: #FFFFFF;
 }
 
 #sideBox {

diff --git a/src/main/resources/view/MainWindow.fxml b/src/main/resources/view/MainWindow.fxml
@@ -28,25 +28,25 @@
             <MenuItem fx:id="helpMenuItem" mnemonicParsing="false" onAction="#handleHelp" text="Help" />
           </Menu>
         </MenuBar>
-        <HBox prefHeight="200" prefWidth="250" id="timetable">
-
+        <HBox prefHeight="200" prefWidth="250" id="timetable" alignment="CENTER">
+          <Label text="Timetable" textAlignment="CENTER"/>
         </HBox>
 
         <HBox>
           <children>
-            <HBox prefHeight="200" prefWidth="610" id="calories">
-
+            <HBox prefHeight="200" prefWidth="610" id="calories" alignment="CENTER">
+              <Label text="Calories"/>
             </HBox>
             <VBox prefHeight="200" prefWidth="610">
-              <HBox prefHeight="100" prefWidth="610" id="sideBox">
-
+              <HBox prefHeight="100" prefWidth="610" id="sideBox" alignment="CENTER">
+                <Label text="${'There is no excuse for not trying.\n-Barack Obama'}"/>
               </HBox>
               <HBox prefHeight="100" prefWidth="610">
-                <VBox prefHeight="100" prefWidth="305" id="bmi">
-
+                <VBox prefHeight="100" prefWidth="305" id="bmi" alignment="CENTER">
+                  <Label wrapText="" text="${'HEIGHT: 170CM\nWEIGHT: 70KG\nBMI: 24.2'}"/>
                 </VBox>
-                <VBox prefHeight="100" prefWidth="305" id = "logo" >
-
+                <VBox prefHeight="100" prefWidth="305" id = "logo" alignment="CENTER">
+                  <Label text="Logo"/>
                 </VBox>
               </HBox>
             </VBox>