Template:Resource link: Difference between revisions

From Against the Storm Official Wiki
(updated to match the new module method; will update doc next)
(Rewriting doc to standard, new parameters, etc. set by building link)
Line 4: Line 4:
}}</includeonly><noinclude>
}}</includeonly><noinclude>


'''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.
== Overview ==


The [[Template:rl]] is a shortcut to this template.
Creates a link to the article for a resource (or good).


== Overview ==
[[Template:rl]] is a shortcut to this template. You can use <code><nowiki>{{bl}}</nowiki></code> instead of <code><nowiki>{{Building link}}</nowiki></code> with the same parameters.


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.
Use good judgment when writing paragraphs that feature a lot of resource links. The first mention should probably be done with this template. But you may find that paragraphs densely mentioning resources become harder not easier to read due to the icons and color fluctuations. After the first mention of the resource, it might be better for subsequent references to be in plain text or with this template but without an icon.


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, <code><nowiki>{{rl|Reed}}s</nowiki></code> yields {{rl|Reed}}s, plural, with the ''s'' included in the link text.
== Parameters ==


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


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.
The name of the resource (or good) is the only required parameter. Use the name as it appears in-game, including spaces. A missing or mispelled name will result in an error.


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


<pre>
{|class=wikitable
{{Resource link|resource|iconsize}}
! Parameter !! Type !! Description
</pre>
|-
| name || string || The name of the resource, as it appears in the game.
|}


== Parameters ==
=== Output overrides ===


Only the first parameter, <code>resource</code> 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.
All of these parameters are optional and change how the link is formatted.


{|class="wikitable"
{|class=wikitable
|-
! Parameter !! Type !! Description
! 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.
| size || string || The size of the icon to display. Choose one of the following:
|-
| iconsize || string || One of the following values to indicate the desired size of the icon:<br />
<table><tr><td>
* <code>none</code>
* <code>none</code>
* <code>small</code>
* <code>small</code>
* <code>med</code>
* <code>medium</code>
* <code>large</code>
* <code>large</code>
* <code>huge</code>
* <code>huge</code>
</td><td>
The default for resources is <code>small</code>, suitable for paragraphs.
which will prevent an icon from displaying<br />
|-
which sizes the icon to {{ImgS}} from [[Template:ImgS]], '''default'''<br />
| display || string || if you include <code>display=notext</code> only the icon will be rendered. There are currently no other options for this parameter.
which sizes the icon to {{ImgM}} from [[Template:ImgM]]<br />
which sizes the icon to {{ImgL}} from [[Template:ImgL]]<br />
which sizes the icon to {{ImgH}} from [[Template:ImgH]]
</td></tr></table>
|}
|}


== Errors ==
Resource links that are written into paragraphs should use the small icon, which is the default, or no icon. The small icon size conforms to the standard line height of text on the wiki and will not disrupt the flow of text.
 
When the template is called without a resource name, the template reminds you that it is required.


'''Example:'''
Note that adding "s" after the template call no longer includes the "s" in the link as it used to.


<pre>
== Examples ==
{{Resource link}}
</pre>


Yields:
=== Basic usage ===


'''{{Resource link}}'''
<pre>{{Resource link|Biscuits}}</pre>
Makes a link to the {{Resource link|Biscuits}} article with a small icon suitable for use in-line in paragraphs like this that discuss villagers and their needs for yummy food. Subsequent mention of Biscuits in the same paragraph can omit the link to avoid adding unnecessary color to paragraphs.


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:'''
<pre>{{Resource link|Biscuits|medium}}</pre>
Yields an icon that's slightly larger for improved recognition. Suitable for tables that list lots of resources where layout provides some space for icons:


Broken: <code><nowiki>{{Resource link|TrainingGear}}</nowiki></code>
{{Resource link|Biscuits|size=medium}}


'''{{Resource link|TrainingGear}}'''


Fixed: <code><nowiki>{{Resource link|Training Gear}}</nowiki></code>
<pre>{{Resource link|name=Biscuits|large}}</pre>
Yields a large icon for good recognition for use in tables with space that allows it:


{{Resource link|Training Gear}}
{{Resource link|name=Biscuits|large}}


== Additional Examples and Errors ==
Here are ways to call the template and the expected result:
{| class="wikitable"
! Parameters !! Examples !! Expected outcome
|-
| None
| <code><nowiki>{{Resource link}}</nowiki></code><br />or <code><nowiki>{{rl}}</nowiki></code>
| An error.
|-
| resource only
| <code><nowiki>{{Resource link|Biscuits}}</nowiki></code>
|rowspan="2"| A small, text-sized icon and link, best for within paragraphs.
|-
|rowspan="4"| resource and iconsize
| <code><nowiki>{{rl|Crystalized Dew|small}}</nowiki></code>
|-
| <code><nowiki>{{rl|Training Gear|med}}</nowiki></code>
| A moderately-sized resource icon and a link, best in dense tables.
|-
| <code><nowiki>{{rl|Flour|large}}</nowiki></code>
| A large resource icon and a link, best as featured items within tables.
|-
| <code><nowiki>{{rl|Pack of Trade Goods|huge}}</nowiki></code>
| A very large resource icon and a link, in case you every need one this big.
|}


The following are generated by calling the template.
<pre>{{Resource link|Biscuits|size=huge}}</pre>
Yields the largest icon, which is great for headlining tables featuring this resource:


1 <code><nowiki>{{Resource link|Biscuits|none}}</nowiki></code> yields:
{{Resource link|Biscuits|size=huge}}


{{Resource link|Biscuits|none}}


