55
回編集
差分
ナビゲーションに移動
検索に移動
ページの作成:「<noinclude>{{Documentation subpage}}</noinclude> '''Documentation'''テンプレートは、今ここに表示されているような、Help:テンプレートの説...」
<noinclude>{{Documentation subpage}}</noinclude>
'''Documentation'''テンプレートは、今ここに表示されているような、[[Help:テンプレートの説明文|テンプレートなどの説明文]]を、他のページから自動的に呼び出して表示するためのテンプレートです。主にテンプレートに解説を加えることに使われることを想定していますが、テンプレート以外の他のページに呼び出されるページにも使用できます（名前空間によって制限されているわけではありません）。
__TOC__
== 使い方 ==
=== 基本 ===
あなたがこのテンプレートを使用しようとしているページが「Template:X」だとすると「Template:X/doc」に解説を書いて保存し、「Template:X」に次のコードを付け足してください。
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>
=== ページ指定 ===
解説が保存されているページが「Template:any page/doc」である場合、次のコードを「Template:X」に付け足してください。
<noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude>
=== インライン・コンテンツ ===
解説を別のページに保存せず、次のように「Template:X」に直接書き込むこともできます。
<noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude>
「Template:X/doc」が存在する場合は、そちらも同時に表示されます。
*'''注意'''：「<nowiki>|content=</nowiki>」で指定した部分に含まれている[[Help:表の作り方#パイプ構文|パイプ構文の表]]は'''正しく表示されません'''。「<nowiki>|content=</nowiki>」で指定する部分に表を作成する場合はパイプ構文ではなくHTMLタグを使用するようにしてください。（「/doc」等のこのテンプレートによって呼び出されたページにパイプ構文の表が含まれる場合は、'''正しく表示されます'''。）
=== ヘッドラインを変更する ===
次のように書き込めば、ヘッドラインを変更できます。
<noinclude>{{{{{template-name|Documentation}}}|heading=変更したヘッドライン}}</noinclude>
もし次のように heading 引数を空にすれば、ヘッドラインは表示されません。
<noinclude>{{{{{template-name|Documentation}}}|heading=}}</noinclude>
=== 注意 ===
これらのコードは<noinclude>の前に余分な空白をつけずに、テンプレートやその他の解説を呼び出したいページに付け加えてください。もし、解説・説明文書のページが<includeonly>や<noinclude>といったタグを解説の一部として含むならば「<」を「&lt;」で置き換えてください。
== 特別な機能 ==
=== プリロード ===
もし解説のページが存在しなければ、[編集]リンクは [[Template:Documentation/preload]] から解説の雛形ファイルを[http://www.mediawiki.org/wiki/Manual:Creating_pages_with_preloaded_text/ja プリロード]します。
プリロードするファイルは、preload 引数で変更できます。
=== サンドボックスとテストケースとの連携 ===
このテンプレートは[[Yourpedia:テンプレートのサンドボックスとテストケース|サンドボックスとテストケース]]の存在を確認し、有無に関わらずそのことを通知しサンドボックスとテストケースの使用に誘導します。
この機能は、sandbox-testcases引数に「show」以外を指定することによってキャンセルできます。
== 引数 ==
{| class="wikitable"
|+引数の一覧
!引数!!指定内容!!既定値!!説明
|-
!style="text-align:left"|1
|ページ名||（対象のページ名）/doc||解説として読み込むページ名。
|-
!style="text-align:left"|content
|任意の文章||（引数1で指定したページの内容）||解説として表示する文章。
|-
!style="text-align:left"|heading
|任意の文字列||解説|| ヘッドラインとして表示する文字列。
|-
!style="text-align:left"|heading-style
|CSS書式||font-size:150%||ヘッドラインのスタイル。
|-
!style="text-align:left; white-space:nowrap"|heading-padding
|style="white-space:nowrap"|単位つき数値（CSS書式）||3px||ヘッドラインのパディング。
|-
!style="text-align:left"|heading-margin
|単位つき数値（CSS書式）||1ex||ヘッドラインのマージン。
|-
!style="text-align:left"|transcluded
|任意の文字列||show||「show」以外を指定すると、読込先を表示しない。
|-
!style="text-align:left"|sandbox-testcases
|任意の文字列||show||「show」以外を指定すると、サンドボックスとテストケースの存否を表示しない。
|-
!style="text-align:left"|preload
|ページ名||style="white-space:nowrap"|[[Template:Documentation/preload]]||解説のページが存在しない場合にプレロードする雛形ファイル。
|}
== カテゴリ ==
''このテンプレートが貼り付けられたページに適用するカテゴリはありません。''
== このテンプレートを使う理由 ==
* このテンプレートを使うことによってテンプレートやその他のページが[[Yourpedia:保護の方針|保護]]されていても、そのページのための解説、言語間リンク、カテゴリなどを変更することができます。
* テンプレートのページはテンプレートを表示するための空間に読み込まれますが、その空間の大きさはパフォーマンス上の理由により[[Help:テンプレートの制限|制限されています]]。解説をサブページにおけば、テンプレートのページ自体に書かれるコードを減らすことができます。
== 関連項目 ==
* [[Help:テンプレートの説明文]]
* [[Yourpedia:テンプレートのサンドボックスとテストケース]]
* {{Tl|Documentation subpage}}
<includeonly>
{{Wikipedia/Ja}}
{{DEFAULTSORT:{{PAGENAME}}}}
[[Category:テンプレート文書| ]]
[[Category:テンプレート用テンプレート]]
[[en:Template:Documentation]]
</includeonly>
'''Documentation'''テンプレートは、今ここに表示されているような、[[Help:テンプレートの説明文|テンプレートなどの説明文]]を、他のページから自動的に呼び出して表示するためのテンプレートです。主にテンプレートに解説を加えることに使われることを想定していますが、テンプレート以外の他のページに呼び出されるページにも使用できます（名前空間によって制限されているわけではありません）。
__TOC__
== 使い方 ==
=== 基本 ===
あなたがこのテンプレートを使用しようとしているページが「Template:X」だとすると「Template:X/doc」に解説を書いて保存し、「Template:X」に次のコードを付け足してください。
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>
=== ページ指定 ===
解説が保存されているページが「Template:any page/doc」である場合、次のコードを「Template:X」に付け足してください。
<noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude>
=== インライン・コンテンツ ===
解説を別のページに保存せず、次のように「Template:X」に直接書き込むこともできます。
<noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude>
「Template:X/doc」が存在する場合は、そちらも同時に表示されます。
*'''注意'''：「<nowiki>|content=</nowiki>」で指定した部分に含まれている[[Help:表の作り方#パイプ構文|パイプ構文の表]]は'''正しく表示されません'''。「<nowiki>|content=</nowiki>」で指定する部分に表を作成する場合はパイプ構文ではなくHTMLタグを使用するようにしてください。（「/doc」等のこのテンプレートによって呼び出されたページにパイプ構文の表が含まれる場合は、'''正しく表示されます'''。）
=== ヘッドラインを変更する ===
次のように書き込めば、ヘッドラインを変更できます。
<noinclude>{{{{{template-name|Documentation}}}|heading=変更したヘッドライン}}</noinclude>
もし次のように heading 引数を空にすれば、ヘッドラインは表示されません。
<noinclude>{{{{{template-name|Documentation}}}|heading=}}</noinclude>
=== 注意 ===
これらのコードは<noinclude>の前に余分な空白をつけずに、テンプレートやその他の解説を呼び出したいページに付け加えてください。もし、解説・説明文書のページが<includeonly>や<noinclude>といったタグを解説の一部として含むならば「<」を「&lt;」で置き換えてください。
== 特別な機能 ==
=== プリロード ===
もし解説のページが存在しなければ、[編集]リンクは [[Template:Documentation/preload]] から解説の雛形ファイルを[http://www.mediawiki.org/wiki/Manual:Creating_pages_with_preloaded_text/ja プリロード]します。
プリロードするファイルは、preload 引数で変更できます。
=== サンドボックスとテストケースとの連携 ===
このテンプレートは[[Yourpedia:テンプレートのサンドボックスとテストケース|サンドボックスとテストケース]]の存在を確認し、有無に関わらずそのことを通知しサンドボックスとテストケースの使用に誘導します。
この機能は、sandbox-testcases引数に「show」以外を指定することによってキャンセルできます。
== 引数 ==
{| class="wikitable"
|+引数の一覧
!引数!!指定内容!!既定値!!説明
|-
!style="text-align:left"|1
|ページ名||（対象のページ名）/doc||解説として読み込むページ名。
|-
!style="text-align:left"|content
|任意の文章||（引数1で指定したページの内容）||解説として表示する文章。
|-
!style="text-align:left"|heading
|任意の文字列||解説|| ヘッドラインとして表示する文字列。
|-
!style="text-align:left"|heading-style
|CSS書式||font-size:150%||ヘッドラインのスタイル。
|-
!style="text-align:left; white-space:nowrap"|heading-padding
|style="white-space:nowrap"|単位つき数値（CSS書式）||3px||ヘッドラインのパディング。
|-
!style="text-align:left"|heading-margin
|単位つき数値（CSS書式）||1ex||ヘッドラインのマージン。
|-
!style="text-align:left"|transcluded
|任意の文字列||show||「show」以外を指定すると、読込先を表示しない。
|-
!style="text-align:left"|sandbox-testcases
|任意の文字列||show||「show」以外を指定すると、サンドボックスとテストケースの存否を表示しない。
|-
!style="text-align:left"|preload
|ページ名||style="white-space:nowrap"|[[Template:Documentation/preload]]||解説のページが存在しない場合にプレロードする雛形ファイル。
|}
== カテゴリ ==
''このテンプレートが貼り付けられたページに適用するカテゴリはありません。''
== このテンプレートを使う理由 ==
* このテンプレートを使うことによってテンプレートやその他のページが[[Yourpedia:保護の方針|保護]]されていても、そのページのための解説、言語間リンク、カテゴリなどを変更することができます。
* テンプレートのページはテンプレートを表示するための空間に読み込まれますが、その空間の大きさはパフォーマンス上の理由により[[Help:テンプレートの制限|制限されています]]。解説をサブページにおけば、テンプレートのページ自体に書かれるコードを減らすことができます。
== 関連項目 ==
* [[Help:テンプレートの説明文]]
* [[Yourpedia:テンプレートのサンドボックスとテストケース]]
* {{Tl|Documentation subpage}}
<includeonly>
{{Wikipedia/Ja}}
{{DEFAULTSORT:{{PAGENAME}}}}
[[Category:テンプレート文書| ]]
[[Category:テンプレート用テンプレート]]
[[en:Template:Documentation]]
</includeonly>
