Subversion Repositories wimsdev

Rev

Rev 15418 | Rev 15509 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
23 reyssat 1
# Format:
2
# Line 1. type name_in_wims_conf variable_name
3
# Line 2. prompt
4
# Line 3. variable type
5
# Line 4. selection range; prompts
7524 obado 6
# Line 5 Small Help
7
# Line 6 and up. More help
23 reyssat 8
 
9
:tech PATH
10
PATH
11
free
12
 
13
Search path for binary executables. It is safe to leave it with the default
14
value, unless you have a very special operating system setup.
15
 
16
:tech aliased_cgi
17
cgi to html address aliasing
18
choice
3988 bpr 19
yes,no;$wims_name_yes,$wims_name_no
23 reyssat 20
Set to yes if you want internet robots to see some WIMS contents as html
21
pages. Helps for making the site better referenced and better known, but
22
you need Apache 1.3 or up to get this to work correctly.
23
<p>
24
If you have just updated Apache httpd and if you have trouble with unknown
7763 bpr 25
addresses when you activate this feature, run the script
26
<code class="tt">bin/apache-config</code>.
27
</p>
23 reyssat 28
:tech aliased_getfile
29
getfile address rewriting
30
choice
3988 bpr 31
yes,no;$wims_name_yes,$wims_name_no
7763 bpr 32
Activating this allows you to get correct file names when downloading
33
wims-generated files: backup archives, student data in virtual classes, some
34
image files, etc. Otherwise all file downloads will default to the name
35
"wims.cgi" which has to be manually corrected when you save the file.
36
<p>
37
You may get into trouble downloading if your Apache httpd is not correctly
38
configured. In this case, say "no".
39
</p>
23 reyssat 40
:housekeep backup_hour
41
Hour of daily backup
42
choice
43
-1,1,2,3,4,5,6,7,8,9,11,13,15,17,18,19,20,21,22; none,1,2,3,4,5,6,7,8,9,11,13,15,17,18,19,20,21,22
7524 obado 44
This is the hour when daily data backup will take place.
45
Choose an hour where the server is not busy, or pick none (-1) to disable daily backup.
23 reyssat 46
 
47
:resources busyhours wims_busyhours
48
Busy hours of the server
49
free
50
 
51
You can list here the hours during which the server is most likely to be busy.
7486 bpr 52
Some activities such as local module publication will be prohibited during
23 reyssat 53
such periods. Give a list of words composed of two digits: for example,
7763 bpr 54
<code class="tt">08 09 13 14</code>.
23 reyssat 55
 
56
:graphics default_anim_format ins_format
11887 obado 57
Format of dynamic animations <span class="tt wims_warning">*</span>
23 reyssat 58
choice
59
gif, mng
60
Graphics format for dynamic animations. There are only two possibilities:
61
gif or mng. You must be aware of the fact that many currently used browsers
62
are unable to show inline mng animations.
63
 
64
:graphics default_texposition
65
Default formula position / MathML
66
choice
67
0,1,2; low,high,MathML
7528 bpr 68
TeX formulas are small graphics files that are middle-aligned with respect to the text line.
7524 obado 69
<p>There is an ancient middle-alignment bug from the beginning days of
23 reyssat 70
Netscape, which aligns the middle of the picture against the base line of
71
the text. This of course makes the formulas appear too low, and WIMS patches
7524 obado 72
it by raising a bit the formulas. </p>
73
<p>However, recent browsers no longer carry this alignment bug. And for these
23 reyssat 74
browsers, the patch makes the formulas too high with respect to text. This
75
parameter allows you to choose whether or not to activate the patch by
7524 obado 76
default. Note that users can define their own preferences. </p>
77
<p>The parameter can be used also to activate MathML translation.</p>
7528 bpr 78
<p>If you change this value, do not think of your own browser,
79
but of those of your average users!</p>
23 reyssat 80
 
81
:tech cgi_name
11887 obado 82
Name of the main cgi program <span class="tt wims_warning">!</span>
23 reyssat 83
free
84
 
7524 obado 85
You can change this name only if you have correctly aliased things in the configuration file of your httpd.
7763 bpr 86
For example, if you have run the script
87
in <code class="tt">bin/apache-config</code>,
88
you may try the names <code class="tt">index.html</code> or <code class="tt">wims.html</code>.
89
<p>
90
Do not change this if you do not know what you are doing! If you make it
91
wrong, you will have to manually recover your config.
92
</p>
23 reyssat 93
:class class_limit wims_class_limit
94
Limit of the number of virtual classes
95
int
96
0,1000
97
 
98
:class class_regpass wims_class_regpass
99
Rights to create virtual classes
100
free
101
 
