模板:Documentation

模板文档[查看] [编辑] [历史] [清除缓存]

此模板使用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> 标签来添加到文档页面。更复杂的案例请参见 w:Wikipedia:模板文档页模式#分类链接。如果文档页包含 includeonly 或 noinclude 标签并作为文档的一部分，请用“<”替代“<”。

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

自定义显示

替换这些值可以实现特殊的输出效果：

{{documentation| heading = ...}} − 改变“文档”页的标题文字。如果此处留空，整个标题行（包括第一个[编辑]链接）也将隐藏。

重定向

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