Difference between revisions of "Template:Dmbox/doc"
(from wikipedia:Template:Dmbox/doc) |
Dinoguy1000 (talk | contribs) m (1 revision imported: mass import/update of Wikipedia stuff) |
||
(5 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
− | <!-- | + | {{High-risk| 317,000+ }} |
+ | <!-- Categories where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) --> | ||
+ | {{Uses TemplateStyles|Template:Dmbox/styles.css}} | ||
+ | {{Mbox templates (small)}} | ||
− | + | This is the {{tl|Dmbox}} (['''D''']isambiguation footer ['''m''']essage ['''box''']) [[WP:MTM|metatemplate]]. | |
− | This is the {{tl| | ||
− | It is used to build disambiguation and [[Wikipedia: | + | It is used to build [[WP:disambiguation|disambiguation]] and [[Wikipedia:set index article|set index article]] message boxes, such as {{tl|Disambiguation}} and {{tl|Ship index}}. |
− | This template works similarly to {{tl| | + | This template works similarly to {{tl|Ambox}} and mostly uses the same parameters. The main differences are that this box uses the disambiguation style and only has two "type" settings. |
=== Usage === | === Usage === | ||
Line 30: | Line 32: | ||
{{dmbox | {{dmbox | ||
| type = setindex | | type = setindex | ||
− | | image = | + | | image = [[File:Schooner.svg|30px|link=|alt=]] [[File:DAB list gray.svg|30px|alt=Disambiguation icon]] |
− | |||
| text = The message body text. | | text = The message body text. | ||
}} | }} | ||
Line 38: | Line 39: | ||
{{dmbox | {{dmbox | ||
| type = setindex | | type = setindex | ||
− | | image = | + | | image = [[File:Schooner.svg|30px|link=|alt=]] [[File:DAB list gray.svg|30px|alt=Disambiguation icon]] |
− | |||
| text = The message body text. | | text = The message body text. | ||
}} | }} | ||
Line 56: | Line 56: | ||
{{dmbox | {{dmbox | ||
| type = setindex | | type = setindex | ||
− | | imageright = [[ | + | | imageright = [[File:Schooner.svg|33px|link=|alt=]] |
− | | text = type = setindex <br> imageright = <nowiki>[[ | + | | text = type = setindex <br> imageright = <nowiki>[[File:Schooner.svg|33px|link=|alt=]]</nowiki> |
}} | }} | ||
{{dmbox | {{dmbox | ||
| type = setindex | | type = setindex | ||
− | | imageright = [[ | + | | imageright = [[File:Schooner.svg|33px|link=|alt=]] |
| 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 [[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. | ||
Line 70: | Line 70: | ||
List of all parameters: | List of all parameters: | ||
− | < | + | <syntaxhighlight lang="moin"> |
{{dmbox | {{dmbox | ||
| type = disambig / setindex | | type = disambig / setindex | ||
− | | image = none / [[ | + | | image = none / [[File:Some image.svg|40px|link=|alt=]] |
− | | imageright = [[ | + | | imageright = [[File:Some image.svg|40px|link=|alt=]] |
− | | | ||
− | | | ||
| text = The message body text. | | text = The message body text. | ||
| nocat = {{{nocat|}}} / true | | nocat = {{{nocat|}}} / true | ||
}} | }} | ||
− | </ | + | </syntaxhighlight> |
− | + | {{Para|type}} | |
− | :If no | + | :If no {{Para|type}} parameter is given the template defaults to type {{code|disambig}}. |
− | : | + | :{{code|disambig}} = Makes it so the {{tl|disambig editintro}} is displayed when editing a page with this template on. (Means that this template internally sets the CSS id "disambigbox". 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]]. |
− | : | + | :{{code|setindex}} = Does ''not'' trigger the {{tl|disambig editintro}} when editing a page. (Because this instead sets the CSS id "setindexbox".) And adds [[:Category:All set index articles]]. |
− | + | {{Para|nocat}} | |
− | : | + | :{{code|true}} = [[Wikipedia:Category suppression|Stops this template from categorizing]]. Useful for tests and demonstrations. Dmbox templates should forward{{when defined as}} {{para|nocat}}, so they too have the option to suppress categories. Thus, it is recommended that Dmbox templates always add something similar to this: |
::<code><nowiki>nocat = {{{nocat|}}}</nowiki></code> | ::<code><nowiki>nocat = {{{nocat|}}}</nowiki></code> | ||
− | + | {{Para|image}} | |
− | :'' | + | :''<span style="color:gray">[No parameter]</span>'' = If no {{Para|image}} parameter is given, the template uses the default {{para|disambig}} or {{para|setindex}} image, depending on the {{Para|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. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example: |
− | ::<code><nowiki>image = [[ | + | ::<code><nowiki>image = [[File:Schooner.svg|30px|link=|alt=]]</nowiki></code> |
− | : | + | :<code>none</code> = Means that no image is used. |
− | + | {{Para|imageright}} | |
− | :'''No parameter''' = If no | + | :'''No parameter''' = If no {{Para|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. ( | + | :'''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. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example: |
− | ::<code><nowiki>imageright = [[ | + | ::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px|alt=Books icon]]</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. | ||
− | + | {{Para|text}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
:The message body text. This message box has ''italic'' text as default, thus no need to manually set that. | :The message body text. This message box has ''italic'' text as default, thus no need to manually set that. | ||
=== 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: | ||
− | < | + | <syntaxhighlight lang="tid"> |
{{dmbox | {{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. | ||
− | But here is a pipe {{!}} and two end braces | + | But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. |
− | And now a pipe and end braces | + | And now a pipe and end braces <nowiki>|}}</nowiki>. |
</div> | </div> | ||
}} | }} | ||
− | </ | + | </syntaxhighlight> |
− | |||
{{dmbox | {{dmbox | ||
| text = <div> | | text = <div> | ||
Line 137: | Line 124: | ||
</div> | </div> | ||
}} | }} | ||
− | |||
− | |||
− | |||
− | |||
For more technical details see the [[Template talk:Dmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details. | For more technical details see the [[Template talk:Dmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details. | ||
− | === See also === | + | ===See also=== |
{{Mbox templates see also}} | {{Mbox templates see also}} | ||
Other pages: | Other pages: | ||
− | + | * [[Wikipedia:Disambiguation]], which includes a section explaining [[Wikipedia:Disambiguation#Set index articles|set index articles]]. | |
− | * [[Wikipedia:Disambiguation]] | ||
* [[Wikipedia:WikiProject Disambiguation]] | * [[Wikipedia:WikiProject Disambiguation]] | ||
− | + | * {{tl|Disambiguation}}, the generic disambiguation message box. | |
− | + | * {{tl|Set index article}}, the generic set index article message box. | |
− | * {{tl|Disambiguation}} | ||
− | * {{tl|Set index article}} | ||
− | <includeonly>{{ | + | <includeonly>{{Sandbox other| |
− | <!-- | + | | <!-- Categories below this line, please; interwikis at Wikidata --> |
− | |||
[[Category:Disambiguation message boxes| ]] | [[Category:Disambiguation message boxes| ]] | ||
[[Category:Set index article templates| ]] | [[Category:Set index article templates| ]] | ||
+ | [[Category:Mbox and messagebox templates]] | ||
}}</includeonly> | }}</includeonly> |
Latest revision as of 23:45, 1 April 2023
This is a documentation subpage for Template:Dmbox. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on 454,000+ pages, or roughly 50% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.
Message box meta-templates | |
---|---|
template | context |
{{Ambox}} | article |
{{Cmbox}} | category |
{{Imbox}} | image |
{{Tmbox}} | talk |
{{Fmbox}} | footer / header |
{{Ombox}} | other pages |
{{Mbox}} | auto-detect |
{{Asbox}} | article stub |
{{Dmbox}} | disambiguation |
This is the {{Dmbox}} ([D]isambiguation footer [m]essage [box]) metatemplate.
It is used to build disambiguation and set index article message boxes, such as {{Disambiguation}} and {{Ship index}}.
This template works similarly to {{Ambox}} and mostly uses the same parameters. The main differences are that this box uses the disambiguation style and only has two "type" settings.
Contents
Usage[edit]
Simple usage example:
{{dmbox | text = Some text.}}
{{dmbox | type = setindex | text = Some text.}}
Complex example:
{{dmbox | type = setindex | image = [[File:Schooner.svg|30px|link=|alt=]] [[File:DAB list gray.svg|30px|alt=Disambiguation icon]] | text = The message body text. }}
Some other parameter combinations:
Parameters[edit]
List of all parameters:
{{dmbox
| type = disambig / setindex
| image = none / [[File:Some image.svg|40px|link=|alt=]]
| imageright = [[File:Some image.svg|40px|link=|alt=]]
| text = The message body text.
| nocat = {{{nocat|}}} / true
}}
|type=
- If no
|type=
parameter is given the template defaults to typedisambig
. 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 "disambigbox". 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.
|nocat=
true
= Stops this template from categorizing. Useful for tests and demonstrations. Dmbox templates should forward[when defined as?]|nocat=
, so they too have the option to suppress categories. Thus, it is recommended that Dmbox templates always add something similar to this:nocat = {{{nocat|}}}
|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. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example:
image = [[File:Schooner.svg|30px|link=|alt=]]
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. (Keep the width small; images in this template do not automatically shrink on mobile devices.) For example:
imageright = [[File:Nuvola apps bookcase.png|40px|alt=Books icon]]
- Anything = Any other object that you want to show on the right side.
|text=
- The message body text. This message box has italic text as default, thus no need to manually set that.
Technical details[edit]
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>
}}
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[edit]
- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Asbox}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
Other pages:
- Wikipedia:Disambiguation, which includes a section explaining set index articles.
- Wikipedia:WikiProject Disambiguation
- {{Disambiguation}}, the generic disambiguation message box.
- {{Set index article}}, the generic set index article message box.