F.A.K.E.J.A.R.V.I.S. User Guide

Introduction

Say goodbye to chaos and hello to an organized and efficient classroom experience.

F.A.K.E.J.A.R.V.I.S. is your friendly companion for efficient task and administrative management, allowing you to excel as a CS1101S Avenger. With this tool, you can effortlessly track assignment gradings, monitor student participation, and seamlessly plan tutorials, consultations, and mastery checks.

As Avengers ourselves, we understand the importance of managing both our time and our students effectively. F.A.K.E.J.A.R.V.I.S. is the one-stop solution to streamlining your workload, making your life easier. It is designed to empower you with the benefits of a Command-Line Interface (CLI), all while preserving the advantages of having a Graphical User Interface (GUI).

If you are new to CLI, or unfamiliar with the commands F.A.K.E.J.A.R.V.I.S. offers and need assistance, don't worry! This User Guide is your trusted assistant, and will guide you through every step and ensure that you can unlock the full potential of F.A.K.E.J.A.R.V.I.S. Let's get started!

Table of Contents

 1 Introduction
      1.1 Table of Contents
      1.2 How to use the User Guide

 2 Graphical User Interface
      2.1 Student Card
      2.2 Task Card
      2.3 Assignment Cards
      2.4 Session Card
      2.5 Consultation Card

 3 Quick Start

 4 Command Format
      4.1 Command Parameters

 5 Features
      5.1 General Commands
            5.1.1 👀 Viewing Help : help
            5.1.2 🔀 Switching between different Tabs : tab
            5.1.3 🗑️ Clearing all Entries : clear
            5.1.4 🏃🚪 Exiting F.A.K.E.J.A.R.V.I.S. : exit
            5.1.5 💾 Saving the Data
            5.1.6 🛠️ Editing the Data File
            5.1.7 💾 Archiving Data Files [coming in v2.0]

      5.2 Student Management
            5.2.1 📝 Adding a Student: add
            5.2.2 👀 Listing all Students : list
            5.2.3 🛠️ Editing a Student Field : edit
            5.2.4 🔎 Finding Student by Name: find
            5.2.5 ❌ Deleting a Student : delete

      5.3 Task Management
            5.3.1 📝 Adding a Task: addtask
            5.3.2 👀 Viewing Tasks: viewtasks
            5.3.3 🛠️ Updating a Task's Progress: updateprogress
            5.3.4 ❌ Deleting a Task: deletetask

      5.4 Attendance Management
            5.4.1 📆 Taking Attendance: takeattendance
            5.4.2 👀 Viewing Attendance: viewattendance

      5.5 Assignment Management
            5.5.1 👀 Viewing a list of Assignments: viewassignments
            5.5.2 🛠️ Editing an Assignment Grade: editgrade
            5.5.3 ❌ Deleting an Assignment Grade: deletegrade
            5.5.4 🛠️ Editing an Assignment Comment: editcomment
            5.5.5 ❌ Deleting an Assignment Comment: deletecomment

      5.6 Graded Test Management
            5.6.1 🛠️ Editing a Graded Test Score: editgradedtest

      5.7 Session Management
            5.7.1 📝 Creating a Session: createsession
            5.7.2 🛠️ Updating a Session's Remark: updatesessionremark
            5.7.3 ❌ Deleting a Session: deletesession

      5.8 Consultation Management
            5.8.1 📝 Creating a Consultation: createconsult
            5.8.2 📝 Adding Students to a Consultation: addtoconsult
            5.8.3 ❌ Removing Students from a Consultation: removefromconsult
            5.8.4 ❌ Deleting a Consultation: deleteconsult

 6 FAQ

 7 Known Issues

 8 Command Summary

 9 Encountering Errors

 10 Contacting Support

How to use the User Guide

You may refer to the Table of Contents for easy navigation of the User Guide.

The F.A.K.E.J.A.R.V.I.S. User Guide employs a variety of visual cues to enhance the information it presents. The table below offers an overview of the typographical conventions used.

Back to Table of Contents

---

Graphical User Interface

F.A.K.E.J.A.R.V.I.S.'s graphical user interface (GUI) consists of 6 main components:

• Menu Bar
• Tabs
• Command Box
• Command Result Display
• Graphical Result Display
• Current Panel

