Difference between revisions of "Template:Console/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(standardization)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
==Description==
+
== Description ==
−
Adds a banner to indicate that the content of a section or an entire page is from the [[Console edition]]. 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 [[console edition]]. It adds a banner to indicate that the content of a section or an entire page is from the console edition. Provides a visual cue and acts as a link to the console editions article.
  
−
For inline use and similar small scale links, use {{T|ConsoleIcon}}.
+
It also adds the [[:Category:Console edition]] to the page.
  
−
==Syntax==
+
For inline use and similar small scale links, use {{T|ConsoleIcon}} ({{ConsoleIcon}}).
−
Type following at the top of the page or the beginning of a section.
 
  
−
<code><nowiki>{{Console}}</nowiki></code>
+
== Optional parameters ==
 +
This template has no mandatory parameters.
  
 +
=== First parameter ===
 +
Setting the first parameter to any value (e.g. <code><nowiki>{{Console|No category}}</nowiki></code>) suppresses adding the page to the [[:Category:Console edition]]. 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>{{Console|No category}}</nowiki></code>
+
=== "section" parameter ===
 +
Setting this parameter to any value (e.g. <code><nowiki>{{Console|section = 1}}</nowiki></code>) will change the message from "page" to "section" and suppresses adding the page to the [[:Category:Console edition]].
  
−
==Usage==
+
== Examples ==
−
Use this template on pages or sections that apply to content from the Royalty DLC.
+
<code><nowiki>{{Console}}</nowiki></code>
 +
{{Console|No category}}
  
−
Include the 'No category' argument when marking a section on a page that also includes core game content.
+
<code><nowiki>{{Console|section = 1}}</nowiki></code>
 +
{{Console|section = 1}}
  
−
==Sample output==
+
<code><nowiki>{{Console|No category}}</nowiki></code>
−
Typing:
+
{{Console|No category}}
−
 
 
−
<code><nowiki>{{Console}}</nowiki></code>
 
  
−
Produces:
+
== See also ==
 +
=== Content ===
 +
* {{T|Biotech}} for marking content from [[Biotech (DLC)]] {{BiotechIcon}}.
 +
* {{T|Ideology}} for marking content from [[Ideology (DLC)]] {{IdeologyIcon}}.
 +
* {{T|Royalty}} for marking content from [[Royalty (DLC)]] {{RoyaltyIcon}}.
 +
* {{T|Console}} for marking  content from the [[console edition]] {{ConsoleIcon}}.
 +
* {{T|Spoiler}} for marking potential spoilers.
  
−
{{Console|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.
−
* [[Template: Royalty]] for the equivalent for the [[Royalty DLC]]
+
** {{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 outdated.
 +
** {{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>
 
<includeonly>[[Category:Notice templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 11:26, 2 November 2022

Description

Place this template at the top of pages or sections that apply to content from the console edition. It adds a banner to indicate that the content of a section or an entire page is from the console edition. Provides a visual cue and acts as a link to the console editions article.

It also adds the Category:Console edition to the page.

For inline use and similar small scale links, use {{ConsoleIcon}} (Content exclusively from the Console Edition).

Optional parameters

This template has no mandatory parameters.

First parameter

Setting the first parameter to any value (e.g. {{Console|No category}}) suppresses adding the page to the Category:Console edition. 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. {{Console|section = 1}}) will change the message from "page" to "section" and suppresses adding the page to the Category:Console edition.

Examples

{{Console}}

Console.png
This page relates to content present in the console edition. Please note that it will not be present in other versions.

{{Console|section = 1}}

Console.png
This section relates to content present in the console edition. Please note that it will not be present in other versions.

{{Console|No category}}

Console.png
This page relates to content present in the console edition. Please note that it will not be present in other versions.

See also

Content

Maintenance

  • 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 outdated.
    • {{Safe to delete}} for marking pages that are ready to be deleted.
    • {{SpeedyDelete}} for marking pages that should be deleted as fast as possible.
Retrieved from "https://rimworldwiki.com/index.php?title=Template:Console/doc&oldid=115504"