Skip to content

Commit

Permalink
Merge pull request #59 from aureliony/30-update-ug
Browse files Browse the repository at this point in the history 
Update all UG sections
  • Loading branch information
@aureliony
aureliony authored Mar 6, 2024
2 parents c60de60 + 1c4ab48 commit 3b04b21
Showing 1 changed file with 88 additions and 95 deletions.
183 changes: 88 additions & 95 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
pageNav: 3
---

# AB-3 User Guide
# AssetBook-3 User Guide

AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
AssetBook-3 is a desktop application for logistics managers to keep track point-of-contacts' (POCs) contact information, along with their relevant assets. It is meant for those who have too many POCs and assets, and wish to easily retrieve contact details based on name, tag, or asset ID.

<!-- * Table of Contents -->
<page-nav-print />
Expand All @@ -15,29 +15,16 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo

## Quick start

1. Ensure you have Java `11` or above installed in your Computer.
1. Ensure you have Java `11` in your Computer.

1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
1. Download the latest `assetbook.jar` from [here](https://github.com/AY2324S2-CS2103T-W12-3/tp/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
1. Copy the file to the folder you want to use as the _home folder_.

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>
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar assetbook.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>
![Ui](images/Ui.png)

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

* `clear` : Deletes all contacts.

* `exit` : Exits the app.

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

--------------------------------------------------------------------------------------------------------------------
Expand All @@ -48,130 +35,138 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo

**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`.
e.g `--name NAME [--tag TAG]` can be used as `--name John Doe --tag friend` or as `--name 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.
* Items with `…` after them can be used multiple times including zero times.<br>
e.g. `[--tag <tag>]…` can be used as `` (i.e. 0 times), `--tag friend`, `--tag friend --tag 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.
e.g. if the command specifies `--name NAME --phone PHONE_NUMBER`, `--phone PHONE_NUMBER --name 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`.
* Extraneous parameters for commands that do not take in parameters (such as `exit`) will be ignored.<br>
e.g. if the command specifies `exit 123`, it will be interpreted as `exit`.

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

### Viewing help : `help`

Shows a message explaning how to access the help page.

![help message](images/helpMessage.png)

Format: `help`

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

### Adding a person: `add`

Adds a person to the address book.
Adds a new contact or asset to the system.

Format for adding a new contact: `add --name <name> [--email <email> --phone <phone>] [--tag <tag>]...`

Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
Format for adding a new asset: `add --id <asset id> --location <location>`

<box type="tip" seamless>

**Tip:** A person can have any number of tags (including 0)
</box>

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`
#### Examples
* Add a contact: `add --name John Doe --email johndoe@example.com --phone +12345678 --tag friend`
* Add an asset: `add --id 001 --location WarehouseA`

### Listing all persons : `list`
#### Options
`--name`
* Name of the contact.
* Case sensitive, i.e. John Doe != John Doe.
* Leading and trailing spaces are automatically removed.
* Multiple people with the same name are allowed.

Shows a list of all persons in the address book.
`--email`
* Email of the contact.
* Must have ‘@’.

Format: `list`
`--phone`
* Phone number of the contact.
* Only digits and ‘+’ is allowed.
* Any number of digits are allowed.
* ‘+’ is optional and must be the first character.

### Editing a person : `edit`
`--tag`
* Tag associated with contact.
* Contact can be created first without tags, then tags can be added later.
* Case sensitive, i.e. NUS != nus.
* Must have no spaces.

Edits an existing person in the address book.
`--id`
* An ID associated with the asset.
* Not necessarily unique.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
`--location`
* The location associated with the asset.

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

### Delete a contact or asset : `delete`

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.
Delete a contact or asset from the system by specifying its ID.

### Locating persons by name: `find`
Format: `delete <id>`
* The id refers to the unique id shown in the GUI.

Finds persons whose names contain any of the given keywords.
#### Examples
`delete a123` deletes the asset with id `a123`.

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

Format: `find KEYWORD [MORE_KEYWORDS]`
### Editing an entity : `edit`

* 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`
Edit existing contacts or assets without recreating them.

Examples:
* `find John` returns `john` and `John Doe`
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findAlexDavidResult.png)
Format: `edit <id> [--email <email> --phone <phone no.> [--tag <tag name> [<tag name>]...]] | [--location <location>]`

### Deleting a person : `delete`
Example: `edit c123 --email newemail@example.com` edits the contact with id `123`, changing its email to `newemail@example.com`.

Deletes the specified person from the address book.
* Edits the entity with the specified `id`. The `id` refers to the unique id shown by the GUI in the contacts list, which can refer to an asset or person.
* 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 `--tag` without
specifying any tags after it.

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, …​
### Search : `search`

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.
Search contacts, assets or tags by any of their metadata.

### Clearing all entries : `clear`
Format: `search [--contact] [--asset] [--tag] <string>`

Clears all entries from the address book.
Example: `search --tag Marketing` searches all tags for the term `Marketing`.

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.
AssetBook 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.
AssetBook data are saved automatically as a JSON file `[JAR file location]/data/assetbook.json`. Advanced users are welcome to update data directly by editing that data file.

<box type="warning" seamless>

**Caution:**
If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.<br>
Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
If your changes to the data file makes its format invalid, AssetBook 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.<br>
Furthermore, certain edits can cause the AssetBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
</box>

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

### Archiving data files `[coming in v2.0]`

_Details coming soon ..._
Expand All @@ -181,7 +176,7 @@ _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.
**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 AssetBook home folder.

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

Expand All @@ -193,12 +188,10 @@ _Details coming soon ..._

## 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/jamesho@example.com 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/jameslee@example.com`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
Action | Format | Examples
-----------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add --name <name> [--email <email> --phone <phone no.> [--tag <tag name> [<tag name>] ...]] [--id <asset id> --location <location>]` | `add --name John Doe --email johndoe@example.com --phone 87654321` <br> `add --id <asset id> --location <location>`
**Delete** | `edit <id> [--email <email> --phone <phone no.> [--tag <tag name> [<tag name>] ...]] [--location <location>]` | `edit c123 --email newemail@example.com`
**Edit** | `edit <id> [--email <email> --phone <phone no.> [--tag <tag name> [<tag name>] ...]] [--location <location>]` | `edit c123 --email newemail@example.com`
**Search** | `search [--contact] [--asset] [--tag] <string>` | `search --tag Marketing`
**Exit** | `exit` | `exit`

0 comments on commit 3b04b21

Please sign in to comment.