Template:Userbox-r/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.

Usage[edit source]

{{userbox-r
| border-c = border color
| border-s = border width in pixels
| id       = id text or image
| id-c     = id background color
| id-fc    = id font color
| id-s     = id text size
| id-p     = id cell padding space
| id-lh    = id line height 
| id-op    = id other parameter (CSS)
| id-w     = id box width
| id-h     = id box height
| info     = info text
| info-c   = info background color
| info-fc  = info font color
| info-s   = info text size
| info-p   = info padding (distance between cell contents & cell border)
| info-lh  = info line height (or distance in between text lines)
| info-op  = info other (CSS) parameter(s)
| usercategory  = user category (optional)
| usercategory2 = user category (optional)
}}
  • Text size is assumed to be in points
  • If border-c is not specified, id-c will be used
  • All parameters are optional

Example[edit source]

Code Result
{{userbox-r}}
info id
{{userbox-r
| id = foo
| id-s = 20
| id-c = #ffffee
| info = ''foo bar''
| info-c = #ffeeff
| info-s = 12
| border-c = #aaffaa
| border-s = 2
}}
foo bar foo
Below example showing the default appearance of a userbox. Which is (much) higher than the 45px. Compare the height of the below one with the above userbox.
{{userbox-r
| id = foo logo
| id-c = #ffffee
| info = ''We are trying to see 
default distance in between text 
lines, and, see the distance in 
between cell content and its border 
and also see total height.''
| info-c = #ffeeff
| border-c = #aaffaa
| border-s = 2
}}
We are trying to see default distance in between text lines, and, see the distance in between cell content and its border and also see total height. foo logo
Below example showing how we can change that userbox and specify further parameters to bring down the overall height of the userbox, to the recommended height of 45px, even with four text lines. Cell padding parameter "info-p" can also be set at "1pt 1pt 1pt 2pt" or, "1pt 2pt" for better appearance, when there are 4 text lines.
{{userbox-r
| id = foo logo
| id-s = 14
| id-c = #ffffee
| id-lh = 1.1em
| 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-s = 8
| info-p = 1pt
| info-lh = 1.05em
| border-c = #aaffaa
| border-s = 1
}}
We have specified values to lessen the distance in between text lines & padding space in between cell content and its border. foo logo
Below example is for advanced users, showing how we can specify other CSS properties, for example, "font-family", to change the font, which are not existing inside the template already. At below, right side shows two userboxes; top one is displayed without the "font-family" parameter, but the bottom userbox is displayed by using the below codes, with the help of "info-op" parameter.
{{userbox-r
| id = foo logo
| id-s = 14
| id-c = #ffe
| id-lh = 1.1em
| info = foo bar
| info-c = #fef
| info-s = 14
| info-op = font-family:'Courier New';
| border-c = #afa
| border-s = 2
}}
foo bar foo logo

 
foo bar foo logo

Basic details[edit source]

Most HTML-based tables only use a handful of these attributes. The following subset can be used to quickly convert an HTML userbox into the format used here.

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

See also[edit source]