forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #247 from johnnythesnake12/master
Update UG format
- Loading branch information
Showing
1 changed file
with
33 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,11 +9,11 @@ Insurahub is a **desktop app for managing clients, optimized for use via a Comma | |
| 1. [Viewing help](#viewing-help--help) | ||
| 2. [Adding a new client](#adding-a-new-client-add) | ||
| 3. [Listing all clients](#listing-all-clients--list) | ||
| 4. [Edit a client](#editing-a-person--edit) | ||
| 4. [Edit a client](#editing-a-client--edit) | ||
| 5. [Locating clients by name](#locating-clients-by-name-find) | ||
| 6. [Deleting a client](#deleting-a-client--delete) | ||
| 7. [Clearing all entries](#clearing-all-entries--clear) | ||
| 8. [Filtering a person via tags](#filtering-for-clients-via-tag--filter) | ||
| 8. [Filtering a client via tags](#filtering-for-clients-via-tag--filter) | ||
| 9. [Adding a policy to a client](#adding-a-policy-to-a-client--addpolicy) | ||
| 10. [Removing a policy from a client](#removing-a-policy-from-a-client--removepolicy) | ||
| 11. [Viewing policy from a client](#viewing-policy-of-a-client-viewpolicy) | ||
|
|
@@ -151,7 +151,7 @@ Format: `list` | |
|
|
||
| Edits an existing client in the application. | ||
|
|
||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [pmr/_MEETING_REGION]` | ||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]… [pmr/PREFERRED_MEETING_REGION]` | ||
|
|
||
| - Edits the client at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … | ||
| - At least one of the optional fields must be provided. | ||
|
|
@@ -210,10 +210,10 @@ Format: `clear` | |
|
|
||
| Filters for all clients in InsuraHub that have the tag being filtered. | ||
|
|
||
| Format: `filter t/TAG1 t/TAG2` | ||
| Format: `filter t/TAG_1 [t/TAG_2]` | ||
|
|
||
| - Filters for person objects that contain all the specified tags `TAG1`, `TAG2`. | ||
| - Only person objects that contain all the specified tags will be listed in the Ui. | ||
| - Filters for clients that contain all the specified tags `TAG1`, `TAG2`. | ||
| - Only clients that contain all the specified tags will be listed in the Ui. | ||
|
|
||
| Examples: | ||
|
|
||
|
|
@@ -225,7 +225,7 @@ Examples: | |
|
|
||
| Adds an insurance policy to a client in InsuraHub. | ||
|
|
||
| Format: `addPolicy INDEX [pn/POLICY NAME] [pd/POLICY DESCRIPTION] [pv/POLICY VALUE] [psd/POLICY START DATE] [ped/POLICY END DATE]` | ||
| Format: `addPolicy INDEX pn/POLICY NAME pd/POLICY DESCRIPTION pv/POLICY VALUE psd/POLICY START DATE ped/POLICY END DATE` | ||
|
|
||
| - `INDEX` must be a positive integer less than or equals to the number of clients currently shown on InsuraHub. | ||
|
|
||
|
|
@@ -254,7 +254,7 @@ Examples: | |
|
|
||
| Creates/opens up a folder specific to a client for storing of their documents | ||
|
|
||
| Format 1: `viewPolicy INDEX_1 INDEX_2` | ||
| Format: `viewPolicy INDEX_1 INDEX_2` | ||
|
|
||
| - `INDEX_1` must be a positive integer less than or equals to the number of clients currently shown on InsuraHub. | ||
| - `INDEX_2` must be a positive integer less than or equals to the number of policies the client specified by `INDEX_1` has. | ||
|
|
@@ -293,7 +293,7 @@ Format: `exit` | |
|
|
||
| Adds at least one new tags to a client object without deleting the pre-exisiting tags. | ||
|
|
||
| Format 1: `addTag INDEX t/TAG_1 t/TAG_2` | ||
| Format: `addTag INDEX t/TAG_1 [t/TAG_2]` | ||
|
|
||
| - Number of tags in the format is just an example. | ||
|
|
||
|
|
@@ -307,7 +307,7 @@ Examples: | |
|
|
||
| Removes at least one pre-existing tags from a client object. | ||
|
|
||
| Format 1: `deleteTag INDEX t/TAG_1 t/TAG_2`<br> | ||
| Format: `deleteTag INDEX t/TAG_1 [t/TAG_2]`<br> | ||
|
|
||
| - Number of tags in the format is just an example. | ||
|
|
||
|
|
@@ -322,7 +322,7 @@ Examples: | |
|
|
||
| Creates/opens up a folder specific to a client's name for storing of their documents. When it is first created, it will be empty. We can add client's documents into the file and it will be saved in the file after closing the window. | ||
|
|
||
| Format 1: `file INDEX` | ||
| Format: `file INDEX` | ||
|
|
||
| - **INDEX** must be a positive integer less than or equals to the number of clients currently shown on Insurahub. | ||
|
|
||
|
|
@@ -334,7 +334,11 @@ Examples: | |
|
|
||
| Groups clients based on their preferred meeting locations, only list one of west, north, south, east or central per command. | ||
|
|
||
| Format: `groupmeeting west/north/south/east/central` | ||
| Format: `groupmeeting PREFERRED_MEETING_LOCATION` | ||
|
|
||
| - **PREFERRED_MEETING_LOCATION** must be either north,south,east,west or central | ||
|
|
||
|
|
||
|
|
||
| Examples: | ||
|
|
||
|
|
@@ -344,10 +348,10 @@ Examples: | |
|
|
||
| Changes the required password to enter Insurahub. | ||
|
|
||
| Format: `changePassword op/OLDPASSWORD np/NEWPASSWORD` | ||
| Format: `changePassword op/OLD_PASSWORD np/NEW_PASSWORD` | ||
|
|
||
| - `OLDPASSWORD` must be the password string that was previously set | ||
| - `NEWPASSWORD` can be any string of length >= 1 | ||
| - `OLD_PASSWORD` must be the password string that was previously set | ||
| - `NEW_PASSWORD` can be any string of length >= 1 | ||
|
|
||
| Examples: | ||
|
|
||
|
|
@@ -370,7 +374,7 @@ Examples: | |
| - Typing non string characters will not return an error, however it might be an issue as it is unlikely that policy description contains non string characters. | ||
| - If policy description is 123 and you filter 123, it will return the policy. | ||
|
|
||
| Format: `filterpolicydescription POLICYDESCRIPTION` | ||
| Format: `filterpolicydescription POLICY_DESCRIPTION` | ||
|
|
||
| Examples: | ||
|
|
||
|
|
@@ -403,39 +407,39 @@ If your changes to the data file makes its format invalid, Insurahub will discar | |
| If you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. | ||
|
|
||
| 2. **When opening multiple application using multiple terminals**<br> | ||
| If you do any actions on the first application, the updates will not be shown on the second application as currently we do not allow application to work simultaneously. | ||
| If you perform any actions on the first application, the updates will not be shown on the second application as currently we do not allow application to work simultaneously. | ||
|
|
||
| 3. **Clients/Persons/Contacts** will generally be regarded as the same in insurahub even though it can be confusing | ||
| 3. **Clients/Persons/Contacts** will generally be regarded as the same in insurahub even though it can be confusing. | ||
|
|
||
| 4. **Policy date issue**<br> | ||
| Putting the end date earlier than the start date for policies is currently accepted, we have acknowledge the error and will work to improve the application to remove those errors. | ||
|
|
||
| 5. **Client Files of deleted/edited clients are retained**<br> | ||
| At this point the application is unable to delete the files of deleted clients or edit the files of edited clients, we can only delete, edit it manually. | ||
| At this point, the application is unable to delete the files of deleted clients or edit the files of edited clients, we can only delete, edit it manually. | ||
|
|
||
| --- | ||
|
|
||
| ## Command summary | ||
|
|
||
| | Action | Format, Examples | | ||
| | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pmr/east [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 pmr/east t/friend t/colleague` | | ||
| |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pmr/PREFERRED_MEETING_REGION [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 pmr/east t/friend t/colleague` | | ||
| | **Clear** | `clear` | | ||
| | **Delete** | `delete INDEX`<br> e.g., `delete 3` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | | ||
| | **Exit** | `exit` | | ||
| | **File** | `file INDEX`<br> e.g. `file 1` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | | ||
| | **Add Tag** | `addTag <INDEX> t/TAG1 t/TAG2`<br/> e.g. `addTag 1 t/friend` | | ||
| | **DeleteTag** | `deleteTag <INDEX> t/TAG1 t/TAG2`<br/> e.g. `deleteTag 1 t/friend` | | ||
| | **Filter Tag** | `filter t/TAG1 t/TAG2`<br/> e.g., `filter t/friend t/colleague` | | ||
| | **Add Tag** | `addTag <INDEX> t/TAG_1 t/TAG_2`<br/> e.g. `addTag 1 t/friend` | | ||
| | **Delete Tag** | `deleteTag <INDEX> t/TAG_1 t/TAG_2`<br/> e.g. `deleteTag 1 t/friend` | | ||
| | **Filter Tag** | `filter t/TAG_1 t/TAG_2`<br/> e.g., `filter t/friend t/colleague` | | ||
| | **List** | `list` | | ||
| | **Add Policy** | `addPolicy INDEX [pn/POLICY NAME pd/POLICY DESCRIPTION pv/POLICY VALUE psd/POLICY START DATE ped/POLICY END DATE]`<br/> e.g. `addPolicy 1 pn/Health Insurance pd/Cancer Plan pv/2000.00 psd/2023-01-01 ped/2024-12-12 ` | | ||
| | **Add Policy** | `addPolicy INDEX [pn/POLICY_NAME pd/POLICY_DESCRIPTION pv/POLICY_VALUE psd/POLICY_START_DATE ped/POLICY_END_DATE]`<br/> e.g. `addPolicy 1 pn/Health Insurance pd/Cancer Plan pv/2000.00 psd/2023-01-01 ped/2024-12-12 ` | | ||
| | **Remove Policy** | `removePolicy INDEX_1 INDEX_2`<br/> e.g. `removePolicy 1 1` | | ||
| | **View Policy** | `viewPolicy INDEX_1 INDEX_2`<br/> e.g. `viewPolicy 1 1` | | ||
| | **Filter Policy Description** | `filterpolicydescription POLICY DESCRIPTION` | | ||
| | **Filter Policy Description** | `filterpolicydescription POLICY_DESCRIPTION` | | ||
| | **Help** | `help` | | ||
| | **Preferred Contact** | `preferredContact INDEX pc/PREFERREDCONTACT`<br/> e.g. `preferredContact 1 pc/phone` | | ||
| | **Change Password** | `changePassword op/OLD PASSWORD np/NEW PASSWORD`<br/>e.g. `changePassword op/123456 np/foo123` | | ||
| | **Preferred Contact** | `preferredContact INDEX pc/PREFERRED_CONTACT`<br/> e.g. `preferredContact 1 pc/phone` | | ||
| | **Change Password** | `changePassword op/OLD_PASSWORD np/NEW_PASSWORD`<br/>e.g. `changePassword op/123456 np/foo123` | | ||
| | **Toggle UI Mode** | `toggleMode` | | ||
| | **Group Meeting** | `groupmeeting PREFERRED MEETING REGION` <br> e.g. `groupmeeting west` | | ||
| | **Group Meeting** | `groupmeeting PREFERRED_MEETING_REGION` <br> e.g. `groupmeeting west` | | ||