Yesterday’s Tomorrow - User Guide

By : Team CS2103JAN2017-F11-B3      Since: Jan 2017      Licence: MIT

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

1. Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest YTomorrow.jar from the releases tab.
  3. Copy the file to the folder you want to use as the home folder for your task list.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

  5. Type the command in the command box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.
  6. Some example commands you can try:
    • list : lists all tasks
    • add` Econ hw d/2017/05/22 0700 : adds a task “Econ hw” to the task list and set the due date to May 22nd at 7am.
    • delete 3 : deletes the 3rd task shown in the current list
    • exit : exits the app
  7. Refer to the Features section below for details of each command.

2. Features

Command Format

2.1. Viewing help : help

Shows information about how to use Yesterday’s Tomorrow. Format: help Hotkey: CTRL+H

2.2. Opening the theme manager : theme

Displays the theme manager of the program. Format: theme Hotkey: CTRL+T

2.3. Adding a task: add

Adds a task to the task list
Format: add TASK_NAME [from START TIME] [to END TIME] [in GROUP]

Users can add a task without defining either start time or end time. An end time must be specified if a start time is specified. local time will be set as default if start time and end time parameters do not specify time. TASK_NAME should only contain alphanumeric characters and spaces, and it should not be blank.

Examples:

2.4. Listing all tasks : list

Shows a list of all tasks (completed or incompleted).
Format: list

The task list will be ordered from earliest to latest end date.

2.5. Listing complete tasks : lc

Shows a list of all completed tasks.
Format: lc

The task list will be ordered from earliest to latest end date.

2.6. Listing incomplete tasks : li

Shows a list of all incomplete tasks.
Format: li

The task list will be ordered from earliest to latest end date.

2.7. Editing a task : edit

Edits an existing task in the task list.
Format: edit INDEX PARAMETER NEW_VALUE

Examples:

2.8. Marking a task as complete : mark

Changes the status of one task to complete. Format: mark INDEX

Examples:

2.9. Marking a task as incomplete : unmark

Marks a task in current task list as incomplete. Format: unmark INDEX

Examples:

2.10. Deleting a task : delete

Deletes the specified task. Reversible with undo
Format: delete INDEX

Deletes the task at the specified INDEX.
The index refers to the index number shown in the most recent listing.
The index must be a positive integer 1, 2, 3, …

Examples:

2.11. Clear all tasks : clear

Clear all tasks or only completed task in the list.
Format: clear [KEYWORD]

Keyword can just be all, passed or complete.

Examples:

2.12. Finding all tasks containing keyword in their task name: find

Finds tasks whose name contain any of the given keywords.
Format: find KEYWORD

Examples:

2.11. seperate different groups : group

list all the tasks within certain groups.
Format: group [KEYWORD]

Examples:

2.13. Undo : undo

Undoes the previous action. This command will return the program to the state it was in before the previous action was executed
Format: undo

2.14. Redo : redo

Does the undo function again. This command will return the program to the state it was in before the previous undo action was executed
Format: redo

2.15. Exiting the program : exit

Exits the program.
Format: exit Hotkey: CTRL+Q

2.16. Saving data

Prompts a new window to select a file to save, and all further changes are saved to this file. Hotkey: CTRL+S

2.16. Opening data

Prompts a new window to select a file to load from, and all further changes are saved to this file. Hotkey: CTRL+O

2.16. Exporting data

Prompts a new window to select a file to save the current data to. Hotkey: CTRL+E

2.16. Importing data

Prompts a new window to select a file to import data from. This adds any new tasks to the current file, and updates any with the same name. Hotkey: CTRL+I

2.17 Hotkeys

2.18 Data Initialization

Upon starting for the first time, the program randomly generates and displays 50 tasks. Upon saving, loading, or modifying the data, the program saves the file location and loads this on startup if found.

2.19 Themes

YTomorrow has a built in theme manager that displays choosable css themes for the program and sets the selected one. Hotkey: CTRL+T

2.20 Clearing Data

Command clears all tasks that are either:

2.21 Completion Indication

Whether a task is complete or not is indicated by a light green or red border around the task, respectively.

2.22 Past Deadline Indication

A task’s deadline has passed when the task’s background is red.

3. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and ask the program to load the transferred file. Q: I found a bug in the program, how do I report it?
A: Please create a new issue via this link with a detailed title and description. Please also include [BUG] in the beginning of the title.

Q: I am a developer. How can I contribute to the project?
A: Please feel free to open a pull request with implementation of new features. Our only request is that you review the developer guide and abide to all the requirements.

Q: Is it possible for me to change the appearance of the application?
A: Yes, using the theme manager via the theme command or CTRL+T.

4. Command Summary