Difference between revisions of "Template:Asbox/doc"

Latest revision as of 10:27, 13 July 2014

This is the asbox or article stub box meta template. It is the standard template used for creating new or updating existing article stub box templates. It supports most, if not all, stub template styles.

Basic usage

{{asbox
| image     = just the name of the image, e.g. Image.png - will be sized at 40x30px
| subject   = given before "article", e.g. "this *biographical* article is a stub"
| qualifier = given after "article" e.g. "this article *about a musician* is a stub"
| category  = just the name of the category to place tagged pages in, e.g. History stubs
| name      = the full name of the stub template itself, used to reference itself internally
}}

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

Full usage

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

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.

category2

An optional third stub category the articles should go in.

tempsort2

If exists the stub template (and any other templates) will be put in its own category sorted as " " (space) followed by tempsort2, otherwise it will be sorted with the value of " " (space) followed by the template name.

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.

Examples

Using image

Based on {{Østfold-geo-stub}}:

{{Asbox
 | image     = Østfold_våpen.svg
 | pix       = 30
 | subject   = [[Østfold]] location
 | category  = Østfold geography stubs
 | tempsort  = *
 | name      = Template:Østfold-geo-stub
}}

appears as:

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

appears as:

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

allowing a user to specify with css that three links regarding the stub template are shown (see [1]). A side effect is that a non-existing talk page of the stub template may show up on Special:WantedPages.

TemplateData

<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."
		},
		"category1": {
			"label": "Secondary stub category",
			"type": "wiki-page-name",
			"description": "A secondary category into which this stub template puts pages."
		},
		"category2": {
			"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."
		},
		"tempsort1": {
			"label": "Secondary stub category sort prefix",
			"description": "If set to a value other than 'no', a prefix for sorting pages in the secondary category."
		},
		"tempsort2": {
			"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 meta-templates in the Module:Message box family:

• {{ambox}} – For article message boxes.
• {{cmbox}} – For category message boxes.
• {{imbox}} – For file (image) page message boxes.
• {{fmbox}} – For header and footer message boxes.
• {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.
• {{ombox}} – For other pages message boxes.
• {{tmbox}} – For talk page message boxes.

Closely related meta-templates:

• {{asbox}} – For article stub message boxes.
• {{dmbox}} – For disambiguation and set index message boxes.
• {{ivmbox}} – A simplistic, full-width box intended to surround important messages or notices, with an ivory background by default.