Difference between revisions of "Template:Infobox material/doc"

From Captain of Industry Wiki
Jump to: navigation, search
(break out type param into type 1/2, add state param to example)
m (Add a default value of {{{Name}}})
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Infobox material
{{Infobox material
| Name         = Cement
  | Name           = Construction Parts
| Image        =
   | Type1         = Crafted material
| Description   = Optional item description goes here. It can be as long or short as you like.
  | State         = Unit
| Type1         = Crafted material
  | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
| State         = Loose
  | Variants      = [[Construction Parts II]]<br>[[Construction Parts III]]<br>[[Construction Parts IV]]
| CreatedIn    = [[Rotary Kiln]]
| UsedIn        = [[Concrete Mixer]]
| TransportedBy = [[Flat Conveyor]]<br/>[[Pickup]]<br/>[[Large Truck]]
| StoredIn      = [[Unit Storage]]<br/>[[Shipyard]]
| StartingQty  = Sailor: 450<br/>Captain: 300<br/>Admiral: 300
}}
}}
Example usage:<pre>
 
{{Infobox material
== Usage and Parameters ==
| Name          = Cement
This is a template to show basic information of items. The template accepts the following parameters:
| Image        =      (if not the same as Name.png)
;Basic parameters
| Description   = Optional item description goes here. It can be as long or short as you like.
:*<code>Name</code>: Name of items. (Default: The name of the page.)
| Type1         = Crafted material
:*<code>Type1</code>, <code>Type2</code>: Types of items. It is used to categorize item in this wiki.
| State         = Loose
:*<code>State</code>: Loose, Fluid, Unit, Molten, or Virtual.
| CreatedIn     = [[Rotary Kiln]]
:*<code>Variants</code>: Variant of the items.
| UsedIn        = [[Concrete Mixer]]
;Parameters for transportation
| TransportedBy = [[Flat Conveyor]]<br/>[[Pickup]]<br/>[[Large Truck]]
:Buildings and vehicles for transporting are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
| StoredIn     = [[Unit Storage]]<br/>[[Shipyard]]
:*<code>TrackTransport</code>: Set no if tracks cannot transport the item (Default: yes).
| StartingQty   = Sailor: 450<br/>Captain: 300<br/>Admiral: 300
:*<code>TransportedBy</code>(rare):  Only if transport override is needed.
:*<code>OtherTransport</code>(rare): To add an extra transport to auto-generated list.
;Parameters for storage
:Buildings for storing are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
:*<code>StoredInShipyard</code>: Set no if the shipyard cannot store the items (Default: yes).
:*<code>StoredInCargoModules</code>: Set yes if cargo modules can store the items (Default: no).
:*<code>StoredIn</code>: Only if storage override is needed. Set to "None" to suppress the field.
:*<code>OtherStorage</code>(rare): To add an extra storage to auto-generated list.
;Parameters for buildings that creates/uses this item
:Buildings that create/use the item are automatically listed from the table made by [[Template:Recipe define]]. But, it should be added with the following parameters in some cases.
:*<code>CreatedIn</code>: To add an extra buildings to auto-generated list.
:*<code>UsedIn</code>: To add an extra buildings to auto-generated list.
;Miscellaneous parameters
:*<code>Radiation</code>: Radiation Level of the items.
:*<code>StartingQty</code>: The number of the items stored in the [[Shipyard]] on game start.  
:*<code>Image</code> (rare): Only if image override is needed.
:*<code>Description</code> (rare): To add an in-game description, though not currently implemented in-game.
 
== Categories set by this template ==
*[[:Category:Items]]: a category for all items applied this template
*Categories depending on <code>Type1</code> and <code>Type2</code>: example [[:Category:Natural resources]]
*[[:Category:Unit products]], [[:Category:Loose products]], [[:Category:Fluid products]], [[:Category:Molten products]], [[:Category:Virtual products]]
*[[:Category:Unstorable items]]: a category for items that cannot be stored any storage. (example {{infoicon|Steam (High)}})
*[[:Category:Items with unique transport or storage]]:
*:A category for maintenance of the wiki. It is applied items which "Transported by" or "Stored in" is overridden manually. If there are too many items in this category, the automatic assignment of these parameters by this template should be updated.
 
== Examples ==
;Example usage for standard item
{{markup|<nowiki>
  {{Infobox material
    | Name          = Electronics III
    | Type1         = Crafted material
    | State         = Unit
    | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
     | Variants      = [[Electronics]]<br>[[Electronics II]]
  }} </nowiki> |
  {{Infobox material
    | Name          = Electronics III
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
    | Variants      = [[Electronics]]<br>[[Electronics II]]
  }}
}}
;Example usage for items that tracks cannot transport or storage cannot store
{{markup|<nowiki>
  {{Infobox material
    | Name          = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn      = none
  }} </nowiki> |
  {{Infobox material
    | Name          = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn      = none
  }}
}}
;Example usage for items that the shipyard cannot store
{{markup|<nowiki>
  {{Infobox material
    | Name            = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }} </nowiki> |
  {{Infobox material
    | Name            = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }}
}}
;Example usage for items having Radiation Level
{{markup|<nowiki>
  {{Infobox material
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }} </nowiki> |
  {{Infobox material
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }}
}}
;Example usage for items stored in special storage
{{markup|<nowiki>
  {{Infobox material
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn        = [[Radioactive Waste Storage]]
  }} </nowiki> |
  {{Infobox material
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn         = [[Radioactive Waste Storage]]
  }}
}}
;Example usage for items stored in cargo modules
{{markup|<nowiki>
  {{Infobox material
    | Name                = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }} </nowiki> |
  {{Infobox material
    | Name                = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }}
}}
;Example usage for items created/used in non-production-machines
{{markup|<nowiki>
  {{Infobox material
    | Name            = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn          = Foo
   }} </nowiki> |
  {{Infobox material
    | Name            = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn          = Foo
  }}
}}
}}
</pre>
<includeonly>[[Category:Infobox templates|Material]]</includeonly><!--
<includeonly>[[Category:Infobox templates|Material]]</includeonly><!--
--><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
--><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 13:07, 22 May 2023

