ip

User Guide

Introduction

Task Manager is a Command Line Interface(CLI) task manager application that helps you to manage your tasks. If you are a fast typist, you can manage your tasks faster than traditional GUI apps.

Table of Contents

Quick Start

  1. Enusure you have Java 11 installed on your Computer.
  2. Download the latest ip.jar from here.
  3. Copy the file to the folder you want to use as home folder for the task manager.
  4. Use Win+R to open the command prompt and type cmd and press Enter.
  5. Then cd into the folder where you copied the jar file. e.g. cd C:\Users\Lau\Desktop\MyTask
  6. Type java -jar ip.jar and press Enter to start the program.
  7. Type the command in the command prompt and press Enter to execute it.

Features

  1. Words in UPPER_CASE are the parameters to be supplied by the user. e.g. in todo DESCRIPTION, DESCRIPTION is a parameter which can be used as todo readbook.
  2. Extraneous parameters for commands that do not take in parameters (such as bye and list) will be ignored. e.g. if the command specifies bye 123, it will be interpreted as bye.

Adding a task: todo

Add a task to the task manager.
Format: todo DESCRIPTION
Constraints: DESCRIPTION must be a non-empty string.
Example:

____________________________________________________________
todo play football
Got it. I've added this task:
[T] [ ] play football
Now you have 9 tasks in the list.
____________________________________________________________

Adding a deadline: deadline

Add a deadline to the task manager.
Format: deadline DESCRIPTION /by DATE
Constraints: DESCRIPTION must be a non-empty string. DATE can be in the format of YYYY-MM-DD.
If the DATE is in the format of YYYY-MM-DD, the manager will automatically convert it to MMM DD YYYY.
If the DATE is not in the format of YYYY-MM-DD, the manager still accepts it but will not convert it.
Example:

____________________________________________________________
deadline Midterm assignment /by not announce yet
Got it. I've added this task:
[D] [ ] Midterm assignment (by: not announce yet)
Now you have 10 tasks in the list.
____________________________________________________________
deadline Final exam /by 2019-10-15
Got it. I've added this task:
[D] [ ] Final exam (by: Oct 15 2019)
Now you have 11 tasks in the list.
____________________________________________________________

Adding an event: event

Add an event to the task manager.
Format: event DESCRIPTION /from START_DATE /to END_DATE
Constraints: DESCRIPTION must be a non-empty string. START_DATE and END_DATE can be in the format of YYYY-MM-DD.
If the START_DATE and END_DATE are in the format of YYYY-MM-DD, the manager will automatically convert it to MMM DD YYYY.
If the START_DATE and END_DATE are not in the format of YYYY-MM-DD, the manager still accepts it but will not convert it.
Example:

____________________________________________________________
event recess week /from 2023-2-20 /to 2023-2-27
Got it. I've added this task:
[E] [ ] recess week (from: 2023-2-20 to: 2023-2-27)
Now you have 12 tasks in the list.
____________________________________________________________
event tour /from 2023-02-20 /to 2023-02-22
Got it. I've added this task:
[E] [ ] tour (from: Feb 20 2023 to: Feb 22 2023)
Now you have 13 tasks in the list.
____________________________________________________________

Listing all tasks: list

List all the tasks in the task manager.
Format: list
Example:

____________________________________________________________
list
Here are the tasks in your list:
1.[T] [X] readbook
2.[E] [ ] project meeting (from: Aug 6th 2pm to: 4pm)
3.[T] [ ] join sports club
____________________________________________________________

Marking a task as done: mark

Mark a task as done.
Format: mark INDEX
Constraints: INDEX must be a positive integer and must be within the range of the task list.
If the INDEX is out of range, an error message will be shown.
If the task is already marked as done, an warning message will be shown.
Example:

____________________________________________________________
mark 2
Nice! I've marked this task as done:
[E] [X] project meeting (from: Aug 6th 2pm to: 4pm)
____________________________________________________________
mark 2
[Warning] This task is already done!
Nice! I've marked this task as done:
[E] [X] project meeting (from: Aug 6th 2pm to: 4pm)
____________________________________________________________
mark -1
[>Error] [mark] Sorry, the id is invalid!
____________________________________________________________

Unmarking a task as done: unmark

When a task is marked as done, you can unmark it as done.
Format: unmark INDEX
Constraints: INDEX must be a positive integer and must be within the range of the task list.
If the INDEX is out of range, an error message will be shown.
If the task is not marked as done, an warning message will be shown.
Example:

____________________________________________________________
unmark 2
Nice! I've unmarked this task as done:
[E] [ ] project meeting (from: Aug 6th 2pm to: 4pm)
____________________________________________________________
unmark 2
[Warning] This task is not done yet!
Nice! I've unmarked this task as done:
[E] [ ] project meeting (from: Aug 6th 2pm to: 4pm)
____________________________________________________________
unmark 10
[>Error] [unmark] Sorry, the id is invalid!
____________________________________________________________

Finding a task: find

Find all the tasks that contain the keyword.
Format: find KEYWORD
Constraints: KEYWORD must be a non-empty string.
Example:

____________________________________________________________
find book
Here are the matching tasks in your list:
1.[T] [X] readbook
3.[T] [ ] borrow book
____________________________________________________________

Deleting a task: delete

Delete a task from the task manager by its index.

Format: delete INDEX
Constraints: INDEX must be a positive integer and must be within the range of the task list. If the INDEX is out of range, an error message will be shown.
Example:

____________________________________________________________
delete 2
Noted. I've removed this task:
[E] [ ] project meeting (from: Aug 6th 2pm to: 4pm)
Now you have 8 tasks in the list.
____________________________________________________________
delete 0
[>Error] [delete] Sorry, the id is invalid!
____________________________________________________________

Searching a task by date: date

Search all the tasks that are on the date.
Format: date DATE
Constraints: DATE must be in the format of YYYY-MM-DD.
Example:

____________________________________________________________
date 2019-10-15
Here are the matching tasks in your list:
5.[D] [ ] running (by: Oct 15 2019)
8.[E] [X] greeting (from: Oct 14 2019 to: Oct 16 2019)
11.[D] [ ] Final exam (by: Oct 15 2019)
____________________________________________________________

Exiting the program: bye

Exit the program.
Format: bye
Example:

bye
Bye. Hope to see you again soon!
  ____  ___   ___  ____  ______   _______ _
 / ___|/ _ \ / _ \|  _ \| __ ) \ / / ____| |
| |  _| | | | | | | | | |  _ \\ V /|  _| | |
| |_| | |_| | |_| | |_| | |_) || | | |___|_|
 \____|\___/ \___/|____/|____/ |_| |_____(_)

____________________________________________________________

Process finished with exit code 0

FAQ

Q: If I do not use the correct format, will the program still work?
A: No, the program will show an error message and provide you the correct format.
Example:

____________________________________________________________
event hahahah
[>Error] Please use the format: event <task name> /from <event time from> /to <event time to>
____________________________________________________________

Command Summary

Action Format Example
todo todo DESCRIPTION todo readbook
deadline deadline DESCRIPTION /by DATE deadline return book /by 2023-02-28
event event DESCRIPTION /from DATE /to DATE event project meeting /from 2023-02-28 3pm /to 4pm
list list list
mark mark INDEX mark 1
unmark unmark INDEX unmark 1
find find KEYWORD find book
delete delete INDEX delete 1
date date DATE date 2023-02-28
bye bye bye