TutorMate User Guide

About

TutorMate is a desktop app targeted to private tuition teachers on handling tuition related matters.

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, TutorMate can get your administrative tasks done faster than traditional GUI ² apps.

This document describes the main features of TutorMate:

1. Student Management System: track all student details
2. Lesson Schedule: easily plan and manage lessons
3. Task Lists: keep track of tasks to be done for lessons

With a customised student list and schedule in TutorMate just for you, organising lessons and managing students will be the least of your worries.

Users are expected to have a basic level of technical knowledge and are familiar with fundamental computer operations and tasks e.g. how to open command terminal and install application.

This project is based on the AddressBook-Level3 project.

---

Table of Contents

---

Quick Start

1. Ensure you have Java ³ 11 or above installed in your Computer. You can check by opening a command terminal ⁴ and typing java -version.

2. Download the latest tutormate.jar from here.

3. Copy the file to the folder you want to use as the home folder ⁵ for your TutorMate.

4. Open a command terminal ⁴, navigate into the home folder ⁵ using the change directory command cd, and use the java -jar tutormate.jar command to run the application.
   A GUI ² similar to the picture below should appear in a few seconds. Note how the app contains some sample data.
   

5. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.
   Some example commands you can try:

   • list students : Lists all students with their name.

   • In 👨‍🎓 STUDENTS list:

     • add -name Leah : Adds a student named "Leah" to the application.

     • show 3 : Shows the details of the person with the index 3 in TutorMate.

   • exit : Exits the app.

6. Refer to the Features below for details of each command.

7. Refer to the Command Summary below for the summary of all commands.

8. Refer to the Glossary below for definitions of glossary terms.

---

Important Notes

Basic Usage

• The app is split into 3 states: 👨‍🎓 STUDENTS list, 📅 SCHEDULE list (default) and 💼 TASKS list. Each corresponds to the main features of TutorMate.
• Each state has its associated features, while certain features work with all states but has differing functionalities.
• The 👨‍🎓 STUDENTS list handles student details management, 📅 SCHEDULE list handles lessons, scheduling and the tasks for each lesson while the full 💼 TASKS list is a view to display all tasks.
• The GUI ² has several main components (see GUI ² image below):
  • The command box is for users to enter and execute commands.
  • The response box is to display responses for command execution, to indicate success or errors.
  • The left side has the list panel, which shows different list types (student, schedule, tasks).
  • The right side has the details panel, which shows details of any specific item in the list.

Back to Table of Contents

Terminologies / Symbols

• Flag: A flag is a word starting with a dash "-" that is used to identify the type of information that is being provided e.g. -name.

• Text formatted as code snippets are either commands e.g. list schedule, command formats e.g. list [LIST][KEYWORDS] or parameters e.g. NAME.

• This box denotes additional information.
• This box denotes tips to improve usability.
• This box denotes warnings that can cause errors.

This box denotes command outputs.

Back to Table of Contents

Notes on Command Format

Back to Table of Contents

Other Notes

Back to Table of Contents

Parameter Summary

Back to Table of Contents

---

Features

List Feature

The list command is the way to navigate between the 3 states in our app. It will display the specified list and its corresponding details panel.

Format: list [LIST] [KEYWORDS]

• Shows the list and associated detail panel for the specified [LIST].
• The [KEYWORDS] parameter is for specifying which student details to display, and is only valid for 👨‍🎓 STUDENTS list. Specifying the [KEYWORDS] parameter without specifying the [LIST] parameter is not allowed. When used for displaying the 📅 SCHEDULE list and 💼 TASKS list, [KEYWORDS] will be ignored.
• Refer to the parameter constraints here.

For Student:

Example usages:

• list students displays all the students with their names (including previously specified fields).
• list students subjects email displays all the students with their names, the list of subjects for each student and their email.

Success outputs:

• Input: list students (with no additional student details):

Showing list STUDENT

For Schedule:

Example usages:

• list and list schedule displays the 📅 SCHEDULE list with all the lessons with their names in time order.

Success outputs:

• Input: list or list schedule

Showing list SCHEDULE

For Task:

Example usages:

• list tasks displays all the tasks with their description.

Success outputs:

• Input: list tasks