102
This parameter defines your site's access right for the creation of virtual
103
classes. It contains 3 comma-separated fields, defining respectively the
104
access right for creating individual classes, class groups and institution
105
portals. For each field, the following definitions are possible.
106
<dl>
7763 bpr 107
<dt><code class="tt">all</code><dd>Every one can create classes.
108
<dt><code class="tt">deny</code><dd>Nobody is allowed to create classes.
109
<dt><code class="tt">email</code><dd>Every one can create classes, as long as he/she submits
23 reyssat 110
his/her working email address. The site will check the effectiveness of this
111
email address.
12877 bpr 112
<dt><code class="tt">passwd ****** ------</code><dd>The user must enter a password to access the
23 reyssat 113
creation of classes. You can define the password as the second word
7763 bpr 114
of the parameter (in replacement of <code class="tt">******</code> above), and
23 reyssat 115
communicate the password to those who you allow to create classes.
15331 obado 116
A third word can be added. It allows you to define an email domain list for automatic dispatch
117
of the password to the email addresses whose domains are indicated (the domains must be separated by |).
12026 guerimand 118
<dt><code class="tt">Host names or IP numbers/code><dd>
23 reyssat 119
 Only people connecting from the defined hosts will be allowed to create
120
classes.
121
$sitehelp
122
</dl>
12877 bpr 123
Par exemple, si vous avez mis
124
<code class="tt">email,email,passwd passwd tartenpion ac-paris.fr|ac-versailles.fr</code>
125
la création de classes et de groupement de classes sera autorisée après vérification
126
d'un email valide (par l'envoi d'un code). Pour la création d'un établissement,
127
le mot de passe
128
<span class="tt">tartenpion</span> sera envoyé
129
automatiquement aux adresses dont le domaine est
130
<code class="tt">ac-paris.fr</code> ou <code class="tt">ac-versailles.fr</code>.
131
Pour les autres domaines, une demande devra vous être faite par mail.
132
 
7524 obado 133
Please notice that the webmaster (that is, you) always has the right to create virtual classes of any kind.
23 reyssat 134
 
135
:class class_quota wims_class_quota
136
Disk quota for virtual classes in Meg
137
int
138
1,1000
7763 bpr 139
This is the limit of disk space usage for each virtual class.
140
If a virtual class' disk space use reaches or exceeds this number in Megabytes,
141
the supervisor's homepage will get locked.
23 reyssat 142
 
225 guerimand 143
:class superclass_quota wims_superclass_quota
144
Disk quota for portal in Meg
145
int
146
1,2000
147
This is the limit of disk space usage for each portal on the server.
148
If a portal disk space use reaches or exceeds this number in Megabytes,
149
the supervisor's homepage will get locked.
150
 
23 reyssat 151
:class class_user_limit wims_class_user_limit
152
Limit of participants in each class
153
int
154
0,2000
155
 
10315 bpr 156
:housekeep backup_delete
15331 obado 157
Class destruction time in days
10315 bpr 158
int
159
100,2000
10325 bpr 160
Mettre un nombre de jours entre 100 et 2000.
161
Si vous indiquez un entier N, les classes archivées seront détruites N jours après la date de leur
162
archivage ou plutôt le premier du mois suivant.
10315 bpr 163
 
23 reyssat 164
:graphics default_ins_format ins_format
11887 obado 165
Format of dynamic graphics <span class="tt wims_warning">*</span>
23 reyssat 166
choice
167
gif, jpeg, png
7763 bpr 168
Sorry for png advocates, but gif is the most compatible format
7524 obado 169
especially if you can install softwares producing compressed gif files.
170
The second choice is jpeg. png still have some compatibility problems.
171
<p>Note also that animated graphics format is not affected by this setting.</p>
23 reyssat 172
 
173
:security,misc devel_modules
174
Access policy for modules under development
175
choice
176
open,close
7763 bpr 177
If set to <code class="tt">close</code>, modules under development cannot be accessed without authentication.
7524 obado 178
In particular exercises cannot be inserted into a
179
worksheet of a class since a participant is not authenticated as modtool developper.
23 reyssat 180
<p>
7763 bpr 181
It is highly recommended that you choose <code class="tt">close</code>, in order
23 reyssat 182
to avoid future problems. Module developers should be encouraged to
7763 bpr 183
publish their modules into local space in order to make them usable by others.
7728 bpr 184
</p>
23 reyssat 185
:class examlog_limit
186
Limit of registered exam sessions for each participant
187
int
188
0,100
7763 bpr 189
Please note that this is site-wide limitation.
190
Setups of individual classes cannot exceed this limit.
191
Registers of exam details may take up a lot of disk space,
192
so if this limit is too high, some very active classes may run
193
into disk quota problems.
194
<p>
195
If you set this limit to 0 or negative, no exam detail will be registered in
196
any virtual class.
197
</p>
23 reyssat 198
:tech tmp_debug wims_tmp_debug
199
Debugging mode
200
choice
3988 bpr 201
yes,no;$wims_name_yes,$wims_name_no
7524 obado 202
Turning on debugging mode allows some basic information to be shown
7728 bpr 203
at the bottom of most pages, when the query is from localhost.
23 reyssat 204
At the same time, the temporary session directory
205
(located down tmp/sessions/) will be conserved for examination. For
206
development use, as well as for troubleshooting the installation.
207
 
