duke

---

Project maintained by lzw12345 Hosted on GitHub Pages — Theme by mattgraham

Task Book - User Guide

Table of contents

1. Introduction
2. Quick Start
3. Features
   1. Adding a Todo task
   2. Adding a Deadline task
   3. Adding an Event task
   4. Adding a NoteBook
   5. Finding a task/notebook
   6. Mark a task/notebook as completed
   7. Deleting a task/notebook
   8. Adding a note to a task/notebook
   9. Finding a note from a task/notebook
   10. Finding a note
   11. Listing all task/notebooks
   12. Listing all notes from a task/notebook
   13. Sorting the columns
   14. Resizing the columns
   15. List of commands
4. FAQ
5. Command summary

---

1.Introduction

Task Book is a simple scheduler with a built in note taking function. It features a command line interface and a helpful chatbot for those who like a more interactive experience. The table formatted data also provides an easy and intuitive way to sort and view the items.

2. Quick Start

1. Ensure you have Java 11 or above installed in your Computer.
2. Download the latest TaskBook.jar here
3. Copy the file to the folder where you want to store Task book (note the save file will be store here too)
4. Double-click the file to start the app. The GUI should appear in a few seconds.
5. Some sample commands you can try
   • list : lists all tasks and notebooks
   • todo meet john adds a to do task to the task list
   • done [1] marks the task with the index 1 as done
   • help shows a list of all the commands

3. Features

Command Format

• the first phrase (with no space) is the command phrase e.g. findnotes test searches for notes with descriptions containing test.
• numbers in square brackets [1] immediately after the command word indicate the task/notebook to be referenced. e.g. addnotes [1] [1] | test 1 creates a note for item 1 with category [1] and description test 1.
• numbers in curly brackets immediately after the task reference are used to indicate the note to be referenced. e.g. deletenotes [1] {2} deletes the note with index 2 in the task/notebook with index 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 meet with a friend.
• All DATE inputs should be input in this format: d/M/yyyy HHmm e.g. 2/2/2019 2345 or 02/02/2019 0945
• DO NOT use / special character in the description or category fields when creating a new note or task/notebook

  3.1 Adding a Todo task

  Adds a to do task to the task list
  Format: todo DESCRIPTION
  Examples:

• todo check the weather
• todo wash dishes

3.2 Adding a deadline task

Adds a deadline task to the task list
Format: deadline DESCRIPTION /by DATE
Examples:

• deadline hand up homework for CS2103 /by 22/2/2019 1234
• deadline finish eating cereal before expiry /by 1/12/2019 1400

3.3 Adding a event task

Adds an event task to the task list
Format: event DESCRIPTION /at DATE
Examples:

• event john's birthday /at 22/12/2019 2300
• event 9.9 lazada sale /at 9/9/2019 0000

3.4 Adding a notebook

Adds a notebook to the list
Format: ‘notebook DESCRIPTION’
Examples:

• notebook weight management
• notebook CS2103 lecture notes

3.5 Finding a task/notebook

Finds a task/notebook with a description matching a keyword or phrase exactly
Format: find KEYWORD(S)
Examples

• find test
• find grocery list

3.6 Mark a task/notebook as completed

Marks a task/notebook as done
Format: done [TASKINDEX]
Examples

• done [2]

3.7 Deleting a task/notebook

Deletes a task/notebook from the list (inputting TASKINDEX as 0 will delete all tasks)
Format: delete [TASKINDEX]
Examples:

• delete [1]

3.8 Adding a note to a task/notebook

Adds a note to the indicated task/notebook
Format:

• addnotes [TASKINDEX] CATEGORY | DESCRIPTION
• addnotes [TASKINDEX] CATEGORY | DESCRIPTION /by DATE
• addnotes [TASKINDEX] CATEGORY | DESCRIPTION /at DATE
  Examples:
• addnotes [1] addition | a+x
• addnotes [2] new version was created /at 2/2/2019 2344

3.9 Deleting a note from a task/notebook

Deletes a note from the indicated task/notebook (inputting NOTEINDEX as 0 will delete all notes)
Format: deletenotes [TASKINDEX] {NOTEINDEX}
Examples:

• deletenotes [1]{1}

3.10 Finding a note

Finds a note from all tasks/notebooks with a description matching a keyword or phrase exactly
Format: findnotes KEYWORD(S)
Examples:

• findnotes mitochondria
• findnotes power house

3.11 Listing all tasks/notebooks

lists all the tasks/notebooks
Format: list

3.12 Listing all notes from a task/notebook

lists all the notes in a indicated task/notebook
Format: shownotes [TASKINDEX]
Examples:

• shownotes [1]

3.13 Sorting the columns

Sort the columns in ascending or descending order by clicking the right corner of the column headers

3.14 Resizing the columns

Resize the columns by clicking and dragging the edges of the column headers

3.15 List of commands

To view a list of commands
Format: help

4 FAQ

Q: Where is the save file stored?
A: The save file is stored in the same folder as the program. It is called SaveFile.json

5 Command Summary

• add todo: todo DESCRIPTION
  e.g. todo check the fridge
• add deadline: deadline DESCRIPTION /by DATE
  e.g. deadline assignment 1 /by 22/2/2222 22222
• add event: event DESCRIPTION /at DATE
  e.g. event jame's birthday /at 22/12/2019 1111
• add notebook: notebook DESCRIPTION
notebook lecture notes
• find a task/notebook: find KEYWORD(S)
  e.g. find biology
• mark a task as done: done [TASKINDEX]
  e.g. done [1]
• delete: delete [TASKINDEX]
  e.g. delete [3]
• add a note:
  • addnotes [TASKINDEX] CATEGORY | DESCRIPTION
  • addnotes [TASKINDEX] CATEGORY | DESCRIPTION /by DATE
  • addnotes [TASKINDEX] CATEGORY | DESCRIPTION /at DATE
    e.g.
  • addnotes [1] addition | a+x
  • addnotes [2] new version was created /at 2/2/2019 2344
• delete note: deletenotes [TASKINDEX] {NOTEINDEX}
  e.g. deletenotes [1]{1}
• find note: findnotes KEYWORD(S)
  e.g. findnotes mitochondria
• list task/notebook: list
• list notes: shownotes [TASKINDEX]
  e.g.shownotes [1]
• list of commands: help