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
:'''{{tlc|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
*{{tlc|navy|Algeria}} → {{navy|Algeria}}

;Argentina
*{{tlc|navy|Argentina}} → {{navy|Argentina}}
*{{tlc|navy|Argentina|coast guard}} → {{navy|Argentina|coast guard}}

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

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

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

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

;France
*{{tlc|navy|Kingdom of France}} → {{navy|Kingdom of France}}
*{{tlc|navy|France|naval-1790}} → {{navy|France|naval-1790}} (1790-94)
*{{tlc|navy|France}} → {{navy|France}}
*{{tlc|navy|France|name=Marine Nationale}} → {{navy|France|name=Marine Nationale}}
*{{tlc|navy|Free French}} → {{navy|Free French}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

;United Kingdom
*{{tlc|navy|England}} → {{navy|England}} (16th century to 1706)
*{{tlc|navy|Kingdom of Great Britain}} → {{navy|Kingdom of Great Britain}} (1707-1800)
*{{tlc|navy|United Kingdom}} → {{navy|United Kingdom}} (since 1801)
*{{tlc|navy|United Kingdom|RFA}} → {{Navy|United Kingdom|RFA}}
*{{tlc|navy|United Kingdom|RMAS}} → {{Navy|United Kingdom|RMAS}}

;United States
*{{tlc|navy|USA|navy}} → {{navy|USA}}
*{{tlc|navy|USA|1912}} → {{navy|USA|1912}}
*{{tlc|coast guard|USA|coast guard}} → {{coast guard|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:
*{{tlc|flagicon|UK|naval}} → {{flagicon|UK|naval}}
*{{tlc|flagicon|CHN|naval}} → {{flagicon|CHN|naval}}
*{{tlc|flagicon|Japan|naval}} → {{flagicon|Japan|naval}}
*{{tlc|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}}}}

===TemplateData===
{{TemplateData header}}
<templatedata>
{
	"params": {
		"variant": {
			"aliases": [
				"2"
			],
			"label": "Variant",
			"description": "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 naval variant if present, so there is no need to specify this variant in the template call.",
			"example": "coast guard",
			"type": "string"
		},
		"size": {
			"label": "Size",
			"description": "Can be used to change the flag icon size"
		},
		"name": {
			"label": "Name",
			"description": "Can be used to change the wikilink display text"
		},
		"nation": {
			"aliases": [
				"1"
			],
			"label": "Nation",
			"description": "The name of the nation or the three-letter ISO 3166-1 alpha-3 country code of the nation to which the navy in question belongs",
			"example": "USA",
			"type": "string",
			"required": true
		}
	},
	"description": "Produces a flag icon attached to a wiki-linked \"Xxxx National Navy\" article, as appropriate for a given country. ",
	"paramOrder": [
		"nation",
		"variant",
		"size",
		"name"
	],
	"format": "inline"
}
</templatedata>

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

<includeonly>{{Sandbox other|
| <!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Navy formatting templates]]
[[Category:Ship templates]]
[[Category:Flag template system]]

}}</includeonly>