Wikipedia Easy Search

Hello, World!

This is the template sandbox page for Template:Button (diff).
See also the companion subpage for test cases.

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

This template is used on approximately 45,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Preview message: Transclusion count updated automatically (see documentation).

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

[edit]

{{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
{{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}} 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. ⇬ Caps Lock)
{{Kbd}} – to indicate user input (of any kind) without making it look like keys or buttons

v t e Button templates
General button templates	{{Clickable button}} {{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}} {{Big Yellow Button}} {{AFC button}} {{Cleanup Button}}
Category

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 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/sandbox

Usage

See also