Шаблон:Tc

{{tc}}

[прагляд] [правіць] [гісторыя] [падстаронкі] [абнавіць]

 Дакументацыя

---

Шаблон {{tc}} дазваляе зручна ствараць прыклады выкарыстання шаблонаў. Ён з’яўляецца лаканічнай альтэрнатывай канструкцыі <code><nowiki>...</nowiki></code>.

Розныя спосабы прывесці код выкліку шаблона ў дакументацыі:

Выкарыстоўваючы {{tc}}	Выкарыстоўваючы <code> + <nowiki>	Вынік
{{tc|шаблон|параметр}}	<code><nowiki>{{шаблон|параметр}}</nowiki></code>	{{шаблон|параметр}}
{{tc|шаблон|а=б}}	<code><nowiki>{{шаблон|а=б}}</nowiki></code>	{{шаблон|а=б}}
{{tc|шаблон|<nowiki>параметр=значэнне|{{IPA|/tʃ/}}</nowiki>}}	<code><nowiki>{{шаблон|параметр=значэнне|{{IPA|/tʃ/}}}}</nowiki></code>	{{шаблон|параметр=значэнне|{{IPA|/tʃ/}}}}

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

• {{tc|шаблон|параметр}} → {{шаблон|параметр}}
• {{tc|шаблон|параметр=значэнне}} → {{шаблон|параметр=значэнне}}
• {{tc|шаблон|параметр 1|||параметр 4}} → {{шаблон|параметр 1|||параметр 4}}
• {{tc|падст:шаблон|параметр}} → {{падст:шаблон|параметр}}

Важна:хоць шаблон і здольны адлюстроўваць найменныя параметры, гэта значыць тыя, у якіх скарыстаны знак «=» (дзякуючы выкарыстанню модуля Template call code), такія параметры ў сапраўдны момант пераносяцца ў канец спісу, а іх парадак скажаецца. Каб гэтага пазбегнуць, замяняйце знак «=» на {{=}} або забірайце параметры ў <nowiki></nowiki>. Таксама гэта варта праробліваць для параметраў, імёны якіх пачынаюцца са знака падкрэслівання, інакш яны не адлюструюцца.

У параметрах шаблона нельга ўпісваць канструкцыі з фігурнымі дужкамі. Іх можна складаць у <nowiki></nowiki>:

• {{tc|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}} → {{шаблон|{{IPA|/tʃ/}}}}

Можна заключаць ў <nowiki></nowiki> і адразу ўсе параметры, акрамя першага:

• {{tc|шаблон|<nowiki>параметр=значэнне|{{IPA|/tʃ/}}</nowiki>}} → {{шаблон|параметр=значэнне|{{IPA|/tʃ/}}}}

Першы параметр можна апускаць — тады яго зменіць назва бягучай старонкі з малой першай літары:

• {{tc||параметр}} → {{tc|параметр}}

Каб забараніць перанос на наступны радок у сярэдзіне кода, выкарыстоўвайце непустым значэнне параметру |_nobr=.

Каб замест тэга <code> выкарыстоўваць <tt>, выкарыстоўвайце |_tag=tt.

Калі задаць пустое значэнне параметру |spaced=, найменныя параметры шаблона будуць адбітыя прабеламі:

• {{tc|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_spaced=x}} → {{ш |параметр 1=значение |параметр 2=значение }}

Если задать непустое значение параметру |allspaced=, все параметры шаблона будут отбиты пробелами с обеих сторон:

• {{tc|ш|параметр 1{{=}}значэнне|параметр 2{{=}}значэнне|_allspaced=x}} → {{ш|параметр 1=значэнне|параметр 2=значэнне}}

У афармленні дакументацыі

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

Прыклад:

{{tc|пераход|''#Раздзел або #якар''{{optp|''тып значка''|''Назва раздзела''}}}}

{{optp/comment}}

↓

{{пераход|#Раздзел або #якар|тып значка|Назва раздзела}}

Неабавязковыя параметры паказаны шэрым.

Звярніце ўвагу, што ў апісанні параметраў мы імкнемся максімальна імітаваць выгляд ўтрымання параметраў у іх рэальным выкарыстанні: загалоўная або малая літара выбіраюцца адпаведна, калі ў канцы патрэбна кропка — ставіцца і яна, а ў дадзеным прыкладзе да назвы падзелу або якара дададзены знак краты. Мэта — каб па адным погляду на сінтаксіс шаблону можна было зразумець, як яго трэба выкарыстоўваць.

Шматрадковыя прыклады выкарыстання шаблонаў можна даваць не толькі пры дапамозе тэга <pre>, які не падтрымлівае разметку ўнутры сябе, але і пры дапамозе прабелу ў пачатку радкоў або (што менш зручна) шаблона {{pre}} (а таксама {{*pre}}, які дазваляе выкарыстаць тэг <pre> з маркерамі спісу пры такой неабходнасці).

Справа густу, але, калі дакументуемы шаблон звычайна займае поўны радок у вікі-тэксце (напрыклад, шаблоны-папярэджанні), аўтар дадзенага шаблона рэкамендуе выкарыстоўваць афармленне, якое дае тэг <pre> / прабел у пачатку радка / шаблон {{pre}} (Апошнія два выпадкі — калі трэба ўставіць разметку), а не тое, якое дае гэты шаблон або камбінацыя <code> + <nowiki>.

Гл. таксама

• {{tlx}} — тое ж самае плюс спасылка на шаблон
• {{pre}} — функцыянал тэга <pre> з магчымасцю выкарыстання разметкі
• {{прыклад}} — код выкліку шаблона → вынік
• {{tlp}} — спасылка на шаблон з указаннем параметраў
• {{t}} — сімвалічны запіс імя шаблона або спасылка на шаблон

Каб пазбегнуць паломак старонак, дзе ўжыты гэты шаблон, пажадана эксперыментаваць у сваёй асабістай прасторы.