Minor: Plugin: xAPI: Update documentation

pull/3687/head
Yannick Warnier 5 years ago
parent 6fed8e3d8b
commit e7ffdf88f7
  1. 14
      plugin/xapi/README.md
  2. 2
      plugin/xapi/lang/english.php

@ -1,23 +1,23 @@
# Experience API (xAPI)
Allow to incorporate an external Learning Record Store and use activities with the xAPI.
Allows you to connect to an external Learning Record Store and use activities with the xAPI standard.
> You can import and use TinCan packages.
> Import Cmi5 packages is beta state and development.
> Import CMI5 packages is to be considered a Beta state and still in development.
**Configuration**
Set LRS endpoint, username and password to itegrate an external LRS in Chamilo LMS.
Set LRS endpoint, username and password to integrate an external LRS in Chamilo LMS.
The fields "Learning path item viewed", "Learning path ended", "Quiz question answered" and "Quiz ended" allow enabling
hooks when the user views an item in learning path, completes a learning path, answers a quiz question and ends the exam.
The statements generated with these hooks are logged in Chamilo database, waiting to be sent to the LRS by a cron job.
The cron job to configure in your server is located in `/CHAMILO_PATH/plugin/xapi/cron/send_statements.php`.
The cron job to configure on your server is located in `CHAMILO_PATH/plugin/xapi/cron/send_statements.php`.
**Use the Statement API from Chamilo LMS**
You can use the xAPI statement API to save some statements from another service.
You need create credentials (username/password) to do this. First you need set the "menu_administrator" plugin region
to xAPI plugin. Then you can create the credentials with the new page "Experience API (xAPI)"
You can use xAPI's "Statement API" to save some statements from another service.
You need to create credentials (username/password) to do this. First you need to enable the "menu_administrator" region
in the plugin configuration. You will then be able to create the credentials with the new page "Experience API (xAPI)"
inside de Plugins block in the Administration panel.

@ -3,7 +3,7 @@
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Experience API (xAPI)';
$strings['plugin_comment'] = 'Allow to incorporate an external Learning Record Store and use activities with the xAPI specification.';
$strings['plugin_comment'] = 'Allows you to connect to an external Learning Record Store and use activities compatible with the xAPI standard.';
$strings[XApiPlugin::SETTING_UUID_NAMESPACE] = 'UUID Namespace';
$strings[XApiPlugin::SETTING_UUID_NAMESPACE.'_help'] = 'Namespace for universally unique identifiers used as statement IDs.'

Loading…
Cancel
Save