Teil 1: Erstelle einen edML-basierten Online-Kurs
Kurzeinführung XML
Ein Tag mit Namen tagname ist ein "Bauelement", das die Struktur eines Dokumentes beschreibt und wird durch <tagname> geöffnet und durch </tagname> geschlossen. Dazwischen können sich je nach Element weitere Unterstrukturen (= andere Tags) und/oder Text befinden. Ist zwischen öffnendem und schließendem Tag kein Inhalt, so kann dies durch <tagname/> abgekürzt werden. Bei <tagname> sind zusätzlich noch sogenannte Attribute erlaubt, die bestimmte Eigenschaften definieren können. Attribute werden in der Form attributname="attributwert" angegeben. Eine Liste aller in edML verfügbaren Tags finden Sie in der Kategorie Sprache (Definitionen) bzw. Player (Anwendungsbeispiele).
Das Grundgerüst: der course-Tag
Derzeit steht der Online-Editor noch nicht zur Verfügung. Daher verwenden Sie am besten einen Code-Editor wie z. B. Visual Studio Code, IntelliJ IDEA oder Eclipse. Alternativ kann auch jeder Texteditor verwendet werden, sogar Word u. ä.
Ein Online-Kurs wird in edML durch einen course-Tag eingeleitet.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
</course>
Der Wert des Attributs edmlversion gibt die edmlversion an
Variante erstellen
Ein Kurs kann eine oder mehrere Varianten von sich definieren, z. B. verschiedene Sprachvarianten. Daher folgt als nächster Tag variant, wobei die Sprache mit dem Attribut lang festgelegt wird. Mögliche Werte sind z. B. de für Deutsch oder en für Englisch.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
</variant>
</course>
In diesem Tutorial beschränken wir uns auf eine Sprachvariante. Weitere könnten Sie analog definieren:
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
</variant>
<variant lang="en">
<variant>
</course>
Kurstitel vergeben
Um dem Kurs einen Titel zu vergeben, muss jeder Variante ein eigenständiger Titel vergeben werden:
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
</variant>
</course>
Navigation und Seiten vorbereiten
Neben dem Kurstitel enthält muss eine Variante noch eine Seiten-Navigation sowie Seiten enthalten. Diese werden in den nächsten Schritten "ausformuliert".
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
</navigation>
<pages>
</pages>
</variant>
</course>
Startseite erstellen
Nun soll eine Startseite erstellt werden, zum Beispiel mit einem Begrüßungstext. Im ersten Schritt wird die Seite erstellt. Jede Seite muss innerhalb einer Variante eindeutig identifizierbar sein. Deshalb erhält jede Seite ein Attribut name, dessen Wert innerhalb der Variante nur an dieser speziellen Seite vorkommen darf. Der Namenswert sollte möglichst so gewählt werden, dass er Sie als Autor bei der Identifikation der Seite unterstützt. Er muss mit einem Buchstaben beginnen. Namensbestandteile können durch _ bzw. - kenntlich gemacht werden.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
</navigation>
<pages>
<page name="startpage">
</page>
</pages>
</variant>
</course>
Die Seite ist zur Zeit inhaltsleer. Ein Seitentitel kann über den Tag title vergeben werden. Um einen Begrüßungstext hinzuzufügen, müssen wir die Seite zunächst mit einem passenden Container versehen, der dann den Inhalt trägt. Der einfachste Container ist ein textbox-Element, in dem Text eingebettet werden kann. Texte werden in Paragraphen (p-Tag) angeordnet. Ein mögliche Startseite könnte so aussehen:
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
</navigation>
<pages>
<page name="startpage">
<title>Herzlich willkommen zum Kurs!</title>
<textbox>
<p>Wir wünschen Ihnen viel Spaß bei der Bearbeitung</p>
</textbox>
</page>
</pages>
</variant>
</course>
Seite mit Navigation verknüpfen
Als letzten Schritt muss die Seite mit mit der Navigation verknüpft werden, damit der Kursnutzer diese auch auffinden kann. Die Navigation kann als eine Liste mit möglichen "Unterlisten" zu einzelnen Punkte aufgefasst werden. Daher zum man zunächst ein navlist-Element der Navigation hinzufügen. Dieses navlist-Element stellt die oberste Ebene der Navigation dar. Ein direkt untergeordnetes navlist-Elemente entspricht der zweiten Navigationsebene usw.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
<navlist>
</navlist>
</navigation>
<pages>
<page name="startpage">
<title>Herzlich willkommen zum Kurs!</title>
<textbox>
<p>Wir wünschen Ihnen viel Spaß bei der Bearbeitung</p>
</textbox>
</page>
</pages>
</variant>
</course>
Die Navigationsliste muss nun um einen Eintrag ergänzt werden, welcher auf die Seite namens startpage verweist. Hierfür wird das Element navitem verwendet sowie das Element ref. Da es sich in unserem Beispiel um die Startseite handelt, soll dem navitem diese Rolle über das Attribut roles zugewiesen werden. Damit das navitem auf die Seite verweist und nicht z. B. auf einen externen Link (was auch möglich wäre), wird dem navitem ein ref-Element untergeordnet. Dieses zeigt mittels dem Attribut to auf die Seite namens startpage.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
<navlist>
<navitem roles="home">
<ref to="startpage"/>
</navitem>
</navlist>
</navigation>
<pages>
<page name="startpage">
<title>Herzlich willkommen zum Kurs!</title>
<textbox>
<p>Wir wünschen Ihnen viel Spaß bei der Bearbeitung</p>
</textbox>
</page>
</pages>
</variant>
</course>
Damit wäre ein erster Online-Kurs seitens edML erfolgreich erstellt. Diesen können Sie durch den eingesetzten Editor in eine Datei speichern, z. B. course.edml. Diese Datei können Sie auch gleich mit Hilfe unserer online edML-Player-Variante testen.
Weitere Seiten hinzufügen
Weitere Seiten können durch Angabe von weiteren page-Elementen unter pages hinzugefügt werden. Diese sollten dann jeweils mit einem navitem verknüpft werden, damit die Kursnutzer diese auch aufrufen können.
<course xmlns="https://edml.mint-kolleg.kit.edu" edmlversion="0.6.0">
<variant lang="de">
<title>Mein erster edML-Online-Kurs</title>
<navigation>
<navlist>
<navitem roles="home">
<ref to="startpage">Start</ref>
</navitem>
<navitem>
<ref to="chapter1page">Kapitel 1</ref>
<navlist>
<navitem>
<ref to="chapter1-content1">Inhalt 1-1</ref>
</navitem>
</navlist>
</navitem>
</navlist>
</navigation>
<pages>
<page name="startpage">
<title>Herzlich willkommen zum Kurs!</title>
<textbox>
<p>Wir wünschen Ihnen viel Spaß bei der Bearbeitung</p>
</textbox>
</page>
<page name="chapter1page">
<title>Kapitel 1</title>
<textbox>
<p>Willkommen zu Kapitel 1!</p>
</textbox>
</page>
<page name="chapter1-content1">
<title>Kapitel 1</title>
<textbox>
<p>Inhalt 1-1</p>
</textbox>
</page>
</pages>
</variant>
</course>