Jump to content

Skin:Cavendish

From mediawiki.org
MediaWiki skins manual - category
Cavendish
Release status: stable
Description Mozilla Cavendish skin based on MonoBook style by Gabriel Wicke.
Author(s) Mozilla, Daniel Schuba, Jack Phoenix, Samantha Nguyen
Latest version 3.0.0 (2022-05-23)
MediaWiki 1.39+
License GNU General Public License 2.0 or later
Download
Example
Quarterly downloads 16 (Ranked 21st)
Public wikis using 173 (Ranked 29th)
Public wikis using as default skin 19
Translate the Cavendish skin if it is available at translatewiki.net
Issues : Open tasks · Report a bug

The Cavendish skin is a rework of the skin formerly used at wiki.mozilla.org. It was modified to work better with new versions of MediaWiki.

Installation

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

Configuration

[edit]

There are different parameters for the skin that can be set in your wiki's LocalSettings.php file.

Configuration option name Default value Details
$wgCavendishLogoURL false URL to the custom logo that should be displayed in the header. By default, no custom logo is displayed.
$wgCavendishLogoWidth 322 Width of the custom logo as a number in pixels (px)
$wgCavendishLogoHeight 53 Height of the custom logo as a number in pixels (px)
$wgCavendishLogoMargin 10 Offset on top of the custom logo
$wgCavendishQRCode false Display a Quick Response (QR) code on all pages? When enabled, the QR codes are generated by pinging an external server at api.qrserver.com.
$wgCavendishQRUrlAdd "?pk_campaign=qr-code" Additional URL parameters (as a string) to be appended to wiki page URLs when QR code generation is enabled. This can be useful to track users coming to the wiki via QR codes if you use analytics software on your wiki. This configuration option has no effect when QR code generation is turned off ($wgCavendishQRCode = false;).
$wgCavendishQRCodeMode "all" Acceptable values are the strings all or print. If all, the "powered by MediaWiki" button image (#f-poweredbyico) is supposed to be hidden via CSS; if print, then the QR code element (#qrcode) is supposed to be hidden via CSS, but this feature might be broken altogether.
$wgCavendishSiteWidth false Fixed width (in pixels) of the content area; it's dynamic if not set
$wgCavendishSidebarSearchbox true Display the search bar (#p-search) in the top navigation area (#nav)? If false, the said bar is then hidden via CSS.

Version history

[edit]
  • 0.9.2: works with MW 1.15.1
  • 0.9.5: Some bugs were reported but could not be verified yet.
  • 1.2.0: big rework and uses many elements from MonoBook skin to be compatible with most MW versions.
  • 1.3.1: was tested with MediaWiki 1.16.5 and 1.17.0 and 1.19alpha.
  • 1.3.3: bugfixes and added support for MediaWiki 1.15
  • 1.3.6: bugfixes and added option for Google +1 button
  • 1.5.0: Dropped support for older versions of MediaWiki and cleaned code
  • 1.6.0: Cleanup of old compatibilities
  • 1.6.1: print.css improved
  • 1.6.3: print improved and QR code added to the front page
  • 1.6.4: small improvements
  • 2.5.0 (1 November 2020): MediaWiki 1.35 or newer is now required; added support for page status indicators, optimized CSS, turned off QR code generation by default and fixed the skin to be compatible with 1.35
  • 2.6.0 (18 February 2022): $wgCavendishColor and $wgCavendishExtensionCSS settings removed
  • 3.0.0 (23 May 2022): MediaWiki 1.39 or newer is now required