Editing Template:Userbox-r/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

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


=== Sandbox Reminder:===
*Always practice or experiment in sandbox
*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: 
**<b>CHANGE</b> http://en.wikipedia.org/wiki/Template:Userbox-r/sandbox 
**<b>TO</b> 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 ===
<!-- Abstract usage of the template, one variable per row. -->
<pre>
{{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)
}}
</pre>
* Text size is assumed to be in [[Point (typography)|points]]
* If border-c is not specified, id-c will be used
* All parameters are optional

Deprecated Old syntax, for compatibility.
<pre>
{{userbox-r
| color 1
| color 2
| id
| info
| id size
}}
</pre>

<!-- explain what this template's parameters do -- if no params, delete the definition -->
=== Example ===
{|
!style="width: 300px;"| Code
!Result
|-
| <pre>{{userbox-r}}</pre> || {{userbox-r}}
|-
| <pre>{{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
}}</pre> || {{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}}
|-
| colspan="2"| 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.
|-
| <pre>{{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
}}</pre> || {{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}}
|-
| colspan="2"| 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.
|-
| <pre>{{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
}}</pre> || {{userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffffee|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}}
|-
| colspan="2"| Below example is for advanced users, showing how we can specify other Cascading Style Sheets 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. 
|-
| <pre>{{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
}}</pre> || colspan="2"| {{Userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffe|info=foo bar|info-c=#fef|info-s=14|border-c=#afa|border-s=2}} <br style="clear:both">&#160;<br /> {{Userbox-r|id=foo logo|id-s=14|id-lh=1.1em|id-c=#ffe|info=foo bar|info-c=#fef|info-s=14|info-op=font-family:'Courier New';|border-c=#afa|border-s=2}}
|}

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

<pre>{{userbox-r
| border-c      = 
| info-c        = 
| id-c          = 
| id-fc         = 
| id-s          = 
| id            = 
| info-fc       = 
| info-s        = 
| info-lh       = 
| info          = 
}}</pre>

=== See also ===
* [[Web colors]]
* [[Template:Userbox]]
* [[Template:Userbox-2]]


<includeonly><noinclude>[[Category:Userboxes]]</noinclude>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:User namespace templates|Userbox-r]]

</includeonly><noinclude>[[Category:Userboxes]]</noinclude>