Template:Fish info/doc

This is the documentation subpage of Template:Fish info. It contains usage information that is not part of the underlying template.

Usage

This template sets properties for fish. It only sets semantic data but does not display anything. It can be used on item and minion pages. This is a work in progress. Not ready for general use. - Gurgum

{{Fish info
| fishing-type =
| aquarium-water =
| aquarium-size =
| canvas = 
| guide-description =
| fishing-level =
| fishing-level-stars =
| prime-spot =
| req-tome =
| bite =
| prefers-bait =
| other-baits =
| req-snagging =
| print-image =
| aquarium-image = 
| video-link=
}}

This template sets semantic properties for fish. It does not display anything.

Template parameters

Parameter		Description	Type	Status
fishing-type	fishing-type	The type of fishing required to catch a given fish. Sets "Has fishing type" Example Skies	String	required
aquarium-water	aquarium-water	The type of aquarium water a fish requires. Sets "Requires aquarium water" Suggested values none, freshwater, saltwater	String	required
aquarium-size	aquarium-size	The size of the smallest aquarium that a fish will fit into. Sets "Requires aquarium size" Suggested values 1,2,3,4	Number	optional
canvas	canvas	The size of the smallest aquarium that a fish will fit into. Sets "Fits Canvas" Suggested values 1,2,3,4	Number	optional
guide-description	guide-description	The description of a fish from the fish guide. Sets "Has fish description"	String	optional
fishing-level	fishing-level	The fishing level recommended to catch a given fish. Sets "Has recommended fishing level"	Number	required
fishing-level-stars	fishing-level-stars	The number of stars related to the level required to catch a fish. Sets "Has fishing level stars" Suggested values 0,1,2,3,4 Default 0	Number	required
prime-spot	prime-spot	The primary fishing spot where a fish can be caught. Sets "Has primary fishing spot" Example Fishing Log: Rogue River	Page name	required
req-tome	req-tome	The tome required to catch a given fish. Sets "Requires gathering tome" Example Tome of Ichthyological Folklore - Alexandria	Page name	optional
bite	bite	The strength of a fish's bite. Sets "Has bite" Suggested values !,!!,!!! Example !	String	optional
req-snagging	req-snagging	Whether snagging is required to catch a fish. Default false	Boolean	optional
print-image	print-image	The filename of the image of a fish on a framed angler's canvas. Example Titanic_Sawfish_print.png	File	optional
aquarium-image	aquarium-image	The filename of the image of a fish in an aquarium. Example Titanic_Sawfish_tank.png	File	optional
video-link	video-link	The link to a guide on how to catch a given fish. Example https://www.youtube.com/watch?v=5KKdB9TGjPk	URL	optional
other-baits	other-baits	Semicolon-delimited list of bait that a given fish will bite (other than the "preferred" bait). Example Pill Bug;Rat Tail	String	optional