模板:Documentation

Template-info-png.png 模板文档  [查看] [编辑] [历史] [刷新]

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

使用Template:Documentation能够将模板及其页面分离,从而避免内联文档的缺点。

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

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

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

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


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

  • 參數1默認值是模板:Documentation/doc。
  • 參數content默認值為空。

分类

  • 要将模板本身置于一个分类中,如果该文档具有/doc子页面,请在/doc子页面上的 <includeonly>...</includeonly> 段落中添加分类。若没有/doc子页面,请在模板页上的 <noinclude>...</noinclude> 段落中添加分类。模板的分类参见Category:页面模板
  • 要将 /doc 子页面置于一个分类中,请在 /doc 子页面上的 <noinclude>...</noinclude> 段落中添加分类。文档子頁面的分類應該只有Category:模板說明文件