Learning Tools: Difference between revisions

Revision as of 08:18, 12 October 2021

About Learning Tools

Description

The purpose of Learning Tools is to provide students tools to improve their learning experience. All tools are very easy to use and can be accessed from a unified interface, the floating button. This design is well known and a very common choice in apps.

Architecture

The plugin is built with flexibility and modularity in mind. The foundation is the local plugin, which implements the management functionality and the unified interface in the form of the floating button. On top of the local plugin, we've created a new (sub) plugin type called "ltool". In the initial release, we're publishing ltool_boomarks and ltool_notes. In the future, we plan many more tools which improve the learning experience even more. Have a look at our roadmap to learn more!

Learning Tools sub plugins

List of ltools that are available and planned for Learning Tools.
Name	Description	Tier	Link	Type
Bookmarks	Create Bookmark	Free	Learning Tools/Bookmarks	included
Notes	Take notes	Free	Learning Tools/Notes	included
Invite	Enrol students easily via email address (in bulk)	Pro		coming in version 0.2
Force activity	Automatically redirect students to a specific activity until the activity is completed	Pro		coming in version 0.2
Information	Display course summary and image	Pro		coming in version 0.2
Email	Send an email to your participants	Pro		coming in version 0.2
Resume	Return to the last exact page with the click of a button	Pro		coming in version 0.2
... see our roadmap for a full list of additions we plan

Installation & Configuration

Installation and configuration instructions can be found here: Learning Tools/Installation

Learning Tools
Type	Local Plugin
Set	N/A
Downloads	https://moodle.org/plugins/local_learningtools (not yet published)
Issues	https://github.com/bdecentgmbh/moodle-local_learningtools/issues
Discussion
Maintainer(s)	Stefan Scholz

@@ Line 12: / Line 12: @@
 === Architecture ===
 The plugin is built with flexibility and modularity in mind. The foundation is the local plugin, which implements the management functionality and the unified interface in the form of the floating button. On top of the local plugin, we've created a new (sub) plugin type called "ltool". In the initial release, we're publishing ltool_boomarks and ltool_notes. In the future, we plan many more tools which improve the learning experience even more. Have a look at our roadmap to learn more!
 === Learning Tools sub plugins ===
 {| class="wikitable"
@@ Line 18: / Line 17: @@
 !Name
 !Description
+!Tier
 !Link
 !Type
@@ Line 23: / Line 23: @@
 |Bookmarks
 |Create Bookmark
+|Free
 |[[Learning Tools/Bookmarks]]
 |included
@@ Line 28: / Line 29: @@
 |Notes
 |Take notes
+|Free
 |[[Learning Tools/Notes]]
 |included
 |-
-|Schedule
+|Invite
-|Schedule an activity to "learn" later
+|Enrol students easily via email address (in bulk)
+|Pro
 |
 |coming in version 0.2
 |-
-|Alert
+|Force activity
-|Inform your students about important news
+|Automatically redirect students to a specific activity until the activity is completed
+|Pro
 |
 |coming in version 0.2
 |-
-|Invite
+|Information
-|Enrol students easily via email address (in bulk)
+|Display course summary and image
+|Pro
+|
+|coming in version 0.2
+|-
+|Email
+|Send an email to your participants
+|Pro
 |
 |coming in version 0.2
 |-
-|Force activity
+|Resume
-|Automatically redirect students to a specific activity until the activity is completed
+|Return to the last exact page with the click of a button
+|Pro
 |
 |coming in version 0.2
 |-
-| colspan="4" |''... see our [https://bdecent.de/learning-tools/roadmap/ roadmap] for a full list of additions we plan''
+| colspan="5" |''... see our [https://bdecent.de/learning-tools/roadmap/ roadmap] for a full list of additions we plan''
 |}
+==Installation & Configuration==
-==Installation==
+Installation and configuration instructions can be found here: [[Learning Tools/Installation]]
-For more detailed info how to install plugins in general, visit https://docs.moodle.org/401/en/Installing_plugins.
-To install Learning Tools, you have three options:
-=====Option 1: Install from Moodle.org=====
-'''''NOT YET POSSIBLE, WAITING FOR PLUGIN APPROVAL'''''
-#Login as an admin and go to Site administration > Plugins > Install plugins. (If you can't find this location, then plugin installation is prevented on your site.)
-#Click the button 'Install plugins from Moodle plugins directory'.
-#Search for "Learning Tools", click the Install button then click Continue.
-#Confirm the installation request
-#Check the plugin validation report
-=====Option 2: Install from zip package=====
-#Download Learning Tools from <nowiki>https://bdecent.de/product/learningtools</nowiki>
-#Login to your Moodle site as an admin and go to Administration > Site administration > Plugins > Install plugins.
-#Upload the ZIP file. You should only be prompted to add extra details (in the Show more section) if the plugin is not automatically detected.
-#If your target directory is not writeable, you will see a warning message.
-#Check the plugin validation report
-=====Option 3: Install manually on server=====
-#Download Learning Tools from <nowiki>https://bdecent.de/product/learningtools</nowiki>
-#Rename the folder to "learningtools"
-#Upload or copy it to your Moodle server.
-#Unzip it in the `/local` directory. (the path should then look for example like this: [https://yourmoodle.com/mod/pulse/version.php https://yourmoodle.com/local/learningtools/version.php])
-#In your Moodle site (as admin) go to Settings > Site administration > Notifications (you should, for most plugin types, get a message saying the plugin is installed).
-== Initial configuration ==
-After the installation, the plugin is ready to use. The floating button will immediately show up for all authenticated users (guests and non-authenticated users can't use them).
-=== Global settings ===
-Learning Tools has a couple of global settings which can be accessed via at ''Site administration > Plugins > Local Plugins > Learning Tools''
-* '''Notification display time''' — this defined the time that the notification is shown to the user after the user for example bookmarked a page
-* '''Learning Tools in user menu''' — syntax for adding tools to the user menu (see below)
-* '''Manage Learning Tools''' — on this page, you can enable/disable, sort and uninstall each tool
-=== Adding Learning Tools to the user menu ===
-In order to keep the floating button menu as simple as possible, we have only added the "action" (e.g. create a bookmark), but not the "list" (e.g. see all bookmarks). Instead, we tried to make Learning Tools as native as possible by adding them on the user profile, following a design pattern used by core moodle (e.g. for forum posts or user related reports).
-In addition, we think that the user menu is a great spot as well to provide access, too. That's why we've prepared the syntax for you, so that you can simply copy and paste it into the user menu. (we had initially automated that, but it felt to intrusive and would have potentially surprised some administrators, which is why we opted for this solution instead).
-The user menu can be customised here: ''Site administration > Appearance > Themes > Theme settings > User menu items'' (or simply search for user menu).

Documentation