Template:Asbox/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Asbox (see that page for the template itself).
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 used to create (but preferably not without consulting WP:WSS) or standardise existing article stub box templates.

Contents

[edit] Usage

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 (UTC).

[edit] Parameters

[edit] Default parameters 1-4

The standard implementation passes four default parameters through to this template to allow for future expansion.

[edit] 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. 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.

[edit] pix

The size of the image, only required if image is set and it's size is not 40x30. Defensive programming suggests setting the value of pix even if it is 40x30.

[edit] 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...

[edit] category

The stub category the articles should go in. Note the template will only include articles in the stub category, unless the parameter tempsort is set in which case templates (in particular the stub template itself) will also be included - sorted with the value of " " (space) followed by tempsort.

[edit] tempsort

If exists the template will be put in it's own category sorted as " " (space) followed by tempsort.

[edit] category1

An optional second stub category the articles should go in. Note the template will only include articles in the stub category, unless the parameter tempsort1 is set in which case templates (in particular the stub template itself) will also be included - sorted with the value of " " (space) followed by tempsort1.

[edit] tempsort1

If exists the template will be put in it's own second category sorted as " " (space) followed by tempsort1.

[edit] note

If exists the value will be added, as a "small" note, to the stub template.

[edit] Examples

[edit] Using image

{{Asbox |{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}| image     = Ostfold_vapen.png
 | pix       = 30
 | subject   = [[Østfold]] location
 | qualifier = 
 | category  = Østfold geography stubs
}}

Appears as:

  This Østfold location article is a stub. You can help by expanding it.

Based on {{Østfold-geo-stub}}

(category has been over-ridden to keep this page out of the stub category)

[edit] Using icon and category1

Using icon allows more flexibility in some circumstances than image and pix, since it can be used with templates. As of January 24, 2007, the new parser requires the {{ and }} around the used template, and a single | is used instead of {{!}} to separate the parameters. Old code relying on {{!}} will need to be updated:

{{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  =       
}}

Appears as:

  This biographical article related to Welsh football (soccer) is a stub. You can help by expanding it.

Based on {{Wales-footy-bio-stub}}

(category and category1 have been over-ridden to keep this page out of the stub categories)

[edit] 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.

[edit] See also