Template:Documentation/doc

{{Documentation}} 模板用于显示某个模板的帮助文档，通常从 /doc 子页面加载。它包含两部分：上方的"文档框"（显示文档内容 + [查看][编辑][历史][清除缓存]工具栏）和下方的"链接框"（显示嵌入来源、沙盒/测试样例链接等元数据）。

使用本模板可以让模板本身得到保护，同时允许任何人编辑文档和分类。

用法

基本语法

将以下代码放在模板代码末尾的 <noinclude> 之前：

<!-- 模板最后一行 --><noinclude>
{{Documentation}}
</noinclude>

嵌入其他页面

通过第一个参数指定不同的文档页：

<noinclude>
{{Documentation|Template:其他页面/doc}}
</noinclude>

使用 content 参数

直接嵌入文档内容（此时不显示 [查看][编辑] 工具栏）：

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

当同时指定 |1= 和 |content= 时，|content= 优先显示在文档框中。

高级语法

自定义标题

默认标题根据命名空间自动显示"模板文档"或"模块文档"。可通过 |heading= 自定义。 设为 |heading=（空值）则不显示标题栏。

自定义链接框

通过 |link box= 自定义链接框内容。设为 off 则隐藏链接框。

测试

通过 |page= 参数模拟在某页面的显示效果，例如 |page=Template:Infobox。

放置位置和分类

此代码应放在模板代码末尾，<noinclude> 之前不要有多余空格（否则会出现在使用该模板的页面上）。 用于模板本身的分类应写在 /doc 子页面的 <includeonly> </includeonly> 标签中。

请勿在 /doc 子页面中再次使用 {{Documentation}}，以避免出错。

完整语法

{{Documentation
| 1 = 文档页面路径（可选）
| content = 直接嵌入的文档（可选）
| heading = 自定义标题（可选）
| heading-style = 标题的 CSS 样式（可选）
| link box = 自定义链接框（可选，设为 off 则隐藏）
| page = 模拟页面（可选，仅测试用）
}}

模板数据

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

Documentation模板数据

显示一个模板的使用说明

模板参数

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

重定向

• {{Template:Documentation}}
• {{Template:Documentation}}