User Guide

Introduction

Do you even find yourself struggling to manage all the different kinds of module information that you have to track? Are there too many modules, contacts, tasks and events to remember? Well, do not worry, CAP5Buddy is here to help.

CAP5Buddy is a desktop application that helps NUS SoC students to keep track of their module details efficiently. It helps you to centralize key module details, contacts and information while following your study progress. It is optimized for use via a Command Line Interface (CLI), while still having the benefits of a Graphical User Interface (GUI). If you can type fast, CAP5Buddy can help you manage your module details and information more efficiently than traditional GUI apps.

• Introduction
• Quick start
• Navigating the GUI
  • Key Components
    • Help Window
    • Additional information Display Panel
    • Calendar
    • Command Box
    • Results Display Panel
    • Main Item Display Panel
    • List Tabs Panel
• Features
  • Module Tracker Features
    • Adding a new module: addmodule
    • Adding a new completed module: addcmodule
    • Viewing a module: viewmodule
    • Archiving a module: archivemodule
    • Un-archiving a module: unarchivemodule
    • View-archived modules: viewarchive
    • View un-archived modules: listmodule
    • Locating modules: findmodule
  • Zoom link management feature
    • Zoom link command parameters
    • Adding a zoom link for a specific lesson to a module: addzoom
    • Editing a zoom link of a specific lesson in a module: editzoom
    • Deleting a zoom link for a specific lesson from a module: deletezoom
    • Deleting a module: deletemodule
    • Editing a module : editmodule
    • Clearing the module list: clearmodule
    • What is an Assignment ? : Assignment
    • Adding assignment to a module: addassignment
    • Editing an assignment in a module: editassignment
    • Deleting an assignment in a module: deleteassignment
    • Adding a grade to a module: addgrade
    • Calculating Cumulative Average Point(CAP): calculatecap
    • Calculating target CAP details: targetcap
  • Todo List Features
    • What is a Task ? : Task
    • Adding a task: addtask
    • Deleting a task: deletetask
    • Editing a task: edittask
    • Locating tasks: findtask
    • Marking a task as completed: completetask
    • Resetting a task: resettask
    • Sorting tasks: sorttask
    • Listing all tasks: listtask
    • Clearing the list: cleartask
  • Contact List Features
    • Contact command parameters
    • Adding a contact: addcontact
    • Locating contacts: findcontact
    • Listing all contacts: listcontact
    • Editing a contact: editcontact
    • Deleting a contact: deletecontact
    • Sorting contacts: sortcontact
    • Marking contacts as important: importantcontact
    • Resetting contacts: resetcontact
    • Clearing the contact list: clearcontact
  • Scheduler Features
    • Adding an Event to the Scheduler: addevent
    • Deleting an Event from the Scheduler: deleteevent
    • Editing an Event from the Scheduler: editevent
    • Finding an Event from the Scheduler: findevent
    • List events: listevent
  • General Features
    • Undo previous user command: undo
    • Redo previous user command: redo
    • Exiting the application: exit
    • Getting help : help
• FAQ
• Command Summary for Module Tracker
• Command Summary for Contact List
• Command summary for Todo List
• Command summary for Scheduler
• Command summary for general features

Quick start

1. Ensure you have Java 11 or above installed in your Computer.

2. Download the latest CAP5Buddy.jar from here.

3. Copy the file to the folder you want to use as the home folder for the CAP5Buddy application.

4. Double-click the file to start the app. The GUI similar to the one below should appear in a few seconds.
   

Navigating the GUI

Key Components

Help Window

You can click this button to open up the User Guide help window.

Additional information Display Panel

This panel displays all the additional information of each item when a view Command is called.

Calendar

This is where you can view your calendar, it is as accurate as a built-in calendar and it also displays those days that have an existing event with a color coded box.

Command Box

Here is where you enter your command input to be executed by the application.

Results Display Panel

This panel will display the status of the command, whether it passes or fails, and displays some basic information or error message.

Main Item Display Panel

Here is where all of the items that are added into the application can be found. It shows all the items as individual cell boxes.

List Tabs Panel

From here, you can choose between the different windows to view.

Features

Some common symbols that can be found in the user guide and their meanings:

• Represents useful information that should be noted.

• Represents a useful tip.

• Represents a warning that users should be aware of.

Module Tracker Features

Adding a new module: addmodule

Creates and add a new module to be stored in the system.

