Skip to content

Commit

Permalink
Merge pull request #88 from solomonng2001/update-developer-and-user-g…
Browse files Browse the repository at this point in the history 
…uide

Update developer and user guide
  • Loading branch information
@solomonng2001
solomonng2001 authored Mar 21, 2024
2 parents 18d4f77 + 1018d17 commit e16a8ca
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 16 deletions.
45 changes: 29 additions & 16 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,21 @@ Format: `add n/NAME c/PHONE_NUMBER e/EMAIL a/ADDRESS b/BIRTHDAY p/PRIORITY [t/TA

<box type="tip" seamless>

**Tip:** A client can have any number of tags (including 0)
**Tip:** A client can have any number of tags (including 0). All other parameters (with the exception of tags) cannot have duplicate parameters.
</box>

Parameters usage for client details:

| Parameter | Usage | Example |
|-------------|-----------------------------------------------------------------------------------------|---------------------------------|
| 'n/NAME' | All names in the system must be unique | `n/John Doe` |
| 'c/PHONE_NUMBER' | Phone numbers should only contain numbers, and it should be at least 3 digits long | `c/98765432` |
| 'e/EMAIL' | Email should be in the format of `local-part@domain` | `e/[email protected]` |
| 'a/ADDRESS' | Address can take any text value | `a/311, Clementi Ave 2, #02-25` |
| 'b/BIRTHDAY'| Birthday should be in the format of `YYYY-MM-DD` | `b/1990-01-01` |
| 'p/PRIORITY'| Priority can be `low`, `medium`, `high` or `vip` | `p/medium` |
| 't/TAG' | Tags can be any text value | `t/friends` |

Examples:
* `add n/John Doe c/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 b/1990-01-01 p/low t/friends t/owesMoney`
* `add n/Betsy Crowe t/friend p/vip e/[email protected] a/Newgate Prison c/1234567 t/criminal b/1979-03-04`
Expand Down Expand Up @@ -120,6 +132,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [b/BIRTHDAY] [p/PRI
* When editing tags, the existing tags of the client will be removed i.e adding of tags is not cumulative.
* You can remove all the client’s tags by typing `t/` without
specifying any tags after it.
* Refer to the [Adding a client](#adding-a-client-add) section for the usage of the parameters.

Examples:
* `edit 1 c/91234567 e/[email protected]` Edits the phone number and email address of the 1st client to be `91234567` and `[email protected]` respectively.
Expand Down Expand Up @@ -275,18 +288,18 @@ _Details coming soon ..._

## Command summary

| Action | Format, Examples |
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME c/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g.,`add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` |
| **Clear** | `clear` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Edit** | `edit INDEX [n/NAME] [c/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **List** | `list` |
| **LastMet** | `met INDEX [l/DATE]`<br> eg., `met 2 l/2023-05-07` |
| **Schedule** | `schedule INDEX [s/DATETIME]`<br> eg., `schedule 2 s/2023-05-07 22:00` | |
| **View** | `view INDEX`<br> eg., `view 1` |
| **Add Policy** | `addpolicy INDEX n/POLICY_NAME i/POLICY_ID` <br/> eg., 'addpolicy 1 n/Life i/1' |
| **Delete Policy** | `deletepolicy INDEX i/POLICY_ID` <br/> eg., 'deletepolicy 1 i/1' |
| **Help** | `help` |
| **Exit** | `exit` |
| Action | Format, Examples |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME c/PHONE_NUMBER e/EMAIL a/ADDRESS b/BIRTHDAY p/PRIORITY [t/TAG]…​` <br> e.g.,`add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 b/1990-01-01 p/medium t/friend t/colleague` |
| **Clear** | `clear` |
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [b/BIRTHDAY] [p/PRIORITY] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **List** | `list` |
| **LastMet** | `met INDEX [l/DATE]`<br> eg., `met 2 l/2023-05-07` |
| **Schedule** | `schedule INDEX [s/DATETIME]`<br> eg., `schedule 2 s/2023-05-07 22:00` | |
| **View** | `view INDEX`<br> eg., `view 1` |
| **Add Policy** | `addpolicy INDEX n/POLICY_NAME i/POLICY_ID` <br/> eg., 'addpolicy 1 n/Life i/1' |
| **Delete Policy** | `deletepolicy INDEX i/POLICY_ID` <br/> eg., 'deletepolicy 1 i/1' |
| **Help** | `help` |
| **Exit** | `exit` |
7 changes: 7 additions & 0 deletions docs/diagrams/UiClassDiagram.puml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Class ClientListCard
Class ClientDetailsCard
Class ClientViewPanel
Class ClientPolicyTable
Class RemindersPanel
Class RemindersCard
Class StatusBarFooter
Class CommandBox
}
Expand All @@ -37,6 +39,7 @@ MainWindow *-down-> "1" CommandBox
MainWindow *-down-> "1" ResultDisplay
MainWindow *-down-> "1" ClientListPanel
MainWindow *-down-> "1" ClientViewPanel
MainWindow *-down-> "1" RemindersPanel
MainWindow *-down-> "1" StatusBarFooter
MainWindow --> "0..1" HelpWindow

Expand All @@ -45,6 +48,8 @@ ClientListPanel *-down-> "*" ClientListCard
ClientViewPanel *-down-> "1" ClientDetailsCard
ClientViewPanel *-down-> "1" ClientPolicyTable

RemindersPanel *-down-> "2" RemindersCard

MainWindow -left-|> UiPart

ResultDisplay --|> UiPart
Expand All @@ -53,12 +58,14 @@ ClientListPanel --|> UiPart
ClientListCard --|> UiPart
ClientDetailsCard --|> UiPart
ClientPolicyTable --|> UiPart
RemindersCard --|> UiPart
StatusBarFooter --|> UiPart
HelpWindow --|> UiPart

ClientListCard ..> Model
ClientDetailsCard ..> Model
ClientPolicyTable ..> Model
RemindersCard ..> Model
UiManager -right-> Logic
MainWindow -left-> Logic

Expand Down

0 comments on commit e16a8ca

Please sign in to comment.