要使用此模板,需要在模板中创建一个名叫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将会被忽略。