Format: addmodule n/MODULE_NAME [t/TAG]...

• You can only key in the module code for the MODULE_NAME. Invalid module codes, such as CS2103TT will not be accepted.

• The module code you input must be capitalised, eg. cs2103t will be rejected while CS2103T is correct.

Example :

• addmodule n/CS2103T creates and adds the module CS2103T.

Expected Outcome:

Other helpful example(s):

• addmodule n/CS2103T t/Coremodule creates and adds the module CS2103T with the tag CoreModule.

Adding a new completed module: addcmodule

Creates and add a new completed module to be stored in the system.

Format: addcmodule n/NAME mc/MODULAR_CREDITS gp/GRADE_POINT [t/TAG]...

• Using this command to add a completed module will automatically tag the module as completed.
• Completed modules can be modified using editmodule. Do note that editing tags will reset all existing tags, therefore in order to keep the completed tag after editing, you must specify the completed tag parameter in the editmodule command by adding t/completed to your command line exactly.
• Completed modules added this way will be used for CAP calculation purposes.

Examples:

• addcmodule n/CS2103T mc/4.0 gp/5.0 creates and adds the module named CS2103T with 4 modular credits and 5 grade points with a completed tag.
• addcmodule n/CS2101 mc/2.0 gp/4.5 t/year1 creates and adds the module named CS2101 with 2 modular credits and 4.5 grade points with the tags completed and year1.

Viewing a module: viewmodule

Displays a snapshot of a module stored in the system.

Format: viewmodule INDEX

• The module viewed will be at the INDEX position of the current displayed list.

• The index refers to the index number of the module shown on the displayed module list.

• The index must be a positive integer 1, 2, 3…

• Clicking on the ZoomLink displayed(if any) will copy the ZoomLink into your clipboard.

• Note that the displayed snapshot is not updated when the module being displayed is changed.

Example:

• viewmodule 1 views the first module in the displayed list.

Expected Outcome:

Archiving a module: archivemodule

Archives a module in the module list and moves it into archived storage.

Format: archivemodule INDEX

• The module archived will be at the INDEX position of the currently displayed un-archived list.

• The index refers to the index number of the module shown on the displayed un-archived module list.

• You can only call this command when viewing the un-archived module list.

• The index must be a positive integer 1, 2, 3…

Example:

• archivemodule 1 Archives the first module in the displayed list.

Expected Outcome:

Other helpful example(s):

* `archivemodule 2` Archives the second module in the displayed list.

Un-archiving a module: unarchivemodule

Un-Archives a module in the module list and moves it back into current module list storage.

Format: unarchivemodule INDEX

• The module un-archived will be at the INDEX position of the currently displayed archived list.

• The index refers to the index number of the module shown on the displayed archived module list.

• You can only call this command when viewing the archived module list.

• The index must be a positive integer 1, 2, 3…

Examples:

• unarchivemodule 1 Un-Archives the first module in the displayed archived module list.
• unarchivemodule 2 Un-Archives the second module in the displayed archived module list.

View-archived modules: viewarchive

Allows you to view the archived module list on the display.

Format: viewarchive

• Executing this command will remove the current un-archived module list from display if you are currently viewing it. You can use the list command to display the un-archived module list(See next section).

Examples:

• viewarchive Views the archived module list on the display.

View un-archived modules: listmodule

Allows you to view the un-archived module list on the display.

Format: listmodule

• Executing this command will remove the current archived module list from display if you are currently viewing it. You can use the viewarchive command to display the archived module list(See previous section).

Examples:

• listmodule Views the un-archived module list on the display.

Locating modules: findmodule

Finds all modules that fulfil the provided module name search criteria.

Format: findmodule [MODULE_NAME_KEYWORDS...]

• The search is case-insensitive, e.g. cs2030 will match CS2030.

• You are allowed to provide multiple search keywords for the module name parameter.

• When you are providing module name keywords, separate distinct keywords with a whitespace, e.g. findmodule CS2030 CS2100 will search for contacts using the 2 distinct keywords CS2030 and CS2100.

• The order of the search keywords does not matter, e.g. CS2030 CS2100 will match CS2100 CS2030 .

• You should ensure that keywords are not be blank and at least one search parameter should be provided.

