Template:SkinInstall/en

• Download and place the file(s) in a directory called SkinInstall in your skins/ folder.
• Add the following code at the bottom of your LocalSettings.php:

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

•  <translate> Done</translate> - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Template documentation

Usage

Parameters are optional!

1=

Set the skin name manually (defaults to the current page name without namespace prefix).

download-link=

Overwrite the download link (defaults to {{DownloadGitSnapshot}})

basedir=

Directory that repo should be installed in and front-end resources are exposed through (defaults to skins, change to extensions if needed).

localsettings=

Pass custom php code that the user should include in LocalSettings.php

custom-steps=

Additional steps (as an unordered * list)

registration=

New way to install skin or extension.

Examples

Below a few examples of how to use this template:

Simple

{{SkinInstall}}

• <translate> [[<tvar name=2>Special:SkinDistributor/theskin</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

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

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

Name

{{SkinInstall|erudite}}

• <translate> [[<tvar name=2>Special:SkinDistributor/erudite</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>erudite</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

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

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

Download link

{{SkinInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}

• <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

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

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

LocalSettings

{{SkinInstall
|localsettings=
$wgUseAjax = true;
$wgEnableMWSuggest = true;
}}

• <translate> [[<tvar name=2>Special:SkinDistributor/theskin</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

require_once "$IP/skins/theskin/theskin.php";
$wgUseAjax = true;
$wgEnableMWSuggest = true;

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

Custom steps

{{SkinInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}

• <translate> [[<tvar name=2>Special:SkinDistributor/theskin</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

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

• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

Skin registration

{{SkinInstall
|registration=Yes
}}

• <translate> [[<tvar name=2>Special:SkinDistributor/theskin</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

wfLoadSkin( 'theskin' );

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

<translate> To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing skins using <tvar name=LoadSkin>wfLoadSkin()</tvar>, since MediaWiki 1.25.</translate> <translate> If you need to install this skin in earlier versions, instead of <tvar name=code>wfLoadSkin( 'theskin' );</tvar>, you need to use:</translate>

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

<translate> (To run a skin on an earlier release, you may need to download the version of it tagged for that release from Special:SkinDistributor.)</translate>

Vagrant

{{SkinInstall
|vagrant=1
}}

• <translate> If using <tvar name=vagrant>Vagrant </tvar>, install with <tvar name=code>vagrant roles enable 1 -p</tvar></translate>

<translate> Manual installation</translate>

• <translate> [[<tvar name=2>Special:SkinDistributor/theskin</tvar>|Download]] and place the file(s) in a directory called <tvar name=name>theskin</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

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

•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

Everything

{{SkinInstall|Example
|download-link=[http://bits.wikimedia.org/example.zip Download]
|localsettings=
$wgUseAjax = true;

|db-update=Yes
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
|registration=Yes
|vagrant=accountinfo
}}

• <translate> If using <tvar name=vagrant>Vagrant </tvar>, install with <tvar name=code>vagrant roles enable accountinfo -p</tvar></translate>

<translate> Manual installation</translate>

• <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>Example</tvar> in your <tvar name=ext>skins/</tvar> folder.</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php</tvar>:</translate>

wfLoadSkin( 'Example' );
$wgUseAjax = true;

• Lorem ipsum dolor sit amet
• Foo bar baz quux sandbox
•  <translate> Done</translate> - <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the skin is successfully installed.</translate>

<translate> To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing skins using <tvar name=LoadSkin>wfLoadSkin()</tvar>, since MediaWiki 1.25.</translate> <translate> If you need to install this skin in earlier versions, instead of <tvar name=code>wfLoadSkin( 'Example' );</tvar>, you need to use:</translate>

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

<translate> (To run a skin on an earlier release, you may need to download the version of it tagged for that release from Special:SkinDistributor.)</translate>

No description.

Template parameters

Parameter		Description	Type	Status
Skin name over-ride	1	Set the skin name manually Default name of the current page name without namespace prefix	String	optional
Download link over-ride	download-link	Overwrite the download link Default {{DownloadGitSnapshot}}	String	optional
New-style registration	registration	Whether to use the new style to register the skin	Boolean	optional
Installation directory	basedir	Directory that repo should be installed in and front-end resources are exposed through (defaults to skins, change to extensions if needed).	String	optional
LocalSettings code	localsettings	Custom PHP code that the user should include in LocalSettings.php	String	optional
Custom steps	custom-steps	Additional steps (as an unordered * list) that you need to undertake to install the skin.	String	optional
nocredits	nocredits	no description	Boolean	optional

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.