Differences

This shows you the differences between two versions of the page.

--- plugin:lms [2022-01-28 09:09] – Aleksandr
+++ plugin:lms [2024-07-29 23:51] (current) – version upped andi
@@ Line 6: / Line 6: @@
 email      : [email protected]
 type       : action
-lastupdate : 2022-01-17
+lastupdate : 2024-07-29
 compatible : Hogfather
 depends    :
@@ Line 20: / Line 20: @@
 screenshot_img :
 ----
 This plugin implements a "Lesson Management System": Create a lesson plan based on a control page. Lessons are wiki pages which (authenticated) users can mark as completed. A widget helps users navigate and mark the lessons.
-| [[https://tangotribe.com/|{{https://i0.wp.com/tangotribe.com/wp-content/uploads/2017/08/cropped-Tango-Tribe-fire-rectangle-2016-07-29.png?150 }}]] The initial development of this plugin was financed by Tango Tribe -- Argentine Tango exploration |
+| [[https://tangotribe.com/|{{https://i0.wp.com/tangotribe.com/wp-content/uploads/2017/08/cropped-Tango-Tribe-fire-rectangle-2016-07-29.png?150&recache }}]] The initial development of this plugin was financed by Tango Tribe -- Argentine Tango exploration |
 ===== Installation =====
-[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://cosmocode.de/static/img/dokuwiki/dwplugins.png?directe|A CosmoCode Plugin}}]]
+[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
 Install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
@@ Line 37: / Line 36: @@
 The plugin expects a control page with the lesson structure. By default it is named ''lms''. You can change the id in the configuration.
+You can have multiple control pages in different namespaces, similar to how [[config:sidebar|sidebars]] work.
 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.
 <code>
@@ Line 51: / Line 54: @@
   * [[adv:Lesson A1]]
   * [[adv:Lesson A2]]
 </code>
@@ Line 65: / Line 67: @@
 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.
+<code>
+~~LMSINCLUDE~~
+</code>
+Like the widget above, the control page will only be included for logged in users and when within a lesson context.
 === Template Integration ===
@@ Line 70: / Line 82: @@
 Alternatively to using the Widget, template authors can also integrate the functionality directly in their template. The plugin comes with a [[https://github.com/cosmocode/dokuwiki-plugin-lms/blob/master/helper.php|helper component]] exposing methods to access the lesson system.
-The JavaScript included in the template will automatically mark all links to seen lessons with a small checkmark.
+The JavaScript included in the plugin will automatically mark all links to seen lessons with a small checkmark.
 === 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.
+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.