User Guide

TAskbook User Guide

TAskbook is a desktop app for managing students, 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, TAskbook can get your student management tasks done faster than traditional GUI apps.

Table of Contents

• TAskbook User Guide
• Table of Contents
• Quick start
• Application Views
  • Types of Views
    • STUDENT view
    • TUTORIAL view
    • ATTENDANCE view
    • SUBMISSION view
    • SINGLE_STUDENT view
  • Switching Views
• Features
  • Command - Viewing help: help
  • Command - Clearing all entries: clear
  • Command - Exiting the program: exit
  • Student Commands
    • Command - Adding a student: add
    • Command - Listing all students: list
    • Command - Editing a student: edit
    • Command - Finding students: find
    • Command - Deleting a student: delete
    • Command - Viewing student details: view
  • Tutorial Commands
    • Command - Adding a tutorial: tutorial add
    • Command - Listing all tutorials: tutorial list
    • Command - Finding a tutorial: tutorial find
    • Command - Deleting a tutorial: tutorial delete
    • Command - Adding a student to tutorial: tutorial add-student
    • Command - Deleting a student from tutorial: tutorial delete-student
  • Assignment Commands
    • Command - Listing assignments
    • Command - Adding an assignment: assignment add
    • Command - Deleting an assignment: assignment delete
  • Submission Commands
    • Command - Listing submissions: submission list
    • Command - Setting submission status: submission set
  • Attendance Commands
    • Command - Listing attendance: attendance list
    • Command - Marking attendance: attendance mark
    • Command - Unmarking attendance: attendance unmark
  • Export Commands
    • Command - Command - Exporting data: export
      • Export All Data
      • Export Students
      • Export Tutorials
• Saving the data
• Editing the data file
• FAQ
• Known issues
• Command Summary
• Troubleshooting
• Acknowledgements

---

Quick start

1. Ensure you have Java 17 or above installed in your Computer.
   Mac users: Ensure you have the precise JDK version prescribed here.

2. Download the latest .jar file from here.

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

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar taskbook.jar command to run the application.
   A GUI similar to the 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: Lists all students.

   • add n/John Doe i/A0123456Z p/98765432 e/johnd@example.com h/@john_doe: Adds a student named John Doe to the Address Book.

   • delete 1: Deletes the 1st student shown in the current list.

   • clear: Deletes all students.

   • exit: Exits the app.

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

---

Application Views

TAskbook operates in distinct views, which determine the information shown in the UI and what commands are available. The current view is indicated in the bottom-right corner of the application window.

---

Types of Views

STUDENT view

For managing students and their tutorial enrollment.

TUTORIAL view

For managing tutorials and their assignments.

ATTENDANCE view

For tracking student attendance.

SUBMISSION view

For managing student submissions and their statuses.

SINGLE_STUDENT view

For viewing comprehensive details of a specific student.

---

Switching Views

The user can switch between views using the following commands:

Command	View
list	STUDENT view
tutorial list	TUTORIAL view
attendance list	ATTENDANCE view
submission list	SUBMISSION view
view INDEX	SINGLE_STUDENT view

For more information on these commands, please refer to the Features section.

---

Features

---

Command - Viewing help: help

Format:
help

Shows a message explaining how to access the help page.

---

Command - Clearing all entries: clear

Clears all entries from the address book.

Format:
clear

---

Command - Exiting the program: exit

Exits the program.

Format:
exit

---

Student Commands

Command - Adding a student: add

Adds a student to the address book.

Format:
add n/NAME i/STUDENT_ID p/PHONE e/EMAIL h/HANDLE [desc/DESCRIPTION]

Examples:

• add n/John Doe i/A0123456Z p/98765432 e/johnd@example.com h/@john_doe

---

Command - Listing all students: list

Shows a list of all students in the address book.

Format:
list

---

Command - Editing a student: edit

Edits an existing student in the address book. You must be in STUDENT view.

Format:
edit INDEX [n/NAME] [i/STUDENT_ID] [p/PHONE] [e/EMAIL] [h/HANDLE] [desc/DESCRIPTION]

Behavior:

• Updates all specified fields with new values
• Preserves unspecified fields

Examples:

• edit 1 p/91234567 e/johndoe@example.com Edits the phone number and email address of the 1st student to be 91234567 and johndoe@example.com respectively.
• edit 2 n/Betsy Crower Edits the name of the 2nd student to be Betsy Crower

