View source for Template:StateForum/doc View history

{{doc subpage}}
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
This template enables the automatic selection of a United States (or US Territory) forum or region name.

== Usage ==
Place {{tl|StateForum}} on a page where either a URL to a state or region forum is desired. Alternately the template can also determine the name of the region based on the state name or the states in a region. It uses the data in {{tl|StateForum/List}}.

{{Pre2|<nowiki>
{{StateForum
| STATENAME or 
  STATE ABBREVIATION or
  REGION NAME
| state-id or 
  region-id or 
  region-name or
  regional-coordinator or
  state-list or
  state-list-long
}}</nowiki>
}}

== Parameters ==
:'''''First parameter'''''
::'''STATENAME''' - The full name of the state or territory (Alaska, California, Texas, etc.)
::'''STATE ABBREVIATION''' - The two letter state abbreviation (AK, CA, TX, etc.)
::'''REGION NAME''' - The full name of the region (Northwest, New England, etc.)

:'''''Second parameter'''''
::'''state-id''' will return a URL to the state specific forum.
::'''region-id''' will return a URL to the forum for that state's region.
::'''region-name''' will return the name of the region.
::'''regional-coordinator''' will return the username of the regional coordinator.
::'''state-list''' will return the abbreviated names of the states in the region.
::'''state-list-long''' will return the full names of the states in the region.


== Examples ==
{|
| Entering: 
| {{Pre2|<nowiki>
[{{StateForum | AK | state-id}} Alaska forum]</nowiki>
}}
|}
Produces: [{{StateForum | AK | state-id}} Alaska forum]
----
{|
| Entering:
| {{Pre2|<nowiki>
[{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum]</nowiki>
}}
|}
Produces: [{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum]
----
{|
| Entering:
| {{Pre2|<nowiki>
[{{StateForum | Northwest | region-id}} Northwest region forum]</nowiki>
}}
|}
Produces: [{{StateForum | Northwest | region-id}} Northwest region forum]
----
{|
| Entering:
| {{Pre2|<nowiki>
{{StateForum | Northwest | regional-coordinator}}</nowiki>
}}
|}
Produces: {{StateForum | Northwest | regional-coordinator}}
----
{|
| Entering:
| {{Pre2|<nowiki>
{{Username |{{StateForum | Northwest | regional-coordinator}} }}</nowiki>
}}
|}
Produces: {{Username |{{StateForum | Northwest | regional-coordinator}} }}

(NOTE: The template currently requires no space between the '''|''' and the first parameter.)

----
{|
| Entering:
| {{Pre2|<nowiki>
{{StateForum | Northwest | state-list}}</nowiki>
}}
|}
Produces: {{StateForum | Northwest | state-list}}
----
{|
| Entering:
| {{Pre2|<nowiki>
{{StateForum | Northwest | state-list-long}}</nowiki>
}}
|}
Produces: {{StateForum | Northwest | state-list-long}}


<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Forum Templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->

</includeonly>