diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 542ca0eb1aa..2be872881fa 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -6,6 +6,8 @@ # Hi:Re User Guide +--- + ## Table of Contents - [Welcome Note](#welcome-note) @@ -13,16 +15,17 @@ - [Quick Start](#quick-start) - [Commands](#commands) 1) [Registering an Account](#registering-an-account-register) - 2) [Login into Account](#login-into-account-login) - 2) [Logout from Account](#logout-from-account-logout) - 2) [Adding a Contact](#adding-a-contact) - 2) [Deleting a Contact](#deleting-a-contact) - 3) [Editing a Contact](#editing-a-contact) - 4) [Toggling the display](#toggling-the-display) - 5) [Finding Contacts by Name](#finding-contacts-by-name) - 5) [Listing all matching information](#listing-all-matching-information-ls) - 6) [Undoing a Command](#undoing-a-command-undo) - 7) [Redoing a Command](#redoing-a-command-redo) + 1) [Login into Account](#login-into-account-login) + 1) [Logout from Account](#logout-from-account-logout) + 1) [Adding a Contact](#adding-a-contact) + 1) [Deleting a Contact](#deleting-a-contact) + 1) [Editing a Contact](#editing-a-contact) + 1) [Toggling the display](#toggling-the-display) + 1) [Finding Contacts by Name](#finding-contacts-by-name) + 1) [Listing all matching information](#listing-all-matching-information-ls) + 1) [Undoing a Command](#undoing-a-command-undo) + 1) [Redoing a Command](#redoing-a-command-redo) + 1) [Link to User Guide](#link-to-our-user-guide-help) - [Built-In Features](#built-in-features) - [FAQ](#faq) - [Known Issues](#known-issues) @@ -30,6 +33,8 @@ - [Future Integrations](#future-integrations) - [Support and Feedback](#support-and-feedback) +--- + ## Welcome Note Greetings HR employees, managers and executives! @@ -45,14 +50,16 @@ can do for you and if it suits your companies' needs! After that, dive into the **[quick start](#quick-start)** section, and we hope you enjoy using Hi:Re as your company's HR employee profiling solution! +
+ + back to top + +
- -*** +--- ## Product Information -[back to top](#table-of-contents) - Hi:Re is a **desktop app for managing employee details, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). @@ -75,7 +82,7 @@ Contacts are also labelled with one mandatory tag and optional additional tags. -Breakdown of commands: +Breakdown of commands: 1) Register, Login and Logout: Data Management 2) Adding a Contact 3) Deleting a Contact @@ -86,13 +93,19 @@ Breakdown of commands: 8) Undoing a Command 9) Redoing a Command 10) Export data into .csv file +11) Link to our User Guide + +
+ + back to top + +
-*** +--- -## Quick start -[back to top](#table-of-contents) +## Quick Start -1. Ensure you have Java `11` or above installed in your Computer. +1. Ensure you have `Java 11` or above installed in your Computer. 1. Download the latest `HiRe.jar` from [here](https://github.com/AY2324S2-CS2103T-T12-3/tp/releases). @@ -116,33 +129,36 @@ Breakdown of commands: 1. Refer to the [Built-In Features](#features) below for details of built-in features. -*** + +
+ + back to top + +
+ +--- ## Commands -[back to top](#table-of-contents) **Notes about the command format:**
* Words in `()` are the parameters to be supplied by the user.
- e.g. in `- /id (id)`, `(id)` is a parameter which can be used as `- /id johndoe69`. + e.g. for `- /id (id)`, `(id)` is the parameter to be supplied by the user. The user will input a similar command into the command box: `- /id johndoe69`. * If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. - +--- ### Registering an Account: `register` -[back to top](#table-of-contents) Register an account first to have your own address book!

Format: `register /u (username) /p (password)`

@@ -153,7 +169,7 @@ Example: `register /u johndoe /p 123456`
* This command can also be used by clicking in the `Account` section of the menu bar.

* A valid password is between 6 and 20 characters long and does not contain spaces.

* A valid username should be alphanumeric and between 4 and 10 characters long.

-* Usernames are unique and cannot be duplicated.
+* Usernames are unique and cannot be duplicated.

**Confirmation of Successful Registration**
@@ -190,8 +206,15 @@ If the user registers successfully, a graphical user interface (GUI) indicative

+
+ + back to top + +
+ +--- + ### Login into Account: `login` -[back to top](#table-of-contents) Login to access your addressbook.

Format: `login /u (username) /p (password)`

@@ -243,8 +266,15 @@ If the user Logins successfully, a graphical user interface (GUI) indicative of

+
+ + back to top + +
+ +--- + ### Logout from Account: `logout` -[back to top](#table-of-contents) After you end accessing your addressbook, log out to protect the data.

Format: `logout`

@@ -266,9 +296,15 @@ If the user Logouts successfully, a graphical user interface (GUI) indicative of

+
+ + back to top + +
+ +--- ### Adding a contact: `+` -[back to top](#table-of-contents) Adds a person to the address book.

