- Ensure that you put
SampleData.xml
inside the/src/test/data/ManualTesting
folder. - Start
Agendum.jar
by double clicking it. - 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. 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.
- Type
help
- Press ESC
- Press Ctrl H
- Press Ctrl H
####Result:
- A help window appears in a table style, listing out all the command available, together with the command description and format.
- Agendum exits the help window.
- The help window will appear.
- Agendum exits the help window.
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
Date Format | Example(s) |
---|---|
Month/day | 1/23 |
Day Month | 1 Oct |
Month Day | Oct 1 |
Day of the week | Wed, Wednesday |
Relative date | today, tmr, next wed |
If no year is specified, it is always assumed to be the current year. It is possible to specify the year before or after the month-day pair in the first 3 formats (e.g. 1/23/2016 or 2016 1 Oct) The day of the week refers to the following week. For example, today is Sunday (30 Oct). Agendum will interpret Wednesday and Sunday as 2 Nov and 6 Nov respectively (a week from now).
Time Format
Time Format | Example(s) |
---|---|
Hour | 10, 22 |
Hour:Minute | 10:30 |
Hour.Minute | 10.30 |
Relative time | this morning, this afternoon, tonight |
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.
To add a task, you have to start your command with the keyword add
.
Here are the acceptable format(s):
add <name>
- adds a task which can be done anytime.
add <name> by <deadline>
- adds a task which have to be done by the specified deadline. Note the keywordby
.add <name> from <start time> to <end time>
- adds a event which will take place between start time and end time. Note the keywordfrom
andto
.
Type add watch movie
.
A new floating task named watch movie
is created at the top of Do It Anytime column, and highlighted in purple borders.
Type add submit essay by 10pm
.
A new task named submit essay
is created in the Do It Soon column, with its deadline under the name of this task. Also, it is highlighted in purple borders.
Type add go for church camp from 20 nov 2pm to 25 nov 5pm
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.
Type add 'drop by store' by tmr
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.
To rename a task, you have to start your command with the keyword rename
.
Here is the acceptable format
rename <id> <new name>
- 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
. Note the task original name as its id change after it has been renamed.
The original task with id 1 is renamed to complete peer review on TEAMMATES for 2101
. Also, it is highlighted in purple borders.
To reschedule a task, you have to start your command with the keyword schedule
.
Here are the acceptable format(s):
schedule <id>
- re-schedule the task identified by<id>
. It can now be done anytime. It is no longer bounded by a deadline or event time!
schedule <id> by <deadline>
- set or update the deadline for the task identified. Note the keywordby
.schedule <id> from <start time> to <end time>
- update the start/end time of the task identified by<id>
. Note the keywordfrom
andto
.
###1. Schedule a task with no deadline or event time
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
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
. Note the task name as its id change after it has been rescheduled.
####Result
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
. Note the task name as its id change after it has been rescheduled.
####Result
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.
To delete a task, you have to start your command with the keyword delete
.
Here is the format:
delete <id>...
- Deletes the task at the specifiedid
. Each<id>
must be a positive number and in the most recent to-do list displayed. If there are multiple<id>
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 id 10 is deleted.
###2. Delete multiple tasks
Type delete 11 21-23
####Result
Tasks with indices 11, 21, 22 and 23 are deleted.
To mark a task as completed, you have to start your command with the keyword mark
.
Here is the format:
mark <id>...
- mark all the tasks identified by<id>
(s) as completed. Each<id>
must be a positive number and in the most recent to-do list displayed. If there are multiple<id>
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
. Note the task name as its id change after it has been marked.
####Result
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
. Note the task names as ids change after they have been marked.
####Result
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)
To unmark a task as completed, you have to start your command with the keyword unmark
.
Here is the format:
unmark <id>...
- unmark all the tasks identified by<id>
(s) as uncompleted. Each<id>
must be a positive number and in the most recent to-do list displayed. If there are multiple<id>
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 unmark 36
. Note the task name as its id change after it has been unmarked.
####Result
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 <id>
s, they should be separated by commas, space, or input as a range.
###2. Unmark multiple tasks
Type unmark 37-40
. Note the task names as ids change after they have been unmarked.
####Result
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 is supposed to reverse the last changes to the task list (e.g. by add
, delete
, rename
, mark
, unmark
, schedule
). Multiple undo are supported.
- Type
undo
. - Press Ctrl Z
####Result
- The previously unmarked tasks (from
unmark 37-40
) are marked as completed again, and the affected tasks are highlighted in purple borders. - The previously unmarked task (from
unmark 36
) is marked as completed again, and the affected task is highlighted in purple borders.
Here is the format:
find <keyword>...
- filter out all tasks containing any of the keyword(s) given. The keywords should be in full word(s), and they are case insensitive.
- Type
find cs2103
- Type
find buy visit
- Press ESC
####Result
- After the first step, tasks containing
cs2103
in their names will be listed out. - After the second step, tasks containing
buy
orvisit
in their names will be listed out. - After the third step, agendum will exit the find results and go back to list all the tasks.
After you are done with searching for tasks, you can use list
to exit your find results and see a list of tasks. Alternatively, you can press ESC to go exit.
- Type
list
- Type
find cs2103
- Press ESC
####Result
- After the first step, agendum will exit the find results and go back to list all the tasks.
- After the second step, agendum will list out tasks containing
cs2103
in their names. - After the third step, agendum will exit the find results and go back to list all the tasks.
To alias a command, you have to start your command with the keyword alias
.
Here is the format:
alias <original command> <your command>
-<your command>
must be a single alphanumeric word, and it cannot be an original-command or already aliased to another command.<original command>
must be a command word that is specified in the Command Summary section (or in the help window)
- Type
alias schedule s
- Type
s 1 by 10pm
####Result
- After the first step,
s
is created as an alias command forschedule
, and you can now use boths
andschedule
to reschedule a task. - After the second step, task with id 1 is rescheduled to be by today 10pm.
To unalias a command, you have to start your command with the keyword unalias
.
Here is the format:
unalias <your command>
-<your command>
should be an alias you previously defined.
- Type
unalias s
- Type
s 1 by 11pm
- Type
schedule 1 by 11pm
####Result
- After the first step,
s
is no longer an alias command forschedule
. - After the second step, the pop-up window will tell you that agendum no longer recognizes the command
s
. - After the third step, task with id 1 is rescheduled to be by today 11pm.
To change the default data save location, you have to start command with the keyword store
.
Here is the format:
store <location>
-<location>
must be a valid path to a file on the local computer. If the folders specified in the new file path does not exist, they will be created. Note that the save file in the old save location remains.
Type > store src/test/data/ManualTesting/Test/newData.xml
####Result The storage file is stored in the specified path.
To sync your tasks in agendum into Google calendar, you have to start command with the keyword sync
.
Here is the format:
sync on
to turn syncing onsync off
to turn syncing off
- Type
sync on
. - Type
sync off
.
####Result
- 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. - After the second step, sync to Google Calendar will be turned off.