Merge branch 'master' into branch-updateUserGuide

# Conflicts: # docs/UserGuide.md
Kappaccinoh · Apr 13, 2024 · 910b3fa · 910b3fa
2 parents 90634f0 + 86eac61
commit 910b3fa
Show file tree

Hide file tree

Showing 72 changed files with 799 additions and 420 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
@@ -2,7 +2,7 @@
 layout: default
 ---
 <article class="post">
-
+  <img id="logo" src="images/medicli_logo.png" alt="MediCLI Logo" width="100">
   <header class="post-header">
     <h1 class="post-title">{{ page.title | escape }}</h1>
   </header>

diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -10,3 +10,17 @@
     height: 21px;
     width: 21px
 }
+
+h2, h3 {
+  font-weight: bold;
+  color: #257ec7;
+}
+
+.post-title {
+  color: #257ec7;
+  font-weight: bold;
+}
+
+#logo {
+  margin-bottom: 15px;
+}
diff --git a/docs/diagrams/DeleteAppointmentActivityDiagram.puml b/docs/diagrams/DeleteAppointmentActivityDiagram.puml
@@ -4,7 +4,7 @@ skinparam ActivityFontSize 15
 skinparam ArrowFontSize 12
 
 start
-:User enters command to appointment;
+:User enters command to delete appointment;
 
 if () then ([command is invalid])
     :Show error message\nfor invalid command;

