模板:Documentation

文件:Template-info.png 模板文档  

这个文档嵌入自模板:Documentation/doc。

这个模板用来显示和格式化模板的说明文档（一般写在模板的/doc子页面），包括你正在阅读的本文。

{{Documentation}}既可以用来嵌入/doc子页面，也可以用来进行内联嵌入；同时，将有一定的样式来标记文档部分。

使用{{Documentation}}能够将模板及其页面分离，从而避免内联文档的缺点（如被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等）。

用法

这个模板用法非常简单：

1. 在主模板页面底部添加<noinclude>{{doc}}</noinclude>。
2. 点击“创建”链接，打开/doc子页面，并在子页面中填写文档。
3. 在/doc子页面的底部添加<noinclude>[[分类:模板文档]]</noinclude>。

至于效果，如你所见，这个显示在模板:Documentation页面的文档就是。

注意

1. 模板主要内容的<includeonly></includeonly>与作为模板说明内容的<noinclude></noinclude>之间不要换行，否则模板使用时会出现莫名其妙的空格或空行。
2. 推荐使用{{doc}}而不是{{Documentation}}，因为前者更加简洁明了且不易出现拼写错误。

其他模板的文档

你可以选择显示其他模板的文档，免去搬运或重定向重复文档的麻烦。

<noinclude>{{doc|模板:其他模板/doc}}</noinclude>

内联文档

内联文档是不显示/doc子页面内容，直接编写的文档。

虽然不推荐内联文档，但是对于一些短小的文档，内联的确更加方便。这时候可以使用该模板的content参数：

<noinclude>{{doc|content=
内联文档
}}</noinclude>

模板来自MCBBS Wiki。