akfquiz(5)                                                          akfquiz(5)



NAME
       akfquiz - Dateiformat fr Quiz-Spiele, bungsaufgaben, Psycho-Tests


BESCHREIBUNG
       Die  AKFQuiz-Dateien  knnen mit einem normalen Texteditor erstellt und
       bearbeitet werden.

       AKFQuiz-Dateien knnen die Datei-Endung ".akfquiz" oder  ".aqz"  haben,
       in vielen Fllen 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 drfen 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  drfen
       eingerckt   sein   und  die  Gro-/Kleinschreibung  ist  beliebig.  Um
       Stichworte ungltig zu machen kann man eine Raute (#) davor setzen.

       Es gibt einzeilige Stichworte.  Diese  dienen  zu  Einstellungszwecken.
       Einzeilige  Stichworte  mssen  am  Anfang  der  Datei,  vor den block-
       orientierten Stichworten stehen.

       Auerdem 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.


Stichworte
       Die Stichworte in AKFQuiz-Dateien im Einzelnen:


       AKFQuiz
              Schreiben Sie den Ausdruck AKFQuiz am Beginn einer AKFQuiz-Datei
              (hinter der #! Zeile, falls Sie die verwenden).  Dahinter knnen
              Sie Informationen ber die bentigte Version schreiben.

              Falls ntig kann auch ein Varianten-Name benutzt werden:
              AKFQuiz-testing Version 3.2.0

              Achtung: Ab Version  4.1.0  oder  hher  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   knnen   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
              fr  den  Inhalt, also fr 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 Quizdatei berarbeitet haben


       Copyright:
              derjenige, der das Copyright bzw. Urheberrecht inne hat.  Dieses
              Stichwort kann alternativ zu Autor: benutzt werden. Es gibt aber
              auch Flle, wo der Autor und der  Copyright-Inhaber  verschieden
              sind. In dem Fall knnen auch beide Stichworte verwendet werden.


       Lizenz: (license:)
              unter  welcher  Lizenz  das  Quiz  steht.  Bitte   die   przise
              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


       Zeichensatz: (charset:)
              welcher Zeichensatz verwendet wird.  (Der Zeichensatz ist  nicht
              die   Schriftart!)    Die  Vorgabe  hngt  von  der  verwendeten
              Plattform ab  und  wird  auf  jeden  Fall  in  die  HTML-Ausgabe
              geschrieben.

              Untersttzt: UTF-8, ISO-8859-1, IBM850, US-ASCII

              (man  sollte  IBM850  statt  IBM437  verwenden,  um  Probleme zu
              vermeiden)


       Sprache: (language:)
              Sprache - als zweistelliges Buchstabenkrzel anzugeben, wie  sie
              in  ISO-639-1  definiert  sind.   Zum Beispiel "de" fr deutsch,
              "en"  fr  Englisch.  Es  sollte  immer  die  richtige   Sprache
              angegeben  werden, auch wenn diese von den Programmen noch nicht
              untersttzt 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).

              Untersttzte Sprachen: en, de, da, it


       rtl:   kann  man  auf "ja", "yes", "true" oder "1" setzen. Es bedeuted,
              dass die Sprache von rechts nach  links  geschrieben  wird,  zB.
              Hebrisch oder Arabisch.

              Das  wird  bisher  nur  fr die HTML-Ausgabe untersttzt.  Bitte
              schreiben Sie mir, wenn Sie mehr Untersttzung wnschen.


       Neutral:
              kann man auf "ja", "yes", "true" oder "1" setzen, was  bedeutet,
              dass die Programme neutral antworten sollen, das heit 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  erklrt, was das
              Ergebnis zu bedeuten hat. Da knnte 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 zustzlich auch das Block-
              Stichwort  Auswertung: als Alternative fr die anderen Programme
              verwenden. Nur das Stichwort Auswertung: zu verwenden  ist  auch
              in Ordnung, wenn das ausreicht.

              Fr  Fortgeschrittene:  Wenn  das  letzte  Zeichen  der  URI ein
              Fragezeichen (?) ist, werden Werte fr "points", "maxpoints" und
              "percent"  angehngt, so dass sie aus Skripten ausgelesen werden
              knnen.

              Beispiel: Auswertungslink: schulnote.html?

              Diese Beispiel-Datei  berechnet  eine  Schulnote.   Sie  benutzt
              dafr  JavaScript.  Natrlich 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.
              Achtung:  Dann sollte man auch &lt; fr <, &gt; fr >, &amp; fr
              & und &quot; fr " benutzen!  Diese "benannten  Zeichen"  werden
              auch  von  nicht-HTML-basierten AKFQuiz-Interpretern verstanden.
              Das "benannte Zeichen" &euro; wird ebenfalls untersttzt.

              Die automatische URI Erkennung (siehe unten) wird ausgeschaltet,
              wenn htmlcode aktiviert ist.


       HauptURI: (baseURI:)
              URI  fr  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 fr eigene  Quizze  verwenden,
              und auch mit verffentlichen.


       Stichworte: (keywords:)
              Stichworte  fr  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  fr  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 fr Fragen mit nur  einer  Antwort-Mglichkeit.
              Diese   Antwort   wird   immer  als  letzte  angefhrt  und  ist
              vorausgewhlt.  Dies sollte man immer verwenden,  wenn  man  fr
              falsche Antworten auch Punkt-Abzge geben will.


   Block-orientierte Stichworte:
       Kommentar: (comment:)
              fgt einen Kommentar in das Quiz ein. Der Kommentar kann mehrere
              Zeilen umfassen und wird  durch  eine  Leerzeile  abgeschlossen.
              Kommentare  knnen  am  Anfang, zwischen den Fragen oder am Ende
              eingefgt 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. Fr die interaktiven  AKFQuiz-Programme  gibt  es  keinen
              Unterschied zu "Kommentar:", aber in den HTML-Varianten wird ein
              "Hinweis:" erst auf der Auflsungs-Seite angezeigt.


       Frage: (question:, mc:)
              definiert eine Frage mit nur einer Antwort-Mglichkeit. Es  kann
              auch  mehr als nur eine Antwort richtig sein, aber nur eine kann
              ausgewhlt werden, zB. fr "was ist die beste Lsung"-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-Mglichkeiten  und die zugeordneten
              Punktzahlen: Am Anfang der Zeile steht  die  Punktzahl  fr  die
              Antwort,  danach  kommt  ein  oder mehrere Leerzeichen oder Tab-
              Zeichen und dann der Antwort-Text. Wenn man fr die Antwort mehr
              als  nur  eine  Zeile  bentigt,  kann  man  am Zeilenende einen
              Backslash (\) eingeben, um anzuzeigen, dass der Text  an  diesem
              Zeilenende noch nicht endet.

              Beispiel:

              Frage:
              Die Frage kann mehr als nur eine Zeile haben.
              Abstze sind ebenfalls mglich.
              .
              Knnen Antworten auch mehr als nur eine Zeile umfassen?

              0 Nein
              1 Ja, aber das Zeilenende muss mit einem \
                Backslash maskiert werden

              Sinnvolle  Werte  fr  die Punktzahl sind hier entweder 0 und 1,
              oder  -1  und  +1.  Aber  andere  ganzzahlige  Punktwerte   sind
              ebenfalls mglich, wenn es passend erscheint.

              (siehe auch "StandardAntwort:" und "Anfrage:")


       Anfrage: (multi:, query:, mcma:)
              definiert  eine  Frage  mit  mehreren  Antwort-Mglichkeiten. Im
              Gegensatz  zu  "Frage:"  kann  der  Endbenutzer  hier   mehreres
              auswhlen.  Der Aufbau entspricht dem bei dem Stichwort "Frage:"
              beschriebenen.  Die  Werte  0  und  1  sind  hier  jedoch  nicht
              sinnvoll,  da man ansonsten einfach alles anwhlen knnte um die
              hchste 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  knnen  beide Stichworte als
              Alternativen fr 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.
              Lngere  Zeilen  knnen  auch  hier  mit  einem  Backslash   (\)
              erweitert   werden.   Der  Zahlenwert  stellt  hier  jedoch  den
              Prozentwert dar, ab welchem der  angegebe  Text  als  Auswertung
              gilt.   Achtung:  Die  Zahlwerte  mssen  in  absteigender Folge
              angegeben werden und der letzte Eintrag muss 0 sein!

              Das Stichwort "Auswertung%:" muss am Ende des Quizzes stehen!

              Beispiel:

              Auswertung%:
              95 sehr gut
              80 gut
              65 befriedigend
              45 ausreichend
              25 mangelhaft
              0  ungengend

              Wenn die Ausgabe HTML-Code ist  (mkquiz,  akfquiz.cgi)  und  das
              Stichwort  Auswertungslink:  verwendet  wurde,  dann  wird diese
              Auswertung% nicht angezeigt.  So  knnen  beide  Stichworte  als
              Alternativen  fr verschiedene Ausgabe-Formate verwendet werden.

              (siehe auch "Auswertung:")


AUTOMATISCHE URI ERKENNUNG
       Die Web basieren Varianten von  AKFQuiz  erkennen  viele  URI  Schemata
       automatisch  wenn  "HTMLcode"  nicht  aktiviert  ist. URIs knnen durch
       Leerzeichen oder  TAB  Zeichen,  doppelte  Anfhrungsstriche  (")  oder
       spitze Klammern (<...>) abgegrenzt werden. Wenn die URI nicht mit einer
       bekannten Protokoll Bezeichnung anfngt, kann man  "URI:"  oder  "URL:"
       davor  setzen.  Damit  kann  man  also auch relative Adressen benutzen.
       Protokoll  Bezeichnungen  mssen  klein  geschrieben  werden,   whrend
       "URI:", bzw. "URL:" gro geschrieben werden mssen.  "URN:" kann sowohl
       gro, als auch klein geschrieben werden.

       Bilder knnen 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 spteren Versionen noch ndern.


   Beispiele:
       http://akfoerster.de/akfquiz/
       <http://akfoerster.de/akfquiz/>
       URI:next.html
       image:URI:next.png
       <mailto:akfquiz@akfoerster.de>
       telnet://akf@akfoerster.de/
       file://localhost/usr/share/pixmaps/myimage.png

       Es werden noch viele weitere URIs untersttzt.

       Benutzen  Sie  "file:"-URIs nur als letzten Ausweg, wenn nichts anderes
       mglich ist.



WEITERE FUNKTIONEN
       Auf Posix-kompatiblen Systemen kann man den das Quiz  selbst  zu  einer
       ausfhrbaren  Datei  machen,  indem  man  folgendes  in die erste Zeile
       schreibt:
       #! /usr/bin/env akfquiz
       Danach kann man das Ausfhrungs-Bit der Datei mit dem  Befehl  chmod(1)
       setzen.

       Als MIME-Typ sollte application/x-akfquiz verwendet werden.



LIZENZ
       Copyright  2003-2006 Andreas K. Frster
       <akfquiz@akfoerster.de>

       AKFQuiz ist Freie Software. Sie knnen es unter den Bedingungen der GNU
       General  Public  License,  wie  von  der   Free   Software   Foundation
       verffentlicht,   weitergeben  und/oder  modifizieren,  entweder  gem
       Version 2 der Lizenz oder (nach Ihrer Option) jeder spteren Version.

       Die Verffentlichung 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  fr  einen
       bestimmten Zweck.


INTERNET
       Kontakt:
              mailto:akfquiz@akfoerster.de


       Homepage:
              http://akfoerster.de/akfquiz/de


       Beispiele:
              http://akfoerster.de/akfquiz/quiz.html


       Quiz verffentlichen:
              http://akfoerster.de/akfquiz/quizupload (keine Garantie!)



SIEHE AUCH
       scrquiz(1)   grquiz(1)   diaquiz(1)  mkquiz(1)  cgiquiz(8)  linequiz(1)
       gtkquizchooser(1)




AKFQuiz                              4.2.2                          akfquiz(5)
