Template:Documentation

本模板已应用于3600+页面。
为避免大规模的破坏及不必要的服务器负荷，任何改动均应先在该模板对应的沙盒页面或您自己的用户页下进行测试，并将测试无误的代码一次性地改动至本模板。
为尊重其他用户，任何功能/兼容性改动在生效前都应先在讨论页进行讨论。

這個模板用來显示并格式化一些模板的说明文档（Documentation），包括你正在阅读的本文。

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

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

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

在其他页面嵌入目标模板后，{{Documentation}}呈现的内容不会出现。
如果你在目标模板使用的是<onlyinclude>标签，你可以直接在该HTML标签以外输入{{Documentation}}, 亦可实现嵌入模板时不显示说明文档的效果。
因为<onlyinclude>同样用于控制嵌入显示内容，仅允许被标签包含其中的内容可被嵌入显示。

注意：請確保HTML标签<noinclude>直接接在模板原始碼或文字的最後一行後方，不要新起一行。

另起一行时的呈现效果
萌娘百科，万物皆可萌的百科全书。 <noinclude>{{Documentation\|content=内联文档 }}</noinclude> 萌娘百科，万物皆可萌的百科全书。模板文档 [编辑] 这个文档是内联文档。内联文档

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

虽然不推荐内联文档，但对于一些内容精简的文档，内联呈现方式的确更加方便。这时候可以使用该模板的content属性：

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

模板文档 [编辑]

这个文档是内联文档。

内联文档

參數1的默認值是{{Documentation/docname}}；解析后的结果为“（页面名字）/doc”。例如，在本页面（Template:Documentation）下，参数1的默认值是Template:Documentation/doc。
以下特定场合亦可使用此模板：
- 多个模板使用一个说明文档时，参数1指向统一的说明文档页面。
- 用在页面空间为“模块（Module）”、“小部件（Widget）”的页面时，此模板将分别显示“模块文档”或“小部件文档”。
- 在其他页面空间以文档形式呈现内容时，此模板将显示为“文档”而不是“模板文档”。
  可以在帮助:沙盒中自行使用{{Documentation}}并显示预览以查看呈现效果。
參數content的默認值為空。
模板:Doc 作为快捷方式重定向至此模板，输入{{Doc}}等效于{{Documentation}}。

导航菜单