View source for Template:Taxonbar/doc

{{Documentation subpage}}
{{high-use|394141}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{further|Help:Taxon identifiers}}
{{Lua|Module:Taxonbar}}
{{Uses Wikidata|section=Taxon identifiers}}
{{Lua sidebar}}
{{TOC left}}

== Description ==
This metadata template links Wikipedia articles to various biological and [[taxonomic database]]s. Taxonbar displays these links as short strings, indicating the unique [[identifier]] each database has assigned the taxon for catalogue purposes.

Taxonomic identifiers of each taxon are stored and retrieved from each taxon's corresponding [[Wikidata]] entry, but can be overridden in individual articles with locally entered data. Adding the data to Wikidata is preferable.

This project is based on the work of {{Tl|Authority Control}} and [[d:Wikidata:WikiProject Taxonomy|Wikidata:WikiProject Taxonomy]]. If you are a template editor or Wikipedia administrator, you may contribute at '''[[Module:Taxonbar]]'''. Please discuss ideas/thoughts for improvement or use on [[Template:Taxonbar/talk]].
[[File:Taxonbar layout placement on English Wikipedia - Cuckoo wasp.png|thumb|Taxonbar is placed below all [[Wikipedia:Navigation template|navigation templates]], except [[Wikipedia:Authority control|Authority control]] (not shown here).]]

== Position ==
{{See also|Wikipedia:Manual of Style/Layout}}
'''Please place Taxonbar correctly'''. As a metadata template, Taxonbar should be placed:
{{columns-list|colwidth=60em|
* Below all [[Wikipedia:References|references]], [[Wikipedia:Footnotes|footnotes]], and [[Wikipedia:External links|external links]].
* Below all [[Wikipedia:Navigation template|navigation templates]]—except Authority control
* Above the [[Wikipedia:Authority control|Authority control]] template.
* Above all [[Wikipedia:Categories|<nowiki>[[Category:]]</nowiki>]] and stub template codes in the editor.
}}

== Usage ==
'''Add Taxonbar to an article:'''
# In Source editing mode, insert <code><nowiki>{{Taxonbar|from=}}</nowiki></code> '''below all other navigation templates except Authority control''' &mdash; it is preferable to add the <code>from = QID</code> parameter even if just a single Wikidata item points to the article.
# Click "Show preview" to check placement, and to see which taxon identifiers are automatically pulled from Wikidata.
# If you have more identifiers to add, consider adding them to the article's Wikidata item, so that all versions of Wikipedia automatically benefit. Be careful not to edit the structure or names of Wikidata taxa until you have become familiar with [[d:Wikidata:WikiProject Taxonomy|Wikidata:WikiProject Taxonomy]] and [[d:Wikidata:WikiProject Taxonomy/Tutorial|Wikidata:WikiProject Taxonomy/Tutorial]].

'''Basic code:'''
<pre><nowiki>{{Taxonbar|from=}}</nowiki></pre>

== Taxon example ==
[[File:Scarlet Macaw RWD3.jpg|thumb|left|'''[[Scarlet macaw|Scarlet macaw (''Ara macao'')]]''']]{{clear|left}}
<code><nowiki>{{Taxonbar | from=Q243761}}</nowiki></code> when placed in the [[Scarlet macaw]] article:
{{Taxonbar | from=Q243761}}

== Basic use samples ==
{{See also|Module:Taxonbar/sandbox|Template:Taxonbar/testcases}}
{{flatlist|
* [[Blue jay]]
* [[European robin]]
* ''[[Agaricus bisporus]]''
* [[American chestnut]]
* ''[[Nelumbo lutea]]''
* ''[[Escherichia coli]]''
* ''[[Plasmodium falciparum]]''
* ''[[Bombus terrestris]]''
* ''[[Canis]]''
* [[Monarch butterfly]]
}}

