User Guide

Introduction

ModTracker is a desktop app for NUS students to track the time spent as well as tasks to do for each of their modules. It helps students prioritise their work and balance their time spent amongst their modules. This app uses a Command Line Interface (CLI).

Table of Contents

1. Quick Start
2. Features
    2.1 View help: help
    2.2 Add a module: addmod
    2.3 Add expected module workload: addexp
    2.4 Add actual time spent on a module: addtime
    2.5 List expected and actual time spent of all modules: list
    2.6 Analyse actual time spent on all modules: analyse
    2.7 Delete a module: deletemod
    2.8 Delete expected module workload: deleteexp
    2.9 Minus from actual time spent on a module: minustime
    2.10 Edit actual time spent on a module: edittime
    2.11 Delete actual time spent on a module: deletetime
    2.12 Add tasks: addtask
    2.13 List all tasks: listtask
    2.14 Mark task as done: done
    2.15 Delete a task: deletetask
    2.16 Open notification: open
    2.17 Save user data
    2.18 Clear module and task data: clear
    2.19 Delete user data: reset
    2.20 Exit the program : exit
3. FAQ
4. Command Summary

1. Quick Start

1. Ensure that you have Java 11 or above installed.

2. Download the latest version of ModTracker from here.

3. Save the jar file to a folder of your choice.

4. Open a command prompt and navigate to the folder that contains the jar file. Command: cd [directory/filename]

5. Type in the java -jar modtracker.jar command and press enter to run the program.

6. A welcome screen as shown below will be displayed if the program has successfully executed.

   Hello from
   |\\        /|         |======            ||
   ||\\      / |  __   __|  ||  __  ___ ___ ||    ___   ____
   || \\    /  |//  \//  |  ||//  \/  |/    ||// / _ \ //   \
   ||  \\  /   |||   ||  |  |||   ||  ||    ||\\ | __/ ||
   ||   \\/    |\\__/\\__|  |||   \\__|\___ || \\\___| ||
   ******************************************************
   
   Full user guide available at: https://ay2021s1-cs2113t-f12-4.github.io/tp/
   Enter <help> for a quick view of available commands.
   
   What is your name?
   

7. Refer to the Features section below for more details on the application's available commands.

2. Features

Notes:

1. Items in <> are the parameters to be supplied by the user, e.g. in addmod <module code>, module code is a parameter which can be used as such: addmod CS2113T.
2. All the module codes are case-insensitive. The app will convert the module codes to uppercase.
3. The module code is valid if it starts with 2 - 3 characters, followed by 4 digits and an optional character without any spacing.
4. Definition of too much / too little time spent on a module:

   1. A user spends too little time on a module if the user's actual workload is less than the expected workload by more than 30%. For example, if the expected workload is 10 hours, but the actual workload is less than 7 hours, the program considers the user to be spending too little time on the module.

   2. A user spends too much time on a module if the user exceeds the expected workload by at least 30%. For example, if the expected workload is 10 hours, but the actual workload is 13 hours or more, the program considers the user to be spending too much time on the module.

   3. A user spends just the right amount of time on a module if the user spends between 70% to 130% of the expected workload. For example, if the expected workload is 10 hours, and the actual workload is between 7 hours (inclusive) and 13 hours (exclusive), the program considers the user to be on track.

      Analysis	Amount of time spent
      Too little time	A < 70% E
      Just right	70% E ≤ A < 130% E
      Too much time	A > 130% E

      E - Expected workload
      A - Actual time spent

2.1 View help: help

Displays a list of all available commands that you can use.

Format: help

Expected output:

Available Commands:
1. addmod <module code>
   example: addmod CS2113T
2. addexp <module code> <expected workload>
   example: addexp CS2113T 5
3. addtime <module code> <actual time spent> <week number>
   example: addtime CS2113T 2 1
4. list <week number>
   example: list 2
5. deletemod <module code>
   example: deletemod CS2113T
6. deleteexp <module code>
   example: deleteexp CS2113T
7. minustime <module code> <time> <week number>
   example: minustime CS2113T 2 1
8. edittime <module code> <actual time spent> <week number>
   example: edittime CS2113T 8 1
9. deletetime <module code> <week number>
   example: deletetime CS2113T 1
10.analyse <week number>
   example: analyse 1
11.addtask <module code> <task description>
   example: addtask CS2113T revise for exam
12.deletetask <task number>
   example: deletetask 1
13.done <task number>
   example: done 1
14.listtask
15.open
16.clear
17.reset
18.exit

2.2 Add a module: addmod

