Skip to content

Latest commit

 

History

History
439 lines (328 loc) · 14.9 KB

UserGuide.adoc

File metadata and controls

439 lines (328 loc) · 14.9 KB

EduBuddy - User Guide

By: CS2103JAN2018-T09-B1 Since: Mar 2018 Licence: MIT

1. Introduction

EduBuddy is for those who prefer to use a desktop app for managing student profiles. More importantly, EduBuddy 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). If you can type fast, EduBuddy can get your student profile management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    ℹ️
    		 Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest EduBuddy.jar here.

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

  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:

    • list or l : lists all students

    • add or an/John Doe p/91234567 ic/S9315585J t/1A t/20 sub/English B3 : adds a student named John Doe to the Address Book.

    • delete or d3 : deletes the 3rd student shown in the current list

    • exit : exits the app

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

  • Parameters can be in any order e.g. if the command specifies n/NAME ic/S9500186H, ic/S9500186H n/NAME is also acceptable.

  • Items in square brackets are optional. e.g n/NAME [t/CLASS] can be used as n/John Doe t/1A or as n/John Doe.

  • Command input is not case sensitive, e.g 'fInD Alex' , 'find alex' works the same.

3.1. Viewing help : help

Shows the help page.
Format: help

3.2. Adding a person: add or a

Adds a person to EduBuddy
Format: add n/NAME p/PHONE_NUMBER ic/NRIC t/CLASS t/CLASS_REGISTER sub/SUBJECT_NAME SUBJECT_GRADE Abbreviation Format: a n/NAME p/PHONE_NUMBER ic/NRIC t/CLASS t/CLASS_REGISTER sub/SUBJECT_NAME SUBJECT_GRADE

  • At least 1 subject from each L1R5 category should be assigned to a student.

  • For example: English, Mathematics, History, Chinese, Physics, Music.

  • For more examples on what subjects can be added, please refer to the FAQ section below.

Examples:

  • add n/John Doe p/91234567 ic/S9500186H t/1A t/20 sub/English B3 sub/Mathematics A2

  • add n/Betsy Crowe p/91234567 t/2B t/21 ic/S9511111I

  • a n/John Doe p/91234567 ic/S9500186H t/1A t/2 sub/English B3 sub/Mathematics A2

  • a n/Betsy Crowe p/91234567 t/2B t/21 ic/S9511111I

3.3. Listing all student : list or l

Shows a list of all students in EduBuddy.
Format: list
Abbreviation Format: l

3.4. Sorting students : sort [since v1.2]

Sorts the list of students in EduBuddy according to the given parameter
Format: sort PARAMETER

  • List of available PARAMETER: name, tag

Examples:

  • sort name
    Sorts the list of students by name in alphabetical order (case insensitive).

  • sort tag
    Sorts the list of students by tag in alphabetical and numerical order (case insensitive)

3.5. Editing a student : edit or e

Edits an existing student in EduBuddy.
Format: edit INDEX [n/NAME] [p/PHONE_NUMBER] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE]
Abbreviation Format: e INDEX [n/NAME] [p/PHONE_NUMBER] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE]

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

  • edit 1 ic/S9123456A
    Edits the nric number of the 1st student to be S9123456A respectively.

  • edit 2 n/Betsy Crower
    Edits the name of the 2nd student to be Betsy Crower.

  • e 1 ic/S9123456A
    Edits the nric number of the 1st student to be S9123456A respectively.

  • e 2 n/Betsy Crower
    Edits the name of the 2nd student to be Betsy Crower.

3.6. Locating students by name: find or f

Finds persons whose names contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS] Abbreviation Format: f 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:

  • find John or f John
    Returns john and John Doe

  • find Betsy Tim John or f Betsy Tim John
    Returns any student having names Betsy, Tim, or John

3.7. Deleting a student : delete or d

Deletes the specified student from EduBuddy.
Format: delete INDEX
Abbreviation Format: d INDEX

  • Deletes the student at the specified INDEX.

  • The index refers to the index number shown in the most recent listing.

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

Examples:

  • list
    d 2
    Deletes the 2nd student in EduBuddy.

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

3.8. Deleting a tag : tagdelete or td [since v1.1]

Deletes the specified tag from every student in EduBuddy.
Format: tagdelete TAGNAME
Abbreviation Format: td TAGNAME

  • Deletes the specified tag from every student in Edubuddy.

  • The tag must be a valid tag name that is assigned to at least one student in Edubuddy.

Examples:

  • tagdelete Class1A or td Class1A
    Deletes the 'Class 1A' tag from every student in the EduBuddy.

3.9. Replacing a tag : tagreplace or tr [since v1.2]

Replaces the specified tag from every student in EduBuddy with a specific tag.
Format: tagreplace t/TAGNAME t/TAGNAME Abbreviation Format: tr t/TAGNAME t/TAGNAME

  • Replaces the specified tag from every student in Edubuddy with a specific tag.

  • The tag refers to the index number shown in the most recent listing.

  • The tag must be a valid tag name that is assigned to at least one student in the Edubuddy.

Examples:

  • tagreplace t/Class1A t/Class2A or tr t/Class1A t/Class2A
    Replaces the 'Class 1A' tag from every student in the EduBuddy with 'Class 2A'.

3.10. Selecting a person : select or s

Selects the student identified by the index number used in the last student listing.
Format: select INDEX
Abbreviation Format: s INDEX

  • Selects the student and loads the student profile of the student at the specified INDEX.

  • Checks that the student selected has the expected number of subjects (minimum 6) and the right subject combination assigned to him/her.

  • The index refers to the index number shown in the most recent listing.

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

