list
,list -s
, list -c
, list -a
bm NUMBER
cat CATEGORY_NAME
delete CATEGORY_NUMBER
back
add LINK
/ add LINK t->TITLE
rm LINK_NUMBER
star LINK_NUMBER
cd 3
/ cd timetable
add class
add activity
show link
show schedule
list activity
list class
delete activity INDEX
delete class INDEX
clean up
cd 4
/ cd academic
add contact c/CONTACT_DETAILS m/MOBILE_NUMBER e/EMAIL
list contact
star contact INDEX
delete contact INDEX
add grade n/MODULE_NAME m/MC g/GRADE
list grade
check cap
star grade INDEX
su grade INDEX
delete grade INDEX
list star
Welcome to Study It User Guide!
Study It is an interactive desktop app that helps manage your study related matters, optimized for use via a Command Line Interface (CLI). It can keep track of your various study matters, present them in an organized and thoughtful manner to help you organize your study life. It will also provide various functionalities to help with your studies. You will be able to make full use of the application if you can type fast.
This application currently has the following modes that you can access and use:
This app is targeted towards National University of Singapore (NUS) students studying in this current online environment. This user guide will be providing information about how to use the Study It app by showing you a step-by-step guide to access each functionality the app provides. By utilizing these features, you will be able to manage your study matters efficiently!
The following is a list of common notations and symbols you’ll encounter throughout the user guide:
INDEX_NUMBER
Words of phrases in full capital indicates that they are inputs that you can decide on
command
words or phrases highlighted indicate that they are actual commands you can use in the app
Underlined words or phrases in blue colour are website links that you can press on to access the website
Let’s get started with using Study It! This section will show you how you can run our app on your computer.
Firstly, please ensure that your computer fulfills the following requirement:
Once you are done installing Java 11.0.8 onto your PC, you may follow these procedures to start using Study It:
java -jar tp.jar
into the command prompt and press Enter to execute it
Congratulations! You are now able to run Study It. To access its various functionalities,
you would need to type in the command at the Command Prompt and press Enter. Whenever you feel lost,
refer to the following sections of this User Guide or call the help
function in the app
for guidance. We hope that you have fun using our app!
The following section details the general commands you can use in the app. These commands can be used anywhere in the app to help you navigate around the app.
This section contains the following commands:
Warning The general commands doesn’t work during
add class
oradd activity
sequence in timetable mode andadd
ortest
sequence in flashcard mode
help
The app will print out a summarised list of functions you can call at the current mode. This help message will vary depending on which mode you are at. Use this command to get guidance on what you can do with the app!
Instruction:
help
and press EnterExpected output:
Example of printing help message at menu:
Another example of printing help message at bookmark mode:
Useful information:
- The message varies in different modes to show you the commands at that mode. Try it out!
cd MODE_NAME or MODE_INDEX
You can change to different modes of the app by using this command! The following are the modes currently available in the app and their corresponding index:
Instruction:
cd
followed by the MODE_NAME
or MODE_INDEX
Expected output:
Command: cd 2
Command: cd academic
Warning
- An error message will appear when you type an invalid mode index or mode name
- Ensure that your index is within range or you spelt the mode names correctly when using this command!
Useful information:
- You can use this command anywhere in the app to switch between modes quickly!
- This command STILL works if you don’t have space/have excess space between
cd
and theMODE_NAME/MODE_INDEX
location
Calling this command will show you which mode you are currently at.
Instruction:
location
and press EnterExpected output:
At bookmark mode:
At flashcard mode:
highlight
This command will print out the starred items in Bookmark and Academic
Instruction:
highlight
and press EnterExpected output:
exit
This command behaves differently depending on which mode you are currently at.
If you are currently at the Main Menu, calling this command will exit the app as shown below:
Instruction:
exit
and press EnterExpected output:
If you are in any of the other modes (i.e. bookmark/timetable/academic/flashcard), calling this command will exit that mode and place you at the Main menu instead, as shown below:
Instruction:
Expected output:
Now that more lessons are moving online, are you managing your links well? You might want to save your time finding your zoom links in your email inbox and save all your links in the bookmark feature to access them easily! The bookmark mode enables you to compile all your links in one destination and even categorise them into different groups. After entering the bookmark mode (refer to General Command 2), use the following commands to navigate around bookmark mode.
This section contains 8 commands:
Warning If you edit the data file wrongly, the bookmark feature will not be able to take in the correct category name, and links. If you encounter any errors after handling the bookmark data file, refer to FAQ
list
,list -s
, list -c
, list -a
Are you trying to find your links by entering into each category to view your links? You might want to have an easy way to view the overview of your links. You can now view the entire list of links in the category you are in, the starred links, the list of categories available, or the entire list of links in every category using the following commands.
Instructions:
list
list -s
list -c
list -a
Expected output:
Useful Information:
- You can only use this command anywhere after entering the bookmark mode. (Refer to General Command 2)
- If your category does not have any links, it will indicate that the list is empty.
- If you are in bookmark main, and you input
list
, it will show you the entire list of links in every category. (Same command aslist -a
)- To star / unstar a link refer to 1.8
- To add a category refer to 1.3, to delete a category refer to 1.4
- You can also omit the space between
list
and-a
/-s
/-c
- The user input is not case-sensitive.
Warning
- Follow the format
list
,list -s
,list -c
,list -a
without adding additional inputs. If additional input is detected, the program will prompt you to input the correct format.
bm NUMBER
Managing so many links can be a hassle! However, categorising the links into different groups can make it even more efficient to find your links! After entering bookmark mode (refer to General Command 2), you can enter each category using the following commands. This command allows you to change the bookmark category within the bookmark mode.
Instruction:
bm NUMBER
E.g. bm 2
Expected output:
Useful Information:
- You can only use this command anywhere after entering the bookmark mode. ( Refer to General Command 2)
- Zoom, Nus, Internship, Hackathon, Career Talks categories are included in the default.
- If you are already in the chosen category, the program will inform you as shown in the figure below.
- You can also omit the space between
bm
andNUMBER
- The user input is not case-sensitive.
If you encounter any errors, take note of the following warnings.
Warning:
- Ensure that the category NUMBER that you have chosen is valid. Error will be shown if the category NUMBER does not exist, or the NUMBER you have entered is not a number. To find out the valid category NUMBER, view the list of categories (Refer to 1.1)
cat CATEGORY_NAME
If you cannot find the perfect category to place your bookmark, why not create your own category! In addition to the default categories that are added (Zoom, NUS, Internship, Hackathon, Career Talks), create your own category to add your bookmark links. Use the following commands to add a category and navigate it (Refer to 1.2) the same way as the rest of your categories.
Instruction:
cat CATEGORY_NAME
e.g. cat entertainment
, cat stocks
Expected output:
Useful Information:
- You can only use this command anywhere after entering the bookmark mode. (Refer to General Command 2)
- NUS, Zoom, Internship, Hackathon and Career Talk categories are included in the default.
- You can also omit the space between
cat
andCATEGORY_NAME
- The user input is not case-sensitive.
If you encounter any errors, take note of the following warnings.
Warning:
- Ensure that the category name is not empty. Error will be shown if the category name is empty.
- You can only add unique category name.
delete CATEGORY_NUMBER
When you have a category, but you have no important links related to the category, take it out of your bookmark list! Organise and design your bookmark categories to your own personal needs by adding your own category (refer to 1.3) and deleting unnecessary categories using these following commands.
Instruction:
delete CATEGORY_NUMBER
e.g. delete 6
Expected output:
Useful Information:
- You can only use this command in bookmark main. (Refer to 1.5 to go back to the bookmark main)
Before deleting a category, take note of the following warnings.
Warning:
- Ensure that the category NUMBER that you have chosen is valid. Error will be shown if the category NUMBER does not exist, or the NUMBER you have entered is not a number. To find out the valid category NUMBER, view the list of category available. (Refer to 1.1)
- CAUTION: Make sure to check all your links before deleting. Deleting a category will delete all the bookmarks in the category!
back
There are two modes in bookmark feature: the main bookmark mode (refer to General Command 2), and the category mode (Refer to 1.2). To navigate freely from mode to mode, use the following command. This command goes back to the previous mode depending on which mode you are in.
Instruction:
back
Expected output:
Useful Information:
- When you input
back
in any bookmark category, you are brought back to the bookmark main.- When you input
back
in the bookmark main, you will be prompted to type “exit
” to exit bookmark mode.- The user input is not case-sensitive.
Warning:
- Follow the format
back
without adding additional inputs. If additional input is detected, the program will prompt you to input the correct format.
add LINK
/ add LINK t->TITLE
If you have a link to add to your bookmark category, follow these commands. Make sure you have chosen your category (Refer to 1.2) and ensure that you do not add an invalid link or an empty link to your bookmark. If you are afraid you will forget what the bookmark link is for, you can add a title to your bookmark link just by including a ` t-> TITLE` after you enter your link. In addition, if you forget what links you have already bookmarked, you can always add the same link, and the program will tell you whether you have the link in your list.
Instruction:
add LINK
e.g. add google.com
add LINK t->TITLE
e.g. add https://nus-cs2113-ay2021s1.github.io/website/index.html t->Cs2113T
Expected output:
Useful Information:
- You can only use this command after choosing your category. (Refer to 1.2)
- You can only bookmark unique links within your category. Refer to the following figure.
- The user input is not case-sensitive.
If you encounter any errors, take note of the following warnings.
Warning:
- Ensure that you have chosen a category. You will be prompted to choose a category before you are allowed to add your links. (Refer to 1.2)
- Ensure that the link added is valid. Error will be shown if the link you have given is empty or is not valid (contains “ “, “|” or does not contain “.”).
rm LINK_NUMBER
If you have a link that you no longer want to bookmark, or if you have a link that you accidentally bookmarked, you can remove the bookmark easily just by following these few commands. Make sure that you have chosen your category (Refer to 1.2) and ensure that you do not remove an empty, or an invalid link number.
Instruction:
rm LINK_NUMBER
e.g. rm 1
Expected output:
Useful Information:
- You can only use this command after choosing your category. (Refer to 1.2)
- You can also omit the space between
rm
andNUMBER
- The user input is not case-sensitive.
If you encounter any errors, take note of the following warnings.
Warning:
- Ensure that you have chosen a category. You will be prompted to choose a category before you are allowed to remove your links. (Refer to 1.2)
- Ensure that the link number that you want to remove is valid. Error will be shown if the link number you have given is empty or is not valid. Refer to 1.1 to find out the correct link number.
star LINK_NUMBER
You might have many links that you need to manage, however, some of the links might be more important than others. If you have such links, you can easily mark them up by following these few commands. Make sure that you have chosen your category (Refer to 1.2) and ensure that you do not input an empty or invalid link number.
Instruction:
star LINK_NUMBER
e.g. star 1
Expected output:
Useful Information:
- It is the same command for marking and unmarking any links. For example, if link 1 is not starred, star 1 will mark the link as starred. And if link 1 is starred, star 1 will unmark link 1.
- You can view your starred links in the highlight function in the main mode. (Refer to General Command 4)
- You can also omit the space between
star
andNUMBER
- The user input is not case-sensitive.
If you encounter any errors, take note of the following warnings.
Warning:
- Ensure that you have chosen a category. You will be prompted to choose a category before you are allowed to mark your links as starred. (Refer to 1.2)
- Ensure that the link number that you want to mark as star is valid. Error will be shown if the link number you have given is empty or is not valid. Refer to 1.1 to find out the correct link number.
Do you find it a hassle to keep track of all your activities and Zoom links for online classes? Do you wish there was a simple, visual way to organise your day and foresee any clashes in your schedule? The timetable mode intends to address these issues, helping you keep track of your work and helping you achieve purposeful productivity.
Warning:
- Do not try to edit the data file for the timetable if you are unsure. Doing so may result in the application not being able to retrieved the saved data, hence deem the data file corrupted and request to format the data file before you can use the timetable feature again.
This section contains 10 commands to navigate the Timetable mode:
cd 3
/ cd timetable
If you find it difficult to make plans due to uncertainties in your schedule, this timetable mode presents your upcoming events at a glance to know what to expect and stay on track. This command brings you to enter the timetable mode.
Instruction:
cd 3
/ cd timetable
Expected output:
Useful information:
- You can use this command from any mode to access the timetable mode easily and quickly!
add class
If you find it hard to keep track of all your Zoom links with an increasing number of online classes, you can now arrange your classes in a systematic manner with this feature. Make sure you are currently in the timetable mode (refer to 2.1).
Instruction:
add class
Expected output:
Useful Information:
- The module code will accept any input between 1-7 characters.
- You can enter the time in both 12hr and 24hr format. Only entering am/pm at the back of the duration will be assumed as both starting and ending time are in the same period.
If you encounter any errors, take note of the following warning.
Warning:
- Ensure that you follow the format for answering the questions. Error will be shown if the questions are not answered in a suitable format.
- Adding events that clash with the existing schedule will result in error message. You will need to check through the schedule and events list and delete the unwanted event accordingly before you can add the new event.
- Number of recurring classes are capped at 52 weeks (1 year) to ensure effective processing time. Add your class again one year later if your class recurs for more than a year.
add activity
It can be hard to view your upcoming events at a glance. Similar to the previous feature, this command allows you to add activities outside of classes to your schedule.
Instruction:
add activity
Expected output:
Useful Information:
- Currently this feature does not support adding activity past 12am. If you wish to schedule an activity overnight, add the activity in 2 separate sessions.
show link
If you find it hard to keep track of all your conference links for your classes or activities, this command will present all links relevant to you for the next 2 hours.
Instruction:
show link
Expected output:
show schedule
If you wish to view your schedule for the next seven days with all the activities, use this command.
Instruction:
show schedule
Expected output:
Warning:
- If the name of event is more than 10 character only the first 10 character will be shown.
list activity
If you wish to see all activities you have input into the system, this command will present all the activities you have added with their starting date and time, if the activity is online, and the venue/link of the activity.
Instruction:
list activity
Expected output:
list class
If you think searching through the timetable is too troublesome, use this command to see all the classes you have added and other details of the classes, similar to the previous feature.
Instruction:
list class
Expected output:
delete activity INDEX
If you have accidentally added a wrong activity, or an activity you have added has been cancelled, use this command to delete an activity with corresponding index according to the activities list (refer to 2.6).
Instruction:
delete activity INDEX
Example of usage:
delete activity 1
will delete the first activity in the list.
Expected output:
delete class INDEX
Similar to feature 2.8, use this command to delete a class with corresponding index according to the classes list (refer to 2.7).
Instruction:
delete class INDEX
Example of usage:
delete class 2
will delete the second class in the list.
Expected output:
Warning:
- Deleting a class will delete all the lessons of that module on schedule. Use this command with caution.
clean up
Having too many events added to the application, and the data file is taking up too much space? Use this command to remove all the activities that was over more than 7 days ago and all the classes with their last lesson concluded more than 7 days ago.
Instruction:
clean up
Expected output:
Warning:
- Deletion will be done automatically. All the events that are deleted will not be able to be retrieved. Only use this if you are sure you do not need your past events.
Have you ever had to dig through tons of emails to look for the contact of a particular TA or sweat over your calculator when trying to estimate your CAPS this semester? Academic tracker provides a convenient experience where you can store all the information you need in one place! To access the academic tracker, follow the instructions below.
This section contains 12 commands to navigate the academic mode:
cd 4
/ cd academic
This command allows you to enter academic tracker mode from the main menu or from the other modes. After entering this mode, you can then access all the features that the academic tracker offers!
Instruction:
cd 4
/ academic
Expected output:
Useful information:
- You can use this command from any mode to access the academic mode easily and quickly!
add contact c/CONTACT_DETAILS m/MOBILE_NUMBER e/EMAIL
In academic mode, you can add a contact to the current list of contacts, following the instructions below.
Instruction:
add contact c/CONTACT_DETAILS m/MOBILE_NUMBER e/EMAIL
Example of usage:
add contact c/Prof Lim m/81234567 e/E7654321@u.nus.edu
will add a contact with the name Prof Lim, mobile number 81234567, and email E7654321@u.nus.edu.
Expected output:
Warning:
- Numbers should be a positive integer with 8 or fewer digits , and email should be in the form abc@xyz.
list contact
You can view all the contacts that have been added previously and stored on your computer by following these sets of instructions
Instruction:
list contact
Expected output:
star contact INDEX
Sometimes you may wish to highlight an important contact, and that’s where starring a contact come into use. Follow the instructions below to mark an important contact with a star.
Instruction:
star contact INDEX
Example of usage:
star contact 1
will mark the first contact in the list with a star.
Expected output:
delete contact INDEX
Do you no longer require the contact of the TA of last sem’s module? Make use of the delete contact function to clean up your contacts by following the instructions below.
Instruction:
delete contact INDEX
Example of usage:
delete contact 1
will delete the first contact in the list.
Expected output:
add grade n/MODULE_NAME m/MC g/GRADE
In academic mode, you can add a grade to the current list of grades, following the instructions below.
Instruction:
add grade n/MODULE_NAME m/MC g/GRADE
Example of usage:
add grade n/CS2101 m/4 g/A-
will add a grade with the title CS2101 that has 4 credits and scored an A-.
Expected output:
Warning:
- Note that module credits need to be a positive integer, and grade entered must be a valid grade.
- This program doesn’t cap how many MCs a module can have.
- This application is not synced to a module database, so any valid input will be accepted as a module name.
list grade
You can view all the grades that have been added previously and stored on your computer by following these sets of instructions
Instruction:
list grade
Expected output:
check cap
To calculate your current CAP based on the grades you have entered previously, follow the instructions below
Instruction:
check cap
Expected output:
star grade INDEX
The star grade function can be used to highlight a particular grade. Follow the instructions below to mark an important grade with a star.
Instruction:
star grade INDEX
Example of usage:
star grade 1
will mark the first grade in the list with a star.
Expected output:
su grade INDEX
SU-ed a module and want to exclude it from your CAP calculation? The SU grade function allows you to do just that through these simple steps.
Instruction:
su grade INDEX
Example of usage:
su grade 1
will su the first grade in the list.
Expected output:
Warning:
- The process of SU-ing a mod is not retractable. Should you accidentally SU a mod unintentionally, consider deleting the mod and adding a new one.
delete grade INDEX
The delete grade function can be used to delete a grade from the currently stored list of grades by following the instructions below.
Instruction:
delete grade INDEX
Example of usage:
delete grade 1
will delete the first grade in the list.
Expected output:
list star
The list star function works like the highlight function, but only displaying the starred items inside the academic section.
Instruction:
list star
Expected output:
Do you wish you had a quick way to refer to the content that will be tested in your upcoming tests? Or a more efficient way to verify your knowledge? Perhaps it is also difficult to scour your handwritten notes to find a particular piece of information. The flashcard mode aims to tackle these aspects that may hinder your learning process.
This section contains 6 commands to navigate the Flashcard mode:
cd 5
/ cd flashcard
If you find it hard to be fully proficient in your study topics, this flashcard mode is a medium for you to actively learn and memorise. This enables you to learn effectively through repetition, helping you to remember information better in the long-term. This command allows you to enter the flashcard mode.
Instruction:
cd 5
/ cd flashcard
Expected output:
Useful information:
- You can use this command from any mode to access the flashcard mode easily and quickly!
add
To assist you in your studies, there needs to be a knowledge base of content to be revised. You can do this by adding new flashcards to the flashcard deck with this command, after entering flashcard mode (refer to 4.1).
Instruction:
add
Example of usage:
4+4
followed by 8
will create a flashcard with question 4+4 and answer 8.
Expected output:
If you encounter any errors, take note of the following warning.
Warning:
- “back” and “show answer” cannot be added as an answer for the flashcard. This is because “back” and “show answer” are used as commands to exit and reveal the answer in the test mode respectively. If the flashcard answer you wish to use is similar to “back” or “show answer”, rephrase and use another term.
list
If you wish to review the content that is currently in the flashcard deck, this command can display all flashcards that have been added.
Instruction:
list
Expected output:
delete
When you have a flashcard that is no longer relevant to you or contains wrong information, you can delete the flashcard from the flashcard deck.
Instruction:
delete
Example of usage:
3
will delete the 3rd flashcard in the list.
Expected output:
Useful information:
- You can use the
list
command to check the card index.
test
Grading your own work is one of the best ways to revise as it helps you effectively retain information. After adding the flashcards, you may wish to revise the content by testing yourself.
If you are unable to answer a question and wish to refer to the answer, use show answer
.
When you are done revising, use back
to exit the test mode, and return to the flashcard main.
Instruction:
test
show answer
/ back
Expected output:
Useful information:
- User input in the test mode is not case sensitive. If the answer is correct but the case is different from the stored answer, the answer will be accepted as the right answer.
find
If you wish to look through the flashcards containing only a particular search term, use this command.
Instruction:
find
Expected output:
Lu Ziyi
Q: How do I transfer my data to another computer?
A: All of Study It’s data is stored under the ROOT_FOLDER/data
folder.
To transfer these data to another computer, please back up the data
folder
and copy it over to the directory in the new computer accordingly after installing the app.
Q: Why is my application not starting up properly?
A: Please refer to the “Getting Started” section and ensure that the correct version of java is installed on your computer. If you face any further difficulties, feel free to refer to the About Us page and contact any of the developers.
Q: Why is XXX feature not supported?
A: As this app is still under development, there are many features we would like to add in the future. Do feedback to us what features you would like to see in Study It!
Ling Si Hui, Shiho
Q: What to do if bookmark data does not load properly after changing the bookmark.txt file?
A: This is for users who edited the bookmark.txt file in the data folder. If you encounter trouble after editing the data file, you can do one of the following steps:
The following table is a compiled list of all available commands in our application that you can easily refer to!
The commands listed under the sections besides “General” can only be called when you are in that specific mode, which you can access using the cd command!