Skip to content

Commit

Permalink
Merge pull request #325 from zaidansani/add-visuals-for-information-c…
Browse files Browse the repository at this point in the history
…ard-UG

Add example of a person and appointment
  • Loading branch information
rxchell authored Nov 11, 2024
2 parents 71dba04 + 4703989 commit f1c4f07
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,13 @@ A **person** is a patient with several fields. The fields and their correspondin
| **Tag(s)** | `t/` | Yes | Yes | Only alphanumeric characters |

You can identify these patients uniquely by their **patient ID (PID)** for easy reference.
The PID can be seen at the top of their information card.

<br><sbr>

<img src="images/personexample.png" width="500">

<br><sbr>

---
**Notes**
Expand Down Expand Up @@ -556,6 +563,18 @@ An **appointment** is defined by several fields. The fields and their correspond
| **Sickness** | `s/` | Yes | No | At least one alphabetic character |
| **Medicine** | `m/` | Yes | No | At least one alphabetic character |

You can identify these appointments uniquely by their **Appointment ID (AID)** for easy reference.
The AID can be seen at the top of their information card.

<br><sbr>

<img src="images/appointmentexample.png" width="500">

<br><sbr>

The number indicated beside the appointment name is the PID of the person who has the appointment.


You can manage the appointments through different commands, which can be seen in the table below:

**Notes:**
Expand Down
Binary file added docs/images/appointmentexample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/personexample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f1c4f07

Please sign in to comment.