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

Add notes on how email and dates are parsed #327

Merged
merged 3 commits into from
Nov 11, 2024
Merged

Add notes on how email and dates are parsed #327

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e40a398
Add notes on how email and dates are parsed
Nov 11, 2024
4ac3452
Fix EOF
Nov 11, 2024
035e0c6
Merge branch 'master' into add-notes-on-email-and-date-parsing
rxchell Nov 11, 2024
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
35 changes: 26 additions & 9 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,15 +320,17 @@ A **person** is a patient with several fields. The fields and their correspondin
|------------------|--------|----------|----------|--------------------------------------------------------|
| **Name** | `n/` | No | No | Only alphanumeric characters (Cannot start with space) |
| **Phone number** | `p/` | No | No | Positive integer of length 3-15 (Inclusive) |
| **Email** | `e/` | No | No | Refer to * |
| **Email** | `e/` | No | No | Refer to 1. below |
| **Address** | `a/` | No | No | Any value |
| **Status** | `st/` | No | No | Only alphanumeric characters |
| **Tag(s)** | `t/` | Yes | Yes | Only alphanumeric characters |

You can identify these patients uniquely by their **patient ID (PID)** for easy reference.

---
* Emails must have a local part containing alphanumeric characters and specific symbols (`+_.-`) (not at the start or end), followed by `@`, and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.
**Notes**

1. Emails must have a local part containing alphanumeric characters and specific symbols (`+_.-`) (not at the start or end), followed by `@`, and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.

<br>

Expand Down Expand Up @@ -421,6 +423,13 @@ Edits an existing patient in DocTrack.

</box>

<box type="info" light>

**Note:** When editing the name of a person, the person's appointments will not reflect the name change until a reload
of the application.

</box>

<box style="background: #eeeeee">

**Navigate back to the subsections here:**
Expand Down Expand Up @@ -538,16 +547,20 @@ Note that this will also clear the appointment data.

An **appointment** is defined by several fields. The fields and their corresponding prefixes are as follows:

| Field | Prefix | Optional | Multiple | Acceptable Inputs |
|---------------------|--------|----------|----------|-----------------------------------|
| **Person ID** | `i/` | No | No | Existing person ID |
| **Appointment Type**| `ty/` | No | No | Any value |
| **Date and Time** | `d/` | No | No | `yyyy-MM-dd HH:mm` |
| **Sickness** | `s/` | Yes | No | At least one alphabetic character |
| **Medicine** | `m/` | Yes | No | At least one alphabetic character |
| Field | Prefix | Optional | Multiple | Acceptable Inputs |
|---------------------|--------|----------|----------|---------------------------------------|
| **Person ID** | `i/` | No | No | Existing person ID |
| **Appointment Type**| `ty/` | No | No | Any value |
| **Date and Time** | `d/` | No | No | `yyyy-MM-dd HH:mm`. Refer to 1. below |
| **Sickness** | `s/` | Yes | No | At least one alphabetic character |
| **Medicine** | `m/` | Yes | No | At least one alphabetic character |

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

**Notes:**

1. The date and time inputs are resolved "smartly" - meaning that certain incorrect dates will be allowed, e.g. `2025-02-29 12:00` will be parsed as `2024-02-28 12:00`.

<br>

| Action | Format | Examples |
Expand Down Expand Up @@ -634,6 +647,8 @@ You can an existing appointment in appointment book.

<br>

<br>

<box style="background: #eeeeee">

**Navigate back to the subsections here:**
Expand Down Expand Up @@ -950,3 +965,5 @@ folder, you can copy these files to another location as a backup.
3. On **MacOS systems**, the bold fonts may appear slightly clipped.

<br>

4. Editing the name in the `edit person` command will not reflect the name change in the appointments until a reload of the application.