• Search Parameters:

  • Name

    • Module with a name matching at least one of the name keywords provided will be considered to have fulfilled the module name search criteria.

    • Module name must match your search criteria exactly for module to be displayed, e.g. cs2030 will match CS2030 but not CS20301.

Example:

• findmodule cs2030 returns the module(if any) with the module name CS2030.

Expected Outcome:

Other helpful example(s):

• findmodule cs2030 cs2100 returns the modules(if any) with the module names CS2030 or CS2100.

Zoom link management feature

The following features allow you to manage the zoom links for your respective modules and perform various zoom link related functions.

The section below provides some useful details about the zoom list management features.

Zoom link command parameters

• ZOOM_LINK:

  • Represents the zoom link of a module

  • All zoom links should adhere to the following constraints:

    • Belong to the NUS domain and have the following format: https://nus-sg.zoom.us/[path]

    • The zoom link path should only contain alphanumeric characters and these special characters: ?=/, and should not be blank

    • Example: https://nus-sg.zoom.us/j/babcyg?pwd=

• LESSON_NAME:

  • Represents the name of a module lesson which contains the zoom link

  • Lesson name should only contain alphanumeric characters, spaces and the hyphen character, and it should not be blank.

  • Example: Lecture-weds

Adding a zoom link for a specific lesson to a module: addzoom

Adds a zoom link for a specific lesson to an existing module.

Format: addzoom INDEX n/LESSON_NAME z/ZOOM_LINK

• Adds a zoom link to the module at the specified INDEX.

• The index refers to the index number of the module shown on the displayed module list.

• The index must be a positive integer 1, 2, 3…

• LESSON_NAME refers to the name of the module lesson which the added zoom link belongs to.

Example:

addzoom 1 n/lecture-weds z/https://nus-sg.zoom.us/j/auya7164hg adds a zoom link https://nus-sg.zoom.us/j/auya7164hg to the first module in the displayed module list for the lesson lecture-weds.

Expected Outcome:

Editing a zoom link of a specific lesson in a module: editzoom

Edits a zoom link of a specific lesson in a module.

Format: editzoom INDEX n/LESSON_NAME z/EDITED_ZOOM_LINK

• Edits the zoom link of the module at the specified INDEX.

• The index refers to the index number of the module shown on the displayed module list.

• The index must be a positive integer 1, 2, 3…

• LESSON_NAME refers to the name of the lesson which the target zoom link to be edited belongs to.

• LESSON_NAME refers to the name of the module lesson which contains the zoom link to be edited.

Example:

editzoom 1 n/lecture-weds z/https://nus-sg.zoom.us/editedZoom edits the zoom link of the lesson lecture-weds in the first module to be https://nus-sg.zoom.us/editedZoom

Expected Outcome:

Deleting a zoom link for a specific lesson from a module: deletezoom

Deletes a zoom link for a specific lesson from an existing module.

Format: deletezoom INDEX n/LESSON_NAME

• Deletes a zoom link from the module at the specified INDEX.

• The index refers to the index number of the module shown on the displayed module list.

• The index must be a positive integer 1, 2, 3…

• LESSON_NAME refers to the name of the module lesson which contains the zoom link to be deleted.

Example

deletezoom 1 n/lecture-weds deletes the zoom link of the lesson lecture-weds from the 1st module in the displayed module list.

Expected Outcome:

Deleting a module: deletemodule

Deletes a module in the displayed module list.

Format: deletemodule INDEX

• The index must be a positive integer 1, 2, 3…

• The index refers to the index number of the module shown on the displayed module list.

Examples:

• deletemodule 1 deletes the module at position 1

Editing a module : editmodule

Edits an existing module in the displayed module list with new details.

Format: editmodule INDEX [n/MODULE_NAME] [mc/MODULAR_CREDITS] [gp/GRADE_POINT] [t/TAG]...

• Edits the details of the module at position INDEX with the optional fields listed.

• The index must be a positive integer 1, 2, 3…

• At least one of the optional fields [MODULE_NAME], [MODULAR_CREDITS] or [GRADE_POINT] must be present.

• You can add [TAG]s to a module through this command,eg. Tutorial.

• You can remove all the contact’s tags by typing t/ without specifying any tags after it.

Examples:

• editmodule 1 n/CS2030 edits the MODULE_NAME for a module at index 1 to CS2030.

• editmodule 3 mc/8 gp/4.5 edits the MODULAR_CREDITS and GRADE_POINT for the module at index 3 to 8.0 modular credits and the grade points to 4.5.

