「テンプレート:Asbox/doc」を編集中

<noinclude>{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}</noinclude><includeonly>{{Sandbox other||{{使用箇所の多いテンプレート|570,000以上}}}}</includeonly>
{{Mbox templates}}
{{Lua|モジュール:Asbox}}
{{Uses TemplateStyles|Template:Asbox/styles.css}}
'''Asbox''' は、記事の[[Wikipedia:スタブ|スタブ]] ({{Lang|en|article stub}}) ボックス用[[メタテンプレート]]です。このテンプレートは[[スタブテンプレート]]作成用の標準テンプレートです。
__TOC__
== 使い方 ==
基本的な使い方：
<syntaxhighlight lang="wikitext">
{{Asbox
|name = {{subst:FULLPAGENAME}}
|image = 
|subject = 
|qualifier = 
|category = 
|tempsort = 
|related = 
}}
</syntaxhighlight>

発展した使い方：
<syntaxhighlight lang="wikitext">
{{Asbox
|name = {{subst:FULLPAGENAME}}
|image = 
|imagealt = 
|pix = 
|article = 
|subject = 
|qualifier =  
|category = 
|tempsort = 
|category1 = 
|tempsort1 = 
|category2 = 
|tempsort2 = 
|related = 
|note = 
|type = 
}}
</syntaxhighlight>

2023年9月の更新により、呼び出し元のスタブテンプレートに対して解説を自動的に生成する機能が追加されました。したがってテンプレートのページで{{tl|Documentation}}を呼び出す必要はありません。

== 引数 ==
{| class="wikitable"
|+ 引数の一覧
! 引数 !! 指定内容 !! 説明
|-
! name
| ページ名 || '''（必須）'''呼び出し元のスタブテンプレートの名前を指定します。<nowiki>{{subst:FULLPAGENAME}}</nowiki>とすると簡単です。 
|-
! image
| ファイル名 || アイコン。
|-
! icon
| 画像 || アイコン。{{para|image}}よりも指定内容に柔軟性があり、例えば{{tl|Flagicon}}のようなテンプレートを使うこともできます。
|-
! imagealt
| 代替テキスト || 画像のalt属性値を変更できます。引数を省略するとalt属性値は「スタブアイコン」となります。
|-
! pix
| 画像サイズ || アイコンのサイズ。
|-
! article
| テキスト || メッセージ冒頭の「項目」の部分を別のテキストに置き換えます。
|-
! subject
| テキスト || スタブの種類。
|-
! qualifier
| テキスト || 
|-
! category
| カテゴリ名 || スタブカテゴリ。
|-
! tempsort
| ソートキー || スタブカテゴリのソートキー。省略するとテンプレート名の先頭にアスタリスク"*"を付けた文字列がソートキーになります。
|-
! category1
| カテゴリ名 || スタブカテゴリ（2番目）。
|-
! tempsort1
| ソートキー || スタブカテゴリ（2番目）のソートキー。
|-
! category2
| カテゴリ名 || スタブカテゴリ（3番目）。{{para|category3}}以降も同様に指定可能です。
|-
! tempsort2
| ソートキー || スタブカテゴリ（3番目）のソートキー。{{para|tempsort3}}以降も同様に指定可能です。
|-
! note
| テキスト || 小さな文字で注釈を入れる。
|-
! related
| テキスト || 関連する[[Wikipedia:ウィキプロジェクト]]、[[Wikipedia:ウィキポータル]]へのリンクなど。<!-- 英語版と非互換 -->
|-
! type
| テキスト || {{para|type|substub}}と指定するとサブスタブ用の表示になり、メッセージが変化するほか、[[File:QSicon_in_Arbeit.svg|24px]]のアイコンが追加で表示されるようになります。<!-- 英語版と非互換 -->
|-
! demo
| テキスト || デモ表示用の引数なので、標準名前空間のページに対しては効果がありません。この引数に空でない値を指定すると、カテゴリをリンクの形式で表示します。{{para|demo|art}}とすると、標準名前空間のページに適用されるカテゴリのみを表示し、テンプレート用のカテゴリは表示しません。{{para|demo|doc}}とすると、カテゴリのリンク表示に加え、解説の生成も常に行います。
|}

