模板:Usbk/doc

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

本模板综合英文维基百科的en:Template:Usbk和en:Template:Userbox table userbox，用于在说明页面（例如Wikipedia:用户框的子页面）中以表格展示用户框的用法。

用法

唯一的必填参数是用户框名称。使用时需在该模板的前后加入{{usbktop}}和{{usbkbottom}}。

{{Userbox table|template|par1|...|par12|category=|note=|comment=}}

template：用户框名称。若位于模板命名空间，则无需加入Template:前缀；但若位于其他命名空间，则需要加入前缀，如User:、Wikipedia:等。

par1|...|par12：用户框的模板参数，可最多填入12个作为示例。
- 命名参数可直接填写。例如，若您希望将{{模板名稱|username=example}}的显示效果作为范例展示，则应填入{{usbk|模板名稱|username=example}}。
- 如果包含未命名的参数，则应从第一个参数开始写起，而非使用类似于|1=的写法。例如，若您希望将{{模板名稱|參數1||參數3}}的显示效果作为范例展示，则应填入{{Usbk|模板名稱|參數1||參數3}}，而非{{Usbk|模板名稱|1=參數1|3=參數3}}。

category=：若用户框会将用户页加入分类，则在此填入分类的名称，无需加入Category:前缀。

note=：可在“程式码”一栏加入额外说明。

comment=：可在“连入页面及分类”一栏加入额外说明。

阻止加入分类

部分用户框会自动将使用其的页面归入某个分类。但这些分类旨在用于用户页，而非说明页面。因此，本模板使用以下方式关闭自动分类：

|nocat=true
|category=
|categories=no

若用户框不支援这些方式，则无法阻止说明页面被自动分类。一个简单的解决方法是，当使用{{Userbox}}建立用户框时，加入|nocat = {{{nocat|}}}，并将用户分类放入|usercategory =。

范例

程式码：

{{usbktop}}
{{usbk|User Arizona|category=亚利桑那州维基人}}
{{Usbk|User Facebook|username=Facebook用戶名|note=用戶名選填}}
{{Usbk|User bot owner|HiW-Bot|category=維基百科機器人所有者}}
{{Usbk|User contrib|10|comment=模板無自動更新功能}}
{{usbkbottom}}

显示效果：

代码显示连入页面及分类

{{User Arizona}}