View source for Template:Sports-reference/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

'''{{NAMESPACE}}:{{BASEPAGENAME}}''' displays an external link to a [[Sports Reference]] web page for an [[Olympic Games]] athlete.

== Usage ==
Unnamed parameters:
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''ID''|''NAME''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''ID''<nowiki>}}</nowiki></code>

Named parameters:
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|id=''ID''|name=''NAME''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|id=''ID''<nowiki>}}</nowiki></code>

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
"description": "This template displays an external link to a Sports Reference web page for an Olympic Games athlete.",
"params": {
  "1": {
    "label": "ID",
    "aliases": ["id"], 
    "description": "ID portion of the URL for an athlete's Sports Reference web page. Example: ab/jeremy-abbott-2 is the ID portion of http://www.sports-reference/olympics/athletes/ab/jeremy-abbott-2.html",
    "type": "string",
    "default": "",
    "required": true
  },
  "2": {
    "label": "Name",
    "aliases": ["name"], 
    "description": "Name of athlete. If not given it defaults to the Wikipedia article name, without any disambiguation such as (athlete).",
    "type": "string",
    "default": "{{PAGENAME}}",
    "required": false
  }
}}</templatedata>

== Examples ==

=== Unnamed parameters ===
''Usage:''
* <code><nowiki>{{</nowiki>Sports-reference | da/gunn-rita-dahle-flesja-1 | Gunn-Rita Dahle Flesjå }}</code>
''Output:''
* {{Sports-reference | da/gunn-rita-dahle-flesja-1 | Gunn-Rita Dahle Flesjå }}
''URL:''
* http://www.sports-reference.com/olympics/athletes/da/gunn-rita-dahle-flesja-1.html

=== Named parameters ===
''Usage:''
* <code><nowiki>{{</nowiki>Sports-reference |id= ab/jeremy-abbott-2 |name= Jeremy Abbott }}</code>
''Output:''
* {{Sports-reference |id= ab/jeremy-abbott-2 |name= Jeremy Abbott }}
''URL:''
* http://www.sports-reference.com/olympics/athletes/ab/jeremy-abbott-2.html

== See also ==
* {{tlx|Cite sports-reference}}, for links used in a reference
* {{tlx|USOC profile}}, which uses a similar format
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Sports external link templates]]
[[Category:People and person external link templates]]

}}</includeonly>