Showing list TASK

• If there are no entries, e.g. there are no students added yet or there are no tasks added yet, an empty list is displayed.

General Examples

Failure outputs:

• Input: list student
  • Error: Should spell students instead of student.
• Input: list task
  • Error: Should spell tasks instead of task.
• Input: list students EMAIL
  • Error: Should spell email in lower case, not EMAIL.
• Input: list students subject
  • Error: Should spell subjects instead of subject.
• Input: list students subjects,phone
  • Error: Use space separation subjects phone for keywords instead of comma separation.

  list: Displays the specified list, which can be a STUDENTS list, SCHEDULE list or TASKS list. Default command without specified list displays the schedule list. When specifying STUDENTS list, optional parameters can be used to specify what student details to display.
  Parameters: [LIST] [KEYWORDS]...
  Example: list schedule
  Example: list students phone email
  Example: list tasks

Back to Table of Contents

Show Feature

The show command has different behaviours depending on the current list. It shows the details of the specified item in the current list in the application.

Format: show INDEX

• The command format is the same for all lists.
• Shows the details of the lesson/task/student at the specified INDEX.
• The INDEX refers to the index number shown in the displayed list.
• The INDEX has to be within the range of the displayed 👨‍🎓 STUDENTS list, 📅 SCHEDULE list or 💼 TASKS list.
• Refer to the parameter constraints here.

For Student:

In 👨‍🎓 STUDENTS list, the show command shows the details of the specified student from the 👨‍🎓 STUDENTS list in the application.

Example usages:

• list STUDENTS followed by show 2 shows the details of the 2nd student in the 👨‍🎓 STUDENTS list.
• find Betsy followed by show 1 shows the details of the 1st student in the results of the find command.

Success outputs:

• Input: show 1

Showing Person: Alex Yeoh; Phone: 87438807; Email: alexyeoh@example.com; Address: Blk 30 Geylang Street 29, #06-40; Subjects: BIOLOGYCHEMISTRY; Tags: [friends]; Remark: To be added

For Schedule:

In 📅 SCHEDULE list, the show command shows the details of the specified lesson from the 📅 SCHEDULE list in the application.

Example usages:

• list SCHEDULE followed by show 2 shows the details of the 2nd lesson in the 📅 SCHEDULE list.
• find lesson1 followed by show 1 shows the details of the 1st lesson in the results of the find command.

Success outputs:

• Input: show 1

Showing Lesson: Start: 1:30 PM; End: 3:30 PM

For Task:

In 💼 TASKS list, the show command shows the details of the specified task from the full 💼 TASKS list in the application.

Example usages:

• list TASKS followed by show 2 shows the description of the 2nd task in the full 💼 TASKS list.

Success outputs:

• Input: show 1

Showing Task: Description: Revise CS2103T Materials

General Examples

Failure outputs:

• Input: show
  • Error: No index given. Enter a valid index!

  Invalid command format!
  show: Shows the details of the item identified by the index number used in the last item listing.
  Parameters: INDEX (must be a positive integer)
  Example: show 1

• Input: show 100
  • Error: Index given exceeds the length of the displayed list. Enter a valid index!

The lesson index provided is invalid

Back to Table of Contents

Add Feature

Adds a student/lesson/task to the 👨‍🎓 STUDENTS list, 📅 SCHEDULE list or the 💼 TASKS list of a lesson in the application.

For Student:

Format: addPerson -name NAME [-phone PHONE_NUMBER] [-email EMAIL] [-address ADDRESS] [-subject SUBJECTS] [-tag TAG] [-remark REMARK]

• A new student cannot have the same name (case-insensitive) as existing students in the 👨‍🎓 STUDENTS list.
• A student can have any number of unique tags (including 0)
• Duplicate phone numbers are allowed, since it is possible for 2 children to use their parent's number.
• Refer to the parameter constraints here.

Example usages:

• addPerson -name John
• addPerson -name John -phone 91234567 -email test@gmail.com -address 10 Kent Ridge Drive -subject MATHEMATICS
• In 👨‍🎓 STUDENTS list :
  • add -name John -phone 91234567 -email test@gmail.com -address 10 Kent Ridge Drive -subject MATHEMATICS

