UserGuide.adoc

EduBuddy - User Guide

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

• 1. Introduction
• 2. Quick Start
• 3. Features
  • 3.1. Viewing help : help
  • 3.2. Adding a student: add or a
  • 3.3. Listing all students : list or l
  • 3.4. Sorting all students : sort [since v1.2]
  • 3.5. Editing a student : edit or e
  • 3.6. Finding students by name: find or f
  • 3.7. Deleting a student : delete or d
  • 3.8. Deleting a tag : tagdelete or td [since v1.1]
  • 3.9. Replacing a tag : tagreplace or tr [since v1.2]
  • 3.10. Adding a remark : addremark [since v1.4]
  • 3.11. Deleting a remark : deleteremark [since v1.4]
  • 3.12. Selecting a person : select or s
  • 3.13. Listing entered commands : history or h
  • 3.14. Undoing previous command : undo or u
  • 3.15. Redoing the previously undone command : redo or r
  • 3.16. Creating an appointment: appointment or appt [since v1.4]
  • 3.17. Viewing streaming score: stream [since v1.5]
  • 3.18. Adding a CCA to a student : addcca [since v1.5]
  • 3.19. Clearing all entries : clear or c
  • 3.20. Exiting the program : exit
  • 3.21. CCA section [coming in v2.0]
  • 3.22. L.E.A.P.S System [coming in v2.0]
  • 3.23. Saving the data
  • 3.24. Encrypting data files [coming in v2.0]
• 4. FAQ
• 5. Command Summary

1. Introduction

EduBuddy is designed for secondary school teachers who prefer to use a desktop app to manage 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.

   Important

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

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

5. A EduBuddy folder will be created in your operating system’s home directory to facilitate debugging for advanced users.

   

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

7. Some example commands you can try:

   • list or l : lists all students

   • add or a n/John Doe p/91234567 ic/S9315585J t/1A t/20 sub/English B3 : adds a student named John Doe to EduBuddy

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

   • exit : exits the app

8. 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 case insensitive, e.g fInD Alex and find Alex works the same.

3.1. Viewing help : help

If you are unsure about the features of the EduBuddy, or require any technical assistance, type help and you will be shown with the help page.
Format: help

return to Table of Contents

3.2. Adding a student: add or a

Adds a student to EduBuddy
Format: add n/NAME ic/NRIC nok/NAME_OF_KIN [t/CLASS] [r/REMARK] [sub/SUBJECT_NAME SUBJECT_GRADE …​]
Abbreviation Format: a n/NAME ic/NRIC nok/NAME_OF_KIN [t/CLASS] [r/REMARK] [sub/SUBJECT_NAME SUBJECT_GRADE …​]

Important

When adding a student, at least a NAME, a NRIC and a NAME_OF_KIN should be provided. A SPACE should be inserted between each SUBJECT_NAME and SUBJECT_GRADE.

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

• For example: English, EMath(Elementary Mathematics), Hist(History), Chinese, Phy(Physics), Music.
  

• For more examples on what subjects and subject grades can be added, please refer to the Section 4, “FAQ” section below.

• If you want to change the details later, you can use the Edit feature at Section 3.5, “Editing a student : edit or e”.

Examples:

• add n/John Doe ic/S9500186H nok/Jonathan t/1A r/English Rep sub/English B3 EMath A2 Chinese A1 Phy A1 AMath A1 Hist A2

• add n/Betsy Crowe ic/S9511111I nok/Betty Crowe

• a n/John Doe ic/S9500186H nok/Jonathan t/1A r/English Rep sub/English B3 EMath A2 Chinese A1 Phy A1 AMath A1 Hist A2

• a n/Betsy Crowe ic/S9511111I nok/Betty

return to Table of Contents

3.3. Listing all students : list or l

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

return to Table of Contents

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

Sorts the list of all 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)

return to Table of Contents

3.5. Editing a student : edit or e

