12
Do + Do v0.2 Release User Guide for Windows A new and advanced To-do Manager for planning your everyday activities. John Goh, Micheal Yue, Chervin Yeung, Jesmond Chia, Fan Kaiwei 11/6/2011

Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

Embed Size (px)

Citation preview

Page 1: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

Do + Do v0.2 Release User Guide for Windows A new and advanced To-do Manager for planning your everyday activities. John Goh, Micheal Yue, Chervin Yeung, Jesmond Chia, Fan Kaiwei 11/6/2011

Page 2: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

Contents DO+DO User Guide ..................................................................................................................................... 3

1 Getting Started ........................................................................................................................................ 3

1.1 Installation ........................................................................................................................................ 3

1.2 System Requirements ....................................................................................................................... 3

1.3 Running Do+Do ................................................................................................................................. 3

2 Task Management ................................................................................................................................... 4

2.1 Add a Task ......................................................................................................................................... 4

2.2 Remove Tasks ................................................................................................................................... 5

2.3 Edit Tasks .......................................................................................................................................... 5

2.4 Priority .............................................................................................................................................. 6

2.5 Tagging .............................................................................................................................................. 6

3 Graphic User Interface (GUI) .................................................................................................................... 7

3.1 System Output Display ...................................................................................................................... 7

3.2 Add/Edit a Task ................................................................................................................................. 7

3.3 Remove Task Button ......................................................................................................................... 7

3.4 Done Task Button .............................................................................................................................. 7

3.5 Classifications of Tasks ...................................................................................................................... 7

3.6 Display Tags ...................................................................................................................................... 8

3.7 Show Calendar .................................................................................................................................. 8

3.8 HELP Button ...................................................................................................................................... 8

3.9 Minimizing and Closing the Application ............................................................................................ 8

4 Hot Keys ................................................................................................................................................... 8

4.1 Redisplay the Application (F9)........................................................................................................... 8

4.2 Display Help (F1) ............................................................................................................................... 8

4.3 Display Calendar (F2) ........................................................................................................................ 8

4.4 Review Commands (Up/Down Arrows) ............................................................................................. 8

4.5 Exit Application ................................................................................................................................. 8

5 Operations Manual (CLI) .......................................................................................................................... 9

5.1 Master Syntax ................................................................................................................................... 9

5.2 Master Commands ............................................................................................................................ 9

5.2A Master Commands (Operational) ............................................................................................... 9

Page 3: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

5.2B Master Commands (View)........................................................................................................... 9

5.2C Master Commands (Detailed Commands) .................................................................................. 9

5.2D Master Commands (Others) ....................................................................................................... 9

5.3 Command Parameters ...................................................................................................................... 9

5.3A Add task command parameters: ............................................................................................... 10

5.3B Edit task command syntax: ....................................................................................................... 10

5.3C Delete task command syntax: ................................................................................................... 10

5.3D Generic view command syntax: ................................................................................................ 10

5.3E View by tab command syntax: .................................................................................................. 10

5.3F View by date command syntax: ................................................................................................ 10

5.3G View by tag command syntax: .................................................................................................. 11

5.3H Add task to tag command syntax:............................................................................................. 11

5.3I Remove task from tag command syntax: ................................................................................... 11

5.3J Edit tag command syntax: .......................................................................................................... 11

5.3K Delete tag command syntax:..................................................................................................... 11

5.3L Sort command syntax:-.............................................................................................................. 11

Page 4: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

DO+DO User Guide This guide will lead you through the process of downloading and using of DO+DO Task Manager. This

guide was written to be as clear aspossible and to provide only the details necessary to get you up and

running with DO+DO. For more in-depth information, please refer to the Comprehensive Guide

