本高风险模板已獲永久半保护以免遭到破坏

Template:Documentation subpage

维基百科,自由的百科全书
跳转至: 导航搜索


Documentation icon 模板文档[查看] [编辑] [页面历史] [清除]

本模板显示“模板文档”框,就像您现在看到的这样。

它起初用于{{模板文件}} ,用来为模板自动从/doc子页面中显示文档,但也用于显示内联文档。

用法

{{documentation subpage}}

{{documentation subpage|[[内联文件]]|[[页面名称]]}}
  • 内联文档是显示在框中的文本。
  • 页面名称指向文档页的名称,用來产生在框顶部右侧[查看]和[编辑]的特定按鈕。

本模板应被放在“/doc”页面顶端。根据被调用的位置的不同,它会显示不同的消息:

  • 在“/doc”页上,它会显示一个文本框,提示这是一个模板说明文档,并提供指向模板本身的链接。
  • 在其他页面上(即嵌入包含“/doc”页的页面),它会该提示说明文档是从一个子页面嵌入包含而来的。

功能

除了提示消息之外,本模板亦将页面分到Category:模板說明文件或相似(根据主体空间命名)的分类下,但仅针对拥有子页面功能的名字空间里的说明文档。本模板还会把模板的排序关键字根据不带名字空间名称时的页面名称作相应变动(比如,根据“Foo”,“Template:Foo”在分类中会被当做“F”开头的模板排序)。

参见