View source for Template:Speciesbox/doc

{{Documentation subpage}}
{{High-use|155586}}
{{Lua|Module:Autotaxobox|Module:Check for unknown parameters}}{{clear}}
{{Automatic_taxobox/doc/nav/boxed}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

{{tl|Speciesbox}} is one of the automated taxobox templates used to generate a taxobox automatically. ({{As of|2019|February}}, there were 8 such templates.) It's part of the "automated taxobox system", and is used for [[taxa]] (groups of organisms) at the rank of species (excluding viruses). The pages linked in the navigation box provide information on different parts of the system. 

Note: If you are a new user, it's a good idea to read the [[Template:Automatic taxobox/doc/system/intro|automated taxobox system introduction]] first; in particular to be sure that you are using the right automated taxobox.

This template is used to display a taxobox for a species whose parent's taxonomy is stored in [[Wikipedia:Automated taxobox system/taxonomy templates|taxonomy templates]]. A requirement is that the name of the species is displayed as a simple binomial (i.e. in the form ''Genus species''). In a few special cases, the name of the species is displayed differently (as for example at ''[[Halictus? savenyei]]''), when {{tl|Automatic taxobox}} is used.

Note that the Speciesbox template does <em>not require or make use of a taxonomy template for the species</em>; it only uses the taxonomy template for the parent taxon, normally the genus.

== Usage ==
Usage is basically the same as {{tl|Automatic taxobox}} (with a few variations noted below).

There are five main cases to consider in using this template:
* [[#Simple cases|Simple cases]], where the species is not a hybrid so that the × symbol is not present, the genus name is unique and not duplicated between kingdoms, and the species is not the only one in the genus.
* [[#Hybrid botanical species|Hybrid species names]], where the symbol × is required.
* [[#Genus names duplicated across kingdoms|Species where the genus name is duplicated between kingdoms]], so the taxonomy for the genus must distinguish between kingdoms (e.g. [[Acanthocarpus (plant)|''Acanthocarpus'' (plant)]] and [[Acanthocarpus (crab)|''Acanthocarpus'' (crab)]]).
* [[#Monospecific genera|Monospecific genera]], where the species and genus articles are combined, with the article title being the genus name.
* [[#Parent taxon is not the genus|Parent taxon not the genus]], where the parent taxon must be specified as it cannot be deduced from the binomial.

=== Simple cases ===
If the article is about a species whose binomial and genus name are both straightforward (e.g., no rank between the species and its genus, no hybrid symbol, no parenthesized disambiguation in the genus name), then the minimum requirement is to specify the <code>taxon</code> parameter:<ref group=note name=N1>If the <code>taxon</code> or <code>genus</code>/<code>species</code> parameters are omitted, the template will try to use the page title as the taxon name. This is deprecated, since it is not self-documenting, so is confusing to editors not familiar with the template, and causes problems if the page is moved.</ref>
* {{para|taxon|name of the species without any formatting (e.g. Quercus major, Lobatus gigas)}}

:(Alternatively you can use the <code>genus</code> and <code>species</code> parameters separately – this is different from {{tl|Automatic taxobox}}:
:* {{para|genus|name of the genus without any formatting (e.g. Quercus, Lobatus)}}
:* {{para|species|specific epithet or name without any formatting (e.g. major, gigas)}}
:This slightly reduces the processing needed.)

It's not necessary to include {{tl|italic title}} in the article; this will be added automatically by the Speciesbox template if needed.

For more complicated cases, see the other sections below.

==== Simple examples ====
* Page at the binomial name; displayed taxobox to have the binomial name as its title, e.g. ''[[Lobatus gigas]]''.

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>| taxon = Lobatus gigas</code> ''--recommended&thinsp;<ref group=note name=N1/>''
:<code>| authority = (Linnaeus, 1758)</code> ''--optional; this is the authority for the binomial (species) name''
:<code>...</code> ''--other optional parameters, e.g. for an image''
:<code><nowiki>}}</nowiki></code>

:Alternatively, use separate parameters for the genus name and the specific name/epithet.

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>| genus = Lobatus</code>
:<code>| species = gigas</code>
:<code>| authority = (Linnaeus, 1758)</code> ''--optional; this is the authority for the binomial (species) name''
:<code>...</code> ''--other optional parameters, e.g. for an image''
:<code><nowiki>}}</nowiki></code>

* Page at the binomial name; displayed taxobox to have the common name as its title, e.g. ''[[Allium moly]]''.

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>| name = Golden garlic</code> ''--required if title of taxobox ≠ taxon name''
:<code>| taxon = Allium moly</code>
:<code>| authority = L.</code> ''--optional; this is the authority for the binomial (species) name''
:<code>...</code> ''--other optional parameters, e.g. for an image''
:<code><nowiki>}}</nowiki></code>

* Page at the common name; displayed taxobox to have the same common name as its title, e.g. [[Lily of the valley]].

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>| name = Lily of the valley</code> ''--optional (defaults to page title)''
:<code>| taxon = Convallaria majalis</code> ''--essential''
:<code>...</code> ''--other optional parameters, e.g. for an image''
:<code><nowiki>}}</nowiki></code>

==== Extinct species ====
If the genus is extinct, the extinct status will be picked up automatically from the taxonomy template for the genus, and a &dagger; placed before the species name in the taxobox.

If the species is extinct, but the genus is not, then to achieve the same effect, use one of
* {{para|extinct|yes}} (<code>true</code> is also accepted)
* {{para|extinct|DATE}} – for recently extinct species, such as the [[Dodo]], to show when it became extinct. DATE is free-form text: examples are "1780", "about 1700", "after 1791". The DATE text will be displayed if (and only if) {{para|status}} is set to "EX" or equivalents in different status systems.

=== Hybrid botanical species ===
The hybrid sign, ×, should not be italicized, whereas the rest of the binomial should be. The example below shows how to achieve the desired effect. In this case, the single <code>taxon</code> parameter can't be used.

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>| genus = Polygonatum</code>
:<code>| species = × hybridum</code>
:<code>| ...</code>
:<code><nowiki>}}</nowiki></code>

Notes:
* The × character is available in the list under the edit text box. (If you use <code><nowiki>{{hybrid}}</nowiki></code>, the automatic italicization of the article title won't work.)
* In the article body, you can either use <code><nowiki>''Polygonatum'' × ''hybridum''</nowiki></code>, or <code><nowiki>''Polygonatum {{hybrid}} hybridum''</nowiki></code> to obtain the correct italicization.

=== Genus names duplicated across kingdoms ===
A special case is where the name of the genus is duplicated in different kingdoms, e.g. ''Acanthocarpus'', which is used for a plant and a crab. The taxonomy template for the plant has to be at [[Template:Taxonomy/Acanthocarpus (plant)]] to allow there to be a separate page at "Template:Taxonomy/Acanthocarpus (crab)". Consider the page ''[[Acanthocarpus preissii]]''. The taxobox has to be set up in this way:

<pre><nowiki>{{Speciesbox
| genus   = Acanthocarpus (plant)
| species = preissii
| ...
}}</nowiki></pre>

The corresponding taxonomy template for the genus, [[:Template:Taxonomy/Acanthocarpus (plant)]], contains the line:

:<code>| link  = Acanthocarpus (plant)|Acanthocarpus</code>

to ensure that wikilinks are to "Acanthocarpus (plant)" whereas the displayed genus name is "''Acanthocarpus''".

Note that this approach is ''only'' necessary when the disambiguation is needed because genus names are duplicated across kingdoms.<!--Need an example here? Previously used Liriope muscari, but now that there's a jellyfish genus with this name it doesn't work-->

=== Monospecific genera ===
Another special case is where the article is about a genus with only one species. The article will be at the genus name, but the final taxon to be displayed in the taxobox should be the species. An example is ''[[Aphyllanthes]]'', with the sole species ''Aphyllanthes monspeliensis''.

:<code><nowiki>{{Speciesbox</nowiki></code>
:<code>|taxon = Aphyllanthes monspeliensis</code>
:<code>|parent_authority = L.</code> ''--authority for genus''
:<code>|authority = L.</code> ''--authority for binomial (i.e. the species)''
:<code>|...</code> ''--other optional parameters''
:<code><nowiki>}}</nowiki></code>

The use of the Speciesbox template with the <code>taxon</code> parameter set to the species name ensures that the taxobox ends with the binomial name even though the page title is the genus name. The mediawiki software automatically replaces the generated wikilink <nowiki>[[Aphyllanthes]]</nowiki> by bold text since it goes to the same page. In this case we want to display the authority for both the species and the genus, since there is no other article. The parameters <code>parent_authority</code>, <code>grandparent_authority</code>, etc. are the way to display authorities up the classification hierarchy.

===Parent taxon is not the genus===
By default, the Speciesbox template uses the genus name as the name of the parent taxon. If this is not the case, because the parent taxon is at a rank between the species and its genus, such as subgenus or botanical section, then use:
*{{para|parent|''parent_taxon''}}

"Template:Taxonomy/''parent_taxon''" must then exist. Conventions for the name of a taxonomy template at a rank between species and genus include:
*"Template:Taxonomy/''Genus'' (''Subgenus'')" for a zoological subgenus, e.g. [[Template:Taxonomy/Mus (Coelomys)]]
*"Template:Taxonomy/''Genus'' subg. ''Subgenus''" for a botanical subgenus, e.g. [[Template:Taxonomy/Pinus subg. Pinus]]
*"Template:Taxonomy/''Genus'' sect. ''Section''" for a botanical section, e.g. [[Template:Taxonomy/Pinus sect. Trifoliae]]

Thus if a zoological subgenus is to be shown, then the taxobox is set up in this way:

<pre><nowiki>{{Speciesbox
| name = House mouse
| parent = Mus (Mus)
| taxon = Mus musculus
| ...
}}</nowiki></pre>

===Nonstandard formatting===
{{See|Template:Automatic_taxobox/doc#Exceptional_cases}}

In some exceptional cases the values shown for the species name and the binomial may require some non-standard formatting. A "binomial" with more than two "words", non-alphabetic characters other than a hyphen, or a need to leave some elements of the name unitalicized require nonstandard formatting. These cases are handled by {{tl|Automatic taxobox}}, not Speciesbox. Examples of exceptional cases include: provisional names for undescribed species (e.g. [[Quassia sp. 'Mount Nardi'|''Quassia'' sp. 'Mount Nardi']], where the provisional name should not be italicized), and uncertain genus placement (which may be specified with a ? as in [[Halictus? savenyei|''Halictus''? ''savenyei'']], or with "" as in [["Colostethus" poecilonotus|"''Colostethus''" ''poecilonotus'']].

== Italicizing the article title ==
The template can normally determine whether the page title matches the species or the genus in the taxobox, and if so outputs {{tl|italic title}}, so usually it is not necessary to add this template. In a very few cases the automatic italicization will be wrong (e.g. if the article is at the English name and this is the same as the genus name, such as [[Hippopotamus]]). Automatic italicization can be over-ridden by setting {{para|italic_title|no}}.

== Requirement for correct display ==
The template will generate a taxobox which will display correctly only if the taxonomy for the genus (or {{para|parent}}) has already been created (i.e. "Template:Taxonomy/''genusname''" or "Template:Taxonomy/''parent''" already exists). If it does not, you will be asked to create it. One way is to look for the "fix" link and open it.

== Displaying intermediate ranks ==
By default, only major ranks are displayed. The parameter {{para|display_parents}} can be set to display intermediate ranks, for example setting {{para|display_parents|4}} will show the next four parent taxa even if they would not otherwise be shown. Note that the genus counts as one of these.

== See also ==
* An example: [[Template:Speciesbox/example]]
* {{tl|Paraphyletic group}}
* {{tl|Taxonbar}}

==Tracking categories==
* {{clc|Pages using speciesbox with unknown parameters}}
* {{clc|Speciesboxes relying on page title‎ }}
* {{clc|Speciesboxes with incorrect parameters specifying the taxon‎}}

==Notes==
{{reflist|group=note}}

==Template Data==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"color_as": {
			"label": "Color as",
			"type": "string",
			"description": "Taxon defining the taxobox color if needed (normally not) ",
			"example": "Animalia"
		},
		"name": {
			"label": "Name",
			"type": "string",
			"description": "Title of the taxobox; may be the English name of the group "
		},
		"fossil_range": {
			"label": "Fossil range",
			"description": "The geologic time span during which the group is generally known to have existed, given in eras; the template {{Fossil range}} is the most common method of presenting this information ",
			"example": "{{Fossil range|Middle Triassic|Present}} ",
			"type": "wiki-template-name"
		},
		"image": {
			"label": "Image name",
			"type": "wiki-file-name",
			"suggested": true,
			"description": "An image of  member of the species, given without the File: or Image: prefix and without double brackets ",
			"example": "Argopecten irradians.jpg"
		},
		"image_upright": {
			"label": "Image upright",
			"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). If a second image is present the value of this parameter will be applied to it too unless over-ridden by image2_upright",
			"example": "0.8",
			"type": "number"
		},
		"image_alt": {
			"label": "Image alt text",
			"type": "string",
			"description": "Text describing what is depicted in the image"
		},
		"image_caption": {
			"label": "Image caption",
			"type": "string",
			"description": "A caption for the image, if any is necessary. Do not simply repeat the name of the taxon"
		},
		"image2": {
			"label": "Image2",
			"type": "wiki-file-name",
			"description": "A second image of a member of the species, given without the File: or Image: prefix and without double brackets. It is desirable to display images of both sexes of sexually dimorphic species."
		},
		"image2_upright": {
			"label": "Image2 upright",
			"type": "number",
			"description": "Used to adjust the displayed size of the second image if the required adjustment is different from the first image. 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"
		},
		"image2_alt": {
			"label": "Image2 alt text",
			"type": "string",
			"description": "Text describing what is depicted in the second image"
		},
		"image2_caption": {
			"label": "Image2 caption",
			"type": "string",
			"description": "A caption for the second image, if any is necessary. Do not simply repeat the name of the taxon"
		},
		"status": {
			"label": "Conservation status",
			"description": "The conservation status of the taxon as assigned by a particular authority",
			"example": "LC",
			"type": "string"
		},
		"status_system": {
			"label": "Conservation status system",
			"description": "The authority assigning a particular conservation status",
			"example": "IUCN3.1",
			"type": "string"
		},
		"status_ref": {
			"label": "Conservation status reference",
			"description": "A citation that supports the displayed status and status_system parameters"
		},
		"status2": {
			"label": "Conservation status2",
			"description": "The conservation status of the taxon as assigned by a second particular authority",
			"example": "LE",
			"type": "string"
		},
		"status2_system": {
			"label": "Conservation status2 system",
			"description": "The second authority assigning a particular conservation status",
			"example": "ESA",
			"type": "string"
		},
		"status2_ref": {
			"label": "Conservation status2 reference",
			"description": "A citation that supports the displayed status2 and status2_system parameters",
			"type": "string"
		},
		"extinct": {
			"label": "Extinct",
			"description": "The date a species 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 species is extinct",
			"example": "1066"
		},
		"classification_status": {
			"label": "Classification status",
			"description": "The status of the scientific group, usually presented as either Disputed or Accepted ",
			"example": "Disputed",
			"type": "string"
		},
		"greatgrandparent_authority": {
			"label": "Great-grandparent authority",
			"description": "The describing authority for the greatgrandparent taxon of a species. Should only be specified when the greatgrandparent taxon is monotypic",
			"type": "string"
		},
		"grandparent_authority": {
			"label": "Grandparent authority",
			"description": "The describing authority for the grandparent taxon of a species. Should only be specified when the grandparent taxon is monotypic",
			"type": "string"
		},
		"parent_authority": {
			"label": "Parent authority",
			"description": "The describing authority for the parent taxon of a species. Should only be specified when the parent taxon is monotypic",
			"type": "string"
		},
		"display_parents": {
			"label": "Parents to display",
			"description": "The number of parent taxa to be displayed above the one specified by the taxon parameter; not normally needed ",
			"example": "3",
			"type": "number"
		},
		"taxon": {
			"label": "Taxon",
			"type": "string",
			"description": "Scientific name (binomial) of the species with no formatting; a entry point into the taxonomic hierarchy. Alternatively, |genus and |species can be used (and are required in some cases)",
			"example": "Homo sapiens"
		},
		"genus": {
			"label": "Genus",
			"type": "string",
			"description": "Scientific name of the genus with no formatting; a entry point into the taxonomic hierarchy. Used in conjunction with |species Alternatively, |taxon may be used instead of |genus and |species (but |taxon will not function properly when a genus requires parenthetical disambiguation)",
			"example": "Homo"
		},
		"species": {
			"label": "Species",
			"type": "string",
			"description": "Scientific name (species epithet) of the species with no formatting; used in conjunction with |genus. Alternatively, |taxon may be used instead of |genus and |species (but |taxon will not function properly when a genus requires parenthetical disambiguation)",
			"example": "sapiens"
		},
		"parent": {
			"label": "Parent",
			"description": "The immediate infrageneric parent taxon containing a particular species, with no formatting. Requires a taxonomy template.",
			"type": "string"
		},
		"subdivision_ranks": {
			"label": "Subdivision ranks",
			"type": "string",
			"description": "The name of the next lowest rank(s) in the taxonomic hierarchy"
		},
		"subdivision": {
			"label": "Subdivision",
			"description": "A list of taxa at the next lowest rank(s) in the taxonomic hiearchy. When there are many (10+) taxa at the lower rank, they should be displayed in the body of the article, not the taxobox",
			"type": "string"
		},
		"range_map": {
			"label": "Range map image",
			"type": "wiki-file-name",
			"description": "The name of the image file, if any, showing the species' geographic habitat range, without the File: or Image: prefix and without double brackets "
		},
		"range_map_upright": {
			"label": "Range map image upright",
			"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",
			"type": "number"
		},
		"range_map_alt": {
			"label": "Range map image alt text",
			"type": "string",
			"description": "Text describing the range depicted in the map",
			"example": "Map of Africa, with shading indicating the species occurs in the eastern part of the island of Madagascar"
		},
		"range_map_caption": {
			"label": "Range map image caption",
			"type": "string",
			"description": "A caption for the range map, if any is necessary"
		},
		"range_map2": {
			"label": "Range map image2",
			"type": "wiki-file-name",
			"description": "The name of a second image file, if any, showing the species' geographic habitat range, without the File: or Image: prefix and without double brackets. Mostly useful when a species has a narrow range, in order to display maps at different scale"
		},
		"range_map2_upright": {
			"label": "Range map image2 upright",
			"type": "number",
			"description": "Used to adjust the displayed size of a second 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_map2_alt": {
			"label": "Range map image2 alt text",
			"type": "string",
			"description": "Text describing the range depicted in the second map",
			"example": "Map of Madagascar, with shading indicating the species occurs in the eastern part of the island"
		},
		"range_map2_caption": {
			"label": "Range map image2 caption",
			"type": "string",
			"description": "A caption for the second range map, if any is necessary"
		},
		"synonyms": {
			"label": "Taxonomic synonyms",
			"description": "Taxonomic synonyms. These should be displayed in a collapsed list format if there are many of them."
		},
		"synonyms_ref": {
			"label": "Taxonomic synonyms reference",
			"description": "A reference supporting the synonymy shown in the list"
		},
		"authority": {
			"label": "Describing authority",
			"type": "string",
			"description": "The describing authority for the species in the appropriate format, which differs between nomenclature codes; presence or absence of parentheses is meaningful ",
			"example": "Wilkes, 1810 – animal; (L.) Mill. – plant",
			"required": true
		},
		"subdivision_ref": {
			"label": "Subdivision reference",
			"description": "A reference supporting the subdivisions shown in the list"
		},
		"greatgreatgrandparent_authority": {
			"label": "Great-great-grandparent authority",
			"description": "The describing authority for the greatgreatgrandparent taxon of a species. Should only be specified when the greatgreatgrandparent, greatgrandparent, grandparent and parent taxa are monotypic",
			"type": "string"
		},
		"italic_title": {
			"label": "Italic title",
			"description": "Specifying \"no\" suppresses italicization of page title. Used only when a scientific name is identical to a vernacular name.",
			"example": "no"
		},
		"type_strain": {
			"label": "Bacterial strain type",
			"description": "The name of a strain that was used to define a bacteria species",
			"type": "string"
		}
	},
	"description": "An infobox for species of organisms where {{tl|Automatic taxobox}} is used at the genus and higher ranks",
	"paramOrder": [
		"color_as",
		"italic_title",
		"name",
		"fossil_range",
		"image",
		"image_upright",
		"image_alt",
		"image_caption",
		"image2",
		"image2_upright",
		"image2_alt",
		"image2_caption",
		"status",
		"status_system",
		"status_ref",
		"status2",
		"status2_system",
		"status2_ref",
		"extinct",
		"classification_status",
		"greatgreatgrandparent_authority",
		"greatgrandparent_authority",
		"grandparent_authority",
		"parent_authority",
		"display_parents",
		"taxon",
		"genus",
		"parent",
		"species",
		"authority",
		"type_strain",
		"subdivision_ranks",
		"subdivision_ref",
		"subdivision",
		"range_map",
		"range_map_upright",
		"range_map_alt",
		"range_map_caption",
		"range_map2",
		"range_map2_upright",
		"range_map2_alt",
		"range_map2_caption",
		"synonyms",
		"synonyms_ref"
	],
	"format": "block"
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Taxobox templates]]
[[Category:Infobox templates|Speciesbox]]
[[Category:Templates that add a tracking category]]
}}</includeonly>