Difference between revisions of "Template:Variants manual/doc"

From Captain of Industry Wiki
Jump to: navigation, search
m
m (Fixed typo)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
;Purpose
;Purpose
:This template is designed as a subroutine of [[Template: Variants]].  
:This template is designed as a subroutine of [[Template: Variants]]. This template works stand-alone, but this is unrecommended.


;Usage
;Usage
:This template accepts the following parameters:
:This template accepts the following parameters:
::<code>{{{1}}}</code>: Common part of the machine name for all tiers, such as Pipe and Boiler.
::<code>{{{1}}}</code>: Common part of the machine name for all tiers, such as "Pipe" and "Boiler."
::<code>{{{2}}}</code> - <code>{{{8}}}</code>: Remaining part of the machine's name, such as II and Gas
::<code>{{{2}}}</code> - <code>{{{8}}}</code>: Remaining part of the machine's name, such as "II" and "Gas."
::<code>{{{sep}}}</code> (optional, rare): Specify separator. Default: &amp;bull;(&bull;)
::<code>{{{skipunmarked}}}</code> (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.
: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 <code>irregular = yes</code> is specified.
:The parameters work as the following instead of above when <code>irregular = yes</code> is specified.
Line 14: Line 16:


;Example
;Example
* {{t|Variants manual|Pipe|II|III}} &rarr; {{Variants manual|Pipe|II|III}}
* Basic
* {{t|Variants manual|Boiler|Coal|Gas|Electric}} &rarr; {{Variants manual|Boiler|Coal|Gas|Electric}}
** {{t|Variants manual|Pipe|II|III}} &rarr; {{Variants manual|Pipe|II|III}}
* {{t|Variants manual|Assembly|Manual|Electric|(Electric) II|Robotic|(Robotic) II}} &rarr; {{Variants manual|Assembly|Manual|Electric|(Electric) II|Robotic|(Robotic) II}}
** {{t|Variants manual|Boiler|Coal|Gas|Electric}} &rarr; {{Variants manual|Boiler|Coal|Gas|Electric}}
* {{t|Variants manual|Captain's Office}} &rarr; {{Variants manual|Captain's Office}}
** {{t|Variants manual|Assembly|Manual|Electric|(Electric) II}} &rarr; {{Variants manual|Assembly|Manual|Electric|(Electric) II}}
* {{t|Variants manual|2=irregular=yes|3=Farm|4=Farm|5=Irrigated Farm|6=Irrigated}} &rarr; {{Variants manual|irregular=yes|Farm|Farm|Irrigated Farm|Irrigated}}
** {{t|Variants manual|Captain's Office}} &rarr; {{Variants manual|Captain's Office}}
* {{t|Variants manual}} &rarr; {{Variants manual}}
* Advanced
* {{t|Variants manual|Ipsum|II|III}} &rarr; {{Variants manual|Ipsum|II|III}}
** {{t|Variants manual|Pipe|II|III|sep&#x3D;,&amp;nbsp;}} &rarr; {{Variants manual|Pipe|II|III|sep=,&nbsp;}}
** {{t|Variants manual|Loose Storage|III|IV|skipunmarked&#x3D;yes}} &rarr; {{Variants manual|Loose Storage|III|IV|skipunmarked=yes}}
**:cf. {{t|Variants manual|Loose Storage|III|IV}} &rarr; {{Variants manual|Loose Storage|III|IV}}
** {{t|Variants manual|irregular&#x3D;yes|Farm|Farm|Irrigated Farm|Irrigated}} &rarr; {{Variants manual|irregular=yes|Farm|Farm|Irrigated Farm|Irrigated}}
* Error
** {{t|Variants manual}} &rarr; {{Variants manual}}
** {{t|Variants manual|Ipsum|II|III}} &rarr; {{Variants manual|Ipsum|II|III}}


;Details
;Details

Latest revision as of 08:54, 9 November 2022

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: &bull;(•)
{{{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
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.