Difference between revisions of "Release notes for WeBWorK 2.12"

From WeBWorK_wiki
Jump to navigation Jump to search
Line 27: Line 27:
on each directory (assuming that origin is your remote name for the openwebwork repo).
on each directory (assuming that origin is your remote name for the openwebwork repo).
2) Depending on your system there may be new perl modules added for 2.11. Run <code>check_modules.pl</code> and look for missing modules. They may include:
2) Depending on your system there may be new perl modules added for 2.12. Run <code>check_modules.pl</code> and look for missing modules. They may include:
* Digest::SHA
* Digest::SHA
You should also run <code>pdflatex /opt/webwork/webwork2/bin/check_latex.tex</code> and look for missing latex packages. They may include:
You should also run <code>pdflatex /opt/webwork/webwork2/bin/check_latex.tex</code> and look for missing latex packages. They may include:

Revision as of 10:38, 28 April 2016

                         Online Homework Delivery System                        
                                  Version 2.12                          

                    Copyright 2000-2016, The WeBWorK Project                    
                              All rights reserved.                              


Release date: May ??, 2016

Github repository:  https://github.com/openwebwork
Modules:    webwork2   pg   ww_install


WARNING: There are significant database upgrades since 2.11, as well as potential new modules. There are also changes to the configuration files which will need to be integrated into your existing configurations. The process for upgrading to 2.12 is described below.

Upgrade Instructions

1) Go to /opt/webwork/webwork2, as well as /opt/webwork/pg and run

git pull origin master

on each directory (assuming that origin is your remote name for the openwebwork repo).

2) Depending on your system there may be new perl modules added for 2.12. Run check_modules.pl and look for missing modules. They may include:

  • Digest::SHA

You should also run pdflatex /opt/webwork/webwork2/bin/check_latex.tex and look for missing latex packages. They may include:

  • fullpage

4) Check localOverrides.conf.dist and look for changes to add to the existing localOverrides.conf. There are a couple of important things here that will negatively affect your system if you don't deal with them.

  • Library Statistics - This is a new feature (see below). There are variables which control whether or not global and local problem statistics are shown in the library browser.
# These flags control if statistics on opl problems are shown in the library
# browser.  If you want to include local statistics you will need to
# run webwork2/bin/update-OPL-statistics on a regular basis.  
$problemLibrary{showLibraryLocalStats} = 1;
# This flag controls whether global statistics will be displayed
$problemLibrary{showLibraryGlobalStats} = 1;
  • Problem Re-Randomization - The problem rerandomization feature (see below) has default options which need to be set.
# The default prPeriod value (re-randomization period) to use for the newly created problem.
# It is suggested to use the value of -1, which means that the course-wide setting would be used
# Setting this to -1 defaults to the use of course-wide settings (suggested)
# Setting this to 0 disables periodic randomization regardless of the course-wide setting
# Setting this to a positive value will override the course-wide setting
$problemDefaults{prPeriod} = -1;

# Periodic re-randomization
# switch to enable periodic re-randomization
$pg{options}{enablePeriodicRandomization} = 0;
# course-wide default period for re-randomization, should be an integer
# the value of 0 disables re-randomization
$pg{options}{periodicRandomizationPeriod} = 5;

5) Check your apache configuration file and look for changes to add to your existing configuration file. In particular you may need to add the following:

  • Code to set the location of the pg directory as an environment variable
$WeBWorK::Constants::PG_DIRECTORY = $pg_dir;
$ENV{PG_ROOT} = $pg_dir;
  • A line to set the server admin email
$ENV{WEBWORK_SERVER_ADMIN} = $webwork_server_admin_email;

You should also check site-conf.dist and look for changes to add to the existing site.conf. There is nothing particular in this version release but you should check just the same.

6) Check your courses.dist/modelCourse/course.conf and look for changes against your course.conf file. They may include:

  • Removing a number of outdated settings.
  • Commented out settings for controlling which instructors can see which students.
# The following hashes control which users are allowed to see students from which
# sections.  This is typically  used for large multi-section classes with many students, ta's and
# professors.  When set users will only be allowed to see students from the appropriate section in the following:
# -  Instructor Tools
# -  Student Progress
# -  Email
# -  Problem Grader
# -  Show Answers
# They will be able to see students from other sections on other pages.  
# These variables generally should be set here and not in defaults.conf.

# $viewable_sections = { user_id1 => [1 ,2 ,3] , # list of viewable sections for user_id1
#		       user_id2 => [1],
#		     };

# $viewable_recitations = { user_id1 => [1 ,2 ,3] , # list of viewable recitations for user_id1
#			  user_id2 => [1],
#		     };

7) Restart the webserver.

sudo apachectl restart

8) Run the upgrade admin database script. You will not be able to access your admin course until this is done, and you will need to do that to upgrade the course databases.


Next, log into the admin course and upgrade the databases for all of your courses. Your server will not be functional until you perform this step.

9) Download the latest version of the OPL. Note: If you have library statistics enabled this will also update your statistics tables.

cd /opt/webwork/libraries/webwork-open-problem-library
git pull origin

