Template:Flag/doc: Difference between revisions

From comp.tf
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Template:Flag''' displays a flag icon that is 15px high and bordered. This template is used in conjunction with [[Template:Flag/abbr]], which defines the terms that can be used in this template. All of the flag images used in this template can be found at [[:Category:Flag Images]].
'''Template:Flag''' displays a flag icon.
== Usage ==
== Usage ==
<code><nowiki>{{flag|</nowiki>'''<nowiki>name</nowiki>'''<nowiki>}}</nowiki></code>
<code><nowiki>{{flag|</nowiki>'''<nowiki>1</nowiki>'''<nowiki>}}</nowiki></code>
=== name ===
=== 1 ===
This is the only parameter in the template and is used for defining which country's information should be used.
This is the only parameter in the template and is used for defining which country's flag will be shown.
*The data entered here will provide the icon with its image and caption/tool tip text.
* All valid settings for flags are listed in the tables below
*Appropriate settings for this parameter are listed in the table below.
* This parameter is case-insensitive.
*Any text entered should be fully lowercase.
 
*Any special characters (å, é, ì, ô, ū) are not used as they conflict with the wiki's file retrieving system.
*If there is no setting or the setting is invalid (i.e. not listed in the table below) the template will display a placeholder flag, {{flag}}. This is used to keep alignment proper in other templates or to indicate an unknown country.
== Examples ==
== Examples ==
{| class="wikitable" style="text-align: center; cell-padding: em;"
{| class="wikitable" style="text-align: center;"
  ! style="color: white; background-color: #1c1c1c" colspan=3 | You type
  | style="background-color:white;border-top:hidden;border-left:hidden" |
  ! style="color: white; background-color: #1c1c1c" colspan=3 | You get
! You type
  ! You get
|-
! Full name
| <code><nowiki>{{flag|United Nations}}</nowiki></code>
| {{flag|United Nations}}
|-
! Alternate name
| <code><nowiki>{{flag|world}}</nowiki></code>
| {{flag|world}}
|-
|-
  | style="border-right:hidden" |
  ! Abbreviation
  | <code><nowiki>{{flag|antarctica}}</nowiki></code>
  | <code><nowiki>{{flag|un}}</nowiki></code>
| style="border-left:hidden" |
  | {{flag|un}}
| style="border-right:hidden" |
  | {{flag|antarctica}}
| style="border-left:hidden" |
|-
|-
  | style="border-right:hidden" |
  ! No parameter
  | <code><nowiki>{{flag|aq}}</nowiki></code>
  | <code><nowiki>{{flag|}}</nowiki></code>
| style="border-left:hidden" |
  | {{flag|}}
| style="border-right:hidden" |
  | {{flag|aq}}
| style="border-left:hidden" |
|-
|-
  | style="border-right:hidden" |
  ! Invalid parameter
  | <code><nowiki>{{flag|invalid}}</nowiki></code>
  | <code><nowiki>{{flag|invalid}}</nowiki></code>
| style="border-left:hidden" |
| style="border-right:hidden" |
  | {{flag|invalid}}
  | {{flag|invalid}}
| style="border-left:hidden" |
|}
|}
== Valid settings ==
== Valid settings ==
A flag can be displayed by either using a country's two letter abbreviation, another name for the country, or the full name of the country in the '''name''' parameter. An alternate list of two letter abbreviations for countries can be found [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements here].
=== Note: United Kingdom flags ===
{{box|start|padding=4em}}
The individual flags of {{flag|uken}} England, {{flag|ukni}} Northern Ireland, {{flag|uksc}} Scotland, and {{flag|ukwa}} Wales should take preference in '''all possible circumstances''' over the {{flag|uk}} United Kingdom flag.
=== {{flag|uken}} {{flag|ukni}} {{flag|uksc}} {{flag|ukwa}} <small>vs.</small> {{flag|uk}} ===
The individual flags of '''{{flag|uken}} England''', '''{{flag|ukni}} Northern Ireland''', '''{{flag|uksc}} Scotland''', and '''{{flag|ukwa}} Wales''' should take preference in all possible circumstances over the '''{{flag|uk}} United Kingdom''' flag.
{| class=wikitable style="width: 100%; text-align: center;"
{| class=wikitable style="width: 100%; text-align: center;"
|[[Template:Flag#Miscellaneous | Misc]] · [[Template:Flag#A | A]] · [[Template:Flag#B | B]] · [[Template:Flag#C | C]] · [[Template:Flag#D | D]] · [[Template:Flag#E | E]] · [[Template:Flag#F | F]] · [[Template:Flag#G | G]] · [[Template:Flag#H | H]] · [[Template:Flag#I | I]] · [[Template:Flag#J | J]] · [[Template:Flag#K | K]] · [[Template:Flag#L | L]] · [[Template:Flag#M | M]] · [[Template:Flag#N | N]] · [[Template:Flag#O | O]] · [[Template:Flag#P | P]] · [[Template:Flag#Q | Q]] · [[Template:Flag#R | R]] · [[Template:Flag#S | S]] · [[Template:Flag#T | T]] · [[Template:Flag#U | U]] · [[Template:Flag#V | V]] · [[Template:Flag#W | W]] · [[Template:Flag#X | X]] · [[Template:Flag#Y | Y]] · [[Template:Flag#Z | Z]]
|[[Template:Flag#Miscellaneous | Misc]] · [[Template:Flag#A | A]] · [[Template:Flag#B | B]] · [[Template:Flag#C | C]] · [[Template:Flag#D | D]] · [[Template:Flag#E | E]] · [[Template:Flag#F | F]] · [[Template:Flag#G | G]] · [[Template:Flag#H | H]] · [[Template:Flag#I | I]] · [[Template:Flag#J | J]] · [[Template:Flag#K | K]] · [[Template:Flag#L | L]] · [[Template:Flag#M | M]] · [[Template:Flag#N | N]] · [[Template:Flag#O | O]] · [[Template:Flag#P | P]] · [[Template:Flag#Q | Q]] · [[Template:Flag#R | R]] · [[Template:Flag#S | S]] · [[Template:Flag#T | T]] · [[Template:Flag#U | U]] · [[Template:Flag#V | V]] · [[Template:Flag#W | W]] · [[Template:Flag#X | X]] · [[Template:Flag#Y | Y]] · [[Template:Flag#Z | Z]]
Line 1,059: Line 1,055:
{{Box|end}}
{{Box|end}}


== Adding a flag ==
== Developer documentation ==
If you wish to add a flag, the following requirements must be followed
=== How this template works ===
=== Image size ===
# '''Template:Flag''' takes the input parameter and calls a sub-template at "Template:Flag/X". For example, <code><nowiki>{{flag|united nations}}</nowiki></code> will call [[Template:Flag/united nations]].
# This sub-template then in turn calls [[Template:Flag icon]], supplying it with a single parameter (<code><nowiki>{{Flag icon|X}}</nowiki></code>). For example, Template:Flag/united nations supplies Template:Flag icon with the single parameter <code>United Nations</code>
# Template:Flag icon calls for a flag image at "File:Flag of X.png", and applies formatting such as sizing and a 1px border. For example, if Template:Flag icon is given the parameter <code>United Nations</code>, it will supply [[:File:Flag of United Nations.png]] ({{flag|un}}).
 
* Many of the sub-templates (such as the abbreviations and alternate names) are simple redirects to a primary sub-template. For example, [[Template:Flag/un]], [[Template:Flag/global]], [[Template:Flag/international]] and [[Template:Flag/world]] all redirect to [[Template:Flag/united nations]]. Template:Flag/united nations is the primary sub-template which then calls Template:Flag icon.
 
=== How to add a flag ===
If you wish to add a flag, the following requirements must be followed:
==== Image size ====
*Width: equal or less than 23px
*Width: equal or less than 23px
*Height: equal or less than 15px
*Height: equal or less than 15px
*Aspect ratio: retained from source flag
*Aspect ratio: retained from source flag
If your flag is a custom flag (e.g. {{flag|nam}}), we recommend a 23x15px flag which has a 2:3 ratio.
If your flag is a custom flag (e.g. {{flag|nam}}), we recommend a 23x15px flag which has a 2:3 ratio.
=== Upload ===
==== Upload ====
*Your flag should be uploaded to <Code>File:Flag of <nowiki><fullflagname></nowiki>.png</code>
*Your flag should be uploaded to <Code>File:Flag of '''ProperFlagName'''.png</code>, where <code>'''ProperFlagName'''</code> is the full name of your flag with correct capitalization
*Make sure you add your flag to [[:Category:Flag Images]]
*Make sure you add your flag image to [[:Category:Flag Images]].
=== Update templates ===
==== Update templates ====
*[[Template:Flag/abbr]] controls abbreviations and flag names, add your flag with its appropriate abbreviation there
*Create a template at <code>Template:Flag/'''lowercaseflagname'''</code>, where <code>'''lowercaseflagname'''</code> is the full name of your flag in complete lowercase. This template should contain the code below:
*Update the appropriate documentation template at Template:Flag/doc/''FirstLetterOfFullFlagName'' (e.g. [[Template:Flag/doc/s]] for Switzerland)
<pre><nowiki>{{Flag icon|</nowiki>'''ProperFlagName'''<nowiki>}}<noinclude>[[Category:Flag sub-templates]]</noinclude></nowiki></pre>
 
*Create a template at <code>Template:Flag/'''abbr'''</code>, where <code>abbr</code> is the lowercase abbreviation of your flag. This template should be a simple redirect to the primary sub-template (<code>Template:Flag/'''lowercaseflagname'''</code>)
<noinclude>[[Category:Flag Documentation Templates]]</noinclude>
**If your template has any alternate names or abbreviations, create them as simple redirects to the primary sub-template as well
*Add your flag to the correct table in the [[Template:Flag/doc|documentation template]].<noinclude>[[Category:Flag Documentation Templates]]</noinclude>

Revision as of 17:31, 11 May 2020

Template:Flag displays a flag icon.

Usage

{{flag|1}}

1

This is the only parameter in the template and is used for defining which country's flag will be shown.

  • All valid settings for flags are listed in the tables below
  • This parameter is case-insensitive.

Examples

You type You get
Full name {{flag|United Nations}} United Nations
Alternate name {{flag|world}} United Nations
Abbreviation {{flag|un}} United Nations
No parameter {{flag|}} Unknown
Invalid parameter {{flag|invalid}} Template:Flag/invalid

Valid settings

Note: United Kingdom flags

The individual flags of England England, Northern Ireland Northern Ireland, Scotland Scotland, and Wales Wales should take preference in all possible circumstances over the United Kingdom United Kingdom flag.

Misc · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

O

Oman om Oman

Q

Qatar qa Qatar

X

Y

Yemen ye Yemen

Developer documentation

How this template works

  1. Template:Flag takes the input parameter and calls a sub-template at "Template:Flag/X". For example, {{flag|united nations}} will call Template:Flag/united nations.
  2. This sub-template then in turn calls Template:Flag icon, supplying it with a single parameter ({{Flag icon|X}}). For example, Template:Flag/united nations supplies Template:Flag icon with the single parameter United Nations
  3. Template:Flag icon calls for a flag image at "File:Flag of X.png", and applies formatting such as sizing and a 1px border. For example, if Template:Flag icon is given the parameter United Nations, it will supply File:Flag of United Nations.png (United Nations).

How to add a flag

If you wish to add a flag, the following requirements must be followed:

Image size

  • Width: equal or less than 23px
  • Height: equal or less than 15px
  • Aspect ratio: retained from source flag

If your flag is a custom flag (e.g. North America), we recommend a 23x15px flag which has a 2:3 ratio.

Upload

  • Your flag should be uploaded to File:Flag of ProperFlagName.png, where ProperFlagName is the full name of your flag with correct capitalization
  • Make sure you add your flag image to Category:Flag Images.

Update templates

  • Create a template at Template:Flag/lowercaseflagname, where lowercaseflagname is the full name of your flag in complete lowercase. This template should contain the code below:
{{Flag icon|'''ProperFlagName'''}}<noinclude>[[Category:Flag sub-templates]]</noinclude>
  • Create a template at Template:Flag/abbr, where abbr is the lowercase abbreviation of your flag. This template should be a simple redirect to the primary sub-template (Template:Flag/lowercaseflagname)
    • If your template has any alternate names or abbreviations, create them as simple redirects to the primary sub-template as well
  • Add your flag to the correct table in the documentation template.
Retrieved from "https://comp.tf/wiki/index.php?title=Template:Flag/doc&oldid=64689"