Template:Asbox/sandbox

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]
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.

Basic 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 "article" in the template (e.g. "biographical", producing "This biographical article is (...)").

qualifier[edit]

Placed after the word "article" (e.g. "about a musician", producing "(...) article 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 = 
| article = 
| 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".

pix[edit]

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 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[edit]

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.
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[edit]

Using image[edit]

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

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.

Navbar[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 [1]). A side effect is that a non-existing talk page of the stub template may appear on Special:WantedPages.

TemplateData[edit]

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

Template parameters
Parameter Description Type Default Auto value Status
Stub category category The category into which this stub template puts pages. wiki-page-name empty empty required
Subject subject The subject of the stub template's category. unknown empty empty suggested
Qualifier qualifier The sub-subject of the stub template's category. unknown empty empty optional
Icon image image Image to use as an icon in the template. wiki-file-name empty empty suggested
Icon at text imagealt Alt text for the icon, especially for screen readers. unknown Stub icon empty suggested
Icon size pix Size at which to display the icon. unknown empty empty optional
Icon icon Icon to show in the template. unknown empty empty suggested
Page name article Different term instead of 'article' to use in the template. unknown empty empty optional
Note note A small note about the stub shown underneath the main text. unknown empty empty optional
Template name name The name of the template. unknown empty empty optional
Secondary stub category category1 A secondary category into which this stub template puts pages. wiki-page-name empty empty optional
Tertiary stub category category2 A tertiary category into which this stub template puts pages. wiki-page-name empty empty optional
Stub category sort prefix tempsort If set to a value other than 'no', a prefix for sorting pages in the category. unknown empty empty optional
Secondary stub category sort prefix tempsort1 If set to a value other than 'no', a prefix for sorting pages in the secondary category. unknown empty empty optional
Tertiary stub category sort prefix tempsort2 If set to a value other than 'no', a prefix for sorting pages in the tertiary category. unknown empty empty optional

See also[edit]

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.