Template:Asbox/doc
This is a documentation subpage for Template:Asbox. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 2,220,000 pages, which is ≈17629% of all pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
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[edit source]
{{Asbox | image = | subject = | qualifier = | category = | name = }}
image[edit source]
Filename only and no prefix, e.g. "Image.png" (without quotemarks). Image will be sized at 40x30px.
subject[edit source]
Placed before the word "article" in the template (e.g. "biographical", producing "This biographical article is (...)").
qualifier[edit source]
Placed after the word "article" (e.g. "about a musician", producing "(...) article about a musician is (...)").
category[edit source]
Name only of category to which pages where this template used are added (e.g. "History stubs").
name[edit source]
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 source]
{{Asbox | image = Ambox style.png | pix = | subject = | article = | qualifier = | category = | tempsort = | category1 = | tempsort1 = | note = | name = {{subst:FULLPAGENAME}} }}
Parameters[edit source]
icon
or image
[edit source]
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 source]
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 source]
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 source]
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[edit source]
Using image
[edit source]
Based on {{Østfold-geo-stub}}:
{{Asbox | image = Østfold_våpen.svg | pix = 30 | subject = [[Østfold]] location | name = Template:Østfold-geo-stub | category = Østfold geography stubs | tempsort = * }}
produces:
This Østfold location article is a stub. You can help Starfleet Logistics by expanding it. |
Using icon
and category1
[edit source]
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:
Template:Soccer icon | This biographical article related to Welsh association football is a stub. You can help Starfleet Logistics by expanding it. |
WhatLinksHere[edit source]
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 source]
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.
See also[edit source]
External links[edit source]
- Template:Asbox/doc at Wikipedia, the free Terran-based encyclopedia that anyone can 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.