View source for Template:Asbox/doc

{{documentation subpage}}
<includeonly>{{high-risk|1,700,000+}}</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Mbox 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 ===
<pre>
{{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
}}</pre>

This simple usage should suffice for a great many stub templates. Additional parameters are described below for advanced use.

=== Full usage ===
<pre>
{{asbox
| image     = Ambox style.png
| pix       = 
| subject   = 
| article   = 
| qualifier = 
| category  = 
| tempsort  = 
| category1 = 
| tempsort1 = 
| note      = 
| name      = {{subst:FULLPAGENAME}}
}}</pre>

===Parameters===
====<code>icon</code> or <code>image</code>====
If the image is called with an icon template, <code>icon</code> is set to the full syntax of the template; that's the name of the template, plus any arguments (separated with '''|''' ), including the <code>{{</code> and <code>}}</code> 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 <code>image</code> is the name of the image :- <code>pix</code> will likely be required as well, the default value for <code>pix</code> is 40x30.

<code>imagealt</code> may be used to override the default alt text which is set to "Stub icon".

====<code>pix</code>====
The size of the image in pixels (no need to append px). Only ''required'' if <code>image</code> 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.)

====<code>subject</code> and <code>qualifier</code>====
This <code>subject</code> article <code>qualifier</code> 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...

====<code>category</code>====
The stub category the articles should go in. 

====<code>tempsort</code>====
If exists the stub template (and any other templates) will be put in its own category sorted as " " (space) followed by <code>tempsort</code>, otherwise it will be sorted with the value of " " (space) followed by the template name.

====<code>category1</code>====
An optional second stub category the articles should go in.

====<code>tempsort1</code>====
If exists the stub template (and any other templates) will be put in its own category sorted as " " (space) followed by <code>tempsort1</code>, otherwise it will be sorted with the value of " " (space) followed by the template name.

====<code>category2</code>====
An optional third stub category the articles should go in.

====<code>tempsort2</code>====
If exists the stub template (and any other templates) will be put in its own category sorted as " " (space) followed by <code>tempsort2</code>, otherwise it will be sorted with the value of " " (space) followed by the template name.

====<code>note</code>====
If exists the value will be added, as a "small" note, to the stub template.

====<code>name</code>====
The full page name of the template itself.

===Examples===
====Using <code>image</code>====
Based on Østfold-geo-stub:
<pre><nowiki>
{{Asbox
 | image     = 
 | pix       = 30
 | subject   = Østfold location
 | category  = Østfold geography stubs
 | tempsort  = *
 | name      = Template:Østfold-geo-stub
}}
</nowiki>
==== Using <code>icon</code> and category1 ====
Using <code>icon</code> allows more flexibility in some circumstances than <code>image</code> and <code>pix</code>, since it can be used with templates. Based on Wales-footy-bio-stub:
<pre><nowiki>
{{asbox
| icon      = 
| subject   = biographical
| qualifier = related to Welsh association football
| category  = Welsh football biography stubs
| tempsort  = * 
}}
</nowiki></pre>

=== Whatlinkshere ===
The page [http://en.wikipedia.org/w/index.php?title=Special:WhatLinksHere/Template:Asbox&hideredirs=1&namespace=10&hidelinks=1 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:
 <nowiki>{{navbar|{{{name}}}|mini=yes|style=position:absolute; right:15px; font-size:smaller; display:none;}}</nowiki>
allowing a user to specify with css that three links regarding the stub template are shown (see [http://en.wikipedia.org/w/index.php?title=Template_talk:Asbox&oldid=313089738#Navbar]). A side effect is that a non-existing talk page of the stub template may show up on [[Special:WantedPages]].

=== See also ===

{{Mbox templates see also}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
[[Category:Stub message boxes| ]]

<!-- PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS. -->
}}</includeonly>