Track OER - outputs register

Cloud created by:

Nick Freear
23 August 2012

We're developing re-usable software components at quite a rate. So I thought it best to note some meta-data as we go along. There will be technical detail, but I'll try to keep things readable for non-techies too!

Useful tools

Note, these browser plugins are not just for developers!

AlternateImage – Piwik plugin

trackoer-page-url Javascript

trackoer-ga Javascript

capret-piwik Javascript

  • Purpose: A slot-in replacement for "classic" capret.js, this Javascript inserts a Piwik web-beacon ("web bug") image in place of the CaPReT-hosted GIF image. Bridges the CaPReT cut and paste tracking into Piwik.
  • Code link: Github: IET-OU/ trackoer-core/ …/assets/capret/js/capret-piwik.js
  • Example: http://track.olnet.org/test/capret/math/course-piwik (View source and/or use Firebug, Chrome console..)
  • Language: Javascript (jQuery plugin)
  • License: MIT probably (CaPReT-compatible)
  • Date coded: 21 August 2012.
  • Todos: Deploy my fix for Internet Explorer.
  • Maturity: Alpha.
  • Comments: Currently in testing with the OU's LTS technical testing team! (Works with jquery.plugin.clipboard.js, oer_license_parse.js and optionally json2.js.)

UML diagrams – documentation

Track OER controller classes yUML

Piwik_Tracker::track

ContentReuse – Piwik plugin

  • Purpose: A Piwik plugin to ensure that the HTTP referer header is read/used/logged (in the "url" parameter), even if the "urlref" Piwik parameter is present.
  • Code link: Github: IET-OU/ piwik-contentreuse-plugin
  • Example: '..
  • Language: PHP, Piwik plugin.
  • License: GPL v2 or later (Piwik compatible)
  • Date coded: 24 August 2012.
  • Todos:
  • Maturity: beta.
  • Comments: To be used with "capret-piwik.js" Javascript.

CLI/ command line batch processor

  • Purpose: An initial solution to inject a license-tracking snippet in the HTML pages in OpenLearn-LabSpace/ B2S download packages (Zip, SCORM etc.).
  • Code link: Github: IET-OU/ trackoer-core/ …controllers/ Cli::batch
  • Example: Github: …/config/ batch_config.sample $ php index.php cli/batch --url=http://labspace.open.ac.uk/..
  • Language: PHP
  • License: free/open source license (TBD)
  • Date coded: 21-28 August 2012.
  • Todos: Initial testing this week (29 August).
  • Maturity: beta.
  • Comments: Currently inserts Google Analytics Javascript tracking. We are looking at XSLT solutions for production use on OpenLearn/LabSpace content.

CaPReT – pull request #10

  • Purpose: Merging some fixes and additions from IET-OU into the main CaPReT development.
  • Code link: Github: tatemae/capret/pull/10 – 6 commits
  • Example: N/A
  • Language: Javascript
  • License: MIT (CaPReT compatible)
  • Date coded: 30 August 2012.
  • Todos:
  • Maturity:
  • Comments:

Code samples – Gists

Extra content

trackoer-page-url Javascript

Nick Freear
13:02 on 23 August 2012 (Edited 13:28 on 23 August 2012)

trackoer-ga Javascript

Nick Freear
13:12 on 23 August 2012 (Edited 13:18 on 23 August 2012)

capret-piwik Javascript

  • Purpose: A slot-in replacement for "classic" capret.js, this Javascript inserts a Piwik web-beacon ("web bug") image in place of the CaPReT-hosted GIF image. Bridges the CaPReT cut and paste tracking into Piwik.
  • Code linkGithub: IET-OU/ trackoer-core/tree.../assets/capret/js/capret-piwik.js
  • Examplehttp://track.olnet.org/test/capret/math/course-piwik (View source and/or use Firebug, Chrome console..)
  • Language: Javascript (jQuery plugin)
  • License: MIT probably (CaPReT-compatible)
  • Date coded: 21 August 2012.
  • Todos: Deploy my fix for Internet Explorer.
  • Maturity: Alpha.
  • Comments: Currently in testing with the OU's LTS technical testing team! (Works with jquery.plugin.clipboard.js, oer_license_parse.js and optionally json2.js.)

Nick Freear
13:26 on 23 August 2012

UML diagrams - documentation

Nick Freear
13:41 on 23 August 2012 (Edited 11:40 on 29 August 2012)

Piwik_Tracker::track

Nick Freear
14:04 on 23 August 2012 (Edited 14:05 on 23 August 2012)

ContentReuse - Piwik plugin

  • Purpose: A Piwik plugin to ensure that the HTTP referer header is read/used/logged (in the "url" parameter), even if the "urlref" Piwik parameter is present.
  • Code linkGithub: IET-OU/ piwik-contentreuse-plugin
  • Example: '..
  • Language: PHP, Piwik plugin.
  • License: GNU General Public License v2 or later (Piwik compatible)
  • Date coded: 24 August 2012.
  • Todos:
  • Maturity: beta.
  • Comments: To be used with "capret-piwik.js" Javascript.

Nick Freear
10:24 on 29 August 2012 (Edited 10:28 on 29 August 2012)

CLI/ command line batch processor

  • Purpose: An initial solution to inject a license-tracking snippet in the HTML pages in OpenLearn-LabSpace/ B2S download packages (Zip, SCORM etc.).
  • Code linkGithub: IET-OU/ trackoer-core/tree/...controllers/ Cli::batch
  • Example: Github: .../config/ batch_config.sample $ php index.php cli/batch --url=http://labspace.open.ac.uk/..
  • Language: PHP
  • License: free/open source license (TBD)
  • Date coded: 21-28 August 2012.
  • Todos: Initial testing this week (29 August).
  • Maturity: beta.
  • Comments: Currently inserts Google Analytics Javascript tracking. We are looking at XSLT solutions for production use on OpenLearn/LabSpace content.

Nick Freear
10:34 on 29 August 2012 (Edited 10:40 on 29 August 2012)

CaPReT - pull request #10

  • Purpose: Merging some fixes and additions from IET-OU into the main CaPReT development.
  • Code linkGithub: tatemae/capret/pull/10 - 6 commits
  • Example: N/A
  • Language: Javascript
  • License: MIT (CaPReT compatible)
  • Date coded: 30 August 2012.
  • Todos:
  • Maturity:
  • Comments:

Nick Freear
05:18 on 7 September 2012

Embedded Content

Example of CaPReT-Piwik Javscript plugin use, with Piwik configuration [Gist]

Example of CaPReT-Piwik Javscript plugin use, with Piwik configuration [Gist]

added by Nick Freear