Шаблён:Прыклад з найменьнямі парамэтраў/Дакумэнтацыя

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

Выкарыстаньне

Для прыкладу паказанае выкарыстаньне для дакумэнтаваньня шаблёну {{Тэатрал}}:

{{{імя}}}
[[Файл:{{{партрэт}}}|225пкс]] {{{апісаньне партрэту}}}
Дата нараджэньня	{{{дата нараджэньня}}}
Месца нараджэньня	{{{месца нараджэньня}}}
Дата сьмерці	{{{дата сьмерці}}}
Месца сьмерці	{{{месца сьмерці}}}
Грамадзянства	{{{грамадзянства}}}
Месца вучобы	{{{альма-матэр}}}
Прафэсіі	{{{прафэсіі}}}
Гады дзейнасьці	{{{гады дзейнасьці}}}
Амплюа	{{{амплюа}}}
Тэатар	{{{тэатар}}}
Ролі	{{{ролі}}}
Спэктаклі	{{{спэктаклі}}}
Узнагароды	{{{узнагароды}}}
Сайт	{{{сайт}}}

{{Прыклад з найменьнямі парамэтраў
|_шаблён = Тэатрал
|імя |арыгінал імя |партрэт |апісаньне партрэту |дата нараджэньня
|месца нараджэньня |дата сьмерці |месца сьмерці |грамадзянства |альма-матэр
|прафэсіі |гады дзейнасьці |амплюа |тэатар |ролі
|спэктаклі |узнагароды |сайт
}}

Заўвагі па выкарыстаньні

Калі шаблён {{Прыклад з найменьнямі парамэтраў}} выкарыстоўваецца на падстаронцы патрэбнага шаблёну, то бок на падстаронцы /Дакумэнтацыя, то парамэтар |_шаблён = пазначаць не патрэбна. Інакш кажучы, калі б вышэйшы код выкарыстоўвася на старонцы Шаблён:Тэатрал/падстаронка (дзе падстаронка можа называцца «Дакумэнтацыя», «Тэсты» і пад.), то выглядаў бы такім чынам:

{{Прыклад з найменьнямі парамэтраў
|імя |арыгінал імя |партрэт |апісаньне партрэту |дата нараджэньня
|месца нараджэньня |дата сьмерці |месца сьмерці |грамадзянства |альма-матэр
|прафэсіі |гады дзейнасьці |амплюа |тэатар |ролі
|спэктаклі |узнагароды |сайт
}}

Адзіным выключэньнем з гэтага ёсьць падстаронка «пясочніца». Калі модуль выкліканы з старонкі, якая сканчаецца на «/пясочніца», то ён выводзіць у шаблёне зьмест гэтай падстаронкі, а ня базавай. Каб зьмяніць гэткія паводзіны модулю, трэба яўна задаць |_шаблён = .

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

Каб перадаць у парамэтар дапасаванае значэньне, замест коду |[назва парамэтру] трэба прапісаць код |[назва парамэтру] = [значэньне]. Каб адфарматаваць такое значэньне — напрыклад, зрабіць курсіўным — фармат трэба перадаць у самім значэньні (напр. |парамэтар = ''значэньне''<br/>). Дапасаваныя значэньні ня могуць перадавацца ў парамэтры, назвы якіх пачынаюцца зь ніжняй рыскі («_»).

Глядзіце таксама

• Вікіпэдыя:Дакумэнтацыя шаблёнаў