Template:Button: Difference between revisions

Hello, World!

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

This template is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This template provides a "clickable button" formatting style for text. This button is not clickable, and care should be taken when using it to avoid readers thinking the result may be. (It has an explanatory tooltip for users hovering over it, but that may not always be displayed, or only displayed after too long a delay, so that it may not show up to people trying to click it.)

If you need a clickable button, use {{Clickable button}}.

Usage

{{Button|text=button text}} produces button text
{{Button|text=button text|format=bold}} produces button text
{{Button|[[File:WikEd close.png]]|padTB=.1em|padLR=.1em}} produces File:WikEd close.png
{{Button|text=button text|bgcolor=#EEF|bgcolor2=#BBE}} produces button text
[[target title|{{Button|linked text}}]] produces linked text, and [https://en.wikipedia.org {{Button|linked text}}] for linked text. {{clickable button 2}} is more suitable for that purpose though.

Alternatively, {{Button|button text}} also produces button text

{{Key press}} – used to illustrate keystrokes, including key combinations (e.g. Ctrl+x)
{{Key top}} – produces a similar visual effect, but includes more symbols and does not directly support key combos (e.g. Template:Key top)
{{Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons

v · d · e Button templates

General button templates	{{Clickable button}} {{Clickable button 2}} {{Branded Button}} {{Button}} (not clickable) {{Blue button}} {{Mw button}}

WikiProject-specific buttons	Article Wizard button button2 button wizard {{Big Blue Button}} {{Big Red Button}} {{Big Cyan Button}} {{Big Green Button}} {{Big Lime Button}} {{Big Orange Button}} {{Big Turquoise Button}} {{Big Fuchsia Button}} {{Big Skyblue Button}} {{Big Purple Button}} {{AFC button}} {{Cleanup Button}}

* Category

#REDIRECT Template:Category link without namespace

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Template Example output Use

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Important!

To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"Never use ..."

Same as Template:Braces but in red

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"Only use ..."

Same as Template:Braces but in green

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"An emphatic phrase"

To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

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, Template:Braces should be used to ensure a noticeable distinction

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Template:Var serif

(see Template:Braces above)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

{{DEFAULTSORT:Y, X}}

To display wikicode variables and magic words as they would appear in code

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

|year=2008

To display template parameters with or without values

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

{{{title|alt}}}

To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with Template:Braces above

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

REDIRECT Template:Template journal parameter

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Template:Pvalue

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.

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

etc.

{{Template|1|2|...|10}}

To display a template call (with or without parameters and values) as code

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Page Template:Template journal inline/styles.css has no content.{{hatnoteLua error: expandTemplate: template "Template journal inline/arg" does not exist.}}

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

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"The <img>...</img> tags ..."

To render HTML elements ("tags") in prose

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"Ensure the alt= parameter ..."

To indicate text is source code. To nest other templates within Template:Braces, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes someMethod

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"FORTH has keyword Template:PreCode."

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

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

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

( or {{sxhl}} ) Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

"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 (<Template:Dcr>).

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For larger blocks of source code and other pre-formatted text

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

_{[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

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For block quotations (only – never for non-quotations)

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

_{[this is a block template]}

For indented blocks of material; visually identical to {{quote}} but without quote markup

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

user input

To indicate user input

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Ctrl+x

To indicate specific-keystroke input, including combinations

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Template:Key top

Similar; includes more symbols, but does not directly support combinations

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

Don't save

To indicate a button in a user interface

REDIRECT Template:Template link with bold

This page is a redirect. The following categories are used to track and monitor this redirect:

Error: missing redirect parameter (help).

When appropriate, protection levels are automatically sensed, described and categorized.

example output

To indicate sample or example output

The above documentation is transcluded from Template:Button/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Template:Button: Difference between revisions

Revision as of 09:23, 11 October 2022

Usage

See also