Editing Template:Taxonbar/doc

{{Documentation subpage}}
{{high-use|394141}}
{{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 ==
{{sh|WP:TAXONPOS}}
{{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:
{{Block indent|left=0.1|1=<nowiki />
# 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:
<syntaxhighlight lang="wikitext">{{Taxonbar|from=}}</syntaxhighlight>
}}

== Taxon example ==

[[File:PileatedWoodpeckerFeedingonTree,_crop.jpg|thumb|left|'''[[Pileated woodpecker]] (''Dryocopus pileatus''), syn. ''Picus pileatus''''']]
{{clear|left}}
<code><nowiki>{{Taxonbar|from=Q930712}}</nowiki></code> when placed in the [[Pileated woodpecker]] article:
{{Taxonbar|from=Q930712}}

== Basic use samples ==
{{See also|Module:Taxonbar/sandbox|Template:Taxonbar/testcases}}
Examples of articles demonstrating its use include:
{{flatlist|
* ''[[Agaricus bisporus]]''
* ''[[Arabidopsis thaliana]]''
* ''[[Bombus terrestris]]''
* ''[[Canis]]''
* [[Chordate]]
* [[Conifer]]
* ''[[Escherichia coli]]''
* [[Eukaryote]]
* [[European robin]]
* [[Salicaceae]]
* [[Influenza A virus]]
* [[Insect]]
* [[Lambda phage]]
* ''[[Nitrosopumilus]]''
* ''[[Physcomitrella patens]]''
* ''[[Plasmodium falciparum]]''
* [[Protozoa]]
* [[Red algae]]
* [[Squamata]]
}}

==Taxon identifiers==
{{For-text|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]].

=== List of taxon identifiers ===
{{#invoke:Taxonbar/confdoc|confdoc}}

===Manual identifiers===
Some taxon identifiers not currently in Wikidata can be added via additional parameters [[#List of taxon identifiers|listed above]]; however, adding the data to Wikidata is preferable, so that all versions of Wikipedia automatically benefit.

Example:
<syntaxhighlight lang="wikitext">{{ Taxonbar | powo = urn:lsid:ipni.org:names:30009317-2 }}</syntaxhighlight>

On ''[[Lilium]]'', the result is the following, where the taxon identifier in the [[Plants of the World Online]] has been added to those picked up from Wikidata:

{{Taxonbar |from=Q5194627 |powo=urn:lsid:ipni.org:names:30009317-2}}

If there are [[#Multiple Wikidata entries|multiple Wikidata entries]] resulting in multiple rows, the row to which an identifier is added can be specified by appending a number matching the relevant {{parameter|from#}} parameter.

A [[Wikispecies]] page can be also added manually. However, it is preferable to link it to the Wikidata item; this can be done at the Wikidata page within the "''Multilingual sites''" section, entering "''species''" as the "''wiki''".

{| class="wikitable"
|-
!Parameter!!Database!!Property URL/Interwiki link
|-
|Wikispecies||[[Wikispecies]]||Wikispecies:$1
|}

=== 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}}. 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 {{tl|Taxonbar}} 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:
<syntaxhighlight lang="wikitext">{{ Taxonbar | foc = no | ipni = no | apdb = no }}</syntaxhighlight>

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

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

===Displaying excluded databases (optional)===
These databases are available at Wikidata but are excluded by default on the English-language Wikipedia as they are not in the English language. They can be included in the {{tl|taxonbar}} by setting the corresponding parameter to {{code|yes}} (e.g. {{para|CoL-Taiwan|yes}}), which will then retrieve the value from Wikidata, or by setting the value of the parameter manually (e.g. {{para|CoL-Taiwan|395235}}).

{| 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
|}

==Multiple Wikidata entries==

The parameter {{para|from}}{{\}}{{para|from1}} will be ''implicitly'' determined by the Wikidata item linked to the article. For maintenance purposes it is preferable to explicitly provide the linked Wikidata item in the {{para|from}}{{\}}{{para|from1}} parameter, although it is not strictly required. If it is not provided the article will be listed at [[:Category:Taxonbars without from parameter]].

Parameters {{para|from2}}, {{para|from3}}, etc., can also be added, for example, if the linked Wikidata item differs from the taxon name of the English-language Wikipedia article. Some taxa exist under multiple names (synonyms) on Wikidata. To add these synonyms, use the {{para|from2}}, {{para|from3}}, etc., parameters to specify their Wikidata IDs. 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. 

For example, <syntaxhighlight lang="wikitext" inline>{{Taxonbar|from=Q26972265|from2=Q20717272}}</syntaxhighlight>, 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, <syntaxhighlight lang="wikitext" inline>{{Taxonbar|from1=Q15715555|from2=Q133951}}</syntaxhighlight> produces:
{{Taxonbar|from1=Q15715555|from2=Q133951}}

You can [[#Manual identifiers|manually add taxon identifier]]s not present in Wikidata to a specific row by appending the appropriate number to the end of the parameter name — for example, to add an inaturalist identifier to the second row, use {{para|inaturalist2}}.

===Basionyms===

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

For example, both 
:<syntaxhighlight lang="wikitext" inline>{{Taxonbar|from1=Q43372357|from2=Q164254}}</syntaxhighlight> and
:<syntaxhighlight lang="wikitext" inline>{{Taxonbar|from1=Q43372357|from2=Q164254|from3=Q21977691}}</syntaxhighlight>
would produce identical taxonbars for ''[[Ponerorchis cucullata]]'':
{{Taxonbar|from1=Q43372357|from2=Q164254|from3=Q21977691}}

However, changing the order of the IDs will alter their position in the taxonbar so
:<syntaxhighlight lang="wikitext" inline>{{Taxonbar|from1=Q43372357|from2=Q21977691|from3=Q164254}}</syntaxhighlight>
produces a taxonbar with the basionym in a different position:
{{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:Standing jaguar.jpg|lthumb|50px]] [[Jaguar]], ''Panthera onca''
{{Taxonbar||from=Q35694}}
[[File:Amanita muscaria 3 vliegenzwammen op rij.jpg|lthumb|50px]] Fly agaric, ''[[Amanita muscaria]]''
{{Taxonbar|from=Q131227}}
[[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==
{{See also|Category:Taxonbar cleanup}}

===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|Taxobox articles missing a taxonbar}} — add {{tl|Taxonbar}}, if appropriate
<!--IDs-->
* {{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 with manual taxon IDs}} — migrate IDs to Wikidata, if possible
* {{clc|Taxonbars with manual taxon IDs identical to Wikidata}} — remove duplicate(s) on Wikipedia
<!--From parameters-->
* {{clc|Taxonbars without from parameter}} — add {{para|from}} parameter
* {{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 with automatically added monotypic genera}} — add QIDs of related monotypic ranks to {{para|from2}}, etc.
* {{clc|Taxonbars with automatically added monotypic species}} — add QIDs of related monotypic ranks to {{para|from2}}, etc.
<!--Others-->
* {{clc|Taxonbars of monotypic species missing genera}} — verify monotypic status of both genus and species on Wikidata
* {{clc|Taxonbars of monotypic genera missing species}} — verify monotypic status of both genus and species on Wikidata

===Tracking only (no error)===
* {{clc|Taxobox articles possibly missing a taxonbar}}
* {{clc|Taxonbars with 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–44 taxon IDs}}
* {{clc|Taxonbars with 45+ taxon IDs}}
* {{clc|Taxonbars with automatically added basionyms}}
* {{clc|Taxonbars with automatically added original combinations}}

<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]]
[[Category:Wikipedia authority control templates]]
}}</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>