Actions

User

Difference between revisions of "QDP2012/29"

From The RadioReference Wiki

< User:QDP2012
m
m
 
(63 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{User:QDP2012/pages}}
+
<noinclude>{{User:QDP2012/pages}}</noinclude>
.
 
 
----
 
----
 
----
 
----
=Templates=
+
==Documentation Sub-page for Template:Text_CatStateOther==
==How templates can be useful==
+
===Scope of Use===
*Templates can act like a "rubber-stamp" and like a "cookie-cutter".
+
====Purpose====
*Wiki-page editors may create a template that contains commonly-used boiler-plate text, and use it repeatedly, like a rubber-stamp, in many different Wiki-articles.
+
*'''[[:Template:Text_CatStateOther]]''' is designed to be a "text"-template which:
*Wiki-page editors may use variables in templates, to create custom individualized results, but with a common behavior regardless of which article invokes the template.
+
**functions as the base upon which individual categories, and simpler categories-templates (that are related to RRDB entries) are built.
 +
***This creates a standardized presentation-style for the text displayed on all individual categories and all category-templates.  Exceptions should be few.
 +
**naturally applies to state-, county-, and country-based categories
 +
**is also intended to be used to create categories that are not state-, county-, or country-based, such as top-level theme-based categories.<br/><br/>
 +
*''(Please use'' '''''[[:Template:Text_CatStateOtherFreq]]''''' ''for "...Frequencies" related templates and categories.)''
 +
*''(Please use'' '''''[[:Template:Text_CatStateOtherNonRRDB]]''''' ''for templates and categories that are not related to RRDB entries.)''
  
==Template Documentation==
+
====Directly Invoked By====
*Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page.  The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes).  Example: [[:Template:Cat_State]]'s documentation is located at: [[:Template:Cat_State/doc]]
+
*'''[[:Template:Text_CatStateOther]]''' should be directly invoked only by
 +
**simpler categories-templates, that are related to RRDB entries, or
 +
**top-level theme-based categories, that are related to RRDB entries, or
 +
**individual categories, that are related to RRDB entries, for which a simpler categories-template does not exist.
  
==Template List==
+
====Not Intended For====
*Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list.
+
*'''[[:Template:Text_CatStateOther]]''' should not be directly invoked by anything other than "categories" pages, or simpler "categories"-templates, that are related to RRDB entries.<br/><br/>
*The grouping-by-purpose is reflected in the lists below.
+
*''(Please use'' '''''[[:Template:Text_CatStateOtherFreq]]''''' ''for "...Frequencies" related templates and categories.)''
 +
*''(Please use'' '''''[[:Template:Text_CatStateOtherNonRRDB]]''''' ''for templates and categories that are not related to RRDB entries.)''
  
===General Use Only===
+
===Parameters===
 +
*Specified values will override default values.
 +
*Specified values, Default values, and Parameter names are all case-sensitive.
 +
*'''''Please Note:'''''
 +
**For consistency and convenience, the parameter-names in the list below have been chosen to closely match the parameter-names used in '''[[:Template:Text_CatStateOtherFreq]]''' and '''[[:Template:Text_CatStateOtherNonRRDB]]'''. 
 +
**If parameter-names must be added or changed, please make the appropriate corresponding changes to '''[[:Template:Text_CatStateOtherFreq]]''' and '''[[:Template:Text_CatStateOtherNonRRDB]]''' also.  Please also update the related documentation pages, including [[:Template:Text_CatStateOther/doc/Compare]]
  
====Callsign-Related====
 
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"  
+
|- bgcolor="lightgrey" |
! Template Name !! Template Purpose
+
! Parameter Name  
 +
! colspan="2" | Parameter Details
 +
|- <!-- ***** parameter row ***** -->
 +
| '''State''' 
 +
| align="right" | Notes:
 +
| width="100%" |
 +
*{{color|red|A value is Required}}<br/>This template's use is not limited to politically-defined "states".  The parameter '''State''' can be assigned a theme-based value instead.  See any of  '''[[:Category:Special Topics]]'''' sub-categories for example.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''State2'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- bgcolor="lightyellow"
 +
| align="right" | Notes:
 +
||
 +
* When not specified, '''State''' value is used in the categories-list
 +
* When specified with a specific value, the specific value is used to override '''State''' in the categories-list, but not in the title.
 +
**'''State2''''s value should be the name of the '''State'''-category's primary parent, and should have a value very similar to '''State''''s value when possible.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| '''Other''' 
 +
| align="right" | Notes:
 +
||
 +
*{{color|red|A value is Required}} unless '''''BOTH''''' '''HideOtherInTitle''' and '''HideOtherInList''' are utilized to hide the value of '''Other'''
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Other2'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- bgcolor="lightyellow" 
 +
| align="right" | Notes:
 +
||
 +
* When not specified, '''Other''' value is used in the categories-list
 +
* When specified with a specific value, the specific value is used to override '''Other''' in the categories-list, but not in the title.
 +
*Also, see notes about parameter '''HideOtherInList'''
 +
 
 +
|-  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''OtherInState'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with a '''State'''-parameter related value.  Examples:
 +
** <tt>OtherInState=<nowiki>US {{{Agency}}} in {{{State}}}</nowiki>|</tt>
 +
** <tt>OtherInState=<nowiki>United States {{{MilBranch}}} in {{{State}}}</nowiki>|</tt>
 
|-
 
|-
| [[:Template:Callsign|Callsign]] || use this to link a callsign to RR's FCC DB
+
| align="right" | Notes:
 +
||
 +
*This overrides the value displayed in the title and the page's example category-statement. 
 +
*This does not influence the list of parent-categories. 
 +
*Values for '''State''' and '''Other''' still should be assigned appropriately.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Country'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value, followed by a non-breaking space ('''<tt>&amp;nbsp;</tt>''')
 +
** Example: <tt>Country=Canada&amp;nbsp;|</tt>
 +
|- bgcolor="lightyellow"
 +
| align="right" | Notes:
 +
||
 +
*This allows a country-name to be assigned as the prefix to the '''Other''' (or '''Other2''') value in the categories-list only.  It does not influence the value of '''Other''' (or '''Other2''') in the title.
 +
*When specified, the '''Country''' value is displayed in the categories-list immediately prior to the value of '''Other''' (or '''Other2''').
 +
*When not specified, no value is displayed.
 +
*Also, see notes about parameter '''HideOtherInList'''
 +
 
 +
|-  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Parent4'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- 
 +
| align="right" | Notes:
 +
||
 +
*When specified, the '''Parent4''' value is displayed in the categories-list.
 +
*When not specified, please use '''HideParent4''' to hide '''Parent4'''.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Parent5'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- bgcolor="lightyellow" 
 +
| align="right" | Notes:
 +
||
 +
*When specified, the '''Parent5''' value is displayed in the categories-list.
 +
*When not specified, please use '''HideParent5''' to hide '''Parent5'''.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Parent6'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|-
 +
| align="right" | Notes:
 +
||
 +
*When specified, the '''Parent6''' value is displayed in the categories-list.
 +
*When not specified, please use '''HideParent6''' to hide '''Parent6'''.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Parent7'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- bgcolor="lightyellow" 
 +
| align="right" | Notes:
 +
||
 +
*When specified, the '''Parent7''' value is displayed in the categories-list.
 +
*When not specified, please use '''HideParent7''' to hide '''Parent7'''.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''Articles'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value, that begins with a non-breaking space (<tt>&amp;nbsp;</tt>).  Example:
 +
**<tt>Articles=&amp;nbsp;that list amateur radio repeaters in {{{State}}},|</tt>
 +
|-
 +
| align="right" | Notes:
 +
||
 +
*Below the categories-list is the following statement (without quotes):<br/><br/>"Lists all the articles<tt>...</tt>as submitted by the members."<br/>
 +
**The <tt>...</tt> in the line quoted above represents the position of the default article-description which is (without quotes):<br/><br/>" for '''Category:State''' that contain '''Other''' information"<br/><br/>
 +
*When '''Articles''' is not specified, the default article-description is displayed.
 +
*When '''Articles''' is specified, the specific value replaces the default article-description.
 +
**'''{{color|red|Note:}}''' Usually, a non-breaking space ('''<tt>&amp;nbsp;</tt>''') should be used as the first character of the specific value.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''MoreText'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with specific value
 +
|- bgcolor="lightyellow" 
 +
| align="right" | Notes:
 +
||
 +
*When not specified, nothing is displayed
 +
*When specified, the specific value is displayed above the example category-statement, approximately in the middle of the page. 
 +
*Horizontal lines and html-breaks are often used to provide visual separation and bring attention to this parameter's value.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideOtherInTitle'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|-
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Other''' is displayed in the title
 +
