Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

HAL9000 User Guide

HAL9000 Screenshot

HAL9000 is a Task Manager application that helps you keep track of your tasks so that you don't have to! It is tailored to users who are familiar with a CLI.

Adding deadlines

Adds a deadline task to your task list.

Format: deadline NAME /by BY-TIME

Example: deadline Math Homework /by 12-12-2021

Got it. I've added this task: 
[D] [ ] Math Homework by: 12-12-2021 00:00
Now you have 1 tasks in list.

Note: Name can contain spaces

Adding Events

Adds a event task to your task list.

Format: event NAME /from FROM-TIME /to TO-TIME

Example: event Chemistry Homework /from 12-12-2021 /to 13-12-2021

Got it. I've added this task: 
[E] [ ] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00
Now you have 2 tasks in list.

Note: Name can contain spaces

Adding Todos

Adds a todo task to your task list.

Format: todo NAME

Example: todo Geography Homework

Got it. I've added this task: 
[T] [ ] Geography Homework
Now you have 3 tasks in list.

Note: Name can contain spaces

Deleting Tasks

Deletes a task from your task list.

Format: delete INDEX

Example: delete 1

I have deleted this:
[D] [ ] Math Homework by: 12-12-2021 00:00

Note: Any additional arguments will be ignored

(ie delete INDEX param2 will be executed exactly the same as delete INDEX

Marking Tasks

Marks a task on your task list.

Format: mark INDEX

Example: mark 1

Successful Response:

I have marked this:
[E] [X] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00

Note: Any additional arguments will be ignored

(ie mark INDEX param2 will be executed exactly the same as mark INDEX

Unmarking Tasks

Unmarks a task on your task list.

Format: unmark INDEX

Example: unmark 1

Successful Response:

I have unmarked this:
[E] [ ] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00

Note: Any additional arguments will be ignored

(ie unmark INDEX param2 will be executed exactly the same as unmark INDEX

Listing Tasks

Lists all tasks in your task list.

Format: list

Example: list

Successful Response:

1. [E] [ ] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00
2. [T] [ ] Geography Homework

Note: Any additional arguments will be ignored

(ie list param1 param2 will be executed exactly the same as list

Searching Tasks

Finds a task in your task list.

Format: find KEYWORD

Example: find Geography

Successful Response:

Here are your matching search results:
1. [T] [ ] Geography Homework

Note: Any additional arguments will be ignored and keyword MUST be one word

(ie find KEYWORD param2 will be executed exactly the same as find KEYWORD

Undoing Commands

Undoes the most recent command.

Format: undo

Example: undo

Successful Response:

Your UNMARK command was undone!
This is your current list:
1. [E] [X] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00
2. [T] [ ] Geography Homework

Note: Any additional arguments will be ignored

(ie undo param1 param2 will be executed exactly the same as undo

Redoing Commands

Redoes the most recent command.

Format: redo

Example: redo

Successful Response:

Your UNMARK command was redone!
This is your current list:
1. [E] [ ] Chemistry Homework from: 12-12-2021 00:00 to: 13-12-2021 00:00
2. [T] [ ] Geography Homework

Note: Any additional arguments will be ignored

(ie redo param1 param2 will be executed exactly the same as redo

Exiting the Application

Exits and closes the application.

Format: bye

Example: bye

Notes

  • Error Handling

    • Errors are displayed in the terminal when the jar file is executed
  • Unrecognised commands

    • If an unrecognised command was inputted, the response would be You inputted an unrecognizable command In that scenario, just try again with a correct input.
  • Incorrect Formatting of parameters

    • If there are any errors in processing commands, the response would be Something went wrong went parsing your COMMAND command please check your input again In that scenario, just try again with a correct command
  • Undoing/Redoing Commands

    • You can only undo and redo commands that alter the state of the application, such as DELETE, MARK, UNMARK, DEADLINE, TODO, EVENT.
    • When trying to undo/redo past the limits of history, the response would be You can't rollback/rollforward the state any more!
    • History is cleared upon exit of the application
  • Time formatting

    • The time parameters (BY-TIME, FROM-TIME, TO-TIME) must be formatted in the following way
      • dd-MM-yyyy HH:mm
      • dd-MM-yyyy (the time component will be automatically set to 00:00)

Command summary

Action Format
Adding Deadlines deadline NAME /by BY-TIME
Adding Events event NAME /from START-TIME /to END-TIME
Adding Todos todo NAME
Deleting Tasks list
Marking Tasks mark INDEX
Unmarking Tasks unmark INDEX
Listing Tasks delete INDEX
Searching tasks find KEYWORD
Undoing Commands undo
Redoing Commands redo
Exiting the Application bye