---

Command - Finding students: find

Finds all students whose names contain any of the specified keywords (case-insensitive) or who are in the specified tutorial group(s).

Format:
find NAME... [t/TUTORIAL_NAME]

Behavior:

• Displays results as a numbered list
• Shows nothing and flag out usage guidelines if no parameters provided
• Unsuccessful search returns empty list
• Tutorial filter must match existing tutorial names exactly

Examples:

• find alice bob: Finds any student(s) named alice or bob.
• find t/CS2103_T02: Finds any student(s) that has a tutorial CS2103_T02.
• find alice bob t/CS2103_T02: Finds any student(s) named alice or bob that has a tutorial CS2103_T02.
• find alice bob t/CS2103_T02 t/CS2103_T03: Finds any student(s) named alice or bob that is in any of the tutorials CS2103_T02 or CS2103_T03.

---

Command - Deleting a student: delete

Deletes the specified student from the address book. You must be in STUDENT view.

Format:
delete INDEX

Behavior:

• Permanently removes the student record

Examples:

• delete 3: Deletes the 3rd student shown in the current list.
• find Alex followed by delete 1: Deletes the first student in the filtered ‘Alex’ results.
• list followed by delete 2: Deletes the 2nd student in the complete student list.

---

Command - Viewing student details: view

Displays comprehensive information for a specific student. You must be in STUDENT view.

Format:
view INDEX

Behavior:

• Shows complete student profile

Example:

• view 1: Displays full details for the first student in the current list.

---

Tutorial Commands

Command - Adding a tutorial: tutorial add

Adds a tutorial slot to the address book.

Format:
tutorial add NAME

Behavior:

• Creates new tutorial if all requirements met
• Rejects invalid names

Examples:

• tutorial add cs2103-f15: Creates tutorial “cs2103-f15” if valid and unique.
• tutorial add lab_01: Creates tutorial “lab_01” if doesn’t exist.
• tutorial add CS2040-T01: Creates tutorial “CS2040-T01” if meets requirements.

---

Command - Listing all tutorials: tutorial list

Shows a list of all tutorials and created assignments in the address book.

Format:
tutorial list

---

Command - Finding a tutorial: tutorial find

Finds tutorials matching specified keywords in their names.

Format:
tutorial find SEARCH...

Behavior:

• Displays results as a numbered list
• Returns empty list if no matches found

Examples:

• tutorial find CS2103_T02: Finds tutorial(s) with “cs2103_t02” in name (regardless of case).
• tutorial find CS2103_T02 CS2103_T03: Finds tutorials containing either “cs2103_t02” or “cs2103_t03”.
• tutorial find CS2103: Finds all tutorials with “cs2103” anywhere in their names.

---

Command - Deleting a tutorial: tutorial delete

Deletes a tutorial slot from the address book.

Format:
tutorial delete TUTORIAL_NAME

Behavior:

• Permanently removes the tutorial
• Automatically unenrolls all students from this tutorial
• Maintains student records (only removes tutorial association)

Examples:

• tutorial delete cs2103-f15: Deletes the tutorial named exactly “cs2103-f15”.
• tutorial delete Lab_Section1: Deletes the tutorial named exactly “Lab_Section1”.

---

Command - Adding a student to tutorial: tutorial add-student

Adds a student to a tutorial slot. You must be in STUDENT view.

Format:
tutorial add-student TUTORIAL_NAME s/STUDENT_INDEX...

Behavior:

• Adds student to specified tutorial
• No effect if student already in tutorial

Examples:

• list then tutorial add-student cs2103-f15 s/1: Adds the 1st displayed student to tutorial “cs2103-f15”.
• find Alice then tutorial add-student cs2101-t03 s/1: Adds Alice (1st in filtered list) to tutorial “cs2101-t03”.

---

Command - Deleting a student from tutorial: tutorial delete-student

Removes a student from a tutorial slot. You must be in STUDENT view.

Format:
tutorial delete-student TUTORIAL_NAME s/STUDENT_INDEX...

Behavior:

• Removes student from specified tutorial
• No effect if student not enrolled in tutorial

Examples:

