Difference between revisions of "Template:FIG/doc"
imported>Zyxw m (fix placement of category to include template, not documentation (via JWB)) |
imported>Zyxw (update TemplateData) |
||
| Line 25: | Line 25: | ||
== TemplateData == | == TemplateData == | ||
| − | {{ | + | {{TemplateData header}} |
| − | <templatedata>{ | + | <templatedata> |
| − | "description": "This template displays an external link to an gymnast's profile at FIG-gymnastics.com, the official website of the International Federation of Gymnastics (FIG: Fédération Internationale de Gymnastique). It is intended for use in the external links section of an article.", | + | { |
| − | "params": { | + | "description": "This template displays an external link to an gymnast's profile at FIG-gymnastics.com, the official website of the International Federation of Gymnastics (FIG: Fédération Internationale de Gymnastique). It is intended for use in the external links section of an article.", |
| − | + | "params": { | |
| − | + | "id": { | |
| − | + | "label": "id", | |
| − | + | "aliases": ["1"], | |
| − | + | "description": "The \"id\" parameter (or unnamed parameter \"1\") should contain the ID portion of the URL. Example: 13822 is the ID portion of https://database.fig-gymnastics.com/public/gymnasts/biography/13822/true?backUrl=. This parameter is optional if Wikidata property P2696 exists, but required if not.", | |
| − | + | "type": "number", | |
| − | "required": true | + | "default": "Wikidata property P2696", |
| + | "required": false | ||
| + | }, | ||
| + | "name": { | ||
| + | "label": "name", | ||
| + | "aliases": ["2"], | ||
| + | "description": "The \"name\" parameter (or unnamed parameter \"2\") may be used to specify the link text, which should be the name of the gymnast. This parameter is optional; it defaults to the Wikipedia article name, without any disambiguation such as \"(gymnast)\".", | ||
| + | "type": "string", | ||
| + | "default": "{{PAGENAMEBASE}}", | ||
| + | "required": false | ||
| + | }, | ||
| + | "brief": { | ||
| + | "label": "brief", | ||
| + | "description": "The \"brief\" parameter may be used to display the external link without the appended description. The value can be \"yes\", \"true\", or any text. This parameter is optional.", | ||
| + | "type": "string", | ||
| + | "required": false | ||
| + | } | ||
}, | }, | ||
| − | " | + | "paramOrder": [ |
| − | " | + | "id", |
| − | + | "name", | |
| − | + | "brief" | |
| − | " | + | ] |
| − | + | } | |
| − | + | </templatedata> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Examples == | == Examples == | ||
| Line 92: | Line 100: | ||
* {{tl|USA Gymnastics name}} | * {{tl|USA Gymnastics name}} | ||
| − | <includeonly>{{ | + | <includeonly>{{sandbox other|| |
| − | <!-- Categories | + | <!-- Categories below this line; interwikis at Wikidata --> |
| + | [[Category:Gymnastics external link templates]] | ||
| + | [[Category:Sports governing body external link templates]] | ||
[[Category:People and person external link templates]] | [[Category:People and person external link templates]] | ||
| − | [[Category: | + | [[Category:External link templates using Wikidata]] |
| − | |||
[[Category:Templates that add a tracking category]] | [[Category:Templates that add a tracking category]] | ||
| − | |||
| − | |||
}}</includeonly> | }}</includeonly> | ||
Revision as of 11:57, 7 March 2017
| This is a documentation subpage for Template:FIG. It contains usage information, categories and other content that is not part of the original template page. |
Template:Uses Wikidata Template:Tracks Wikidata
| 30px | This template uses Lua: |
Template:FIG displays an external link to an gymnast's profile at FIG-gymnastics.com, the official website of the International Federation of Gymnastics (FIG: Fédération Internationale de Gymnastique). It is intended for use in the external links section of an article.
Contents
Usage
Unnamed parameters:
{{FIG | ID }}{{FIG | ID | NAME }}
Named parameters:
{{FIG | id= ID }}{{FIG | id= ID | name= NAME }}{{FIG | id= ID | brief= yes }}{{FIG | id= ID | name= NAME | brief= yes }}
Using Wikidata property P2696:
{{FIG}}{{FIG | name= NAME }}{{FIG | brief= yes }}{{FIG | name= NAME | brief= yes }}
TemplateData
TemplateData for FIG
This template displays an external link to an gymnast's profile at FIG-gymnastics.com, the official website of the International Federation of Gymnastics (FIG: Fédération Internationale de Gymnastique). It is intended for use in the external links section of an article.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| id | id 1 | The "id" parameter (or unnamed parameter "1") should contain the ID portion of the URL. Example: 13822 is the ID portion of https://database.fig-gymnastics.com/public/gymnasts/biography/13822/true?backUrl=. This parameter is optional if Wikidata property P2696 exists, but required if not.
| Number | optional |
| name | name 2 | The "name" parameter (or unnamed parameter "2") may be used to specify the link text, which should be the name of the gymnast. This parameter is optional; it defaults to the Wikipedia article name, without any disambiguation such as "(gymnast)".
| String | optional |
| brief | brief | The "brief" parameter may be used to display the external link without the appended description. The value can be "yes", "true", or any text. This parameter is optional. | String | optional |
Examples
Unnamed parameters
URL:
Usage:
{{FIG | 13822 | Alexandra Raisman }}
Output:
Named parameters
URL:
Usage:
{{FIG |id= 597 |name= Marco Torres }}
Output:
Usage:
{{FIG |id= 597 |name= Marco Torres |brief= yes }}
Output:
No parameters and Wikidata property not defined
Usage:
{{FIG}}
Output:
- Template:PAGENAMEBASE at the International Gymnastics FederationScript error: No such module "EditAtWikidata".
Tracking categories
- "id" parameter exists
- Category:FIG gymnast ID not in Wikidata (0)
- Category:FIG gymnast ID different from Wikidata (0)
- Category:FIG gymnast ID same as Wikidata (0)
- "id" parameter does not exist
See also