ヘルプ:テンプレートの説明文 - 変更履歴

由亜辺出夫: 表示崩れ防止

2019-04-02T13:15:58Z

表示崩れ防止

竪場島: +cat

2017-08-29T20:51:19Z

+cat

Game-M: sp

2010-01-07T16:01:08Z

黄色のニクイ奴: 新しいページ: ' テンプレートはとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すれ...'

2008-02-02T00:32:27Z

新しいページ: ' テンプレートはとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すれ...'

新規ページ

[[Help:テンプレート|テンプレート]]はとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すればよいのかがわかりにくい、複雑なテンプレートも多く存在します。これらのテンプレートには、'''テンプレートの説明文'''が副えられることが望ましいでしょう。ここでは、テンプレートの説明文の記述方法について解説します。

== テンプレートのページに書く方法 ==
最も簡単な方法は、テンプレートの使用方法を解説した部分を<noinclude>と</noinclude>のタグの間に挿んで提示するものです。また、[[Template:Documentation]]を用いて<nowiki><noinclude>{{Documentation|content=「解説文」}}</noinclude> </nowiki>とする方法もあります。このような解説文は、テンプレートの呼びだし先には表示されず、テンプレートページでのみ表示されるようになっています。簡単な説明の場合にはこれで十分ですが、この方式には欠点があります。
* <nowiki><noinclude>...</noinclude></nowiki>に囲まれたテキストは「展開前のサイズ ''pre-expand include size''」に計上されてしまい、これには上限があります（詳しくは[[Help:テンプレートの制限]]を参照してください）。
* いくつかのテンプレートは、その編集が多くのページに与える多大な影響を考慮し、保護されています。この場合、解説文書の編集は管理者に依頼するよりほかありません。

このため、サブページを使って、テンプレート本体から解説文書を別ページとして安全に切り離すための方法も整備されています。これにより解説文書は保護せずに、テンプレート本体を完全に保護することが可能となり、複雑なテンプレートが破壊される恐れなしに、解説文書を誰でも編集できるようになります。

== 解説サブページを作成する方法 ==
ここでは、Template:X に解説[[Help:サブページ|サブページ]]を作成するものとして解説します。ただし、この方法は[[Help:名前空間|名前空間]]によって制限されるものではないことに注意してください。

まず、Template:X の最後の行に[[Template:Documentation]]を<noinclude>タグで囲んで貼り付け、編集を完了します。これでテンプレート本体には、本体コードと[[Template:Documentation]]のみを記述して、説明文、言語間リンク、カテゴリはサブページに移行することができます。

'''注意''': <nowiki><noinclude></nowiki> は<u>改行せずに</u>テンプレート本体の最後の文字と同じ行に続けて配置するようにして下さい。そうしないと、余分な改行がテンプレートを呼び出したページに反映されてしまいます。

'''テンプレート本体（Template:X）に貼り付けるコード'''
<pre><noinclude>
{{Documentation}}

</noinclude></pre>

次に右上の[編集]のリンクをクリックすると、[[Template:Documentation/preload|説明文の雛形]]が記述された Template:X/doc の編集画面が開くのでコメント文を参考に編集して、解説サブページの完成です。説明文、言語間リンク、カテゴリ、{{Tl|複雑なテンプレート}}や{{Tl|告知}}のようなテンプレートも全てサブページに記述します。

== 実例 ==
* [[Template:Commons]] - サブページを使わないでタグを使った例
* [[Template:郵便局]] - サブページを使わないでテンプレートを使った例
* [[Template:国際化]] - サブページを使った例
* [[Template:国際化/doc]] - 解説サブページの例

