Skip to content

Latest commit

 

History

History
142 lines (120 loc) · 6.45 KB

A0142073R.md

File metadata and controls

142 lines (120 loc) · 6.45 KB

A0142073R

\AboutUs.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
##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
## Appendix A : User Stories

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


Priority | As a ... | I want to ... | So that I can...
-------- | :---------- | :--------- | :-----------
`* * *` | new user | see user guide | refer to the different commands when I forget how to use the application.
`* * *` | user |  add a task | take note of all my tasks.
`* * *` | user | delete a task | remove task that I no longer need.
`* * *` | user | find a task by its description | locate details of tasks without having to go through the entire list.
`* * *` | user | categorize my tasks | group and view tasks of similar type.
`* * *` | user | view all the tasks, sorted by day, month | plan my schedule.
`* * *` | user | edit task | make changes to the task created.
`* * *` | user | have a start and end time for an event | take note of the duration of the event.
`* * *` | user | set deadlines for a task | remember when the task is due.
`* * *` | user | undo my previous action | correct any mistakes made.
`* * *` | user | mark a task as done | focus on the uncompleted tasks.
`* * *` | user | have flexible command format |have various options to execute a command.
`* * *` | user | specify a folder with cloud syncing service as the storage location | I can easily access my task manager from different computers.
`* * *` | user | I want to see a list of completed tasks | view all the tasks I had done.
`* *` | user |  delete tasks based on a certain index | delete a few tasks instead of one.
`*` | user | set some of my task recursively | schedule them on a daily/weekly/monthly basis.
`*` | user | be able to block multiple timeslots, and release the timeslots when timing is confirmed|  schedule in events which have uncertain timings more efficiently.
`*` | user | sort tasks by priority | view the most important tasks.
`*` | 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
## 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! 
\UserGuide.md
#### Editing a task : `edit`
To edit a task<br>
Formats: 
- `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 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>
\UserGuide.md
     
## Command Summary

Command | Format  
-------- | :-------- 
Add Floating Task | `add` TASK ITEM 
Add Event | `add` TASK ITEM <strong>by</strong> [DATE]
Add Event | `add` TASK ITEM <strong>by</strong> [TIME]
Add Event With Deadline | `add` TASK ITEM <strong>by</strong> [DATE][TIME]
Calendar View | `calendar` or `cal`
Clear | `clear`
Complete | `done` INDEX
Delete | `delete` INDEX
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]
Undo | `undo` or `undo` INDEX

## Appendix A

Supported Date Format |   Example  
-------- | :-------- 
DD-MM-YY |1-1-16 
DD-MM-YY  | 1-1-2016 
DD-MM-YY  | 1-Jan-2016
DD-MM-YY  | 1-January-2016  
DD-MM-YY  | 1.Jan.2016
DD-MM-YY  | 1.January.2016  
MM-YY  | july-16
MM  | july
day  | today
day  | tdy
day  | tmr
day  | tomorrow
day  | thursday

## Appendix B

Supported Time Format |   Example  
-------- | :-------- 
12hour |1pm
12hour |12am
12hour |11.45pm