From 02578f23981f748077b588920ff41480cad88872 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 20:55:56 +0800 Subject: [PATCH 01/18] Remove all manual page --- docs/UserGuide.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 11a2483f2d7..7b346b1469e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -23,6 +23,7 @@ You can click on any of the links below to navigate to the respective sections f # Table of Contents + * [1 Quick start](#1-quick-start) * [1.1 Prerequisites](#11-prerequisites) * [1.1.1 Java](#111-java) @@ -81,12 +82,11 @@ You can click on any of the links below to navigate to the respective sections f * [6 Summary](#6-summary) * [6.1 Prefix Summary](#61-prefix-summary) * [6.2 Command Summary](#62-command-summary) + -------------------------------------------------------------------------------------------------------------------- -
- # 1 Quick start ## 1.1 Prerequisites @@ -345,8 +345,6 @@ Menu Item Card consists of the following components: -------------------------------------------------------------------------------------------------------------------- -
- # 2 Commands
@@ -383,7 +381,7 @@ Menu Item Card consists of the following components:
-
+
@@ -417,7 +415,7 @@ Duplicate data are not allowed. Hence, adding of duplicate data or editing of an with another existing data in the data list will not be successful. Here's how we check for duplicates: | Any two | are considered to be duplicates if | -| ---------- | --------------------------------------------------------------------------- | +|------------|-----------------------------------------------------------------------------| | Suppliers | they have the same phone numbers | | Orders | all the parameters (excluding `STATUS`) are the same (with matching cases). | | Tasks | they have the same task names (case-insensitive) and deadlines. | @@ -466,7 +464,7 @@ Adds an order into the list of orders. Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOMER_ADDRESS p/CUSTOMER_PHONE_NUMBER [s/STATUS]` -
+
@@ -858,22 +856,23 @@ Syntax: `find_order [on/ORDER_ITEM] [q/QUANTITY] [d/DEADLINE] [n/CUSTOMER_NAME] * e.g. `find_o s/D` will return orders marked as `Delivered`.
* For `CUSTOMER_NAME` and `CUSTOMER_ADDRESS`: -<<<<<<< HEAD + <<<<<<< HEAD * Search is case-insensitive for `CUSTOMER_NAME` but case-sensitive for `CUSTOMER_ADDRESS` - (e.g. The search for orders with customer address `smith` will match with `smith` but not with `Smith`). -======= + (e.g. The search for orders with customer address `smith` will match with `smith` but not with `Smith`). + ======= * Search is case-insensitive (e.g. The search for orders with customer name `amy` will match with `Amy` and with `amy`). ->>>>>>> master - * Order of the keywords matter (e.g. `Amy Lee` will not match with `Lee Amy`). - * Only full words will match. - * Order's respective parameter must fully match with the given parameter.
- (e.g. `Amy Lee` will only match with `Amy Lee` and not with `Amy Lee Tan`). -<<<<<<< HEAD +> > > > > > > master +* Order of the keywords matter (e.g. `Amy Lee` will not match with `Lee Amy`). +* Only full words will match. +* Order's respective parameter must fully match with the given parameter.
+ (e.g. `Amy Lee` will only match with `Amy Lee` and not with `Amy Lee Tan`). + +<<<<<<< HEAD ======= ->>>>>>> master +> > > > > > > master
@@ -1626,7 +1625,7 @@ Here are the respective formats for each of the data types: # 6.1 Prefix Summary | Parameter | Prefix | Rules | -| ------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|--------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Name (Task, Supplier, Customer, Menu Item) | n/ | - Should only contains alphanumeric characters and spaces | | Phone Number (Supplier, Customer) | p/ | - Should only contain digits
- Should have least 3 digits | | Email | e/ | - Should only be of the form `local@domain` and only accept alphanumeric characters
- `local` allows for special characters `+`, `_`, `.` and `-` as well.
- `domain` must be at least 2 letters long.
- `.com` is not required. | @@ -1644,7 +1643,7 @@ Here are the respective formats for each of the data types: ## 6.2 Command Summary | Action | Format, Examples | -| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Add** | `add_supplier` / `add_s`
e.g., `add_s n/Betsy Cow t/diary e/betsycow@example.com a/Betsy Street p/12345678 t/meat`

`add_order` / `add_o`
e.g., `add_o n/John Doe l/John Street d/12/12/2023 q/10 on/Cupcakes`

`add_task` / `add_t`
e.g., `add_t d/Buy a card d/23/12/2024 s/D`

`add_item` / `add_i`
e.g., `add_i n/Chocolate Cake pr/30 c/10` | | **Edit** | `edit_supplier` / `edit_s`
e.g., `edit_s 3 t/Supplies Flour e/mark@example.com`

`edit_order` / `edit_o`
e.g., `edit_o 3 q/20`

`edit_task` / `edit_t`
e.g., `edit_t 1 s/D`

`edit_item` / `edit_i`
e.g., `edit_i n/Chocolate Chip Cookie` | | **Delete** | `delete_supplier` / `delete_s`
e.g., `delete_s 2`

`delete_order` / `delete_o`
e.g., `delete_o 1`

`delete_task` / `delete_t`
e.g., `delete_t 4`

`delete_item` / `delete_i`
e.g., `delete_i 2` | From a63d151f773ecaab3594bab0cd1880c8e511bdec Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 20:59:57 +0800 Subject: [PATCH 02/18] Add manual page break --- docs/UserGuide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7b346b1469e..7c27d2de6c4 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -117,6 +117,8 @@ An example is shown below.
+
+ ### 1.1.2 Glossary * **Mainstream OS**: Windows, Linux, Mac @@ -373,6 +375,14 @@ Menu Item Card consists of the following components: * Parameters can be in any order.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +
+ +
+ +
+ +:information_source: **Notes about the command format:** + * If a parameter is expected only once in the command, but you specified it multiple times, only the **last** occurrence of the parameter will be taken.
e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. From e39a0b43a2e87220ee0f1d420ebf9e590e6693ad Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:01:45 +0800 Subject: [PATCH 03/18] Add manual page break --- docs/UserGuide.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7c27d2de6c4..0ffc9fe1475 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -347,6 +347,8 @@ Menu Item Card consists of the following components: -------------------------------------------------------------------------------------------------------------------- +
+ # 2 Commands
@@ -375,14 +377,6 @@ Menu Item Card consists of the following components: * Parameters can be in any order.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. -
- -
- -
- -:information_source: **Notes about the command format:** - * If a parameter is expected only once in the command, but you specified it multiple times, only the **last** occurrence of the parameter will be taken.
e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. From 3edf0bf14987c42a56faf9e24879943986465c14 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:01:57 +0800 Subject: [PATCH 04/18] Add manual page break --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0ffc9fe1475..57385720bfa 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -385,7 +385,7 @@ Menu Item Card consists of the following components:
- +
From 7d1d577b441c22aec780471da30afddf700b5aec Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:05:31 +0800 Subject: [PATCH 05/18] Add manual page break --- docs/UserGuide.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 57385720bfa..a8fa4981b88 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -429,9 +429,13 @@ with another existing data in the data list will not be successful. Here's how w Adding of an information to the specific list. Below are the specific add commands for supplier, order, task and menu item. -:pencil2: Note
+
+ +:pencil2: **Note**
Adding of duplicate data is not allowed. Refer to this [table](#20-checking-for-duplicates) to see how duplicates are checked for. +
+ ### 2.1.1 Adding a supplier: `add_supplier` Adds a supplier to the list of suppliers. @@ -468,7 +472,7 @@ Adds an order into the list of orders. Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOMER_ADDRESS p/CUSTOMER_PHONE_NUMBER [s/STATUS]` - +
From b3ea6afa823ad7153dbe437512fe13a24c6d1e5e Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:13:14 +0800 Subject: [PATCH 06/18] Add manual page break --- docs/UserGuide.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a8fa4981b88..e36c2378afe 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -555,6 +555,8 @@ Syntax: `add_task n/TASK_NAME d/DEADLINE [s/STATUS]`
+
+ ### 2.1.4 Adding a menu item: `add_item` Adds a menu item to the menu. @@ -643,6 +645,8 @@ Syntax: `edit_supplier INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…
+
+
:clipboard: **Example 1: Standard command removing tags** @@ -683,6 +687,8 @@ Syntax: `edit_order INDEX [on/ORDER_ITEM] [q/QUANTITY] [d/DEADLINE] [n/CUSTOMER_
+
+
:clipboard: **Example 1: Standard command** @@ -803,6 +809,8 @@ Syntax: `find_supplier NAME`
+
+
:clipboard: **Example 1: Standard command** @@ -842,6 +850,8 @@ Find orders whose information matches with any of the given parameters. Syntax: `find_order [on/ORDER_ITEM] [q/QUANTITY] [d/DEADLINE] [n/CUSTOMER_NAME] [a/CUSTOMER_ADDRESS] [p/CUSTOMER_PHONE_NUMBER] [s/STATUS]` +
+
:information_source: **Information** @@ -864,23 +874,14 @@ Syntax: `find_order [on/ORDER_ITEM] [q/QUANTITY] [d/DEADLINE] [n/CUSTOMER_NAME] * e.g. `find_o s/D` will return orders marked as `Delivered`.
* For `CUSTOMER_NAME` and `CUSTOMER_ADDRESS`: - <<<<<<< HEAD * Search is case-insensitive for `CUSTOMER_NAME` but case-sensitive for `CUSTOMER_ADDRESS` (e.g. The search for orders with customer address `smith` will match with `smith` but not with `Smith`). - ======= - * Search is case-insensitive (e.g. The search for orders with customer name `amy` will match with `Amy` and with `amy`). - -> > > > > > > master * Order of the keywords matter (e.g. `Amy Lee` will not match with `Lee Amy`). * Only full words will match. * Order's respective parameter must fully match with the given parameter.
(e.g. `Amy Lee` will only match with `Amy Lee` and not with `Amy Lee Tan`). -<<<<<<< HEAD - -======= -> > > > > > > master
From 11ac8c1823b46cffa58aeee93d592889c1c8af63 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:18:08 +0800 Subject: [PATCH 07/18] Add manual page break --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 42ad6ffea2f..dd8c18dc54a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -809,8 +809,6 @@ Syntax: `find_supplier NAME`
-
-
:clipboard: **Example 1: Standard command** @@ -828,6 +826,8 @@ Syntax: `find_supplier NAME` * `Prim` * `PrimaFlour` +
+ :clipboard: **Example 2: Shortcut command** * `find_s Pte`
From ea5a8df68e4ed71d8c1648bb19df4f51aee6a6d7 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:20:47 +0800 Subject: [PATCH 08/18] Add manual page break --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index dd8c18dc54a..42ad6ffea2f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -809,6 +809,8 @@ Syntax: `find_supplier NAME`
+
+
:clipboard: **Example 1: Standard command** @@ -826,8 +828,6 @@ Syntax: `find_supplier NAME` * `Prim` * `PrimaFlour` -
- :clipboard: **Example 2: Shortcut command** * `find_s Pte`
From 8891a11f49439aba4dfc9847890af41dcf9c5b5c Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:24:37 +0800 Subject: [PATCH 09/18] Add manual page break --- docs/UserGuide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 42ad6ffea2f..b956086013a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -883,6 +883,8 @@ Syntax: `find_order [on/ORDER_ITEM] [q/QUANTITY] [d/DEADLINE] [n/CUSTOMER_NAME]
+
+
:clipboard: **Example 1: Standard command with single fields** @@ -923,6 +925,8 @@ Finds tasks with information that matches with any of the given parameters. Syntax: `find_task [n/TASK_NAME] [d/DEADLINE] [s/STATUS]` +
+
:information_source: **Information** @@ -1017,6 +1021,8 @@ Syntax: `find_item ITEM_NAME`

+
+ ## 2.4 Delete Deleting of an information to the specific list. Below are the specific delete commands for supplier, order, task and menu item. @@ -1133,6 +1139,8 @@ Deleting a menu item does not invalidate the orders with the same order item nam

+
+ ## 2.5 Sort Sorting of information in the specific list. Below are the specific sort commands for task and order. From 917e04febbb6c4e9f5b441480475e73f05acf103 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:27:41 +0800 Subject: [PATCH 10/18] Add manual page break --- docs/UserGuide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b956086013a..46062dae14d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1068,6 +1068,8 @@ Syntax: `delete_supplier INDEX`
+
+ ### 2.4.2 Deleting an order: `delete_order` Deletes the specified order from the order list. @@ -1177,6 +1179,8 @@ Sorts tasks according to the criteria specified. Syntax: `sort_task [c/CRITERIA]` +
+
:information_source: **Information** @@ -1219,6 +1223,8 @@ Sorts orders according to the criteria specified. Syntax: `sort_order [c/CRITERIA]` +
+
:information_source: **Information** @@ -1258,6 +1264,8 @@ Syntax: `sort_order [c/CRITERIA]`

+
+ ## 2.6 List Shows all data in the specific list. Below are the specific list commands for suppliers, order, tasks and menu. From b9a813a2a58d878b4f4c87e53563a35017907631 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:31:39 +0800 Subject: [PATCH 11/18] Add manual page break --- docs/UserGuide.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 46062dae14d..53cbf1016ce 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -973,6 +973,8 @@ Syntax: `find_task [n/TASK_NAME] [d/DEADLINE] [s/STATUS]`
+
+ ### 2.3.4 Finding a menu item: `find_item` Find tasks with information that matches with any of the given parameters. @@ -1112,6 +1114,8 @@ Syntax: `delete_task INDEX`
+
+ ### 2.4.4 Deleting a menu item: `delete_item` Deletes the specified menu item from the menu. @@ -1348,7 +1352,7 @@ Syntax: `list_menu` * `list_m price`
Shows all menu items. -
+ ## 2.7 Clear @@ -1452,6 +1456,8 @@ Clearing all menu items does not invalidate the orders.
+
+ ## 2.8 Switch Allows for you to switch to the tab for view your respective information. You can use the GUI to navigate it as shown [here](#14-navigating-the-user-interface) or use the command shown here. @@ -1620,6 +1626,8 @@ Here are the respective formats for each of the data types: } ``` +
+ # 4 Upcoming features `[coming soon]` * Highlight overdue orders. @@ -1644,6 +1652,8 @@ Here are the respective formats for each of the data types: -------------------------------------------------------------------------------------------------------------------- +
+ # 6 Summary # 6.1 Prefix Summary From e9901c668c54e329796ea34d58415caca43e7b7f Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:34:48 +0800 Subject: [PATCH 12/18] Add manual page break --- docs/UserGuide.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 53cbf1016ce..73e3bd61e88 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -411,7 +411,7 @@ Menu Item Card consists of the following components: * You can find out the constraints for the parameters with their corresponding prefix [here](#61-prefix-summary). -
+ ## 2.0 Checking for duplicates @@ -601,7 +601,7 @@ Syntax: `add_item n/ITEM_NAME pr/PRICE c/COST` * Price: `20.55` * Cost: `25.2` -
+ ## 2.2 Edit @@ -785,7 +785,7 @@ Syntax: `edit_item INDEX [n/ITEM_NAME] [pr/PRICE] [c/COST]` * Price: `8.5` * Cost: `2.25` -
+ ## 2.3 Find @@ -1021,7 +1021,7 @@ Syntax: `find_item ITEM_NAME` :x: Example of order item that do not match: * `Vanilla Cupcake` -
+
@@ -1143,7 +1143,7 @@ Deleting a menu item does not invalidate the orders with the same order item nam * `find_item cupcake` lists all menu items with item names containing `cupcake` * `delete_m 1` deletes the **first** menu item with an item name that contains `cupcake` from the visible menu -
+
@@ -1266,7 +1266,7 @@ Syntax: `sort_order [c/CRITERIA]` * `find_order s/N` lists all orders with status as `Not Delievered` * `sort_o c/Name` sorts all `Not Delivered` orders found according to their `Name` -
+
@@ -1354,6 +1354,8 @@ Syntax: `list_menu` +
+ ## 2.7 Clear Clears all data in the specific list. Below are the specific clear commands for suppliers, order, tasks and menu. @@ -1454,7 +1456,7 @@ Clearing all menu items does not invalidate the orders. * `clear_m price`
Clears all menu item data from menu. -
+
@@ -1484,7 +1486,7 @@ Syntax: `tab t/TAB` * `tab t/HOME`
Navigates you to the home tab -
+ ## 2.9 Others From bd355b74cbf811b9501278a0a6e8abbcee559946 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:40:02 +0800 Subject: [PATCH 13/18] Add manual page break --- docs/UserGuide.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 73e3bd61e88..b5ba226c70e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -425,6 +425,8 @@ with another existing data in the data list will not be successful. Here's how w | Tasks | they have the same task names (case-insensitive) and deadlines. | | Menu items | they have the same item names (with matching cases). | +
+ ## 2.1 Add Adding of an information to the specific list. Below are the specific add commands for supplier, order, task and menu item. @@ -472,8 +474,6 @@ Adds an order into the list of orders. Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOMER_ADDRESS p/CUSTOMER_PHONE_NUMBER [s/STATUS]` -
-
:information_source: **Information** @@ -518,6 +518,8 @@ Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOME
+
+ ### 2.1.3 Adding a task: `add_task` Adds a task to the list of tasks. @@ -1396,6 +1398,8 @@ Clears all order entries from the order list. Syntax: `clear_order` +
+
:clipboard: **Example 1: Standard command** @@ -1528,6 +1532,8 @@ Note: For any **optional** fields, you can indicate it with a `-` to have it be
Figure 2.9.2.1: Example of a valid csv file

