--------------------------------------------------------------------------------------------------------
 WebsiteBaker Module Name: QUIZ, Release v0.01
--------------------------------------------------------------------------------------------------------

  Module developed for the Open Source Content Management System WebsiteBaker (http://websitebaker.org)

  Copyright (C) 2012, Andreas Schmidt
  Contact me: webmaster(at)hillschmidt.de, http://www.hillschmidt.de
  It bases on a script developed by Werner Zenk, Homepage: www.homepage-total.de,
  eMail: webmaster@homepage-total.de and his Quiz - Version: 12.11.2009.

  LICENCE TERMS / LIZENZBESTIMMUNGEN:
  This module is free software. You can redistribute it and/or modify it
  under the terms of the GNU General Public License  - version 2 or later,
  as published by the Free Software Foundation: http://www.gnu.org/licenses/gpl.html.

  DISCLAIMER / HAFTUNGSAUSSCHLUSS:
  This module 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.

--------------------------------------------------------------------------------------------------------
DESCRIPTION

This page module allows you to create quizzes or tests within your site.
At the end, an entry into a »Hall of Fame« will be possible if a specific success rate is reached.

--------------------------------------------------------------------------------------------------------
REQUIREMENTS

This module has been tested on Website Baker 2.8.x but may work also with earlier releases.

To edit the file directly from the backend, which makes the test, you need to change
line 80 (WB v2.8.2) in /modules/edit_module_files.php
from
    $css_file = (in_array($_edit_file, array('frontend.css', 'backend.css'))) ? $_edit_file : '';
to
    $css_file = (in_array($_edit_file, array('frontend.css', 'backend.css'))) ? $_edit_file : $_edit_file;
This is NOT really RECOMMENDED but maybe useful.

To include images per question you need to install the droplet Image; see
http://www.websitebakers.com/pages/droplets/official-library/images/image.php
In the backend, you can then use for example the code
    [[image?image=/quiz/evangelium.jpg&alt=Evangelium]]
in the greyed field, where the path to the image is relative to the /media/ directory of your
WebsiteBaker installation directory.

--------------------------------------------------------------------------------------------------------
RESTRICTION

You CANNOT add more than one quiz per page!!!

--------------------------------------------------------------------------------------------------------
INSTALLATION

1. Download the latest version from
   http://www.hillschmidt.de/wb/pages/internet/websitebaker-modul-quiz/download-wb-module-quiz.php
2. Log into your WebsiteBaker installation.
3. Go to Addons -> Modules
4. In the »Install Module« section, enter the path to the quiz_vx.yy zip file that you downloaded
   in step 1, and choose the »Install« button.
5. If this is the first installation of this module it will be added as additional page module.
6. If a previous version of »Quiz Module« is already installed, it will be updated automatically
   if the downloaded file contains a different version.
   Otherwise you will see an error (WebsiteBaker standard installation routine).

The module's installation zip file includes the following files, which will be added into
a (new) /modules/ subdirectory named quiz/ of your WebsiteBaker's installation directory:
  add.php
  backend.css
  backend.js
  delete.php
  frontend.css
  frontend.js
  halloffame.php
  index.php
  info.php
  install.php
  modify.php
  README.TXT
  save.php
  uninstall.php
  view.php
  data\index.php
  languages\DE.php
  languages\EN.php
  languages\index.php

--------------------------------------------------------------------------------------------------------
DESCRIPTION FOR USING QUIZ

Login into your backend. Create a new page with type »Quiz Module«.

You will see a new form, where you have to specify:
- the titel of the test or quiz which will be shown in the frontend,
- whether the correct answers will be shown during the quiz (default: NO),
- the required success rate as percentage between 0 and 100 when an entry into the Hall Of Fame
  will be made available,
- OPTIONAL: insert a picture per question
  (droplet »image« has to be installed before; see section REQUIREMENTS),
- the (1st) question,
- up to six possible answers (minimum is 2),
- one answer must be marked as correct answer,
- a check of the field »eliminate« will clear the question and answers in the marked section
  WITHOUT RETURN!,
- a click in »Save with a new question« will create a new empty question section when you finally
- click on the »Save« button. This will save the question(s) and return to the same quiz for further
  actions, like inserting a new question having saved with the new question option.
- This process can be repeated as often as you want to add additional questions or
  edit existing answers.

Other settings of this page can be done as usual in WB.

--------------------------------------------------------------------------------------------------------
COMMON QUESTIONS / FAQ

Q:
A:

--------------------------------------------------------------------------------------------------------
FUTURE DEVELOPMENT PLANS

- edit the Hall Of Fame file directly.
- instead of Hall Of Fame, open a (eMail) form to send the result to someone.

--------------------------------------------------------------------------------------------------------