Difference between revisions of "Module:FishRef/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Jts1882
(update for new name →‎top)
blackwiki>Jts1882
(update for change to FishRef)
Line 1: Line 1:
This module is to create {{tl|cite web}} references to the ''[[Catalog of Fishes]]'' database. The output is a reference with a link  to the results of the particular search that is being referenced.
+
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 is used with {{tl|Catalog of Fishes}}, which is 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}}.
+
The module provides a wrapper to the cite web system, which means the 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}}.
  
 
'''Usage of module:''' <nowiki>{{#invoke:FishRef|cof}}</nowiki>
 
'''Usage of module:''' <nowiki>{{#invoke:FishRef|cof}}</nowiki>

Revision as of 14:34, 21 November 2018

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 the 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}}.

Usage of module: {{#invoke:FishRef|cof}}

Examples of Lua module {{Catalog of Fishes}}

Use the templates as follows:

{{Catalog of Fishes |family=Xiphiidae |list=species |access-date=7 June 2018}}
{{Catalog of Fishes |family=Cyprinidae |access-date=7 June 2018}}
{{Catalog of Fishes |family=Salmonidae |list=genus |access-date=7 June 2018}}

{{Catalog of Fishes |genus=Vinagarra |access-date=7 June 2018}}

{{Catalog of Fishes |genus=Vinagarra |species=elongata |access-date=7 June 2018}} 
{{Catalog of Fishes |genus=Abbottina |species=rivularis |access-date=7 June 2018}}
{{Catalog of Fishes |genus=Tylognathus |species=sinensis |access-date=7 June 2018}}

{{Catalog of Fishes |genid=150  |access-date=8 June 2018}} 
{{Catalog of Fishes |genid=150 |title=Syngnathus |access-date=8 June 2018}} 

{{Catalog of Fishes|spid=14756  |access-date=8 June 2018}}
{{Catalog of Fishes |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}

Results:

  • Eschmeyer, William N.; Fricke, Ron & van der Laan, Richard (eds.). "Species in the family Xiphiidae". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018.
  • Eschmeyer, William N.; Fricke, Ron & van der Laan, Richard (eds.). "Genera in the family Cyprinidae". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018.
  • Eschmeyer, William N.; Fricke, Ron & van der Laan, Richard (eds.). "Genera in the family Cyprinidae". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018.




Examples of use of template language versions templates

Use the templates as follows:

{{Cof family |Xiphiidae|7 June 2018}}
{{Cof family |family=Xiphiidae |list=species |access-date=7 June 2018}}
{{Cof family |family=Cyprinidae |access-date=7 June 2018}}
{{Cof family |family=Cyprinidae |list=genus |access-date=7 June 2018}}

{{Cof genus |Garra|7 June 2018}}
{{Cof genus |genus=Vinagarra |access-date=7 June 2018}}

{{Cof species |genus=Vinagarra |species=elongata|access-date=7 June 2018}} 
{{Cof species |Abbottina|rivularis|7 June 2018}}
{{Cof species |Tylognathus|sinensis|7 June 2018}}

{{Cof record |genid=150 |title=Syngnathus |access-date=8 June 2018}} 
{{Cof record |spid=14756 |title=Syngnathus abaster |access-date=8 June 2018}}

{{Cof record |genid=150  |access-date=8 June 2018}} 
{{Cof record |spid=14756  |access-date=8 June 2018}}

Results:

  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Xiphiidae genera". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Xiphiidae species". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Cyprinidae genera". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Cyprinidae genera". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)


  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Garra species". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Vinagarra species". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)


  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Vinagarra elongata synonyms". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Abbottina rivularis synonyms". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Tylognathus sinensis synonyms". Catalog of Fishes. California Academy of Sciences. Retrieved 7 June 2018. Unknown parameter |name-list-style= ignored (help)


  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Syngnathus". Catalog of Fishes. California Academy of Sciences. Retrieved 8 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "Syngnathus abaster". Catalog of Fishes. California Academy of Sciences. Retrieved 8 June 2018. Unknown parameter |name-list-style= ignored (help)


  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "genid=150". Catalog of Fishes. California Academy of Sciences. Retrieved 8 June 2018. Unknown parameter |name-list-style= ignored (help)
  • Eschmeyer, W. N.; R. Fricke; R. van der Laan (eds.). "spid=14756". Catalog of Fishes. California Academy of Sciences. Retrieved 8 June 2018. Unknown parameter |name-list-style= ignored (help)