Template:Country showdata/doc: Difference between revisions

→‎Additional parameters: include Hatnote section
m (1 revision imported)
imported>Paine Ellsworth
(→‎Additional parameters: include Hatnote section)
 
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-use|demo={{ROOTPAGENAME}}}}
{{Lua|Module:String}}
{{Lua|Module:String}}


Line 29: Line 30:
</noinclude>
</noinclude>
</pre>
</pre>
===Hatnote===
If a brief hatnote is needed, then it can be added to the top of the documentation page by including the {{para|hatnote}} parameter with any of the existing hatnote templates. Example:
: {{para|hatnote|<nowiki>{{Hatnote|This template contains data that applies to the [[Republic of Ireland|sovereign state]]. For the [[Ireland|entire island]], see [[Template:Country data Ireland]].}}</nowiki>}}
results in:
{{Hatnote|This template contains data that applies to the [[Republic of Ireland|sovereign state]]. For the [[Ireland|entire island]], see [[Template:Country data Ireland]].}}


===Flag variants===
===Flag variants===
Line 107: Line 114:


===Additional documentation===
===Additional documentation===
For situations where the automatic documentation method is not completely adequate, additional documentation can be displayed by <code>country showdata</code>. Simply create a documentation subpage (named as <code>Template:Country data Countryname/doc</code>) with the additional material, and it will be transcluded after all other output sections.
{{hatnote|'''There is no need''' to "noinclude" template {{tl|Documentation}} in the main country data template.}}
For situations where the automatic documentation method is not completely adequate, additional documentation can be displayed by <code>country showdata</code>. Simply create a documentation subpage (named as <code>Template:Country data Countryname/doc</code>) with the additional material, and it will be transcluded to a section called "Other information" at or near the end of the automatic documentation. This "extra" documentation page can usually be edited even if the country data template is edit-protected.


For example:
For example:
*[[Template:Country data Ireland/doc]] is used to explain why that template is distinct from [[Template:Country data Republic of Ireland]]
* [[Template:Country data Ireland/doc]] is used to explain why that template is distinct from [[Template:Country data Republic of Ireland]]
*[[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 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
* [[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
* [[Template:Country data Empire of Japan/doc]] sorts its template into individualized categories.


===Categorization===
===Categorization===