+
+ ### 2.9.3 Exiting the program: `exit` Exits the program. @@ -1568,6 +1574,8 @@ If your changes to the data file are invalid, Trackr will discard all data and s
+
+ Here is the layout of the data file: ```json From d2ba6cc393325bc400b3a8fa13e21b5846fbb51a Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:42:47 +0800 Subject: [PATCH 14/18] Add manual page break --- docs/UserGuide.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b5ba226c70e..75208c7d704 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -490,6 +490,8 @@ Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOME +
+
:clipboard: **Example 1: Standard command without status** @@ -1448,6 +1450,8 @@ Clearing all menu items does not invalidate the orders.
+
+
:clipboard: **Example 1: Standard command** @@ -1636,8 +1640,6 @@ Here are the respective formats for each of the data types: } ``` -
- # 4 Upcoming features `[coming soon]` * Highlight overdue orders. From 5c6d5d7957e4a34b98acb5650e4be31bc7e13343 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:47:28 +0800 Subject: [PATCH 15/18] Add manual page break --- docs/UserGuide.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 75208c7d704..dbb11022f86 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1466,8 +1466,6 @@ Clearing all menu items does not invalidate the orders.
-
- ## 2.8 Switch Allows for you to switch to the tab for view your respective information. You can use the GUI to navigate it as shown [here](#14-navigating-the-user-interface) or use the command shown here. @@ -1496,6 +1494,8 @@ Syntax: `tab t/TAB` +
+ ## 2.9 Others Here are other functionalities and commands that are available for you to utilise. @@ -1536,8 +1536,6 @@ Note: For any **optional** fields, you can indicate it with a `-` to have it be
Figure 2.9.2.1: Example of a valid csv file

