Message box
meta-templates
templatecontext
{{Rmbox}}resource
{{Cmbox}}category
{{Imbox}}image
{{Tmbox}}talk
{{Fmbox}}footer / header
{{Ombox}}other pages
{{Mbox}}auto-detect
{{Rsbox}}resource stub
{{Dmbox}}disambiguation

This is the Rsbox ([R]esource [s]tub [box]) metatemplate (redirected to {{Asbox}} for ease of interwiki integration). It is the standard template used for creating new or updating existing resource stub box templates. It supports virtually all stub template styles.

Usage

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

image

edit

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

subject

edit

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

qualifier

edit

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

category

edit

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

name

edit

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

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

Parameters

edit

icon or image

edit

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

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

edit

This subject resource qualifier is a stub ...

Examples:

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

Other parameters

edit
Parameter Description
category The stub category the resources 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 resources 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 resource 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 resource 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

edit

Using image

edit

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

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

produces:


Using icon and category1

edit

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

edit

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.

edit

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

edit
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Asbox

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

Template parameters

ParameterDescriptionTypeStatus
Stub categorycategory

The category into which this stub template puts pages.

Page namerequired
Subjectsubject

The subject of the stub template's category.

Unknownsuggested
Qualifierqualifier

The sub-subject of the stub template's category.

Unknownoptional
Icon imageimage

Image to use as an icon in the template.

Filesuggested
Icon at textimagealt

Alt text for the icon, especially for screen readers.

Default
Stub icon
Unknownsuggested
Icon sizepix

Size at which to display the icon.

Unknownoptional
Iconicon

Icon to show in the template.

Unknownsuggested
Page nameresource

Different term instead of 'resource' to use in the template.

Unknownoptional
Notenote

A small note about the stub shown underneath the main text.

Unknownoptional
Template namename

The name of the template.

Auto value
{{subst:FULLPAGENAME}}
Stringoptional
Tertiary stub categorycategory1

A tertiary category into which this stub template puts pages.

Page nameoptional
Stub category sort prefixtempsort

If set to a value other than 'no', a prefix for sorting pages in the category.

Unknownoptional
Tertiary stub category sort prefixtempsort1

If set to a value other than 'no', a prefix for sorting pages in the tertiary category.

Unknownoptional
Prevent category outputdemo

Has no effect in resource 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 resource space (i.e. no error/hidden cats). Set to 'doc' to preview the documentation page as well (and all cats)

Stringoptional

See also

edit

There are several meta-templates in the mbox family:

  • {{ambox}} – For article message boxes.
  • {{tmbox}} – For talk page message boxes.
  • {{imbox}} – For file (image) page message boxes.
  • {{cmbox}} – For category message boxes.
  • {{ombox}} – For other pages 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.

Closely related meta-templates:

  • {{fmbox}} – For header and footer message boxes.