Template:Ambox/doc

From FORwiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 +
{{Documentation subpage}}
 +
This is the {{tl|ambox}} or '''article message box''' meta-template.
This is the {{tl|ambox}} or '''article message box''' meta-template.
It is used to build ''article message box'' templates. 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]].
It is used to build ''article message box'' templates. 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]].
 +
 +
 +
=== Usage ===
 +
 +
Simple usage example:
 +
 +
<pre>
 +
{{ambox | text = Some text.}}
 +
</pre>
 +
 +
{{ambox | text = Some text.}}
 +
 +
 +
Complex example:
 +
 +
<pre>
 +
{{ambox
 +
| type      = style
 +
| small      = left
 +
| image      = [[Image:Emblem-question-yellow.svg|40px|link=]]
 +
| smallimage = [[Image:Emblem-question-yellow.svg|20px|link=]]
 +
| textstyle  = color: red; font-weight: bold; font-style: italic;
 +
| text      = Text for a big box, for the top of articles.
 +
| smalltext  = Text for the top of article sections.
 +
}}
 +
</pre>
 +
 +
{{ambox
 +
| type      = style
 +
| small      = left
 +
| image      = [[Image:Emblem-question-yellow.svg|40px|link=]]
 +
| smallimage = [[Image:Emblem-question-yellow.svg|20px|link=]]
 +
| textstyle  = color: red; font-weight: bold; font-style: italic;
 +
| text      = Text for a big box, for the top of articles.
 +
| smalltext  = Text for the top of article sections.
 +
}}
 +
 +
But you are not really supposed to use red bold italic 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|link=]]
 +
| text  = type = content <br> image = <nowiki>[[Image:Unbalanced scales.svg|40px|link=]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues.
 +
}}
 +
{{ambox
 +
| type  = style
 +
| image = [[Image:Wikitext.svg|50px|link=]]
 +
| text  = type = style <br> image = <nowiki>[[Image:Wikitext.svg|50px|link=]]</nowiki> <br> This image is often used for {{tl|wikify}} etc.
 +
}}
 +
{{ambox
 +
| type  = move
 +
| image = [[Image:Merge-arrows.svg|50px|link=]]
 +
| text  = type = move <br> image = <nowiki>[[Image:Merge-arrows.svg|50px|link=]]</nowiki> <br> This image is used for {{tl|merge}} etc.
 +
}}
 +
 +
=== More examples ===
 +
 +
Some other parameter combinations.
 +
 +
{{ambox
 +
| text  = No type and no image given ('''default''')
 +
}}
 +
{{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|link=]]
 +
| imageright = [[Image:Nuvola apps bookcase.svg|40px|link=]]
 +
