Difference between revisions of "Template:Move/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(Adding documentation. See reason for removing deletion tag on main page)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
== Description ==
 
Creates a banner noting that the page should be moved and automatically categorizes the page into [[:Category:Pages to be moved]].
 
Creates a banner noting that the page should be moved and automatically categorizes the page into [[:Category:Pages to be moved]].
  
−
==Example Usage==
+
== 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 where the page should be moved to (e.g. <code><nowiki>{{Move| destination = Trees}}</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 moved and why to that particular destination - be it as obvious to you as it gets. This can be any text (e.g. <code><nowiki>{{Move| reason = I hope we can all agree that ''Treees'' is spelled ''Trees'' and should therefore be moved to that page}}</nowiki></code>).
 +
 
 +
=== "section" parameter ===
 +
Setting this parameter to any value (e.g. <code><nowiki>{{Move| section = 1}}</nowiki></code>) will change the message from "article" to "section".
 +
 
 +
=== "nocat" parameter ===
 +
Setting this parameter to ''true'' (e.g. <code><nowiki>{{Move| nocat = true}}</nowiki></code>) suppresses adding the page to [[:Category:Pages to be moved]].
 +
 
 +
Include this parameter when using the template for testing purposes, like on this page.
 +
 
 +
== Examples ==
 
The template can be used with no arguments:
 
The template can be used with no arguments:
−
<nowiki>{{Move}}</nowiki>
+
<pre>{{Move}}</pre>
 
producing:
 
producing:
−
{{Move}}
+
{{Move| nocat = true}}
−
Alternatively, a suggested destination can be given
+
 
−
<nowiki>{{Move|destination=Other Page}}</nowiki>
+
As you can see the template complains if you don't provide a ''destination'' and a ''reason''. You should therefore always provide them:
 +
<pre>{{Move| destination = Trees | reason = I hope we can all agree that ''Treees'' is spelled ''Trees'' and should therefore be moved to that page}}</pre>
 
producing:
 
producing:
−
{{Move|destination=Other Page}}
+
{{Move| destination = Trees | reason = I hope we can all agree that ''Treees'' is spelled ''Trees'' and should therefore be moved to that page | nocat = true}}
−
A reason for the suggested move can also be given
+
 
−
<nowiki>{{Move|reason=The Other Page makes this redundant}}</nowiki>
+
A specific section can be designated for moving:
 +
<pre>{{Move| destination = Trees | reason = This section should be its own page | section = 1 }}</pre>
 
producing:
 
producing:
−
{{Move|reason=The Other Page makes this redundant}}
+
{{Move| destination = Trees | reason = This section should be its own page | section = 1 | nocat = true}}
−
Both arguments can also be combined.
+
 
−
Alternatively, a suggested destination can be given
+
== See also ==
−
<nowiki>{{Move|destination=Other Page|reason=The Other Page makes this redundant}}</nowiki>
+
=== Maintenance ===
−
producing:
+
* Incomplete pages/sections:
−
{{Move|destination=Other Page|reason=The Other Page makes this redundant}}
+
** {{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.
 +
 
 +
=== 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>
 +
<includeonly>[[Category:Notice templates]]</includeonly>

Latest revision as of 02:27, 14 February 2023

Description[edit]

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

Parameters[edit]

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

"destination" parameter[edit]

You should always provide the name of the page where the page should be moved to (e.g. {{Move| destination = Trees}})). It doesn't matter if the page exists already.

"reason" parameter[edit]

You should always provide an explanation why you think the page should be moved and why to that particular destination - be it as obvious to you as it gets. This can be any text (e.g. {{Move| reason = I hope we can all agree that ''Treees'' is spelled ''Trees'' and should therefore be moved to that page}}).

"section" parameter[edit]

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

"nocat" parameter[edit]

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

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

Examples[edit]

The template can be used with no arguments: 

{{Move}}

producing:

Form Caravan.png
This page is suggested to be moved. Destination: Please suggest a target page. Reason: Please provide a reason .

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

{{Move| destination = Trees | reason = I hope we can all agree that ''Treees'' is spelled ''Trees'' and should therefore be moved to that page}}

producing:

Form Caravan.png
This page is suggested to be moved. Destination: Trees. Reason: I hope we can all agree that Treees is spelled Trees and should therefore be moved to that page.

A specific section can be designated for moving: 

{{Move| destination = Trees | reason = This section should be its own page | section = 1 }}

producing:

Form Caravan.png
This section is suggested to be moved. Destination: Trees. Reason: This section should be its own page.

See also[edit]

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.

Content[edit]

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