|
akfquiz − Dateiformat für Quiz-Spiele, Übungsaufgaben, Psycho-Tests |
|
Die AKFQuiz-Dateien können mit einem normalen Texteditor erstellt und bearbeitet werden. AKFQuiz-Dateien können die Datei-Endung ".akfquiz" oder ".aqz" haben, in vielen Fällen kann man die Datei-Endung aber auch weg lassen. Eine Zeile, die mit einer Raute (#) beginnt ist ein Kommentar und wird ignoriert. Vor der Raute dürfen nur Leerzeichen stehen. Eine Raute, die nicht am Anfang der Zeile steht, wird als normales Zeichen interpretiert. Das AKFQuiz-Format basiert auf Stichworten. Die Stichworte dürfen eingerückt sein und die Groß-/Kleinschreibung ist beliebig. Um Stichworte ungültig zu machen kann man eine Raute (#) davor setzen. Es gibt einzeilige Stichworte. Diese dienen zu Einstellungszwecken. Einzeilige Stichworte müssen am Anfang der Datei, vor den block-orientierten Stichworten stehen. Außerdem gibt es block-orientierte Stichworte. Diese bilden dann den sichtbaren Inhalt des Quizzes. Der Text bei block-orientierten Stichworten muss in einer neuen Zeile beginnen. Man beachte die Beispiel-Dateien. |
|
Die Stichworte in AKFQuiz-Dateien im Einzelnen: |
|
AKFQuiz |
|
Schreiben Sie den Ausdruck AKFQuiz an den Anfang einer AKFQuiz-Datei (hinter der #! Zeile, falls Sie die verwenden). Dahinter können Sie Informationen über die benötigte Version schreiben. Falls nötig kann auch ein Varianten-Name benutzt werden: Achtung: Ab Version 4.1.0 oder höher muss dieses Stichwort benutzt werden und es muss am Anfang der Zeile stehen. Zeilen vor diesem Stichwort werden ignoriert. |
|
Ende (end) |
|
Das Stichwort Ende oder end sollte am Ende der Quiz-Datei geschrieben werden. Zeilen nach diesem Stichwort werden ignoriert. Somit können AKFQuiz Dateien in andere textorientierte Dateiformate eingebettet werden. |
|
Zeilen-orientierte Stichworte: |
|
Titel: (title:) |
|
Titel des Quizzes - dieser sollte immer angegeben werden und eindeutig sein. |
|
Autor: (author:) |
|
der Autor des Quizzes. Es sollte derjenige angegeben werden, der für den Inhalt, also für die Fragen verantwortlich ist - nicht derjenige, der das als Datei umgesetzt hat. |
|
Autorlink: (authorlink:) |
|
Link zur Homepage des Autors, oder die E-Mail Adresse. Bitte in URI-Schreibweise mit Protokollnamen angeben. Zum Beispiel: http://akfoerster.de/ oder mailto:akfquiz@akfoerster.de |
|
Bearbeitet: (edited:) |
|
Liste von Leuten, die die Quiz-Datei überarbeitet haben |
|
Copyright: |
|
derjenige, der das Copyright bzw. Urheberrecht inne hat. Dieses Stichwort kann alternativ zu Autor: benutzt werden. Es gibt aber auch Fälle, wo der Autor und der Copyright-Inhaber verschieden sind. In dem Fall können auch beide Stichworte verwendet werden. |
|
Lizenz: (license:) |
|
unter welcher Lizenz das Quiz steht. Bitte die präzise Bezeichnung und die Versions-Nummer der Lizenz angeben. |
|
Lizenzlink: (licenselink:) |
|
ein Link zum Lizenz-Text, oder eine URN, die sich auf die Lizenz bezieht. |
|
Uebersetzer: (translator:) |
|
der Übersetzer, falls es sich um eine Übersetzung handelt |
|
Kodierung: (encoding:) |
|
welche Zeichensatz-Kodierung verwendet wird. Die Vorgabe ist US-ASCII und Zeichen, die nicht in ASCII vorkommen (zB. deutsche Umlaute) werden heraus gefiltert. Unterstützt: UTF-8, ISO-8859-1, ISO-8859-15, IBM850, US-ASCII, Windows-1252 (man sollte IBM850 statt IBM437 verwenden um Probleme zu vermeiden) |
|
Zeichensatz: (charset:) |
|
Obsolet; sollte nicht mehr verwendet werden |
|
Sprache: (language:) |
|
Sprache - als zweistelliges Buchstabenkürzel anzugeben, wie sie in ISO-639-1 definiert sind. Zum Beispiel "de" für deutsch, "en" für Englisch. Es sollte immer die richtige Sprache angegeben werden, auch wenn diese von den Programmen noch nicht unterstützt wird, da diese Angabe auch in den (X)HTML-Code zur weiteren Bearbeitung kopiert wird. Sprachen, die nicht in ISO-639-1 definiert sind, sollten mit "x-" eingeleitet werden. Zum Beispiel "x-cherokee" (Sprache der Schirokesen). Unterstützte Sprachen: en, de, da, it |
|
rtl: |
kann man auf "ja", "yes", "true" oder "1" setzen. Es bedeutet, dass die Schreibrichtung des Haupttextes von rechts nach links verläuft, zB. für Hebräisch oder Arabisch. |
|
Experimentelle Unterstützung |
|
bidi: |
Bidi steht für "bidirectional" (sinngemäß: 2 Schreibrichtungen) Man kann es auf "ja", "yes", "true" oder "1" setzen. Das bedeutet, der Text kann Textstellen enthalten, die eine andere Schreibrichtung haben, als der Haupttext. |
|
Experimentelle Unterstützung |
|
Neutral: |
|
kann man auf "ja", "yes", "true" oder "1" setzen, was bedeutet, dass die Programme neutral antworten sollen, das heißt Antworten nicht als richtig oder falsch kennzeichnen, oder sagen, dass weniger als 1 Punkt "nicht genug" sei. Dieses sollte zusammen mit den Stichworten "Auswertung:" und "Auswertungslink:" verwendet werden. |
|
Auswertungslink: (assessmentlink:) |
|
Link, der auf ein Dokument verweist, das erklärt, was das Ergebnis zu bedeuten hat. Da könnte zum Beispiel so was stehen wie "über 80% ist gut, unter 10% ist schlecht". Der Auswertungslink wird nur benutzt, wenn die Ausgabe HTML-Code ist (mkquiz, akfquiz.cgi). Man sollte zusätzlich auch das Block-Stichwort Auswertung: als Alternative für die anderen Programme verwenden. Nur das Stichwort Auswertung: zu verwenden ist auch in Ordnung, wenn das ausreicht. Für Fortgeschrittene: Wenn das letzte Zeichen der URI ein Fragezeichen (?) ist, werden Werte für "points", "maxpoints" und "percent" angehängt, so dass sie aus Skripten ausgelesen werden können. Beispiel: Auswertungslink: schulnote.html? Diese Beispiel-Datei berechnet eine Schulnote. Sie benutzt dafür JavaScript. Natürlich kann man auch CGI oder PHP Skripte verwenden. |
|
htmlcode: |
|
kann man auf "ja", "yes", "true" oder "1" setzen, wenn man in der
Eingabe-Datei selber HTML Code verwenden will - die HTML-Tags werden
direkt in die HTML-Ausgabe kopiert. Andere AKFQuiz-Interpreter lassen
HTML-Tags einfach aus. Die automatische URI Erkennung (siehe unten) wird ausgeschaltet, wenn htmlcode aktiviert ist. |
|
HauptURI: (baseURI:) |
|
URI für die Grafik-Dateien und CSS-Dateien. Es kann eine relative oder absolute Adresse angegeben werden. Diese Angabe hat nur Auswirkungen bei akfquiz.cgi. Beispiel: /akfquiz |
|
Layout: (CSS:) |
|
verweist auf eine CSS Datei. Diese Dateien beeinflussen das Aussehen des Quizzes im Web-Browser. Diese Angabe hat nur Auswirkungen auf die (X)HTML-Ausgabe. Die Unterscheidung zwischen verschiedenen Ausgabe-Medien sollte in der CSS-Datei stattfinden. Man kann gerne die Beispiel-Dateien, die bei dem Programm mitgeliefert werden auch für eigene Quizze verwenden, und auch mit veröffentlichen. |
|
Stichworte: (keywords:) |
|
Stichworte für die Meta-Daten von (X)HTML-Dateien. Wird von einigen Suchmaschinen ausgewertet. |
|
JavaScript: |
|
gibt den Namen der JavaScript Datei an. Das Stichwort ist mittlerweile obsolet und sollte nicht mehr verwendet werden. |
|
NoIndex: |
|
kann man auf "ja", "yes", "true" oder "1" setzen. Es schreibt eine Anweisung für Suchmaschinen in den (X)HTML-Code, dass dieses Quiz nicht in den Index der Suchmaschine aufgenommen werden soll. Die meisten Suchmaschinen halten sich auch dran. Auf andere Ausgabeformen hat dieses Stichwort keine Auswirkungen. |
|
StandardAntwort: (default:) |
|
Standard-Antwort für Fragen mit nur einer Antwort-Möglichkeit. Diese Antwort wird immer als letzte angeführt und ist vorausgewählt. Dies sollte man immer verwenden, wenn man für falsche Antworten auch Punkt-Abzüge geben will. |
|
Block-orientierte Stichworte: |
|
Kommentar: (comment:) |
|
fügt einen Kommentar in das Quiz ein. Der Kommentar kann mehrere Zeilen umfassen und wird durch eine Leerzeile abgeschlossen. Kommentare können am Anfang, zwischen den Fragen oder am Ende eingefügt werden. Eine Leerzeile kann in einem solchen Kommentar nicht vorkommen. Um einen neuen Abschnitt zu beginnen, kann man einen einzelnen Punkt als einziges lesbares Zeichen in der Zeile schreiben (Leerzeichen sind erlaubt) (siehe auch "Hinweis:" und "Auswertung:") |
|
Hinweis:, Anmerkung: (hint:, remark:) |
|
Dieses ist ähnlich wie ein "Kommentar:", aber es wird nur gezeigt, nachdem die vorhergehende Frage bereits beantwortet wurde. Für die interaktiven AKFQuiz-Programme gibt es keinen Unterschied zu "Kommentar:", aber in den HTML-Varianten wird ein "Hinweis:" erst auf der Auflösungs-Seite angezeigt. |
|
Frage: (question:, mc:) |
|
definiert eine Frage mit nur einer Antwort-Möglichkeit. Es kann auch mehr als nur eine Antwort richtig sein, aber nur eine kann ausgewählt werden, zB. für "was ist die beste Lösung"-Fragen. Die Frage kann mehrere Zeilen umfassen und wird durch eine Leerzeile abgeschlossen. Um einen neuen Abschnitt zu beginnen, kann man einen einzelnen Punkt als einziges lesbares Zeichen in der Zeile schreiben (Leerzeichen sind erlaubt). Darauf folgen die Antwort-Möglichkeiten und die zugeordneten Punktzahlen: Am Anfang der Zeile steht die Punktzahl für die Antwort, danach kommt ein oder mehrere Leerzeichen oder Tab-Zeichen und dann der Antwort-Text. Wenn man für die Antwort mehr als nur eine Zeile benötigt, kann man am Zeilenende einen Backslash (\) eingeben, um anzuzeigen, dass der Text an diesem Zeilenende noch nicht endet. Beispiel: Frage: 0 Nein Sinnvolle Werte für die Punktzahl sind hier entweder 0 und 1, oder -1 und +1. Aber andere ganzzahlige Punktwerte sind ebenfalls möglich, wenn es passend erscheint. (siehe auch "StandardAntwort:" und "Anfrage:") |
|
Anfrage: (multi:, query:, mcma:) |
|
definiert eine Frage mit mehreren Antwort-Möglichkeiten. Im Gegensatz zu "Frage:" kann der Endbenutzer hier mehreres auswählen. Der Aufbau entspricht dem bei dem Stichwort "Frage:" beschriebenen. Die Werte 0 und 1 sind hier jedoch nicht sinnvoll, da man ansonsten einfach alles anwählen könnte um die höchste Punktzahl zu erreichen. Man sollte also mit -1 und +1 arbeiten. Das Stichwort "StandardAntwort:" hat auf diesen Fragen-Typ keinen Einfluss. |
|
Auswertung: (assessment:) |
|
Wie ein Kommentar:-Feld, wird aber erst ganz am Ende angezeigt. Das Stichwort "Auswertung:" muss am Ende des Quizzes stehen! AKFQuiz-Interpreter zeigen diesen Kommentar erst an, nachdem die erreichte Punktzahl ausgegeben wurde. Wenn die Ausgabe HTML-Code ist (mkquiz, akfquiz.cgi) und das Stichwort Auswertungslink: verwendet wurde, dann wird diese Auswertung nicht angezeigt. So können beide Stichworte als Alternativen für verschiedene Ausgabe-Formate verwendet werden. (siehe auch "Auswertung%:") |
|
Auswertung%: (assessment%:) |
|
Der Inhalt beim Stichwort "Auswertung%:" ist ähnlich aufgebaut, wie die Antworten bei einer Frage; zuerst ein Zahlwert, dann beliebig viele Leerzeichen oder Tab-Zeichen und dann ein Text. Längere Zeilen können auch hier mit einem Backslash (\) erweitert werden. Der Zahlenwert stellt hier jedoch den Prozentwert dar, ab welchem der angegebene Text als Auswertung gilt. Achtung: Die Zahlwerte müssen in absteigender Folge angegeben werden und der letzte Eintrag muss 0 sein! Das Stichwort "Auswertung%:" muss am Ende des Quizzes stehen! Beispiel: Auswertung%: Wenn die Ausgabe HTML-Code ist (mkquiz, akfquiz.cgi) und das Stichwort Auswertungslink: verwendet wurde, dann wird diese Auswertung% nicht angezeigt. So können beide Stichworte als Alternativen für verschiedene Ausgabe-Formate verwendet werden. (siehe auch "Auswertung:") |
|
Die Web basieren Varianten von AKFQuiz erkennen viele URI Schemata automatisch wenn "HTMLcode" nicht aktiviert ist. URIs können durch Leerzeichen oder TAB Zeichen, doppelte Anführungsstriche (") oder spitze Klammern (<...>) abgegrenzt werden. Wenn die URI nicht mit einer bekannten Protokoll Bezeichnung anfängt, kann man "URI:" oder "URL:" davor setzen. Damit kann man also auch relative Adressen benutzen. Protokoll Bezeichnungen müssen klein geschrieben werden, während "URI:", bzw. "URL:" groß geschrieben werden müssen. "URN:" kann sowohl groß, als auch klein geschrieben werden. Bilder können direkt in die Webseite eingebunden werden, indem man das Stichwort "image:" davor setzt. Achtung: Die Positionierung der Bilder ist noch experimentell und kann sich in späteren Versionen noch ändern. |
|
Beispiele: |
|
http://akfquiz.nongnu.org/ Es werden noch viele weitere URIs unterstützt. Benutzen Sie "file:"-URIs nur als letzten Ausweg, wenn nichts anderes möglich ist. |
|
Auf Posix-kompatiblen Systemen kann man den das Quiz selbst zu einer
ausführbaren Datei machen, indem man folgendes in die erste Zeile
schreibt: Als MIME-Typ sollte application/x-akfquiz verwendet werden. |
|
Copyright © 2003-2006 Andreas K. Förster AKFQuiz ist Freie Software. Sie können es unter den Bedingungen der GNU General Public License, wie von der Free Software Foundation veröffentlicht, weitergeben und/oder modifizieren, entweder gemäß Version 2 der Lizenz oder (nach Ihrer Option) jeder späteren Version. Die Veröffentlichung von AKFQuiz erfolgt in der Hoffnung, dass es Ihnen von Nutzen sein wird, aber ohne irgendeine Garantie, sogar ohne die implizite Garantie der Marktreife oder der Verwendbarkeit für einen bestimmten Zweck. |
|
http://akfquiz.nongnu.org/ |
|
scrquiz(1) grquiz(1) mkquiz(1) cgiquiz(8) linequiz(1) |