208
:graphics default_insplot_font insplot_font
7763 bpr 209
Font size of dynamic plot (gnuplot)
23 reyssat 210
choice
211
small,medium,large
7524 obado 212
This font size affects dynamic plots generated by gnuplot.
213
Individual modules may change this setting.
23 reyssat 214
 
215
:doc doc_quota wims_class_quota
216
Disk quota for Documents in Meg
217
int
218
1,1000
7763 bpr 219
This is the limit of disk space usage for each interactive document.
23 reyssat 220
If a document's disk space use reaches or exceeds this number in Megabytes,
221
further modification of the document will no longer be allowed.
222
 
223
:forum forum_limit wims_forum_limit
224
Limit of the number of forums
225
int
226
0,1000
227
 
228
:software gap_command
229
Command name for GAP
230
free
231
 
7524 obado 232
GAP is a group theoretic calculator used by WIMS.
233
If you install it in a directory according to its instructions, with an executable gap.sh within
3941 bpr 234
usual PATH, you do not need to touch this.
23 reyssat 235
 
236
:log general_log_limit
237
Length limit (in bytes) of main log files
238
int
239
0,102400000
240
Length limit of general log files (access.log, post.log, session.log).
241
 
877 guerimand 242
 
23 reyssat 243
:graphics gnuplot_format
11887 obado 244
Internal graphics format for gnuplot <span class="tt wims_warning">*</span>
23 reyssat 245
choice
246
gif,jpeg,png
247
Choose a format known to your gnuplot.
248
gnuplot is used for generating dynamic plottings. In
249
most recent distributions, gnuplot is not compiled for gif format.
250
 
251
:appearances home_module
11887 obado 252
Home (default) module <span class="tt wims_warning">!</span>
23 reyssat 253
free
254
 
255
This module is the entry point of the site. You should not change this
256
unless you have designed and put up your own home module.
257
 
7900 bpr 258
:appearances site_languages wims_site_languages
11887 obado 259
Supported languages <span class="tt wims_warning">*</span>
7900 bpr 260
free
261
 
262
Available languages:
263
ca (Catalan),
264
cn (Chinese gb),
265
de (German),
266
en (English),
267
es (Spanish),
268
fr (French),
269
it (Italian),
270
nl (Dutch),
271
si (Slovenian),
272
tw (Chinese gib5).
273
 
274
List them separated by white spaces.
275
<p>
276
The order of your listing is important: languages listed first will get more priority.
277
</p>
278
 
23 reyssat 279
:tech idle_time
280
Delay before an idle class session is killed
281
choice
282
600,1200,1800,2400,3600,5400,7200,10800,14400,18000;10 min,20 min, 30 min, 40 min, 1 hour,1.5 hours, 2 hours, 3 hours,4 hours, 5 hours
7524 obado 283
Reducing this may increase performance but slow visitors will find their sessions expired.
284
Usually an active user will touch his session at least once every 10 minutes, unless he is
23 reyssat 285
working on a very hard exercise (a fairly rare case). However, killing the
286
session of the latter will result in huge frustration. So be careful!
287
<p>
288
If exams will be carried out on your installation, please note that this
7524 obado 289
delay should exceed the time allowance of any exam sheet.</p>
23 reyssat 290
 
291
:tech idle_time2
292
Delay before an idle anonymous session is killed
293
choice
294
600,900,1200,1800,2400,3600,5400,7200,10800,14400,18000;10 min,15 min,20 min, 30 min, 40 min, 1 hour,1.5 hours, 2 hours, 3 hours,4 hours, 5 hours
7524 obado 295
Reducing this may increase performance but slow visitors will find their sessions expired.
296
Usually an active user will touch his session at least once every 10 minutes, unless he is
23 reyssat 297
working on a very hard exercise (a fairly rare case). If killing the
298
session of the latter will result in huge frustration, such activities
299
are less important when they are not in a virtual class.
7900 bpr 300
<p>
301
This delay only applies to sessions without authentication. It cannot be bigger than delay for class sessions.
302
</p>
23 reyssat 303
:tech idle_time3
304
Delay before an idle first-created session is killed
305
choice
306
300,360,480,600,720,900,1200,1800,2400,3600,7200;5 min,6 min,8 min,10 min,12 min,15 min,20 min, 30 min, 40 min, 1 hour,2 hours, 2 hours
7524 obado 307
If one creates a session without reusing it during this amount of seconds, the newly-created session will be removed.
23 reyssat 308
<p>
309
This delay only applies to sessions without authentication. Creating a
310
session without reusing it is usually a behavior of internet robots.
7763 bpr 311
</p><p>
312
This delay cannot be bigger than that for idle anonymous sessions.
7524 obado 313
</p>
23 reyssat 314
:tech mail_opt
315
Options for !mailto command
316
free
317
 
