Mod Manager - User Guide

You can open the help window that displays a link to our user guide.

Format:

During a usage session with Mod Manager, you may make mistakes while adding/editing/deleting an entry. It would be nice if you can reverse the effect in a neat way. The undo command is here to give you that convenience.

All of your commands are recorded, so with undo, you can reverse the effect of previous add/edit/delete commands one by one, starting with the most previous command.

As of the current version, you can only use undo to reverse the effects of add/edit/delete commands.

Format:

Example:

Let’s say you are editing a task of module ST2334 with ID number 401. It is the task highlighted with the red box. Don’t bother with the command if you haven’t read the section on Task feature yet. This is just a quick demonstration.

After that, you realize you didn’t mean to make this change, so you type undo.

After you press Enter, the effect will be reverted and the change is undone. The task is back to before your editing.

We understand that you can change your mind right after undo-ing, so we give have the redo command to assist you.

You can reverse the effect of the most previous undo command with redo.

Format:

Example:

Let’s say you have just used undo to a task edit command.

After you press Enter, the previously undone effect will come back.

Listing all commands:

Sometimes, you might forget what commands are available in Mod Manager. To give you a quick reminder of all the command groups provided, we have the cmd all command.

The command groups available in Mod Manager are the words in bold you have seen throughout this document.

These include: facil, mod, task, …​

Format:

Example:

Type cmd all into the Command Box.

Press Enter and you will be able to see all the command groups listed.

Listing commands for a specific feature:

Seeing all the command groups might not be sufficient to remind you of the specific command formats. That’s why there is cmd group. It will list all valid command formats of a group for you, so you can get back to work.

You can use cmd all first to get a glimpse of all the command groups we have.

Format:

Example: cmd group class

You want to know what commands there are in command group class. Type cmd group class into the Command Box.

Hit Enter and you will see the commands associated in the command group class. Since there are quite a few commands there, you might want to scroll down through the list.

During a Mod Manager usage session, you may want to repeat some commands but you feel quite lazy to type again. Therefore, we bring you the ability to use the up/down arrow key on your keyboard to find the past command that you need.

Example:

Let’s say you want to use command "mod view CS2103T" again, but you have already executed 5 more commands ever since. Just simply press the up key on your keyboard a few times and you will see it in the command box.

If you have been pressing up and accidentally bypassed the command you need, just press down until you see it again.

For this feature, you can try out very quickly. Just open Mod Manager, type in a few commands and press up/down like you mean it. That’s the best and only way to truly feel the convenience of Mod Manager.

You can clear all entries from Mod Manager. All the lists of modules, classes, facilitators and tasks that you have will be cleared. Please use this command cautiously, you cannot undo after it!

Format:

Example:

Suppose your semester has ended and you do not want to see any information related to those modules you have taken in that semester anymore. You can type clear as shown below.

After pressing Enter, Mod Manager is empty. All the entries you have are cleared.

You can exit the program. Upon closing the application, the Mod Manager data will be saved automatically in your hard disk.

Format:

You can add a module to Mod Manager.

Format:

Command properties:

Examples:

You can add a module to the module list. To add a module with the module code CS2103T and description Software Engineering, you can type the following command:

mod add /code CS2103T /desc Software Engineering

You can also add a module without description. To add a module with the module code CS2101, you can type the following command:

mod add /code CS2101

You can view a list of all modules.

Format:

Example:

You can view all modules in Mod Manager. To see a list of all modules, you can type the following command:

mod list

You can view all classes, tasks and facilitators for a module.

Format:

Command properties:

Examples:

You can view a module using the index in the module list. To view all classes, tasks and facilitators for the second module in the module list, you can type the following command:

mod view 2

Alternatively, you can view a module using the module code. To view all classes, tasks and facilitators for the module CS2103T, you can type the following command:

mod view CS2103T

You can edit the information of a module.

Format:

Command properties:

Examples:

You can edit a module using the index in the module list. To update the module code of the first module in the module list to CS2113T, you can type the following command:

mod edit 1 /code CS2113T

Alternatively, you can edit a module using the module code. To update the description of the module CS2101 to Effective Communication for Computing Professionals, you can type the following command:

mod edit CS2101 /desc Effective Communication for Computing Professionals

You can also remove the description of a module without specifying any input after the prefix /desc. To remove the description of the third module in the module list, you can type the following command:

mod edit 3 /desc

You can delete a module from Mod Manager. All classes, tasks and facilitators for that module will also be deleted.

Format:

Command properties:

Examples:

You can delete a module using the index in the module list. To delete the second module in the module list, you can type the following command:

