Actions

User

Difference between revisions of "QDP2012/30/1"

From The RadioReference Wiki

< User:QDP2012‎ | 30
m
m
Line 1: Line 1:
 
{{User:QDP2012/pages}}
 
{{User:QDP2012/pages}}
 
.
 
.
==Documentation Sub-page for Template:Text_CatGeneral==
+
==Documentation Sub-page for Template:Cat_State==
 
===Scope of Use===
 
===Scope of Use===
 
====Purpose====
 
====Purpose====
*'''[[:Template:Text_CatGeneral]]''' is designed to be a single-source text-template that provides a common and uniform structure for the text that is displayed in the mid-sections of both '''[[:Template:Text_CatStateOther]]''' and '''[[:Template:Text_CatStateOtherFreq]]'''
+
*'''[[:Template:Cat_State]]''' should be used to build category-pages for individual US States, Territories, etc. and Canadian Provinces.
*Variables listed below allow the default message to be shown or hidden, and/or custom-messages to be displayed when provided.
+
*'''[[:Template:Cat_State]]''' is designed to be a category-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.
*The default message is intended for frequencies-related categories, and contains instructions about submitting information to the Frequency Database.
+
====Directly Invoked By====
 +
*'''[[:Template:Cat_State]]''' should be directly invoked only by "state"-level category-pages.
  
====Directly Invoked By====
 
*'''[[:Template:Text_CatGeneral]]''' should be directly invoked only by '''[[:Template:Text_CatStateOther]]''' and '''[[:Template:Text_CatStateOtherFreq]]'''.
 
 
====Not Intended For====
 
