View source for Template:Service link/doc

'''NOTE: Documentation is outdated. Will update momentarily.'''



'''Service link''' is a template that creates links to services on the wiki and includes an icon for improved recognition. Reuses standardizes icon size templates for consistency.

== Overview ==

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

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]]).

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

== Usage ==

<pre>
{{Service link|service|iconsize}}
</pre>

== Parameters ==

Only the first parameter, <code>service</code> is required, and it must be spelled correctly to match the in-game name of the service. 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.

{|class="wikitable"
|-
! Parameter !! Type !! Description
|-
| service || string || '''Required.''' The in-game name of the service whose page you want to link to and whose icon you might want to display.
|-
| iconsize || string || One of the following values to indicate the desired size of the icon:<br />
<table><tr><td>
* <code>none</code>
* <code>small</code>
* <code>med</code>
* <code>large</code>
* <code>huge</code>
</td><td>
which will prevent an icon from displaying<br />
which sizes the icon to {{ImgS}} from [[Template:ImgS]], '''default'''<br />
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 ==

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

'''Example:'''

<pre>
{{Service link}}
</pre>

Yields:

'''{{Service link}}'''

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

'''Example:'''

Broken: <code><nowiki>{{Service link|Educatoin}}</nowiki></code>

'''{{Service link|Educatoin}}'''

Fixed: <code><nowiki>{{Service link|Education}}</nowiki></code>

{{Service link|Education}}

== Additional Examples and Errors ==

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

{| class="wikitable"
! Parameters !! Examples !! Expected outcome
|-
| None
| <code><nowiki>{{Service link}}</nowiki></code>
| An error.
|-
| service only
| <code><nowiki>{{Service link|Luxury}}</nowiki></code>
|rowspan="2"| A small, text-sized icon and link, best for within paragraphs.
|-
|rowspan="4"| service and iconsize
| <code><nowiki>{{Service link|Leisure|small}}</nowiki></code>
|-
| <code><nowiki>{{Service link|Treatment|med}}</nowiki></code>
| A moderately-sized icon and a link, best in dense tables.
|-
| <code><nowiki>{{Service link|Brawling|large}}</nowiki></code>
| A large icon and a link, best as featured items within tables.
|-
| <code><nowiki>{{Service link|Religion|huge}}</nowiki></code>
| A very large icon and a link, in case you every need one this big.
|}

The following are generated by calling the template.

1 <code><nowiki>{{Service link|Education|none}}</nowiki></code> yields:

{{Service link|Education|none}}

2. <code><nowiki>{{Service link|Education|small}}</nowiki></code> yields:

{{Service link|Education|small}}

3. <code><nowiki>{{Service link|Education|med}}</nowiki></code> yields:

{{Service link|Education|med}}

4. <code><nowiki>{{Service link|Education|large}}</nowiki></code> yields:

{{Service link|Education|large}}

5. <code><nowiki>{{Service link|Education|huge}}</nowiki></code> yields:

{{Service link|Education|huge}}

The following are additional incorrect usages of the template:

6. With no service but an icon size, <code><nowiki>{{Service link||large}}</nowiki></code> yields:

'''{{Service 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.

9. With a valid service but invalid icon size, <code><nowiki>{{Service link|Education|gigantic}}</nowiki></code> yields:

{{Service link|Education|gigantic}}