Adds a new module to track your time spent on it and tasks related to it.

Format: addmod <module code>

• The module code needs to be valid.
• The module code does not exist in the database.
• The leading and trailing spaces of the module code is removed.

Example of usage:

addmod cs2113t

Expected output:

CS2113T is added.

2.3 Add expected module workload: addexp

Adds the expected workload of the given module to the database. Every module in NUS has an expected workload, which is the expected number of hours of preparatory work required by a student per week. This information can be found on LumiNUS or NUSMODS.

Format: addexp <module code> <expected workload>

• The module code needs to be valid.
• The expected workload is expressed in hours. It has to be a number between 1 and 24 inclusive with a maximum of 1 decimal place.
• If the module code already exists, this command replaces its expected workload with the new expected workload.
• If the module code does not exist, this command creates a new module and adds its expected workload to the database.

Example of usage:

addexp cs2113t 10

Expected output(when CS2113T does not exist):

CS2113T, Expected Workload: 10.0h is added.

2.4 Add actual time spent on a module: addtime

Adds to the time you have spent on the indicated module, for that week. After which, a summary of the total hours spent in that week will also be displayed. Time value will be rounded off to 1 decimal place.

Format: addtime <module code> <time spent> <week number>

• The module code needs to be valid.
• The time spent is in hours.
• The week number must be between 1 and 13 inclusive.

Example of usage:

addtime CS2113T 3 1

Expected output:

3 hours have been added to CS2113T.
3.0 hours have been spent on this module in week 1.

2.5 List expected and actual time spent of all modules: list

Shows a list of all of your modules, their expected module workload, and the actual time spent you have spent on each of them for that specific week.

Format: list <week number>

• The week number must be between 1 and 13 inclusive.

Example of usage:

list 1

Expected output:

+------+---------+----------+----------+
| Week | Module  | Expected |  Actual  |
+------+---------+----------+----------+
|  01  | CS2113T |    10    |    3.0   |
+------+---------+----------+----------+

2.6 Analyse actual time spent on all modules: analyse

To further analyse the data, you can use the analyse command. It shows the breakdown and analysis of your time spent on each module for the specific week.

Format: analyse <week number>

• The week number must be between 1 and 13 inclusive.

Example of usage:

analyse 1

Expected output:

Module    Week 1

CS2113T
Actual   | [][][] 3.0
Expected | [][][][][][][][][][] 10.0

CS1231
Actual   | [][][][][][][] 7.0
Expected | [][][][][][][][] 8.0

Total time spent: 10.0 H
30% of time is spent on CS2113T
70% of time is spent on CS1231

Analysis:
CS2113T
You seem to be spending too little time on the module.
Perhaps you should spend more time on this module.

CS1231
Good Job! Great time management!

2.7 Delete a module: deletemod

Deletes the specified module code from the database, together with all its related data, such as the time you have spent on it.

Format: deletemod <module code>

• The module code needs to be valid.
• The module code exists in the database.
• The leading and trailing spaces of the module code is removed.

Example of usage:

deletemod CS2113T

Expected output:

CS2113T is removed.
All tasks under CS2113T are deleted.

2.8 Delete expected module workload: deleteexp

Deletes the expected workload of the specified module code from the database.

Format: deleteexp <module code>

• The module code is valid.
• The module code exists in the database.
• The leading and trailing spaces of the module code is removed.
• There is an input in the expected workload of the module code.

Example of usage:

deleteexp CS2113T

Expected output:

Expected Workload of CS2113T is removed.

2.9 Minus from actual time spent on a module: minustime

Minus the actual time you have spent on a specified module. After which, a summary of the total hours spent in that week will also be displayed. Time value will be rounded off to 1 decimal place.

Format: minustime <module code> <time spent> <week number>

• The module code needs to be valid.
• The time spent is in hours.
• The week number must be between 1 and 13 inclusive.

Example of usage:

minustime CS2113T 3 1

Expected output:

3 hours have been removed from CS2113T.
2.0 hours have been spent on this module in week 1.

2.10 Edit actual time spent on a module: edittime

Edits the actual time you have spent on a specified module for that week to the given value. Time value will be rounded off to 1 decimal place.

Format: edittime <module code> <time spent> <week number>

• The module code needs to be valid.
• The time spent is in hours.
• The week number must be between 1 and 13 inclusive.

Example of usage:

edittime CS2113T 3 1

Expected output:

3 hours is the new actual workload for the module CS2113T.
3.0 hours have been spent on this module in week 1.

2.11 Delete actual time spent on a module: deletetime

