Editing Module:FishRef/doc

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. <code>|mode=cs1|2</code> or <code>|quote=TEXT</code>).

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:''' <nowiki>{{#invoke:FishRef|cof}}</nowiki>, <nowiki>{{#invoke:FishRef|fishbase}}</nowiki>, <nowiki>{{#invoke:FishRef|fossilworks}}</nowiki>, etc.

==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'''
{| class="wikitable"
|-
! Template usage !! Results
|-
|Family using {{para|taxon}} parameter:
<pre>{{BioRef|asm |taxon=Felidae |access-date=19 November 2018 |mode=cs2}}</pre>
|    {{BioRef|asm |taxon=Felidae |access-date=19 November 2018 |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 |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}}
*{{User:Jts1882/sandbox/template/asm |genus=Panthera|species=leo |access-date=19 November 2018}}