View source for Template:Infobox animal/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}
{{About|the infobox used for specific animals with given names, including individual pets|the animal species|Template:Taxobox#Animal species}}

==Usage==

The infobox may be added by pasting the template as shown below into an article. All fields are optional and unused parameter names can be left blank or omitted.

{{Parameter names example | name | image | image_size <!-- | image size | imagesize --> | image_upright | landscape | alt | caption | othername | species | breed | sex | birth_name | birth_date | birth_place | hatch_name | hatch_date | hatch_place | death_date | death_place | death_cause | resting_place | resting_place_coordinates | nationality | occupation | employer | role | years_active | known_for <!-- | known --> | tricks | title | term | predecessor | successor | owner | residence | parents | mate | children <!-- | weight_kg | weight_st | weight_lb --> | weight <!-- | height_cm | height_ft | height_in --> | height | appearance | namedafter | awards | website | module | module2 | module3 | module4 | module5 | footnotes }}

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Infobox animal
| name          = 
| image         = 
| image_upright = 
| landscape     = <!-- yes, if wide image, otherwise leave blank -->
| alt           = <!-- descriptive text for use by speech synthesis (text-to-speech) software -->
| caption       = 
| othername     = 
| species       = 
| breed         = 
| sex           = 
| birth_name    = <!-- (or hatch_name= value; for non-mammals) -->
| birth_date    = <!-- (or hatch_date= value; for non-mammals) -->
| birth_place   = <!-- (or hatch_place= value; for non-mammals)-->
| death_date    = 
| death_place   = 
| death_cause   =
| resting_place = 
| resting_place_coordinates = 
| nationality   = <!-- use only when necessary per [[WP:INFONAT]] -->
| occupation    = 
| employer      = 
| role          = 
| years_active  = 
| known_for     = 
| tricks        = 
| awards        = 
| title         = 
| term          = 
| predecessor   = 
| successor     = 
| owner         = 
| residence     = 
| parents       = 
| mate          = 
| children      = 
| weight        = 
| height        = 
| appearance    = 
| namedafter    = 
| module        = 
| module2       = 
| module3       = 
| module4       = 
| module5       = 
| website       = 
| footnotes     = 
}}
</syntaxhighlight>
{{Clear}}

== Parameters ==