Deletes the actual time you have spent on a specified module for that week.

Format: deletetime <module code> <week number>

• The module code needs to be valid.
• The module code exists in the database.
• The week number must be a whole number between 1 and 13 inclusive.
• There is an input in the actual time of the module code for that week.

Example of usage:

deletetime CS2113T 3

Expected output:

Actual time of CS2113T of week 3 is removed.

2.12 Add tasks: addtask

Adds a task which is required by the specified module.

Format: addtask <module code> <task description>

• The module code needs to be valid.
• The module code specified by the user must exist in the database.

Example of usage:

addtask CS2113T finish project

Expected output:

Got it. I've added this task under CS2113T:
[X] [CS2113T] finish project
Now you have 1 task in the list.

2.13 List all tasks: listtask

Lists all tasks that you currently have, whether completed or not.

Format: listtask

Expected output:

Here are the tasks in your list:
1. [X] [CS2113T] finish project

2.14 Mark task as done: done

Marks the specified task as done in your task list, so that you can keep track of what you have completed.

Format: done <task number>

• task number is between 1 and the number of tasks in the database inclusive.

Example of usage:

done 1

Expected output:

Nice! I've marked this task as done:
[/] [CS2113T] finish project

2.15 Delete a task: deletetask

Deletes a specified task from your task list.

Format: deletetask <task number>

• task number is between 1 and the number of tasks in the database inclusive.

Example of usage:

deletetask 1

Expected output:

Noted. I've removed this task:
[/] [CS2113T] finish project
You currently have no task :-)

2.16 Open notification: open

Opens the notification which contains a randomised encouraging message. The notification will give the user an update on the progress of the current week. The program determines the current week based on the latest week that has at least one actual time input. If there is no actual time input in any week, it will be considered as week 1.

Format: open

Example of usage:

open

A possible expected output (when user spends too little time on CS1010 in week 2):

Oh no! It appears you are spending too little time on CS1010 in week 2.
   
The harder you work, the closer you are to success!

Note: The actual output may differ as the encouraging message is random.

2.17 Save user data

The program will save your data such as your name, modules, time spent and tasks to the hard disk automatically. There is no need to save these manually.

When you exit and run the program again, your data will be loaded from the hard disk, and you can use the app as per normal, continuing from where you left off.

The external file which stores your data will be locked to read-only when it is not in use, keeping your data safe and secure.

2.18 Clear module and task data: clear

Deletes all module and tasks data. The program will also prompt the user to confirm this action.

Format: clear

Expected output:

---WARNING!---
This will delete all modules and tasks data.
Type 'yes' if you wish to continue.
Enter any other key to cancel this operation.

Case 1: User enters yes

Note: yes is case-insensitive here. The program ignores any leading or trailing spaces.

Expected output:

Okay, your data has been deleted :(

Case 2: User enters no

Note: any other input will fall under this case.

Expected output:

Clearing of data not confirmed. Your data is safe :)

2.19 Delete user data: reset

Deletes all module and tasks data, and the username, effectively resetting the whole program. The program will also prompt the user to confirm this action. If confirmed, the program will restart and prompt for a new username.

Format: reset

Expected output:

---WARNING!---
This will delete all your past data and reset the whole program.
Type 'yes' if you wish to continue.
Enter any other key to cancel this operation.

Case 1: User enters yes

Note: yes is case-insensitive here. The program ignores any leading or trailing spaces.

Expected output:

Okay, the program will reset now...

Hello from
|\\        /|         |======            ||
||\\      / |  __   __|  ||  __  ___ ___ ||    ___   ____
|| \\    /  |//  \//  |  ||//  \/  |/    ||// / _ \ //   \
||  \\  /   |||   ||  |  |||   ||  ||    ||\\ | __/ ||
||   \\/    |\\__/\\__|  |||   \\__|\___ || \\\___| ||
******************************************************

Full user guide available at: https://ay2021s1-cs2113t-f12-4.github.io/tp/UserGuide.html
Enter <help> for a quick view of available commands.

What is your name?

Case 2: User enters no

Note: any other input will fall under this case.

Expected output:

Reset not confirmed. Your data is safe :)

2.20 Exit the program : exit

Exits the program.

Format: exit

Expected output:

All changes saved.
_______    _______
||   \\\  //||
||___//\\// ||___
||   \\ ||  ||
||___// ||  ||____

Bye <username>. Hope to see you again soon!

3. FAQ

Q: Are the commands case-sensitive?

A: No, all the commands are case-insensitive. Eg. typing in HELP will be taken in as a help command.

4. Command Summary

Home Page