Difference between revisions of "Template:BBC programme/doc"

From blackwiki
Jump to navigation Jump to search
imported>Galobtter
(→‎Usage: update)
imported>Zyxw
(update usage, examples, category links, and TemplateData)
Line 5: Line 5:
 
{{Lua|Module:EditAtWikidata|Module:WikidataCheck}}
 
{{Lua|Module:EditAtWikidata|Module:WikidataCheck}}
  
==Usage==
+
This template displays an external link to the [[BBC Online#iPlayer and programme sites|BBC Programmes]] page at [[BBC Online]] for a [[BBC]] television or radio programme. It is intended for use in the [[Wikipedia:External links|external links]] section of an article.
This template is for linking to the [[BBC Online#iPlayer and programme sites|BBC Programmes]] page at [[BBC Online]] for [[BBC]] television and radio programmes. It should appear in the External links section.
 
  
Use one of:
+
== Usage ==
 +
; Unnamed parameters
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' | ''DESCRIPTION'' }}</code>
  
* <pre>* {{BBC programme}}</pre>
+
; Named parameters
* <pre>* {{BBC programme|id=|title=|description=}}</pre>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | title= ''TITLE'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | title= ''TITLE'' | description= ''DESCRIPTION'' }}</code>
 +
 
 +
; Using [[Wikidata]] property {{Property|827}}
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}}}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | title= ''TITLE'' }}</code>
 +
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | title= ''TITLE'' | description= ''DESCRIPTION'' }}</code></code>
  
 
The template has the following optional parameters:
 
The template has the following optional parameters:
Line 29: Line 39:
 
|}
 
|}
  
==Example==
+
== Examples ==
The following usage:
+
; One parameter
<pre>* {{BBC programme|id=b006m86d|title=EastEnders}}</pre>
+
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} | b006m86d }}</code>
 +
:* {{{{BASEPAGENAME}} | b006m86d }}
 +
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} |id= b006m86d }}</code>
 +
:* {{{{BASEPAGENAME}} | id= b006m86d }}
 +
 
 +
; Two parameters
 +
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} | b006m86d | EastEnders }}</code>
 +
:* {{{{BASEPAGENAME}} | b006m86d | EastEnders }}
 +
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} | id= b006m86d | title= EastEnders }}</code>
 +
:* {{{{BASEPAGENAME}} | id= b006m86d | title= EastEnders }}
 +
 
 +
; Three parameters
 +
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} | b006m86d | EastEnders | (British TV series) }}</code>
 +
:* {{{{BASEPAGENAME}} | b006m86d | EastEnders | (British TV series) }}
 +
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}} | id= b006m86d | title= EastEnders | description= (British TV series) }}</code>
 +
:* {{{{BASEPAGENAME}} | id= b006m86d | title= EastEnders | description= (British TV series) }}
  
Produces:
+
; No ID in template or Wikidata
* {{BBC programme|id=b006m86d|title=EastEnders}}
+
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}}}}</code>
 +
:* {{{{BASEPAGENAME}}<!-- -->}}
  
 
==Tracking categories==
 
==Tracking categories==
 +
; ID parameter exists
 
* {{clc|BBC programme ID not in Wikidata}}
 
* {{clc|BBC programme ID not in Wikidata}}
 
* {{clc|BBC programme ID different from Wikidata}}
 
* {{clc|BBC programme ID different from Wikidata}}
 
* {{clc|BBC programme ID same as Wikidata}}
 
* {{clc|BBC programme ID same as Wikidata}}
* {{cl|BBC programme template with no id set}} (exists in template, not created)
+
; ID parameter does not exist
 +
* {{clc|BBC programme template missing ID and not in Wikidata}}
 +
* {{clc|BBC programme template using Wikidata}}
  
 
==See also==
 
==See also==
Line 47: Line 76:
 
* {{tl|BBC composer page}} - for links to pages about composers
 
* {{tl|BBC composer page}} - for links to pages about composers
  
==Template data==
+
==TemplateData==
 
{{TemplateData header}}
 
{{TemplateData header}}
 
<templatedata>
 
<templatedata>
 
