mod/hotpot/README.TXT

   1 ===============================================
   2 This is v2.1.20 of the HotPot module for Moodle
   3 ===============================================
   4
   5    This module allows teachers to administer Hot Potatoes and TexToys quizzes via Moodle.
   6    It has been tested on:
   7       - Hot Potatoes 6
   8       - Moodle 1.1 thru 1.6
   9       - PHP 4.1 thru 5.1.2
  10       - MySQL and PostgreSQL databases
  11
  12    This module may be distributed under the terms of the General Public License
  13    (see http://www.gnu.org/licenses/gpl.txt for details)
  14
  15    This software is provided "AS IS" without a warranty of any kind.
  16
  17    Sponsors who have generously contributed to the development of this software:
  18       - Agencia de Gestio d'Ajuts Universitaris i de Recerca (AGAUR),
  19         Autonomous Government of Catalonia, Spain
  20         (via Josep M. Fontana, Universitat Pompeu Fabra)
  21       - Rikkyo Univeristy, Japan (via Paul Allum)
  22       - Universite de Franche-Comte, France (via Glenys Hanson)
  23
  24
  25 ================
  26 IMPORTANT NOTICE
  27 ================
  28 *  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.
  29
  30
  31 ======================================
  32 TO INSTALL OR UPDATE THE HOTPOT MODULE
  33 ======================================
  34
  35 1. Install the core scripts of the hotpot module
  36
  37    (a) download http://download.moodle.org/download.php/modules/hotpot.zip
  38        to the "mod" folder on your Moodle site
  39    (b) remove the current "mod/hotpot" folder, if there is one (Unix: rm -fR hotpot)
  40    (c) unzip the zip file so it creates a new "mod/hotpot" folder
  41
  42 2. Install the messages and help files of the hotpot module
  43
  44    On Moodle 1.5 and earlier:
  45    (a) download http://moodle.cvs.sourceforge.net/moodle/moodle/lang/en_utf8/hotpot.php
  46        to "lang/en/hotpot.php" on your Moodle site
  47    (b) download the files in http://moodle.cvs.sourceforge.net/moodle/moodle/lang/en_utf8/help/hotpot/
  48        into "lang/en/help/hotpot/" on your Moodle site
  49
  50    On Moodle 1.6 and later:
  51    (a) locate the "lang" folder on your Moodle site.
  52        Note: the default location for the "lang" folder is in the "$CFG->dataroot" directory defined in the config.php file for your Moodle site
  53    (b) download http://moodle.cvs.sourceforge.net/moodle/moodle/lang/en_utf8/hotpot.php
  54        to "lang/en_utf8/hotpot.php" on your Moodle site
  55    (c) download the files in http://moodle.cvs.sourceforge.net/moodle/moodle/lang/en_utf8/help/hotpot/
  56        into "lang/en_utf8/help/hotpot/" on your Moodle site
  57
  58 3. copy and set up the file icons
  59    [This step is not required for Moodle 1.5 and later, and is optional for Moodle 1.1 to 1.4]
  60
  61    (a) copy the hotpot icons (jcb.gif, jcl.gif, jcw.gif, jmt.gif, jmx.gif, jqz.gif)
  62        from http://moodle.cvs.sourceforge.net/moodle/moodle/pix/f/
  63        to "pix/f" on your Moodle site
  64    (b) open the "files/mimetypes.php" file on your Moodle site with a text editor
  65    (c) insert the following lines just AFTER the line which reads "$mimeinfo = array (":
  66        // additional mimetypes for the "hotpot" module
  67        "jcb"  => array ("type"=>"text/xml", "icon"=>"jcb.gif"),
  68        "jcl"  => array ("type"=>"text/xml", "icon"=>"jcl.gif"),
  69        "jcw"  => array ("type"=>"text/xml", "icon"=>"jcw.gif"),
  70        "jmt"  => array ("type"=>"text/xml", "icon"=>"jmt.gif"),
  71        "jmx"  => array ("type"=>"text/xml", "icon"=>"jmx.gif"),
  72        "jqz"  => array ("type"=>"text/xml", "icon"=>"jqz.gif"),
  73        "rhb"  => array ("type"=>"text/xml", "icon"=>"xml.gif"),
  74        "sqt"  => array ("type"=>"text/xml", "icon"=>"xml.gif"),
  75    (d) save the changes and close the file
  76
  77 4. enable import from Hot Potatoes XML files to Moodle's Quiz module
  78    [This step is not required for Moodle 1.5 and later, and is optional for Moodle 1.1 to 1.4]
  79
  80    (a) if necessary, create a folder at "mod/quiz/format/hotpot" on your Moodle site
  81    (b) download http://moodle.cvs.sourceforge.net/moodle/moodle/question/format/hotpot/format.php
  82        to "mod/hotpot/quiz/format/hotpot/format.php" on your Moodle site
  83
  84    (c) open the "lang/en/quiz.php" file on your Moodle site with a text editor
  85    (d) insert the following line just BEFORE the final line which reads "?>":
  86         $string['hotpot'] = 'Hot Potatoes XML format';
  87    (e) save the changes and close the file
  88
  89    Steps (f), (g) and (h) are only required on Moodle 1.4.5
  90    (f) open the "mod/quiz/import.php" file on your Moodle site with a text editor
  91    (g) if necessary, add 'hotpot' to the "fileformats" array on lines 9-10:
  92         $fileformats = array('aiken','aon','blackboard','coursetestmanager',
  93           'gift','learnwise','missingword','webct','xml','hotpot' );
  94    (h) save the changes and close the file
  95
  96 5. Login to your Moodle site as an administrator
  97
  98    a) If you are installing this module for the first time, you should see a report saying that the following (prefix)_hotpot tables have been successfuly created:
  99       hotpot
 100       hotpot_attempts
 101       hotpot_details
 102       hotpot_questions
 103       hotpot_responses
 104       hotpot_strings
 105
 106    b) If you are updating the module, you will probably see messages indicating the progress of the update
 107
 108    c) If you get error messages, please copy and save them to a file on your PC, and then ask for help on Moodle's HotPot support forum:
 109       go to http://moodle.org
 110       then click "Free Support",
 111       then click "HotPot"
 112
 113
 114 ========================
 115 TO USE THE HOTPOT MODULE
 116 ========================
 117
 118 1. If you haven't already done so, download and install the Hot Potatoes software from http://www.halfbakedsoftware.com onto your PC
 119
 120 2. Create any type of Hot Potatoes quiz on your PC using the Hot Potatoes software
 121
 122 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.
 123
 124 4. Also upload any graphics, sound files, stylesheets or javascripts that the quiz uses
 125
 126 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 .
 127
 128    If "Hot Potatoes Quiz" does not appear on the "Add an activity" menu, you may need to enable the HotPot module as follows:
 129
 130    a) from the site's front page select "Admin" then "Modules"
 131    b) click the "closed eye" icon for the "Hot Potatoes Quiz" module
 132
 133    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)
 134
 135 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.
 136
 137 7. Review the other settings for the quiz and click "Save Changes" when you are ready
 138
 139 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.
 140
 141 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)
 142
 143
 144 ==============================
 145 HOT POTATOES CONDITIONS OF USE
 146 ==============================
 147 ** Reproduced from the Hot Potatoes site **
 148
 149 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:
 150 *  You do not work for a public sector educational establishment.
 151 *  You charge money for access to the material you make with Hot Potatoes.
 152 *  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.)
 153 *  You want to use the Masher program included with the Hot Potatoes suite.
 154
 155 For more information on licences, and details on how to purchase one, check out our Website at:
 156    http://www.halfbakedsoftware.com/hotpot/
 157
 158 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.
 159 Martin Holmes, Half-Baked Software and the University of Victoria HCMC, 1998-2004.