Template:StateForum/doc View history

(added region lookups)
(→‎Usage: added more info and link)
Line 4: Line 4:


== Usage ==
== 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 passed to it.
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>
{{Pre2|<nowiki>

Revision as of 15:50, 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 or the states in a region. It uses the data in {{StateForum/List}}.

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