View source for Template:User invitation/doc

{{documentation subpage}}__NOTOC__
This [[Help:Template|template]] creates a [[Wikipedia:Userboxes|custom userbox]] that invites [[Wikipedia:Wikipedians|users]] to visit a specific nation, state, province, territory, district, or place.

==Use==
To use this userbox template, place the following line of [[Help:Wikitext|Wikitext]] on [[Special:MyPage|your user&nbsp;page]]:
:'''<code><nowiki>{{User invitation|location|the|alt=|region=|color=}}</nowiki></code>'''
where:
*'''<code>location&nbsp;</code>'''is a location name.
*'''<code>the&nbsp;</code>'''is an optional article to precede the location name.
*'''<code>alt=&nbsp;</code>'''an optional alternate location name.
*'''<code>region=&nbsp;</code>'''an optional region name or [[ISO 3166-1|ISO 3166 code]].  (default&nbsp;=&nbsp;'''<code>location</code>''')
:See [[:Category:Multiuse regional user templates]] for currently available '''''<code>region</code>''''' names and codes.
*'''<code>color=&nbsp;</code>'''an optional background color.

This template adds your user page to the approriate [[:Category:Wikipedians by location|regional location category]].  A <code>nocat=true</code> parameter may be used to inhibit category declaration.

===Examples===
{|border="1" cellpadding="2"
![[Wiki markup]]
![[Wikipedia:Userboxes|Userbox]]
|-
|<code>&thinsp;<nowiki>{{User invitation|Great Britain}}</nowiki>&thinsp;</code>
|{{User invitation|Great Britain}}
|-
|<code>&thinsp;<nowiki>{{User invitation|United Kingdom|the}}</nowiki>&thinsp;</code>
|{{User invitation|United Kingdom|the}}
|-
|<code>&thinsp;<nowiki>{{User invitation|UK|the}}</nowiki>&thinsp;</code>
|{{User invitation|UK|the}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Wales}}</nowiki>&thinsp;</code>
|{{User invitation|Wales}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Madhya Pradesh}}</nowiki>&thinsp;</code>
|{{User invitation|Madhya Pradesh}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Queensland}}</nowiki>&thinsp;</code>
|{{User invitation|Queensland}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Johannesburg|region=South Africa}}</nowiki>&thinsp;</code>
|{{User invitation|Johannesburg|region=South Africa}}
|-
|<code>&thinsp;<nowiki>{{User invitation|New York City|region=US}}</nowiki>&thinsp;</code>
|{{User invitation|New York City|region=US}}
|-
|<code>&thinsp;<nowiki>{{User invitation|New York City|region=New York}}</nowiki>&thinsp;</code>
|{{User invitation|New York City|region=New York}}
|-
|<code>&thinsp;<nowiki>{{User invitation|New York City}}</nowiki>&thinsp;</code>
|{{User invitation|New York City}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Sept-Îles, Quebec|region=Quebec}}</nowiki>&thinsp;</code>
|{{User invitation|Sept-Îles, Quebec|region=Quebec}}
|-
|<code>&thinsp;<nowiki>{{User invitation|Centennial, Wyoming|region=Wyoming}}</nowiki>&thinsp;</code>
|{{User invitation|Centennial, Wyoming|region=Wyoming}}
|-
|<code>&thinsp;<nowiki>{{User invitation|King of Prussia, Pennsylvania|region=Pennsylvania}}</nowiki>&thinsp;</code>
|{{User invitation|King of Prussia, Pennsylvania|region=Pennsylvania}}
|-
|<code>&thinsp;<nowiki>{{User invitation|eThekwini Metropolitan Municipality|region=South Africa|alt=eThekwini}}</nowiki>&thinsp;</code>
|{{user invitation|eThekwini Metropolitan Municipality|region=South Africa|alt=eThekwini}}
|-
|<code>&thinsp;<nowiki>{{User invitation|South Island|region=New Zealand}}</nowiki>&thinsp;</code>
|{{User invitation|South Island|region=New Zealand}}
|-
|<code>&thinsp;<nowiki>{{User invitation}}</nowiki>&thinsp;</code>
|{{User invitation}}
|}
{{-}}

{{Template:User activity/custom}}
<includeonly>{{Sandbox other||
[[Category:Regional activity user templates|Invitation]]
}}</includeonly>