模板:Documentation
以下為模板的說明文件([編輯]、[更新]) |
---|
請注意:此模板在某些情況下可能會部份或全體不可見。 |
檢視模板:Documentation/doc編輯文件內容。(如何使用?) |
為新模板建立說明文件時,會直接套用範本基底。 |
描述
這個模板是用來在模板頁面插入其說明文件。
語法
在模板頁面的底部追加<noinclude>{{documentation}}</noinclude>
。
使用
在模板頁面
當使用以下方式時顯示正常:
模板程式碼<includeonly>任何透過模板插入到文章的類别</includeonly><noinclude> {{documentation}}</noinclude>
如果你的模板不是完整的div或者表格,你可能需要在插入{{documentation}}
之前加入結束標籤(在noinclude標籤內),例如以下方式:
<div class="test"> {{{輸入用欄位}}} <noinclude> </div> <-- 注意此部份 {{Documentation}} </noinclude>
在{{documentation}}
前斷開一行也非常有幫助,因為它可以阻止文件模板成為其程式碼的一部分。
模板文件(Template/doc)的範本
通常情況下,你可以使用類似以下的寫法: 參見模板:Documentation/範本
== 描述 == 這個模板有某種用途。 == 語法 == 在某處輸入{{((}}{{PAGENAME}}{{))}}。 :{|class="wikitable" style="" |- ! 欄位 !! 必要性 !! 預設值 !! 作用 !! 備註 |- | 匿名參數1 || 必要/選用 || 空白/錯誤訊息 || 用途說明 || 需求、性質、限制等 |- | 匿名參數2<br>abc || 至少其一 || {{code|1=black}} || 用途說明 || abc的值會覆寫匿名參數2的值 |} == 範例 == {| class="wikitable" |- ! 語法 !! 範例 !! 說明 |- | <code><nowiki><nowiki></code> || 範例 || 說明 |- | <code><nowiki><nowiki></code> || 範例 || 說明 |- | <code><nowiki><nowiki></code> || 範例 || 說明 |} <includeonly>[[Category:模板]][[Category:OO模板]]</includeonly><noinclude>[[Category:模板文件]]</noinclude>使用上面某個或者所有的描述/語法/範例。你也可以追加「其他資訊」("see also")之類的章節(Section)。