From 74c2275effd3abe343e5e0d9f9d704fa76c80d65 Mon Sep 17 00:00:00 2001 From: nuyer <98694104+nuyer@users.noreply.github.com> Date: Mon, 15 Apr 2024 23:48:20 +0800 Subject: [PATCH 1/5] Add page break --- docs/UserGuide.md | 132 +++++++++++++++++++--------------------------- 1 file changed, 53 insertions(+), 79 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 5a2ba79eb6..b6f4d03a7c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -21,27 +21,28 @@ If you relate to this problem we identified, then NetConnect might be just right - [Quick start](#quick-start) - [Features](#features) - [Data Constraints](#data-constraints) - - [Viewing help : `help`](#viewing-help-help) + - [Viewing help : `help`](#viewing-help--help) - [Adding a person: `add`](#adding-a-person-add) - - [Deleting a person : `delete`](#deleting-a-person-delete) - - [Listing all contacts : `list`](#listing-all-contacts-list) - - [Editing a person : `edit`](#editing-a-person-edit) - - [Locating Contacts : `find`](#locating-contacts-find) - - [Clearing all entries : `clear`](#clearing-all-entries-clear) - - [Create Relations between Profiles : `relate`](#create-relations-between-profiles-relate) - - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles-unrelate) - - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person-showrelated) + - [Deleting a person : `delete`](#deleting-a-person--delete) + - [Listing all contacts : `list`](#listing-all-contacts--list) + - [Editing a person : `edit`](#editing-a-person--edit) + - [Locating Contacts : `find`](#locating-contacts--find) + - [Clearing all entries : `clear`](#clearing-all-entries--clear) + - [Create Relations between Profiles : `relate`](#create-relations-between-profiles--relate) + - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles--unrelate) + - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person--showrelated) - [Open on Last State](#open-on-last-state) - - [Export view to CSV File : `export`](#export-view-to-csv-file-export) - - [Exiting the program : `exit`](#exiting-the-program-exit) + - [Export view to CSV File : `export`](#export-view-to-csv-file--export) + - [Exiting the program : `exit`](#exiting-the-program--exit) - [Saving the data](#saving-the-data) - [Editing the data file](#editing-the-data-file) -- [Future Implementations](#future-implementations) - - [Truncate text in GUI](#truncate-text-in-gui) +- [Planned Enhancements](#planned-enhancements) - [FAQ](#faq) - [Known issues](#known-issues) - [Command summary](#command-summary) +
+ # Quick start 1. Ensure you have Java `11` or above installed in your Computer. @@ -61,6 +62,7 @@ If you relate to this problem we identified, then NetConnect might be just right 1. Refer to the [Features](#features) below for details of each command. -------------------------------------------------------------------------------------------------------------------- +
# Features @@ -86,6 +88,8 @@ If you relate to this problem we identified, then NetConnect might be just right * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. +
+ ## Data Constraints **Constraints:** @@ -105,7 +109,7 @@ Here are the constraints for each field in the application: * `TERMS OF SERVICE`: Terms of service can take any format. * `PRODUCTS`: Product names should only contain alphanumeric characters and spaces. -

+
## Viewing help : `help` @@ -115,10 +119,8 @@ Format: `help` ![help message](images/helpMessage.png) -
- -
+
## Adding a person: `add` @@ -145,10 +147,8 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [r/remark] [t/TAG Info: NetConnect checks for unique profiles by its NAME, PHONE NUMBER and EMAIL. It does not allow you to create two profiles with identical name, phone number and email. - -
-
+
## Deleting a person : `delete` @@ -173,9 +173,7 @@ Examples: ![Delete Warning](images/deletewarning.png)
-
- -
+
## Listing all contacts : `list` @@ -184,9 +182,7 @@ Shows a list of all contacts in the address book. Format: `list` ![list](images/list.png) -
- -
+
## Editing a person : `edit` @@ -208,9 +204,7 @@ Examples: ![EditResultExample](images/editExample.png) * `edit i/2 n/Betsy Crower t/` Edits the name of the person with ID of 2 to be `Betsy Crower` and clears all existing tags. -
- -

+
## Locating Contacts : `find` @@ -255,9 +249,7 @@ Stacking find by role and tag example ![result for 'find employee friends'](images/stackEmployeeFriends.png) -
- -
+
## Clearing all entries : `clear` @@ -272,10 +264,7 @@ Format: `clear` ![result for 'clear warning'](images/ClearWarning.png) - -

- -
+
## Create Relations between Profiles : `relate` @@ -287,9 +276,7 @@ Example: `relate i/1 i/3` creates a relation between the profiles with ID of 1 a ![result for 'relate result'](images/relateResult.png) -
- -
+
## Remove Relations between Profiles : `unrelate` @@ -301,10 +288,7 @@ Example: `unrelate i/1 i/23` removes a relation between the profiles with ID of ![result for 'unrelate result'](images/unrelateResult.png) - -
- -
+
## Show Relations Associated to a Person : `showrelated` @@ -320,17 +304,12 @@ Example: `showrelated i/1` shows all relations between the profile with ID 1 and ![result for 'showrelated result'](images/showrelatedResult.png) -
- -
+
## Open on Last State With every change to the command input, NetConnect saves and updates the command input in a separate file. When the app closes and is opened again, the last command present before closure will be retrieved from the separate file and input into the command field (if any). This way, you never have to worry about losing progress! -
- - -
+
## Export view to CSV File : `export` Retrieve information on a group of profiles at once with this function! This can be useful for consolidating all the emails or contact number at once, or to share information with third parties. @@ -371,9 +350,7 @@ Step 2: `export client.csv` The CSV file named clients.csv containing all client contacts is exported to a folder on your laptop located within the same directory as the NetConnect application. ![result for 'CSV file'](images/csvfile.png) -
- -
+
## Exiting the program : `exit` @@ -381,20 +358,12 @@ Exits the program. Format: `exit` -
- - -
+
## Saving the data NetConnect data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. -
- - -
- ## Editing the data file NetConnect data are saved automatically as a JSON file `[JAR file location]/data/netconnect.json`. Advanced users are welcome to update data directly by editing that data file. @@ -402,9 +371,10 @@ NetConnect data are saved automatically as a JSON file `[JAR file location]/data **Caution:** If your changes to the data file makes its format invalid, NetConnect will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the NetConnect to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. -
-------------------------------------------------------------------------------------------------------------------- +
+ # Planned Enhancements The NetConnect team is working on new features and fixes for you, but they are unfortunately unavailable in this current implementation. We intend to have future fixes for these occurences below! @@ -419,6 +389,8 @@ Further details on the planned enhancements can be found in the Developer Guide. -------------------------------------------------------------------------------------------------------------------- +
+ # FAQ **Q**: How do I transfer my data to another Computer?
@@ -444,20 +416,22 @@ Further details on the planned enhancements can be found in the Developer Guide. -------------------------------------------------------------------------------------------------------------------- +
+ # Command summary -| Action | Format | Examples | -|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | -| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [t/TAG] [dept/DEPARTMENT] [job/JOB] [skills/SKILL1] [skills/SKILL2] ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` | -| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [t/TAG] [pref/PREFERENCES] [prod/PRODUCT 1] [prod/PRODUCT 2]` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | -| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [t/TAG] [tos/TERMS OF SERVICE] [prod/PRODUCT 1] [prod/PRODUCT 2]` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | -| **List** | `list` | `list` | -| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | -| **Edit** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | -| **Find** | `find [n/NAME] [t/TAG] [p/PHONE] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | -| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | -| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | -| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | -| **Export** | `export [filename]` | `export ClientInfo.csv` | -| **Clear** | `clear` | `clear` | -| **Exit** | `exit` | `exit` | +| Action | Format | Examples | +|--------------------------|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | +| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [t/TAG] [dept/DEPARTMENT] [job/JOB] [skills/SKILL]... ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` | +| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [t/TAG] [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | +| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [t/TAG] [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | +| **List** | `list` | `list` | +| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | +| **Edit** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | +| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | +| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | +| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | +| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | +| **Export** | `export [filename]` | `export ClientInfo.csv` | +| **Clear** | `clear` | `clear` | +| **Exit** | `exit` | `exit` | From e7dfddc05b0a9d70f30962c445e5bf49aef1bae6 Mon Sep 17 00:00:00 2001 From: Puri Virakarin <110763159+purivirakarin@users.noreply.github.com> Date: Mon, 15 Apr 2024 22:51:10 +0700 Subject: [PATCH 2/5] Update UserGuide.md --- docs/UserGuide.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b6f4d03a7c..770e599d85 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -21,19 +21,19 @@ If you relate to this problem we identified, then NetConnect might be just right - [Quick start](#quick-start) - [Features](#features) - [Data Constraints](#data-constraints) - - [Viewing help : `help`](#viewing-help--help) + - [Viewing help : `help`](#viewing-help-help) - [Adding a person: `add`](#adding-a-person-add) - - [Deleting a person : `delete`](#deleting-a-person--delete) - - [Listing all contacts : `list`](#listing-all-contacts--list) - - [Editing a person : `edit`](#editing-a-person--edit) - - [Locating Contacts : `find`](#locating-contacts--find) - - [Clearing all entries : `clear`](#clearing-all-entries--clear) - - [Create Relations between Profiles : `relate`](#create-relations-between-profiles--relate) - - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles--unrelate) - - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person--showrelated) + - [Deleting a person : `delete`](#deleting-a-person-delete) + - [Listing all contacts : `list`](#listing-all-contacts-list) + - [Editing a person : `edit`](#editing-a-person-edit) + - [Locating Contacts : `find`](#locating-contacts-find) + - [Clearing all entries : `clear`](#clearing-all-entries-clear) + - [Create Relations between Profiles : `relate`](#create-relations-between-profiles-relate) + - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles-unrelate) + - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person-showrelated) - [Open on Last State](#open-on-last-state) - - [Export view to CSV File : `export`](#export-view-to-csv-file--export) - - [Exiting the program : `exit`](#exiting-the-program--exit) + - [Export view to CSV File : `export`](#export-view-to-csv-file-export) + - [Exiting the program : `exit`](#exiting-the-program-exit) - [Saving the data](#saving-the-data) - [Editing the data file](#editing-the-data-file) - [Planned Enhancements](#planned-enhancements) From 9777699cddccb81d9628d0ba3b3bb6cdf10967c7 Mon Sep 17 00:00:00 2001 From: nuyer <98694104+nuyer@users.noreply.github.com> Date: Mon, 15 Apr 2024 23:53:09 +0800 Subject: [PATCH 3/5] Update command summary table --- docs/UserGuide.md | 54 +++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b6f4d03a7c..657cdecc26 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -21,19 +21,19 @@ If you relate to this problem we identified, then NetConnect might be just right - [Quick start](#quick-start) - [Features](#features) - [Data Constraints](#data-constraints) - - [Viewing help : `help`](#viewing-help--help) + - [Viewing help : `help`](#viewing-help-help) - [Adding a person: `add`](#adding-a-person-add) - - [Deleting a person : `delete`](#deleting-a-person--delete) - - [Listing all contacts : `list`](#listing-all-contacts--list) - - [Editing a person : `edit`](#editing-a-person--edit) - - [Locating Contacts : `find`](#locating-contacts--find) - - [Clearing all entries : `clear`](#clearing-all-entries--clear) - - [Create Relations between Profiles : `relate`](#create-relations-between-profiles--relate) - - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles--unrelate) - - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person--showrelated) + - [Deleting a person : `delete`](#deleting-a-person-delete) + - [Listing all contacts : `list`](#listing-all-contacts-list) + - [Editing a person : `edit`](#editing-a-person-edit) + - [Locating Contacts : `find`](#locating-contacts-find) + - [Clearing all entries : `clear`](#clearing-all-entries-clear) + - [Create Relations between Profiles : `relate`](#create-relations-between-profiles-relate) + - [Remove Relations between Profiles : `unrelate`](#remove-relations-between-profiles-unrelate) + - [Show Relations Associated to a Person : `showrelated`](#show-relations-associated-to-a-person-showrelated) - [Open on Last State](#open-on-last-state) - - [Export view to CSV File : `export`](#export-view-to-csv-file--export) - - [Exiting the program : `exit`](#exiting-the-program--exit) + - [Export view to CSV File : `export`](#export-view-to-csv-file-export) + - [Exiting the program : `exit`](#exiting-the-program-exit) - [Saving the data](#saving-the-data) - [Editing the data file](#editing-the-data-file) - [Planned Enhancements](#planned-enhancements) @@ -419,19 +419,19 @@ Further details on the planned enhancements can be found in the Developer Guide.
# Command summary -| Action | Format | Examples | -|--------------------------|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | -| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [t/TAG] [dept/DEPARTMENT] [job/JOB] [skills/SKILL]... ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` | -| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [t/TAG] [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | -| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [t/TAG] [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | -| **List** | `list` | `list` | -| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | -| **Edit** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/ROLE [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | -| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | -| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | -| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | -| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | -| **Export** | `export [filename]` | `export ClientInfo.csv` | -| **Clear** | `clear` | `clear` | -| **Exit** | `exit` | `exit` | +| Action | Format | Examples | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | +| **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [r/REMARK] [t/TAG]... [dept/DEPARTMENT] [job/JOB] [skills/SKILL]... ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` | +| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [r/REMARK] [t/TAG]... [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | +| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [r/REMARK] [t/TAG].. [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | +| **List** | `list` | `list` | +| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | +| **Edit** | `edit [n/NAME] [p/PHONE_NUMBER] [e/EMAIL a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | +| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | +| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | +| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | +| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | +| **Export** | `export [filename]` | `export ClientInfo.csv` | +| **Clear** | `clear` | `clear` | +| **Exit** | `exit` | `exit` | From 1f28105172ec49dd66c96d937212dc64ca8dd936 Mon Sep 17 00:00:00 2001 From: nuyer <98694104+nuyer@users.noreply.github.com> Date: Mon, 15 Apr 2024 23:54:38 +0800 Subject: [PATCH 4/5] Update ug --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 657cdecc26..6e98feaf21 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -427,7 +427,7 @@ Further details on the planned enhancements can be found in the Developer Guide. | **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [r/REMARK] [t/TAG].. [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | | **List** | `list` | `list` | | **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | -| **Edit** | `edit [n/NAME] [p/PHONE_NUMBER] [e/EMAIL a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | +| **Edit** | `edit [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | | **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | | **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | | **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | From 251a5769d208feb1b66ee1154cffea601a8e739b Mon Sep 17 00:00:00 2001 From: nuyer <98694104+nuyer@users.noreply.github.com> Date: Mon, 15 Apr 2024 23:55:27 +0800 Subject: [PATCH 5/5] update ug --- docs/UserGuide.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6e98feaf21..683f2f949d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -419,19 +419,19 @@ Further details on the planned enhancements can be found in the Developer Guide.
# Command summary -| Action | Format | Examples | -|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | +| Action | Format | Examples | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | | **Add (Employee)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Employee [r/REMARK] [t/TAG]... [dept/DEPARTMENT] [job/JOB] [skills/SKILL]... ` | `add n/Bob Ye p/8928732 e/boby@example.com a/Blk 11, Clementi Ave 1, #03-32 t/friends t/coreTeam r/requires follow up on pay raise role/employee dept/HR job/Manager skills/Java` | -| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [r/REMARK] [t/TAG]... [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | -| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [r/REMARK] [t/TAG].. [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | -| **List** | `list` | `list` | -| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | -| **Edit** | `edit [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | -| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | -| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | -| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | -| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | -| **Export** | `export [filename]` | `export ClientInfo.csv` | -| **Clear** | `clear` | `clear` | -| **Exit** | `exit` | `exit` | +| **Add (Client)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Client [r/REMARK] [t/TAG]... [pref/PREFERENCES] [prod/PRODUCT]...` | `add n/Benson Mayer p/87728933 e/mayerb@example.com a/311, Clementi Ave 2, #02-25 role/Client pref/Dairy-free prod/Sourdough bread prod/Raisin Bread` | +| **Add (Supplier)** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS role/Supplier [r/REMARK] [t/TAG].. [tos/TERMS OF SERVICE] [prod/PRODUCT]...` | `add n/Fiona Kunz p/94824272 e/lydia@example.com a/little tokyo role/Supplier tos/Delivery within 2 weeks prod/Office Supplies prod/Furniture` | +| **List** | `list` | `list` | +| **Delete** | `delete [i/ID] [n/NAME]` | `delete i/123`, `delete n/John Doe` | +| **Edit** | `edit i/ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [r/REMARK] [t/TAG]…​` (other fields specific to the role) | `edit i/123 n/James Lee e/jameslee@example.com` | +| **Find** | `find [n/NAME] [t/TAG] [p/PHONE_NUMBER] [role/ROLE] [r/REMARK]` | `find role/employee` , followed by `find n/Bob` to stack filters | +| **Relate Profiles** | `relate i/ID i/ID` | `relate i/1 i/2` | +| **Unrelate Profiles** | `unrelate i/ID i/ID` | `relate i/1 i/2` | +| **Show related Profile** | `showrelated i/ID` | `showrelated i/2` | +| **Export** | `export [filename]` | `export ClientInfo.csv` | +| **Clear** | `clear` | `clear` | +| **Exit** | `exit` | `exit` |