{| class="wikitable"
! Parameter
! Explanation
|-
| name
| The given name of the animal. Use the animal's common name, typically the name of article, if multiple names are used. If omitted or blank it defaults to the name of the article.
|-
| image
| Image file name. Use only the file name such as abc.jpg, xyz.png, 123.gif, etc. Do not use syntax such as <del><nowiki>[[File:abc.jpg]]</nowiki></del> or <del><nowiki>[[File:abc.jpg|200px]]</nowiki></del>.
|-
| image_size
| For example, 150px
|-
| image_upright
| Image scaling factor, e.g. 1.2 for 120%
|-
| landscape
| Set to "yes" when using wide, short images. The image height (rather than width) will be limited to 200 pixels. 
|-
| alt
| The [[alt attribute]] for the image, for readers who cannot see the image. See [[WP:ALT]].
|-
| caption
| Photograph caption. Try to include date of photo and the photographer.
|-
| birth_name
| Name at birth if it has changed since birth.
|-
| othername
| Other appellation(s) that the animal has been known by.
|-
| species
| The scientific (aka "Latin") [[species]] name of the animal.
|-
| breed
| The [[breed]] of the animal.
|-
| sex
| The [[sex]] of the animal.
|-
| birth_date
| Date of birth. Consider using {{tl|birth date and age}} if the animal is living, otherwise use {{tl|birth date}}.
|-
| birth_place
| Place of birth: town, city, state, country.
|-
| death_date
| Date of death. Consider using {{tl|death date and age}}.
|-
| death_place
| Place of death: town, city, state, country.
|-
| death_cause
| Should be clearly defined, and should only be included when the cause of death has significance for the subject's notability
|-
| resting_place
| Name of cemetery; place of ash-scattering, etc.
|-
| resting_place_coordinates
| Coordinates of cemetery; place of ash-scattering, etc. using {{tl|coord}} with ''display=inline,title''. For graves, please be as precise as possible.
|-
| nationality
| The country the animal is from.
|-
| occupation
| The occupation(s) animal is known for, e.g. [[pet]], [[wiktionary:mouser|mouser]], [[actor]].
|-
| employer
| The employer of the animal.
|-
| role
| If the animal is/was an actor, insert any famous roles the animal is known for.
|-
| years_active
| The years that the animal was active in its career. Use the format: <blockquote><nowiki>year of first professional performance</nowiki>–<nowiki>year of final professional appearance</nowiki></blockquote>Note: If still active, use "present" in place of the end year.
|-
| known
| A brief description of why the animal is notable.
|-
| tricks
| Notable tricks the animal has been [[animal training|trained]] to perform.
|-
| awards
| Any awards won.
|-
| title
| Any title the animal has held.
|-
| term
| The years the animal held the '''title''' listed above.
|-
| predecessor
| The name of the animal who previously held the '''title''' listed above.
|-
| successor
| The name of the animal who subsequently held the '''title''' listed above.
|-
| owner
| The animal's owner.
|-
| residence
| Place of residence
|-
| parents
| The names of the animal's ''notable'' parent(s) (<nowiki><br /></nowiki>).
|-
| mate
| The names of ''especially notable'' mate(s) of the animal(<nowiki><br /></nowiki>).
|-
| children
| The names of ''especially notable'' offspring of the animal(<nowiki><br /></nowiki>).
|-
| weight
| The weight of the animal (should also include the date).
|-
| height
| The height of the animal (should also include the date).
|-
| appearance
| The appearance of the animal.
|-
| namedafter
| Who or what the animal was named after.
|-
| website
| The animal's official website. Use only the link such as <nowiki>http://www.example.com/</nowiki>. Do not use syntax such as <del><nowiki>[http://www.example.com/]</nowiki></del>.
|-
| {{ubl | '''module''' | '''module2''' | '''module3''' | '''module4''' | '''module5'''}}
| Used for embedding other infoboxes into this one.
|}

== TemplateData ==
{{TemplateData header}}

