Difference between revisions of "Cat State/doc"
From The RadioReference Wiki
< Template:Cat State
m (moved documentation to separate page) |
m (→Variables: updated notes) |
||
| Line 13: | Line 13: | ||
| '''CategoryName''' || || the category-article's own name (not its parent's name). || || | | '''CategoryName''' || || the category-article's own name (not its parent's name). || || | ||
|- | |- | ||
| − | | '''ParentCat''' || (Parent Category) || name of the article's parent category || Collaboration || | + | | '''ParentCat''' || (Parent Category) || name of the category-article's parent-category || Collaboration || |
|- | |- | ||
| − | | '''loctype''' || (location type) || | + | | '''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 |
|- | |- | ||
| '''StateWikiArticle''' || ||the proper title for the related Wiki article. || || | | '''StateWikiArticle''' || ||the proper title for the related Wiki article. || || | ||
Revision as of 09:18, 6 September 2015
Documentation Sub-page for Template:Cat_State
Scope of Use
- Template:Cat_State should be used to build category-pages for individual US States, Territories, etc. and Canadian Provinces.
Variables
- Specified values will override default values.
- Specified values and Default values are all case-sensitive.
| Variable Name | Var Description | Expected Value(s) | Default Value | Notes |
|---|---|---|---|---|
| CategoryName | the category-article's own name (not its parent's name). | |||
| 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 |
| StateWikiArticle | the proper title for the related Wiki article. |
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=Province Data}}
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.
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).