Difference between revisions of "Template:Dmbox/doc"

From Ouroboros Portal
Jump to: navigation, search
(copied from wikipedia with lots of modifications)
 
m
Line 102: Line 102:
 
<includeonly>
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
+
[[Category:Disambiguation templates|{{PAGENAME}}]]
  
 
</includeonly>
 
</includeonly>

Revision as of 06:57, 5 March 2009


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

It is used to build disambiguation boxes, such as {{disambig}}.

Usage

Simple usage example:

{{dmbox | text = Some text.}}

Additional examples:

Parameters

List of all parameters:

{{dmbox
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS values
| textstyle = CSS values
| text  = The message body text. 
}}

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:PWiki Logo NoText.png|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:PWiki Logo NoText.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

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.

For more technical details see the talk page. Since this template works almost exactly like {{ambox}}, {{tmbox}}, {{imbox}}, {{cmbox}} and {{ombox}} their talk pages and related pages might also contain more details.

See also

  • {{disambig}} – The generic disambiguation message box.