Difference between revisions of "Template:Item"

From The Coppermind
Jump to navigation Jump to search
m
Line 5: Line 5:
 
{{#if:{{{type|}}} |{{row/kv| Type |{{{type}}} }}|}}
 
{{#if:{{{type|}}} |{{row/kv| Type |{{{type}}} }}|}}
   
{{#if:{{{abilities|}}} |{{row/kv| Abilities |{{{abilities}}} }}|}}
+
{{#if:{{{abilities|}}} |{{row/kv| Abilities |[[cat tag|items-with-abilities]] }}|}}
{{#if:{{{appearance|}}} |{{row/kv| Appearance |{{{appearance}}} }}|}}
+
{{#if:{{{appearance|}}} |{{row/kv| Appearance |[[cat tag|items-with-appearance]] }}|}}
{{#if:{{{magic|}}} |{{row/kv| Magic |{{{magic}}} }}|}}
+
{{#if:{{{magic|}}} |{{row/kv| Magic |[[cat tag|items-with-magic]] }}|}}
  +
{{#if:{{{function|}}} |{{row/kv| Function |{{{function}}} }}|}}
   
 
<!-- owner/creator/etc. -->
 
<!-- owner/creator/etc. -->
Line 27: Line 28:
 
-->[[Category: Objects and Materials]]<!--
 
-->[[Category: Objects and Materials]]<!--
   
world & universe parameters
 
 
-->{{#if:<!--
 
-->{{#if:<!--
 
-->{{{earth|}}}<!-- -->{{{world|}}}<!-- -->{{{'world|}}}<!-- -->{{{universe|}}}<!--
 
-->{{{earth|}}}<!-- -->{{{world|}}}<!-- -->{{{'world|}}}<!-- -->{{{universe|}}}<!--
Line 37: Line 37:
 
--></includeonly><noinclude>
 
--></includeonly><noinclude>
   
This template allows you to describe the many attributes of an inanimate object.
+
The ''{{t|item}}'' infobox template allows you to describe specific, and usually named inanimate objects.
   
  +
__TOC__
The parameter {{{world}}} will link to the page passed. {{{books}}} will need to be formatted manually. The {{{type}}} should probably use {{t|tag+}}. Parameters {{{abilities}}} {{{appearance}}} and {{{magic}}} can also be specified. The ownership of an object can be specified by {{{owner}}}, and if necessary the {{{creator}}} or {{{creators}}} parameters can specify distinct creators.
 
 
It automatically adds pages to [[:Category: Objects and Materials]]
 
   
  +
=== Template ===
 
<pre class=mw-code>
 
<pre class=mw-code>
 
{{item
 
{{item
 
|image=
 
|image=
 
|type=
 
|type=
  +
|function=
|abilities=
 
|appearance=
 
|magic=
 
 
|creator= / creators=
 
|creator= / creators=
 
|owner= / owners=
 
|owner= / owners=
 
|world=
 
|world=
  +
|universe=
 
|books=
 
|books=
 
}}
 
}}
 
</pre>
 
</pre>
  +
  +
=== Parameters ===
  +
Highlighted lines indicate '''mandatory''' parameters.
  +
On lines with multiple parameters (e.g. <code>|world= / earth=</code>) pick only the one most appropriate.
  +
  +
{{docs|title={{t|Item}} Parameters}}
  +
  +
<!-- ---------- -->
  +
<!-- ROW: image -->
  +
<!-- ---------- -->
  +
{{docs/image
  +
|eg=
  +
<code><nowiki>|image=Elhokar sunraiser.jpg</nowiki></code>
  +
}}
  +
  +
<!-- --------- -->
  +
<!-- ROW: type -->
  +
<!-- --------- -->
  +
{{docs/row/optional
  +
|param=type
  +
|desc=Use this to specify the type of item being described. Apply a category (ideally with {{t|tag+}}) if possible.
  +
|eg=
  +
<code><nowiki>|type={{tag+|Shardblade}}</nowiki></code><br>
  +
<code><nowiki>|type={{cat tag|Currencies|Currency}}</nowiki></code>
  +
<code><nowiki>|type=Dye</nowiki></code>
  +
}}
  +
  +
<!-- ------------- -->
  +
<!-- ROW: function -->
  +
<!-- ------------- -->
  +
{{docs/row/optional
  +
|param= function
  +
|desc= Use this to briefly describe the items function if the '''type''' parameter wasn't clear enough.
  +
|eg=
  +
<code><nowiki>|function=Indicates rank</nowiki></code>
  +
}}
  +
  +
<!-- ----------------------- -->
  +
<!-- ROW: creator / creators -->
  +
<!-- ----------------------- -->
  +
{{docs/row/optional
  +
|'param=<code>creator</code> <br><small>or</small><br> <code>creators</code>
  +
|desc= Use this to specify the item's creator(s).<br>
  +
<small>'''Note:''' <code>creator</code> automatically generates a link, but <code>creators</code> does not.</small>
  +
|eg=
  +
<code><nowiki>|creator=Ranette</nowiki></code><br>
  +
<code><nowiki>|creators=[[Forger]]s</nowiki></code>
  +
}}
  +
  +
<!-- ------------------- -->
  +
<!-- ROW: owner / owners -->
  +
<!-- ------------------- -->
  +
{{docs/row/optional
  +
|'param=<code>owner</code> <br><small>or</small><br> <code>owners</code>
  +
|desc= Use this to specify the item's ''current'' (or last known) owner(s).<br>
  +
<small>'''Note:''' <code>owner</code> automatically generates a link, but <code>owners</code> does not.</small>
  +
|eg=
  +
<code><nowiki>|owner=Wyrn</nowiki></code><br>
  +
<code><nowiki>|owners=[[Sand master]]s</nowiki></code>
  +
}}
  +
  +
<!-- ------------------ -->
  +
<!-- ROW: world / earth -->
  +
<!-- ------------------ -->
  +
{{docs/world}}
  +
  +
<!-- ------------- -->
  +
<!-- ROW: universe -->
  +
<!-- ------------- -->
  +
{{docs/universe}}
  +
  +
<!-- ---------- -->
  +
<!-- ROW: books -->
  +
<!-- ---------- -->
  +
{{docs/books}}
  +
  +
|}
  +
  +
  +
=== Categories & Tags ===
  +
Pages that make use of the ''{{t|item}}'' template will be added to [[:Category: Objects and Materials]].
  +
   
 
[[Category: Infoboxes]]
 
[[Category: Infoboxes]]

Revision as of 01:01, 26 December 2019

Item
Featured In {{{books}}}

The {{item}} infobox template allows you to describe specific, and usually named inanimate objects.

Template

{{item
|image=
|type=
|function=
|creator= / creators=
|owner= / owners=
|world=
|universe=
|books=
}}

Parameters

Highlighted lines indicate mandatory parameters. On lines with multiple parameters (e.g. |world= / earth=) pick only the one most appropriate.

Template:Docs/books
{{Item}} Parameters
Parameter Description Examples
image Use this to display a relevant image hosted on the Coppermind.

See Help:Infoboxes for further details.

|image=Elhokar sunraiser.jpg

type Use this to specify the type of item being described. Apply a category (ideally with {{tag+}}) if possible.

|type={{tag+|Shardblade}}
|type={{cat tag|Currencies|Currency}} |type=Dye

function Use this to briefly describe the items function if the type parameter wasn't clear enough.

|function=Indicates rank

creator
or
creators
Use this to specify the item's creator(s).

Note: creator automatically generates a link, but creators does not.

|creator=Ranette
|creators=[[Forger]]s

owner
or
owners
Use this to specify the item's current (or last known) owner(s).

Note: owner automatically generates a link, but owners does not.

|owner=Wyrn
|owners=[[Sand master]]s

world
or
earth
Use this to specify the planet where the item can be found.

Note: Automatically generates a link. To bypass this, use 'world.
See Help:Infoboxes for further details.

|world=Roshar
|earth=Reckoners
|'world=Mars

universe Use this to indicate the (connected) universe where the item can be found.

See Help: Infoboxes for further details.

|universe=[[Cosmere]]
|universe=[[Cytoverse]]
|universe=[[Wode]] [[State]]s
|universe=''Standalone''


Categories & Tags

Pages that make use of the {{item}} template will be added to Category: Objects and Materials.