collate to .md

CS2103AUG2016-W15-C3 · Nov 2, 2016 · c97d51a · c97d51a
1 parent 8fd7fc1
commit c97d51a
Show file tree

Hide file tree

Showing 15 changed files with 2,266 additions and 1,443 deletions.
diff --git a/collated/docs/A0139257X.md b/collated/docs/A0139257X.md
@@ -1,14 +1,35 @@
 # A0139257X
+###### \AboutUs.md
+``` md
+#### [Marcus Ng Wen Jian](https://github.com/marcusngwj) <br>
+<img src="images/Marcus.png" width="150"><br>
+
+Role: Team Leader
+* Components in charge of: [Logic](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/DeveloperGuide.md#logic-component)
+* Aspects/tools in charge of: Overall Project Management, Code Quality
+* Features implemented:
+	* [Add Command](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/UserGuide.md#adding-a-task-add)
+* Code written: 
+[[functional code](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/main/A0139257X.md)]
+[[test code](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/test/A0139257X.md)]
+[[docs](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/docs/A0139257X.md)]
+* Other major contributions:
+	* Contributed to first round refactoring from AddressBook Level 4 to TaskManager [[#11](https://github.com/CS2103AUG2016-W15-C3/main/pull/11)]
+	* Contributed to second round refactoring from AddressBook Level 4 to Taskell [[#64](https://github.com/CS2103AUG2016-W15-C3/main/pull/64)]
+	* Set up Codacy [[#113](https://github.com/CS2103AUG2016-W15-C3/main/pull/113)]
+
+-----
+```
 ###### \DeveloperGuide.md
 ``` md
+
 ## Appendix B : Use Cases
 
 #### Use case: Add task
 
 **MSS**
 
 1. User requests to add tasks
-
 2. Taskell adds the task<br>
 Use case ends
 
@@ -59,7 +80,7 @@ Use case ends
 
 4a. User tries to mark a completed task as completed
 
-#### Use case: Help task
+#### Use case: Help command
 
 **MSS**
 
@@ -74,7 +95,7 @@ Use case ends
 
 > 3a1. Taskell stil displays the help message <br>
 
-#### Use case: Find task
+#### Use case: Find tasks
 
 **MSS**
 
@@ -110,97 +131,10 @@ Use case ends
 > 3a1, 3b1 and 3c1. Taskell shows an error message <br>
   Use case resumes at step 2
 
-#### Use case: Undo task
-
-**MSS**
-
-1. User enters a command
-2. Taskell executes it
-<<<<<<< HEAD
-3. User requests to list commands history
-4. User requests to undo command at specific index
-5. Taskell undoes the previous command <br>
-=======
-3. User requests to list undo commands history
-4. User requests to undo command at specific index
-5. Taskell revert the command <br>
->>>>>>> 9d3e940bc97dc4a324dca16582e28cdbfc8c5ebc
-Use case ends
-
-**Extensions**
-
-3a. The user did not enter any previous command
-
-> 3a1. Taskell shows a message indicating no commands available for undo<br>
-
-4a. The user enters invalid index
-
-> 4a1. Taskell shows error message indicating index is invalid<br>
-
-#### Use case: List task
-
-**MSS**
-
-1. User requests to list either all tasks, incomplete tasks, completed tasks, task with specific start date or task with specific priority
-2. Taskell shows a list of tasks accordingly
-Use case ends
-
-**Extensions**
-
-2a. The list is empty
-
-> 2a1. Taskell shows an error message <br>
-  Use case resumes at step 2
-
-#### Use case: View calendar for the week
-
-**MSS**
-
-1. User requests to view calendar
-2. Taskell displays calendar
-
-#### Use case: Save data to specified folder
-
-**MSS**
-
-1. User requests to save all tasks
-2. Taskell saves all tasks in the requested folder <br>
-Use case ends
-
-**Extensions**
-
-2a. Data cannot be written to the requested folder (invalid directory or access prohibited)
-
-> 2a1. Taskell shows an error message and still saves data in previous old location.<br>
-
-#### Use case: Clear task
-
-**MSS**
-
-1. User requests to clear all tasks
-2. Taskell deletes all tasks
-Use case ends
-
-**Extensions**
-
-2a. The list is empty
-
-> 2a1. Taskell shows an error message <br>
-
-#### Use case: Exit task
-
-**MSS**
-
-1. User requests to exit Taskell
-2. Taskell saves all the data and stops
-Use case ends
-
-**Extensions**
-
-NIL
 ```
 ###### \UserGuide.md
 ``` md
+
 #### Adding a task: `add`
 To add a floating task<br>
 Format: 
@@ -239,4 +173,5 @@ Example: `add ` concert by 2am band <i>startat</i> 7pm<br>
 
 - `add ` TASK <i>endat</i>  [TIME]<br>
 Example: `add ` netball training <i>endat</i> 7pm<br>
+
 ```
diff --git a/collated/docs/A0142073R.md b/collated/docs/A0142073R.md
@@ -1,14 +1,41 @@
 # A0142073R
