User Guide - SerSnapsalot

By: Ken Yoon Since: Sep 2019

1. Introduction

2. Quick Start

3. Features
...3.1 Viewing help: help
...3.2 Adding a ToDo: todo
...3.3 Adding a Deadline: deadline
...3.4 Adding an Event: event
...3.5 Marking a task as done: done
...3.6 Deleting a task: delete
...3.7 Listing all tasks: list
...3.8 Clearing task list: clear
...3.9 Locating task by description: find
...3.10 Saving the data: save
...3.11 Saving the data to archive: archive save
...3.12 Loading the data from archive: archive load
...3.13 Exiting the program: bye

4. FAQ

5. Command Summary

---

1. Introduction

SerSnapsalot(SS) is for those of us who enjoy keeping track of tasks through a desktop. Specifically, SS is designed to implement a CLI while utilizing a Graphical User Interface (GUI). SS also takes reference from Marvel's Spiderman and Ironman to keep a light and refreshing atmosphere.

2. Quick Start

1. Ensure that Java 11 or above is installed in your Computer.
2. Download the latest SerSnapsalot.jar here.
3. Move the file to the folder you want to set 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.

3. Features

Command Format

• Words in UPPER_CASE are parameters provided by the user e.g. in todo d/DESCRIPTION, DESCRIPTION is the parameter which can be used as todo d/Task 1.
• Parameters must be in the specified order when the command specifies either /at or /by for Event and Deadlines, e.g. event d/DESCRIPTION /at t/TIME and deadline d/DESCRIPTION /at t/TIME.

3.1 Viewing Help: help

Displays the full range of keywords to begin commands.

3.2 Creating a Todo: todo

Adds a Task subclass, ToDo, to the task list.

Format: todo d/DESCRIPTION

Examples:

• todo Borrow a book from the library

3.3 Creating a Deadline: deadline

Adds a Task subclass, Deadline, to the task list.

Format: deadline d/DESCRIPTION /at t/TIME

• TIME should be in the format DD/MM/YYYY HHMM, which specifies the day, month, year, hour and minutes

Examples:

• deadline Return book to the library /by 29/12/2018 2359

3.4 Creating an Event: event

Adds a Task subclass, Event, to the task list.

Format: deadline d/DESCRIPTION /at t/TIME

• TIME should be in the format DD/MM/YYYY HHMM, which specifies the day, month, year, hour and minutes

Examples:

• event Outing at the library /at 29/12/2018 1200

3.5 Marking a task as done: done

Marks a task as done on the task list.

Format: done i/INDEX

• Marks the task at the specified INDEX as done, changing the symbol from [X] to [O]
• The index refers to the i-th task in the task list
• The index must be a positive integer starting from 1 and smaller than the size of the task list

Examples:

• done 1

3.6 Deleting a task: delete

Deletes a task from the task list.

Format: delete i/INDEX

• Deletes the task at the specified INDEX
• The index refers to the i-th task in the task list
• The index must be a positive integer starting from 1 and smaller than the size of the task list

Examples:

• delete 1

3.7 Listing all tasks: list

format: list

3.8 Clearing task list: clear

format: clear

3.9 Locating task by description: find

Finds tasks whose description contains the given keyword.

Format: find k/KEYWORD

• The search is case-sensitive e.g. Task will not match task
• Only the description of the Task is searched
• Partial words will also be matched e.g. Task will match Tasks
• Tasks with matching keywords will be displayed.

Examples:

• find Return book
• Returns 2. Return book to the library (by: Sat Dec 29 23:59:00 SGT 2018)

3.10 Saving the task list: save

Format: save

3.11 Saving to archive: archive save

Saves the current task list to the archive and clears the current task list.

Format: archive save

3.12 Loading from archive: archive load

Loads the task list from the archive and replaces the current task list.

Format: archive load

3.13 Exiting the program

Format: bye

4. FAQ

Q: Where are the tasklist and archived task lsit files saved? A: They will be saved in the same folder as the jar file as "tasklist.txt" and "tasklistArchive.txt" respectively.

5. Command Summary

• Help: help
• Todo: todo d/DESCRIPTION e.g. todo Borrow a book from the library
• Deadline: deadline d/DESCRIPTION /by t/TIME e.g. deadline Return book to the library /by 29/12/2018 2359
• Event: event d/DESCRIPTION /at t/TIME e.g. event Outing at the library /at 29/12/2018 1200
• Done: done
• Delete: delete i/INDEX e.g. delete 1
• List: list
• Clear: clear
• Find: find k/KEYWORD e.g. find Return book
• Save: save
• Archive save: archive save
• Archive load: archive load
• Exit: bye

Acknowledgements

• Libraries used: JavaFX, JUnit5

• Images from:

  https://www.pinterest.com/pin/316518680060680715/

  https://comicbook.com/marvel/2019/07/04/spider-man-far-from-home-reveals-how-people-returned-avengers-infinity-war-snap/

  https://wegotthiscovered.com/movies/spiderman-return-mcu-apple-buying-sony-rumor-true/

  https://weheartit.com/entry/328726211