diff --git a/docs/diagrams/EditAppointmentActivityDiagram.puml b/docs/diagrams/EditAppointmentActivityDiagram.puml
@@ -0,0 +1,26 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to edit appointment;
+
+if () then ([command is invalid])
+    :Show error message\nfor invalid command;
+else ([else])
+    if () then ([missing required fields])
+        :Show error message\nfor missing required fields;
+    else ([else])
+        if () then ([Invalid appointment index detected])
+            :Show error message\nindicating invalid Appointment index;
+            else ([else])
+                 :edit appointment\nin the appointment list;
+                 :Update the 'appointment' panel\nin the GUI;
+                 :Show success message\nwith edited appointment information;
+        endif;
+    endif
+endif
+
+stop
+@enduml
diff --git a/docs/diagrams/EditAppointmentSequenceDiagram.puml b/docs/diagrams/EditAppointmentSequenceDiagram.puml
@@ -0,0 +1,65 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":EditAppointmentCommandParser" as EditAppointmentCommandParser LOGIC_COLOR
+participant "e:EditAppointmentCommand" as EditAppointmentCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("editappt i/...")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("editappt i/...")
+activate AddressBookParser
+
+create EditAppointmentCommandParser
+AddressBookParser -> EditAppointmentCommandParser
+activate EditAppointmentCommandParser
+
+create EditAppointmentCommand
+EditAppointmentCommandParser -> EditAppointmentCommand : : parse("editappt i/...")
+activate EditAppointmentCommand
+
+EditAppointmentCommand --> EditAppointmentCommandParser
+deactivate EditAppointmentCommand
+
+EditAppointmentCommandParser --> AddressBookParser
+deactivate EditAppointmentCommandParser
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditAppointmentCommandParser -[hidden]-> AddressBookParser
+destroy EditAppointmentCommandParser
+
+AddressBookParser --> LogicManager
+deactivate AddressBookParser
+
+LogicManager -> EditAppointmentCommand : execute()
+activate EditAppointmentCommand
+
+EditAppointmentCommand -> Model : setAppointment(toEdit)
+activate Model
+
+Model --> EditAppointmentCommand
+deactivate Model
+
+create CommandResult
+EditAppointmentCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> EditAppointmentCommand : result
+deactivate CommandResult
+
+EditAppointmentCommand --> LogicManager : result
+deactivate EditAppointmentCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/EditPersonActivityDiagram.puml b/docs/diagrams/EditPersonActivityDiagram.puml
@@ -0,0 +1,26 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to edit doctor or patient;
+
+if () then ([command is invalid])
+    :Show error message\nfor invalid command;
+else ([else])
+    if () then ([missing required fields])
+        :Show error message\nfor missing required fields;
+    else ([else])
+        if () then ([Invalid person index detected])
+            :Show error message\nindicating invalid Person index;
+            else ([else])
+                 :Edit patient/doctor\nfrom the persons list\nalso updates any appointments\nassociated with the edited patient/doctor;
+                 :Update the 'person' panel\nand appointments panel\n in the GUI;
+                 :Show success message\nwith edited doctor/patient information;
+        endif;
+    endif
+endif
+
+stop
+@enduml
diff --git a/docs/diagrams/EditPersonSequenceDiagram.puml b/docs/diagrams/EditPersonSequenceDiagram.puml
@@ -0,0 +1,65 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":EditCommandParser" as EditCommandParser LOGIC_COLOR
+participant "e:EditCommand" as EditCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("edit i/...")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("edit i/...")
+activate AddressBookParser
+
+create EditCommandParser
+AddressBookParser -> EditCommandParser
+activate EditCommandParser
+
+create EditCommand
+EditCommandParser -> EditCommand : : parse("edit i/...")
+activate EditCommand
+
+EditCommand --> EditCommandParser
+deactivate EditCommand
+
+EditCommandParser --> AddressBookParser
+deactivate EditCommandParser
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditCommandParser -[hidden]-> AddressBookParser
+destroy EditCommandParser
+
+AddressBookParser --> LogicManager
+deactivate AddressBookParser
+
+LogicManager -> EditCommand : execute()
+activate EditCommand
+
+EditCommand -> Model : setPerson(toEdit)
+activate Model
+
+Model --> EditCommand
+deactivate Model
+
+create CommandResult
+EditCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> EditCommand : result
+deactivate CommandResult
+
+EditCommand --> LogicManager : result
+deactivate EditCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/FindActivityDiagram.puml b/docs/diagrams/FindActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to query a person,\nthe person can be either a doctor or patient.;
+
+
+if () then ([missing required fields])
+    :Show error message\nfor missing required fields;
+else ([else])
+    :Search the person from person list;
+    :Update the 'person' panel\nin the GUI to display the list;
+    :Show success message\nwith found person(s) information;
+endif
+
+
+stop
+@enduml
diff --git a/docs/diagrams/FindPersonSequenceDiagram.puml b/docs/diagrams/FindPersonSequenceDiagram.puml
@@ -0,0 +1,65 @@
+@startuml
+!include style.puml
+skinparam ArrowFontStyle plain
+
+box Logic LOGIC_COLOR_T1
+participant ":LogicManager" as LogicManager LOGIC_COLOR
+participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
+participant ":FindCommandParser" as FindCommandParser LOGIC_COLOR
+participant "e:FindCommand" as FindCommand LOGIC_COLOR
+participant ":CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("find ...")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("find ...")
+activate AddressBookParser
+
+create FindCommandParser
+AddressBookParser -> FindCommandParser
+activate FindCommandParser
+
+create FindCommand
+FindCommandParser -> FindCommand : : parse("find ...")
+activate FindCommand
+
+FindCommand --> FindCommandParser
+deactivate FindCommand
+
+FindCommandParser --> AddressBookParser
+deactivate FindCommandParser
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+FindCommandParser -[hidden]-> AddressBookParser
+destroy FindCommandParser
+
+AddressBookParser --> LogicManager
+deactivate AddressBookParser
+
+LogicManager -> FindCommand : execute()
+activate FindCommand
+
+FindCommand -> Model : find(person)
+activate Model
+
+Model --> FindCommand
+deactivate Model
+
+create CommandResult
+FindCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> FindCommand : result
+deactivate CommandResult
+
+FindCommand --> LogicManager : result
+deactivate FindCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml
diff --git a/docs/diagrams/QueryDoctorActivityDiagram.puml b/docs/diagrams/QueryDoctorActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to query doctor(s);
+
+
+if () then ([missing required fields])
+    :Show error message\nfor missing required fields;
+else ([else])
+    :Search doctor(s) from person list;
+    :Update the 'person' panel\nin the GUI to display the list;
+    :Show success message\nwith queried doctor(s) information;
+endif
+
+
+stop
+@enduml
diff --git a/docs/diagrams/QueryDoctorAppointmentActivityDiagram.puml b/docs/diagrams/QueryDoctorAppointmentActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to query appointment with the associated doctor;
+
+
+if () then ([missing required fields])
+    :Show error message\nfor missing required fields;
+else ([else])
+    :Search Appointments(s) from person list;
+    :Update the 'appointment' panel\nin the GUI to display the list;
+    :Show success message\nwith queried appointment information;
+endif
+
+
+stop
+@enduml
diff --git a/docs/diagrams/QueryPatientActivityDiagram.puml b/docs/diagrams/QueryPatientActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to query patient(s);
+
+
+if () then ([missing required fields])
+    :Show error message\nfor missing required fields;
+else ([else])
+    :Search patient(s) from person list;
+    :Update the 'person' panel\nin the GUI to display the list;
+    :Show success message\nwith queried patient(s) information;
+endif
+
+
+stop
+@enduml
diff --git a/docs/diagrams/QueryPatientAppointmentActivityDiagram.puml b/docs/diagrams/QueryPatientAppointmentActivityDiagram.puml
@@ -0,0 +1,20 @@
+@startuml
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+
+start
+:User enters command to query appointments with associated patient;
+
+
+if () then ([missing required fields])
+    :Show error message\nfor missing required fields;
+else ([else])
+    :Search Appointment(s) from appointment list;
+    :Update the 'appointment' panel\nin the GUI to display the list;
+    :Show success message\nwith queried appointment information;
+endif
+
+
+stop
+@enduml
diff --git a/docs/images/EditAppointmentActivityDiagram.png b/docs/images/EditAppointmentActivityDiagram.png
diff --git a/docs/images/EditAppointmentSequenceDiagram.png b/docs/images/EditAppointmentSequenceDiagram.png
diff --git a/docs/images/EditPersonActivityDiagram.png b/docs/images/EditPersonActivityDiagram.png
diff --git a/docs/images/EditPersonSequenceDiagram.png b/docs/images/EditPersonSequenceDiagram.png
diff --git a/docs/images/FindActivityDiagram.png b/docs/images/FindActivityDiagram.png
diff --git a/docs/images/FindPersonSequenceDiagram.png b/docs/images/FindPersonSequenceDiagram.png
diff --git a/docs/images/GUI.png b/docs/images/GUI.png
diff --git a/docs/images/InitialState.png b/docs/images/InitialState.png
diff --git a/docs/images/QueryDoctorActivityDiagram.png b/docs/images/QueryDoctorActivityDiagram.png
diff --git a/docs/images/QueryDoctorAppointmentActivityDiagram.png b/docs/images/QueryDoctorAppointmentActivityDiagram.png
diff --git a/docs/images/QueryPatientActivityDiagram.png b/docs/images/QueryPatientActivityDiagram.png
diff --git a/docs/images/QueryPatientAppointmentActivityDiagram.png b/docs/images/QueryPatientAppointmentActivityDiagram.png
diff --git a/docs/images/WindowsStartup.png b/docs/images/WindowsStartup.png
diff --git a/docs/images/addAppointment.png b/docs/images/addAppointment.png
diff --git a/docs/images/addDoctor.png b/docs/images/addDoctor.png
diff --git a/docs/images/addPatient.png b/docs/images/addPatient.png
diff --git a/docs/images/clear.png b/docs/images/clear.png
diff --git a/docs/images/cli_format.png b/docs/images/cli_format.png
diff --git a/docs/images/deleteApptFinalState.png b/docs/images/deleteApptFinalState.png
diff --git a/docs/images/deleteApptInitialState.png b/docs/images/deleteApptInitialState.png
diff --git a/docs/images/deletePatient.png b/docs/images/deletePatient.png
diff --git a/docs/images/deletePerson.png b/docs/images/deletePerson.png
diff --git a/docs/images/editAppointment.png b/docs/images/editAppointment.png
diff --git a/docs/images/editPerson.png b/docs/images/editPerson.png
diff --git a/docs/images/findAppointmentInitialDoctor.png b/docs/images/findAppointmentInitialDoctor.png
diff --git a/docs/images/findAppointmentInitialPatient.png b/docs/images/findAppointmentInitialPatient.png
diff --git a/docs/images/findAppointmentResultDoctor.png b/docs/images/findAppointmentResultDoctor.png
diff --git a/docs/images/findAppointmentResultPatient.png b/docs/images/findAppointmentResultPatient.png
diff --git a/docs/images/findDoctor.png b/docs/images/findDoctor.png
diff --git a/docs/images/findPatient.png b/docs/images/findPatient.png
diff --git a/docs/images/macOSStartup.png b/docs/images/macOSStartup.png
diff --git a/docs/images/medicli_logo.png b/docs/images/medicli_logo.png