diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 16126e1fb230..f1fb7f514a58 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -57,6 +57,15 @@ It should start in a few seconds and begin the initialization set-up. If you need the full list of available commands and their associated details, please proceed to <>! == Commands and Features +*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. + +* Parameters can be in any order e.g. if the command specifies `n/NAME ic/NRIC dob/DATE_OF_BIRTH`, +`dob/DATE_OF_BIRTH n/NAME ic/NRIC ` is also acceptable. === Breakdown of attributes used within TeethHub [cols=",,,", options="header",] @@ -97,7 +106,7 @@ You can use *Import* to add select patients from another patient list to your cu + You can use *Export* to save select patients to a .json or .pdf file. -==== Open +==== open Opens the file in the specified file path and overwrites the current patients list. ** Note that 'open' always searches inside the data folder. ** You can only open .json files. @@ -113,7 +122,7 @@ Replaces the current patients list with the patients list in "patients1.json". Replaces the current patients list with the patients list in "patients2.json" found in the "february" folder. -==== Save +==== save Saves the current patients list to the specified filepath. ** Note that 'save' always saves inside the data folder. If no such filepath exists, it will be created. Otherwise, it will overwrite the existing file. @@ -132,7 +141,7 @@ Saves the current patients list to "patients1.json". Saves the current patients list to "patients2.json" found in the "february" folder. -==== Import +==== import Opens the file in the specified file path and adds the specified patients to the patients list. ** Note that 'import' always searches inside the data folder. ** You can only import .json files. @@ -157,7 +166,7 @@ Adds patient 1 to patient 4 from "patients1.json" to the current patients list. Adds patient 1 and patient 3 to patient 5 from "patients1.json" to the current patients list. -==== Export +==== export Saves the specified patients in the current patients list to the specified filepath. ** Note that 'export' always saves inside the data folder. If no such filepath exists, it will be created. Otherwise, it will overwrite the existing file. @@ -455,7 +464,7 @@ The commands listed below deal with displaying and finding data for you to view. They do not deal with the adding or modification of any information currently already stored within the program. -==== List +==== list Shows a list of all patients or medical stored in TeethHub. Format: `list [dental]` @@ -472,7 +481,7 @@ Shows details of all patients. Shows details of patient's dental records. -==== Find +==== find Shows patients whose data contains any of the given keywords according to a specified parameter. Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]` @@ -493,7 +502,7 @@ Show all the people with an address containing the keyword Yishun. Shows all the dental records with cleaning -==== Sort +==== sort Sorts the records by an input parameter in an input order. Format: `sort PARAM ORDER` @@ -532,19 +541,19 @@ Example: |2 |Bob |24 |11/02/2019 |=== -==== Stat +==== stat Generates a statistics report based on the specified patient's data. Format: `stat INDEX` -=== History +=== history Lists all the commands that have been entered since starting the application in reverse chronological order. Format: `history` -=== Undo +=== undo Undo the latest command. Format: `undo` @@ -569,7 +578,7 @@ previously. `undo` (reverses the clear command) + `undo` (reverses the delete 1 command) -=== Redo +=== redo Reverses the most recent undo command. Format: `redo` @@ -592,7 +601,7 @@ previously. `redo` (reapplies the delete 1 command) + `redo` (reapplies the clear command) -=== Clear +=== clear Clears all patients and records from TeethHub. * You will be prompted to confirm. @@ -600,12 +609,12 @@ Clears all patients and records from TeethHub. Format: `clear` -=== Exit +=== exit Exits the program. You won't be able to exit if copies exist. Format: `exit` -=== Exit anyway +=== exit anyway Exits the program, disregarding any copies. Format: `exit!`