ip

User Guide

Floren is a desktop app for managing tasks, optimized for use via a Command-Line Interface (CLI) while still having a Graphical User Interface (GUI).

New to the terms CLI and GUI? See here for a short summary on the differences between CLI and GUI.

Table of Contents

Quick Start / Setting Up

  1. Ensure you have Java 11 installed in your computer.

    Not familiar with Java? Refer to this installation guide.

  2. Download the latest iteration of Floren here. The specific file to download is floren-{version}.jar, e.g. floren-v0.2.jar.
  3. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds.

Note: The list is filled with placeholder data.

Features

Adding Tasks

Adds a task to the bot’s list. There are three types of tasks:

1. ToDo : todo

Quick tasks that need to be done soon without the need of a specific time or place.

Format: todo <TASK_NAME>

Examples:

Expected output:

Got it! I've added this task:
[T][ ] Homework
You have 2 tasks in the list.

2. Event: event

Tasks that need to be done with the need of a specific place.

Format: event <EVENT_NAME> /at <PLACE_NAME>

Examples:

Expected output:

Got it! I've added this task:
[E][ ] Concert (at: YST Conservatory)
You have 2 tasks in the list.

3. Deadline : deadline

Tasks that need to be done before a specific time.

Format: deadline <TASK_NAME> /by <YYYY-MM-DD>

Examples:

Expected output:

Got it! I've added this task:
[D][ ] iP (by: 2022-09-16)
You have 3 tasks in the list.

Listing tasks : list

Lists the tasks that have been added to the bot.

Format: list

Expected output:

Aight. Here is your complete tasks.
1. [T][ ] Run in the morning
2. [D][ ] iP (by: 2022-09-16)
3. [E][ ] Concert (at: Buona Vista)

Deleting your tasks : delete

Deletes a task that has been added to the bot.

Format: delete <TASK_INDEX>

Examples:

Expected output:

Yay. Successfully removed this unwanted task :p
[D][ ] iP (by: 2022-09-16)
Now you have 2 tasks in the list.

Finding your tasks : find

Finds a task with the given keyword.

Format: find <KEYWORD>

Examples:

Expected Output:

1.[D][ ] meeting ambassador (by: 2022-09-16)
2.[T][ ] meeting President

Marking your tasks as done: mark

Marks a task as done. Tasks that have been marked will be denoted with an “X”.

Format: mark <TASK_INDEX>

Examples:

Expected output:

Congrats on completing this task!
[D][X] iP (by: 2022-09-16) 
You have 9 tasks in the list.

Unmark your tasks: unmark

Unmarks a task as done. Tasks that have been unmarked will be denoted with a white space [ ].

Format: unmark <TASK_INDEX>

Examples:

Expected output:

Got it. I've unmarked this task for you ;)
[D][ ] iP (by: 2022-09-16)
You have 2 tasks in the list.

FAQ / Troubleshooting

I cannot seem to start the bot.

Please make sure you have Java 11 installed; refer to this installation guide.

Floren keeps telling me these messages and I don’t know what to do.

  1. ☹ OOPS!!! Please specify what you want to do!

    It is likely that you did not include the description of the task when adding a ToDo. Please make sure to refer to this guide.

  2. ☹ OOPS!!! The description of an event cannot be empty.

    It is likely that you did not include the description of the task when adding an Event. Please make sure to refer to this guide.

  3. ☹ OOPS!!! The description of a deadline cannot be empty.

    It is likely that you did not include the description of the task when adding a Deadline. Please make sure to refer to this guide.

  4. ☹ OOPS!! Date is invalid! Hint: Make it YYYY-MM-DD.

    You inserted a wrong date format. Like stated, please make it YYYY-MM-DD. Example: 2022-09-15 means 15 September 2022.

  5. ☹ OOPS!!! I’m sorry, but I don’t know what that means :-(

    You likely inputted a wrong command line. Please try again!

  6. ☹ OOPS!! I don’t know when you are rescheduling this to.

    You might have added a date of the wrong format, or you did not add a date at all.

  7. ☹ OOPS!! Please enter the task number after the command!

    Please enter a valid positive integer after the command, e.g. mark 2, delete 5, unmark 3

  8. ☹ OOPS!!! Failed to read file.

    Floren failed to read the file where your tasks have been saved to (duke.txt). Please restart Floren and try again.

  9. ☹ OOPS!!! Failed to write to file.

    Isara failed to write to the file where your tasks should have been saved to (duke.txt). Please restart Floren and try again.

Command Summary

Action Format Example Output
Add ToDo todo <TASK_NAME> todo Homework Got it! I’ve added this task:
[T][ ] Homework
You have 1 tasks in the list.
Add Event event <EVENT_NAME> /at <PLACE_NAME> event Concert /at Buona Vista Got it! I’ve added this task:
[E][ ] Concert (at: Buona Vista)
You have 2 tasks in the list.
Add Deadline deadline <TASK_NAME> /by <YYYY-MM-DD> deadline iP /by 2022-09-16 Got it! I’ve added this task:
[D][ ] iP (by: 2022-09-16)
You have 3 tasks in the list.
Listing tasks list list Aight. Here is your complete tasks.
1. [T][ ] Run in the morning
2. [D][ ] iP (by: 2022-09-16)
3. [E][ ] Concert (at: Buona Vista)
Deleting your tasks delete <TASK_INDEX> delete 2 Yay, successfully removed this unwanted task :p
[D][ ] iP (by: 2022-09-16)
Now you have 2 tasks in the list.
Finding your tasks find <KEYWORD> find morning 1. [T][ ] Run in the morning
Marking your tasks as done mark <TASK_INDEX> mark 2 Congrats on completing this task!
[D][X] iP (by: 2022-09-16)
Unmark your tasks unmark <TASK_INDEX> unmark 2 Got it. I’ve unmarked this task for you ;)
[D][ ] iP (by: 2022-09-16)
       

Uncovered Issues?

If you have any other issue that has not been covered in this guide, please bring your concerns here.