要使用此模板,需要在模板中建立一個名叫doc的子頁面,把{{doc/start}}
放在文件的開頭,把{{doc/end}}
放在文件的末尾。
然後回到你的主模板頁面,在模板末尾新開一行並放置<noinclude>{{doc}}
</noinclude>。/doc頁面會被自動加入分類到Category:模板文件。
可選參數
clear
如果你的主文件頁面有浮動內容並且你想阻止這些內容浮動在文件上,在文件頁面放置{{doc/start|clear}}
,而不是{{doc/start}}
。
這也可用於沒有使用<includeonly>的目標,因為它會在模板和文件框之間放一些空格。
nodoc=1
如果有模板沒有文件頁面,且您不知道如何使用此模板,放置{{doc/start|nodoc=1}}
(或如果文件需要清理,在文件頁面放置{{doc/start|clear|nodoc=1}}
)而不是放置{{doc/start}}
。
文件框的背景將會變成紅色以使其變得更引人注目,頁面也會被加入Category:沒有文件頁面的模板。
baddoc=1
與nodoc類似,此參數用於標記有文件頁面的模板,但它並不是很好。這意味著此文件頁面沒有足夠的例子,沒有恰當地解釋所有功能,或沒有恰當地解釋模板的要點。
文件的背景色會變成黃色以使其更引人注目,頁面也會被加入分類:含有低質量的文件頁面
如果nodoc和baddoc都指定了,baddoc將會被忽略。