config_site.rst 63.8 KB
Newer Older
1
2
.. include:: /shortcuts.rstext

3
.. index::
4
   pair: Administration; Configure site
Kristina Hoeppner's avatar
Kristina Hoeppner committed
5
   single: Site administrator; Configure site
6
7
8
9
10
11

.. _configure_site:

Configure site
----------------

12
*Administration → Configure site*
13

14
.. note::
15
   *Configure site* is only accessible by site administrators.
16

17
18
19
20
21
In *Configure site* you can:

* set general parameters for your Mahara site
* edit site pages
* determine the display of certain menu items
22
* allow networking with Moodle or another Mahara
23
24
* create and share site pages and collections
* upload site files
25

26
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
27
28
   pair: Administration; Site options
   single: Site administrator; Site options
29

30
31
32
33
34
.. _site_options:

Site options
~~~~~~~~~~~~~~~~~~

35
*Administration → Configure site → Site options*
36

37
In *Site options* you can set global options that will apply by default throughout the entire site.
38
39

.. note::
40
    One or more fields may be disabled if overridden by a setting in your config.php file.
41

Kristina Hoeppner's avatar
Kristina Hoeppner committed
42
43
When you are done editing one or more settings, click the *Update site options* button at the bottom of the page.

44
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
45
46
   pair: Administration; Site settings
   single: Site administrator; Site settings
47
   single: Drop-down site navigation
48

49
50
51
52
53
.. _site_settings:

Site settings
^^^^^^^^^^^^^^^^^^^

54
.. figure:: /images/administration/site_settings.*
55
56
57
58
   :alt: Site settings

   Site settings

59
#. **Site name**: Choose a name for your Mahara instance. It appears in certain places around the site, e.g. in the title bar of the browser and in emails sent from the site. Therefore, it should not be too long.
60
#. **Language**: Set the default language for your site. If you have multiple language packs installed, you see a drop-down menu. Otherwise, the standard language, English, is displayed.
61
62
63
64

   .. note::
      You can install more `language packs <http://langpacks.mahara.org/>`_. `More information about the language packs <https://wiki.mahara.org/index.php/Language_Packs>`_ is on the wiki.

65
#. **Country**: The country selected is the default for country selections throughout your Mahara installation, e.g. in :ref:`contact information <contact_info>`.
66
#. **Theme**: Mahara comes with a number of themes that you can use. Choose one from the drop-down menu to make it the default theme for your site. If you have :ref:`institutions <site_admin_institutions>` set up, they can :ref:`choose their own theme <add_institution>`. You can `search for community-contributed themes <https://wiki.mahara.org/index.php/Themes/Contributed_themes>`_ on the Mahara wiki.
67
68
69
#. **Drop-down navigation**: If set to "Yes", the main Mahara navigation uses a drop-down menu for its subnavigation.
#. **Show homepage / dashboard information**: If set to "Yes", information about Mahara and how it is used is displayed on the homepage for logged-out and on the *Dashboard* for registered users. Registered users can disable this for their own dashboard. See also :ref:`Quick links <dashboard_quick_links>`.
#. **Send weekly updates?**: If set to "Yes", your site sends weekly updates to `mahara.org <http://mahara.org>`_ with some statistics about your site. See also :ref:`Register your Mahara site <mahara_registration>`.
70

71
.. index:: Gravatar
Kristina Hoeppner's avatar
Kristina Hoeppner committed
72
73
   pair: Administration; User settings
   single: Site administrator; User settings
74
75
   single: Logged-in profile page access
   single: Staff report access
76
77
78
   single: Staff statistics access setting
   single: Device detection
   single: Responsive design
79
80
   single: Masquerading: Require reason
   single: Masquerading: Notify user
81

82
.. _user_settings:
83
.. _staff_report_access:
84
.. _staff_statistics_access:
85
86
.. _masquerading_reason_setting:
.. _masquerading_notification_setting:
87
.. _profile_completion_siteadmin:
88
.. _export_to_queue:
89
.. _anonymous_feedback:
90
91
92
93

User settings
^^^^^^^^^^^^^^^^^^

94
.. figure:: /images/administration/user_settings.*
95
96
97
98
   :alt: User settings

   User settings

99
#. **Users can choose page themes**: If this setting is enabled, users can select a theme for their portfolio page. The page is displayed with this theme to other users. Thus, the institution or site theme can be overwritten.
100
#. **Display remote avatars**: If allowed, users' default profile pictures will be their `Gravatar <http://gravatar.com>`_ pictures (:ref:`remote avatar <remote_avatar>`). Users will need an account with Gravatar for this to work.
101
102

   .. note::
103
      If you use your own avatar server to provide profile pictures for your users, you can use that instead of Gravatar for the default profile pictures. In order to do so, you need to add the :ref:`remote avatar base URL <config_variable_remoteavatarbaseurl>` to your config.php.
104

105
#. **Users can hide real names**: If allowed, users who have set a :ref:`display name <about_me>` may choose to be searchable only by their display name and will not be found in searches by their real name. In the administration section of the site, users are always searchable by their real names. An administrator (site and institution) always sees the display name, first and last name and username.
106
#. **Never display usernames**: :index:`If set <single: User settings; Never display usernames>` to "Yes", ordinary users cannot search for others using their username in "Search users" on the :ref:`Dashboard <dashboard>` or via :ref:`Find people <find_people>`. They will also not be able to see the username of any other user. These restrictions do not apply to staff and administrators. Additionally, Clean URLs (if activated) for profile pages will be generated using display names (if provided) or real names, rather than usernames.
107
#. **Show users in public search**: If allowed, :index:`usernames can appear in public search results <Administration; Show users in public search>`. In addition, this feature needs to have the `value <single: config.php; publicsearchallowed>` ``$cfg->publicsearchallowed = true;`` set in your config.php file and requires a search plugin that allows public search, e.g. Elasticsearch.
108
109
110
111

   .. note::
      When you change this setting, you need to re-index the search index for the change to take effect.

112
#. **Anonymous comments**: :index:`If allowed <single: Feedback; Anonymous feedback>`, logged-out users / users without a login can leave comments on public pages or pages they can access via a secret URL.
113
#. **Profile access for all registered users**: If this option is set to "No", profile pages are initially viewable by all registered users, but the owner is allowed to restrict access to their institution only if they wish. Enable this option if you want to make sure all users can see each others' profile pages. Profiles of institution members will always be visible to other members of the same institution.
114
115
116
117
118
119
120
#. **Access reports for staff**: :index:`If <single:Configure site; Staff report access>` set to "Yes", site and institution staff will have :ref:`access to user reports <People_reports>`. The following reports are available to them:

   * Masquerading sessions (if logging of these is turned on)
   * Portfolio access
   * User details

#. **All reports for institution staff**: If set to "Yes", institution staff will have access to all reports in their institutions. This is normally restricted to administrators and site staff.
121
122
123
#. **Users can disable device detection**: If allowed, users can disable mobile device detection in their :ref:`account settings <general_account_options>`. This allows them to be more flexible in what they can view and do on a mobile device such as a smartphone or tablet.
#. **Require reason for masquerading**: If set to "Yes", administrators will be required to enter a reason for :ref:`masquerading as other users <login_as>`. This will be logged, and if the setting "Notify users of masquerading" is enabled, included in the notification to the user about the masquerading. This setting needs :ref:`logging <logging_settings>` to be turned on.
#. **Notify users of masquerading**: If set to "Yes", users will be notified :ref:`when an administrator masqueraded as them <login_as>`. The notification will include who, when and - if enabled under "Require reason for masquerading" - why. This setting needs :ref:`logging <logging_settings>` to be turned on.
124
#. **Show profile completion**: If set to "Yes", :index:`a progress bar with tips <single: Profile completion activation>` about what to complete in the user profile will be displayed in the sidebar to users. They can disable it in their :ref:`account settings <general_account_options>`.
125
126

   .. seealso::
