forked from tunapanda/wp-h5p-xapi
-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
68 lines (50 loc) · 2.82 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
=== wp-h5p-xapi ===
Contributors: Tunapanda
Donate link: http://www.tunapanda.org/contribute
Tags: xapi, h5p, admin, learning, integration, lms, learning management system
Requires at least: 3.8.1
Tested up to: 4.6.1
Stable tag: trunk
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
This plugin stores all xAPI statements generaded by H5P in a remote LRS.
== Description ==
This plugin interfaces between the [H5P](https://wordpress.org/plugins/h5p/) plugin
and an [xAPI](https://en.wikipedia.org/wiki/Experience_API_(Tin_Can_API)) compatible
[learning record store](http://www.adlnet.org/tla/lrs.html) (LRS) such as
[Learning Locker](http://learninglocker.net/). It auto saves
[xAPI statements](https://tincanapi.com/statements-101/) generated by the H5P libraries into the LRS.
You can use this plugin as a component to make your Wordpress installation function as a
[Learning Management System](https://en.wikipedia.org/wiki/Learning_management_system).
After installation you will find a settings page called H5P xAPI in the admin panel.
You need to enter the credentials for the connection to the LRS there, please see screenshots and
further instructions on the settings page.
If you find this plugin useful we would like to know about it!
[Tell us your story!](http://www.tunapanda.org/#contact).
= For developers =
This plugin makes the following hooks available:
* `h5p-xapi-pre-save` <br>
This filter is applied before the statement is saved. Plugins implementing this filter have
a chance to modify or add information to the statement to be saved. It's also possible to
block the statement from being saved by returning NULL.
* `h5p-xapi-post-save` <br>
This action is triggered after a statement has been saved to xAPI. The statement that
was just saved is passed to the action as a parameter in the form of an array.
* `h5p-xapi-auth-settings` <br>
This filter is applied as a means for other plugins to provide settings for connecting
to the xAPI backend. If this filter is implemented, the wp-h5p-xapi plugin will pick up the
connection settings from there and operate in the background, i.e. not show any settings
page. The filter function should return an array contining the
keys `endpoint_url`, `username` and `password`.
== Installation ==
Download the plugin and upload it in the plugins section of your wordpress instance.
= Optionally, you can do the following =
1. Download and extract the plugin,
2. Put the extracted folder in your `/wp-content/plugins/` directory,
3. Navigate to your wordpress instance,
4. Login and active the plugin.
After installation you will find a settings page called H5P xAPI in the admin panel.
You need to enter the credentials for the connection to the LRS there, please see screenshots and
further instructions on the settings page.
== Frequently Asked Questions ==
== Screenshots ==