Merge pull request #114 from Kratious/ug-documentation

UserGuide.adoc: Update Event Management section

docs/UserGuide.adoc

@@ -124,6 +124,7 @@ Format: `clear`
 Exits the program. +
 Format: `exit`
 
+[[command-switch]]
 ==== Switching context : `switch`
 
 Switches context to volunteers or events +
@@ -150,8 +151,8 @@ Adds a volunteer to the system when in the volunteers context +
 Format: `add n/NAME b/BIRTHDAY g/GENDER a/ADDRESS e/EMAIL p/PHONE_NUMBER [t/TAG]...`
 
 ****
-* Birthday is in the 'DD-MM-YYYY format'
-* A volunteer can have any number of tags (including 0)
+* Birthday is in the 'DD-MM-YYYY format'.
+* A volunteer can have any number of tags (including 0).
 ****
 
 Examples:
@@ -194,30 +195,79 @@ Deletes the details of the volunteer specified at index 1
 
 === Event Management
 
+The following commands can only be accessed after switching to the 'event' context. (see <<command-switch>>)
+
 ==== Add new event: `add`
 
-Adds an event to the system when in the event context +
-Format: `add n/NAME l/LOCATION sd/START_DATE ed/END_DATE d/DESCRIPTION [t/TAG]...`
+Adds an event to the system when in the 'event' context. +
+
+Format: `add n/NAME l/LOCATION sd/START_DATE ed/END_DATE st/START_TIME et/END_TIME d/DESCRIPTION [t/TAG]...`
 
 ****
-* Start date and end dates are in the 'DD-MM-YYYY format'
-* An event can have any number of tags (including 0)
+* Start date and end date must be in 'DD-MM-YYYY format'.
+* Start time and end time must be in 'HH:MM format'.
+* An event can have any number of tags (including 0).
 ****
 
 Examples:
 
-* `add n/Flag Day l/Yishun MRT S sd/31-10-2018 ed/31-10-2018 d/For the children's home`
-* `add n/Fundraising l/Tampines S sd/31-09-2018 ed/31-09-2018 d/Raising funds  t/fundraiser t/charity`
+* `add n/Flag Day l/Yishun MRT sd/31-10-2018 ed/31-10-2018 st/09:00 et/15:00 d/For the children's home` +
++
+Adds an event with the following properties:
++
+[options="header", cols="1,3"]
+|===
+|Property   |Value
+|Name       |Flag day
+|Location   |Yishun MRT
+|Start Date |31-10-2018
+|End Date   |31-10-2018
+|Start Time |09:00
+|End Time   |15:00
+|Description|For the children's home
+|===
+
+* `add n/Fundraising l/Tampines Street 31 sd/15-11-2018 ed/17-11-2018 st/13:00 et/18:00 d/Raising funds t/fundraiser
+t/charity`
++
+Adds an event with the following properties:
++
+[options="header", cols="1,3"]
+|===
+|Property   |Value
+|Name       |Fundraising
+|Location   |Tampines Street 31
+|Start Date |15-11-2018
+|End Date   |17-11-2018
+|Start Time |13:00
+|End Time   |18:00
+|Description|Raising funds
+|Tags       |fundraiser, charity
+|===
+
+The figures below show the before and after results of an add command.
+
+--
+.Before entering the add command
+image::command_add_event_before.png[Before add, 800]
+
+.A new event is added after entering the add command
+image::command_add_event_after.png[After add, 800]
+--
+
+
 
 ==== Listing all events : `list`
 
-Lists all events in the system when in the events context. +
+Lists all events in the system when in the 'event' context. +
+
 Format: `list`
 
 ==== Editing event details : `edit`
 
-Edit details of an existing event in the system when in the event context. +
-Format: `edit INDEX [n/NAME] [l/LOCATION] [sd/START_DATE] [ed/END_DATE] [d/DESCRIPTION] [t/TAG]...`
+Edit details of an existing event in the system when in the 'event' context. +
+
+Format: `edit INDEX [n/NAME] [l/LOCATION] [sd/START_DATE] [ed/END_DATE] [st/START_TIME] [et/END_TIME] [d/DESCRIPTION] [t/TAG]...`
 
 ****
 * Edits the event at the specified `INDEX`. The index refers to the index number shown in the displayed event list. The index *must be a positive integer* 1, 2, 3, ...
@@ -230,17 +280,38 @@ Format: `edit INDEX [n/NAME] [l/LOCATION] [sd/START_DATE] [ed/END_DATE] [d/DESCR
 Examples:
 
 * `edit 1 n/Charity Fun Run t/` +
-Edits the name of event at index 1 and removes all tags
+Edits the name of event at index 1 and removes all tags.
+
+The figures below show the before and after results of an edit command.
+
+--
+.Before entering the edit command
+image::command_edit_event_before.png[Before add, 800]
+
+.The targeted event is updated to reflect the new values after entering the edit command
+image::command_edit_event_after.png[After add, 800]
+--
 
 ==== Deleting event details : `delete`
 
-Deletes details of an existing event in the system when in the event context. +
+Deletes details of an existing event in the system when in the 'event' context. +
+
 Format: `delete INDEX`
 
 Examples:
 
-* `delete 1` +
-Deletes the details of the event specified at index 1
+* `delete 2` +
+Deletes the details of the event specified at index 2.
+
+The figures below show the before and after results of a delete command.
+
+--
+.The event at index 2 is targeted before entering the delete command
+image::command_delete_event_before.png[Before add, 800]
+
+.The targeted event is deleted after entering the delete command
+image::command_delete_event_after.png[After add, 800]
+--
 
 === Record Management
 
@@ -350,7 +421,8 @@ e.g. `delete 3`
 
 === Event Management
 * *Add* `add n/NAME l/LOCATION sd/START_DATE ed/END_DATE d/DESCRIPTION [t/TAG]...` +
-e.g. `add n/Fundraising l/Tampines S sd/31-09-2018 ed/31-09-2018 d/Raising funds  t/fundraiser t/charity`
+e.g. `add n/Fundraising l/Tampines S sd/31-09-2018 ed/31-09-2018 st/13:00 et/18:00 d/Raising funds t/fundraiser
+t/charity`
 * *List* : `list`
 * *Edit* : `edit INDEX [n/NAME] [l/LOCATION] [sd/START_DATE] [ed/END_DATE] [d/DESCRIPTION] [t/TAG]...` +
 e.g. `edit 2 n/Fundraiser`