H5P Platform Integration Plugin for Neos CMS
This package is auto-updated.
Last update: 2021-09-01 05:29:25 UTC
H5P is an open standard for rich content in browsers, mainly - but certainly not limited to - for learning use cases and environments. It provides a variety of reusable content types, such as Memory Games, Fill in the Blanks, Multiple Choice Questions and many more. Too get an overview about H5P and its content types, visit https://h5p.org/content-types-and-applications.
This plugin provides a platform integration for H5P into the Neos Content Application Platform, allowing you to use H5P content types seamlessly within Neos.
Sandstorm.NeosH5P is currently being maintained for the following versions:
Installation is simple and consists of these steps:
composer require sandstorm/neosh5p
- Install the database model via
- Create a default set of configuration via
- Make sure the H5P core assets (JS and CSS files) are published by running
That's it - you're good to use H5P content on your site. You new have a new plugin node type "H5P Content" that you can use to integrate with H5P. You also have a set of backend modules to create and manage H5P content, libraries, results and settings.
Make sure to read and follow the integration guide below to really make the best use of the H5P package.
Refer to this video explaining how to use the H5P plugin: https://www.youtube.com/watch?v=eslFaQ3oj7E
Configuration/Settings.yaml file and adjust the config settings to your needs. You should not need to change
anything under the
h5pPublicFolder key, as this controls the publishing mechanism of the H5P plugin - this should work
out of the box. You can adjust anything under
xAPI the way you want it. The individual config
settings are described in the
Important: After you changed anything under the
configSettings key, you need to re-run the
command to bring it into the database and make it accessible to H5P. This is by design, as H5P is designed for these config
settings to be changed by an admin (which we haven't implemented yet, and likely never will).
H5P supports persisting content state (e.g. the currently selected answers to multiple choice questions) and content results (e.g. answers given by a user to a multiple choice question). In order for this to work in Neos, we need to add a few settings.
In your site package's
Policy.yaml, provide the permission to use the controller actions to the role which you
want to be able to use them. If you're using a frontend login package like Sandstorm.UserManagement,
your config could look like below. Replace the role
Sandstorm.UserManagement:User with the one your frontend users
actually have. If you want to save content results and user data even for non-logged-in users, set this to
Neos.Flow:Everybody. Mind the GDPR implications of this, as you're then persisting data of every user that
interacts with H5P content on your site.
roles: Sandstorm.UserManagement:User: privileges: - privilegeTarget: 'Sandstorm.NeosH5P:FrontendControllerActions' permission: GRANT
You can control which username and email address is sent in xAPI statements by implementing your own implementation of
FrontendUserServiceInterface. Check the default
Sandstorm\NeosH5P\Domain\Service\FrontendUserService for an
example. You need to configure Neos to use your implementation in your site package's
Objects.yaml. This will give
you the opportunity to interact with your own frontend user model and extract name and email address.
process. This way, you have control over the sending process and can handle any login/routing/statement manipulation
requirements in your own package. The script is injected automatically - all you need to do is provide a path to a
script file under the configuration setting
Sandstorm.NeosH5P.xAPI.integrationScript. Refer to this package's
Settings.yaml for a detailed explanation (see the comments at the "xAPI" section of the config).
Plan a cronjob to remove all EditorTempfiles and associated resources. EditorTempfiles are created e.g. when a user
starts creating an H5P content element and has already uploaded assets (such as pictures), then cancels the process.
We provide a CLI command for this:
./flow h5p:cleareditortempfiles. Depending on how many users you have that are
creating H5P content, this should be run about once a week.
- Internationalization is not implemented yet.
- Form validation in the H5P editor is not taken into account.
- Flash messages do not work in the fullscreen content editor.
- Methods for usage statistics are not implemented yet.
- Config settings can not be changed in the GUI, only via CLI command (which is probably fine).
Thanks to our valued customer Deutsches Institut für Erwachsenenbildung Bonn for sponsorship of this package!