Шаблон:OnLua/Дакументацыя
 |
Дакументацыя да шаблона OnLua. |
 |
Шаблон для пазнакі шаблонаў, якія выкарыстоўваюць функцыянал пашырэння Scribunto. Звычайна ставіцца ў пачатку дакументацый шаблонаў.
Ужыванне для шаблонаў правіць
{{OnLua|імя модуля|імя функцыі|funcref=нестандартная спасылка на функцыю або line=нумар радка кода|tech=тэкст пасля слова «выкарыстаннем»|partly=калі шаблон рэалізаваны на аснове модуля часткова|nocat=1}}
Неабавязковыя параметры паказаны шэрым.
Першы параметр — назва модуля, другі — імя функцыі. Па змаўчанні, калі імя функцыі паказана, яно афармляецца спасылкай на раздзел на старонцы модуля з такім імем.
Можна перанакіраваць на любую іншую старонку, паказаўшы параметр funcref, ці даць спасылку на радок у рэдактары модуля параметрам line (пераход будзе непасрэдна на рэдагаванне).
Тэкст пасля слова «выкарыстаннем» можна перавызначыць параметрам tech. Шаблон будзе дададзены ў катэгорыю Шаблоны, якія выкарыстоўваюць Scribunto. Пры гэтым на падстаронак дакументацыі (вызначаецца па роўнасці зменнай Дакументацыя параметру doc, па змаўчанні «doc») катэгорыя не працуе.
Непустое значэнне параметру partly дадасць слова «часткова» да «рэалізаваны».
Прыклад правіць
{{onLua|Ru|o}}
- «часткова» рэалізаваны
{{onLua|partly=x|ParamValue2Value}}
| Гэты шаблон часткова рэалізаваны на аснове Lua з выкарыстаннем кода з модуля ParamValue2Value. |
Можна зрабіць правіць
Дадаць больш параметраў на выпадак, калі шаблон выкарыстоўвае больш аднаго модуля.
Ужыванне для модуляў правіць
Таксама гэты шаблон можа ўжывацца для модуляў, каб паказаць, ад якіх іншых модуляў залежыць пэўны модуль. У гэтым выпадку ў якіасці параметраў перадаюцца назвы модуляў, з прэфіксам «Модуль:» (або «Module:»).
Гл. таксама правіць