== カテゴリ ==
このテンプレートは、呼び出した標準名前空間のページに対して{{para|category}}や{{para|category1}}などの引数で指定したカテゴリを付与します。それに加えて{{clc|すべてのスタブ記事}}を常に付与します。

テンプレート名前空間のページに対しては{{cl|スタブテンプレート}}を常に付与します。それに加えて以下の追跡カテゴリを付与する場合があります:
* {{clc|注意を要するスタブテンプレート}}
* {{clc|画像のないスタブテンプレート}}
* {{clc|icon引数を使用しているスタブテンプレート}}
* {{clc|docサブページが存在するスタブテンプレート}}

[{{Purge|page=Template:Asbox/doc}}]

== 使用例 ==
{{demo|br=出力:|demo_kill_categories=yes
|<nowiki>{{Asbox
|image     = Castle in Inuyama.JPG
|pix       = 55
|subject   = '''[[日本の歴史]]'''
|qualifier = 
|category  = 日本の歴史関連のスタブ項目
|tempsort  = 
|category1 = 
|tempsort1 = 
|category2 = 
|tempsort2 = 
|note      = 
|name      = Template:Japanese-history-stub
|related   = [[プロジェクト:日本史]]／[[Portal:歴史]]
}}
</nowiki>}}
{{demo|br=出力:|demo_kill_categories=yes
|<nowiki>{{Asbox
|image     = Stubico.svg
|pix       = 55
|subject   = '''[[ダミー]]'''
|qualifier = （qualifier）
|category  = スタブ
|tempsort  = 
|category1 = 
|tempsort1 = 
|category2 = 
|tempsort2 = 
|note      = [[:Template:Stub|このテンプレート]]は分野別のスタブテンプレート（[[Wikipedia:スタブカテゴリ]]参照）に変更することが望まれています。
|name      = Template:Dummy-stub
|related   = [[プロジェクト:テンプレート]]
}}
</nowiki>}}

== 外観のカスタマイズ ==
このテンプレートの外観は[[Template:Asbox/styles.css]]で定義されています。[[Special:Mypage/common.css|個人のカスタムCSS]]でスタイルを定義することで、外観をカスタマイズすることができます。

以下の例は、Asboxの外観を2021年11月以前のものにします。これは[[MediaWiki:Common.css]]の[[特別:固定リンク/85598683#L-795|2021年9月17日 (金) 16:42 (UTC)の版]]に存在したものを少し改変しています。
<syntaxhighlight lang="css">
/* [[MediaWiki:Common.css]]の[[特別:固定リンク/85598683#L-795]]以降を少し改変 */
.mw-body-content .mw-parser-output .asbox {
	border: solid #999 1px;
	background-color: #f8f8f8;
	margin: 0.5em 10%;
	clear: both;
}
</syntaxhighlight>
このようにスタイルを定義した場合、{{tl|people-stub}}は以下のように表示されます。
<div style = "border: solid #999 1px; background-color: #f8f8f8; margin: 0.5em 10%; clear: both;">{{Suppress categories|{{People-stub}}}}</div>

== Navbar ==
このテンプレートの内部では[[モジュール:Navbar]]を使用しており、出力には {{View|Asbox/doc|e}} という形式でスタブテンプレートへのリンクが含まれています。通常はリンクが見えなくなっていますが、[[Special:Mypage/common.css|個人のカスタムCSS]]で以下のようにスタイルを定義すると見えるようになります。
<syntaxhighlight lang="css">
.mw-body-content .mw-parser-output .asbox {
    margin-top: 1em;
    overflow: visible;
}
.mw-body-content .mw-parser-output .asbox .navbar {
	display: inherit;
    font-size: 88%;
}
</syntaxhighlight>

== 関連項目 ==
* {{tl|Ambox}} - 記事用
* {{tl|Tmbox}} - ノートページ用
* {{tl|Cmbox}} - カテゴリ用
* {{tl|Ombox}} - その他のページ用
* {{tl|Mbox}} - 名前空間を自動判定して表示形式を変えるメッセージボックス
* {{tl|Fmbox}} - ヘッダ／フッタ用
* {{tl|Dmbox}} - 曖昧さ回避用
<includeonly>{{Sandbox other||
<!-- カテゴリは以下に追加してください -->
[[Category:メッセージボックスメタテンプレート]]
[[Category:スタブテンプレート|*]]
}}</includeonly>