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.
- Loading branch information
1 parent
655b6bb
commit 3da95d7
Showing
2 changed files
with
70 additions
and
71 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 |
|---|---|---|
|
|
@@ -4,14 +4,14 @@ | |
| pageNav: 3 | ||
| --- | ||
|
|
||
| # AB-3 User Guide | ||
| # HR Insight User Guide | ||
|
|
||
| AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. | ||
| HR Insight is a **desktop app for HR people, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). | ||
|
|
||
| <!-- * Table of Contents --> | ||
| <page-nav-print /> | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| --- | ||
|
|
||
| ## Quick start | ||
|
|
||
|
|
@@ -28,43 +28,43 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo | |
| 1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br> | ||
| Some example commands you can try: | ||
|
|
||
| * `list` : Lists all contacts. | ||
| - `list` : Lists all contacts. | ||
|
|
||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. | ||
| - `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. | ||
|
|
||
| * `delete 3` : Deletes the 3rd contact shown in the current list. | ||
| - `delete 3` : Deletes the 3rd contact shown in the current list. | ||
|
|
||
| * `clear` : Deletes all contacts. | ||
| - `clear` : Deletes all contacts. | ||
|
|
||
| * `exit` : Exits the app. | ||
| - `exit` : Exits the app. | ||
|
|
||
| 1. Refer to the [Features](#features) below for details of each command. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| <box type="info" seamless> | ||
|
|
||
| **Notes about the command format:**<br> | ||
|
|
||
| * Words in `UPPER_CASE` are the parameters to be supplied by the user.<br> | ||
| - Words in `UPPER_CASE` are the parameters to be supplied by the user.<br> | ||
| e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. | ||
|
|
||
| * Items in square brackets are optional.<br> | ||
| - Items in square brackets are optional.<br> | ||
| e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. | ||
|
|
||
| * Items with `…` after them can be used multiple times including zero times.<br> | ||
| - Items with `…` after them can be used multiple times including zero times.<br> | ||
| e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. | ||
|
|
||
| * Parameters can be in any order.<br> | ||
| - Parameters can be in any order.<br> | ||
| e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. | ||
|
|
||
| * Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br> | ||
| - Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br> | ||
| e.g. if the command specifies `help 123`, it will be interpreted as `help`. | ||
|
|
||
| * 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. | ||
| </box> | ||
| - 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. | ||
| </box> | ||
|
|
||
| ### Viewing help : `help` | ||
|
|
||
|
|
@@ -74,76 +74,76 @@ Shows a message explaning how to access the help page. | |
|
|
||
| Format: `help` | ||
|
|
||
| ### Adding an employee: `add` | ||
|
|
||
| ### Adding a person: `add` | ||
| Adds an employee to the employee list. | ||
|
|
||
| Adds a person to the address book. | ||
| Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SALARY b/CLAIM_BUDGET d/DEPARTMENT dob/BIRTH_DATE (YYYY-MM-DD)` | ||
|
|
||
| Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` | ||
| Examples: | ||
|
|
||
| <box type="tip" seamless> | ||
| - `add n/Adam p/12345678 e/[email protected] a/Singapore s/10000 b/5000 d/Engineering dob/2000-01-01` | ||
| - `add n/John Doe p/87654321 e/[email protected] a/Tokyo s/5000 b/2000 d/Sales dob/1992-07-21` | ||
|
|
||
| **Tip:** A person can have any number of tags (including 0) | ||
| </box> | ||
| ### Listing all employees : `list` | ||
|
|
||
| Examples: | ||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` | ||
| * `add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal` | ||
| Lists all the details of an organization’s employees, or list all employees of a specified department. | ||
|
|
||
| ### Listing all persons : `list` | ||
| Format: `list [d/DEPARTMENT]` | ||
|
|
||
| Shows a list of all persons in the address book. | ||
| Examples: | ||
|
|
||
| Format: `list` | ||
| - `list` | ||
| - `list d/Engineering` | ||
|
|
||
| ### Editing a person : `edit` | ||
| ### Editing an employee's information : `edit` | ||
|
|
||
| Edits an existing person in the address book. | ||
| Edits an existing employee in the employee list by the specified index. | ||
|
|
||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | ||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [s/SALARY] [b/CLAIM_BUDGET] [d/DEPARTMENT] [dob/BIRTH_DATE (YYYY-MM-DD)]` | ||
|
|
||
| * Edits the person 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. | ||
| * Existing values will be updated to the input values. | ||
| * When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. | ||
| * You can remove all the person’s tags by typing `t/` without | ||
| specifying any tags after it. | ||
| - Edits the employee at the specified `INDEX`. The index refers to the index number shown in the displayed employee list. | ||
| The index **must be a positive integer** 1, 2, 3, … | ||
| - At least one of the optional fields must be provided. | ||
| - Existing values will be updated to the input values. | ||
|
|
||
| Examples: | ||
| * `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively. | ||
| * `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. | ||
|
|
||
| - `edit 1 p/23423423 e/[email protected]` Edits the phone number and email address of the 1st person to be `23423423` and `[email protected]` respectively. | ||
|
|
||
| ### Locating persons by name: `find` | ||
|
|
||
| Finds persons whose names contain any of the given keywords. | ||
|
|
||
| Format: `find KEYWORD [MORE_KEYWORDS]` | ||
|
|
||
| * The search is case-insensitive. e.g `hans` will match `Hans` | ||
| * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` | ||
| * Only the name is searched. | ||
| * Only full words will be matched e.g. `Han` will not match `Hans` | ||
| * Persons matching at least one keyword will be returned (i.e. `OR` search). | ||
| - The search is case-insensitive. e.g `hans` will match `Hans` | ||
| - The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans` | ||
| - Only the name is searched. | ||
| - Only full words will be matched e.g. `Han` will not match `Hans` | ||
| - Persons matching at least one keyword will be returned (i.e. `OR` search). | ||
| e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` | ||
|
|
||
| Examples: | ||
| * `find John` returns `john` and `John Doe` | ||
| * `find alex david` returns `Alex Yeoh`, `David Li`<br> | ||
|
|
||
| - `find John` returns `john` and `John Doe` | ||
| - `find alex david` returns `Alex Yeoh`, `David Li`<br> | ||
|  | ||
|
|
||
| ### Deleting a person : `delete` | ||
| ### Deleting an employee : `delete` | ||
|
|
||
| Deletes the specified person from the address book. | ||
| Delete an employee in the employee list by the specified index. | ||
|
|
||
| Format: `delete INDEX` | ||
|
|
||
| * Deletes the person 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, … | ||
| - Deletes the employee at the specified `INDEX`. | ||
| - The index refers to the index number shown in the displayed employee list. | ||
| - The index **must be a positive integer** 1, 2, 3, … | ||
|
|
||
| Examples: | ||
| * `list` followed by `delete 2` deletes the 2nd person in the address book. | ||
| * `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. | ||
|
|
||
| - `list` followed by `delete 2` deletes the 2nd person in the employee list. | ||
| - `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. | ||
|
|
||
| ### Clearing all entries : `clear` | ||
|
|
||
|
|
@@ -168,36 +168,36 @@ AddressBook data are saved automatically as a JSON file `[JAR file location]/dat | |
| <box type="warning" seamless> | ||
|
|
||
| **Caution:** | ||
| If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | ||
| If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. | ||
| </box> | ||
|
|
||
| ### Archiving data files `[coming in v2.0]` | ||
|
|
||
| _Details coming soon ..._ | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| --- | ||
|
|
||
| ## FAQ | ||
|
|
||
| **Q**: How do I transfer my data to another Computer?<br> | ||
| **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 AddressBook home folder. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| --- | ||
|
|
||
| ## Known issues | ||
|
|
||
| 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. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
| --- | ||
|
|
||
| ## Command summary | ||
|
|
||
| Action | Format, Examples | ||
| -----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 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]` | ||
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | ||
| **List** | `list` | ||
| **Help** | `help` | ||
| | Action | Format, Examples | | ||
| | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 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]` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | | ||
| | **List** | `list` | | ||
| | **Help** | `help` | | ||
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