[system] / trunk / webwork-modperl / conf / global.conf.dist Repository:
ViewVC logotype

Annotation of /trunk/webwork-modperl/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3688 - (view) (download)

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9