Manual:Skin configuration

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎British English • ‎español • ‎日本語 • ‎Nederlands • ‎polski • ‎português do Brasil • ‎русский • ‎中文

This page contains comprehensive information for administrators on how to configure skins on a wiki. Please refer to Help:Skins for general skin information and Manual:Skinning for developer information on creating new skins.

This documentation applies to MediaWiki 1.24 and greater.

Downloading skins[edit | edit source]

The MediaWiki tarball download comes pre-bundled with four skins: Vector (the default skin), MonoBook, Modern and Cologne Blue.

However, if you have downloaded MediaWiki from Git or from a nightly version, or if you want to install additional skins, you will need to separately download the code for that skin or skins.

Many MediaWiki skins are contained in the Wikimedia Git repository (see the full listing here). To download one of the skins in this group via Git, you should make a call like the following:

git clone https://git.wikimedia.org/git/mediawiki/skins/SkinName.git

Unfortunately, there is currently no way to download an additional skin other than via Git, but the mechanism to do such a thing is being developed.

After you have obtained the folder of a skin's files, place it as a subdirectory of /skins in your MediaWiki installation (you can place the Git repository there directly).

Installing skins[edit | edit source]

For any skin in your /skins directory that you wish to use, you must add a require_once line for it to your LocalSettings.php file. For example, to install Vector, add the following:

require_once "$IP/skins/Vector/Vector.php";

(This is equivalent to installing an extension, only in a different directory.)

Detailed installation instructions are available on each skin's page on mediawiki.org; for example, for Vector see Skin:Vector#Installation. Instructions for all other skins are analogous.

Setting the default skin for a wiki[edit | edit source]

A default skin should be set for new users of a wiki by setting the variable $wgDefaultSkin in LocalSettings.php to the lowercase skin name specified in the skin file. Users can still change their skin by going to their preferences page, unless you uninstall or suppress all other skins, or disable the preference altogether (see below). For example:

$wgDefaultSkin = 'vector';

Changing these value on an existing wiki will automatically change the setting of all users who have been using the previous default skin. There is a maintenance script to change users' preferences (userOptions.php), but you will most likely not need to use it.

If you do not change this value, Vector will be the default skin.

Uninstalling skins[edit | edit source]

To uninstall a skin, remove the require_once line from your LocalSettings.php file. You may remove the skin files from the skins/ directory afterwards.

If any users have been using the skin you just uninstalled, MediaWiki will automatically switch them to the default skin of the wiki.

Suppressing skins without uninstalling[edit | edit source]

The administrator can limit the skin choices that are offered site-wide in user's preferences by listing skin(s) to suppress in the $wgSkipSkins array. This might be useful if you want to test a new skin without letting users see it. To do this, put something like this in LocalSettings.php:

// To remove various skins from the User Preferences choices
$wgSkipSkins = array( "cologneblue", "monobook" );

You will be able to preview the skin using the useskin URL parameter.

Site-wide CSS modifications[edit | edit source]

MediaWiki allows administrators to specify site-wide CSS rules to be added to every page rendered. These rules can be added by editing the page Common.css on your wiki, if $wgUseSiteCss is set to true. In addition to a global stylesheet, one can also specify CSS rules to be used only in certain skins (see Manual:Interface/Stylesheets).

User CSS modifications[edit | edit source]

Users can also specify their own CSS rules by creating the page "User:Username/common.css". The CSS on this page is then applied to whatever skin the user is using. If the website is changed to a different default skin, the user's custom CSS will continue to work just as before. This feature can be enabled by setting $wgAllowUserCss to true in LocalSettings.php. A user can also apply CSS to a specific skin by creating the page "User:Username/skinname.css". If a user uses the MonoBook skin for example, they would edit the page Special:MyPage/monobook.css.

Disable site users' ability to choose skins in user preferences[edit | edit source]

MediaWiki version: 1.16

The system administrator can completely remove the "Skin" option so that it does not show up at all in User Preferences. This makes sense if your site will use a customized skin and would not look right in any other skin.

To do it, add a new line containing the following code to LocalSettings.php. It will remove the "Skin" option from preferences and the possibility to use the useskin parameter in the URL.

$wgHiddenPrefs[] = 'skin';