Skip to content

Commit eefb42c

Browse files
kaixin-hckaixin-hc
authored
Merge pull request nus-cs2103-AY2122S1#80 from AY2122S1-CS2103T-W08-1/elroygohjy-ug
Docs: Fix UserGuide Docs
2 parents 6fbeca4 + 5b74000 commit eefb42c

2 files changed

Lines changed: 60 additions & 48 deletions

File tree

‎docs/UserGuide.md‎

Lines changed: 59 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,22 @@ Examples:
179179
* `person /create n:John Lim g:CS2103T`
180180
* `p /c n:Mary`
181181

182+
#### Adding a person to a group or subgroup: `person /add`
183+
184+
Adds a person to a specified group.
185+
186+
Format: `person NAME /add g:GROUP_NAME [sg:SUP_GROUP_NAME]`<br>
187+
Advanced user Format: `p NAME /a g:GROUP_NAME [sg:SUP_GROUP_NAME]`
188+
189+
* Adds a person with the NAME to GROUP_NAME.
190+
* Optional arguments:
191+
* `SUB_GROUP_NAME`: name of the subgroup to add the user to.
192+
193+
Examples:
194+
195+
* `person John /add Lim g:CS2103T`
196+
* `p Mary /a g:CS2103T sg:W08`
197+
*
182198
#### Deleting a person : `person /delete`
183199

184200
Deletes an existing person.
@@ -190,7 +206,7 @@ Advanced user Format: `p /d n:NAME`
190206

191207
Examples:
192208

193-
* `person /delete n:John Lim g:CS2103T`
209+
* `person /delete n:John Lim `
194210
* `p /d n:Mary`
195211

196212
#### Editing a person : `person /edit`
@@ -247,7 +263,7 @@ Creates a group.
247263
Format: `group /create g:GROUP_NAME`<br>
248264
Advanced user Format: `g /c g:GROUP_NAME`
249265

250-
* Creates a new group with the name `group_name`.
266+
* Creates a new group with the name `GROUP_NAME`.
251267
* The new group must not have a same name with other existing groups.
252268
* The new group's name must not include backslash (`/`) or colon (`:`).
253269

@@ -268,12 +284,12 @@ Examples :
268284
* `group /delete g:CS2103T` will delete the group CS2103T.
269285
* `g /d g:Orbital`
270286

271-
### Editing a group: `group group_name /edit`
287+
### Editing a group: `group /edit`
272288

273289
Edits the name of an existing group.
274290

275-
Format: `group group_name /edit g:NEW_NAME`<br>
276-
Advanced user Format: `g group_name /e g:NEW_NAME`
291+
Format: `group GROUP_NAME /edit g:NEW_NAME`<br>
292+
Advanced user Format: `g GROUP_NAME /e g:NEW_NAME`
277293

278294
* Renames an existing group `GROUP_NAME` to `NEW_NAME` .
279295
* The new group must not have a same name with other existing groups.
@@ -282,84 +298,81 @@ Advanced user Format: `g group_name /e g:NEW_NAME`
282298
Examples :
283299

284300
* `group CS2103T /edit g:CS2101` will rename the group CS2103T to CS2101
285-
* `g Orbitan /e g:Orbital`
301+
* `g Orbital /e g:Orbital3`
286302

287-
### Creating a subgroup: `group group_name /create`
303+
### Creating a subgroup: `group GROUP_NAME /create`
288304

289305
Creates a new subgroup.
290306

291-
Format: `group group_name /create sg:SUBGROUP_NAME`<br>
292-
Advanced user Format: `g group_name /c sg:SUBGROUP_NAME`
307+
Format: `group GROUP_NAME /create sg:SUBGROUP_NAME`<br>
308+
Advanced user Format: `g GROUP_NAME /c sg:SUBGROUP_NAME`
293309

294-
* Creates a new subgroup of `group_name` with the name `subgroup_name`.
310+
* Creates a new subgroup of `GROUP_NAME` with the name `SUBGROUP_NAME`.
295311
* The new subgroup must not have a same name with other existing subgroups in the same group.
296312
* The new subgroup's name must not include backslash (`/`) or colon (`:`).
297313

298314
Examples :
299315

