tagging as ATutor 1.5.4-release
[atutor.git] / documentation / admin / system_preferences.php
1 <?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate$'; ?>
2
3         <h2>System Preferences</h2>
4                 <dl>
5                         <dt>Site Name</dt>
6                         <dd>The name of the course server's website. This name will appear at the top of all the public pages, in the web browser's title bar, and as the <em>From</em> name when sending non-personal emails.</dd>
7
8                         <dt>Home <acronym title="Uniform Resource Locator, a site's address">URL</acronym></dt>
9                         <dd>This will be the web address for the 'Home' link in the public area. Leave empty to remove this link.</dd>
10
11                         <dt>Default Language</dt>
12                         <dd>The default language to use if the client's browser settings cannot be detected. Must be one of the languages already installed. See the <a href="languages.php">Languages</a> section on installing and managing existing languages.</dd>
13
14                         <dt>Contact Email</dt>
15                         <dd>The reply address used for emails sent for instructor requests and other system emails.</dd>
16
17                         <dt>Time Zone</dt>
18                         <dd>Changing ATutor's time zone to one other than that specific by the server requires MySQL 4.1.3+. Additionally, MySQL's time zone tables must be loaded; see <a href="http://dev.mysql.com/doc/refman/4.1/en/time-zone-support.html" target="_new">MySQL Server Time Zone Support</a> for additional details. This option is available in ATutor 1.5.3.3+.</dd>
19
20                         <dt>Maximum File Size</dt>
21                         <dd>Maximum allowable file size in Bytes that can be uploaded to the course's File Manager. This does not override the value set for <kbd>upload_max_filesize</kbd> in <kbd>php.ini</kbd>.</dd>
22
23                         <dt>Maximum Course Size</dt>
24                         <dd>Total maximum allowable course size in Bytes. This is the total amount of space a course's File Manager can use.</dd>
25
26                         <dt>Maximum Course Float</dt>
27                         <dd>How much a course can be over its <em>Maximum Course Size</em> limit while still allowing a file to upload or import. Makes the course limit actually be <em>Max Course Size</em> + <em>Max Course Float</em>. When <em>Max Course Float</em> is reached, no more uploads will be allowed for that course until files are deleted and the course's space usage falls under the Maximum Course Size.</dd>
28
29                         <dt>Display Name Format</dt>
30                         <dd>The Display Name Format option controls how non-administrator users' names appear. This option is available in ATutor 1.5.4+.</dd>
31
32                         <dt>Authenticate Against A Master Student List</dt>
33                         <dd>Whether or not to enable Master Student List authentication. If enabled, only new accounts that validate against the master list will be created. See the <a href="master_student_list.php">Master Student List</a> section for additional details on using this feature.</dd>
34
35                         <dt>Require Email Confirmation Upon Registration</dt>
36                         <dd>If  email confirmation is enabled, before they can login, registrants must confirm their registration by replying to a message sent to the email address they registered with.  </dd>
37
38                         <dt>Allow Instructor Requests</dt>
39                         <dd>If enabled, students will be allowed to request that their account be upgraded to an instructor account. Instructor account requests must be approved by administrators using the <a href="instructor_requests.php">Instructor Requests</a> section. If disabled then the <em>Create Course</em> link used for requesting an instructor account will be removed and only the administrators will be able to create instructor accounts.</dd>
40
41                         <dt>Instructor Request Email Notification</dt>
42                         <dd>If enabled, and if <em>Allow Instructor Requests</em> is enabled, then an email notification message will be sent to the <em>Contact Email</em> each time a new instructor account request is made. This does not affect whether or not instructor requests can be made, only whether or not a notification message is sent out each time.</dd>
43
44                         <dt>Auto Approve Instructor Requests</dt>
45                         <dd>If <em>Allow Instructor Requests</em> is enabled, then existing students requesting instructor accounts will be upgraded automatically, bypassing the approval process. Additionally, any newly created accounts will be created as instructors rather than as students. Useful for setting up a demo version of ATutor. </dd>
46
47                         <dt>Theme Specific Categories</dt>
48                         <dd>Theme specific categories allows for the association between themes and categories. Courses belonging to a specific category will always be presented using that category's associated theme. This option disables the personalised theme preference. Use the <a href="categories.php">Categories</a> section to create and manage course categories, and the <a href="themes.php">Themes</a> section to install and manage themes.</dd>
49
50                         <dt>User Contributed Handbook Notes</dt>
51                         <dd>If enabled will allow anyone viewing the Handbook to contribute notes. User contributed notes must then be approved by an administrator by logging in on the main Handbook page. This option is available in ATutor 1.5.1+.</dd>
52
53                         <dt>Illegal File Extensions</dt>
54                         <dd>A list of all the file types, by extension, that are not allowed to be stored on the server. Any file that is being imported or uploaded with an extension in the specified list will be ignored and not saved. The list must contain only the file extensions seperated by commas without the leading dot.</dd>
55
56                         <dt>Cache Directory</dt>
57                         <dd>Where cached data is stored. On a Windows machine the path should look like <kbd>C:\Windows\temp\</kbd>, while on Unix it should look like <kbd>/tmp/cache/</kbd>. On some Linux/Unix based systems, a shared memory device can also be used <kbd>/dev/shm/</kbd> if it is available.  Leave empty to disable caching.</dd>
58
59                         <dt>Course Backups</dt>
60                         <dd>The maximum number of backups that can be stored per course. The stored backups do not count towards the course's <em>Max Course Size</em>.</dd>
61
62                         <dt>Number of Days to Keep Copied Sent Messages for</dt>
63                         <dd>All sent messages are copied to the sender's <em>Sent Messages</em> area. This option specifies the number of days old a copied message has to be before it is automatically deleted. The recipient's message is not affected.</dd>
64
65                         <dt>Check for ATutor Updates Automatically</dt>
66                         <dd>If enabled, ATutor will check the atutor.ca web site for updates whenever the administrator logs in. This option is available since ATutor 1.5.2.</dd>
67
68                         <dt>Maintain File Storage Version Control</dt>
69                         <dd>If enabled, every file revision in the File Storage area will be saved. If space is a concern, the administrator may wish to disable this feature.</dd>
70
71                         <dt>Enable Mail Queue</dt>
72                         <dd>The administrator may wish to set up a <a href="cron_setup.php">cron job</a> (automated event scheduler) for email. If enabled, and if the cron has been set up, system email will be sent out at a certain time instead of immediately. This can help speed up email capable features where a slower mail server is being used.</dd>
73
74                         <dt>Automatically Install New Language Packs</dt>
75                         <dd>If enabled, and if the <a href="cron_setup.php">cron job</a> (automated event scheduler) has been set up, new language packs published on atutor.ca will be imported automatically This option is available in ATutor 1.5.3.2+.</dd>
76                 </dl>
77
78 <?php require('../common/body_footer.inc.php'); ?>