Skip to content

Commit

Permalink
Merge pull request #340 from yanghengtang/branch-Update-UserGuide
Browse files Browse the repository at this point in the history
Add page break for UG
  • Loading branch information
derekjxtan authored Nov 14, 2023
2 parents 032cd99 + b9f8ffb commit e467b9f
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ Here are some common terms used throughout this user guide.
| MAX_INT | Integer value 2147483647 |
| Command Terminal | A window into which users can type commands that are then executed by their computer's operating system |

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

## Navigating this user guide

As this guide aims to be as comprehensive as possible, you might find the amount of information in this user guide overwhelming.
Expand Down Expand Up @@ -95,6 +97,8 @@ Back to [Table of Contents](#table-of-contents).
The commands you give should look similar to what is shown below:
![Terminal](images/terminalcommand.png)

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

A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
![Ui](images/Ui.png)

Expand Down Expand Up @@ -273,6 +277,8 @@ Below is an example of a successful view command call.

Back to [Patient Management Features](#patient-management-features).

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

### Editing a patient : `edit_p`

Allows you to edit an existing patient in the system. This is useful to correct any mistakes made when adding or updating a patient.
Expand Down Expand Up @@ -311,6 +317,8 @@ Edited Patient: Jonathan Reese; Phone: 81453894; NRIC: S8712461K

Back to [Patient Management Features](#patient-management-features).

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

### Locating patients by name : `find_p`

Allows you to find patients whose name contains any of the given keywords.
Expand Down Expand Up @@ -352,6 +360,8 @@ If a patient is removed, the appointments of the patient will be deleted too!

Back to [Patient Management Features](#patient-management-features).

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

### Adding a medical condition to a patient : `add_tag_p`

Allows you to add a medical condition to a specified patient in the system.
Expand Down Expand Up @@ -389,6 +399,8 @@ Allows you to delete a medical condition from a specified patient in the system.

Back to [Patient Management Features](#patient-management-features).

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

### Editing the remark of a patient : `remark_p`

Allows you to edit the remark of a specified patient in the system. The patient's remark can be used to store temporary information such as family health history and current medications/treatments the patient is on.
Expand Down Expand Up @@ -461,6 +473,8 @@ New doctor added: John Doe; Nric: T0212385J

Back to [Doctor Management Features](#doctor-management-features).

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

### Listing all doctors : `list_d`

Allows you to list all the doctors in the system.
Expand Down Expand Up @@ -488,12 +502,16 @@ Allows you to view details, such as basic information, specialisation, and remar
* Entering `list_d` followed by `view_d 2` shows the details of the 2nd doctor in the doctor list.
* Entering `find_d Jonathan` followed by `view_d 1` shows the details of the 1st doctor in the resultant doctor list of the `find_d` command.

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

Below is an example of a successful view command call.

![ViewDoctorMainWindow](images/view-doctor.png)

Back to [Doctor Management Features](#doctor-management-features).

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

### Editing a doctor : `edit_d`

Allows you to edit an existing doctor in the system. This is useful to correct any mistakes made when adding or updating a doctor.
Expand Down Expand Up @@ -531,6 +549,8 @@ Edited Doctor: Joe Ng; Nric: T0212385J

Back to [Doctor Management Features](#doctor-management-features).

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

### Locating doctors by name : `find_d`

Allows you to locate doctors whose name contains any of the given keywords.
Expand Down Expand Up @@ -571,6 +591,8 @@ If a doctor is removed, the appointments of the doctor will be deleted too!

Back to [Doctor Management Features](#doctor-management-features).

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

### Adding a specialisation to a doctor : `add_tag_d`

Allows you to add a specialisation to a specified doctor in the system.
Expand Down Expand Up @@ -608,6 +630,8 @@ Allows you to delete a specialisation from a specific doctor in the system.

Back to [Doctor Management Features](#doctor-management-features).

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

### Editing the remark of a doctor : `remark_d`

Allows you to edit the remark of a specified doctor in the system. The doctor's remark is usually used to indicate the doctor's availability.
Expand Down Expand Up @@ -698,6 +722,8 @@ Allows you to either display all the appointments in the system or the list of a

Back to [Appointment Management Features](#appointment-management-features).

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

### Editing an appointment : `edit_a`

Allows you to edit an existing appointment in the system. This is useful to correct any mistakes made when adding or updating an appointment.
Expand Down Expand Up @@ -735,6 +761,8 @@ If you edit the patient or doctor NRIC of an appointment, ensure that there exis

Back to [Appointment Management Features](#appointment-management-features).

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

### Viewing details of an appointment : `view_a`

Allows you to view details, such as basic information, prescription given, and remark, of a specific appointment in the system.
Expand All @@ -759,6 +787,8 @@ Below is the image of a successful result that you should have encountered.

Back to [Appointment Management Features](#appointment-management-features).

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

### Deleting an appointment : `delete_a`

Allows you to delete the specified appointment from the system.
Expand Down Expand Up @@ -793,6 +823,8 @@ Allows you to add a prescription for an appointment in the system.

Back to [Appointment Management Features](#appointment-management-features).

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

### Deleting a prescription from an appointment : `delete_tag_a`

Allows you to delete a prescription from an appointment in the system.
Expand Down Expand Up @@ -872,6 +904,8 @@ MediConnect data are saved in the hard disk automatically after any command. The

Back to [General Features](#general-features).

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

### Editing the data file

MediConnect data are saved automatically as a JSON file `[JAR file location]/data/database.json`. Advanced users are welcome to update data directly by editing that data file.
Expand Down

0 comments on commit e467b9f

Please sign in to comment.