Template:Purge button/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

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

العربية ∙ 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 ∙ 简体中文 ∙ 繁體中文 ∙ +/−

No description yet available.

Usage

{{Purge button}}

Template parameters

ParameterDescriptionDefaultStatus
1positionHorizontal position on page; “left”, “center” or “right”rightoptional
pagepage titleThe title of the page to be purged{{FULLPAGENAME}}optional
iconsizeicon sizeSize of the icon picture in pixels64optional
textstyletext styleAdditional CSS style for the link textemptyoptional
 Parameter text is empty
<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.

Wikipedia's help about TemplateData • Commons-specific information

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
position1

Horizontal position on page; “left”, “center” or “right”

Default
right
Lineoptional
icon sizeiconsize

Size of the icon picture in pixels

Default
64
Numberoptional
page titlepage

The title of the page to be purged

Default
{{FULLPAGENAME}}
Page nameoptional
text styletextstyle

Additional CSS style for the link text

Lineoptional

Additional information

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

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

Placement: At the top of the page

See also

Localization

This template is not intended to be localized.

Retrieved from "https://commons.wikimedia.org/w/index.php?title=Template:Purge_button/doc&oldid=318524485"