Template:Ambox/doc - Revision history

Jadrian Miles: /* Parameters */

2009-07-16T17:54:57Z

Parameters

← Older revision		Revision as of 17:54, 16 July 2009
Line 116:		Line 116:
	'''image'''		'''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.		:'''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:		:'''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>		::<code><nowiki>image = [[Image:Unbalanced scales.svg\|40px\|link=]]</nowiki></code>
	:'''none''' = Means that no image is used.		:'''none''' = Means that no image is used.
Line 147:		Line 147:
	}}		}}
	{{ambox		{{ambox
	~~\| type = style~~
	\| small = left		\| small = left
	\| text = type = style <br> small = left		\| text = type = style <br> small = left
Line 157:		Line 156:
	{{ambox		{{ambox
	\| small = left		\| small = left
	\| image = [[~~File~~:~~Gnome globe current event~~.~~svg~~\|50px\|link=]]		\| image = [[Image:CavePainting-menu-undo.jpg\|50px\|link=]]
	\| smallimage = [[~~File~~:~~Gnome globe current event~~.~~svg~~\|25px\|link=]]		\| smallimage = [[Image:CavePainting-menu-undo.jpg\|25px\|link=]]
	\| text =		\| 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>		small = left <br> image = <nowiki>[[Image:CavePainting-menu-undo.jpg\|50px\|link=]]</nowiki> <br> smallimage = <nowiki>[[Image:CavePainting-menu-undo.jpg\|25px\|link=]]</nowiki>
	}}		}}
	'''smallimage'''		'''smallimage'''

Jadrian Miles: /* More examples */

2009-07-16T17:51:09Z

More examples

← Older revision		Revision as of 17:51, 16 July 2009
Line 87:		Line 87:

	{{ambox		{{ambox
	\| image = [[Image:~~Gnome globe current event~~.~~svg~~\|42px\|link=]]		\| image = [[Image:CavePainting-menu-undo.jpg\|42px\|link=]]
	\| imageright = [[Image:~~Nuvola apps bookcase~~.~~svg~~\|40px\|link=]]		\| imageright = [[Image:CavePainting-menu-redo.jpg\|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>		\| text = <tt>image = <nowiki>[[Image:CavePainting-menu-undo.jpg\|42px\|link=]]</nowiki> <br> imageright = <nowiki>[[Image:CavePainting-menu-redo.jpg\|40px\|link=]]</nowiki></tt>
	}}

	~~{{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.~~
	}}		}}

Jadrian Miles: /* Usage */

2009-07-16T17:49:24Z

Usage

← Older revision		Revision as of 17:49, 16 July 2009
Line 32:		Line 32:

	{{ambox		{{ambox
			\| type = notice
	\| small = left		\| small = left
	\| image = [[Image:Icon question.svg\|40px\|link=]]		\| image = [[Image:Icon question.svg\|40px\|link=]]

Jadrian Miles: /* Usage */

2009-07-16T17:49:11Z

Usage

← Older revision		Revision as of 17:49, 16 July 2009
Line 21:		Line 21:
	<pre>		<pre>
	{{ambox		{{ambox
			\| type = notice
	\| small = left		\| small = left
	\| image = [[Image:Icon question.svg\|40px\|link=]]		\| image = [[Image:Icon question.svg\|40px\|link=]]

Jadrian Miles: /* Other images */

2009-07-16T17:48:41Z

Other images

← Older revision		Revision as of 17:48, 16 July 2009
Line 64:		Line 64:
	=== Other images ===		=== 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.		The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. This example uses the '''image''' parameter to specify an image other than the default images.

	{{ambox		{{ambox
	\| type = info		\| type = info
	\| image = [[Image:CavePainting-menu-save.jpg\|40px\|link=]]		\| image = [[Image:CavePainting-menu-save.jpg\|40px\|link=]]
	\| text = type = info <br> image = <nowiki>[[Image:CavePainting-menu-save.jpg\|40px\|link=]]</nowiki> <br> ~~Example image.~~		\| text = <tt>type = info <br> image = <nowiki>[[Image:CavePainting-menu-save.jpg\|40px\|link=]]</nowiki></tt>
	}}		}}

Jadrian Miles: /* Other images */

2009-07-16T17:45:44Z

Other images

← Older revision		Revision as of 17:45, 16 July 2009
Line 67:		Line 67:

	{{ambox		{{ambox
	\| type = ~~content~~		\| type = info
	\| image = [[Image:~~Unbalanced scales~~.~~svg~~\|40px\|link=]]		\| image = [[Image:CavePainting-menu-save.jpg\|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.~~		\| text = type = info <br> image = <nowiki>[[Image:CavePainting-menu-save.jpg\|40px\|link=]]</nowiki> <br> Example image.
	}}
	~~{{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~~.
	}}		}}

Jadrian Miles at 17:42, 16 July 2009

2009-07-16T17:42:52Z

← Older revision		Revision as of 17:42, 16 July 2009
Line 46:		Line 46:

	{{ambox		{{ambox
	\| type = ~~speedy~~		\| type = warn
	\| text = type=<u>~~speedy~~</u> – ~~Speedy deletion issues, such as {{tl\|db-g1}} and {{tl\|db-g3}}~~.		\| text = type=<u>warn</u> – Warnings.
	}}		}}
	{{ambox		{{ambox
	\| type = ~~delete~~		\| type = question
	\| text = type=<u>~~delete~~</u> – ~~Deletion issues, such as {{tl\|afd}} and {{tl\|prod}}~~.		\| text = type=<u>question</u> – Questions or indications of uncertainty.
	}}		}}
	{{ambox		{{ambox
	\| type = ~~content~~		\| type = exclamation
	\| text = type=<u>~~content~~</u> – ~~Content issues, such as {{tl\|POV}} and {{tl\|globalize}}.~~		\| text = type=<u>exclamation</u> – Exclamations.
	}}
	~~{{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		{{ambox
	\| type = ~~protection~~		\| type = info
	\| text = type=<u>~~protection~~</u> – ~~Protection notices, such as {{tl\|pp-vandalism}} and {{tl\|pp-semi-protected}}~~.		\| text = type=<u>info</u> – Additional information.
	}}		}}

Line 247:		Line 235:

	Other pages:		Other pages:
	* [[w:Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:~~Table~~\|wikitable]]s and ~~[[HTML element#Tables\|~~HTML tables]].		* [[w:Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Tables\|wikitable]]s and HTML tables.
	* [[w:Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.		* [[w:Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
	* [[w:Wikipedia talk:Article message boxes]] – For discussion about these matters.		* [[w:Wikipedia talk:Article message boxes]] – For discussion about these matters.

Jadrian Miles: /* Usage */

2009-07-16T17:32:11Z

Usage

← Older revision		Revision as of 17:32, 16 July 2009
Line 21:		Line 21:
	<pre>		<pre>
	{{ambox		{{ambox
	~~\| type = style~~
	\| small = left		\| small = left
	\| image = [[Image:~~Emblem-~~question~~-yellow~~.svg\|40px\|link=]]		\| image = [[Image:Icon question.svg\|40px\|link=]]
	\| smallimage = [[Image:~~Emblem-~~question~~-yellow~~.svg\|20px\|link=]]		\| smallimage = [[Image:Icon question.svg\|20px\|link=]]
	\| textstyle = color: red; font-weight: bold; font-style: italic;		\| textstyle = color: red; font-weight: bold; font-style: italic;
	\| text = Text for a big box, for the top of articles.		\| text = Text for a big box, for the top of articles.
Line 32:		Line 31:

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

Jadrian Miles: New page: This is the {{tl|ambox}} or '''article message box''' meta-template, copied from Wikipedia. I...

2009-07-16T17:24:11Z

New page:  This is the {{tl|ambox}} or '''article message box''' meta-template, copied from Wikipedia. I...

New page

This is the {{tl|ambox}} or '''article message box''' meta-template, [[w:Template:Ambox|copied from Wikipedia]].

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
| 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=speedy – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.
}}
{{ambox
| type = delete
| text = type=delete – Deletion issues, such as {{tl|afd}} and {{tl|prod}}.
}}
{{ambox
| type = content
| text = type=content – Content issues, such as {{tl|POV}} and {{tl|globalize}}.
}}
{{ambox
| type = style
| text = type=style – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}.
}}
{{ambox
| type = notice
| text = type=notice – Article notices, such as {{tl|current}} and {{tl|inuse}}.
}}
{{ambox
| type = move
| text = type=move – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}.
}}
{{ambox
| type = protection
| text = type=protection – 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 image = <nowiki>[[Image:Unbalanced scales.svg|40px|link=]]</nowiki> This image is often used for {{tl|POV}} and similar issues.
}}
{{ambox
| type = style
| image = [[Image:Wikitext.svg|50px|link=]]
| text = type = style image = <nowiki>[[Image:Wikitext.svg|50px|link=]]</nowiki> This image is often used for {{tl|wikify}} etc.
}}
{{ambox
| type = move
| image = [[Image:Merge-arrows.svg|50px|link=]]
| text = type = move image = <nowiki>[[Image:Merge-arrows.svg|50px|link=]]</nowiki> 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> 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]].'''
 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 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 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 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 image = <nowiki>[[Image:Replacement filing cabinet.svg|50px|link=]]</nowiki> 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 imageright = <nowiki>[[File:Gnome globe current event.svg|50px|link=]]</nowiki> 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.

=== 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 &#124; and two end braces <nowiki>}}</nowiki>.
And now a pipe and end braces <nowiki>|}}</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 braces <nowiki>|}}</nowiki>.
</div>
}}

The <code><div></code> tags that surround the text in the example above are usually not needed. But if the text contains line breaks then sometimes we get weird line spacing. This especially happens when using vertical dotted lists. Then use the div tags to fix that.

This template uses CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.

This template calls {{tl|ambox/core}} which holds most of the code for {{tl|ambox}}, while {{tl|ambox}} itself does parameter preprocessing.

Internally this meta-template uses HTML wikimarkup instead of wikimarkup for the table code. That is the usual way we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and some special characters in parameters.

The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.

=== See also ===

Other pages:
* [[w:Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[HTML element#Tables|HTML tables]].
* [[w:Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
* [[w:Wikipedia talk:Article message boxes]] – For discussion about these matters.

<includeonly>

</includeonly>