Module:Sandbox/BrandonXLF/1/doc: Difference between revisions

Revision as of 18:04, 23 June 2020

Latest revision as of 01:28, 4 May 2023

(9 intermediate revisions by the same user not shown)

Line 1:

{{notice|Please do not delete this module or its doc page.}}

DO NOT DELETE

== Parameters ==

[[Module:Call]] calls a template while giving it all the arguments the current page receives. It is meant to be used in the template namespace and will only work in other namespaces if the page it's being used on is transcluded on another page.

<code>''(floor#)''</code> - Sets the name of a floor

<code>''(floor#)''_''(part#)''_''(param)''</code> - Sets a parameter for a row of a floor where <code>''(param)''</code> is:

== Usage ==

* <code>name</code> - The name of the row, e.g. "Westbound track"

There are two ways of using the module, using the <code>default</code> function and using the <code>force</code> function.

* <code>desc</code> - The description for the row

* '''Services'''

=== Set '''default''' values for parameters ===

** <code>dir</code> - The direction of the service(s) for the track (<code>right</code> or <code>left</code>)

<code>{{((}}#invoke:call{{!}}default{{!}}_=''template''{{))}}</code>

** <code>service</code> - The service running on the track

** <code>service''(service#)''</code> - Additional services running on the track

When using the <code>default</code> function, parameters supplied to the <code>#invoke</code> call will be overridden by parameters sent to the template calling this module.

** <code>dest</code> - The destination for the service

** <code>dest''(service#)''</code> - Destinations for the additional services

=== Set '''forced''' values for parameters ===

** <code>note</code> - Note about the services

<code>{{((}}#invoke:call{{!}}force{{!}}_=''template''{{))}}</code>

** <code>note''(service#)''</code> - Notes about the additional services

* '''Platform'''

When using the <code>force</code> function, parameters supplied to the <code>#invoke</code> call will override parameters sent to the template calling this module.

** <code>platform</code> - The type of platform

** <code>accessible</code> - Set if the platform is {{access icon|alt=}} [[accessible]]

** <code>note</code> - Note about the platform