Halopedia:Skins/Onyx

PARDON OUR DUST! This page is still under construction.

Onyx is a MediaWiki skin designed to emulate and improve upon Oasis, the desktop skin used on wikis hosted by Wikia/FANDOM. It was primarily written by Dab1001 with help from Jack Phoenix, and is maintained by the Halopedia team. It is free and open-source under the GPL v2 license, and its source code can be found here.

Since its inception, the scope of the Onyx skin has expanded beyond just Halopedia, now aiming to provide a fully-featured, general-purpose skin for use on any wiki. Although primarily a surrogate for Oasis, Onyx hopes to improve upon its progenitor wherever possible, with the inclusion of minor improvements and refinements, like a wide page width for more article space, and quality-of-life features like a scrolling table of contents.

History
First conceived in late 2018 while planning the merger of Halo Nation into Halopedia, Onyx's original aim was to ease the transition to Halopedia, for users going from Wikia's service to an independently-hosted wiki. Christened "Onyx" after the eponymous Forerunner shield world in the Halo universe, development began on the project, and its sister project Trove (then named Trevelyan), in January 2019. Progress was slow throughout most of the year, but the skin was released on Halopedia in a beta state in the fourth quarter of 2019.

Onyx was originally planned to be one of a pair of skins, the other being Trevelyan, a mobile skin loosely based on Wikia/FANDOM's mobile skin, Mercury. In April 2020, however, it became clear that Halopedia's then-default skin, Nimbus, would need to be retired due to lack of support for extensions such as Echo, and a desire to modernise the site's frontend. Consequently, this pair of skins was expanded into the Maginot skin family project, and now includes Onyx, Trove (a newly renamed Trevelyan), Requiem and Noble. This project is still in its infancy, however, and is far from complete.

Installation

 * 1) Make sure that your wiki is using a compatible version of MediaWiki (basically whatever Halopedia is currently using; see Special:Version)
 * 2) Check out the source code via git into your wiki's   directory:
 * 3) Add the following to your wiki's   file to initialize the skin:
 * 4) Configure at will (see below for details)
 * 5) Visit your wiki's   page to verify that the skin has been correctly installed
 * 6) That's it!

Configuration options
Onyx features a large number of configuration options, to allow wikis to customise it to their exact needs. As part of the Maginot skin family, Onyx will also inherit configuration settings set for that family, so that consistency. However, configuration options set specifically for Onyx will override those set for Maginot family as a whole. So, for instance, if the options  and   are both set, the skin will favour the value of.

If any are left unset, the skin will use a sensible default value instead. Despite this, however, it is strongly recommended that you at least set  and , as these default to the value of  , which typically points to a square image ill-suited to the Onyx skin.

Example
This is an example Onyx configuration setup.

$wgOnyxNavigationSource = 'MediaWiki:Onyx/Navigation'; $wgOnyxToolboxSource = 'MediaWiki:Onyx/Toolbox'; $wgOnyxBannerLogo = $wgScriptPath. '/images/4/47/myBannerLogo.png'; $wgOnyxHeaderLogo = $wgScriptPath. '/images/6/3A/myHeaderLogo.png';

List
The following is a list of all configuration options currently supported by Onyx. Each option is also supported by the entire Maginot skin family, and a configuration option can be set for all Maginot skins by replacing the  in   with.

Navigation and Toolbox
For the navigation and toolbox lists, Onyx implements a superset of the standard MediaWiki:Sidebar syntax. Firstly, it supports nested lists, which will manifest as dropdown menus. These can be up to two levels deep. For example, the following content would create a dropdown list labelled "Lorem", with three options: "Ipsum", "Dolor" and "Consectetur", where "Dolor" is itself a dropdown list with options "Sit" and "Amet".


 * Lorem
 * Ipsum
 * Dolor
 * Sit
 * Amet
 * Consectetur

In addition, the navigation list supports assigning 14x14 icons to the options. These either use the id of any icon in the the Maginot family's shared icon set, in which case the icons will be displayed as inline SVGs and can hence be styled using CSS, or can be the page name of a file on the wiki, in which case the corresponding image will be scaled to the appropriate size. The syntax to assign these icons to the navigation options is as follows:


 * PAGE_TITLE  | LINK_TEXT
 * PAGE_TITLE {File:FILENAME} | LINK_TEXT

Because '<', '>', '{' and '}' are not valid characters in page titles, this syntax will never conflict with page names. However, it is not compatible with other skins, and so it is strongly advised that you do not use this syntax on any navigation list pages shared by other skins.

Icons
Onyx and the other Maginot skins share a set of icons for consistency with one another. These icons are used in a number of areas on the skins, but can be used to augment the navigation list elements with a CSS-styleable inline SVG beside their labels (see the Navigation and Toolbox section). The following is a list of all of the icons currently included: