模板:Documentation/doc:修订间差异
外观
![]() |
|||
第1行: | 第1行: | ||
== 模板说明 == | |||
本模板用于在模板、模块、小部件等页面底部显示标准的“文档”内容区域,包括: | |||
* 标题(自动根据页面命名空间识别为“模板文档”、“模块文档”等); | |||
* 如何加载文档(内联或嵌入方式); | |||
* 实际的文档正文(可以使用参数传入或来自子页面); | |||
* 编辑、查看、历史、刷新等便捷操作链接。 | |||
---- | |||
== 用法 == | |||
=== 1. 子页面嵌入(推荐方式) === | |||
将说明文档写入一个子页面,通常叫 `Template:模板名/doc`,然后在模板页面底部调用本模板: | |||
<pre> | |||
{{Documentation}} | |||
</pre> | |||
默认会寻找 `{{FULLPAGENAME}}/doc` 作为子页面载入文档内容。 | |||
--- | |||
=== 2. 指定其他子页面(适用于自定义路径) === | |||
<pre> | |||
{{Documentation|1=Template:OtherTemplate/doc}} | |||
</pre> | |||
指定第一个参数,就可以载入任意页面做为文档。 | |||
--- | |||
=== 3. 使用 `content=` 内联方式写文档 === | |||
<pre> | |||
{{Documentation | |||
|content= | |||
== 用法 == | |||
* 示例用法 1 | |||
* 参数说明 | |||
}} | |||
</pre> | |||
当提供 `content=...` 参数时,内容将内联显示,不依赖/doc 子页面。 | |||
---- | |||
== 参数说明 == | |||
{| class="wikitable" style="width:100%;" | |||
! 参数 !! 说明 | |||
|- | |||
| <code>1</code> || 可选。要嵌入的子页面名称,例如 <code>Template:模板名/doc</code> | |||
|- | |||
| <code>content</code> || 可选。使用内联模式直接书写模板文档,不加载子页面 | |||
|} | |||
---- | |||
== 显示效果 == | |||
* 顶部显示模板类型(如“模板文档” / “模块文档”); | |||
* 自动识别内联或嵌入,并显示提示说明; | |||
* 显示文档正文; | |||
* 底部提供快速导航按钮:编辑、查看、历史、刷新。 | |||
你看到的这个文档页面就是一个 `{{Documentation}}` 模板的使用示例。 |
2025年5月4日 (日) 20:39的版本
模板说明
本模板用于在模板、模块、小部件等页面底部显示标准的“文档”内容区域,包括:
- 标题(自动根据页面命名空间识别为“模板文档”、“模块文档”等);
- 如何加载文档(内联或嵌入方式);
- 实际的文档正文(可以使用参数传入或来自子页面);
- 编辑、查看、历史、刷新等便捷操作链接。
用法
1. 子页面嵌入(推荐方式)
将说明文档写入一个子页面,通常叫 `Template:模板名/doc`,然后在模板页面底部调用本模板:
{{Documentation}}
默认会寻找 `模板:Documentation/doc/doc` 作为子页面载入文档内容。
---
2. 指定其他子页面(适用于自定义路径)
{{Documentation|1=Template:OtherTemplate/doc}}
指定第一个参数,就可以载入任意页面做为文档。
---
3. 使用 `content=` 内联方式写文档
{{Documentation |content= == 用法 == * 示例用法 1 * 参数说明 }}
当提供 `content=...` 参数时,内容将内联显示,不依赖/doc 子页面。
参数说明
参数 | 说明 |
---|---|
1 |
可选。要嵌入的子页面名称,例如 Template:模板名/doc
|
content |
可选。使用内联模式直接书写模板文档,不加载子页面 |
显示效果
- 顶部显示模板类型(如“模板文档” / “模块文档”);
- 自动识别内联或嵌入,并显示提示说明;
- 显示文档正文;
- 底部提供快速导航按钮:编辑、查看、历史、刷新。
你看到的这个文档页面就是一个 `
` 模板的使用示例。