diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 0f8e72efdc5..2a395aff05d 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -4,12 +4,16 @@
pageNav: 3
---
-# RTPM User Guide
+# **RTPM User Guide**
+
+
-
+
+
RealtorTrackerPlusMax (RTPM) is the hottest new computer app
for realtors. RTPM allows you to manage your clients, optimized for use via a
@@ -17,7 +21,7 @@ Command Line Interface (CLI), aimed at maximising your speed in entering data.
Whether you are learning how to get into the real estate industry, or looking for a simple and free app
to get rid of your cluttered spreadsheets, RTPM is for you!
---------------------------------------------------------------------------------------------------------------------
+
## Contents
@@ -74,8 +78,9 @@ to get rid of your cluttered spreadsheets, RTPM is for you!
A display similar to the below should appear in a few seconds. If you are starting the app for the first time,
there will be some sample data loaded.
-
+
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.
@@ -114,6 +119,10 @@ Note that backslashes need to be repeated twice.
+
+
+--------------------------------------------------------------------------------------------------------------------
+
## Features
Here are some things regarding RTPM's features to take note of before using them.
@@ -138,7 +147,9 @@ Here are some things regarding RTPM's features to take note of before using them
* The order in which you input data is not fixed by RTPM.
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
-* All commands and prefixes ignore case. parameters however, are case-sensitive.
+
+
+* All commands and prefixes ignore case. Parameters however, are case-sensitive.
e.g. if the command specifies `buyer n/NAME`, `BUYER N/NAME` is also acceptable.
* Extra parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
@@ -147,8 +158,10 @@ Here are some things regarding RTPM's features to take note of before using them
* 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.
+
+
+
-
@@ -172,11 +185,10 @@ Here are some things regarding RTPM's features to take note of before using them
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
---------------------------------------------------------------------------------------------------------------------
@@ -233,7 +245,7 @@ Example: buyer n/John Doe p/98765432 e/johnd@example.com ah/311, Clementi Ave 2,
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -242,7 +254,7 @@ Example: buyer n/John Doe p/98765432 e/johnd@example.com ah/311, Clementi Ave 2,
-### Adding a seller : `seller`
+### Adding a seller: `seller`
Similar to [`buyer`](#adding-a-buyer-buyer),
the `seller` command allows you to add clients who have homes to sell.
@@ -282,7 +294,7 @@ Example: seller n/Ryan p/91234567 e/ryan@gmail.com ah/My Secret Home as/47D Lor
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -342,7 +354,7 @@ Parameters: INDEX (must be a positive integer) [n/NAME] [p/PHONE] [e/EMAIL] [ah/
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -394,7 +406,7 @@ Parameters: INDEX (must be a positive integer) [n/NAME] [p/PHONE] [e/EMAIL] [ah/
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -441,7 +453,7 @@ Example: bdelete 1
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -482,6 +494,7 @@ Example: sdelete 1
>The seller index provided is higher than the last number in the list!
+
--------------------------------------------------------------------------------------------------------------------
### Clearing all entries : `clear`
@@ -499,7 +512,7 @@ Expected output when the command succeeds:
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -550,6 +563,15 @@ Jane Doe; Phone: 91234567; Email: something@else.com; Address: 1 Co
+
+
+[Back to top](#contents)
+
+
+
+
+
+
Possible invalid inputs & their corresponding error messages:
@@ -563,18 +585,11 @@ Parameters: INDEX PRIORITY
-
-
-[Back to top](#rtpm-user-guide)
-
-
-
-
-
-
+--------------------------------------------------------------------------------------------------------------------
+
### Setting a seller's priority: `sprio`
@@ -593,8 +608,20 @@ Format: `sprio INDEX PRIORITY`
Example: `sprio 3 high`
+
+
+
+[Back to top](#contents)
+
+
+
+
+
+
+
+
**Note:**
* `PRIORITY` only considers the first letter of the input (`h` for high, `m` for medium, `l` for low, or `n` for nil). For example, `bprio 3 hlow` sets the priority of buyer 3 to high.
* Any extra inputs given after `PRIORITY` will be ignored. For example, `bprio 3 high low` is equivalent to `bprio 3 high`.
@@ -624,7 +651,7 @@ Parameters: INDEX PRIORITY
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -685,29 +712,20 @@ If you don't put any keywords to filter for:
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
-
### Listing all buyers and sellers: `list`
-The `list` command allows you to display the full updated lists, so that you can get back to work after using the `filter` command or editing the data file directly.
+The `list` command allows you to display all buyers and sellers, so that you can get back to work after using the `filter` command or editing the data file directly.
Format: `list`
-
-
-Expected outputs when the command succeeds:
-
->Listed all buyers and sellers!
-
-
-
--------------------------------------------------------------------------------------------------------------------
### Displaying a buyer from buyer list: `blist`
@@ -728,11 +746,8 @@ Jane Doe; Phone: 91234567; Email: janedoe@gmail.com; Address: 1 Col
-
+--------------------------------------------------------------------------------------------------------------------
-[Back to top](#rtpm-user-guide)
-
-
### Displaying a seller from seller list: `slist`
@@ -754,7 +769,7 @@ Ryan; Phone: 91234567; Email: ryan@gmail.com; Address: My Secret Ho
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -795,6 +810,7 @@ Expected outputs when the command succeeds:
+
Expected outputs when the command fails:
@@ -811,6 +827,16 @@ Example: bsort prio/d
+
+
+
+[Back to top](#contents)
+
+
+
+
+
+
**Note:**
@@ -825,14 +851,7 @@ valid prefix (`n`, `ah`, `i` or `prio`).
-
-
-[Back to top](#rtpm-user-guide)
-
-
-
-
-
+--------------------------------------------------------------------------------------------------------------------
### Sorting sellers: `ssort`
@@ -860,6 +879,18 @@ Examples:
* `ssort` to sort by default
* `ssort n/d` to sort by name descending
+
+
+
+
+
+[Back to top](#contents)
+
+
+
+
+
+
Expected outputs when the command succeeds:
@@ -868,6 +899,7 @@ Expected outputs when the command succeeds:
+
Expected outputs when the command fails:
@@ -898,7 +930,7 @@ Example: ssort prio/d
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -969,7 +1001,7 @@ If there is no command to redo:
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -1027,22 +1059,33 @@ and type in the `java -jar rtpm.jar`command to run the application.
**Q**: How do I install Java 11?
**A**: Try installing from the official Oracle archive [here](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html).
+
+
+[Back to top](#contents)
+
+
+
+
+
+
**Q**: I still have issues!
**A**: Try contacting our developer team by creating an issue on our
[GitHub](https://github.com/AY2324S1-CS2103T-F11-3/tp/issues), and we will see how we can help.
+
+
--------------------------------------------------------------------------------------------------------------------
## 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.
-2. Adding multiple contacts with excessively long names (>5000 characters) may cause RTPM to lag significantly. It is recommended to use nicknames or initials if necessary.
+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.
+2. Adding multiple contacts with excessively long names (>5000 characters) may cause RTPM to lag significantly. It is recommended to use nicknames or initials if necessary.
3. Long fields can cause the details of a client to not be displayed fully. A workaround is to use the
-```slist```/```blist``` commands to display the details of the client in the result box.
+```slist```/```blist``` commands to display the details of the client in the result box.
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -1079,7 +1122,7 @@ and type in the `java -jar rtpm.jar`command to run the application.
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -1132,7 +1175,7 @@ Please ignore if this is expected.
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -1153,7 +1196,7 @@ and the warning given if the field is inappropriate.
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
@@ -1195,10 +1238,13 @@ An example when the same name is detected:
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
+
+
+
## Appendix D: Definitions
Provided is a useful definition list of terms that were used in the guide and in the application.
@@ -1221,7 +1267,7 @@ In RTPM, you use this to interact with the internal logic.
-[Back to top](#rtpm-user-guide)
+[Back to top](#contents)
diff --git a/docs/images/startUi.PNG b/docs/images/startUi.PNG
new file mode 100644
index 00000000000..b4b7ec2f413
Binary files /dev/null and b/docs/images/startUi.PNG differ