* When specified with no value, the value of '''Other''' is not displayed in the title
 +
*Please do not assign a specific value to this parameter.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideOtherInList'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|- bgcolor="lightyellow" 
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Country''', if used, and the value of '''Other''' (or '''Other2''' if used) are displayed in the categories-list
 +
* When specified with no value, the value of '''Country''', if used, and the value of '''Other''' (or '''Other2''' if used) are not displayed in the categories-list
 +
*Please do not assign a specific value to this parameter.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideParent4'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|-
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Parent4''' is displayed
 +
* When specified with no value, the value of '''Parent4''' is not displayed
 +
*Please do not assign a specific value to this parameter.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideParent5'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|- bgcolor="lightyellow"
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Parent5''' is displayed
 +
* When specified with no value, the value of '''Parent5''' is not displayed
 +
*Please do not assign a specific value to this parameter.
 +
 
 +
|- <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideParent6'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|-
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Parent6''' is displayed
 +
* When specified with no value, the value of '''Parent6''' is not displayed
 +
*Please do not assign a specific value to this parameter.
 +
 
 +
|- bgcolor="lightyellow"  <!-- ***** parameter row ***** -->
 +
| rowspan="2" | '''HideParent7'''
 +
| align="right" | Expected Value(s):
 +
||
 +
* not specified '''''(Default value)'''''
 +
* specified with no value
 +
|- bgcolor="lightyellow"
 +
| align="right" | Notes:
 +
||
 +
* When not specified, the value of '''Parent7''' is displayed
 +
* When specified with no value, the value of '''Parent7''' is not displayed
 +
*Please do not assign a specific value to this parameter.
 +
 
 
|-
 
|-
| [[:Template:Callsignham|Callsignham]] || use this to link an amateur radio callsign to RR's FCC DB
+
|} <!-- end of parameter table -->
 +
 
 +
* Please note:
 +
**The entire list of user-specified parameters is listed here for convenient copy-pasting. 
 +
**Please read the above table for instruction, and see the examples later in this page, on how to use the appropriate parameters.
 +
**There will never be a case when all of the following parameters are used at the same time.  Only use the needed parameters.  Thanks.
 +
**Parameter "Parent3" is not listed here because its value is automatic, not user-specified.
 +
 
 +
<nowiki>{{</nowiki>Text_CatStateOther|
 +
State=|
 +
State2=|
 +
Other=|
 +
Other2=|
 +
OtherInState=|
 +
HideOtherInTitle=|
 +
HideOtherInList=|
 +
Country=|
 +
Articles=|
 +
MoreText=|
 +
Parent4=|
 +
Parent5=|
 +
Parent6=|
 +
Parent7=|
 +
HideParent3=|
 +
HideParent4=|
 +
HideParent5=|
 +
HideParent6=|
 +
HideParent7=<nowiki>}}</nowiki>
 +
 
 +
===Parameter-Use Examples: Categories-Templates===
 +
*Selected examples that illustrate various combinations of parameters:
 +
====Categories-Templates: Emergency Services====
 +
{| {{table}} width="100%"
 
|-
 
|-
| [[:Template:FRN|FRN]] || use this to link an FRN number to RR's FCC DB
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories-Templates: Emergency Services}}}'''
 +
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateFireSvcs|
 +
Params=State, Other, Country,<br/>HideParent4,&nbsp;HideParent5,<br/>HideParent6, HideParent7|
 +
StateEx=[[:Category:Texas_Fire_Services]]<br/>[[:Category:Canada_Fire_Services]]<br/>[[:Category:Ontario_Fire_Services]]|
 +
Similar=[[:Template:Cat_StateLawEnf]]<br/>[[:Template:Cat_StateMedical]]|
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateFireSvcsAv|
 +
Params=State, State2, Other, Country, Articles, HideParent3, Parent4, Parent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Texas_Fire_Services_Aviation]]|
 +
Similar=[[:Template:Cat_StateLawEnfAv]]<br/>[[:Template:Cat_StateMedAv]]
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====DB-Related====
+
====Categories-Templates: General Services====
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
 
|-
 
|-
| [[:Template:DB|DB]] || use this to link to a specific Frequency-Database page
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories-Templates: General Services}}}'''
|-
+
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
| [[:Template:DBSite|DBSite]] || use this to link a specific TRS tower-site in the Frequency-Database
+
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
|-
+
TmpltName=Cat_StateAv|
| [[:Template:Table_DBSite_Details|Table_DBSite_Details]] || this can be used to display tower-site related information in the Wiki.<br/>Example: [http://wiki.radioreference.com/index.php/WVIRP_Site_Info_%28WV%29 WVIRP_Site_Info_(WV)]
+
Params=State, Other, Country,<br/>HideParent4,&nbsp;HideParent5,<br/>HideParent6, HideParent7|
 +
StateEx=[[:Category:Texas_Aviation]]<br/>[[:Category:Bermuda_Aviation]]<br/>[[:Category:Canada_Aviation]]<br/>[[:Category:Ontario_Aviation]]|
 +
Similar=[[:Template:Cat_StateAmateur]]<br/>[[:Template:Cat_StateMjrEvtDis]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateAmateur|
 +
Params=State, State2, Other, Country, HideOtherInList, Articles, HideParent3, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Texas_Amateur_Radio]]<br/>[[:Category:Canada_Amateur_Radio]]<br/>[[:Category:British_Columbia_Amateur_Radio]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateBus|
 +
Params=State, Other, Country, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Texas_Businesses]]<br/>[[:Category:Canada_Businesses]]<br/>[[:Category:Ontario_Businesses]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateBusComPrv|
 +
Params=State, State2, Other, Country, MoreText, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:California_Communications_Providers]]<br/>[[:Category:Australia_Communications_Providers]]<br/>[[:Category:New_South_Wales_Communications_Providers]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateBusFastFood|
 +
Params=State, State2, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:New_York_Fast_Food]]<br/>[[:Category:Canada_Fast_Food]]<br/>[[:Category:Alberta_Fast_Food]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateCivilAv|
 +
Params=State, State2, Other, Country, Articles, MoreText, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Idaho_Civil_Aviation]]<br/>[[:Category:Canada_Civil_Aviation]]<br/>[[:Category:Nova_Scotia_Civil_Aviation]]|
 +
