Skip to content

Commit 7727f3d

Browse files
ReganChoyReganChoy
authored
Merge pull request #199 from yorklim/UserGuide
Fix spacing issue and command introduction
2 parents a86249f + cf9200c commit 7727f3d

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎docs/UserGuide.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Let's learn the language that ClientCare speaks in.
205205
<br/>
206206

207207
### ClientCare commands
208-
A ClientCare command has the following parts:
208+
A ClientCare command can be made up of the following parts:
209209

210210
![Command Structure](images/ug/commandStructure.png =450x)
211211

@@ -430,15 +430,15 @@ All other fields (except for tags) cannot have duplicate fields. For example, `c
430430

431431
Fields usage for client details:
432432

433-
| Field | Usage | Example |
434-
|------------------|-----------------------------------------------------------------------------------------------|---------------------------------------|
435-
| 'n/NAME' | All names in the system must be unique and names are case sensitive | `n/John Doe` |
436-
| 'c/PHONE_NUMBER' | Phone numbers should only contain numbers, and it should be at least 3 digits long | `c/98765432` |
437-
| 'e/EMAIL' | Email should be in the format of `local-part@domain` | `e/johndoe@email.com` |
438-
| 'a/ADDRESS' | Address can take any text value | `a/311, Clementi Ave 2, #02-25` |
439-
| 'd/BIRTHDAY' | Birthday should be in the format of `YYYY-MM-DD` | `d/1990-01-01` |
440-
| '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` |
441-
| 't/TAG' | Tags can be any text value | `t/friends` |
433+
| Field | Usage | Example |
434+
|------------------|-----------------------------------------------------------------------------------------------|--------------------------------------|
435+
| 'n/NAME' | All names in the system must be unique and names are case sensitive | `n/John Doe` |
436+
| 'c/PHONE_NUMBER' | Phone numbers should only contain numbers, and it should be at least 3 digits long | `c/98765432` |
437+
| 'e/EMAIL' | Email should be in the format of `local-part@domain` | `e/johndoe@email.com` |
438+
| 'a/ADDRESS' | Address can take any text value | `a/311, Clementi Ave 2, #02-25` |
439+
| 'd/BIRTHDAY' | Birthday should be in the format of `YYYY-MM-DD` | `d/1990-01-01` |
440+
| '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` |
441+
| 't/TAG' | Tags can be any text value | `t/friends` |
442442

443443
Examples:
444444
* `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`
@@ -474,7 +474,7 @@ You have now added James Wee to our Client List! ClientCare shows a success mess
474474

475475
<div style="page-break-after: always;"></div>
476476

477-
### Deleting a client : `delete`
477+
### Deleting a client: `delete`
478478

479479
While you can have new clients, it is also possible to lose existing clients. Hopefully, that does not happen often!
480480
You can delete a specified client from the client list with `delete`.
@@ -507,7 +507,7 @@ You have now removed David Li from our client list! ClientCare shows a success m
507507

508508
<div style="page-break-after: always;"></div>
509509

510-
### Editing a client : `edit`
510+
### Editing a client: `edit`
511511

512512
Client information is always changing! If you ever need to update your client's particulars, you can edit an existing client with `edit`.
513513

@@ -540,7 +540,7 @@ You have updated James' name! ClientCare shows a success message in the Feedback
540540
![success_edit](images/ug/success_edit.png =600x)
541541

542542

543-
### Listing all clients : `list`
543+
### Listing all clients: `list`
544544

545545
After applying certain filter or finding commands, you can see all your clients again with `list`.
546546

@@ -565,7 +565,7 @@ All your clients are now listed on the client list! ClientCare shows a success m
565565

566566
<div style="page-break-after: always;"></div>
567567

568-
### Viewing a client : `view`
568+
### Viewing a client: `view`
569569

570570
There are times when you would want to view a client's details and his policies in detail. You can do so with `view`.
571571

@@ -677,7 +677,7 @@ ClientCare shows a success message in the Feedback Display too.
677677

678678
<div style="page-break-after: always;"></div>
679679

680-
### Clearing all entries : `clear`
680+
### Clearing all entries: `clear`
681681

682682
Do you want to clear the sample clients from ClientCare or start from scratch?
683683
You can clear all the clients from the client list with `clear`.
@@ -708,7 +708,7 @@ ClientCare shows a success message in the Feedback Display too.
708708

709709
<div style="page-break-after: always;"></div>
710710

711-
### Sorting the client list : `sort`
711+
### Sorting the client list: `sort`
712712

713713
Want to see all your VIP clients first? You can sort the client list with `sort`:
714714

@@ -767,7 +767,7 @@ ClientCare offers the following commands to help you manage your schedule:
767767

768768
<div style="page-break-after: always;"></div>
769769

770-
### Updating last met : `met`
770+
### Updating last met: `met`
771771

772772
Just met up with a client? You can update the last met date you had with your client with `met`.
773773

@@ -818,7 +818,7 @@ ClientCare shows a success message in the Feedback Display too.
818818

