カービィWiki
カービィWiki
 
(2人の利用者による、間の5版が非表示)
1行目: 1行目:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
  +
テンプレートページの使用法などを記載した説明書を表示するためのテンプレートです。
 
  +
== 解説 ==
  +
このテンプレートはテンプレートに解説を挿入する目的で使用します。
  +
== 構文 ==
  +
テンプレートページの最後に<code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code>を追記してください。
  +
他のテンプレートページの /doc サブページを読み込む場合は、<code><nowiki><noinclude></nowiki>{{t|Documentation|解説ページ名}}<nowiki></noinclude></nowiki></code>を追記してください。
   
 
== 使用法 ==
 
== 使用法 ==
   
  +
=== テンプレートページ上での利用 ===
説明書を表示させたいテンプレートページの後ろに「'''/doc'''」を付加したページ(たとえば「テンプレート:Documentation」なら「テンプレート:Documentation/doc」)というテンプレートページを新たに作成し、そこに直接テンプレートの使用法などを記載します。(「'''解説サブページ'''」と呼びます。)
 
  +
これは通常のフォーマットでの使用例です。
   
  +
<pre>
次に対象のテンプレートページに戻り編集画面に行き、表示させたい位置に
 
  +
テンプレートコード<includeonly>テンプレートによって記事に挿入される任意のカテゴリ</includeonly><noinclude>
<pre><noinclude>{{Documentation}}</noinclude></pre>
 
  +
{{documentation}}</noinclude>
と挿入してください。
 
  +
</pre>
   
テンプレート部分を ''<nowiki><includeonly><onlyinclude></nowiki>'' で囲んでいる場合は ''<nowiki><noinclude></nowiki>'' は必要ありません。
 
   
  +
'''テンプレートによっては、( noinclude タグつきで) 挿入した<code><nowiki>{{documentation}}</nowiki></code>の前で table タグや div タグを閉じる必要がある場合があります。'''
== 解説サブページの記述について ==
 
  +
  +
<code><nowiki>{{documentation}}</nowiki></code> の直前の改行は、解説テンプレートが前のコードに影響するのを防ぐのにも役立ちます。
  +
  +
=== テンプレート解説ページ上での使用 ===
  +
