Vorlage:Dmbox/Doku: Unterschied zwischen den Versionen

Aus skandinavien-wiki.net
imported>Davidgothberg
K (moved Template:Disambigbox/doc to Template:Dmbox/doc: More in line with the naming of the other mboxes.)
imported>Davidgothberg
(Updated doc from "disambigbox" name to "dmbox".)
Zeile 6: Zeile 6:
}}
}}


This is the {{tl|disambigbox}} or '''disambiguation message box''' meta-template.
This is the {{tl|dmbox}} 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}}.  
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.
This template works similarly to {{tl|ambox}} and mostly uses the same parameters. The main differences are that this box uses the disambig style and only has two "type" settings.


=== Usage ===
=== Usage ===
Zeile 17: Zeile 17:


<pre>
<pre>
{{disambigbox | text = Some text.}}
{{dmbox | text = Some text.}}
</pre>
</pre>


{{disambigbox | text = Some text.}}
{{dmbox | text = Some text.}}


Complex example:
Complex example:


<pre>
<pre>
{{disambigbox
{{dmbox
| type      = setindex
| type      = setindex
| image    = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]]
| image    = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]]
Zeile 33: Zeile 33:
</pre>
</pre>


{{disambigbox
{{dmbox
| type      = setindex
| type      = setindex
| image    = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]]
| image    = [[Image:Schooner.svg|27px]] [[Image:Disambig gray.svg|30px]]
Zeile 43: Zeile 43:
Some other parameter combinations:
Some other parameter combinations:


{{disambigbox
{{dmbox
| text  = No type and no image given ('''default''')
| text  = No type and no image given ('''default''')
}}
}}
{{disambigbox
{{dmbox
| image = none
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
}}


{{disambigbox
{{dmbox
| image = [[Image:Disambig gray.svg|35px]]
| image = [[Image:Disambig gray.svg|35px]]
| imageright = [[Image:Schooner.svg|35px]]  
| imageright = [[Image:Schooner.svg|35px]]  
Zeile 57: Zeile 57:
}}
}}


{{disambigbox
{{dmbox
| image = [[Image:Disambig gray.svg|35px]]
| image = [[Image:Disambig gray.svg|35px]]
| imageright = [[Image:Schooner.svg|35px]]
| imageright = [[Image:Schooner.svg|35px]]
Zeile 69: Zeile 69:


<pre>
<pre>
{{disambigbox
{{dmbox
| type  = disambig / setindex
| type  = disambig / setindex
| image = none / [[Image:Some image.svg|40px]]
| image = none / [[Image:Some image.svg|40px]]
Zeile 114: Zeile 114:


<pre>
<pre>
{{cmbox
{{dmbox
| 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.  
Zeile 123: Zeile 123:
</pre>
</pre>


{{cmbox
{{dmbox
| 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.  
Zeile 143: Zeile 143:
Some text.
Some text.


{{disambigbox}}
{{dmbox}}


Some text.
Some text.


{{disambigbox
{{dmbox
| type = disambig
| type = disambig
| text =  
| text =  
Zeile 155: Zeile 155:
Some text.
Some text.


{{disambigbox
{{dmbox
| type = setindex
| type = setindex
| text =  
| text =  
Zeile 163: Zeile 163:
Some text.
Some text.


{{disambigbox
{{dmbox
| type = setindex
| type = setindex
| image = [[Image:Schooner.svg|27px]][[Image:Disambig gray.svg|30px|Disambiguation notice]]
| image = [[Image:Schooner.svg|27px]][[Image:Disambig gray.svg|30px|Disambiguation notice]]
Zeile 172: Zeile 172:
Some text.
Some text.


{{disambigbox
{{dmbox
| type = setindex
| type = setindex
| image = [[Image:Three-Sisters-Alberta-cropped.jpg|80px]]
| image = [[Image:Three-Sisters-Alberta-cropped.jpg|80px]]

Version vom 8. Oktober 2008, 12:22 Uhr

Vorlage:Caution

This is the {{dmbox}} or disambiguation message box meta-template.

It is used to build disambiguation and set index article boxes, such as {{disambig}} and {{shipindex}}.

This template works similarly to {{ambox}} and mostly uses the same parameters. The main differences are that this box uses the disambig style and only has two "type" settings.

Usage

Simple usage example:

{{dmbox | text = Some text.}}

Complex example:

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


Some other parameter combinations:

Parameters

List of all parameters:

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

type

If no type parameter is given the template defaults to type disambig.
disambig = Means that this template internally sets the CSS id "disambig". Which means that the {{disambig editintro}} is displayed when editing a page with this template on. (The id is used by the javascript in MediaWiki:Common.js to determine if a page is a disambiguation page or not.)
setindex = Means that this template sets the CSS id "setindexbox". Which does not trigger the {{disambig editintro}} when editing a page.

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:
image = [[Image:Schooner.svg|30px]]
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:
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.2em;

textstyle

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

text

The message body text. This message box has italic text as default, thus no need to manually set that.

Technical details

This template currently uses hard coded styles and class names. Later it will only use CSS classes making it easier to skin. (In the meantime it can be skinned by using the "!important" keyword.)

If you need to use special characters in the text parameter then you need to escape them like this:

{{dmbox
| 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>
}}

Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.

See also


Test examples

Some text.

Some text.

Some text.

Some text.

Some text.

Some text.