テンプレート:Notice/docのソースを表示

<!-- 以下でテンプレートの解説を編集してください -->
汎用のお知らせテンプレートです。'''[[Subst]]:''' は非推奨。

== 使い方 ==
任意の場所に、以下のように入力します。
: <code><nowiki>{{Notice|表示したい文字列}}</nowiki></code>
{{Notice|表示したい文字列}}

このように、簡単にお知らせテンプレートを設置することができます。[[Template:Mbox]]を使用しているため、このテンプレートを記事で呼び出せば[[Template:Ambox]]と同様の表示が得られます。

複数のパラメータを設定して使うこともできます。
: <code><nowiki>{{Notice|表示したい文字列|タイトル（題）|style=スタイル}}</nowiki></code>
: <code><nowiki>{{Notice|表示したい文字列|style=スタイル}}</nowiki></code>
: <code><nowiki>{{Notice|text=表示したい文字列|title=タイトル（題）|style=スタイル}}</nowiki></code>
: <code><nowiki>{{Notice|text=表示したい文字列|header=ヘッダータイトル（題）|style=スタイル}}</nowiki></code>

=== スタイル ===
「スタイル」の部分には、<code>announce, attention, fix, help, idea, important, propose, question, search, stop, warning</code>の値を設定することができますが、一部のスタイルは画像が未設定のため利用できません。
; announce
{{Notice|表示したい文字列|style=announce}}
; attention
{{Notice|表示したい文字列|style=attention}}
; fix
{{Notice|表示したい文字列|style=fix}}
; help
{{Notice|表示したい文字列|style=help}}
; idea
{{Notice|表示したい文字列|style=idea}}
; important
{{Notice|表示したい文字列|style=important}}
; propose
{{Notice|表示したい文字列|style=propose}}
; question
{{Notice|表示したい文字列|style=question}}
; search
{{Notice|表示したい文字列|style=search}}
; stop
{{Notice|表示したい文字列|style=stop}}
; warning
{{Notice|表示したい文字列|style=warning}}
; news
{{Notice|表示したい文字列|style=news}}

=== 小型化 ===
小型化には{{para|small}}もしくは{{para|section}}が使えます。これらの引数の挙動はテンプレートを貼り付けたページが属する名前空間によって異なります。

==== 標準名前空間の場合 ====
記事の節で使いたい場合は、{{para|section}}に空でない値を指定するか、{{para|small|left}}としてください（{{para|small|right}}や{{para|small|yes}}のような指定は無効です）。{{para|section}}を使用した場合は幅一杯に表示されます。
 <nowiki>{{Notice|表示したい文字列|section=1|demospace=main}}</nowiki>
{{Notice|text=表示したい文字列|section=1|demospace=main}}
 <nowiki>{{Notice|表示したい文字列|small=left|demospace=main}}</nowiki>
{{Notice|text=表示したい文字列|small=left|demospace=main}}

==== ファイル名前空間もしくはCategory名前空間の場合 ====
ファイル名前空間およびCategory名前空間で使用した場合は'''小型化ができません'''。

==== その他の名前空間の場合 ====
{{para|small|yes}}としてください（{{para|small|left}}のような指定は無効です）。{{para|section}}は使えません。

 <nowiki>{{Notice|表示したい文字列|small=yes}}</nowiki>

{{Notice|表示したい文字列|small=yes}}
{{-}}

== 引数 ==
{| class="wikitable"
|+引数の一覧
!colspan="2"|引数!!指定内容!!style="white-space:nowrap"|既定値!!説明
|-
!text!!1
|任意の文字列||なし||表示する文章
|-
!title!!2
|任意の文字列||なし||強調して表示する題
|-
!style!!3
|<code>announce, attention, fix, help, idea, important, propose, question, search, stop, warning</code>||なし||指定がなければ<code>notice</code>スタイル
|-
!colspan="2"|header
|任意の文字列||なし||ヘッダーにセンタリングした状態で強調して表示する題
|-
!colspan="2" style="white-space:nowrap"|section
|任意の文字列||なし||入力されていれば記事において節用のスタイルで表示
|-
!colspan="2"|small
|<code>left</code> / <code>yes</code> / <code>no</code>||なし|| 記事においてはleftを、それ以外の名前空間ではsmallを指定すれば小型化表示（ファイルとCategory名前空間では無効）
|}

<templatedata>
{
	"description": "Mboxのテンプレートデータ",
	"params": {
		"small": {
			"label": "small",
			"type": "string",
			"description": "記事においてはleftを、それ以外の名前空間ではsmallを指定すれば小型化表示（ファイルとCategory名前空間では無効）",
			"suggestedvalues": [
				"left",
				"yes",
				"no"
			]
		},
		"text": {
			"label": "text",
			"type": "string",
			"description": "表示する文章",
			"aliases": [
				"1"
			],
			"suggested": true
		},
		"style": {
			"aliases": [
				"3"
			],
			"label": "style",
			"description": "指定がなければnoticeスタイル",
			"type": "string",
			"suggestedvalues": [
				"notice",
				"attention",
				"fix",
				"important",
				"search",
				"stop"
			],
			"default": "notice",
			"suggested": true
		},
		"header": {
			"label": "header",
			"description": "ヘッダーにセンタリングした状態で強調して表示する題",
			"type": "string"
		},
		"section": {
			"label": "section",
			"description": "入力されていれば記事において節用のスタイルで表示",
			"type": "string"
		},
		"title": {
			"aliases": [
				"2"
			],
			"label": "title",
			"description": "強調して表示する題",
			"type": "string",
			"suggested": true
		}
	},
	"paramOrder": [
		"text",
		"title",
		"style",
		"header",
		"section",
		"small"
	]
}
</templatedata>

== 関連テンプレート ==
* {{tl|注意}} - 注意を促す専用のテンプレート
* {{tl|告知}} - 議論等の告知をするテンプレート
* {{tl|Dablink}} - [[曖昧さ回避]]用のテンプレート
* {{tl|Memo}} - 汎用的なお知らせ、警告テンプレート

== 関連項目 ==
* [[:Category:免責テンプレート]]
<includeonly>{{Sandbox other||<!-- カテゴリは以下に追加してください -->
[[Category:お知らせテンプレート|* Notice]]
}}</includeonly>