JelphaBot - User Guide

By: AY1920S2-CS2103T-F09-2 Since: Jan 2020 Licence: MIT

A0190055L Ong Eden
A0187819J Amanda Lam
A0188384M Lim We Si, Jel
A0184679H Yap Dian Hao
A0187280Y Thng Yao Jie

Table of Contents

1. Introduction
2. Quick Start
3. Features
4. FAQ
5. Command Summary

1. Introduction

Welcome to JelphaBot!
This user guide is written for new and experienced users of Jelphabot. This guide will equip you with the basics so that you can quickly enjoy and master the features offered.

If this is not your first time using JelphaBot, you can refer to Section 2, “Quick Start” to get started right away!

1.1. What is JelphaBot?

JelphaBot is a desktop app for managing tasks specially designed by and for NUS students that allows you to recognise important tasks at a glance so that you can prioritise commitments and manage your time.

You can enter commands in JelphaBot through a Command Line Interface (CLI), which means that if you can type quickly, JelphaBot can help you get work done faster than a traditional mouse-controlled Graphical User Interface (GUI), while still retaining the benefits of a beautiful user interface.

Figure 1. Brief overview of the app

1.2. Overview of features

The main features of JelphaBot are split into five tabs.

Summary - Summary of the updates to your task list over the past day.
Task List - View and manage tasks in your task list.
Calendar - View your schedule on a specific day or within a specific month.
Productivity - Track your overall productivity through metrics such as task completion rate.
Reminder - Set and manage your upcoming reminders.

Each tab provides a specific feature aimed to help you manage your tasks and deadlines more productively!

Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

1.3. Using this User Guide

This User Guide is filled with information to help you set up and make the best out of you very own JelphaBot! You will be able to learn more about the commands that are available for you, together with examples of how they are used. These commands are also consolidated in Section 5, “Command Summary” for your convenience.

1.3.1. Notation used in this Guide

To aid in your understanding throughout this User Guide, you may find below the different symbols and formatting used throughout this guide. We have also provided hyperlinks to help you navigate between related sections.

Table 1. Common symbols used throughout this guide.
Symbol	What does it mean?
`command`	Command that can be typed into the command box
`Key`	A Key that you should press on your keyboard
	Tips and tricks that might be useful
	Additional information that is good to know
	Important pointers to note
Hyperlink	Link to another section or website

2. Quick Start

Ensure you have Java 11 or above installed in your Computer.
Download the latest jelphabot.jar here.
Copy the file to the folder you want to use as JelphaBot’s home folder.

This is important because it decides where your information is saved!
Ensure that JelphaBot has write permissions to that folder.
Double-click the file to start the app. The GUI should appear in a few seconds.
JelphaBot should initialize with a sample list of tasks as shown in the following diagram.

Upon running JelphaBot, you will see various components on it’s main display screen. The components of the main screen is labelled below.

Figure 2. Expected result after running JelphaBot

Some tasks should already be present in JelphaBot.

JelphaBot is initialized with a sample list of tasks, to test if you’ve installed JelphaBot correctly!
If you do not see this, please try deleting JelphaBot and its accompanying files and folders and repeat steps 2 to 4.

Type a command in the command box and press Enter to execute it.
e.g. typing help and pressing Enter will open the help window. To start entering your own commands, use clear to reset JelphaBot.
Some example commands you can try:
- add d/Assignment 1 dt/10-Mar-2020 23 59 m/CS2103T :
  adds a task with description "Assignment 1" to the task list.
- list : lists all tasks.
- delete 1 : deletes the 1st task shown in the current list.
- exit : exits the app.
  
  You can use the UP and DOWN keys to view your last entered commands,
  and Ctrl + Tab to nagivate to the next tab quickly!

Refer to Section 3, “Features” to learn about how each command can help you.
A summarized list of commands is available here.
We hope you have a great time using JelphaBot!

3. Features

In this section, you can find details about the commands that JelphaBot supports. These include the function of the command, its format, and example usages.

For easier naviagation, this guide will go through features according to the order of tabs shown on the User Interface.

3.1. Common commands

3.1.1. Viewing help : `help`

If you can’t recall the command you need, you can enter the help command in any panel.
A help window will appear with a link to this user guide.
Format: help

Figure 3. Expected result after running help

3.1.2. Exiting the program : `exit`

You can exit the program anytime by entering the exit command directly from any panel.
Format: exit

3.1.3. Switching between tabs

You can switch between tabs anytime by pressing Ctrl + Tab on your keyboard to move to the next tab on the right. If you are already on the rightmost tab, it wraps around to the leftmost tab. You can also move to tabs directly by using the respective shortcut commands. These make JelphaBot easier to use for experienced users. Easily remember command shortcuts by checking the bolded letter in the title of every panel!