Similar=[[:Template:Cat_StateUtilComCar]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateCSX|
 +
Params=State, State2, Other, Country, Parent4, Parent5, Parent6, HideParent7|
 +
StateEx=[[:Category:Florida_CSX_Transportation]]<br/>[[:Category:Canada_CSX_Transportation]]<br/>[[:Category:Quebec_CSX_Transportation]]|
 +
Similar=[[:Template:Cat_StateUtilComCar]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateEduc|
 +
Params=State, Other, Country, Articles, HideParent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Michigan_Education]]|
 +
Similar=[[:Template:Cat_StateMedia]]<br/>[[:Template:Cat_StateSports]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateGrndTrans|
 +
Params=State. Other. Country. MoreText. HideParent4. HideParent5. HideParent6. HideParent7|
 +
StateEx=[[:Category:New_York_Ground_Transportation]]<br/>[[:Category:Canada_Ground_Transportation]]<br/>[[:Category:Quebec_Ground_Transportation]]|
 +
Similar=[[Template:Cat_StateMarine]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateMotorFrt|
 +
Params=State, State2, Other, Country, Articles, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:New_York_Motor_Freight]]<br/>[[:Category:Canada_Motor_Freight]]<br/>[[:Category:Quebec_Motor_Freight]]|
 +
Similar=[[:Template:Cat_StateRail]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateRecAtr|
 +
Params=State, Other, Country, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:North_Carolina_Recreation_or_Attractions]]<br/>[[:Category:Canada_Recreation_or_Attractions]]<br/>[[:Category:Alberta_Recreation_or_Attractions]]|
 +
Similar=[[Template:Cat_StateSpcEvts]]<br/>[[:Template:Cat_StateUtil]]<br/>[[:Template:Cat_StateWeather]]
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====DB-Sitemap-Related====
+
====Categories-Templates: Federal/Military Frequencies====
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:DBSiteMap_FCC|DBSiteMap_FCC]] || use this to display a link to a specific FCC site map in the RR Frequency-Database
 
 
|-
 
|-
| [[:Template:DBSiteMap_RR|DBSiteMap_RR]] || use this to display a link to a specific Radio Reference site map in the RR Frequency-Database
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories-Templates: Federal/Military Frequencies}}}'''
 +
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateAirShows|
 +
Params=State, State2, Other, Country, Parent4, Parent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:New York Air Shows]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateMilAv|
 +
Params=State. State2, Other, Country, Articles, MoreText, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:California Military Aviation]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_StateANG|
 +
Params=State, Other, Country, HideParent4,&nbsp;HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:Maryland Air National Guard]]|
 +
Similar=[[:Template:Cat_StateARNG]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_USFedInState|
 +
Params=OtherInState, Agency, State, Other, Other2, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:US Land Management in Nevada]]|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForTemp|
 +
TmpltName=Cat_USMilInState|
 +
Params=OtherInState, MilBranch, State, Other, Other2, Parent4, HideParent5, HideParent6, HideParent7|
 +
StateEx=[[:Category:United States Air Force in New York]]|
 +
Similar=
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====Forums-Related====
+
===Parameter-Use Examples: Categories===
*The base url for links to forums and threads has changed with time, making some old links invalid.  Using the templates below makes it easier to update all of the forum-links and thread-links to correspond to any future changes in the base url.
+
*Selected examples that illustrate various combinations of parameters:
 +
====Categories: Top-level "Themes"====
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Forum|Forum]] || use this to link to a specific Forum in the RR Forums.
 
 
|-
 
|-
| [[:Template:Thread|Thread]] || use this to link to a specific Thread within a Forum in the RR Forums.
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories: Top-level "Themes"}}}'''
 +
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=Air Shows|
 +
Params=State, State2, Other, HideOtherInTitle, Articles, Parent4, Parent5, HideParent6, HideParent7|
 +
Similar= [[:Category:Businesses]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=Amateur Radio|
 +
Params=State, Other, HideOtherInTitle, Articles, HideParent4,&nbsp;HideParent5, HideParent6, HideParent7|
 +
Similar=[[:Category:Education]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=Air National Guard|
 +
Params=State, Other, HideOtherInTitle, Parent4, HideParent5, HideParent6, HideParent7|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=Medical|
 +
Params=State, Other, HideOtherInTitle, HideParent4, HideParent5, HideParent6, HideParent7|
 +
Similar=
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=Railroads|
 +
Params=State, Other, HideOtherInTitle, Articles, HideParent4, HideParent5, HideParent6, HideParent7|
 +
Similar=
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====Infobox-Related====
+
====Categories: Aviation for a Specific Theme====
*Some InfoBoxes listed below are specific to Trunked Radio Systems, while others are specific to a particular geographical area, like a county or state.
 
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Infobox_TRS|Infobox_TRS]] || use this to create an InfoBox for a typical county-specific Trunked Radio System, in the U.S.
 
 
|-
 
