Skip to content

Commit

Permalink
Fix or update minor add ins in ug
Browse files Browse the repository at this point in the history
  • Loading branch information
@solomonng2001
solomonng2001 committed Apr 13, 2024
1 parent 8999796 commit b83b263
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ Let's type the following command into the Command Input:

<box type="info">

**Note:** Since you cannot schedule an appointment for a date and time that has passed or that exact moment,
**Note:** Since you cannot schedule an appointment for a date and time that has passed for that exact moment,
do change the date field as needed.

</box>
Expand Down Expand Up @@ -430,15 +430,15 @@ All other fields (with the exception of tags) cannot have duplicate fields. For

Fields usage for client details:

| Field | Usage | Example |
|------------------|------------------------------------------------------------------------------------------|---------------------------------|
| 'n/NAME' | All names in the system must be unique | `n/John Doe` |
| 'c/PHONE_NUMBER' | Phone numbers should only contain numbers, and it should be at least 3 digits long | `c/98765432` |
| 'e/EMAIL' | Email should be in the format of `local-part@domain` | `e/johndoe@email.com` |
| 'a/ADDRESS' | Address can take any text value | `a/311, Clementi Ave 2, #02-25` |
| 'd/BIRTHDAY' | Birthday should be in the format of `YYYY-MM-DD` | `d/1990-01-01` |
| 'p/PRIORITY' | Priority can be `low`, `medium`, `high`, `vip`, or `l`, `m`, `h`, `v` <br/>(Case Insensitive) | `p/medium`, `p/mEdIuM` ,`p/m` |
| 't/TAG' | Tags can be any text value | `t/friends` |
| Field | Usage | Example |
|------------------|-----------------------------------------------------------------------------------------------|---------------------------------------|
| 'n/NAME' | All names in the system must be unique and names are case sensitive | `n/John Doe` |
| 'c/PHONE_NUMBER' | Phone numbers should only contain numbers, and it should be at least 3 digits long | `c/98765432` |
| 'e/EMAIL' | Email should be in the format of `local-part@domain` | `e/johndoe@email.com` |
| 'a/ADDRESS' | Address can take any text value | `a/311, Clementi Ave 2, #02-25` |
| 'd/BIRTHDAY' | Birthday should be in the format of `YYYY-MM-DD` | `d/1990-01-01` |
| 'p/PRIORITY' | Priority can be `low`, `medium`, `high`, `vip`, or `l`, `m`, `h`, `v` <br/>(Case Insensitive) | `p/medium`, `p/MEDIUM` ,`p/m`, `p/M` |
| 't/TAG' | Tags can be any text value | `t/friends` |

Examples:
* `add n/John Doe c/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 d/1990-01-01 p/low t/friends t/owesMoney`
Expand Down Expand Up @@ -546,6 +546,7 @@ You have updated James' name! ClientCare shows a success message in the Feedback
After applying certain filter or finding commands, you can see all your clients again with `list`.

Format: `list`
* Extraneous fields will be ignored. For example, `list all` will be interpreted as `list`.

**Before Command:**

Expand Down Expand Up @@ -577,7 +578,7 @@ Format: `view INDEX`

Examples:
* `list` followed by `view 2` views the 2nd client in the client list.
* `find Betsy` followed by `view 1` view the 1st client in the results of the `find` command.
* `find Betsy` followed by `view 1` views the 1st client in the results of the `find` command.

**Before Command:**

Expand Down Expand Up @@ -627,7 +628,7 @@ Type the following into the Command Input: `find james`

**After Command:**

All clients with the name "james" will now show up in the client list.
All clients whose name contains the word "james" will now show up in the client list.
ClientCare shows a success message in the Feedback Display too.

![success_edit](images/ug/success_find.png =600x)
Expand Down Expand Up @@ -657,7 +658,7 @@ Examples:

<box type="info">

**Note:** ClientCare allows you to put up to 550 characters for `REMARK` before characters are truncated in fullscreen.
**Note:** ClientCare allows you to put up to about 550 characters for `REMARK` before characters are truncated in fullscreen. The limit might vary depending on your screen size, so do check if the remark is fully displayed.
</box>

**Before Command:**
Expand All @@ -683,6 +684,7 @@ Do you want to clear the sample clients from ClientCare or start from scratch?
You can clear all the clients from the client list with `clear`.

Format: `clear`
* Extraneous fields will be ignored. For example, `clear all` will be interpreted as `clear`.

<box type="warning" theme="danger" icon=":warning:">

Expand Down Expand Up @@ -747,7 +749,7 @@ of your clients' birthday!

![Reminders panel'](images/ug/reminders.png =600x)

**Last Met Display:** Shows you the list of clients you have not met in a while (that do not have an active schedule). You can set the overdue period using [`set`](#setting-last-met-overdue-period-set), by default is 90 days.
**Last Met Display:** Shows you the list of clients you have not met in a while (that do not have an active schedule). You can set the overdue period using [`set`](#setting-last-met-overdue-period-set), which by default is 90 days.

**Schedule Display:** Shows you the list of clients you have an appointment with.

Expand Down Expand Up @@ -987,7 +989,7 @@ numbering schemes.
<box type="info">

**Note:** Although most policy IDs will be up to 25 digits,
ClientCare allows you to put up to 40 digits long before values are truncated in fullscreen.
ClientCare allows you to put up to about 40 digits long before values are truncated in fullscreen. The limit might vary depending on your screen size, so do check if the remark is fully displayed.
</box>

**Before Command:**
Expand Down

0 comments on commit b83b263

Please sign in to comment.