Template:Stub
| This page is a stub. You can help Miraheze Developers Wiki by expanding it. |
- Description
- This template is used to identify a stub (an incomplete page). Any pages using this template will be automatically placed in the Stubs category.
Usage
This is the stub 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
{{stub
| 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
{{stub
| 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.
lowercase
If set to "y", this will indicate that the stub template's name should begin with a lowercase letter.
name
The full page name of the template itself.
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.
TemplateData
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 name | 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. | Unknown | optional |
| Secondary stub category | category1 | A secondary category into which this stub template puts pages. | Page name | optional |
| Tertiary stub category | category2 | A tertiary category into which this stub template puts pages. | Page name | optional |
| Stub category sort prefix | tempsort | If set to a value other than 'no', a prefix for sorting pages in the category. | Unknown | 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 | 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 | optional |