Table 2. List of applicable Switch Tab commands.
Command	Tab switched to
`summary`, or `:s`	Summary
`list`, or `:t`	Task List
`calendar`, or `:c`	Calendar
`productivity`, or `:p`	Productivity
`remindertab`, or `:r`	Reminder

3.2. Summary (Eden)

This will be the first panel you see after entering JelphaBot!

This section gives you a minimalistic overview of the day, namely tasks that you have due within the day, and tasks that you have completed within the day. Tasks displayed will only have it’s module code as well as their description for simplicity!

3.2.1. Viewing the summary tab: `summary`

You can enter the summary command or its shortcuts :S or :s to manually switch to the summary tab. Summary panel shows your tasks that are due today, and those that you have completed today. Once a task that is due today is marked as done, it will appear under the tasks that you have completed today.

Format: summary
Shortcut: :S or :s

Figure 4. Example of expected result after executing summary

Summary panel shows the tasks that are Due Today, and Completed Today.

Once a task under the Due Today header is marked as done, it will appear under the Completed Today tab.

Figure 5. Expected view of the Summary tab after completing the task, ACC1101 Tutorial 4

3.3. Task Management (Yao Jie)

JelphaBot allows you to track and manage your tasks comprehensively as well! You can view and sort all your tasks from the Task List page.
You can enter the list command or its shortcuts :T or :t to instantly switch to the task list tab. The task list panel will then display all your tasks sorted into various categories.

Format: list
Shortcut: :T or :t

Figure 6. Example of expected result after executing list

3.3.1. Reading the Task List

The task list is formatted so that you can distinguish urgent tasks at first glance. The start of every task is labelled with a module code so that you can visually categorize them. Tasks are tagged according to their importance:

Default priority
High Priority tasks will be bolded to denote important tasks.
Low priority tasks will be italicized to denote optional tasks.

The start of every task will be labelled with a module code so that you can visually categorize them.
Go here to read more about adding tasks with priority and here for editing task priority.

Command Format for Task list commands

Parts of the command in UPPER_CASE represent command parameters that have to be supplied by you.
e.g. in add d/DESCRIPTION, DESCRIPTION represents a field where you can provide the appropriate description, such as add d/Assignment 1.
Parameters in square brackets are optional e.g d/DESCRIPTION [p/PRIORITY] can be used as d/Assignment 1 p/0 or as d/Assignment 1.
Parameters with a trailing … can be used as many times as you want, or can also be omitted.
e.g. [t/TAG]… can be used once as t/project, or multiple times like t/project t/graded, and so on.
Parameters can be in any order e.g. if the command specifies d/DESCRIPTION p/PRIORITY, p/PRIORITY d/DESCRIPTION is also acceptable.

3.3.2. Adding a Task: `add`

You can add new tasks to your task list in JelphaBot with the add command. This allows you to update your task list with new tasks whenever they arise.

Format: add d/DESCRIPTION dt/DATETIME m/MODULE_CODE [p/PRIORITY] [t/TAG]…

Figure 7. Example of an expected result after executing add d/Assignment 1 dt/Jan-01-2020 23 59 m/CS1231 t/graded

For dt/DATETIME inputs, please use the format MMM-dd-YYYY HH mm.
- MMM: the corresponding month in 3 letters.
- dd: the corresponding day in 2 numbers.
- YYYY: the corresponding year (AD) as 4 numbers.
- HH: the hour the task is due, in 24-hour format.
- mm: the minute the task is due.
Values that p/PRIORITY can take are -1, 0 or 1.

Format of the month in DATETIME (MMM) input has to have the first letter in upper-case.
E.g Mar instead of mar when specifying the month of March.

Examples:

add d/Assignment 1 dt/Jan-01-2020 23 59 m/CS3230 p/1
add d/Project TP dt/Jan-01-2020 23 59 m/CS2103T p/1 t/pair t/work

A task can have any number of tags (including 0)!
If the priority field is not specified, priority is set to Default priority.

3.3.3. Listing all Tasks : `list`

JelphaBot allows you to list all your current tasks. In order to make it easier for you to view and use JelphaBot, you can group your tasks by some categories. These categories can be specified through optional arguments. Format: list [GROUPING_CATEGORY]

If no GROUPING_CATEGORY is provided, the date grouping will be applied by default.
Valid GROUPING_CATEGORY values are date (groups tasks by date) and module (Groups tasks by module code)

Grouping Tasks by Date : `list date`

You can group tasks based on their due date. This is also the default interface for the task list tab.
Format: list date

Figure 8. Example of an expected result after executing list date

list date allows you to group your tasks into the following categories:

Overdue
(Shows tasks which are past their due date)
Due Today
(Shows tasks not overdue and due by the end of the current day)
Due This Week
(Shows tasks due within the next seven days)
Due Someday
(Shows all other tasks that do not fit into prior categories)

These categories are arranged to make it easier for you to see what is immediately due. By moving tasks that are due soon to the top of the list, you can decide what to focus your time on.

Grouping Tasks by Module : `list module`

You can also group your tasks based on their module code.
Format: list module

Figure 9. Example of an expected result after executing list module

This grouping allows you to manage your time by tracking the amount of time spent on each module. You can also see which modules have upcoming projects or assignments due.

3.3.4. Locating Tasks by name: `find`

You can find tasks in your task list with description containing any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS]

Figure 10. Example of an expected result after executing find tutorial

The search is case insensitive. e.g tut will match Tut
The order of the keywords does not matter. e.g. project Work will match Work project
Only the description is searched.
Only full words will be matched e.g. Tut will not match Tutorial
Tasks matching at least one keyword will be returned (i.e. OR search). e.g. Project Work will return Project Group, Work meeting

Examples:

find assignment
Returns Assignment 1 and assignment task
find Tutorial Project MidTerm
Returns any task having descriptions of Tutorial, Project, or MidTerm

3.3.5. Editing a Task : `edit`

If there are changes to existing tasks in JelphaBot, you can edit it with the edit command.
Format: edit INDEX [d/DESCRIPTION] [dt/DATETIME] [m/MODULE_CODE] [p/PRIORITY (-1, 0, or 1)] [t/TAG]…

Figure 11. Example of an expected result after executing edit 1 m/CS2105 d/Tutorial 2

Edits the task at the specified INDEX number shown in the displayed task list.
The index provided must be positive and the task to edit cannot have a running timer.
At least one of the optional fields must be provided.
Existing values will be updated to the input values.
When tags are edited, all existing tags will be removed and replaced with the new tags.

Examples:

edit 1 m/CS2105 d/Tutorial 2
Edits the Module Code of the first task to CS2105 and Description to Tutorial 2.
edit 2 dt/Jan-2-2020 23 59 t/
Edits the Date and Time of the second task to be Jan-2-2020 23 59 and clears all existing tags.

You can remove all the task’s tags by typing t/ without specifying any tags after it.

3.3.6. Completing a Task : `done`

When you complete a task, you can mark it as done in JelphaBot. The task’s status will automatically be updated in the display.
Format: done INDEX

Figure 12. Example of an expected result after executing done 1

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, …
The task must not have a running timer.

3.3.7. Deleting a Task : `delete`

If you no longer need a task stored in JelphaBot, you can delete it with the delete command.

Format: delete INDEX

Figure 13. Example of an expected result after executing delete 1

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, …
Deleting a task deletes any reminders for it too.

Examples:

list
delete 2
Deletes the 2nd task in the task list.
find Betsy
delete 1
Deletes the 1st task in the results of the find command.

3.3.8. Clearing all Tasks : `clear`

If you want to reset JelphaBot and start over, you can use the clear command. This command will delete all existing Tasks and Reminders from JelphaBot.

Format: clear

Figure 14. Example of an expected result after executing clear

3.3.9. Showing completed Tasks : `show-completed` (Eden)

You can keep a log of all the tasks that have been completed with the show-completed command.

Figure 15. Example of an expected result after executing show-completed

The figure above shows a task list with a single task completed.

If you do not have any currently complete tasks, the displayed list will be empty and a message will be shown telling you that you currently do not have any completed tasks!

Figure 16. Example of an expected result after executing show-completed, if the task list does not have any completed tasks

The corresponding message is shown in the Results Display.

3.3.10. Showing incomplete Tasks: `show-incomplete` (Eden)

You can display all the tasks in your task list that are currently incomplete, so that you can see what you should do next.

Figure 17. Example of an expected result after executing show-incomplete

In the example above, there are many overdue tasks. The task list can be further scrolled to view all the tasks.

If you do not have any tasks that are incomplete in your task list, the displayed list will be empty and a message will be shown telling you that you currently do not have any incomplete tasks!

Figure 18. Example of an expected result after executing show-incomplete, if the task list does not have any incomplete tasks

The corresponding message is shown in the Results Display.

3.3.11. Pinning Important Tasks : `pin` [Coming in V2.0] (Yao Jie)

