cgiquiz

NAME

cgiquiz − CGI program for using AKFQuiz-files

This manpage is under construction!

Command line:

cgiquiz [--help|-h|/?]
cgiquiz --version

Browser:

http://example.org/cgi-bin/cgiquiz?--help
http://example.org/cgi-bin/cgiquiz?--version
http://example.org/cgi-bin/cgiquiz/quizpath/
http://example.org/cgi-bin/cgiquiz/quizpath/quizfile.akfquiz
http://example.org/cgi-bin/cgiquiz/quizpath/quizfile.akfquiz?q1=2&q2=1&q5=2

cgiquiz lets you use a quiz from an easy to write text-file. There is also an exam-mode, which can be used for real exams.

The documentation for cgiquiz is not completed yet. If you have questions, have a look at the Internet site first (see below). If you don’t find the answer there, feel free to contact the author directly.

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

See the file INSTALL for instructions

The URI is constructed by the path to the CGI-executable plus the relative path to the quizfile. So, if you can access the CGI program by
http://example.org/cgi-bin/cgiquiz
and the quizfile by
http://example.org/quizpath/quizfile.akfquiz
then you can put it together like this:
http://example.org/cgi-bin/cgiquiz/quizpath/quizfile.akfquiz

Users may have their quiz-files in their "public-html" directory. The URI then looks something like this:
http://example.org/cgi-bin/cgiquiz/~user/quizfile.akfquiz

If you append the term /exam/, the program switches into a special exam-mode. The files for the exam-mode are located in a special directory (which is not exported by the webserver). To find out, which the exam-directory is, use the parameter --help.

[...]

Additionally there are also key-shortcuts defined

On PCs they are as follows:

Alt + R

shows the Result

Alt + N

allows you to enter anything New

These shortcuts are only available with newer browsers.

automatic indexer

The program also includes an automatic indexer. That is not very flexible and puts a heavy load on the server. So you should avoid using it whenever possible. If you have a fixed set of quiz-files, write your own index.

The indexer is called when the URI ends up with a "/".
For example:
http://example.org/cgi-bin/cgiquiz/quizpath/
or
http://example.org/cgi-bin/cgiquiz/~user/

If it encounters errors:

The program 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 nothing, or it creates an empty file.

The HTML code that’s produced by the program, should always be formally 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 simply 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 version is stored and a link to the homepage.

Some limitations of the program are intentionally there for security-reasons:

The CGI program doesn’t allow using "/.." in the quizpath and the automatic indexer doesn’t show any subdirectories.

The environment variable QUIZPATH as used by the other parts of AKFQuiz has no influence on the CGI program.

This program doesn’t execute any external programs.

Copyright © 2005-2006 Andreas K. Foerster

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.

http://akfquiz.nongnu.org/

akfquiz(5) mkquiz(1) scrquiz(1) grquiz(1) linequiz(1)