Module:Portal image banner

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 module depends on the following other modules:

Module:Random (sandbox)

This module implements {{Portal image banner}}; see documentation there for usage instructions. This module will not work when used directly (as {{#invoke:Portal image banner|main}}). Rather it is advisable that the main template Portal image banner is used.

localp={}localrandomModule=require('Module:Random')p.main=function(frame)localparent=frame.getParent(frame)localparentArgs=parent.argslocalargs=cleanupArgs(parentArgs)localoutput=p._main(args)returnframe:preprocess(output)endfunctioncleanupArgs(argsTable)localcleanArgs={}forkey,valinpairs(argsTable)doiftype(val)=='string'thenval=val:match('^%s*(.-)%s*$')ifval~=''thencleanArgs[key]=valendelsecleanArgs[key]=valendendreturncleanArgsendp._main=function(args)ifnotargs[1]thenreturnerror('No page specified',0)endlocallines=makeGalleryLinesTable(args)returnmakeOutput(lines,args.overflow,args.maxheight,args.mode,args.croptop)endfunctionmakeGalleryLine(file,caption,link)localtitle=mw.title.new(file,"File")locallinktext=(linkand'{{!}}link='..linkor'')localmaxImageWidth='{{!}}800px'return'[['..title.prefixedText..(captionand'{{!}}'..captionor'')..maxImageWidth..linktext..']]'..(captionand'\n<div style="text-align:center;">'..caption..'</div>'or'\n')endfunctionmakeGalleryLineSlideshow(file,caption)localtitle=mw.title.new(file,"File")localcaptiontext='[[File:OOjs_UI_icon_info-progressive.svg|link=:'..title.prefixedText..']]&nbsp;<span style="font-size:110%;">'..(captionor'')..'</span>'returntitle.prefixedText..'{{!}}'..captiontextendfunctionmakeGalleryLinesTable(args)localgalleryLinesTable={}locali=1whileargs[i]doifnotargs.modethentable.insert(galleryLinesTable,makeGalleryLine(args[i],args[i+1],args.link))elseifargs.mode=='slideshow'thentable.insert(galleryLinesTable,makeGalleryLineSlideshow(args[i],args[i+1],args.link))elseerror('Mode not supported')endi=i+2endreturngalleryLinesTableendfunctionmakeOutput(imageLines,overflow,maxHeight,mode,croptop)localrandomiseArgs={['t']=imageLines}localrandomisedLines=randomModule.main('array',randomiseArgs)localoutput,galleryContentifnotmodethengalleryContent=table.concat(randomisedLines,'\n',1,1)seperate=mw.text.split(galleryContent,'\n')output='<div class="portal-banner-image" style="max-height:'..(maxHeightor'initial')..'; overflow:'..(overflowor'auto')..';"><div class="portal-banner-image-crop" style="position:relative; margin-top:-'..(croptopor'0')..'%;">'..seperate[1]..'</div></div>'..seperate[2]elseifmode=='slideshow'thengalleryContent=table.concat(randomisedLines,'\n')output='<div class="portal-banner-image-slideshow nomobile" style="max-height:'..(maxHeightor'initial')..'; overflow:'..(overflowor'auto')..';"><div class="portal-banner-image-crop" style="position:relative; margin-top:-'..(croptopor'0')..'%;">'..'{{#tag:gallery|'..galleryContent..'|mode=slideshow}}'..'</div></div>'elseerror('Mode not supported')endreturnoutputendreturnp

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

See also