From 2ab7256af20c5e83b9ad01a54339ce8188a38cfc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 10 Nov 2024 05:58:11 +0000 Subject: [PATCH] deploy: 7d0ae523ffdf6c6db49e5e037ceca363a76da86b --- AboutUs.html | 2 +- AboutUs.page-vue-render.js | 2 +- Configuration.html | 2 +- Configuration.page-vue-render.js | 2 +- DevOps.html | 2 +- DevOps.page-vue-render.js | 2 +- DeveloperGuide.html | 2 +- DeveloperGuide.page-vue-render.js | 2 +- Documentation.html | 2 +- Documentation.page-vue-render.js | 2 +- Logging.html | 2 +- Logging.page-vue-render.js | 2 +- SettingUp.html | 2 +- SettingUp.page-vue-render.js | 2 +- Testing.html | 2 +- Testing.page-vue-render.js | 2 +- UserGuide.html | 7 ++++--- UserGuide.page-vue-render.js | 14 ++++---------- index.html | 2 +- index.page-vue-render.js | 2 +- siteData.json | 1 - team/btbrandon.html | 2 +- team/btbrandon.page-vue-render.js | 2 +- team/ethan-g.html | 2 +- team/ethan-g.page-vue-render.js | 2 +- team/jessica2828.html | 2 +- team/jessica2828.page-vue-render.js | 2 +- team/juliantayyc.html | 2 +- team/juliantayyc.page-vue-render.js | 2 +- team/jyl27.html | 2 +- team/jyl27.page-vue-render.js | 2 +- 31 files changed, 36 insertions(+), 42 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index cc9eafbc9e4..7b5bcca2dd0 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -16,7 +16,7 @@ Search

About Us

We are a team based in the School of Computing, National University of Singapore.

Project team

Julian Tay

[Github]

Ethan Goh

[Github]

Brandon Tan

[Github]

Jessica

[Github]

Jun Yu

[Github]

