From 02d5619593836b1d644b1c2aefee34a5f01ea215 Mon Sep 17 00:00:00 2001 From: Wongqingyee Date: Thu, 29 Feb 2024 16:31:12 +0800 Subject: [PATCH 1/2] Update the add feature --- docs/UserGuide.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7abd1984218..f091c0be5c4 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -51,11 +51,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo * Items in square brackets are optional.
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. -* Items with `…`​ after them can be used multiple times including zero times.
- e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. - -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +* Parameters must be in specified order.
* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. @@ -74,17 +70,19 @@ Format: `help` ### Adding a person: `add` -Adds a person to the address book. +Adds student details to the address book. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` +Format: `add id/STUDENT_ID n/NAME e/EMAIL g/GRADE [t/TAG]​` -
:bulb: **Tip:** -A person can have any number of tags (including 0) -
+* Name, student_id, grade, and email must have. +* Name can be case-insensitive, eg. john doe, JOHN DOE same as John Doe +* Email must have the correct format and string length of 8 for the email username eg. e0000000@u.nus.edu +* Grade: [A+, A, A-, B+, B, B-, C+, C, D+, D, F] +* Student_id must start with A and end with a letter, string length of 9 eg. A0000000X Examples: -* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` -* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` +* `add id/A01234567H n/John Doe e/e0123456@u.nus.edu` + ### Listing all persons : `list` From 5394b75ecc128705fd340e2bee4e24442e598eda Mon Sep 17 00:00:00 2001 From: Wongqingyee Date: Thu, 29 Feb 2024 17:02:16 +0800 Subject: [PATCH 2/2] Update the Quick start in the UG --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f091c0be5c4..2c122594453 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -14,11 +14,11 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo 1. Ensure you have Java `11` or above installed in your Computer. -1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). +1. Download the latest `TeachStack.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. -1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.
+1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TeachStack.jar` command to run the application.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
![Ui](images/Ui.png)