Actions

User

Difference between revisions of "QDP2012/30"

From The RadioReference Wiki

< User:QDP2012
m
m
Line 677: Line 677:
 
----
 
----
 
----
 
----
====How to avoid common error(s) while invoking this template for ...(idea 6)====
+
====How to avoid common error(s) while invoking this template====
*<nowiki>{{template_name|parameters and values to show how not to invoke this template}}</nowiki>
+
*'''Purpose: To avoid unintended spaces in parameter-values'''
*Place vertical bar at end of value, not at left-margin.
+
**'''Technique:''' Place the vertical bar at end of parameter-value, not at left-margin.
*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.
+
 
----
+
 
=====Result=====
+
*'''Purpose: To correctly assign no-value to a parameter'''
.(either show the verbatim result, or describe it in sufficient detail)
+
**'''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".
 +
<nowiki>{{Text_CatStateOtherFreq|
 +
State=Air National Guard|
 +
StateParentNotFreq=|
 +
Other=United States Air Force|
 +
HideOtherInTitle=|
 +
HideParent3=|
 +
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_CatStateOtherFreq
 +
|State=Air National Guard
 +
|StateParentNotFreq=
 +
|Other=United States Air Force
 +
|HideOtherInTitle=
 +
|HideParent3=
 +
|Parent4=Military Aviation Frequencies
 +
|HideParent5=
 +
|HideParent6=
 +
|HideParent7=
 +
}}</nowiki>
 +
 
 
----
 
----
 
----
 
----

Revision as of 13:05, 22 December 2015


Home Prompts Move TRVA Cat Tree Links CECC Pgmg Templates

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



Conv&Stds
Sandbox

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

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

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

InfoBox project related:
Template:ForTestingOnly
OLD: NEW:






.



Documentation Sub-page for Template: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.

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

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.
StateParentNotFreq Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the word "Frequencies" is appended to the State (or State2 if used) value in the categories-list.
  • When specified with no value, the word "Frequencies" is NOT appended to the State (or State2 if used) value in the categories-list.
  • Please do not assign a specific value to this parameter.
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
OtherIsNotFreq Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the word "Frequencies" is appended to the Other (or Other2 if used) value in the title and in the categories-list.
  • When specified with no value, the word "Frequencies" is NOT appended to the Other (or Other2 if used) value in the title and in the categories-list.
  • With rare exception, Please do not assign a specific value to this parameter.
OtherFreqInState Expected Value(s):
  • not specified (Default value)
  • specified with a State-parameter related value. Examples:
    • OtherFreqInState=US {{{Agency}}} Frequencies in {{{State}}}|
    • OtherFreqInState=United States {{{MilBranch}}} Frequencies 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
Parent3 Automatic Value(s):

Using values from parameters above, either:

  • State Other, or State2 Other, or State Other2, or State2 Other2
Notes:
  • Parent3's value is automatically created using the values of State (or State2 if used) and Other (or Other2 if used).
  • Parent3's value cannot be manually assigned by the Wiki-editor; but can be hidden using HideParent3 listed below.
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 Frequencies"

  • 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.
HideParent3 Expected Value(s):
  • not specified (Default value)
  • specified with no value
Notes:
  • When not specified, the value of Parent3 is displayed
  • When specified with no value, the value of Parent3 is not displayed
  • 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_CatStateOtherFreq|
State=|
State2=|
StateParentNotFreq=|
Other=|
Other2=|
OtherIsNotFreq=|
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

[http://www.airnav.com/airport/

]

Link

Categories-Templates: General Services Frequencies

Categories-Templates: General Services Frequencies} Parameters used

Link

Link

Link

Link

Link

Link

Link

Link

Link

Link

Link

Categories-Templates: Federal/Military Frequencies

Categories-Templates: Federal/Military Frequencies} Parameters used

Link

Link

Link

Link

Link

Parameter-Use Examples: Categories

  • Selected examples that illustrate various combinations of parameters:

Categories: Top-level "Theme"-Frequencies

Categories: Top-level "Theme" Frequencies} Parameters used

What links here

What links here

What links here

What links here

What links here

What links here

What links here

Categories: Aviation Frequencies for a Specific Theme

Categories: Aviation Frequencies for a Specific Theme} Parameters used

What links here

What links here

Categories: CSX Transportation Frequencies

Category:CSX Transportation Frequencies} Parameters used

What links here

Categories: US Agency Frequencies

Categories: US Agency Frequencies} Parameters used

What links here

What links here

What links here

What links here

Categories: United States Military Branch Frequencies

Category:United States Air Force Frequencies} Parameters used

What links here

PositionMarker

  • 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


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


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


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


How to invoke this template for ...(idea 5)

  • {{template_name|parameters and values that produce unexpected but useful result}}

Result

.(either show the verbatim result, or describe it in sufficient detail)



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
    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_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