「テンプレート:Documentation subpage」の版間の差分

提供: Yourpedia
移動: 案内検索
1行目: 1行目:
 +
このテンプレートは、(主にテンプレートの)[[Help:テンプレートの説明文|解説]][[Help:サブページ|サブページ]]であることを告知するために使います。
 +
__TOC__
 +
== 使い方 ==
  
<onlyinclude><includeonly>{{
+
=== 基本 ===
  #ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
+
次のコードをページの冒頭に張るだけです:
  | <!-- doc page -->
+
&lt;noinclude&gt;<nowiki>{{Documentation subpage}}</nowiki>&lt;/noinclude&gt;
</includeonly>{{
+
 
    #ifeq: {{{doc-notice|show}}} | show
+
=== 解説の対象を指定する ===
    | <!-- doc-notice show -->{{Ombox
+
次のように解説の対象を指定することもできます:
| type = notice
+
&lt;noinclude&gt;<nowiki>{{Documentation subpage|[[Template:X]]}}</nowiki>&lt;/noinclude&gt;
| image-file = Edit-copy green.svg
+
 
| text = '''これは、{{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}の[[Help:テンプレートの説明文|解説]][[Help:サブページ|サブページ]]です。'''<br />使用方法、[[Help:言語間リンク|言語間リンク]]と[[Help:カテゴリ|カテゴリ]]、そのほか{{{種類|{{ #if: {{SUBJECTSPACE}} |{{SUBJECTSPACE ja}}ページ|記事}}}}}そのものに含まれない情報を含んでいます。他のページから呼び出して表示することを意図しているため、[[Help:サブページ#相対リンク|相対リンク]]や[[Help:条件文|条件文]]などの動作が意図しないものになっていることがあります。<br /><span style="font-size: 0.9em;">{{{種類|{{ #if: {{SUBJECTSPACE}} |{{SUBJECTSPACE ja}}ページ|記事}}}}}自体は、{{{1|[[{{ #if: {{SUBJECTSPACE}} |{{SUBJECTSPACE}}:}}{{BASEPAGENAME}}]]}}}をご覧ください。</span>
+
=== 種類を指定する ===
}}
+
次のように解説の対象の種類を指定することもできます:
    | <!-- doc-notice hide -->
+
&lt;noinclude&gt;<nowiki>{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}</nowiki>&lt;/noinclude&gt;
  }}<includeonly>
+
 
  |<!-- not doc -->
+
== 引数 ==
}}</includeonly><includeonly>{{
+
{| class="wikitable" border="1"
  #ifeq: {{SUBPAGENAME}} | doc
+
|+ 引数の一覧
  | {{
+
! 引数 !! 指定内容 !! 既定値 !! 説明
    #ifeq: {{NAMESPACE}} | {{ns:10}}
+
|-
    | [[Category:テンプレート文書|{{PAGENAME}}]]
+
! style="text-align:left;" | 1
    }}
+
| ページ名 || <nowiki>[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]</nowiki> || 解説の対象を指定。
}}</includeonly></onlyinclude>
+
|-
{{Documentation}}
+
! style="text-align:left;" | override
<!-- Add categories and interwikis to the /doc subpage, not here! -->
+
| サブページ名 || doc || そのテンプレートは、この引数で指定されたサブページ名を持つページでだけ機能します。
 +
|-
 +
! style="text-align:left;" | doc-notice
 +
| 任意の文字列 || show || 「show」以外を指定すると、このテンプレートは告知を出力しません。
 +
|-
 +
! style="text-align:left;" | 種類
 +
| 任意の文字列 || {{tl|SUBJECTSPACE ja}}ページ<small>(標準名前空間以外のとき)</small><br />記事<small>(標準名前空間のとき)</small>|| 解説の対象の種類を指定。
 +
|}
 +
 
 +
== カテゴリ ==
 +
このテンプレートは、貼り付けられたページに次のカテゴリを適用します:
 +
{| class="wikitable" border="1"
 +
|+ 適用するカテゴリの一覧
 +
! カテゴリ !! ソートキー !! 解説
 +
|-
 +
! style="text-align:left;" | [[:Category:テンプレート文書]]
 +
| <nowiki>{{PAGENAME}}</nowiki>
 +
| {{ns:10}} 名前空間にあるページのみをカテゴライズします。
 +
|}
 +
 
 +
== 関連項目 ==
 +
* [[Help:テンプレートの説明文]]
 +
* {{Tl|Documentation}}
 +
<includeonly>
 +
 
 +
{{DEFAULTSORT:{{PAGENAME}}}}
 +
[[Category:テンプレート文書| ]]
 +
[[Category:テンプレート用テンプレート]]
 +
 
 +
</includeonly>

2014年8月18日 (月) 12:33時点における版

このテンプレートは、(主にテンプレートの)解説サブページであることを告知するために使います。

使い方

基本

次のコードをページの冒頭に張るだけです:

<noinclude>{{Documentation subpage}}</noinclude>

解説の対象を指定する

次のように解説の対象を指定することもできます:

<noinclude>{{Documentation subpage|[[Template:X]]}}</noinclude>

種類を指定する

次のように解説の対象の種類を指定することもできます:

<noinclude>{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}</noinclude>

引数

引数の一覧
引数 指定内容 既定値 説明
1 ページ名 [[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]] 解説の対象を指定。
override サブページ名 doc そのテンプレートは、この引数で指定されたサブページ名を持つページでだけ機能します。
doc-notice 任意の文字列 show 「show」以外を指定すると、このテンプレートは告知を出力しません。
種類 任意の文字列 {{SUBJECTSPACE ja}}ページ(標準名前空間以外のとき)
記事(標準名前空間のとき)
解説の対象の種類を指定。

カテゴリ

このテンプレートは、貼り付けられたページに次のカテゴリを適用します:

適用するカテゴリの一覧
カテゴリ ソートキー 解説
Category:テンプレート文書 {{PAGENAME}} テンプレート 名前空間にあるページのみをカテゴライズします。

関連項目