Examples:

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

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

3.11. Listing entered commands : history or h

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

ℹ️

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

3.12. Undoing previous command : undo or u

Restores EduBuddy to the state before the previous undoable command was executed.
Format: undo
Abbreviation Format: u

ℹ️

Undoable commands: those commands that modify the EduBuddy’s content (add, delete, edit and clear).

Examples:

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

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

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

3.13. Redoing the previously undone command : redo or r

Reverses the most recent undo command.
Format: redo
Abbreviation Format: r

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)
    r (reapplies the delete 1 command)
    r (reapplies the clear command)

3.14. Clearing all entries : clear or c

Clears all entries from EduBuddy.
Format: clear
Abbreviation Format: c

3.15. Exiting the program : exit

Exits the program.
Format: exit

3.16. Creating an appointment on the calendar : create [coming in v2.0]

Creates an appointment with the student identified by the index number used in the last student listing and displays it on the calendar. E.g. setting a consultation time slot with students.
Format: create INDEX date/DATE time/TIME

  • Date is in DDMMYY format

  • Time is in 24 hour format

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

Examples:

  • create 1 date/01022018 time/1500
    Creates an appointment with the 1st student on 01022018 at 1500

3.17. Remarks Command [coming in v2.0]

{Allows the teachers to write a remark for the student for all other teachers to see. e.g. Medical/Injuries history}

3.18. CCA section [coming in v2.0]

{Allows the teachers to key in which CCA the students are in and to keep track of attendance.}

3.19. L.E.A.P.S System [coming in v2.0]

{Allows the teachers to key in the levels attained by the student for the various domains in L.E.A.P.S to calculate the Co-Curricular Attainment of the student.}

3.20. Saving the data

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

3.21. Encrypting data files [coming in v2.0]

{explain how the user can enable/disable data encryption}

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 EduBuddy folder.

Q: What is L1R5?
A: L1R5 is a grading system used in Singapore to determine the secondary school students' proficiency in the subjects taken for the O’Level Examinations. The score is used for the students to enroll into Junior Colleges, which is the next higher level of education. "L1" refers to the first language subject taken by the student, while "R5" refers to the 5 relevant subjects that are examinable by the students. The grade of L1R5 is then determined by taking the best grades of each category and summing them up, for example, if a student scores A1 for all 6 subjects are from each category, the score will be 6.

Q: How are the grades for the subjects determined?
A: The level of achievement in each subject is indicated by the grade obtained, with A1 being the highest achievable grade and F9 the lowest:

Grade Percentage of Competency

A1

75% - 100%

A2

70% - 74%

B3

65% - 69%

B4

60% - 64%

C5

55% - 59%

C6

50% - 54%

D7

45% - 49%

E8

40% - 44%

F9

0% - 39%

Q: What are the subjects are in the L1R5 category?
A: These are the following subjects that are examinable in O level Examinations in Singapore (as of Year 2018).

ℹ️
 The subjects in the brackets are not to be used as input. The subjects not in brackets are preferred for better efficiency in typing.
Subject Category Subjects

L1

English, HTamil(Higher Tamil), HChi(Higher Chinese), HMalay(Higher Malay)

R1

Hist(History), Geog(Geography), ComHum(Combined Humanities), ELit(English Literature), CLit(Chinese Literature), MLit(Malay Literature), TLit(Tamil Literature), HArt(Higher Art), HMusic(Higher Music), BIndo(Bahasa Indonesia), CSP(Chinese Special Programme), MSP(Malay Special Programme)

R2

EMath(Elementary Mathematics), AMath(Additional Mathematics), Phy(Physics), Chem(Chemistry), Bio(Biology), Sci(Combined Science)

R3

Consist of both R1 and R2 subjects

R4

Consist of L1, R1 and R2 subjects. French, German, Spanish, Hindi, Urdu, Gujarati, Panjabi, Bengali, Burmese, Thai, Jap, Tamil, Chinese, Malay, DnT, Comp(Computing), FnN(Food and Nutrition), PoA(Principles of Accounting), Econs(Economics), Drama, PE(Physical Education), Biz(Business Studies), Biotech(Biotechnology), Design(Design Studies)

R5

Consist of R4 subjects

5. Command Summary

  • Add add n/NAME p/PHONE_NUMBER ic/NRIC t/CLASS t/CLASS_REGISTER sub/SUBJECT_NAME SUBJECT_GRADE
    e.g. add n/James Ho p/22224444 ic/S9500186H t/1A t/20 sub/English A2
    e.g. a n/James Ho p/22224444 ic/S9500186H t/1A t/20 sub/English A2

  • Clear : clear or c

  • Delete : delete INDEX or d INDEX
    e.g. delete 3
    e.g. d 3

  • TagDelete : tagdelete TAGNAME or td TAGNAME
    e.g. tagdelete CLASS2A
    e.g. td CLASS2A

  • TagReplace : tagreplace t/TAGNAME t/TAGNAME or tr t/TAGNAME t/TAGNAME
    e.g. tagreplace t/CLASS2A t/CLASS3A
    e.g. tr t/CLASS2A t/CLASS3A

  • Edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE]
    e INDEX [n/NAME] [p/PHONE_NUMBER] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE]
    e.g. edit 2 n/James Lee
    e.g. e 2 n/James Lee

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

  • Sort : sort PARAMETER
    e.g. sort name
    e.g. sort tag

  • List : list or l

  • Help : help

  • Select : select INDEX or s INDEX+ e.g.select 2 e.g.s 2

  • History : history or h

  • Undo : undo or u

  • Redo : redo or r