View source for Template:Transclude files as random slideshow/doc

{{Documentation subpage}}
{{Template display|badmobile}}
{{Lua|Module:Random slideshow}}
This template transcludes images from specified pages, and creates a slideshow [[Help:Gallery tag|gallery]] with a randomised order – i.e. it changes when the page is purged. '''It is intended for use in portals and does not show anything in article space'''.

== Usage ==
{{a note}} Though there is no fixed limit to the number of pages that can be specified, or images per page, be aware that technical limitations may be encountered for very large numbers of pages or images. 

Specify pages displaying images:
<syntaxhighlight lang="wikitext">
{{Transclude files as random slideshow
| First page
| second page
| third page
}}
</syntaxhighlight>

If images should only be retrieved from a certain section of each page:
<syntaxhighlight lang="wikitext">
{{Transclude files as random slideshow
| First page  | section1= section name
| second page | section2= section name
| third page  | section3= section name
}}
</syntaxhighlight>

To also include some specific files:
<syntaxhighlight lang="wikitext">
{{Transclude files as random slideshow
| File:SpecificFileOne.jpg | caption1= Caption for first file
| File:SpecificFileTwo.png | caption2= Caption for second file | credit2= Credits for second file (optional)
| First page
| Second page
| Third page
}}
</syntaxhighlight>

{{anchor|Alternate syntax}}Alternate syntax for specific files' captions and credits:
<syntaxhighlight lang="wikitext">
{{Transclude files as random slideshow
| File:SpecificFileOne.jpg ## Caption for first file
| File:SpecificFileTwo.png ## Caption for second file ## Credits for second file (optional)
| First page
| Second page
| Third page
}}
</syntaxhighlight>
===Parameters===
;{{para|1}}, {{para|2}}, {{para|3}}, ... {{resize|(or equivalent positional parameters)}}
:Full page name – including namespace – of the page containing images, or of a specific image.
;{{para|section1}}, {{para|section2}}, {{para|section3}}, ...
:Limit to files in these section of the corresponding page. Optional.
;{{para|caption1}}, {{para|caption2}}, {{para|caption3}}, ...
:Caption for the corresponding file (or omit these parameters and use the [[#Alternate syntax|alternate syntax]] shown above)
;{{para|credit1}}, {{para|credit2}}, {{para|credit3}}, ...
:Optional: Credits for the file (or omit these parameters and use the [[#Alternate syntax|alternate syntax]] shown above)
;{{para|width}}
:Maximum width for all images; default is <code>100%</code> (intended for use inside portal components)
:Can be specified as a <code>%</code> (e.g. <kbd>75%</kbd>), or in <code>em</code>s (e.g. <kbd>30em</kbd>), or in <code>px</code> (e.g. <kbd>200px</kbd>)
:If a unit is not specified, <code>px</code> is assumed (i.e. <kbd>350</kbd> is equivalent to <kbd>350px</kbd>)

==Display in the mobile view==
On mobile devices, a standard gallery is displayed instead of the slideshow, and only the first four images (after randomisation) are visible.

===Examples===
<syntaxhighlight lang="wikitext">
{{Box-header|title=Selected pictures}}
{{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/1
| Template:Transclude files as random slideshow/testcases/2
| Template:Transclude files as random slideshow/testcases/3
}}
{{Box-footer}}
</syntaxhighlight>
<div style=max-width:600px>
{{Box-header|title=Selected pictures|EDIT=yes}}
{{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/1
| Template:Transclude files as random slideshow/testcases/2
| Template:Transclude files as random slideshow/testcases/3
}}
{{Box-footer}}
</div>

<syntaxhighlight lang="wikitext">
{{Box-header|title=Selected pictures}}
{{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/2 |section1=Mice
}}
{{Box-footer}}
</syntaxhighlight>
<div style=max-width:600px>
{{Box-header|title=Selected pictures|EDIT=yes}}
{{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/2 |section1=Mice
}}
{{Box-footer}}
</div>

<syntaxhighlight lang="wikitext">
{{Box-header|title=Selected pictures}}
{{Transclude files as random slideshow
| Australia
}}
{{Box-footer}}
</syntaxhighlight>
<div style=max-width:600px>
{{Box-header|title=Selected pictures|EDIT=yes}}
{{Transclude files as random slideshow
| Australia
}}
{{Box-footer}}
</div>

<!-- note that the sidebar view does not render on mobile, only on desktop -->
{{Sidebar
| pretitle = Embedded in sidebar, scaled to 1.35 upright
| pretitlestyle = font-weight:bold;
| width =
| style = border:1px solid #c8ccd1;
| content1style = margin:-5px -5px -2.2em -5px; display: inline-block;
| content1 = {{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/2 |section1=Mice
}}
| content2style = height:0px; margin:0 -0.4em; padding:0; display:inline-block; visibility:hidden; 
| content2 = [[File:Cat playing with a lizard.jpg|frameless|border|upright=1.35]]
}}
<syntaxhighlight lang="wikitext">
{{Sidebar
| pretitle = Embedded in sidebar, scaled to 1.35 upright
| pretitlestyle = font-weight:bold;
| width =
| style = border:1px solid #c8ccd1;
| content1style = margin:-5px -5px -2.2em -5px; display: inline-block;
| content1 = {{Transclude files as random slideshow
| Template:Transclude files as random slideshow/testcases/2 |section1=Mice
}}
| content2style = height:0px; margin:0 -0.4em; padding:0; display:inline-block; visibility:hidden; 
| content2 = [[File:Cat playing with a lizard.jpg|frameless|border|upright=1.35]]
}}
</syntaxhighlight>

==See also==
{{Portal templates navbox}}
{{cot|TemplateData}}
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Page 1",
			"description": "First page to use as a source of files/images",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Page 2",
			"description": "Second page to use a source of files/images. (Add more pages using parameters \"3\", \"4\", \"5\", etc)",
			"type": "wiki-page-name"
		},
		"section1": {
			"label": "Section of page 1",
			"description": "Limit files to this section of page 1",
			"type": "string"
		},
		"section2": {
			"label": "Section of page 2",
			"description": "Limit files to this section of page 2",
			"type": "string"
		},
		"width": {
			"label": "Width",
			"description": "Maximum width for all images. Specify as a %, or in em, or in px",
			"type": "string",
			"default": "100%"
		}
	}
}
</templatedata>
{{cob}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Image formatting and function templates]]
}}</includeonly>