Vorlage:Dmbox/Doku: Unterschied zwischen den Versionen
Adding lots more documentation. Intermediate save.
imported>Davidgothberg (Adding a notice at top that this template is not ready to deploy yet. And correcting the category. And adding list of all parameters.) |
imported>Davidgothberg (Adding lots more documentation. Intermediate save.) |
||
Zeile 6: | Zeile 6: | ||
}} | }} | ||
=== Disambig box | This is the {{tl|disambigbox}} or '''disambiguation message box''' meta-template. | ||
It is used to build disambiguation and [[Wikipedia:Disambiguation#Set index articles|set index article]] boxes, such as {{tl|disambig}} and {{tl|shipindex}}. | |||
This template works similarly to {{tl|ambox}} and mostly uses the same parameters. The main differences are that this box has the disambig style and only has two "type" settings. | |||
=== Usage === | |||
Simple usage example: | |||
<pre> | |||
{{disambigbox | text = Some text.}} | |||
</pre> | |||
{{disambigbox | text = Some text.}} | |||
Complex example: | |||
<pre> | |||
{{disambigbox | |||
| type = setindex | |||
| image = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]] | |||
| textstyle = color: red; font-weight: bold; font-style: normal; | |||
| text = The message body text. | |||
}} | |||
</pre> | |||
{{disambigbox | |||
| type = setindex | |||
| image = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]] | |||
| textstyle = color: red; font-weight: bold; font-style: normal; | |||
| text = The message body text. | |||
}} | |||
=== Parameters === | |||
List of all parameters: | |||
<pre> | |||
{{disambigbox | |||
| type = disambig / setindex | |||
| image = none / [[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 '''disambig'''. It means that it internally sets the CSS id "disambig" which means ... | |||
'''image''' | |||
:'''No parameter''' = If no '''image''' parameter is given the template uses the default disambig image. | |||
:'''An image''' = Should be an image with usual wiki notation. 30px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example: | |||
::<code><nowiki>image = [[Image:Schooner.svg|30px]]</nowiki></code> | |||
:'''none''' = Means that no image is used. | |||
'''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. 30px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) 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.2em;</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. This message box has ''italic'' text as default, thus no need to manually set that. | |||
=== Test examples === | === Test examples === | ||
Zeile 34: | Zeile 107: | ||
{{disambigbox | {{disambigbox | ||
| type = setindex | | type = setindex | ||
| image = [[Image: | | image = [[Image:Schooner.svg|27px]][[Image:Disambig gray.svg|30px|Disambiguation notice]] | ||
| text = | | text = | ||
''This [[Wikipedia: | ''This article includes a [[Wikipedia:WikiProject Ships/Guidelines#Index pages|list of ships]] with the same or similar names. If an [[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|internal link]] for a specific ship referred you to this page, you may wish to change the link to point directly to the intended ship article, if one exists.'' | ||
}} | }} | ||
Zeile 43: | Zeile 116: | ||
{{disambigbox | {{disambigbox | ||
| type = setindex | | type = setindex | ||
| image = [[Image: | | image = [[Image:Three-Sisters-Alberta-cropped.jpg|80px]] | ||
| text = | | text = | ||
''This | ''This [[Wikipedia:Disambiguation#Set index articles|set index article]] lists articles about mountains with the same or similar names. If an [[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|internal link]] referred you to this page, you may wish to change the link to point directly to the intended mountain article, if one exists.'' | ||
}} | }} | ||
Some text. | Some text. | ||
=== See also === | === See also === |