Difference between revisions of "Template:Infobox MLB player/doc"

From blackwiki
Jump to navigation Jump to search
imported>John of Reading
m (→‎TemplateData: Typo fixing, replaced: playes → plays using AWB)
imported>Muboshgu
(templates were merged, this doc page is redundant)
 
Line 1: Line 1:
{{Documentation subpage}}
+
#REDIRECT[[Template:Infobox baseball biography/doc]]
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
 
 
This template can be used to add at-a-glance comparative information to articles on [[Major League Baseball]] players.
 
 
 
Team colors are now added to the infobox automatically when a team is entered into the team field. The colors are taken from [[Module:Baseball color/data]].
 
 
 
== Usage ==
 
 
 
Copy and paste the template below:
 
<pre style="overflow:auto">
 
{{Infobox MLB player
 
| name        =
 
| image      =
 
| position    =
 
| birth_date  = <!-- {{birth date and age|YYYY|MM|DD}} -->
 
| birth_place =
 
| death_date  = <!-- {{death date and age|YYYY|MM|DD|YYYY|MM|DD}} (death date then birth date) -->
 
| death_place =
 
| bats        =
 
| throws      =
 
| debutdate  =
 
| debutyear  =
 
| debutteam  =
 
| finaldate  =
 
| finalyear  =
 
| finalteam  =
 
| stat1label  =
 
| stat1value  =
 
| stat2label  =
 
| stat2value  =
 
| stat3label  =
 
| stat3value  =
 
| teams      =
 
}}
 
</pre>
 
 
 
To use the full version, use this template:
 
<pre style="overflow:auto">
 
{{Infobox MLB player
 
| name        =
 
| image      =
 
| image_size  =
 
| alt        =
 
| caption    =
 
| team        =
 
| number      =
 
| position    =
 
| positionplain =
 
| birth_date  = <!-- {{birth date and age|YYYY|MM|DD}} -->
 
| birth_place =
 
| death_date  = <!-- {{death date and age|YYYY|MM|DD|YYYY|MM|DD}} (death date then birth date) -->
 
| death_place =
 
| bats        =
 
| throws      =
 
| debutdate  =
 
| debutyear  =
 
| debutteam  =
 
| finaldate  =
 
| finalyear  =
 
| finalteam  =
 
| statyear    =
 
| stat1label  =
 
| stat1value  =
 
| stat2label  =
 
| stat2value  =
 
| stat3label  =
 
| stat3value  =
 
| stat4label  =
 
| stat4value  =
 
| stat5label  =
 
| stat5value  =
 
| stat6label  =
 
| stat6value  =
 
| highlights  =
 
| teams      =
 
| hofdate    =
 
| hofvote    =
 
| hofmethod  =
 
| hoffuture  = (set to true if the player has been announced but not inducted)
 
}}
 
</pre>
 
 
 
=== Parameters ===
 
Please refer to [[Wikipedia:WikiProject Baseball/Player style advice]] for guidance on what to include in an MLB player's infobox.
 
 
 
Note that all of these parameters are optional—it is better not to include one than to include misleading or incomplete information. For a nineteenth-century player about whom almost nothing is known, it may be better to forgo the infobox completely than to have an empty skeleton.
 
 
 
