మూస:Asbox/doc
This is a documentation subpage for మూస:Asbox. It may contain usage information, categories and other content that is not part of the original మూస page. |
Message box meta-templates |
---|
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
[మార్చు]{{asbox | 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
[మార్చు]{{asbox | 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.
name
[మార్చు]The full page name of the template itself.
Examples
[మార్చు]Using image
[మార్చు]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 }}
appears as:
Demo categories: Category:Østfold geography stubs | Category:Østfold geography stubs| * | Category:Stub message templates needing attention|NAsbox/doc | Category:Stub message templates
Using icon
and category1
[మార్చు]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 }}
appears as:
Demo categories: Category:Welsh football biography stubs | Category:Welsh football biography stubs| * | Category:Stub message templates needing attention|NAsbox/doc | Category:Stub message templates | Category:Stub message templates using icon parameter
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.
Navbar
[మార్చు]This template contains:
{{navbar|{{{name}}}|mini=yes|style=position:absolute; right:15px; font-size:smaller; display:none;}}
allowing a user to specify with css that three links regarding the stub template are shown (see [1]). A side effect is that a non-existing talk page of the stub template may show up on Special:WantedPages.
See also
[మార్చు]There are several meta-templates in the mbox family:
- {{ambox}} – For article message boxes.
- {{cmbox}} – For category message boxes.
- {{imbox}} – For file (image) page message boxes.
- {{mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.
- {{ombox}} – For other pages message boxes.
- {{tmbox}} – For talk page message boxes.
Closely related meta-templates: