diff --git a/docs/UserGuide.md b/docs/UserGuide.md index ae96213b53f..b58b5c9e63d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -12,6 +12,9 @@ PatientSync is a **desktop app made for nurses to manage patient, optimized for +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ## Quick start @@ -42,6 +45,9 @@ command to run the application.
1. Refer to the [Features](#features) below for details of each command. +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ## Features @@ -81,6 +87,9 @@ Shows a message explaning how to access the help page. Format: `help` +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Adding a patient: `add` @@ -111,6 +120,9 @@ Examples: ![result for 'adding patient John Doe'](images/addPatientResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Listing all patients : `list` @@ -121,6 +133,9 @@ Format: `list` ![result for 'listing all patients'](images/listResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Editing a patient : `edit` @@ -149,6 +164,9 @@ Examples: ![result for 'edit patient'](images/editPatientResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Locating patients by name: `find` @@ -171,6 +189,9 @@ Examples: ![result for 'find patients whose name is alex ali'](images/findPatientAlexAliResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Deleting a patient : `delete` @@ -189,6 +210,9 @@ Examples: ![result for 'delete 2'](images/deletePatientResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Adding Tags to a Patient : `addt` @@ -219,6 +243,9 @@ Examples: ![result for 'add tags'](images/addTagsResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Deleting Tags from a Patient : `deletet` @@ -244,6 +271,9 @@ Examples: ![result for 'delete tags'](images/deleteTagsResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Locating patients by tag: `findt` @@ -266,6 +296,9 @@ Examples: ![result for 'find tags'](images/findTagsResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Adding an Event to a Patient : `adde` @@ -289,6 +322,9 @@ Examples: ![result for 'add event'](images/addEventResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Deleting an Event from a Patient : `deletee` @@ -311,6 +347,9 @@ Examples: ![result for 'delete event'](images/deleteEventResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Editing an Event for a Patient: `edite` @@ -339,6 +378,9 @@ Examples: ![result for 'edit event'](images/editEventResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Sorting the patient list : `sort` @@ -366,6 +408,9 @@ Examples: ![result for 'sort'](images/sortResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Clearing all entries : `clear` @@ -376,6 +421,9 @@ Format: `clear` ![result for 'clear'](images/clearResult.png) +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ### Exiting the program : `exit` @@ -416,6 +464,9 @@ Furthermore, certain edits can cause PatientSync to behave in unexpected ways (e 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. +-------------------------------------------------------------------------------------------------------------------- +
+ -------------------------------------------------------------------------------------------------------------------- ## Command summary diff --git a/docs/images/addPatientResult.png b/docs/images/addPatientResult.png index 0b826222d4b..4af6c4425b4 100644 Binary files a/docs/images/addPatientResult.png and b/docs/images/addPatientResult.png differ