Template:Article stub box/sandbox

Message box
meta-templates
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 template sandbox page for Template:Article stub box (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 2,370,000 pages, or roughly 4% 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.

Shortcut

{{asboxTemplate:Asbox}}

This template uses Lua:

Module:Article stub box (sandbox)

This is the Article stub box metatemplate, also known under the shorter name Asbox. 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 (...)").

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#	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#	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!) 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:

This Akershus ___location article is a stub. You can help Wikipedia by expanding it.

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:

This biographical article related to Welsh association football is a stub. You can help Wikipedia by expanding it.

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.

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:Article stub box in articles based on its TemplateData.

TemplateData for Article stub box

Standard template used for creating new or updating existing article stub box templates.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Stub category	`category`	The category into which this stub template puts pages.	Page name	required
Subject	`subject`	The subject of the stub template's category.	Unknown	suggested
Qualifier	`qualifier`	The sub-subject of the stub template's category.	Unknown	optional
Icon image	`image`	Image to use as an icon in the template.	File	suggested
Icon at text	`imagealt`	Alt text for the icon, especially for screen readers. Default Stub icon	Unknown	suggested
Icon size	`pix`	Size at which to display the icon.	Unknown	optional
Icon	`icon`	Icon to show in the template.	Unknown	suggested
Page name	`article`	Different term instead of 'article' to use in the template.	Unknown	optional
Note	`note`	A small note about the stub shown underneath the main text.	Unknown	optional
Template name	`name`	The name of the template. Auto value `{{subst:FULLPAGENAME}}`	String	optional
Tertiary stub category	`category1`	A tertiary category into which this stub template puts pages.	Page name	optional
Stub category sort prefix	`tempsort`	If set to a value other than 'no', a prefix for sorting pages in the category.	Unknown	optional
Tertiary stub category sort prefix	`tempsort1`	If set to a value other than 'no', a prefix for sorting pages in the tertiary category.	Unknown	optional
Prevent category output	`demo`	Has no effect in article space. Prevents category output. Set to anything to enable. (Even 'no' or 'false' will enable it!) If set, it will show pseudo-categories. If set to 'art' then the pseudo-cats shown will only be those visible in article space (i.e. no error/hidden cats). Set to 'doc' to preview the documentation page as well (and all cats)	String	optional

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