10) Download the latest version of MathJax.

cd /opt/webwork/MathJax
git pull

Primary Changes

  • LTI Grade Passback: This is a complete rewrite of the LTI authentication module as well as upgrades to allow grades to be passed back from WeBWorK to the LMS (e.g. Blackboard, Moodle, etc...). The authentication features include the ability to automatically create students logging into WeBWorK for the first time. The grading feature has two modes. You can either have WeBWorK pass back a single "homework" grade for the entire course, or you can set it up on a set by set basis. You can read more about this module at the following links. Note: The new LTIAdvanced module not a strict upgrade from the older LTI authentication module LTIBasic. The older module still works, but should be considered legacy code.
  • Hardcopy Themes: This adds support for different hardcopy themes. Instructors will set the theme that students have access to on the Course Configuration page, and can also select the different themes on the instructor download handouts page. Right now there are two themes: the traditional two column WeBWorK theme and a new "one column" theme which is better for "wide" problems. The system is also set up so that universities can add their own themes for tests or with branding. Note: You will need to make sure the fullpage latex package is available on your server to use this feature.
  • Past Answer Refactor: This is a rewrite of the existing Past Answer's page. First, it replaces the old "wildcard/regex" feature in Past Answers with multiselect lists. Now users will explicitly select which sets, users and problems they would like to search for past answers. It also adds the ability to download answers from the Past Answer page as a CSV.
  • OPL Statistics: This adds problem usage statistics to the Library Browser. When enabled and configured you should both local and 'global' statistics on how many times problems have been assigned and students average scores and attempt numbers. Here local statistics are generated from the data on your WeBWorK server and reflects how your courses use problems. Global statistics are generated from over a dozen different universities and includes information on 23000 problems.
  • Translator Refactor: This is an extensive under the hood revamping of how PG tracks problem resources, aliases, answer blanks and evaluators. In general the new approach uses less "dead reckoning" and is smarter about treating answer blanks and evaluators as different components of the same "object". You should not see any changes in functionality as a result of this.
  • Advanced Problem Debugging: Users with admin privileges will have the ability to see detailed debugging information about problems. There are four options available. AnswerGroupInfo shows information about answer "groups". This is most helpful for multianswer style problems. Show Auxiliary Resources shows information about auxiliary files used by the problem. AnswerHashInfo shows information about the answer hash, including answers, filters and evaluators. PGInfo prints the PG environment, including all available variables.
  • Peroidic Randomization: This feature allows you to force problems to generate a new seed after a fixed number of attempts. It is sort of "max attempts lite" in that students can keep trying, but they have to start over. The feature is enabled via the Course Configuration page (in the Optional Modules section). Instructors can set the default number of attempts before re-randomization. The number of attempts before re-randomization can also be set on a per problem basis.
  • parserWordCompletion: These new macros provided free response fill in the blank questions with interactive help. As a student types their answer into the answer blank, jQuery's autocomplete feature generates a drop-down list of allowable answers that match what has already been typed.
  • Grades: The Grades page was overhauled with an number of small modifications. The total percentage score for homeworks is now shown and the "C" has been replaced by a 100. There is also a course homework grade at the bottom of the Grades table. This score is generated from the total number of points earned divided by the total number of points available and should match the score generated by selecting all sets on the Scoring Tools page. (This can be turned off on the Course Configuration page if WeBWorK's grading scheme doesn't match with what you use.)

Smaller Changes


The ww_install installer has been updated to support version 2.12. It has been tested on all of the distributions listed below. The installer has also been refactored to be more modular when it comes to different distributions. If you are interested in modifying the installer to work with your distribution post an issue on the ww_install github. You can read more about it at WeBWorK Installer Guide

Supported Distributions

The following are the distributions and features that are officially still supported. They have all been tested with the webwork installer. You still can use WeBWorK on whatever you like, of course. In particular if you install WeBWorK on a very recent version of Ubuntu or Fedora and have problems let us know.

  • Ubuntu 15.10
  • Ubuntu 16.04 (LTS)
  • Debian 8
  • CentOS 7
  • Fedora 22
  • Fedora 23

What could possibly go wrong?

  • I cannot access the admin course. This could be because you have not run upgrade_admin_db.pl yet.
  • I see little vertical lines next to MathJax rendered formulas. This is caused by an incompatibility between older versions of MathJax and Chrome. Update MathJax with cd /opt/webwork/MathJax and git pull to fix the problem.
  • I do not see links to some of the editors in the Main Menu, including the links to Problem Set Detail 2, or you may get an error about "SimplePGEditor". To fix this remove the definition of the %showeditors from localOverrides.conf. This hash should be defined in defaults.config and if you want to change things in localOverrides.conf you should set hash elements individually.
  • I can't get LTI to work. First make sure that you are using the new version of LTI. (Make a fresh copy of authen_LTI.conf from the distribution file.) Also enable the $debug_lti_parameters flag. For security reasons the default error messages from the LTI module are very vague.
  • I dont see the Library Statistics. Make sure that you have enable the appropriate flags in localOverrides.conf (see the first section of this page) and run OPL-update