[system] / trunk / wwmoodle / documentation.txt Repository:
ViewVC logotype

View of /trunk/wwmoodle/documentation.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4215 - (download) (annotate)
Tue Jul 11 02:53:40 2006 UTC (13 years, 7 months ago) by gage
File size: 8451 byte(s)
Modifications so that license and documentation now apply to wwassignment rather wwmoodle
(wwassignment is based on wwmoodle).

    1 wwassignment
    2 
    3 The WeBWorK/Moodle Bridge
    4 
    5 Michael Gage <gage@math.rochester.edu> (based on wwmoodle by Peter Snoblin <pas@truman.edu>)
    6 
    7 
    8 
    9 Copyright (c) 2006 Michael Gage,  Copyright (c) 2005 Peter Snoblin
   10 
   11 This work is licensed under the Creative Commons Attribution 2.5 License. To
   12 view a copy of this license, visit http://creativecommons.org/licenses/by/2.5/
   13 or send a letter to Creative Commons, 543 Howard Street, 5th Floor, San
   14 Francisco, California, 94105, USA.
   15 
   16 -------------------------------------------------------------------------------
   17 
   18 
   19 
   20 Introduction
   21 
   22 wwassign is a set of software that enables the bridging of Moodle and 
   23 WeBWorK 2.2.2 and higher.
   24 The goal of this bridge is to allow a WeBWorK homework set to appear
   25 as an assignment within Moodle.  The WeBWorK courses uses Moodle's list of users
   26 to authenticate the user and to determine whether they are enrolled in the course.
   27 Moodle  also queries the WeBWorK database to determine each student's score
   28 for the problem set and places the score in Moodle's gradebook.  
   29 
   30 As of this writing the instructor needs to set up the homeworkset in WeBWorK,
   31 assign it to students with in WeBWorK, and then on the Moodle side add the assignment
   32 to the list of assignments for that week.  There are links that make it easier
   33 for the instructor to move back and forth between Moodle and WeBWorK easily.
   34 
   35 (There are plans for automating some of this work, but they are not implemented in this version.)
   36 
   37 
   38 Assumptions
   39 
   40 Throughout this document I will make several assumptions:
   41 
   42   * WeBWorK is installed at /opt/webwork2.
   43 
   44   * Moodle is installed at /var/www/moodle.
   45 
   46 You are, of course, free to use different locations, however you should be
   47 careful to adapt the instructions herein to your setup.
   48 
   49 Additionally, if you are using the MySQL database server, I assume that you are
   50 using version 4.1 or newer.
   51 
   52 Chapter 2. Installing WeBWorK
   53 
   54 The documents for installation are at: http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/InstallationManualV2pt2
   55 
   56 Instructions for downloading WeBWorK from CVS are at:
   57 
   58 http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/WeBWorKCVSReadOnly
   59 
   60 (This is recommended since it makes the update procedure very easy.)
   61 
   62 The main page http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/WebHome
   63 has a link for the current release.  Moodle bridging works for WeBWorK 2.2.2 and higher.
   64 
   65 
   66  Chapter 3. Configuring Moodle:
   67  
   68  Within Moodle ensure that you have configured session data to be stored in
   69     the database.
   70 
   71      a. Log in to Moodle as an administrator and select the "Configuration"
   72         option.
   73 
   74      b. Scroll down to the "Operating System" section and find the "dbsession"
   75         option.
   76 
   77      c. Ensure it is set to "Yes".
   78 
   79 At this point any course set to use "sql_moodle" as it's database schema will
   80 get it's user list and access rights from the Moodle course with the same short
   81 name (eg: CS435) as the WeBWorK course.
   82 
   83 
   84 Chapter 4. Adding wwassignment to Moodle Modules
   85 
   86 It is time to install the wwassignment Moodle
   87 module. 
   88 
   89  1. From the wwmoodle directory copy the folder wwassignment to /var/www/
   90     moodle/mod/.
   91 
   92     cp -r wwassignment/ /var/www/moodle/mod/
   93 
   94  2. Move the file /var/www/moodle/mod/wwassignment/lang.php to /var/www/moodle/lang
   95     /en/wwassignment.php 
   96     
   97     or if you are using the new utf8 character set, copy to the folder 
   98     /var/www/moodle/lang/en_utf8/wwassignment.php
   99 
  100     mv /var/www/moodle/mod/wwassignment/lang.php /var/www/moodle/lang/en/wwassignment.php
  101 
  102  3. Move the folder /var/www/moodle/mod/wwassignment/help to /var/www/moodle/lang/
  103     en/help/wwassignment.
  104 
  105     mv /var/www/moodle/mod/wwassignment/help/ /var/www/moodle/lang/en/help/wwassignment
  106 
  107  4. Log in to Moodle as an administrative user and go to the "Admin..."
  108     section. The  new modules should be set up automatically.
  109 
  110  8. Go to Moodle's module configuration page and configure "WeBWorK Problem Set".
  111 
  112 With that you are now ready to use WeBWorK from within your Moodle courses.
  113 
  114 Do please note that at this time, there are no alternate language to English
  115 for wwmoodle. However, if you would like to translate it, feel free to send me
  116 your translations and I will include them in future releases. (gage@math.rochester.edu)
  117 
  118 
  119 Chapter 5. Creating a WeBWorK course for use with Moodle
  120 
  121 
  122 Create the companion course in WeBWorK using the "Course Administration" page.
  123 (the url will be something like: http://webwork.math.rochester.edu/webwork2/admin )
  124 You need to be a WeBWorK administrator (i.e. a member of the WeBWorK admin course) in
  125 order to create a WeBWorK course.
  126 
  127 When creating the WeBWorK course, its name must be the same as the "shortname" of 
  128 the companion Moodle course.  In Moodle a course is given a shortname such as MTH165
  129 and a longer one such as "Linear Algebra".  The WeBWorK companion course must be
  130 created with the name MTH165 (the name is case sensitive).
  131 
  132 When asked for the datbase layout choose "sql_moodle".  This is the only requirement
  133 for making the course compatible with Moodle.  At this point WeBWorK will 
  134 use Moodle to enumerate users and determine what
  135 access rights they have. 
  136 
  137 (You should make sure that you are 
  138 a teacher of the Moodle MTH165 course or you may not be able to edit
  139 the WeBWorK MTH165 course.)
  140 
  141 The next step on the WeBWorK side is to login to the WeBWorK MTH165 course 
  142 (there is a link from the  course administration page). Choose the 
  143 Course Configuration link, and from the choices
  144 presented choose the "moodle" template for the course.  While not essential, 
  145 this adjuststhe WeBWorK HTML display so that it looks good inside the Moodle 
  146 frame. (Thanks to Davide Cervone for developing this.)
  147 
  148 Finally build a homework set in WeBWorK -- this can be done from the "Homework Sets Editor"
  149 page in WeBWorK-- choose to import the "set0" or the "Orientation to WeBWorK" set which 
  150 is present in most webowrk installations. Assign this homework set to all
  151 currently enrolled students.
  152 
  153 
  154 Chapter 6. Adding a webwork problem set to a course.
  155  1. Log in to Moodle as a teacher of the course which you wish to use with
  156     WeBWorK.
  157 
  158 
  159  2. Go to the home page for that course and "Turn editing on".
  160 
  161  3. In the weekly outline find the week where you'd like the homeworkset to appear
  162    and from the drop-down box entitled
  163     "Add an activity...". select "WebWorK Problem Set" from this box.
  164 
  165  4. Fill out the form presented to you.
  166 
  167       * You may have only one choice for the problem set (set0).  The pop-up
  168         menu shows which problem sets have been created within WeBWorK and are 
  169         available to be assigned.
  170 
  171       * To build more problem sets you can return to WeBWorK (there is a link).
  172 
  173 
  174  5. As your students complete the assigned set you will be able to view their
  175 	grades from within Moodle with the normal "Grades" tool.
  176 	
  177 Chapter 7. Some cautions: non-features (or at least not-yet-features)
  178 
  179 From the instructor's point of view the intergration of WeBWorK and Moodle is not yet
  180 complete. Certain actions have to be done on the WeBWorK side and others on the Moodle
  181 side -- a few have to be done on both.
  182 
  183 1.	If new students are added to the Moodle course, homework sets will NOT be automatically
  184 	created for these new students.  To create the problem sets for new users you 
  185 	go to the WeBWorK course, Homework Sets Editor page 
  186 	and in the homework sets row click on the column labeled "Edit Assigned Users".
  187 	Clicking the "Assign to all Current Users" button will assign homework sets to the 
  188 	new students without disturbing any of the homework sets already assigned.
  189 	
  190 	This process an be annoying if students are allowed to self-register, but it is manageable.
  191 	
  192 2.  The due dates for homework sets must be assigned in WeBWorK (the "Homework Sets Editor page), 
  193     however the listing in Moodle of "WeBWorK Problem Sets" will list all of the homework sets
  194     with correct, up-to-the-minute due dates since it gets its information from the WeBWorK database.
  195     
  196     If you change a homework set due date for one individual this will not be published in 
  197     Moodle, but will appear on the summary page of the WeBWorK homework set (in the 
  198     upper right hand information section.)
  199     
  200 Many thanks to Peter Snoblin for creating wwmoodle upon which this Moodle module is based and to 
  201 Sam Hathaway for adding the subclasses to WeBWorK that facilitate this intergration. Thanks to 
  202 Davide Cervone for the moodle template.
  203 
  204 Take care,
  205 Mike Gage

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9