[system] / trunk / webwork2 / conf / global.conf.dist Repository:
ViewVC logotype

View of /trunk/webwork2/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6507 - (download) (annotate)
Thu Nov 11 15:42:44 2010 UTC (2 years, 6 months ago) by gage
File size: 43188 byte(s)
moved files around
added Inequalities::common to global.conf.dist


    1 #!perl
    2 ################################################################################
    3 # WeBWorK Online Homework Delivery System
    4 # Copyright © 2000-2007 The WeBWorK Project, http://openwebwork.sf.net/
    5 # $CVSHeader: webwork2/conf/global.conf.dist,v 1.225 2010/05/18 18:03:31 apizer Exp $
    6 #
    7 # This program is free software; you can redistribute it and/or modify it under
    8 # the terms of either: (a) the GNU General Public License as published by the
    9 # Free Software Foundation; either version 2, or (at your option) any later
   10 # version, or (b) the "Artistic License" which comes with this package.
   11 #
   12 # This program is distributed in the hope that it will be useful, but WITHOUT
   13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   14 # FOR A PARTICULAR PURPOSE.  See either the GNU General Public License or the
   15 # Artistic License for more details.
   16 ################################################################################
   17 
   18 # This file is used to set up the default WeBWorK course environment for all
   19 # requests. Values may be overwritten by the course.conf for a specific course.
   20 # All package variables set in this file are added to the course environment.
   21 # If you wish to set a variable here but omit it from the course environment,
   22 # use the "my" keyword. The $webwork_dir variable is set in the WeBWorK Apache
   23 # configuration file (webwork.apache-config) and is available for use here. In
   24 # addition, the $courseName variable holds the name of the current course.
   25 
   26 ################################################################################
   27 # Seed variables
   28 ################################################################################
   29 
   30 # Set these variables to correspond to your configuration and preferences. You
   31 # will need to restart the webserver to reset the variables in this section.
   32 
   33 # URL of WeBWorK handler. If WeBWorK is to be on the web server root, use "". Note
   34 # that using "" may not work so we suggest sticking with "/webwork2".
   35 $webwork_url         = "/webwork2";
   36 $server_root_url   = "";
   37 $server_userID     = "";
   38 $server_groupID    = "";
   39 
   40 # In the apache configuration file (often called httpd.conf) you will find
   41 # User wwadmin   --- this is the $server_userID -- of course it may be wwhttpd or some other name
   42 # Group wwdata   --- this is the $server_groupID -- this will have different names also
   43 
   44 # Root directory of PG.
   45 $pg_dir              = "/opt/webwork/pg";
   46 
   47 # URL and path to htdocs directory.
   48 $webwork_htdocs_url  = "/webwork2_files";
   49 $webwork_htdocs_dir  = "$webwork_dir/htdocs";
   50 
   51 # URL and path to courses directory.
   52 $webwork_courses_url = "/webwork2_course_files";
   53 $webwork_courses_dir = "/opt/webwork/courses"; #(a typical place to put the course directory
   54 
   55 ################################################################################
   56 # Paths to external programs
   57 ################################################################################
   58 
   59 # system utilities
   60 $externalPrograms{mv}    = "/bin/mv";
   61 $externalPrograms{cp}    = "/bin/cp";
   62 $externalPrograms{rm}    = "/bin/rm";
   63 $externalPrograms{mkdir} = "/bin/mkdir";
   64 $externalPrograms{tar}   = "/bin/tar";
   65 $externalPrograms{gzip}  = "/bin/gzip";
   66 
   67 # equation rendering/hardcopy utiltiies
   68 $externalPrograms{latex}    = "/usr/bin/latex";
   69 $externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape";
   70 $externalPrograms{dvipng}   = "/usr/bin/dvipng";
   71 $externalPrograms{tth}      = "/usr/bin/tth";
   72 
   73 ####################################################
   74 # NetPBM - basic image manipulation utilities
   75 # Most sites only need to configure $netpbm_prefix.
   76 ####################################################
   77 my $netpbm_prefix = "/usr/bin";
   78 $externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm";
   79 $externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm";
   80 $externalPrograms{pnmtops}  = "$netpbm_prefix/pnmtops";
   81 $externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng";
   82 $externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm";
   83 
   84 # url checker
   85 $externalPrograms{checkurl} = "/usr/bin/lwp-request -d -mHEAD "; # or "/usr/local/bin/w3c -head "
   86 
   87 # image conversions utiltiies
   88 # the source file is given on stdin, and the output expected on stdout.
   89 $externalPrograms{gif2eps} = "$externalPrograms{giftopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
   90 $externalPrograms{png2eps} = "$externalPrograms{pngtopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
   91 $externalPrograms{gif2png} = "$externalPrograms{giftopnm} | $externalPrograms{pnmtopng}";
   92 
   93 # mysql clients
   94 $externalPrograms{mysql}     = "/usr/bin/mysql";
   95 $externalPrograms{mysqldump} = "/usr/bin/mysqldump";
   96 
   97 ################################################################################
   98 # Mail settings
   99 ################################################################################
  100 
  101 # Mail sent by the PG system and the mail merge and feedback modules will be
  102 # sent via this SMTP server.
  103 $mail{smtpServer}            = 'mail.yourschool.edu';
  104 
  105 # When connecting to the above server, WeBWorK will send this address in the
  106 # MAIL FROM command. This has nothing to do with the "From" address on the mail
  107 # message. It can really be anything, but some mail servers require it contain
  108 # a valid mail domain, or at least be well-formed.
  109 $mail{smtpSender}            = 'webwork@yourserver.yourschool.edu';
  110 
  111 # Seconds to wait before timing out when connecting to the SMTP server.
  112 $mail{smtpTimeout}           = 30;
  113 
  114 # AllowedRecipients defines addresses that the PG system is allowed to send mail
  115 # to. this prevents subtle PG exploits. This should be set in course.conf to the
  116 # addresses of professors of each course. Sending mail from the PG system (i.e.
  117 # questionaires, essay questions) will fail if this is not set somewhere (either
  118 # here or in course.conf).
  119 $mail{allowedRecipients}     = [
  120   #'prof1@yourserver.yourdomain.edu',
  121   #'prof2@yourserver.yourdomain.edu',
  122 ];
  123 
  124 # By default, feeback is sent to all users who have permission to
  125 # receive_feedback. If this list is non-empty, feedback is also sent to the
  126 # addresses specified here.
  127 #
  128 # * If you want to disable feedback altogether, leave this empty and set
  129 #   submit_feeback => $nobody in %permissionLevels below. This will cause the
  130 #   feedback button to go away as well.
  131 #
  132 # * If you want to send email ONLY to addresses in this list, set
  133 #   receive_feedback => $nobody in %permissionLevels below.
  134 #
  135 # It's often useful to set this in the course.conf to change the behavior of
  136 # feedback for a specific course.
  137 #
  138 # Items in this list may be bare addresses, or RFC822 mailboxes, like:
  139 #   'Joe User <joe.user@example.com>'
  140 # The advantage of this form is that the resulting email will include the name
  141 # of the recipient in the "To" field of the email.
  142 #
  143 $mail{feedbackRecipients}    = [
  144   #'prof1@yourserver.yourdomain.edu',
  145   #'prof2@yourserver.yourdomain.edu',
  146 ];
  147 
  148 # Feedback subject line -- the following escape sequences are recognized:
  149 #
  150 #   %c = course ID
  151 #   %u = user ID
  152 #   %s = set ID
  153 #   %p = problem ID
  154 #   %x = section
  155 #   %r = recitation
  156 #   %% = literal percent sign
  157 #
  158 
  159 $mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r";
  160 
  161 # feedbackVerbosity:
  162 #  0: send only the feedback comment and context link
  163 #  1: as in 0, plus user, set, problem, and PG data
  164 #  2: as in 1, plus the problem environment (debugging data)
  165 $mail{feedbackVerbosity}     = 1;
  166 
  167 # Defines the size of the Mail Merge editor window
  168 # FIXME: should this be here? it's UI, not mail
  169 # FIXME: replace this with the auto-size method that TWiki uses
  170 $mail{editor_window_rows}    = 15;
  171 $mail{editor_window_columns} = 100;
  172 
  173 ###################################################
  174 # Customizing the action of the "Email your instructor" button
  175 ###################################################
  176 
  177 # Use this to customize the text of the feedback button.
  178 $feedback_button_name = "Email instructor";
  179 
  180 # If this value is true, feedback will only be sent to users with the same
  181 # section as the user initiating the feedback.
  182 $feedback_by_section = 0;
  183 
  184 # If the variable below is set to a non-empty value (i.e. in course.conf), WeBWorK's usual
  185 # email feedback mechanism  will be replaced with a link to the given URL.
  186 # See also $feedback_button_name, above.
  187 
  188 $courseURLs{feedbackURL} = "";
  189 
  190 # If the variable below is set to a non-empty value (i.e. in course.conf),
  191 # WeBWorK's usual email feedback mechanism  will be replaced with a link to the given URL and
  192 # a POST request with information about the problem including the HTML rendering
  193 # of the problem will be sent to that URL.
  194 # See also $feedback_button_name, above.
  195 
  196 #$courseURLs{feedbackFormURL} = "http://www.mathnerds.com/MathNerds/mmn/SDS/askQuestion.aspx";  #"http://www.tipjar.com/cgi-bin/test";
  197 $courseURLs{feedbackFormURL} = "";
  198 
  199 ################################################################################
  200 # Theme
  201 ################################################################################
  202 
  203 $defaultTheme = "math2";
  204 $defaultThemeTemplate = "system";
  205 
  206 ################################################################################
  207 # System-wide locations (directories and URLs)
  208 ################################################################################
  209 
  210 # The root directory, set by webwork_root variable in Apache configuration.
  211 $webworkDirs{root}          = "$webwork_dir";
  212 
  213 # Location of system-wide data files.
  214 $webworkDirs{DATA}          = "$webworkDirs{root}/DATA";
  215 
  216 # Used for temporary storage of uploaded files.
  217 $webworkDirs{uploadCache}   = "$webworkDirs{DATA}/uploads";
  218 
  219 # Location of utility programs.
  220 $webworkDirs{bin}           = "$webworkDirs{root}/bin";
  221 
  222 # Location of configuration files, templates, snippets, etc.
  223 $webworkDirs{conf}          = "$webworkDirs{root}/conf";
  224 
  225 # Location of theme templates.
  226 $webworkDirs{templates}     = "$webworkDirs{conf}/templates";
  227 
  228 # Location of course directories.
  229 $webworkDirs{courses}       = "$webwork_courses_dir" || "$webworkDirs{root}/courses";
  230 
  231 # Contains log files.
  232 $webworkDirs{logs}          = "$webworkDirs{root}/logs";
  233 
  234 # Contains non-web-accessible temporary files, such as TeX working directories.
  235 $webworkDirs{tmp}           = "$webworkDirs{root}/tmp";
  236 
  237 # The (absolute) destinations of symbolic links that are OK for the FileManager to follow.
  238 #   (any subdirectory of these is a valid target for a symbolic link.)
  239 # For example:
  240 #    $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"];
  241 $webworkDirs{valid_symlinks}   = [];
  242 
  243 ################################################################################
  244 ##### The following locations are web-accessible.
  245 ################################################################################
  246 
  247 # The root URL (usually /webwork2), set by <Location> in Apache configuration.
  248 $webworkURLs{root}          = "$webwork_url";
  249 
  250 # Location of system-wide web-accessible files, such as equation images, and
  251 # help files.
  252 $webworkDirs{htdocs}        = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs";
  253 $webworkURLs{htdocs}        = "$webwork_htdocs_url";
  254 
  255 # Location of web-accessible temporary files, such as equation images.
  256 $webworkDirs{htdocs_temp}   = "$webworkDirs{htdocs}/tmp";
  257 $webworkURLs{htdocs_temp}   = "$webworkURLs{htdocs}/tmp";
  258 
  259 # Location of cached equation images.
  260 $webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations";
  261 $webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations";
  262 
  263 # Contains context-sensitive help files.
  264 $webworkDirs{local_help}    = "$webworkDirs{htdocs}/helpFiles";
  265 $webworkURLs{local_help}    = "$webworkURLs{htdocs}/helpFiles";
  266 
  267 # URL of general WeBWorK documentation.
  268 $webworkURLs{docs}          = "http://webwork.maa.org";
  269 
  270 # URL of WeBWorK Bugzilla database.
  271 $webworkURLs{bugReporter}   = "http://bugs.webwork.maa.org/enter_bug.cgi";
  272 
  273 # Location of CSS
  274 # $webworkURLs{stylesheet}    = "$webworkURLs{htdocs}/css/${defaultTheme}.css";
  275 # this is never used -- changing the theme from the config panel
  276 # doesn't appear to reset the theme in time?
  277 # It's better to refer directly to the .css file in the system.template
  278 # <link rel="stylesheet" type="text/css" href="<!--#url type="webwork" name="htdocs"-->/css/math.css"/>
  279 
  280 # Location of jsMath script, used for the jsMath display mode.
  281 $webworkURLs{jsMath}        = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js";
  282 
  283 # Location of MathJax script, used for the MathJax display mode.
  284 $webworkURLs{MathJax}        = "$webworkURLs{htdocs}/mathjax/MathJax.js";
  285 
  286 # Location of ASCIIMathML script, used for the asciimath display mode.
  287 $webworkURLs{asciimath}     = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js";
  288 
  289 # Location of LaTeXMathML script, used for the LaTeXMathML display mode.
  290 $webworkURLs{LaTeXMathML}   = "$webworkURLs{htdocs}/LaTeXMathML/LaTeXMathML.js";
  291 
  292 ################################################################################
  293 # Defaults for course-specific locations (directories and URLs)
  294 ################################################################################
  295 
  296 # The root directory of the current course. (The ID of the current course is
  297 # available in $courseName.)
  298 $courseDirs{root}        = "$webworkDirs{courses}/$courseName";
  299 
  300 # Location of course-specific data files.
  301 $courseDirs{DATA}        = "$courseDirs{root}/DATA";
  302 
  303 # Location of course HTML files, passed to PG.
  304 $courseDirs{html}        = "$courseDirs{root}/html";
  305 $courseURLs{html}        = "$webwork_courses_url/$courseName";
  306 
  307 # Location of course image files, passed to PG.
  308 $courseDirs{html_images} = "$courseDirs{html}/images";
  309 
  310 # Location of web-accessible, course-specific temporary files, like static and
  311 # dynamically-generated PG graphics.
  312 $courseDirs{html_temp}   = "$courseDirs{html}/tmp";
  313 $courseURLs{html_temp}   = "$courseURLs{html}/tmp";
  314 
  315 # Location of course-specific logs, like the transaction log.
  316 $courseDirs{logs}        = "$courseDirs{root}/logs";
  317 
  318 # Location of scoring files.
  319 $courseDirs{scoring}     = "$courseDirs{root}/scoring";
  320 
  321 # Location of PG templates and set definition files.
  322 $courseDirs{templates}   = "$courseDirs{root}/templates";
  323 
  324 # Location of course-specific macro files.
  325 $courseDirs{macros}      = "$courseDirs{templates}/macros";
  326 
  327 # Location of mail-merge templates.
  328 $courseDirs{email}       = "$courseDirs{templates}/email";
  329 
  330 # Location of temporary editing files.
  331 $courseDirs{tmpEditFileDir}  = "$courseDirs{templates}/tmpEdit";
  332 
  333 
  334 # mail merge status directory
  335 $courseDirs{mailmerge}   = "$courseDirs{DATA}/mailmerge";
  336 
  337 ################################################################################
  338 # System-wide files
  339 ################################################################################
  340 
  341 # Location of this file.
  342 $webworkFiles{environment}                      = "$webworkDirs{conf}/global.conf";
  343 
  344 # Flat-file database used to protect against MD5 hash collisions. TeX equations
  345 # are hashed to determine the name of the image file. There is a tiny chance of
  346 # a collision between two TeX strings. This file allows for that. However, this
  347 # is slow, so most people chose not to worry about it. Set this to "" if you
  348 # don't want to use the equation cache file.
  349 $webworkFiles{equationCacheDB}                  = ""; # "$webworkDirs{DATA}/equationcache";
  350 
  351 ################################################################################
  352 # Hardcopy snippets are used in constructing a TeX file for hardcopy output.
  353 # They should contain TeX code unless otherwise noted.
  354 ################################################################################
  355 # The preamble is the first thing in the TeX file.
  356 $webworkFiles{hardcopySnippets}{preamble}       = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex";
  357 
  358 # The setHeader preceeds each set. It is a PG file.
  359 $webworkFiles{hardcopySnippets}{setHeader}      = "$webworkDirs{conf}/snippets/setHeader.pg";  # hardcopySetHeader.pg",
  360 
  361 # The problem divider goes between problems.
  362 $webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex";
  363 
  364 # The set footer goes after each set. Is is a PG file.
  365 $webworkFiles{hardcopySnippets}{setFooter}      = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg";
  366 
  367 # The set divider goes between sets (in multiset output).
  368 $webworkFiles{hardcopySnippets}{setDivider}     = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex";
  369 
  370 # The user divider does between users (in multiuser output).
  371 $webworkFiles{hardcopySnippets}{userDivider}    = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex";
  372 
  373 # The postabmle is the last thing in the TeX file.
  374 $webworkFiles{hardcopySnippets}{postamble}      = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex";
  375 
  376 ##### Screen snippets are used when displaying problem sets on the screen.
  377 
  378 # The set header is displayed on the problem set page. It is a PG file.
  379 $webworkFiles{screenSnippets}{setHeader}        = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg"
  380 
  381 # A PG template for creation of new problems.
  382 $webworkFiles{screenSnippets}{blankProblem}    = "$webworkDirs{conf}/snippets/blankProblem2.pg"; # screenSetHeader.pg"
  383 
  384 # A site info  "message of the day" file
  385 $webworkFiles{site_info}                       = "$webworkDirs{htdocs}/site_info.txt";
  386 
  387 ################################################################################
  388 # Course-specific files
  389 ################################################################################
  390 
  391 # The course configuration file.
  392 $courseFiles{environment} = "$courseDirs{root}/course.conf";
  393 
  394 # The course simple configuration file (holds web-based configuratoin).
  395 $courseFiles{simpleConfig} = "$courseDirs{root}/simple.conf";
  396 
  397 # File contents are displayed after login, on the problem sets page. Path given
  398 # here is relative to the templates directory.
  399 $courseFiles{course_info} = "course_info.txt";
  400 
  401 # File contents are displayed on the login page. Path given here is relative to
  402 # the templates directory.
  403 $courseFiles{login_info}  = "login_info.txt";
  404 
  405 # Additional library buttons can be added to the Library Browser (SetMaker.pm)
  406 # by adding the libraries you want to the following line.  For each key=>value
  407 # in the list, if a directory (or link to a directory) with name 'key' appears
  408 # in the templates directory, then a button with name 'value' will be placed at
  409 # the top of the problem browser.  (No button will appear if there is no
  410 # directory or link with the given name in the templates directory.)  For
  411 # example,
  412 #
  413 #     $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
  414 #
  415 # would add two buttons, one for the Rochester library and one for the ASU
  416 # library, provided templates/rochester and templates/asu exists either as
  417 # subdirectories or links to other directories. The "NPL Directory" button
  418 # activated below gives access to all the directories in the National
  419 # Problem Library.
  420 #
  421 $courseFiles{problibs}    = {
  422   Library          => "NPL Directory",
  423 #   rochesterLibrary => "Rochester",
  424 #   unionLibrary     =>"Union",
  425 #   asuLibrary       => "Arizona State",
  426 #   dcdsLibrary      => "Detroit CDS",
  427 #   dartmouthLibrary => "Dartmouth",
  428 #   indianaLibrary   => "Indiana",
  429 #   osuLibrary       => "Ohio State",
  430 #   capaLibrary      => "CAPA",
  431 };
  432 
  433 ################################################################################
  434 # Status system
  435 ################################################################################
  436 
  437 # This is the default status given to new students and students with invalid
  438 # or missing statuses.
  439 $default_status = "Enrolled";
  440 
  441 # The first abbreviation in the abbreviations list is the canonical
  442 # abbreviation, and will be used when setting the status value in a user record
  443 # or an exported classlist file.
  444 #
  445 # Results are undefined if more than one status has the same abbreviation.
  446 #
  447 # The four behaviors that are controlled by status are:
  448 #   allow_course_access   => is this user allowed to log in?
  449 #   include_in_assignment => is this user included when assigning as set to "all" users?
  450 #   include_in_stats      => is this user included in statistical reports?
  451 #   include_in_email      => is this user included in emails sent to the class?
  452 #   include_in_scoring    => is this user included in score reports?
  453 
  454 %statuses = (
  455   Enrolled => {
  456     abbrevs => [qw/ C c current enrolled /],
  457     behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email include_in_scoring /],
  458   },
  459   Audit => {
  460     abbrevs => [qw/ A a audit /],
  461     behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email /],
  462   },
  463   Drop => {
  464     abbrevs => [qw/ D d drop withdraw /],
  465     behaviors => [qw/  /],
  466   },
  467   Proctor => {
  468     abbrevs => [qw/ P p proctor /],
  469     behaviors => [qw/  /],
  470   },
  471 );
  472 
  473 ################################################################################
  474 # Database options
  475 ################################################################################
  476 
  477 # these variables are used by database.conf. we define them here so that editing
  478 # database.conf isn't necessary.
  479 
  480 # required permissions
  481 # GRANT SELECT ON webwork.* TO webworkRead@localhost IDENTIFIED BY 'passwordRO';
  482 # GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, INDEX, LOCK TABLES ON webwork.* TO webworkWrite@localhost IDENTIFIED BY 'passwordRW';
  483 
  484 $database_dsn = "dbi:mysql:webwork";
  485 $database_username = "webworkWrite";
  486 $database_password = "";
  487 $database_debug = 0;
  488 
  489 # Variables for sql_moodle database layout.
  490 $moodle_dsn = "dbi:mysql:moodle";
  491 $moodle_username = $database_username;
  492 $moodle_password = $database_password;
  493 $moodle_table_prefix = "mdl_";
  494 $moodle17 = 0;
  495 
  496 # Several database are defined in the file conf/database.conf and stored in the
  497 # hash %dbLayouts.
  498 include "conf/database.conf";
  499 
  500 # Select the default database layout. This can be overridden in the course.conf
  501 # file of a particular course. The only database layout supported in WW 2.1.4
  502 # and up is "sql_single".
  503 $dbLayoutName = "sql_single";
  504 
  505 # This sets the symbol "dbLayout" as an alias for the selected database layout.
  506 *dbLayout     = $dbLayouts{$dbLayoutName};
  507 
  508 ################################################################################
  509 # Problem library options
  510 ################################################################################
  511 
  512 # For configuration instructions, see:
  513 # http://webwork.maa.org/wiki/National_Problem_Library
  514 # The directory containing the natinal problem library files. Set to "" if no problem
  515 # library is installed.
  516 $problemLibrary{root}        = "";
  517 
  518 # Problem Library version
  519 # Version 1 is in use.  Version 2 will be released soon.
  520 $problemLibrary{version} = "2";
  521 
  522 # Problem Library SQL database connection information
  523 $problemLibrary_db = {
  524         dbsource => $database_dsn,
  525         user     => $database_username,
  526         passwd   => $database_password,
  527 };
  528 
  529 ################################################################################
  530 # Logs
  531 ################################################################################
  532 
  533 # FIXME: take logs out of %webworkFiles/%courseFiles and give them their own
  534 # top-level hash.
  535 
  536 # Logs data about how long it takes to process problems. (Do not confuse this
  537 # with the /other/ timing log which can be set by WeBWorK::Timing and is used
  538 # for benchmarking system performance in general. At some point, this timing
  539 # mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.)
  540 $webworkFiles{logs}{timing}         = "$webworkDirs{logs}/timing.log";
  541 
  542 # Logs courses created via the web-based Course Administration module.
  543 $webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log";
  544 
  545 # The transaction log contains data from each recorded answer submission. This
  546 # is useful if the database becomes corrupted.
  547 $webworkFiles{logs}{transaction}    = "$webworkDirs{logs}/${courseName}_transaction.log";
  548 
  549 # The answer log stores a history of all users' submitted answers.
  550 $courseFiles{logs}{answer_log}      = "$courseDirs{logs}/answer_log";
  551 
  552 # Log logins.
  553 $courseFiles{logs}{login_log}       = "$courseDirs{logs}/login.log";
  554 
  555 # Log for almost every click.  By default it is the empty string, which
  556 # turns this log off.  If you want it turned on, we suggest
  557 #                "$courseDirs{logs}/activity.log"
  558 # When turned on, this log can get quite large.
  559 $courseFiles{logs}{activity_log} = '';
  560 
  561 ################################################################################
  562 # Site defaults (FIXME: what other things could be "site defaults"?)
  563 ################################################################################
  564 
  565 # Set the default timezone of courses on this server. To get a list of valid
  566 # timezones, run:
  567 #
  568 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'
  569 #
  570 # To get a list of valid timezone "links" (deprecated names), run:
  571 #
  572 #     perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'
  573 #
  574 # If left blank, the system timezone will be used. This is usually what you
  575 # want. You might want to set this if your server is NOT in the same timezone as
  576 # your school. If just a few courses are in a different timezone, set this in
  577 # course.conf for the affected courses instead.
  578 #
  579 $siteDefaults{timezone} = "America/New_York";
  580 
  581 # The default_templates_course is used by default to create a new course.
  582 # The contents of the templates directory are copied from this course
  583 # to the new course being created.
  584 $siteDefaults{default_templates_course} ="modelCourse";
  585 
  586 ################################################################################
  587 # Authentication system
  588 ################################################################################
  589 
  590 # FIXME This mechanism is a little awkward and probably should be merged with
  591 # the dblayout selection system somehow.
  592 
  593 # Select the authentication module to use for normal logins.
  594 #
  595 # If this value is a string, the given authentication module will be used
  596 # regardless of the database layout. If it is a hash, the database layout name
  597 # will be looked up in the hash and the resulting value will be used as the
  598 # authentication module. The special hash key "*" is used if no entry for the
  599 # current database layout is found.
  600 #
  601 $authen{user_module} = {
  602   sql_moodle => "WeBWorK::Authen::Moodle",
  603   # sql_ldap   => "WeBWorK::Authen::LDAP",
  604   "*" => "WeBWorK::Authen",
  605 };
  606 
  607 # Select the authentication module to use for proctor logins.
  608 #
  609 # A string or a hash is accepted, as above.
  610 #
  611 $authen{proctor_module} = "WeBWorK::Authen::Proctor";
  612 
  613 # Options for particular authentication modules
  614 
  615 # $authen{moodle_options} = {
  616 #   dsn => $moodle_dsn,
  617 #   username => $moodle_username,
  618 #   password => $moodle_password,
  619 #   table_prefix => $moodle_table_prefix,
  620 #   moodle17 => $moodle17,
  621 # };
  622 
  623 $authen{ldap_options} = {
  624   # hosts to attempt to connect to, in order. For example:
  625   #   auth.myschool.edu             -- uses LDAP scheme and port 389
  626   #   ldap://auth.myschool.edu:666  -- non-standard port
  627   #   ldaps://auth.myschool.edu     -- uses LDAPS scheme and port 636
  628   #   ldaps://auth.myschool.edu:389 -- SSL on non-SSL port
  629   #   Edit the host(s) below:
  630   net_ldap_hosts => [
  631     "ldaps://auth1.myschool.edu",
  632     "ldaps://auth2.myschool.edu",
  633   ],
  634   # connection options
  635   net_ldap_options => {
  636     timeout => 30,
  637     version => 3,
  638   },
  639   # base to use when searching for user's DN
  640   # Edit the data below:
  641   net_ldap_base => "ou=people,dc=myschool,dc=edu",
  642 
  643         # Use a Bind account if set to 1
  644         bindAccount => 0,
  645 
  646         searchDN => "cn=search,DC=youredu,DC=edu",
  647         bindPassword =>  "password",
  648 
  649   # If LDAP rejects password, check it against the WeBWorK password database
  650   failover => 1,
  651 };
  652 
  653 ################################################################################
  654 # Authorization system
  655 ################################################################################
  656 
  657 # this section lets you define which groups of users can perform which actions.
  658 
  659 # this hash maps a numeric permission level to the name of a role. the number
  660 # assigned to a role is significant -- roles with higher numbers are considered
  661 # "more privileged", and are included when that role is listed for a privilege
  662 # below.
  663 #
  664 %userRoles = (
  665   guest => -5,
  666   student => 0,
  667   login_proctor => 2,
  668   grade_proctor => 3,
  669   ta => 5,
  670   professor => 10,
  671 );
  672 
  673 # this hash maps operations to the roles that are allowed to perform those
  674 # operations. the role listed and any role with a higher permission level (in
  675 # the %userRoles hash) will be allowed to perform the operation. If the role
  676 # is undefined, no users will be allowed to perform the operation.
  677 #
  678 %permissionLevels = (
  679   login                          => "guest",
  680   report_bugs                    => "ta",
  681   submit_feedback                => "student",
  682   change_password                => "student",
  683   change_email_address           => "student",
  684 
  685   proctor_quiz_login             => "login_proctor",
  686   proctor_quiz_grade             => "grade_proctor",
  687   view_proctored_tests           => "student",
  688   view_hidden_work               => "ta",
  689 
  690   view_multiple_sets             => "ta",
  691   view_unopened_sets             => "ta",
  692   view_unpublished_sets          => "ta",
  693   view_answers                   => "ta",
  694   view_ip_restricted_sets        => "ta",
  695 
  696   become_student                 => "professor",
  697   access_instructor_tools        => "ta",
  698   score_sets                     => "professor",
  699   send_mail                      => "professor",
  700   receive_feedback               => "ta",
  701 
  702   create_and_delete_problem_sets => "professor",
  703   assign_problem_sets            => "professor",
  704   modify_problem_sets            => "professor",
  705   modify_student_data            => "professor",
  706   modify_classlist_files         => "professor",
  707   modify_set_def_files           => "professor",
  708   modify_scoring_files           => "professor",
  709   modify_problem_template_files  => "professor",
  710   manage_course_files            => "professor",
  711 
  712   create_and_delete_courses      => "professor",
  713   fix_course_databases           => "professor",
  714 
  715   ##### Behavior of the interactive problem processor #####
  716 
  717   show_correct_answers_before_answer_date         => "ta",
  718   show_solutions_before_answer_date               => "ta",
  719   avoid_recording_answers                         => "ta",
  720   # Below this level, old answers are never initially shown
  721   can_show_old_answers_by_default                 => "student",
  722   # at this level, we look at showOldAnswers for default value
  723   # even after the due date
  724   can_always_use_show_old_answers_default         => "professor",
  725   check_answers_before_open_date                  => "ta",
  726   check_answers_after_open_date_with_attempts     => "ta",
  727   check_answers_after_open_date_without_attempts  => "guest",
  728   check_answers_after_due_date                    => "guest",
  729   check_answers_after_answer_date                 => "guest",
  730   create_new_set_version_when_acting_as_student   => undef,
  731   print_path_to_problem                           => "professor", # see "Special" PG environment variables
  732   record_set_version_answers_when_acting_as_student => undef,
  733   record_answers_when_acting_as_student           => undef,
  734   # "record_answers_when_acting_as_student" takes precedence
  735   # over the following for professors acting as students:
  736   record_answers_before_open_date                 => undef,
  737   record_answers_after_open_date_with_attempts    => "student",
  738   record_answers_after_open_date_without_attempts => undef,
  739   record_answers_after_due_date                   => undef,
  740   record_answers_after_answer_date                => undef,
  741   dont_log_past_answers                           => "professor",
  742   # does the user get to see a dump of the problem?
  743   view_problem_debugging_info                     => "ta",
  744 
  745   ##### Behavior of the Hardcopy Processor #####
  746 
  747   download_hardcopy_multiuser  => "ta",
  748   download_hardcopy_multiset   => "ta",
  749   download_hardcopy_view_errors =>"professor",
  750   download_hardcopy_format_pdf => "guest",
  751   download_hardcopy_format_tex => "ta",
  752 );
  753 
  754 # This is the default permission level given to new students and students with
  755 # invalid or missing permission levels.
  756 $default_permission_level = $userRoles{student};
  757 
  758 ################################################################################
  759 # Session options
  760 ################################################################################
  761 
  762 # $sessionKeyTimeout defines seconds of inactivity before a key expires
  763 $sessionKeyTimeout = 60*30;
  764 
  765 # $sessionKeyLength defines the length (in characters) of the session key
  766 $sessionKeyLength = 32;
  767 
  768 # @sessionKeyChars lists the legal session key characters
  769 @sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9');
  770 
  771 # Practice users are users who's names start with $practiceUser
  772 # (you can comment this out to remove practice user support)
  773 $practiceUserPrefix = "practice";
  774 
  775 # There is a practice user who can be logged in multiple times.  He's
  776 # commented out by default, though, so you don't hurt yourself.  It is
  777 # kindof a backdoor to the practice user system, since he doesn't have a
  778 # password.  Come to think of it, why do we even have this?!
  779 #$debugPracticeUser = "practice666";
  780 
  781 # Option for gateway tests; $gatewayGracePeriod is the time in seconds
  782 # after the official due date during which we'll still grade the test
  783 $gatewayGracePeriod = 120;
  784 
  785 ################################################################################
  786 # PG subsystem options
  787 ################################################################################
  788 
  789 # List of enabled display modes. Comment out any modes you don't wish to make
  790 # available for use.
  791 $pg{displayModes} = [
  792 # "plainText",     # display raw TeX for math expressions
  793 # "formattedText", # format math expressions using TtH
  794   "images",        # display math expressions as images generated by dvipng
  795   "jsMath",        # render TeX math expressions on the client side using jsMath
  796 # "MathJax",       # render TeX math expressions on the client side using MathJax --- we strongly recommend people install and use MathJax
  797 # "asciimath",     # render TeX math expressions on the client side using ASCIIMathML
  798 # "LaTeXMathML",   # render TeX math expressions on the client side using LaTeXMathML
  799 ];
  800 
  801 #### Default settings for the PG translator
  802 
  803 # Default display mode. Should be listed above (uncomment only one).
  804 $pg{options}{displayMode}        = "images";
  805 #$pg{options}{displayMode}        = "jsMath";
  806 #$pg{options}{displayMode}        = "MathJax";
  807 
  808 # The default grader to use, if a problem doesn't specify.
  809 $pg{options}{grader}             = "avg_problem_grader";
  810 
  811 # Fill in answer blanks with the student's last answer by default?
  812 $pg{options}{showOldAnswers}     = 1;
  813 
  814 # Show correct answers (when allowed) by default?
  815 $pg{options}{showCorrectAnswers} = 0;
  816 
  817 # Show hints (when allowed) by default?
  818 $pg{options}{showHints}          = 0;
  819 
  820 # Show solutions (when allowed) by default?
  821 $pg{options}{showSolutions}      = 0;
  822 
  823 # Catch translation warnings internally by default? (We no longer need to do
  824 # this, since there is a global warnings handler. So this should be off.)
  825 $pg{options}{catchWarnings}      = 0;
  826 
  827 ##### Currently-selected renderer
  828 
  829 # Only the local renderer is supported in this version.
  830 $pg{renderer} = "WeBWorK::PG::Local";
  831 
  832 # The remote renderer connects to an XML-RPC PG rendering server.
  833 #$pg{renderer} = "WeBWorK::PG::Remote";
  834 
  835 ##### Renderer-dependent options
  836 
  837 # The remote renderer has one option:
  838 $pg{renderers}{"WeBWorK::PG::Remote"} = {
  839   # The "proxy" server to connect to for remote rendering.
  840   proxy => "http://localhost:21000/RenderD",
  841 };
  842 
  843 ##### Settings for various display modes
  844 
  845 # "images" mode has several settings:
  846 $pg{displayModeOptions}{images} = {
  847   # Determines the method used to align images in output. Can be
  848   # "baseline", "absmiddle", or "mysql".
  849   dvipng_align => 'mysql',
  850 
  851   # If mysql is chosen, this information indicates which database contains the
  852   # 'depths' table. Since 2.3.0, the depths table is kept in the main webwork
  853   # database. (If you are upgrading from an earlier version of webwork, and
  854   # used the mysql method in the past, you should move your existing 'depths'
  855   # table to the main database.)
  856   dvipng_depth_db => {
  857     dbsource => $database_dsn,
  858     user     => $database_username,
  859     passwd   => $database_password,
  860   },
  861 };
  862 
  863 $pg{displayModeOptions}{jsMath} = {
  864   reportMissingFonts => 0,       # set to 1 to allow the missing font message
  865   missingFontMessage => undef,   # set to an HTML string to replace the missing font message
  866   noImageFonts => 0,             # set to 1 if you didn't install the jsMath image fonts
  867   processDoubleClicks => 1,      # set to 0 to disable double-click on math to get TeX source
  868 };
  869 
  870 ##### Directories used by PG
  871 
  872 # The root of the PG directory tree (from pg_root in Apache config).
  873 $pg{directories}{root}   = "$pg_dir";
  874 $pg{directories}{lib}    = "$pg{directories}{root}/lib";
  875 $pg{directories}{macros} = "$pg{directories}{root}/macros";
  876 
  877 #
  878 #  The macro file search path.  Each directory in this list is seached
  879 #  (in this order) by loadMacros() when it looks for a .pl file.
  880 #
  881 $pg{directories}{macrosPath} = [
  882    ".",                     # search the problem file's directory
  883    $courseDirs{macros},
  884    $pg{directories}{macros},
  885    "$courseDirs{templates}/Library/macros/Union",
  886    "$courseDirs{templates}/Library/macros/Michigan",
  887    "$courseDirs{templates}/Library/macros/CollegeOfIdaho",
  888    "$courseDirs{templates}/Library/macros/FortLewis",
  889    "$courseDirs{templates}/Library/macros/TCNJ",
  890    "$courseDirs{templates}/Library/macros/NAU",
  891    "$courseDirs{templates}/Library/macros/Dartmouth",
  892 ];
  893 
  894 # The applet search path. If a full URL is given, it is used unmodified. If an
  895 # absolute path is given, the URL of the local server is prepended to it.
  896 #
  897 # For example, if an item is "/math/applets",
  898 # and the local server is  "https://math.yourschool.edu",
  899 # then the URL "https://math.yourschool.edu/math/applets" will be used.
  900 #
  901 
  902 $pg{directories}{appletPath} = [    # paths to search for applets (requires full url)
  903   "$webworkURLs{htdocs}/applets",
  904   "$webworkURLs{htdocs}/applets/geogebra_stable"
  905   #"$courseURLs{html}/applets",  # -- hack to prevent conflict of curl and apache2 only uses first entry
  906 ];
  907 
  908 ##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
  909 
  910 # Users for whom to print the file name of the PG file being processed.
  911 $pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ];
  912    # ie file paths are printed for 'gage'
  913 $pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_PERMISSION_LEVEL} = $userRoles{ $permissionLevels{print_path_to_problem} };
  914    # (file paths are also printed for anyone with this permission or higher)
  915 
  916 # Locations of CAPA resources. (Only necessary if you need to use converted CAPA
  917 # problems.)
  918 $pg{specialPGEnvironmentVars}{CAPA_Tools}             = "/opt/webwork/libraries/CAPA/CAPA_Tools/",
  919 $pg{specialPGEnvironmentVars}{CAPA_MCTools}           = "/opt/webwork/libraries/CAPA/CAPA_MCTools/",
  920 $pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$webworkDirs{htdocs}/CAPA_Graphics/",
  921 $pg{specialPGEnvironmentVars}{CAPA_Graphics_URL}      = "$webworkURLs{htdocs}/CAPA_Graphics/",
  922 
  923 # Size in pixels of dynamically-generated images, i.e. graphs.
  924 $pg{specialPGEnvironmentVars}{onTheFlyImageSize}      = 400,
  925 
  926 # To disable the Parser-based versions of num_cmp and fun_cmp, and use the
  927 # original versions instead, set this value to 1.
  928 $pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 0;
  929 
  930 # Strings to insert at the start and end of the body of a problem
  931 #  (at beginproblem() and ENDDOCUMENT) in various modes.  More display modes
  932 #  can be added if different behaviours are desired (e.g., HTML_dpng,
  933 #  HTML_asciimath, etc.).  These parts are not used in the Library browser.
  934 
  935 $pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' };
  936 $pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' };
  937 
  938 # To have the problem body indented and boxed, uncomment:
  939 
  940 # $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '<BLOCKQUOTE>
  941 #     <TABLE BORDER=1 CELLSPACING=1 CELLPADDING=15 BGCOLOR=#E8E8E8><TR><TD>';
  942 # $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '</TD></TR></TABLE>
  943 #     </BLOCKQUOTE>';
  944 
  945 ##### PG modules to load
  946 
  947 # The first item of each list is the module to load. The remaining items are
  948 # additional packages to import.
  949 
  950 ${pg}{modules} = [
  951   [qw(DynaLoader)],
  952   [qw(Exporter)],
  953   [qw(GD)],
  954 
  955   [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)],
  956   [qw(AnswerHash AnswerEvaluator)],
  957   [qw(WWPlot)], # required by Circle (and others)
  958   [qw(Circle)],
  959   [qw(Complex)],
  960   [qw(Complex1)],
  961   [qw(Distributions)],
  962   [qw(Fraction)],
  963   [qw(Fun)],
  964   [qw(Hermite)],
  965   [qw(Label)],
  966   [qw(ChoiceList)],
  967   [qw(Match)],
  968   [qw(MatrixReal1)], # required by Matrix
  969   [qw(Matrix)],
  970   [qw(Multiple)],
  971   [qw(PGrandom)],
  972   [qw(Regression)],
  973   [qw(Select)],
  974   [qw(Units)],
  975   [qw(VectorField)],
  976   [qw(Parser Value)],
  977   [qw(Parser::Legacy)],
  978   [qw(Inequalities::common)],
  979 # [qw(SaveFile)],
  980 #   [qw(Chromatic)], # for Northern Arizona graph problems
  981 #                    #  -- follow instructions at libraries/nau_problib/lib/README to install
  982     [qw(Applet FlashApplet JavaApplet CanvasApplet)],
  983   [qw(PGcore PGalias PGresource PGloadfiles PGanswergroup PGresponsegroup  Tie::IxHash)],
  984 ];
  985 
  986 ##### Problem creation defaults
  987 
  988 # The default weight (also called value) of a problem to use when using the
  989 # Library Browser, Problem Editor or Hmwk Sets Editor to add problems to a set
  990 # or when this value is left blank in an imported set definition file.
  991 $problemDefaults{value} = 1;
  992 
  993 # The default max_attempts for a problem to use when using the
  994 # Library Browser, Problem Editor or Hmwk Sets Editor to add problems to a set
  995 # or when this value is left blank in an imported set definition file.  Note that
  996 # setting this to -1 gives students unlimited attempts.
  997 $problemDefaults{max_attempts} = -1;
  998 
  999 ##### Answer evaluatior defaults
 1000 
 1001 $pg{ansEvalDefaults} = {
 1002   functAbsTolDefault            => .001,
 1003   functLLimitDefault            => .0000001,
 1004   functMaxConstantOfIntegration => 1E8,
 1005   functNumOfPoints              => 3,
 1006   functRelPercentTolDefault     => .1,
 1007   functULimitDefault            => .9999999,
 1008   functVarDefault               => "x",
 1009   functZeroLevelDefault         => 1E-14,
 1010   functZeroLevelTolDefault      => 1E-12,
 1011   numAbsTolDefault              => .001,
 1012   numFormatDefault              => "",
 1013   numRelPercentTolDefault       => .1,
 1014   numZeroLevelDefault           => 1E-14,
 1015   numZeroLevelTolDefault        => 1E-12,
 1016   useBaseTenLog                 => 0,
 1017   defaultDisplayMatrixStyle     => "[s]",  # left delimiter, middle line delimiters, right delimiter
 1018   reducedScoringPeriod          => 0, # Length of Reduced Credit Period (formally Reduced Scoring Period) in minutes
 1019   reducedScoringValue       => 1, # A number in [0,1]. Students will be informed of the value as a percentage
 1020 };
 1021 
 1022 ################################################################################
 1023 # Compatibility
 1024 ################################################################################
 1025 
 1026 # Define the old names for the various "root" variables.
 1027 $webworkRoot    = $webworkDirs{root};
 1028 $webworkURLRoot = $webworkURLs{root};
 1029 $pgRoot         = $pg{directories}{root};
 1030 

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9