diff --git a/docs/UserGuide.md b/docs/UserGuide.md index e6e600dc4af..e749908fd65 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -35,7 +35,7 @@ Are you a School of Computing (SoC) Computing Club event planner juggling numero Managing everything efficiently just got easier with CoordiMate! -CoordiMate is your go-to **desktop app** designed specifically for **SoC Computing Club event planners** to help you **manage your contacts and tasks** for your events, so that you can focus on the event itself. +CoordiMate is your go-to **desktop app** designed specifically for **SoC Computing Club event planners**. It helps you **manage your contacts and tasks** for your events, so that you can focus on the event itself. And here's the best part – while it's perfect for members of SoC Computing Club, **event planners of all kinds** can benefit from CoordiMate's powerful features too! @@ -43,11 +43,11 @@ And here's the best part – while it's perfect for members of SoC Computing Clu 1. **User-Friendly [Command Line Interface (CLI)](#command-line-interface)**: CoordiMate is optimized for use via a CLI, combining all the benefits of a [Graphical User Interface (GUI)](#graphical-user-interface) with the efficiency of a CLI. -2. **Speedy Navigation**: If you're a fast typist, CoordiMate will help you complete your contact and tasks management faster than traditional GUI apps, maximising your productivity. +2. **Speedy Navigation**: If you're a fast typist, CoordiMate will help you manage your contacts and tasks faster than traditional GUI apps, maximising your productivity. -Don't let the stress of contact and task management hinder your event planning creativity. +Don't let the stress of contact and task management hinder your creativity. -Let **CoordiMate** take care of the details, while you craft extraordinary events with confidence. +Let CoordiMate take care of the details, while you craft extraordinary events with confidence. ## Using This Guide @@ -86,7 +86,8 @@ Known issues that you may face when using CoordiMate and how to resolve them. Throughout this guide, you will see different text styles that are used to highlight important information. - Text in blue are links which you can click on to jump to the relevant section. -- `Text with light blue background` are commands or file names which are used for CoordiMate. +- `Text with background` are commands or file names which are used for CoordiMate. +- Text in buttons are keys that you press on your keyboard. --- @@ -101,60 +102,58 @@ Throughout this guide, you will see different text styles that are used to highl
-## Features - [Back to Table of Contents](#table-of-contents) - 1. **Easy Management of People**: - - Seamlessly create, update, and delete your contacts, ensuring your contact list is always up-to-date.

+## Features + + 1. **Easy Contact Management**: + - CoordiMate seamlessly creates, updates, and deletes your contacts, ensuring that your contact list is always up-to-date.

2. **Effortless Task Management**: - - CoordiMate records down your tasks and their completion status, allowing you to stay on top of your to-do list.

+ - CoordiMate records your tasks and their completion status, allowing you to stay on top of your task list.

3. **Simplified Searching**: - - Easily locate contacts or tasks based on your criteria. No more scrolling through endless lists!

+ - CoordiMate easily locates contacts or tasks based on your given criteria. No more scrolling through endless lists!

4. **Hassle-Free Data Management**: - CoordiMate automatically saves your data on every change, so you never have to worry about losing your data. - - When CoordiMate starts, your existing data is automatically loaded in, allowing you to pick up where you left off. - - For advanced users, CoordiMate offers you complete data control by saving your data in a human-readable format.
Locate the data file at `[JAR file location]/data/addressbook.json` to edit CoordiMate's data directly! - -{% include admonition.html type="warning" title="Warning" body=" - -If your changes to the data file makes its format invalid, CoordiMate will not be able to load the data file, resulting in the contact and task lists being empty.
- -Always make a backup before you edit! - -" %} ---
-## Quick Start - [Back to Table of Contents](#table-of-contents) -1. Ensure you have Java `11` or above installed in your computer. +## Quick Start + +1. Ensure you have Java `11` or above installed on your computer. 2. Download the latest `CoordiMate.jar` from [here](https://github.com/AY2324S1-CS2103T-T10-2/tp/releases). -3. Copy `CoordiMate.jar` to the folder you want to use as the _home folder_ for CoordiMate. This folder will be used by CoordiMate to store its data. +3. Copy `CoordiMate.jar` to the folder you want to use as the home folder for CoordiMate. This folder will be used by CoordiMate to store its data. -4. Open a command terminal, `cd` into the folder you put `CoordiMate.jar` in, and use the `java -jar CoordiMate.jar` command to start CoordiMate.
+4. Open a command terminal. - A GUI similar to the below screenshot should appear in a few seconds. Note how the app contains some sample data.