+###### \AboutUs.md
+``` md
+#### [Madasamy Ravi Nadar Mamtha](https://github.com/Mamtha3005) 
+<img src="images/Mamtha.png" width="150"><br>
+
+Role: Developer
+* Components in charge of: [Logic](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/DeveloperGuide.md#logic-component)
+* Aspects/tools in charge of: Documentation, Scheduling
+* Features implemented:
+	* [Edit Command](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/UserGuide.md#editing-a-task--edit)
+	* [List-date Command]
+	(https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/UserGuide.md#listing-a-task--list)
+	* [List-priority Command]
+	(https://github.com/CS2103AUG2016-W15-C3/main/blob/master/docs/UserGuide.md#listing-a-task--list)
+* Code Written:
+[[functional code](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/main/A0142073R.md)]
+[[test code](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/test/A0142073R.md)]
+[[docs](https://github.com/CS2103AUG2016-W15-C3/main/blob/master/collated/docs/A0142073R.md)]
+* Other major contributions:
+	* Contributed to second round refactoring from AddressBook Level 4 to Taskell [[#64](https://github.com/CS2103AUG2016-W15-C3/main/pull/64)]
+	* Copy, editing and revising of documentation
+
+-----
+```
 ###### \DeveloperGuide.md
 ``` md
+
 ##Introduction
 
 Taskell is a simple software for users to keep track of their daily tasks and manage their busy schedule. Keyboard lovers will be able to experience the full benefit of Taskell as it implements a command-line interface.
 
 This developer guide will help you understand the design and implementation of Taskell. It helps you understand how Taskell works and how you can contribute for further development. This guide follows a top-down approach by giving an overview of the essential components first, followed by thorough explanation subsequently.
+
 ```
 ###### \DeveloperGuide.md
 ``` md
+
 ## Appendix A : User Stories
 
 Priorities: High (must have) - `* * *`, Medium (nice to have)  - `* *`,  Low (unlikely to have) - `*`
@@ -37,40 +64,32 @@ Priority | As a ... | I want to ... | So that I can...
 `*` | user | edit my notification time period | customise if I wanted to be reminded earlier or later.
 `*` | user |  use the history command | saves time typing repeated commands.
 `*` | user |  view the task in either calendar form or list form |  switch between the two display format.
+
 ```
 ###### \UserGuide.md
 ``` md
+
 ## Introduction
 Are you having a hard time remembering all the work you have to do? Do you have trouble finding a task manager that suits your preference for keyboard input? Well, worry no more, Taskell is here for you! <br>
 Taskell will be your personal secretary. It will keep track of your daily tasks and remind you of any important dates and deadlines. What distinguishes Taskell from other task managers is that Taskell only requires a single line of command for every task input. This means that you can record each one of your tasks with just a single statement. You will no longer have to use a mouse if you do not wish to. <br>
-Ready to begin life anew with a more efficient task manager? Read on to find out more!
+Ready to begin life anew with a more efficient task manager? Read on to find out more! 
+
 ```
 ###### \UserGuide.md
 ``` md
+
 #### Editing a task : `edit`
-To edit the description of a task<br>
+To edit a task<br>
 Formats: 
-- `edit-desc` INDEX NEWDESCRIPTION<br>
-- `edit-name` INDEX NEWDESCRIPTION<br>
+- `edit ` INDEX `st: `[NEWSTARTTIME] `et: `[NEWENDTIME] `desc: `[NEWDESCRIPTION] `sd: `[NEWSTARTDATE] `ed: `[NEWENDDATE] `p: `[NEWPRIORITY]<br>
  <br> <img src="images/editCmd.png" width="600"> </br>
-Diagram 5: Edits the 2nd task on the list<br>
+Diagram 5: Edits the 1st task on the list.  <br>
+Entering "edit 1 desc: send all emails sd: 11-11-2016 ed: 12-11-2016 st: 3pm et: 4pm p: 3", will update description to "send all emails", start date to 11-11-2016, end date to 12-11-2016, start time to 3pm end time to 4pm and priority to 3.<br>
 
-To edit the time of a task<br>
-Formats: 
-- `edit-startTime` INDEX NEWTIME<br>
-- `edit-endTime` INDEX NEWTIME<br>
-
-To edit the date of a task<br>
-Formats: 
-- `edit-startDate` INDEX NEWDATE<br>
-- `edit-endDate` INDEX NEWDATE<br>
-
-To edit the priority of a task<br>
-Formats: 
-- `edit-priority` INDEX NEWDATE<br>
 ```
 ###### \UserGuide.md
 ``` md
+
 ## Command Summary
 
 Command | Format  
@@ -87,13 +106,12 @@ Edit | `edit` INDEX NEWTASK
 Find | `find` KEYWORD [MORE_KEYWORDS]
 Find Tag | `find-tag` KEYWORD [MORE_KEYWORDS]
 Help | `help`
+History | `history` or `hist`
 List Incomplete Tasks| `list`
 List All Tasks | `list-all`
 List Given Day | `list-date` [DATE]
 List Tasks Done | `list-done` [DONE]
-List Undo | `list-undo`
-Undo | `undo INDEX`
-Calendar View | `calendar` or `cal`
+Undo | `undo` or `undo` INDEX
 
 ## Appendix A
 
@@ -119,5 +137,6 @@ Supported Time Format |   Example
 -------- | :-------- 
 12hour |1pm
 12hour |12am
-12hour |111.45pm
+12hour |11.45pm
+
 ```