You can pin important tasks to the top of the task list with the pin command.
Pinned tasks will always be displayed in the Pinned Tasks group in the task list.
Trying to pin a task that is already pinned will unpin it.

3.3.12. Sorting Tasks : `sort` [Coming in V2.0] (Yao Jie)

You can change how tasks are sorted with the sort command. Format: sort SORTING_ORDER

Valid SORTING_ORDER values include date, module, and priority.

3.4. Calendar (Amanda)

JelphaBot also comes with a built-in calendar view that allows you to view your overarching tasks due on a monthly basis. Dates that have tasks due would have a dot indicator shown on the calendar. You would also be able to navigate to specific dates to view your tasks due for that day of the month!

3.4.1. Viewing your calender : `calendar`

You can enter the calendar command or its shortcuts :C or :c to manually switch to the calendar tab. The calendar panel will then show you your schedule for the current month with today’s date highlighted.

Format: calendar
Shorcut: :C or :c

Figure 19. Example of expected result after executing calendar

Highlighting of Dates: Today’s date would be highlighted in dark blue, while other dates would be in light blue.

3.4.2. Changing month and year view of your Calendar : `calendar`

You can navigate the calendar panel to another month and year by specifying it. The calendar panel would be updated accordingly while highlighting the first day of the month. The task list panel on the left will display the tasks due on the first day of the month.
Format: calendar MONTHYEAR

For MONTHYEAR format, it should be MMM-YYYY, but it also allows some other formats shown when your format is invalid.

Examples:

calendar May-2020

Figure 20. Example of expected result after executing calendar May-2020

This command should display the calendar for the month of May in the year 2020 in the calendar panel (on the right) and display the corresponding tasks due for 1-May-2020 in the task list (on the left).

Format of the month in MONTHYEAR (MMM) input has to have the first letter in upper-case.
E.g Mar instead of mar when specifying the month of March.

Dot indicator showing tasks: Dates that have more than 3 tasks due would have a red dot indicator, while dates with at least 1 task but less than 4 tasks due would be represented with a green dot indicator.

3.4.3. Showing tasks due on a specific date : `calendar`

Displays the tasks due on specified date, while highlighting that day on the calendar
Format: calendar DATE

The date specified must be for a day within the date range displayed in the current Calendar panel for the corresponding date to be highlighted.
For DATE formats, we recommend the format to be MMM-dd-YYYY, but it also allows some other formats shown when you type in the command word.

Examples:

calendar Apr-6-2020
calendar Apr/6/2020

Figure 21. Example of expected result after executing calendar Apr-6-2020

This command should highlight the 11th of April in the calendar panel (on the right) and display the corresponding tasks due in the task list (on the left).

3.4.4. Navigating directly to today’s date on Calendar : `calendar`

You can directly navigate to the current day’s date in the calendar view. Format: calendar today

Examples:

calendar today

Figure 22. Example of expected result after executing calendar today on 13th April, 2020

This command will display the corresponding calendar for this month and highlight today’s date in the calendar panel (on the right). The task list panel also will display the corresponding tasks due today (on the left).

3.5. Productivity Tracking (Jel)

JelphaBot automatically tracks your productivity within the day, and displays a progress bar which allows you to track the completion progress of the tasks which are due in the coming week. You can see the progress bar fill up as you complete more tasks.

JelphaBot also dynamically provides feedback in response to your achievements and task completion rate. Hopefully, this would make you even more productive by encouraging you to get more done!

3.5.1. Tracking your productivity : `productivity`

You can enter the productivity command or its shortcuts :P or :p to manually switch to the productivity tab. The productivity panel will then show you your productivity for the day.

Format: productivity
Shortcut: :P or :p

Figure 23. Example of expected result after executing productivity

The progress bar and the text following it only shows tasks that are due within the week JelphaBot is running.

3.5.2. Starting the timer for a task : `start`

You can start a timer for your task.
Format: start INDEX

Figure 24. Example of expected result after executing start 1

Each task can only have 1 running timer.
Starts the timer for the task at the specified INDEX if timer was not already running.
The index refers to the index number shown in the displayed task list.
The index must be a positive integer 1, 2, 3, …
A completed task cannot be timed.
New timer entry under "Running Timer(s)" in the productivity tab will be added if execution is successful.

3.5.3. Stopping the timer for a task : `stop`

You can stop a running timer for your task.
Format: stop INDEX

Figure 25. Expected result after running stop 1

The task has to have a running timer.
Stops the timer for the task at the specified INDEX if timer was running.
The index refers to the index number shown in the displayed task list.
The index must be a positive integer 1, 2, 3, …
Timer entry under "Running Timer(s)" in the productivity tab will be removed if execution is successful.
Time spent on timed task will be added to the respected time spent section in the productivity tab.

