tp

User Guide

Introduction

Welcome to CantVas!

logo.png

Congratulations on taking the first step towards smarter, more organized student life! CantVas is your ultimate companion for managing your academic and financial responsibilities with ease. Designed with students in mind, our app offers a comprehensive suite of tools to help you stay on top of your expenses, organize your timetable and track your grades.

Table of Contents

Quick Start

  1. Ensure you have Java-11 or above installed on your computer.
  2. Download the latest version of CantVas from here.
  3. Copy the jar file to your desired folder.
  4. Open a command prompt in the same directory as the jar file.
  5. Run java -jar CantVas.jar to run the application.

Features

CantVas includes the following features:

Expenditure Tracker

The expenditure tracker allows you to store, view, delete and filter the expenditures you have entered. Making it a good way to track your expenses.

Please remember to include spaces between each input when using the commands to ensure proper functionality.

The features include:

Adding expenditure without type

Doing so will leave the ‘type’ field empty and thus defaulting to ‘NA’. When viewed using any list or view functions, the second column will be ‘NA’.

Note that there are input length restrictions to the expenditures. The description field should not exceed 100 characters and the type field should not exceed 20 characters.

Adding expenditure with type

View all expenditure

View expenditure by month and year

View expenditure by year

View expenditure by type

Delete all expenditure

Delete expenditure by index

Back to table of contents

GPA Calculator

The GPA calculator allows you to calculate your GPA, based on your previous GPA and your new modules’ grades and module credit numbers.

Please remember to include spaces between each input when using the commands to ensure proper functionality.

In CantVas, we provide 2 methods of GPA calculation.

Method 1: Step by Step GPA Calculator

Quick Start:

  1. Starting from the main menu.
  2. Type GPASTEP (Regardless of caps) to proceed to start the function.
  3. Type Your Current_GPA / Numbers_of_MCs_Taken. Example: 4.00/24
  4. Type the numbers of modules taken for this semester. Example: 4
  5. Type in the details for each module taken. In the format of: n/ mc/ gr/. Example: `n/CS1010 mc/4 gr/A+` or `n/CS2113 mc/4 gr/F`
  6. Your GPA will be automatically calculated afterward.
  7. You have the flexibility to leave the GPA calculator at any point by simply typing exit.

    Modular credit should be a non-negative integer value between 0 and 12.

Method 2: Calculation of GPA by ModuleList

This method is for user who are more familiar with GPA calculation mechanism or they have too many modules to enter. This method provides them with the ease to edit their module list.

Quick Start:

  1. Starting from the main menu.
  2. Type ‘GPALIST’ (Regardless of caps) to proceed to start the function.
  3. You will enter GPA Calculation by list mode.
  4. First you are recommended to enter modules into the list by typing add.
  5. After which you can input the numbers of modules that you would like to record into the list by inputting an integer.
  6. Type in the details for each module taken. In the format of: n/ mc/ gr/. Example: `n/CS1010 mc/4 gr/A+` or `n/CS2113 mc/4 gr/F`.
  7. After done with adding in modules, type exit to go back to sub-menu.
  8. Now you can calculate your GPA by typing gpa.
  9. Follow the prompt, input your current gpa and modular credits completed so far in the format of Current_GPA / Numbers_of_MCs_Taken. Example: 4.00/24.
  10. Your GPA will be automatically calculated !
  11. If you feels like editing the modules information, you can access it by typing del to delete specific module or to delete the whole list.

Commands in GPALIST

help : See the help list.

del : Delete specific module result record, or to delete everything.

add : Add modules’ credit information and expected grade.

viewlist :To view what modules are in the list.

gpa : To calculate your gpa based on modules recorded in the list. If the module list is empty, it will just return your current GPA.

exit : Go back to the previous page.

img_gpalist.png

Back to table of contents

Mathematical Graph Demo

To fulfill students’ requirement of knowing how mathematical equations are like in graphical form. We have implemented a function named GC .

To enter our graph demo, you can simply by typing GC in the main window. After which you will be brought to the Graph Demo Page.

We have implemented 3 graphs so far. Namely:

Y = X

Y = log(X)

Y = X ^2

You can select which graph you would like to see by typing YX or YXsq or YlogX to view them in the pop-up window.

gcdemo.png

Back to table of contents

Timetable Tracker

The timetable tracker allows you to store, view and delete classes you have entered for the current semester. Making it a good way to track what are the classes, where are the classes and the class durations from monday to friday respectively.

