diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 16145e9406c..788aa3f0891 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -837,5 +837,5 @@ Team size: 5 6. **Add sharper colour contrast between assets and tags**: Currently, tags and assets have a very similar color scheme, making it harder for users to differentiate them. In future versions, we will add more visual clarity tags and assets. 7. **Make duplicate checking more robust**: The application enforces distinct contacts, but the user may add the same contact twice unintentionally (e.g. entering `dave tan` and `Dave Tan`). We plan to make duplicate checking more robust and potentially warn the user first for such cases. 8. **Add a `remark` command**: At present users can only add additional information to contacts using tags. We plan to allow the user to add more detailed information like notes using a `remark` command. -9. **Add command shortcuts and suggestions**: Currently, there is no support for any shortcuts or suggestions of commands to aid both experienced and new users. We plan to add command shortcuts and suggestions to make the application easier to use for all users. -10. **Make phone number validation more robust**: Currently, we perform little validation on the phone number to allow for inputs such as `2555 (ext)` for the user's convenience. This however means that inputs such as `+++` may be accepted. We plan to improve phone number validation without restricting the user. +9. **Add command suggestions**: Currently, there is no support for any auto-complete suggestions for commands, that would aid both experienced and new users. We plan to add an auto-complete feature, that would display what command the user is likely typing in a separate pop-up, the ability to press `tab` to quickly complete the command word, and what fields they are missing. +10. **Make phone number validation more robust**: Currently, we perform little validation on the phone number to allow for inputs such as `2555, 232` for the user's convenience. This however means that inputs such as `+++` would be accepted, which is unlikely to be the user's intention. We plan to improve phone number validation without restricting the user in the future. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index ca493f68a3f..c23d0e26ab5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -45,7 +45,9 @@ referenced section immediately. A [glossary](#glossary) is provided in case you encounter any unfamiliar terms. + Look out for texts with icons similar to this, which would contain additional information, tips, or warnings. + #### New Users @@ -55,12 +57,14 @@ application and get started. After which, you may take a look at the [features](#features) of *AssetBook*, or simply follow this guide in order. + Don't worry if you don't have much technical know-how! We will guide you through step-by-step. + #### Experienced Users -If you are not a new user and are just looking to refresh your memory, you can utilise the [table of contents](#table-of-contents) +If you are not a new user and are just looking to refresh your memory, you can utilize the [table of contents](#table-of-contents) or skip to the [command summary](#command-summary). --- @@ -84,8 +88,8 @@ or skip to the [command summary](#command-summary). + [Editing an Asset](#editing-an-asset-asset) + [Clear all Contacts](#clear-all-contacts-clear) + [Miscellaneous Shortcuts](#miscellaneous-shortcuts) - + [Listing all Contacts](#listing-all-contacts-list) + [Finding Contacts](#finding-contacts-find) + + [Listing all Contacts](#listing-all-contacts-list) + [Undoing Commands](#undoing-commands-undo) + [Redoing Commands](#redoing-commands-redo) + [Display Previous Commands](#display-previous-commands-and) @@ -108,7 +112,9 @@ or skip to the [command summary](#command-summary). ### Setting Up + The following instructions are for **Windows**, **MacOS** and **Linux**. + 1. Ensure you have [Java 11](https://www.oracle.com/java/technologies/downloads/#java11) installed on your device. @@ -116,7 +122,7 @@ The following instructions are for **Windows**, **MacOS** and **Linux**. 2. Download the latest `assetbook.jar` from [here](https://github.com/AY2324S2-CS2103T-W12-3/tp/releases).

- +

3. Move `assetbook.jar` into the folder where you want *AssetBook* to store the contact information. New users may simply @@ -127,6 +133,8 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

+
+ 4. To launch the application, double-click on `assetbook.jar` and a GUI similar to the one below should appear. Note that the application contains some sample data when launched for the first time. @@ -135,7 +143,9 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

+ Having trouble? You may find the FAQ useful. +
@@ -145,7 +155,7 @@ Having trouble? You may find the - +

1. **Command Input Box** @@ -156,7 +166,9 @@ Here are the components of the GUI. 6. **Assets** + You can resize the command output box by dragging its top edge. + --- @@ -179,7 +191,7 @@ Let's get started by adding our first contact, John Doe, into *AssetBook*. 1. **Click on the Command Input Box**: Begin by locating and clicking on the [command input box](#navigating-the-gui) near the bottom of the application.

- +

@@ -188,7 +200,7 @@ Let's get started by adding our first contact, John Doe, into *AssetBook*. Let's add your first contact, John, by copying the following command into the command input box:
`add n\John Doe p\98765432 e\johnd@example.com a\311, Clementi Ave 2, #02-25 t\friends t\owesMoney A\screwdriver`

- +

3. **Execute the Command**: @@ -199,7 +211,7 @@ Let's get started by adding our first contact, John Doe, into *AssetBook*. 4. **Confirmation**: Check for a confirmation message to verify that John Doe has been added successfully.

- +

--- @@ -215,16 +227,18 @@ Now that you've successfully added John Doe to *AssetBook*, let's try to find hi Let's now find the contact, John, we just added by entering the following command:
`find John`

- +

3. **Execute the Command**: After typing the command, simply press `Enter` to find the contact in *AssetBook*. +
+ 4. **View the Results**: John Doe will be displayed in the contacts list, along with the total number of contacts matching 'John' found.

- +

--- @@ -241,11 +255,13 @@ Let's update John's email address. We can find out what John's index is by checking the number currently beside his name. The `find` command makes it easier by reducing the number of contacts displayed. Here, he has index 1.

- +

