Template:Species link/doc - Revision history

76561197969631737: updating documentation to reflect parameter name standardization

2024-10-15T02:38:56Z

updating documentation to reflect parameter name standardization

← Older revision		Revision as of 02:38, 15 October 2024
Line 24:		Line 24:
	! Parameter !! Type !! Description		! Parameter !! Type !! Description
	\|-		\|-
	\| ~~iconsize~~ \|\| string \|\| one of the following: <code>~~small~~</code>, <code>~~medium~~</code>, <code>~~large~~</code>, <code>~~huge~~</code>~~. You may also write~~ <code>~~none~~</code> ~~to skip the icon.~~ The default is <code>small</code>, which is text-height for use in paragraphs. If you do not name this parameter, it must come second.		\| size \|\| string \|\| The size of the icon to display. Choose one of the following:
			* <code>none</code>
			* <code>small</code>
			* <code>medium</code>
			* <code>large</code>
			* <code>huge</code>
			The default is <code>small</code>, which is text-height for use in paragraphs. If you do not name this parameter with <code>size=</code>, it must come second.
	\|-		\|-
	\| display \|\| string \|\| if you include <code>display=notext</code>, only the icon will be rendered. There are currently no other options for this parameter.		\| display \|\| string \|\| if you include <code>display=notext</code>, only the icon will be rendered. There are currently no other options for this parameter.
Line 37:		Line 43:


	<pre>{{Species link\|human\|~~iconsize~~=medium}}</pre>		<pre>{{Species link\|human\|size=medium}}</pre>
	Yields a slightly larger icon, suitable for easy recognition in tables:		Yields a slightly larger icon, suitable for easy recognition in tables:

	{{Species link\|human\|~~iconsize~~=medium}}		{{Species link\|human\|size=medium}}


Line 50:		Line 56:
	=== Other examples ===		=== Other examples ===

	<pre>{{Species link\|species=Harpy\|~~iconsize~~=small\|display=notext}}</pre>		<pre>{{Species link\|species=Harpy\|size=small\|display=notext}}</pre>
	Yields just a linked icon {{Species link\|species=Harpy\|~~iconsize~~=small\|display=notext}} for the Harpies. Use this sparingly, because it is not as accessible, and in paragraphs the icons can be hard to distinguish. This is good in tables where the icon functions as a reminder than an important factor. An example where this is useful is in the infoboxes of buildings which feature specialization as an important factor, and the species icon is shown next to the specialization as just a quick reminder.		Yields just a linked icon {{Species link\|species=Harpy\|size=small\|display=notext}} for the Harpies. Use this sparingly, because it is not as accessible, and in paragraphs the icons can be hard to distinguish. This is good in tables where the icon functions as a reminder than an important factor. An example where this is useful is in the infoboxes of buildings which feature specialization as an important factor, and the species icon is shown next to the specialization as just a quick reminder.


Line 58:		Line 64:


	<pre>{{Species link\|Foxes\|~~iconsize~~=gigantic}}</pre>		<pre>{{Species link\|Foxes\|size=gigantic}}</pre>
	Providing an icon size that is not recognized does not return an error. Instead, the template shows the default, small icon size: {{Species link\|Foxes\|~~iconsize~~=gigantic}}		Providing an icon size that is not recognized does not return an error. Instead, the template shows the default, small icon size: {{Species link\|Foxes\|size=gigantic}}

	=== Errors ===		=== Errors ===

76561197969631737: /* Examples */ edits

2024-10-12T01:32:00Z

Examples: edits

