[[PageOutline(2-7, Table of Contents, floated)]]

== iPeer User Documentation ==
(Created August 2010)[[br]]

iPeer is an application to develop and deliver rubric-based peer evaluations, to review and release student comments, to build progress report forms online, and to analyze evaluation results. It has extensive features including user management system, student feedback control, data import/export, automatic installer, self-evaluation and etc… 
(from: http://ipeer.apsc.ubc.ca/home/?page=about)

==== Technical Information ====
iPeer is a Web Application. This means that it runs on a server, and can be accessed with any web browser.[[br]]
iPeer is written in a web programming language PHP (http://www.php.net) and uses a framework called CakePHP. (http://www.cakephp.org) to structure its code.
For more technical details, please see trac website at http://burrito.olt.ubc.ca/trac/


=== Students ===
The students interface is focused on completing evaluations. After students have been created, and assigned to courses, they can log into the system, and complete evaluation events.

==== Login for Students ====
Students can log in via 2 mechanisms:
 * via username and password, like every other user on the system.
 * via the CWL plug-in (for University of British Columbia (UBC)). 
  * Note that if this plug-in is enabled, the students can not login via iPeer's username and password, and must use their CWL login.

===== iPeer Login for Students =====
The students login with their username and password.
 * Username: enter your student number
 * Password: enter the password given to you by your instructor or TA. You can update it later.
Click the login button to complete the login process.

===== CWL Login for USB Students =====
Click on the CWL logo at the login screen, and you will be taken to the UBC CWL login page. Login just like for other UBC pages, and after the logon is complete, you'll be taken iPeer Home.
* Please note that if you use your CWL login, changing your password in iPeer will have no effect on your CWL password.

===== Updating Email on First Logon =====
If this your first time logging into iPeer, you may be asked to update your email. Please enter you email to the right '''Email:''' label, and click the '''Save''' button on the bottom of the screen. The top of your page should now read:[[br]]
Your Profile Has Been Updated Successfully.[[br]]
'''Go to your iPeer Home page.'''[[br]]
Click on the orange "Go to your iPeer Hope page" link to finish.

==== Home Page ====
When a students logs in, they are presented with the home page. Student's view of iPeer is focused on submitting evaluations assigned by their instructors.[[br]]
This page contains 2 sections, both listing evaluation events:

===== Peer Evaluations Due =====

These are the evaluation that should be completed. For example:
||'''Event'''||'''Course'''||'''Due Date'''||'''Due In / Late By (red)'''||
||Evaluation 1||COMP 101 101||Sun, Sep 5, 2010 11:55 am||30 day(s)||

To complete an evaluation, just clink on its title. So, to complete the above event, you would click on "Evaluation 2".

===== Peer Evaluations Submitted =====

These evaluations were already completed by you. Example:

||'''Event'''||'''Course'''||'''Due Date'''||'''Date Submitted'''||
||Evaluation 1||home COMP 101 101||Sun, Sep 5, 2010 11:55 am||Fri, Sep 3, 2010 9:25 am||


If you want to see your answers for this evaluation, click on it's title. A new window or tab will pop up, with the evaluation answers, and results, if these were released.

==== Filling out Evaluations ====

There are 4 types of evaluations in iPeer: Simple Evaluations, Rubrics, and Mixed evaluations.
After clicking on an evaluation name, the selected evaluation will open:

===== Simple Evaluations ===== 
[[Image(documentation-simpleEvalExample1.png, 320px, align=right, border=10)]]  

===== Rubric Evaluations =====
[[Image(documentation-rubricEvalExample1.png, 320px, right)]]  

===== Mixed Evaluations =====
[[Image(documentation-mixedEvalExample1.png, 320px, right)]]  


=== Instructors ===


=== Administrators ===