Autocomplete related activities

English Description

German version please see below

This plugin helps with activity completion tracking when sections provide the same material in different forms, e.g. as interactive book, PDF or Video-URL. If any of the alternatives is marked complete, the plugin automatically marks the remaining alternatives as complete too.

It considers activities and resources as alternatives that are within the same section and follow a configurable regular expression matching pattern.

To see the completion state change, users might have to refresh the page.

Thus, material in a section could be offered as

• example topic (book variant)
• example topic (link to a video variant)
• example topic (as a PDF file)

With a regular expression that considers the materials to be alternatives if their names match up to opening parenthesis, the plugin then considers these alternatives, and if one is completed, it automatically marks the others as completed too.

In addition, it is possible to introduce a label that e.g. contains the text "I know this already". In this case learners can indicate that they don't need to go through any of the alternatives. If such a label is present, it is automatically marked complete if one of the alternatives is completed (assuming that in this case there is also no need to go through the alternatives any more). The automatic marking does not work the other way: if only the label is marked as complete, the alternatives keep their completion status.

The plugin is only active in those courses for which it is configured (by indicating the respective course IDs in the settings of the plugin).

More details on functionality and configuration of this plugin can be found in the Wiki.

Installing via Moodle Web Interface

1. Load the .zip file with the newest version from https://github.com/SE-Stuttgart/moodle-local_autocompleteactivities/releases.
2. Log in to your Moodle site as an admin and go to Site administration > Plugins > Install plugins.
3. Upload the ZIP file with the plugin code and click Install plugin from the ZIP file
4. Check the plugin validation report and finish the installation.
5. You are prompted to configure the plugin. Please specify in which courses the plugin should be active by selecting from the list of available courses. For example, you may enter 1,2 to activate the plugin in the courses with the IDs 1 and 2. This concludes the configuration.

If you want to change the configuration later, come back to the plugin page (Site administration > Plugins). Click Category: Local plugins. You will find the configuration page of the plugin under Manage Activity Autocompletion Settings.

Installing manually

The plugin can be also installed by putting the contents of this directory to

{your/moodle/dirroot}/local/autocompleteactivities

Afterwards, log in to your Moodle site as an admin and go to Site administration > Notifications to complete the installation.

Alternatively, you can run

$ php admin/cli/upgrade.php

to complete the installation from the command line.

Deutsche Beschreibung

This plugin helps with activity completion tracking when sections provide the same material in different forms, e.g. as interactive book, PDF or Video-URL. If any of the alternatives is marked complete, the plugin automatically marks the remaining alternatives as complete too.

It considers activities and resources as alternatives that are within the same section and follow a configurable regular expression matching pattern.

To see the completion state change, users might have to refresh the page.

Dieses Plugin hilft beim Verfolgen der abgeschlossenen Aktivitäten im Falle dass Abschnitte das gleiche Selbe in verschiedenen Formen anbieten, z.B. as interaktives Buch, PDF oder Link zu einem Video. Wenn eine der Alternativen als abgeschlossen markiert wird, markiert das Plugin automatisch auch die Alternativen in der Datenbank als abgeschlossen.

Als Alternativen gelten Aktivitäten und Arbeitsmaterial innerhalb des selben Kursabschnitts, die einen konfigurierbaren regulären Ausdruck erfüllen.

So könnte Material in einem Kursabschnitt z.B. angeboten werden als

• Beispielthema (Buch-Variante)
• Beispielthema (Video-Link-Variante)
• Beispielthema (PDF-Datei-Variante)

Mit einem regulären Ausruck, der Materialien als Alternativen akzeptiert falls ihre Namen bis zu einer offenen Klammer übereinstimmen, wird das Plugin alle diese Alternativen automatisch als abgeschlossen markieren, sobald eine beliebige davon abgeschlossen wurde.

Außerdem ist es möglich, zusätzlich ein Textfeld anzulegen, das den Text "kann ich schon" enthält. Dadurch können Lernende selbständig markieren, welches Material sie überspringen wollen. Falls so ein Textfeld vorhanden ist, wird es bei der Erledigung der Aktivitäten in dem Abschnitt automatisch ebenfalls als erledigt gekennzeichnet. Andersherum geschieht das allerdings nicht automatisch: wird nur das Textfeld "kann ich schon" erledigt, behalten die weiteren Materialien ihren Erledigungs-Status.

Das Plugin wird nur in den Kursen aktiv, für die es konfiguriert wurde (durch Angabe der Kurs-IDs der gewünschten Kurse bei den Einstellungen des Plugins).

Mehr Informationen zu den Funktionen und zur Konfiguration des Plugins sind im Wiki zu finden.

Installation über das Web-Interface von Moodle

1. Laden Sie unter https://github.com/SE-Stuttgart/moodle-local_autocompleteactivities/releases das .zip-File mit der neuesten Version.
2. Loggen Sie sich in Ihrem Moodle als Admin ein und gehen Sie zu Website-Administration > Plugins > Plugin installieren.
3. Laden Sie das .zip-File hoch und klicken Sie Plugin installieren.
4. Überprüfen Sie die Hinweise und schließen Sie die Installation ab.
5. Sie bekommen anschließend eine Seite zur Konfiguration des Plugins angezeigt. Wählen Sie hier bitte aus, in welchen Kursen das Plugin aktiv sein darf. Zum Beispiel können sie 1,2 eingeben um das Plugin in den Kursen mit den IDs 1 und 2 zu aktivieren. Damit ist die Konfiguration abgeschlossen.

Falls die Konfiguration später geändert werden soll, kommen Sie zurück zur Plugin-Seite (Website-Administration > Plugins). Sie finden dort unter Bereich: Lokale Plugins den Punkt Manage Activity Autocompletion Settings, unter dem Sie das Plugin wie oben erklärt konfigurieren können.

Bitte beachten Sie, dass das Plugin nicht rückwirkend funktioniert: es markiert die Alternativen erst ab dem Zeitpunkt, ab dem es für einen Kurs konfiguriert wurde, automatisch als erledigt. Alternativen zu bereits früher abgeschlossenem Arbeitsmaterial bleiben unerledigt und müssen ggf. von Hand erledigt werden. Wenn die Funktionalität also gewünscht wird, sollte das Plugin möglichst vor Kursbeginn installiert sein.

License

2022 Universtity of Stuttgart [email protected]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Förderhinweis

English version please see Acknowledgement below

Diese Software wird im Rahmen des Projekts $KI$ $B^3$ - Künstliche Intelligenz in die Berufliche Bildung bringen als InnoVeET-Projekt aus Mitteln des Bundesministeriums für Bildung und Forschung gefördert. Projektträger ist das Bundesinstitut für Berufsbildung (BIBB). Im Projekt werden eine Zusatzqualifikation (DQR 4) sowie zwei Fortbildungen (auf DQR5- bzw. DQR-6 Level) für KI und Maschinelles Lernen entwickelt. Die Software soll die Lehre in diesen Fortbildungen unterstützen.

Acknowledgement

This software is developed in the project $KI$ $B^3$ - Künstliche Intelligenz in die Berufliche Bildung bringen. The project is funded by the German Federal Ministry of Education and Research (BMBF) as part of the InnoVET funding line, with the Bundesinstitut für Berufsbildung (BIBB) as funding organization. The project also develops vocational training programs on Artificial Intelligence and Machine Learning (for DQR levels 4, 5, and 6). The software supports teaching in these programs.