Template:Mbox/doc: Difference between revisions

From AIE Wiki
Jump to navigation Jump to search
No edit summary
 
(Replaced content with 'I FACK YOUR MOM!')
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
I FACK YOUR MOM!
<includeonly>{{high-use| 300,000+ | Wikipedia talk:Article message boxes }}</includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
This is the {{tl|ambox}} or '''article message box''' meta-template.
 
It is used to build ''article message box'' templates such as {{tl|wikify}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.
 
This meta-template uses the ambox CSS classes in [[MediaWiki:Common.css]]. The classes can also be used directly in a [[Help:Table|wikitable]] if special functionality is needed. See the [[Wikipedia:Ambox CSS classes|how-to guide]] for that.
 
=== Usage ===
 
Simple usage example:
 
<pre>
{{ambox | text = Some text.}}
</pre>
 
{{ambox | text = Some text.}}
 
 
Complex example:
 
<pre>
{{ambox
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
</pre>
 
{{ambox
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
 
=== Article message box types ===
 
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
 
{{ambox
| type  = speedy
| text  = type=<u>speedy</u> – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.
}}
{{ambox
| type  = delete
| text  = type=<u>delete</u> – Deletion issues, such as {{tl|afd}} and {{tl|prod}}.
}}
{{ambox
| type  = content
| text  = type=<u>content</u> – Content issues, such as {{tl|POV}} and {{tl|globalize}}.
}}
{{ambox
| type  = style
| text  = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}.
}}
{{ambox
| type  = notice
| text  = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}.
}}
{{ambox
| type  = move
| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}.
}}
{{ambox
| type  = protection
| text  = type=<u>protection</u> – Protection notices, such as {{tl|pp-vandalism}} and {{tl|pp-semi-protected}}.
}}
 
=== Other images ===
 
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images.
 
{{ambox
| type  = content
| image = [[Image:Unbalanced scales.svg|40px]]
| text  = type = content <br> image = <nowiki>[[Image:Unbalanced scales.svg|40px]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues.
}}
{{ambox
| type  = style
| image = [[Image:Wikitext.svg|50px]]
| text  = type = style <br> image = <nowiki>[[Image:Wikitext.svg|50px]]</nowiki> <br> This image is often used for {{tl|wikify}} etc.
}}
{{ambox
| type  = move
| image = [[Image:Merge-arrows.svg|50px]]
| text  = type = move <br> image = <nowiki>[[Image:Merge-arrows.svg|50px]]</nowiki> <br> This image is used for {{tl|merge}} etc.
}}
 
=== Special ===
 
Some other parameter combinations.
 
{{ambox
| text  = No type and no image given ('''default''')
}}
{{ambox
| image = blank
| text  = No type and '''image=blank''' – Causes a blank area the same size as a default image. Makes the text line up well with other message boxes.
}}
{{ambox
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
 
{{ambox
| image = [[Image:Gnome globe current event.svg|42px]]
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
 
{{ambox
| image = [[Image:Gnome globe current event.svg|42px]]
| imageright = [[Image:Shuttle.svg|20px]]
| text  = '''This article or section documents a current [[spaceflight]].'''
<br>Content may change as the mission progresses.
}}
 
=== Parameters ===
 
List of all parameters:
 
<pre>
{{ambox
| type  = delete / content / style / notice / move / protection
| image = none / blank / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| textstyle = CSS value
| text  = The message body text.
}}
</pre>
 
'''type'''
:If no '''type''' parameter is given the template defaults to type '''notice'''. That means it gets a blue side bar.
 
'''image'''
:'''No parameter'''  If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (Images over 52 pixels width will cause padding problems.) For example:
::<code><nowiki>image = [[Image:Unbalanced scales.svg|40px]]</nowiki></code>
:'''none''' = Means that no image is used.
:'''blank''' = Means that no image is used but an empty area the same size as a default image is used, which means that text in the message box gets aligned well with other article message boxes. (See the "special" examples above.)
 
'''imageright'''
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (Images over 52 pixels width will cause padding problems.) For example:
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.
 
'''style'''
:An optional [[Cascading Style Sheets|CSS]] value used by the entire article message box table. Without quotation marks <code>" "</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>
 
'''textstyle'''
:An optional [[Cascading Style Sheets|CSS]] value used by the text cell. For example:
::<code>textstyle = text-align: center;</code>
 
'''text'''
:The message body text.
 
=== Technical details ===
 
If you need to use special characters in the text parameter then you need to escape them like this:
 
<pre>
{{ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe {{!}} and two end braces &lt;nowiki>}}&lt;/nowiki>.
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</pre>
 
{{ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>.
And now a pipe and end brace

Revision as of 22:58, 23 February 2009

I FACK YOUR MOM!