Jump to content

Main menu Navigation ●Main page ●Contents ●Current events ●Random article ●About Wikipedia ●Contact us ●Donate Contribute ●Help ●Learn to edit ●Community portal ●Recent changes ●Upload file

●Create account ●Log in ●Create account ● Log in Pages for logged out editors learn more ●Contributions ●Talk

(Top) 1 Parameters 1.1 Unnamed (Positional) 2 Examples 3 See also 3.1 General-purpose formatting 3.2 Other formatting templates 3.3 With utility links

Template:Template link with subst

●Аԥсшәа ●العربية ●অসমীয়া ●Авар ●Azərbaycanca ●تۆرکجه ●বাংলা ●Башҡортса ●Беларуская ●भोजपुरी ●Bosanski ●Català ●Чӑвашла ●Chavacano de Zamboanga ●الدارجة ●Ελληνικά ●Esperanto ●فارسی ●Fiji Hindi ●Gàidhlig ●Galego ●ГӀалгӀай ●ગુજરાતી ●गोंयची कोंकणी / Gõychi Konknni ●Gungbe ●客家語/Hak-kâ-ngî ●한국어 ●Հայերեն ●हिन्दी ●Hrvatski ●Ilokano ●Bahasa Indonesia ●Íslenska ●Jawa ●ქართული ●Қазақша ●Kurdî ●Кыргызча ●Latina ●Latviešu ●Lietuvių ●मैथिली ●മലയാളം ●مصرى ●Bahasa Melayu ●閩東語 / Mìng-dĕ̤ng-ngṳ̄ ●Мокшень ●မြန်မာဘာသာ ●日本語 ●Norsk bokmål ●Олык марий ●Oʻzbekcha / ўзбекча ●ਪੰਜਾਬੀ ●पालि ●Русский ●संस्कृतम् ●Scots ●සිංහල ●Simple English ●سنڌي ●Slovenščina ●کوردی ●Српски / srpski ●Sunda ●Suomi ●Tagalog ●தமிழ் ●ၽႃႇသႃႇတႆး ●తెలుగు ●ไทย ●Тоҷикӣ ●ತುಳು ●Удмурт ●Українська ●اردو ●Tiếng Việt ●粵語 ●Zazaki ●中文 Edit links ●Template ●Talk ●Read ●View source ●View history Tools Actions ●Read ●View source ●View history General ●What links here ●Related changes ●Upload file ●Special pages ●Permanent link ●Page information ●Get shortened URL ●Download QR code ●Wikidata item Print/export ●Download as PDF ●Printable version In other projects ●Wikimedia Commons ●MediaWiki ●Meta-Wiki ●Wikispecies ●Wikibooks ●Wikidata ●Wikifunctions ●Wikinews ●Wikisource ●Wikiversity Appearance

From Wikipedia, the free encyclopedia (Redirected from Template:Tlsp)

Shortcuts

{{tls}}

This template uses Lua:

Module:Template link general (sandbox)