|-
| [[:Template:Infobox_TRS_Canada|Infobox_TRS_Canada]] || use this to create an InfoBox for a typical Trunked Radio System in Canada.
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories: Aviation for a Specific Theme}}}'''
|-
+
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
| [[:Template:Infobox_TRS_MultiCounty|Infobox_TRS_MultiCounty]] || use this to create an InfoBox for a Trunked Radio System that spans multiple counties, in the U.S.
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
|-
+
CatName=Fire Services Aviation|
| [[:Template:Infobox_TRS_MultiState|Infobox_TRS_MultiState]] || use this to create an InfoBox for a Trunked Radio System that spans multiple states, in the U.S.
+
Params=State, Other, Articles, HideParent4,&nbsp;HideParent5, HideParent6, HideParent7|
|-
+
Similar=[[:Category:Law Enforcement Aviation]]<br/>[[:Category:Medical Aviation]]
| [[:Template:Infobox_TRS_Military|Infobox_TRS_Military]] || use this to create an InfoBox for a Trunked Radio System that is used primarily by the U.S. Military.  Typically these span multiple states.
+
}}
|-
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
| [[:Template:Infobox_TRS_Federal|Infobox_TRS_Federal]] || use this to create an InfoBox for a Trunked Radio System that is used primarily by the U.S. Federal Government
+
CatName=Military Aviation|
|-
+
Params=State, State2, Other, HideOtherInTitle, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7|
| [[:Template:Infobox_TRS_DC|Infobox_TRS_DC]] || use this to create an InfoBox for a Trunked Radio System located in the District of Columbia, in the U.S.
+
Similar=
|-
+
}}
| [[:Template:Infobox_TRS_MN|Infobox_TRS_MN]] || use this to create an InfoBox for a Trunked Radio System located in the state of Minnesota, in the U.S.
 
|-
 
| [[:Template:Infobox_TRS_WI|Infobox_TRS_WI]] || use this to create an InfoBox for a Trunked Radio System located in the state of Wisconsin, in the U.S.
 
|-
 
| [[:Template:Infobox_AB_County|Infobox_AB_County]] || use this to create an InfoBox for county-specific pages located in the province of Alberta, Canada
 
|-
 
| [[:Template:Infobox_IA|Infobox_IA]] || use this to create an InfoBox for pages located in the state of Iowa, in the U.S.
 
|-
 
| [[:Template:Infobox_IL|Infobox_IL]] || use this to create an InfoBox for pages located in the state of Illinois, in the U.S.
 
|-
 
| [[:Template:Infobox_MI|Infobox_MI]] || use this to create an InfoBox for pages located in the state of Michigan, in the U.S.
 
|-
 
| [[:Template:Infobox_MN|Infobox_MN]] || use this to create an InfoBox for pages located in the state of Minnesota, in the U.S.
 
|-
 
| [[:Template:Infobox_OH|Infobox_OH]] || use this to create an InfoBox for pages located in the state of Ohio, in the U.S.
 
|-
 
| [[:Template:Infobox_OK|Infobox_OK]] || use this to create an InfoBox for pages located in the state of Oklahoma, in the U.S.
 
|-
 
| [[:Template:Infobox_WI|Infobox_WI]] || use this to create an InfoBox for pages located in the state of Wisconsin, in the U.S.
 
 
|-
 
|-
 
|}
 
|}
  
====Tracker-Related====
+
====Categories: CSX Transportation====
*Tracker templates help make it easier to find articles, by use of the "What Links Here" feature.  These templates also display advisory-statements related to the specific type of radio system.
 
 
 
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Tracker_DMR|Tracker_DMR]] || apply this template to all DMR/MOTOTRBO articles.
 
|-
 
| [[:Template:Tracker_LTR|Tracker_LTR]] || apply this template to all LTR articles.
 
|-
 
| [[:Template:Tracker_MPT1327|Tracker_MPT1327]] || apply this template to all MPT1327 articles.
 
|-
 
| [[:Template:Tracker_NXDN|Tracker_NXDN]] || apply this template to all [[:Template:Tracker_NXDN|Tracker_NXDN]] articles.<br/>Please note, there is also a related category [[:Category:NXDN NEXEDGE]]
 
|-
 
| [[:Template:Tracker_OpenSky|Tracker_OpenSky]] || apply this template to all OpenSky articles.
 
 
|-
 
|-
| [[:Template:Tracker_Phase2|Tracker_Phase2]] || apply this template to all P25-Phase2 articles.
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Category:CSX Transportation}}}'''
|-
+
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
| [[:Template:Tracker_Provoice|Tracker_Provoice]] || apply this template to all Provoice articles.
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=CSX Transportation|
 +
Params=State, State2, Other, HideOtherInTitle, Articles, Parent4, Parent5, HideParent6,&nbsp;HideParent7|
 +
Similar=
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====Table-Related====
+
====Categories: US Agency====
*Warning: The table-templates are inconsistent in their syntax and implementation.  This will be corrected in the relatively-near future, and documented accordingly.
 
 
 
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Table|Table]] || use this to create a basic thin-line table
 
 
|-
 
