diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 92c0a21d83d8..f833c09c5d1e 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -17,10 +17,13 @@ By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` == Introduction -Medeina is for Veterinarians and their assistants who *prefer to use a desktop app for managing contacts and appointments*. More importantly, Medeina is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Medeina can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the <> to get started. Enjoy! +Medeina is for Veterinarians and their assistants who *prefer to use a desktop app for managing contacts and appointments*. More importantly, Medeina is *optimized for those who prefer to work with a Command Line Interface* (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Medeina can get your contact management tasks done faster than traditional GUI apps. +This User Guide is made to help you get familiar with Medeina's set-up and its various features. Interested? Jump to the <> to get started. Enjoy! == Quick Start +To successsfully install and run Medeina, you need to: + . Ensure you have Java version `1.8.0_60` or later installed in your Computer. + [NOTE] @@ -48,7 +51,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. == Features ==== -*Command Format* +*The following is the command format :* * Words in `UPPER_CASE` are the parameters to be supplied by the user e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. * Items in square brackets are optional e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. @@ -59,12 +62,12 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window. === Viewing help : `help` or `h` -Format: `help` or `h` +The command format to bring up help page is: `help` or `h` === Adding new owner + pet patient + appointment : `add` or `a` To add a new owner, new pet patient and new appointment to Mediena: + -Format: `add **-o** n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS nr/NRIC [t/TAG]... +The command format should be: `add **-o** n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS nr/NRIC [t/TAG]... **-p** n/PET_PATIENT_NAME s/SPECIES b/BREED c/COLOUR bt/BLOOD_TYPE [t/TAG]... **-a** d/DATE r/REMARK [t/TYPE OF APPOINTMENT]...` @@ -78,17 +81,17 @@ Examples: === Listing all persons : `list` or `ls` -Shows a list of all persons in Medeina's address book. + -Format: `list` or `ls` +To show a list of all persons in Medeina's address book. + +The command format should be: `list` or `ls` === Editing a person : `edit` or `ed` -Edits an existing person in Medeina's address book. + -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nr/NRIC] [t/TAG]...` + -or `ed INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nr/NRIC] [t/TAG]... +To edit an existing person in Medeina's address book. + +The command format should be: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nr/NRIC] [t/TAG]...` + +or `ed INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nr/NRIC] [t/TAG]...` **** -* Edits the person at the specified `INDEX`. The index refers to the index number shown in the last person listing. The index *must be a positive integer* 1, 2, 3, ... +* The command edits the person at the specified `INDEX`. The index refers to the index number shown in the last person listing. The index *must be a positive integer* 1, 2, 3, ... * At least one of the optional fields must be provided. * Existing values will be updated to the input values. * When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. @@ -97,15 +100,16 @@ or `ed INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nr/NRIC] [t/TAG]... Examples: -* `edit 1 p/91234567 e/johndoe@example.com` + -Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. -* `edit 2 n/Betsy Crower t/` or `e 2 n/Betsy Crower t/` + -Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. +* Type in `edit 1 p/91234567 e/johndoe@example.com` + +Medeina will edit the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. + +* Type in `edit 2 n/Betsy Crower t/` or `e 2 n/Betsy Crower t/` + +Medeina will edit the name of the 2nd person to be `Betsy Crower` and clears all existing tags. === Locating persons by name: `find` or `f` -Finds persons whose names contain any of the given keywords. + -Format: `find KEYWORD [MORE_KEYWORDS]` or `f KEYWORD [MORE_KEYWORDS]` +To find persons whose names contain any of the given keywords. + +The command format should be: `find KEYWORD [MORE_KEYWORDS]` or `f KEYWORD [MORE_KEYWORDS]` **** * The search is case insensitive. e.g `hans` will match `Hans` @@ -117,55 +121,58 @@ Format: `find KEYWORD [MORE_KEYWORDS]` or `f KEYWORD [MORE_KEYWORDS]` Examples: -* `f John` + -Returns `john` and `John Doe` -* `find Betsy Tim John` + -Returns any person having names `Betsy`, `Tim`, or `John` +* Type in `f John` + +Medeina will return `john` and `John Doe` + +* Type in `find Betsy Tim John` + +Medeina will return any person having names `Betsy`, `Tim`, or `John` === Deleting a person : `delete` or `d` -Deletes the specified person from Medeina's address book. + -Format: `delete INDEX` or `d INDEX` +To delete the specified person from Medeina's address book. + +The command format should be: `delete INDEX` or `d INDEX` **** -* Deletes the person at the specified `INDEX`. +* The command deletes the person at the specified `INDEX`. * The index refers to the index number shown in the most recent listing. * The index *must be a positive integer* 1, 2, 3, ... **** Examples: -* `list` + +* Type in `list` + `delete 2` + -Deletes the 2nd person in Medeina's address book. -* `find Betsy` + +Medeina will deletes the 2nd person in Medeina's address book. + +* Type in `find Betsy` + `d 1` + -Deletes the 1st person in the results of the `find` command. +Medeina will delete the 1st person in the results of the `find` command. === Selecting a person : `select` or `s` -Selects the person identified by the index number used in the last person listing. + -Format: `select INDEX` or `s INDEX` +To select the person identified by the index number used in the last person listing. + +The command format should be: `select INDEX` or `s INDEX` **** -* Selects the person and loads the Google search page the person at the specified `INDEX`. +* The command selects the person and loads the Google search page the person at the specified `INDEX`. * The index refers to the index number shown in the most recent listing. * The index *must be a positive integer* `1, 2, 3, ...` **** Examples: -* `list` + +* Type in `list` + `select 2` + -Selects the 2nd person in Medeina's address book. -* `find Betsy` + +Medeina will select the 2nd person in Medeina's address book. + +* Type in `find Betsy` + `s 1` + -Selects the 1st person in the results of the `find` command. +Medeina will select the 1st person in the results of the `find` command. === Listing entered commands : `history` or `his` -Lists all the commands that you have entered in reverse chronological order. + -Format: `history` or `his` +To list all the commands that you have entered in reverse chronological order. + +The command format should be: `history` or `his` [NOTE] ==== @@ -175,8 +182,8 @@ Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and // tag::undoredo[] === Undoing previous command : `undo` or `ud` -Restores Medeina to the state before the previous _undoable_ command was executed. + -Format: `undo` or `ud` +To restore Medeina to the state before the previous _undoable_ command was executed. + +The command format should be: `undo` or `ud` [NOTE] ==== @@ -185,52 +192,52 @@ Undoable commands: those commands that modify Medeina's content (`add`, `delete` Examples: -* `delete 1` + +* Type in `delete 1` + `list` + -`ud` (reverses the `delete 1` command) + +`ud` (The command will reverses the `delete 1` command) + -* `select 1` + +* Type in `select 1` + `list` + `undo` + The `undo` command fails as there are no undoable commands executed previously. -* `delete 1` + +* Type in `delete 1` + `clear` + -`undo` (reverses the `clear` command) + -`ud` (reverses the `delete 1` command) + +`undo` (The command reverses the `clear` command) + +`ud` (The command reverses the `delete 1` command) + === Redoing the previously undone command : `redo` or `rd` -Reverses the most recent `undo` command. + -Format: `redo` or `rd` +To reverse the most recent `undo` command. + +The command format should be: `redo` or `rd` Examples: -* `delete 1` + -`undo` (reverses the `delete 1` command) + -`redo` (reapplies the `delete 1` command) + +* Type in `delete 1` + +`undo` (The command reverses the `delete 1` command) + +`redo` (The command reapplies the `delete 1` command) + -* `delete 1` + +* Type in `delete 1` + `redo` + The `redo` command fails as there are no `undo` commands executed previously. -* `delete 1` + +* Type in `delete 1` + `clear` + -`ud` (reverses the `clear` command) + -`ud` (reverses the `delete 1` command) + -`rd` (reapplies the `delete 1` command) + -`rd` (reapplies the `clear` command) + +`ud` (The command reverses the `clear` command) + +`ud` (The command reverses the `delete 1` command) + +`rd` (The command reapplies the `delete 1` command) + +`rd` (The command reapplies the `clear` command) + // end::undoredo[] === Clearing all entries : `clear` or `cls` -Clears all entries from Medeina's address book. + -Format: `clear` or `cls` +To clear all entries from Medeina's address book. + +The command format should be: `clear` or `cls` === Changing theme : `theme` or `t` -Change Medeina's current theme to another pre-loaded theme. + -Format: `theme THEME_NAME` or `t THEME_NAME` +To change Medeina's current theme to another pre-loaded theme. + +The command format should be: `theme THEME_NAME` or `t THEME_NAME` **** * THEME_NAME is case insensitive. e.g `DARK` will match `dark` @@ -239,13 +246,17 @@ Format: `theme THEME_NAME` or `t THEME_NAME` Examples: -* `theme dark` -* `t light` +* Type in `theme dark` + +Medeina will change to dark theme. + +* Type in `t light` + +Medeina will change to light theme. === Exiting the program : `exit` or `q` -Exits the program. + -Format: `exit` or `q` +To exit the program. + +The command format should be: `exit` or `q` + === Saving the data @@ -284,6 +295,8 @@ and their assistants to access Medeina simultaneously in different rooms. == Command Summary +The following is a summary of all commands available in Medeina: + * *Add* `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...` + or `a n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]...` + e.g. `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` +