Template:Clickable button 3/doc

From WWII Archives

< Template:Clickable button 3
Revision as of 14:12, 26 October 2022 by wc>Krinkle (http->https)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
File:Edit-copy green.svgThis is a documentation subpage for Template:Terminate sentence
It may contain usage information, categories and other content that is not part of the original template page.

This template generates a clickable button that is styled using the mediawiki.ui.button module.

Usage

{{Clickable button 3 |1= |2= |url= |class= |style= }}

Template parameters

ParameterDescriptionDefaultStatus
1targetLink target page. Becomes the title when used with urlemptyrequired
2labelButton labelTarget pageoptional
urlemptyoptional
classemptyoptional
styleemptyoptional
Button text
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

This template generates a clickable button that is styled using the mediawiki.ui.button module.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
target1

Link target page. Becomes the title when used with url

Page namerequired
label2

Button label

Default
Target page
Lineoptional
class

Unknownoptional
style

Unknownoptional
url

URLoptional

Additional information

The template is intended to be used in the following namespaces: unknown

The template is intended to be used by the following user groups: all users

Localization

This template is not intended to be localized.

Examples

This template generates a clickable button that is styled using the mediawiki.ui.button module. It can be used in the following ways,

  • Code: {{Clickable button 3|Main Page}}
  • Code: {{Clickable button 3|Main Page|Cover page}}
  • Code: {{Clickable button 3|Main Page|url=https://en.wikipedia.org}}
  • Code: {{Clickable button 3|label=Main Page|url=https://en.wikipedia.org}}
  • Code: {{Clickable button 3|Main Page|class=mw-ui-constructive}}
  • Code: {{Clickable button 3|Main Page|class=mw-ui-destructive}}
  • Code: {{Clickable button 3|Main Page|class=mw-ui-progressive}}
  • Code: {{Clickable button 3|Template:Clickable button 3/doc|class=mw-ui-progressive}} (link to current page becomes unclickable)


Retrieved from "https://wwii-archives.org/index.php?title=Template:Clickable_button_3/doc&oldid=2020"