2. <code><nowiki>{{Resource link|Biscuits|small}}</nowiki></code> yields:
=== Other examples ===


{{Resource link|Biscuits|small}}
<pre>{{Resource link|Biscuits|size=none}}</pre>
Alternatively, paragraphs can include even simpler links like {{Resource link|Biscuits|size=none}} that display no icon to improve the flow of the paragraph at the cost of a slight reduction in recognition since the resource icons are so ubiquitous in the game. The highlighting of the link is still sufficient to draw the reader's attention. No icon is advised for every link to a resource after its first (where an icon is appropriate) within each paragraph.


3. <code><nowiki>{{Resource link|Biscuits|med}}</nowiki></code> yields:
Using no icon is also great for lists:
* {{Resource link|Biscuits|size=none}}
* {{Resource link|Jerky|size=none}}
* {{Resource link|Pie|size=none}}


{{Resource link|Biscuits|med}}


4. <code><nowiki>{{Resource link|Biscuits|large}}</nowiki></code> yields:
<pre>{{Resource link|Jerky|size=gigantic}}</pre>
Specifying an icon size that is not recognized does not return an error. Instead, it defaults to the small icon:


{{Resource link|Biscuits|large}}
{{Resource link|Jerky|size=gigantic}}


5. <code><nowiki>{{Resource link|Biscuits|huge}}</nowiki></code> yields:


{{Resource link|Biscuits|huge}}
=== Errors ===


The following are additional incorrect usages of the template:
The following are error messages generated by calling the template incorrectly.


6. With no resource but an icon size, <code><nowiki>{{Resource link||large}}</nowiki></code> yields:
<pre>{{Resource link}}</pre>
With no arguments: {{Resource link}}


'''{{Resource link||large}}'''


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.
<pre>{{Resource link|Potatoes}}</pre>
Naming a resource that doesn't exist in the game: {{Resource link|Potatoes}}


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


{{Resource link|Biscuits|gigantic}}
<pre>{{Resource link|huge|Jerky}}</pre>
The same goes for swapping the order of the parameters so that the resource is not first: {{Resource link|huge|Jerky}}


[[Category:Lua-based templates]]
[[Category:Lua-based templates]]
[[Category:Link templates]]</noinclude>
[[Category:Link templates]]</noinclude>

Revision as of 03:10, 19 October 2024


Overview

Creates a link to the article for a resource (or good).

Template:rl is a shortcut to this template. You can use {{bl}} instead of {{Building link}} with the same parameters.

Use good judgment when writing paragraphs that feature a lot of resource links. The first mention should probably be done with this template. But you may find that paragraphs densely mentioning resources become harder not easier to read due to the icons and color fluctuations. After the first mention of the resource, it might be better for subsequent references to be in plain text or with this template but without an icon.

Parameters

Resource

The name of the resource (or good) is the only required parameter. Use the name as it appears in-game, including spaces. A missing or mispelled name will result in an error.

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

Parameter Type Description
name string The name of the resource, as it appears in the game.

Output overrides

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

Parameter Type Description
size string The size of the icon to display. Choose one of the following:
  • none
  • small
  • medium
  • large
  • huge

The default for resources is small, suitable for paragraphs.

display string if you include display=notext only the icon will be rendered. There are currently no other options for this parameter.

Resource links that are written into paragraphs should use the small icon, which is the default, or no icon. The small icon size conforms to the standard line height of text on the wiki and will not disrupt the flow of text.

Note that adding "s" after the template call no longer includes the "s" in the link as it used to.

Examples

Basic usage

{{Resource link|Biscuits}}

Makes a link to the Biscuits Biscuits article with a small icon suitable for use in-line in paragraphs like this that discuss villagers and their needs for yummy food. Subsequent mention of Biscuits in the same paragraph can omit the link to avoid adding unnecessary color to paragraphs. 


{{Resource link|Biscuits|medium}}

Yields an icon that's slightly larger for improved recognition. Suitable for tables that list lots of resources where layout provides some space for icons:

Biscuits Biscuits 


{{Resource link|name=Biscuits|large}}

Yields a large icon for good recognition for use in tables with space that allows it:

Biscuits Biscuits 


{{Resource link|Biscuits|size=huge}}

Yields the largest icon, which is great for headlining tables featuring this resource:

Biscuits Biscuits


Other examples

{{Resource link|Biscuits|size=none}}

Alternatively, paragraphs can include even simpler links like Biscuits that display no icon to improve the flow of the paragraph at the cost of a slight reduction in recognition since the resource icons are so ubiquitous in the game. The highlighting of the link is still sufficient to draw the reader's attention. No icon is advised for every link to a resource after its first (where an icon is appropriate) within each paragraph.

Using no icon is also great for lists: 


{{Resource link|Jerky|size=gigantic}}

Specifying an icon size that is not recognized does not return an error. Instead, it defaults to the small icon:

Jerky Jerky


Errors

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

{{Resource link}}

With no arguments: Lua error in Module:ResourceLink at line 64: You must specify a resource. Please see the template documentation for how to use the parameters. 


{{Resource link|Potatoes}}

Naming a resource that doesn't exist in the game: Lua error in Module:ResourceLink at line 41: No resource found with name: Potatoes. Please see the template documentation for how to use the parameters. 


{{Resource link|huge|Jerky}}

The same goes for swapping the order of the parameters so that the resource is not first: Lua error in Module:ResourceLink at line 41: No resource found with name: huge. Please see the template documentation for how to use the parameters.

Retrieved from "https://hoodedhorse.com/wiki/Against_the_Storm/index.php?title=Template:Resource_link&oldid=8928"