From 084668f9da0797ffdebb7332a386c697e697ad5c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 12:25:35 +0000 Subject: [PATCH] deploy: 57792850d42f61edfeeca56bab1346e646d15742 --- AboutUs.html | 2 +- AboutUs.page-vue-render.js | 2 +- Configuration.html | 2 +- Configuration.page-vue-render.js | 2 +- DevOps.html | 2 +- DevOps.page-vue-render.js | 2 +- DeveloperGuide.html | 6 ++++-- DeveloperGuide.page-vue-render.js | 9 ++++++--- Documentation.html | 2 +- Documentation.page-vue-render.js | 2 +- Logging.html | 2 +- Logging.page-vue-render.js | 2 +- SettingUp.html | 2 +- SettingUp.page-vue-render.js | 2 +- Testing.html | 2 +- Testing.page-vue-render.js | 2 +- UserGuide.html | 6 +++--- UserGuide.page-vue-render.js | 15 +++------------ index.html | 2 +- index.page-vue-render.js | 2 +- team/choiwab.html | 2 +- team/choiwab.page-vue-render.js | 2 +- team/jayjay19630.html | 2 +- team/jayjay19630.page-vue-render.js | 2 +- team/rxchell.html | 2 +- team/rxchell.page-vue-render.js | 2 +- team/vangmay.html | 2 +- team/vangmay.page-vue-render.js | 2 +- team/zaidansani.html | 2 +- team/zaidansani.page-vue-render.js | 2 +- 30 files changed, 42 insertions(+), 46 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index 100e5bfcd0d..af1937847de 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -23,7 +23,7 @@ [portfolio]

Rachel Tai

[github] [portfolio]

Jo An

[github] [email] -[portfolio]

+[portfolio]

