From 0f06a29c4db13b713a203e67074e1c220ddb2205 Mon Sep 17 00:00:00 2001 From: AriellaCallista Date: Wed, 15 Nov 2023 22:18:56 +0800 Subject: [PATCH 1/2] Update UG for CS2101 #3 --- docs/UserGuide.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index e76459a3eb8..3cf9501e818 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -127,12 +127,14 @@ You are an **advanced** user if ... **Notes** and **tips** curated for you are labeled by the following box! -
-

Advanced

+
+

@@ -304,7 +306,7 @@ The `Help Window` opens up as follows: -------------------------------------------------------------------------------------------------------------------- -### 1.Managing Tags +### 1. Managing Tags Tags are meant to help you easily remember applicants details by appending different colour coding to different types of information. @@ -666,10 +668,11 @@ Format: `edit INDEX ([n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAGNAME]…​ * If you used a tag that has not been created using `create` in an `edit` command, the tag would still be added to the applicant, but it would be _uncategorized_. * If you have **multiple tags in different categories with the same name**, you must **specify the category** when you want to tag the specified applicant with one of these tags e.g. `edit INDEX t/CATEGORY DUPLICATETAGNAME` -

-

Advanced

+
+

-

Advanced

+
+

-

Advanced

+
+

-

Advanced

+
+

-

-

Advanced

+
+

-

Advanced

+
+

-An example of the `remark` command being successfully executed: +**An example of the `remark` command being successfully executed:** 1. Enter the command `remark 1 r/Great attitude, hardworking` 2. This is the result of the successful `remark` command (Take note that command entered will not be shown in the result): ![Remark-Success](images/remark-command-success.png) @@ -466,7 +466,7 @@ An example of the `remark` command being successfully executed:
-An example of the `remark` command being successfully executed with the **REMARK** keyword: +**An example of the `remark` command being successfully executed with the **REMARK** keyword:** 1. Enter the command `remark 1 r/**REMARK** furthermore he is great at teamwork` 2. This is the result of the successful `remark` command (Take note that command entered will not be shown in the result): ![Remark-Success](images/remark-command-enhanced-success.png) @@ -481,7 +481,7 @@ An example of the `remark` command being successfully executed with the **REMARK | Invalid Index | The person index provided is invalid | Ensure that the index is valid. That is it is a number that is on the displayed applicant list. | | Negative or 0 Index | Invalid command format! | Ensure that the index is a positive integer and is also a number that is on the displayed applicant list. | -Additional Examples: +**Additional Examples:** * `remark 1` Empties the remark of the 1st applicant. It is equivalent to `remark 1 r/`. [Jump back to Table of Contents](#table-of-contents) @@ -580,7 +580,7 @@ Format: `set INDEX STATUS` | Mandatory | `INDEX` | `INDEX` must be an existing index in the displayed applicant list and it must not be greater than the total number of applicant in JABPro. It must also be a positive integer | | Mandatory | `STATUS` | `STATUS` must be one of the following - "Preliminary", "Interviewed", "Rejected", "Accepted". It is case-insensitive. | -Examples: +**Examples:** * `list` followed by `set 2 Interviewed` sets the 2nd applicant in the address book to "Interviewed". [Jump back to Table of Contents](#table-of-contents) @@ -607,14 +607,14 @@ This means that the view will be updated to reflect the latest changes to the da -An example of the `view` command being successfully executed: +**An example of the `view` command being successfully executed:** 1. Enter the command `view 3` 2. This is the result of the successful `view` command (Take note that command entered will not be shown in the result): ![View-Success](images/view-command-success.png)
-An example of the `view` command being successfully executed for applicant with tags and score: +**An example of the `view` command being successfully executed for applicant with tags and score:** 1. Enter the command `view 2` (**Applicant with tags and score**) 2. This is the result of the successful `view` command (Take note that command entered will not be shown in the result): @@ -716,7 +716,7 @@ Nonetheless, we **strongly recommend you to use `create` to create categorized t
-An example of the `edit` command being successfully executed: +**An example of the `edit` command being successfully executed:** 1. Enter the command `edit 1 n/Alex Ho p/91234567` (**edits name and phone number**) 2. This is the result of the successful `edit` command (Take note that command entered will not be shown in the result): @@ -725,7 +725,7 @@ An example of the `edit` command being successfully executed:
-An example of the `edit` command being successfully executed with tags and score: +**An example of the `edit` command being successfully executed with tags and score:** 1. Ensure that you have created a tag `Interview` under the `assessment` category using the `create` command. Enter the command `create t/assessment Interview` 2. Enter the command `edit 1 t/Interview sc/Interview 80` (**edits tag and score**) 3. This is the result of the successful `edit` command (Take note that command entered will not be shown in the result): @@ -735,7 +735,7 @@ An example of the `edit` command being successfully executed with tags and score
-An example of the `edit` command being successfully executed to clear a tags and score: +**An example of the `edit` command being successfully executed to clear a tags and score:** 1. Enter the command `edit 1 t/` (**Clear all tags**) 2. This is the result of the successful `edit` command (Take note that command entered will not be shown in the result): @@ -799,7 +799,7 @@ Format: `delete (t/TAGNAME... st/STATUS...)` **Note:** * You can combine multiple delete categories in a single `delete` command e.g. `delete st/interviewed t/intern` -An example of **delete by index** command being successfully executed: +**An example of **delete by index** command being successfully executed:** 1. Enter the command `delete Bernice` ![delete-by-index-pre](images/delete-by-index-pre.png) @@ -885,7 +885,7 @@ Format: `search (n/NAME... st/STATUS... t/TAGNAME...)` **Note:** * You can combine multiple search categories in a single `search` command e.g. `search n/alex st/interviewed t/intern` -Here are some examples of **search** command being successfully executed: +**Here are some examples of **search** command being successfully executed:** 1. Enter `search n/alex bernice` ![search-success-1](images/search-success-1.png) @@ -982,7 +982,7 @@ Set up for examples when you first start JABPro with default data:
-An example of the `filter` command being successfully executed: +**An example of the `filter` command being successfully executed:** 1. Enter the command `list` 2. Enter the command `filter t/interview met/percentile val/80` (**Filter by percentile**) 3. This is the result of the successful `filter` command (Take note that command entered will not be shown in the result): @@ -992,7 +992,7 @@ An example of the `filter` command being successfully executed:
-An example of the `filter` command being successfully executed with `median`: +**An example of the `filter` command being successfully executed with `median`:** 1. Enter the command `list` 2. Enter the command `filter t/interview met/median` (**Filter by median**) 3. This is the result of the successful `filter` command (Take note that command entered will not be shown in the result): @@ -1136,7 +1136,7 @@ Exports the entries into a .csv file located in the current directory as (/data/ * JABPro must have write permissions, this means that if the .csv file is open, exporting again will not be possible. -Examples: +**Examples:** * `export` exports the data to /data/export.csv [Jump back to Table of Contents](#table-of-contents)