Fyrimynd:Userbox-r/doc

Hetta er ein dokumentatión undirsíða til Fyrimynd:Userbox-r.
Hon inniheldur kunning um nýtsluna, bólkar og um annað innihald, ið ikki er við í uppruna fyrimynd síðuni.

Uses Lua:

Module:Userbox

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.

Sandbox Reminder:

Always practice or experiment in the Template:Userbox-r/sandbox or Template:Userbox-r/testcases
Once you are satisfied: Copy your code!
In your Browser's address bar, change "sandbox" or "testcases" to the name of your new Userbox.
- Example:
- CHANGE http://en.wikipedia.org/wiki/Template:Userbox-r/sandbox
- TO http://en.wikipedia.org/wiki/Template:Userbox-r/WhateverYourNewBoxNameIs
- If the name of your new Userbox is taken, create a different name.
You will be prompted to Start or Create your new Template Userbox!
Paste your code into the space provided.

Usage

{{userbox-r
| bodyclass     = <!--Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.-->
| border-c      = <!--border color (default=id-c)-->
| border-s      = <!--border width in pixels (default=1)-->
| float         = <!--left|right|none (default=left)-->
| id            = <!--id image or text (standard height=x45px)-->
| id-a          = <!--id horizontal alignment left/center/right/justify (default=center)-->
| id-c          = <!--id background color (default=#d0d0d0)-->
| id-fc         = <!--id font color (default=black)-->
| id-h          = <!--id box height in pixels (default=45)-->
| id-lh         = <!--id line height (default=1.25em)-->
| id-op         = <!--id other CSS parameters-->
| id-p          = <!--id cell padding (default=0 0 0 1px)-->
| id-s          = <!--id text size in points (default=14)-->
| id-w          = <!--id box width in pixels (default=45)-->
| info-class    = <!--Adds an HTML class attribute to the "info" HTML table-row, to allow for styling, emission of microformats, etc.-->
| info          = <!--info text or image-->
| info-a        = <!--info horizontal alignment left/center/right/justify (default=left)-->
| info-c        = <!--info background color (default=#e0e0e0)-->
| info-fc       = <!--info font color (default=black)-->
| info-lh       = <!--info line height (default=1.25em)-->
| info-op       = <!--info other CSS parameters-->
| info-p        = <!--info padding (default=0 4px 0 4px)-->
| info-s        = <!--info text size in points (default=8)-->
| nocat         = <!--block page category declarations (default=false)-->
| usercategory  = <!--user category (optional)-->
| usercategory2 = <!--user category (optional)-->
| usercategory3 = <!--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

Deprecated old syntax, for compatibility.

{{userbox-r
| color 1
| color 2
| id
| info
| id size
}}

Example

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

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          = 
}}

Sandbox Reminder:

Usage

Example

Basic details

See also