通常、解説ページはテンプレートの /doc サブページに作成します。他のページを解説として呼び出す場合は、このテンプレートの第1パラメーターで指定してください。(詳細は[[#構文]]をご覧ください。)
  +
 
解説サブページの1行目に
 
解説サブページの1行目に
 
<pre>{{Documentation subpage}}</pre>
 
<pre>{{Documentation subpage}}</pre>
 
と記載することで、このページが解説サブページであることを明示してください。
 
と記載することで、このページが解説サブページであることを明示してください。
  +
通常は、解説ページには以下のようなことを書くとよいでしょう。
   
  +
<pre>
また、カテゴリや言語間リンク(デフォルトソートも含む)をテンプレートに含ませたい場合は、解説サブページの一番下に
 
  +
{{Documentation subpage}}
<pre><includeonly>
 
  +
;解説
{{DEFAULTSORT:~~}}
 
  +
:このテンプレートは……に使用します。
[[Category:~~]]
 
[[Category:~~]]
 
.
 
.
 
.
 
   
  +
;必要なファイル <!-- 空の場合はなし -->
[[en:~~]]
 
  +
<!-- このテンプレートが使用しているモジュール、CSS、JS、画像、他のテンプレートについて -->
[[fr:~~]]
 
  +
:*
.
 
  +
.
 
  +
;構文
.
 
  +
:……に <code>{{t|テンプレート名|引数1 <!-- 空の場合はなし -->}}</code> と入力してください。
</includeonly>
 
  +
  +
;使用例
  +
:<code><nowiki>{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}</nowiki></code> は次のようになります...
  +
:{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}
  +
  +
;関連項目 <!-- 空の場合はなし -->
  +
:* [[テンプレート:<!-- 関連するテンプレート -->]] <!-- 空の場合はなし -->
  +
:* [[<!-- その他の関連情報 -->]] <!-- 空の場合はなし -->
  +
 
<includeonly>
  +
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}
  +
<!-- テンプレートのカテゴリ・言語間リンク -->
 
</includeonly><noinclude>
  +
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}[[カテゴリ:テンプレート文書]]
  +
<!-- テンプレート解説ページの言語間リンク -->
  +
</noinclude>
 
</pre>
 
</pre>
  +
という風に ''<nowiki><includeonly></nowiki>'' で囲んだ方式で記述してください。
 
  +
上の「解説」「構文」「使用例」の出力セクションのいずれかまたはすべてを使用してください。「関連項目」や追加情報セクションを追加することもできます。
  +
  +
上の例は[[テンプレート:T]]テンプレートも使用していることに注意してください。
  +
  +
== テンプレートWikiの記事 ==
  +
* [[w:c:ja.templates:テンプレート:{{BASEPAGENAME}}]]
  +
  +
<includeonly>[[カテゴリ:テンプレート]]</includeonly><noinclude>[[カテゴリ:テンプレート文書|{{PAGENAME}}]]</noinclude>

2021年4月18日 (日) 03:13時点における最新版

Template doc icon.png これは、テンプレート:Documentationの解説サブページです。

以下に記載された機能が、このページ自体に組み込まれているわけではありませんのでご注意ください。

解説

このテンプレートはテンプレートに解説を挿入する目的で使用します。

構文

テンプレートページの最後に<noinclude>{{documentation}}</noinclude>を追記してください。 他のテンプレートページの /doc サブページを読み込む場合は、<noinclude>{{Documentation|<解説ページ名>}}</noinclude>を追記してください。

使用法

テンプレートページ上での利用

これは通常のフォーマットでの使用例です。

テンプレートコード<includeonly>テンプレートによって記事に挿入される任意のカテゴリ</includeonly><noinclude>
{{documentation}}</noinclude>


テンプレートによっては、( noinclude タグつきで) 挿入した{{documentation}}の前で table タグや div タグを閉じる必要がある場合があります。

{{documentation}} の直前の改行は、解説テンプレートが前のコードに影響するのを防ぐのにも役立ちます。

テンプレート解説ページ上での使用

通常、解説ページはテンプレートの /doc サブページに作成します。他のページを解説として呼び出す場合は、このテンプレートの第1パラメーターで指定してください。(詳細は#構文をご覧ください。)

解説サブページの1行目に

{{Documentation subpage}}

と記載することで、このページが解説サブページであることを明示してください。 通常は、解説ページには以下のようなことを書くとよいでしょう。

{{Documentation subpage}}
;解説
:このテンプレートは……に使用します。

;必要なファイル <!-- 空の場合はなし -->
<!-- このテンプレートが使用しているモジュール、CSS、JS、画像、他のテンプレートについて -->
:* 

;構文
:……に <code>{{t|テンプレート名|引数1 <!-- 空の場合はなし -->}}</code> と入力してください。

;使用例
:<code>{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}</code> は次のようになります...
:{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}

;関連項目 <!-- 空の場合はなし -->
:* [[テンプレート:<!-- 関連するテンプレート -->]] <!-- 空の場合はなし -->
:* [[<!-- その他の関連情報 -->]] <!-- 空の場合はなし -->

<includeonly>
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}
<!-- テンプレートのカテゴリ・言語間リンク -->
</includeonly><noinclude>
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}[[カテゴリ:テンプレート文書]]
<!-- テンプレート解説ページの言語間リンク -->
</noinclude>

上の「解説」「構文」「使用例」の出力セクションのいずれかまたはすべてを使用してください。「関連項目」や追加情報セクションを追加することもできます。

上の例はテンプレート:Tテンプレートも使用していることに注意してください。

テンプレートWikiの記事