- ![Ui](images/Ui.png) +5. Change the directory to the folder where you have placed `CoordiMate.jar`. If it is in your `Downloads` folder, type the command below and press Enter :

+ ``` + cd Downloads + ``` +6. To launch CoordiMate, type the following command and press Enter :

+ ``` + java -jar CoordiMate.jar + ``` + After a few seconds, a GUI should appear, showing some sample data, as in the screenshot below.

+ ![Ui](images/Ui.png)

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

+7. Type the command in the [command line](#understanding-our-gui) and press Enter to execute it. e.g. typing `help` and pressing Enter will open the help window. Some example commands you can try: - `listPerson` : Lists all persons. - - `addPerson n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a new contact named `John Doe` with the specified details. + - `addPerson n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a new person named `John Doe` with the specified details. - - `deletePerson 3` : Deletes the 3rd contact shown in the current contact list. + - `deletePerson 3` : Deletes the 3rd person shown in the current contact list. - `findTask caterer` : Finds all tasks with the word `caterer` in their title or note. @@ -166,16 +165,16 @@ Always make a backup before you edit! - `exit` : Exits the app. -6. Refer to the [Usage](#usage) section below for details of each command. +8. Refer to the [Usage](#usage) section below for details of each command. ---
-## Usage - [Back to Table of Contents](#table-of-contents) +## Usage + The commands are split into 4 main sections: 1. [Commands to Manage Persons](#1-commands-to-manage-persons) @@ -204,17 +203,24 @@ The commands are split into 4 main sections:

  • Fields in square brackets 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. + e.g. [t/TAG]…​ can be used as   (i.e. zero times), t/friend, t/friend t/family etc.

  • - Fields can be in any order.
    + All fields except INDEX can be in any order.
    e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

    • +
  • +

    + Whitespaces at the start and end of fields are trimmed.
    + e.g. The input n/ John Doe   will be interpreted as n/John Doe. +

    +
    • +

  • Extraneous fields for commands that do not take in fields (such as help, listPerson, deleteAllPerson, listTask, deleteAllTask and exit) will be ignored.
    @@ -233,10 +239,10 @@ If you are using a PDF version of this document, be careful when copying and pas

    -### Command Aliases - [Back to Table of Contents](#table-of-contents) +### Command Aliases + CoordiMate supports predefined aliases for commands, so that you can get things done faster!
    **Example 1: Adding a person** @@ -269,7 +275,7 @@ you can simply type: 
    lp
    -Both commands will show a full list of all the contacts in your contact list.
    +Both commands will show a full list of all the persons in your contact list.
    A summary of valid aliases is shown in the [Command Summary](#command-summary) section below. @@ -277,10 +283,10 @@ A summary of valid aliases is shown in the [Command Summary](#command-summary) s
    -### Understanding Our GUI - [Back to Table of Contents](#table-of-contents) +### Understanding Our GUI + ![Ui](images/Ui_explanation.png) 1. Menu Bar: Quick access to File and Help features. @@ -292,7 +298,7 @@ A summary of valid aliases is shown in the [Command Summary](#command-summary) s {% include admonition.html type="note" title="Note" body=" -Here's a handy trick – you can easily resize sections like Command Result, Contact List, and Task List. Just give the sides a drag in or out to customize the view according to your preference. +Here's a handy trick – you can easily resize sections like Command Result, Contact List, and Task List. Just drag the dividers to customize the view according to your preferences. " %} @@ -300,12 +306,12 @@ Here's a handy trick – you can easily resize sections like Command Result, Con
    +[Back to Table of Contents](#table-of-contents) + ### 1. Commands to Manage Persons #### 1.1. Adding a person: `addPerson` -[Back to Table of Contents](#table-of-contents) - You can add new persons to your contact list, so that you can remember details of new people you meet.

    Format:

    @@ -324,40 +330,42 @@ ap | Fields | Prefix | Required | Remarks | |--------|--------|:--------:|---------| -| `NAME` | `n/` | | Full name of the individual.| -| `PHONE_NUMBER` | `p/` | | Phone number of the individual.| -| `EMAIL` | `e/` | | Email address of the individual.| -| `ADDRESS` | `a/` | | Physical address of the individual.| -| `TAG` | `t/` | | Tag(s) for the individual.| +| `NAME` | `n/` | | Full name of the person. The name should only contain alphanumeric characters and spaces.| +| `PHONE_NUMBER` | `p/` | | Phone number of the person. The number should only contain numbers, and it should be at least 3 digits long.| +| `EMAIL` | `e/` | | Email of the person. The email should match this format: `@.