You may enter your commands in the Command Box and then press Enter to execute them. The resulting message will be shown in the Command Result Display box, and in Graphical Result Display if needed.

The following describes what each tab displays on the Current Panel:

• Student Tab: Displays your student list and students' details.
• Task Tab: Displays your task list and tasks' details.
• Assignment Tab: Displays your assignment list.
• Session Tab: Displays your session list and sessions' details.
• Consultation Tab: Displays your consultation list and consultations' details.

Student Card

Task Card

Assignment Cards

Session Card

Consultation Card

Back to Table of Contents

---

Quick start

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

2. Download the latest fakejarvis.jar from here.

3. Copy the file to the folder you want to use as the home folder for your F.A.K.E.J.A.R.V.I.S..

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar fakejarvis.jar command to run the application.
   A GUI similar to the image below should appear in a few seconds.
   

   

   Note that the app will contain some sample data initially. You can use the clear command for a blank state.
   

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:

   • viewtasks : Lists all tasks.

   • deletetask 3: Deletes the 3rd task shown in the current task list.

   • createconsult d/10/10/2023 tt/15:00 n/John Doe n/Foo Bar : Creates a consultation with the students John Doe and Foo Bar.

   • createsession s/3 n/John Doe : Creates a session with session number 3 with the student John Doe.

   • exit : Exits the app.

6. Refer to the Features below for details of each command and the Command Format for the specifications of each command.

Back to Table of Contents

---

Command Format

The commands in the user guide adopt the following conventions:

• Words in UPPER_CASE are the parameters to be supplied by the user.
  e.g. in addtask tn/TASK_NAME, TASK_NAME is a parameter which can be specified, such as addtask tn/Do User Guide.

• Items in square brackets are optional.
  e.g tn/TASK_NAME [td/TASK_DESCRIPTION] can be used as tn/Do User Guide td/do before feedback or as tn/Do user Guide.

• Items with …​ after them can be used multiple times including zero times.
  e.g. [n/NAME]…​ can be used as (i.e. 0 times), n/John Doe, n/John Doe n/Foo Bar etc.

• Items with / can only be used one time.
  e.g. tn/user guide / td/developer guide has to be used as tn/user guide or td/developer guide.

• Parameters can be in any order.
  e.g. if the command specifies tn/TASK_NAME td/TASK_DESCRIPTION, td/TASK_DESCRIPTION tn/TASK_NAME is also acceptable.

• Extraneous parameters for commands that do not take in parameters (such as help, list, exit and clear) will be ignored.
  e.g. if the command specifies help 123, it will be interpreted as help.

Command Parameters

Most commands given in the user guide utilise various parameters which are also known as prefixes. To add a prefix to your command, follow this format: PREFIX/MESSAGE. A list of prefixes and their respective constraints are given in the table below.

Back to Table of Contents

---

Features

This section describes each of the commands and features available in F.A.K.E.J.A.R.V.I.S.

General Commands

This section describes commands that fit in no special category.

👀Viewing help : help

You can view a message detailing how to access the user guide if you require assistance in understanding the different commands and their formats.

Format: help

📖Example 1:

Input: help Opens up the help window.

Output: Opened help window.

Output Image:

🔀Switching between different Tabs: tab

You can navigate between different tabs in F.A.K.E.J.A.R.V.I.S. to view different lists on the panel.

Format: tab TAB_INDEX

📖Example 1:

Input: tab 1 Switches to the student list tab.

Output: Switched to tab 1

Output Image:

Clearing all Entries : clear

You can clear all data from F.A.K.E.J.A.R.V.I.S. if you need to delete the database.

Format: clear

📖Example 1:

Input: clear Deletes all data in F.A.K.E.J.A.R.V.I.S.

Output: Address book has been cleared!

Output Image:

🏃🚪Exiting F.A.K.E.J.A.R.V.I.S. : exit

You can exit the F.A.K.E.J.A.R.V.I.S. application if you're done using the application.

Format: exit

💾Saving the Data

F.A.K.E.J.A.R.V.I.S. data are saved in the hard disk automatically after any command that changes the data. There is no need to save the data manually.

🛠️Editing the Data File

F.A.K.E.J.A.R.V.I.S. data are saved automatically as a JavaScript Object Notation (JSON) file [JAR file location]/data/fakejarvis.json. Advanced users are welcome to update the data directly by editing that data file.

