模板:Documentation

来自Bejeweled Wiki
跳转到导航 跳转到搜索

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

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

使用方法极其简单,仅需在模板的最后加入<noinclude>{{Documentation}}</noinclude>即可,然后在模板下方就会出现文档内容。

注意,请确保<noinclude>的开头直接接在模板源码或文字的最后一行的后方,不要新起一行。否则,一个多余的新行会被插入到包含该模板的页面中,往往该页面不需要这个新行。

点击创建就能在模板的/doc子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档,效果即如本文档一般。

内联文档

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

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


同样地,请确保<noinclude>的开头直接接在模板源码或文字的最后一行的后方,不要新起一行

模板数据

向页面嵌入说明文档,并以一定样式加以标记。

模板参数

参数描述类型状态
待嵌入页面名1

待嵌入的文档页面名。嵌入Template命名空间的页面时需要加上Template:前缀。

默认值
<当前页面名>/doc
页面名称可选
内联文档内容content

内联文档的内容。会使参数1失效(即覆盖嵌入的内容)。

内容可选
文档类型type

文档类型。会使文档框标题的内容变成“<type>文档”。

默认值
在Template名字空间中:“模板”

在Module名字空间中:“模块”

在其余名字空间中:“页面”
单行文本可选

模板别名