Template:Dmbox/doc

From FORwiki

Revision as of 21:28, 9 October 2009 (view source) Admin (Talk | contribs) ← Older edit		Revision as of 21:34, 9 October 2009 (view source) Admin (Talk | contribs) (→Usage) Newer edit →
Line 57:		Line 57:
	| imageright = [[Image:Schooner.svg|33px]]		| imageright = [[Image:Schooner.svg|33px]]
	| text  =		| text  =
-	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.	+	This article includes a list of ships with the same or similar names.
	}}		}}

---

Revision as of 21:34, 9 October 2009

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

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

Some text.

{{dmbox | type = setindex | text = Some text.}}

Some text.

Complex example:

{{dmbox
| type      = setindex
| image     = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:List gray.svg|30px]] }}
| textstyle = color: red; font-weight: bold; font-style: normal;
| text      = The message body text.
}}

The message body text.

Some other parameter combinations:

No type and no image given (default)

No type and image=none – No image is used and the text uses the whole message box area.

type = setindex imageright = [[Image:Schooner.svg|33px]]

This article includes a list of ships with the same or similar names.

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 = Makes it so the {{disambig editintro}} is displayed when editing a page with this template on. (Means that this template internally sets the CSS id "disambig". The id is used by the javascript in MediaWiki:Common.js to determine if a page is a disambiguation page or not.) And adds Category:All disambiguation pages and Category:All article disambiguation pages.

setindex = Does not trigger the {{disambig editintro}} when editing a page. (Because this instead sets the CSS id "setindexbox".) And adds Category:All set index articles.

category

Don't use this parameter, it is currently broken. I will fix that. --David Göthberg (talk) 21:42, 4 March 2009 (UTC)

image

No parameter = If no image parameter is given, the template uses the default disambig or setindex image, depending on the type parameter.

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.