Template:Asbox/doc

2009-02-13T05:34:29Z

Pegship: sp, punc

<includeonly>{{pp-template|small=yes}}</includeonly>
{{documentation subpage}}

This is the '''asbox''' or '''article stub box''' meta template.

It is used to create (but preferably '''not''' without consulting [[WP:WSS]]) or standardise existing ''article stub box'' templates.

This is a standard template for creating standard stub templates. It supports most, if not all, stub template styles in place prior to 26 September 2007.

=== Usage ===
<pre><nowiki>
{{ asbox
| {{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}
| image = Ambox style.png
| pix =
| subject =
| qualifier =
| category =
| tempsort =
| category1 =
| tempsort1 =
| note =
}}
</nowiki></pre>

===Parameters===
====Default parameters 1-4====
The standard implementation passes four default parameters through to this template to allow for future expansion.

====<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. 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>pix</code>====
The size of the image, only ''required'' if <code>image</code> is set and its size is not 40x30. [[Defensive programming]] suggests setting the value of <code>pix</code> even if it is 40x30.

====<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. Note the template will only include articles in the stub category, unless the parameter [[#tempsort|<code>tempsort</code> ]] is set, in which case templates (in particular the stub template itself) will also be included - sorted with the value of " " (space) followed by <code>tempsort</code>.

====<code>tempsort</code>====
If exists the template will be put in its own category sorted as " " (space) followed by <code>tempsort</code>.

====<code>category1</code>====
An optional second stub category the articles should go in. Note the template will only include articles in the stub category, unless the parameter [[#tempsort|<code>tempsort1</code> ]] is set, in which case templates (in particular the stub template itself) will also be included - sorted with the value of " " (space) followed by <code>tempsort1</code>.

====<code>tempsort1</code>====
If exists the template will be put in its own second category sorted as " " (space) followed by <code>tempsort1</code>.

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

===Examples===
====Using <code>image</code>====
<pre><nowiki>
{{Asbox |{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}| image = Ostfold_vapen.png
| pix = 30
| subject = [[Østfold]] location
| qualifier =
| category = Østfold geography stubs
}}
</nowiki></pre>

Appears as:

{{Asbox |{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}| image = Ostfold_vapen.png
| pix = 30
| subject = [[Østfold]] location
| qualifier =
| category = <noinclude>Template documentation</noinclude>
}}

Based on {{tl|Østfold-geo-stub}}
:''(<code>category</code> has been over-ridden to keep this page out of the stub category)''

====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. As of January 24, 2007, the new parser requires the <code>{{</code> and <code>}}</code> around the used template, and a single <code>|</code> is used instead of <code><nowiki>{{!}}</nowiki></code> to separate the parameters. Old code relying on <code><nowiki>{{!}}</nowiki></code> will need to be updated:

<pre><nowiki>
{{Asbox |{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}
| icon = {{Soccer icon|Wales|50}}
| subject = [[biography|biographical]]
| qualifier = related to Welsh [[football (soccer)]]
| category = Welsh football biography stubs
| category1 = Welsh people stubs
| tempsort =
}}
</nowiki></pre>

Appears as:

{{Asbox |{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}
| icon = {{Soccer icon|Wales|50}}
| subject = [[biography|biographical]]
| qualifier = related to Welsh [[football (soccer)]]
| category = Template documentation
}}

Based on {{tl|Wales-footy-bio-stub}}
:''(<code>category</code> and <code>category1</code> have been over-ridden to keep this page out of the stub categories)''

==Whatlinkshere==
The page [http://en.wikipedia.org/w/index.php?title=Special:Whatlinkshere/Template:Asbox/whatlinkshere&limit=5000&from=0 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.'''

== See also ==
* [[Template talk:Asbox]]
* [[Wikipedia talk:WikiProject Stub sorting/Archive11#Stub template standardisation]]
* {{tl|Ambox}}
* {{tl|MetaPicstub}}

<includeonly>

[[Category:Wikipedia metatemplates|{{PAGENAME}}]]


[[dsb:Pśedłoga:ZarodkowyTyp]]
[[hsb:Předłoha:Zarodk po předmjeće]]
[[ru:Шаблон:Stub-meta]]
[[sv:Mall:Stubbmall]]
</includeonly>

The Broken Dagger Wiki - User contributions [en]

Template:Asbox/doc