Модуль:Template invocation/Дакументацыя

З Вікіпедыі, свабоднай энцыклапедыі

Гэта старонка дакументацыі для Модуль:Template invocation

Модуль прызначаны для выкліку шаблонаў у іншых модулях.

Ужыванне[правіць зыходнік]

Спачатку трэба загрузіць модуль:

local mTemplateInvocation = require('Module:Template invocation')

Цяпер можна ўжываць функцыі модуля, апісаныя ніжэй.

Name[правіць зыходнік]

mTemplateInvocation.name(title)

Функцыя стварае імя, якое будзе ўжывацца для выкліку шаблона. Для старонкі прасторы шаблонаў яна вяртае назву старонкі без прэфікса «Шаблон:», для старонак асноўнай прасторы вяртае поўную назву старонкі з «:» у пачатку, і для іншых старонак вяртае поўную назву. title можа мець тып string або mw.title object.

Invocation[правіць зыходнік]

mTemplateInvocation.invocation(name, args, format)

Функцыя стварае выклік шаблона.

Параметры:

  • name — назва шаблона (string, абавязковы). Запісваецца гэтак жа, як і пры звычайным выкліку, напрыклад для Шаблон:Прыклад будзе «Прыклад». Каб атрымаць назву шаблона з назву старонкі, можна скарыстацца функцыяй name.
  • args — аргументы шаблона для ўжывання пры выкліку (table, абавязковы). Ключы і значэнны табліцы могуць быць радкамі або лікамі.
  • format — фармат выкліку (string, апцыянальны). Па змоўчанні ўжываецца звычайны фармат з фігурнымі дужкамі, вертыкальнымі рыскамі і знакамі роўнасці. Калі пададзена значэнне «nowiki», фігурныя дужкі, вертыкальныя рыскі і знакі роўнасці замяняюцца адпаведнымі мнемонікамі HTML.

Прыклад

Код mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'}) дасць {{foo|bar|baz|abc=def}}.