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 is the asbox 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[edit]
{{asbox
| image = just the name of the image, e.g. Image.png - will be sized at 40x30px
| subject = given before "page", e.g. "this *help* page is a stub"
| qualifier = given after "page" e.g. "this page *about copyright* is a stub"
| category = just the name of the category to place tagged pages in, e.g. Help page 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[edit]
{{asbox
| image = Ambox style.png
| pix =
| subject =
| page =
| 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 page qualifier is a stub...
Examples:
- This help page about copyright is a stub...
- This process page is a stub...
- This page about gadgets is a stub...
category[edit]
The stub category the pages should go in.
tempsort[edit]
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[edit]
An optional second stub category the pages should go in.
tempsort1[edit]
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[edit]
An optional third stub category the pages should go in.
tempsort2[edit]
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[edit]
If exists the value will be added, as a "small" note, to the stub template.
name[edit]
The full page name of the template itself.
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.