7524 obado 318
Add options to the system command "mail" when using the !mailto command.
319
See the sytem's mail manual for details of possible options.
23 reyssat 320
<p>
7486 bpr 321
For example, if your system's mail command supports this, you can use
7763 bpr 322
<code class="tt">-a "User-Agent: WIMS"</code> to add a User-Agent header to the mail sent
323
out by wims. Some providers require this to accept mails.
324
</p>
9395 bpr 325
 
23 reyssat 326
:security manager_https
11887 obado 327
Site maintenance must use https connection <span class="tt wims_warning">*</span>
23 reyssat 328
choice
7900 bpr 329
0,1;$wims_name_no,$wims_name_yes
7524 obado 330
Whenever possible, choose https connection to increase security.
331
An intrusion to your server as webmaster represents a great danger to your installation!
23 reyssat 332
<p>WIMS is compatible with https. All you have to do is to configure your
7524 obado 333
httpd so that it accepts https requests.</p>
23 reyssat 334
 
335
:security manager_site
11887 obado 336
Site maintenance connections must come from a site with this IP <span class="tt wims_warning">*</span>
23 reyssat 337
free
338
 
7524 obado 339
You may put here several IP numbers.
340
Partial numbers such as 134.59.10. are accepted, but be aware that the more there are allowed sites,
7528 bpr 341
the more will be your security risks.
7524 obado 342
The most secure site is 127.0.0.1 (localhost).
7528 bpr 343
In any case, choose only site(s) you can trust.
7524 obado 344
An intrusion to your server as webmaster represents a great danger to your installation!
23 reyssat 345
<p>
11887 obado 346
If you put a '*' to this field, the next time you will not be
23 reyssat 347
able to use this online maintenance tool (and you can be sure that nobody
7900 bpr 348
else will).
349
</p>
23 reyssat 350
:software maxima_command
4417 bpr 351
Command name for Maxima
23 reyssat 352
free
353
 
7763 bpr 354
You do not need to change this
355
if Maxima is installed in a usual way with the starting executable in PATH.
23 reyssat 356
 
357
:log module_log
358
Log individual module informations
359
choice
7900 bpr 360
1,0;$wims_name_no,$wims_name_yes
7528 bpr 361
Many WIMS modules define their own log informations.
7524 obado 362
If you want to see these module informations, you can activate this (see also the definition of
363
module log file lengths).
364
Attention however that these log files will end up by using up a fair amount of disk spaces,
365
as there are hundreds of logging modules.
23 reyssat 366
 
367
:log module_log_limit
368
Length limit (in bytes) of module log files
369
int
370
0,102400000
7524 obado 371
Length limit of module log files.
372
 There are some secondary general log files who also use this limit,
373
  so even if module log is set to no, this number still makes sense.
23 reyssat 374
 
7900 bpr 375
:housekeep site_accounting
376
Activity accounting
23 reyssat 377
choice
7900 bpr 378
0,1;$wims_name_yes,$wims_name_no
379
Enable or disable daily activity accounting.
380
This is necessary for site activity statistics, as well as for virtual class connection time accounting.
23 reyssat 381
 
3019 guerimand 382
:housekeep mu_download_site
23 reyssat 383
Download site for module update
3019 guerimand 384
checkbox
3030 guerimand 385
$mu_downloadsites
7524 obado 386
Choose a download site for module update.
387
Known mirror sites:
23 reyssat 388
<pre>
3080 bpr 389
$help_downloadsites
7524 obado 390
</pre>
391
<p>If you choose automatic module update with very small delay (0 or 1 day),
7900 bpr 392
you should set the download site to the primary mirror <code class="tt">$(mu_sites[1])</code>.
393
</p>
23 reyssat 394
 
3009 bpr 395
:housekeep mu_publish_site
396
$wims_name_publish_center
397
checkbox
398
$mu_publishsitesw
399
You can here choose the publication centers for ressource modules.
3030 guerimand 400
<pre>
3080 bpr 401
$help_publishsites
3030 guerimand 402
</pre>
3009 bpr 403
 
23 reyssat 404
:housekeep mu_delay
405
Delay in automatic module update
406
choice
407
0,1,2,4,7,10,15,20,30,50,100
7524 obado 408
The number of days between the publication of a module and the update by this site.
23 reyssat 409
<p>
410
Choosing a bigger value here will allow you to reduce the risk of getting
411
new bugs, because the latter will hopefully be discovered and corrected during
412
your delay.
7524 obado 413
</p>
23 reyssat 414
<p>
415
If you choose a very small number here (0 or 1), you should set
7763 bpr 416
the download site to the primary mirror <code class="tt">$(mu_sites[1])</code>.
417
</p>
23 reyssat 418
:housekeep mu_zone
419
Zones for automatic module update
420
free
421
 
