Skip to content

Commit

Permalink
Merge pull request #174 from ZhiWei1010/v1.3-update-user-guide-for-fi…
Browse files Browse the repository at this point in the history 
…nal-release

Docs: Add manual page break for friendlier PDF version of UserGuide
  • Loading branch information
@choowengyan
choowengyan authored Apr 4, 2024
2 parents 38ab77c + 63f5823 commit 8f1ed15
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ PatientSync is a **desktop app made for nurses to manage patient, optimized for
<!-- * Table of Contents -->
<page-nav-print />

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

## Quick start
Expand Down Expand Up @@ -42,6 +45,9 @@ command to run the application.<br>

1. Refer to the [Features](#features) below for details of each command.

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

## Features
Expand Down Expand Up @@ -81,6 +87,9 @@ Shows a message explaning how to access the help page.

Format: `help`

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Adding a patient: `add`
Expand Down Expand Up @@ -111,6 +120,9 @@ Examples:

![result for 'adding patient John Doe'](images/addPatientResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Listing all patients : `list`
Expand All @@ -121,6 +133,9 @@ Format: `list`

![result for 'listing all patients'](images/listResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Editing a patient : `edit`
Expand Down Expand Up @@ -149,6 +164,9 @@ Examples:

![result for 'edit patient'](images/editPatientResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Locating patients by name: `find`
Expand All @@ -171,6 +189,9 @@ Examples:

![result for 'find patients whose name is alex ali'](images/findPatientAlexAliResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Deleting a patient : `delete`
Expand All @@ -189,6 +210,9 @@ Examples:

![result for 'delete 2'](images/deletePatientResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Adding Tags to a Patient : `addt`
Expand Down Expand Up @@ -219,6 +243,9 @@ Examples:

![result for 'add tags'](images/addTagsResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Deleting Tags from a Patient : `deletet`
Expand All @@ -244,6 +271,9 @@ Examples:

![result for 'delete tags'](images/deleteTagsResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Locating patients by tag: `findt`
Expand All @@ -266,6 +296,9 @@ Examples:

![result for 'find tags'](images/findTagsResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Adding an Event to a Patient : `adde`
Expand All @@ -289,6 +322,9 @@ Examples:

![result for 'add event'](images/addEventResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Deleting an Event from a Patient : `deletee`
Expand All @@ -311,6 +347,9 @@ Examples:

![result for 'delete event'](images/deleteEventResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Editing an Event for a Patient: `edite`
Expand Down Expand Up @@ -339,6 +378,9 @@ Examples:

![result for 'edit event'](images/editEventResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Sorting the patient list : `sort`
Expand Down Expand Up @@ -366,6 +408,9 @@ Examples:

![result for 'sort'](images/sortResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Clearing all entries : `clear`
Expand All @@ -376,6 +421,9 @@ Format: `clear`

![result for 'clear'](images/clearResult.png)

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

### Exiting the program : `exit`
Expand Down Expand Up @@ -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.

--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

--------------------------------------------------------------------------------------------------------------------

## Command summary
Expand Down
Binary file modified docs/images/addPatientResult.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8f1ed15

Please sign in to comment.