Success outputs:

• Input: addPerson -name John -phone 91234567 -email test@gmail.com -address 10 Kent Ridge Drive -subject MATHEMATICS

New person added: John; Phone: 91234567; Email: test@gmail.com; Address: 10 Kent Ridge Drive; Subjects: MATHEMATICS; Tags: ; Remark: To be added

Failure outputs:

• Input: addPerson
  • Error: No name given. Enter the -name flag with a valid name.

Invalid person format: Flag name not found. 
Usage: addPerson -name NAME (any number of unique [-phone|email|address|subject|tag|remark] VALUE). 
For example, addPerson -name John -phone 91234567
If you are currently displaying student list, you could use 'add' inplace of 'addPerson'. 
Note you must provide a 'name' not already in the address book.

For Schedule:

Format: addLesson -name NAME [-day DATE] [-start TIME] [-end TIME] [-subject SUBJECT]

• A new lesson cannot have the same name as existing students in the contact list.
• Start time cannot be after end time.
• Users can choose to specify the start or end time of a lesson only.
• Refer to the parameter constraints here.

Example usages:

• addLesson -name Chemistry Lesson at Bishan
• addLesson -name Lesson at Tai Seng -start 09:00 -end 11:00 -day 03/21 -subject physics
• In 📅 SCHEDULE list :
  • add -name Lesson at Yishun -day 21 -subject MATHEMATICS

Success outputs:

• Input: addLesson -name Chemistry Lesson at Bishan

New lesson added: Lesson Chemistry Lesson at Bishan

• Input: addLesson -name Lesson at Tai Seng -start 09:00 -end 11:00 -day 03/21 -subject physics

New lesson added: Lesson Lesson at Tai Seng from 9:00 AM to 11:00 AM on 21-03-2023 for PHYSICS

Failure outputs:

• Input: addLesson -name Chemistry Lesson followed by addLesson -name Chemistry Lesson -day 2023/12/12
  • Error: A new lesson cannot have the same name as an existing lesson. Enter another name for the new lesson.

Lesson with this name already exists in the schedule

• Input: addLesson -name English Lesson -start 13:00 -end 10:00
  • Error: The start time specified for a lesson cannot be after its end time. Enter a start time that is before the end time.

Invalid lesson input: End time: 10:00 AM cannot be before start time: 1:00 PM.. 
Usage: addLesson -name NAME (any number of unique [-subject|day|start|end VALUE]). 
 For example, addLesson -name John -subject English -day 23 -start 14:30 -end 16:30
 If you are currently displaying schedule list, you could use 'add' inplace of 'addLesson'. 
 Note you must provide a 'name' not already in the schedule and 'start' must be before 'end'.

For Task:

Format: addTask [INDEX] DESCRIPTION

• Adds the task to the lesson at specified INDEX of the displayed 📅 SCHEDULE list or to the shown lesson (if INDEX is omitted).
• The INDEX has to be within the range of the displayed 📅 SCHEDULE list.
• A new task cannot have the same description as existing tasks in the task list of that specific lesson.
• Refer to the parameter constraints here.

Example usages:

• addTask 1 Make Forces Notes
• With a lesson shown:
  • addTask Mark MYE Practice Paper

Success outputs:

• Input: addTask 1 Make Forces Notes

New task added to lesson with index 1: Make Forces Notes

• Input: addTask Mark MYE Practice Paper

New task added to current lesson: Mark MYE Practice Paper

Failure outputs:

• Input: addTask
  • Error: No lesson index specified and no lesson shown. Missing description.
    Use the show command or add the lesson index you want to add tasks to after addTask. Add description of the task at the end of the command.

Invalid description: Tasks can take any values, and it should not be blank
Usage: addTask + [lesson index] [description]. You could omit the lesson index when adding task to showing lesson.
Example1: addtask 1 do homework

Back to Table of Contents

Delete Feature

Deletes the specified item in the 👨‍🎓 STUDENTS list or 📅 SCHEDULE list of the application.

For Student:

Deletes a student in the 👨‍🎓 STUDENTS list of the application.

Format: deletePerson INDEX