127
      Administrators can configure the items that count towards profile completion in *Administration → Institutions →* :ref:`Profile completion <profile_completion>`.
128

129
#. **Export to queue**: :index:`If allowed <single: Use export queue for personal portfolio export (experimental)>`, the export queue will handle the exporting of user portfolios via Leap2A for better server load management.
130
131
132
133

   .. note::
      **This feature is still experimental.** Turning this feature on will export individual portfolios in *Portfolio → Export* via the export queue. That means that the export is made when there are enough system resources available. The user exporting a portfolio will receive an email when the export is ready for download.

134
#. **Multiple journals**: If allowed, :index:`all users <single: User settings; Allow multiple journals for everyone per default>` will have multiple journals per default. They can still change that setting in their personal account settings.
135

136
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
137
138
   pair: Administration; Search settings
   single: Site administrator; Search settings
139

140
141
142
143
144
145
146
.. _search_settings:

Search settings
^^^^^^^^^^^^^^^^^^

Mahara comes with a search plugin that allows you to search for users and pages. If you install another search plugin, you will be able to select which one to use for your site.

147
.. figure:: /images/administration/search_settings.*
148
149
150
151
   :alt: Search settings

   Search settings

152
153
.. seealso::
   You can configure the internal search plugin in the :ref:`administration of the search plugin <plugin_search>`.
154

155
156
157
158
159
Elasicsearch is another search plugin that is supported by Mahara out of the box. The search server will need to be installed separately though. Elasticsearch is useful for fulltext search and is required for |new in Mahara 17.10| advanced reporting.

.. note::
   You need to choose the Elasticsearch plugin if you turn on :ref:`"Event log reporting" <logging_settings>`.

160
.. index:: Public group, Group category
Kristina Hoeppner's avatar
Kristina Hoeppner committed
161
162
   pair: Administration; Group settings
   single: Site administrator; Group settings
163

164
165
166
167
168
169
170
.. _group_settings:

Group settings
^^^^^^^^^^^^^^^^^^^^

Mahara cannot only be used for individual work but also to work collaboratively in groups. Some settings are available in that area.

171
.. figure:: /images/administration/group_settings.*
172
173
174
175
   :alt: Group settings

   Group settings

176
#. **Create groups**: You decide whether administrators, administrators and staff or everyone can create groups. The default setting is the most permissive "everyone" because Mahara is user-centered and gives the individual users a great deal of control over what they want to do. If you choose to limit the group creation to administrators (and staff), these need to be contacted to set up groups. There is no internal group request system.
177
#. **Create public groups**: Choose whether everyone or only administrators can create :ref:`public groups <public_group>`. These are groups for which you do not need to be a member of the group or even have a login for Mahara to view the group homepage, discussion forums (and member listing if the group administrator allowed that).
178
#. **Allow group categories**: If allowed, site administrators can create categories for users to assign to their groups. These categories can be used to filter groups in :ref:`My groups <my_groups>` and :ref:`Find groups <find_groups>`.
179

180
.. seealso::
181
   Group categories are managed by site administrators in the :ref:`groups area <group_categories>` of the administration.
182

183
.. index:: Multiple institutions; Institution expiry; Auto-suspend expired institutions
Kristina Hoeppner's avatar
Kristina Hoeppner committed
184
185
   pair: Administration; Institution settings
   single: Site administrator; Institution settings
186

Kristina Hoeppner's avatar
Kristina Hoeppner committed
187
188
.. _institution_settings:

189
Institution settings
Kristina Hoeppner's avatar
Kristina Hoeppner committed
190
^^^^^^^^^^^^^^^^^^^^^^^^
191
192
193

You can use Mahara with multiple institutions and separate them for administrative purposes, e.g. user management and permissions, and to give them a different theme.

194
.. figure:: /images/administration/institution_settings.*
195
196
197
198
   :alt: Institution settings

   Institution settings

199
200
201
202
203
204
#. **Confirm registration**: :index:`If set to "Yes", administrators <single: Confirm registration site-wide>` cannot make the *Confirm registration* setting optional when :ref:`configuring an institution <add_institution>`. This prevents institution administrators from disabling this setting when it is required site-wide to not allow user accounts to be created without administrator approval.
#. **Users allowed multiple institutions**: If allowed, users can be members of several institutions at the same time. Thus, a user who belongs to two or more institutions only needs one account.

   .. note::
      While this is a convenient setting for people who need to be institution administrators in multiple institutions and cannot receive site administrator permissions, it is recommended that users can only belong to one institution.

205
#. **Warning time for institution expiry**: If set, a notification will be sent to site and institution administrators this amount of time before an institution is due to expire and be suspended. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, institutions will not expire by default.
206
#. **Auto-suspend expired institutions**: If set to "Yes", this option will allow Mahara to automatically suspend an institution that has expired automatically. This means that users of that institution will not be able to log in until the institution has been unsuspended.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
207

208
.. index:: Default account lifetime, Default account inactivity time, Session lifetime, Warning time for inactivity / expiry
Kristina Hoeppner's avatar
Kristina Hoeppner committed
209
210
   pair: Administration; Account settings
   single: Site administrator; Account settings
211
212
   single: Account settings; Default registration expiry lifetime
   single: Account settings; Override user account lifetime
213

Kristina Hoeppner's avatar
Kristina Hoeppner committed
214
215
216
217
218
.. _config_site_account_settings:

Account settings
^^^^^^^^^^^^^^^^^^^^^^

219
.. figure:: /images/administration/account_settings.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
220
221
222
223
224
   :alt: Account settings

   Account settings

#. **Session lifetime**: For security reasons, after a specified period of inactivity, a user will be logged off the site automatically. This field specifies this time in minutes. The default value is 1440 minutes (24 hours).
225
#. **Default registration expiry lifetime**: As site administrator you can decide when :ref:`pending registrations <pending_registrations>` that require approval expire. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, pending registrations will not expire by default. The default value is 2 weeks.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
226
#. **Default account lifetime**: If set, user accounts will expire after this amount of time from when they were created. When a user account is expired, the user cannot log in. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, accounts will not expire by default.
227
#. **Override user account lifetime**: Choose for which accounts a :index:`change in the default account lifetime <single: Override user account lifetime>` shall take effect:
228
229
230
231
232
233
234
235

   * Only for newly created users
   * For new users and users without an account lifetime already set (excluding site administrators)
   * For all user accounts (excluding site administrators)

   .. note::
      Site administrators are always excluded from a change in the account lifetime as they should always have access to the system.

Kristina Hoeppner's avatar
Kristina Hoeppner committed
236
237
238
#. **Default account inactivity time**: If set, users who do not log in for this amount of time will be considered "inactive" and will not be able to log in anymore. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, users are not set to "inactive" by default.
#. **Warning time for inactivity / expiry**: If set, a warning message will be sent to users this amount of time before their accounts are due to expire or become inactive. This time may be specified in days, weeks, months, years or "No end date". If the latter is chosen, users do not receive a warning before their account expires or they are flagged as having an inactive account.

239
.. index:: Virus checking, ClamAV, Anti-spam, External resources in HTML
Kristina Hoeppner's avatar
Kristina Hoeppner committed
240
241
   pair: Administration; Security settings
   single: Site administrator; Security settings
