From 05747bc0c3443d6a4a2f2bfd9651ceefeadf4cb0 Mon Sep 17 00:00:00 2001 From: Elyas Alqasim <> Date: Thu, 7 Nov 2024 22:53:23 +0800 Subject: [PATCH] Update user guide with new features --- docs/UserGuide.md | 105 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 91 insertions(+), 14 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 86118c6e861..16aa74cc818 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -127,13 +127,16 @@ Examples: ### Listing all contacts : `list` +**When in the main window** -**When in the main or inspect window** - -Takes you back to the main window, and shows a list of all contacts added to the contacts list. +Shows a list of all contacts added to the contacts list. Format: `list` +**When in the inspect window** + +Shows a list of all deliveries added to a contact's delivery list. Format is the same as in the main window. + ### Editing a contact or delivery: `edit` **When in the main window** @@ -164,7 +167,7 @@ Examples: * `edit 1 i/Speaker c/$50` changes the items and cost of the 1st delivery to be `Speaker` and `$50` respectively. * `edit 2 s/delivered t/` changes the status of the 2nd delivery to be `delivered` and clears all of its tags. -### Locating contacts or deliveries by name: `find` +### Locating contacts by name: `find` **When in the main window** Finds contacts whose names contain any of the given keywords. @@ -186,6 +189,24 @@ Examples: Find command does not work in the inspect window. +### Locating deliveries by item: `finddel` +**When in the main window** + +`finddel` does not work in the main window. + +**When in the inspect window** + +Finds deliveries that contain any of the given items. + +Format: `finddel ITEM [MORE_ITEMS]` +* **Case-insensitive search**: The search does not distinguish between upper or lower case. e.g `mouse` will match `Mouse` +* **Keyword order does not matter**: You can enter keywords in any order. e.g. `Mouse Monitor` will match `Monitor Mouse` +* **"OR" search**: If a delivery contains any of the items, it will be shown. e.g. `Mouse Monitor` will return `Mouse Chair`, `Monitor Desk` + +Examples: +* `finddel Chair` returns any delivery that contains the item chair. +* `find Chair Desk` returns any delivery that contains the item chair, desk, or both. + ### Archiving a contact or delivery : `archive` **When in the main window** @@ -315,6 +336,54 @@ Examples: `inspect` does not work in the inspect window. +### Assigning a delivery to an employee : `assign` +**When in the main window** + +`assign` does not work in the main window. + +**When in the inspect window** + +Assigns the specified delivery from the delivery list of a client to the specified employee. It does not work when inspecting an employee. + +Format: `assign INDEX n/EMPLOYEE_NAME` + +* Assigns the delivery at the specified `INDEX` to the employee specified by `EMPLOYEE_NAME`. +* The index is the number displayed at the top of a delivery in the delivery list of a contact. +* The index **must be a positive number** (starting from 1). +* The worker name should match an existing worker in the contact list. + +Examples: +* `assign 1 n/Betsy Crowe` assigns first delivery of the current contact to employee Betsy Crowe. + +### Remove delivery from employee : `remove` +**When in the main window** + +`remove` does not work in the main window. + +**When in the inspect window** + +Removes the specified delivery from the delivery list of an employee. It does not work when inspecting a client. + +Format: `remove INDEX` + +* Removes the delivery at the specified `INDEX` from the current employee's delivery list. +* The index is the number displayed at the top of a delivery in the delivery list of a contact. +* The index **must be a positive number** (starting from 1). + +Examples: +* `remove 1` removes the first delivery of the current employee's delivery list. + +### Returning to the main window : `back` +**When in the main window** + +`back` does not do anything in the main window. + +**When in the inspect window** + +Takes you back to the main window. + +Format: `back` + ### Clearing all entries : `clear` **When in the main or inspect window** @@ -368,16 +437,22 @@ Furthermore, certain edits can cause the LogiLink to behave in unexpected ways ( Action | Format, Examples -----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL r/ROLE a/ADDRESS [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com r/Client a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Archive**| `archive INDEXES`
e.g., `archive 3`, `archive 3 4` -**Clear** | `clear` -**Delete** | `delete INDEXES`
e.g., `delete 3`, `delete 3 4` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**Inspect**| `inspect INDEX`
e.g., `inspect 2` -**List** | `list` -**Help** | `help` -**Unarchive**| `unarchive INDEXES`
e.g., `unarchive 3`, `unarchive 3 4` +**Add** | Main Window:
`add n/NAME p/PHONE_NUMBER e/EMAIL r/ROLE a/ADDRESS [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com r/Client a/123, Clementi Rd, S123456 t/friend t/colleague`
Inspect Window:
`add i/ITEM…​ e/ETA a/ADDRESS c/COST s/STATUS [t/TAG]…​`
e.g., `add i/Monitor i/Mouse e/2020-02-02 a/311, Clementi Ave 2, #02-25, S120300 c/$100 s/not delivered t/Difficult address to deliver` +**Archive**| Both Windows:
`archive INDEXES`
e.g., `archive 3`, `archive 3 4` +**Assign** | Main Windows:
Does not work
Inpsect Windows:
`assign INDEX n/EMPLOYEE_NAME`
e.g., `assign 1 n/Betsy Crowe` +**Back** | Both Windows:
`back` +**Clear** | Both Windows:
`clear` +**Delete** | Both Windows:
`delete INDEXES`
e.g., `delete 3`, `delete 3 4` +**Edit** | Main Window:
`edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com`
Inspect Window:
`edit INDEX [i/ITEM]…​ [e/ETA] [a/ADDRESS] [c/COST] [s/STATUS] [t/TAG]…​`
e.g., `edit 1 i/Speaker c/$50` +**Find** | Main Window:
`find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake`
Inspect Window:
Does not work +**Find Delivery**| Main Window:
Does not work
Inspect Window:
`finddel ITEM [MORE_ITEMS]` e.g., `finddel Monitor Mouse` +**Help** | Both Windows:
`help` +**Inspect**| Main Window:
`inspect INDEX`
e.g., `inspect 2`
Inspect Window:
Does not work +**List** | Both Windows:
`list` +**Remove** | Main Window:
Does not work
Inspect Window:
`remove INDEX` e.g., `remove 1` +**Sort Ascending**| Both Windows:
`asort by/ATTRIBUTE` +**Sort Descending**| Both Windows:
`dsort by/ATTRIBUTE` +**Unarchive**| Both Windows:
`unarchive INDEXES`
e.g., `unarchive 3`, `unarchive 3 4` -------------------------------------------------------------------------------------------------------------------- @@ -387,3 +462,5 @@ Terms | Meaning -----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Archive** |The action of moving an item, from an active or accessible state to a preserved state by reducing its immediate availability and visibility. **Unarchive** |The action of restoring a previously archived item, to an active or accessible state. +**Client** |A contact that has the role `client` +**Employee** |A contact that has the role `employee`