Skip to content

UserGuide.adoc

Latest commit

 

History

History
880 lines (641 loc) · 32.3 KB

UserGuide.adoc

File metadata and controls

880 lines (641 loc) · 32.3 KB

TAble - User Guide

By: AY1920-CS2103-W15-3 Since: Apr 2020 Licence: MIT

1. Introduction

Have you ever had trouble keeping track of your tutorials and students as a TA in NUS? TAble is your handy desktop app, optimized for TAs who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI)! Mark attendance, arrange consults, add module notes, set reminders and more with TAble!

2. Quick Start

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

  2. Download the latest TAble.jar here.

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

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

    Ui

  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.

  6. Some example commands you can try:

    • listStudent : lists all students

    • deleteStudent3 : deletes the 3rd student shown in the current list

    • exit : exits the app

  7. Refer to Section 3, “Features” for details of each command.

  8. Example of the Tutorial and Consult panels.

    ℹ️
    		 The consults that are overdue will appear in red to highlight that these consults are ready to be deleted!
    TutConsult

  9. Example of the Module and ModInfo panels.

    Mods

  10. Example of the Calendar window.

    CalendarWindow

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in addStudent name/NAME, NAME is a parameter which can be used as addStudent name/John Doe.

  • Items in square brackets are optional e.g name/NAME [tag/TAG] can be used as name/John Doe tag/friend or as name/John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [tag/TAG]…​ can be used as   (i.e. 0 times), tag/friend, tag/friend tag/family etc.

  • Parameters can be in any order e.g. if the command specifies name/NAME email/EMAIL, email/EMAIL name/NAME is also acceptable.

Command History

  • Navigate through the past command history by pressing ↑ / ↓ buttons.

    ℹ️
    		 Only successfully executed commands will be added to list of command history.

Autocompletion

  • TAble will suggest the available commands and prefixes based on your current input.

  • Press Tab or Enter to accept the suggestion.

  • Press Esc to cancel and close the suggestion pop-up.

3.1. Viewing help : help

Format: help

  • A window containing the link to our User Guide will appear. Click on the Copy Link button to copy the link to our User Guide.

3.2. Students Feature (Written by Shun De)

3.2.1. Adding a student: addStudent

Adds a student to TAble
Format: addStudent name/NAME matric/MATRIC_NUMBER email/EMAIL [tag/TAG]…​

ℹ️

  • The students name will be automatically formatted such that it follows a standard format of the first letter of each word being uppercase and the rest lowercase, and a maximum of one space between each word. This is done to follow proper naming convention, making it more presentable and readable, and remedies any errors which may have happened when extracting the list of student names. The removal of excess spaces is also done for tags.

    • For example: addStudent name/john doe matric/A0123456X email/johnd@example.com adds a student with the name "John Doe" into the list.

  • Students name have a maximum length of 70 characters as it is the standard length for database fields.
💡
 A student can have any number of tags (including 0), but tags are limited to a length of 40 characters

Examples:

  • addStudent name/John Doe matric/A0123456X email/johnd@example.com

  • addStudent name/Betsy Crowe Daphne matric/A1234567X tag/friend email/betsycrowe@example.com tag/CS2103

3.2.2. Listing all students : listStudent

Shows a list of all students in TAble.
Format: listStudent

3.2.3. Clears the list of students : clearStudent

Clears the list of all students in TAble.
Format: clearStudent

3.2.4. Editing a student : editStudent

Edits an existing student in TAble.
Format: editStudent INDEX [name/NAME] [matric/MATRIC_NUMBER] [email/EMAIL] [tag/TAG]…​

  • Edits the student at the specified INDEX. The index refers to the index number shown in the displayed student 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.

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

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

Examples:

  • editStudent 1 email/johndoe@example.com
    Edits the email address of the 1st student to be johndoe@example.com.

  • editStudent 2 name/Betsy Crower tag/
    Edits the name of the 2nd student to be Betsy Crower and clears all existing tags.

  • editStudent 3 matric/A0123456X
    Edits the matric number of the 3rd student to be A0123456X.

3.2.5. Locating students by name: findStudent

