From 4c765ae1eea12434064dc87399b1ba5ff1bfcbc3 Mon Sep 17 00:00:00 2001 From: nicolengk Date: Fri, 10 Nov 2023 13:39:47 +0800 Subject: [PATCH 1/2] update ug --- docs/UserGuide.md | 173 +++++++++++++++++++++++++++++----------------- 1 file changed, 111 insertions(+), 62 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index f651438ae29..3edb9b20e02 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -19,7 +19,7 @@ Greetings property agents! A warm welcome to our user guide, your companion for ## Introduction [Back to Table of Contents](#table-of-contents) -PropertyMatch is a **contact and property management system** that aims to help you, property agents, to organise their client profiles with their corresponding properties. +PropertyMatch is a **contact and property management system** that aims to help you, property agents, to organise their client profiles with their corresponding properties. This guide is designed for property agents ranging from novice tech enthusiasts to seasoned tech professionals who want to organise and streamline their client and property data. With PropertyMatch, you can easily - **Match** your existing customers and properties @@ -40,6 +40,8 @@ This **user guide** aims to provide you with an in-depth overview of how to set As property agents, we understand that using a [Command Line Interface (CLI)](https://en.wikipedia.org/wiki/Command-line_interface) might not be your forte. Fear not! Our application is tailored just for you with simplicity in mind, with easy to use commands that you will naturally reach to without having to remember how to use them. +Already familiar with using a CLI? Great! Feel free to move on to the section below to begin your PropertyMatch journey! + * Embark on your PropertyMatch journey using our [Quick Start](#quick-start) Guide - the express lane to get PropertyMatch up and running in no time! * Afterwhich, you can head over to our [Interface Layout](#interface-layout) section to familiarise yourself with our snazzy interface and discover the ins and outs of the [CLI](#2-command-input-and-output-boxes). @@ -62,7 +64,50 @@ In addition, here are some symbols that will give you a more enjoyable time usin -------------------------------------------------------------------------------------------------------------------- +## Quick start +[Back to Table of Contents](#table-of-contents) + +1. Ensure you have Java `11` or above installed in your Computer. + * The method to check the Java version you use will be different for every operating system. + * **Windows** users:
+ Click on the '**Windows**' key and search for '**Command Prompt**'
+ * **Mac** users:
+ Click on '**F4**' and search for '**Terminal**' + * **Linux** users:
+ Click on '**Ctrl**' + '**Alt**' + '**T**' keys simultaneously + * Once the application is open, type `java -version` and hit '**Enter/ Return**'. + * The application should state your Java version as `11`. + + * If you do not see `11`, this [link](https://docs.oracle.com/en/java/javase/11/install/overview-jdk-installation.html#GUID-8677A77F-231A-40F7-98B9-1FD0B48C346A) (external link to Oracle) provides a step-by-step installation guide for Java `11`. + +2. Download the latest `propertymatch.jar` from our [releases page](https://github.com/AY2324S1-CS2103T-W11-2/tp/releases). After clicking into the release page, scroll down slightly until you reach the Assets section of the page. This section should look like this:
+ + + ![Release page](images/user-guide/ReleasePage.png) + +3. Simply click on `propertymatch.jar`, and PropertyMatch should begin automatically downloading on your computer! + +4. Copy the `propertymatch.jar` file to the folder you want to use as the _home folder_ for PropertyMatch. All data will be created and stored in that folder. If you are unsure where to place the folder, go to your desktop and create a folder. You can then copy the `propertymatch.jar` file into the folder you just created. + +5. Open the folder and double-click on `propertymatch.jar` to open PropertyMatch. If this does not work, please open up the terminal on your computer and type in `java -jar propertymatch.jar` to start the application. + +6. A GUI similar to the one below should appear in a few seconds. Note that the app already contains some sample data.
+ ![startUi](images/startUi.png) + +Congratulations! PropertyMatch is now set up and ready to work on your system. + +If you encounter any problems during the setup process, please check out the FAQ section of this guide, which is located near the bottom of the guide, which hopefully contains some information that can help you diagnose your issue. + +
+ +**:exclamation: Caution (for advanced users):**
+* On first launch, PropertyMatch will create a few files that have the extension `.json` in its *home directory*. These files are used + by PropertyMatch to store its data.
+* **Edit these at your own risk**, as PropertyMatch will start with an empty database if it detects any + error in the formatting of the data in these files. +
+-------------------------------------------------------------------------------------------------------------------- ## Interface Layout [Back to Table of Contents](#table-of-contents) @@ -135,50 +180,6 @@ It appears when you execute the [Help Command](#viewing-help-help). -------------------------------------------------------------------------------------------------------------------- -## Quick start -[Back to Table of Contents](#table-of-contents) - -1. Ensure you have Java `11` or above installed in your Computer. - * The method to check the Java version you use will be different for every operating system. - * **Windows** users:
- Click on the '**Windows**' key and search for '**Command Prompt**'
- * **Mac** users:
- Click on '**F4**' and search for '**Terminal**' - * **Linux** users:
- Click on '**Ctrl**' + '**Alt**' + '**T**' keys simultaneously - * Once the application is open, type `java -version` and hit '**Enter/ Return**'. - * The application should state your Java version as `11`. - - * If you do not see `11`, this [link](https://docs.oracle.com/en/java/javase/11/install/overview-jdk-installation.html#GUID-8677A77F-231A-40F7-98B9-1FD0B48C346A) (external link to Oracle) provides a step-by-step installation guide for Java `11`. - -2. Download the latest `propertymatch.jar` from our [releases page](https://github.com/AY2324S1-CS2103T-W11-2/tp/releases). After clicking into the release page, scroll down slightly until you reach the Assets section of the page. This section should look like this:
- ![Release page](images/user-guide/ReleasePage.png) - -3. Simply click on `propertymatch.jar`, and PropertyMatch should begin automatically downloading on your computer! - -4. Copy the `propertymatch.jar` file to the folder you want to use as the _home folder_ for PropertyMatch. All data will be created and stored in that folder. If you are unsure where to place the folder, go to your desktop and create a folder. You can then copy the `propertymatch.jar` file into the folder you just created. - -5. Open the folder and double-click on `propertymatch.jar` to open PropertyMatch. If this does not work, please open up the terminal on your computer and type in `java -jar propertymatch.jar` to start the application. - -6. A GUI similar to the one below should appear in a few seconds. Note that the app already contains some sample data.
- ![startUi](images/startUi.png) - -Congratulations! PropertyMatch is now set up and ready to work on your system. - -If you encounter any problems during the setup process, please check out the FAQ section of this guide, which hopefully contains some information that can help you diagnose your issue. - -
- -**:exclamation: Caution (for advanced users):**
-* On first launch, PropertyMatch will create a few files that have the extension `.json` in its *home directory*. These files are used -by PropertyMatch to store its data.
-* **Edit these at your own risk**, as PropertyMatch will start with an empty database if it detects any -error in the formatting of the data in these files. -
-
- --------------------------------------------------------------------------------------------------------------------- - ## Features [Back to Table of Contents](#table-of-contents) @@ -208,10 +209,14 @@ If you just want a quick summary of all the feature PropertyMatch has, do take a ### Add Commands + [Back to Table of Contents](#table-of-contents) + +Ready to start adding customer and properties into PropertyMatch? Read the follow section to find out more about our `add` feature. + #### Adding a customer: `addcust` -Adds a customer to your application. +Adds a customer and their respective contact details and information to PropertyMatch's customer address book. Format: `addcust n/NAME p/PHONE e/EMAIL b/BUDGET [c/CHARACTERISTIC]…​` @@ -221,6 +226,13 @@ Format: `addcust n/NAME p/PHONE e/EMAIL b/BUDGET [c/CHARACTERISTIC]…​` * `b/BUDGET` : Budget of the customer * `c/CHARACTERISTIC` (optional) : Characteristics of the property the customer is looking for +
+ +**:information_source: Note:**
+ +* `NAME` can be alphanumeric with spaces but cannot start with a space. +
+ Examples: * `addcust n/Tim Cook p/91234567 e/cook@apple.com b/2500000 c/bright c/sunny` * `addcust n/Phoebe p/87654321 e/pb@gmail.com b/200000 c/bright c/sunny c/white` @@ -241,13 +253,13 @@ You should see the message in the [output box](#2-command-input-and-output-boxes **:information_source: Note:**
-* To ensure that your database remains neat, PropertyMatch will warn you when you try to add duplicate customers that have the same name. +* To ensure that your database remains neat, PropertyMatch will warn you when you try to add duplicate customers that have the same phone number. #### Adding a property: `addprop` -Adds a property to your application. +Adds a property and the respective contact details of the homeowner and information about the property to PropertyMatch's property address book. Format: `addprop n/NAME a/ADDRESS p/PHONE_NUMBER pr/PRICE [c/CHARACTERISTIC]…​` @@ -258,6 +270,13 @@ Format: `addprop n/NAME a/ADDRESS p/PHONE_NUMBER pr/PRICE [c/CHARACTERISTIC]… * `pr/PRICE` : Price of the property * `c/CHARACTERISTIC` (Optional) : Characteristics of the property +
+ +**:information_source: Note:**
+ +* `NAME` can be alphanumeric with symbols but cannot start with a space. +
+ Examples: * `addprop n/Aqua Heights a/195 Paya Lebar 3 #18-32 p/91135235 pr/700000` * `addprop n/Skyview a/214 Clementi Ave 2 #09-78 p/98835235 pr/500000 c/bright c/sunny c/big c/square` @@ -274,13 +293,16 @@ You should get a result similar to adding customers when the property is success
**:information_source: Note:**
-* Similar to adding a customer, PropertyMatch will warn you when you try to add duplicate customers that have the name. +* PropertyMatch will warn you when you try to add a duplicate property that has the same address as an existing property in the address book.
### List Commands + [Back to Table of Contents](#table-of-contents) +Want to see all your customers and property details all at one go? Read the follow section to find out more about our `list` feature. +
**:bulb: Tip:**
@@ -290,7 +312,7 @@ You should get a result similar to adding customers when the property is success #### Listing all customers: `listcust` -Updates the [Customer List](#3-customer-list) to show all customers in your database. +Updates the [Customer List](#3-customer-list) to show all customers in your database for ease of viewing. Format: `listcust` @@ -299,7 +321,7 @@ No additional parameters are needed for this command, and they will be ignored i #### Listing all properties: `listprop` -Updates the [Property List](#4-property-list) to show all properties in your database. +Updates the [Property List](#4-property-list) to show all properties in your database for ease of viewing. Format: `listprop` @@ -308,6 +330,9 @@ No additional parameters are needed for this command, and they will be ignored i ### Delete Commands [Back to Table of Contents](#table-of-contents) + +Already made a sale and want to remove a customer or property's details? Read the follow section to find out more about our `delete feature. + #### Deleting a customer: `delcust` Deletes the specified customer and their corresponding details from your database. @@ -344,6 +369,9 @@ The result will be similar to deleting customers when the property is successful ### Edit Commands [Back to Table of Contents](#table-of-contents) + +Customer or property details might change after some time and this is where our `edit` can come in handy! Read the follow section to find out more about our `edit` feature. + #### Editing a customer: `editcust` Edits the details of your customer. @@ -406,19 +434,23 @@ Successfully editing your property would produce a similar result as editing a c ### Find Commands [Back to Table of Contents](#table-of-contents) + +Can't seem to find the customer or property you are looking for? Read the follow section to find out more about our `find` feature. + #### Finding a customer: `findcust` -Finds and returns a customer or a list of customers, from all your customers whose name contains the substring inputted. +Finds and returns a customer or a list of customers, from all your customers whose name contains words that begin with the substring inputted. Format: `findcust NAME` -* Finds and returns the customer(s) whose names begins with the `NAME` substring at any position within their name. +* Finds and returns the customer or customers whose name contains any word that begins with the `NAME` substring. * The `NAME` must be in the same language as the name, i.e English. -* The `NAME` should only contain the relevant alphabets +* The `NAME` should only contain the relevant alphabets. +* The `NAME` should not contain any numbers or symbols. Examples: -* `list` followed by `findcust F` finds and returns the customer(s) whose names begin with "F" at any position within their name in the customer list. -* `list` followed by `findcust B D` finds and returns the customer(s) whose names begin with "B" or "D" at any position within their name in the customer list. +* `list` followed by `findcust F` finds and returns the customer or customers whose names contains any word that starts with `F` in the customer list, such as `Fredy Lawrence` or `Sara Foo`. +* `list` followed by `findcust B D` finds and returns the customer or customers whose names contains any word that starts with `B` and/or `D` in the customer list, such as `Doraemon`, `Boraemon`,`Sara Doo`, `Sara Boo`, or `Bara Doo`. You should see the message in the [output box](#2-command-input-and-output-boxes) as below when you have successfully found your customers. @@ -429,23 +461,27 @@ When `findcust B D` is entered. #### Finding a property: `findprop` -Finds and returns a property or a list of properties, from all your properties whose name contains the substring inputted. +Finds and returns a property or a list of properties, from all your properties whose name contains words that begin with the substring inputted. Format: `findprop NAME` -* Finds and returns the property or properties whose name contains the `NAME` substring. +* Finds and returns the property or properties whose name contains any word that begins with the `NAME` substring. * The `NAME` must be in the same language as the name, i.e English. -* The `NAME` should only contain the relevant alphabets +* The `NAME` should only contain the relevant alphabets. +* The `NAME` should not contain any numbers or symbols. Examples: -* `list` followed by `findprop F` finds and returns the property or properties with names that begin with "F" in the property list. -* `list` followed by `findprop F J` finds and returns the property or properties with names that begin with "F" or "J" in the property list. +* `list` followed by `findprop F` finds and returns the property or properties with names that begin with "F" in the property list, such as `Fernvale Square` or `Dairy Farm`. +* `list` followed by `findprop F J` finds and returns the property or properties with names that begin with "F" or "J" in the property list, such as `Fernvale Square`, `Dairy Farm`, `Jden` or `Changi Jail`. Successfully finding the property you want would produce a similar result as finding a customer! ### Filter Commands [Back to Table of Contents](#table-of-contents) + +Want to only see selected customers or properties? Read the follow section to find out more about our `filter` feature. + #### Filter customers: `filtercust` Filters all your customers to only show customers that fit the criteria. @@ -513,6 +549,8 @@ Successfully filtering your properties would produce a similar result as filteri ### Match Commands [Back to Table of Contents](#table-of-contents) +Ready to match customers and properties? Our unique matching feature has the power to match customers and properties easily! Read the follow section to find out more about our `match` feature. +
**:bulb: Tip:**
@@ -557,7 +595,11 @@ Examples: Matching your properties successfully will output a similar message as matching your customers. ### General Features + [Back to Table of Contents](#table-of-contents) + +Want to start fresh and clear all your existing data? Exit the application? Or in need of assistance? Read the follow section to find out more about our `clear`, `exit` and `help` feature. + #### Clear the data in the application: `clear` Resets all data in the application. (i.e. Deletes all entries in your Customer List and Property List) @@ -632,6 +674,13 @@ PropertyMatch's data is saved as 2 separate JSON files `[JAR file location]/data **Q**: Do I need an active internet connection to use PropertyMatch?
**A**: No, PropertyMatch is a standalone application that does not require an internet connection to function. However, you'll need an internet connection to download it to your machine. +**Q**: I can't find what i need...
+**A**: The guide is divided into sections for easy navigation. Use the table of contents to locate what you are looking for. + +**Q**: How do I open Terminal?
+**A**: If you are a Windows user, press the Windows key + R to open the Run window, then type wt and click OK.
+If you are using a Mac, click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal. + -------------------------------------------------------------------------------------------------------------------- ## Known issues @@ -650,7 +699,7 @@ PropertyMatch's data is saved as 2 separate JSON files `[JAR file location]/data | **[Add property](#adding-a-property-addprop)** | `addprop n/NAME a/ADDRESS [c/CHARACTERISTIC]…​ p/PHONE_NUMBER pr/PRICE`
e.g., `addprop n/Aqua Heights a/195 Paya Lebar 3 #18-32 p/91135235 pr/700000` | | **[List customers](#listing-all-properties-listprop)** | `listcust` | | **[List properties](#listing-all-customers-listcust)** | `listprop` | - | + | | **[Delete customer](#deleting-a-customer-delcust)** | `delcust INDEX`
e.g., `delcust 3` | | **[Delete property](#deleting-a-property-delprop)** | `delprop INDEX`
e.g., `delprop 3` | | **[Edit customer](#editing-a-customer-editcust)** | `editcust INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [b/BUDGET] [c/CHARACTERISTIC]…​`
e.g., `editcust 1 p/91234567 e/andrew@gmail.com` | From 08ebaff91a9897fe7ac715f87872210616584f2d Mon Sep 17 00:00:00 2001 From: nicolengk Date: Fri, 10 Nov 2023 13:58:57 +0800 Subject: [PATCH 2/2] Fix ug formatting --- docs/UserGuide.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3edb9b20e02..d515db84661 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -118,9 +118,11 @@ that make up this window. ![UserInterface](images/user-guide/UserInterface.png) ### 1. Menu Bar + The Menu Bar is your command center, allowing you to exit the application and look for the link to our user guide. ### 2. Command Input and Output Boxes + These boxes are located at the top section of the window.

![CommandBox](images/user-guide/CommandBox.png)

The **command input box** is located where the placeholder text `Enter command here...` is.
@@ -154,6 +156,7 @@ Here are some commands you can test to start with. You can refer to the [Features](#features) below for the details of each command. ### 3. Customer List + You can find the customer list located at the left section of the window.



The customer list displays information regarding customers who are currently stored in PropertyMatch's database. @@ -163,6 +166,7 @@ Note that it might not be showing *all* the customers in the database all the ti You can also filter and modify the customer list using the commands given in the [Features](#features) section below. ### 4. Property List + You can find the property list located at the right section of the window.



The property list displays information regarding properties that are currently stored in PropertyMatch's database. @@ -172,6 +176,7 @@ Note that it might not be showing *all* the properties in the database all the t You can also filter and modify the property list using the commands given in the [Features](#features) section below. ### 5. Help Window + This will appear as a separate window. ![Help Window](images/user-guide/HelpWindow.png) The __help window__ displays a link to PropertyMatch's User Guide, which is the online version of this document. :) @@ -209,7 +214,6 @@ If you just want a quick summary of all the feature PropertyMatch has, do take a
### Add Commands - [Back to Table of Contents](#table-of-contents) Ready to start adding customer and properties into PropertyMatch? Read the follow section to find out more about our `add` feature. @@ -298,7 +302,6 @@ You should get a result similar to adding customers when the property is success ### List Commands - [Back to Table of Contents](#table-of-contents) Want to see all your customers and property details all at one go? Read the follow section to find out more about our `list` feature. @@ -406,7 +409,6 @@ When `editcust 1 n/Andrew c/` is entered #### Editing a property: `editprop` - Edits the details of your property. Format: `editprop INDEX [n/NAME] [p/PHONE] [pr/PRICE] [a/ADDRESS] [c/CHARACTERISTIC]…​` @@ -679,7 +681,9 @@ PropertyMatch's data is saved as 2 separate JSON files `[JAR file location]/data **Q**: How do I open Terminal?
**A**: If you are a Windows user, press the Windows key + R to open the Run window, then type wt and click OK.
-If you are using a Mac, click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal. +If you are using a Mac, click the Launchpad icon in the Dock, type Terminal in the search field, then click Terminal.
+If you are using a Linux system, press Ctrl + Alt + T key to open up Terminal. + --------------------------------------------------------------------------------------------------------------------