View source for Template:BBC programme/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

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.

There are some specific rules about it's usage.
*It is '''not''' a general BBC linking template. Use a normal external URL link, not this template.
*It can only be used on the main article about the programme, not related articles like "List of" articles, character articles etc.
*It should only be used in the [[Wikipedia:External links|external links]] section of an article and should not be used inside a reference.
*It can only be used '''once''' per article.
*For individual episodes use {{tl|BBC episode}} instead.

All other uses (or multiple uses in the same article) will result in conflicts between Wikipedia and Wikidata, causing the article to appear in the error categories below.

== Usage ==
; Unnamed parameters
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' }}</code>
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' }}</code>
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' | ''DESCRIPTION'' }}</code>

; Named parameters
: <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>

The template has the following optional parameters:
{| class="wikitable"
|-
! 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 ==
; No parameters '''and''' the show has a Wikidata entry with a BBC programme id.
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}}}}</code>
:* {{{{BASEPAGENAME}} | id= b006m86d | title= EastEnders }}

; No parameters and the show '''does not''' have a Wikidata entry with a BBC programme id.
: <code><nowiki>* {{</nowiki>{{BASEPAGENAME}}}}</code>
:* {{{{BASEPAGENAME}}<!-- -->}}

; One parameter
: <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) }}

==Tracking categories==
; ID parameter exists
* {{clc|BBC programme ID not in Wikidata}}
* {{clc|BBC programme ID different from Wikidata}}
* {{clc|BBC programme ID same as Wikidata}}
; ID parameter does not exist
* {{clc|BBC programme template missing ID and not in Wikidata}}
* {{clc|BBC programme template using Wikidata}}

==See also==
* {{tl|BBC Online}} – for general links to [[BBC Online]] pages
* {{tl|BBC episode}} – for links to [[BBC Online#iPlayer and programme sites|BBC Programmes]] episode pages
* {{tl|BBC composer page}} - for links to pages about composers

==TemplateData==
{{TemplateData header}}
<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": {
		"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",
			"required": false,
			"default": "Wikidata property P827",
			"example": "b006m86d"
		},
		"title": {
			"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",
			"required": false,
			"default": "{{PAGENAMEBASE}}",
			"example": "EastEnders"
		},
		"description": {
			"label": "Programme description",
                        "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
		}
	},
	"paramOrder": [
		"id",
		"title",
		"description"
	]
}
</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Template-Class BBC articles]]
[[Category:Television external link templates]]
[[Category:Radio external link templates]]
[[Category:Templates that add a tracking category]]
[[Category:External link templates using Wikidata]]
}}</includeonly>