From 214f846cdaecfd0b250dabcbd361411f7488003c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 13 Apr 2024 04:04:50 +0000 Subject: [PATCH] deploy: f953a499cf861f032e21f64319096f0557767ad4 --- AboutUs.html | 2 +- AboutUs.page-vue-render.js | 2 +- Configuration.html | 2 +- Configuration.page-vue-render.js | 2 +- DevOps.html | 2 +- DevOps.page-vue-render.js | 2 +- DeveloperGuide.html | 2 +- DeveloperGuide.page-vue-render.js | 2 +- Documentation.html | 2 +- Documentation.page-vue-render.js | 2 +- Logging.html | 2 +- Logging.page-vue-render.js | 2 +- SettingUp.html | 2 +- SettingUp.page-vue-render.js | 2 +- Testing.html | 2 +- Testing.page-vue-render.js | 2 +- UserGuide.html | 24 +++++++----- UserGuide.page-vue-render.js | 41 +++++++++++++-------- index.html | 2 +- index.page-vue-render.js | 2 +- siteData.json | 11 +++--- team/johndoe.html | 2 +- team/johndoe.page-vue-render.js | 2 +- tutorials/AddRemark.html | 2 +- tutorials/AddRemark.page-vue-render.js | 2 +- tutorials/RemovingFields.html | 2 +- tutorials/RemovingFields.page-vue-render.js | 2 +- tutorials/TracingCode.html | 2 +- tutorials/TracingCode.page-vue-render.js | 2 +- 29 files changed, 71 insertions(+), 57 deletions(-) diff --git a/AboutUs.html b/AboutUs.html index d33e0cadbaa..562c8404423 100644 --- a/AboutUs.html +++ b/AboutUs.html @@ -22,7 +22,7 @@
  • About Us

    • About Us

    We are a team based in the School of Computing, National University of Singapore.

    You can reach us at the email seer[at]comp.nus.edu.sg

    Project team

    Justin Leng Chern Harn

    [github] [portfolio]

    Lee Poe Aik

    [github] [portfolio]

    Chia Rena

    [github] [portfolio]

    Safwan Hussein

    [github] -[portfolio]

    +[portfolio]

    + TutorTrack - AddressBook Level-3 @@ -14,25 +14,31 @@ - +

    TutorTrack User Guide

    TutorTrack is a desktop app for tutors to manage their students and scheduled classes, optimized for use via a Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, TutorTrack can get your contact management tasks done faster than traditional GUI apps.

    What is in this user guide:

    • Quick start
    • Features -
      • Help : Viewing help
      • Add : Adding a student
      • List : Listing all students
      • Edit : Editing a student
      • Find : Finding a student
      • Schedule: Scheduling a lesson
      • Mark: Marking a lesson as done
      • Remark: Add remark to a student
      • Delete : Deleting a student
      • Schedule : Adding a lesson schedule to a student
      • Mark : Mark a lesson as complete
      • Clear : Clearing all entries
      • Exit : Exiting the program
      • Saving data
      • Editing the data file
      • Archiving data files
    • FAQs
    • Known issues
    • Command summary

    How to use this guide

    Navigation : Use the table of contents to find the section you are looking for.

    Features : Each feature and what they do are listed with their commands for you to understand what our app can do.

    Examples : Under each feature, examples of commands and UI are given for you to better understand how the app should work.

    Getting started : For first time users, refer to the "Quick start" segment to start up the app for the first time

    Quick start

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

    2. Download the latest TutorTrack.jar from here.

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

    4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar TutorTrack.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.
      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.
      -Some example commands you can try:

      • list : Lists all contacts.

      • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 s/Maths : Adds a student named John Doe to the Address Book.

      • delete 3 : Deletes the 3rd student shown in the current list.

      • clear : Deletes all contacts.

      • exit : Exits the app.

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

    Features

    Notes about the command format:

    • Words in UPPER_CASE are the parameters to be supplied by the user.
      +

  • About Us

    • TutorTrack User Guide

    TutorTrack is a desktop application for tutors to manage their students and scheduled classes, 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, TutorTrack can get your contact management tasks done faster than traditional GUI apps.

    How to use this guide

    Navigation : Use the table of contents to find the section you are looking for.

    Features : Each feature and what it does is listed with its respective command for you to understand what Tutor +Track can do.

    Examples : Under each feature, examples of commands and UI are given for you to better understand how Tutor Track +works.

    Getting started : For first time users, refer to the "Quick start" segment to start up Tutor Track for the first +time.

    What is in this User Guide:

    Quick start

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

    2. Download the latest TutorTrack.jar from here.

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

    4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar TutorTrack.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.
      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.

    Here are some example commands you can try:

    • list : Lists all students.

    • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 s/Maths : Adds a student named +John Doe to the Address Book.

    • delete 3 : Deletes the 3rd student shown in the current list.

    • clear : Deletes all students.

    • exit : Exits the Tutor Track application.

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

    Features

    Notes about the command format:

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

    • Items in square brackets are optional.
      e.g n/NAME [l/LESSON] can be used as n/John Doe l/2024-05-01|09:00 or as n/John Doe.

    • Items with …​ after them can be used multiple times including zero times.
      e.g. [l/LESSON]…​ can be used as (i.e. 0 times), l/2024-05-01|09:00, l/Maths|2024-05-03|10:30 l/Biology|2024-05-05|11:00 etc.

    • Parameters can be in any order.
      e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/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.

    • If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.

    Viewing help : help

    Shows a message explaning how to access the help page.

    help message

    Format: help

    Adding a person: add

    Adds a student to the address book.

    Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SUBJECT [l/LESSON]…​

    Tip: A student can have any number of lessons (including 0)

    Examples:

    • add n/John Poe p/84920491 e/poe@yuh.com a/RVRC s/Physics addStudentExample.png

    Listing all students : list

    Shows a list of all students in the address book.

    Format: list

    Editing a student : edit

    Edits an existing student in the address book.

    Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [s/SUBJECT]…​

    • 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 lessons, the existing lessons of the student will be removed i.e adding of lessons is not cumulative.
    • You can remove all the person’s lessons by typing l/ without +e.g. if the command specifies help 123, it will be interpreted as help.

    • If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.

    Viewing help : help

    Shows a message with a link to access the help page.

    help message

    Format: help

    Adding a Student: add

    Adds a student to the address book.

    Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SUBJECT [l/LESSON]…​

    Tip: A student can have any number of lessons (including 0)

    Examples:

    Here are some constraints for the add command.

    Listing all Students : list

    Shows a list of all students in the address book.

    Format: list

    Editing a Student : edit

    Edits an existing student in the address book.

    Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [s/SUBJECT]…​

    Examples:

    Locating students by name: find

    Finds persons whose names contain any of the given keywords.

    Format: find KEYWORD [MORE_KEYWORDS]

    Examples:

    Deleting a person : delete

    Deletes the specified person from the address book.

    Format: delete INDEX

    Examples:

    Add a lessson schedule : schedule

    Adds a lesson to a specific student.

    Format : schedule INDEX l/LESSON

    Examples:

    image

    Mark a lessson schedule : mark

    Mark a lesson as complete to a specific student and removing it from displaying.

    Format : mark INDEX l/LESSON

    Examples:

    image

    Add remark to a student : remark

    Format : remark INDEX r/REMARK

    Examples:

    Clearing all entries : clear

    Clears all entries from TutorTrack.

    Format: clear

    Exiting the program : exit

    Exits the program.

    Format: exit

    Saving the data

    TutorTrack 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

    TutorTrack 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.

    Caution: +e.g. Hans Bo will return Hans Gruber, Bo Yang

    Examples:

    • find poe returns Poe John Poe
      findCommandExample.png

    Deleting a Student : delete

    Deletes the specified person from the address book.

    Format: delete INDEX

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

    Examples:

    • list followed by delete 2 deletes the 2nd student in TutorTrack.
    • find Jessica Jane followed by delete 1 deletes the 1st person in the results of the find command.

    Add a lessson schedule : schedule

    Adds a lesson to a specific student.

    Format : schedule INDEX l/LESSON

    • Adds a lesson to the specified INDEX.
    • INDEX must be a positive integer 1, 2, 3, ...
    • INDEX refers to the index number shown in the displayed person list.
    • LESSON must be in the format of dd-mm-yyyy|hh:mm

    Examples:

    • schedule 1 l/09-09-2024|10:00 would add a new lesson at 09-09-2024, 10:00 to the first person on the student list.
    image

    Mark a lessson schedule : mark

    Mark a lesson as complete to a specific student and removing it from displaying.

    Format : mark INDEX l/LESSON

    • Adds a lesson to the specified INDEX.
    • INDEX must be a positive integer 1, 2, 3, ...
    • INDEX refers to the index number shown in the displayed person list.
    • LESSON must be in the format of dd-mm-yyyy|hh:mm

    Examples:

    • mark 1 l/09-09-2024|10:00 would mark a lesson at 09-09-2024, 10:00 as completed to the first person on the student list.
    • Completed lessons will not show up in the list of lessons for the student.
    image

    Add remark to a student : remark

    Format : remark INDEX r/REMARK

    • Adds a remark to a student by specifying the INDEX.
    • INDEX must be a positive integer 1, 2, 3, ...
    • INDEX refers to the index number shown in the displayed person list.

    Examples:

    • remark 1 r/Student is very hardworking would add a remark to the first student on the student list.

    Clearing all entries : clear

    Clears all entries from TutorTrack.

    Format: clear

    Exiting the program : exit

    Exits the program.

    Format: exit

    Saving the data

    TutorTrack 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

    TutorTrack 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.

    Caution: If your changes to the data file makes its format invalid, TutorTrack will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
    -Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

    Archiving data files [coming in v2.0]

    Details coming soon ...

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

    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

    Action Format, Examples
    Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SUBJECT [l/LESSON]…​
    e.g., add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 s/Maths l/Maths |2024-05-03|10:30
    Clear clear
    Delete delete INDEX
    e.g., delete 3
    Edit edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [l/LESSON]…​
    e.g.,edit 2 n/James Lee e/jameslee@example.com
    Fee Status feestatus INDEX f/FEESTATUS
    Find find KEYWORD [MORE_KEYWORDS]
    e.g., find James Jake
    Remark remark INDEX r/REMARK
    e.g., remark 1 r/Needs extra practice
    Schedule schedule INDEX l/LESSON
    e.g., schedule 1 l/ 20-05-2024|10:30
    Mark mark INDEX l/LESSON
    List list
    Help help
    [Powered by MarkBind 5.4.0, generated on Thu, 11 Apr 2024, 16:05:11 GMT+8]
    +Furthermore, certain edits can cause the AddressBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

    Archiving data files [coming in v2.0]

    Details coming soon ...

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

    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

    Action Format, Examples
    Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SUBJECT [l/LESSON]…​
    e.g., add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 s/Maths l/Maths |2024-05-03|10:30
    Clear clear
    Delete delete INDEX
    e.g., delete 3
    Edit edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [l/LESSON]…​
    e.g.,edit 2 n/James Lee e/jameslee@example.com
    Fee Status feestatus INDEX f/FEESTATUS
    Find find KEYWORD [MORE_KEYWORDS]
    e.g., find James Jake
    Remark remark INDEX r/REMARK
    e.g., remark 1 r/Needs extra practice
    Schedule schedule INDEX l/LESSON
    e.g., schedule 1 l/ 20-05-2024|10:30
    Mark mark INDEX l/LESSON
    List list
    Help help