Module:Flag/doc

This is a documentation subpage for Module:Flag.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 308,000 pages, or roughly 1% of all 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.

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[edit]

{{flag}} → {{#invoke:flag|}}
{{flagcountry}} → {{#invoke:flag|country}}
{{flagdeco}} → {{#invoke:flag|deco}}
{{flagicon}} → {{#invoke:flag|icon}}
{{flag+link}} → {{#invoke:flag|+link}}
{{flagathlete}} → {{#invoke:flag|athlete}}
{{flagmedalist}} → {{#invoke:flag|medalist}}

Examples[edit]

Template			Module
Code	Output	PEIS	Code	Output	PEIS
`{{flag\|CHN}}`	CHN	443b	`{{#invoke:flag\|\|CHN}}`	CHN	128b
`{{flagcountry\|CHN}}`	China	577b	`{{#invoke:flag\|country\|CHN}}`	China	128b
`{{flagdeco\|CHN}}`		452b	`{{#invoke:flag\|deco\|CHN}}`		107b
`{{flagicon\|CHN}}`		548b	`{{#invoke:flag\|icon\|CHN}}`		117b
`{{flag+link\|History of\|CHN}}`	China	663b	`{{#invoke:flag\|+link\|History of\|CHN}}`	China	139b
`{{flagathlete\|Andy Murray\|GBR}}`	Andy Murray (GBR)	617b	`{{#invoke:flag\|athlete\|Andy Murray\|GBR}}`	Andy Murray (GBR)	210b
`{{flagmedalist\|Andy Murray\|GBR}}`	Andy Murray Great Britain	469b	`{{#invoke:flag\|medalist\|Andy Murray\|GBR}}`	Andy Murray Great Britain	129b

Caveats[edit]

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