Skip to content

cs2103jan2016-f14-4j/main

Repository files navigation

#Taskey Quick Start Guide

Pre-requisites:

  • Java SE Runtime Environment 8u74 (can be downloaded from Oracle.com)

PS: Take note of stuff in bold as they are important keywords.

###Shortcuts

  • F1: Help Menu
  • F2: Dark Theme
  • F3: Light Theme
  • Ctrl+W : Minimise/Re-Open Taskey
  • Tab: Scroll through the tabs
  • Page Up: Scroll up the task list
  • Page Down: Scroll down the task list
  • Left Arrow Key: view previous page
  • Right Arrow Key: view next page
  • Up/Down Arrow Keys: get previous commands

###Reserved Characters

The following characters are reserved for special usage and should not be used in task names:

  • ! : Used for specifying task priorities (low:!, medium: !!, high: !!!)
  • # : Used for specifying hashtags for a task

###Accepted date/time formats

  • Time should have am/pm included (eg. 'meeting at 3pm', not 'meeting at 3')
  • Dates should be keyed as DD MMM YYYY or DD MMM.
  • Special allowable dates: morning, night, tomorrow, today, next xyz (eg. next wed), this xyz (eg. this fri)
  • morning/night deadlines are 8am/8pm respectively (eg. 'do homework by tonight' will be processed as 'do homework by 8pm today')

###Adding a task

Format:

  • Floating: add <taskname>
  • Deadline: add <taskname> on/by <date/time>
  • Event: add <taskname> from <date/time> to <date/time>
  • Adding hashtags/ priorities: [any of the above 3] + "#hashtags !!!" (adding of priorities must come after adding of hashtags)

Examples:

  • add learn cooking
  • add learn cooking #leisure
  • add do homework by tomorrow !!!
  • add meet friends on 20 feb 2016
  • add project meeting from 4pm to 5pm on 19 feb
  • add project meeting from 19 feb 3pm to 4pm

###Deleting a task A task can be deleted by its index number as shown in the UI.

Format: del <id>

Examples:

  • del 1

###Editing a task A task's name, priority or its date details can be changed when required.

Format: set <old id> "new taskname"/[new date]
set <old id> <new priority>

Examples:

  • set 1 [none]
  • set 1 [19 feb]
  • set 1 [19 feb 3pm, 19 feb 4pm]
  • set 1 "learn golf" [19 feb 5pm,19 feb 6pm]
  • set 1 !!!

###Archiving a task When you are done with a task, you can archive it.

Format: done <id>

Examples:

  • done 1

###Searching for a task You can search for tasks via the command "search". To increase the chances of finding the task(s) that you are looking for, try to include at least 3 characters in your search and be as specific as possible.

Format: search <keyword(s)>

Example:

  • search meetings
  • search bio quiz

###Undoing an Action You can undo the last action by typing "undo".

###Tagging your Tasks You can add tags to your tasks, so that you can view them by tags. Typing the command view, followed by the tag-name allows you to view all tasks with that tag in one window.

Examples:

  • add learn cooking #forfun
  • add play pokemon #forfun
  • view forfun

###Viewing selected tasks You can choose to view only certain types of task with the "view" command

Format: view <category> or view #tag1 #tag2 #tag3 ...
[You can only view one basic category at a time, but you can view multiple user-defined categories at one go]

Examples:

  • view deadlines
  • view #work #leisure

###Saving You can save any changes to your task list by typing the command save

###Clearing all tasks You can clear all your tasks by typing the command clear. To save this change, type save.