• Deletes the student at the specified INDEX.
• The INDEX refers to the index number shown in the displayed 👨‍🎓 STUDENTS list.
• The INDEX has to be within the range of the displayed 👨‍🎓 STUDENTS list.
• The command is case-insensitive: e.g. deleteperson, deletePerson and DELETEPERSON are all valid.
• Refer to the parameter constraints here.

Example usages:

• deletePerson 1
• In 👨‍🎓 STUDENTS list :
  • delete 1

Success outputs:

• Input: deletePerson 1

Deleted Person: Alex Yeoh; Phone: 87438807; Email: alexyeoh@example.com; Address: Blk 30 Geylang Street 29, #06-40; Subjects: BIOLOGYCHEMISTRY; Tags: [friends]; Remark: To be added

Failure outputs:

• Input: deletePerson
  • Error: No index given. Enter a valid index!

Invalid command format! 
deleteperson: Deletes the entry identified by the index number used in the displayed list.
Parameters: INDEX (must be a positive integer)
Example: delete 1

For Schedule:

Deletes a lesson in the 📅 SCHEDULE list of the application.

Format: deleteLesson INDEX

• Deletes the lesson at the specified INDEX.
• The INDEX refers to the index number shown in the displayed 📅 SCHEDULE list.
• The INDEX has to be within the range of the displayed 📅 SCHEDULE list.
• The command is case-insensitive: e.g. deletelesson, deleteLesson and DELETELESSON are all valid.
• Refer to the parameter constraints here.

Example usages:

• deleteLesson 1
• In 📅 SCHEDULE list : delete 1

Success outputs:

• Input: deleteLesson 1

Deleted Lesson: Lesson lesson1 from 12:30 PM to 2:30 PM on 20-11-2023 for MATHEMATICS

Failure outputs:

• Input: deleteLesson
  • Error: No index given. Enter a valid index!

Invalid command format! 
deletelesson: Deletes the lesson identified by the index number used in the displayed schedule list.
Parameters: INDEX (must be a positive integer)
Example: deletelesson 1

For Task:

Deletes the specified task from the shown lesson in the application. User must be in the 📅 SCHEDULE list and showing a lesson.

Format: deleteTask INDEX

• Deletes the task at the specified INDEX of the task list in the shown lesson.
• The INDEX refers to the index number shown in the displayed task list of the lesson.
• The INDEX has to be within the range of the displayed task list.
• The command is case-insensitive: e.g. deletetask, deleteTask and DELETETASK are all valid.
• Refer to the parameter constraints here.

Example usages:

• In 📅 SCHEDULE list : show 1 followed by deleteTask 2 deletes the 2nd task of the 1st lesson in the 📅 SCHEDULE list.

Success outputs:

• Input: show 1 followed by deleteTask 1

Deleted Task: Revise CS2103T Materials

Failure outputs:

• Input: show 1 followed by deleteTask 100
  • Error: The index given is invalid. Enter a valid task index!

Task index do not belong to any tasks!

• Input: show 1 followed by deleteTask
  • Error: No index given. Enter a valid task index!

Invalid command format! 
deletetask: Deletes the task identified by the task index from the currently displayed lesson.
Parameters: task index (must be a positive integer)
Example: deletetask 1

• Input: deleteTask 1 without showing a lesson
  • Error: No lesson shown. Show a lesson with the show command.

Please use show lessonIndex before deleting task!

Back to Table of Contents

Edit Feature

Edits the specified item in the 👨‍🎓 STUDENTS list or 📅 SCHEDULE list of the application.

For Student:

Format: editPerson [INDEX] [-name NAME] [-phone PHONE_NUMBER] [-email EMAIL] [-address ADDRESS] [-subject SUBJECTS] [-tag TAG] [-remark REMARK]

• Edits the student at the specified INDEX if it is provided, otherwise edits the currently/lastly shown student.
• The INDEX has to be within the range of the displayed 👨‍🎓 STUDENTS list.
• The name of the student after editing cannot be the same (case-insensitive) as other existing students in the contact list.
• You must specify at least one field to edit.
• Refer to the parameter constraints here.

Example usages:

• editPerson 1 -name John
• To edit the currently shown student in 👨‍🎓 STUDENTS list:
  • edit -phone 91234567 -tag jc,express