mod delete 2

Alternatively, you can delete a module using the module code. To delete the module with the module code CS2103T, you can type the following command:

mod delete CS2103T

You can add a class to a module.

Format:

Command properties:

Example:

You have a CS2103T lecture on Friday from 14:00 to 16:00 at i3-Aud. Before adding that class, Mod Manager looks like what you see in the figure below.

To add that class, you can type:
class add /code CS2103T /type LEC /at FRIDAY 14:00 16:00 /venue i3-Aud.
You will see a new class added to the module CS2103T as shown in the figure below.

You can find classes occurring on a particular day.

Format:

Command properties:

Example:

To know what classes you have on Friday, you can type class find /at friday and you will be able to see the classes in the result display box as shown in the figure below.

You can find the next class that will start soon.

Format:

Example:

After typing class find /next, you will be directed to the module’s page and you will see the class as shown in the figure below.

You can edit the information of the class. The class to be edited is selected by its index in the displayed module’s class list. You can view the module’s class list by using mod view MOD_CODE as stated in section 3.2.3.

Format:

Command properties:

Example:

Let’s say that the venue of the CS2103T lecture you just added changed to Home. You can edit the class by typing class edit 1 /code CS2103T /venue Home. Mod Manager will direct you to the module’s page and it will reflect the updated venue as seen below.

You can delete the class from the module. The class to be deleted is selected by its index in the displayed module’s class list. You can view the module’s class list by using mod view MOD_CODE as stated in section 3.2.3.

Format:

Command properties:

Example:

You can delete the CS2103T lecture by typing class delete 1 /code CS2103T. The class will not appear in the class list under the module CS2103T as seen below.

You can add a task to a module.

Format:

Example: task add /code CS3230 /desc Programming Assignment 2 /on 20/02/2020 /at 23:59

Command properties:

From here on, you will be introduced to Mod Manager’s task ID system.

You can edit a task’s description, its date and time details, or both by providing the correct task ID and the updated information.

Format:

Mod Manager will find the task associated with the module code and task ID number provided and update the information correspondingly. The properties of DESCRIPTION, DATE and TIME are described in the task add command above.

Example: task edit CS2101 344 /desc OP2 /on 08/04/2020

Type the command into the command box. The task to edit in this example is marked by the red rectangle.

After pressing Enter, you will see that the task has been edited.

Since you may want to remove the date and time of a task, Mod Manager provides you a way to do so. Note that if you try to remove the date and time from a task without these values,

Format:

Example: task edit ST2334 401 /on non

Again, press Enter and you will see its date and time has been removed. Its order in the list may be changed due to the sorting property of the task list.

You can delete a task from Mod Manager’s system.

Format:

Example: task delete CS2101 344

Press Enter and the task will be gone from the list.

You can mark the task as done in the module in Mod Manager.

Format:

Command properties:

Example:

You can mark a task as done in the module. To mark the task with task ID ID_NUMBER in module MOD_CODE to be done, you can type in the following command:

task done /code CS2105 /id 224 and hit Enter

The task card has changed to green; which means our task has been marked as done. Hooray! We just completed a task.

You can view a list of all tasks across all modules in Mod Manager. This is great when you need an overview of all tasks that you need to complete at present.

Format:

Example:

By typing the command above, you should see a list of tasks, such as the following:

If you want to find tasks for a specific module in Mod Manager, this is the command for you to use!

Format:

Command properties:

Example:

If you want a list of current tasks for the module CS3230, you can type in the following command:

task module /code CS3230 and hit Enter

It is not compulsory for you to be at the Tasks tab before typing in this command. Mod Manager will automatically redirect you to the Tasks tab if you are currently at another tab.

Previously, we know that we can mark a task as done, so as to organise, manage, and plan our tasks better. Now, with this command, you can see all the tasks that have not yet been finished.

Format: task undone

By typing the command above and hit Enter, you should only see uncompleted tasks, which are in dark red color:

You are browsing through the task list. But there are too many tasks! You suddenly remember a specific task that you want to do, but you can only vaguely remember its description, e.g. something related to assignment.

This command is exactly what you need. In your case, you can find all tasks that contain the word assignment, which may include Programming Assignment, written assignment, Take-home Lab Assignment (note that it can be case-insensitive). If you remember multiple words in your wanted tasks, you may also type in multiple words as you want. Tasks that meet at least one of the keywords you provided will be shown to you.

Format:

Command properties:

Examples:

To find tasks that contain the word oral, assign, or tut in their description, you can type in the following command:

task find oral assign tut and press Enter