{
 
{
 +
"description": "This template displays an external link to the BBC Programmes page at BBC Online for a BBC television or radio programme. It is intended for use in the external links section of an article.",
 +
"format": "inline",
 
"params": {
 
"params": {
 
"id": {
 
"id": {
"label": "Programme ID",
+
"label": "Programme identifier",
 +
"aliases": [ "1" ],
 +
"description": "The \"id\" parameter (or unnamed parameter \"1\") should contain the identifier (ID) portion of the URL. Example: b006m86d is the ID portion of https://www.bbc.co.uk/programmes/b006m86d. This parameter is optional if Wikidata property P827 exists, but required if not.",
 
"type": "string",
 
"type": "string",
 +
"required": false,
 +
"default": "Wikidata property P827",
 
"example": "b006m86d"
 
"example": "b006m86d"
 
},
 
},
 
"title": {
 
"title": {
"label": "Programme name",
+
"label": "Programme title",
 +
"aliases": ["2"],
 +
"description": "The \"title\" parameter (or unnamed parameter \"2\") may be used to specify the title of the programme. This parameter is optional; it defaults to the Wikipedia article name, without any disambiguation such as \"(TV series)\". It is displayed in an italic font.",
 
"type": "string",
 
"type": "string",
 +
"required": false,
 +
"default": "{{PAGENAMEBASE}}",
 
"example": "EastEnders"
 
"example": "EastEnders"
 
},
 
},
 
"description": {
 
"description": {
"label": "Description",
+
"label": "Programme description",
"type": "string"
+
                        "aliases" : [ "3" ],
 +
                        "description": "The \"description\" parameter (or unnamed parameter \"3\") may be used to add a description of the programme. It is displayed in a non-italic font.",
 +
"type": "string",
 +
                        "required": false
 
}
 
}
 
},
 
},
"format": "inline",
+
"paramOrder": [
"description": "This template is for linking to the BBC Programmes page at BBC Online for BBC television and radio programmes. It should appear in the External links section."
+
"id",
 +
"title",
 +
"description"
 +
]
 
}
 
}
 
</templatedata>
 
</templatedata>

Revision as of 21:42, 25 April 2019

Template:Uses Wikidata Template:Tracks Wikidata

This template displays an external link to the BBC Programmes page at BBC Online for a BBC television or radio programme. It is intended for use in the external links section of an article.

Usage

Unnamed parameters
{{BBC programme | ID }}
{{BBC programme | ID | TITLE }}
{{BBC programme | ID | TITLE | DESCRIPTION }}
Named parameters
{{BBC programme | id= ID }}
{{BBC programme | id= ID | title= TITLE }}
{{BBC programme | id= ID | title= TITLE | description= DESCRIPTION }}
Using Wikidata property Template:Property
{{BBC programme}}
{{BBC programme | title= TITLE }}
{{BBC programme | title= TITLE | description= DESCRIPTION }}

The template has the following optional parameters:

Parameter Notes
id Programme id given after https://www.bbc.co.uk/programmes/. For example, the EastEnders entry is at https://www.bbc.co.uk/programmes/b006m86d and the id is b006m86d.
title Programme name, for the above example this would be EastEnders. The title is automatically formatted.
description Additional description

Examples

One parameter
* {{BBC programme | b006m86d }}
* {{BBC programme |id= b006m86d }}
Two parameters
* {{BBC programme | b006m86d | EastEnders }}
* {{BBC programme | id= b006m86d | title= EastEnders }}
Three parameters
* {{BBC programme | b006m86d | EastEnders | (British TV series) }}
* {{BBC programme | id= b006m86d | title= EastEnders | description= (British TV series) }}
No ID in template or Wikidata
* {{BBC programme}}

Tracking categories

ID parameter exists
ID parameter does not exist

See also

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for BBC programme

This template displays an external link to the BBC Programmes page at BBC Online for a BBC television or radio programme. It is intended for use in the external links section of an article.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Programme identifierid 1

The "id" parameter (or unnamed parameter "1") should contain the identifier (ID) portion of the URL. Example: b006m86d is the ID portion of https://www.bbc.co.uk/programmes/b006m86d. This parameter is optional if Wikidata property P827 exists, but required if not.

Default
Wikidata property P827
Example
b006m86d
Stringoptional
Programme titletitle 2

The "title" parameter (or unnamed parameter "2") may be used to specify the title of the programme. This parameter is optional; it defaults to the Wikipedia article name, without any disambiguation such as "(TV series)". It is displayed in an italic font.

Default
{{PAGENAMEBASE}}
Example
EastEnders
Stringoptional
Programme descriptiondescription 3

The "description" parameter (or unnamed parameter "3") may be used to add a description of the programme. It is displayed in a non-italic font.

Stringoptional