|-
| [[:Template:Table_Sortable|Table_Sortable]] || use this to create a sortable-table (that has sort-arrows in each of the header-row's cells).
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Categories: US Agency Frequencies}}}'''
|-
+
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
| [[:Template:Table_SortableLarge|Table_SortableLarge]] || this is just like Template:Table_Sortable but is formatted to be full-width across the page.
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
|-
+
CatName=US Federal Government|
| [[:Template:Table_Pretty|Table_Pretty]] || this is similar to Template:Table except this is formatted to be (almost) full-width across the page.
+
Params=State, Other, HideOtherInTitle, MoreText, HideParent4,&nbsp;HideParent5, HideParent6, HideParent7|
|-
+
Similar=
| [[:Template:Table_ELTRfreqs|Table_ELTRfreqs]] || use this to display a table of LCN Frequencies for an LTR system
+
}}
|-
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
| [[:Template:Table_Trbosys|Table_Trbosys]] || use this to display a table of color codes and frequencies for a DMR/MOTOTRBO system
+
CatName=US Civil Air Patrol|
|-
+
Params=State, Other, HideOtherInTitle, Articles, Parent4, Parent5, Parent6, HideParent7|
| [[:Template:Table_Motofreqs|Table_Motofreqs]] || use this to display a table of frequencies for a site that is part of a DMR/MOTOTRBO system
+
Similar=
|-
+
}}
| [[:Template:Table_DBSite_Details|Table_DBSite_Details]] || this can be used to display tower-site related information in the Wiki.<br/>Example: [http://wiki.radioreference.com/index.php/WVIRP_Site_Info_%28WV%29 WVIRP_Site_Info_(WV)]
+
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=US Federal Prisons|
 +
Params=State, Other, HideOtherInTitle, HideParent4, HideParent5, HideParent6, HideParent7|
 +
Similar=[[:Category:US Bureau of Reclamation]]
 +
}}
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=US Land Management|
 +
Params=State, Other, HideOtherInTitle, Parent4, HideParent5, HideParent6, HideParent7|
 +
Similar=
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====Text-Related====
+
====Categories: United States Military Branch====
*These templates either display boilerplate text, or change the appearance (font, color, etc.) of text.
 
 
{| {{table}} width="100%"
 
{| {{table}} width="100%"
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Color|Color]] || use this to set the color of the designated text.
 
|-
 
| [[:Template:Text_Airshow|Text_Airshow]] || use this to build an air-show specific article
 
|-
 
| [[:Template:Text_Deprecated|Text_Deprecated]] || use this on every article that corresponds to a system that has been marked "Deprecated" in the Frequency-Database
 
|-
 
| [[:Template:Text_DeprecatedStateTRS|Text_DeprecatedStateTRS]] || use this to display the appropriate text on a "(state) Deprecated Trunked Systems" category-page.
 
|-
 
| [[:Template:Text_Disambiguation|Text_Disambiguation]] || use this to build disambiguation articles.
 
|-
 
| [[:Template:Text_ListOfWhatDisplaysRIDUIDs|Text_ListOfWhatDisplaysRIDUIDs]] || this lists the resources that are capable of displaying RIDs and UIDs; and displays that list in the RID/UID-related category-pages.
 
|-
 
| [[:Template:Text_MTairshow|Text_MTairshow]] || use this on AirShow related pages to display a link to an Air Show Guide
 
|-
 
| [[:Template:Text_Sortable|Text_Sortable]] || use this as needed in the proximity of a sortable-table to explain how to sort the table.
 
 
|-
 
|-
| [[:Template:Text_TalkInForumsPlease|Text_TalkInForumsPlease]] || use this only on "Talk:" pages, to remind Wiki-users that discussions should be in the Forums.
+
| colspan="2" bgcolor="darkblue" align="left" | '''{{Color|white|Category:United States Air Force Frequencies}}}'''
 +
| bgcolor="yellow" align="center" | '''Parameters&nbsp;used'''
 +
{{Text_CatStateOtherFreq/doc/TblRowForCat|
 +
CatName=United States Air Force|
 +
Params=State, Other, HideOtherInTitle, HideParent4,&nbsp;HideParent5, HideParent6, HideParent7|
 +
Similar=[[:Category:United States Army]]<br/>[[:Category:United States Coast Guard]]<br/>[[:Category:United States Navy]]
 +
}}
 
|-
 
|-
 
|}
 
|}
  
====Map-Related====
+
===How To...===
{| {{table}} width="100%"
+
*The horizontal lines below separate examples for clarity and do not appear when template is invoked.
|- bgcolor="lightgrey"
+
----
! Template Name !! Template Purpose
+
----
|-  
+
 
| [[:Template:Geographic_Location|Geographic_Location]] || use this to display a "compass" that shows relative-direction to neighboring entities, and link to them.
+
====How to invoke this template for a simpler (state) TEMPLATE====
|-  
+
*'''Template_CatStateFreq''' is an example of a simpler category-template that is used to build state-level, district-level, province-level, or country-level, categories:
| [[:Template:Map_US_and_CA|Map_US_and_CA]] || displays a US/Canada map with clickable links to state-level categories.
+
<nowiki>{{Text_CatStateOther|
|-  
+
State={{{State}}}|
| [[:Template:Map_CT_Counties|Map_CT_Counties]] || displays a map of Connecticut's counties
+
Other={{{FreqParent|Wiki}}}|
|-  
+
HideOtherInTitle=|
| [[:Template:Map_MN_Counties|Map_MN_Counties]] || displays a map of Minnesota's counties
+
MoreText={{{MoreText|}}}|
|-  
+
HideParent4=|
| [[:Template:Map_OH_Counties|Map_OH_Counties]] || displays a map of Ohio's counties
+
HideParent5=|
|-
+
HideParent6=|
|}
+
HideParent7=}}</nowiki>
 +
----
 +
=====Result=====
 +
*See [[:Template:Cat_State]] for the actual category-template.
 +
 
 +
----
 +
----
 +
 
 +
====How to invoke this template for a simpler US (Agency) in (State) TEMPLATE====
 +
*'''Template:Cat_USFedInState''' is an example of a simpler category-template that is used to build (US Federal Government) agency-level categories:
 +
<nowiki>{{Text_CatStateOther|
 +
OtherInState=US {{{Agency}}} in {{{State}}}|
 +
Other={{{Agency}}}|
 +
State={{{State}}}|
 +
Other2=US {{{Agency}}}|
 +
Parent4=US {{{Agency}}} in {{{State}}}|
 +
HideParent5=|
 +
HideParent6=|
 +
HideParent7=}}</nowiki>
 +
----
 +
=====Result=====
 +
* See [[:Template:Cat_USFedInState]] for the actual category-template.
 +
----
 +
----
 +
 
 +
====How to invoke this template for a simpler United States (MilBranch) in (State) TEMPLATE====
 +
*'''Template:Cat_USMilInState''' is an example of a simpler category-template that is used to build (United States Military) Branch-level categories:
 +
<nowiki>{{Text_CatStateOther|
 +
OtherInState=United States {{{MilBranch}}} in {{{State}}}|
 +
Other={{{MilBranch}}}|
 +
State={{{State}}}|
 +
Other2=United States {{{MilBranch}}}|
 +
Parent4=United States {{{MilBranch}}} in {{{State}}}|
 +
HideParent5=|
 +
HideParent6=|
 +
HideParent7=}}</nowiki>
 +
----
 +
=====Result=====
 +
* See [[:Template:Cat_USMilInState]] for the actual category-template.
 +
----
 +
----
 +
 
 +
====How to invoke this template for a (theme) CATEGORY====
 +
*'''Category:Air_National_Guard''' is an example of a Theme-level category:
 +
<nowiki>{{Text_CatStateOther|
 +
State=Air National Guard|
 +
Other=United States Air Force|
 +
HideOtherInTitle=|
 +
Parent4=Military Aviation|
 +
HideParent5=|
 +
HideParent6=|
 +
HideParent7=|}}</nowiki>
 +
----
 +
=====Result=====
 +
* See [[:Category:Air_National_Guard]] for the actual category.
 +
----
 +
----
 +
 
 +
====How to avoid common error(s) while invoking this template====
 +
*'''Purpose: To avoid unintended spaces in parameter-values'''
 +
**'''Technique:''' Place the vertical bar at end of parameter-value, not at left-margin.
 +
 
 +
 
 +
*'''Purpose: To correctly assign no-value to a parameter'''
 +
**'''Technique:''' Place the vertical bar at end of parameter-value, not at left-margin.
 +
 
 +
 
 +
*'''Purpose: To avoid confusion with template's closing braces'''
 +
**'''Technique:''' Put "Hide..." parameters at end of template-call to help ensure the closing braces are used and not confused with the value of another parameter.
 +
 
 +
 
 +
*'''Example:''' [[:Category:Air_National_Guard]]
 +
**The following template-code is correct, because
 +
*#The vertical-bar ends immediately after each parameter-value, or immediately after an equal-sign thereby indicating "no value":
 +
*#The template's closing pair of braces immediately follows the last parameter-value and is not on a separate line where it could become confusing and orphaned or even deleted during later editing.
 +
*#The "HideParent..." parameters are placed at the end and immediately followed by the template's closing braces.  This becomes more apparent when using parameters "Articles" and "MoreText".
 +
<nowiki>{{Text_CatStateOther|
 +
State=Air National Guard|
 +
Other=United States Air Force|
 +
HideOtherInTitle=|
 +
Parent4=Military Aviation Frequencies|
 +
HideParent5=|
 +
HideParent6=|
 +
HideParent7=}}</nowiki>
 +
 
 +
:*The following template-code is '''''not correct''''', because it introduces unintended spaces and risks the closing braces becoming orphaned, lost, or deleted during later editing, especially if values are assigned later to parameters "'''Articles'''" and/or "'''MoreText'''":
 +
<nowiki>{{Text_CatStateOther
 +
|State=Air National Guard
 +
|Other=United States Air Force
 +
|HideOtherInTitle=
 +
|Parent4=Military Aviation Frequencies
 +
|HideParent5=
 +
|HideParent6=
 +
|HideParent7=
 +
}}</nowiki>
 +
 
 +
