Module:FishRef/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 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. &lt;code&gt;|mode=cs1|2&lt;/code&gt; or &lt;code&gt;|quote=TEXT&lt;/code&gt;).
 
 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|FishBase/sandbox}}, {{tl|BioRef}}, {{tl|fossilworks/sandbox}}, [[User:Jts1882/sandbox/template/asm]]
 
 '''Usage of module:''' &lt;nowiki&gt;{{#invoke:FishRef|cof}}&lt;/nowiki&gt;, &lt;nowiki&gt;{{#invoke:FishRef|fishbase}}&lt;/nowiki&gt;, &lt;nowiki&gt;{{#invoke:FishRef|fossilworks}}&lt;/nowiki&gt;, etc.
 
 ==Examples of templates using the [[Module:FishRef]]==
 
 ===Catalog of Fishes===
 '''Examples using {{tl|Catalog of Fishes}}'''
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |&lt;pre&gt;{{Catalog of Fishes |family=Xiphiidae |list=species |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |family=Xiphiidae |list=species |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |family=Cyprinidae |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |family=Cyprinidae |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |family=Salmonidae |list=genus |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |family=Salmonidae |list=genus |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genus=Vinagarra |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |genus=Vinagarra |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genus=Vinagarra |species=elongata |access-date=7 June 2018}} &lt;/pre&gt;
 |     {{Catalog of Fishes |genus=Vinagarra |species=elongata |access-date=7 June 2018}} 
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genus=Abbottina |species=rivularis |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |genus=Abbottina |species=rivularis |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genus=Tylognathus |species=sinensis |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |genus=Tylognathus |species=sinensis |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genid=150  |access-date=8 June 2018}} &lt;/pre&gt;
 |     {{Catalog of Fishes |genid=150  |access-date=8 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |genid=150 |title=Syngnathus |access-date=8 June 2018}} &lt;/pre&gt;
 |     {{Catalog of Fishes |genid=150 |title=Syngnathus |access-date=8 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes|spid=14756  |access-date=8 June 2018}}&lt;/pre&gt;
 |     {{Catalog of Fishes |spid=14756  |access-date=8 June 2018}}
 |-
 |&lt;pre&gt;{{Catalog of Fishes |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}&lt;/pre&gt;
 |     {{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=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |&lt;pre&gt;{{Cof family |Xiphiidae|access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof family |Xiphiidae|access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof family |family=Xiphiidae |list=species |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof family |family=Xiphiidae |list=species |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof family |family=Cyprinidae |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof family |family=Cyprinidae |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof family |family=Salmonidae |list=genus |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof family |family=Salmonidae |list=genus |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof genus |Garra|access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof genus |Garra|access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof genus |genus=Vinagarra |access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof genus |genus=Vinagarra |access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof species |genus=Vinagarra |species=elongata|access-date=7 June 2018}} &lt;/pre&gt;
 |     {{Cof species |genus=Vinagarra |species=elongata|access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof species |Abbottina|rivularis|access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof species |Abbottina|rivularis|access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof species |Tylognathus|sinensis|access-date=7 June 2018}}&lt;/pre&gt;
 |     {{Cof species |Tylognathus|sinensis|access-date=7 June 2018}}
 |-
 |&lt;pre&gt;{{Cof record |genid=150 |title=Syngnathus |access-date=8 June 2018}} &lt;/pre&gt;
 |     {{Cof record |genid=150 |title=Syngnathus |access-date=8 June 2018}}
 |-
 |&lt;pre&gt;{{Cof record |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}&lt;/pre&gt;
 |     {{Cof record |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}
 |-
 |&lt;pre&gt;{{Cof record |genid=150  |access-date=8 June 2018}} &lt;/pre&gt;
 |     {{Cof record |genid=150  |access-date=8 June 2018}} 
 |-
 |&lt;pre&gt;{{Cof record |spid=14756  |access-date=8 June 2018}}&lt;/pre&gt;
 |     {{Cof record |spid=14756  |access-date=8 June 2018}}
 |}
 
 === Using {{tl|FishBase/sandbox}} ===
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |Species with positional parameters]:
 &lt;pre&gt;{{FishBase/sandbox|Danio|rerio|year=2018}} &lt;/pre&gt;
 |    {{FishBase/sandbox|Danio|rerio|year=2018}}
 |-
 |Subspecies with position parameters:
 &lt;pre&gt;{{FishBase/sandbox|Emmelichthys|nitidus|cyanescens}}  &lt;/pre&gt;
 |    {{FishBase/sandbox|Emmelichthys|nitidus|cyanescens}}
 |-
 |Species with named parameters:
 &lt;pre&gt;{{FishBase/sandbox|genus=Danio|species=rerio}}  &lt;/pre&gt;
 |    {{FishBase/sandbox|genus=Danio|species=rerio}}
 |-
 |Subspecies with named parameters:
 &lt;pre&gt;{{FishBase/sandbox|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}} &lt;/pre&gt;
 |    {{FishBase/sandbox|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}} 
 |-
 |Genus:
 &lt;pre&gt;{{FishBase/sandbox|genus=Emmelichthys}}&lt;/pre&gt;
 |    {{FishBase/sandbox|genus=Emmelichthys}}
 |-
 |Family:
 &lt;pre&gt;{{FishBase/sandbox|family=Percidae}}&lt;/pre&gt;
 |    {{FishBase/sandbox|family=Percidae}}
 |-
 |Order:
 &lt;pre&gt;{{FishBase/sandbox|order=Perciformes|access-date=19 November 2018|mode=cs2}}&lt;/pre&gt;
 |    {{FishBase/sandbox|order=Perciformes|access-date=19 November 2018|mode=cs2}}
 |}
 
 === Using {{tl|BioRef}}===
 
 '''Fishbase:'''
 
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage 
 ! Results
 |-
 |Species with positional parameters:
 &lt;pre&gt;{{BioRef|fishbase|Danio|rerio}}&lt;/pre&gt;
 |    {{BioRef|fishbase|Danio|rerio}}
 |-
 |Subspecies with positional parameters:
 &lt;pre&gt;{{BioRef|fishbase|Emmelichthys|nitidus|cyanescens}}&lt;/pre&gt;
 |    {{BioRef|fishbase|Emmelichthys|nitidus|cyanescens}}
 |-
 |Species with named parameters:
 &lt;pre&gt;{{BioRef|fishbase|genus=Danio|species=rerio}}&lt;/pre&gt;
 |    {{BioRef|fishbase|genus=Danio|species=rerio}}
 |-
 |Subspecies with named parameters:
 &lt;pre&gt;{{BioRef|fishbase|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}}&lt;/pre&gt;
 |    {{BioRef|fishbase|genus=Emmelichthys|species=nitidus|subspecies=cyanescens}}
 |-
 |Genus:
 &lt;pre&gt;{{BioRef|fishbase|genus=Emmelichthys}}&lt;/pre&gt;
 |    {{BioRef|fishbase|genus=Emmelichthys}}
 |-
 |Family:
 &lt;pre&gt;{{BioRef|fishbase|family=Percidae}}&lt;/pre&gt;
 |    {{BioRef|fishbase|family=Percidae}}
 |-
 |Order:
 &lt;pre&gt;{{BioRef|fishbase|order=Perciformes|access-date=19 November 2018|mode=cs2}}&lt;/pre&gt;
 |    {{BioRef|fishbase|order=Perciformes|access-date=19 November 2018|mode=cs2}}
 |}
 
 &lt;section begin=Herpetology /&gt;
 &lt;section begin=ASW6 /&gt;
 '''Amphibian Species of the World (ASW6)'''
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |Default page with family listing:
 &lt;pre&gt;{{BioRef|ASW6 |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|ASW6 |access-date=27 September 2019}}
 |-
 |Title + url:
 &lt;pre&gt;{{BioRef|ASW6 |title=Hylidae Rafinesque, 1815|year=2019 |url=http://research.amnh.org/vz/herpetology/amphibia/Amphibia/Anura/Hylidae |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{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):
 &lt;pre&gt;{{BioRef|ASW6 |family=Hylidae |year=2019  |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|ASW6 |family=Hylidae |year=2019  |access-date=27 September 2019}}
 |-
 |Genus + species (named parameters)::
 &lt;pre&gt;{{BioRef|ASW6 |genus=Chiromantis |species=cherrapunjiae |year=2019  |access-date=27 September 2019}} &lt;/pre&gt;
 |    {{BioRef|ASW6 |genus=Chiromantis |species=cherrapunjiae |year=2019  |access-date=27 September 2019}} 
 |-
 |Genus + species (positional parameters)::
 &lt;pre&gt;{{BioRef|ASW6 | Chiromantis| cherrapunjiae |year=2019  |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|ASW6 | Chiromantis| cherrapunjiae |year=2019  |access-date=27 September 2019}}
 &lt;!--|-
 |XXX:
 &lt;pre&gt;XXX&lt;/pre&gt;
 |    XXX--&gt;
 |-
 |Note: the citation title can changed with {{para|title|My title}}
 |}
 
 &lt;section end=ASW6 /&gt;
 &lt;section begin=AmphibiaWeb /&gt;
 '''AmphibiaWeb'''
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |Default page with for interactive family listing:
 &lt;pre&gt;{{BioRef|amphibiaweb |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|amphibiaweb |access-date=27 September 2019}}
 |-
 |Title with url:
 &lt;pre&gt;{{BioRef|amphibiaweb |title=Ranidae |year=2019 |url=https://amphibiaweb.org/lists/Ranidae.shtml |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|amphibiaweb |title=Ranidae |year=2019 |url=https://amphibiaweb.org/lists/Ranidae.shtml |access-date=27 September 2019}}
 |-
 |Family:
 &lt;pre&gt;{{BioRef|amphibiaweb |family=Ranidae |year=2019 |access-date=27 September 2019}} &lt;/pre&gt;
 |    {{BioRef|amphibiaweb |family=Ranidae |year=2019 |access-date=27 September 2019}}
 |-
 |Genus + species (named parameters):
 &lt;pre&gt;{{BioRef|amphibiaweb |genus=Altiphrynoides |species=malcolmi |year=2019 |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|amphibiaweb |genus=Altiphrynoides |species=malcolmi |year=2019 |access-date=27 September 2019}}
 |-
 |Genus + species (positional parameters):
 &lt;pre&gt;{{BioRef|amphibiaweb | Altiphrynoides | malcolmi |year=2019 |access-date=27 September 2019}}&lt;/pre&gt;
 |    {{BioRef|amphibiaweb | Altiphrynoides | malcolmi |year=2019 |access-date=27 September 2019}}
 &lt;!--|-
 |XXX:
 &lt;pre&gt;XXX&lt;/pre&gt;
 |    XXX--&gt;
 |-
 |Note: the citation title can changed with {{para|title|My title}}
 |}
 
 &lt;section end=AmphibiaWeb /&gt;
 &lt;section begin=reptileDB /&gt;
 
 '''Reptile database:'''
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |Species:
 &lt;pre&gt;{{BioRef|reptileDB |genus=Loxocemus |species=bicolor|access-date=22 November 2018}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |genus=Loxocemus |species=bicolor|access-date=22 November 2018}}
 &lt;!--|-
 |Species (positional parameters):
 &lt;pre&gt;{{BioRef|reptileDB |Loxocemus |bicolor|access-date=22 November 2018}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |Loxocemus |bicolor|access-date=22 November 2018}}--&gt;
 |-
 |Species (positional parameters) with title:
 &lt;pre&gt;{{BioRef|reptileDB |Python |natalensis |title=''Python natalensis'' SMITH, 1840|access-date=14 October 2019}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |Python |natalensis |title=''Python natalensis'' SMITH, 1840|access-date=14 October 2019}}
 |-
 |Genus:
 &lt;pre&gt;{{BioRef|reptileDB |genus=Cylindrophis|access-date=22 November 2018}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |genus=Cylindrophis|access-date=22 November 2018}}
 |-
 |Use {{para|taxon}} parameter for higher taxa:
 |-
 |Family:
 &lt;pre&gt;{{BioRef|reptileDB |taxon=Pythonidae|title=Species in Family Pythonidae|access-date=22 November 2018}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |taxon=Pythonidae|title=Species in Family Pythonidae|access-date=22 November 2018}}
 |-
 |Other taxon (e.g. infraorder):
 &lt;pre&gt;{{BioRef|reptileDB |taxon=Alethinophidia|access-date=22 November 2018}}&lt;/pre&gt;
 |    {{BioRef|reptileDB |taxon=Alethinophidia|access-date=22 November 2018}}
 |}
 
 &lt;section end=reptileDB /&gt;
 &lt;section end=Herpetology /&gt;
 
 '''ASM Mammal Diversity Database'''
 {| class=&quot;wikitable&quot;
 |-
 ! Template usage !! Results
 |-
 |Family using {{para|taxon}} parameter:
 &lt;pre&gt;{{BioRef|asm |taxon=Felidae |access-date=19 November 2018 |mode=cs2}}&lt;/pre&gt;
 |    {{BioRef|asm |taxon=Felidae |access-date=19 November 2018 |mode=cs2}}
 |-
 |Family using {{para|family}} parameter:
 &lt;pre&gt;{{BioRef|asm |family=Canidae |access-date=19 November 2018 |mode=cs2}}&lt;/pre&gt;
 |    {{BioRef|asm |family=Canidae |access-date=19 November 2018 |mode=cs2}}
 |-
 |Genus using {{para|genus}} parameter:
 &lt;pre&gt;{{BioRef|asm |genus=Ursus |access-date=19 November 2018}}&lt;/pre&gt;
 |    {{BioRef|asm |genus=Ursus |access-date=19 November 2018}}
 |-
 |Species using {{para|id}} parameter:
 &lt;pre&gt;{{BioRef|asm |id=8541 |title=Sand cat|access-date=19 November 2018}}&lt;/pre&gt;
 |    {{BioRef|asm |id=8541 |title=Sand cat|access-date=19 November 2018}}
 |-
 |Species with {{para|genus}} and {{para|species}} parameters:
 &lt;pre&gt;{{BioRef|asm |genus=Panthera|species=leo |access-date=19 November 2018}}&lt;/pre&gt;
 |    {{BioRef|asm |genus=Panthera|species=leo |access-date=19 November 2018}}
 |}
 
 === [[User:Jts1882/sandbox/template/asm]]===
 
 *{{User:Jts1882/sandbox/template/asm |taxon=Felidae |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=8541 |title=Sand cat|access-date=19 November 2018}}