Template:Top icon/doc

This is a documentation subpage for Template:Top icon.
It contains usage information, categories and other content that is not part of the original template page.

Template:注意利用者ページや記事の右上（ページタイトル右横）に小さい（通常20x20ピクセル）アイコンを表示するためのテンプレートで、ページステータスインジケータ(page status indicator)システムを使用します。

使用法

{{Top icon
| imagename    = 使用するファイル名を名前空間やウィキリンク抜きのファイル名で記入。
| wikilink     = アイコンのリンク先を指定。
| description  = アイコンをマウスオーバーした際に表示される説明文。
| id           = indicator が使用する識別子。識別子を同じくするものが同一ページ内に存在する場合、一つしか表示されない。
}}

任意のオプション:

| width        = アイコンサイズの横幅。既定値は20。
| height       = アイコンサイズの縦幅。既定値は20。
| usercat      = 利用者名前空間で使用された際に利用するカテゴリ名を指定。
| maincat      = 記事（標準）名前空間で使用された際に利用するカテゴリ名を指定。
| subpage      = サブページである場合にカテゴリを適用するのか否かを指定。 (既定値はno)
| nocat        = テンプレート自身にカテゴリを適用するか否か。 (既定値はno)

|width=と|height=には制限があり、一方のパラメータが指定されていない場合、通常、指定した高い方の値が最大値となります。サイズ全体を拡大したい場合は両方指定する必要があります。

TemplateData

転送 Template:TemplateData header

No description.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
ファイル名	`image` `imagename`	使用するファイル名を名前空間やウィキリンク抜きのファイル名で記入します。 Example Padlock-violet.svg	File	required
横幅	`width`	アイコンサイズの横幅を指定します。 Default 20 Example 20	Number	optional
縦幅	`height`	アイコンサイズの縦幅を指定します。 Default 20 Example 20	Number	optional
リンク先	`link` `wikilink`	アイコンのリンク先を指定します。 Example Wikipedia:半保護の方針#半永久的な半保護	Page name	optional
代替文	`alt`	アイコンをマウスオーバーした際に表示される代替 (alt) 文章です。[[Help:画像の表示#キャプションをつける]] の alt です。 Example アイコンの説明文。	String	suggested
アイコンの説明文	`text` `description`	アイコンをマウスオーバーした際に表示される説明文です。 alt が指定されている場合、そちらを優先します。 Example アイコンの説明。	String	optional
識別子	`name` `id`	indicator が使用する識別子です。識別子を同じくするものが同一ページ内に存在する場合、一つしか表示されません。 Default 指定されない場合、image 引数が利用されます。 Example name	String	suggested
利用者名前空間用カテゴリ	`usercat`	利用者名前空間で使用された際に利用するカテゴリ名を指定します。 [[Template:Category handler]] 由来のものです。 Example [[Category:ウィキペディアン]]	Content	optional
標準名前空間用カテゴリ	`maincat`	記事（標準）名前空間で使用された際に利用するカテゴリ名を指定します。[[Template:Category handler]] 由来のものです。 Example Category:編集保護中の記事	Unknown	optional
サブページへのカテゴリ適用可否	`subpage`	サブページである場合にカテゴリを適用するのか否かを指定します。"no"（適用しない）, "yes"（適用）, "only"（サブページのみ適用）の何れかより指定してください。 [[Template:Category handler]] 由来のものです。 Example yes	String	optional
カテゴリ非適用	`nocat`	テンプレート自身にカテゴリを適用するか否か。[[Template:Category handler]] 由来のものです。	String	optional