Difference between revisions of "Template:AMARB/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(format examples so /doc doesn't need to be updated every time the URL is updated in template, add note about template maintenance)
m (7 revisions imported)
 
(2 intermediate revisions by 2 users not shown)
Line 18: Line 18:
 
This template uses a URL in the following format:
 
This template uses a URL in the following format:
  
: <kbd>https://<nowiki/>www1.arbitron.com/sip/displaySip.do?surveyID='''<var>Season</var>'''&band='''am'''&callLetter='''<var>Callsign</var>'''</kbd>
+
: <code>https://<nowiki/>www1.arbitron.com/sip/displaySip.do?surveyID='''<var>Season</var>'''&band='''am'''&callLetter='''<var>Callsign</var>'''</code>
  
 
<var>Season</var> is a code representing the current season and year. Examples: <code>SP17</code> for Spring 2017, <code>SU17</code> for Summer 2017, <code>FA17</code> for Fall 2017, and <code>WI18</code> for Winter 2018. Therefore, this template should be updated each season. If not, the links will land on pages stating "No data found" such as:
 
<var>Season</var> is a code representing the current season and year. Examples: <code>SP17</code> for Spring 2017, <code>SU17</code> for Summer 2017, <code>FA17</code> for Fall 2017, and <code>WI18</code> for Winter 2018. Therefore, this template should be updated each season. If not, the links will land on pages stating "No data found" such as:
  
: [https://www1.arbitron.com/sip/displaySip.do?surveyID=FA17&band=am&callLetter=WGY <kbd>https://<nowiki/>www1.arbitron.com/sip/displaySip.do?surveyID='''FA17'''&band='''am'''&callLetter='''WGY'''</kbd>]
+
: <code>[https://www1.arbitron.com/sip/displaySip.do?surveyID=FA17&band=am&callLetter=WGY https://www1.arbitron.com/sip/displaySip.do?surveyID='''FA17'''&band='''am'''&callLetter='''WGY''']</code>
 +
 
 +
== TemplateData==
 +
<templatedata>
 +
{
 +
"params": {
 +
"1": {
 +
"label": "Call sign",
 +
"description": "Call sign of radio station, without -AM",
 +
"required": true
 +
}
 +
},
 +
"description": "Nielsen Audio query template for AM radio stations",
 +
"format": "inline"
 +
}
 +
</templatedata>
  
 
== See also ==
 
== See also ==

Latest revision as of 11:32, 16 October 2020

This template displays an external link to Nielsen Audio (formerly Arbitron) for an AM station.

Usage

{{AMARB|callsign}}

There is only one parameter, the station callsign, and it is required. Do not include the -AM suffix.

Examples

To the right of each example is the displayed output. Below each example is the actual wiki-markup output which includes the URL. Template:Nowiki template demo Template:Nowiki template demo

Template maintenance

This template uses a URL in the following format:

https://www1.arbitron.com/sip/displaySip.do?surveyID=Season&band=am&callLetter=Callsign

Season is a code representing the current season and year. Examples: SP17 for Spring 2017, SU17 for Summer 2017, FA17 for Fall 2017, and WI18 for Winter 2018. Therefore, this template should be updated each season. If not, the links will land on pages stating "No data found" such as:

https://www1.arbitron.com/sip/displaySip.do?surveyID=FA17&band=am&callLetter=WGY

TemplateData

Nielsen Audio query template for AM radio stations

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Call sign1

Call sign of radio station, without -AM

Unknownrequired

See also