Difference between revisions of "Template:Merge/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(Created page with "Creates a banner noting that the page should be merged and automatically categorizes the page into Category:Pages to be merged. A merge candidate must be identified. ==...")
 
(updated)
Line 1: Line 1:
−
Creates a banner noting that the page should be merged and automatically categorizes the page into [[:Category:Pages to be merged]].
+
__NOTOC__
 +
== Description ==
 +
Creates a banner noting that the page or section should be merged and automatically categorizes the page into [[:Category:Pages to be merged]].
  
−
A merge candidate must be identified.
+
== Parameters ==
 +
This template has no mandatory parameters, it is however good practice to always provide the "''destination''" and "''reason''" parameter.
  
−
==Example Usage==
+
=== "destination" parameter ===
−
The template used with no arguments:
+
You should always provide the name of the page that the page or section should be merged with (e.g. <code><nowiki>{{Merge| destination = Template:Move}}</nowiki></code>). It doesn't matter if the page exists already.
−
<nowiki>{{merge}}</nowiki>
+
 
 +
=== "destination2" parameter ===
 +
You can also provide the name of a second page that the page or section should be merged with (e.g. <code><nowiki>{{Merge| destination = Template:Move | destination2 = Template:Split}}</nowiki></code>). It doesn't matter if the page exists already.
 +
 
 +
=== "reason" parameter ===
 +
You should always provide an explanation why you think the page should be merged and why with that particular destination - be it as obvious to you as it gets. This can be any text (e.g. <code><nowiki>{{Merge| destination = Template:Move | reason = Could be integrated into that page}}</nowiki></code>).
 +
 
 +
=== "section" parameter ===
 +
Setting this parameter to any value (e.g. <code><nowiki>{{Merge| section = 1}}</nowiki></code>) will change the message from "article" to "section".
 +
 
 +
=== "notoc" parameter ===
 +
Setting this parameter to ''true'' (e.g. <code><nowiki>{{Merge| nocat = true}}</nowiki></code>) suppresses adding the page to [[:Category:Pages to be merged]].
 +
 
 +
Include this parameter when using the template for testing purposes, like on this page.
 +
 
 +
== Examples ==
 +
The template can be used with no arguments:
 +
<pre>{{Merge}}</pre>
 
producing:
 
producing:
−
{{merge}}
+
{{Merge | nocat = true}}
  
−
Alternatively, a suggested destination can be given
+
As you can see, however, the template complains if you don't provide a ''destination'' and a ''reason''. You should therefore always provide them:
−
<nowiki>{{merge|destination=Template:Move}}</nowiki>
+
<pre>{{Merge| destination = Template:Move | reason = Could be integrated into that page}}</pre>
 
producing:
 
producing:
−
{{merge|destination=Template:Move}}
+
{{Merge| destination = Template:Move | reason = Could be integrated into that page | nocat = true}}
  
−
A reason for the suggested move can also be given
+
You can also provide a second destination:
−
<nowiki>{{merge|destination=Template:Move|reason=Could be integrated into that page}}</nowiki>
+
<pre>{{Merge| destination = Template:Move | destination2 = Template:Split | reason = Could be integrated into that page}}</pre>
 
producing:
 
producing:
−
{{merge|destination=Template:Move|reason=Could be integrated into that page}}
+
{{Merge| destination = Template:Move | destination2 = Template:Split | reason = Could be integrated into that page | nocat = true}}
 +
 
 +
A specific section can be designated for merging:
 +
<pre>{{Merge| destination = Template:Move | reason = Could be integrated into that page | section = 1}}</pre>
 +
producing:
 +
{{Merge| destination = Template:Move | reason = Could be integrated into that page | section = 1 | nocat = true}}
 +
 
 +
== See also ==
 +
=== Maintenance ===
 +
* Incomplete pages/sections:
 +
** {{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.
 +
** {{T|Split}} for marking pages or sections that should be split.
 +
* 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.
 +
 
 +
=== 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.
  
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Notice templates]]</includeonly>
 
<includeonly>[[Category:Notice templates]]</includeonly>

Revision as of 14:37, 14 December 2022

Description

Creates a banner noting that the page or section should be merged and automatically categorizes the page into Category:Pages to be merged.

Parameters

This template has no mandatory parameters, it is however good practice to always provide the "destination" and "reason" parameter.

"destination" parameter

You should always provide the name of the page that the page or section should be merged with (e.g. {{Merge| destination = Template:Move}}). It doesn't matter if the page exists already.

"destination2" parameter

You can also provide the name of a second page that the page or section should be merged with (e.g. {{Merge| destination = Template:Move | destination2 = Template:Split}}). It doesn't matter if the page exists already.

"reason" parameter

You should always provide an explanation why you think the page should be merged and why with that particular destination - be it as obvious to you as it gets. This can be any text (e.g. {{Merge| destination = Template:Move | reason = Could be integrated into that page}}).

"section" parameter

Setting this parameter to any value (e.g. {{Merge| section = 1}}) will change the message from "article" to "section".

"notoc" parameter

Setting this parameter to true (e.g. {{Merge| nocat = true}}) suppresses adding the page to Category:Pages to be merged.

Include this parameter when using the template for testing purposes, like on this page.

Examples

The template can be used with no arguments: 

{{Merge}}

producing:

Merge Caravans.png
This article is suggested to be merged with Please suggest a destination.
Reason: Please provide a reason.

As you can see, however, the template complains if you don't provide a destination and a reason. You should therefore always provide them: 

{{Merge| destination = Template:Move | reason = Could be integrated into that page}}

producing:

Merge Caravans.png
This article is suggested to be merged with Template:Move.
Reason: Could be integrated into that page

You can also provide a second destination: 

{{Merge| destination = Template:Move | destination2 = Template:Split | reason = Could be integrated into that page}}

producing:

Merge Caravans.png
This article is suggested to be merged with Template:Move and/or Template:Split.
Reason: Could be integrated into that page

A specific section can be designated for merging: 

{{Merge| destination = Template:Move | reason = Could be integrated into that page | section = 1}}

producing:

Merge Caravans.png
This section is suggested to be merged with Template:Move.
Reason: Could be integrated into that page

See also

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.
    • {{Split}} for marking pages or sections that should be split.
  • 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.

Content

Retrieved from "https://rimworldwiki.com/index.php?title=Template:Merge/doc&oldid=122443"