Template:Asbox

For a documentation template you can use on your wiki, see Template:Documentation (copy) on Templates Wiki.

Template information, documentation, and installation instructions.
Expand the below text for usage and other information.

---

Template Documentation:

Note: The template above might be broken without the parameters; this is normal.
View, edit, or check the history of this documentation. (How does this work?)
Editors can experiment with this template's sandbox and testcases.

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 Asbox ([A]rticle [s]tub [box]) metatemplate. It is the standard template used for creating new or updating existing article stub box templates. It supports virtually all stub template styles.

Usage

{{Asbox
| image =
| subject =
| qualifier =
| category =
| name =
}}

image

Filename only and no prefix, e.g. "image.png" (without quotemarks). Image will be sized at 40x30px.

subject

Placed before the word "article" in the template (e.g. "biographical", producing "This biographical article is (...)").

qualifier

Placed after the word "article" (e.g. "about a musician", producing "(...) article about a musician is (...)").

category

Name only of category to which pages where this template used are added (e.g. "History stubs").

name

Full name of the stub template itself (used for internal reference).

This simple usage should suffice for most stub templates. Additional parameters are described below for advanced use.

Full syntax

{{Asbox
	| image = Ambox style.png
	| pix = 
	| subject = 
	| article = 
	| qualifier = 
	| category = 
	| tempsort = 
	| category1 = 
	| tempsort1 = 
	| note = 
	| name = {{subst:FULLPAGENAME}}
}}

Parameters

icon or image

If the image is called with an icon template, icon is set to the full syntax of the template; that's the name of the template, plus any arguments (separated with | ), including the {{ and }} around it. Icon can also be used to provide the full image markup (include the opening and closing square brackets), if special image settings such as "border" are to be used. If the image is called explicitly image is the name of the image :- pix will likely be required as well, the default value for pix is 40x30.

imagealt may be used to override the default alt text which is set to "Stub icon".

pix

The size of the image in pixels (no need to append px). Only required if image is used and this image requires a size different from the default maximum of 40x30 pixels. (Note that in the interests of standardising the formats of stub messages, images of size 40x30 are much preferred.)

subject and qualifier

This subject article qualifier is a stub ...

Examples:

• This geography article about a place in Rohan is a stub ...
• This elementary physics article is a stub ...
• This article about Rudolph the Red-nosed reindeer is a stub ...

Other parameters

Parameter	Description
category	The stub category the articles should go in.
tempsort	If exists the stub template [?] (and any other templates) will be put in its own category sorted as " " (space) followed by tempsort, otherwise it will be sorted with the value of " " (space) followed by the template name.
category1	An optional second stub category the articles should go in.
tempsort1	If exists the stub template [?] (and any other templates) will be put in its own category sorted as " " (space) followed by tempsort1, otherwise it will be sorted with the value of " " (space) followed by the template name.
category#	New (Jan 2015): Since the release of Asbox's module, this template now supports an unlimited number of categories. Just replace '#' with a number, e.g. |category2=Normal stubs, |category99=Over-categorized stubs, etc. Traditionally, category2 was the max, so please only use more than 3 if the additional categories are unique, i.e. not sub or parent categories of the others.
tempsort#	New (Jan 2015): Similar to the category params, you can have any number of tempsort params.
note	If exists the value [?] will be added, as a "small" note, to the stub template.
name	The full page name of the template itself.
demo	Has no effect in article space. Prevents category output. Set to anything to enable. (Even 'no' or 'false' will enable it!) New (Jan 2015): If demo is set, it will show pseudo-categories. If |demo=art then the pseudo-cats shown will only be those visible in article space (i.e. no error/hidden cats). Set |demo=doc to preview the documentation page as well (and all cats). See: Template:Asbox/testcases

Examples

Using image

Based on {{Akershus-geo-stub}}:

{{asbox
| image     = Akershus våpen.svg
| pix       = 30
| subject   = [[Akershus]] location 
| qualifier = 
| category  = Akershus geography stubs
| tempsort  = 
| name      = Template:Akershus-geo-stub
}}

produces:

Using icon and category1

Using icon allows more flexibility in some circumstances than image and pix, since it can be used with templates. Based on {{Wales-footy-bio-stub}}:

{{Asbox
| icon = {{soccer icon|Wales|50}}
| subject = biographical
| qualifier = related to Welsh association football 
| category = Welsh football biography stubs
| tempsort = * 
| name = Template:Wales-footy-bio-stub
}}

produces:

WhatLinksHere

The page here should have a complete list of all templates using this template. This list can be compared with existing list of stub templates to identify new stub templates created out of process. The last entries will also be the most recently created items.

Navbar

This template contains...

{{Navbar |{{{name}}} |mini=yes |style=position:absolute;right:15px;font-size:smaller;display:none;}}

...which allows the specification (with CSS) of the three stub-template links provided (see discussion). A side effect is that a non-existing talk page of the stub template may appear on Special:WantedPages.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Asbox in articles based on its TemplateData.

TemplateData for Asbox

<templatedata> { "description": "Standard template used for creating new or updating existing article stub box templates.", "params": { "category": { "label": "Stub category", "type": "wiki-page-name", "description": "The category into which this stub template puts pages.", "required": true }, "subject": { "label": "Subject", "description": "The subject of the stub template's category.", "suggested": true }, "qualifier": { "label": "Qualifier", "description": "The sub-subject of the stub template's category." }, "image": { "label": "Icon image", "type": "wiki-file-name", "description": "Image to use as an icon in the template.", "suggested": true }, "imagealt": { "label": "Icon at text", "description": "Alt text for the icon, especially for screen readers.", "default": "Stub icon", "suggested": true }, "pix": { "label": "Icon size", "description": "Size at which to display the icon." }, "icon": { "label": "Icon", "description": "Icon to show in the template.", "suggested": true }, "article": { "label": "Page name", "description": "Different term instead of 'article' to use in the template." }, "note": { "label": "Note", "description": "A small note about the stub shown underneath the main text." }, "name": { "label": "Template name", "description": "The name of the template.", "type": "string", "autovalue": "{{subst:FULLPAGENAME}}" }, "category1": { "label": "Secondary stub category", "type": "wiki-page-name", "description": "A secondary category into which this stub template puts pages." }, "category#": { "label": "Tertiary stub category", "type": "wiki-page-name", "description": "A tertiary category into which this stub template puts pages." }, "tempsort": { "label": "Stub category sort prefix", "description": "If set to a value other than 'no', a prefix for sorting pages in the category." }, "tempsort#": { "label": "Tertiary stub category sort prefix", "description": "If set to a value other than 'no', a prefix for sorting pages in the tertiary category." } } } </templatedata>

See also

• Wikipedia talk:WikiProject Stub sorting/Archive11#Stub template standardisation

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.
  

---

Installation Instructions

Export this template, then import to install it.
Use edit summary: Copied from [[w:c:templates:Template:Asbox]] to properly attribute this template's editors.

There is no additional installation instructions for this template. If there is any, you may create it at Template:Asbox/install.