Template:Skin

課題管理システム: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]
From mediawiki.org
This page is a translated version of the page Template:Skin and the translation is 72% complete.
Outdated translations are marked like this.
テンプレートの解説

このテンプレートは、このウィキのすべての外装ページ (ただし、メインページのみ) に追加する必要があります。これにより、基礎情報ボックスが表示され、外装がカテゴリ分けされます。

使用法

以下をコピー & ペーストします:

{{Skin|templatemode =
|name                 = 
|localised name       = 
|status               = 
|hook1                = 
|hook2                = 
|newhook1             = 
|newhook2             = 
|username             = 
|author               = 
|description          = 
|image                = 
|imagesize            = 
|version              = 
|update               = 
|version preview      = 
|update preview       = 
|compatibility policy =
|mediawiki            = 
|php                  = 
|composer             =
|license              = 
|download             = 
|readme               = 
|changelog            = 
|example              = 
|parameters           = 
|compatibility        = 
|bugzilla             = 
|phabricator          =
|vagrant-role         =
}}

引数の値のヘルプは下記を参照してください。

MediaWiki 外装マニュアル - カテゴリ
{{{localised name}}}
リリースの状態: 不明
説明 {{{description}}}
作者 SomeAuthor
最新バージョン {{{version}}} ({{{update}}})
最新プレビュー バージョン {{{version preview}}} ({{{update preview}}})
互換性の方針 無効
MediaWiki {{{mediawiki}}}
PHP {{{php}}}
Composer {{{composer}}}
ライセンス {{{license}}}
ダウンロード {{{download}}}
{{{readme}}}
{{{changelog}}}
{{{example}}}
パラメーター
{{{parameters}}}
{{{compatibility}}}
translatewiki.net で翻訳を利用できる場合は、Skin 外装の翻訳にご協力ください
Vagrant role {{{vagrant-role}}}
問題点 : [[phab:tag/{{{phabricator}}}|未解決のタスク]] · バグを報告

コンテンツのパラメーター

この節では情報ボックスの内容を制御する引数を解説します。

templatemodeその他の制御パラメーターに関するヘルプは制御のパラメーターを参照してください。
コンテンツのパラメーター
パラメーター 説明
name外装の名前
localised name source text for localising name of the skin

Specify the same value as name.

It will be used later for localising the name.
status現在のリリースの状態

以下のいずれか:

  • unstable - 破損 - この外装を使用しないでください
  • experimental - 開発の初期段階は、大幅に変化する可能性があります
  • beta - 安定しているが完全にテストされていない
  • stable - stable - the skin works in the latest MediaWiki version without any fatal errors.
  • unmaintained - unmaintained - only use if the linked repository is archived or the maintainer has not responded to an enquiry about the maintained status. If using this status, please link to a patch or issue/bug report as a reference using an HTML comment. If the skin is broken use unstable instead.
  • unknown - 既定

上記以外のステータスの場合は無視され、代わりに既定値である「Unknown」がテンプレートに表示されます。

hook1
hook2
hook3
hook4
...
hook90
拡張機能が使用する各フックの名前

このフィールドに値を入力することは、拡張機能を広く知らせ、他の開発者を支援する良い方法です。 文書化された各フックは、そのフックを使用する拡張機能を列挙するカテゴリに自動的に追加されます。 このカテゴリは各フック ページに自動的にリンクされるため、プログラマーは特定のフックを使用する拡張機能の例を簡単に見つけられます。

組み込みのフックについては:

  • フック名のみを使用します。 値については Manual:Hooks を参照してください (ただし、先頭の '/' は省略します)。

拡張機能で定義されたカスタム フックについては:

  • extensionName/hookName を使用します。 カスタム フックの部分的な一覧は Extension hook registry を参照してください。
複数のフックの場合は、最初のフックを hook1 に、2 番めのフックを hook2 に、以降のフックをそれぞれ割り当てます。
newhook1
newhook2
newhook3
newhook4
...
newhook90

拡張機能が提供する各フックの名前

また、フックを Extension hook registry に追加することもできます。

username MediaWiki.orgでの作者の利用者名 (登録済の場合)。 省略可能ですが、登録してある場合は作者の利用者ぺージならびにそのトークページにリンクするため使用します。 名前空間名と[[]]を除去して記入します。
author MediaWiki.org での利用者名と異なる場合、外装の作者名。 フリーテキスト。 省略すると'username'欄を使用 (登録済みの場合)。
description 短い説明
image 外装のスクリーンショットまたはロゴ。 名前空間名と[[]]を除去して記入します。
imagesize 文字通り画像サイズ (既定値は220px)
version 最終バージョン
updatedate of the last update
compatibility policy compatibility policy (accepted values are master, rel and ltsrel). (backlog )
mediawikirequired version of MediaWiki
phprequired version of PHP
licenselicense(s) governing use of this skin, e.g. GPL
downloadlink to the download: Use {{WikimediaDownloadSkin}} or {{GithubDownload}}.
readmeexternal link to the readme file
changelogexternal link to the changelog file
parametersavailable parameters for LocalSettings.php
exampleexample, website or screenshot of working skin
compatibilitycompatibility chart
bugzillaBugzilla MediaWiki skin component name

制御のパラメーター

Control parameters
Parameter Description
templatemodeControls auto-categorisation of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorisation. Use this value if you are adding this template to subpages of a 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.

この項目を空白のままにすると、このテンプレートはホスト ページを カテゴリ:すべての外装 に追加し、コンテンツ パラメーターに割り当てられた値に応じて 1 つ以上の追加カテゴリに追加します。

subpage; it is not in the Skin: namespace; or if suppressed by 'templatemode=nocats'

Categories added

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

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

基礎情報ボックスの使用

既存の外装ページ

既存のページに情報ボックスを追加するには、このページ冒頭のコードをコピー&ペーストします。

外装ページの新規作成

外装のページを新規作成するには、下記の欄にページ名を記入してボタンをクリックします。 すると基礎情報ボックスを備えたページが新規作成されます。

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.

A developer sharing their code in the code repository should expect:

フィードバック / 批評 / コード レビュー
他の開発者による、フレームワークの使用、セキュリティ、効率、使い勝手などのレビューとコメント。
開発者による手直し
他の開発者が、新しいフレームワークのクラスやメソッド、コーディング規約、翻訳に合わせて、あなたの提出したコードを改善またはクリーンアップするために修正すること。
他の開発者による将来のバージョン
MediaWiki の新バージョンがリリースされると、他の開発者によってあなたのコードの新しいブランチが作成される。
帰属
あなたの作品の著作権情報が将来のバージョンでも保持されること
同様に、コードを借用した外装は、その開発者の著作権表記をする必要があります。

これらの操作のいずれかが発生することを不快に思う開発者は、コード リポジトリで自分のコードをホスティングしてはいけません。 また、ウィキに外装の概要ページを作成し、外装とそのダウンロード先を知らせることも推奨されています。

Enhancing this template

If you would like to improve on this template, thanks!

This is a complicated template so here is some help along the way:

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 the documentation.

The Create skin button

To improve the create skin button behavior:

Infobox parameters

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 cases

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