Difference between revisions of "Template:HockeyDB/doc"
imported>Zyxw m (Zyxw moved page Template:Hockeydb/doc to Template:HockeyDB/doc: match move of template) |
imported>Zyxw (updates for handling of missing ID and use of Wikidata property for player if ID not specified, misc formatting) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | ||
| + | {{Uses Wikidata|P2602}} | ||
| + | {{Lua|Module:EditAtWikidata}} | ||
| − | '''{{NAMESPACE}}:{{BASEPAGENAME}}''' displays an external link to [[ice hockey]] player's or team's statistics at [http://www.hockeydb.com HockeyDB.com]. | + | '''{{NAMESPACE}}:{{BASEPAGENAME}}''' displays an external link to [[ice hockey]] player's or team's statistics at [http://www.hockeydb.com HockeyDB.com]. It is intended for use in the [[Wikipedia:External links|external links]] section of an article. |
== Usage == | == Usage == | ||
| + | |||
=== Player === | === Player === | ||
Unnamed parameters: | Unnamed parameters: | ||
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' }}</code> | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | ''ID'' | ''NAME'' }}</code> | |
Named parameters: | Named parameters: | ||
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' }}</code> | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | id= ''ID'' | name= ''NAME'' }}</code> | |
| + | |||
| + | Using [[Wikidata]] property [[d:Property:P2602|P2602]]: | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code> | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | name= ''NAME'' }}</code> | ||
=== Team === | === Team === | ||
Unnamed parameters: | Unnamed parameters: | ||
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes | ''ID'' }}</code> | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes | ''ID'' | ''NAME'' }}</code> | |
Named parameters: | Named parameters: | ||
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes | id= ''ID'' }}</code> | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes | id= ''ID'' | name= ''NAME'' }}</code> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Examples == | == Examples == | ||
=== Player === | === Player === | ||
| − | + | http://www.hockeydb.com/ihdb/stats/pdisplay.php?pid=73288 | |
| − | |||
| − | |||
| − | + | ; Unnamed parameters | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | 73288 | Sidney Crosby }}</code> | |
| − | + | : {{{{BASEPAGENAME}} | 73288 | Sidney Crosby }} | |
| − | + | ; Named parameters (id, name) | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |id= 73288 |name= Sidney Crosby }}</code> | |
| − | + | : {{{{BASEPAGENAME}} |id= 73288 |name= Sidney Crosby }} | |
| + | |||
| + | ; Named parameters (id, title) | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} |id= 73288 |title= Sidney Crosby }}</code> | ||
| + | : {{{{BASEPAGENAME}} |id= 73288 |title= Sidney Crosby }} | ||
| + | |||
| + | ; Missing ID parameter and Wikidata property not defined | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki></code> | ||
| + | : {{{{BASEPAGENAME}}<!-- -->}} | ||
=== Team === | === Team === | ||
| − | + | http://www.hockeydb.com/ihdb/stats/teamseasons.php?tid=690 | |
| − | + | ||
| − | + | ; Unnamed parameters | |
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes | 690 | Colorado Avalanche }}</code> | ||
| + | : {{{{BASEPAGENAME}} | team= yes | 690 | Colorado Avalanche }} | ||
| + | |||
| + | ; Named parameters (id, name) | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes |id= 690 |name= Colorado Avalanche }}</code> | ||
| + | : {{{{BASEPAGENAME}} | team= yes |id= 690 |name= Colorado Avalanche }} | ||
| + | |||
| + | ; Named parameters (id, title) | ||
| + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes |id= 690 |title= Colorado Avalanche }}</code> | ||
| + | : {{{{BASEPAGENAME}} | team= yes |id= 690 |title= Colorado Avalanche }} | ||
| − | + | ; Missing ID parameter | |
| − | + | : <code><nowiki>{{</nowiki>{{BASEPAGENAME}} | team= yes }}</code> | |
| − | + | : {{{{BASEPAGENAME}} | team= yes }} | |
| − | + | == TemplateData == | |
| − | + | {{TemplateData header}} | |
| − | + | <templatedata> | |
| + | { | ||
| + | "description": "This template displays an external link to ice hockey player's or team's statistics at HockeyDB.com. It is intended for use in the external links section of an article.", | ||
| + | "params": { | ||
| + | "id": { | ||
| + | "label": "id", | ||
| + | "aliases": ["1"], | ||
| + | "description": "Player's or team's ID number in the URL. Player: 73288 is the ID in http://www.hockeydb.com/ihdb/stats/pdisplay.php?pid=73288. Team: 690 is the ID in http://www.hockeydb.com/ihdb/stats/teamseasons.php?tid=690. For players, this parameter is optional if Wikidata property 2602 exists, but required if not. For teams, this parameter is required.", | ||
| + | "type": "number", | ||
| + | "required": false, | ||
| + | "default": "Wikidata property P2602 (for players)" | ||
| + | }, | ||
| + | "name": { | ||
| + | "label": "name", | ||
| + | "aliases": ["title", "2"], | ||
| + | "description": "Name of player or team. If not given it defaults to the Wikipedia article name, without any disambiguation such as (ice hockey).", | ||
| + | "type": "string", | ||
| + | "required": false, | ||
| + | "default": "{{PAGENAMEBASE}}" | ||
| + | }, | ||
| + | "team": { | ||
| + | "label": "team", | ||
| + | "description": "If team=yes, the template will display team statistics instead of individual player statistics.", | ||
| + | "type": "string", | ||
| + | "required": false | ||
| + | } | ||
| + | }, | ||
| + | "paramOrder": [ | ||
| + | "id", | ||
| + | "name", | ||
| + | "team" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
== See also == | == See also == | ||
| Line 101: | Line 127: | ||
[[Category:WikiProject Ice Hockey templates]] | [[Category:WikiProject Ice Hockey templates]] | ||
[[Category:People and person external link templates]] | [[Category:People and person external link templates]] | ||
| + | [[Category:External link templates using Wikidata]] | ||
}}</includeonly> | }}</includeonly> | ||
Revision as of 09:57, 25 April 2017
| This is a documentation subpage for Template:HockeyDB. It contains usage information, categories and other content that is not part of the original template page. |
| This template uses Lua: |
Template:HockeyDB displays an external link to ice hockey player's or team's statistics at HockeyDB.com. It is intended for use in the external links section of an article.
Usage
Player
Unnamed parameters:
{{HockeyDB | ID }}{{HockeyDB | ID | NAME }}
Named parameters:
{{HockeyDB | id= ID }}{{HockeyDB | id= ID | name= NAME }}
Using Wikidata property P2602:
{{HockeyDB}}{{HockeyDB | name= NAME }}
Team
Unnamed parameters:
{{HockeyDB | team= yes | ID }}{{HockeyDB | team= yes | ID | NAME }}
Named parameters:
{{HockeyDB | team= yes | id= ID }}{{HockeyDB | team= yes | id= ID | name= NAME }}
Examples
Player
http://www.hockeydb.com/ihdb/stats/pdisplay.php?pid=73288
- Unnamed parameters
{{HockeyDB | 73288 | Sidney Crosby }}- Sidney Crosby career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Named parameters (id, name)
{{HockeyDB |id= 73288 |name= Sidney Crosby }}- Sidney Crosby career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Named parameters (id, title)
{{HockeyDB |id= 73288 |title= Sidney Crosby }}- Template:PAGENAMEBASE career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Missing ID parameter and Wikidata property not defined
{{HockeyDB}}- Template:PAGENAMEBASE career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
Team
http://www.hockeydb.com/ihdb/stats/teamseasons.php?tid=690
- Unnamed parameters
{{HockeyDB | team= yes | 690 | Colorado Avalanche }}- Colorado Avalanche career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Named parameters (id, name)
{{HockeyDB | team= yes |id= 690 |name= Colorado Avalanche }}- Colorado Avalanche career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Named parameters (id, title)
{{HockeyDB | team= yes |id= 690 |title= Colorado Avalanche }}- Template:PAGENAMEBASE career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
- Missing ID parameter
{{HockeyDB | team= yes }}- Template:PAGENAMEBASE career statistics at The Internet Hockey DatabaseScript error: No such module "EditAtWikidata".
TemplateData
TemplateData for HockeyDB
This template displays an external link to ice hockey player's or team's statistics at HockeyDB.com. It is intended for use in the external links section of an article.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| id | id 1 | Player's or team's ID number in the URL. Player: 73288 is the ID in http://www.hockeydb.com/ihdb/stats/pdisplay.php?pid=73288. Team: 690 is the ID in http://www.hockeydb.com/ihdb/stats/teamseasons.php?tid=690. For players, this parameter is optional if Wikidata property 2602 exists, but required if not. For teams, this parameter is required.
| Number | optional |
| name | name title 2 | Name of player or team. If not given it defaults to the Wikipedia article name, without any disambiguation such as (ice hockey).
| String | optional |
| team | team | If team=yes, the template will display team statistics instead of individual player statistics. | String | optional |
See also
Ice hockey player external link templates:
- Official league websites:
- {{AHL profile}}
- {{ECHL profile}}
- {{EIHL profile}}
- {{NHL profile}}
- {{KHL profile}}
- Other websites:
- {{Eliteprospects}}
- {{Eurohockey}}
- {{Hockey-reference}}
- {{Legendsmember}}
- {{Legendsofhockey}}
- {{TSN-NHL profile}}