This template, often abbreviated as {{tls}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {{tj}}.

Parameters

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. If a row renders identically to a previous row, it means the current template does not support that option and {{tlg}} needs to be used instead.

Parameter	Action	Use with {{example}}	Default active
	Default (without accessory parameters)	{{subst:example}}
brace	Include braces as part of the template link	{{subst:example}}	{{tlw}}/{{tn}}
braceinside	Include innermost braces as part of the template link	{{subst:example}}
bold	Renders the template link/name in bold	{{subst:example}}	{{tlb}}, {{tlxb}}
code	Display output using HTML `<code>...</code>` tags (monospaced font)	`{{subst:example}}`	{{tlc}}, {{Template link expanded}}, etc.
italic	Display any parameters accompanying the template link/name in italics	{{subst:example\|param}}	{{tlxi}}
kbd	Display output using HTML `<kbd>...</kbd>` tags (monospaced font)	`{{subst:example}}`
nolink	Don't render the template name as a link	{{example}}	{{tlf}}, {{tnull}}
nowrap	Prevent the insertion of line breaks (word wrap) in the output	{{subst:example}}
nowrapname	Prevent word wrapping in the output of template name/link (parameters will wrap if needed)	{{subst:example}}
plaincode	Uses `<code style="border:none; background:transparent;">...</code>`	`{{subst:example}}`	{{tltss}}
subst	Include a subst: prefix before the template link/name	{{subst:example}}	{{tls}}, {{tlxs}}, etc
alttext=`[text]`	Replace `[text]` with the actual label to be displayed for the template link	{{subst:Other}}	{{tla}}
_show_result	Will also display the result of the template	{{subst:Min\|7\|-5}} → -5
_expand	Will add a link to the expanded template page	{{subst:Min\|7\|-5}} [1]

Unnamed (Positional)

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

Code	Output	Remarks
{{tls\|Banner}}	{{subst:Banner}}	Template:Banner does not exist. (Non-existent template is redlinked.)
{{tls\|Abc}}	{{subst:Abc}}	Template:Abc exists.
{{tls\|abC}}	{{subst:abC}}	Template names are case-sensitive
{{tls\|abc}}	{{subst:abc}}	(but the first letter is case-insensitive).
{{tls\|x0}}	{{subst:x0}}	no parameters
{{tls\|x1\|one}}	{{subst:x1\|one}}	one parameter
{{tls\|x2\|one\|two}}	{{subst:x2\|one\|two}}	two parameters
{{tls\|x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}	{{subst:x3\|1\|2\|3\|4\|5\|6\|7\|8\|9\|10}}	ten parameters
{{tls\|convert\|14\|m\|ftin\|abbr=out\|sp=us}}	{{subst:convert\|14\|m\|ftin\|abbr=out\|sp=us}}	Unlimited parameters, as one `<nowiki>...</nowiki>` string.
{{tls\|x2\|\|two\|\|}}	{{subst:x2\|two}}	Empty parameters are discarded.
{{tls\|x0\|code=on}}	`{{subst:x0}}`	<code> style
{{tls\|x0\|plaincode=on}}	`{{subst:x0}}`	plaincode style
{{tls\|x0\|kbd=on}}	`{{subst:x0}}`	<kbd> style
{{tls\|x0\|bold=on}}	{{subst:x0}}	bold link/name
{{tls\|x1\|one\|italic=on}}	{{subst:x1\|one}}	parameter(s) in italics
{{tls\|x0\|nolink=on}}	{{x0}}
{{tls\|x0\|subst=on}}	{{subst:x0}}
{{tls\|x0\|brace=on}}	{{subst:x0}}	all braces in link
{{tls\|x0\|braceinside=on}}	{{subst:x0}}	inside braces in link
{{tls\|x0\|alttext=x0 link}}	{{subst:x0 link}}
{{tls\|x0\|bold=on\|code=on\|brace=on}}	`{{subst:x0}}`	Combine multiple parameter settings.
{{tls\|abc\|{{spaces}}one{{spaces}}}}	{{subst:abc\| one }}	Using {{spaces}} before and after a parameter.
{{tls\|x2\|bold=on\|code=on\|one\|two}}	`{{subst:x2\|one\|two}}`	Can combine named and anonymous parameters ...
{{tls\|x2\|one\|two\|bold=on\|code=on}}	`{{subst:x2\|one\|two}}`	... in any order ...
{{tls\|x2\|one\|code=on\|two\|bold=on\|three}}	`{{subst:x2\|one\|two\|three}}`	... even intermixed ...
{{tls\|x2\|one\|code=on\|two\|bold=on\|three\|italic=on}}	`{{subst:x2\|one\|two\|three}}`	... with many configurations.
{{tls\|x1}}	{{subst:x1}}	= won't work
{{tls\|x1\|x=u}}	{{subst:x1\|x=u}}	`=` is okay
{{tls\|x1\|x=u}}	{{subst:x1\|x=u}}	`{{=}}` is okay (see Template:=)
{{tls\|x1\|x=u}}	{{subst:x1\|x=u}}	Sticky nowiki is okay.
{{tls\|x2\|3=two\|2=one}}	{{subst:x2\|one\|two}}	Right-to-left is okay
{{tls}}	tls	With no arguments, it emits the current page name without braces.
{{tls\|x2\|3=one\|4=two}}	{{subst:x2}}	Null parameter stops parsing.

Wrapping of long names (default)
Code	Output
{{tls\|long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}	{{subst:long template name that would wrap to new line\|this is a long value for the 1st parameter that would wrap}}

Wrapping of long names (`nowrap=on`)
Code	Output
{{tls\|nowrap=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}	{{subst:long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}

Wrapping of long names (`nowrapname=on`)
Code	Output
{{tls\|nowrapname=on\|long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}	{{subst:long template name that would wrap to new line\|long value for the 1st parameter that would wrap}}

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓	`{{tlg}}` options^{[note 1]} to achieve text style	Link style
Text style ↓	`{{tlg}}` options^{[note 1]} to achieve text style	Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
`{{tlg}}` options^{[note 1]} to achieve link style	—	DEFAULT	`nolink=yes`	`subst=yes`	`nolink=yes\|subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	{{tlg}}^{[note 1]} {{tl}} {{tlp\|1\|2\|...}}^{[note 2]} {{Template:tlu}}^{[note 3]}	{{tlf}}^{[note 2]} ^{<template link>}	{{subst:tls}} {{subst:Template:tlsu}}^{[note 3]}	{{subst:tlsf}}^{[note 2]} ^{<template link>}	{{tn}}	{{tla}}
`code`	`code=yes`	`{{tl2}}` `{{tlx}}` `{{Template:tlxu}}`^{[note 3]}	`{{tlc}}`^{[note 2]} ^{<template link>} `{{tnull}}`^{<template link>}	`{{subst:tlxs}}`	`{{subst:tlsc}}`^{[note 2]} ^{<template link>}	—
monospace	`plaincode=yes`^{[note 4]}	—		{{subst:tltss}}^{[note 5]}	—
`kbd`	`kbd=yes`^{[note 5]}	—		{{subst:tltss}}^{[note 5]}	—
bold	`bold=yes`	{{tlb}}	—
`bold+code`	`bold=yes\|code=yes`	`{{tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi}}`

^ ^a ^b ^c {{tlg}} is the most general template, allowing any combination of text style and/or link style options.

^ ^a ^b ^c ^d ^e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.

^ ^a ^b ^c Allows links to templates in any namespace.

^ {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.

^ ^a ^b Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
`{{Tj\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category =no\| lang =fr}} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category =no\| lang =fr}}	Same as above
`{{Tji\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`<syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{tln\|Hatnote}}`	Template:Hatnote	Produces a normal link to the template
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	`[[Template:Hatnote]]` `[[Template:Hatnote\|Hatnote]]`	Formats wikilink, with optional piped link text and blended suffix
`{{ml\|Example\|hello}}`	{{#invoke:Example\|hello}}	Counterpart to {{tl}} for linking to Lua modules
`{{mfl\|Example\|hello}}`	{{#invoke:Example\|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
`{{mlx\|Example\|hello}}`	`{{#invoke:Example\|hello}}`	Counterpart to {{tlx}} for linking to Lua modules
`{{ml-lua\|Module:Example\|hello}}`	`require('Module:Example')`	Link to Lua modules and built-in libraries, showing Lua code.
`{{para\|title\|<var>book title</var>}}`	`\|title=book title`	Formats template parameters for display, with or without values
`{{sclx\|LASTING}}`	`[[WP:LASTING]]`	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a `<code>...</code>` tag.
`{{tag\|ref}}` `{{xtag\|templatedata}}`	`<ref>...</ref>` `<templatedata>`	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
`{{dtl\|Ping project}}`	{{d:Ping project}}	Wikidata counterpart to {{tl}}
`{{pf\|if}}` `{{pf\|if\|{{{1}}}\|true\|false}}`	{{#if}} {{#if:{{{1}}}\|true\|false}}	Parser function equivalent to {{tl}}
`{{magic word\|uc:}}`	{{uc:}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example	Effect
`{{lt\|Hatnote}}`	Template:Hatnote (edit \| talk \| history \| links \| watch \| logs)
`{{lts\|Hatnote}}`	Template:Hatnote(edit talk links history)
`{{t links\|Hatnote}}`	{{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
`{{tfd links\|Hatnote}}`	Template:Hatnote (talk · history · transclusions · logs · subpages)
`{{tetl\|Hatnote}}`	{{Hatnote}} links talk edit
`{{tsetl\|Hatnote}}`	{{subst:Hatnote}} links talk edit
`{{ti\|Hatnote}}`	Template:Hatnote (talk · links · edit)
`{{tic\|Hatnote}}`	Template:Hatnote (talk links edit)
`{{tim\|Hatnote}}`	m:Template:Hatnote (backlinks edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (backlinks edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	{{Hatnote}} (t/l)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)

Semantic markup templates

Template	Example output	Use
{{strong}}	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}}	"Never use ..."	Same as {{strong}} but in red
{{stronggood}}	"Only use ..."	Same as {{strong}} but in green
{{em}}	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}}	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}}	`strIllustratePrefix`	(see {{var}} above)
{{tld}}	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
{{para}}	`\|year=2008`	To display template parameters with or without values
{{param}}	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}}	\|selfref=yes	To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
{{param value}}	`··2·blanks·fore·and·aft··`	To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc.	`{{Template\|1\|2\|...\|10}}`	To display a template call (with or without parameters and values) as code
{{tji}}	{{hatnote\|Hello\|selfref=yes\|category=no}}	To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}}	"The `<img>...</img>` tags ..."	To render HTML elements ("tags") in prose
{{code}}/{{codett}}	"Ensure the `alt=` parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`. {{codett}} differs only in styling: `someMethod` becomes `someMethod`
{{PreCode}}	"FORTH has keyword `?BRANCH`."	Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki}}	`{{small\|small text example}}`	To wrap example code in `<code><nowiki>...</nowiki></code>`
{{subst:kbdnowiki}}	`{{large\|large text example}}`	To wrap example code in `<kbd><nowiki>...</nowiki></kbd>`
{{syntaxhighlight}}	_{[this is a block template]}	( or `{{sxhl}}` ) Wrapper for `<syntaxhighlight>...</syntaxhighlight>`, but will wrap overflowing text
{{deprecated code}}	"Do not use `<blink>`."	( or `{{dc}}` ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The `{{dc2}}` variant uses strike-through (`<blink>`) while `{{dcr}}` uses red (`<blink>`).
{{pre}}	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
{{tj}}	_{[this is a block template]}	To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}	_{[this is a block template]}	For block quotations (only – never for non-quotations)
{{block indent}}	_{[this is a block template]}	For indented blocks of material; visually identical to `{{quote}}` but without quote markup
{{kbd}}	`user input`	To indicate user input
{{key press}}	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
{{key top}}	`Left shift`	Similar; includes more symbols, but does not directly support combinations
{{button}}	`Don't save`	To indicate a button in a user interface
{{samp}}	`example output`	To indicate sample or example output

The above documentationistranscluded from Template:Tlg/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Template_link_with_subst&oldid=989853227" Categories: ●Lua-based templates ●Internal template-link templates ●Wikitext typing-aid templates Hidden categories: ●Pages using deprecated source tags ●Wikipedia template-protected templates ●This page was last edited on 21 November 2020, at 12:06 (UTC). ●Text is available under the Creative Commons Attribution-ShareAlike License 4.0; additional terms may apply. By using this site, you agree to the Terms of Use and Privacy Policy. Wikipedia® is a registered trademark of the Wikimedia Foundation, Inc., a non-profit organization. ●Privacy policy ●About Wikipedia ●Disclaimers ●Contact Wikipedia ●Code of Conduct ●Developers ●Statistics ●Cookie statement ●Mobile view