Skip to content

Commit b10b757

Browse files
authored
Merge pull request #175 from yorklim/UserGuide
Update UG to include missing information
2 parents 5ba5e7c + 2d8ffa2 commit b10b757

File tree

1 file changed

+43
-17
lines changed

1 file changed

+43
-17
lines changed

docs/UserGuide.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,8 @@ Here are some things to take note of when using them!
227227
* Fields often have a prefix in front of them. For example, name has `n/` and date has `d/`. The command format will show what field a prefix is referring to in uppercase, like `n/NAME`, in case you forget!
228228
* Some fields are even optional, and they'll be shown with square brackets: `[a/ADDRESS]`.
229229
* Fields that have a trailing ellipsis behind them like `[t/TAG]...`, meaning you can use multiple of them, so you can have both `t/friend t/drives` in one command.
230-
* Not all commands have fields! For example, when clearing your client list, a simple command keyword of `clear` will do! There is no need to have a field such as `clear 1` or `clear 2`.
230+
* Not all commands take in fields! For example, when clearing your client list, a simple command keyword of `clear` will do! If any extraneous fields are present for these commands, they will be ignored.
231+
For example, `clear 1` and `clear all` will both be interpreted as `clear`.
231232

232233
The full list of commands and their formats can be found under the [Features](#features) section.
233234
Alternatively, [Command Summary](#command-summary) has all of them under one page for a quick reference.
@@ -261,7 +262,7 @@ Let's boot up ClientCare and get started!
261262

262263
Type the following into the Command Input:
263264

264-
`add n/James Wee c/98765432 e/james@hotmail.com a/East Coat Blk 112 d/1998-05-25 p/vip`
265+
`add n/James Wee c/98765432 e/james@hotmail.com a/East Coast Blk 112 d/1998-05-25 p/vip`
265266

266267
![addclient](images/ug/addclient.png =600x)
267268

@@ -285,7 +286,8 @@ Let's type the following command into the Command Input:
285286

286287
<box type="info">
287288

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

290292
</box>
291293

@@ -361,15 +363,15 @@ All other fields (with the exception of tags) cannot have duplicate fields. For
361363

362364
Fields usage for client details:
363365

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

374376
Examples:
375377
* `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`
@@ -451,7 +453,7 @@ Examples:
451453
You can look for a client with `find`.
452454
Client whose names contain any of the given keywords will show up!
453455

454-
Format: `find KEYWORD [MORE_KEYWORDS]`
456+
Format: `find KEYWORD [MORE_KEYWORDS]...`
455457

456458
* The search is case-insensitive. e.g `hans` will match `Hans`.
457459
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`.
@@ -473,7 +475,7 @@ Examples:
473475

474476
### Adding notes to clients: `remark`
475477

476-
You can add notes to each client with `remark`.
478+
You can add notes to each client with `remark`. If a current remark exists, it will be replaced with the new remark.
477479

478480
Format: `remark INDEX [r/REMARK]`
479481

@@ -485,6 +487,11 @@ Examples:
485487
* `remark 2 r/Has 2 school-age children and 1 elderly dependent` adds a remark for the 2nd client in the client list.
486488
* `remark 1` deletes the remark for the 1st client in the client list.
487489

490+
<box type="tip">
491+
492+
**Tip:** To remove a remark, you can use either `remark INDEX` or `remark INDEX r/`!
493+
</box>
494+
488495
<br/>
489496
<br/>
490497

@@ -593,7 +600,7 @@ no appointments are scheduled will show up in the Last Met reminder display.
593600

594601
### Scheduling appointments : `schedule`
595602

596-
Got a new appointment or a postpone is needed?
603+
Got a new appointment or a reschedule is needed?
597604
You can schedule an appointment date and time you have with your client with `schedule`.
598605

599606
Format: `schedule INDEX d/DATETIME`
@@ -611,7 +618,14 @@ Examples:
611618

612619
<box type="info">
613620

614-
**Note:** ClientCare will not allow you to schedule with someone from a past date.
621+
**Note:** ClientCare will only allow you to create a schedule with someone with a valid future date and time.
622+
</box>
623+
624+
<box type="tip">
625+
626+
**Tip:** ClientCare currently only keeps track of a single schedule with a client at a time.
627+
If you have multiple appointments, you can use the `schedule` command to update the appointment date and time to the
628+
next appointment after the most recent one is done.
615629
</box>
616630

617631

@@ -647,6 +661,13 @@ ClientCare helps you to manage all your clients' policies and allows you to view
647661

648662
![Policies panel'](images/ug/policies.png =600x)
649663

664+
You can click on "Policy ID" and "Policy Name" to sort the policies by their respective field. Clicking once will sort
665+
in ascending order, and clicking again will sort in descending order.
666+
667+
**Note:** Sorting for both "Policy ID" and "Policy Name" will follow lexigraphical order.
668+
</box>
669+
670+
650671
ClientCare offers the following commands to help you manage your clients' policies:
651672
* [Adding a policy: `addpolicy`](#adding-a-policy-addpolicy)
652673
* [Deleting a policy: `deletepolicy`](#deleting-a-policy-deletepolicy)
@@ -669,6 +690,11 @@ Format: `addpolicy INDEX n/POLICY_NAME i/POLICY_ID`
669690
Examples:
670691
* `addpolicy 1 n/Life i/1` adds a policy named `Life` with policy ID `1` to the 1st client in the client list.
671692
* `addpolicy 3 n/Health i/2` adds a policy named `Health` with policy ID `2` to the 3rd client in the client list.
693+
<box type="info">
694+
695+
**Note:** "001" and "1" are not considered duplicated policy IDs as different insurance companies have different
696+
numbering schemes.
697+
</box>
672698

673699
<br/>
674700
<br/>
@@ -726,7 +752,7 @@ ClientCare data are saved in the hard disk automatically after any command that
726752

727753
### Editing the data file
728754

729-
ClientCare data is automatically saved as a file `[ClientCare file location]/data/clientcare.json`. Advanced users are welcome to update data directly by editing that data file.
755+
ClientCare data is automatically saved as a file `[ClientCare file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
730756

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

0 commit comments

Comments
 (0)