Skin:Mirage

From mediawiki.org
Jump to navigation Jump to search
MediaWiki skins manual - category
Crystal Clear device blockdevice.png
Mirage
Release status: stable
MirageSkin.png
Author(s) Mainframe98
MediaWiki 1.36+
License MIT License
Download
README.md
Translate the Mirage skin if it is available at translatewiki.net
Check usage and version matrix;
Issues : Open tasks · Report a bug

Mirage is a responsive skin that focuses on displaying content with a rail on the right.

About the name[edit]

Mirage is based on Oasis, the skin used by FANDOM. Rather than be an exact copy of the Oasis skin, Mirage is a reflection of Oasis' appearance; a mirage of an oasis.

Features[edit]

Mirage supports on-wiki configuration for several of its features.

Wordmark[edit]

Mirage will use the wordmark from mirage-wordmark.png when that file exists and $wgMirageEnableWordmark is enabled. The file should be 250 pixels wide and 65 pixels high.

Navigation[edit]

Mirage can use navigation defined in MediaWiki:sidebar, but also supports enhanced navigation through the MediaWiki:mirage-navigation message. It uses the same syntax as MediaWiki:sidebar does, but with support for nesting, allowing each navigation dropdown to have a submenu.

Community messages[edit]

Community messages is a right rail module that displays the content of MediaWiki:mirage-community-messages. It only shows if that message is not disabled.

Installation[edit]

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

Themes[edit]

Mirage supports the theme extension out of the box. Additionally, if the Theme extension isn't installed, setting$wgMirageTheme to any of the supported themes listed below, allows enabling the theme manually. This is currently the only way Mirage can provide a dark mode.

Configuration[edit]

$wgMirageEnableWordmark
This setting controls if the file mirage-wordmark.png should be used as the wordmark. When enabled, users can change the wordmark by uploading a new version of that file. The file should be 250 pixels wide and 65 pixels high.
This file should be protected against re-uploads to prevent changes to the wordmark without the proper permissions.
If the file does not exist, or if this setting is disabled, a wordmark will be created from the value of $wgLogos.
$wgMirageTheme
This setting controls the default theme of Mirage, when the theme extension isn't installed. Currently, Mirage supports the neutral and darkmirage themes.
$wgMirageForceTemplateRecompilation
This setting is for development use and disables the caching of the Mustache templates that make up Mirage.
$wgMirageHiddenRightRailModules
This setting contains a list of right rail modules that should not be shown. The list consists of module names.