Skip to content

Latest commit

 

History

History
413 lines (301 loc) · 13.3 KB

UserGuide.adoc

File metadata and controls

413 lines (301 loc) · 13.3 KB
Raw

EazyTutors - User Guide

By: Team W12-4 Since: Aug 2018 Licence: MIT

1. Introduction

EazyTutors is an application for tutors or teachers who prefer a virtual way to record students’ attendance. It also boasts extra features to check on students’ progress and helps users customise their teaching to students with different capabilities. EazyTutors is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). You won’t need to bring around attendance sheets anymore with EazyTutors! Interested? Jump to Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

  1. Ensure that you have Java version 9 or later installed in your Computer.

  2. Copy the file to the folder you want to use as the home folder for EazyTutors.

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

    Ui

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

  5. Some example commands you can try:

    • addn/John Doe p/999 e/police@hotmail.com t/cops: Adds a contact named John Doe to the student list

    • select1: views the details of the 1st student shown in the student list

    • delete3 : deletes the 3rd student shown in the student list

    • exit : exits the app

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

3. Features

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 [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

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

  • Parameters can be in any order if all the parameters have prefixes e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

3.1. Viewing help : help

Shows all commands available with examples. Format: help

3.2. Adding a student: add

Adds a student at INDEX with a compulsory name. The other information (index at list to add him to, phone number, email and tags) is optional.
Format: add n/NAME [p/PHONE_NUMBER e/EMAIL a/ADDRESS s/INDEX t/TAG…​]

💡
 Students are added to the bottom of the student list by default. A student can have multiple tags (or none). Whitespace between different parameters do not affect the result, such as between s/1 and n/John Doe.

Examples:

  • add n/John Doe p/98765432 e/johnd@example.com t/CS2103 (Added to the bottom of the student list as index not specified)

  • add n/Betsy Crowe s/1 e/betsycrowe@example.com t/CS2103T (The order of the parameters can be swapped around as all parameters have prefixes)

3.3. Listing all students : list

Shows the list of all students in the student list. Format: list

3.4. Locating students by name : find

Finds students whose names contain any of the given keywords. Format: find 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

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

Examples:

  • find John
    Returns john and John Doe

  • find Betsy Tim John
    Returns any person having names Betsy, Tim, or John

3.5. Clearing all entries : clear

Clears all entries from the student list.
Format: clear

3.6. Deleting a student : delete

Deletes a student from the student list.
Format: delete INDEX

  • There can be any number of spaces between delete and 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, …​

Examples:

  • delete 2
    Deletes the 2nd person in the student list.

3.7. Selecting a student : select

Selects the student identified by the index number used in the displayed student list. Format: select INDEX

  • Selects the student and loads the Google search page 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, …​

Examples:

  • list
    select 2
    Selects the 2nd student in the student list.

  • find Betsy
    select 1
    Selects the 1st student in the results of the find command.

3.8. Adding a profile photo : addphoto

Adds a profile photo to a student

Format: addphoto INDEX f/FILENAME

  • Adds a photo at location FILENAME to person at the specified INDEX. The index refers to the index number shown in the last person listing. The index must be a positive integer 1, 2, 3, …​

  • FILENAME must point to a valid image file.

Examples:

  • addphoto 1 f/C://Users/Zackk95/Pictures/zacharytan.jpg
    Edits the profile photo of the 1st person to be the picture at C://Users//Zackk95//Pictures//zacharytan.jpg

3.9. Deleting a student’s photo: deleteProfilePhoto

Delete a student’s photo and sets it to the default photo.
Format: deleteProfilePhoto INDEX

  • Will delete a student’s photo and set it to the default photo.

  • This command is irreversible!

Examples:

  • deleteProfilePhoto 1
    Delete the photo of the person at index 1 and set it to the default photo.

3.10. Undoing previous command : undo

Restores the student list to the state before the previous undoable command was executed.
Format: undo

ℹ️

Undoable commands: those commands that modify the student list’s content (add, delete, edit, addAssignment, deleteAssignment, markAssignment, attend, note, delnote, editnote and clear).

Examples:

  • delete 1
    select 2 undo (reverses the delete 1 command)

  • results
    select 1
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)

3.11. Redoing the previously undone command : redo

Reverses the most recent undo command only if the last command is undo.
Format: redo

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)
    redo (reapplies the clear command)

3.12. Exiting the program : exit

Exits the program.
Format: exit

3.13. Mark a student’s attendance as present: attend

Records the attendance of a student as present for a specified class.
Format: attend INDEX at/CLASSNAME

3.14. Mark a student’s attendance as absent: unattend {Coming in v1.4}

Records the attendance of a student as absent for a specified class.
Format: unattend INDEX at/CLASSNAME

3.15. Sort the student list: sort

Sort the student list by alphabetical order.
Format: sort

3.16. Add an assignment: addAssignment

