View source for Template:Stub category/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{high use|15376}}
{{#ifeq:{{{regional|no}}}|yes|The {{tlx|regional stub category}} template operates identically to {{tlx|stub category}} except that it also categorises the page into {{cl|Stubs by region}}.}}
__FORCETOC__

==Usage==
 <nowiki>{{</nowiki>{{#ifeq:{{{regional|no}}}|yes|Regional stub category|Stub category}}
 |article=
 |newstub=
 |category=
 |category type=
 |WikiProject=
 |message=
 <nowiki>}}</nowiki>

For example:

 <nowiki>{{</nowiki>{{#ifeq:{{{regional|no}}}|yes|Regional stub category|Stub category}}
 |article=<nowiki>people in Japanese [[football (soccer)]], including football players, managers, coaches, etc.</nowiki>
 |newstub=Japan-footy-bio-stub
 |category=Japanese footballers
 |message=
 <nowiki>}}</nowiki>

will show:

{{Stub category|article=people in Japanese [[football (soccer)]], including football players, managers, coaches, etc.|newstub=Japan-footy-bio-stub}}<!-- Removed cat so it doesn't show in it -->

The {{para|category type}} parameter inserts additional text between the phrases "This category is for" and "[[Wikipedia:Stub|stub articles]] relating to ...", so using {{para|category type|biographical}} will give "This category is for biographical [[Wikipedia:Stub|stub articles]] relating to ...".

=== Optional parameters ===
==== WikiProject ====
{{para|WikiProject}} links to a relevant WikiProject page. For example:

 <nowiki>{{</nowiki>{{#ifeq:{{{regional|no}}}|yes|Regional stub category|Stub category}}
 |article=<nowiki>the [[Commonwealth of Massachusetts]]</nowiki>
 |newstub=Massachusetts-stub
 |category=Massachusetts
 |category type=biographical
 |WikiProject=Massachusetts
 <nowiki>}}</nowiki>

will show:
{{stub category|article=the [[Commonwealth of Massachusetts]]|newstub=Massachusetts-stub |category type=biographical |WikiProject=Massachusetts}}

==== message ====
{{para|message}} adds a message displayed below the main output of the template, but above the table of contents (TOC) which will be automatically generated by {{tl|CatAutoTOC}} if the category contains enough pages.

This ensures that the message doesn't get tangled up in the TOC.

 <nowiki>{{</nowiki>{{#ifeq:{{{regional|no}}}|yes|Regional stub category|Stub category}}
 |article=<nowiki>people in Japanese [[football (soccer)]], including football players, managers, coaches, etc.</nowiki>
 |newstub=Japan-footy-bio-stub
 |category=Japanese footballers
 |message=This category is only people involved in [[association football]] (soccer). Please do NOT use this stub tag for players of other types of football, e.g. [[Gaelic football]], [[Australian rules football]], [[rugby union]].
 <nowiki>}}</nowiki>

===Tracking categories===
Certain cases of incorrect usage are tracked:
*the {{para|newstub}} parameter is blank or absent;
*the {{para|category}} parameter is blank or absent.

See [[:Category:Stub categories needing attention]] (population: {{PAGESINCATEGORY:Stub categories needing attention}})

Usage of the {{param|message}} parameter is also tracked.<br />See [[:Category:Stub categories with message parameter]] (population: {{PAGESINCATEGORY:Stub categories with message parameter}})

<small>{{Purge|''Purge this page to update the totals''}}</small>

==See also==
{{other category-header templates}}

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
{{#ifeq:{{{regional|no}}}|yes||
[[Category:Stub categories| {{PAGENAME}}]]
[[Category:Category namespace templates]]
[[Category:WikiProject Stub sorting templates]]

[[ro:Format:CiotCat]]

}}}}</includeonly>