242
   single: Spam protection; reCAPTCHA
243

Kristina Hoeppner's avatar
Kristina Hoeppner committed
244
245
246
247
248
.. _security_settings:

Security settings
^^^^^^^^^^^^^^^^^^^^^

249
.. figure:: /images/administration/security_settings.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
250
251
252
253
   :alt: Security settings

   Security settings

254
#. **Virus checking**: If you want all files that are uploaded by users to be run through the ClamAV virus scanner, you should turn the virus checking option on. You have to have `ClamAV <http://www.clamav.net/>`_ installed on your server.
255
#. **Path to ClamAV**: For security reasons, the :index:`path to ClamAV <single: Security settings; Path to ClamAV>` on your server needs to be provided in the :ref:`config file <config_variable_pathtoclam>`. You see the path here if you provided that config value.
256
#. **Anti-spam**: There are three levels of anti-spam protection available for publicly visible forms such as the contact and registration forms. A form submission is never silently rejected. Rather, an error message is displayed asking the user to try again if the submission is classified as spam. The three choices are:
Kristina Hoeppner's avatar
Kristina Hoeppner committed
257
258
259

   * **None**: No anti-spam checks are performed on form submissions.
   * **Simple**: Some basic checks are performed. Form submissions with email addresses that are not well-formed or that have an excessive number of URLs are rejected.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
260
   * **Advanced**: Performs additional checks to determine whether email addresses are real or contain URLs that are blacklisted. This requires an Internet connection.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
261

262
263
264
#. **Spamhaus URL blacklist**: If set to "Yes", URLs will be checked against the Spamhaus DNSBL. The `Spamhaus Project <http://www.spamhaus.org>`_ provides a URL blacklist that is free for non-commercial, low-traffic use. A professional use datafeed service is also available but not supported in Mahara. Please read the `Spamhaus DNSBL usage terms <http://www.spamhaus.org/organization/dnsblusage.html>`_ before enabling this option.
#. **SURBL URL blacklist**: If set to "Yes", URLs will be checked against the SURBL DNSBL. `SURBL <http://www.surbl.org>`_ provides a URL blacklist that is free for organizations with fewer than 1000 users. A professional use datafeed service is also available, but not supported in Mahara. Please read the `SURBL usage terms <http://www.surbl.org/usage-policy.html>`_ before enabling this option.
#. **Disable external resources in user HTML**: Turning this option on will prevent users from embedding external resources such as images from remote sites into their forum posts and other HTML content. YouTube videos and other media can also not be embedded. It is however a good thing to do from a security standpoint since it does neutralise a few clever phishing attacks. See the `HTML Purifier documentation <http://htmlpurifier.org/live/configdoc/plain.html#URI.DisableExternalResources>`_ for more details.
265
#. **reCAPTCHA on user registration form**: If set to "Yes", :index:`people who register themselves on the site <single: Security settings; reCAPTCHA>` are required to fill in a `reCAPTCHA <http://recaptcha.org/>`_ test. This is a spam protection instrument.
266
267
#. **reCAPTCHA site key**: Enter the site key for your site's reCAPTCHA account.
#. **reCAPTCHA secret key**: Enter the secret key for your site's reCAPTCHA account.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
268

269
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
270
271
   pair: Administration; Proxy settings
   single: Site administrator; Proxy settings
272

Kristina Hoeppner's avatar
Kristina Hoeppner committed
273
274
275
276
277
.. _proxy_settings:

Proxy settings
^^^^^^^^^^^^^^^^^^

278
.. figure:: /images/administration/proxy_settings.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
279
280
281
282
   :alt: Proxy settings

   Proxy settings

283
#. **Proxy address**: If your site uses a proxy server to access the Internet, specify the proxy in ``hostname:portnumber`` notation.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
284
285
286
#. **Proxy authentication model**: Select your proxy's authentication model (none or basic [NCSA]), if appropriate.
#. **Proxy credentials**: Enter the credentials required for your proxy to authenticate your web server in ``username:password`` format.

287
.. index:: System mail address
Kristina Hoeppner's avatar
Kristina Hoeppner committed
288
289
   pair: Administration; Email settings
   single: Site administrator; Email settings
290
   single: Default notification method
291

Kristina Hoeppner's avatar
Kristina Hoeppner committed
292
293
294
295
296
.. _email_settings:

Email settings
^^^^^^^^^^^^^^^^

297
.. figure:: /images/administration/email_settings.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
298
299
300
301
302
303
   :alt: Email settings

   Email settings

#. **SMTP host**: If you want to force Mahara to use a specific SMTP server instead of the system one, enter its hostname here, e.g. ``smtp.example.com``. It is possible to specify more than one host by separating them with semicolons, e.g. ``smtp1.example.com;smtp2.example.com``, but keep in mind that all other settings, e.g. authentication credentials and port numbers, will apply to all listed servers. It is not possible to specify different credentials for each server in this list. This feature is useful when SMTP host authentication is not required or you list different frontends for the same mail server in which case other settings will work.
#. **SMTP port**: If your SMTP server uses a port number different from 25, you may specify it here. When encryption is enabled, the default ports are 465 for SSL and 587 for TLS. You only need to specify a port number if it is different from these. Check the correct settings with your mail service provider.
304
305
#. **User**: If your SMTP server requires authentication, enter the username here.
#. **Password**: If your SMTP server requires authentication, enter the password here.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
306
#. **SMTP encryption**: If your SMTP server supports encryption, enable it here.
307
308
#. **System mail address**: This email address is the address that emails are sent from Mahara.

309
310
311
312
313
.. index::
   pair: Administration; Notification settings

.. _notification_settings:

314
Notification settings
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can set the default options for new users to receive notifications. Users can override these settings on their own *Settings → Notifications* page.

The options you have are:

* **Email**: Sends an email to your primary email address once the notification was created. In some cases, the cron needs to run first in order for the notification to be sent.
* **Email digest**: Sends one email per day for all the notifications that you set to "Email digest".

  .. note::
     If you select either of the email options, notifications will still arrive in the user's inbox, but they will be marked as read automatically.

* **Inbox**: All notifications are only sent to your system inbox that you can reach in the top right corner next to the "Logout" button.
* **None**: If you use this option, you will not get a notification for the selected notification type. Use this setting wisely as you may miss important notifications.

  .. note::
     You cannot set "System messages" and "Messages from other users" to "None".

.. figure:: /images/administration/notification_settings.*
   :alt: Notification settings

   Notification settings

338
#. **Contact us**: Only site administrators see this notification type. These are messages sent via the "Contact us" form that can be accessed in the footer of the site if the site administrators :ref:`decided to display this link <footer>`.
339
#. **Feedback**: These are notifications about any comments received on pages, artefacts or journal posts.
340
#. **Feedback on annotations**: :index:`These notifications <single: Notification settings; Annotation feedback>` are triggered when feedback is left on an annotation.
341
342
#. **Group message**: The system generates these notifications automatically, e.g. when a user requests to join a group.
#. **Institution message**: These notifications are generated by the system automatically, e.g. institution confirmation message, institution removal message, institution request sent to administrator.
343
#. **Message from other users**: Messages that are sent by other users.
344
#. **New forum post**: These notifications are sent to a user when new forum posts happened in the forums or forum topics that the user is subscribed to.
345
#. **New page access**: This type of notification is sent to you when you, you as a friend or one of your groups has been given access to a page. You do not receive notifications about pages accessible to all registered users and the public.
346
#. **Objectionable content**: Only administrators see this notification type. These notifications contain complaints by users about content that an administrator should take a look at because it does not comply with the terms and conditions set out for the site. This setting is for pages and artefacts that contain objectionable content.
347
#. **Objectionable content in forum**: Only administrators see this notification type. These notifications contain complaints by users about content that an administrator should take a look at because it does not comply with the terms and conditions set out for the site. This setting is for forum topics and posts that contain objectionable content.
348
#. **Repeat virus upload**: Only site administrators see this notification type. This notification informs site administrators about users who repeatedly upload virus-infected files. :ref:`Virus checking <security_settings>` must be turned on.
349
#. **System message**: This type of notification is generated automatically by the system or sent automatically by one of the site administrators, e.g. account confirmation message.
350
#. **Virus flag release**: Only site administrators see this notification type. This notification lets site administrators know when files were released by the virus scanner. :ref:`Virus checking <security_settings>` must be turned on.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
351
#. **Wall post**: :index:`This <single: Wall; Wall post notification delivery setting (general)>` type of notification is sent to you when somebody else leaves a public or private message on your wall.
352
#. **Watchlist**: Notifications of updates to pages or artefacts that you put onto your watchlist are generated automatically and sent in intervals.
353

