這個模板用來顯示並格式化一些模板的說明文件,包括你正在閱讀的本文。
Template:Documentation既可以用來嵌入/doc子頁面,也可以用來進行內聯嵌入;同時,將有一定的樣式來標記文檔部分。
使用Template:Documentation能夠將模板及其頁面分離,從而避免內聯文檔的缺點(如頁面被保護/資料庫被鎖定後無法編輯說明、只選一個目錄編輯可能會被系統誤判為無限遞歸使用等問題)。
使用方法極其簡單,僅需在目標模板的最後加入<noinclude>{{Documentation}}</noinclude>
即可,然後在模板下方就會出現文檔內容。
{{Documentation}}
, 亦可實現嵌入模板時不顯示說明文檔的效果。<onlyinclude>
同樣用於控制嵌入顯示內容,僅允許被標籤包含其中的內容可被嵌入顯示。注意:請確保HTML標籤<noinclude>直接接在模板原始碼或文字的最後一行後方,不要新起一行。
另起一行時的呈現效果 |
---|
萌娘百科,萬物皆可萌的百科全書。 <noinclude>{{Documentation|content=內聯文檔 }}</noinclude> 萌娘百科,萬物皆可萌的百科全書。
|
點擊模板中的「創建」按鈕就能在模板的/doc子頁面中創建所需的文檔。創建完以後模板頁就會自動包含這個文檔,效果即如本文檔般。
雖然不推薦內聯文檔,但對於一些內容精簡的文檔,內聯呈現方式的確更加方便。這時候可以使用該模板的content
屬性:
<noinclude>{{Documentation|content= 內聯文檔 }}</noinclude>
{{Documentation/docname}}
;解析後的結果為「(頁面名字)/doc」。例如,在本頁面(Template:Documentation)下,參數1的默認值是Template:Documentation/doc。content
的默認值為空。{{Doc}}
等效於{{Documentation}}
。