|
|
Line 1: |
Line 1: |
| {{User:QDP2012/pages}} | | {{User:QDP2012/pages}} |
| . | | . |
− | ==Documentation Sub-page for Template:Cat_StateFreq==
| |
− | ===Scope of Use===
| |
− | ====Purpose====
| |
− | *'''[[:Template:Cat_StateFreq]]''' should be used to build frequency-related category-pages for individual Countries, US States, Territories, etc. and Canadian Provinces.
| |
− | *'''[[:Template:Cat_StateFreq]]''' 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 frequency-related "state"-level categories.
| |
− |
| |
− | ====Directly Invoked By====
| |
− | *'''[[:Template:Cat_StateFreq]]''' should be directly invoked only by "state"-level frequency-related category-pages.
| |
− |
| |
− | ====Not Intended For====
| |
− | *'''[[:Template:Cat_StateFreq]]''' should not be directly invoked by any other template or category, including state-specific frequency-related sub-categories below a primary "state"-level frequency-related category; nor by the top frequencies-related category within a particular theme (e.g. not invoked by "Category:Medical Frequencies").
| |
− |
| |
− | ===Variables===
| |
− | *Specified values will override default values.
| |
− | *Specified values and Default values are all case-sensitive.
| |
− |
| |
− | {| {{table}} width="100%"
| |
− | |- bgcolor="lightgrey" |
| |
− | ! Variable Name !! Var Description !! Expected Value(s) !! Default Value !! Notes
| |
− | |-
| |
− | | '''State''' || || || || {{color|red|A value is Required}}
| |
− | |-
| |
− | | '''FreqParent''' || ||name of the parent "...Frequencies" category <br/>(omit the word "Frequencies") ||Wiki || The word "Frequencies" is already present in the template and should '''not''' be included in the FreqParent value.
| |
− | |-
| |
− | | '''MoreText''' || || || (no value) || This variable allows for an optional custom message in the page's mid-section. When no value is specified, the variable name is hidden.
| |
− | |-
| |
− | |}
| |
− |
| |
− | ===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====
| |
− | *<nowiki>{{Cat_StateFreq|State=Utah}}</nowiki>
| |
− | ----
| |
− | =====Result=====
| |
− | Welcome to the '''"Category:Utah Frequencies"''' category. This category:
| |
− | *Is a sub-category of:
| |
− | **"[[:Category:Utah]]",
| |
− | **"[[:Category:Wiki Frequencies]]".
| |
− | *Lists all the articles for [[:Category:Utah]] that contain Wiki Frequencies information as submitted by the members.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | To CATEGORIZE an article into this category, please add the following as the last line in the article:<br/>
| |
− | '''<nowiki>[[Category:</nowiki>Utah Frequencies<nowiki>]]</nowiki>'''
| |
− |
| |
− |
| |
− | Please do NOT edit this page unless you intend to change the Description of this Category. Thank you.
| |
− | <br/><br/>
| |
− | ----
| |
− | ----
| |
− |
| |
− | ====How to invoke this template for a Canadian Province====
| |
− | *<nowiki>{{Cat_StateFreq|State=Ontario}}</nowiki>
| |
− | ----
| |
− | =====Result=====
| |
− | Welcome to the '''"Category:Ontario Frequencies"''' category. This category:
| |
− | *Is a sub-category of:
| |
− | **"[[:Category:Ontario]]",
| |
− | **"[[:Category:Wiki Frequencies]]".
| |
− | *Lists all the articles for [[:Category:Ontario]] that contain Wiki Frequencies information as submitted by the members.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | To CATEGORIZE an article into this category, please add the following as the last line in the article:<br/>
| |
− | '''<nowiki>[[Category:</nowiki>Ontario Frequencies<nowiki>]]</nowiki>'''
| |
− |
| |
− |
| |
− | Please do NOT edit this page unless you intend to change the Description of this Category. Thank you.
| |
− | <br/><br/>
| |
− | ----
| |
− | ----
| |
− |
| |
− | ====How to invoke this template for another Country with Custom Message====
| |
− | *<nowiki>{{Cat_StateFreq|State=My Country|MoreText=<br/><br/>....This example uses bogus names....<br/><br/>}}</nowiki>
| |
− | ----
| |
− | =====Result=====
| |
− | Welcome to the '''"Category:My Country Frequencies"''' category. This category:
| |
− | *Is a sub-category of:
| |
− | **"[[:Category:My Country]]",
| |
− | **"[[:Category:Wiki Frequencies]]".
| |
− | *Lists all the articles for [[:Category:My Country]] that contain Wiki Frequencies information as submitted by the members.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− |
| |
− |
| |
− | ....This example uses bogus names....
| |
− |
| |
− |
| |
− | To CATEGORIZE an article into this category, please add the following as the last line in the article:<br/>
| |
− | '''<nowiki>[[Category:</nowiki>My Country Frequencies<nowiki>]]</nowiki>'''
| |
− |
| |
− |
| |
− | Please do NOT edit this page unless you intend to change the Description of this Category. Thank you.
| |
− | <br/><br/>
| |
− | ----
| |
− | ----
| |
− |
| |
− | ====How to invoke this template for a State in another Country with Custom Message====
| |
− | *<nowiki>{{Cat_StateFreq|State=My State|FreqParent=My Country|MoreText=<br/><br/>>>>>This example uses bogus names<<<<<br/><br/>}}</nowiki>
| |
− | ----
| |
− | =====Result=====
| |
− | Welcome to the '''"Category:My State Frequencies"''' category. This category:
| |
− | *Is a sub-category of:
| |
− | **"[[:Category:My State]]",
| |
− | **"[[:Category:My Country Frequencies]]".
| |
− | *Lists all the articles for [[:Category:My State]] that contain My Country Frequencies information as submitted by the members.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− | 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.
| |
− |
| |
− |
| |
− |
| |
− |
| |
− | ....This example uses bogus names....
| |
− |
| |
− |
| |
− | To CATEGORIZE an article into this category, please add the following as the last line in the article:<br/>
| |
− | '''<nowiki>[[Category:</nowiki>My State Frequencies<nowiki>]]</nowiki>'''
| |
− |
| |
− |
| |
− | Please do NOT edit this page unless you intend to change the Description of this Category. Thank you.
| |
− | <br/><br/>
| |
− | ----
| |
− | ----
| |
− |
| |
− |
| |
− |
| |
− |
| |
− |
| |
− |
| |
− |
| |
− |
| |
− |
| |
− | Return to: [[:Template:Cat_StateFreq]]
| |