(Attached) or the Developer Guide (http://www.dropbox.com/231413231/DO+DO Developer Guide.pdf)

or email us at [email protected]

1 Getting Started

1.1 Installation No installation is required for our software. However, JIntellitype.dll is required to run the program

1.2 System Requirements The following table shows the recommended basic system requirements for the program.

System Minimum Requirements

Operating System Windows XP

Physical Memory 20MB free space

Processor Intel™ Core Duo or equivalent

Ram 128MB

Java Runtime Environment

JRE 1.6 or above

Additional Files JIntellitype.dll

1.3 Running Do+Do To begin, double click DO+DO.jar. DO+DO Task Manager

Fig 1.3 Running Do+Do.jar

Once the application is launched, the application retrieves user’s tasks from storage location and

displays it as a grid in the application. Our application also includes a calendar for viewing.

Page 5: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

2 Task Management

2.1 Add a Task To add a new task, simply type “/add<task>”into the input box.The syntax and examples are shown in

the Output box below. For example:

1) /add prepare for speech on 31 Nov 2011

2) /add meet Alan for dinner

Fig 2.1 Add Tasks

Page 6: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

2.2 Remove Tasks If you wish to remove an existing task, type “/remove <ID>” into the input box or select the task and

click remove. For example:

1) /remove 2 This removes the task of ID 2

Fig 2.2 Remove Tasks

2.3 Edit Tasks Tasks may be easily marked as done or pending by selecting the task and clicking the “completed”

button (Fig 2.3) or by typing out the command /done <ID> and /pending <ID>. For example /done 4 and

/pending 4

Page 7: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

Fig 2.3Completion Tasks

To edit details of the tasks, users may type /edit <ID><parameters><value>. Accepted parameters are

Name, Date and Priority. For example:

1) /edit 3 name Meeting with ex-boss

2) /edit 6 priority high

2.4 Priority Users may wish to add priorities to their tasks. This can be done with /add <task><-priority> or /edit

<ID><param><value>. For example:

1) /add Meet John –high

2) /edit 3 priority low

2.5 Tagging Users may wish to tag their tasks with hash tags such as #family and #work. This can be done when

adding the task, for example:

Page 8: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

1) /add Dinner with Chris #dinner #food

2) /add Project After Action Review #work #office

Alternatively, this can be done by typing the /AddTo<ID><#tag> and /RemoveFrom<ID><#tag>. For

example:

1) /addto 4 #family

2) /removefrom 7 #home

Users may also wish to manage their tags by renaming them with /edittag<old name><new name> or

removing them with /removetag<tag>. For example:

1) /edittag#dinner #food

2) /removetag #home

3 Graphic User Interface (GUI)

3.1 System Output Display All system output (i.e. success/failure of adding a task) will be displayed in the text box area under

“Output”. This section displays all information regarding system operations running at the background.

It also shows recommendations for the standard commands that users can key in.

3.2 Add/Edit a Task When you wish to add a new task, simply type in the different fields of the task into the “Input” text box

area. If you wish to edit an existing task, click on the task in the task display and type the fields into the

input text area.

You may also choose to view from the list of categories by clicking on the different tabs displayed above

the input text box area. When a certain task is completed, you may click on “Completed” to move the

task into the “Completed” category.

3.3 Remove Task Button When you wish to remove any tasks from the list of tasks, simply do so by selecting the task is the list of

tasks and click “Remove”.

3.4 Done Task Button When you wish to mark as completed any tasks from the list of tasks, simply do so by selecting the task

is the list of tasks and click “Remove”.

3.5 Classifications of Tasks Tasks are also sorted according to 3 different classifications, namely, “Overdue”, “Important” and “All”

tasks. Users may choose to view their tasks through a different sorted manner. By default, task display

Page 9: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

shows the ALL the tasks the user have. Users may also view Completed or Uncompleted tasks by the

browsing tabs.

3.6 Display Tags From the tagging drop-down box, you can select the tagged tasks that you wish to view. For example, if

you select “#tutorials”, the display shows only the tasks that are tagged in “#tutorial”.

3.7 Show Calendar You can choose to view the calendar by clicking on the “Show Calendar” check-box. You can also search

for tasks that you have on a particular day by clicking on the dates in the calendar.

3.8 HELP Button In the event that users forgot their command inputs, users can always choose to click on the “Help”

button to review on commands they can use within the application.

3.9 Minimizing and Closing the Application When the user clicks on the “X” button on the top right hand corner of the application, the application

does not exit but minimizes itself to the system tray. In order to correctly exit the application, user must

type in /exit in the CLI or right click on the application and click close.

4 Hot Keys Users can also use hot keys on the keyboard to enable certain functions. This acts as a shortcut key that

