Home

Welcome to MarkUs

MarkUs (pronounced "mark us") is an open-source tool which recreates the ease and flexibility of grading assignments with pen on paper, within a web application. It also allows students and instructors to form groups, and collaborate on assignments. It's predecessor OLM (Online Marking) was originally written in Python on top of the TurboGears framework.

The MarkUs project is a re-implementation of the Online Marking system using Ruby on Rails. The goal of this project is to take what we learned from OLM and our forays into Web-CAT, and build a web-based marking tool that includes an early submission and testing system in support of test driven development.

Project Resources

• Project Website http://www.markusproject.org
• Developer's Blog http://blog.markusproject.org
• Review Board http://review.markusproject.org
• IRC Channel: Our channel is #markus on irc.freenode.net. Logs of the channel are also available.
• Sandbox http://www.markusproject.org/admin-demo/
• User Guide: MarkUs Documentation
  • Instructor Guide: Instructor Guide
  • Grader Guide: Grader Guide
  • Student Guide: Student Guide
• Git Resources:
  • MarkUs and Git HowTo
  • A Git Tutorial
  • Progit Book
  • Gitref.org
• Issue Labels: Their meaning is described here

Screencasts

• [[Student File Submission: September 2 2009 | http://www.youtube.com/watch?v=ofpyaty20FQ]]
• [[Student Group Formation: August 17, 2009 | http://www.youtube.com/watch?v=Ed_z_tHCAg8]]
• [[The Grader View: June 6, 2009 | http://www.cs.toronto.edu/~reid/screencasts/OLM-2009-06-03.swf]]
• [[Flexible Marking Scheme Selection: December 1, 2009 | http://www.youtube.com/watch?v=x4mbE3WBgog]]
• [[Flexible Marking Scheme Criterion: December 1, 2009 | http://www.youtube.com/watch?v=tVkti9y91RA]]
• [[Notes created through the Modal dialog as an Admin: December 3, 2009 | http://www.youtube.com/watch?v=eoxriy2cYW0]]
• [[Notes created through the Modal dialog as a TA: December 3, 2009 | http://www.youtube.com/watch?v=J4r18LNDwPs]]
• [[Creating and editing a grade entry form as an admin: December 4, 2009 | http://www.youtube.com/watch?v=r7UnaNYe2rw]]
• [[Notes tab: December 11, 2009 | http://www.youtube.com/watch?v=IcuG6AlJfvQ]]
• [[Entering and releasing the marks for a grade entry form as an admin: April 4, 2010 | http://www.youtube.com/watch?v=-v6eVy94pdI]]

MarkUs Developer Installation Guides

Linux

• Setting up a development environment on GNU/Linux (i.e. Debian based systems) including Ruby on Rails, MarkUs and Radrails IDE (Eclipse plug-in)

Mac OS X

• [[Setting up a development environment on Mac OS X 10.6 (Snow Leopard) | InstallationMacOsX]]

Windows

(Note: Linux and Mac OS X development environments generally caused less problems)

• [[Setting up a development environment on Windows using InstantRails | InstallationWindows]]

MarkUs Developer Documentation

Project Vitals

Repository: Create a Github account and fork MarkUsProject/MarkUs (see Github help for more info).

Mailing list address: [email protected]

Mailing list archive at marc.info

Project Contributors

Geoffrey Flores, Mike Conley, Andrew Louis, Justin Foong, Veronica Wong, Amanda Manarin, Severin Gehwolf, Catherine Fawcett Nelle Varoquaux, Neha Kumar, Gabriel Roy-Lortie, Simon Lavigne-Giroux, Mélanie Gaudet, Fernando Garces, Tara Clark, Farah Juma, Benjamin Vialle, Christian Jacques, Victoria Mui, Joseph Maté, Robert Burke, Bryan Shen, Brian Xu, Anton Braverman, Diane Tam, Evan Browning, Dina Sabie, Misa Sakamoto, Vivien Suen, Horatiu Halmaghi, Kurtis Schmidt, Jiahui Xu, Victor Ivri, Benjamin Vialle, Clément Delafargue

Industry Advisors: Mike Gunderloy, Adam Goucher

Supervisor: Karen Reid

Term Work

• Fall 2010
  • [[Who is doing what? (punchlines/minutes) | http://blog.markusproject.org/?p=1713]]
• Winter 2010
  • [[Who is doing what? (punchlines/minutes) | http://blog.markusproject.org/?p=1049]]
• Fall 2009
  • [[Who is in charge of what, administratively? | http://blog.markusproject.org/?p=504]]
  • [[September 18 - Pre-meeting Status | http://blog.markusproject.org/?p=296]]

Everything a Developer Needs to Know about Ruby, Ruby on Rails and MarkUs

• Getting Started with Ruby, Ruby on Rails and MarkUs

  • Short Rails Debugging HOWTO
  • How to program in Ruby, Rubybook
  • Rails API
  • Rails Guides
  • Using metric_fu
  • [[General Guide Lines to code - Code review from Mike Gunderloy | GeneralGuideLines]]
  • http://apidock.com/rails
  • [[Some notes from a Ruby book taken by Tara Clark | http://taraclark.wordpress.com/category/ruby-on-rails]]
  • How to run Selenium tests
  • Acceptance/Cucumber tests
  • How to use the MarkUs API
  • How to use MarkUs Testing Framework (still in alpha)

• MarkUs Coding Style/Coding Practices/Rails Gotchas

  • Basic Guidelines for MarkUs Development (IMPORTANT!)
  • How to use Review Board
  • Rails erb quirks
  • [[Use h (alias for html_escape) and sanitize in views | RailsViewsConventions]]
  • Please document your code according to the RDoc specification (see how to use RDOC)
  • Ruby compatibility: Please check ticket: #206. Also check out the [[difference between COUNT, LENGTH, and SIZE | http://blog.hasmanythrough.com/2008/2/27/count-length-size]
  • Our Ruby/Rails testing guidelinesi
  • Security testing guidelines
  • Internationalisation

• MarkUs API/Test Coverage

  • MarkUs Ruby Doc
  • MarkUs Test Coverage

• MarkUs Releases

  • Preparing a Release and Patch

• User Roles and Stories for MarkUs

  • General / Constraints
    • MarkUs is internationalized
    • MarkUs is configurable
    • [[Rubrics are not allowed to change once Submissions have been collected|GeneralUseCase_NoRubricChangesAfterCollection]]
    • Instructor
      • Instructors can create / edit assignments
      • Instructors can download/export files
      • Instructors can hide students
      • Instructors can do everything that Graders can do
      • Instructors can release/unrelease completed marking results
      • Instructors can map particular students/groups to Grader_(s) for marking
      • Instructors can download / export a file that describes the Student /Grouping mapping to Graders
      • Instructors can upload a file that will do the Student /Grouping mapping to Graders
      • Instructors can manage groups without restrictions
    • Grader
      • Graders can easily tell which submissions are assigned to them to mark
      • Graders can view a Submission from a Student / Grouping
      • Graders can view/annotate/mark a particular file from a Submission
      • Graders can add annotations to particular lines of code within a Submission File
      • Graders can create reusable Annotations
      • Graders can create short, formatted overall comments on a Submission
      • Graders can view and use a Rubric for marking a Submission for an Assignment
      • Graders can view a summary of marked submissions
      • Graders can add bonuses / penalties to submissions
      • Graders can modify the marking state of a submission result
      • Graders can easily switch to the next / previous Submission for marking
    • Student
      • Students can view marks of submissions
      • Students can view annotations of marked submissions/assignments
      • Students can submit files for their assignments
      • Students can view/edit submission files for assignments

• Database Schema

  • AutoGenerate Database Schema
  • [[Questions and Answers (Old Document) | Schema_Questions])

• MarkUs Component Descriptions

  • Group / Grouping Behaviours
  • Groupings and Repositories
  • Authentication and Authorization
  • Annotations
  • How Student Work is Graded
  • Submission Rules
  • The FilterTable Class
  • Simple Grade Entry
  • Notes System

• Feedback Notes

  • 2009-05-22: Phyliss
  • 2009-06-22: Ryan

• Tips and Trick

  • Dropping/Rebuilding Database Quickly and Easily

• IDE/Editor Notes

  • jEdit
  • NetBeans

MarkUs Deployment Documents (Installation Instructions for MarkUs using RAILS_ENV=production)

• Setup Instructions for MarkUs Stable
• Hosting several MarkUs applications on one machine (for Production)
• How to use LDAP with MarkUs
• How to use Phusion Passenger instead of Mongrel

For a complete list of local wiki pages, see TitleIndex.