Skip to content

Commit b151246

Browse files
zacwong2151zacwong2151
authored
Merge pull request #255 from brein62/finalise-ug
Update command summary
2 parents 28ef036 + fca6c24 commit b151246

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

‎docs/DeveloperGuide.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1821,3 +1821,4 @@ However, our implementation only updates this displayed list if the user execute
18211821
The same occurrence also happens when the event list panel is currently displaying the events joined by a particular volunteer (used `vliste` command), and an `eremovev` command is executed to remove this volunteer from the event.
18221822
We plan to correct this behaviour as it might cause confusion to our users.
18231823

1824+
<div style="page-break-after: always;"></div>

‎docs/UserGuide.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ iVolunteer is your dedicated application for volunteer coordination, designed wi
7878
* Items in square brackets are optional.<br>
7979
e.g `n/NAME [s/SKILL]` can be used as `n/John Doe s/friendly` or as `n/John Doe`.
8080

81-
* Items with `…`​ after them can be used multiple times including zero times.<br>
82-
e.g. `[s/SKILL]…​` can be used as ` ` (i.e. 0 times), `s/friendly`, `s/friendly s/caring` etc.
81+
* Items with `…`​ after them can be used multiple times.<br>
82+
e.g. `[s/SKILL]…​` can be used as `s/friendly`, `s/friendly s/caring` etc.
8383

8484
* Parameters can be in any order.<br>
8585
e.g. if the command specifies `n/NAME p/PHONE`, `p/PHONE n/NAME` is also acceptable.
@@ -163,7 +163,6 @@ Restrictions:
163163
* At least one of the optional fields must be provided.
164164
* The search is case-insensitive. e.g `n/hans` will match `Hans`.
165165
* Allows partial matching of keywords e.g. `n/Han` will match `Hans`.
166-
* Both the volunteer name and corresponding skills can be searched.
167166
* The order of the keywords does not matter. e.g. `s/chef n/Hans` and `n/Hans s/chef` are valid inputs.
168167

169168
<div style="page-break-after: always;"></div>
@@ -299,7 +298,7 @@ Format: `elist`
299298

300299
Finds events whose name contain any of the given keywords.
301300

302-
Format: `efind n/EVENT_NAME [n/MORE_EVENT_NAME]... ​`
301+
Format: `efind n/EVENT_NAME... ​`
303302

304303
Parameters:
305304
* n/ - Event name to be searched
@@ -359,7 +358,6 @@ Restrictions:
359358
Examples:
360359
* `elist` followed by `edelete 2` deletes the 2nd event in the event list.
361360
* `efind n/Beach cleaning` followed by `edelete 1` deletes the 1st event in the results of the `efind` command
362-
* `efind Beach cleaning` followed by `edelete 1` deletes the 1st event in the results of the `find` command (tentative feature)
363361

364362
#### Edit the details of an event: `eedit`
365363