| text  = image = <nowiki>[[Image:Gnome globe current event.svg|42px|link=]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px|link=]]</nowiki>
 +
}}
 +
 +
{{ambox
 +
| image = [[Image:Gnome globe current event.svg|42px|link=]]
 +
| imageright = [[Image:Shuttle.svg|20px|link=]]
 +
| 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  = speedy / delete / content / style / notice / move / protection
 +
| image = none / [[Image:Some image.svg|40px|link=]]
 +
| imageright = [[Image:Some image.svg|40px|link=]]
 +
| style = CSS values
 +
| textstyle = CSS values
 +
| text  = The message body text.
 +
| small = {{{small|}}} / left
 +
| smallimage = none / [[Image:Some image.svg|20px|link=]]
 +
| smallimageright = none / [[Image:Some image.svg|20px|link=]]
 +
| smalltext  = A shorter 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.) Typically, these images are purely decorative icons, so they should use "<code>|link=</code>" to avoid confusing [[screen readers]] and other [[assistive technology]] used by visually impaired readers (see [[WP:ALT]]). For example:
 +
::<code><nowiki>image = [[Image:Unbalanced scales.svg|40px|link=]]</nowiki></code>
 +
:'''none''' = Means that no image is used.
 +
:<s>'''blank'''</s> = This parameter is now deprecated. If you see it in use, change it to "image=none".
 +
 +
'''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|link=]]</nowiki></code>
 +
:'''Anything''' = Any other object that you want to show on the right side.
 +
 +
'''style'''
 +
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
 +
::<code>style = margin-bottom: 0.5em;</code>
 +
 +
'''textstyle'''
 +
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
 +
::<code>textstyle = text-align: center;</code>
 +
 +
'''text'''
 +
:The message body text.
 +
 +
==== The small parameters ====
 +
 +
The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.
 +
 +
{{ambox
 +
| small = left
 +
| text = small = yes
 +
}}
 +
{{ambox
 +
| type = style
 +
| small = left
 +
| text = type = style <br> small = left
 +
}}
 +
'''small'''
 +
:'''left''' = Makes it a smaller left aligned message box. This also makes the default images smaller. Note that any data fed to the '''smallimage''', '''smallimageright''' and '''smalltext''' parameters is only used if "small=left". To make it so your template also understands the small parameter you can use this code:
 +
::<code><nowiki>small = {{{small|}}}</nowiki></code>
 +
 +
{{ambox
 +
| small = left
 +
| image      = [[File:Gnome globe current event.svg|50px|link=]]
 +
| smallimage = [[File:Gnome globe current event.svg|25px|link=]]
 +
| text =
 +
small = left <br> image = <nowiki>[[Image:Replacement filing cabinet.svg|50px|link=]]</nowiki> <br> smallimage = <nowiki>[[Image:Replacement filing cabinet.svg|25px|link=]]</nowiki>
 +
}}
 +
'''smallimage'''
 +
:'''No parameter''' = If no '''smallimage''' parameter is given then this template falls back to use the '''image''' parameter. If the '''image''' parameter also is empty then a small default image is used.
 +
:'''An image''' = Should be an image with usual wiki notation. 20px width is usually about right for boxes with one line of text, while 25px width is usually about right for boxes with two lines of text. For example:
 +
::<code><nowiki>smallimage = [[File:Gnome globe current event.svg|20px|link=]]</nowiki></code>
 +
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left".
 +
 +
{{ambox
 +
| small = left
 +
| imageright = [[File:Gnome globe current event.svg|50px|link=]]
 +
| smallimageright = none
 +
| text =
 +
small = yes <br> imageright = <nowiki>[[File:Gnome globe current event.svg|50px|link=]]</nowiki> <br> smallimageright = none
 +
}}
 +
'''smallimageright'''
 +
:'''No parameter''' = If no '''smallimageright''' parameter is given then this template falls back to use the '''imageright''' parameter. If the '''imageright''' parameter also is empty then no image is shown on the right side.
 +
:'''An image''' = Should be an image with usual wiki notation. 20px - 25px width is usually about right. For example:
 +
::<code><nowiki>smallimageright = [[Image:Nuvola apps bookcase.png|20px|link=]]</nowiki></code>
 +
:'''Anything''' = Any other object that you want to show on the right side.
 +
:'''none''' = Means that no right side image is used. This overrides any image fed to '''imageright''', when "small=left".
 +
 +
'''smalltext'''
 +
:A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter.

Revision as of 21:40, 9 October 2009


This is the {{ambox}} or article message box meta-template.

It is used to build article message box templates. 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.


Contents

Usage

Simple usage example: 

{{ambox | text = Some text.}}
Some text.


Complex example: 

{{ambox
| type       = style
| small      = left
| image      = [[Image:Emblem-question-yellow.svg|40px|link=]]
| smallimage = [[Image:Emblem-question-yellow.svg|20px|link=]]
| textstyle  = color: red; font-weight: bold; font-style: italic;
| text       = Text for a big box, for the top of articles.
| smalltext  = Text for the top of article sections.
}}
Text for the top of article sections.

But you are not really supposed to use red bold italic 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.

type=speedy – Speedy deletion issues, such as {{db-g1}} and {{db-g3}}.
type=delete – Deletion issues, such as {{afd}} and {{prod}}.
type=content – Content issues, such as {{POV}} and {{globalize}}.
type=style – Style issues, such as {{cleanup}} and {{wikify}}.
type=notice – Article notices, such as {{current}} and {{inuse}}.
type=move – Merge, split and transwiki proposals, such as {{split}} and {{copy to wiktionary}}.
type=protection – Protection notices, such as {{pp-vandalism}} and {{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.

type = content
image = [[Image:Unbalanced scales.svg|40px|link=]]
This image is often used for {{POV}} and similar issues.
type = style
image = [[Image:Wikitext.svg|50px|link=]]
This image is often used for {{wikify}} etc.
type = move
image = [[Image:Merge-arrows.svg|50px|link=]]
This image is used for {{merge}} etc.

More examples

Some other parameter combinations.

No type and no image given (default)
No type and image=none – No image is used and the text uses the whole message box area.
image = [[Image:Gnome globe current event.svg|42px|link=]]
imageright = [[Image:Nuvola apps bookcase.svg|40px|link=]]
This article or section documents a current spaceflight.
Content may change as the mission progresses.

Parameters

List of all parameters: 

{{ambox
| type  = speedy / delete / content / style / notice / move / protection
| image = none / [[Image:Some image.svg|40px|link=]]
| imageright = [[Image:Some image.svg|40px|link=]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
| small = {{{small|}}} / left
| smallimage = none / [[Image:Some image.svg|20px|link=]]
| smallimageright = none / [[Image:Some image.svg|20px|link=]]
| smalltext  = A shorter message body text.
}}

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.) Typically, these images are purely decorative icons, so they should use "|link=" to avoid confusing screen readers and other assistive technology used by visually impaired readers (see WP:ALT). For example:
image = [[Image:Unbalanced scales.svg|40px|link=]]
none = Means that no image is used.
blank = This parameter is now deprecated. If you see it in use, change it to "image=none".

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:
imageright = [[Image:Nuvola apps bookcase.png|40px|link=]]
Anything = Any other object that you want to show on the right side.

style

Optional CSS values used by the entire message box table. Without quotation marks " " but with the ending semicolons ;. For example:
style = margin-bottom: 0.5em;

textstyle

Optional CSS values used by the text cell. For example:
textstyle = text-align: center;

text

The message body text.

The small parameters

The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.

small = yes
type = style
small = left

small

left = Makes it a smaller left aligned message box. This also makes the default images smaller. Note that any data fed to the smallimage, smallimageright and smalltext parameters is only used if "small=left". To make it so your template also understands the small parameter you can use this code:
small = {{{small|}}}
small = left
image = [[Image:Replacement filing cabinet.svg|50px|link=]]
smallimage = [[Image:Replacement filing cabinet.svg|25px|link=]]

smallimage

No parameter = If no smallimage parameter is given then this template falls back to use the image parameter. If the image parameter also is empty then a small default image is used.
An image = Should be an image with usual wiki notation. 20px width is usually about right for boxes with one line of text, while 25px width is usually about right for boxes with two lines of text. For example:
smallimage = [[File:Gnome globe current event.svg|20px|link=]]
none = Means that no image is used. This overrides any image fed to image, when "small=left".
small = yes
imageright = [[File:Gnome globe current event.svg|50px|link=]]
smallimageright = none

smallimageright

No parameter = If no smallimageright parameter is given then this template falls back to use the imageright parameter. If the imageright parameter also is empty then no image is shown on the right side.
An image = Should be an image with usual wiki notation. 20px - 25px width is usually about right. For example:
smallimageright = [[Image:Nuvola apps bookcase.png|20px|link=]]
Anything = Any other object that you want to show on the right side.
none = Means that no right side image is used. This overrides any image fed to imageright, when "small=left".

smalltext

A shorter version of the message body text. If no smalltext parameter is given then this template falls back to use the text parameter.
Retrieved from "http://forwiki.ro/wiki/Template:Ambox/doc"
Personal tools