-
- ### 2.9.3 Exiting the program: `exit` Exits the program. @@ -1552,6 +1550,8 @@ This section will inform you how the data is saved. All data are saved after any command is executed successfully. There is no need for you to manually save. +
+ ## 3.2 Editing the data file Trackr data are saved as a JSON file at `[JAR file location]/data/trackr.json`. @@ -1578,8 +1578,6 @@ If your changes to the data file are invalid, Trackr will discard all data and s -
- Here is the layout of the data file: ```json @@ -1603,6 +1601,9 @@ Here are the respective formats for each of the data types: "tagged" : [ "flour" ] } ``` + +
+ * Task
```json { From 7b61d4089e42a22154b72907e3956e60aa762333 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 21:53:22 +0800 Subject: [PATCH 16/18] Add manual page break --- docs/UserGuide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 202d53473b2..16c65706727 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -472,8 +472,6 @@ Adds an order into the list of orders. Syntax: `add_order on/ORDER_ITEM q/QUANTITY d/DEADLINE n/CUSTOMER_NAME a/CUSTOMER_ADDRESS p/CUSTOMER_PHONE_NUMBER [s/STATUS]` -
-
:information_source: **Information** From bd7bd63ae9293c6df4e405adcd89b5e159c49333 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:42:15 +0800 Subject: [PATCH 17/18] Fix tag --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 16c65706727..25d415f0cc3 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -661,7 +661,7 @@ Syntax: `edit_supplier INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… :clipboard: **Example 2: Shortcut command replacing tags** -* `edit_s 3 t/Supplies Flour e/mark@example.com`
+* `edit_s 3 t/flour e/mark@example.com`
Edits the **third** supplier information (shown on screen) with the following details: * Email: `mark@example.com` * Tags: `Supplies Flour` @@ -1675,7 +1675,7 @@ Here are the respective formats for each of the data types: | Phone Number (Supplier, Customer) | p/ | - Should only contain digits
- Should have least 3 digits | | Email | e/ | - Should only be of the form `local@domain` and only accept alphanumeric characters
- `local` allows for special characters `+`, `_`, `.` and `-` as well.
- `domain` must be at least 2 letters long.
- `.com` is not required. | | Address (Supplier, Customer) | a/ | - Can contain any letters | -| Tag | t/ | - Should only contain alphanumeric characters | +| Tag | t/ | - Should only contain alphanumeric characters
- Should not contain spaces | | Deadline (Task, Order) | d/ | - Should be of the format `dd/MM/yyyy` - Dates that have passed are allowed | | Status (Task, Order) | s/ | - Should only contain alphanumeric characters | | Order Name | on/ | - Should only contain alphanumeric characters
- Order name should be a valid menu item name | @@ -1690,7 +1690,7 @@ Here are the respective formats for each of the data types: | Action | Format, Examples | |------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Add** | `add_supplier` / `add_s`
e.g., `add_s n/Betsy Cow t/diary e/betsycow@example.com a/Betsy Street p/12345678 t/meat`

