模板:Documentation

此页面是Template:Documentation的模板文档。
此页面可能包含了模板的使用说明、分类和其他内容。

此模板文档被引用于约27,000个页面。
为了避免造成大规模的影响，所有对此模板文档的编辑应先于沙盒、测试样例或您的沙盒上测试。
测试后无误的版本可以一次性地加入此模板文档中，但是修改前请务必于讨论页发起讨论。

模板引用数量会自动更新。

此模板使用Lua语言：

Module:Documentation（沙盒）

概要

这个模板自动显示“模板文档”框，就像你现在看到的这样，文档框中的内容由其它页面生成。

参数及使用方法

在主模板中增加<noinclude>{{Documentation}}</noinclude>。
点击“编辑”链接，它将打开/doc子页面，并在那里填写文档。
将分类增加在/doc子页面的<includeonly></includeonly>中。

正常的/doc子页面

<noinclude>{{Documentation}}</noinclude>

任意/doc子页面

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

内联内容

<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>

有[查看][编辑]链接的内联内容

<noinclude>{{Documentation
|1 = Template:模板名/doc
|content = {{Template:模板名/doc|参数}}
}}</noinclude>

最佳用法

此代码应该放置在模板代码的底部“<noinclude>”之前且不加多余的空格（否则会导致使用该模板的页面上出现多余空格）。参数可以像上面这样来使用以包含任意文档页。用于模板本身的分类链接应该用 <includeonly> </includeonly> 标签来添加到文档页面。更复杂的案例请参见 Wikipedia:模板文件页模式#分类链接。如果文档页包含 includeonly 或 noinclude 标签并作为文档的一部分，请用“<”替代“<”。

请勿在/doc子页面里再挂上{{Documentation}}，以避免出错。

以下是该模板的模板数据，适用于可视化编辑器等工具。

Documentation模板数据

显示一个模板的使用说明

模板参数[编辑模板数据]
参数		描述	类型	状态
模板的使用说明所在页面	`1`	标示该模板的使用说明所在页面名称默认值 {{PAGENAME}}/doc 示例值 Template:Documentation/doc	页面名称	可选
模板的使用说明内容	`content`	以所写的使用说明内容取代该模板的/doc子页面示例值这是这个模板的使用说明	内容	可选

重定向

上述文档嵌入自Template:Documentation/doc。
编者可以在本模板的沙盒和测试样例页面进行实验。
请在/doc子页面中添加分类。本模板的子页面。