Skip to content

Commit

Permalink
Merge pull request #279 from darrentfy/update-UG
Browse files Browse the repository at this point in the history 
Add additional note in UG
  • Loading branch information
@quzhetao01
quzhetao01 authored Nov 13, 2023
2 parents 9782c0d + 3602f12 commit 1f6fa66
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,20 @@ All instructions executed in WellNUS generally use the following command format:
The list of all available prefixes and parameters, as well as constraints of each parameter, is shown in the table below.
To see a list of all command words, refer to the [Command Summary](#5-command-summary) section.
| Prefix | Parameter | Parameter Meaning | Example Usage | Parameter Constraints |
|-----------|-------------------|----------------------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **n/** | STUDENT_NAME | Name of student | n/Peter Johnson | STUDENT_NAME **must** only contain **alphabetical characters and spaces**, be **unique** up to **100 characters** long, and **cannot be blank**. |
| **c/** | CONTACT_NUMBER | Contact number of student | c/94738484 | CONTACT_NUMBER **must** only contain **numerical characters**, be **exactly 8 digits long** (without spaces) and **cannot be blank**. |
| **a/** | ADDRESS | Address of student | a/Blk 515 Choa Chu Kang Avenue 6 | ADDRESS can take any value up to **200 characters** long, and **cannot be blank**. |
| **r/** | RISK_LEVEL | Risk level assigned to student | r/high | RISK_LEVEL **must** be one of the following three values: **high**, **medium**, **low**. **Case-insensitive**. |
| **note/** | NOTE | Note associated with student | note/Struggles with 3rd grade math | NOTE can take any value up to **500 characters** long. |
| -- | STUDENT_INDEX | Index of student in the list | -- | STUDENT_INDEX **must** be a **positive integer** (i.e. 1, 2, 3, ...) up to the size of the student list. |
| **date/** | DATE | Date of appointment | date/2023-10-12 | DATE **must** be in the following format: `yyyy-MM-dd`. Specified date must be **within a year from the current date**. |
| **from/** | START_TIME | Start time of appointment | from/16:30 | START_TIME **must** be in the following format: `HH:mm`, in **24-hour format**. |
| **to/** | END_TIME | End time of appointment | to/17:30 | END_TIME **must** be in the following format: `HH:mm`, in **24-hour format**. |
| **d/** | DESCRIPTION | Description of appointment | d/3rd counselling session | DESCRIPTION can take any value up to **100 characters** long, and **cannot be blank**. |
| -- | APPOINTMENT_INDEX | Index of appointment in the list | -- | APPOINTMENT_INDEX **must** be a **positive integer** (i.e. 1, 2, 3, ...) up to the size of the appointment list. |
| **g/** | CATEGORY | Category of search | g/appointments | CATEGORY **must** be one of the following three values: **students**, **appointments**, **all**. |
| Prefix | Parameter | Parameter Meaning | Example Usage | Parameter Constraints |
|-----------|-------------------|----------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **n/** | STUDENT_NAME | Name of student | n/Peter Johnson | STUDENT_NAME **must** only contain **alphabetical characters and spaces**, be **unique** up to **100 characters** long, and **cannot be blank**. The first letter of each word **must** be in **upper case**, while every other letter **must** be in **lower case**. |
| **c/** | CONTACT_NUMBER | Contact number of student | c/94738484 | CONTACT_NUMBER **must** only contain **numerical characters**, be **exactly 8 digits long** (without spaces) and **cannot be blank**. |
| **a/** | ADDRESS | Address of student | a/Blk 515 Choa Chu Kang Avenue 6 | ADDRESS can take any value up to **200 characters** long, and **cannot be blank**. |
| **r/** | RISK_LEVEL | Risk level assigned to student | r/high | RISK_LEVEL **must** be one of the following three values: **high**, **medium**, **low**. **Case-insensitive**. |
| **note/** | NOTE | Note associated with student | note/Struggles with 3rd grade math | NOTE can take any value up to **500 characters** long. |
| -- | STUDENT_INDEX | Index of student in the list | -- | STUDENT_INDEX **must** be a **positive integer** (i.e. 1, 2, 3, ...) up to the size of the student list. |
| **date/** | DATE | Date of appointment | date/2023-10-12 | DATE **must** be in the following format: `yyyy-MM-dd`. Specified date must be **within a year from the current date**. |
| **from/** | START_TIME | Start time of appointment | from/16:30 | START_TIME **must** be in the following format: `HH:mm`, in **24-hour format**. |
| **to/** | END_TIME | End time of appointment | to/17:30 | END_TIME **must** be in the following format: `HH:mm`, in **24-hour format**. |
| **d/** | DESCRIPTION | Description of appointment | d/3rd counselling session | DESCRIPTION can take any value up to **100 characters** long, and **cannot be blank**. |
| -- | APPOINTMENT_INDEX | Index of appointment in the list | -- | APPOINTMENT_INDEX **must** be a **positive integer** (i.e. 1, 2, 3, ...) up to the size of the appointment list. |
| **g/** | CATEGORY | Category of search | g/appointments | CATEGORY **must** be one of the following three values: **students**, **appointments**, **all**. |
<div markdown="block" class="alert alert-info">
Expand Down Expand Up @@ -457,6 +457,12 @@ WellNUS data is saved automatically as a JSON file `[JAR file location]/data/add
<div markdown="span" class="alert alert-warning">
:exclamation: **Caution:**
If your changes to the data file makes its format invalid, WellNUS 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.
The following scenarios will render the data file invalid:
* File contains invalid or missing parameters, see `Parameter Constraints` under the [Command Format](#13-about-the-command-format) section
* File contains duplicate `Students` and `Appointments`
* File contains overlapping `Appointments`, or `Appointments` without a corresponding `Student`
* File is not in proper JSON format, you may refer to [this guide](https://json.org/example.html)
</div>
### 2.5 Tracking TODOS `[Coming soon]`
Expand Down

0 comments on commit 1f6fa66

Please sign in to comment.