Erfahrene Autoren (mit entsprechenden HTML/CSS und JavaScript Kenntnissen) können für Lehrmittel auf die Avendoo® API (application programming interface) zurückgreifen und so bestimmte Parameter an ein eigenständig erstelltes Design übergeben.
Die nachfolgende Tabelle enthält den entsprechenden Befehl und die jeweilige Erklärung:
Lehrmittel API
| Befehl | Beschreibung |
|---|---|
fn_getAPIVersion() | Gibt die Versionsnummer der aktuellen API wieder. Im Moment gibt die Funktion den Wert „2“ zurück (Stand Februar 2023). |
fn_getActualPageNumber() | Gibt an, auf welcher Seite man sich aktuell befindet. Seite 1 = 0001, Seite 2 = 0002, Unterseite 1 von Seite 2 = 0002, 0001 etc. |
fn_setAllPagesRead() | Setzt alle Lehrmittelseiten auf „visited“, wodurch das Lehrmittel auf dem Lernpfad als „abgeschlossen“ gewertet wird. Der Lerner befindet sich automatisch auf der letzten Lehrmittelseite.
Hinweis: |
fn_reload_page() | Lädt die Seite neu |
fn_getUserLogin() | Gibt den Loginnamen zurück.
Anwendungsbeispiel: |
fn_getUserLanguage() | Gibt die Sprache, die für den Lerner hinterlegt ist, in Form eines Länderkürzels zurück. Die Länderkürzel entsprechen der ISO 639-1. Achtung: |
fn_isPageVisited() | Gibt den Wert „true“ bzw. „false“ zurück, je nachdem ob eine Seite bereits angesehen (true) wurde oder nicht (false). |
fn_getVisitedPages() | Die Funktion liefert ein Array mit allen Seiten, die sich der Lernende bereits angesehen hat. |
fn_getTutorialId() | Gibt die ID zurück, mit der jedes Lehrmittel nummeriert wird. |
fn_getAssignmentId() | Gibt die ID zurück, mit der jede Kursfreigabe nummeriert wird. |
fn_getPageId() | Gibt die ID zurück, mit der jede Lehrmittel-Seite nummeriert wird. |
fn_setData() | Setzt die Daten für alle JavaScript-Varianten mit Text, auch Falsch-Richtig-Werte. Beispiel: fn_setData(“objectType”, 4): “objectType” könnte “Frage 1” sein. |
fn_getData() | Liest die Daten, die gespeichert wurden, für alle JavaScript-Varianten mit Text aus. Beispiel: fn_setData(“objectType”, 4); fn_setData(“objectType”, fn_getData(“objectType”) + 6); fn_getData(“objectType”); => 10 |
Die Tutorial- Assignment- und PageId sind eindeutige 13-stellige Zahlen und sehen in etwa so aus „1437638469552_1“. Zwei unterschiedliche Lehrmittel, Kursfreigaben oder Lehrmittelseiten haben niemals die gleiche ID.
| Befehl | Erklärung |
|---|---|
fn_opencloseMenu() | Blendet das Menü zur Navigation durch das Lehrmittel ein bzw. aus. |
fn_closeMenu() | Blendet das Menü zur Navigation durch das Lehrmittel aus. |
fn_left() | Öffnet die vorherige Seite. |
fn_up() | Bei einer eingerückten Seite öffnet diese Funktion die Seite, die sich eine Ebene höher befindet. |
fn_right() | Öffnet die nächste Seite. |
Diese Funktionen erlauben es dem Autor, eine individuelle Navigation innerhalb der Lehrmittel zu erstellen, indem die Funktionalität der onboard-Navigation von Avendoo® nachgestellt wird.
Anwendungsbeispiel:
Innerhalb des Lehrmittels soll mithilfe von individuellen Buttons navigiert werden. Dabei ist die Menüleiste des Lehrmittels standardmäßig ausgeblendet und wird nur bei Bedarf eingeblendet.
Funktionen, um zu anderen Lehrmittelseiten zu springen
| Befehl | Erklärung |
|---|---|
fn_getPages() | Die Funktion liefert ein Array, in dem jeder Lehrmittelseite eine Ziffernfolge zugeordnet wird – beginnend bei „0001“. Für jede Einrückung wird der jeweiligen Ziffernfolge eine weitere Ziffernfolge angehängt – ebenfalls beginnend mit „0001“. Die erste Unterseite der ersten Seite hat also den Wert „0001, 0001“. Die vierte Unterseite der dritten Seite hat den Wert „0003, 0004“ usw. Hinweis: |
fn_openPageByMenuPosition(position) | Mit der Funktion fn_openPageByMenuPosition(position) kann man auf eine beliebige Lehrmittelseite springen. Dafür setzt man für „position“ einfach die passende Ziffernfolgenkombination der jeweiligen Lehrmittelseite ein (siehe fn_getPages()).
Anwendungsbeispiel: |
fn_openPageByPageId(pageId) | Diese Funktion ist ähnlich zu der Funktion „fn_openPageByMenuPosition(position)“. Allerdings wird die Position nicht in Form von Buchstaben angegeben sondern in Form der pageId (siehe hierzu auch fn_getPageId()). |
fn_switch2otherTutorial(tutorialId,pageId)
| Mithilfe dieser beiden Funktionen kann auf eine beliebige Seite in einem anderen Lehrmittel gesprungen werden.
Achtung: |
Beim Aufruf von einer bestimmten Seite innerhalb bzw. außerhalb eines Lehrmittels nimmt Avendoo® dem Autor bereits viel Arbeit ab. Klicken Sie im Editor auf „Lehrmittel verlinken“, wird automatisch ein Link zur gewünschten Lehrmittelseite erstellt. Im Quellcode können Sie den fertig erstellen Link kopieren, abändern und wiederverwerten.
