Skip to content
This repository has been archived by the owner on Oct 23, 2022. It is now read-only.

abdurrahmanfaqihiskandar/ip

 
 

Repository files navigation

User Guide

Duke Chatbot is a desktop app for managing tasks and scehdules. This chatbot uses a GUI text interface to interact with the user.

  • Quick Start
  • Features
    • Help
    • Adding a task:
      • ToDo: todo
      • Deadline: deadline
      • Event: event
    • Listing tasks: list
    • Finding tasks based on keyword: find
    • Marking tasks as done: done
    • Deleting tasks: delete
    • Exiting the program: bye
  • Command Summary

Quick Start

  1. Ensure you have java 11 or newer installed in your computer.
  2. Download the latest release from here.
  3. Add the duke.jar file into a directory of your choice to be used as your home directory.
  4. Double click the duke.jar file to launch the application.

Features

Notes about the command format:

  • 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 Clean the dishes.

Adding a task

Adding a ToDo task:todo

Adds a todo task to the tasklist.

Format: todo DESCRIPTION

Examples:

  • todo Clean the dishes

Adding a task with a deadline:deadline

Adds a task with a deadline to the tasklist. A task with a deadline needs to have a deadline date and time in the form YYYY-MM-DD and HH:MM respectively.

Format: deadline DESCRIPTION /by YYYY-MM-DD HH:MM

Example:

  • deadline Project submisstion /by 2020-11-09 23:59
  • deadline Write my essay /by 2020-12-13 00:30

Adding an event task:event

Adds an event to the tasklist. An event needs to have an event date in the form YYYY-MM-DD and an event time range HH:MM-HH:MM.

Format: event DESCRIPTION /at YYYY-MM-DD HH:MM-HH:MM

Example:

  • event Birthday party /at 2020-09-26 18:00-20:00
  • event History exam /at 2020-11-12 17:00-18:45

Listing tasks:list

Shows the list of tasks currently. There are a number of ways to list the tasks in the tasklist. Below are all the different ways to list tasks in the tasklist broken down into the type of tasks:

  • All tasks:
    • List all tasks:list all
    • List all tasks that are done:list all done
    • List all tasks that are not done:list all not done
  • ToDo tasks:
    • List all todo tasks:list todos
    • List all todo tasks that are done:list todos done
    • List all todo tasks that are not done:list todos not done
  • Tasks with a deadline:
    • List all tasks with a deadline:list deadlines
    • List all tasks with a deadline that are done:list deadlines done
    • List all tasks with a deadline that are not done:list deadlines not done
  • Events:
    • List all events:list events
    • List all events that are done:list events done
    • List all events that are not done:list events not done

Finding tasks based on keyword:find

Find tasks whose names contain the keyword.

Format: find KEYWORD

  • KEYWORD cannot be empty
  • The search is case-sensitive. E.g. tEsT will not match test.
  • Only the name is searched.
  • Part search will also match full words. E.g. te will match test.
  • The order of the keywords does not matter. E.g. Exam Mock will match Mock Exam.

Examples:

  • find party
  • find exam

Marking tasks as done:done

Marks tasks as done.

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, ...

Examples:

  • list all to view all the tasks in the tasklist followed by done 2 will mark the 2nd task as done.
  • done 4 will mark the 4th task as done.

Deleting tasks:delete

Deletes tasks from the tasklist.

Format: delete INDEX

  • Deletes the task at the specified INDEX.
  • The INDEX refers to the index number shown in the displayed task list.
  • The INDEX must be a positive integer 1, 2, 3, ...

Examples:

  • list all to view all the tasks in the tasklist followed by delete 2 will delete 2nd task.
  • delete 4 will delete the 4th task.

Exiting the program:bye

Exits the program and closes the application.

Format:bye

Saving the data

Duke automatically saves the tasklist in the hard disk after any command that changes the data. There is no need to save manually.

Command Summary

Action Format, Examples
todo todo DESCRIPTION, e.g. todo Clean the dishes
deadline deadline DESCRIPTION /by YYYY-MM-DD HH:MM, e.g. deadline Project submisstion /by 2020-11-09 23:59
event event DESCRIPTION /at YYYY-MM-DD HH:MM-HH:MM, e.g. event Birthday party /at 2020-09-26 18:00-20:00
list list PARAMETER, e.g. list events done
find find KEYWORD, e.g. find homework
done done INDEX, e.g. done 2
delete delete INDEX, e.g. delete 1
bye bye

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 98.0%
  • Shell 1.2%
  • Batchfile 0.8%