Template:Variants/doc

Purpose

This template provides a method to rapidly line variants of machines with the link

Usage

This template accepts the following parameters:

{{{1}}}: Common part of the machine name for all tiers, such as "Pipe" and "Boiler."

{{{2}}} - {{{8}}}: Remaining part of the machine's name, such as "II" and "Gas." If {{{2}}} is omitted or "auto", all variants of the machine will be listed.

{{{sep}}} (optional, rare): Specify separator. Default: •(•)

{{{skipunmarked}}} (optional, rare): If yes, the building whose name is an exact match as {{{1}}} (mostly tier 1)

This template requires the page of 1st tier of the machine in the wiki. Notably, all parameters are case-sensitive.

Example

• Standard usage
  • {{Variants|Pipe}} → Pipe [II•III]
  • {{Variants|Boiler}} → Boiler (Coal) [Gas•Electric]
  • {{Variants|Assembly}} → Assembly (Manual) [Electric•Electric II•Robotic•Robotic II]
  • {{Variants|Farm}} → Farm [Irrigated]
  • {{Variants|Maintenance Depot}} → Maintenance Depot [Basic•II•III]
  • {{Variants|Captain's Office}} → Captain's Office I [II]
• Specify variants manually
  • {{Variants|Research Lab|III|V}} → Research Lab [III•V]
  • {{Variants|Research Lab|III|V|skipunmarked=yes}} → Research Lab III [V]
  • {{Variants|Boiler|Coal|Gas}} → Boiler (Coal) [Gas]
• Specify format
  • {{Variants|Pipe|sep=,}} → Pipe [II, III]
• Error
  • {{Variants}} → Template Variants: parameter {{{1}}} is not provided.
  • {{Variants|Ipsum|II|III}} → Template Variants: the page of "Ipsum", "Ipsum II" or "Ipsum (II)" is not found in the wiki.

Details

Bracket Completion

The round brackets may be omitted if the entire parameter is covered by the brackets. For example, you can input "Gas" instead of "(Gas)." However, the brackets cannot be omitted if the parameter is covered partially such as "(Electric) II."

Name of 1st tier machine

This template searches the machine page in the wiki for choosing a format. If there is a page named {{{1}}}, it is considered as 1st tier of the machine. If there is a page named "{{{1}}} {{{2}}}" or "{{{1}}} ({{{2}}})", this name is considered as 1st tier of the machine.

Automatically listing variants

If the variants are named regularly by Roman numerals, the variants whose page exists on the wiki are listed. If the variants are irregularly named, the variants to be listed are defined in the code of this template.