View source for Template:Navy/doc

{{Documentation subpage}}<noinclude>{{for|the template documentation of the template that changes text color|Template:Navy (color)/doc}}</noinclude>

===Usage===
Produces a flag icon attached to a wiki-linked "{{Varserif|Xxxx}} National Navy" article, as appropriate for a given country.

;Syntax
:'''{{tc|navy|nation|variant|size=optional|name=optional}}'''

;Parameters
:*{{para|nation}} –  Use either the name of the nation or the three-letter [[ISO 3166-1 alpha-3]] country code
:*{{para|variant}} (optional) –  Specifies an alternate (historical) naval flag to use.  This parameter is documented by the appropriate template in [[:Category:Country data templates]].  Note that the standard behaviour of this template is to use the <code>naval</code> variant if present, so there is no need to specify this variant in the template call.
:*{{para|size}} (optional) –  Can be used to change the flag icon size
:*{{para|name}} (optional) –  Can be used to change the wikilink display text

===Examples===
;Algeria
*{{tc|navy|Algeria}} → {{navy|Algeria}}

;Australia
*{{tc|navy|Argentina}} → {{navy|Argentina}}
*{{tc|navy|Argentina|coast guard}} → {{navy|Argentina|coast guard}}

;Australia
*{{tc|navy|Australia|1913}} → {{navy|Australia|1913}}
*{{tc|navy|Australia}} → {{navy|Australia}}

;Belgium
*{{tc|navy|Belgium|state}} → {{navy|Belgium|state}} (1831-1950)
*{{tc|navy|Belgium}} → {{navy|Belgium}}

;Canada
*{{tc|navy|Canada}} → {{navy|Canada}}
*{{tc|navy|Canada|1921}} → {{navy|Canada|1921}}

;China
*{{tc|navy|Qing dynasty}} → {{navy|Qing dynasty}}
*{{tc|navy|CHN}} → {{navy|CHN}}

;France
*{{tc|navy|Kingdom of France}} → {{navy|Kingdom of France}}
*{{tc|navy|France}} → {{navy|France}}
*{{tc|navy|France|name=Marine Nationale}} → {{navy|France|name=Marine Nationale}}
*{{tc|navy|Free French}} → {{navy|Free French}}

;Georgia
*{{tc|Navy|Georgia}} → {{Navy|Georgia}}
*{{tc|navy|Georgia|coast guard}} → {{navy|Georgia|coast guard}}

;Germany
*{{tc|Navy|German Empire}} → {{Navy|German Empire}}
*{{tc|navy|Weimar Republic}} → {{navy|Weimar Republic}}
*{{tc|Navy|Nazi Germany}} → {{Navy|Nazi Germany}}
*{{tc|navy|East Germany}} → {{Navy|East Germany}} 
*{{tc|navy|DEU}} → {{navy|DEU}}
*{{tc|navy|DEU|name=Deutsche Marine}} → {{navy|DEU|name=Deutsche Marine}}

;Iceland
*{{tc|navy|Iceland}} → {{navy|Iceland}}

;India
*{{tc|navy|British Raj}} → {{navy|British Raj}}
*{{tc|navy|India}} → {{navy|India}}

;Italy
*{{tc|navy|Kingdom of Italy}} → {{navy|Kingdom of Italy}}
*{{tc|navy|Italy}} → {{navy|Italy}}

;Japan
*{{tc|navy|Japan}} → {{navy|Japan}}
*{{tc|navy|Empire of Japan}} → {{navy|Empire of Japan}}

;Netherlands
*{{tc|navy|Netherlands}} → {{navy|Netherlands}}

;New Zealand
*{{tc|navy|New Zealand|1941}} → {{navy|New Zealand|1941}}
*{{tc|navy|New Zealand}} → {{navy|New Zealand}}

;Norway
*{{tc|navy|NOR}} → {{navy|NOR}}

;Panama
*{{tc|navy|Panama|1958}} → {{navy|Panama|1958}}
*{{tc|navy|Panama|1984}} → {{navy|Panama|1984}}
*{{tc|navy|Panama}} → {{navy|Panama}}

;Russia/Soviet Union
*{{tc|navy|Russian Empire}} → {{navy|Russian Empire}}
*{{tc|navy|Soviet Union}} → {{navy|Soviet Union}}
*{{tc|navy|Russia}} → {{navy|Russia}}

