mkquiz(1)                                                            mkquiz(1)



NAME
       mkquiz - creates HTML file with a quiz (needs akfquiz5.js)


SYNTAX
       mkquiz [options] [quiz-files]
       mkquiz [-h|--help|/?]


DESCRIPTION
       Mkquiz creates a HTML file with a quiz from easy to write text-files.

       This  HTML files then need also the script "akfquiz5.js" as well as the
       files "leer.png", "richtig.png" and "falsch.png", and probably a  given
       CSS  file.  These  files  have  to be in the same directory as the HTML
       files, or the path may be given with the keyword baseURI:.

       The format of the input data is described in akfquiz(5).

       The filenames for the output files are deduced from  the  filenames  of
       the input files.

       If  mkquiz  is  called  without  filenames and without the option -a or
       --auto, it reads from standard input and writes to standard output.


USAGE
   OPTIONS
       -o <dir> | --out <dir>
              directory for the output files


       -a | --auto
              process all quiz-files in the current directory


       -i | --index
              write an index.html with all files processed

When you enter input files on the command-line, you may leave away the  exten-
sion ".akfquiz" or ".aqz".


   Usage of the created HTML-file:
       It  is  an HTML-file, which includes a JavaScript-file. So the usage is
       mostly dependent on the browser. On most browsers you can use the  but-
       tons  at  the  end by "clicking" with a mouse or an other device on it.
       Besides of that on most browsers you can chose the  elements  with  the
       Tab-key  and  activate  them  by  pressing  either the space-key or the
       enter-key.

       Additionally there are also key-shortcuts defined in the HTML-file

       On PCs they are as follows:

       Alt + R
          shows the Result

       Alt + S
          shows the Solution

       Alt + N
          allows you to enter anything New


       These shortcuts are only available with newer browsers.


   Printing:
       To print a quiz on a printer, please use the HTML-file, not the  input-
       file.  The  HTML-file and the CSS-files contain special code for print-
       ing. So it's not simply the same as what you see on the screen.

       If you want to print a page with the solution, then  press  the  button
       Solution in the browser and print it again.


DIAGNOSTICS
   If it encounters errors:
       The  program  mkquiz should even then always produce correct HTML code.
       Error messages are written into the code. So you can  easily  find  the
       position of the errors, by looking at the result with a browser.

       If the program cannot interpret the input data at all, it outputs noth-
       ing, or it creates an empty file.

       The HTML code, that's produced by the program, should  always  be  for-
       mally  correct,  unless you use the keyword "htmlcode:". If you use it,
       you're responsive for it yourself.


   Additional information:
       The HTML code contains some additional information,  which  you  cannot
       see with the browser.  The code contains the language as given with the
       keyword "language:".  This also has technical relevancy, so don't  sim-
       ply skip this keyword.  Besides of that, the author is stored in a way,
       that it can be easily found by software programs (for  example  search-
       engines). Also the name of the software which created the file and ver-
       sion is stored.


BUGS
       The JavaScript akfquiz5.js shows no graphic for "multi:"-questions.


FILES
       The following files must be in the same directory as the created  HTML-
       file:


       akfquiz5.js
              JavaScript-file - needed by the HTML-file


       leer.png, richtig.png, falsch.png
              needed graphic-files


       If  you  mentioned a CSS-file in the AKFQuiz-file, it also has to be in
       the same directory. It might be, that this CSS-file again  needs  other
       files.


LICENSE
       Copyright  2003-2006 Andreas K. Foerster
       <akfquiz@akfoerster.de>

       AKFQuiz  is  free  software;  you  can redistribute it and/or modify it
       under the terms of the GNU General Public License as published  by  the
       Free  Software Foundation; either version 2 of the License, or (at your
       option) any later version.

       AKFQuiz is distributed in the hope that it will be useful, but  WITHOUT
       ANY  WARRANTY;  without even the implied warranty of MERCHANTABILITY or
       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General  Public  License
       for more details.



INTERNET
       contact:
              mailto:akfquiz@akfoerster.de


       homepage:
              http://akfoerster.de/akfquiz/


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


       publish quiz:
              http://akfoerster.de/akfquiz/quizupload (no guaranty!)



SEE ALSO
       akfquiz(5) scrquiz(1) grquiz(1) diaquiz(1) cgiquiz(8) linequiz(1)



AKFQuiz                              4.2.0                           mkquiz(1)
