-
Notifications
You must be signed in to change notification settings - Fork 581
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #251 from ruiyangzh/UG-Finalization
Rework output message examples
- Loading branch information
Showing
1 changed file
with
99 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,10 +6,15 @@ | |
|
|
||
| # RTPM User Guide | ||
|
|
||
| RealtorTrackerPlusMax (RTPM) is the hottest new desktop/laptop application | ||
| <div style="text-align:center;"> | ||
| <img src="images/Ui.png" alt="Ui" style="width:500px"/> | ||
| </div> | ||
|
|
||
|
|
||
| RealtorTrackerPlusMax (RTPM) is the hottest new computer app | ||
| for realtors. RTPM allows you to manage your clients, optimized for use via a | ||
| Command Line Interface (CLI) for easy and quick typing. Whether you are learning | ||
| how to get into the real estate industry or looking for a simple and free app | ||
| 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! | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
@@ -207,7 +212,7 @@ Example: | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I've added a buyer contact:<br> | ||
| Jane Doe; Phone: 91234567; Email: [email protected]; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: high; Tags: | ||
| Jane Doe; Phone: 91234567; Email: janedoe@<span></span>gmail.com; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: high; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -258,7 +263,7 @@ Example: `seller n/Ryan p/91234567 e/[email protected] ah/My Secret Home as/47D Lor | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I've added a seller contact:<br> | ||
| Ryan; Phone: 91234567; Email: [email protected]; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: high; Tags: | ||
| Ryan; Phone: 91234567; Email: ryan@<span></span>gmail.com; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: high; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -313,7 +318,7 @@ Example: `bedit 3 e/[email protected] ah/Residential Street` | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I've edited a buyer contact:<br> | ||
| Jane Doe; Phone: 91234567; Email: [email protected]; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| Jane Doe; Phone: 91234567; Email: something@<span></span>else.com; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -367,7 +372,7 @@ Example: `sedit 3 e/[email protected] ah/Residential Street` | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I've edited a seller contact:<br> | ||
| Ryan; Phone: 91234567; Email: [email protected]; Address: Another Place; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| Ryan; Phone: 91234567; Email: ryan@<span></span>gmail.com; Address: Another Place; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -416,7 +421,7 @@ Example: `bdelete 3` | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I’ve deleted a buyer contact:<br> | ||
| Jane Doe; Phone: 91234567; Email: [email protected]; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| Jane Doe; Phone: 91234567; Email: janedoe@<span></span>gmail.com; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -460,7 +465,7 @@ Example: `sdelete 3` | |
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. I’ve deleted a seller contact:<br> | ||
| Ryan; Phone: 91234567; Email: [email protected]; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| Ryan; Phone: 91234567; Email: ryan@<span></span>gmail.com; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -541,7 +546,7 @@ Example: `bprio 3 high` | |
| Expected output when the command succeeds: | ||
|
|
||
| >The buyer's priority level has been set:<br> | ||
| Jane Doe; Phone: 91234567; Email: [email protected]; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: high; Tags: | ||
| Jane Doe; Phone: 91234567; Email: something@<span></span>else.com; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: high; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -600,7 +605,7 @@ Example: `sprio 3 high` | |
| Expected output when the command succeeds: | ||
|
|
||
| >The seller's priority level has been set:<br> | ||
| Ryan; Phone: 91234567; Email: [email protected]; Address: Another Place; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: high; Tags: | ||
| Ryan; Phone: 91234567; Email: ryan@<span></span>gmail.com; Address: Another Place; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: high; Tags: | ||
| </box> | ||
|
|
||
|
|
@@ -659,10 +664,25 @@ Example: `filter John Doe` | |
|
|
||
| </box> | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| Expected output when the command succeeds: | ||
|
|
||
| <box type="success" seamless> | ||
|
|
||
| >1 buyer(s) and 0 seller(s) listed! | ||
| </box> | ||
|
|
||
| <box type="wrong" seamless> | ||
|
|
||
| If you don't put any keywords to filter for: | ||
|
|
||
| >Invalid command format! | ||
| >filter: Filters all buyers and sellers whose names contain any of the specified keywords (case-insensitive) and displays them as a list with index numbers. | ||
| >Parameters: KEYWORD [MORE_KEYWORDS]... | ||
| >Example: filter alice bob charlie | ||
| </box> | ||
|
|
||
| <div style='text-align: right;'> | ||
|
|
||
| [Back to top](#rtpm-user-guide) | ||
|
|
@@ -680,10 +700,14 @@ The `list` command allows you to display the full updated lists, so that you can | |
|
|
||
| Format: `list` | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected outputs when the command succeeds: | ||
|
|
||
| >Listed all buyers and sellers! | ||
| </box> | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ### Displaying a buyer from buyer list: `blist` | ||
|
|
@@ -695,10 +719,14 @@ Format: `blist INDEX` | |
|
|
||
| Example: `blist 3` | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected output when the command succeeds: | ||
|
|
||
| >Got it. Here's the information of this buyer:<br> | ||
| Jane Doe; Phone: 91234567; Email: [email protected]; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| Jane Doe; Phone: 91234567; Email: janedoe@<span></span>gmail.com; Address: 1 College Ave East; House Info: Central Area 5 Room Condominium; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
| <div style='text-align: right;'> | ||
|
|
||
|
|
@@ -715,10 +743,14 @@ Format: `slist INDEX` | |
|
|
||
| Example: `slist 3` | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected outputs when the command succeeds: | ||
|
|
||
| >Got it. Here's the information of this seller:<br> | ||
| Ryan; Phone: 91234567; Email: [email protected]; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| Ryan; Phone: 91234567; Email: ryan@<span></span>gmail.com; Address: My Secret Home; Selling Address: 47D Lor Sarhad, Singapore 119164; House Info: 4 Room Flat in Sarhad Ville; Priority: nil; Tags: | ||
| </box> | ||
|
|
||
| <div style='text-align: right;'> | ||
|
|
||
|
|
@@ -755,19 +787,30 @@ Examples: | |
| * `bsort` to sort by original order | ||
| * `bsort n/d` to sort by name descending | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected outputs when the command succeeds: | ||
|
|
||
| >Got it. I've sorted the buyer list! | ||
| </box> | ||
|
|
||
| <box type="wrong" seamless> | ||
|
|
||
| Expected outputs when the command fails: | ||
|
|
||
| * If your command is not in the proper format: | ||
|
|
||
| Precise outputs when the command fails: | ||
| 1. For general errors: | ||
| >Invalid command format!<br> | ||
| bsort: Sorts the buyers in RTPM. Parameters: Choose zero or one of [n/] [ah/] [i/] [prio/] a/d (for ASC/DESC)<br> | ||
| Example: bsort prio/d | ||
| 2. When the same prefix is used more than once: | ||
|
|
||
| * If the same prefix is used more than once: | ||
|
|
||
| >Multiple values specified for the following single-valued field(s): ... | ||
| </box> | ||
|
|
||
| <box type="info"> | ||
|
|
||
| **Note:** | ||
|
|
@@ -817,19 +860,30 @@ Examples: | |
| * `ssort` to sort by default | ||
| * `ssort n/d` to sort by name descending | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected outputs when the command succeeds: | ||
|
|
||
| >Got it. I've sorted the seller list! | ||
| </box> | ||
|
|
||
| <box type="wrong" seamless> | ||
|
|
||
| Expected outputs when the command fails: | ||
|
|
||
| * If your command is not in the proper format: | ||
|
|
||
| Precise outputs when the command fails: | ||
| 1. For general errors: | ||
| >Invalid command format!<br> | ||
| ssort: Sorts the sellers in RTPM. Parameters: Choose zero or one of [n/] [ah/] [i/] [prio/] a/d (for ASC/DESC)<br> | ||
| Example: ssort prio/d | ||
| 2. When the same prefix is used more than once: | ||
| Example: ssort prio/d | ||
|
|
||
| * If the same prefix is used more than once: | ||
|
|
||
| >Multiple values specified for the following single-valued field(s): ... | ||
| </box> | ||
|
|
||
| <box type="info"> | ||
|
|
||
| **Note:** | ||
|
|
@@ -866,14 +920,22 @@ Format: `undo` | |
|
|
||
| </box> | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected output when the command succeeds: | ||
|
|
||
| >Last command was undone. | ||
| Precise outputs when the command fails: | ||
| </box> | ||
|
|
||
| <box type="wrong" seamless> | ||
|
|
||
| If there is no command to undo: | ||
|
|
||
| >No commands to undo! | ||
| </box> | ||
|
|
||
| -------------------------------------------------------------------------------------------------------------------- | ||
|
|
||
| ### Redoing previous action: `redo` | ||
|
|
@@ -889,14 +951,21 @@ Format : `redo` | |
|
|
||
| </box> | ||
|
|
||
| Precise outputs when the command succeeds: | ||
| <box type="success" seamless> | ||
|
|
||
| Expected output when the command succeeds: | ||
|
|
||
| >The next command was redone. | ||
| Precise outputs when the command fails: | ||
| </box> | ||
|
|
||
| <box type="wrong" seamless> | ||
|
|
||
| If there is no command to redo: | ||
|
|
||
| >No commands to redo! | ||
| </box> | ||
|
|
||
| <div style='text-align: right;'> | ||
|
|
||
|
|
||