模板:Documentation/doc
Lua
此模板使用了模块:Documentation,此脚本使用 Lua 编写。
当前模板用于输出模板或者模块的文档页面。
如果页面不存在文档,可以通过点击提示栏的创建会打开创建文档的编辑页面。打开页面后,会自动附带默认文档页面的模板。
文档页面会被自动添加到分类:文档页面下。
可选参数
引入 {{Documentation}}
模板时,可以传入以下参数。
type
设置文档的类型,例如模板、模块等。
默认情况下,type 会根据命名空间的自动设置,因此通常无需手动指定。
page
文档所在的页面。默认为当前页面的 doc 子页面。
content
直接指定文档的内容,将文档的内容嵌入到本体页面,不单独创建新的子页面。一般在比较小的模板上使用。
nodoc
如果模板文档缺失,并且编辑者不清楚如何使用,则可添加 nodoc=1。文档的背景会被设置为红色,并且页面会被添加到下面的分类之中。
如果文档页面不存在或着为空时会自动判断,一般情况下不需要手动设置。
baddoc
和 nodoc 类似,baddoc 用于标记有文档但文档质量一般的模板(没有示例等)。文档的背景会被设置为黄色,并且页面会被添加到下面的分类之中。