Модуль:Сцягі краін/Дакументацыя

Гэты модуль выкарыстоўваецца модулем Сцягафікацыя. Тут змешчаныя краіны і сцягі, якія можна паказаць праз шаблон {{Сцягафікацыя}} і {{Сцяг}}.

Фармат

Модуль вяртае табліцу з краінамі і сцягамі. Увесь спіс падзелены на дзве часткі: перанакіраванні і, уласна, краіны.

Краіны

Пад краінай маецца наўвазе любая тэрыторыя (краіна, вобласць, штат, горад і т. п.). Для кожнай новай тэрыторыі трэба стварыць прынамсі дапомны сцяг, які будзе адлюстроўвацца, калі ў шаблонах {{Сцягафікацыя}} або {{Сцяг}} не выбраны асобны варыянт сцяга. Апроч таго можна дадаць процьму розных варыянтаў.

Унутры элемента тэрыторыі ствараецца новая табліца, кожны элемент — асобны варыянт. Дапомны носіць назву default. Так, для Беларусі з адзіным, дапомным, варыянтам, код будзе выглядаць наступным чынам:

-- каментары ў кодзе трэба папярэдзіць двума злучкамі
return { -- гэта асноўная табліца, унутры якой месцяцца краіны
	["Беларусь"] = { -- назва асобнай краіны, паводле якой паказваюцца сцягі праз адпаведныя шаблоны
		["default"] = { -- дапомны варыянт
			["image"] = "Flag of Belarus.svg" -- назва файла са сцягам для дапомнага варыянта
		}
	}
}

Як бачна, элемент default уяўляе сабой яшчэ адну табліцу, якая мае адзіны элемент image (бел.: выява). Значэннем гэтага элемента мае быць назва файла, у якім знаходзіцца выява.

Акрамя параметра image у асобныя варыянты можна дадаць параметры link і caption. Першы — назва артыкула, на які будзе весці сцяг (і спасылка побач у выпадку з {{Сцягафікацыя}}). Другі — альтэрнатыўная назва краіны (напрыклад, артыкул пра краіну Македонія завецца Рэспубліка Македонія — подпіс да сцяга таксама будзе дапомна сведчыць «Рэспубліка Македонія», дадаўшы ["caption"] = "Македонія" у варыянт default пры адлюстраванні дапомнага сцяга побач будзе пісацца «Македонія» замест «Рэспубліка Македонія».

return {
	["Рэспубліка Македонія"] = {
		["default"] = {
			["image"] = "Flag of the Republic of Macedonia.svg",
			["caption"] = "Македонія"
		}
	}
}

У выніку атрымаецца: Паўночная Македонія замест Паўночная Македонія.

Перанакіраванні

Бывае, што сцяг пэўнай тэрыторыі ў адным месцы зручней выклікаць адной назвай, а ў другім месцы — другой. Так, звяртаючыся зноў да Македоніі, можна прапускаць «Рэспубліка», выклікаючы шаблон {{Сцягафікацыя}} проста па назве «Македонія»:

{{Сцягафікацыя|Рэспубліка Македонія}} → Паўночная Македонія

{{Сцягафікацыя|Македонія}} → Паўночная Македонія

Спіс перанакіраванняў змешчаны ў пачатку модуля.

Каб у асобным артыкуле змяніць напісанне тэрыторыі або артыкул, на які вядзе спасылка, глядзіце такументацыю да шаблонаў {{Сцягафікацыя}} і {{Сцяг}}.