### Exiting the program : `exit`
-Exits the program.
+Exits your PoochPlanner application.
Format: `/exit`
### Saving the data
-Data in PoochPlanner is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+Data in your PoochPlanner is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
### Editing the data file
-Data in PoochPlanner is saved automatically as a JSON file `[JAR file location]/data/poochplanner.json`. Advanced users are welcome to update data directly by editing that data file.
+Data in your PoochPlanner is saved automatically as a JSON file `[JAR file location]/data/poochplanner.json`. Advanced users are welcome to update data directly by editing their `poochplanner.json` file.
-
:exclamation: **Caution:**
+
:exclamation: **Caution:**
-Manually editing the JSON file is not advised and should be taken with extreme caution. If your changes to the data file makes its format invalid, PoochPlanner may discard all data and start with an empty data file on the next run. Hence, it is recommended to take a backup of the file before editing it.
-Furthermore, certain manual edits can cause the PoochPlanner to behave in unexpected ways (e.g., if a value entered lies outside the acceptable range).
+Manually editing the JSON file is not advised and should be taken with extreme caution. If your changes to the data file makes its format invalid, your PoochPlanner may discard all data and start with an empty data file on the next run. Hence, it is recommended to make a backup of the file before editing it.
+Furthermore, certain manual edits can cause your PoochPlanner to behave in unexpected ways (e.g., if a value entered lies outside its acceptable range).
--------------------------------------------------------------------------------------------------------------------
@@ -872,40 +887,39 @@ Furthermore, certain manual edits can cause the PoochPlanner to behave in unexpe
### Unknown Command
If you encounter an unknown command error, please ensure the command entered is a valid command mentioned
-in our feature list. Below is an example of an unknown command input and the corresponding error message.
+in our [Command Summary](#command-summary). Below is an example of an unknown command input and the corresponding error message.
-
Image depicting an unknown command with an unknown command error message.
+
Image depicting an unknown command with the unknown command error message.
### Invalid Field
-If you encounter an invalid field error, please ensure the field entered is a valid field for the command you
-are using. Below is an example of a command with an invalid field and the corresponding error message.
+If you encounter an invalid field error, please ensure that the field entered is a valid field for the command you
+are using. Refer to our [Command Summary](#command-summary) for a list of valid fields for each PoochPlanner command.
Below is an example of a command with an invalid field and the corresponding error message.
-
Image depicting a help command with an invalid field error message.
+
Image depicting a `help` command with its invalid field error message.
### Missing Field
-If you encounter a missing field error, please ensure the fields listed in the error message are present in your command input.
-Below is an example of a command with a missing field and the corresponding error message.
+If you encounter a missing field error, please ensure the fields listed in the error message are present in your command input. Refer to our [Command Summary](#command-summary) for a list of fields required for all PoochPlanner commands. Below is an example of a command with a missing field and the corresponding error message.
-
Image depicting a note command with a missing field error message.
+
Image depicting a `note` command with its missing field error message.
@@ -923,7 +937,7 @@ Below is an example of a command with a missing field and the corresponding erro
2. Navigate to the directory where the JAR file is located.
3. Enter `java -jar poochplanner.jar` and the PoochPlanner Application should launch.
-**Method 2**: Using `.bat/.sh` Scripts
+**Method 2**: Using `.bat`/`.sh` Scripts
1. Create a new text file and paste the following line into the file:
```
java -jar [JAR file location]/poochplanner.jar
@@ -941,13 +955,13 @@ Below is an example of a command with a missing field and the corresponding erro
### Loading Data from Another Computer
-**Q**: How can I transfer my PoochContacts to another computer?
-**A**: Install PoochPlanner in your target computer and overwrite the empty data file it creates with the file that contains the data of your previous poochplanner home folder by copying the contents of the `poochplanner.json` file from your current computer and pasting it inside the `poochplanner.json` file of your target computer.
+**Q**: How can I transfer my PoochPlanner contacts to another computer?
+**A**: Install PoochPlanner in your target computer and overwrite the empty data file it creates with the file that contains the data of your previous PoochPlanner home folder by copying the contents of the `poochplanner.json` file from your current computer and pasting it inside the `poochplanner.json` file of your target computer.
### Using PoochPlanner
**Q**: What are the available commands in PoochPlanner?
-**A**: Please refer to the [Command Summary](#command-summary) for the list of available commands.
+**A**: Please refer to our [Command Summary](#command-summary) for the list of available commands.
**Q**: Do I need an internet connection to use PoochPlanner?
**A**: All of PoochPlanner’s functionality can be used offline! No internet connection is required.
@@ -955,20 +969,20 @@ Below is an example of a command with a missing field and the corresponding erro
**Q**: How do I save my data?
**A**: Data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
-**Q**: If I have a lot of PoochContacts, is there a way for me to access my most frequently used PoochContacts easily?
-**A**: Yes! You may wish to make use of our `pin` feature, which keeps all of your pinned contacts at the very top of your PoochContact list, ensuring that you are always able to see them!
The syntax for the `pin` command is as follows:
+**Q**: If I have a lot of contacts, is there a way for me to access my most frequently used contacts easily?
+**A**: Yes! You may wish to keep your most important contacts at the top of your contacts list. With our `pin` feature, PoochPlanner ensures that you are always to see them!
The syntax for the `pin` command is as follows:
```
/pin ; name : [name]
```
-**Q**: How can I remove a PoochContact's rating?
-**A**: In PoochPlanner, a `0` rating corresponds to a non-rating (no rating is provided). Therefore, to remove a PoochContact's rating, simply give the target PoochContact a rating of `0`.
The syntax for the `rate` command is as follows:
+**Q**: How can I remove a contact's rating?
+**A**: In PoochPlanner, a `0` rating corresponds to a non-rating (no rating is provided). Therefore, to remove a contact's rating, simply give the target contact a rating of `0`.
The syntax for the `rate` command is as follows:
```
/rate ; name : [name] ; rating : [rating]
```
-**Q**: Can I append a note to a PoochContact when creating it?
-**A**: Yes you can! In fact, you may also rate PoochContacts at their time of creation. Simply enter their respective [prefixes](#prefix-summary) and you should be on your way!
+**Q**: Can I append a note to a contact when creating it?
+**A**: Yes you can! In fact, you may also rate a contact at its time of creation. Simply append the `; note :` prefix, and you should be on your way!
Example: Adding a new contact with a note and a rating
```
/add-person ; name : Pooch ; phone : 98883888 ; address : Pooch Street 32 ; email : impooch@gmail.com ; rating : 3 ; note : Hello my name is Pooch!
@@ -978,7 +992,7 @@ Example: Adding a new contact with a note and a rating
## 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.
+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 your PoochPlanner application before running PoochPlanner again.
--------------------------------------------------------------------------------------------------------------------
@@ -986,45 +1000,45 @@ Example: Adding a new contact with a note and a rating
A **prefix** is an integral construct of PoochPlanner's commands that allow PoochPlanner to uniquely identify contact fields.
-| Prefix | Field | Contact Type |
-|------------------|-------------------------------------------------------------|----------------|
-| `; name :` | Specifies the name of the PoochContact | All |
-| `; phone :` | Specifies the phone number of the PoochContact | All |
-| `; address :` | Specifies the addresss of the PoochContact | All |
-| `; email :` | Specifies the email address of the PoochContact | All |
-| `; note :` | Specifies the note appended to the PoochContact | All |
-| `; rating :` | Specifies the rating given to the PoochContact | All |
-| `; deadline :` | Specifies the deadline of note appended to the PoochContact | All |
-| `; command :` | Specifies the command type to give help for | All |
-| `; salary :` | Specifies the salary of the PoochContact | Staff |
-| `; employment :` | Specifies the employment of the PoochContact | Staff |
-| `; product :` | Specifies the product sold by the PoochContact | Supplier |
-| `; price :` | Specifies the price charged by the PoochContact | Supplier |
-| `; skill :` | Specifies the type of service offered by the PoochContact | Maintainer |
-| `; commission :` | Specifies the commission charged by the PoochContact | Maintainer |
+| Prefix | Field | Contact Type |
+|------------------|---------------------------------------------------------|----------------|
+| `; name :` | Specifies the name of the contact. | All |
+| `; phone :` | Specifies the phone number of the contact. | All |
+| `; address :` | Specifies the address of the contact. | All |
+| `; email :` | Specifies the email address of the contact. | All |
+| `; note :` | Specifies the note appended to the contact. | All |
+| `; rating :` | Specifies the rating given to the contact. | All |
+| `; deadline :` | Specifies the deadline of note appended to the contact. | All |
+| `; command :` | Specifies the command type to give help for. | All |
+| `; salary :` | Specifies the salary of the contact. | Staff |
+| `; employment :` | Specifies the employment of the contact. | Staff |
+| `; product :` | Specifies the product sold by the contact. | Supplier |
+| `; price :` | Specifies the price charged by the contact. | Supplier |
+| `; skill :` | Specifies the type of service offered by the contact. | Maintainer |
+| `; commission :` | Specifies the commission charged by the contact. | Maintainer |
## Command Summary
-| Action | Format and Example |
-|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Add General Contact** | Format :
`/add-person ; name : [name] ; phone : [phone] ; address : [address] ; email : [email]`
Example :
`/add-person ; name : Janna ; phone : 98765435 ; address : Poochie Street 24 ; email : iamjanna@gmail.com` |
-| **Add Staff** | Format :
`/add-staff ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; salary : [salary] ; employment : [part-time/full-time]`
Example :
`/add-staff ; name : Poochie ; phone : 98765435 ; address : Poochie Street 21 ; email : ilovecatstoo@gmail.com ; salary : $50/hr ; employment : part-time` |
-| **Add Supplier** | Format :
`/add-supplier ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; product : [product] ; price : [price]`
Example :
`/add-supplier ; name : PetCo ; phone : 98673098 ; address : Meow Street 24 ; email : ilovewombatstoo@gmail.com ; product : kibble ; price : $98/bag` |
-| **Add Maintainer** | Format :
`/add-maintainer ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; skill : [skill] ; commission : [commission]`
Example :
`/add-maintainer ; name : Tom Tan ; phone : 98765435 ; address : Poochie Street 24 ; email : ihelppooches@gmail.com ; skill : trainer ; commission : $60/hr` |
-| **Edit General Contact** | Format :
`/edit-person ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-person ; name : Poochie ; field : { address : Poochie Street 25 }` |
-| **Edit Staff** | Format :
`/edit-staff ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-staff ; name : Poochie ; field : { salary : $40/hr ; employment : part-time }` |
-| **Edit Supplier** | Format :
`/edit-supplier ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-supplier ; name : Poochie ; field : { product : kibble ; price : $75/bag }` |
-| **Edit Maintainer** | Format :
`/edit-maintainer ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-maintainer ; name : Poochie ; field : { commission : $10/hr }` |
-| **Delete** | Format :
`/delete ; name : [name] `
Example :
`/delete ; name : Poochie` |
-| **Search** | Format :
`/search ; target-field : [value]`
Example :
`/search ; name : Poochie` |
-| **List** | Format :
`/list`
Example :
`/list` |
-| **Help** | Format :
`/help ; command : [command type]`
Example :
`/help ; command : delete` |
-| **Rate** | Format :
`/rate ; name : [name] ; rating : [rating]`
Example :
`/rate ; name : Poochie ; rating : 5` |
-| **Undo** | Format :
`/undo`
Example :
`/undo` |
-| **Redo** | Format :
`/redo`
Example :
`/redo` |
-| **Pin** | Format :
`/pin ; name : [name]`
Example :
`/pin ; name : Poochie` |
-| **Unpin** | Format :
`/unpin ; name : [name]`
Example :
`/unpin ; name : Poochie` |
-| **Sort** | Format :
`/sort ; field : [target-field]`
Example :
`/sort ; field ; name` |
-| **Note** | Format :
`/note ; name : [name] ; note : [note]`
or
`/note ; name : [name] ; note : [note] ; deadline : [deadline]`
Example :
`/note ; name : Poochie ; note : get dog for groomers ; deadline : 2020-10-10` |
-| **Remind** | Format :
`/remind`
Example :
`/remind` |
-| **Exit** | Format :
`/exit`
Example :
`/exit` |
+| Action | Format and Example |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Add Person** | Format :
`/add-person ; name : [name] ; phone : [phone] ; address : [address] ; email : [email]`
Example :
`/add-person ; name : Janna ; phone : 98765435 ; address : Poochie Street 24 ; email : iamjanna@gmail.com` |
+| **Add Staff** | Format :
`/add-staff ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; salary : [salary] ; employment : [part-time/full-time]`
Example :
`/add-staff ; name : Poochie ; phone : 98765435 ; address : Poochie Street 21 ; email : ilovecatstoo@gmail.com ; salary : $50/hr ; employment : part-time` |
+| **Add Supplier** | Format :
`/add-supplier ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; product : [product] ; price : [price]`
Example :
`/add-supplier ; name : PetCo ; phone : 98673098 ; address : Meow Street 24 ; email : ilovewombatstoo@gmail.com ; product : kibble ; price : $98/bag` |
+| **Add Maintainer** | Format :
`/add-maintainer ; name : [name] ; phone : [phone] ; address : [address] ; email : [email] ; skill : [skill] ; commission : [commission]`
Example :
`/add-maintainer ; name : Tom Tan ; phone : 98765435 ; address : Poochie Street 24 ; email : ihelppooches@gmail.com ; skill : trainer ; commission : $60/hr` |
+| **Edit Person** | Format :
`/edit-person ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-person ; name : Poochie ; field : { address : Poochie Street 25 }` |
+| **Edit Staff** | Format :
`/edit-staff ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-staff ; name : Poochie ; field : { salary : $40/hr ; employment : part-time }` |
+| **Edit Supplier** | Format :
`/edit-supplier ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-supplier ; name : Poochie ; field : { product : kibble ; price : $75/bag }` |
+| **Edit Maintainer** | Format :
`/edit-maintainer ; name : [name] ; field : { target-field : [value] }`
Example :
`/edit-maintainer ; name : Poochie ; field : { commission : $10/hr }` |
+| **Delete** | Format :
`/delete ; name : [name] `
Example :
`/delete ; name : Poochie` |
+| **Search** | Format :
`/search ; target-field : [value]`
Example :
`/search ; name : Poochie` |
+| **List** | Format :
`/list`
Example :
`/list` |
+| **Help** | Format :
`/help ; command : [command type]`
Example :
`/help ; command : delete` |
+| **Rate** | Format :
`/rate ; name : [name] ; rating : [rating]`
Example :
`/rate ; name : Poochie ; rating : 5` |
+| **Undo** | Format :
`/undo`
Example :
`/undo` |
+| **Redo** | Format :
`/redo`
Example :
`/redo` |
+| **Pin** | Format :
`/pin ; name : [name]`
Example :
`/pin ; name : Poochie` |
+| **Unpin** | Format :
`/unpin ; name : [name]`
Example :
`/unpin ; name : Poochie` |
+| **Sort** | Format :
`/sort ; field : [target-field]`
Example :
`/sort ; field ; name` |
+| **Note** | Format :
`/note ; name : [name] ; note : [note]`
or
`/note ; name : [name] ; note : [note] ; deadline : [deadline]`
Example :
`/note ; name : Poochie ; note : get dog for groomers ; deadline : 2020-10-10` |
+| **Remind** | Format :
`/remind`
Example :
`/remind` |
+| **Exit** | Format :
`/exit`
Example :
`/exit` |
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-