helps users to reduce the number of actions to perform some typical operations

4.1 Redisplay the Application (F9) Users can click F9 to redisplay the application when it is minimized to the system tray.

4.2 Display Help (F1) Like most applications, the user can press F1 to display the help page.

4.3 Display Calendar (F2) The user may choose to press F2 to display the calendar

4.4 Review Commands (Up/Down Arrows) When selecting the input box, Users can press the up and down arrows to maneuver between previous

commands in the command line.

4.5 Exit Application User can choose to exit the application by right-clicking on the application and click close. The user may

also choose to type /exit in the CLI to exit the system entirely.

Page 10: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

5 Operations Manual (CLI)

5.1 Master Syntax Users may choose to input their tasks into the system through the Graphic User Interface(GUI) or the

Command Line Interface (CLI). All inputs typed into the CLI must follow certain syntax given to the users.

Master syntax format:

/[command] [parameter]...(all commands and parameters are not case-sensitive)

5.2 Master Commands

5.2A Master Commands (Operational)

List of all master commands:

Add task: /add, /addtask, /+

Edit task: /edit, /modify, /change

Delete task: /delete, /remove, /del, /-

5.2B Master Commands (View)

Generic view commands: /view, /display, /show

View by tab commands: /viewtab, /displaytab, /showtab

View by date commands: /viewdate, /displaydate, /showdate

View by tag commands: /viewtag, /displaytag, /showtag

5.2C Master Commands (Detailed Commands)

Add task to tag: /addto

Remove task from tag: /deletefrom, /delfrom

Edit tag: /edittag, /modifytag, /changetag

Delete tag: /deletetag, /removetag, /deltag, /-tag

Sort: /sort

5.2D Master Commands (Others)

Help: /help, /how

Exit: /exit, /quit

5.3 Command Parameters All parameters are separated by their own unique delimiters. However, the order of the parameters is

not crucial. The following is a list of examples provided for the user.

Page 11: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

5.3A Add task command parameters:

(e.g. /add task name #tag -low on 12 Dec 2012 and /add task name on 12 Dec 2012 #tag -low are

identical commands)

Name: no delimeter, but must be placed as the first input variable.

Tags: delimited by '#' (# and parameter are not separated by a space)

Priority: delimited by '-', inputs = {-low, -normal, -high, -p1, -p2, -p3}

Date: delimited by 'on', acceptable date formats = {ddMMyyyy, ddMMyy, dd MMM yyyy, dd MMM yy}

Deadline (only for autoscheduling): delimted by 'by', acceptable date formats same as above\

5.3B Edit task command syntax:

/edit <ID><param><value>

ID: Unique ID value of task

Param: name, date, priority, completion

Value: New value to be assigned

5.3C Delete task command syntax:

/del<ID>

ID: Unique ID value of the task to be deleted

5.3D Generic view command syntax:

/view <view by><value>

View by: date, tag, tab

Value: Corresponding value of the type to be viewed by

5.3E View by tab command syntax:

/viewtab<tab>

Tab: Tab to filter view by

5.3F View by date command syntax:

/viewdate<date>

Page 12: Do v0.2 Release - NUS Computingcs2103/AY1112S1projects/[T14J6][V0.2]User... · 3 Graphic User Interface ... For more in-depth information, ... simply type “/add”into

Date: Date to filter view by

5.3G View by tag command syntax:

/viewtag<tag>

Tag: Tag to filter view by ('#' symbol is optional)

5.3H Add task to tag command syntax:

/addto<task ID><tag name>

Task ID: Unique ID value of task

Tag name: Name of tag in which task is to be added to ('#' is optional)

5.3I Remove task from tag command syntax:

/delfrom<task ID><tag name>

Task ID: Unique ID value of task

Tag name: Name of tag in which task is to be deleted from ('#' is optional)

5.3J Edit tag command syntax:

/edittag<name><new name>

Name: Name of the tag to be renamed ('#' symbol is optional)

New name: New name of the tag ('#' symbol is optional)

5.3K Delete tag command syntax:

/deltag<name>

Name: Name of tag to be deleted ('#' symbol is optional)

5.3L Sort command syntax:-

/sort <param>

Param: ID, name, date, priority