Edits an existing student in EduBuddy.The existing fields will then be updated accordingly.
Format: edit INDEX [n/NAME] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE …​]
Abbreviation Format: e INDEX [n/NAME] [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.

• At least one of the optional fields must be provided.
  

• INDEX must be a positive integer: 1, 2, 3, …​
  

• When editing subjects, the previous subjects will be overwritten by the new subjects.

Examples:

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

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

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

return to Table of Contents

3.6. Finding students by name: find or f

Finds a list of students whose name contains 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. Students matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang.

Important

Only the name is searched and only exact words will be matched e.g. Han will not match Hans.

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

return to Table of Contents

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.

Important

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.

return to Table of Contents

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

When you have added the wrong Class tag, or when the secondary 4 students have moved to the next higher education level, and you want to remove the Class tag from every student who has the Class tag assigned to them.

This command deletes the specified tag from every student in EduBuddy.
Format: tagdelete TAGNAME
Abbreviation Format: td TAGNAME

Important

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

Examples:

• tagdelete 4A or td 4A
  Deletes the '4A' tag from every student in the EduBuddy.

return to Table of Contents

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 must be a valid tag name that is assigned to at least one student in the Edubuddy.

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

Important

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 EduBuddy with 'Class 2A'.

return to Table of Contents

3.10. Adding a remark : addremark [since v1.4]

Adds a remark to a specified student in EduBuddy. Format: addremark INDEX r/REMARK

• Adds a remark to the the student at the specified INDEX.

• The remark refers to anything that the teachers wants to comment

• 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
addremark 2 r/Class Monitor
Adds a remark, Class Monitor, to the 2nd student in EduBuddy.

3.11. Deleting a remark : deleteremark [since v1.4]

Delete a remark to a specified student in EduBuddy. Format: deleteremark INDEX r/REMARK

• Deletes a remark from the the student at the specified INDEX.

• The remark refers to any part of the existing remark that is in the student profile for the student that you want.

• 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
deleteremark 2 r/Class Monitor
Deletes the remark, Class Monitor, from the 2nd student in EduBuddy.

3.12. Selecting a person : select or s

When you want to view a student’s personal details like academic grades, cca grades etc, you can view it by selecting the student.

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.
  

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

Important

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

Examples:

• list
select 4
  Selects the 4th student in EduBuddy.

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

return to Table of Contents

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

return to Table of Contents

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

return to Table of Contents

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

return to Table of Contents

3.16. Creating an appointment: appointment or appt [since v1.4]

Creates an appointment (e.g. setting a consultation time slot with students) with the student identified by the index number used in the last student listing and displays it on the calendar.

Format: appointment INDEX d/DATE s/START_TIME e/END_TIME
Abbreviation Format: appt INDEX d/DATE s/START_TIME e/END_TIME

• DATE should be in DDMMYYYY format e.g. 25th Dec 2018 would be 25122018.
  

• START_TIME and END_TIME should be in 24 hour format e.g. 3:30p.m. would be 1530.
  

• INDEX must be a positive integer: 1, 2, 3, …​

ℹ️	After the appointment is successfully created, right click on the calendar and select Reload page to see your appointment.

Examples:

• appointment 1 d/01022018 s/1500 e/1600
  Creates an appointment with the 1st student on 1st Feb 2018 from 3p.m. to 4p.m.

• appt 3 d/20042018 s/0930 e/1100
  Creates an appointment with the 3rd student on 20th Apr 2018 from 9:30a.m. to 11a.m. return to Table of Contents

3.17. Viewing streaming score: stream [since v1.5]

If you want to know if the student is qualified to enter the next education level, Junior College or Polytechnic, you can view the respective streaming score using this command.

Format: stream INDEX STREAM_TYPE You will be able to see a success message in the CommandBox, For example: Student: John Doe. L1R5 Score: 8.

• Selects the student at the specified INDEX. The index refers to the index number shown in the last student listing.
  

• STREAM_TYPE refers to the different streaming categories.

STREAM_TYPE	Streaming categories
1	L1R5
2	L1B4-A or L1R2B2-A
3	L1B4-B or L1R2B2-B
4	L1B4-C or L1R2B2-C
5	L1B4-D or L1R2B2-D

• INDEX must be a positive integer: 1, 2, …​

• STREAM_TYPE must be a positive integer: 1, 2, 3, 4, 5.

• The Student should have the right subject combination to calculate the respective score.

• If you want to change the subject details, you can use the Edit feature at Section 3.5, “Editing a student : edit or e”.

Examples:

• stream 1 1
  Returns the L1R5 score obtained by the student based on his/her grades.

• stream 1 2
  Returns the L1B4-A score obtained by the student based on his/her grades.

return to Table of Contents

3.18. Adding a CCA to a student : addcca [since v1.5]

Adds a CCA to the student records in EduBuddy.
Format: addcca 1 cca/CCA pos/POSITION
You will be able to see the success message, CCA added: CCA: POSITION
Person: NAME

3.19. Clearing all entries : clear or c

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

return to Table of Contents

3.20. Exiting the program : exit

Exits the program.
Format: exit

return to Table of Contents

3.21. CCA section [coming in v2.0]

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

return to Table of Contents

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

return to Table of Contents

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

return to Table of Contents

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

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

return to Table of Contents

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 L1B4 (as known as L1R2B2)?
A: A grading system for Secondary School students taking "O-Level Examination" at the end of their four years of studies in Secondary School. The score obtained from the grading system will be used to determine the eligibility of the students to enter the next level of education, Polytechnic. L1 represents the First language subject and B4 represents 2 relevant subjects, according to the polytechnic course applied, and 2 other best subjects. The category the relevant subject is under(for example: L1B4-A, L1B4-B, L1B4-C, L1B4D), will determine which subjects are the relevant subjects. The score will be calculated by considering the subjects' grades. Each subject can only be considered once.

If you want to find out more about the subject categories (L1B4-A, L1B4-B, L1B4-C, L1B4D), please visit:

• Singapore Polytechnic: https://www.sp.edu.sg/wps/portal/vp-spws/!ut/p/a0/04_Sj9CPykssy0xPLMnMz0vMAfGjzOJDPUxdjdxMTQws3J1cDDwt_MJMXZxDDE3cDfQLsh0VAYY7oWE!/?PC_Z7_UH5E2F540G6P00IO8K5AU61JM5027774_WCM_CONTEXT=/wps/wcm/connect/lib-spws/site-spwebsite/future+students/admissions/selection+criteria+for+gce+o+level+holders+-aggregate+computation+%28admissions+-+course+intakes+and+cut-off+points%29

• Temasek Polytechnic: http://www.tp.edu.sg/admissions/gce-o-level-aggregate-scores-computation

• Other Polytechnics: https://www.moe.gov.sg/education/post-secondary#polytechnics

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 "O-Level Examination". 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. Each subject can only be considered once. For more information, please visit: https://www.moe.gov.sg/admissions/direct-admissions/dsa-jc/eligibility

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. For example, type in: Hist A1 not History A1

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(Japanese), Tamil, Chinese, Malay, DnT(Design and Technology), 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

• The following subjects can be assigned to students but are not considered as O-Level subjects: ChiB (Chinese B), MalayB (Malay B), TamilB(Tamil B).

Q: What is CCA and CCA score?
A: CCA stands for Co-Curricular Activities. It functions as a non-academic activity where students can have a more enriching experience in school. Find out more at: https://www.moe.gov.sg/education/programmes/co-curricular-activities.

CCA score is used as an indicator of the students' contribution in the non-academic aspect, and can be used to improve the students' streaming score. For more information about CCA score, please visit: https://www.moe.gov.sg/docs/default-source/document/education/programmes/co-curricular-activities/leaps-2.pdf

Q: What is LEAPS?
A: It stands for Leadership, Enrichment, Achievement, Participation, and Service. It is a grading system for the schools to determine the CCA score for each student.
For more information about LEAPS, please visit: https://www.moe.gov.sg/docs/default-source/document/education/programmes/co-curricular-activities/leaps-2.pdf

Q: What comprises the post-secondary education?
A: There are many different platforms of post-secondary education. We are currently focusing on Polytechnics and Junior Colleges. For more information about the platforms, please visit: https://www.moe.gov.sg/education/post-secondary

Q: Why the information in the User Guide is not updated?
A: The EduBuddy is created in the Year 2018, so the information are all based in 2018. And, we are not part of the Ministry of Education so we may be lacking in expertise in this area. If you want to see the latest update on the education system, you can visit: https://www.moe.gov.sg/home.

• If you want us to update the EduBuddy, you can post issues on our website, https://github.com/CS2103JAN2018-T09-B1/main/issues. Please go through the following 2 steps to post an issue:

You should have a GitHub account to post an issue. If you don’t, you can create one at https://github.com/join.

Figure 1. Step 1: Create new issue

Figure 2. Step 2: Submit new issue

• If you want to see that your issue is posted, you can follow the next 2 steps.

Figure 3. Step 3: Return to main issue page

or you can go back to https://github.com/CS2103JAN2018-T09-B1/main/issues.

Figure 4. Step 4: View issue

We will let you know through your GitHub account or the email linked to your GitHub account once we have address your issue.

return to Table of Contents

5. Command Summary

The table below provides a quick summary of all the commands available in EduBuddy.

Command	Function	Format	Example
Add	Adds a student entry	add n/NAME ic/NRIC t/CLASS t/CLASS_REGISTER sub/SUBJECT_NAME SUBJECT_GRADE OR a n/NAME ic/NRIC t/CLASS t/CLASS_REGISTER sub/SUBJECT_NAME SUBJECT_GRADE	add n/James Ho ic/S9500186H t/1A t/20 sub/English A2 EMath A1 Chinese A1 Phy A1 AMath A1 Hist A2 OR a n/James Ho ic/S9500186H t/1A t/20 sub/English A2 EMath A1 Chinese A1 Phy A1 AMath A1 Hist A2
Appointment	Creates an appointment	appointment INDEX d/DATE s/START_TIME e/END_TIME OR appt INDEX d/DATE s/START_TIME e/END_TIME	appointment 1 d/25122018 s/1200 e/1300 OR appt 1 d/25122018 s/1200 e/1300
Clear	Clears all student entries	clear OR c	clear OR c
Delete	Deletes a student entry	delete INDEX OR d INDEX	delete 3 OR d 3
Edit	Edits a student entry	edit INDEX [n/NAME] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE] OR e INDEX [n/NAME] [ic/NRIC] [t/CLASS] [t/CLASS_REGISTER] [sub/SUBJECT_NAME SUBJECT_GRADE]	edit 2 n/James Lee OR e 2 n/James Lee
Exit	Exits EduBuddy	exit	exit
Find	Finds student by name	find KEYWORD [MORE_KEYWORDS] OR f KEYWORD [MORE_KEYWORDS]	find James Jake OR f James Jake
Help	Shows the help page	help	help
History	Lists the past commands entered	history OR h	history OR h
List	Lists all student entries	list OR l	list OR l
Redo	Redo previous undo command	redo OR r	redo OR r
Select	Selects the student entry	select INDEX OR s INDEX	select 2 OR s 2
Sort	Sorts student entries by parameters	sort PARAMETER	sort name OR sort tag
Stream	Returns a specific streaming score of a student	stream INDEX STREAM_TYPE	stream 1 1 OR stream 1 2
TagDelete	Deletes a tag from every student	tagdelete TAGNAME OR td TAGNAME	tagdelete CLASS2A OR td CLASS2A
TagReplace	Replaces a tag for every student	tagreplace t/TAGNAME t/TAGNAME OR tr t/TAGNAME t/TAGNAME
AddRemark	Adds a remark to a specific student	addremark 1 r/REMARK
DeleteRemark	Deletes a remark from a specific student	deleteremark 1 r/REMARK
Undo	Undo previous command	undo OR u	undo OR u

return to Table of Contents