Difference between revisions of "Template:Royalty/doc"

Revision as of 09:29, 2 November 2022

Description

Place this template at the top of pages or sections that apply to content from the Royalty (DLC). It adds a banner to indicate that the content of a section or an entire page is from the Royalty DLC. Provides a visual cue and acts as a link to the DLC's article.

It also adds the Category:Royalty to the page.

For inline use and similar small scale links, use {{RoyaltyIcon}} ().

Optional parameters

This template has no mandatory parameters.

First parameter

Setting the first parameter to any value (e.g. {{Royalty|No category}}) suppresses adding the page to the Royalty category. Any text will work, but "No category" is suggested for clarity's sake.

Include the 'No category' argument when marking a page that also includes core game content or when using the template for testing purposes.

"section" parameter

Setting this parameter to any value (e.g. {{Royalty|section = 1}}) will change the message from "article" to "section" and suppresses adding the page to the Royalty category.

Examples

{{Royalty}}

{{Royalty|section = 1}}

{{Royalty|No category}}

@@ Line 1: / Line 1: @@
 __NOTOC__
 == Description ==
-Adds a banner to indicate that the content of a section or an entire page is from the [[Royalty DLC]]. Provides a visual cue and acts as a link to the DLC's article.
+Place this template at the top of pages or sections that apply to content from the [[Royalty (DLC)]]. It adds a banner to indicate that the content of a section or an entire page is from the Royalty DLC. Provides a visual cue and acts as a link to the DLC's article.
-For inline use and similar small scale links, use [[Template:RoyaltyIcon|<nowiki>{{RoyaltyIcon}}</nowiki>]].
+It also adds the [[:Category:Royalty]] to the page.
-== Syntax ==
+For inline use and similar small scale links, use {{T|RoyaltyIcon}} ({{RoyaltyIcon}}).
-Type following at the top of the page or the beginning of a section.
-<code><nowiki>{{Royalty}}</nowiki></code>
+== Optional parameters ==
+This template has no mandatory parameters.
-'''Optional parameters'''
-<p>This template accepts one optional parameter that suppresses adding the page to the Royalty category.</p>
-<p>Any text will work, but "No category" is suggested for clarity's sake.</p>
-<code><nowiki>{{Royalty|No category}}</nowiki></code>
+=== First parameter ===
+Setting the first parameter to any value (e.g. <code><nowiki>{{Royalty|No category}}</nowiki></code>) suppresses adding the page to the Royalty category. Any text will work, but "No category" is suggested for clarity's sake.
-== Usage ==
+Include the 'No category' argument when marking a page that also includes core game content or when using the template for testing purposes.
-Use this template on pages or sections that apply to content from the Royalty DLC.
-Include the 'No category' argument when marking a section on a page that also includes core game content.
+=== "section" parameter ===
+Setting this parameter to any value (e.g. <code><nowiki>{{Royalty|section = 1}}</nowiki></code>) will change the message from "article" to "section" and suppresses adding the page to the Royalty category.
-== Sample output ==
+== Examples ==
 <code><nowiki>{{Royalty}}</nowiki></code>
-{{Royalty}}
+{{Royalty|No category}}
 <code><nowiki>{{Royalty|section = 1}}</nowiki></code>
@@ Line 31: / Line 27: @@
 <code><nowiki>{{Royalty|No category}}</nowiki></code>
 {{Royalty|No category}}
-<code><nowiki>{{Royalty|section = 1|No category}}</nowiki></code>
-{{Royalty|section = 1|No category}}
 == See also ==
-* [[Template:Ideology|<nowiki>{{Ideology}}</nowiki>]] for the equivalent template for the [[Ideology DLC]]
+* {{T|Biotech}} for the equivalent template for [[Biotech (DLC)]] {{BiotechIcon}}.
-* [[Template:Biotech|<nowiki>{{Biotech}}</nowiki>]] for the equivalent template for the [[Biotech DLC]]
+* {{T|Ideology}} for the equivalent template for [[Ideology (DLC)]] {{IdeologyIcon}}.
 <includeonly>[[Category:Notice templates]]</includeonly>
 <noinclude>[[Category:Template documentation]]</noinclude>