Template:Random slideshow/doc

This is a documentation subpage for Template:Random slideshow.
It may contain usage information, categories and other content that is not part of the original template page.

This template contains coding that is not compatible with mobile versions of Wikipedia causing display and accessibility problems.
On mobile devices a standard gallery is displayed instead of the slideshow. If the screen width is less than 720px, only the first four images after randomisation are visible (example screenshot). For mobile devices with larger resolutions, all images are displayed (example screenshot). For some tables it displays all images stacked (example screenshot)

This template 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

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

|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

Purge this page to see these galleries in a different order

Cats

{{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 1Cat on snow
Image 2Cat playing with a lizard
Image 3Cats in Mumbai
Image 4Tired cat
Image 5Cat lying on rice straw

Mice

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Random slideshow in articles based on its TemplateData.

TemplateData for Random slideshow

<templatedata> { "params": { "1": { "aliases": [ "(unnamed positional parameter)" ], "label": "Image 1", "description": "Name of the first image, without prefix", "example": "Portal puzzle.svg, 1=Portal puzzle.svg", "type": "wiki-file-name", "default": "(empty)", "required": true }, "2": { "aliases": [ "(unnamed positional parameter)" ], "label": "Caption 1", "description": "Caption of the first image", "example": "2=This is the default portal icon", "type": "string", "default": "(empty)", "required": true }, "3": { "aliases": [ "(unnamed positional parameter" ], "label": "Image 2", "description": "Name of the second image, without prefix", "example": "Brown mouse.jpg, 3=Brown mouse.jpg", "type": "wiki-file-name", "default": "(empty)", "suggested": true }, "4": { "aliases": [ "(unnamed positional parameter)" ], "label": "Caption 2", "description": "Caption of the second image", "example": "4=This is a brown mouse", "type": "string", "default": "(empty)", "suggested": true }, "width": { "label": "Width", "description": "Maximum width of all images", "example": "width=80px, width=30em, width=50%", "type": "number", "default": "(none)", "suggested": true }, "credit1": { "label": "Credit 1", "description": "Credit for the first image", "example": "Photograph: Example" }, "credit2": { "label": "Credit 2", "description": "Credits for the second image", "example": "Photographer: Example" } }, "description": "Creates a slideshow gallery with randomized order. Add as many images as desired.", "paramOrder": [ "1", "2", "credit1", "width", "3", "4", "credit2" ], "format": "block" } </templatedata>