模板:Documentation

模板说明文档  

此说明文档嵌入自模板:Documentation/doc.

描述

这个模板用于在模板或模块或小工具页面插入说明文档。

语法

在模板页面的底部添加语句<noinclude>{{documentation}}</noinclude>
或<noinclude>{{doc}}</noinclude>。

• 若notoc=1，说明文档的目录将不会显示。
• 使用toc=可以设置说明文档的目录的对齐方式。

使用

在模板页面

当使用以下方式时显示正常:

模板代码<includeonly>任何通过模板插入到文章的类别</includeonly><noinclude>
{{doc}}</noinclude>

如果你的模板不是完整的div或者表格，你也许需要在插入{{doc}}之前就结束标签的使用(在noinclude标签内).

在{{doc}}前断开一行也非常有帮助，因为它可以帮助阻止文档模板成为代码的一部分。

在模板/文档(Template/doc)页面

通常情况下，你可以使用类似以下的代码：

==描述==
这个模板有某种用途。

==句法==
在某个地方输入<code>{{tl|templatename}}</code>。

==示例==
<code><nowiki>{{templatename|input}}</nowiki></code> 

结果...

{{templatename|输入}}

<includeonly>模板本身的类别</includeonly><noinclude>[[Category:模板文件|{{PAGENAME}}]]</noinclude>

使用上面某个或者所有的描述／句法／事例。你也可以添加“其他”部分。