User Guide
Duke (Also known as Dwayne The Rock Johnson) is your friendly productivity assistant chatbot. Simply type into the message box and send your inputs and Duke’s got your back!
- Quick Start
- Features
- Adding a todo:
todo
- Adding a deadline:
deadline
- Adding an event:
event
- Marking task as done:
done
- Listing all tasks:
list
- Deleting a task:
delete
- Finding a task:
find
- Exiting the program:
bye
- Adding a todo:
- Command Summary
Quick Start
-
Ensure you have Java
11
or above installed in your Computer. -
Download the latest duke.jar from here
-
Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Take note this image reflects the state of the GUI after adding some sample commands so yours may look empty initially.
-
Type the command in the message box and press Enter to execute it. e.g. typing list and pressing Enter will give you a list of tasks. Some example commands you can try:
list
: Lists all current tasks in order of datesdeadline
Do homework /by 2020-08-08
: Adds an unfinished deadline titledDo homework
with the corresponding dateby: Aug 08 2020
todo
Read book
: Adds an unfinished todo titledRead book
with no corresponding datedelete
2
: Deletes the second task on the task list and lists remaining tasksdone
1
: Marks first task on the task list as donefind
homework
: Finds tasks containing the keywordshomework
Features
:information_source: Notes about the command format:
-
Fields after deadline/event descriptions should be followed by a
/
and a preposition such asby
orat
with no whitespace in between. The subsequent field takes in a date in theYYYY-MM-DD
format with a whitespace before the field. Any other date format is not able to be accepted.
e.g.deadline Homework /by 2020-08-08
creates a deadline for homework at2020-08-28
, but using2020-28-08
will not be accepted. -
The commands
done
anddelete
need to be followed by awhitespace
and aninteger
greater than 0 and less than or equals to the size of the task list.
e.gdone 1
will mark the first task as done,delete 1
will mark the first task as deleted from the list butdone 0
ordelete
will both neither be accepted inputs. -
The task-identifying commands
todo
,deadline
andevent
must have text input after these fields.
e.g.todo Read a book
is an accepted input, buttodo
is not -
The input and commands are case sensitive.
e.g.todo Read a book
is an accepted input, butTodo read a book
is not
Adding a todo: todo
Adds a todo task to the task list.
Format: todo TASK_DESCRIPTION
Examples:
todo Exercise and get some abs
Adding a deadline: deadline
Adds a deadline to the task list.
Format: deadline TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD
Examples:
deadline Exercise and get some abs /by 2020-08-28
deadline Do homework /due 2017-09-22
Adding an event: event
Adds an event to the task list.
Format: event TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD
Examples:
event Science conference /on 2019-06-11
event Roy's party /at 2018-09-14
Listing all tasks : list
Shows a list of all persons in the task list, sorted by todos at the top and by dates of deadlines/events in chronological order (from soonest to latest).
Each list element has a marker [T]
, [E]
or [D]
to indicate whether the task is of type todo
, event
or deadline
respectively.
Each list element will show a tick symbol [✔]
if the task is marked done, or a cross [x]
if undone.
Format: list
Locating task by keywords: find
Finds tasks whose descriptions contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS]
- The search is case-sensitive. e.g
book
will not match task descriptionread Book
- The order of the keywords matter. e.g.
read book
will matchbook read
- Only the task description is searched, and
find
returns all types of taskstodo
,deadline
,event
. - Partial words will be matched e.g.
boo
will match task descriptionread books
Examples:
find books
will match the task descriptionsRead book
andReturn books
(if both tasks exist)
Deleting a person : delete
Deletes the specified task from the task list.
Format: delete INDEX
- Deletes the task at the specified
INDEX
, and reprints the new list. - The index refers to the index number shown in the displayed task list.
- The index must be a positive integer 1, 2, 3, … and be less than or equals to the size of the list.
Examples:
delete 2
deletes the 2nd task in the task list.
Marking a task as done : done
Marks a task as done and changes done symbol ([✔] or [x]) of the specified task on the task list.
Format: done INDEX
- Marks the task at the specified
INDEX
as done. - The index refers to the index number shown in the displayed task list.
- The index must be a positive integer 1, 2, 3, … and be less than or equals to the size of the list.
Examples:
done 2
marks the 2nd task in the task list as done.
Exiting the program : bye
Exits the program.
Format: bye
Action | Format, Examples |
---|---|
todo | todo TASK_DESCRIPTION e.g., todo Read book |
event | event TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD e.g., event Science conference /at 2020-08-08 |
deadline | deadline TASK_DESCRIPTION /PREPOSITION YYYY-MM-DD e.g., deadline Return books /by 2020-05-07 |
list | list |
delete | delete INDEX e.g., delete 3 |
done | edit INDEX e.g., done 2 |
find | find KEYWORD [MORE_KEYWORDS] e.g., find Return books |
bye | bye |