BGDWiki:模板指引
本指引介绍BGDWiki中模板页面普遍遵循的格式规范。
组成部分
BGDWiki的模板页面主要由模板说明和模板代码两部分组成。
模板说明
模板说明包含该模板的模板文档、模板分类两部分。使用<noinclude>......</noinclude>
与模板代码部分分隔开。
模板文档
模板文档是对模板的详细介绍,包含以下三个部分:
- 模板用途:对模板适用以及不适用的情况作以说明。
- 模板参数:对模板中所有可用参数及其参数格式、参数含义、可选情况等内容作以说明。
- 模板示例:展示该模板实际样式。应尽量包含所有的可用参数。
模板文档通常使用{{Documentation}}
或{{Doc}}
嵌入模板页。
模板分类
BGDWiki要求每个模板都应有至少一个模板分类,以便管理与查找所有模板。 (模板分类待补充)
结语
模板是BGDWiki的重要组成部分,对于模板的修改往往会导致大量页面的变动。建议各位编者在编辑模板时先前往沙盒页面进行测试,待修改无误后再次添加。如有进一步的问题或困难,欢迎前往Help:互助客栈提问。