From ff89cfd6a93bcf0e1937d70712524e2f695e091f Mon Sep 17 00:00:00 2001 From: Qing Hua Date: Wed, 2 Nov 2016 22:30:30 +0800 Subject: [PATCH 1/5] Update UserGuide.md --- docs/UserGuide.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index dada09ed4b5d..77ef0cdbf335 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -151,6 +151,16 @@ Format: `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/ >
> Overwrites any of the specified fields ('LOCATION', 'DESCRIPTION'...) with the new values +#### Change storage location : `storage` +Changes the storage location of Savvy Tasker.
+Format: `storage PATH` + +> Parameters | Description +> -------- | :-------- +> PATH | `Mandatory` Specifies the path of where Savvy Tasker's task list is saved at. +>
+> If the new storage location specified by `PATH` is not accessible by Savvy Tasker, no change will be made to the existing path. + [//]: # (@@author A0097627N) #### Mark a task as done : `mark` @@ -260,6 +270,7 @@ Command | Format [Help](#viewing-help--help) | `help` [Modify](#modifies-a-task--modify) | `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/PRIORITY_LEVEL] [r/RECURRING_TYPE] [n/NUMBER_OF_RECURRENCE] [c/CATEGORY] [d/DESCRIPTION]`
Example: `modify 2 t/Wednesday Weekly Milestone s/wed d/Project Meeting and Finalization` [Mark](#mark-a-task-as-done--mark) | `mark INDEX [MORE_INDEX]`
Example: `mark 1 2 3` +[Storage]() | `storage PATH`
Example: `storage data/savvytasker.xml` [Unmark](#unmark-a-task-as-done--unmark) | `unmark INDEX [MORE_INDEX]`
Example: `unmark 1 2 3` [Undo](#undo-the-most-recent-operation--undo) | `undo` [Redo](#redo-the-most-recent-undo-operation--redo) | `redo` From 1edba0efe857ee5dc0343c45a205efddb5d20d9a Mon Sep 17 00:00:00 2001 From: Qing Hua Date: Wed, 2 Nov 2016 22:35:01 +0800 Subject: [PATCH 2/5] Update UserGuide.md --- docs/UserGuide.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 77ef0cdbf335..eb6fc76c9f68 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -78,11 +78,11 @@ Examples: #### Listing all tasks: `list` Shows a list of all tasks in Savvy Tasker
-Format: `list [t/LIST_TYPE]` +Format: `list [LIST_TYPE]` > Parameters | Description > -------- | :-------- -> LIST_TYPE | `Optional` Specifies the name of the task.
`Accepts` values `DueDate`, `PriorityLevel`, `Archived`
`Defaults` to `DueDate` +> LIST_TYPE | `Optional` Specifies the name of the task.
`Accepts` values `DueDate`, `PriorityLevel`, `Archived`, `Alias`
`Defaults` to `DueDate` `LIST_TYPE` Explanation: * `DueDate`
@@ -91,7 +91,9 @@ Format: `list [t/LIST_TYPE]` * `PriorityLevel`
Tasks are sorted according to priority level beginning with the highest.
* `Archived`
- Tasks that have been [marked](#mark-a-task-as-done--mark) are listed. They are sorted according to the time of creation of the task.
+ Tasks that have been [marked](#mark-a-task-as-done--mark) are listed. They are sorted according to the time of creation of the task. +* `Alias`
+ [Aliases](#alias-a-keyword--alias) that have been registered are listed.
#### Finding all task containing any keyword in its name: `find` Finds tasks whose names contain any of the given keywords.
@@ -157,7 +159,7 @@ Format: `storage PATH` > Parameters | Description > -------- | :-------- -> PATH | `Mandatory` Specifies the path of where Savvy Tasker's task list is saved at. +> PATH | `Mandatory` Specifies the path where Savvy Tasker's task list is saved at. >
> If the new storage location specified by `PATH` is not accessible by Savvy Tasker, no change will be made to the existing path. @@ -266,11 +268,11 @@ Command | Format [Delete](#deleting-a-task--delete) | `delete INDEX [MORE_INDEX]`
Example: `delete 1 2 3` [Exit](#exiting-the-program--exit) | `exit` [Find](#finding-all-task-containing-any-keyword-in-its-name-find) | `find [t/FIND_TYPE] KEYWORD [MORE_KEYWORDS]`
Example: `find t/exact CS2103 Meeting` -[List](#listing-all-tasks-list) | `list [t/LIST_TYPE]`
Example: `list t/archived` +[List](#listing-all-tasks-list) | `list [LIST_TYPE]`
Example: `list archived` [Help](#viewing-help--help) | `help` [Modify](#modifies-a-task--modify) | `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/PRIORITY_LEVEL] [r/RECURRING_TYPE] [n/NUMBER_OF_RECURRENCE] [c/CATEGORY] [d/DESCRIPTION]`
Example: `modify 2 t/Wednesday Weekly Milestone s/wed d/Project Meeting and Finalization` [Mark](#mark-a-task-as-done--mark) | `mark INDEX [MORE_INDEX]`
Example: `mark 1 2 3` -[Storage]() | `storage PATH`
Example: `storage data/savvytasker.xml` +[Storage](#change-storage-location--storage) | `storage PATH`
Example: `storage data/savvytasker.xml` [Unmark](#unmark-a-task-as-done--unmark) | `unmark INDEX [MORE_INDEX]`
Example: `unmark 1 2 3` [Undo](#undo-the-most-recent-operation--undo) | `undo` [Redo](#redo-the-most-recent-undo-operation--redo) | `redo` From 032fd78bc96b862c152912e4cecd525b54d5a9bf Mon Sep 17 00:00:00 2001 From: Qing Hua Date: Wed, 2 Nov 2016 22:44:34 +0800 Subject: [PATCH 3/5] Update DeveloperGuide.md --- docs/DeveloperGuide.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index d985b50905ac..eb3748732ba2 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -293,7 +293,7 @@ b. Require developers to download those libraries manually (this creates extra w Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -Priority | As a ... | I want to ... | So that I can... +Priority | As a(n) ... | I want to ... | So that I can... -------- | :-------- | :--------- | :----------- `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App `* * *` | new user | view more information about a particular command | learn how to use various commands @@ -309,6 +309,7 @@ Priority | As a ... | I want to ... | So that I can... `*` | user | sort tasks by priority level | see the most important tasks and prioritize accordingly `*` | user | undo most recent command | undo the most recent operation `*` | user | redo most recent undo command | redo the operation done by the most recent undo action +`*` | user | change storage location | easily sync them with the cloud `*` | advanced user | alias keywords with shorter versions | type a command faster `*` | advanced user | remove alias of keywords with shorter versions | get rid of shorter version of certain keywords {More to be added} @@ -411,6 +412,29 @@ Use case ends. > 2b1. Savvy Tasker shows an error message and display the expected format
Use case resumes at step 3 + +#### Use case: Change storage location + +**MSS** + +1. Savvy Tasker waits for user command +2. User requests to change the storage location of Savvy Tasker +3. Savvy Tasker changes the storage location, saving all existing data in the new location
+Use case ends. + +**Extensions** + +2a. The given path is invalid + +> 2a1. Savvy Tasker shows an error message
+ Use case ends + +2b. The given path is is not accessible (read/write) by Savvy Tasker + +> 2b1. Savvy Tasker shows an error message
+ Use case ends + + #### Use case: Mark task as done **MSS** From 368440459c773776be0644784f557a4b4ca407c5 Mon Sep 17 00:00:00 2001 From: Qing Hua Date: Wed, 2 Nov 2016 22:47:44 +0800 Subject: [PATCH 4/5] Update DeveloperGuide.md --- docs/DeveloperGuide.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index eb3748732ba2..be75f72a987f 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -309,7 +309,7 @@ Priority | As a(n) ... | I want to ... | So that I can... `*` | user | sort tasks by priority level | see the most important tasks and prioritize accordingly `*` | user | undo most recent command | undo the most recent operation `*` | user | redo most recent undo command | redo the operation done by the most recent undo action -`*` | user | change storage location | easily sync them with the cloud +`*` | user | change storage location | choose where my tasks are saved at `*` | advanced user | alias keywords with shorter versions | type a command faster `*` | advanced user | remove alias of keywords with shorter versions | get rid of shorter version of certain keywords {More to be added} @@ -320,7 +320,7 @@ Priority | As a(n) ... | I want to ... | So that I can... (For all use cases below, the **System** is the `Savvy Tasker` and the **Actor** is the `user`, unless specified otherwise) -#### Use case: Add task +### Use case: Add task **MSS** @@ -350,7 +350,7 @@ Use case ends. > 2d1. Savvy Tasker shows an error message
> Use case resumes at step 1 -#### Use case: List tasks +### Use case: List tasks **MSS** @@ -366,7 +366,7 @@ Use case ends. > 3a1. Savvy Tasker shows an error message
Use case ends -#### Use case: Find task +### Use case: Find task **MSS** @@ -387,7 +387,7 @@ Use case ends. > Use case ends -#### Use case: Modify task +### Use case: Modify task **MSS** @@ -413,7 +413,7 @@ Use case ends. Use case resumes at step 3 -#### Use case: Change storage location +### Use case: Change storage location **MSS** @@ -435,7 +435,7 @@ Use case ends. Use case ends -#### Use case: Mark task as done +### Use case: Mark task as done **MSS** @@ -458,7 +458,7 @@ Use case ends. > 3b1. Savvy Tasker shows a 'task already marked' error message.
> Use case resumes at step 1 -###Use case: Unmark marked task +### Use case: Unmark marked task **MSS** @@ -479,7 +479,7 @@ Use case ends. > Use case resumes at step 1 -#### Use case: Delete task +### Use case: Delete task **MSS** @@ -501,7 +501,7 @@ Use case ends. > 4a1. Savvy Tasker shows an error message > Use case resumes at step 3
-###Use case: Alias keyword and use shorten keyword +### Use case: Alias keyword and use shorten keyword **MSS** @@ -523,7 +523,7 @@ Use case ends. > 2b1. Savvy Tasker shows a error message and the shorten keyword's original associated keyword > Use case resumes at step 1
-###Use case: Unalias keyword +### Use case: Unalias keyword **MSS** @@ -538,7 +538,7 @@ Use case ends. > 2a1. Savvy Tasker shows a 'not found' error message > Use case resumes at step 1
-###Use case: Undo previous command +### Use case: Undo previous command **MSS** @@ -553,7 +553,7 @@ Use case ends. > 2a1. Savvy Tasker shows a 'cannot undo' error message
> Use case ends -###Use case: Redo most recently undone command +### Use case: Redo most recently undone command **MSS** From bbbd343d541aa9f653521ccd56e0fe6a3a18c0d8 Mon Sep 17 00:00:00 2001 From: Qing Hua Date: Wed, 2 Nov 2016 22:49:15 +0800 Subject: [PATCH 5/5] Update DeveloperGuide.md --- docs/DeveloperGuide.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index be75f72a987f..16f7b1f58831 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -312,7 +312,6 @@ Priority | As a(n) ... | I want to ... | So that I can... `*` | user | change storage location | choose where my tasks are saved at `*` | advanced user | alias keywords with shorter versions | type a command faster `*` | advanced user | remove alias of keywords with shorter versions | get rid of shorter version of certain keywords -{More to be added} ## Appendix B : Use Cases @@ -579,7 +578,6 @@ Use case ends. 8. Should store data in text file. 9. Should work without requiring an installer. -{More to be added} ## Appendix D : Glossary