From 2c7ca78e1e97d60d39a006032f4e049643f3b78d Mon Sep 17 00:00:00 2001 From: cchj1995 Date: Mon, 25 Mar 2019 21:16:44 +0800 Subject: [PATCH 1/7] Updated UserGuide to include taskadd command --- docs/UserGuide.adoc | 87 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 3fe27542093e..8b6f22fcb223 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -431,6 +431,93 @@ newly created teeth layout. write a note describing more detail on the patient’s teeth health. +=== Task Management +==== Task Add +Adds a task to the application's list of tasks. + +Format: `taskadd PARAMETERS` + +You can specify information that describes the task you wish to add to the application by +keying in certain parameters after the `taskadd` command. + +Some parameters have specific patterns that should be followed when you include them. +Do note that some parameters are also mandatory when adding a task. Non-mandatory tasks will be assigned +a default value if you do not include them when adding the task. You can also <> the task afterwards if +needed. + +Table 1 shows the list of parameters along with their respective descriptions. +Mandatory parameters are marked with an asterisk `*` in the attribute section of the table. + +.Task parameters +|=== +|Attribute |Description |Tag |Example + +|Title* +|General description for the task to be added. + +You can provide any alphanumeric characters and the special characters: +`( ,@, !, ?, ., -` when giving the title for the task. Other characters not specified will not be allowed +due to security reasons. +|ti/TEXT +|ti/Tooth Extraction + +|Start date* +|The date in which the task is set to begin. + +You should provide the date in the format `DD-MM-YYYY` and should not be a date that is BEFORE the current date. +Invalid dates such as 33-02-1995 or 25-13-2020 for example, will also be rejected as these are invalid date values +|sd/DD-MM-YYYY +|sd/19-12-2019 + +|End date* +|The date in which the task is set to end. + +You should provide the date in the format `DD-MM-YYYY`, following standard date values should not be a date +that is BEFORE the current date OR the given START DATE. +Invalid dates such as 33-02-1995 or 25-13-2020 for example, will also be rejected as these are invalid date values. +|ed/DD-MM-YYYY +|ed/19-12-2019 + +|Start time* +|The specific time in which the task is set to begin. + +You should provide the time in the format `HHMM` (hours and minutes) and should also follow standard time values. +Invalid time values such as 2500 or 2388 will also be rejected as these are not valid time values. +|st/HHMM +|st/0845 + +|End time* +|The specific time in which the task is set to end + +You should provide the time in the format `HHMM` (hours and minutes) and should also follow standard time values. +If the task's start date and end date are the same, the end time should also not be BEFORE the start time. +Invalid time values such as 2500 or 2388 will also be rejected as these are not valid time values. +|et/HHMM +|et/1245 + +|Priority +|The priority level of the task to be performed + +You should provide the priority as `high`, `med` or `low` in either upper or lowercase. +Tasks with different priority will be marked with different colors on the task list. +High priority will be marked [red]#red#, Medium priority be marked [yellow]#yellow# and +Low priority will be marked [green]#green#. + +As the priority is not a mandatory parameter, if you do not specify a priority when you add a task, +it will be given a defualt priority of [green]#Medium# +|pi/PRIORITY +|pi/MED + +|Details +|The details of the task to be performed. You can add additional details regarding the task that might be too lengthy +to put in the title. +You can provide any alphanumeric characters and the special characters: +`( ,@, !, ?, ., -` when giving the title for the task. Other characters not specified will not be allowed +due to security reasons. +|det/TEXT +|det/Patient involved is Alex Yeoh, tools should be prepared 15 minutes in advance. + +|=== === List Shows a list of all patients or medical stored in TeethHub. From 689f1f1042495c721b47bfdd62060d0b34f94960 Mon Sep 17 00:00:00 2001 From: cchj1995 Date: Mon, 25 Mar 2019 21:56:59 +0800 Subject: [PATCH 2/7] Updated UserGuide to include taskdelete and taskedit usage details --- docs/UserGuide.adoc | 77 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 63 insertions(+), 14 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 8b6f22fcb223..d2276d6cf02f 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -432,18 +432,20 @@ write a note describing more detail on the patient’s teeth health. === Task Management -==== Task Add +==== taskadd Adds a task to the application's list of tasks. Format: `taskadd PARAMETERS` -You can specify information that describes the task you wish to add to the application by -keying in certain parameters after the `taskadd` command. +You can specify information that describes the task you wish to add by +keying in certain tags after the `taskadd` command. Do note the following: + +* All parameters have certain patterns that **MUST** be followed. + + +* Some parameters are mandatory when adding a task. + + +* Non-mandatory tasks will be assigned a default value if not specified -Some parameters have specific patterns that should be followed when you include them. -Do note that some parameters are also mandatory when adding a task. Non-mandatory tasks will be assigned -a default value if you do not include them when adding the task. You can also <> the task afterwards if -needed. Table 1 shows the list of parameters along with their respective descriptions. Mandatory parameters are marked with an asterisk `*` in the attribute section of the table. @@ -487,7 +489,7 @@ Invalid time values such as 2500 or 2388 will also be rejected as these are not |st/0845 |End time* -|The specific time in which the task is set to end +|The specific time in which the task is set to end. You should provide the time in the format `HHMM` (hours and minutes) and should also follow standard time values. If the task's start date and end date are the same, the end time should also not be BEFORE the start time. @@ -496,7 +498,7 @@ Invalid time values such as 2500 or 2388 will also be rejected as these are not |et/1245 |Priority -|The priority level of the task to be performed +|The priority level of the task to be performed. You should provide the priority as `high`, `med` or `low` in either upper or lowercase. Tasks with different priority will be marked with different colors on the task list. @@ -505,19 +507,66 @@ Low priority will be marked [green]#green#. As the priority is not a mandatory parameter, if you do not specify a priority when you add a task, it will be given a defualt priority of [green]#Medium# -|pi/PRIORITY -|pi/MED +|pri/PRIORITY +|pri/high |Details -|The details of the task to be performed. You can add additional details regarding the task that might be too lengthy -to put in the title. +|The details of the task to be performed. You can specify additional details about the task here. You can provide any alphanumeric characters and the special characters: `( ,@, !, ?, ., -` when giving the title for the task. Other characters not specified will not be allowed -due to security reasons. +due to security reasons. If not specified, the task will have no additional details. |det/TEXT |det/Patient involved is Alex Yeoh, tools should be prepared 15 minutes in advance. |=== + +Examples: + +* `taskadd ti/Teeth Filling for Alex sd/14-09-2019 ed/14-09-2019 st/1200 et/1300 pri/HIGH + det/Tooth 12 and 14 are to be filled. Perform a quick check-up prior to procedure.` + + +* `taskadd ti/Regular review of all patients' records sd/10-10-2019 ed/15-10-2019 st/1200 et/0800 pri/low` + +* `taskadd ti/Braces removal for Bernice sd/05-05-2020 ed/05-05-2020 st/1500 et/1600` + +==== taskedit +Edits a task currently stored in the application + +Format: `taskedit INDEX PARAMETERS` + +* Index of a task shown in the list **MUST** be specified + +* Index should be a positive integer (e.g. 1,2...5) +* Index of the tasks will be shown next to task's title in the task list +* Input tag of the field to modify followed by the new value to replace the old value +* Multiple fields can be provided in a single command and they will all be edited. +* Refer to *Table 1* in <> to see the fields that can be modified + along with their format and restrictions + +Examples: + +* `taskedit 1 ti/Tooth Extraction for Alex` + +* `taskedit 2 sd/15-09-2019 ed/15-09-2019 st/1400 et/1500` + +* `taskfind pri/high` + + `taskedit 1 ti/Braces removal for Bernice sd/05-05-2020 ed/05-05-2020 st/1500 et/1600 pri/MED` + + +==== taskdelete +Deletes a task from the task list + +Format: `taskdelete 2` + +* Index of a task shown in the list **MUST** be specified + +* Index should be a positive integer (e.g. 1,2...5) +* Index of the tasks will be shown next to task's title in the task list + +Example: + +* `taskdelete 1` +* `taskfind pri/low` + + `taskdelete 2` + === List Shows a list of all patients or medical stored in TeethHub. From af3b3d73c1337f1564fa7267374db2eca01f9913 Mon Sep 17 00:00:00 2001 From: cchj1995 Date: Mon, 25 Mar 2019 22:07:38 +0800 Subject: [PATCH 3/7] Re-arranged commands placement in UserGuide --- docs/UserGuide.adoc | 177 ++++++++++++++++++++++---------------------- 1 file changed, 90 insertions(+), 87 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index d2276d6cf02f..195f167e0c42 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -297,6 +297,85 @@ the current patient list with a copy tag. Makes 4 copies of the patient at index 3 and inserts them at the bottom of the current patient list with a copy tag. +==== list +Shows a list of all patients or medical stored in TeethHub. + +Format: `list [dental]` + +Command shows patient details by default, add dental to see dental +records. + +Example: + +* `list` + +Shows details of all patients. + + +* `list dental` + +Shows details of patient's dental records. + + +==== find +Shows patients whose data contains any of the given keywords according to a specified parameter. + +Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]` + +* Add “dental” to search dental records instead. +* Search is case insensitive. +* Order of keywords does not matter. + +Example: + + +* `find a/Yishun` + +Show all the people with an address containing the keyword Yishun. + + +* `find dental cleaning` + +Shows all the dental records with cleaning + + +==== sort +Sorts the records by an input parameter in an input order. + +Format: `sort PARAM ORDER` + +Example: + +[cols=",,,",options="header",] +|=== +|*ID* |*Name* |*Age* |*Last Modified* +|0 |Alice |19 |03/07/2003 +|1 |Clara |12 |05/02/2021 +|2 |Bob |24 |11/02/2019 +|=== + +* sort name desc + +[cols=",,,",options="header",] +|=== +|*ID* |*Name* |*Age* |*Last Modified* +|1 |Clara |12 |05/02/2021 +|2 |Bob |24 |11/02/2019 +|0 |Alice |19 |03/07/2003 +|=== + + +* sort age asce + +[cols=",,,",options="header",] +|=== +|*ID* |*Name* |*Age* |*Last Modified* +|1 |Clara |12 |05/02/2021 +|0 |Alice |19 |03/07/2003 +|2 |Bob |24 |11/02/2019 +|=== + +==== stat +Generates a statistics report based on the specified patient's data. + +Format: `stat INDEX` + === Patient Records Management ==== record add @@ -567,93 +646,16 @@ Example: * `taskfind pri/low` + `taskdelete 2` -=== List -Shows a list of all patients or medical stored in TeethHub. - -Format: `list [dental]` - -Command shows patient details by default, add dental to see dental -records. - -Example: - -* `list` + -Shows details of all patients. - - -* `list dental` + -Shows details of patient's dental records. - - -=== Find -Shows patients whose data contains any of the given keywords according to a specified parameter. - -Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]` - -* Add “dental” to search dental records instead. -* Search is case insensitive. -* Order of keywords does not matter. +=== General Commands -Example: - - -* `find a/Yishun` + -Show all the people with an address containing the keyword Yishun. - - -* `find dental cleaning` + -Shows all the dental records with cleaning - - -=== Sort -Sorts the records by an input parameter in an input order. - -Format: `sort PARAM ORDER` - -Example: - -[cols=",,,",options="header",] -|=== -|*ID* |*Name* |*Age* |*Last Modified* -|0 |Alice |19 |03/07/2003 -|1 |Clara |12 |05/02/2021 -|2 |Bob |24 |11/02/2019 -|=== - -* sort name desc - -[cols=",,,",options="header",] -|=== -|*ID* |*Name* |*Age* |*Last Modified* -|1 |Clara |12 |05/02/2021 -|2 |Bob |24 |11/02/2019 -|0 |Alice |19 |03/07/2003 -|=== - - -* sort age asce - -[cols=",,,",options="header",] -|=== -|*ID* |*Name* |*Age* |*Last Modified* -|1 |Clara |12 |05/02/2021 -|0 |Alice |19 |03/07/2003 -|2 |Bob |24 |11/02/2019 -|=== - -=== 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` @@ -678,7 +680,7 @@ previously. `undo` (reverses the clear command) + `undo` (reverses the delete 1 command) -=== Redo +==== redo Reverses the most recent undo command. Format: `redo` @@ -701,23 +703,24 @@ previously. `redo` (reapplies the delete 1 command) + `redo` (reapplies the clear command) -=== Clear -Clears all patients and records from TeethHub. +==== clear +Clears all patients, records and tasks from TeethHub. * You will be prompted to confirm. * Input `y` to proceed to the clear all records or `n` to abort. Format: `clear` -=== Exit +==== exit Exits the program. You won't be able to exit if copies exist. Format: `exit` -=== Exit anyway -Exits the program, disregarding any copies. +==== +You can also use `exit!` to forcefully exit the application +==== + -Format: `exit!` == Cloud Functionality [Coming in v2.0] To increase data redundancy and reduce the risk of data being lost, From 41201192e670d20822f0a9e306276e987753724b Mon Sep 17 00:00:00 2001 From: cchj1995 Date: Mon, 25 Mar 2019 22:22:15 +0800 Subject: [PATCH 4/7] Shifted General Commands to the top of Commands and Features in UserGuide --- docs/UserGuide.adoc | 177 +++++++++++++++++++++++--------------------- 1 file changed, 92 insertions(+), 85 deletions(-) diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index 195f167e0c42..011971078de5 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -57,13 +57,87 @@ 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 +=== General Commands + + -=== Help +==== help Displays the help text for all available commands. Format: `help` +==== history +Lists all the commands that have been entered since starting the +application in reverse chronological order. + +Format: `history` + +==== undo +Undo the latest command. + +Format: `undo` + +* The following commands are affected by undo: add edit delete and clear. + + +Examples: + +* `<> 1` + +`<>` + +`undo` (reverses the delete 1 command) + +* `<>` + +`undo` + +The undo command fails as there are no undo-able commands executed +previously. + + +* `<> 1` + +`<>` + +`undo` (reverses the clear command) + +`undo` (reverses the delete 1 command) + +==== redo +Reverses the most recent undo command. + +Format: `redo` + +Examples: + +* `<> 1` + +`<>` (reverses the delete 1 command) + +`redo` (reapplies the delete 1 command) + +* `<> 1` + +`redo` + +The redo command fails as there are no undo commands executed +previously. + +* `<> 1` + +`<> + +`<>` (reverses the clear command) + +`<>` (reverses the delete 1 command) + +`redo` (reapplies the delete 1 command) + +`redo` (reapplies the clear command) + +==== clear +Clears all patients, records and tasks from TeethHub. + +* You will be prompted to confirm. +* Input `y` to proceed to the clear all records or `n` to abort. + +Format: `clear` + +==== exit +Exits the program. You won't be able to exit if copies exist. + +Format: `exit` + +==== +You can also use `exit!` to forcefully exit the application +==== + === File Management TeethHub automatically saves all data in AddressBook.json when you close the program. @@ -78,7 +152,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. @@ -94,7 +168,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. @@ -113,7 +187,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. @@ -138,7 +212,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. @@ -646,82 +720,6 @@ Example: * `taskfind pri/low` + `taskdelete 2` -=== General Commands - -==== history -Lists all the commands that have been entered since starting the -application in reverse chronological order. - -Format: `history` - - -==== undo -Undo the latest command. - -Format: `undo` - -* The following commands are affected by undo: add edit delete and clear. - - -Examples: - -* `<> 1` + -`<>` + -`undo` (reverses the delete 1 command) - -* `<>` + -`undo` + -The undo command fails as there are no undo-able commands executed -previously. - - -* `<> 1` + -`<>` + -`undo` (reverses the clear command) + -`undo` (reverses the delete 1 command) - -==== redo -Reverses the most recent undo command. - -Format: `redo` - -Examples: - -* `<> 1` + -`<>` (reverses the delete 1 command) + -`redo` (reapplies the delete 1 command) - -* `<> 1` + -`redo` + -The redo command fails as there are no undo commands executed -previously. - -* `<> 1` + -`<> + -`<>` (reverses the clear command) + -`<>` (reverses the delete 1 command) + -`redo` (reapplies the delete 1 command) + -`redo` (reapplies the clear command) - -==== clear -Clears all patients, records and tasks from TeethHub. - -* You will be prompted to confirm. -* Input `y` to proceed to the clear all records or `n` to abort. - -Format: `clear` - -==== exit -Exits the program. You won't be able to exit if copies exist. - -Format: `exit` - -==== -You can also use `exit!` to forcefully exit the application -==== - - - == Cloud Functionality [Coming in v2.0] To increase data redundancy and reduce the risk of data being lost, you will be able to synchronise your data with a cloud account. @@ -795,13 +793,13 @@ det/Mouth was noticeably foul, might have halitosis` E.g. `record delete n/S1235467H 4` * *Record Edit* : `record edit n/NRIC INDEX` + -E.g. `record edit n/S1234657H 3 + +e.g. `record edit n/S1234657H 3 + doc/Debang + det/new details + Done` * *Record Copy* : `record copy n/NRIC INDEX` + -E.g. `record copy n/S1235467H 2` +e.g. `record copy n/S1235467H 2` * *Redo* : `redo` @@ -809,9 +807,18 @@ E.g. `record copy n/S1235467H 2` e.g. `save \mnt\clinicRecords.txt` * *Sort* : `sort PARAM ORDER` + -E.g. `sort name ascend` or `sort age descend` +e.g. `sort name ascend` or `sort age descend` + +* *Task Add*: `taskadd PARAM` + +e.g. `taskadd ti/Regular review of all patients' records sd/10-10-2019 ed/15-10-2019 st/1200 et/0800 pri/low` + +* *Task Edit*: `taskedit INDEX PARAM` + +e.g. `taskedit 1 ti/Tooth extraction for Alex pri/HIGH` + +* *Task Delete*: `taskdelete INDEX` + +e.g. `taskdelete 1` * *Teeth* : `teeth add