Skip to content

Commit

Permalink
Update user guide to switch relevant user to you
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryanlimdx
ryanlimdx committed Apr 15, 2024
1 parent cfcdafe commit eac81ea
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Back to [Table of Contents](#table-of-contents)
<br>
<div markdown="block" class="alert alert-info"> :information_source:
**Ensure you have the necessary permissions to execute commands.** <br>
_For Windows Users, running the command prompt as an administrator may be
_For Windows users, running the command prompt as an administrator may be
required. If you encounter permission issues on Mac/Linux, you might need to use `chmod +x nab.jar` to make the file
executable._
</div>
Expand Down Expand Up @@ -176,7 +176,7 @@ records.

:information_source: <b>Notes about the command format:</b><br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
* Words in `UPPER_CASE` are the parameters to be supplied by you.<br>
e.g. in `add n\NAME`, `NAME` is a parameter which can be used as `add n\John Doe`.

* Parameters in square brackets are optional.<br>
Expand All @@ -197,16 +197,16 @@ as space characters surrounding line-breaks may be omitted when copied over to t

### Parameters for commands

| Parameter | Description | Valid Input |
|--------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **INDEX** | The position of a patient in the displayed list. | Positive integers (i.e. from 1 onwards) e.g., `1`, `2`, `3`. Should not be larger than the length of displayed list. |
| **NAME** | The name of a patient. | Common names are generally accepted. Names should be alphanumeric, with the inclusion of the following special characters: whitespaces, `'`, `-`, `,` and `/`. e.g., `John Doe`, `Nagaratnam s/o Suppiah`. <br><br> **Name should be limited to 40 characters. Longer names may not display fully in the GUI.** |
| **IC_NUMBER** | The IC number (NRIC/ FIN) of the patient. | A unique identification number in the format of a capital letter, followed by a 7-digit number, and ending with a capital letter. e.g., `T1234567Z`. Note that while the platform performs some level of IC validation, it is up to the user to ensure that the IC is accurate. |
| **DATE_OF_BIRTH** | The date of birth of a patient. | The date of birth of the patient must be in the format dd/MM/yyyy. e.g., `21/03/2000`. Date entered can only be up till the current date inclusive. No negative values or values exceeding the format provided (for e.g., having a year `99999` despite there being only `yyyy`) is allowed. Note that while the platform performs some level of date validation, it is up to the user to ensure that the date is accurate (not in the future, or impossible dates such as 30th February etc). |
| **ADMISSION_DATE** | The date a patient was admitted to the ward. | The admission date of the patient must be in the format of dd/MM/yyyy. e.g., `21/03/2022`. Date entered can only be up till the current date inclusive. No negative values or values exceeding the format provided (for e.g., having a year `99999` despite there being only `yyyy`) is allowed. Note that while the platform performs some level of date validation, it is up to the user to ensure that the date is accurate (not in the future, impossible dates such as 30th February etc). |
| **WARD** | The ward where a patient is located. | An alphanumeric string, e.g., `A1`. Note that special characters are not allowed, and you can work around this issue by utilising [camelCase](#glossary) e.g., `wardA` or [PascalCase](#glossary) e.g., `WardA`. |
| **REMARK** | Optional remark about a patient. | Any string input, e.g., `Patient is an amputee`. |
| **TAG** | Optional tag to categorize a patient by health condition or other descriptors. | An alphanumeric string for each tag, e.g., `Diabetes`. Note that special characters are not allowed, and you can work around this issue by omitting special characters, utilising [camelCase](#glossary) e.g., `fallRisk` or [PascalCase](#glossary) e.g., `FallRisk`. <br><br> **Tags should be limited to 15 characters. Longer tags may not display fully in the GUI.** |
| Parameter | Description | Valid Input |
|--------------------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **INDEX** | The position of a patient in the displayed list. | Positive integers (i.e. from 1 onwards) e.g., `1`, `2`, `3`. Should not be larger than the length of displayed list. |
| **NAME** | The name of a patient. | Common names are generally accepted. Names should be alphanumeric, with the inclusion of the following special characters: whitespaces, `'`, `-`, `,` and `/`. e.g., `John Doe`, `Nagaratnam s/o Suppiah`. <br><br> **Name should be limited to 40 characters. Longer names may not display fully in the GUI.** |
| **IC_NUMBER** | The IC number (NRIC/ FIN) of the patient. | A unique identification number in the format of a capital letter, followed by a 7-digit number, and ending with a capital letter. e.g., `T1234567Z`. Note that while the platform performs some level of IC validation, you should ensure that the IC is accurate. |
| **DATE_OF_BIRTH** | The date of birth of a patient. | The date of birth of the patient must be in the format dd/MM/yyyy. e.g., `21/03/2000`. Date entered can only be up till the current date inclusive. No negative values or values exceeding the format provided (for e.g., having a year `99999` despite there being only `yyyy`) is allowed. Note that while the platform performs some level of date validation, you should ensure that the date is accurate (not in the future, or impossible dates such as 30th February etc). |
| **ADMISSION_DATE** | The date a patient was admitted to the ward. | The admission date of the patient must be in the format of dd/MM/yyyy. e.g., `21/03/2022`. Date entered can only be up till the current date inclusive. No negative values or values exceeding the format provided (for e.g., having a year `99999` despite there being only `yyyy`) is allowed. Note that while the platform performs some level of date validation, you should ensure that the date is accurate (not in the future, impossible dates such as 30th February etc). |
| **WARD** | The ward where a patient is located. | An alphanumeric string, e.g., `A1`. Note that special characters are not allowed, and you can work around this issue by utilising [camelCase](#glossary) e.g., `wardA` or [PascalCase](#glossary) e.g., `WardA`. |
| **REMARK** | Optional remark about a patient. | Any string input, e.g., `Patient is an amputee`. |
| **TAG** | Optional tag to categorize a patient by health condition or other descriptors. | An alphanumeric string for each tag, e.g., `Diabetes`. Note that special characters are not allowed, and you can work around this issue by omitting special characters, utilising [camelCase](#glossary) e.g., `fallRisk` or [PascalCase](#glossary) e.g., `FallRisk`. <br><br> **Tags should be limited to 15 characters. Longer tags may not display fully in the GUI.** |

<div markdown="block" class="alert alert-info">
:information_source: <b>Note:</b>
Expand Down

0 comments on commit eac81ea

Please sign in to comment.