View source for Module:Cite taxon/doc

{{High-use}}
This module was created to generate {{tl|cite web}} references to the ''[[Catalog of Fishes]]'' database. The capabilities were extended to handle other fish-related references and the module renamed [[Module:FishRef|FishRef]]. Further extension to cover taxonomy databases handling non-fish taxa led to creation of template {{tl|BioRef}}.  and {{tl|Cite taxon}} templates and module name was changed to [[Module:Cite taxon|Cite taxon]] to better describe its function of handling citations for a wide variety taxonomy databases.

The module provides a wrapper to the citation template {{tl|cite web}}, which means that the references can also include other parameters supported by the CS1/CS2 citation system. These include {{para|access-date}}, which is recommended, reference style formating parameters such as {{para|mode|cs1{{!}}2}} or {{para|name-list-style|vanc}}, the archiving parameters {{para|url-status}}, {{para|archive-url}} and {{[para|archive-date}}, and other general parameter such as {{para|quote}}. The template supplies authors or editors for some databases, but for others these can be added using the cite web parameters {{para|author}}, {{para|last}}, {{para|first}} or the editor equivalents.

=== Templates using the module ===

The module is used with {{tl|Catalog of Fishes}}, which was designed to replace a series of templates that were originally written in the Wikipedia template language: {{tl|Cof genus}}, {{tl|Cof family}}, {{tl|Cof species}}, {{tl|Cof record}}.

Other templates using the module: 

* {{tl|Cite taxon}} (general purpose template handling many databases*)
* {{tl|BioRef}} (general purpose template handling many databases.* Deprecated, use {{tl|Cite taxon}})
* {{tl|FishRef}} (general purpose template handling many fish databases. Deprecated, use {{tl|Cite taxon}} or fishbase or CoF templates)
* {{tl|FishBase}}  
* {{tl|Fossilworks}} (site defunct)
* {{tl|Catalogue of Life}}
* {{tl|Cite WFO}} (World Flora Online)
* {{tl|Cite mdd}} (Mammalian Diversity Database)
* {{tl|Cite BOW}} (Birds of the World)

:<code>*</code> The module currently handles ASW6, Amphibiaweb, Reptile Database, IOC, Avibase, TiF, WoRMS, POWO, GRIN, IPNI, World Plants, World Ferns, Tropicos, FNA, ATRF, Goffinet's Bryophyte classification, Algaebase, Paleobiology DB, ITIS

=== Usage of module ===

General form: <nowiki>{{#invoke:Cite taxon|main|</nowiki>''db''<nowiki>|</nowiki>''parameters''<nowiki>}}</nowiki>

Examples: <nowiki>{{#invoke:Cite taxon|main|cof|</nowiki>''parameters''<nowiki>}}</nowiki>, <nowiki>{{#invoke:Cite taxon|main|fishbase|</nowiki>''parameters''<nowiki>}}</nowiki>, <nowiki>{{#invoke:Cite taxon|main|reptileDB|</nowiki>''parameters''<nowiki>}}</nowiki>, <nowiki>{{#invoke:Cite taxon|main|ASW6|</nowiki>''parameters''<nowiki>}}</nowiki>, <nowiki>{{#invoke:Cite taxon|main|POWO|</nowiki>''parameters''<nowiki>}}</nowiki>, etc.

The module stores information about each database in a data table (e.g. data.cof for Catalog of Fishes). The table has a CitationArgs table, for parameters to be passed to {{tl|cite web}}, a CustomArgs table for parameters used for internal workings to set other {{tl|cite web}} parameters, and one or more custom  functions handling different types of citation parameter. Typical functions are id, species, genus, family, order, and taxon. Which functions are needed depend on the options provided by the external database, some use a common format with an id for all links, others have taxon-specific links.

=== General rules ===

Different databases provide different options so uniformity is not possible. Some provide links that allow handling of species, genera, families, orders and other taxon ranks using the taxon names. This allows specific function to handle different taxa. Other just provide an id which can be used to generate the url, but needs a title. The following are the general rules for what functions are available:

# All databases can take a {{para|title}} and {{para|url}}. The templates then just add the general citation information about the website.
# Many take a {{para|id}}. The template will complete the url and add a default title, although adding a title is recommended.
# Some databases allow taxon names that can be used with {{para|genus}}, {{para|family}}, {{para|order}} or {{para|taxon}}
# Species can also often be handled when given {{para|genus}} and {{para|species}}, and in some cases also {{para|subspecies}}. These can usually be added as position parameters, but it is recommended that the parameter names are given


==Examples of templates using the [[Module:FishRef]]==

===Catalog of Fishes===
'''Examples using {{tl|Catalog of Fishes}}'''
{| class="wikitable"
|-
! Template usage !! Results
|-
|<pre>{{Catalog of Fishes |family=Xiphiidae |list=species |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |family=Xiphiidae |list=species |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |family=Cyprinidae |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |family=Cyprinidae |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |family=Salmonidae |list=genus |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |family=Salmonidae |list=genus |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |genus=Vinagarra |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |genus=Vinagarra |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |genus=Vinagarra |species=elongata |access-date=7 June 2018}} </pre>
|     {{Catalog of Fishes |genus=Vinagarra |species=elongata |access-date=7 June 2018}} 
|-
|<pre>{{Catalog of Fishes |genus=Abbottina |species=rivularis |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |genus=Abbottina |species=rivularis |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |genus=Tylognathus |species=sinensis |access-date=7 June 2018}}</pre>
|     {{Catalog of Fishes |genus=Tylognathus |species=sinensis |access-date=7 June 2018}}
|-
|<pre>{{Catalog of Fishes |genid=150  |access-date=8 June 2018}} </pre>
|     {{Catalog of Fishes |genid=150  |access-date=8 June 2018}}
|-
|<pre>{{Catalog of Fishes |genid=150 |title=Syngnathus |access-date=8 June 2018}} </pre>
|     {{Catalog of Fishes |genid=150 |title=Syngnathus |access-date=8 June 2018}}
|-
|<pre>{{Catalog of Fishes|spid=14756  |access-date=8 June 2018}}</pre>
|     {{Catalog of Fishes |spid=14756  |access-date=8 June 2018}}
|-
|<pre>{{Catalog of Fishes |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}</pre>
|     {{Catalog of Fishes |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}
|}

'''Examples using {{tl|Cof family}}, {{tl|Cof genus}}, {{tl|Cof species}} and {{tl|Cof record}} templates'''

{| class="wikitable"
|-
! Template usage !! Results
|-
|<pre>{{Cof family |Xiphiidae|access-date=7 June 2018}}</pre>
|     {{Cof family |Xiphiidae|access-date=7 June 2018}}
|-
|<pre>{{Cof family |family=Xiphiidae |list=species |access-date=7 June 2018}}</pre>
|     {{Cof family |family=Xiphiidae |list=species |access-date=7 June 2018}}
|-
|<pre>{{Cof family |family=Cyprinidae |access-date=7 June 2018}}</pre>
|     {{Cof family |family=Cyprinidae |access-date=7 June 2018}}
|-
|<pre>{{Cof family |family=Salmonidae |list=genus |access-date=7 June 2018}}</pre>
|     {{Cof family |family=Salmonidae |list=genus |access-date=7 June 2018}}
|-
|<pre>{{Cof genus |Garra|access-date=7 June 2018}}</pre>
|     {{Cof genus |Garra|access-date=7 June 2018}}
|-
|<pre>{{Cof genus |genus=Vinagarra |access-date=7 June 2018}}</pre>
|     {{Cof genus |genus=Vinagarra |access-date=7 June 2018}}
|-
|<pre>{{Cof species |genus=Vinagarra |species=elongata|access-date=7 June 2018}} </pre>
|     {{Cof species |genus=Vinagarra |species=elongata|access-date=7 June 2018}}
|-
|<pre>{{Cof species |Abbottina|rivularis|access-date=7 June 2018}}</pre>
|     {{Cof species |Abbottina|rivularis|access-date=7 June 2018}}
|-
|<pre>{{Cof species |Tylognathus|sinensis|access-date=7 June 2018}}</pre>
|     {{Cof species |Tylognathus|sinensis|access-date=7 June 2018}}
|-
|<pre>{{Cof record |genid=150 |title=Syngnathus |access-date=8 June 2018}} </pre>
|     {{Cof record |genid=150 |title=Syngnathus |access-date=8 June 2018}}
|-
|<pre>{{Cof record |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}</pre>
|     {{Cof record |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}
|-
|<pre>{{Cof record |genid=150  |access-date=8 June 2018}} </pre>
|     {{Cof record |genid=150  |access-date=8 June 2018}} 
|-
|<pre>{{Cof record |spid=14756  |access-date=8 June 2018}}</pre>
|     {{Cof record |spid=14756  |access-date=8 June 2018}}
|}

=== Using {{tl|FishBase/sandbox}} ===
{| class="wikitable"
|-
! Template usage !! Results
|-
|Species with positional parameters]:
<pre>{{FishBase/sandbox|Danio|rerio|year=2018}} </pre>
|    {{FishBase/sandbox|Danio|rerio|year=2018}}
|-
|Subspecies with position parameters:
<pre>{{FishBase/sandbox|Emmelichthys|nitidus|cyanescens}}  </pre>
|    {{FishBase/sandbox|Emmelichthys|nitidus|cyanescens}}
|-
|Species with named parameters:
<pre>{{FishBase/sandbox|genus=Danio|species=rerio}}  </pre>
|    {{FishBase/sandbox|genus=Danio|species=rerio}}
|-
|Subspecies with named parameters:
<pre>{{FishBase/sandbox|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}} </pre>
|    {{FishBase/sandbox|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}} 
|-
|Genus:
<pre>{{FishBase/sandbox|genus=Emmelichthys}}</pre>
|    {{FishBase/sandbox|genus=Emmelichthys}}
|-
|Family:
<pre>{{FishBase/sandbox|family=Percidae}}</pre>
|    {{FishBase/sandbox|family=Percidae}}
|-
|Order:
<pre>{{FishBase/sandbox|order=Perciformes|access-date=19 November 2018|mode=cs2}}</pre>
|    {{FishBase/sandbox|order=Perciformes|access-date=19 November 2018|mode=cs2}}
|}

=== Using {{tl|BioRef}}===

'''Fishbase:'''

{| class="wikitable"
|-
! Template usage 
! Results
|-
|Species with positional parameters:
<pre>{{BioRef|fishbase|Danio|rerio}}</pre>
|    {{BioRef|fishbase|Danio|rerio}}
|-
|Subspecies with positional parameters:
<pre>{{BioRef|fishbase|Emmelichthys|nitidus|cyanescens}}</pre>
|    {{BioRef|fishbase|Emmelichthys|nitidus|cyanescens}}
|-
|Species with named parameters:
<pre>{{BioRef|fishbase|genus=Danio|species=rerio}}</pre>
|    {{BioRef|fishbase|genus=Danio|species=rerio}}
|-
|Subspecies with named parameters:
<pre>{{BioRef|fishbase|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}}</pre>
|    {{BioRef|fishbase|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}}
|-
|Genus:
<pre>{{BioRef|fishbase|genus=Emmelichthys}}</pre>
|    {{BioRef|fishbase|genus=Emmelichthys}}
|-
|Family:
<pre>{{BioRef|fishbase|family=Percidae}}</pre>
|    {{BioRef|fishbase|family=Percidae}}
|-
|Order:
<pre>{{BioRef|fishbase|order=Perciformes|access-date=19 November 2018|mode=cs2}}</pre>
|    {{BioRef|fishbase|order=Perciformes|access-date=19 November 2018|mode=cs2}}
|}

<section begin=Herpetology />
<section begin=ASW6 />
'''Amphibian Species of the World (ASW6)'''
{| class="wikitable"
|-
! Template usage !! Results
|-
|Default page with family listing:
<pre>{{BioRef|ASW6 |access-date=27 September 2019}}</pre>
|    {{BioRef|ASW6 |access-date=27 September 2019}}
|-
|Title + url:
<pre>{{BioRef|ASW6 |title=Hylidae Rafinesque, 1815|year=2019 |url=http://research.amnh.org/vz/herpetology/amphibia/Amphibia/Anura/Hylidae |access-date=27 September 2019}}</pre>
|    {{BioRef|ASW6 |title=Hylidae Rafinesque, 1815|year=2019 |url=http://research.amnh.org/vz/herpetology/amphibia/Amphibia/Anura/Hylidae |access-date=27 September 2019}}
|-
|Family (currently only works for Anura):
<pre>{{BioRef|ASW6 |family=Hylidae |year=2019  |access-date=27 September 2019}}</pre>
|    {{BioRef|ASW6 |family=Hylidae |year=2019  |access-date=27 September 2019}}
|-
|Genus + species (named parameters)::
<pre>{{BioRef|ASW6 |genus=Chiromantis |species=cherrapunjiae |year=2019  |access-date=27 September 2019}} </pre>
|    {{BioRef|ASW6 |genus=Chiromantis |species=cherrapunjiae |year=2019  |access-date=27 September 2019}} 
|-
|Genus + species (positional parameters)::
<pre>{{BioRef|ASW6 | Chiromantis| cherrapunjiae |year=2019  |access-date=27 September 2019}}</pre>
|    {{BioRef|ASW6 | Chiromantis| cherrapunjiae |year=2019  |access-date=27 September 2019}}
<!--|-
|XXX:
<pre>XXX</pre>
|    XXX-->
|-
|Note: the citation title can changed with {{para|title|My title}}
|}

<section end=ASW6 />
<section begin=AmphibiaWeb />
'''AmphibiaWeb'''
{| class="wikitable"
|-
! Template usage !! Results
|-
|Default page with for interactive family listing:
<pre>{{BioRef|amphibiaweb |access-date=27 September 2019}}</pre>
|    {{BioRef|amphibiaweb |access-date=27 September 2019}}
|-
|Title with url:
<pre>{{BioRef|amphibiaweb |title=Ranidae |year=2019 |url=https://amphibiaweb.org/lists/Ranidae.shtml |access-date=27 September 2019}}</pre>
|    {{BioRef|amphibiaweb |title=Ranidae |year=2019 |url=https://amphibiaweb.org/lists/Ranidae.shtml |access-date=27 September 2019}}
|-
|Family:
<pre>{{BioRef|amphibiaweb |family=Ranidae |year=2019 |access-date=27 September 2019}} </pre>
|    {{BioRef|amphibiaweb |family=Ranidae |year=2019 |access-date=27 September 2019}}
|-
|Genus + species (named parameters):
<pre>{{BioRef|amphibiaweb |genus=Altiphrynoides |species=malcolmi |year=2019 |access-date=27 September 2019}}</pre>
|    {{BioRef|amphibiaweb |genus=Altiphrynoides |species=malcolmi |year=2019 |access-date=27 September 2019}}
|-
|Genus + species (positional parameters):
<pre>{{BioRef|amphibiaweb | Altiphrynoides | malcolmi |year=2019 |access-date=27 September 2019}}</pre>
|    {{BioRef|amphibiaweb | Altiphrynoides | malcolmi |year=2019 |access-date=27 September 2019}}
<!--|-
|XXX:
<pre>XXX</pre>
|    XXX-->
|-
|Note: the citation title can changed with {{para|title|My title}}
|}

<section end=AmphibiaWeb />
<section begin=reptileDB />

'''Reptile database:'''
{| class="wikitable"
|-
! Template usage !! Results
|-
|Species:
<pre>{{BioRef|reptileDB |genus=Loxocemus |species=bicolor|access-date=22 November 2018}}</pre>
|    {{BioRef|reptileDB |genus=Loxocemus |species=bicolor|access-date=22 November 2018}}
<!--|-
|Species (positional parameters):
<pre>{{BioRef|reptileDB |Loxocemus |bicolor|access-date=22 November 2018}}</pre>
|    {{BioRef|reptileDB |Loxocemus |bicolor|access-date=22 November 2018}}-->
|-
|Species (positional parameters) with title:
<pre>{{BioRef|reptileDB |Python |natalensis |title=''Python natalensis'' SMITH, 1840|access-date=14 October 2019}}</pre>
|    {{BioRef|reptileDB |Python |natalensis |title=''Python natalensis'' SMITH, 1840|access-date=14 October 2019}}
|-
|Genus:
<pre>{{BioRef|reptileDB |genus=Cylindrophis|access-date=22 November 2018}}</pre>
|    {{BioRef|reptileDB |genus=Cylindrophis|access-date=22 November 2018}}
|-
|Use {{para|taxon}} parameter for higher taxa:
|-
|Family:
<pre>{{BioRef|reptileDB |taxon=Pythonidae|title=Species in Family Pythonidae|access-date=22 November 2018}}</pre>
|    {{BioRef|reptileDB |taxon=Pythonidae|title=Species in Family Pythonidae|access-date=22 November 2018}}
|-
|Other taxon (e.g. infraorder):
<pre>{{BioRef|reptileDB |taxon=Alethinophidia|access-date=22 November 2018}}</pre>
|    {{BioRef|reptileDB |taxon=Alethinophidia|access-date=22 November 2018}}
|}

<section end=reptileDB />
<section end=Herpetology />

'''ASM Mammal Diversity Database'''
* See also {{tl|cite mdd}}
{| class="wikitable"
|-
! Template usage !! Results
|-
|Family using {{para|taxon}} parameter:
<pre>{{BioRef|asm |order=Carnivora |access-date=28 February 2024 |mode=cs2}}</pre>
|   {{BioRef|asm |order=Carnivora |access-date=28 February 2024 |mode=cs2}}
|-
|Family using {{para|family}} parameter:
<pre>{{BioRef|asm |family=Canidae |access-date=19 November 2018 |mode=cs2}}</pre>
|    {{BioRef|asm |family=Canidae |access-date=19 November 2018 |mode=cs2}}
|-
|Genus using {{para|genus}} parameter:
<pre>{{BioRef|asm |genus=Ursus |access-date=19 November 2018}}</pre>
|    {{BioRef|asm |genus=Ursus |access-date=19 November 2018}}
|-
|Species using {{para|id}} parameter:
<pre>{{BioRef|asm |id=8541 |title=Sand cat|access-date=19 November 2018}}</pre>
|    {{BioRef|asm |id=8541 |title=Sand cat|access-date=19 November 2018}}
|-
|Species with {{para|genus}} and {{para|species}} parameters:
<pre>{{BioRef|asm |genus=Panthera|species=leo |access-date=19 November 2018}}</pre>
|    {{BioRef|asm |genus=Panthera|species=leo |access-date=19 November 2018}}
|}

=== [[User:Jts1882/sandbox/template/asm]]===

*{{User:Jts1882/sandbox/template/asm |order=Carnivora |access-date=19 November 2018 |mode=cs2}}
*{{User:Jts1882/sandbox/template/asm |family=Canidae |access-date=19 November 2018 |mode=cs2}}
*{{User:Jts1882/sandbox/template/asm |genus=Ursus |access-date=19 November 2018}}
*{{User:Jts1882/sandbox/template/asm |id=1005988 |title=Sand cat|access-date=19 November 2018}}
*{{User:Jts1882/sandbox/template/asm |genus=Panthera|species=leo |access-date=19 November 2018}}
<noinclude>
[[Category:Module documentation pages]]
</noinclude>