Exiting the application before stopping any running timer wil cause all recorded time since the timer was started to be lost.

3.6. Set Reminders (Dian Hao)

JelphaBot allows you to set reminders for tasks and manage your tasks comprehensively! You can view all your existing reminders from the reminders tab.

3.6.1. Viewing your reminders : `remindertab`

You can enter the remindertab command or its shortcuts :R or :r to manually switch to the reminder tab. The reminder panel will then show all the reminders that you have set.

Format: remindertab
Shortcut: :R or :r

Figure 26. Example of expected result after executing remindertab

Every Reminder will show the Task `s module code, description, due date, the days that will be reminded before the deadline, and the hours that will be reminded before the deadline.

3.6.2. Adding reminder : `reminder`

You can add a reminder to your specified task to remind yourself of the task if the current time is within the time-frame specified by you.

Format: reminder INDEX days/DAYS hours/HOURS

Figure 27. Example of expected result after executing reminder 1 days/1 hours/1

Adds a reminder to the task which is 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, ….
DAYS refers to the number of days before the due date of the task when you want to be reminded of it.
HOURS refers to the number of hours before the due date of the task when you want to be reminded of it.
You can only specify DAYS to be in the range 0 - 7 inclusive.
You can only specify HOURS to be in the range 0 - 24 inclusive.
Every Task can only have one Reminder .
A Task that is completed cannot have a Reminder .
A Task that is reminded but is not completed after the deadline will still be reminded for.
A Task will not be reminded if the task is completed but it has a Reminder .

3.6.3. Removing reminder : `delrem`

If you would like for a task’s reminder to be deleted, you can use the delrem command to remove the reminder of that task.

Format: delrem INDEX

Figure 28. Example of expected result after executing delrem 1

Removes a reminder associated to 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, ….
Whenever a task is deleted, the corresponding reminder will also be removed.

Whenever you start up JelphaBot after adding your reminders, JelphaBot’s reminder window will popup. The popup will show a list of tasks that will be overdue soon, and tasks that are past their deadline but have not been completed.

Figure 29. Example of expected result after tasks are being reminded.

Reminders will persist until you either complete the Task, or delete the Reminder.

3.7. Colour-coded module codes [Coming in V2.0]

Users can customise the font colours of different modules to better distinguish between different tasks. The module codes displayed in the Main Window will be similar to the tags displayed to make it easier for users to view them.

4. FAQ

Q1: Is JelphaBot free?
A: Yes, JelphaBot is completely free to use!

Q2: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous JelphaBot folder.

Q3: How do I save my data?
A: JelphaBot automatically saves your data whenever you make a change. There is no need to save manually.

Q4: Can I add multiple tasks using a command line?
A: Sorry, we currently do not support this feature. We will consider this in v2.0.

Q5: How do I add tasks with no deadline or description?
A: Sorry, we currently do not support task entries with no deadline or descriptions. We will consider this in v2.0.

Q6: Do I need an Internet connection to use JelphaBot?
A: No, you don’t. JelphaBot works completely offline.

5. Command Summary

Help: help
Summary: summary or :s or :S
Add [d/DESCRIPTION] [dt/DATETIME] [m/MODULE_CODE] [p/PRIORITY] [t/TAG]…
e.g. add d/Project TP dt/Jan-01-2020 23 59 m/CS2103T p/1 t/pair work
List: list or :t or :T
List by Date: list date
List by Modules: list module
Find: find KEYWORD [MORE_KEYWORDS]
e.g. find Tutorial Assignment
Edit: edit INDEX [d/DESCRIPTION] [dt/DATETIME] [m/MODULE_CODE] [p/PRIORITY] [t/TAG]…
e.g. edit 1 m/CS2105 d/Tutorial 2
Done: done INDEX
e.g. done 1
Delete: delete INDEX
e.g. delete 3
Clear: clear
Exit: exit
Show Completed Tasks: show-completed
Show Incomplete Tasks: show-incomplete
Add Reminder: reminder INDEX days/DAYS hours/HOURS
e.g. reminder 2 days/1 hours/1
Delete Reminder: delrem INDEX
e.g. delrem 2
View Reminders: remindertab or :r or :R
Productivity: productivity or :p or :P
Timer: start INDEX or stop INDEX
e.g. start 1 or stop 1
Calendar: calendar or :c or :C
Calendar Date: calendar DATE
e.g. calendar Jan-1-2020
Change Calendar View: calendar MONTHYEAR
e.g. calendar Apr-2020
Today’s Calendar View: calendar today