Actions

User

QDP2012/29

From The RadioReference Wiki

< User:QDP2012

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