Skip to content

Commit

Permalink
Merge pull request #151 from gingerbreaf/branch-UG
Browse files Browse the repository at this point in the history
Update UG Table + list commands
  • Loading branch information
yashpola authored Apr 3, 2024
2 parents d4334d8 + cdabdad commit 4846128
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,10 @@ Executing this would result in the following display:

Now that you have added multiple `Applicants` and `Interviewers` into Tether, it would be nice to view them with their
details simultaneously. The list of persons is displayed on the left side of the GUI by default and is updated
whenever new persons are added.
whenever new persons are added.

However, there is a ```find``` command (explained below) that filters the persons list in
the UI. If you have filtered the list and wants to see the original unfiltered list of persons, you can use this command.

Format: `list_persons`

Expand All @@ -141,6 +144,9 @@ Now that you have added multiple `Interviews` into Tether, it would be nice to v
simultaneously. The list of interviews is displayed on the right side of the GUI by default and is updated whenever
new interviews are added.

However, there is a ```filter_interviews_by_date``` command (explained below) that filters the interviews list in
the UI. If you have filtered the list and wants to see the original unfiltered list, you can use this command.

Format: `list_interviews`

## Finding persons:
Expand Down Expand Up @@ -247,13 +253,20 @@ the data of your previous Tether home folder.

## Command summary

| Action | Format, Examples |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add Applicant** | `add_applicant n/NAME p/PHONE e/EMAIL [t/TAG]` <br> e.g., `add_applicant n/John Doe p/81239123 e/[email protected]` |
| **Add Interviewer** | `add_interviewer n/NAME p/PHONE e/EMAIL [t/TAG]` <br> e.g., `add_interviewer n/Jane Doe p/81239123 e/[email protected]` |
| **Add Interview** | `add_interview desc/DESCRIPTION date/DATE st/START TIME et/END TIME a/APPLICANT PHONE i/INTERVIEWER PHONE`<br> e.g., `add_interview desc/Interview with John date/2024-11-11 st/10:00 et/11:00 a/81239123 i/91238123` |
| **Delete Person** | `delete_person PHONE` <br> e.g., `delete_person 81239123` |
| **Delete Interview** | `delete_interview INDEX`<br> e.g., `delete_interview 1` |
| **List Interviews** | `list_interviews` |
| **Exit** | `exit` |
| **Help** | `help` |
| Action | Format, Examples |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add Applicant** | `add_applicant n/NAME p/PHONE e/EMAIL [t/TAG]` <br> e.g., `add_applicant n/John Doe p/81239123 e/[email protected]` |
| **Change Applicant Status** | `applicant_status PHONE s/STATUS` <br> e.g., `applicant_status 81239123 s/accepted` |
| **Add Interviewer** | `add_interviewer n/NAME p/PHONE e/EMAIL [t/TAG]` <br> e.g., `add_interviewer n/Jane Doe p/81239123 e/[email protected]` |
| **Change Interviewer Status** | `interviewer_status PHONE s/STATUS` <br> e.g., `interviewer_status 81239123 s/free` |
| **Add Interview** | `add_interview desc/DESCRIPTION date/DATE st/START TIME et/END TIME a/APPLICANT PHONE i/INTERVIEWER PHONE`<br> e.g., `add_interview desc/Interview with John date/2024-11-11 st/10:00 et/11:00 a/81239123 i/91238123` |
| **Delete Person** | `delete_person PHONE` <br> e.g., `delete_person 81239123` |
| **Delete Interview** | `delete_interview INDEX`<br> e.g., `delete_interview 1` |
| **List Interviews** | `list_interviews` |
| **List Persons** | `list_persons` |
| **Find Persons** | `find_[email/name/phone] [keyword 1]` <br> e.g., `find_name Ryan` |
| **Filter Persons by Status** | `filter_by_status STATUS` <br> e.g., `filter_by_status free` |
| **Filter Interviews by date** | `filter_interviews_by_date YYYY-MM-DD` <br> e.g., `filter_interviews_by_date 2024-05-05` |
| **View Overall Status** | `view_overall_statistics` |
| **Exit** | `exit` |
| **Help** | `help` |

0 comments on commit 4846128

Please sign in to comment.