模板:Documentation

(重定向自Template:模板文件
文档图示 模板文档[查看] [编辑] [历史] [清除缓存]

概要

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

参数及使用方法

  1. 在主模板中增加<noinclude>{{Documentation}}</noinclude>
  2. 点击“编辑”链接,它将打开/doc子页面,并在那里填写文档。
  3. 将分类增加在/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:模板文档页模式#分类链接。 如果文档页包含 includeonlynoinclude 标签并作为文档的一部分,请用“&lt;”替代“<”。

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

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

Documentation模板数据

显示一个模板的使用说明

模板参数[编辑模板数据]

参数描述类型状态
模板的使用说明所在页面1

标示该模板的使用说明所在页面名称

默认值
{{PAGENAME}}/doc
示例值
Template:Documentation/doc
页面名称可选
模板的使用说明内容content

以所写的使用说明内容取代该模板的/doc子页面

示例值
这是这个模板的使用说明
内容可选

重定向