Finds students whose names contain any of the given keywords.
Format: findStudent KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g hans will match Hans

  • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

  • Only the name is searched.

  • Only full words will be matched e.g. Han will not match Hans

  • Students matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • findStudent John
    Returns john and John Doe

  • findStudent Betsy Tim John
    Returns any student having names Betsy, Tim, or John

3.2.6. Locating students by matric number: findStudentMatricNumber

Finds students whose matric number matches the given matric number.
Format: findStudentMatricNumber matric/MATRIC_NUMBER

  • The search is case insensitive. e.g a0123456a will match A0123456A

  • Only the matric number is searched.

  • Only full matric number will be matched e.g. A01234 will not match A0123456A, conversely A0123456A will only return the student with matric number 'A0123456A'

  • Students with matric number matching the given matric number will be returned.

Examples:

  • findStudentMatricNumber matric/A0111111X
    Returns the student with matric number "A0111111X"

3.2.7. Deleting a student : deleteStudent

Deletes the specified student from TAble.
This removes the student from all enrolled tutorials as well.
Format: deleteStudent INDEX

  • Deletes the student at the specified INDEX.

  • The index refers to the index number shown in the displayed student list.

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

  • Deleting the student from TAble also deletes the student from any tutorial they are enrolled in.

Examples:

  • listStudent
    deleteStudent 2
    Deletes the 2nd student in TAble.

  • findStudent Betsy
    deleteStudent 1
    Deletes the 1st student in the results of the find command.

3.3. Module Feature (Written by Nigel Neo)

3.3.1. Add Module into database: addMod

Adds a module into TAble.

ℹ️
 Due to naming restrictions in java, all code references to modules are named Mod instead of Module.

Format: addMod modCode/MODULE_CODE modName/MODULE_NAME

  • The module code provided is case insensitive, e.g. Cs2103 is equivalent to CS2103.
    Module codes consist of three parts: Department Code, Number, then Subcode. They should adhere to the following constraints:

    1. The department code should only contain either two or three capital letters.

    2. This is followed by 4 numbers, with the first not being zero.

    3. The Subcode cannot be more than 2 capital letters long.

  • The module name provided should be any valid string.

Example:

  • addMod modCode/CS1010S modName/Programming Methodology

3.3.2. Delete Module from database: deleteMod

Deletes a module from TAble.
Format: deleteMod modCode/MODULE_CODE

  • The module code provided is case insensitive, e.g. Cs2103 is equivalent to CS2103. It should be prefixed by at most three characters, then four numbers, and finally no more than two characters as suffix.

  • The module code should correspond to an existing module in the database.

  • Modules cannot be deleted if there are tutorials associated with it in TAble (i.e. User cannot delete CS2103 if there are still tutorials with module code CS2103).

Example:

  • addModule modCode/CS1010S modName/Programming Methodology

3.3.3. Edit Module note: noteMod

Edits corresponding note of module.
Format: noteMod modCode/MODULE_CODE modNote/NOTE

  • The module code should correspond to an existing module in the database.

  • The note provided should be any valid string, and replaces the current note of the module.

Example:

  • noteModule modCode/CS1010S modNote/How cool is that?
    When viewing the module info for CS1010S, the note will be updated to show "How cool is that?".

3.3.4. Add link to module with appropriate name: addModLink

Edit module to include links to appropriate websites (e.g. Google Drive Folder, Module Website etc.)
Format: addModLink modCode/MODULE_CODE modLink/LINK modLinkName/NAME

  • The module code should correspond to an existing module in the database.

  • The module link should correspond to a valid URL format as specified by Java.

  • The tag provided should be any valid string.

Example:

  • addModLink modCode/CS1231 modLink/https://comp.nus.edu.sg/~cs1231 modLinkName/Module Website
    When viewing the module page for CS1231, there will be an additional label with "Module Website" and points to https://comp.nus.edu.sg/~cs1231.

3.3.5. Clear all module links from module in database: clearModLink

Removes all module links from a module in TAble.
Format: clearModLink modCode/MODULE_CODE

  • The module code should correspond to an existing module in the database.

Example:

  • clearModLink modCode/CS1231
    When viewing the module page for CS1231, there will not be any module links shown.