Success outputs:

• Input: editPerson 1 -name new name -phone 91234567 -tag jc,express

Edit success.
 from: Bernice Yu; Phone: 99272758; Email: berniceyu@example.com; Address: Blk 30 Lorong 3 Serangoon Gardens, #07-18; Subjects: MATHEMATICSENGLISH; Tags: [colleagues][friends]; Remark: sn
 to: new name; Phone: 91234567; Email: berniceyu@example.com; Address: Blk 30 Lorong 3 Serangoon Gardens, #07-18; Subjects: MATHEMATICSENGLISH; Tags: [jc][express]; Remark: sn

Failure outputs:

• Input: editPerson 1
  • Error: No field to edit given. Need to enter at least one field to edit.

No edit detected. Please edit at least one field: name, phone, email, address, subjects, remark, tags to different value.

• Input: editPerson 1 -name David Li (assuming there is already another student named David Li)
  • Error: The name of the student after editing cannot be the same as other existing students in the contact list.

Clash detected.
Edited: David Li; Phone: 91234567; Email: berniceyu@example.com; Address: Blk 30 Lorong 3 Serangoon Gardens, #07-18; Subjects: MATHEMATICSENGLISH; Tags: [jc][express]; Remark: sn
Clashes with: David Li; Phone: 91031282; Email: lidavid@example.com; Address: Blk 436 Serangoon Gardens Street 26, #16-43; Subjects: BIOLOGY; Tags: [family]; Remark: .

• Input: editPerson -phone 91234567 -tag jc,express (assuming no student is currently shown)
  • Error: If editPerson is used without specifying INDEX, then a student must be selected via the show INDEX command.

Using edit command without specifying index when no entry is shown. 
Usage: edit [INDEX] (at least one of unique [-name|phone|email|address|subject|tag|remark VALUE]). 
For example, edit 1 -name John -phone 91234567
If you want to edit the currently shown person, you could omit the index. 
Note your edited 'name' must not already in the address book.

For Schedule:

Format: editLesson [INDEX] [-name NAME] [-start TIME] [-end TIME] [-day DATE] [-subject SUBJECT] (for list specific format)

• Edits the lesson at the specified INDEX if it is provided, otherwise edits the currently/lastly shown lesson.
• The INDEX has to be within the range of the displayed 📅 SCHEDULE list.
• You must specify at least one field to edit.
• The name of the lesson after editing cannot be the same (case-insensitive) as other existing lessons in the schedule list.
• The start time of the lesson after editing cannot be after the end time of the lesson, if the end time is specified, and vice versa.
• The lesson cannot clash (same day, start and end all specified and are overlapping) in time with other lessons in the schedule list.
• Please note that unlike the addLesson command, the editLesson command's "-subject" flag only accepts one subject, not multiple subjects (parameter is SUBJECT, not SUBJECTS).
• Refer to the parameter constraints here.

Example usages:

• editLesson 1 -start 12:35 -end 14:35 -day 2023/11/21 -subject English
• To edit the currently shown lesson in 📅 SCHEDULE list:
  • edit -start 12:30 -end 14:30 -day 2023/11/20 -subject English

Success outputs:

• Input: editLesson 1 -start 12:35 -end 14:35 -subject English

Edit success.
from: Lesson lesson1 from 12:30 PM to 2:30 PM on 20-11-2023 for MATHEMATICS
to: Lesson lesson1 from 12:35 PM to 2:35 PM on 20-11-2023 for ENGLISH

Failure outputs:

• Input: editLesson 1
  • Error: No field to edit given. Need to enter at least one field to edit.

No edit detected. Please edit at least one field: name, start, end, subject, day to different value.

• Input: editLesson -name a new name (assuming no lesson is currently shown)
  • Error: No lesson shown. Show a lesson with the show command.

Using edit command without specifying index when no entry is shown. 
Usage: edit [INDEX] (at least one of unique [-name|subject|day|start|end VALUE]). 
For example, edit 1 -name lesson2 -subject English -day 23/12 -start 14:30 -end 16:30
If you want to edit the currently shown lesson, you could omit the index. 
Note your edited 'name' must not already in the schedule and 'start' must be before 'end'.