+
  • About Us

    We are a team based in the School of Computing, National University of Singapore.

    Project team

    Julian Tay

    [Github]

    Ethan Goh

    [Github]

    Brandon Tan

    [Github]

    Jessica

    [Github]

    Jun Yu

    [Github]

    diff --git a/AboutUs.page-vue-render.js b/AboutUs.page-vue-render.js index 525ae359805..d7d0d0c3222 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('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":"julian-tay"}},[_v("Julian Tay"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#julian-tay","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/juliantayyc.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"https://github.com/juliantayyc"}},[_v("Github")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Team Lead")])]),_v(" "),_c('h3',{attrs:{"id":"ethan-goh"}},[_v("Ethan Goh"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ethan-goh","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/ethan-goh.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/ethan-goh"}},[_v("Github")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Code Quality")]),_v(" "),_c('li',[_v("Responsibilities: Ensure code follows the code quality requirements as outlined by the course.")])]),_v(" "),_c('h3',{attrs:{"id":"brandon-tan"}},[_v("Brandon Tan"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#brandon-tan","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/btbrandon.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/btbrandon"}},[_v("Github")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Deliverables and Deadlines")]),_v(" "),_c('li',[_v("Responsibilities: Ensure team deliverables meet the deadlines as outlined by the course.")])]),_v(" "),_c('h3',{attrs:{"id":"jessica"}},[_v("Jessica"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jessica","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/jessica2828.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/jessica2828"}},[_v("Github")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Scheduling and Tracking")]),_v(" "),_c('li',[_v("Responsibilities: Assigning and managing tasks")])]),_v(" "),_c('h3',{attrs:{"id":"jun-yu"}},[_v("Jun Yu"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jun-yu","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/tp/images/jyl27.png","width":"200px"}}),_v(" "),_c('p',[_v("["),_c('a',{attrs:{"href":"http://github.com/jyl27"}},[_v("Github")]),_v("]")]),_v(" "),_c('ul',[_c('li',[_v("Role: Developer")]),_v(" "),_c('li',[_v("Responsibilities: UI")])])])} },function anonymous( ) { -with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.5.3")]),_v(", generated on Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Configuration.html b/Configuration.html index 3c5ed10f0b9..76bb1c97989 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).

    +
  • 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 9ad09fad9ba..6729fe3ff8c 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DevOps.html b/DevOps.html index c30ba8a72cb..ada3a95f31e 100644 --- a/DevOps.html +++ b/DevOps.html @@ -18,7 +18,7 @@
  • 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 f6512231197..a460cbc880f 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/DeveloperGuide.html b/DeveloperGuide.html index 1ae49921ca5..07c98160ba1 100644 --- a/DeveloperGuide.html +++ b/DeveloperGuide.html @@ -46,7 +46,7 @@

    Appendix: Instructions Expected: EduContacts has a blank list of persons. A new address.json file will be created in the data folder after closing the app or executing a command.


    Appendix: Effort

    {to work on in the future}


    Appendix: Planned Enhancements

    Data archiving

    Importing contact data

    Exporting contact data

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/DeveloperGuide.page-vue-render.js b/DeveloperGuide.page-vue-render.js index 2f51f57d184..aeb7d21a3e7 100644 --- a/DeveloperGuide.page-vue-render.js +++ b/DeveloperGuide.page-vue-render.js @@ -479,6 +479,6 @@ with(this){return _c('h3',{attrs:{"id":"exporting-contact-data"}},[_v("Exporting with(this){return _c('ul',[_c('li',[_v("Description: Allow users to export contact data to multiple formats (e.g. CSV, vCard)")]),_v(" "),_c('li',[_v("Benefits:\n"),_c('ul',[_c('li',[_v("Allow users to easily transfer their contact information to other applications or storage solutions.")]),_v(" "),_c('li',[_v("Provide users with the ability to create backups of their contact data.")]),_v(" "),_c('li',[_v("Enable users to share their contact lists with others.")]),_v(" "),_c('li',[_v("Allow users to organize and manipulate their contact data externally.")]),_v(" "),_c('li',[_v("Help users comply with data export regulations or organizational policies.")])])])])} },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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Documentation.html b/Documentation.html index 8a1b063838f..f2ec54a4558 100644 --- a/Documentation.html +++ b/Documentation.html @@ -16,7 +16,7 @@ Search

    Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
  • Documentation Guide

    Style guidance:

    Converting to PDF

    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/Documentation.page-vue-render.js b/Documentation.page-vue-render.js index 9a2b77a3413..56a73ae0cdc 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Logging.html b/Logging.html index c9925dbefc3..5a7d93504af 100644 --- a/Logging.html +++ b/Logging.html @@ -16,7 +16,7 @@ Search

    Logging guide

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

    • We are using java.util.logging package for logging.
    • The LogsCenter class is used to manage the logging levels and logging destinations.
    • The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level.
    • Log messages are output through the console and to a .log file.
    • The output logging level can be controlled using the logLevel setting in the configuration file (See the Configuration guide section).
    • When choosing a level for a log message, follow the conventions given in [se-edu/guides] Java: Logging conventions.
    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/Logging.page-vue-render.js b/Logging.page-vue-render.js index d0bec669817..da9d786748e 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/SettingUp.html b/SettingUp.html index ce2334ac4fd..7ca99e16667 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 EduContacts’ architecture.

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

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +These tutorials will help you get acquainted with the codebase.

    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/SettingUp.page-vue-render.js b/SettingUp.page-vue-render.js index a239b245653..9d4cd73345d 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/Testing.html b/Testing.html index 32d321aacbe..4edd6c7c191 100644 --- a/Testing.html +++ b/Testing.html @@ -20,7 +20,7 @@ test class, or a test and choose Run 'ABC'
  • Method 2: Using Gradle
    • Open a console and run the command gradlew clean test (Mac/Linux: ./gradlew clean test)
  • Link: Read this Gradle Tutorial from the se-edu/guides to learn more about using Gradle.


    Types of tests

    This project has three types of tests:

    1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest
    2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest
    3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      -e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +e.g. seedu.address.logic.LogicManagerTest
    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/Testing.page-vue-render.js b/Testing.page-vue-render.js index f9e6609e608..4f6fc22933d 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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/UserGuide.html b/UserGuide.html index 986395928d4..4841a8e241c 100644 --- a/UserGuide.html +++ b/UserGuide.html @@ -26,14 +26,15 @@

    Deletes a person contact with student ID 12345678.

    clear
     

    Deletes all contacts.

    exit
     

    Exits the EduContacts application.

    Tip: Use the UP and DOWN arrow keys to scroll through previous commands in the Command Box. This feature helps you reuse recent commands without retyping, making it faster for you to correct or repeat commands!

    1. Refer to the Features below for details of each command.

    Features

    Notes about the command format:

    • All command words should be in lowercase.

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

    • Parameters can be in any order.
      +e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.

    • Parameters enclosed in square brackets indicate that they are optional.
      +e.g. in filter n/NAME [m/MODULE], MODULE is a parameter which can be included or omitted as needed.

    • 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

    Shows a message explaining how to access the help page.

    Format:

    help
     

    The help window will display the help message as shown in the screenshot below: help message Alternatively, you can click the button on the top right hand corner as indicated here: alternative_help


    Adding a person: add

    Adds a person contact to EduContacts.

    Format:

    add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE
    -

    Examples:


    Listing all persons : list

    Shows a list of all persons in EduContacts.

    Format:

    list
    +

    Examples:


    Listing all persons : list

    Shows a list of all persons in EduContacts.

    Format:

    list
     

    The response message of this command is shown in the screenshot below: result for 'list command result'


    Adding a module to a person: module

    Adds a module to a specified person in EduContacts.

    Format:

    module ID m/MODULE
     

    Examples:


    Editing a person : edit

    Edits a specified person in EduContacts.

    Format:

    edit ID [FIELD_TO_EDIT_PREFIX] [NEW_VALUE]
    @@ -48,7 +49,7 @@
     The clear command will erase all contacts from the system. Please ensure that you have backed up any important information before proceeding. This action cannot be undone, so use this command with caution.


    Exiting the program : exit

    Exits the EduContacts application.

    Format:

    exit
     

    Saving the data

    EduContacts 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

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

    Warning: If your changes to the data file makes its format invalid, EduContacts 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 EduContacts 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.


    Archiving data files [coming in v2.0]

    Details coming soon ...


    FAQ

    Q: I am unfamiliar with command-line interfaces. How should I begin using EduContacts?
    A: We recommend starting with the Quick Start section of the user guide, which provides essential steps for setup and installation. Once you have the application running, utilize the help command or Help button to view a comprehensive list of available commands and their functions. Additionally, the Features section offers detailed instructions and examples for each command. We recommend familiarizing yourself with these resources as it will enhance your experience with EduContacts.

    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 EduContacts home folder.

    Q: Is there a way to recover accidentally deleted contacts?
    A: Unfortunately, once deleted, a contact cannot be recovered unless you have a backup of the JSON file from before deletion. Regular backups are recommended for this reason.

    Q: Can I export my contacts to Excel or another format?
    A: EduContacts data is stored in JSON format. You can convert JSON files to Excel or CSV using an external tool or script to make data compatible with spreadsheet applications.


    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.

    Command summary

    Action Format, Examples
    Add add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE
    e.g., add 12345678 n/John Doe p/99999999 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student
    Clear clear
    Delete delete ID
    e.g., delete 12345678

    delete ID m/MODULE
    e.g., delete 12345678 m/CS2103T
    Edit edit ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/COURSE] [r/ROLE]…​
    e.g.,edit 12345678 p/91234567 e/johndoe@example.com
    Grade grade ID m/MODULE g/GRADE
    e.g. grade 12345678 m/CS2103T g/A
    Add Module module ID [m/MODULE]
    e.g., add 12345678 m/CS2103T
    Filter filter [n/NAME] [c/COURSE] [m/MODULE]
    e.g., filter n/James Jake
    Find find ID
    e.g., find 12345678
    List list
    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +Furthermore, certain edits can cause the EduContacts 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: I am unfamiliar with command-line interfaces. How should I begin using EduContacts?
    A: We recommend starting with the Quick Start section of the user guide, which provides essential steps for setup and installation. Once you have the application running, utilize the help command or Help button to view a comprehensive list of available commands and their functions. Additionally, the Features section offers detailed instructions and examples for each command. We recommend familiarizing yourself with these resources as it will enhance your experience with EduContacts.

    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 EduContacts home folder.

    Q: Is there a way to recover accidentally deleted contacts?
    A: Unfortunately, once deleted, a contact cannot be recovered unless you have a backup of the JSON file from before deletion. Regular backups are recommended for this reason.

    Q: Can I export my contacts to Excel or another format?
    A: EduContacts data is stored in JSON format. You can convert JSON files to Excel or CSV using an external tool or script to make data compatible with spreadsheet applications.


    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.

    Command summary

    Action Format, Examples
    Add add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE
    e.g., add 12345678 n/John Doe p/99999999 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student
    Clear clear
    Delete delete ID
    e.g., delete 12345678

    delete ID m/MODULE
    e.g., delete 12345678 m/CS2103T
    Edit edit ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/COURSE] [r/ROLE]…​
    e.g.,edit 12345678 p/91234567 e/johndoe@example.com
    Grade grade ID m/MODULE g/GRADE
    e.g. grade 12345678 m/CS2103T g/A
    Add Module module ID m/MODULE
    e.g., add 12345678 m/CS2103T
    Filter filter [n/NAME] [c/COURSE] [m/MODULE]
    e.g., filter n/James Jake
    Find find ID
    e.g., find 12345678
    List list
    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/UserGuide.page-vue-render.js b/UserGuide.page-vue-render.js index fbcf5b157fd..0eb033a4cc2 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("EduContacts")])]},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#guidance-icons-legend"}},[_v("Guidance Icons Legend")])])]),_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#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_c('br'),_v(" "),_m(1),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Helpful suggestions to improve your experience or maximize efficiency.")])]),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Important information or details to keep in mind for correct usage.")])]),_c('p'),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" Critical cautions to prevent errors, potential issues, or data loss.")])]),_c('p'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" After downloading, you can confirm installation by typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -version")]),_v(" in your command terminal.")])]),_v(" "),_m(7),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the UP and DOWN arrow keys to scroll through previous commands in the Command Box. This feature helps you reuse recent commands without retyping, making it faster for you to correct or repeat commands!")])]),_v(" "),_m(8),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(9),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Notes about the command format:")]),_c('br')]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("All command words should be in lowercase.")])]),_v(" "),_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("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(" "),_m(10),_v(" "),_c('p',[_v("Shows a message explaining how to access the help page.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(11),_m(12),_v(" "),_c('br'),_v(" "),_m(13),_v(" "),_c('p',[_v("Adds a person contact to EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(14),_c('p',[_v("Examples:")]),_v(" "),_m(15),_v(" "),_c('br'),_v(" "),_m(16),_v(" "),_c('p',[_v("Shows a list of all persons in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(17),_m(18),_v(" "),_c('br'),_v(" "),_m(19),_v(" "),_c('p',[_v("Adds a module to a specified person in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(20),_c('p',[_v("Examples:")]),_v(" "),_m(21),_v(" "),_c('br'),_v(" "),_m(22),_v(" "),_c('p',[_v("Edits a specified person in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(23),_m(24),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_c('p',[_v("Adds a grade to a person's module.")]),_v(" "),_m(27),_m(28),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(29),_v(" "),_c('br'),_v(" "),_m(30),_v(" "),_c('p',[_v("Filters person contacts based on their names, courses and modules.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(31),_m(32),_v(" "),_m(33),_v(" "),_m(34),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cs1231s")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CS1231S")]),_v(".")])]),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(35),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" After using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter")]),_v(", only the persons displayed in the filtered list can be edited or deleted, and persons not shown in this truncated list cannot be modified.")]),_v(" "),_c('p',[_v("To return to display the full list of persons, use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" command.")])]),_v(" "),_m(36),_v(" "),_c('p',[_v("Deletes the specified person/module from EduContacts. This command has 2 formats.")]),_v(" "),_c('p',[_v("Format 1:")]),_v(" "),_m(37),_m(38),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(39),_v(" "),_c('p',[_v("Format 2:")]),_v(" "),_m(40),_m(41),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(42),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(43),_v(" "),_c('p',[_v("Finds the specified person from EduContacts and displays their details.")]),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(46),_v(" "),_c('br'),_v(" "),_m(47),_v(" "),_c('p',[_v("Clears all entries from EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(48),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nThe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command will erase all contacts from the system. Please ensure that you have backed up any important information before proceeding. This action cannot be undone, so use this command with caution.")])]),_v(" "),_c('br'),_v(" "),_m(49),_v(" "),_c('p',[_v("Exits the EduContacts application.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(50),_c('br'),_v(" "),_m(51),_v(" "),_c('p',[_v("EduContacts data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.")]),_v(" "),_c('br'),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nIf your changes to the data file makes its format invalid, EduContacts 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 EduContacts 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('br'),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_c('hr'),_v(" "),_m(61),_v(" "),_m(62),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(63),_v(" "),_m(64)],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":"#educontacts-user-guide"}},[_v("EduContacts 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":"#guidance-icons-legend"}},[_v("Guidance Icons Legend‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#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":"#adding-a-module-to-a-person-module"}},[_v("Adding a module to a person: module‎")]),_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":"#adding-a-grade-grade"}},[_v("Adding a grade : grade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#listing-person-by-certain-attributes-filter"}},[_v("Listing person by certain attributes : filter‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person-module-delete"}},[_v("Deleting a person/module : delete‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person-find"}},[_v("Finding a person : find‎")]),_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":"#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":"#archiving-data-files-coming-in-v2-0"}},[_v("Archiving data files [coming in v2.0]‎")])]),_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‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-summary"}},[_v("Command summary‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(65)])} +with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"sticky":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/tp/index.html","title":"Home"}},[_v("EduContacts")])]},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#guidance-icons-legend"}},[_v("Guidance Icons Legend")])])]),_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#quick-start"}},[_v("Quick Start")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#features"}},[_v("Features")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/UserGuide.html#faq"}},[_v("Command Summary")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html"}},[_v("Developer Guide")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#acknowledgements"}},[_v("Acknowledgements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#setting-up-getting-started"}},[_v("Setting Up")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#design"}},[_v("Design")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#implementation"}},[_v("Implementation")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops"}},[_v("Documentation, logging, testing, configuration, dev-ops")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-requirements"}},[_v("Appendix: Requirements")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/DeveloperGuide.html#appendix-instructions-for-manual-testing"}},[_v("Appendix: Instructions for manual testing")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_v("Tutorials\n\n"),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/TracingCode.html"}},[_v("Tracing code")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/AddRemark.html"}},[_v("Adding a command")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/tutorials/RemovingFields.html"}},[_v("Removing Fields")])])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/tp/AboutUs.html"}},[_v("About Us")])])])])],1)],1)]),_v(" "),_c('div',{attrs:{"id":"content-wrapper"}},[_c('br'),_v(" "),_m(0),_v(" "),_c('br'),_v(" "),_m(1),_v(" "),_c('br'),_v(" "),_m(2),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Helpful suggestions to improve your experience or maximize efficiency.")])]),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" Important information or details to keep in mind for correct usage.")])]),_c('p'),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v(" Critical cautions to prevent errors, potential issues, or data loss.")])]),_c('p'),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" After downloading, you can confirm installation by typing "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -version")]),_v(" in your command terminal.")])]),_v(" "),_m(7),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" Use the UP and DOWN arrow keys to scroll through previous commands in the Command Box. This feature helps you reuse recent commands without retyping, making it faster for you to correct or repeat commands!")])]),_v(" "),_m(8),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(9),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Notes about the command format:")]),_c('br')]),_v(" "),_c('ul',[_c('li',[_c('p',[_v("All command words should be in lowercase.")])]),_v(" "),_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("Parameters enclosed in square brackets indicate that they are optional. "),_c('br'),_v("\ne.g. in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter n/NAME [m/MODULE]")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MODULE")]),_v(" is a parameter which can be included or omitted as needed.")])]),_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(" "),_m(10),_v(" "),_c('p',[_v("Shows a message explaining how to access the help page.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(11),_m(12),_v(" "),_c('br'),_v(" "),_m(13),_v(" "),_c('p',[_v("Adds a person contact to EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(14),_c('p',[_v("Examples:")]),_v(" "),_m(15),_v(" "),_c('br'),_v(" "),_m(16),_v(" "),_c('p',[_v("Shows a list of all persons in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(17),_m(18),_v(" "),_c('br'),_v(" "),_m(19),_v(" "),_c('p',[_v("Adds a module to a specified person in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(20),_c('p',[_v("Examples:")]),_v(" "),_m(21),_v(" "),_c('br'),_v(" "),_m(22),_v(" "),_c('p',[_v("Edits a specified person in EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(23),_m(24),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(25),_v(" "),_c('br'),_v(" "),_m(26),_v(" "),_c('p',[_v("Adds a grade to a person's module.")]),_v(" "),_m(27),_m(28),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(29),_v(" "),_c('br'),_v(" "),_m(30),_v(" "),_c('p',[_v("Filters person contacts based on their names, courses and modules.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(31),_m(32),_v(" "),_m(33),_v(" "),_m(34),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Tip:")]),_v(" The search is case-insensitive. e.g "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cs1231s")]),_v(" will match "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CS1231S")]),_v(".")])]),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(35),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("Note:")]),_v(" After using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter")]),_v(", only the persons displayed in the filtered list can be edited or deleted, and persons not shown in this truncated list cannot be modified.")]),_v(" "),_c('p',[_v("To return to display the full list of persons, use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_v(" command.")])]),_v(" "),_m(36),_v(" "),_c('p',[_v("Deletes the specified person/module from EduContacts. This command has 2 formats.")]),_v(" "),_c('p',[_v("Format 1:")]),_v(" "),_m(37),_m(38),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(39),_v(" "),_c('p',[_v("Format 2:")]),_v(" "),_m(40),_m(41),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(42),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(43),_v(" "),_c('p',[_v("Finds the specified person from EduContacts and displays their details.")]),_v(" "),_m(44),_v(" "),_m(45),_v(" "),_c('p',[_v("Examples:")]),_v(" "),_m(46),_v(" "),_c('br'),_v(" "),_m(47),_v(" "),_c('p',[_v("Clears all entries from EduContacts.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(48),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nThe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("clear")]),_v(" command will erase all contacts from the system. Please ensure that you have backed up any important information before proceeding. This action cannot be undone, so use this command with caution.")])]),_v(" "),_c('br'),_v(" "),_m(49),_v(" "),_c('p',[_v("Exits the EduContacts application.")]),_v(" "),_c('p',[_v("Format:")]),_v(" "),_m(50),_c('br'),_v(" "),_m(51),_v(" "),_c('p',[_v("EduContacts data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.")]),_v(" "),_c('br'),_v(" "),_m(52),_v(" "),_m(53),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_c('strong',[_v("Warning:")]),_v("\nIf your changes to the data file makes its format invalid, EduContacts 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 EduContacts 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(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(54),_v(" "),_m(55),_v(" "),_m(56),_v(" "),_m(57),_v(" "),_m(58),_v(" "),_c('hr'),_v(" "),_m(59),_v(" "),_m(60),_v(" "),_c('hr'),_v(" "),_c('div',{staticStyle:{"page-break-after":"always"}}),_v(" "),_m(61),_v(" "),_m(62)],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":"#educontacts-user-guide"}},[_v("EduContacts 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":"#guidance-icons-legend"}},[_v("Guidance Icons Legend‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#quick-start"}},[_v("Quick start‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#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":"#adding-a-module-to-a-person-module"}},[_v("Adding a module to a person: module‎")]),_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":"#adding-a-grade-grade"}},[_v("Adding a grade : grade‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#listing-person-by-certain-attributes-filter"}},[_v("Listing person by certain attributes : filter‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#deleting-a-person-module-delete"}},[_v("Deleting a person/module : delete‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#finding-a-person-find"}},[_v("Finding a person : find‎")]),_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":"#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‎")]),_v(" "),_c('a',{pre:true,attrs:{"class":"nav-link py-1","href":"#command-summary"}},[_v("Command summary‎")])])])],1)]),_v(" "),_c('scroll-top-button')],1),_v(" "),_m(63)])} }; var pageVueStaticRenderFns = [function anonymous( ) { @@ -50,7 +50,7 @@ with(this){return _c('h3',{attrs:{"id":"adding-a-person-add"}},[_v("Adding a per with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"hljs bash"}},[_c('span',[_v("add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE\n")])])])} },function anonymous( ) { -with(this){return _c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 87654321 n/Betsy Crowe r/Student e/betsycrowe@example.com a/Blk 30 Geylang Street 29, #06-40 p/1234567 c/Business Analytics")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy Crowe")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("87654321")]),_v(" to EduContacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 n/John Doe p/98981212 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("12345678")]),_v(" to EduContacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 71271222 n/Benson Boon p/89229191 e/benson@example.com a/Blk 12 Benson Street c/Economics r/Student")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Benson Boon")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("71271222")]),_v(" to EduContacts (the response message of this command is shown in the screenshot below).")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/addCommandResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/addCommandResult.png","alt":"result for 'add command result'"}})])])])])} +with(this){return _c('ul',[_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 87654321 n/Betsy Crowe r/Student e/betsycrowe@example.com a/Blk 30 Geylang Street 29, #06-40 p/12345678 c/Business Analytics")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Betsy Crowe")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("87654321")]),_v(" to EduContacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 n/John Doe p/98981212 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("John Doe")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("12345678")]),_v(" to EduContacts.")])]),_v(" "),_c('li',[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 71271222 n/Benson Boon p/89229191 e/benson@example.com a/Blk 12 Benson Street c/Economics r/Student")]),_v(" will add a person named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Benson Boon")]),_v(" with student ID of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("71271222")]),_v(" to EduContacts (the response message of this command is shown in the screenshot below).")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/tp/images/addCommandResult.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/tp/images/addCommandResult.png","alt":"result for 'add command result'"}})])])])])} },function anonymous( ) { with(this){return _c('h3',{attrs:{"id":"listing-all-persons-list"}},[_v("Listing all persons : "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#listing-all-persons-list","onclick":"event.stopPropagation()"}})])} @@ -167,12 +167,6 @@ with(this){return _c('h3',{attrs:{"id":"editing-the-data-file"}},[_v("Editing th with(this){return _c('p',[_v("EduContacts data are saved automatically as a JSON file "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[JAR file location]/data/educontacts.json")]),_v(". Advanced users are welcome to update data directly by editing that data file.")])} },function anonymous( ) { -with(this){return _c('h3',{attrs:{"id":"archiving-data-files-coming-in-v2-0"}},[_v("Archiving data files "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[coming in v2.0]")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#archiving-data-files-coming-in-v2-0","onclick":"event.stopPropagation()"}})])} -},function anonymous( -) { -with(this){return _c('p',[_c('em',[_v("Details coming soon ...")])])} -},function anonymous( -) { with(this){return _c('h2',{attrs:{"id":"faq"}},[_v("FAQ"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#faq","onclick":"event.stopPropagation()"}})])} },function anonymous( ) { @@ -197,9 +191,9 @@ with(this){return _c('ol',[_c('li',[_c('strong',[_v("When using multiple screens with(this){return _c('h2',{attrs:{"id":"command-summary"}},[_v("Command summary"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#command-summary","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('strong',[_v("Add")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 n/John Doe p/99999999 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student")])])]),_v(" "),_c('tr',[_c('td',[_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('strong',[_v("Delete")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete ID")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete 12345678")]),_v(" "),_c('br'),_v(" "),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete ID m/MODULE")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete 12345678 m/CS2103T")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Edit")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/COURSE] [r/ROLE]…​")]),_c('br'),_v(" e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 12345678 p/91234567 e/johndoe@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Grade")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("grade ID m/MODULE g/GRADE")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("grade 12345678 m/CS2103T g/A")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Add Module")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("module ID [m/MODULE]")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 m/CS2103T")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Filter")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter [n/NAME] [c/COURSE] [m/MODULE]")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter n/James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Find")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find ID")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find 12345678")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("List")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])])])])])} +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('strong',[_v("Add")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add ID n/NAME p/PHONE e/EMAIL a/ADDRESS c/COURSE r/ROLE")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 n/John Doe p/99999999 e/johndoe@example.com a/123 Jane Doe Road c/Computer Science r/Student")])])]),_v(" "),_c('tr',[_c('td',[_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('strong',[_v("Delete")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete ID")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete 12345678")]),_v(" "),_c('br'),_v(" "),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete ID m/MODULE")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete 12345678 m/CS2103T")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Edit")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit ID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/COURSE] [r/ROLE]…​")]),_c('br'),_v(" e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("edit 12345678 p/91234567 e/johndoe@example.com")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Grade")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("grade ID m/MODULE g/GRADE")]),_v(" "),_c('br'),_v(" e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("grade 12345678 m/CS2103T g/A")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Add Module")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("module ID m/MODULE")]),_v(" "),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("add 12345678 m/CS2103T")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Filter")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter [n/NAME] [c/COURSE] [m/MODULE]")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("filter n/James Jake")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("Find")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find ID")]),_c('br'),_v(" e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("find 12345678")])])]),_v(" "),_c('tr',[_c('td',[_c('strong',[_v("List")])]),_v(" "),_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("list")])])])])])])} },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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/index.html b/index.html index dba0ad6f7a2..a0610088273 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@ Search

    EduContacts

    CI Status codecov

    Ui

    EduContacts is a desktop application for Tertiary Educators to manage your contact details. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
  • EduContacts

    CI Status codecov

    Ui

    EduContacts is a desktop application for Tertiary Educators to manage your contact details. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

    Acknowledgements

    [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/index.page-vue-render.js b/index.page-vue-render.js index 926c6960e55..ecb7ec1cd6b 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":"educontacts"}},[_v("EduContacts"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#educontacts","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/AY2425S1-CS2103T-F15-2/tp/actions"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://github.com/AY2425S1-CS2103T-F15-2/tp/workflows/Java%20CI/badge.svg","alt":"CI Status"}})]),_v(" "),_c('a',{attrs:{"href":"https://codecov.io/gh/AY2425S1-CS2103T-F15-2/tp"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://codecov.io/gh/AY2425S1-CS2103T-F15-2/tp/branch/master/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("EduContacts is a desktop application for Tertiary Educators to manage your 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 EduContacts, 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 EduContacts, 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('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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/siteData.json b/siteData.json index 701b27a29e1..ad83ba31a16 100644 --- a/siteData.json +++ b/siteData.json @@ -130,7 +130,6 @@ "exiting-the-program-exit": "Exiting the program : exit", "saving-the-data": "Saving the data", "editing-the-data-file": "Editing the data file", - "archiving-data-files-coming-in-v2-0": "Archiving data files [coming in v2.0]", "faq": "FAQ", "known-issues": "Known issues", "command-summary": "Command summary" diff --git a/team/btbrandon.html b/team/btbrandon.html index 4bdb60f3382..353bf598122 100644 --- a/team/btbrandon.html +++ b/team/btbrandon.html @@ -18,7 +18,7 @@
  • Project: AddressBook Level 3

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

    Given below are my contributions to the project.

    • New Feature: Added the ability to undo/redo previous commands.

      • 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.
      • 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.
      • 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.
      • Credits: {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}
    • New Feature: Added a history command that allows the user to navigate to previous commands using up/down keys.

    • Code contributed: RepoSense link

    • Project management:

      • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
    • Enhancements to existing features:

      • Updated the GUI color scheme (Pull requests #33, #34)
      • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
    • Documentation:

      • User Guide:
        • Added documentation for the features delete and find #72
        • Did cosmetic tweaks to existing documentation of features clear, exit: #74
      • Developer Guide: -
        • Added implementation details of the delete feature.
    • Community:

      • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
      • Contributed to forum discussions (examples: 1, 2, 3, 4)
      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
      • Some parts of the history feature I added was adopted by several other class mates (1, 2)
    • Tools:

      • Integrated a third party library (Natty) to the project (#42)
      • Integrated a new Github plugin (CircleCI) to the team repo
    • {you can add/remove categories in the list above}

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    • Added implementation details of the delete feature.
  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:

    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}

  • [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/team/btbrandon.page-vue-render.js b/team/btbrandon.page-vue-render.js index b08d91e46e2..6c4ba4cb203 100644 --- a/team/btbrandon.page-vue-render.js +++ b/team/btbrandon.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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/ethan-g.html b/team/ethan-g.html index bd34185f7e3..89a5468baf0 100644 --- a/team/ethan-g.html +++ b/team/ethan-g.html @@ -18,7 +18,7 @@
  • Project: AddressBook Level 3

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

    Given below are my contributions to the project.

    • New Feature: Added the ability to undo/redo previous commands.

      • 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.
      • 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.
      • 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.
      • Credits: {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}
    • New Feature: Added a history command that allows the user to navigate to previous commands using up/down keys.

    • Code contributed: RepoSense link

    • Project management:

      • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
    • Enhancements to existing features:

      • Updated the GUI color scheme (Pull requests #33, #34)
      • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
    • Documentation:

      • User Guide:
        • Added documentation for the features delete and find #72
        • Did cosmetic tweaks to existing documentation of features clear, exit: #74
      • Developer Guide: -
        • Added implementation details of the delete feature.
    • Community:

      • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
      • Contributed to forum discussions (examples: 1, 2, 3, 4)
      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
      • Some parts of the history feature I added was adopted by several other class mates (1, 2)
    • Tools:

      • Integrated a third party library (Natty) to the project (#42)
      • Integrated a new Github plugin (CircleCI) to the team repo
    • {you can add/remove categories in the list above}

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    • Added implementation details of the delete feature.
  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:

    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}

  • [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/team/ethan-g.page-vue-render.js b/team/ethan-g.page-vue-render.js index b08d91e46e2..6c4ba4cb203 100644 --- a/team/ethan-g.page-vue-render.js +++ b/team/ethan-g.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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/jessica2828.html b/team/jessica2828.html index 42a7dda29c7..8a032eaf137 100644 --- a/team/jessica2828.html +++ b/team/jessica2828.html @@ -18,7 +18,7 @@
  • Project: AddressBook Level 3

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

    Given below are my contributions to the project.

    • New Feature: Added the ability to undo/redo previous commands.

      • 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.
      • 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.
      • 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.
      • Credits: {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}
    • New Feature: Added a history command that allows the user to navigate to previous commands using up/down keys.

    • Code contributed: RepoSense link

    • Project management:

      • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
    • Enhancements to existing features:

      • Updated the GUI color scheme (Pull requests #33, #34)
      • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
    • Documentation:

      • User Guide:
        • Added documentation for the features delete and find #72
        • Did cosmetic tweaks to existing documentation of features clear, exit: #74
      • Developer Guide: -
        • Added implementation details of the delete feature.
    • Community:

      • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
      • Contributed to forum discussions (examples: 1, 2, 3, 4)
      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
      • Some parts of the history feature I added was adopted by several other class mates (1, 2)
    • Tools:

      • Integrated a third party library (Natty) to the project (#42)
      • Integrated a new Github plugin (CircleCI) to the team repo
    • {you can add/remove categories in the list above}

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    • Added implementation details of the delete feature.
  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:

    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}

  • [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/team/jessica2828.page-vue-render.js b/team/jessica2828.page-vue-render.js index b08d91e46e2..6c4ba4cb203 100644 --- a/team/jessica2828.page-vue-render.js +++ b/team/jessica2828.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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/juliantayyc.html b/team/juliantayyc.html index 6009b30d7bc..19f9818fc3a 100644 --- a/team/juliantayyc.html +++ b/team/juliantayyc.html @@ -18,7 +18,7 @@
  • Project: AddressBook Level 3

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

    Given below are my contributions to the project.

    • New Feature: Added the ability to undo/redo previous commands.

      • 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.
      • 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.
      • 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.
      • Credits: {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}
    • New Feature: Added a history command that allows the user to navigate to previous commands using up/down keys.

    • Code contributed: RepoSense link

    • Project management:

      • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
    • Enhancements to existing features:

      • Updated the GUI color scheme (Pull requests #33, #34)
      • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
    • Documentation:

      • User Guide:
        • Added documentation for the features delete and find #72
        • Did cosmetic tweaks to existing documentation of features clear, exit: #74
      • Developer Guide: -
        • Added implementation details of the delete feature.
    • Community:

      • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
      • Contributed to forum discussions (examples: 1, 2, 3, 4)
      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
      • Some parts of the history feature I added was adopted by several other class mates (1, 2)
    • Tools:

      • Integrated a third party library (Natty) to the project (#42)
      • Integrated a new Github plugin (CircleCI) to the team repo
    • {you can add/remove categories in the list above}

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    • Added implementation details of the delete feature.
  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:

    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}

  • [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/team/juliantayyc.page-vue-render.js b/team/juliantayyc.page-vue-render.js index b08d91e46e2..6c4ba4cb203 100644 --- a/team/juliantayyc.page-vue-render.js +++ b/team/juliantayyc.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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file diff --git a/team/jyl27.html b/team/jyl27.html index de002e0190a..7e716e7cef4 100644 --- a/team/jyl27.html +++ b/team/jyl27.html @@ -18,7 +18,7 @@
  • Project: AddressBook Level 3

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

    Given below are my contributions to the project.

    • New Feature: Added the ability to undo/redo previous commands.

      • 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.
      • 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.
      • 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.
      • Credits: {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}
    • New Feature: Added a history command that allows the user to navigate to previous commands using up/down keys.

    • Code contributed: RepoSense link

    • Project management:

      • Managed releases v1.3 - v1.5rc (3 releases) on GitHub
    • Enhancements to existing features:

      • Updated the GUI color scheme (Pull requests #33, #34)
      • Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
    • Documentation:

      • User Guide:
        • Added documentation for the features delete and find #72
        • Did cosmetic tweaks to existing documentation of features clear, exit: #74
      • Developer Guide: -
        • Added implementation details of the delete feature.
    • Community:

      • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
      • Contributed to forum discussions (examples: 1, 2, 3, 4)
      • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
      • Some parts of the history feature I added was adopted by several other class mates (1, 2)
    • Tools:

      • Integrated a third party library (Natty) to the project (#42)
      • Integrated a new Github plugin (CircleCI) to the team repo
    • {you can add/remove categories in the list above}

    [Powered by MarkBind 5.5.3, generated on Sat, 9 Nov 2024, 18:52:11 GMT+8]
    +
    • Added implementation details of the delete feature.
  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
    • Contributed to forum discussions (examples: 1, 2, 3, 4)
    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
    • Some parts of the history feature I added was adopted by several other class mates (1, 2)
  • Tools:

    • Integrated a third party library (Natty) to the project (#42)
    • Integrated a new Github plugin (CircleCI) to the team repo
  • {you can add/remove categories in the list above}

  • [Powered by MarkBind 5.5.3, generated on Sun, 10 Nov 2024, 13:57:56 GMT+8]
    diff --git a/team/jyl27.page-vue-render.js b/team/jyl27.page-vue-render.js index b08d91e46e2..6c4ba4cb203 100644 --- a/team/jyl27.page-vue-render.js +++ b/team/jyl27.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 Sat, 9 Nov 2024, 18:52:11 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 Sun, 10 Nov 2024, 13:57:56 GMT+8]")])])])} }]; \ No newline at end of file