模板:Documentation/doc
跳转到导航
跳转到搜索
這個模板用來建立一些重要模板的說明文件。包括本模板。
本模板已应用于250+页面。 为避免大规模的破坏及不必要的服务器负荷,任何改动均应先在模板的沙盒页面或您自己的用户页测试,经过测试後即可一次性改动本模板。为尊重其他用户,任何改动在生效前都应先在讨论页讨论。 |
Template:Documentation既可以嵌入/doc子页面,也可以用来进行内联嵌入,同时会将有一定的样式来标记这是文档页。
使用Template:Documentation能够将模板及其页面分离,从而避免内联文档的缺点。
使用方法及其简单,仅需在模板的最后加入<noinclude>{{Documentation}}</noinclude>
即可,然后在模板下方就会出现文档内容。
点击创建就能在/doc子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档。
虽然不推荐内联文档,但是对于一些短小的文档,内联的确更加方便。这时候可以使用该模板的content属性:
<noinclude>{{Documentation|content= 内联文档 }}</noinclude>
注意,請確保<noinclude>的開頭,接在模板原始碼或文字的最後一行後方,不要新起一行。否則,一個多餘的新行會被插入到包含该模板的頁面中,往往該頁面不需要這個新行。
- 參數1默認值是模板:Documentation/doc/doc。
- 參數content默認值為空。
分类
- 要将模板本身置于一个分类中,如果该文档具有/doc子页面,请在/doc子页面上的
<includeonly>...</includeonly>
段落中添加分类。若没有/doc子页面,请在模板页上的<noinclude>...</noinclude>
段落中添加分类。模板的分类参见Category:页面模板。 - 要将 /doc 子页面置于一个分类中,请在 /doc 子页面上的
<noinclude>...</noinclude>
段落中添加分类。文档子頁面的分類應該只有Category:模板說明文件。