Template:Clickable button 3/doc: Difference between revisions

Latest revision as of 21:42, 3 September 2024

This template is used in system messages.

Changes to it can cause immediate changes to the Wikimedia 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.

Transclusion count: unknown

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Clickable button 3.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

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

Usage

Template parameters

Parameter	Description		Default	Status
`1`	target	Link target page. Becomes the title when used with url	empty	required
`2`	label	Button label	Target page	optional
`url`			empty	optional
`class`			empty	optional
`style`			empty	optional

Template data

Parameter text is empty

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.

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.
Parameter		Description	Type	Status
target	`1`	Link target page. Becomes the title when used with url	Page name	required
label	`2`	Button label Default Target page	Line	optional
	`class`		Unknown	optional
	`style`		Unknown	optional
	`url`		URL	optional

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

@@ Line 1: / Line 1: @@
+<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{used in system}}
+{{TemplateBox
+  |1        =1<!-- Name of the first parameter the template takes -->
+  |1label   =target<!-- A (very) brief name for the parameter. -->
+  |1d-en    =Link target page. Becomes the title when used with url<!-- English description of the first parameter the template takes -->
+  |1aliases =<!-- List of aliases, separated by / (a slash) -->
+  |1type    =wiki-page-name<!-- number, string, string/wiki-user-name, string/wiki-page-name, string/line; unknown -->
+  |1def     =<!-- default value for the parameter -->
+  |1stat    =required<!-- required, optional or optional-; optional- means it is optional and omitted in the usage-sample -->
+  |2        =2
+  |2label   =label
+  |2d-en    =Button label
+  |2aliases =
+  |2type    =line
+  |2def     =Target page
+  |2stat    =optional
+  |3        =url
+  |3label   =
+  |3d-en    =
+  |3d-td    =
+  |3aliases =
+  |3type    =url
+  |3def     =
+  |3stat    =optional
+  |4        =class
+  |4label   =
+  |4d-en    =
+  |4d-td    =
+  |4aliases =
+  |4type    =
+  |4def     =
+  |4stat    =optional
+  |5        =style
+  |5label   =
+  |5d-en    =
+  |5d-td    =
+  |5aliases =
+  |5type    =
+  |5def     =
+  |5stat    =optional
+  |name               =Clickable button 3
+  |desc-en            =This template generates a clickable button that is styled using the mediawiki.ui.button module.
+  |desc-fr            =Ce modèle permet de génerer un bouton cliquable qui utilise le style de mediawiki.ui.button module.
+  |namespace          =any
+  |usergroup          =all
+  |placement          =
+  |example-value      =
+  |mustbesubst        =
+  |relieson           =
+  |usage-notes        =
+  |shorthand          =
+  |setscats           =
+  |seealso            =
+  |type               =
+  |i18n-desc          =
+  |i18n-subpage       =
+  |i18n-mediawiki-msg =
+  |i18n-method        =-
+  |example            =
+  |print              =
+  |useTemplateData    =1
+}}
+== Examples ==
 This template generates a clickable button that is styled using the mediawiki.ui.button module. It can be used in the following ways,
@@ Line 5: / Line 75: @@
 *'''Code: '''<code><nowiki>{{Clickable button 3|Main Page|Cover page}}</nowiki></code>
 **'''Result: '''{{Clickable button 3|Main Page|Cover page}}
-*'''Code: '''<code><nowiki>{{Clickable button 3|Main Page|url=http://en.wikipedia.org}}</nowiki></code>
+*'''Code: '''<code><nowiki>{{Clickable button 3|Main Page|url=https://en.wikipedia.org}}</nowiki></code>
-**'''Result: '''{{Clickable button 3|Main Page|url=http://en.wikipedia.org}}
+**'''Result: '''{{Clickable button 3|Main Page|url=https://en.wikipedia.org}}
+*'''Code: '''<code><nowiki>{{Clickable button 3|label=Main Page|url=https://en.wikipedia.org}}</nowiki></code>
+**'''Result: '''{{Clickable button 3|label=Main Page|url=https://en.wikipedia.org}}
 *'''Code: '''<code><nowiki>{{Clickable button 3|Main Page|class=mw-ui-constructive}}</nowiki></code>
 **'''Result: '''{{Clickable button 3|Main Page|class=mw-ui-constructive}}
@@ Line 13: / Line 85: @@
 *'''Code: '''<code><nowiki>{{Clickable button 3|Main Page|class=mw-ui-progressive}}</nowiki></code>
 **'''Result: '''{{Clickable button 3|Main Page|class=mw-ui-progressive}}
+*'''Code: '''<code><nowiki>{{Clickable button 3|</nowiki>{{FULLPAGENAME}}<nowiki>|class=mw-ui-progressive}}</nowiki></code> (link to current page becomes unclickable)
+**'''Result: '''{{Clickable button 3|{{FULLPAGENAME}}|class=mw-ui-progressive}}
+<includeonly>{{Sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
+[[Category:Formatting templates]]
+}}</includeonly>

2604:3d08:9476:be00:190e:abe1:77b4:9f05 (talk)