## Commands
+
+help
+
+
### Viewing help : `help`
Shows a message explaining how to access the help page.
@@ -140,6 +161,15 @@ Shows a message explaining how to access the help page.
Format: `help`
+
+
+
+---
+
+
+add
+
+
### Adding a booking: `add`
Adds a booking to the bookings book.
@@ -159,6 +189,15 @@ Examples:
* `add r/1 d/2023-01-01 08:00 to 2023-01-02 12:00 n/John Doe p/98765432 e/johnd@gmail.com`
* `add r/256 d/2023-02-01 15:00 to 2023-02-02 23:59 n/Betsy Crowe p/99990000 e/betsycrowe@gmail.com`
+
+
+
+---
+
+
+add: Potential Errors
+
+
:exclamation: **Caution:**
If your add command is missing one or more parameters except for a remark or has mutliple parameters which do not follow the parameter format, CheckMate will show the following error:
"Invalid command format!
@@ -194,6 +233,15 @@ If your add command only has the email parameter that does not match the email p
The domain name must end with a domain label that is supported:
- gmail, yahoo, outlook, hotmail, icloud"
+
+
+---
+
+
+list
+
+
### Listing all bookings : `list`
Shows a list of all bookings in the bookings book.
@@ -204,6 +252,15 @@ Format: `list`
* Example image above shows result of command `list`
+
+
+
+---
+
+
+edit
+
+
### Editing a booking : `edit`
Edits an existing booking in the bookings book.
@@ -226,6 +283,14 @@ The **edit** command makes use of the [Prefix Completion feature](#prefix-comple
Examples:
* `edit 1 p/91234567 e/johndoe@gmail.com` Edits the phone number and email of the 1st booking to be `91234567` and `johndoe@gmail.com` respectively.
+
+
+
+---
+
+
+edit: Potential Errors
+
:exclamation: **Caution:**
If your edit command contains an index which is 0 or a negative integer, CheckMate will show the following error:
@@ -242,6 +307,15 @@ If your edit command does not change any details of the target booking, CheckMat
"No changes made. At least one field to edit must be provided."
+
+
+
+---
+
+
+find
+
+
### Locating bookings by name or room: `find`
Finds bookings whose bookings contain the room, name, or both.
@@ -263,6 +337,15 @@ Examples:
* `find 1` returns the booking which contains the room `1`.
* `find john` returns the booking(s) where the name is `john`.
+
+
+
+---
+
+
+delete
+
+
### Deleting a booking : `delete`
Deletes the specified booking(s) from the bookings book.
@@ -282,6 +365,15 @@ Examples:
* `list` followed by `delete 2` deletes the 2nd booking in the bookingPeriod book.
* `find Betsy` followed by `delete 1` deletes the 1st booking in the results of the `find` command.
+
+
+
+---
+
+
+delete: Potential Errors
+
+
:exclamation: **Caution:**
If your delete command contains an index which is 0 or a negative integer, CheckMate will show the following error:
"Index should be a non-zero unsigned integer."
@@ -292,6 +384,15 @@ If your delete command contains an index which above the number largest index sh
"The booking index provided is invalid."
+
+
+---
+
+
+undo
+
+
### Undo a deletion : `undo`
Adds the most recently deleted booking back to the system.
@@ -304,11 +405,29 @@ Format: `undo`
* If the deleted item was manually added back, then undo was performed, the deleted booking will not be added as it
already exists in CheckMate which compares two bookings using their room number and booking period.
+
+
+
+---
+
+
+undo: Potential Errors
+
+
:exclamation: **Caution:**
If you input an undo command without previously having deleted a booking, CheckMate will show the following error:
"No deletions to undo."
+
+
+---
+
+
+clear
+
+
### Clearing all entries : `clear`
Clears all entries from the bookingPeriod book.
@@ -319,6 +438,15 @@ Format: `clear`
* Example image above shows the result of command `clear`
+
+
+
+---
+
+
+exit
+
+
### Exiting the program : `exit`
Exits the program.
@@ -327,10 +455,28 @@ Format: `exit`
* The window will close automatically on command `exit`
+
+
+
+---
+
+
+Saving the data
+
+
### Saving the data
CheckMate data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+
+
+
+---
+
+
+Editing the data file
+
+
### Editing the data file
CheckMate data are saved automatically as a JSON file `[JAR file location]/data/checkmate.json`. Advanced users are welcome to update data directly by editing that data file.
@@ -339,6 +485,15 @@ CheckMate data are saved automatically as a JSON file `[JAR file location]/data/
If your changes to the data file makes its format invalid, CheckMate will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
+