----
 +
----
 +
 
  
====Category-Related====
 
=====Category-Related: States or Provinces=====
 
*These templates are used to create state-specific categories, and state-specific "...Frequency" categories.
 
{| {{table}} width="100%"
 
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Cat_State|Cat_State]] || used to create a state's primary category<br/>Examples: [[:Category:Ohio]], [[:Category:Ontario]]
 
|-
 
| [[:Template:Cat_StateFreq|Cat_StateFreq]] || used to create a state's primary "...Frequency" category.<br/>Examples: [[:Category:Ohio Frequencies]], [[:Category:Ontario Frequencies]]
 
|-
 
|}
 
  
=====Category-Related: Emergency Services=====
 
*These templates are used to create state-specific categories, and state-specific "...Frequency" categories, that are related to emergency services.
 
{| {{table}} width="100%"
 
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Cat_StateBrevCd|Cat_StateBrevCd]] || use this to create state-specific "(state) Brevity Codes" categories
 
|-
 
| [[:Template:Cat_StateFireSvcs|Cat_StateFireSvcs]] || use this to create state-specific "(state) Fire Services" categories
 
|-
 
| [[:Template:Cat_StateFireSvcsFreq|Cat_StateFireSvcsFreq]] || use this to create state-specific "(state) Fire Services Frequencies" categories
 
|-
 
| [[:Template:Cat_StateFireSvcsAv|Cat_StateFireSvcsAv]] || use this to create state-specific "(state) Fire Services Aviation" categories
 
|-
 
| [[:Template:Cat_StateFireSvcsAvFreq|Cat_StateFireSvcsAvFreq]] || use this to create state-specific "(state) Fire Services Aviation Frequencies" categories
 
|-
 
| [[:Template:Cat_StateFTO|Cat_StateFTO]] || use this to create state-specific "(state) Fire Tone Outs" categories
 
|-
 
| [[:Template:Cat_StateLawEnf|Cat_StateLawEnf]] || use this to create state-specific "(state) Law Enforcement" categories
 
|-
 
| [[:Template:Cat_StateLawEnfFreq|Cat_StateLawEnfFreq]] || use this to create state-specific "(state) Law Enforcement Frequencies" categories
 
|-
 
| [[:Template:Cat_StateLawEnfAv|Cat_StateLawEnfAv]] || use this to create state-specific "(state) Law Enforcement Aviation" categories
 
|-
 
| [[:Template:Cat_StateLawEnfAvFreq|Cat_StateLawEnfAvFreq]] || use this to create state-specific "(state) Law Enforcement Aviation Frequencies" categories
 
|-
 
| [[:Template:Cat_StateMedical|Cat_StateMedical]] || use this to create state-specific "(state) Medical" categories
 
|-
 
| [[:Template:Cat_StateMedicalFreq|Cat_StateMedicalFreq]] || use this to create state-specific "(state) Medical Frequencies" categories
 
|-
 
| [[:Template:Cat_StateMedAv|Cat_StateMedAv]] || use this to create state-specific "(state) Medical Aviation" categories
 
|-
 
| [[:Template:Cat_StateMedAvFreq|Cat_StateMedAvFreq]] || use this to create state-specific "(state) Medical Aviation Frequencies" categories
 
|-
 
| [[:Template:Cat_StateStnIDs|Cat_StateStnIDs]] || use this to create state-specific "(state) System IDs" categories.<br/>(Please note: System IDs are the "Radio ID's" used over the air; not the TRS-related RID/UIDs, for which there is a different template.)
 
|-
 
|}
 
  
=====Category-Related: General Services=====
 
  
=====Category-Related: Federal/Military=====
 
  
=====Category-Related: Trunked Radio Systems=====
 
  
=====Category-Related: Used To Make Other Category-Templates=====
+
Return to: [[:Template:Text_CatStateOther]], [[:Template:Text_CatStateOther/doc/Compare]]
*These templates are used to create state-specific categories, state-specific sub-categories, or state-specific category-templates listed above.
 
{| {{table}} width="100%"
 
|- bgcolor="lightgrey"
 
! Template Name !! Template Purpose
 
|-
 
| [[:Template:Text_CatStateOther|Text_CatStateOther]] || used for primary (non-frequency) category-template
 
|-
 
| [[:Template:Text_CatStateOtherFreq|Text_CatStateOtherFreq]] || used for "...Frequency" category-templates
 
|-
 
| [[:Template:Text_CatGeneral|Text_CatGeneral]] || used to display the mid-section of boilerplate text, with optional custom message.
 
|-
 
|}
 
  
===Sets of Related Pages===
+
[[Category:Documentation]]

Latest revision as of 04:48, 16 July 2016


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:Text_CatStateOther

Scope of Use

Purpose

  • Template:Text_CatStateOther is designed to be a "text"-template which:
    • functions as the base upon which individual categories, and simpler categories-templates (that are related to RRDB entries) are built.
      • This creates a standardized presentation-style for the text displayed on all individual categories and all category-templates. Exceptions should be few.
    • naturally applies to state-, county-, and country-based categories
    • is also intended to be used to create categories that are not state-, county-, or country-based, such as top-level theme-based categories.

  • (Please use Template:Text_CatStateOtherFreq for "...Frequencies" related templates and categories.)
  • (Please use Template:Text_CatStateOtherNonRRDB for templates and categories that are not related to RRDB entries.)

Directly Invoked By

  • Template:Text_CatStateOther should be directly invoked only by
    • simpler categories-templates, that are related to RRDB entries, or
    • top-level theme-based categories, that are related to RRDB entries, or
    • individual categories, that are related to RRDB entries, for which a simpler categories-template does not exist.

Not Intended For

Parameters

Parameter Name Parameter Details
State Notes:
  • A value is Required
    This template's use is not limited to politically-defined "states". The parameter State can be assigned a theme-based value instead. See any of Category:Special Topics' sub-categories for example.
State2 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When not specified, State value is used in the categories-list
  • When specified with a specific value, the specific value is used to override State in the categories-list, but not in the title.
    • State2's value should be the name of the State-category's primary parent, and should have a value very similar to State's value when possible.
Other Notes:
  • A value is Required unless BOTH HideOtherInTitle and HideOtherInList are utilized to hide the value of Other
Other2 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When not specified, Other value is used in the categories-list
  • When specified with a specific value, the specific value is used to override Other in the categories-list, but not in the title.
  • Also, see notes about parameter HideOtherInList
OtherInState Expected Value(s):
  • not specified (Default value)
  • specified with a State-parameter related value. Examples:
    • OtherInState=US {{{Agency}}} in {{{State}}}|
    • OtherInState=United States {{{MilBranch}}} in {{{State}}}|
Notes:
  • This overrides the value displayed in the title and the page's example category-statement.
  • This does not influence the list of parent-categories.
  • Values for State and Other still should be assigned appropriately.
Country Expected Value(s):
  • not specified (Default value)
  • specified with specific value, followed by a non-breaking space (&nbsp;)
    • Example: Country=Canada&nbsp;|
Notes:
  • This allows a country-name to be assigned as the prefix to the Other (or Other2) value in the categories-list only. It does not influence the value of Other (or Other2) in the title.
  • When specified, the Country value is displayed in the categories-list immediately prior to the value of Other (or Other2).
  • When not specified, no value is displayed.
  • Also, see notes about parameter HideOtherInList
Parent4 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When specified, the Parent4 value is displayed in the categories-list.
  • When not specified, please use HideParent4 to hide Parent4.
Parent5 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When specified, the Parent5 value is displayed in the categories-list.
  • When not specified, please use HideParent5 to hide Parent5.
Parent6 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When specified, the Parent6 value is displayed in the categories-list.
  • When not specified, please use HideParent6 to hide Parent6.
Parent7 Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When specified, the Parent7 value is displayed in the categories-list.
  • When not specified, please use HideParent7 to hide Parent7.
Articles Expected Value(s):
  • not specified (Default value)
  • specified with specific value, that begins with a non-breaking space (&nbsp;). Example:
    • Articles=&nbsp;that list amateur radio repeaters in {{{State}}},|
Notes:
  • Below the categories-list is the following statement (without quotes):

    "Lists all the articles...as submitted by the members."
    • The ... in the line quoted above represents the position of the default article-description which is (without quotes):

      " for Category:State that contain Other information"

  • When Articles is not specified, the default article-description is displayed.
  • When Articles is specified, the specific value replaces the default article-description.
    • Note: Usually, a non-breaking space (&nbsp;) should be used as the first character of the specific value.
MoreText Expected Value(s):
  • not specified (Default value)
  • specified with specific value
Notes:
  • When not specified, nothing is displayed
  • When specified, the specific value is displayed above the example category-statement, approximately in the middle of the page.
  • Horizontal lines and html-breaks are often used to provide visual separation and bring attention to this parameter's value.
HideOtherInTitle Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Other is displayed in the title
  • When specified with no value, the value of Other is not displayed in the title
  • Please do not assign a specific value to this parameter.
HideOtherInList Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Country, if used, and the value of Other (or Other2 if used) are displayed in the categories-list
  • When specified with no value, the value of Country, if used, and the value of Other (or Other2 if used) are not displayed in the categories-list
  • Please do not assign a specific value to this parameter.
HideParent4 Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Parent4 is displayed
  • When specified with no value, the value of Parent4 is not displayed
  • Please do not assign a specific value to this parameter.
HideParent5 Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Parent5 is displayed
  • When specified with no value, the value of Parent5 is not displayed
  • Please do not assign a specific value to this parameter.
HideParent6 Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Parent6 is displayed
  • When specified with no value, the value of Parent6 is not displayed
  • Please do not assign a specific value to this parameter.
HideParent7 Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Parent7 is displayed
  • When specified with no value, the value of Parent7 is not displayed
  • Please do not assign a specific value to this parameter.
  • Please note:
    • The entire list of user-specified parameters is listed here for convenient copy-pasting.
    • Please read the above table for instruction, and see the examples later in this page, on how to use the appropriate parameters.
    • There will never be a case when all of the following parameters are used at the same time. Only use the needed parameters. Thanks.
    • Parameter "Parent3" is not listed here because its value is automatic, not user-specified.
{{Text_CatStateOther|
State=|
State2=|
Other=|
Other2=|
OtherInState=|
HideOtherInTitle=|
HideOtherInList=|
Country=|
Articles=|
MoreText=|
Parent4=|
Parent5=|
Parent6=|
Parent7=|
HideParent3=|
HideParent4=|
HideParent5=|
HideParent6=|
HideParent7=}}

Parameter-Use Examples: Categories-Templates

  • Selected examples that illustrate various combinations of parameters:

Categories-Templates: Emergency Services

Categories-Templates: Emergency Services} Parameters used
Categories-Template example: Template:Cat_StateFireSvcs State, Other, Country,
HideParent4, HideParent5,
HideParent6, HideParent7
State-specific example(s): Category:Texas_Fire_Services
Category:Canada_Fire_Services
Category:Ontario_Fire_Services
   Template(s) with similar syntax: Template:Cat_StateLawEnf
Template:Cat_StateMedical
Categories-Template example: Template:Cat_StateFireSvcsAv State, State2, Other, Country, Articles, HideParent3, Parent4, Parent5, HideParent6, HideParent7
State-specific example(s): Category:Texas_Fire_Services_Aviation
   Template(s) with similar syntax: Template:Cat_StateLawEnfAv
Template:Cat_StateMedAv

Categories-Templates: General Services

Categories-Templates: General Services} Parameters used
Categories-Template example: Template:Cat_StateAv State, Other, Country,
HideParent4, HideParent5,
HideParent6, HideParent7
State-specific example(s): Category:Texas_Aviation
Category:Bermuda_Aviation
Category:Canada_Aviation
Category:Ontario_Aviation
   Template(s) with similar syntax: Template:Cat_StateAmateur
Template:Cat_StateMjrEvtDis
Categories-Template example: Template:Cat_StateAmateur State, State2, Other, Country, HideOtherInList, Articles, HideParent3, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:Texas_Amateur_Radio
Category:Canada_Amateur_Radio
Category:British_Columbia_Amateur_Radio
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateBus State, Other, Country, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:Texas_Businesses
Category:Canada_Businesses
Category:Ontario_Businesses
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateBusComPrv State, State2, Other, Country, MoreText, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:California_Communications_Providers
Category:Australia_Communications_Providers
Category:New_South_Wales_Communications_Providers
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateBusFastFood State, State2, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:New_York_Fast_Food
Category:Canada_Fast_Food
Category:Alberta_Fast_Food
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateCivilAv State, State2, Other, Country, Articles, MoreText, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:Idaho_Civil_Aviation
Category:Canada_Civil_Aviation
Category:Nova_Scotia_Civil_Aviation
   Template(s) with similar syntax: Template:Cat_StateUtilComCar
Categories-Template example: Template:Cat_StateCSX State, State2, Other, Country, Parent4, Parent5, Parent6, HideParent7
State-specific example(s): Category:Florida_CSX_Transportation
Category:Canada_CSX_Transportation
Category:Quebec_CSX_Transportation
   Template(s) with similar syntax: Template:Cat_StateUtilComCar
Categories-Template example: Template:Cat_StateEduc State, Other, Country, Articles, HideParent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:Michigan_Education
   Template(s) with similar syntax: Template:Cat_StateMedia
Template:Cat_StateSports
Categories-Template example: Template:Cat_StateGrndTrans State. Other. Country. MoreText. HideParent4. HideParent5. HideParent6. HideParent7
State-specific example(s): Category:New_York_Ground_Transportation
Category:Canada_Ground_Transportation
Category:Quebec_Ground_Transportation
   Template(s) with similar syntax: Template:Cat_StateMarine
Categories-Template example: Template:Cat_StateMotorFrt State, State2, Other, Country, Articles, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:New_York_Motor_Freight
Category:Canada_Motor_Freight
Category:Quebec_Motor_Freight
   Template(s) with similar syntax: Template:Cat_StateRail
Categories-Template example: Template:Cat_StateRecAtr State, Other, Country, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:North_Carolina_Recreation_or_Attractions
Category:Canada_Recreation_or_Attractions
Category:Alberta_Recreation_or_Attractions
   Template(s) with similar syntax: Template:Cat_StateSpcEvts
Template:Cat_StateUtil
Template:Cat_StateWeather

Categories-Templates: Federal/Military Frequencies

Categories-Templates: Federal/Military Frequencies} Parameters used
Categories-Template example: Template:Cat_StateAirShows State, State2, Other, Country, Parent4, Parent5, HideParent6, HideParent7
State-specific example(s): Category:New York Air Shows
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateMilAv State. State2, Other, Country, Articles, MoreText, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:California Military Aviation
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_StateANG State, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:Maryland Air National Guard
   Template(s) with similar syntax: Template:Cat_StateARNG
Categories-Template example: Template:Cat_USFedInState OtherInState, Agency, State, Other, Other2, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:US Land Management in Nevada
   Template(s) with similar syntax:
Categories-Template example: Template:Cat_USMilInState OtherInState, MilBranch, State, Other, Other2, Parent4, HideParent5, HideParent6, HideParent7
State-specific example(s): Category:United States Air Force in New York
   Template(s) with similar syntax:

Parameter-Use Examples: Categories

  • Selected examples that illustrate various combinations of parameters:

Categories: Top-level "Themes"

Categories: Top-level "Themes"} Parameters used
Categories example: Category:Air Shows State, State2, Other, HideOtherInTitle, Articles, Parent4, Parent5, HideParent6, HideParent7
   Categories with similar syntax: Category:Businesses
Categories example: Category:Amateur Radio State, Other, HideOtherInTitle, Articles, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax: Category:Education
Categories example: Category:Air National Guard State, Other, HideOtherInTitle, Parent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:
Categories example: Category:Medical State, Other, HideOtherInTitle, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:
Categories example: Category:Railroads State, Other, HideOtherInTitle, Articles, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:

Categories: Aviation for a Specific Theme

Categories: Aviation for a Specific Theme} Parameters used
Categories example: Category:Fire Services Aviation State, Other, Articles, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax: Category:Law Enforcement Aviation
Category:Medical Aviation
Categories example: Category:Military Aviation State, State2, Other, HideOtherInTitle, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:

Categories: CSX Transportation

Category:CSX Transportation} Parameters used
Categories example: Category:CSX Transportation State, State2, Other, HideOtherInTitle, Articles, Parent4, Parent5, HideParent6, HideParent7
   Categories with similar syntax:

Categories: US Agency

Categories: US Agency Frequencies} Parameters used
Categories example: Category:US Federal Government State, Other, HideOtherInTitle, MoreText, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:
Categories example: Category:US Civil Air Patrol State, Other, HideOtherInTitle, Articles, Parent4, Parent5, Parent6, HideParent7
   Categories with similar syntax:
Categories example: Category:US Federal Prisons State, Other, HideOtherInTitle, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax: Category:US Bureau of Reclamation
Categories example: Category:US Land Management State, Other, HideOtherInTitle, Parent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax:

Categories: United States Military Branch

Category:United States Air Force Frequencies} Parameters used
Categories example: Category:United States Air Force State, Other, HideOtherInTitle, HideParent4, HideParent5, HideParent6, HideParent7
   Categories with similar syntax: Category:United States Army
Category:United States Coast Guard
Category:United States Navy

How To...

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


How to invoke this template for a simpler (state) TEMPLATE

  • Template_CatStateFreq is an example of a simpler category-template that is used to build state-level, district-level, province-level, or country-level, categories:
{{Text_CatStateOther|
State={{{State}}}|
Other={{{FreqParent|Wiki}}}|
HideOtherInTitle=|
MoreText={{{MoreText|}}}|
HideParent4=|
HideParent5=|
HideParent6=|
HideParent7=}}

Result


How to invoke this template for a simpler US (Agency) in (State) TEMPLATE

  • Template:Cat_USFedInState is an example of a simpler category-template that is used to build (US Federal Government) agency-level categories:
{{Text_CatStateOther|
OtherInState=US {{{Agency}}} in {{{State}}}|
Other={{{Agency}}}|
State={{{State}}}|
Other2=US {{{Agency}}}|
Parent4=US {{{Agency}}} in {{{State}}}|
HideParent5=|
HideParent6=|
HideParent7=}}

Result


How to invoke this template for a simpler United States (MilBranch) in (State) TEMPLATE

  • Template:Cat_USMilInState is an example of a simpler category-template that is used to build (United States Military) Branch-level categories:
{{Text_CatStateOther|
OtherInState=United States {{{MilBranch}}} in {{{State}}}|
Other={{{MilBranch}}}|
State={{{State}}}|
Other2=United States {{{MilBranch}}}|
Parent4=United States {{{MilBranch}}} in {{{State}}}|
HideParent5=|
HideParent6=|
HideParent7=}}

Result


How to invoke this template for a (theme) CATEGORY

  • Category:Air_National_Guard is an example of a Theme-level category:
{{Text_CatStateOther|
State=Air National Guard|
Other=United States Air Force|
HideOtherInTitle=|
Parent4=Military Aviation|
HideParent5=|
HideParent6=|
HideParent7=|}}

Result


How to avoid common error(s) while invoking this template

  • Purpose: To avoid unintended spaces in parameter-values
    • Technique: Place the vertical bar at end of parameter-value, not at left-margin.


  • Purpose: To correctly assign no-value to a parameter
    • Technique: Place the vertical bar at end of parameter-value, not at left-margin.


  • Purpose: To avoid confusion with template's closing braces
    • Technique: Put "Hide..." parameters at end of template-call to help ensure the closing braces are used and not confused with the value of another parameter.


  • Example: Category:Air_National_Guard
    • The following template-code is correct, because
    1. The vertical-bar ends immediately after each parameter-value, or immediately after an equal-sign thereby indicating "no value":
    2. The template's closing pair of braces immediately follows the last parameter-value and is not on a separate line where it could become confusing and orphaned or even deleted during later editing.
    3. The "HideParent..." parameters are placed at the end and immediately followed by the template's closing braces. This becomes more apparent when using parameters "Articles" and "MoreText".
{{Text_CatStateOther|
State=Air National Guard|
Other=United States Air Force|
HideOtherInTitle=|
Parent4=Military Aviation Frequencies|
HideParent5=|
HideParent6=|
HideParent7=}}
  • The following template-code is not correct, because it introduces unintended spaces and risks the closing braces becoming orphaned, lost, or deleted during later editing, especially if values are assigned later to parameters "Articles" and/or "MoreText":
{{Text_CatStateOther
|State=Air National Guard
|Other=United States Air Force
|HideOtherInTitle=
|Parent4=Military Aviation Frequencies
|HideParent5=
|HideParent6=
|HideParent7=
}}





Return to: Template:Text_CatStateOther, Template:Text_CatStateOther/doc/Compare