@@ -333,8 +369,15 @@ If the user Logouts successfully, a graphical user interface (GUI) indicative of

+
+ + back to top + +
+ +--- + ### Deleting a contact: `-` -[back to top](#table-of-contents) Deletes a person with his specified ID.

@@ -355,6 +398,7 @@ If the user Logouts successfully, a graphical user interface (GUI) indicative of Following the accurate input of the command, if the person with the input id does exist in the address book, a window will pop up asking for your confirmation to delete. Click OK to continue with the deletion. After confirmation, a graphical user interface (GUI) indicative of a successful contact deletion will be displayed, as illustrated below. + * Pop-up window for confirmation @@ -362,7 +406,9 @@ If the user Logouts successfully, a graphical user interface (GUI) indicative of

* GUI upon successful addition command

-

+ +

+ * **Error Handling Protocols**
@@ -391,8 +437,15 @@ If the user Logouts successfully, a graphical user interface (GUI) indicative of

+
+ + back to top + +
+ +--- + ### Editing a contact: `>` -[back to top](#table-of-contents) Edits a person in the address book.

@@ -457,9 +510,15 @@ GUI upon successful addition command



+
+ + back to top + +
+ +--- ### Toggling the display: `$` -[back to top](#table-of-contents) Toggles the display to view / hide the contacts panel of Hi:Re.

@@ -475,68 +534,168 @@ Toggles the display to view / hide the contacts panel of Hi:Re.



+
+ + back to top + +
+ +--- + ### Finding Contacts by Name: `?` -[back to top](#table-of-contents) Finds all contacts in the Hi:Re app that has names matching the words entered. -Format: ? (name)
- -Example: ? jo - ? jo a
+Format: ? (keyword)
* All names consist of alphanumeric characters, hence any non-alphanumeric characters used will result in no contacts found. -* All names that contain the words entered will be matched. E.g `? jo` will give John if John exists in the contacts -list. -* More than one word can be entered, separated by spaces. All names that match **any** of the words will be matched. +* All names that contain the `(keyword)` entered will be matched.
+E.g `? jo` will give John if John exists in the contacts list. +* More than one `(keyword)` can be entered, separated by spaces. All names that match **any** of the words will be listed.
E.g `? jo a` will give John and Ali if both of them exists in the contacts list. +* `(keyword)` used to match names are **CASE-INSENSITIVE**. + + +Example: + + + Finding with one `(keyword)`: ? al

+

+ + + + Finding with more than one `(keyword)`: ? al ch

+

+ +
+ + back to top + +
+ +--- + ### Listing all matching information: `ls` -[back to top](#table-of-contents) - List has different functionalities.

+List has different functionalities.

- Format: ls ARGS
- - ARGS = -a: List all contacts in the address book.
- ARGS = -t: List all tags available.
- ARGS = TAG_NAME: List all contacts with TAG_NAME.
+Format: ls (args)
+(args) = -a: List all contacts in the address book.
+(args) = -t: List all tags available.
+(args) = (tag_name): List all contacts with (tag_name).
+ + + +* All tags consist of alphanumeric characters, hence any non-alphanumeric characters used will result in no contacts found.
+* More than one `(tag_name)` can be entered, separated by spaces. All tags that match **any** of the words will be listed.
+E.g `ls H fin` will list all contacts with tags containing `H` **OR** `fin`.
+* `(tag_name)` used to match tags are **CASE-SENSITIVE**. + + + +Example: + + + -a: List all contacts in the address book.
+ Command: ls -a

+

+ + + + (args) = -t: List all tags available.
+ Command: ls -t

+

+ + + + (tag_name): List all contacts with ONE (tag_name).
+ Example: ls H

+

+ + + + (tag_name): List all contacts with MORE THAN ONE (tag_name).
+ Example: ls H fin

+

+ + +
+ + back to top + +
+ +--- ### Add Tag: `tag+` -[back to top](#table-of-contents) - Add tag into a tag list.

+Add tag into a tag list.

- Format: tag+ TAG_NAME
+Format: tag+ (tag_name)
- + -* **MUST** add a tag into a tag list before adding a person. +* Default tags: `HR`, `operations`, `finance`, `marketing`, `IT`, `sales` & `RnD` +* Tags are **CASE-SENSITIVE**. +Example: + + + Adding the tag CEO: tag+ CEO

+

+ + +**Error Handling Protocols**
+ + + Duplicate tags.

+

+ + + +
+ + back to top + +
+ +--- ### Delete Tag: `tag-` -[back to top](#table-of-contents) Delete tag from the tag list.

- Format: tag- TAG_NAME
+ Format: tag- (tag_name)
- - - Tag cannot be removed if a person is tagged with the tag-to-be-removed. - + + +* Tag cannot be removed if a person is tagged with the tag-to-be-removed. +Example: + + + Removing the tag HR: tag- HR

+

+ + +
+ + back to top + +
+ +--- ### Undoing a Command: `undo` -[back to top](#table-of-contents) Restores the address book to the state before the previous **undoable** command was executed.
Format: `undo`
@@ -567,8 +726,15 @@ Example:


 +
