Module:CountryData/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:58:17Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:58, 29 August 2024
Line 30:		Line 30:
	<includeonly>{{Sandbox other \| \|		<includeonly>{{Sandbox other \| \|
	[[Category:Flag template system]]		[[Category:Flag template system]]
	}}</includeonly>		}}</includeonly><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

2600:1700:A2A0:FB50:DC18:CA2:30A6:770C at 07:25, 10 November 2023

2023-11-10T07:25:26Z

← Previous revision		Revision as of 07:25, 10 November 2023
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{High-use}}
	This module has three functions to extract data from [[:Category:Country data templates\|country data templates]] (which are used for most [[WP:WPFT\|flag templates]]).		This module has three functions to extract data from [[:Category:Country data templates\|country data templates]] (which are used for most [[WP:WPFT\|flag templates]]).

Paine Ellsworth: /* getalias */ remove deleted template

2021-09-25T06:29:02Z

getalias: remove deleted template

← Previous revision		Revision as of 06:29, 25 September 2021
Line 13:		Line 13:
	If used from wikicode, this function returns the value of a single field in a data template. The first parameter is the country or other entity whose data to return; the second is the name of the field. For example, <code>{{((}}#invoke:CountryData\|getalias\|France\|flag alias{{))}}</code> → {{#invoke:CountryData\|getalias\|France\|flag alias}}. The other parameters are {{para\|variant}} to return a variant parameter value, with fallback to the main field value if the variant does not exist, and {{para\|def}} for the fallback output if the wanted data template or field does not exist, the default for which is a literal "nil".		If used from wikicode, this function returns the value of a single field in a data template. The first parameter is the country or other entity whose data to return; the second is the name of the field. For example, <code>{{((}}#invoke:CountryData\|getalias\|France\|flag alias{{))}}</code> → {{#invoke:CountryData\|getalias\|France\|flag alias}}. The other parameters are {{para\|variant}} to return a variant parameter value, with fallback to the main field value if the variant does not exist, and {{para\|def}} for the fallback output if the wanted data template or field does not exist, the default for which is a literal "nil".

	Note: This is likely not quicker than wikicode-only alternatives such as {{tl\|getalias~~}}, {{tl\|getalias2~~}} and {{tl\|~~pst name~~}}, because it transcludes the data template from Lua and converts it to a Lua table using the above function, picks the wanted parameter name, and returns it to wikicode, whereas other templates perform two simple non-Lua transclusions to get, in most cases, the same result. The Lua version does have the advantage that using it with a non-existing country data template returns "nil" (or the value of {{para\|def}}) rather than a redlink to the data template. See a comparison of the four at [[User:SiBr4/Flagg tests#Lua-based getalias\|User:SiBr<sub>4</sub>/Flagg tests#Lua-based getalias]].		Note: This is likely not quicker than wikicode-only alternatives such as {{tl\|getalias}} and {{tl\|getalias2}}, because it transcludes the data template from Lua and converts it to a Lua table using the above function, picks the wanted parameter name, and returns it to wikicode, whereas other templates perform two simple non-Lua transclusions to get, in most cases, the same result. The Lua version does have the advantage that using it with a non-existing country data template returns "nil" (or the value of {{para\|def}}) rather than a redlink to the data template. See a comparison of the four at [[User:SiBr4/Flagg tests#Lua-based getalias\|User:SiBr<sub>4</sub>/Flagg tests#Lua-based getalias]].

	=== gettemplate ===		=== gettemplate ===

GKFX: /* gettemplate */ use #tag in example

2021-05-03T14:51:44Z

gettemplate: use #tag in example

← Previous revision		Revision as of 14:51, 3 May 2021
Line 18:		Line 18:
	This function concatenates the fields of a data template into a string similar to what you get when transcluding it directly. It can be compared with a direct transclusion to test if a template is being converted to Lua correctly:		This function concatenates the fields of a data template into a string similar to what you get when transcluding it directly. It can be compared with a direct transclusion to test if a template is being converted to Lua correctly:
	<pre>		<pre>
	{{pre\|{{Country data France}}}}		{{#tag:pre\|{{Country data France}}}}
	{{pre\|{{#invoke:CountryData\|gettemplate\|France}}}}		{{#tag:pre\|{{#invoke:CountryData\|gettemplate\|France}}}}
	</pre>		</pre>
	gives		gives
	{{pre\|{{Country data France}}}}		{{#tag:pre\|{{Country data France}}}}
	{{pre\|{{#invoke:CountryData\|gettemplate\|France}}}}		{{#tag:pre\|{{#invoke:CountryData\|gettemplate\|France}}}}

	Note that, like with all Lua tables, the order of entries is not preserved, so the parameters are mixed up.		Note that, like with all Lua tables, the order of entries is not preserved, so the parameters are mixed up.

WOSlinker: change source to syntaxhighlight

2020-07-07T13:26:21Z

change source to syntaxhighlight

← Previous revision		Revision as of 13:26, 7 July 2020
Line 6:		Line 6:

	The first parameter is the <code>frame</code> of the invoking module; the second is the country or other entity to get the data of. The optional third parameter is a table of parameters to pass into the data template; this may, for example, include {{para\|age}} or {{para\|mw}}, which are used in the values of some sports alias parameters. E.g.,		The first parameter is the <code>frame</code> of the invoking module; the second is the country or other entity to get the data of. The optional third parameter is a table of parameters to pass into the data template; this may, for example, include {{para\|age}} or {{para\|mw}}, which are used in the values of some sports alias parameters. E.g.,
	<~~source~~ lang="Lua">local data = require('Module:CountryData').gettable(frame,"France",{age="20",mw="men's"})</~~source~~>		<syntaxhighlight lang="Lua">local data = require('Module:CountryData').gettable(frame,"France",{age="20",mw="men's"})</syntaxhighlight>

	The function returns an empty table if a data template does not exist or does not conform to the [[WP:WPFT#Basic country data template structure\|standard structure]].		The function returns an empty table if a data template does not exist or does not conform to the [[WP:WPFT#Basic country data template structure\|standard structure]].

Stranger195: Use {{Sandbox other}} instead of {{#ifeq:}}

2018-07-21T07:36:55Z

Use {{Sandbox other}} instead of {{#ifeq:}}

← Previous revision		Revision as of 07:36, 21 July 2018
Line 27:		Line 27:
	Note that, like with all Lua tables, the order of entries is not preserved, so the parameters are mixed up.		Note that, like with all Lua tables, the order of entries is not preserved, so the parameters are mixed up.

	<includeonly>{{~~#ifeq:{{SUBPAGENAME}}\|sandbox~~ \| \|		<includeonly>{{Sandbox other \| \|
	[[Category:Flag template system]]		[[Category:Flag template system]]
	}}</includeonly>		}}</includeonly>

Ludwig20 at 15:52, 14 June 2017

2017-06-14T15:52:25Z

← Previous revision		Revision as of 15:52, 14 June 2017
Line 1:		Line 1:
			{{Module rating\|protected}}
	This module has three functions to extract data from [[:Category:Country data templates\|country data templates]] (which are used for most [[WP:WPFT\|flag templates]]).		This module has three functions to extract data from [[:Category:Country data templates\|country data templates]] (which are used for most [[WP:WPFT\|flag templates]]).

SiBr4: /* gettable */

2015-09-28T21:02:56Z

gettable

← Previous revision		Revision as of 21:02, 28 September 2015
Line 2:		Line 2:

	=== gettable ===		=== gettable ===
	Extracts all parameters from a data template and returns them as a Lua table. This function is only usable from other Lua modules; invoke it using <code>~~data =~~ require('Module:CountryData').gettable(''parameters'')</code>.		Extracts all parameters from a data template and returns them as a Lua table. This function is only usable from other Lua modules; invoke it using <code>require('Module:CountryData').gettable(''parameters'')</code>.

	The first parameter is the <code>frame</code> of the invoking module; the second is the country or other entity to get the data of. The optional third parameter is a table of parameters to pass into the data template; this may, for example, include {{para\|age}} or {{para\|mw}}, which are used in the values of some sports alias parameters. E.g.,		The first parameter is the <code>frame</code> of the invoking module; the second is the country or other entity to get the data of. The optional third parameter is a table of parameters to pass into the data template; this may, for example, include {{para\|age}} or {{para\|mw}}, which are used in the values of some sports alias parameters. E.g.,
	<source lang="Lua">data = require('Module:CountryData').gettable(frame,"France",{age="20",mw="men's"})</source>		<source lang="Lua">local data = require('Module:CountryData').gettable(frame,"France",{age="20",mw="men's"})</source>

	The function returns an empty table if a data template does not exist or does not conform to the [[WP:WPFT#Basic country data template structure\|standard structure]].		The function returns an empty table if a data template does not exist or does not conform to the [[WP:WPFT#Basic country data template structure\|standard structure]].

SiBr4: Hopefully clarify that country data templates, not the three functions, are used for most flag templates

2015-09-28T21:01:53Z

Hopefully clarify that country data templates, not the three functions, are used for most flag templates

← Previous revision		Revision as of 21:01, 28 September 2015
Line 1:		Line 1:
	This module has three functions to extract data from [[:Category:Country data templates\|country data templates]], which are used for most [[WP:WPFT\|flag templates]].		This module has three functions to extract data from [[:Category:Country data templates\|country data templates]] (which are used for most [[WP:WPFT\|flag templates]]).

	=== gettable ===		=== gettable ===

SiBr4: /* getalias */

2015-09-02T14:07:51Z

getalias

← Previous revision		Revision as of 14:07, 2 September 2015
Line 10:		Line 10:

	=== getalias ===		=== getalias ===
	If used from wikicode, this function returns the value of a single field in a data template. The first parameter is the country or other entity whose data to return; the second is the name of the field. For example, <code>{{((}}#invoke:CountryData\|getalias\|France\|flag alias{{))}}</code> → {{#invoke:CountryData\|getalias\|France\|flag alias}}.		If used from wikicode, this function returns the value of a single field in a data template. The first parameter is the country or other entity whose data to return; the second is the name of the field. For example, <code>{{((}}#invoke:CountryData\|getalias\|France\|flag alias{{))}}</code> → {{#invoke:CountryData\|getalias\|France\|flag alias}}. The other parameters are {{para\|variant}} to return a variant parameter value, with fallback to the main field value if the variant does not exist, and {{para\|def}} for the fallback output if the wanted data template or field does not exist, the default for which is a literal "nil".

	Note: This is likely not quicker than wikicode-only alternatives such as {{tl\|getalias}}, {{tl\|getalias2}} and {{tl\|pst name}}, because it transcludes the data template from Lua and converts it to a Lua table using the above function, picks the wanted parameter name, and returns it to wikicode, whereas other templates perform two simple non-Lua transclusions to get the same result. The Lua version ~~also doesn't let non-existing variant values fall back to the main ones like getalias and getalias2 do. It~~ does have the advantage that using it with a non-existing country data template returns "nil" rather than a redlink to the data template. See a comparison at [[User:SiBr4/Flagg tests#Lua-based getalias\|User:SiBr<sub>4</sub>/Flagg tests#Lua-based getalias]].		Note: This is likely not quicker than wikicode-only alternatives such as {{tl\|getalias}}, {{tl\|getalias2}} and {{tl\|pst name}}, because it transcludes the data template from Lua and converts it to a Lua table using the above function, picks the wanted parameter name, and returns it to wikicode, whereas other templates perform two simple non-Lua transclusions to get, in most cases, the same result. The Lua version does have the advantage that using it with a non-existing country data template returns "nil" (or the value of {{para\|def}}) rather than a redlink to the data template. See a comparison of the four at [[User:SiBr4/Flagg tests#Lua-based getalias\|User:SiBr<sub>4</sub>/Flagg tests#Lua-based getalias]].

	=== gettemplate ===		=== gettemplate ===