[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 3825 - (view) (download)

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

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9