Module:Flag/doc
This is the documentation page for Module:Flag
This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. 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
កែប្រែ- {{flag}} → {{#invoke:flag|}}
- {{flag country}} → Flag#country
- {{flag decoration}} → Flag#decoration (or Flag#deco)
- {{flag icon}} → Flag#icon
- {{flag link}} → Flag#link
- {{flag+link}} → Flag#+link
- {{flag athlete}} → Flag#athlete
- {{flag medalist}} → Flag#medalist
- {{flag IOC athlete}} → Flag#IOC athlete
- {{fb}} → Flag#fb
- {{fb-rt}} → Flag#fb-rt
- {{fbicon}} → Flag#fbicon
- {{ru}} → Flag#ru
Examples
កែប្រែ! colspan=3| Template !! colspan=3| Module
|-
! Code !! Output !! PEIS !! Code !! Output !! PEIS
|-
| {{flag|CHN}}
|| CHN || 443b || {{#invoke:flag||CHN}}
|| CHN || 128b
|-
| {{flag country|CHN}}
|| ចិន || 577b || {{#invoke:flag|country|CHN}}
|| CHN || 128b
|-
| {{flag decoration|CHN}}
/{{flag deco|CHN}}
|| ទំព័រគំរូ:Flag deco || 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}}
|| ទំព័រគំរូ:Flag link || 497b || {{#invoke:flag|link|CHN|at the 2004 Summer Olympics}}
|| CHN || 198b
|-
| {{flag+link|History of|CHN}}
|| ទំព័រគំរូ:Flag+link || 663b || {{#invoke:flag|+link|History of|CHN}}
|| CHN || 139b
|-
| {{flag athlete|Andy Murray|GBR}}
|| ទំព័រគំរូ:Flagathlete || 617b || {{#invoke:flag|athlete|Andy Murray|GBR}}
|| GBR || 210b
|-
| {{flag medalist|Andy Murray|GBR}}
|| ទំព័រគំរូ:Flagmedalist || 469b || {{#invoke:flag|medalist|Andy Murray|GBR}}
|| Andy Murray
GBR || 129b
|-
| {{flag IOC athlete|Mark Spitz|USA|1972 Summer}}
|| ទំព័រគំរូ:Flag IOC athlete || 346b || {{#invoke:flag|IOC athlete | Mark Spitz| USA| 1972 Summer}}
|| Mark Spitz (USA) || 178b
|-
| {{fb|CHN}}
|| ស.ប. ចិន || 560b || {{#invoke:flag|fb|CHN}}
|| Lua error in package.lua at line 80: module 'Module:Flagg/Altvar data' not found. || 151b
|-
| {{fb-rt|CHN}}
|| ស.ប. ចិន || 482b || {{#invoke:flag|fb-rt|CHN}}
|| Lua error in package.lua at line 80: module 'Module:Flagg/Altvar data' not found. || 151b
|-
| {{fbicon|CHN}}
|| ទំព័រគំរូ:Fbicon || 444b || {{#invoke:flag|fbicon|CHN}}
|| Lua error in package.lua at line 80: module 'Module:Flagg/Altvar data' not found. || 163b
|-
| {{ru|CHN}}
|| ទំព័រគំរូ:Ru || 646b || {{#invoke:flag|ru|CHN}}
|| Lua error in package.lua at line 80: module 'Module:Flagg/Altvar data' not found. || 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}}
.