To be implemented:

• We are working on adding the functionality to edit the zoom links for the module for each lesson.

Clearing the module list: clearmodule

Clears all un-archived modules.

Format: clearmodule

• Tips : If you accidentally cleared the whole module list, you can always use the undo command to restore the module list.

What is an Assignment ? : Assignment

Each assignment is stored under a module and represents the cumulative results achieved for that module. Your assignments will contain the following fields:

• ASSIGNMENT_NAME

  • Represents the name of the assignment you are providing, eg. Quiz 1 or Oral Presentation 2.

• ASSIGNMENT_PERCENTAGE

  • Represents the percentage the assignment carries for the final grade, eg. if Quiz 1 is worth 15% of the final grade, the ASSIGNMENT_PERCENTAGE should be 15.0%.

  • Can only be a value from 0.00 - 1.00

• ASSIGNMENT_RESULT

  • Represents your results attained for the assignment, eg. if a score of 75/100 is achieved for Oral Presentation 2, an ASSIGNMENT_RESULT of 0.75 should be input.

Adding assignment to a module: addassignment

Adds an assignment to an existing module.

Format: addassignment n/MODULE_NAME a/ASSIGNMENT_NAME %/ASSIGNMENT_PERCENTAGE r/ASSIGNMENT_RESULT

• Adds an assignment ASSIGNMENT_NAME to a module MODULE_NAME

• The assignment takes up a percentage of the final grade, ASSIGNMENT_PERCENTAGE.

• Your ASSIGNMENT_RESULT can only range from 0.00 - 100

• The changes for your assignment would only be seen through using the viewmodule command.

Example:

• addassignment n/CS2100 a/Quiz 1 %/5 r/80 adds an assignment called Quiz 1 to the module CS2100. Quiz 1 carries 5% of the final grade and the result for this assignment is 80.

Expected Outcome:

Editing an assignment in a module: editassignment

Edits an assignment at the specified position in the specified module.

Format: editassignment INDEX n/MODULE_NAME [a/ASSIGNMENT_NAME] [%/ASSIGNMENT_PERCENTAGE] [r/ASSIGNMENT_RESULT]

• The fields that can be edited are the ASSIGNMENT_NAME, ASSIGNMENT_PERCENTAGE of the final grade and ASSIGNMENT_RESULT.

• At least one of the optional fields must be present.

• The index must be a positive integer 1, 2, 3…

• Your new ASSIGNMENT_RESULT can only range from 0.00 - 100

• The viewmodule command needs to be called again to update the assignment visually.

Examples of usage:

• editassignment 1 n/CS2100 a/Quiz 1 edits the assignment at position 1 of the module CS2100 with a new assignment name, Quiz 1.

• editassignment 1 n/CS2100 %/20 r/80 edits the assignment at position 1 of the module CS2100 with a new assignment percentage, 20% of the final grade, and a new assignment result, 80.

To be implemented:

• We are working on showing the assignment changes without the need to call viewmodule again as we see the possible hassle involved.

Deleting an assignment in a module: deleteassignment

Deletes an assignment at the specified position in the specified module.

Format: deleteassignment INDEX n/MODULE_NAME

• You can retrieve the index of the assignment list by using the viewmodule command to list out the details of the module.

• The index must be a positive integer 1, 2, 3…

• The changes for your assignment would only be seen through using the viewmodule command.

Example of usage:

• deleteassignment 1 n/CS2100 deletes the assignment at position 1 of the module CS2100.

Adding a grade to a module: addgrade

Adds a grade to the specified module.

Format: addgrade n/MODULE_NAME g/GRADE

• The MODULE_NAME must match exactly with an existing module in the module list.

• The GRADE can only range from 0 - 100.

• The existing GRADE will be overwritten by the new GRADE being added.

• The changes for your assignment would only be seen through using the viewmodule command.

Example of usage:

• addgrade n/CS2100 g/85 adds a grade of 85 to the module CS2100.

Expected Outcome:

Calculating Cumulative Average Point(CAP): calculatecap

Calculates your CAP based on completed modules

Format: calculatecap

Examples:

• calculatecap calculate the user’s cap

Calculating target CAP details: targetcap

Calculates helpful CAP details based on the target CAP you input

Format: targetcap [tc/TARGET_CAP]

• The target cap refers to the desired CAP input by you

Example:

