Template:Calculator button/doc

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

Creates a button for use with {{Calculator}} widgets. Requires the calculator gadget to be enabled.

Upon clicking a button, the button evaluates its formula parameter and inserts the results into the field identified by the for parameter. You can separate multiple for/formula with a semicolon.

For example:

{{calculator button|contents=Add 1|for=x|formula=x+1|type=plain}}. X = {{calculator|type=plain|id=x|default=0}}

Creates

The contents of a button should only contain non-interactive phrasing content (No links, no <div>. Images are ok)

If the delay parameter is set, then the button will repeat every that many seconds. It will repeat until the max iterations parameter is reached or otherwise forever. There is only one button allowed to repeat at a time, so starting one repeating button cancels all other repeating buttons within a calculator container. If the toggle parameter is set then clicking the button a second time stops the iteration. The until parameter can be used to stop the iterations once some formula is true.

You can also use the functions timertime(), timer() timeriterations() in formulas to get information about the current repeating button.

{{calculator button
|id=buttoncount
|type=progressive
|contents=
	{{calculator
		|type=plain
		|formula=timer()
		|mapping={"Start counting":0,"Stop counting": 1}
		|default=Start counting
	}}
|for=y
|formula=y+1
|delay=0.5  <!-- Update every half a second -->
|toggle=1 <!-- Stop counting if we click again -->
|max iterations=40 <!-- Stop if we reach 40. If this is unspecified we'd go forever. -->
}}. I counted up to {{calculator|type=plain|id=y|default=0}} in total. I have been counting for {{calculator|type=plain|formula=timertime(buttoncount)|default=?}} seconds since my last break.

Makes:

Start counting. I counted up to 0 in total. I have been counting for ? seconds since my last break.

There are many different types of buttons you can make. For codex style buttons, see [1] for best practice on how to use them. Note, the value default refers to the codex "default" styles, it is not the default option. The style of plain buttons may vary between different skins and operating systems.

There is also support for size parameter that takes "medium" or "large". Medium is recommended unless the button is only a small icon. There is an alt parameter to provide alt text for screen readers. However you should only use it if the text contents of the button don't explain its purpose. Most of the time it is better to just make the button contents descriptive.