Module:Random slideshow

Module documentation[view] [edit] [history] [purge]

This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This template contains coding that is not compatible with mobile versions of Wikipedia, causing display and accessibility problems. Read the documentation for an explanation.

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Random slideshow/styles.css (sandbox)

Usage

{{#invoke:Random slideshow|main}}: See {{Random slideshow}} for details.
{{#invoke:Random slideshow|transclude}}: See {{Transclude files as random slideshow}} for details.

This module is also used by Module:Excerpt slideshow.

Display in the mobile view

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).

Testcases

The following testcase pages are available for testing changes made to this module's sandbox:

The above documentation is transcluded from Module:Random slideshow/doc.
Editors can experiment in this module's sandbox and testcases pages.
Subpages of this module.

-- Creates a slideshow gallery where the order is randomised. Intended for use on portal pages.localp={}localexcerptModule=require('Module:Excerpt/portals')localrandomModule=require('Module:Random')functioncleanupArgs(argsTable)localcleanArgs={}forkey,valinpairs(argsTable)doiftype(val)=='string'thenval=val:match('^%s*(.-)%s*$')ifval~=''thencleanArgs[key]=valendelsecleanArgs[key]=valendendreturncleanArgsendfunctionnormaliseCssMeasurement(input)localsuffix=string.reverse(string.sub(string.reverse(input),1,2))if(suffix=='px')or(suffix=='em')or(string.sub(suffix,2,2)=='%')thenreturninputelsereturninput..'px'endendfunctionisDeclined(val)ifnotvalthenreturnfalseendlocaldeclinedWords=" decline declined exclude excluded false none not no n off omit omitted remove removed "returnstring.find(declinedWords,' '..val..' ',1,true)andtrueorfalseendfunctionmakeOutput(galleryLines,maxWidth,containerClassName,nonRandom)localrandomiseArgs={['t']=galleryLines}localsortedLines=nonRandomandgalleryLinesorrandomModule.main('array',randomiseArgs)fori=1,#sortedLinesdo-- insert a switcher-label span just after the first pipe, which should ideally be the captionsortedLines[i]=sortedLines[i]:gsub("|",'|<span class="switcher-label" style="display:none"><span class="randomSlideshow-sr-only">Image '..tostring(i)..'</span></span>',1)endlocalgalleryContent=table.concat(sortedLines,'\n')localoutput='<div class="'..containerClassName..'" style="max-width:'..normaliseCssMeasurement(maxWidth)..'; margin:-4em auto;"><div class="nomobile"><!--intentionally empty on desktop, and is not present on mobile website (outside template namesapce)--></div>'..mw.getCurrentFrame():extensionTag({name="gallery",content=galleryContent,args={mode="slideshow",class="switcher-container"}})..'</div>'returnoutputendfunctionmakeGalleryLine(file,caption,credit)localtitle=mw.title.new(file,"File")ifnottitlethenreturn"File:Blank.png|{{Error|File [[:File:"..file.."]] does not exist.}}"endlocalcreditLine=(creditand'<p><span style="font-size:88%">'..credit..'</span></p>'or'')returntitle.prefixedText..'|'..(captionor'')..creditLineendfunctionmakeGalleryLinesTable(args)localgalleryLinesTable={}locali=1whileargs[i]dotable.insert(galleryLinesTable,makeGalleryLine(args[i],args[i+1],args['credit'..(i+1)/2]))i=i+2endreturngalleryLinesTableendfunctionhasCaption(line)localcaption=mw.ustring.match(line,".-|(.*)")-- require caption to exist with more than 5 characters (avoids sizes etc being mistaken for captions)returncaptionand#caption>5andtrueorfalseendfunctionextractGalleryFiles(wikitext)localgallery=mw.ustring.match(wikitext,'<gallery.->%s*(.-)%s*</gallery>')ifnotgallerythenreturnfalseendreturnmw.text.split(gallery,'%c')endfunctionextractRegularFiles(wikitext)localfiles={}localframe=mw.getCurrentFrame()localexpand=function(template)returnframe:preprocess(template)endforfileinmw.ustring.gmatch(wikitext,'%b[]')do-- remove keywords that don't work in galleriesfile=mw.ustring.gsub(file,'|%s*baseline%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*border%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*bottom%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*center%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*centre%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*class%s*=.-([|%]])','%1')file=mw.ustring.gsub(file,'|%s*framed?%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*frameless%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*lang%s*=.-([|%]])','%1')file=mw.ustring.gsub(file,'|%s*left%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*link%s*=.-([|%]])','%1')file=mw.ustring.gsub(file,'|%s*none%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*right%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*sub%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*super%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*text%-bottom%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*text%-top%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*thumb%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*thumbnail%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*top%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*upright%s*[0-9%.]*%s*([|%]])','%1')file=mw.ustring.gsub(file,'|%s*upright%s*=.-([|%]])','%1')-- remove spaces prior to captions (which cause pre-formatted text)file=mw.ustring.gsub(file,'|%s*','|')-- remove sizes, which sometimes get mistaken for captionsfile=mw.ustring.gsub(file,'|%s*%d*x?%d+%s*px%s*([|%]])','%1')-- remove linebreaksfile=mw.ustring.gsub(file,'\n\n','<br>')file=mw.ustring.gsub(file,'\n','')-- remove surrounding square bracketsfile=mw.ustring.gsub(file,'^%[%[','')file=mw.ustring.gsub(file,'%]%]$','')table.insert(files,file)endreturnfilesend--Central function for fixing issues that could occur in both gallery-fetched and file-fetched fileslocalfunctiondoubleCheck(file)-- disable pipes in wikilinksfile=file:gsub("%[%[([^%]]-)|(.-)]]","[[%1__PIPE__%2]]")-- move any alt parameter to the end to avoid putting the switcher in too early and causing a linter errorfile=file:gsub("^(.+)(|alt=[^|]*)(.*)$","%1%3%2")-- bring back pipes in wikilinksfile=file:gsub("%[%[(.-)__PIPE__(.-)]]","[[%1|%2]]")returnfileendfunctionmakeTranscludedGalleryLinesTables(args)localnamespaceNumber=function(pagetitle)localtitleObject=mw.title.new(pagetitle)returntitleObjectandtitleObject.namespaceendlocallines={}locali=1whileargs[i]doifnamespaceNumber(args[i])==6then-- file namespace-- args[i] is either just the filename, or uses syntax File:Name.jpg##Caption##Creditlocalparts=mw.text.split(args[i],'##%s*')localfilename=parts[1]localcaption=args['caption'..i]orparts[2]orfalselocalcredit=args['credit'..i]orparts[3]orfalselocalline=makeGalleryLine(filename,caption,credit)table.insert(lines,line)elselocalcontent,pagename=excerptModule.getContent(args[i])ifnotpagenamethenreturnerror('Cannot read a valid page for "'..args[i]..'"',0)elseifnotcontentthenreturnerror('No content found on page "'..args[i]..'"',0)endifargs['section'..i]thencontent=excerptModule.getSection(content,args['section'..i])or''endcontent=excerptModule.cleanupText(content,{keepSubsections=true,ignoreOnlyincludes=true})-- true means keep subsectionslocalgalleryFiles=extractGalleryFiles(content)ifgalleryFilesthenfor_,finpairs(galleryFiles)doifhasCaption(f)thenlocalfilename=string.gsub(f,'|.*','')localisOkay=excerptModule.checkImage(filename)ifisOkaythentable.insert(lines,doubleCheck(f.." (from '''[["..pagename.."]]''')"))endendendendlocalotherFiles=excerptModule.parse(content,{fileflags="1-100",filesOnly=true})ifotherFilesthenfor_,finpairs(extractRegularFiles(otherFiles))doiffandf~=''andmw.ustring.sub(f,1,5)=='File:'andhasCaption(f)thentable.insert(lines,doubleCheck(f.." (from '''[["..pagename.."]]''')"))endendendendi=i+1endreturn(#lines>0)andlinesorerror('No images found')endp._main=function(args,transclude,extraClassName)ifnotargs[1]thenreturnerror(linkedand'No page specified'or'No page specified',0)endlocallines=transcludeandmakeTranscludedGalleryLinesTables(args)ormakeGalleryLinesTable(args)localclassNames='randomSlideshow-container'ifextraClassNamethenclassNames=classNames..' '..extraClassNameendreturnmakeOutput(lines,args.widthor'100%',classNames,isDeclined(args.random))endp.main=function(frame)localparent=frame.getParent(frame)localparentArgs=parent.argslocalargs=cleanupArgs(parentArgs)localoutput=p._main(args,false)returnframe:extensionTag{name='templatestyles',args={src='Module:Random slideshow/styles.css'}}..frame:preprocess(output)endp.transclude=function(frame)localparent=frame.getParent(frame)localparentArgs=parent.argslocalargs=cleanupArgs(parentArgs)localoutput=p._main(args,true)returnframe:extensionTag{name='templatestyles',args={src='Module:Random slideshow/styles.css'}}..frame:preprocess(output)endreturnp

v t e Portal templates
Visual overview of template usage
Layout and formatting	{{Box portal skeleton}} {{Box-header}} color palettes plain round square watch {{Box-header colour}}^[1] {{Box-footer}} {{Flex columns}} {{Plain navboxes}}
Content transclusion	{{Transclude lead excerpt}}^[2] {{Transclude linked excerpt}}^[2] {{Transclude list item excerpt}}^[2] {{Transclude random excerpt}}^[2] {{Transclude selected excerpt}}^[2] {{Excerpt}} {{Transclude DYK}}^[9] {{Transclude selected current events}}^[3] {{Transclude selected recent additions}}^[4]
Content slideshows	{{Random slideshow}}^[5] {{Transclude files as random slideshow}}^[5] {{Transclude excerpts as random slideshow}}^[6] {{Transclude linked excerpts as random slideshow}}^[6] {{Transclude list item excerpts as random slideshow}}^[6]
Content randomisation	{{Random portal component}}^[7] {{Random quotation}} {{Random subpage}}
General	{{Portals}} {{Portals browsebar}} {{Portal description}} {{Portal information sidebar}} {{Portal navbar no header2}} {{Purge link portals}} {{Wikimedia for portals}}
Linking templates	{{Portal}}^[11] {{Portal bar}}^[12] {{Portal-inline}}^[13] {{Pbox}} {{Related portals2}}
Talk pages / Maintenance	{{Portal talk}} {{Portal maintenance status}}^[8] {{Portal suggestions}} {{Portal toolbox}} {{WikiProject Portals}}^[8]
Images	{{Portal dynamic image}} {{Portal image banner}}^[10] {{Portal pictures}}^[14] {{Portal POTD}}
Modules	1. Module:Box-header 2. Module:Excerpt/portals 3. Module:Selected current events 4. Module:Selected recent additions 5. Module:Random slideshow 6. Module:Excerpt slideshow 7. Module:Random portal component 8. Module:Portal maintenance status 9. Module:Transclude DYK 10. Module:Portal image banner 11. Module:Portal 12. Module:Portal bar 13. Module:Portal-inline 14. Module:Portal pictures
Usage	Wikipedia:Portal Wikipedia:WikiProject Portals
For more information, see: Category:Template-Class Portal pages and Category:Wikipedia Portal templates