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 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. |
 | This Lua module is used on approximately 376,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. |
 | 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]Generic flag templates
[edit]- {{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}}
- {{flagu}} → {{#invoke:flag|u}}
Sports flag templates
[edit]- {{flag team}} → {{#invoke:flag|team}}
- {{flag athlete}} → {{#invoke:flag|athlete}}
- {{flag medalist}} → {{#invoke:flag|medalist}}
- {{flag IOC}} → {{#invoke:flag|IOC}}
- {{flag IOC 2}} → {{#invoke:flag|IOC 2}}
- {{flag IOC athlete}} → {{#invoke:flag|IOC athlete}}
- {{3x3}} → {{#invoke:flag|3x3}}
- {{bb}} → {{#invoke:flag|bb}}
- {{fb}} → {{#invoke:flag|fb}}
- {{fb-rt}} → {{#invoke:flag|fb-rt}}
- {{fba}} → {{#invoke:flag|fba}}
- {{fbw}} → {{#invoke:flag|fbw}}
- {{fbw-rt}} → {{#invoke:flag|fbw-rt}}
- {{fbicon}} → {{#invoke:flag|fbicon}}
- {{fbaicon}} → {{#invoke:flag|fbaicon}}
- {{futsal}} → {{#invoke:flag|futsal}}
- {{futsal-rt}} → {{#invoke:flag|futsal-rt}}
- {{ru}} → {{#invoke:flag|ru}}
Examples
[edit]| 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 list|SWI}} |  SWI | 685b | {{#invoke:flag|list|SWI}} | SWI | 254b |
{{flagu|CHN}} | CHN | 365b | {{#invoke:flag|u|CHN}} | CHN | 162b |
{{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 |
{{fbw|CHN}} | China | 318b | {{#invoke:flag|fbw|CHN}} | China | 183b |
{{fbw-rt|CHN}} | China | 506b | {{#invoke:flag|fbw-rt|CHN}} | China | 190b |
{{futsal|CHN}} | China | 476b | {{#invoke:flag|futsal|CHN}} | China | 149b |
{{futsal-rt|CHN}} | China | 476b | {{#invoke:flag|futsal-rt|CHN}} | China | 156b |
{{ru|CHN}} | China | 646b | {{#invoke:flag|ru|CHN}} | China | 210b |
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}}.