{| class="wikitable" border="1"
 
! width="50" | Field Name
 
! Description
 
|-
 
|name||name of player
 
|-
 
| colspan="2" style="text-align:center;background:#fff8dc;" | {{Caution|Do not upload images from MLB.com or any other site unless you are ''certain'' the images are public domain or otherwise fair to use on Wikipedia. See [[Wikipedia:Copyrights]] for more information.}}
 
|-
 
|image||filename of the image of the player, not preceded by "Image:" (optional)
 
|-
 
|image_size||width of image in pixels, don't use unless smaller than 200 (optional, defaults to 200)
 
|-
 
|alt||alt text for image, for visually impaired readers; see [[WP:ALT]]
 
|-
 
|caption||caption text for image (optional)
 
|-
 
|team||current [[Major League Baseball#Current Major League Clubs|team]]
 
|-
 
|number||current uniform number
 
|-
 
|position||the [[Baseball positions|position]](s) primarily played by the player now (active players) or in their career (retired players): [[Pitcher]], [[Catcher]], [[First baseman]], [[Second baseman]], [[Third baseman]], [[Shortstop]], [[Left fielder]], [[Center fielder]] or [[Right fielder]].
 
|-
 
|birth_date||For living players: {{tlx|birth date and age|YYYY|MM|DD}}, where YYYY is the year, MM is month, and DD is day<br>For deceased players: {{tlx|birth date|YYYY|MM|DD}}, where YYYY is the year, MM is month, and DD is day
 
|-
 
|death_date||''NOTE:'' Only if the player is deceased: {{tlx|death date and age|YYYY|MM|DD|YYYY|MM|DD}}, with death date followed by birth date, where YYYY is the year, MM is month, and DD is day
 
|-
 
|bats||Left, Right, Switch, or Unknown
 
|-
 
|throws||Left, Right, or Unknown
 
|-
 
|debutdate||debut date (Month and day only)
 
|-
 
|debutyear||debut year
 
|-
 
|debutteam||debut team
 
|-
 
|statyear||the year or date that the stats listed below apply to
 
|-
 
|stat1label||the most important statistic for evaluating this player.  Will vary according to what the player is most well known for.
 
|-
 
|stat1value||the value of that statistic.
 
|-
 
|stat2label||another statistic (up to six can be used--in exceptional cases!)
 
|-
 
|stat2value||etc.
 
|-
 
|stat3label
 
|-
 
|stat3value
 
|-
 
|stat4label
 
|-
 
|stat4value
 
|-
 
|stat5label
 
|-
 
|stat5value
 
|-
 
|stat6label
 
|-
 
|stat6value
 
|-
 
|highlights||list of career highlights; see [[Wikipedia:WikiProject Baseball/Player style advice#Infobox]] for guidance
 
|-
 
|teams||list of teams (former and present) the player has played for, with their years.  Note that the "formerteams" option is deprecated and should be converted to teams. Teams should be shown in chronological order (years played in parentheses), like this:
 
*Washington Senators (1939–1942, 1945–1949)
 
*Boston Red Sox (1949–1952)
 
*Washington Senators (1952–1953)
 
*Detroit Tigers (1956)
 
|-
 
|hofdate||if the player is a member of the National Baseball Hall of Fame, enter the date (or at least year) that he was elected.  Setting this tag will make a Hall of Fame banner appear. (note that {{tl2|Infobox baseball biography}} also has these fields and may be more appropriate)
 
|-
 
|hofvote||put details of the HoF vote (if any) here.
 
|-
 
|hofmethod||put details of the method elected (veteran's committee, Negro league, etc.) here.  Leave blank if a standard vote
 
|-
 
|hoffuture||declare this variable (any value, but "true" is an obvious choice) for players who have elected to the HoF but who have not yet been inducted. This variable will modify the HoF banner to say "Incoming Member"; the purpose of this is to reduce arguments from editors about whether or not to include the HoF section before the induction date.
 
|}
 
 
 
== Examples ==
 
{{Infobox MLB player
 
| name      = All Options On (+HoF)
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| caption    = Caption
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| statyear  = 2005
 
| stat1label = [[Batting average]]
 
| stat1value = .340
 
| stat2label = [[Run batted in|Runs batted in]]
 
| stat2value = 586
 
| stat3label = [[Home run]]s
 
| stat3value = 233
 
| teams      =
 
*First Team Name ({{MLB Year|2000}}–{{MLB Year|2003}})
 
*Second Team Name ({{MLB Year|2003}}–{{MLB Year|2004}})
 
*Current Team Name ({{MLB Year|2005}}–present)
 
| hofdate    = March 20, 2007
 
| hofvote    = 88% (first ballot)
 
| hofmethod  = Veteran's Committee
 
}}
 
 
 
{{Infobox MLB player
 
| name      = No Teams Listed
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| caption    = Caption
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| statyear  = 2005
 
| stat1label = [[Batting average]]
 
| stat1value = .340
 
| stat2label = [[Run batted in|Runs batted in]]
 
| stat2value = 586
 
| stat3label = [[Home run]]s
 
| stat3value = 233
 
}}
 
 
 
{{Infobox MLB player
 
| name      = No Stats
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| caption    = Caption
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| teams      =
 
*First Team Name ({{MLB Year|2000}}–{{MLB Year|2003}})
 
*Second Team Name ({{MLB Year|2003}}–{{MLB Year|2004}})
 
*Current Team Name ({{MLB Year|2005}}–present)
 
}}
 
 
 
{{Infobox MLB player
 
| name      = No Stats, No Teams
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| caption    = Caption
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
}}
 
 
 
{{Infobox MLB player
 
| name      = Two Stats
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| caption    = Caption
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| statyear  = 2005
 
| stat1label = [[Batting average]]
 
| stat1value = .340
 
| stat2label = [[Run batted in|Runs batted in]]
 
| stat2value = 586
 
| teams      =
 
*First Team Name ({{MLB Year|2000}}–{{MLB Year|2003}})
 
*Second Team Name ({{MLB Year|2003}}–{{MLB Year|2004}})
 
*Current Team Name ({{MLB Year|2005}}–present)
 
}}
 
 
 
{{Infobox MLB player
 
| name      = No Caption
 
| image      = Baseball (crop).jpg
 
| width      = 100
 
| alt        = Alt text
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| statyear  = 2005
 
| stat1label = [[Batting average]]
 
| stat1value = .340
 
| stat2label = [[Run batted in|Runs batted in]]
 
| stat2value = 586
 
| stat3label = [[Home run]]s
 
| stat3value = 233
 
| teams      =
 
*First Team Name ({{MLB Year|2000}}–{{MLB Year|2003}})
 
*Second Team Name ({{MLB Year|2003}}–{{MLB Year|2004}})
 
*Current Team Name ({{MLB Year|2005}}–present)
 
}}
 
 
 
{{Infobox MLB player
 
| name      = No Image
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
| statyear  = 2005
 
| stat1label = [[Batting average]]
 
| stat1value = .340
 
| stat2label = [[Run batted in|Runs batted in]]
 
| stat2value = 586
 
| stat3label = [[Home run]]s
 
| stat3value = 233
 
| teams      =
 
*First Team Name ({{MLB Year|2000}}–{{MLB Year|2003}})
 
*Second Team Name ({{MLB Year|2003}}–{{MLB Year|2004}})
 
*Current Team Name ({{MLB Year|2005}}–present)
 
}}
 
 
 
{{Infobox MLB player
 
| name      = All Options Off
 
| bgcolor1  = darkblue
 
| textcolor1 = white
 
| bgcolor2  = red
 
| textcolor2 = white
 
| team      = Team Name
 
| number    = 99
 
| position  = Position
 
| bats      = Bats
 
| throws    = Throws
 
| debutdate  = June 1
 
| debutyear  = 2000
 
| debutteam  = Team Name
 
}}
 
 
 
{{-}}
 
 
 
=== Microformat ===
 
{{UF-hcard-person}}
 
 
 
==TemplateData==
 
 
 
<templatedata>
 
{
 
"params": {
 
"name": {
 
"required": true,
 
"label": "Name",
 
"type": "string",
 
"description": "Name of Player."
 
},
 
"image": {
 
"required": false,
 
"label": "Image",
 
"type": "wiki-page-name",
 
"description": "Image of Player"
 
},
 
"position": {
 
"required": false,
 
"label": "position",
 
"type": "string",
 
"description": "Position at which the player plays"
 
},
 
"alt": {
 
"required": false,
 
"label": "Image alternative text",
 
"type": "string",
 
"description": "Alt text to display if the image specified by image_name does not display for whatever reason"
 
},
 
"caption": {
 
"required": false,
 
"label": "Image caption",
 
"type": "string",
 
"description": "Caption for the image."
 
},
 
"pseudonym": {
 
"required": false,
 
"label": "Pseudonym",
 
"type": "string",
 
"description": "Name used by the artist(artist name)"
 
},
 
"birth_name": {
 
"required": false,
 
"label": "Birth Name",
 
"type": "string",
 
"description": "Nomenclature at the time of birth"
 
},
 
"birth_date": {
 
"required": false,
 
"label": "Birth Date",
 
"type": "line",
 
"description": "Date of birth and age of player"
 
},
 
"birth_place": {
 
"required": false,
 
"label": "Birth Place",
 
"type": "string",
 
"description": "Player's place of birth"
 
},
 
"death_date": {
 
"required": false,
 
"label": "Death Date",
 
"type": "line",
 
"description": "Date of death of player"
 
},
 
"death_place": {
 
"required": false,
 
"label": "Death Place",
 
"type": "string",
 
"description": "Player's place of death"
 
},
 
"bats": {
 
"required": false,
 
"label": "Bats",
 
"type": "string",
 
"description": "Arm that is used by the player to bat"
 
},
 
"throws": {
 
"required": false,
 
"label": "Throws",
 
"type": "string",
 
"description": "Arm that is used by the player to throw"
 
},
 
"debutdate": {
 
"required": false,
 
"label": "Debut Date",
 
"type": "line",
 
"description": "Date of debut of the player(Month and date)"
 
},
 
"debutyear": {
 
"required": false,
 
"label": "Debut Year",
 
"type": "number",
 
"description": "Year of debut"
 
},
 
"debutteam": {
 
"required": false,
 
"label": "Debut Team",
 
"type": "string",
 
"description": "Team for which the player made his debut"
 
},
 
"finaldate": {
 
"required": false,
 
"label": "Final Date",
 
"type": "line",
 
"description": "Date of the final match played by the player(Month and date)"
 
},
 
"finalyear": {
 
"required": false,
 
"label": "Final Year",
 
"type": "number",
 
"description": "Year of final match"
 
},
 
"finalteam": {
 
"required": false,
 
"label": "Final Team",
 
"type": "string",
 
"description": "Team for which the player played his final game"
 
},
 
"stat1label": {
 
"required": false,
 
"label": "Stat1Label",
 
"type": "string",
 
"description": "Most important statistic for evaluating the player"
 
},
 
"stat1value": {
 
"required": false,
 
"label": "Stat1Value",
 
"type": "string",
 
"description": "Value of the statistic"
 
},
 
"teams": {
 
"required": false,
 
"label": "Teams",
 
"type": "string",
 
"description": "Teams that the player played for"
 
}
 
}
 
}
 
</templatedata>
 
 
 
=== See also ===
 
* {{tl|Infobox baseball biography}}
 
 
 
<includeonly>
 
{{Basepage subpage|
 
[[Category:Baseball player infobox templates|MLB player]]
 
[[Category:Sportsperson infobox templates|MLB player]]
 
}}
 
</includeonly>
 

Latest revision as of 18:14, 30 November 2016