Template:Documentation

[查看 | 编辑 | 历史 | 清除缓存]文档页面

对于模板，在末尾插入{{subst:doc}}，然后保存页面，这将放置{{documentation}}和一条建议编辑者在何处放置类别和interwiki链接的评论。对于其他类型的页面，文档模板应该存在。

单击页面顶部的“创建”将打开文档页面，并带有某些预格式化。也可以使用文档页面上的{{subst:doc}}创建这种格式。

文档页面将自动添加到Category:文档页面。 使用不带subst:的{{doc}}会将页面添加到Category:需要替换模板的页面。

可选参数

创建页面时，可以将此参数添加到 {{subst:doc}}模板中，也可以添加到{{documentation}}模板。

type

设置文档的“type”，例如模板、模块、消息等。这将用作模板可能显示的某些消息以及分类的一部分。

type是基于名字空间的自动类型，因此通常无需设置。

page

文档所在的页面。默认为当前页面的子页面，称为“doc”。

content

允许直接指定文档内容，而不是在单独的子页面上。 对于特定于小型页面的子页面模板很有用，例如爆炸/table。

nodoc

如果模板没有文档，并且你不知道如何使用它，请在文档页面上的文档模板中添加nodoc=1。文档的背景将变为红色以使其引人注意，并且将页面添加到类别中。

• Category:没有文档的模板
• Category:没有文档的模块

如果文档页面不存在或为空，则会自动设置，因此通常不需要设置。

baddoc

与nodoc相似，它用于标记有文档的模板，但不是很好。这可能意味着它没有足够的示例，未正确解释所有功能或未正确解释模板的要点。文档的背景将变为黄色以使其更引人注目，并且页面将添加到类别中。

• Category:文档质量较低的模板
• Category:文档质量较低的模块

[查看 | 编辑 | 历史 | 清除缓存]上述文档是从Template:Documentation/doc引用的。