819819
<div style="page-break-after: always;"></div>
820820

821-
### Setting last met overdue period : `set`
821+
### Setting last met overdue period: `set`
822822

823823
Feel that 90 days is too short or long of a period? You can set your own desired overdue duration with `set`.
824824

@@ -849,7 +849,7 @@ ClientCare shows a success message in the Feedback Display too.
849849

850850
<div style="page-break-after: always;"></div>
851851

852-
### Scheduling appointments : `schedule`
852+
### Scheduling appointments: `schedule`
853853

854854
Got a new appointment or a rescheduling is needed?
855855
You can schedule an appointment date and time you have with your client with `schedule`.
@@ -900,7 +900,7 @@ ClientCare shows a success message in the Feedback Display too.
900900

901901
<div style="page-break-after: always;"></div>
902902

903-
### Marking appointments : `mark`
903+
### Marking appointments: `mark`
904904

905905
Done with or need to cancel an appointment?
906906
You can mark an appointment as completed with `mark`.
@@ -963,7 +963,7 @@ ClientCare offers the following commands to help you manage your clients' polici
963963
<br/>
964964
<div style="page-break-after: always;"></div>
965965

966-
### Adding a policy : `addpolicy`
966+
### Adding a policy: `addpolicy`
967967

968968
Just closed a deal?
969969
You can add a policy to a client with `addpolicy`.
@@ -1008,7 +1008,7 @@ Roy's new policy has been added! ClientCare shows a success message in the Feedb
10081008

10091009
<div style="page-break-after: always;"></div>
10101010

1011-
### Deleting a policy : `deletepolicy`
1011+
### Deleting a policy: `deletepolicy`
10121012

10131013
Wrong policy or a policy just matured?
10141014
You can delete a policy from a client with `deletepolicy`.
@@ -1041,7 +1041,7 @@ Roy's policy with ID 4123 has been deleted! ClientCare shows a success message i
10411041

10421042
## Miscellaneous
10431043

1044-
### Viewing help : `help`
1044+
### Viewing help: `help`
10451045

10461046
You can look for help by typing `help`.
10471047
You will see a message explaining how to access the help page.
@@ -1053,7 +1053,7 @@ Format: `help`
10531053
<br/>
10541054
<br/>
10551055

1056-
### Exiting the program : `exit`
1056+
### Exiting the program: `exit`
10571057

10581058
Done with all your work? You can exit the program with `exit`.
10591059

@@ -1076,7 +1076,7 @@ ClientCare data is automatically saved as a file `[ClientCare file location]/dat
10761076

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

1079-
**CAUTION**: If your changes to the data file makes its format invalid, ClientCare will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br/>
1079+
**CAUTION**: If your changes to the data file makes its format invalid, ClientCare will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br/>
10801080
Furthermore, certain edits can cause the ClientCare to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
10811081
</box>
10821082

@@ -1230,7 +1230,7 @@ This is the number which is assigned to a particular Client. For example, the 3r
12301230
8. **Integer**
12311231

12321232
This is a whole number. No decimal or fractions is allowed.
1233-
-7 , -1, 0, 7, 14 are all integers. 3.14 or 5/8 are not integers.
1233+
-7, -1, 0, 7, 14 are all integers. 3.14 or 5/8 are not integers.
12341234

12351235
9. **Address**
12361236

@@ -1292,8 +1292,8 @@ If a text is truncated in the display, this means that the full text has been sh
12921292
| [**Sort**](#sorting-the-client-list-sort) | `sort CRITERIA o/ORDER` <br/> e.g. `sort priority o/desc` |
12931293
| [**LastMet**](#updating-last-met-met) | `met INDEX d/DATE`<br/> e.g. `met 2 d/2023-05-07` |
12941294
| [**Set**](#setting-last-met-overdue-period-set) | `set NUMBER_OF_DAYS`<br/> e.g. `set 5` |
1295-
| [**Schedule**](#scheduling-appointments-schedule) | `schedule INDEX d/DATETIME`<br/> e.g. `schedule 2 d/2023-05-07 22:00` | |
1296-
| [**Mark**](#marking-appointments-mark) | `mark INDEX`<br/> e.g. `mark 2` | |
1295+
| [**Schedule**](#scheduling-appointments-schedule) | `schedule INDEX d/DATETIME`<br/> e.g. `schedule 2 d/2023-05-07 22:00` |
1296+
| [**Mark**](#marking-appointments-mark) | `mark INDEX`<br/> e.g. `mark 2` |
12971297
| [**Add Policy**](#adding-a-policy-addpolicy) | `addpolicy INDEX n/POLICY_NAME i/POLICY_ID` <br/> e.g. `addpolicy 1 n/Life i/1` |
12981298
| [**Delete Policy**](#deleting-a-policy-deletepolicy) | `deletepolicy INDEX i/POLICY_ID` <br/> e.g. `deletepolicy 1 i/1` |
12991299
| [**Help**](#viewing-help-help) | `help` |

0 commit comments

Comments
 (0)