7763 bpr 422
Limit the automatic module update to the given zones.
423
<code class="tt">all</code> means everything.
23 reyssat 424
<p>
425
Possible choices of zones: <dl>
7900 bpr 426
<dt><code class="tt">K</code>
427
    <dd>Kindergarten (you can fine-tune with K1 K2 K3)
7763 bpr 428
<dt><code class="tt">E</code>
23 reyssat 429
    <dd>Elementary school materials (you can fine-tune with E1 E2 E3 E4 E5 E6)
7763 bpr 430
<dt><code class="tt">H</code>
23 reyssat 431
    <dd>Middle school materials (you can fine-tune with H1 H2 H3 H4 H5 H6)
7763 bpr 432
<dt><code class="tt">U</code>
23 reyssat 433
    <dd>University teaching materials (you can fine-tune with U1 U2 U3 U4 U5)
7763 bpr 434
<dt><code class="tt">Lang</code>
23 reyssat 435
    <dd>Foreign language-learning materials
7763 bpr 436
<dt><code class="tt">tool</code>
23 reyssat 437
    <dd>Online tools and helpers.
438
</dl>
7900 bpr 439
</p><p>
23 reyssat 440
You can put several zones in this field, separated by white spaces.
441
 
442
:housekeep mu_cat
443
Categories for automatic module update
444
free
445
 
446
Limit the automatic module update to the given categories. "all" means everything.
447
<p>
448
Some choices of categories (non-exhaustive): <dl>
7763 bpr 449
<dt><code class="tt">math</code> resp. <code class="tt">physics chemistry language</code> etc.
23 reyssat 450
    <dd>Corresponding disciplines.
7763 bpr 451
<dt><code class="tt">cs</code>
23 reyssat 452
    <dd>Computer science.
453
</dl>
7900 bpr 454
<p><p>
23 reyssat 455
You can put several categories in this field, separated by white spaces.
7900 bpr 456
</p>
23 reyssat 457
:log old_log_files
11887 obado 458
Number of old log files <span class="tt wims_warning">*</span>
23 reyssat 459
int
460
0,20
7528 bpr 461
This is the number of rotated old log files.
7524 obado 462
Increasing this number will give you more historic information, while proportionally increase disk space use.
23 reyssat 463
 
464
:software pari_command
465
Command name for PARI/GP
466
free
467
 
7524 obado 468
PARI/GP is a number-theoretic calculator used by many WIMS modules.
469
If you follow its installation procedure with binary executable within usual PATH,
3941 bpr 470
you do not need to touch this.
23 reyssat 471
 
472
:resources priority
473
Sites with connection priority
474
free
475
 
7524 obado 476
Connections from these sites will not be refused when server load is above threshold.
477
$sitehelp
23 reyssat 478
 
479
:appearances page_bgcolor wims_bgcolor
480
Page background color
7763 bpr 481
color
23 reyssat 482
 
7524 obado 483
Background color of most WIMS pages.
484
Use a color name or #rrggbb hexadecimal code (see html standard for detail).
23 reyssat 485
 
486
:appearances page_bgimg wims_bgimg
487
Page background image file
488
free
489
 
490
Background image file (tile) for most WIMS pages. You may use any valid URL.
491
Take also a look in the directory public_html/gifs/bg which contains
492
some pre-defined background files. These files can be referenced simply by
493
their names, without any directory prefix.
7524 obado 494
<p>Here is the list of such directly usable background image files:</p>
7763 bpr 495
<pre>$bgimgs</pre>
23 reyssat 496
 
497
:tech,misc rafale_level
498
Anti-rapidfire severity
499
int
500
0,100
7524 obado 501
Rapid-fire requests of exercises without serious attempts to resolve them will generate errors.
502
This is one of the anti-cheating measures of the system.
23 reyssat 503
Higher severity level results in more requirements in time before new
7524 obado 504
exercises are allowed. Choosing the value of 0 or less for this severity will disable this measure.
23 reyssat 505
 
506
:appearances ref_bgcolor wims_ref_bgcolor
507
Table background color
7728 bpr 508
color
23 reyssat 509
 
7524 obado 510
Background color appearing in head menus and many WIMS administration modules.
511
Use a color name or #rrggbb hexadecimal code (see html standard for detail).
23 reyssat 512
 
2069 bpr 513
:appearances ref_menucolor wims_ref_menucolor
7486 bpr 514
Link color in menus and reference table.
7728 bpr 515
color
7524 obado 516
 
517
You can choose the color menu link  here.
518
This is possible only for "new themes", so not for default theme.
2250 reyssat 519
Choose it according to the table background color
2069 bpr 520
 
3064 bpr 521
:appearances ref_button_bgcolor wims_ref_button_bgcolor
522
Button background color
7728 bpr 523
color
7524 obado 524
 
