Template:documentation

此乃 {{documentation}} 模板。

可参阅文档查看关于何时及如何使用此模板的指示。

此模板显示如你此刻所见的绿色文档框，并自动从 /doc 子页面加载内容。它亦能加载来自其他位置的内容，若指示它这么做。

此模板的目的是为模板与嵌入到其他页面上的某些页面编写文档。它能用于模板空间及大部分其他命名空间中。

此模板的使用允许模板在需要处为受保护，亦允许任何人编辑文档、分类及维基间链接。

用法

通常不带任何参数使用此模板，并将它置于模板或要拥有文档的页面底部，在 <noinclude> 内部：

<!--你模板代码的最后一行--><noinclude>

{{documentation}}
<!-- 添加分类和维基间链接到 /doc 子页面，而非此处！ -->
</noinclude>

然后此模板会自动加载来自使用它的模板的 /doc 子页面的内容。

此模板亦能加载来自任何其他页面的内容。像这样：

<!--你模板代码的最后一行--><noinclude>

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

注意加载来自任何本地 /doc 页面外的其他页面时，处理分类和维基间链接变得需要技巧。

内容可以作为文本直接放入。像这样：

<!--你模板代码的最后一行--><noinclude>

{{documentation
| content = 某些文档文本。
}}
</noinclude>

使用 content 参数时，文档框通常不显示 [编辑] [清理] 链接于右上角。注意若 /doc 页面存在，则仍然在文档框下方的链接框显示一条到它的链接。

不过参数 1 和 content 参数也可以合并，像这样：

<!--你模板代码的最后一行--><noinclude>

{{documentation
| 1 = Template:任意页面/doc
| content = {{Template:任意页面/doc|参数}}
}}
</noinclude>

然后作为参数 1 填入的页面名被用于 [编辑] [清理] 链接和文档框下方的链接框的 /doc 链接。但 content 参数被用于在文档框中显示内容。上述代码表明内容被嵌入作 "{{Template:任意页面/doc|参数}}" 。在此示例也为要加载的 /doc 页面提供了一个参数。

最佳实践

代码应该添加到模板代码底部，在 "<noinclude>" 前应无空格（这会导致使用模板的页面上的额外空格）。

应用到模板自身的分类和维基间链接应该添加到 /doc 子页面的底部，在 <includeonly></includeonly> 标签内。对于更多情况，参阅 enwiki:Wikipedia:Template documentation#Categories and interwiki links 。

若文档页面含有作为可见文档文本的 <includeonly> 或 <noinclude> 标签，就要将 "<" 替换成 "<" 。

参阅

• {{documentation}} ——将它置于模板和其他页面上，以为之创立文档。