模板:Documentation/doc

来自维阿百科
跳转至: 导航搜索

這個模板用來显示和格式化一些重要模板的說明文件,包括你正在阅读的本文。

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

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

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

注意,請確保<noinclude>的開頭直接接在模板原始碼或文字的最後一行後方,不要新起一行。否則,一個多餘的新行會被插入到包含该模板的頁面中,往往該頁面不需要這個新行。

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

内联文档

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

<noinclude>{{Documentation|content=
内联文档
}}</noinclude>
Template-info.png 模板文档  [编辑]

内联文档

同样地,請確保<noinclude>的開頭直接接在模板原始碼或文字的最後一行後方,不要新起一行

  • 參數1的默認值是{{Documentation/docname}};其解析为“(页面名字)/doc”。例如,在本页面(模板:Documentation/doc)下,参数1的默认值是模板:Documentation/doc/doc。
  • 參數content的默認值為空。