Difference between revisions of "Text CatGeneral/doc"
From The RadioReference Wiki
< Template:Text CatGeneral
m (added category) |
m (→Parameters: updated list) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
===Scope of Use=== | ===Scope of Use=== | ||
====Purpose==== | ====Purpose==== | ||
| − | *'''[[:Template:Text_CatGeneral]]''' is designed to be a single-source text-template that provides a common and uniform structure for the text that is displayed in the mid-sections of | + | *'''[[:Template:Text_CatGeneral]]''' is designed to be a single-source text-template that provides a common and uniform structure for the text that is displayed in the mid-sections of '''[[:Template:Text_CatStateOther]]''', '''[[:Template:Text_CatStateOtherFreq]]''', '''[[:Template:Text_CatStateOtherNonRRDB]]'''. |
| − | * | + | *Parameters listed below allow the default message to be shown or hidden, and/or custom-messages to be displayed when provided. |
*The default message is intended for frequencies-related categories, and contains instructions about submitting information to the Frequency Database. | *The default message is intended for frequencies-related categories, and contains instructions about submitting information to the Frequency Database. | ||
====Directly Invoked By==== | ====Directly Invoked By==== | ||
| − | *'''[[:Template:Text_CatGeneral]]''' should be directly invoked only by '''[[:Template:Text_CatStateOther]]''' and '''[[:Template: | + | *'''[[:Template:Text_CatGeneral]]''' should be directly invoked only by '''[[:Template:Text_CatStateOther]]''', '''[[:Template:Text_CatStateOtherFreq]]''', and '''[[:Template:Text_CatStateOtherNonRRDB]]'''. |
====Not Intended For==== | ====Not Intended For==== | ||
| − | *'''[[:Template:Text_CatGeneral]]''' should not be directly invoked by any other template or category, although all templates and categories that invoke either '''[[:Template:Text_CatStateOther]]''' or '''[[:Template:Text_CatStateOtherFreq]]''' will indirectly invoke '''[[:Template:Text_CatGeneral]]''' by transclusion. | + | *'''[[:Template:Text_CatGeneral]]''' should not be directly invoked by any other template or category, although all templates and categories that invoke either '''[[:Template:Text_CatStateOther]]''' or '''[[:Template:Text_CatStateOtherFreq]]''' or '''[[:Template:Text_CatStateOtherNonRRDB]]''' will indirectly invoke '''[[:Template:Text_CatGeneral]]''' by transclusion. |
| − | + | ===Parameters=== | |
| − | |||
| − | === | ||
*Specified values will override default values. | *Specified values will override default values. | ||
| − | *Specified values | + | *Specified values, Default values, and Parameter Names are all case-sensitive. |
{| {{table}} width="100%" | {| {{table}} width="100%" | ||
|- bgcolor="lightgrey" | | |- bgcolor="lightgrey" | | ||
| − | ! | + | ! Parameter Name !! Var Description !! Expected Value(s) !! Default Value !! Notes |
| + | |- | ||
| + | | '''HideRRDBText''' || || | ||
| + | *either unspecified <br/> | ||
| + | *or specified with no value | ||
| + | ||unspecified || | ||
| + | * When unspecified, the default RRDB-related message displays (and will be listed as the second bullet item in the list).<br/> | ||
| + | *When specified with no value, the RRDB-related message is hidden.<br/> | ||
| + | ---- | ||
| + | *'''[[:Template:Text_CatStateOtherNonRRDB]]''' hides the RRDB-related message. | ||
| + | *'''[[:Template:Text_CatStateOther]]''' and '''[[:Template:Text_CatStateOtherFreq]]''' display the RRDB-related message. | ||
| + | |||
| + | ---- | ||
| + | *'''''{{Color|red|Caution}}:''''' '''Please do not specify an actual value for this parameter''', as the results will be beyond the designs of both this template and the templates that are expected to invoke this template. | ||
|- | |- | ||
| '''HideFreqText''' || || | | '''HideFreqText''' || || | ||
| Line 25: | Line 36: | ||
*or specified with no value | *or specified with no value | ||
||unspecified || | ||unspecified || | ||
| − | * When unspecified, the | + | * When unspecified, the frequency-related message displays (and will be above any custom message specified by the MoreText parameter).<br/> |
| − | *When specified with no value, the | + | *When specified with no value, the frequency-related message is hidden.<br/> |
---- | ---- | ||
| − | *'''[[:Template:Text_CatStateOther]]''' | + | *'''[[:Template:Text_CatStateOtherNonRRDB]]''' and '''[[:Template:Text_CatStateOther]]''' hide the frequency-related message. |
| − | *'''[[:Template:Text_CatStateOtherFreq]]''' displays the | + | *'''[[:Template:Text_CatStateOtherFreq]]''' displays the frequency-related message. |
---- | ---- | ||
| − | *'''''{{Color|red|Caution}}:''''' '''Please do not specify an actual value for this | + | *'''''{{Color|red|Caution}}:''''' '''Please do not specify an actual value for this parameter''', as the results will be beyond the designs of both this template and the templates that are expected to invoke this template. |
|- | |- | ||
| '''MoreText''' || || | | '''MoreText''' || || | ||
| Line 38: | Line 49: | ||
*or specified with a custom-message | *or specified with a custom-message | ||
|| unspecified || | || unspecified || | ||
| − | *When unspecified, this | + | *When unspecified, this parameter is hidden.<br/> |
| − | *When specified, any custom message assigned to this | + | *When specified, any custom message assigned to this parameter will be displayed. If the default message is not hidden (using the HideFreqText parameter), then the default message will be displayed above the custom message. |
---- | ---- | ||
| − | *'''[[:Template:Text_CatStateOther]]''' | + | *These templates allow a custom message via MoreText: |
| − | *'''[[:Template:Text_CatStateOtherFreq]]''' | + | **'''[[:Template:Text_CatStateOther]]''' |
| − | + | **'''[[:Template:Text_CatStateOtherFreq]]''' | |
| + | **'''[[:Template:Text_CatStateOtherNonRRDB]]''' | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 20:43, 6 November 2015
Contents
- 1 Documentation Sub-page for Template:Text_CatGeneral
- 1.1 Scope of Use
- 1.2 Parameters
- 1.3 Examples
Documentation Sub-page for Template:Text_CatGeneral
Scope of Use
Purpose
- Template:Text_CatGeneral is designed to be a single-source text-template that provides a common and uniform structure for the text that is displayed in the mid-sections of Template:Text_CatStateOther, Template:Text_CatStateOtherFreq, Template:Text_CatStateOtherNonRRDB.
- Parameters listed below allow the default message to be shown or hidden, and/or custom-messages to be displayed when provided.
- The default message is intended for frequencies-related categories, and contains instructions about submitting information to the Frequency Database.
Directly Invoked By
- Template:Text_CatGeneral should be directly invoked only by Template:Text_CatStateOther, Template:Text_CatStateOtherFreq, and Template:Text_CatStateOtherNonRRDB.
Not Intended For
- Template:Text_CatGeneral should not be directly invoked by any other template or category, although all templates and categories that invoke either Template:Text_CatStateOther or Template:Text_CatStateOtherFreq or Template:Text_CatStateOtherNonRRDB will indirectly invoke Template:Text_CatGeneral by transclusion.
Parameters
- Specified values will override default values.
- Specified values, Default values, and Parameter Names are all case-sensitive.
| Parameter Name | Var Description | Expected Value(s) | Default Value | Notes |
|---|---|---|---|---|
| HideRRDBText |
|
unspecified |
| |
| HideFreqText |
|
unspecified |
| |
| MoreText |
|
unspecified |
|
Examples
- The horizontal lines below separate examples for clarity and do not appear when template is invoked.
How to invoke this template to show only the default message
- {{Text_CatGeneral}}
Result
In general, data in any Wiki article:
- should be used to supplement the data in our Frequency Database.
- may not be accurate. Members are encouraged to listen and validate it, and to edit the articles.
The data in the articles listed below:
- should not be submitted to the data base team until the data have been validated.
- Please read RR Database Submission Guidelines before submitting validated data to the Frequency Database.
- Please read Wiki Extensions to learn how to incorporate Database-data into a Wiki page.
- Please use tables if there are more than a couple lines of data.
- This enables several applications to capture this data, copy it into Windows clipboard, and from there to your scanner programming software. This helps to avoid a large amount of tedious (and error prone) manual typing and copying. See the Applications that can copy Frequency Data from the Wiki article for more information.
How to invoke this template to show both default and custom messages
-
{{Text_CatGeneral|MoreText=<br/><br/>This is a custom message.}}
Result
In general, data in any Wiki article:
- should be used to supplement the data in our Frequency Database.
- may not be accurate. Members are encouraged to listen and validate it, and to edit the articles.
The data in the articles listed below:
- should not be submitted to the data base team until the data have been validated.
- Please read RR Database Submission Guidelines before submitting validated data to the Frequency Database.
- Please read Wiki Extensions to learn how to incorporate Database-data into a Wiki page.
- Please use tables if there are more than a couple lines of data.
- This enables several applications to capture this data, copy it into Windows clipboard, and from there to your scanner programming software. This helps to avoid a large amount of tedious (and error prone) manual typing and copying. See the Applications that can copy Frequency Data from the Wiki article for more information.
This is a custom message.
How to invoke this template to show only a custom message
-
{{Text_CatGeneral|HideFreqText=|MoreText=<br/><br/>This is a custom message.}}
Result
In general, data in any Wiki article:
- should be used to supplement the data in our Frequency Database.
- may not be accurate. Members are encouraged to listen and validate it, and to edit the articles.
This is a custom message.
How to invoke this template to show neither the default nor a custom message
-
{{Text_CatGeneral|HideFreqText=|MoreText=|}}
Result
In general, data in any Wiki article:
- should be used to supplement the data in our Frequency Database.
- may not be accurate. Members are encouraged to listen and validate it, and to edit the articles.
Return to: Template:Text_CatGeneral