模板:Country alias/doc

此頁面是Template:Country alias的模板文件。
此頁面可能包含了模板的使用說明、分類和其他內容。

此模板使用Lua語言：

Module:Country alias（沙盒）

本模板根據所輸入的數據返回對應的國家和地區名稱或旗幟。

{{Country alias}}主要用於奧林匹克運動會、殘疾人奧林匹克運動會、英聯邦運動會、亞洲運動會等綜合體育賽事。

用法

本模板包含以下參數，其中第一個參數為必輸參數：

country/1: 由三個字母（少數為四個字母）組成的國家和地區代碼。該參數可以為非命名參數。關於各國家和地區所使用的縮寫，請參閱國際奧委會國家編碼列表條目
flag: 如果設定為yes，將返回國家和地區旗幟文件名，否則返回國家和地區名
year: 主要用於決定具體返回的國家和地區名或旗幟的參數之一。例如country參數輸入TUN，year參數輸入1998年，會返回的旗幟是「Pre-1999 Flag of Tunisia.svg」，輸入2000年，會返回的旗幟是「Flag of Tunisia.svg」。
games: 主要用於決定具體返回的國家和地區名或旗幟的參數之一。例如1980年夏季奧林匹克運動會有相當一部分國家和地區選擇以奧林匹克旗幟參賽。注意調用本模板時確保該參數非繁簡混用。
lan: 主要用於決定返回的國家和地區名的中文用字。例如輸入country參數輸入KEN，lan參數輸入zh-tw，則返回的國家和地區名為「肯亞」，目前調用時輸入的值為「zh-mo」。

範例

以下以意大利（ITA）為例展示各種組合的輸入所返回的結果

ITA = {
	name = "Italy",
	{1946, "Flag of Italy (1861-1946).svg"},
	{2002, "Flag of Italy.svg"},
	{2006, "Flag of Italy (2003-2006).svg"},
	"Flag of Italy.svg",
	["夏季奥林匹克运动会"] = {
		[1980] = "Olympic flag.svg",
	},
	["夏季奧林匹克運動會"] = {
		[1980] = "Olympic flag.svg",
	},
}

{{Country alias|ITA}} → 意大利
{{Country alias|ITA|flag=yes}} → Flag of Italy.svg
{{Country alias|ITA|flag=yes|year=1946}} → Flag of Italy (1861-1946).svg
{{Country alias|ITA|flag=yes|year=1947}} → Flag of Italy.svg
{{Country alias|ITA|flag=yes|year=1980|games=夏季奥林匹克运动会}} → Olympic flag.svg
{{Country alias|ITA|flag=yes|year=2006|games=夏季奥林匹克运动会}} → Flag of Italy (2003–2006).svg

注意上述最後一個示例中，games參數並未影響到最終返回的旗幟文件名。

錯誤示例

如果所輸入的代碼是模塊中所不支持的，調用模板時會返回錯誤信息：

{{Country alias}} → Lua錯誤在Module:Country_alias的第275行：Invalid country alias: {{{country}}}
{{Country alias|}} → Lua錯誤在Module:Country_alias的第275行：Invalid country alias: nil
{{Country alias|EXZ}} → Lua錯誤在Module:Country_alias的第275行：Invalid country alias: EXZ
{{Country alias|country=EXZ}} → Lua錯誤在Module:Country_alias的第275行：Invalid country alias: EXZ

調用模板時也可使用|error=value來自定義所返回的錯誤信息：

{{Country alias|EXZ|error=ERROR}} → ERROR