`add_order` / `add_o`
e.g., `add_o n/John Doe l/John Street d/12/12/2023 q/10 on/Cupcakes`

`add_task` / `add_t`
e.g., `add_t d/Buy a card d/23/12/2024 s/D`

`add_item` / `add_i`
e.g., `add_i n/Chocolate Cake pr/30 c/10` | -| **Edit** | `edit_supplier` / `edit_s`
e.g., `edit_s 3 t/Supplies Flour e/mark@example.com`

`edit_order` / `edit_o`
e.g., `edit_o 3 q/20`

`edit_task` / `edit_t`
e.g., `edit_t 1 s/D`

`edit_item` / `edit_i`
e.g., `edit_i n/Chocolate Chip Cookie` | +| **Edit** | `edit_supplier` / `edit_s`
e.g., `edit_s 3 t/flour e/mark@example.com`

`edit_order` / `edit_o`
e.g., `edit_o 3 q/20`

`edit_task` / `edit_t`
e.g., `edit_t 1 s/D`

`edit_item` / `edit_i`
e.g., `edit_i n/Chocolate Chip Cookie` | | **Delete** | `delete_supplier` / `delete_s`
e.g., `delete_s 2`

`delete_order` / `delete_o`
e.g., `delete_o 1`

`delete_task` / `delete_t`
e.g., `delete_t 4`

`delete_item` / `delete_i`
e.g., `delete_i 2` | | **Find** | `find_supplier` / `find_s`
e.g., `find_s Pte`

`find_order` / `find_o`
e.g., `find_order on/Chocolate`

`find_task` / `find_t`
e.g., `find_t s/N`

`find_item` / `find_i`
e.g., `find_i Chocolate` | | **Sort** | `sort_task` / `sort_t`
e.g., `sort_t c/Deadline`

`sort_order` / `sort_o`
e.g., `sort_order c/Deadline` | From 260974d4582926b74c574f2cef745d5f8f6f831f Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:43:32 +0800 Subject: [PATCH 18/18] Fix p/ to pr/ --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 25d415f0cc3..cc38f1d9022 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -781,7 +781,7 @@ Syntax: `edit_item INDEX [n/ITEM_NAME] [pr/PRICE] [c/COST]` :clipboard: **Example 2: Shortcut command with decimal values** -* `edit_i 3 d/Signature burger p/8.5 c/2.25`
+* `edit_i 3 d/Signature burger pr/8.5 c/2.25`
Edits the **third** menu item information with the following details: * Item Name: `Signature burger` * Price: `8.5`