Module:Tlx/doc
MyWikiBiz, Author Your Legacy — Saturday December 28, 2024
Jump to navigationJump to searchThis is the documentation page for Module:Tlx
Usage
{{#invoke:Tlx|function_name|SISTER=sister project name}}
Implements a version of {{tlx}}, {{tlxs}}, {{tlxb}}, {{tlxi}}, {{tlxc}}, and {{temt}}.
{{tlx}} and {{temt}} use the function name tlx
, {{tlxs}} uses tlxs
, {{tlxb}} uses tlxb
, {{tlxi}} uses tlxi
, and {{tlxs}} uses tlx
with Template:Para.
Generally, a call to this module can be placed at the front of a template call to display formatted code instead of the template output. For example, if this module is implemented at {{tlx/sandbox}}, a function call such as {{convert|1|m|disp=flip}}
can be displayed as formatted text using the code {{tlx/sandbox|convert|1|m|disp=flip}}
, which outputs Template:Tlx/sandbox.
This has the following caveats:
- Template:Para, Template:Para, and Template:Para are reserved for compatibility with the legacy {{tlx}} template. In order to display
{{x0|LANG=de|SISTER=wikt|subst=yes}}
you would need to use workarounds from the old template such as{{tlx/sandbox|x0|<nowiki>LANG=en</nowiki>|SISTER{{=}}wikt|4=subst=yes}}
to produce Template:Tlx/sandbox. - Parameters are presented in alphabetical order, starting with numbered parameters, regardless of input order.
{{tlx/sandbox|x0|z=y|x=w|a|b}}
displays Template:Tlx/sandbox - Since the Template:Para parameter is used for the template name, numbered parameters where the number is explicitly specified must be offset by one (as was true with the legacy {{tlx}} template):
{{tlx/sandbox|x0|2=first|3=second|4=third=***}}
produces Template:Tlx/sandbox.
- NOTE: you must be careful not to double-define a parameter.
{{tlx/sandbox|x0|first|2=second=**}}
will output Template:Tlx/sandbox (and generate a warning) since the2
parameter was defined twice. Use{{tlx/sandbox|x0|first|3=second=**}}
to display Template:Tlx/sandbox.
- NOTE: you must be careful not to double-define a parameter.
- To display the number of a numbered parameter explicitly, the same workarounds from the legacy template still work:
{{tlx/sandbox|x0|<nowiki>1=first</nowiki>|2{{=}}second|4=3=third}}
produces Template:Tlx/sandbox