View of /trunk/NationalProblemLibrary/Instructions

    1 How to Install the WeBWorK Problem Library Version 2
    2 --- -- ------- --- ------- ------- ------- ------- -
    3 
    4 Installing the problem library can be done in 4 steps.
    5 
    6 1. Download and unpack files
    7 
    8 The files are located in the Rochester cvs (including this one).
    9 Get the files and remember where you put them.  We will refer to
   10 it below as that directory from step 1.
   11 
   12 2. Tell WeBWorK where on your disk you put the problem library
   13 
   14 In the file $WEBWORK_ROOT/conf/global.conf, set the following
   15 values.  The first one is where you put the problem library files
   16 in step 1.
   17 
   18 $problemLibrary{root}        = "/opt/ProblemLibrary";
   19 $problemLibrary{version} = "2";
   20 
   21 The last line is the password you use for webworkWrite for mysql.
   22 
   23 3. Run the installation script
   24 
   25 Run the command NPL-update which is in the directory $WEBWORK_ROOT/bin.
   26 If $WEBWORK_ROOT/bin is not in your path, you may need to specify
   27 the full path, which might look something like
   28 
   29   /opt/webwork2/bin/NPL-update
   30 
   31 The script will print diagnostic information as it goes.  When it
   32 finishes, you are ready to go.
   33 
   34 4. Adjust existing courses.
   35 
   36 If you have courses which had been accessing version 1 of the problem
   37 library, your courses will have a symbolic link in their templates
   38 directories called Library.  Delete this link (rm Library).  WeBWorK
   39 will make the correct new link for you the next time you need it.
   40 
   41 5. Using the Rochester problem library from NPL
   42 
   43 For many years, the canonical set of problems people would start with
   44 for their WeBWorK installation was the Rochester collection.  All of
   45 those problems are now part of the NPL.  Since development/refinement
   46 of NPL problems will continue, it is a good idea to use the NPL
   47 problems instead.
   48 
   49 If you have existing problem sets, or you simply want to be able to
   50 browse the Rochester problems as you always have, you can still use
   51 the NPL problems for this purpose.
   52 
   53 The trickiest part of the instructions for doing this is that
   54 different systems may have put files in different places.  Here we
   55 assume:
   56 
   57   NPL is located at /opt/ProblemLibrary
   58 
   59   Rochester problems were a symbolic link in each course templates
   60   directory called "rochester_problib" (you may have to substitute
   61   your own value in the commands below).
   62 
   63 Then, move to the templates directory of a course:
   64 
   65   cd /opt/courses/MyCourseName/templates
   66 
   67 Then execute the commands:
   68 
   69   rm rochester_problib
   70   ln -s Library/Rochester rochester_problib
   71 
   72 Then repeat this for each existing course.  In the future, if new
   73 courses are made by copying the templates directories from existing
   74 courses, the changes will be carried over automatically.
   75 
   76 Test and enjoy.
   77 
   78 Upgrading
   79 ---------
   80 
   81 First update the problems in the problem library.  "cd" to the
   82 location of the problem library, which might be
   83 
   84   cd /opt/ProblemLibrary
   85 
   86 depending on where you installed it initially.  From that location,
   87 give the command
   88 
   89   cvs -q up -d
   90 
   91 This will update any problems you have already, and download new
   92 problems if the problem library has grown.
   93 
   94 Send questions, problems, and other feedback to jj (at) asu.edu.
   95 
   96 Credit
   97 ------
   98 
   99 This problem library was compiled in large part by support from the
  100 National Science Foundation.
  101