💾Archiving Data Files [coming in v2.0]

Stay tuned for more features and enhancements in v2.0, including archiving data files and more!

Back to Table of Contents

---

Student Management

This section describes commands that help you manage your students.

📝Adding a Student: add

You can add a student to F.A.K.E.J.A.R.V.I.S. if you need to keep track of new students.

Format: add n/NAME p/PHONE e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TEST]

📖Example 1:

Input: add n/John Doe p/98765432 e/johnd@u.nus.edu th/johnny01 gt/RA1:0 | RA2:0 | MidTerms:0 | Finals:0 | PE:0 Adds a person called John Doe into F.A.K.E.J.A.R.V.I.S. He has 98765432 as his phone number, johnd@u.nus.edu as his email and johnny01 as his telegram handle. All his grades are also set to 0.

Output: New person added: Name: John Doe; Phone: 98765432; Email: johnd@u.nus.edu; Telegram Handle: johnny01; Tags: ; Graded Test: RA1: 0; RA2: 0; MidTerms: 0; Final: 0; PE: 0

Output Image:

👀Listing all Students : list

You can list out all students in F.A.K.E.J.A.R.V.I.S. if you need to view the complete student list.

Format: list

📖Example 1:

Input: list Shows all the students currently in F.A.K.E.J.A.R.V.I.S.

Output: Listed all persons

Output Image:

🛠️Editing a Student Field : edit

You can edit an existing student's fields in F.A.K.E.J.A.R.V.I.S. if you need to make changes to a student's information.

Format: edit STUDENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [th/TELEGRAM_HANDLE] [t/TAG]…​ [gt/GRADED_TEST]

📖Example 1:

Input: edit 1 p/91234567 e/johndoe@u.nus.edu Edits the phone number and email address of the 1st person to be 91234567 and johndoe@u.nus.edu.

Output: Edited Person: Name: Alex Yeoh; Phone: 91234567; Email: johndoe@u.nus.edu; Telegram Handle: alexYeohh; Tags: [friends]; Graded Test: RA1: -; RA2: -; MidTerms: 3; Final: 4; PE: 5

Output Image:

🔎Finding Student by Name: find

You can find a student in F.A.K.E.J.A.R.V.I.S. if you're looking for certain students by their names.

Format: find KEYWORD…

📖Example 1:

Input: find John Finds students who have the john in their name.

Output: 1 persons listed!

Output Image:

❌Deleting a Student : delete

You can delete a specific student from F.A.K.E.J.A.R.V.I.S. if they're no longer your student.

Format: delete STUDENT_INDEX

📖Example 1:

Input: list followed by delete 2 Deletes the 2nd student in F.A.K.E.J.A.R.V.I.S.

Output: Deleted Person: Name: Bernice Yu; Phone: 99272758; Email: berniceyu@u.nus.edu; Telegram Handle: berrynice123; Tags: [colleagues][friends]; Graded Test: RA1: -; RA2: -; MidTerms: 3; Final: 4; PE: 5

Output Image:

Back to Table of Contents

---

Task Management

This section describes commands that help you manage your tasks.

📝Adding a Task: addtask

You can add a task to your task list if you have a new item to include in your list of things to do.

Format: addtask tn/TASK_NAME [td/TASK_DESCRIPTION] [d/DATE] [tp/TASK_PRIORITY]

📖Example 1:

Input: addtask tn/Prepare Lecture slides d/30/09/2023 tp/high Creates a task to prepare lecture slides with a high priority due on September 30, 2023.

Output: Task has been added: Prepare Lecture slides; Description: No Description Provided; Priority: HIGH; Date: 2023-09-30; Progress: NOT_STARTED

Output Image:

👀Viewing Tasks: viewtasks

You can view your list of tasks if you want to check and manage your current set of to-do list.

Format: viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DATE] / [tp/TASK_PRIORITY] / [tprog/TASK_PROGRESS]

📖Example 1:

Input: viewtasks Displays all tasks in the user's task list.

Output: 4 tasks listed!

Output Image:

📖Example 2:

Input: viewtasks d/30/09/2023 Displays tasks due on September 30, 2023.

Output: 1 tasks listed!

Output Image:

🛠️Updating a Task's Progress: updateprogress

You can update a task's progress if there are changes to the status of a particular task on your list.

