Module:Flag

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

Lua-native alternative to popular flag templates. Can be used to reduce post-expand include size of pages with lots of templates, since it avoids calling multilevel templates.

Usage

Generic flag templates

• {{flag}} → {{#invoke:flag|}}
• {{flag country}} → {{#invoke:flag|country}}
• {{flag decoration}} (or {{flagdeco}}) → {{#invoke:flag|decoration}} (or {{#invoke:flag|deco}})
• {{flag icon}} → {{#invoke:flag|icon}}
• {{flag link}} → {{#invoke:flag|link}}
• {{flag+link}} → {{#invoke:flag|+link}}

Sports flag templates

• {{flag athlete}} → {{#invoke:flag|athlete}}
• {{flag medalist}} → {{#invoke:flag|medalist}}
• {{flag team}} → {{#invoke:flag|team}}
• {{flag IOC}} → {{#invoke:flag|IOC}}
• {{flag IOC 2}} → {{#invoke:flag|IOC 2}}
• {{flag IOC athlete}} → {{#invoke:flag|IOC athlete}}
• {{fb}} → {{#invoke:flag|fb}}
• {{fba}} → {{#invoke:flag|fba}}
• {{fb-rt}} → {{#invoke:flag|fb-rt}}
• {{fbicon}} → {{#invoke:flag|fbicon}}
• {{fbaicon}} → {{#invoke:flag|fbaicon}}
• {{ru}} → {{#invoke:flag|ru}}

Examples

Template			Module
Code	Output	PEIS	Code	Output	PEIS
{{flag|CHN}}	CHN	443b	{{#invoke:flag||CHN}}	CHN	128b
{{flag country|CHN}}	China	577b	{{#invoke:flag|country|CHN}}	China	128b
{{flag decoration|CHN}}/{{flag deco|CHN}}		452b	{{#invoke:flag|decoration|CHN}}/{{#invoke:flag|deco|CHN}}		107b
{{flag icon|CHN}}		548b	{{#invoke:flag|icon|CHN}}		117b
{{flag link|CHN|at the 2004 Summer Olympics}}	China	497b	{{#invoke:flag|link|CHN|at the 2004 Summer Olympics}}	China	198b
{{flag+link|History of|CHN}}	China	663b	{{#invoke:flag|+link|History of|CHN}}	China	139b
{{flag team|GBR}}	Great Britain (GBR)	804b	{{#invoke:flag|team|GBR}}	Great Britain (GBR)	193b
{{flag athlete|Andy Murray|GBR}}	Andy Murray (GBR)	617b	{{#invoke:flag|athlete|Andy Murray|GBR}}	Andy Murray (GBR)	210b
{{flag medalist|Andy Murray|GBR}}	Andy Murray Great Britain	469b	{{#invoke:flag|medalist|Andy Murray|GBR}}	Andy Murray Great Britain	129b
{{flag IOC|CAN|1924 Winter|1}}	Canada (1)	326b	{{#invoke:flag|IOC|CAN|1924 Winter|1}}	Canada (1)	163b
{{flag IOC 2|HKG|1954 Asian Games|1}}	Hong Kong (1)	368b	{{#invoke:flag|IOC 2|HKG|1954 Asian Games|1}}	Hong Kong (1)	184b
{{flag IOC athlete|Mark Spitz|USA|1972 Summer}}	Mark Spitz (USA)	346b	{{#invoke:flag|IOC athlete|Mark Spitz|USA|1972 Summer}}	Mark Spitz (USA)	178b
{{fb|CHN}}	China	560b	{{#invoke:flag|fb|CHN}}	China	151b
{{fb-rt|CHN}}	China	482b	{{#invoke:flag|fb-rt|CHN}}	China	151b
{{fbicon|CHN}}		444b	{{#invoke:flag|fbicon|CHN}}		163b
{{fba|CHN}}	China	625b	{{#invoke:flag|fba|CHN}}	China	149b
{{fbaicon|CHN}}		500b	{{#invoke:flag|fbaicon|CHN}}		159b
{{ru|CHN}}	China	646b	{{#invoke:flag|ru|CHN}}	China	210b

Caveats

When used inside a template, parameters from that template are passed to the module. This can be useful in some situations, but can lead to conflicts (for example, if the parent template has a parameter |country= that is unrelated to the flag it is supposed to display). To prevent this behavior, add the |frameonly= parameter to the module call, e.g. {{#invoke:flag|deco|CHN|frameonly=true}}.

The above documentation is transcluded from Module:Flag/doc. (edit | history)
Editors can experiment in this module's sandbox(edit | diff) and testcases(edit) pages.
Subpages of this module.

localmargs=require('Module:Arguments')localfunction_main(frame,name,mode)localcategories={['Flag icon']='[[Category:Flag icons missing country data templates]]',['Flag decoration']='[[Category:Flag decoration missing country data templates]]',}localyesno=require('Module:Yesno')--Get input argumentslocalargs=margs.getArgs(frame,{frameOnly=((frame.args.frameonlyor'')~=''),valueFunc=function(key,value)ifvaluethenvalue=mw.text.trim(value)--Change empty string to nil for all args except 'image' and 'border'ifkey=="image"orkey=="border"orvalue~=""thenreturnvalueendendreturnnilend})localpreftext,sufftext="",""ifname=='Flag+link'thenargs.pref=args[1]elseifname=='Flag athlete'thenargs.preftext=args[1]args[2]=args.codeorargs[2]or""args.variant=args.variantorargs[3]elseifname=='Flag medalist'thenpreftext=(args[1]or"").."<br/>"args[2]=args.codeorargs[2]or""args.variant=args.variantorargs[3]elseifname=='Flag link'thenargs.suff=args[2]args[2]=args[1]or""args.variant=args.variantorargs[3]elsesports={fb='fb',['fb-rt']='fb',fbicon='fb',ru='ru',fba='fba',fbaicon='fba'}ifsports[name]andargs[1]thenargs.avar=sports[name]ifname=='fb'andyesno(args.align)==truethenargs.align='c'elseifargs.avar=='fba'thenlocallist=require("Module:Fba/list")localold=((args.oldor"")~="")and"_old"or""localfba=list.fbas[args[1]..old]ifnotfbaandstring.len(args[1])==3thenfork,vinpairs(list.codes)doifv==args[1]thenfba=list.fbas[k];breakendendendifargs.name=="code"thenargs.name=list.codes[args[1]]elseifargs.name=="full"thenargs.name=fbaendiffbathenmode=string.gsub(mode,"p","c")args.link=fbaendargs.altlink=args.oldendelseifname=="Flag team"and(args.codeorargs[1])thensufftext='&nbsp;<span style="font-size:90%;">('..(args.codeorargs[1])..')</span>'endargs.variant=args.variantorargs[2]args[2]=args[1]or""endargs[1]=mode..(args.optsor'')args.missingcategory=categories[name]args.noredlink=args.noredlinkor'notext'ifargs.placeholderandyesno(args.placeholder)~=truethenargs[1]=args[1]..'o'endifmw.title.getCurrentTitle().namespace==0thenlocalunknown='[[Category:Pages using '..mw.ustring.lower(name)..' template with unknown parameters|_VALUE_'..frame:getParent():getTitle()..']]'elselocalunknown=''endcheck=''ifname=='Flag icon'thenlocalopts={unknown=unknown,preview='Page using [[Template:'..name..']] with unknown parameter "_VALUE_"',ignoreblank='y','1','2','variant','image','size','sz','border','align','al','width','w','alt','ilink','noredlink','missingcategory','name','clink','link','pref','suff','plink','the','section','altvar','avar','age','nalign','nal','text','nodata','opts','placeholder','getParent','frameonly'}check=require('Module:Check for unknown parameters')._check(opts,args)endreturnpreftext..require('Module:Flagg').luaMain(frame,args)..sufftext..checkendlocalp={['']=function(frame)return_main(frame,'Flag','unc')end,decoration=function(frame)return_main(frame,'Flag decoration','uxx')end,icon=function(frame)return_main(frame,'Flag icon','cxxl')end,link=function(frame)return_main(frame,'Flag link','unpe')end,['+link']=function(frame)return_main(frame,'Flag+link','unpefo')end,country=function(frame)return_main(frame,'Flag country','unce')end,team=function(frame)return_main(frame,'Flag team','unce')end,athlete=function(frame)return_main(frame,'Flag athlete','unape')end,medalist=function(frame)return_main(frame,'Flag medalist','unce')end,fb=function(frame)return_main(frame,'fb','unpe')end,fba=function(frame)return_main(frame,'fba','unpe')end,['fb-rt']=function(frame)return_main(frame,'fb-rt','unpre')end,fbicon=function(frame)return_main(frame,'fbicon','pxxl')end,fbaicon=function(frame)return_main(frame,'fbaicon','pxxl')end,ru=function(frame)return_main(frame,'ru','unpe')end,IOC=function(frame)returnrequire('Module:Country_alias').flagIOC(frame:newChild{title='Template:Flag IOC'})end,IOC2=function(frame)returnrequire('Module:Country_alias').flagXYZ(frame:newChild{title='Template:Flag IOC 2',args={name=margs.getArgs(frame).nameor'',type='name'}})end,IOCathlete=function(frame)returnrequire('Module:Country_alias').flagXYZ(frame:newChild{title='Template:Flag IOC athlete',args={type='athlete-O'}})end,}p['deco']=p.decorationp['IOC 2']=p.IOC2p['IOC athlete']=p.IOCathletereturnp