Skin:Citizen

From mediawiki.org
Jump to navigation Jump to search
MediaWiki skins manual - category
OOjs UI icon layout-ltr.svg
Citizen
Release status: stable
Screenshot-skin-citizen.png
Description A responsive skin developed for the Star Citizen Wiki
Author(s) alistair3149, Octfx
Compatibility policy Master maintains backwards compatibility.
MediaWiki 1.35.2+
License GNU General Public License 3.0 or later
Download
README on GitHub
Example Star Citizen Wiki, Star Citizen Wiki DE, Wikimedia Skin Lab, MediaWiki Skins Wiki
Parameters
  • $wgCitizenThemeDefault
  • $wgCitizenEnableSearch
  • $wgCitizenSearchGateway
  • $wgCitizenSearchDescriptionSource
  • $wgCitizenMaxSearchResults
  • $wgCitizenEnableManifest
  • $wgCitizenManifestThemeColor
  • $wgCitizenManifestBackgroundColor
  • $wgCitizenShowPageTools
  • $wgCitizenEnablePreconnect
  • $wgCitizenPreconnectURL
  • $wgCitizenThemeColor
  • $wgCitizenEnableDrawerSubSearch
  • $wgCitizenPortalAttach
  • $wgCitizenEnableCollapsibleSections
Translate the Citizen skin if it is available at translatewiki.net
Check usage and version matrix;

Citizen is a minimalistic responsive skin for MediaWiki built by the Star Citizen Wiki team. Although it is specifically built for the Star Citizen Wiki, the skin is configured to be flexible and able to run on any MediaWiki installation that is 1.35.2 or higher.

If you find an issue or there is some improvements that you would like to work on, please feel free to submit patches or report issues over at Github. Alternatively you can also use the discussion page for any help regarding the skin.

Notable features[edit]

  • Fully responsive skin: Responsive and able to adapt to different screen sizes.
  • Light/dark mode support: Switch between light and dark mode. Require JS
  • Adjustable font size and page width: Read the article the way you wanted. Require JS
  • Collapsible sections: Collapse and expand article sections. Require JS
  • Persistent ToC: Access ToC anywhere in the article. Tracking require JS
  • Rich search suggestions: More helpful search suggestions with images and descriptions. Require JS
  • Webapp manifest: Give a more app-like experience when user add your wiki to their home screen.

Screenshots[edit]

Installation[edit]

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

Configuration[edit]

The skin works out of the box without any configurations. The config flags allow more customization on the specific features in the skin.

Note that:

  • If you have a lot of users that does not use javascript, it is recommended to turn off image lazyload as it requires javascript to display images properly.

Appearance[edit]

Name Description Values Default
$wgCitizenThemeDefault The default theme of the skin 'auto' - switch between light and dark according to OS/browser settings; 'light'; 'dark' 'auto'
$wgCitizenEnableCollapsibleSections Enables or disable collapsible sections on content pages true - enable; false - disable true
$wgCitizenShowPageTools The condition of page tools visibility true - always visible; 'login' - visible to logged-in users; 'permission' - visible to users with the right permissions true
$wgCitizenEnableDrawerSiteStats Enables the site statistics in drawer menu true - enable; false - disable true
$wgCitizenEnableDrawerSubSearch Enables the drawer search box for menu entries true - enable; false - disable false
$wgCitizenPortalAttach Label of the portal to attach links to upload and special pages to string 'first'
$wgCitizenThemeColor The color defined in the theme-color meta tag Hex color code '#131a21'

Search suggestions[edit]

Name Description Values Default
$wgCitizenEnableSearch Enable or disable rich search suggestions true - enable; false - disable true
$wgCitizenSearchGateway Which gateway to use for fetching search suggestion mwActionApi; mwRestApi mwActionApi
$wgCitizenSearchDescriptionSource Source of description text on search suggestions wikidata - Use description provided by WikibaseLib or ShortDescription; textextracts - Use description provided by TextExtracts; pagedescription - Use description provided by Description2 or any other extension that sets the description page property textextracts
$wgCitizenMaxSearchResults Max number of search suggestions Integer > 0 6

Webapp manifest[edit]

Name Description Values Default
$wgCitizenEnableManifest Enable or disable web app manifest true - enable; false - disable true
$wgCitizenManifestThemeColor Theme color of the web app manifest Hex color code #131a21
$wgCitizenManifestBackgroundColor Background color of the web app manifest Hex color code #131a21

Miscellaneous[edit]

Name Description Values Default
$wgCitizenEnablePreconnect Enable or disable preconnect to required origin true - enable; false - disable false
$wgCitizenPreconnectURL The URL for preconnect to required origin URL