• Input: editLesson 1 -start 12:35 -end 14:35 -day 2023/11/21 (assuming there is already another lesson with clashing time)
  • Error: The lesson cannot clash (same day, start and end all specified and are overlapping) in time with other lessons in the schedule list.

Time clash detected.
Edited: Lesson lesson1 from 12:35 PM to 2:35 PM on 21-11-2023 for ENGLISH
Clashes with: Lesson lesson2 from 1:30 PM to 3:30 PM on 21-11-2023 for PHYSICS.

• Input: editLesson 1 -name lesson2 (assuming there is already another lesson named lesson2)
  • Error: The name of the lesson after editing cannot be the same as other existing lessons in the schedule list.

Name clash detected.
Edited: Lesson lesson2 from 12:30 PM to 2:30 PM on 20-11-2023 for MATHEMATICS
Clashes with: Lesson lesson2 from 1:30 PM to 3:30 PM on 21-11-2023 for PHYSICS.

For Task:

Editing of 💼 TASKS list is not supported at this time!

Back to Table of Contents

Find Feature

The find command finds students (in 👨‍🎓 STUDENTS list) or lessons (in 📅 SCHEDULE list) whose names contain the search string ⁷.

Format: find SEARCH_STRING

• The search is case-insensitive. e.g. lesson will match Lesson. hans will match Hans.
• Names does not need to match the search string ⁷, as long as they contain it they will be returned. e.g. search string ⁵ sson Che will return Lesson Chemistry.
• While non-alphanumeric characters are allowed in the search string ⁷, they will likely not return any results as NAME parameter only allows alphanumeric characters.

For Student:

Example usages:

• find bernice
• find a

Success outputs:

• Input: find bernice

1 persons listed!

