Module:FishRef/doc

This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module was created to generate {{cite web}} references to the Catalog of Fishes database. The capabilities were extended to handle other fish-related references and the module renamed FishRef. Further extension to a more general Bioref system is the long-term goal.

The module provides a wrapper to the cite web system, which means that the references can also include general cite web parameters (e.g. |mode=cs1|2 or |quote=TEXT).

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

Other templates using the module: {{FishBase/sandbox}}, {{BioRef}}, {{fossilworks/sandbox}}, User:Jts1882/sandbox/template/asm

Usage of module: {{#invoke:FishRef|cof}}, {{#invoke:FishRef|fishbase}}, {{#invoke:FishRef|fossilworks}}, etc.

Examples of templates using the Module:FishRef

Catalog of Fishes

Examples using {{Catalog of Fishes}}

Template usage	Results
{{Catalog of Fishes \|family=Xiphiidae \|list=species \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|family=Cyprinidae \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|family=Salmonidae \|list=genus \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genus=Vinagarra \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genus=Vinagarra \|species=elongata \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genus=Abbottina \|species=rivularis \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genus=Tylognathus \|species=sinensis \|access-date=7 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genid=150 \|access-date=8 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|genid=150 \|title=Syngnathus \|access-date=8 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes\|spid=14756 \|access-date=8 June 2018}}	வார்ப்புரு:Catalog of Fishes
{{Catalog of Fishes \|spid=14756 \|title=Syngnathus abaster \|access-date=8 June 2018}}	வார்ப்புரு:Catalog of Fishes

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

Template usage	Results
{{Cof family \|Xiphiidae\|access-date=7 June 2018}}	வார்ப்புரு:Cof family
{{Cof family \|family=Xiphiidae \|list=species \|access-date=7 June 2018}}	வார்ப்புரு:Cof family
{{Cof family \|family=Cyprinidae \|access-date=7 June 2018}}	வார்ப்புரு:Cof family
{{Cof family \|family=Salmonidae \|list=genus \|access-date=7 June 2018}}	வார்ப்புரு:Cof family
{{Cof genus \|Garra\|access-date=7 June 2018}}	வார்ப்புரு:Cof genus
{{Cof genus \|genus=Vinagarra \|access-date=7 June 2018}}	வார்ப்புரு:Cof genus
{{Cof species \|genus=Vinagarra \|species=elongata\|access-date=7 June 2018}}	வார்ப்புரு:Cof species
{{Cof species \|Abbottina\|rivularis\|access-date=7 June 2018}}	வார்ப்புரு:Cof species
{{Cof species \|Tylognathus\|sinensis\|access-date=7 June 2018}}	வார்ப்புரு:Cof species
{{Cof record \|genid=150 \|title=Syngnathus \|access-date=8 June 2018}}	வார்ப்புரு:Cof record
{{Cof record \|spid=14756 \|title=Syngnathus abaster \|access-date=8 June 2018}}	வார்ப்புரு:Cof record
{{Cof record \|genid=150 \|access-date=8 June 2018}}	வார்ப்புரு:Cof record
{{Cof record \|spid=14756 \|access-date=8 June 2018}}	வார்ப்புரு:Cof record

Using {{FishBase/sandbox}}

Template usage	Results
Species with positional parameters]: {{FishBase/sandbox\|Danio\|rerio\|year=2018}}	வார்ப்புரு:FishBase/sandbox
Subspecies with position parameters: {{FishBase/sandbox\|Emmelichthys\|nitidus\|cyanescens}}	வார்ப்புரு:FishBase/sandbox
Species with named parameters: {{FishBase/sandbox\|genus=Danio\|species=rerio}}	வார்ப்புரு:FishBase/sandbox
Subspecies with named parameters: {{FishBase/sandbox\|genus=Emmelichthys\|species=nitidus\|subspecies=cyanescens}}	வார்ப்புரு:FishBase/sandbox
Genus: {{FishBase/sandbox\|genus=Emmelichthys}}	வார்ப்புரு:FishBase/sandbox
Family: {{FishBase/sandbox\|family=Percidae}}	வார்ப்புரு:FishBase/sandbox
Order: {{FishBase/sandbox\|order=Perciformes\|access-date=19 November 2018\|mode=cs2}}	வார்ப்புரு:FishBase/sandbox

Using {{BioRef}}

Fishbase:

Template usage	Results
Species with positional parameters: {{BioRef\|fishbase\|Danio\|rerio}}	Froese, Rainer; Pauly, Daniel (eds.). "Danio rerio". Fishbase.
Subspecies with positional parameters: {{BioRef\|fishbase\|Emmelichthys\|nitidus\|cyanescens}}	Froese, Rainer; Pauly, Daniel (eds.). "Emmelichthys nitidus cyanescens". Fishbase.
Species with named parameters: {{BioRef\|fishbase\|genus=Danio\|species=rerio}}	Froese, Rainer; Pauly, Daniel (eds.). "Danio rerio". Fishbase.
Subspecies with named parameters: {{BioRef\|fishbase\|genus=Emmelichthys\|species=nitidus\|subspecies=cyanescens}}	Froese, Rainer; Pauly, Daniel (eds.). "Emmelichthys nitidus cyanescens". Fishbase.
Genus: {{BioRef\|fishbase\|genus=Emmelichthys}}	Froese, Rainer; Pauly, Daniel (eds.). "Species in genus Emmelichthys". Fishbase.
Family: {{BioRef\|fishbase\|family=Percidae}}	Froese, Rainer; Pauly, Daniel (eds.). "Family Percidae". Fishbase.
Order: {{BioRef\|fishbase\|order=Perciformes\|access-date=19 November 2018\|mode=cs2}}	Froese, Rainer; Pauly, Daniel (eds.), "Order Perciformes", Fishbase, பார்க்கப்பட்ட நாள் 19 November 2018

Amphibian Species of the World (ASW6)

Template usage	Results
Default page with family listing: {{BioRef\|ASW6 \|access-date=27 September 2019}}	Frost, Darrel R. "ASW Home". Amphibian Species of the World, an Online Reference. Version 6.0. American Museum of Natural History, New York. பார்க்கப்பட்ட நாள் 27 September 2019.
Title + url: {{BioRef\|ASW6 \|title=Hylidae Rafinesque, 1815\|year=2019 \|url=http://research.amnh.org/vz/herpetology/amphibia/Amphibia/Anura/Hylidae \|access-date=27 September 2019}}	Frost, Darrel R. (2019). "Hylidae Rafinesque, 1815". Amphibian Species of the World, an Online Reference. Version 6.0. American Museum of Natural History, New York. பார்க்கப்பட்ட நாள் 27 September 2019.
Family (currently only works for Anura): {{BioRef\|ASW6 \|family=Hylidae \|year=2019 \|access-date=27 September 2019}}	Frost, Darrel R. (2019). "Hylidae". Amphibian Species of the World, an Online Reference. Version 6.0. American Museum of Natural History, New York. பார்க்கப்பட்ட நாள் 27 September 2019.
Genus + species (named parameters):: {{BioRef\|ASW6 \|genus=Chiromantis \|species=cherrapunjiae \|year=2019 \|access-date=27 September 2019}}	Frost, Darrel R. (2019). "Search for taxon: Chiromantis cherrapunjiae". Amphibian Species of the World, an Online Reference. Version 6.0. American Museum of Natural History, New York. பார்க்கப்பட்ட நாள் 27 September 2019.
Genus + species (positional parameters):: {{BioRef\|ASW6 \| Chiromantis\| cherrapunjiae \|year=2019 \|access-date=27 September 2019}}	Frost, Darrel R. (2019). "Search for taxon: Chiromantis cherrapunjiae". Amphibian Species of the World, an Online Reference. Version 6.0. American Museum of Natural History, New York. பார்க்கப்பட்ட நாள் 27 September 2019.
Note: the citation title can changed with `\|title=My title`

AmphibiaWeb

Template usage	Results
Default page with for interactive family listing: {{BioRef\|amphibiaweb \|access-date=27 September 2019}}	"AmphibiaWeb Family Taxonomy". AmphibiaWeb. University of California, Berkeley. பார்க்கப்பட்ட நாள் 27 September 2019.
Title with url: {{BioRef\|amphibiaweb \|title=Ranidae \|year=2019 \|url=https://amphibiaweb.org/lists/Ranidae.shtml \|access-date=27 September 2019}}	"Ranidae". AmphibiaWeb. University of California, Berkeley. 2019. பார்க்கப்பட்ட நாள் 27 September 2019.
Family: {{BioRef\|amphibiaweb \|family=Ranidae \|year=2019 \|access-date=27 September 2019}}	"Ranidae". AmphibiaWeb. University of California, Berkeley. 2019. பார்க்கப்பட்ட நாள் 27 September 2019.
Genus + species (named parameters): {{BioRef\|amphibiaweb \|genus=Altiphrynoides \|species=malcolmi \|year=2019 \|access-date=27 September 2019}}	"Altiphrynoides malcolmi". AmphibiaWeb. University of California, Berkeley. 2019. பார்க்கப்பட்ட நாள் 27 September 2019.
Genus + species (positional parameters): {{BioRef\|amphibiaweb \| Altiphrynoides \| malcolmi \|year=2019 \|access-date=27 September 2019}}	"Altiphrynoides malcolmi". AmphibiaWeb. University of California, Berkeley. 2019. பார்க்கப்பட்ட நாள் 27 September 2019.
Note: the citation title can changed with `\|title=My title`

Reptile database:

Template usage	Results
Species: {{BioRef\|reptileDB \|genus=Loxocemus \|species=bicolor\|access-date=22 November 2018}}	Uetz, P.; Freed, P.; Hošek, J. (eds.). "Loxocemus bicolor". The Reptile Database. பார்க்கப்பட்ட நாள் 22 November 2018.
Species (positional parameters) with title: {{BioRef\|reptileDB \|Python \|natalensis \|title=''Python natalensis'' SMITH, 1840\|access-date=14 October 2019}}	Uetz, P.; Freed, P.; Hošek, J. (eds.). "Python natalensis SMITH, 1840". The Reptile Database. பார்க்கப்பட்ட நாள் 14 October 2019.
Genus: {{BioRef\|reptileDB \|genus=Cylindrophis\|access-date=22 November 2018}}	Uetz, P.; Freed, P.; Hošek, J. (eds.). "Cylindrophis". The Reptile Database. பார்க்கப்பட்ட நாள் 22 November 2018.
Use `\|taxon=` parameter for higher taxa:
Family: {{BioRef\|reptileDB \|taxon=Pythonidae\|title=Species in Family Pythonidae\|access-date=22 November 2018}}	Uetz, P.; Freed, P.; Hošek, J. (eds.). "Species in Family Pythonidae". The Reptile Database. பார்க்கப்பட்ட நாள் 22 November 2018.
Other taxon (e.g. infraorder): {{BioRef\|reptileDB \|taxon=Alethinophidia\|access-date=22 November 2018}}	Uetz, P.; Freed, P.; Hošek, J. (eds.). "Alethinophidia". The Reptile Database. பார்க்கப்பட்ட நாள் 22 November 2018.

ASM Mammal Diversity Database

Template usage	Results
Family using `\|taxon=` parameter: {{BioRef\|asm \|taxon=Felidae \|access-date=19 November 2018 \|mode=cs2}}	Lua error in Module:FishRef at line 656: attempt to concatenate local 'rank' (a nil value).
Family using `\|family=` parameter: {{BioRef\|asm \|family=Canidae \|access-date=19 November 2018 \|mode=cs2}}	"Canidae", ASM Mammal Diversity Database, American Society of Mammalogists, பார்க்கப்பட்ட நாள் 19 November 2018
Genus using `\|genus=` parameter: {{BioRef\|asm \|genus=Ursus \|access-date=19 November 2018}}	"Ursus". ASM Mammal Diversity Database. American Society of Mammalogists. பார்க்கப்பட்ட நாள் 19 November 2018.
Species using `\|id=` parameter: {{BioRef\|asm \|id=8541 \|title=Sand cat\|access-date=19 November 2018}}	"Sand cat". ASM Mammal Diversity Database. American Society of Mammalogists. பார்க்கப்பட்ட நாள் 19 November 2018.
Species with `\|genus=` and `\|species=` parameters: {{BioRef\|asm \|genus=Panthera\|species=leo \|access-date=19 November 2018}}	"Panthera leo". ASM Mammal Diversity Database. American Society of Mammalogists. பார்க்கப்பட்ட நாள் 19 November 2018.