+ The index each contact has changes when you use the find command. + --- @@ -257,7 +273,7 @@ We can edit John's email by typing the following command:
`edit 1 e\newemail@example.com`

- +

4. **Execute the Command**: @@ -268,7 +284,7 @@ We can edit John's email by typing the following command:
5. **Confirmation**: Look for a confirmation message, indicating that John's email has been successfully updated.

- +

--- @@ -286,16 +302,18 @@ Let's update our existing assets. `asset o\screwdriver n\screw`

- +

3. **Execute the Command**: After entering the command, press `Enter`. This will update the asset details in *AssetBook*. +
+ 4. **Confirmation**: Check for a confirmation message to ensure that the asset has been successfully updated.

- +

--- @@ -319,7 +337,9 @@ A valid input by the user corresponding to the above will be `add n\John Doe e\johndoe@example.com a\574 Ang Mo Kio Ave 10 p\12345678 A\L293D` + Command words are not case-sensitive, i.e. `add`, `Add`, `ADD`, etc. are all valid. + @@ -353,11 +373,15 @@ After successful execution of a command, some feedback will appear in the [comma If you enter something that the application did not expect or does not understand, an *error* message will show up instead. + **If you are using a PDF version of this document**, be careful when you copy and paste commands that span multiple lines, as space characters may be missing when copied over to the application. + + Note that the backslash `\` is reserved for prefixes. It is **not** allowed to be part of any field. + --- @@ -375,7 +399,9 @@ Adds a new contact. Format: `add n\NAME p\PHONE e\EMAIL a\ADDRESS [t\TAG]... [A\ASSET]...` + A contact can have any number of tags and assets (including 0). + #### Example @@ -383,7 +409,7 @@ A contact can have any number of tags and assets (including 0). `add n\John Doe e\johndoe@example.com a\574 Ang Mo Kio Ave 10 p\12345678 A\L293D`

- +

@@ -394,7 +420,7 @@ If the command was executed successfully, the following message will appear:
`New contact added: John Doe; Phone: 12345678; Email: johndoe@example.com; Address: 574 Ang Mo Kio Ave 10; Tags: []; Assets: [[L293D]]`

- +

@@ -404,7 +430,7 @@ If the command was executed successfully, the following message will appear:
If the command was not executed successfully, the proper format of the `add` command will be shown to you instead.

- +

@@ -446,13 +472,13 @@ If the command was not executed successfully, the proper format of the `add` com * Multiple assets can be specified at once. For example, a valid option is `A\asset1 A\asset2 A\asset3`. + You may assign the same asset to multiple contacts, so remember to name different assets with unique names. + --- -
- ### Deleting a Contact: `delete` Delete a contact by specifying its index. @@ -483,7 +509,9 @@ Format: `edit INDEX [n\NAME] [p\PHONE] [e\EMAIL] [a\ADDRESS] [t\TAG]... [A\ASSET * You can remove all assets associated to the contact by typing `A\` without specifying any assets after it. + Edit **replaces** the current tags and assets of a contact. It does **not** add on to existing tags and assets. + --- @@ -511,7 +539,9 @@ Deletes all contacts. Format: `clear` + If you unintentionally deleted all your contacts, you can use the `undo` command to bring them back. + --- @@ -522,16 +552,6 @@ If you unintentionally deleted all your contacts, you can use the `undo` command This section contains the details for **non-modifying commands** and other useful shortcuts. -### Listing all Contacts: `list` - -Displays all contacts. - -Format: `list` - -* Useful when you have filtered the contacts list with `find`. - ---- - ### Finding Contacts: `find` Finds contacts by name, tag or asset. @@ -544,7 +564,7 @@ Find contacts whose name, tags, or assets contain `jo`:
`find jo`

- +

3 matches were found, each with `jo` found in a different field and at different positions. @@ -556,7 +576,15 @@ Find contacts whose name, tags, or assets contain `jo`:
--- -
+### Listing all Contacts: `list` + +Displays all contacts. + +Format: `list` + +* Useful when you have filtered the contacts list with `find`. + +--- ### Undoing Commands: `undo` @@ -582,7 +610,9 @@ Format: `redo` If an asset name was changed, after `undo` was executed to verify what the previous asset name was, `redo` can be used to revert to the new asset name. + After executing an `undo` command, you cannot `redo` this if another modifying command was executed. + --- @@ -598,7 +628,9 @@ Press the `↑` arrow key to show older commands. Press the `↓` arrow key to show newer commands. + Only successfully executed commands will be shown. + --- @@ -706,10 +738,6 @@ At present, names allow any special character except `\`. This is to allow the u that may include symbols such as `/`, `'` and `-`. As such, the application may accept all manner of gibberish for names. A remedy is planned for the future to perform more robust checks on names. -#### Scrolling -An astute user may notice that the ability to scroll with the keyboard is missing from the application. This feature -will be implemented as soon as possible in an upcoming release. - #### More Asset Details Some users may require assets to have more details recorded. We plan to add features that allow adding of more fields to assets such as serial number, location, etc. diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index dbc9035e91e..b57edcfaecd 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -156,27 +156,17 @@ mark { .btn { font-size: 0.65rem !important; } + img { + zoom: 0.8; /* might not work on some browsers */ + } } -h1, +h2, +h3, h4, h5, h6 { - color: darkslategray; -} - -h2 { - font-weight: bold; - background-color: darkslategray; - color: #FFFFFF; - padding: 8px 8px 12px 8px; -} - -h3 { - font-weight: bold; - background-color: darkolivegreen; - color: #FFFFFF; - padding: 8px 8px 12px 8px; + color: #e46c0a; }