Changes
Jump to navigation
Jump to search
m
Template:Biographical Directory of Congress/doc (view source)
Revision as of 18:05, 29 October 2018
, 5 years agoadd {{documentation subpage}}
{{documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
'''<nowiki>{{Biographical Directory of Congress}}</nowiki>''' (and its shorter redirect '''<nowiki>{{CongBio}}</nowiki>''') displays an external link to a specified article at the [[Biographical Directory of the United States Congress]] website ([http://bioguide.congress.gov bioguide.congress.gov]).
== Usage ==
In the following, <code><nowiki>{{</nowiki>Biographical Directory of Congress</code> can be used instead of <code><nowiki>{{</nowiki>CongBio</code>.
=== Unnamed parameters ===
* <code><nowiki>{{</nowiki>CongBio|''ID''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|''ID''|''NAME''<nowiki>}}</nowiki></code>
=== Named parameters ===
* <code><nowiki>{{</nowiki>CongBio|id=''ID''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''|inline=''YES''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''|findagrave=''GRID''<nowiki>}}</nowiki></code>
There are some other additional parameters that carry default values:
author=''author'' — defaults to ''United States Congress'', but it can be overwritten
mode =''mode'' — defaults to ''cs1'' but can be set to ''cs2'' (see [[WP:CS1]])
ref =''ref'' — for use with the {{tlx|harv}} templates for inline citations
defaults to:<code><nowiki>{{</nowiki>harv|United States Congress|''ID''}}</code>
If the author is set to something other than ''United States Congress''
then it is also changed here. The ref parameter can be assigned another
value including ''none'' to unset the parameter.
accessdate=''date'' — the usual name for the "Retrieved" parameter
== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
"description": "This template displays an external link to a specified article at the Biographical Directory of the United States Congress website (bioguide.congress.gov).",
"params": {
"1": {
"label": "ID",
"aliases": ["id"],
"description": "ID portion of the URL. Example: C000482 is the ID portion of http://bioguide.congress.gov/scripts/biodisplay.pl?index=C000482",
"type": "string",
"default": "",
"required": true
},
"2": {
"label": "Name",
"aliases": ["name"],
"description": "Name of subject. If not given it defaults to the Wikipedia article name, without any disambiguation such as (politician).",
"type": "string",
"default": "{{PAGENAME}}",
"required": false
},
"accessdate": {
"label": "Access date",
"aliases": ["date"],
"description": "Date the web page was accessed/retrieved.",
"type": "date",
"required": false
},
"author": {
"label": "Author",
"description": "Value assigned to the \"author\" parameter of the {{cite web}} template.",
"type": "string",
"default": "United States Congress",
"required": false
},
"ref": {
"label": "Ref",
"description": "Value assigned to the \"ref\" parameter of the {{cite web}} template.",
"type": "string",
"required": false
},
"mode": {
"label": "Mode",
"description": "Value assigned to the \"mode\" parameter of the {{cite web}} template.",
"type": "string",
"required": false
},
"noid": {
"label": "No ID",
"description": "If this parameter is assigned a value (yes, 1, or anything) then the \"id\" parameter will not be displayed in parentheses after the \"name\" parameter.",
"type": "string",
"required": false
},
"inline": {
"label": "Inline",
"description": "If this parameter is assigned a value (yes, 1, or anything) then the leading asterisk/bullet is not displayed.",
"type": "string",
"required": false
},
"findagrave": {
"label": "Findagrave",
"description": "If this parameter is assigned a value, then the template will display an external link to the associated page at the Find a Grave website.",
"type": "string",
"required": false
}
}}</templatedata>
== Examples ==
In the following, <code><nowiki>{{</nowiki>Biographical Directory of Congress</code> can be used instead of <code><nowiki>{{</nowiki>CongBio</code>.
These examples all link to [[Henry Clay]]'s biography, which is located at:
* http://bioguide.congress.gov/scripts/biodisplay.pl?index=C000482
=== Unnamed parameters ===
''Usage:''
: <code><nowiki>{{</nowiki>CongBio | C000482 | Henry Clay }}</code>
''Output:''
: {{CongBio | C000482 | Henry Clay }}
=== Named parameters ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay }}</code>
''Output'':
: {{CongBio| id= C000482 | name= Henry Clay }}
=== Access date ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |accessdate= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |accessdate= January 26, 2010 }}
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |date= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |date= January 26, 2010 }}
=== Author ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |author= }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |inline= |author= }}
=== No ID ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |noid= y }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |noid= y }}
=== Inline ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |inline= yes }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |inline= yes }}
=== Findagrave ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 }}
=== Findagrave and access date ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |date= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |date= January 26, 2010 }}
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |accessdate= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |accessdate= January 26, 2010 }}
==See also==
* {{tl|CongLinks}} - For members from 1991–present. It has BioGuide, Washington Post voting record, Open Secrets, FEC reports, Vote Smart, On The issues, Legistorm, StateSurge GovTrack and FindAGrave. '''This is preferred.'''
* {{tl|Bioguide}} looks like this: {{Bioguide}}
* {{tl|Cleanup Congress Bio}} puts articles in the category, [[:Category:Biographical Directory of the United States Congress cleanup]].
* [[Biographical Directory of the United States Congress]]
* [[Wikipedia:WikiProject U.S. Congress/Bioguide]], a subpage of '''Project Congress''', tracks how well information is imported from the Bioguide.
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:People and person external link templates]]
[[Category:United States Congress external link templates]]
[[Category:United States government attribution templates]]
[[Category:Templates containing multiple external links]]
}}</includeonly>
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
'''<nowiki>{{Biographical Directory of Congress}}</nowiki>''' (and its shorter redirect '''<nowiki>{{CongBio}}</nowiki>''') displays an external link to a specified article at the [[Biographical Directory of the United States Congress]] website ([http://bioguide.congress.gov bioguide.congress.gov]).
== Usage ==
In the following, <code><nowiki>{{</nowiki>Biographical Directory of Congress</code> can be used instead of <code><nowiki>{{</nowiki>CongBio</code>.
=== Unnamed parameters ===
* <code><nowiki>{{</nowiki>CongBio|''ID''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|''ID''|''NAME''<nowiki>}}</nowiki></code>
=== Named parameters ===
* <code><nowiki>{{</nowiki>CongBio|id=''ID''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''|inline=''YES''<nowiki>}}</nowiki></code>
* <code><nowiki>{{</nowiki>CongBio|id=''ID''|name=''NAME''|date=''DATE''|findagrave=''GRID''<nowiki>}}</nowiki></code>
There are some other additional parameters that carry default values:
author=''author'' — defaults to ''United States Congress'', but it can be overwritten
mode =''mode'' — defaults to ''cs1'' but can be set to ''cs2'' (see [[WP:CS1]])
ref =''ref'' — for use with the {{tlx|harv}} templates for inline citations
defaults to:<code><nowiki>{{</nowiki>harv|United States Congress|''ID''}}</code>
If the author is set to something other than ''United States Congress''
then it is also changed here. The ref parameter can be assigned another
value including ''none'' to unset the parameter.
accessdate=''date'' — the usual name for the "Retrieved" parameter
== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
"description": "This template displays an external link to a specified article at the Biographical Directory of the United States Congress website (bioguide.congress.gov).",
"params": {
"1": {
"label": "ID",
"aliases": ["id"],
"description": "ID portion of the URL. Example: C000482 is the ID portion of http://bioguide.congress.gov/scripts/biodisplay.pl?index=C000482",
"type": "string",
"default": "",
"required": true
},
"2": {
"label": "Name",
"aliases": ["name"],
"description": "Name of subject. If not given it defaults to the Wikipedia article name, without any disambiguation such as (politician).",
"type": "string",
"default": "{{PAGENAME}}",
"required": false
},
"accessdate": {
"label": "Access date",
"aliases": ["date"],
"description": "Date the web page was accessed/retrieved.",
"type": "date",
"required": false
},
"author": {
"label": "Author",
"description": "Value assigned to the \"author\" parameter of the {{cite web}} template.",
"type": "string",
"default": "United States Congress",
"required": false
},
"ref": {
"label": "Ref",
"description": "Value assigned to the \"ref\" parameter of the {{cite web}} template.",
"type": "string",
"required": false
},
"mode": {
"label": "Mode",
"description": "Value assigned to the \"mode\" parameter of the {{cite web}} template.",
"type": "string",
"required": false
},
"noid": {
"label": "No ID",
"description": "If this parameter is assigned a value (yes, 1, or anything) then the \"id\" parameter will not be displayed in parentheses after the \"name\" parameter.",
"type": "string",
"required": false
},
"inline": {
"label": "Inline",
"description": "If this parameter is assigned a value (yes, 1, or anything) then the leading asterisk/bullet is not displayed.",
"type": "string",
"required": false
},
"findagrave": {
"label": "Findagrave",
"description": "If this parameter is assigned a value, then the template will display an external link to the associated page at the Find a Grave website.",
"type": "string",
"required": false
}
}}</templatedata>
== Examples ==
In the following, <code><nowiki>{{</nowiki>Biographical Directory of Congress</code> can be used instead of <code><nowiki>{{</nowiki>CongBio</code>.
These examples all link to [[Henry Clay]]'s biography, which is located at:
* http://bioguide.congress.gov/scripts/biodisplay.pl?index=C000482
=== Unnamed parameters ===
''Usage:''
: <code><nowiki>{{</nowiki>CongBio | C000482 | Henry Clay }}</code>
''Output:''
: {{CongBio | C000482 | Henry Clay }}
=== Named parameters ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay }}</code>
''Output'':
: {{CongBio| id= C000482 | name= Henry Clay }}
=== Access date ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |accessdate= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |accessdate= January 26, 2010 }}
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |date= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |date= January 26, 2010 }}
=== Author ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |author= }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |inline= |author= }}
=== No ID ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |noid= y }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |noid= y }}
=== Inline ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |inline= yes }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |inline= yes }}
=== Findagrave ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 }}
=== Findagrave and access date ===
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |date= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |date= January 26, 2010 }}
''Usage'':
: <code><nowiki>{{</nowiki>CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |accessdate= January 26, 2010 }}</code>
''Output'':
: {{CongBio |id= C000482 |name= Henry Clay |findagrave= 203 |accessdate= January 26, 2010 }}
==See also==
* {{tl|CongLinks}} - For members from 1991–present. It has BioGuide, Washington Post voting record, Open Secrets, FEC reports, Vote Smart, On The issues, Legistorm, StateSurge GovTrack and FindAGrave. '''This is preferred.'''
* {{tl|Bioguide}} looks like this: {{Bioguide}}
* {{tl|Cleanup Congress Bio}} puts articles in the category, [[:Category:Biographical Directory of the United States Congress cleanup]].
* [[Biographical Directory of the United States Congress]]
* [[Wikipedia:WikiProject U.S. Congress/Bioguide]], a subpage of '''Project Congress''', tracks how well information is imported from the Bioguide.
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:People and person external link templates]]
[[Category:United States Congress external link templates]]
[[Category:United States government attribution templates]]
[[Category:Templates containing multiple external links]]
}}</includeonly>
