模板:Documentation/doc:修订间差异

来自黑神话百科
跳转到导航 跳转到搜索
(导入PRTS模版)
 
(修改分类命名)
第23行: 第23行:
*参数content默认值为空。
*参数content默认值为空。
=== 分类 ===
=== 分类 ===
* '''要将模板本身置于一个分类中''',如果该文档具有'''/doc'''子页面,请在'''/doc'''子页面上的 <code><nowiki><includeonly>...</includeonly></nowiki></code> 段落中添加分类。若没有'''/doc'''子页面,请在模板页上的 <code><nowiki><noinclude>...</noinclude></nowiki></code> 段落中添加分类。模板的分类参见[[:分类:PRTS模板]]。
* '''要将模板本身置于一个分类中''',如果该文档具有'''/doc'''子页面,请在'''/doc'''子页面上的 <code><nowiki><includeonly>...</includeonly></nowiki></code> 段落中添加分类。若没有'''/doc'''子页面,请在模板页上的 <code><nowiki><noinclude>...</noinclude></nowiki></code> 段落中添加分类。模板的分类参见[[:分类:模板]]。
* '''要将 ''/doc'' 子页面置于一个分类中''',请在 ''/doc'' 子页面上的 <code><nowiki><noinclude>...</noinclude></nowiki></code> 段落中添加分类。
* '''要将 ''/doc'' 子页面置于一个分类中''',请在 ''/doc'' 子页面上的 <code><nowiki><noinclude>...</noinclude></nowiki></code> 段落中添加分类。
<!-- 本行下加入模板的分类 -->
<!-- 本行下加入模板的分类 -->
<includeonly></includeonly>
<includeonly></includeonly>

2024年7月14日 (日) 13:00的版本

这个模板用来建立一些重要模板的说明文件。包括本模板。

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

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

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

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

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

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

内联文档


注意,请确保<noinclude>的开头,接在模板原始码或文字的最后一行后方,不要新起一行。否则,一个多余的新行会被插入到包含该模板的页面中,往往该页面不需要这个新行。

  • 参数1默认值是模板:Documentation/doc/doc。
  • 参数content默认值为空。

分类

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