Format: updateprogress TASK_INDEX tprog/NEW_PROGRESS

📖Example 1:

Input: updateprogress 1 tprog/pending Updates the progress of the 1st task as pending.

Output: Updated Task: Do 2103T; Description: Homework assignment; Priority: HIGH; Date: 2023-10-22; Progress: PENDING

Output Image:

❌Deleting a Task: deletetask

You can delete a task from your task list if you no longer need to keep it on your list of things to do.

Format: deletetask TASK_INDEX

📖Example 1:

Input: deletetask 3 Deletes the 3rd task from the task list.

Output: Deleted Task: Do cs2100; Description: Remember mips; Priority: HIGH; Date: 2023-10-22; Progress: DONE

Output Image:

Back to Table of Contents

---

Attendance Management

This section describes commands that help you manage your students' attendance.

📆Taking Attendance: takeattendance

You can take the attendance of your student(s) if you need to record their presence for a session.

Format: takeattendance n/NAME s/SESSION_NUMBER ap/PRESENCE

📖Example 1:

Input: takeattendance n/Alex Yeoh s/1 ap/present Marks Alex Yeoh as present on the 1st session.

Output: Attendance taken

Output Image:

👀Viewing Attendance: viewattendance

You can view the attendance list of your students if you want to check and review their attendance records.

Format: viewattendance [n/NAME]…

📖Example 1:

Input: viewattendance Displays the overall attendance across all students and sessions.

Output: 2 sessions listed!

Output Image:

📖Example 2:

Input: viewattendance n/David Li n/Alex Yeoh Displays all the sessions that David Li and Alex Yeoh have attended.

Output: 2 sessions listed!

Output Image:

Back to Table of Contents

---

Assignment Management

This section describes commands that help you manage your students' assignments.

👀Viewing a list of Assignments: viewassignments

You can view the list of assignment grades and comments of a student if you want to assess and review the feedback provided for each assignment.

Format: viewassignments STUDENT_INDEX

📖Example 1:

Input: viewassignments 2 shows the 2nd student's assignment grades and comments.

Output: Showing all assignment details of: Charlotte Oliveiro

Output Image:

🛠️Editing an Assignment Grade: editgrade

You can edit your student's assignment grade if there is a need to make adjustments or corrections to the initially assigned grade.

Format: editgrade STUDENT_INDEX as/ASSIGNMENT g/GRADE

📖Example 1:

Input: editgrade 1 as/Rune Trials g/600 Edits the grade of the 1st student's Rune Trial assignment to 600.

Output: Edited grade to assignment: Rune Trials

Output Image:

❌Deleting an Assignment Grade: deletegrade

You can delete your student's assignment grade if you need to remove or reset the previously assigned grade for a particular assignment.

Format: deletegrade STUDENT_INDEX as/ASSIGNMENT

📖Example 1:

Input: deletegrade 1 as/Rune Trials deletes the 1st student's Rune Trials grade.

Output: Deleted grade from assignment: Rune Trials

Output Image:

🛠️Editing an Assignment Comment: editcomment

You can edit the comment of your student's assignment if you need to make changes or additions to the feedback provided for a specific assignment.

Format: editcomment STUDENT_INDEX as/ASSIGNMENT c/COMMENT

📖Example 1:

Input: editcomment 1 as/Rune Trials c/Decent Changes the comment on the 1st student's Rune Trials assignment to “Decent”.

Output: Edited comment to assignment: Rune Trials

Output Image:

❌Deleting an Assignment Comment: deletecomment

You can delete the comment tagged to your student's assignment if you want to remove or revise the feedback associated with that particular assignment.

Format: deletecomment STUDENT_INDEX as/ASSIGNMENT

📖Example 1:

Input: deletecomment 1 as/Rune Trials Deletes the comment on the 1st student's Rune Trials assignment if it exists.

Output: Deleted comment from assignment: Rune Trials

Output Image:

Back to Table of Contents

---

Graded Test Management

This section describes commands tht help you manage your students' graded tests.

🛠️Editing a Graded Test Score: editgradedtest

You can edit your student's graded test scores if you need to make adjustments or corrections to their initially recorded test scores.

Format: editgradedtest STUDENT_INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICAL_EXAM]

📖Example 1:

