Merge branch 'RemoteDoc' into codeMods

README.adoc

@@ -1,10 +1,8 @@
 = OurTeeth (Morphed from Address Book Level 4)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-
+https://travis-ci.org/CS2103-AY1819S2-W17-2/main[image:https://travis-ci.org/CS2103-AY1819S2-W17-2/main.svg?branch=master["Build Status", link="https://travis-ci.org/CS2103-AY1819S2-W17-2/main"]]
+https://app.netlify.com/sites/cs2103-w17-2/deploys[image:https://api.netlify.com/api/v1/badges/0ed4dd99-3443-483f-94e5-64bb727aa43c/deploy-status[Netlify Status]]
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]

docs/DeveloperGuide.adoc

@@ -1,4 +1,4 @@
-= AddressBook Level 4 - Developer Guide
+= OurTeeth - Developer Guide
 :site-section: DeveloperGuide
 :toc:
 :toc-title:
@@ -15,7 +15,7 @@ ifdef::env-github[]
 endif::[]
 :repoURL: https://github.com/se-edu/addressbook-level4/tree/master
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Team W17-2`      Since: `14 Mar 2019`      Licence: `MIT`
 
 == Setting up
 
@@ -827,21 +827,43 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...
-|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
 
-|`* * *` |user |add a new person |
+|`* * *` |user |add a new patient's particulars | know about their situation
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |user |edit my patient's particulars when the situation changes |
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |user |my patients' medical records and teeth data tied to them |know how their situation evolved
 
-|`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
+|`* * *` |user |store, edit, and view my dental patients' teeth condition | understand and serve my dental patients'
+teeth condition better
+
+|`* * *` |user |add a new task | keep track of what I need to do
+
+|`* * *` |user |delete a task |remove tasks that I have already completed or no longer need to do
+
+|`* * *` |user |edit a task |change details of certains tasks that I have already added
+
+|`* * *` |user | encrypt the imported/exported data | ensure patient information remains confidential
+
+|`* * *` |user | append imported/exported data | work more flexibly with patient information
+
+|`* * *` |user | my imported/exported data supported by multiple file types | work more flexibly with patient information
+
+|`* * *` |user | see a statistics report on each patient's dental history | have an easier time understanding their potential problems
+
+|`* * *` |user | warning to come up when I'm exiting the program if there exists duplicate entries | be reminded to
+edit them before exiting.
+
+|`* *` |user | see an overall statistics report on my patients | analyze potential trends
 
 |`* *` |user |copy a person |reduce the time needed to create a new person who has similar records to an existing person in the list
 
 |`* *` |user |export entries into an external file |view certain entries even when I am not using the application
 
-|`* *` |user |import entries from an external file |reduce the time needed to create a person whose information can be already be obtained from an external source
+|`* *` |user |import entries from an external file |reduce the time needed to create a person whose information can
+be already be obtained from an external source
+
+|`* *` |user |see relevant dentistry tags on my patients' entries | have an overview of my patients' condition
 
 |`*` |user with confidential patient information|log into the application with a password |prevent unauthorized access to the application when I am not around
 

docs/UserGuide.adoc

@@ -16,7 +16,7 @@ endif::[]
 
 By: `Team W17-2`      Since: `Feb 2019`      Licence: `MIT`
 
-Last Updated: 2/12/2019 21:35:35
+Last Updated: 2/19/2019 15:35:35
 
 == Introduction
 
@@ -349,24 +349,79 @@ newly created teeth layout.
 indicate personalised note describing more detail on the patient’s teeth
 health.
 
-=== Importing records: `import`
+=== Open
+Opens the file in the specified file path and overwrites the current records.
+** Note that 'open' always searches inside the data folder.
 
-Reads all entries from a specified text file and overwrites the address book. +
-Format: `import FILENAME`
+Format: `open FILE_PATH`
 
 Examples:
 
-* `import records1.json` +
-Reads all entries from a records1.json and overwrites the address book. +
+* `open records1.json` +
+Replaces the current records with the records in "records1.json".
 
-=== Exporting records: `export`
+* `open february\records2.json` +
+Replaces the current records with the records in "records2.json" found in the "february" folder.
 
-Writes all entries from the address book to a specified text file. +
-If no file exists, a new one will be created.
-Format: `export FILENAME`
+
+=== Save
+Saves the current records to the specified filepath.
+** Note that 'save' always saves inside the data folder. If no such filepath exists,
+it will be created. Otherwise, it will overwrite the existing file.
+
+Format: `save FILE_PATH`
+
+Examples:
+
+* `save records1.json` +
+Saves the current records to "records1.json".
+
+* `save february\records2.json` +
+Saves the current records to "records1.json" found in the "february" folder.
+
+
+=== Import
+Opens the file in the specified file path and adds the specified patients to the current records.
+** Note that 'import' always searches inside the data folder.
+
+Format: `import FILE_PATH INDEX_RANGE`
+
+Examples:
+
+* `import records1.json 1` +
+Adds patient 1 from "records1.json" to the current records.
+
+* `import february\records1.json 1` +
+Adds patient 1 from "records1.json" found in the "february" folder to the current records.
+
+* `import records1.json 1,4` +
+Adds patient 1 and patient 4 from "records1.json" to the current records.
+
+* `import records1.json 1-4` +
+Adds patient 1 to patient 4 from "records1.json" to the current records.
+
+
+=== Export
+Saves the specified patients in the current records to the specified filepath.
+** Note that 'export' always saves inside the data folder. If no such filepath exists,
+it will be created. Otherwise, it will overwrite the existing file.
+
+Format: `export FILE_PATH INDEX_RANGE`
 
 Examples:
 