For any of the features below, if there exist multiple errors, the program will only return one of them. Specifically, the program returns missing input errors over valid input format errors.

Please remember to include spaces between each input when using the commands to ensure proper functionality.

The features include:

Add class

View all class for the week

View class for the day

Delete class

Back to table of contents

Motivational Quotes

Feeling Down? Dread looking at your packed timetable? CantVas is here to save your day and uplift your spirits whenever you need it most (when looking at expenses and timetable)

Everytime you start CantVas, we will provide you with a motivational quote to give you energy and encouragement to get through your day!

Back to table of contents

FAQ

Q: What if I key in the wrong expenditure or timetable class?

A: Editing the list is not possible, in the event of erroneous input, please delete and input the correct expense or class accordingly.

Q: What if I mistakenly delete a class or expenditure entry?

A: Once a class or expenditure entry is deleted, it cannot be recovered through CantVas itself. It’s important to confirm your actions before deleting any data. To prevent such mistakes, always double-check the details before executing a deletion command.

Q: Why can’t I find the expenditure I inputted via the e/ view/ t/ function?

A: Double check if you have inputted in the type of expenditure by using the list command to check if there exists an NA after the expenditure description. If so, amend accordingly and then e/ view/ t/ should work as expected.

Q: What kind of timetable is the app able to display? Is it for the whole semester, one month or one week?

A: CantVas is able to display your timetable from Monday to Friday for classes in the semester using a list format for each day, arranged based on the time of the day. For example, if we have a 3-hour CG2023 from 1pm on monday at E4-03-07 and a 2-hour EE2026 from 9am on monday at LT6, the list will output:

Monday:

Take note that each hour is listed out as an individual row. Hence, for any classes lasting more than an hour, there will be more than one rows for such classes. But each row will have total hours -1 value for the duration.

Q: What if I have 2 classes with the same code on the same day and I only want to delete 1?

A: Deleting that specified class code for the day will delete all instances of the specified class within the day, Users will have to re-enter the class they would like to keep

Q: How do I transfer my data to another Computer?

A: Download CantVas on the other computer and overwrite the empty text files created in the ./data directory with the text files from your original computer also found in the ./data directory.

Q: What happens if there are corrupted file entry?

A: CantVas will try to remove the corrupted entry when you exit the application. However in the case where CantVas does not recognise the entry as corrupted, you may remove the entry directly from the text file.

Q: What should I do if CantVas crashes or freezes?

A: If If CantVas crashes or freezes, restart the application. If the problem persists, ensure that your data files are not corrupted and check if your system meets the software’s requirements(Java 11). If necessary, reinstall CantVas to resolve software glitches.

Q: What should I do if I encounter an error saying File not found when accessing CantVas?

A: This error typically occurs when CantVas cannot locate its data files in the ./data directory. Ensure that you have not moved or deleted the ./data folder. If the problem continues, try reinstalling CantVas and make sure the installation path is correct and accessible.

Q: Is there a limit to the number of classes or expenditures I can input into CantVas?

A: CantVas does not impose a specific limit on the number of classes or expenditures you can input. However, performance may vary based on your computer’s capabilities, especially as the data files grow larger. The number of classes is also limited by the number of hours/days in a week since the timetable is for one week.

Back to table of contents

Command Summary

Please remember to include spaces between each input when using the commands to ensure proper functionality.

Action Format
Add expenditure without type e/ add/ d/ <description> amt/ <cost> date/ <dd.mm.yyyy>
Add expenditure with type e/ add/ d/ <description> t/ <type> amt/ <cost> date/ <dd.mm.yyyy>
List expenditure e/ list/
View expenditure by month e/ view/ m/ <mm.yyyy>
View expenditure by year e/ view/ y/ <yyyy>
View expenditure by type e/ view/ t/ <type>
Clear all expenditure e/ clearlist/
Delete expenditure by index e/ del/ <index>
GPA calculator method 1 gpastep
GPA calculator method 2 gpalist
Mathematical Graph Demo gc
Add class tt/ add/ day/ <day> code/ <classCode> time/ <hh> duration/ <duration> location/ <location>
List all class for the week tt/ list/
List class for the day tt/ list -d/ <day>
Delete class tt/ del/ day/ <day> code/ <code>
Show help message help
Exit CantVas exit
Back to table of contents