Skip to content

Commit

Permalink
Merge pull request #269 from tengcharmaine/addnotelogic
Browse files Browse the repository at this point in the history 
Update user guide with the addnote logic
  • Loading branch information
@Jayne1010
Jayne1010 authored Apr 14, 2024
2 parents 4d4aae8 + ae6dd1f commit d836aa9
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -752,9 +752,11 @@ Examples:
- An alternative to check if the note is updated correctly, use the `find` command. (See [find](#locating-persons-by-ic-number-find) command)
On the patient list panel, the list will be filtered to that specific patient; On the patient notes panel, the updated notes of the specific patient will be shown.

- If you'd like to add empty line(s), you can use a ` ` (i.e. a normal space) as the note's contents 1 or more times.
- If you'd like to add empty line(s), you can add an empty note (i.e. `addnote T0123456A n\` 1 or more times.
Do note that the person list panel will not display the empty line(s) unless there is a note with other characters before and after the note with just spaces.

- The space characters at the start and end of the note are stripped during the execution of this command. So `addnote T0123456A n\ Diabetes` and `addnote T0123456A n\Diabetes` give the same note of `Diabetes`.

</div>

<span class="generated-only">[&uarr; Back to Top](#welcome-to-clinicmate)</span>
Expand Down Expand Up @@ -879,16 +881,16 @@ These descriptions will help you understand the key terms used in ClinicMate.

### Parameters Description

| Parameter | Description | Constraints |
|-----------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `NAME` | Name of the patient. | Only contain alphanumeric characters and spaces, and should not be blank. |
| `PHONE` | Phone number of the patient. | Only contain numbers, be at least 3 digits. Should not be blank. |
| `EMAIL` | Email of the patient. | Should be in the format of `local-part@domain` and should not be blank. |
| Parameter | Description | Constraints |
|-----------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| `NAME` | Name of the patient. | Only contain alphanumeric characters and spaces, and should not be blank. |
| `PHONE` | Phone number of the patient. | Only contain numbers, be at least 3 digits. Should not be blank. |
| `EMAIL` | Email of the patient. | Should be in the format of `local-part@domain` and should not be blank. |
| `IC_NUMBER` | IC number of the patient. | Case-insensitive and should not be blank. It should start with one letter (S, F, G or M), followed by 7 digits and 1 letter behind. |
| `AGE` | Age of the patient. | Only contain numbers, and should not be blank. |
| `SEX` | Sex of the patient. | Case-insensitive and should not be blank. Only accepts `m`, `f`, `M`, `F` as inputs. |
| `ADDRESS` | Address of the patient. | Case-insensitive and should not be blank. |
| `NOTE` | Note of the patient | Case-insensitive and should not be blank. |
| `AGE` | Age of the patient. | Only contain numbers, and should not be blank. |
| `SEX` | Sex of the patient. | Case-insensitive and should not be blank. Only accepts `m`, `f`, `M`, `F` as inputs. |
| `ADDRESS` | Address of the patient. | Case-insensitive and should not be blank. |
| `NOTE` | Note of the patient | Case-insensitive and can be blank. |


<div markdown="block" class="alert alert-info">
Expand Down

0 comments on commit d836aa9

Please sign in to comment.