+* `export records1.json 1` +
+Saves patient 1 from the current records to "records1.json".
+
+* `export february\records1.json 1` +
+Saves patient 1 from the current records to "records1.json" found in the "february" folder.
+
+* `export records1.json 1,4` +
+Saves patient 1 and patient 4 from the current records to "records1.json".
+
+* `export records1.json 1-4` +
+Saves patient 1 to patient 4 from the current records to "records1.json".
+
 * `Export records2.json` +
 Writes all entries from the address book to records2.json. +
 
@@ -389,9 +444,9 @@ Shows details of patients’ dental records
 
 
 === Find
-Shows persons whose data contain any of the given keywords.
+Shows patients whose data contains any of the given keywords according to a specified paramter.
 
-Format: `find [dental] KEYWORD [MORE_KEYWORDS]`
+Format: `find [dental] PREFIX/KEYWORD [MORE_KEYWORDS]`
 
 * Add “dental” to search dental records instead
 * Search is case insensitive
@@ -400,8 +455,8 @@ Format: `find [dental] KEYWORD [MORE_KEYWORDS]`
 Example:
 
 
-* `find Yishun` +
-Show all the people that live in Yishun
+* `find a/Yishun` +
+Show all the people with an address containing the keyword Yishun
 
 
 * `find dental cleaning` +
@@ -423,7 +478,7 @@ Example:
 |2 |Bob |24 |11/02/2019
 |===
 
-* sort name descend
+* sort name desc
 
 [cols=",,,",options="header",]
 |===
@@ -434,7 +489,7 @@ Example:
 |===
 
 
-* sort age ascend
+* sort age asce
 
 [cols=",,,",options="header",]
 |===
@@ -444,6 +499,11 @@ Example:
 |2 |Bob |24 |11/02/2019
 |===
 
+=== Stat
+Generates a statistics report based on the specified patient's data.
+
+Format: `stat INDEX`
+
 === History
 Lists all the commands that have been entered since starting the
 application in reverse chronological order

docs/team/cchj1995.adoc

@@ -0,0 +1,72 @@
+= Jonathan Choo - Project Portfolio
+:site-section: AboutUs
+:imagesDir: ../images
+:stylesDir: ../stylesheets
+
+== PROJECT: AddressBook - Level 4
+
+---
+
+== Overview
+
+AddressBook - Level 4 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.
+
+== Summary of contributions
+
+* *Major enhancement*: 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}_
+
+* *Minor enhancement*: added a history command that allows the user to navigate to previous commands using up/down keys.
+
+* *Code contributed*: [https://github.com[Functional code]] [https://github.com[Test code]] _{give links to collated code files}_
+
+* *Other contributions*:
+
+** Project management:
+*** Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+** Enhancements to existing features:
+*** Updated the GUI color scheme (Pull requests https://github.com[#33], https://github.com[#34])
+*** Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests https://github.com[#36], https://github.com[#38])
+** Documentation:
+*** Did cosmetic tweaks to existing contents of the User Guide: https://github.com[#14]
+** Community:
+*** PRs reviewed (with non-trivial review comments): https://github.com[#12], https://github.com[#32], https://github.com[#19], https://github.com[#42]
+*** Contributed to forum discussions (examples:  https://github.com[1], https://github.com[2], https://github.com[3], https://github.com[4])
+*** Reported bugs and suggestions for other teams in the class (examples:  https://github.com[1], https://github.com[2], https://github.com[3])
+*** Some parts of the history feature I added was adopted by several other class mates (https://github.com[1], https://github.com[2])
+** Tools:
+*** Integrated a third party library (Natty) to the project (https://github.com[#42])
+*** Integrated a new Github plugin (CircleCI) to the team repo
+
+_{you can add/remove categories in the list above}_
+
+== Contributions to the User Guide
+
+
+|===
+|_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
+|===
+
+include::../UserGuide.adoc[tag=undoredo]
+
+include::../UserGuide.adoc[tag=dataencryption]
+
+== Contributions to the Developer Guide
+
+|===
+|_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
+|===
+
+include::../DeveloperGuide.adoc[tag=undoredo]
+
+include::../DeveloperGuide.adoc[tag=dataencryption]
+
+
+== PROJECT: PowerPointLabs
+
+---
+
+_{Optionally, you may include other projects in your portfolio.}_