From 8ee98331c920bb2859e04cb9b10c50469add9165 Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 00:51:44 +0800 Subject: [PATCH 1/6] Add warning for clear command --- docs/UserGuide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 83f75151e3b..4a29f27b948 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -110,6 +110,13 @@ EduContacts is a **desktop app for educators in tertiary institutions to manage ``` Deletes all contacts. + + +**Warning:** +The `clear` command will erase all contacts from the system. Please ensure that you have backed up any important information before proceeding. This action cannot be undone, so use this command with caution. + + + ```bash exit ``` From f8034e995e959626346e83443b3a9e0776f6b3aa Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 07:14:51 +0800 Subject: [PATCH 2/6] Update edit command to include 2 formats --- docs/UserGuide.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4a29f27b948..63875d2836b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -226,14 +226,23 @@ Examples: ### Editing a person : `edit` -Edits a specified person in EduContacts. +Edits a specified person in EduContacts. There are 2 usages: -Format: -```bash -edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE] -``` +1. Edits the details of the person identified by the studentId assigned to the corresponding student. Existing values will be overwritten by the input values. + + Format: + ```bash + edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE] + ``` + +2. Edits a module of the person identified. Existing values will be overwritten by the input module. + Format: + ```bash + edit ID m/ OLD_MODULE NEW_MODULE + ``` +In general, `edit` command: * Edits a person's details according to the fields specified. * At least one of the optional fields must be provided. * Existing values will be updated to the input values. From 85388c7a6ce56f2b64a710a6a8d9a9bddeca09ba Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 09:29:52 +0800 Subject: [PATCH 3/6] Update to make formatting consistent --- docs/UserGuide.md | 60 ++++++++++++++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 22 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 63875d2836b..7b3c83723fe 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -226,26 +226,28 @@ Examples: ### Editing a person : `edit` -Edits a specified person in EduContacts. There are 2 usages: +Edits a specified person details or module in EduContacts. +Usages: -1. Edits the details of the person identified by the studentId assigned to the corresponding student. Existing values will be overwritten by the input values. +**1. Edit person details:** - Format: - ```bash - edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE] - ``` + Format: -2. Edits a module of the person identified. Existing values will be overwritten by the input module. +```bash +edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE] +``` + * Updates the details of the person identified by the studentId assigned to the corresponding student. + * At least one of the optional fields must be provided. + * Existing values will be overwritten by the input values. - Format: - ```bash - edit ID m/ OLD_MODULE NEW_MODULE - ``` +**2. Edit person's module:** -In general, `edit` command: -* Edits a person's details according to the fields specified. -* At least one of the optional fields must be provided. -* Existing values will be updated to the input values. + Format: +```bash +edit ID m/ OLD_MODULE NEW_MODULE +``` + * Updates a module of the person identified by the studentId. + * Existing module (`OLD_MODULE`) will be overwritten by the input module (`NEW_MODULE`). Examples: * `edit 12345678 m/CS2103T CS2101` will edit a person with student ID of `12345678` by replacing the old module `CS2103T` with the new module `CS2101`. @@ -276,29 +278,43 @@ Examples: ### Listing persons by certain attributes : `filter` -Filters person contacts based on their names, courses and modules. +Filters person contacts by name, course, or module. +Usages: + +**1. Filter by name:** Format: ```bash -filter [KEYWORD_PREFIX] [MORE_KEYWORDS] +filter n/KEYWORD [MORE_KEYWORDS] ``` -* **For filtering by names:** * Use prefix `n/`. * Only full words will be matched e.g. `Han` will not match `Hans` * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` * Persons matching at least one keyword will be returned (i.e. `OR` search). - e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` + e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` + +**2. Filter by Module:** + +Format: +```bash +filter m/KEYWORD +``` -* **For filtering by Module:** * Use prefix `m/`. * Partial matching is supported, allowing users to input parts of module codes. e.g. `m/CS21` will match modules like "CS2103T" and "CS2101." +**3. Filter by course:** + +Format: +```bash +filter c/KEYWORD +``` + -* **For filtering by Course:** * Use prefix `c/` * Partial matching is supported, but the first keyword must match the beginning of the course name. e.g `Engineer` will match courses like "Engineering" but not "Civil Engineering". @@ -309,7 +325,7 @@ filter [KEYWORD_PREFIX] [MORE_KEYWORDS] Examples: -* `filter n/John` will return a list of all persons with `John` in their name e.g. `john` and `John Doe`. +* `filter n/John` will return a list of all persons with `John` in their name e.g. `John Smith` and `John Doe`. * `filter m/CS2103T` will return a list of all persons with module `CS2103T`. * `filter c/Computer Science` will return a list of all persons with course `Computer Science`. * `filter n/alex david` will return a list of all persons with `alex` or `david` in their name e.g. `Alex Yeoh`, `David Li` (the result of this command is shown in the screenshot below). From de92c831f742eb5f6f5764a46ce24fe324276ee3 Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 10:00:26 +0800 Subject: [PATCH 4/6] Add footnotes, specify Singapore phone number --- docs/UserGuide.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7b3c83723fe..8214b365f16 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -10,7 +10,7 @@
-EduContacts is a **desktop app for educators in tertiary institutions to manage contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). For expert users familiar with command-based tools, EduContacts can get your contact management tasks done faster than traditional GUI apps. For new users, EduContacts also includes user-friendly and intuitive features and guidance, making it user-friendly and accessible for all users. +EduContacts is a **desktop app for educators in tertiary institutions in Singapore to manage contacts, optimized for use via a Command Line Interface[1]** (CLI) while still having the benefits of a Graphical User Interface[2] (GUI). For expert users familiar with command-based tools, EduContacts can get your contact management tasks done faster than traditional GUI apps. For new users, EduContacts also includes user-friendly and intuitive features and guidance, making it user-friendly and accessible for all users.
@@ -34,6 +34,20 @@ EduContacts is a **desktop app for educators in tertiary institutions to manage 6. [Command summary](#command-summary) -------------------------------------------------------------------------------------------------------------------- + + + +

+ +**1. Command Line Interface:** a software mechanism you use to interact with your operating system using your keyboard.

+ +

+ +**2. Graphical User Interface:** a digital interface in which a user interacts with graphical components such as icons, buttons, and menus.

+ + + +
## Guidance Icons Legend @@ -185,6 +199,12 @@ Format: add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE ``` + + +**Note:** The phone number must be at least 8 digits long, and is a valid Singapore phone number. + + + Examples: * `add 87654321 n/Betsy Crowe r/Student e/betsycrowe@example.com a/Blk 30 Geylang Street 29, #06-40 p/12345678 c/Business Analytics` will add a person named `Betsy Crowe` with student ID of `87654321` to EduContacts. * `add 12345678 n/John Doe p/98981212 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student` will add a person named `John Doe` with student ID of `12345678` to EduContacts. From 9a69436b9f69177c866ef9a194416993ce1df81b Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 10:20:10 +0800 Subject: [PATCH 5/6] Add UG fixes --- docs/UserGuide.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8214b365f16..b2fea04c2cd 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -257,7 +257,7 @@ Usages: edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE] ``` * Updates the details of the person identified by the studentId assigned to the corresponding student. - * At least one of the optional fields must be provided. + * At least one of the optional fields must be provided: name, phone, email, address, course, role. Note that studentId cannot be edited as it is the person's identifier. * Existing values will be overwritten by the input values. **2. Edit person's module:** @@ -275,6 +275,10 @@ Examples: ![result for 'edit command result'](images/editCommandResult.png) + + +**Tip:** Use the `find` command to view the full detail of the student first before proceeding with `edit`. This allows you to view the changes and verify the edit immediately. +
### Adding a grade : `grade` @@ -285,14 +289,14 @@ Adds a grade to a person's module. grade ID m/MODULE g/GRADE ``` -* Adds a grade to a person according to the specified student ID and Module. +* Adds a grade to a person according to the specified studentId and Module. * Module specified must exist prior to execution grade command. * Acceptable grades: `A+, A, A-, B+, B, B-, C+, C, D+, D, F`. * Existing grade will be updated to the input grade. Examples: -* `grade 23876767 m/CS2103T g/A` will assign an `A` grade to the `CS2103T` module of a person with student ID of `23876767`. -* `grade 14141414 m/CS1101S g/B+` will assign an `B+` grade to the `CS1101S` module of a person with student ID of `14141414`. +* `grade 23876767 m/CS2103T g/A` will assign an `A` grade to the `CS2103T` module of a person with studentId of `23876767`. +* `grade 14141414 m/CS1101S g/B+` will assign an `B+` grade to the `CS1101S` module of a person with studentId of `14141414`.
@@ -308,7 +312,7 @@ Format: filter n/KEYWORD [MORE_KEYWORDS] ``` - * Use prefix `n/`. + * `n/` prefix is used. * Only full words will be matched e.g. `Han` will not match `Hans` * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` * Persons matching at least one keyword will be returned (i.e. `OR` search). @@ -323,7 +327,7 @@ filter m/KEYWORD - * Use prefix `m/`. + * `m/` prefix is used. * Partial matching is supported, allowing users to input parts of module codes. e.g. `m/CS21` will match modules like "CS2103T" and "CS2101." **3. Filter by course:** @@ -335,7 +339,7 @@ filter c/KEYWORD - * Use prefix `c/` + * `c/` prefix is used. * Partial matching is supported, but the first keyword must match the beginning of the course name. e.g `Engineer` will match courses like "Engineering" but not "Civil Engineering". @@ -370,11 +374,11 @@ Format 1: delete ID ``` -* Deletes person with the specified student ID. +* Deletes person with the specified studentId. Examples: -* `delete 15151515` will delete a person with student ID of `15151515` from EduContacts. -* `delete 71271222` will delete a person with student ID of `71271222` from EduContacts (the response message of this command is shown in the screenshot below). +* `delete 15151515` will delete a person with studentId of `15151515` from EduContacts. +* `delete 71271222` will delete a person with studentId of `71271222` from EduContacts (the response message of this command is shown in the screenshot below). ![result for 'delete_71271222'](images/deleteCommandResult.png) @@ -383,10 +387,10 @@ Format 2: delete ID m/MODULE ``` -* Deletes a module from the person with the specified student ID. +* Deletes a module from the person with the specified studentId. Examples: -* `delete 13131313 m/CS2103T` will delete the module `CS2103T` from a person with student ID of `13131313` (the result of this command is shown in the screenshot below). +* `delete 13131313 m/CS2103T` will delete the module `CS2103T` from a person with studentId of `13131313` (the result of this command is shown in the screenshot below). ![result for 'delete_13131313'](images/deleteModuleResult.png)
@@ -400,7 +404,7 @@ Format: `find ID` * Finds student with the specified `ID`. Examples: -* `find 12345678` will find a person with student ID of `12345678` and display their details. +* `find 12345678` will find a person with studentId of `12345678` and display their details.
From 136caf06811a535ec04d188c1b45a79b9d5f9538 Mon Sep 17 00:00:00 2001 From: jessica2828 Date: Mon, 11 Nov 2024 10:22:40 +0800 Subject: [PATCH 6/6] Improve readability --- docs/UserGuide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b2fea04c2cd..851f20b5811 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -184,8 +184,12 @@ help ``` The help window will display the help message as shown in the screenshot below: -![help message](images/helpMessage.png) +![help message](images/helpMessage.png)
+ + Alternatively, you can click the button on the top right hand corner as indicated here: + + ![alternative_help](images/alternativeHelp.png)