3.3.6. Copy Module Link into Clipboard: copyModLink

Copies a module link from the links currently associated with a module. Index corresponding to module link can be seen when viewing the module info using viewModInfo.

Format: copyModLink INDEX modCode/MODULE_CODE

  • The module code should correspond to an existing module in the database.

  • The index should correspond to a valid index in the module links.

Example:

  • copyModLink 1 modCode/CS1231
    The first module link for CS1231 is copied into the user’s clipboard.

3.3.7. View Module: viewModInfo

Opens the view for the selected module to view module description, links and (coming in v2.0) lecture timeslots.

Format: viewModInfo modCode/MODULE_CODE

  • The module code should correspond to an existing module in the database.

3.3.8. Add lecture timeslot: addModLecture [coming in v2.0]

Adds lecture timeslot to module. This is to be integrated with the future calendar display feature.
Format: addModLecture modCode/MODULE_CODE d/DAY from/TIME to/TIME p/LOCATION

Example:

  • addModLecture modCode/CS1010S d/WED from/1400 to/1600 p/LT27

3.3.9. Clear all lecture timeslots: clearModLecture [coming in v2.0]

Clears all lectures associated with a certain module.
Format: clearModLecture modCode/MODULE_CODE

Example:

  • clearModLecture modCode/CS1010S

3.4. Tutorials Feature (Written by Sarah Lim)

3.4.1. Switch GUI Display to Tutorial List View: listTutorial

Focuses the display in the GUI to the Tutorials list view, without requiring the user to click on the tab. Format: listTutorial

3.4.2. Add a tutorial slot: addTutorial

Add a tutorial slot for a particular module at the given time, day and place.
Format: addTutorial modCode/MODULE_CODE tutorialName/TUTORIAL_NAME day/WEEKDAY_VALUE beginTime/START_TIME endTime/END_TIME place/PLACE

💡
 A tutorial is distinguished by its module and name. Only one session is allowed per tutorial. If you wish to have a tutorial with multiple slots per week, you may use unique tutorial names (eg. T02A and T02B).
💡
 The module for addTutorial MODULE_CODE should already exist in TAble before adding the desired Tutorial

  • The tutorial name provided is capped at 8 alphanumeric characters.

  • The time provided must be in HH:MM format, i.e: 24-hour format

  • The day provided is the value of the weekday (ie. MONDAY = 1, TUESDAY = 2, …​ SUNDAY = 7)

  • The module code provided is case insensitive, e.g. Cs2103 is equivalent to CS2103

  • The module with the referenced module code should already be present in TAble

  • The place provided can be any valid string

  • Note that you are not allowed to add tutorials with clashing times (ie. periods overlap)

Example:

  • addTutorial modCode/CS2103 tutorialName/T02 day/3 beginTime/12:00 endTime/13:00 place/SR3

  • addTutorial modCode/CS1101S tutorialName/T11 day/4 beginTime/12:00 endTime/13:00 place/SR3

addTutorial

3.4.3. Delete a tutorial slot: deleteTutorial

Delete a tutorial slot for a particular module.
Format: deleteTutorial INDEX

  • Deletes the tutorial at the specified INDEX.

  • The index refers to the index number shown in the displayed tutorial list.

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

Example:

  • listTutorial
    deleteTutorial 2

deleteTutorial

3.4.4. Add student to tutorial: addTutorialStudent

Enroll an existing student to an existing tutorial. Format: addTutorialStudent tutorialIndex/INDEX student/STUDENT_INDEX

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The STUDENT_INDEX should be referred to by index as referred to in the student list.

  • The student should already exist in TAble.

  • The tutorial should already exist in TAble.

  • Note that listAttendance (see Section 3.4.9) has to be called after adding a student to view the updated list

Example:

  • addTutorialStudent tutorialIndex/3 student/12

3.4.5. Marks students as present: markPresent