;South Africa
*{{tc|navy|South Africa|1922}} → {{navy|South Africa|1922}} (1922 to 1946)
*{{tc|navy|South Africa|1946}} → {{navy|South Africa|1946}} (1946 to 1952)
*{{tc|navy|South Africa|1952}} → {{navy|South Africa|1952}} (1952 to 1981)
*{{tc|navy|South Africa|1981}} → {{navy|South Africa|1981}} (1981 to 1994)
*{{tc|navy|South Africa}} → {{navy|South Africa}} (since 1994)

;Spain
*{{tc|navy|Spain|1506}} → {{navy|Spain|1506}} (1506 to 1701)
*{{tc|navy|Spain|1701}} → {{navy|Spain|1701}} (1701 to 1748)
*{{tc|navy|Spain|1748}} → {{navy|Spain|1748}} (1748 to 1785)
*{{tc|navy|Spain|1785}} → {{navy|Spain|1785}} (1785 to 1873)
*{{tc|navy|Spain|1873}} → {{navy|Spain|1873}} (1873 to 1931)
*{{tc|navy|Spanish Republic}} → {{navy|Spanish Republic}} (1931 to 1938)
*{{tc|navy|Spain|1938}} → {{navy|Spain|1938}} (1938 to 1945)
*{{tc|navy|Spain|1945}} → {{navy|Spain|1945}} (1945 to 1977)
*{{tc|navy|Spain|1977}} → {{navy|Spain|1977}} (1977 to 1981)
*{{tc|navy|Spain}} → {{navy|Spain}} (from 1981)

;Thailand
*{{tc|navy|Thailand}} → {{navy|Thailand}}

;United Kingdom
*{{tc|navy|England}} → {{navy|England}} (16th century to 1706)
*'''<nowiki>{{flagicon|Kingdom of Great Britain|white}} [[Royal Navy]]</nowiki>''' → {{flagicon|Kingdom of Great Britain|white}} [[Royal Navy]] (1707-1801) – '''DO NOT USE''' {{strongbad|<nowiki>{{navy|Kingdom of Great Britain}}</nowiki>}}, which would produce {{navy|Kingdom of Great Britain}}!
*{{tc|navy|United Kingdom}} → {{navy|United Kingdom}}
*{{tc|navy|United Kingdom|RFA}} → {{Navy|United Kingdom|RFA}}
*{{tc|navy|United Kingdom|RMAS}} → {{Navy|United Kingdom|RMAS}}

;United States
*{{tc|navy|USA}} → {{navy|USA}}
*{{tc|navy|USA|1912}} → {{navy|USA|1912}}
*{{tc|navy|USA|coast guard}} → {{navy|USA|coast guard}}

===Related templates===
The {{tl|flagicon}} template can be used to display the naval flag by itself, using the {{code|naval}} variant as a template parameter:
*{{tc|flagicon|UK|naval}} → {{flagicon|UK|naval}}
*{{tc|flagicon|CHN|naval}} → {{flagicon|CHN|naval}}
*{{tc|flagicon|Japan|naval}} → {{flagicon|Japan|naval}}
*{{tc|flagicon|Nazi Germany|naval}} → {{flagicon|Nazi Germany|naval}}

===Implementation notes===
By default, this template shows the standard national flag for the selected country, following by a wikilink to "{{varserif|Country}} Navy".  Both of these items can be changed by adding specific parameters to the appropriate {{code|country_data}} template (complete set found in {{cl|Country data templates}}).

To use a different flag, such as the naval ensign for the nation, use:
:{{para|flag alias-naval|{{Var|image name of naval ensign}}}}
To use a different name for the wikilinked navy article, use:
:{{para|link alias-naval|{{Var|article name}}}}

===See also===
*[[Wikipedia:WikiProject Ships/Ensigns]]
*{{tl|Shipboxflag}}
*{{tl|USN flag}}, providing U.S. Navy flags for any given year.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Navy formatting templates]]
[[Category:Ship templates]]
[[Category:Flag template system]]

[[bn:টেমপ্লেট:Navy]]
[[ko:틀:Navy]]
[[tpi:Templet:Navy]]
}}<!--(end #ifeq)--></includeonly>