• list then tutorial delete-student cs2103-f15 s/1: Removes the 1st displayed student from tutorial “cs2103-f15”.
• find Alice then tutorial delete-student cs2101-t03 s/1: Removes Alice (1st in filtered list) from tutorial “cs2101-t03”.

---

Assignment Commands

Command - Listing assignments

Command - Adding an assignment: assignment add

Creates a new assignment for specified tutorials. You must be in TUTORIAL view.

Format:
assignment add ASSIGNMENT_NAME [t/TUTORIAL_INDEX]... [d/DUE_DATE]

Examples:

• assignment add Lab1 t/1 t/2: Creates basic assignment for listed tutorials in index 1 and 2.
• assignment add Final_Project t/3 d/2023-12-15 16:00: Creates assignment with due date.
• assignment add Quiz-1 t/1 t/99: Only creates for valid tutorial (ignores invalid).

Behaviour:

• An error will be shown (but the rest of the tutorials will be processed):
  • Invalid tutorial indexes will
  • Assignments not in specified tutorial

---

Command - Deleting an assignment: assignment delete

Removes an assignment from specified tutorials. You must be in TUTORIAL view.

Format:
assignment delete ASSIGNMENT_NAME [t/TUTORIAL_INDEX]...

Behavior:

• Removes assignment from all specified tutorials
• An error will be shown (but the rest of the tutorials will be processed):
  • Invalid tutorial indexes will
  • Assignments not in specified tutorial
• Preserves all student submissions

Examples:

• assignment delete Lab1 t/1: Deletes “Lab1” from tutorial at position 1 in current view.
• list then assignment delete Final_Project t/2 t/3: Deletes “Final_Project” from tutorials at positions 2 and 3.
• tutorial find cs2103 then assignment delete Quiz1 t/1: Deletes “Quiz1” from first tutorial in filtered CS2103 list.

---

Submission Commands

Command - Listing submissions: submission list

Displays a comprehensive overview of all student enrollments and their assignment completion status across tutorials.

Format:
submission list

---

Command - Setting submission status: submission set

Updates the completion status of specified student submissions.

Format:
submission set STATE t/TUTORIAL_NAME a/ASSIGNMENT_NAME s/STUDENT_NAME

Behavior:

• Rejects entire operation if any parameter is invalid

Examples:

• submission set submitted t/CS2103-F15 a/Midterm s/Bernice Yu: Marks Bernice Yu’s submission as “submitted”.
• submission set graded t/CS2103-F15 a/Midterm s/Alex Yeoh s/Charlotte Li: Records “graded” status for two students’ midterms.

---

Attendance Commands

Command - Listing attendance: attendance list

Displays attendance records for students or tutorials. You can be in any view to execute this command, but different views have different behaviors.

Format:
attendance list [INDEX]

Behavior:

• Without index: shows all attendance records
• With index while in student/tutorial view: shows records for specified student/tutorial
• With index while in other views: error is shown asking user to change to a valid view
• Multiple entries possible per student (across different tutorials)
• Invalid input defaults to full attendance list
• Displays:
  • Week numbers
  • Attendance status (Present/Absent)

Examples:

• list then attendance list 1: Shows attendance for all tutorials under the first student in current student list.
• tutorial list then attendance list 2: Shows attendance for all students enrolled in second tutorial in current tutorial list.
• attendance list: Displays complete attendance records for all students (one student one tutorial per row).

---

Command - Marking attendance: attendance mark

Records student attendance for a specific week. You must be in ATTENDANCE view.

Format:
attendance mark w/WEEK i/INDEX...

Behavior:

• Marks specified students as “Present” for the week
• Handles multiple students in single command

Examples:

• attendance mark w/3 i/1: Marks first student in attendance list as present for week 3.
• attendance mark w/13 i/1 i/2: Marks students at positions 1 and 2 as present for week 13.

Usage Notes:

• Always check current attendance list before marking
• Changes take effect immediately

---

Command - Unmarking attendance: attendance unmark

Removes attendance records for specified students in a given week. You must be in ATTENDANCE view.

Format:
attendance unmark w/WEEK i/INDEX...

Behavior:

• Sets specified students’ status to “Absent” for the week
• Processes multiple students in a single command

Examples:

• attendance unmark w/3 i/1: Removes attendance mark for first student in week 3.
• attendance unmark w/13 i/1 i/2: Unmarks attendance for students at positions 1 and 2 in week 13.

