Template:Usercatb/doc

Description

This template allows to easily categorize and provide information to "Wikipedians in..." categories. It includes the best features of {{Usercat}}, {{Usercat-1}} and {{Usercat-2}}, with logic allowing it to work as a direct drop-in replacement for both {{Usercat}} and {{Usercat-2}}, and a minor incompatibility with {{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 {{User category}}, and provides sane defaults allowing it to be used without providing any parameters all.

Usage

{{Usercatb|1|2|3|4|5|6|alt=|ub1=|ub2=|ub3=|ub4=}}

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 |example=value, to allow for the future expansions of the unnamed parameters without breaking backwards compatibility. The parameters are:

• |1= the small name to show on the top link bar to represent this place/category (default: the page name).
• |2= parent category to this category (without the "Category:" text) (default: none).
• |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).
• |4= grandparent category to this category (without the "Category:" text) (default: none).
• |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).
• |6= any text to be added after the end of the description line (default: a dot to finishing the paragraph).
• |alt= alternate full link, in the format [[Article name|Link text]], 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").
• |ub1= name of userbox template #1 (without the "Template:" text) (default: none).
• |ub2= name of userbox template #2 (without the "Template:" text) (default: none).
• |ub3= name of userbox template #3 (without the "Template:" text) (default: none).
• |ub4= name of userbox template #4 (without the "Template:" text) (default: none).

Examples

Country, State, City, extra text, no user box

{{Usercatb|Boston|Wikipedians in the United States|United States|Wikipedians in Massachusetts|Massachusetts|, [[Massachusetts]]}}

This category contains Wikipedians who currently or regularly live in, or self-identify as being from, Boston, Massachusetts.

To add your user page to this category, copy and paste the following code (do not change BASEPAGENAME):

[[Category:Wikipedians in Boston, Massachusetts|{{subst:BASEPAGENAME}}]]

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

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

This category contains Wikipedians who currently or regularly live in, or self-identify as being from, the city of São Paulo.

To add your user page to this category, use the following userbox:

{{User SP city}}

This user is from, or living in, the city of São Paulo.

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

[[Category:Wikipedians in São Paulo (city)|{{subst:BASEPAGENAME}}]]

Continent, Country, 2 user boxes

{{Usercatb|Brazil|Wikipedians in South America|South America|ub1=User br wikipedian|ub2=User Brazil}}

This category contains Wikipedians who currently or regularly live in, or self-identify as being from, Brazil.

To add your user page to this category, use any of the following userboxes:

{{User br wikipedian}}	This user is a Wikipedian in Brazil and loving it!
{{User Brazil}}	This user comes from Brazil.

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

[[Category:Wikipedians in Brazil|{{subst:BASEPAGENAME}}]]

See also

• {{User category}} for generic user categories.
• {{Educat}} for categories of Wikipedians by alma mater.