354
.. index:: Online users side block, Sitemap, Public profile, Public pages, Portfolio search, Tag cloud, Small page headers, Registration agreement, Mobile upload, HTML editor
Kristina Hoeppner's avatar
Kristina Hoeppner committed
355
356
   pair: Administration; General settings
   single: Site administrator; General settings
357
358
   single: Automatically allow public profiles with public pages
   single: Generate sitemap for public content
Kristina Hoeppner's avatar
Kristina Hoeppner committed
359
   single: Limit the number of users in the "Online users" sidebar
360
   single: Small page header is visible at all times
361
   single: License metadata
Kristina Hoeppner's avatar
Kristina Hoeppner committed
362
363

.. _general_settings:
364
.. _small_headers:
365
.. _anonymous_pages:
Kristina Hoeppner's avatar
Kristina Hoeppner committed
366
367
368
369

General settings
^^^^^^^^^^^^^^^^^^^

370
.. figure:: /images/administration/general_settings.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
371
372
373
374
   :alt: General settings

   General settings

375
376
377
378
379
380
381
#. **Allow public pages**: If set to "Yes", users can create portfolio pages that are accessible to the public rather than only to registered users.
#. **Allow public profiles**: If allowed, users can set their profile pages to be accessible to the public rather than only to registered users. However, only registered users can use interactive features such as the wall.

   .. note::
      If the option "Allow public pages" is chosen, "Allow public profiles" is automatically selected.

#. **Allow anonymous pages**: :index:`If <single: Allow anonymous pages>` set to "Yes", users can hide their name as the author of a page from other users. Administrators and staff can still view authorship information by clicking on the "Author's name hidden" link that will reveal the real name.
382
383
384
385

   .. note::
      The name is also anonymized in blocks that are on the page and would normally display the author's name.

386
387
388
#. **Sitemap**: If set to "Yes", sitemap files from publicly accessible pages, groups and forum topics are generated that can be sent to another service.
#. **Portfolio search**: If allowed, the "Search my portfolio" side block is displayed in the *Content* and *Portfolio* sections of the site. However, it has not been working for most users for a long time.
#. **Tag cloud**: If set to "Yes", users see a side block in the *Content* and *Portfolio* sections of the site with a list of their most frequently used tags. The number of tags displayed is defined by the option "Maximum tags in cloud".
Kristina Hoeppner's avatar
Kristina Hoeppner committed
389
#. **Maximum tags in cloud**: Enter the default number of tags to display in user tag clouds. Users can change this number in their :ref:`account settings <general_account_options>`.
390
#. **Show online users**: If set to "Yes", users see a side block with a list of the users who have been logged-in in the last 10 minutes (cf. the :ref:`dashboard <dashboard>`). Institution administrators can limit the users displayed in this block to institution members in the :ref:`institution settings <add_institution>`.
391
#. **Online users limit**: Enter the maximum number of users to display in the *Online users* side block.
392
393
394
395
#. **Registration agreement**: If set to "Yes", you force users to agree to the "Terms and Conditions" before registration. You should edit your site's "Terms and Conditions" page before enabling this option. You can do so under :ref:`Static pages <edit_site_pages>`.
#. **License metadata**: If allowed, users can choose under which license they want to make their content available. They can set a default license in their :ref:`account settings <account_settings>` and then decide for each artefact individually as well. An institution administrator can set the default license in the :ref:`institution settings <add_institution>`.
#. **Custom licenses**: If allowed, users can enter any URL as license for their content. If not checked, users will be limited to the licenses configured by the site administrator.
#. **Mobile uploads**: If set to "Yes", users have the option of setting authentication tokens in their :ref:`account settings <general_account_options>`. That allows them to upload content from their :ref:`mobile devices <mobile_mahara>`. You can enter more than one token in order to connect mutliple mobile devices.
396
#. **HTML editor**: Choose whether the HTML editor is used by default or not. If set to **User-defined**, users will be allowed to choose whether to use the HTML editor in their personal settings or not. Otherwise the specified setting will be used site-wide.
397
#. **Enable MathJax**: :index:`If <single: MathJax support>` set to "Yes", mathematics and science equations can be displayed nicely in Mahara pages. For more information on how to configure MathJax, see the *Help* icon next to the option.
398
#. **Access to site files**: :index:`If allowed, registered users will have access to site files in subfolders <single: Access to site files in subfolders>` of the folder "public". By default, only files directly in the folder "public" are accessible to them.
399
#. **Watchlist notification delay**: :index:`Decide how many minutes <single: Watchlist notification delay>` after editing a page, a watchlist notification is sent. The default value is "20" for 20 minutes.
400
401
402

   .. note::
      In the past, a watchlist notification about a change was sent whenever a block was edited on a page. Since that caused a lot of notifications to be sent, a delay has been put in place to accumulate a number of changes so that it can be assumed more that a page and not only an item on the page has changed.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
403

404
405
406
.. index::
   pair: Administration; Logging settings
   single: Site administrator; Logging settings
407
408
   single: Logging settings
   single: Masquerading: Logging settings
409
410
411

.. _logging_settings:

412
Logging settings
413
414
415
416
417
418
419
420
421
422
423
424
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Mahara logs a number of events. These can now be collected in the database as well. The primary reason for logging events in the database is the logging of :ref:`administrators masquerading as users <login_as>` for enhanced audits of these actions.

.. figure:: /images/administration/logging_settings.*
   :alt: Logging settings

   Logging settings

#. **Log events**: Decide which events you wish to log in the database. Events are generated every time the user does something significant on the site, such as editing a page. This log is kept in the ``event_log`` table in the database.

   * **None**: Nothing is logged in the database.
425
   * **Masquerading**: Only masquerading sessions are logged. This setting needs to be turned on if you wish to :ref:`report on administrator masquerading of users <masquerading_report>`.
426
427
   * **All**: All events that can be logged in the database are logged.
#. **Event log expiry**: Decide for how long you wish to keep your database log. If you selected to log all events, the table can grow quite quickly especially on an active site. This time may be specified in days, weeks, months, years or "No end date". If the latter option is chosen, the event log is not deleted by default.
428
#. |new in Mahara 17.10| **Event log reporting**: :index:`If <single: New in Mahara 17.10; Logging for advanced reporting>` set to "Yes", you can report over a number of activities on the site in the :ref:`"Reports" section <reports>` that require events to be logged.
429

430
The table ``event_log`` contains the data that can be logged:
431

