From ef54613c3b1fd05a512ffc3a59bb45b80ce19ccc Mon Sep 17 00:00:00 2001 From: varung97 Date: Mon, 7 Nov 2016 16:59:41 +0800 Subject: [PATCH] Collated code --- collated/docs/A0139621H.md | 100 +- collated/docs/A0147924X.md | 294 ++-- collated/docs/A0148042M.md | 6 +- collated/main/A0139621H.md | 240 ++++ collated/main/A0147924X.md | 2278 ++++++++++++++++++++++++++++++ collated/main/A0148003U.md | 244 ++++ collated/main/A0148042M.md | 1085 ++++++++++++++ collated/main/A0148042Mreused.md | 29 + collated/test/A0139621H.md | 367 +++++ collated/test/A0139621Hreused.md | 63 + collated/test/A0147924X.md | 1324 +++++++++++++++++ collated/test/A0148003U.md | 58 + collated/test/A0148042M.md | 83 ++ 13 files changed, 6007 insertions(+), 164 deletions(-) create mode 100644 collated/main/A0139621H.md create mode 100644 collated/main/A0147924X.md create mode 100644 collated/main/A0148003U.md create mode 100644 collated/main/A0148042M.md create mode 100644 collated/main/A0148042Mreused.md create mode 100644 collated/test/A0139621H.md create mode 100644 collated/test/A0139621Hreused.md create mode 100644 collated/test/A0147924X.md create mode 100644 collated/test/A0148003U.md create mode 100644 collated/test/A0148042M.md diff --git a/collated/docs/A0139621H.md b/collated/docs/A0139621H.md index 163f4b907c6f..3628e8f4ff1b 100644 --- a/collated/docs/A0139621H.md +++ b/collated/docs/A0139621H.md @@ -1,10 +1,100 @@ # A0139621H -###### \UserGuide.md +###### /UserGuide.md +``` md + +#### Ticking off tasks: `done` +_Perhaps the most satisfying command! Let's you mark a task as done._
+Format: `done ` + +> Task number specifies which out of the tasks on the screen you wish to tick off + +Examples: + * `done 1` + * `done 3` + + + + +#### Undo previous action: `undo` +_Made a mistake? Fret not! Just use this keyword to revert the last action that you did!_
+Format: `undo` + +> * Can be used more than once.
+> * Cannot be used if you close TaskNinja and reopen it; the temporary history of commands that you use will be cleared and there will be nothing for TaskNinja to undo.
+> * The commands that you can undo are: add, edit, delete and alias +> * All extension commands cannot be undone, by default. + +Example: + * `undo` + + + +#### Sortby: `sortby` +_Sorts your task list either by time, or by priority._
+Format: `sortby time/priority` + +> Even if priority or time have been aliased, this command will still use the words priority and time + +Examples: + * `sortby time` + * `sortby priority` + + + +#### Specify a storage folder: `storage` +_Allows you to edit the storage file._
+Format: `storage ` + +> The file's name must have a .xml extension.
+ +Example: + * `storage data/TaskNinja.xml` + + + +#### Alias Commands: `alias` +_If you're an advanced user, you may replace our existing commands with a keyword of your own!_
+Format: `alias ` + +> * Take note that you cannot replace a command with a keyword that is already in use.
+> * To a command's alias, simply use help for that command.
+ +Examples: + * `alias add +` + * `alias + add` + * `alias priority p` + + + +#### Clear: `clear` +_Wipes off all tasks and tags from TaskNinja._
+Format: `clear` + +> * *WARNING*: This command is irreversible! It cannot be undone even with the `undo` command!
+> * You should hence be VERY sure if you wish to use this command at any point in time, unless you have saved your tasks to another .xml file!
+ + + +#### Exiting Task Ninja: `exit` +_This command closes Task Ninja. Hope to see you back soon!_
+Format: `exit` + +Example: + * `exit` + + +#### Saving the data +Tasks are saved in the hard disk automatically after any command that changes the data.
+There is no need to save manually. + + +``` +###### /UserGuide.md ``` md # Appendix A _This appendix lists down all the inputs of dates and times that are accepted when adding/editing a task._
_As we are using PrettyTime parser to read in dates and times, we strongly recommend you to follow this table in order to let you have the best experience when using Task Ninja!_
-_You may also refer to the examples in [Event](#from-to) and [Before](#before) sections for an overview of how to input your dates and times when adding/editing your task._
+_You may also refer to the examples in [Event](#from-to), [At](#at) and [By](#by) sections for an overview of how to input your dates and times when adding/editing your task._
> * The current time (in HH:MM:SS) will be timestamped to your tasks should you decide not to enter a time. > * The following examples use Wed 19 Oct 12:00:00 2016 as the current time and date, unless otherwise specified @@ -13,14 +103,14 @@ Input | Read in as | Comments ----- | :--------: | ------- | `2am` | Wed Oct 19 02:00:00 | 12-hour format `2AM` | Wed Oct 19 02:00:00 | Not case-sensitive -`2pm` | Wed Oct 19 14:00:00 | -`3:30am` | Wed Oct 19 03:30:00 | +`2pm` | Wed Oct 19 14:00:00 | +`3:30am` | Wed Oct 19 03:30:00 | `4:45pm` | Wed Oct 19 16:45:00 | `0515` | Wed Oct 19 05:15:00 | 24-hour format `1700` | Wed Oct 19 17:00:00 | `6:00` | Wed Oct 19 06:00:00 | `07:55` | Wed Oct 19 07:55:00 | -`19:59` | Wed Oct 19 19:59:00 | +`19:59` | Wed Oct 19 19:59:00 | `20 November` | Sun Nov 20 12:00:00 | Uses current time by default `22 January '17` | Sun Jan 22 12:00:00 2017 | Uses an apostrophe in shortened year `23rd February 2017` | Tue Feb 23 12:00:00 2017 | Numerals (st, nd, rd, th) are accepted diff --git a/collated/docs/A0147924X.md b/collated/docs/A0147924X.md index ebd6a68c1ccb..2e7cd8f3b050 100644 --- a/collated/docs/A0147924X.md +++ b/collated/docs/A0147924X.md @@ -1,5 +1,5 @@ # A0147924X -###### \DeveloperGuide.md +###### /DeveloperGuide.md ``` md ## Introduction @@ -9,7 +9,7 @@ This guide describes how Task Ninja has been designed and implemented. It is dir ``` -###### \DeveloperGuide.md +###### /DeveloperGuide.md ``` md ## Appendix A : User Stories @@ -17,24 +17,24 @@ Likeliness: Likely - `L`, Unlikely - `U` Likeliness | As (a)... | I want to... | So that I can... -------- | :-------- | :--------- | :----------- -`L` | All Users | Interact with the manager using a CLI and keys | Get rid of the need for a mouse -`L` | All Users | Use a keyboard shortcut to activate the manager | Speed up my workflow +`L` | All Users | Interact with the manager using a CLI and keys | Get rid of the usage for a mouse `L` | New User | View info about a command | Learn how to use these commands `L` | User | Add tasks with a description and a specific deadline | Set deadlines for tasks -`L` | User | Add tasks with description, start time and end time | Create events in the calendar -`L` | User | Add tasks with only a description | Set tasks that need to be completed at some point of time -`L` | User | Add tasks that starts from a certain time | Set tasks that doesn't have an end time +`L` | User | Add tasks with description, start time and end time | Create events in the task manager +`L` | User | Add tasks with only a description | Set tasks that do not have certain time, which are called floating tasks +`L` | User | Add tasks that starts from a certain time | Set tasks that do not have an end time `L` | User | Modify a task | Update deadlines and descriptions `L` | User | Delete a task | Remove it from the Task Manager's to-do list `L` | User | Tick off a task | Record that this task is complete by marking it as done -`L` | User | Search for (a) task(s) | Find (a) task(s) and maybe edit it +`L` | User | Search for task(s) | Find task(s) and maybe edit it `L` | User | See upcoming tasks | Decide what to do next `L` | User | Assign priority to tasks | Gauge which task should be done next +`L` | User | Sort upcoming tasks by priority | Make the decision of which task to complete next faster `L` | User | See tasks in a specific period of time | See what has been scheduled for a certain period `L` | User | See upcoming tasks up until a specified time | See less / more upcoming tasks according to the time frame I want `L` | User | Undo operation(s) | Remove a mistake -`L` | Advanced User | Edit the storage file | Make changes without having to go through the manager -`L` | Advanced User | Declare my own names for commands | Personalise the experience and make it faster +`L` | Advanced User | Edit the storage file | Make changes without going through the manager +`L` | Advanced User | Declare my own names for commands | Personalize the experience and make it more efficient `U` | New User | View the procedure of creating a task | Learn how to create a task first `U` | User | Declare tasks that have to be done after a certain time | Record these tasks somewhere and not be bothered by them until a certain time `U` | User | Redo operation(s) | Redo a change that had been undone @@ -42,20 +42,20 @@ Likeliness | As (a)... | I want to... | So that I can... `U` | User | Search for empty slots (within a given time frame) | Decide when to schedule a task `U` | User | Integrate with third-party applications like GCalendar | Access my tasks on another platform too `U` | User | List [floating tasks](#floating-task) | See whether I want to complete a floating task next -`U` | User | Sort upcoming tasks by priority | Make the decision of which task to complete next faster `U` | User | Block multiple slots for a task | Choose later which slot I want to assign this task to and keep the selected slots free for that task `U` | User | Decide slot for an item blocking multiple slots | Free up the other slots for other tasks `U` | User | Receive emails/notifications about pressing deadlines | Be reminded to complete these tasks +`U` | All Users | Use a keyboard shortcut to activate the manager | Speed up my workflow ``` -###### \UserGuide.md +###### /UserGuide.md ``` md # User Guide * [Quick Start](#quick-start) * [Features](#features) * [Primary Commands](#primary-commands) - * [Extensions](#extensions) + * [Extensions](#extensions) * [Cheat Sheet](#cheat-sheet) * [Appendix A](#appendix-a) @@ -85,11 +85,11 @@ Likeliness | As (a)... | I want to... | So that I can... ## Features ### Overview -Task Ninja uses some [primary commands](#primary-commands), like `add`, `edit`, `delete` and `find`. These commands can then be made more specific using [extensions](#extensions), such as `at`, `before`, `from-to` and `priority`.
+Task Ninja uses some [primary commands](#primary-commands), like `add`, `edit`, `delete` and `find`. Some of these commands, like `add` and `edit`, can then be made more specific using [extensions](#extensions), such as `at`, `by`, `from-to` and `priority`.
This means that the primary commands are used in conjunction with extensions to give the manager more information about what you want to do.
-For example, you could edit the venue of the 1st task displayed by typing `edit 1 at Home`. +For example, you could edit the venue of the 1st task displayed by typing `edit 1 venue Home`. > The order of extensions is not fixed. @@ -103,12 +103,15 @@ For example, you could edit the venue of the 1st task displayed by typing `edit #### Viewing help: `help` _Overwhelmed by the amazingness of Task Ninja? `help` is here to help you discover more._
-Format: `help` +Format: `help []` -> This shows help for all commands.
+> This shows help for all commands (In fact it opens this User Guide)
+> If a command is specified, then it shows help for that command only -Example: +Examples: * `help` + * `help add` + * `help delete` @@ -122,191 +125,170 @@ Format: `add []` Examples: * `add Dinner with Arthur` - * `add Dinner with Arthur venue Avalon from 8:30pm to 9:30pm` - * `add Finish 2103T Tutorial before 11:59pm` + * `add Elope with Guinevere` - -#### Searching for tasks: `find` -_Forgotten when you arranged that date? Use `find`!_
-Format: `find []` + +#### Extensions +_But now you're probably wondering... what extensions can I use? How do they help me? +Well to answer that, let's just dive straight into our extensions:_
-> * The search is case sensitive. e.g `dinner` will not match `Dinner`. -> * The order of the keywords does not matter. e.g. `Tutorial CS2103T` will match `CS2103T Tutorial`. -> * Only the description is searched for. -> * Only full words will be matched e.g. `2103T` will not match `CS2103T`. -> * Tasks matching at least one keyword will be returned (i.e. OR search). e.g. `Dinner` will match `Dinner with Mum`. + +##### At a certain venue: `venue` +_Going to university but somehow ended up wandering at the mall aimlessly? Remember your destination with this extension._
+Format: `venue ` Examples: - * `find Tutorial`
- Shows all tasks containing `Tutorial` in the description - * `find Dinner Tutorial`
- Shows all tasks containing `Dinner` or `Tutorial` in their descriptions + * `add Lunch with Arthur venue Avalon` + * `add Date with Girlfriend venue Romantic spot` - -#### Editing tasks: `edit` -_Decided to postpone your homework? We let you do that too ;)_
-Format: `edit [] []` + +##### Events that last for a certain period of time: `from-to` +_Mark tasks/events that will be done over a certain period of time._
+Format: `from to ` -> * Task number specifies which out of the tasks on the screen you wish to modify.
-> * If given, the new task description will replace the old one for this task.
-> * Fields for the specified extensions will be changed.
+> * Start time/date indicates when the task/event begins, end time/date indicates when the task/event finishes.
+> * A list of supported time and date inputs are listed in [Appendix A](#appendix-a). You may also refer to the examples for a brief guide.
Examples: - * `edit 1 Dinner with Guinevere` - * `edit 2 at 1am 3 Oct` - * `edit 1 Dinner with Guinevere venue Under the stars` - + * `add Meeting with Boss from 11am to 1pm` + * `add Collect computer from store from 2:30pm to 3:00pm` + * `add Picnic with Guinevere from tomorrow morning to tomorrow evening` - -#### Deleting tasks: `delete` -_Added a task you don't need? Fear not, for delete is here._
-Format: `delete ` -> Task number specifies which out of the tasks on the screen you wish to delete.
+ +##### At a certain time/date: `at` +_Specify a start time for a task._
+Format: `at