Takes attendance of students in a tutorial class by marking them as present for a particular week. Present students will be marked by a green background in the respective attendance list.
Format: markPresent tutorialIndex/INDEX week/WEEK student/STUDENT_INDEX

  • Updates the tutorial at the specified INDEX.

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The STUDENT_INDEX may either be an integer index or all to select all students in the specified tutorial.

  • The STUDENT_INDEX, if an integer, should be referred to by the index as referred to in the student list relative to the specified tutorial.

  • The week should be in numerical format, and accepts only numbers in the range 1 to 13 (inclusive)

Example:

  • markPresent tutorialIndex/3 week/7 student/2
    Marks only student at index 2 (for tutorial at index 3) as present in week 7 for tutorial at index 3

  • markPresent tutorialIndex/2 week/7 student/all
    Marks all students as present in week 7 in tutorial at index 2

markPresent indiv
Figure 1. Only mark the student at index 2 of the tutorial as present
markPresent all
Figure 2. Mark all students present

3.4.6. Marks students as absent: markAbsent

Takes attendance of students in a tutorial class by marking them as absent for a particular week. Absent students will be marked by a red background in the respective attendance list.
Format: markPresent tutorialIndex/INDEX week/WEEK student/STUDENT_INDEX

  • Updates the tutorial at the specified INDEX.

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The STUDENT_INDEX may either be an integer index or all to select all students in the specified tutorial.

  • The STUDENT_INDEX, if an integer, should be referred to by the index as referred to in the student list relative to the specified tutorial.

  • The week should be in numerical format, and accepts only numbers in the range 1 to 13 (inclusive)

Example:

  • markAbsent tutorialIndex/3 week/7 student/2
    Marks only student at index 2 (for tutorial at index 3) as absent in week 7 for tutorial at index 3

  • markAbsent tutorialIndex/3 week/7 student/all
    Marks all students in week 7 as absent in tutorial at index 3 (oh no!)

markAbsent indiv
Figure 3. Only mark the student at index 3 of the tutorial as absent
markAbsent all
Figure 4. Mark all students absent

3.4.7. Remove student from tutorial: deleteTutorialStudent

Remove an existing student from an existing tutorial. Format: deleteTutorialStudent tutorialIndex/INDEX student/STUDENT_INDEX

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The STUDENT_INDEX should be referred to by the index as referred to in the student list relative to the specified tutorial.

  • The student should already exist in TAble and exist in the tutorial being deleted from.

  • The tutorial should already exist in TAble.

  • Note that deleting the student from the tutorial does not delete the student from the TAble database.

  • Note that listAttendance (see Section 3.4.9) has to be called after deleting a student to view the updated list

Example:

  • deleteTutorialStudent tutorialIndex/3 student/12

3.4.8. Copy tutorial students' emails to user clipboard: copyTutorialEmails

Copies all student emails in the given tutorial to the user clipboard, for easy mass-emailing purposes. Format: copyTutorialEmails tutorialIndex/INDEX

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The tutorial should already exist in TAble.

  • The emails will be delimited by a semicolon (eg. hello@email.com; bye@email.com)

Example:

  • copyTutorialEmails tutorialIndex/3

3.4.9. Display students and attendance of a tutorial: listAttendance

Displays the list of students in a tutorial and their corresponding attendance for a particular week in the GUI. Format: listAttendance tutorialIndex/INDEX week/INDEX

  • Shows the attendance for tutorial at the specified INDEX.

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The tutorial should already exist in TAble.

  • The week should be in numerical format, and accepts only numbers in the range 1 to 13 (inclusive)

Example:

  • listAttendance tutorialIndex/2 week/10

3.4.10. Export tutorial attendance to csv file: exportAttendance (Written by Nigel Neo)

Exports the attendance data of all enrolled students in a tutorial group to a csv file, where the filepath is specified by the user. Format: exportAttendance tutorialIndex/INDEX csvFilePath/FILEPATH

  • The index refers to the index number shown in the displayed tutorial list.

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

  • The tutorial should already exist in TAble.

  • TAble must be able to write to the file specified.

  • The filepath must end in ".csv" as it is a csv file.

  • Attendance data from all weeks are exported into a csv file, where a 0 indicates absence and 1 indicates presence.

Example:

  • exportAttendance tutorialIndex/1 csvFilePath/./data/attendance.csv

3.5. Consults Feature (Written by Han Ching)