432
433
434
435
436
* **usr**: user ID of the person whose account is shown on screen
* **realusr**: user ID of the administrator who masquerades
* **event**: action being carried out, e.g. beginning of a masqueradin session, saving of an artefact, deleting of a page or artefact, update user information, placing a block onto a page
* **data**: additional information about the action, e.g. the ID of a block that is updated
* **time**: time when the action was carried out
437

438
.. index::
439
440
   pair: Administration; Static pages
   single: Site administrator; Static pages
441

Kristina Hoeppner's avatar
Kristina Hoeppner committed
442
443
.. _edit_site_pages:

444
Static pages
Kristina Hoeppner's avatar
Kristina Hoeppner committed
445
446
~~~~~~~~~~~~~~~~~~~

447
448
*Administration → Configure site → Static pages*

Kristina Hoeppner's avatar
Kristina Hoeppner committed
449
450
451
452
453
454
455
456
Here you can edit the content of some pages around the site and the pages linked to in the footer:

* About
* Home (Dashboard)
* Logged-out home
* Privacy statement
* Terms and conditions

457
.. seealso::
458
   Institutions can change the content of these pages on their :ref:`static institution pages <static_institution_pages>` to their liking and do not have to go with the content from the entire site.
459

Kristina Hoeppner's avatar
Kristina Hoeppner committed
460
461
All pages come with default text that you can change entirely. Every page must contain some text. You can use the visual editor to style your page.

462
463
.. figure:: /images/administration/static_pages_site.*
   :alt: Edit static pages
Kristina Hoeppner's avatar
Kristina Hoeppner committed
464

465
   Edit static pages
Kristina Hoeppner's avatar
Kristina Hoeppner committed
466

467
468
#. **Page name**: Choose the page you want to edit from the drop-down menu.
#. **Page text**: Change the text in the editor window. You cannot leave this field empty.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
469
470
#. Click the *Save changes* button.

471
.. index::
472
   single: Local customisation of the "Static pages" list
473
474

.. note::
475
   If your site has added custom pages to the menu, e.g. like `MyPortfolio.school.nz <http://myportfolio.school.nz>`_ where you have a number of additional informational pages, you can edit their content from the *Static pages* screen. In order to do so, a server administrator needs to make `changes on the backend <https://bugs.launchpad.net/mahara/+bug/999464>`_.
476

477
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
478
479
   pair: Administration; Menu
   single: Site administrator; Menu
480

Kristina Hoeppner's avatar
Kristina Hoeppner committed
481
482
483
484
485
.. _menus:

Menus
~~~~~~~~~~~~~

486
*Administration → Configure site → Menus*
487

Kristina Hoeppner's avatar
Kristina Hoeppner committed
488
489
490
491
492
There are two menus in Mahara:

* Links and resources
* Footer

493
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
494
495
   pair: Administration; Links and resources
   single: Site administrator; Links and resources
496

Kristina Hoeppner's avatar
Kristina Hoeppner committed
497
498
499
500
501
.. _links_resources:

Links and resources
^^^^^^^^^^^^^^^^^^^^^^^

502
The *Links and resources* menu appears to all users on most pages in the side bar. You can decide which links or files are available to everybody - also those without a login - and which ones only logged-in users shall see.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
503

504
.. figure:: /images/administration/menu_external.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
505
506
507
508
509
510
511
512
   :alt: Add external links to the menu

   Add external links to the *Links and resources* menu

#. Choose which *Links and resources* menu you want to edit: the public or the logged-in users one.
#. Choose the type *External link*.
#. Give your link a name that will appear in the menu.
#. Provide the full URL to the link including ``http://`` or ``https://``.
513
#. Click the *Add* button |add menu item|.
514
515
#. Click the *Edit* button |edit| to make changes to the existing link.
#. Click the *Delete* button |delete| to delete the link.
516

Kristina Hoeppner's avatar
Kristina Hoeppner committed
517
518
You can also link to files that you have uploaded to the :ref:`site files area <site_files>`.

519
.. figure:: /images/administration/menu_site_files.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
520
521
522
523
524
525
526
   :alt: Add site file to menu

   Add a site file to the *Links and resources* menu

#. Choose which *Links and resources* menu you want to edit: the public or the logged-in users one.
#. Choose the type *Site file*.
#. Give your site file a name that will appear in the menu.
527
#. Choose the file you want to display from the drop-down menu.
528
#. Click the *Add* button |add menu item|.
529
530
#. You can make changes to the name or choose a different file when you click the *Edit* button |edit|.
#. You can remove the file from the menu by clicking the *Delete* button |delete|. This will only delete the reference to the file in the menu but not the file itself.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
531
532
533
534

.. note::
   If you wish to display your links and resources in a specific order, map that order out before you add the links and files because you cannot change the order afterwards.

535
.. figure:: /images/administration/links_resources.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
536
537
538
539
   :alt: Links and Resources menu

   *Links and resources* menu result

540
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
541
542
   pair: Administration; Footer menu
   single: Site administrator; Footer menu
543
   single: Override default site pages
544

545
546
.. _footer:

Kristina Hoeppner's avatar
Kristina Hoeppner committed
547
548
549
550
551
Footer menu
^^^^^^^^^^^^^^^^

You have control over which links are displayed in the footer on each page.

552
.. figure:: /images/administration/menu_footer.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
553
554
555
556
   :alt: Footer menu

   Footer menu

557
558
559
560
561
562
563
564
565
566
567
568
#. **Terms and conditions**: Set the switch to "Yes" if you wish to display a link to the terms and conditions for the site in the footer of every page.
#. If you already have terms and conditions and don't want to write them again for Mahara, you can simply link to the existing page here.
#. **Privacy statement**: Set the switch to "Yes" if you want to show a link to the privacy statement in the footer.
#. If you already have a privacy statement elsewhere, you can link to it.
#. **About**: Choose "Yes" to display the link to the "About" page in the footer.
#. If you have an existing page, you can provide the link here.
#. **Contact us**: Set the switch to "Yes" if you want to display a link to a contact form in the footer.
#. If you have a contact page, you can provide the link to overwrite the Mahara one.
#. Click the *Save changes* button to save your choices.

.. note::
   You can change the text of "Terms and conditions", "Privacy statement" and "About" in :ref:`Static pages <edit_site_pages>` if you don't already have an existing text to link to.
569

570
571
572
573
574
575
576
577
578
579
580
581
.. index:: MNet, Moodle, Mahoodle
   pair: Administration; Networking
   single: Site administrator; Networking
   single: Generate new public key for MNet by deleting the existing one

.. _networking:

Networking
~~~~~~~~~~~~~

*Administration → Configure site → Networking*

582
Mahara's networking feature allows it to communicate with other Mahara or `Moodle <http://moodle.org>`_ sites. If networking is enabled, you can use it to configure single sign-on (SSO) for users who log in at either Moodle or Mahara or allow users from another Mahara instance to access yours.
583

584
You can connect Mahara and Moodle to save certain content you created in Moodle through the `portfolio feature <http://docs.moodle.org/22/en/Portfolios>`_.
585
586
587
588
589
590
591
592

.. figure:: /images/administration/networking.*
   :alt: Networking

   Networking overview

In order to use networking site-wide with any institution, you need to:

593
#. **Enable networking**: Choose "Yes" if you wish to connect one or more Mahara or Moodle sites to your Mahara instance.
594
595
#. **Auto-register all hosts**: If you choose "Yes", an institution is created for any host that connects allowing these users to log in to your Mahara site. We recommend you leave the default "No" because that gives you more control over which Moodle or Mahara instances can connect.
#. Click the *Save changes* button.
596
#. Click the *Delete this key* button if you want to generate a new key for your Mahara site, e.g. when you copied the database from another site or the other instance doesn't recognize it properly.
597
598
599
600

