Шаблон:Прыклад

З пляцоўкі Вікіпедыя
Jump to navigation Jump to search
(i) Дакументацыя

Шаблон прызначаны для спрашчэння афармлення прыкладаў выкарыстання шаблонаў у дакументацыях. Ён выдае вікітэкст выкліку шаблону (у агульным выпадку з параметрамі) і вынік гэтага выкліку.

У дадзены момант шаблон не прыстасаваны для афармлення прыкладаў шаблонаў з шматрадковых кодам і якія змяшчаюць шаблоны ўнутры шаблону.

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

  • {{прыклад|t|t}} дасць {{t|t}}{{t}}
  • {{прыклад|replace|something|some|any}} дасць {{replace|something|some|any}} → anything
  • {{прыклад|tlx|шаблон|параметр 1|||параметр 4}} дасць {{tlx|T|параметр 1|||параметр 4}}{{T|параметр 1|||параметр 4}}
  • {{прыклад|tlu|:en:Template:Example|alt=English Template:Example}} дасць {{tlu|:en:Template:Example|alt=English Template:Example}}

Першы параметр можна апускаць - тады яго заменіць назва бягучай старонкі з малой першай літары. Напрыклад, у дакументацыі шаблону {{tr-en}} {{прыклад||слова}} дасць:

{{tr-en|слова}} → з англ. — «слова»

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

Для нагляднасці можна таксама паказваць імя шаблону праз параметр _template, пры гэтым першы параметр больш не значыць імя шаблону:

  • {{прыклад|_template=t|прыклад}} дасць {{t|прыклад}}{{прыклад}}

Абмежаванні і шляхі іх абыходу

Модуль пераносіць усе найменныя параметры ў канец, а таксама дрэнна захоўвае парадак прытрымлівання найменных параметраў, калі іх больш аднаго (з-за тэхнічнага недасканаласці ПЗ). Каб гэтага пазбегнуць, варта выкарыстоўваць {{=}} замест =:

Red x.svg {{прыклад|нейкі шаблон|parameter1=value|parameter2=value|parameter3=value}} дасць:
{{нейкі шаблон|parameter1=value|parameter3=value|parameter2=value}}
Yes check.svg {{прыклад|нейкі шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} дасць:
{{нейкі шаблон|parameter1=value|parameter2=value|parameter3=value}}

Таксама нельга запісваць напрамую параметры, чые імёны пачынаюцца са знака падкрэслення, - для прадухілення перасячэння з параметрамі, мадыфікуецца знешні выгляд выніку. Дапаможа тое ж рашэнне:

  • {{прыклад|tp|шаблон|_text{{=}}тэкст спасылкі}} дасць {{tp|T|_text=тэкст спасылкі}}{{тэкст спасылкі}}

Каб ўпісаць <nowiki>, выкарыстоўвайце HTML-сутнасці для замены кутніх дужак, напрыклад:

  • {{прыклад|tp|шаблон|&lt;nowiki><nowiki>{{IPA|/tʃ/}}</nowiki>&lt;/nowiki>}} дасць {{tp|T|<nowiki>{{IPA|/tʃ/}}</nowiki>}}{{T|{{IPA|/tʃ/}}}}

Каб ўпісаць {{=}}, выкарыстоўвайце {{((}}{{=}}{{))}} або HTML-сутнасці, напрыклад:

  • {{прыклад|pre|тэкст {{((}}{{=}}{{))}} тэкст|_sep={{sp↓||-0.5em}}}} дасць
{{pre|тэкст {{=}} тэкст}}
тэкст = тэкст

У дадзены момант не падтрымліваецца раскрыццё ўкладзеных шаблонаў і іншых канструкцый з фігурнымі дужкамі (іх можна паказваць ўнутры <nowiki>, але яны не расчыняцца). Мшматрадковыя шаблоны таксама не падтрымліваюцца.

Налады

_sep: памяняць стрэлачку на што заўгодна іншае:

{{прыклад|t|t|_sep=адлюстроўваецца як}} дасць {{t|t}} адлюстроўваецца як {{t}}

_tag: памяняць абгортку <code> (а з дапамогай _container зрабіць так, каб код прыкладу апрацоўваўся шаблонам-кантэйнерам, напрыклад {{pre}}):

{{прыклад|_template=t|_tag=tt|прыклад}} дасць {{t|прыклад}}{{прыклад}}

_link: уключыць адлюстраванне спасылкі:

{{прыклад|_template=флаг|_link=1|Расія}} дасць {{сцяг|Расія}}Расія

_pre-text (_prefix) і _post-text (_postfix): пазначыць тэкст да і пасля шаблону:

{{прыклад|tr-en|слова|_pre-text=word (|_post-text=)}} дасць word ({{tr-en|слова}}) → word (з англ. — «слова»)

_nobr: забараніць перанос радка для кода прыкладу.

_nocat: ззабараніць дадаваць старонку ў прастаўляемыя шаблонам катэгорыі, калі ў яго прадугледжаны адпаведны параметр _nocat. Пры гэтым у кодзе выкліку шаблону гэты параметр адлюстроўвацца не будзе. Так, напрыклад, у дадзеным прыкладзе сапраўдная старонка не дадаецца ў катэгорыю Кампаніі, якія маюць лістынг акцый на NASDAQ:

{{прыклад|NASDAQ|123|_nocat=1}} дасць {{NASDAQ|123}}NASDAQ: 123

_spaced: адбіць прабелам кожны параметр для лепшай чытальнасці (прабел ўстаўляецца толькі пасля найменных параметраў, так як парсер па змаўчанні абразае толькі іх):

{{прыклад|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}} дасць:
{{MathWorld |author=John Doe |urlname=GammaFunction |title=Gamma Function }} → John Doe Gamma Function(англ.)  на старонцы Wolfram MathWorld.

Стылі

З дапамогай параметру _style можна ўсталяваць стыль, які будзе ўсталёўваць некаторыя з вышэйпералічаных параметраў разам. Якія існуюць на дадзены момант стылі — pre, *pre і wikitable (а таксама pre↓):

  • {{прыклад|праверыць нейтральнасць|_style=pre}} дасць:
{{праверыць нейтральнасць}}
  • {{прыклад|праверыць нейтральнасць|_style=*pre}} дасць:
  •  

    {{праверыць нейтральнасць}}
  •  

    {| class=wikitable
    ! Код !! Вынік
    |-
    | {{прыклад|Атлас свету|1967|_style=wikitable|_nobr=1}}
    |-
    | {{прыклад|Атлас свету|1991|_style=wikitable|_nobr=1}}
    ...
    |}
дасць
Код Вынік
{{Атлас свету|1967}}
{{Атлас свету|1991}}

Групы прыкладаў

Для вываду груп прыкладаў карыстайцеся шаблонамі {{стопка прыкладаў}} (спісам) і {{табліца прыкладаў}} (табліцай).

Гл. таксама

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