Skip to content

Commit e7d3dbe

Browse files
authored
Merge pull request #59 from AY1920S2-CS2103T-F10-3/UserGuide-AddressBook-Update
Updated User Guide (Address Book feature)
2 parents 12987cd + 1aa28d3 commit e7d3dbe

File tree

1 file changed

+61
-3
lines changed

1 file changed

+61
-3
lines changed

docs/UserGuide.adoc

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ You can add your classmate or teammate as contact.
6565

6666
Format: `contact add n\[name] p\[phone number] c\[classmate/teammate]`
6767

68+
Example:
69+
70+
* `contact add n\John Doe p\12345678 c\classmate`
71+
6872
Note:
6973

7074
* `[name]` is not case-sensitive (Jane doe is the same as jane Doe).
@@ -76,6 +80,10 @@ You can edit the contacts that you have added. If the contact you tried to edit
7680

7781
Format: `contact edit n\[name] p\[phone number] c\[classmate/teammate]`
7882

83+
Example:
84+
85+
* `contact edit n\John Doe p\88888888 c\classmate`
86+
7987
Note:
8088

8189
* `[name]` is not case-sensitive (Jane doe is the same as jane Doe).
@@ -86,6 +94,10 @@ You can delete a contact that you have added. If the contact you try to delete d
8694

8795
Format: `contact delete n\[name]`
8896

97+
Example:
98+
99+
* `contact delete n\John Doe`
100+
89101
Note:
90102

91103
* `[name]` is not case-sensitive (Jane doe is the same as jane Doe).
@@ -96,18 +108,31 @@ You can delete all the contacts that you have added in your address book. If the
96108

97109
Format: `contact delete all`
98110

111+
Example:
112+
113+
* `contact delete all`
114+
99115
==== List All Contacts: `list`
100116

101117
NOVA will list the contact's name, phone number and category of all contacts.
102118

103119
Format: `contact list`
104120

121+
Example:
122+
123+
* `contact list`
124+
105125
==== List Category Contact: `list [classmate/teammate]`
106126

107127
NOVA will list the name and phone number of all the contacts under that category. NOVA will also list the category specific remarks.
108128

109129
Format: `contact list c\[classmate/teammate]`
110130

131+
Example:
132+
133+
* `contact list c\classmate`
134+
* `contact list c\teammate`
135+
111136
Note:
112137

113138
* `[classmate/teammate]` is not case-sensitive.
@@ -117,7 +142,11 @@ Note:
117142

118143
NOVA will find a specific contact added to the address book.
119144

120-
Format: `contact find [name]`
145+
Format: `contact find n\[name]`
146+
147+
Example:
148+
149+
* `contact find n\john DOE`
121150

122151
Note:
123152

@@ -127,7 +156,11 @@ Note:
127156

128157
NOVA will find a specific contact added to the address book and add the picture.
129158

130-
Format: `contact addpic n\[name] [path]`
159+
Format: `contact addpic n\[name] pa\[path]`
160+
161+
Example:
162+
163+
* `contact addpic n\john doe pa\C:\Users\aloha\Desktop\aloha.png`
131164

132165
Note:
133166

@@ -137,7 +170,11 @@ Note:
137170

138171
NOVA will find a specific contact added to the address book and edit the picture.
139172

140-
Format: `contact updatepic n\[name] [path]`
173+
Format: `contact updatepic n\[name] pa\[path]`
174+
175+
Example:
176+
177+
* `contact updatepic n\john doe pa\C:\Users\aloha\Desktop\updatedAloha.png`
141178

142179
Note:
143180

@@ -149,6 +186,10 @@ NOVA will find a specific contact added to the address book and edit the picture
149186

150187
Format: `contact deletepic n\[name]`
151188

189+
Example:
190+
191+
* `contact deletepic n\john doe`
192+
152193
Note:
153194

154195
* `[name]` is not case-sensitive (Jane doe is the same as jane Doe)
@@ -159,6 +200,10 @@ NOVA will find a specific contact added to the address book and add the remark a
159200

160201
Format: `contact remark c\[classmate/teammate] n\[name] d\[description]`
161202

203+
Example:
204+
205+
* `contact remark c\teammate n\john DOE d\He's cuteeee!`
206+
162207
Note:
163208

164209
* `[name]` is not case-sensitive (Jane doe is the same as jane Doe)
@@ -169,16 +214,29 @@ NOVA will find the second latest command that was done by the user and go to tha
169214

170215
Format: `contact undo`
171216

217+
Example:
218+
219+
* `contact undo`
220+
172221
==== Redo Your Command: `redo`
173222

174223
NOVA will redo commands.
175224

176225
Format: `contact redo`
177226

227+
Example:
228+
229+
* `contact redo`
230+
178231
==== Short Form [v2.0]
179232

180233
You can use the short form of contact `c` in your command.
181234

235+
Example:
236+
237+
* `c redo`
238+
* `c add n\Hee Haw p\88887777 c\classmate`
239+
182240
=== Manage Plans
183241
Commands that will help you in managing your events.
184242

0 commit comments

Comments
 (0)