Template:Resource link

Resource_link is a template creates links to resources (or goods) on the wiki and includes an icon for improved recognition. Reuses standardizes icon size templates for consistency.

The Template:rl is a shortcut to this template.

Overview

This template should be used liberally across the wiki, wherever the names of goods are mentioned in paragraphs or in tables. The accompanying icons will help skimming for expert players and orientation for new players.

Since the rendering of the template ends in a standard wikilink, you can append an s after the template to write the plural of the good if it isn't already plural. Just like a regular wiki link, {{rl|Reed}}s yields Reeds, plural, with the s included in the link text.

For in-paragraph display, which is presumed to be the most common utilization, the default icon size is small, or x16px from Template:ImgS. For use in tables where more spacing between lines doesn't hurt readability or aesthetics, it is recommended to use med, which will increase the size of the icons to x30px (from Template:ImgM).

Use your judgment when writing content. The first mention of a resource in a paragraph should probably be done with this template. But you may find that paragraphs densely mentioning resources become harder not easier to read. You may decide that after the first mention of the resource, it's better for subsequent references to be in plain text or with this template but without an icon.

Usage

{{Resource link|resource|iconsize}}

Parameters

Only the first parameter, resource is required, and it must be spelled correctly to match the in-game name of the resource or good. The other parameter is optional but improve this template's applicability to more instances of its use. You may include or omit any parameters' names.

Parameter	Type	Description
resource	string	Required. The in-game name of the good whose page you want to link to and whose icon you want to display.
iconsize	string	One of the following values to indicate the desired size of the icon: none small med large huge which will prevent an icon from displaying which sizes the icon to x16px from Template:ImgS, default which sizes the icon to x30px from Template:ImgM which sizes the icon to x60px from Template:ImgL which sizes the icon to x84px from Template:ImgH

Errors

When the template is called without a resource name, the template reminds you that it is required.

Example:

{{Resource link}}

Yields:

When providing the name of a good, it is important that it is spelled correctly, including any punctuation or spaces. Otherwise, you will see an error message:

Example:

Broken: {{Resource link|TrainingGear}}

Fixed: {{Resource link|Training Gear}}

Training Gear

Additional Examples and Errors

Here are ways to call the template and the expected result:

Parameters	Examples	Expected outcome
None	{{Resource link}} or {{rl}}	An error.
resource only	{{Resource link|Biscuits}}	A small, text-sized icon and link, best for within paragraphs.
resource and iconsize	{{rl|Crystalized Dew|small}}
	{{rl|Training Gear|med}}	A moderately-sized resource icon and a link, best in dense tables.
	{{rl|Flour|large}}	A large resource icon and a link, best as featured items within tables.
	{{rl|Pack of Trade Goods|huge}}	A very large resource icon and a link, in case you every need one this big.

The following are generated by calling the template.

1 {{Resource link|Biscuits|none}} yields:

Biscuits

2. {{Resource link|Biscuits|small}} yields:

Biscuits

3. {{Resource link|Biscuits|med}} yields:

Biscuits

4. {{Resource link|Biscuits|large}} yields:

Biscuits

5. {{Resource link|Biscuits|huge}} yields:

Biscuits

The following are additional incorrect usages of the template:

6. With no resource but an icon size, {{Resource link||large}} yields:

Finally, providing an icon size that is not recognized does not break the template. There is a default icon size instead of returning an error.

9. With a valid resource but invalid icon size, {{Resource link|Biscuits|gigantic}} yields:

Biscuits