UltiStudent - User Guide

This command will usually be your first and frequently used command in UltiStudent! But fret not, I will teach you on how to use this powerful command that is applicable to all Managers in UltiStudent.

To use this command, we have to adhere to this format: open MANAGER else UltiStudent would not be able to understand what we are trying to tell it to do.

Example time!

Lets say we have a Homework to add, edit or delete, we can easily use open HomeworkManager to command UltiStudent to open Homework Manager for us! Same goes for Notes Manager open NotesManager and Cap Manager open CapManager.

With this, we can begin our journey with UltiStudent to become an ultimate student!

Format: help

Not sure how to get started? Not to worry! Simply type 'help' for more clarity!

If you would like to review what you have done in your current session of UltiStudent, simply use our history command! This command will help to retrieve the previously executed commands which has been entered into the system before history.

This command will result in a prompt that will remind you of the respective command to enter for each manager. For example, entering add command will result in a prompt letting you know that add-hw is the add command for the Homework Manager, add-note for adding notes to Notes Manager and add-cap for the CAP Manager.

Format: exit

When you are done with using UltiStudent, simply close it by using exit! All of your entries will be safely stored on our application.

UltiStudent data are saved in the hard disk automatically after any command that changes the data.
There is no need to for you to save manually. It’s easy to use!

Format: add-hw mc/MODULECODE hw/HOMEWORK d/DEADLINE

Have a homework but unable to attend to it immediately? No worries! Let Homework Manager help us keep track of them! By using add-hw, we can command this manager to remember our homework for us! Make sure we are in the Homework Manager by using open HomeworkManager first.

Sadly, it doesn’t do our homework for us…​ but hey it reduces our worries on forgetting our homework!

To use this command we have to adhere to this format: add-hw mc/MODULECODE hw/HOMEWORK d/DEADLINE else Homework Manager would not be able to understand what we are trying to tell it to do.

Okay enough explanation and time for an example!

Lets say we have to do Tutorial 1 for CS1101S by 1st May 2019. We could command this manager to remember it for us by using add-hw mc/CS1101S hw/Tutorial 1 d/01/05/2019 in the command box (red highlighted box) and do make sure that you are in the homework manager by checking if the Homework icon is highlighted in the nagivation bar (white highlighted box) as shown below.

When CS1101S tutorial 1 has been successfully added, the Result Box (green highlighted box) would display New homework added: CS1101S; Tutorial 1; 01/05/2019;.

We will also be able to view the CS1101S being added into the Module List (blue highlighted box) since this is the first homework for CS1101S we have and the Homework List (orange highlighted box) would show us the newly added CS1101S homework.

Format: edit-homework INDEX [mc/MODULECODE] [hw/HOMEWORK] [d/DEADLINE]

Realised that you made a mistake in an entry after you added it? Introducing our edit command! You can make any changes to any of the attributes of the homework entry using this command!

To use this command, we must follow this format: edit-homework INDEX [mc/MODULECODE] [hw/HOMEWORK] [d/DEADLINE] You can refer to the diagram below to understand what we mean by the word index! You may have noticed that it looks rather similar to the add-hw command. Good observation! However, you should take note of the slight difference that you do not have to include all the attributes. Instead, only include those you wish to change. Any other attribute(s) is optional.

Now let’s take a look at an example so that you can understand what I mean more clearly. So you already have a homework entry in the homework manager which has these mc/CS1101S hw/Tutorial 1 d/01/05/2019 as its attributes. Now let’s say our professor has decided to extend the deadline by a week upon requests by students. Simply type edit-hw 1 d/08/05/2019 and the update will be reflected in your homework entry.

After entering your edit-hw command, the message you see in the green highlighted box in the diagram above indicates that you have successfully done it. You can also see how the deadline of the attribute has been updated according to the deadline you wish to edit it to.

Format: delete-hw INDEX

Now let’s say you are done with your homework and you wish to remove that entry from the homework manager. You can easily delete it by using the delete-hw command! All you have to do is to follow this short and simple format delete-hw INDEX.

Using the same example in the edit command. Let’s say we are done with the CS1101S homework and wish to remove it from the Homework Manager. All you have to do is to type delete-hw 2 and you are done!

Our delete command is the shortest command in UltiStudent and the easiest to use. If you happen to forget what we mean by the word INDEX, simply refer to the diagram in the edit-hw section (Section 4.2.2) to understand what it means!

Format: find-mod [KEYWORDS]

As we get later into the semester, there will be more work for us to do. Every single module has some form of submission and you will soon have so many entries in your homework list that it makes it difficult to read and find a particular entry. We have a special command for you to use and find all the homework entries belonging to a specific module(s).

The format of this command is simple. find-mod [KEYWORDS]. As you can see from the diagram below, after adding a module code as part of a keyword, you will be able to see only homework from the module in the homework list.

As you can see from the diagram above, even though there are a total of four modules with homework in the module list, only homework from the modules CS1101S is shown after the common find-mod CS1101S is used.

Format: list-hw

In the previous sub-section, we looked at how we can use the command find-mod to display homework entries from selected module codes. Now, you are probably wondering now how to display a full list of modules.

To display the full list, simply use this command list-hw. This command has no additional inputs for you to type and that makes this simple and easy to use!

