Jump to content

User:XmanAuthor/Template:XmanAuthor/doc

From Wikipedia, the free encyclopedia

Usage

[edit]
Recommended Usage: {{box|''Contents''}}
Special Parameters
Parameter Description Values
|type= The type of box
black
,
white
or
transparent
|span= Uses span tags instead of div tags yes
|wide= Set the box to be as wide as the page/table
yes
|inline= Set the box to be inline text text text
yes
text text text
|header= Adds an optional header
Header
Text
Supported Parameters
Parameter Description Default CSS
The contents of the box (Highly Recommend)
|background=/|color= The color of the background of the box White background-color
|align= The alignment of the box (left, center, right) (Recommended) left float
|padding= The inner padding of the border 3px padding
|style= The style of the border Solid border-style
|border color= The color of the border Black background-color
|border size= The size of the border 3px border-width
|text align= The alignment of the text (Recommended) left text-align
|spacing= The spacing of the letters letter-spacing
|font= The font of the box's text font-family
|font size= The font size of the box's text font-size
|text color= The color of the text black text-color
|margin= The outer margin of the box (Only does horizontal when type isn't inline-block or block) 3px margin
|box type= The type of box (inline, inline-block, block) inline-block display
|height= The height of the box height
|width= The width of the box (The width of the text) width
|CSS= Any Additional CSS you want to add

(make sure to add ; to end)

Other Parameters
Parameter Description Default CSS
|top margin= The top outer margin of the box (Only does horizontal when type isn't inline-block or block) 3px margin-top
|bottom margin= The bottom outer margin of the box (Only does horizontal when type isn't inline-block or block) 3px margin-bottom
|left margin= The left outer margin of the box (Only does horizontal when type isn't inline-block or block) 3px margin-left
|right margin= The right outer margin of the box (Only does horizontal when type isn't inline-block or block) 3px margin-right
|top padding= The top inner padding of the border 3px padding-top
|bottom padding= The bottom inner padding of the border 3px padding-bottom
|left padding= The left inner padding of the border 3px padding-left
|right padding= The right inner padding of the border 3px padding-right

Examples

[edit]

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

A
B

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Curabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis sollicitudin mauris. Integer in mauris eu nibh euismod gravida. Duis ac tellus et risus vulputate vehicula. Donec lobortis risus a elit. Etiam tempor. Ut ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt sapien risus a quam. Maecenas fermentum consequat mi. Donec fermentum. Pellentesque malesuada nulla a mi. Duis sapien sem, aliquet nec, commodo eget, consequat quis, neque. Aliquam faucibus, elit ut dictum aliquet, felis nisl adipiscing sapien, sed malesuada diam lacus eget erat. Cras mollis scelerisque nunc. Nullam arcu. Aliquam consequat. Curabitur augue lorem, dapibus quis, laoreet et, pretium ac, nisi. Aenean magna nisl, mollis quis, molestie eu, feugiat in, orci. In hac habitasse platea dictumst.

C

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{{box|A|background=red|text color=white}}
{{box|B|background=blue|text color=orange}}
{{box|C|background=black|text color=white|margin=0px|height=1em|width=40px|border color=yellow}}

DOG
{{box|spacing=5px|height=50px|DOG}}

The quick brown fox jumps over the lazy dog
{{box|background=yellow|align=center|border size=10px|text align=center|The quick brown fox jumps over the lazy dog}}

Data

[edit]

This template produces a variety of boxes from preset options and from CSS.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
11

The contents of the box

Example
Hello, world!
Unknownsuggested
headerheader

A heading for the box

Example
Warning
Unknownsuggested
alignalign

The alignment of the box

Default
left
Example
center
Unknownsuggested
box typebox type

The type of box (css display) (block,inline-block or inline)

Example
block
Auto value
inline-block
Unknownoptional
widewide

If set to yes the box will be wide

Default
no
Example
yes
Auto value
Booleanoptional
inlineinline

Set to yes for the box type to be inline

Default
no
Example
yes
Booleanoptional
stylestyle

The style of the border

Default
solid
Unknownoptional
paddingpadding

The padding of the box

Default
3px
Unknownoptional
top paddingtop padding

The top padding of the box

Unknownoptional
bottom paddingbottom padding

Thebottom padding of the box

Unknownoptional
left paddingleft padding

The left padding of the box

Unknownoptional
right paddingright padding

The right padding of the box

Unknownoptional
border colorborder color

The color of the box border

Default
black
Example
red
Stringoptional
typetype

The type of box (black,white,transparent)

Example
black
Unknownoptional
border sizeborder size

The size of the border

Default
3px
Unknownoptional
colorcolor background

The color of background

Default
white
Example
black
Unknownoptional
text colortext color

The color of the text

Default
black
Example
green
Unknownoptional
text aligntext align

The alignment of the text (css text-align)

Default
left
Example
center
Unknownoptional
spacingspacing

The spacing of the letters

Unknownoptional
fontfont

The font of the text

Unknownoptional
font sizefont size text size

The size of the text

Unknownoptional
marginmargin

The size of the box's margin

Default
3px
Example
30px
Unknownoptional
top margintop margin

The size of the box's top margin

Unknownoptional
bottom marginbottom margin

The size of the box's bottom margin

Unknownoptional
left marginleft margin

The size of the box's left margin

Unknownoptional
right marginright margin

The size of the box's right margin

Unknownoptional
heightheight

The height of the box

Default
''the height of the contents plus the margin''
Example
400px
Unknownoptional
widthwidth

The width of the box

Default
''the width of the text plus the margin''
Unknownoptional
CSSCSS

Any additional CSS to use

Unknownoptional

Ytl|Divbox}}