Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UserGuide to include Faculty #91

Merged
merged 3 commits into from
Mar 17, 2024
Merged

Update UserGuide to include Faculty #91

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2f85ce
Merge branch 'master' of https://github.com/JerryWang0000/tp
JerryWang0000 Mar 16, 2024
d9855b0
Update UserGuide to include Faculty
JerryWang0000 Mar 16, 2024
7597490
Fix typos in UserGuide.md
JerryWang0000 Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 33 additions & 16 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ StaffConnect (SC) is a **desktop app for managing contacts of Professors and Tut

* `list` : Lists all contacts.

* `add n/John Doe p/98765432 e/[email protected] v/John street, block 123, #01-01 m/CS2103` : Adds a contact named `John Doe` to the contacts list.
* `add n/John Doe p/98765432 e/[email protected] f/Computing v/John street, block 123, #01-01 m/CS2103` : Adds a contact named `John Doe` to the contacts list.

* `delete 3` : Deletes the 3rd contact shown in the current list.

Expand Down Expand Up @@ -76,15 +76,15 @@ Format: `help`

Adds a person to the contacts.

Format: `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​`
Format: `add n/NAME p/PHONE_NUMBER e/EMAIL f/FACULTY v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​`

<div markdown="span" class="alert alert-primary">:bulb: **Tip:**
A person can have any number of tags and availabilities (including 0)
</div>

Examples:
* `add n/John Doe p/98765432 e/[email protected] v/John street, block 123, #01-01 m/CS2103`
* `add n/Betsy Crowe t/friend m/CS2103T e/[email protected] v/Newgate Prison p/1234567 t/criminal a/monday a/wednesday`
* `add n/John Doe p/98765432 e/[email protected] f/Computing v/John street, block 123, #01-01 m/CS2103`
* `add n/Betsy Crowe t/friend m/CS2103T e/[email protected] f/Computing v/Newgate Prison p/1234567 t/criminal a/monday a/wednesday`

### Listing all persons : `list`

Expand All @@ -96,7 +96,7 @@ Format: `list`

Edits an existing person in the contacts.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`
Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [f/FACULTY] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`

* Edits 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, …​
* At least one of the optional fields must be provided.
Expand Down Expand Up @@ -202,18 +202,35 @@ _Details coming soon ..._
## Known issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.

2. **Restrictions on the valid user input of `Faculty` values**: For the current version, a valid user input for `Faculty` with prefix `f/` can only match exactly the same string as suggested below. Cases can be ignored though.
- Arts and Social Sciences
- Business
- Computing
- Continuing and Lifelong Education
- Dentistry
- Design and Environment
- Duke-NUS Medical School
- Engineering
- Integrative Sciences and Engineering
- Law
- Medicine
- Music
- Public Health
- Public Policy
- Science
- University Scholars Programme
- Yale-NUS College
--------------------------------------------------------------------------------------------------------------------

## Command summary

Action | Format, Examples
--------|------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] v/123, Clementi Rd, 1234665 m/CS2103 t/friend t/colleague a/monday`
**Clear** | `clear`
**Delete** | `delete INDEX`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Sort** | `sort [ATTRIBUTE]`<br> e.g., `sort p/`
**List** | `list`
**Help** | `help`
| Action | Format, Examples |
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL f/FACULTY v/VENUE m/MODULE [t/TAG]…​ [a/AVAILABILITY]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] f/Computing v/123, Clementi Rd, 1234665 m/CS2103 t/friend t/colleague a/monday` |
| **Clear** | `clear` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [f/FACULTY] [v/VENUE] [m/MODULE] [t/TAG]…​ [a/AVAILABILITY]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **Sort** | `sort [ATTRIBUTE]`<br> e.g., `sort p/` |
| **List** | `list` |
| **Help** | `help` |
Loading