THC Science

|

Template documentation[view] [edit] [history] [purge]

Usage

This template is for giving examples of template parameter source code (useful in template documentation and talk page discussions of template code).

It must have at least one or two parameters itself. The first parameter is the name of the example parameter to display (this may be empty, but it must be present). The second (optional) parameter is a value for the first example parameter; or, if the first parameter is empty, the second illustrates an example unnamed parameter (which in some cases may serve as a pre-defined parameter that takes no |=value after it, e.g. the |section in {{Refimprove|section}}).

Examples

Code	Result	Notes
{{para\|name}}	`\|name=`
{{para\|title\|The Oxford English Dictionary}}	`\|title=The Oxford English Dictionary`
{{para\|\|section}}	`\|section`	For unnamed parameters; note empty first parameter in the code
`{{para\|{{var\|parameter}}\|{{var\|value}}}}`	`\|parameter=value`

When using literal, pre-specified parameter names and values, simply provide them (as in the first through third examples above). When illustrating hypothetical/example parameter names, or variable or user-definable values, use something like {{var|parameter}} and/or {{var|value}} (as in the last example above).

Parameters

|1= or first unnamed parameter – the parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter (which, depending on the context, may serve as a valueless parameter name); e.g., {{para|section}} → |section
|2= or second unnamed parameter – the value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name), as illustrated above.
|plain=y (or any other value besides y) – removes the faint border and light-grey background, which may be useful in various situations. The border and text color are set to inherit, to use the colors of the surrounding text. This parameter cooperates with the two below, in that if either are used, the text will be colorized while the border and background will still be removed.
|mxt=y or |green=y – to apply the style (green text, but still monospaced as code) that would be applied by {{mxt}} ("monospaced example text"). This is so that {{para}} can be used inside a passage of {{mxt}} content without the <code> markup inside {{para}} overriding the color of {{mxt}}. This parameter cooperates with |plain= in applying the color but respecting the removal of border and background.
|!mxt=y or |red=y – same as above, but applies the red of {{!mxt}}, the "bad monospaced example text" template.
|style= – to apply arbitrary CSS style, for some specialized contextual purpose. Example: |style=background-color: Yellow;. Any color, background-color, or border specified here will override those provided by any of the above parameters, regardless of the order in which the parameters are given in the template. As this template uses a  element, only CSS that can apply to inline elements (not block elements) will work. Like the above parameters, it applies to the entire output.
- If you want to only style the parameter name and/or the value, just do so directly;
 e.g.: {{para|page|{{var|'''single''' page number}}}}, {{para|page'''''s'''''|{{var|page '''range''', or '''multiple''' individual pages, or both}}}}
 gives: |page=single page number, |pages=page range, or multiple individual pages, or both

TemplateData

Gives examples of template parameter source code

Template parameters[Edit template data]
Parameter		Description	Type	Status
Parameter name	`1`	The parameter name. Give this parameter as explicitly blank and just fill in parameter 2 when you want to show an unnamed parameter	String	suggested
Value name	`2`	The value name. When the first parameter is given but is blank, the second represents an unnamed parameter's value (or a valueless parameter name).	String	suggested
plain	`plain`	Removes the faint border and light-grey background	Boolean	optional
mxt	`mxt`	no description	Unknown	optional
green	`green`	no description	Unknown	optional
!mxt	`!mxt`	no description	Unknown	optional
red	`red`	no description	Unknown	optional
style	`style`	Apply arbitrary CSS style, for some specialized contextual purpose. Example background-color: Yellow;	Content	optional

{{Param}}, for markup of examples of parameter names as they would appear in MediaWiki source code of templates, e.g. {{param|foo}} gives: {{{foo}}}
{{Template journal parameter}}, for markup of examples of parameter names as they would appear in the {{tj}} and {{tji}} templates.
{{Tag|...|attribs}}, for markup of examples of HTML elements' attributes and values; e.g. {{tag|a|attribs=href=/demo.php|o}} gives: <a href=/demo.php>

General-purpose formatting

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 ... 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 ....

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)

[TlTfn1-1] {{tlg}} is the most general template, allowing any combination of text style and/or link style options.

[TlTfn2-2] Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.

[TlTfn3-3] Allows links to templates in any namespace.

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

[TlTfn5-5] Displays monospaced font using <span style="font-family:monospace;">...</span>.

[note 1]

[note 2]

[note 3]

[note 4]

[note 5]

Code	Result	Notes
{{para\|name}}	`\|name=`
{{para\|title\|The Oxford English Dictionary}}	`\|title=The Oxford English Dictionary`
{{para\|\|section}}	`\|section`	For unnamed parameters; note empty first parameter in the code
`{{para\|{{var\|parameter}}\|{{var\|value}}}}`	`\|parameter=value`

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

THC Science

Bringing Science to the Cannabis Conversation!

Trichome