Actions

Template

Difference between revisions of "Cat State/doc"

From The RadioReference Wiki

< Template:Cat State
m (→‎Variables: updated notes)
m (updated categories)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Documentation Sub-page for Template:Cat_State==
 
==Documentation Sub-page for Template:Cat_State==
 
===Scope of Use===
 
===Scope of Use===
 +
====Purpose====
 
*'''[[:Template:Cat_State]]''' should be used to build category-pages for individual US States, Territories, etc. and Canadian Provinces.
 
*'''[[:Template:Cat_State]]''' should be used to build category-pages for individual US States, Territories, etc. and Canadian Provinces.
 +
*'''[[:Template:Cat_State]]''' is designed to be a categories-template that provides a common and uniform structure for both the text that is displayed on, and the categories assigned to, specific "state"-level categories.
  
===Variables===
+
====Directly Invoked By====
 +
*'''[[:Template:Cat_State]]''' should be directly invoked only by "state"-level category-pages.
 +
 
 +
====Not Intended For====
 +
*'''[[:Template:Cat_State]]''' should not be directly invoked by any other template or category, including state-specific sub-categories below a primary "state"-level category.
 +
 
 +
===Parameters===
 
*Specified values will override default values.
 
*Specified values will override default values.
*Specified values and Default values are all case-sensitive.
+
*Specified values, Default values, and Parameter Names are all case-sensitive.
  
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
 
|- bgcolor="lightgrey" |  
 
|- bgcolor="lightgrey" |  
! Variable Name !! Var Description !! Expected Value(s) !! Default Value !! Notes
+
! Parameter Name !! Var Description !! Expected Value(s) !! Default Value !! Notes
 
|-
 
|-
| '''CategoryName''' || || the category-article's own name (not its parent's name). || ||
+
| '''CategoryName''' || ||
 +
* the category-article's own name (not its parent's name).
 +
|| || {{color|red|A value is Required}}
 
|-
 
|-
| '''ParentCat''' || (Parent Category) || name of the category-article's parent-category || Collaboration ||
+
| '''ParentCat''' || (Parent Category) ||
 +
* name of the category-article's parent-category
 +
|| Collaboration ||  
 
|-
 
|-
| '''loctype''' || (location type) || either "state", "province", or "district" (without quotes). || state || the value should be the noun that is grammatically correct for the specified "state" wiki article
+
| '''loctype''' || (location type) || (without quotes)
 +
* either "state"
 +
* or "province"  
 +
* or "district".
 +
|| state ||
 +
* The value should be the noun that is grammatically correct for the specified "state" wiki article.
 
|-
 
|-
| '''StateWikiArticle''' || ||the proper title for the related Wiki article. || ||
+
| '''StateWikiArticle''' || ||
 +
*the proper title for the related Wiki article.
 +
|| || {{color|red|A value is Required}}
 
|-
 
|-
 
|}
 
|}
Line 64: Line 83:
 
|loctype=province</nowiki><br/><nowiki>
 
|loctype=province</nowiki><br/><nowiki>
 
|StateWikiArticle=Quebec (CA)</nowiki><br/><nowiki>
 
|StateWikiArticle=Quebec (CA)</nowiki><br/><nowiki>
|ParentCat=Province Data}}</nowiki><br/>
+
|ParentCat=Canada}}</nowiki><br/>
 
----
 
----
 
=====Result=====
 
=====Result=====
Welcome to the "Category:Quebec" category which is a sub-category of "[[:Category:Province Data]]". Please assign this category to all articles relating to information from entities in the province of Quebec.
+
Welcome to the "Category:Quebec" category which is a sub-category of "[[:Category:Canada]]". Please assign this category to all articles relating to information from entities in the province of Quebec.
  
 
To assign this category to an article, '''please add <nowiki>[[</nowiki>Category:Quebec<nowiki>]]</nowiki> as the last line.'''
 
To assign this category to an article, '''please add <nowiki>[[</nowiki>Category:Quebec<nowiki>]]</nowiki> as the last line.'''
Line 75: Line 94:
 
----
 
----
 
----
 
----
 +
 +
 +
 +
 +
 +
 +
Return to: [[:Template:Cat_State]]
 +
 +
[[Category:Documentation]]

Latest revision as of 05:19, 22 October 2015

Documentation Sub-page for Template:Cat_State

Scope of Use

Purpose

  • Template:Cat_State should be used to build category-pages for individual US States, Territories, etc. and Canadian Provinces.
  • Template:Cat_State is designed to be a categories-template that provides a common and uniform structure for both the text that is displayed on, and the categories assigned to, specific "state"-level categories.

Directly Invoked By

Not Intended For

  • Template:Cat_State should not be directly invoked by any other template or category, including state-specific sub-categories below a primary "state"-level category.

Parameters

  • Specified values will override default values.
  • Specified values, Default values, and Parameter Names are all case-sensitive.
Parameter Name Var Description Expected Value(s) Default Value Notes
CategoryName
  • the category-article's own name (not its parent's name).
A value is Required
ParentCat (Parent Category)
  • name of the category-article's parent-category
Collaboration
loctype (location type) (without quotes)
  • either "state"
  • or "province"
  • or "district".
state
  • The value should be the noun that is grammatically correct for the specified "state" wiki article.
StateWikiArticle
  • the proper title for the related Wiki article.
A value is Required

Examples

  • The horizontal lines below separate examples for clarity and do not appear when template is invoked.


How to invoke this template for a US State

  • {{Cat_State
    |CategoryName=Texas
    |StateWikiArticle=Texas (US)}}

Result

Welcome to the "Category:Texas" category which is a sub-category of "Category:Collaboration". Please assign this category to all articles relating to information from entities in the state of Texas.

To assign this category to an article, please add [[Category:Texas]] as the last line.


You may find this state's Wiki article at Texas (US).



How to invoke this template for the US District of Columbia

  • {{Cat_State
    |CategoryName=District of Columbia
    |loctype=district
    |StateWikiArticle=District of Columbia (DC)}}

Result

Welcome to the "Category:District of Columbia" category which is a sub-category of "Category:Collaboration". Please assign this category to all articles relating to information from entities in the district of District of Columbia.

To assign this category to an article, please add [[Category:District of Columbia]] as the last line.


You may find this district's Wiki article at District of Columbia (DC).



How to invoke this template for a Canadian Province

  • {{Cat_State
    |CategoryName=Quebec
    |loctype=province
    |StateWikiArticle=Quebec (CA)
    |ParentCat=Canada}}

Result

Welcome to the "Category:Quebec" category which is a sub-category of "Category:Canada". Please assign this category to all articles relating to information from entities in the province of Quebec.

To assign this category to an article, please add [[Category:Quebec]] as the last line.


You may find this province's Wiki article at Quebec (CA).






Return to: Template:Cat_State