moodle/mod/hotpot/README.TXT

==================================================
This is v2.4.2 of the HotPot module for Moodle 1.9
==================================================

   This module allows teachers to administer Hot Potatoes and TexToys quizzes via Moodle.
   It has been tested on:
      - Hot Potatoes 6
      - Moodle 1.9
      - PHP 4.1 thru 5.2
      - MySQL 4.x thru 5.0
      - PostgreSQL 7.3 thru 8.2

   This module may be distributed under the terms of the General Public License
   (see http://www.gnu.org/licenses/gpl.txt for details)

   This software is provided "AS IS" without a warranty of any kind.

   Sponsors who have generously contributed to the development of this software:
      - Agencia de Gestio d'Ajuts Universitaris i de Recerca (AGAUR),
        Autonomous Government of Catalonia, Spain
        (via Josep M. Fontana, Universitat Pompeu Fabra)
      - Rikkyo Univeristy, Japan (via Paul Allum)
      - Universite de Franche-Comte, France (via Glenys Hanson)


================
IMPORTANT NOTICE
================
*  Please be sure to use Hot Potatoes according to the conditions of use which are listed at the end of this file. If you restrict use via a required Moodle login, you most likely can still meet the 'freely available' condition if you make the same material on a separate URL that permits free access.  Otherwise, please purchase a license.


======================================
TO INSTALL OR UPDATE THE HOTPOT MODULE
======================================

   You should install only this module by installing a complete Moodle 1.9 package.

   Similarly, the recommended way to upgrade this module is to upgrade to a complete Moodle 1.8 package.

   However, it is possible to download and unzip a complete Moodle 1.9 package and extract the "mod/hotpot" folder for use on your live Moodle 1.8 site.

========================
TO USE THE HOTPOT MODULE
========================

1. If you haven't already done so, download and install the Hot Potatoes software from http://www.halfbakedsoftware.com onto your PC

2. Create any type of Hot Potatoes quiz on your PC using the Hot Potatoes software

3. Upload the quiz's source file (".jcl", ".jcw", ".jmt", ".jmx", ".jqz") or ".html" file from your PC to the "Files" area of a course on your Moodle site.

4. Also upload any graphics, sound files, stylesheets or javascripts that the quiz uses

5. On the main page for the Moodle course, confirm editing is turned on (click the "Turn editing on" button), then, in the section where you want to add the HotPot activity, select "Hot Potatoes Quiz" on the "Add an activity" drop-down menu .

   If "Hot Potatoes Quiz" does not appear on the "Add an activity" menu, you may need to enable the HotPot module as follows:

   a) from the site's front page select "Admin" then "Modules"
   b) click the "closed eye" icon for the "Hot Potatoes Quiz" module

   If there is no "Hot Potatoes Quiz" on the "Modules" page, you probably have not put the hotpot.php messages file in the right place. Please refer to step 2, "Install the messages and help files", of the installation procedure (see previous section)

6. The "Adding a new Hot Potatoes Quiz" page appears. Click the "Choose or Upload a file ..." button and select the desired Hot Potaotes quiz file.

7. Review the other settings for the quiz and click "Save Changes" when you are ready

8. You can view reports of the results via the "Hot Potatoes Quizzes" link on the "Activities menu". Students will see links to all the quizzes. Administrators and teachers will additionally see links to the statistical reports for each quiz.

9. You can also import the questions from the Hot Potatoes source file to the Moodle Quiz database, if you completed step 4, "enable import from Hot Potatoes XML files", of the installation procedure (see previous section)


==============================
HOT POTATOES CONDITIONS OF USE
==============================
** Reproduced from the Hot Potatoes site **

Hot Potatoes is offered free to the educational community by the University of Victoria Humanities Computing and Media Centre (formerly the Language Centre), under certain conditions. Hot Potatoes is free for use by state educational institutions which are non-profit making, on the condition that the material produced using the program is freely available to anyone via the WWW. However, you need to purchase a licence under any of the following conditions:
*  You do not work for a public sector educational establishment.
*  You charge money for access to the material you make with Hot Potatoes.
*  You restrict access to the material in some way. (The only exception here is if you have an account on www.hotpot.net, where you ARE allowed to use password restrictions.)
*  You want to use the Masher program included with the Hot Potatoes suite.

For more information on licences, and details on how to purchase one, check out our Website at:
   http://www.halfbakedsoftware.com/hotpot/

If you intend using the programs to generate more than a handful of exercises, please make sure you register. This costs you nothing -- see How to register for details.
Martin Holmes, Half-Baked Software and the University of Victoria HCMC, 1998-2004.