Depending on which site you wish to connect, you may need to provide some of the other information on the page, in particular the *WWW root* and the *public key*.

.. seealso::
601
   You can consult the `comprehensive guide for setting up a Mahoodle <https://wiki.mahara.org/index.php?title=System_Administrator%27s_Guide/Moodle%2F%2FMahara_Integration>`_ when connecting Mahara and Moodle.
602
603
604

   You set up MNet for an institution when you :ref:`edit the authentication method XML-RPC <mnet>`.

605
606
607
.. index::
   pair: Administration; Licenses
   single: Site administrator; Licenses
608
   single: License metadata: Configure licenses
609
610
611

.. _licenses:

612
Licenses
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Administration → Configure site → Licenses*

The site administrator can allow users to add license metadata to their artefacts in the :ref:`general site settings <general_settings>`. Additionally, an institution administrator can require institution members to choose a license for any of their artefacts in the :ref:`institution settings <add_institution>`.

List of licenses
^^^^^^^^^^^^^^^^^^^^^^^^

Licenses that are available to all users of the site are defined on the *Licenses* page. Mahara comes with a number of pre-defined licenses, but the site administrator can add many more or delete any of the existing ones.

.. figure:: /images/administration/licenses.*
   :alt: Available licenses on the site

   Available licenses on the site

629
#. Click the *Add a license* button to add an additional license that users can choose from.
630
#. **Icon**: Every license can have an icon / license logo that is displayed on the details page of an artefact.
631
#. **Display name**: The name that is displayed for each license around the site, e.g. in the drop-down menu where a user can select a license and on the details page of an artefact.
632
633
634
635
636
637
638
639
#. **Acronym**: The short name by which the license is also known. This acronym is also displayed to the user on the details page of an artefact.
#. **URL**: The Internet address where the license text can be found. When a license is displayed on the details page of an artefact, it is linked to this URL.

   .. note::
      It is important for users to be able to click on a link to the license because that allows them to learn about the license conditions and what they can do with the artefact or not.

#. Click the *Edit* button |edit| to change properties of a license. You can change the display name, acronym and the license icon, but not its URL. If you want to change the latter, you will need to create a new license.
#. Click the *Delete* button |delete| to remove a license from the system.
640

641
642
643
644
645
646
647
648
649
650
651
652
.. _add_license:

Add a license
^^^^^^^^^^^^^^^^^^^^^^

As site administrator you can add as many licenses as you wish. Go to *Administration → Configure site → Licenses* and click the *Add a license* button.

.. figure:: /images/administration/licenses_add.*
   :alt: Add a new license to the site

   Add a new license to the site

653
#. **Display name**: Choose a name for your license that will be displayed around the site, e.g. on the details page of an artefact and in the drop-down menu in which users and institution administrators choose their defaul license. This field is required.
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
#. **URL**: The Internet address where the license text can be found. When a license is displayed on the details page of an artefact, it is linked to this URL. This field is required.
#. **Acronym**: If the license you want to add also has a commonly known acronym, you can enter it.
#. **Icon**: If the license you add has a logo that you want to display next to the icense, e.g. on the details page of an artefact, you can link it here.

   #. This can be a http://... or https://... URL to an image elsewhere on your site or anywhere on the Internet.
   #. It can also be a license:... URL to specify license icons from the Mahara theme. For example, the URL ``license:gfdl.png`` would refer to the file ``static/images/license/gfdl.png`` in the theme.

#. Click the *Save* button to add the license to the site.

.. _edit_license:

Edit a license
^^^^^^^^^^^^^^^^^^^^^^

As site administrator you can change the properties of any license. Go to *Administration → Configure site → Licenses* and click the *Edit* button |edit| next to a license that you want to change. You can change all license properties but the URL.

.. figure:: /images/administration/licenses_edit.*
   :alt: Edit a license on the site

   Edit a license on the site

#. **Display name**: Change the name of the license that is displayed around the site.
#. **Acronym**: Change the acronoym of the license.
#. **Icon**: Change the icon that is associated with the license and displayed along with the license's name around the site.

   #. This can be a http://... or https://... URL to an image elsewhere on your site or anywhere on the Internet.
   #. It can also be a license:... URL to specify license icons from the Mahara theme. For example, the URL ``license:gfdl.png`` would refer to the file ``static/images/license/gfdl.png`` in the theme.

#. Click the *Save* button to keep your changes to the license.

684
685
686
.. note::
   You cannot change the URL of the license. If you have a mistake in the URL, you will need to delete the license entirely and add it correctly.

687
.. index::
688
689
690
691
692
   pair: Administration; Site pages and collections
   single: Site administrator; Site pages and collections
   single: Site pages and collections; Default dashboard page
   single: Site pages and collections; Default profile page
   single: Site pages and collections; Default group homepage
693

Kristina Hoeppner's avatar
Kristina Hoeppner committed
694
695
.. _site_pages:

696
697
Site pages and collections
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Kristina Hoeppner's avatar
Kristina Hoeppner committed
698

699
*Administration → Configure site → Pages and collections*
700

701
You can create site pages with informational content to share with other users or you can create templates which users can copy into their own accounts. You can also change the default content and layout of the pages for the dashboard, profile, group homepage, and regular page.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
702

703
704
.. figure:: /images/administration/site_portfolios.*
   :alt: Site pages and collections
Kristina Hoeppner's avatar
Kristina Hoeppner committed
705

706
   Site pages and collections
Kristina Hoeppner's avatar
Kristina Hoeppner committed
707

708
Adding and editing site pages and collections is very similar to :ref:`creating <create_page>` and :ref:`editing <page_editor>` a portfolio page or collection. However, not all blocks are available when editing a site page in the :ref:`page editor <page_editor>` due to the different context. Please refer to the :ref:`overview of blocks <blocks_in_context>` for a list of all the blocks that you can use in a site page.
709

710
#. Click the *Add* button to start a new page or collection from scratch.
711
712

   .. note::
713
      A modal opens in which you can choose whether to create a page or collection.
714

715
      |add page or collection|
716

717
718
719
#. Click the *Copy* button to choose an existing page or collection as basis.
#. **Search**: Type your search term into the search field.
#. Use the drop-down arrow to limit your search. The available options are:
720

721
722
723
   * **Title, description, tags**: Search for your search term in the title, descirption, and tags of your site portfolios.
   * **Title, description**: This is the default option. It searches in the title and description of your site portfolios.
   * **Tags**: Search only within the tags of your site portfolios.
724

725
#. **Sort by**: Decide on the sort order in which you wish to display your portfolios.
726

727
728
729
730
731
732
   * **Alphabetical**: Portfolios are displayed in alphabetical order.
   * **Date created**: List the portfolios in chronologically reverse order with the newest portfolios first.
   * **Last modified**: Display the portfolios in the order of their last modification with the most recent portfolios that have been changed first. This is the default display option.
   * **Last viewed**: Show the portfolios in the order in which they were viewed by you and others starting with the most recently viewed portfolios.
   * **Most visited**: Display the portfolios that have been visited most first in the list.
   * **Most feedback**: List the portfolios in descending order based on the amount of feedback they have received.
733

734
735
    .. note::
       :index:`The sort order <single: Page sort order is remembered>` that you choose does not change when you navigate away from the overview page or log out. When you change the sort order, that new setting will be used until you change it again.
736

