diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2ecaa4b8ca2..ffc6c82b8c1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -45,8 +45,7 @@ or above installed. Java is the language that your computer uses to understand T **Step 3.** Check the version number provided (`xxx`) is at least `11`. -An example is shown below. - +An example is shown below: ``` > java -version java version "xxx" @@ -58,15 +57,15 @@ An example is shown below. #### Glossary -| Words/Abbreviations | Explanation | -|---------------------|-------------------------------------------------------------------------------------------------------------------------------------| -| **TA** | Teaching Assistant | -| **Applicant** | Applicant refers to a student who has applied as a TA | -| **Mainstream OS** | Windows, Linux or Mac | -| **CLI** | Command-Line Interface | -| **GUI** | Graphical User Interface | -| **Toast** | A popup alert to inform users about certain information | -| **Tag** | Tags are associated with applicants, users can tag applicants with any keyword they want,
the number of tags are not restricted | +| Words/Abbreviations | Explanation | +|---------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| **TA** | Teaching Assistant | +| **Applicant** | Applicant refers to a student who has applied as a TA | +| **Mainstream OS** | Windows, Linux or Mac | +| **CLI** | Command-Line Interface | +| **GUI** | Graphical User Interface | +| **Toast** | A popup alert to inform users about certain information. | +| **Tag** | Tags are associated with applicants, users can tag applicants with any keyword they want,
the number of tags are not restricted. | ### Installation @@ -88,7 +87,7 @@ An example is shown below. **Step 4.** Press enter and execute the command. -An example of the final command is displayed below. +An example of the final command is displayed below: ``` > java -jar xxxx/xxxx/tafinder.jar @@ -96,7 +95,8 @@ An example of the final command is displayed below. -The GUI similar to the below should appear in a few seconds. ![Ui](images/navigationUI.png) +The GUI similar to the below should appear in a few seconds. +![Ui](images/startup-UI.png) ### Utilisation @@ -120,9 +120,9 @@ Some example commands you can try: **:bulb: Not sure what the commands above do?** -* Find all about the usable commands [here](#features) -* Look at a summary of all the usable commands [here](#command-summary) -* Return to the [Table of Contents](#toc-heading) to find your desired command +* Find all about the usable commands [here](#features). +* Look at a summary of all the usable commands [here](#command-summary). +* Return to the [Table of Contents](#toc-heading) to find your desired command. @@ -131,15 +131,25 @@ Some example commands you can try: ![UI with shaded areas](images/navigation_coloredUI.png) The UI has the following areas: -- Navigation bar +- Navigation Bar - This is where you can navigate to the `File` and `Help` menus. -- Command Input Box - - This where commands are typed +- Command Input Box + - This where commands are typed. - press `Enter` to execute it. -- Command Result Screen +- Command Result Screen - This is where the result of the command is displayed. Applicants are displayed in a list format. -- Applicant list +- Applicant List - This is where the list of applicants is displayed. +- Applicant Viewing Box + - This is where the details of the selected applicant is displayed after the command `view` is executed. + +
+ +**:bulb: Not sure what `view` does?** + +* Find out about `view` [here](#viewing-the-details-of-a-single-applicant-view). + +
-------------------------------------------------------------------------------------------------------------------- @@ -151,22 +161,22 @@ The UI has the following areas: * Words in `UPPER_CASE` are the parameters to be supplied by the user.
e.g. in `add n/NAME`,
-`NAME` is a parameter which can be used as `add n/John Doe`. + `NAME` is a parameter which can be used as `add n/John Doe`. * 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` + 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. + 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. + `p/PHONE_NUMBER n/NAME` is also acceptable. * Extraneous parameters will be ignored.
@@ -174,7 +184,7 @@ can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple -lines as space characters surrounding line-breaks may be omitted when copied over to the application. + lines as space characters surrounding line-breaks may be omitted when copied over to the application. @@ -219,12 +229,12 @@ Here are some examples you can try with the `add` command. **`add s/A0251647W n/amanda p/89064678 e/amanda@example.com g/4.3 pg/A`** - Adds an applicant with the following information: - - **Student number**: A0251647W - - **Name**: Amanda - - **Phone number**: 89064678 - - **Email address**: amanda@example.com - - **GPA**: 4.3 - - **Previous grade**: A + - **Student number**: A0251647W + - **Name**: Amanda + - **Phone number**: 89064678 + - **Email address**: amanda@example.com + - **GPA**: 4.3 + - **Previous grade**: A @@ -232,15 +242,15 @@ Here are some examples you can try with the `add` command. **`add s/A0269357C n/john doe p/91234567 e/johndoe@example.com g/5.0 pg/A- is/8.9 c/Hardworking t/pastTA t/deanslist`** - Adds an applicant with the following information: - - **Student number**: A0269357C - - **Name**: John Doe - - **Phone number**: 91234567 - - **Email address**: johndoe@example.com - - **GPA**: 5.0 - - **Previous grade**: A- - - **Interview score**: 8.9 - - **Comment**: Hardworking - - **Tags**: pastTA, deanslist + - **Student number**: A0269357C + - **Name**: John Doe + - **Phone number**: 91234567 + - **Email address**: johndoe@example.com + - **GPA**: 5.0 + - **Previous grade**: A- + - **Interview score**: 8.9 + - **Comment**: Hardworking + - **Tags**: pastTA, deanslist @@ -285,27 +295,28 @@ Repeated applicant:
#### Editing an applicant: `edit` -Edits an existing applicant in the list of applicants. - -![edit function UI](images/edit_afterUI.png) +After adding a few applicants, you realize that you have made a mistake in an applicant's information. +Lets find out how you can edit the applicant's information. **Format:**
-**`edit INDEX [s/STUDENT NUMBER] [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [c/comment] [t/TAG]…`** +**`edit INDEX [s/STUDENT NUMBER] [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [pg/PREVIOUS_GRADE] [is/INTERVIEW_SCORE] [c/COMMENT] [t/TAG]…`** - **`INDEX`**: The index of the applicant to edit. The index must be a positive integer (e.g., 1, 2, 3…). - `[optional fields]`: **At least one** of the following optional fields must be provided for editing: - - **`s/STUDENT NUMBER`**: Student number of the applicant. - - **`n/NAME`**: Name of the applicant. - - **`p/PHONE`**: Phone number of the applicant. - - **`e/EMAIL`**: Email address of the applicant. - - **`g/GPA`**: GPA of the applicant. - - **`c/comment`**: Comment of the applicant. - - **`t/TAG`**: Tags of the applicant. Note that editing tags will replace existing tags; it is not cumulative. - - To remove all existing tags, use **`t/`** without specifying any tags after it. + - **`s/STUDENT NUMBER`**: Student number of the applicant. + - **`n/NAME`**: Name of the applicant. + - **`p/PHONE`**: Phone number of the applicant. + - **`e/EMAIL`**: Email address of the applicant. + - **`g/GPA`**: GPA of the applicant. + - **`pg/PREVIOUS_GRADE`**: Previous grade of the applicant. + - **`c/comment`**: Comment of the applicant. + - **`is/INTERVIEW_SCORE`**: Interview score of the applicant. + - **`t/TAG`**: Tags of the applicant. Note that editing tags will replace existing tags; it is not cumulative. + - To remove all existing tags, use **`t/`** without specifying any tags after it.
@@ -322,20 +333,24 @@ Edits an existing applicant in the list of applicants.
-**`edit 2 n/Betsy Crower t/`** +**`edit 2 n/Alex Yeoh t/`** - Edits the following fields of the second person in the list: - **Name**: **`Betsy Crower`** - Clears all existing tags
+Following the example above, if you entered everything correctly, you should see the following: + +![edit function UI](images/edit_afterUI.png) + **Expected Outputs:**
Successfully editing applicant and applicant's information.
Confirmation message:
- **`"Edited applicant: Student number: ; Name: ; Phone: ; Email: ; GPA: ; Comment: ; Tags: "`** +**`"Edited applicant: Student number: ; Name: ; Phone: ; Email: ; GPA: ; Comment: ; Tags: "`**
@@ -344,9 +359,9 @@ Confirmation message:
Invalid command format:
- `"Invalid command format!`
- `edit: Edits the details of the applicant identified by the index number used in the displayed applicant list. Existing values will be overwritten by the input values.`
- `Parameters: INDEX (must be a positive integer) [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [c/COMMENT] [t/TAG]..."` +`"Invalid command format!`
+`edit: Edits the details of the applicant identified by the index number used in the displayed applicant list. Existing values will be overwritten by the input values.`
+`Parameters: INDEX (must be a positive integer) [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [c/COMMENT] [t/TAG]..."`
@@ -399,17 +414,17 @@ Confirmation message:
Missing index:
- **`"Invalid command format!`
- `delete: Displays the applicant identified by the index number used in the displayed applicant list.`
- `Parameters: INDEX (must be a positive integer)`
- `Example: delete 1"`** +**`"Invalid command format!`
+`delete: Displays the applicant identified by the index number used in the displayed applicant list.`
+`Parameters: INDEX (must be a positive integer)`
+`Example: delete 1"`**
Index out of range:
- **`"Error: Invalid index. Please enter an index within range."`** +**`"Error: Invalid index. Please enter an index within range."`**
@@ -517,9 +532,9 @@ Confirmation message:
Missing index:
**`"Invalid command format!`
- `view: Displays the applicant identified by the index number used in the displayed applicant list.`
- `Parameters: INDEX (must be a positive integer)`
- `Example: view 1"`** +`view: Displays the applicant identified by the index number used in the displayed applicant list.`
+`Parameters: INDEX (must be a positive integer)`
+`Example: view 1"`** @@ -536,7 +551,7 @@ Index out of range:
Hides/unhides an applicant from the list of applicants. -**Format:**  +**Format:**
@@ -558,7 +573,7 @@ Hides/unhides an applicant from the list of applicants. `unhide INDEX` - Unhides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list.
-Index must be a positive integer (e.g. 1, 2, 3...). + Index must be a positive integer (e.g. 1, 2, 3...).
@@ -612,9 +627,9 @@ Confirmation message:
Missing index:
**`"Invalid command format!`
- `hide: Hides an applicant, identified by the index number used in the last list, from all future lists of applicants.`
- `Parameter: INDEX (must be a positive integer)`
- `Example: hide 1"`** +`hide: Hides an applicant, identified by the index number used in the last list, from all future lists of applicants.`
+`Parameter: INDEX (must be a positive integer)`
+`Example: hide 1"`** @@ -836,7 +851,7 @@ Following the example above, if you entered everything correctly, you should see - Successfully bookmark/unbookmark applicant at the given index. - Confirmation message:
-**`"Applicant at index INDEX has been successfully bookmarked/unbookmarked."`** + **`"Applicant at index INDEX has been successfully bookmarked/unbookmarked."`** @@ -846,9 +861,9 @@ Following the example above, if you entered everything correctly, you should see Missing index:
**`"Invalid command format!`
- `bookmark: Bookmarks an applicant, identified by the index number used in the last list, from all future lists of applicants.`
- `Parameter: INDEX (must be a positive integer)`
- `Example: bookmark 1"`** +`bookmark: Bookmarks an applicant, identified by the index number used in the last list, from all future lists of applicants.`
+`Parameter: INDEX (must be a positive integer)`
+`Example: bookmark 1"`** @@ -977,7 +992,7 @@ A0483910A,Mohammed Taufiq bin Rozaini,85535252,taufiq@u.nus.edu,4.2,A+, - Successfully attaching a file to the applicant at the corresponding index. - Sample confirmation message:
-**`"Imported 10 applicants successfully!"`** + **`"Imported 10 applicants successfully!"`** @@ -1032,7 +1047,7 @@ Attaches local files to the profiles of applicants to provide even more richness - Successfully attaching a file to the applicant at the corresponding index. - Sample confirmation message:
-**`"Attached 1 attachments to Alex Yeoh!"`** + **`"Attached 1 attachments to Alex Yeoh!"`** @@ -1104,23 +1119,23 @@ If your changes to the data file makes its format invalid, TAfinder will discard ### Command Summary #### Basic applicant management commands -| Action | Format, Examples | -|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Add** | - `add [s/STUDENT_NUMBER] [n/NAME] [p/PHONE] [e/EMAIL] [g/GPA] [t/TAG]…`
- e.g., `add s/A0269357C n/john doe p/91234567 e/johndoe@example.com g/5.0 t/pastTA t/deanslist` | -| **Edit** | - `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
- e.g.,`edit 2 n/James Lee e/jameslee@example.com` | -| **Delete** | - `delete INDEX`
- e.g., `delete 3` | -| **List** | - `list` | -| **View** | - `view INDEX`
- e.g., `view 3` | -| **Hide/Unhide** | - `hide INDEX` / `unhide INDEX`
- e.g., `hide 3` / `unhide 3` | +| Action | Format, Examples | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add** | - `add s/STUDENT_NUMBER n/NAME p/PHONE e/EMAIL g/GPA [pg/PREVIOUS_GRADE] [is/INTERVIEW_SCORE] [c/COMMENT] [t/TAG]…`
- e.g., `add s/A0269357C n/john doe p/91234567 e/johndoe@example.com g/5.0 pg/A+ t/pastTA t/deanslist` | +| **Edit** | - `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
- e.g.,`edit 2 n/James Lee e/jameslee@example.com` | +| **Delete** | - `delete INDEX`
- e.g., `delete 3` | +| **List** | - `list [FIELD]` | +| **View** | - `view INDEX`
- e.g., `view 3` | +| **Hide/Unhide** | - `hide INDEX` / `unhide INDEX`
- e.g., `hide 3` / `unhide 3` | #### Applicant comparison and evaluation commands | Action | Format, Examples | |-------------------------|-----------------------------------------------------------------------------------| -| **Sort GPA** | - `sort-gpa` | +| **Sort** | - `sort FIELD`
- e.g., `sort gpa`, `sort name` | | **Compare** | - `compare INDEX1 INDEX2`
- e.g.,`compare 1 2` | | **Bookmark/Unbookmark** | - `bookmark INDEX` / `unbookmark INDEX`
- e.g., `bookmark 3` / `unbookmark 3` | -| **Comment** | - `comment INDEX COMMENT`
- e.g., `comment 3 Hardworking` | +| **Comment** | - `comment INDEX c/COMMENT`
- e.g., `comment 3 c/Hardworking` | #### Data import and management diff --git a/docs/images/navigationUI.png b/docs/images/navigationUI.png index c3f689d5ee1..3965e03a25c 100644 Binary files a/docs/images/navigationUI.png and b/docs/images/navigationUI.png differ diff --git a/docs/images/startup-UI.png b/docs/images/startup-UI.png new file mode 100644 index 00000000000..4fac9bf8ba1 Binary files /dev/null and b/docs/images/startup-UI.png differ