模板:Gadget-desc/doc

此页面是Template:Gadget-desc的模板文档。
此页面可能包含了模板的使用说明、分类和其他内容。

本模板用于以结构化的方式展示小工具描述。

参数[编辑]

self: 小工具描述页的名称，不含命名空间以及语言子页面，用于生成小工具锚点。例如小工具描述页为MediaWiki:Gadget-Foo/zh，参数应填写Gadget-Foo。必须填写。
name: 小工具名称（如“Twinkle”）。可留空。
1: 小工具功能介绍（如“执行常见管理操作”）。必须填写。
default: 默认启用填1，否则填0。; 维基共享资源曾试图使用Lua自动检测是否默认启用，但由于性能问题遭禁用。因而本站也采用手动标示。T51501解决后不再需要本设置。
extwiki: 若小工具会加载其他维基媒体wiki的内容，填1，否则填0。如这些内容同时亦为用户脚本或样式，请同时设置user。
external: 若小工具会加载外部网站（非维基媒体站点）的内容，填1，否则填0。此类小工具不建议默认启用。
user: 若小工具会加载用户脚本或样式，填1，否则填0。此类小工具不建议默认启用。
doc: 文档页名称。可留空。
example: 示例页名称。可留空。
talk: 讨论页名称。可留空。
settings: 设置页面名称。可留空。

代码	效果
`{{Gadget-desc\|self=Gadget-Foo\|小工具描述。}}`	小工具描述。
`{{Gadget-desc\|self=Gadget-FooDefault\|default=1\|小工具描述。}}`	^预小工具描述。
`{{Gadget-desc\|self=Gadget-Foo1\|name=小工具名\|小工具描述。}}`	小工具名：小工具描述。
`{{Gadget-desc\|self=Gadget-Foo1ExtwikiUser\|name=小工具名\|extwiki=1\|user=1\|小工具描述。}}`	小工具名：^跨^用小工具描述。
`{{Gadget-desc\|self=Gadget-Foo2\|name=小工具名\|小工具描述。\|doc=Wikipedia:Sandbox}}`	小工具名：小工具描述。 [文档]
`{{Gadget-desc\|self=Gadget-Foo3\|name=小工具名\|小工具描述。\|doc=Wikipedia:Sandbox\|talk=Talk:Sandbox\|example=Wikipedia:Sandbox\|settings=Wikipedia:Sandbox}}`	小工具名：小工具描述。 [文档 / 示例 / 讨论 / 设置]

隐藏的小工具不应使用本模板，而应使用{{Gadget-desc-utility}}作为占位符。