Usage and Parameters

This is a template to show basic information of items. The template accepts the following parameters:

Basic parameters
  • Name: Name of items. (Default: The name of the page.)
  • Type1, Type2: Types of items. It is used to categorize item in this wiki.
  • State: Loose, Fluid, Unit, Molten, or Virtual.
  • Variants: Variant of the items.
Parameters for transportation
Buildings and vehicles for transporting are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
  • TrackTransport: Set no if tracks cannot transport the item (Default: yes).
  • TransportedBy(rare): Only if transport override is needed.
  • OtherTransport(rare): To add an extra transport to auto-generated list.
Parameters for storage
Buildings for storing are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
  • StoredInShipyard: Set no if the shipyard cannot store the items (Default: yes).
  • StoredInCargoModules: Set yes if cargo modules can store the items (Default: no).
  • StoredIn: Only if storage override is needed. Set to "None" to suppress the field.
  • OtherStorage(rare): To add an extra storage to auto-generated list.
Parameters for buildings that creates/uses this item
Buildings that create/use the item are automatically listed from the table made by Template:Recipe define. But, it should be added with the following parameters in some cases.
  • CreatedIn: To add an extra buildings to auto-generated list.
  • UsedIn: To add an extra buildings to auto-generated list.
Miscellaneous parameters
  • Radiation: Radiation Level of the items.
  • StartingQty: The number of the items stored in the Shipyard on game start.
  • Image (rare): Only if image override is needed.
  • Description (rare): To add an in-game description, though not currently implemented in-game.

Categories set by this template

Examples

Example usage for standard item
Markup Renders as
  {{Infobox material
    | Name           = Electronics III
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
    | Variants       = [[Electronics]]<br>[[Electronics II]]
  }} 
Electronics III
Electronics III.png
TypeCrafted material
StateUnit
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inUnit Storage [IIIIIIV]
Shipyard
Created inAssembly (Robotic)
Assembly (Robotic) II
Used inAssembly (Robotic)
Assembly (Robotic) II
Maintenance III Depot
Starting amountSailor: 987
Captain: 654
Admiral: 321
VariantsElectronics
Electronics II
Example usage for items that tracks cannot transport or storage cannot store
Markup Renders as
  {{Infobox material
    | Name           = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn       = none
  }} 
Chilled Water
Chilled Water.png
StateFluid
Transported byPipe [IIIII]
Stored inNone
Created inWater Chiller
Used inNone
Example usage for items that the shipyard cannot store
Markup Renders as
  {{Infobox material
    | Name             = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }} 
Example usage for items having Radiation Level
Markup Renders as
  {{Infobox material
    | Name             = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }} 
Spent Fuel
Spent Fuel.png
TypeRadioactive waste
StateUnit
Radiation Level2
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inUnit Storage [IIIIIIV]
Shipyard
Created inNuclear Reactor
Nuclear Reactor II
Used inNuclear Reprocessing Plant
Example usage for items stored in special storage
Markup Renders as
  {{Infobox material
    | Name             = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn         = [[Radioactive Waste Storage]]
  }} 
Spent Fuel
Spent Fuel.png
TypeRadioactive waste
StateUnit
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inRadioactive Waste Storage
Created inNuclear Reactor
Nuclear Reactor II
Used inNuclear Reprocessing Plant
Example usage for items stored in cargo modules
Markup Renders as
  {{Infobox material
    | Name                 = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }} 
Uranium Ore
Uranium Ore.png
TypeNatural resources
StateLoose
Transported byU-shape Conveyor [IIIII]
PickupTruck
Haul Truck (Dump)
Stored inLoose Storage [IIIIIIV]
Shipyard
Loose Module (S) [ML]
Created inNone
Used inCrusher
Crusher (Large)
Example usage for items created/used in non-production-machines
Markup Renders as
  {{Infobox material
    | Name             = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn           = Foo
  }}