diff --git a/AboutUs.page-vue-render.js b/AboutUs.page-vue-render.js index e29c1e5e8d8..be75d442c95 100644 --- a/AboutUs.page-vue-render.js +++ b/AboutUs.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"about-us"}},[_v("About Us"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#about-us","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We are a team based in the "),_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg"}},[_v("School of Computing, National University of Singapore")]),_v(".")]),_v(" "),_c('p',[_v("You can reach us at our individual emails below!")]),_v(" "),_c('h2',{attrs:{"id":"project-team"}},[_v("Project team"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-team","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"vangmay-sachan"}},[_v("Vangmay Sachan"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#vangmay-sachan","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/vangmay.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/vangmay"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/vangmay.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Quality Assurance")]),_v(" "),_c('li',[_v("Responsibilities: Logic")])]),_v(" "),_c('h3',{attrs:{"id":"muhammad-zaidan-bin-sani"}},[_v("Muhammad ZAIDAN bin Sani"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#muhammad-zaidan-bin-sani","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/zaidansani.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/zaidansani"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"mailto:zaidan@u.nus.edu"}},[_v("email")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/zaidansani.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Team Lead, Developer, Integration")]),_v(" "),_c('li',[_v("Responsibilities: Model")])]),_v(" "),_c('h3',{attrs:{"id":"jae-choi"}},[_v("Jae Choi"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jae-choi","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/choiwab.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/choiwab"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/choiwab.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Code quality")]),_v(" "),_c('li',[_v("Responsibilities: Storage")])]),_v(" "),_c('h3',{attrs:{"id":"rachel-tai"}},[_v("Rachel Tai"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#rachel-tai","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/rxchell.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/rxchell"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/rxchell.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Documentation")]),_v(" "),_c('li',[_v("Responsibilities: Commons")])]),_v(" "),_c('h3',{attrs:{"id":"jo-an"}},[_v("Jo An"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jo-an","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/jayjay19630.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/jayjay19630"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"mailto:jo.an@u.nus.edu"}},[_v("email")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/jayjay19630.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Roles: Developer, Deliverables and Deadlines, Scheduling and Tracking")]),_v(" "),_c('li',[_v("Responsibilities: UI")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index 95fe2525494..08008364123 100644 --- a/Configuration.html +++ b/Configuration.html @@ -16,7 +16,7 @@ Search

Configuration guide

Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: config.json).

+
  • About Us

    • Configuration guide

    Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: config.json).

    diff --git a/Configuration.page-vue-render.js b/Configuration.page-vue-render.js index 013dbaefb9b..4b2872afc46 100644 --- a/Configuration.page-vue-render.js +++ b/Configuration.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"configuration-guide"}},[_v("Configuration guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#configuration-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(").")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index 3e18318ed05..d181f37d247 100644 --- a/DevOps.html +++ b/DevOps.html @@ -18,7 +18,7 @@
  • About Us

    • DevOps guide

    Build automation

    This project uses Gradle for build automation and dependency management. You are recommended to read this Gradle Tutorial from the se-edu/guides.

    Given below are how to use Gradle for some important project tasks.

    Continuous integration (CI)

    This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

    Code coverage

    As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.

    However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.

    To enable Codecov for forks of this project, follow the steps given in this se-edu guide.

    Repository-wide checks

    In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

    These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

    ./config/travis/run-checks.sh

    Any warnings or errors will be printed out to the console.

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

    1. Update the version number in MainApp.java.
    2. Generate a fat JAR file using Gradle (i.e., gradlew shadowJar).
    3. Tag the repo with the version number. e.g. v0.1
    4. Create a new release using GitHub. Upload the JAR file you created.
    +e.g. ./gradlew shadowJar.

  • run: Builds and runs the application.
    runShadow: Builds the application as a fat JAR, and then runs it.

  • checkstyleMain: Runs the code style check for the main code base.
    checkstyleTest: Runs the code style check for the test code base.

  • test: Runs all tests.

    • Continuous integration (CI)

    This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the .github/workflows folder). No further setting up required.

    Code coverage

    As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.

    However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.

    To enable Codecov for forks of this project, follow the steps given in this se-edu guide.

    Repository-wide checks

    In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.

    These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:

    ./config/travis/run-checks.sh

    Any warnings or errors will be printed out to the console.

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

    1. Update the version number in MainApp.java.
    2. Generate a fat JAR file using Gradle (i.e., gradlew shadowJar).
    3. Tag the repo with the version number. e.g. v0.1
    4. Create a new release using GitHub. Upload the JAR file you created.
    diff --git a/DevOps.page-vue-render.js b/DevOps.page-vue-render.js index ddf10a99b8c..9aaba752a06 100644 --- a/DevOps.page-vue-render.js +++ b/DevOps.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"devops-guide"}},[_v("DevOps guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#devops-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('h2',{attrs:{"id":"build-automation"}},[_v("Build automation"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#build-automation","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This project uses Gradle for "),_c('strong',[_v("build automation and dependency management")]),_v(". "),_c('strong',[_v("You are recommended to read "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/gradle.html"}},[_v("this Gradle Tutorial from the se-edu/guides")])]),_v(".")]),_v(" "),_c('p',[_v("Given below are how to use Gradle for some important project tasks.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clean")])]),_v(": Deletes the files created during the previous build tasks (e.g. files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("build")]),_v(" folder)."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew clean")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("shadowJar")])]),_v(": Uses the ShadowJar plugin to creat a fat JAR file in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("build/lib")]),_v(" folder, "),_c('em',[_v("if the current file is outdated")]),_v("."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew shadowJar")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run")])]),_v(": Builds and runs the application."),_c('br'),_v(" "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("runShadow")])]),_v(": Builds the application as a fat JAR, and then runs it.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("checkstyleMain")])]),_v(": Runs the code style check for the main code base."),_c('br'),_v(" "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("checkstyleTest")])]),_v(": Runs the code style check for the test code base.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")])]),_v(": Runs all tests.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew test")]),_v(" — Runs all tests")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./gradlew clean test")]),_v(" — Cleans the project and runs tests")])])])]),_v(" "),_c('hr'),_v(" "),_c('h2',{attrs:{"id":"continuous-integration-ci"}},[_v("Continuous integration (CI)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#continuous-integration-ci","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This project uses GitHub Actions for CI. The project comes with the necessary GitHub Actions configurations files (in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows")]),_v(" folder). No further setting up required.")]),_v(" "),_c('h3',{attrs:{"id":"code-coverage"}},[_v("Code coverage"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#code-coverage","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As part of CI, this project uses Codecov to generate coverage reports. When CI runs, it will generate code coverage data (based on the tests run by CI) and upload that data to the CodeCov website, which in turn can provide you more info about the coverage of your tests.")]),_v(" "),_c('p',[_v("However, because Codecov is known to run into intermittent problems (e.g., report upload fails) due to issues on the Codecov service side, the CI is configured to pass even if the Codecov task failed. Therefore, developers are advised to check the code coverage levels periodically and take corrective actions if the coverage level falls below desired levels.")]),_v(" "),_c('p',[_v("To enable Codecov for forks of this project, follow the steps given in "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/codecov.html"}},[_v("this se-edu guide")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"repository-wide-checks"}},[_v("Repository-wide checks"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repository-wide-checks","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("In addition to running Gradle checks, CI includes some repository-wide checks. Unlike the Gradle checks which only cover files used in the build process, these repository-wide checks cover all files in the repository. They check for repository rules which are hard to enforce on development machines such as line ending requirements.")]),_v(" "),_c('p',[_v("These checks are implemented as POSIX shell scripts, and thus can only be run on POSIX-compliant operating systems such as macOS and Linux. To run all checks locally on these operating systems, execute the following in the repository root directory:")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config/travis/run-checks.sh")])]),_v(" "),_c('p',[_v("Any warnings or errors will be printed out to the console.")]),_v(" "),_c('p',[_c('strong',[_v("If adding new checks:")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("Checks are implemented as executable "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("check-*")]),_v(" scripts within the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github")]),_v(" directory. The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run-checks.sh")]),_v(" script will automatically pick up and run files named as such. That is, you can add more such files if you need and the CI will do the rest.")])]),_v(" "),_c('li',[_c('p',[_v("Check scripts should print out errors in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SEVERITY:FILENAME:LINE: MESSAGE")])]),_v(" "),_c('ul',[_c('li',[_v("SEVERITY is either ERROR or WARN.")]),_v(" "),_c('li',[_v("FILENAME is the path to the file relative to the current directory.")]),_v(" "),_c('li',[_v("LINE is the line of the file where the error occurred and MESSAGE is the message explaining the error.")])])]),_v(" "),_c('li',[_c('p',[_v("Check scripts must exit with a non-zero exit code if any errors occur.")])])]),_v(" "),_c('hr'),_v(" "),_c('h2',{attrs:{"id":"making-a-release"}},[_v("Making a release"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#making-a-release","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Here are the steps to create a new release.")]),_v(" "),_c('ol',[_c('li',[_v("Update the version number in "),_c('a',{attrs:{"href":"https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MainApp.java")])]),_v(".")]),_v(" "),_c('li',[_v("Generate a fat JAR file using Gradle (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gradlew shadowJar")]),_v(").")]),_v(" "),_c('li',[_v("Tag the repo with the version number. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v0.1")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://help.github.com/articles/creating-releases/"}},[_v("Create a new release using GitHub")]),_v(". Upload the JAR file you created.")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 82b92b8a379..ee8e2f08493 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -125,9 +125,11 @@
    1. Prerequisites: At least one person in DocTrack, for proper testing.
    2. Test case: clear appt
    3. Expected: The list is updated to show no appointment.

    Saving data

    1. Dealing with missing/corrupted data files
      1. Test case: missing data file
        1. Navigate to ../data and delete the .json files.
        2. Run the application
        3. Expected: The application should still run, with sample data shown in the list.
      2. Test case: corrupted data file -
        1. Navigate to ../data and edit the .json file, adding a random / at the end.
        2. Run the application
        3. Expected: The application should still run, with sample data shown in the list.


    Appendix: Planned enhancements

    Team size: 5



    Appendix: Effort

    Difficulty Level

    Our project presented a higher level of complexity compared to AB3. Our project involved handling multiple entity types, mainly persons and appointments, whereas AB3 manages only a single entity. This increased the requirements for command processing as each entity type has additional attributes and methods.

    Challenges Faced

    Achievements

    Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.


    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index a073a4c3ea1..bb4fc8ee672 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(9),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_c('br'),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureSequenceDiagram.png","width":"574"}}),_v(" "),_c('p',[_v("Each of the four main components (also shown in the diagram above),")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_m(19),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_c('br'),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"Interactions Inside the Logic Component for the `delete 1` Command"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The lifeline for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommandParser")]),_v(" should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.")])]),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_m(32),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(33),_v(" "),_c('br'),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"750"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" An alternative (arguably, a more OOP) model is given below. It has a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" list (the\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UniqueTagList")]),_v(") in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(", which "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" references. This allows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(" to only require one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" object per unique tag, instead of each "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" needing their own "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" objects. Similarly, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" objects are shown as such too."),_c('br')]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/BetterModelClassDiagram.png","width":"750"}})],1),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"650"}}),_v(" "),_m(40),_v(" "),_c('br'),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(43),_v(" "),_c('p',[_v("The activity diagram shows the general sequence of steps when a user interacts with DocTrack.")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/OverallFlowActivityDiagram.png","width":"700"}}),_v(" "),_m(44),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_m(47),_v(" "),_c('p',[_v("The sequence diagram shows how an entity command is executed:")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/EntityCommandSequenceDiagram.png","alt":"EntityCommandSequenceDiagram"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" There are two entities, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("The entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("Similarly, the entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("This applies for the other commands as well.")])])]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('br'),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_c('br'),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('br'),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('br'),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_c('br'),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_c('br'),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('br'),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('br'),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('br'),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_m(78),_v(" "),_c('br'),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_c('br'),_v(" "),_m(81),_v(" "),_m(82),_v(" "),_c('box',{attrs:{"type":"tip","theme":"success","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v("\nTo add a new predicate, navigate the corresponding entity folder in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model")]),_v(" package. There, you can create a new class that implements "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Predicate")]),_v(". Ensure that this method has a test method which defines the specific condition for a predicate.")])]),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/GeneralCommandsSequenceDiagram.png","width":"600"}}),_v(" "),_m(86),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_c('br'),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('br'),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_m(103),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v("\nFor "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(", the fields "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" are optional. Hence, if "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v("\nis not specified, it would be represented as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"null\"")]),_v(", in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("appointmentbook.json")]),_v(" file.")])]),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111),_v(" "),_m(112),_v(" "),_c('br'),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_c('br'),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_v(" "),_m(121),_v(" "),_m(122),_v(" "),_m(123),_v(" "),_c('br'),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_c('br'),_v(" "),_m(127),_v(" "),_c('p',[_v("For all use cases below, unless specified otherwise,")]),_v(" "),_m(128),_v(" "),_c('br'),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_c('br'),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_c('br'),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_c('br'),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_c('br'),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_c('br'),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_c('br'),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_c('br'),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_c('br'),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_c('br'),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_c('br'),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_c('br'),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_c('br'),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_c('br'),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(191),_v(" "),_c('p',[_v("Given below are instructions to test the app manually.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" These instructions only provide a starting point for testers to work on;\ntesters are expected to do more "),_c('em',[_v("exploratory")]),_v(" testing.")])]),_v(" "),_c('br'),_v(" "),_m(192),_v(" "),_m(193),_v(" "),_m(194),_v(" "),_m(195),_v(" "),_m(196),_v(" "),_m(197),_v(" "),_m(198),_v(" "),_m(199),_v(" "),_m(200),_v(" "),_m(201),_v(" "),_m(202),_v(" "),_m(203),_v(" "),_m(204),_v(" "),_m(205),_v(" "),_m(206),_v(" "),_m(207),_v(" "),_m(208),_v(" "),_m(209),_v(" "),_m(210),_v(" "),_m(211),_v(" "),_m(212),_v(" "),_m(213),_v(" "),_m(214),_v(" "),_m(215),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(216),_v(" "),_c('p',[_v("Team size: 5")]),_v(" "),_m(217),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(218),_v(" "),_m(219),_v(" "),_c('p',[_v("Our project presented a higher level of complexity compared to AB3. Our project involved handling multiple entity types, mainly persons and appointments, whereas AB3 manages only a single entity. This increased the requirements for command processing as each entity type has additional attributes and methods.")]),_v(" "),_m(220),_v(" "),_m(221),_v(" "),_m(222),_v(" "),_c('p',[_v("Our project involved substantial effort in several key areas:")]),_v(" "),_m(223),_v(" "),_m(224),_v(" "),_c('p',[_v("Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.")]),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doctrack-developer-guide"}},[_v("DocTrack Developer Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledgements"}},[_v("Acknowledgements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setting-up-getting-started"}},[_v("Setting up, getting started‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#design"}},[_v("Design‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#architecture"}},[_v("Architecture‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#ui-component"}},[_v("UI component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#logic-component"}},[_v("Logic component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#model-component"}},[_v("Model component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#storage-component"}},[_v("Storage component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#common-classes"}},[_v("Common classes‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#flow"}},[_v("Flow‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-entity-command-features"}},[_v("Implementation of entity command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-design-considerations"}},[_v("General Design Considerations‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-specific-design-considerations"}},[_v("Command-Specific Design Considerations‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-general-command-features"}},[_v("Implementation of general command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exit-feature"}},[_v("Exit feature‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-feature"}},[_v("Help feature‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-miscellaneous-design-considerations"}},[_v("Appendix: Miscellaneous Design Considerations‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#data-storage-and-files"}},[_v("Data storage and files‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parsing"}},[_v("Parsing‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-interface"}},[_v("User Interface‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-requirements"}},[_v("Appendix: Requirements‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#product-scope"}},[_v("Product scope‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-stories"}},[_v("User stories‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#use-cases"}},[_v("Use cases‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#non-functional-requirements"}},[_v("Non-Functional Requirements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#glossary"}},[_v("Glossary‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launch-and-shutdown"}},[_v("Launch and shutdown‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person"}},[_v("Adding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person"}},[_v("Deleting a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person"}},[_v("Editing a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person"}},[_v("Finding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-appointment"}},[_v("Adding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-appointment"}},[_v("Deleting an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-an-appointment"}},[_v("Editing an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-an-appointment"}},[_v("Finding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list-2"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-data"}},[_v("Saving data‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned enhancements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-effort"}},[_v("Appendix: Effort‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(225)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureDiagram.png","width":"280"}}),_v(" "),_m(9),_v(" "),_c('p',[_v("Given below is a quick overview of main components and how they interact with each other.")]),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('p',[_v("The bulk of the app's work is done by the following four components:")]),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_c('br'),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ArchitectureSequenceDiagram.png","width":"574"}}),_v(" "),_c('p',[_v("Each of the four main components (also shown in the diagram above),")]),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ComponentManagers.png","width":"300"}}),_v(" "),_m(19),_v(" "),_c('p',[_v("The sections below give more details of each component.")]),_v(" "),_c('br'),_v(" "),_m(20),_v(" "),_m(21),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/UiClassDiagram.png","alt":"Structure of the UI Component"}}),_v(" "),_m(22),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_m(27),_v(" "),_m(28),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/LogicClassDiagram.png","width":"550"}}),_v(" "),_m(29),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/DeleteSequenceDiagram.png","alt":"Interactions Inside the Logic Component for the `delete 1` Command"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" The lifeline for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommandParser")]),_v(" should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.")])]),_v(" "),_m(30),_v(" "),_m(31),_v(" "),_m(32),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ParserClasses.png","width":"600"}}),_v(" "),_c('p',[_v("How the parsing works:")]),_v(" "),_m(33),_v(" "),_c('br'),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/ModelClassDiagram.png","width":"750"}}),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" An alternative (arguably, a more OOP) model is given below. It has a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" list (the\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UniqueTagList")]),_v(") in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(", which "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" references. This allows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddressBook")]),_v(" to only require one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" object per unique tag, instead of each "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" needing their own "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tag")]),_v(" objects. Similarly, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" objects are shown as such too."),_c('br')]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/BetterModelClassDiagram.png","width":"750"}})],1),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/StorageClassDiagram.png","width":"650"}}),_v(" "),_m(40),_v(" "),_c('br'),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(43),_v(" "),_c('p',[_v("The activity diagram shows the general sequence of steps when a user interacts with DocTrack.")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/OverallFlowActivityDiagram.png","width":"700"}}),_v(" "),_m(44),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_m(47),_v(" "),_c('p',[_v("The sequence diagram shows how an entity command is executed:")]),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/EntityCommandSequenceDiagram.png","alt":"EntityCommandSequenceDiagram"}}),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" There are two entities, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("The entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("Similarly, the entity referred in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddEntityCommand")]),_v(" refers to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddPersonCommand")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AddAppointmentCommand")]),_v(".")]),_v(" "),_c('li',[_v("This applies for the other commands as well.")])])]),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_m(54),_v(" "),_c('br'),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_c('br'),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('br'),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('br'),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_c('br'),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_c('br'),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('br'),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('br'),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('br'),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_m(78),_v(" "),_c('br'),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_c('br'),_v(" "),_m(81),_v(" "),_m(82),_v(" "),_c('box',{attrs:{"type":"tip","theme":"success","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v("\nTo add a new predicate, navigate the corresponding entity folder in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("model")]),_v(" package. There, you can create a new class that implements "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Predicate")]),_v(". Ensure that this method has a test method which defines the specific condition for a predicate.")])]),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_v(" "),_c('pic',{attrs:{"src":"/tp/diagrams/GeneralCommandsSequenceDiagram.png","width":"600"}}),_v(" "),_m(86),_v(" "),_m(87),_v(" "),_m(88),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_c('br'),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('br'),_v(" "),_m(93),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_m(96),_v(" "),_m(97),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_m(103),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v("\nFor "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(", the fields "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" are optional. Hence, if "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v("\nis not specified, it would be represented as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"null\"")]),_v(", in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("appointmentbook.json")]),_v(" file.")])]),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111),_v(" "),_m(112),_v(" "),_c('br'),_v(" "),_m(113),_v(" "),_m(114),_v(" "),_m(115),_v(" "),_c('br'),_v(" "),_m(116),_v(" "),_m(117),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(118),_v(" "),_m(119),_v(" "),_m(120),_v(" "),_m(121),_v(" "),_m(122),_v(" "),_m(123),_v(" "),_c('br'),_v(" "),_m(124),_v(" "),_m(125),_v(" "),_m(126),_c('br'),_v(" "),_m(127),_v(" "),_c('p',[_v("For all use cases below, unless specified otherwise,")]),_v(" "),_m(128),_v(" "),_c('br'),_v(" "),_m(129),_v(" "),_m(130),_v(" "),_m(131),_v(" "),_m(132),_v(" "),_m(133),_v(" "),_c('br'),_v(" "),_m(134),_v(" "),_m(135),_v(" "),_m(136),_v(" "),_m(137),_v(" "),_m(138),_v(" "),_c('br'),_v(" "),_m(139),_v(" "),_m(140),_v(" "),_m(141),_v(" "),_m(142),_v(" "),_m(143),_v(" "),_c('br'),_v(" "),_m(144),_v(" "),_m(145),_v(" "),_m(146),_v(" "),_m(147),_v(" "),_m(148),_v(" "),_c('br'),_v(" "),_m(149),_v(" "),_m(150),_v(" "),_m(151),_v(" "),_m(152),_v(" "),_m(153),_v(" "),_c('br'),_v(" "),_m(154),_v(" "),_m(155),_v(" "),_m(156),_v(" "),_c('br'),_v(" "),_m(157),_v(" "),_m(158),_v(" "),_m(159),_v(" "),_m(160),_v(" "),_m(161),_v(" "),_c('br'),_v(" "),_m(162),_v(" "),_m(163),_v(" "),_m(164),_v(" "),_m(165),_v(" "),_m(166),_v(" "),_c('br'),_v(" "),_m(167),_v(" "),_m(168),_v(" "),_m(169),_v(" "),_m(170),_v(" "),_m(171),_v(" "),_c('br'),_v(" "),_m(172),_v(" "),_m(173),_v(" "),_m(174),_v(" "),_m(175),_v(" "),_m(176),_v(" "),_c('br'),_v(" "),_m(177),_v(" "),_m(178),_v(" "),_m(179),_v(" "),_m(180),_v(" "),_m(181),_v(" "),_c('br'),_v(" "),_m(182),_v(" "),_m(183),_v(" "),_m(184),_v(" "),_c('br'),_v(" "),_m(185),_v(" "),_m(186),_v(" "),_c('br'),_v(" "),_m(187),_v(" "),_m(188),_v(" "),_m(189),_v(" "),_m(190),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(191),_v(" "),_c('p',[_v("Given below are instructions to test the app manually.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" These instructions only provide a starting point for testers to work on;\ntesters are expected to do more "),_c('em',[_v("exploratory")]),_v(" testing.")])]),_v(" "),_c('br'),_v(" "),_m(192),_v(" "),_m(193),_v(" "),_m(194),_v(" "),_m(195),_v(" "),_m(196),_v(" "),_m(197),_v(" "),_m(198),_v(" "),_m(199),_v(" "),_m(200),_v(" "),_m(201),_v(" "),_m(202),_v(" "),_m(203),_v(" "),_m(204),_v(" "),_m(205),_v(" "),_m(206),_v(" "),_m(207),_v(" "),_m(208),_v(" "),_m(209),_v(" "),_m(210),_v(" "),_m(211),_v(" "),_m(212),_v(" "),_m(213),_v(" "),_m(214),_v(" "),_m(215),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(216),_v(" "),_c('p',[_v("Team size: 5")]),_v(" "),_m(217),_v(" "),_m(218),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(219),_v(" "),_m(220),_v(" "),_c('p',[_v("Our project presented a higher level of complexity compared to AB3. Our project involved handling multiple entity types, mainly persons and appointments, whereas AB3 manages only a single entity. This increased the requirements for command processing as each entity type has additional attributes and methods.")]),_v(" "),_m(221),_v(" "),_m(222),_v(" "),_m(223),_v(" "),_c('p',[_v("Our project involved substantial effort in several key areas:")]),_v(" "),_m(224),_v(" "),_m(225),_v(" "),_c('p',[_v("Our project successfully expanded AB3’s functionality, enabling the application to manage patients and appointments. Despite the challenges, our final solution provides a user-friendly interface and coherent command structure. Additionally, the design allows for potential future expansion to include other entity types without extensive restructuring, making the system both flexible and scalable.")]),_v(" "),_c('br')],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#doctrack-developer-guide"}},[_v("DocTrack Developer Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#acknowledgements"}},[_v("Acknowledgements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#setting-up-getting-started"}},[_v("Setting up, getting started‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#design"}},[_v("Design‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#architecture"}},[_v("Architecture‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#ui-component"}},[_v("UI component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#logic-component"}},[_v("Logic component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#model-component"}},[_v("Model component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#storage-component"}},[_v("Storage component‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#common-classes"}},[_v("Common classes‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#flow"}},[_v("Flow‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-entity-command-features"}},[_v("Implementation of entity command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-design-considerations"}},[_v("General Design Considerations‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-specific-design-considerations"}},[_v("Command-Specific Design Considerations‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#implementation-of-general-command-features"}},[_v("Implementation of general command features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exit-feature"}},[_v("Exit feature‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#help-feature"}},[_v("Help feature‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-miscellaneous-design-considerations"}},[_v("Appendix: Miscellaneous Design Considerations‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#data-storage-and-files"}},[_v("Data storage and files‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parsing"}},[_v("Parsing‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-interface"}},[_v("User Interface‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-requirements"}},[_v("Appendix: Requirements‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#product-scope"}},[_v("Product scope‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-stories"}},[_v("User stories‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#use-cases"}},[_v("Use cases‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#non-functional-requirements"}},[_v("Non-Functional Requirements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#glossary"}},[_v("Glossary‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launch-and-shutdown"}},[_v("Launch and shutdown‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person"}},[_v("Adding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person"}},[_v("Deleting a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person"}},[_v("Editing a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person"}},[_v("Finding a person‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-an-appointment"}},[_v("Adding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-an-appointment"}},[_v("Deleting an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-an-appointment"}},[_v("Editing an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-an-appointment"}},[_v("Finding an appointment‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-person-list-2"}},[_v("Clearing person list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-data"}},[_v("Saving data‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-planned-enhancements"}},[_v("Appendix: Planned enhancements‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appendix-effort"}},[_v("Appendix: Effort‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(226)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -656,7 +656,10 @@ with(this){return _c('ol',[_c('li',[_v("Dealing with missing/corrupted data file with(this){return _c('h2',{attrs:{"id":"appendix-planned-enhancements"}},[_c('strong',[_v("Appendix: Planned enhancements")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-planned-enhancements","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('ol',[_c('li')])} +with(this){return _c('ol',[_c('li'),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Modify date parsing to check for leap years")])])])])} +},function anonymous( +) { +with(this){return _c('ul',[_c('li',[_c('strong',[_v("Flaw:")]),_v(" When a user enters February 29 for a non-leap year, the date automatically adjusts to February\n28, which may be confusing.")]),_v(" "),_c('li',[_c('strong',[_v("Enhancement:")]),_v(" Modify the date parsing logic to check for leap years.\n"),_c('ul',[_c('li',[_v("If the user enters February 29 for a non-leap year, display an error message indicating that the date is invalid.")]),_v(" "),_c('li',[_v("If the user enters February 29 for a leap year, the date is accepted.")])])]),_v(" "),_c('li',[_c('strong',[_v("Sample Input:")]),_v(" User enters "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2023-02-29")]),_v(" for an appointment date.")]),_v(" "),_c('li',[_c('strong',[_v("Expected Output:")]),_v(" The result display box shows "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Invalid date: 2023 is not a leap year, so February 29 is not valid.")])])])} },function anonymous( ) { with(this){return _c('h2',{attrs:{"id":"appendix-effort"}},[_c('strong',[_v("Appendix: Effort")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-effort","onclick":"event.stopPropagation()"}})])} @@ -680,6 +683,6 @@ with(this){return _c('ul',[_c('li',[_c('strong',[_v("Design and Refactoring")]), with(this){return _c('h4',{attrs:{"id":"achievements"}},[_v("Achievements"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#achievements","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index 80d191ba37b..719e0619f26 100644 --- a/Documentation.html +++ b/Documentation.html @@ -16,7 +16,7 @@ Search

    Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +
  • About Us

    • Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 75d3bf3a2fd..2a399f1540d 100644 --- a/Documentation.page-vue-render.js +++ b/Documentation.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"documentation-guide"}},[_v("Documentation Guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#documentation-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_v("We use "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_c('strong',[_v("MarkBind")])]),_v(" to manage documentation.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docs/")]),_v(" folder contains the source files for the documentation website.")]),_v(" "),_c('li',[_v("To learn how set it up and maintain the project website, follow the guide "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/markbind-forked-sites.html"}},[_v("[se-edu/guides] Working with Forked MarkBind sites")]),_v(" for project documentation.")])]),_v(" "),_c('p',[_c('strong',[_v("Style guidance:")])]),_v(" "),_c('ul',[_c('li',[_v("Follow the "),_c('a',{attrs:{"href":"https://developers.google.com/style"}},[_c('strong',[_c('em',[_v("Google developer documentation style guide")])])]),_v(".")]),_v(" "),_c('li',[_v("Also relevant is the "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/markdown.html"}},[_c('em',[_v("se-edu/guides "),_c('strong',[_v("Markdown coding standard")])])]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Converting to PDF")])]),_v(" "),_c('ul',[_c('li',[_v("See the guide "),_c('a',{attrs:{"href":"https://se-education.org/guides/tutorials/savingPdf.html"}},[_c('em',[_v("se-edu/guides "),_c('strong',[_v("Saving web documents as PDF files")])])]),_v(".")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 3964481a13c..ba0e7b7f25a 100644 --- a/Logging.html +++ b/Logging.html @@ -16,7 +16,7 @@ Search

    Logging guide

    • We are using java.util.logging package for logging.
    • The LogsCenter class is used to manage the logging levels and logging destinations.
    • The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.
    • Log messages are output through the console and to a .log file.
    • The output logging level can be controlled using the logLevel setting in the configuration file (See the Configuration guide section).
    • When choosing a level for a log message, follow the conventions given in [se-edu/guides] Java: Logging conventions.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +
  • About Us

    • Logging guide

    • We are using java.util.logging package for logging.
    • The LogsCenter class is used to manage the logging levels and logging destinations.
    • The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.
    • Log messages are output through the console and to a .log file.
    • The output logging level can be controlled using the logLevel setting in the configuration file (See the Configuration guide section).
    • When choosing a level for a log message, follow the conventions given in [se-edu/guides] Java: Logging conventions.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index 5e7d174fd94..5aaeda7a492 100644 --- a/Logging.page-vue-render.js +++ b/Logging.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"logging-guide"}},[_v("Logging guide"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#logging-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_v("We are using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java.util.logging")]),_v(" package for logging.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LogsCenter")]),_v(" class is used to manage the logging levels and logging destinations.")]),_v(" "),_c('li',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Logger")]),_v(" for a class can be obtained using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LogsCenter.getLogger(Class)")]),_v(" which will log messages according to the specified logging level.")]),_v(" "),_c('li',[_v("Log messages are output through the console and to a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".log")]),_v(" file.")]),_v(" "),_c('li',[_v("The output logging level can be controlled using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("logLevel")]),_v(" setting in the configuration file (See the "),_c('a',{attrs:{"href":"/tp/Configuration.html"}},[_v("Configuration guide")]),_v(" section).")]),_v(" "),_c('li',[_c('strong',[_v("When choosing a level for a log message")]),_v(", follow the conventions given in "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/java/logging.html"}},[_c('em',[_v("[se-edu/guides] Java: Logging conventions")])]),_v(".")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index b1fe5a37ca0..4c40703fd9e 100644 --- a/SettingUp.html +++ b/SettingUp.html @@ -22,7 +22,7 @@
  • Verify the setup:
    1. Run the seedu.address.Main and try a few commands.
    2. Run the tests to ensure they all pass.

    • Before writing code

    1. Configure the coding style

      If using IDEA, follow the guide [se-edu/guides] IDEA: Configuring the code style to set up IDEA's coding style to match ours.

      Tip: Optionally, you can follow the guide [se-edu/guides] Using Checkstyle to find how to use the CheckStyle within IDEA e.g., to report problems as you write code.

    2. Set up CI

      This project comes with a GitHub Actions config files (in .github/workflows folder). When GitHub detects those files, it will run the CI for your project automatically at each push to the master branch or to any PR. No set up required.

    3. Learn the design

      When you are ready to start coding, we recommend that you get some sense of the overall design by reading about AddressBook’s architecture.

    4. Do the tutorials -These tutorials will help you get acquainted with the codebase.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +These tutorials will help you get acquainted with the codebase.

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index d25ec65556c..fa30f31ee80 100644 --- a/SettingUp.page-vue-render.js +++ b/SettingUp.page-vue-render.js @@ -41,6 +41,6 @@ with(this){return _c('li',[_c('p',[_c('strong',[_v("Learn the design")])]),_v(" with(this){return _c('li',[_c('p',[_c('strong',[_v("Do the tutorials")]),_v("\nThese tutorials will help you get acquainted with the codebase.")]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a new command")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing fields")])])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 4314fdc11eb..44643b8d317 100644 --- a/Testing.html +++ b/Testing.html @@ -20,7 +20,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle
    • Open a console and run the command gradlew clean test (Mac/Linux: ./gradlew clean test)

    • Link: Read this Gradle Tutorial from the se-edu/guides to learn more about using Gradle.

    Types of tests

    This project has three types of tests:

    1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest
    2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest
    3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      -e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index 6af93111bec..4a573cf2652 100644 --- a/Testing.page-vue-render.js +++ b/Testing.page-vue-render.js @@ -20,6 +20,6 @@ with(this){return _c('h2',{attrs:{"id":"types-of-tests"}},[_v("Types of tests"), with(this){return _c('ol',[_c('li',[_c('em',[_v("Unit tests")]),_v(" targeting the lowest level methods/classes."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.commons.StringUtilTest")])]),_v(" "),_c('li',[_c('em',[_v("Integration tests")]),_v(" that are checking the integration of multiple code units (those code units are assumed to be working)."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.storage.StorageManagerTest")])]),_v(" "),_c('li',[_v("Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seedu.address.logic.LogicManagerTest")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index b61f406962b..6459bfca2e5 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -55,8 +55,8 @@ of the application.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Finding persons by name: find person

    You can find person(s) whose names contain any of the given keywords.

    Format: find person KEYWORD [MORE_KEYWORDS]

    Examples:


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Deleting a person : delete person

    You can delete a specified person from the patient book.

    Format: delete person INDEX

    Tip: Make sure you have the correct index of the patient before deleting. Use list person to check.

    Examples:

    Warning: This action is irreversible. Ensure you have selected the correct person before deleting. Note that deleting a person will also delete all related appointments.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Clearing all persons : clear person

    You can delete all person entries from the patient book.

    Format: clear person

    Warning: This action is irreversible. Ensure you have a backup of the patient data before clearing. -Note that this will also clear the appointment data.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands



    Appointment Commands

    An appointment is defined by several fields. The fields and their corresponding prefixes are as follows:

    Field Prefix Optional Multiple Acceptable Inputs
    Person ID i/ No No Existing person ID
    Appointment Type ty/ No No Any value
    Date and Time d/ No No yyyy-MM-dd HH:mm. Refer to 1. below
    Sickness s/ Yes No At least one alphabetic character
    Medicine m/ Yes No At least one alphabetic character

    You can identify these appointments uniquely by their Appointment ID (AID) for easy reference. -The AID can be seen in the top right corner of their information card, as shown below:

    You can manage the appointments through different commands, which can be seen in the table below:

    Notes:

    1. The date and time inputs are resolved "smartly" - meaning that certain incorrect dates will be allowed, e.g. 2025-02-29 12:00 will be parsed as 2025-02-28 12:00.

    Action Format Examples
    Add appointment add appt i/PERSON_ID d/DATE_TIME ty/APPOINTMENT_TYPE [s/SICKNESS] [m/MEDICINE]

    		add appt i/1 d/2024-12-01 09:30 ty/Consulation s/Diabetes m/Insulin
    List all appointments list appt list appt
    Edit appointment edit appt INDEX [i/PERSON_ID] [d/DATE_TIME] [ty/APPOINTMENT_TYPE] [s/SICKNESS] [m/MEDICINE] edit appt 3 d/2024-12-05 13:00 m/Panadol
    Find appointment find appt KEYWORD [MORE_KEYWORDS] find appt d/2024-12-05
    Delete appointment delete appt INDEX delete appt 2
    Clear all appointments clear appt
    		clear appt

    Adding an appointment: add appt

    You can add an appointment to DocTrack.

    Format: add appt i/PERSON_ID ty/APPOINTMENT_TYPE d/DATE_TIME [s/SICKNESS] [m/MEDICINE]

    Tip: You can decide to leave out sickness and medicine inputs when adding them, then edit them later.

    Examples:

    Note: Although you type DATE_TIME in the format yyyy-MM-dd HH:mm, you will see it displayed as Month Date, Year, Time.
    Example: You will see 2024-12-10 12:30 displayed as December 10, 2024, 12:30 PM.

    Note: Ensure that you enter a unique person, date and time, +Note that this will also clear the appointment data.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands



    Appointment Commands

    An appointment is defined by several fields. The fields and their corresponding prefixes are as follows:

    Field Prefix Optional Multiple Acceptable Inputs
    Person ID i/ No No Existing person ID
    Appointment Type ty/ No No Any value
    Date and Time d/ No No yyyy-MM-dd HH:mm. Refer to 1. below
    Sickness s/ Yes No At least one alphabetic character
    Medicine m/ Yes No At least one alphabetic character

    You can identify these appointments uniquely by their Appointment ID (AID) for easy reference. +The AID can be seen in the top right corner of their information card, as shown below:

    • The number indicated beside the appointment name is the PID of the person who has the appointment.

    You can manage the appointments through different commands, which can be seen in the table below:

    Notes:

    1. Acceptable inputs for Date and Time:

    • The time is in 24-hour format, i.e. HH:mm should be between 00:00 and 23:59.
    • The date and time inputs are resolved "smartly" - meaning that certain incorrect dates will be allowed.
      Example:2025-02-29 12:00 will be parsed as 2025-02-28 12:00.

    Action Format Examples
    Add appointment add appt i/PERSON_ID d/DATE_TIME ty/APPOINTMENT_TYPE [s/SICKNESS] [m/MEDICINE]

    		add appt i/1 d/2024-12-01 09:30 ty/Consulation s/Diabetes m/Insulin
    List all appointments list appt list appt
    Edit appointment edit appt INDEX [i/PERSON_ID] [d/DATE_TIME] [ty/APPOINTMENT_TYPE] [s/SICKNESS] [m/MEDICINE] edit appt 3 d/2024-12-05 13:00 m/Panadol
    Find appointment find appt KEYWORD [MORE_KEYWORDS] find appt d/2024-12-05
    Delete appointment delete appt INDEX delete appt 2
    Clear all appointments clear appt
    		clear appt

    Adding an appointment: add appt

    You can add an appointment to DocTrack.

    Format: add appt i/PERSON_ID ty/APPOINTMENT_TYPE d/DATE_TIME [s/SICKNESS] [m/MEDICINE]

    Tip: You can decide to leave out sickness and medicine inputs when adding them, then edit them later.

    Examples:

    • add appt i/1 ty/Consulation d/2024-12-01 09:30 s/Diabetes m/Insulin adds an appointment to the person with personId 1. The appointment has appointment type Consulation, date and time 2024-12-01 09:30, sickness Diabetes, and medicine Insulin.
    • add appt i/2 ty/Follow-up d/2024-02-01 16:40 s/Asthma m/Inhaler adds an appointment to the person with personId 2. The appointment has appointment type Follow-up, date and time 2024-02-01 16:40, sickness Asthma, and medicine Inhaler.

    Note: Although you type DATE_TIME in the format yyyy-MM-dd HH:mm, you will see it displayed as Month Date, Year, Time.
    Example: You will see 2024-12-10 14:30 displayed as December 10, 2024, 2:30 PM.

    Note: Ensure that you enter a unique person, date and time, and appointment type for the appointment you are adding. Else, it will be detected as a duplicate, and an error message will be shown.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Listing all appointments : list appt

    You can view a list of all appointments in the appointment book.

    Format: list appt


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Editing an appointment : edit appt

    You can an existing appointment in appointment book.

    Format: edit appt INDEX [i/PERSON_ID] [d/DATE_TIME] [ty/APPOINTMENT_TYPE] [s/SICKNESS] [m/MEDICINE]

    • Edits the appointment at the specified INDEX.
    • At least one of the optional fields must be provided.
    • Existing values will be updated to the input values.
    • The format of DATE_TIME is yyyy-MM-dd HH:mm. For example, 2025-03-20 10:30.

    Examples:

    • edit appt 3 d/2024-12-05 13:00 m/Budesonide edits the date and time and the medicine to be 2024-12-05 13:00 and Budesonide respectively.

    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Finding appointments by name and date: find appt

    You can find appointments whose person names and / or dates contain any of the given keywords.

    Format: find appt KEYWORD [MORE_KEYWORDS]

    • Use the prefix n/ to search for patient names.
    • Use the prefix d/ to search for dates.
    • At least one keyword must be provided.
    • The format of DATE is YYYY-MM-DD. For example, 2024-10-16.

    Tip: Use the find appt command to filter out appointments for a certain day or patient.

    Examples:

    • find appt n/John returns appointments with patients named John.
    • find appt d/2024-12-05 returns appointments on 2024-12-05.
    • find appt n/John d/2024-12-05 returns appointments with patients named John, and is on 2024-12-05.

      result for 'find appt John and 2024-12-05'

    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Deleting an appointment : delete appt

    You can delete a specified appointment from appointment book.

    Format: delete appt INDEX

    • Deletes the appointment at the specified INDEX.

    Tip: Use the list appt to check the index of the appointment before deleting one.

    Examples:

    • list appt followed by delete appt 2 deletes the second appointment in the list of appointments.
    • find appt d/2024-12-05 followed by delete appt 1 deletes the first appointment in the results of the find command.

    Warning: This action is irreversible. Ensure you have selected the correct appointment before deleting.


    Navigate back to the subsections here: Command overview Person commands Appointment commands General commands


    Clearing all appointments : clear appt

    You can delete all appointment entries from the appointment book.

    Format: clear appt

    Warning: @@ -116,7 +116,7 @@ folder.

  • Replace these empty files with the addressbook.json and appointmentbook.json files you saved from your previous computer.

    • Q: Can I access DocTrack without internet connection?
    A: Yes, you can run DocTrack without an internet connection.


    Q: How do I back up my data?
    A: Since the data is saved in the addressbook.json and appointmentbook.json files in the data folder, you can copy these files to another location as a backup.


    Q: How many patients and appointments does DocTrack support?
    A: DocTrack technically supports up to 4 billion total historical patients and appointments. However, depending on your system, it might lag with larger numbers of patients and appointments. -We recommend that you do not exceed 10,000 total patients and appointments.




    Known issues

    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.

    1. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

    1. On MacOS systems, the bold fonts may appear slightly clipped.

    1. Editing the name in the edit person command will not reflect the name change in the appointments until a reload of the application.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +We recommend that you do not exceed 10,000 total patients and appointments.




    Known issues

    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.

    1. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

    1. On MacOS systems, the bold fonts may appear slightly clipped.

    1. Editing the name in the edit person command will not reflect the name change in the appointments until a reload of the application.
    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index 6624b00edab..bcd1507c581 100644 --- a/UserGuide.page-vue-render.js +++ b/UserGuide.page-vue-render.js @@ -1,7 +1,7 @@ var pageVueRenderFn = function anonymous( ) { -with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('box',{attrs:{"type":"info","light":"","theme":"primary"}},[_c('b',[_v("DocTrack")]),_v(" is a desktop application for "),_c('b',[_v("general practitioners (GPs)")]),_v(" to quickly access patient \ncontact details, appointments, and treatment records.\n"),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" aims to be the bridge for general practitioners in smaller clinics towards the digitalisation of their administrative efforts, with a focus on contact management and visit history tracking.")]),_v(" "),_c('br'),_v("\nWe plan to help you simplify and speed-up the administrative burden of patient management through an \nintuitive and efficient application.\n")]),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('p',[_v("... all with an intuitive and user-friendly interface!")]),_v(" "),_c('br'),_v(" "),_c('p',[_v("To get started, you can read the introduction below, which shows all the different sections in this user guide.")]),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-success",attrs:{"href":"#quick-start"}},[_v("Quick Start")])]),_v(" "),_c('p',[_v("Quickly get started with DocTrack!")]),_v(" "),_c('p',[_v("Click on this section for a quick set-up guide, with examples of commands that you can use, out of the box.")])]),_v(" "),_c('box',{attrs:{"type":"info","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-info",attrs:{"href":"#interacting-with-doctrack"}},[_v("Interacting with DocTrack")])]),_v(" "),_c('p',[_v("Learn how you can interact with DocTrack!")]),_v(" "),_c('p',[_v("DocTrack functions through a set of commands. Click on this section to learn more.")])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command Overview")])]),_v(" "),_c('p',[_v("Click on this section to know more about the commands you can use in DocTrack.\nFor more specifics, click on the subsections below.")]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v("\nClick on this section for a rough summary of all the commands related to persons.")])]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v("\nClick on this section for a rough summary of all the commands related to appointments.")])]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")]),_v("\nClick on this section for a rough summary of all the general commands.")])])],1),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-warning",attrs:{"href":"#faq"}},[_v("FAQs")])]),_v(" "),_c('p',[_v("Have questions? Read here to see answer to commonly asked questions.")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-warning",attrs:{"href":"#known-issues"}},[_v("Known issues")])]),_v(" "),_c('p',[_v("Having a problem? Read here to see some common issues that may arise while you are using DocTrack.")])]),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('br'),_v(" "),_m(7),_v(" "),_c('br'),_v(" "),_m(8),_v(" "),_c('br'),_v(" "),_m(9),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_c('br'),_v(" "),_m(11),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")])]),_v(" "),_c('p',[_v("This would be a good time to run the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")]),_v(" command, to start afresh without sample data.")])]),_v(" "),_c('br'),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("Here are some "),_c('strong',[_v("key points")]),_v(" to keep in mind when you are using the commands:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Appointments")]),_v(" are sorted by "),_c('strong',[_v("date")]),_v(". "),_c('strong',[_v("Patients")]),_v(" are sorted in "),_c('strong',[_v("chronological")]),_v(" order.")])]),_v(" "),_c('li',[_c('p',[_v("You should supply "),_c('strong',[_v("all")]),_v(" the fields (words in "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UPPER_CASE")])]),_v(") that are needed for a command."),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" In "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/NAME")]),_v(", "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")])]),_v(" is a field which can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/John Doe")]),_v(".")])])]),_v(" "),_c('li',[_c('p',[_v("The "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("INDEX")])]),_v(" in command formats like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person INDEX")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete appt INDEX")]),_v(" refers to the index\nnumber (shown beside the person or appointment) in the displayed list. The index "),_c('strong',[_v("must be a positive integer i.e. 1, 2, 3...")]),_v(" "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" The index of the first person displayed at the top the list is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("1")]),_v(", the index of the second person displayed is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2")]),_v(", and so on.")])])]),_v(" "),_c('li',[_c('p',[_v("Items in "),_c('strong',[_v("square")]),_v(" brackets "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[]")])]),_v(" are "),_c('strong',[_v("optional")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/NAME [t/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe t/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe")]),_v(".")])])]),_v(" "),_c('li',[_c('p',[_v("Items with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("…​")]),_v(" after them can be used "),_c('strong',[_v("zero times or more times")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[t/TAG]…​")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}}),_v(" (i.e. 0 times), "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")]),_v(" etc.")])])]),_v(" "),_c('li',[_c('p',[_v("You can add fields in "),_c('strong',[_v("any order")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" If the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/NAME p/PHONE_NUMBER")]),_v(", then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("p/PHONE_NUMBER n/NAME")]),_v(" is also acceptable.")])])])]),_v(" "),_c('box',{staticStyle:{"border":"1px solid"},attrs:{"type":"tip","theme":"success","light":""}},[_c('p',[_c('strong',[_v("Tip:")])]),_v(" "),_c('p',[_v("If you add extraneous fields for commands that do not take in fields (such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(",\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v("), they will be ignored. "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" If the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help 123")]),_v(", then it will be interpreted as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(".")])])]),_v(" "),_c('box',{staticStyle:{"border":"1px solid red"},attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Caution:")])]),_v(" "),_c('p',[_v("If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines. This is because some space characters surrounding line-breaks may be omitted when copied over.")])])],1),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(16),_v(" "),_c('p',[_v("The following sections describe the various commands you can use in the DocTrack application.")]),_v(" "),_c('hr'),_v(" "),_m(17),_v(" "),_m(18),_c('br'),_v(" "),_c('hr'),_v(" "),_m(19),_v(" "),_m(20),_c('br'),_v(" "),_c('hr'),_v(" "),_m(21),_v(" "),_m(22),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_c('box',{attrs:{"type":"info","light":"","seamless":""}},[_c('p',[_c('strong',[_v("Notes:")])]),_v(" "),_c('p',[_c('strong',[_v("1.")]),_v(" The "),_c('strong',[_v("email")]),_v(" must have")]),_v(" "),_c('ul',[_c('li',[_v("a local part containing alphanumeric characters and specific symbols (such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("+")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-")]),_v(") (not at the start or end),")]),_v(" "),_c('li',[_v("followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(", and a domain part with labels separated by periods,")]),_v(" "),_c('li',[_v("ending in a label with at least two alphanumeric characters,")]),_v(" "),_c('li',[_v("and no labels starting or ending with hyphens.")])])]),_v(" "),_c('p',[_v("You can identify these patients uniquely by their "),_c('strong',[_v("patient ID (PID)")]),_v(" for easy reference.\nThe "),_c('strong',[_v("PID")]),_v(" can be seen in the top right corner of their information card, as shown below:"),_c('br'),_c('br'),_v(" "),_c('img',{staticStyle:{"display":"block","margin-left":"auto","margin-right":"auto"},attrs:{"src":"/tp/images/personexample.png","width":"480"}}),_v(" "),_c('br'),_c('sbr')],1),_v(" "),_c('br'),_v(" "),_c('p',[_v("You can also manage the patient information through different commands, which can be seen in the table below:")]),_v(" "),_m(26),_c('br'),_v(" "),_m(27),_v(" "),_c('p',[_v("You can add a person to the patient book.")]),_v(" "),_m(28),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" A person can have any number of tags (including 0). "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/likes coding")]),_v(" has 2 tags and it is valid.")])])]),_v(" "),_m(29),_v(" "),_m(30),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Ensure that you enter a "),_c('strong',[_v("unique name (case-insensitive) and phone number")]),_v(" for the person you are adding. Else, it will be detected as a duplicate, and an error message will be shown.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(31),_v(" "),_c('p',[_v("You can view a list of all persons in the patient book.")]),_v(" "),_m(32),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(33),_v(" "),_c('p',[_v("Edits an existing patient in DocTrack.")]),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" When trying to add tags while keeping existing tags, remember to type in all the pre-existing tags with your new tags.")])]),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" When editing the name of a person, the person's appointments will not reflect the name change until a reload\nof the application.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(44),_v(" "),_c('p',[_v("You can delete a specified person from the patient book.")]),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Make sure you have the correct index of the patient before deleting. Use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(" to check.")])]),_v(" "),_m(47),_v(" "),_m(48),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have selected the correct person before deleting.\nNote that deleting a person will also delete all related appointments.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(49),_v(" "),_c('p',[_v("You can delete all person entries from the patient book.")]),_v(" "),_m(50),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have a backup of the patient data before clearing.\nNote that this will also clear the appointment data.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_c('br'),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_c('p',[_v("You can manage the appointments through different commands, which can be seen in the table below:")]),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_c('br'),_v(" "),_m(58),_c('br'),_v(" "),_m(59),_v(" "),_c('p',[_v("You can add an appointment to DocTrack.")]),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" You can decide to leave out sickness and medicine inputs when adding them, then edit them later.")])]),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_c('box',{attrs:{"type":"info","light":"","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Although you type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DATE_TIME")]),_v(" in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yyyy-MM-dd HH:mm")]),_v(", you will see it displayed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Month Date, Year, Time")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" You will see "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-10 12:30")]),_v(" displayed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("December 10, 2024, 12:30 PM")]),_v(".")])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Ensure that you enter a "),_c('strong',[_v("unique person, date and time,\nand appointment type")]),_v(" for the appointment you are adding. Else, it will be detected as a duplicate, and an error message will be shown.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(64),_v(" "),_c('p',[_v("You can view a list of all appointments in the appointment book.")]),_v(" "),_m(65),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(66),_v(" "),_c('p',[_v("You can an existing appointment in appointment book.")]),_v(" "),_m(67),_v(" "),_m(68),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(71),_v(" "),_c('p',[_v("You can find appointments whose person names and / or dates contain any of the given keywords.")]),_v(" "),_m(72),_v(" "),_m(73),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt")]),_v(" command to filter out appointments for a certain day or patient.")])]),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(76),_v(" "),_c('p',[_v("You can delete a specified appointment from appointment book.")]),_v(" "),_m(77),_v(" "),_m(78),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")]),_v(" to check the index of the appointment before deleting one.")])]),_v(" "),_m(79),_v(" "),_m(80),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have selected the correct appointment before deleting.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(81),_v(" "),_c('p',[_v("You can delete all appointment entries from the appointment book.")]),_v(" "),_m(82),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nThis action is irreversible. Ensure you have a backup of the appointment data before clearing.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(83),_v(" "),_m(84),_v(" "),_m(85),_c('br'),_v(" "),_m(86),_v(" "),_c('p',[_v("You will be able to view a help window that directs you to this user guide.")]),_v(" "),_m(87),_v(" "),_c('img',{attrs:{"src":"/tp/images/helpMessage.png","alt":"Help Message","width":"540px"}}),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(88),_v(" "),_c('p',[_v("You will be able to exit the DocTrack application.")]),_v(" "),_m(89),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(90),_v(" "),_c('p',[_v("The data of the patients and appointments are saved in the hard disk automatically after you run any command that changes the data. You do not need to save them manually.")]),_v(" "),_m(91),_v(" "),_c('br'),_v(" "),_m(92),_v(" "),_m(93),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Caution:")])]),_v(" "),_c('ul',[_c('li',[_v("If your changes to the data file makes its format invalid, DocTrack will discard all data and start with an empty data file at the next run. Hence, it is recommended that you have a backup of the file before\nediting it."),_c('br')]),_v(" "),_c('li',[_v("Furthermore, certain edits can cause DocTrack to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, you should edit the data file only if you are confident that you\ncan update it correctly.")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(94),_v(" "),_m(95),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(96),_v(" "),_m(97),_m(98),_v(" "),_m(99),_m(100),_v(" "),_m(101),_v(" "),_m(102),_v(" "),_c('br'),_v(" "),_m(103),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_c('br'),_v(" "),_m(105),_v(" "),_m(106),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_c('br'),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111)],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-guide"}},[_v("User Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#introduction"}},[_v("Introduction‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#interacting-with-doctrack"}},[_v("Interacting with DocTrack‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-overview"}},[_v("Command Overview‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#person-commands"}},[_v("Person Commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appointment-commands"}},[_v("Appointment Commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-commands"}},[_v("General Commands‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#faq"}},[_v("FAQ‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#known-issues"}},[_v("Known issues‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(112)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("DocTrack")])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/index.html"}},[_v("Home")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/se-edu/addressbook-level3","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])])],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"fw-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_v("Site Map")])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/index.html"}},[_v("Home")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html"}},[_v("User Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_m(1),_v(" "),_c('box',{attrs:{"type":"info","light":"","theme":"primary"}},[_c('b',[_v("DocTrack")]),_v(" is a desktop application for "),_c('b',[_v("general practitioners (GPs)")]),_v(" to quickly access patient \ncontact details, appointments, and treatment records.\n"),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" aims to be the bridge for general practitioners in smaller clinics towards the digitalisation of their administrative efforts, with a focus on contact management and visit history tracking.")]),_v(" "),_c('br'),_v("\nWe plan to help you simplify and speed-up the administrative burden of patient management through an \nintuitive and efficient application.\n")]),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('p',[_v("... all with an intuitive and user-friendly interface!")]),_v(" "),_c('br'),_v(" "),_c('p',[_v("To get started, you can read the introduction below, which shows all the different sections in this user guide.")]),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_m(4),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-success",attrs:{"href":"#quick-start"}},[_v("Quick Start")])]),_v(" "),_c('p',[_v("Quickly get started with DocTrack!")]),_v(" "),_c('p',[_v("Click on this section for a quick set-up guide, with examples of commands that you can use, out of the box.")])]),_v(" "),_c('box',{attrs:{"type":"info","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-info",attrs:{"href":"#interacting-with-doctrack"}},[_v("Interacting with DocTrack")])]),_v(" "),_c('p',[_v("Learn how you can interact with DocTrack!")]),_v(" "),_c('p',[_v("DocTrack functions through a set of commands. Click on this section to learn more.")])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command Overview")])]),_v(" "),_c('p',[_v("Click on this section to know more about the commands you can use in DocTrack.\nFor more specifics, click on the subsections below.")]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v("\nClick on this section for a rough summary of all the commands related to persons.")])]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v("\nClick on this section for a rough summary of all the commands related to appointments.")])]),_v(" "),_c('box',{attrs:{"light":""}},[_c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")]),_v("\nClick on this section for a rough summary of all the general commands.")])])],1),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-warning",attrs:{"href":"#faq"}},[_v("FAQs")])]),_v(" "),_c('p',[_v("Have questions? Read here to see answer to commonly asked questions.")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('a',{staticClass:"badge bg-warning",attrs:{"href":"#known-issues"}},[_v("Known issues")])]),_v(" "),_c('p',[_v("Having a problem? Read here to see some common issues that may arise while you are using DocTrack.")])]),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('br'),_v(" "),_m(7),_v(" "),_c('br'),_v(" "),_m(8),_v(" "),_c('br'),_v(" "),_m(9),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_c('br'),_v(" "),_m(11),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")])]),_v(" "),_c('p',[_v("This would be a good time to run the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")]),_v(" command, to start afresh without sample data.")])]),_v(" "),_c('br'),_v(" "),_m(12),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(13),_v(" "),_m(14),_v(" "),_m(15),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_v("Here are some "),_c('strong',[_v("key points")]),_v(" to keep in mind when you are using the commands:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Appointments")]),_v(" are sorted by "),_c('strong',[_v("date")]),_v(". "),_c('strong',[_v("Patients")]),_v(" are sorted in "),_c('strong',[_v("chronological")]),_v(" order.")])]),_v(" "),_c('li',[_c('p',[_v("You should supply "),_c('strong',[_v("all")]),_v(" the fields (words in "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UPPER_CASE")])]),_v(") that are needed for a command."),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" In "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/NAME")]),_v(", "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")])]),_v(" is a field which can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/John Doe")]),_v(".")])])]),_v(" "),_c('li',[_c('p',[_v("The "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("INDEX")])]),_v(" in command formats like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person INDEX")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete appt INDEX")]),_v(" refers to the index\nnumber (shown beside the person or appointment) in the displayed list. The index "),_c('strong',[_v("must be a positive integer i.e. 1, 2, 3...")]),_v(" "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" The index of the first person displayed at the top the list is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("1")]),_v(", the index of the second person displayed is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2")]),_v(", and so on.")])])]),_v(" "),_c('li',[_c('p',[_v("Items in "),_c('strong',[_v("square")]),_v(" brackets "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[]")])]),_v(" are "),_c('strong',[_v("optional")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/NAME [t/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe t/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe")]),_v(".")])])]),_v(" "),_c('li',[_c('p',[_v("Items with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("…​")]),_v(" after them can be used "),_c('strong',[_v("zero times or more times")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[t/TAG]…​")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}}),_v(" (i.e. 0 times), "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")]),_v(" etc.")])])]),_v(" "),_c('li',[_c('p',[_v("You can add fields in "),_c('strong',[_v("any order")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" If the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/NAME p/PHONE_NUMBER")]),_v(", then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("p/PHONE_NUMBER n/NAME")]),_v(" is also acceptable.")])])])]),_v(" "),_c('box',{staticStyle:{"border":"1px solid"},attrs:{"type":"tip","theme":"success","light":""}},[_c('p',[_c('strong',[_v("Tip:")])]),_v(" "),_c('p',[_v("If you add extraneous fields for commands that do not take in fields (such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(",\n"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v("), they will be ignored. "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" If the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help 123")]),_v(", then it will be interpreted as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(".")])])]),_v(" "),_c('box',{staticStyle:{"border":"1px solid red"},attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Caution:")])]),_v(" "),_c('p',[_v("If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines. This is because some space characters surrounding line-breaks may be omitted when copied over.")])])],1),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(16),_v(" "),_c('p',[_v("The following sections describe the various commands you can use in the DocTrack application.")]),_v(" "),_c('hr'),_v(" "),_m(17),_v(" "),_m(18),_c('br'),_v(" "),_c('hr'),_v(" "),_m(19),_v(" "),_m(20),_c('br'),_v(" "),_c('hr'),_v(" "),_m(21),_v(" "),_m(22),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_m(23),_v(" "),_m(24),_v(" "),_m(25),_c('box',{attrs:{"type":"info","light":"","seamless":""}},[_c('p',[_c('strong',[_v("Notes:")])]),_v(" "),_c('p',[_c('strong',[_v("1.")]),_v(" The "),_c('strong',[_v("email")]),_v(" must have")]),_v(" "),_c('ul',[_c('li',[_v("a local part containing alphanumeric characters and specific symbols (such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("+")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-")]),_v(") (not at the start or end),")]),_v(" "),_c('li',[_v("followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(", and a domain part with labels separated by periods,")]),_v(" "),_c('li',[_v("ending in a label with at least two alphanumeric characters,")]),_v(" "),_c('li',[_v("and no labels starting or ending with hyphens.")])])]),_v(" "),_c('p',[_v("You can identify these patients uniquely by their "),_c('strong',[_v("patient ID (PID)")]),_v(" for easy reference.\nThe "),_c('strong',[_v("PID")]),_v(" can be seen in the top right corner of their information card, as shown below:"),_c('br'),_c('br'),_v(" "),_c('img',{staticStyle:{"display":"block","margin-left":"auto","margin-right":"auto"},attrs:{"src":"/tp/images/personexample.png","width":"480"}}),_v(" "),_c('br'),_c('sbr')],1),_v(" "),_c('br'),_v(" "),_c('p',[_v("You can also manage the patient information through different commands, which can be seen in the table below:")]),_v(" "),_m(26),_c('br'),_v(" "),_m(27),_v(" "),_c('p',[_v("You can add a person to the patient book.")]),_v(" "),_m(28),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" A person can have any number of tags (including 0). "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/likes coding")]),_v(" has 2 tags and it is valid.")])])]),_v(" "),_m(29),_v(" "),_m(30),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Ensure that you enter a "),_c('strong',[_v("unique name (case-insensitive) and phone number")]),_v(" for the person you are adding. Else, it will be detected as a duplicate, and an error message will be shown.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(31),_v(" "),_c('p',[_v("You can view a list of all persons in the patient book.")]),_v(" "),_m(32),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(33),_v(" "),_c('p',[_v("Edits an existing patient in DocTrack.")]),_v(" "),_m(34),_v(" "),_m(35),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" When trying to add tags while keeping existing tags, remember to type in all the pre-existing tags with your new tags.")])]),_v(" "),_m(36),_v(" "),_m(37),_v(" "),_c('box',{attrs:{"type":"info","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" When editing the name of a person, the person's appointments will not reflect the name change until a reload\nof the application.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_m(40),_v(" "),_m(41),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(44),_v(" "),_c('p',[_v("You can delete a specified person from the patient book.")]),_v(" "),_m(45),_v(" "),_m(46),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Make sure you have the correct index of the patient before deleting. Use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(" to check.")])]),_v(" "),_m(47),_v(" "),_m(48),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have selected the correct person before deleting.\nNote that deleting a person will also delete all related appointments.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(49),_v(" "),_c('p',[_v("You can delete all person entries from the patient book.")]),_v(" "),_m(50),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have a backup of the patient data before clearing.\nNote that this will also clear the appointment data.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(51),_v(" "),_m(52),_v(" "),_m(53),_c('br'),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_c('p',[_v("You can manage the appointments through different commands, which can be seen in the table below:")]),_v(" "),_c('box',{attrs:{"type":"info","light":"","seamless":""}},[_c('p',[_c('strong',[_v("Notes:")])]),_v(" "),_c('p',[_c('strong',[_v("1.")]),_v(" Acceptable inputs for "),_c('strong',[_v("Date and Time")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("The time is in 24-hour format, i.e. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("HH:mm")]),_v(" should be between "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("00:00")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("23:59")]),_v(".")]),_v(" "),_c('li',[_v("The date and time inputs are resolved \"smartly\" - meaning that certain incorrect dates will be allowed."),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2025-02-29 12:00")]),_v(" will be parsed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2025-02-28 12:00")]),_v(".")])])])]),_v(" "),_c('br'),_v(" "),_m(56),_c('br'),_v(" "),_m(57),_v(" "),_c('p',[_v("You can add an appointment to DocTrack.")]),_v(" "),_m(58),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" You can decide to leave out sickness and medicine inputs when adding them, then edit them later.")])]),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_c('box',{attrs:{"type":"info","light":"","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Although you type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DATE_TIME")]),_v(" in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yyyy-MM-dd HH:mm")]),_v(", you will see it displayed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Month Date, Year, Time")]),_v(". "),_c('br'),_v(" "),_c('em',[_c('strong',[_v("Example:")]),_v(" You will see "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-10 14:30")]),_v(" displayed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("December 10, 2024, 2:30 PM")]),_v(".")])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Ensure that you enter a "),_c('strong',[_v("unique person, date and time,\nand appointment type")]),_v(" for the appointment you are adding. Else, it will be detected as a duplicate, and an error message will be shown.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(61),_v(" "),_c('p',[_v("You can view a list of all appointments in the appointment book.")]),_v(" "),_m(62),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(63),_v(" "),_c('p',[_v("You can an existing appointment in appointment book.")]),_v(" "),_m(64),_v(" "),_m(65),_v(" "),_m(66),_v(" "),_m(67),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(68),_v(" "),_c('p',[_v("You can find appointments whose person names and / or dates contain any of the given keywords.")]),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt")]),_v(" command to filter out appointments for a certain day or patient.")])]),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(73),_v(" "),_c('p',[_v("You can delete a specified appointment from appointment book.")]),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_c('box',{attrs:{"type":"tip","light":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")]),_v(" to check the index of the appointment before deleting one.")])]),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" This action is irreversible. Ensure you have selected the correct appointment before deleting.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(78),_v(" "),_c('p',[_v("You can delete all appointment entries from the appointment book.")]),_v(" "),_m(79),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nThis action is irreversible. Ensure you have a backup of the appointment data before clearing.")])]),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(80),_v(" "),_m(81),_v(" "),_m(82),_c('br'),_v(" "),_m(83),_v(" "),_c('p',[_v("You will be able to view a help window that directs you to this user guide.")]),_v(" "),_m(84),_v(" "),_c('img',{attrs:{"src":"/tp/images/helpMessage.png","alt":"Help Message","width":"540px"}}),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(85),_v(" "),_c('p',[_v("You will be able to exit the DocTrack application.")]),_v(" "),_m(86),_v(" "),_c('br'),_v(" "),_c('box',{staticStyle:{"background":"#eeeeee"}},[_c('p',[_c('strong',[_v("Navigate back to the subsections here:")]),_v(" "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command overview")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v(" "),_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")])])]),_v(" "),_c('br'),_v(" "),_m(87),_v(" "),_c('p',[_v("The data of the patients and appointments are saved in the hard disk automatically after you run any command that changes the data. You do not need to save them manually.")]),_v(" "),_m(88),_v(" "),_c('br'),_v(" "),_m(89),_v(" "),_m(90),_v(" "),_c('box',{attrs:{"type":"warning","light":""}},[_c('p',[_c('strong',[_v("Caution:")])]),_v(" "),_c('ul',[_c('li',[_v("If your changes to the data file makes its format invalid, DocTrack will discard all data and start with an empty data file at the next run. Hence, it is recommended that you have a backup of the file before\nediting it."),_c('br')]),_v(" "),_c('li',[_v("Furthermore, certain edits can cause DocTrack to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, you should edit the data file only if you are confident that you\ncan update it correctly.")])])]),_v(" "),_c('br'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(91),_v(" "),_m(92),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(93),_v(" "),_m(94),_m(95),_v(" "),_m(96),_m(97),_v(" "),_m(98),_v(" "),_m(99),_v(" "),_c('br'),_v(" "),_m(100),_v(" "),_c('br'),_v(" "),_m(101),_v(" "),_c('br'),_v(" "),_m(102),_v(" "),_m(103),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_c('br'),_v(" "),_m(107),_v(" "),_c('br'),_v(" "),_m(108)],1),_v(" "),_c('overlay-source',{attrs:{"id":"page-nav","tag-name":"nav","to":"page-nav"}},[_c('div',{staticClass:"nav-component slim-scroll"},[_c('overlay-source',{staticClass:"nav nav-pills flex-column my-0 small no-flex-wrap",attrs:{"id":"mb-page-nav","tag-name":"nav","to":"mb-page-nav"}},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#user-guide"}},[_v("User Guide‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#introduction"}},[_v("Introduction‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#interacting-with-doctrack"}},[_v("Interacting with DocTrack‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-overview"}},[_v("Command Overview‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#person-commands"}},[_v("Person Commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#appointment-commands"}},[_v("Appointment Commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#general-commands"}},[_v("General Commands‎")])]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#faq"}},[_v("FAQ‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#known-issues"}},[_v("Known issues‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(109)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -164,7 +164,7 @@ with(this){return _c('h3',{attrs:{"id":"appointment-commands"}},[_c('strong',[_v with(this){return _c('p',[_v("An "),_c('strong',[_v("appointment")]),_v(" is defined by several fields. The fields and their corresponding prefixes are as follows:")])} },function anonymous( ) { -with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Field")]),_v(" "),_c('th',[_v("Prefix")]),_v(" "),_c('th',[_v("Optional")]),_v(" "),_c('th',[_v("Multiple")]),_v(" "),_c('th',[_v("Acceptable Inputs")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('strong',[_v("Person ID")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("i/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Existing person ID")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Appointment Type")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ty/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Any value")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Date and Time")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yyyy-MM-dd HH:mm")]),_v(". Refer to 1. below")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Sickness")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("s/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("At least one alphabetic character")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Medicine")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("m/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("At least one alphabetic character")])])])])])} +with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Field")]),_v(" "),_c('th',[_v("Prefix")]),_v(" "),_c('th',[_v("Optional")]),_v(" "),_c('th',[_v("Multiple")]),_v(" "),_c('th',[_v("Acceptable Inputs")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('strong',[_v("Person ID")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("i/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Existing person ID")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Appointment Type")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ty/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Any value")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Date and Time")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yyyy-MM-dd HH:mm")]),_v(". Refer to "),_c('strong',[_v("1.")]),_v(" below")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Sickness")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("s/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("At least one alphabetic character")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Medicine")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("m/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("At least one alphabetic character")])])])])])} },function anonymous( ) { with(this){return _c('p',[_v("You can identify these appointments uniquely by their "),_c('strong',[_v("Appointment ID (AID)")]),_v(" for easy reference.\nThe "),_c('strong',[_v("AID")]),_v(" can be seen in the top right corner of their information card, as shown below:"),_c('br'),_c('br'),_v(" "),_c('img',{staticStyle:{"display":"block","margin-left":"auto","margin-right":"auto"},attrs:{"src":"/tp/images/appointmentexample.png","width":"480"}})])} @@ -173,12 +173,6 @@ with(this){return _c('p',[_v("You can identify these appointments uniquely by th with(this){return _c('ul',[_c('li',[_v("The number indicated beside the appointment name is the "),_c('strong',[_v("PID")]),_v(" of the person who has the appointment.")])])} },function anonymous( ) { -with(this){return _c('p',[_c('strong',[_v("Notes:")])])} -},function anonymous( -) { -with(this){return _c('ol',[_c('li',[_v("The date and time inputs are resolved \"smartly\" - meaning that certain incorrect dates will be allowed, e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2025-02-29 12:00")]),_v(" will be parsed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2025-02-28 12:00")]),_v(".")])])} -},function anonymous( -) { with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Action")]),_v(" "),_c('th',[_v("Format")]),_v(" "),_c('th',[_v("Examples")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#adding-an-appointment-add-appt"}},[_v("Add appointment")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add appt i/PERSON_ID d/DATE_TIME ty/APPOINTMENT_TYPE [s/SICKNESS] [m/MEDICINE]")]),_v(" "),_c('br'),_v(" "),_c('br')]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add appt i/1 d/2024-12-01 09:30 ty/Consulation s/Diabetes m/Insulin")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#listing-all-appointments-list-appt"}},[_v("List all appointments")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list appt")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#editing-an-appointment-edit-appt"}},[_v("Edit appointment")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit appt INDEX [i/PERSON_ID] [d/DATE_TIME] [ty/APPOINTMENT_TYPE] [s/SICKNESS] [m/MEDICINE]")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit appt 3 d/2024-12-05 13:00 m/Panadol")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#finding-appointments-by-name-and-date-find-appt"}},[_v("Find appointment")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt KEYWORD [MORE_KEYWORDS]")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt d/2024-12-05")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#deleting-an-appointment-delete-appt"}},[_v("Delete appointment")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete appt INDEX")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete appt 2")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#clearing-all-appointments-clear-appt"}},[_v("Clear all appointments")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear appt")]),_v(" "),_c('br')]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear appt")])])])])])])} },function anonymous( ) { @@ -188,9 +182,6 @@ with(this){return _c('h5',{attrs:{"id":"adding-an-appointment-add-appt"}},[_v("A with(this){return _c('p',[_c('strong',[_v("Format")]),_v(": "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add appt i/PERSON_ID ty/APPOINTMENT_TYPE d/DATE_TIME [s/SICKNESS] [m/MEDICINE]")])])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_v("The format of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DATE_TIME")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yyyy-MM-dd HH:mm")]),_v(". For example, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2025-03-20 10:30")]),_v(".")])])} -},function anonymous( -) { with(this){return _c('p',[_c('strong',[_v("Examples")]),_v(":")])} },function anonymous( ) { @@ -341,6 +332,6 @@ with(this){return _c('ol',{attrs:{"start":"3"}},[_c('li',[_v("On "),_c('strong', with(this){return _c('ol',{attrs:{"start":"4"}},[_c('li',[_v("Editing the name in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person")]),_v(" command will not reflect the name change in the appointments until a reload of the application.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index 37c6d684d03..b9221161fa1 100644 --- a/index.html +++ b/index.html @@ -19,7 +19,7 @@
  • About Us

    • DocTrack

    CI Status Codecov

    Ui

    DocTrack is a desktop application for general practitioners (GPs) to quickly access patient contact details, appointments, and treatment records. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
    +place to start.

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index 0d121d4bcbc..c3ae62b9272 100644 --- a/index.page-vue-render.js +++ b/index.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"doctrack"}},[_v("DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-W10-2/tp/actions"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://github.com/AY2425S1-CS2103T-W10-2/tp/workflows/Java%20CI/badge.svg","alt":"CI Status"}})]),_v(" "),_c('a',{attrs:{"href":"https://codecov.io/gh/AY2425S1-CS2103T-W10-2/tp"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://codecov.io/gh/AY2425S1-CS2103T-W10-2/tp/graph/badge.svg?token=134QRO3UI3","alt":"Codecov"}})])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/Ui.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/Ui.png","alt":"Ui"}})])]),_v(" "),_c('p',[_c('strong',[_v("DocTrack is a desktop application for general practitioners (GPs) to quickly access patient contact\ndetails, appointments, and treatment records.")]),_v(" While it has a GUI, most of the user\ninteractions happen using a CLI (Command Line Interface).")]),_v(" "),_c('ul',[_c('li',[_v("If you are interested in using DocTrack, head over to the "),_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_c('em',[_v("Quick Start")]),_v(" section of the "),_c('strong',[_v("User Guide")])]),_v(".")]),_v(" "),_c('li',[_v("If you are interested about developing DocTrack, the "),_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_c('strong',[_v("Developer Guide")])]),_v(" is a good\nplace to start.")])]),_v(" "),_c('p',[_c('strong',[_v("Acknowledgements")])]),_v(" "),_c('ul',[_c('li',[_v("Libraries used: "),_c('a',{attrs:{"href":"https://openjfx.io/"}},[_v("JavaFX")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/FasterXML/jackson"}},[_v("Jackson")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/junit-team/junit5"}},[_v("JUnit5")])])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/choiwab.html b/team/choiwab.html index 6712cc515e9..c337924f21b 100644 --- a/team/choiwab.html +++ b/team/choiwab.html @@ -16,7 +16,7 @@ Search

      Project: DocTrack

      DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

      Given below are my contributions to the project.

      [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
      +
    • About Us

      • Project: DocTrack

      DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

      Given below are my contributions to the project.

      [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
      diff --git a/team/choiwab.page-vue-render.js b/team/choiwab.page-vue-render.js index ed16af81070..bf00de98529 100644 --- a/team/choiwab.page-vue-render.js +++ b/team/choiwab.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/jayjay19630.html b/team/jayjay19630.html index 818e1172cac..7eebaaa6df9 100644 --- a/team/jayjay19630.html +++ b/team/jayjay19630.html @@ -16,7 +16,7 @@ Search

        Project: DocTrack

        DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

        Given below are my contributions to the project.

        [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
        +
      • About Us

        • Project: DocTrack

        DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

        Given below are my contributions to the project.

        [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
        diff --git a/team/jayjay19630.page-vue-render.js b/team/jayjay19630.page-vue-render.js index ed16af81070..bf00de98529 100644 --- a/team/jayjay19630.page-vue-render.js +++ b/team/jayjay19630.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/rxchell.html b/team/rxchell.html index 415e13bbbb3..b47b2566d2b 100644 --- a/team/rxchell.html +++ b/team/rxchell.html @@ -16,7 +16,7 @@ Search

          Project: DocTrack

          DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

          Given below are my contributions to the project.

          • Refactored abstraction for ListCommand to support new command format
          • Implemented the DeleteAppointmentCommand
          • Added a Status attribute in the Person class
          • Modified the Sickness and Medicine attributes to be optional in the Appointment class
          • Updated the FindPersonCommand to search for a person by name
          • Added tests for the above changes
          • Created tests for AppointmentBookStorage
          • Updated the format of the User Guide and Developer Guide to ensure consistency
          • Updated the contents of the User Guide and Developer Guide to ensure accuracy
          [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
          +
        • About Us

          • Project: DocTrack

          DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

          Given below are my contributions to the project.

          • Refactored abstraction for ListCommand to support new command format
          • Implemented the DeleteAppointmentCommand
          • Added a Status attribute in the Person class
          • Modified the Sickness and Medicine attributes to be optional in the Appointment class
          • Updated the FindPersonCommand to search for a person by name
          • Added tests for the above changes
          • Created tests for AppointmentBookStorage
          • Updated the format of the User Guide and Developer Guide to ensure consistency
          • Updated the contents of the User Guide and Developer Guide to ensure accuracy
          [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
          diff --git a/team/rxchell.page-vue-render.js b/team/rxchell.page-vue-render.js index 62ba57cb1f3..73bec122698 100644 --- a/team/rxchell.page-vue-render.js +++ b/team/rxchell.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_v("Refactored abstraction for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ListCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Implemented the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteAppointmentCommand")])]),_v(" "),_c('li',[_v("Added a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Status")]),_v(" attribute in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Person")]),_v(" class")]),_v(" "),_c('li',[_v("Modified the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sickness")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Medicine")]),_v(" attributes to be optional in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Appointment")]),_v(" class")]),_v(" "),_c('li',[_v("Updated the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindPersonCommand")]),_v(" to search for a person by name")]),_v(" "),_c('li',[_v("Added tests for the above changes")]),_v(" "),_c('li',[_v("Created tests for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AppointmentBookStorage")])]),_v(" "),_c('li',[_v("Updated the format of the User Guide and Developer Guide to ensure consistency")]),_v(" "),_c('li',[_v("Updated the contents of the User Guide and Developer Guide to ensure accuracy")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/vangmay.html b/team/vangmay.html index 105ae895f60..cc34364b070 100644 --- a/team/vangmay.html +++ b/team/vangmay.html @@ -16,7 +16,7 @@ Search

            Project: DocTrack

            DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

            Role:

            • Developer
            • QA Tester
            • Responsible for overseeing Logic

            Given below are my contributions to the project:

            • Refactor Find Persons Command
            • Create add appointment command
            • Create AppointmentDescriptor in the AppointmentModel
            • Created tests for Appointment book
            • Wrote test cases to increase code coverage
            • Implement changes in UI to add 2 windows
            • Update user guide
            • Update Developer guide (Find, List, Clear appt)
            [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
            +
          • About Us

            • Project: DocTrack

            DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

            Role:

            • Developer
            • QA Tester
            • Responsible for overseeing Logic

            Given below are my contributions to the project:

            • Refactor Find Persons Command
            • Create add appointment command
            • Create AppointmentDescriptor in the AppointmentModel
            • Created tests for Appointment book
            • Wrote test cases to increase code coverage
            • Implement changes in UI to add 2 windows
            • Update user guide
            • Update Developer guide (Find, List, Clear appt)
            [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
            diff --git a/team/vangmay.page-vue-render.js b/team/vangmay.page-vue-render.js index de6c8298bad..0eac4baeb89 100644 --- a/team/vangmay.page-vue-render.js +++ b/team/vangmay.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Role:")]),_v(" "),_c('ul',[_c('li',[_v("Developer")]),_v(" "),_c('li',[_v("QA Tester")]),_v(" "),_c('li',[_v("Responsible for overseeing Logic")])]),_v(" "),_c('p',[_v("Given below are my contributions to the project:")]),_v(" "),_c('ul',[_c('li',[_v("Refactor Find Persons Command")]),_v(" "),_c('li',[_v("Create add appointment command")]),_v(" "),_c('li',[_v("Create AppointmentDescriptor in the AppointmentModel")]),_v(" "),_c('li',[_v("Created tests for Appointment book")]),_v(" "),_c('li',[_v("Wrote test cases to increase code coverage")]),_v(" "),_c('li',[_v("Implement changes in UI to add 2 windows")]),_v(" "),_c('li',[_v("Update user guide")]),_v(" "),_c('li',[_v("Update Developer guide (Find, List, Clear appt)")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/zaidansani.html b/team/zaidansani.html index 429d35934b6..2c4e0fe965e 100644 --- a/team/zaidansani.html +++ b/team/zaidansani.html @@ -16,7 +16,7 @@ Search

              Project: DocTrack

              DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

              Role:

              • Team Lead
              • Developer
              • Integration

              Given below are my contributions to the project:

              • Refactoring Person into PersonDescriptor to support PersonID
              • Refactoring of DeleteCommand to support new command format
              • Refactoring of ClearCommand to support new command format
              • Refactoring of models to support running count for implementation of IDs
              • Updated test cases in the above to work
              • Adding of FindAppointmentCommand
                • Created new predicates
                • Find by date and person name
              • Autosorting of listed appointments by date
              • Autosorting of listed persons by name
              [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]
              +
            • About Us

              • Project: DocTrack

              DocTrack helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.

              Role:

              • Team Lead
              • Developer
              • Integration

              Given below are my contributions to the project:

              • Refactoring Person into PersonDescriptor to support PersonID
              • Refactoring of DeleteCommand to support new command format
              • Refactoring of ClearCommand to support new command format
              • Refactoring of models to support running count for implementation of IDs
              • Updated test cases in the above to work
              • Adding of FindAppointmentCommand
                • Created new predicates
                • Find by date and person name
              • Autosorting of listed appointments by date
              • Autosorting of listed persons by name
              [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]
              diff --git a/team/zaidansani.page-vue-render.js b/team/zaidansani.page-vue-render.js index e7d48b67a01..7408c6df095 100644 --- a/team/zaidansani.page-vue-render.js +++ b/team/zaidansani.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h3',{attrs:{"id":"project-doctrack"}},[_v("Project: DocTrack"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-doctrack","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("DocTrack")]),_v(" helps general practitioners (GPs) at small clinics quickly access patient contact details, appointments, and treatment records. It is optimized for users who prefer a command-line interface (CLI), enabling faster completion of frequent tasks through typed commands.")]),_v(" "),_c('hr'),_v(" "),_c('p',[_v("Role:")]),_v(" "),_c('ul',[_c('li',[_v("Team Lead")]),_v(" "),_c('li',[_v("Developer")]),_v(" "),_c('li',[_v("Integration")])]),_v(" "),_c('p',[_v("Given below are my contributions to the project:")]),_v(" "),_c('ul',[_c('li',[_v("Refactoring Person into PersonDescriptor to support PersonID")]),_v(" "),_c('li',[_v("Refactoring of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DeleteCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Refactoring of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ClearCommand")]),_v(" to support new command format")]),_v(" "),_c('li',[_v("Refactoring of models to support running count for implementation of IDs")]),_v(" "),_c('li',[_v("Updated test cases in the above to work")]),_v(" "),_c('li',[_v("Adding of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FindAppointmentCommand")]),_v(" "),_c('ul',[_c('li',[_v("Created new predicates")]),_v(" "),_c('li',[_v("Find by date and person name")])])]),_v(" "),_c('li',[_v("Autosorting of listed appointments by date")]),_v(" "),_c('li',[_v("Autosorting of listed persons by name")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:01:31 GMT+8]")])])])} +with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Mon, 11 Nov 2024, 20:25:24 GMT+8]")])])])} }]; \ No newline at end of file