-
Notifications
You must be signed in to change notification settings - Fork 5
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
Changes from 1 commit
e4523de
13e5b96
bcf584d
d64df6f
7c05bb7
a296a78
c68d95c
bec3c73
a331e79
78521e3
1faf221
df1f4c3
2ee009f
dca2ced
3cfe973
4868c7f
420fc2e
a3cb59b
a641218
1c74e38
ff2db73
31b429d
7ccdb67
e2c3dba
9db1295
d3e714a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
Format: `find n/NAME` | ||
Format: `find n/NAME [a/ADDRESSKEYWORD] [e/EMAILKEYWORD] [t/TAGKEYWORD] [k/KINKEYWORD] [d/DESCKEYWORD] [p/PHONEKEYWORD]` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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` | ||
|
||
|
@@ -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! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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_ | ||
|
||
|
@@ -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 | | | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be in italics