← Older revision		Revision as of 01:32, 12 October 2024
Line 48:		Line 48:
	{{Species link\|human\|large}}		{{Species link\|human\|large}}

			=== Other examples ===

	<pre>{{Species link\|~~human~~\|~~none~~}}</pre>		<pre>{{Species link\|species=Harpy\|iconsize=small\|display=notext}}</pre>
	Yields just the ~~text~~, ~~suitable for when mentioning subsequent times~~ in the ~~same paragraph~~. (This is ~~preferable to using~~ a ~~wiki link~~, so the ~~styling matches, even if it appears~~ to ~~have~~ the ~~same styling right now~~.)		Yields just a linked icon {{Species link\|species=Harpy\|iconsize=small\|display=notext}} for the Harpies. Use this sparingly, because it is not as accessible, and in paragraphs the icons can be hard to distinguish. This is good in tables where the icon functions as a reminder than an important factor. An example where this is useful is in the infoboxes of buildings which feature specialization as an important factor, and the species icon is shown next to the specialization as just a quick reminder.

	~~{{Species link\|human\|none}}~~

	~~=== Other examples ===~~		<pre>{{Species link\|human\|none}}</pre>
			Yields just the text link, {{Species link\|human\|none}}, suitable for when mentioning more than one time in the same paragraph to avoid cluttering the paragraph with icons. (This is preferable to using a regular wiki link, so the styling matches, even if it appears to have the same styling right now.)

	~~<pre>{{Species link\|species=Harpy\|iconsize=small\|display=notext}}</pre>~~
	Yields just a linked icon {{Species link\|species=Harpy\|iconsize=small\|display=notext}} for the Harpies. Use this sparingly, because it is not as accessible, and in paragraphs the icons can be hard to distinguish. This is good in tables where the icon functions as a reminder than an important factor. An example where this is useful is in the infoboxes of buildings which feature specialization as an important factor, and the species icon is shown next to the specialization as just a quick reminder.

	<pre>{{Species link\|Foxes\|iconsize=gigantic}}</pre>		<pre>{{Species link\|Foxes\|iconsize=gigantic}}</pre>

76561197969631737: /* Basic usage */ Adding no-icon example

2024-10-12T00:09:52Z

Basic usage: Adding no-icon example

← Older revision		Revision as of 00:09, 12 October 2024
Line 47:		Line 47:

	{{Species link\|human\|large}}		{{Species link\|human\|large}}


			<pre>{{Species link\|human\|none}}</pre>
			Yields just the text, suitable for when mentioning subsequent times in the same paragraph. (This is preferable to using a wiki link, so the styling matches, even if it appears to have the same styling right now.)

			{{Species link\|human\|none}}

	=== Other examples ===		=== Other examples ===

76561197969631737: Refactored the documentation into a subpage

2024-10-10T04:32:48Z

Refactored the documentation into a subpage

New page

== Overview ==

Creates a link to a species' page.

== Parameters ==

=== Species ===

The name of the species is the only required parameter. Use the name of the species as it appears in game. A missing or misspelled species name will result in an error.

If you do not wish to write the code <code>species=</code>, you may skip that, but you must specify the name of the species before any other parameters.

{|class=wikitable
! Parameter !! Type !! Description
|-
| species || string || The name of the species, as it appears in the game, either singular or plural.
|}

=== Output overrides ===

All of these parameters are optional and change how the link is formatted.

{|class=wikitable
! Parameter !! Type !! Description
|-
| iconsize || string || one of the following: <code>small</code>, <code>medium</code>, <code>large</code>, <code>huge</code>. You may also write <code>none</code> to skip the icon. The default is <code>small</code>, which is text-height for use in paragraphs. If you do not name this parameter, it must come second.
|-
| display || string || if you include <code>display=notext</code>, only the icon will be rendered. There are currently no other options for this parameter.
|}

== Examples ==

=== Basic usage ===

<pre>{{Species link|species=Humans}}</pre>
Yields {{Species link|species=Humans}}, a text-height icon that flows well in paragraphs without impacting line height.

<pre>{{Species link|human|iconsize=medium}}</pre>
Yields a slightly larger icon, suitable for easy recognition in tables:

{{Species link|human|iconsize=medium}}

<pre>{{Species link|human|large}}</pre>
Yields a larger icon, suitable for tables featuring the species as an important factor:

{{Species link|human|large}}

=== Other examples ===

<pre>{{Species link|species=Harpy|iconsize=small|display=notext}}</pre>
Yields just a linked icon {{Species link|species=Harpy|iconsize=small|display=notext}} for the Harpies. Use this sparingly, because it is not as accessible, and in paragraphs the icons can be hard to distinguish. This is good in tables where the icon functions as a reminder than an important factor. An example where this is useful is in the infoboxes of buildings which feature specialization as an important factor, and the species icon is shown next to the specialization as just a quick reminder.

<pre>{{Species link|Foxes|iconsize=gigantic}}</pre>
Providing an icon size that is not recognized does not return an error. Instead, the template shows the default, small icon size: {{Species link|Foxes|iconsize=gigantic}}

=== Errors ===

The following are error messages generated by calling the template incorrectly.

<pre>{{Species link}}</pre>
With no arguments: {{Species_link}}

<pre>{{Species link|Centaurs}}</pre>
Naming a species that doesn't exist in the game: {{Species link|Centaurs}}

<noinclude>
[[Category:Template documentation]]
</noinclude>