Template:Samps/doc
From The Blockheads Wiki
[refresh]
This is the documentation page. It should be transcluded into Template:Samps. See Template:Documentation for more information.- See also: Template:Code
This template is a simplified usage of <samp>...</samp>
, which is used mainly to format file names and the like.
Usage
Each anonymous parameter is a string to format. Note that <nowiki>...</nowiki>
is needed around a parameter value if it contains the pipe (|
) or equals (=
) symbols, or they will be treated as a parameter separator or parameter identifier, respectively. Alternatively, you could also use {{!}}
or {{=}}
instead.
Use the |delimiter=
parameter (aliases |delim=
or |d=
) to change the separator between each string. Set this value to the name in words of the delimiter, such as "and", "br", "or-list", "none", etc. When using a list delimiter, use |list-level=
to change the indentation (defaults to **
).
Examples
{{samps|text}}
– text{{samps|1|2|3|4|5}}
– 1 2 3 4 5{{samps|1|2|3|4|5|delimiter=,}}
– 1, 2, 3, 4, 5{{samps|1|2|3|4|5|delimiter=and}}
– 1, 2, 3, 4, and 5{{samps|<nowiki>something=one|two|three</nowiki>}}
– something=one|two|three{{samps|something{{=}}one{{!}}two{{!}}three}}
– something=one|two|three
See also
{{samp}}
, which supports attributes but can format only one string