forked from nus-cs2103-AY2324S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from pangyyen/py-UserGuide
Create new User Guide
- Loading branch information
Showing
1 changed file
with
22 additions
and
188 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,197 +1,31 @@ | ||
| --- | ||
| layout: page | ||
| 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} | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ## Quick start | ||
|
|
||
| 1. Ensure you have Java `11` or above installed in your Computer. | ||
|
|
||
| 1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). | ||
|
|
||
| 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. | ||
|
|
||
| 1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br> | ||
| A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br> | ||
|  | ||
|
|
||
| 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. | ||
|
|
||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. | ||
|
|
||
| * `delete 3` : Deletes the 3rd contact shown in the current list. | ||
|
|
||
| * `clear` : Deletes all contacts. | ||
|
|
||
| * `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> | ||
| 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> | ||
| 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> | ||
| 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> | ||
| 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> | ||
| 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. | ||
| </div> | ||
|
|
||
| ### Viewing help : `help` | ||
|
|
||
| Shows a message explaning how to access the help page. | ||
|
|
||
|  | ||
|
|
||
| Format: `help` | ||
|
|
||
|
|
||
| ### Adding a person: `add` | ||
|
|
||
| Adds a person to the address book. | ||
|
|
||
| Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` | ||
| # User Guide | ||
|
|
||
| <div markdown="span" class="alert alert-primary">:bulb: **Tip:** | ||
| A person can have any number of tags (including 0) | ||
| </div> | ||
| ## 1. Create Patient Record | ||
|
|
||
| Examples: | ||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` | ||
| * `add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal` | ||
| **What it does:** | ||
| Adds a new patient record to the system. | ||
|
|
||
| ### Listing all persons : `list` | ||
| **Command Format:** | ||
| `add-patient n/NAME ic/NRIC a/AGE p/PHONE_NUMBER` | ||
|
|
||
| Shows a list of all persons in the address book. | ||
|
|
||
| Format: `list` | ||
| **Example Commands:** | ||
| `add-patient n/Jane Doe ic/0123456A a/45 e/[email protected]` | ||
|
|
||
| ### Editing a person : `edit` | ||
| **Acceptable Values:** | ||
| - **NAME:** Alphabetic characters and spaces only | ||
| - **NRIC:** 8-16 Alphanumeric characters | ||
| - **AGE:** Integer values between 0 and 120 | ||
| - **PHONE_NUMBER:** 8-12 digits integer | ||
|
|
||
| Edits an existing person in the address book. | ||
| **Expected Output (Success):** | ||
| CLI: A new entry appears in the list of patients. | ||
| Message: "Successfully added patient: [Patient Details]" | ||
|
|
||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | ||
| **Expected Output (Failure):** | ||
| - Message: "Invalid input. Please enter a valid name." | ||
| - Message: "Invalid input. Please enter a valid NRIC (8-16 alphanumeric characters)." | ||
| - Message: "Invalid input. Age should be between 0 to 120" | ||
| - Message: "Invalid input. Please enter a valid phone number." | ||
|
|
||
| * 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/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively. | ||
| * `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. | ||
|
|
||
| ### 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). | ||
| 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> | ||
|  | ||
|
|
||
| ### Deleting a person : `delete` | ||
|
|
||
| Deletes the specified person from the address book. | ||
|
|
||
| Format: `delete INDEX` | ||
|
|
||
| * Deletes the person at the specified `INDEX`. | ||
| * The index refers to the index number shown in the displayed person list. | ||
| * The index **must be a positive integer** 1, 2, 3, … | ||
|
|
||
| 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. | ||
|
|
||
| ### Clearing all entries : `clear` | ||
|
|
||
| Clears all entries from the address book. | ||
|
|
||
| Format: `clear` | ||
|
|
||
| ### Exiting the program : `exit` | ||
|
|
||
| Exits the program. | ||
|
|
||
| Format: `exit` | ||
|
|
||
| ### Saving the data | ||
|
|
||
| AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually. | ||
|
|
||
| ### Editing the data file | ||
|
|
||
| AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. | ||
|
|
||
| <div markdown="span" class="alert alert-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. | ||
| </div> | ||
|
|
||
| ### Archiving data files `[coming in v2.0]` | ||
|
|
||
| _Details coming soon ..._ | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ## FAQ | ||
|
|
||
| **Q**: How do I transfer my data to another Computer?<br> | ||
| **A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ## Known issues | ||
|
|
||
| 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ## Command summary | ||
|
|
||
| Action | Format, Examples | ||
| --------|------------------ | ||
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` | ||
| **Clear** | `clear` | ||
| **Delete** | `delete INDEX`<br> e.g., `delete 3` | ||
| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | ||
| **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | ||
| **List** | `list` | ||
| **Help** | `help` | ||
| --- |