==Taxon identifiers==
{{For2|databases supported by Wikidata:WikiProject Taxonomy|[[d:Wikidata:WikiProject Taxonomy#Databases]]}}
The template can automatically get its information from the following properties on [[Wikidata]]. This is configured in [[Module:Taxonbar/conf]].

{{#invoke:Taxonbar/confdoc|confdoc}}
<!--'''<nowiki>*</nowiki>'''(support for this parameter temporarily disabled)-->
<!-- If none of these is applicable, it can be forced with: <nowiki>{{Authority control |MBA={{#Property:P434}} }}</nowiki> which for [[The Beatles]] would produce:
{{Authority control |MBA=b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d }}
Note that for The Beatles <nowiki>{{Authority control}}</nowiki> would work out of the box already. -->

=== Hide specific identifier (optional) ===
Individual identifiers listed in the table above can be removed/hidden from the bar by setting the corresponding parameter to <code>no</code>. This is useful when trying to reduce the number of unhelpful links within Taxonbar. Spaces are optional.  There is no sense in removing too many identifiers, for example: removing plant or fungi identifiers from an animal taxon would have no effect, as these parameters will not show up on an animal taxon in the first place.  It is best to preview <code><nowiki>{{Taxonbar}}</nowiki></code> on the page and decide what entries provide little relevant data.  Plant species will have the most entries and are most likely in need of hiding some entries.

Example:
To remove FOC, IPNI, and AFPD, the code would look like:
<pre><nowiki>{{Taxonbar | foc = no | ipni = no| apdb = no }}</nowiki></pre>

On ''[[Coffea arabica]]'', the result is:

{{Taxonbar | from=Q47685 | foc = no | ipni = no| apdb = no }}

===Excluded databases===
These databases are available at Wikidata, but are excluded by default here (en.wiki) for being non-English.
{| class="wikitable sortable"
|-
! data-sort-type=number style="white-space: nowrap;"|Wikidata property name &nbsp;&nbsp;&nbsp;&nbsp; !! ID !! Authority !! Description !! Language
|-
|{{Taxonbar/ExcludedProperty|3088}}||Taiwanese
|-
|{{Taxonbar/ExcludedProperty|4902}}||Spanish
|-
|{{Taxonbar/ExcludedProperty|5263}}||Czech
|-
|{{Taxonbar/ExcludedProperty|6115}}||French
|-
|{{Taxonbar/ExcludedProperty|4630}}||French
|-
|{{Taxonbar/ExcludedProperty|1939}}||Swedish
|-
|{{Taxonbar/ExcludedProperty|6043}}||French
|-
|{{Taxonbar/ExcludedProperty|5179}}||Catalan
|-
|{{Taxonbar/ExcludedProperty|6094}}||German
|-
|{{Taxonbar/ExcludedProperty|4311}}||Dutch
|-
|{{Taxonbar/ExcludedProperty|6054}}||French
|-
|{{Taxonbar/ExcludedProperty|2794}}||French
|-
|{{Taxonbar/ExcludedProperty|6025}}||French
|-
|{{Taxonbar/ExcludedProperty|3102}}||Russian
|-
|{{Taxonbar/ExcludedProperty|3186}}||French
|-
|{{Taxonbar/ExcludedProperty|3105}}||French
|-
|{{Taxonbar/ExcludedProperty|4125}}||French
|-
|{{Taxonbar/ExcludedProperty|6142}}||Dutch
|-
|{{Taxonbar/ExcludedProperty|3322}}||Dutch
|-
|{{Taxonbar/ExcludedProperty|4664}}||Portuguese
|}

==Additional parameters==
Some taxon identifiers not currently in Wikidata can be added via additional parameters; however, adding the data to Wikidata is preferable, so that all versions of Wikipedia automatically benefit.

Example:
<pre><nowiki>{{Taxonbar | emonocot = 280381 }}</nowiki></pre>

On ''[[Lilium]]'', the result is:

{{Taxonbar | from=Q5194627 | emonocot = 280381 }}

where the taxon identifier in the [[eMonocot]] has been added to those picked up from Wikidata.

{| class="wikitable sortable"
|-
!Parameter!!Database!!Property URL/Interwiki link
|-
|eMonocot||[[eMonocot]]||<nowiki>http://e-monocot.org/taxon/urn:kew.org:wcs:taxon:$1</nowiki>
|-
|emonocotfamily||[[eMonocot]]||<nowiki>http://e-monocot.org/taxon/urn:kew.org:wcs:family:$1</nowiki>
|-
|wsc-species||[[World Spider Catalog]]||<nowiki>http://www.wsc.nmbe.ch/search?sFamily=&fMt=begin&sGenus=&gMt=begin&sSpecies=&sMt=begin&mMt=exact&multiPurpose=slsid&sMulti=$1</nowiki>
|-
|wsc-genus||[[World Spider Catalog]]||<nowiki>http://www.wsc.nmbe.ch/search?sFamily=&fMt=begin&sGenus=&gMt=begin&sSpecies=&sMt=begin&mMt=exact&multiPurpose=glsid&sMulti=$1</nowiki>
|-
|wsc-family||[[World Spider Catalog]]||<nowiki>http://www.wsc.nmbe.ch/search?sFamily=&fMt=begin&sGenus=&gMt=begin&sSpecies=&sMt=begin&mMt=exact&multiPurpose=flsid&sMulti=$1</nowiki>
|-
|Wikispecies||[[Wikispecies]]||Wikispecies:$1
|}

==Multiple Wikidata entries==

Some taxa will exist under multiple names (synonyms) on Wikidata. To add these synonyms, use the {{para|from2}}, {{para|from3}}, etc., parameters to specify their Wikidata IDs. The parameter {{para|from}} / {{para|from1}} will be ''implicitly'' determined by the Wikidata item linked to the article. While not required, it is preferable to [[:Category:Taxonbars without from parameter|explicitly store]] the linked Wikidata item in the {{para|from}} / {{para|from1}} parameter, for maintenance purposes. Parameters {{para|from2}}, {{para|from3}}, etc., can also be added, for example, if the linked Wikidata item differs from the taxon name of the en:Wikipedia article.

If there is more than one row, the taxon name from Wikidata will be shown in the leftmost column — to overwrite this, use the {{para|title}} / {{para|title1}}, {{para|title2}}, {{para|title3}}, etc. parameters. You can add taxon identifiers not present in Wikidata by appending the appropriate number to the end of the parameter name — for example, to add emonocot to the second row, use {{para|emonocot2}}.

For example, {{tlx|Taxonbar|2=from=Q26972265|3=from2=Q20717272}}, when placed on the page [[Dog]] produces:
{{Taxonbar|from=Q26972265|from2=Q20717272}}

The same approach can be used when monotypic taxa have a single article, but there are multiple entries in Wikidata. For example, at ''[[Haptanthus]]'', which covers the genus and its sole species, {{tlx|Taxonbar|2=from1=Q15715555|3=from2=Q133951}} produces:
{{Taxonbar|from1=Q15715555|from2=Q133951}}

===Basionyms===

[[Basionyms]] available on Wikidata (via {{Wikidata property link|P566}}) are automatically appended. You may also manually specify the basionym via {{para|from#}} to customize its location.

For example, both 
:{{tlx|Taxonbar|2=from1=Q43372357|3=from2=Q164254}} and
:{{tlx|Taxonbar|2=from1=Q43372357|3=from2=Q164254|4=from3=Q21977691}}
would produce identical taxonbars for ''[[Ponerorchis cucullata]]'':
{{Taxonbar|from1=Q43372357|from2=Q164254|from3=Q21977691}}

or {{tlx|Taxonbar|2=from1=Q43372357|3=from2=Q21977691|4=from3=Q164254}} for a customized location:
{{Taxonbar|from1=Q43372357|from2=Q21977691|from3=Q164254}}

==More taxon examples==
{{See also|Module:Taxonbar/sandbox|Template:Taxonbar/testcases}}
{{Purge page}}{{clear|left}}
[[File:Coffee-230022.jpg|lthumb|50px]] Arabica coffee, ''[[Coffea arabica]]''
{{Taxonbar|from=Q47685}}
[[File:Common_Milkweed_(Asclepias_syriaca)_(14911935302).jpg|lthumb|50px]] Common milkweed, ''[[Asclepias syriaca]]''
{{Taxonbar|from=Q158295}}
[[File:Newborn Monarch being released (15476827630).jpg|lthumb|50px]] [[Monarch butterfly]], ''Danaus plexippus''
{{Taxonbar|from=Q212398}}
[[File:Melanism_in_Panthera_Onca.jpg|lthumb|50px]] [[Jaguar]], ''Panthera onca''
{{Taxonbar||from=Q35694}}
[[File:Eastern_Bluebird-27527-7.jpg|lthumb|50px]] [[Eastern bluebird]], ''Sialia sialis''
{{Taxonbar|from=Q600880}}
[[File:Firefly_%E3%83%9B%E3%82%BF%E3%83%AB_%E8%9B%8D_Hotaru.jpg|lthumb|50px]] [[Firefly]], ''Lampyridae''
{{Taxonbar|from=Q25420}}
[[File:Amanita muscaria 3 vliegenzwammen op rij.jpg|lthumb|50px]] Fly agaric, ''[[Amanita muscaria]]''
{{Taxonbar|from=Q131227}}
[[File:Saccharomyces_cerevisiae_SEM.jpg|lthumb|50px]] ''[[Saccharomyces cerevisiae]]''
{{Taxonbar|from=Q719725}}
[[File:Lactobacillus_acidophilus_SEM.jpg|lthumb|50px]] ''[[Lactobacillus acidophilus]]''
{{Taxonbar|from=Q132644}}
[[File:Plasmodium_falciparum_01.png|lthumb|50px]] ''[[Plasmodium falciparum]]''
{{Taxonbar|from=Q311383}}

== Module editing — to-do list ==
* Continue to add support for new, useful parameters ([https://query.wikidata.org/#SELECT%20%3Fitem%20WHERE%0A%7B%0A%20%20%23%20all%20instance%20of%3A%20Wikidata%20property%20to%20identify%20taxa%20%28Q42396390%29%0A%20%20%3Fitem%20wdt%3AP31%20wd%3AQ42396390%20.%0A%7D search])

== Module editing — to-don't list ==
* Import synonym QIDs via {{Wikidata property link|P1420}} from Wikidata ([[Template talk:Taxonbar/Archive 4#Basionyms and synonyms|talk]])

==See also==
* [[Help:Taxon identifiers]]
* [[Module:Taxonbar/candidate]]
* [[Module:Taxonbar/exists]]

==Other links==
* {{tl|ThePlantList}}
* {{tl|Authority control}}
* {{tl|Taxobox}}
* [[Wikipedia:Automated taxobox system/intro]]
* Other templates in [[:Category:Biology external link templates]]
* Other templates in [[:Category:Botany external link templates]]

==Tracking categories==
===Maintenance required===
* {{clc|Taxonbar pages requiring a Wikidata item‎}}
* {{clc|Taxonbars desynced from Wikidata}}
* {{clc|Taxonbars on possible non-taxon pages}}
* {{clc|Taxonbars with duplicate from parameters}}
* {{clc|Taxonbars with invalid from parameters}}
* {{clc|Taxonbars with manual taxon IDs differing from Wikidata}}
* {{clc|Taxonbars with unknown parameters}}
* {{clc|Taxonbars with unnamed parameters}}

===Maintenance desired===
* {{clc|Taxonbars without primary Wikidata taxon IDs}} — find/add taxon IDs to the primary Wikidata item
* {{clc|Taxonbars without secondary Wikidata taxon IDs}} — find/add taxon IDs to secondary Wikidata item(s)
* {{clc|Taxonbars using manual taxon IDs}} — migrate IDs to Wikidata, if possible
* {{clc|Taxonbars with manual taxon IDs identical to Wikidata}} — remove duplicate(s) on Wikipedia
* {{clc|Taxonbars with from2 matching article title‎}} — swap {{para|from1}}/{{para|from2}} parameter values (maybe)
* {{clc|Taxonbars with from2 matching article title‎ & QID}} — swap {{para|from1}}/{{para|from2}} parameter values (probably)
* {{clc|Taxonbars without from parameter}} — add {{para|from}} parameter
* {{clc|Taxobox articles missing a taxonbar}} — add {{tl|Taxonbar}}, if appropriate

===Tracking only (no error)===
* {{clc|Taxobox articles possibly missing a taxonbar}}
* {{clc|Taxonbars using multiple manual Wikidata items}}
* {{clc|Taxonbars with 20–24 taxon IDs}}
* {{clc|Taxonbars with 25–29 taxon IDs}}
* {{clc|Taxonbars with 30–34 taxon IDs}}
* {{clc|Taxonbars with 35–39 taxon IDs}}
* {{clc|Taxonbars with 40+ taxon IDs}}
* {{clc|Taxonbars with automatically added basionyms‎}}
* {{clc|Taxonbars with automatically added original combinations}}
* {{clc|Taxonbars with automatically added monotypic genera}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Biology infobox templates]]
[[Category:Botany infobox templates]]
[[Category:Botany external link templates]]
[[Category:Biology external link templates]]
[[Category:External link templates using Wikidata]]
[[Category:External link templates to linked data sites with reciprocal links]]
[[Category:Templates that add a tracking category]]

}}</includeonly>

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"from": {
			"label": "Wikidata item",
			"example": "Q1",
			"suggested": true
		}
	},
	"description": "Links to taxonomic databases via Wikidata",
	"paramOrder": [
		"from"
	],
	"format": "inline"
}
</templatedata>