Merge branch 'master' of github.com:CS2103AUG2016-F11-C3/main

CS2103AUG2016-F11-C3 · Nov 7, 2016 · d776358 · d776358
2 parents b0fb61d + 5695810
commit d776358
Show file tree

Hide file tree

Showing 70 changed files with 3,652 additions and 1,621 deletions.
diff --git a/README.md b/README.md
@@ -28,5 +28,10 @@
 
 ### Acknowledgements
 
+* Libraries used:
+   * [`opencsv`](http://opencsv.sourceforge.net/)
+   * [`prettytime`](http://www.ocpsoft.org/prettytime/)
+   * [`prettytime-nlp`](http://ocpsoft.org/prettytime/nlp/)
+   * [`google-diff-match-patch`](https://code.google.com/p/google-diff-match-patch/)
 * The original product that this is based on is **addressbook-level4**, developed by the [NUS Software Engineering team](https://github.com/se-edu/)
 
diff --git a/build.gradle b/build.gradle
@@ -58,6 +58,8 @@ allprojects {
         compile group: 'org.ocpsoft.prettytime', name: 'prettytime', version: '4.0.0.Final'
         // https://mvnrepository.com/artifact/org.ocpsoft.prettytime/prettytime-nlp
         compile group: 'org.ocpsoft.prettytime', name: 'prettytime-nlp', version: '4.0.0.Final'
+		// https://mvnrepository.com/artifact/org.webjars/google-diff-match-patch
+		compile group: 'org.bitbucket.cowwoc', name: 'diff-match-patch', version: '1.1'
 
 
         testCompile "junit:junit:$junitVersion"

diff --git a/collated/docs/A0092390E.md b/collated/docs/A0092390E.md
@@ -1,5 +1,9 @@
 # A0092390E
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
+``` md
+<img src="images/UiClassDiagram.png" width="800"><br>
+```
+###### \DeveloperGuide.md
 ``` md
 ### Use case: Mark task as completed
 #### MSS
@@ -33,46 +37,49 @@
 > 1b2. User selects desired choice
 > 1b3. System deletes selected tasks
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 #### `context_id`
 Tasks and events are shown on the main interface of Sudowudo and paged. The `context_id` allows you to modify tasks and events that are shown on the interface based on the *contextual* identifier, i.e. the numerical index that is shown on the interface. The identifier does not need to be enclosed in quote marks.
 
 The `context_id` is not persistent and can change depending on what tasks/events are on the interface at the time. It is meant to provide a more convenient and interactive way to interact with tasks/events.
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 ### Updating an Event
 #### Editing Event Details
 Sometimes it is necessary to change the details of your event because life. Luckily, you can edit an item's description, start date/time and end date/time.
 
-```bash
-# format
+```java
+// format
 edit CONTEXT_ID FIELD_NAME:NEW_DETAIL
 ```
 Fields: [`CONTEXT_ID`](#context-id), [`FIELD_NAME`](#field-name), `NEW_DETAIL`
 
 You can change multiple fields for the same event at the same time by separating multiple `FIELD_NAME:NEW_DETAIL` parameters with a comma.
 
-```bash
-# examples
+```java
+// examples
 edit 10 by: 29 October 5pm
 edit 4 end:1/2/2016 10:51am # edits the forth item currently listed
 edit 5 period : 11 nov 4:30pm to 6:30pm
 
-# change multiple fields at the same time
-# both of these commands are equivalent
+// change multiple fields at the same time
+// both of these commands are equivalent
 edit 1 start: this friday 1600, end:this friday 1645
 edit 1 period: this friday 1600 to 1645
 ```
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
-### Paging
+### Scrolling
 The main interface of Sudowudo pages your upcoming tasks/events.
 
-```bash
-next           # shows next page of tasks/events
-back           # shows previous page of tasks/events
-```
+You can scroll through the list of items on the main interface using keyboard shortcuts.
+
+|         | Scroll Up | Scroll Down |
+|---------|-----------|-------------|
+| Windows | `Page Up` | `Page Down` |
+| Mac     | `⌘ ↑`  | `⌘ ↓`  |
+
 ```
diff --git a/collated/docs/A0131560U.md b/collated/docs/A0131560U.md
@@ -1,5 +1,9 @@
 # A0131560U
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
+``` md
+<img src="images/ModelClassDiagram.png" width="800"><br>
+```
+###### \DeveloperGuide.md
 ``` md
 ## Appendix A: User Stories
 Priorities: 
@@ -27,7 +31,7 @@ Priority | As a ... | I want to ... | So that I can...
 `*`   | user | have the app autocomplete my task name | more quickly type in commands
 `*`   | power user | use keyboard shortcuts to access frequently-used features | more quickly access useful features
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
 ``` md
 ## Appendix B: Use Cases
 (For all use cases below, the `System` is Wudodo and the `Actor` is the user, unless specified otherwise)
@@ -56,7 +60,7 @@ Priority | As a ... | I want to ... | So that I can...
 2a. No matching tasks
 > Use case ends
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
 ``` md
 ### Use case: List all tasks
 #### MSS
@@ -72,7 +76,7 @@ Priority | As a ... | I want to ... | So that I can...
 > 2a1. System shows an error message
 > Use case resumes at step 2
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
 ``` md
 ## Appendix C: Non-Functional Product Requirements
 1. Should work on any mainstream OS as long as it has `Java 1.8.0_60` or higher installed.
@@ -83,7 +87,7 @@ Priority | As a ... | I want to ... | So that I can...
 6. Should not use relational databases
 7. Should be reliant on CLI instead of GUI
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
 ``` md
 ## Appendix D: Product Survey
 
@@ -133,7 +137,7 @@ This list of features is taken from the [Handbook](http://www.comp.nus.edu.sg/~c
 - Use of keyboard shortcuts
 - On-screen shortcuts for particular features (e.g. postponing, making event recurring)
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
 ``` md
 ### Apple Reminders
 #### Meets Specifications
@@ -158,49 +162,50 @@ This list of features is taken from the [Handbook](http://www.comp.nus.edu.sg/~c
 
 [^2]: https://support.todoist.com/hc/en-us/articles/205063212-Keyboard-shortcuts
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 
 #### `tags`
 Tags are single-word markers that can be added to a task. Each task can have as many `tags` as you want. Hashtags are used to denote a tag.
 
-```bash
-#important # valid
-important  # invalid
+```java
+#important   // valid
+important    // invalid
 ```
+
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 ### Searching for a Task/Event
 You can search for specific events using keyphrases. Keyphrases are filtered according to whether they search through `Descriptor`s, `Tag`s or `DateTime`s. Take note of your current [`list`](#enumerating-tasks) context, as this will affect what items are searched.
 
 The keyphrases are case-insensitive and can be simply part of the event name. All of the keyphrases must be matched for an item to be returned.
 
-```bash
-# format
-find "DESCRIPTOR KEYPHRASE" "KEYPHRASE" -> searches descriptors for partial matches
-find #TAGPHRASE                         -> searches tags for partial matches
-find from tomorrow to tuesday           -> searches for exact matches to the date specified
+```java
+// format
+find "DESCRIPTOR KEYPHRASE" "KEYPHRASE" // searches descriptors for partial matches
+find #TAGPHRASE                         // searches tags for partial matches
+find from tomorrow to tuesday           // searches for exact matches to the date specified
 ```
 
 Fields: [`DESCRIPTOR KEYPHRASE`](#descriptors), [`TAG KEYWORD`](#tags), [`DATETIME KEYPHRASE`](#datetime)
 
-```bash
-# examples
+```java
+// examples
 find "cake"
-find "CS2103" #homework tomorrow        -> searches for CS2103 in descriptors, homework in tags,
-                                           and looks for dates matching the date of 'tomorrow'
+find "CS2103" #homework tomorrow        // searches for CS2103 in descriptors, homework in tags,
+                                        // and looks for dates matching the date of 'tomorrow'
 ```
 
 ### Enumerating Tasks
 You can enumerate a list of all the events and show it on the main interface. You can also limit your listings using specific meta-tags. List changes the context of your current window view, so that all future searches will occur within this context. For instance, `list task` -> `find "homework"` returns all tasks with the keyword 'homework' in the descriptions, but will not return any events with the keyword 'homework' in the description.
 
-```bash
-list         # lists all tasks/events in chronological order
-list task    # lists all tasks, no events
-list event   # lists all events, no tasks
-list done    # lists all tasks/events that are done
-list undone  # opposite of list done, lists everything not done
-list overdue # lists all events/tasks with end date before the current time
+```java
+list         // lists all tasks/events in chronological order
+list task    // lists all tasks, no events
+list event   // lists all events, no tasks
+list done    // lists all tasks/events that are done
+list undone  // opposite of list done, lists everything not done
+list overdue // lists all events/tasks with end date before the current time
 ```
 ```
diff --git a/collated/docs/A0144750J.md b/collated/docs/A0144750J.md
@@ -1,49 +1,5 @@
 # A0144750J
-###### /AboutUs.md
-``` md
-
-We are a project team for the module CS2103 - Software Engineering from the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
-
-## Project Team
-
-#### [Muthu Kumar Chandrasekaran](http://wing.comp.nus.edu.sg/~cmkumar)
-<img src="images/Muthu.jpg" width="150"><br>
-
-**Role**: Project Advisor
-
------
-
-#### CARA LEONG SU-YI
-<img src="images/Cara.jpg" width="150"><br>
-
-**Responsibilities**: UI
-
------
-
-#### DARREN WEE ZHE YU
-<img src="images/Darren.jpg" width="150"><br>
-
-**Responsibilities**: Storage
-
------
-
-#### LE MINH DUC
-<img src="images/MinhDuc.jpg" width="150"><br>
-
-**Responsibilities**: Model
-
------
-
-#### YUAN YUCHUAN
-<img src="images/Yuchuan.jpg" width="150"><br>
-
-**Responsibilities**: Logic
-
------
-
-
-```
-###### /ContactUs.md
+###### \ContactUs.md
 ``` md
 
 * **Bug reports, Suggestions** : Post in our [issue tracker](https://github.com/CS2103AUG2016-F11-C3/main/issues)
@@ -53,7 +9,11 @@ We are a project team for the module CS2103 - Software Engineering from the [Sch
 
 * **Email us** *(email to be changed)*: You can also reach us at `e0008837 [at] u.nus.edu` 
 ```
-###### /NewDeveloperGuide.md
+###### \DeveloperGuide.md
+``` md
+<img src="images/SDforDeleteItem.png" width="800">
+```
+###### \DeveloperGuide.md
 ``` md
 ### Use case: Clear list
 #### MSS
@@ -65,7 +25,7 @@ We are a project team for the module CS2103 - Software Engineering from the [Sch
 1a. The list is empty
 > Use case resumes at step 3
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 ## Quick Start
 <!-- for getting the thing to actually work -->
@@ -81,46 +41,52 @@ In the following sections, we outline the format of commands to use `Sudowudo`.
 ### Getting Help
 `Sudowudo` also stores documentation that can be accessed from its command-line interface using the following command.
 
-```bash
-# format
-help           # for general how-to-use help
-help COMMAND   # for command-specific help
+```java
+// format
+help           // for general how-to-use help
+help COMMAND   // for command-specific help
 ```
 
-```bash
-# examples
-help add       # command-specific help for add
-help list       # command-specific help for list
+```java
+// examples
+help add       // command-specific help for add
+help list      // command-specific help for list
 ```
 ### Field Formats
 
 #### `descriptors`
 Descriptors are words/phrases used for identification, such as for the name of an event or for an event's description. Quote marks are used to denote a descriptor.
 
-```bash
-"Dental Appointment" # valid
-Dental Appointment   # invalid
+```java
+"Dental Appointment" // valid
+Dental Appointment   // invalid
 ```
 ```
-###### /UserGuide.md
+###### \UserGuide.md
 ``` md
 #### Marking as Complete
-```bash
-# format
+```java
+// format
 done CONTEXT_ID
 ```
-Fields: [`CONTEXT_ID`](#context-id)
+Fields: [`CONTEXT_ID`](//context-id)
 
-```bash
-# examples
-done 3 # marks the third item displayed as done
+```java
+// examples
+done 3 // marks the third item displayed as done
 ```
 ```
-###### /UserGuide.md
+###### \UserGuide.md
+``` md
+### Command History
+The command box stores a history of past commands that you can traverse with the `Up` and `Down` arrow keys. The keyboard shortcut is the same for both Windows and Mac.
+
+```
+###### \UserGuide.md
 ``` md
 ### Undoing
 Use the `undo` command to undo the most recent action.
-```bash
+```java
 undo
 ```
 ```