525
You can choose the background color action buttons here.
526
This is possible only for "new themes", so not for default theme.
3065 bpr 527
Choose it according to the table background color
3064 bpr 528
 
529
:appearances ref_button_color wims_ref_button_color
530
Button color
7728 bpr 531
color
3064 bpr 532
 
7524 obado 533
You can choose the color of the text of action buttons here.
534
This is possible only for "new themes", it does not work perfectly for default theme.
535
 
3064 bpr 536
:appearances ref_button_help_bgcolor wims_ref_button_help_bgcolor
537
Help button background color
7728 bpr 538
color
3064 bpr 539
 
7524 obado 540
You can choose the  background color of help link buttons here.
541
This is possible only for "new themes", it does not work perfectly for default theme.
542
 
3064 bpr 543
:appearances ref_button_help_color wims_ref_button_help_color
544
Help button color
7728 bpr 545
color
3064 bpr 546
 
7524 obado 547
You can choose the color of the text of most of help link buttons here.
548
This is possible only for "new themes", it does not work perfectly for default theme.
549
 
1208 bpr 550
:appearances theme wims_theme
551
Presentation theme
552
choice
553
$themelist
7524 obado 554
You can choose the presentation theme here.
7763 bpr 555
<code class="tt">default</code> is the original theme.
556
 The theme <code class="tt">standard</code> allows a more configurable css style and icon theme.
1208 bpr 557
 
1364 bpr 558
:appearances theme_icon wims_theme_icon
559
Icon theme
560
choice
561
$iconlist
7524 obado 562
You can choose the icon presentation theme here.
563
This is possible only for "new themes", so not for default theme.
1364 bpr 564
 
23 reyssat 565
:appearances css wims_css
566
Style sheet
567
choice
568
$csslist
569
The style sheet affects almost all pages of the site.
570
<p>
7486 bpr 571
The available stylesheet (css) files are in
7763 bpr 572
<code class="tt">public_html/html/css/$lang</code>.
7524 obado 573
If you want more stylesheets, you can put new css files into this directory.
574
</p>
7763 bpr 575
<p>If you choose css=<code class="tt">-theme-</code>, the stylesheet of the current theme
7900 bpr 576
will be used. No stylesheet will be loaded if css=<code class="tt">----</code>.
577
</p>
23 reyssat 578
 
14523 bpr 579
:appearances frontmsg wims_frontmsg
580
Module de messages
581
free
582
 
583
Adresse d'un module de présentation dans la page d'accueil
584
 
23 reyssat 585
:resources rlimit_cpu
11887 obado 586
Processing time allowance in seconds <span class="tt wims_warning">*</span>
23 reyssat 587
int
588
1,10000
7524 obado 589
If a user request needs more time than this amount to process, the computation will be cut off and an error message will be sent back.
23 reyssat 590
It is useless to increase this number too much, because in normal
591
circumstances few internet users will wait more than a few dozens of
592
seconds for a page.
7900 bpr 593
<p>
594
This is also a very important security measure to check denial-of-service attacks.
595
</p>
23 reyssat 596
 
597
:appearances show_author wims_show_author
598
Show author names in search results
599
choice
7900 bpr 600
yes,no;$wims_name_yes,$wims_name_no
7524 obado 601
Do you want the author names to show up behind each module in the search results?
23 reyssat 602
 
603
:appearances show_stat wims_show_stat
604
Show site usage statistics
605
choice
7900 bpr 606
yes,no;$wims_name_yes,$wims_name_no
23 reyssat 607
Log accounting must be activated before statistics can be shown.
7524 obado 608
<p>To activate log accounting, you should run log/account.sh once every early
609
morning, by putting it into crontab.</p>
23 reyssat 610
 
7900 bpr 611
:housekeep mu_auto
612
Module update method
23 reyssat 613
choice
7900 bpr 614
none,check,install,update,all
615
Method of automatic daily module update.
616
<dl>
617
<dt><code class="tt">none</code>
618
   <dd>Disable automatic module update.
619
<dt><code class="tt">check</code>
620
   <dd>Check what should be updated, and send a mail to webmaster (that
621
   is, you). Do not install or update anything.
622
<dt><code class="tt">install</code>
623
   <dd>Install new modules, but not update existing modules.
624
<dt><code class="tt">update</code>
625
   <dd>Update existing modules, but not install new modules. <br />
626
   This will let you benefit from bug fixes, as well as suffer from
627
   newly introduced ones.
628
<dt><code class="tt">all</code>
629
   <dd>Install new modules and update existing ones.
630
</dl>
23 reyssat 631
 
632
:misc site_description wims_site_description
633
Site description
634
free
635
 
7524 obado 636
This description text is put in the header of every page rendered by the server.
637
Its main purpose is to inform internet robots.
23 reyssat 638
<p>
639
Modules will also have access to this text via the variable
640
$$wims_site_description.
7524 obado 641
</p>
23 reyssat 642
 
