Template:Shortcut2/doc

This template uses TemplateStyles:

Template:Shortcut2/styles.css

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

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

Produce a box floating right suited for shortcuts to sections.

Usage

This template is restricted to three parameters.

Template parameters

Parameter	Description		Default	Status
`1`	shortcut name		empty	required
`2`	shortcut name		empty	optional
`3`	shortcut name		empty	optional
`lang`	display language	Fix language code. Useful on translated Commons namespace pages, or in other translated templates.	{{int:lang}}	optional
`bg`	background color	CSS background color of the box.	white	optional
`border`	border color	CSS border color of the box.	#ccc	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.

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

Produce a box floating right suited for shortcuts to sections.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
shortcut name	`1`		Page name	required
shortcut name	`2`		Page name	optional
shortcut name	`3`		Page name	optional
background color	`bg`	CSS background color of the box. Default white	Line	optional
border color	`border`	CSS border color of the box. Default #ccc	Line	optional
display language	`lang`	Fix language code. Useful on translated Commons namespace pages, or in other translated templates. Default {{int:lang}}	Line	optional

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Relies on:

Example

{{shortcut2|COM:SAND|COM:SANDBOX|COM:SB}}{{Lorem}}

renders as:

Shortcuts

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Localization

This template is not intended to be localized.

The “Shortcut” text is translated at {{Shortcut text}}.