Template:Asbox/doc
Sarna News
- HEXTECH Wave 9 Review - Winding Rivers, Tall Walls, and Underground Tunnels
- Hired Steel and Making MechWarrior 5: Clans Cinematics with Constantin & Bernhard of TMC
- Your BattleTech News Round-Up For December, 2024
- Community Outreach - Caterwauling On CamoSpecs With Matt "00Dawg" Frederiksen
- HEXTECH Wave 8 Review - Autumn Colors, Canyons, And Slums
- Read more →
This is a documentation subpage for Template:Asbox. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses TemplateStyles: |
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 |
{{Ivmbox}} | important messages or notices. |
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.
Contents
Usage[edit]
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.
|
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. |
[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]
TemplateData for Asbox
Standard template used for creating new or updating existing article stub box templates.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Stub category | category | The category into which this stub template puts pages. | Page | 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.
| 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.
| String | optional |
Secondary stub category | category1 | A secondary category into which this stub template puts pages. | Page | optional |
Tertiary stub category | category# | A tertiary category into which this stub template puts pages. | Page | 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 | tempsort# | If set to a value other than 'no', a prefix for sorting pages in the tertiary category. | Unknown | optional |
See also[edit]
- {{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.