ヘルプ:テンプレート

提供: ArchWiki
移動先: 案内検索

テンプレートは、記事に挿入することが出来る定義済みの wikitext です。テンプレートは主としてコンテンツを整形するために使われます。

使用方法

以下のマークアップを記事に追加することでテンプレートを使えます:

{{Template name}}

ほとんどのテンプレートは引数を指定します。例えば Template:Note の場合:

{{Note|This text should be noted.}}

以下のように表示されます:

ノート: This text should be noted.

テンプレートによっては名前付きのパラメータを使うことがあります。Template:hc の場合:

{{hc|head=/etc/rc.local|output=exit 0}}

以下のように表示されます:

/etc/rc.local
exit 0

一般的なフォーマットは:

{{Template name|param1|param2|...|paramN}}

使用方法についてはそれぞれのテンプレートのページを見て下さい。

スタイル

  • テンプレートの名前の先頭の大文字・小文字はサンプルに合わせてください。例えば {{Pkg|...{{ic|... は正しく、{{pkg|...{{Ic|... は誤り。
  • テンプレートの名前の前後に空白を挟んではいけません: {{Template name|... は正しく、{{ Template name |... は誤りです。
  • テンプレートはカテゴリに入れてはいけません。

テンプレートを破壊する文字列のエスケープ

テンプレートの中で使用すると、出力が破壊される文字列が存在します: その中で最も頻繁に使われるのが "=" (イコール記号) と "|" (パイプ記号) です。以下の方法でエスケープしてください。

ヒント: パイプ記号 "|" は {{!}} マジックワードでエスケープできます。

名前付きパラメータ

問題が "=" 記号だけの場合、テンプレートのパラメータの名前やポジション番号を使うことで解決するのがおすすめです。URL にクエリ文字列を含む外部リンクや変数の定義で有用ですが、"|" など他の問題がある文字列には通用しません。例:

{{Tip|1=https://www.archlinux.org/?foo=bar}}

もしくは、複数のパラメータを使って:

{{hc|1=$ echo "="|2==}}
{{hc|head=$ echo "="|output==}}
$ echo "="
=

nowiki タグ

"|" など "=" 以外の文字列で問題を抱えている場合、パラメータ全体を <nowiki> タグで囲ってしまう方法が推奨されます。この方法ではあらゆる文字列を表示しますが、リンクや他のテンプレートなどのテキストマークアップも wiki エンジンによって処理されなくなります。例:

{{Tip|<nowiki>= | }} https://www.archlinux.org/ {{ic|foo}}</nowiki>}}
ヒント: = | }} https://www.archlinux.org/ {{ic|foo}}

特定の部分だけ (あるいは一文字だけ) を <nowiki> タグで囲うことも可能ですが、可読性を高めるために、リンクや他のテンプレートを通常通りに表示したいときだけに使うようにしてください。例:

{{Tip|<nowiki>= | }}</nowiki> https://www.archlinux.org/ {{ic|foo}}}}
ヒント: = | }} https://www.archlinux.org/ foo

HTML エンティティ

問題の文字列を、対応する HTML エンティティで置き換える方法もありますが、ソーステキストの可読性が失われるため、上記の方法が使えない場合にのみ利用してください。例:

{{Tip|&#61; &#124; &#125;&#125;}}
ヒント: = | }}

作成

ノート:
  • テンプレートを作成する前に、ヘルプ・トーク:テンプレートで議論してください。
  • 作成するテンプレートは意味のあるものにしてください。特定の記事でしか使うことができないような、特殊なテンプレートを作成するのは止めて下さい。
  • テンプレートは簡潔にしてください。The Arch Way を思い出しましょう: Keep It Simple, Stupid!

以下のテンプレートを使うことで新しいテンプレートを作成して利用・編集できます:

<noinclude>
{{Template}}

A brief description of the template

== 使用方法 ==

<nowiki>{{Template name|param1|param2|...|paramN}}</nowiki>

== サンプル ==

{{Template name|param1|param2|...|paramN}}</noinclude><includeonly>Template code goes here...</includeonly>

テンプレートを作成するには、Template:Template name (Template name は作成したいテンプレートの名前に置き換えて下さい) を開いて wikitext を編集・追加してください。

テンプレート一覧

ArchWiki の記事で直接使うことができるテンプレートは以下の通りです。詳しくはそれぞれのリンクをクリックしてください。ローカリゼーションやメタテンプレートのリストは特別:ページ一覧/テンプレート:特別:前方一致ページ一覧/テンプレート:特別:使用箇所の多いテンプレートを見てください。

警告: 既存のテンプレートで実験をしてはいけません。保護されていないテンプレートを編集したいときは、テキストをテンプレート:サンドボックスにコピーして、編集・テストしてから、元のテンプレートにコピーし直して下さい。まずは議論ページで変更を提案することを強く推奨します (テンプレートが保護されている場合は必須)。

テスト

記事の状態テンプレート

関連記事のテンプレート

コード整形のテンプレート

ノートテンプレート

雑多なテンプレート

パッケージのテンプレート

テーブルテンプレート

参照