<templatedata>
{
	"params": {
		"name": {
			"label": "Name",
			"description": "The given name of the animal. Use the animal's common name, typically the name of article, if multiple names are used. If omitted or blank it defaults to the name of the article.",
			"type": "string",
			"suggested": true
		},
		"image": {
			"label": "Image",
			"description": "Image file name. Use only the file name such as abc.jpg, xyz.png, 123.gif, etc.",
			"type": "wiki-file-name",
			"suggested": true
		},
		"image_size": {
			"label": "Image size",
			"description": "For example, 150px",
			"type": "string",
			"aliases": [
				"imagesize",
				"image size"
			]
		},
		"image_upright": {
			"label": "Image upright",
			"description": "Image scaling factor, e.g. 1.2 for 120%",
			"type": "number"
		},
		"landscape": {
			"label": "Landscape",
			"description": "Set to \"yes\" when using wide, short images. The image height (rather than width) will be limited to 200 pixels.",
			"type": "string",
			"autovalue": "yes"
		},
		"alt": {
			"label": "Alt",
			"description": "The [[alt attribute]] for the image, for readers who cannot see the image. See [[WP:ALT]].",
			"type": "string"
		},
		"caption": {
			"label": "Caption",
			"description": "Photograph caption. Try to include date of photo and the photographer.",
			"type": "string",
			"suggested": true,
			"aliases": [
				"image caption",
				"image_caption"
			]
		},
		"birth_name": {
			"label": "Birth name",
			"description": "Name at birth if it has changed since birth.",
			"type": "string"
		},
		"othername": {
			"label": "Other name",
			"description": "Other appellation(s) that the animal has been known by.",
			"type": "string"
		},
		"species": {
			"label": "Species",
			"description": "The scientific (aka \"Latin\") [[species]] name of the animal.",
			"type": "string",
			"suggested": true
		},
		"breed": {
			"label": "Breed",
			"description": "The [[breed]] of the animal.",
			"type": "string",
			"suggested": true
		},
		"sex": {
			"label": "Sex",
			"description": "The [[sex]] of the animal.",
			"type": "string",
			"suggested": true,
			"aliases": [
				"gender"
			]
		},
		"birth_date": {
			"label": "Birth date",
			"description": "Date of birth. Consider using {{birth date and age}} if the animal is living, otherwise use {{birth date}}.",
			"type": "string",
			"suggested": true
		},
		"birth_place": {
			"label": "Birth place",
			"description": "Place of birth: town, city, state, country.",
			"type": "string",
			"suggested": true
		},
		"death_date": {
			"label": "Death date",
			"description": "Date of death. Consider using {{death date and age}}.",
			"type": "string"
		},
		"death_place": {
			"label": "Death place",
			"description": "Place of death: town, city, state, country.",
			"type": "string"
		},
		"death_cause": {
			"label": "Death cause",
			"description": "Should be clearly defined, and should only be included when the cause of death has significance for the subject's notability",
			"type": "string"
		},
		"resting_place": {
			"label": "Resting place",
			"description": "Name of cemetery; place of ash-scattering, etc.",
			"type": "string"
		},
		"resting_place_coordinates": {
			"label": "Resting place coordinates",
			"description": "Coordinates of cemetery; place of ash-scattering, etc. using {{coord}} with ''display=inline,title''. For graves, please be as precise as possible.",
			"type": "string"
		},
		"nationality": {
			"label": "Nationality",
			"description": "The country the animal is from.",
			"type": "string"
		},
		"occupation": {
			"label": "Occupation",
			"description": "The occupation(s) animal is known for, e.g. [[pet]], [[wiktionary:mouser|mouser]], [[actor]].",
			"type": "string"
		},
		"employer": {
			"label": "Employer",
			"description": "The employer of the animal.",
			"type": "string"
		},
		"role": {
			"label": "Role",
			"description": "If the animal is/was an actor, insert any famous roles the animal is known for.",
			"type": "string"
		},
		"years_active": {
			"label": "Years active",
			"description": "The years that the animal was active in its career. Use the format: <blockquote><nowiki>year of first professional performance</nowiki>–<nowiki>year of final professional appearance</nowiki></blockquote>Note: If still active, use \"present\" in place of the end year.",
			"type": "string"
		},
		"known": {
			"label": "Known",
			"description": "A brief description of why the animal is notable.",
			"aliases": [
				"known_for"
			]
		},
		"tricks": {
			"label": "Tricks",
			"description": "Notable tricks the animal has been [[animal training|trained]] to perform."
		},
		"awards": {
			"label": "Awards",
			"description": "Any awards won."
		},
		"title": {
			"label": "Title",
			"description": "Any title the animal has held."
		},
		"term": {
			"label": "Term",
			"description": "The years the animal held the '''title''' listed above."
		},
		"predecessor": {
			"label": "Predecessor",
			"description": "The name of the animal who previously held the '''title''' listed above."
		},
		"successor": {
			"label": "Successor",
			"description": "The name of the animal who subsequently held the '''title''' listed above."
		},
		"owner": {
			"label": "Owner",
			"description": "The animal's owner. Use owners if there are multiple.",
			"type": "string"
		},
		"residence": {
			"label": "Residence",
			"description": "Place of residence",
			"type": "string"
		},
		"parents": {
			"label": "Parents",
			"description": "The names of the animal's ''notable'' parent(s).",
			"type": "string"
		},
		"mate": {
			"label": "Mate",
			"description": "The names of ''especially notable'' mate(s) of the animal.",
			"type": "string"
		},
		"children": {
			"label": "Children",
			"description": "The names of ''especially notable'' offspring of the animal.",
			"type": "string"
		},
		"weight": {
			"label": "Weight",
			"description": "The weight of the animal (should also include the date)."
		},
		"height": {
			"label": "Height",
			"description": "The height of the animal (should also include the date)."
		},
		"appearance": {
			"label": "Appearance",
			"description": "The appearance of the animal."
		},
		"namedafter": {
			"label": "Named After",
			"description": "Who or what the animal was named after.",
			"type": "string"
		},
		"website": {
			"label": "Website",
			"description": "The animal's official website. Use only the link such as {{URL|example.com}} or {{Official URL}}",
			"type": "wiki-template-name"
		},
		"embed": {
			"aliases": [
				"child"
			],
			"label": "Embed",
			"description": "If this is a child or embed of another infobox"
		},
		"hatch_name": {
			"label": "Hatch Name",
			"type": "string"
		},
		"hatch_date": {
			"label": "Hatch Date"
		},
		"hatch_place": {
			"label": "Hatch Place",
			"type": "string"
		},
		"owners": {
			"label": "Owners",
			"description": "The animal's owners. Use owner if there is only one.",
			"type": "string"
		},
		"weight_kg": {
			"label": "Weight (kilos)",
			"description": "The animal's weight in kilograms. Will be converted automatically.",
			"type": "number"
		},
		"weight_st": {},
		"weight_lb": {
			"label": "Weight (pounds)",
			"description": "The animal's weight, in pounds. Will be converted.",
			"type": "number"
		},
		"height_cm": {
			"label": "Height (cm)",
			"description": "This animal's height in centimeters. Will be converted.",
			"type": "number"
		},
		"height_ft": {
			"label": "Height (ft)",
			"description": "This animal's height in feet. Will be converted.",
			"type": "number"
		},
		"height_in": {
			"label": "Height (inches)",
			"description": "This animal's height in inches. Will be converted.",
			"type": "number"
		},
		"module": {
			"aliases": [
				"misc"
			],
			"label": "Module 1",
			"description": "Used for embedding other infoboxes into this one.",
			"type": "wiki-template-name"
		},
		"module2": {
			"label": "Module 2",
			"description": "Used for embedding other infoboxes into this one.",
			"type": "wiki-template-name"
		},
		"module3": {
			"label": "Module 3",
			"description": "Used for embedding other infoboxes into this one.",
			"type": "wiki-template-name"
		},
		"module4": {
			"label": "Module 4",
			"description": "Used for embedding other infoboxes into this one.",
			"type": "wiki-template-name"
		},
		"module5": {
			"label": "Module 5",
			"description": "Used for embedding other infoboxes into this one.",
			"type": "wiki-template-name"
		},
		"footnotes": {
			"label": "Footnotes",
			"description": "Notes at the bottom of the infobox.",
			"type": "string"
		}
	},
	"description": "Infobox used for specific animals with given names, including individual pets",
	"paramOrder": [
		"name",
		"image",
		"image_size",
		"image_upright",
		"caption",
		"landscape",
		"alt",
		"othername",
		"species",
		"breed",
		"sex",
		"birth_name",
		"birth_date",
		"birth_place",
		"hatch_name",
		"hatch_date",
		"hatch_place",
		"death_date",
		"death_place",
		"death_cause",
		"resting_place",
		"resting_place_coordinates",
		"nationality",
		"occupation",
		"employer",
		"role",
		"years_active",
		"known",
		"tricks",
		"awards",
		"title",
		"term",
		"predecessor",
		"successor",
		"owner",
		"owners",
		"residence",
		"parents",
		"mate",
		"children",
		"weight",
		"weight_lb",
		"weight_kg",
		"weight_st",
		"height",
		"height_cm",
		"height_ft",
		"height_in",
		"appearance",
		"namedafter",
		"website",
		"module",
		"module2",
		"module3",
		"module4",
		"module5",
		"footnotes",
		"embed"
	],
	"format": "block"
}
</templatedata>

== Microformat ==
{{UF-species}}

== Tracking category ==
* {{clc|Pages using infobox animal with unknown parameters}}

<includeonly>{{sandbox other||
<!-- Categories below this line and interwikis at Wikidata -->
[[Category:Animal infobox templates|animal]]
[[Category:Templates that add a tracking category|{{PAGENAME}}]]
}}</includeonly>