Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update user guide with the addnote logic #269

Merged
merged 1 commit into from
Apr 14, 2024
Merged

Update user guide with the addnote logic #269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,9 +739,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 @@ -866,16 +868,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
Loading