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

View of /trunk/wwmoodle/documentation.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4133 - (download) (annotate)
Sat Jun 17 21:45:25 2006 UTC (13 years, 8 months ago) by sh002i
File size: 9096 byte(s)
Imported from beta 4

    1 wwmoodle
    2 
    3 The WeBWorK/Moodle Bridge
    4 
    5 Peter Snoblin
    6 
    7 <pas@truman.edu>
    8 
    9 Copyright ? 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 Table of Contents
   19 
   20 1. Introduction and Assumptions
   21 
   22     Introduction
   23     Assumptions
   24 
   25 2. Installing WeBWorK
   26 3. Configuring WeBWorK
   27 4. Moodle Modules
   28 5. Using wwmoodle
   29 
   30 Chapter 1. Introduction and Assumptions
   31 
   32 Table of Contents
   33 
   34 Introduction
   35 Assumptions
   36 
   37 Introduction
   38 
   39 wwmoodle is a set of software that enables the bridging of Moodle and WeBWorK.
   40 The goal of this bridge is to eliminate as much of the overlap between Moodle
   41 and WeBWorK's models. The particular focus is on establishing an unified store
   42 of information about users, courses, and the rights of those users with respect
   43 to each course. Given that this package was developed in an environment with an
   44 existing Moodle server, but no WeBWorK server, Moodle is considered to be the
   45 authoritative source for all of this information. Additionally, given the
   46 nature of how courses are defined within WeBWorK (as a combination of both
   47 database tables and file system objects) there is neither an immediate nor
   48 one-to-one mapping of courses between WeBWorK and Moodle. Instead, there is a
   49 Moodle module that ensures that a WeBWorK course exists for any Moodle course
   50 it is added to.
   51 
   52 Assumptions
   53 
   54 Throughout this document I will make several assumptions:
   55 
   56   * WeBWorK is installed at /opt/webwork2.
   57 
   58   * Moodle is installed at /var/www/moodle.
   59 
   60 You are, of course, free to use different locations, however you should be
   61 careful to adapt the instructions herein to your setup.
   62 
   63 Additionally, if you are using the MySQL database server, I assume that you are
   64 using version 4.1 or newer.
   65 
   66 Chapter 2. Installing WeBWorK
   67 
   68 This section details how to install WeBWorK itself, as well as configure it for
   69 use with Moodle. If you already have WeBWorK installed, you want Chapter 3,
   70 Configuring WeBWorK.
   71 
   72  1. Download the WeBWorK and PG tarballs from the SourceForge website: http://
   73     sourceforge.net/projects/openwebwork.
   74 
   75  2. Follow the installation instructions on the WeBWorK Wiki through the step
   76     on "Configuring Apache," being sure to follow the instructions for using
   77     the sql_single database schema: http://devel.webwork.rochester.edu/twiki/
   78     bin/view/Webwork/InstallationManualV2pt1.
   79 
   80      a. When you create database users for webwork, ensure that these users
   81         also have the same permission sets on your Moodle database.
   82 
   83      b. When modifying database.conf as per the instructions, use the
   84         database.conf file that comes with wwmoodle rather than the one from
   85         WeBWorK. (It is at WeBWorK/conf/database.conf in the wwmoodle tarball.)
   86         Be sure to set $sqlMoodleSource to an appropriate value, in addition to
   87         the items mentioned by WeBWorK installation manual.
   88 
   89  3. Create the administrative "course" by following the instructions from the
   90     WeBWorK Wiki: http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/
   91     CourseAdministrationManual#The_admin_course.
   92 
   93 Chapter 3. Configuring WeBWorK
   94 
   95 Once you have a working installation of WeBWorK you will need to configure it
   96 to use Moodle for user authentication and access control.
   97 
   98  1. From the wwmoodle tarball copy the folder WeBWorK/lib/DB/Schema/Moodle to /
   99     opt/webwork2/lib/WeBWorK/DB/Schema.
  100 
  101     cp -r WeBWorK/lib/DB/Schema/Moodle /opt/webwork2/lib/WeBWorK/DB/Schema/
  102 
  103  2. Edit /opt/webwork2/conf/database.conf to include the section from the
  104     wwmoodle tarball file WorK/conf/database.conf starting at line 325. NOTE:
  105     You don't have to do this if you followed the instructions from Chapter 2,
  106     Installing WeBWorK.
  107 
  108       * Be sure to set $sqlMoodleSource to an appropriate value.
  109 
  110  3. IF you want all courses created with WeBWorK's tools to use Moodle by
  111     default, edit /opt/webwork2/conf/global.conf so that $dbLayoutName (found
  112     around line 333) has the value "sql_moodle".
  113 
  114 At this point WeBWorK will use Moodle to enumerate users and determine what
  115 access rights they have. However, users will still have to log in to WeBWorK
  116 even if they are already logged in to Moodle. If you want to remove this
  117 restriction follow these steps:
  118 
  119  1. From the wwmoodle tarball, copy the file WeBWorK/lib/Authen.pm to /opt/
  120     webwork2/lib/WeBWorK.
  121 
  122     cp WeBWorK/lib/Authen.pm /opt/webwork2/lib/WeBWorK/
  123 
  124  2. From the wwmoodle tarball, copy the file WeBWorK/lib/DB.pm to /opt/webwork2
  125     /lib/WeBWorK.
  126 
  127     cp WeBWorK/lib/DB.pm /opt/webwork2/lib/WeBWorK/
  128 
  129  3. Ensure that you have the PHP::Serialization Perl module installed.
  130 
  131       * To check if you already have it, execute the following command at a
  132         shell prompt:
  133 
  134         perl -MPHP::Serialization -e 'print "installed.\n";'
  135 
  136       * If that command gave you an error message, you can install the module
  137         from CPAN as follows:
  138 
  139         perl -MCPAN -e "install PHP::Serialization"
  140 
  141  4. Within Moodle ensure that you have configured session data to be stored in
  142     the database.
  143 
  144      a. Log in to Moodle as an administrator and select the "Configuration"
  145         option.
  146 
  147      b. Scroll down to the "Operating System" section and find the "dbsession"
  148         option.
  149 
  150      c. Ensure it is set to "Yes".
  151 
  152 At this point any course set to use "sql_moodle" as it's database schema will
  153 get it's user list and access rights from the Moodle course with the same short
  154 name (eg: CS435) as the WeBWorK course.
  155 
  156 You must now also decide if you want all Moodle administrators to be WeBWorK
  157 admins. If so, edit the file /opt/webwork2/courses/admin/course.conf and change
  158 the value of $dbLayoutName (around line 35) to "sql_moodle".
  159 
  160 Chapter 4. Moodle Modules
  161 
  162 Once you have WeBWorK itself setup, it is time to install the two Moodle
  163 modules. The first of these handles synchronization of Moodle courses and
  164 WeBWorK courses, while the second allows teachers to assign WeBWorK sets from
  165 within Moodle.
  166 
  167  1. From the wwmoodle tarball, copy the folder Moodle/wwmoodle to /var/www/
  168     moodle/mod/.
  169 
  170     cp -r Moodle/wwmoodle/ /var/www/moodle/mod/
  171 
  172  2. Move the file /var/www/moodle/mod/wwmoodle/lang.php to /var/www/moodle/lang
  173     /en/wwmoodle.php.
  174 
  175     mv /var/www/moodle/mod/wwmoodle/lang.php /var/www/moodle/lang/en/wwmoodle.php
  176 
  177  3. Move the folder /var/www/moodle/mod/wwmoodle/help to /var/www/moodle/lang/
  178     en/help/wwmoodle.
  179 
  180     mv /var/www/moodle/mod/wwmoodle/help/ /var/www/moodle/lang/en/help/wwmoodle
  181 
  182  4. From the wwmoodle tarball, copy the folder Moodle/wwmoodle_set to /var/www/
  183     moodle/mod.
  184 
  185     cp -r Moodle/wwmoodle_set/ /var/www/moodle/mod/
  186 
  187  5. Move the file /var/www/moodle/mod/wwmoodle_set/lang.php to /var/www/moodle/
  188     lang/en/wwmoodle_set.php.
  189 
  190     mv /var/www/moodle/mod/moodle_set/lang.php /var/www/moodle/lang/en/wwmoodle_set.php
  191 
  192  6. Move the folder /var/www/moodle/mod/wwmoodle_set/help to /var/www/moodle/
  193     lang/en/help/wwmoodle_set.
  194 
  195     mv /var/www/moodle/mod/wwmoodle_set/help/ /var/www/moodle/lang/en/help/wwmoodle_set
  196 
  197  7. Log in to Moodle as an administrative user and go to the "Admin..."
  198     section. The two new modules should be set up automatically.
  199 
  200  8. Go to Moodle's module configuration page and configure "WeBWorK/Moodle
  201     Bridge" and "WeBWorK Problem Set".
  202 
  203 With that you are now ready to use WeBWorK from within your Moodle courses.
  204 
  205 Do please note that at this time, there are no alternate language to English
  206 for wwmoodle. However, if you would like to translate it, feel free to send me
  207 your translations and I will include them in future releases.
  208 
  209 Chapter 5. Using wwmoodle
  210 
  211 Once you have wwmoodle fully installed you will, no doubt, want to use it in
  212 your courses. Doing so is fairly simple:
  213 
  214  1. Log in to Moodle as a teacher of the course which you wish to use with
  215     WeBWorK.
  216 
  217  2. Go to the home page for that course and "Turn editing on".
  218 
  219  3. Under the "Weekly Outline" heading there should be a drop-down box entitled
  220     "Add an activity...". Select "WeBWorK/Moodle Bridge" from this box.
  221 
  222  4. Fill out the form presented to you.
  223 
  224       * The name of the bridge doesn't matter much, though you should use
  225         something that makes sense.
  226 
  227       * It is suggested that you choose to hide the bridge from students, as it
  228         will never contain any content.
  229 
  230 Once you have added the bridge you may now add homework sets from WeBWorK:
  231 
  232  1. Before you can assign a set, you must first create one via WeBWorK. This
  233     process is beyond the scope of this document.
  234 
  235  2. After logging in to Moodle and ensuring you "Turn editing on", find the
  236     week where you would like the set to be.
  237 
  238  3. From the "Add an activity..." drop-down box select "WeBWorK Problem Set".
  239 
  240  4. Fill out the form presented to you.
  241 
  242 As your students complete the assigned set you will be able to view their
  243 grades from within Moodle with the normal "Grades" tool.
  244 

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9