Template:Variants manual/doc

Purpose

This template is designed as a subroutine of Template: Variants. This template works stand-alone, but this is unrecommended.

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."

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

{{{skipunmarked}}} (optional, rare): If yes, the building whose name is an exact match as {{{1}}} (mostly tier 1) will not be listed. See also an example.

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

The parameters work as the following instead of above when irregular = yes is specified.

{{{1}}}: The page name of 1st tire machine.

{{{2}}}: The name of 1st tire machine. Default value: {{{1}}}

{{{3}}}, {{{5}}}, {{{7}}}, ..., {{{15}}}: The page name of 2nd - 8th tire machine.

{{{4}}}, {{{6}}}, {{{8}}}, ..., {{{16}}}: The abbreviated name of 2nd - 8th tire machine. They ares shown in square brackets.

Example

• Basic
  • {{Variants manual|Pipe|II|III}} → Pipe [II•III]
  • {{Variants manual|Boiler|Coal|Gas|Electric}} → Boiler (Coal) [Gas•Electric]
  • {{Variants manual|Assembly|Manual|Electric|(Electric) II}} → Assembly (Manual) [Electric•Electric II]
  • {{Variants manual|Captain's Office}} → Captain's Office II
• Advanced
  • {{Variants manual|Pipe|II|III|sep=, }} → Pipe [II, III]
  • {{Variants manual|Loose Storage|III|IV|skipunmarked=yes}} → Loose Storage III [IV]

    cf. {{Variants manual|Loose Storage|III|IV}} → Loose Storage [III•IV]

  • {{Variants manual|irregular=yes|Farm|Farm|Irrigated Farm|Irrigated}} → Farm [Irrigated]
• Error
  • {{Variants manual}} → Template Variants: parameter {{{1}}} is not provided.
  • {{Variants manual|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.