From 0f98ca4b0bed446661096076e8da21dc1305c503 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 11:50:05 +0000 Subject: [PATCH] deploy: c7cf3c62d9f3ceed2f0733d1074b3c7a229e1174 --- 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 | 2 +- DeveloperGuide.page-vue-render.js | 2 +- 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 | 57 +++++++++++++---------------- UserGuide.page-vue-render.js | 37 +++++++------------ 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, 68 insertions(+), 82 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index e5bb57aca37..74270b4afdc 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 ccac786d304..4a055aa6aa6 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index f8477613e5f..793ffc459aa 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 9ba7ed2f64d..01b467869cf 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index 6a7ee2f5f33..584f5d9c1de 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 2a5dd173827..464e2909bd2 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index c2e0e291d2e..29736acaea1 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -127,7 +127,7 @@
    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.
  • 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

    Effort Required

    Our project involved substantial effort in several key areas:

    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.


    +that each command and feature worked as expected for both entity types.

    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 cf48610fa67..60bfde7a12c 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -680,6 +680,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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index 1dd683ef5d5..59b8723ee3c 100644 --- a/Documentation.html +++ b/Documentation.html @@ -16,7 +16,7 @@ Search

    Documentation Guide

    Style guidance:

    Converting to PDF

    +
  • About Us

    • Documentation Guide

    Style guidance:

    Converting to PDF

    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 3e3db7548a6..587ec4c2ca9 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 0968eb54016..3822e630921 100644 --- a/Logging.html +++ b/Logging.html @@ -16,7 +16,7 @@ Search

    Logging guide

    +
  • About Us

    • Logging guide

    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index 306075dee72..26dbc840df2 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index 70dc1eddf12..9dc9cabe2eb 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.

    +These tutorials will help you get acquainted with the codebase.

    diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index 9a6dc025077..f8377fd818b 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index c2940144991..dde97235e60 100644 --- a/Testing.html +++ b/Testing.html @@ -20,7 +20,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle

    • 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
    +e.g. seedu.address.logic.LogicManagerTest diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index fe40cb708e9..5dba513c177 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index aa3ba83830f..bb4f2670b23 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -16,16 +16,13 @@ Search

    User Guide

    DocTrack is a desktop application for general practitioners (GPs) to quickly access patient contact -details, appointments, and treatment records. -


    DocTrack aims to be the bridge for medical practitioners in smaller clinics -towards digitalisation of their administrative efforts, with focus on contact management and visit history tracking.


    -We plan on helping you simplify and speed-up the administrative burden of patient management -through an intuitive and efficient application. -

    With DocTrack, you can take the first step towards digitalisation of your practice! -DocTrack aims to simplify your patient and appointment tracking process, by allowing you to

    To get started, you can read the introduction below, which shows all the different sections -in this user guide.

    Introduction

    Quick Start

    Quickly get started with DocTrack!

    Click on this section for a quick set-up guide, with examples of commands that you can use, out of the box.

    Interacting with DocTrack

    Learn how you can interact with DocTrack!

    DocTrack functions through a set of commands. Click on this section to learn more.

    Command Overview

    Click on this section to know more about the commands you can use in DocTrack. +

  • About Us

    • User Guide

    DocTrack is a desktop application for general practitioners (GPs) to quickly access patient +contact details, appointments, and treatment records. +


    DocTrack 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.


    +We plan to help you simplify and speed-up the administrative burden of patient management through an +intuitive and efficient application. +

    With DocTrack, you can take the first step towards digitalisation of your practice! +DocTrack can assist you in streamlining your patient and appointment tracking process, by allowing you to ...

    • easily add and update patient and appointment records,
    • delete records for regulation purposes, and
    • search for records based on important criteria such as dates and names

    ... all with an intuitive and user-friendly interface!


    To get started, you can read the introduction below, which shows all the different sections in this user guide.



    Introduction

    Quick Start

    Quickly get started with DocTrack!

    Click on this section for a quick set-up guide, with examples of commands that you can use, out of the box.

    Interacting with DocTrack

    Learn how you can interact with DocTrack!

    DocTrack functions through a set of commands. Click on this section to learn more.

    Command Overview

    Click on this section to know more about the commands you can use in DocTrack. For more specifics, click on the subsections below.

    Person commands Click on this section for a rough summary of all the commands related to persons.

    Appointment commands Click on this section for a rough summary of all the commands related to appointments.

    General commands @@ -43,29 +40,27 @@
    Ui

    1. Type the command in the command box, which is indicated by Enter command here.... Press Enter to execute it.
      Example: Typing help and pressing Enter will open the help window.

      Some other examples of commands you can enter:

      • list person : Lists all contacts.
      • add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering : Adds a contact named John Doe to the Address Book.
      • delete person 3 : Deletes the 3rd contact shown in the current list.
      • clear person : Deletes all contacts.
      • exit : Exits the app.

    Tip:

    This would be a good time to run the clear person command, to start afresh without sample data.


    1. You can refer to the Command Overview below for details of each command.


    Interacting with DocTrack

    All interactions with the DocTrack platform are done through a series of commands -(explained in Command Overview) entered by you.

    • These commands allow you to perform various tasks, such as adding, editing, listing, deleting, finding, -and clearing persons/appointments.
    • The commands are designed to be flexible and user-friendly. -
      • You can add fields in any order.
      • You can add multiple entries for specific fields.

    Here are some key points to keep in mind when you are using the commands:

    • Appointments are sorted by date and Patients are sorted in chronological order.

    • You should supply all the fields (words in UPPER_CASE) that are needed for a command.
      Example: In add person n/NAME, NAME is a field which can be used as add person n/John Doe.

    • The INDEX in command formats like edit person INDEX and delete appt INDEX refers to the index +(explained in Command Overview) entered by you.

      • These commands allow you to perform various tasks, such as adding, editing, listing, deleting, finding, and clearing persons/appointments.
      • The commands are designed to be flexible and user-friendly.

      Here are some key points to keep in mind when you are using the commands:

      • Appointments are sorted by date. Patients are sorted in chronological order.

      • You should supply all the fields (words in UPPER_CASE) that are needed for a command.
        Example: In add person n/NAME, NAME is a field which can be used as add person n/John Doe.

      • The INDEX in command formats like edit person INDEX and delete appt INDEX refers to the index number (shown beside the person or appointment) in the displayed list. The index must be a positive integer i.e. 1, 2, 3...
        Example: The index of the first person displayed at the top the list is 1, the index of the second person displayed is 2, and so on.

      • Items in square brackets [] are optional.
        Example: n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

      • Items with …​ after them can be used zero times or more times.
        Example:[t/TAG]…​ can be used as (i.e. 0 times), t/friend, t/friend t/family etc.

      • You can add fields in any order.
        Example: If the command specifies n/NAME p/PHONE_NUMBER, then p/PHONE_NUMBER n/NAME is also acceptable.

      Tip:

      If you add extraneous fields for commands that do not take in fields (such as help, list person, list appt, exit and clear), they will be ignored.
      Example: If the command specifies help 123, then it will be interpreted as help.

      Caution:

      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.



      Command Overview

      The following sections describe the various commands you can use in the DocTrack application.

      Person commands -Click this section to know more about the commands, or click on the individual commands below for information -specific to those commands.

      Action Format Examples
      Add person add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​ add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend
      List all persons list person
      		list person
      Edit person edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​ edit person 2 n/James Lee e/jameslee@example.com
      Find person find person KEYWORD [MORE_KEYWORDS] find person n/James Jake
      Delete person delete person INDEX delete person 3
      Clear all persons clear person clear person

      Appointment commands -Click this section to know more about the commands, or click on the individual commands below for information -specific to those commands.

      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

      General commands -Click this section to know more about the commands, or click on the individual commands below for information -specific to those commands.

      Action Format Examples
      Help help help
      Exit exit exit

      Person Commands

      A person is a patient with several fields. The fields and their corresponding prefixes are as follows:

      Field Prefix Optional Multiple Acceptable Inputs
      Name n/ No No Only alphanumeric characters (Cannot start with space)
      Phone number p/ No No Positive integer of length 3-15 (Inclusive)
      Email e/ No No Refer to 1. below
      Address a/ No No Any value
      Status st/ No No Only alphanumeric characters
      Tag(s) t/ Yes Yes Only alphanumeric characters

      You can identify these patients uniquely by their patient ID (PID) for easy reference. -The PID can be seen at the top of their information card.



      Notes

      1. Emails must have a local part containing alphanumeric characters and specific symbols (+_.-) (not at the start or end), followed by @, and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.

      You can also manage the patient information through different commands, which can be seen in the table below:

      Action Format Examples
      Add person add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​ add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend
      List all persons list person
      		list person
      Edit person edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​ edit person 2 n/James Lee e/jameslee@example.com
      Find person find person KEYWORD [MORE_KEYWORDS] find person n/James Jake
      Delete person delete person INDEX delete person 3
      Clear all persons clear person clear person

      Adding a person: add person

      You can add a person to the patient book.

      Format: add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​

      Tip: A person can have any number of tags (including 0).
      Example: t/friend t/likes coding has 2 tags and it is valid.

      Examples:

      • add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering -adds a person named John Doe with phone number 98765432, email johnd@example.com, and address John street, block 123, #01-01, and status recovering.
      • add person n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 st/recovered t/criminal adds a person named Betsy Crowe with email betsycrowe@example.com, address Newgate Prison, phone number 1234567, status recovered, and the tags friend and criminal.

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


      Listing all persons : list person

      You can view a list of all persons in the patient book.

      Format: list person shows the list of all patients on the screen.

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


      Editing a person : edit person

      Edits an existing patient in DocTrack.

      Format: edit person INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​

      • Edits the patient at the specified INDEX.
      • At least one of the optional fields must be provided.
      • Existing values will be updated to the input values.
      • When editing tags, the existing tags of the person will be removed i.e. adding of tags is not cumulative.
      • You can remove all the person’s tags by typing t/ without -specifying any tags after it.

      Examples:

      • list person followed by edit person 1 p/91234567 e/johndoe@example.com edits the phone number and email +⬅ Click on this section to know more about the commands you can use to manage the list of persons. You can also click on the individual commands below for information specific to these commands.

        Action Format Examples
        Add person add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​ add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend
        List all persons list person
        		list person
        Edit person edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​ edit person 2 n/James Lee e/jameslee@example.com
        Find person find person KEYWORD [MORE_KEYWORDS] find person n/James Jake
        Delete person delete person INDEX delete person 3
        Clear all persons clear person clear person

        Appointment commands +⬅ Click on this section to know more about the commands you can use to manage the appointments. You can also click on the individual commands below for information specific to these commands.

        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

        General commands +⬅ Click on this section to know more about the general commands. You can +also click on the individual commands below for information specific to these commands.

        Action Format Examples
        Help help help
        Exit exit exit

        Person Commands

        A person is a patient with several fields. The fields and their corresponding prefixes are as follows:

        Field Prefix Optional Multiple Acceptable Inputs
        Name n/ No No Only alphanumeric characters (Cannot start with space)
        Phone number p/ No No Positive integer of length 3-15 (Inclusive)
        Email e/ No No Refer to 1. below
        Address a/ No No Any value
        Status st/ No No Only alphanumeric characters
        Tag(s) t/ Yes Yes Only alphanumeric characters

        Notes:

        1. The email must have

        • a local part containing alphanumeric characters and specific symbols (such as + _ . -) (not at the start or end),
        • followed by @, and a domain part with labels separated by periods,
        • ending in a label with at least two alphanumeric characters,
        • and no labels starting or ending with hyphens.

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



        You can also manage the patient information through different commands, which can be seen in the table below:

        Action Format Examples
        Add person add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​ add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend
        List all persons list person
        		list person
        Edit person edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​ edit person 2 n/James Lee e/jameslee@example.com
        Find person find person KEYWORD [MORE_KEYWORDS] find person n/James Jake
        Delete person delete person INDEX delete person 3
        Clear all persons clear person clear person

        Adding a person: add person

        You can add a person to the patient book.

        Format: add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​

        Tip: A person can have any number of tags (including 0).
        Example: t/friend t/likes coding has 2 tags and it is valid.

        Examples:

        • add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering +adds a person named John Doe with phone number 98765432, email johnd@example.com, and address John street, block 123, #01-01, and status recovering.
        • add person n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 st/recovered t/criminal adds a person named Betsy Crowe with email betsycrowe@example.com, address Newgate Prison, phone number 1234567, status recovered, and the tags friend and criminal.

        Note: Ensure that you enter a unique name (case-insensitive) and phone number for the person 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 persons : list person

        You can view a list of all persons in the patient book.

        Format: list person shows the list of all patients on the screen.


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


        Editing a person : edit person

        Edits an existing patient in DocTrack.

        Format: edit person INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​

        • Edits the patient at the specified INDEX.
        • At least one of the optional fields must be provided.
        • Existing values will be updated to the input values.
        • When editing tags, the existing tags of the person will be removed i.e. adding of tags is not cumulative.
        • You can remove all the person’s tags by typing t/ without +specifying any tags after it.

        Tip: When trying to add tags while keeping existing tags, remember to type in all the pre-existing tags with your new tags.

        Examples:

        • list person followed by edit person 1 p/91234567 e/johndoe@example.com edits the phone number and email address of the first person in the list to be 91234567 and johndoe@example.com respectively.
        • list person followed by edit person 2 n/Betsy Crower t/ edits the name of the second person in the list to -be Betsy Crower and clears all existing tags.

        Tip: When trying to add tags while keeping existing tags, remember to type in all the pre-existing tags with your new tags.

        Note: When editing the name of a person, the person's appointments will not reflect the name change until a reload -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]

        • Use the prefix n/ to search for names.
        • The search is case-insensitive. e.g. hans will match Hans
        • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
        • Only the name is searched.
        • Only full words will be matched e.g. Han will not match Hans
        • Persons matching at least one keyword will be returned (i.e. OR search). -e.g. Hans Bo will return Hans Gruber, Bo Yang

        Examples:

        • find person n/John returns john and John Doe
        • find person n/alex david returns Alex Yeoh, David Li

          result for 'find person alex david'

        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

        • Deletes the person at the specified INDEX.

        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.

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

        Examples:

        • list person followed by delete person 2 deletes the second person in the list.
        • find Betsy followed by delete person 1 deletes the first person in the results of the find command.

        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 at the top of their information card.



        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. 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]

        • The format of DATE_TIME is yyyy-MM-dd HH:mm. For example, 2025-03-20 10:30.

        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 12:30 displayed as December 10, 2024, 12:30 PM.

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


        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.

        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'


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


        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.

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

        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.

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


        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: -This action is irreversible. Ensure you have a backup of the appointment data before clearing.


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



        General Commands

        General commands can help you with miscellaneous tasks related to patient and appointment management.

        Action Format Examples
        Help help help
        Exit exit exit

        Viewing help : help

        You will be able to view a help window that directs you to this user guide.

        Format: help

        Help Message


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


        Exiting the program : exit

        You will be able to exit the DocTrack application.

        Format: exit


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


        Saving the data

        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.

        • For more information on how the data is stored, you can refer to FAQs.

        Editing the data file

        For advanced users, feel free to update patient and appointment data directly by editing the data files in the +be Betsy Crower and clears all existing tags.

      Note: When editing the name of a person, the person's appointments will not reflect the name change until a reload +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]

      • Use the prefix n/ to search for names.
      • The search is case-insensitive. e.g. hans will match Hans
      • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
      • Only the name is searched.
      • Only full words will be matched e.g. Han will not match Hans
      • Persons matching at least one keyword will be returned (i.e. OR search). +e.g. Hans Bo will return Hans Gruber, Bo Yang

      Examples:

      • find person n/John returns john and John Doe
      • find person n/alex david returns Alex Yeoh, David Li

        result for 'find person alex david'

      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

      • Deletes the person at the specified INDEX.

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

      Examples:

      • list person followed by delete person 2 deletes the second person in the list.
      • find Betsy followed by delete person 1 deletes the first person in the results of the find command.

      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:

      • 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. 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]

      • The format of DATE_TIME is yyyy-MM-dd HH:mm. For example, 2025-03-20 10:30.

      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 12:30 displayed as December 10, 2024, 12: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: +This action is irreversible. Ensure you have a backup of the appointment data before clearing.


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



      General Commands

      General commands can help you with miscellaneous tasks related to patient and appointment management.

      Action Format Examples
      Help help help
      Exit exit exit

      Viewing help : help

      You will be able to view a help window that directs you to this user guide.

      Format: help

      Help Message


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


      Exiting the program : exit

      You will be able to exit the DocTrack application.

      Format: exit


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


      Saving the data

      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.

      • For more information on how the data is stored, you can refer to FAQs.

      Editing the data file

      For advanced users, feel free to update patient and appointment data directly by editing the data files in the data folder. Learn more here: FAQs.

      Caution:

      • 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 editing it.
      • 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 can update it correctly.


      FAQ

      Q: How is my data stored?
      A: Your data is stored in .json files, located in the data @@ -119,7 +114,7 @@



      Q: How do I transfer my data (in the addressbook.json and appointmentbook.json files) to another computer?
      A:

      1. Save the addressbook.json and appointmentbook.json files from the data folder in your current computer.
      2. Install the DocTrack app in the other computer.
      3. When you run DocTrack, it creates empty .json files in the data folder.
      4. 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.




      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, 18:53:32 GMT+8]
    +folder, you can copy these files to another location as a backup.




    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, 19:49:53 GMT+8]
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index d3d304a4ad6..e6b8e01f8c1 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 contact \ndetails, appointments, and treatment records.\n"),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('p',[_v("DocTrack aims to be the bridge for medical practitioners in smaller clinics\ntowards digitalisation of their administrative efforts, with focus on contact management and visit history tracking.")]),_v(" "),_c('br'),_v("\nWe plan on helping you simplify and speed-up the administrative burden of patient management \nthrough an intuitive and efficient application.\n")]),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('p',[_v("To get started, you can read the introduction below, which shows all the different sections\nin this user guide.")]),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_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',[_v("Appointments are sorted by date and Patients are sorted in chronological 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),_m(26),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('img',{attrs:{"src":"/tp/images/personexample.png","width":"500"}}),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('hr'),_v(" "),_m(27),_v(" "),_m(28),_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(29),_c('br'),_v(" "),_m(30),_v(" "),_c('p',[_v("You can add a person to the patient book.")]),_v(" "),_m(31),_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(32),_v(" "),_m(33),_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(34),_v(" "),_c('p',[_v("You can view a list of all persons in the patient book.")]),_v(" "),_m(35),_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(36),_v(" "),_c('p',[_v("Edits an existing patient in DocTrack.")]),_v(" "),_m(37),_v(" "),_m(38),_v(" "),_m(39),_v(" "),_m(40),_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(" "),_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('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(41),_v(" "),_m(42),_v(" "),_m(43),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_m(46),_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(47),_v(" "),_c('p',[_v("You can delete a specified person from the patient book.")]),_v(" "),_m(48),_v(" "),_m(49),_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('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(50),_v(" "),_m(51),_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(52),_v(" "),_c('p',[_v("You can delete all person entries from the patient book.")]),_v(" "),_m(53),_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('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(54),_v(" "),_m(55),_v(" "),_m(56),_m(57),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('img',{attrs:{"src":"/tp/images/appointmentexample.png","width":"500"}}),_v(" "),_c('p',[_c('br'),_c('sbr')],1),_v(" "),_c('p',[_v("The number indicated beside the appointment name is the PID of the person who has the appointment.")]),_v(" "),_c('p',[_v("You can manage the appointments through different commands, which can be seen in the table below:")]),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('br'),_v(" "),_m(60),_c('br'),_v(" "),_m(61),_v(" "),_c('p',[_v("You can add an appointment to DocTrack.")]),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_m(65),_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":"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(" "),_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 view a list of all appointments in the appointment book.")]),_v(" "),_m(67),_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 an existing appointment in appointment book.")]),_v(" "),_m(69),_v(" "),_m(70),_v(" "),_m(71),_v(" "),_m(72),_v(" "),_c('br'),_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 find appointments whose person names and / or dates contain any of the given keywords.")]),_v(" "),_m(74),_v(" "),_m(75),_v(" "),_m(76),_v(" "),_m(77),_v(" "),_c('br'),_v(" "),_m(78),_v(" "),_c('br'),_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(" "),_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(79),_v(" "),_c('p',[_v("You can delete a specified appointment from appointment book.")]),_v(" "),_m(80),_v(" "),_m(81),_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(" "),_m(82),_v(" "),_m(83),_v(" "),_c('br'),_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(" "),_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(84),_v(" "),_c('p',[_v("You can delete all appointment entries from the appointment book.")]),_v(" "),_m(85),_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(86),_v(" "),_m(87),_v(" "),_m(88),_c('br'),_v(" "),_m(89),_v(" "),_c('p',[_v("You will be able to view a help window that directs you to this user guide.")]),_v(" "),_m(90),_v(" "),_c('img',{attrs:{"src":"/tp/images/helpMessage.png","alt":"Help Message","width":"500px"}}),_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(91),_v(" "),_c('p',[_v("You will be able to exit the DocTrack application.")]),_v(" "),_m(92),_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(93),_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(94),_v(" "),_c('br'),_v(" "),_m(95),_v(" "),_m(96),_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(97),_v(" "),_m(98),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(99),_v(" "),_m(100),_m(101),_v(" "),_m(102),_m(103),_v(" "),_m(104),_v(" "),_m(105),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_c('br'),_v(" "),_m(107),_v(" "),_m(108),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_m(110),_v(" "),_c('br'),_v(" "),_m(111),_v(" "),_c('br'),_v(" "),_m(112),_v(" "),_c('br'),_v(" "),_m(113)],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(114)])} +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(" "),_m(105),_v(" "),_c('hr'),_v(" "),_c('br'),_v(" "),_m(106),_v(" "),_m(107),_v(" "),_c('br'),_v(" "),_m(108),_v(" "),_c('br'),_v(" "),_m(109),_v(" "),_c('br'),_v(" "),_m(110)],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(111)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -11,10 +11,10 @@ with(this){return _c('p',[_c('img',{staticStyle:{"height":"100px","display":"blo with(this){return _c('h1',{attrs:{"id":"user-guide"}},[_c('strong',[_v("User Guide")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#user-guide","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('p',[_v("With "),_c('strong',[_v("DocTrack")]),_v(", you can take the first step towards digitalisation of your practice!\n"),_c('strong',[_v("DocTrack")]),_v(" aims to simplify your patient and appointment tracking process, by allowing you to")])} +with(this){return _c('p',[_v("With "),_c('strong',[_v("DocTrack")]),_v(", you can take the first step towards digitalisation of your practice!\n"),_c('strong',[_v("DocTrack")]),_v(" can assist you in streamlining your patient and appointment tracking process, by allowing you to ...")])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_v("easily add and update patient and appointment records.")]),_v(" "),_c('li',[_v("delete records for regulation purposes.")]),_v(" "),_c('li',[_v("search for records based on important criteria such as dates and names\nwith an intuitive and user-friendly interface!")])])} +with(this){return _c('ul',[_c('li',[_v("easily add and update patient and appointment records,")]),_v(" "),_c('li',[_v("delete records for regulation purposes, and")]),_v(" "),_c('li',[_v("search for records based on important criteria such as dates and names")])])} },function anonymous( ) { with(this){return _c('h2',{attrs:{"id":"introduction"}},[_c('strong',[_v("Introduction")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#introduction","onclick":"event.stopPropagation()"}})])} @@ -50,25 +50,25 @@ with(this){return _c('h2',{attrs:{"id":"interacting-with-doctrack"}},[_c('strong with(this){return _c('p',[_v("All interactions with the DocTrack platform are done through a series of "),_c('strong',[_v("commands")]),_v("\n(explained in "),_c('a',{staticClass:"badge bg-primary",attrs:{"href":"#command-overview"}},[_v("Command Overview")]),_v(") entered by you.")])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_v("These commands allow you to perform various "),_c('strong',[_v("tasks")]),_v(", such as adding, editing, listing, deleting, finding,\nand clearing persons/appointments.")]),_v(" "),_c('li',[_v("The commands are designed to be flexible and user-friendly.\n"),_c('ul',[_c('li',[_v("You can add fields in any order.")]),_v(" "),_c('li',[_v("You can add multiple entries for specific fields.")])])])])} +with(this){return _c('ul',[_c('li',[_v("These commands allow you to perform various "),_c('strong',[_v("tasks")]),_v(", such as adding, editing, listing, deleting, finding, and clearing persons/appointments.")]),_v(" "),_c('li',[_v("The commands are designed to be flexible and user-friendly.")])])} },function anonymous( ) { with(this){return _c('h2',{attrs:{"id":"command-overview"}},[_c('strong',[_v("Command Overview")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#command-overview","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v("\nClick this section to know more about the commands, or click on the individual commands below for information\nspecific to those commands.")])} +with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#person-commands"}},[_v("Person commands")]),_v("\n⬅ Click on this section to know more about the commands you can use to manage the list of persons. You can also click on the individual commands below for information specific to these commands.")])} },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-a-person-add-person"}},[_v("Add person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#listing-all-persons-list-person"}},[_v("List all persons")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(" "),_c('br')]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#editing-a-person-edit-person"}},[_v("Edit person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person 2 n/James Lee e/jameslee@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#finding-persons-by-name-find-person"}},[_v("Find person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find person KEYWORD [MORE_KEYWORDS]")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find person n/James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#deleting-a-person-delete-person"}},[_v("Delete person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete person INDEX")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete person 3")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#clearing-all-persons-clear-person"}},[_v("Clear all persons")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")])])])])])])} },function anonymous( ) { -with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v("\nClick this section to know more about the commands, or click on the individual commands below for information\nspecific to those commands.")])} +with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#appointment-commands"}},[_v("Appointment commands")]),_v("\n⬅ Click on this section to know more about the commands you can use to manage the appointments. You can also click on the individual commands below for information specific to these commands.")])} },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( ) { -with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")]),_v("\nClick this section to know more about the commands, or click on the individual commands below for information\nspecific to those commands.")])} +with(this){return _c('p',[_c('a',{staticClass:"badge bg-dark",attrs:{"href":"#general-commands"}},[_v("General commands")]),_v("\n⬅ Click on this section to know more about the general commands. You can\nalso click on the individual commands below for information specific to these commands.")])} },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":"#viewing-help-help"}},[_v("Help")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#exiting-the-program-exit"}},[_v("Exit")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")])])])])])])} @@ -80,16 +80,7 @@ with(this){return _c('h3',{attrs:{"id":"person-commands"}},[_c('strong',[_v("Per with(this){return _c('p',[_v("A "),_c('strong',[_v("person")]),_v(" is a patient with 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("Name")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Only alphanumeric characters (Cannot start with space)")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Phone number")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("p/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Positive integer of length 3-15 (Inclusive)")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Email")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("e/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Refer to 1. below")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Address")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("a/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Any value")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Status")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("st/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Only alphanumeric characters")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Tag(s)")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("Only alphanumeric characters")])])])])])} -},function anonymous( -) { -with(this){return _c('p',[_v("You can identify these patients uniquely by their "),_c('strong',[_v("patient ID (PID)")]),_v(" for easy reference.\nThe PID can be seen at the top of their information card.")])} -},function anonymous( -) { -with(this){return _c('p',[_c('strong',[_v("Notes")])])} -},function anonymous( -) { -with(this){return _c('ol',[_c('li',[_v("Emails must have a local part containing alphanumeric characters and specific symbols ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("+_.-")]),_v(") (not at the start or end), followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(", and a domain part with labels separated by periods, ending in a label with at least two alphanumeric characters, and no labels starting or ending with hyphens.")])])} +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("Name")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Only alphanumeric characters (Cannot start with space)")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Phone number")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("p/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Positive integer of length 3-15 (Inclusive)")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Email")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("e/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Refer to "),_c('strong',[_v("1.")]),_v(" below")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Address")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("a/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Any value")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Status")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("st/")])]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("No")]),_v(" "),_c('td',[_v("Only alphanumeric characters")])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Tag(s)")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/")])]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("Yes")]),_v(" "),_c('td',[_v("Only alphanumeric characters")])])])])])} },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-a-person-add-person"}},[_v("Add person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add person n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 st/recovering t/friend")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#listing-all-persons-list-person"}},[_v("List all persons")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")]),_v(" "),_c('br')]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list person")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#editing-a-person-edit-person"}},[_v("Edit person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit person 2 n/James Lee e/jameslee@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#finding-persons-by-name-find-person"}},[_v("Find person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find person KEYWORD [MORE_KEYWORDS]")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find person n/James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#deleting-a-person-delete-person"}},[_v("Delete person")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete person INDEX")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete person 3")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_c('a',{attrs:{"href":"#clearing-all-persons-clear-person"}},[_v("Clear all persons")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear person")])])])])])])} @@ -176,7 +167,10 @@ with(this){return _c('p',[_v("An "),_c('strong',[_v("appointment")]),_v(" is def 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")])])])])])} },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 AID can be seen at the top of their information card.")])} +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"}})])} +},function anonymous( +) { +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:")])])} @@ -236,10 +230,7 @@ with(this){return _c('ul',[_c('li',[_v("Use the prefix "),_c('code',{pre:true,at with(this){return _c('p',[_c('strong',[_v("Examples")]),_v(":")])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt n/John")]),_v(" returns appointments with patients named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt d/2024-12-05")]),_v(" returns appointments on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-05")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt n/John d/2024-12-05")]),_v(" returns appointments with patients named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John")]),_v(", and is on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-05")]),_v(".")])])} -},function anonymous( -) { -with(this){return _c('p',[_c('a',{attrs:{"href":"/tp/images/findApptExample.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findApptExample.png","alt":"result for 'find appt John and 2024-12-05'"}})])])} +with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt n/John")]),_v(" returns appointments with patients named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt d/2024-12-05")]),_v(" returns appointments on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-05")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find appt n/John d/2024-12-05")]),_v(" returns appointments with patients named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John")]),_v(", and is on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2024-12-05")]),_v(".\n"),_c('br'),_c('br'),_c('a',{attrs:{"href":"/tp/images/findApptExample.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findApptExample.png","alt":"result for 'find appt John and 2024-12-05'"}})])])])} },function anonymous( ) { with(this){return _c('h5',{attrs:{"id":"deleting-an-appointment-delete-appt"}},[_v("Deleting an appointment : "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete appt")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#deleting-an-appointment-delete-appt","onclick":"event.stopPropagation()"}})])} @@ -347,6 +338,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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index e768dfb2cbc..5eefcc7f138 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, 18:53:32 GMT+8]
    +place to start.

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Mon, 11 Nov 2024, 19:49:53 GMT+8]
    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index da1cc15fc33..54cc3aa99e2 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/choiwab.html b/team/choiwab.html index 2ef663df3d1..e31dcf038f3 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.

    +
  • 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.

    diff --git a/team/choiwab.page-vue-render.js b/team/choiwab.page-vue-render.js index 335a89784fc..e0ea8abb201 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/jayjay19630.html b/team/jayjay19630.html index 9579f97994d..1464dcd1cf9 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.

    +
  • 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.

    diff --git a/team/jayjay19630.page-vue-render.js b/team/jayjay19630.page-vue-render.js index 335a89784fc..e0ea8abb201 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/rxchell.html b/team/rxchell.html index d3f1d23dde4..f7ffb800143 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.

    +
  • 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.

    diff --git a/team/rxchell.page-vue-render.js b/team/rxchell.page-vue-render.js index ea7fe5035cd..335971e8ee5 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/vangmay.html b/team/vangmay.html index 53dbc746c16..1d70dcfbfda 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:

    Given below are my contributions to the project:

    +
  • 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:

    Given below are my contributions to the project:

    diff --git a/team/vangmay.page-vue-render.js b/team/vangmay.page-vue-render.js index f6c49c3f0b2..2144b1bf639 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/zaidansani.html b/team/zaidansani.html index 04e28b188bc..1ac50eaa689 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:

    Given below are my contributions to the project:

    +
  • 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:

    Given below are my contributions to the project:

    diff --git a/team/zaidansani.page-vue-render.js b/team/zaidansani.page-vue-render.js index cf1b0ad49fc..4db3cbff82e 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, 18:53:32 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, 19:49:53 GMT+8]")])])])} }]; \ No newline at end of file