737
738
739
740
#. Click the *Search* button to search your site portfolios based on your search term and / or sorting criteria.
#. **Dashboard template**: You can edit the dashboard template. The dashboard doesn't change for existing users. However, new users will get the changed dashboard.
#. **Group homepage template**: Change the layout and the blocks that are displayed on all group homepages. This only affects groups created after the changes.
#. **Profile template**: Make changes to the layout and the blocks that users see on their profile page per default. Your changes only affect new users.
741

742
743
   .. note::
      You cannot delete the dashboard, group homepage, profile and page templates.
744

745
#. **Page template**: :index:`Change <single: Administration; Change the default page>` the default portfolio page. The changes only affect any pages that are created after you made the change.
746

747
748
   .. note::
      Changing this page template is useful if you want to have all new pages use a specific layout instead of the built-in three-column layout. You could also place a block onto the template that any new page should have.
749

750
      Users still have the possibility to change any settings once they create their page. You are not locking them into a specific way.
751

752
Once you are done creating your site portfolios, you can :ref:`share them with others <site_share>`.
753

754
755
.. note::
   :index:`When somebody leaves feedback <single: Feedback notification for site pages and artefacts>` on a site page or artefact, the site administrators receive a notification.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
756

757
758
759
760
761
762
.. index::
   pair: Administration; Site journals
   single: Site administrator; Site journals

.. _site_journals:

763
Site journals
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Administration → Configure site → Journals*

You create site journals like regular :ref:`user journals <journal>`.

.. figure:: /images/administration/site_journals.*
   :alt: Site journals

   Site journals

#. You can create multiple journals. Click the *Create journal* button to set up a new journal.
#. All your journals are listed on *Administration → Configure site → Journals* with their titles. The titles link through to the individual journals.
#. You can see the description of the journal.
#. You see how many entries you have in each journal.
#. Click the *Arrow* icon |arrow-to-right| to be taken to the journal and see all journal entries.
#. Click the *New entry* button to create a new journal entry directly from this screen.
#. Click the *Edit* button |edit| to make changes to your journal title, description or tags.
#. Click the *Delete* button |delete| to delete the journal and all its entries.

.. warning::
   When you click the *Delete* button, you receive a confirmation message whether you really want to delete the journal or not. :index:`If you used the journal or an entry of it in a page <single: Confirmation message before deleting journal that is in use>`, Mahara lets you know so you can decide whether to delete the journal or not. Once you agree to delete the journal, your journal and all its content are removed permanently.

787
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
788
789
   pair: Administration; Share site pages and collections
   single: Site administrator; Share site pages and collections
790

791
792
.. _site_share:

Kristina Hoeppner's avatar
Kristina Hoeppner committed
793
794
795
Share
~~~~~~~~~~~

796
*Administration → Configure site → Share*
797

798
You share site pages and site collections like any other pages and collections.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
799
800

.. seealso::
801
   Refer to the :ref:`share options <share>` for regular portfolio pages and collections for further information.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
802

803
.. figure:: /images/administration/share.*
804
   :alt: Share site pages and collections
Kristina Hoeppner's avatar
Kristina Hoeppner committed
805

806
   Share site pages and collections
Kristina Hoeppner's avatar
Kristina Hoeppner committed
807

808
When you want to allow copying, you have a few more options available than on regular pages or collections.
809

810
.. figure:: /images/administration/share_copying.*
811
   :alt: Copying site pages and collections
812

813
   Copying site pages and collections
814

815
#. **Allow copying**: Switch this option to "Yes" if you want to allow the people who have access to the page or collection to copy it.
816
817
818
819
820
#. **Copy for new users**: Enable this option if all new users on the site - and not just in one institution - shall receive a copy of the selected page(s) or collection(s) into their portfolios when an account is created for them.

   .. note::
      If you enable this option without also enabling the option "Allow copying", your users will not be able to make a copy of the page(s) or collection(s) themselves if they need another one.

821
822
#. **Course**: Switch this option to "Yes" if all **course** groups shall receive a copy of the selected page(s) or collection(s).
#. **Standard**: Switch this option to "Yes" if all **standard** groups shall receive a copy of the selected page(s) or collection(s).
823

824
825
826
.. index::
   pair: Administration; Site skins
   single: Site administrator; Site skins
827
   single: Skins
828
829
830

.. _site_skins:

831
Site skins
832
833
834
835
836
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Administration → Configure site → Site skins*

.. warning::
837
   *Skins* is a feature that can be applied on top of themes for pages. While you can change a lot of style elements, changing all of them is not advised depending on the theme that is underlying your page.
838

839
This feature is only available when the server administrator :ref:`enabled skins <config_variable_skins>` for the site.
840
841
842
843
844
845
846
847
848
849
850

You can create skins that will be available to all users of your site.

.. figure:: /images/administration/site_skins.*
   :alt: Site skins

   Site skins

#. Click the *Create skin* button to design a new skin.
#. Click the *Import skin(s)* button to import skins that others have shared online.
#. Click the *Export skin(s)* button to export all site skins.
851
852
#. The title of the skin.
#. Click the *Info* button to see more details for the skin, e.g. who created it when.
853
854
855
856
857
858
859
#. Click the *Edit* button |edit| to make changes to this skin.
#. Click the *Export* button |export| to export only this one skin.
#. Click the *Delete* button |delete| to remove this skin.

.. seealso::
   The process of creating and editing a site skin is very similar to creating and editing :ref:`skins in your portfolio <create_skin>`.

860
861
862
.. index::
   pair: Administration; Fonts
   single: Site administrator; Fonts
863
   single: Fonts
864
865
866

.. _fonts:

867
Fonts
868
869
870
871
872
873
874
875
876
877
878
879
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Administration → Configure site → Fonts*

You can install additional fonts to be used with :ref:`page skins <skins>`. Currently, you cannot use these fonts anywhere else.

.. figure:: /images/administration/fonts_overview.*
   :alt: Fonts overview page

   Fonts overview page

#. Click the *Install font* button to install a font from your computer.
880
#. Click the *Install Google font(s)* button to install fonts you discovered through `Google fonts <https://www.google.com/fonts/>`_.
881
882
883
884
885
886
887
888
889
890
891
892
893
894
#. **Text**: Decide in which preview text the installed fonts should be displayed on this overview page. The default text is "Grumpy wizards...":

   * Latin alphabet (ASCII only)
   * Latin alphabet (ISO/IEC 8859-1)
   * Latin alphabet (ISO/IEC 8859-2)
   * Cyrillic alphabet (ISO/IEC 8859-5)
   * Greek alphabet (ISO/IEC 8859-7)
   * Numbers and fractions
   * Punctuation
   * Lorem ipsum dolor sit amet, consectetur adipiscing elit.
   * Grumpy wizards make toxic brew for the evil Queen and Jack.
   * The quick brown fox jumps over the lazy dog.

   .. note::
895
      Not all fonts have the full character set implemented. In particular, the Cyrillic and Greek alphabets may be missing and also some numbers, fractions and pucntuation symbols.
896
897
898
899
900
901
902
903
904
905
906
907
908
909

      The three last sentences show most / all of the letters in the English alphabet.

#. **Size**: Decide on the size of the letters in which the installed fonts should be displayed on this overview page. The default size is 28.
#. **Show**: Decide which fonts you want to see on this overview page:

   * All fonts
   * Local fonts
   * Google web fonts

#. Click the *Preview* button to change which fonts are displayed depending on the criteria you selected.
#. The title of the font is shown.
#. See what your font looks like according to your preview settings.
#. You see whether it is a Google font or a local font that you uploaded.
910
911
912
913
#. Click *View font specimen* to see details about this font.
#. Click *Edit font properties* on a local font to change some font settings.
#. Click *Add font style* to add more styles for a local font.
#. Click *Delete font* to delete this font.
914
915
916
917
918
919
920
921
922

.. _install_font:

Install a local font
^^^^^^^^^^^^^^^^^^^^^^

You can install a font that you find online **as long as you have the permission to do so**. Please always read the license of a font before uploading it to ensure that you are allowed to do so.

.. seealso::
923
   There are a lot of websites for finding fonts. One of them where you can use, share and remix them is the `Open Font Library <http://openfontlibrary.org/>`_.
924
925
926
927

Click the *Install font* button on the *Fonts* overview page.

.. seealso::
928
   If you want to upload a font you found on Google fonts, please :ref:`follow the Google fonts installation instructions <install_google_font>`.
929
930
931
932
933
934

.. figure:: /images/administration/font_install.*
   :alt: Install a font

   Install a font

935
#. **Font name**: Provide the name of the font. this field is required.
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
#. **Font notice**: Provide information about the font, e.g. license, and the font creator.
#. **Font style**: State what styles the font has available that you upload. If the styles come in separate font files, you need to upload all of them separately:

   * Regular
   * Bold
   * Italics
   * Bold italics

#. **Font type**: Decide where in a page skin the font can be used:

   * Headings and text
   * Headings only

#. **Generic font family**: To what generic font family does this font belong? Choose from:

951
   * **serif**: Letters and symbols have a small line attached to the end of a stroke to guide the eye from one letter to the next. An example is the font "Times New Roman".
952
953
954
955
956
   * **sans-serif**: Letters and symbols do not have the guiding line. An example is the font "Arial".
   * **monospace**: All letters have the same space.
   * **cursive**: Handwriting fonts.
   * **fantasy**: Fonts that are very ornamented.

957
#. **ZIP archive**: You can upload all font files in one go using a zip archive instead of having to upload them separately. You need to include all required font files.
958
959
960
961
962
963
964
965
966
967
968
#. **Font files**: You need to upload your font in all these font files in order to ensure that it can be displayed in different browsers and on different devices. Click the *Browse* button next to each font file type to upload that specific font file.

   * **EOT font file**: Embedded OpenType font (for Internet Explorer 4+)
   * **SVG font file**: Scalable Vector Graphic font (for iPad and iPhone)
   * **TTF font file**: TrueType font (for Firefox 3.5+, Opera 10+, Safari 3.1+, Chrome 4.0.249.4+)
   * **WOFF font file**: Web Open Font Format font (for Firefox 3.6+, Internet Explorer 9+, Chrome 5+)
   * **License file**: Upload the font license file

   .. seealso::
      You can use the `FontSquirrel Webfont Generator <http://www.fontsquirrel.com/tools/webfont-generator/>`_ to convert your fonts into the required formats.

969
#. Click the *Install font* button to finish installing this font or click *Cancel* to abort your action.
970
971
972
973
974
975

Edit a local font
^^^^^^^^^^^^^^^^^^^^^^^

You can make certain changes to a local font and also install additional font styles.

976
Click *Edit font properties* on the *Fonts* overview page to make changes to a number of settings of a local font.
977
978
979
980
981
982
983
984
985
986

.. figure:: /images/administration/font_edit.*
   :alt: Edit font properties of a local font

   Edit font properties of a local font

#. **Font name**: Edit the font name.
#. **Font notice**: Make changes to the license information and the creator of the font.
#. **Font type**: Choose whether the font can be used for headings only or also for regular text.
#. **Generic font family**: Change the font family to which this font belongs.
987
#. Click the *Save* button to accept your changes or click *Cancel* to abort your action.
988
989
990
991
992
993
994
995
996
997
998

Click the *Add font style* button to upload additional font styles for your font. If your font comes with a number of different styles in separate files, you need to upload them separately.

.. figure:: /images/administration/font_style.*
   :alt: Add an additional font style to a specific font

   Add an additional font style to a specific font

#. **Font name**: The name of your font for which you are uploading an additional font style is displayed.
#. **Font style**: Choose the font style that you are uploading.
#. **Font files**: Upload all required font files.
999
#. Click the *Save* button to accept your changes or click *Cancel* to abort your action.
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014

.. _install_google_font:

Install Google font(s)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Click the *Install Google font(s)* button to see the instructions and the font upload area for Google fonts.

.. figure:: /images/administration/font_install_googlefont.*
   :alt: Install Google font(s)

   Install Google font(s)

#. Follow the instructions for finding and downloading Google fonts.

1015
   * Visit the `Google fonts <https://www.google.com/fonts>`__ website.
1016
1017
   * Select the fonts that you wish to make available for all users to choose for skins and add them to your collection on Google.
   * Download all fonts as a ZIP file.
1018
1019

#. **Valid ZIP file**: Click the *Browse* button to upload the ZIP file that you downloaded from Google.
1020
#. Click the *Install Google font(s)* button to add these fonts to your fonts on Mahara or click *Cancel* to abort your action.
1021

1022
.. index::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
1023
1024
   pair: Administration; Site files
   single: Site administrator; Site files
1025

Kristina Hoeppner's avatar
Kristina Hoeppner committed
1026
1027
1028
1029
1030
.. _site_files:

Files
~~~~~~~~~~~

1031
*Administration → Configure site → Files*
1032

1033
Here you can upload files that you can include in the :ref:`links and resources <links_resources>` menu or in :ref:`site pages <site_pages>`. You can add files that are in the home directory to the menu with resources for logged-in users. Files that you save in the *public* folder can be used in the menu for users who are not logged-in. Additionally, users can put them into their own portfolio pages as files to download.
Kristina Hoeppner's avatar
Kristina Hoeppner committed
1034
1035
1036
1037

.. seealso::
   The process of uploading and managing files is very similar to files in your personal :ref:`files area <files_area>`.

1038
.. figure:: /images/administration/site_files.*
Kristina Hoeppner's avatar
Kristina Hoeppner committed
1039
1040
1041
   :alt: Site files

   Site files
1042
1043
1044
1045

.. index::
   pair: Administration; Cookie Consent
   single: Site administrator; Cookie Consent
1046
   single: Cookie Consent
1047
1048
1049

.. _cookie_consent:

1050
Cookie Consent
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Administration → Configure site → Cookie Consent*

The "Cookie Law", Directive 2009/136/EC of the European Parliament and of the Council, defines the requirements for consenting to the keeping of cookies across the European Union. Before your site can store or retrieve information from an electronic device, the user of your site must give informed consent for you to do so.

.. seealso::
   Read the `full text of the directive <http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=CELEX:32002L0058:en:HTML>`_.

.. figure:: /images/administration/cookie_consent_overview.*
1061
   :alt: Enable Cookie Consent
1062

1063
   Enable Cookie Consent
1064

1065
#. **Enable Cookie Consent**: Switch this setting to "Yes" if you want to enable the Cookie Consent feature.
1066
1067
#. Click the *Save changes* button.

1068
.. note::
Kristina Hoeppner's avatar
Kristina Hoeppner committed
1069
   Cookie Consent does not have its own configuration. Site administrators need to provide relevant information on the *Privacy* page.
1070
1071

When Cookie Consent is enabled, your users see the following banner at the bottom of their screen.
1072

1073
1074
.. figure:: /images/administration/cookie_consent_banner.*
   :alt: Cookie Consent banner
1075

1076
   Cookie Consent banner
1077

1078
1079
#. Click the "Learn more" link to be taken to the *Privacy* page of your site. There, more information about the collection of data via cookies is available.
#. Click the *Got it* button to acknowledge the use of cookies. You only need to do this once in a browser.