Note: You are currently viewing documentation for Moodle 3.7. Up-to-date documentation for the latest stable version of Moodle may be available here: Theme settings.

Theme settings: Difference between revisions

From MoodleDocs
(admin documentation category)
(formatting)
Line 1: Line 1:
== Theme Types and Settings ==
== Theme settings ==


=== The Theme Settings on the Variables Page ===
The following variables may be set by the administrator on the [[admin/config|Variables]] page:


On the admin page "MyMoodle » Administration » Configuration » Variables" you set the options to allow user and/or course specific themes:
;themelist
:This lists the themes available for course and user themes. Leave this blank to allow any valid theme to be used. If you want to shorten the theme menu, you may specify a comma-separated list of names here, though don't use spaces!. For example standard,orangewhite.


'''themelist:'''
;allowuserthemes
Leave this blank to allow any valid theme to be used. If you want to shorten the theme menu, you can specify a comma-separated list of names here (Don't use spaces!). For example: standard,orangewhite.
:If you enable this, then users will be allowed to set their own themes. User themes override site themes but not course themes.


'''allowuserthemes:'''
;allowcoursethemes
If you enable this, then users will be allowed to set their own themes. User themes override site themes (but not course themes)
:If you enable this, then teachers will be able to set their own course themes. Course themes override all other theme choices (site, user, or session themes).


'''allowcoursethemes:'''
== Theme types ==
If you enable this, then courses will be allowed to set their own themes. Course themes override all other theme choices (site, user, or session themes)


=== The Theme Types ===
=== Site themes ===
Site themes may be previewed and chosen on the [[theme/index|Themes]] page.


==== Site Themes ====
=== User themes ===
On the '''admin page''' "MyMoodle » Administration » Configuration » Themes" you choose the basic theme for your Moodle site. Theme previews give you a first impression how the theme looks.
If the option ''allowuserthemes'' is enabled, each user may select their preferred theme on the [[user/edit|Edit profile]] page. All Moodle pages will be displayed in the user's theme, apart from courses where a course theme has been set.


==== User Themes ====
=== Course themes ===
If the option '''allowuserthemes:''' is enabled every user can select her own theme. On the page "MyMoodle » User  » Edit profile" go to the option '''Preferred theme''' and select your theme from the theme list specified by the administrator (see above). All Moodle pages will be displayed in the users theme.
If the option ''allowcoursethemes'' is enabled, each editing teacher may select their course theme via the Force theme option on the [[course/edit|Course settings]] page. The course will always be displayed in the theme specified in the course setting, with user and the site themes being overwritten.


==== Course Themes ====
=== Session Themes ===
If the option '''allowcoursethemes:''' is enabled every editing teacher can select the theme for the active course. On the page "MyMoodle » mycourse » Edit course settings"  go to the option '''Force theme:''' and select your theme from the theme list specified by the administrator (see above). The course page will be displayed with this selected theme, all other Moodle pages will be displayed with different themes. The course will always been displayed in the theme specified in the course setting, user themes and the site theme are overwritten.
Moodle offers an additional way to set a theme - the '''session theme'''. This is set with the URL and lasts until you log out. When you next login, the site/course/user themes are active again. This option is great for theme testing and works perfectly when you want to enable different themes for different situations.


==== Session Themes ====
For example you can offer a special link for PDA users and integrate the session theme ''orangewhitepda'' in that link. Nobody needs to change any settings, you just click on that link. The session theme is called by the URL parameter <code>&theme=orangewhitepda</code>. The whole URL  without the session theme could look like <code><nowiki>http://mymoodlesite.org/course/view.php?id=18</nowiki></code> and with the parameter for the PDA theme like <code><nowiki>"http://mymoodlesite.org/course/view.php?id=18&theme=orangewhitepda"</nowiki></code>.
Moodle offers an additional way to set a theme - the '''session theme''' is set with the URL and lasts until you log out. After a new login the site and/or user theme is active again. This option is great for theme testing and works perfectly when you want to enable different themes for different situations.


For example you can offer a special link for PDA users and integrate the session theme "orangewhitepda" in that link. Nobody needs to change any settings, you just click on that link. The session theme is called by the url parameter "&theme=orangewhitepda" - the whole url  without the session theme could look like <nowiki>"http://mysite/moodle/course/view.php?id=18"</nowiki> and with the parameter for the pda theme like <nowiki>"http://mysite/moodle/course/view.php?id=18&theme=orangewhitepda"</nowiki>.
In a standard Moodle installation, session themes are not active. To activate them the administrator must add the parameter <code>$CFG->allowthemechangeonurl = true;</code> to the Moodle ''config.php'' file in the Moodle base directory.


In a standard Moodle installation session themes are not active. To activate them the administrator must add the '''parameter''' "$CFG->allowthemechangeonurl = true;" to the Moodle '''config.php''' file in the Moodle base directory.
== Theme overview ==
 
=== Theme Type Overview ===


{| style="border:1px dashed #ddd"
{| style="border:1px dashed #ddd"
|- style="vertical-align:top;text-align:left"
|- style="vertical-align:top;text-align:left"
!Theme Type
!Theme type
! style="background:#eee"|Overwrites
! style="background:#eee"|Overwrites
!Display
!Display
! style="background:#eee"|Setting Type
! style="background:#eee"|Setting type
|- style="vertical-align:top"
|- style="vertical-align:top"
|Site Theme
|Site
|style="background:#eee"| -  
|style="background:#eee"| -  
|all pages*
|all pages*
|style="background:#eee"|saved in theme profile
|style="background:#eee"|saved in theme profile
|- style="vertical-align:top"
|- style="vertical-align:top"
|User Theme
|User
|style="background:#eee"|Site Theme
|style="background:#eee"|Site theme
|all pages*
|all pages*
|style="background:#eee"|saved in user profile
|style="background:#eee"|saved in user profile
|- style="vertical-align:top"
|- style="vertical-align:top"
|Course Theme
|Course
|style="background:#eee"|Site theme, <br />
|style="background:#eee"|Site, user and session themes
User Theme, <br />
Session Theme
|one course
|one course
|style="background:#eee"|saved in course profile
|style="background:#eee"|saved in course profile
|- style="vertical-align:top"
|- style="vertical-align:top"
|Session Theme
|Session
|style="background:#eee"|Site Theme, <br />
|style="background:#eee"|Site and user themes
User Theme
|all pages*
|all pages*
|style="background:#eee"|temporary until logout
|style="background:#eee"|temporary until logout
|}
|}
(* all pages except courses with the Course Theme set.)
(* except courses with the course theme set)
 
----


[[Category: Administrator documentation]]
[[Category: Administrator]]
[[Category:Themes]]
[[Category:Themes]]

Revision as of 19:09, 25 November 2005

Theme settings

The following variables may be set by the administrator on the Variables page:

themelist
This lists the themes available for course and user themes. Leave this blank to allow any valid theme to be used. If you want to shorten the theme menu, you may specify a comma-separated list of names here, though don't use spaces!. For example standard,orangewhite.
allowuserthemes
If you enable this, then users will be allowed to set their own themes. User themes override site themes but not course themes.
allowcoursethemes
If you enable this, then teachers will be able to set their own course themes. Course themes override all other theme choices (site, user, or session themes).

Theme types

Site themes

Site themes may be previewed and chosen on the Themes page.

User themes

If the option allowuserthemes is enabled, each user may select their preferred theme on the Edit profile page. All Moodle pages will be displayed in the user's theme, apart from courses where a course theme has been set.

Course themes

If the option allowcoursethemes is enabled, each editing teacher may select their course theme via the Force theme option on the Course settings page. The course will always be displayed in the theme specified in the course setting, with user and the site themes being overwritten.

Session Themes

Moodle offers an additional way to set a theme - the session theme. This is set with the URL and lasts until you log out. When you next login, the site/course/user themes are active again. This option is great for theme testing and works perfectly when you want to enable different themes for different situations.

For example you can offer a special link for PDA users and integrate the session theme orangewhitepda in that link. Nobody needs to change any settings, you just click on that link. The session theme is called by the URL parameter &theme=orangewhitepda. The whole URL without the session theme could look like http://mymoodlesite.org/course/view.php?id=18 and with the parameter for the PDA theme like "http://mymoodlesite.org/course/view.php?id=18&theme=orangewhitepda".

In a standard Moodle installation, session themes are not active. To activate them the administrator must add the parameter $CFG->allowthemechangeonurl = true; to the Moodle config.php file in the Moodle base directory.

Theme overview

Theme type Overwrites Display Setting type
Site - all pages* saved in theme profile
User Site theme all pages* saved in user profile
Course Site, user and session themes one course saved in course profile
Session Site and user themes all pages* temporary until logout

(* except courses with the course theme set)