Template:SkinInstall

From mediawiki.org
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎svenska • ‎čeština • ‎български • ‎русский • ‎فارسی • ‎中文 • ‎日本語 • ‎한국어
  • 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";
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.
Template documentation

Usage[edit]

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[edit]

Below a few examples of how to use this template:

Simple[edit]

{{SkinInstall}}
  • Download and place the file(s) in a directory called theskin in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/theskin/theskin.php";
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Name[edit]

{{SkinInstall|erudite}}
  • Download and place the file(s) in a directory called erudite in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/erudite/erudite.php";
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Download link[edit]

{{SkinInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Download and place the file(s) in a directory called theskin in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/theskin/theskin.php";
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

LocalSettings[edit]

{{SkinInstall
|localsettings=
$wgUseAjax = true;
$wgEnableMWSuggest = true;
}}
  • Download and place the file(s) in a directory called theskin in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/theskin/theskin.php";
$wgUseAjax = true;
$wgEnableMWSuggest = true;
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Custom steps[edit]

{{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 your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/theskin/theskin.php";
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Skin registration[edit]

{{SkinInstall
|registration=Yes
}}
  • Download and place the file(s) in a directory called theskin in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadSkin( 'theskin' );
  • Yes 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 of wfLoadSkin( '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[edit]

{{SkinInstall
|vagrant=1
}}
  • If using Vagrant , install with vagrant roles enable 1 -p

Manual installation[edit]

  • Download and place the file(s) in a directory called theskin in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/skins/theskin/theskin.php";
  • Yes Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Everything[edit]

{{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[edit]

  • Download and place the file(s) in a directory called Example in your skins/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadSkin( 'Example' );
$wgUseAjax = true;
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes 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 of wfLoadSkin( '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.

Template parameters

ParameterDescriptionTypeStatus
Skin name over-ride1

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

Unknownoptional
Download link over-ridedownload-link

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

Unknownoptional
New-style registrationregistration

Whether to use the new style to register the skin

Unknownoptional
Installation directorybasedir

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

Unknownoptional
LocalSettings codelocalsettings

Custom PHP code that the user should include in LocalSettings.php

Unknownoptional
Custom stepscustom-steps

Additional steps (as an unordered * list) that you need to undertake to install the skin.

Unknownoptional
Nocreditsnocredits

no description

Unknownoptional