Halopedia:Skins/Onyx: Difference between revisions
From Halopedia, the Halo wiki
(Updated with more options. Still not finished) |
(Added in the final set of configuration options) |
||
| Line 41: | Line 41: | ||
{| width=100% style="background-color:rgba(127, 127, 127, 0.2);" | {| width=100% style="background-color:rgba(127, 127, 127, 0.2);" | ||
|- style="background-color:rgba(0, 0, 0, 0.2);" | |- style="background-color:rgba(0, 0, 0, 0.2);" | ||
!width= | !width=20% style="padding:5px;"|Option Name | ||
!width=10% style="padding:5px;"|Type | !width=10% style="padding:5px;"|Type | ||
!width= | !width=20% style="padding:5px;"|Default Setting | ||
!width= | !width=45% style="padding:5px;"|Description | ||
!width=5% style="padding:5px;"|Version | !width=5% style="padding:5px;"|Version | ||
|- | |- | ||
| Line 51: | Line 51: | ||
|style="padding:5px;"|''"MediaWiki:Onyx-navigation"'' | |style="padding:5px;"|''"MediaWiki:Onyx-navigation"'' | ||
|style="padding:5px;"|The full page name (including namespace) from which the navigation menus should be drawn. If the specified page does not exist, the skin will default to the content of [[MediaWiki:Sidebar]] instead. | |style="padding:5px;"|The full page name (including namespace) from which the navigation menus should be drawn. If the specified page does not exist, the skin will default to the content of [[MediaWiki:Sidebar]] instead. | ||
|style="padding:5px;"|1.0≤ | |style="padding:5px;"|1.0.0≤ | ||
|- | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|toolbox-source | |style="padding:5px;"|toolbox-source | ||
|style="padding:5px;"|string | |style="padding:5px;"|string | ||
|style="padding:5px;"|''"MediaWiki:Onyx-toolbox"'' | |style="padding:5px;"|''"MediaWiki:Onyx-toolbox"'' | ||
|style="padding:5px;"|The full page name (including namespace) from which the custom toolbox links should be drawn. If the specified page does not exist, the skin will default to the usual toolbox links instead. | |style="padding:5px;"|The full page name (including namespace) from which the custom toolbox links should be drawn. If the specified page does not exist, the skin will default to the usual toolbox links instead. | ||
|style="padding:5px;"|1.0≤ | |style="padding:5px;"|1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|enable-custom-user-toolboxes | |style="padding:5px;"|enable-custom-user-toolboxes | ||
| Line 63: | Line 63: | ||
|style="padding:5px;"|''true'' | |style="padding:5px;"|''true'' | ||
|style="padding:5px;"|Determines whether users can customise their own toolboxes, by creating a sub-page of their user page in the same format as the toolbox customisation page. | |style="padding:5px;"|Determines whether users can customise their own toolboxes, by creating a sub-page of their user page in the same format as the toolbox customisation page. | ||
|style="padding:5px;"|1.0≤ | |style="padding:5px;"|1.0.0≤ | ||
|- | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|custom-user-toolbox-suffix | |style="padding:5px;"|custom-user-toolbox-suffix | ||
|style="padding:5px;"|string | |style="padding:5px;"|string | ||
|style="padding:5px;"|''"Onyx-toolbox"'' | |style="padding:5px;"|''"Onyx-toolbox"'' | ||
|style="padding:5px;"|The name of the sub-page of the user page from which the custom toolbox information should be drawn, if custom user toolboxes are enabled. | |style="padding:5px;"|The name of the sub-page of the user page from which the custom toolbox information should be drawn, if custom user toolboxes are enabled. | ||
|style="padding:5px;"|1.0≤ | |style="padding:5px;"|1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|banner-logo | |style="padding:5px;"|banner-logo | ||
| Line 75: | Line 75: | ||
|style="padding:5px;"|''$wgLogo'' | |style="padding:5px;"|''$wgLogo'' | ||
|style="padding:5px;"|The URL of the image that should be used for the logo on the banner. Set it in the same manner as you would $wgLogo. It is recommended that the image be exactly 45px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | |style="padding:5px;"|The URL of the image that should be used for the logo on the banner. Set it in the same manner as you would $wgLogo. It is recommended that the image be exactly 45px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|use-banner-logo-image | |style="padding:5px;"|use-banner-logo-image | ||
| Line 80: | Line 81: | ||
|style="padding:5px;"|''true'' | |style="padding:5px;"|''true'' | ||
|style="padding:5px;"|This decides whether an image logo should be displayed in the banner, or if it should instead be replaced by the wiki's title in plain text. True corresponds to displaying the logo image, and false to displaying the title as text. | |style="padding:5px;"|This decides whether an image logo should be displayed in the banner, or if it should instead be replaced by the wiki's title in plain text. True corresponds to displaying the logo image, and false to displaying the title as text. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- | |- | ||
|style="padding:5px;"|header-logo | |style="padding:5px;"|header-logo | ||
| Line 85: | Line 87: | ||
|style="padding:5px;"|''$wgLogo'' | |style="padding:5px;"|''$wgLogo'' | ||
|style="padding:5px;"|The URL of the image that should be used for the logo on the page header. Set it in the same manner as you would [[mw:Manual:$wgLogo|$wgLogo]]. It is recommended that the image be exactly 135px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | |style="padding:5px;"|The URL of the image that should be used for the logo on the page header. Set it in the same manner as you would [[mw:Manual:$wgLogo|$wgLogo]]. It is recommended that the image be exactly 135px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|show-sidebar-by-default | |style="padding:5px;"|show-sidebar-by-default | ||
|style="padding:5px;"|boolean | |style="padding:5px;"|boolean | ||
|style="padding:5px;"|true | |style="padding:5px;"|''true'' | ||
|style="padding:5px;"|Determines whether the sidebar should be collapsed or expanded upon initial page load, if there are no saved cookies indicating the user's preference. | |style="padding:5px;"|Determines whether the sidebar should be collapsed or expanded upon initial page load, if there are no saved cookies indicating the user's preference. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- | |||
|style="padding:5px;"|show-sidebar-by-default-on-edit | |||
|style="padding:5px;"|boolean | |||
|style="padding:5px;"|''false'' | |||
|style="padding:5px;"|Determines whether the sidebar should be collapsed or expanded by default when editing, if there are no saved cookies indicating the user's preference. | |||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |||
|style="padding:5px;"|show-sidebar-by-default-on-main-page | |||
|style="padding:5px;"|boolean | |||
|style="padding:5px;"|''false'' | |||
|style="padding:5px;"|Determines whether the sidebar should be collapsed or expanded by default on the wiki's main page, if there are no saved cookies indicating the user's preference. | |||
|style="padding:5px;"|1.0.0≤ | |||
|- | |- | ||
|style="padding:5px;"|enable-recent-changes-module | |style="padding:5px;"|enable-recent-changes-module | ||
| Line 95: | Line 111: | ||
|style="padding:5px;"|''true'' | |style="padding:5px;"|''true'' | ||
|style="padding:5px;"|Enables or disables the recent changes module on the sidebar, with true corresponding to enabled. Disabling recent changes may have a minor performance increase, as it removes the need for another database read on page load. However, the results are cached, so the hit to performance should be minimal. | |style="padding:5px;"|Enables or disables the recent changes module on the sidebar, with true corresponding to enabled. Disabling recent changes may have a minor performance increase, as it removes the need for another database read on page load. However, the results are cached, so the hit to performance should be minimal. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|recent-changes-cache-expiry-time | |style="padding:5px;"|recent-changes-cache-expiry-time | ||
| Line 100: | Line 117: | ||
|style="padding:5px;"|''30'' | |style="padding:5px;"|''30'' | ||
|style="padding:5px;"|The time, in seconds, before the cached information used by the recent changes sidebar module should be considered expired, and hence refreshed. | |style="padding:5px;"|The time, in seconds, before the cached information used by the recent changes sidebar module should be considered expired, and hence refreshed. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- | |- | ||
|style="padding:5px;"|recent-changes-amount | |style="padding:5px;"|recent-changes-amount | ||
| Line 105: | Line 123: | ||
|style="padding:5px;"|''7'' | |style="padding:5px;"|''7'' | ||
|style="padding:5px;"|The number of recent changes that should be displayed on the recent changes sidebar module. | |style="padding:5px;"|The number of recent changes that should be displayed on the recent changes sidebar module. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |- style="background-color:rgba(255, 255, 255, 0.1);" | ||
|style="padding:5px;"|enable-page-contents-module | |style="padding:5px;"|enable-page-contents-module | ||
| Line 110: | Line 129: | ||
|style="padding:5px;"|''true'' | |style="padding:5px;"|''true'' | ||
|style="padding:5px;"|Determines whether or not the page contents sidebar module should be displayed. This has no impact on server-side performance, as the contents list is populated using client-side JavaScript. | |style="padding:5px;"|Determines whether or not the page contents sidebar module should be displayed. This has no impact on server-side performance, as the contents list is populated using client-side JavaScript. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- | |- | ||
|style="padding:5px;"|page-contents-min-headings | |style="padding:5px;"|page-contents-min-headings | ||
| Line 115: | Line 135: | ||
|style="padding:5px;"|''3'' | |style="padding:5px;"|''3'' | ||
|style="padding:5px;"|The minimum number of headings the page needs to include in order for the page contents sidebar module to be displayed. | |style="padding:5px;"|The minimum number of headings the page needs to include in order for the page contents sidebar module to be displayed. | ||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |||
|style="padding:5px;"|custom-sidebar-static-source | |||
|style="padding:5px;"|string | |||
|style="padding:5px;"|''"Template:Onyx/Sidebar/Static"'' | |||
|style="padding:5px;"|The full page name (including namespace) of the page from which the static custom sidebar module content should be drawn. The static custom module sits at the very top of the sidebar and will ''not'' follow the user as they scroll along the page. | |||
|style="padding:5px;"|1.0.0≤ | |||
|- | |||
|style="padding:5px;"|custom-sidebar-sticky-source | |||
|style="padding:5px;"|string | |||
|style="padding:5px;"|''"Template:Onyx/Sidebar/Sticky"'' | |||
|style="padding:5px;"|The full page name (including namespace) of the page from which the sticky custom sidebar module content should be drawn. The sticky custom module sits at the bottom of the sidebar and ''will'' follow the user as they scroll along the page. | |||
|style="padding:5px;"|1.0.0≤ | |||
|- style="background-color:rgba(255, 255, 255, 0.1);" | |||
|style="padding:5px;"|use-html5 | |||
|style="padding:5px;"|boolean | |||
|style="padding:5px;"|''true'' | |||
|style="padding:5px;"|Determines if the skin will output an HTML5 webpage, or one that is compliant with older versions of HTML. | |||
|style="padding:5px;"|1.0.0≤ | |||
|} | |} | ||
<!-- NOTE TO SELF: USE THIS FOR SYNTAX OF NAV AND TOOLBOX PAGES: | <!-- NOTE TO SELF: USE THIS FOR SYNTAX OF NAV AND TOOLBOX PAGES: | ||
Revision as of 20:10, October 5, 2019
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.
First conceived by Dab1001 during the merger of Halo Nation into Halopedia in early 2019, its aim was to ease the transition for users going from Wikia's service to an independently-hosted wiki. TODO: Finish this section
Installation
TODO
Configuration options
Onyx features a number of configuration options to allow wikis to customise it to their needs. For convenience and to avoid polluting the global namespace, all Onyx configuration options can be set using an associative array assigned to the variable $wgOnyxConfig. Nevertheless, if you would prefer to set each option individually as its own global variable, Onyx does support this: just convert the option name into camel case and prefix it with $wgOnyx - for example, banner-logo would become $wgOnyxBannerLogo. The skin will prioritise values set in $wgOnyxConfig over those set in individual global variables, if there is a conflict.
If any are left unset, or set to a value of an incorrect type, the skin will use a sensible default value instead. Despite this, however, it is recommended that you at least set banner-logo and header-logo, as these default to the value of $wgLogo, which typically points to a square image ill-suited to the Onyx skin.
Example
This is an example Onyx configuration setup.
$wgOnyxConfig = [ 'navigation-source' => 'MediaWiki:Onyx/Navigation', 'toolbox-source' => 'MediaWiki:Onyx/Toolbox', 'banner-logo' => $wgScriptPath . '/images/4/47/myBannerLogo.png', 'header-logo' => $wgScriptPath . '/images/6/3A/myHeaderLogo.png' ];
This same configuration could also be achieved in the alternative format, like so:
$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.
| Option Name | Type | Default Setting | Description | Version |
|---|---|---|---|---|
| navigation-source | string | "MediaWiki:Onyx-navigation" | The full page name (including namespace) from which the navigation menus should be drawn. If the specified page does not exist, the skin will default to the content of MediaWiki:Sidebar instead. | 1.0.0≤ |
| toolbox-source | string | "MediaWiki:Onyx-toolbox" | The full page name (including namespace) from which the custom toolbox links should be drawn. If the specified page does not exist, the skin will default to the usual toolbox links instead. | 1.0.0≤ |
| enable-custom-user-toolboxes | boolean | true | Determines whether users can customise their own toolboxes, by creating a sub-page of their user page in the same format as the toolbox customisation page. | 1.0.0≤ |
| custom-user-toolbox-suffix | string | "Onyx-toolbox" | The name of the sub-page of the user page from which the custom toolbox information should be drawn, if custom user toolboxes are enabled. | 1.0.0≤ |
| banner-logo | string | $wgLogo | The URL of the image that should be used for the logo on the banner. Set it in the same manner as you would $wgLogo. It is recommended that the image be exactly 45px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | 1.0.0≤ |
| use-banner-logo-image | boolean | true | This decides whether an image logo should be displayed in the banner, or if it should instead be replaced by the wiki's title in plain text. True corresponds to displaying the logo image, and false to displaying the title as text. | 1.0.0≤ |
| header-logo | string | $wgLogo | The URL of the image that should be used for the logo on the page header. Set it in the same manner as you would $wgLogo. It is recommended that the image be exactly 135px in height, and at most 400px in width. The image will be automatically scaled down if it is too tall. | 1.0.0≤ |
| show-sidebar-by-default | boolean | true | Determines whether the sidebar should be collapsed or expanded upon initial page load, if there are no saved cookies indicating the user's preference. | 1.0.0≤ |
| show-sidebar-by-default-on-edit | boolean | false | Determines whether the sidebar should be collapsed or expanded by default when editing, if there are no saved cookies indicating the user's preference. | 1.0.0≤ |
| show-sidebar-by-default-on-main-page | boolean | false | Determines whether the sidebar should be collapsed or expanded by default on the wiki's main page, if there are no saved cookies indicating the user's preference. | 1.0.0≤ |
| enable-recent-changes-module | boolean | true | Enables or disables the recent changes module on the sidebar, with true corresponding to enabled. Disabling recent changes may have a minor performance increase, as it removes the need for another database read on page load. However, the results are cached, so the hit to performance should be minimal. | 1.0.0≤ |
| recent-changes-cache-expiry-time | integer | 30 | The time, in seconds, before the cached information used by the recent changes sidebar module should be considered expired, and hence refreshed. | 1.0.0≤ |
| recent-changes-amount | integer | 7 | The number of recent changes that should be displayed on the recent changes sidebar module. | 1.0.0≤ |
| enable-page-contents-module | boolean | true | Determines whether or not the page contents sidebar module should be displayed. This has no impact on server-side performance, as the contents list is populated using client-side JavaScript. | 1.0.0≤ |
| page-contents-min-headings | integer | 3 | The minimum number of headings the page needs to include in order for the page contents sidebar module to be displayed. | 1.0.0≤ |
| custom-sidebar-static-source | string | "Template:Onyx/Sidebar/Static" | The full page name (including namespace) of the page from which the static custom sidebar module content should be drawn. The static custom module sits at the very top of the sidebar and will not follow the user as they scroll along the page. | 1.0.0≤ |
| custom-sidebar-sticky-source | string | "Template:Onyx/Sidebar/Sticky" | The full page name (including namespace) of the page from which the sticky custom sidebar module content should be drawn. The sticky custom module sits at the bottom of the sidebar and will follow the user as they scroll along the page. | 1.0.0≤ |
| use-html5 | boolean | true | Determines if the skin will output an HTML5 webpage, or one that is compliant with older versions of HTML. | 1.0.0≤ |