Extension:Theme

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Theme

Release status:Extension status stable

ImplementationTemplate:Extension#type Skin
DescriptionTemplate:Extension#description Allows using themes of skins
Author(s)Template:Extension#username Ryan Schmidt
Jack Phoenix
Samantha Nguyen
Latest versionTemplate:Extension#version 2.1
MediaWikiTemplate:Extension#mediawiki 1.30+
LicenseTemplate:Extension#license Public domain
(the main PHP file is PD-licensed, while some of the actual theme files may not be)
Download
ExampleTemplate:Extension#example ShoutWiki
ParametersTemplate:Extension#parameters

$wgDefaultTheme

Hooks usedTemplate:Extension#hook
BeforePageDisplayManual:Hooks/BeforePageDisplay
GetPreferencesManual:Hooks/GetPreferences
OutputPageBodyAttributesManual:Hooks/OutputPageBodyAttributes

Translate the Theme extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The Theme extension allows loading of themes (preset CSS to change the appearance of a skin). Users can determine their preferred theme by configuring this in their preferences. The $wgDefaultTheme variable can be used to control what theme is being used site-wide, and the usetheme=X parameter is accepted on a request to change the theme on a per-pageload basis.

This extension was written by Skizzerz for ShoutWiki.

Installation[edit]

  • Download and place the file(s) in a directory called Theme in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'Theme' );
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Parameters[edit]

$wgDefaultTheme controls which theme is displayed by default when users visit your wiki.

Available themes[edit]

For MonoBook
  • dark
  • pink
  • stellarbook
For Vector
  • dark
  • deepsea

Adding themes[edit]

To add a new theme for a core skin (such as Modern or Vector), create a directory called skinname (i.e. vector) under $IP/extensions/Theme, place the CSS file(s) there and register the new theme in Theme/extension.json file, under ResourceModules object.

To add a new theme for a custom skin, register a module for each theme in the skin's main setup file. The naming convention is themeloader.skins.skinname-in-lowercase.themename-in-lowercase; for example, the module name of the AutumnLeaf theme for the BlueCloud skin would be themeloader.skins.bluecloud.autumnleaf.