Difference between revisions of "Template:Royalty/doc"

Revision as of 05:24, 27 January 2021

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.

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

Syntax

Type following at the top of the page or the beginning of a section.

{{Royalty}}

Optional parameters

This template accepts one optional parameter that suppresses adding the page to the Royalty category.

Any text will work, but "No category" is suggested for clarity's sake.

{{Royalty|No category}}

Usage

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.

Sample output

Typing:

{{Royalty}}

Produces:

@@ Line 1: / Line 1: @@
 __NOTOC__
-== Description ==
+==Description==
-Adds a banner to indicate that the content of an entire page or section is from the [[Royalty DLC]]. Provides both a visual cue and acts as a link to the DLC's article.
+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 the [[Template:RoyaltyIcon|<nowiki>{{RoyaltyIcon}}</nowiki>]]
+For inline use and similar small scale links, use {{T|RoyaltyIcon}}.
-== Usage ==
-Simply add the template to the top of the page or section required.
+==Syntax==
+Type following at the top of the page or the beginning of a section.
+ <nowiki>{{Royalty}}</nowiki>
+===Optional parameters===
+This template accepts one optional parameter that suppresses adding the page to the Royalty category.
+Any text will work, but "No category" is suggested for clarity's sake.
+ <nowiki>{{Royalty|No category}}</nowiki>
+==Usage==
+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.
+==Sample output==
+Typing:
   <nowiki>{{Royalty}}</nowiki>
 Produces:
-<includeonly>{{Royalty}}</includeonly>
+{{Royalty|No category}}
-Adding a argument to the template will suppress the category addition. Any argument will work, but "No Category" is suggested for clarities sake.
- <nowiki>{{Royalty|No Category}}</nowiki>
-<includeonly>{{Royalty|No Category}}</includeonly>
+<includeonly>[[Category:Notice templates]]</includeonly>
+<noinclude>[[Category:Template documentation]]</noinclude>