Skip to content

Commit

Permalink
Merge pull request #204 from Jolonauh/user-guide
Browse files Browse the repository at this point in the history 
Update user guide
  • Loading branch information
@Rishit02
Rishit02 authored Apr 15, 2024
2 parents 370ae38 + b0fe8c3 commit 302d19f
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ _This command adds a new client to your client list._

<box type="tip" seamless>

**Tip:** You can use spaces in place of special characters in the names you want to enter.
**Tip:** You can use spaces in place of special characters in the names you want to enter (for the NAME or NEXT_OF_KIN parameters).

</box>
</markdown>
Expand Down Expand Up @@ -401,17 +401,23 @@ _This command helps update existing client's information in the client list in t
<panel header="Parameter Descriptions and Remarks" alt="Parameters" minimized>
<markdown>

| Parameter | Description | Remarks |
|-----------------|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| u/EXISTING_USER | Name of client that you want to update | Name must be unique, alphanumeric and case-sensitive. It is also compulsory |
| n/NAME | New name of client that you want to add | Name must be unique, alphanumeric and case-sensitive |
| p/PHONE_NUMBER | Phone Number of client that you want to add | Phone number should only contain numbers |
| e/EMAIL | Email of client that you want to add | Emails should be of the format local-part@domain and adhere to the following constraints:<br/>1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.<br/>. This is followed by a '@' and then a domain name. The domain name is made up of domain labels separated by periods.<br/>The domain name must:<br/>- end with a domain label at least 2 characters long<br/>- have each domain label start and end with alphanumeric characters<br/>- have each domain label consist of alphanumeric characters, separated only by hyphens, if any. |
| a/ADDRESS | Address of client that you want to add | - |
| k/NEXT_OF_KIN | Next of Kin details of client that you want to add | Name must be alphanumeric |
| d/DESCRIPTION | Description of client that you want to add | Description should not be blank |
| t/TAG | Tag to identify the client | Multiple tags can be specified, but they must each be prefixed |
| Parameter | Description | Remarks |
|-----------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| u/EXISTING_USER | Name of client that you want to update | Name must be unique, alphanumeric and case-sensitive. It is also compulsory |
| n/NAME | New name of client that you want to add | Name must be unique, alphanumeric and case-sensitive |
| p/PHONE_NUMBER | Phone Number of client that you want to add | Phone number should only contain numbers |
| e/EMAIL | Email of client that you want to add | Emails should be of the format local-part@domain and adhere to the following constraints:<br/>1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.<br/>2. This is followed by a '@' and then a domain name. The domain name is made up of one or more domain labels separated by periods.<br/>The domain name must:<br/> - end with a domain label at least 2 characters long<br/> - have each domain label start and end with alphanumeric characters<br/> - have each domain label consist of alphanumeric characters, separated only by hyphens, if any.<br/> - Valid emails include: [email protected], felix@asd, [email protected] |
| a/ADDRESS | Address of client that you want to add | - |
| k/NEXT_OF_KIN | Next of Kin details of client that you want to add | Name must be alphanumeric |
| d/DESCRIPTION | Description of client that you want to add | Description should not be blank |
| t/TAG | Tag to identify the client | Multiple tags can be specified, but they must each be prefixed |
</markdown>

<box type="tip" seamless>

**Tip:** You can use spaces in place of special characters in the names you want to enter (for the NAME or NEXT_OF_KIN parameters).

</box>
</panel>

&nbsp;
Expand Down Expand Up @@ -491,12 +497,17 @@ Click [here](#table-of-contents) to return to the table of contents!

### Finding clients: `find`

_This command allows you to find a specific client in your client list by any of a client's parameters_
_This command allows you to find clients in your client list by specifying client parameters that you are interested in. _

**Format:** `find [n/NAME]… [a/KEYWORD]… [e/KEYWORD]… [t/KEYWORD]… [k/KEYWORD]… [d/KEYWORD]… [p/KEYWORD]…`

<box type="info">

**Note:** At least one optional parameter has to be given.
</box>

<box type="info">

**Note:** This command finds clients that match any of your search terms.
</box>

Expand Down Expand Up @@ -528,7 +539,7 @@ Let's say your client list contains the following clients:

<div class="image-container" style="display: block;max-width: 40%;margin: auto;">
<pic src="images/user-guide/ExampleClientList.png" alt="clientlist">
<markdown> Figure 1.1: _An example client list in ConnectCare_ </markdown>
<markdown> Figure 1.1: _An example client list in ConnectCare (appointments list is cropped)_ </markdown>
</pic>
</div>

Expand Down

0 comments on commit 302d19f

Please sign in to comment.