From 274e01726bf979eb182ac6a3f2abd032034fe319 Mon Sep 17 00:00:00 2001 From: rachx Date: Mon, 7 Nov 2016 23:14:20 +0800 Subject: [PATCH] Fix test scripts (#221) * Fix test scripts * missing #userguide * Update AboutUs.md * Update AboutUs.md * Bring back the brackets * index -> id, add disclaimer to note task name as id changes * update about us --- docs/AboutUs.md | 20 +++---- src/test/data/ManualTesting/testScript.md | 71 +++++++++++++---------- 2 files changed, 49 insertions(+), 42 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 29c995800c59..7d49b740a432 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -10,7 +10,7 @@ We are a team based in the [School of Computing, National University of Singapor ----- -#### [Rachael Sim](https://github.com/rachx) +#### [Rachael Sim @rachx](https://github.com/rachx)
**Role: Team leader**
* Components in charge of: Model
@@ -22,7 +22,7 @@ We are a team based in the [School of Computing, National University of Singapor * [Rename an existing task](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#renaming-a-task--rename) * [Undo last changes to the task list](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#undoing-your-last-changes--undo) * [Defining custom alias for commands](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#creating-an-alias-for-a-command--alias) - * [Removing custom alias for commands](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/#removing-an-alias-command--unalias) + * [Removing custom alias for commands](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#removing-an-alias-command--unalias) * Code written:
[[Functional Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/main/A0133367E.md)]
[[Testing Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/test/A0133367E.md)]
@@ -33,7 +33,7 @@ We are a team based in the [School of Computing, National University of Singapor ----- -#### [Vishnu Prem](http://github.com/burnflare) +#### [Vishnu Prem @burnflare](http://github.com/burnflare)
**Role: Developer**
* Components in charge of: Logic
@@ -41,8 +41,8 @@ We are a team based in the [School of Computing, National University of Singapor * Features implemented: * [Adding a task (with time)](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#adding-a-task-add) * [Rescheduling a task](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#rescheduling-a-task--schedule) - * [Synchronizing with Google calendar](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#synchronizing-with-google-calendar--sync) - * [Smart command correction] + * [Synchronizing with Google calendar](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#synchronizing-with-google-calendar-sync) + * Smart command correction * Code written:
[[Functional Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/main/A0003878Y.md)]
[[Testing Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/test/A0003878Y.md)]
@@ -52,7 +52,7 @@ We are a team based in the [School of Computing, National University of Singapor ----- -#### [Justin Tay](https://github.com/INCENDE) +#### [Justin Tay @INCENDE](https://github.com/INCENDE)
**Role: Developer**
* Components in charge of: Storage, Commons
@@ -71,16 +71,16 @@ We are a team based in the [School of Computing, National University of Singapor ----- -#### [Fan Weiguang](https://github.com/fanwgwg) +#### [Fan Weiguang @fanwgwg](https://github.com/fanwgwg)
**Role: Developer**
* Components in charge of: UI, Main
* Aspects/tools in charge of: Testing, Eclipse
* Features implemented: - * [Scrolling through previous command history] - * [Tab to autocomplete] + * Scrolling through previous command history + * [Tab to autocomplete](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#keyboard-shortcuts) * [Help command](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#viewing-help--help) - * [Keyboard shortcuts](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#keyboard-shortcuts)) + * [Keyboard shortcuts](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/docs/UserGuide.md#keyboard-shortcuts) * Code written:
[[Functional Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/main/A0148031R.md)]
[[Testing Code](https://github.com/CS2103AUG2016-W11-C2/main/blob/master/collated/test/A0148031R.md)]
diff --git a/src/test/data/ManualTesting/testScript.md b/src/test/data/ManualTesting/testScript.md index 49df812cdcff..41f7908ac175 100644 --- a/src/test/data/ManualTesting/testScript.md +++ b/src/test/data/ManualTesting/testScript.md @@ -8,7 +8,7 @@ 3. Type `load src/test/data/ManualTesting/SampleData.xml`. ####Result: -* In the **Do It Soon** column, there should be 22 tasks appearing with indices from 1 to 22, where task 1-6 are highlighted in red, 7-12 in yellow, and the remaining not highlighted. +* In the **Do It Soon** column, there should be 22 tasks appearing with indices from 1 to 22. Tasks highlighted in red have a start/end time before the current day and time; task highlighted in yellow have a start/end time within the current week and the remaining are not highlighted. * In the **Do It Anytime** column, there should be 16 tasks appearing, with indices from 23 to 38. * In the **Done** column, there should be 12 tasks appearing, with indices 39-50. @@ -27,7 +27,7 @@ ## Date Time Formats -Before proceeding to add or schedule tasks with dates and time, here is a brief on the date time formats that Agendum supports, by combining any of the date format and time format below. The date/time formats are case insensitive too. +Before proceeding to add or schedule tasks with dates and time, please refer to the tables below. They describe the date format and time format Agendum supports. Combine any of the date format and time format below. The date/time formats are case insensitive too. *Date Format* @@ -54,6 +54,9 @@ Before proceeding to add or schedule tasks with dates and time, here is a brief > By default, we use the 24-hour time format but we do support the meridian format as well e.g. 10am, 10pm +Note +> If no year, date or time is specified, the current year, date or time will be used in its place. +> It is advisable to specify both the date and time. ## Add To add a task, you have to start your command with the keyword `add`. @@ -80,11 +83,11 @@ Type `add go for church camp from 20 nov 2pm to 25 nov 5pm` #### Result A new task named `go for church` is created in the **Do It Soon** column, with its deadline under the name of this task . Also, it is highlighted in purple borders. -### 4. Add a task with single quotation mark +### 4. Add a task with name enclosed in single quotation mark Type `add 'drop by store' by tmr` #### Result -A new task named `drop by store` is created in the **Do It Soon** column, with its deadline under the name of this task. ->Sometimes Agendum may wrongly interpret part of task name as a deadline/event time. To avoid this wrong interpretation, you can add single quotation marks around the task name, and agendum will only interpret those inside the quotation marks as task name. +A new task named `drop by store` is created in the **Do It Soon** column, with its deadline (tomorrow's date) under the name of this task. +>Sometimes Agendum may incorrectly interpret part of task name as a deadline/event time. To avoid this misinterpretation, you can add single quotation mark around the task name. Agendum will then intepret what is enclosed within the single quotation mark as the task name and will not attempt to parse it as time. ## Rename @@ -94,9 +97,9 @@ To rename a task, you have to start your command with the keyword `rename`. > * `rename ` - give a new name to the task identified by . The must be a positive number and be in the most recent to-do list displayed. -Type `rename 1 complete peer review on TEAMMATES for 2101`. +Type `rename 1 complete peer review on TEAMMATES for 2101`. Note the task original name as its id change after it has been renamed. #### Result -The task with index 1 is renamed to `complete peer review on TEAMMATES for 2101`. Also, it is highlighted in purple borders. +The original task with id 1 is renamed to `complete peer review on TEAMMATES for 2101`. Also, it is highlighted in purple borders. ## (Re)schedule To reschedule a task, you have to start your command with the keyword `schedule`. @@ -108,31 +111,31 @@ To reschedule a task, you have to start your command with the keyword `schedule` * `schedule from to ` - update the start/end time of the task identified by ``. Note the keyword `from` and `to`. ###1. Schedule a task with no deadline or event time -Type `schedule 22`. +Type `schedule 22`. Note the task name as its id change after it has been rescheduled. Use the task name to identify the task. ####Result -Task with index 22 now has no deadline, and it is shifted to **Do It Anytime** column with a new index. Also, it is highlighted in purple borders. +The original task with id 22 now has no deadline, and it is shifted to **Do It Anytime** column with a new id. Also, it is highlighted in purple borders. ###2. Schedule a task with a deadline -Type `schedule 23 by 11 nov 10pm`. +Type `schedule 23 by 11 nov 10pm`. Note the task name as its id change after it has been rescheduled. ####Result -Task with index 23 now has a deadline, and it is shifted to **Do It Soon** column with a new index. Also, it is highlighted in purple borders. +The original task with id 23 now has a deadline, and it is shifted to **Do It Soon** column with a new id. Also, it is highlighted in purple borders. ###3. Schedule a task with event time -Type `schedule 14 from 13 nov 2pm to 13 nov 4pm`. +Type `schedule 14 from 13 nov 2pm to 13 nov 4pm`. Note the task name as its id change after it has been rescheduled. ####Result -Task with index 14 now has an event time, and it is assigned with a new index. Also, it is highlighted in purple borders. +The original task with id 14 now has an event time, and it is assigned with a new id. Also, it is highlighted in purple borders. ## Delete To delete a task, you have to start your command with the keyword `delete`. >Here is the *format*: ->* `delete ...` - Deletes the task at the specified `INDEX`. Each `` must be a positive number and in the most recent to-do list displayed. If there are multiple ``s, they should be separated by commas, space, or input as a range. +>* `delete ...` - Deletes the task at the specified `id`. Each `` must be a positive number and in the most recent to-do list displayed. If there are multiple ``s, they should be separated by commas or space (e.g. 1,2 or 1 2). You can also input a range (e.g. 3-5) ###1. Delete a single task Type `delete 10`. ####Result -Task with index 10 is deleted. +Task with id 10 is deleted. ###2. Delete multiple tasks Type `delete 11 21-23` @@ -144,42 +147,46 @@ To mark a task as completed, you have to start your command with the keyword `ma >Here is the *format*: ->* `mark ...` - mark all the tasks identified by ``(s) as completed. Each `` must be a positive number and in the most recent to-do list displayed. If there are multiple ``s, they should be separated by commas, space, or input as a range. +>* `mark ...` - mark all the tasks identified by ``(s) as completed. Each `` must be a positive number and in the most recent to-do list displayed. If there are multiple ``s, they should be separated by commas or space (e.g. 1,2 or 1 2). You can also input a range (e.g. 3-5) ###1. Mark a single task -Type `mark 1`. +Type `mark 1`. Note the task name as its id change after it has been marked. ####Result -Task with index 1 is marked as completed, shifting from **Do It Soon** column to **Done** column, and the completion time is shown below the task name. Also, it is highlighted in purple borders. +The original task with id 1 is marked as completed, shifting from **Do It Soon** column to **Done** column, and the completion time is shown below the task name. Also, it is highlighted in purple borders. ###2. Mark multiple tasks -Type `mark 1 3-5`. +Type `mark 1 3-5`. Note the task names as ids change after they have been marked. ####Result -Tasks with indices 1, 3, 4 and 5 are marked as completed, shifting from **Do It Soon** column to **Done** column, and their completion times are shown below their task names. Also, they are all highlighted in purple borders. +Tasks with old indices 1, 3, 4 and 5 are marked as completed, shifting from **Do It Soon** column to **Done** column, and their completion times are shown below their task names. Also, they are all highlighted in purple borders. +(The operation will only be successful if no duplicate task will result) ## Unmark To unmark a task as completed, you have to start your command with the keyword `unmark`. >Here is the *format*: ->* `unmark ...` - unmark all the tasks identified by ``(s) as uncompleted. Each `` must be a positive number and in the most recent to-do list displayed. +>* `unmark ...` - unmark all the tasks identified by ``(s) as uncompleted. Each `` must be a positive number and in the most recent to-do list displayed. If there are multiple ``s, they should be separated by commas or space (e.g. 1,2 or 1 2). You can also input a range (e.g. 3-5) ###1. Unmark a single task -Type `mark 36`. +Type `unmark 36`. Note the task name as its id change after it has been unmarked. ####Result -Task with index 36 is marked as completed, shifting from **Done** column to **Do It Soon** column, and there is no more completion time under the task name. Also, it is highlighted in purple borders. If there are multiple ``s, they should be separated by commas, space, or input as a range. +The original task with id 36 are unmarked, shifting from **Done** column to **Do It Soon** column, and there is no more completion time under the task name. Also, it is highlighted in purple borders. If there are multiple ``s, they should be separated by commas, space, or input as a range. ###2. Unmark multiple tasks -Type `mark 37-40`. +Type `unmark 37-40`. Note the task names as ids change after they have been unmarked. ####Result -Tasks with indices 37, 38, 39 and 40 are unmarked as uncompleted, shifting from **Done** column to **Do It Soon** column, and there are no more completion times under their task names. Also, they are all highlighted in purple borders. +Tasks with old indices 37, 38, 39 and 40 are unmarked, shifting from **Done** column to **Do It Soon** column, and there are no more completion times under their task names. Also, they are all highlighted in purple borders. +(The operation will only be successful if no duplicate task will result) ## Undo +Undo is supposed to reverse the last changes to the task list (e.g. by `add`, `delete`, `rename`, `mark`, `unmark`, `schedule`). Multiple undo are supported. + 1. Type `undo`. 2. Press Ctrl Z ####Result -1. The previously unmarked tasks are marked again, and the affected tasks are highlighted in purple borders. -2. The previously marked task is marked again, and the affected task is highlighted in purple borders. +1. The previously unmarked tasks (_from `unmark 37-40`_) are marked as completed again, and the affected tasks are highlighted in purple borders. +2. The previously unmarked task (_from `unmark 36`_) is marked as completed again, and the affected task is highlighted in purple borders. ## Find >Here is the *format*: @@ -211,20 +218,20 @@ After you are done with searching for tasks, you can use `list` to exit your fin To alias a command, you have to start your command with the keyword `alias`. >Here is the *format*: ->* `alias ` - `` must be a single alphanumeric word, and it cannot be an original-command or already aliased to another command. `` must be a command word that is specified in the Command Summary section +>* `alias ` - `` must be a single alphanumeric word, and it cannot be an original-command or already aliased to another command. `` must be a command word that is specified in the Command Summary section (or in the help window) 1. Type `alias schedule s` 2. Type `s 1 by 10pm` ####Result 1. After the first step, `s` is created as an alias command for `schedule`, and you can now use both `s` and `schedule` to reschedule a task. -2. After the second step, task with index 1 is rescheduled to be by today 10pm. +2. After the second step, task with id 1 is rescheduled to be by today 10pm. ## Unalias To unalias a command, you have to start your command with the keyword `unalias`. >Here is the *format*: ->* `unalias ` - `` must be a single alphanumeric word, and it cannot be a original-command or already aliased to another command. +>* `unalias ` - `` should be an alias you previously defined. 1. Type `unalias s` 2. Type `s 1 by 11pm` @@ -233,7 +240,7 @@ To unalias a command, you have to start your command with the keyword `unalias`. ####Result 1. After the first step, `s` is no longer an alias command for `schedule`. 2. After the second step, the pop-up window will tell you that agendum no longer recognizes the command `s`. -3. After the third step, task with index 1 is rescheduled to be by today 11pm. +3. After the third step, task with id 1 is rescheduled to be by today 11pm. ## Store To change the default data save location, you have to start command with the keyword `store`. @@ -259,7 +266,7 @@ To sync your tasks in agendum into Google calendar, you have to start command wi 2. Type `sync off`. ####Result -1. After the first step, agendum will direct you to the Google Calendar authorization page in your browser. Once authorized with your Google account, there will be a pop-up window telling you that sync has been turned on, and you may close the authorization page and go back to agendum. After the authorization, all the tasks with an event time you added will sync to your Google Calendar, where a separate calendur called `Agendum Calendar` will appear for you to view all tasks from agendum. +1. After the first step, agendum will direct you to the Google Calendar authorization page in your browser. Once authorized with your Google account, there will be a pop-up window telling you that sync has been turned on, and you may now close the authorization page and go back to Agendum. After the authorization, all the tasks with an event time you added will sync to your Google Calendar, where a separate calendar called `Agendum Calendar` will appear for you to view all tasks from agendum. 2. After the second step, sync to Google Calendar will be turned off.