Phabricator project: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Template:Skin

From MediaWiki.org
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

This template should be added to all skin pages on this wiki (but only the main page) to display an information box and categorize the skin.

Usage[edit]

Copy and paste:

{{ {{TNTN|Skin}} |templatemode =
|name            = 
|status          = 
|username        = 
|author          = 
|description     = 
|image           = 
|imagesize       = 
|version         = 
|update          = 
|version preview = 
|update preview  = 
|mediawiki       = 
|php             = 
|composer        =
|license         = 
|download        = 
|readme          = 
|changelog       = 
|example         = 
|parameters      = 
|compatibility   = 
|bugzilla        = 
|phabricator =
}}

For help with parameter values, see below.

MediaWiki skins manual - category
Crystal Clear device blockdevice.png
{{{name}}}

Release status: unknown

Placeholder.png
Description {{{description}}}
Author(s) SomeAuthor (SomeUsertalk)
Latest version

{{{version}}} ({{{update}}})

Latest preview version

{{{version preview}}} ({{{update preview}}})

MediaWiki {{{mediawiki}}}
PHP {{{php}}}
Composer {{{composer}}}
License {{{license}}}
Download {{{download}}}
{{{readme}}}
{{{changelog}}}
Example {{{example}}}
Parameters

{{{parameters}}}

{{{compatibility}}}

Translate the Skin skin if it is available at translatewiki.net

Issues:

[[phab:tag/{{{phabricator}}}|Open tasks]] · Report a bug


Content parameters[edit]

This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.

Content parameters
Parameter Description
name name of the skin
status current release status

One of:

  • unstable (broken - do not use this extension)
  • experimental (early stages of development, may change drastically)
  • beta (stable but not fully tested)
  • stable (stable version)
  • unmaintained (unmaintained - previously claimed to be stable, now unmaintained)
  • unknown (default)

If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead.

username The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.
author The skin author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
description short description
image screenshot or logo of skin. It should be provided without namespace and without [[]]s.
imagesize facultative, size of the image (default size is 220px)
version last version
update date of the last update
mediawiki required version of MediaWiki
php required version of PHP
license license(s) governing use of this skin, e.g. GPL
download link to the download : If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Skin:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
readme external link to the readme file
changelog external link to the changelog file
parameters available parameters for LocalSettings.php
example example, website or screenshot of working skin
compatibility compatibility chart, e.g. Template:Extension Testing
bugzilla Bugzilla MediaWiki skin component name

Control parameters[edit]

Control parameters
Parameter Description
templatemode Controls auto-categorization of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorization. Use this value if you are adding this template to subpages of an skin or to how-to documentation of skins. For example, the usage image above sets templatemode=nocats because this isn't an actual skin page and we don't want to add this page to any categories on account of it.


If this is left blank, this template will add the host page to Category:All skins and to one or more additional categories, depending on the values assigned to the Content parameters. subpage; it is not in the Skin: namespace; or if suppressed by 'templatemode=nocats'

Categories added[edit]

This template will automatically add the pages it is used on to the Category:All skins category.

In addition, it will categorize the page based on the value of the status parameter:

Using the infobox[edit]

Existing skin pages[edit]

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new skin article[edit]

If you want to create a new skin page, enter the name below and click the button. A new page will be created with the infobox template already in place.


Please replace "TheSkin" with your skin's name:


MediaWiki is an open-source project and users are encouraged to make any MediaWiki skins under an Open Source Initiative (OSI) approved GPLv2 compatible license (including MIT, BSD, PD). For skins that have a compatible license, you can request commit access to the MediaWiki source repository for skins. Alternatively, you may also post your code directly on your skin's page, although that is not the preferred method.

A developer sharing their code on the MediaWiki wiki or code repository should expect:

Feedback / Criticism / Code reviews
Review and comments by other developers on things like framework use, security, efficiency and usability.
Developer tweaking
Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
Improved access for wiki sysadmins
If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.
Future versions by other developers
New branches of your code being created by other developers as new versions of MediaWiki are released.
Credit
Credit for your work being preserved in future versions
Similarly, you should credit the developers of any skins whose code you borrow from.

Any developer who is uncomfortable with any of these actions occurring should not host their code directly on the MediaWiki wiki or code repository. You are still encouraged to create a summary page for your skin on the wiki to let people know about the skin, and where to download it. You may also add the {{Skin exception}} template to your skin requesting other developers refrain from modifying your code, although no guarantees can be made that an update will be made if deemed important for security or compatibility reasons. You may use the current issues noticeboard if you feel another developer has violated the spirit of these expectations in editing your skin.


Enhancing this template[edit]

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation[edit]

If you would like to fix documentation, please be aware that documentation and code is split into two files:

  • Template:Skin/doc - stores all documentation.
  • Template:Skin - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).


In addition, Template:Skin/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Skin/doc.

The Create skin button[edit]

To improve the create skin button behavior:

Infobox parameters[edit]

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.

Test case[edit]

See if the following pages are still ok, after edited this template.

Language:Project:Language policy English  • 日本語 • português do Brasil