ℹ️
 The consults that are overdue will appear in red to highlight that these consults are ready to be deleted!

3.5.1. Adding a consult: addConsult

Add a consultation slot at the given time, date and place.
Format: addConsult student/STUDENT_INDEX beginDateTime/BEGIN_DATE_TIME endDateTime/END_DATE_TIME place/PLACE

💡
 Consults will be automatically sorted according to their date and time, with the earliest at the top of the list.

  • The 'STUDENT_INDEX' should be referred to by the index as referred to in the student list

  • The begin and end date time provided must be in the yyyy-MM-dd HH:mm format

  • The location provided should be any valid string i.e, must be alphanumeric

  • The consult must be held within the same day, thus the begin and end DateTime objects should have the same date.

  • Consults also cannot be added in the past, and must be a consult that will occur in the future.

Example:

  • addConsult student/1 beginDateTime/2020-03-03 10:00 endDateTime/2020-03-03 12:00 place/Deck

3.5.2. Editing a consult: editConsult

Edit the time, date or place of an existing consultation slot.
Format: editConsult INDEX [beginDateTime/BEGINDATETIME] [endDateTime/ENDDATETIME] [place/PLACE]

  • Edits the consult at the specified INDEX. The index refers to the index number shown in the displayed consultation 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.

  • Note that one cannot edit the student involved in the consult, as it is unlikely that the TA will need to change the student at that consult timing.

Example:

  • editConsult 1 beginDateTime/2020-03-03 15:00
    Edits the beginning time of the 1st consult to be at 2020-03-03, 15:00 hours i.e 3.00 p.m.

  • editConsult 2 place/SR3
    Edits the place of the 2nd consult to be at SR3.

3.5.3. Listing all consults : listConsult

Shows a list of all consultations in TAble.
Format: listConsult

3.5.4. Deleting a consult: deleteConsult

Removes an existing consultation slot.
Format: deleteConsult INDEX

  • Deletes the consultation at the specified INDEX.

  • The index refers to the index number shown in the displayed consultation list.

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

Example:

  • listConsult
    deleteConsult 2
    Deletes the 2nd consultation in TAble.

3.5.5. Clearing all consults : clearConsults

Clears all consultations slots in TAble.
Format: clearConsults

3.5.6. Locating consultations by date or place: findConsult [coming in v2.0]

Finds consultations whose date or place match any of the given keywords.
Format: findConsult [DATE] [PLACE]

  • At least one of the optional fields must be provided

  • If both optional fields are provided, only consults that meet both criterion will be returned

  • The search is case insensitive. e.g SR1 will match sr1

  • The order of the keywords matters. e.g. find SR1 03-03-2020 will throw an error

Examples:

  • findConsult 03-03-2020
    Returns all consults on 03-03-2020

  • findConsult SR3
    Returns any consults that are held at SR3

3.6. Reminder Feature (Written by Cranston Yeo)

3.6.1. Adding a reminder: addReminder

Adds a reminder to the reminder list.
Format: addReminder desc/DESCRIPTION date/DATE time/TIME

💡
 Reminders will be automatically sorted according to their date and time, with the earliest at the top of the list.

  • The description provided should be any valid string that is not blank or exceeds 80 characters.

  • The date provided must be in YYYY-MM-DD format.

  • The time provided must be in HH:MM format, i.e: 24-hour format.

  • The reminder must be in the future.

Examples:

  • addReminder desc/Mark midterms papers date/2020-10-05 time/14:00

3.6.2. Editing a reminder: editReminder

Edits an existing reminder in the reminder list.
Format: editReminder INDEX [desc/DESCRIPTION] [date/DATE] [time/TIME]

  • Edits the reminder at the specified INDEX. The index refers to the index number shown in the displayed reminder 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.

Examples:

  • editReminder 1 desc/Return midterms papers
    Edits the description of the 1st reminder to "Return midterms paper".

  • editReminder 3 date/2020-05-20 time/18:00
    Edits the date of the 3rd reminder to 20th May 2020 18:00 hours i.e. 6.00 p.m.

3.6.3. Finding reminders by their descriptions or date: findReminder

Finds reminders matching with the given descriptions or date. Format: findReminder [desc/DESCRIPTION] [MORE_DESCRIPTIONS] [date/DATE]

  • The search is case insensitive. e.g Mark will match mark.

  • The order of the descriptions does not matter. e.g. Mark papers will match Papers mark

  • Only full words will be matched e.g. Mar will not match Mark

  • Reminders matching at least one description will be returned (i.e. OR search). e.g. Mark midterms will return Mark papers, Midterms exam

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

  • If both optional fields are provided, only reminders matching both criteria will be displayed.

Examples:

  • findReminder desc/mark
    Returns reminders containing the keyword 'mark'.

  • findReminder date/2020-05-05
    Returns all reminders on 05 May 2020.

3.6.4. List all reminders: listReminder

Lists all the reminders that the TA have added on TAble.
Format: listReminder

3.6.5. Marking a reminder as done: doneReminder

Marks the reminder from the reminder list as done.
Format: doneReminder INDEX

💡
 Reminders marked as done will automatically be sorted to the bottom of the list and will no longer appears in the calendar.

  • Marks the reminder at the specified INDEX as done.

  • The index refers to the index number shown in the displayed reminder list.

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

Examples:

  • listReminder
    doneReminder 3
    Mark the 3rd reminder in TAble as done.

3.6.6. Deleting a reminder: deleteReminder

Deletes the specified reminder from the reminder list.
Format: deleteReminder INDEX

  • Deletes the reminder at the specified INDEX.

  • The index refers to the index number shown in the displayed reminder list.

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

Examples:

  • listReminder
    deleteReminder 3
    Deletes the 3rd reminder in TAble.

3.6.7. Snoozing a reminder: snoozeReminder

Snoozes a reminder in the reminder list.
Format: snoozeReminder INDEX [day/DAY] [hour/HOUR] [minute/MINUTE]

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

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

  • Number of days, hours or minutes provided must be a positive whole number.

  • Reminder to be snoozed must not be done.

Examples:

  • snoozeReminder 2 day/3 hour/2
    Postpone the second reminder to 3 days and 2 hours later.

  • snoozeReminder 4 minute/30
    Postpone the fourth reminder to 30 minutes later.

3.7. Calendar Feature (Written by Han Ching)

3.7.1. Display the calendar window: viewCalendar

Brings up the calendar window. Format: viewCalendar

  • The calendar will be brought up, displaying the current month and year.

  • For each month, the number of tutorials, consults and reminders for each day will be displayed in the calendar.

  • Click on the left/right arrows in the calendar window or press ← / → buttons to change the month displayed.

3.7.2. Close the calendar window: closeCalendar

Closes the calendar window. Format: closeCalendar

  • The calendar will be closed, if a current calendar window is displayed.

  • Alternatively, clicking the cross can also close the calendar window.

3.7.3. View consults and tutorials on a particular day [Coming in v2.0]

3.8. Exiting the program : exit

Exits the program.
Format: exit

3.9. Saving the data

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

4. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous TAble folder.

5. Command Summary

5.1. Student

  • Add : addStudent name/NAME matric/MATRIC_NUMBER email/EMAIL [tag/TAG]…​
    e.g. addStudent name/James Tan matric/A0123456X email/jamesho@example.com tag/friend tag/colleague

  • Clear : clearStudent e.g. clearStudent

  • Delete : deleteStudent INDEX
    e.g. deleteStudent 3

  • Edit : editStudent INDEX [name/NAME] [matric/MATRIC_NUMBER] [email/EMAIL] [tag/TAG]…​
    e.g. editStudent 2 name/James Lee email/jameslee@example.com

  • Find : findStudent KEYWORD [MORE_KEYWORDS]
    e.g. findStudent James Jake

  • Find Student with a certain matric number : findStudentMatricNumber matric/matric_number
    e.g. findStudentMatricNumber matric/A0123456A

  • List : listStudent

