You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+43-17Lines changed: 43 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -227,7 +227,8 @@ Here are some things to take note of when using them!
227
227
* 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!
228
228
* Some fields are even optional, and they'll be shown with square brackets: `[a/ADDRESS]`.
229
229
* 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`.
231
232
232
233
The full list of commands and their formats can be found under the [Features](#features) section.
233
234
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!
Client whose names contain any of the given keywords will show up!
453
455
454
-
Format: `find KEYWORD [MORE_KEYWORDS]`
456
+
Format: `find KEYWORD [MORE_KEYWORDS]...`
455
457
456
458
* The search is case-insensitive. e.g `hans` will match `Hans`.
457
459
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`.
@@ -473,7 +475,7 @@ Examples:
473
475
474
476
### Adding notes to clients: `remark`
475
477
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.
477
479
478
480
Format: `remark INDEX [r/REMARK]`
479
481
@@ -485,6 +487,11 @@ Examples:
485
487
*`remark 2 r/Has 2 school-age children and 1 elderly dependent` adds a remark for the 2nd client in the client list.
486
488
*`remark 1` deletes the remark for the 1st client in the client list.
487
489
490
+
<boxtype="tip">
491
+
492
+
**Tip:** To remove a remark, you can use either `remark INDEX` or `remark INDEX r/`!
493
+
</box>
494
+
488
495
<br/>
489
496
<br/>
490
497
@@ -593,7 +600,7 @@ no appointments are scheduled will show up in the Last Met reminder display.
593
600
594
601
### Scheduling appointments : `schedule`
595
602
596
-
Got a new appointment or a postpone is needed?
603
+
Got a new appointment or a reschedule is needed?
597
604
You can schedule an appointment date and time you have with your client with `schedule`.
598
605
599
606
Format: `schedule INDEX d/DATETIME`
@@ -611,7 +618,14 @@ Examples:
611
618
612
619
<boxtype="info">
613
620
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
+
<boxtype="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.
615
629
</box>
616
630
617
631
@@ -647,6 +661,13 @@ ClientCare helps you to manage all your clients' policies and allows you to view
647
661
648
662

649
663
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
+
650
671
ClientCare offers the following commands to help you manage your clients' policies:
651
672
*[Adding a policy: `addpolicy`](#adding-a-policy-addpolicy)
652
673
*[Deleting a policy: `deletepolicy`](#deleting-a-policy-deletepolicy)
@@ -669,6 +690,11 @@ Format: `addpolicy INDEX n/POLICY_NAME i/POLICY_ID`
669
690
Examples:
670
691
*`addpolicy 1 n/Life i/1` adds a policy named `Life` with policy ID `1` to the 1st client in the client list.
671
692
*`addpolicy 3 n/Health i/2` adds a policy named `Health` with policy ID `2` to the 3rd client in the client list.
693
+
<boxtype="info">
694
+
695
+
**Note:** "001" and "1" are not considered duplicated policy IDs as different insurance companies have different
696
+
numbering schemes.
697
+
</box>
672
698
673
699
<br/>
674
700
<br/>
@@ -726,7 +752,7 @@ ClientCare data are saved in the hard disk automatically after any command that
726
752
727
753
### Editing the data file
728
754
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.
0 commit comments