模板: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}}