Template:文档

来自滚动的天空Wiki
(重定向自Template:Documentation
文档图示 模板文档[查看] [编辑] [查看历史] [清除缓存]

本模板用于生成文档。但是与维基百科上的Template:Documentation不同,本模板更加简化,功能也略有差异。

文档用于解释某个模板、模块的功能、用法等说明。通常来说,文档内容应当写在专门的文档页面内。

参数

模板文档模板支持自定义文档页面和文档内容。

匿名参数
页面标题,通常不建议使用。这个页面的内容将会作为模板文档显示。例如,在Template:Foo模板中,如果直接使用{{doc}},则会文档内容会是Template:Foo/doc中的内容。如果使用{{doc|FooDoc}},则会显示FooDoc页面中的内容。
page
页面标题,通常不建议使用。用于显示另一个模板的文档。
content
文档内容。一般不需要使用。通常,文档模板会使用专门的文档页面中的内容,如果你不愿意为此专门创建文档页面,可以直接使用content参数。例如,在Template:Foo中加入{{doc|content=这是Foo模板的文档}},则文档内容就会显示“这是Foo模板的文档”,Template:Foo/doc就会被忽略。

模块文档

对于模块文档,在其导出表内添加以下字段可以使用非标准的文档。

_delete_request_
提删模块,类似于{{提删}}。如果设置为一个表(序列),则表中内容会转为无序列表作为提删的理由。不是表时显示没有提供理由。
_documented_with_
若为一个函数,则调用函数作为文档。
_document_content_
若为一个字符串,则作为模块的内联文档。只有这种情况才会生成绿色的块级元素,上面两者都是直接放在模块源码上方。

此外,如果怕出现问题,可以设置p._not_optional_ = true以禁用非标准文档。如果模块没有返回表会自动禁用。

优先级为:禁用>提删>函数>内联>/doc子页面。

参见

上述文档内容嵌入自Template:文档/doc编辑 | 历史
编者可以在本模板的沙盒创建 | 镜像和测试样例创建页面进行实验。
请将模板自身所属的分类添加在文档中。本模板的子页面