Skip to content

Commit

Permalink
Merge pull request #98 from Jolonauh/user-guide
Browse files Browse the repository at this point in the history 
Update add and shortcut section of user guide
  • Loading branch information
@pjanthony2001
pjanthony2001 authored Apr 4, 2024
2 parents 9f358e6 + 2c9f78b commit fe64c88
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,20 +173,20 @@ ___

_This command adds a new client to your client list._

**Format:** `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS k/NEXT_OF_KIN d/DESCRIPTION [t/TAG]…`
**Format:** `add n/NAME p/PHONE_NUMBER e/EMAIL [a/ADDRESS] [k/NEXT_OF_KIN] [d/DESCRIPTION] [t/TAG]…`

<panel header="Parameter Descriptions and Remarks" alt="Parameters" minimized>
<markdown>

| Parameter | Description | Remarks |
|----------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| n/NAME | Name of client that you want to add | Name must be unique, alphanumeric and is compulsory |
| p/PHONE_NUMBER | Phone Number of client that you want to add | Phone number should only contain numbers and is compulsory |
| e/EMAIL | Email of client that you want to add | Emails is compulsory and 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 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 | Compulsory |
| k/NEXT_OF_KIN | Next of Kin details of client that you want to add | Name must be alphanumeric and is compulsory |
| d/DESCRIPTION | Description of client that you want to add | Description should not be blank and is compulsory |
| t/TAG | Tag to identify the client | A person can have any number of tags (or even 0) |
| Parameter | Description | Remarks |
|----------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| n/NAME | Name of client that you want to add | Name must be unique, alphanumeric and is compulsory |
| p/PHONE_NUMBER | Phone Number of client that you want to add | Phone number should only contain numbers and is compulsory |
| 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 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 | A person can have any number of tags (or even 0) |


<box type="tip" seamless>
Expand Down Expand Up @@ -594,7 +594,11 @@ _These are a list of helpful actions to facilitate the ease of use of our applic
|--------|---------------------------------------------------|
| `Up` | Displays to the previous command entered, if any. |
| `Down` | Displays the next command entered, if any. |
| `Tab` | Automatically completes commands, if available. |

<box type="info">

**Note**: A message will be displayed in the dialog to notify users when there are no previous/next command available.
</box>

### Saving the data

Expand All @@ -616,16 +620,16 @@ ___

## Command summary

| Action | Format | Examples |
|-------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` | `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 d/Suffers from anxiety k/Jon Ho t/friend t/colleague` |
| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` |
| **Find** | `find n/NAME… [a/ADD]… [e/EMAIL]… [t/TAG]… [k/KIN]… [d/DESC]… [p/PHONE]…` | `find n/James a/clementi e/gmail t/important k/charles d/tall p/123` |
| **Undo** | `undo` | |
| **Redo** | `redo` | |
| **Display** | `display n/NAME` | |
| **Clear** | `clear` | |
| **Exit** | `exit` | |
| Action | Format | Examples |
|-------------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL [a/ADDRESS] [k/NEXTOFKIN] [d/DESCRIPTION] [t/TAG]… ` | `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 d/Suffers from anxiety k/Jon Ho t/friend t/colleague` |
| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` |
| **Find** | `find n/NAME… [a/ADD]… [e/EMAIL]… [t/TAG]… [k/KIN]… [d/DESC]… [p/PHONE]…` | `find n/James a/clementi e/gmail t/important k/charles d/tall p/123` |
| **Undo** | `undo` | |
| **Redo** | `redo` | |
| **Display** | `display n/NAME` | |
| **Clear** | `clear` | |
| **Exit** | `exit` | |

___

Expand Down

0 comments on commit fe64c88

Please sign in to comment.