• targetcap tc/4.5 Calculates CAP achievement required for planned modules in order to achieve target CAP

Todo List Features

The GUI for TodoList is shown below

Todo List can store all of your tasks that you need to complete. Before you start learning how to use the commands for Todo List, you should first understand the details of a task.

What is a Task ? : Task

A task contains 5 type of information that can be useful when you are tying to track all the things that you need to do. Below are the explanations for each information that you can add to a task.

• TASK_NAME

  • Represents the name of the task which can be a short description.

  • Can only consist of 30 characters.

  • Tips : You can set the TASK_NAME to be short and clear, for instance, you can name the task as “Finish Lab09”. this way, you can read through the list much faster.

• TAG

  • Represents a single-word (tag) that can help describe the type of the task.

• PRIORITY

  • Represents how important the task is.

  • You can choose 4 pre-defined priority level, which are,

    • HIGHEST
    • HIGH
    • NORMAL
    • LOW

• DATE

  • You can use DATE based on your need, for instance, you can set the `DATE as the deadline of a task or a target deadline that is earlier than the real deadline. It’s all up to you.

• STATUS

  • Represents the progress status of a task.

  • Only have two value which are Completed or Note Completed.

  • When you create a new task, it will have a status of Not Completed by default.

Adding a task: addtask

Adds a task to the list.

Format: addtask n/TASK_NAME [t/TAG]... [p/PRIORITY] [d/DATE]

• All fields except TASK_NAME are optional.

• The order of the input does not matter.

• TASK_NAME should not be longer than 30 characters.

• You can provide more than one TAG e.g. t/LAB t/DAILY.

• You can choose 3 level of PRIORITY i.e. HIGH, NORMAL, LOW.

• Input for PRIORITY is not case-sensitive e.g. highest, Highest work fine.

• Date must be in the form of YYYY-MM-DD e.g. 2020-12-20.

Examples:

• addtask n/read book t/DAILY t/HOBBY p/low d/2020-10-10 adds a task with the given input.

• addtask n/finish assignemnt t/SCHOOL d/2020-12-10 adds a task with the given input.

Expected output:

Deleting a task: deletetask

Deletes a task from the list.

Format: deletetask INDEX

• You can get the INDEX from the current displayed list under the Tasks tab.

• Index must be a positive integer.

Examples:

• deletetask 1 deletes the first task in the list.

• deletetask 2 deletes the second task in the list.

Editing a task: edittask

Edits a task in the list.

Format: edittask INDEX [n/TASK_NAME] [t/TAG]... [p/PRIORITY] [d/DATE]

• You can get the INDEX from the current displayed list under the Tasks tab.

• INDEX must be a positive integer.

• The order of the input does not matter.

• At least one field must not be empty.

• TASK_NAME should not be longer than 30 characters.

• Editing the TAG will overwrite all the current TAGs.

Examples:

• edittask 1 n/read chapter 5 p/HIGH edits the first task name to read chapter 5 and and the priority to HIGH.

• edittask 2 n/read tutorial d/2020-11-04 edits the second task name to read tutorial and and the DATE to 2020-11-04.

Locating tasks: findtask

Finds all tasks that fulfil all the provided search criteria.

Format: findtask [n/NAME_KEYWORDS] [d/DATE] [p/PRIORITY] [s/STATUS] [t/TAG_KEYWORDS]

• The search is case-insensitive, e.g. lab will match Lab.

• When you are providing name or tag keywords, separate distinct keywords with a whitespace, e.g. findtask n/lab quiz will search for tasks using the 2 distinct keywords lab and quiz.

• You should ensure that search arguments are not blank and at least one search parameter should be provided.

• Search Parameters:

  • Name

    • You are allowed to provide multiple name keywords.

    • Tasks with their name matching at least one of the name keywords provided will be considered to have fulfilled the task name search criteria.

    • The order of the search keywords does not matter, e.g. Lab Quiz will match Quiz Lab.

    • Only full words will be matched, e.g. lab will match lab assignment but not labs.

  • Date

    • Your search date should be of the format: YYYY-MM-DD.

    • You should only provide one search date, i.e. d/2020-01-01 2020-02-02 would not be accepted.

    • Tasks with their date matching the search date exactly are considered to have fulfilled the task date search criteria.

  • Priority

    • Your search priority should be one of the following: highest, high, normal, low (case-insensitive). No other search priority will be allowed.

    • You should only provide one search priority, i.e. p/highest low is not allowed.

    • Tasks with their priority matching the search priority exactly are considered to have fulfilled the task priority search criteria.

  • Status

    • Your search status should be one of the following: completed, incomplete (case-insensitive).

    • You should only provide one search status, i.e. s/completed incomplete is not allowed.

    • Tasks with their status matching the search status exactly are considered to have fulfilled the task status search criteria.

  • Tag

    • You are allowed to provide multiple tag keywords.

    • The tag keyword provided should conform to the tag constraint, i.e. should be alphanumeric and should not be blank or contain whitespaces.

    • Task tags will be considered a match only if the tag words are an exact match (case-insensitive), e.g. a tag with the word hard will match a tag with the word HARD, but will not match a tag with the word harder.

    • Tasks containing tags which match at least one of the tag keywords provided will be considered to have fulfilled the task tag search criteria.

• Only tasks matching all search criteria provided will be returned.

Example:

findtask

Expected Outcome:

Other helpful examples:

• findtask d/2020-10-10 p/high returns all tasks with the date 2020-10-10 and high priority

• findtask t/difficult online returns all tasks that have the difficult or online tag

• findtask n/lab quiz t/difficult returns all tasks with their name containing either the word lab or quiz and has difficult as one of its tags

Marking a task as completed: completetask

Labels a task as Completed.

Format: completetask INDEX

• You can get the INDEX from the current displayed list under the Tasks tab.

• INDEX must be a positive integer.

• Tips : You can change back the status to Not Completed by using either the undo or resettask command.

Examples:

• completetask 1 labels the first task in the list as Completed.

• completetask 2 labels the second task in the list as Completed.

Resetting a task: resettask

Reset the status of a task back to Not Completed.

Format: resettask INDEX

• You can get the INDEX from the current displayed list under the Tasks tab.

• INDEX must be a positive integer.

Examples:

• resettask 1 reset the first task in the list.

• resettask 2 reset the second task in the list.

Sorting tasks: sorttask

Sorts the list based on a criterion.

Format: sorttask [r] CRITERION

• r indicates if the sorted list should have reversed order, for example, if sorttask priority sorts the list from the highest priority to the lowest priority then sorttask r priority will sort the list from the lowest to the highest priority instead.

• r is optional.

• CRITERION is pre-defined, you can choose NAME, PRIORITY, or DATE.

• CRITERION is not case-sensitive e.g priority, PRIORITY work fine.

Examples:

• sorttask date sorts the task from the task with the closest date to the current date to.

• sorttask r date sorts the task from the task with the farthest date from the current date.

Listing all tasks: listtask

List all the tasks on the list and resets ordering.

Format: listtask

• Tips : You can use listtask to go back to the original list after performing a findtask or sorttask command.

Clearing the list: cleartask

Clears all tasks in the list.

Format: cleartask

• Tips : If you accidentally cleared the whole list, you can always use the undo command to restore the list.

Contact List Features

The following features allow you to manage a list of contacts and perform various contact related functions.

The section below provides some useful details about the contact list features.

Contact command parameters

A contact list feature can use one or more of the following parameters:

• NAME:

  • Represents the name of a contact

  • Can only contain alphanumeric characters and spaces, and should not be blank.

  • Examples: John, Amy

  • All contacts must have a name

• EMAIL:

  • Represents the email address of a contact

  • Emailshould be of the format local-part@domain and adhere to the following constraints:

    1. The local-part should only contain alphanumeric characters and these special characters: !#$%&'*+/=?{|}~^.-

    2. This is followed by a @ and then a domain name.

    3. The domain name must:

       • Be at least 2 characters long
       • Start and end with alphanumeric characters
       • Consist of alphanumeric characters, a period or a hyphen for the characters in between, if any.

  • Example: johndoe@gmail.com

  • All contacts must have an email address

• Telegram:

  • Represents the telegram username of a contact

  • The TELEGRAM field provided must be a valid telegram username that follows the following constraints:

    1. Must start with the @ symbol
    2. At least 5 characters long, not including the @ symbol
    3. Contains only alphanumeric characters or underscore

  • Examples: @john_doe, @johndoe

  • Telegram is a not a compulsory field of a contact

• Tag:

  • Represents a tag that can be used to describe a contact

  • Tags names should be alphanumeric and should not be blank or contain whitespaces.

  • Examples: friend, TA

  • Tag is not a compulsory field of a contact

Adding a contact: addcontact

Adds a new contact into the contact list if it does not already exist.

Format: addcontact n/NAME e/EMAIL [te/TELEGRAM] [t/TAG]...

• A contact can have any number of tags (including 0)

Example:

addcontact n/Amy e/Amy@gmail.com te/@Amytele t/friend adds a new contact with the name Amy, email Amy@gmail.com, telegram @Amytele and a tag friend

Expected Outcome:

Locating contacts: findcontact

Finds all contacts that fulfil all the provided search criteria.

Format: findcontact [n/NAME_KEYWORDS] [t/TAG_KEYWORDS]

• The search is case-insensitive, e.g. bob will match Bob.

• You are allowed to provide multiple search keywords for both the name and tag parameter.

• The order of the search keywords does not matter, e.g. Bob Abramham will match Abraham Bob.

• When you are providing name or tag keywords, separate distinct keywords with a whitespace, e.g. findcontact n/bob abraham will search for contacts using the 2 distinct keywords bob and abraham.

• You should ensure that keywords are not be blank and at least one search parameter should be provided.

• Search Parameters:

  • Name

    • Contacts with their name matching at least one of the name keywords provided will be considered to have fulfilled the contact name search criteria.

    • Only full words will be matched, e.g. Bob will match Bob Abraham but not Bobs.

  • Tag

    • Contacts containing tags which match at least one of the tag keywords provided will be considered to have fulfilled the contact tag search criteria.

    • Contact tags will be considered a match only if the tag words are an exact match (case-insensitive), e.g. a tag with the word friend will match a tag with the word FRIEND, but will not match a tag with the word friendly.

    • The tag keyword provided should conform to the tag constraint, i.e. should be alphanumeric and should not be blank or contain whitespaces.

• Only contacts matching all search criteria provided will be returned.

Example:

findcontact n/amy finds all contacts with the word amy in their name

Expected Outcome:

Other helpful examples:

• findcontact n/Bob Abraham returns all contacts with the word Bob or Abraham in their name, e.g. Bob Lim, Tommy Abraham

• findcontact t/friend coworker returns all contacts that have the friend or coworker tag

• findcontact n/john t/friend returns all contacts with the word john in its name and has friend as one of its tags

Listing all contacts: listcontact

Shows a list of all contacts in the contact list.

Format: listcontact

Example: listcontact

Expected Outcome:

Editing a contact: editcontact

Edits an existing contact in the contact list.

Format: editcontact INDEX [n/NAME] [e/EMAIL] [te/TELEGRAM] [t/TAG]...

• Edits the contact at the specified INDEX. The index refers to the index number of the contact shown in the displayed contact list. The index must be a positive integer 1, 2, 3…

• At least one of the optional fields must be provided.

• Existing values will be updated to the input values.

• If the contact has an existing telegram field, you can remove it by typing te/ without specifying any telegram field after it, i.e. editcontact 1 te/

• When editing tags, the existing tags of the contact will be removed i.e adding of tags is not cumulative.

• You can remove all the contact’s tags by typing t/ without specifying any tags after it, i.e. editcontact 1 t/

Example:

editcontact 2 n/amy lee e/amy-lee@gmail.com t/classmate edits the second contact in the displayed contact list with the name amy lee, email amy-lee@gmail.com and tag classmate

Expected Outcome:

Deleting a contact: deletecontact

Deletes the specified contact from the contact list.

Format: deletecontact INDEX

• Deletes the contact at the specified INDEX.

• The index refers to the index number of the contact shown on the displayed contact list.

• The index must be a positive integer 1, 2, 3…

Example:

deletecontact 2 deletes the second contact in the displayed contact list

Expected Outcome:

Sorting contacts: sortcontact

Sorts the list based on the name of the contact lexicographically.

Format: sortcontact [r]

• r indicates if the sorted list should have reversed order.

• r is optional.

Examples:

• sortcontact might produce a list of {michael, sasha}.

• sortcontact r might produce a list of {sasha, michael}.

Marking contacts as important: importantcontact

Marks a task as Important.

Format: importantcontact INDEX

• You can get the INDEX from the current displayed list under the Contacts tab.

• INDEX must be a positive integer.

• Tips : You remove important mark from contact by using either the undo or resetcontact command.

Examples:

• importantcontact 1 marks the first contact in the list as Important.

• importantcontact 2 mark the second contact in the list as Important.

Resetting contacts: resetcontact

Removes a contact’s important mark and replaces it with Not Important (default).

Format: resetcontact INDEX

• You can get the INDEX from the current displayed list under the Contacts tab.

• INDEX must be a positive integer.

Examples:

• resetcontact 1 marks the first contact in the list as Not Important.

• resetcontact 2 mark the second contact in the list as Not Important.

Clearing the contact list: clearcontact

Clears all contacts in the contact list.

Format: clearcontact

Example: clearcontact

Expected Outcome:

Scheduler Features

Adding an Event to the Scheduler: addevent

Creates and add a new Event with the specified information from the user input

Format: addevent n/EVENT_NAME d/DATE_TIME [t/TAG]

Examples: * addevent n/CS2100 Assignment 1 d/10-9-2020 1200 t/Important adds an Event called C2100 Assignment 1 with the deadline of 10-9-2020 1200 and the tagging of Important.(Expected result shown in above image.) * addevent n/CS2103T exams d/12-12-2020 1200 adds an Event called CS2103T into the Scheduler with the date 12-12-2020. * addevent n/CS2103T exams d/12-12-2020 1200 t/Important adds an Event called CS2103T into the Scheduler with the date 12-12-2020 and the tag of Important. * addevent n/CS2103T exams d/12-12-2020 1200 t/Important t/Urgent adds an Event called CS2103T into the Scheduler with the date 12-12-2020 and the tag of Important and Urgent.

Deleting an Event from the Scheduler: deleteevent

You can delete an existing event from the list by specifying the index.

Format: deleteevent index

Example: * deleteevent 1 deletes the event of index 1 from the EventList.

Editing an Event from the Scheduler: editevent

You can select an existing event from the list and modify the information such as event name and the event date.

Format: editevent index [n/new name] [d/new date]
Note: All fields are optional but at least 1 of them must be present.

Examples: * editevent 1 n/CS2103T assignment d/2-4-2020 1200 t/NotImportant edits the event of index 1 with the new name of CS2103T, new date and time of 2-4-2020 1200 and the new tag of NotImportant. (Expected result shown in above image.) * editevent 1 n/CS2100 edits the event of index 1 with the new name of CS2103T. * editevent 1 d/3-3-2020 1300 edits the event of index 1 with the new date time of 3-3-2020 1300. * editevent 1 t/NotImportant edits the event of index 1 with the new tag of Not Important.

Finding an Event from the Scheduler: findevent

You can search for a particular event based on the name and date. This will return you a list of all events that have these keywords.

Format: findevent [n/EVENT_NAME] [d/DATE_TIME] Note: All fields are optional but at least 1 of them must be present.

Examples: * findevent n/CS2103T finds all events that have CS2103T in their event name. * findevent d/1-1-2020 1200 finds all event that have the date and time of 1 Jan 2020 12:00.

List events: listevent

Allows you to view all events.

Format: listevent

Examples:

• listevent Views the event list on the display.

General Features

Undo previous user command: undo

Undoes the previous user command

Format: undo

• The undo feature currently has not been extended to Scheduler commands

Example:

• undo

Redo previous user command: redo

Redoes the previously undone user command

Format: redo

• The redo feature currently has not been extended to Scheduler commands

Example:

• redo

Exiting the application: exit

Exits CAP5Buddy

Format: exit

Example:

• exit

Getting help : help

Opens the help window

Format: help

Example:

• help

• Tips : If you accidentally cleared the whole list, you can always use the undo command to restore the list.

FAQ

Q: How do you add a module into the program?
A: Run the program and wait for the terminal to start up. Next, type in : “addmodule n/CS2103T” to add a module called CS2103T.

Q: How do you view the zoom links of a particular module?
A: When the program has started running, enter the following in the terminal : “viewmodule 1” to view the zoom link for the first module in the displayed list.

Q: How do you edit a module’s information? A: When the program is running, you can enter the edit command and enter whichever field you want to modify but at least 1 field must be present.

Q: How do I save all the module related information I have entered? A: All information and details entered will be automatically stored and can be accessed the next time you start the application. ——————————————————————————————————————–

Command Summary for Module Tracker

Command Summary for Contact List

Command summary for Todo List

Command summary for Scheduler

Command summary for general features