Adds an assignment with given assignment name, weight, deadline, maximum mark.
Format: addAssignment n/ASSIGNMENTNAME w/WEIGHT d/DEADLINE m/MAX_MARK

3.17. Delete an assignment: deleteAssignment

Delete an assignment with given assignment index.
Format: deleteAssignment INDEX

3.18. Edit an assignment: editAssignment

Edit an existing assignment with specified informations. Format: editAssignment INDEX [n/ASSIGNMENTNAME] [w/WEIGHT] [d/DEADLINE] [m/MAX_MARK]

3.19. Sort all assignment: sortAssignment

Sort all assignment by deadline.
Format: sortAssignment

3.20. Record a mark for a student: markAssignment

Adds a mark for an assignment associated with a student given the mark obtained. Can mark more than maxMark in case of bonus score.
Format: markAssignment INDEX id/ASSIGNMENT_INDEX m/MARK

3.21. Display the statistics for an assignment: assignmentStats

Display the statistics for the specified assignment.
Format: assignmentStats INDEX

3.22. Display the statistics for an assignment: classStats

Display the statistics for the overall grades of students.
Format: classStats

3.23. Editing a student: edit

Edits an existing student in the student list.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [t/TAG]…​

  • Edits the person 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 person will be removed i.e adding of tags is not cumulative.

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

Examples:

  • edit 1 p/91234567 e/johndoe@example.com
    Edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.

  • edit 2 n/Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.24. Viewing command history : history

Lists all the commands that you have entered in reverse chronological order.
Format: history

3.25. Add a note about a student : note

Attaches a note with TEXT to a student in the student list specified by his/her INDEX.
Format: note INDEX TEXT

  • Any added note is automatically ended with a full stop unless the input TEXT ends with either ., ! or ?.

  • If a note is added to a student who already has a previous note, the previous note is changed to end with a comma before the new text is appended to the back.

ℹ️
 TEXT should not begin with a whitespace but alphanumeric and special characters are allowed.

Examples:

  • note 1 hardworking student
    (Adds the text hardworking student. to the student at index 1)
    note 1 motivated too!
    (Note for student at index 1 is now hardworking student, motivated too!)

3.26. Delete a student’s note : delnote

Deletes the corresponding note of the student at the specified INDEX.
Format: delnote INDEX

  • There can be any number of spaces between delnote and INDEX.

ℹ️
 An empty note cannot be deleted!

Examples:

  • delnote 2 (Deletes the note of the 2nd student shown, is invalid if there is less than 2 students in the shown student list.)

3.27. Edits the note of a student : editnote

Edits the corresponding note of the student at the specified INDEX to TEXT. Refer to Section 3.25, “Add a note about a student : note” for details on TEXT.
Format: editnote INDEX TEXT

ℹ️
 An empty note cannot be edited!

Examples:

  • note 1 check finals mark addition (Note is now: check finals mark addition.
    note 1 check midterms also? (Note is now: check finals mark addition, check midterms also?)
    editnote marks checked. (Note is now: marks checked.)
    delnote 1 (Note deleted and reset to default <No note added>)

ℹ️

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

4. Command Summary

  • Add : add n/NAME [s/INDEX p/PHONE_NUMBER e/EMAIL t/TAG]…​
    e.g. add n/James Ho s/1 p/22224444 e/jamesho@example.com t/friend t/colleague

  • AddAssignment : addAssignment n/NAME w/WEIGHT d/DEADLINE m/MAX_MARK
    e.g. addAssignment n/Assignment 1 w/15 d/14/10/2019 m/100

  • AssignmentStats : assignmentStats INDEX
    e.g. assignmentStats 1

  • Attend : attend INDEX at/CLASSNAME
    e.g. attend 1 at/Tutorial 1

  • ClassStats : classStats

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • DeleteAssignment : deleteAssignment INDEX
    e.g. deleteAssignment 3

  • Delnote : delnote INDEX
    e.g. delnote 2

  • Edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…​
    e.g. edit 2 n/James Lee e/jameslee@example.com

  • EditAssignment : editAssignment INDEX [n/NAME] [w/WEIGHT] [d/DEADLINE] [m/MAXMARK]
    e.g. edit 2 n/Assignment3 w/40

  • Editnote : editnote INDEX TEXT
    e.g. editnote 1 Consult changed to 3pm

  • Exit : exit

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

  • Help : help

  • History : history

  • List : list

  • MarkAssignment : markAssignment INDEX id/ASSIGNMENT_INDEX m/MARK
    e.g. markAssignment 1 id/1 m/53

  • Note : note INDEX TEXT
    e.g. note 4 Good student

  • Redo : redo

  • Select : select INDEX e.g. select 2

  • Sort : sort

  • SortAssignment : sortAssignment

  • Unattend : unattend INDEX at/CLASSNAME {Coming in v1.4}

  • Undo : undo