15331 obado 643
:misc site_keywords wims_site_keywords
23 reyssat 644
Site keywords
645
free
646
 
647
This is a general keyword list which will be put to the header of every page
648
rendered by the server, appended by the keyword list of the module. Its main
649
purpose is to make the server better referenced by internet robots (hence
650
search engines).
651
<p>
652
Modules will also have access to this text via the variable
653
$$wims_site_keywords.
7524 obado 654
</p>
23 reyssat 655
 
15331 obado 656
:misc site_hostname wims_site_hostname
657
Public host name
658
free
659
 
660
Allows to customize the name of the server (if different from the hostname).
661
<p>If you installed your server behind a proxy
662
 (to do load balancing for example),
663
 the hostname of the machine will be different from the one displayed to users.</p>
664
<p>In this case, indicate here the public hostname,
665
  which will for example be used in scheduled tasks
666
  (update of modules, deletion of expired classes ...)</p>
667
<p>Enter only the name of the server (for example "wims.wimsedu.info", without "https: //").</p>
668
 
23 reyssat 669
:appearances site_manager wims_site_manager
11887 obado 670
Your email address <span class="tt wims_warning">*</span>
23 reyssat 671
free
672
 
7486 bpr 673
This will be given as the email address of the webmaster. It is to this
23 reyssat 674
address that visitors and users of the server will report server problems.
675
<p>
676
You must change the default value $DF_site_manager to YOUR email address, if
3941 bpr 677
you do not read messages sent to $DF_site_manager.
7524 obado 678
</p>
679
<p>Modules will also have access to this text via the variable $$wims_site_manager.</p>
23 reyssat 680
 
681
:graphics texbasesize
11887 obado 682
Default TeX font size step <span class="tt wims_warning">*</span>
23 reyssat 683
choice
684
0,1,2,3,4,5,6,7,8,9,10
7524 obado 685
This is the defaut font size in the graphics pictures generated by TeX
7763 bpr 686
(that is, mathematics formulas).
687
This default size should be set to meet the text
23 reyssat 688
font size of the browser of average visitors. The latter can change this
689
size to better fit their situation, but this change is not saved from one
690
session to another, except for virtual class users.
691
<p>
3941 bpr 692
Do not adjust this font size only according to your own browser! Think of
23 reyssat 693
others who may have different font sizes in their browsers.
7524 obado 694
</p>
695
<p>Each step increases (decreases) 9% of the linear size of the font.</p>
23 reyssat 696
 
697
:resources threshold1
698
First load threshold
699
int
700
10,500
7524 obado 701
If the server load average (as reported by `w', `uptime' or `top') exceeds this value times 0.01, visitors outside a virtual class will be refused access.
702
<p>The time allowance for each request will also be reduced if the server load approaches this value.</p>
23 reyssat 703
 
704
:resources threshold2
705
Second load threshold
706
int
707
10,500
7524 obado 708
If the server load average (as reported by `w', `uptime' or `top') exceeds this value times 0.01, visitors not from priority sites will be refused access.
709
<p>This value should normally be larger than the first load threshold.</p>
23 reyssat 710
 
711
:security trusted_modules
712
List of trusted modules
713
free
714
 