====Not Intended For====
*'''[[:Template:Text_CatGeneral]]''' should not be directly invoked by any other template or category, although all templates and categories that invoke either '''[[:Template:Text_CatStateOther]]''' or '''[[:Template:Text_CatStateOtherFreq]]''' will indirectly invoke '''[[:Template:Text_CatGeneral]]''' by transclusion.
+
*'''[[: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.
 
 
 
 
  
 
===Variables===
 
===Variables===
Line 21: Line 18:
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
 
|- bgcolor="lightgrey" |  
 
|- bgcolor="lightgrey" |  
! Variable Name !! Var Description !! Expected&nbsp;Value(s) !! Default Value !! Notes
+
! Variable Name !! Var Description !! Expected Value(s) !! Default Value !! Notes
 
|-
 
|-
| '''HideFreqText''' || ||
+
| '''CategoryName''' || ||
*either unspecified <br/>
+
* the category-article's own name (not its parent's name).
*or specified with no value
+
|| ||
||unspecified ||  
+
|-
* When unspecified, the default message displays (and will be above any custom message specified by the MoreText variable).<br/>
+
| '''ParentCat''' || (Parent Category) ||
*When specified with no value, the default message is hidden.<br/>
+
* name of the category-article's parent-category
----
+
|| Collaboration ||
*'''[[:Template:Text_CatStateOther]]''' hides the default message.
+
|-
*'''[[:Template:Text_CatStateOtherFreq]]''' displays the default message.
+
| '''loctype''' || (location type) || (without quotes)
 
+
* either "state"
----
+
* or "province"
*'''''{{Color|red|Caution}}:''''' '''Please do not specify an actual value for this variable''', as the results will be beyond the designs of both this template and the template(s) that are expected to invoke this template.
+
* or "district".
 +
|| state ||
 +
* The value should be the noun that is grammatically correct for the specified "state" wiki article.
 
|-
 
|-
| '''MoreText''' || ||
+
| '''StateWikiArticle''' || ||
*either unspecified<br/>
+
*the proper title for the related Wiki article.
*or specified with a custom-message
+
|| ||
|| unspecified ||
 
*When unspecified, this variable is hidden.<br/>
 
*When specified, any custom message assigned to this variable with be displayed.  If the default message is not hidden (using the HideFreqText variable), then the default message will be displayed above the custom message.
 
----
 
*'''[[:Template:Text_CatStateOther]]''' allows a custom message via MoreText.
 
*'''[[:Template:Text_CatStateOtherFreq]]''' allows a custom message via MoreText.
 
 
 
 
|-
 
|-
 
|}
 
|}
Line 53: Line 45:
 
----
 
----
 
----
 
----
====How to invoke this template to show only the default message====
+
====How to invoke this template for a US State====
*<nowiki>{{Text_CatGeneral}}</nowiki><br/>
+
*<nowiki>
 +
{{Cat_State</nowiki><br/><nowiki>
 +
|CategoryName=Texas</nowiki><br/><nowiki>
 +
|StateWikiArticle=Texas (US)}}</nowiki><br/>
 
----
 
----
 
=====Result=====
 
=====Result=====
In general, data in any Wiki article:
+
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.
*should be used to supplement the data in our [http://www.radioreference.com/apps/db/ Frequency Database].
 
*may not be accurate.  Members are encouraged to listen and validate it, and to edit the articles.
 
  
 +
To assign this category to an article, '''please add <nowiki>[[</nowiki>Category:Texas<nowiki>]]</nowiki> as the last line.'''
  
The data in the articles listed below:
 
*should '''not''' be submitted to the data base team '''until the data have been validated.'''
 
**Please read [[RR Database Submission Guidelines]] before submitting validated data to the Frequency Database.
 
**Please read [[RR Wiki Extensions|Wiki Extensions]] to learn how to incorporate Database-data into a Wiki page.
 
**Please use [http://www.mediawiki.org/wiki/Help:Tables tables] if there are more than a couple lines of data.
 
***This enables several applications to capture this data, copy it into Windows clipboard, and from there to your scanner programming software. This helps to avoid a large amount of tedious (and error prone) manual typing and copying. See the [[Applications that can copy Frequency Data from the Wiki]] article for more information.
 
  
 +
You may find this state's Wiki article at '''[[Texas (US)]]'''.
  
 
----
 
----
 
----
 
----
 
+
====How to invoke this template for the US District of Columbia====
====How to invoke this template to show both default and custom messages====
 
 
*<nowiki>
 
*<nowiki>
{{Text_CatGeneral|MoreText=<br/><br/>This is a custom message.}}</nowiki><br/>
+
{{Cat_State</nowiki><br/><nowiki>
 +
|CategoryName=District of Columbia</nowiki><br/><nowiki>
 +
|loctype=district</nowiki><br/><nowiki>
 +
|StateWikiArticle=District of Columbia (DC)}}</nowiki><br/>
 
----
 
----
 
=====Result=====
 
=====Result=====
In general, data in any Wiki article:
+
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.
*should be used to supplement the data in our [http://www.radioreference.com/apps/db/ Frequency Database].
 
*may not be accurate.  Members are encouraged to listen and validate it, and to edit the articles.
 
  
 +
To assign this category to an article, '''please add <nowiki>[[</nowiki>Category:District of Columbia<nowiki>]]</nowiki> as the last line.'''
  
The data in the articles listed below:
 
*should '''not''' be submitted to the data base team '''until the data have been validated.'''
 
**Please read [[RR Database Submission Guidelines]] before submitting validated data to the Frequency Database.
 
**Please read [[RR Wiki Extensions|Wiki Extensions]] to learn how to incorporate Database-data into a Wiki page.
 
**Please use [http://www.mediawiki.org/wiki/Help:Tables tables] if there are more than a couple lines of data.
 
***This enables several applications to capture this data, copy it into Windows clipboard, and from there to your scanner programming software. This helps to avoid a large amount of tedious (and error prone) manual typing and copying. See the [[Applications that can copy Frequency Data from the Wiki]] article for more information.
 
<br/><br/>This is a custom message.
 
----
 
----
 
 
====How to invoke this template to show only a custom message====
 
*<nowiki>
 
{{Text_CatGeneral|HideFreqText=|MoreText=<br/><br/>This is a custom message.}}</nowiki><br/>
 
----
 
=====Result=====
 
In general, data in any Wiki article:
 
*should be used to supplement the data in our [http://www.radioreference.com/apps/db/ Frequency Database].
 
*may not be accurate.  Members are encouraged to listen and validate it, and to edit the articles.
 
  
 +
You may find this district's Wiki article at '''[[District of Columbia (DC)]]'''.
  
<br/><br/>This is a custom message.
 
 
----
 
----
 
----
 
----
 
+
====How to invoke this template for a Canadian Province====
====How to invoke this template to show neither the default nor a custom message====
 
 
*<nowiki>
 
*<nowiki>
{{Text_CatGeneral|HideFreqText=|MoreText=|}}</nowiki><br/>
+
{{Cat_State</nowiki><br/><nowiki>
 +
|CategoryName=Quebec</nowiki><br/><nowiki>
 +
|loctype=province</nowiki><br/><nowiki>
 +
|StateWikiArticle=Quebec (CA)</nowiki><br/><nowiki>
 +
|ParentCat=Province Data}}</nowiki><br/>
 
----
 
----
 
=====Result=====
 
=====Result=====
In general, data in any Wiki article:
+
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.
*should be used to supplement the data in our [http://www.radioreference.com/apps/db/ Frequency Database].
+
 
*may not be accurate.  Members are encouraged to listen and validate it, and to edit the articles.
+
To assign this category to an article, '''please add <nowiki>[[</nowiki>Category:Quebec<nowiki>]]</nowiki> as the last line.'''
  
  
 +
You may find this province's Wiki article at '''[[Quebec (CA)]]'''.
 
----
 
----
 
----
 
----
Line 125: Line 101:
  
  
Return to: [[:Template:Text_CatGeneral]]
+
Return to: [[:Template:Cat_State]]

Revision as of 23:08, 7 September 2015


Home Prompts Move TRVA Cat Tree Links CECC Pgmg Templates

Tasks: Art, Cat, Tmp, DB
10, 13, 27, 29, 30/1
32, 43, 44,
193,194



Conv&Stds
Sandbox

Edit
PrfxIdx
..WRRR
..USBR 1
..USBR 76
..PHT
Cat List Custom
Avoid Unused
35, 36, 37, 38,

CT (C E S N) SC
Categories to be DELETED
Templates to be DELETED
Pages to be DELETED

TL (G IB C S D)
B, C, D, F, I
Tk, Tb, Ct, Tx. M, S, TO
Avoid Unused

InfoBox project related:
Template:ForTestingOnly
OLD: NEW:






.

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

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

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






Return to: Template:Cat_State