View source for Template:Usercatb/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
== Description ==

This template allows to easily categorize and provide information to "Wikipedians in..." categories. It includes the best features of {{tl|Usercat}}, {{tl|Usercat-1}} and {{tl|Usercat-2}}, with logic allowing it to work as a direct drop-in replacement for both {{tl|Usercat}} and {{tl|Usercat-2}}, and a minor incompatibility with {{tl|Usercat-1}} that still allow it to replace most of the case where it's used without having to change any parameter. It also includes the ability to show user boxes provided with the same look and feel available in the more generic {{tl|User category}}, and provides sane defaults allowing it to be used without providing any parameters all.

== Usage ==

 <code><nowiki>{{</nowiki>[[Template:Usercatb|Usercatb]]|''1''|''2''|''3''|''4''|''5''|''6''|alt=|ub1=|ub2=|ub3=|ub4=<nowiki>}}</nowiki></code>

Where all parameters are optional and have default values if unspecified. The first six parameters are unnamed, being entered directly between the pipe ("|") signs (leave two pipe signs in sequence if the parameter isn't needed). The remaining five are named, having to be entered as {{para|example|value}}, to allow for the future expansions of the unnamed parameters without breaking backwards compatibility. The parameters are:

* '''{{para|1}}''' the small name to show on the top link bar to represent this place/category ''(default: the page name)''.
* '''{{para|2}}''' parent category to this category  (without the "Category:" text) ''(default: none)''.
* '''{{para|3}}''' the small name to show on the top link bar to represent the parent place/category to this one ''(default: the category name itself)''.
* '''{{para|4}}''' grandparent category to this category  (without the "Category:" text) ''(default: none)''.
* '''{{para|5}}''' the small name to show on the top link bar to represent the grandparent place/category to this one ''(default: middle category name itself)''.
* '''{{para|6}}''' any text to be added after the end of the description line ''(default: a dot to finishing the paragraph)''.
* '''{{para|alt}}''' alternate full link, in the format <code><nowiki>[[Article name|Link text]]</nowiki></code>, to the Wikipedia article about this place/category ''(default: link to an article with the same name from the first parameter, or the page name")''.
* '''{{para|ub1}}''' name of userbox template #1 (without the "Template:" text) ''(default: none)''.
* '''{{para|ub2}}''' name of userbox template #2 (without the "Template:" text) ''(default: none)''.
* '''{{para|ub3}}''' name of userbox template #3 (without the "Template:" text) ''(default: none)''.
* '''{{para|ub4}}''' name of userbox template #4 (without the "Template:" text) ''(default: none)''.

== Examples ==
<!-- Subst'ed and edited for a better exemplification -->
=== Country, State, City, extra text, no user box ===

 <code><nowiki>{{</nowiki>[[Template:Usercatb|Usercatb]]<nowiki>|Boston|Wikipedians in the United States|United States|Wikipedians in Massachusetts|Massachusetts|, [[Massachusetts]]}}</nowiki></code>

{| class="toccolours" style="margin:1em auto;"
 | '''[[Wikipedia:Classification|Classification]]''' : [[:Category:Wikipedians|Wikipedians]] {{!}} [[:Category:Wikipedians by location|By location]] {{!}} [[:Category:Wikipedians in the United States|United States]] {{!}} [[:Category:Wikipedians in Massachusetts|Massachusetts]] {{!}} '''Boston'''
|}


This [[Wikipedia:Categorization FAQ|category]] contains [[Wikipedia:Wikipedian|Wikipedians]] who currently or regularly live in, or self-identify as being from, [[Boston]], [[Massachusetts]].

To add your [[Special:Mypage|user page]] to this category, copy and paste the following code (do not change <code>BASEPAGENAME</code>):

: <code><nowiki>[[Category:Wikipedians in Boston, Massachusetts|{{subst:BASEPAGENAME}}]]</nowiki></code>

=== Country, State, City, alternate link, 1 user box ===

 <code><nowiki>{{</nowiki>[[Template:Usercatb|Usercatb]]<nowiki>|São Paulo (city)|Wikipedians in Brazil|Brazil|Wikipedians in São Paulo|São Paulo|alt=[[São Paulo|the city of São Paulo]]|ub1=User SP city}}</nowiki></code>

{| align="center" class="toccolours"
 | '''[[Wikipedia:Classification|Classification]]''' : [[:Category:Wikipedians|Wikipedians]] {{!}} [[:Category:Wikipedians by location|By location]] {{!}} [[:Category:Wikipedians in Brazil|Brazil]] {{!}} [[:Category:Wikipedians in São Paulo|São Paulo]] {{!}} '''São Paulo (city)'''
|}


This [[Wikipedia:Categorization FAQ|category]] contains [[Wikipedia:Wikipedian|Wikipedians]] who currently or regularly live in, or self-identify as being from, [[São Paulo|the city of São Paulo]].

To add your [[Special:Mypage|user page]] to this category, use the following [[Wikipedia:Userboxes|userbox]]:

<table style="background-color: transparent;">
<tr><td>
:<code>{{tlx|User SP city}}</code></td><td>{{User SP city|nocat=true|category=|categories=no}}
</td></tr>
</table>

Alternatively, copy and paste the following code (do not change <code>BASEPAGENAME</code>):

: <code><nowiki>[[Category:Wikipedians in São Paulo (city)|{{subst:BASEPAGENAME}}]]</nowiki></code>

=== Continent, Country, 2 user boxes ===

 <code><nowiki>{{</nowiki>[[Template:Usercatb|Usercatb]]<nowiki>|Brazil|Wikipedians in South America|South America|ub1=User br wikipedian|ub2=User Brazil}}</nowiki></code>

{| align="center" class="toccolours"
 | '''[[Wikipedia:Classification|Classification]]''' : [[:Category:Wikipedians|Wikipedians]] {{!}} [[:Category:Wikipedians by location|By location]] {{!}} [[:Category:Wikipedians in South America|South America]]  {{!}} '''Brazil'''
|}


This [[Wikipedia:Categorization FAQ|category]] contains [[Wikipedia:Wikipedian|Wikipedians]] who currently or regularly live in, or self-identify as being from, [[Brazil]].

To add your [[Special:Mypage|user page]] to this category, use any of the following [[Wikipedia:Userboxes|userboxes]]:

<table style="background-color: transparent;">
<tr><td>
:<code>{{tlx|User br wikipedian}}</code></td><td>{{User br wikipedian|nocat=true|category=|categories=no}}
</td></tr>
<tr><td>
:<code>{{tlx|User Brazil}}</code></td><td>{{User Brazil|nocat=true|category=|categories=no}}
</td></tr>
</table>

Alternatively, copy and paste the following code (do not change <code>BASEPAGENAME</code>):

: <code><nowiki>[[Category:Wikipedians in Brazil|{{subst:BASEPAGENAME}}]]</nowiki></code>

== See also ==

* {{tl|User category}} for generic user categories.
* {{tl|Educat}} for categories of Wikipedians by alma mater.

{{namespace category}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Usercat templates]]
}}</includeonly>