+ + back to top + +
+ +--- + ### Redoing a Command: `redo` -[back to top](#table-of-contents) Reverses the most recently undone command.
Format: `redo`
@@ -600,104 +766,16 @@ Example:


 +
+ + back to top + +
- - -*** +--- ## Built-In Features -[back to top](#table-of-contents) - Features are built-in for the ease of use. They do not require any commands for it to work. ### Sort @@ -713,8 +791,17 @@ Features are built-in for the ease of use. They do not require any commands for

+
+ + back to top + +
+ +--- + ### Delete sample data + Sample data is deleted when you add the first contact into the addressbook.

@@ -727,8 +814,35 @@ Features are built-in for the ease of use. They do not require any commands for

+
+ + back to top + +
+ +--- + +### Link to our User Guide: `help` + +Leads you to our user guide (i.e. this page) for guidance when using the application. + +Format: `help` + + + Pop-up box upon running the command.

+

+ + +
+ + back to top + +
+ +--- ### Information security + We try our best to protect the private information in your addressbook.

1. **Password Hashing**
@@ -744,34 +858,48 @@ Features are built-in for the ease of use. They do not require any commands for However, we are working on a more secure solution for future versions of the application. -*** +
+ + back to top + +
-## FAQ +--- -[back to top](#table-of-contents) +## FAQ **A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Hi:Re home folder. + **A**: Java 11 is the version of the Java Programming Language that our application uses to function. Any version of Java, 11 and above will work. You can download it from the [official Java website](https://www.oracle.com/sg/java/). -*** +
+ + back to top + +
+ +--- ## Known issues -[back to top](#table-of-contents) 1. **When using multiple screens**, 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. -*** +
+ + back to top + +
-## Command summary +--- -[back to top](#table-of-contents) +## Command summary Action | Format -----------|--------- @@ -780,11 +908,15 @@ Action | Format **Edit** | `> (id) /name (name) /hp (handphone)` **Toggle** | `$` -*** +
+ + back to top + +
-## Future Integrations +--- -[back to top](#table-of-contents) +## Future Integrations **In the future, we plan to integrate some of the following features:** @@ -796,12 +928,22 @@ Action | Format organisation's requirements. 4. **Multiple phone numbers**, allowing for contacts to add in both their office and personal phone numbers. -*** +
+ + back to top + +
-## Support and Feedback +--- -[back to top](#table-of-contents) +## Support and Feedback We are a dedicated team of developers committed to evolving Hi:Re to always be better. Should you have any enquiries or feedback, do reach out to us at our [website!](https://github.com/AY2324S2-CS2103T-T12-3) + +
+ + back to top + +
diff --git a/docs/images/helpMessage.png b/docs/images/helpMessage.png deleted file mode 100644 index b1f70470137..00000000000 Binary files a/docs/images/helpMessage.png and /dev/null differ diff --git a/docs/images/ui/find/1.png b/docs/images/ui/find/1.png new file mode 100644 index 00000000000..8ee2149580b Binary files /dev/null and b/docs/images/ui/find/1.png differ diff --git a/docs/images/ui/find/2.png b/docs/images/ui/find/2.png new file mode 100644 index 00000000000..b575e841fd3 Binary files /dev/null and b/docs/images/ui/find/2.png differ diff --git a/docs/images/ui/help/1.png b/docs/images/ui/help/1.png new file mode 100644 index 00000000000..e57c9298bc5 Binary files /dev/null and b/docs/images/ui/help/1.png differ diff --git a/docs/images/ui/list/image1.png b/docs/images/ui/list/image1.png new file mode 100644 index 00000000000..37d35c10c9d Binary files /dev/null and b/docs/images/ui/list/image1.png differ diff --git a/docs/images/ui/list/image2.png b/docs/images/ui/list/image2.png new file mode 100644 index 00000000000..64a2997574a Binary files /dev/null and b/docs/images/ui/list/image2.png differ diff --git a/docs/images/ui/list/image3.png b/docs/images/ui/list/image3.png new file mode 100644 index 00000000000..3c68ab78bcc Binary files /dev/null and b/docs/images/ui/list/image3.png differ diff --git a/docs/images/ui/list/image4.png b/docs/images/ui/list/image4.png new file mode 100644 index 00000000000..99f90ef48a8 Binary files /dev/null and b/docs/images/ui/list/image4.png differ diff --git a/docs/images/ui/tag_minus/1.png b/docs/images/ui/tag_minus/1.png new file mode 100644 index 00000000000..4f8f18eb46f Binary files /dev/null and b/docs/images/ui/tag_minus/1.png differ diff --git a/docs/images/ui/tag_plus/1.png b/docs/images/ui/tag_plus/1.png new file mode 100644 index 00000000000..7d64240c038 Binary files /dev/null and b/docs/images/ui/tag_plus/1.png differ diff --git a/docs/images/ui/tag_plus/2.png b/docs/images/ui/tag_plus/2.png new file mode 100644 index 00000000000..7d077ed7f21 Binary files /dev/null and b/docs/images/ui/tag_plus/2.png differ