diff --git a/AboutUs.html b/AboutUs.html index f6d0874c095..32e24a30ba4 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -21,7 +21,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 07294f8ac88..1448e0eac3f 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index a292ae27704..2aa396653ef 100644 --- a/Configuration.html +++ b/Configuration.html @@ -16,7 +16,7 @@ Search

Configuration guide

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

+
  • About Us

    • Configuration guide

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

    diff --git a/Configuration.page-vue-render.js b/Configuration.page-vue-render.js index 062c2ef3b27..e2ea60c6894 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index b4dd2d831ce..dcca6ec39c6 100644 --- a/DevOps.html +++ b/DevOps.html @@ -18,7 +18,7 @@
  • About Us

    • DevOps guide

    Build automation

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

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

    Continuous integration (CI)

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

    Code coverage

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

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

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

    Repository-wide checks

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

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

    ./config/travis/run-checks.sh

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

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

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

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

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

  • test: Runs all tests.

    • Continuous integration (CI)

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

    Code coverage

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

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

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

    Repository-wide checks

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

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

    ./config/travis/run-checks.sh

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

    If adding new checks:

    Making a release

    Here are the steps to create a new release.

    1. Update the version number in MainApp.java.
    2. Generate a fat JAR file using Gradle (i.e., gradlew shadowJar).
    3. Tag the repo with the version number. e.g. v0.1
    4. Create a new release using GitHub. Upload the JAR file you created.
    diff --git a/DevOps.page-vue-render.js b/DevOps.page-vue-render.js index 29ae018ed31..caac0dc7774 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 52460a26ee3..5d32107e2ba 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -16,7 +16,7 @@ Search

    KonTActs Developer Guide

    Acknowledgements

    { list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }

    Setting up, getting started

    Refer to the guide Setting up and getting started.

    Design

    Architecture

    The Architecture Diagram given above explains the high-level design of the App.

    Given below is a quick overview of main components and how they interact with each other.

    Main components of the architecture

    Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

    The bulk of the app's work is done by the following four components:

    Commons represents a collection of classes used by multiple other components.

    How the architecture components interact with each other

    The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete 1.

    Each of the four main components (also shown in the diagram above),

    For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

    The sections below give more details of each component.

    UI component

    The API of this component is specified in Ui.java

    Structure of the UI Component

    The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

    The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

    The UI component,

    Logic component

    API : Logic.java

    Here's a (partial) class diagram of the Logic component:

    The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete n/John") API call as an example.

    Interactions Inside the Logic Component for the `delete 1` Command

    Note: The lifeline for DeleteCommandParser should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.

    How the Logic component works:

    1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
    2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
    3. The command can communicate with the Model when it is executed (e.g. to delete a person).
      +
  • About Us

    • KonTActs Developer Guide

    Acknowledgements

    { list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }

    Setting up, getting started

    Refer to the guide Setting up and getting started.

    Design

    Architecture

    The Architecture Diagram given above explains the high-level design of the App.

    Given below is a quick overview of main components and how they interact with each other.

    Main components of the architecture

    Main (consisting of classes Main and MainApp) is in charge of the app launch and shut down.

    The bulk of the app's work is done by the following four components:

    Commons represents a collection of classes used by multiple other components.

    How the architecture components interact with each other

    The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete n/John.

    Each of the four main components (also shown in the diagram above),

    For example, the Logic component defines its API in the Logic.java interface and implements its functionality using the LogicManager.java class which follows the Logic interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.

    The sections below give more details of each component.

    UI component

    The API of this component is specified in Ui.java

    Structure of the UI Component

    The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter etc. All these, including the MainWindow, inherit from the abstract UiPart class which captures the commonalities between classes that represent parts of the visible GUI.

    The UI component uses the JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

    The UI component,

    Logic component

    API : Logic.java

    Here's a (partial) class diagram of the Logic component:

    The sequence diagram below illustrates the interactions within the Logic component, taking execute("delete n/John") API call as an example.

    Interactions Inside the Logic Component for the `delete 1` Command

    Note: The lifeline for DeleteCommandParser should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline continues till the end of diagram.

    How the Logic component works:

    1. When Logic is called upon to execute a command, it is passed to an AddressBookParser object which in turn creates a parser that matches the command (e.g., DeleteCommandParser) and uses it to parse the command.
    2. This results in a Command object (more precisely, an object of one of its subclasses e.g., DeleteCommand) which is executed by the LogicManager.
    3. The command can communicate with the Model when it is executed (e.g. to delete a person).
      Note that although this is shown as a single step in the diagram above (for simplicity), in the code it can take several interactions (between the command object and the Model) to achieve.
    4. The result of the command execution is encapsulated as a CommandResult object which is returned back from Logic.

    Here are the other classes in Logic (omitted from the class diagram above) that are used for parsing a user command:

    How the parsing works:

    Model component

    API : Model.java

    The Model component,

    Note: An alternative (arguably, a more OOP) model is given below. It has a Tag list in the AddressBook, which Person references. This allows AddressBook to only require one Tag object per unique tag, instead of each Person needing their own Tag objects.

    Storage component

    API : Storage.java

    The Storage component,

    Common classes

    Classes used by multiple components are in the seedu.address.commons package.

    Implementation

    This section describes some noteworthy details on how certain features are implemented.

    [Proposed] Undo/redo feature

    Proposed Implementation

    The proposed undo/redo mechanism is facilitated by VersionedAddressBook. It extends AddressBook with an undo/redo history, stored internally as an addressBookStateList and currentStatePointer. Additionally, it implements the following operations:

    These operations are exposed in the Model interface as Model#commitAddressBook(), Model#undoAddressBook() and Model#redoAddressBook() respectively.

    Given below is an example usage scenario and how the undo/redo mechanism behaves at each step.

    Step 1. The user launches the application for the first time. The VersionedAddressBook will be initialized with the initial address book state, and the currentStatePointer pointing to that single address book state.

    UndoRedoState0

    Step 2. The user executes delete 5 command to delete the 5th person in the address book. The delete command calls Model#commitAddressBook(), causing the modified state of the address book after the delete 5 command executes to be saved in the addressBookStateList, and the currentStatePointer is shifted to the newly inserted address book state.

    UndoRedoState1

    Step 3. The user executes add n/David …​ to add a new person. The add command also calls Model#commitAddressBook(), causing another modified address book state to be saved into the addressBookStateList.

    UndoRedoState2

    Note: If a command fails its execution, it will not call Model#commitAddressBook(), so the address book state will not be saved into the addressBookStateList.

    Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the undo command. The undo command will call Model#undoAddressBook(), which will shift the currentStatePointer once to the left, pointing it to the previous address book state, and restores the address book to that state.

    UndoRedoState3

    Note: If the currentStatePointer is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The undo command uses Model#canUndoAddressBook() to check if this is the case. If so, it will return an error to the user rather than attempting to perform the undo.

    The following sequence diagram shows how an undo operation goes through the Logic component:

    UndoSequenceDiagram-Logic

    Note: The lifeline for UndoCommand should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.

    Similarly, how an undo operation goes through the Model component is shown below:

    UndoSequenceDiagram-Model

    The redo command does the opposite — it calls Model#redoAddressBook(), which shifts the currentStatePointer once to the right, pointing to the previously undone state, and restores the address book to that state.

    Note: If the currentStatePointer is at index addressBookStateList.size() - 1, pointing to the latest address book state, then there are no undone AddressBook states to restore. The redo command uses Model#canRedoAddressBook() to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.

    Step 5. The user then decides to execute the command list. Commands that do not modify the address book, such as list, will usually not call Model#commitAddressBook(), Model#undoAddressBook() or Model#redoAddressBook(). Thus, the addressBookStateList remains unchanged.

    UndoRedoState4

    Step 6. The user executes clear, which calls Model#commitAddressBook(). Since the currentStatePointer is not pointing at the end of the addressBookStateList, all address book states after the currentStatePointer will be purged. Reason: It no longer makes sense to redo the add n/David …​ command. This is the behavior that most modern desktop applications follow.

    UndoRedoState5

    The following activity diagram summarizes what happens when a user executes a new command:

    Design considerations:

    Aspect: How undo & redo executes:

    {more aspects and alternatives to be added}

    [Proposed] Data archiving

    {Explain here how the data archiving feature will be implemented}

    Documentation, logging, testing, configuration, dev-ops

    Appendix: Requirements

    Product scope

    Target user profile:

    Value proposition: manage contacts faster than a typical mouse/GUI driven app

    User stories

    Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

    Priority As a/an …​ I want to …​ So that …​
    * * * CS2030S TA store student's github username I can easily reference them when grading assignments.
    * * * user add the student's contact number I can easily reference them when I need to contact my students.
    * * * CS2030S TA add the contact details of other TAs I can quickly reach out for help or collaboration.
    * * * CS2030S TA add contact details of professors I can easily reach them for guidance or to pass on important information.
    * * * CS2030S TA delete contacts easily I dont clutter the list with unwanted contacts.
    * * * CS2030S TA store the grades and progress of my students I can keep track of which of my students need more guidance and follow up.
    * * * CS2030S TA store student's telegram username I can easily reference them and contact them when needed to.
    * * * CS2030S TA see the student's MC or reasoning when they do not turn up for lessons I can create make up lessons / check up on them.
    * * CS2030S TA have a function to hide the details of students that I do not need I can only the the information that I want to see.
    * * CS2030S TA view the last modification date of student contact details I can confirm the accuracy and recency of the information stored.
    * * CS2030S TA create contacts with optional fields I can resepct the privacy of my students.
    * CS2030S TA search for a student’s GitHub username I can quickly access their repository for grading and feedback.
    * potential user see the application populated with sample data I can see how the app looks like when it is in use.
    * CS2030S TA put the contacts into different tabs I can easily navigate between different types of contacts.
    * CS2030S TA use the command line interface to search for contacts I can integrate the tool smoothly into my existing workflow.
    * CS2030S TA search for the contact details of professors/ other TAs I can quickly contact them for help if needed.
    * CS2030S TA find my students house in time I can offer them help in times of crisis.
    * CS2030S TA organise the contact of my students I can view the details of each student with greater ease.
    * CS2030S TA import student contact information from a file I can easily transfer data between devices.
    * CS2030S TA export student contact information to a file I can backup or share contact details with other TAs or professors if needed.
    * CS2030S TA flag specific students for follow-up I can easily identify students who may need additional support or guidance.
    * CS2030S TA choose to sort my students I can group students based on their proficiency.
    * CS2030S TA filter the contact details that is shown I can easily find the information of a particular group.
    * CS2030S TA filter contacts based on a certain criteria I can access a specific subset of students that I want.
    * CS2030S TA tag students with custom labels I can categorize students based on their progress or needs.
    * CS2030S TA use the command line to access my students work have their work and contact and tags all tied together in one smooth workflow.
    * experienced user create shortcuts for commands that I use frequently I can access the frequently used information quickly.
    * new user use a help function to check what this app offers I can easily have the details of the commands to use in my fingertips.
    * CS2030S TA create automatic flags to indicate if a student's work is marked I can monitor grading deadlines so that I can stay on top of my responsibilities without missing any critical dates.

    Use cases

    (For all use cases below, the System is the KonTActs and the Actor is the user, unless specified otherwise)

    Use case: UC01 - Add contacts

    MSS

    1. User chooses to add a contact.

    2. KonTActs requests for the contact details.

    3. User enters the contact details.

    4. KonTActs adds the new contact.

      Use case ends.

    Extensions


    Use case: UC02 - Delete contacts

    Precondition

    1. The task that the user wants to delete exists.

    MSS

    1. User indicates to delete a task.

    2. KonTActs deletes the tasks and indicates success.

      Use case ends.

    Extensions


    Use case: UC03 - Add grades of students

    Precondition

    1. The student that the user wants to add grades exists.
    2. The assignment that the user wants to add a grade to exists.

    MSS

    1. User chooses to add grades for a student.

    2. KonTActs requests for details of the student alongside the assignment and grade.

    3. User enters the requested details.

    4. KonTActs updates the grade of the student.

      Use case ends.

    Extensions

    Use case: UC04 - View Contact

    MSS

    1. Current UI is not showing the entire contact list.
    2. User chooses to view the entire contact list.
    3. KonTActs displays the full list of contacts.
      @@ -26,7 +26,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 2399a851e60..54c40df0219 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -47,7 +47,7 @@ with(this){return _c('p',[_c('a',{attrs:{"href":"#common-classes"}},[_c('strong' with(this){return _c('p',[_c('strong',[_v("How the architecture components interact with each other")])])} },function anonymous( ) { -with(this){return _c('p',[_v("The "),_c('em',[_v("Sequence Diagram")]),_v(" below shows how the components interact with each other for the scenario where the user issues the command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete 1")]),_v(".")])} +with(this){return _c('p',[_v("The "),_c('em',[_v("Sequence Diagram")]),_v(" below shows how the components interact with each other for the scenario where the user issues the command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/John")]),_v(".")])} },function anonymous( ) { with(this){return _c('ul',[_c('li',[_v("defines its "),_c('em',[_v("API")]),_v(" in an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" with the same name as the Component.")]),_v(" "),_c('li',[_v("implements its functionality using a concrete "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("{Component Name}Manager")]),_v(" class (which follows the corresponding API "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" mentioned in the previous point.")])])} @@ -482,6 +482,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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index ecae455efae..aa590c01996 100644 --- a/Documentation.html +++ b/Documentation.html @@ -16,7 +16,7 @@ Search

    Documentation Guide

    Style guidance:

    Converting to PDF

    +
  • About Us

    • Documentation Guide

    Style guidance:

    Converting to PDF

    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 8c1f3c5ebb9..9303ffc3d62 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index 8eae66b6d90..3c058735a0f 100644 --- a/Logging.html +++ b/Logging.html @@ -16,7 +16,7 @@ Search

    Logging guide

    +
  • About Us

    • Logging guide

    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index a9bac82532c..18fb499ce95 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index eae14895c58..b44ea0059d6 100644 --- a/SettingUp.html +++ b/SettingUp.html @@ -22,7 +22,7 @@
  • Verify the setup:
    1. Run the seedu.address.Main and try a few commands.
    2. Run the tests to ensure they all pass.

    • Before writing code

    1. Configure the coding style

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

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

    2. Set up CI

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

    3. Learn the design

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

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

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

    diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index 65b88323503..1735763d333 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 0859a9fc9c1..eb6777b35bd 100644 --- a/Testing.html +++ b/Testing.html @@ -20,7 +20,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle

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

    Types of tests

    This project has three types of tests:

    1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest
    2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest
    3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      -e.g. seedu.address.logic.LogicManagerTest
    +e.g. seedu.address.logic.LogicManagerTest diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index 0ab182f5a6b..c1a8d051c07 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index ec49d66f574..e24eed510f9 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -18,19 +18,19 @@
  • About Us

    • KonTActs User Guide

    konTActs is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, konTActs can get your contact management tasks done faster than traditional GUI apps.

    Quick start

    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 your AddressBook.

    4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar addressbook.jar command to run the application.
      A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
      Ui

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

      • add n/James Ho p/22224444 e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool : Adds a contact named James Ho to the Address Book.

      • delete n/James Ho : Deletes the contact with name James Ho if it is shown in the current list.

      • clear : Deletes all contacts.

      • exit : Exits the app.

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

    Summary of commands

    Action Format, Examples
    Add add n/NAME p/PHONE_NUMBER e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB
    e.g., add n/James Ho p/22224444 e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool
    Clear clear
    Delete delete n/NAME
    e.g., delete n/James
    Edit edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]
    e.g.,edit 2 n/James Lee e/jameslee@example.com
    Find find KEYWORD [MORE_KEYWORDS]
    e.g., find James Jake
    Filter filter t/[TAG] t/[MORE_TAG]…​
    e.g., filter t/friends t/family
    List list
    Help help
    View view [n/NAME]
    e.g., view n/JohnDoe
    Github github n/NAME
    e.g., github n/Harry
    Mark mark n/NAME w/WEEK NUMBER
    e.g. mark n/John Doe w/1
    Unmark unmark n/NAME w/WEEK NUMBER
    e.g. unmark n/John Doe w/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 n/NAME asgn/ASSIGNMENT_NAME s/SCORE
    e.g. addGrade n/JohnDoe asgn/Ex01 s/5
    Remove grade removeGrade n/NAME asgn/ASSIGNMENT_NAME
    e.g. removeGrade n/John Doe asgn/Ex01



    Features

    Notes about the command format:

    • Words in UPPER_CASE are the parameters to be supplied by the user.
      +Some example commands you can try:

      • list : Lists all contacts.

      • add n/James Ho e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool : Adds a contact named James Ho to the Address Book.

      • delete n/James Ho : Deletes the contact with name James Ho if it is shown in the current list.

      • clear : Deletes all contacts.

      • exit : Exits the app.

    • Refer to the Features below for details of each command. +

      • Summary of commands

      Action Format, Examples
      Add add n/NAME e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB
      e.g., add n/James Ho e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool
      Clear clear
      Delete delete n/NAME
      e.g., delete n/James
      Edit edit INDEX [n/NAME] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]
      e.g.,edit 2 n/James Lee e/jameslee@example.com
      Find find KEYWORD [MORE_KEYWORDS]
      e.g., find James Jake
      Filter filter t/[TAG] t/[MORE_TAG]…​
      e.g., filter t/friends t/family
      List list
      Help help
      View view [n/NAME]
      e.g., view n/JohnDoe
      Github github n/NAME
      e.g., github n/Harry
      Mark mark n/NAME w/WEEK NUMBER
      e.g. mark n/John Doe w/1
      Unmark unmark n/NAME w/WEEK NUMBER
      e.g. unmark n/John Doe w/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 n/NAME asgn/ASSIGNMENT_NAME s/SCORE
      e.g. addGrade n/JohnDoe asgn/Ex01 s/5
      Remove grade removeGrade n/NAME asgn/ASSIGNMENT_NAME
      e.g. removeGrade n/John Doe asgn/Ex01



      Features

      Notes about the command format:

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

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

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

      • Parameters can be in any order.
        -e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

      • Extraneous parameters for commands that do not take in parameters (such as help, list, exit and clear) will be ignored.
        -e.g. if the command specifies help 123, it will be interpreted as help.

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

      Viewing help : help

      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.

      A compact reference guide is also provided for quick reference.

      Format: help

      The help window is launched in a separate window.

      help message

      Adding a person: add

      Adds a person to KonTActs.

      Format: add n/NAME p/PHONE_NUMBER e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB

      A person can have any number of tags (including 0)

      Tag restrictions

      • Tags must be a single word containing only alphanumeric characters (no spaces or special symbols are allowed).
      • To specify multiple tags, separate each tag with a space.

      GitHub username restrictions

      • Length of username must between 1 and 39 characters
      • Can contain only alphanumeric characters and hyphens ('-').
      • Hyphens cannot appear at the start or end, nor consecutively within the username

      Valid examples

      user123, user-name, username456

      Invalid examples

      very-mega-ultra-super-duper-long-username, -username, username-, user--name, username_with_special$chars

      Examples:

      • add n/John Doe p/98765432 e/johnd@example.com telegram/@john github/swag-john33 adds John Doe's contact details with no tags.
      • add n/Betsy Crowe t/friend e/betsycrowe@example.com p/1234567 telegram/@Betsy t/criminal github/betsy-29 adds Betsy Crowe's contact details with a friend and criminal tag.

      Listing all persons : list

      Displays all persons in KonTActs.

      Format: list

      Editing a person : edit

      Edits an existing person detail in KonTActs.

      Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]

      • Edits the person at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​
      • At least one of the optional fields must be provided.
      • Existing values will be updated to the input values.
      • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
      • You can remove all the person’s tags by typing t/ without -specifying any tags after it.

      Examples:

      • edit 1 p/91234567 e/johndoe@example.com Edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.
      • edit 2 n/Betsy Crower t/ Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.
      • edit 1 github/cool-james12 n/James Edits the name of the 1st person to James and github username to cool-james12.
      • edit 2 telegram/@Mary n/Mary Edits the name of the 2nd person to Mary and telegram ID to @Mary.

      Finding persons by name: find

      Find all persons whose names contains any of the given keywords.

      Format: find KEYWORD [MORE_KEYWORDS]

      • The search is case-insensitive. e.g hans will match Hans
      • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
      • Only the name is searched.
      • Only full words will be matched e.g. Han will not match Hans
      • Persons matching at least one keyword will be returned (i.e. OR search). +e.g. if the command specifies n/NAME telegram/TELEGRAM, telegram/TELEGRAM n/NAME is also acceptable.

      • Extraneous parameters for commands that do not take in parameters (such as help, list, exit and clear) will be ignored.
        +e.g. if the command specifies help 123, it will be interpreted as help.

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

      Viewing help : help

      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.

      A compact reference guide is also provided for quick reference.

      Format: help

      The help window is launched in a separate window.

      help message

      Adding a person: add

      Adds a person to KonTActs.

      Format: add n/NAME e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB

      A person can have any number of tags (including 0)

      Tag restrictions

      • Tags must be a single word containing only alphanumeric characters (no spaces or special symbols are allowed).
      • To specify multiple tags, separate each tag with a space.

      GitHub username restrictions

      • Length of username must between 1 and 39 characters
      • Can contain only alphanumeric characters and hyphens ('-').
      • Hyphens cannot appear at the start or end, nor consecutively within the username

      Valid examples

      user123, user-name, username456

      Invalid examples

      very-mega-ultra-super-duper-long-username, -username, username-, user--name, username_with_special$chars

      Examples:

      • add n/John Doe e/johnd@example.com telegram/@john github/swag-john33 adds John Doe's contact details with no tags.
      • add n/Betsy Crowe t/friend e/betsycrowe@example.com telegram/@Betsy t/criminal github/betsy-29 adds Betsy Crowe's contact details with a friend and criminal tag.

      Listing all persons : list

      Displays all persons in KonTActs.

      Format: list

      Editing a person : edit

      Edits an existing person detail in KonTActs.

      Format: edit INDEX [n/NAME] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]

      • Edits the person at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​
      • At least one of the optional fields must be provided.
      • Existing values will be updated to the input values.
      • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
      • You can remove all the person’s tags by typing t/ without +specifying any tags after it.

      Examples:

      • edit 1 e/johndoe@example.com Edits the email address of the 1st person to be johndoe@example.com respectively.
      • edit 2 n/Betsy Crower t/ Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.
      • edit 1 github/cool-james12 n/James Edits the name of the 1st person to James and github username to cool-james12.
      • edit 2 telegram/@Mary n/Mary Edits the name of the 2nd person to Mary and telegram ID to @Mary.

      Finding persons by name: find

      Find all persons whose names contains any of the given keywords.

      Format: find KEYWORD [MORE_KEYWORDS]

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

      Examples:

      • find John returns john and John Doe
      • find alex david returns Alex Yeoh, David Li
        result for 'find alex david'

      Filtering persons by tag: filter

      Finds persons whose names contain any of the given tag keywords.

      Format: filter t/TAG [t/MORE_TAG]...

      • The search is case-sensitive. e.g friends will not match Friends
      • At least one tag must be provided.
      • The order of the keywords does not matter. e.g. t/friends t/family will match t/family t/friends
      • Only the tags is searched.
      • Only full tag name will be matched e.g. friend will not match friends
      • Persons matching at least one keyword will be returned (i.e. OR search). e.g. t/friends t/family will return any contact tagged with friend or family.

      Examples:

      • filter t/friend t/family returns any contact tagged with friend or family
        result for 'filter t/friend t/family'

      Deleting a person : delete

      Deletes the specified person from the address book.

      Format: delete n/NAME

      • Deletes the person with the specified name.
      • The name refers to the full name of the person shown in the displayed person list.
      • If a person matches the name but is not shown in the list, it will not be deleted.

      Examples:

      • list followed by delete n/Betsy deletes the person with the name Betsy.
      • find Betsy followed by delete Alex will not delete the person named Alex.
      • delete n/Betsy deletes the person named Betsy if it is shown on the filtered list.

      Launching GitHub repository : github

      Launches GitHub repository of the specified person on the browser from the address book.

      Format: github n/NAME

      • Launches the GitHub repository of the specified person.
      • Person specified needs to have a GitHub username assigned in the Address Book.
      • The name refers to the full name of the person shown in the Address Book.

      Examples:

      • github n/Betsy launches the GitHub repository of the person named Betsy, using the GitHub username assigned to Betsy.

      Viewing a contact's full details : view

      Opens a window at the side with the full details of the specified person from the address book.

      Format: view [n/NAME]

      • View the full details of the selected contact.
      • The name refers to the full name of the person shown in the displayed person list.
      • Calling view without any name parameter closes any windows previously opened by view.

      Examples:

      • view n/JohnDoe opens a window at the side showing the full details of the person named JohnDoe.
      • Calling view n/JohnDoe followed by view closes the window showing the full contact details of JohnDoe.

      Marking a student as present : mark

      Marks a student as present for a particular week.

      Format: mark n/NAME w/[WEEK_NUMBER]

      • Marks the particular student as present in that week.
      • The name and week number is compulsory.
      • The name is case-sensitive.
      • The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 weeks per semester.

      Examples:

      • mark n/Viswa w/1 marks the student named Viswa as present for week 1. result for mark

      Unmarking a student as present : unmark

      Unmarks a student as present for a particular week.

      Format: unmark n/NAME w/[WEEK_NUMBER]

      • Unmarks the particular student as present in that week.
      • The name and week number is compulsory.
      • The name is case-sensitive.
      • The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 weeks per semester.

      Examples:

      • unmarks n/John Doe w/1 unmarks the student named JohnDoe as present for week 1. -result for unmark

      Sorting the displayed list : sort

      Sorts the displayed list based on the given field and order.

      Format: sort FIELD order/ORDER

      • Current FIELD that can be sorted by: github, name, telegram.
      • Current ORDER that is accepted: asc, desc.
      • The sort order will persist between commands.
      • The sorting is case-insensitive: upper and lower case are treated as the same values.

      Examples:

      • sort name order/asc will sort the displayed list based on their name in ascending order.

      Clearing all entries : clear

      Clears all entries from the address book.

      Format: clear

      Importing data from CSV file import

      Imports contacts based on CSV file. Importing a file will replace ALL existing contacts

      Format: import path/CSV_FILE_PATH

      • File path can be relative or absolute, but must end with .csv

      Examples:

      • import path/data/group12.csv will import the contacts found from the CSV (group12.csv from relative path given)

      CSV file formatting:

      • The CSV file must have header with the exact required order {"Name", "Phone", "Email", "Telegram", "Tags", "Github", -"Assignments", "WeeksPresent"} (Case-insensitive)
      • The CSV file must contain information about at least 1 person
      • The data fields for Name, Phone, Email, Telegram, Github is compulsory
      • Tags format: enclose tag in square brackets ("[tag]"). If a person has multiple tags, separate the tags within the same entry +result for unmark

      Sorting the displayed list : sort

      Sorts the displayed list based on the given field and order.

      Format: sort FIELD order/ORDER

      Reset Format: sort reset

      • Current FIELD that can be sorted by: github, name, telegram.
      • Current ORDER that is accepted: asc, desc.
      • The sort order will persist between commands.
      • The sort order will reset when sort reset command is given.
      • The sorting is case-insensitive: upper and lower case are treated as the same values.

      Examples:

      • sort name order/asc will sort the displayed list based on their name in ascending order.
      • sort reset will reset the displayed list to its default order.

      Clearing all entries : clear

      Clears all entries from the address book.

      Format: clear

      Importing data from CSV file import

      Imports contacts based on CSV file. Importing a file will replace ALL existing contacts

      Format: import path/CSV_FILE_PATH

      • File path can be relative or absolute, but must end with .csv

      Examples:

      • import path/data/group12.csv will import the contacts found from the CSV (group12.csv from relative path given)

      CSV file formatting:

      • The CSV file must have header with the exact required order {"Name", "Email", "Telegram", "Tags", "Github", +"Assignments", "WeeksPresent"} (Case-insensitive)
      • The CSV file must contain information about at least 1 person
      • The data fields for Name, Email, Telegram, Github is compulsory
      • Tags format: enclose tag in square brackets ("[tag]"). If a person has multiple tags, separate the tags within the same entry with commas. (e.g."[tag1],[tag2],[tag3].....")
        • Duplicate tags will be ignored (e.g."[Group1],[Group1]" will be treated as "[Group1]")
        • This field can be empty (will be treated as no tags for specific person)
      • Assignment format: Assignment name and assignment score should be separated with "|" (e.g. Ex01|10). If multiple assignments are present for a person, separate them within the same entry using commas. (e.g. Ex01|9, Ex02|5) @@ -56,7 +56,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 asgn/ASSIGNMENT_NAME

      Examples:

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

      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

      AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

      Editing the data file

      AddressBook data are saved automatically as a JSON file [JAR file location]/data/addressbook.json. Advanced users are welcome to update data directly by editing that data file.

      If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
      -Furthermore, certain edits can cause the AddressBook 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 AddressBook 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.
    [Powered by MarkBind 5.5.3, generated on Tue, 5 Nov 2024, 22:53:59 GMT+8]
    +Furthermore, certain edits can cause the AddressBook 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 AddressBook 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.
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index 3e58d1c7eea..a7877c3a35e 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)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('hr'),_v(" "),_m(4),_v(" "),_m(5),_m(6),_v(" "),_m(7),_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 to be supplied by the user."),_c('br'),_v("\ne.g. in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/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 n/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("n/NAME [t/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe t/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Items with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("…")]),_v("​ after them can be used multiple times including zero times."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[t/TAG]…​")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}}),_v(" (i.e. 0 times), "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")]),_v(" etc.")])]),_v(" "),_c('li',[_c('p',[_v("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("n/NAME p/PHONE_NUMBER")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("p/PHONE_NUMBER n/NAME")]),_v(" is also acceptable.")])]),_v(" "),_c('li',[_c('p',[_v("Extraneous 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(" "),_c('hr'),_v(" "),_m(8),_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(" "),_c('hr'),_v(" "),_m(9),_v(" "),_c('p',[_v("Adds a person 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 n/NAME p/PHONE_NUMBER e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB")])])])])]),_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 with a space.")])])]),_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 p/98765432 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 p/1234567 telegram/@Betsy t/criminal github/betsy-29")]),_v(" adds Betsy Crowe's contact details with a friend and criminal tag.")])])]),_v(" "),_c('hr'),_v(" "),_m(10),_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(11),_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 [n/NAME] [p/PHONE] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/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 p/91234567 e/johndoe@example.com")]),_v(" Edits the phone number and email address of the 1st person to be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("91234567")]),_v(" and "),_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(" "),_c('hr'),_v(" "),_m(12),_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":"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 david")]),_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("David Li")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexDavidResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexDavidResult.png","alt":"result for 'find alex david'"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(13),_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 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-sensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_v(" will not 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('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/friend t/family")]),_v(" returns 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")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexDavidResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexDavidResult.png","alt":"result for 'filter t/friend t/family'"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(14),_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 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(" "),_c('hr'),_v(" "),_m(15),_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 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/Betsy")]),_v(" launches the GitHub repository of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(", using the GitHub username assigned to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(".")])])]),_v(" "),_c('hr'),_v(" "),_m(16),_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 [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 selected contact.")]),_v(" "),_c('li',[_v("The name 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('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/JohnDoe")]),_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("JohnDoe")]),_v(".")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/JohnDoe")]),_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("JohnDoe")]),_v(".")])])]),_v(" "),_c('hr'),_v(" "),_m(17),_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 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 name and week number is compulsory.")]),_v(" "),_c('li',[_v("The name is case-sensitive.")]),_v(" "),_c('li',[_v("The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 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/Viswa w/1")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Viswa")]),_v(" as present for week 1.\n"),_c('a',{attrs:{"href":"/tp/images/markPresent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markPresent.png","alt":"result for mark"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(18),_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":"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 name and week number is compulsory.")]),_v(" "),_c('li',[_v("The name is case-sensitive.")]),_v(" "),_c('li',[_v("The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 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("unmarks n/John Doe w/1")]),_v(" unmarks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(" as present for week 1.\n"),_c('a',{attrs:{"href":"/tp/images/unmarkStudent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/unmarkStudent.png","alt":"result for unmark"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(19),_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('p',[_c('span',[_c('strong',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort FIELD order/ORDER")])])])])]),_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("Current FIELD 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',[_v("Current ORDER 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 will persist between commands.")]),_v(" "),_c('li',[_v("The sorting is case-insensitive: 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/asc")]),_v(" will sort the displayed list based on their name in ascending order.")])])]),_v(" "),_c('hr'),_v(" "),_m(20),_v(" "),_c('p',[_v("Clears all entries 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("clear")])])])])]),_v(" "),_c('hr'),_v(" "),_m(21),_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":"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\", \"Phone\", \"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, Phone, Email, Telegram, Github is compulsory")]),_v(" "),_c('li',[_v("Tags format: enclose tag in square brackets (\"[tag]\"). If a person has multiple tags, separate the tags within the same entry\nwith 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(" "),_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('p',[_c('a',{attrs:{"href":"/tp/images/validCSV.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/validCSV.png","alt":"Valid CSV"}})]),_v(" "),_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(" "),_c('hr'),_v(" "),_m(22),_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":"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("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(" "),_c('hr'),_v(" "),_m(23),_v(" "),_m(24),_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(" "),_c('hr'),_v(" "),_m(25),_v(" "),_c('p',[_v("Add 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 n/NAME asgn/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('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"}},[_c('span',[_v("{\n")]),_c('span',[_v(" \"assignments\" : [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" \"name\": \"Ex01\",\n")]),_c('span',[_v(" \"maxScore\": 10\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" \"name\": \"Ex02\",\n")]),_c('span',[_v(" \"maxScore\": 10\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" \"name\": \"Ex03\",\n")]),_c('span',[_v(" \"maxScore\": 15\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(26),_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 asgn/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',[_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(27),_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(" "),_c('hr'),_v(" "),_m(28),_v(" "),_c('p',[_v("AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.")]),_v(" "),_c('hr'),_v(" "),_m(29),_v(" "),_m(30),_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',[_v("If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it."),_c('br'),_v("\nFurthermore, certain edits can cause the AddressBook 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(31),_v(" "),_m(32),_v(" "),_c('hr'),_v(" "),_m(33),_v(" "),_m(34),_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":"#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(35)])} +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)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_m(0),_v(" "),_m(1),_v(" "),_c('div',{pre:true,attrs:{"class":"page-nav-print d-none d-print-block"}}),_v(" "),_c('hr'),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('hr'),_v(" "),_m(4),_v(" "),_m(5),_m(6),_v(" "),_m(7),_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 to be supplied by the user."),_c('br'),_v("\ne.g. in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/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 n/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("n/NAME [t/TAG]")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe t/friend")]),_v(" or as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("n/John Doe")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Items with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("…")]),_v("​ after them can be used multiple times including zero times."),_c('br'),_v("\ne.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[t/TAG]…​")]),_v(" can be used as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}}),_v(" (i.e. 0 times), "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("t/friend t/family")]),_v(" etc.")])]),_v(" "),_c('li',[_c('p',[_v("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("n/NAME telegram/TELEGRAM")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("telegram/TELEGRAM n/NAME")]),_v(" is also acceptable.")])]),_v(" "),_c('li',[_c('p',[_v("Extraneous 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(" "),_c('hr'),_v(" "),_m(8),_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(" "),_c('hr'),_v(" "),_m(9),_v(" "),_c('p',[_v("Adds a person 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 n/NAME e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB")])])])])]),_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 with a space.")])])]),_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(" "),_c('hr'),_v(" "),_m(10),_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(11),_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 [n/NAME] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/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(" "),_c('hr'),_v(" "),_m(12),_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":"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 david")]),_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("David Li")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexDavidResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexDavidResult.png","alt":"result for 'find alex david'"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(13),_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 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-sensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("friends")]),_v(" will not 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('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/friend t/family")]),_v(" returns 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")]),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/findAlexDavidResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/findAlexDavidResult.png","alt":"result for 'filter t/friend t/family'"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(14),_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 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(" "),_c('hr'),_v(" "),_m(15),_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 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/Betsy")]),_v(" launches the GitHub repository of the person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(", using the GitHub username assigned to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy")]),_v(".")])])]),_v(" "),_c('hr'),_v(" "),_m(16),_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 [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 selected contact.")]),_v(" "),_c('li',[_v("The name 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('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/JohnDoe")]),_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("JohnDoe")]),_v(".")]),_v(" "),_c('li',[_v("Calling "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/JohnDoe")]),_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("JohnDoe")]),_v(".")])])]),_v(" "),_c('hr'),_v(" "),_m(17),_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 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 name and week number is compulsory.")]),_v(" "),_c('li',[_v("The name is case-sensitive.")]),_v(" "),_c('li',[_v("The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 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/Viswa w/1")]),_v(" marks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Viswa")]),_v(" as present for week 1.\n"),_c('a',{attrs:{"href":"/tp/images/markPresent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/markPresent.png","alt":"result for mark"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(18),_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":"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 name and week number is compulsory.")]),_v(" "),_c('li',[_v("The name is case-sensitive.")]),_v(" "),_c('li',[_v("The range of the WEEK NUMBER is between 0 and 13, both inclusive. Rationale being there are 13 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("unmarks n/John Doe w/1")]),_v(" unmarks the student named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(" as present for week 1.\n"),_c('a',{attrs:{"href":"/tp/images/unmarkStudent.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/unmarkStudent.png","alt":"result for unmark"}})])])])]),_v(" "),_c('hr'),_v(" "),_m(19),_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('p',[_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":"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("Current FIELD 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',[_v("Current ORDER 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 will persist 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 case-insensitive: 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/asc")]),_v(" will sort the displayed list based on their name in ascending order.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort reset")]),_v(" will reset the displayed list to its default order.")])])]),_v(" "),_c('hr'),_v(" "),_m(20),_v(" "),_c('p',[_v("Clears all entries 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("clear")])])])])]),_v(" "),_c('hr'),_v(" "),_m(21),_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":"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")]),_v(" "),_c('li',[_v("Tags format: enclose tag in square brackets (\"[tag]\"). If a person has multiple tags, separate the tags within the same entry\nwith 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(" "),_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('p',[_c('a',{attrs:{"href":"/tp/images/validCSV.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/validCSV.png","alt":"Valid CSV"}})]),_v(" "),_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(" "),_c('hr'),_v(" "),_m(22),_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":"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("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(" "),_c('hr'),_v(" "),_m(23),_v(" "),_m(24),_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(" "),_c('hr'),_v(" "),_m(25),_v(" "),_c('p',[_v("Add 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 n/NAME asgn/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('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"}},[_c('span',[_v("{\n")]),_c('span',[_v(" \"assignments\" : [\n")]),_c('span',[_v(" {\n")]),_c('span',[_v(" \"name\": \"Ex01\",\n")]),_c('span',[_v(" \"maxScore\": 10\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" \"name\": \"Ex02\",\n")]),_c('span',[_v(" \"maxScore\": 10\n")]),_c('span',[_v(" }, {\n")]),_c('span',[_v(" \"name\": \"Ex03\",\n")]),_c('span',[_v(" \"maxScore\": 15\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(26),_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 asgn/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',[_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(27),_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(" "),_c('hr'),_v(" "),_m(28),_v(" "),_c('p',[_v("AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.")]),_v(" "),_c('hr'),_v(" "),_m(29),_v(" "),_m(30),_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',[_v("If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it."),_c('br'),_v("\nFurthermore, certain edits can cause the AddressBook 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(31),_v(" "),_m(32),_v(" "),_c('hr'),_v(" "),_m(33),_v(" "),_m(34),_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":"#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(35)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -14,13 +14,13 @@ with(this){return _c('p',[_v("konTActs is a "),_c('strong',[_v("desktop app for with(this){return _c('h2',{attrs:{"id":"quick-start"}},[_v("Quick start"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#quick-start","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('ol',[_c('li',[_c('p',[_v("Ensure you have Java "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("17")]),_v(" or above installed in your Computer. Refer "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/website/admin/programmingLanguages.html"}},[_v("here")]),_v(" for the specific version.")])]),_v(" "),_c('li',[_c('p',[_v("Download the latest "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jar")]),_v(" file from "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-T11-2/tp/releases"}},[_v("here")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Copy the file to the folder you want to use as the "),_c('em',[_v("home folder")]),_v(" for your AddressBook.")])]),_v(" "),_c('li',[_c('p',[_v("Open a command terminal, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cd")]),_v(" into the folder you put the jar file in, and use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar addressbook.jar")]),_v(" command to run the application."),_c('br'),_v("\nA GUI similar to the below should appear in a few seconds. Note how the app contains some sample data."),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/Ui.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/Ui.png","alt":"Ui"}})])])]),_v(" "),_c('li',[_c('p',[_v("Type the command in the command box and press Enter to execute it. e.g. typing "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])]),_v(" and pressing Enter will open the help window."),_c('br'),_v("\nSome example commands you can try:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" : Lists all contacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/James Ho p/22224444 e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool")]),_v(" : Adds a contact named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James Ho")]),_v(" to the Address Book.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/James Ho")]),_v(" : Deletes the contact with name "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James Ho")]),_v(" if it is shown in the current list.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" : Deletes all contacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" : Exits the app.")])])])]),_v(" "),_c('li',[_c('p',[_v("Refer to the "),_c('a',{attrs:{"href":"#features"}},[_v("Features")]),_v(" below for details of each command.\n"),_c('br'),_c('br')])])])} +with(this){return _c('ol',[_c('li',[_c('p',[_v("Ensure you have Java "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("17")]),_v(" or above installed in your Computer. Refer "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2425s1.github.io/website/admin/programmingLanguages.html"}},[_v("here")]),_v(" for the specific version.")])]),_v(" "),_c('li',[_c('p',[_v("Download the latest "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jar")]),_v(" file from "),_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-T11-2/tp/releases"}},[_v("here")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Copy the file to the folder you want to use as the "),_c('em',[_v("home folder")]),_v(" for your AddressBook.")])]),_v(" "),_c('li',[_c('p',[_v("Open a command terminal, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cd")]),_v(" into the folder you put the jar file in, and use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar addressbook.jar")]),_v(" command to run the application."),_c('br'),_v("\nA GUI similar to the below should appear in a few seconds. Note how the app contains some sample data."),_c('br'),_v(" "),_c('a',{attrs:{"href":"/tp/images/Ui.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/Ui.png","alt":"Ui"}})])])]),_v(" "),_c('li',[_c('p',[_v("Type the command in the command box and press Enter to execute it. e.g. typing "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])]),_v(" and pressing Enter will open the help window."),_c('br'),_v("\nSome example commands you can try:")]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" : Lists all contacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/James Ho e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool")]),_v(" : Adds a contact named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James Ho")]),_v(" to the Address Book.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/James Ho")]),_v(" : Deletes the contact with name "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("James Ho")]),_v(" if it is shown in the current list.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" : Deletes all contacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exit")]),_v(" : Exits the app.")])])])]),_v(" "),_c('li',[_c('p',[_v("Refer to the "),_c('a',{attrs:{"href":"#features"}},[_v("Features")]),_v(" below for details of each command.\n"),_c('br'),_c('br')])])])} },function anonymous( ) { with(this){return _c('h2',{attrs:{"id":"summary-of-commands"}},[_v("Summary of commands"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#summary-of-commands","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { -with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Action")]),_v(" "),_c('th',[_v("Format, Examples")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('a',{attrs:{"href":"#adding-a-person-add"}},[_c('strong',[_v("Add")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/NAME p/PHONE_NUMBER e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/James Ho p/22224444 e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#clearing-all-entries-clear"}},[_c('strong',[_v("Clear")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#deleting-a-person-delete"}},[_c('strong',[_v("Delete")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/NAME")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/James")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#editing-a-person-edit"}},[_c('strong',[_v("Edit")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]")]),_c('br'),_v(" e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 n/James Lee e/jameslee@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#finding-persons-by-name-find"}},[_c('strong',[_v("Find")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find KEYWORD [MORE_KEYWORDS]")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#filtering-persons-by-tag-filter"}},[_c('strong',[_v("Filter")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/[TAG] t/[MORE_TAG]…​")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/friends t/family")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#listing-all-persons-list"}},[_c('strong',[_v("List")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#viewing-help-help"}},[_c('strong',[_v("Help")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#viewing-a-contact-s-full-details-view"}},[_c('strong',[_v("View")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view [n/NAME]")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/JohnDoe")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#launching-github-repository-github"}},[_c('strong',[_v("Github")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/NAME")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#marking-a-student-as-present-mark"}},[_c('strong',[_v("Mark")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/NAME w/WEEK NUMBER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/John Doe w/1")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#unmarking-a-student-as-present-unmark"}},[_c('strong',[_v("Unmark")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/NAME w/WEEK NUMBER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/John Doe w/1")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#sorting-the-displayed-list-sort"}},[_c('strong',[_v("Sort")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort FIELD order/ORDER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort name order/asc")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#importing-data-from-csv-file-import"}},[_c('strong',[_v("Import")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/CSV FILE PATH")]),_v(" "),_c('br'),_v(" e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/user/data/xxx.csv")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#exporting-data-into-csv-file-export"}},[_c('strong',[_v("Export")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/DESIRED FILE DESTINATION")]),_v(" "),_c('br'),_v(" e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/user/data/xxx.csv")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#accessing-command-history-and"}},[_c('strong',[_v("Command History")])])]),_v(" "),_c('td',[_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#adding-grades-to-a-contact-addgrade"}},[_c('strong',[_v("Add grade")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/NAME asgn/ASSIGNMENT_NAME s/SCORE")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/5")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#removing-grades-from-a-contact-removegrade"}},[_c('strong',[_v("Remove grade")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/NAME asgn/ASSIGNMENT_NAME")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")])])])])])])} +with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Action")]),_v(" "),_c('th',[_v("Format, Examples")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('a',{attrs:{"href":"#adding-a-person-add"}},[_c('strong',[_v("Add")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/NAME e/EMAIL telegram/TELEGRAM [t/TAG]…​ github/GITHUB")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add n/James Ho e/jamesho@example.com telegram/@James t/friend t/colleague github/james-cool")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#clearing-all-entries-clear"}},[_c('strong',[_v("Clear")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#deleting-a-person-delete"}},[_c('strong',[_v("Delete")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/NAME")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete n/James")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#editing-a-person-edit"}},[_c('strong',[_v("Edit")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit INDEX [n/NAME] [e/EMAIL] [telegram/TELEGRAM] [t/TAG]…​ [github/GITHUB]")]),_c('br'),_v(" e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 2 n/James Lee e/jameslee@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#finding-persons-by-name-find"}},[_c('strong',[_v("Find")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find KEYWORD [MORE_KEYWORDS]")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#filtering-persons-by-tag-filter"}},[_c('strong',[_v("Filter")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/[TAG] t/[MORE_TAG]…​")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter t/friends t/family")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#listing-all-persons-list"}},[_c('strong',[_v("List")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#viewing-help-help"}},[_c('strong',[_v("Help")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("help")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#viewing-a-contact-s-full-details-view"}},[_c('strong',[_v("View")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view [n/NAME]")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("view n/JohnDoe")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#launching-github-repository-github"}},[_c('strong',[_v("Github")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/NAME")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("github n/Harry")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#marking-a-student-as-present-mark"}},[_c('strong',[_v("Mark")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/NAME w/WEEK NUMBER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mark n/John Doe w/1")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#unmarking-a-student-as-present-unmark"}},[_c('strong',[_v("Unmark")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/NAME w/WEEK NUMBER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("unmark n/John Doe w/1")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#sorting-the-displayed-list-sort"}},[_c('strong',[_v("Sort")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort FIELD order/ORDER")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("sort name order/asc")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#importing-data-from-csv-file-import"}},[_c('strong',[_v("Import")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/CSV FILE PATH")]),_v(" "),_c('br'),_v(" e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("import path/user/data/xxx.csv")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#exporting-data-into-csv-file-export"}},[_c('strong',[_v("Export")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/DESIRED FILE DESTINATION")]),_v(" "),_c('br'),_v(" e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("export path/user/data/xxx.csv")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#accessing-command-history-and"}},[_c('strong',[_v("Command History")])])]),_v(" "),_c('td',[_c('kbd',[_v("↑")]),_v(" and "),_c('kbd',[_v("↓")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#adding-grades-to-a-contact-addgrade"}},[_c('strong',[_v("Add grade")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/NAME asgn/ASSIGNMENT_NAME s/SCORE")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("addGrade n/JohnDoe asgn/Ex01 s/5")])])]),_v(" "),_c('tr',[_c('td',[_c('a',{attrs:{"href":"#removing-grades-from-a-contact-removegrade"}},[_c('strong',[_v("Remove grade")])])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/NAME asgn/ASSIGNMENT_NAME")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("removeGrade n/John Doe asgn/Ex01")])])])])])])} },function anonymous( ) { with(this){return _c('p',[_c('br'),_c('br')])} @@ -110,6 +110,6 @@ with(this){return _c('h2',{attrs:{"id":"known-issues"}},[_v("Known issues"),_c(' 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.")])])} },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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/diagrams/BetterModelClassDiagram.png b/diagrams/BetterModelClassDiagram.png index 7dfcec0af9a..8b604c7fe7d 100644 Binary files a/diagrams/BetterModelClassDiagram.png and b/diagrams/BetterModelClassDiagram.png differ diff --git a/diagrams/BetterModelClassDiagram.puml b/diagrams/BetterModelClassDiagram.puml index bf2bbb2720a..3fad6d74120 100644 --- a/diagrams/BetterModelClassDiagram.puml +++ b/diagrams/BetterModelClassDiagram.puml @@ -15,9 +15,7 @@ UniquePersonList -right-> Person Person -up-> "*" Tag Person *--> Name -Person *--> Phone Person *--> Email -Person *--> Address Person *--> Github Person *--> Telegram Person *--> "*" Assignment diff --git a/diagrams/ModelClassDiagram.png b/diagrams/ModelClassDiagram.png index 0595df57780..24b89d935ad 100644 Binary files a/diagrams/ModelClassDiagram.png and b/diagrams/ModelClassDiagram.png differ diff --git a/diagrams/ModelClassDiagram.puml b/diagrams/ModelClassDiagram.puml index e74927d8982..318af4f5798 100644 --- a/diagrams/ModelClassDiagram.puml +++ b/diagrams/ModelClassDiagram.puml @@ -17,10 +17,8 @@ Class ReadOnlyPredefinedAssignmentsData Class UniquePersonList Class Person -Class Address Class Email Class Name -Class Phone Class Tag Class Telegram Class Github @@ -47,9 +45,7 @@ PredefinedAssignmentData .up.|> ReadOnlyPredefinedAssignmentsData AddressBook *--> "1" UniquePersonList UniquePersonList --> "~* all" Person Person *--> Name -Person *--> Phone Person *--> Email -Person *--> Address Person *--> "*" Tag Person *--> Telegram Person *--> Github @@ -58,9 +54,6 @@ Person *--> "*" Assignment Person -[hidden]up--> I UniquePersonList -[hidden]right-> I -Name -[hidden]right-> Phone -Phone -[hidden]right-> Address -Address -[hidden]right-> Email ModelManager --> "~* filtered" Person @enduml diff --git a/index.html b/index.html index b3239c6ff41..14d0ed43732 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@ Search

    KonTActs

    Java CI codecov

    Ui

    KonTActs is a desktop application for managing 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.

    +
  • About Us

    • KonTActs

    Java CI codecov

    Ui

    KonTActs is a desktop application for managing 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 af2d377dd6d..845863674d4 100644 --- a/index.page-vue-render.js +++ b/index.page-vue-render.js @@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":"" with(this){return _c('div',{attrs:{"id":"content-wrapper"}},[_c('h1',{attrs:{"id":"kontacts"}},[_v("KonTActs"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#kontacts","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-T11-2/tp/actions/workflows/gradle.yml"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://github.com/AY2425S1-CS2103T-T11-2/tp/actions/workflows/gradle.yml/badge.svg","alt":"Java CI"}})]),_v(" "),_c('a',{attrs:{"href":"https://codecov.io/github/AY2425S1-CS2103T-T11-2/tp"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://codecov.io/gh/AY2425S1-CS2103T-T11-2/tp/graph/badge.svg","alt":"codecov"}})])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/Ui.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/Ui.png","alt":"Ui"}})])]),_v(" "),_c('p',[_c('strong',[_v("KonTActs is a desktop application for managing your students', fellow TAs', and professors' contact details.")]),_v(" While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).")]),_v(" "),_c('ul',[_c('li',[_v("If you are interested in using KonTActs, head over to the "),_c('a',{attrs:{"href":"/tp/UserGuide.html#quick-start"}},[_c('em',[_v("Quick Start")]),_v(" section of the "),_c('strong',[_v("User Guide")])]),_v(".")]),_v(" "),_c('li',[_v("If you are interested about developing KonTActs, the "),_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_c('strong',[_v("Developer Guide")])]),_v(" is a good place to start.")])]),_v(" "),_c('p',[_c('strong',[_v("Acknowledgements")])]),_v(" "),_c('p',[_v("This project is based on the AddressBook-Level3 project created by the "),_c('a',{attrs:{"href":"https://se-education.org"}},[_v("SE-EDU initiative")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Libraries used: "),_c('a',{attrs:{"href":"https://openjfx.io/"}},[_v("JavaFX")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/FasterXML/jackson"}},[_v("Jackson")]),_v(", "),_c('a',{attrs:{"href":"https://github.com/junit-team/junit5"}},[_v("JUnit5")])])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/currynia.html b/team/currynia.html index 9e10897f8c8..523a51402ec 100644 --- a/team/currynia.html +++ b/team/currynia.html @@ -18,7 +18,7 @@
  • About Us

    • 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 4e5205a2de4..bf937993965 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/dessnowy.html b/team/dessnowy.html index 43065479d15..0909d98924c 100644 --- a/team/dessnowy.html +++ b/team/dessnowy.html @@ -18,7 +18,7 @@
  • About Us

    • 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 4e5205a2de4..bf937993965 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/incogdino.html b/team/incogdino.html index 19594921061..ccbb5f68996 100644 --- a/team/incogdino.html +++ b/team/incogdino.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.

    +
  • About Us

    • 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 7b5f51c0afa..2af0ee2a138 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/swaminathanviswa.html b/team/swaminathanviswa.html index 6d7260214b7..ac7f708320c 100644 --- a/team/swaminathanviswa.html +++ b/team/swaminathanviswa.html @@ -18,7 +18,7 @@
  • About Us

    • 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 4e5205a2de4..bf937993965 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/tohjh.html b/team/tohjh.html index 4d03f211204..0ce33433557 100644 --- a/team/tohjh.html +++ b/team/tohjh.html @@ -18,7 +18,7 @@
  • About Us

    • 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 4e5205a2de4..bf937993965 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 Tue, 5 Nov 2024, 22:53:59 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 Wed, 6 Nov 2024, 1:19:35 GMT+8]")])])])} }]; \ No newline at end of file