== 関連項目 ==
* [[Template:Documentation]]
* [[Template:Documentation subpage]]
* [[Wikipedia:テンプレートのサンドボックスとテストケース]]
* [[Help:テンプレート#一部を無視させる]] - <noinclude>と<includeonly>の解説

{{DEFAULTSORT:てんふれとのせつめいふん}}
[[Category:ユアペディアのテンプレート|*せつめいふん]]
[[Category:テンプレート文書|*]]

[[en:Wikipedia:Template_documentation]]
[[id:Wikipedia:Dokumentasi_templat]]
[[uk:В?к?пед?я:Документац?я_шаблон?в]]
[[zh:Wikipedia:模板文件頁模式]]

@@ 2行目: / 2行目: @@
 == テンプレートのページに書く方法 ==
-最も簡単な方法は、テンプレートの使用方法を解説した部分を&lt;noinclude>と&lt;/noinclude>のタグの間に挿んで提示するものです。 また、[[Template:Documentation]]を用いて<nowiki><noinclude>{{Documentation|content=「解説文」}}</noinclude> </nowiki>とする方法もあります。このような解説文は、テンプレートの呼びだし先には表示されず、テンプレートページでのみ表示されるようになっています。簡単な説明の場合にはこれで十分ですが、この方式には欠点があります。
+最も簡単な方法は、テンプレートの使用方法を解説した部分を<nowiki>&lt;noinclude&gt;</nowiki>と<nowiki>&lt;/noinclude&gt;</nowiki>のタグの間に挿んで提示するものです。 また、[[Template:Documentation]]を用いて<nowiki><noinclude>{{Documentation|content=「解説文」}}</noinclude></nowiki>とする方法もあります。このような解説文は、テンプレートの呼びだし先には表示されず、テンプレートページでのみ表示されるようになっています。簡単な説明の場合にはこれで十分ですが、この方式には欠点があります。
-* <nowiki>&lt;noinclude>...&lt;/noinclude></nowiki>に囲まれたテキストは「展開前のサイズ ''pre-expand include size''」に計上されてしまい、これには上限があります（詳しくは[[Help:テンプレートの制限]]を参照してください）。
+* <nowiki>&lt;noinclude&gt;...&lt;/noinclude&gt;</nowiki>に囲まれたテキストは「展開前のサイズ ''pre-expand include size''」に計上されてしまい、これには上限があります（詳しくは[[Help:テンプレートの制限]]を参照してください）。
 * いくつかのテンプレートは、その編集が多くのページに与える多大な影響を考慮し、保護されています。この場合、解説文書の編集は管理者に依頼するよりほかありません。
@@ 9行目: / 9行目: @@
 == 解説サブページを作成する方法 ==
-ここでは、Template:X に解説[[Help:サブページ|サブページ]]を作成するものとして解説します。ただし、この方法は[[Help:名前空間|名前空間]]によって制限されるものではないことに注意してください。
+ここでは、<nowiki>Template:X</nowiki>に解説[[Help:サブページ|サブページ]]を作成するものとして解説します。ただし、この方法は[[Help:名前空間|名前空間]]によって制限されるものではないことに注意してください。
-まず、Template:X の最後の行に[[Template:Documentation]]を&lt;noinclude&gt;タグで囲んで貼り付け、編集を完了します。これでテンプレート本体には、本体コードと[[Template:Documentation]]のみを記述して、説明文、言語間リンク、カテゴリはサブページに移行することができます。
+まず、<nowiki>Template:X</nowiki>の最後の行に[[Template:Documentation]]を<nowiki>&lt;noinclude&gt;</nowiki>タグで囲んで貼り付け、編集を完了します。これでテンプレート本体には、本体コードと[[Template:Documentation]]のみを記述して、説明文、言語間リンク、カテゴリはサブページに移行することができます。
-'''注意''': <nowiki>&lt;noinclude></nowiki> は<u>改行せずに</u>テンプレート本体の最後の文字と同じ行に続けて配置するようにして下さい。そうしないと、余分な改行がテンプレートを呼び出したページに反映されてしまいます。
+'''注意''': <nowiki>&lt;noinclude&gt;</nowiki> は'''改行せずに'''テンプレート本体の最後の文字と同じ行に続けて配置するようにして下さい。そうしないと、余分な改行がテンプレートを呼び出したページに反映されてしまいます。
 '''テンプレート本体（Template:X）に貼り付けるコード'''
@@ 21行目: / 21行目: @@
 </noinclude></pre>
-次に右上の[編集]のリンクをクリックすると、[[Template:Documentation/preload|説明文の雛形]]が記述された Template:X/doc の編集画面が開くのでコメント文を参考に編集して、解説サブページの完成です。説明文、言語間リンク、カテゴリ、{{Tl|複雑なテンプレート}}や{{Tl|告知}}のようなテンプレートも全てサブページに記述します。
+次に右上の[編集]のリンクをクリックすると、[[Template:Documentation/preload|説明文の雛形]]が記述された<nowiki>Template:X/doc</nowiki>の編集画面が開くのでコメント文を参考に編集して、解説サブページの完成です。説明文、言語間リンク、カテゴリ、{{Tl|複雑なテンプレート}}や{{Tl|告知}}のようなテンプレートも全てサブページに記述します。
 == 実例 ==
@@ 32行目: / 32行目: @@
 * [[Template:Documentation subpage]]
 * [[Yourpedia:テンプレートのサンドボックスとテストケース]]
-* [[Help:テンプレート#一部を無視させる]] - &lt;noinclude&gt;と&lt;includeonly&gt;の解説
+* [[Help:テンプレート#一部を無視させる]] - <nowiki>&lt;noinclude&gt;</nowiki>と<nowiki>&lt;includeonly&gt;</nowiki>の解説
 {{Wikipedia/Ja}}

@@ 37行目: / 37行目: @@
 {{DEFAULTSORT:てんふれとのせつめいふん}}
 [[Category:ユアペディアのテンプレート|*せつめいふん]]
 [[Category:テンプレート文書|*]]
 [[en:Wikipedia:Template_documentation]]

@@ 1行目: / 1行目: @@
 [[Help:テンプレート|テンプレート]]はとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すればよいのかがわかりにくい、複雑なテンプレートも多く存在します。これらのテンプレートには、'''テンプレートの説明文'''が副えられることが望ましいでしょう。ここでは、テンプレートの説明文の記述方法について解説します。
@@ 28行目: / 27行目: @@
 * [[Template:郵便局]] - サブページを使わないでテンプレートを使った例
 * [[Template:国際化]] - サブページを使った例
 == 関連項目 ==
 * [[Template:Documentation]]
 * [[Template:Documentation subpage]]
-* [[Wikipedia:テンプレートのサンドボックスとテストケース]]
+* [[Yourpedia:テンプレートのサンドボックスとテストケース]]
 * [[Help:テンプレート#一部を無視させる]] - &lt;noinclude&gt;と&lt;includeonly&gt;の解説
 {{DEFAULTSORT:てんふれとのせつめいふん}}
@@ 41行目: / 41行目: @@
 [[en:Wikipedia:Template_documentation]]