Template:StateForum/doc View history

(added category)
(added region lookups)
Line 9: Line 9:
{{StateForum
{{StateForum
| STATENAME or  
| STATENAME or  
   STATE ABBREVIATION
   STATE ABBREVIATION or
  REGION NAME
| state-id or  
| state-id or  
   region-id or  
   region-id or  
   region-name
   region-name or
  state-list
}}</nowiki>
}}</nowiki>
}}
}}
Line 20: Line 22:
::'''STATENAME''' - The full name of the state or territory (Alaska, California, Texas, etc.)
::'''STATENAME''' - The full name of the state or territory (Alaska, California, Texas, etc.)
::'''STATE ABBREVIATION''' - The two letter state abbreviation (AK, CA, TX, 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'''''
:'''''Second parameter'''''
Line 25: Line 28:
::'''region-id''' will return a URL to the forum for that state's region.
::'''region-id''' will return a URL to the forum for that state's region.
::'''region-name''' will return the name of the region, not a URL.
::'''region-name''' will return the name of the region, not a URL.
::'''state-list''' will return the names of the states in the region, not a URL.


== Examples ==
== Examples ==
Entering:  
Entering:  
{{Pre2|<nowiki>
{{Pre2|<nowiki>
[{{StateForum | AK | state-id}} Alaska forum].</nowiki>
[{{StateForum | AK | state-id}} Alaska forum]</nowiki>
}}
}}
Produces: [{{StateForum | AK | state-id}} Alaska forum].
Produces: [{{StateForum | AK | state-id}} Alaska forum]


Entering:
Entering:
{{Pre2|<nowiki>
{{Pre2|<nowiki>
[{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum].</nowiki>
[{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum]</nowiki>
}}
}}
Produces: [{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum].
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 | state-list}}</nowiki>
}}
Produces: {{StateForum | Northwest | state-list}}
 


<includeonly>
<includeonly>

Revision as of 14:35, 4 July 2014

This is a documentation subpage for Template:StateForum.
It contains usage information, categories and other content that is not part of the original template page.

This template enables the automatic selection of a United States (or US Territory) forum or region name.

Usage

Place {{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 passed to it.

{{StateForum
| STATENAME or 
  STATE ABBREVIATION or
  REGION NAME
| state-id or 
  region-id or 
  region-name or
  state-list
}}

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, not a URL.
state-list will return the names of the states in the region, not a URL.

Examples

Entering:

[{{StateForum | AK | state-id}} Alaska forum]

Produces: Alaska forum

Entering:

[{{StateForum | AK | region-id}} {{StateForum | AK | region-name}} region forum]

Produces: http://www.waze.com/forum/viewforum.php?f=Northwest region forum

Entering:

[{{StateForum | Northwest | region-id}} Northwest region forum]

Produces: Northwest region forum

Entering:

{{StateForum | Northwest | state-list}}

Produces: http://www.waze.com/forum/viewforum.php?f=AK/ID/MT/OR/WA/WY