Difference between revisions of "Template:KBS World TV program/doc"
imported>Accireioj |
imported>St3095 m |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| + | {{Template shortcut|KBS World|KBS}} | ||
This template is used to generate an external link to a web page at [[KBS World (TV channel)]]. It should be used '''exclusively for KBS World TV programs'''. | This template is used to generate an external link to a web page at [[KBS World (TV channel)]]. It should be used '''exclusively for KBS World TV programs'''. | ||
| Line 6: | Line 7: | ||
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' <nowiki>}}</nowiki></code> | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' <nowiki>}}</nowiki></code> | ||
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' <nowiki>}}</nowiki></code> | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' <nowiki>}}</nowiki></code> | ||
| + | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''TITLE'' | ''DESCRIPTION'' <nowiki>}}</nowiki></code> | ||
Named parameters: | Named parameters: | ||
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' <nowiki>}}</nowiki></code> | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' <nowiki>}}</nowiki></code> | ||
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | title= ''TITLE'' <nowiki>}}</nowiki></code> | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | title= ''TITLE'' <nowiki>}}</nowiki></code> | ||
| + | * <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | title= ''TITLE'' | description= ''DESCRIPTION'' <nowiki>}}</nowiki></code> | ||
== Instructions == | == Instructions == | ||
| Line 22: | Line 25: | ||
#: or <code><nowiki>{{</nowiki>KBS World TV program | id= {{Hilite|####}} | title= ''Program Name'' }}</code> | #: or <code><nowiki>{{</nowiki>KBS World TV program | id= {{Hilite|####}} | title= ''Program Name'' }}</code> | ||
#: where <code>####</code> is the number you've copied, and <code>''Program Name''</code> is the title of the show. | #: where <code>####</code> is the number you've copied, and <code>''Program Name''</code> is the title of the show. | ||
| + | # (Optional) If you want to add an additional description to distinguish this show from another that may be on the same page with the same name, use the following text: | ||
| + | #: <code><nowiki>{{</nowiki>KBS World TV program | #### | ''Title'' | ''Description'' }}</code> | ||
| + | #: where <code>####</code> is the number you've copied, <code>''Title''</code> is the title of the show, and <code>''Description''</code> is the description of the show, in parentheses. | ||
== Examples == | == Examples == | ||
| Line 45: | Line 51: | ||
Example: <code><nowiki>{{KBS World TV program | id= 1167 | title= Witch at Court }}</nowiki></code> | Example: <code><nowiki>{{KBS World TV program | id= 1167 | title= Witch at Court }}</nowiki></code> | ||
: Result: {{KBS World TV program | id= 1167 | title= Witch at Court }} | : Result: {{KBS World TV program | id= 1167 | title= Witch at Court }} | ||
| + | |||
| + | === Parameter: description (3) === | ||
| + | Example: <code><nowiki>{{KBS World TV program | 1167 | Witch at Court | (2017 South Korean TV series) }}</nowiki></code> | ||
| + | : Result: {{KBS World TV program | 1167 | Witch at Court | (2017 South Korean TV series) }} | ||
| + | |||
| + | Example: <code><nowiki>{{KBS World TV program | id= 1167 | title= Witch at Court | description= (2017 South Korean TV series) }}</nowiki></code> | ||
| + | : Result: {{KBS World TV program | id= 1167 | title= Witch at Court | description= (2017 South Korean TV series) }} | ||
== TemplateData == | == TemplateData == | ||
| Line 65: | Line 78: | ||
"type": "string", | "type": "string", | ||
"required": false | "required": false | ||
| + | }, | ||
| + | "description": { | ||
| + | "label": "Description", | ||
| + | "description": "Description of the production.", | ||
| + | "type": "string", | ||
| + | "required": false, | ||
| + | "aliases" : [ "3" ] | ||
} | } | ||
} | } | ||
| Line 76: | Line 96: | ||
* {{clc|KBS World TV program template with no id set}} (exists in template, not created) | * {{clc|KBS World TV program template with no id set}} (exists in template, not created) | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other|| |
[[Category:Television external link templates]] | [[Category:Television external link templates]] | ||
[[Category:Templates using data from Wikidata]] | [[Category:Templates using data from Wikidata]] | ||
[[Category:Templates that add a tracking category]] | [[Category:Templates that add a tracking category]] | ||
[[Category:External link templates using Wikidata]] | [[Category:External link templates using Wikidata]] | ||
| + | |||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 10:55, 3 November 2020
| This is a documentation subpage for Template:KBS World TV program. It contains usage information, categories and other content that is not part of the original template page. |
This template is used to generate an external link to a web page at KBS World (TV channel). It should be used exclusively for KBS World TV programs.
Contents
Usage
Unnamed parameters:
{{KBS World TV program | ID }}{{KBS World TV program | ID | TITLE }}{{KBS World TV program | ID | TITLE | DESCRIPTION }}
Named parameters:
{{KBS World TV program | id= ID }}{{KBS World TV program | id= ID | title= TITLE }}{{KBS World TV program | id= ID | title= TITLE | description= DESCRIPTION }}
Instructions
- Search on KBS World for the title you want. On the Wikipedia page of the TV program concerned this can often be done with the link produced by previewing
{{Template:KBS World TV program}}(this may not work if the page title is more than just the program title). - Click on the correct link to go to the program's page. Be sure you're getting on the correct title page.
- The page URL should look like this:
http://kbsworld.kbs.co.kr/program/program_view.php?pg_seq=####- where
####indicates a number.
- Copy the ID number that appears after
.kr/program/program_view.php?pg_seq=in the URL. The leading zeros in the number are not needed, but are recommended for Linksearch uniformity. - Add the following to the external links section of the article:
{{KBS World TV program | #### | Program Name }}- or
{{KBS World TV program | id= #### | title= Program Name }} - where
####is the number you've copied, andProgram Nameis the title of the show.
- (Optional) If you want to add an additional description to distinguish this show from another that may be on the same page with the same name, use the following text:
{{KBS World TV program | #### | Title | Description }}- where
####is the number you've copied,Titleis the title of the show, andDescriptionis the description of the show, in parentheses.
Examples
Parameter: id (1)
- Search on KBS World for the title Witch at Court.
- On the search results page, click the link for "Witch at Court". That KBS World page URL is:
http://kbsworld.kbs.co.kr/program/program_view.php?pg_seq=1167
- Copy
1167and add it to the template.
Example: {{KBS World TV program | 1167 }}
- Result: Template:PAGENAMEBASE on KBS World
Example: {{KBS World TV program |id= 1167 }}
- Result: Template:PAGENAMEBASE on KBS World
Typically this is a list item in the external links section (even if there is only one link), so you should add "*" in front.
Parameter: title (2)
Example: {{KBS World TV program | 1167 | Witch at Court }}
- Result: Witch at Court on KBS World
Example: {{KBS World TV program | id= 1167 | title= Witch at Court }}
- Result: Witch at Court on KBS World
Parameter: description (3)
Example: {{KBS World TV program | 1167 | Witch at Court | (2017 South Korean TV series) }}
Example: {{KBS World TV program | id= 1167 | title= Witch at Court | description= (2017 South Korean TV series) }}
TemplateData
TemplateData for KBS World TV program
This template is used to generate an external link to a web page for a program in the KBS World portal.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| ID | id 1 | The KBS World TV program ID for the target page. | Number | required |
| Name | name 2 | Name that you want to have displayed. Defaults to article title. | String | optional |
| Description | description 3 | Description of the production. | String | optional |
Tracking category
- Category:KBS World TV program ID not in Wikidata (0)
- Category:KBS World TV program ID different from Wikidata (0)
- Category:KBS World TV program ID same as Wikidata (0)
- Category:KBS World TV program template with no id set (0) (exists in template, not created)