# வார்ப்புரு:Country showdata/doc


This template is used for documenting country data meta-templates used by the flag template system. The output of this template can be seen by directly viewing any of the templates in .  

See for the main documentation and discussion page for the flag template system.  

## Usage
This template is automatically invoked by the standard syntax of a country data template:  
<pre>  

</pre>  
The first parameter to a country data template is usually the name of a *formatting meta-template*. For example, வார்ப்புரு:கொடி uses Template:Country flag2 to actually render the flag icon and wikilink. If the first parameter is missing, which is the case when a country data template is viewed directly, the template code fragment <code></code> ensures that *this* template will be used as the default first parameter. This technique ensures that country data templates are "self-documenting" if they use the standard syntax.  

## Additional parameters
Many country data templates require additional documentation beyond the standard mandatory <tt>alias</tt> and <tt>flag alias</tt> parameters. This template will automatically document standard optional parameters (such as <tt>shortname alias</tt> and/or <tt>alt attribute</tt>) if present, and can document unique optional parameters (such as flag variants) if instructed to. This latter method uses documentation-specific parameters in the country data template to activate the additional output from this template. These documentation parameters are set off from the rest of the parameters in the country data template by a <tt></tt> section:  
<pre>  
&lt;noinclude&gt;  
| var1 = ...  
| redir1 = ...  
| related1 = ...  
&lt;/noinclude&gt;  
</pre>  

### Flag variants
Flag variants are added to a country data template by the inclusion of one or more <tt>flag alias-*label*</tt> parameters, where each <tt>*label*</tt> is a unique identifier that is subsequently used as an input parameter to <tt></tt>, <tt></tt>, etc. To document these flag variants, use the <tt>var*N*</tt> documentation parameters to identify each label.  

For example, Template:Country data Seychelles identifies three flag variants (in addition to the current flag) with the following code:  
<pre>  
| flag alias-1976 = Flag of the Seychelles 1976.svg  
| flag alias-1977 = Flag of the Seychelles 1977.svg  
| flag alias-colonial = Government Ensign of the United Kingdom.svg  
</pre>  
These three variants are documented by the following code segment later in the template:  
<pre>  
&lt;noinclude&gt;  
| var1 = 1976  
| var2 = 1977  
| var3 = colonial  
...  
&lt;/noinclude&gt;  
</pre>  
Up to nine flag variants can be documented by this method (using <tt>var1</tt> to <tt>var9</tt>). If more are present (and currently, only வார்ப்புரு:நாட்டுத் தகவல் ஐக்கிய அமெரிக்க நாடுகள் has more than nine flag variants), these can be listed on a separate documentation subpage as described below.  

Note that you do *not* have to use a <tt>var*N*</tt> parameter for the standard optional variant label <tt>naval</tt> (used for the country's naval ensign). If present, it will automatically be documented.  

### Redirect aliases
Many country data templates have *alias* names that can be used instead of the usual country name with all of the main flag templates. These are usually, but not exclusively, standard country code abbreviations such as those specifed in ISO 3166-1 alpha-3 or by the IOC or FIFA. These are implemented as redirects, and are listed in .  

For example, வார்ப்புரு:நாட்டுத் தகவல் இடாய்ச்சுலாந்து and வார்ப்புரு:நாட்டுத் தகவல் இடாய்ச்சுலாந்து both redirect to வார்ப்புரு:நாட்டுத் தகவல் இடாய்ச்சுலாந்து, because *DEU* is the ISO code and *GER* is the IOC and FIFA code for Germany. Therefore, <tt></tt>, <tt></tt>, and <tt></tt> all have the same result. These redirect aliases are documented by the following template code fragment:  
<pre>  
&lt;noinclude&gt;  
...  
| redir1 = DEU  
| redir2 = GER  
...  
&lt;/noinclude&gt;  
</pre>  

### Related templates
Several country data templates are used for alternate forms to the common country data template for the nation, usually but not exclusively for historic nations. Pointers to these alternate templates are useful additions to the template documentation so that editors can use the correct template for their specific purposes.  

For example, வார்ப்புரு:நாட்டுத் தகவல் செர்பியா மொண்டெனேகுரோ includes the following code to document three other related country data templates:  
<pre>  
&lt;noinclude&gt;  
...  
| related1 = Serbia  
| related2 = Montenegro  
| related3 = FR Yugoslavia  
...  
&lt;/noinclude&gt;  
</pre>  

### Additional documentation
For situations where the automatic documentation method is not completely adequate, additional documentation can be displayed by <tt>country showdata</tt>. Simply create a documentation subpage (named as <tt>Template:Country data Countryname/doc</tt>) with the additional material, and it will be transcluded after all other output sections.  

For example:  
- Template:Country data Ireland/doc is used to explain why that template is distinct from வார்ப்புரு:நாட்டுத் தகவல் அயர்லாந்து குடியரசு
- Template:Country data France/doc is used to document the list of country data templates available for each of the regions of France
- Template:Country data United States/doc is used to document the full set of flag variants (for each number of stars), and to list all of the country data templates available for state and territory flags