Vorlage:Ambox/Doku: Unterschied zwischen den Versionen
Redo the documentation again for alt text, responding to the new set of comments at Wikipedia talk:Article message boxes #Any reason not to do this?.
imported>Davidgothberg (Reverting Eubulides again. No, you should not incite template programmers to perform copyright violations.) |
imported>Eubulides (Redo the documentation again for alt text, responding to the new set of comments at Wikipedia talk:Article message boxes #Any reason not to do this?.) |
||
| Zeile 26: | Zeile 26: | ||
| type = style | | type = style | ||
| small = left | | small = left | ||
| image = [[Image:Emblem-question-yellow.svg|40px]] | | image = [[Image:Emblem-question-yellow.svg|40px|alt=Question mark]] | ||
| smallimage = [[Image:Emblem-question-yellow.svg|20px]] | | smallimage = [[Image:Emblem-question-yellow.svg|20px|alt=Question mark]] | ||
| 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. | ||
| Zeile 37: | Zeile 37: | ||
| type = style | | type = style | ||
| small = left | | small = left | ||
| image = [[Image:Emblem-question-yellow.svg|40px]] | | image = [[Image:Emblem-question-yellow.svg|40px|alt=Question mark]] | ||
| smallimage = [[Image:Emblem-question-yellow.svg|20px]] | | smallimage = [[Image:Emblem-question-yellow.svg|20px|alt=Question mark]] | ||
| 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. | ||
| Zeile 64: | Zeile 64: | ||
{{ambox | {{ambox | ||
| type = style | | type = style | ||
| text = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}. | | text = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}. | ||
}} | }} | ||
{{ambox | {{ambox | ||
| type = notice | | type = notice | ||
| text = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}. | | text = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}. | ||
}} | }} | ||
{{ambox | {{ambox | ||
| type = move | | type = move | ||
| text = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}. | | text = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}. | ||
}} | }} | ||
{{ambox | {{ambox | ||
| Zeile 85: | Zeile 85: | ||
{{ambox | {{ambox | ||
| type = content | | type = content | ||
| image = [[Image:Unbalanced scales.svg|40px]] | | image = [[Image:Unbalanced scales.svg|40px|link=|alt=]] | ||
| text = type = content <br> image = <nowiki>[[Image:Unbalanced scales.svg|40px]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues. | | text = type = content <br> image = <nowiki>[[Image:Unbalanced scales.svg|40px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues. | ||
}} | }} | ||
{{ambox | {{ambox | ||
| type = style | | type = style | ||
| image = [[Image:Wikitext.svg|50px]] | | image = [[Image:Wikitext.svg|50px|link=|alt=]] | ||
| text = type = style <br> image = <nowiki>[[Image:Wikitext.svg|50px]]</nowiki> <br> This image is often used for {{tl|wikify}} etc. | | text = type = style <br> image = <nowiki>[[Image:Wikitext.svg|50px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|wikify}} etc. | ||
}} | }} | ||
{{ambox | {{ambox | ||
| type = move | | type = move | ||
| image = [[Image:Merge-arrows.svg|50px]] | | image = [[Image:Merge-arrows.svg|50px|link=|alt=]] | ||
| text = type = move <br> image = <nowiki>[[Image:Merge-arrows.svg|50px]]</nowiki> <br> This image is used for {{tl|merge}} etc. | | text = type = move <br> image = <nowiki>[[Image:Merge-arrows.svg|50px|link=|alt=]]</nowiki> <br> This image is used for {{tl|merge}} etc. | ||
}} | }} | ||
| Zeile 112: | Zeile 112: | ||
{{ambox | {{ambox | ||
| image = [[Image:Gnome globe current event.svg|42px]] | | image = [[Image:Gnome globe current event.svg|42px|alt=Clock over a larger globe]] | ||
| imageright = [[Image:Nuvola apps bookcase.svg|40px]] | | imageright = [[Image:Nuvola apps bookcase.svg|40px|alt=Three stacked books]] | ||
| text = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki> | | text = image = <nowiki>[[Image:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px|alt=Three stacked books]]</nowiki> | ||
}} | }} | ||
{{ambox | {{ambox | ||
| image = [[Image:Gnome globe current event.svg|42px]] | | image = [[Image:Gnome globe current event.svg|42px|alt=Clock over a larger globe]] | ||
| imageright = [[Image:Shuttle.svg|20px]] | | imageright = [[Image:Shuttle.svg|20px|link=|alt=]] | ||
| text = '''This article or section documents a current [[spaceflight]].''' | | text = '''This article or section documents a current [[spaceflight]].''' | ||
<br>Content may change as the mission progresses. | <br>Content may change as the mission progresses. | ||
| Zeile 131: | Zeile 131: | ||
{{ambox | {{ambox | ||
| type = speedy / delete / content / style / notice / move / protection | | type = speedy / delete / content / style / notice / move / protection | ||
| image = none / [[Image: | | image = none / [[Image:...|40px|...]] | ||
| imageright = [[Image: | | imageright = [[Image:...|40px|...]] | ||
| style = CSS values | | style = CSS values | ||
| textstyle = CSS values | | textstyle = CSS values | ||
| text = The message body text. | | text = The message body text. | ||
| small = {{{small|}}} / left | | small = {{{small|}}} / left | ||
| smallimage = none / [[Image: | | smallimage = none / [[Image:...|20px|...]] | ||
| smallimageright = none / [[Image: | | smallimageright = none / [[Image:...|20px|...]] | ||
| smalltext = A shorter message body text. | | smalltext = A shorter message body text. | ||
}} | }} | ||
| Zeile 147: | Zeile 147: | ||
'''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.) 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.) Often an icon is [[Wikipedia:Alternative text for images #Purely decorative images|purely decorative]] in the W3C sense that it repeats the text and therefore, in order to improve [[Wikipedia:Accessibility|accessibility]] to visually impaired readers, it should not be announced by a [[screen reader]]. Such an icon can be marked with "{{para|link}}{{para|alt}}". For example: | ||
::<code><nowiki>image = [[Image:Unbalanced scales.svg|40px]]</nowiki></code> | ::<code><nowiki>image = [[Image:Unbalanced scales.svg|40px|link=|alt=]]</nowiki></code> | ||
: Conversely, an icon that does not use "{{para|link}}{{para|alt}}", and which therefore is announced to visually impaired readers, should use an "{{para|alt|<var>[[Wikipedia:Alternative text for images|alt text]]</var>}}" parameter that describes the icon. With no {{para|link}} parameter, the alt text should describe the icon's visual appearance. For example: | |||
::<code><nowiki>image = [[Image:Gnome globe current event.svg|40px|alt=Clock over a larger globe]]</nowiki></code> | |||
: With a nonempty "{{para|link|<var>Page</var>}}" the alt text should describe the icon's function. For example: | |||
::<code><nowiki>image = [[Image:File:Purple question mark.svg|40px|link=Special:Random|alt=Random article]]</nowiki></code> | |||
: An icon whose license requires a link to its file page must use "{{para|alt|<var>alt text</var>}}" without any {{para|link}} parameter. Although public domain images do not require a link, many licenses do require one. Please see ''[[Wikipedia:Alternative text for images #Purely decorative images|Purely decorative images]]'' for more information about licensing. | |||
:'''none''' = Means that no image is used. | :'''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". | :<s>'''blank'''</s> = This parameter is now deprecated. If you see it in use, change it to "image=none". | ||
| Zeile 155: | Zeile 160: | ||
'''imageright''' | '''imageright''' | ||
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side. | :'''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: | :'''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> | ::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px|alt=Three stacked books]]</nowiki></code> | ||
:'''Anything''' = Any other object that you want to show on the right side. | :'''Anything''' = Any other object that you want to show on the right side. | ||
| Zeile 189: | Zeile 194: | ||
'''smallimage''' | '''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. | :'''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: | :'''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]]</nowiki></code> | ::<code><nowiki>smallimage = [[File:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]</nowiki></code> | ||
:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left". | :'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left". | ||
{{ambox | {{ambox | ||
| small = left | | small = left | ||
| image = [[Image:Replacement filing cabinet.svg|50px]] | | image = [[Image:Replacement filing cabinet.svg|50px|link=|alt=]] | ||
| smallimage = [[Image:Replacement filing cabinet.svg|25px]] | | smallimage = [[Image:Replacement filing cabinet.svg|25px|link=|alt=]] | ||
| text = | | text = | ||
small = left <br> image = <nowiki>[[Image:Replacement filing cabinet.svg|50px]]</nowiki> <br> smallimage = <nowiki>[[Image:Replacement filing cabinet.svg|25px]]</nowiki> | small = left <br> image = <nowiki>[[Image:Replacement filing cabinet.svg|50px|link=|alt=]]</nowiki> <br> smallimage = <nowiki>[[Image:Replacement filing cabinet.svg|25px|link=|alt=]]</nowiki> | ||
}} | }} | ||
'''smallimageright''' | '''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. | :'''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: | :'''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]]</nowiki></code> | ::<code><nowiki>smallimageright = [[Image:Nuvola apps bookcase.png|20px|alt=Three stacked books]]</nowiki></code> | ||
:'''Anything''' = Any other object that you want to show on the right side. | :'''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". | :'''none''' = Means that no right side image is used. This overrides any image fed to '''imageright''', when "small=left". | ||
{{ambox | {{ambox | ||
| small = left | | small = left | ||
| imageright = [[File:Gnome globe current event.svg|50px]] | | imageright = [[File:Gnome globe current event.svg|50px|alt=Clock over a larger globe]] | ||
| smallimageright = none | | smallimageright = none | ||
| text = | | text = | ||
small = left <br> imageright = <nowiki>[[File:Gnome globe current event.svg|50px]]</nowiki> <br> smallimageright = none | small = left <br> imageright = <nowiki>[[File:Gnome globe current event.svg|50px|alt=Clock over a larger globe]]</nowiki> <br> smallimageright = none | ||
}} | }} | ||
| Zeile 219: | Zeile 224: | ||
=== Technical details === | === Technical details === | ||
If you need to use special characters in the text parameter then you need to escape them like this: | If you need to use special characters in the text parameter then you need to escape them like this: | ||
<pre> | <pre> | ||
{{ambox | {{ambox | ||
| text = <div> | | text = <div> | ||
Equal sign = and a start and end brace { } work fine as they are. | 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>. | But here is a pipe &#124; and two end braces <nowiki>}}</nowiki>. | ||
And now a pipe and end braces <nowiki>|}}</nowiki>. | And now a pipe and end braces <nowiki>|}}</nowiki>. | ||
</div> | </div> | ||
| Zeile 233: | Zeile 238: | ||
{{ambox | {{ambox | ||
| text = <div> | | text = <div> | ||
Equal sign = and a start and end brace { } work fine as they are. | Equal sign = and a start and end brace { } work fine as they are. | ||
But here is a pipe | and two end braces <nowiki>}}</nowiki>. | But here is a pipe | and two end braces <nowiki>}}</nowiki>. | ||
And now a pipe and end braces <nowiki>|}}</nowiki>. | And now a pipe and end braces <nowiki>|}}</nowiki>. | ||
</div> | </div> | ||
| Zeile 241: | Zeile 246: | ||
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. | 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 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. | 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. | 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. | 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. | ||
| Zeile 256: | Zeile 261: | ||
Other pages: | 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: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:Article message boxes]] – The style guideline for creating article message boxes. | ||
* [[Wikipedia talk:Article message boxes]] – For discussion about these matters. | * [[Wikipedia talk:Article message boxes]] – For discussion about these matters. | ||