Usage Notes:

• Verify current attendance list before unmarking
• Changes are immediate and irreversible

---

Export Commands

Command - Command - Exporting data: export

Generates CSV files of system data for external use.

Export All Data

Format:
export

Behavior:

• Creates two files:
  • data/students.csv (all student records)
  • data/tutorials.csv (all tutorial records)
• Overwrites existing files without confirmation
• Includes all active records regardless of current view

Export Students

Format:
export students [TUTORIAL_NAME]

Behavior:

• Without parameter: data/students.csv (all students)
• With parameter: data/students-TUTORIAL_NAME.csv
• Only includes currently enrolled students
• Preserves special characters in names

Examples:

• export students: Exports all students to students.csv.
• export students CS2103-T2: Creates students-CS2103-T2.csv with tutorial-specific enrollments.

Export Tutorials

Format:
export tutorials

Behavior:

• Generates data/tutorials.csv
• Includes all tutorial metadata
• Maintains original creation timestamps

---

Saving the data

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

Editing the data file

TAskbook data are saved automatically as a JSON file [JAR file location]/data/addressbook.json. Advanced users are welcome to update data directly by editing that data file.

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 TAskbook home folder.

Known issues

These document changes that are not planned in current version of the product.

1. Opening the app in full screen, and constantly typing help and closing the help window for many times. Eventually the app will crash.

Command Summary

Action	Required View	Format, Examples
Student Management
Add student		add n/NAME i/STUDENT_ID p/PHONE e/EMAIL h/HANDLE [desc/DESCRIPTION] e.g., add n/John Doe i/A0123456Z p/98765432 e/johnd@example.com h/@johndoe
Edit student	STUDENT	edit INDEX [n/NAME] [i/STUDENT_ID] [p/PHONE] [e/EMAIL] [h/HANDLE] [desc/DESCRIPTION] e.g., edit 1 p/91234567
Delete student	STUDENT	delete INDEX e.g., delete 2
List students		list
View student	STUDENT	view INDEX e.g., view 2
Find students		find NAME [t/TUTORIAL] e.g., find Alice t/CS2103
Tutorial Management
Add tutorial		tutorial add NAME e.g., tutorial add cs2103-f15
Delete tutorial		tutorial delete NAME e.g., tutorial delete cs2103-f15
List tutorials		tutorial list
Find tutorials		tutorial find NAME e.g., tutorial find CS2103
Add student to tutorial	STUDENT	tutorial add-student TUTORIAL s/INDEX... e.g., tutorial add-student cs2103-f15 s/1
Remove student from tutorial	STUDENT	tutorial delete-student TUTORIAL s/INDEX... e.g., tutorial delete-student cs2103-f15 s/1
Academic Tracking
Add assignment	TUTORIAL	assignment add NAME t/TUTORIAL... [d/DATE] e.g., assignment add Lab1 t/1 d/2023-11-30 14:00
Delete assignment	TUTORIAL	assignment delete NAME t/TUTORIAL... e.g., assignment delete Lab1 t/1
Mark attendance	ATTENDANCE	attendance mark w/WEEK i/INDEX... e.g., attendance mark w/4 i/1
Unmark attendance	ATTENDANCE	attendance unmark w/WEEK i/INDEX... e.g., attendance unmark w/4 i/1
List attendance	STUDENT or TUTORIAL if INDEX is specified	attendance list [INDEX] e.g., attendance list 1
Set submission status		submission set STATE t/TUTORIAL a/ASSIGNMENT s/STUDENT... e.g., submission set submitted t/cs2103 a/lab1 s/Alice
List submissions		submission list [s/STUDENT] [t/TUTORIAL] [a/ASSIGNMENT] e.g., submission list t/cs2103 a/lab1
Data Export
Export all		export
Export students		export students [TUTORIAL] e.g., export students CS2103-T2
Export tutorials		export tutorials
System
Clear data		clear
Help		help
Exit		exit

Troubleshooting

1. Data not saving: Ensure you have write permissions in the installation directory.
2. Invalid command errors: Check for exact parameter formats and case sensitivity.
3. Missing features: Some advanced features are planned for v2.0.

Acknowledgements

• Built using JavaFX
• Inspired by AddressBook-Level3