1,212
edits
Halopedia:Skins/Onyx: Difference between revisions
add quick and dirty installation instructions + some spacing to the config options table
(Began documenting nav and toolbox) |
Jack Phoenix (talk | contribs) (add quick and dirty installation instructions + some spacing to the config options table) |
||
| Line 12: | Line 12: | ||
==Installation== | ==Installation== | ||
# Make sure that your wiki is using a compatible version of MediaWiki (basically whatever Halopedia is currently using; see [[Special:Version]]) | |||
# Check out the source code via git into your wiki's <code>skins</code> directory: <code>git clone https://github.com/Halopedia/Onyx.git</code> | |||
# Add the following to your wiki's <code>LocalSettings.php</code> file to initialize the skin: <code>wfLoadSkin( 'Onyx' );</code> | |||
# Configure at will ([[#Configuration options|see below for details]]) | |||
# Visit your wiki's <code>Special:Version</code> page to verify that the skin has been correctly installed | |||
# That's it! | |||
==Configuration options== | ==Configuration options== | ||
| Line 45: | Line 50: | ||
{| 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=20% style="padding:5px;"|Option | ! width=20% style="padding:5px;" | Option name | ||
!width=10% style="padding:5px;"|Type | ! width=10% style="padding:5px;" | Type | ||
!width=20% style="padding:5px;"|Default | ! width=20% style="padding:5px;" | Default value | ||
!width=45% style="padding:5px;"|Description | ! width=45% style="padding:5px;" | Description | ||
!width=5% style="padding:5px;"|Version | ! width=5% style="padding:5px;" | Version | ||
|- | |- | ||
|style="padding:5px;"|navigation-source | | style="padding:5px;" | navigation-source | ||
|style="padding:5px;"|string | | style="padding:5px;" | string | ||
|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.0≤ | | 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;"|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.0≤ | | style="padding:5px;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|enable-custom-user-toolboxes | | style="padding:5px;" | enable-custom-user-toolboxes | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|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.0≤ | | 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;"|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.0≤ | | style="padding:5px;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|banner-logo | | style="padding:5px;" | banner-logo | ||
|style="padding:5px;"|string | | style="padding:5px;" | string | ||
|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="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 | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|header-logo | | style="padding:5px;" | header-logo | ||
|style="padding:5px;"|string | | style="padding:5px;" | string | ||
|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="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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|show-sidebar-by-default-on-edit | | style="padding:5px;" | show-sidebar-by-default-on-edit | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|style="padding:5px;"|''false'' | | 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;" | 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="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-on-main-page | | style="padding:5px;" | show-sidebar-by-default-on-main-page | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|style="padding:5px;"|''false'' | | 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;" | 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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|enable-recent-changes-module | | style="padding:5px;" | enable-recent-changes-module | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|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="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 | ||
|style="padding:5px;"|integer | | style="padding:5px;" | integer | ||
|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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|recent-changes-amount | | style="padding:5px;" | recent-changes-amount | ||
|style="padding:5px;"|integer | | style="padding:5px;" | integer | ||
|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="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 | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|page-contents-min-headings | | style="padding:5px;" | page-contents-min-headings | ||
|style="padding:5px;"|integer | | style="padding:5px;" | integer | ||
|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="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;"|custom-sidebar-static-source | | style="padding:5px;" | custom-sidebar-static-source | ||
|style="padding:5px;"|string | | style="padding:5px;" | string | ||
|style="padding:5px;"|''"Template:Onyx/Sidebar/Static"'' | | 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;" | 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;" | 1.0.0≤ | ||
|- | |- | ||
|style="padding:5px;"|custom-sidebar-sticky-source | | style="padding:5px;" | custom-sidebar-sticky-source | ||
|style="padding:5px;"|string | | style="padding:5px;" | string | ||
|style="padding:5px;"|''"Template:Onyx/Sidebar/Sticky"'' | | 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;" | 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="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-html5 | | style="padding:5px;" | use-html5 | ||
|style="padding:5px;"|boolean | | style="padding:5px;" | boolean | ||
|style="padding:5px;"|''true'' | | 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;" | 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≤ | | style="padding:5px;" | 1.0.0≤ | ||
|} | |} | ||