forked from AY2324S1-CS2103T-W10-1/tp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request AY2324S1-CS2103T-W10-1#193 from nabonitasen/branch…
…-ug-updates Update clear and exit commands in UG
- Loading branch information
Showing
5 changed files
with
93 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,7 +8,7 @@ show-sticky-toc: true | |
|
||
Introducing **TAfinder - the one-stop solution for all your TA selection needs**. | ||
|
||
With TAfinder, you can easily: | ||
As an NUS School Of Computing professor, with TAfinder, you can easily: | ||
1. **Manage** troves of TA applicants. | ||
2. Make more **informed decisions** with the help of our **compare** and **sort** functions. | ||
3. **Import** data to the TAfinder application. | ||
|
@@ -458,17 +458,15 @@ Shows a list of applicants. | |
|
||
#### Viewing the details of a single applicant: `view` | ||
|
||
Displays a single applicant. | ||
|
||
![edit function UI](images/viewUI.png) | ||
Displays the details of a specified applicant in the details panel. | ||
|
||
**Format:** | ||
|
||
<div markdown="block" class="alert alert-info"> | ||
|
||
**`view INDEX`** | ||
|
||
**`INDEX`**: The index corresponding to the applicant to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). | ||
**`INDEX`**: The index corresponding to the applicant you want to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). | ||
|
||
</div> | ||
|
||
|
@@ -479,27 +477,34 @@ Displays a single applicant. | |
**`view 3`** | ||
- Displays the following details about the third applicant. | ||
- Name | ||
- Student number | ||
- Tags | ||
- Phone number | ||
- Email Address | ||
- GPA | ||
- Previous Grade | ||
- Interview Score | ||
- Comments | ||
- Tags | ||
|
||
- Attachments | ||
</div> | ||
|
||
Following the example above, if you entered everything correctly, you should see the following: | ||
|
||
![view function UI](images/viewUI.png) | ||
|
||
**Expected Outputs:** | ||
|
||
<div markdown="block" class="alert alert-success"> | ||
|
||
Successfully displaying all details of an applicant in the following format: | ||
- **`Name: John Doe`** | ||
- **`Student number: A0358289S`** | ||
- **`Tags: pastTA, deansList`** | ||
- **`Phone Number: 91234567`** | ||
- **`Email Address: [email protected]`** | ||
- **`GPA: 5.0`** | ||
- **`Comments: Good fit, has teaching experience`** | ||
- **`Tags: pastTA, deansList`** | ||
- **`Previous Grade: A`** | ||
- **`Interview Scorw (optional): 8`** | ||
- **`Comment (optional): Good fit, has teaching experience`** | ||
- **`Attachments: Resume.pdf`** | ||
|
||
Confirmation message:<br> | ||
**`"Displaying: APPLICANT_NAME"`** | ||
|
@@ -622,6 +627,59 @@ Index out of range:<br> | |
|
||
--- | ||
|
||
#### Clearing all applicants: `clear` | ||
|
||
Clears your entire list of applicants. | ||
|
||
**Format:** | ||
|
||
<div markdown="block" class="alert alert-info"> | ||
|
||
**`clear`** | ||
|
||
</div> | ||
|
||
Following the example above, if you entered everything correctly, you should see the following: | ||
|
||
|
||
| Before | After | | ||
|:-----------------------------------------------:|:----------------------------------------------:| | ||
| ![clear function UI](images/clear_beforeUI.png) | ![clear function UI](images/clear_afterUI.png) | | ||
|
||
**Expected Outputs:** | ||
|
||
<div markdown="block" class="alert alert-success"> | ||
|
||
Successfully clearing all applicants.<br> | ||
**`"Applicant list has been cleared!"`** | ||
|
||
</div> | ||
|
||
|
||
--- | ||
|
||
#### Exiting the application: `exit` | ||
|
||
Exits the application, while ensuring all your changes are saved. | ||
|
||
**Format:** | ||
|
||
<div markdown="block" class="alert alert-info"> | ||
|
||
**`exit`** | ||
|
||
</div> | ||
|
||
**Expected Outputs:** | ||
|
||
<div markdown="block" class="alert alert-success"> | ||
|
||
- Application closes. | ||
|
||
</div> | ||
|
||
--- | ||
|
||
### Applicant evaluation & comparison | ||
|
||
#### Sorting applicants by GPA: `sort` | ||
|
@@ -725,40 +783,49 @@ Comparing the same applicant:<br> | |
|
||
--- | ||
|
||
#### Bookmarking/Unbookmarking applicants: `bookmark/unbookmark` | ||
#### Bookmarking applicants: `bookmark`/`unbookmark` | ||
|
||
Bookmarks/Unbookmarks a specific applicant. | ||
|
||
| Before | After | | ||
|:-----------------------------------------------------:|:----------------------------------:| | ||
| ![bookmark function UI](images/bookmark_beforeUI.png) | ![bookmark function UI](images/bookmark_afterUI.png) | | ||
|
||
**Format:** | ||
|
||
<div markdown="block" class="alert alert-info"> | ||
|
||
**`bookmark INDEX` / `unbookmark INDEX`** | ||
|
||
**`INDEX`**: The index corresponding to the applicant to be bookmarked/unbookmarked. The index must be a positive integer (e.g., 1, 2, 3…). | ||
**`INDEX`**: The index corresponding to the applicant you want to bookmark/unbookmark. The index must be a positive integer (e.g., 1, 2, 3…). | ||
|
||
</div> | ||
|
||
**Examples:** | ||
|
||
<div markdown="block" class="alert alert-secondary"> | ||
|
||
**`bookmark 3`** | ||
- Bookmarks the third applicant. | ||
**`bookmark 2`** | ||
- Bookmarks the second applicant. | ||
|
||
</div> | ||
|
||
Following the example above, if you entered everything correctly, you should see the following: | ||
|
||
| Before | After | | ||
|:-----------------------------------------------------:|:----------------------------------:| | ||
| ![bookmark function UI](images/bookmark_beforeUI.png) | ![bookmark function UI](images/bookmark_afterUI.png) | | ||
|
||
<div markdown="block" class="alert alert-secondary"> | ||
|
||
**`unbookmark 3`** | ||
- Unbookmarks the third applicant. | ||
**`unbookmark 2`** | ||
- Unbookmarks the second applicant. | ||
|
||
</div> | ||
|
||
Following the example above, if you entered everything correctly, you should see the following: | ||
|
||
| Before | After | | ||
|:---------------------------------------------------------:|:--------------------------------------------------------:| | ||
| ![unbookmark function UI](images/unbookmark_beforeUI.png) | ![unbookmark function UI](images/unbookmark_afterUI.png) | | ||
|
||
|
||
**Expected Outputs:** | ||
|
||
<div markdown="block" class="alert alert-success"> | ||
|
@@ -790,7 +857,7 @@ Index out of range:<br> | |
|
||
--- | ||
|
||
#### Commenting on TA applicant: **`comment`** | ||
#### Commenting on applicant: `comment` | ||
|
||
One of yours TAs is unable to make it for the interview. | ||
You want to make a comment on the applicant to remind yourself to follow up with him/her. | ||
|
@@ -852,6 +919,7 @@ Index out of range:<br> | |
|
||
</div> | ||
|
||
|
||
--- | ||
|
||
### Files and data management | ||
|
@@ -990,13 +1058,13 @@ TAfinder data are saved in the hard disk automatically after any command that ch | |
|
||
TAfinder data are saved automatically as a JSON file `[JAR file location]/data/tafinder.json`. Advanced users are welcome to update data directly by editing that data file. | ||
|
||
<box type="warning"> | ||
|
||
**Warning:** | ||
|
||
<div markdown="block" type="alert alert-warning"> | ||
|
||
If your changes to the data file makes its format invalid, TAfinder will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | ||
|
||
</box> | ||
</div> | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
## Upcoming Features [coming in a future update!] | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.