Module:Flag/doc

This is the documentation page for Module:Flag

This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.

Lua error in Module:Effective_protection_level at line 64: attempt to index field 'TitleBlacklist' (a nil value).

-->

Warning

This Lua module is used on approximately 363,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

File:Lua-Logo.svg

This module depends on the following other modules:

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}}
{{flag list}} → {{#invoke:flag|list}}

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}}`	File:Flag of the People's Republic of China.svg CHN	443b	`{{#invoke:flag\|\|CHN}}`	File:Flag of the People's Republic of China.svg CHN	128b
`{{flag country\|CHN}}`	File:Flag of the People's Republic of China.svg China	577b	`{{#invoke:flag\|country\|CHN}}`	File:Flag of the People's Republic of China.svg China	128b
`{{flag decoration\|CHN}}`/`{{flag deco\|CHN}}`	File:Flag of the People's Republic of China.svg	452b	`{{#invoke:flag\|decoration\|CHN}}`/`{{#invoke:flag\|deco\|CHN}}`	File:Flag of the People's Republic of China.svg	107b
`{{flag icon\|CHN}}`	China	548b	`{{#invoke:flag\|icon\|CHN}}`	China	117b
`{{flag link\|CHN\|at the 2004 Summer Olympics}}`	File:Flag of the People's Republic of China.svg China	497b	`{{#invoke:flag\|link\|CHN\|at the 2004 Summer Olympics}}`	File:Flag of the People's Republic of China.svg China	198b
`{{flag+link\|History of\|CHN}}`	File:Flag of the People's Republic of China.svg China	663b	`{{#invoke:flag\|+link\|History of\|CHN}}`	File:Flag of the People's Republic of China.svg China	139b
`{{flag list\|SWI}}`	File:Flag of Switzerland (Pantone).svg SWI	685b	`{{#invoke:flag\|list\|SWI}}`	File:Flag of Switzerland (Pantone).svg SWI	254b
`{{flag team\|GBR}}`	File:Flag of the United Kingdom.svg Great Britain (GBR)	804b	`{{#invoke:flag\|team\|GBR}}`	File:Flag of the United Kingdom.svg Great Britain (GBR)	193b
`{{flag athlete\|Andy Murray\|GBR}}`	File:Flag of the United Kingdom.svg Andy Murray (GBR)	617b	`{{#invoke:flag\|athlete\|Andy Murray\|GBR}}`	File:Flag of the United Kingdom.svg Andy Murray (GBR)	210b
`{{flag medalist\|Andy Murray\|GBR}}`	Andy Murray File:Flag of the United Kingdom.svg Great Britain	469b	`{{#invoke:flag\|medalist\|Andy Murray\|GBR}}`	Andy Murray File:Flag of the United Kingdom.svg Great Britain	129b
`{{flag IOC\|CAN\|1924 Winter\|1}}`	File:Flag of Canada (1921–1957).svg Canada (1)	326b	`{{#invoke:flag\|IOC\|CAN\|1924 Winter\|1}}`	File:Flag of Canada (1921–1957).svg Canada (1)	163b
`{{flag IOC 2\|HKG\|1954 Asian Games\|1}}`	File:Flag of Hong Kong (1876–1941 and 1945–1955).svg Hong Kong (1)	368b	`{{#invoke:flag\|IOC 2\|HKG\|1954 Asian Games\|1}}`	File:Flag of Hong Kong (1876–1941 and 1945–1955).svg Hong Kong (1)	184b
`{{flag IOC athlete\|Mark Spitz\|USA\|1972 Summer}}`	File:Flag of the United States.svg Mark Spitz (USA)	346b	`{{#invoke:flag\|IOC athlete\|Mark Spitz\|USA\|1972 Summer}}`	File:Flag of the United States.svg Mark Spitz (USA)	178b
`{{fb\|CHN}}`	File:Flag of the People's Republic of China.svg China	560b	`{{#invoke:flag\|fb\|CHN}}`	File:Flag of the People's Republic of China.svg China	151b
`{{fb-rt\|CHN}}`	China File:Flag of the People's Republic of China.svg	482b	`{{#invoke:flag\|fb-rt\|CHN}}`	China File:Flag of the People's Republic of China.svg	151b
`{{fbicon\|CHN}}`	China	444b	`{{#invoke:flag\|fbicon\|CHN}}`	China national football team	163b
`{{fba\|CHN}}`	File:Flag of the People's Republic of China.svg China	625b	`{{#invoke:flag\|fba\|CHN}}`	File:Flag of the People's Republic of China.svg China	149b
`{{fbaicon\|CHN}}`	China	500b	`{{#invoke:flag\|fbaicon\|CHN}}`	Chinese Football Association	159b
`{{ru\|CHN}}`	File:Flag of the People's Republic of China.svg China	646b	`{{#invoke:flag\|ru\|CHN}}`	File:Flag of the People's Republic of China.svg 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}}.