Skip to content

Commit 175a7b9

Browse files
committed
v1.63 release
1 parent 70e7f1a commit 175a7b9

File tree

2 files changed

+23
-82
lines changed

2 files changed

+23
-82
lines changed

README.md

Lines changed: 21 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
1-
tincanlaunch
1+
xAPI Launch Link
22
============
33

44
A Moodle plug-in that allows the launch of xAPI content using a separate LRS.
55

66
## Background
7-
The [xAPI Specification](https://github.com/adlnet/xAPI-Spec) was released in 2013 and allows for tracking
8-
of learning experiences. xAPI was designed on the premise of a distributed system communicating via
9-
API calls over the internet. This means that whilst it is possible to include a Learner Record Store (LRS) and
10-
reporting tools inside an LMS like Moodle, it is equally possible for the LRS and reporting tools to exist as
11-
seprate entities outside of the LMS.
12-
13-
This projects will assume that a separate LRS and reporting tool are used. This will allow us to take
14-
advantage of an open-source LRS and reporting tool projects outside of the Moodle community.
7+
The plugin is called tincanlaunch because of the original research project called 'Project Tin Can'. At this point in time, the more commonly heard names of Tincan are the 'Experience API' and 'xAPI'. More details can be found here: https://xapi.com/tin-can-experience-api-xapi
158

169
One of the key issues in xAPI is launching content in such a way that the activity provider knows:
1710
* the LRS endpoint
18-
* authorisation credentials
11+
* authorization credentials
1912
* user information
2013

2114

@@ -26,51 +19,34 @@ A second method will be considered as development continues, [cmi5](http://aicc.
2619

2720

2821
## What you will need
29-
To use this plugin you will need the following:
30-
* A working instance of a [supported Moodle version](https://docs.moodle.org/dev/Releases) 3.5, 3.7, or 3.8+
31-
* A [supported PHP version](https://www.php.net/supported-versions.php) (as of this writing the supported versions of PHP are 7.2-7.4)
22+
To use this plugin, you will need the following:
23+
* A working instance of a [supported Moodle version](https://docs.moodle.org/dev/Releases) 3.9+
24+
* A [supported PHP version](https://www.php.net/supported-versions.php) (as of this writing, the supported versions of PHP are 7.4, 8.0, and 8.1)
3225
* Moodle administrative access
33-
* Web accessible xAPI-compliant content that implements the launch mechanism outlined above (Articulate Storyline/ Adobe Captivate)
26+
* Web-accessible xAPI-compliant content that implements the launch mechanism outlined above (Articulate Storyline, Adobe Captivate, etc.)
3427
* An xAPI-compliant LRS (LearningLocker, Watershed, SCORM Cloud)
3528

36-
3729
## Installation (Recommended)
3830
It is recommended to get this plugin from the Moodle Plugins Database (https://moodle.org/plugins/mod_tincanlaunch)
3931

40-
This plugin is installed in the same way as any activity plugin. Download the zip file and navigate to Moodle
41-
System administration > Plugins > Install plugins.
42-
43-
## Installation from Github (Developer)
44-
45-
This is recommended only for developers or if you need the very latest versions.
46-
47-
The plugin has one submodule dependencies and will NOT work directly from a clone. Go into the plugin folder
48-
and type the following command:
49-
50-
```git submodule update --init --recursive```
51-
52-
The plugin is now ready for use.
32+
This plugin is installed in the same way as any activity plugin. Download the zip file and navigate to Moodle System administration > Plugins > Install plugins.
5333

5434
### Course set up
55-
This plugin can be added to a course like any other course activity. Simply add an activity and select Tin Can
56-
Launch from the list.
35+
This plugin can be added to a course like any other course activity. Simply add an activity and select xAPI Launch Link from the list.
5736

58-
The settings for this module all have help text which can be accessed by clicking the ? icon next to that setting.
37+
There are appearance settings that allow various launch settings.
38+
* Simplified Launch - When learners click the activity from within the Moodle course, they will automatically be brought to the xAPI content. This bypasses the registration screen. Most browsers will block this launch, and the learner must allow popups from the site.
39+
* Single Registrations - When learners click the activity, they will be brought to a registration screen. If they have no prior registrations, they can create a new one. Subsequent visits to the activity will allow the user to launch the existing activity.
40+
* Multiple Registrations - This differs from 'Single Registrations' in that the user will be able to see and launch all of their prior registrations as well as launch a new registration.
41+
42+
The settings for this module all have help text which can be accessed by clicking the '?' icon next to that setting.
5943

6044
## Using the plugin
61-
When the learner clicks the launch link, they are taken to a page listing all of their prior attempts for that
62-
activity. The most recent attempt is at the top and a new attempt button above that. Learners can choose to
63-
launch a new attempt, or return to a previously saved attempt. This can also be disabled to only show the most
64-
recent attempt.
45+
Depending on the settings chosen during the activity setup, the learner will either directly launch the content (Simplified Launch) or be brought to a Registrations page (Single/Multiple Registrations).
6546

66-
Moodle will pass the e-learning a registration id in the form of a universal unique id representing the previous
67-
attempt or a newly generated one for a new attempt. It's up to the e-learning what it does with that data, but
68-
hopefully it will store its bookmarking state on a per registration basis.
47+
Moodle will pass the xAPI content a registration ID as a universal unique ID (UUID) representing the previous attempt or a newly generated one for a new attempt. It's up to the xAPI content what it does with that data, but ideally, it will store its bookmarking state on a per-registration basis.
6948

70-
Note that the list of attempts is stored in the LRS, rather than Moodle and can therefore be read and modified
71-
by another LMS or by the learning activity itself. Additionally, if another copy of the launch link is installed
72-
elsewhere on the Moodle or even on another Moodle, the data will be shared so long as the user email and activity
73-
id are the same.
49+
Note that the list of attempts is stored in the LRS, rather than Moodle, and can therefore be read and modified by another LMS or by the learning activity itself. Additionally, if another copy of the launch link is installed elsewhere on Moodle or even on another Moodle, the data will be shared so long as the user email and activity ID are the same.
7450

7551
## FAQ
7652

@@ -79,46 +55,11 @@ Tracking data from the learning activity is stored in your LRS and can be retrie
7955

8056

8157
### Why doesn't the plugin do x, y, or z?
82-
If you'd like the plugin to do something, please raise an issue and perhaps somebody will do it for you for free.
83-
If you want to make sure it happens, or get it done quickly, I recommended you hire a developer or add the feature
84-
yourself. Email [david.pesce@exputo.com](mailto:david.pesce@exputo.com) if you'd like to hire us.
85-
86-
87-
## Other projects for reference
88-
### Tin Launcher
89-
Tin Launcher is an open source JavaScript tool for launching Tin Can activities using the Rustici launch method. We can
90-
use this as a reference when building the launch URL. This was written by me and we can re-use the code for this
91-
project if any of it fits.
92-
93-
[Demo](http://garemoko.github.io/Tin-launcher/)
94-
95-
[Github](https://github.com/garemoko/Tin-launcher)
96-
97-
### SCORM Cloud Moodle Module
98-
The SCORM Cloud Moodle module is designed to integrate SCORM Cloud into Moodle so that SCORM Cloud is used in
99-
place of Moodle's SCORM player. This also allows the upload of Tin Can packages. In it's current form this module only
100-
works with SCORM Cloud LRS.
101-
102-
This module is licensed under a GNU 3 license so in theory we could take and re-purpose it to talk to any LRS.
103-
There's a lot of SCORM related code that we don't need though and it deals with content uploaded to Moodle rather than
104-
externally hosted content, so I think it makes more sense to start afresh and use this as a reference.
105-
106-
[Github](https://github.com/RusticiSoftware/SCORMCloud_MoodleModule)
107-
108-
### Jamie Smith's work
109-
Jamie Smith has created a couple of Github projects that work together to allow for Tin Can packages to be
110-
tracked in Moodle as though they are SCORM packages. The aims of his work are different to this project (he's dealing
111-
with content uplaoded to Moodle), but we'll need to consider if and how we build on or integrate with his work.
112-
Perhaps, for example, this project could be used in conjunction with Jamie's work to allow extenrally hosted Tin Can
113-
activties to be tracked back inside Moodle instead of an external LRS.
114-
115-
[Github](https://github.com/jgsmitty)
58+
If you'd like the plugin to do something, please raise an issue; perhaps someone within the community will develop it for you. If you want to make sure it happens or is done quickly, please email [david.pesce@exputo.com](mailto:david.pesce@exputo.com) if you'd like to hire us.
11659

117-
## Useful Links
118-
[The Moodle tracker item relating to xAPI (TinCan)](https://tracker.moodle.org/browse/MDL-35433)
11960

12061
## Reporting issues
12162
Please report any issues with this plugin here: https://github.com/davidpesce/moodle-mod_tincanlaunch/issues
122-
Please provide screenshots of your settings (both at plugin and instance level) and a link to your content.
63+
Please provide screenshots of your settings (both at the plugin and instance level) and a link to your content.
12364

124-
The majority of issues are caused by incorrect settings. You can see previous closed issues here: https://github.com/garemoko/moodle-mod_tincanlaunch/issues?q=is%3Aissue+is%3Aclosed
65+
The majority of issues are caused by incorrect settings. You can see previously closed issues here: https://github.com/davidpesce/moodle-mod_tincanlaunch/issues?q=is%3Aissue+is%3Aclosed

version.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828

2929
defined('MOODLE_INTERNAL') || die();
3030

31-
$plugin->version = 2023041200; // The current module version (Date: YYYYMMDDXX).
31+
$plugin->version = 2023041300; // The current module version (Date: YYYYMMDDXX).
3232
$plugin->requires = 2021051700; // Requires Moodle 3.11 version.
3333
$plugin->supported = [311, 401];
3434
$plugin->cron = 0; // Period for cron to check this module (secs).
3535
$plugin->component = 'mod_tincanlaunch'; // To check on upgrade, that module sits in correct place.
3636
$plugin->maturity = MATURITY_STABLE;
37-
$plugin->release = '1.62';
37+
$plugin->release = 'v1.63';

0 commit comments

Comments
 (0)