300-
* `group Orbital /create g:Artemis` will create a new subgroup Artemis in group Orbital.
301-
* `g CS2103T /c g:ip`
316+
* `group Orbital /create sg:Artemis` will create a new subgroup Artemis in group Orbital.
317+
* `g CS2103T /c sg:ip`
302318

303-
### Deleting a subgroup: `group group_name /delete`
319+
### Deleting a subgroup: `group GROUP_NAME /delete`
304320

305321
Deletes an existing subgroup from a group.
306322

307-
Format: `group group_name /delete sg:SUBGROUP_NAME`<br>
308-
Advanced user Format: `g group_name /d sg:SUBGROUP_NAME`
323+
Format: `group GROUP_NAME /delete sg:SUBGROUP_NAME`<br>
324+
Advanced user Format: `g GROUP_NAME /d sg:SUBGROUP_NAME`
309325

310-
* Deletes an existing subgroup of `group_name` with the name `subgroup_name`.
326+
* Deletes an existing subgroup of `GROUP_NAME` with the name `SUBGROUP_NAME`.
311327

312328
Examples :
313329

314-
* `group Orbital /delete g:Artemis` will delete the subgroup Artemis from Orbital.
315-
* `g CS2103T /d g:ip`
330+
* `group Orbital /delete sg:Artemis` will delete the subgroup Artemis from Orbital.
331+
* `g CS2103T /d sg:ip`
316332

317-
### Editing a subgroup: `group group_name /edit`
333+
### Editing a subgroup: `group GROUP_NAME /edit`
318334

319335
Edits the name of an existing subgroup from a group.
320336

321-
Format: `group GROUP_NAME:SUPGROUP_NAME /edit sg:new_name`<br>
322-
Advanced user Format: `g GROUP_NAME:SUPGROUP_NAME /e sg:SUBGROUP_NAME`
337+
Format: `group GROUP_NAME:SUP_GROUP_NAME /edit sg:NEW_SUP_GROUP_NAME`<br>
338+
Advanced user Format: `g GROUP_NAME:SUP_GROUP_NAME /e sg:SUB_GROUP_NAME`
323339

324-
* Renames an existing subgroup of `GROUP_NAME` with the name `SUPGROUP_NAME` to `NEW_NAME`.
340+
* Renames an existing subgroup of `GROUP_NAME` with the name `SUP_GROUP_NAME` to `NEW_SUP_GROUP_NAME`.
325341
* The new subgroup must not have a same name with other existing subgroups in the same group.
326342
* The new subgroup's name must not include backslash (`/`) or colon (`:`).
327343

328344
Examples :
329345

330-
* `group Orbital:Artemis /edit g:Apollo` will rename the subgroup Artemis to Apollo.
331-
* `g CS2103T:tp /e g:ip`
346+
* `group g:Orbital:Artemis /edit sg:Apollo` will rename the subgroup Artemis to Apollo.
347+
* `g g:CS2103T:tp /e sg:ip`
332348

333-
### Adding notes on a group: `group group_name /note`
349+
### Adding notes on a group: `group GROUP_NAME /note`
334350

335351
Adds notes on a group and saves the time when the note is added.
336352

337-
Format: ` group group_name /note`<br>
338-
Advanced user Format: `g group_name /n`
353+
Format: ` group GROUP_NAME /note`<br>
354+
Advanced user Format: `g GROUP_NAME /n`
339355

340-
* Entering the command will lead to a popup window where the user can edit notes for `group`.
356+
* Entering the command will lead to a popup window where the user can edit notes for `GROUP_NAME`.
341357
* The time when the note is edited will be saved.
342358

343359
Examples :
344360

345-
* `group Orbital /note` will prompt a popup window where the user can edit the notes for Orbital.
361+
* `group Orbital /note sg:Team1` will prompt a popup window where the user can edit the notes for Orbital.
346362
* `g CS2103T /n`
347363

348-
### Adding notes on a subgroup: `group group_name /note`
364+
365+
### Adding notes on a subgroup: `group GROUP_NAME /note`
349366

350367
Adds notes on a subgroup and saves the time when the note is added.
351368

352-
Format: ` group group_name /note sg:SUB_GROUP`<br>
353-
Advanced user Format: `g group_name /n sg:SUB_GROUP`
369+
Format: ` group GROUP_NAME /note sg:SUB_GROUP_NAME`<br>
370+
Advanced user Format: `g GROUP_NAME /n sg:SUB_GROUP_NAME`
354371

