Template:StateForum/doc View history

(Updated documentation)
(added category)
Line 41: Line 41:
<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Templates]]
[[Category:Forum Templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!-- ADD INTERWIKIS BELOW THIS LINE -->


</includeonly>
</includeonly>

Revision as of 06:38, 1 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
| state-id or 
  region-id or 
  region-name
}}

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.)
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.

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.