Fandom


Icon required
名前?
解説?
Wikiでこのテンプレートを使うには、こちらをクリックしてエクスポートした後、インポートしてください。詳しい手順はヘルプページをご覧ください。
FANDOMのライセンスに基づき、編集内容の要約には忘れずに以下のメッセージを加えてください:
[[w:c:ja.templates:テンプレート:Docparam]]より複製
このテンプレートはFANDOM starter pages for Japaneseにはありません。どのFANDOMコミュニティでも使用できますが、はじめから組み込まれているものではないので注意してください。
テンプレートの解説
注意: 上記のテンプレートは部分的または完全に非表示になることがあります。
下記の解説を閲覧・編集する。 (詳しくはこちら)
Editors can experiment with this template's sandbox and test case pages.
解説
テンプレート文書にあるテンプレートパラメータの標準フォーマットのテンプレート。
必要なファイル
CSS の使用
/* Template:Docparam */
.va-docparam {
   padding: 0 2px 0 20px;
   text-indent: -20px;
   margin-bottom: 3px;
   background: #F9F9F9;
   border: 1px dotted #D9D9D9;
   overflow: auto;
}
 
.va-docparam-icon {
   margin: 0;
   padding: 0;
   width: 20px;
   float: left;
}
 
.va-docparam-default {
   float: right;
   font-size: 10px;
}
 
.va-docparam-params {
   font-family: monospace;
}
 
.va-docparam-desc {
   margin: 0;
   padding: 0 0 5px 20px;
}
構文
{{Docparam|name=パラメータ|req=yes|desc=解説}}
パラメータ
Icon required
<unnamed 1> または 名前
パラメータ名。指定された文字列は自動的に代替の選択肢やパラメータレンジに翻訳されます。

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

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

利用可能なオプション:

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

}}
使用例
シンプル
{{Docparam|name=パラメータ|req=yes|default=|desc=
解説
}}

は次のようになります...

Icon required
パラメータ
解説
一歩進んだ使用法
{{Docparam|name=パラメータ // 代替 ++ 類似1 >> 類似3|req=no|default=デフォルト設定|desc=
解説
}}

は次のようになります...

Icon optional
(デフォルト: "デフォルト設定")
パラメータ または 代替, 類似1 - 類似3
解説
関連項目
テンプレートWikiの記事
特に記載のない限り、コミュニティのコンテンツはCC-BY-SA ライセンスの下で利用可能です。