From 37f08fb1ef8995d756aa1666c4e9bc154ce21598 Mon Sep 17 00:00:00 2001 From: tsulim Date: Tue, 26 Mar 2024 20:44:25 +0800 Subject: [PATCH 1/2] Update user guide on `mark` and `unmark` commands --- docs/UserGuide.md | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 312313b89bf..a5d9ad4dc59 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -5,14 +5,14 @@ title: User Guide StaffConnect (SC) is a **desktop app for managing contacts of Professors and Tutors, 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, SC can get your contact management tasks done faster than traditional GUI apps. -* Table of Contents -{:toc} +* Table of Contents + {:toc} -------------------------------------------------------------------------------------------------------------------- ## Quick start -1. Ensure you have Java `11` or above installed in your Computer. +1. Ensure you have Java `11` or above installed in your Computer. 2. Download the latest `StaffConnect.jar` from [here](https://github.com/AY2324S2-CS2103-F08-3/tp/). @@ -103,7 +103,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MODULE] [f/FACULTY] [v/VENUE * Existing values will be updated to the input values. * When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. * You can remove all the person’s tags by typing `t/` without - specifying any tags after it. + specifying any tags after it. * When editing availabilities, the existing availabilites of the person will be removed i.e adding of availabilities is not cumulative. * You can remove all the person’s availabilities by typing `a/` without specifying any availabilities after it. @@ -182,7 +182,7 @@ Format: `meeting INDEX [d/DESCRIPTION] [s/DATETIME]` * Duplicate meetings with the same `DESCRIPTION` and `DATETIME` in the same person is not allowed. Examples: -* `meeting 1 d/ Meet for finals preparation s/ 12/04/2024 18:00` adds a meeting to the first person with the description of `Meet for finals preparation` and the date and time of `12/04/2024 18:00` +* `meeting 1 d/ Meet for finals preparation s/ 12/04/2024 18:00` adds a meeting to the first person with the description of `Meet for finals preparation` and the date and time of `12/04/2024 18:00` * `meeting 2 d/ Meet for practical exam s/ 20/04/2024 15:00` adds a meeting to the second person with the description of `Meet for practical exam` and the date and time of `20/04/2024 15:00` ![result for 'meeting 1 d/ Meet for finals preparation s/ 12/04/2024 18:00'](images/addMeetingResult.png) @@ -200,6 +200,34 @@ Examples: * `list` followed by `delete 2` deletes the 2nd person in the contacts. * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +### Marking a person : `mark` + +Marks the specified person from the contacts as favourite. + +Format: `mark INDEX` + +* Marks the person at the specified `INDEX`. +* The index refers to the index number shown in the displayed person list. +* The index **must be a positive integer** 1, 2, 3, …​ + +Examples: +* `list` followed by `mark 2` marks the 2nd person in the contacts. +* `find Betsy` followed by `mark 1` marks the 1st person in the results of the `find` command. + +### Unmarking a person : `unmark` + +Unmarks the specified person from the contacts as favourite. + +Format: `unmark INDEX` + +* Unmarks the person at the specified `INDEX`. +* The index refers to the index number shown in the displayed person list. +* The index **must be a positive integer** 1, 2, 3, …​ + +Examples: +* `list` followed by `unmark 2` unmarks the 2nd person in the contacts. +* `find Betsy` followed by `unmark 1` unmarks the 1st person in the results of the `find` command. + ### Clearing all entries : `clear` Clears all entries from the contacts. @@ -269,5 +297,7 @@ Action | Format, Examples **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` **Sort** | `sort [ATTRIBUTE]`
e.g., `sort p/` **Add Meeting** | `meeting INDEX [d/DESCRIPTION] [s/DATETIME]`
e.g., `meeting 1 d/ Meet for finals preparation s/ 12/04/2024 18:00` +**Mark** | `mark INDEX`
e.g., `mark 3` +**Unmark** | `unmark INDEX`
e.g., `unmark 3` **List** | `list` **Help** | `help` From a3c196919976a5d6cfcbce1665baec288b71f4c6 Mon Sep 17 00:00:00 2001 From: tsulim Date: Thu, 28 Mar 2024 23:30:30 +0800 Subject: [PATCH 2/2] Update `mark` and `unmark` header in user guide --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a5d9ad4dc59..e5d1abf601e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -200,7 +200,7 @@ Examples: * `list` followed by `delete 2` deletes the 2nd person in the contacts. * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. -### Marking a person : `mark` +### Marking a person as favourite: `mark` Marks the specified person from the contacts as favourite. @@ -214,7 +214,7 @@ Examples: * `list` followed by `mark 2` marks the 2nd person in the contacts. * `find Betsy` followed by `mark 1` marks the 1st person in the results of the `find` command. -### Unmarking a person : `unmark` +### Unmarking a person as favourite: `unmark` Unmarks the specified person from the contacts as favourite.