• Input: find a[s*(|o

0 persons listed!

For Schedule:

Example usages:

• find lesson
• find b

Success outputs:

• Input: find lesson

4 lessons listed!

• Input: find &*af1

0 lessons listed!

For Task:

Finding in 💼 TASKS list is not supported at this time!

General Examples

Failure outputs:

• Input: find or find
  • Error: search string⁷ is empty.

Invalid command format! 
find: Finds all persons or lesson whose names contains the specified search string (case-insensitive) and displays them as a list with index numbers.
Parameter: SEARCH_STRING
Example: find alex yeoh

• Input: find task1 (in 💼 TASKS list)
  • Error: Find command is disabled in task list.

Unknown command

Back to Table of Contents

Filter Feature

For Student:

Format: filter [-name NAME] [-subject SUBJECTS] [-tag TAG] [-remark REMARK]

• Multiple fields can be specified at the same time.
• Refer to the parameter constraints here.
• At least one optional field should be specified.

Example usages:

• filter -name Alex -tag primary -subject Mathematics

Success outputs:

• Input: filter -name Alex -tag primary -subject Mathematics
• Input: filter -name Brian

Filtered student list successfully!

Failure outputs:

• Input: filter -name Alan!
  • Error: The non-alphanumeric character "!" is used. To fix the error, remove all non-alphanumeric characters.

Invalid filter format: Names should only contain alphanumeric characters and spaces, and it should not be blank. 
Usage: filter (any number of unique -[name|subject|tag|remark] [value]). 
For example, filter -name John -subject physics,english

For Schedule:

Format: filter [-name NAME] [-subject SUBJECTS] [-before DATE] [-on DATE] [-after DATE]

• Only one of -before, -on, -after can be used at once. For example, you cannot use both -before and -after in the same filter command.
• The dates specified in -before and -after are exclusive. For example, specifying -before 2023/05/01 will find lessons before but not on 2023/05/01.
• Refer to the parameter constraints here.
• At least one optional field should be specified.

Example usages:

• filter -before 2022/10/10 -subject Mathematics
• filter -name CS2103T Lab

Success outputs:

• Input: filter -before 2023/12/20 -subject Mathematics

Filtered schedule list successfully!

Failure outputs:

• Input: filter -before 2022/10/10 -after 2022/01/01
  • Error: Both the -before and -after flags are specified. Use only one of -before, -after, and -on in the same command.

Invalid filter format: You can only use one of -before, -on, -after at a time. 
Usage: filter -(at least one of unique [-name|subject|before|on|after|remark VALUE]). 
For example, filter -before 2023/10/10 -subject physics
Note you should only use one of -before, -on, -after at a time.

• Input: filter -on 2/2/2
  • Error: The date given is invalid. Please specify a date using the correct format (see here)

Invalid filter format: 2/2/2 is not a valid date, please use yyyy/mm/dd or mm/dd or dd
for example, assume today is 2023/11/3, to add 2023/11/29, could use 29, 11/29, 2023/11/29 or 23/11/29. 
Usage: filter -(at least one of unique [-name|subject|before|on|after VALUE]). 
For example, filter -before 2023/10/10 -subject physics
Note you should only use one of -before, -on, -after at a time.

For Task:

Filtering is not supported in the 💼 TASKS list at this time!

General Examples

Failure outputs:

• Input: filter
  • Error: No fields specified to filter.

Invalid filter format: You must specify at least one unique field to filter!. 
Usage: filter -(at least one of unique [-name|subject|before|on|after VALUE]). 
For example, filter -before 2023/10/10 -subject physics
Note you should only use one of -before, -on, -after at a time.

Back to Table of Contents

Link Feature

You can link lessons to students, and vice versa. For example, if a lesson has a few students, you can link each of the students to the lesson, so that you can quickly see who is attending this specific lesson.

For Both Student and Schedule:

You can be in the 👨‍🎓 STUDENTS list or 📅 SCHEDULE list. Format: link -student STUDENT_NAME -lesson LESSON_NAME

• STUDENT_NAME is the name of the student you would like to link to.
• LESSON_NAME is the name of the lesson you would like to link to.
• Refer to STUDENT_NAME's and LESSON_NAME's constraints here.

Example usages: link -student alex yeoh -lesson lesson1

Success output:

• Input: link -student alex yeoh -lesson lesson1

Linked alex yeoh to lesson1 

Failure outputs:

• Input: link -student alex yeoh -lesson lesson1 twice

The student is already linked to this lesson

• Input: link -student alexxxx -lesson lesson1 (No student with alexxxx in application)

No such student with name alexxxx found

For Student:

Format: linkTo LESSON_NAME

• LESSON_NAME is the name of the lesson you would like to link to.
• Refer to LESSON_NAME's constraints here.

Example usages:

• linkTo CS2103T Lab

Success outputs:

• Input: linkTo CS2103T Lab

Linked Alex Wong to CS2103T Lab

Failure outputs:

• Current state: In the 👨‍🎓 STUDENTS list and no student is selected
• Input: linkTo CS2103T Lab
  • Error: A student is not yet selected. Select a student using show INDEX first.

No student is shown
LinkTo command usage: linkTo LESSON_NAME
Example: linkTo CS2103T lab1
Note: This command is only available when a student is shown

• Current state: In the 👨‍🎓 STUDENTS list and a student is selected
• Input: linkTo CS2109 Lab
  • Error: No such lesson with the name "CS2109 Lab". Make sure the lesson's name is correct and try again.

No such lesson

For Schedule:

Format: linkTo STUDENT_NAME

• STUDENT_NAME is the name of the student you would like to link to.
• Refer to STUDENT_NAME's constraints here.

Example usages:

• linkTo Bernice Yu

Success outputs:

• Input: linkTo Bernice Yu

Linked Bernice Yu to CS2103T Lab

Failure outputs:

• Current state: In the 📅 SCHEDULE list and no lesson is selected
• Input: linkTo Bernice Yu
  • Error: A lesson is not yet selected. Select a lesson using show INDEX first.

No lesson is shown
LinkTo command usage: linkTo STUDENT_NAME
Example: linkTo Alice Pauline
Note: This command is only available when a lesson is shown

• Current state: In the 📅 SCHEDULE list and a lesson is selected
• Input: linkTo Bernice Yong
  • Error: No such student with the name "Bernice Yong". Make sure the student's name is correct and try again.

No such student with name Bernice Yong found

For Task:

This feature is not used for tasks!

Back to Table of Contents

Navigate Feature

After linking students to lessons or vice versa, you can "navigate" between the student and their linked lessons, or the lesson and its linked students. This comes in handy when you want to view the details of students in a lesson, or see what lessons a student has upcoming.

Format: nav

For Student:

Example usages:

• nav

Success outputs:

• Input: nav

Navigated to student's lessons

Failure outputs:

• Current state: In the 👨‍🎓 STUDENTS list and a student is not selected
• Input: nav
  • Error: nav only works when a student is selected. Select a student with the show INDEX command and try again.

No student is currently displayed

• Current state: In the 👨‍🎓 STUDENTS list and a student without any linked lessons is selected
• Input: nav
  • Error: nav only works when a student has linked lessons. Link a lesson with the linkTo command.

This student has no linked lessons

For Schedule:

Example usages:

• nav

Success outputs:

• Input: nav

Navigated to lesson's students

Failure outputs:

• Current state: In the 📅 SCHEDULE list and a lesson is not selected
• Input: nav
  • Error: nav only works when a lesson is selected. Select a lesson with the show INDEX command and try again.

No lesson is currently displayed

• Current state: In the 📅 SCHEDULE list and a lesson without any linked students is selected
• Input: nav
  • Error: nav only works when a lesson has linked students. Link a student with the linkTo command.

This lesson has no linked students

For Task:

This feature is not used for tasks!

Back to Table of Contents

Command History Feature

The command history feature allows you to retrieve previously typed commands into the command text box.

• To start navigating the command history, press the up ⇧ or down ⇩ arrow on your keyboard, which will point and return the most recent command text (for invalid commands, it will retrieve it again since it is also saved, hence it will not change the command text yet).
• Cycle through the command history using the up ⇧ arrow to go back to previous commands, and down ⇩ arrow to go to next commands, going beyond the command history will retrieve the oldest or newest command text for respectively.

Example usages:

• Input: list students, list schedule, list tasks were entered in this order.

1. Pressing up ⇧ arrow will go back in the command history and retrieve: list tasks.
2. Pressing up ⇧ arrow will go further back in the command history and retrieve: list schedule.
3. Pressing down ⇩ arrow will go forward in the command history and retrieve: list tasks.

Back to Table of Contents

Clearing Data

Clears the program data.

Format: clear

Exit Program

Exits the program.

Format: exit

View Help

Shows a message explaining how to access the help page. Click on the button to copy the link, enter it in a web browser to visit our user guide.

Format: help

Saving Data

TutorMate data is saved in the hard disk⁹ automatically after any command that changes the data. There is no need to save manually.

Editing Data File

TutorMate data is saved automatically as JSON¹⁰ files [JAR file location]/data/addressbook.json, [JAR file location]/data/schedulelist.json and [JAR file location]/data/personLessonMap.json. It is possible to update data directly by editing that data file, but we do not recommend doing so. If you insist on modifying the data file directly, be very careful, especially when you modify attributes such as Start and End time of lessons, as any overlapping lesson timings will render the data as invalid. Scenarios like these are not exhaustive.

Back to Table of Contents

---

FAQ

Q: How do I install Java version 11?
A: You can follow the steps here to install Java 11 to your computer.

Q: How do I transfer my data to another Computer?
A: Copy TutorMate's jar file into the folder you want to use as the home folder⁵ in the other computer. Before running the application, copy addressbook.json, personLessonMap.json and schedulelist.json files from the home folder⁵ in your current computer into the home folder⁵ of the other computer. After copying the 3 files, running the application will show the same data. However, do note that the changes made through the application in one computer will not be reflected in the data in another computer.

Q: Can I edit the data in the application through the addressbook.json, personLessonMap.json, schedulelist.json files directly?
A: It is possible. However, it is not advisable for normal users to do so as if the changes made to the data file makes its format invalid, TutorMate will discard all data. Please use the edit command to make changes to your data instead. If you insist on directly modifying data files, please read this caution here.

Q: Can I still use the application without internet connection?
A: Yes, you can. TutorMate is an offline desktop application. The only exception is the help command which provides a URL¹¹ to the user guide.

Back to Table of Contents

---

Known Issues

1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI ² will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.

---

Command Summary

Back to Table of Contents

---

Glossary

Back to Table of Contents