@@ -397,8 +395,8 @@ Restrictions:
397395
* The assigned volunteers cannot be edited with eedit, to do so, refer to [eaddv](#adding-a-volunteer-into-an-event-eaddv) and [eremovev](#removing-a-volunteer-from-an-event-eremovev) for more detail information.
398396

399397
Examples:
400-
* `eedit 1 n/clean beach r/10 cleaner sd/30/11/2023 1200 l/east coast park dsc/help clean east coast park m/ `
401-
* Edits the event to name `clean beach`, roles needed `10 cleaner`, event date from `30th November 2023, 12pm`, location `east coast park`, description `help clean east coast park` and materials needed to empty.
398+
* `eedit 1 r/10 cleaner sd/30/11/2023 1200 l/east coast park dsc/help clean east coast park m/ `
399+
* Edits the event to roles needed `10 cleaner`, event date from `30th November 2023, 12pm`, location `east coast park`, description `help clean east coast park` and materials needed to empty.
402400

403401
#### Adding and tracking quantity of materials into an event: `eaddm`
404402

@@ -601,21 +599,29 @@ coming soon
601599

602600
<div style="page-break-after: always;"></div>
603601

602+
## Command summary
603+
604604
| Action | Format, Examples |
605605
|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
606606
| **Display help window** | `help` |
607+
| **Create a new volunteer profile** | `vcreate n/NAME p/PHONE e/EMAIL [s/SKILL]...`<br> e.g.,`vcreate n/John Lim p/81234567 e/[email protected] s/Cooking` |
608+
| **List all volunteer profiles** | `vlist` |
609+
| **Finding volunteers by name and skill** | `vfind [n/NAME]…​ [s/SKILL]…` <br> e.g., `vfind n/charlotte s/mechanic` |
610+
| **Edit a volunteer profile** | `vedit VOLUNTEER_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [s/SKILL]…​` <br> e.g., `vedit 1 p/91234567 e/[email protected]` |
611+
| **Delete a volunteer profile** | `vdelete VOLUNTEER_INDEX` <br> e.g., `vdelete 4` |
607612
| **Create a new event** | `ecreate n/NAME r/ROLE_WITH_QUANTITY… sd/START_DATE_AND_TIME [ed/END_DATE_AND_TIME] l/LOCATION dsc/DESCRIPTION [m/MATERIAL_WITH_QUANTITY]... [b/BUDGET] [vs/MAX_VOLUNTEER_COUNT]` <br> e.g., `ecreate n/clean beach r/cleaner sd/30/11/2023 1200 ed/30/11/2023 1800 l/east coast park dsc/clean ECP m/10 gloves m/10 trash bags b/50.00`|
608613
| **List all events** | `elist` |
609-
| **Edit an individual event** | `eedit EVENT_INDEX [r/ROLE_WITH_QUANTITY]... [sd/START_DATE_AND_TIME] [ed/END_DATE_AND_TIME] [l/LOCATION] [dsc/DESCRIPTION] [m/MATERIAL_WITH_QUANTITY]... [b/BUDGET] [vs/MAX_VOLUNTEER_COUNT]` <br> e.g, `eedit 1 r/10 farmer ed/20/11/2024 1300 l/malaysia vs/3` |
614+
| **Finding events by name** | `efind n/EVENT_NAME...` <br> e.g., `efind n/litter n/teaching` |
610615
| **Read an individual event** | `eshow EVENT_INDEX` <br> e.g., `eshow 8` |
611616
| **Delete an event** | `edelete EVENT_INDEX` <br> e.g., `edelete 3` |
617+
| **Edit an individual event** | `eedit EVENT_INDEX [r/ROLE_WITH_QUANTITY]... [sd/START_DATE_AND_TIME] [ed/END_DATE_AND_TIME] [l/LOCATION] [dsc/DESCRIPTION] [m/MATERIAL_WITH_QUANTITY]... [b/BUDGET] [vs/MAX_VOLUNTEER_COUNT]` <br> e.g, `eedit 1 r/10 farmer ed/20/11/2024 1300 l/malaysia vs/3` |
612618
| **Add a quantity of materials to an event** | `eaddm eid/EVENT_INDEX m/MATERIAL_WITH_QUANTITY`<br> e.g., `eaddm eid/1 m/10 potato` |
613-
| **Create a new volunteer profile** | `vcreate n/NAME p/PHONE e/EMAIL [s/SKILL]...`<br> e.g.,`vcreate n/John Lim p/81234567 e/[email protected] s/Cooking` |
614-
| **List all volunteer profiles** | `vlist` |
615-
| **Edit a volunteer profile** | `vedit VOLUNTEER_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [s/SKILL]…​` <br> e.g., `vedit 1 p/91234567 e/[email protected]` |
616-
| **Delete a volunteer profile** | `vdelete VOLUNTEER_INDEX` <br> e.g., `vdelete 4` |
617619
| **Add a volunteer to an event** | `eaddv vid/VOLUNTEER_INDEX eid/EVENT_INDEX`<br> e.g., `eaddv vid/1 eid/3` |
618620
| **Check for volunteers assigned to an event** | `elistv EVENT_INDEX` <br> e.g. `elistv 8` |
619621
| **Check for events joined by a volunteer** | `vliste VOLUNTEER_INDEX` <br> e.g. `vliste 3` |
620622
| **Remove a volunteer from an event** | `eremovev vid/VOLUNTEER_INDEX eid/EVENT_INDEX`<br> e.g., `eremovev vid/3 eid/4` |
623+
| **Undo a command** | `undo` |
624+
| **Redo a command** | `redo` |
621625
| **Exits iVolunteer** | `exit` |
626+
627+
<div style="page-break-after: always;"></div>

0 commit comments

Comments
 (0)