Difference between revisions of "Template:Image wanted/doc"

From RimWorld Wiki
Jump to navigation Jump to search
(→‎Example: Template link instead of copy-paste template code)
(rewritten)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
==Description==
+
__NOTOC__
−
This template is used to mark pages that need additional images to make the article better, categorizing them in [[:Category:Needs Pictures]].
+
== Description ==
 +
This template is used to mark pages that need additional images to make the article better, categorizing them in [[:Category:Pages that need images]].
  
−
==Syntax==
+
== Parameters ==
−
Type <code>{{t|NeedsPictures}}</code> on the page to be marked.
+
This template has no mandatory parameters, it is however good practice to always provide the "''reason''" or "''note''" parameter.
  
−
==Example==
+
=== "destination" parameter ===
−
{{NeedsPictures}}
+
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.
−
<includeonly>[[Category:Templates]][[Category:Template Infobox]]</includeonly>
+
 
−
<noinclude>[[Category:Template Documentation]]</noinclude>
+
=== "reason" or "note" parameter ===
 +
You should always provide an explanation what images are missing or are in need of updating - be it as obvious to you as it gets. This can be any text. You can use either "''reason''" or "''note''"(e.g. <code><nowiki>{{Move| reason = Add picture showing proper orientation of a cooler for freezer storage}}</nowiki></code> or <code><nowiki>{{Move| note = Add picture showing proper orientation of a cooler for freezer storage}}</nowiki></code>), the former is prefered, as it is more consistant with other notice templates.
 +
 
 +
=== "section" parameter ===
 +
Setting this parameter to any value (e.g. <code><nowiki>{{Move| section = 1}}</nowiki></code>) will change the message from "page" to "section".
 +
 
 +
=== "notoc" parameter ===
 +
Setting this parameter to ''true'' (e.g. <code><nowiki>{{Move| nocat = true}}</nowiki></code>) suppresses adding the page to [[:Category:Pages that need images]].
 +
 
 +
Include this parameter when using the template for testing purposes, like on this page.
 +
 
 +
== Examples ==
 +
The template can be used with no arguments:
 +
<pre>{{Image wanted}}</pre>
 +
producing:
 +
{{Image wanted| nocat = true}}
 +
 
 +
As you can see the template complains if you don't provide a ''reason'' or ''note''. You should therefore always provide one of them:
 +
<pre>{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage}}</pre>
 +
producing:
 +
{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage | nocat = true}}
 +
 
 +
A specific section can be designated for missing images:
 +
<pre>{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage | section = 1 }}</pre>
 +
producing:
 +
{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage | 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.
 +
* 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 12:25, 2 November 2022

Description[edit]

This template is used to mark pages that need additional images to make the article better, categorizing them in Category:Pages that need images.

Parameters[edit]

This template has no mandatory parameters, it is however good practice to always provide the "reason" or "note" 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" or "note" parameter[edit]

You should always provide an explanation what images are missing or are in need of updating - be it as obvious to you as it gets. This can be any text. You can use either "reason" or "note"(e.g. {{Move| reason = Add picture showing proper orientation of a cooler for freezer storage}} or {{Move| note = Add picture showing proper orientation of a cooler for freezer storage}}), the former is prefered, as it is more consistant with other notice templates.

"section" parameter[edit]

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

"notoc" parameter[edit]

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

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

Examples[edit]

The template can be used with no arguments: 

{{Image wanted}}

producing:

Blindness.png
This page could use some more or updated images. You can help RimWorld Wiki by uploading images to make this page better. Note: Please provide a note or a reason .

As you can see the template complains if you don't provide a reason or note. You should therefore always provide one of them: 

{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage}}

producing:

Blindness.png
This page could use some more or updated images. You can help RimWorld Wiki by uploading images to make this page better. Note: Add picture showing proper orientation of a cooler for freezer storage.

A specific section can be designated for missing images: 

{{Image wanted| reason = Add picture showing proper orientation of a cooler for freezer storage | section = 1 }}

producing:

Blindness.png
This section could use some more or updated images. You can help RimWorld Wiki by uploading images to make this section better. Note: Add picture showing proper orientation of a cooler for freezer storage.

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:Image_wanted/doc&oldid=115535"