साचा:देश माहिती दाखवा/doc

This template is used for documenting देश माहिती meta-templates used by the flag template system. The output of this template can be seen by directly viewing any of the templates in Category:देश माहिती साचे.

See Wikipedia:WikiProject Flag Template for the main documentation and discussion page for the flag template system.

Usage

This template is automatically invoked by the standard syntax of a देश माहिती साचे:

{{ {{{1<noinclude>|देश माहिती दाखवा</noinclude>}}}
| टोपणनाव = Countryname
| flag alias = Flag of Countryname.svg
| size = {{{size|}}}
| नाव= {{{नाव|}}}
}}

The first parameter to a देश माहिती साचे is usually the name of a formatting meta-template. For example, Template:Flag uses Template:Country flag2 to actually render the flag icon and wikilink. If the first parameter is missing, which is the case when a देश माहिती साचे is viewed directly, the template code fragment {{{1<noinclude>|देश माहिती दाखवा</noinclude>}}} ensures that this template will be used as the default first parameter. This technique ensures that देश माहिती साचे are "self-documenting" if they use the standard syntax.

Additional parameters

Many देश माहिती साचे require additional documentation beyond the standard mandatory alias and flag alias parameters. This template will automatically document standard optional parameters (such as shortname alias and/or alt attribute) if present, and can document unique optional parameters (such as flag variants) if instructed to. This latter method utilizes documentation-specific parameters in the देश माहिती template to activate the additional output from this template. These documentation parameters are set off from the rest of the parameters in the देश माहिती template by a <noinclude> section:

<noinclude>
| var1 = ...
| redir1 = ...
| related1 = ...
</noinclude>

Flag variants

Flag variants are added to a देश माहिती template by the inclusion of one or more flag alias-label parameters, where each label is a unique identifier that is subsequently used as an input parameter to {{flag|...}}, {{flagicon|...}}, etc. To document these flag variants, use the varN documentation parameters to identify each label.

For example, Template:देश माहिती Seychelles identifies three flag variants (in addition to the current flag) with the following code:

| 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

These three variants are documented by the following code segment later in the template:

<noinclude>
| var1 = 1976
| var2 = 1977
| var3 = colonial
...
</noinclude>

Up to nine flag variants can be documented by this method (using var1 to var9). If more are present (and currently, only Template:देश माहिती United States 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 varN parameter for the standard optional variant label naval (used for the country's naval ensign). If present, it will automatically be documented.

Redirect aliases

Many देश माहिती 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 Category:देश माहिती redirects.

For example, Template:देश माहिती DEU and Template:देश माहिती GER both redirect to Template:देश माहिती Germany, because DEU is the ISO code and GER is the IOC and FIFA code for Germany. Therefore, {{flagicon|DEU}}, {{flagicon|GER}}, and {{flagicon|Germany}} all have the same result. These redirect aliases are documented by the following template code fragment:

<noinclude>
...
| redir1 = DEU
| redir2 = GER
...
</noinclude>

Related templates

Several देश माहिती templates are used for alternate forms to the common देश माहिती 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, Template:देश माहिती Serbia and Montenegro includes the following code to document three other related देश माहिती templates:

<noinclude>
...
| related1 = Serbia
| related2 = Montenegro
| related3 = FR Yugoslavia
...
</noinclude>

Additional documentation

For situations where the automatic documentation method is not completely adequate, additional documentation can be displayed by देश माहिती दाखवा. Simply create a documentation subpage (named as Template:देश माहिती Countryname/doc) with the additional material, and it will be transcluded after all other output sections.

For example:

• Template:देश माहिती Ireland/doc is used to explain why that template is distinct from Template:देश माहिती Republic of Ireland
• Template:देश माहिती France/doc is used to document the list of देश माहिती templates available for each of the regions of France
• Template:देश माहिती United States/doc is used to document the full set of flag variants (for each number of stars), and to list all of the देश माहिती templates available for state and territory flags