Architektur der eEx-Aufgaben
eEx-Aufgaben sind HTML-Dateien mit JavaScript-Code für die Logik der Aufgabe. Damit eine HTML-Datei als Aufgabe verwendet werden kann, müssen einige Voraussetzungen erfüllt werden:
- Bestimmte Meta-Daten der Datei müssen befüllt sein.
- Die Datei muss einen Hyperlink zum Inhalt enthalten, ebenfalls sollte eine Funktion zum Neuladen der Datei vorhanden sein.
- Der JS-Code muss sowohl die Aufgabe als auch die Lösung implementieren.
- Die erzielten Ergebnisse der Anwender werden per AJAX an den eEx-Webserver übermittelt.
HTML-Datei, Header und Meta-Daten
Der HTML-Standard seit Version 4.0 schreibt keine konkreten Meta-Angaben mehr vor. eEx erwartet jedoch einige Angaben, welche die Verwaltung der Aufgaben erleichtern. Allgemeines zu Meta-Angaben finden Sie auf den SELFHTML-Seiten.
Der typische Aufbau einer eEx-Aufgabenseite sieht wie folgt aus:
<!doctype html> <html> <head> <title>Nomen, Verben, Adjektive</title> <meta name="description" content="Worttypen erkennen" /> <meta name="page-topic" content="Deutsch, Grammatik" /> <meta name="audience" content="Grundschule 4. Klasse" /> <meta name="page-type" content="Aufgabe" /> <meta name="date" content="01.05.2012" /> <meta name="author" content="Wolfgang Wolf" /> <meta name="copyright" content="WW-Anwendungsentwicklung" /> <meta name="id" content="8FADDCBA-3A54-42F7-856C-D8FAA315144A" /> <meta name="version" content="1" /> <meta http-equiv="content-language" content="de" /> <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <script type="text/javascript" src="jquery-1.7.min.js"></script> <script type="text/javascript" src="eex-1.0.0.min.js"></script> <link rel="stylesheet" type="text/css" href="eex-1.0.0.css" /> <style type="text/css"> ... </style> </head> <body> ... </body> </html>
Dokumententyp-Deklaration
Im Beispiel wurde der Doctype für HTML 5 verwendet. Erforderlich.
html, head
Einleitende Tags für HTML-Datei und Kopfbereich. Erforderlich.
title
Titel: dieser wird auch in der Aufgabenübersicht von eEx angezeigt. Erforderlich.
description
Beschreibung: Kurzbeschreibung der Aufgabe. Sollte angegeben werden, weil diese auch in der Aufgabenübersicht von eEx angezeigt wird. Optional.
page-topic
Thema: Sie sollten hier die Aufgabe grob kategorisieren, indem Sie zum Beispiel das Lern- / Studienfach und eine Spezifizierung angeben. Optional.
audience
Zielgruppe: Sie sollten hier angeben für wen die Aufgabe gedacht ist. Optional.
page-type
Aufgaben-Typ: Aufgabe, Übung, Mehrfachauswahlfragen, usw. Optional.
date
Datum: gibt das Erstellungsdatum der Aufgabe an. Optional.
author
Autor: Hier sollte der Autor der Seite stehen. Optional.
copyright
Urheber: Hier kann der Urheber der Seite stehen. Optional.
id
ID: Dieses Feld beinhaltet eine einmalige Kennung und identifiziert eindeutig eine Aufgabe. Wenn Sie die Aufgabe schon mal publiziert haben, dann sollten Sie diese Kennung nicht mehr ändern. Wichtig: erzeugen Sie keine unterschiedlichen Aufgaben mit der gleichen ID! Erforderlich.
Alle eEx-Autorenprogramme können eindeutige IDs erzeugen. Darüber hinaus finden sie im Programmordner der eEx-Programme auch das Tool eExGUID.exe. Dieses Programm erzeugt beim Ausführen eine eindeutige ID und kopiert diese in die Zwischenablage.
version
Version: zeigt die Version (Ausgabestand) der Aufgabe. Sollten Sie später Ihre Aufgabe überarbeiten oder ergänzen wollen, dann erhöhen Sie die Version. Dafür ist eine Zahl von 1 bis 999 vorgesehen. Die Version für eine neue Aufgabe ist immer 1. Optional.
content-language
Sprache der Aufgabe nach RFC 1766. Optional.
content-type
Angabe zur Zeichenkodierung. Erforderlich.
Beziehungen zu anderen Quellen
Die folgenden drei Zeilen binden externe JS- und CSS-Dateien ein. Hier wurde die jQuery-Bibliothek verwendet und eine von uns zur Verfügung stehende eex-Bibliothek.
Damit alle Aufgaben über ein einheitliches Layout verfügen, sollte eine gemeinsame CSS-Datei verwendet werden. Mit der Datei eex-x.x.x.css stellen wir bereits eine Vorlage zur Verfügung, es besteht aber kein Zwang diese zu verwenden.
style
Manche Aufgaben erfordern zusätzliche und individuelle Style-Informationen. Diese können hier eingetragen werden.
Die eEx-Aufgaben sind Geräte- und Betriebssystemunabhängig. Deshalb sollten die Aufgaben nach der Fertigstellung auf unterschiedlichen Plattformen getestet werden. Hier ist dann nicht nur die Funktionsfähigkeit entscheidend sondern auch die Bedienbarkeit (Usability).