Imagine yourself sitting in CS2103T Week 7 lecture, and the Professor have just covered an important concept which you would like to take some notes on. Let Notes Manager handle that for you by storing your notes digitally for you!

To use this command we have to follow this format: add-note mc/MODULECODE n/NOTENAME

First, we will need to be in the Note Manager. To open Notes Manager, enter open Notes Manager into the Command Box (red). You will see the Result Box (green) prompting that the Notes Mananger is opened.

In this case, we need to add a new note. We will need to enter the following command into the Command Box: add-note mc/CS2103T n/Week 7 Lecture.

The new note will be added to the bottom of the list.

Format: delete-note

As the semester comes to an end, we would like to clean up the notes by removing some of the notes which we no longer need. Here’s where delete-note comes in handy!

To use this command we have to follow this format: delete-note INDEX. This will delete the note at the specified index. The index must be a positive integer (1, 2, 3,…​) and it must refer to an existing index number shown in the displayed Notes List.

Say, we would like to delete the note we added from CS2103T Week 7 Lecture. It has an index of 12 in the list.

As such, we will need to enter the following command: delete-note 12.

Viola! The note is deleted.

As the semester progresses, there will be more notes taken for various module activities (lectures, tutorials, labs). Wouldn’t it be easier if we can search for our notes based on a keyword? With find-note, we will be able to find our notes easily with the usage of keywords!

The format of this command: find-note [KEYWORDS].

Let’s say you are looking for a tutorial note. We will enter find-note tutorial in the Command Box (red). The resulting list will be displayed in the Notes List (light blue box).

In v2.0, we will be able to search for notes by its module code and note name.

In the previous sub-section, we looked at how we can use the command find-note to display notes from selected keywords. Now, you are probably wondering now how to display a full list of modules.

To display the full list, simply use this command list-note. This command has no additional inputs for you to type and that makes this simple and easy to use!

Format: add-cap mc/MODULECODE g/MODULEGRADE mcs/MODULECREDITS sem/MODULESEMESTER

Let’s assume it’s the end of the semester and you just got your grades back. Simply add your modules to the Cap Manager with the add-cap command to view your updated CAP!

Examples:

Let’s assume you would like to add the module, CS2101 into the CAP Manager. Given that you got B+, and that CS2101 is worth 4 Modular credits and you took the module in Year 2 Semester 2, the command to input to the Command Box would be:

Before adding

After entering add-cap mc/CS2101 g/B+ mcs/4 sem/Y2S2 into the command box.

And just like that your CAP Manager will now include the module you just added! Your CAP score will also be updated right away! In addition, the semester list will also be updated if you are adding a module that is newly taken.

Format: edit-cap INDEX [mc/MODULECODE] [g/MODULEGRADE] [mcs/MODULECREDITS] [sem/MODULESEMESTER]

If you made a mistake in entering the information for any particular CAP entry, do not worry! edit-cap command can easily fix that.

Examples:

Let’s assume you had actually gotten A+ for the module CS2101 and you took the module in Y3S1 instead.

Given this scenario, the command to input to the Command Box would be:

Let’s put it to use!

Before editing:

After editing:

Just like that, all changes you have made will be reflected straightaway in the CAP manager. This of course includes the module list, semester list and your CAP score!

Format: edit-cap-mc MODULECODE [mc/MODULECODE] [g/MODULEGRADE] [mcs/MODULECREDITS] [sem/MODULESEMESTER]

UltiStudent understands the large amount of modules students have to take as such, to bring more convenience, CAP Manager now allows you to edit the parameters of any modules through their module code instead of the index number for more convenience!

Just like the edit-cap command, edit-cap-mc edits the parameters of the modules in CAP Manager! For the sake of brevity, you can refer to the functionality and the effects by referring to the edit-cap command.

Format: delete-cap INDEX

If you ever do need to delete a module in the CAP Manager, you may use this command to easily delete that module. The format for this command is that of delete-cap INDEX.

Examples: For example, if you would like to delete the module ST2334 from CAP Manager, simply look for its index number. and apply it to the format! In this case, we would enter:

Before deleting: image::EditedCapManager.png[width="700"]

After entering the delete command:

With that the module has been deleted. Once again, your CAP will be updated rightaway in the CAP Indicator!

Format: find-sem MODULESEMESTER …​

Here at UltiStudent, we understand that students have many modules and it can become difficult to find and filter through the many modules that they take. To help you with this, the find-sem will be handy!

Let’s say you would like to view all the modules that you took in Year 1 Semester 2. Simply type find-sem Y1S2 into the Command Box and the module list will be updated rightaway to show the modules ou took in the semester you entered!

Format: list-cap In the previous sub-section, we saw how using the find-sem command can help us to filter through the entire CAP Manager and only see the modules of the semesters we are interested in. Now let’s see how we can view all of our modules again!

The list-cap command will help you to view your full list of modules in the CAP Manager. All you have to do is enter list-cap into the command box and you will see all the modules you have taken.

Accidentally made any mistake by entering a command with unintended effects? Don’t worry! Simply type undo and you will undo your latest changes in any of our managers.
Format: undo

Examples:

Made an extra undo by mistake? Fear not! You can simply revert any of your undos by using our redo command.
Format: redo

Examples: