模板:Userbox/doc

此頁面是Template:Userbox的模板文件。
此頁面可能包含了模板的使用說明、分類和其他內容。

此模板使用：

Module:Userbox

模板介紹

本模板適用於建置用戶框，提供使用者在用戶頁面顯示使用者的一些資訊，以免於HTML與Wikitable參數的麻煩。

使用方式

{{userbox
| bodyclass     = <!--自訂HTML Class參數-->
| border-c      = <!--邊框色彩 (預設與 id-c 之參數相同)-->
| border-s      = <!--邊框像素大小 (預設值：1)-->
| float         = <!--流動對齊方式 left|right|none (預設值：left)-->
| id            = <!--id 圖片或文字（選用，預設尺寸是x45px）-->
| id-a          = <!--id 水平對齊方式 left/center/right/justify (預設：center)-->
| id-c          = <!--id 的背景色彩 (預設：#d0d0d0)-->
| id-fc         = <!--id 的文字色彩 (預設：black)-->
| id-h          = <!--id 框的像素大小 (預設：45)-->
| id-lh         = <!--id 行高 (預設：1em)-->
| id-op         = <!--id 的其他 CSS 參數-->
| id-p          = <!--id 的儲存格留白值 (預設：0 1px 0 0)-->
| id-s          = <!--id 文字點數 (預設：14)-->
| id-w          = <!--id 框長度 (預設：45)-->
| info-class    = <!--Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.-->
| info          = <!--info 框圖文內容-->
| info-a        = <!--info 框水平對齊方式 left/center/right/justify (預設：left)-->
| info-c        = <!--info 框背景色 (預設：#e0e0e0)-->
| info-fc       = <!--info 框文字色彩 (預設：black)-->
| info-lh       = <!--info 框行高 (預設：1.25em)-->
| info-op       = <!--info 框的其他CSS樣式參數-->
| info-p        = <!--info 框的留白值 (預設：0 4px 0 4px)-->
| info-s        = <!--info 文字點數 (預設：9)-->
| nocat         = <!--block page category declarations (default=false)-->
| usercategory  = <!--使用者自設分類（選用）-->
| usercategory2 = <!--使用者自設分類（選用）-->
| usercategory3 = <!--使用者自設分類（選用）-->
}}

全部參數皆為選填
圖像建議少於45px

多數基於HTML的表格僅用這些參數的一小部分。以下子集可以用來把HTML用戶框快速轉換成這裏所用的格式：

{{userbox
| border-c      = 
| id            = 
| id-c          = 
| id-fc         = 
| id-s          = 
| info          = 
| info-c        = 
| info-fc       = 
| info-lh       = 
| info-s        = 
| nocat         = {{{nocat|}}}
| usercategory  = 
}}

範例

代碼效果

{{userbox}}

{{{info}}}

{{userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo
| id-c          = #ffffee
| id-s          = 20
| info          = ''foo bar''
| info-c        = #ffeeff
| info-s        = 12
}}

foo	foo bar

以下展示高度超過45px的用戶框的默認外觀，比較一下上下兩個用戶框的差異。

{{userbox
| border-c      = #aaffaa
| border-s      = 2
| id            = foo logo
| id-c          = #ffffee
| info          = ''We are trying to see 
default distance in between text 
lines, see the distance in 
between cell content and its border, 
and also see total height.''
| info-c        = #ffeeff
}}

foo logo	We are trying to see default distance in between text lines, see the distance in between cell content and its border, and also see total height.

以下展示怎樣能修改用戶框並進一步指定參數來降低用戶框的高度以達到推薦的45px，即使有四行文字。在四行文字之下，單元格邊距參數info-p也可以設置成1pt 1pt 1pt 2pt，或者1pt 2pt以達到更好的效果。

{{userbox
| border-c      = #aaffaa
| border-s      = 1
| id            = foo logo
| id-c          = #ffffee
| id-lh         = 1.1em
| id-s          = 14
| info          = ''We have specified values 
to lessen the distance in between 
text lines & padding space in between 
cell content and its border.''
| info-c        = #ffeeff
| info-lh       = 1.05em
| info-p        = 1pt
| info-s        = 8
}}

foo logo	We have specified values to lessen the distance in between text lines & padding space in between cell content and its border.

以下針對高級用戶，展示怎樣指定其他CSS屬性，例如，font-family調整字體家族，text-align從默認參數調整對齊方式。如下所示，右邊是2個用戶框：上面一個是不帶font-family或text-align參數；下面一個是以填寫info-op參數來使用此類代碼顯示的。

{{userbox
| border-c      = #afa
| border-s      = 2
| id            = foo logo
| id-c          = #ffe
| id-lh         = 1.1em
| id-s          = 14
| info          = foo bar
| info-c        = #fef
| info-op       = font-family:'Courier New'; text-align:center;
| info-s        = 14
}}

foo logo	foo bar

foo logo	foo bar

模板數據

本模板適用於建置用戶框，提供使用者在用戶頁面顯示使用者的一些資訊，以免於HTML與Wikitable參數的麻煩。

模板參數
參數		描述	類型	狀態
bodyclass	`bodyclass`	自訂HTML Class參數預設 id-c	字串	非必填
border-c	`border-c`	邊框色彩預設	字串	非必填
border-s	`border-s`	邊框像素大小預設 1	字串	非必填
float	`float`	流動對齊方式 left\|right\|none 預設 left	字串	非必填
id	`id`	id 圖片或文字（選用）預設 x45px	字串	非必填
id-a	`id-a`	id 水平對齊方式 left/center/right/justify 預設 center	字串	非必填
id-c	`id-c`	id 的背景色彩預設 #d0d0d0	字串	非必填
id-fc	`id-fc`	id 的文字色彩預設 black	字串	非必填
id-h	`id-h`	id 框的像素大小預設 45	字串	非必填
id-lh	`id-lh`	id 行高預設 1em	字串	非必填
id-op	`id-op`	id 的其他 CSS 參數預設	字串	非必填
id-p	`id-p`	id 的儲存格留白值預設 0 1px 0 0	字串	非必填
id-s	`id-s`	id 文字點數預設 14	字串	非必填
id-w	`id-w`	id 框長度，單位是像素預設 45	字串	非必填
info-class	`info-class`	Adds an HTML class attribute to the “info” HTML table-row, to allow for styling, emission of microformats, etc. 預設	字串	非必填
info	`info`	info 框圖文內容預設	字串	非必填
info-a	`info-a`	info 框水平對齊方式 left/center/right/justify 預設 left	字串	非必填
info-c	`info-c`	info 框背景色預設 #e0e0e0	字串	非必填
info-fc	`info-fc`	info 框文字色彩預設 black	字串	非必填
info-lh	`info-lh`	info 框行高預設 1.25em	字串	非必填
info-op	`info-op`	info 框的其他CSS樣式參數預設	字串	非必填
info-p	`info-p`	info 框的留白值預設 0 4px 0 4px	字串	非必填
info-s	`info-s`	info 文字點數預設 8	字串	非必填
nocat	`nocat`	block page category declarations 預設 false	字串	非必填
usercategory	`usercategory`	使用者自設分類（選用）預設	字串	非必填
usercategory2	`usercategory2`	使用者自設分類（選用）預設	字串	非必填
usercategory3	`usercategory3`	使用者自設分類（選用）預設	字串	非必填