Difference between revisions of "Template:Royalty/doc"

Latest revision as of 00:10, 14 March 2024

Description[edit]

Place this template at the top of pages or sections that apply to content from 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[edit]

This template has no mandatory parameters.

First parameter[edit]

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[edit]

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[edit]

{{Royalty}}

{{Royalty|section = 1}}

{{Royalty|No category}}

See also[edit]

Content[edit]

{{Royalty}} for marking content from Royalty (DLC) .
{{Ideology}} for marking content from Ideology (DLC) .
{{Biotech}} for marking content from Biotech (DLC) .
{{Anomaly}} for marking content from Anomaly (DLC) .
{{Console}} for marking content from the console edition .
{{Spoiler}} for marking potential spoilers.

Maintenance[edit]

Incomplete pages/sections:
- {{Documentation wanted}} for marking templates without documentation.
- {{Image wanted}} for marking pages or sections that are missing images.
- {{Stub}} for marking incomplete pages or sections.
Request major changes:
- {{Disambig}} for marking pages that are ambiguous.
- {{Merge}} for marking pages that should be merged.
- {{Move}} for marking pages or sections that should be moved.
- {{Rewrite}} for marking pages or sections that should be rewritten.
- {{Recode}} for marking templates or pages that need to be recoded.
Deletion:
- {{Delete}} for marking pages that should be deleted.
- {{Obsolete}} for marking pages that are no longer relevant to the current game version.
- {{Safe to delete}} for marking pages that are ready to be deleted.
- {{SpeedyDelete}} for marking pages that should be deleted as fast as possible.

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+== 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 [[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 {{T|RoyaltyIcon}}.
+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.
+=== 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.
-'''Optional parameters'''
+Include the 'No category' argument when marking a page that also includes core game content or when using the template for testing purposes.
-<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>
+=== "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.
-==Usage==
+== Examples ==
-Use this template on pages or sections that apply to content from the Royalty DLC.
+<code><nowiki>{{Royalty}}</nowiki></code>
+{{Royalty|No category}}
-Include the 'No category' argument when marking a section on a page that also includes core game content.
+<code><nowiki>{{Royalty|section = 1}}</nowiki></code>
+{{Royalty|section = 1}}
-==Sample output==
+<code><nowiki>{{Royalty|No category}}</nowiki></code>
-Typing:
+{{Royalty|No category}}
-<code><nowiki>{{Royalty}}</nowiki></code>
-Produces:
+== See also ==
+=== Content ===
+* {{T|Royalty}} for marking content from [[Royalty (DLC)]] {{RoyaltyIcon}}.
+* {{T|Ideology}} for marking content from [[Ideology (DLC)]] {{IdeologyIcon}}.
+* {{T|Biotech}} for marking content from [[Biotech (DLC)]] {{BiotechIcon}}.
+* {{T|Anomaly}} for marking content from [[Anomaly (DLC)]] {{AnomalyIcon}}.
+* {{T|Console}} for marking  content from the [[console edition]] {{ConsoleIcon}}.
+* {{T|Spoiler}} for marking potential spoilers.
-{{Royalty|No category}}
+=== Maintenance ===
-==See also==
+* Incomplete pages/sections:
-* [[Template: Ideology]] for the equivalent for the [[Ideology DLC]]
+** {{T|Documentation wanted}} for marking templates without documentation.
+** {{T|Image wanted}} for marking pages or sections that are missing images.
+** {{T|Stub}} for marking incomplete pages or sections.
+* Request major changes:
+** {{T|Disambig}} for marking pages that are ambiguous.
+** {{T|Merge}} for marking pages that should be merged.
+** {{T|Move}} for marking pages or sections that should be moved.
+** {{T|Rewrite}} for marking pages or sections that should be rewritten.
+** {{T|Recode}} for marking templates or pages that need to be recoded.
+* Deletion:
+** {{T|Delete}} for marking pages that should be deleted.
+** {{T|Obsolete}} for marking pages that are no longer relevant to the current game version.
+** {{T|Safe to delete}} for marking pages that are ready to be deleted.
+** {{T|SpeedyDelete}} for marking pages that should be deleted as fast as possible.
 <includeonly>[[Category:Notice templates]]</includeonly>
 <noinclude>[[Category:Template documentation]]</noinclude>