Input: editgradedtest 1 ra1/1 ra2/2 mt/3 f/4 pe/5 Edits the corresponding graded test scores for the 1st person Alex Yeoh.

Output: Edited Person: Name: Alex Yeoh; Phone: 91234567; Email: johndoe@u.nus.edu; Telegram Handle: alexYeohh; Tags: [friends]; Graded Test: RA1: 1; RA2: 2; MidTerms: 3; Final: 4; PE: 5

Output Image:

Back to Table of Contents

---

Session Management

This section describes commands that help you manage your sessions.

📝Creating a Session: createsession

You can create a session for any upcoming or past sessions if you need to schedule or document your class sessions in the system.

Format: createsession s/SESSION_NUMBER [n/NAME]…

📖Example 1:

Input: createsession s/3 n/Alex Yeoh Creates a session with session no. 3 with Alex Yeoh.

Output: New session added: Session: 3; Students: Alex Yeoh; Remark: NA

Output Image:

🛠️Updating a Session's Remark: updatesessionremark

You can update an existing session's remark if you need to change or add additional information to the session notes or details.

Format: updatesessionremark s/SESSION_NUMBER r/SESSION_REMARK

📖Example 1:

Input: updatesessionremark s/2 r/Teach Essence of Recursion Updates the remark for session number 2 to "Teach Essence of Recursion".

Output: Session remarks updated: Session: 2; Students: Charlotte Oliveiro David Li Alex Yeoh Irfan Ibrahim Roy Balakrishnan ; Remark: Teach Essence of Recursion

Output Image:

❌Deleting a Session: deletesession

You can delete an existing session specified by its session number if you need to remove or clear the session record from the system.

Format: deletesession s/SESSION_NUMBER

📖Example 1:

Input: deletesession s/1 Deletes the session with session number 1 from the session list.

Output: Deleted Session: Session: 1; Students: Charlotte Oliveiro David Li Alex Yeoh Irfan Ibrahim Roy Balakrishnan ; Remark: NA

Output Image:

Back to Table of Contents

---

Consultation Management

This section describes commands that help you manage your consultations with students.

📝Creating a Consultation: createconsult

You can create a consultation with your students if you need to schedule or document consultations in the system.

Format: createconsult d/DATE tt/TIME [n/NAME]…

📖Example 1:

Input: createconsult d/30/10/2023 tt/12:30 n/Alex Yeoh Creates a consultation for Alex Yeoh on 2023-10-30 12:30.

Output: New consultation added: Date: 2023-10-30; Time: 12:30; Students: Alex Yeoh

Output Image:

📝️Adding Students to a Consultation: addtoconsult

You can add your student(s) into a consultation slot if you need to track students in your consultations.

Format: addtoconsult CONSULTATION_INDEX n/NAME…

📖Example 1:

Input: addtoconsult 1 n/David Li n/Roy Balakrishnan Adds David Li and Roy Balakrishnan to the 1st consultation in the list.

Output: New student(s) added to consultation at index 1: Date: 2023-11-11; Time: 11:11; Students: Bernice Yu, David Li, Alex Yeoh, Roy Balakrishnan

Output Image:

❌Removing Students from a Consultation: removefromconsult

You can remove your student(s) from a consultation if you need to cancel your student's participation in the scheduled consultation.

Format: removefromconsult CONSULTATION_INDEX n/NAME…

📖Example 1:

Input: removefromconsult 1 n/David Li Removes David Li from the 1st consultation in the list.

Output: Student(s) removed from consultation at index 1: Date: 2023-11-11; Time: 11:11; Students: Alex Yeoh, Roy Balakrishnan

Output Image:

❌Deleting a Consultation: deleteconsult

You can delete the consultation slot specified by an index if you need to remove or clear the scheduled consultation from the system.

Format: deleteconsult CONSULTATION_INDEX

📖Example 1:

Input: deleteconsult 1 Deletes the 1st consultation in the consultation list.

Output: Deleted Consultation: Date: 2023-11-11; Time: 11:11; Students: Alex Yeoh, Roy Balakrishnan

Output Image:

Back to Table of Contents

---

FAQ

Back to Table of Contents

---

Known Issues

Back to Table of Contents

---

Back to Table of Contents

---

Contacting Support

If you need further assistance with F.A.K.E.J.A.R.V.I.S. please contact our support team at support@fakejarvis.org.