plugin:lms
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:lms [2022-01-27 12:18] – andi | plugin:lms [2024-01-07 13:48] (current) – Aleksandr | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : dokuwiki@cosmocode.de | email : dokuwiki@cosmocode.de | ||
type : action | type : action | ||
- | lastupdate : 2022-01-17 | + | lastupdate : 2023-11-18 |
compatible : Hogfather | compatible : Hogfather | ||
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : | + | tags : |
downloadurl: | downloadurl: | ||
Line 20: | Line 20: | ||
screenshot_img : | screenshot_img : | ||
---- | ---- | ||
- | |||
This plugin implements a " | This plugin implements a " | ||
- | | [[https:// | + | | [[https:// |
===== Installation ===== | ===== Installation ===== | ||
- | [[https:// | ||
+ | [[https:// | ||
Install the plugin using the [[plugin: | Install the plugin using the [[plugin: | ||
Line 37: | Line 36: | ||
The plugin expects a control page with the lesson structure. By default it is named '' | The plugin expects a control page with the lesson structure. By default it is named '' | ||
+ | |||
+ | You can have multiple control pages in different namespaces, similar to how [[config: | ||
The page should contain links to your lesson pages. You can use any other syntax in between to structure the page if needed. | The page should contain links to your lesson pages. You can use any other syntax in between to structure the page if needed. | ||
+ | |||
+ | Only links to pages within (or below) the control page's namespace are considered lessons in that control page's context. | ||
< | < | ||
Line 51: | Line 54: | ||
* [[adv: | * [[adv: | ||
* [[adv: | * [[adv: | ||
- | |||
</ | </ | ||
Line 65: | Line 67: | ||
The widget will only be displayed for logged in users and only when on a lesson page. | The widget will only be displayed for logged in users and only when on a lesson page. | ||
+ | |||
+ | === Lesson Include === | ||
+ | |||
+ | The plugin comes with a simple mechanism to include the control page in another page. This is useful if you want to display the list of lessons in the sidebar for example. | ||
+ | |||
+ | < | ||
+ | ~~LMSINCLUDE~~ | ||
+ | </ | ||
+ | |||
+ | Like the widget above, the control page will only be included for logged in users and when within a lesson context. | ||
=== Template Integration === | === Template Integration === | ||
- | Alternatively to using the Widget, template authors can also integrate the functionality directly in their template. The plugin comes with a helper component exposing methods to access the lesson system. | + | Alternatively to using the Widget, template authors can also integrate the functionality directly in their template. The plugin comes with a [[https:// |
- | The JavaScript included in the template | + | The JavaScript included in the plugin |
=== Admin Interface === | === Admin Interface === | ||
Superusers and managers can access a tool in the admin interface to check the lesson completion status for specific users. Entering a username will list all lessons and the info when the user completed a lesson. | Superusers and managers can access a tool in the admin interface to check the lesson completion status for specific users. Entering a username will list all lessons and the info when the user completed a lesson. | ||
+ | |||
+ | Note that this admin interface is context sensitive. When using multiple namespaced control pages, you need to open the admin interface from a page in the correct namespace. | ||
plugin/lms.1643282299.txt.gz · Last modified: 2022-01-27 12:18 by andi