Difference between revisions of "Template:Dmbox/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(update)
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(33 intermediate revisions by 24 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{high-risk| 170,000+ }}
+
{{High-risk| 317,000+ }}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- 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)}}
  
{{mbox templates}}
+
This is the {{tl|Dmbox}} (['''D''']isambiguation footer ['''m''']essage ['''box''']) metatemplate.
This is the {{tl|dmbox}} or '''disambiguation footer 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 [[WP:disambiguation|disambiguation]] and [[Wikipedia:set index article|set index article]] message boxes, such as {{tl|Disambiguation}} and {{tl|Shipindex}}.  
  
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.
+
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 ===
 
 
Simple usage example:
 
Simple usage example:
  
Line 25: Line 25:
  
 
{{dmbox | type = setindex | text = Some text.}}
 
{{dmbox | type = setindex | text = Some text.}}
 +
  
 
Complex example:
 
Complex example:
Line 31: Line 32:
 
{{dmbox
 
{{dmbox
 
| type      = setindex
 
| type      = setindex
| image    = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:List gray.svg|30px]] }}
+
| image    = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:DAB list gray.svg|30px]] }}
| textstyle = color: red; font-weight: bold; font-style: normal;
+
| textstyle=color: red; font-weight: bold; font-style: normal;
 
| text      = The message body text.
 
| text      = The message body text.
 
}}
 
}}
Line 39: Line 40:
 
{{dmbox
 
{{dmbox
 
| type      = setindex
 
| type      = setindex
| image    = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:List gray.svg|30px]] }}
+
| image    = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:DAB list gray.svg|30px]] }}
| textstyle = color: red; font-weight: bold; font-style: normal;
+
| textstyle=color: red; font-weight: bold; font-style: normal;
 
| text      = The message body text.
 
| text      = The message body text.
 
}}
 
}}
 +
  
 
Some other parameter combinations:
 
Some other parameter combinations:
Line 68: Line 70:
  
 
=== Parameters ===
 
=== Parameters ===
 
 
List of all parameters:
 
List of all parameters:
  
Line 76: Line 77:
 
| image = none / [[Image:Some image.svg|40px]]
 
| image = none / [[Image:Some image.svg|40px]]
 
| imageright = [[Image:Some image.svg|40px]]
 
| imageright = [[Image:Some image.svg|40px]]
| style = CSS values
+
| style=CSS values
| textstyle = CSS values
+
| textstyle=CSS values
 
| text  = The message body text.  
 
| text  = The message body text.  
 +
| nocat = {{{nocat|}}} / true
 
}}
 
}}
 
</pre>
 
</pre>
  
'''type'''
+
{{Para|type}}
:If no '''type''' parameter is given the template defaults to type '''disambig'''.  
+
:If no {{Para|type}} parameter is given the template defaults to type {{code|disambig}}.
:'''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 "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]].
+
:{{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]].
  
:'''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]].
+
:{{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]].
  
<s>'''category'''</s>
+
{{Para|nocat}}
:''Don't use this parameter, it is currently broken. I will fix that. --[[User:Davidgothberg|David Göthberg]] ([[User talk:Davidgothberg|talk]]) 21:42, 4 March 2009 (UTC)''
+
:{{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>
  
'''image'''
+
{{Para|image}}
:'''No parameter''' = If no '''image''' parameter is given, the template uses the default disambig or setindex image, depending on the '''type''' parameter.
+
:''<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. (But the message box can handle images of any size.) For example:  
+
:''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>
 
::<code><nowiki>image = [[Image:Schooner.svg|30px]]</nowiki></code>
:'''none''' = Means that no image is used.
+
:<code>none</code> = Means that no image is used.
  
'''imageright'''
+
{{Para|imageright}}
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
+
:'''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. (But the message box can handle images of any size.) For example:  
+
:'''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>
 
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</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.
  
'''style'''
+
{{Para|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:
 
: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>
+
::<code>style=margin-bottom: 0.2em;</code>
  
'''textstyle'''
+
{{Para|textstyle}}
 
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
 
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>
+
::<code>textstyle=text-align: center;</code>
  
'''text'''
+
{{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 ===
 
 
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 "<code>!important</code>" keyword.)
 
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 "<code>!important</code>" keyword.)
  
Line 138: Line 140:
 
}}
 
}}
  
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 [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.  
+
 
 +
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 [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.  
  
 
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]] – Also has a section explaining [[Wikipedia:Disambiguation#Set index articles|set index articles]].
 
 
* [[Wikipedia:WikiProject Disambiguation]]
 
* [[Wikipedia:WikiProject Disambiguation]]
* [[MediaWiki:Disambiguationspage]] – Should list all disambiguation message boxes, so that some automatic tools can know what pages are disambiguation pages. Now also has a separate list with all set index message boxes, so some tools can know what pages are set index articles.
+
* [[MediaWiki:Disambiguationspage]], where all disambiguation message boxes should be listed to assist automatic tools' identification of disambiguation pages. Now also has a separate list with all set index message boxes, so some tools can know what pages are set index articles.
 
+
* {{tl|Disambiguation}}, the generic disambiguation message box.
* {{tl|disambig}} – The generic disambiguation message box.
+
* {{tl|Set index article}}, the generic set index article message box.
* {{tl|SIA}} – The generic set index article message box.
 
  
<includeonly>
+
<includeonly>{{Sandbox other|
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
+
[[Category:Disambiguation message boxes| ]]
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
+
[[Category:Set index article templates| ]]
[[pt:Predefinição:Dmbox]]
+
[[Category:Mbox and messagebox templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 23:55, 24 April 2020

Script error: No such module "Uses TemplateStyles".

Message box
meta-templates
templatecontext
{{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 {{Shipindex}}.

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.

Usage

Simple usage example:

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


Complex example:

{{dmbox
| type      = setindex
| image     = {{nowrap| [[Image:Schooner.svg|30px]] [[Image:DAB list 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. 
| nocat = {{{nocat|}}} / true
}}

|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 "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 forwardTemplate: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. (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.

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

There are seven metatemplates in the Module:Message box family:
  • {{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.

Templates intended to be used in conjunction with Mboxes:

Other pages: