View source for Template:Subspeciesbox/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Autotaxobox}}{{clear}}
{{Automatic_taxobox/doc/nav/boxed}}

This template is only suitable for taxa whose names are regulated by the ''[[International Code of Zoological Nomenclature]]''. For ranks below species whose names are regulated by the ''[[International Code of Nomenclature for algae, fungi, and plants]]'' see [[Template:Infraspeciesbox]].

=== Usage ===

Usage is almost the same as [[Template:Automatic taxobox]], except that you need to specify:
* {{para|genus|''name of the genus (e.g. Quercus)''}}
* {{para|subgenus|''link to subgenus''}}
* {{para|species|''specific epithet (e.g. major)''}}
* {{para|species_link|}} (optional link to page about species; defaults to ''<code>genus species</code>'')
* {{para|subspecies|''subspecific epithet (e.g. major)''}}
Unlike {{tl|Speciesbox}}, {{para|taxon}} cannot be used; the three parts of the trinomial must be given separately.

If the subspecies is extinct, but the species and genus are not, then you need to specify:
* {{para|extinct|''yes'' or ''year''}} (in order to display the year of extinction, ''year'' is needed if {{para|status}} is set, whether or not the genus is extinct)

If the species (and hence the subspecies) is extinct, but the genus is not, then you need to specify:
* {{para|species_extinct|''yes''}}

=== See also ===
An example: [[Template:Subspeciesbox/example]]

===Template Data===
{{TemplateData header}}
<templatedata>
{
	"params": {
		"genus": {
			"type": "string",
			"required": true,
			"description": "Scientific name of the genus with no formatting; used in conjunction with |species and |subspecies.",
			"example": "Homo"
		},
		"subgenus": {
			"type": "string",
			"description": "The subgenus containing a particular species. Any formatting or link mark-up must be manually added."
		},
		"species": {
			"type": "string",
			"required": true,
			"description": "Scientific name (species epithet) of the species with no formatting; used in conjunction with |genus and |subspecies.",
			"example": "sapiens"
		},
		"species_link": {
			"type": "string",
			"description": "The title of the article that is the parent species of the subspecies. Used to bypass a redirect when the species has a vernacular name title. Required when the genus is disambiguated. Should not be specified in other circumstances"
		},
		"subspecies": {
			"type": "string",
			"required": true,
			"description": "Scientific name (subspecies epithet) of the subspecies with no formatting; used in conjunction with |genus and |species.",
			"example": "sapiens"
		},
		"image": {
			"type": "wiki-file-name",
			"suggested": true,
			"description": "An image of  a member of the subspecies, given without the File: or Image: prefix and without double brackets "
		},
		"image_caption": {
			"type": "string",
			"description": "A caption for the image, if any is necessary. Do not simply repeat the name of the taxon"
		},
		"name": {
			"type": "string",
			"description": "Title of the taxobox; may be the English vernacular name of the subspecies"
		},
		"extinct": {
			"type": "string",
			"description": "The date a subspecies was declared extinct (specifying |status=EX is required in order for the date to display). Alternatively, if a non-numeric value is given, displays † to indicate that a subspecies is extinct",
			"example": "1066"
		},
		"species_extinct": {
			"type": "boolean",
			"description": "Displays † to indicate that the parent species is extinct",
			"example": "yes"
		},
		"authority": {
			"suggested": true,
			"type": "string",
			"description": "The describing authority for the subspecies in the appropriate format; presence or absence of parentheses is meaningful ",
			"example": "Wilkes, 1810"
		},
		"status": {
			"type": "string",
			"description": "The conservation status of the taxon as assigned by a particular authority",
			"example": "LC"
		},
		"status_system": {
			"type": "string",
			"description": "The authority assigning a particular conservation status",
			"example": "IUCN3.1"
		},
		"status_ref": {
			"type": "string",
			"description": "A citation that supports the displayed status and status_system parameters"
		},
		"range_map": {
			"type": "wiki-file-name",
			"description": "The name of the image file, if any, showing the subspecies' geographic habitat"
		},
		"range_map_upright": {
			"type": "number",
			"description": "Used to adjust the displayed size of a range map. May be useful when the range map has an extreme aspect ratio (use values <1 for tall/narrow range maps, and >1 for short/wide range maps). May also be necessary if an image_upright parameter is specified",
			"example": "0.8"
		},
		"range_map_caption": {
			"type": "string",
			"description": "A caption for the range map, if any is necessary"
		},
		"synonyms": {
			"type": "string",
			"description": "Taxonomic synonyms. These should be displayed in a collapsed list format if there are many of them."
		},
		"synonyms_ref": {
			"type": "string",
			"description": "A reference supporting the synonymy shown in the list"
		},
		"image2": {
			"type": "wiki-file-name",
			"description": "An second image of a member of the subspecies, given without the File: or Image: prefix and without double brackets. It is desirable to display images of both sexes of sexually dimorphic subspecies."
		},
		"image2_caption": {
			"type": "string",
			"description": "A caption for the second image, if any is necessary. Do not simply repeat the name of the taxon"
		},
		"image2_upright": {
			"type": "number",
			"description": "Used to adjust the displayed size of an image with an extreme aspect ratio. Values under 1.0 decrease the size of an image (most useful for very tall, narrow images) Values over 1.0 increase the size of an image (possibly useful for short, wide images)",
			"example": "0.8"
		},
		"image_upright": {
			"type": "number",
			"description": "Used to adjust the displayed size of an image with an extreme aspect ratio. Values under 1.0 decrease the size of an image (most useful for very tall, narrow images) Values over 1.0 increase the size of an image (possibly useful for short, wide images)",
			"example": "0.8"
		},
		"image_alt": {
			"description": "Text describing what is depicted in the image",
			"type": "string"
		}
	},
	"description": "An infobox for subspecies of animals (organisms governed by the ICZN) where {{tl|Automatic taxobox}} or {{tl|Speciesbox}} is used for parent taxa",
	"paramOrder": [
		"name",
		"image",
		"image_upright",
		"image_alt",
		"image_caption",
		"image2",
		"image2_caption",
		"image2_upright",
		"status",
		"status_system",
		"status_ref",
		"extinct",
		"species_extinct",
		"genus",
		"subgenus",
		"species_link",
		"species",
		"subspecies",
		"authority",
		"range_map",
		"range_map_upright",
		"range_map_caption",
		"synonyms",
		"synonyms_ref"
	],
	"format": "block"
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Taxobox templates]]
[[Category:Infobox templates|Subspeciesbox]]
}}</includeonly>