Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update UG with assign member to task, assign deadline to project&task #27

Merged
merged 3 commits into from
Mar 12, 2024
Merged

Update UG with assign member to task, assign deadline to project&task #27

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0510219
Update UG with assign member to task, assign deadline to project&task
modembcc Mar 12, 2024
8bbb949
Merge pull request #6 from modembcc/master
modembcc Mar 12, 2024
8dad032
Merge pull request #8 from modembcc/master
modembcc Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 112 additions & 51 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ title: User Guide

AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.

* Table of Contents
{:toc}
- Table of Contents
{:toc}

--------------------------------------------------------------------------------------------------------------------
---

## Quick start

Expand All @@ -25,42 +25,42 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
Some example commands you can try:

* `list` : Lists all contacts.
- `list` : Lists all contacts.

* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
- `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.

* `delete 3` : Deletes the 3rd contact shown in the current list.
- `delete 3` : Deletes the 3rd contact shown in the current list.

* `clear` : Deletes all contacts.
- `clear` : Deletes all contacts.

* `exit` : Exits the app.
- `exit` : Exits the app.

1. Refer to the [Features](#features) below for details of each command.

--------------------------------------------------------------------------------------------------------------------
---

## Features

<div markdown="block" class="alert alert-info">

**:information_source: Notes about the command format:**<br>

* Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
- Words in `UPPER_CASE` are the parameters to be supplied by the user.<br>
e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`.

* Items in square brackets are optional.<br>
- Items in square brackets are optional.<br>
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.

* Items with `…`​ after them can be used multiple times including zero times.<br>
- Items with `…`​ after them can be used multiple times including zero times.<br>
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.

* Parameters can be in any order.<br>
- Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.

* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.<br>
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
- 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.
</div>

### Viewing help : `help`
Expand All @@ -71,20 +71,21 @@ Shows a message explaning how to access the help page.

Format: `help`


### Adding a project: `add project`

Adds a project to the project manager.

Format: `add project <PROJECT_NAME>`

Examples:
* `add project CS2103T Duke Chatbot Project`
* `add project CS2101 Presentation`

- `add project CS2103T Duke Chatbot Project`
- `add project CS2101 Presentation`

Expected output:
* Success: `<PROJECT_NAME> has been added to the project list.`
* Failure: `Project <PROJECT_NAME> already exists.`

- Success: `<PROJECT_NAME> has been added to the project list.`
- Failure: `Project <PROJECT_NAME> already exists.`

### Listing all persons : `list`

Expand All @@ -98,33 +99,35 @@ Edits an existing person in the address book.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`

* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
- Edits the 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.

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.

- `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.

### Locating persons by name: `find`

Finds persons whose names contain any of the given keywords.

Format: `find KEYWORD [MORE_KEYWORDS]`

* The search is case-insensitive. e.g `hans` will match `Hans`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Only the name is searched.
* Only full words will be matched e.g. `Han` will not match `Hans`
* Persons matching at least one keyword will be returned (i.e. `OR` search).
- The search is case-insensitive. e.g `hans` will match `Hans`
- The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
- Only the name is searched.
- Only full words will be matched e.g. `Han` will not match `Hans`
- Persons matching at least one keyword will be returned (i.e. `OR` search).
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`

Examples:
* `find John` returns `john` and `John Doe`
* `find alex david` returns `Alex Yeoh`, `David Li`<br>

- `find John` returns `john` and `John Doe`
- `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)

### Deleting a project : `delete project`
Expand All @@ -133,14 +136,72 @@ Deletes the specified project from the project list.

Format: `delete project <PROJECT_NAME>`

* The specified project name must exist in the project list.
- The specified project name must exist in the project list.

Examples:

- `delete project CS2101 Presentation`

Expected output:

- Successful deletion: `<PROJECT_NAME> has been deleted from the project list.`
- Failed deletion: `Project <PROJECT_NAME> not found: Please make sure the project exists.`

### Assign member to task : `add person`

Assigns a team member to a task within a project.

Format: `add person <PERSON_NAME> /to <TASK_NAME> /in <PROJECT_NAME>`

- The specified project name must exist in the project list.
- The specified task name must exist in the project's task.
- The specified member name must be a member of the project team.

Examples:

- `add person Joe /to unit test /in CS2103_TP`

Expected output:

- Successful assignment: `<PERSON_NAME> has been assigned to <PROJECT_NAME>: <TASK_NAME>`
- Failed assignment (example): `Person <PERSON_NAME> is not a team member.`

### Assign deadline to project : `add deadline`

Assigns a deadline to a project.

Format: `add deadline <DEADLINE> /to <PROJECT_NAME>`

- The specified project name must exist in the project list.
- The deadline must be in `MMM D YYYY` format
Lin-Shuang-Shuang marked this conversation as resolved.
Show resolved Hide resolved

Examples:
* `delete project CS2101 Presentation`

- `add deadline Feb 25 2024 /to CS2103_TP`

Expected output:
* Successful deletion: `<PROJECT_NAME> has been deleted from the project list.`
* Failed deletion: `Project <PROJECT_NAME> not found: Please make sure the project exists.`

- Successful assignment: `Deadline <DEADLINE> has been assigned to <PROJECT_NAME>`
- Failed assignment (example): `Deadline needs to be in MMM D YYYY format.`

### Assign deadline to task : `add deadline`

Assigns a deadline to a task in a project.

Format: `add deadline <DEADLINE> /to <TASK_NAME> /in <PROJECT_NAME>`

- The specified project name must exist in the project list.
- The specified task name must exist in the project's tasks.
- The deadline must be in `MMM D YYYY` format

Examples:

- `add deadline Feb 25 2024 /to submit feature list /in CS2103_TP`

Expected output:

- Successful assignment: `Deadline <DEADLINE> has been assigned to <PROJECT_NAME>:<TASK_NAME>`
- Failed assignment (example): `Deadline needs to be in MMM D YYYY format.`

### Clearing all entries : `clear`

Expand Down Expand Up @@ -171,29 +232,29 @@ Furthermore, certain edits can cause the AddressBook to behave in unexpected way

_Details coming soon ..._

--------------------------------------------------------------------------------------------------------------------
---

## FAQ

**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.

--------------------------------------------------------------------------------------------------------------------
---

## Known issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.

--------------------------------------------------------------------------------------------------------------------
---

## Command summary

Action | Format, Examples
--------|------------------
**Add** | `add project <PROJECT_NAME>` <br> e.g., `add project CS2101 Presentation`
**Clear** | `clear`
**Delete** | `delete project <PROJECT_NAME>`<br> e.g., `delete project CS2101 Presentation`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
| Action | Format, Examples |
| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| **Add** | `add project <PROJECT_NAME>` <br> e.g., `add project CS2101 Presentation` |
| **Clear** | `clear` |
| **Delete** | `delete project <PROJECT_NAME>`<br> e.g., `delete project CS2101 Presentation` |
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` |
| **List** | `list` |
| **Help** | `help` |
Loading