跳转到内容

模板:Documentation

維基文庫,自由的圖書館
(重定向自Template:Template doc
文档图示 模板文档[查看] [编辑] [历史] [清除缓存]

这个模板自动显示“模板文档”框,就像你现在看到的这样。文档框中的内容由其它页面生成。

用法

[编辑]
  1. 在主模板中增加<noinclude>{{Documentation}}</noinclude>
  2. 点击“编辑”链接,它将打开/doc子页面,并在那里填写文档。
  3. 將分類與跨語言連結增加在/doc子頁面的<includeonly></includeonly>中。

正常的/doc子页面

[编辑]
<noinclude>{{Documentation}}</noinclude>

任意/doc子页面

[编辑]
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

内联内容

[编辑]
<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>

有[查看][编辑]链接的内联内容

[编辑]
<noinclude>{{Documentation
|1 = Template:模板名/doc
|content ={{Template:模板名/doc|参数}}
}}</noinclude>

最佳用法

[编辑]

此代码应该放置在模板代码的底部“<noinclude>”之前且不加多余的空格(否则会导致使用该模板的页面上出现多余空格)。参数可以像上面这样来使用以包含任意文档页。 用于模板本身的分类链接和跨维基链接应该用 <includeonly> </includeonly> 标签来添加到文档页面。 更复杂的案例请参见 Wikipedia:模板文件頁模式#分类链接与跨维基链接。 如果文档页包含 includeonlynoinclude 标签并作为文档的一部分,请用“&lt;”替代“<”。

自定义显示

[编辑]

替换这些值可以实现特殊的输出效果:

  • {{documentation| heading = ...}} − 改变“文档”页的标题文字。如果此处留空,整个标题行(包括第一个[编辑]链接)也将隐藏。

模板帮助

模板参数[编辑模板数据]

参数描述类型状态
template-nametemplate-name

无描述

未知可选