Skip to content

Latest commit

 

History

History
278 lines (181 loc) · 6.51 KB

UserGuide.md

File metadata and controls

278 lines (181 loc) · 6.51 KB
Raw

User Guide

Quick start

  1. Ensure that you have the latest Java version ‘1.8.0_60’ or later installed in your Computer.

    Having any Java 8 version is not enough
    The application will not work for any earlier Java versions

  2. Find the project in the Project Explorer or Package Explorer (usually located at the left side)

  3. Right click on the project

  4. Click Run As > Java Application and choose the Main class. The GUI should appear within split second.

  5. Type the command into the command box and press Enter to execute the command.
    List of commands:
    help : opens instruction
    add : adds a task
    show : shows all tasks
    find : searches for a task
    edit : edits a task
    delete : deletes a task
    complete : marks a task as completed
    pin : pin tasks
    unpin : removes tasks from the pinned list
    undo : reverts the task list back to the previous state
    clear : deletes every task on the list

  6. Refer to the Commands section below for details of each command.

Features

Commands

Viewing help : help

Format:

help

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

Adding a task : add

Adds a task to the planner

Format:

1. add [TASKNAME] s/[START](optional) e/[END](optional) c/[CATEGORY]...(optional)

Examples:

  1. add travel

Task with no specified timing is added to today's schedule

  1. add meeting s/tomorrow 2pm e/4pm

Fixed task is added from 2pm to 4pm the next day

  1. add math homework e/7 nov 6pm

Task with a deadline is added

Viewing a schedule : show

Shows tasks based on query(date or completion)

Format:

show [DATE]/[COMPLETION](optional)

Examples:
show

Shows all tasks

show today

Shows schedule for today

show complete

Shows completed tasks

show not complete

Shows uncompleted tasks

show next wednesday

Shows schedule for next wednesday


The show function will sort the users's schedule and display it.

Tasks are sorted by their urgency(how close it is to its deadline).

The user can then use this recommended schedule to follow the order of the tasks and worryless-ly go about their day.

Searching for a task: find

Searches for a particular task and displays more information about it.

Format:

find TASKNAME

Examples:

find cs lecture
  • The search is case insensitive.
  • The order of the keywords does not matter. e.g. math assignment will match assignment math
  • Only the name is searched.
  • Task matching at least one keyword will be returned (i.e. OR search). e.g. math will match math lecture

Editing a task: edit

Edits a particular task's details
Format:

edit [INDEX] [NEWTASKNAME](optional) [NEWSTART](optional) [NEWEND](optional) [NEWCATEGORY](optional)

Examples:
edit 2 tomorrow
s/wednesday 4pm e/6pm (only changes date and time)

Deleting a task : delete

Description: Deletes a task from the planner.

Format: delete [INDEX]

Deletes the task at the specified INDEX. The index refers to the index number shown on the list that is currently being viewed
The index must be a positive integer 1, 2, 3, ...

Examples:
delete 5

Deletes task 5 of current list being viewed

Completing a task : complete

Description: Marks a task as completed from the planner.

Format: complete [INDEX]

Marks the task at the specified INDEX as completed. The index refers to the index number shown on the list that is currently being viewed
The index must be a positive integer 1, 2, 3, ...

Examples:
complete 5

Task 5 of current list being viewed is marked as completed

Pin important task on the pinned task list: pin

Description: Pins task on the list on the left.

Format: pin [INDEX]

Pins the task at the specified INDEX. The index refers to the index number shown on the list that is currently being viewed
The index must be a positive integer 1, 2, 3, ...

Examples:
pin 5

Task 5 of current list is being pinned on the pinned list

Remove important task on the pinned task list: unpin

Description: Unpins task on the list from the pinned tasks list.

Format: unpin INDEX

Unpins the task at the specified INDEX. The index refers to the index number shown on the pinned tasks list(left)
The index must be a positive integer 1, 2, 3, ...

Examples:
unpin 5

Task 5 of pinned list is being removed and put back to the schedule list

Undo last command: undo

Description: Undo the latest command.

Format: undo

Undo the last command. If the last command was add, the task added will be removed if undo is invoked

Examples:
undo

Undo previous command

Delete every task: clear

Description: Clears all tasks.

Format: clear

Clears all task from the list

Examples:
clear

The list is now empty

Exiting the program : exit

Exits the program.
Format: exit

Saving the data

Daily Planner data is saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.


Descriptions and Usage

Tasks

The daily planner stores all of the users events as a Task.

A Task can be viewed, added, searched, edited or deleted with the right command word as can be found in Commands.

Every Task must consist of a mandatory TASKNAME field and optional START, END, CATEGORY fields.

START and END Field

The START and END field, if specified, tells the Daily Planner when a task should start and end.
Both START and END fields consist of either a DATE field, a TIME field or both DATE TIME fields, separated by a whitespace.
This allows for natural descriptors of starting and ending times.
The TIME field must be given in 12hr am or pm format.
The following are all valid START and END fields:


11/11/2016 5pm
The 31st of April in the year 2008
Fri, 21 Nov 1997
Jan 21, '97
Sun, Nov 21 5am
jan 1st 9pm
february twenty-eighth
next thursday
last wednesday
today
tomorrow 6pm
yesterday 3pm
next week
next month
next year
3 days from now
three weeks ago