Skip to content

Commit f6ef003

Browse files
CYX22222003CYX22222003
authored
Merge pull request #381
Improve formatting and language
2 parents 2f6368b + a4b5f44 commit f6ef003

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

‎docs/UserGuide.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,20 @@ any traditional point-and-click management app.
9999

100100
## Command summary
101101

102-
| Action | Format, Examples |
103-
|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|
104-
| **[Add](#adding-a-person-add)** | `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…​` <br> e.g., `add n/James Ho p/91231234 e/[email protected] t/friend t/classmate` |
105-
| **[Clear](#clearing-all-entries-clear)** | `clear` |
106-
| **[Delete](#deleting-a-person-delete)** | `delete INDEX`<br> e.g., `delete 3` |
107-
| **[Edit](#editing-a-person-edit)** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
108-
| **[Find by contact information](#finding-persons-by-contact-information-find)** | `find PREFIX/KEYWORD [PREFIX/MORE_KEYWORDS]…​`<br> e.g., `find n/James t/floorball` |
109-
| **[Add tag](#adding-tags-to-a-specific-person-addtag)** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]…​` <br> e.g. `addtag 1 t/friend t/classmate` |
110-
| **[Delete tag](#deleting-a-person-s-tag-deltag)** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend` |
111-
| **[Categorize tag](#categorizing-a-tag-cattag)** | `cattag t/TAG [t/MORE_TAGS…​] CATEGORY` <br> e.g. `cattag t/floorball t/mahjong activity` |
112-
| **[Undo action](#undo-a-command-undo)** | `undo` |
113-
| **[Redo action](#redo-a-command-redo)** | `redo` |
114-
| **[List](#listing-all-persons-list)** | `list` |
115-
| **[Help](#viewing-help-help)** | `help` |
102+
| Action | Format, Examples |
103+
|:-------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------:|
104+
| **[Add:link:](#adding-a-person-add)** | `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…​` <br> e.g., `add n/James Ho p/91231234 e/[email protected] t/friend t/classmate` |
105+
| **[Clear:link:](#clearing-all-entries-clear)** | `clear` |
106+
| **[Delete:link:](#deleting-a-person-delete)** | `delete INDEX`<br> e.g., `delete 3` |
107+
| **[Edit:link:](#editing-a-person-edit)** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]` |
108+
| **[Find by contact information:link:](#finding-persons-by-contact-information-find)** | `find PREFIX/KEYWORD [PREFIX/MORE_KEYWORDS]…​`<br> e.g., `find n/James t/floorball` |
109+
| **[Add tag:link:](#adding-tags-to-a-specific-person-addtag)** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]…​` <br> e.g. `addtag 1 t/friend t/classmate` |
110+
| **[Delete tag:link:](#deleting-a-person-s-tag-deltag)** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend` |
111+
| **[Categorize tag:link:](#categorizing-a-tag-cattag)** | `cattag t/TAG [t/MORE_TAGS…​] CATEGORY` <br> e.g. `cattag t/floorball t/mahjong activity` |
112+
| **[Undo action:link:](#undo-a-command-undo)** | `undo` |
113+
| **[Redo action:link:](#redo-a-command-redo)** | `redo` |
114+
| **[List:link:](#listing-all-persons-list)** | `list` |
115+
| **[Help:link:](#viewing-help-help)** | `help` |
116116

117117
--------------------------------------------------------------------------------------------------------------------
118118
## Commands
@@ -173,30 +173,31 @@ Examples:
173173

174174
### Finding persons by contact information : `find`
175175

176-
Finds persons whose names, email address, contact number, or tag contain any of the given keywords.
176+
Finds persons whose name, email address, contact number, or tags contain any of the given keywords, even if the keyword is only a part of the information stored.
177177

178178
Format:
179179

180180
`find PREFIX/KEYWORD [PREFIX/MORE_KEYWORDS]…​`
181181

182182
* Only the specified fields are searched.
183-
* The search is case-insensitive. e.g. `hans` will match `Hans`
184-
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
185-
* Persons matching at least one keyword will be returned (i.e. `OR` search).
186-
e.g. `n/Hans n/Bo` will return `Hans Gruber`, `Bo Yang`
183+
* The search is case-insensitive. e.g. `hans` will match `Hans`.
184+
* The order of the keywords does not matter, e.g. `find n/Hans n/Bo` is equivalent to `find n/Bo n/Hans`.
185+
* Persons matching at least one keyword will be returned (i.e. `OR` search),
186+
e.g. `find n/Hans n/Bo` will match persons with names `Hans Gruber` or `Bo Yang`.
187+
* Keywords do not need to fully match the field, a partial match is sufficient, e.g. `bern` can match names like `Bernice` or `Bernard`
187188

188189
How `find` works with multiple parameters:
189190
* If multiple keywords for a field are present, `find` will display contacts that satisfy *any* keyword for that field.
190191
* If multiple fields are present, `find` will display contacts that satisfy **all** of these fields.
191192

192193
Examples:
193194
* `find n/bernice t/is1108` returns `Bernice Yu`<br>
194-
![result for 'find n/bernice t/is1108'](images/findBerniceIS1108Result.png){ width="750px" }
195+
![result for 'find n/bernice t/is1108'](images/findBerniceIS1108Result.png){ width="675px" }
195196

196197
* `find t/floor t/run` returns all contacts with any tag containing `floor` or `run` <br>
197-
![result for 'find t/floor t/run'](images/findFloorRunResult.png){ width="750px" }
198+
![result for 'find t/floor t/run'](images/findFloorRunResult.png){ width="675px" }
198199

199-
<div style="page-break-after: always;"></div>
200+
* `find n/alex n/bernice t/floor t/neighbour` returns all contacts that have names containing either `alex` or `bernice` **with** tags containing either `floor` or `neighbour`
200201

201202
### Deleting a person : `delete`
202203

@@ -218,10 +219,10 @@ Adds the specified person's tag.
218219

219220
Format: `addtag INDEX t/TAG [t/MORE_TAGS]…​`
220221

221-
* Adds the tags with the specified name `TAG` of the person at the specified `INDEX`.
222+
* Adds the tags with the specified value `TAG` of the person at the specified `INDEX`.
222223
* The index refers to the index number shown in the displayed person list.
223224
* The index **must be a positive integer** 1, 2, 3, …​
224-
* Multiple tags can be added at a time.
225+
* Multiple tags can be added to a person per command.
225226
* Attempt to add duplicate tags to a person will cause an error message to be thrown.
226227

227228
Examples:
@@ -234,15 +235,15 @@ Deletes the specified person's tag.
234235

235236
Format: `deltag INDEX t/TAG`
236237

237-
* Deletes the tag with the specified name `TAG` of the person at the specified `INDEX`.
238+
* Deletes the tag with the specified value `TAG` of the person at the specified `INDEX`.
238239
* The index refers to the index number shown in the displayed person list.
239240
* The index **must be a positive integer** 1, 2, 3, …​
240-
* Only one tag can be deleted at a time.
241-
* The list of the tag will be updated accordingly.
241+
* Only one tag can be deleted per command.
242+
* The list of tags will be updated accordingly.
242243

243244
Examples:
244245
* `deltag 1 t/friend`
245-
deletes the friend tag of the first person in the list.
246+
deletes the `friend` tag of the first person in the list.
246247

247248
<div style="page-break-after: always;"></div>
248249

@@ -252,7 +253,7 @@ Categorizes a tag under a defined category.
252253

253254
Format: `cattag t/TAG [t/MORE_TAGS]…​ CATEGORY`
254255

255-
* Sets the tag(s) in CampusConnect with the specified name `TAG` to fall under the specified `CATEGORY`.
256+
* Sets the tag(s) in CampusConnect with the specified value `TAG` to fall under the specified `CATEGORY`.
256257
* Currently available categories with their respective keywords and colours are:
257258

258259
Category | Keyword (case sensitive) | Colour
@@ -263,20 +264,18 @@ Format: `cattag t/TAG [t/MORE_TAGS]…​ CATEGORY`
263264
**Networking**| `network` | <span style="color:LimeGreen"> Green </span>
264265
**Mentorship**| `mentor` | <span style="color:HotPink"> Pink </span>
265266

266-
* Multiple tags can be categorized to the same category at a time.
267+
* Multiple tags can be categorized to the same category using a single command.
267268
* All tags specified must be valid existing tags.
268269
* Attempts to set a tag to its current category will cause the whole command to be rejected.
269270
* Only one category is allowed to be entered per command, i.e. `cattag t/tag1 acads t/tag2 general` is not allowed.
271+
* Note: Newly created tags (by [`add`:link:](#adding-a-person-add) or [`addtag`:link:](#adding-tags-to-a-specific-person-addtag)) will have category `General` and colour `Grey` by default.
270272

271273
Examples:
272274
* `cattag t/CS2100 acads` categorizes the tag `CS2100` under `Academics` and display colour of the tag`CS2100` becomes `Gold`.
273275
* `cattag t/floorball t/mahjong activity` categorizes both tags `floorball` and `mahjong` under `Activities` with colour `Blue`.
274-
* Newly created tags (by [`add`](#adding-a-person-add) or [`addtag`](#adds-tags-to-a-specific-person--addtag)) will have category `General` and colour `Grey` by default.
275276

276277
![cattag response image](images/cattagResponse.png)
277278

278-
<div style="page-break-after: always;"></div>
279-
280279
### Undo a command : `undo`
281280

282281
Undoes the previous command and reverts CampusConnect.
@@ -303,11 +302,11 @@ Clears all entries from CampusConnect.
303302

304303
Format: `clear`
305304

306-
<box type="warning" seamless>
305+
<box type="warning">
307306
<strong>Caution:</strong>
308-
There will not be any confirmation message shown. </br>
309307

310-
If you have unintentionally executed the `clear` command, you can use the [`undo`](#undo-a-command-undo) command to restore your data.
308+
* There will not be any confirmation message shown. </br>
309+
* If you have unintentionally executed the `clear` command, you can use the [`undo`:link:](#undo-a-command-undo) command to restore your data.
311310
</box>
312311

313312
### Exiting the program : `exit`
@@ -324,10 +323,11 @@ CampusConnect data is saved in the hard disk automatically after any command tha
324323

325324
CampusConnect data is saved automatically as a JSON file `[JAR file location]/data/CampusConnect.json`. Advanced users are welcome to update data directly by editing that data file.
326325

327-
<box type="warning" seamless>
326+
<box type="warning">
328327
<strong>Caution:</strong>
329-
If your changes to the data file makes its format invalid, CampusConnect will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br>
330-
Furthermore, certain edits can cause CampusConnect to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
328+
329+
* If your changes to the data file makes its format invalid, CampusConnect will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br>
330+
* Furthermore, certain edits can cause CampusConnect to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
331331
</box>
332332

333333
--------------------------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)