テンプレート:Documentation
テンプレートの場合、<noinclude>{{subst:doc}}</noinclude> をテンプレートの最後に挿入し、ページを保存することで、{{documentation}}、および編集者に対してカテゴリとインターウィキリンクをどこに記述すればよいかをアドバイスするコメントが配置されます。
ページの上部にある「作成」をクリックすると、プリフォーマットとともに解説ページが開かれます。このフォーマットは、解説ページで {{subst:doc}} を使用することでも作成できます。
解説ページは、自動的にカテゴリ:解説ページに追加されます。subst: を用いず {{doc}} を使用した場合、ページはカテゴリ:テンプレートの置換を必要とするページに追加されます。
任意のパラメータ[ソースを編集]
これらのパラメータは、ページの作成時に {{subst:doc}} テンプレートに追加するか、または {{documentation}} テンプレートに後から追加することができます。
type[ソースを編集]
解説の「種類」を設定します。例えば、テンプレート、モジュール、メッセージなどです。このパラメータは、テンプレートに表示される一部のメッセージや、カテゴリの付与に使用されます。
解説の種類は名前空間に基づいて自動的に行われるため、通常は設定する必要はありません。
page[ソースを編集]
解説ページが存在するページ。デフォルトでは、現在のページの「doc」サブページとなります。
content[ソースを編集]
解説の内容をサブページではなく、直接指定することができます。爆発/tableのような、規模の小さな、ページ専用のサブページテンプレートに便利です。
nodoc[ソースを編集]
テンプレートに解説がなく、その使用法が不明な場合、nodoc=1 を解説ページの解説テンプレートに追加します。設定されると、解説の背景が赤色で目立つようになり、ページの種類に応じてカテゴリが追加されます。
解説ページが存在しない場合は自動的にカテゴリが追加されるため、通常は設定する必要はありません。
baddoc[ソースを編集]
nodocと同様に、解説は存在しているが、あまり良くないことを示すために使用します。これは、十分な例がない、すべての機能を適切に説明していない、またはテンプレートの要点を適切に説明していないことを意味します。解説の背景が黄色で目立つようになり、ページの種類に応じてカテゴリが追加されます。