From 34812d4a01bf4d4e376a3f720e08a358e5d96c77 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 7 Nov 2024 16:05:21 +0000 Subject: [PATCH] deploy: c820323c7812637f9a3674f2f85e0484f07b0c86 --- 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 | 5 ++--- UserGuide.page-vue-render.js | 7 ++----- index.html | 2 +- index.page-vue-render.js | 2 +- team/currynia.html | 2 +- team/currynia.page-vue-render.js | 2 +- team/dessnowy.html | 2 +- team/dessnowy.page-vue-render.js | 2 +- team/incogdino.html | 2 +- team/incogdino.page-vue-render.js | 2 +- team/swaminathanviswa.html | 2 +- team/swaminathanviswa.page-vue-render.js | 2 +- team/tohjh.html | 2 +- team/tohjh.page-vue-render.js | 2 +- 30 files changed, 32 insertions(+), 36 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index b38de995d4a..be5857b7d81 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -19,7 +19,7 @@ [portfolio]

Lau Xiang Yu

[github] [portfolio]

Swaminathan Viswa

[github] [portfolio]

Javier Tan Meng Wee

[github] -[portfolio]

+[portfolio]

diff --git a/AboutUs.page-vue-render.js b/AboutUs.page-vue-render.js index fc57352b469..558e17ed750 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 the email "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("e1249111[at]u.nus.edu")])]),_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":"toh-jia-han"}},[_v("Toh Jia Han"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#toh-jia-han","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/tohjh.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/tohjh"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/tohjh.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Deliverables and deadline")])]),_v(" "),_c('h3',{attrs:{"id":"wen-rui"}},[_v("Wen Rui"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#wen-rui","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/currynia.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/currynia"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/currynia.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Code quality")]),_v(" "),_c('li',[_v("Responsibilities: Looks after code quality, ensures adherence to coding standards, etc.")])]),_v(" "),_c('h3',{attrs:{"id":"lau-xiang-yu"}},[_v("Lau Xiang Yu"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#lau-xiang-yu","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/dessnowy.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/DesSnowy"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/dessnowy.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Integration")])]),_v(" "),_c('h3',{attrs:{"id":"swaminathan-viswa"}},[_v("Swaminathan Viswa"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#swaminathan-viswa","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/swaminathanviswa.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/SwaminathanViswa"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/swaminathanviswa.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: Responsible for quality of project documentations")])]),_v(" "),_c('h3',{attrs:{"id":"javier-tan-meng-wee"}},[_v("Javier Tan Meng Wee"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#javier-tan-meng-wee","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/incogdino.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/incogdino"}},[_v("github")]),_v("]\n["),_c('a',{attrs:{"href":"/tp/team/incogdino.html"}},[_v("portfolio")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Testing")]),_v(" "),_c('li',[_v("Responsibilities: Ensures the testing of the project is done properly and on time.")])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index 913a7583b2b..716155700e0 100644 --- a/Configuration.html +++ b/Configuration.html @@ -14,7 +14,7 @@

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

+

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 f428aaf735b..3d9030a6050 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index c235c30b706..af211a6f2d9 100644 --- a/DevOps.html +++ b/DevOps.html @@ -16,7 +16,7 @@ Search

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 e4a6e6236c1..d20c3050d82 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 4e4dae16d01..59559d4faf2 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -23,7 +23,7 @@ Expected: The most recent window size and location is retained.

  • { more test cases …​ }

    • Deleting a person

    1. Deleting a person while all persons are being shown

      1. Prerequisites: List all persons using the list command. Multiple persons in the list.

      2. Test case: delete 1
        Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

      3. Test case: delete 0
        Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

      4. Other incorrect delete commands to try: delete, delete x, ... (where x is larger than the list size)
        -Expected: Similar to previous.

    2. { more test cases …​ }

    Saving data

    1. Dealing with missing/corrupted data files

      1. {explain how to simulate a missing/corrupted file, and the expected behavior}

    2. { more test cases …​ }

    +Expected: Similar to previous.

  • { more test cases …​ }

    • Saving data

    1. Dealing with missing/corrupted data files

      1. {explain how to simulate a missing/corrupted file, and the expected behavior}

    2. { more test cases …​ }

    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index b280e6e8e01..7d796290012 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -512,6 +512,6 @@ with(this){return _c('h3',{attrs:{"id":"saving-data"}},[_v("Saving data"),_c('a' with(this){return _c('ol',[_c('li',[_c('p',[_v("Dealing with missing/corrupted data files")]),_v(" "),_c('ol',[_c('li',[_c('em',[_v("{explain how to simulate a missing/corrupted file, and the expected behavior}")])])])]),_v(" "),_c('li',[_c('p',[_c('em',[_v("{ more test cases …​ }")])])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index bbe5f944b6d..da385ddb7ec 100644 --- a/Documentation.html +++ b/Documentation.html @@ -14,7 +14,7 @@

    Documentation Guide

    Style guidance:

    Converting to PDF

    +

    Documentation Guide

    Style guidance:

    Converting to PDF

    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index b9165917807..18363917806 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 1dfd37252fd..f01cbc9d2c9 100644 --- a/Logging.html +++ b/Logging.html @@ -14,7 +14,7 @@

    Logging guide

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

    Logging guide

    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index b8b9a86e449..8441e572f83 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index 0ddebc6ff9e..a752dff905c 100644 --- a/SettingUp.html +++ b/SettingUp.html @@ -20,7 +20,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 1e8016c0c86..509db32b181 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index fdcd2105918..08a6f0e5419 100644 --- a/Testing.html +++ b/Testing.html @@ -18,7 +18,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 c3bae494a6a..a6dbe5c78cc 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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index 52019ab7150..1d28fd5c1b9 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -17,8 +17,7 @@
    Logo

    KonTActs User Guide

    KonTActs is a desktop app for managing your contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).

    KonTActs streamlines contact management, helping you keep track of students, professors, and fellow TAs more effectively than traditional GUI apps.


    Quick start

    To get started,

    1. Ensure you have Java 17 or above installed in your Computer. Refer here for the specific version.

    2. Download the latest .jar file from here.

    3. Copy the file to the folder you want to use as the home folder for KonTActs.

    4. Open a command terminal, cd into home folder you put the jar file in, and enter java -jar KonTActs.jar to run the application and type view name/Alex Yeoh.
      A interface similar to the one below should appear in a few seconds. Note how the app contains some sample data.
      quick start GUI on launch


    1. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.
      Some example commands you can try:

      • list : Lists all contacts.

      • mark name/Alex Yeoh week/0 : Marks Alex Yeoh attendance in KonTActs.

      • delete name/Bernice Yu : Deletes Bernice Yu from KonTActs.

      • addGrade name/Alex Yeoh assignment/Ex01 score/9 : Assigns and adds Ex01 with a score of 9 to Alex Yeoh.

      • The GUI should now look something like this.
        quick start GUI after commands

      • clear : Deletes all contacts.

    2. Refer to the Features below for details of each command. -


    Summary of commands

    Action Format, Examples
    Add add name/NAME email/EMAIL telegram/TELEGRAM [tag/TAG]…​ github/GITHUB
    e.g., add name/James Ho email/jamesho@example.com telegram/@James tag/friend tag/colleague github/james-cool
    Clear clear
    Delete delete name/NAME
    e.g., delete name/James
    Edit edit INDEX [name/NAME] [email/EMAIL] [telegram/TELEGRAM] [tag/TAG]…​ [github/GITHUB]
    e.g.,edit 2 name/James Lee email/jameslee@example.com
    Find find KEYWORD [MORE_KEYWORDS]
    e.g., find James Jake
    Filter filter tag/[TAG] tag/[MORE_TAG]…​
    e.g., filter tag/friends tag/family
    List list
    Help help
    View view [name/NAME]
    e.g., view name/John Doe
    Github github name/NAME
    e.g., github name/Harry
    Mark mark name/NAME week/WEEK_NUMBER
    e.g. mark name/John Doe week/1
    Unmark unmark name/NAME week/WEEK_NUMBER
    e.g. unmark name/John Doe week/1
    Sort sort FIELD order/ORDER
    e.g. sort name order/asc
    Import import path/CSV_FILE_PATH
    e.g import path/user/data/xxx.csv
    Export export path/DESIRED_FILE_DESTINATION
    e.g export path/user/data/xxx.csv
    Command History ↑ and ↓
    Add grade addGrade name/NAME assignment/ASSIGNMENT_NAME score/SCORE
    e.g. addGrade n/JohnDoe assignment/Ex01 score/5
    Remove grade removeGrade name/NAME assignment/ASSIGNMENT_NAME
    e.g. removeGrade name/John Doe assignment/Ex01

                                                                           |
-

    Parameter shortcuts

    All parameters in KonTActs come equipped with their equivalent shortcuts.

    Parameter Shortcut
    name/ n/
    email/ e/
    tag/ t/
    assignment/ a/
    score/ s/
    telegram/ tele/
    github/ g/
    week/ w/
    order/ o/
    path/ p/

    Command shortcuts

    All commands in KonTActs come equipped with their equivalent shortcuts.

    Command Shortcut
    mark m
    unmark um
    import im
    export ex
    find fd
    filter f
    view v
    addGrade ag
    removeGrade rg
    delete rm
    edit e
    gitHub git

    Features

    Notes about the command format:

    • Words in UPPER_CASE are the parameters supplied by you.
      +


      • Summary of commands

      Action Format, Examples
      Add add name/NAME email/EMAIL telegram/TELEGRAM [tag/TAG]…​ github/GITHUB
      e.g., add name/James Ho email/jamesho@example.com telegram/@James tag/friend tag/colleague github/james-cool
      Clear clear
      Delete delete name/NAME
      e.g., delete name/James
      Edit edit INDEX [name/NAME] [email/EMAIL] [telegram/TELEGRAM] [tag/TAG]…​ [github/GITHUB]
      e.g.,edit 2 name/James Lee email/jameslee@example.com
      Find find KEYWORD [MORE_KEYWORDS]
      e.g., find James Jake
      Filter filter tag/[TAG] tag/[MORE_TAG]…​
      e.g., filter tag/friends tag/family
      List list
      Help help
      View view [name/NAME]
      e.g., view name/John Doe
      Github github name/NAME
      e.g., github name/Harry
      Mark mark name/NAME week/WEEK_NUMBER
      e.g. mark name/John Doe week/1
      Unmark unmark name/NAME week/WEEK_NUMBER
      e.g. unmark name/John Doe week/1
      Sort sort FIELD order/ORDER
      e.g. sort name order/asc
      Import import path/CSV_FILE_PATH
      e.g import path/user/data/xxx.csv
      Export export path/DESIRED_FILE_DESTINATION
      e.g export path/user/data/xxx.csv
      Command History ↑ and ↓
      Add grade addGrade name/NAME assignment/ASSIGNMENT_NAME score/SCORE
      e.g. addGrade n/JohnDoe assignment/Ex01 score/5
      Remove grade removeGrade name/NAME assignment/ASSIGNMENT_NAME
      e.g. removeGrade name/John Doe assignment/Ex01

      Parameter shortcuts

      All parameters in KonTActs come equipped with their equivalent shortcuts.

      Parameter Shortcut
      name/ n/
      email/ e/
      tag/ t/
      assignment/ a/
      score/ s/
      telegram/ tele/
      github/ g/
      week/ w/
      order/ o/
      path/ p/

      Command shortcuts

      All commands in KonTActs come equipped with their equivalent shortcuts.

      Command Shortcut
      mark m
      unmark um
      import im
      export ex
      find fd
      filter f
      view v
      addGrade ag
      removeGrade rg
      delete rm
      edit e
      gitHub git

      Features

      Notes about the command format:

      • Words in UPPER_CASE are the parameters supplied by you.
        e.g. add name/NAME, NAME is a parameter which can be used as add name/John Doe.

      • Items in square brackets are optional.
        e.g name/NAME [tag/TAG] can be used as name/John Doe tag/friend or as name/John Doe.

      • Items with …​ after them can be used multiple times including zero times.
        e.g. [tag/TAG]…​ can be used as (i.e. 0 times), tag/friend, tag/friend tag/family etc.

      • Parameters can be in any order.
        @@ -71,7 +70,7 @@ as the input score is greater than the max, as specified in the assignment.json file.

        addGrade n/JohnDoe asgn/Ex05 s/5 will not add the assignment to contact JohnDoe as the assignment is not specified assignment.json

      Calling addGrade without any fields will show the list of assignments in assignment.json.

      Removing grades from a contact : removeGrade

      Removes an assignment and its grades from a contact.

      Format: removeGrade n/NAME assignment/ASSIGNMENT_NAME

      Shortcut: rg n/NAME a/ASSIGNMENT_NAME

      Examples:

      Assuming John Doe has Ex01 assignment with a score of 5.

      Calling removeGrade n/John Doe asgn/Ex01 will remove the Ex01 assignment from contact John Doe.

      Calling removeGrade n/John Doe asgn/Ex01 again will throw an error since the assignment has already been removed. To add a new assignment, refer to addGrade command above.

      Exiting the program : exit

      Exits the program.

      Format: exit


      Saving the data

      KonTActs data are automatically saved in the hard disk after every command that changes data. You do not need to save the data manually.

      However, it is always good practice to have a local backup 😄 You can do this with the export command.

      Editing the data file

      KonTActs data are saved automatically as a JSON file [JAR file location]/data/kontacts.json.

      Recommended for more advanced and seasoned users

      • Data in the JSON file can be edited.
      • If your changes to the data file results in an invalid format, KonTActs will discard all data and start with an empty data file at the next run.
      • It is recommended to create a backup of the file before editing it. This can be done with the export command.
      • Certain edits can also cause the KonTActs to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

      FAQ

      Q: How do I transfer my data to another Computer?
      A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous KonTActs home folder. Alternatively, you can use the export command to export the data into a CSV file and import the CSV file into your other device.


      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.
      2. 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.
      3. When using excel to edit telegram username, typing "@" will trigger the command function which will output a "Function is not valid" error. The remedy is to prefix the telegram username with an apostrophe ' to escape from the command function. For example: typing '@james. -excel known issue
    [Powered by MarkBind 5.5.3, generated on Thu, 7 Nov 2024, 23:26:37 GMT+8]
    +excel known issue
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index 29932c95ee5..07d7759f4df 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("KonTActs")])]},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#summary-of-commands"}},[_v("Command Summary")])])]),_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-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)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('center',[_c('pic',{attrs:{"src":"/tp/images/kontactsLogo.png","width":"300","alt":"Logo","lazy":""}},[_c('h1',{attrs:{"id":"kontacts-user-guide"}},[_c('strong',[_v("KonTActs User Guide")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#kontacts-user-guide","onclick":"event.stopPropagation()"}})])])],1),_v(" "),_m(0),_v(" "),_c('p',[_v("KonTActs streamlines contact management, helping you keep track of students, professors, and fellow TAs more effectively than traditional GUI apps.")]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_m(1),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_c('p',[_v("To get started,")]),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(7),_v(" "),_m(8),_m(9),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_m(10),_v(" "),_c('hr'),_v(" "),_m(11),_v(" "),_c('p',[_v("All parameters in KonTActs come equipped with their equivalent shortcuts.")]),_v(" "),_m(12),_c('hr'),_v(" "),_m(13),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(14),_v(" "),_c('p',[_v("All commands in KonTActs come equipped with their equivalent shortcuts.")]),_v(" "),_m(15),_m(16),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(17),_v(" "),_c('box',{attrs:{"type":"info","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-info",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('strong',[_v("Notes about the command format:")]),_c('br')]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("Words in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UPPER_CASE")]),_v(" are the parameters supplied by you."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/NAME")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")]),_v(" is a parameter which can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/John Doe")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Items in square brackets are optional."),_c('br'),_v("\ne.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/NAME [tag/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/John Doe tag/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/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 multiple times including zero times."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[tag/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("tag/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("tag/friend tag/family")]),_v(" etc.")])]),_v(" "),_c('li',[_c('p',[_v("Parameters can be in any order."),_c('br'),_v("\ne.g. if the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/NAME telegram/TELEGRAM")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("telegram/TELEGRAM name/NAME")]),_v(" is also acceptable.")])]),_v(" "),_c('li',[_c('p',[_v("Extra parameters for commands that do not take in parameters (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")]),_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(") will be ignored."),_c('br'),_v("\ne.g. if the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help 123")]),_v(", it will be interpreted as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.")])])])]),_v(" "),_m(18),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(19),_v(" "),_c('p',[_v("The help command opens the help window that shows the link to this user guide. The window adds access to copy the url to the clipboard or directly launch this user guide from the browser.")]),_v(" "),_c('p',[_v("A compact reference guide is also provided for quick reference.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])])])])]),_v(" "),_c('box',{attrs:{"type":"info","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-info",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('span',[_c('strong',[_v("The help window is launched in a separate window.")])]),_c('br'),_c('br'),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/helpMessage.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/helpMessage.png","alt":"help message"}})]),_c('br'),_c('br')])]),_v(" "),_m(20),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(21),_v(" "),_c('p',[_v("Adds a person's contact detail to KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/NAME email/EMAIL telegram/TELEGRAM [tag/TAG]…​ github/GITHUB")])])]),_c('br')])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/NAME e/EMAIL tele/TELEGRAM [t/TAG]…​ g/GITHUB")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Email restrictions")])]),_v("\nEmails should be of the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part@domain")]),_v(" and adhere to the following constraints:")]),_v(" "),_c('ol',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part")]),_v(" should only contain alphanumeric characters and "),_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(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part")]),_v(" may not start or end with any special characters.")]),_v(" "),_c('li',[_v("This is followed by an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(" and then a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("domain")]),_v(" name. The domain name is made up of domain labels separated by periods.\nThe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("domain name")]),_v(" must:\n"),_c('ul',[_c('li',[_v("end with a domain label at least 2 characters long")]),_v(" "),_c('li',[_v("have each domain label start and end with alphanumeric characters")]),_v(" "),_c('li',[_v("have each domain label consist of alphanumeric characters, separated only by hyphens, if any.")])])])]),_v(" "),_c('p',[_v("Eg. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("A person can have any number of tags (including 0)")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Tag restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Tags must be a single word containing only alphanumeric characters (no spaces or special symbols are allowed).")]),_v(" "),_c('li',[_v("To specify multiple tags, separate each tag parameter with a space.")])]),_v(" "),_c('p',[_v("Eg. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Telegram username restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Usernames must start with an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(", and can only contain underscores ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_")]),_v(") and alphanumeric characters.")])])]),_v(" "),_m(22),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("GitHub username restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Length of username must between 1 and 39 characters")]),_v(" "),_c('li',[_v("Can contain only alphanumeric characters and hyphens ('-').")]),_v(" "),_c('li',[_v("Hyphens cannot appear at the start or end, nor consecutively within the username")])]),_v(" "),_c('p',[_c('strong',[_v("Valid examples")])]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user123")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user-name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username456")])]),_v(" "),_c('p',[_c('strong',[_v("Invalid examples")])]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("very-mega-ultra-super-duper-long-username")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-username")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username-")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user--name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username_with_special$chars")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/John Doe e/johnd@example.com telegram/@john github/swag-john33")]),_v(" adds John Doe's contact details with no tags.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/Betsy Crowe t/friend e/betsycrowe@example.com telegram/@Betsy t/criminal github/betsy-29")]),_v(" adds Betsy Crowe's contact details with a friend and criminal tag.")])])]),_v(" "),_m(23),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(24),_v(" "),_c('p',[_v("Displays all persons in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])])])]),_v(" "),_c('hr'),_v(" "),_m(25),_v(" "),_c('p',[_v("Edits an existing person detail in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit INDEX [name/NAME] [email/EMAIL] [telegram/TELEGRAM] [tag/TAG]…​ [github/GITHUB]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("e INDEX [n/NAME] [e/EMAIL] [tele/TELEGRAM] [t/TAG]…​ [g/GITHUB]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Edits the person at the specified "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("INDEX")]),_v(". The index refers to the index number shown in the displayed person list. The index "),_c('strong',[_v("must be a positive integer")]),_v(" 1, 2, 3, …​")]),_v(" "),_c('li',[_v("At least one of the optional fields must be provided.")]),_v(" "),_c('li',[_v("Existing values will be updated to the input values.")]),_v(" "),_c('li',[_v("When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.")]),_v(" "),_c('li',[_v("You can remove all the person’s tags by typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/")]),_v(" without\nspecifying any tags after it.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 1 e/johndoe@example.com")]),_v(" Edits the email address of the 1st person to be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("johndoe@example.com")]),_v(" respectively.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 n/Betsy Crower t/")]),_v(" Edits the name of the 2nd person to be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy Crower")]),_v(" and clears all existing tags.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 1 github/cool-james12 n/James")]),_v(" Edits the name of the 1st person to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James")]),_v(" and github username to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cool-james12")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 telegram/@Mary n/Mary")]),_v(" Edits the name of the 2nd person to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Mary")]),_v(" and telegram ID to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@Mary")]),_v(".")])])]),_v(" "),_m(26),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(27),_v(" "),_c('p',[_v("Find all persons whose names contains any of the given keywords.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find KEYWORD [MORE_KEYWORDS]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("f KEYWORD [MORE_KEYWORDS]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hans")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans")])]),_v(" "),_c('li',[_v("The order of the keywords does not matter. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Bo")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Bo Hans")])]),_v(" "),_c('li',[_v("Only the name is searched.")]),_v(" "),_c('li',[_v("Only full words will be matched e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Han")]),_v(" will not match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans")])]),_v(" "),_c('li',[_v("Persons matching at least one keyword will be returned (i.e. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OR")]),_v(" search).\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Bo")]),_v(" will return "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Gruber")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Bo Yang")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find John")]),_v(" returns "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("john")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find alex charlotte")]),_v(" returns "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Charlotte")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexCharlotte.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexCharlotte.png","alt":"result for 'find alex charlotte'"}})])])])]),_v(" "),_m(28),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(29),_v(" "),_c('p',[_v("Finds persons whose names contain any of the given tag keywords.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter tag/TAG [tag/MORE_TAG]...")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("f t/TAG [t/MORE_TAG]...")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Friends")])]),_v(" "),_c('li',[_v("At least one tag must be provided.")]),_v(" "),_c('li',[_v("The order of the keywords does not matter. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friends t/family")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/family t/friends")])]),_v(" "),_c('li',[_v("Only the tags is searched.")]),_v(" "),_c('li',[_v("Only full tag name will be matched e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friend")]),_v(" will not match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")])]),_v(" "),_c('li',[_v("Persons matching at least one keyword will be returned (i.e. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OR")]),_v(" search).\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friends t/family")]),_v(" will return any contact tagged with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friend")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("family")]),_v(".")])])]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/friends")]),_v(" returns any contact tagged with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/filterFriendsTagByFilter.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/filterFriendsTagByFilter.png","alt":"result for 'filter t/friend t/family'"}})])])])]),_v(" "),_m(30),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(31),_v(" "),_c('p',[_v("Deletes the specified person from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete name/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rm n/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Deletes the person with the specified name.")]),_v(" "),_c('li',[_v("The name refers to the full name of the person shown in the displayed person list.")]),_v(" "),_c('li',[_v("If a person matches the name but is not shown in the list, it will not be deleted.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/Betsy")]),_v(" deletes the person with the name "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find Betsy")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete Alex")]),_v(" will not delete the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/Betsy")]),_v(" deletes the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(" if it is shown on the filtered list.")])])]),_v(" "),_m(32),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(33),_v(" "),_c('p',[_v("Launches GitHub repository of the specified person on the browser from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github name/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git n/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Launches the GitHub repository of the specified person.")]),_v(" "),_c('li',[_v("Person specified needs to have a GitHub username assigned in the Address Book.")]),_v(" "),_c('li',[_v("The name refers to the full name of the person shown in the Address Book.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")]),_v(" launches the GitHub repository of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Harry")]),_v(", using the GitHub username assigned to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Harry")]),_v(".\n"),_c('a',{attrs:{"href":"/tp/images/githubUsage.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/githubUsage.png","alt":"github use case for launching Harry's repository"}})])])])]),_v(" "),_m(34),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(35),_v(" "),_c('p',[_v("Opens a window at the side with the full details of the specified person from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view [name/NAME]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v [n/NAME]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("View the full details of the contact you specify.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")]),_v(" refers to the full name of the person shown in the displayed person list.")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" without any name parameter closes any windows previously opened by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(".")]),_v(" "),_c('li',[_v("Deleting or editing name of the current contact opened by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" closes "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(".")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/John Doe")]),_v(" opens a window at the side showing the full details of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(".")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/John Doe")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" closes the window showing the full contact details of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(".\n"),_c('a',{attrs:{"href":"/tp/images/quickStartLaunchScreenshot.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/quickStartLaunchScreenshot.png","alt":"viewing John Doe's contact detail in the view window"}})])])])]),_v(" "),_m(36),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(37),_v(" "),_c('p',[_v("Marks a student as present for a particular week.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark name/NAME week/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("m n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Marks the particular student as present in that week.")]),_v(" "),_c('li',[_v("The full name and week number is "),_c('strong',[_v("compulsory")]),_v(".")]),_v(" "),_c('li',[_v("The name is "),_c('strong',[_v("case-sensitive")]),_v(".")]),_v(" "),_c('li',[_v("The range of the WEEK_NUMBER is between 0 and 13, both inclusive. Rationale being there are 14 weeks per semester.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/Alex Yeoh w/0")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(" as present for week 0.\n"),_c('a',{attrs:{"href":"/tp/images/markAlexPresent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markAlexPresent.png","alt":"result for mark"}})])])])]),_v(" "),_m(38),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(39),_v(" "),_c('p',[_v("Unmarks a student as present for a particular week.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("um n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Unmarks the particular student as present in that week.")]),_v(" "),_c('li',[_v("The full name and week number is "),_c('strong',[_v("compulsory")]),_v(".")]),_v(" "),_c('li',[_v("The name is "),_c('strong',[_v("case-sensitive")]),_v(".")]),_v(" "),_c('li',[_v("The range of the WEEK_NUMBER is between 0 and 13, both inclusive. Rationale being there are 14 weeks per semester.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/Alex Yeoh w/0")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(" as absent for week 0.\n"),_c('a',{attrs:{"href":"/tp/images/markAlexAbsent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markAlexAbsent.png","alt":"result for unmark"}})])])])]),_v(" "),_m(40),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(41),_v(" "),_c('p',[_v("Sorts the displayed list based on the given field and order.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort FIELD order/ORDER")])])]),_v(" "),_c('p',[_c('span',[_c('strong',[_v("Reset Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")])])])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Order of contact details can be reset to default by calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(".")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FIELD")]),_v(" that can be sorted by: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("telegram")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ORDER")]),_v(" that is accepted: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("asc")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("desc")]),_v(".")]),_v(" "),_c('li',[_v("The sort order persists between commands.")]),_v(" "),_c('li',[_v("The sort order will reset when "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(" command is given.")]),_v(" "),_c('li',[_v("The sorting is "),_c('strong',[_v("case-insensitive")]),_v(": upper and lower case are treated as the same values.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort name order/desc")]),_v(" will sort the displayed list based on their name in ascending order.\n"),_c('a',{attrs:{"href":"/tp/images/sortByNameDesc.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/sortByNameDesc.png","alt":"result_for_sorting"}})])])]),_v(" "),_c('div',{staticClass:"d-print-none"},[_c('hr')]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(" will reset the displayed list to its default order.\n"),_c('a',{attrs:{"href":"/tp/images/sortReset.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/sortReset.png","alt":"result_for_sorting"}})])])])])]),_v(" "),_c('hr'),_v(" "),_m(42),_v(" "),_c('p',[_v("Clears all entries from the KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")])])])])]),_v(" "),_m(43),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(44),_v(" "),_c('p',[_v("Imports contacts based on CSV file. Importing a file will replace ALL existing contacts")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/CSV_FILE_PATH")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("im p/CSV_FILE_PATH")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("File path can be relative or absolute, but must end with .csv")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/data/group12.csv")]),_v(" will import the contacts found from the CSV (group12.csv from relative path given)")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("CSV file formatting:")])])]),_v(" "),_c('ul',[_c('li',[_v("The CSV file must have header with the exact required order {\"Name\", \"Email\", \"Telegram\", \"Tags\", \"Github\",\n\"Assignments\", \"WeeksPresent\"} (Case-insensitive)")]),_v(" "),_c('li',[_v("The CSV file must contain information about at least 1 person")]),_v(" "),_c('li',[_v("The data fields for Name, Email, Telegram, Github is compulsory\n"),_c('ul',[_c('li',[_v("Do note that each of these field have their own restrictions\n"),_c('a',{attrs:{"href":"#i-classfa-solid-fa-user-plusi-adding-a-person-add"}},[_v("(refer above)")])])])]),_v(" "),_c('li',[_v("Tags format: enclose tag in square brackets (\"[tag]\"). If a person has multiple tags, separate the tags within\nthe same entry with commas. (e.g.\"[tag1],[tag2],[tag3].....\")\n"),_c('ul',[_c('li',[_v("Duplicate tags will be ignored (e.g.\"[Group1],[Group1]\" will be treated as \"[Group1]\")")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no tags for specific person)")])])]),_v(" "),_c('li',[_v("Assignment format: Assignment name and assignment score should be separated with \"|\" (e.g. Ex01|10). If multiple\nassignments are present for a person, separate them within the same entry using commas. (e.g. Ex01|9, Ex02|5)\n"),_c('ul',[_c('li',[_v("If an assignment name appears twice, the later instance will be used (e.g. Ex01|10, Ex01|5 will cause KonTActs\nto record 5 marks for Assignment Ex01)")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no assignments for specified person)")])])]),_v(" "),_c('li',[_v("WeeksPresent format: Each integer represents a specific week, with each week separated by a comma. (e.g. 1,2,3,4)\n"),_c('ul',[_c('li',[_v("Duplicate weeks will be ignored (e.g. 1,2,3,4,1 will be treated as 1,2,3,4)")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no weeks attended for specific person)")])])])])]),_v(" "),_m(45),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Example of acceptable CSV file:")])])]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("\"Name\",\"Email\",\"Telegram\",\"Tags\",\"Github\",\"Assignments\",\"WeeksPresent\"\n")]),_c('span',[_v("\"Alex Yeoh\",\"alexyeoh@example.com\",\"@alex\",\"[friends]\",\"Alex\",\"Ex01 | 3.0\",\"5\"\n")]),_c('span',[_v("\"Bernice Yu\",\"berniceyu@example.com\",\"@bernice\",\"[colleagues],[friends]\",\"Bernice\",\"\",\"\"\n")]),_c('span',[_v("\"Charlotte Oliveiro\",\"charlotte@example.com\",\"@charlotte\",\"[friend],[colleague]\",\"Charlotte\",\"\",\"\"\n")]),_c('span',[_v("\"David Li\",\"lidavid@example.com\",\"@david\",\"[family]\",\"david\",\"\",\"\"\n")]),_c('span',[_v("\"Irfan Ibrahim\",\"irfan@example.com\",\"@irfan\",\"[classmates]\",\"Irfan\",\"\",\"\"\n")]),_c('span',[_v("\"Roy Balakrishnan\",\"royb@example.com\",\"@roy\",\"[colleagues]\",\"Roy\",\"\",\"\"\n")])])]),_c('p',[_c('a',{attrs:{"href":"/tp/images/validCSV1.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/validCSV1.png","alt":"Valid CSV(excel)"}})])])]),_v(" "),_m(46),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(47),_v(" "),_c('p',[_v("Exports contacts based on contacts and their details stored in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/DESIRED_FILE_DESTINATION")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ex p/DESIRED_FILE_DESTINATION")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("File path can be relative or absolute but must end with .csv")])])]),_v(" "),_c('li',[_v("You must have write permission in order to export CSV file to specified location")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/data/group12.csv")]),_v(" will export the contacts in the Address book as a csv file (group12.csv at the\nrelative path given)")])])]),_v(" "),_m(48),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(49),_v(" "),_m(50),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")]),_v(" arrow keys")])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('p',[_v("Current input in the text field is erased when accessing the command history.")])]),_v(" "),_c('li',[_c('p',[_v("If the current session of KonTActs has no commands added, pressing the "),_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")]),_v(" arrow keys will not have any effect.")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ol',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")]),_v(" launches the github account of Harry on the browser")]),_v(" "),_c('li',[_v("The command text field box is now empty.")]),_v(" "),_c('li',[_v("Pressing "),_c('kbd',[_v("↑")]),_v(" will retrieve the last input command which will populate the command text field box with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")])]),_v(" "),_c('li',[_v("Continuously pressing "),_c('kbd',[_v("↑")]),_v(" will scroll through all commands that have been previously input.")]),_v(" "),_c('li',[_v("Pressing "),_c('kbd',[_v("↓")]),_v(" will scroll down to the more recent commands that was last input.")])])]),_v(" "),_m(51),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(52),_v(" "),_c('p',[_v("Adds an assignment and its grades to a contact.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade name/NAME assignment/ASSIGNMENT_NAME score/SCORE")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ag n/NAME a/ASSIGNMENT_NAME s/SCORE")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('p',[_v("Assignments that can be added to a contact are specified in path "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data/assignment.json")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" is missing from "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data")]),_v(", KonTActs will load a default assignment database.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" needs to be manually created in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Each assignment must have a unique "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSIGNMENT_NAME")]),_v(".")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('p',[_v("Example with the following assignment.json file:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"assignments\"")]),_v(" : [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex01\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("10")]),_v("\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex02\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("10")]),_v("\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex03\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("15")]),_v("\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/5")]),_v(" will add an assignment name\nAssignment01 with score 5 to contact JohnDoe.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/12")]),_v(" will not add the assignment to contact JohnDoe\nas the input score is greater than the max, as specified in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" file.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex05 s/5")]),_v(" will not add the assignment to contact JohnDoe\nas the assignment is not specified "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade")]),_v(" without any fields will show the list of assignments in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(".")])]),_v(" "),_c('hr'),_v(" "),_m(53),_v(" "),_c('p',[_v("Removes an assignment and its grades from a contact.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/NAME assignment/ASSIGNMENT_NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rg n/NAME a/ASSIGNMENT_NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('p',[_v("Assuming John Doe has "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ex01")]),_v(" assignment with a score of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("5")]),_v(".")]),_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")]),_v(" will remove the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ex01")]),_v(" assignment from contact John Doe.")]),_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")]),_v(" again will throw an error since the assignment has already been removed.\nTo add a new assignment, refer to "),_c('a',{attrs:{"href":"#adding-grades-to-a-contact-addgrade"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade")])]),_v(" command above.")])]),_v(" "),_c('hr'),_v(" "),_m(54),_v(" "),_c('p',[_v("Exits the program.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")])])])])]),_v(" "),_m(55),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(56),_v(" "),_c('p',[_v("KonTActs data are automatically saved in the hard disk after every command that changes data. You do not need to save the data manually.")]),_v(" "),_m(57),_v(" "),_c('hr'),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('strong',[_v("Recommended for more advanced and seasoned users")])]),_v(" "),_c('ul',[_c('li',[_v("Data in the JSON file can be edited.")]),_v(" "),_c('li',[_v("If your changes to the data file results in an invalid format, KonTActs will discard all data and start with an empty data file at the next run.")]),_v(" "),_c('li',[_v("It is recommended to create a backup of the file before editing it. This can be done with the "),_c('a',{attrs:{"href":"#exporting-data-into-csv-file-export"}},[_v("export")]),_v(" command.")]),_v(" "),_c('li',[_v("Certain edits can also cause the KonTActs to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.")])])]),_v(" "),_c('hr'),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_m(62),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(63),_v(" "),_m(64),_v(" "),_c('hr')],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":"#kontacts-user-guide"}},[_v("KonTActs 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":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary-of-commands"}},[_v("Summary of commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parameter-shortcuts"}},[_v(" Parameter shortcuts‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-shortcuts"}},[_v(" Command shortcuts‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#features"}},[_v(" Features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#viewing-help-help"}},[_v(" Viewing help : help‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person-add"}},[_v(" Adding a person: add‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#listing-all-persons-list"}},[_v(" Listing all persons : list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person-edit"}},[_v(" Editing a person : edit‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-persons-by-name-find"}},[_v(" Finding persons by name: find‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filtering-persons-by-tag-filter"}},[_v(" Filtering persons by tag: filter‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person-delete"}},[_v(" Deleting a person : delete‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launching-github-repository-github"}},[_v(" Launching GitHub repository : github‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#viewing-a-contact-s-full-details-view"}},[_v(" Viewing a contact's full details : view‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#marking-a-student-as-present-mark"}},[_v(" Marking a student as present : mark‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#unmarking-a-student-as-present-unmark"}},[_v(" Unmarking a student as present : unmark‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sorting-the-displayed-list-sort"}},[_v(" Sorting the displayed list : sort‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-all-entries-clear"}},[_v(" Clearing all entries : clear‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#importing-data-from-csv-file-import"}},[_v(" Importing data from CSV file : import‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exporting-data-into-csv-file-export"}},[_v(" Exporting data into CSV file : export‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#accessing-command-history-and"}},[_v(" Accessing command history : ↑ and ↓‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-grades-to-a-contact-addgrade"}},[_v(" Adding grades to a contact : addGrade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#removing-grades-from-a-contact-removegrade"}},[_v(" Removing grades from a contact : removeGrade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exiting-the-program-exit"}},[_v(" Exiting the program : exit‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-the-data"}},[_v(" Saving the data‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-the-data-file"}},[_v(" Editing the data file‎")])]),_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(65)])} +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("KonTActs")])]},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#summary-of-commands"}},[_v("Command Summary")])])]),_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-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)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('center',[_c('pic',{attrs:{"src":"/tp/images/kontactsLogo.png","width":"300","alt":"Logo","lazy":""}},[_c('h1',{attrs:{"id":"kontacts-user-guide"}},[_c('strong',[_v("KonTActs User Guide")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#kontacts-user-guide","onclick":"event.stopPropagation()"}})])])],1),_v(" "),_m(0),_v(" "),_c('p',[_v("KonTActs streamlines contact management, helping you keep track of students, professors, and fellow TAs more effectively than traditional GUI apps.")]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_m(1),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_c('p',[_v("To get started,")]),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(7),_v(" "),_m(8),_m(9),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(10),_v(" "),_c('p',[_v("All parameters in KonTActs come equipped with their equivalent shortcuts.")]),_v(" "),_m(11),_c('hr'),_v(" "),_m(12),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(13),_v(" "),_c('p',[_v("All commands in KonTActs come equipped with their equivalent shortcuts.")]),_v(" "),_m(14),_m(15),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(16),_v(" "),_c('box',{attrs:{"type":"info","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-info",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('strong',[_v("Notes about the command format:")]),_c('br')]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("Words in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("UPPER_CASE")]),_v(" are the parameters supplied by you."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/NAME")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")]),_v(" is a parameter which can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/John Doe")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Items in square brackets are optional."),_c('br'),_v("\ne.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/NAME [tag/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/John Doe tag/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/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 multiple times including zero times."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[tag/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("tag/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("tag/friend tag/family")]),_v(" etc.")])]),_v(" "),_c('li',[_c('p',[_v("Parameters can be in any order."),_c('br'),_v("\ne.g. if the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name/NAME telegram/TELEGRAM")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("telegram/TELEGRAM name/NAME")]),_v(" is also acceptable.")])]),_v(" "),_c('li',[_c('p',[_v("Extra parameters for commands that do not take in parameters (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")]),_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(") will be ignored."),_c('br'),_v("\ne.g. if the command specifies "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help 123")]),_v(", it will be interpreted as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.")])])])]),_v(" "),_m(17),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(18),_v(" "),_c('p',[_v("The help command opens the help window that shows the link to this user guide. The window adds access to copy the url to the clipboard or directly launch this user guide from the browser.")]),_v(" "),_c('p',[_v("A compact reference guide is also provided for quick reference.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])])])])]),_v(" "),_c('box',{attrs:{"type":"info","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-info",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('span',[_c('strong',[_v("The help window is launched in a separate window.")])]),_c('br'),_c('br'),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/helpMessage.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/helpMessage.png","alt":"help message"}})]),_c('br'),_c('br')])]),_v(" "),_m(19),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(20),_v(" "),_c('p',[_v("Adds a person's contact detail to KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add name/NAME email/EMAIL telegram/TELEGRAM [tag/TAG]…​ github/GITHUB")])])]),_c('br')])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/NAME e/EMAIL tele/TELEGRAM [t/TAG]…​ g/GITHUB")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Email restrictions")])]),_v("\nEmails should be of the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part@domain")]),_v(" and adhere to the following constraints:")]),_v(" "),_c('ol',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part")]),_v(" should only contain alphanumeric characters and "),_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(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("local-part")]),_v(" may not start or end with any special characters.")]),_v(" "),_c('li',[_v("This is followed by an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(" and then a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("domain")]),_v(" name. The domain name is made up of domain labels separated by periods.\nThe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("domain name")]),_v(" must:\n"),_c('ul',[_c('li',[_v("end with a domain label at least 2 characters long")]),_v(" "),_c('li',[_v("have each domain label start and end with alphanumeric characters")]),_v(" "),_c('li',[_v("have each domain label consist of alphanumeric characters, separated only by hyphens, if any.")])])])]),_v(" "),_c('p',[_v("Eg. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("A person can have any number of tags (including 0)")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Tag restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Tags must be a single word containing only alphanumeric characters (no spaces or special symbols are allowed).")]),_v(" "),_c('li',[_v("To specify multiple tags, separate each tag parameter with a space.")])]),_v(" "),_c('p',[_v("Eg. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Telegram username restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Usernames must start with an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@")]),_v(", and can only contain underscores ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_")]),_v(") and alphanumeric characters.")])])]),_v(" "),_m(21),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("GitHub username restrictions")])])]),_v(" "),_c('ul',[_c('li',[_v("Length of username must between 1 and 39 characters")]),_v(" "),_c('li',[_v("Can contain only alphanumeric characters and hyphens ('-').")]),_v(" "),_c('li',[_v("Hyphens cannot appear at the start or end, nor consecutively within the username")])]),_v(" "),_c('p',[_c('strong',[_v("Valid examples")])]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user123")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user-name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username456")])]),_v(" "),_c('p',[_c('strong',[_v("Invalid examples")])]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("very-mega-ultra-super-duper-long-username")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-username")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username-")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("user--name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("username_with_special$chars")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/John Doe e/johnd@example.com telegram/@john github/swag-john33")]),_v(" adds John Doe's contact details with no tags.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/Betsy Crowe t/friend e/betsycrowe@example.com telegram/@Betsy t/criminal github/betsy-29")]),_v(" adds Betsy Crowe's contact details with a friend and criminal tag.")])])]),_v(" "),_m(22),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(23),_v(" "),_c('p',[_v("Displays all persons in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])])])]),_v(" "),_c('hr'),_v(" "),_m(24),_v(" "),_c('p',[_v("Edits an existing person detail in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit INDEX [name/NAME] [email/EMAIL] [telegram/TELEGRAM] [tag/TAG]…​ [github/GITHUB]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("e INDEX [n/NAME] [e/EMAIL] [tele/TELEGRAM] [t/TAG]…​ [g/GITHUB]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Edits the person at the specified "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("INDEX")]),_v(". The index refers to the index number shown in the displayed person list. The index "),_c('strong',[_v("must be a positive integer")]),_v(" 1, 2, 3, …​")]),_v(" "),_c('li',[_v("At least one of the optional fields must be provided.")]),_v(" "),_c('li',[_v("Existing values will be updated to the input values.")]),_v(" "),_c('li',[_v("When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.")]),_v(" "),_c('li',[_v("You can remove all the person’s tags by typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/")]),_v(" without\nspecifying any tags after it.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 1 e/johndoe@example.com")]),_v(" Edits the email address of the 1st person to be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("johndoe@example.com")]),_v(" respectively.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 n/Betsy Crower t/")]),_v(" Edits the name of the 2nd person to be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy Crower")]),_v(" and clears all existing tags.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 1 github/cool-james12 n/James")]),_v(" Edits the name of the 1st person to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James")]),_v(" and github username to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cool-james12")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 telegram/@Mary n/Mary")]),_v(" Edits the name of the 2nd person to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Mary")]),_v(" and telegram ID to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@Mary")]),_v(".")])])]),_v(" "),_m(25),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(26),_v(" "),_c('p',[_v("Find all persons whose names contains any of the given keywords.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find KEYWORD [MORE_KEYWORDS]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("f KEYWORD [MORE_KEYWORDS]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("hans")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans")])]),_v(" "),_c('li',[_v("The order of the keywords does not matter. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Bo")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Bo Hans")])]),_v(" "),_c('li',[_v("Only the name is searched.")]),_v(" "),_c('li',[_v("Only full words will be matched e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Han")]),_v(" will not match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans")])]),_v(" "),_c('li',[_v("Persons matching at least one keyword will be returned (i.e. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OR")]),_v(" search).\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Bo")]),_v(" will return "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Hans Gruber")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Bo Yang")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find John")]),_v(" returns "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("john")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find alex charlotte")]),_v(" returns "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Charlotte")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexCharlotte.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexCharlotte.png","alt":"result for 'find alex charlotte'"}})])])])]),_v(" "),_m(27),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(28),_v(" "),_c('p',[_v("Finds persons whose names contain any of the given tag keywords.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter tag/TAG [tag/MORE_TAG]...")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("f t/TAG [t/MORE_TAG]...")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Friends")])]),_v(" "),_c('li',[_v("At least one tag must be provided.")]),_v(" "),_c('li',[_v("The order of the keywords does not matter. e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friends t/family")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/family t/friends")])]),_v(" "),_c('li',[_v("Only the tags is searched.")]),_v(" "),_c('li',[_v("Only full tag name will be matched e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friend")]),_v(" will not match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")])]),_v(" "),_c('li',[_v("Persons matching at least one keyword will be returned (i.e. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OR")]),_v(" search).\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friends t/family")]),_v(" will return any contact tagged with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friend")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("family")]),_v(".")])])]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/friends")]),_v(" returns any contact tagged with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/filterFriendsTagByFilter.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/filterFriendsTagByFilter.png","alt":"result for 'filter t/friend t/family'"}})])])])]),_v(" "),_m(29),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(30),_v(" "),_c('p',[_v("Deletes the specified person from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete name/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rm n/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Deletes the person with the specified name.")]),_v(" "),_c('li',[_v("The name refers to the full name of the person shown in the displayed person list.")]),_v(" "),_c('li',[_v("If a person matches the name but is not shown in the list, it will not be deleted.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/Betsy")]),_v(" deletes the person with the name "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find Betsy")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete Alex")]),_v(" will not delete the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/Betsy")]),_v(" deletes the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(" if it is shown on the filtered list.")])])]),_v(" "),_m(31),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(32),_v(" "),_c('p',[_v("Launches GitHub repository of the specified person on the browser from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github name/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git n/NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Launches the GitHub repository of the specified person.")]),_v(" "),_c('li',[_v("Person specified needs to have a GitHub username assigned in the Address Book.")]),_v(" "),_c('li',[_v("The name refers to the full name of the person shown in the Address Book.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")]),_v(" launches the GitHub repository of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Harry")]),_v(", using the GitHub username assigned to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Harry")]),_v(".\n"),_c('a',{attrs:{"href":"/tp/images/githubUsage.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/githubUsage.png","alt":"github use case for launching Harry's repository"}})])])])]),_v(" "),_m(33),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(34),_v(" "),_c('p',[_v("Opens a window at the side with the full details of the specified person from the address book.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view [name/NAME]")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v [n/NAME]")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("View the full details of the contact you specify.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("NAME")]),_v(" refers to the full name of the person shown in the displayed person list.")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" without any name parameter closes any windows previously opened by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(".")]),_v(" "),_c('li',[_v("Deleting or editing name of the current contact opened by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" closes "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(".")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/John Doe")]),_v(" opens a window at the side showing the full details of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(".")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/John Doe")]),_v(" followed by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view")]),_v(" closes the window showing the full contact details of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(".\n"),_c('a',{attrs:{"href":"/tp/images/quickStartLaunchScreenshot.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/quickStartLaunchScreenshot.png","alt":"viewing John Doe's contact detail in the view window"}})])])])]),_v(" "),_m(35),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(36),_v(" "),_c('p',[_v("Marks a student as present for a particular week.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark name/NAME week/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("m n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Marks the particular student as present in that week.")]),_v(" "),_c('li',[_v("The full name and week number is "),_c('strong',[_v("compulsory")]),_v(".")]),_v(" "),_c('li',[_v("The name is "),_c('strong',[_v("case-sensitive")]),_v(".")]),_v(" "),_c('li',[_v("The range of the WEEK_NUMBER is between 0 and 13, both inclusive. Rationale being there are 14 weeks per semester.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/Alex Yeoh w/0")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(" as present for week 0.\n"),_c('a',{attrs:{"href":"/tp/images/markAlexPresent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markAlexPresent.png","alt":"result for mark"}})])])])]),_v(" "),_m(37),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(38),_v(" "),_c('p',[_v("Unmarks a student as present for a particular week.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("um n/NAME w/WEEK_NUMBER")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("Unmarks the particular student as present in that week.")]),_v(" "),_c('li',[_v("The full name and week number is "),_c('strong',[_v("compulsory")]),_v(".")]),_v(" "),_c('li',[_v("The name is "),_c('strong',[_v("case-sensitive")]),_v(".")]),_v(" "),_c('li',[_v("The range of the WEEK_NUMBER is between 0 and 13, both inclusive. Rationale being there are 14 weeks per semester.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/Alex Yeoh w/0")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Alex Yeoh")]),_v(" as absent for week 0.\n"),_c('a',{attrs:{"href":"/tp/images/markAlexAbsent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markAlexAbsent.png","alt":"result for unmark"}})])])])]),_v(" "),_m(39),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(40),_v(" "),_c('p',[_v("Sorts the displayed list based on the given field and order.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort FIELD order/ORDER")])])]),_v(" "),_c('p',[_c('span',[_c('strong',[_v("Reset Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")])])])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Order of contact details can be reset to default by calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(".")])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FIELD")]),_v(" that can be sorted by: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("name")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("telegram")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ORDER")]),_v(" that is accepted: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("asc")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("desc")]),_v(".")]),_v(" "),_c('li',[_v("The sort order persists between commands.")]),_v(" "),_c('li',[_v("The sort order will reset when "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(" command is given.")]),_v(" "),_c('li',[_v("The sorting is "),_c('strong',[_v("case-insensitive")]),_v(": upper and lower case are treated as the same values.")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort name order/desc")]),_v(" will sort the displayed list based on their name in ascending order.\n"),_c('a',{attrs:{"href":"/tp/images/sortByNameDesc.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/sortByNameDesc.png","alt":"result_for_sorting"}})])])]),_v(" "),_c('div',{staticClass:"d-print-none"},[_c('hr')]),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(" will reset the displayed list to its default order.\n"),_c('a',{attrs:{"href":"/tp/images/sortReset.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/sortReset.png","alt":"result_for_sorting"}})])])])])]),_v(" "),_c('hr'),_v(" "),_m(41),_v(" "),_c('p',[_v("Clears all entries from the KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")])])])])]),_v(" "),_m(42),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(43),_v(" "),_c('p',[_v("Imports contacts based on CSV file. Importing a file will replace ALL existing contacts")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/CSV_FILE_PATH")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("im p/CSV_FILE_PATH")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("File path can be relative or absolute, but must end with .csv")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/data/group12.csv")]),_v(" will import the contacts found from the CSV (group12.csv from relative path given)")])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("CSV file formatting:")])])]),_v(" "),_c('ul',[_c('li',[_v("The CSV file must have header with the exact required order {\"Name\", \"Email\", \"Telegram\", \"Tags\", \"Github\",\n\"Assignments\", \"WeeksPresent\"} (Case-insensitive)")]),_v(" "),_c('li',[_v("The CSV file must contain information about at least 1 person")]),_v(" "),_c('li',[_v("The data fields for Name, Email, Telegram, Github is compulsory\n"),_c('ul',[_c('li',[_v("Do note that each of these field have their own restrictions\n"),_c('a',{attrs:{"href":"#i-classfa-solid-fa-user-plusi-adding-a-person-add"}},[_v("(refer above)")])])])]),_v(" "),_c('li',[_v("Tags format: enclose tag in square brackets (\"[tag]\"). If a person has multiple tags, separate the tags within\nthe same entry with commas. (e.g.\"[tag1],[tag2],[tag3].....\")\n"),_c('ul',[_c('li',[_v("Duplicate tags will be ignored (e.g.\"[Group1],[Group1]\" will be treated as \"[Group1]\")")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no tags for specific person)")])])]),_v(" "),_c('li',[_v("Assignment format: Assignment name and assignment score should be separated with \"|\" (e.g. Ex01|10). If multiple\nassignments are present for a person, separate them within the same entry using commas. (e.g. Ex01|9, Ex02|5)\n"),_c('ul',[_c('li',[_v("If an assignment name appears twice, the later instance will be used (e.g. Ex01|10, Ex01|5 will cause KonTActs\nto record 5 marks for Assignment Ex01)")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no assignments for specified person)")])])]),_v(" "),_c('li',[_v("WeeksPresent format: Each integer represents a specific week, with each week separated by a comma. (e.g. 1,2,3,4)\n"),_c('ul',[_c('li',[_v("Duplicate weeks will be ignored (e.g. 1,2,3,4,1 will be treated as 1,2,3,4)")]),_v(" "),_c('li',[_v("This field can be empty (will be treated as no weeks attended for specific person)")])])])])]),_v(" "),_m(44),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Example of acceptable CSV file:")])])]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("\"Name\",\"Email\",\"Telegram\",\"Tags\",\"Github\",\"Assignments\",\"WeeksPresent\"\n")]),_c('span',[_v("\"Alex Yeoh\",\"alexyeoh@example.com\",\"@alex\",\"[friends]\",\"Alex\",\"Ex01 | 3.0\",\"5\"\n")]),_c('span',[_v("\"Bernice Yu\",\"berniceyu@example.com\",\"@bernice\",\"[colleagues],[friends]\",\"Bernice\",\"\",\"\"\n")]),_c('span',[_v("\"Charlotte Oliveiro\",\"charlotte@example.com\",\"@charlotte\",\"[friend],[colleague]\",\"Charlotte\",\"\",\"\"\n")]),_c('span',[_v("\"David Li\",\"lidavid@example.com\",\"@david\",\"[family]\",\"david\",\"\",\"\"\n")]),_c('span',[_v("\"Irfan Ibrahim\",\"irfan@example.com\",\"@irfan\",\"[classmates]\",\"Irfan\",\"\",\"\"\n")]),_c('span',[_v("\"Roy Balakrishnan\",\"royb@example.com\",\"@roy\",\"[colleagues]\",\"Roy\",\"\",\"\"\n")])])]),_c('p',[_c('a',{attrs:{"href":"/tp/images/validCSV1.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/validCSV1.png","alt":"Valid CSV(excel)"}})])])]),_v(" "),_m(45),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(46),_v(" "),_c('p',[_v("Exports contacts based on contacts and their details stored in KonTActs.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/DESIRED_FILE_DESTINATION")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ex p/DESIRED_FILE_DESTINATION")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_v("File path can be relative or absolute but must end with .csv")])])]),_v(" "),_c('li',[_v("You must have write permission in order to export CSV file to specified location")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/data/group12.csv")]),_v(" will export the contacts in the Address book as a csv file (group12.csv at the\nrelative path given)")])])]),_v(" "),_m(47),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(48),_v(" "),_m(49),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")]),_v(" arrow keys")])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('p',[_v("Current input in the text field is erased when accessing the command history.")])]),_v(" "),_c('li',[_c('p',[_v("If the current session of KonTActs has no commands added, pressing the "),_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")]),_v(" arrow keys will not have any effect.")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('ol',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")]),_v(" launches the github account of Harry on the browser")]),_v(" "),_c('li',[_v("The command text field box is now empty.")]),_v(" "),_c('li',[_v("Pressing "),_c('kbd',[_v("↑")]),_v(" will retrieve the last input command which will populate the command text field box with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")])]),_v(" "),_c('li',[_v("Continuously pressing "),_c('kbd',[_v("↑")]),_v(" will scroll through all commands that have been previously input.")]),_v(" "),_c('li',[_v("Pressing "),_c('kbd',[_v("↓")]),_v(" will scroll down to the more recent commands that was last input.")])])]),_v(" "),_m(50),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(51),_v(" "),_c('p',[_v("Adds an assignment and its grades to a contact.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade name/NAME assignment/ASSIGNMENT_NAME score/SCORE")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ag n/NAME a/ASSIGNMENT_NAME s/SCORE")])])])])]),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('ul',[_c('li',[_c('p',[_v("Assignments that can be added to a contact are specified in path "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data/assignment.json")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" is missing from "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data")]),_v(", KonTActs will load a default assignment database.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" needs to be manually created in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/data")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Each assignment must have a unique "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSIGNMENT_NAME")]),_v(".")])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('p',[_v("Example with the following assignment.json file:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"assignments\"")]),_v(" : [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex01\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("10")]),_v("\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex02\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("10")]),_v("\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"name\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Ex03\"")]),_v(",\n")]),_c('span',[_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"maxScore\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-number"}},[_v("15")]),_v("\n")]),_c('span',[_v(" }\n")]),_c('span',[_v(" ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/5")]),_v(" will add an assignment name\nAssignment01 with score 5 to contact JohnDoe.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/12")]),_v(" will not add the assignment to contact JohnDoe\nas the input score is greater than the max, as specified in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(" file.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex05 s/5")]),_v(" will not add the assignment to contact JohnDoe\nas the assignment is not specified "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")])])]),_v(" "),_c('box',{attrs:{"type":"success","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-lightbulb",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade")]),_v(" without any fields will show the list of assignments in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("assignment.json")]),_v(".")])]),_v(" "),_c('hr'),_v(" "),_m(52),_v(" "),_c('p',[_v("Removes an assignment and its grades from a contact.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/NAME assignment/ASSIGNMENT_NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Shortcut: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rg n/NAME a/ASSIGNMENT_NAME")])])])])]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-book",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Examples:")])])]),_v(" "),_c('p',[_v("Assuming John Doe has "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ex01")]),_v(" assignment with a score of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("5")]),_v(".")]),_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")]),_v(" will remove the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ex01")]),_v(" assignment from contact John Doe.")]),_v(" "),_c('p',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")]),_v(" again will throw an error since the assignment has already been removed.\nTo add a new assignment, refer to "),_c('a',{attrs:{"href":"#adding-grades-to-a-contact-addgrade"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade")])]),_v(" command above.")])]),_v(" "),_c('hr'),_v(" "),_m(53),_v(" "),_c('p',[_v("Exits the program.")]),_v(" "),_c('box',{attrs:{"type":"definition","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-spell-check",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")])])])])]),_v(" "),_m(54),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(55),_v(" "),_c('p',[_v("KonTActs data are automatically saved in the hard disk after every command that changes data. You do not need to save the data manually.")]),_v(" "),_m(56),_v(" "),_c('hr'),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_c('box',{attrs:{"type":"warning","light":""},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fa-solid fa-circle-exclamation",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_c('strong',[_v("Recommended for more advanced and seasoned users")])]),_v(" "),_c('ul',[_c('li',[_v("Data in the JSON file can be edited.")]),_v(" "),_c('li',[_v("If your changes to the data file results in an invalid format, KonTActs will discard all data and start with an empty data file at the next run.")]),_v(" "),_c('li',[_v("It is recommended to create a backup of the file before editing it. This can be done with the "),_c('a',{attrs:{"href":"#exporting-data-into-csv-file-export"}},[_v("export")]),_v(" command.")]),_v(" "),_c('li',[_v("Certain edits can also cause the KonTActs to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.")])])]),_v(" "),_c('hr'),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_m(61),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_c('br'),_v(" "),_c('hr'),_v(" "),_m(62),_v(" "),_m(63),_v(" "),_c('hr')],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":"#kontacts-user-guide"}},[_v("KonTActs 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":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#summary-of-commands"}},[_v("Summary of commands‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#parameter-shortcuts"}},[_v(" Parameter shortcuts‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-shortcuts"}},[_v(" Command shortcuts‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#features"}},[_v(" Features‎")]),_v(" "),_c('nav',{staticClass:"nav nav-pills flex-column my-0 nested no-flex-wrap"},[_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#viewing-help-help"}},[_v(" Viewing help : help‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-a-person-add"}},[_v(" Adding a person: add‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#listing-all-persons-list"}},[_v(" Listing all persons : list‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-a-person-edit"}},[_v(" Editing a person : edit‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-persons-by-name-find"}},[_v(" Finding persons by name: find‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#filtering-persons-by-tag-filter"}},[_v(" Filtering persons by tag: filter‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person-delete"}},[_v(" Deleting a person : delete‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#launching-github-repository-github"}},[_v(" Launching GitHub repository : github‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#viewing-a-contact-s-full-details-view"}},[_v(" Viewing a contact's full details : view‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#marking-a-student-as-present-mark"}},[_v(" Marking a student as present : mark‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#unmarking-a-student-as-present-unmark"}},[_v(" Unmarking a student as present : unmark‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#sorting-the-displayed-list-sort"}},[_v(" Sorting the displayed list : sort‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#clearing-all-entries-clear"}},[_v(" Clearing all entries : clear‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#importing-data-from-csv-file-import"}},[_v(" Importing data from CSV file : import‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exporting-data-into-csv-file-export"}},[_v(" Exporting data into CSV file : export‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#accessing-command-history-and"}},[_v(" Accessing command history : ↑ and ↓‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#adding-grades-to-a-contact-addgrade"}},[_v(" Adding grades to a contact : addGrade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#removing-grades-from-a-contact-removegrade"}},[_v(" Removing grades from a contact : removeGrade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#exiting-the-program-exit"}},[_v(" Exiting the program : exit‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#saving-the-data"}},[_v(" Saving the data‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#editing-the-data-file"}},[_v(" Editing the data file‎")])]),_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(64)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -35,9 +35,6 @@ with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticC with(this){return _c('div',{staticClass:"d-print-none"},[_c('hr')])} },function anonymous( ) { -with(this){return _c('pre',[_c('code',{pre:true},[_v(" |\n")])])} -},function anonymous( -) { with(this){return _c('h2',{attrs:{"id":"parameter-shortcuts"}},[_c('i',{staticClass:"fa-solid fa-bolt-lightning"}),_v(" Parameter shortcuts"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#parameter-shortcuts","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { @@ -200,6 +197,6 @@ with(this){return _c('h2',{attrs:{"id":"known-issues"}},[_c('i',{staticClass:"fa with(this){return _c('ol',[_c('li',[_c('strong',[_v("When using multiple screens")]),_v(", 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 "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("preferences.json")]),_v(" file created by the application before running the application again.")]),_v(" "),_c('li',[_c('strong',[_v("If you minimize the Help Window")]),_v(" and then run the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")]),_v(" command (or use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Help")]),_v(" menu, or the keyboard shortcut "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("F1")]),_v(") 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.")]),_v(" "),_c('li',[_c('strong',[_v("When using excel to edit telegram username")]),_v(", typing \"@\" will trigger the command function which will output a \"Function is not valid\" error. The remedy is to prefix the telegram username with an apostrophe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("'")]),_v(" to escape from the command function. For example: typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("'@james")]),_v(".\n"),_c('a',{attrs:{"href":"/tp/images/excelKnownIssue.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/excelKnownIssue.png","alt":"excel known issue"}})])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index c05c702b832..8f69657b508 100644 --- a/index.html +++ b/index.html @@ -14,7 +14,7 @@

    KonTActs

    Logo

    Java CI codecov

    Logo

    KonTActs is a desktop application for CS2030 teaching assistants to manage your students', fellow TAs', and professors' contact details. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

    +

    KonTActs

    Logo

    Java CI codecov

    Logo

    KonTActs is a desktop application for CS2030 teaching assistants to manage your students', fellow TAs', and professors' contact details. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index 3fab440c3e2..1563b1021df 100644 --- a/index.page-vue-render.js +++ b/index.page-vue-render.js @@ -23,6 +23,6 @@ with(this){return _c('p',[_v("This project is based on the AddressBook-Level3 pr with(this){return _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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/currynia.html b/team/currynia.html index 51c297d2f4d..c2666c31017 100644 --- a/team/currynia.html +++ b/team/currynia.html @@ -16,7 +16,7 @@ Search

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    +

  • Community:

  • Tools:

  • {you can add/remove categories in the list above}

    • diff --git a/team/currynia.page-vue-render.js b/team/currynia.page-vue-render.js index dee4148d42c..2616e25f7bf 100644 --- a/team/currynia.page-vue-render.js +++ b/team/currynia.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-addressbook-level-3"}},[_v("Project: AddressBook Level 3"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-addressbook-level-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability to undo/redo previous commands.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.")]),_v(" "),_c('li',[_v("Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.")]),_v(" "),_c('li',[_v("Credits: "),_c('em',[_v("{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a history command that allows the user to navigate to previous commands using up/down keys.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5rc")]),_v(" (3 releases) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Updated the GUI color scheme (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#33")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#34")]),_v(")")]),_v(" "),_c('li',[_v("Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#36")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#38")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" "),_c('a',{attrs:{"href":""}},[_v("#72")])]),_v(" "),_c('li',[_v("Did cosmetic tweaks to existing documentation of features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("#74")])])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" feature.")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":""}},[_v("#12")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#32")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#19")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#42")])]),_v(" "),_c('li',[_v("Contributed to forum discussions (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("4")]),_v(")")]),_v(" "),_c('li',[_v("Reported bugs and suggestions for other teams in the class (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(")")]),_v(" "),_c('li',[_v("Some parts of the history feature I added was adopted by several other class mates ("),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Tools")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Integrated a third party library (Natty) to the project ("),_c('a',{attrs:{"href":""}},[_v("#42")]),_v(")")]),_v(" "),_c('li',[_v("Integrated a new Github plugin (CircleCI) to the team repo")])])]),_v(" "),_c('li',[_c('p',[_c('em',[_v("{you can add/remove categories in the list above}")])])])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/dessnowy.html b/team/dessnowy.html index 19f4d36a03f..38714b64247 100644 --- a/team/dessnowy.html +++ b/team/dessnowy.html @@ -16,7 +16,7 @@ Search

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    +

  • Community:

  • Tools:

  • {you can add/remove categories in the list above}

    • diff --git a/team/dessnowy.page-vue-render.js b/team/dessnowy.page-vue-render.js index dee4148d42c..2616e25f7bf 100644 --- a/team/dessnowy.page-vue-render.js +++ b/team/dessnowy.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-addressbook-level-3"}},[_v("Project: AddressBook Level 3"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-addressbook-level-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability to undo/redo previous commands.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.")]),_v(" "),_c('li',[_v("Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.")]),_v(" "),_c('li',[_v("Credits: "),_c('em',[_v("{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a history command that allows the user to navigate to previous commands using up/down keys.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5rc")]),_v(" (3 releases) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Updated the GUI color scheme (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#33")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#34")]),_v(")")]),_v(" "),_c('li',[_v("Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#36")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#38")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" "),_c('a',{attrs:{"href":""}},[_v("#72")])]),_v(" "),_c('li',[_v("Did cosmetic tweaks to existing documentation of features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("#74")])])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" feature.")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":""}},[_v("#12")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#32")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#19")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#42")])]),_v(" "),_c('li',[_v("Contributed to forum discussions (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("4")]),_v(")")]),_v(" "),_c('li',[_v("Reported bugs and suggestions for other teams in the class (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(")")]),_v(" "),_c('li',[_v("Some parts of the history feature I added was adopted by several other class mates ("),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Tools")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Integrated a third party library (Natty) to the project ("),_c('a',{attrs:{"href":""}},[_v("#42")]),_v(")")]),_v(" "),_c('li',[_v("Integrated a new Github plugin (CircleCI) to the team repo")])])]),_v(" "),_c('li',[_c('p',[_c('em',[_v("{you can add/remove categories in the list above}")])])])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/incogdino.html b/team/incogdino.html index 7bdba8a935f..44eb82d9da7 100644 --- a/team/incogdino.html +++ b/team/incogdino.html @@ -14,7 +14,7 @@

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    +

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    diff --git a/team/incogdino.page-vue-render.js b/team/incogdino.page-vue-render.js index 63498cfdfd8..8d9d6257698 100644 --- a/team/incogdino.page-vue-render.js +++ b/team/incogdino.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-addressbook-level-3"}},[_v("Project: AddressBook Level 3"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-addressbook-level-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.")]),_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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/swaminathanviswa.html b/team/swaminathanviswa.html index cb2b52eaedb..b5d1eea5b87 100644 --- a/team/swaminathanviswa.html +++ b/team/swaminathanviswa.html @@ -16,7 +16,7 @@ Search

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    +

  • Community:

  • Tools:

  • {you can add/remove categories in the list above}

    • diff --git a/team/swaminathanviswa.page-vue-render.js b/team/swaminathanviswa.page-vue-render.js index dee4148d42c..2616e25f7bf 100644 --- a/team/swaminathanviswa.page-vue-render.js +++ b/team/swaminathanviswa.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-addressbook-level-3"}},[_v("Project: AddressBook Level 3"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-addressbook-level-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability to undo/redo previous commands.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.")]),_v(" "),_c('li',[_v("Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.")]),_v(" "),_c('li',[_v("Credits: "),_c('em',[_v("{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a history command that allows the user to navigate to previous commands using up/down keys.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5rc")]),_v(" (3 releases) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Updated the GUI color scheme (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#33")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#34")]),_v(")")]),_v(" "),_c('li',[_v("Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#36")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#38")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" "),_c('a',{attrs:{"href":""}},[_v("#72")])]),_v(" "),_c('li',[_v("Did cosmetic tweaks to existing documentation of features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("#74")])])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" feature.")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":""}},[_v("#12")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#32")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#19")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#42")])]),_v(" "),_c('li',[_v("Contributed to forum discussions (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("4")]),_v(")")]),_v(" "),_c('li',[_v("Reported bugs and suggestions for other teams in the class (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(")")]),_v(" "),_c('li',[_v("Some parts of the history feature I added was adopted by several other class mates ("),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Tools")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Integrated a third party library (Natty) to the project ("),_c('a',{attrs:{"href":""}},[_v("#42")]),_v(")")]),_v(" "),_c('li',[_v("Integrated a new Github plugin (CircleCI) to the team repo")])])]),_v(" "),_c('li',[_c('p',[_c('em',[_v("{you can add/remove categories in the list above}")])])])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/tohjh.html b/team/tohjh.html index 3243754e9d5..cc0e2c98cdc 100644 --- a/team/tohjh.html +++ b/team/tohjh.html @@ -16,7 +16,7 @@ Search

    Project: AddressBook Level 3

    AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

    Given below are my contributions to the project.

    +

  • Community:

  • Tools:

  • {you can add/remove categories in the list above}

    • diff --git a/team/tohjh.page-vue-render.js b/team/tohjh.page-vue-render.js index dee4148d42c..2616e25f7bf 100644 --- a/team/tohjh.page-vue-render.js +++ b/team/tohjh.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-addressbook-level-3"}},[_v("Project: AddressBook Level 3"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-addressbook-level-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.")]),_v(" "),_c('p',[_v("Given below are my contributions to the project.")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added the ability to undo/redo previous commands.")]),_v(" "),_c('ul',[_c('li',[_v("What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.")]),_v(" "),_c('li',[_v("Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.")]),_v(" "),_c('li',[_v("Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.")]),_v(" "),_c('li',[_v("Credits: "),_c('em',[_v("{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("New Feature")]),_v(": Added a history command that allows the user to navigate to previous commands using up/down keys.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Code contributed")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("RepoSense link")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Project management")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Managed releases "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.3")]),_v(" - "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("v1.5rc")]),_v(" (3 releases) on GitHub")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Enhancements to existing features")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Updated the GUI color scheme (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#33")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#34")]),_v(")")]),_v(" "),_c('li',[_v("Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests "),_c('a',{attrs:{"href":""}},[_v("#36")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#38")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Documentation")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("User Guide:\n"),_c('ul',[_c('li',[_v("Added documentation for the features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find")]),_v(" "),_c('a',{attrs:{"href":""}},[_v("#72")])]),_v(" "),_c('li',[_v("Did cosmetic tweaks to existing documentation of features "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(": "),_c('a',{attrs:{"href":""}},[_v("#74")])])])]),_v(" "),_c('li',[_v("Developer Guide:\n"),_c('ul',[_c('li',[_v("Added implementation details of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete")]),_v(" feature.")])])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Community")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("PRs reviewed (with non-trivial review comments): "),_c('a',{attrs:{"href":""}},[_v("#12")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#32")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#19")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("#42")])]),_v(" "),_c('li',[_v("Contributed to forum discussions (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("4")]),_v(")")]),_v(" "),_c('li',[_v("Reported bugs and suggestions for other teams in the class (examples: "),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("3")]),_v(")")]),_v(" "),_c('li',[_v("Some parts of the history feature I added was adopted by several other class mates ("),_c('a',{attrs:{"href":""}},[_v("1")]),_v(", "),_c('a',{attrs:{"href":""}},[_v("2")]),_v(")")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Tools")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("Integrated a third party library (Natty) to the project ("),_c('a',{attrs:{"href":""}},[_v("#42")]),_v(")")]),_v(" "),_c('li',[_v("Integrated a new Github plugin (CircleCI) to the team repo")])])]),_v(" "),_c('li',[_c('p',[_c('em',[_v("{you can add/remove categories in the list above}")])])])])])} },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 Thu, 7 Nov 2024, 23:26:37 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 Fri, 8 Nov 2024, 0:05:12 GMT+8]")])])])} }]; \ No newline at end of file