Template:SkinInstall
- Download and place the file(s) in a directory called
SkinInstall
in yourskins/
folder. - Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/SkinInstall/SkinInstall.php";
- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Uses Lua: |
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 toextensions
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
orextension
.
Examples
Below a few examples of how to use this template:
Simple
{{SkinInstall}}
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/theskin/theskin.php";- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Name
{{SkinInstall|erudite}}
- Download and place the file(s) in a directory called
erudite
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/erudite/erudite.php";- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Download link
{{SkinInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/theskin/theskin.php";- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
LocalSettings
{{SkinInstall |localsettings= $wgUseAjax = true; $wgEnableMWSuggest = true; }}
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/theskin/theskin.php"; $wgUseAjax = true; $wgEnableMWSuggest = true;- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Custom steps
{{SkinInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/theskin/theskin.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Skin registration
{{SkinInstall |registration=Yes }}
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
wfLoadSkin( 'theskin' );- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing skins using
wfLoadSkin()
, since MediaWiki 1.25. If you need to install this skin in earlier versions, instead ofwfLoadSkin( 'theskin' );
, you need to use:require_once "$IP/skins/theskin/theskin.php";(To run a skin on an earlier release, you may need to download the version of it tagged for that release from Special:SkinDistributor.)
Vagrant
{{SkinInstall |vagrant=1 }}
- If using Vagrant , install with
vagrant roles enable 1 -p
Manual installation
- Download and place the file(s) in a directory called
theskin
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
require_once "$IP/skins/theskin/theskin.php";- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
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 }}
- If using Vagrant , install with
vagrant roles enable accountinfo -p
Manual installation
- Download and place the file(s) in a directory called
Example
in yourskins/
folder.- Add the following code at the bottom of your LocalSettings.php file:
wfLoadSkin( 'Example' ); $wgUseAjax = true;- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
To users running MediaWiki 1.24 or earlier:
The instructions above describe the new way of installing skins using
wfLoadSkin()
, since MediaWiki 1.25. If you need to install this skin in earlier versions, instead ofwfLoadSkin( 'Example' );
, you need to use:require_once "$IP/skins/Example/Example.php";(To run a skin on an earlier release, you may need to download the version of it tagged for that release from Special:SkinDistributor.)
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Skin name over-ride | 1 | Set the skin name manually
| String | optional |
Download link over-ride | download-link | Overwrite the download link
| 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 |