Skip to content

Latest commit

 

History

History
315 lines (235 loc) · 9.93 KB

UserGuide.md

File metadata and controls

315 lines (235 loc) · 9.93 KB
Raw

User Guide

Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest happyjimtaskmanager.jar from the releases tab.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

  5. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  6. Some example commands you can try:

    • list : Lists all active tasks
    • add Homework by 24 sep 6pm: adds a task named Homework to the Task Master
    • delete 212 : deletes the task with ID 212 shown in the current list
    • exit : exits the app

  7. Refer to the Features section below for details of each command.

HappyJimTaskMaster's GUI

  1. Command box. This is where the commands are entered. Simply type in the command and press enter to execute it.
  2. Result display. This is where the results of commands are shown.
  3. Agenda. This where the agenda of this week is shown.
  4. Tasklist panel. This is where the tasks are displayed.
  5. Navigation bar panel. This is where the navigation categories are displayed.

Color Scheme

  1. Yellow for floating tasks.
  2. Blue for normal non-floating tasks.
  3. Brown for blocked time slots.
  4. Red for deadlines.
  5. Green for completed tasks.

Change of color scheme can done through click Customize Skin using pre-load alternatives, or thorugh modifying ColorTheme.css in src/main/resources/view folder.

Features

Command Format

  • Each command consists of a command word (such as add or delete), followed by other options such as DATE,TIME or [t/TAG]
  • Words in UPPER_CASE are the description of what kind data to input.
  • Items in SQUARE_BRACKETS [items] are optional.
  • Items with ... after them can have multiple instances.
  • The order of parameters is fixed.

Date and Time Format

HappyJimTaskMaster uses Natty date parser to parse date and time options.

Some examples of acceptable format include:

  • 21 nov 2005
  • 24 sep 8pm
  • jan 1st
  • next thursday
  • 3 days from now

For a full list of acceptable formats, please refer to http://natty.joestelmach.com/doc.jsp

Viewing help : help

Format: help

Help is also shown if you enter an incorrect command e.g. abcd

Example:

  • help

Adding a floating task : add

Adds a task to the todo list
Format:add TASK_NAME [t/TAG]...

Examples:

  • add Homework
  • add Homework t/CS1231

Adding a task with deadline : add

Format: add TASK_NAME by DATE TIME [RECURRING_TYPE] [repeat REPEAT_PERIOD] [t/TAG]...

RECURRING_TYPE consists of daily, weekly, monthly and yearly case insensitive. Tasks can have only 1 RECURRING_TYPE. If multiple RECURRING_TYPE are used, only the first instance will be accepted. REPEAT_PERIOD is the number of recurring task to be tracked If REPEAT_PERIOD is not entered as a number [repeat REPEAT_PERIOD] will be ignored

Examples:

  • add Homework by 24 sep 8pm t/CS1231
  • add Homework by 24 sep 6pm daily t/CS1231
  • add Homework by 24 sep 7.15pm daily repeat 4 t/CS1231

Adding a task with start time and end time : add

Format: add TASK_NAME from DATE TIME to DATE TIME [RECURRING_TYPE] [repeat REPEAT_PERIOD] [t/TAG]...

RECURRING_TYPE consists of daily, weekly, monthly and yearly case insensitive. Tasks can have only 1 RECURRING_TYPE. If multiple RECURRING_TYPE are used, only the first instance will be accepted. REPEAT_PERIOD is the number of recurring task to be tracked If REPEAT_PERIOD is not entered as a number [repeat REPEAT_PERIOD] will be ignored

Examples:

  • add Homework from 24 sep 8pm to 25 sep 9pm tag/CS1231
  • add Homework from 24 sep 7.15pm to 25 sep 9pm daily repeat 4 t/CS1231
  • add Homework from today 8.03pm to 8.15pm t/CS1231
  • add Homework from 26 oct 10am to 11am daily repeat 3

Select tasks : select

Format: select TASK_ID

If TASK_ID is more than or less than the task present in the task list it is invalid.

Examples:

  • select 1

Lists all active tasks : list

Format: list

Examples:

  • list

Edit tasks : edit

Format: edit TASK_ID [NEW_TASK_NAME] [from DATE_TIME to DATE_TIME | by DATE_TIME [daily | weekly | monthly | yearly] ] [tag/EDIT_TAG]...

Every field in edit is optional. After you specify the task that you are going to edit, you are able to change its name, date time and tag. For editing date time of a task, you have the following restrictions:

  1. You cannot change a non-floating task to a floating task.
  2. You cannot directly change recurring type of a task (need to specify time first).

Examples:

  • edit 1 cs2103 webcast
  • edit 1 t/study
  • edit 1 from today 4pm to today 5pm
  • edit 2 by today 7pm
  • edit 1 from today 4pm to today 5pm daily

Delete tasks : delete

Format: delete TASK_ID

Examples:

  • delete 2

Archive completed tasks : done

Format: done TASK_ID

Examples:

  • done 5

    >Completed tasks can be viewed from navigation bar on the side.

Block out timeslot : block

Format: block from [START_DATE] START_TIME to [START_DATE] START_TIME [t/TAG]

Examples:

  • block from tomorrow 3pm to tomorrow 5pm t/meeting

Undo tasks : undo

Format: u

Maximum 3 undo

Examples:

  • u

Redo tasks : redo

Format: r

Maximum 3 redo

Examples:

  • r

View agenda of a day : view

Format: view DATE [TIME]

Examples:

  • view next monday

Find tasks : find

Format: find [KEY_WORD] [from DATE_TIME to DATE_TIME | by DATE_TIME] [t/TAG]...

For find command, all parameters optional. You are able to search by key words of a particular task, or search by a particular time period, search by deadline, or search by particular tags. (You can have more than one tags to search)

Examples:

  • find cs2103

  • find from today 5am to today 6am

  • find by today 10am

  • find cs2103 tag/lolo

Clear the task master : clear

Format: clear

clears all the tasks

Examples:

  • clear

Change directory : cd

Format: cd FILE_PATH

Examples:

  • cd data\newlist.xml

Exiting the program : exit

Exits the program.
Format: exit

FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.

Q: How do i get started using the task manager?
A: Type 'help' or any incorrect command will bring you to the help screen.

Command Summary

Command Format
Add add TASK_NAME [t/TAG]...
Add add TASK_NAME by DATE TIME [RECURRING_TYPE] [repeat REPEAT_PERIOD] [t/TAG]...
Add add TASK_NAME from DATE TIME to DATE TIME [RECURRING_TYPE] [repeat REPEAT_PERIOD] [t/TAG]...
Select select TASK_ID
Edit edit TASK_ID [from EDIT_START_DATE EDIT_START_TIME to EDIT_END_DATE EDIT_END_TIME] [by EDIT_END_DATE EDIT_END_TIME] [t/EDIT_TAG]...
Delete delete TASK_ID
Complete done TASK_ID
Block block TASK_NAME from [START_DATE] START_TIME to [START_DATE] START_TIME [t/TAG]...
Redo r
Undo u
Find `find [KEY_WORD] [from DATE_TIME to DATE_TIME
View view DATE [TIME]
Clear clear
Change directory cd FILE_PATH
Exit exit