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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3831 - (view) (download)

1 : sh002i 1801 #!perl
2 : sh002i 654 ################################################################################
3 : sh002i 1663 # WeBWorK Online Homework Delivery System
4 : sh002i 3826 # Copyright © 2000-2003 The WeBWorK Project, http://openwebwork.sf.net/
5 : sh002i 3831 # $CVSHeader: webwork2/conf/global.conf.dist,v 1.158 2005/12/18 22:00:58 sh002i Exp $
6 : sh002i 1663 #
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 : sh002i 654 ################################################################################
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 : sh002i 2515 # 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 : sh002i 654
26 :     ################################################################################
27 : sh002i 2515 # Seed variables
28 :     ################################################################################
29 :    
30 : sh002i 2520 # Set these variables to correspond to your configuration and preferences. You
31 : sh002i 3124 # will need to restart the webserver to reset the variables in this section.
32 : sh002i 2515
33 :     # URL of WeBWorK handler.
34 :     $webwork_url = "/webwork2";
35 :    
36 :     # Root directory of PG.
37 : sh002i 2516 $pg_dir = "/opt/pg";
38 : sh002i 2515
39 :     # URL and path to htdocs directory.
40 :     $webwork_htdocs_url = "/webwork2_files";
41 :     $webwork_htdocs_dir = "$webwork_dir/htdocs";
42 :    
43 :     # URL and path to courses directory.
44 :     $webwork_courses_url = "/webwork2_course_files";
45 :     $webwork_courses_dir = "$webwork_dir/courses";
46 :    
47 :     ################################################################################
48 : sh002i 2508 # Paths to external programs
49 :     ################################################################################
50 :    
51 : sh002i 3622 # system utilties
52 : sh002i 2508 $externalPrograms{mkdir} = "/bin/mkdir";
53 : sh002i 3124 $externalPrograms{mv} = "/bin/mv";
54 : sh002i 3389 $externalPrograms{mysql} = "/usr/bin/mysql";
55 : sh002i 3622 $externalPrograms{tar} = "/usr/bin/tar";
56 : sh002i 2508
57 : sh002i 3622 # equation rendering/hardcopy utiltiies
58 : sh002i 3389 $externalPrograms{latex} = "/usr/bin/latex";
59 : sh002i 3622 $externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape"; # --shell-escape allows pdflatex to handle .eps files
60 : sh002i 3389 $externalPrograms{dvipng} = "/usr/bin/dvipng";
61 :     $externalPrograms{tth} = "/usr/bin/tth";
62 : sh002i 2508
63 : sh002i 3622 # NetPBM - basic image manipulation utilities
64 :     # most sites only need to configure $netpbm_prefix.
65 : sh002i 3581 my $netpbm_prefix = "/usr/bin";
66 :     $externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm";
67 :     $externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm";
68 :     $externalPrograms{pnmtops} = "$netpbm_prefix/pnmtops";
69 :     $externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng";
70 :     $externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm";
71 : jj 3546
72 : sh002i 3622 # image conversions utiltiies
73 :     # the source file is given on stdin, and the output expected on stdout.
74 :     #
75 :     # Note on conversions pipelines:
76 :     # we used to use `pnmdepth 1' instead of ppmtopgm as it creates a
77 :     # monochrome image (1 bit) rather than a greyscale image (8 bits).
78 :     # However, this was causing improper display of some sort in PDFs.
79 :     $externalPrograms{gif2eps} = "$externalPrograms{giftopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
80 : jj 3546 $externalPrograms{png2eps} = "$externalPrograms{pngtopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
81 :     $externalPrograms{gif2png} = "$externalPrograms{giftopnm} | $externalPrograms{pnmtopng}";
82 :    
83 : sh002i 2508 ################################################################################
84 :     # Mail settings
85 :     ################################################################################
86 :    
87 :     # Mail sent by the PG system and the mail merge and feedback modules will be
88 :     # sent via this SMTP server.
89 : apizer 3617 $mail{smtpServer} = 'mail.yourschool.edu';
90 : sh002i 2508
91 :     # When connecting to the above server, WeBWorK will send this address in the
92 :     # MAIL FROM command. This has nothing to do with the "From" address on the mail
93 :     # message. It can really be anything, but some mail servers require it contain
94 :     # a valid mail domain, or at least be well-formed.
95 :     $mail{smtpSender} = 'webwork@yourserver.yourschool.edu';
96 : sh002i 3645
97 : sh002i 2508 # AllowedRecipients defines addresses that the PG system is allowed to send mail
98 :     # to. this prevents subtle PG exploits. This should be set in course.conf to the
99 :     # addresses of professors of each course. Sending mail from the PG system (i.e.
100 :     # questionaires, essay questions) will fail if this is not set somewhere (either
101 :     # here or in course.conf).
102 :     $mail{allowedRecipients} = [
103 :     #'prof1@yourserver.yourdomain.edu',
104 :     #'prof2@yourserver.yourdomain.edu',
105 :     ];
106 : sh002i 3627
107 :     # By default, feeback is sent to all users who have permission to
108 :     # receive_feedback. If this list is non-empty, feedback is also sent to the
109 :     # addresses specified here.
110 :     #
111 :     # * If you want to disable feedback altogether, leave this empty and set
112 :     # submit_feeback => $nobody in %permissionLevels below. This will cause the
113 :     # feedback button to go away as well.
114 :     #
115 :     # * If you want to send email ONLY to addresses in this list, set
116 : apizer 3643 # receive_feedback => $nobody in %permissionLevels below.
117 : sh002i 3627 #
118 :     # It's often useful to set this in the course.conf to change the behavior of
119 :     # feedback for a specific course.
120 :     #
121 : sh002i 3698 # Items in this list may be bare addresses, or RFC822 mailboxes, like:
122 :     # 'Joe User <joe.user@example.com>'
123 :     # The advantage of this form is that the resulting email will include the name
124 :     # of the recipient in the "To" field of the email.
125 :     #
126 : sh002i 3627 $mail{feedbackRecipients} = [
127 :     #'prof1@yourserver.yourdomain.edu',
128 :     #'prof2@yourserver.yourdomain.edu',
129 :     ];
130 :    
131 : sh002i 3645 # Feedback subject line -- the following escape sequences are recognized:
132 :     #
133 :     # %c = course ID
134 :     # %u = user ID
135 :     # %s = set ID
136 :     # %p = problem ID
137 :     # %x = section
138 :     # %r = recitation
139 :     # %% = literal percent sign
140 :     #
141 : sh002i 3656 $mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r";
142 : sh002i 3645
143 : sh002i 2508 # feedbackVerbosity:
144 :     # 0: send only the feedback comment and context link
145 :     # 1: as in 0, plus user, set, problem, and PG data
146 :     # 2: as in 1, plus the problem environment (debugging data)
147 :     $mail{feedbackVerbosity} = 1;
148 : sh002i 3645
149 : sh002i 2508 # Defines the size of the Mail Merge editor window
150 :     # FIXME: should this be here? it's UI, not mail
151 :     # FIXME: replace this with the auto-size method that TWiki uses
152 :     $mail{editor_window_rows} = 15;
153 :     $mail{editor_window_columns} = 100;
154 :    
155 :     ################################################################################
156 : sh002i 2438 # System-wide locations (directories and URLs)
157 : sh002i 663 ################################################################################
158 : sh002i 654
159 : sh002i 2438 # The root directory, set by webwork_root variable in Apache configuration.
160 : sh002i 2491 $webworkDirs{root} = "$webwork_dir";
161 : sh002i 654
162 : sh002i 2438 # Location of system-wide data files.
163 :     $webworkDirs{DATA} = "$webworkDirs{root}/DATA";
164 : sh002i 654
165 : sh002i 2438 # Used for temporary storage of uploaded files.
166 :     $webworkDirs{uploadCache} = "$webworkDirs{DATA}/uploads";
167 : sh002i 654
168 : sh002i 2438 # Location of utility programs.
169 :     $webworkDirs{bin} = "$webworkDirs{root}/bin";
170 :    
171 :     # Location of configuration files, templates, snippets, etc.
172 :     $webworkDirs{conf} = "$webworkDirs{root}/conf";
173 :    
174 : sh002i 3831 # Location of theme templates.
175 :     $webworkDirs{templates} = "$webworkDirs{conf}/templates";
176 :    
177 : sh002i 2438 # Location of course directories.
178 : sh002i 2491 $webworkDirs{courses} = "$webwork_courses_dir" || "$webworkDirs{root}/courses";
179 : sh002i 2438
180 :     # Contains log files.
181 :     $webworkDirs{logs} = "$webworkDirs{root}/logs";
182 :    
183 :     # Contains non-web-accessible temporary files, such as TeX working directories.
184 :     $webworkDirs{tmp} = "$webworkDirs{root}/tmp";
185 :    
186 : dpvc 3330 # The (absolute) destinations of symbolic links that are OK for the FileManager to follow.
187 :     # (any subdirectory of these is a valid target for a symbolic link.)
188 :     # For example:
189 :     # $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"];
190 :     $webworkDirs{valid_symlinks} = [];
191 :    
192 : sh002i 2438 ##### The following locations are web-accessible.
193 :    
194 :     # The root URL (usually /webwork2), set by <Location> in Apache configuration.
195 : sh002i 2491 $webworkURLs{root} = "$webwork_url";
196 : sh002i 2438
197 :     # Location of system-wide web-accessible files, such as equation images, and
198 :     # help files.
199 : sh002i 2491 $webworkDirs{htdocs} = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs";
200 :     $webworkURLs{htdocs} = "$webwork_htdocs_url";
201 : sh002i 2438
202 :     # Location of web-accessible temporary files, such as equation images.
203 :     $webworkDirs{htdocs_temp} = "$webworkDirs{htdocs}/tmp";
204 :     $webworkURLs{htdocs_temp} = "$webworkURLs{htdocs}/tmp";
205 :    
206 :     # Location of cached equation images.
207 :     $webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations";
208 :     $webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations";
209 :    
210 :     # Contains context-sensitive help files.
211 :     $webworkDirs{local_help} = "$webworkDirs{htdocs}/helpFiles";
212 :     $webworkURLs{local_help} = "$webworkURLs{htdocs}/helpFiles";
213 :    
214 :     # URL of general WeBWorK documentation.
215 :     $webworkURLs{docs} = "http://webhost.math.rochester.edu/webworkdocs/docs";
216 :    
217 :     # URL of WeBWorK 1.x profLogin.pl script, for access to old professor pages.
218 :     # Note that both systems must share a single "courses" directory for this to be
219 :     # useful. Leave this blank to disable
220 :     $webworkURLs{oldProf} = "/webwork1/profLogin.pl";
221 :    
222 :     # URL of WeBWorK Bugzilla database.
223 : sh002i 2694 $webworkURLs{bugReporter} = "http://bugs.webwork.rochester.edu/";
224 : sh002i 2438
225 : sh002i 3124 # Location of CSS
226 :     $webworkURLs{stylesheet} = "$webworkURLs{htdocs}/css/ur.css";
227 :    
228 : sh002i 2438 # Location of jsMath script, used for the jsMath display mode.
229 : dpvc 3538 $webworkURLs{jsMath} = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js";
230 : sh002i 2438
231 :     # Location of ASCIIMathML script, used for the asciimath display mode.
232 : dpvc 2441 $webworkURLs{asciimath} = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js";
233 : sh002i 2438
234 : sh002i 663 ################################################################################
235 : sh002i 2438 # Defaults for course-specific locations (directories and URLs)
236 : sh002i 663 ################################################################################
237 :    
238 : sh002i 2438 # The root directory of the current course. (The ID of the current course is
239 :     # available in $courseName.)
240 :     $courseDirs{root} = "$webworkDirs{courses}/$courseName";
241 : sh002i 663
242 : sh002i 2438 # Location of course HTML files, passed to PG.
243 :     $courseDirs{html} = "$courseDirs{root}/html";
244 : sh002i 2491 $courseURLs{html} = "$webwork_courses_url/$courseName";
245 : sh002i 2438
246 :     # Location of course image files, passed to PG.
247 :     $courseDirs{html_images} = "$courseDirs{html}/images";
248 :    
249 :     # Location of web-accessible, course-specific temporary files, like static and
250 :     # dynamically-generated PG graphics.
251 :     $courseDirs{html_temp} = "$courseDirs{html}/tmp";
252 :     $courseURLs{html_temp} = "$courseURLs{html}/tmp";
253 :    
254 :     # Location of course-specific logs, like the transaction log.
255 :     $courseDirs{logs} = "$courseDirs{root}/logs";
256 :    
257 :     # Location of scoring files.
258 :     $courseDirs{scoring} = "$courseDirs{root}/scoring";
259 :    
260 :     # Location of PG templates and set definition files.
261 :     $courseDirs{templates} = "$courseDirs{root}/templates";
262 :    
263 :     # Location of course-specific macro files.
264 :     $courseDirs{macros} = "$courseDirs{templates}/macros";
265 :    
266 :     # Location of mail-merge templates.
267 :     $courseDirs{email} = "$courseDirs{templates}/email";
268 :    
269 : gage 3717 # Location of temporary editing files.
270 :     $courseDirs{tmpEditFileDir} = "$courseDirs{templates}/tmpEdit";
271 :    
272 : sh002i 2438 ################################################################################
273 :     # System-wide files
274 :     ################################################################################
275 :    
276 :     # Location of this file.
277 :     $webworkFiles{environment} = "$webworkDirs{conf}/global.conf";
278 :    
279 :     # Flat-file database used to protect against MD5 hash collisions. TeX equations
280 :     # are hashed to determine the name of the image file. There is a tiny chance of
281 :     # a collision between two TeX strings. This file allows for that. However, this
282 :     # is slow, so most people chose not to worry about it. Set this to "" if you
283 :     # don't want to use the equation cache file.
284 :     $webworkFiles{equationCacheDB} = ""; # "$webworkDirs{DATA}/equationcache";
285 :    
286 :     ##### Hardcopy snippets are used in constructing a TeX file for hardcopy output.
287 :     ##### They should contain TeX code unless otherwise noted.
288 :    
289 :     # The preamble is the first thing in the TeX file.
290 :     $webworkFiles{hardcopySnippets}{preamble} = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex";
291 :    
292 :     # The setHeader preceeds each set. It is a PG file.
293 : gage 2447 $webworkFiles{hardcopySnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # hardcopySetHeader.pg",
294 : sh002i 2438
295 :     # The problem divider goes between problems.
296 :     $webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex";
297 :    
298 :     # The set footer goes after each set. Is is a PG file.
299 :     $webworkFiles{hardcopySnippets}{setFooter} = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg";
300 :    
301 :     # The set divider goes between sets (in multiset output).
302 :     $webworkFiles{hardcopySnippets}{setDivider} = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex";
303 :    
304 :     # The user divider does between users (in multiuser output).
305 :     $webworkFiles{hardcopySnippets}{userDivider} = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex";
306 :    
307 :     # The postabmle is the last thing in the TeX file.
308 :     $webworkFiles{hardcopySnippets}{postamble} = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex";
309 :    
310 :     ##### Screen snippets are used when displaying problem sets on the screen.
311 :    
312 :     # The set header is displayed on the problem set page. It is a PG file.
313 : gage 2447 $webworkFiles{screenSnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg"
314 : sh002i 2438
315 : sh002i 3124 # A PG template for creation of new problems.
316 : gage 3069 $webworkFiles{screenSnippets}{blankProblem} = "$webworkDirs{conf}/snippets/blankProblem.pg"; # screenSetHeader.pg"
317 :    
318 : gage 3237 # A site info "message of the day" file
319 : sh002i 3701 $webworkFiles{site_info} = "$webworkDirs{htdocs}/site_info.txt";
320 : sh002i 3697
321 : sh002i 2438 ################################################################################
322 :     # Course-specific files
323 :     ################################################################################
324 :    
325 :     # The course configuration file.
326 :     $courseFiles{environment} = "$courseDirs{root}/course.conf";
327 :    
328 : jj 3681 # The course simple configuration file (holds web-based configuratoin).
329 :     $courseFiles{simpleConfig} = "$courseDirs{root}/simple.conf";
330 :    
331 : sh002i 2438 # File contents are displayed after login, on the problem sets page. Path given
332 :     # here is relative to the templates directory.
333 :     $courseFiles{course_info} = "course_info.txt";
334 :    
335 :     # File contents are displayed on the login page. Path given here is relative to
336 :     # the templates directory.
337 :     $courseFiles{login_info} = "login_info.txt";
338 :    
339 :     # Additional library buttons can be added to the Library Browser (SetMaker.pm)
340 :     # by adding the libraries you want to the following line. For each key=>value
341 :     # in the list, if a directory (or link to a directory) with name 'key' appears
342 :     # in the templates directory, then a button with name 'value' will be placed at
343 :     # the top of the problem browser. (No button will appear if there is no
344 :     # directory or link with the given name in the templates directory.) For
345 :     # example,
346 :     #
347 :     # $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
348 :     #
349 :     # would add two buttons, one for the Rochester library and one for the ASU
350 : sh002i 2694 # library, provided templates/rochester and templates/asu exists either as
351 :     # subdirectories or links to other directories.
352 : sh002i 2438 #
353 : sh002i 2694 $courseFiles{problibs} = {
354 :     # rochesterLibrary => "Rochester",
355 :     # asuLibrary => "Arizona State",
356 :     # dcdsLibrary => "Detroit CDS",
357 :     # dartmouthLibrary => "Dartmouth",
358 :     # indianaLibrary => "Indiana",
359 :     # osuLibrary => "Ohio State",
360 : sh002i 2722 # capaLibrary => "CAPA",
361 : sh002i 2694 };
362 : dpvc 2431
363 : sh002i 2438 ################################################################################
364 : sh002i 3645 # Database options
365 : sh002i 2508 ################################################################################
366 :    
367 :     # Several database are defined in the file conf/database.conf and stored in the
368 :     # hash %dbLayouts.
369 :     include "conf/database.conf";
370 :    
371 :     # Select the default database layout. This can be overridden in the course.conf
372 : sh002i 3822 # file of a particular course. The only database layout supported in WW 2.1.4
373 :     # and up is "sql_single".
374 :     $dbLayoutName = "sql_single";
375 : sh002i 2508
376 :     # This sets the symbol "dbLayout" as an alias for the selected database layout.
377 :     *dbLayout = $dbLayouts{$dbLayoutName};
378 :    
379 :     ################################################################################
380 :     # Problem library options
381 :     ################################################################################
382 :    
383 :     # The directory containing the problem library files. Set to "" if no problem
384 :     # library is installed.
385 :     $problemLibrary{root} = "";
386 :    
387 : jj 3407 # Problem Library version
388 :     # Version 1 is in use. Version 2 will be released soon.
389 :     $problemLibrary{version} = "1";
390 :    
391 : sh002i 2508 # The name of the SQL database containing problem metadata
392 :     $problemLibrary{sourceSQL} = "ProblemLibrary";
393 :    
394 :     # The user name to use when connecting to the problem library database
395 :     $problemLibrary{userSQL} = "webworkRead";
396 :    
397 :     # The password to use when connecting to the problem library database
398 :     $problemLibrary{passwordSQL} = "";
399 :    
400 :     ################################################################################
401 : sh002i 2438 # Logs
402 :     ################################################################################
403 : dpvc 2431
404 : sh002i 2438 # FIXME: take logs out of %webworkFiles/%courseFiles and give them their own
405 :     # top-level hash.
406 : sh002i 705
407 : sh002i 2438 # Logs data about how long it takes to process problems. (Do not confuse this
408 :     # with the /other/ timing log which can be set by WeBWorK::Timing and is used
409 :     # for benchmarking system performance in general. At some point, this timing
410 :     # mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.)
411 :     $webworkFiles{logs}{timing} = "$webworkDirs{logs}/timing.log";
412 : sh002i 654
413 : sh002i 2831 # Logs courses created via the web-based Course Administration module.
414 :     $webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log";
415 :    
416 : sh002i 2438 # The transaction log contains data from each recorded answer submission. This
417 :     # is useful if the database becomes corrupted.
418 :     $webworkFiles{logs}{transaction} = "$courseDirs{logs}/transaction.log";
419 :    
420 :     # The answer log stores a history of all users' submitted answers.
421 :     $courseFiles{logs}{answer_log} = "$courseDirs{logs}/answer_log";
422 :    
423 : sh002i 3365 # Log logins.
424 :     $courseFiles{logs}{login_log} = "$courseDirs{logs}/login.log";
425 :    
426 : jj 3583 # Log for almost every click. By default it is the empty string, which
427 :     # turns this log off. If you want it turned on, we suggest
428 :     # "$courseDirs{logs}/activity.log"
429 :     # When turned on, this log can get quite large.
430 :     $courseFiles{logs}{activity_log} = '';
431 :    
432 : sh002i 654 ################################################################################
433 : sh002i 2438 # Site defaults (FIXME: what other things could be "site defaults"?)
434 :     ################################################################################
435 :    
436 : sh002i 2857 # Set the default timezone of courses on this server. To get a list of valid
437 :     # timezones, run:
438 : sh002i 2770 #
439 : sh002i 2857 # perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'
440 :     #
441 :     # To get a list of valid timezone "links" (deprecated names), run:
442 :     #
443 :     # perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'
444 :     #
445 : sh002i 2770 # If left blank, the system timezone will be used. This is usually what you
446 :     # want. You might want to set this if your server is NOT in the same timezone as
447 :     # your school. If just a few courses are in a different timezone, set this in
448 :     # course.conf for the affected courses instead.
449 :     #
450 :     $siteDefaults{timezone} = "";
451 :    
452 : gage 3436 # The default_templates_course is used by default to create a new course.
453 :     # The contents of the templates directory are copied from this course
454 :     # to the new course being created.
455 :     $siteDefaults{default_templates_course} ="modelCourse";
456 :    
457 : sh002i 2438 ################################################################################
458 : sh002i 3831 # Theme
459 : sh002i 663 ################################################################################
460 :    
461 : sh002i 3831 $defaultTheme = "math";
462 :     $defaultThemeTemplate = "system";
463 : sh002i 654
464 : sh002i 663 ################################################################################
465 : sh002i 1108 # Authorization system
466 :     ################################################################################
467 :    
468 : sh002i 3671 # this section lets you define which groups of users can perform which actions.
469 : sh002i 2438
470 : sh002i 3671 # this hash maps a numeric permission level to the name of a role. the number
471 :     # assigned to a role is significant -- roles with higher numbers are considered
472 :     # "more privileged", and are included when that role is listed for a privilege
473 :     # below.
474 :     #
475 :     %userRoles = (
476 :     guest => -5,
477 :     student => 0,
478 :     proctor => 2,
479 :     ta => 5,
480 :     professor => 10,
481 :     );
482 : sh002i 2438
483 : sh002i 3671 # this hash maps operations to the roles that are allowed to perform those
484 :     # operations. the role listed and any role with a higher permission level (in
485 :     # the %userRoles hash) will be allowed to perform the operation. If the role
486 :     # is undefined, no users will be allowed to perform the operation.
487 :     #
488 : sh002i 654 %permissionLevels = (
489 : sh002i 3671 login => "guest",
490 :     report_bugs => "student",
491 :     submit_feedback => "student",
492 :     change_password => "student",
493 :     change_email_address => "student",
494 : sh002i 3691
495 : sh002i 3671 proctor_quiz => "proctor",
496 : sh002i 2505
497 : sh002i 3671 view_multiple_sets => "ta",
498 :     view_unopened_sets => "ta",
499 :     view_unpublished_sets => "ta",
500 :     view_answers => "ta",
501 : sh002i 2505
502 : sh002i 3671 become_student => "professor",
503 :     access_instructor_tools => "ta",
504 :     score_sets => "professor",
505 :     send_mail => "professor",
506 :     receive_feedback => "ta",
507 : sh002i 2505
508 : sh002i 3671 create_and_delete_problem_sets => "professor",
509 :     assign_problem_sets => "professor",
510 :     modify_problem_sets => "professor",
511 :     modify_student_data => "professor",
512 :     modify_classlist_files => "professor",
513 :     modify_set_def_files => "professor",
514 :     modify_scoring_files => "professor",
515 :     modify_problem_template_files => "professor",
516 : sh002i 3675 manage_course_files => "professor",
517 : sh002i 2505
518 : sh002i 3671 create_and_delete_courses => "professor",
519 :     fix_course_databases => "professor",
520 : sh002i 2505
521 :     ##### Behavior of the interactive problem processor #####
522 :    
523 : sh002i 3671 show_correct_answers_before_answer_date => "ta",
524 :     show_solutions_before_answer_date => "ta",
525 :     avoid_recording_answers => "ta",
526 : jj 3580 # Below this level, old answers are never initially shown
527 : sh002i 3671 can_show_old_answers_by_default => "student",
528 : jj 3580 # at this level, we look at showOldAnswers for default value
529 :     # even after the due date
530 : sh002i 3671 can_always_use_show_old_answers_default => "professor",
531 :     check_answers_before_open_date => "ta",
532 :     check_answers_after_open_date_with_attempts => "ta",
533 :     check_answers_after_open_date_without_attempts => "guest",
534 :     check_answers_after_due_date => "guest",
535 :     check_answers_after_answer_date => "guest",
536 :     record_answers_when_acting_as_student => undef,
537 : sh002i 2505 # "record_answers_when_acting_as_student" takes precedence
538 :     # over the following for professors acting as students:
539 : sh002i 3671 record_answers_before_open_date => undef,
540 :     record_answers_after_open_date_with_attempts => "student",
541 :     record_answers_after_open_date_without_attempts => undef,
542 :     record_answers_after_due_date => undef,
543 :     record_answers_after_answer_date => undef,
544 :     dont_log_past_answers => "professor",
545 : sh002i 3795 # does the user get to see a dump of the problem?
546 :     view_problem_debugging_info => "ta",
547 : sh002i 2764
548 :     ##### Behavior of the Hardcopy Processor #####
549 :    
550 : sh002i 3671 download_hardcopy_multiuser => "ta",
551 :     download_hardcopy_multiset => "ta",
552 :     download_hardcopy_format_pdf => "guest",
553 :     download_hardcopy_format_tex => "ta",
554 : sh002i 654 );
555 :    
556 : sh002i 3707 # This is the default permission level given to new students and students with
557 :     # invalid or missing permission levels.
558 :     $default_permission_level = $userRoles{student};
559 :    
560 : sh002i 1108 ################################################################################
561 : sh002i 3688 # Status system
562 :     ################################################################################
563 :    
564 : sh002i 3691 # This is the default status given to new students and students with invalid
565 :     # or missing statuses.
566 :     $default_status = "Enrolled";
567 :    
568 : sh002i 3688 # The first abbreviation in the abbreviations list is the canonical
569 :     # abbreviation, and will be used when setting the status value in a user record
570 :     # or an exported classlist file.
571 :     #
572 :     # Results are undefined if more than one status has the same abbreviation.
573 :     #
574 :     # The four behaviors that are controlled by status are:
575 :     # allow_course_access => is this user allowed to log in?
576 :     # include_in_assignment => is this user included when assigning as set to "all" users?
577 :     # include_in_stats => is this user included in statistical reports?
578 : sh002i 3691 # include_in_email => is this user included in emails sent to the class?
579 : sh002i 3688 # include_in_scoring => is this user included in score reports?
580 :    
581 :     %statuses = (
582 :     Enrolled => {
583 :     abbrevs => [qw/ C c current enrolled /],
584 : sh002i 3691 behaviors => [qw/ allow_course_access include_in_assignment include_in_stats
585 :     include_in_email include_in_scoring /],
586 : sh002i 3688 },
587 :     Audit => {
588 :     abbrevs => [qw/ A a audit /],
589 : sh002i 3691 behaviors => [qw/ allow_course_access include_in_assignment include_in_stats
590 :     include_in_email /],
591 : sh002i 3688 },
592 :     Drop => {
593 :     abbrevs => [qw/ D d drop withdraw /],
594 :     behaviors => [qw/ /],
595 :     },
596 :     );
597 :    
598 :     ################################################################################
599 : sh002i 1108 # Session options
600 :     ################################################################################
601 :    
602 : sh002i 768 # $sessionKeyTimeout defines seconds of inactivity before a key expires
603 :     $sessionKeyTimeout = 60*30;
604 :    
605 : sh002i 811 # $sessionKeyLength defines the length (in characters) of the session key
606 :     $sessionKeyLength = 40;
607 :    
608 :     # @sessionKeyChars lists the legal session key characters
609 :     @sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9', '.', '^', '/', '!', '*');
610 :    
611 : sh002i 768 # Practice users are users who's names start with $practiceUser
612 :     # (you can comment this out to remove practice user support)
613 :     $practiceUserPrefix = "practice";
614 :    
615 :     # There is a practice user who can be logged in multiple times. He's
616 :     # commented out by default, though, so you don't hurt yourself. It is
617 :     # kindof a backdoor to the practice user system, since he doesn't have a
618 :     # password. Come to think of it, why do we even have this?!
619 :     #$debugPracticeUser = "practice666";
620 :    
621 : sh002i 663 ################################################################################
622 : sh002i 2438 # PG subsystem options
623 : sh002i 663 ################################################################################
624 : sh002i 654
625 : sh002i 2438 # List of enabled display modes. Comment out any modes you don't wish to make
626 :     # available for use.
627 :     $pg{displayModes} = [
628 :     "plainText", # display raw TeX for math expressions
629 :     "formattedText", # format math expressions using TtH
630 :     "images", # display math expressions as images generated by dvipng
631 :     "jsMath", # render TeX math expressions on the client side using jsMath
632 :     "asciimath", # render TeX math expressions on the client side using ASCIIMathML
633 :     ];
634 :    
635 :     #### Default settings for the PG translator
636 :    
637 :     # Default display mode. Should be listed above.
638 :     $pg{options}{displayMode} = "images";
639 :    
640 :     # The default grader to use, if a problem doesn't specify.
641 :     $pg{options}{grader} = "avg_problem_grader";
642 :    
643 :     # Fill in answer blanks with the student's last answer by default?
644 :     $pg{options}{showOldAnswers} = 1;
645 :    
646 :     # Show correct answers (when allowed) by default?
647 :     $pg{options}{showCorrectAnswers} = 0;
648 :    
649 :     # Show hints (when allowed) by default?
650 :     $pg{options}{showHints} = 0;
651 :    
652 :     # Show solutions (when allowed) by default?
653 :     $pg{options}{showSolutions} = 0;
654 :    
655 :     # Catch translation warnings internally by default? (We no longer need to do
656 :     # this, since there is a global warnings handler. So this should be off.)
657 :     $pg{options}{catchWarnings} = 0;
658 :    
659 :     ##### Currently-selected renderer
660 :    
661 :     # Only the local renderer is supported in this version.
662 :     $pg{renderer} = "WeBWorK::PG::Local";
663 :    
664 :     # The remote renderer connects to an XML-RPC PG rendering server.
665 : sh002i 2940 #$pg{renderer} = "WeBWorK::PG::Remote";
666 : sh002i 2438
667 :     ##### Renderer-dependent options
668 :    
669 :     # The remote renderer has one option:
670 :     $pg{renderers}{"WeBWorK::PG::Remote"} = {
671 :     # The "proxy" server to connect to for remote rendering.
672 :     proxy => "http://localhost:21000/RenderD",
673 :     };
674 :    
675 :     ##### Settings for various display modes
676 :    
677 :     # "images" mode has several settings:
678 :     $pg{displayModeOptions}{images} = {
679 :     # Determines the method used to align images in output. Can be
680 :     # "baseline", "absmiddle", or "mysql".
681 :     dvipng_align => 'baseline',
682 :    
683 :     # If we choose mysql, we need information on connecting to the
684 :     # database. Whatever you use here, you have to create the database
685 :     # and grant read/write priveleges to the user listed here. To create
686 :     # the database in mysql, as root use:
687 :     #
688 :     # CREATE DATABASE DvipngDepths;
689 :     # USE DvipngDepths;
690 :     # CREATE TABLE depths (md5 CHAR(33) NOT NULL, depth SMALLINT, PRIMARY KEY (md5));
691 :     # GRANT ALL ON DvipngDepths.* TO webworkWrite;
692 :     #
693 :     # In the last statement, "webworkWrite" should match the user below.
694 : sh002i 2831 # FIXME: this database can become a table in the 'webwork' database
695 : sh002i 2438 dvipng_depth_db => {
696 :     dbsource => 'dbi:mysql:DvipngDepths',
697 : sh002i 3822 user => $dbLayouts{sql_single}->{password}->{params}->{usernameRW},
698 :     passwd => $dbLayouts{sql_single}->{password}->{params}->{passwordRW},
699 : sh002i 2192 },
700 : sh002i 2438 };
701 : jj 2413
702 : dpvc 2983 $pg{displayModeOptions}{jsMath} = {
703 : dpvc 3538 reportMissingFonts => 0, # set to 1 to allow the missing font message
704 :     missingFontMessage => undef, # set to an HTML string to replace the missing font message
705 :     noImageFonts => 0, # set to 1 if you didn't install the jsMath image fonts
706 : dpvc 3764 processDoubleClicks => 1, # set to 0 to disable double-click on math to get TeX source
707 : dpvc 2983 };
708 :    
709 : sh002i 2438 ##### Directories used by PG
710 : jj 2413
711 : sh002i 2438 # The root of the PG directory tree (from pg_root in Apache config).
712 : sh002i 2491 $pg{directories}{root} = "$pg_dir";
713 : sh002i 2438 $pg{directories}{lib} = "$pg{directories}{root}/lib";
714 :     $pg{directories}{macros} = "$pg{directories}{root}/macros";
715 : jj 2417
716 : dpvc 3224 #
717 :     # The macro file search path. Each directory in this list is seached
718 :     # (in this order) by loadMacros() when it looks for a .pl file.
719 :     #
720 :     $pg{directories}{macrosPath} = [
721 :     ".", # search the problem file's directory
722 :     $courseDirs{macros},
723 :     $pg{directories}{macros},
724 :     ];
725 :    
726 : sh002i 2438 ##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
727 : jj 2417
728 : sh002i 2438 # Users for whom to print the file name of the PG file being processed.
729 :     $pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ];
730 : jj 2417
731 : sh002i 2438 # Locations of CAPA resources. (Only necessary if you need to use converted CAPA
732 :     # problems.)
733 :     $pg{specialPGEnvironmentVars}{CAPA_Tools} = "$courseDirs{macros}/CAPA_Tools/",
734 :     $pg{specialPGEnvironmentVars}{CAPA_MCTools} = "$courseDirs{macros}/CAPA_MCTools/",
735 :     $pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$courseDirs{html}/CAPA_Graphics/",
736 :     $pg{specialPGEnvironmentVars}{CAPA_Graphics_URL} = "$courseURLs{html}/CAPA_Graphics/",
737 :    
738 :     # Size in pixels of dynamically-generated images, i.e. graphs.
739 :     $pg{specialPGEnvironmentVars}{onTheFlyImageSize} = 400,
740 : jj 3571
741 : sh002i 3809 # To disable the Parser-based versions of num_cmp and fun_cmp, and use the
742 :     # original versions instead, set this value to 1.
743 :     $pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 0;
744 : sh002i 2438
745 : jj 3552 # Strings to insert at the start and end of the body of a problem
746 :     # (at beginproblem() and ENDDOCUMENT) in various modes. More display modes
747 :     # can be added if different behaviours are desired (e.g., HTML_dpng,
748 :     # HTML_asciimath, etc.). These parts are not used in the Library browser.
749 :    
750 :     $pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' };
751 :     $pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' };
752 :    
753 :     # To have the problem body indented and boxed, uncomment:
754 :    
755 :     # $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '<BLOCKQUOTE>
756 :     # <TABLE BORDER=1 CELLSPACING=1 CELLPADDING=15 BGCOLOR=#E8E8E8><TR><TD>';
757 :     # $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '</TD></TR></TABLE>
758 :     # </BLOCKQUOTE>';
759 :    
760 : sh002i 2438 ##### PG modules to load
761 :    
762 :     # The first item of each list is the module to load. The remaining items are
763 :     # additional packages to import.
764 :    
765 :     ${pg}{modules} = [
766 :     [qw(DynaLoader)],
767 :     [qw(Exporter)],
768 :     [qw(GD)],
769 :    
770 : gage 3211 [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)],
771 : sh002i 2438 [qw(AnswerHash AnswerEvaluator)],
772 :     [qw(WWPlot)], # required by Circle (and others)
773 :     [qw(Circle)],
774 :     [qw(Complex)],
775 :     [qw(Complex1)],
776 :     [qw(Distributions)],
777 :     [qw(Fraction)],
778 :     [qw(Fun)],
779 :     [qw(Hermite)],
780 :     [qw(Label)],
781 :     [qw(List)],
782 :     [qw(Match)],
783 :     [qw(MatrixReal1)], # required by Matrix
784 :     [qw(Matrix)],
785 :     [qw(Multiple)],
786 :     [qw(PGrandom)],
787 :     [qw(Regression)],
788 :     [qw(Select)],
789 :     [qw(Units)],
790 :     [qw(VectorField)],
791 : dpvc 2577 [qw(Parser Value)],
792 : jj 3571 [qw(Parser::Legacy)],
793 : sh002i 2954 [qw(Apache::Log)],
794 : sh002i 2438 ];
795 :    
796 :     ##### Answer evaluatior defaults
797 :    
798 :     $pg{ansEvalDefaults} = {
799 :     functAbsTolDefault => .001,
800 :     functLLimitDefault => .0000001,
801 :     functMaxConstantOfIntegration => 1E8,
802 :     functNumOfPoints => 3,
803 :     functRelPercentTolDefault => .1,
804 :     functULimitDefault => .9999999,
805 :     functVarDefault => "x",
806 :     functZeroLevelDefault => 1E-14,
807 :     functZeroLevelTolDefault => 1E-12,
808 :     numAbsTolDefault => .001,
809 :     numFormatDefault => "",
810 :     numRelPercentTolDefault => .1,
811 :     numZeroLevelDefault => 1E-14,
812 :     numZeroLevelTolDefault => 1E-12,
813 :     useBaseTenLog => 0,
814 :     defaultDisplayMatrixStyle => "[s]",
815 :     };
816 : sh002i 2491
817 :     ################################################################################
818 :     # Compatibility
819 :     ################################################################################
820 :    
821 :     # Define the old names for the various "root" variables.
822 :     $webworkRoot = $webworkDirs{root};
823 :     $webworkURLRoot = $webworkURLs{root};
824 :     $pgRoot = $pg{directories}{root};

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9