Fandom


requiredIcon required
名前?
解説?
テンプレートドキュメンテーション (上に表示されるテンプレートは、隠れるか不可視になることがあります)

テンプレートドキュメンテーションにあるテンプレートパラメータの標準フォーマットのテンプレート。

使用法

{{Docparam|name=パラメータ|req=yes|desc=解説}}

パラメータ

requiredIcon required
<unnamed 1> または 名前
パラメータ名。指定された文字列は自動的に代替の選択肢やパラメータレンジに翻訳されます。

翻訳される文字列 (これらはすべてスペースで囲う必要があります)

  • >> は両端にスペースつきのダッシュ (" - ") にコンバートされます。パラメータレンジを示すために使われます (例、"game1 -game5")
  • // は「または」(or) にコンバートされます。これにはふたつの選択があります (たとえば、"<unnamed 1> または タイトル")。
  • ++ は末尾スペースつきのカンマ (", ") にコンバートされます。分割されたパラメータのリスティングに使われますが、同様に機能します (例, "contentA1, contentB1").
optionalIcon optional
default, default2
パラメータのデフォルト値。
requiredIcon required
desc
パラメータの解説。
semi-requiredIcon semi-required
(デフォルト: "yes")
req
機能すべきテンプレートでこのパラメータが必要とするものを指定。

利用可能なオプション:

  • no: 完全なオプション。
  • semi: 特定の環境で必要だがその他ではオプションとなるパラメータ。パラメータのレンジに関連 (set via を通した集合。これはすくなくともそれらのうちひとつであることを意味する。
  • yes: 常に必要とされる。

コピー/ペースト

{{Docparam|name=|req=|default=|desc=

}}

シンプル

{{Docparam|name=パラメータ|req=yes|default=|desc=
解説
}}

は次のようになります:

requiredIcon required
パラメータ
解説

一歩進んだ使用法

{{Docparam|name=パラメータ // 代替 ++ 類似1 >> 類似3|req=no|default=デフォルト設定|desc=
解説
}}

results in:

optionalIcon optional
(デフォルト: "デフォルト設定")
パラメータ または 代替, 類似1 - 類似3
解説
テンプレート:Docparam/doc からトランスクルードされたドキュメンテーション。
特に記載のない限り、コミュニティのコンテンツはCC-BY-SA ライセンスの下で利用可能です。