355-
* Entering the command will lead to a popup window where the user can edit notes for `sub_group`.
372+
* Entering the command will lead to a popup window where the user can edit notes for `SUB_GROUP_NAME`.
356373
* The time when the note is edited will be saved.
357374

358375
Examples :
359-
360-
* `group Orbital /note sg: Artemis` will prompt a popup window where the user can edit the notes for Artemis.
361-
* `g CS2103T /e sg: ip`
362-
363376
## Miscellaneous information
364377

365378
### Saving the data
@@ -396,22 +409,22 @@ the data of your previous Notor home folder.
396409

397410
Action | Format | Advanced Format
398411
--------|--------|----------
399-
**Create** | `person /create NAME [g:GROUP_NAME]` | `p /c NAME [g:GROUP_NAME]`
412+
**Create** | `person /create n:NAME [g:GROUP_NAME]` | `p /c n:NAME [g:GROUP_NAME]`
413+
**Add** | `person NAME /add g:GROUP_NAME [sg:SUB_GROUP_NAME]` | `p NAME /a g:GROUP_NAME [sg:SUB_GROUP_NAME]`
400414
**Edit** | `person NAME /edit n:NAME` | `p NAME /e n:NAME`
401-
**Delete** | `person /delete NAME` | `p NAME /d n:NAME`
402-
**Remove** | `person NAME /remove or /r g:GROUP_NAME ` | `p NAME /r g:GROUP_NAME`
415+
**Delete** | `person /delete n:NAME` | `p NAME /d n:NAME`
416+
**Remove** | `person NAME /remove g:GROUP_NAME ` | `p NAME /r g:GROUP_NAME`
403417
**Note** | `person NAME /note` | `p NAME /n`
404418

405419
## Group
406420

407421
Action | Format | Advanced Format
408422
--------|--------|----------
409-
**Create** | `group / c g:GROUP_NAME` | `g / c g:GROUP_NAME`
410-
**Edit** | `group g:GROUP_NAME /edit g:GROUP_NAME` | `g GROUP_NAME /e g:GROUP_NAME`
411-
**Delete** | `group g:GROUP_NAME /delete g:GROUP_NAME` | `g g:GROUP_NAME /d g:GROUP_NAME`
412-
**Note** | `group g:GROUP_NAME /note` | `g g:GROUP_NAME /n g:GROUP_NAME`
413-
**Create subgroup** | `group GROUP_NAME /create sg:SUB_GROUP_NAME` | `g g:GROUP_NAME /c sg:SUB_GROUP_NAME`
414-
**Edit subgroup** | `group GROUP_NAME:SUB_GROUP_NAME /edit sg:SUB_GROUP_NAME` | `g g:GROUP_NAME:SUB_GROUP_NAME /e sg:SUB_GROUP_NAME`
423+
**Create** | `group /create g:GROUP_NAME` | `g /c g:GROUP_NAME`
424+
**Edit** | `group GROUP_NAME /edit g:GROUP_NAME` | `g GROUP_NAME /e g:GROUP_NAME`
425+
**Delete** | `group GROUP_NAME /delete g:GROUP_NAME` | `g GROUP_NAME /d g:GROUP_NAME`
426+
**Note** | `group GROUP_NAME /note` | `g GROUP_NAME /n`
427+
**Create subgroup** | `group GROUP_NAME /create sg:SUB_GROUP_NAME` | `g GROUP_NAME /c sg:SUB_GROUP_NAME`
415428
**Delete subgroup** | `group GROUP_NAME /delete sg:SUB_GROUP_NAME` | `g GROUP_NAME /d sg:SUB_GROUP_NAME`
416429
**Note subgroup** | `group GROUP_NAME /note sg:SUB_GROUP_NAME` | `g GROUP_NAME /n sg:SUB_GROUP_NAME`
417430

‎docs/_includes/head.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
<meta http-equiv="X-UA-Compatible" content="IE=edge">
44
<meta name="viewport" content="width=device-width, initial-scale=1">
55

6-
<link rel="stylesheet" href="{{ "
7-
/assets/css/style.css" | relative_url }}">
6+
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
87

98
{%- include custom-head.html -%}
109

0 commit comments

Comments
 (0)