Avendoo® Online Hilfe

Avendoo® API

Interaktive Wissenstestfragen

Erfahrene Autoren (mit entsprechenden HTML/CSS und JavaScript Kenntnissen) können für das Erstellen einer interaktive Frage 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:

BefehlErklärung

window.top.

Da der Inhalt der interaktiven Frage in einen Iframe eingebunden wird, muss diese Angabe vor jeder Funktion stehen, um aus dem Iframe heraus auf die Funktion der Avendoo-API zuzugreifen.

fn_setInteractiveQuestionState(percent,
useranswer)

Die Funktion übergibt die folgenden Parameter der interaktiven Frage an Avendoo®:

percent = Erreichte Punktzahl
useranswer = Ausgewählte Antwort des Benutzers

Mit Hilfe des Parameters percent definiert der Autor den erreichbaren Punktewert je Antwortfall.
Die Punktzahl kann ein fest definierter Wert sein oder mit Hilfe der Funktion

fn_getPoints()

anteilig aus der maximal erreichbaren Punktzahl der Frage ermittelt werden.

Der Parameter useranswer kennzeichnet die unterschiedlichen Antwortfälle und ist eine, vom Autor frei bestimmbare, alphanumerische Bezeichnung (z.B. „opt1“, „opt2“, „opt3“).

Hinweis:

Die Bezeichnungen „opt1“, „opt2“ usw. müssen in doppelten Anführungszeichen oben notiert sein.

fn_getReshow()

Die Funktion ermittelt, ob es sich um eine Wiederanzeige der Frage handelt.

true = Frage wird erneut angezeigt
false = Frage wird erstmals angezeigt

Beispiel:
Wird die Frage von der Endseite eines Wissenstests aus erneut angezeigt, soll die Frage in dem Zustand angezeigt werden, wie der Benutzer sie nach der Bearbeitung der Frage „abgegeben“ hat. Mit Hilfe dieser Funktion wird die erneute Anzeige ausgelesen.

Quellcode-Beispiel:

if(window.top.fn_getReshow()) {
var useranswer = window.top.fn_getUserAnswer();
    //Mit Hilfe der Variable useranswer muss nun die Antwort zur Anzeige gebracht werden. 
Zum Beispiel das Setzen des gewählten Radio-Buttons einer SingleChoice-Frage
 }

fn_getDissolve()

Die Funktion ermittelt auf Basis der Einstellungen im Wissenstest-Assistenten, ob die Lösung angezeigt werden soll oder nicht.

true = Lösung soll angezeigt werden
false = Lösung soll nicht angezeigt werden

Interaktive Frage API Navigation

Beispiel:
Nachdem der Benutzer die Frage falsch beantwortet hat, kann ihm die korrekte Lösung dargestellt werden.

fn_getPoints()

Die Funktion ermittelt die maximal erreichbaren Punkte, die im Frage-Assistenten der interaktiven Frage eingestellt wurde.

Interaktive Frage API Erreichbare Punkte

fn_getReachedPoints()

Die Funktion ermittelt die mit dem tatsächlichen Antwortfall des Benutzers erreichten Punkte für diese Frage.

Hinweis:
Es handelt sich um die Punktzahl, die mit Hilfe der Funktion
fn_setInteractiveQuestionState
an Avendoo® übergeben wurde; also den vom Autor je Antwortfall festgelegten Punktewert.

fn_getUseranswer()

Die Funktion ermittelt den vom Benutzer gewählten Antwortfall.

Hinweis:
Es handelt sich um die Antwort, die mit Hilfe der Funktion
fn_setInteractiveQuestionState
an Avendoo® übergeben wurde; also die vom Autor festgelegte alphanumerische Bezeichnung je Antwortfall.

Beispiel:
Wird die Frage von der Endseite eines Wissenstests aus, erneut angezeigt, soll die Frage in dem Zustand angezeigt werden, wie der Benutzer sie nach der Bearbeitung der Frage „abgegeben“ hat.

fn_getParameter()

Die Funktion ermittelt die Parameter, die im Frage-Assistenten der interaktiven Frage unter „Frageparameter“ eingegeben wurden.

Interaktive Frage API Frageparameter

Beispiel:

In den Frageparametern können z.B. die Texte der Fragestellung und Antwortmöglichkeiten einer Frage definiert werden. Die Parameter werden dann ausgelesen und dynamisch in die interaktive Frage geschrieben. Somit wird die Flexibilität gesteigert und es kann im Prinzip eine Fragevorlage erstellt werden, die über die Frageparameter immer wieder anders befüllt wird.

Nachfolgend sehen Sie die Anweisungen, mit denen die Texte der interaktiven Frage mit Hilfe der Frageparameter befüllt werden können:

Frageparameter (in der interaktiven Frage von Avendoo®):

{"question": "Was war der 30.06.2015 für ein Wochentag?",
"answer1": "Montag",
"answer2": "Dienstag",
"answer3": "Mittwoch"}

Die Eigenschaftsnamen „answer1“, „answer2“ usw. müssen in doppelten Anführungszeichen notiert sein

  • Die zugehörigen Werte werden als Text/String ebenfalls in doppelte Anführungszeichen geschrieben. Zahlenwerte und Boolean (true/false) werden ohne Anführungszeichen geschrieben.


JavaScript (im Inhalt der interaktiven Frage):

var parameter = window.top.fn_getParameter();
var json = JSON.parse(parameter);
// Mit Hilfe der Angaben json-question, json.answer1, json.answer2, json.answer3 können die definierten Frageparameter 
in der interaktiven Frage verwendet werden.