Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update user guide #57

Merged
merged 26 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e4523de
Update models to include description
Rishit02 Mar 24, 2024
13e5b96
Update models to include Next of Kin
Rishit02 Mar 24, 2024
bcf584d
Update user guide
eliotlee68 Mar 24, 2024
d64df6f
Update User Guide
pjanthony2001 Mar 24, 2024
7c05bb7
Add class to model package
Rishit02 Mar 24, 2024
a296a78
Merge pull request #59 from Rishit02/update-uml
Jolonauh Mar 24, 2024
c68d95c
Fix links in User Guide
pjanthony2001 Mar 24, 2024
bec3c73
Update add command in UG
Rishit02 Mar 24, 2024
a331e79
Update Boxes in User Guide
pjanthony2001 Mar 24, 2024
78521e3
Fix Formatting
pjanthony2001 Mar 24, 2024
1faf221
Update UML Diagrams
tejas-1405 Mar 24, 2024
df1f4c3
Fix wording of Redo
pjanthony2001 Mar 24, 2024
2ee009f
Merge pull request #58 from pjanthony2001/update-user-guide
tejas-1405 Mar 24, 2024
dca2ced
Update UG for update command
Rishit02 Mar 24, 2024
3cfe973
Update UserGuide.md
Rishit02 Mar 24, 2024
4868c7f
Merge branch 'master' into update-UG
Rishit02 Mar 24, 2024
420fc2e
Update UserGuide.md
Rishit02 Mar 25, 2024
a3cb59b
Merge branch 'update-UG' of https://github.com/Rishit02/tp into updat…
Rishit02 Mar 25, 2024
a641218
Update UG
Rishit02 Mar 25, 2024
1c74e38
Update User Guide
Rishit02 Mar 25, 2024
ff2db73
Merge pull request #60 from tejas-1405/UML-update
pjanthony2001 Mar 25, 2024
31b429d
Update user guide
Rishit02 Mar 25, 2024
7ccdb67
Merge pull request #62 from Rishit02/update-UG
pjanthony2001 Mar 25, 2024
e2c3dba
Update format to be consistent
eliotlee68 Mar 25, 2024
9db1295
Update user guide
eliotlee68 Mar 25, 2024
d3e714a
Merge branches '55-Update-UG' and '55-Update-UG' of https://github.co…
eliotlee68 Mar 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,29 @@ Examples:
email: [[email protected]](mailto:[email protected])
address: John street, block 123, #01-011

### Locating persons by name: `find`
### Locating clients by keywords: `find`

This command allows you to find a specific client in your client list by their **name**
This command allows you to find a specific client in your client list by their **name**, and optionally by other fields too

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be in italics


Format: `find n/NAME`
Format: `find n/NAME [a/ADDRESSKEYWORD] [e/EMAILKEYWORD] [t/TAGKEYWORD] [k/KINKEYWORD] [d/DESCKEYWORD] [p/PHONEKEYWORD]`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if there are parameter constraints, but if there are you should put it here


Examples: Lets say your contact list contains the following contacts: **John Doe** **John Lee** **Alex Lee** **Bobby Chan**
Examples: Lets say your contact list contains the following contacts:
<img src="images/ExampleClientList.png" />

- `find John` would return `John Doe` as well as `John Lee`
- `find Alex Lee` would return `Alex Lee`
- `find Lee` would return `John Lee` as well as `Alex Lee`
- `find n/alex` would return `Alex Lee` as well as `Alex Chan`
- `find n/alex p/99824412 ` would return `Alex Chan`
- `find n/a` would return `Alex Lee` , `Alex Chan`, as well as `Xavier`
- `find n/a t/important` would return `Alex Lee` as well as `Xavier`

**Note:** you can search for multiple keywords, for example `find n/name1 n/name2` would search for all clients with names that contain name1 OR name2
This also applies to the optional keywords, for example `find n/name1 a/address1 a/address2 would search for all clients with names that contain name1 AND
have an address that contains address1 OR address2, so
- `find n/alex n/bobby` would return `Alex Lee`, `Alex Chan`, and `Bobby`
- `find n/a p/86151644 p/12355125` would return `Alex Lee` and `Bobby`

<box type="tip" seamless>
eliotlee68 marked this conversation as resolved.
Show resolved Hide resolved
**Tip:** After using the find function, you can use clear to display the full list of clients again!
</box>

### Clearing all entries : `clear`

Expand All @@ -149,6 +161,8 @@ This command allows you to exit the application.

Format: `exit`

**Note:** You can simply close the window using the X button too!
Copy link

@pjanthony2001 pjanthony2001 Mar 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convert this to a tip instead by using <box type="tip" seamless> </box>


### Shortcuts
_These are a list of helpful actions to facilitate the ease of use of our application_

Expand Down Expand Up @@ -184,7 +198,7 @@ ___
| --- | --- | --- |
| **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 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 KEYWORD [MORE_KEYWORDS]` | `find James Jake` |
| **Find** | `find n/NAME [a/ADDRESSKEYWORD] [e/EMAILKEYWORD] [t/TAGKEYWORD] [k/KINKEYWORD] [d/DESCKEYWORD] [p/PHONEKEYWORD]` | `find n/James n/Bill a/Clementi` |
| **Undo** | `undo`| |
| **Redo** | `redo` | |
| **Display** | TBD | |
Expand Down
Binary file added docs/images/ExampleClientList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading