Text CatStateOtherFreq/doc
From The RadioReference Wiki
< Template:Text CatStateOtherFreq
Contents
- 1 Documentation Sub-page for Template:Text_CatStateOtherFreq
- 1.1 Scope of Use
- 1.2 Parameters
- 1.3 Parameter-Use Examples: Categories-Templates
- 1.4 Parameter-Use Examples: Categories
- 1.5 How To...
- 1.5.1 How to invoke this template for a simpler (state) frequencies TEMPLATE
- 1.5.2 How to invoke this template for a simpler US (Agency) Frequencies in (State) TEMPLATE
- 1.5.3 How to invoke this template for a simpler United States (MilBranch) Frequencies in (State) TEMPLATE
- 1.5.4 How to invoke this template for a (theme) frequencies CATEGORY
- 1.5.5 How to avoid common error(s) while invoking this template
Documentation Sub-page for Template:Text_CatStateOtherFreq
Scope of Use
Purpose
- Template:Text_CatStateOtherFreq is designed to be a "text"-template which:
- functions as the base upon which individual "...Frequencies" categories, and simpler "...Frequencies" categories-templates are built.
- This creates a standardized presentation-style for the text displayed on all individual "...Frequencies" categories and all "...Frequencies" category-templates. Exceptions should be few.
- naturally applies to state-, county-, and country-based "...Frequencies" categories
- is also intended to be used to create "...Frequencies" categories that are not state-, county-, or country-based, such as top-level theme-based "...Frequencies" categories.
- functions as the base upon which individual "...Frequencies" categories, and simpler "...Frequencies" categories-templates are built.
Directly Invoked By
- Template:Text_CatStateOtherFreq should be directly invoked only by
- simpler "...Frequencies" categories-templates, or
- top-level theme-based "...Frequencies" categories, or
- individual "...Frequencies" categories for which a simpler "...Frequencies" categories-template does not exist.
Not Intended For
- Template:Text_CatStateOtherFreq should not be directly invoked by anything other than "...Frequencies" "categories" pages, or simpler "...Frequencies" "categories"-templates.
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_CatStateOther and Template:Text_CatStateOtherNonRRDB.
- If parameter-names must be added or changed, please make the appropriate corresponding changes to Template:Text_CatStateOther and Template:Text_CatStateOtherNonRRDB also. Please also update the related documentation pages, including Template:Text_CatStateOther/doc/Compare
Parameter Name | Parameter Details | |
---|---|---|
State | Notes: |
|
State2 | Expected Value(s): |
|
Notes: |
| |
StateParentNotFreq | Expected Value(s): |
|
Notes: |
| |
Other | Notes: |
|
Other2 | Expected Value(s): |
|
Notes: |
| |
OtherIsNotFreq | Expected Value(s): |
|
Notes: |
| |
OtherFreqInState | Expected Value(s): |
|
Notes: |
| |
Country | Expected Value(s): |
|
Notes: |
| |
Parent3 | Automatic Value(s): |
Using values from parameters above, either:
|
Notes: |
| |
Parent4 | Expected Value(s): |
|
Notes: |
| |
Parent5 | Expected Value(s): |
|
Notes: |
| |
Parent6 | Expected Value(s): |
|
Notes: |
| |
Parent7 | Expected Value(s): |
|
Notes: |
| |
Articles | Expected Value(s): |
|
Notes: |
| |
MoreText | Expected Value(s): |
|
Notes: |
| |
HideOtherInTitle | Expected Value(s): |
|
Notes: |
| |
HideOtherInList | Expected Value(s): |
|
Notes: |
| |
HideParent3 | Expected Value(s): |
|
Notes: |
| |
HideParent4 | Expected Value(s): |
|
Notes: |
| |
HideParent5 | Expected Value(s): |
|
Notes: |
| |
HideParent6 | Expected Value(s): |
|
Notes: |
| |
HideParent7 | Expected Value(s): |
|
Notes: |
|
- 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_CatStateOtherFreq| State=| State2=| StateParentNotFreq=| Other=| Other2=| OtherIsNotFreq=| OtherFreqInState=| 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 Frequencies
Categories-Templates: Emergency Services Frequencies} | Parameters used | |
Categories-Template example: | Template:Cat_StateFireSvcsFreq | State, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Texas_Fire_Services_Frequencies Category:Canada_Fire_Services_Frequencies Category:Ontario_Fire_Services_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateLawEnfFreq Template:Cat_StateMedicalFreq | |
Categories-Template example: | Template:Cat_StateFireSvcsAvFreq | State, State2, Other, Country, Articles, HideParent3, Parent4, Parent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Texas_Fire_Services_Aviation_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateLawEnfAvFreq Template:Cat_StateMedAvFreq |
Categories-Templates: General Services Frequencies
Categories-Templates: General Services Frequencies} | Parameters used | |
Categories-Template example: | Template:Cat_StateAvFreq | State, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Texas_Aviation_Frequencies Category:Bermuda_Aviation_Frequencies Category:Canada_Aviation_Frequencies Category:Ontario_Aviation_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateAmateurFreq Template:Cat_StateMjrEvtDisFreq | |
Categories-Template example: | Template:Cat_StateAmateurRptr | State, State2, Other, Country, OtherIsNotFreq, HideOtherInList, Articles, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Texas_Amateur_Radio_Repeaters Category:Canada_Amateur_Radio_Repeaters Category:British_Columbia_Amateur_Radio_Repeaters | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateBusFreq | State, Other, Country, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Texas_Business_Frequencies Category:Canada_Business_Frequencies Category:Ontario_Business_Frequencies | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateBusComPrvFreq | State, State2, StateParentNotFreq, Other, Country, HideParent3, MoreText, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:California_Communications_Providers_Frequencies Category:Australia_Communications_Providers_Frequencies Category:New_South_Wales_Communications_Providers_Frequencies | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateBusFastFoodFreq | State, State2, StateParentNotFreq, Other, Country, HideParent3, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:New_York_Fast_Food_Frequencies Category:Canada_Fast_Food_Frequencies Category:Alberta_Fast_Food_Frequencies | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateCivilAvFreq | State, State2, Other, Country, Articles, HideParent3, MoreText, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Idaho_Civil_Aviation_Frequencies Category:Canada_Civil_Aviation_Frequencies Category:Nova_Scotia_Civil_Aviation_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateUtilComCarFreq | |
Categories-Template example: | Template:Cat_StateCSXFreq | State, State2, StateParentNotFreq, Other, Country, HideParent3, Parent4, Parent5, Parent6, HideParent7 |
State-specific example(s): | Category:Florida_CSX_Transportation_Frequencies Category:Canada_CSX_Transportation_Frequencies Category:Quebec_CSX_Transportation_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateUtilComCarFreq | |
Categories-Template example: | Template:Cat_StateEducFreq | State, Other, Country, Articles, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Michigan_Education_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateMediaFreq Template:Cat_StateSportsFreq | |
Categories-Template example: | Template:Cat_StateGrndTransFreq | State. Other. Country. MoreText. HideParent4. HideParent5. HideParent6. HideParent7 |
State-specific example(s): | Category:New_York_Ground_Transportation_Frequencies Category:Canada_Ground_Transportation_Frequencies Category:Quebec_Ground_Transportation_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateMarineFreq | |
Categories-Template example: | Template:Cat_StateMotorFrtFreq | State, State2, StateParentNotFreq, Other, Country, HideParent3, Articles, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:New_York_Motor_Freight_Frequencies Category:Canada_Motor_Freight_Frequencies Category:Quebec_Motor_Freight_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateRailFreq | |
Categories-Template example: | Template:Cat_StateRecAtrFreq | State, Other, Country, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:North_Carolina_Recreation_or_Attractions_Frequencies Category:Canada_Recreation_or_Attractions_Frequencies Category:Alberta_Recreation_or_Attractions_Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateSpcEvtsFreq Template:Cat_StateUtilFreq Template:Cat_StateWeatherFreq |
Categories-Templates: Federal/Military Frequencies
Categories-Templates: Federal/Military Frequencies} | Parameters used | |
Categories-Template example: | Template:Cat_StateAirShowsFreq | State, State2, StateParentNotFreq, Other, Country, HideParent3, Parent4, Parent5, HideParent6, HideParent7 |
State-specific example(s): | Category:New York Air Show Frequencies | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateMilAvFreq | State. State2, Other, Country, HideParent3, Articles, MoreText, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:California Military Aviation Frequencies | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_StateANGFreq | State, Other, Country, HideParent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:Maryland Air National Guard Frequencies | |
Template(s) with similar syntax: | Template:Cat_StateARNGFreq | |
Categories-Template example: | Template:Cat_USFedFreqInState | OtherFreqInState, Agency, State, Other, Other2, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:US Land Management Frequencies in Nevada | |
Template(s) with similar syntax: | ||
Categories-Template example: | Template:Cat_USMilFreqInState | OtherFreqInState, MilBranch, State, Other, Other2, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
State-specific example(s): | Category:United States Air Force Frequencies in New York | |
Template(s) with similar syntax: |
Parameter-Use Examples: Categories
- Selected examples that illustrate various combinations of parameters:
Categories: Top-level "Theme"-Frequencies
Categories: Top-level "Theme" Frequencies} | Parameters used | |
Categories example: | Category:Wiki Frequencies | State, State2, StateParentNotFreq, HideOtherInTitle, HideOtherInList, Articles, HideParent3, MoreText, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | ||
Categories example: | Category:Air Show Frequencies | State, State2, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Articles, Parent4, Parent5, HideParent6, HideParent7 |
Categories with similar syntax: | Category:Business Frequencies | |
Categories example: | Category:Amateur Radio Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Articles, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | Category:Education Frequencies | |
Categories example: | Category:Amateur Radio Repeaters | State, Other, OtherIsNotFreq, HideOtherInTitle, HideOtherInList, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | Unique Special Case | |
Categories example: | Category:Air National Guard Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | ||
Categories example: | Category:Medical Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | ||
Categories example: | Category:Railroads Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Articles, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: |
Categories: Aviation Frequencies for a Specific Theme
Categories: Aviation Frequencies for a Specific Theme} | Parameters used | |
Categories example: | Category:Fire Services Aviation Frequencies | State, Other, Articles, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | Category:Law Enforcement Aviation Frequencies Category:Medical Aviation Frequencies | |
Categories example: | Category:Military Aviation Frequencies | State, State2, Other, HideOtherInTitle, Articles, MoreText, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: |
Categories: CSX Transportation Frequencies
Category:CSX Transportation Frequencies} | Parameters used | |
Categories example: | Category:CSX Transportation Frequencies | State, State2, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Articles, Parent4, Parent5, HideParent6, HideParent7 |
Categories with similar syntax: |
Categories: US Agency Frequencies
Categories: US Agency Frequencies} | Parameters used | |
Categories example: | Category:US Federal Government Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, MoreText, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | ||
Categories example: | Category:US Civil Air Patrol Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Articles, Parent4, Parent5, Parent6, HideParent7 |
Categories with similar syntax: | ||
Categories example: | Category:US Federal Prisons Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | Category:US Bureau of Reclamation Frequencies | |
Categories example: | Category:US Land Management Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, Parent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: |
Categories: United States Military Branch Frequencies
Category:United States Air Force Frequencies} | Parameters used | |
Categories example: | Category:United States Air Force Frequencies | State, StateParentNotFreq, Other, HideOtherInTitle, HideParent3, HideParent4, HideParent5, HideParent6, HideParent7 |
Categories with similar syntax: | Category:United States Army Frequencies Category:United States Coast Guard Frequencies Category:United States Navy Frequencies |
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) frequencies 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, "Frequencies" categories:
{{Text_CatStateOtherFreq| State={{{State}}}| StateParentNotFreq=| Other={{{FreqParent|Wiki}}}| HideOtherInTitle=| HideParent3=| MoreText={{{MoreText|}}}| HideParent4=| HideParent5=| HideParent6=| HideParent7=}}
Result
- See Template:Cat_StateFreq for the actual category-template.
How to invoke this template for a simpler US (Agency) Frequencies in (State) TEMPLATE
- Template:Cat_USFedFreqInState is an example of a simpler category-template that is used to build (US Federal Government) agency-level "Frequencies" categories:
{{Text_CatStateOtherFreq| OtherFreqInState=US {{{Agency}}} Frequencies in {{{State}}}| Other={{{Agency}}}| State={{{State}}}| Other2=US {{{Agency}}}| HideParent3=| Parent4=US {{{Agency}}} in {{{State}}}| HideParent5=| HideParent6=| HideParent7=}}
Result
- See Template:Cat_USFedFreqInState for the actual category-template.
How to invoke this template for a simpler United States (MilBranch) Frequencies in (State) TEMPLATE
- Template:Cat_USMilFreqInState is an example of a simpler category-template that is used to build (United States Military) Branch-level "Frequencies" categories:
{{Text_CatStateOtherFreq| OtherFreqInState=United States {{{MilBranch}}} Frequencies in {{{State}}}| Other={{{MilBranch}}}| State={{{State}}}| Other2=United States {{{MilBranch}}}| HideParent3=| Parent4=United States {{{MilBranch}}} in {{{State}}}| HideParent5=| HideParent6=| HideParent7=}}
Result
- See Template:Cat_USMilFreqInState for the actual category-template.
How to invoke this template for a (theme) frequencies CATEGORY
- Category:Air_National_Guard_Frequencies is an example of a Theme-level "Frequencies" category:
{{Text_CatStateOtherFreq| State=Air National Guard| StateParentNotFreq=| Other=United States Air Force| HideOtherInTitle=| HideParent3=| Parent4=Military Aviation Frequencies| HideParent5=| HideParent6=| HideParent7=|}}
Result
- See Category:Air_National_Guard_Frequencies 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_Frequencies
- 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".
{{Text_CatStateOtherFreq| State=Air National Guard| StateParentNotFreq=| Other=United States Air Force| HideOtherInTitle=| HideParent3=| 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_CatStateOtherFreq |State=Air National Guard |StateParentNotFreq= |Other=United States Air Force |HideOtherInTitle= |HideParent3= |Parent4=Military Aviation Frequencies |HideParent5= |HideParent6= |HideParent7= }}
Return to: Template:Text_CatStateOtherFreq, Template:Text_CatStateOther/doc/Compare