Difference between revisions of "Template:Mbox/doc"
m (Reverting possible vandalism by Flappyflappy to version by Davidgothberg. False positive? Report it. Thanks, ClueBot. (590779) (Bot)) |
|||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} | |
| + | <includeonly>{{high-risk| 300,000+ | Wikipedia talk:Article message boxes }}</includeonly> | ||
| + | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
| + | {{mbox templates}} | ||
| + | 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. | |
| − | The | + | === 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 values | ||
| + | | textstyle = CSS values | ||
| + | | 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''' | ||
| + | :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. | ||
| + | |||
| + | === 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. | ||
| + | |||
| + | 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. | ||
| + | |||
| + | For more technical details see the [[Template talk:Ambox|talk page]] and the "See also" links below. Since this template works almost exactly like {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details. | ||
| + | |||
| + | === See also === | ||
| + | |||
| + | {{Mbox templates see also}} | ||
| + | |||
| + | Other pages: | ||
| + | * [[Wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[HTML element#Tables|HTML tables]]. | ||
| + | * [[Wikipedia:Article message boxes]] – The style guideline for creating article message boxes. | ||
| + | * [[Wikipedia talk:Article message boxes]] – For discussion about these matters. | ||
| + | |||
| + | <includeonly> | ||
| + | <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
| + | [[Category:Wikipedia metatemplates|Ambox]] | ||
| + | |||
| + | [[bg:Шаблон:Ambox]] | ||
| + | [[be-x-old:Шаблён:Паведамленьне]] | ||
| + | [[ca:Plantilla:Metacaixa d'avís]] | ||
| + | [[da:Skabelon:Hønsedesign]] | ||
| + | [[dsb:Pśedłoga:Ambox]] | ||
| + | [[es:Plantilla:Metaplantilla de avisos]] | ||
| + | [[eo:Ŝablono:ArtikolaMesaĝokesto]] | ||
| + | [[fa:الگو:Ambox]] | ||
| + | [[fr:Modèle:Méta bandeau d'avertissement]] | ||
| + | [[ko:틀:알림 상자]] | ||
| + | [[hsb:Předłoha:Ambox]] | ||
| + | [[hy:Կաղապար:Ambox]] | ||
| + | [[is:Snið:Skilaboð]] | ||
| + | [[it:Template:Avviso]] | ||
| + | [[ka:თარგი:Ambox]] | ||
| + | [[lv:Veidne:Ambox]] | ||
| + | [[mk:Шаблон:Ambox]] | ||
| + | [[mn:Template:Ambox]] | ||
| + | [[no:Mal:Ambox]] | ||
| + | [[ja:Template:Ambox]] | ||
| + | [[pl:Szablon:Ambox]] | ||
| + | [[ro:Format:meta-casetă]] | ||
| + | [[ru:Template:Ambox]] | ||
| + | [[sk:Šablóna:Ambox]] | ||
| + | [[sl:Predloga:Opozorilno polje]] | ||
| + | [[fi:Malline:Viestipohja]] | ||
| + | [[th:แม่แบบ:Ambox]] | ||
| + | [[tr:Şablon:Mikutusu]] | ||
| + | [[uk:Шаблон:Ambox]] | ||
| + | [[vi:Tiêu bản:Hộp thông báo]] | ||
| + | [[zh-yue:Template:Ambox]] | ||
| + | [[zh:Template:Ambox]] | ||
| + | </includeonly> | ||
Revision as of 18:43, 18 February 2009
Template:Mbox templates
This is the Template:Tl or article message box meta-template.
It is used to build article message box templates such as Template:Tl 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 wikitable if special functionality is needed. See the how-to guide for that.
Contents
[hide]Usage
Simple usage example:
{{ambox | text = Some text.}}
Complex example:
{{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.
Template:Ambox Template:Ambox Template:Ambox Template:Ambox Template:Ambox Template:Ambox Template:Ambox
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.
Template:Ambox Template:Ambox Template:Ambox
Special
Some other parameter combinations.
Template:Ambox Template:Ambox Template:Ambox
Parameters
List of all parameters:
{{ambox
| type = delete / content / style / notice / move / protection
| image = none / blank / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text = The 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.) For example:
image = [[Image:Unbalanced scales.svg|40px]]
- 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:
imageright = [[Image:Nuvola apps bookcase.png|40px]]
- 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.
Technical details
If you need to use special characters in the text parameter then you need to escape them like this:
{{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 <div> 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.
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 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.
For more technical details see the talk page and the "See also" links below. Since this template works almost exactly like Template:Tl, Template:Tl, Template:Tl and Template:Tl their talk pages and related pages might also contain more details.
See also
Template:Mbox templates see also
Other pages:
- Wikipedia:Ambox CSS classes – Describes how to use the ambox CSS classes directly in wikitables and HTML tables.
- Wikipedia:Article message boxes – The style guideline for creating article message boxes.
- Wikipedia talk:Article message boxes – For discussion about these matters.