715
A trusted module may use administrative commands prohibited to usual modules.
716
These commands allow the module to modify or view server informations
717
usually hidden to the public. For security reasons, only administration
718
modules and modules written
719
by trusted authors can have access to these commands.
720
<p>
721
Administration modules (in the subdirectory adm/) and the home module are
722
automatically trusted. If you want to add other modules to this list, add
723
their addresses (the part after `module=' in the http request string) into
724
this field, separated by white spaces.
7524 obado 725
</p>
726
<p>Avoid defining trusted modules unless you are really sure of what you are doing.</p>
23 reyssat 727
 
728
:class user_limit wims_user_limit
729
Limit of the total number of users in all classes
730
int
731
10,100000
7524 obado 732
Each time a new participant registration occurs, the sum of existing participants to all the virtual classes will be computed.
733
If this sum exceeds the limit, registration will fail.
23 reyssat 734
 
735
:resources workfile_limit
736
Length limit of data files
737
int
738
10000,100000000
7524 obado 739
This limit applies to many files, including script files in modules
740
as well as data file for participant works. So do not set it too small.
23 reyssat 741
 
742
:misc usecookie wims_usecookie
743
Cookie for anonymous visitors
744
choice
7900 bpr 745
yes,no;$wims_name_yes,$wims_name_no
7524 obado 746
If you choose `yes', the server will send cookies to anonymous visitors, which helps tracking the user.
23 reyssat 747
<p>
748
Note that cookies are not mandatory: even if
749
the visitor disables cookies, he will still be able to work normally on WIMS.
750
The main difference is that cookies can help them to keep their
2872 reyssat 751
personal preferences longer, and can improve server performance by
23 reyssat 752
eliminating unnecessary session creations.
7524 obado 753
</p>
754
<p>The use of cookies for works in virtual classes is not affected by this parameter.</p>
23 reyssat 755
 
877 guerimand 756
:log show_ip
15418 bpr 757
Show user IP and user times to supervisor in class logfile
877 guerimand 758
choice
7900 bpr 759
yes,no;$wims_name_yes,$wims_name_no
15418 bpr 760
if no, supervisor cannot see IP and times in logfile.
910 bpr 761
 
4504 bpr 762
:software scilab_command
763
Command name for Scilab
764
free
765
 
4615 bpr 766
Scilab
767
 
5015 bpr 768
:auth cas_auth
769
Hôte CAS
770
free
771
 
5597 reyssat 772
These values will be used as default in classes allowing CAS authentication.
12041 bpr 773
In the case of several CAS authentifications, separate them by <code>|</code>;
774
You can write also the names seen by the teachers, for example
775
<pre>
776
https://url1, site1 | https://url2, site2
5597 reyssat 777
 
5024 bpr 778
:auth php_auth
15331 obado 779
Address of a PHP script
5024 bpr 780
free
781
 
5597 reyssat 782
These values will be used as default in classes allowing PHP script authentication.
5024 bpr 783
 
5015 bpr 784
:auth ldap_auth
4615 bpr 785
LDAP host
4661 bpr 786
free
4615 bpr 787
 
5597 reyssat 788
These values will be used as default in classes allowing LDAP authentication.
7524 obado 789
 
4615 bpr 790
:auth ldap_port
791
LDAP Port
792
free
793
 
5597 reyssat 794
These values will be used as default in classes allowing LDAP authentication.
795
 
4615 bpr 796
:auth ldap_version
797
LDAP Version
798
free
799
 
5597 reyssat 800
These values will be used as default in classes allowing LDAP authentication.
801
 
4615 bpr 802
:auth ldap_base
803
LDAP Base
804
free
805
 
5597 reyssat 806
These values will be used as default in classes allowing LDAP authentication.
807
 
4615 bpr 808
:auth ldap_branch
809
LDAP Branch
810
free
811
 
5597 reyssat 812
These values will be used as default in classes allowing LDAP authentication.
813
 
4615 bpr 814
:auth ldap_uid
815
LDAP identifier
816
free
817
 
818
It is the login used by the ldap. The participant must enter it as login.
5597 reyssat 819
These values will be used as default in classes allowing LDAP authentication.
820
 
4615 bpr 821
:auth ldap_login
822
WIMS login
823
free
824
 
825
The login will be used by wims in its internal structure (must be alphanumeric and with less 8 characters)
5597 reyssat 826
These values will be used as default in classes allowing LDAP authentication.
7524 obado 827
 
5024 bpr 828
:auth ldap_email
829
LDAP email
830
free
4836 bpr 831
 
5597 reyssat 832
These values will be used as default in classes allowing LDAP registration.
7524 obado 833
 
5024 bpr 834
:auth ldap_photourl
835
LDAP Photo
836
free
837
 
5597 reyssat 838
These values will be used as default in classes allowing LDAP registration.
7524 obado 839
 
5024 bpr 840
:auth ldap_regnum
841
LDAP Inscription number
842
free
843
 
5597 reyssat 844
These values will be used as default in classes allowing LDAP registration.
845
 
4836 bpr 846
:appearances site_logo
847
Address of an institutional logo
848
free
849
 
850
:appearances site_logolink
851
External link on the institutional logo
6475 bpr 852
free
853
 
854
:tech validator_address
855
Address of a w3c-validator
856
free
857
 
858
For example, http://validator.w3.org/check
6688 guerimand 859
 
10075 bpr 860
:software octave_command
15331 obado 861
Octave access command
10075 bpr 862
free
863
 
864
GNU Octave is a high-level language, primarily intended for numerical computations.
865
It provides a convenient command line interface for solving linear
866
and nonlinear problems numerically,
867
and for performing other numerical experiments using a language
868
that is mostly compatible with Matlab.
869
 
6688 guerimand 870
:software QRencode_command
871
command for QRcode picture
872
free
873
 
7486 bpr 874
generate QRcode.
7728 bpr 875
 
876
:tech classification_open
15331 obado 877
Possibility for a teacher to classify the OEF exercises.
7728 bpr 878
choice
879
no,yes;$wims_name_no,$wims_name_yes
15331 obado 880
If you activate this, it will be possible for the teachers of a class
881
 to put keywords (freely or according to a taxonomy) in exercises
882
 in order to improve the search engines.
883
You must get in touch with
884
 the WIMS EDU association <referencement@wimsedu.info>
885
 so that this data can then be used.
14321 guerimand 886
 
887
:optionalmod allowed_optional_module
15331 obado 888
Activation of optional modules
14321 guerimand 889
checkbox
890
class/freeworks;Devoir libre
15331 obado 891
Choose the optional modules you want to activate