Explanation:
- Oral Presentation 2 contains Oral which matches oral (case-insensitive).
- Programming Assignment 2 contains Assignment which matches assign (case-insensitive, and words can be partial match)
- Similarly, Assignment 3 will match assign, and Tutorial will match tut
- As long as a task’s description matches one of the keywords provided, it will be shown.

You can try typing in task find assign tut oral and press Enter. This will return the same list of tasks, since the ordering of the keywords does not matter.

Other examples:

With this command, you can search for all tasks that occur on your specified date, month, or year.

Format:

Command properties:

Example:

You can search for tasks that are due on the submission date of CS2103T for AY19/20 S2 (13 April). To find tasks happening on 13 April, you can type task search /date 13 /month 4 and press Enter. This will return all tasks that are happening on 13 April.

Explanation: the two tasks both have date as 13 and month as 4.

Other examples:

You can add a facilitator to Mod Manager.

Format:

Command properties:

Examples:

You can add a facilitator to the facilitator list. To add a facilitator with the name Akshay Narayan, phone 98765432 and email dcsaksh@nus.edu.sg to the modules CS2103T and CS3243, you can type the following command:

facil add /name Akshay Narayan /phone 98765432 /email dcsaksh@nus.edu.sg /code CS2103T CS3243

You can also add a facilitator to multiple modules by typing the prefix /code multiple times. To add a facilitator with the name Aaron Tan, email tantc@comp.nus.edu.sg and office COM1-0312 to the modules CS1231 and CS2100, you can type the following command:

facil add /name Aaron Tan /email tantc@comp.nus.edu.sg /office COM1-0312 /code CS1231 /code CS2100

You can view a list of all facilitators sorted in alphabetical order.

Format:

Example:

You can view all facilitators in Mod Manager. To see a list of all facilitators sorted in alphabetical order, you can type the following command:

facil list

You can find facilitators by name.

Format:

Command properties:

Examples:

You can search for facilitators by name. To view all facilitators whose name contains Akshay, you can type the following command:

facil find Akshay

You can also search for multiple facilitators or search with partial names. To view a list of facilitators whose name contains yan or tan, you can type the following command:

facil find yan tan

You can edit the information of a facilitator.

Format:

Command properties:

Examples:

You can edit the information of a facilitator using the index in the last shown facilitator list. To update the name and email of the first facilitator in the last shown facilitator list in the Facilitators tab to Akshay and hisnewemail@nus.edu.sg respectively, you can type the following command:

facil edit 1 /name Akshay /email hisnewemail@nus.edu.sg

Alternatively, you can edit the information of a facilitator using the name of the facilitator. To update the office of the facilitator with the name Akshay Narayan to COM2-0203, you can type the following command:

facil edit Akshay Narayan /office COM2-0203

You can also remove the information of a facilitator without specifying any input after the prefix /phone, /email or /office. To remove the phone of the second facilitator in the last shown facilitator list in the Facilitators tab, type the following command:

facil edit 2 /phone

You can delete a facilitator from Mod Manager.

Format:

Command properties:

Examples:

You can delete a facilitator using the index in the last shown facilitator list. To delete the first facilitator in the last shown facilitator list in the Facilitators tab, you can type the following command:

facil delete 1

Alternatively, you can delete a facilitator using the name of the facilitator. To delete the facilitator with the name Akshay Narayan, you can type the following command:

facil delete Akshay Narayan

You can view the calendar for the current week. It displays the tasks and classes you have in the current week.

Format:

Example:

After typing cal view /week this, the calendar for the current week will be displayed to you as shown below. The red cards represent the tasks you have not done, the green cards represent the tasks you have already done and the blue cards represent the classes you have in the current week.

You can view the calendar for next week. It displays the tasks and classes you have in the next week.

Format:

Example:

After typing cal view /week next, the calendar for the next week will be displayed to you as shown below. The red cards represent the tasks you have not done, the green cards represent the tasks you have already done and the blue cards represent the classes you have in next week.

You can find the empty slots from current day to end of the week of the current day. The empty slots are time periods where you do not have classes or tasks.

Format:

Example:

You can get the list of empty slots after typing cal find empty. The list will be displayed in the result display box as seen below. The command will not change the week of the calendar you are viewing.

The full message in the result display box in the above figure is:

You can add tags to a task.

You can add a priority level to a task.

You can receive reminders for deadlines and events the next day.

You can find upcoming tasks, such as assignment submissions and final exams in Mod Manager.

After an add, edit or delete operation, the view will be scrolled to that recently created or modified item, so that you can refer to the information easily. The newly created or modified details will be highlighted and focused so that you know what has been changed. == FAQ