+### Chen Qun
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+
-* Role: Project Advisor
+[[github](https://github.com/jean-cq)]
+[[portfolio](team/jean-cq.md)]
-### Jane Doe
+* Role: Developer, Deliverables and deadlines
+* Responsibilities: Ensure project deliverables are done on time and in the right format.
+### Ivan Tan
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ivyy-poison)]
+[[portfolio](team/ivyy-poison.md)]
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer, Integration
+* Responsibilities: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
-### Johnny Doe
+### Ong Wei Hong
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ong-wei-hong)] [[portfolio](team/ong-wei-hong.md)]
-* Role: Developer
-* Responsibilities: Data
+* Role: Developer, Code Quality
+* Responsibilities: Looks after code quality, ensures adherence to coding standards, etc.
-### Jean Doe
+### Qin Nanxin
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/infibeyond)]
+[[portfolio](team/infibeyond.md)]
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Developer, Documentation
+* Responsibilities: Ensures the quality of various project documents.
-### James Doe
+### Ryan Ong
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/ryanozx)]
+[[portfolio](team/ryanozx.md)]
-* Role: Developer
-* Responsibilities: UI
+* Role: Developer, Testing
+* Responsibilities: Ensures the testing of the project is done properly and on time.
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 13cf0faea16..32f6255f3b9 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -1,6 +1,8 @@
---
-layout: page
-title: Configuration guide
+ layout: default.md
+ title: "Configuration guide"
---
+# Configuration guide
+
Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
diff --git a/docs/DevOps.md b/docs/DevOps.md
index d2fd91a6001..8228c845e86 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: DevOps guide
+ layout: default.md
+ title: "DevOps guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# DevOps guide
---------------------------------------------------------------------------------------------------------------------
+
+
+
+
+
+
+
+{{ page.alt_title | escape }}
-
- {{ content }}
-
-
-
- {{ content }}
-
- :information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
+
-
+**Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
-
++
+**Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.-
+:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
+**Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
-
+:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
+
+
+**Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
than attempting to perform the undo.
-
+
The following sequence diagram shows how the undo operation works:
-
+:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+**Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
-
+:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+
-
+**Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+
+
Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
-
+
+:information_source: **Note:** These instructions only provide a starting point for testers to work on;
-testers are expected to do more *exploratory* testing.
-
-
++ 2. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. -1. _{ more test cases … }_ +### Adding an employee +1. Adding an employee while all employees are being shown + + 1. Test case: `add n/John Doe p/98765432 e/johnd@example.com a/John Street, block 123 #01-01`
+ Expected: The employee is added to the list. Details of the added leave shown in the status message. + + 2. Test case: `add n/John Two p/98765431 e/johnt@example.com a/John Street, block 122 #01-01 t/remote`
+ Expected: The employee is added to the list. Error details shown in the status message. Status bar becomes red. + + 3. Test case: `add n/John Two p/98765431 e/johnt@example.com`
+ Expected: The employee is not added to the list. Details of the added leave shown in the status message. + 4. Other incorrect add commands to try: `add`, `add` with missing compulsory fields, `add` with illegal arguments in fields
+ Expected: Similar to previous. + +### Deleting an employee -### Deleting a person 1. Deleting a person while all persons are being shown - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + + 2. Test case: `delete 1`
+ Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar becomes red. + + 4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. + +2. Deleting a person after applying a filter + + 1. Prerequisites: Filter to the second person using `find PERSON_NAME` where `PERSON_NAME` is the name of the second person. + + 2. Test case: `delete 1`
+ Expected: First visible contact is delete from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `delete 2`
+ Expected: No person is delete. Error details shown in the status message. Status bar becomes red. + + 4. Follow up actions: `list`
+ Expected: Only the previously deleted person is deleted. + +### Adding a tag +1. Adding a tag to an employee while all employee are being shown - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. + 1. Prerequisites: List all employee using the list command. Multiple employees in the list. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. + 2. Test case: `add-tag 1 t/full time`
+ Expected: The tag `full time` is added to employee indexed 1 shown in the employee list. Details of the edited employee shown in the status message. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. + 3. Test case: `add-tag 1`
+ Expected: No tag is added. Error details shown in the status message. Status bar becomes red. -1. _{ more test cases … }_ + 4. Other incorrect add-tag commands to try: `add-tag`, `add-tag`with illegal arguments in fields, `add-tag x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Editing an employee +1. Editing an employee while all employee are being shown + + 1. Prerequisites: List all employee using the list command. Multiple employees in the list. + + 2. Test case: `edit 2 p/98765432 e/johndoe@example.com t/full-time t/remote`
+ Expected: Thephone number, email address and tags of the employee indexed 2 are changed to 98765432, johndoe@example.com and full-time and remote. Details of the edited employee shown in the status message. + + 3. Test case: `edit 1 a/John street, block 123 #01-01 t/`
+ Expected: The home address of the employee indexed 1 is changed to John street, block 123 #01-01 and all tags removed from the employee shown in the employee list. Details of the edited employee shown in the status message. + + 4. Test case: `edit 1 a/ t/`
+ Expected: No tag is added. Error details shown in the status message. Status bar becomes red. + + 5. Other incorrect edit commands to try: `edit`, `edit` with illegal arguments in fields, `edit x` (where x is larger than the list size)
+ Expected: Similar to previous. + +### Viewing all tags existing +1. Viewing all tags while there are exsiting tags + 1. Prerequisites: There are tags attached to the employees. + + 2. Test case: `view-tag`
+ Expected: Tags shown in the status message. + + +### Finding all tags matched +1. Finding Employees with All Tags in a Valid Scenario + 1. Prerequisites: + 1. Have a dataset with employees having different tags, specifically `remote`, `full time`, `part time` and `on-site`. + 2. List all employees using the list command to identify available tags. + 2. Test Case: `find-all-tag t/remote t/full time` + Expected: GUI Changes: A dedicated interface section displays a list of employees with both tags `remote` and `full time`. Status message indicates the number of matched employees. Verify that employees with additional tags are also displayed. + 3. Test Case: `find-all-tag` + Expected: Error message indicates an invalid command format.Status bar becomes red. + 4. Test Case: `find-all-tag t/Nonexistent tag` + Expected: GUI Changes: A dedicated interface section displays no employee. Status message indicates 0 matched employee. + 5. Test Case: `find-all-tag t/REMOTE` + Expected: GUI Changes: A dedicated interface section displays no employee. Status message indicates 0 matched employee. + 6. Test Case: `find-all-tag t/123!` + Expected: Error message indicates illegal tag names. Status bar becomes red. + 7. Test Case: `find-all-tag t/re` + Expected:Employees with tag named `re` are displayed. Verify that employees with additional tags are also displayed. + +### Finding some tags matched +1. Finding Employees with All Tags in a Valid Scenario + 1. Prerequisites: + 1. Have a dataset with employees having different tags, specifically `remote`, `full time`, `part time` and `on-site`. + 2. List all employees using the list command to identify available tags. + 2. Test Case: `find-some-tag t/remote t/full time` + Expected: GUI Changes: A dedicated interface section displays a list of employees with either tags `remote` and `full time`. Status message indicates the number of matched employees. Verify that employees with additional tags are also displayed. + 3. Test Case: `find-some-tag` + Expected: Error message indicates an invalid command format.Status bar becomes red. + 4. Test Case: `find-some-tag t/Nonexistent tag` + Expected: GUI Changes: A dedicated interface section displays no employee. Status message indicates 0 matched employee. + 5. Test Case: `find-some-tag t/REMOTE` + Expected: GUI Changes: A dedicated interface section displays no employee. Status message indicates 0 matched employee. + 6. Test Case: `find-some-tag t/123!` + Expected: Error message indicates illegal tag names. Status bar becomes red. + 7. Test Case: `find-some-tag t/re` + Expected:Employees with tag named `re` are displayed. Verify that employees with additional tags are also displayed. + +### Adding a leave +1. Adding a leave while all leaves are being shown + + 1. Prerequisites: List all leaves using the list-leaves command. Multiple leaves in the list. + + 2. Test case: `add-leave 1 title/Vacation start/2023-11-15 end/2023-11-20`
+ Expected: The leave is added to the list. Details of the added leave shown in the status message. Timestamp in the status bar is updated. + + 3. Test case: `add-leave 0 title/Conference start/2023-12-01 end/2023-12-03 d/Attending conference`
+ Expected: No leave is added. Error details shown in the status message. Status bar becomes red. + + 4. Other incorrect add-leave commands to try: `add-leave`, `add-leave x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. ### Saving data 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 1. Open `./data/addressbook.json` and delete the first character `{`. Then open HRMate.
+ Expected: HRMate opens an empty address book. + + 2. Add a person using `add` and a leave using `add-leave`, then `exit`. Open `./data/leavesbook.json` and edit the fullName of the name of the employee of a leave. Reopen HRMate.
+ Expected: HRMate restores all data except for the edited leave. + +### Data integrity between `Person` and `Leave` + +1. Dealing with edits to `Person` + + 1. Add a `Person` using `add` and a `Leave` using `add-leave`. Edit the `Person` name using `edit`.
+ Expected: The Employee under the created `Leave` is edited also. + +2. Dealing with deletes to `Person` + + 1. Add a `Person` using `add` and a `Leave` using `add-leave`. Delete the `Person` with `delete`.
+ Expected: The previously created `Leave` is deleted also. + +---------------------------------------------------------------------------------------------------------------------------- + +## **Appendix: Planned Enhancements** + +1. `export-all` would export both `Person` and `Leave`. HR Managers usually wants to move both `Person` and `Leave` to another application, so being able to export both in a single csv sheet would help them do so. + +2. find-all-tags and find-any-tags searches for tags case insensitive. Since tags are used for categorising, HR Managers might see no difference between Intern and intern. Hence allowing case insensitive search in find-all-tags and find-any-tags would help HR Managers find employees more easily. + +3. Mergable `import`. Sometimes, HR Managers want to move data from one app to HRMate without removing all current employees. Allow HRMate to merge a csv file, with an option to overwrite current data or overwrite csv data when a same employee is encountered, would help HR Managers achieve this. -1. _{ more test cases … }_ +4. Filtered `clear`. Allowing HR Managers to select a group of employees to delete would be good. For example, they could use `find-any-tags t/intern`, `clear` to delete all interns. Subsequently, `list` would show all non intern employees. diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..082e652d947 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -1,29 +1,21 @@ --- -layout: page -title: Documentation guide + layout: default.md + title: "Documentation guide" + pageNav: 3 --- -**Setting up and maintaining the project website:** - -* We use [**Jekyll**](https://jekyllrb.com/) to manage documentation. -* The `docs/` folder is used for documentation. -* To learn how set it up and maintain the project website, follow the guide [_[se-edu/guides] **Using Jekyll for project documentation**_](https://se-education.org/guides/tutorials/jekyll.html). -* Note these points when adapting the documentation to a different project/product: - * The 'Site-wide settings' section of the page linked above has information on how to update site-wide elements such as the top navigation bar. - * :bulb: In addition to updating content files, you might have to update the config files `docs\_config.yml` and `docs\_sass\minima\_base.scss` (which contains a reference to `AB-3` that comes into play when converting documentation pages to PDF format). -* If you are using Intellij for editing documentation files, you can consider enabling 'soft wrapping' for `*.md` files, as explained in [_[se-edu/guides] **Intellij IDEA: Useful settings**_](https://se-education.org/guides/tutorials/intellijUsefulSettings.html#enabling-soft-wrapping) +# Documentation Guide +* We use [**MarkBind**](https://markbind.org/) to manage documentation. +* The `docs/` folder contains the source files for the documentation website. +* To learn how set it up and maintain the project website, follow the guide [[se-edu/guides] Working with Forked MarkBind sites](https://se-education.org/guides/tutorials/markbind-forked-sites.html) for project documentation. **Style guidance:** * Follow the [**_Google developer documentation style guide_**](https://developers.google.com/style). +* Also relevant is the [_se-edu/guides **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html). -* Also relevant is the [_[se-edu/guides] **Markdown coding standard**_](https://se-education.org/guides/conventions/markdown.html) - -**Diagrams:** - -* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) -**Converting a document to the PDF format:** +**Converting to PDF** -* See the guide [_[se-edu/guides] **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html) +* See the guide [_se-edu/guides **Saving web documents as PDF files**_](https://se-education.org/guides/tutorials/savingPdf.html). diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index c8385d85874..00000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,10 +0,0 @@ -# frozen_string_literal: true - -source "https://rubygems.org" - -git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } - -gem 'jekyll' -gem 'github-pages', group: :jekyll_plugins -gem 'wdm', '~> 0.1.0' if Gem.win_platform? -gem 'webrick' diff --git a/docs/Logging.md b/docs/Logging.md index 5e4fb9bc217..589644ad5c6 100644 --- a/docs/Logging.md +++ b/docs/Logging.md @@ -1,8 +1,10 @@ --- -layout: page -title: Logging guide + layout: default.md + title: "Logging guide" --- +# Logging guide + * We are using `java.util.logging` package for logging. * The `LogsCenter` class is used to manage the logging levels and logging destinations. * The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..03df0295bd2 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -1,27 +1,32 @@ --- -layout: page -title: Setting up and getting started + layout: default.md + title: "Setting up and getting started" + pageNav: 3 --- -* Table of Contents -{:toc} +# Setting up and getting started + +
:exclamation: **Caution:**
+
+**Caution:**
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
-
+
First, **fork** this repo, and **clone** the fork into your computer.
If you plan to use Intellij IDEA (highly recommended):
1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**.
-1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.- :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. +1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA. +
:bulb: **Tip:**
+
+ **Tip:**
Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code.
-
+
1. **Set up CI**
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..78ddc57e670 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: Testing guide
+ layout: default.md
+ title: "Testing guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# Testing guide
---------------------------------------------------------------------------------------------------------------------
+
+:link: **Link**: Read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html) to learn more about using Gradle.
-
++ +To facilitate ease of transfer of information, a core feature of HRMate is its ability to import and export employee records and +leave applications in [CSV](#glossary) format. This allows you to easily transfer your employee records and leave applications to and from +HRMate, so you can use HRMate alongside other HR management tools. + +-------------------------------------------------------------------------------------------------------------------- + + ## Quick start -1. Ensure you have Java `11` or above installed in your Computer. +1. Download the latest `hrmate.jar` from [here](https://github.com/AY2324S1-CS2103T-W11-1/tp/releases/tag/v1.4.0) and move the downloaded file to your desired location. +See [How do I move a file?](#q-how-do-i-move-a-file) for help. + +2. Open a terminal or your computer. +
-
+
- For Mac users: open the Terminal app on your Mac +
- For Window users: press the windows key, type `powershell` and press "Enter" on your keyboard +
- See How do I open a terminal? for more information. +
+An app similar to the one below should appear in a few seconds. The app is populated with some sample data for you to experiment with.
+We have added some annotations in red so that you can understand the app visually. + + +6. You can try typing some commands into the command box and pressing "enter" to execute. We have listed down some commands for you to try. + - `help`: Opens the help window. + - `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`: Adds an employee named `John Doe` to the employee list. + - `list`: Lists all employees. + - `add-leave 1 title/medical leave start/2023-11-11 end/2023-11-11`: Adds a leave entry for the first employee in the current employee list. Note that the default leave status is `PENDING`. + - `delete 2`: Deletes the second employee shown in the current employee list and any leave applications associated with the second employee. + - `exit`: Exits the app. +For new users, especially first-time users, it is very important and helpful to read through the [How to interpret command formats?](#how-to-interpret-command-formats). This section provides a detailed introduction to the overall structure of all commands used in HRmate. + +Also, look through [Features](#features) for commands and the details of each command. If you would like a concise summary of the commands, please check out our [command summary](#command-summary). We hope to aid you in your HR journey! + +-------------------------------------------------------------------------------------------------------------------- + + + +## Important things to note -1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). +**Warning:** +
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +> - For a more detailed introduction to the command structure of HRmate and specific information on the parts of a command we can and cannot modify, please refer to [How to interpret command formats?](#how-to-interpret-command-formats). +> +> - Read through our [features](#features) section for detailed information on each command. +> +> - Check out our [command summary](#command-summary) for a concise list of available commands and their formats. -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.
- Some example commands you can try: +
+The user guide splits HRMate's features into 3 main categories: [Employee-related operations](#employee-related-operations), [Leave-related operations](#leave-related-operations), and [other operations](#other-operations).
+
+## Employee-related operations
+
+HRMate allows you to manage your employees' contact details, such as their name, phone number, email address, and home address.
+
+For instance you can [add](#add-an-employee-record) a new employee, [find](#find-an-employee-record) specific employees, [edit](#edit-an-employee-record) an employee's information, [delete](#delete-an-employee-record) an employee, or [import/export](#import-export-employee-records) employee records in CSV format.
+
+### Add an employee record
+When a new employee joins, use the [`add`](#adding-an-employee-add) command to add their information into HRMate.
+
+#### Adding an employee: `add`
+
+Use the `add` command to add an employee to the employee list.
+
+Here's how to add an employee:
+
+1. Type in the following command in the [command box](#glossary): `add n/NAME p/PHONE_NUMBER e/EMAIL_ADDRESS a/HOME_ADDRESS [t/TAG]...`, replace `NAME` with employee name, `PHONE_NUMBER` with employee phone number `EMAIL_ADDRESS` with employee email address and `HOME_ADDRESS` with employee home address. `[t/TAG]...` is an optional field with one or more tags, with `TAG` being the name of the tag.
+ - For instance, if you have an employee name John Doe with phone number 98765432, email johnd@example.com, home address John Street, block 123 #01-01 and tags full-time and remote, type in the command `add n/John Doe p/98765432 e/johnd@example.com a/John Street, block 123 #01-01 t/full-time t/remote`
+ - If your employee does not require any tags, using the same information as above, the command would be `add n/John Doe p/98765432 e/johnd@example.com a/John Street, block 123 #01-01`
+ - Please refer to [how to interpret command formats](#how-to-interpret-command-formats) for more information
+2. Press "enter" on your keyboard and you should see the person information at the end of the employee list.
+
+
+
+Here are the potential error messages that you may receive and here's how to fix them:
+
+| Error message | Why it happens | Fix |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `add n/NAME p/PHONE_NUMBER e/EMAIL_ADDRESS a/HOME_ADDRESS [t/TAG]...`, replacing `NAME` with employee name, `PHONE_NUMBER` with employee phone number, `EMAIL_ADDRESS` with employee email address, `HOME_ADDRESS` with employee home address. `[t/TAG]...` is optional, with `[t/TAG]` representing one or more tags and `TAG` being the tag name. |
+| `FIELD should FORMAT` where `FIELD` is an input like `Names` or `Phone numbers` and `FORMAT` contains additional information about the field's format. | The input does not follow the format prescribed. For example, the entered phone number might contain alphabets. | Follow the on screen message to fix the field in question. For example, `Phone numbers should only contain numbers, and it should be at least 3 digits long` means that the input phone number does not follow the prescribed format. |
+| `This employee already exists in the address book` | The provided employee name is already found in HRMate | Use another name for the employee. For example, if trying to add another "John Doe", use the name "John Doe (HR)" to differentiate between the existing John Doe. HRMate does this name checking to prevent unintentional duplicate employee entries. |
+
+
+
+Currently, HRmate's user interface is able to hold 35 to 160 characters on a single line, depending on the letters used. For any inputs longer than the character limit, HRmate will display ... for the remaining characters after the character limit.
+
+
+
+
+
+
+HRmate's names are case-sensitive. This means that the names `Alex` and `alex` are interpreted as different names.
+
+
+
+HRmate's tags are case-sensitive. This means that tags `Part-Time` and `part-time` are interpreted as different tags. Having redundant tags with similar spelling may decrease efficiency and add unnecessary workload. To see all current tags in use, you may refer to the `view-tag` command.
+
+
+
+
+### Find an employee record
+HRMate makes it easy to find an employee and there are multiple ways of doing so. You can use the [`list`](#listing-all-employees-list) command to list all employees, or use the [`find`](#finding-employees-by-name-find) command to find employees by name. You can also use the [`find-all-tag`](#finding-employees-by-all-specified-tags-find-all-tag) and [`find-some-tag`](#finding-employees-by-at-least-one-specified-tag-find-some-tag) commands to find employees by their associated [tags](#glossary).
+
+#### Listing all employees: `list`
+
+Use the `list` command to view all employees that are currently listed in the employee list.
+
+Here's how to use the `list` command:
+
+1. Type in the following command in the command box: `list`.
+2. Press "enter" on your keyboard and you should see the information of all employees listed in the employee list.
+
+
+This command does not require any parameters. However, to account for possible typing mistakes, HRMate reads in inputs like `list 123`, `list abc`, and `list 1a2b` all as the command `list`.
+
+
+Here are the potential error messages that you may receive and here's how to fix them:
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Unknown command` | The command you inputted is not part of the commands available in HRmate. | Please check the spelling and try again.
+
+#### Finding employees by name: `find`
+
+Use the `find` command to find employees by name. This command will find employees whose names contain the specified words that you enter.
+
+Here's how to find employees by name:
+
+ 1. Type in the following command in the command box `find NAME....` where `NAME...` are to be replaced with one or more names of the employees for search.
+ * The words for search are case insensitive, meaning you do not have to worry about the capitalization of the words entered.
+ - For instance, to find employees whose names contain `Martin`, type `find martin` to the command box.
+ - Take another example, suppose we have employees `alex` and `Alex`, for input `find alex`, both employees will be shown as a reult.
+ - For another instance, to find employees whose names contain either "*Harry*" or "*Redknapp*, type `find harry redknapp` to the command box.
+ - However, if you want to find employees whose names contain `martin` but only entered `mar`, NO employee named Martin will be found, instead employee named Mar will be found. Note that he search looks for names containing the entire specified word.
+ 2. Press "enter" on your keyboard and you should see the employees matched being listed in the employee list.
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `find NAME...` where `NAME` is the specified name of the employee to search (case-insensitive).
+
+* **For advanced users:**
+ * Employees are displayed in the order in which they are arranged in the employee list.
+
+#### Viewing All Tags: `view-tag`
+
+To view all tags currently in use within the employee list, use the `view-tag` command. This will be
+useful if you want to find employees by their associated tags using the [`find-all-tag`](#finding-employees-by-all-specified-tags-find-all-tag) and [`find-some-tag`](#finding-employees-by-at-least-one-specified-tag-find-some-tag) commands.
+
+Here's how to view all currently used tags:
+
+1. Type in the following command in the command box: `view-tag`.
+2. Press "enter" on your keyboard and you should see a list of all tags currently in use within the employee list.
+
+
+
+This command does not require any parameters. However, to account for possible typing mistakes, HRMate reads in inputs like `view-tag 123`, `view-tag abc`, and `view-tag 1a2b` all as the command `view-tag`.
+
+
+Here are the potential error messages that you may receive and here's how to fix them:
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Unknown command` | The command you inputted is not part of the commands available in HRmate. | Please check the spelling and try again.
+
+
+
+
+#### Finding employees by all specified tags: `find-all-tag`
+
+To find employees by a set of specified tags, use the `find-all-tag` command. This command will find employees that are currently associated with all the specified tags that you enter.
+
+Here's how to use the `find-all-tag` command:
+
+1. Type in the following command in the command box `find-all-tag t/TAG [t/MORE_TAGS]...` where `TAG` is to be replaced with the name of the tags.
+ * At least one tag should be entered for search and more tags can be entered if you want to search for more.
+ * The tag names are case sensitive, meaning the capitalization of the words entered matters.
+ - For instance, to find employees with both tag `remote` and tag `full time`, type `find-all-tag t/remote t/full time` to the command box.
+ - However, if you want to find employees with tag `remote`, but only entered `re` as the tag name, NO employees with tag `remote` will be found, instead, employees with tag `re` will be found. Note that only tags containing the entire specified word are matched.
+2. Press "enter" on your keyboard and you should see the employees matched being listed in the employee list. Note that employees with additional tags other than the specified ones will also be displayed.
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `find-all-tag t/TAG [t/MORE_TAGS]...` where `TAG` is to be replaced with the name of the tags, and capitalization of the tag names mattered (case-sensitive). At least one tag should be entered for search and more tags can be entered if you want to search for more. |
+| `Tags names only allow alphanumeric characters, spaces, and dashes.` | The tags input contains illegal characters | Remove the illegal characters from the input. |
+
+* **For advanced users:**
+ * Employees are displayed in the order in which they are arranged in the employee list.
+
+#### Finding employees by at least one specified tag: `find-some-tag`
+
+To find employees by at least one of the specified tags, use the `find-some-tag` command. This command will find employees that are currently associated with at least one of the specified tags that you enter.
+
+Here's how to use the `find-some-tag` command:
+
+1. Type in the following command in the command box `find-some-tag t/TAG [t/MORE_TAGS]...` where `TAG` is to be replaced with the name of the tags.
+ * At least one tag should be entered for search and more tags can be entered if you want to search for more.
+ * The tag names are case sensitive, meaning the capitalization of the words entered matters.
+ - For instance, to find employees with either tag `remote` and tag `full time`, type `find-some-tag t/remote t/full time` to the command box.
+ - However, if you want to find employees with tag `remote`, but only entered `re` as the tag name, NO employees with tag `remote` will be found, instead, employees with tag `re` will be found. Note that only tags containing the entire specified word are matched.
+2. Press "enter" on your keyboard and you should see the employees matched being listed in the employee list. Note that employees with additional tags other than the specified ones will also be displayed.
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `find-all-tag t/TAG [t/MORE_TAGS]...` where `TAG` is to be replaced with the name of the tags, and capitalization of the tag names mattered (case-sensitive). At least one tag should be entered for search and more tags can be entered if you want to search for more. |
+| `Tags names only allow alphanumeric characters, spaces, and dashes.` | The tags input contains illegal characters | Remove the illegal characters from the input. |
+
+* **For advanced users:**
+ * Employees are displayed in the order in which they are arranged in the employee list.
+
+
+
+### Edit an employee record
+HRMate offers different commands for editing employee records. [`add-tag`](#adding-tags-to-employees-add-tag) and [`delete-tag`](#removing-tags-from-employees-delete-tag) would add and remove an employee's tags while [`edit`](#editing-employee-information-edit) is for editing name, phone number, email address, home address and tags.
+
+#### Adding tags to employees: `add-tag`
+
+Use the `add-tag` command to add tags to an employee. This command will add the specified tags to an employee specified by their index in the employee list.
+
+Here's how to use the `add-tag` command:
+
+1. Find the employee under the employee list.
+
+
+If the employee is not found, consider using list or any find commands to locate the employee in the employee list.
+
+
+2. Type in the following command in the command box `add-tag INDEX t/TAG...` where `INDEX` is the [index](#glossary) of the employee in the list currently, `TAG` is the name of the tag to be added and `t/TAG...` representing one or more tags.
+ - For instance, if you want to add the tags full-time and remote to the employee indexed 2, type `add-tag 2 t/full-time t/remote` to the command box.
+ - Please refer to [how to interpret command formats](#how-to-interpret-command-formats) for more information
+3. Press "enter" on your keyboard and you should see the input tags added to the employee specified.
+
+Here are the potential error messages that you may receive and here's how to fix them:
+
+| Error message | Why it happens | Fix |
+|-----------------------------------------------------------------------|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `Invalid command format!` | The command you input does not follow the specfied format | Ensure the command you entered follows the following format: `add-tag INDEX t/TAG...`, replacing INDEX with the index of the employee currently, `TAG` is the name of the tag to be added and `t/TAG...` representing one or more tags. |
+| `At least one tag must be provided` | No tags were provided | Add tags to the command in the command box. Note that the tags must have a t/ [prefix](#glossary). For example, to add the tag full-time, use `t/full-time`. |
+| `The person index provided is invalid` | The index specified does not refer to any employee | Double check if the index appears in the employee list. Alternatively, use [list](#listing-all-employees-list) or any [find commands](#find-an-employee-record) to locate the employee in the employee list. Afterwards, use the correct employee index in the `add-tag` command. |
+| `The employee already has some of the tags` | The employee already has some of the tags which you are trying to add | Remove the tags the employee has from the input command. For example, for an employee who already has the full-time tag, the command `add-tag 2 t/full-time t/remote` would not work. Instead, try `add-tag 2 t/remote`. |
+| `Tags names only allows alphanumeric characters, spaces, and dashes.` | The tags input contains illegal characters | Remove the illegal characters from the input. |
+#### Removing tags from employees: `delete-tag`
+
+Use the `delete-tag` command to remove tags from an employee. This command will remove the specified tags from an employee specified by their index in the employee list.
+
+Here's how to use the `delete-tag` command:
+
+1. Get the [index](#glossary) of the employee in the employee list.
+
+
+If the employee is not found, consider using [list](#listing-all-employees-list) or any [find commands](#find-an-employee-record) to locate the employee in the employee list.
+
+
+2. Type in the following command in the command box `delete-tag INDEX t/TAG...` where `INDEX` is the index of the employee in the list currently, `TAG` is the name of the tag to be deleted and `t/TAG...` representing one or more tags.
+ - For instance, if you want to remove the tags full-time and remote to the employee indexed 2, type `delete-tag 2 t/full-time t/remote` to the command box.
+ - Please refer to [how to interpret command formats](#how-to-interpret-command-formats) for more information
+3. Press "enter" on your keyboard and you should see the input tags removed from the employee specified.
+
+Here are the potential error messages you may receive and here's how to fix them:
+
+| Error message | Why it happens | Fix |
+|---------------|----------------|-----|
+| `Invalid command format!` | The command you input does not follow the specfied format | Ensure the command you entered follows the following format: `delete-tag INDEX t/TAG...`, replacing INDEX with the index of the employee currently, `TAG` is the name of the tag to be deleted and `t/TAG...` representing one or more tags. |
+| `At least one tag must be provided` | No tags were provided | Add tags to the command in the command box. Note that the tags must have a t/ [prefix](#glossary). For example, to remove the tag full-time, use `t/full-time` |
+| `The person index provided is invalid` | The index specified does not refer to any employee | Double check if the index appears in the employee list. Alternatively, use [list](#listing-all-employees-list) or any [find commands](#find-an-employee-record) to locate the employee in the employee list. Afterwards, use the correct employee index in the `delete-tag` command. |
+| `Some of the tags are not found on this employee.` | The employee does not have some of the tags you are trying to delete | Remove the tags not found on the employee from the input command. For example, for an employee without the tag full-time, the command `delete-tag 2 t/full-time t/remote` does not work. Instead try `delete-tag 2 t/remote`.|
+| `Tags names only allows alphanumeric characters, spaces, and dashes.` | The tags input contains illegal characters | Remove the illegal characters from the input. |
+
+
+
+#### Editing employee information : `edit`
+
+For a more comprehensive editing of an employee's information, use the `edit` command. This command will edit the specified fields of an employee specified by their index in the employee list.
+
+Here's how to use the `edit` command to edit an employee's information:
+
+1. Get the [index](#glossary) of the employee under the employee list.
+
+
+If the employee is not found, consider using list or any find commands to locate the employee in the employee list.
+
+
+2. Type in the following command in the command box `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL_ADDRESS] [a/HOME_ADDRESS] [t/TAG]...` where `INDEX` is the index of the employee in the list currently, `[n/NAME]`, `[p/PHONE_NUMBER]`, `[e/EMAIL_ADDRESS]`, `[a/HOME_ADDRESS]` are optional fields which require changing, replacing `NAME` with employee name, `PHONE_NUMBER` with employee phone number, `EMAIL_ADDRESS` with employee email address and `HOME_ADDRESS` with employee home address. `[t/TAG]...` is an optional field representing one or more tags where `TAG` is the tag name. Note that at least one field to edit must be present and only the fields present will be edited.
+ - For example, to change the phone number, email address and tags of the employee indexed 2 to 98765432, johndoe@example.com and full-time and remote, type in the command `edit 2 p/98765432 e/johndoe@example.com t/full-time t/remote`. Note that the name and home address will remain unchanged.
+ - In another example, to change the home address of the employee indexed 1 to John street, block 123 #01-01 and remove all tags from the employee, type in the command `edit 1 a/John street, block 123 #01-01 t/`. Note that the name, phone number and email_address will remain unchanged.
+ - Please refer to [how to interpret command formats](#how-to-interpret-command-formats) for more information
+
+
+If the tag prefix is specified, all existing tags under the employee will be removed and replaced with the new tags in the command.
+In the first example, the employee will have all tags removed and replaced by 2 tags: full-time and remote.
+In the second example, the employee will have all tags removed. No tags will be added since no tags are specified.
+Therefore, to avoid unintentionally losing any information while editing tags, we recommend using the add tag and delete-tag commands instead for editing tags.
+
+
+3. Press "enter" on your keyboard and you should see the changes applied to the employee.
+
+| Error message | Why it happens | Fix |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL_ADDRESS] [a/HOME_ADDRESS] [t/TAG]...` where `INDEX` is the index of the employee in the list currently, `[n/NAME]`, `[p/PHONE_NUMBER]`, `[e/EMAIL_ADDRESS]`, `[a/HOME_ADDRESS]` are optional fields which require changing, replacing `NAME` with employee name, `PHONE_NUMBER` with employee phone number, `EMAIL_ADDRESS` with employee email address and `HOME_ADDRESS` with employee home address. `[t/TAG]...` is an optional field representing one or more tags where `TAG` is the tag name. Also check if the index is a positive integer, having an invalid index such as zero, negative numbers, non-integers, and characters can lead to this error message.|
+| `FIELD should FORMAT` where `FIELD` is an input like `Names` or `Phone numbers` and `FORMAT` contains additional information about the field's format. | The input does not follow the format prescribed. For example, the entered phone number might contain alphabets. | Follow the on screen message to fix the field in question. For example, `Phone numbers should only contain numbers, and it should be at least 3 digits long` means that the input phone number does not follow the prescribed format. |
+| `The person index provided is invalid` | The index specified does not refer to any employee | Double check if the index appears in the employee list. Alternatively, use [list](#listing-all-employees-list) or any [find commands](#find-an-employee-record) to locate the employee in the employee list. Afterwards, use the correct employee index in the `edit` command. |
+| `At least one field to edit must be provided` | The command you input does not contain any fields to edit | Check if there is any input fields in the command inputted. An input like `edit 1` is not accepted as there is no edits to be made. |
+| `This employee already exists in the address book` | The provided employee name is already found in HRMate | Use another name for the employee. For example, if trying to add another "John Doe", use the name "John Doe (HR)" to differentiate between the existing John Doe. HRMate does this name checking to prevent unintentional duplicate employee entries. |
+
+* **For advanced users:**
+ * You can remove all the tags of an employee with `edit INDEX t/` (see warning above)
+
+
+
+### Delete an employee record
+
+Delete employee records from HRMate using the [`delete`](#deleting-a-record-delete) command.
+
+#### Deleting a record : `delete`
+
+Use the `delete` command to delete an employee record from HRMate. This command will delete the specified employee from the employee list.
+
+Here's how to delete an employee record:
+
+1. Get the [index](#glossary) of the employee under the employee list. View this image in [quick start](#quick-start) for more information.
+
+If the employee is not found, consider using list or any find commands to locate the employee in the employee list.
+
+2. Type in the following command in the command box `delete INDEX` where `INDEX` is to be replaced with the index of the employee in the list currently
+ - For instance, to remove the whole record of the employee indexed 1, type `delete 1` to the command box.
+
+
+Once you delete the record, the records will be no longer available in HRMate and cannot be recovered.
+Therefore, to avoid unintentionally losing any information of the employee, if you just want to modify some information, we recommend using the
+edit command instead to modify the record.
+
+
+3. Press "enter" on your keyboard and you should see the employee removed from the employee list with all leaves related to that employee in the leave list being removed.
+
+
+| Error message | Why it happens | Fix |
+|----------------------------------------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `Invalid command format!` | The command you input does not follow the specified format | Ensure the command you entered follows the following format: `delete INDEX` where `INDEX` is the index of the employee in the list currently. Also check if the index is a positive integer, having an invalid index such as zero, negative numbers, non-integers, and characters can lead to this error message. |
+| `The person index provided is invalid` | The index specified is not positive or does not refer to any employee | Double check if the index is positive and appears in the employee list. Alternatively, use [list](#listing-all-employees-list) or any [find commands](#find-an-employee-record) to locate the employee in the employee list. Afterwards, use the correct employee index in the `delete` command. |
+|
+
+
+
+### Import/export employee records
+It's painful having to add in each employee into HRMate manually. That's why HRMate provides [`import`](#importing-employee-records-import) and [`export`](#exporting-employee-records-export) commands,
+so you can bring in all your records from Excel with just a single command!
+
+With the import and export commands, HRMate can read and save files in [CSV](#csv) format, which is supported
+by major spreadsheet applications such as Microsoft Excel.
+
+
+#### Importing employee records: `import`
+
+Use the `import` command to import employee records from a CSV file. This command will import the employee records from
+the specified CSV file into HRMate.
+
+
+Imported employee records will overwrite existing employee records in HRMate. Remember to make a copy of your existing
+employee records if you want to save them! You can do so by exporting your current records.
+
+
+Here's how you can bring over your records from Excel:
-**:information_source: Notes about the command format:**
+1. Export your Excel save file in CSV format. Ensure that the separator is set to be a semicolon(`;`), and that you have +the following fields: Name, Phone, Email, Address, Tags. Note that tags in the Tags field have to be separated by commas. + * You may skip this step if you already have a CSV file (e.g. you are importing a previously exported CSV file generated by + HRMate) -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +
+If you have saved or edited your CSV file in Excel, please note that Excel will likely change the separator into a comma,
+which will cause problems when trying to import employee records. To fix this problem,
+click here to find out how you
+can change the separator to semicolons in Excel. Note that this workaround is currently available only for Windows users.
+
-* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +2. If you are unsure how your file should look like, you may refer to the following images: + * Here's how your CSV file should look like if you open it up in Notepad: +  + * It is okay if your CSV file does not contain the first line `sep=;`, as this is a line added to files exported by HRMate + to help Excel open the file. Do ensure the next line has to be the following: + `Name;Phone;Email;Address;Tags` in order for HRMate to read it. Also note that tags are separated by commas + (see `colleagues, friends` under `Bernice Yu`'s row). + * If you open your CSV file in Excel, your file should look like this: +
+
+  +
+
+ * Do ensure that the first row contains the following headers: `Name`, `Phone`, `Email`, `Address`, and `Tags`. + Note that tags, if present, should be separated by commas (see cell `E3` for an example). -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +3. In HRMate, type in the following command in the command box: `import` +4. In the file dialog that opens up, go to where you saved your exported CSV file, click on it, and click on the Open button. +5. You should see your employee records show up in HRMate, along with the message "Employee records have been imported from [your file name]!" -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +Here are some possible error messages you might encounter and here's how you can fix them: -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +| Error Message | Why it happens | Fix | +|----------------------------------------------------------------------|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| Employee records were not imported. | You did not select a file in the file dialog | Retype the command, and make sure to select a CSV file when the file dialog opens | +| Records in file [file name] could not be imported, import cancelled. | Your file likely contains illegal characters or is corrupted | Ensure that your data fulfils the following constraints (to be added) | +| No valid records found in file [file name], import cancelled | Your file either is empty or does not contain a single valid employee record | Ensure that your file is non-empty and fulfils the abovementioned constraints | -* 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. -
-### Viewing help : `help`
+#### Exporting employee records : `export`
-Shows a message explaning how to access the help page.
+Not only can you bring your data into HRMate, you can also bring your data out of HRMate. HRMate's export feature allows you
+to export either the entire set of employee records, or employee records with a particular filter applied (e.g. only export
+all full-time employees, which are tagged with "Full time"). You can then either store your exported CSV file for future use,
+open it in a different application, or send it to another employee for them to import!
-
+Here's how you can export your data out of HRMate:
-Format: `help`
+1. In HRMate, type in the following command in the command box: `export [file name]`, replacing `[file name]` with the name
+you will like to give your file. Your files will be saved in CSV format automatically.
+ - For instance, if you would like to save your file as `employees.csv`, type in the command `export employees`
+2. You should see the message "Employee records have been saved to [file name]!"
+3. To retrieve your exported file, go to the folder in which HRMate is stored in your File Explorer (if using Windows) or
+Finder (if using Mac OS). From there, click on the `export` folder.
+4. You should see your file in the `export` folder.
+Here are potential error messages that you may receive and here's how to fix them:
-### Adding a person: `add`
+| Error Message | Why it happens | Fix |
+|---------------------------------------------------------------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Employee records could not be saved! | You do not have the permission to write the file | Try renaming your file name when typing out the command, especially if the previous name refers to an existing file. If not, move HRMate to a different folder where you can create files, and run the command again. |
-Adds a person to the address book.
-Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
-+1. Export your Excel save file in CSV format. Ensure that the separator is set to be a semicolon(`;`), and that you have +the following fields: Name, Phone, Email, Address, Tags. Note that tags in the Tags field have to be separated by commas. + * You may skip this step if you already have a CSV file (e.g. you are importing a previously exported CSV file generated by + HRMate) -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +2. If you are unsure how your file should look like, you may refer to the following images: + * Here's how your CSV file should look like if you open it up in Notepad: +  + * It is okay if your CSV file does not contain the first line `sep=;`, as this is a line added to files exported by HRMate + to help Excel open the file. Do ensure the next line has to be the following: + `Name;Phone;Email;Address;Tags` in order for HRMate to read it. Also note that tags are separated by commas + (see `colleagues, friends` under `Bernice Yu`'s row). + * If you open your CSV file in Excel, your file should look like this: +
+
+  +
+
+ * Do ensure that the first row contains the following headers: `Name`, `Phone`, `Email`, `Address`, and `Tags`. + Note that tags, if present, should be separated by commas (see cell `E3` for an example). -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +3. In HRMate, type in the following command in the command box: `import` +4. In the file dialog that opens up, go to where you saved your exported CSV file, click on it, and click on the Open button. +5. You should see your employee records show up in HRMate, along with the message "Employee records have been imported from [your file name]!" -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +Here are some possible error messages you might encounter and here's how you can fix them: -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. +| Error Message | Why it happens | Fix | +|----------------------------------------------------------------------|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| Employee records were not imported. | You did not select a file in the file dialog | Retype the command, and make sure to select a CSV file when the file dialog opens | +| Records in file [file name] could not be imported, import cancelled. | Your file likely contains illegal characters or is corrupted | Ensure that your data fulfils the following constraints (to be added) | +| No valid records found in file [file name], import cancelled | Your file either is empty or does not contain a single valid employee record | Ensure that your file is non-empty and fulfils the abovementioned constraints | -* 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. -
:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+
-Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal`
-### Listing all persons : `list`
+## Leave-related operations
-Shows a list of all persons in the address book.
+HRMate allows you to manage your employees' leave applications with ease.
-Format: `list`
+For instance, you can [add](#add-a-leave-application) a leave application, [find](#find-a-leave-application) specific leave applications, [edit](#edit-a-leave-application) leave applications, [delete](#delete-a-leave-application) a leave application, and [import/export](#importing-exporting-leave-applications) leave applications with just a few commands.
-### Editing a person : `edit`
-Edits an existing person in the address book.
+### Add a leave application
+When an employee applies for leave, you can use the `add-leave` command to add their leave application into HRMate.
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+#### Adding a leave application: `add-leave`
-* 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.
+Use the `add-leave` command to add a leave application to HRMate. This command will add the specified leave application to the leave list.
-Examples:
-* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+Here's how to add a leave application:
-### Locating persons by name: `find`
+1. Get the [index](#glossary) of the employee under the employee list. View this image in [quick start](#quick-start) for more information.
-Finds persons whose names contain any of the given keywords.
+-  + -### Deleting a person : `delete` +### Find a leave application -Deletes the specified person from the address book. +HRMate offers different commands for finding leave applications. [`find-leave-range`](#find-leave-applications-by-time-period-find-leave-range) and [`find-leave-status`](#find-leave-applications-by-leave-status-find-leave-status) would find leave applications by time period and leave status respectively while [`find-leave`](#find-leave-applications-belonging-to-an-employee-find-leave) and [`find-all-leave`](#view-all-leaves-find-all-leave) would find leave applications by employee and view all leave applications respectively. -Format: `delete INDEX` +#### Find leave applications by time period: `find-leave-range` -* 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, … +To find leave applications by time period, use the `find-leave-range` command. This command will find leave applications that fall within the specified time period. -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. +Here's how to use the `find-leave-range` command: -### Clearing all entries : `clear` +1. Type in the following command in the command box: + `find-leave-range [start/START_DATE] [end/END_DATE]`, and replace `START_DATE` with the start date of the time period, + and `END_DATE` with the end date of the time period, both in the format `yyyy-MM-dd`. + - For instance: if you wanted to view all leave applications that fall within the time period of 2023-10-27 and 2023-11-03 inclusive, + you would type in `find-leave-range start/2023-10-27 end/2023-11-03` in the command box. + - Do note that neither the start or end fields are required: + - If you wanted to view all leave applications that start on or after 2023-10-27, you can type in `find-leave-range start/2023-10-27`. + - If you wanted to view all leave applications that end on or before 2023-11-03, you can type in `find-leave-range end/2023-11-03`. + - If you wanted to view all leave applications, you can type in `find-leave-range` or [`find-all-leave`](#view-all-leaves-find-all-leave) instead. +2. Press `Enter` to execute the command. You should see the leave applications that fall within the time period you specified. -Clears all entries from the address book. -Format: `clear` +Here are some potential error messages that you may receive and here's how to solve them: -### Exiting the program : `exit` -Exits the program. +| Error message | Why it happens | Fix | +|--------------------------------------------------------|----------------------------------------------------------|--------------------------------------------------------------------| +| `The end date is earlier than the start date!` | The end date you provided is earlier than the start date | Make sure that the end date is later than the start date | +| `Date should be valid and in a format of "yyyy-MM-dd"` | The date you provided is not in the format `yyyy-MM-dd` | Make sure that the date you provided is in the format `yyyy-MM-dd` | + +Note: `yyyy-MM-dd` refers to the format of the date in the form of year-month-day. For example, 2023-11-01 refers to 1st November 2023. + +#### Find leave applications by leave status: `find-leave-status` + +To find leave applications by leave status, use the `find-leave-status` command. This command will find leave applications that have the specified status. + +Here's how to use the `find-leave-status` command: + +1. Type in the following command in the command box: + `find-leave-status STATUS`, and replace `STATUS` with the status of the leave applications you wish to view. + - For instance: if you wanted to view all leave applications that have been approved, you would type in `find-leave-status APPROVED` in the command box. + - Do note that the status field is required, and the status must be either `APPROVED`, `PENDING` or `REJECTED`. + - You can only specify one status at a time. + - If you wish to view all leave applications, you can use the [`find-all-leave`](#view-all-leaves-find-all-leave) command instead. +2. Press `Enter` to execute the command. You should see the leave applications that have the status you specified. + + +Here are some potential error messages that you may receive and here's how to solve them: + + +| Error message | Why it happens | Fix | +|-----------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------| +| `Command should only contain one of the following words: APPROVED / PENDING / REJECTED` | The status you provided is not valid | Make sure that the status you provided is either `APPROVED`, `PENDING` or `REJECTED` | + + + +#### Find leave applications belonging to an employee: `find-leave` + +To find leave applications belonging to an employee, use the `find-leave` command. This command will find leave applications that belong to the employee specified by their index in the employee list. + +Here's how to use the `find-leave` command: + +1. Get the [index](#glossary) of the employee under the employee list. View this image in [quick start](#quick-start) for more information. +2. Type in the following command in the command box: + `find-leave INDEX`, and replace `INDEX` with the index of the employee whose leave applications you wish to view. + - For instance: if you wanted to view all leave applications that belong to the employee with index 1, you would type in `find-leave 1` in the command box. + - Do note that the index field is required, and the index must be a valid number. + - The index must be a positive number. + - The index must be within the range of the number of employees in HRMate. + - If you wish to view all leave applications, you can use the [`find-all-leave`](#view-all-leaves-find-all-leave) command instead. +3. Press `Enter` to execute the command. You should see the leave applications that belong to the employee with the index you specified. + + + + + +Here are some potential error messages that you may receive and here's how to solve them: + + +| Error message | Why it happens | Fix | +|----------------------------------------|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `The person index provided is invalid` | The index you provided does not match with any person in the address book | Make sure that the employee that you are requesting for is currently displayed in the employee list. Then, use the number to the left of the employee's name as the index. | +| `Invalid command format!` | No index was provided, or index provided is not a positive number greater than 0 | Make sure that you provide an index when using this command. If you require assistance identifying the index, refer to the box directly above. Also check if the index is a positive integer, having an invalid index such as zero, negative numbers, non-integers, and characters can lead to this error message.| + +#### View all leaves: `find-all-leave` + +Use the `find-all-leave` command to view all leave applications currently stored in HRMate. + +Here's how to view all leave applications in the leave list: + +1. Type in the following command in the command box: + `find-all-leave` +2. Press `Enter` to execute the command. You should see all the leave applications in HRMate. + + +### Edit a leave application + +HRMate offers different commands for editing leave applications. [`approve-leave`](#approve-leave-application-by-index-approve-leave) and [`reject-leave`](#reject-leave-application-by-index-reject-leave) would approve and reject leave applications respectively while [`edit-leave`](#editing-a-leave-application-edit-leave) would edit the leave application comprehensively. + +#### Approve leave application by index: `approve-leave` + +Use the `approve-leave` command to approve a leave application in HRMate. This command will approve the specified leave application. + +Here's how to approve a leave application: + +1. Get the [index](#glossary) of the leave under the leave list. + +
+
+  +
+
+ * Do ensure that the first row contains the following headers: `Title`, `Employee`, `Start`, `End`, `Description`, and `Status`. +3. In HRMate, type in the following command in the command box: `import-leave` and press "Enter" +4. In the file dialog that opens up, go to where you saved your exported CSV file, click on it, and click on the Open button. +5. You should see your leave applications show up in HRMate, along with the message "leave applications have been imported from [your file name]!" + +Here are some possible error messages you might encounter and here's how you can fix them: + +| Error Message | Why it happens | Fix | +|---------------------------------------------------------------------|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| leave applications were not imported | You did not select a file in the file dialog | Retype the command, and make sure to select a CSV file when the file dialog opens | +| Records in file [file name] could not be imported, import cancelled | Your file likely contains illegal characters or is corrupted | Ensure that your data fulfils the following constraints (to be added) | +| No valid records found in file [file name], import cancelled | Your file either is empty or does not contain a single valid leave application | Ensure that your file is non-empty and fulfils the abovementioned constraints | + + +#### Exporting leave applications: `export-leave` + +Not only can you bring your data into HRMate, you can also bring your data out of HRMate. HRMate's export feature allows you +to export either the entire set of leave application records, or leave applications with a particular filter applied (e.g. only export +all leaves in a given time period). You can then either store your exported CSV file for future use, +open it in a different application, or send it to another employee for them to import! + +Here's how you can export your data out of HRMate: + +1. In HRMate, type in the following command in the command box: `export-leave [file name]`, replacing `[file name]` with the name + you will like to give your file. Your files will be saved in CSV format automatically. + - For instance, if you would like to save your file as `today.csv`, type in the command `export today` +2. You should see the message "leave applications have been saved to [file name]!" +3. To retrieve your exported file, go to the folder in which HRMate is stored in your File Explorer (if using Windows) or + Finder (if using Mac OS). From there, click on the `export` folder. +4. You should see your file in the `export` folder. + +Here are potential error messages that you may receive and here's how to fix them: + +| Error Message | Why it happens | Fix | +|-----------------------------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| leave applications could not be saved! | You do not have the permission to write the file | Try renaming your file name when typing out the command, especially if the previous name refers to an existing file. If not, move HRMate to a different folder where you can create files, and run the command again. | + + + +-------------------------------------------------------------------------------------------------------------------- + + + +## Other operations + +This section covers other operations that you can perform in HRMate. + +For information on how to get [help](#getting-help), [reset HRMate](#reset-hrmate), and [exit HRMate](#exit-hrmate), please refer to the respective sections below. + +### Getting help +Should you need any help, you can access this online user guide (this document) with the `help` command. + +#### Getting help : `help` + +Here's how to use the `help` command: + +1. Type in the following command in the command box: `help`. +2. Press "Enter" on your keyboard. +3. The following pop up should show: + + + + +4. Click on the "copy link" button to copy the link to the user guide, and paste into any [web browser](#glossary) to access the user guide. Alternatively, click the red button at the corner of the window to close the pop up. + +### Reset HRMate + +After playing with the different features in HRMate, you might feel that it's time to delete HRMate's sample employee +contacts and instead use your own. Rather than manually deleting every employee contact and leave application, here's a +quick and easy way to clear them in the app! + +#### Resetting HRMate by clearing all existing records: `clear` + +Here's how you can remove every employee contact and leave application from the app: + +1. In HRMate, type this command into the [command box](#command-box): `clear` and press Enter. +2. That's it! You should notice that your [Employee List](#employee-list) and [Leave List](#leave-list) are both empty. + You should also notice that the [Command Output Box](#command-output-box) will display the message: + `All employee contacts and leave applications have been cleared!` Now you have a clean slate and can start adding your + own data! + +**Warning:** +
:exclamation: **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.
-
-### Archiving data files `[coming in v2.0]`
-_Details coming soon ..._
--------------------------------------------------------------------------------------------------------------------
-## FAQ
+
+
+## How to interpret command formats
+
+Example command formats: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...`, `add-tag INDEX t/TAG...`
+
+The first command is used to add an employee while the second is used to add tags to a specified employee. Let's examine how the command is used.
+
+| **Command component examples** | **What they mean** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `add`, `add-tag` | The name of the command. The first word of the command is used to specify what command is used. |
+| `n/NAME`, `p/PHONE_NUMBER`, `e/EMAIL`, `a/ADDRESS`, `t/TAG` | Mandatory command fields. These fields are used to provide further information that the commmand needs. The start of a field is denoted by a field [prefix](#glossary). |
+| `n/`, `p/`, `e/`, `a/`, `t/` | Field prefix. These indicate what the field type is (name, phone number, email address etc.). They have a letter or phrase, followed by a backslash ("/"). This allows fields to be written in any order. For example, `edit 1 n/John Doe p/98765432` would have the same effect as `edit 1 p/98765432 n/John Doe`. |
+| `INDEX` | The [index](#glossary) of the command. Some command requires an index to specified which employee or leave to act on. It must be the second word of the command, after the name of the command. |
+| `[t/TAG]` | Optional command field. The square brackets ("[" and "]") indicates that a field is optional. However, some commands like [edit](#editing-the-name-phone-number-email-address-home-address-or-tags-of-employees--edit) have additional requirements like at least one of the optional fields must be specified. |
+| `...` | Variable optional fields. This indicates that we can supply more than one field of the same type. When coupled with the optional command field ("[" and "]"), this means that zero or more command fields of that type can be provided. For example, `[t/TAG]...` indicates **zero** or more tags can be specified while `t/TAG...` indicates **one** or more tags can be specified. To specify multiple fields, use multiple tag prefixes. For instance, to use full-time and remote as tag fields to a command, type `t/full-time t/remote` |
+
+**Notes**
+* Parameters can be in any order + 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
+ e.g. if the command `help 123` is executed, 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. + +-------------------------------------------------------------------------------------------------------------------- + + -**Q**: How do I transfer my data to another Computer?
-**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. +## FAQ +#### Q: How do I transfer my data to another computer? +**A**: We recommend using the [import and export command for employees](#importing-exporting-employee-records) and [import and export command for leave applications](#importing-exporting-leave-applications). +
+
+ +#### Q: How do I move a file? +**A**: +* For **Windows** users, first open File Explorer and find the file. Afterwards, drag the selected file's icon to the desired location using your mouse. For more help, please consult the [Microsoft documentation](https://support.microsoft.com/en-gb/office/move-or-copy-an-item-to-another-folder-19768dfe-86c4-40bf-b82c-1c084b624492)
+* For **Mac** users, first open Finder and find the specific file. Then drag it to the desired location using the mouse. For more help, please consult the [Apple documentation](https://support.apple.com/en-sg/guide/mac-help/mh26885/mac). +
+
+ +#### Q: How do I open a terminal? +**A**: +* For **Windows** users, press the Windows key, type in `powershell` and press Enter. The terminal should open. For more help, please consult the [Microsoft documentation](https://learn.microsoft.com/en-us/windows/terminal/install). +* For **Mac** users, open the Terminal app on your Mac. For more help, please consult the [Apple documentation](https://support.apple.com/en-sg/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac#:~:text=Terminal%20for%20me-,Open%20Terminal,%2C%20then%20double%2Dclick%20Terminal.). +
+
+ +#### Q: How do I navigate files in terminal? +**A**: You can use the `cd` command to navigate in terminal. For more information, please consult this [documentation](https://www.ibm.com/docs/en/aix/7.2?topic=directories-changing-another-directory-cd-command). +
+
+ +#### Q: How do I download Java 11? +**A**: Please refer to the official Java installation instructions [here](https://docs.oracle.com/en/java/javase/21/install/overview-jdk-installation.html#GUID-8677A77F-231A-40F7-98B9-1FD0B48C346A). +
+
+ +#### Q: How do I change the separator of my CSV file into semicolons(`;`) in Excel? +**A**: +* If you are a **Windows** user: + 1. In Excel, click on File > Options > Advanced. + 2. Under Editing options, uncheck the `Use system separators` check box. + 3. Change the Decimal separator to a comma (`,`) and the Thousands separator to a period (`.`). + 4. Save your file. When saving your file, change the save type (`Save as type`) to `CSV (Comma delimited) (*.csv)` + 5. After saving your file, remember to reset your Excel separators. Repeat steps 1 and 2, only that this time remember to + check the `Use system separators` check box instead. +* If you are a **Mac** user, unfortunately Excel makes it very difficult to change the separator to semicolons. +Stay tuned for future releases that will extend support for Mac OS! -------------------------------------------------------------------------------------------------------------------- ## Known issues @@ -184,14 +1049,59 @@ _Details coming soon ..._ -------------------------------------------------------------------------------------------------------------------- + + ## Command summary -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**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` -**List** | `list` -**Help** | `help` +| Action | Format, Examples | +|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` | +| **Add Leave** | `add-leave INDEX title/TITLE start/START_DATE end/END_DATE [d/DESCRIPTION]`
e.g., `add-leave 1 title/Sample Leave 1 start/2023-11-01 end/2023-11-01` | +| **Add Tag** | `add-tag EMPLOYEE_LIST_INDEX TAG`
e.g., `add-tag 3 remote` | +| **Approve Leave** | `approve-leave 1`
e.g., `approve-leave 1` | +| **Clear** | `clear` | +| **Delete** | `delete EMPLOYEE_LIST_INDEX`
e.g., `delete 3` | +| **Delete Leave** | `delete-leave LEAVE_LIST_INDEX`
e.g., `delete-leave 1` | +| **Delete Tag** | `delete-tag EMPLOYEE_LIST_INDEX TAG`
e.g., `delete-tag 3 remote` | +| **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` | +| **Edit Leave** | `edit-leave INDEX [title/TITLE] [start/START_DATE] [end/END_DATE] [d/DESCRIPTION] [s/STATUS]`
e.g., `edit-leave 1 title/medical leave start/2023-11-01` | +| **Exit** | `exit` | +| **Export Contacts** | `export FILE_NAME` | +| **Export Leaves** | `export-leave FILE_NAME` | +| **Find** | `find NAME...`
e.g., `find James Jake` | +| **Find All Tags** | `find-all-tag [t/TAG]...`
e.g.,`find-all-tag t/remote t/full-time` | +| **Find Some Tags** | `find-some-tag [t/TAG]...`
e.g.,`find-some-tag t/remote t/full-time` | +| **Find Leaves by Period** | `find-leave-range [start/START_DATE] [end/END_DATE]` | +| **Find Leaves by Status** | `find-leave-status STATUS` | +| **Find All Leaves** | `find-all-leave` | +| **Find All Tags** | `find-all-tag [t/TAG]...`
e.g.,`find-all-tag t/remote t/full-time` | +| **Find Leaves** | `find-leave INDEX`
e.g., `fin-leave 1` | +| **Find Leaves by Period** | `find-leave-range [start/START_DATE] [end/END_DATE]` | +| **Find Leaves by Status** | `find-leave-status STATUS` | +| **Find Some Tags** | `find-some-tag [t/TAG]...`
e.g.,`find-some-tag t/remote t/full-time` | +| **Help** | `help` | +| **Import Contacts** | `import` | +| **Import Leaves** | `import-leaves` | +| **List** | `list` | +| **Reject Leave** | `reject-leave 1`
e.g., `reject-leave 1` | +| **View tag** | `view-tag` | +-------------------------------------------------------------------------------------------------------------------- + +-------------------------------------------------------------------------------------------------------------------- + +## Glossary + +| Term | Meaning | +|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CLI | A text based interface where users type in commands instead of interacting with the application's graphics. Also see: GUI | +| CSV | A text file format that uses commas to separate values. It is supported by a wide range of software, including Microsoft Excel. | +| Command | A line of instructions that you input into the command box. Also see: Command box | +| Command Box | A box for you to input commands. Refer to [quick start](#quick-start) for more information. | +| Command Output Box | A box that displays the results of the command you keyed in. It will tell you whether the command you entered has successfully run, or if there is an error in your command that needs to be fixed. Refer to []() for a picture. | +| Employee List | The Employee list is the list of employees on the left side of the application. Refer to [quick start](#quick-start) for a picture. | +| Leave List | The Leave list is the list of leaves on the right side of the application. Refer to [quick start](#quick-start) for a picture. | +| GUI | A graphical based interface where users interact the the application's graphics like buttons or scrollpanes. Also see: CLI | +| Prefix | A letter or phrase before an input. Refer to [how to interpret command formats](#how-to-interpret-command-formats) for more information. | +| Tag | A text phrase used to categorise employees by. A tag can be a position (intern, senior), department (HR, tech) or any category (full-time, remote). | +| Index | The number labelling each employee in the employee list. Refer to [quick start](#quick-start) for more information. | +| Web browser | An application to serve the web like Internet Explorer, Google Chrome or Firefox. In fact, you are probably using one to access this guide right now! | diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6bd245d8f4e..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -title: "AB-3" -theme: minima - -header_pages: - - UserGuide.md - - DeveloperGuide.md - - AboutUs.md - -markdown: kramdown - -repository: "se-edu/addressbook-level3" -github_icon: "images/github-icon.png" - -plugins: - - jemoji diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- include custom-head.html -%} - -
- {%- assign default_paths = site.pages | map: "path" -%}
- {%- assign page_paths = site.header_pages | default: default_paths -%}
- {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
- {{ site.title | escape }}
-
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
-{{ page.title | escape }}
-
- {{ content }}
-
-
-
+
+
+
+
diff --git a/docs/_markbind/variables.json b/docs/_markbind/variables.json
new file mode 100644
index 00000000000..9d89eb0358b
--- /dev/null
+++ b/docs/_markbind/variables.json
@@ -0,0 +1,3 @@
+{
+ "jsonVariableExample": "Your variables can be defined here as well"
+}
diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
new file mode 100644
index 00000000000..89ae5318fa4
--- /dev/null
+++ b/docs/_markbind/variables.md
@@ -0,0 +1,4 @@
+
+ {{ content }}
+
+
+
+
-:information_source: Don’t forget to update `AddressBookParser` to use our new `RemarkCommandParser`!
+Don’t forget to update `AddressBookParser` to use our new `RemarkCommandParser`!
-
+
If you are stuck, check out the sample
[here](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-8bf239e8e9529369b577701303ddd96af93178b4ed6735f91c2d8488b20c6b4a).
@@ -244,7 +247,7 @@ Simply add the following to [`seedu.address.ui.PersonCard`](https://github.com/s
**`PersonCard.java`:**
-``` java
+```java
@FXML
private Label remark;
```
@@ -276,11 +279,11 @@ We change the constructor of `Person` to take a `Remark`. We will also need to d
Unfortunately, a change to `Person` will cause other commands to break, you will have to modify these commands to use the updated `Person`!
-
+
-:bulb: Use the `Find Usages` feature in IntelliJ IDEA on the `Person` class to find these commands.
+Use the `Find Usages` feature in IntelliJ IDEA on the `Person` class to find these commands.
-
+
Refer to [this commit](https://github.com/se-edu/addressbook-level3/commit/ce998c37e65b92d35c91d28c7822cd139c2c0a5c) and check that you have got everything in order!
@@ -291,11 +294,11 @@ AddressBook stores data by serializing `JsonAdaptedPerson` into `json` with the
While the changes to code may be minimal, the test data will have to be updated as well.
-
+
-:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
+You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
-
+
Check out [this commit](https://github.com/se-edu/addressbook-level3/commit/556cbd0e03ff224d7a68afba171ad2eb0ce56bbf)
to see what the changes entail.
@@ -308,7 +311,7 @@ Just add [this one line of code!](https://github.com/se-edu/addressbook-level3/c
**`PersonCard.java`:**
-``` java
+```java
public PersonCard(Person person, int displayedIndex) {
//...
remark.setText(person.getRemark().value);
@@ -328,7 +331,7 @@ save it with `Model#setPerson()`.
**`RemarkCommand.java`:**
-``` java
+```java
//...
public static final String MESSAGE_ADD_REMARK_SUCCESS = "Added remark to Person: %1$s";
public static final String MESSAGE_DELETE_REMARK_SUCCESS = "Removed remark from Person: %1$s";
diff --git a/docs/tutorials/RemovingFields.md b/docs/tutorials/RemovingFields.md
index f29169bc924..c73bd379e5e 100644
--- a/docs/tutorials/RemovingFields.md
+++ b/docs/tutorials/RemovingFields.md
@@ -1,8 +1,11 @@
---
-layout: page
-title: "Tutorial: Removing Fields"
+ layout: default.md
+ title: "Tutorial: Removing Fields"
+ pageNav: 3
---
+# Tutorial: Removing Fields
+
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
>
> — Antoine de Saint-Exupery
@@ -10,17 +13,17 @@ title: "Tutorial: Removing Fields"
When working on an existing code base, you will most likely find that some features that are no longer necessary.
This tutorial aims to give you some practice on such a code 'removal' activity by removing the `address` field from `Person` class.
-
+
**If you have done the [Add `remark` command tutorial](AddRemark.html) already**, you should know where the code had to be updated to add the field `remark`. From that experience, you can deduce where the code needs to be changed to _remove_ that field too. The removing of the `address` field can be done similarly.
However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** -
+
-* Table of Contents
-{:toc}
+
+
## Safely deleting `Address`
@@ -50,10 +53,10 @@ Let’s try removing references to `Address` in `EditPersonDescriptor`.
1. Remove the usages of `address` and select `Do refactor` when you are done.
- However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** -
+
- :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `address` field from the `Person` class will require you to modify its constructor.
-
+ **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `address` field from the `Person` class will require you to modify its constructor.
+
1. Repeat the steps for the remaining usages of `Address`
@@ -71,7 +74,7 @@ A quick look at the `PersonCard` class and its `fxml` file quickly reveals why i
**`PersonCard.java`**
-``` java
+```java
...
@FXML
private Label address;
diff --git a/docs/tutorials/TracingCode.md b/docs/tutorials/TracingCode.md
index 4fb62a83ef6..2b1b0f2d6b7 100644
--- a/docs/tutorials/TracingCode.md
+++ b/docs/tutorials/TracingCode.md
@@ -1,26 +1,30 @@
---
-layout: page
-title: "Tutorial: Tracing code"
+ layout: default.md
+ title: "Tutorial: Tracing code"
+ pageNav: 3
---
+# Tutorial: Tracing code
+
+
> Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are constantly reading old code as part of the effort to write new code. …\[Therefore,\] making it easy to read makes it easier to write.
>
> — Robert C. Martin Clean Code: A Handbook of Agile Software Craftsmanship
When trying to understand an unfamiliar code base, one common strategy used is to trace some representative execution path through the code base. One easy way to trace an execution path is to use a debugger to step through the code. In this tutorial, you will be using the IntelliJ IDEA’s debugger to trace the execution path of a specific user command.
-* Table of Contents
-{:toc}
+
+
## Before we start
Before we jump into the code, it is useful to get an idea of the overall structure and the high-level behavior of the application. This is provided in the 'Architecture' section of the developer guide. In particular, the architecture diagram (reproduced below), tells us that the App consists of several components.
-
+
+
+
-
+
-:bulb: **Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
-
+**Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
+
A quick look at the `seedu.address.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
@@ -67,14 +71,14 @@ public interface Logic {
But apparently, this is an interface, not a concrete implementation.
That should be fine because the [Architecture section of the Developer Guide](../DeveloperGuide.html#architecture) tells us that components interact through interfaces. Here's the relevant diagram:
-
+
+
-:bulb: **Intellij Tip:** The ['**Find Usages**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of the code a class/method/variable is being used.
-
+**Intellij Tip:** The ['**Find Usages**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of the code a class/method/variable is being used.
+
@@ -87,10 +91,10 @@ Now let’s set the breakpoint. First, double-click the item to reach the corres
Recall from the User Guide that the `edit` command has the format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` For this tutorial we will be issuing the command `edit 1 n/Alice Yeoh`.
-
+
-:bulb: **Tip:** Over the course of the debugging session, you will encounter every major component in the application. Try to keep track of what happens inside the component and where the execution transfers to another component.
-
+**Tip:** Over the course of the debugging session, you will encounter every major component in the application. Try to keep track of what happens inside the component and where the execution transfers to another component.
+
1. To start the debugging session, simply `Run` \> `Debug Main`
@@ -110,7 +114,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
**LogicManager\#execute().**
- ``` java
+ ```java
@Override
public CommandResult execute(String commandText)
throws CommandException, ParseException {
@@ -142,7 +146,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to the `AddressBookParser#parseCommand()` method (partial code given below):
- ``` java
+ ```java
public Command parseCommand(String userInput) throws ParseException {
...
final String commandWord = matcher.group("commandWord");
@@ -157,7 +161,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the command we typed is an edit command).
- ``` java
+ ```java
...
case EditCommand.COMMAND_WORD:
return new EditCommandParser().parse(arguments);
@@ -166,8 +170,10 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`.
- :bulb: **Intellij Tip:** Sometimes, you might end up stepping into functions that are not of interest. Simply use the `step out` button to get out of them!
-
+ 
+ -  +
FYI, The 'filtered list' is the list of persons resulting from the most recent operation that will be shown to the user immediately after. For the `edit` command, we populate it with all the persons so that the user can see the edited person along with all other persons. If this was a `find` command, we would be setting that list to contain the search results instead.
To provide some context, given below is the class diagram of the `Model` component. See if you can figure out where the 'filtered list' of persons is being tracked. -
+
* :bulb: This may be a good time to read through the [`Model` component section of the DG](../DeveloperGuide.html#model-component) 1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates a `CommandResult` object (containing information about the result of the execution) and returns it.
Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` method.
1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in this partial class diagram some of the classes you've encountered so far, and see how they fit into the class structure of the `Logic` component: -
+ :bulb: **Intellij Tip:** When trying to step into a statement such as `storage.saveAddressBook(model.getAddressBook())` which contains multiple method calls, Intellij will let you choose (by clicking) which one you want to step into.
-
+ -
+ + * Will return false for any other non-null string input + * e.g. empty string, "+1", " 2 " (untrimmed), "3 0" (contains whitespace), "1 a" (contains letters) + * + * @param s string to be tested + * @return true if {@code s} represents an integer + */ + public static boolean isInteger(String s) { + requireNonNull(s); + + try { + Integer.parseInt(s); + return true; + } catch (NumberFormatException nfe) { + return false; + } + } } diff --git a/src/main/java/seedu/address/logic/Logic.java b/src/main/java/seedu/address/logic/Logic.java index 92cd8fa605a..d29b40f503d 100644 --- a/src/main/java/seedu/address/logic/Logic.java +++ b/src/main/java/seedu/address/logic/Logic.java @@ -8,6 +8,8 @@ import seedu.address.logic.commands.exceptions.CommandException; import seedu.address.logic.parser.exceptions.ParseException; import seedu.address.model.ReadOnlyAddressBook; +import seedu.address.model.ReadOnlyLeavesBook; +import seedu.address.model.leave.Leave; import seedu.address.model.person.Person; /** @@ -33,6 +35,7 @@ public interface Logic { /** Returns an unmodifiable view of the filtered list of persons */ ObservableList