Template:Random slideshow/doc

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

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

Template:Mobile view problem

Uses Lua:

Module:Random slideshow

This template creates a slideshow gallery with a randomised order – i.e. it changes when the page is purged. It is intended for use in portals and will not display in article space.

Usage edit

As many images and captions as desired may be specified, in the following format:

{{Random slideshow 
| First image  | first caption
| second image | second caption
| third image  | third caption
}}

Credits (e.g. "Photograph: Example") may be specified, using the following format

{{Random slideshow 
| First image  | first caption | credit1=
| second image | second caption | credit2=
| third image  | third caption | credit3=
}}

Parameters edit

|1=, |3=, |5=, ... (or equivalent positional parameters): File name. The "File:" prefix is optional.
|2=, |4=, |6=, ... (or equivalent positional parameters): Caption for the file.
|credit1=, |credit2=, |credit3=, ...: Credits for the file. Optional.
|width=: Maximum width for all images; default is 100% (intended for use inside portal components); Can be specified as a % (e.g. 75%), or in ems (e.g. 30em), or in px (e.g. 200px); If a unit is not specified, px is assumed (i.e. 350 is equivalent to 350px)
|random=: Set to no or false to turn off the randomisation.

Examples edit

Purge this page to see these galleries in a different order

Cats edit

{{Box-header|title=Selected pictures}}
{{Random slideshow 
| File:Cat playing with a lizard.jpg | Cat playing with a lizard
| Felis silvestris catus lying on rice straw.jpg | Cat lying on rice straw
| Mumbai 03-2016 63 Dhobi Talao Chowk.jpg | Cats in Mumbai
| File:Felis catus-cat on snow.jpg | Cat on snow
| Tired 20-year-old cat.jpg | Tired cat
}}
{{Box-footer}}

edit

Selected pictures

Image 1Cats in Mumbai
Image 2Tired cat
Image 3Cat on snow
Image 4Cat playing with a lizard
Image 5Cat lying on rice straw

Mice edit

{{Random slideshow | width=275
| File:Agouti Mice.jpg | Two mice | credit1= Photograph: Pogrebnoj-Alexandroff
| Brown mouse.jpg | Brown mouse | credit2= Photograph: [[User:Kulmalukko|Tiia Monto]]
| File:Farbmaeuse.jpg | Mice with food | credit3= Photograph: [[c:User:Whitesky~commonswiki|Whitesky]]
| File:Farbmaus.JPG | Mouse on a wheel | credit2= Photograph: [[de:User:R2Dine|R2Dine]]
| White lab mouse in hand B.jpg | A mouse in the hand is worth two in the bush | credit4= Photograph: Pogrebnoj-Alexandroff
}}

Image 1Brown mouse
Photograph: Tiia Monto
Image 2Mouse on a wheel
Photograph: R2Dine
Image 3Mice with food
Photograph: Whitesky
Image 4A mouse in the hand is worth two in the bush
Photograph: Pogrebnoj-Alexandroff
Image 5Two mice
Photograph: Pogrebnoj-Alexandroff

TemplateData

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

Creates a slideshow gallery with randomized order. Add as many images as desired.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Image 1	`1` `(unnamed positional parameter)`	Name of the first image, without prefix Default (empty) Example Portal puzzle.svg, 1=Portal puzzle.svg	File	required
Caption 1	`2` `(unnamed positional parameter)`	Caption of the first image Default (empty) Example 2=This is the default portal icon	String	required
Credit 1	`credit1`	Credit for the first image Example Photograph: [[User:Example\|Example]]	Unknown	optional
Width	`width`	Maximum width of all images Default (none) Example width=80px, width=30em, width=50%	Number	suggested
Image 2	`3` `(unnamed positional parameter`	Name of the second image, without prefix Default (empty) Example Brown mouse.jpg, 3=Brown mouse.jpg	File	suggested
Caption 2	`4` `(unnamed positional parameter)`	Caption of the second image Default (empty) Example 4=This is a brown mouse	String	suggested
Credit 2	`credit2`	Credits for the second image Example Photographer: [[User:Example\|Example]]	Unknown	optional