Template:Button/doc View history

(Created doc page)
 
m (add templatedata)
 
(One intermediate revision by the same user not shown)
Line 10: Line 10:
* {{tlx|1=Button|2=<nowiki>[[File:WikEd close.png]]</nowiki>|3=padTB=.1em|4=padLR=.1em}} produces {{Button|[[File:CloseSquare.png]]|padTB=.1em|padLR=.1em}}
* {{tlx|1=Button|2=<nowiki>[[File:WikEd close.png]]</nowiki>|3=padTB=.1em|4=padLR=.1em}} produces {{Button|[[File:CloseSquare.png]]|padTB=.1em|padLR=.1em}}
Alternatively, {{tlx|1=Button|2=button&nbsp;text}} also produces {{Button|button text}}
Alternatively, {{tlx|1=Button|2=button&nbsp;text}} also produces {{Button|button text}}
== Parameters ==
This template will accept the following parameters, all are optional except for the text which does not need to be named.
* {{para|text|button text}} This is the text that will be shown in the button. This can also be used with the name as shown above by simply adding {{para||button text}}
* {{para|padTB|.1em}} Set the padding for the top and bottom in em units
* {{para|padLR|.1em}} Set the padding for the sides in em units
* {{para|bgcolor}} Set the background color of the button
* {{para|fomat|bold}} Use this to make the button text bold
* {{para|style}} Use to add any CSS style codes


== See also ==
== See also ==
Line 20: Line 29:


</includeonly>
</includeonly>
<templatedata>
{
"params": {
"1": {
"label": "alternate method to add text to the button",
"type": "string",
"suggested": true
},
"padTB": {
"label": "vertical padding in em units"
},
"padLR": {
"label": "horizontal (side) padding in em units"
},
"bgcolor": {
"label": "background color",
"type": "string"
},
"format": {
"label": "use this to make text bold",
"type": "boolean",
"default": "bold"
},
"style": {
"label": "CSS style codes",
"type": "string"
},
"text": {
"label": "the text in the button",
"type": "string",
"suggested": true
}
},
"description": "Add a non-functioning button to a page as an illustration",
"paramOrder": [
"text",
"1",
"bgcolor",
"format",
"padTB",
"padLR",
"style"
]
}
</templatedata>

Latest revision as of 16:37, 5 July 2017

This is a documentation subpage for Template:Button.
It contains usage information, categories and other content that is not part of the original template page.

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 [[|Click here]]
  • {{Button|text=button text|format=bold}} produces [[|Click here]]
  • {{Button|[[File:WikEd close.png]]|padTB=.1em|padLR=.1em}} produces [[|]]

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


Parameters

This template will accept the following parameters, all are optional except for the text which does not need to be named.

  • |text=button text This is the text that will be shown in the button. This can also be used with the name as shown above by simply adding |button text
  • |padTB=.1em Set the padding for the top and bottom in em units
  • |padLR=.1em Set the padding for the sides in em units
  • |bgcolor= Set the background color of the button
  • |fomat=bold Use this to make the button text bold
  • |style= Use to add any CSS style codes

See also

  • {{key press}} – used to illustrate keystrokes


Add a non-functioning button to a page as an illustration

Template parameters

ParameterDescriptionTypeStatus
the text in the buttontext

no description

Stringsuggested
alternate method to add text to the button1

no description

Stringsuggested
background colorbgcolor

no description

Stringoptional
use this to make text boldformat

no description

Default
bold
Booleanoptional
vertical padding in em unitspadTB

no description

Unknownoptional
horizontal (side) padding in em unitspadLR

no description

Unknownoptional
CSS style codesstyle

no description

Stringoptional