diff --git a/docs/UserGuide.md b/docs/UserGuide.md index fa83e06887e..c507e0dc8c7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -188,19 +188,40 @@ Parameters: INDEX (must be a positive integer) ### Add meeting time -- What it does: Adds a meeting time for a lead -- Command format: `addmeetingtime INDEX m/MEETING_TIME` -- Example usage: `addmeetingtime 1 m/12/12/2020 12:00` +- What it does: Adds a meeting time to a person. +- Command format: `addmeeting INDEX m/MEETING_TIME` +- Example usage: `addmeeting 1 m/12/10/2023 16:00` + +
+ +

Before using addmeeting

+
+ +
+ +

After using addmeeting

+
+ - Acceptable values for each parameter: - - `INDEX`: Any integer from `1` to the last index of the leads list. + - `INDEX`: Any integer from `1` to the last index of the displayed list. - `MEETING_TIME`: A string of format `dd/MM/yyyy HH:mm`. - Precise expected outputs when the command succeeds: -`Meeting time added to : ` +`Added Meeting: to Person ` - Precise expected outputs when the command fails: -`Meeting time failed to add. Please enter a valid lead id or meeting time` +When adding a meeting time to an invalid index or with an invalid datetime format: +``` +Invalid command format! +addmeeting: Adds a new meeting time to the person identified by the displayed index in the address book. +Parameters: INDEX (must be a positive integer) m/MEETING_TIME +Example: addmeeting 1 m/12/10/2023 16:00 +``` + +When adding a meeting time to a person who already has an existing meeting: + +`Person already has a meeting time, use the edit command instead` ### Delete meeting time for lead @@ -218,6 +239,28 @@ Parameters: INDEX (must be a positive integer) `Meeting time failed to be deleted. Please enter a valid lead id or meeting time` + +### Sort meeting time + +- What it does: Sorts the meeting times of all leads and clients chronologically, displaying +only entries with a meeting time. +- Command format: `sortmeeting` +- Example usage: + +
+ +

Before using sortmeeting

+
+ +
+ +

After using sortmeeting

+
+ +- Precise expected outputs when the command succeeds: + +`Sorted all meeting times chronologically` + ### Convert lead to client - What it does: Converts a lead to client. @@ -248,3 +291,4 @@ from current date to ensure a followup by the user - Precise expected outputs when the command fails: `The person index provided is invalid` + diff --git a/docs/images/afteraddmeeting.png b/docs/images/afteraddmeeting.png new file mode 100644 index 00000000000..9883413d4c0 Binary files /dev/null and b/docs/images/afteraddmeeting.png differ diff --git a/docs/images/aftersortmeeting.png b/docs/images/aftersortmeeting.png new file mode 100644 index 00000000000..971777c6905 Binary files /dev/null and b/docs/images/aftersortmeeting.png differ diff --git a/docs/images/beforeaddmeeting.png b/docs/images/beforeaddmeeting.png new file mode 100644 index 00000000000..58943808db2 Binary files /dev/null and b/docs/images/beforeaddmeeting.png differ diff --git a/docs/images/beforesortmeeting.png b/docs/images/beforesortmeeting.png new file mode 100644 index 00000000000..7449a0d29a5 Binary files /dev/null and b/docs/images/beforesortmeeting.png differ