5.2. Module

  • Add : addMod modCode/MODULE_CODE modName/MODULE_NAME
    e.g. addMod modCode/CS2103 modName/Software Engineering

  • Delete : deleteMod modCode/MODULE_CODE
    e.g. deleteMod modCode/CS2103

  • Edit module Note : noteMod modCode/MODULE_CODE modNote/MODULE_NOTE
    e.g. noteMod modCode/CS2103 modNote/SWE is fun!

  • Add module website link : addModLink modCode/MODULE_CODE modLink/MODULE_LINK modLinkName/MODULE_LINK_NAME
    e.g. addModLink modCode/CS2103 modLink/http://comp.nus.edu.sg/~cs2103 modLinkName/Module Website

  • Clear all module links : clearModLink modCode/MODULE_CODE

  • View module info : viewModInfo modCode/MODULE_CODE

  • Copy module link into clipboard : copyModLink INDEX modCode/MODULE_CODE
    e.g. copyModLink 1 modCode/CS2013

  • List Mods : listMod

5.3. Tutorial

  • Add : addTutorial modCode/MODULE_CODE tutorialName/TUTORIAL_NAME day/WEEKDAY_VALUE beginTime/START_TIME endTime/END_TIME place/PLACE
    e.g. addTutorial modCode/CS2103 tutorialName/T02 day/3 beginTime/12:00 endTime/13:00 place/SR3

  • Delete : deleteTutorial INDEX
    e.g. deleteTutorial 2

  • Add Tutorial Student : addTutorialStudent tutorialIndex/INDEX student/STUDENT_INDEX
    e.g. addTutorialStudent tutorialIndex/1 student/3

  • Mark Present : markPresent tutorialIndex/INDEX week/WEEK student/STUDENT_INDEX
    e.g. markPresent tutorialIndex/3 week/7 student/2

  • Mark Absent : markPresent tutorialIndex/INDEX week/WEEK student/STUDENT_INDEX
    e.g. markAbsent tutorialIndex/3 week/7 student/2

  • Delete Tutorial Student : deleteTutorialStudent tutorialIndex/INDEX student/STUDENT_INDEX
    e.g. deleteTutorialStudent tutorialIndex/3 student/12

  • List Tutorial : listTutorial

  • List Attendance : listAttendance tutorialIndex/INDEX week/INDEX
    e.g. listAttendance tutorialIndex/2 week/10

  • Copy Tutorial Students' Emails : copyTutorialEmails tutorialIndex/INDEX
    e.g. copyTutorialEmails tutorialIndex/3

  • Export attendance to CSV file : exportAttendance tutorialIndex/INDEX csvFilePath/CSV_FILEPATH
    e.g. exportAttendance tutorialIndex/1 csvFilePath/./data/attendance.csv

5.4. Consult

  • Add : addConsult student/STUDENT_INDEX beginDateTime/BEGIN_DATE_TIME endDateTime/END_DATE_TIME place/PLACE
    e.g. addConsult student/1 beginDateTime/2020-03-03 10:00 endDateTime/2020-03-03 12:00 place/Deck

  • Clear : clearConsult

  • Delete : deleteConsult INDEX
    e.g. deleteConsult 3

  • Edit : editConsult INDEX [beginDateTime/BEGINDATETIME] [endDateTime/ENDDATETIME] [place/PLACE]
    e.g editConsult 3 place/The Deck

  • List : listConsult

5.5. Reminder

  • Add : addReminder desc/DESCRIPTION date/DATE time/TIME
    e.g. addReminder desc/Upload week 11 tutorial answers date/2020-10-31 time/15:00

  • Edit : editReminder INDEX [desc/DESCRIPTION] [date/DATE] [time/TIME]
    e.g editReminder 3 date/2020-10-05

  • Find : findReminder [desc/DESCRIPTION] [MORE_DESCRIPTIONS] [date/DATE]
    e.g findReminder desc/midterms paper date/2020-10-15

  • List : listReminder

  • Done : doneReminder INDEX
    e.g. doneReminder 2

  • Delete : deleteReminder INDEX
    e.g. deleteReminder 2

  • Snooze : snoozeReminder INDEX [day/DAY] [hour/HOUR] [minute/MINUTE]
    e.g snoozeReminder 4 hour/2 minute/30

5.6. Calendar

  • View Calendar : viewCalendar

  • Close Calendar: closeCalendar

  • Help : help